jro_apps/redmine Commit - r2037:fefc6e6bec61

Adds .find and .all Plugin class methods....

Jean-Philippe Lang -

r2037:fefc6e6bec61

parent child

Context file:

r2037:fefc6e6bec61

Collapse all files

app/controllers/admin_controller.rb +1 -1

             # redMine - project management software
             # Copyright (C) 2006  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.
             class AdminController < ApplicationController
               before_filter :require_admin
               helper :sort
               include SortHelper
               def index
                 @no_configuration_data = Redmine::DefaultData::Loader::no_data?
               end
               def projects
                 sort_init 'name', 'asc'
                 sort_update
                 @status = params[:status] ? params[:status].to_i : 1
                 c = ARCondition.new(@status == 0 ? "status <> 0" : ["status = ?", @status])
                 unless params[:name].blank?
                   name = "%#{params[:name].strip.downcase}%"
                   c << ["LOWER(identifier) LIKE ? OR LOWER(name) LIKE ?", name, name]
                 end
                 @project_count = Project.count(:conditions => c.conditions)
                 @project_pages = Paginator.new self, @project_count,
             								per_page_option,
             								params['page']
                 @projects = Project.find :all, :order => sort_clause,
                                     :conditions => c.conditions,
             						:limit  =>  @project_pages.items_per_page,
             						:offset =>  @project_pages.current.offset
                 render :action => "projects", :layout => false if request.xhr?
               end
               def plugins
-                @plugins = Redmine::Plugin.registered_plugins.values.sort
+                @plugins = Redmine::Plugin.all
               end
               # Loads the default configuration
               # (roles, trackers, statuses, workflow, enumerations)
               def default_configuration
                 if request.post?
                   begin
                     Redmine::DefaultData::Loader::load(params[:lang])
                     flash[:notice] = l(:notice_default_data_loaded)
                   rescue Exception => e
                     flash[:error] = l(:error_can_t_load_default_data, e.message)
                   end
                 end
                 redirect_to :action => 'index'
               end
               def test_email
                 raise_delivery_errors = ActionMailer::Base.raise_delivery_errors
                 # Force ActionMailer to raise delivery errors so we can catch it
                 ActionMailer::Base.raise_delivery_errors = true
                 begin
                   @test = Mailer.deliver_test(User.current)
                   flash[:notice] = l(:notice_email_sent, User.current.mail)
                 rescue Exception => e
                   flash[:error] = l(:notice_email_error, e.message)
                 end
                 ActionMailer::Base.raise_delivery_errors = raise_delivery_errors
                 redirect_to :controller => 'settings', :action => 'edit', :tab => 'notifications'
               end
               def info
                 @db_adapter_name = ActiveRecord::Base.connection.adapter_name
                 @flags = {
                   :default_admin_changed => User.find(:first, :conditions => ["login=? and hashed_password=?", 'admin', User.hash_password('admin')]).nil?,
                   :file_repository_writable => File.writable?(Attachment.storage_path),
                   :rmagick_available => Object.const_defined?(:Magick)
                 }
               end
             end

app/controllers/settings_controller.rb +6 -5

             # 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.
             class SettingsController < ApplicationController
               before_filter :require_admin
               def index
                 edit
                 render :action => 'edit'
               end
               def edit
                 @notifiables = %w(issue_added issue_updated news_added document_added file_added message_posted)
                 if request.post? && params[:settings] && params[:settings].is_a?(Hash)
                   settings = (params[:settings] || {}).dup.symbolize_keys
                   settings.each do |name, value|
                     # remove blank values in array settings
                     value.delete_if {|v| v.blank? } if value.is_a?(Array)
                     Setting[name] = value
                   end
                   flash[:notice] = l(:notice_successful_update)
                   redirect_to :action => 'edit', :tab => params[:tab]
                   return
                 end
                 @options = {}
                 @options[:user_format] = User::USER_FORMATS.keys.collect {|f| [User.current.name(f), f.to_s] }
                 @deliveries = ActionMailer::Base.perform_deliveries
                 @guessed_host_and_path = request.host_with_port
                 @guessed_host_and_path << ('/'+ request.relative_url_root.gsub(%r{^\/}, '')) unless request.relative_url_root.blank?
               end
               def plugin
-                plugin_id = params[:id].to_sym
+                @plugin = Redmine::Plugin.find(params[:id])
-                @plugin = Redmine::Plugin.registered_plugins[plugin_id]
                 if request.post?
-                  Setting["plugin_#{plugin_id}"] = params[:settings]
+                  Setting["plugin_#{@plugin.id}"] = params[:settings]
                   flash[:notice] = l(:notice_successful_update)
-                  redirect_to :action => 'plugin', :id => params[:id]
+                  redirect_to :action => 'plugin', :id => @plugin.id
                 end
                 @partial = @plugin.settings[:partial]
-                @settings = Setting["plugin_#{plugin_id}"]
+                @settings = Setting["plugin_#{@plugin.id}"]
+              rescue Redmine::PluginNotFound
+                render_404
               end
             end

app/models/setting.rb +2 -2

             # 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.
             class Setting < ActiveRecord::Base
               DATE_FORMATS = [
             	'%Y-%m-%d',
             	'%d/%m/%Y',
             	'%d.%m.%Y',
             	'%d-%m-%Y',
             	'%m/%d/%Y',
             	'%d %b %Y',
             	'%d %B %Y',
             	'%b %d, %Y',
             	'%B %d, %Y'
                 ]
               TIME_FORMATS = [
                 '%H:%M',
                 '%I:%M %p'
                 ]
               ENCODINGS = %w(US-ASCII
                               windows-1250
                               windows-1251
                               windows-1252
                               windows-1253
                               windows-1254
                               windows-1255
                               windows-1256
                               windows-1257
                               windows-1258
                               windows-31j
                               ISO-2022-JP
                               ISO-2022-KR
                               ISO-8859-1
                               ISO-8859-2
                               ISO-8859-3
                               ISO-8859-4
                               ISO-8859-5
                               ISO-8859-6
                               ISO-8859-7
                               ISO-8859-8
                               ISO-8859-9
                               ISO-8859-13
                               ISO-8859-15
                               KOI8-R
                               UTF-8
                               UTF-16
                               UTF-16BE
                               UTF-16LE
                               EUC-JP
                               Shift_JIS
                               GB18030
                               GBK
                               ISCII91
                               EUC-KR
                               Big5
                               Big5-HKSCS
                               TIS-620)
               cattr_accessor :available_settings
               @@available_settings = YAML::load(File.open("#{RAILS_ROOT}/config/settings.yml"))
-              Redmine::Plugin.registered_plugins.each do |id, plugin|
+              Redmine::Plugin.all.each do |plugin|
                 next unless plugin.settings
-                @@available_settings["plugin_#{id}"] = {'default' => plugin.settings[:default], 'serialized' => true}
+                @@available_settings["plugin_#{plugin.id}"] = {'default' => plugin.settings[:default], 'serialized' => true}
               end
               validates_uniqueness_of :name
               validates_inclusion_of :name, :in => @@available_settings.keys
               validates_numericality_of :value, :only_integer => true, :if => Proc.new { |setting| @@available_settings[setting.name]['format'] == 'int' }
               # Hash used to cache setting values
               @cached_settings = {}
               @cached_cleared_on = Time.now
               def value
                 v = read_attribute(:value)
                 # Unserialize serialized settings
                 v = YAML::load(v) if @@available_settings[name]['serialized'] && v.is_a?(String)
                 v = v.to_sym if @@available_settings[name]['format'] == 'symbol' && !v.blank?
                 v
               end
               def value=(v)
                 v = v.to_yaml if v && @@available_settings[name]['serialized']
                 write_attribute(:value, v.to_s)
               end
               # Returns the value of the setting named name
               def self.[](name)
                 v = @cached_settings[name]
                 v ? v : (@cached_settings[name] = find_or_default(name).value)
               end
               def self.[]=(name, v)
                 setting = find_or_default(name)
                 setting.value = (v ? v : "")
                 @cached_settings[name] = nil
                 setting.save
                 setting.value
               end
               # Defines getter and setter for each setting
               # Then setting values can be read using: Setting.some_setting_name
               # or set using Setting.some_setting_name = "some value"
               @@available_settings.each do |name, params|
                 src = <<-END_SRC
                 def self.#{name}
                   self[:#{name}]
                 end
                 def self.#{name}?
                   self[:#{name}].to_i > 0
                 end
                 def self.#{name}=(value)
                   self[:#{name}] = value
                 end
                 END_SRC
                 class_eval src, __FILE__, __LINE__
               end
               # Helper that returns an array based on per_page_options setting
               def self.per_page_options_array
                 per_page_options.split(%r{[\s,]}).collect(&:to_i).select {|n| n > 0}.sort
               end
               # Checks if settings have changed since the values were read
               # and clears the cache hash if it's the case
               # Called once per request
               def self.check_cache
                 settings_updated_on = Setting.maximum(:updated_on)
                 if settings_updated_on && @cached_cleared_on <= settings_updated_on
                   @cached_settings.clear
                   @cached_cleared_on = Time.now
                   logger.info "Settings cache cleared." if logger
                 end
               end
             private
               # Returns the Setting instance for the setting named name
               # (record found in database or new record with default value)
               def self.find_or_default(name)
                 name = name.to_s
                 raise "There's no setting named #{name}" unless @@available_settings.has_key?(name)
                 setting = find_by_name(name)
                 setting ||= new(:name => name, :value => @@available_settings[name]['default']) if @@available_settings.has_key? name
               end
             end

lib/redmine/plugin.rb +13 -1

             # 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:
+              class PluginNotFound < StandardError; end
               # 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
                 attr_reader :id
                 # Plugin constructor
                 def self.register(id, &block)
                   p = new(id)
                   p.instance_eval(&block)
-                  Plugin.registered_plugins[id] = p
+                  registered_plugins[id] = p
+                end
+                # Returns an array off all registered plugins
+                def self.all
+                  registered_plugins.values.sort
+                end
+                # Finds a plugin by its id
+                def self.find(id)
+                  registered_plugins[id.to_sym] || raise(PluginNotFound)
                 end
                 def initialize(id)
                   @id = id.to_sym
                 end
                 def <=>(plugin)
                   self.id.to_s <=> plugin.id.to_s
                 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, :plugin_example, { :controller => 'example', :action => 'say_hello' }, :caption => 'Sample'
                 #
                 # +name+ parameter can be: :top_menu, :account_menu, :application_menu or :project_menu
                 #
                 def menu(menu, item, url, options={})
                   Redmine::MenuManager.map(menu).push(item, url, options)
                 end
                 alias :add_menu_item :menu
                 # Removes +item+ from the given +menu+.
                 def delete_menu_item(menu, item)
                   Redmine::MenuManager.map(menu).delete(item)
                 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
                 # 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
                 #
                 # A model can provide several activity event types.
                 #
                 # Examples:
                 #   register :news
                 #   register :scrums, :class_name => 'Meeting'
                 #   register :issues, :class_name => ['Issue', 'Journal']
                 #
                 # 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.
                 #
                 # The following call should return all the scrum events visible by current user that occured in the 5 last days:
                 #   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
                 #
                 # Note that :view_scrums permission is required to view these events in the activity view.
                 def activity_provider(*args)
                   Redmine::Activity.register(*args)
                 end
                 # 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
                 # Returns +true+ if the plugin can be configured.
                 def configurable?
                   settings && settings.is_a?(Hash) && !settings[:partial].blank?
                 end
               end
             end

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages