ronin 1.5.1 → 2.0.0.beta1

data/lib/ronin/script/path.rb

@@ -1,293 +0,0 @@
-#
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin.
-#
-# Ronin is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ronin is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ronin.  If not, see <https://www.gnu.org/licenses/>.
-#
-
-require 'ronin/model'
-require 'ronin/script/script'
-
-require 'object_loader'
-
-module Ronin
-  module Script
-    #
-    # The {Path} model stores information in the {Database} about
-    # cached {Script} objects.
-    #
-    # @since 1.1.0
-    #
-    class Path
-
-      include Model
-
-      # The primary key of the cached file
-      property :id, Serial
-
-      # The path to the file where the object was defined in
-      property :path, FilePath, :required => true
-
-      # The timestamp of the cached file
-      property :timestamp, Time, :required => true
-
-      # The class name of the cached object
-      property :class_name, String, :required => true
-
-      # The repository the file was cached from
-      belongs_to :repository
-
-      # Any exceptions raise when loading a fresh object
-      attr_reader :cache_exception
-
-      # Any cache errors encountered when caching the object
-      attr_reader :cache_errors
-
-      #
-      # The path to require to access the Class of the cached object.
-      #
-      # @return [String]
-      #   The possible path inferred from the class name.
-      #
-      # @since 1.1.0
-      #
-      def class_path
-        if self.class_name
-          DataMapper::Inflector.underscore(self.class_name)
-        end
-      end
-
-      #
-      # The Model of the cached object.
-      #
-      # @return [Class, nil]
-      #   Returns the Model of the cached object, or `nil` if the class
-      #   could not be loaded or found.
-      #
-      # @since 1.1.0
-      #
-      def script_class
-        return unless self.class_name
-
-        # filter out unloadable script classes
-        begin
-          require class_path
-        rescue Gem::LoadError => e
-          raise(e)
-        rescue ::LoadError
-        end
-
-        # filter out missing class names
-        loaded_class = begin
-                         DataMapper::Ext::Object.full_const_get(self.class_name)
-                       rescue NameError
-                         return nil
-                       end
-
-        # filter out non-script classes
-        return loaded_class if loaded_class < Script
-      end
-
-      #
-      # The object from the Database that was cached from the file.
-      #
-      # @return [Model]
-      #   The previously cached object connected to the cache file.
-      #
-      # @since 1.1.0
-      #
-      def cached_script
-        if (cached_class = script_class)
-          return cached_class.first(:script_path => self)
-        end
-      end
-
-      #
-      # A freshly loaded {Script} object from the cache file.
-      #
-      # @return [Script, nil]
-      #   The first {Script} object loaded from the cache file.
-      #   If `nil` is returned, the file did not contain any cacheable
-      #   objects or the cache file contained a syntax error.
-      #   
-      # @since 1.1.0
-      #
-      def load_script
-        begin
-          # load the first found object
-          blocks = ObjectLoader.load_blocks(self.path)
-        rescue ::Exception => e
-          @cache_exception = e
-          return nil
-        end
-
-        blocks.each do |object_class,object_block|
-          if object_class < Script
-            # create the fresh object
-            object = object_class.new()
-
-            begin
-              object.instance_eval(&object_block)
-
-              @cache_exception = nil
-              return object
-            rescue ::Exception => e
-              @cache_exception = e
-            end
-          end
-        end
-
-        return nil
-      end
-
-      #
-      # Determines if the cache file was updated.
-      #
-      # @return [Boolean]
-      #   Specifies whether the cache file was updated.
-      #
-      # @since 1.1.0
-      #
-      def updated?
-        # assume updates if there is no timestamp
-        return true unless self.timestamp
-
-        if File.file?(self.path)
-          return self.path.mtime > self.timestamp
-        end
-
-        # do not assume updates, if there is no path
-        return false
-      end
-
-      #
-      # Determines if the cache file was deleted.
-      #
-      # @return [Boolean]
-      #   Specifies whether the cache file was deleted.
-      #
-      # @since 1.1.0
-      #
-      def missing?
-        !(self.path.file?)
-      end
-
-      #
-      # Caches the freshly loaded object from the cache file into the
-      # Database.
-      #
-      # @return [Boolean]
-      #   Specifies whether the object was successfully cached.
-      #
-      # @since 1.1.0
-      #
-      def cache
-        if (new_script = load_script)
-          # reset the model-class
-          self.class_name = new_script.class.to_s
-
-          # update the timestamp
-          self.timestamp = self.path.mtime
-
-          # re-cache the newly loaded script
-          new_script.script_path = self
-
-          if new_script.save
-            @cache_errors = nil
-            return true
-          else
-            @cache_errors = new_script.errors
-          end
-        end
-
-        return false
-      end
-
-      #
-      # Syncs the cached object in the Database with the object loaded from
-      # the cache file.
-      #
-      # @return [Boolean]
-      #   Specifies whether the cached object was successfully synced.
-      #
-      # @since 1.1.0
-      #
-      def sync
-        if missing?
-          # destroy the cached file, if the actual file is missing
-          return destroy
-        elsif updated?
-          # clean the previously cached file
-          clean
-
-          # if we couldn't cache anything, self-destruct
-          destroy unless cache
-          return true
-        end
-
-        return false
-      end
-
-      #
-      # Cleans the cached file from the Database.
-      #
-      # @since 1.4.0
-      #
-      def clean
-        if (script = cached_script)
-          # destroy the previously cached object
-          script.destroy!
-        end
-      end
-
-      #
-      # Before destroying the cached file object, also destroy the
-      # associated cached object.
-      #
-      # @since 1.1.0
-      #
-      def destroy
-        clean unless destroyed?
-
-        return super
-      end
-
-      #
-      # Before forcibly destroying the cached file object, also destroy the
-      # associated cached object.
-      #
-      # @since 1.4.0
-      #
-      def destroy!
-        clean unless destroyed?
-
-        return super
-      end
-
-      #
-      # Converts the script path to a String.
-      #
-      # @return [String]
-      #   The path of the script path.
-      #
-      # @since 1.1.0
-      #
-      def to_s
-        self.path.to_s
-      end
-
-    end
-  end
-end

data/lib/ronin/script/script.rb

@@ -1,384 +0,0 @@
-#
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin.
-#
-# Ronin is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ronin is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ronin.  If not, see <https://www.gnu.org/licenses/>.
-#
-
-require 'ronin/script/path'
-require 'ronin/model/model'
-require 'ronin/model/has_name'
-require 'ronin/model/has_description'
-require 'ronin/model/has_version'
-require 'ronin/model/has_license'
-require 'ronin/model/has_authors'
-require 'ronin/ui/output/helpers'
-
-require 'object_loader'
-require 'data_paths/finders'
-require 'parameters'
-
-module Ronin
-  #
-  # {Script} is a high-level module that enables a Class to load
-  # instances from files and cache them into the {Database}.
-  # Classes that include {Script}, may also include Script sub-modules
-  # that define behaviors of the Script Class:
-  #
-  # * {Buildable}
-  # * {Testable}
-  # * {Deployable}
-  #
-  # @since 1.1.0
-  #
-  module Script
-    include UI::Output::Helpers
-
-    #
-    # Adds the following to the Class.
-    #
-    # * {Script::InstanceMethods}
-    # * {Model}
-    # * {Model::HasName}
-    # * {Model::HasDescription}
-    # * {Model::HasVersion}
-    # * {Model::HasLicense}
-    # * {Model::HasAuthors}
-    # * [ObjectLoader](http://rubydoc.info/gems/object_loader)
-    # * [DataPaths::Finders](http://rubydoc.info/gems/data_paths)
-    # * [Parameters](http://rubydoc.info/gems/parameters)
-    # * {ClassMethods}
-    #
-    # @api semipublic
-    #
-    def self.included(base)
-      base.send :include, InstanceMethods,
-                          Model,
-                          Model::HasName,
-                          Model::HasDescription,
-                          Model::HasVersion,
-                          Model::HasLicense,
-                          Model::HasAuthors,
-                          ObjectLoader,
-                          DataPaths::Finders,
-                          Parameters
-
-      base.send :extend, ClassMethods
-
-      base.module_eval do
-        # The class-name of the cached object
-        property :type, DataMapper::Property::Discriminator
-
-        # The cached file of the object
-        belongs_to :script_path, Ronin::Script::Path, :required => false
-
-        # Validations
-        validates_uniqueness_of :version, :scope => [:name]
-      end
-
-      Path.has 1, base.relationship_name, base, :child_key => [:script_path_id]
-    end
-
-    #
-    # @since 1.1.0
-    #
-    module ClassMethods
-      #
-      # The shortened name of the Script class.
-      #
-      # @return [String]
-      #   The shortened name.
-      #
-      # @since 1.4.0
-      #
-      # @api semipublic
-      #
-      def short_name
-        @short_name ||= self.name.split('::').last
-      end
-
-      #
-      # Loads the {Script} of the same class.
-      #
-      # @param [String] path
-      #   The path to load the script from.
-      #
-      # @return [Script]
-      #   The loaded script.
-      #
-      # @example
-      #   Exploits::HTTP.load_from('mod_php_exploit.rb')
-      #   # => #<Ronin::Exploits::HTTP: ...>
-      #
-      # @since 1.1.0
-      #
-      def load_from(path)
-        load_object(path)
-      end
-
-      #
-      # Loads all objects with the matching attributes.
-      #
-      # @param [Hash] attributes
-      #   Attributes to search for.
-      #
-      # @since 1.1.0
-      #
-      # @api public
-      #
-      def load_all(attributes={})
-        resources = all(attributes)
-        resources.each { |resource| resource.load_script! }
-
-        return resources
-      end
-
-      #
-      # Loads the first object with matching attributes.
-      #
-      # @param [Hash] attributes
-      #   Attributes to search for.
-      #
-      # @return [Cacheable]
-      #   The loaded cached objects.
-      #
-      # @since 1.1.0
-      #
-      # @api public
-      #
-      def load_first(attributes={})
-        if (resource = first(attributes))
-          resource.load_script!
-        end
-
-        return resource
-      end
-    end
-
-    #
-    # Instance methods for an {Script}.
-    #
-    # @since 1.1.0
-    #
-    module InstanceMethods
-      #
-      # Initializes the Ronin Script.
-      #
-      # @param [Array] arguments
-      #   Arguments for initializing the Script.
-      #
-      # @since 1.1.0
-      #
-      # @api semipublic
-      #
-      def initialize(*arguments,&block)
-        @script_loaded = false
-        @cache_prepared = false
-
-        if arguments.first.kind_of?(Hash)
-          initialize_params(arguments.first)
-        end
-
-        super(*arguments,&block)
-      end
-
-      #
-      # Determines if the original code, from the cache file, has been
-      # loaded into the object.
-      #
-      # @return [Boolean]
-      #   Specifies whether the original code has been loaded into the
-      #   object.
-      #
-      # @since 1.1.0
-      #
-      # @api private
-      #
-      def script_loaded?
-        @script_loaded == true
-      end
-
-      #
-      # Loads the code from the cached file for the object, and instance
-      # evaluates it into the object.
-      #
-      # @return [Boolean]
-      #   Indicates the original code was successfully loaded.
-      #
-      # @since 1.1.0
-      #
-      # @api private
-      #
-      def load_script!
-        if (cached? && !script_loaded?)
-          block = self.class.load_object_block(self.script_path.path)
-
-          @script_loaded = true
-          instance_eval(&block) if block
-          return true
-        end
-
-        return false
-      end
-
-      #
-      # @return [Boolean]
-      #   Specifies whether the object has been prepared to be cached,
-      #
-      # @since 1.1.0
-      #
-      # @api private
-      #
-      def prepared_for_cache?
-        @cache_prepared == true
-      end
-
-      #
-      # Indicates whether the object has been cached.
-      #
-      # @return [Boolean]
-      #   Specifies whether the object has been previously cached.
-      #
-      # @since 1.1.0
-      #
-      # @api private
-      #
-      def cached?
-        (saved? && self.script_path)
-      end
-
-      #
-      # Default method which invokes the script.
-      #
-      # @param [Array] arguments
-      #   Optional arguments.
-      #
-      # @since 1.1.0
-      #
-      def run(*arguments)
-      end
-
-      #
-      # Converts the script to a String.
-      #
-      # @return [String]
-      #   The name and version of the script.
-      #
-      # @since 1.1.0
-      #
-      # @api public
-      #
-      def to_s
-        if (self.name && self.version)
-          "#{self.name} #{self.version}"
-        elsif self.name
-          super
-        elsif self.version
-          self.version.to_s
-        end
-      end
-
-      #
-      # Inspects both the properties and parameters of the Ronin Script.
-      #
-      # @return [String]
-      #   The inspected Ronin Script.
-      #
-      # @since 1.1.0
-      #
-      # @api public
-      #
-      def inspect
-        body = []
-
-        self.attributes.each do |name,value|
-          body << "#{name}: #{value.inspect}"
-        end
-
-        param_pairs = []
-
-        self.params.each do |name,param|
-          param_pairs << "#{name}: #{param.value.inspect}"
-        end
-
-        body << "params: {#{param_pairs.join(', ')}}"
-
-        return "#<#{self.class}: #{body.join(', ')}>"
-      end
-
-      protected
-
-      #
-      # Will call the given block only once, in order to prepare the
-      # object for caching.
-      #
-      # @yield []
-      #   The block will be ran inside the object when the object is to be
-      #   prepared for caching.
-      #
-      # @return [Boolean]
-      #   Specifies whether the object was successfully prepared for
-      #   caching.
-      #
-      # @since 1.1.0
-      #
-      # @api public
-      #
-      def cache
-        if (block_given? && !(cached? || prepared_for_cache?))
-          @cache_prepared = true
-
-          yield
-          return true
-        end
-
-        return false
-      end
-    end
-
-    # 
-    # Loads a script from a file.
-    #
-    # @param [String] path
-    #   The path to the file.
-    #
-    # @return [Script]
-    #   The loaded script.
-    #
-    # @since 1.1.0
-    #
-    # @api semipublic
-    #
-    def Script.load_from(path)
-      path = File.expand_path(path)
-      script = ObjectLoader.load_objects(path).find do |obj|
-        obj.class < Script
-      end
-
-      unless script
-        raise("No cacheable object defined in #{path.dump}")
-      end
-
-      script.instance_variable_set('@script_loaded',true)
-      script.script_path = Path.new(
-        :path => path,
-        :timestamp => File.mtime(path),
-        :class_name => script.class.to_s
-      )
-
-      return script
-    end
-  end
-end