ronin 1.3.0 → 1.4.0.rc1

data/lib/ronin/ui/cli/commands/uninstall.rb

@@ -0,0 +1,65 @@
+#
+# 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/command'
+require 'ronin/repository'
+require 'ronin/database'
+
+module Ronin
+  module UI
+    module CLI
+      module Commands
+        #
+        # The `ronin-uninstall` command.
+        #
+        class Uninstall < Command
+
+          summary 'Uninstalls Ronin Repositories'
+
+          argument :repo, :type => String,
+                          :description => 'Repository to uninstall'
+
+          #
+          # Sets up the install command.
+          #
+          def setup
+            super
+
+            Database.setup
+          end
+
+          #
+          # Executes the command.
+          #
+          def execute
+            unless repo?
+              print_error "Must specify the REPO argument"
+              exit -1
+            end
+
+            repository = Repository.uninstall(@repo)
+
+            print_info "Repository #{repository} uninstalled."
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/ui/cli/commands/update.rb

@@ -0,0 +1,100 @@
+#
+# 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/command'
+require 'ronin/repository'
+require 'ronin/database'
+
+module Ronin
+  module UI
+    module CLI
+      module Commands
+        #
+        # The `ronin-update` command.
+        #
+        class Update < Command
+
+          summary 'Updates Ronin Repositories'
+
+          argument :repo, :type        => String,
+                          :description => 'Repository to update'
+
+          #
+          # Sets up the install command.
+          #
+          def setup
+            super
+
+            Database.setup
+          end
+
+          #
+          # Executes the command.
+          #
+          def execute
+            if repo?
+              repository = begin
+                             Repository.find(@repo)
+                           rescue RepositoryNotFound => e
+                             print_error e.message
+                             exit -1
+                           end
+
+              print_info "Updating #{repository} ..."
+
+              repository.update!
+
+              print_info "Repository #{repository} updated."
+            else
+              print_info "Updating Repositories ..."
+
+              Repository.update!
+
+              print_info "Repositories updated."
+            end
+          end
+
+          protected
+
+          #
+          # Print out any exceptions or validation errors encountered
+          # when caching the files of the repository.
+          #
+          # @param [Repository] repository
+          #   The repository that was updated.
+          #
+          def print_cache_errors(repo)
+            repository.script_paths.each do |script_path|
+              if script_path.cache_exception
+                print_exception script_path.cache_exception
+              end
+
+              if script_path.cache_errors
+                script_path.cache_errors.each do |error|
+                  print_error error
+                end
+              end
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/ui/cli/commands/urls.rb

@@ -31,36 +31,36 @@ module Ronin
 
           model URL
 
-          query_option :http, :type => :boolean
-          query_option :https, :type => :boolean
+          query_option :http, :type => true
+          query_option :https, :type => true
 
-          query_option :hosts, :type => :array,
-                               :aliases => '-H',
-                               :banner => 'HOST [...]'
+          query_option :hosts, :type  => Array,
+                               :flag  => '-H',
+                               :usage => 'HOST [...]'
 
-          query_option :ports, :type => :array,
-                               :aliases => '-P',
-                               :banner => 'PORT [...]'
+          query_option :ports, :type  => Array[Integer],
+                               :flag  => '-P',
+                               :usage => 'PORT [...]'
 
-          query_option :directory, :type => :string, 
-                                   :aliases => '-d',
-                                   :banner => 'SUBDIR'
+          query_option :directory, :type  => String, 
+                                   :flag  => '-d',
+                                   :usage => 'SUBDIR'
 
-          query_option :query_param, :type => :array,
-                                     :aliases => '-q',
-                                     :banner => 'NAME'
+          query_option :with_query_param, :type  => Array,
+                                          :flag  => '-q',
+                                          :usage => 'NAME [...]'
 
-          query_option :query_value, :type => :array,
-                                     :aliases => '-Q',
-                                     :banner => 'VALUE'
+          query_option :with_query_value, :type   => Array,
+                                          :flag   => '-Q',
+                                          :usage  => 'VALUE [...]'
 
-          class_option :list, :type => :boolean,
-                              :default => true,
-                              :aliases => '-l'
+          option :list, :type    => true,
+                        :default => true,
+                        :flag    => '-l'
 
-          class_option :import, :type => :string,
-                                :aliases => '-i',
-                                :banner => 'FILE'
+          option :import, :type  => String,
+                          :flag  => '-i',
+                          :usage => 'FILE'
 
           protected
 
@@ -73,7 +73,7 @@ module Ronin
           # @since 1.0.0
           #
           def print_resource(url)
-            return super(url) unless options.verbose?
+            return super(url) unless verbose?
 
             print_title url
 

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

@@ -28,8 +28,9 @@ module Ronin
       #
       class ModelCommand < Command
 
-        class_option :database, :type => :string,
-                                :aliases => '-D'
+        option :database, :type => URI,
+                          :flag => '-D',
+                          :description => 'The Database URI'
 
         #
         # The query options for the command.
@@ -109,7 +110,8 @@ module Ronin
         #
         def self.query_option(name,options={})
           query_options << name
-          class_option name, options
+
+          return option(name,options)
         end
 
         #
@@ -122,8 +124,8 @@ module Ronin
         def setup
           super
 
-          if self.options[:database]
-            Database.repositories[:default] = options[:database]
+          if @database
+            Database.repositories[:default] = @database
           end
 
           Database.setup
@@ -151,7 +153,7 @@ module Ronin
           query = self.class.model.all
 
           self.class.each_query_option do |name|
-            value = options[name]
+            value = get_param(name).value
 
             # skip unset options
             next if value.nil?

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

@@ -0,0 +1,167 @@
+#
+# 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/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

@@ -28,10 +28,17 @@ module Ronin
       #
       class ResourcesCommand < ModelCommand
 
-        class_option :csv, :type => :boolean
-        class_option :xml, :type => :boolean
-        class_option :yaml, :type => :boolean
-        class_option :json, :type => :boolean
+        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.
@@ -41,8 +48,8 @@ module Ronin
         # @api semipublic
         #
         def execute
-          if options[:import]
-            self.class.model.import(options[:import]) do |resource|
+          if @import
+            self.class.model.import(@import) do |resource|
               print_info "Imported #{resource}"
             end
           else
@@ -61,9 +68,10 @@ module Ronin
         #
         def self.model(model=nil)
           if (model && model < Model::Importable)
-            class_option :import, :type => :string,
-                                  :aliases => '-i',
-                                  :banner => 'FILE'
+            option :import, :type  => String,
+                            :flag  => '-i',
+                            :usage => 'FILE',
+                            :description => 'The file to import'
           end
 
           return super(model)
@@ -94,13 +102,13 @@ module Ronin
         # @api semipublic
         #
         def print_resources(resources)
-          if options.csv?
+          if @csv
             print resources.to_csv
-          elsif options.xml?
+          elsif @xml
             print resources.to_xml
-          elsif options.yaml?
+          elsif @yaml
             print resources.to_yaml
-          elsif options.json?
+          elsif @json
             print resources.to_json
           else
             resources.each { |resource| print_resource(resource) }