Redmine

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

module Redmine

  class PluginNotFound < StandardError; end

  class PluginRequirementError < StandardError; end

  # Base class for Redmine plugins.

  # It must be a hash with the following keys:

  # * <tt>:default</tt>: default value for the plugin settings

  # * <tt>:partial</tt>: path of the configuration partial view, relative to the plugin <tt>app/views</tt> directory

  #   settings :default => {'foo'=>'bar'}, :partial => 'settings/settings'

  # In this example, the settings partial will be found here in the plugin directory: <tt>app/views/settings/_settings.rhtml</tt>.

  #

  # When rendered, the plugin settings value is available as the local variable +settings+

  class Plugin

    cattr_accessor :directory

    self.directory = File.join(Rails.root, 'plugins')

    cattr_accessor :public_directory

    self.public_directory = File.join(Rails.root, 'public', 'plugin_assets')

    @used_partials = {}

    class << self

      attr_reader :registered_plugins

      private :new

      def def_field(*names)

        class_eval do

          names.each do |name|

      end

    end

    def_field :name, :description, :url, :author, :author_url, :version, :settings, :directory

    attr_reader :id

    # Plugin constructor

    def self.register(id, &block)

      p = new(id)

      p.instance_eval(&block)

    end

    # Returns an array of all registered plugins

    def self.all

      registered_plugins.values.sort

    end

    # Finds a plugin by its id

    # Returns a PluginNotFound exception if the plugin doesn't exist

    def self.find(id)

      registered_plugins[id.to_sym] || raise(PluginNotFound)

    end

    # Clears the registered plugins hash

    # It doesn't unload installed plugins

    def self.clear

      @registered_plugins = {}

    end

    # Removes a plugin from the registered plugins

    # It doesn't unload the plugin

    def self.unregister(id)

      @registered_plugins.delete(id)

    end

    # Checks if a plugin is installed

    #

    def self.installed?(id)

      registered_plugins[id.to_sym].present?

    end

    def self.load

      Dir.glob(File.join(self.directory, '*')).sort.each do |directory|

        if File.directory?(directory)

      end

    end

    def initialize(id)

      @id = id.to_sym

    end

    def public_directory

      File.join(self.class.public_directory, id.to_s)

    end

    def to_param

      id

    end

    def assets_directory

      File.join(directory, 'assets')

    end

    def <=>(plugin)

      self.id.to_s <=> plugin.id.to_s

    end

    # Sets a requirement on Redmine version

    # Raises a PluginRequirementError exception if the requirement is not met

    #

    #   # Requires Redmine 0.7.3 or higher

    #   requires_redmine :version_or_higher => '0.7.3'

    #   requires_redmine '0.7.3'

    #   # Requires a Redmine version within a range

    #   requires_redmine :version => '0.7.3'..'0.9.1'     # >= 0.7.3 and <= 0.9.1

    #   requires_redmine :version => '0.7'..'0.9'         # >= 0.7.x and <= 0.9.x

    def requires_redmine(arg)

      arg = { :version_or_higher => arg } unless arg.is_a?(Hash)

      arg.assert_valid_keys(:version, :version_or_higher)

      true

    end

    def compare_versions(requirement, current)

      requirement = requirement.split('.').collect(&:to_i)

      requirement <=> current.slice(0, requirement.size)

    # Sets a requirement on a Redmine plugin version

    # Raises a PluginRequirementError exception if the requirement is not met

    #

    #   # Requires a plugin named :foo version 0.7.3 or higher

    #   requires_redmine_plugin :foo, :version_or_higher => '0.7.3'

    #   requires_redmine_plugin :foo, '0.7.3'

    #   # Requires a specific version of a Redmine plugin

    #   requires_redmine_plugin :foo, :version => '0.7.3'              # 0.7.3 only

    #   requires_redmine_plugin :foo, :version => ['0.7.3', '0.8.0']   # 0.7.3 or 0.8.0

    def requires_redmine_plugin(plugin_name, arg)

      arg = { :version_or_higher => arg } unless arg.is_a?(Hash)

      arg.assert_valid_keys(:version, :version_or_higher)

    #

    # +name+ parameter can be: :top_menu, :account_menu, :application_menu or :project_menu

    #

    def menu(menu, item, url, options={})

      Redmine::MenuManager.map(menu).push(item, url, options)

    end

    alias :add_menu_item :menu

    # Removes +item+ from the given +menu+.

    def delete_menu_item(menu, item)

      Redmine::MenuManager.map(menu).delete(item)

    end

    # * :require => can be set to one of the following values to restrict users the permission can be given to: :loggedin, :member

    # * :read => set it to true so that the permission is still granted on closed projects

    #

    #   # A permission that is implicitly given to any user

    #   # This permission won't appear on the Roles & Permissions setup screen

    #   permission :say_hello, { :example => :say_hello }, :public => true, :read => true

    #

    #   # A permission that can be given to project members only

    #   permission :say_hello, { :example => :say_hello }, :require => :member

    def permission(name, actions, options = {})

      if @project_module

        Redmine::AccessControl.map {|map| map.project_module(@project_module) {|map|map.permission(name, actions, options)}}

    #     permission :view_contacts, { :contacts => [:list, :show] }, :public => true

    #     permission :destroy_contacts, { :contacts => :destroy }

    #   end

    def project_module(name, &block)

      @project_module = name

      self.instance_eval(&block)

    #

    # A model can provide several activity event types.

    #

    #   register :news

    #   register :scrums, :class_name => 'Meeting'

    #   register :issues, :class_name => ['Issue', 'Journal']

    #   Meeting.find_events('scrums', User.current, 5.days.ago, Date.today, :project => foo) # events for project foo only

    #

    # Note that :view_scrums permission is required to view these events in the activity view.

    def activity_provider(*args)

      Redmine::Activity.register(*args)

    end

    # * +options+ - a Hash of options (optional)

    #   * :label - label for the formatter displayed in application settings

    #

    #   wiki_format_provider(:custom_formatter, CustomFormatter, :label => "My custom formatter") 

    #

    def wiki_format_provider(name, *args)

      Redmine::WikiFormatting.register(name, *args)

    end

    # Returns +true+ if the plugin can be configured.

    def configurable?

      settings && settings.is_a?(Hash) && !settings[:partial].blank?

    end

    def mirror_assets

      source = assets_directory

      destination = public_directory

    end

    # Mirrors assets from one or all plugins to public/plugin_assets

    def self.mirror_assets(name=nil)

      if name.present?

        find(name).mirror_assets

    end

    # The directory containing this plugin's migrations (<tt>plugin/db/migrate</tt>)

    def migration_directory

      File.join(directory, 'db', 'migrate')

    end

    # Returns the version number of the latest migration for this plugin. Returns

    # nil if this plugin has no migrations.

    def latest_migration

      migrations.last

    end

    # Returns the version numbers of all migrations for this plugin.

    def migrations

      migrations = Dir[migration_directory+"/*.rb"]

      migrations.map { |p| File.basename(p).match(/0*(\d+)\_/)[1].to_i }.sort

    end

    # Migrate this plugin to the given version

    def migrate(version = nil)

      puts "Migrating #{id} (#{name})..."

      Redmine::Plugin::Migrator.migrate_plugin(self, version)

    #   Plugin.migrate('sample_plugin')

    #   Plugin.migrate('sample_plugin', 1)

    #

    def self.migrate(name=nil, version=nil)

      if name.present?

        find(name).migrate(version)

      end

    end

    class Migrator < ActiveRecord::Migrator

      # We need to be able to set the 'current' plugin being migrated.

      cattr_accessor :current_plugin

      class << self

        # Runs the migrations from a plugin, up (or down) to the version given

        def migrate_plugin(plugin, version)

          self.current_plugin = plugin

          return if current_version(plugin) == version

          migrate(plugin.migration_directory, version)

        end

        def current_version(plugin=current_plugin)

          # Delete migrations that don't match .. to_i will work because the number comes first

          sm_table = ::ActiveRecord::SchemaMigration.table_name

        end

      end

      def migrated

        sm_table = ::ActiveRecord::SchemaMigration.table_name

        ::ActiveRecord::Base.connection.select_values(

        ).delete_if{ |v| v.match(/-#{current_plugin.id}$/) == nil }.map(&:to_i).sort

      end

      def record_version_state_after_migrating(version)

        super(version.to_s + "-" + current_plugin.id.to_s)

      end