ronin 1.5.1 → 2.0.0.beta1

data/lib/ronin/ui/cli/printing.rb

@@ -1,167 +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/ui/output/helpers'
-
-module Ronin
-  module UI
-    module CLI
-      #
-      # CLI Printing helper methods.
-      #
-      # @since 1.4.0
-      #
-      module Printing
-        include Output::Helpers
-
-        #
-        # Initializes Printing settings.
-        #
-        def initialize
-          @indent = 0
-        end
-
-        #
-        # Increases the indentation out output temporarily.
-        #
-        # @param [Integer] n
-        #   The number of spaces to increase the indentation by.
-        #
-        # @yield []
-        #   The block will be called after the indentation has been
-        #   increased. After the block has returned, the indentation will
-        #   be returned to normal.
-        #
-        # @return [nil]
-        #
-        # @api semipublic
-        #
-        def indent(n=2)
-          @indent += n
-
-          yield
-
-          @indent -= n
-          return nil
-        end
-
-        #
-        # Print the given messages with indentation.
-        #
-        # @param [Array] messages
-        #   The messages to print, one per-line.
-        #
-        # @api semipublic
-        #
-        def puts(*messages)
-          super(*(messages.map { |mesg| (' ' * @indent) + mesg.to_s }))
-        end
-
-        #
-        # Prints a given title.
-        #
-        # @param [String] title
-        #   The title to print.
-        #
-        # @api semipublic
-        #
-        def print_title(title)
-          puts "[ #{title} ]\n"
-        end
-
-        #
-        # Prints a section with a title.
-        #
-        # @yield []
-        #   The block will be called after the title has been printed
-        #   and indentation increased.
-        #
-        # @since 1.0.0
-        #
-        # @api semipublic
-        #
-        def print_section(title,&block)
-          print_title(title)
-          indent(&block)
-        end
-
-        #
-        # Prints a given Array.
-        #
-        # @param [Array] array 
-        #   The Array to print.
-        #
-        # @param [Hash] options
-        #   Additional options.
-        #
-        # @option options [String] :title
-        #   The optional title to print before the contents of the Array.
-        #
-        # @return [nil]
-        #
-        # @api semipublic
-        #
-        def print_array(array,options={})
-          print_title(options[:title]) if options[:title]
-
-          indent do
-            array.each { |value| puts value }
-          end
-
-          puts if options[:title]
-          return nil
-        end
-
-        #
-        # Prints a given Hash.
-        #
-        # @param [Hash] hash
-        #   The Hash to print.
-        #
-        # @param [Hash] options
-        #   Additional options.
-        #
-        # @option options [String] :title
-        #   The optional title to print before the contents of the Hash.
-        #
-        # @return [nil]
-        #
-        # @api semipublic
-        #
-        def print_hash(hash,options={})
-          align = hash.keys.map { |name|
-            name.to_s.length
-          }.max
-
-          print_title(options[:title]) if options[:title]
-
-          indent do
-            hash.each do |name,value|
-              name = "#{name}:".ljust(align)
-              puts "#{name}\t#{value}"
-            end
-          end
-
-          puts if options[:title]
-          return nil
-        end
-      end
-    end
-  end
-end

data/lib/ronin/ui/cli/resources_command.rb

@@ -1,117 +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/ui/cli/model_command'
-require 'ronin/model/importable'
-
-module Ronin
-  module UI
-    module CLI
-      #
-      # A base-command class for listing Database Resources.
-      #
-      class ResourcesCommand < ModelCommand
-
-        option :csv, :type => true,
-                     :description => 'CSV output'
-
-        option :xml, :type => true,
-                     :description => 'XML output'
-
-        option :yaml, :type => true,
-                      :description => 'YAML output'
-
-        option :json, :type => true,
-                      :description => 'JSON output'
-
-        #
-        # Default method performs the query and prints the found resources.
-        #
-        # @since 1.1.0
-        #
-        # @api semipublic
-        #
-        def execute
-          if @import
-            self.class.model.import(@import) do |resource|
-              print_info "Imported #{resource}"
-            end
-          else
-            print_resources(query)
-          end
-        end
-
-        protected
-
-        #
-        # Sets the model used by the command.
-        #
-        # @see ModelCommand.model
-        #
-        # @since 1.3.0
-        #
-        def self.model(model=nil)
-          if (model && model < Model::Importable)
-            option :import, :type  => String,
-                            :flag  => '-i',
-                            :usage => 'FILE',
-                            :description => 'The file to import'
-          end
-
-          return super(model)
-        end
-
-        #
-        # Default method which will print every queried resource.
-        #
-        # @param [DataMapper::Resource] resource
-        #   A queried resource from the Database.
-        #
-        # @since 1.1.0
-        #
-        # @api semipublic
-        #
-        def print_resource(resource)
-          puts resource
-        end
-
-        #
-        # Prints multiple resources.
-        #
-        # @param [DataMapper::Collection] resources
-        #   The query to print.
-        #
-        # @since 1.1.0
-        #
-        # @api semipublic
-        #
-        def print_resources(resources)
-          if    csv?  then print resources.to_csv
-          elsif xml?  then print resources.to_xml
-          elsif yaml? then print resources.to_yaml
-          elsif json? then print resources.to_json
-          else
-            resources.each { |resource| print_resource(resource) }
-          end
-        end
-
-      end
-    end
-  end
-end

data/lib/ronin/ui/cli/script_command.rb

@@ -1,212 +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/ui/cli/model_command'
-require 'ronin/ui/console'
-require 'ronin/script'
-
-require 'parameters/options'
-
-module Ronin
-  module UI
-    module CLI
-      #
-      # A base-command for querying and loading {Script}s.
-      #
-      class ScriptCommand < ModelCommand
-
-        usage '[options] --'
-
-        query_option :named, :type  => String,
-                             :flag  => '-n',
-                             :usage => 'NAME'
-
-        query_option :describing, :type  => String,
-                                  :flag  => '-d',
-                                  :usage => 'DESC'
-
-        query_option :revision, :type  => String,
-                                :flag  => '-V',
-                                :usage => 'REV'
-
-        query_option :licensed_under, :type  => String,
-                                      :flag  => '-L',
-                                      :usage => 'LICENSE'
-
-        option :file, :type  => String,
-                      :flag  => '-f',
-                      :usage => 'FILE'
-
-        option :console, :type => true
-
-        argument :param_options, :type        => Array,
-                                 :default     => [],
-                                 :description => 'Additional options'
-
-        #
-        # Initializes the Script command.
-        #
-        # @param [Hash{Symbol => Object}] options
-        #   Options for the script command.
-        #
-        # @api semipublic
-        #
-        def initialize(options={})
-          super(options)
-
-          @script_options = []
-        end
-
-        #
-        # Starts the script command.
-        #
-        # @param [Array<String>] argv
-        #   Command-line arguments for the script command.
-        #
-        # @since 1.4.0
-        #
-        # @api semipublic
-        #
-        def start(argv=ARGV)
-          # collect the script options, upto the -- separator
-          @script_options = argv[0,argv.index('--') || argv.length]
-
-          super(argv)
-        end
-
-        #
-        # Sets up the script command, loads the script and parses additional
-        # options for the script.
-        #
-        # @since 1.4.0
-        #
-        # @api semipublic
-        #
-        def setup
-          super
-
-          load!
-          param_option_parser.parse(@param_options)
-        end
-
-        #
-        # Loads the script, sets its parameters and runs the script.
-        #
-        # @since 1.1.0.
-        #
-        # @api semipublic
-        #
-        def execute
-          if @console
-            print_info "Starting the console with @script set ..."
-
-            UI::Console.start(:script => @script)
-          else
-            @script.run
-          end
-        end
-
-        protected
-
-        #
-        # Defines the class to load scripts from.
-        #
-        # @param [Script] script
-        #   The script class.
-        #
-        # @return [Script]
-        #   The new script class.
-        #
-        # @raise [ArgumentError]
-        #   The given script class does not include {Ronin::Script}.
-        #
-        # @since 1.1.0
-        #
-        # @api semipublic
-        #
-        def self.script_class(script=nil)
-          if (script && !script.included_modules.include?(Script))
-            raise(ArgumentError,"#{script} does not include Ronin::Script")
-          end
-
-          return model(script)
-        end
-
-        #
-        # Loads an script using the commands options.
-        #
-        # @return [Script, nil]
-        #   The newly loaded script.
-        #
-        # @raise [RuntimeError]
-        #   The script class did not define the query method for one of the
-        #   query options.
-        #
-        # @since 1.1.0
-        #
-        # @api semipublic
-        #
-        def load!
-          @script = if @file then self.class.model.load_from(@file)
-                    else          query.load_first
-                    end
-
-          unless @script
-            print_error "Could not find or load the #{self.class.script_class.short_name}"
-            exit -1
-          end
-        end
-
-        #
-        # Creates an OptionParser based on the parameters of one or more
-        # objects.
-        #
-        # @yield [opts]
-        #   If a block is given, it will be passed the newly created
-        #   OptionParser.
-        #
-        # @yieldparam [OptionParser] opts
-        #   The newly created OptionParser for the parameters.
-        #
-        # @return [OptionParser]
-        #   The configured OptionParser for the parameters.
-        #
-        # @since 1.4.0
-        #
-        # @api semipublic
-        #
-        def param_option_parser
-          OptionParser.new do |opts|
-            opts.banner = "usage: #{self.class.command_name} #{@script_options.join(' ')} -- [script_options]"
-            
-            opts.separator ''
-            opts.separator "#{self.class.script_class.short_name} Options:"
-
-            @script.each_param do |param|
-              Parameters::Options.define(opts,param)
-            end
-
-            yield opts if block_given?
-          end
-        end
-
-      end
-    end
-  end
-end

data/lib/ronin/ui/cli.rb

@@ -1,21 +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/ui/cli/command'
-require 'ronin/ui/cli/cli'

data/lib/ronin/ui/console/commands.rb

@@ -1,86 +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 'shellwords'
-require 'tempfile'
-
-module Ronin
-  module UI
-    module Console
-      #
-      # Allows for calling {Console} commands via the `.` prefix.
-      #
-      # ## Commands
-      #
-      # * {edit .edit}
-      #
-      # @since 1.2.0
-      #
-      # @api private
-      #
-      module Commands
-        # Regexp to recognize `.commands`.
-        PATTERN = /^\.[a-z][a-z0-9_]*/
-
-        #
-        # Check for the `.` prefix, and attempt to call the Console command.
-        #
-        # @param [String] input
-        #   The input from the console.
-        #
-        def loop_eval(input)
-          if (@buffer.nil? && input =~ PATTERN)
-            command = input[1..-1]
-            name, arguments = Shellwords.shellsplit(command)
-
-            if Commands.singleton_class.method_defined?(name)
-              arguments ||= []
-
-              return Commands.send(name,*arguments)
-            end
-          end
-
-          super(input)
-        end
-
-        #
-        # Edits a path and re-loads the code.
-        #
-        # @param [String] path 
-        #   The path of the file to re-load.
-        #
-        # @return [Boolean]
-        #   Specifies whether the code was successfully re-loaded.
-        #
-        def self.edit(path=nil)
-          if ENV['EDITOR']
-            path ||= Tempfile.new(['ronin-console', '.rb']).path
-
-            system(ENV['EDITOR'],path) && load(path)
-          else
-            print_error "Please set the EDITOR env variable"
-            return false
-          end
-        end
-      end
-    end
-  end
-end
-
-Ripl::Shell.send :include, Ronin::UI::Console::Commands