Fine Grained Permission possible realms and paths format are not documented.

[dpc@…]

I'm trying to configure authz_policy.py (TracFineGrainedPermissions) for things other than Wiki Pages.

I can see that this is possible and working, but I'm waisting my time discovering "paths and realms" for every single thing I want to manage via authz_policy.

All the samples and documentation I've found describe configuration for wiki: realms *only* and while this is probably most common usage I'd like to create a ticket to expand the documentation in this topic.

[Remy Blank]

Some documentation effort about this is certainly welcome, thanks!

[osimons]

The problem is that plugins also provides resource support, and for lookup purposes for users there really should be some code that iterates and presents them. Like we do for config and for macros.

[Christian Boos]

Not for 0.12.1, it seems.

[Ryan J Ollos]

Moving this forward since I don't think it needs to be fixed on 0.12-stable, but please comment if you feel differently.

We may want to consider this within the context of a more extensive rework of the permission system in which IPermissionRequestor may define actions associated with realms: trunk/trac/perm.py@12930:152-154#L117​. Something like,

-        actions = ['WIKI_CREATE', 'WIKI_DELETE', 'WIKI_MODIFY', 'WIKI_RENAME',
-                   'WIKI_VIEW']
-       return actions + [('WIKI_ADMIN', actions)]
+        actions = ['CREATE', 'DELETE', 'MODIFY', 'RENAME', 'VIEW']
+        return {'wiki': actions + [('ADMIN', actions)]}

That's not a fully developed idea though.

[Ryan J Ollos]

Narrowing focus for milestone:1.2. Please move ticket to milestone:1.2 if you intend to fix it.

[anonymous]

there really should be some code that iterates and presents them. Like we do for config and for macros.

trac/wiki/macros.py

@@ -24 +24 @@
 
 from trac.core import *
 from trac.resource import (
-    Resource, ResourceNotFound, get_resource_name, get_resource_summary,
-    get_resource_url
+    Resource, ResourceNotFound, ResourceSystem, get_resource_name,
+    get_resource_summary, get_resource_url
 )
 from trac.util import as_int
 from trac.util.datefmt import format_date, from_utimestamp, user_time
@@ -903 +903 @@
                     for mime_type in sorted(mime_types))))
 
 
+class KnownRealmsMacro(WikiMacroBase):
+    _domain = 'messages'
+    _description = cleandoc_(
+    """List all known realms which can be used with TracFineGrainedPermissions.
+
+    Can be given an optional argument which is interpreted as realm filter.
+    """)
+
+    def expand_macro(self, formatter, name, content):
+        realm_filter = ''
+        args, kw = parse_args(content)
+        if args:
+            realm_filter = args.pop(0).strip().rstrip('*')
+
+        resource_sys = ResourceSystem(self.env)
+        realms = []
+        for realm in resource_sys.get_known_realms():
+          if not realm_filter or realm.startswith(realm_filter):
+            try:
+                summary = get_resource_summary(self.env, Resource(realm))
+            except Exception as e:
+                summary = 'ERROR ' + str(e)
+            realms.append((realm, summary))
+
+        return tag.div(class_='trac-realms')(
+            tag.table(class_='wiki')(
+                tag.thead(tag.tr(
+                    tag.th(_("Realm")),
+                    tag.th(_("Summary")))),
+                tag.tbody(
+                    tag.tr(tag.th(tag.code(realm),
+                                  style="text-align: left"),
+                           tag.td(tag.code(
+                            summary
+                           )))
+                    for realm, summary in sorted(realms))))
+
+
 class TracGuideTocMacro(WikiMacroBase):
     _domain = 'messages'
     _description = cleandoc_(

[[KnownRealms()]] shows:

Realm	Summary
attachment	Unparented attachment None
changeset	Changeset None
milestone	Milestone None
repository	Default repository
source	ERROR 'NoneType' object has no attribute 'get_node'
ticket	ERROR coercing to Unicode: need string or buffer, NoneType found
wiki

[Ryan J Ollos]

The realm summary isn't useful, but a comma-separated list might be enough.

[Ryan J Ollos]

Milestone renamed