ronin 0.2.0 → 0.2.1

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

@@ -0,0 +1,123 @@
+#
+#--
+# Ronin - A Ruby platform designed for information security and data
+# exploration tasks.
+#
+# Copyright (c) 2006-2009 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/platform/overlay'
+
+module Ronin
+  module UI
+    module CommandLine
+      module Commands
+        class LS < Command
+
+          def defaults
+            @cache = nil
+            @verbose = false
+          end
+
+          def define_options(opts)
+            opts.usage = '[NAME ...] [options]'
+
+            opts.options do
+              opts.on('-C','--cache DIR','Specify an alternate overlay cache') do |dir|
+                @cache = dir
+              end
+
+              opts.on('-v','--verbose','Enable verbose output') do
+                @verbose = true
+              end
+            end
+
+            opts.arguments(
+              'NAME' => 'Overlay to display'
+            )
+
+            opts.summary %{
+              Display all or the specified repositories within the Overlay
+              cache
+            }
+          end
+
+          def arguments(*args)
+            Platform.load_overlays(@cache) if @cache
+
+            if args.empty?
+              # list all overlays by name
+              Platform.overlays.each_overlay do |overlay|
+                puts "  #{overlay}"
+              end
+
+              return
+            end
+
+            # list specified overlays
+            args.each do |name|
+              overlay = Platform.overlays.get(name)
+
+              puts "[ #{overlay.name} ]\n\n"
+
+              puts "  Path: #{overlay.path}"
+              puts "  Media: #{overlay.media}" if overlay.media
+              puts "  URI: #{overlay.uri}" if overlay.uri
+
+              if @verbose
+                putc "\n"
+
+                if overlay.title
+                  puts "  Title: #{overlay.title}"
+                end
+
+                if overlay.source
+                  puts "  Source URI: #{overlay.source}"
+                end
+
+                if overlay.source_view
+                  puts "  Source View: #{overlay.source_view}"
+                end
+
+                if overlay.website
+                  puts "  Website: #{overlay.website}"
+                end
+
+                unless overlay.extensions.empty?
+                  puts "  Extensions:\n\n"
+                  overlay.extensions.each { |ext| puts "    #{ext}" }
+                  putc "\n"
+                end
+
+                if overlay.description
+                  puts "  Description:\n\n    #{overlay.description}\n\n"
+                else
+                  putc "\n"
+                end
+              else
+                putc "\n"
+              end
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -26,162 +26,163 @@ require 'ronin/platform/overlay'
 require 'ronin/version'
 
 require 'fileutils'
-require 'rexml/document'
+require 'nokogiri'
 
 module Ronin
   module UI
     module CommandLine
-      class OverlayCommand < Command
+      module Commands
+        class Overlay < Command
+
+          include Nokogiri
+
+          def defaults
+            @title = nil
+            @source = nil
+            @source_view = nil
+            @website = nil
+            @license = nil
+            @maintainers = []
+            @description = nil
+          end
 
-        include REXML
+          def define_options(opts)
+            opts.usage = '[options] PATH'
 
-        command :overlay
+            opts.options do
+              opts.on('-t','--title NAME','Name of the Overlay') do |title|
+                @title = title
+              end
 
-        def initialize
-          @title = nil
-          @source = nil
-          @source_view = nil
-          @website = nil
-          @license = nil
-          @maintainers = []
-          @description = nil
+              opts.on('-S','--source URL','The URL where the source of the Overlay will be hosted') do |url|
+                @source = url
+              end
 
-          super
-        end
+              opts.on('-V','--source-view URL','The URL for viewing the contents of the Overlay') do |url|
+                @source_view = url
+              end
 
-        def define_options(opts)
-          opts.usage = '[options] PATH'
+              opts.on('-U','--website URL','The URL of the website of the Overlay') do |url|
+                @website = url
+              end
 
-          opts.options do
-            opts.on('-t','--title NAME','Name of the Overlay') do |title|
-              @title = title
-            end
+              opts.on('-L','--license LICENSE','The license of the contents of the Overlay') do |license|
+                @license = license
+              end
 
-            opts.on('-S','--source URL','The URL where the source of the Overlay will be hosted') do |url|
-              @source = url
-            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
 
-            opts.on('-V','--source-view URL','The URL for viewing the contents of the Overlay') do |url|
-              @source_view = url
-            end
+                email = email.first if email
 
-            opts.on('-U','--website URL','The URL of the website of the Overlay') do |url|
-              @website = url
-            end
+                @maintainers << {:name => name, :email => email}
+              end
 
-            opts.on('-L','--license LICENSE','The license of the contents of the Overlay') do |license|
-              @license = license
+              opts.on('-D','--description TEXT','The description for the Overlay') do |text|
+                @description = text
+              end
             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
+            opts.arguments(
+              'PATH' => 'The PATH of the Overlay to be created'
+            )
 
-              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
+            opts.summary('Create an empty Overlay at the specified PATH')
           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
 
-        def arguments(*args)
-          unless args.length == 1
-            fail('only one Overlay path maybe specified')
-          end
+            path = File.expand_path(args.first)
 
-          path = File.expand_path(args.first)
+            @title ||= File.basename(path).gsub(/[_\s]+/,' ').capitalize
+            @source_view ||= @source
+            @website ||= @source_view
 
-          @title ||= File.basename(path).gsub(/[_\s]+/,' ').capitalize
-          @source_view ||= @source
-          @website ||= @source_view
+            FileUtils.mkdir_p(path)
+            FileUtils.mkdir_p(File.join(path,'lib'))
+            FileUtils.mkdir_p(File.join(path,'objects'))
 
-          FileUtils.mkdir_p(path)
-          FileUtils.mkdir_p(File.join(path,'lib'))
-          FileUtils.mkdir_p(File.join(path,'objects'))
+            File.open(File.join(path,Platform::Overlay::METADATA_FILE),'w') do |file|
+              doc = XML::Document.new
+              doc << XML::ProcessingInstruction.new(
+                doc,
+                'xml-stylesheet',
+                'type="text/xsl" href="http://ronin.rubyforge.org/dist/overlay.xsl"'
+              )
 
-          File.open(File.join(path,Platform::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 = XML::Node.new('ronin-overlay',doc)
+              root['version'] = Ronin::VERSION
 
-            root = Element.new('ronin-overlay')
-            root.attributes['version'] = Ronin::VERSION
+              title_tag = XML::Node.new('title',doc)
+              title_tag << XML::Text.new(@title,doc)
+              root << title_tag
 
-            title_tag = Element.new('title')
-            title_tag.text = @title
-            root.add_element(title_tag)
+              if @source
+                source_tag = XML::Node.new('source',doc)
+                source_tag << XML::Text.new(@source,doc)
+                root << source_tag
+              end
 
-            if @source
-              source_tag = Element.new('source')
-              source_tag.text = @source
-              root.add_element(source_tag)
-            end
+              if @source_view
+                source_view_tag = XML::Node.new('source-view',doc)
+                source_view_tag << XML::Text.new(@source_view,doc)
+                root << source_view_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 = XML::Node.new('website',doc)
+                url_tag << XML::Text.new(@website,doc)
+                root << url_tag
+              end
 
-            if @website
-              url_tag = Element.new('website')
-              url_tag.text = @website
-              root.add_element(url_tag)
-            end
+              if @license
+                license_tag = XML::Node.new('license',doc)
+                license_tag << XML::Text.new(@license,doc)
+                root << license_tag
+              end
 
-            if @license
-              license_tag = Element.new('license')
-              license_tag.text = @license
-              root.add_element(license_tag)
-            end
+              unless @maintainers.empty?
+                maintainers_tag = XML::Node.new('maintainers',doc)
 
-            unless @maintainers.empty?
-              maintainers_tag = Element.new('maintainers')
+                @maintainers.each do |author|
+                  if (author[:name] || author[:email])
+                    maintainer_tag = XML::Node.new('maintainer',doc)
 
-              @maintainers.each do |author|
-                if (author[:name] || author[:email])
-                  maintainer_tag = Element.new('maintainer')
+                    if author[:name]
+                      name_tag = XML::Node.new('name',doc)
+                      name_tag << XML::Text.new(author[:name],doc)
+                      maintainer_tag << name_tag
+                    end
 
-                  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 = XML::Node.new('email',doc)
+                      email_tag << XML::Text.new(author[:email],doc)
+                      maintainer_tag << email_tag
+                    end
 
-                  if author[:email]
-                    email_tag = Element.new('email')
-                    email_tag.text = author[:email]
-                    maintainer_tag.add_element(email_tag)
+                    maintainers_tag << maintainer_tag
                   end
-
-                  maintainers_tag.add_element(maintainer_tag)
                 end
+
+                root << maintainers_tag
               end
 
-              root.add_element(maintainers_tag)
-            end
+              if @description
+                description_tag = XML::Node.new('description',doc)
+                description_tag << XML::Text.new(@description,doc)
+                root << description_tag
+              end
 
-            if @description
-              description_tag = Element.new('description')
-              description_tag.text = @description
-              root.add_element(description_tag)
+              doc << root
+              doc.write_xml_to(file)
             end
-
-            doc.add_element(root)
-            doc.write(file,2)
           end
-        end
 
+        end
       end
     end
   end

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

@@ -27,47 +27,45 @@ require 'ronin/platform/overlay'
 module Ronin
   module UI
     module CommandLine
-      class RemoveCommand < Command
+      module Commands
+        class RM < Command
 
-        command :remove, :rm
-
-        def initialize
-          @cache = nil
-          @verbose = false
-
-          super
-        end
+          def defaults
+            @cache = nil
+            @verbose = false
+          end
 
-        def define_options(opts)
-          opts.usage = 'NAME [...] [options]'
+          def define_options(opts)
+            opts.usage = 'NAME [...] [options]'
 
-          opts.options do
-            opts.on('-C','--cache DIR','Specify an alternate overlay cache') do |dir|
-              @cache = dir
-            end
+            opts.options do
+              opts.on('-C','--cache DIR','Specify an alternate overlay cache') do |dir|
+                @cache = dir
+              end
 
-            opts.on('-v','--verbose','Enable verbose output') do
-              @verbose = true
+              opts.on('-v','--verbose','Enable verbose output') do
+                @verbose = true
+              end
             end
-          end
 
-          opts.arguments(
-            'NAME' => 'The overlay to remove'
-          )
+            opts.arguments(
+              'NAME' => 'The overlay to remove'
+            )
 
-          opts.summary('Remove the specified repositories')
-        end
+            opts.summary('Remove the specified repositories')
+          end
 
-        def arguments(*args)
-          Platform.load_overlays(@cache) if @cache
+          def arguments(*args)
+            Platform.load_overlays(@cache) if @cache
 
-          args.each do |name|
-            Platform.remove(name) do |overlay|
-              puts "Removing #{overlay.name.dump} ..."
+            args.each do |name|
+              Platform.remove(name) do |overlay|
+                puts "Removing #{overlay.name.dump} ..."
+              end
             end
           end
-        end
 
+        end
       end
     end
   end