2 rcs_id('$Id: WikiAdminSetAcl.php,v 1.21 2004-11-23 15:17:20 rurban Exp $');
4 Copyright 2004 $ThePhpWikiProgrammingTeam
6 This file is part of PhpWiki.
8 PhpWiki is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 PhpWiki is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with PhpWiki; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 * Set individual PagePermissions
26 * Usage: <?plugin WikiAdminSetAcl ?> or called via WikiAdminSelect
27 * Author: Reini Urban <rurban@x-ray.at>
30 * Requires PHP 4.2 so far.
32 require_once('lib/PageList.php');
33 require_once('lib/plugin/WikiAdminSelect.php');
35 class WikiPlugin_WikiAdminSetAcl
36 extends WikiPlugin_WikiAdminSelect
39 return _("WikiAdminSetAcl");
42 function getDescription() {
43 return _("Set individual page permissions.");
46 function getVersion() {
47 return preg_replace("/[Revision: $]/", '',
48 "\$Revision: 1.21 $");
51 function getDefaultArguments() {
54 PageList::supportedArgs(),
56 'p' => "[]", // list of pages
57 's' => false, /* select by pagename */
58 /* Columns to include in listing */
59 'info' => 'pagename,perm,mtime,owner,author',
63 function setaclPages(&$request, $pages, $acl) {
66 $dbi =& $request->_dbi;
67 // check new_group and new_perm
68 if (isset($acl['_add_group'])) {
69 //add groups with perm
70 foreach ($acl['_add_group'] as $access => $dummy) {
71 $group = $acl['_new_group'][$access];
72 $acl[$access][$group] = isset($acl['_new_perm'][$access]) ? 1 : 0;
74 unset($acl['_add_group']);
76 unset($acl['_new_group']); unset($acl['_new_perm']);
77 if (isset($acl['_del_group'])) {
78 //del groups with perm
79 foreach ($acl['_del_group'] as $access => $del) {
80 while (list($group,$dummy) = each($del))
81 unset($acl[$access][$group]);
83 unset($acl['_del_group']);
85 if ($perm = new PagePermission($acl)) {
87 foreach ($pages as $pagename) {
88 // check if unchanged? we need a deep array_equal
89 $page = $dbi->getPage($pagename);
90 $oldperm = getPagePermissions($page);
93 if ($oldperm and $perm->equal($oldperm->perm)) // (serialize($oldperm->perm) == serialize($perm->perm))
94 $ul->pushContent(HTML::li(fmt("ACL not changed for page '%s'.",$pagename)));
95 elseif (mayAccessPage('change', $pagename)) {
96 setPagePermissions ($page, $perm);
97 $ul->pushContent(HTML::li(fmt("ACL changed for page '%s'.",$pagename)));
100 $ul->pushContent(HTML::li(fmt("Access denied to change page '%s'.",$pagename)));
104 $ul->pushContent(HTML::li(fmt("Invalid ACL")));
109 HTML::p(fmt("%s pages have been changed.",$count)));
112 HTML::p(fmt("No pages changed.")));
116 function run($dbi, $argstr, &$request, $basepage) {
118 // return $this->disabled("WikiAdminSetAcl not yet enabled. Set DEBUG to try it.");
119 if ($request->getArg('action') != 'browse')
120 if ($request->getArg('action') != _("PhpWikiAdministration/SetAcl"))
121 return $this->disabled("(action != 'browse')");
123 $args = $this->getArgs($argstr, $request);
124 $this->_args = $args;
125 $this->preSelectS($args, $request);
127 $p = $request->getArg('p');
128 $post_args = $request->getArg('admin_setacl');
129 $next_action = 'select';
131 if ($p && !$request->isPost())
133 elseif ($this->_list)
134 $pages = $this->_list;
136 if ($p && $request->isPost() &&
137 !empty($post_args['acl']) && empty($post_args['cancel'])) {
138 // without individual PagePermissions:
139 if (!ENABLE_PAGEPERM and !$request->_user->isAdmin()) {
140 $request->_notAuthorized(WIKIAUTH_ADMIN);
141 $this->disabled("! user->isAdmin");
143 if ($post_args['action'] == 'verify') {
145 $header->pushContent(
146 $this->setaclPages($request, array_keys($p),
147 $request->getArg('acl')));
149 if ($post_args['action'] == 'select') {
150 if (!empty($post_args['acl']))
151 $next_action = 'verify';
152 foreach ($p as $name => $c) {
157 if ($next_action == 'select' and empty($pages)) {
158 // List all pages to select from.
159 $pages = $this->collectPages($pages, $dbi, $args['sortby'], $args['limit'], $args['exclude']);
161 if ($next_action == 'verify') {
162 $args['info'] = "checkbox,pagename,perm,mtime,owner,author";
164 $pagelist = new PageList_Selectable($args['info'],
166 array('types' => array(
168 => new _PageList_Column_perm('perm', _("Permission")),
170 => new _PageList_Column_acl('acl', _("ACL")))));
172 $pagelist->addPageList($pages);
173 if ($next_action == 'verify') {
174 $button_label = _("Yes");
175 $header = $this->setaclForm($header, $post_args, $pages);
176 $header->pushContent(
177 HTML::p(HTML::strong(
178 _("Are you sure you want to permanently change access to the selected files?"))));
181 $button_label = _("SetAcl");
182 $header = $this->setaclForm($header, $post_args, $pages);
183 $header->pushContent(HTML::p(_("Select the pages to change:")));
186 $buttons = HTML::p(Button('submit:admin_setacl[acl]', $button_label, 'wikiadmin'),
187 Button('submit:admin_setacl[cancel]', _("Cancel"), 'button'));
189 return HTML::form(array('action' => $request->getPostURL(),
192 $pagelist->getContent(),
193 HiddenInputs($request->getArgs(),
195 array('admin_setacl')),
196 HiddenInputs(array('admin_setacl[action]' => $next_action)),
199 : HiddenInputs(array('require_authority_for_post' => WIKIAUTH_ADMIN)),
203 function setaclForm(&$header, $post_args, $pagehash) {
204 $acl = $post_args['acl'];
206 //FIXME: find intersection of all pages perms, not just from the last pagename
208 foreach ($pagehash as $name => $checked) {
209 if ($checked) $pages[] = $name;
211 $perm_tree = pagePermissions($name);
212 $table = pagePermissionsAclFormat($perm_tree, !empty($pages));
213 $header->pushContent(HTML::strong(_("Selected Pages: ")), HTML::tt(join(', ',$pages)), HTML::br());
214 $first_page = $GLOBALS['request']->_dbi->getPage($name);
215 $owner = $first_page->getOwner();
216 list($type, $perm) = pagePermissionsAcl($perm_tree[0], $perm_tree);
217 //if (DEBUG) $header->pushContent(HTML::pre("Permission tree for $name:\n",print_r($perm_tree,true)));
218 if ($type == 'inherited')
219 $type = sprintf(_("page permission inherited from %s"), $perm_tree[1][0]);
220 elseif ($type == 'page')
221 $type = _("invidual page permission");
222 elseif ($type == 'default')
223 $type = _("default page permission");
224 $header->pushContent(HTML::strong(_("Type: ")), HTML::tt($type),HTML::br());
225 $header->pushContent(HTML::strong(_("getfacl: ")), pagePermissionsSimpleFormat($perm_tree, $owner),HTML::br());
226 $header->pushContent(HTML::strong(_("ACL: ")), HTML::tt($perm->asAclLines()),HTML::br());
228 $header->pushContent(HTML::p(HTML::strong(_("Description: ")),
229 _("Selected Grant checkboxes allow access, unselected checkboxes deny access."),
230 _("To ignore delete the line."),
231 _("To add check 'Add' near the dropdown list.")
233 $header->pushContent(HTML::blockquote($table));
235 // display array of checkboxes for existing perms
236 // and a dropdown for user/group to add perms.
237 // disabled if inherited,
238 // checkbox to disable inheritance,
239 // another checkbox to progate new permissions to all childs (if there exist some)
241 // warn if more pages are selected and they have different perms
242 //$header->pushContent(HTML::input(array('name' => 'admin_setacl[acl]',
243 // 'value' => $post_args['acl'])));
244 $header->pushContent(HTML::br());
245 if (!empty($pages) and DEBUG) {
246 $checkbox = HTML::input(array('type' => 'checkbox',
247 'name' => 'admin_setacl[updatechildren]',
249 if (!empty($post_args['updatechildren'])) $checkbox->setAttr('checked','checked');
250 $header->pushContent($checkbox,
251 _("Propagate new permissions to all subpages?"),
252 HTML::raw(" "),
253 HTML::em(_("(disable individual page permissions, enable inheritance)?")),
254 HTML::br(),HTML::em(_("(Currently not working)"))
257 $header->pushContent(HTML::hr(),HTML::p());
262 class _PageList_Column_acl extends _PageList_Column {
263 function _getValue ($page_handle, &$revision_handle) {
264 $perm_tree = pagePermissions($page_handle->_pagename);
265 return pagePermissionsAclFormat($perm_tree);
269 class _PageList_Column_perm extends _PageList_Column {
270 function _getValue ($page_handle, &$revision_handle) {
271 $perm_array = pagePermissions($page_handle->_pagename);
272 return pagePermissionsSimpleFormat($perm_array,
273 $page_handle->get('author'),
274 $page_handle->get('group'));
278 // $Log: not supported by cvs2svn $
279 // Revision 1.20 2004/11/01 10:43:59 rurban
280 // seperate PassUser methods into seperate dir (memory usage)
281 // fix WikiUser (old) overlarge data session
282 // remove wikidb arg from various page class methods, use global ->_dbi instead
285 // Revision 1.19 2004/06/16 10:38:59 rurban
286 // Disallow refernces in calls if the declaration is a reference
287 // ("allow_call_time_pass_reference clean").
288 // PhpWiki is now allow_call_time_pass_reference = Off clean,
289 // but several external libraries may not.
290 // In detail these libs look to be affected (not tested):
294 // Revision 1.18 2004/06/14 11:31:39 rurban
295 // renamed global $Theme to $WikiTheme (gforge nameclash)
296 // inherit PageList default options from PageList
297 // default sortby=pagename
298 // use options in PageList_Selectable (limit, sortby, ...)
299 // added action revert, with button at action=diff
300 // added option regex to WikiAdminSearchReplace
302 // Revision 1.17 2004/06/13 15:33:20 rurban
303 // new support for arguments owner, author, creator in most relevant
304 // PageList plugins. in WikiAdmin* via preSelectS()
306 // Revision 1.16 2004/06/08 13:50:43 rurban
307 // show getfacl and acl line
309 // Revision 1.15 2004/06/08 10:05:12 rurban
310 // simplified admin action shortcuts
312 // Revision 1.14 2004/06/07 22:28:06 rurban
313 // add acl field to mimified dump
315 // Revision 1.13 2004/06/04 20:32:54 rurban
316 // Several locale related improvements suggested by Pierrick Meignen
317 // LDAP fix by John Cole
318 // reanable admin check without ENABLE_PAGEPERM in the admin plugins
320 // Revision 1.12 2004/06/03 22:24:48 rurban
321 // reenable admin check on !ENABLE_PAGEPERM, honor s=Wildcard arg, fix warning after Remove
323 // Revision 1.11 2004/06/01 15:28:02 rurban
324 // AdminUser only ADMIN_USER not member of Administrators
325 // some RateIt improvements by dfrankow
326 // edit_toolbar buttons
328 // Revision 1.10 2004/05/27 17:49:06 rurban
329 // renamed DB_Session to DbSession (in CVS also)
330 // added WikiDB->getParam and WikiDB->getAuthParam method to get rid of globals
331 // remove leading slash in error message
332 // added force_unlock parameter to File_Passwd (no return on stale locks)
333 // fixed adodb session AffectedRows
334 // added FileFinder helpers to unify local filenames and DATA_PATH names
335 // editpage.php: new edit toolbar javascript on ENABLE_EDIT_TOOLBAR
337 // Revision 1.9 2004/05/24 17:34:53 rurban
340 // Revision 1.8 2004/05/16 22:32:54 rurban
343 // Revision 1.7 2004/05/16 22:07:35 rurban
344 // check more config-default and predefined constants
345 // various PagePerm fixes:
346 // fix default PagePerms, esp. edit and view for Bogo and Password users
347 // implemented Creator and Owner
348 // BOGOUSERS renamed to BOGOUSER
349 // fixed syntax errors in signin.tmpl
351 // Revision 1.5 2004/04/07 23:13:19 rurban
352 // fixed pear/File_Passwd for Windows
353 // fixed FilePassUser sessions (filehandle revive) and password update
355 // Revision 1.4 2004/03/17 20:23:44 rurban
356 // fixed p[] pagehash passing from WikiAdminSelect, fixed problem removing pages with [] in the pagename
358 // Revision 1.3 2004/03/12 13:31:43 rurban
359 // enforce PagePermissions, errormsg if not Admin
361 // Revision 1.2 2004/02/24 04:02:07 rurban
362 // Better warning messages
364 // Revision 1.1 2004/02/23 21:30:25 rurban
365 // more PagePerm stuff: (working against 1.4.0)
366 // ACL editing and simplification of ACL's to simple rwx------ string
375 // c-hanging-comment-ender-p: nil
376 // indent-tabs-mode: nil