Web Permissions Plugin

This plugin provides a centralised interface to TWiki permissions that are applied on a web level, or topic level.

Web permissions are presented as a matrix that has columns of webs and rows of users. For each web, you can control which users can view or change that web. All user webs, every registered user (except admin users), and every group (except admin groups) are shown in the matrix.

To interactivly edit topic permissions, it adds an "Edit topic ACLs" option to the "More Actions" page.

Web Permissions

Viewing Editing
VIEW = CHANGE =
AlbumsSinglesReviewsStatistics
AnnieLennox
BillyBragg
ColinTowns
DavidSoul
EaglesGroup
VIEW = CHANGE =
AlbumsSinglesReviewsStatistics
AnnieLennox
BillyBragg
ColinTowns
DavidSoul
EaglesGroup


This control model is very useful in cases such as a web per project environment. In this case you will probably want to give team members change access to the specific projects they are working on. The plugin gives you a simple, one page interface, for handling these permissions.

The plugin tries very hard to keep the permissions specification you started with, though it does move them to METADATA.

Topic Permissions

All Users and Groups

Editors

Viewers

       

THIS PLUGIN REQUIRES TWiki-4.0.0 or later

Syntax Rules

The permissions matrix can be viewed (and edited) by entering %WEBPERMISSIONS% anywhere in a topic. You have to have admin rights (be a member of TWikiAdminGroup) to view/edit the matrix.

The WEBPERMISSIONS TWiki variable accepts the following parameters:

  • webs - a comma-separated list of webs to show. Default is to show all webs.
  • repeatheads - if set to a number, headings will be repeated every this number of rows. This is very useful when you have a lot of users and groups.

If you have a lot of webs, use the following form to select the subset of webs you want to display. If you have admin rights, and the plugin is installed, you will see the matrix below the form:

Select the webs you want to change permissions for from the list below. Ctrl+click and Shift+click work as normal.

VIEW CHANGE
TWiki
AbelGomez
AdrianFernandez
AitorBediaga
AmbrosioToval
AndresIborra
ArturBoronat
BarbaraAlvarez
BeatrizMora
BegonaMoros
CarlosBlanco
TWiki
CarlosECuesta
CarlosSolis
CarmenPenades
CesarGonzalez
CoralCalero
CristinaVicente
CristobalCosta
DanielMellado
DiegoAlonso
ElenaNavarro
TWiki
ElviraRolon
EmanuelMontero
EmilioInsfran
FedericoBotella
FelixGarcia
FernandoLosilla
FernandoMolina
FranciscaRosique
FranciscoLucas
FranciscoOrtiz
TWiki
FranciscoPino
FranciscoRuiz
HansDieterEhrich
IgnacioGarcia
IsidroRamos
IsmaelCaballero
JenniferPerez
JoaquinLasheras
JoaquinNicolas
JoseAntonioCruz
TWiki
JoseHilarioCanos
JuanAngelPastor
JuanAntonioLopez
MAngelesMoraga
MacarioPolo
ManuelAngelSerrano
ManuelJimenez
ManuelLlavador
MarcelaGenero
MariaEugeniaCabello
TWiki
MarioPiattini
MiguelAngelMartinez
NobodyGroup
NourAli
PatricioLetelier
PedroAlcover
PedroSanchez
PepeCarsi
RogelioLimon
SilviaAbrahao
TWiki
TWikiAdminGroup
TWikiContributor
TWikiGuest
TWikiRegistrationAgent
TomasMartinez
UnknownUser
XabierLarrucea

Plugin Settings

  • One line description, is shown in the TextFormattingRules topic:
    • Set SHORTDESCRIPTION = View and edit web permissions

By default, the plugin only supports VIEW and CHANGE permissions on webs. You can change the set of access modes handled by the plugin by defining a configuration variable (in LocalSite.cfg) to be a comma-separated list of access modes. For example,

$TWiki::cfg{Plugins}{WebPermissionsPlugin}{modes} = 'VIEW,CHANGE,RENAME';
See TWikiAccessControls for more information on what access modes can be used to control.

Plugin Installation Instructions

Note: These instructions are for the TWiki maintainer. No changes to your browser are required. This plugin makes extensive use of new features added to TWiki in the Feb 2006 release. Earlier versions lack all the features described here. Make sure you install using the zip appropriate to your TWiki installation. For best overall performance, please upgrade your TWiki to the latest released version.

  • Download the archive (zip or tgz) from the Plugin web (see below). Contents:
    File: Description:
    lib/TWiki/Plugins/WebPermissionsPlugin.pm  
    data/TWiki/WebPermissionsPlugin.txt  
    pub/TWiki/WebPermissionsPlugin/CHANGE.gif  
    pub/TWiki/WebPermissionsPlugin/VIEW.gif  
    pub/TWiki/WebPermissionsPlugin/uparrow.png  
    pub/TWiki/WebPermissionsPlugin/downarrow.png  
    pub/TWiki/WebPermissionsPlugin/leftarrow.png  
    pub/TWiki/WebPermissionsPlugin/rightarrow.png  
    pub/TWiki/WebPermissionsPlugin/WebPermissionsPlugin.js  
    templates/webpermissionsplugin.topichtml.tmpl  
    templates/webpermissionsplugin.topicjavascript.tmpl  
    templates/oopsmore.webpermissions.tmpl  
    templates/oopsmoretopicacls.tmpl  
    templates/topicacls.tmpl  

  • Unpack the archive in your twiki installation directory.
  • perl WebPermissionsPlugin_installer.pl to automatically check and install other TWiki modules that this module depends on. This script also includes an uninstaller should you ever wish to remove the plugin from your installation.
  • Alternatively, manually make sure the dependencies listed in the table below are resolved.
NameVersionDescription
TWiki::Plugins>=1.1TWiki-4
TWiki::Contrib::FuncUsersContrib>=1.0Required, available from TWiki.org
  • Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.
  • to enable the TOPIC ACLs user interface, add webpermissions to the front of the SKIN setting (eg Set SKIN=webpermissions,pattern)

Plugin Info

Plugin Author: TWiki:Main.CrawfordCurrie http://c-dot.co.uk & TWiki:Main.SvenDowideit http://www.WikiRing.com
Copyright: © 2006, Evolved Media Network, Spanlink Communications and WikiRing?
License: GPL (GNU General Public License)
Plugin Version: 11083
Change History:  
July 2006 add Topic ACLs userinterface via More topic actions - SvenDowideit@WikiRing.com
10216 Item2291 Added repeatheads and webs parameters
9048 Item1766 corrected problems with passing incorrect parameters to setACLs and not interpreting values from the form correctly.
8877 Item1701 first release
Dependencies:
NameVersionDescription
TWiki::Plugins>=1.1TWiki-4
TWiki::Contrib::FuncUsersContrib>=1.0Required, available from TWiki.org
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/WebPermissionsPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/WebPermissionsPluginDev
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/WebPermissionsPluginAppraisal

This plugin was developed on behalf of Evolved Media Network

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

-- TWikiContributor - 01 Feb 2006

toggleopenShow attachmentstogglecloseHide attachments
Topic attachments
I Attachment Action Size Date Who Comment
pngpng leftarrow.png manage 0.2 K 18 May 2007 - 17:47 TWikiAdminGroup Saved by install script
gifgif VIEW.gif manage 0.5 K 18 May 2007 - 17:47 TWikiAdminGroup Saved by install script
pngpng downarrow.png manage 0.2 K 18 May 2007 - 17:47 TWikiAdminGroup Saved by install script
gifgif CHANGE.gif manage 0.5 K 18 May 2007 - 17:47 TWikiAdminGroup Saved by install script
jsjs WebPermissionsPlugin.js manage 3.5 K 18 May 2007 - 17:47 TWikiAdminGroup Saved by install script
pngpng rightarrow.png manage 0.2 K 18 May 2007 - 17:47 TWikiAdminGroup Saved by install script
pngpng uparrow.png manage 0.2 K 18 May 2007 - 17:47 TWikiAdminGroup Saved by install script
This topic: TWiki > WebPermissionsPlugin
History: r2 - 18 May 2007 - 17:47:38 - TWikiAdminGroup
 
Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Proyecto META? Send feedback