module Contextify

contexts() click to toggle source

All contextified classes.

@return [Hash{Symbol => Class}]

All defined contexts and their classes.

# File lib/contextify/contextify.rb, line 16
def Contextify.contexts
  @@contextify_contexts ||= {}
end

included(base) click to toggle source

# File lib/contextify/contextify.rb, line 6
def self.included(base)
  base.extend ClassMethods
end

is_context?(name) click to toggle source

Determines whether a context with a specific name has been defined.

@param [Symbol, String] name

The name of the context to search for.

@return [Boolean]

Specifies whether there is a context defined with the specified
name.

# File lib/contextify/contextify.rb, line 30
def Contextify.is_context?(name)
  Contextify.contexts.has_key?(name.to_s)
end

is_loading?(path) click to toggle source

Determines whether contexts are being loaded from a specific path.

@param [String] path

The path to check if contexts are being loaded from.

@return [Boolean]

Specifies whether pending contexts are being loaded from the
specified path.

# File lib/contextify/contextify.rb, line 93
def Contextify.is_loading?(path)
  !(Contextify.loading(path).nil?)
end

is_pending?() click to toggle source

Determines whether there are pending contexts.

@return [Boolean]

Specifies whether there is a pending context present.

# File lib/contextify/contextify.rb, line 60
def Contextify.is_pending?
  !(Contextify.waiting.empty?)
end

load_block(name,path,&block) click to toggle source

Loads the context block for the context with the specific name from a specific path.

@param [Symbol, String] name

The name of the context to load the block for.

@param [String] path

The path to load the context block from.

@yield [block]

The block which will receive the context block.

@yieldparam [Proc] block

The context block loaded from the specified _path_.

@return [Proc]

The block for the context with the specified _name_.

@example

Contextify.load_block(:exploit,'/path/to/my_exploit.rb')
# => Proc

@example

Contextify.load_block(:shellcode,'/path/to/execve.rb') do |block|
  # ...
end

# File lib/contextify/contextify.rb, line 162
def Contextify.load_block(name,path,&block)
  context_block = Contextify.load_blocks(path).blocks[name.to_s]

  block.call(context_block) if block
  return context_block
end

load_blocks(path,&block) click to toggle source

Loads all context blocks from a specific path.

@param [String] path

The path to load all context blocks from.

@return [PendingContext]

The pending context which contains the blocks.

# File lib/contextify/contextify.rb, line 106
def Contextify.load_blocks(path,&block)
  path = File.expand_path(path)

  unless File.file?(path)
    raise(ContextNotFound,"context #{path.dump} doest not exist",caller)
  end

  # prevent circular loading of contexts
  unless Contextify.is_pending?
    # push on the new pending context
    Contextify.waiting.unshift(PendingContext.new(path))

    begin
      load(path)
    rescue Exception => e
      # if any error is encountered, pop off the context
      Contextify.waiting.shift
      raise(e)
    end
  end

  # pop off and return the pending context
  pending_context = Contextify.waiting.shift

  block.call(pending_context) if block
  return pending_context
end

load_context(name,path,*arguments) click to toggle source

Loads the context object of a specific name and from the specific path.

@param [Symbol, String] name

The name of the context to load.

@param [String] path

The path to load the context object from.

@return [Object]

The loaded context object.

@raise [UnknownContext]

No context was defined with the specific name.

@example

Contextify.load_context(:note,'/path/to/my_notes.rb')
# => Note

# File lib/contextify/contextify.rb, line 189
def Contextify.load_context(name,path,*arguments)
  name = name.to_s

  unless Contextify.is_context?(name)
    raise(UnknownContext,"unknown context #{name.dump}",caller)
  end

  new_context = Contextify.contexts[name].new(*arguments)

  Contextify.load_block(name,path) do |context_block|
    new_context.instance_eval(&context_block) if context_block
  end

  return new_context
end

load_contexts(path,&block) click to toggle source

Loads all context objects from a specific path.

@param [String] path

The path to load all context objects from.

@return [Array]

The array of loaded context objects.

@example

Contextify.load_contexts('/path/to/misc_contexts.rb')
# => [...]

# File lib/contextify/contextify.rb, line 218
def Contextify.load_contexts(path,&block)
  new_objs = []

  Contextify.load_blocks(path) do |pending|
    pending.each do |name,context_block|
      if Contextify.is_context?(name)
        new_obj = Contextify.contexts[name].new
        new_obj.instance_eval(&context_block)

        block.call(new_obj) if block
        new_objs << new_obj
      end
    end
  end

  return new_objs
end

loading(path) click to toggle source

Finds the first pending context being loaded from a specific path.

@param [String] path

The path which is being loaded.

@return [PendingContext]

The first pending context with the specified path.

# File lib/contextify/contextify.rb, line 73
def Contextify.loading(path)
  Contextify.waiting.each do |pending|
    if pending.path == path
      return pending
    end
  end

  return nil
end

pending() click to toggle source

The first context waiting to be fully loaded.

@return [PendingContext]

The pending context being loaded.

# File lib/contextify/contextify.rb, line 50
def Contextify.pending
  Contextify.waiting.first
end

waiting() click to toggle source

The contexts waiting to be fully loaded.

@return [Array<PendingContext>]

Contexts which are waiting to be loaded.

# File lib/contextify/contextify.rb, line 40
def Contextify.waiting
  @@contextify_waiting_contexts ||= []
end

Constants

Public Class Methods