ronin 0.1.1 → 0.1.2

data/lib/ronin/ui/command_line/commands/overlay.rb

@@ -0,0 +1,187 @@
+#
+#--
+# Ronin - A Ruby platform designed for information security and data
+# exploration tasks.
+#
+# Copyright (c) 2006-2007 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program 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 2 of the License, or
+# (at your option) any later version.
+#
+# This program 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 this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#++
+#
+
+require 'ronin/ui/command_line/command'
+require 'ronin/cache/overlay'
+require 'ronin/version'
+
+require 'fileutils'
+require 'rexml/document'
+
+module Ronin
+  module UI
+    module CommandLine
+      class OverlayCommand < Command
+
+        include REXML
+
+        command :overlay
+
+        def initialize
+          @name = nil
+          @source = nil
+          @source_view = nil
+          @website = nil
+          @license = nil
+          @maintainers = []
+          @description = nil
+
+          super
+        end
+
+        def define_options(opts)
+          opts.usage = '[options] PATH'
+
+          opts.options do
+            opts.on('-n','--name NAME','Name of the Overlay') do |name|
+              @name = name
+            end
+
+            opts.on('-S','--source URL','The URL where the source of the Overlay will be hosted') do |url|
+              @source = url
+            end
+
+            opts.on('-V','--source-view URL','The URL for viewing the contents of the Overlay') do |url|
+              @source_view = url
+            end
+
+            opts.on('-U','--website URL','The URL of the website of the Overlay') do |url|
+              @website = url
+            end
+
+            opts.on('-L','--license LICENSE','The license of the contents of the Overlay') do |license|
+              @license = license
+            end
+
+            opts.on('-m','--maintainer "NAME <EMAIL>"','Name of a maintainer of the Overlay') do |text|
+              name = text.scan(/^[^<]+[^<\s]/).first
+              email = text.scan(/<([^<>]+)>\s*$/).first
+
+              email = email.first if email
+
+              @maintainers << {:name => name, :email => email}
+            end
+
+            opts.on('-D','--description TEXT','The description for the Overlay') do |text|
+              @description = text
+            end
+          end
+
+          opts.arguments(
+            'PATH' => 'The PATH of the Overlay to be created'
+          )
+
+          opts.summary('Create an empty Overlay at the specified PATH')
+        end
+
+        def arguments(*args)
+          unless args.length == 1
+            fail('only one Overlay path maybe specified')
+          end
+
+          path = File.expand_path(args.first)
+
+          @name ||= File.basename(path).gsub(/[_\s]+/,' ').capitalize
+          @source_view ||= @source
+          @website ||= @source_view
+
+          FileUtils.mkdir_p(path)
+          FileUtils.mkdir_p(File.join(path,'objects'))
+
+          File.open(File.join(path,Cache::Overlay::METADATA_FILE),'w') do |file|
+            doc = Document.new
+            doc.add(XMLDecl.new)
+            doc.add(Instruction.new('xml-stylesheet','type="text/xsl" href="http://ronin.rubyforge.org/dist/overlay.xsl"'))
+
+            root = Element.new('ronin-overlay')
+            root.attributes['version'] = Ronin::VERSION
+
+            name_tag = Element.new('name')
+            name_tag.text = @name
+            root.add_element(name_tag)
+
+            if @source
+              source_tag = Element.new('source')
+              source_tag.text = @source
+              root.add_element(source_tag)
+            end
+
+            if @source_view
+              source_view_tag = Element.new('source-view')
+              source_view_tag.text = @source_view
+              root.add_element(source_view_tag)
+            end
+
+            if @website
+              url_tag = Element.new('website')
+              url_tag.text = @website
+              root.add_element(url_tag)
+            end
+
+            if @license
+              license_tag = Element.new('license')
+              license_tag.text = @license
+              root.add_element(license_tag)
+            end
+
+            unless @maintainers.empty?
+              maintainers_tag = Element.new('maintainers')
+
+              @maintainers.each do |author|
+                if (author[:name] || author[:email])
+                  maintainer_tag = Element.new('maintainer')
+
+                  if author[:name]
+                    name_tag = Element.new('name')
+                    name_tag.text = author[:name]
+                    maintainer_tag.add_element(name_tag)
+                  end
+
+                  if author[:email]
+                    email_tag = Element.new('email')
+                    email_tag.text = author[:email]
+                    maintainer_tag.add_element(email_tag)
+                  end
+
+                  maintainers_tag.add_element(maintainer_tag)
+                end
+              end
+
+              root.add_element(maintainers_tag)
+            end
+
+            if @description
+              description_tag = Element.new('description')
+              description_tag.text = @description
+              root.add_element(description_tag)
+            end
+
+            doc.add_element(root)
+            doc.write(file,2)
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/{program/commands/uninstall.rb → ui/command_line/commands/remove.rb}

@@ -21,35 +21,43 @@
 #++
 #
 
-require 'ronin/program/command'
+require 'ronin/ui/command_line/command'
 require 'ronin/cache/overlay'
 
 module Ronin
-  module Program
-    class UninstallCommand < Command
+  module UI
+    module CommandLine
+      class RemoveCommand < Command
 
-      command :uninstall
+        command :remove, :rm
 
-      options('NAME [NAME ...] [options]') do |opts|
-        opts.options
+        def define_options(opts)
+          opts.usage = 'NAME [...] [options]'
 
-        opts.arguments do
-          opts.arg('NAME','The repository to uninstall')
-        end
+          opts.options do
+            opts.on('-v','--verbose','Enable verbose output') do
+              @verbose = true
+            end
+          end
 
-        opts.summary('Uninstall the specified repositories')
-      end
+          opts.arguments(
+            'NAME' => 'The repository to remove'
+          )
 
-      def arguments(*args)
-        args.each do |name|
-          Cache::Overlay.save_cache do
-            Cache::Overlay.uninstall(name) do |repo|
-              puts "Uninstalling #{repo}..."
+          opts.summary('Remove the specified repositories')
+        end
+
+        def arguments(*args)
+          args.each do |name|
+            Cache::Overlay.save_cache do
+              Cache::Overlay.remove(name) do |repo|
+                puts "Removing #{repo}..."
+              end
             end
           end
         end
-      end
 
+      end
     end
   end
 end

data/lib/ronin/{program/commands/update.rb → ui/command_line/commands/uninstall.rb}

@@ -21,33 +21,43 @@
 #++
 #
 
-require 'ronin/program/command'
+require 'ronin/ui/command_line/command'
 require 'ronin/cache/overlay'
 
 module Ronin
-  module Program
-    class UpdateCommand < Command
+  module UI
+    module CommandLine
+      class UninstallCommand < Command
 
-      command :update, :up
+        command :uninstall
 
-      options('[NAME ...] [options]') do |opts|
-        opts.options
+        def define_options(opts)
+          opts.usage = 'NAME [NAME ...] [options]'
 
-        opts.arguments do
-          opts.arg('NAME','The repository to update')
-        end
+          opts.options do
+            opts.on('-v','--verbose','Enable verbose output') do
+              @verbose = true
+            end
+          end
 
-        opts.summary('Updates all or the specified repositories')
-      end
+          opts.arguments(
+            'NAME' => 'The repository to uninstall'
+          )
 
-      def arguments(*args)
-        if args.empty?
-          Cache::Overlay.each { |repo| repo.update }
-        else
-          args.each { |name| Cache::Overlay.update(name) }
+          opts.summary('Uninstall the specified repositories')
         end
-      end
 
+        def arguments(*args)
+          args.each do |name|
+            Cache::Overlay.save_cache do
+              Cache::Overlay.uninstall(name) do |repo|
+                puts "Uninstalling #{repo}..."
+              end
+            end
+          end
+        end
+
+      end
     end
   end
 end

data/lib/ronin/{program/commands/remove.rb → ui/command_line/commands/update.rb}

@@ -21,35 +21,41 @@
 #++
 #
 
-require 'ronin/program/command'
+require 'ronin/ui/command_line/command'
 require 'ronin/cache/overlay'
 
 module Ronin
-  module Program
-    class RemoveCommand < Command
+  module UI
+    module CommandLine
+      class UpdateCommand < Command
 
-      command :remove, :rm
+        command :update, :up
 
-      options('NAME [NAME ...] [options]') do |opts|
-        opts.options
+        def define_options(opts)
+          opts.usage = '[NAME ...] [options]'
 
-        opts.arguments do
-          opts.arg('NAME','The repository to remove')
-        end
+          opts.options do
+            opts.on('-v','--verbose','Enable verbose output') do
+              @verbose = true
+            end
+          end
 
-        opts.summary('Remove the specified repositories')
-      end
+          opts.arguments(
+            'NAME' => 'The repository to update'
+          )
 
-      def arguments(*args)
-        args.each do |name|
-          Cache::Overlay.save_cache do
-            Cache::Overlay.remove(name) do |repo|
-              puts "Removing #{repo}..."
-            end
+          opts.summary('Updates all or the specified repositories')
+        end
+
+        def arguments(*args)
+          if args.empty?
+            Cache::Overlay.each { |repo| repo.update }
+          else
+            args.each { |name| Cache::Overlay.update(name) }
           end
         end
-      end
 
+      end
     end
   end
 end

data/lib/ronin/{program → ui/command_line}/exceptions.rb

@@ -21,4 +21,4 @@
 #++
 #
 
-require 'ronin/program/exceptions/unknown_command'
+require 'ronin/ui/command_line/exceptions/unknown_command'

data/lib/ronin/{program → ui/command_line}/exceptions/unknown_command.rb

@@ -22,8 +22,10 @@
 #
 
 module Ronin
-  module Program
-    class UnknownCommand < RuntimeError
+  module UI
+    module CommandLine
+      class UnknownCommand < RuntimeError
+      end
     end
   end
 end

data/lib/ronin/ui/command_line/options.rb

@@ -0,0 +1,148 @@
+#
+#--
+# Ronin - A Ruby platform designed for information security and data
+# exploration tasks.
+#
+# Copyright (c) 2006-2008 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program 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 2 of the License, or
+# (at your option) any later version.
+#
+# This program 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 this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#++
+#
+
+require 'optparse'
+
+module Ronin
+  module UI
+    module CommandLine
+      class Options < OptionParser
+
+        #
+        # Creates a new Options object with the specified _program_ name
+        # and the given _banner_. If a _block_ is given, it will be passed
+        # the newly created Options object.
+        #
+        def initialize(program,&block)
+          @program = program
+
+          super(&block)
+        end
+
+        #
+        # Creates a new Options object for a Command with the specified
+        # _program_ name and the given command _name_. If a _block_ is
+        # given, it will be passed the newly created Options object.
+        #
+        def Options.command(program,name=nil,&block)
+          program = program.to_s
+          program << " #{name}" if name
+
+          return Options.new(program,&block)
+        end
+
+        #
+        # Sets the example usage for the options to the specified _example_.
+        #
+        def usage=(example)
+          self.banner = "Usage: #{@program} #{example}"
+          self.separator ''
+        end
+
+        #
+        # Adds an options section to the help message. If a _block_ is given
+        # it will be called before any default options are added.
+        #
+        def options(&block)
+          self.separator '  Options:'
+
+          block.call() if block
+
+          self.on('-h','--help','print this message') do
+            help
+            exit
+          end
+
+          self.separator ''
+
+          return self
+        end
+
+        #
+        # Creates an arguments section in the help message using the given
+        # _args_.
+        #
+        def arguments(args={})
+          self.separator '  Arguments:'
+
+          args.each do |name,description|
+            self.separator "    #{name}\t#{description}"
+          end
+
+          self.separator ''
+          return self
+        end
+
+        #
+        # Addes a summary section with the specified _text_.
+        #
+        def summary(text)
+          self.separator '  Summary:'
+
+          text.each_line do |line|
+            line = line.strip
+
+            self.separator "    #{line}" unless line.empty?
+          end
+
+          self.separator ''
+          return self
+        end
+
+        #
+        # Adds a defaults section with the specified _flags_.
+        #
+        def defaults(*flags)
+          self.separator '  Defaults:'
+
+          flags.each { |flag| self.separator "    #{flag}" }
+
+          self.separator ''
+          return self
+        end
+
+        #
+        # Prints the help message and exits successfully. If a _block_ is
+        # given it will be called after the help message has been print
+        # and before the Program has exited.
+        #
+        def help(&block)
+          puts self
+        end
+
+        #
+        # Parses the specified _arguments_ and returns any remaining
+        # arguments. If a _block_ is given, it will be passed any
+        # remaining arguments.
+        #
+        def parse(arguments,&block)
+          args = super(arguments)
+
+          block.call(args) if block
+          return args
+        end
+
+      end
+    end
+  end
+end