Chris@909: # Redmine - project management software
Chris@909: # Copyright (C) 2006-2011  Jean-Philippe Lang
Chris@0: #
Chris@0: # This program is free software; you can redistribute it and/or
Chris@0: # modify it under the terms of the GNU General Public License
Chris@0: # as published by the Free Software Foundation; either version 2
Chris@0: # of the License, or (at your option) any later version.
Chris@909: #
Chris@0: # This program is distributed in the hope that it will be useful,
Chris@0: # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@0: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Chris@0: # GNU General Public License for more details.
Chris@909: #
Chris@0: # You should have received a copy of the GNU General Public License
Chris@0: # along with this program; if not, write to the Free Software
Chris@0: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
Chris@0: 
Chris@0: module Redmine #:nodoc:
Chris@0: 
Chris@0:   class PluginNotFound < StandardError; end
Chris@0:   class PluginRequirementError < StandardError; end
Chris@909: 
Chris@0:   # Base class for Redmine plugins.
Chris@0:   # Plugins are registered using the <tt>register</tt> class method that acts as the public constructor.
Chris@909:   #
Chris@0:   #   Redmine::Plugin.register :example do
Chris@0:   #     name 'Example plugin'
Chris@0:   #     author 'John Smith'
Chris@0:   #     description 'This is an example plugin for Redmine'
Chris@0:   #     version '0.0.1'
Chris@0:   #     settings :default => {'foo'=>'bar'}, :partial => 'settings/settings'
Chris@0:   #   end
Chris@909:   #
Chris@0:   # === Plugin attributes
Chris@909:   #
Chris@0:   # +settings+ is an optional attribute that let the plugin be configurable.
Chris@0:   # It must be a hash with the following keys:
Chris@0:   # * <tt>:default</tt>: default value for the plugin settings
Chris@0:   # * <tt>:partial</tt>: path of the configuration partial view, relative to the plugin <tt>app/views</tt> directory
Chris@0:   # Example:
Chris@0:   #   settings :default => {'foo'=>'bar'}, :partial => 'settings/settings'
Chris@0:   # In this example, the settings partial will be found here in the plugin directory: <tt>app/views/settings/_settings.rhtml</tt>.
Chris@909:   #
Chris@0:   # When rendered, the plugin settings value is available as the local variable +settings+
Chris@0:   class Plugin
Chris@0:     @registered_plugins = {}
Chris@0:     class << self
Chris@0:       attr_reader :registered_plugins
Chris@0:       private :new
Chris@0: 
Chris@0:       def def_field(*names)
Chris@909:         class_eval do
Chris@0:           names.each do |name|
Chris@909:             define_method(name) do |*args|
Chris@0:               args.empty? ? instance_variable_get("@#{name}") : instance_variable_set("@#{name}", *args)
Chris@0:             end
Chris@0:           end
Chris@0:         end
Chris@0:       end
Chris@0:     end
Chris@0:     def_field :name, :description, :url, :author, :author_url, :version, :settings
Chris@0:     attr_reader :id
Chris@909: 
Chris@0:     # Plugin constructor
Chris@0:     def self.register(id, &block)
Chris@0:       p = new(id)
Chris@0:       p.instance_eval(&block)
Chris@0:       # Set a default name if it was not provided during registration
Chris@0:       p.name(id.to_s.humanize) if p.name.nil?
Chris@0:       # Adds plugin locales if any
Chris@0:       # YAML translation files should be found under <plugin>/config/locales/
Chris@909:       ::I18n.load_path += Dir.glob(File.join(Rails.root, 'vendor', 'plugins', id.to_s, 'config', 'locales', '*.yml'))
Chris@0:       registered_plugins[id] = p
Chris@0:     end
Chris@909: 
Chris@909:     # Returns an array of all registered plugins
Chris@0:     def self.all
Chris@0:       registered_plugins.values.sort
Chris@0:     end
Chris@909: 
Chris@0:     # Finds a plugin by its id
Chris@0:     # Returns a PluginNotFound exception if the plugin doesn't exist
Chris@0:     def self.find(id)
Chris@0:       registered_plugins[id.to_sym] || raise(PluginNotFound)
Chris@0:     end
Chris@909: 
Chris@0:     # Clears the registered plugins hash
Chris@0:     # It doesn't unload installed plugins
Chris@0:     def self.clear
Chris@0:       @registered_plugins = {}
Chris@0:     end
chris@37: 
chris@37:     # Checks if a plugin is installed
chris@37:     #
chris@37:     # @param [String] id name of the plugin
chris@37:     def self.installed?(id)
chris@37:       registered_plugins[id.to_sym].present?
chris@37:     end
Chris@909: 
Chris@0:     def initialize(id)
Chris@0:       @id = id.to_sym
Chris@0:     end
Chris@909: 
Chris@0:     def <=>(plugin)
Chris@0:       self.id.to_s <=> plugin.id.to_s
Chris@0:     end
Chris@909: 
Chris@0:     # Sets a requirement on Redmine version
Chris@0:     # Raises a PluginRequirementError exception if the requirement is not met
Chris@0:     #
Chris@0:     # Examples
Chris@0:     #   # Requires Redmine 0.7.3 or higher
Chris@0:     #   requires_redmine :version_or_higher => '0.7.3'
Chris@0:     #   requires_redmine '0.7.3'
Chris@0:     #
Chris@0:     #   # Requires a specific Redmine version
Chris@0:     #   requires_redmine :version => '0.7.3'              # 0.7.3 only
Chris@0:     #   requires_redmine :version => ['0.7.3', '0.8.0']   # 0.7.3 or 0.8.0
Chris@0:     def requires_redmine(arg)
Chris@0:       arg = { :version_or_higher => arg } unless arg.is_a?(Hash)
Chris@0:       arg.assert_valid_keys(:version, :version_or_higher)
Chris@909: 
Chris@0:       current = Redmine::VERSION.to_a
Chris@0:       arg.each do |k, v|
Chris@0:         v = [] << v unless v.is_a?(Array)
Chris@0:         versions = v.collect {|s| s.split('.').collect(&:to_i)}
Chris@0:         case k
Chris@0:         when :version_or_higher
Chris@0:           raise ArgumentError.new("wrong number of versions (#{versions.size} for 1)") unless versions.size == 1
Chris@0:           unless (current <=> versions.first) >= 0
Chris@0:             raise PluginRequirementError.new("#{id} plugin requires Redmine #{v} or higher but current is #{current.join('.')}")
Chris@0:           end
Chris@0:         when :version
Chris@0:           unless versions.include?(current.slice(0,3))
Chris@0:             raise PluginRequirementError.new("#{id} plugin requires one the following Redmine versions: #{v.join(', ')} but current is #{current.join('.')}")
Chris@0:           end
Chris@0:         end
Chris@0:       end
Chris@0:       true
Chris@0:     end
Chris@0: 
Chris@0:     # Sets a requirement on a Redmine plugin version
Chris@0:     # Raises a PluginRequirementError exception if the requirement is not met
Chris@0:     #
Chris@0:     # Examples
Chris@0:     #   # Requires a plugin named :foo version 0.7.3 or higher
Chris@0:     #   requires_redmine_plugin :foo, :version_or_higher => '0.7.3'
Chris@0:     #   requires_redmine_plugin :foo, '0.7.3'
Chris@0:     #
Chris@0:     #   # Requires a specific version of a Redmine plugin
Chris@0:     #   requires_redmine_plugin :foo, :version => '0.7.3'              # 0.7.3 only
Chris@0:     #   requires_redmine_plugin :foo, :version => ['0.7.3', '0.8.0']   # 0.7.3 or 0.8.0
Chris@0:     def requires_redmine_plugin(plugin_name, arg)
Chris@0:       arg = { :version_or_higher => arg } unless arg.is_a?(Hash)
Chris@0:       arg.assert_valid_keys(:version, :version_or_higher)
Chris@0: 
Chris@0:       plugin = Plugin.find(plugin_name)
Chris@0:       current = plugin.version.split('.').collect(&:to_i)
Chris@0: 
Chris@0:       arg.each do |k, v|
Chris@0:         v = [] << v unless v.is_a?(Array)
Chris@0:         versions = v.collect {|s| s.split('.').collect(&:to_i)}
Chris@0:         case k
Chris@0:         when :version_or_higher
Chris@0:           raise ArgumentError.new("wrong number of versions (#{versions.size} for 1)") unless versions.size == 1
Chris@0:           unless (current <=> versions.first) >= 0
Chris@0:             raise PluginRequirementError.new("#{id} plugin requires the #{plugin_name} plugin #{v} or higher but current is #{current.join('.')}")
Chris@0:           end
Chris@0:         when :version
Chris@0:           unless versions.include?(current.slice(0,3))
Chris@0:             raise PluginRequirementError.new("#{id} plugin requires one the following versions of #{plugin_name}: #{v.join(', ')} but current is #{current.join('.')}")
Chris@0:           end
Chris@0:         end
Chris@0:       end
Chris@0:       true
Chris@0:     end
Chris@0: 
Chris@0:     # Adds an item to the given +menu+.
Chris@0:     # The +id+ parameter (equals to the project id) is automatically added to the url.
Chris@0:     #   menu :project_menu, :plugin_example, { :controller => 'example', :action => 'say_hello' }, :caption => 'Sample'
Chris@909:     #
Chris@0:     # +name+ parameter can be: :top_menu, :account_menu, :application_menu or :project_menu
Chris@909:     #
Chris@0:     def menu(menu, item, url, options={})
Chris@0:       Redmine::MenuManager.map(menu).push(item, url, options)
Chris@0:     end
Chris@0:     alias :add_menu_item :menu
Chris@909: 
Chris@0:     # Removes +item+ from the given +menu+.
Chris@0:     def delete_menu_item(menu, item)
Chris@0:       Redmine::MenuManager.map(menu).delete(item)
Chris@0:     end
Chris@0: 
Chris@0:     # Defines a permission called +name+ for the given +actions+.
Chris@909:     #
Chris@0:     # The +actions+ argument is a hash with controllers as keys and actions as values (a single value or an array):
Chris@0:     #   permission :destroy_contacts, { :contacts => :destroy }
Chris@0:     #   permission :view_contacts, { :contacts => [:index, :show] }
Chris@909:     #
Chris@0:     # The +options+ argument can be used to make the permission public (implicitly given to any user)
Chris@0:     # or to restrict users the permission can be given to.
Chris@909:     #
Chris@0:     # Examples
Chris@0:     #   # A permission that is implicitly given to any user
Chris@0:     #   # This permission won't appear on the Roles & Permissions setup screen
Chris@0:     #   permission :say_hello, { :example => :say_hello }, :public => true
Chris@909:     #
Chris@0:     #   # A permission that can be given to any user
Chris@0:     #   permission :say_hello, { :example => :say_hello }
Chris@909:     #
Chris@0:     #   # A permission that can be given to registered users only
Chris@0:     #   permission :say_hello, { :example => :say_hello }, :require => :loggedin
Chris@909:     #
Chris@0:     #   # A permission that can be given to project members only
Chris@0:     #   permission :say_hello, { :example => :say_hello }, :require => :member
Chris@0:     def permission(name, actions, options = {})
Chris@0:       if @project_module
Chris@0:         Redmine::AccessControl.map {|map| map.project_module(@project_module) {|map|map.permission(name, actions, options)}}
Chris@0:       else
Chris@0:         Redmine::AccessControl.map {|map| map.permission(name, actions, options)}
Chris@0:       end
Chris@0:     end
Chris@909: 
Chris@0:     # Defines a project module, that can be enabled/disabled for each project.
Chris@0:     # Permissions defined inside +block+ will be bind to the module.
Chris@909:     #
Chris@0:     #   project_module :things do
Chris@0:     #     permission :view_contacts, { :contacts => [:list, :show] }, :public => true
Chris@0:     #     permission :destroy_contacts, { :contacts => :destroy }
Chris@0:     #   end
Chris@0:     def project_module(name, &block)
Chris@0:       @project_module = name
Chris@0:       self.instance_eval(&block)
Chris@0:       @project_module = nil
Chris@0:     end
Chris@909: 
Chris@0:     # Registers an activity provider.
Chris@0:     #
Chris@0:     # Options:
Chris@0:     # * <tt>:class_name</tt> - one or more model(s) that provide these events (inferred from event_type by default)
Chris@0:     # * <tt>:default</tt> - setting this option to false will make the events not displayed by default
Chris@909:     #
Chris@0:     # A model can provide several activity event types.
Chris@909:     #
Chris@0:     # Examples:
Chris@0:     #   register :news
Chris@0:     #   register :scrums, :class_name => 'Meeting'
Chris@0:     #   register :issues, :class_name => ['Issue', 'Journal']
Chris@909:     #
Chris@0:     # Retrieving events:
Chris@0:     # Associated model(s) must implement the find_events class method.
Chris@0:     # ActiveRecord models can use acts_as_activity_provider as a way to implement this class method.
Chris@909:     #
Chris@909:     # The following call should return all the scrum events visible by current user that occured in the 5 last days:
Chris@0:     #   Meeting.find_events('scrums', User.current, 5.days.ago, Date.today)
Chris@0:     #   Meeting.find_events('scrums', User.current, 5.days.ago, Date.today, :project => foo) # events for project foo only
Chris@909:     #
Chris@0:     # Note that :view_scrums permission is required to view these events in the activity view.
Chris@0:     def activity_provider(*args)
Chris@0:       Redmine::Activity.register(*args)
Chris@0:     end
Chris@909: 
Chris@0:     # Registers a wiki formatter.
Chris@0:     #
Chris@0:     # Parameters:
Chris@0:     # * +name+ - human-readable name
Chris@0:     # * +formatter+ - formatter class, which should have an instance method +to_html+
Chris@0:     # * +helper+ - helper module, which will be included by wiki pages
Chris@0:     def wiki_format_provider(name, formatter, helper)
Chris@0:       Redmine::WikiFormatting.register(name, formatter, helper)
Chris@0:     end
Chris@0: 
Chris@0:     # Returns +true+ if the plugin can be configured.
Chris@0:     def configurable?
Chris@0:       settings && settings.is_a?(Hash) && !settings[:partial].blank?
Chris@0:     end
Chris@0:   end
Chris@0: end