lib/PagePerm.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id: PagePerm.php,v 1.8 2004-03-14 16:24:35 rurban Exp $');
   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    Permissions per page and action based on current user,
  25    ownership and group membership implemented with ACL's (Access Control Lists),
  26    opposed to the simplier unix like ugo:rwx system.
  27    The previous system was only based on action and current user. (lib/main.php)
  28
  29    Permissions maybe inherited its parent pages, and ultimativly the
  30    optional master page (".")
  31    Pagenames starting with "." have special default permissions.
  32    For Authentication see WikiUserNew.php, WikiGroup.php and main.php
  33    Page Permssions are in PhpWiki since v1.3.9 and enabled since v1.4.0
  34
  35    This file might replace the following functions from main.php:
  36      Request::_notAuthorized($require_level)
  37        display the denied message and optionally a login form
  38        to gain higher privileges
  39      Request::getActionDescription($action)
  40        helper to localize the _notAuthorized message per action,
  41        when login is tried.
  42      Request::getDisallowedActionDescription($action)
  43        helper to localize the _notAuthorized message per action,
  44        when it aborts
  45      Request::requiredAuthority($action)
  46        returns the needed user level
  47        has a hook for plugins on POST
  48      Request::requiredAuthorityForAction($action)
  49        just returns the level per action, will be replaced with the
  50        action + page pair
  51
  52      The defined main.php actions map to simplier access types:
  53        browse => view
  54        edit   => edit
  55        create => edit or create
  56        remove => remove
  57        rename => change
  58        store prefs => change
  59        list in PageList => list
  60 */
  61
  62 /* Symbolic special ACL groups. Untranslated to be stored in page metadata*/
  63 define('ACL_EVERY',        '_EVERY');
  64 define('ACL_ANONYMOUS',    '_ANONYMOUS');
  65 define('ACL_BOGOUSERS',    '_BOGOUSERS');
  66 define('ACL_HASHOMEPAGE',  '_HASHOMEPAGE');
  67 define('ACL_SIGNED',       '_SIGNED');
  68 define('ACL_AUTHENTICATED','_AUTHENTICATED');
  69 define('ACL_ADMIN',        '_ADMIN');
  70 define('ACL_OWNER',        '_OWNER');
  71 define('ACL_CREATOR',      '_CREATOR');
  72
  73 // Return an page permissions array for this page.
  74 // To provide ui helpers to view and change page permissions:
  75 //   <tr><th>Group</th><th>Access</th><th>Allow or Forbid</th></tr>
  76 //   <tr><td>$group</td><td>_($access)</td><td> [ ] </td></tr>
  77 function pagePermissions($pagename) {
  78     global $request;
  79     $page = $request->getPage($pagename);
  80     // Page not found (new page); returned inherited permissions, to be displayed in gray
  81     if (! $page->exists() ) {
  82         if ($pagename == '.') // stop recursion
  83             return array('default',new PagePermission());
  84         else {
  85             return array('inherited',pagePermissions(getParentPage($pagename)));
  86         }
  87     } elseif ($perm = getPagePermissions($page)) {
  88         return array('page',$perm);
  89     // or no permissions defined; returned inherited permissions, to be displayed in gray
  90     } else {
  91         return array('inherited',pagePermissions(getParentPage($pagename)));
  92     }
  93 }
  94
  95 function pagePermissionsSimpleFormat($perm_tree,$owner,$group=false) {
  96     list($type,$perm) = pagePermissionsAcl($perm_tree[0], $perm_tree);
  97     /*
  98     $type = $perm_tree[0];
  99     $perm = pagePermissionsAcl($perm_tree);
 100     if (is_object($perm_tree[1]))
 101         $perm = $perm_tree[1];
 102     elseif (is_array($perm_tree[1])) {
 103         $perm_tree = pagePermissionsSimpleFormat($perm_tree[1],$owner,$group);
 104         if (isa($perm_tree[1],'pagepermission'))
 105             $perm = $perm_tree[1];
 106         elseif (isa($perm_tree,'htmlelement'))
 107             return $perm_tree;
 108     }
 109     */
 110     if ($type == 'page')
 111         return HTML::tt(HTML::bold($perm->asRwxString($owner,$group).'+'));
 112     elseif ($type == 'default')
 113         return HTML::tt($perm->asRwxString($owner,$group));
 114     elseif ($type == 'inherited') {
 115         return HTML::tt(array('class'=>'inherited','style'=>'color:#aaa;'),
 116                         $perm->asRwxString($owner,$group));
 117     }
 118 }
 119
 120 function pagePermissionsAcl($type,$perm_tree) {
 121     $perm = $perm_tree[1];
 122     while (!is_object($perm)) {
 123         $perm_tree = pagePermissionsAcl($type, $perm);
 124         $perm = $perm_tree[1];
 125     }
 126     return array($type,$perm);
 127 }
 128
 129 // view => who
 130 // edit => who
 131 function pagePermissionsAclFormat($perm_tree,$editable=false) {
 132     list($type,$perm) = pagePermissionsAcl($perm_tree[0], $perm_tree);
 133     if ($editable)
 134         return $perm->asEditableTable($type);
 135     else
 136         return $perm->asTable($type);
 137 }
 138
 139 /**
 140  * Check permission per page.
 141  * Returns true or false.
 142  */
 143 function mayAccessPage ($access,$pagename) {
 144     return _requiredAuthorityForPagename($access,$pagename);
 145 }
 146
 147 /** Check the permissions for the current action.
 148  * Walk down the inheritance tree. Collect all permissions until
 149  * the minimum required level is gained, which is not
 150  * overruled by more specific forbid rules.
 151  * Todo: cache result per access and page in session?
 152  */
 153 function requiredAuthorityForPage ($action) {
 154     if (_requiredAuthorityForPagename(action2access($action),
 155                                       $GLOBALS['request']->getArg('pagename')))
 156         return $GLOBALS['request']->_user->_level;
 157     else
 158         return WIKIAUTH_FORBIDDEN;
 159 }
 160
 161 // Translate action or plugin to the simplier access types:
 162 function action2access ($action) {
 163     global $request;
 164     switch ($action) {
 165     case 'browse':
 166     case 'viewsource':
 167     case 'diff':
 168     case 'select':
 169     case 'xmlrpc':
 170     case 'search':
 171         return 'view';
 172     case 'zip':
 173     case 'ziphtml':
 174     case 'dumpserial':
 175     case 'dumphtml':
 176         return 'dump';
 177     case 'edit':
 178         return 'edit';
 179     case 'create':
 180         $page = $request->getPage();
 181         $current = $page->getCurrentRevision();
 182         if ($current->hasDefaultContents())
 183             return 'edit';
 184         else
 185             return 'view';
 186         break;
 187     case 'upload':
 188     case 'loadfile':
 189         // probably create/edit but we cannot check all page permissions, can we?
 190     case 'remove':
 191     case 'lock':
 192     case 'unlock':
 193             return 'change';
 194     default:
 195         //Todo: Plugins should be able to override its access type
 196         if (isWikiWord($action))
 197             return 'view';
 198         else
 199             return 'change';
 200         break;
 201     }
 202 }
 203
 204 // Recursive helper to do the real work
 205 function _requiredAuthorityForPagename($access, $pagename) {
 206     global $request;
 207     $page = $request->getPage($pagename);
 208     // Page not found; check against default permissions
 209     if (! $page->exists() ) {
 210         $perm = new PagePermission();
 211         return ($perm->isAuthorized($access,$request->_user) === true);
 212     }
 213     // no ACL defined; check for special dotfile or walk down
 214     if (! ($perm = getPagePermissions($page))) {
 215         if ($pagename[0] == '.') {
 216             $perm = new PagePermission(PagePermission::dotPerms());
 217             return ($perm->isAuthorized($access,$request->_user) === true);
 218         }
 219         return _requiredAuthorityForPagename($access,getParentPage($pagename));
 220     }
 221     // ACL defined; check if isAuthorized returns true or false or undecided
 222     $authorized = $perm->isAuthorized($access,$request->_user);
 223     if ($authorized != -1) // -1 for undecided
 224         return $authorized;
 225     else
 226         return _requiredAuthorityForPagename($access,getParentPage($pagename));
 227 }
 228
 229 /**
 230  * @param  string $pagename   page from which the parent page is searched.
 231  * @return string parent      pagename or the (possibly pseudo) dot-pagename.
 232  */
 233 function getParentPage($pagename) {
 234     if (isSubPage($pagename)) {
 235         return subPageSlice($pagename,0);
 236     } else {
 237         return '.';
 238     }
 239 }
 240
 241 // Read the ACL from the page
 242 // Done: Not existing pages should NOT be queried.
 243 // Check the parent page instead and don't take the default ACL's
 244 function getPagePermissions ($page) {
 245     if ($hash = $page->get('perm'))  // hash => object
 246         return new PagePermission(unserialize($hash));
 247     else
 248         return false;
 249 }
 250
 251 // Store the ACL in the page
 252 function setPagePermissions ($page,$perm) {
 253     $perm->store($page);
 254 }
 255
 256 function getAccessDescription($access) {
 257     static $accessDescriptions;
 258     if (! $accessDescriptions) {
 259         $accessDescriptions = array(
 260                                     'list'     => _("List this page and all subpages"),
 261                                     'view'     => _("View this page and all subpages"),
 262                                     'edit'     => _("Edit this page and all subpages"),
 263                                     'create'   => _("Create a new (sub)page"),
 264                                     'dump'     => _("Download the page contents"),
 265                                     'change'   => _("Change page attributes"),
 266                                     'remove'   => _("Remove this page"),
 267                                     );
 268     }
 269     if (in_array($access, array_keys($accessDescriptions)))
 270         return $accessDescriptions[$access];
 271     else
 272         return $access;
 273 }
 274
 275 /**
 276  * The ACL object per page. It is stored in a page, but can also
 277  * be merged with ACL's from other pages or taken from the master (pseudo) dot-file.
 278  *
 279  * A hash of "access" => "requires" pairs.
 280  *   "access"   is a shortcut for common actions, which map to main.php actions
 281  *   "requires" required username or groupname or any special group => true or false
 282  *
 283  * Define any special rules here, like don't list dot-pages.
 284  */
 285 class PagePermission {
 286     var $perm;
 287
 288     function PagePermission($hash = array()) {
 289         if (is_array($hash) and !empty($hash)) {
 290             $accessTypes = $this->accessTypes();
 291             foreach ($hash as $access => $requires) {
 292                 if (in_array($access,$accessTypes))
 293                     $this->perm[$access] = $requires;
 294                 else
 295                     trigger_error(sprintf(_("Unsupported ACL access type %s ignored."),$access),
 296                                   E_USER_WARNING);
 297             }
 298         } else {
 299             // set default permissions, the so called dot-file acl's
 300             $this->perm = $this->defaultPerms();
 301         }
 302         return $this;
 303     }
 304
 305     /**
 306      * The workhorse to check the user against the current ACL pairs.
 307      * Must translate the various special groups to the actual users settings
 308      * (userid, group membership).
 309      */
 310     function isAuthorized($access,$user) {
 311         if (!empty($this->perm{$access})) {
 312             foreach ($this->perm[$access] as $group => $bool) {
 313                 if ($this->isMember($user,$group))
 314                     return $bool;
 315             }
 316         }
 317         return -1; // undecided
 318     }
 319
 320     /**
 321      * Translate the various special groups to the actual users settings
 322      * (userid, group membership).
 323      */
 324     function isMember($user,$group) {
 325         global $request;
 326         if ($group === ACL_EVERY) return true;
 327         $member = &WikiGroup::getGroup($request);
 328         //$user = & $request->_user;
 329         if ($group === ACL_ADMIN)   // WIKI_ADMIN or member of _("Administrators")
 330             return $user->isAdmin() or
 331                    $member->isMember(GROUP_ADMIN);
 332         if ($group === ACL_ANONYMOUS)
 333             return ! $user->isSignedIn();
 334         if ($group === ACL_BOGOUSERS)
 335             if (ENABLE_USER_NEW) return isa($user,'_BogoUser');
 336             else return isWikiWord($user->UserName());
 337         if ($group === ACL_HASHOMEPAGE)
 338             return $user->hasHomePage();
 339         if ($group === ACL_SIGNED)
 340             return $user->isSignedIn();
 341         if ($group === ACL_AUTHENTICATED)
 342             return $user->isAuthenticated();
 343         if ($group === ACL_OWNER) {
 344             $page = $request->getPage();
 345             return $page->get('author') === $user->UserName();
 346         }
 347         if ($group === ACL_CREATOR) {
 348             $page = $request->getPage();
 349             $rev = $page->getRevision(1);
 350             return $rev->get('author') === $user->UserName();
 351         }
 352         /* Or named groups or usernames.
 353          Note: We don't seperate groups and users here.
 354          Users overrides groups with the same name. */
 355         return $user->UserName() === $group or
 356                $member->isMember($group);
 357     }
 358
 359     /**
 360      * returns hash of default permissions.
 361      * check if the page '.' exists and returns this instead.
 362      */
 363     function defaultPerms() {
 364         //Todo: check for the existance of '.' and take this instead.
 365         //Todo: honor more index.php auth settings here
 366         $perm = array('view'   => array(ACL_EVERY => true),
 367                       'edit'   => array(ACL_EVERY => true),
 368                       'create' => array(ACL_EVERY => true),
 369                       'list'   => array(ACL_EVERY => true),
 370                       'remove' => array(ACL_ADMIN => true,
 371                                         ACL_OWNER => true),
 372                       'change' => array(ACL_ADMIN => true,
 373                                         ACL_OWNER => true));
 374         if (defined('ZIPDUMP_AUTH') && ZIPDUMP_AUTH)
 375             $perm['dump'] = array(ACL_ADMIN => true,
 376                                   ACL_OWNER => true);
 377         else
 378             $perm['dump'] = array(ACL_EVERY => true);
 379         if (defined('REQUIRE_SIGNIN_BEFORE_EDIT') && REQUIRE_SIGNIN_BEFORE_EDIT)
 380             $perm['edit'] = array(ACL_SIGNED => true);
 381         if (defined('ALLOW_ANON_USER') && ! ALLOW_ANON_USER) {
 382             if (defined('ALLOW_BOGO_USER') && ALLOW_BOGO_USER) {
 383                 $perm['view'] = array(ACL_BOGOUSER => true);
 384                 $perm['edit'] = array(ACL_BOGOUSER => true);
 385             } elseif (defined('ALLOW_USER_PASSWORDS') && ALLOW_USER_PASSWORDS) {
 386                 $perm['view'] = array(ACL_AUTHENTICATED => true);
 387                 $perm['edit'] = array(ACL_AUTHENTICATED => true);
 388             } else {
 389                 $perm['view'] = array(ACL_SIGNED => true);
 390                 $perm['edit'] = array(ACL_SIGNED => true);
 391             }
 392         }
 393         return $perm;
 394     }
 395
 396     /**
 397      * returns list of all supported access types.
 398      */
 399     function accessTypes() {
 400         return array_keys($this->defaultPerms());
 401     }
 402
 403     /**
 404      * special permissions for dot-files, beginning with '.'
 405      * maybe also for '_' files?
 406      */
 407     function dotPerms() {
 408         $def = array(ACL_ADMIN => true,
 409                      ACL_OWNER => true);
 410         $perm = array();
 411         foreach ($this->accessTypes() as $access) {
 412             $perm[$access] = $def;
 413         }
 414         return $perm;
 415     }
 416
 417     /**
 418      *  dead code. not needed inside the object. see getPagePermissions($page)
 419      */
 420     function retrieve($page) {
 421         $hash = $page->get('perm');
 422         if ($hash)  // hash => object
 423             return new PagePermission(unserialize($hash));
 424         else
 425             return new PagePermission();
 426     }
 427
 428     function store($page) {
 429         // object => hash
 430         return $page->set('perm',serialize(obj2hash($this->perm)));
 431     }
 432
 433     /* type: page, default, inherited */
 434     function asTable($type) {
 435         $table = HTML::table();
 436         foreach ($this->perm as $access => $perms) {
 437             $td = HTML::table(array('class' => 'cal','valign' => 'top'));
 438             foreach ($perms as $group => $bool) {
 439                 $td->pushContent(HTML::tr(HTML::td(array('align'=>'right'),$group),
 440                                                    HTML::td($bool ? '[X]' : '[ ]')));
 441             }
 442             $table->pushContent(HTML::tr(array('valign' => 'top'),
 443                                          HTML::td($access),HTML::td($td)));
 444         }
 445         if ($type == 'default')
 446             $table->setAttr('style','border: dotted thin black; background-color:#eee;');
 447         elseif ($type == 'inherited')
 448             $table->setAttr('style','border: dotted thin black; background-color:#ddd;');
 449         elseif ($type == 'page')
 450             $table->setAttr('style','border: solid thin black; font-weight: bold;');
 451         return $table;
 452     }
 453
 454     /* type: page, default, inherited */
 455     function asEditableTable($type) {
 456         $table = HTML::table();
 457         $table->pushContent(HTML::tr(array('valign' => 'top'),
 458                                      HTML::th(array('align' => 'left'),'access'),
 459                                      HTML::th(array('align'=>'right'),
 460                                               'Group/User'),
 461                                      HTML::th(),
 462                                      HTML::th('Description')));
 463         foreach ($this->perm as $access => $perms) {
 464             //$permlist = HTML::table(array('class' => 'cal','valign' => 'top'));
 465             $first_only = true;
 466             foreach ($perms as $group => $bool) {
 467                 $checkbox = HTML::input(array('type' => 'checkbox',
 468                                               'name' => "acl[$access][$group]",
 469                                               'value' => true));
 470                 if ($bool) $checkbox->setAttr('checked','checked');
 471                 if ($first_only) {
 472                     $table->pushContent(HTML::tr(array('valign' => 'top'),
 473                                                  HTML::td(HTML::strong($access.":")),
 474                                                  HTML::td(array('class' => 'cal-today','align'=>'right'),
 475                                                           constant("GROUP".$group)),
 476                                                  HTML::td($checkbox),
 477                                                  HTML::td(HTML::em(getAccessDescription($access)))));
 478                     $first_only = false;
 479                 } else {
 480                     $table->pushContent(HTML::tr(array('valign' => 'top'),
 481                                                  HTML::td(),
 482                                                  HTML::td(array('class' => 'cal-today','align'=>'right'),
 483                                                           constant("GROUP".$group)),
 484                                                  HTML::td($checkbox),
 485                                                  HTML::td()));
 486                 }
 487             }
 488             /*
 489             $table->pushContent(HTML::tr(array('valign' => 'top'),
 490                                          HTML::td(HTML::strong($access)),
 491                                          HTML::td($permlist),
 492                                          HTML::td(HTML::em(getAccessDescription($access)))));
 493             */
 494         }
 495         if ($type == 'default')
 496             $table->setAttr('style','border: dotted thin black; background-color:#eee;');
 497         elseif ($type == 'inherited')
 498             $table->setAttr('style','border: dotted thin black; background-color:#ddd;');
 499         elseif ($type == 'page')
 500             $table->setAttr('style','border: solid thin black; font-weight: bold;');
 501         return $table;
 502     }
 503
 504     // this is just a bad hack for testing
 505     // simplify the ACL to a unix-like "rwx------" string
 506     function asRwxString($owner,$group=false) {
 507         global $request;
 508         // simplify object => rwxrw---x+ string as in cygwin (+ denotes additional ACLs)
 509         $perm =& $this->perm;
 510         // get effective user and group
 511         $s = '---------';
 512         if (isset($perm['view'][$owner]) or
 513             (isset($perm['view'][ACL_AUTHENTICATED]) and $request->_user->isAuthenticated()))
 514             $s[0] = 'r';
 515         if (isset($perm['edit'][$owner]) or
 516             (isset($perm['edit'][ACL_AUTHENTICATED]) and $request->_user->isAuthenticated()))
 517             $s[1] = 'w';
 518         if (isset($perm['change'][$owner]) or
 519             (isset($perm['change'][ACL_AUTHENTICATED]) and $request->_user->isAuthenticated()))
 520             $s[2] = 'x';
 521         if (!empty($group)) {
 522             if (isset($perm['view'][$group]) or
 523                 (isset($perm['view'][ACL_AUTHENTICATED]) and $request->_user->isAuthenticated()))
 524                 $s[3] = 'r';
 525             if (isset($perm['edit'][$group]) or
 526                 (isset($perm['edit'][ACL_AUTHENTICATED]) and $request->_user->isAuthenticated()))
 527                 $s[4] = 'w';
 528             if (isset($perm['change'][$group]) or
 529                 (isset($perm['change'][ACL_AUTHENTICATED]) and $request->_user->isAuthenticated()))
 530                 $s[5] = 'x';
 531         }
 532         if (isset($perm['view'][ACL_EVERY]) or
 533             (isset($perm['view'][ACL_AUTHENTICATED]) and $request->_user->isAuthenticated()))
 534             $s[6] = 'r';
 535         if (isset($perm['edit'][ACL_EVERY]) or
 536             (isset($perm['edit'][ACL_AUTHENTICATED]) and $request->_user->isAuthenticated()))
 537             $s[7] = 'w';
 538         if (isset($perm['change'][ACL_EVERY]) or
 539             (isset($perm['change'][ACL_AUTHENTICATED]) and $request->_user->isAuthenticated()))
 540             $s[8] = 'x';
 541         return $s;
 542     }
 543 }
 544
 545 // $Log: not supported by cvs2svn $
 546 // Revision 1.7  2004/02/28 22:25:07  rurban
 547 // First PagePerm implementation:
 548 //
 549 // $Theme->setAnonEditUnknownLinks(false);
 550 //
 551 // Layout improvement with dangling links for mostly closed wiki's:
 552 // If false, only users with edit permissions will be presented the
 553 // special wikiunknown class with "?" and Tooltip.
 554 // If true (default), any user will see the ?, but will be presented
 555 // the PrintLoginForm on a click.
 556 //
 557 // Revision 1.6  2004/02/24 15:20:05  rurban
 558 // fixed minor warnings: unchecked args, POST => Get urls for sortby e.g.
 559 //
 560 // Revision 1.5  2004/02/23 21:30:25  rurban
 561 // more PagePerm stuff: (working against 1.4.0)
 562 //   ACL editing and simplification of ACL's to simple rwx------ string
 563 //   not yet working.
 564 //
 565 // Revision 1.4  2004/02/12 13:05:36  rurban
 566 // Rename functional for PearDB backend
 567 // some other minor changes
 568 // SiteMap comes with a not yet functional feature request: includepages (tbd)
 569 //
 570 // Revision 1.3  2004/02/09 03:58:12  rurban
 571 // for now default DB_SESSION to false
 572 // PagePerm:
 573 //   * not existing perms will now query the parent, and not
 574 //     return the default perm
 575 //   * added pagePermissions func which returns the object per page
 576 //   * added getAccessDescription
 577 // WikiUserNew:
 578 //   * added global ->prepare (not yet used) with smart user/pref/member table prefixing.
 579 //   * force init of authdbh in the 2 db classes
 580 // main:
 581 //   * fixed session handling (not triple auth request anymore)
 582 //   * don't store cookie prefs with sessions
 583 // stdlib: global obj2hash helper from _AuthInfo, also needed for PagePerm
 584 //
 585 // Revision 1.2  2004/02/08 13:17:48  rurban
 586 // This should be the functionality. Needs testing and some minor todos.
 587 //
 588 // Revision 1.1  2004/02/08 12:29:30  rurban
 589 // initial version, not yet hooked into lib/main.php
 590 //
 591 //
 592
 593 // Local Variables:
 594 // mode: php
 595 // tab-width: 8
 596 // c-basic-offset: 4
 597 // c-hanging-comment-ender-p: nil
 598 // indent-tabs-mode: nil
 599 // End:
 600 ?>