Page Rights Viewer Application

Last modified by Admin on 2026/02/26 15:45

cogAllow visualizing actual rights applied on a given wiki page and persistent rights applied on a page and each of its parent pages (tree).
TypeXAR
CategoryApplication
Developed by

Mohamed Boussaa

Active Installs1
Rating
0 Votes
LicenseGNU Lesser General Public License 2.1

Success

Installable with the Extension Manager

Description

The objective of this extension is to ease the readability/comprehension of the rights applied on a given page as it offers a UI that shows the actual rights applied on the page which are implied from the global rights configuration and the rights set on each of the page parents. In addition to this, it will be possible to view all the persistent rights applied on the tree of pages (from wiki level to the current page) on the same UI whereas with the standard UI you need to check the rights of each entity separately.

Basically, the extension will add a menu entry (Page rights viewer) to the page menu (viewers section) and onclick reloads the page with a special sheet to display the rights.

Note that the XWiki Rights API is used to retrieve the rights.

Screenshots

page-rights-viewer-menu.png
Page rights viewer menu entry

actual-rights.png
Actual page rights

detailed-rights.png
Detailed page rights

Macros

Actual Rights Macro

The Actual Rights macro is used to display the actual rights table of a given page or the current page where the macro is called.

Usage

{{actualrights reference="Main.WebHome" /}}
{{actualrights /}}

actual-rights-macro-wysiwyg.png
From WYSIWYG editor

Parameters definition

NameOptionalAllowed valuesDefault valueDescription
referenceyesA document reference The reference of the XWiki page for which to display actual rights. Leave empty to display the actual rights of the current page.

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Versions

Dependencies

Dependencies for this extension (org.xwiki.contrib:application-page-rights-viewer 1.0.4):

Get Connected