comparison .svn/pristine/07/071c1af1d5f365dd709aaf606fafd0332e258d64.svn-base @ 1298:4f746d8966dd redmine_2.3_integration

Merge from redmine-2.3 branch to create new branch redmine-2.3-integration
author Chris Cannam
date Fri, 14 Jun 2013 09:28:30 +0100
parents 622f24f53b42
children
comparison
equal deleted inserted replaced
1297:0a574315af3e 1298:4f746d8966dd
1 # Redmine - project management software
2 # Copyright (C) 2006-2013 Jean-Philippe Lang
3 #
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.
8 #
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.
13 #
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.
17
18 module Redmine #:nodoc:
19
20 class PluginNotFound < StandardError; end
21 class PluginRequirementError < StandardError; end
22
23 # Base class for Redmine plugins.
24 # Plugins are registered using the <tt>register</tt> class method that acts as the public constructor.
25 #
26 # Redmine::Plugin.register :example do
27 # name 'Example plugin'
28 # author 'John Smith'
29 # description 'This is an example plugin for Redmine'
30 # version '0.0.1'
31 # settings :default => {'foo'=>'bar'}, :partial => 'settings/settings'
32 # end
33 #
34 # === Plugin attributes
35 #
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
40 # Example:
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>.
43 #
44 # When rendered, the plugin settings value is available as the local variable +settings+
45 class Plugin
46 cattr_accessor :directory
47 self.directory = File.join(Rails.root, 'plugins')
48
49 cattr_accessor :public_directory
50 self.public_directory = File.join(Rails.root, 'public', 'plugin_assets')
51
52 @registered_plugins = {}
53 class << self
54 attr_reader :registered_plugins
55 private :new
56
57 def def_field(*names)
58 class_eval do
59 names.each do |name|
60 define_method(name) do |*args|
61 args.empty? ? instance_variable_get("@#{name}") : instance_variable_set("@#{name}", *args)
62 end
63 end
64 end
65 end
66 end
67 def_field :name, :description, :url, :author, :author_url, :version, :settings
68 attr_reader :id
69
70 # Plugin constructor
71 def self.register(id, &block)
72 p = new(id)
73 p.instance_eval(&block)
74 # Set a default name if it was not provided during registration
75 p.name(id.to_s.humanize) if p.name.nil?
76
77 # Adds plugin locales if any
78 # YAML translation files should be found under <plugin>/config/locales/
79 ::I18n.load_path += Dir.glob(File.join(p.directory, 'config', 'locales', '*.yml'))
80
81 # Prepends the app/views directory of the plugin to the view path
82 view_path = File.join(p.directory, 'app', 'views')
83 if File.directory?(view_path)
84 ActionController::Base.prepend_view_path(view_path)
85 ActionMailer::Base.prepend_view_path(view_path)
86 end
87
88 # Adds the app/{controllers,helpers,models} directories of the plugin to the autoload path
89 Dir.glob File.expand_path(File.join(p.directory, 'app', '{controllers,helpers,models}')) do |dir|
90 ActiveSupport::Dependencies.autoload_paths += [dir]
91 end
92
93 registered_plugins[id] = p
94 end
95
96 # Returns an array of all registered plugins
97 def self.all
98 registered_plugins.values.sort
99 end
100
101 # Finds a plugin by its id
102 # Returns a PluginNotFound exception if the plugin doesn't exist
103 def self.find(id)
104 registered_plugins[id.to_sym] || raise(PluginNotFound)
105 end
106
107 # Clears the registered plugins hash
108 # It doesn't unload installed plugins
109 def self.clear
110 @registered_plugins = {}
111 end
112
113 # Checks if a plugin is installed
114 #
115 # @param [String] id name of the plugin
116 def self.installed?(id)
117 registered_plugins[id.to_sym].present?
118 end
119
120 def self.load
121 Dir.glob(File.join(self.directory, '*')).sort.each do |directory|
122 if File.directory?(directory)
123 lib = File.join(directory, "lib")
124 if File.directory?(lib)
125 $:.unshift lib
126 ActiveSupport::Dependencies.autoload_paths += [lib]
127 end
128 initializer = File.join(directory, "init.rb")
129 if File.file?(initializer)
130 require initializer
131 end
132 end
133 end
134 end
135
136 def initialize(id)
137 @id = id.to_sym
138 end
139
140 def directory
141 File.join(self.class.directory, id.to_s)
142 end
143
144 def public_directory
145 File.join(self.class.public_directory, id.to_s)
146 end
147
148 def to_param
149 id
150 end
151
152 def assets_directory
153 File.join(directory, 'assets')
154 end
155
156 def <=>(plugin)
157 self.id.to_s <=> plugin.id.to_s
158 end
159
160 # Sets a requirement on Redmine version
161 # Raises a PluginRequirementError exception if the requirement is not met
162 #
163 # Examples
164 # # Requires Redmine 0.7.3 or higher
165 # requires_redmine :version_or_higher => '0.7.3'
166 # requires_redmine '0.7.3'
167 #
168 # # Requires Redmine 0.7.x or higher
169 # requires_redmine '0.7'
170 #
171 # # Requires a specific Redmine version
172 # requires_redmine :version => '0.7.3' # 0.7.3 only
173 # requires_redmine :version => '0.7' # 0.7.x
174 # requires_redmine :version => ['0.7.3', '0.8.0'] # 0.7.3 or 0.8.0
175 #
176 # # Requires a Redmine version within a range
177 # requires_redmine :version => '0.7.3'..'0.9.1' # >= 0.7.3 and <= 0.9.1
178 # requires_redmine :version => '0.7'..'0.9' # >= 0.7.x and <= 0.9.x
179 def requires_redmine(arg)
180 arg = { :version_or_higher => arg } unless arg.is_a?(Hash)
181 arg.assert_valid_keys(:version, :version_or_higher)
182
183 current = Redmine::VERSION.to_a
184 arg.each do |k, req|
185 case k
186 when :version_or_higher
187 raise ArgumentError.new(":version_or_higher accepts a version string only") unless req.is_a?(String)
188 unless compare_versions(req, current) <= 0
189 raise PluginRequirementError.new("#{id} plugin requires Redmine #{req} or higher but current is #{current.join('.')}")
190 end
191 when :version
192 req = [req] if req.is_a?(String)
193 if req.is_a?(Array)
194 unless req.detect {|ver| compare_versions(ver, current) == 0}
195 raise PluginRequirementError.new("#{id} plugin requires one the following Redmine versions: #{req.join(', ')} but current is #{current.join('.')}")
196 end
197 elsif req.is_a?(Range)
198 unless compare_versions(req.first, current) <= 0 && compare_versions(req.last, current) >= 0
199 raise PluginRequirementError.new("#{id} plugin requires a Redmine version between #{req.first} and #{req.last} but current is #{current.join('.')}")
200 end
201 else
202 raise ArgumentError.new(":version option accepts a version string, an array or a range of versions")
203 end
204 end
205 end
206 true
207 end
208
209 def compare_versions(requirement, current)
210 requirement = requirement.split('.').collect(&:to_i)
211 requirement <=> current.slice(0, requirement.size)
212 end
213 private :compare_versions
214
215 # Sets a requirement on a Redmine plugin version
216 # Raises a PluginRequirementError exception if the requirement is not met
217 #
218 # Examples
219 # # Requires a plugin named :foo version 0.7.3 or higher
220 # requires_redmine_plugin :foo, :version_or_higher => '0.7.3'
221 # requires_redmine_plugin :foo, '0.7.3'
222 #
223 # # Requires a specific version of a Redmine plugin
224 # requires_redmine_plugin :foo, :version => '0.7.3' # 0.7.3 only
225 # requires_redmine_plugin :foo, :version => ['0.7.3', '0.8.0'] # 0.7.3 or 0.8.0
226 def requires_redmine_plugin(plugin_name, arg)
227 arg = { :version_or_higher => arg } unless arg.is_a?(Hash)
228 arg.assert_valid_keys(:version, :version_or_higher)
229
230 plugin = Plugin.find(plugin_name)
231 current = plugin.version.split('.').collect(&:to_i)
232
233 arg.each do |k, v|
234 v = [] << v unless v.is_a?(Array)
235 versions = v.collect {|s| s.split('.').collect(&:to_i)}
236 case k
237 when :version_or_higher
238 raise ArgumentError.new("wrong number of versions (#{versions.size} for 1)") unless versions.size == 1
239 unless (current <=> versions.first) >= 0
240 raise PluginRequirementError.new("#{id} plugin requires the #{plugin_name} plugin #{v} or higher but current is #{current.join('.')}")
241 end
242 when :version
243 unless versions.include?(current.slice(0,3))
244 raise PluginRequirementError.new("#{id} plugin requires one the following versions of #{plugin_name}: #{v.join(', ')} but current is #{current.join('.')}")
245 end
246 end
247 end
248 true
249 end
250
251 # Adds an item to the given +menu+.
252 # The +id+ parameter (equals to the project id) is automatically added to the url.
253 # menu :project_menu, :plugin_example, { :controller => 'example', :action => 'say_hello' }, :caption => 'Sample'
254 #
255 # +name+ parameter can be: :top_menu, :account_menu, :application_menu or :project_menu
256 #
257 def menu(menu, item, url, options={})
258 Redmine::MenuManager.map(menu).push(item, url, options)
259 end
260 alias :add_menu_item :menu
261
262 # Removes +item+ from the given +menu+.
263 def delete_menu_item(menu, item)
264 Redmine::MenuManager.map(menu).delete(item)
265 end
266
267 # Defines a permission called +name+ for the given +actions+.
268 #
269 # The +actions+ argument is a hash with controllers as keys and actions as values (a single value or an array):
270 # permission :destroy_contacts, { :contacts => :destroy }
271 # permission :view_contacts, { :contacts => [:index, :show] }
272 #
273 # The +options+ argument is a hash that accept the following keys:
274 # * :public => the permission is public if set to true (implicitly given to any user)
275 # * :require => can be set to one of the following values to restrict users the permission can be given to: :loggedin, :member
276 # * :read => set it to true so that the permission is still granted on closed projects
277 #
278 # Examples
279 # # A permission that is implicitly given to any user
280 # # This permission won't appear on the Roles & Permissions setup screen
281 # permission :say_hello, { :example => :say_hello }, :public => true, :read => true
282 #
283 # # A permission that can be given to any user
284 # permission :say_hello, { :example => :say_hello }
285 #
286 # # A permission that can be given to registered users only
287 # permission :say_hello, { :example => :say_hello }, :require => :loggedin
288 #
289 # # A permission that can be given to project members only
290 # permission :say_hello, { :example => :say_hello }, :require => :member
291 def permission(name, actions, options = {})
292 if @project_module
293 Redmine::AccessControl.map {|map| map.project_module(@project_module) {|map|map.permission(name, actions, options)}}
294 else
295 Redmine::AccessControl.map {|map| map.permission(name, actions, options)}
296 end
297 end
298
299 # Defines a project module, that can be enabled/disabled for each project.
300 # Permissions defined inside +block+ will be bind to the module.
301 #
302 # project_module :things do
303 # permission :view_contacts, { :contacts => [:list, :show] }, :public => true
304 # permission :destroy_contacts, { :contacts => :destroy }
305 # end
306 def project_module(name, &block)
307 @project_module = name
308 self.instance_eval(&block)
309 @project_module = nil
310 end
311
312 # Registers an activity provider.
313 #
314 # Options:
315 # * <tt>:class_name</tt> - one or more model(s) that provide these events (inferred from event_type by default)
316 # * <tt>:default</tt> - setting this option to false will make the events not displayed by default
317 #
318 # A model can provide several activity event types.
319 #
320 # Examples:
321 # register :news
322 # register :scrums, :class_name => 'Meeting'
323 # register :issues, :class_name => ['Issue', 'Journal']
324 #
325 # Retrieving events:
326 # Associated model(s) must implement the find_events class method.
327 # ActiveRecord models can use acts_as_activity_provider as a way to implement this class method.
328 #
329 # The following call should return all the scrum events visible by current user that occured in the 5 last days:
330 # Meeting.find_events('scrums', User.current, 5.days.ago, Date.today)
331 # Meeting.find_events('scrums', User.current, 5.days.ago, Date.today, :project => foo) # events for project foo only
332 #
333 # Note that :view_scrums permission is required to view these events in the activity view.
334 def activity_provider(*args)
335 Redmine::Activity.register(*args)
336 end
337
338 # Registers a wiki formatter.
339 #
340 # Parameters:
341 # * +name+ - human-readable name
342 # * +formatter+ - formatter class, which should have an instance method +to_html+
343 # * +helper+ - helper module, which will be included by wiki pages
344 def wiki_format_provider(name, formatter, helper)
345 Redmine::WikiFormatting.register(name, formatter, helper)
346 end
347
348 # Returns +true+ if the plugin can be configured.
349 def configurable?
350 settings && settings.is_a?(Hash) && !settings[:partial].blank?
351 end
352
353 def mirror_assets
354 source = assets_directory
355 destination = public_directory
356 return unless File.directory?(source)
357
358 source_files = Dir[source + "/**/*"]
359 source_dirs = source_files.select { |d| File.directory?(d) }
360 source_files -= source_dirs
361
362 unless source_files.empty?
363 base_target_dir = File.join(destination, File.dirname(source_files.first).gsub(source, ''))
364 begin
365 FileUtils.mkdir_p(base_target_dir)
366 rescue Exception => e
367 raise "Could not create directory #{base_target_dir}: " + e.message
368 end
369 end
370
371 source_dirs.each do |dir|
372 # strip down these paths so we have simple, relative paths we can
373 # add to the destination
374 target_dir = File.join(destination, dir.gsub(source, ''))
375 begin
376 FileUtils.mkdir_p(target_dir)
377 rescue Exception => e
378 raise "Could not create directory #{target_dir}: " + e.message
379 end
380 end
381
382 source_files.each do |file|
383 begin
384 target = File.join(destination, file.gsub(source, ''))
385 unless File.exist?(target) && FileUtils.identical?(file, target)
386 FileUtils.cp(file, target)
387 end
388 rescue Exception => e
389 raise "Could not copy #{file} to #{target}: " + e.message
390 end
391 end
392 end
393
394 # Mirrors assets from one or all plugins to public/plugin_assets
395 def self.mirror_assets(name=nil)
396 if name.present?
397 find(name).mirror_assets
398 else
399 all.each do |plugin|
400 plugin.mirror_assets
401 end
402 end
403 end
404
405 # The directory containing this plugin's migrations (<tt>plugin/db/migrate</tt>)
406 def migration_directory
407 File.join(Rails.root, 'plugins', id.to_s, 'db', 'migrate')
408 end
409
410 # Returns the version number of the latest migration for this plugin. Returns
411 # nil if this plugin has no migrations.
412 def latest_migration
413 migrations.last
414 end
415
416 # Returns the version numbers of all migrations for this plugin.
417 def migrations
418 migrations = Dir[migration_directory+"/*.rb"]
419 migrations.map { |p| File.basename(p).match(/0*(\d+)\_/)[1].to_i }.sort
420 end
421
422 # Migrate this plugin to the given version
423 def migrate(version = nil)
424 puts "Migrating #{id} (#{name})..."
425 Redmine::Plugin::Migrator.migrate_plugin(self, version)
426 end
427
428 # Migrates all plugins or a single plugin to a given version
429 # Exemples:
430 # Plugin.migrate
431 # Plugin.migrate('sample_plugin')
432 # Plugin.migrate('sample_plugin', 1)
433 #
434 def self.migrate(name=nil, version=nil)
435 if name.present?
436 find(name).migrate(version)
437 else
438 all.each do |plugin|
439 plugin.migrate
440 end
441 end
442 end
443
444 class Migrator < ActiveRecord::Migrator
445 # We need to be able to set the 'current' plugin being migrated.
446 cattr_accessor :current_plugin
447
448 class << self
449 # Runs the migrations from a plugin, up (or down) to the version given
450 def migrate_plugin(plugin, version)
451 self.current_plugin = plugin
452 return if current_version(plugin) == version
453 migrate(plugin.migration_directory, version)
454 end
455
456 def current_version(plugin=current_plugin)
457 # Delete migrations that don't match .. to_i will work because the number comes first
458 ::ActiveRecord::Base.connection.select_values(
459 "SELECT version FROM #{schema_migrations_table_name}"
460 ).delete_if{ |v| v.match(/-#{plugin.id}/) == nil }.map(&:to_i).max || 0
461 end
462 end
463
464 def migrated
465 sm_table = self.class.schema_migrations_table_name
466 ::ActiveRecord::Base.connection.select_values(
467 "SELECT version FROM #{sm_table}"
468 ).delete_if{ |v| v.match(/-#{current_plugin.id}/) == nil }.map(&:to_i).sort
469 end
470
471 def record_version_state_after_migrating(version)
472 super(version.to_s + "-" + current_plugin.id.to_s)
473 end
474 end
475 end
476 end