4 * Copyright 1999-2008 $ThePhpWikiProgrammingTeam
5 * Copyright (C) 2008-2010 Marc-Etienne Vargenau, Alcatel-Lucent
6 * Copyright (C) 2009 Roger Guignard, Alcatel-Lucent
8 * This file is part of PhpWiki.
10 * PhpWiki is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * PhpWiki is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 define ('USE_PREFS_IN_PAGE', true);
27 //include "lib/config.php";
28 require_once(dirname(__FILE__) . "/stdlib.php");
29 require_once 'lib/Request.php';
30 require_once 'lib/WikiDB.php';
32 require_once 'lib/WikiUserNew.php';
34 require_once 'lib/WikiUser.php';
35 require_once 'lib/WikiGroup.php';
37 require_once 'lib/PagePerm.php';
40 * Check permission per page.
41 * Returns true or false.
43 function mayAccessPage($access, $pagename)
46 return _requiredAuthorityForPagename($access, $pagename); // typically [10-20ms per page]
51 class WikiRequest extends Request
55 function WikiRequest()
57 $this->_dbi = WikiDB::open($GLOBALS['DBParams']);
58 // first mysql request costs [958ms]! [670ms] is mysql_connect()
60 if (in_array('File', $this->_dbi->getAuthParam('USER_AUTH_ORDER'))) {
61 // force our local copy, until the pear version is fixed.
62 include_once(dirname(__FILE__) . "/pear/File_Passwd.php");
64 if (ENABLE_USER_NEW) {
65 // Preload all necessary userclasses. Otherwise session => __PHP_Incomplete_Class_Name
66 // There's no way to demand-load it later. This way it's much slower, but needs slightly
67 // less memory than loading all.
69 include_once 'lib/WikiUser/BogoLogin.php';
70 // UserPreferences POST Update doesn't reach this.
71 foreach ($GLOBALS['USER_AUTH_ORDER'] as $method) {
72 include_once("lib/WikiUser/$method.php");
74 switch (DATABASE_TYPE) {
76 include_once 'lib/WikiUser/PearDb.php';
79 include_once 'lib/WikiUser/AdoDb.php';
82 include_once 'lib/WikiUser/PdoDb.php';
89 include_once 'lib/DbSession.php';
91 if (defined('READONLY') and !READONLY) // READONLY might be set later
92 $this->_dbsession = new DbSession($dbi, $dbi->getParam('prefix')
93 . $dbi->getParam('db_session_table'));
96 // Fixme: Does pear reset the error mask to 1? We have to find the culprit
97 //$x = error_reporting();
99 $this->version = phpwiki_version();
100 $this->Request(); // [90ms]
103 $this->setArg('pagename', $this->_deducePagename());
104 $this->setArg('action', $this->_deduceAction());
106 if ((DEBUG & _DEBUG_SQL)
107 or (DATABASE_OPTIMISE_FREQUENCY > 0 and
108 (time() % DATABASE_OPTIMISE_FREQUENCY == 0))
110 if ($this->_dbi->_backend->optimize())
111 trigger_error(_("Optimizing database"), E_USER_NOTICE);
114 // Restore auth state. This doesn't check for proper authorization!
115 $userid = $this->_deduceUsername();
116 if (ENABLE_USER_NEW) {
117 if (isset($this->_user) and
118 !empty($this->_user->_authhow) and
119 $this->_user->_authhow == 'session'
121 // users might switch in a session between the two objects.
122 // restore old auth level here or in updateAuthAndPrefs?
123 //$user = $this->getSessionVar('wiki_user');
124 // revive db handle, because these don't survive sessions
125 if (isset($this->_user) and
126 (!isa($this->_user, WikiUserClassname())
127 or (strtolower(get_class($this->_user)) == '_passuser')
128 or (strtolower(get_class($this->_user)) == '_fusionforgepassuser'))
130 $this->_user = WikiUser($userid, $this->_user->_prefs);
132 // revive other db handle
133 if (isset($this->_user->_prefs->_method)
134 and ($this->_user->_prefs->_method == 'SQL'
135 or $this->_user->_prefs->_method == 'ADODB'
136 or $this->_user->_prefs->_method == 'PDO'
137 or $this->_user->_prefs->_method == 'HomePage')
139 $this->_user->_HomePagehandle = $this->getPage($userid);
141 // need to update the lockfile filehandle
142 if (isa($this->_user, '_FilePassUser')
143 and $this->_user->_file->lockfile
144 and !$this->_user->_file->fplock
146 //$level = $this->_user->_level;
147 $this->_user = UpgradeUser($this->_user,
148 new _FilePassUser($userid,
149 $this->_user->_prefs,
150 $this->_user->_file->filename));
151 //$this->_user->_level = $level;
153 $this->_prefs = & $this->_user->_prefs;
155 $user = WikiUser($userid);
156 $this->_user = & $user;
157 $this->_prefs = & $this->_user->_prefs;
160 $this->_user = new WikiUser($this, $userid);
161 $this->_prefs = $this->_user->getPreferences();
165 function initializeLang()
167 // check non-default pref lang
168 if (empty($this->_prefs->_prefs['lang']))
170 $_lang = $this->_prefs->_prefs['lang'];
171 if (isset($_lang->lang) and $_lang->lang != $GLOBALS['LANG']) {
172 $user_lang = $_lang->lang;
173 //check changed LANG and THEME inside a session.
174 // (e.g. by using another baseurl)
175 if (isset($this->_user->_authhow) and $this->_user->_authhow == 'session')
176 $user_lang = $GLOBALS['LANG'];
177 update_locale($user_lang);
178 FindLocalizedButtonFile(".", 'missing_ok', 'reinit');
180 //if (empty($_lang->lang) and $GLOBALS['LANG'] != $_lang->default_value) ;
183 function initializeTheme($when = 'default')
186 // if when = 'default', then first time init (default theme, ...)
187 // if when = 'login', then check some callbacks
188 // and maybe the theme changed (other theme defined in pref)
189 // if when = 'logout', then check other callbacks
190 // and maybe the theme changed (back to default theme)
192 // Load non-default theme (when = login)
193 if (!empty($this->_prefs->_prefs['theme'])) {
194 $_theme = $this->_prefs->_prefs['theme'];
195 if (isset($_theme) and isset($_theme->theme))
196 $user_theme = $_theme->theme;
197 elseif (isset($_theme) and isset($_theme->default_value))
198 $user_theme = $_theme->default_value; else
201 $user_theme = $this->getPref('theme');
203 //check changed LANG and THEME inside a session.
204 // (e.g. by using another baseurl)
205 if (isset($this->_user->_authhow)
206 and $this->_user->_authhow == 'session'
207 and !isset($_theme->theme)
209 and $user_theme != THEME
211 include_once 'themes/'. THEME . '/themeinfo.php';
213 if (empty($WikiTheme) and $user_theme) {
214 if (strcspn($user_theme, "./\x00]") != strlen($user_theme)) {
215 trigger_error(sprintf("invalid theme '%s': Invalid characters detected",
218 $user_theme = "default";
220 if (!$user_theme) $user_theme = "default";
221 include_once "themes/$user_theme/themeinfo.php";
223 if (empty($WikiTheme) and defined('THEME'))
224 include_once 'themes/'. THEME . '/themeinfo.php';
225 if (empty($WikiTheme))
226 include_once 'themes/default/themeinfo.php';
227 assert(!empty($WikiTheme));
229 // Do not execute global init code anymore
231 // WikiTheme callbacks
232 if ($when == 'login') {
233 $WikiTheme->CbUserLogin($this, $this->_user->_userid);
234 if (!$this->_user->hasHomePage()) { // NewUser
235 $WikiTheme->CbNewUserLogin($this, $this->_user->_userid);
236 if (in_array($this->getArg('action'), array('edit', 'create')))
237 $WikiTheme->CbNewUserEdit($this, $this->_user->_userid);
239 } elseif ($when == 'logout') {
240 $WikiTheme->CbUserLogout($this, $this->_user->_userid);
241 } elseif ($when == 'default') {
243 if ($this->_user->_level > 0 and !$this->_user->hasHomePage()) { // NewUser
244 if (in_array($this->getArg('action'), array('edit', 'create')))
245 $WikiTheme->CbNewUserEdit($this, $this->_user->_userid);
250 // This really maybe should be part of the constructor, but since it
251 // may involve HTML/template output, the global $request really needs
252 // to be initialized before we do this stuff.
253 // [50ms]: 36ms if wikidb_page::exists
254 function updateAuthAndPrefs()
257 if (isset($this->_user) and (!isa($this->_user, WikiUserClassname()))) {
258 $this->_user = false;
260 // Handle authentication request, if any.
261 if ($auth_args = $this->getArg('auth')) {
262 $this->setArg('auth', false);
263 $this->_handleAuthRequest($auth_args); // possible NORETURN
264 } elseif (!$this->_user
265 or (isa($this->_user, WikiUserClassname())
266 and !$this->_user->isSignedIn())
268 // If not auth request, try to sign in as saved user.
269 if (($saved_user = $this->getPref('userid')) != false) {
270 $this->_signIn($saved_user);
274 $action = $this->getArg('action');
276 // Save preferences in session and cookie
277 if ((defined('WIKI_XMLRPC') and !WIKI_XMLRPC) or $action != 'xmlrpc') {
278 if (isset($this->_user) and $this->_user->_userid) {
279 if (!isset($this->_user->_authhow) or $this->_user->_authhow != 'session') {
280 $this->_user->setPreferences($this->_prefs, true);
283 $tmpuser = $this->_user; // clone it
284 $this->setSessionVar('wiki_user', $tmpuser);
288 // Ensure user has permissions for action
289 // HACK ALERT: We may not set the request arg to create,
290 // since the pageeditor has an ugly logic for action == create.
291 if ($action == 'edit' or $action == 'create') {
292 $page = $this->getPage();
293 if (!$page->exists())
298 if (!ENABLE_PAGEPERM) { // Bug #1438392 by Matt Brown
299 $require_level = $this->requiredAuthority($action);
300 if (!$this->_user->hasAuthority($require_level))
301 $this->_notAuthorized($require_level); // NORETURN
303 // novatrope patch to let only _AUTHENTICATED view pages.
304 // If there's not enough authority or forbidden, ask for a password,
305 // unless it's explicitly unobtainable. Some bad magic though.
306 if ($this->requiredAuthorityForAction($action) == WIKIAUTH_UNOBTAINABLE) {
307 $require_level = $this->requiredAuthority($action);
308 $this->_notAuthorized($require_level); // NORETURN
315 if (isset($this->_user))
318 return $GLOBALS['ForbiddenUser'];
321 function & getGroup()
323 if (isset($this->_user) and isset($this->_user->_group))
324 return $this->_user->_group;
326 // Debug Strict: Only variable references should be returned by reference
327 $this->_user->_group = WikiGroup::getGroup();
328 return $this->_user->_group;
332 function & getPrefs()
334 return $this->_prefs;
337 // Convenience function:
338 function getPref($key)
340 if (isset($this->_prefs)) {
341 return $this->_prefs->get($key);
351 * Get requested page from the page database.
352 * By default it will grab the page requested via the URL
354 * This is a convenience function.
355 * @param string $pagename Name of page to get.
356 * @return WikiDB_Page Object with methods to pull data from
357 * database for the page requested.
359 function getPage($pagename = false)
361 //if (!isset($this->_dbi)) $this->getDbh();
363 $pagename = $this->getArg('pagename');
364 return $this->_dbi->getPage($pagename);
367 /** Get URL for POST actions.
369 * Officially, we should just use SCRIPT_NAME (or some such),
370 * but that causes problems when we try to issue a redirect, e.g.
371 * after saving a page.
373 * Some browsers (at least NS4 and Mozilla 0.97 won't accept
374 * a redirect from a page to itself.)
376 * So, as a HACK, we include pagename and action as query args in
377 * the URL. (These should be ignored when we receive the POST
380 function getPostURL($pagename = false)
382 global $HTTP_GET_VARS;
384 if ($pagename === false)
385 $pagename = $this->getArg('pagename');
386 $action = $this->getArg('action');
387 if (!empty($HTTP_GET_VARS['start_debug'])) // zend ide support
388 return WikiURL($pagename, array('action' => $action, 'start_debug' => 1));
389 elseif ($action == 'edit')
390 return WikiURL($pagename); else
391 return WikiURL($pagename, array('action' => $action));
394 function _handleAuthRequest($auth_args)
396 if (!is_array($auth_args))
399 // Ignore password unless POST'ed.
400 if (!$this->isPost())
401 unset($auth_args['passwd']);
403 $olduser = $this->_user;
404 $user = $this->_user->AuthCheck($auth_args);
405 if (is_string($user)) {
406 // Login attempt failed.
407 $fail_message = $user;
408 $auth_args['pass_required'] = true;
409 // if clicked just on to the "sign in as:" button dont print invalid username.
410 if (!empty($auth_args['login']) and empty($auth_args['userid']))
412 // If no password was submitted, it's not really
413 // a failure --- just need to prompt for password...
414 if (!ALLOW_USER_PASSWORDS
416 and !isset($auth_args['passwd'])
418 $fail_message = false;
420 $olduser->PrintLoginForm($this, $auth_args, $fail_message, 'newpage');
421 $this->finish(); //NORETURN
422 } elseif (isa($user, WikiUserClassname())) {
423 // Successful login (or logout.)
424 $this->_setUser($user);
426 // Login request cancelled.
431 * Attempt to sign in (bogo-login).
435 * @param $userid string Userid to attempt to sign in as.
438 function _signIn($userid)
440 if (ENABLE_USER_NEW) {
442 $this->_user = new _BogoUser($userid);
443 // FIXME: is this always false? shouldn't we try passuser first?
445 $this->_user = new _PassUser($userid);
448 $this->_user = new WikiUser($this, $userid);
450 $user = $this->_user->AuthCheck(array('userid' => $userid));
451 if (isa($user, WikiUserClassname())) {
452 $this->_setUser($user); // success!
456 // login or logout or restore state
457 function _setUser(&$user)
459 $this->_user =& $user;
460 if (defined('MAIN_setUser')) return; // don't set cookies twice
461 $this->setCookieVar(getCookieName(), $user->getAuthenticatedId(),
462 COOKIE_EXPIRATION_DAYS, COOKIE_DOMAIN);
463 $isSignedIn = $user->isSignedIn();
465 $user->_authhow = 'signin';
468 // Save userid to prefs..
469 if (empty($this->_user->_prefs)) {
470 $this->_user->_prefs = $this->_user->getPreferences();
471 $this->_prefs =& $this->_user->_prefs;
473 $this->_user->_group = $this->getGroup();
474 $this->setSessionVar('wiki_user', $user);
475 $this->_prefs->set('userid',
476 $isSignedIn ? $user->getId() : '');
477 if (!ENABLE_USER_NEW) {
478 if (empty($this->_user->_request))
479 $this->_user->_request =& $this;
480 if (empty($this->_user->_dbi))
481 $this->_user->_dbi =& $this->_dbi;
483 $this->initializeTheme($isSignedIn ? 'login' : 'logout');
484 define('MAIN_setUser', true);
487 /* Permission system */
488 function getLevelDescription($level)
490 static $levels = false;
491 if (!$levels) // This looks like a Visual Basic hack. For the very same reason. "0"
492 $levels = array('x-1' => _("FORBIDDEN"),
497 'x100' => _("UNOBTAINABLE"));
500 if (!empty($levels["x" . $level]))
501 return $levels["x" . $level];
506 function _notAuthorized($require_level)
508 // Display the authority message in the Wiki's default
509 // language, in case it is not english.
511 // Note that normally a user will not see such an error once
512 // logged in, unless the admin has altered the default
513 // disallowed wikiactions. In that case we should probably
514 // check the user's language prefs too at this point; this
515 // would be a situation which is not really handled with the
517 if (empty($GLOBALS['LANG']))
518 update_locale(DEFAULT_LANGUAGE);
520 // User does not have required authority. Prompt for login.
521 $what = $this->getActionDescription($this->getArg('action'));
522 $pass_required = ($require_level >= WIKIAUTH_USER);
523 if ($require_level == WIKIAUTH_UNOBTAINABLE) {
524 global $DisabledActions;
525 if ($DisabledActions and in_array($action, $DisabledActions)) {
526 $msg = fmt("%s is disallowed on this wiki.",
527 $this->getDisallowedActionDescription($this->getArg('action')));
531 // Is the reason a missing ACL or just wrong user or password?
532 if (class_exists('PagePermission')) {
533 $user =& $this->_user;
534 $status = $user->isAuthenticated() ? _("authenticated") : _("not authenticated");
535 $msg = fmt("%s %s %s is disallowed on this wiki for %s user '%s' (level: %s).",
536 _("Missing PagePermission:"),
537 action2access($this->getArg('action')),
538 $this->getArg('pagename'),
539 $status, $user->getId(), $this->getLevelDescription($user->_level));
540 // TODO: add link to action=setacl
541 $user->PrintLoginForm($this, compact('pass_required'), $msg);
545 $msg = fmt("%s is disallowed on this wiki.",
546 $this->getDisallowedActionDescription($this->getArg('action')));
547 $this->_user->PrintLoginForm($this, compact('require_level', 'pass_required'), $msg);
551 } elseif ($require_level == WIKIAUTH_BOGO)
552 $msg = fmt("You must sign in to %s.", $what); elseif ($require_level == WIKIAUTH_USER) {
553 // LoginForm should display the relevant messages...
555 /*if (!ALLOW_ANON_USER)
556 $msg = fmt("You must log in first to %s", $what);
558 $msg = fmt("You must log in to %s.", $what);
560 } elseif ($require_level == WIKIAUTH_ANON)
561 $msg = fmt("Access for you is forbidden to %s.", $what); else
562 $msg = fmt("You must be an administrator to %s.", $what);
564 $this->_user->PrintLoginForm($this, compact('require_level', 'pass_required'),
566 if (!$GLOBALS['WikiTheme']->DUMP_MODE)
567 $this->finish(); // NORETURN
570 // Fixme: for PagePermissions we'll need other strings,
571 // relevant to the requested page, not just for the action on the whole wiki.
572 function getActionDescription($action)
574 static $actionDescriptions;
575 if (!$actionDescriptions) {
577 = array('browse' => _("view this page"),
578 'diff' => _("diff this page"),
579 'dumphtml' => _("dump html pages"),
580 'dumpserial' => _("dump serial pages"),
581 'edit' => _("edit this page"),
582 'rename' => _("rename this page"),
583 'revert' => _("revert to a previous version of this page"),
584 'create' => _("create this page"),
585 'loadfile' => _("load files into this wiki"),
586 'lock' => _("lock this page"),
587 'purge' => _("purge this page"),
588 'remove' => _("remove this page"),
589 'unlock' => _("unlock this page"),
590 'upload' => _("upload a zip dump"),
591 'verify' => _("verify the current action"),
592 'viewsource' => _("view the source of this page"),
593 'xmlrpc' => _("access this wiki via XML-RPC"),
594 'soap' => _("access this wiki via SOAP"),
595 'zip' => _("download a zip dump from this wiki"),
596 'ziphtml' => _("download a html zip dump from this wiki")
599 if (in_array($action, array_keys($actionDescriptions)))
600 return $actionDescriptions[$action];
602 return _("use") . " " . $action;
606 TODO: check against these cases:
607 if ($DisabledActions and in_array($action, $DisabledActions))
608 return WIKIAUTH_UNOBTAINABLE;
610 if (ENABLE_PAGEPERM and class_exists("PagePermission")) {
611 return requiredAuthorityForPage($action);
613 => Browsing pages is disallowed on this wiki for authenticated user 'rurban' (level: BOGO).
615 function getDisallowedActionDescription($action)
617 static $disallowedActionDescriptions;
619 if (!$disallowedActionDescriptions) {
620 $disallowedActionDescriptions
621 = array('browse' => _("Browsing pages"),
622 'diff' => _("Diffing pages"),
623 'dumphtml' => _("Dumping html pages"),
624 'dumpserial' => _("Dumping serial pages"),
625 'edit' => _("Editing pages"),
626 'revert' => _("Reverting to a previous version of pages"),
627 'create' => _("Creating pages"),
628 'loadfile' => _("Loading files"),
629 'lock' => _("Locking pages"),
630 'purge' => _("Purging pages"),
631 'remove' => _("Removing pages"),
632 'unlock' => _("Unlocking pages"),
633 'upload' => _("Uploading zip dumps"),
634 'verify' => _("Verify the current action"),
635 'viewsource' => _("Viewing the source of pages"),
636 'xmlrpc' => _("XML-RPC access"),
637 'soap' => _("SOAP access"),
638 'zip' => _("Downloading zip dumps"),
639 'ziphtml' => _("Downloading html zip dumps")
642 if (in_array($action, array_keys($disallowedActionDescriptions)))
643 return $disallowedActionDescriptions[$action];
648 function requiredAuthority($action)
650 $auth = $this->requiredAuthorityForAction($action);
651 if (!ALLOW_ANON_USER) return WIKIAUTH_USER;
654 * This is a hook for plugins to require authority
655 * for posting to them.
657 * IMPORTANT: This is not a secure check, so the plugin
658 * may not assume that any POSTs to it are authorized.
659 * All this does is cause PhpWiki to prompt for login
660 * if the user doesn't have the required authority.
662 if ($this->isPost()) {
663 $post_auth = $this->getArg('require_authority_for_post');
664 if ($post_auth !== false)
665 $auth = max($auth, $post_auth);
670 function requiredAuthorityForAction($action)
672 global $DisabledActions;
674 if ($DisabledActions and in_array($action, $DisabledActions))
675 return WIKIAUTH_UNOBTAINABLE;
677 if (ENABLE_PAGEPERM and class_exists("PagePermission")) {
678 return requiredAuthorityForPage($action);
691 return WIKIAUTH_ANON;
696 if (INSECURE_ACTIONS_LOCALHOST_ONLY and !is_localhost())
697 return WIKIAUTH_ADMIN;
698 return WIKIAUTH_ANON;
702 return WIKIAUTH_ADMIN;
703 if (INSECURE_ACTIONS_LOCALHOST_ONLY and !is_localhost())
704 return WIKIAUTH_ADMIN;
705 return WIKIAUTH_ANON;
708 if (INSECURE_ACTIONS_LOCALHOST_ONLY and is_localhost())
709 return WIKIAUTH_ANON;
710 return WIKIAUTH_ADMIN;
714 return WIKIAUTH_ADMIN;
715 return WIKIAUTH_ANON;
720 if (defined('REQUIRE_SIGNIN_BEFORE_EDIT') && REQUIRE_SIGNIN_BEFORE_EDIT)
721 return WIKIAUTH_BOGO;
722 return WIKIAUTH_ANON;
723 // return WIKIAUTH_BOGO;
726 $page = $this->getPage();
727 $current = $page->getCurrentRevision();
728 if ($current->hasDefaultContents())
729 return $this->requiredAuthorityForAction('edit');
730 return $this->requiredAuthorityForAction('browse');
743 return WIKIAUTH_ADMIN;
745 /* authcheck occurs only in the plugin.
746 required actionpage RateIt */
749 case 'delete_rating':
750 // Perhaps this should be WIKIAUTH_USER
751 return WIKIAUTH_BOGO;
755 global $WikiNameRegexp;
756 if (preg_match("/$WikiNameRegexp\Z/A", $action))
757 return WIKIAUTH_ANON; // ActionPage.
759 return WIKIAUTH_ADMIN;
764 /* End of Permission system */
766 function possiblyDeflowerVirginWiki()
768 if ($this->getArg('action') != 'browse')
770 if ($this->getArg('pagename') != HOME_PAGE)
773 $page = $this->getPage();
774 $current = $page->getCurrentRevision();
775 if ($current->getVersion() > 0)
776 return; // Homepage exists.
778 include_once 'lib/loadsave.php';
779 $this->setArg('action', 'loadfile');
781 $this->finish(); // NORETURN
784 // [574ms] mainly template:printexpansion: 393ms and template::expandsubtemplate [100+70+60ms]
785 function handleAction()
787 // Check illegal characters in page names: <>[]{}|"
788 require_once 'lib/Template.php';
789 $page = $this->getPage();
790 $pagename = $page->getName();
791 if (strlen($pagename) > MAX_PAGENAME_LENGTH) {
792 $pagename = substr($pagename, 0, MAX_PAGENAME_LENGTH - 1) . '…';
793 $CONTENT = HTML::div(array('class' => 'error'),
794 _('Page name too long'));
795 GeneratePage($CONTENT, $pagename);
798 if (preg_match("/[<\[\{\|\"\}\]>]/", $pagename, $matches) > 0) {
799 $CONTENT = HTML::div(
800 array('class' => 'error'),
801 sprintf(_("Illegal character '%s' in page name."),
803 GeneratePage($CONTENT, $pagename);
806 $action = $this->getArg('action');
808 and !$this->_user->isAdmin()
809 and $action != 'browse'
810 and $action != 'wikitohtml'
812 if ($page->get('moderation')) {
813 require_once 'lib/WikiPlugin.php';
814 $loader = new WikiPluginLoader();
815 $plugin = $loader->getPlugin("ModeratedPage");
816 if ($plugin->handler($this, $page)) {
819 array('class' => 'wiki-edithelp'),
820 fmt("%s: action forwarded to a moderator.",
823 _("This action requires moderator approval. Please be patient."));
824 if (!empty($plugin->_tokens['CONTENT']))
825 $plugin->_tokens['CONTENT']->pushContent
828 _("You must wait for moderator approval."));
830 $plugin->_tokens['CONTENT'] = $CONTENT;
831 $title = WikiLink($page->getName());
832 $title->pushContent(' : ', WikiLink(_("ModeratedPage")));
833 GeneratePage(Template('browse', $plugin->_tokens),
835 $page->getCurrentRevision());
840 $method = "action_$action";
841 if (method_exists($this, $method)) {
843 } elseif ($page = $this->findActionPage($action)) {
844 $this->actionpage($page);
846 $this->finish(fmt("%s: Bad action", $action));
850 function finish($errormsg = false)
855 exit(); // just in case CloseDataBase calls us
858 global $ErrorManager;
859 $ErrorManager->flushPostponedErrors();
861 if (!empty($errormsg)) {
864 HTML::h2(_("Fatal PhpWiki Error")),
867 echo "\n</body></html>";
869 if (is_object($this->_user)) {
870 $this->_user->page = $this->getArg('pagename');
871 $this->_user->action = $this->getArg('action');
872 unset($this->_user->_HomePagehandle);
873 unset($this->_user->_auth_dbi);
874 unset($this->_user->_dbi);
875 unset($this->_user->_request);
882 * Generally pagename is rawurlencoded for older browsers or mozilla.
883 * Typing a pagename into the IE bar will utf-8 encode it, so we have to
884 * fix that with fixTitleEncoding().
885 * If USE_PATH_INFO = true, the pagename is stripped from the "/DATA_PATH/PageName&arg=value" line.
886 * If false, we support either "/index.php?pagename=PageName&arg=value",
887 * or the first arg (1.2.x style): "/index.php?PageName&arg=value"
889 function _deducePagename()
891 if (trim(rawurldecode($this->getArg('pagename'))))
892 return fixTitleEncoding(rawurldecode($this->getArg('pagename')));
895 $pathinfo = $this->get('PATH_INFO');
896 if (empty($pathinfo)) { // fix for CGI
897 $path = $this->get('REQUEST_URI');
898 $script = $this->get('SCRIPT_NAME');
899 $pathinfo = substr($path, strlen($script));
900 $pathinfo = preg_replace('/\?.+$/', '', $pathinfo);
902 $tail = substr($pathinfo, strlen(PATH_INFO_PREFIX));
904 if (trim($tail) != '' and $pathinfo == PATH_INFO_PREFIX . $tail) {
905 return fixTitleEncoding($tail);
907 } elseif ($this->isPost()) {
909 * In general, for security reasons, HTTP_GET_VARS should be ignored
910 * on POST requests, but we make an exception here (only for pagename).
912 * The justification for this hack is the following
913 * asymmetry: When POSTing with USE_PATH_INFO set, the
914 * pagename can (and should) be communicated through the
915 * request URL via PATH_INFO. When POSTing with
916 * USE_PATH_INFO off, this cannot be done --- the only way
917 * to communicate the pagename through the URL is via
918 * QUERY_ARGS (HTTP_GET_VARS).
920 global $HTTP_GET_VARS;
921 if (isset($HTTP_GET_VARS['pagename']) and trim($HTTP_GET_VARS['pagename'])) {
922 return fixTitleEncoding(rawurldecode($HTTP_GET_VARS['pagename']));
927 * Support for PhpWiki 1.2 style requests.
928 * Strip off "&" args (?PageName&action=...&start_debug,...)
930 $query_string = $this->get('QUERY_STRING');
931 if (trim(rawurldecode($query_string)) and preg_match('/^([^&=]+)(&.+)?$/', $query_string, $m)) {
932 return fixTitleEncoding(rawurldecode($m[1]));
935 return fixTitleEncoding(HOME_PAGE);
938 function _deduceAction()
940 if (!($action = $this->getArg('action'))) {
941 // TODO: improve this SOAP.php hack by letting SOAP use index.php
942 // or any other virtual url as with xmlrpc
943 if (defined('WIKI_SOAP') and WIKI_SOAP)
945 // Detect XML-RPC requests.
947 && ((defined("WIKI_XMLRPC") and WIKI_XMLRPC)
948 or ($this->get('CONTENT_TYPE') == 'text/xml'
949 or $this->get('CONTENT_TYPE') == 'application/xml')
950 && strstr($GLOBALS['HTTP_RAW_POST_DATA'], '<methodCall>'))
954 return 'browse'; // Default if no action specified.
957 if (method_exists($this, "action_$action"))
960 // Allow for, e.g. action=LikePages
961 if (isActionPage($action))
964 // Handle untranslated actionpages in non-english
965 // (people playing with switching languages)
966 if (0 and $GLOBALS['LANG'] != 'en') {
967 require_once 'lib/plugin/_WikiTranslation.php';
968 $trans = new WikiPlugin__WikiTranslation();
969 $en_action = $trans->translate($action, 'en', $GLOBALS['LANG']);
970 if (isActionPage($en_action))
974 trigger_error("$action: Unknown action", E_USER_NOTICE);
978 function _deduceUsername()
980 global $HTTP_SERVER_VARS, $HTTP_ENV_VARS;
982 if (!empty($this->args['auth']) and !empty($this->args['auth']['userid']))
983 return $this->args['auth']['userid'];
985 if ($user = $this->getSessionVar('wiki_user')) {
986 // Switched auth between sessions.
987 // Note: There's no way to demandload a missing class-definition
988 // afterwards! Stupid php.
989 if (defined('FUSIONFORGE') and FUSIONFORGE) {
990 if (empty($HTTP_SERVER_VARS['PHP_AUTH_USER'])) {
993 } elseif (isa($user, WikiUserClassname())) {
994 $this->_user = $user;
995 $this->_user->_authhow = 'session';
996 return ENABLE_USER_NEW ? $user->UserName() : $this->_user;
1000 // Sessions override http auth
1001 if (!empty($HTTP_SERVER_VARS['PHP_AUTH_USER']))
1002 return $HTTP_SERVER_VARS['PHP_AUTH_USER'];
1004 if (!empty($HTTP_SERVER_VARS['REMOTE_USER']))
1005 return $HTTP_SERVER_VARS['REMOTE_USER'];
1006 if (!empty($HTTP_ENV_VARS['REMOTE_USER']))
1007 return $HTTP_ENV_VARS['REMOTE_USER'];
1009 if ($userid = $this->getCookieVar(getCookieName())) {
1010 if (!empty($userid) and substr($userid, 0, 2) != 's:') {
1011 $this->_user->authhow = 'cookie';
1016 if ($this->getArg('action') == 'xmlrpc') { // how about SOAP?
1017 if (empty($GLOBALS['HTTP_RAW_POST_DATA']))
1018 trigger_error("Wrong always_populate_raw_post_data = Off setting in your php.ini\nCannot use xmlrpc!", E_USER_ERROR);
1019 // wiki.putPage has special otional userid/passwd arguments. check that later.
1021 if (isset($HTTP_SERVER_VARS['REMOTE_USER']))
1022 $userid = $HTTP_SERVER_VARS['REMOTE_USER'];
1023 elseif (isset($HTTP_SERVER_VARS['REMOTE_ADDR']))
1024 $userid = $HTTP_SERVER_VARS['REMOTE_ADDR']; elseif (isset($HTTP_ENV_VARS['REMOTE_ADDR']))
1025 $userid = $HTTP_ENV_VARS['REMOTE_ADDR']; elseif (isset($GLOBALS['REMOTE_ADDR']))
1026 $userid = $GLOBALS['REMOTE_ADDR'];
1033 function findActionPage($action)
1036 if (!$action) return false;
1038 if (isActionPage($action))
1039 return $cache[$action] = $action;
1041 // check for translated version, as per users preferred language
1042 // (or system default in case it is not en)
1043 $translation = gettext($action);
1045 if (isset($cache) and isset($cache[$translation]))
1046 return $cache[$translation];
1048 // check for cached translated version
1049 if ($translation and isActionPage($translation))
1050 return $cache[$action] = $translation;
1052 // Allow for, e.g. action=LikePages
1053 if (!isWikiWord($action))
1054 return $cache[$action] = false;
1056 // check for translated version (default language)
1058 if ($LANG != "en") {
1059 require_once 'lib/WikiPlugin.php';
1060 require_once 'lib/plugin/_WikiTranslation.php';
1061 $trans = new WikiPlugin__WikiTranslation();
1062 $trans->lang = $LANG;
1063 $default = $trans->translate_to_en($action, $LANG);
1064 if ($default and isActionPage($default))
1065 return $cache[$action] = $default;
1067 $default = $translation;
1070 // check for english version
1071 if ($action != $translation and $action != $default) {
1072 if (isActionPage($action))
1073 return $cache[$action] = $action;
1076 trigger_error("$action: Cannot find action page", E_USER_NOTICE);
1077 return $cache[$action] = false;
1080 function action_browse()
1082 $this->buffer_output();
1083 include_once 'lib/display.php';
1087 function action_verify()
1089 $this->action_browse();
1092 function actionpage($action)
1094 $this->buffer_output();
1095 include_once 'lib/display.php';
1096 actionPage($this, $action);
1099 function adminActionSubpage($subpage)
1101 $page = __("PhpWikiAdministration") . "/" . $subpage;
1102 $action = $this->findActionPage($page);
1104 if (!$this->getArg('s'))
1105 $this->setArg('s', $this->getArg('pagename'));
1106 $this->setArg('verify', 1); // only for POST
1107 if ($this->getArg('action') != 'rename')
1108 $this->setArg('action', $action);
1109 elseif ($this->getArg('to') && empty($this->args['admin_rename'])) {
1110 $this->args['admin_rename']
1111 = array('from' => $this->getArg('s'),
1112 'to' => $this->getArg('to'),
1113 'action' => 'select');
1115 $this->actionpage($action);
1117 trigger_error($page . ": Cannot find action page", E_USER_WARNING);
1121 function action_chown()
1123 $this->adminActionSubpage(__("Chown"));
1126 function action_setacl()
1128 $this->adminActionSubpage(__("SetAcl"));
1131 function action_setaclsimple()
1133 $this->adminActionSubpage(__("SetAclSimple"));
1136 function action_deleteacl()
1138 $this->adminActionSubpage(__("DeleteAcl"));
1141 function action_rename()
1143 $this->adminActionSubpage(__("Rename"));
1146 function action_dump()
1148 $action = $this->findActionPage(_("PageDump"));
1150 $this->actionpage($action);
1152 // redirect to action=upgrade if admin?
1153 trigger_error(_("PageDump") . ": Cannot find action page", E_USER_WARNING);
1157 function action_diff()
1159 $this->buffer_output();
1160 include_once 'lib/diff.php';
1164 function action_search()
1166 // Decide between title or fulltextsearch (e.g. both buttons available).
1167 // Reformulate URL and redirect.
1168 $searchtype = $this->getArg('searchtype');
1169 $args = array('s' => $this->getArg('searchterm')
1170 ? $this->getArg('searchterm')
1171 : $this->getArg('s'));
1172 if ($searchtype == 'full' or $searchtype == 'fulltext') {
1173 $search_page = _("FullTextSearch");
1174 } elseif ($searchtype == 'external') {
1176 $link = new WikiPageName("Search:$s"); // Expand interwiki url. I use xapian-omega
1177 $this->redirect($link->url);
1179 $search_page = _("TitleSearch");
1180 $args['auto_redirect'] = 1;
1182 $this->redirect(WikiURL($search_page, $args, 'absolute_url'));
1185 function action_edit()
1187 $this->buffer_output();
1188 include 'lib/editpage.php';
1189 $e = new PageEditor ($this);
1193 function action_create()
1195 $this->action_edit();
1198 function action_viewsource()
1200 $this->buffer_output();
1201 include 'lib/editpage.php';
1202 $e = new PageEditor ($this);
1206 function action_lock()
1208 $page = $this->getPage();
1209 $page->set('locked', true);
1210 $this->_dbi->touch();
1211 // check ModeratedPage hook
1212 if ($moderated = $page->get('moderation')) {
1213 require_once 'lib/WikiPlugin.php';
1214 $plugin = WikiPluginLoader::getPlugin("ModeratedPage");
1215 if ($retval = $plugin->lock_check($this, $page, $moderated))
1216 $this->setArg('errormsg', $retval);
1217 } // check if a link to ModeratedPage exists
1218 elseif ($action_page = $page->existLink(_("ModeratedPage"))) {
1219 require_once 'lib/WikiPlugin.php';
1220 $plugin = WikiPluginLoader::getPlugin("ModeratedPage");
1221 if ($retval = $plugin->lock_add($this, $page, $action_page))
1222 $this->setArg('errormsg', $retval);
1224 $this->action_browse();
1227 function action_unlock()
1229 $page = $this->getPage();
1230 $page->set('locked', false);
1231 $this->_dbi->touch();
1232 $this->action_browse();
1235 function action_purge()
1237 $pagename = $this->getArg('pagename');
1238 if (strstr($pagename, _("PhpWikiAdministration"))) {
1239 $this->action_browse();
1241 include 'lib/purgepage.php';
1246 function action_remove()
1248 // This check is now redundant.
1249 //$user->requireAuth(WIKIAUTH_ADMIN);
1250 $pagename = $this->getArg('pagename');
1251 if (strstr($pagename, _("PhpWikiAdministration"))) {
1252 $this->action_browse();
1254 include 'lib/removepage.php';
1259 function action_xmlrpc()
1261 include_once 'lib/XmlRpcServer.php';
1262 $xmlrpc = new XmlRpcServer($this);
1266 function action_soap()
1268 if (defined("WIKI_SOAP") and WIKI_SOAP) // already loaded
1271 allow VIRTUAL_PATH or action=soap SOAP access
1273 include_once 'SOAP.php';
1276 function action_revert()
1278 include_once 'lib/loadsave.php';
1282 function action_zip()
1284 include_once 'lib/loadsave.php';
1288 function action_ziphtml()
1290 include_once 'lib/loadsave.php';
1291 MakeWikiZipHtml($this);
1292 // I don't think it hurts to add cruft at the end of the zip file.
1293 echo "\n========================================================\n";
1294 echo "PhpWiki " . PHPWIKI_VERSION . "\n";
1297 function action_dumpserial()
1299 include_once 'lib/loadsave.php';
1303 function action_dumphtml()
1305 include_once 'lib/loadsave.php';
1306 DumpHtmlToDir($this);
1309 function action_upload()
1311 include_once 'lib/loadsave.php';
1312 LoadPostFile($this);
1315 function action_upgrade()
1317 include_once 'lib/loadsave.php';
1318 include_once 'lib/upgrade.php';
1322 function action_loadfile()
1324 include_once 'lib/loadsave.php';
1325 LoadFileOrDir($this);
1328 function action_pdf()
1330 include_once 'lib/pdf.php';
1331 ConvertAndDisplayPdf($this);
1334 function action_captcha()
1336 include_once 'lib/Captcha.php';
1337 $captcha = new Captcha();
1338 $captcha->image($captcha->captchaword());
1341 function action_wikitohtml()
1343 include_once 'lib/WysiwygEdit/Wikiwyg.php';
1344 $wikitohtml = new WikiToHtml($this->getArg("content"), $this);
1345 $wikitohtml->send();
1348 function action_setpref()
1350 $what = $this->getArg('pref');
1351 $value = $this->getArg('value');
1352 $prefs =& $this->_user->_prefs;
1353 $prefs->set($what, $value);
1354 $num = $this->_user->setPreferences($prefs);
1358 //FIXME: deprecated with ENABLE_PAGEPERM (?)
1359 function is_safe_action($action)
1362 return $request->requiredAuthorityForAction($action) < WIKIAUTH_ADMIN;
1365 function validateSessionPath()
1367 // Try to defer any session.save_path PHP errors before any html
1368 // is output, which causes some versions of IE to display a blank
1369 // page (due to its strict mode while parsing a page?).
1370 if (!is_writeable(ini_get('session.save_path'))) {
1371 $tmpdir = (defined('SESSION_SAVE_PATH') and SESSION_SAVE_PATH) ? SESSION_SAVE_PATH : '/tmp';
1372 if (!is_writeable($tmpdir))
1375 (sprintf(_("%s is not writable."),
1376 _("The session.save_path directory"))
1378 . sprintf(_("Please ensure that %s is writable, or redefine %s in config/config.ini."),
1379 sprintf(_("the session.save_path directory '%s'"),
1380 ini_get('session.save_path')),
1381 'SESSION_SAVE_PATH')
1383 . sprintf(_("Attempting to use the directory '%s' instead."),
1386 if (!is_writeable($tmpdir)) {
1388 (sprintf(_("%s is not writable."), $tmpdir)
1390 . _("Users will not be able to sign in.")
1393 @ini_set('session.save_path', $tmpdir);
1399 if (version_compare(PHP_VERSION, '5.2', '<')) {
1400 exit(_("Your PHP version is too old. You must have at least PHP 5.2."));
1403 if (!USE_DB_SESSION)
1404 validateSessionPath();
1407 if ((DEBUG & _DEBUG_APD) and extension_loaded("apd")) {
1408 //apd_set_session_trace(9);
1409 apd_set_pprof_trace();
1412 // Postpone warnings
1413 global $ErrorManager;
1414 if (defined('E_STRICT')) // and (E_ALL & E_STRICT)) // strict php5?
1415 $ErrorManager->setPostponedErrorMask(E_NOTICE | E_USER_NOTICE | E_USER_WARNING | E_WARNING | E_STRICT | ((check_php_version(5, 3)) ? E_DEPRECATED : 0));
1417 $ErrorManager->setPostponedErrorMask(E_NOTICE | E_USER_NOTICE | E_USER_WARNING | E_WARNING);
1418 $request = new WikiRequest();
1420 $action = $request->getArg('action');
1421 if (substr($action, 0, 3) != 'zip') {
1422 if ($action == 'pdf')
1423 $ErrorManager->setPostponedErrorMask(-1); // everything
1424 //else // reject postponing of warnings
1425 // $ErrorManager->setPostponedErrorMask(E_NOTICE|E_USER_NOTICE);
1429 * Allow for disabling of markup cache.
1430 * (Mostly for debugging ... hopefully.)
1432 * See also <<WikiAdminUtils action=purge-cache>>
1434 if (!defined('WIKIDB_NOCACHE_MARKUP')) {
1435 if ($request->getArg('nocache')) // 1 or purge
1436 define('WIKIDB_NOCACHE_MARKUP', $request->getArg('nocache'));
1438 define('WIKIDB_NOCACHE_MARKUP', false); // redundant, but explicit
1441 // Initialize with system defaults in case user not logged in.
1442 // Should this go into the constructor?
1443 $request->initializeTheme('default');
1444 $request->updateAuthAndPrefs();
1445 $request->initializeLang();
1448 //if ($user->is_authenticated())
1449 // $LogEntry->user = $user->getId();
1451 // Memory optimization:
1452 // http://www.procata.com/blog/archives/2004/05/27/rephlux-and-php-memory-usage/
1453 // kill the global PEAR _PEAR_destructor_object_list
1454 if (!empty($_PEAR_destructor_object_list))
1455 $_PEAR_destructor_object_list = array();
1456 $request->possiblyDeflowerVirginWiki();
1458 $validators = array('wikiname' => WIKI_NAME,
1459 'args' => wikihash($request->getArgs()),
1460 'prefs' => wikihash($request->getPrefs()));
1461 if (CACHE_CONTROL == 'STRICT') {
1462 $dbi = $request->getDbh();
1463 $timestamp = $dbi->getTimestamp();
1464 $validators['mtime'] = $timestamp;
1465 $validators['%mtime'] = (int)$timestamp;
1467 // FIXME: we should try to generate strong validators when possible,
1468 // but for now, our validator is weak, since equal validators do not
1469 // indicate byte-level equality of content. (Due to DEBUG timing output, etc...)
1471 // (If DEBUG if off, this may be a strong validator, but I'm going
1472 // to go the paranoid route here pending further study and testing.)
1473 // access hits and edit stats in the footer violate strong ETags also.
1475 $validators['%weak'] = true;
1477 $request->setValidators($validators);
1479 $request->handleAction();
1481 if (DEBUG and DEBUG & _DEBUG_INFO) phpinfo(INFO_VARIABLES | INFO_MODULES);
1485 if ((!FUSIONFORGE) || (forge_get_config('installation_environment') != 'production')) {
1486 if (defined('E_STRICT') and (E_ALL & E_STRICT)) // strict php5?
1487 error_reporting(E_ALL & ~E_STRICT); // exclude E_STRICT
1489 error_reporting(E_ALL); // php4
1491 error_reporting(E_ERROR);
1494 // don't run the main loop for special requests (test, getimg, xmlrpc, soap, ...)
1495 if (!defined('PHPWIKI_NOMAIN') or !PHPWIKI_NOMAIN)
1501 // c-basic-offset: 4
1502 // c-hanging-comment-ender-p: nil
1503 // indent-tabs-mode: nil