ronin 1.5.1 → 2.0.0.beta1

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

@@ -1,215 +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/console/context'
-require 'ronin/config'
-require 'ronin/repository'
-
-require 'ripl'
-require 'ripl/multi_line'
-require 'ripl/auto_indent'
-
-module Ronin
-  module UI
-    #
-    # An interactive Ruby {Console} using
-    # [Ripl](https://github.com/cldwalker/ripl).
-    #
-    module Console
-
-      # The history file for the Console session
-      HISTORY_FILE = File.join(Config::PATH,'console.log')
-
-      @@color        = !(STDOUT.tty?)
-      @@short_errors = !(ENV.has_key?('VERBOSE'))
-      @@auto_load    = []
-      @@setup_blocks = []
-
-      #
-      # Determines whether colorized output will be enabled.
-      #
-      # @return [Boolean]
-      #   Specifies whether colorized output will be enabled.
-      #
-      # @since 1.0.0
-      #
-      # @api semipublic
-      #
-      def Console.color?
-        @@color
-      end
-
-      #
-      # Enables or disables colorized output.
-      #
-      # @param [Boolean] mode
-      #   The new colorized output mode.
-      #
-      # @return [Boolean]
-      #   The colorized output mode.
-      #
-      # @since 1.0.0
-      #
-      # @api semipublic
-      #
-      def Console.color=(mode)
-        @@color = mode
-      end
-
-      #
-      # Determines whether one-line errors will be printed, instead of full
-      # backtraces.
-      #
-      # @return [Boolean]
-      #   The Console short-errors setting.
-      #
-      # @since 1.0.0
-      #
-      # @api semipublic
-      #
-      def Console.short_errors?
-        @@short_errors
-      end
-
-      #
-      # Enables or disables the printing of one-line errors.
-      #
-      # @param [Boolean] mode
-      #   The new Console short-errors setting.
-      #
-      # @return [Boolean]
-      #   The Console short-errors setting.
-      #
-      # @since 1.0.0
-      #
-      # @api semipublic
-      #
-      def Console.short_errors=(mode)
-        @@short_errors = mode
-      end
-
-      #
-      # The list of files to load before starting the Console.
-      #
-      # @return [Array]
-      #   The files to require when the Console starts.
-      #
-      # @api semipublic
-      #
-      def Console.auto_load
-        @@auto_load
-      end
-
-      #
-      # Adds a block to be ran from within the Console after it is
-      # started.
-      #
-      # @yield []
-      #   The block to be ran from within the Console.
-      #
-      # @api semipublic
-      #
-      def Console.setup(&block)
-        @@setup_blocks << block if block
-      end
-
-      #
-      # The list of completions files to require.
-      #
-      # @return [Array<String>]
-      #   The sub-paths to require within `bond/completions/`.
-      #
-      # @since 1.2.0
-      #
-      # @api semipublic
-      #
-      def Console.completions
-        (Ripl.config[:completion][:gems] ||= [])
-      end
-
-      Console.completions << 'ronin'
-
-      #
-      # Starts a Console.
-      #
-      # @param [Hash{Symbol => Object}] variables
-      #   Instance variable names and values to set within the console.
-      #
-      # @yield []
-      #   The block to be ran within the Console, after it has been setup.
-      #
-      # @return [Console]
-      #   The instance context the Console ran within.
-      #
-      # @example
-      #   Console.start
-      #   # >>
-      #
-      # @example
-      #   Console.start(:var => 'hello')
-      #   # >> @var
-      #   # # => "hello"
-      #
-      # @example
-      #   Console.start { @var = 'hello' }
-      #   # >> @var
-      #   # # => "hello"
-      #
-      # @api semipublic
-      #
-      def Console.start(variables={},&block)
-        require 'ripl/color_result' if @@color
-        require 'ripl/short_errors' if @@short_errors
-
-        require 'ronin'
-        require 'ronin/repositories'
-        require 'pp'
-
-        # append the current directory to $LOAD_PATH for Ruby 1.9.
-        $LOAD_PATH << '.' unless $LOAD_PATH.include?('.')
-
-        # require any of the auto-load paths
-        @@auto_load.each { |path| require path }
-
-        context = Context.new
-        context.instance_variables = variables
-
-        # run any setup-blocks
-        @@setup_blocks.each do |setup_block|
-          context.instance_eval(&setup_block)
-        end
-
-        # run the supplied configuration block is given
-        context.instance_eval(&block) if block
-
-        # Start the Ripl console
-        Ripl.start(
-          :argv    => [],
-          :name    => 'ronin',
-          :binding => context.instance_eval('binding'),
-          :history => HISTORY_FILE,
-          :irbrc   => false
-        )
-
-        return context
-      end
-
-    end
-  end
-end

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

@@ -1,106 +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/>.
-#
-
-module Ronin
-  module UI
-    module Console
-      #
-      # @since 1.2.0
-      #
-      class Context
-
-        #
-        # Creates a new {Console} context.
-        #
-        # @return [Class<Context>]
-        #   A new context for the {Console}.
-        #
-        def self.new
-          class << super; self; end
-        end
-
-        class << self
-          #
-          # Catches missing constants and searches the {Ronin} namespace.
-          #
-          # @param [Symbol] name
-          #   The constant name.
-          #
-          # @return [Object]
-          #   The found constant.
-          #
-          # @raise [NameError]
-          #   The constant could not be found within {Ronin}.
-          #
-          # @since 1.0.0
-          #
-          # @api semipublic
-          #
-          def self.const_missing(name)
-            Ronin.send(:const_missing,name)
-          end
-
-          #
-          # @note
-          #   Ruby 1.8.x requires {const_missing} to be defined as an
-          #   instance-method.
-          #
-          def const_missing(name)
-            Ronin.send(:const_missing,name)
-          end
-
-          #
-          # Populates the instance variables.
-          #
-          # @param [Hash] variables
-          #   The variable names and values.
-          #
-          def instance_variables=(variables)
-            variables.each do |name,value|
-              instance_variable_set(:"@#{name}",value)
-            end
-          end
-
-          #
-          # Inspects the console.
-          #
-          # @return [String]
-          #   The inspected console.
-          #
-          # @since 1.0.0
-          #
-          # @api semipublic
-          #
-          def inspect
-            unless instance_variables.empty?
-              body = ':'
-
-              instance_variables.each do |name|
-                body << " #{name}=#{instance_variable_get(name).inspect}"
-              end
-            end
-
-            return "#<Ronin::UI::Console#{body}>"
-          end
-        end
-
-      end
-    end
-  end
-end

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

@@ -1,184 +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/config'
-
-require 'set'
-require 'shellwords'
-
-module Ronin
-  module UI
-    module Console
-      #
-      # Allows for executing shell commands prefixed by a `!`.
-      #
-      # @since 1.5.0
-      #
-      # @api private
-      #
-      module Shell
-        # Names and statuses of executables.
-        EXECUTABLES = Hash.new do |hash,key|
-          hash[key] = Config::BIN_DIRS.any? do |dir|
-            path = File.join(dir,key)
-
-            (File.file?(path) && File.executable?(path))
-          end
-        end
-
-        # Regexp to recognize `!commands`.
-        PATTERN = /^![a-zA-Z][a-zA-Z0-9\._-]*/
-
-        # Blacklist of known commands that conflict with Ruby keywords.
-        BLACKLIST = Set[
-          '[', 'ap', 'begin', 'case', 'class', 'def', 'fail', 'false',
-          'for', 'if', 'lambda', 'load', 'loop', 'module', 'p', 'pp',
-          'print', 'proc', 'puts', 'raise', 'require', 'true', 'undef',
-          'unless', 'until', 'warn', 'while'
-        ]
-
-        #
-        # Dynamically execute shell commands, instead of Ruby.
-        #
-        # @param [String] input
-        #   The input from the console.
-        #
-        def loop_eval(input)
-          if (@buffer.nil? && input =~ PATTERN)
-            command = input[1..-1]
-            name, arguments = parse_command(command)
-
-            unless BLACKLIST.include?(name)
-              if Shell.singleton_class.method_defined?(name)
-                arguments ||= []
-
-                return Shell.send(name,*arguments)
-              elsif executable?(name)
-                return Shell.exec(name,*arguments)
-              end
-            end
-          end
-
-          super(input)
-        end
-
-        #
-        # Default command which executes a command in the shell.
-        #
-        # @param [Array<String>] arguments
-        #   The arguments of the command.
-        #
-        # @return [Boolean]
-        #   Specifies whether the command exited successfully.
-        #
-        # @since 1.5.0
-        #
-        def self.exec(*arguments)
-          system(Shellwords.shelljoin(arguments))
-        end
-
-        #
-        # Equivalent of the `cd` command, using `Dir.chdir`.
-        #
-        # @param [Array<String>] arguments
-        #   The arguments of the command.
-        #
-        # @return [Boolean]
-        #   Specifies whether the directory change was successful.
-        #
-        def self.cd(*arguments)
-          old_pwd = Dir.pwd
-
-          new_cwd = if arguments.empty?
-                      Config::HOME
-                    elsif arguments.first == '-'
-                      unless ENV['OLDPWD']
-                        print_warning 'cd: OLDPWD not set'
-                        return false
-                      end
-
-                      ENV['OLDPWD']
-                    else
-                      arguments.first
-                    end
-
-          Dir.chdir(new_cwd)
-          ENV['OLDPWD'] = old_pwd
-          return true
-        end
-
-        #
-        # Equivalent of the `export` or `set` commands.
-        #
-        # @param [Array<String>] arguments
-        #   The arguments of the command.
-        #
-        # @return [true]
-        #
-        def self.export(*arguments)
-          arguments.each do |pair|
-            name, value = pair.split('=',2)
-
-            ENV[name] = value
-          end
-        end
-
-        protected
-
-        #
-        # Parses a Console command.
-        #
-        # @param [String] command
-        #   The Console command to parse.
-        #
-        # @return [String, Array<String>]
-        #   The command name and additional arguments.
-        #
-        # @since 1.5.0
-        #
-        def parse_command(command)
-          # evaluate embedded Ruby expressions
-          command = command.gsub(/\#\{[^\}]*\}/) do |expression|
-            eval(expression[2..-2],Ripl.config[:binding]).to_s.dump
-          end
-
-          arguments = Shellwords.shellsplit(command)
-          name      = arguments.shift
-
-          return name, arguments
-        end
-
-        #
-        # Determines if an executable exists on the system.
-        #
-        # @param [String] name
-        #   The program name or path.
-        #
-        # @return [Boolean]
-        #   Specifies whether the executable exists.
-        #
-        def executable?(name)
-          (File.file?(name) && File.executable?(name)) || EXECUTABLES[name]
-        end
-      end
-    end
-  end
-end
-
-Ripl::Shell.send :include, Ronin::UI::Console::Shell

data/lib/ronin/ui/console.rb

@@ -1,22 +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/console/console'
-require 'ronin/ui/console/commands'
-require 'ronin/ui/console/shell'