ronin 1.0.0 → 1.1.0.rc1

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

@@ -0,0 +1,115 @@
+#
+# Copyright (c) 2006-2011 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 <http://www.gnu.org/licenses/>.
+#
+
+require 'ronin/ui/cli/model_command'
+require 'ronin/ui/console'
+require 'ronin/script'
+
+module Ronin
+  module UI
+    module CLI
+      #
+      # A base-command for querying and loading {Script}s.
+      #
+      class ScriptCommand < ModelCommand
+
+        query_option :named, :type => :string, :aliases => '-n'
+        query_option :describing, :type => :string, :aliases => '-d'
+        query_option :revision, :type => :string, :aliases => '-V'
+        query_option :licensed_under, :type => :string, :aliases => '-L'
+
+        class_option :file, :type => :string, :aliases => '-f'
+        class_option :params, :type => :hash,
+                              :default => {},
+                              :banner => 'NAME:VALUE ...',
+                              :aliases => '-p'
+        class_option :console, :type => :boolean, :default => false
+
+        #
+        # Loads the script, sets its parameters and runs the script.
+        #
+        # @since 1.1.0.
+        #
+        # @api semipublic
+        #
+        def execute
+          script = load_script
+          script.params = options[:params]
+
+          if options.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)
+          unless script.included_modules.include?(Script)
+            raise(ArgumentError,"#{script} does not include Ronin::Script")
+          end
+
+          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 options[:file]
+            self.class.query_model.load_from(options[:file])
+          else
+            query.load_first
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/ui/console.rb

@@ -44,6 +44,8 @@ module Ronin
       #
       # @since 1.0.0
       #
+      # @api semipublic
+      #
       def Console.color?
         @@color
       end
@@ -59,6 +61,8 @@ module Ronin
       #
       # @since 1.0.0
       #
+      # @api semipublic
+      #
       def Console.color=(mode)
         @@color = mode
       end
@@ -72,6 +76,8 @@ module Ronin
       #
       # @since 1.0.0
       #
+      # @api semipublic
+      #
       def Console.short_errors?
         @@short_errors
       end
@@ -87,6 +93,8 @@ module Ronin
       #
       # @since 1.0.0
       #
+      # @api semipublic
+      #
       def Console.short_errors=(mode)
         @@short_errors = mode
       end
@@ -97,6 +105,8 @@ module Ronin
       # @return [Array]
       #   The files to require when the Console starts.
       #
+      # @api semipublic
+      #
       def Console.auto_load
         @@auto_load
       end
@@ -108,6 +118,8 @@ module Ronin
       # @yield []
       #   The block to be ran from within the Console.
       #
+      # @api semipublic
+      #
       def Console.setup(&block)
         @@setup_blocks << block if block
       end
@@ -138,6 +150,8 @@ module Ronin
       #   # >> @var
       #   # # => "hello"
       #
+      # @api semipublic
+      #
       def Console.start(variables={},&block)
         require 'ripl'
         require 'ripl/completion'
@@ -147,11 +161,9 @@ module Ronin
         require 'ripl/short_errors' if @@short_errors
 
         require 'ronin'
+        require 'ronin/repositories'
         require 'pp'
 
-        # activates all installed or added repositories
-        Repository.activate!
-
         # append the current directory to $LOAD_PATH for Ruby 1.9.
         $LOAD_PATH << '.' unless $LOAD_PATH.include?('.')
 
@@ -194,6 +206,8 @@ module Ronin
         #
         # @since 1.0.0
         #
+        # @api semipublic
+        #
         def inspect
           "#<Ronin::UI::Console>"
         end

data/lib/ronin/ui/output/helpers.rb

@@ -37,6 +37,8 @@ module Ronin
         #
         # @since 1.0.0
         #
+        # @api public
+        #
         def write(data)
           unless Output.silent?
             data = data.to_s
@@ -57,6 +59,8 @@ module Ronin
         #
         # @since 1.0.0
         #
+        # @api public
+        #
         def putc(data)
           char = data.chr if data.kind_of?(Integer)
 
@@ -75,6 +79,8 @@ module Ronin
         #
         # @since 0.3.0
         #
+        # @api public
+        #
         def puts(*messages)
           unless messages.empty?
             messages.each { |message| write("#{message}#{$/}") }
@@ -98,6 +104,8 @@ module Ronin
         # 
         # @since 1.0.0
         #
+        # @api public
+        #
         def printf(format,*data)
           write(format % data)
           return nil
@@ -120,6 +128,8 @@ module Ronin
         #
         # @since 0.3.0
         #
+        # @api public
+        #
         def print_info(*message)
           unless Output.silent?
             Output.handler.print_info(format_message(message))
@@ -143,6 +153,8 @@ module Ronin
         #
         # @since 0.3.0
         #
+        # @api public
+        #
         def print_debug(*message)
           if (Output.verbose? && !(Output.silent?))
             Output.handler.print_debug(format_message(message))
@@ -169,6 +181,8 @@ module Ronin
         #
         # @since 0.3.0
         #
+        # @api public
+        #
         def print_warning(*message)
           if (Output.verbose? && !(Output.silent?))
             Output.handler.print_warning(format_message(message))
@@ -195,6 +209,8 @@ module Ronin
         #
         # @since 0.3.0
         #
+        # @api public
+        #
         def print_error(*message)
           unless Output.silent?
             Output.handler.print_error(format_message(message))
@@ -217,6 +233,8 @@ module Ronin
         #
         # @since 1.0.0
         #
+        # @api private
+        #
         def format_message(message)
           if message.length == 1
             message[0]

data/lib/ronin/ui/output/output.rb

@@ -17,6 +17,7 @@
 # along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
 #
 
+require 'ronin/ui/output/terminal/raw'
 require 'ronin/ui/output/terminal/color'
 
 module Ronin
@@ -26,7 +27,11 @@ module Ronin
     #
     module Output
       @mode = :quiet
-      @handler = Terminal::Color
+      @handler = if STDOUT.tty?
+                   Terminal::Color
+                 else
+                   Terminal::Raw
+                 end
 
       #
       # @return [Boolean]
@@ -34,6 +39,8 @@ module Ronin
       #
       # @since 0.3.0
       #
+      # @api semipublic
+      #
       def Output.verbose?
         @mode == :verbose
       end
@@ -44,6 +51,8 @@ module Ronin
       #
       # @since 0.3.0
       #
+      # @api semipublic
+      #
       def Output.quiet?
         @mode == :quiet
       end
@@ -54,6 +63,8 @@ module Ronin
       #
       # @since 0.3.0
       #
+      # @api semipublic
+      #
       def Output.silent?
         @mode == :silent
       end
@@ -65,6 +76,8 @@ module Ronin
       #
       # @since 1.0.0
       #
+      # @api semipublic
+      #
       def Output.verbose!
         @mode = :verbose
         return self
@@ -77,6 +90,8 @@ module Ronin
       #
       # @since 1.0.0
       #
+      # @api semipublic
+      #
       def Output.quiet!
         @mode = :quiet
         return self
@@ -100,6 +115,8 @@ module Ronin
       #
       # @since 0.3.0
       #
+      # @api semipublic
+      #
       def Output.handler
         @handler
       end
@@ -114,6 +131,8 @@ module Ronin
       #
       # @since 0.3.0
       #
+      # @api semipublic
+      #
       def Output.handler=(new_handler)
         @handler = new_handler
       end

data/lib/ronin/ui/output/terminal/color.rb

@@ -49,6 +49,8 @@ module Ronin
           #
           # @since 1.0.0
           #
+          # @api private
+          #
           def self.write(data)
             STDOUT.write(data)
           end
@@ -61,6 +63,8 @@ module Ronin
           #
           # @since 1.0.0
           #
+          # @api private
+          #
           def self.print_info(message)
             puts "#{GREEN}[-] #{message}#{CLEAR}"
           end
@@ -73,6 +77,8 @@ module Ronin
           #
           # @since 1.0.0
           #
+          # @api private
+          #
           def self.print_debug(message)
             puts "#{CYAN}[=] #{message}#{CLEAR}"
           end
@@ -85,6 +91,8 @@ module Ronin
           #
           # @since 1.0.0
           #
+          # @api private
+          #
           def self.print_warning(message)
             puts "#{YELLOW}[*] #{message}#{CLEAR}"
           end
@@ -97,6 +105,8 @@ module Ronin
           #
           # @since 1.0.0
           #
+          # @api private
+          #
           def self.print_error(message)
             puts "#{RED}[!] #{message}#{CLEAR}"
           end

data/lib/ronin/ui/output/terminal/raw.rb

@@ -34,6 +34,8 @@ module Ronin
           #
           # @since 1.0.0
           #
+          # @api private
+          #
           def self.write(data)
             STDOUT.write(data)
           end
@@ -46,6 +48,8 @@ module Ronin
           #
           # @since 1.0.0
           #
+          # @api private
+          #
           def self.print_info(message)
             puts "[-] #{message}"
           end
@@ -58,6 +62,8 @@ module Ronin
           #
           # @since 1.0.0
           #
+          # @api private
+          #
           def self.print_debug(message)
             puts "[=] #{message}"
           end
@@ -70,6 +76,8 @@ module Ronin
           #
           # @since 1.0.0
           #
+          # @api private
+          #
           def self.print_warning(message)
             puts "[*] #{message}"
           end
@@ -82,6 +90,8 @@ module Ronin
           #
           # @since 1.0.0
           #
+          # @api private
+          #
           def self.print_error(message)
             puts "[!] #{message}"
           end

data/lib/ronin/ui/shell.rb

@@ -57,6 +57,8 @@ module Ronin
       # @example
       #   Shell.start(:prompt => '$') { |shell,line| system(line) }
       #
+      # @api semipublic
+      #
       def Shell.start(options={},&block)
         name = (options[:name] || '')
         prompt = (options[:prompt] || DEFAULT_PROMPT)