rapid7/metasploit-framework

# -*- coding: binary -*-
require 'rails'
module Msf
  module Simple
    module Framework
      module ModulePaths

        attr_accessor :configured_module_paths
        attr_accessor :module_paths_inited

        # Initialize the module paths
        #
        # @return [void]
        def init_module_paths(opts = {})
          if @module_paths_inited
            raise 'Module paths already initialized.  To add more module paths call `modules.add_module_path`'
          end

          @configured_module_paths = []
          extract_engine_module_paths(Rails.application).each do |path|
            @configured_module_paths << path
          end

          if Msf::Config.user_module_directory
            @configured_module_paths << Msf::Config.user_module_directory
          end

          ::Rails::Engine.subclasses.map(&:instance).each do |engine|
            extract_engine_module_paths(engine).each do |path|
              @configured_module_paths << path
            end
          end

          # If additional module paths have been defined globally, then load them.
          # They should be separated by semi-colons.
          self.datastore['MsfModulePaths'].to_s.split(";").each do |path|
            @configured_module_paths << path
          end

          # If the caller had additional paths to search, load them.
          # They should be separated by semi-colons.
          opts.delete(:module_paths).to_s.split(";").each do |path|
            @configured_module_paths << path
          end

          # Remove any duplicate paths
          @configured_module_paths.uniq!
          # return early if we're deferring module loading
          return if opts.delete(:defer_module_loads)

          # Update the module cache from the database
          self.modules.refresh_cache_from_database(@configured_module_paths)

          # Load each of the module paths
          @configured_module_paths.each do |path|
            self.modules.add_module_path(path, opts, recalculate: false)
          end

          @module_paths_inited = true
        end

        private

        # Extract directories `engine.paths['modules']` from `engine`.
        #
        # @param engine [Rails::Engine] a rails engine or application
        # @return [Array<String>] The list of module paths to load
        def extract_engine_module_paths(engine)
          engine.paths['modules'] ? engine.paths['modules'].existent_directories : []
        end

      end
    end
  end
end