openproject-global_roles 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzY4ODY4MzJmNGE5MjUxMzhlOTc2NDkzMzMxMmZkZWRkNGFmZDBhZQ==
+  data.tar.gz: !binary |-
+    OWViNzBhZmU0NzFhZGIyOTllZTlhY2QwZjUxMWQ3MjU0YjUxYzQyMg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YTYzMzhjYzBiZjI0ZTdkMjg5YWU4NGEzOTg5MjQzYTE3M2JmMWNiMzA5OWNh
+    OTBkOTMwOTgyMzJmNzE0YWQwNTY0NmM4Y2NiZmZhMGU4ZmVkNGU2OTcwMTY4
+    NjUyZDRiODZmZGEyMjRmNzg2ZjFiMjA2MjFkMzMyNzI1NDM4ODI=
+  data.tar.gz: !binary |-
+    MDIwNDQ3NDRiMjBmNWM2MzU0NzUwOGNkNzQzYWY2NTZkZTJhM2U5YzFlYWRj
+    NTk4NmU3YjVhOTZjN2ZiODBhMTMwN2ViNGM3OGExYzkxNjJiYzk3NzgyZTEw
+    MGQ3NGQ1ZWI3MmNlMmI5NmU4NjM5OWZlN2FjMTc0NGVmOTJlMWM=

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+## 1.0.0
+
+* `#1643` Public Release of Global Roles Plugin
+
+## 1.0.0.pre4
+
+* adapted cukes to changed steps from core
+
+## 1.0.0.pre3
+
+* `#1461` Fix for: Integration Activity Plugin
+
+## 1.0.0.pre2
+
+* '#1319' Fix for failures on CI
+
+## 1.0.0.pre1
+
+* First rails 3 version
+* `#1284` Created initial changelog

data/README.md

@@ -0,0 +1,89 @@
+OpenProject Global Roles Plugin
+==========================
+
+
+This plugin adds global roles to [OpenProject](https://www.openproject.org).
+A user can have a global role allowing to perform actions outside of the scope
+of a specific project normally only allowed for administrators.
+By assigning the permission to create projects to a global role,
+non-administrators can create top-level projects.
+
+To create a global role, go to the Administration view, select "Roles and permissions"
+and click on "New Role". Afterwards, select the checkbox "Global Role" and choose the
+permissions for this role. From the plugin, only "Create project" is available.
+However, there are other plugins adding more permissions to be assigned to global
+roles.
+
+The created global roles can be assigned to individual users in the added "Global Roles"
+tab of the user settings.
+
+Requirements
+------------
+
+The Global Roles plugin currently requires the [OpenProject Core](https://github.com/opf/openproject/) in
+version 3.0.0pre13 or newer.
+
+
+Installation
+------------
+
+Please follow the default [plugin installation instructions for
+OpenProject](https://www.openproject.org/projects/openproject/wiki/Installation#222-Add-plugins),
+adding the following line to the Gemfile.plugins:
+
+`gem "openproject-global_roles"`
+
+Afterwards, run:
+
+`bundle install`
+
+This plugin contains migrations. To migrate the database, run:
+
+`rake openproject_global_roles:install:migrations`
+
+`rake db:migrate`
+
+Deinstallation
+--------------
+
+Currently, there complete automatic uninstall is not supported.
+Before the plugin can be removed, all global roles have to be deleted.
+Afterwards, remove the line
+
+`gem "openproject-global_roles"`
+
+from the file `Gemfile.plugins` and run:
+
+`bundle install`
+
+Please not that this changes by the plugin in the database. Currently, we do not
+support full uninstall of the plugin.
+
+Bug Reporting
+-------------
+
+If you find any bugs, you can create a bug ticket at
+
+https://www.openproject.org/projects/plugin-global-roles
+
+Development
+-----------
+
+To contribute, you can create pull request on the official repository at
+
+`https://github.com/finnlabs/openproject-global_roles`
+
+Credits
+-------
+
+Special thanks go to
+
+* Deutsche Telekom AG (opensource@telekom.de) for project sponsorship
+
+License
+-------
+
+(c) 2010 - 2013 - Finn GmbH
+
+This plugin is licensed under the GNU GPL v3. See doc/COPYRIGHT.rdoc and
+doc/GPL.txt for details.

data/app/assets/javascripts/global_roles/global_roles.js

@@ -0,0 +1,91 @@
+//-- copyright
+// OpenProject is a project management system.
+//
+// Copyright (C) 2010-2013 the OpenProject Team
+//
+// This program is free software; you can redistribute it and/or
+// modify it under the terms of the GNU General Public License version 3.
+//
+// See doc/COPYRIGHT.rdoc for more details.
+//++
+
+//= require global_roles/principal_roles
+
+var global_roles = {
+	init: function(){
+		global_roles.toggle_forms_on_click();
+		global_roles.activation_and_visibility_based_on_checked($('global_role'));
+	},
+
+	toggle_forms_on_click: function(){
+		$('global_role').observe("click", global_roles.toggle_forms);
+	},
+
+	toggle_forms: function(event){
+		global_roles.activation_and_visibility_based_on_checked(this)
+	},
+
+	activation_and_visibility_based_on_checked: function(element){
+		if($(element).checked){
+			global_roles.show_global_forms();
+			global_roles.hide_member_forms();
+			global_roles.enable_global_forms();
+			global_roles.disable_member_forms();
+		}
+		else{
+			global_roles.show_member_forms();
+			global_roles.hide_global_forms();
+			global_roles.disable_global_forms();
+			global_roles.enable_member_forms();
+		}
+	},
+
+	show_global_forms: function(){
+		$('global_attributes').show();
+		$('global_permissions').show();
+	},
+
+	show_member_forms: function(){
+		$('member_attributes').show();
+		$('member_permissions').show();
+	},
+
+	hide_global_forms: function(){
+		$('global_attributes').hide();
+		$('global_permissions').hide();
+	},
+
+	hide_member_forms: function(){
+		$('member_attributes').hide();
+		$('member_permissions').hide();
+	},
+
+	enable_global_forms: function(){
+		$$('#global_attributes input, #global_attributes input').each(global_roles.enable_element);
+		$$('#global_permissions input').each(global_roles.enable_element);
+	},
+
+	enable_member_forms: function(){
+	 	$$('#member_attributes input, #member_attributes input').each(global_roles.enable_element);
+	 	$$('#member_permissions input').each(global_roles.enable_element);
+	},
+
+	enable_element: function(element){
+		element.enable();
+	},
+
+	disable_global_forms: function(){
+		$$('#global_attributes input, #global_attributes input').each(global_roles.disable_element);
+		$$('#global_permissions input').each(global_roles.disable_element);;
+	},
+
+	disable_member_forms: function(){
+		$$('#member_attributes input, #member_attributes input').each(global_roles.disable_element);;
+		$$('#member_permissions input').each(global_roles.disable_element);;
+	},
+
+	disable_element: function(element){
+		element.disable();
+	}
+};
+document.observe("dom:loaded", global_roles.init);

data/app/assets/javascripts/global_roles/principal_roles.js

@@ -0,0 +1,51 @@
+//-- copyright
+// OpenProject is a project management system.
+//
+// Copyright (C) 2010-2013 the OpenProject Team
+//
+// This program is free software; you can redistribute it and/or
+// modify it under the terms of the GNU General Public License version 3.
+//
+// See doc/COPYRIGHT.rdoc for more details.
+//++
+
+var principal_roles = {
+	init: function(){
+		principal_roles.set_table_visibility();
+		principal_roles.set_available_roles_visibility();
+	},
+
+	set_table_visibility: function(){
+		if ($$('#table_principal_roles_body tr').length > 0){
+			$('table_principal_roles').show();
+			$('no_data').hide();
+		}
+		else
+		{
+			$('table_principal_roles').hide();
+			$('no_data').show();
+		}
+	},
+
+	set_available_roles_visibility: function(){
+		if ($$('.principal_role_option').length > 0){
+			$('additional_principal_roles').show();
+			$('no_additional_principal_roles').hide();
+		}
+		else
+		{
+			$('additional_principal_roles').hide();
+			$('no_additional_principal_roles').show();
+		}
+	},
+
+	role_already_assigned: function(){
+		return ($$('.assigned_global_role_' + element.down('input').value).length > 0)
+	}
+};
+
+document.observe('dom:loaded', principal_roles.init);
+
+Ajax.Responders.register({
+  onComplete: principal_roles.init
+});

data/app/assets/stylesheets/global_roles/global_roles.css

@@ -0,0 +1,18 @@
+//-- copyright
+// OpenProject is a project management system.
+//
+// Copyright (C) 2010-2013 the OpenProject Team
+//
+// This program is free software; you can redistribute it and/or
+// modify it under the terms of the GNU General Public License version 3.
+//
+// See doc/COPYRIGHT.rdoc for more details.
+//++
+
+span.label {
+float:left;
+margin-left: -180px;
+text-align:right;
+font-weight:bold;
+width: 175px;
+}

data/app/controllers/principal_roles_controller.rb

@@ -0,0 +1,139 @@
+#-- copyright
+# OpenProject is a project management system.
+#
+# Copyright (C) 2010-2013 the OpenProject Team
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# See doc/COPYRIGHT.rdoc for more details.
+#++
+
+class PrincipalRolesController < ApplicationController
+
+  def create
+    @principal_roles = new_principal_roles_from_params
+    @global_roles = GlobalRole.all
+    @user = Principal.find(params[:principal_role][:principal_id])
+
+    call_hook :principal_roles_controller_create_before_save,
+              {:principal_roles => @principal_roles}
+
+    @principal_roles.each{ |pr| pr.save } unless performed?
+
+    call_hook :principal_roles_controller_create_before_respond,
+              {:principal_roles => @principal_roles}
+
+    respond_to_create @principal_roles, @user, @global_roles unless performed?
+  end
+
+  def update
+    @principal_role = PrincipalRole.find(params[:principal_role][:id])
+
+    call_hook :principal_roles_controller_update_before_save,
+              {:principal_role => @principal_role}
+
+    @principal_role.update_attributes(params[:principal_role]) unless performed?
+
+    call_hook :principal_roles_controller_update_before_respond,
+              {:principal_role => @principal_role}
+
+    respond_to_update @principal_role unless performed?
+  end
+
+  def destroy
+    @principal_role = PrincipalRole.find(params[:id])
+    @user = Principal.find(@principal_role.principal_id)
+    @global_roles = GlobalRole.all
+
+    call_hook :principal_roles_controller_destroy_before_destroy,
+              {:principal_role => @principal_role}
+
+    @principal_role.destroy unless performed?
+
+    call_hook :principal_roles_controller_destroy_before_respond,
+              {:principal_role => @principal_role}
+
+    respond_to_destroy @principal_role, @user, @global_roles unless performed?
+  end
+
+  private
+
+  def new_principal_roles_from_params
+    pr_params = params[:principal_role].dup
+    role_ids = pr_params[:role_id] ? [pr_params.delete(:role_id)] : pr_params.delete(:role_ids)
+    principal_id = pr_params.delete(:principal_id)
+
+    roles = Role.find role_ids
+
+    principal_roles = []
+    role_ids.map(&:to_i).each do |role_id|
+      role = PrincipalRole.new(pr_params)
+      role.principal_id = principal_id
+      role.role = roles.detect {|r| r.id == role_id}
+      principal_roles << role
+    end
+    principal_roles
+  end
+
+  def respond_to_create principal_roles, user, global_roles
+    respond_to do |format|
+      format.js do
+        render(:update) do |page|
+          if principal_roles.all?{|r| r.valid?}
+            principal_roles.each do |role|
+              page.insert_html :top, 'table_principal_roles_body',
+                               :partial => "principal_roles/show_table_row",
+                               :locals => {:principal_role => role}
+
+              call_hook :principal_roles_controller_create_respond_js_role,
+                        {:page => page, :principal_role => role}
+            end
+
+            page.replace "available_principal_roles",
+                         :partial => "users/available_global_roles",
+                         :locals => {:global_roles => global_roles,
+                                     :user => user}
+          else
+            page.insert_html :top, "tab-content-global_roles", :partial => 'errors'
+          end
+        end
+      end
+    end
+  end
+
+  def respond_to_update role
+    respond_to do |format|
+      format.js do
+        render(:update) do |page|
+          if role.valid?
+            page.replace "principal_role-#{role.id}",
+                          :partial => "principal_roles/show_table_row",
+                          :locals => {:principal_role => role}
+          else
+            page.insert_html :top, "tab-content-global_roles", :partial => 'errors'
+          end
+
+          call_hook :principal_roles_controller_update_respond_js_role,
+                    {:page => page, :principal_role => role}
+        end
+      end
+    end
+  end
+
+  def respond_to_destroy principal_role, user, global_roles
+    respond_to do |format|
+      format.js do
+        render(:update) do |page|
+          page.remove "principal_role-#{principal_role.id}"
+          page.replace "available_principal_roles",
+                        :partial => "users/available_global_roles",
+                        :locals => {:user => user, :global_roles => global_roles}
+
+          call_hook :principal_roles_controller_update_respond_js_role,
+                        {:page => page, :principal_role => principal_role}
+        end
+      end
+    end
+  end
+end

data/app/models/global_role.rb

@@ -0,0 +1,46 @@
+#-- copyright
+# OpenProject is a project management system.
+#
+# Copyright (C) 2010-2013 the OpenProject Team
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# See doc/COPYRIGHT.rdoc for more details.
+#++
+
+class GlobalRole < Role
+  has_many :principal_roles, :foreign_key => :role_id, :dependent => :destroy
+  has_many :principals, :through => :principal_roles
+
+  def initialize(*args)
+    super
+    self.assignable = false
+  end
+
+  def permissions=(perms)
+    perms = perms.collect {|p| p.to_sym unless p.blank? }.compact.uniq if perms
+    write_attribute(:permissions, perms)
+  end
+
+  def setable_permissions
+    Redmine::AccessControl.global_permissions
+  end
+
+  def self.setable_permissions
+    Redmine::AccessControl.global_permissions
+  end
+
+  def to_s
+    name
+  end
+
+  def assignable=(value)
+    raise ArgumentError if value == true
+    super
+  end
+
+  def assignable_to?(user)
+    true
+  end
+end