Changes between Version 4 and Version 5 of CookBook/PermissionPolicies

Timestamp:

Mar 9, 2017, 7:28:19 PM (7 years ago)

Author:

Peter Suter

Comment:

Add GrantTicketOwnerPermissionsPolicy example

CookBook/PermissionPolicies

@@ -63 +63 @@
  1. Grant the `TICKET_CHANGE_STATE` permission to your users.
 
+== Grant a permission to the Ticket Owner
+
+This permissions policy can be used to grant permissions to the ticket's owner.
+
+To install and activate the plugin:
+ 1. Create a [TracDev/PluginDevelopment#Singlefileplugins single file plugin] that implements [wiki:TracDev/PluginDevelopment/ExtensionPoints/trac.perm.IPermissionPolicy IPermissionPolicy]:
+{{{#!python
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 Edgewall Software
+# All rights reserved.
+#
+# This software is licensed as described in the file COPYING, which
+# you should have received as part of this distribution. The terms
+# are also available at http://trac.edgewall.org/wiki/TracLicense.
+#
+# This software consists of voluntary contributions made by many
+# individuals. For the exact contribution history, see the revision
+# history and logs, available at http://trac.edgewall.org/log/.
+
+from trac.core import *
+from trac.perm import IPermissionPolicy
+from trac.ticket.model import Ticket
+
+
+class GrantTicketOwnerPermissionsPolicy(Component):
+    """Grants permissions to the ticket owner."""
+
+    implements(IPermissionPolicy)
+
+    allowed_actions = (
+        'TICKET_CHGPROP',
+        'TICKET_EDIT_CC',
+        'TICKET_EDIT_DESCRIPTION',
+        'TICKET_EDIT_COMMENT')
+
+    # IPermissionPolicy methods
+
+    def check_permission(self, action, username, resource, perm):
+        if action in self.allowed_actions \
+                and resource is not None \
+                and resource.realm == 'ticket' \
+                and resource.id is not None:
+            ticket = Ticket(self.env, resource.id)
+            return ticket['owner'] == username
+        return None
+}}}
+ 1. Edit the `permission_policies` option in the [TracIni#trac-section "[trac]"] section of trac.ini, adding the component ''before'' the default [TracPermissions permission] policy:
+ {{{#!ini
+ [trac]
+ permission_policies = GrantTicketOwnerPermissionsPolicy, ...
+}}}
+
+==== Variations
+* Remove permissions from the `allowed_actions` or add others.
+* Change `ticket['owner']` to `ticket['reporter']` to grant the permissions to the Ticket Reporter instead.
+
 ----