125 lines
5.0 KiB
Ruby
125 lines
5.0 KiB
Ruby
# redMine - project management software
|
|
# Copyright (C) 2006-2007 Jean-Philippe Lang
|
|
#
|
|
# 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.
|
|
#
|
|
# 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.
|
|
#
|
|
# 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:
|
|
|
|
# Base class for Redmine plugins.
|
|
# Plugins are registered using the <tt>register</tt> class method that acts as the public constructor.
|
|
#
|
|
# 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
|
|
#
|
|
# === Plugin attributes
|
|
#
|
|
# +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>.
|
|
#
|
|
# When rendered, the plugin settings value is available as the local variable +settings+
|
|
class Plugin
|
|
@registered_plugins = {}
|
|
class << self
|
|
attr_reader :registered_plugins
|
|
private :new
|
|
|
|
def def_field(*names)
|
|
class_eval do
|
|
names.each do |name|
|
|
define_method(name) do |*args|
|
|
args.empty? ? instance_variable_get("@#{name}") : instance_variable_set("@#{name}", *args)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
def_field :name, :description, :author, :version, :settings
|
|
|
|
# Plugin constructor
|
|
def self.register(name, &block)
|
|
p = new
|
|
p.instance_eval(&block)
|
|
Plugin.registered_plugins[name] = p
|
|
end
|
|
|
|
# Adds an item to the given +menu+.
|
|
# The +id+ parameter (equals to the project id) is automatically added to the url.
|
|
# menu :project_menu, :label_plugin_example, :controller => 'example', :action => 'say_hello'
|
|
#
|
|
# Currently, only the project menu can be extended. Thus, the +name+ parameter must be +:project_menu+
|
|
def menu(name, label, url)
|
|
Redmine::MenuManager.map(name) {|menu| menu.push label, url}
|
|
end
|
|
|
|
# Defines a permission called +name+ for the given +actions+.
|
|
#
|
|
# 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] }
|
|
#
|
|
# The +options+ argument can be used to make the permission public (implicitly given to any user)
|
|
# or to restrict users the permission can be given to.
|
|
#
|
|
# Examples
|
|
# # A permission that is implicitly given to any user
|
|
# # This permission won't appear on the Roles & Permissions setup screen
|
|
# permission :say_hello, { :example => :say_hello }, :public => true
|
|
#
|
|
# # A permission that can be given to any user
|
|
# permission :say_hello, { :example => :say_hello }
|
|
#
|
|
# # A permission that can be given to registered users only
|
|
# permission :say_hello, { :example => :say_hello }, :require => loggedin
|
|
#
|
|
# # A permission that can be given to project members only
|
|
# permission :say_hello, { :example => :say_hello }, :require => member
|
|
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
|
|
|
|
# Defines a project module, that can be enabled/disabled for each project.
|
|
# Permissions defined inside +block+ will be bind to the module.
|
|
#
|
|
# 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
|
|
|
|
# Returns +true+ if the plugin can be configured.
|
|
def configurable?
|
|
settings && settings.is_a?(Hash) && !settings[:partial].blank?
|
|
end
|
|
end
|
|
end
|