1 # redMine - project management software
2 # Copyright (C) 2006-2007 Jean-Philippe Lang
4 # This program is free software; you can redistribute it and/or
5 # modify it under the terms of the GNU General Public License
6 # as published by the Free Software Foundation; either version 2
7 # of the License, or (at your option) any later version.
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
14 # You should have received a copy of the GNU General Public License
15 # along with this program; if not, write to the Free Software
16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 module Redmine #:nodoc:
20 class PluginNotFound < StandardError; end
21 class PluginRequirementError < StandardError; end
23 # Base class for Redmine plugins.
24 # Plugins are registered using the <tt>register</tt> class method that acts as the public constructor.
26 # Redmine::Plugin.register :example do
27 # name 'Example plugin'
29 # description 'This is an example plugin for Redmine'
31 # settings :default => {'foo'=>'bar'}, :partial => 'settings/settings'
34 # === Plugin attributes
36 # +settings+ is an optional attribute that let the plugin be configurable.
37 # It must be a hash with the following keys:
38 # * <tt>:default</tt>: default value for the plugin settings
39 # * <tt>:partial</tt>: path of the configuration partial view, relative to the plugin <tt>app/views</tt> directory
41 # settings :default => {'foo'=>'bar'}, :partial => 'settings/settings'
42 # In this example, the settings partial will be found here in the plugin directory: <tt>app/views/settings/_settings.rhtml</tt>.
44 # When rendered, the plugin settings value is available as the local variable +settings+
46 @registered_plugins = {}
48 attr_reader :registered_plugins
54 define_method(name) do |*args|
55 args.empty? ? instance_variable_get("@#{name}") : instance_variable_set("@#{name}", *args)
61 def_field :name, :description, :url, :author, :author_url, :version, :settings
65 def self.register(id, &block)
67 p.instance_eval(&block)
68 # Set a default name if it was not provided during registration
69 p.name(id.to_s.humanize) if p.name.nil?
70 # Adds plugin locales if any
71 # YAML translation files should be found under <plugin>/config/locales/
72 ::I18n.load_path += Dir.glob(File.join(RAILS_ROOT, 'vendor', 'plugins', id.to_s, 'config', 'locales', '*.yml'))
73 registered_plugins[id] = p
76 # Returns an array off all registered plugins
78 registered_plugins.values.sort
81 # Finds a plugin by its id
82 # Returns a PluginNotFound exception if the plugin doesn't exist
84 registered_plugins[id.to_sym] || raise(PluginNotFound)
87 # Clears the registered plugins hash
88 # It doesn't unload installed plugins
90 @registered_plugins = {}
98 self.id.to_s <=> plugin.id.to_s
101 # Sets a requirement on Redmine version
102 # Raises a PluginRequirementError exception if the requirement is not met
105 # # Requires Redmine 0.7.3 or higher
106 # requires_redmine :version_or_higher => '0.7.3'
107 # requires_redmine '0.7.3'
109 # # Requires a specific Redmine version
110 # requires_redmine :version => '0.7.3' # 0.7.3 only
111 # requires_redmine :version => ['0.7.3', '0.8.0'] # 0.7.3 or 0.8.0
112 def requires_redmine(arg)
113 arg = { :version_or_higher => arg } unless arg.is_a?(Hash)
114 arg.assert_valid_keys(:version, :version_or_higher)
116 current = Redmine::VERSION.to_a
118 v = [] << v unless v.is_a?(Array)
119 versions = v.collect {|s| s.split('.').collect(&:to_i)}
121 when :version_or_higher
122 raise ArgumentError.new("wrong number of versions (#{versions.size} for 1)") unless versions.size == 1
123 unless (current <=> versions.first) >= 0
124 raise PluginRequirementError.new("#{id} plugin requires Redmine #{v} or higher but current is #{current.join('.')}")
127 unless versions.include?(current.slice(0,3))
128 raise PluginRequirementError.new("#{id} plugin requires one the following Redmine versions: #{v.join(', ')} but current is #{current.join('.')}")
135 # Sets a requirement on a Redmine plugin version
136 # Raises a PluginRequirementError exception if the requirement is not met
139 # # Requires a plugin named :foo version 0.7.3 or higher
140 # requires_redmine_plugin :foo, :version_or_higher => '0.7.3'
141 # requires_redmine_plugin :foo, '0.7.3'
143 # # Requires a specific version of a Redmine plugin
144 # requires_redmine_plugin :foo, :version => '0.7.3' # 0.7.3 only
145 # requires_redmine_plugin :foo, :version => ['0.7.3', '0.8.0'] # 0.7.3 or 0.8.0
146 def requires_redmine_plugin(plugin_name, arg)
147 arg = { :version_or_higher => arg } unless arg.is_a?(Hash)
148 arg.assert_valid_keys(:version, :version_or_higher)
150 plugin = Plugin.find(plugin_name)
151 current = plugin.version.split('.').collect(&:to_i)
154 v = [] << v unless v.is_a?(Array)
155 versions = v.collect {|s| s.split('.').collect(&:to_i)}
157 when :version_or_higher
158 raise ArgumentError.new("wrong number of versions (#{versions.size} for 1)") unless versions.size == 1
159 unless (current <=> versions.first) >= 0
160 raise PluginRequirementError.new("#{id} plugin requires the #{plugin_name} plugin #{v} or higher but current is #{current.join('.')}")
163 unless versions.include?(current.slice(0,3))
164 raise PluginRequirementError.new("#{id} plugin requires one the following versions of #{plugin_name}: #{v.join(', ')} but current is #{current.join('.')}")
171 # Adds an item to the given +menu+.
172 # The +id+ parameter (equals to the project id) is automatically added to the url.
173 # menu :project_menu, :plugin_example, { :controller => 'example', :action => 'say_hello' }, :caption => 'Sample'
175 # +name+ parameter can be: :top_menu, :account_menu, :application_menu or :project_menu
177 def menu(menu, item, url, options={})
178 Redmine::MenuManager.map(menu).push(item, url, options)
180 alias :add_menu_item :menu
182 # Removes +item+ from the given +menu+.
183 def delete_menu_item(menu, item)
184 Redmine::MenuManager.map(menu).delete(item)
187 # Defines a permission called +name+ for the given +actions+.
189 # The +actions+ argument is a hash with controllers as keys and actions as values (a single value or an array):
190 # permission :destroy_contacts, { :contacts => :destroy }
191 # permission :view_contacts, { :contacts => [:index, :show] }
193 # The +options+ argument can be used to make the permission public (implicitly given to any user)
194 # or to restrict users the permission can be given to.
197 # # A permission that is implicitly given to any user
198 # # This permission won't appear on the Roles & Permissions setup screen
199 # permission :say_hello, { :example => :say_hello }, :public => true
201 # # A permission that can be given to any user
202 # permission :say_hello, { :example => :say_hello }
204 # # A permission that can be given to registered users only
205 # permission :say_hello, { :example => :say_hello }, :require => loggedin
207 # # A permission that can be given to project members only
208 # permission :say_hello, { :example => :say_hello }, :require => member
209 def permission(name, actions, options = {})
211 Redmine::AccessControl.map {|map| map.project_module(@project_module) {|map|map.permission(name, actions, options)}}
213 Redmine::AccessControl.map {|map| map.permission(name, actions, options)}
217 # Defines a project module, that can be enabled/disabled for each project.
218 # Permissions defined inside +block+ will be bind to the module.
220 # project_module :things do
221 # permission :view_contacts, { :contacts => [:list, :show] }, :public => true
222 # permission :destroy_contacts, { :contacts => :destroy }
224 def project_module(name, &block)
225 @project_module = name
226 self.instance_eval(&block)
227 @project_module = nil
230 # Registers an activity provider.
233 # * <tt>:class_name</tt> - one or more model(s) that provide these events (inferred from event_type by default)
234 # * <tt>:default</tt> - setting this option to false will make the events not displayed by default
236 # A model can provide several activity event types.
240 # register :scrums, :class_name => 'Meeting'
241 # register :issues, :class_name => ['Issue', 'Journal']
244 # Associated model(s) must implement the find_events class method.
245 # ActiveRecord models can use acts_as_activity_provider as a way to implement this class method.
247 # The following call should return all the scrum events visible by current user that occured in the 5 last days:
248 # Meeting.find_events('scrums', User.current, 5.days.ago, Date.today)
249 # Meeting.find_events('scrums', User.current, 5.days.ago, Date.today, :project => foo) # events for project foo only
251 # Note that :view_scrums permission is required to view these events in the activity view.
252 def activity_provider(*args)
253 Redmine::Activity.register(*args)
256 # Registers a wiki formatter.
259 # * +name+ - human-readable name
260 # * +formatter+ - formatter class, which should have an instance method +to_html+
261 # * +helper+ - helper module, which will be included by wiki pages
262 def wiki_format_provider(name, formatter, helper)
263 Redmine::WikiFormatting.register(name, formatter, helper)
266 # Returns +true+ if the plugin can be configured.
268 settings && settings.is_a?(Hash) && !settings[:partial].blank?