Extension:RightFunctions/Doc

RightFunctions is an extension that adds permission-based parser functions. Please note that these extensions may be used to superficially hide information from those with certain rights. Also, all of these functions disable the cache on the page they are used in unless you set $wgRightFunctionsAllowCaching to true. For installation instructions, please view the main extension page.

Usage
As of now, RightFunctions defines nine parser functions, ifright, ifallowed, userrights, usergroup, ifgroup, ifpageright, ifpageallowed, ifprotected, and getrestrictions.

Ifright
Tests whether the current user has the given right, then displays the appropriate text. If the right doesn't exist, it simply returns else. If no right is specified, it returns then. This function ignores per-page restrictions on a user's rights, so use if you need that functionality.

Usage:

Ifallowed
Tests whether the given user has the given right, then displays the appropriate text. If the user viewing this function doesn't have ample permissions to view other users' rights, a warning message will instead be displayed (unless you disable them by setting $wgRightFunctionsDisableWarnings). This function ignores per-page restrictions on a user's rights, so use if you need that functionality.

Usage:

Userrights
Lists all rights in an unordered list either of the current user or of the given user. In order to get the rights of another user, you must have ample permissions (via $wgRightFunctionsOtherUsers), otherwise, it displays a warning message (provided $wgRightFunctionsDisableWarnings isn't enabled) and gives you your own rights when you try to view it (if a user is defined, if not, it triggers on the current user regardless).

Usage:  (for current user) or   (for other users)

Usergroup
Returns the highest user group the user belongs to. The groups are defined in lowest-to-highest ranking in the array $wgRightFunctionsUserGroups. Also, this by default does not restrict you from checking other users, but the functionality can be enabled by setting $wgRightFunctionsRestrictUsergroup to true (the permission is controlled, as always, by $wgRightFunctionsOtherUsers).

Usage:  (for current user) or   (for other users)

Ifgroup
Tests if the given user is in the specified group. Testing other users is restricted by $wgRightFunctionsOtherUsers. If no user is specified, it tests the current user. If no group is specified, it returns else.

Usage:  (for current user) or   (for other users)

Ifpageright
Tests whether the current user has the given right on the given page, then displays the appropriate text. If the right doesn't exist, it simply returns else. If no right is specified, it returns then. This function does not ignore per-page restrictions on a user's rights.

Usage:  for testing other pages or   for testing the current page.

Ifpageallowed
Tests whether the given user has the given right on the given page, then displays the appropriate text (again, testing other users is controlled by $wgRightFunctionsOtherUsers). If no user is specified, it checks the current user. If no page is specified, it checks the current page. If the right doesn't exist, it returns else and if no right is specified, it returns then. This function does not ignore per-page restrictions on a user's rights.

Usage:  for testing other pages or   for testing the current page.

Ifprotected
Tests whether the given page is protected, then displays the appropriate text. If no page is given, it tests the current page. It will return then if the page is either fully-protected, semi-protected, protected because it is included in a cascading-protected page, or if it is namespace-protected. You may control which of these are tested by adding the letters "f", "s", "c", and/or "n" (standing for fully-protected, semi-protected, cascading-protected, and namespace-protected, respectively) to the fourth parameter of the page (by default all 4 are tested).

Usage:  for testing other pages, or   for testing the current page or (for example)   for testing only certain types of protection.

Getrestrictions
Grabs what right is required to carry out the action on the given page. If no page is given, it checks the current page instead. If no right is given, it checks the 'edit' right. If there are no restrictions on that page for the particular right, it returns the empty string (""). If the page has cascading restrictions as well, it returns the highest restriction level for the page (from all cascading sources and the local page itself). If you would like all the restrictions to be listed instead, set the third parameter to "true". If you do, the output format changes a bit to "restrictions (from current page), restrictions (from cascading-protected sources)" if there are restrictions on the current page, or just "restrictions (from cascading-protected sources)" if there aren't.

Usage:  for testing other pages, or   for testing the current page or   for listing all restrictions instead of just the highest one.

Variables
These variables control how the various parser functions work. There are currently 6 variables.

$wgRightFunctionsOtherUsers
Default value: true

Controls what right is required to get information about other users on the wiki. A value of true means that only those with the sysop right (default sysops and bureaucrats) can get such info, a value of false means that anyone with the * right (default everyone, including anons) can get such info, and any other value requires them to have that right.

$wgRightFunctionsUserGroups
Default value: array('*', 'user', 'autoconfirmed', 'sysop', 'bureaucrat')

An array of groups to test for in. They are arranged in order of least to greatest for group testing.

$wgRightFunctionsRestrictUsergroup
Default value: false

If set to true, checking other users via usergroup also requires you to have permissions with $wgRightFunctionsOtherUsers.

$wgRightFunctionsAllowCaching
Default value: false

If set to true, the functions do not disable the parser cache and they do not trigger the recache when getting a user's groups.

$wgRightFunctionsAllowExpensiveQueries
Default value: true

If set to true, using ifpageright and ifpageallowed will check the rights more thoroughly (like through cascading protection), so it will produce more accurate results, but it will me more server-intensive to perform.

$wgRightFunctionsDisableWarnings
Default value: false

If set to true, all warnings are replaced with an empty string.

Changelog

 * version 1.6:getrestrictions now only returns the highest-level restriction by default, a list of all restrictions can be had by setting the third parameter true.
 * version 1.5:major bugfix in getrestrictions, should now work as expected (yay)
 * version 1.4:getrestrictions now checks cascading sources (albeit not very efficiently), now allows user to pick protection types to check for in ifprotected, bugfix in return of getrestrictions.
 * version 1.3:cleaned up code for less redundancy, added $wgRightFunctionsAllowCaching to allow caching, added ifgroup, made usergroup actually work off of real user groups instead of rights that mimicked group names, changed $wgRightFunctionsOtherUsers to test groups instead of rights. $wgRightFunctionsAllowExpensiveQueries is now true by default.
 * version 1.2:added four parser functions ifpageright, ifpageallowed, ifprotected, and getrestrictions. Added in variable for hiding warning messages and a variable for enabling more server-intensive queries for the ifpageright and ifpageallowed functions.
 * version 1.1:added safeguard against those trying to access extension directly, and an additional parser function usergroup.
 * version 1.0:initial release defined three parser functions, ifright, ifallowed, and userrights.

Please note that versions less than 1.2 were not placed on mediawiki.org. If you want the source for a version earlier than 1.2, please leave a message on my talk page.