2011-06-17 05:19:27 +04:00
# Redmine - project management software
2013-01-12 13:29:31 +04:00
# Copyright (C) 2006-2013 Jean-Philippe Lang
2007-09-23 21:19:27 +04:00
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
2011-06-17 05:19:27 +04:00
#
2007-09-23 21:19:27 +04:00
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
2011-06-17 05:19:27 +04:00
#
2007-09-23 21:19:27 +04:00
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
module Redmine #:nodoc:
2008-11-16 18:38:37 +03:00
class PluginNotFound < StandardError ; end
2008-11-16 23:00:20 +03:00
class PluginRequirementError < StandardError ; end
2011-09-20 06:43:47 +04:00
2007-09-23 21:19:27 +04:00
# Base class for Redmine plugins.
# Plugins are registered using the <tt>register</tt> class method that acts as the public constructor.
2011-09-20 06:43:47 +04:00
#
2007-09-23 21:19:27 +04:00
# Redmine::Plugin.register :example do
# name 'Example plugin'
# author 'John Smith'
# description 'This is an example plugin for Redmine'
# version '0.0.1'
# settings :default => {'foo'=>'bar'}, :partial => 'settings/settings'
# end
2011-09-20 06:43:47 +04:00
#
2007-09-23 21:19:27 +04:00
# === Plugin attributes
2011-09-20 06:43:47 +04:00
#
2007-09-23 21:19:27 +04:00
# +settings+ is an optional attribute that let the plugin be configurable.
# 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
# Example:
# 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>.
2011-09-20 06:43:47 +04:00
#
2007-09-23 21:19:27 +04:00
# When rendered, the plugin settings value is available as the local variable +settings+
class Plugin
2012-04-25 21:17:49 +04:00
cattr_accessor :directory
self . directory = File . join ( Rails . root , 'plugins' )
2012-03-04 14:29:47 +04:00
cattr_accessor :public_directory
self . public_directory = File . join ( Rails . root , 'public' , 'plugin_assets' )
2007-09-23 21:19:27 +04:00
@registered_plugins = { }
class << self
attr_reader :registered_plugins
private :new
def def_field ( * names )
2011-09-20 06:43:47 +04:00
class_eval do
2007-09-23 21:19:27 +04:00
names . each do | name |
2011-09-20 06:43:47 +04:00
define_method ( name ) do | * args |
2007-09-23 21:19:27 +04:00
args . empty? ? instance_variable_get ( " @ #{ name } " ) : instance_variable_set ( " @ #{ name } " , * args )
end
end
end
end
end
2008-11-16 20:12:02 +03:00
def_field :name , :description , :url , :author , :author_url , :version , :settings
2008-11-16 18:22:48 +03:00
attr_reader :id
2011-09-20 06:43:47 +04:00
2007-09-23 21:19:27 +04:00
# Plugin constructor
2008-11-16 18:22:48 +03:00
def self . register ( id , & block )
p = new ( id )
2007-09-23 21:19:27 +04:00
p . instance_eval ( & block )
2008-11-16 19:08:25 +03:00
# Set a default name if it was not provided during registration
p . name ( id . to_s . humanize ) if p . name . nil?
2012-04-25 21:17:49 +04:00
2009-02-21 14:04:50 +03:00
# Adds plugin locales if any
# YAML translation files should be found under <plugin>/config/locales/
2012-04-25 21:17:49 +04:00
:: I18n . load_path += Dir . glob ( File . join ( p . directory , 'config' , 'locales' , '*.yml' ) )
# Prepends the app/views directory of the plugin to the view path
view_path = File . join ( p . directory , 'app' , 'views' )
if File . directory? ( view_path )
ActionController :: Base . prepend_view_path ( view_path )
2012-09-06 21:34:14 +04:00
ActionMailer :: Base . prepend_view_path ( view_path )
2012-04-25 21:17:49 +04:00
end
# Adds the app/{controllers,helpers,models} directories of the plugin to the autoload path
Dir . glob File . expand_path ( File . join ( p . directory , 'app' , '{controllers,helpers,models}' ) ) do | dir |
ActiveSupport :: Dependencies . autoload_paths += [ dir ]
end
2008-11-16 18:38:37 +03:00
registered_plugins [ id ] = p
end
2011-08-11 06:40:08 +04:00
# Returns an array of all registered plugins
2008-11-16 18:38:37 +03:00
def self . all
registered_plugins . values . sort
end
2011-08-11 06:40:08 +04:00
2008-11-16 18:38:37 +03:00
# Finds a plugin by its id
2008-11-16 19:08:25 +03:00
# Returns a PluginNotFound exception if the plugin doesn't exist
2008-11-16 18:38:37 +03:00
def self . find ( id )
registered_plugins [ id . to_sym ] || raise ( PluginNotFound )
2008-11-16 18:22:48 +03:00
end
2011-09-20 06:43:47 +04:00
2008-11-16 19:08:25 +03:00
# Clears the registered plugins hash
# It doesn't unload installed plugins
def self . clear
@registered_plugins = { }
end
2010-10-26 03:32:01 +04:00
# Checks if a plugin is installed
#
# @param [String] id name of the plugin
def self . installed? ( id )
registered_plugins [ id . to_sym ] . present?
end
2011-09-20 06:43:47 +04:00
2012-04-25 21:17:49 +04:00
def self . load
Dir . glob ( File . join ( self . directory , '*' ) ) . sort . each do | directory |
if File . directory? ( directory )
lib = File . join ( directory , " lib " )
if File . directory? ( lib )
$: . unshift lib
ActiveSupport :: Dependencies . autoload_paths += [ lib ]
end
initializer = File . join ( directory , " init.rb " )
if File . file? ( initializer )
require initializer
end
end
end
end
2008-11-16 18:22:48 +03:00
def initialize ( id )
@id = id . to_sym
end
2011-09-20 06:43:47 +04:00
2012-04-25 21:17:49 +04:00
def directory
File . join ( self . class . directory , id . to_s )
end
def public_directory
File . join ( self . class . public_directory , id . to_s )
end
2012-12-13 17:52:56 +04:00
def to_param
id
end
2012-04-25 21:17:49 +04:00
def assets_directory
File . join ( directory , 'assets' )
end
2008-11-16 18:22:48 +03:00
def <=> ( plugin )
self . id . to_s < = > plugin . id . to_s
2007-09-23 21:19:27 +04:00
end
2011-09-20 06:43:47 +04:00
2008-11-16 23:00:20 +03:00
# Sets a requirement on Redmine version
# Raises a PluginRequirementError exception if the requirement is not met
#
# Examples
# # Requires Redmine 0.7.3 or higher
# requires_redmine :version_or_higher => '0.7.3'
# requires_redmine '0.7.3'
2012-11-17 15:05:27 +04:00
#
# # Requires Redmine 0.7.x or higher
2012-11-17 14:55:38 +04:00
# requires_redmine '0.7'
2008-11-16 23:00:20 +03:00
#
# # Requires a specific Redmine version
# requires_redmine :version => '0.7.3' # 0.7.3 only
2012-11-17 14:55:38 +04:00
# requires_redmine :version => '0.7' # 0.7.x
2008-11-16 23:00:20 +03:00
# requires_redmine :version => ['0.7.3', '0.8.0'] # 0.7.3 or 0.8.0
2012-11-17 14:55:38 +04:00
#
# # 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
2008-11-16 23:00:20 +03:00
def requires_redmine ( arg )
arg = { :version_or_higher = > arg } unless arg . is_a? ( Hash )
arg . assert_valid_keys ( :version , :version_or_higher )
2011-09-20 06:43:47 +04:00
2008-11-16 23:00:20 +03:00
current = Redmine :: VERSION . to_a
2012-11-17 14:55:38 +04:00
arg . each do | k , req |
2008-11-16 23:00:20 +03:00
case k
when :version_or_higher
2012-11-17 14:55:38 +04:00
raise ArgumentError . new ( " :version_or_higher accepts a version string only " ) unless req . is_a? ( String )
unless compare_versions ( req , current ) < = 0
raise PluginRequirementError . new ( " #{ id } plugin requires Redmine #{ req } or higher but current is #{ current . join ( '.' ) } " )
2008-11-16 23:00:20 +03:00
end
when :version
2012-11-17 14:55:38 +04:00
req = [ req ] if req . is_a? ( String )
if req . is_a? ( Array )
unless req . detect { | ver | compare_versions ( ver , current ) == 0 }
raise PluginRequirementError . new ( " #{ id } plugin requires one the following Redmine versions: #{ req . join ( ', ' ) } but current is #{ current . join ( '.' ) } " )
end
elsif req . is_a? ( Range )
unless compare_versions ( req . first , current ) < = 0 && compare_versions ( req . last , current ) > = 0
raise PluginRequirementError . new ( " #{ id } plugin requires a Redmine version between #{ req . first } and #{ req . last } but current is #{ current . join ( '.' ) } " )
end
else
raise ArgumentError . new ( " :version option accepts a version string, an array or a range of versions " )
2008-11-16 23:00:20 +03:00
end
end
end
true
end
2007-09-23 21:19:27 +04:00
2012-11-17 14:55:38 +04:00
def compare_versions ( requirement , current )
requirement = requirement . split ( '.' ) . collect ( & :to_i )
requirement < = > current . slice ( 0 , requirement . size )
end
private :compare_versions
2009-12-16 05:07:46 +03:00
# Sets a requirement on a Redmine plugin version
# Raises a PluginRequirementError exception if the requirement is not met
#
# Examples
# # 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 )
plugin = Plugin . find ( plugin_name )
current = plugin . version . split ( '.' ) . collect ( & :to_i )
arg . each do | k , v |
v = [ ] << v unless v . is_a? ( Array )
versions = v . collect { | s | s . split ( '.' ) . collect ( & :to_i ) }
case k
when :version_or_higher
raise ArgumentError . new ( " wrong number of versions ( #{ versions . size } for 1) " ) unless versions . size == 1
unless ( current < = > versions . first ) > = 0
raise PluginRequirementError . new ( " #{ id } plugin requires the #{ plugin_name } plugin #{ v } or higher but current is #{ current . join ( '.' ) } " )
end
when :version
unless versions . include? ( current . slice ( 0 , 3 ) )
raise PluginRequirementError . new ( " #{ id } plugin requires one the following versions of #{ plugin_name } : #{ v . join ( ', ' ) } but current is #{ current . join ( '.' ) } " )
end
end
end
true
end
2007-09-23 21:19:27 +04:00
# Adds an item to the given +menu+.
# The +id+ parameter (equals to the project id) is automatically added to the url.
2008-02-22 21:19:00 +03:00
# menu :project_menu, :plugin_example, { :controller => 'example', :action => 'say_hello' }, :caption => 'Sample'
2011-09-20 06:43:47 +04:00
#
2008-02-22 21:19:00 +03:00
# +name+ parameter can be: :top_menu, :account_menu, :application_menu or :project_menu
2011-09-20 06:43:47 +04:00
#
2008-10-25 13:55:31 +04:00
def menu ( menu , item , url , options = { } )
Redmine :: MenuManager . map ( menu ) . push ( item , url , options )
end
alias :add_menu_item :menu
2011-09-20 06:43:47 +04:00
2008-10-25 13:55:31 +04:00
# Removes +item+ from the given +menu+.
def delete_menu_item ( menu , item )
Redmine :: MenuManager . map ( menu ) . delete ( item )
2007-09-23 21:19:27 +04:00
end
# Defines a permission called +name+ for the given +actions+.
2011-09-20 06:43:47 +04:00
#
2007-09-23 21:19:27 +04:00
# The +actions+ argument is a hash with controllers as keys and actions as values (a single value or an array):
# permission :destroy_contacts, { :contacts => :destroy }
# permission :view_contacts, { :contacts => [:index, :show] }
2011-09-20 06:43:47 +04:00
#
2012-06-25 21:49:35 +04:00
# The +options+ argument is a hash that accept the following keys:
# * :public => the permission is public if set to true (implicitly given to any user)
# * :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
2011-09-20 06:43:47 +04:00
#
2007-09-23 21:19:27 +04:00
# Examples
# # A permission that is implicitly given to any user
# # This permission won't appear on the Roles & Permissions setup screen
2012-06-25 21:49:35 +04:00
# permission :say_hello, { :example => :say_hello }, :public => true, :read => true
2011-09-20 06:43:47 +04:00
#
2007-09-23 21:19:27 +04:00
# # A permission that can be given to any user
# permission :say_hello, { :example => :say_hello }
2011-09-20 06:43:47 +04:00
#
2007-09-23 21:19:27 +04:00
# # A permission that can be given to registered users only
2010-07-16 07:11:35 +04:00
# permission :say_hello, { :example => :say_hello }, :require => :loggedin
2011-09-20 06:43:47 +04:00
#
2007-09-23 21:19:27 +04:00
# # A permission that can be given to project members only
2010-07-16 07:11:35 +04:00
# permission :say_hello, { :example => :say_hello }, :require => :member
2007-09-23 21:19:27 +04:00
def permission ( name , actions , options = { } )
if @project_module
Redmine :: AccessControl . map { | map | map . project_module ( @project_module ) { | map | map . permission ( name , actions , options ) } }
else
Redmine :: AccessControl . map { | map | map . permission ( name , actions , options ) }
end
end
2011-09-20 06:43:47 +04:00
2007-09-23 21:19:27 +04:00
# Defines a project module, that can be enabled/disabled for each project.
# Permissions defined inside +block+ will be bind to the module.
2011-09-20 06:43:47 +04:00
#
2007-09-23 21:19:27 +04:00
# project_module :things do
# 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 )
@project_module = nil
end
2011-09-20 06:43:47 +04:00
2008-07-27 22:38:31 +04:00
# Registers an activity provider.
#
# Options:
# * <tt>:class_name</tt> - one or more model(s) that provide these events (inferred from event_type by default)
# * <tt>:default</tt> - setting this option to false will make the events not displayed by default
2011-09-20 06:43:47 +04:00
#
2008-07-27 22:38:31 +04:00
# A model can provide several activity event types.
2011-09-20 06:43:47 +04:00
#
2008-07-27 22:38:31 +04:00
# Examples:
# register :news
# register :scrums, :class_name => 'Meeting'
# register :issues, :class_name => ['Issue', 'Journal']
2011-09-20 06:43:47 +04:00
#
2008-07-27 22:38:31 +04:00
# Retrieving events:
# Associated model(s) must implement the find_events class method.
# ActiveRecord models can use acts_as_activity_provider as a way to implement this class method.
2011-09-20 06:43:47 +04:00
#
# The following call should return all the scrum events visible by current user that occured in the 5 last days:
2008-07-27 22:38:31 +04:00
# Meeting.find_events('scrums', User.current, 5.days.ago, Date.today)
# Meeting.find_events('scrums', User.current, 5.days.ago, Date.today, :project => foo) # events for project foo only
2011-09-20 06:43:47 +04:00
#
2008-07-27 22:38:31 +04:00
# Note that :view_scrums permission is required to view these events in the activity view.
def activity_provider ( * args )
Redmine :: Activity . register ( * args )
end
2011-09-20 06:43:47 +04:00
2008-10-27 14:08:29 +03:00
# Registers a wiki formatter.
#
# Parameters:
# * +name+ - human-readable name
# * +formatter+ - formatter class, which should have an instance method +to_html+
# * +helper+ - helper module, which will be included by wiki pages
def wiki_format_provider ( name , formatter , helper )
Redmine :: WikiFormatting . register ( name , formatter , helper )
end
2007-09-23 21:19:27 +04:00
# Returns +true+ if the plugin can be configured.
def configurable?
settings && settings . is_a? ( Hash ) && ! settings [ :partial ] . blank?
end
2012-04-25 21:17:49 +04:00
def mirror_assets
source = assets_directory
destination = public_directory
return unless File . directory? ( source )
source_files = Dir [ source + " /**/* " ]
source_dirs = source_files . select { | d | File . directory? ( d ) }
source_files -= source_dirs
unless source_files . empty?
base_target_dir = File . join ( destination , File . dirname ( source_files . first ) . gsub ( source , '' ) )
2012-09-26 08:11:14 +04:00
begin
FileUtils . mkdir_p ( base_target_dir )
rescue Exception = > e
raise " Could not create directory #{ base_target_dir } : " + e . message
end
2012-04-25 21:17:49 +04:00
end
source_dirs . each do | dir |
# strip down these paths so we have simple, relative paths we can
# add to the destination
target_dir = File . join ( destination , dir . gsub ( source , '' ) )
begin
FileUtils . mkdir_p ( target_dir )
rescue Exception = > e
2012-09-26 08:11:00 +04:00
raise " Could not create directory #{ target_dir } : " + e . message
2012-04-25 21:17:49 +04:00
end
end
source_files . each do | file |
begin
target = File . join ( destination , file . gsub ( source , '' ) )
unless File . exist? ( target ) && FileUtils . identical? ( file , target )
FileUtils . cp ( file , target )
end
rescue Exception = > e
2012-09-26 08:11:00 +04:00
raise " Could not copy #{ file } to #{ target } : " + e . message
2012-04-25 21:17:49 +04:00
end
end
2012-04-28 15:07:59 +04:00
end
2012-05-01 14:25:22 +04:00
# Mirrors assets from one or all plugins to public/plugin_assets
def self . mirror_assets ( name = nil )
if name . present?
find ( name ) . mirror_assets
else
all . each do | plugin |
plugin . mirror_assets
end
2012-04-28 15:07:59 +04:00
end
2012-04-25 21:17:49 +04:00
end
# The directory containing this plugin's migrations (<tt>plugin/db/migrate</tt>)
def migration_directory
File . join ( Rails . root , 'plugins' , id . to_s , 'db' , 'migrate' )
end
2012-05-01 13:02:34 +04:00
2012-04-25 21:17:49 +04:00
# 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
2012-05-01 13:02:34 +04:00
2012-04-25 21:17:49 +04:00
# 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
2012-05-01 13:02:34 +04:00
2012-04-25 21:17:49 +04:00
# Migrate this plugin to the given version
def migrate ( version = nil )
2012-05-01 13:02:34 +04:00
puts " Migrating #{ id } ( #{ name } )... "
2012-04-25 21:17:49 +04:00
Redmine :: Plugin :: Migrator . migrate_plugin ( self , version )
end
2012-05-01 13:02:34 +04:00
# Migrates all plugins or a single plugin to a given version
# Exemples:
# Plugin.migrate
# Plugin.migrate('sample_plugin')
# Plugin.migrate('sample_plugin', 1)
#
def self . migrate ( name = nil , version = nil )
if name . present?
find ( name ) . migrate ( version )
else
all . each do | plugin |
plugin . migrate
end
end
end
2012-04-25 21:17:49 +04:00
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
:: ActiveRecord :: Base . connection . select_values (
" SELECT version FROM #{ schema_migrations_table_name } "
) . delete_if { | v | v . match ( / - #{ plugin . id } / ) == nil } . map ( & :to_i ) . max || 0
end
end
def migrated
sm_table = self . class . schema_migrations_table_name
:: ActiveRecord :: Base . connection . select_values (
" SELECT version FROM #{ sm_table } "
) . 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
end
2007-09-23 21:19:27 +04:00
end
end