Basic plugin support.

git-svn-id: http://redmine.rubyforge.org/svn/trunk@752 e93f8b46-1217-0410-a6f0-8f06a7374b81

app/controllers/admin_controller.rb

@@ -75,5 +75,6 @@ class AdminController < ApplicationController
       :file_repository_writable => File.writable?(Attachment.storage_path),
       :rmagick_available => Object.const_defined?(:Magick)
     }
+    @plugins = Redmine::Plugin.registered_plugins
   end  
 end

app/controllers/settings_controller.rb

@@ -30,4 +30,16 @@ class SettingsController < ApplicationController
       redirect_to :action => 'edit' and return
     end
   end
+  
+  def plugin
+    plugin_id = params[:id].to_sym
+    @plugin = Redmine::Plugin.registered_plugins[plugin_id]
+    if request.post?
+      Setting["plugin_#{plugin_id}"] = params[:settings]
+      flash[:notice] = l(:notice_successful_update)
+      redirect_to :action => 'plugin', :id => params[:id]
+    end
+    @partial = "../../vendor/plugins/#{plugin_id}/app/views/" + @plugin.settings[:partial]
+    @settings = Setting["plugin_#{plugin_id}"]
+  end
 end

app/models/setting.rb

@@ -19,6 +19,10 @@ class Setting < ActiveRecord::Base
 
   cattr_accessor :available_settings
   @@available_settings = YAML::load(File.open("#{RAILS_ROOT}/config/settings.yml"))
+  Redmine::Plugin.registered_plugins.each do |id, plugin|
+    next unless plugin.settings
+    @@available_settings["plugin_#{id}"] = {'default' => plugin.settings[:default], 'serialized' => true}    
+  end
   
   validates_uniqueness_of :name
   validates_inclusion_of :name, :in => @@available_settings.keys

app/views/admin/info.rhtml

@@ -7,3 +7,19 @@
 <tr class="even"><td>File repository writable</td><td><%= image_tag (@flags[:file_repository_writable] ? 'true.png' : 'false.png'), :style => "vertical-align:bottom;" %></td></tr>
 <tr class="odd"><td>RMagick available</td><td><%= image_tag (@flags[:rmagick_available] ? 'true.png' : 'false.png'), :style => "vertical-align:bottom;" %></td></tr>
 </table>
+
+<% if @plugins.any? %>
+&nbsp;
+<h3 class="icon22 icon22-plugin">Plugins</h3>
+<table class="list">
+    <% @plugins.keys.sort.each do |plugin| %>
+        <tr class="<%= cycle('odd', 'even') %>">
+        <td><%=h @plugins[plugin].name %></td>
+        <td><%=h @plugins[plugin].description %></td>
+        <td><%=h @plugins[plugin].author %></td>
+        <td><%=h @plugins[plugin].version %></td>
+        <td><%= link_to('Configure', :controller => 'settings', :action => 'plugin', :id => plugin.to_s) if @plugins[plugin].configurable? %></td>
+        </tr>
+    <% end %>
+</table>
+<% end %>

app/views/settings/plugin.rhtml

@@ -0,0 +1,8 @@
+<h2><%= l(:label_settings) %>: <%=h @plugin.name %></h2>
+
+<% form_tag({:action => 'plugin'}) do %>
+<div class="box tabular">
+<%= render :partial => @partial, :locals => {:settings => @settings}%>
+</div>
+<%= submit_tag l(:button_apply) %>
+<% end %>

config/environment.rb

@@ -58,6 +58,10 @@ Rails::Initializer.run do |config|
 	# ActionMailer::Base.deliveries array.
 	#config.action_mailer.delivery_method = :test
 	config.action_mailer.delivery_method = :smtp  
+
+  # Uncomment this line if the engines plugin is installed.
+  # This will ensure that engines is loaded first.
+  # config.plugins = ["engines", "*"]
 end
 
 ActiveRecord::Errors.default_error_messages = {

lib/redmine.rb

@@ -3,6 +3,7 @@ require 'redmine/menu_manager'
 require 'redmine/mime_type'
 require 'redmine/acts_as_watchable/init'
 require 'redmine/acts_as_event/init'
+require 'redmine/plugin'
 
 begin
   require_library_or_gem 'RMagick' unless Object.const_defined?(:Magick)

lib/redmine/plugin.rb

@@ -0,0 +1,124 @@
+# 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

lib/tasks/migrate_plugins.rake

@@ -0,0 +1,15 @@
+namespace :db do
+  desc 'Migrates installed plugins.'
+  task :migrate_plugins => :environment do
+    if Rails.respond_to?('plugins')
+      Rails.plugins.each do |plugin|
+        next unless plugin.respond_to?('migrate')
+        puts "Migrating #{plugin.name}..."
+        plugin.migrate
+      end
+    else
+      puts "Undefined method plugins for Rails!"
+      puts "Make sure engines plugin is installed."
+    end
+  end
+end

public/stylesheets/application.css

@@ -446,3 +446,4 @@ vertical-align: middle;
 .icon22-comment { background-image: url(../images/22x22/comment.png); }
 .icon22-package { background-image: url(../images/22x22/package.png); }
 .icon22-settings { background-image: url(../images/22x22/settings.png); }
+.icon22-plugin { background-image: url(../images/22x22/plugin.png); }

vendor/plugins/gloc-1.1.0/lib/gloc-internal.rb

@@ -73,7 +73,7 @@ module GLoc
     end
     
     def _get_lang_file_list(dir) #:nodoc:
-      dir= File.join(RAILS_ROOT,'lang') if dir.nil?
+      dir= File.join(RAILS_ROOT,'{.,vendor/plugins/*}','lang') if dir.nil?
       Dir[File.join(dir,'*.{yaml,yml}')]
     end