lib/plugin/WikiAdminSetAcl.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id$');
   3 /*
   4  Copyright 2004 $ThePhpWikiProgrammingTeam
   5
   6  This file is part of PhpWiki.
   7
   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.
  12
  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.
  17
  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
  21  */
  22
  23 /**
  24  * Set individual PagePermissions
  25  *
  26  * Usage:   <?plugin WikiAdminSetAcl ?> or called via WikiAdminSelect
  27  * Author:  Reini Urban <rurban@x-ray.at>
  28  *
  29  * KNOWN ISSUES:
  30  * Requires PHP 4.2 so far.
  31  *
  32  * TODO: UI to add custom group/username.
  33  * Currently it's easier to dump a page, fix it manually and
  34  * import it, than use Setacl
  35  */
  36 require_once('lib/PageList.php');
  37 require_once('lib/plugin/WikiAdminSelect.php');
  38
  39 class WikiPlugin_WikiAdminSetAcl
  40 extends WikiPlugin_WikiAdminSelect
  41 {
  42     function getName() {
  43         return _("WikiAdminSetAcl");
  44     }
  45
  46     function getDescription() {
  47         return _("Set individual page permissions.");
  48     }
  49
  50     function getVersion() {
  51         return preg_replace("/[Revision: $]/", '',
  52                             "\$Revision: 1.24 $");
  53     }
  54
  55     function getDefaultArguments() {
  56         return array_merge
  57             (
  58              PageList::supportedArgs(),
  59              array(
  60                      'p'        => "[]",  // list of pages
  61                      's'        => false, /* select by pagename */
  62                      /* Columns to include in listing */
  63                      'info'     => 'pagename,perm,mtime,owner,author',
  64                      ));
  65     }
  66
  67     function setaclPages(&$request, $pages, $acl) {
  68         $ul = HTML::ul();
  69         $count = 0;
  70         $dbi =& $request->_dbi;
  71         // check new_group and new_perm
  72         if (isset($acl['_add_group'])) {
  73             //add groups with perm
  74             foreach ($acl['_add_group'] as $access => $dummy) {
  75                 $group = $acl['_new_group'][$access];
  76                 $acl[$access][$group] = isset($acl['_new_perm'][$access]) ? 1 : 0;
  77             }
  78             unset($acl['_add_group']);
  79         }
  80         unset($acl['_new_group']); unset($acl['_new_perm']);
  81         if (isset($acl['_del_group'])) {
  82             //del groups with perm
  83             foreach ($acl['_del_group'] as $access => $del) {
  84                 while (list($group,$dummy) = each($del))
  85                     unset($acl[$access][$group]);
  86             }
  87             unset($acl['_del_group']);
  88         }
  89         if ($perm = new PagePermission($acl)) {
  90             $perm->sanify();
  91             foreach ($pages as $pagename) {
  92                 // check if unchanged? we need a deep array_equal
  93                 $page = $dbi->getPage($pagename);
  94                 $oldperm = getPagePermissions($page);
  95                 if ($oldperm)
  96                     $oldperm->sanify();
  97                 if ($oldperm and $perm->equal($oldperm->perm)) // (serialize($oldperm->perm) == serialize($perm->perm))
  98                     $ul->pushContent(HTML::li(fmt("ACL not changed for page '%s'.",$pagename)));
  99                 elseif (mayAccessPage('change', $pagename)) {
 100                     setPagePermissions ($page, $perm);
 101                     $ul->pushContent(HTML::li(fmt("ACL changed for page '%s'.",$pagename)));
 102                     $count++;
 103                 } else {
 104                     $ul->pushContent(HTML::li(fmt("Access denied to change page '%s'.",$pagename)));
 105                 }
 106             }
 107         } else {
 108             $ul->pushContent(HTML::li(fmt("Invalid ACL")));
 109         }
 110         if ($count) {
 111             $dbi->touch();
 112             return HTML($ul,
 113                         HTML::p(fmt("%s pages have been changed.",$count)));
 114         } else {
 115             return HTML($ul,
 116                         HTML::p(fmt("No pages changed.")));
 117         }
 118     }
 119
 120     function run($dbi, $argstr, &$request, $basepage) {
 121         //if (!DEBUG)
 122         //    return $this->disabled("WikiAdminSetAcl not yet enabled. Set DEBUG to try it.");
 123         if ($request->getArg('action') != 'browse')
 124             if ($request->getArg('action') != _("PhpWikiAdministration/SetAcl"))
 125                 return $this->disabled("(action != 'browse')");
 126         if (!ENABLE_PAGEPERM)
 127             return $this->disabled("ENABLE_PAGEPERM = false");
 128
 129         $args = $this->getArgs($argstr, $request);
 130         $this->_args = $args;
 131         $this->preSelectS($args, $request);
 132
 133         $p = $request->getArg('p');
 134         $post_args = $request->getArg('admin_setacl');
 135         $next_action = 'select';
 136         $pages = array();
 137         if ($p && !$request->isPost())
 138             $pages = $p;
 139         elseif ($this->_list)
 140             $pages = $this->_list;
 141         $header = HTML::p();
 142         if ($p && $request->isPost() &&
 143             !empty($post_args['acl']) && empty($post_args['cancel'])) {
 144             // without individual PagePermissions:
 145             if (!ENABLE_PAGEPERM and !$request->_user->isAdmin()) {
 146                 $request->_notAuthorized(WIKIAUTH_ADMIN);
 147                 $this->disabled("! user->isAdmin");
 148             }
 149             if ($post_args['action'] == 'verify') {
 150                 // Real action
 151                 $header->pushContent(
 152                     $this->setaclPages($request, array_keys($p),
 153                                        $request->getArg('acl')));
 154             }
 155             if ($post_args['action'] == 'select') {
 156                 if (!empty($post_args['acl']))
 157                     $next_action = 'verify';
 158                 foreach ($p as $name => $c) {
 159                     $pages[$name] = 1;
 160                 }
 161             }
 162         }
 163         if ($next_action == 'select' and empty($pages)) {
 164             // List all pages to select from.
 165             $pages = $this->collectPages($pages, $dbi, $args['sortby'], $args['limit'], $args['exclude']);
 166         }
 167         if ($next_action == 'verify') {
 168             $args['info'] = "checkbox,pagename,perm,mtime,owner,author";
 169         }
 170         $pagelist = new PageList_Selectable($args['info'],
 171                                             $args['exclude'],
 172                                             array('types' => array(
 173                                                   'perm'
 174                                                   => new _PageList_Column_perm('perm', _("Permission")),
 175                                                   'acl'
 176                                                   => new _PageList_Column_acl('acl', _("ACL")))));
 177
 178         $pagelist->addPageList($pages);
 179         if ($next_action == 'verify') {
 180             $button_label = _("Yes");
 181             $header = $this->setaclForm($header, $post_args, $pages);
 182             $header->pushContent(
 183               HTML::p(HTML::strong(
 184                   _("Are you sure you want to permanently change access to the selected files?"))));
 185         }
 186         else {
 187             $button_label = _("SetAcl");
 188             $header = $this->setaclForm($header, $post_args, $pages);
 189             $header->pushContent(HTML::p(_("Select the pages to change:")));
 190         }
 191
 192         $buttons = HTML::p(Button('submit:admin_setacl[acl]', $button_label, 'wikiadmin'),
 193                            Button('submit:admin_setacl[cancel]', _("Cancel"), 'button'));
 194
 195         return HTML::form(array('action' => $request->getPostURL(),
 196                                 'method' => 'post'),
 197                           $header,
 198                           $pagelist->getContent(),
 199                           HiddenInputs($request->getArgs(),
 200                                         false,
 201                                         array('admin_setacl')),
 202                           HiddenInputs(array('admin_setacl[action]' => $next_action)),
 203                           ENABLE_PAGEPERM
 204                           ? ''
 205                           : HiddenInputs(array('require_authority_for_post' => WIKIAUTH_ADMIN)),
 206                           $buttons);
 207     }
 208
 209     function setaclForm(&$header, $post_args, $pagehash) {
 210         $acl = $post_args['acl'];
 211
 212         //FIXME: find intersection of all pages perms, not just from the last pagename
 213         $pages = array();
 214         foreach ($pagehash as $name => $checked) {
 215            if ($checked) $pages[] = $name;
 216         }
 217         $perm_tree = pagePermissions($name);
 218         $table = pagePermissionsAclFormat($perm_tree, !empty($pages));
 219         $header->pushContent(HTML::strong(_("Selected Pages: ")), HTML::tt(join(', ',$pages)), HTML::br());
 220         $first_page = $GLOBALS['request']->_dbi->getPage($name);
 221         $owner = $first_page->getOwner();
 222         list($type, $perm) = pagePermissionsAcl($perm_tree[0], $perm_tree);
 223         //if (DEBUG) $header->pushContent(HTML::pre("Permission tree for $name:\n",print_r($perm_tree,true)));
 224         if ($type == 'inherited')
 225             $type = sprintf(_("page permission inherited from %s"), $perm_tree[1][0]);
 226         elseif ($type == 'page')
 227             $type = _("invidual page permission");
 228         elseif ($type == 'default')
 229             $type = _("default page permission");
 230         $header->pushContent(HTML::strong(_("Type").': '), HTML::tt($type),HTML::br());
 231         $header->pushContent(HTML::strong(_("getfacl").': '), pagePermissionsSimpleFormat($perm_tree, $owner),HTML::br());
 232         $header->pushContent(HTML::strong(_("ACL").': '), HTML::tt($perm->asAclLines()),HTML::br());
 233
 234         $header->pushContent(HTML::p(HTML::strong(_("Description").': '),
 235                                      _("Selected Grant checkboxes allow access, unselected checkboxes deny access."),
 236                                      _("To ignore delete the line."),
 237                                      _("To add check 'Add' near the dropdown list.")
 238                                      ));
 239         $header->pushContent(HTML::blockquote($table));
 240         //
 241         // display array of checkboxes for existing perms
 242         // and a dropdown for user/group to add perms.
 243         // disabled if inherited,
 244         // checkbox to disable inheritance,
 245         // another checkbox to progate new permissions to all childs (if there exist some)
 246         //Todo:
 247         // warn if more pages are selected and they have different perms
 248         //$header->pushContent(HTML::input(array('name' => 'admin_setacl[acl]',
 249         //                                       'value' => $post_args['acl'])));
 250         $header->pushContent(HTML::br());
 251         if (!empty($pages) and DEBUG) {
 252           $checkbox = HTML::input(array('type' => 'checkbox',
 253                                         'name' => 'admin_setacl[updatechildren]',
 254                                         'value' => 1));
 255           if (!empty($post_args['updatechildren']))  $checkbox->setAttr('checked','checked');
 256           $header->pushContent($checkbox,
 257                   _("Propagate new permissions to all subpages?"),
 258                   HTML::raw("&nbsp;&nbsp;"),
 259                   HTML::em(_("(disable individual page permissions, enable inheritance)?")),
 260                   HTML::br(),HTML::em(_("(Currently not working)"))
 261                                );
 262         }
 263         $header->pushContent(HTML::hr(),HTML::p());
 264         return $header;
 265     }
 266 }
 267
 268 class _PageList_Column_acl extends _PageList_Column {
 269     function _getValue ($page_handle, &$revision_handle) {
 270         $perm_tree = pagePermissions($page_handle->_pagename);
 271         return pagePermissionsAclFormat($perm_tree);
 272     }
 273 };
 274
 275 class _PageList_Column_perm extends _PageList_Column {
 276     function _getValue ($page_handle, &$revision_handle) {
 277         $perm_array = pagePermissions($page_handle->_pagename);
 278         return pagePermissionsSimpleFormat($perm_array,
 279                                            $page_handle->get('author'),
 280                                            $page_handle->get('group'));
 281     }
 282 };
 283
 284 // $Log: not supported by cvs2svn $
 285 // Revision 1.23  2005/02/12 17:24:24  rurban
 286 // locale update: missing . : fixed. unified strings
 287 // proper linebreaks
 288 //
 289 // Revision 1.22  2005/01/25 08:05:17  rurban
 290 // protect against !ENABLE_PAGEPERM
 291 //
 292 // Revision 1.21  2004/11/23 15:17:20  rurban
 293 // better support for case_exact search (not caseexact for consistency),
 294 // plugin args simplification:
 295 //   handle and explode exclude and pages argument in WikiPlugin::getArgs
 296 //     and exclude in advance (at the sql level if possible)
 297 //   handle sortby and limit from request override in WikiPlugin::getArgs
 298 // ListSubpages: renamed pages to maxpages
 299 //
 300 // Revision 1.20  2004/11/01 10:43:59  rurban
 301 // seperate PassUser methods into seperate dir (memory usage)
 302 // fix WikiUser (old) overlarge data session
 303 // remove wikidb arg from various page class methods, use global ->_dbi instead
 304 // ...
 305 //
 306 // Revision 1.19  2004/06/16 10:38:59  rurban
 307 // Disallow refernces in calls if the declaration is a reference
 308 // ("allow_call_time_pass_reference clean").
 309 //   PhpWiki is now allow_call_time_pass_reference = Off clean,
 310 //   but several external libraries may not.
 311 //   In detail these libs look to be affected (not tested):
 312 //   * Pear_DB odbc
 313 //   * adodb oracle
 314 //
 315 // Revision 1.18  2004/06/14 11:31:39  rurban
 316 // renamed global $Theme to $WikiTheme (gforge nameclash)
 317 // inherit PageList default options from PageList
 318 //   default sortby=pagename
 319 // use options in PageList_Selectable (limit, sortby, ...)
 320 // added action revert, with button at action=diff
 321 // added option regex to WikiAdminSearchReplace
 322 //
 323 // Revision 1.17  2004/06/13 15:33:20  rurban
 324 // new support for arguments owner, author, creator in most relevant
 325 // PageList plugins. in WikiAdmin* via preSelectS()
 326 //
 327 // Revision 1.16  2004/06/08 13:50:43  rurban
 328 // show getfacl and acl line
 329 //
 330 // Revision 1.15  2004/06/08 10:05:12  rurban
 331 // simplified admin action shortcuts
 332 //
 333 // Revision 1.14  2004/06/07 22:28:06  rurban
 334 // add acl field to mimified dump
 335 //
 336 // Revision 1.13  2004/06/04 20:32:54  rurban
 337 // Several locale related improvements suggested by Pierrick Meignen
 338 // LDAP fix by John Cole
 339 // reanable admin check without ENABLE_PAGEPERM in the admin plugins
 340 //
 341 // Revision 1.12  2004/06/03 22:24:48  rurban
 342 // reenable admin check on !ENABLE_PAGEPERM, honor s=Wildcard arg, fix warning after Remove
 343 //
 344 // Revision 1.11  2004/06/01 15:28:02  rurban
 345 // AdminUser only ADMIN_USER not member of Administrators
 346 // some RateIt improvements by dfrankow
 347 // edit_toolbar buttons
 348 //
 349 // Revision 1.10  2004/05/27 17:49:06  rurban
 350 // renamed DB_Session to DbSession (in CVS also)
 351 // added WikiDB->getParam and WikiDB->getAuthParam method to get rid of globals
 352 // remove leading slash in error message
 353 // added force_unlock parameter to File_Passwd (no return on stale locks)
 354 // fixed adodb session AffectedRows
 355 // added FileFinder helpers to unify local filenames and DATA_PATH names
 356 // editpage.php: new edit toolbar javascript on ENABLE_EDIT_TOOLBAR
 357 //
 358 // Revision 1.9  2004/05/24 17:34:53  rurban
 359 // use ACLs
 360 //
 361 // Revision 1.8  2004/05/16 22:32:54  rurban
 362 // setacl icons
 363 //
 364 // Revision 1.7  2004/05/16 22:07:35  rurban
 365 // check more config-default and predefined constants
 366 // various PagePerm fixes:
 367 //   fix default PagePerms, esp. edit and view for Bogo and Password users
 368 //   implemented Creator and Owner
 369 //   BOGOUSERS renamed to BOGOUSER
 370 // fixed syntax errors in signin.tmpl
 371 //
 372 // Revision 1.5  2004/04/07 23:13:19  rurban
 373 // fixed pear/File_Passwd for Windows
 374 // fixed FilePassUser sessions (filehandle revive) and password update
 375 //
 376 // Revision 1.4  2004/03/17 20:23:44  rurban
 377 // fixed p[] pagehash passing from WikiAdminSelect, fixed problem removing pages with [] in the pagename
 378 //
 379 // Revision 1.3  2004/03/12 13:31:43  rurban
 380 // enforce PagePermissions, errormsg if not Admin
 381 //
 382 // Revision 1.2  2004/02/24 04:02:07  rurban
 383 // Better warning messages
 384 //
 385 // Revision 1.1  2004/02/23 21:30:25  rurban
 386 // more PagePerm stuff: (working against 1.4.0)
 387 //   ACL editing and simplification of ACL's to simple rwx------ string
 388 //   not yet working.
 389 //
 390 //
 391
 392 // Local Variables:
 393 // mode: php
 394 // tab-width: 8
 395 // c-basic-offset: 4
 396 // c-hanging-comment-ender-p: nil
 397 // indent-tabs-mode: nil
 398 // End:
 399 ?>