ronin 0.3.0 → 1.0.0.pre1

data/lib/ronin/database/migrations/graph.rb

@@ -0,0 +1,278 @@
+require 'ronin/database/migrations/exceptions/duplicate_migration'
+require 'ronin/database/migrations/exceptions/unknown_migration'
+require 'ronin/database/migrations/migration'
+
+require 'set'
+require 'tsort'
+
+module Ronin
+  module Database
+    module Migrations
+      class Graph
+
+        include Enumerable
+        include TSort
+
+        # The migrations in the graph
+        attr_reader :migrations
+
+        # The mapping of position numbers to migration names
+        attr_reader :positions
+
+        #
+        # Creates a new Migration Graph.
+        #
+        # @since 1.0.1
+        #
+        def initialize
+          @migrations = {}
+          @positions = {}
+        end
+
+        #
+        # Determines if the migration graph is empty.
+        #
+        # @return [Boolean]
+        #   Specifies whether the migration graph contains no migrations.
+        #
+        # @since 1.0.1
+        #
+        def empty?
+          @migrations.empty?
+        end
+
+        #
+        # Provides direct access to migrations.
+        #
+        # @param [Integer, Symbol] position_or_name
+        #   The position or name of the migration.
+        #
+        # @return [Migration]
+        #   The migration.
+        #
+        # @raise [KeyError]
+        #   There was no migration defined with the given position or name.
+        #
+        def [](position_or_name)
+          name = name_of(position_or_name)
+
+          unless @migrations.has_key?(name)
+            raise(UnknownMigration,"unknown migration #{position_or_name.inspect}",caller)
+          end
+
+          @migrations[name]
+        end
+
+        #
+        # @api private
+        #
+        def tsort_each_node(&block)
+          @migrations.each_key(&block)
+        end
+
+        #
+        # @api private
+        #
+        def tsort_each_child(node)
+          unless @migrations.has_key?(node)
+            raise(UnknownMigration,"no migration defined for #{node}",caller)
+          end
+
+          @migrations[node].needs.each do |dep|
+            yield name_of(dep)
+          end
+        end
+
+        alias sort tsort
+
+        #
+        # Defines a migration.
+        #
+        # @param [Symbol] name
+        #   The name of the migration.
+        #
+        # @param [Hash] options
+        #   Additional options for the migration.
+        #
+        # @option options [Boolean] :verbose (true)
+        #   Enables or disables verbose output.
+        #
+        # @option options [Symbol] :repository (:default)
+        #   The DataMapper repository the migration will operate on.
+        #
+        # @option options [Array, Symbol] :needs
+        #   Other migrations that are dependencies of the migration.
+        #
+        # @return [Migration]
+        #   The newly defined migration.
+        #
+        # @raise [DuplicateMigration]
+        #   Another migration was previously defined with the same name.
+        #
+        # @since 1.0.1
+        #
+        # @api semipublic
+        #
+        def migration_named(name,options={},&block)
+          if @migrations.has_key?(name)
+            raise(DuplicateMigration,"there is already a migration with the name #{name}",caller)
+          end
+
+          @migrations[name] = Migration.new(name,options,&block)
+        end
+
+        #
+        # Defines a migration assigned to a given position.
+        #
+        # @param [Integer] position
+        #   The position of the migration.
+        #
+        # @param [Symbol] name
+        #   The name of the migration.
+        #
+        # @param [Hash] options
+        #   Additional options for the migration.
+        #
+        # @return [Migration]
+        #   The newly defined migration.
+        #
+        # @raise [DuplicateMigration]
+        #   Another migration was previously defined with the same name or
+        #   position.
+        #
+        # @see migration_named
+        #
+        # @since 1.0.1
+        #
+        # @api semipublic
+        #
+        def migration_at(position,name,options={},&block)
+          if @positions.has_key?(position)
+            raise(DuplicateMigration,"there is already a migration at position #{position}",caller)
+          end
+
+          if position > 1
+            # explicit define a dependencey on the previous migration position
+            options[:needs] = [position - 1]
+          end
+
+          name = name.to_sym
+
+          migration = migration_named(name,options,&block)
+
+          # define a mapping from position to migration name
+          @positions[position] = name
+          return migration
+        end
+
+        #
+        # Enumerates over the migrations up to a specific migration.
+        #
+        # @param [Integer, Symbol, nil] position_or_name
+        #   The migration position or name to stop after.
+        #
+        # @yield [migration]
+        #   The given block will be passed each migration. Once the
+        #   migration of the given position or name is yielded, no further
+        #   migrations will be yielded.
+        #
+        # @yieldparam [Migration] migration
+        #   A migration from the graph.
+        #
+        # @return [Enumerator]
+        #   If no block is given, an enumerator object will be returned.
+        #
+        # @raise [UnknownMigration]
+        #   A migration had a dependencey on an unknown migration.
+        #
+        # @since 1.0.1
+        #
+        # @api semipublic
+        #
+        def upto(position_or_name=nil)
+          return enum_for(:upto,position_or_name) unless block_given?
+
+          name = name_of(position_or_name)
+
+          # tsort named migrations by their dependencies
+          tsort.each do |key|
+            yield @migrations[key]
+
+            # break after the target migration has been reached
+            break if (name && name == key)
+          end
+        end
+
+        #
+        # Enumerates over the migrations down to a specific migration.
+        #
+        # @param [Integer, Symbol, nil] position_or_name
+        #   The migration position or name to stop before.
+        #
+        # @yield [migration]
+        #   The given block will be passed each migration. Once the
+        #   migration of the given position or name is reached, no further
+        #   migrations will be yielded.
+        #
+        # @yieldparam [Migration] migration
+        #   A migration from the graph.
+        #
+        # @return [Enumerator]
+        #   If no block is given, an enumerator object will be returned.
+        #
+        # @raise [UnknownMigration]
+        #   A migration had a dependencey on an unknown migration.
+        #
+        # @since 1.0.1
+        #
+        # @api semipublic
+        #
+        def downto(position_or_name=nil)
+          return enum_for(:downto,position_or_name) unless block_given?
+
+          name = name_of(position_or_name)
+
+          # tsort named migrations by their dependencies
+          tsort.reverse_each do |key|
+            # break before the target migration is reached
+            break if (name && name == key)
+
+            yield @migrations[key]
+          end
+        end
+
+        protected
+
+        #
+        # Maps a position or name to a migration name.
+        #
+        # @param [Symbol, Integer] position_or_name
+        #   The migration position or name.
+        #
+        # @return [Symbol]
+        #   The migration name.
+        #
+        # @raise [UnknownMigration]
+        #   There was no migration defined at the given position.
+        #
+        # @since 1.0.1
+        #
+        # @api private
+        #
+        def name_of(position_or_name)
+          case position_or_name
+          when Integer
+            unless @positions.has_key?(position_or_name)
+              raise(UnknownMigration,"unknown migration position #{position_or_name}",caller)
+            end
+
+            @positions[position_or_name]
+          when Symbol
+            position_or_name
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/database/migrations/migration.rb

@@ -0,0 +1,67 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2006-2010 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/output/output'
+
+require 'dm-migrations/migration'
+
+module Ronin
+  module Database
+    module Migrations
+      class Migration < DataMapper::Migration
+
+        # The dependencies of the migration
+        attr_reader :needs
+
+        #
+        # Creates a new migration.
+        #
+        # @param [Symbol] name
+        #   The name of the migration.
+        #
+        # @param [Hash] options
+        #   Additional options for the migration.
+        #
+        # @option options [Boolean] :verbose (false)
+        #   Enables or disables verbose output.
+        #
+        # @option options [Symbol] :repository (:default)
+        #   The DataMapper repository the migration will operate on.
+        #
+        # @option options [Array, Symbol] :needs ([])
+        #   Other migrations that are dependencies of the migration.
+        #
+        # @api semipublic
+        #
+        def initialize(name,options={},&block)
+          options = options.merge(
+            :verbose => UI::Output.verbose?,
+            :needs => []
+          )
+
+          @needs = Set[*options[:needs]]
+
+          super(0,name,options,&block)
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/database/migrations/migrations.rb

@@ -0,0 +1,186 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2006-2010 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/database/migrations/graph'
+
+require 'dm-core'
+
+module Ronin
+  module Database
+    module Migrations
+      extend DataMapper::Property::Lookup
+
+      #
+      # The defined migrations.
+      #
+      # @return [Graph]
+      #   The defined migrations.
+      #
+      # @since 1.0.1
+      #
+      # @api public
+      #
+      def self.migrations
+        @migrations ||= Graph.new
+      end
+
+      #
+      # Defines a new migration.
+      #
+      # @param [Array] arguments
+      #   Additional arguments.
+      #
+      # @yield []
+      #   The given block will define the migration.
+      #
+      # @return [Migration]
+      #   The newly defined migration.
+      #
+      # @raise [ArgumentError]
+      #   The first argument was not a `Symbol`, `String` or `Integer`.
+      #
+      # @raise [DuplicateMigration]
+      #   Another migration was previously defined with the same name or
+      #   position.
+      #
+      # @example Defining a migration at a position
+      #   migration(1, :create_people_table) do
+      #     up do
+      #       create_table :people do
+      #         column :id,   Integer, :serial => true
+      #         column :name, String, :size => 50
+      #         column :age,  Integer
+      #       end
+      #     end
+      #
+      #     down do
+      #       drop_table :people
+      #     end
+      #   end
+      #
+      # @example Defining a migration with a name
+      #   migration(:create_people_table) do
+      #     up do
+      #       create_table :people do
+      #         column :id,   Integer, :serial => true
+      #         column :name, String, :size => 50
+      #         column :age,  Integer
+      #       end
+      #     end
+      #
+      #     down do
+      #       drop_table :people
+      #     end
+      #   end
+      #
+      # @example Defining a migration with dependencies
+      #   migration(:add_salary_column, :needs => :create_people_table) do
+      #     up do
+      #       modify_table :people do
+      #         add_column :salary, Integer
+      #       end
+      #     end
+      #
+      #     down do
+      #       modify_table :people do
+      #         drop_column :salary
+      #       end
+      #     end
+      #   end
+      #
+      # @note
+      #   Its recommended that you stick with raw SQL for migrations that
+      #   manipulate data. If you write a migration using a model, then
+      #   later change the model, there's a possibility the migration
+      #   will no longer work. Using SQL will always work.
+      #
+      # @since 1.0.1
+      #
+      # @api public
+      #
+      def self.migration(*arguments,&block)
+        case arguments[0]
+        when Integer
+          position = arguments[0]
+          name = arguments[1]
+          options = (arguments[2] || {})
+
+          self.migrations.migration_at(position,name,options,&block)
+        when Symbol, String
+          name = arguments[0]
+          options = (arguments[1] || {})
+
+          self.migrations.migration_named(name,options,&block)
+        else
+          raise(ArgumentError,"first argument must be an Integer, Symbol or a String",caller)
+        end
+      end
+
+      #
+      # Migrates the database upward to a given migration position or name.
+      #
+      # @param [Symbol, Integer, nil] position_or_name
+      #   The migration position or name to migrate the database to.
+      #
+      # @return [true]
+      #   The database was successfully migrated up.
+      #
+      # @raise [UnknownMigration]
+      #   A migration had a dependencey on an unknown migration.
+      #
+      # @since 1.0.1
+      #
+      # @api public
+      #
+      def self.migrate_up!(position_or_name=nil)
+        self.migrations.upto(position_or_name) do |migration|
+          migration.perform_up
+        end
+
+        return true
+      end
+
+      #
+      # Migrates the database downwards to a certain migration position or
+      # name.
+      #
+      # @param [Symbol, Integer, nil] position_or_name
+      #   The migration position or name to migrate the database down to.
+      #
+      # @return [true]
+      #   The database was successfully migrated down.
+      #
+      # @raise [UnknownMigration]
+      #   A migration had a dependencey on an unknown migration.
+      #
+      # @since 1.0.1
+      #
+      # @api public
+      #
+      def self.migrate_down!(position_or_name=nil)
+        self.migrations.downto(position_or_name) do |migration|
+          migration.perform_down
+        end
+
+        return true
+      end
+    end
+  end
+end

data/lib/ronin/database/migrations.rb

@@ -0,0 +1,55 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2006-2010 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/database/migrations/migrations'
+require 'ronin/database/migrations/create_tags_table'
+require 'ronin/database/migrations/create_taggings_table'
+require 'ronin/database/migrations/create_arches_table'
+require 'ronin/database/migrations/create_os_table'
+require 'ronin/database/migrations/create_vendors_table'
+require 'ronin/database/migrations/create_softwares_table'
+require 'ronin/database/migrations/create_licenses_table'
+require 'ronin/database/migrations/create_authors_table'
+require 'ronin/database/migrations/create_addresses_table'
+require 'ronin/database/migrations/create_ports_table'
+require 'ronin/database/migrations/create_ip_address_mac_addresses_table'
+require 'ronin/database/migrations/create_host_name_ip_addresses_table'
+require 'ronin/database/migrations/create_proxies_table'
+require 'ronin/database/migrations/create_services_table'
+require 'ronin/database/migrations/create_open_ports_table'
+require 'ronin/database/migrations/create_os_guesses_table'
+require 'ronin/database/migrations/create_url_schemes_table'
+require 'ronin/database/migrations/create_url_query_params_table'
+require 'ronin/database/migrations/create_urls_table'
+require 'ronin/database/migrations/create_user_names_table'
+require 'ronin/database/migrations/create_email_addresses_table'
+require 'ronin/database/migrations/create_passwords_table'
+require 'ronin/database/migrations/create_credentials_table'
+require 'ronin/database/migrations/create_countries_table'
+require 'ronin/database/migrations/create_organizations_table'
+require 'ronin/database/migrations/create_campaigns_table'
+require 'ronin/database/migrations/create_targets_table'
+require 'ronin/database/migrations/create_remote_files_table'
+require 'ronin/database/migrations/create_cached_files_table'
+require 'ronin/database/migrations/create_repositories_table'
+
+require 'ronin/database/database'
+
+Ronin::Database.upgrade!

data/lib/ronin/database.rb

@@ -1,7 +1,7 @@
 #
 # Ronin - A Ruby platform for exploit development and security research.
 #
-# Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2010 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
@@ -19,3 +19,4 @@
 #
 
 require 'ronin/database/database'
+require 'ronin/database/migrations'