ronin-support 0.2.0 → 0.3.0

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

@@ -0,0 +1,146 @@
+#
+# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of Ronin Support.
+#
+# Ronin Support is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ronin Support 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require 'ronin/ui/output/terminal/raw'
+require 'ronin/ui/output/terminal/color'
+
+module Ronin
+  module UI
+    #
+    # Controls {Output} from Ronin.
+    #
+    module Output
+      @mode = if ($VERBOSE || $DEBUG || ENV['VERBOSE'])
+                :verbose
+              else
+                :quiet
+              end
+
+      @handler = if STDOUT.tty?
+                   Terminal::Color
+                 else
+                   Terminal::Raw
+                 end
+
+      #
+      # @return [Boolean]
+      #   Specifies whether verbose output is enabled.
+      #
+      # @since 0.3.0
+      #
+      # @api semipublic
+      #
+      def Output.verbose?
+        @mode == :verbose
+      end
+
+      #
+      # @return [Boolean]
+      #   Specifies whether quiet output is enabled.
+      #
+      # @since 0.3.0
+      #
+      # @api semipublic
+      #
+      def Output.quiet?
+        @mode == :quiet
+      end
+
+      #
+      # @return [Boolean]
+      #   Specifies whether silent output is enabled.
+      #
+      # @since 0.3.0
+      #
+      # @api semipublic
+      #
+      def Output.silent?
+        @mode == :silent
+      end
+
+      #
+      # Enables verbose output.
+      #
+      # @return [Output]
+      #
+      # @since 1.0.0
+      #
+      # @api semipublic
+      #
+      def Output.verbose!
+        @mode = :verbose
+        return self
+      end
+
+      #
+      # Disables verbose output.
+      #
+      # @return [Output]
+      #
+      # @since 1.0.0
+      #
+      # @api semipublic
+      #
+      def Output.quiet!
+        @mode = :quiet
+        return self
+      end
+
+      #
+      # Disables all output.
+      #
+      # @return [Output]
+      #
+      # @since 1.0.0
+      #
+      def Output.silent!
+        @mode = :silent
+        return self
+      end
+
+      #
+      # @return [Ronin::UI::Output::Handler]
+      #   The current Output handler.
+      #
+      # @since 0.3.0
+      #
+      # @api semipublic
+      #
+      def Output.handler
+        @handler
+      end
+
+      #
+      # Sets the current Output handler.
+      #
+      # @param [Handler] new_handler
+      #   The new output handler to use. Must provide the `puts`,
+      #   `print_info`, `print_debug`, `print_warning` and `print_error`
+      #   class methods.
+      #
+      # @since 0.3.0
+      #
+      # @api semipublic
+      #
+      def Output.handler=(new_handler)
+        @handler = new_handler
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+#
+# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of Ronin Support.
+#
+# Ronin Support is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ronin Support 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require 'ronin/ui/output/terminal/raw'
+require 'ronin/ui/output/terminal/color'

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

@@ -0,0 +1,118 @@
+#
+# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of Ronin Support.
+#
+# Ronin Support is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ronin Support 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+module Ronin
+  module UI
+    module Output
+      module Terminal
+        #
+        # The handler for color output to the terminal.
+        #
+        class Color
+
+          # ANSI Green code
+          GREEN = "\e[32m"
+
+          # ANSI Cyan code
+          CYAN = "\e[36m"
+
+          # ANSI Yellow code
+          YELLOW = "\e[33m"
+
+          # ANSI Red code
+          RED = "\e[31m"
+
+          # ANSI Clear code
+          CLEAR = "\e[0m"
+
+          #
+          # Writes data to `STDOUT`.
+          #
+          # @param [String] data
+          #   The data to write.
+          #
+          # @since 1.0.0
+          #
+          # @api private
+          #
+          def self.write(data)
+            STDOUT.write(data)
+          end
+
+          #
+          # Prints an `info` message.
+          #
+          # @param [String] message
+          #   The message to print.
+          #
+          # @since 1.0.0
+          #
+          # @api private
+          #
+          def self.print_info(message)
+            puts "#{GREEN}[-] #{message}#{CLEAR}"
+          end
+
+          #
+          # Prints a `debug` message.
+          #
+          # @param [String] message
+          #   The message to print.
+          #
+          # @since 1.0.0
+          #
+          # @api private
+          #
+          def self.print_debug(message)
+            puts "#{CYAN}[=] #{message}#{CLEAR}"
+          end
+
+          #
+          # Prints a `warning` message.
+          #
+          # @param [String] message
+          #   The message to print.
+          #
+          # @since 1.0.0
+          #
+          # @api private
+          #
+          def self.print_warning(message)
+            puts "#{YELLOW}[*] #{message}#{CLEAR}"
+          end
+
+          #
+          # Prints an `error` message.
+          #
+          # @param [String] message
+          #   The message to print.
+          #
+          # @since 1.0.0
+          #
+          # @api private
+          #
+          def self.print_error(message)
+            puts "#{RED}[!] #{message}#{CLEAR}"
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,103 @@
+#
+# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of Ronin Support.
+#
+# Ronin Support is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ronin Support 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+module Ronin
+  module UI
+    module Output
+      module Terminal
+        #
+        # The handler for raw output to the terminal.
+        #
+        class Raw
+
+          #
+          # Writes data to `STDOUT`.
+          #
+          # @param [String] data
+          #   The data to write.
+          #
+          # @since 1.0.0
+          #
+          # @api private
+          #
+          def self.write(data)
+            STDOUT.write(data)
+          end
+
+          #
+          # Prints an `info` message.
+          #
+          # @param [String] message
+          #   The message to print.
+          #
+          # @since 1.0.0
+          #
+          # @api private
+          #
+          def self.print_info(message)
+            puts "[-] #{message}"
+          end
+
+          #
+          # Prints a `debug` message.
+          #
+          # @param [String] message
+          #   The message to print.
+          #
+          # @since 1.0.0
+          #
+          # @api private
+          #
+          def self.print_debug(message)
+            puts "[=] #{message}"
+          end
+
+          #
+          # Prints a `warning` message.
+          #
+          # @param [String] message
+          #   The message to print.
+          #
+          # @since 1.0.0
+          #
+          # @api private
+          #
+          def self.print_warning(message)
+            puts "[*] #{message}"
+          end
+
+          #
+          # Prints an `error` messages.
+          #
+          # @param [String] message
+          #   The message to print.
+          #
+          # @since 1.0.0
+          #
+          # @api private
+          #
+          def self.print_error(message)
+            puts "[!] #{message}"
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/ui/shell.rb

@@ -0,0 +1,219 @@
+#
+# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of Ronin Support.
+#
+# Ronin Support is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ronin Support 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require 'ronin/ui/output/helpers'
+
+require 'set'
+
+module Ronin
+  module UI
+    #
+    # Spawns a ReadLine powered interactive Shell.
+    #
+    # @api semipublic
+    #
+    class Shell
+
+      include Output::Helpers
+
+      # Default shell prompt
+      DEFAULT_PROMPT = '>'
+
+      # The shell name
+      attr_accessor :name
+
+      # The shell prompt
+      attr_accessor :prompt
+
+      # The commands available for the shell
+      attr_reader :commands
+
+      #
+      # Creates a new shell.
+      #
+      # @param [Hash] options
+      #   Additional options.
+      #
+      # @option options [String] :name ('')
+      #   The shell-name to use before the prompt.
+      #
+      # @option options [String] :prompt (DEFAULT_PROMPT)
+      #   The prompt to use for the shell.
+      #
+      # @yield [shell, line]
+      #   The block that will be passed every command entered.
+      #
+      # @yieldparam [Shell] shell
+      #   The shell to use for output.
+      #
+      # @yieldparam [String] line
+      #   The command entered into the shell.
+      #
+      # @api semipublic
+      #
+      # @since 0.3.0
+      #
+      def initialize(options={},&block)
+        @name     = options.fetch(:name,'')
+        @prompt   = options.fetch(:prompt,DEFAULT_PROMPT)
+
+        @commands = Set[:help, :exit]
+        @commands += protected_methods.map { |name| name.to_sym }
+
+        @input_handler = block
+      end
+
+      #
+      # Creates a new Shell object and starts it.
+      #
+      # @param [Array] arguments
+      #   Arguments for {#initialize}.
+      #
+      # @yield [shell, line]
+      #   The block that will be passed every command entered.
+      #
+      # @yieldparam [Shell] shell
+      #   The shell to use for output.
+      #
+      # @yieldparam [String] line
+      #   The command entered into the shell.
+      #
+      # @return [nil]
+      #
+      # @example
+      #   Shell.start(:prompt => '$') { |shell,line| system(line) }
+      #
+      def self.start(*arguments,&block)
+        new(*arguments,&block).start
+      end
+
+      #
+      # Starts the shell.
+      #
+      # @since 0.3.0
+      #
+      def start
+        history_rollback = 0
+
+        loop do
+          unless (raw_line = Readline.readline("#{name}#{prompt} "))
+            break # user exited the shell
+          end
+
+          line = raw_line.strip
+
+          if (line == 'exit' || line == 'quit')
+            exit
+            break
+          elsif !(line.empty?)
+            Readline::HISTORY << raw_line
+            history_rollback += 1
+
+            begin
+              handler(line)
+            rescue => e
+              print_error "#{e.class.name}: #{e.message}"
+            end
+          end
+        end
+
+        history_rollback.times { Readline::HISTORY.pop }
+        return nil
+      end
+
+      #
+      # Handles input for the shell.
+      #
+      # @param [String] line
+      #   A line of input received by the shell.
+      # 
+      # @since 0.3.0
+      #
+      def call(line)
+        if @input_handler
+          @input_handler.call(self,line)
+        else
+          arguments = line.split(/\s+/)
+          command   = arguments.shift
+
+          # ignore empty lines
+          return false unless command
+
+          command = command.to_sym
+
+          # no explicitly calling handler
+          return false if command == :handler
+
+          unless @commands.include?(command)
+            print_error "Invalid command: #{command}"
+            return false
+          end
+
+          return send(command,*arguments)
+        end
+      end
+
+      protected
+
+      #
+      # Method which is called before exiting the shell.
+      #
+      # @since 0.3.0
+      #
+      def exit
+      end
+
+      #
+      # @see #exit
+      #
+      # @since 0.3.0
+      #
+      def quit
+        exit
+      end
+
+      #
+      # Prints the available commands and their arguments.
+      #
+      # @since 0.3.0
+      #
+      def help
+        puts "Available commands:"
+        puts
+
+        @commands.sort.each do |name|
+          command_method = method(name)
+          arguments = command_method.parameters.map do |param|
+            case param[0]
+            when :opt
+              "[#{param[1]}]"
+            when :rest
+              "[#{param[1]} ...]"
+            else
+              param[1]
+            end
+          end
+
+          puts "  #{name} #{arguments.join(' ')}"
+        end
+      end
+
+    end
+  end
+end