2 rcs_id('$Id: PagePerm.php,v 1.14 2004-05-15 22:54:49 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 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)
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
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,
42 Request::getDisallowedActionDescription($action)
43 helper to localize the _notAuthorized message per action,
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
52 The defined main.php actions map to simplier access types:
55 create => edit or create
59 list in PageList => list
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');
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) {
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());
85 return array('inherited',pagePermissions(getParentPage($pagename)));
87 } elseif ($perm = getPagePermissions($page)) {
88 return array('page',$perm);
89 // or no permissions defined; returned inherited permissions, to be displayed in gray
91 return array('inherited',pagePermissions(getParentPage($pagename)));
95 function pagePermissionsSimpleFormat($perm_tree,$owner,$group=false) {
96 list($type,$perm) = pagePermissionsAcl($perm_tree[0], $perm_tree);
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'))
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));
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];
126 return array($type,$perm);
131 function pagePermissionsAclFormat($perm_tree, $editable=false) {
132 list($type,$perm) = pagePermissionsAcl($perm_tree[0], $perm_tree);
134 return $perm->asEditableTable($type);
136 return $perm->asTable($type);
140 * Check permission per page.
141 * Returns true or false.
143 function mayAccessPage ($access, $pagename) {
144 return _requiredAuthorityForPagename($access, $pagename);
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?
153 function requiredAuthorityForPage ($action) {
154 $auth = _requiredAuthorityForPagename(action2access($action),
155 $GLOBALS['request']->getArg('pagename'));
156 assert($auth !== -1);
158 return $GLOBALS['request']->_user->_level;
160 return WIKIAUTH_UNOBTAINABLE;
163 // Translate action or plugin to the simplier access types:
164 function action2access ($action) {
183 $page = $request->getPage();
184 $current = $page->getCurrentRevision();
185 if ($current->hasDefaultContents())
192 // probably create/edit but we cannot check all page permissions, can we?
199 //Todo: Plugins should be able to override its access type
200 if (isWikiWord($action))
208 // Recursive helper to do the real work
209 function _requiredAuthorityForPagename($access, $pagename) {
211 $page = $request->getPage($pagename);
212 // Page not found; check against default permissions
213 if (! $page->exists() ) {
214 $perm = new PagePermission();
215 return ($perm->isAuthorized($access,$request->_user) === true);
217 // no ACL defined; check for special dotfile or walk down
218 if (! ($perm = getPagePermissions($page))) {
219 if ($pagename[0] == '.') {
220 $perm = new PagePermission(PagePermission::dotPerms());
221 return ($perm->isAuthorized($access,$request->_user) === true);
223 return _requiredAuthorityForPagename($access,getParentPage($pagename));
225 // ACL defined; check if isAuthorized returns true or false or undecided
226 $authorized = $perm->isAuthorized($access,$request->_user);
227 if ($authorized != -1) // -1 for undecided
230 return _requiredAuthorityForPagename($access,getParentPage($pagename));
234 * @param string $pagename page from which the parent page is searched.
235 * @return string parent pagename or the (possibly pseudo) dot-pagename.
237 function getParentPage($pagename) {
238 if (isSubPage($pagename)) {
239 return subPageSlice($pagename,0);
245 // Read the ACL from the page
246 // Done: Not existing pages should NOT be queried.
247 // Check the parent page instead and don't take the default ACL's
248 function getPagePermissions ($page) {
249 if ($hash = $page->get('perm')) // hash => object
250 return new PagePermission(unserialize($hash));
255 // Store the ACL in the page
256 function setPagePermissions ($page,$perm) {
260 function getAccessDescription($access) {
261 static $accessDescriptions;
262 if (! $accessDescriptions) {
263 $accessDescriptions = array(
264 'list' => _("List this page and all subpages"),
265 'view' => _("View this page and all subpages"),
266 'edit' => _("Edit this page and all subpages"),
267 'create' => _("Create a new (sub)page"),
268 'dump' => _("Download the page contents"),
269 'change' => _("Change page attributes"),
270 'remove' => _("Remove this page"),
273 if (in_array($access, array_keys($accessDescriptions)))
274 return $accessDescriptions[$access];
280 * The ACL object per page. It is stored in a page, but can also
281 * be merged with ACL's from other pages or taken from the master (pseudo) dot-file.
283 * A hash of "access" => "requires" pairs.
284 * "access" is a shortcut for common actions, which map to main.php actions
285 * "requires" required username or groupname or any special group => true or false
287 * Define any special rules here, like don't list dot-pages.
289 class PagePermission {
292 function PagePermission($hash = array()) {
293 $this->_group = &WikiGroup::getGroup($GLOBALS['request']);
294 if (is_array($hash) and !empty($hash)) {
295 $accessTypes = $this->accessTypes();
296 foreach ($hash as $access => $requires) {
297 if (in_array($access,$accessTypes))
298 $this->perm[$access] = $requires;
300 trigger_error(sprintf(_("Unsupported ACL access type %s ignored."),$access),
304 // set default permissions, the so called dot-file acl's
305 $this->perm = $this->defaultPerms();
311 * The workhorse to check the user against the current ACL pairs.
312 * Must translate the various special groups to the actual users settings
313 * (userid, group membership).
315 function isAuthorized($access,$user) {
316 if (!empty($this->perm{$access})) {
317 foreach ($this->perm[$access] as $group => $bool) {
318 if ($this->isMember($user,$group)) {
323 return -1; // undecided
327 * Translate the various special groups to the actual users settings
328 * (userid, group membership).
330 function isMember($user,$group) {
332 if ($group === ACL_EVERY) return true;
333 if (!isset($this->_group)) $member =& WikiGroup::getGroup($request);
334 else $member =& $this->_group;
335 //$user = & $request->_user;
336 if ($group === ACL_ADMIN) // WIKI_ADMIN or member of _("Administrators")
337 return $user->isAdmin() or
338 ($user->isAuthenticated() and
339 $member->isMember(GROUP_ADMIN));
340 if ($group === ACL_ANONYMOUS)
341 return ! $user->isSignedIn();
342 if ($group === ACL_BOGOUSERS)
343 if (ENABLE_USER_NEW) return isa($user,'_BogoUser');
344 else return isWikiWord($user->UserName());
345 if ($group === ACL_HASHOMEPAGE)
346 return $user->hasHomePage();
347 if ($group === ACL_SIGNED)
348 return $user->isSignedIn();
349 if ($group === ACL_AUTHENTICATED)
350 return $user->isAuthenticated();
351 if ($group === ACL_OWNER) {
352 $page = $request->getPage();
353 return ($page->get('author') === $user->UserName() and
354 $user->isAuthenticated());
356 if ($group === ACL_CREATOR) {
357 $page = $request->getPage();
358 $rev = $page->getRevision(1);
359 return ($rev->get('author') === $user->UserName() and
360 $user->isAuthenticated());
362 /* Or named groups or usernames.
363 Note: We don't seperate groups and users here.
364 Users overrides groups with the same name. */
365 return $user->UserName() === $group or
366 $member->isMember($group);
370 * returns hash of default permissions.
371 * check if the page '.' exists and returns this instead.
373 function defaultPerms() {
374 //Todo: check for the existance of '.' and take this instead.
375 //Todo: honor more index.php auth settings here
376 $perm = array('view' => array(ACL_EVERY => true),
377 'edit' => array(ACL_EVERY => true),
378 'create' => array(ACL_EVERY => true),
379 'list' => array(ACL_EVERY => true),
380 'remove' => array(ACL_ADMIN => true,
382 'change' => array(ACL_ADMIN => true,
384 if (defined('ZIPDUMP_AUTH') && ZIPDUMP_AUTH)
385 $perm['dump'] = array(ACL_ADMIN => true,
388 $perm['dump'] = array(ACL_EVERY => true);
389 if (defined('REQUIRE_SIGNIN_BEFORE_EDIT') && REQUIRE_SIGNIN_BEFORE_EDIT)
390 $perm['edit'] = array(ACL_SIGNED => true);
391 if (defined('ALLOW_ANON_USER') && ! ALLOW_ANON_USER) {
392 if (defined('ALLOW_BOGO_USER') && ALLOW_BOGO_USER) {
393 $perm['view'] = array(ACL_BOGOUSER => true);
394 $perm['edit'] = array(ACL_BOGOUSER => true);
395 } elseif (defined('ALLOW_USER_PASSWORDS') && ALLOW_USER_PASSWORDS) {
396 $perm['view'] = array(ACL_AUTHENTICATED => true);
397 $perm['edit'] = array(ACL_AUTHENTICATED => true);
399 $perm['view'] = array(ACL_SIGNED => true);
400 $perm['edit'] = array(ACL_SIGNED => true);
407 foreach ($this->perm as $access => $groups) {
408 foreach ($groups as $group => $bool) {
409 $this->perm[$access][$group] = (boolean) $bool;
415 * returns list of all supported access types.
417 function accessTypes() {
418 return array_keys($this->defaultPerms());
422 * special permissions for dot-files, beginning with '.'
423 * maybe also for '_' files?
425 function dotPerms() {
426 $def = array(ACL_ADMIN => true,
429 foreach ($this->accessTypes() as $access) {
430 $perm[$access] = $def;
436 * dead code. not needed inside the object. see getPagePermissions($page)
438 function retrieve($page) {
439 $hash = $page->get('perm');
440 if ($hash) // hash => object
441 $perm = new PagePermission(unserialize($hash));
443 $perm = new PagePermission();
448 function store($page) {
451 return $page->set('perm',serialize($this->perm));
454 function groupName ($group) {
455 if ($group[0] == '_') return constant("GROUP".$group);
459 /* type: page, default, inherited */
460 function asTable($type) {
461 $table = HTML::table();
462 foreach ($this->perm as $access => $perms) {
463 $td = HTML::table(array('class' => 'cal','valign' => 'top'));
464 foreach ($perms as $group => $bool) {
465 $td->pushContent(HTML::tr(HTML::td(array('align'=>'right'),$group),
466 HTML::td($bool ? '[X]' : '[ ]')));
468 $table->pushContent(HTML::tr(array('valign' => 'top'),
469 HTML::td($access),HTML::td($td)));
471 if ($type == 'default')
472 $table->setAttr('style','border: dotted thin black; background-color:#eee;');
473 elseif ($type == 'inherited')
474 $table->setAttr('style','border: dotted thin black; background-color:#ddd;');
475 elseif ($type == 'page')
476 $table->setAttr('style','border: solid thin black; font-weight: bold;');
480 /* type: page, default, inherited */
481 function asEditableTable($type) {
483 if (!isset($this->_group)) {
484 $this->_group =& WikiGroup::getGroup($GLOBALS['request']);
486 $table = HTML::table();
487 $table->pushContent(HTML::tr(
488 HTML::th(array('align' => 'left'),
490 HTML::th(array('align'=>'right'),
492 HTML::th(_("Grant")),
493 HTML::th(_("Del/Add")),
494 HTML::th(_("Description"))));
496 $allGroups = $this->_group->_specialGroups();
497 foreach ($this->_group->getAllGroupsIn() as $group) {
498 if (!in_array($group,$this->_group->specialGroups()))
499 $allGroups[] = $group;
501 //array_unique(array_merge($this->_group->getAllGroupsIn(),
502 $deletesrc = $Theme->getButtonURL('delete');
503 $nbsp = HTML::raw(' ');
504 foreach ($this->perm as $access => $groups) {
505 //$permlist = HTML::table(array('class' => 'cal','valign' => 'top'));
507 $newperm = HTML::input(array('type' => 'checkbox',
508 'name' => "acl[_new_perm][$access]",
510 $addbutton = HTML::input(array('type' => 'checkbox',
511 'name' => "acl[_add_group][$access]",
514 'title' => _("Add this ACL"),
516 $newgroup = HTML::select(array('name' => "acl[_new_group][$access]",
517 'style'=> 'text-align: right;',
519 foreach ($allGroups as $groupname) {
520 if (!isset($groups[$groupname]))
521 $newgroup->pushContent(HTML::option(array('value' => $groupname),
522 $this->groupName($groupname)));
524 if (empty($groups)) {
525 $addbutton->setAttr('checked','checked');
526 $newperm->setAttr('checked','checked');
528 HTML::tr(array('valign' => 'top'),
529 HTML::td(HTML::strong($access.":")),
531 HTML::td($nbsp,$newperm),
532 HTML::td($nbsp,$addbutton),
533 HTML::td(HTML::em(getAccessDescription($access)))));
535 foreach ($groups as $group => $bool) {
536 $checkbox = HTML::input(array('type' => 'checkbox',
537 'name' => "acl[$access][$group]",
538 'title' => _("Allow / Deny"),
540 if ($bool) $checkbox->setAttr('checked','checked');
541 $checkbox = HTML(HTML::input(array('type' => 'hidden',
542 'name' => "acl[$access][$group]",
545 $deletebutton = HTML::input(array('type' => 'checkbox',
546 'name' => "acl[_del_group][$access][$group]",
547 //'src' => $deletesrc,
549 'title' => _("Delete this ACL"),
554 HTML::td(HTML::strong($access.":")),
555 HTML::td(array('class' => 'cal-today','align'=>'right'),
556 $this->groupName($group)),
557 HTML::td($nbsp,$checkbox),
558 HTML::td($nbsp,$deletebutton),
559 HTML::td(HTML::em(getAccessDescription($access)))));
565 HTML::td(array('class' => 'cal-today','align'=>'right'),
566 $this->groupName($group)),
567 HTML::td($nbsp,$checkbox),
568 HTML::td($nbsp,$deletebutton),
574 HTML::tr(array('valign' => 'top'),
575 HTML::td(array('align'=>'right'),_("add ")),
577 HTML::td($nbsp,$newperm),
578 HTML::td($nbsp,$addbutton),
579 HTML::td(HTML::small(_("Check to add this Acl")))));
581 if ($type == 'default')
582 $table->setAttr('style','border: dotted thin black; background-color:#eee;');
583 elseif ($type == 'inherited')
584 $table->setAttr('style','border: dotted thin black; background-color:#ddd;');
585 elseif ($type == 'page')
586 $table->setAttr('style','border: solid thin black; font-weight: bold;');
590 // this is just a bad hack for testing
591 // simplify the ACL to a unix-like "rwx------" string
592 function asRwxString($owner,$group=false) {
594 // simplify object => rwxrw---x+ string as in cygwin (+ denotes additional ACLs)
595 $perm =& $this->perm;
596 // get effective user and group
598 if (isset($perm['view'][$owner]) or
599 (isset($perm['view'][ACL_AUTHENTICATED]) and $request->_user->isAuthenticated()))
601 if (isset($perm['edit'][$owner]) or
602 (isset($perm['edit'][ACL_AUTHENTICATED]) and $request->_user->isAuthenticated()))
604 if (isset($perm['change'][$owner]) or
605 (isset($perm['change'][ACL_AUTHENTICATED]) and $request->_user->isAuthenticated()))
607 if (!empty($group)) {
608 if (isset($perm['view'][$group]) or
609 (isset($perm['view'][ACL_AUTHENTICATED]) and $request->_user->isAuthenticated()))
611 if (isset($perm['edit'][$group]) or
612 (isset($perm['edit'][ACL_AUTHENTICATED]) and $request->_user->isAuthenticated()))
614 if (isset($perm['change'][$group]) or
615 (isset($perm['change'][ACL_AUTHENTICATED]) and $request->_user->isAuthenticated()))
618 if (isset($perm['view'][ACL_EVERY]) or
619 (isset($perm['view'][ACL_AUTHENTICATED]) and $request->_user->isAuthenticated()))
621 if (isset($perm['edit'][ACL_EVERY]) or
622 (isset($perm['edit'][ACL_AUTHENTICATED]) and $request->_user->isAuthenticated()))
624 if (isset($perm['change'][ACL_EVERY]) or
625 (isset($perm['change'][ACL_AUTHENTICATED]) and $request->_user->isAuthenticated()))
631 // $Log: not supported by cvs2svn $
632 // Revision 1.13 2004/05/15 19:48:33 rurban
633 // fix some too loose PagePerms for signed, but not authenticated users
634 // (admin, owner, creator)
635 // no double login page header, better login msg.
636 // moved action_pdf to lib/pdf.php
638 // Revision 1.12 2004/05/04 22:34:25 rurban
641 // Revision 1.11 2004/05/02 21:26:38 rurban
642 // limit user session data (HomePageHandle and auth_dbi have to invalidated anyway)
643 // because they will not survive db sessions, if too large.
644 // extended action=upgrade
645 // some WikiTranslation button work
646 // revert WIKIAUTH_UNOBTAINABLE (need it for main.php)
647 // some temp. session debug statements
649 // Revision 1.10 2004/04/29 22:32:56 zorloc
650 // Slightly more elegant fix. Instead of WIKIAUTH_FORBIDDEN, the current user's level + 1 is returned on a false.
652 // Revision 1.9 2004/04/29 17:18:19 zorloc
653 // Fixes permission failure issues. With PagePermissions and Disabled Actions when user did not have permission WIKIAUTH_FORBIDDEN was returned. In WikiUser this was ok because WIKIAUTH_FORBIDDEN had a value of 11 -- thus no user could perform that action. But WikiUserNew has a WIKIAUTH_FORBIDDEN value of -1 -- thus a user without sufficent permission to do anything. The solution is a new high value permission level (WIKIAUTH_UNOBTAINABLE) to be the default level for access failure.
655 // Revision 1.8 2004/03/14 16:24:35 rurban
656 // authenti(fi)cation spelling
658 // Revision 1.7 2004/02/28 22:25:07 rurban
659 // First PagePerm implementation:
661 // $Theme->setAnonEditUnknownLinks(false);
663 // Layout improvement with dangling links for mostly closed wiki's:
664 // If false, only users with edit permissions will be presented the
665 // special wikiunknown class with "?" and Tooltip.
666 // If true (default), any user will see the ?, but will be presented
667 // the PrintLoginForm on a click.
669 // Revision 1.6 2004/02/24 15:20:05 rurban
670 // fixed minor warnings: unchecked args, POST => Get urls for sortby e.g.
672 // Revision 1.5 2004/02/23 21:30:25 rurban
673 // more PagePerm stuff: (working against 1.4.0)
674 // ACL editing and simplification of ACL's to simple rwx------ string
677 // Revision 1.4 2004/02/12 13:05:36 rurban
678 // Rename functional for PearDB backend
679 // some other minor changes
680 // SiteMap comes with a not yet functional feature request: includepages (tbd)
682 // Revision 1.3 2004/02/09 03:58:12 rurban
683 // for now default DB_SESSION to false
685 // * not existing perms will now query the parent, and not
686 // return the default perm
687 // * added pagePermissions func which returns the object per page
688 // * added getAccessDescription
690 // * added global ->prepare (not yet used) with smart user/pref/member table prefixing.
691 // * force init of authdbh in the 2 db classes
693 // * fixed session handling (not triple auth request anymore)
694 // * don't store cookie prefs with sessions
695 // stdlib: global obj2hash helper from _AuthInfo, also needed for PagePerm
697 // Revision 1.2 2004/02/08 13:17:48 rurban
698 // This should be the functionality. Needs testing and some minor todos.
700 // Revision 1.1 2004/02/08 12:29:30 rurban
701 // initial version, not yet hooked into lib/main.php
709 // c-hanging-comment-ender-p: nil
710 // indent-tabs-mode: nil