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