2 rcs_id('$Id: IniConfig.php,v 1.61 2004-11-06 17:01:30 rurban Exp $');
5 * A configurator intended to read it's config from a PHP-style INI file,
6 * instead of a PHP file.
8 * Pass a filename to the IniConfig() function and it will read all it's
9 * definitions from there, all by itself, and proceed to do a mass-define
10 * of all valid PHPWiki config items. In this way, we can hopefully be
11 * totally backwards-compatible with the old index.php method, while still
12 * providing a much tastier on-going experience.
14 * @author: Joby Walker, Reini Urban, Matthew Palmer
17 * Copyright 2004 $ThePhpWikiProgrammingTeam
19 * This file is part of PhpWiki.
21 * PhpWiki is free software; you can redistribute it and/or modify
22 * it under the terms of the GNU General Public License as published by
23 * the Free Software Foundation; either version 2 of the License, or
24 * (at your option) any later version.
26 * PhpWiki is distributed in the hope that it will be useful,
27 * but WITHOUT ANY WARRANTY; without even the implied warranty of
28 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
29 * GNU General Public License for more details.
31 * You should have received a copy of the GNU General Public License
32 * along with PhpWiki; if not, write to the Free Software
33 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
38 * - Convert the value lists to provide defaults, so that every "if
39 * (defined())" and "if (!defined())" can fuck off to the dismal hole
41 * - config.ini => config.php dumper for faster startup. (really faster? to time)
44 * - Old-style index.php => config/config.ini converter.
46 * - Don't use too much globals for easier integration into other projects
47 * (namespace pollution). (gforge, phpnuke, postnuke, phpBB2, carolina, ...)
48 * Use one global $phpwiki object instead which holds the cfg vars, constants
49 * and all other globals.
50 * (global $FieldSeparator, $charset, $WikiNameRegexp, $KeywordLinkRegexp;
51 * global $DisabledActions, $DBParams, $LANG, $AllActionPages)
53 * - Resurrect the larger "config object" code (in config/) so it'll aid the
54 * GUI config writers, and allow us to do proper validation and default
57 * - Get rid of WikiNameRegexp and KeywordLinkRegexp as globals by finding
58 * everywhere that uses them as variables and modify the code to use
59 * them as constants. Will involve hacking around
60 * pcre_fix_posix_classes (probably with redefines()).
63 include_once (dirname(__FILE__)."/config.php");
64 include_once (dirname(__FILE__)."/FileFinder.php");
66 function save_dump($file) {
67 $vars =& $GLOBALS; // copy + unset not possible
69 foreach (array("SERVER","ENV","GET","POST","REQUEST","COOKIE","FILES") as $key) {
70 $ignore["HTTP_".$key."_VARS"]++;
73 foreach (array("HTTP_POST_FILES","GLOBALS","RUNTIMER","ErrorManager",'RCS_IDS','LANG',
74 'HOME_PAGE','request','SCRIPT_NAME','VIRTUAL_PATH','SCRIPT_FILENAME') as $key)
76 $fp = fopen($file, "wb");
77 fwrite($fp,"<?php\n");
78 fwrite($fp,"function wiki_configrestore(){\n");
79 //TODO: optimize this by removing ignore, big serialized array and merge into existing GLOBALS
80 foreach ($vars as $var => $val) {
82 fwrite($fp, "\$GLOBALS['".$var."']=unserialize(\"".addslashes(serialize($val))."\");\n");
84 // cannot be optimized, maybe leave away predefined consts somehow
85 foreach (get_defined_constants() as $var => $val) {
86 if (substr($var,0,4) != "PHP_" and substr($var,0,2) != "E_" and substr($var,0,2) != "T_" and substr($var,0,2) != "M_")
87 fwrite($fp, "if(!defined('".$var."')) define('".$var."',unserialize(\"".addslashes(serialize($val))."\"));\n");
89 fwrite($fp, "return 'noerr';}");
94 function IniConfig($file) {
95 // check config/config.php dump for faster startup
96 $dump = substr($file, 0, -3)."php";
97 if (isWindows($dump)) $dump = str_replace("/","\\",$dump);
98 if (file_exists($dump) and is_readable($dump) and sort_file_mtime($dump, $file) < 0) {
100 if (function_exists('wiki_configrestore') and (wiki_configrestore() === 'noerr')) {
101 fixup_dynamic_configs();
106 // List of all valid config options to be define()d which take "values" (not
107 // booleans). Needs to be categorised, and generally made a lot tidier.
108 $_IC_VALID_VALUE = array
109 ('WIKI_NAME', 'ADMIN_USER', 'ADMIN_PASSWD',
110 'DEFAULT_DUMP_DIR', 'HTML_DUMP_DIR',
111 'HTML_DUMP_SUFFIX', 'MAX_UPLOAD_SIZE', 'MINOR_EDIT_TIMEOUT',
112 'ACCESS_LOG', 'CACHE_CONTROL', 'CACHE_CONTROL_MAX_AGE',
113 'COOKIE_EXPIRATION_DAYS', 'COOKIE_DOMAIN',
114 'PASSWORD_LENGTH_MINIMUM', 'USER_AUTH_POLICY',
116 'EDITING_POLICY', 'THEME', 'CHARSET',
117 'DEFAULT_LANGUAGE', 'WIKI_PGSRC', 'DEFAULT_WIKI_PGSRC',
118 'ALLOWED_PROTOCOLS', 'INLINE_IMAGES', 'SUBPAGE_SEPARATOR',
119 'DATABASE_PREFIX', 'DATABASE_DSN', 'DATABASE_TYPE',
120 'INTERWIKI_MAP_FILE', 'COPYRIGHTPAGE_TITLE', 'COPYRIGHTPAGE_URL',
121 'AUTHORPAGE_TITLE', 'AUTHORPAGE_URL', 'SERVER_NAME', 'SERVER_PORT',
122 'SCRIPT_NAME', 'DATA_PATH', 'PHPWIKI_DIR', 'VIRTUAL_PATH',
124 'PLUGIN_CACHED_DATABASE', 'PLUGIN_CACHED_FILENAME_PREFIX',
125 'PLUGIN_CACHED_HIGHWATER', 'PLUGIN_CACHED_LOWWATER', 'PLUGIN_CACHED_MAXLIFETIME',
126 'PLUGIN_CACHED_MAXARGLEN', 'PLUGIN_CACHED_IMGTYPES',
129 // Optional values which need to be defined.
130 // These are not defined in config-default.ini and empty if not defined.
131 $_IC_OPTIONAL_VALUE = array
134 'LDAP_AUTH_HOST','LDAP_SET_OPTION','LDAP_BASE_DN', 'LDAP_AUTH_USER',
135 'LDAP_AUTH_PASSWORD','LDAP_SEARCH_FIELD','LDAP_OU_GROUP','LDAP_OU_USERS',
136 'AUTH_USER_FILE','DBAUTH_AUTH_DSN',
137 'IMAP_AUTH_HOST', 'POP3_AUTH_HOST',
138 'AUTH_USER_FILE', 'AUTH_GROUP_FILE', 'AUTH_SESS_USER', 'AUTH_SESS_LEVEL',
139 'GOOGLE_LICENSE_KEY','FORTUNE_DIR',
140 'DISABLE_GETIMAGESIZE','DBADMIN_USER','DBADMIN_PASSWD',
144 // List of all valid config options to be define()d which take booleans.
145 $_IC_VALID_BOOL = array
146 ('ENABLE_USER_NEW', 'ENABLE_PAGEPERM', 'ENABLE_EDIT_TOOLBAR', 'JS_SEARCHREPLACE',
147 'ENABLE_REVERSE_DNS', 'ENCRYPTED_PASSWD', 'ZIPDUMP_AUTH',
148 'ENABLE_RAW_HTML', 'ENABLE_RAW_HTML_LOCKEDONLY', 'ENABLE_RAW_HTML_SAFE',
149 'STRICT_MAILABLE_PAGEDUMPS', 'COMPRESS_OUTPUT',
150 'WIKIDB_NOCACHE_MARKUP', 'ALLOW_ANON_USER', 'ALLOW_ANON_EDIT',
151 'ALLOW_BOGO_LOGIN', 'ALLOW_USER_PASSWORDS',
152 'AUTH_USER_FILE_STORABLE', 'ALLOW_HTTP_AUTH_LOGIN',
153 'ALLOW_USER_LOGIN', 'ALLOW_LDAP_LOGIN', 'ALLOW_IMAP_LOGIN',
154 'WARN_NONPUBLIC_INTERWIKIMAP', 'USE_PATH_INFO',
155 'DISABLE_HTTP_REDIRECT',
156 'PLUGIN_CACHED_USECACHE', 'PLUGIN_CACHED_FORCE_SYNCMAP',
157 'ENABLE_XHTML_XML', 'ENABLE_DOUBLECLICKEDIT'
160 if(!file_exists($file)){
161 trigger_error("Datasource file '$file' does not exist", E_USER_ERROR);
165 $rs = @parse_ini_file($file);
166 $rsdef = @parse_ini_file(dirname(__FILE__)."/../config/config-default.ini");
167 foreach ($rsdef as $k => $v) {
169 $rs[$k] = constant($k);
170 } elseif (!isset($rs[$k])) {
175 foreach ($_IC_VALID_VALUE as $item) {
176 if (defined($item)) {
180 if (array_key_exists($item, $rs)) {
181 define($item, $rs[$item]);
183 //} elseif (array_key_exists($item, $rsdef)) {
184 // define($item, $rsdef[$item]);
185 // calculate them later or not at all:
186 } elseif (in_array($item,
187 array('DATABASE_PREFIX', 'SERVER_NAME', 'SERVER_PORT',
188 'SCRIPT_NAME', 'DATA_PATH', 'PHPWIKI_DIR', 'VIRTUAL_PATH',
189 'LDAP_AUTH_HOST','IMAP_AUTH_HOST','POP3_AUTH_HOST',
190 'PLUGIN_CACHED_CACHE_DIR')))
194 trigger_error(sprintf("missing config setting for %s",$item));
198 // Boolean options are slightly special - if they're set to any of
199 // '', 'false', '0', or 'no' (all case-insensitive) then the value will
200 // be a boolean false, otherwise if there is anything set it'll
202 foreach ($_IC_VALID_BOOL as $item) {
203 if (defined($item)) {
207 if (array_key_exists($item, $rs)) {
209 //} elseif (array_key_exists($item, $rsdef)) {
210 // $val = $rsdef[$item];
212 $val = false; //trigger_error(sprintf("missing boolean config setting for %s",$item));
215 // calculate them later: old or dynamic constants
216 if (!array_key_exists($item, $rs) and
217 in_array($item,array('USE_PATH_INFO', 'USE_DB_SESSION',
218 'ALLOW_HTTP_AUTH_LOGIN', 'ALLOW_LDAP_LOGIN',
219 'ALLOW_IMAP_LOGIN', 'ALLOW_USER_LOGIN',
220 'REQUIRE_SIGNIN_BEFORE_EDIT',
221 'WIKIDB_NOCACHE_MARKUP')))
226 define($item, false);
228 elseif (strtolower($val) == 'false' ||
229 strtolower($val) == 'no' ||
233 define($item, false);
243 foreach (array('DATABASE_TYPE' => 'dbtype',
244 'DATABASE_DSN' => 'dsn',
245 'DATABASE_SESSION_TABLE' => 'db_session_table',
246 'DATABASE_DBA_HANDLER' => 'dba_handler',
247 'DATABASE_DIRECTORY' => 'directory',
248 'DATABASE_TIMEOUT' => 'timeout',
249 'DATABASE_PREFIX' => 'prefix')
253 $DBParams[$k] = constant($d);
255 } elseif (array_key_exists($d, $rs)) {
256 $DBParams[$k] = $rs[$d];
259 } elseif (array_key_exists($d, $rsdef)) {
260 $DBParams[$k] = $rsdef[$d];
261 define($d, $rsdef[$d]);
265 // USE_DB_SESSION default logic:
266 if (!defined('USE_DB_SESSION')) {
267 if ($DBParams['db_session_table']
268 and in_array($DBParams['dbtype'], array('SQL','ADODB'))) {
269 define('USE_DB_SESSION', true);
270 } elseif ($DBParams['dbtype'] == 'dba' and check_php_version(4,1,2)) {
271 define('USE_DB_SESSION', true);
273 define('USE_DB_SESSION', false);
278 global $ExpireParams;
279 foreach (array('major','minor','author') as $major) {
280 foreach (array('max_age','min_age','min_keep','keep','max_keep') as $max) {
281 $item = strtoupper($major) . '_'. strtoupper($max);
282 if (defined($item)) $val = constant($item);
283 elseif (array_key_exists($item, $rs))
285 elseif (array_key_exists($item, $rsdef))
286 $val = $rsdef[$item];
287 if (!isset($ExpireParams[$major]))
288 $ExpireParams[$major] = array();
289 $ExpireParams[$major][$max] = $val;
294 // User authentication
295 if (!isset($GLOBALS['USER_AUTH_ORDER']))
296 if (isset($rs['USER_AUTH_ORDER']))
297 $GLOBALS['USER_AUTH_ORDER'] = preg_split('/\s*:\s*/',
298 $rs['USER_AUTH_ORDER']);
300 $GLOBALS['USER_AUTH_ORDER'] = array("PersonalPage");
302 // Now it's the external DB authentication stuff's turn
303 if (in_array('Db', $GLOBALS['USER_AUTH_ORDER']) && empty($rs['DBAUTH_AUTH_DSN'])) {
304 $rs['DBAUTH_AUTH_DSN'] = $DBParams['dsn'];
307 global $DBAuthParams;
308 $DBAP_MAP = array('DBAUTH_AUTH_DSN' => 'auth_dsn',
309 'DBAUTH_AUTH_CHECK' => 'auth_check',
310 'DBAUTH_AUTH_USER_EXISTS' => 'auth_user_exists',
311 'DBAUTH_AUTH_CRYPT_METHOD' => 'auth_crypt_method',
312 'DBAUTH_AUTH_UPDATE' => 'auth_update',
313 'DBAUTH_AUTH_CREATE' => 'auth_create',
314 'DBAUTH_PREF_SELECT' => 'pref_select',
315 'DBAUTH_PREF_UPDATE' => 'pref_update',
316 'DBAUTH_IS_MEMBER' => 'is_member',
317 'DBAUTH_GROUP_MEMBERS' => 'group_members',
318 'DBAUTH_USER_GROUPS' => 'user_groups'
320 foreach ($DBAP_MAP as $rskey => $apkey) {
321 if (defined($rskey)) {
322 $DBAuthParams[$apkey] = constant($rskey);
323 } elseif (isset($rs[$rskey])) {
324 $DBAuthParams[$apkey] = $rs[$rskey];
325 define($rskey, $rs[$rskey]);
326 } elseif (isset($rsdef[$rskey])) {
327 $DBAuthParams[$apkey] = $rsdef[$rskey];
328 define($rskey, $rsdef[$rskey]);
333 // optional values will be set to '' to simplify the logic.
334 foreach ($_IC_OPTIONAL_VALUE as $item) {
335 if (defined($item)) {
339 if (array_key_exists($item, $rs)) {
340 define($item, $rs[$item]);
347 global $LDAP_SET_OPTION;
348 if (defined('LDAP_SET_OPTION') and LDAP_SET_OPTION) {
349 $optlist = preg_split('/\s*:\s*/', LDAP_SET_OPTION);
350 foreach ($optlist as $opt) {
351 $bits = preg_split('/\s*=\s*/', $opt, 2);
352 if (count($bits) == 2) {
353 if (is_string($bits[0]) and defined($bits[0]))
354 $bits[0] = constant($bits[0]);
355 $LDAP_SET_OPTION[$bits[0]] = $bits[1];
358 // Possibly throw some sort of error?
363 // Default Wiki pages to force loading from pgsrc
364 global $GenericPages;
365 $GenericPages = preg_split('/\s*:\s*/', @$rs['DEFAULT_WIKI_PAGES']);
367 // Wiki name regexp: Should be a define(), but might needed to be changed at runtime
368 // (different LC_CHAR need different posix classes)
369 global $WikiNameRegexp;
370 $WikiNameRegexp = constant('WIKI_NAME_REGEXP');
371 if (!trim($WikiNameRegexp))
372 $WikiNameRegexp = '(?<![[:alnum:]])(?:[[:upper:]][[:lower:]]+){2,}(?![[:alnum:]])';
374 // Another "too-tricky" redefine
375 global $KeywordLinkRegexp;
376 if (!isset($rs['KEYWORDS'])) $rs['KEYWORDS'] = @$rsdef['KEYWORDS'];
377 if (!isset($rs['KEYWORDS'])) $rs['KEYWORDS'] = "Category:Topic";
378 $keywords = preg_split('/\s*:\s*/', $rs['KEYWORDS']);
379 if (empty($keywords)) $keywords = array("Category","Topic");
380 $KeywordLinkRegexp = '(?<=' . implode('|^', $keywords) . ')[[:upper:]].*$';
382 // TODO: can this be a constant?
383 global $DisabledActions;
384 if (!array_key_exists('DISABLED_ACTIONS',$rs) and array_key_exists('DISABLED_ACTIONS',$rsdef))
385 $rs['DISABLED_ACTIONS'] = @$rsdef['DISABLED_ACTIONS'];
386 if (array_key_exists('DISABLED_ACTIONS',$rs))
387 $DisabledActions = preg_split('/\s*:\s*/', $rs['DISABLED_ACTIONS']);
389 global $PLUGIN_CACHED_IMGTYPES;
390 $PLUGIN_CACHED_IMGTYPES = preg_split('/\s*[|:]\s*/', PLUGIN_CACHED_IMGTYPES);
391 if (empty($rs['PLUGIN_CACHED_CACHE_DIR']) and !empty($rsdef['PLUGIN_CACHED_CACHE_DIR']))
392 $rs['PLUGIN_CACHED_CACHE_DIR'] = $rsdef['PLUGIN_CACHED_CACHE_DIR'];
393 if (empty($rs['PLUGIN_CACHED_CACHE_DIR'])) {
394 if (!empty($rs['INCLUDE_PATH'])) {
395 ini_set('include_path', $rs['INCLUDE_PATH']);
397 if (!FindFile('/tmp/cache', 1)) {
398 if (!FindFile('/tmp', 1)) {
401 mkdir('/tmp/cache', 777);
403 // will throw an error if not exists.
404 define('PLUGIN_CACHED_CACHE_DIR', FindFile('/tmp/cache',false,1));
406 define('PLUGIN_CACHED_CACHE_DIR', $rs['PLUGIN_CACHED_CACHE_DIR']);
407 // will throw an error if not exists.
408 FindFile(PLUGIN_CACHED_CACHE_DIR);
411 // process the rest of the config.ini settings:
412 foreach ($rs as $item => $value) {
413 if (defined($item)) {
416 define($item, $value);
424 fixup_static_configs();
425 // Dump all globals and constants
426 // The question is if reading this is faster then doing IniConfig() + fixup_static_configs()
427 if (is_writable($dump)) {
430 fixup_dynamic_configs(); // store locale[] in config.php? This is too problematic.
433 // moved from lib/config.php
434 function fixup_static_configs() {
435 global $FieldSeparator, $charset, $WikiNameRegexp, $KeywordLinkRegexp, $AllActionPages;
436 global $HTTP_SERVER_VARS, $DBParams, $LANG;
438 // init FileFinder to add proper include paths
439 FindFile("lib/interwiki.map",true);
441 // "\x80"-"\x9f" (and "\x00" - "\x1f") are non-printing control
442 // chars in iso-8859-*
443 // $FieldSeparator = "\263"; // this is a superscript 3 in ISO-8859-1.
444 // $FieldSeparator = "\xFF"; // this byte should never appear in utf-8
445 // FIXME: get rid of constant. pref is dynamic and language specific
447 // Disabled: Let the admin decide which charset.
448 //if (isset($LANG) and in_array($LANG,array('zh')))
449 // $charset = 'utf-8';
450 if (strtolower($charset) == 'utf-8')
451 $FieldSeparator = "\xFF";
453 $FieldSeparator = "\x81";
455 if (!defined('DEFAULT_LANGUAGE')) // not needed anymore
456 define('DEFAULT_LANGUAGE', 'en');
458 $AllActionPages = explode(':',
459 'AllPages:BackLinks:CreatePage:DebugInfo:EditMetaData:FindPage:'
460 .'FullRecentChanges:FullTextSearch:FuzzyPages:InterWikiSearch:'
461 .'LikePages:MostPopular:'
462 .'OrphanedPages:PageDump:PageHistory:PageInfo:RandomPage:RateIt:'
463 .'RecentChanges:RecentEdits:RecentComments:RelatedChanges:TitleSearch:'
464 .'TranslateText:UpLoad:UserPreferences:WantedPages:WhoIsOnline:'
465 .'PhpWikiAdministration/Remove:PhpWikiAdministration/Chmod:'
466 .'PhpWikiAdministration/Rename:PhpWikiAdministration/Replace:'
467 .'PhpWikiAdministration/SetAcl:PhpWikiAdministration/Chown'
470 // If user has not defined PHPWIKI_DIR, and we need it
471 if (!defined('PHPWIKI_DIR') and !file_exists("themes/default")) {
472 $themes_dir = FindFile("themes");
473 define('PHPWIKI_DIR', dirname($themes_dir));
476 // If user has not defined DATA_PATH, we want to use relative URLs.
477 if (!defined('DATA_PATH')) {
478 // fix similar to the one suggested by jkalmbach for
479 // installations in the webrootdir, like "http://phpwiki.org/HomePage"
480 if (!defined('SCRIPT_NAME'))
481 define('SCRIPT_NAME', deduce_script_name());
482 $temp = dirname(SCRIPT_NAME);
483 if ( ($temp == '/') || ($temp == '\\') )
485 define('DATA_PATH', $temp);
488 define('DATA_PATH', '..');
492 //////////////////////////////////////////////////////////////////
495 if (empty($DBParams['dbtype']))
496 $DBParams['dbtype'] = 'dba';
498 if (!defined('THEME'))
499 define('THEME', 'default');
501 // check whether the crypt() function is needed and present
502 if (defined('ENCRYPTED_PASSWD') && !function_exists('crypt')) {
503 $error = sprintf(_("Encrypted passwords cannot be used: %s."),
504 "'function crypt()' not available in this version of php");
505 trigger_error($error);
508 if (!defined('ADMIN_PASSWD') or ADMIN_PASSWD == '')
509 trigger_error(_("The admin password cannot be empty. Please update your config/config.ini"));
511 if (defined('USE_DB_SESSION') and USE_DB_SESSION) {
512 if (! $DBParams['db_session_table'] ) {
513 $DBParams['db_session_table'] = @$DBParams['prefix'] . 'session';
514 trigger_error(sprintf(_("DATABASE_SESSION_TABLE configuration set to %s."),
515 $DBParams['db_session_table']),
520 if (!defined('ENABLE_USER_NEW')) define('ENABLE_USER_NEW',true);
521 if (!defined('ALLOW_USER_LOGIN'))
522 define('ALLOW_USER_LOGIN', defined('ALLOW_USER_PASSWORDS') && ALLOW_USER_PASSWORDS);
523 if (!defined('ALLOW_ANON_USER')) define('ALLOW_ANON_USER', true);
524 if (!defined('ALLOW_ANON_EDIT')) define('ALLOW_ANON_EDIT', false);
525 if (!defined('REQUIRE_SIGNIN_BEFORE_EDIT')) define('REQUIRE_SIGNIN_BEFORE_EDIT', ! ALLOW_ANON_EDIT);
526 if (!defined('ALLOW_BOGO_LOGIN')) define('ALLOW_BOGO_LOGIN', true);
527 if (!ENABLE_USER_NEW) {
528 if (!defined('ALLOW_HTTP_AUTH_LOGIN'))
529 define('ALLOW_HTTP_AUTH_LOGIN', false);
530 if (!defined('ALLOW_LDAP_LOGIN'))
531 define('ALLOW_LDAP_LOGIN', function_exists('ldap_connect') and defined('LDAP_AUTH_HOST'));
532 if (!defined('ALLOW_IMAP_LOGIN'))
533 define('ALLOW_IMAP_LOGIN', function_exists('imap_open') and defined('IMAP_AUTH_HOST'));
536 if (ALLOW_USER_LOGIN and !empty($DBAuthParams) and empty($DBAuthParams['auth_dsn'])) {
537 if (isset($DBParams['dsn']))
538 $DBAuthParams['auth_dsn'] = $DBParams['dsn'];
542 function fixup_dynamic_configs() {
543 global $WikiNameRegexp, $KeywordLinkRegexp;
544 global $HTTP_SERVER_VARS, $DBParams, $LANG;
546 if (defined('INCLUDE_PATH'))
547 ini_set('include_path', INCLUDE_PATH);
548 if (defined('SESSION_SAVE_PATH'))
549 ini_set('session.save_path', SESSION_SAVE_PATH);
550 if (!defined('DEFAULT_LANGUAGE')) // not needed anymore
551 define('DEFAULT_LANGUAGE', 'en');
553 update_locale(isset($LANG) ? $LANG : DEFAULT_LANGUAGE);
555 // Set up (possibly fake) gettext()
556 // Todo: this could be moved to fixup_static_configs()
557 if (!function_exists ('bindtextdomain')) {
560 function gettext ($text) {
562 if (!empty ($locale[$text]))
563 return $locale[$text];
568 return gettext($text);
572 // Working around really weird gettext problems: (4.3.2, 4.3.6 win)
573 // bindtextdomain() returns the current domain path.
574 // 1. If the script is not index.php but something like "de", on a different path
575 // then bindtextdomain() fails, but after chdir to the correct path it will work okay.
576 // 2. But the weird error "Undefined variable: bindtextdomain" is generated then.
577 $bindtextdomain_path = FindFile("locale", false, true);
579 $bindtextdomain_path = str_replace("/","\\",$bindtextdomain_path);
580 $bindtextdomain_real = @bindtextdomain("phpwiki", $bindtextdomain);
581 if ($bindtextdomain_real != $bindtextdomain_path) {
582 // this will happen with virtual_paths. chdir and try again.
583 chdir($bindtextdomain_path);
584 $bindtextdomain_real = @bindtextdomain("phpwiki", $bindtextdomain);
586 textdomain("phpwiki");
587 if ($bindtextdomain_real != $bindtextdomain_path) { // change back
588 chdir($bindtextdomain_real . (isWindows() ? "\\.." : "/.."));
591 // language dependent updates
592 $WikiNameRegexp = pcre_fix_posix_classes($WikiNameRegexp);
593 $KeywordLinkRegexp = pcre_fix_posix_classes($KeywordLinkRegexp);
595 //////////////////////////////////////////////////////////////////
596 // Autodetect URL settings:
598 foreach (array('SERVER_NAME','SERVER_PORT') as $var) {
599 //FIXME: for CGI without _SERVER
600 if (!defined($var) and !empty($HTTP_SERVER_VARS[$var]))
601 define($var, $HTTP_SERVER_VARS[$var]);
603 if (!defined('SERVER_PROTOCOL')) {
604 if (empty($HTTP_SERVER_VARS['HTTPS']) || $HTTP_SERVER_VARS['HTTPS'] == 'off')
605 define('SERVER_PROTOCOL', 'http');
607 define('SERVER_PROTOCOL', 'https');
610 if (!defined('SCRIPT_NAME'))
611 define('SCRIPT_NAME', deduce_script_name());
613 if (!defined('USE_PATH_INFO')) {
615 define('USE_PATH_INFO', false);
618 * If SCRIPT_NAME does not look like php source file,
619 * or user cgi we assume that php is getting run by an
620 * action handler in /cgi-bin. In this case,
621 * I think there is no way to get Apache to pass
622 * useful PATH_INFO to the php script (PATH_INFO
623 * is used to the the php interpreter where the
626 switch (php_sapi_name()) {
628 case 'apache2handler':
629 define('USE_PATH_INFO', true);
632 case 'apache2filter':
633 define('USE_PATH_INFO', false);
636 define('USE_PATH_INFO', ereg('\.(php3?|cgi)$', SCRIPT_NAME));
643 && SERVER_PORT != (SERVER_PROTOCOL == 'https' ? 443 : 80)) {
645 SERVER_PROTOCOL . '://' . SERVER_NAME . ':' . SERVER_PORT);
649 SERVER_PROTOCOL . '://' . SERVER_NAME);
652 if (VIRTUAL_PATH != SCRIPT_NAME) {
653 // Apache action handlers are used.
654 define('PATH_INFO_PREFIX', VIRTUAL_PATH . '/');
657 define('PATH_INFO_PREFIX', '/');
659 define('PHPWIKI_BASE_URL',
660 SERVER_URL . (USE_PATH_INFO ? VIRTUAL_PATH . '/' : SCRIPT_NAME));
662 if (!defined('VIRTUAL_PATH')) {
663 // We'd like to auto-detect when the cases where apaches
664 // 'Action' directive (or similar means) is used to
665 // redirect page requests to a cgi-handler.
667 // In cases like this, requests for e.g. /wiki/HomePage
668 // get redirected to a cgi-script called, say,
669 // /path/to/wiki/index.php. The script gets all
670 // of /wiki/HomePage as it's PATH_INFO.
673 // How to detect when this has happened reliably?
674 // How to pick out the "virtual path" (in this case '/wiki')?
676 // (Another time an redirect might occur is to a DirectoryIndex
677 // -- the requested URI is '/wikidir/', the request gets
678 // passed to '/wikidir/index.php'. In this case, the
679 // proper VIRTUAL_PATH is '/wikidir/index.php', since the
680 // pages will appear at e.g. '/wikidir/index.php/HomePage'.
683 $REDIRECT_URL = &$HTTP_SERVER_VARS['REDIRECT_URL'];
684 if (USE_PATH_INFO and isset($REDIRECT_URL)
685 and ! IsProbablyRedirectToIndex()) {
686 // FIXME: This is a hack, and won't work if the requested
687 // pagename has a slash in it.
688 $temp = strtr(dirname($REDIRECT_URL . 'x'),"\\",'/');
689 if ( ($temp == '/') || ($temp == '\\') )
691 define('VIRTUAL_PATH', $temp);
693 define('VIRTUAL_PATH', SCRIPT_NAME);
697 // Detect PrettyWiki setup (not loading index.php directly)
698 // $SCRIPT_FILENAME should be the same as __FILE__ in index.php
699 if (!isset($SCRIPT_FILENAME))
700 $SCRIPT_FILENAME = @$HTTP_SERVER_VARS['SCRIPT_FILENAME'];
701 if (!isset($SCRIPT_FILENAME))
702 $SCRIPT_FILENAME = @$HTTP_ENV_VARS['SCRIPT_FILENAME'];
703 if (!isset($SCRIPT_FILENAME))
704 $SCRIPT_FILENAME = dirname(__FILE__.'/../') . '/index.php';
706 $SCRIPT_FILENAME = str_replace('\\\\','\\',strtr($SCRIPT_FILENAME, '/', '\\'));
707 define('SCRIPT_FILENAME', $SCRIPT_FILENAME);
709 if (!defined('WIKI_NAME'))
710 define('WIKI_NAME', _("An unnamed PhpWiki"));
712 if (!defined('HOME_PAGE'))
713 define('HOME_PAGE', _("HomePage"));
715 // Get remote host name, if apache hasn't done it for us
716 if (empty($HTTP_SERVER_VARS['REMOTE_HOST'])
717 and !empty($HTTP_SERVER_VARS['REMOTE_ADDR'])
718 and ENABLE_REVERSE_DNS)
719 $HTTP_SERVER_VARS['REMOTE_HOST'] = gethostbyaddr($HTTP_SERVER_VARS['REMOTE_ADDR']);
723 // $Log: not supported by cvs2svn $
724 // Revision 1.60 2004/11/06 03:06:58 rurban
725 // make use of dumped static config state in config/config.php (if writable)
727 // Revision 1.59 2004/11/05 20:53:35 rurban
728 // login cleanup: better debug msg on failing login,
729 // checked password less immediate login (bogo or anon),
730 // checked olduser pref session error,
731 // better PersonalPage without password warning on minimal password length=0
732 // (which is default now)
734 // Revision 1.58 2004/11/03 16:50:31 rurban
735 // some new defaults and constants, renamed USE_DOUBLECLICKEDIT to ENABLE_DOUBLECLICKEDIT
737 // Revision 1.57 2004/11/01 10:43:55 rurban
738 // seperate PassUser methods into seperate dir (memory usage)
739 // fix WikiUser (old) overlarge data session
740 // remove wikidb arg from various page class methods, use global ->_dbi instead
743 // Revision 1.56 2004/10/21 20:20:53 rurban
744 // From patch #970004 "Double clic to edit" by pixels.
746 // Revision 1.55 2004/10/14 19:23:58 rurban
747 // remove debugging prints
749 // Revision 1.54 2004/10/14 17:13:01 rurban
750 // use DATABASE_PREFIX
752 // Revision 1.53 2004/10/12 13:13:19 rurban
753 // php5 compatibility (5.0.1 ok)
755 // Revision 1.52 2004/10/04 23:38:07 rurban
758 // Revision 1.51 2004/09/20 13:40:19 rurban
759 // define all config.ini settings, only the supported will be taken from -default.
760 // support USE_EXTERNAL_HTML2PDF renderer (htmldoc tested)
762 // Revision 1.50 2004/09/06 09:28:58 rurban
763 // fix PLUGIN_CACHED_CACHE_DIR fallback logic. ini entry did not work before
765 // Revision 1.49 2004/07/13 13:07:27 rurban
766 // improved DB_SESSION logic
768 // Revision 1.48 2004/07/05 13:09:37 rurban
769 // ENABLE_RAW_HTML_LOCKEDONLY, ENABLE_RAW_HTML_SAFE
771 // Revision 1.47 2004/07/03 16:51:05 rurban
772 // optional DBADMIN_USER:DBADMIN_PASSWD for action=upgrade (if no ALTER permission)
773 // added atomic mysql REPLACE for PearDB as in ADODB
774 // fixed _lock_tables typo links => link
775 // fixes unserialize ADODB bug in line 180
777 // Revision 1.46 2004/07/02 09:55:58 rurban
778 // more stability fixes: new DISABLE_GETIMAGESIZE if your php crashes when loading LinkIcons: failing getimagesize in old phps; blockparser stabilized
780 // Revision 1.45 2004/07/01 08:51:21 rurban
781 // dumphtml: added exclude, print pagename before processing
783 // Revision 1.44 2004/06/29 08:52:22 rurban
784 // Use ...version() $need_content argument in WikiDB also:
785 // To reduce the memory footprint for larger sets of pagelists,
786 // we don't cache the content (only true or false) and
787 // we purge the pagedata (_cached_html) also.
788 // _cached_html is only cached for the current pagename.
789 // => Vastly improved page existance check, ACL check, ...
791 // Now only PagedList info=content or size needs the whole content, esp. if sortable.
793 // Revision 1.43 2004/06/29 06:48:02 rurban
794 // Improve LDAP auth and GROUP_LDAP membership:
795 // no error message on false password,
796 // added two new config vars: LDAP_OU_USERS and LDAP_OU_GROUP with GROUP_METHOD=LDAP
797 // fixed two group queries (this -> user)
798 // stdlib: ConvertOldMarkup still flawed
800 // Revision 1.42 2004/06/28 15:01:07 rurban
801 // fixed LDAP_SET_OPTION handling, LDAP error on connection problem
803 // Revision 1.41 2004/06/25 14:29:17 rurban
804 // WikiGroup refactoring:
805 // global group attached to user, code for not_current user.
806 // improved helpers for special groups (avoid double invocations)
807 // new experimental config option ENABLE_XHTML_XML (fails with IE, and document.write())
808 // fixed a XHTML validation error on userprefs.tmpl
810 // Revision 1.40 2004/06/22 07:12:48 rurban
811 // removed USE_TAGLINES constant
813 // Revision 1.39 2004/06/21 16:22:28 rurban
814 // add DEFAULT_DUMP_DIR and HTML_DUMP_DIR constants, for easier cmdline dumps,
815 // fixed dumping buttons locally (images/buttons/),
816 // support pages arg for dumphtml,
817 // optional directory arg for dumpserial + dumphtml,
818 // fix a AllPages warning,
819 // show dump warnings/errors on DEBUG,
820 // don't warn just ignore on wikilens pagelist columns, if not loaded.
821 // RateIt pagelist column is called "rating", not "ratingwidget" (Dan?)
823 // Revision 1.38 2004/06/21 08:39:36 rurban
824 // pear/Cache update from Cache-1.5.4 (added db and trifile container)
825 // pear/DB update from DB-1.6.1 (mysql bugfixes, php5 compat, DB_PORTABILITY features)
827 // Revision 1.37 2004/06/19 12:32:37 rurban
828 // new TEMP_DIR for ziplib
830 // Revision 1.36 2004/06/19 10:06:37 rurban
831 // Moved lib/plugincache-config.php to config/*.ini
832 // use PLUGIN_CACHED_* constants instead of global $CacheParams
834 // Revision 1.35 2004/06/15 09:15:52 rurban
835 // IMPORTANT: fixed passwd handling for passwords stored in prefs:
836 // fix encrypted usage, actually store and retrieve them from db
837 // fix bogologin with passwd set.
838 // fix php crashes with call-time pass-by-reference (references wrongly used
839 // in declaration AND call). This affected mainly Apache2 and IIS.
840 // (Thanks to John Cole to detect this!)
842 // Revision 1.34 2004/06/13 13:54:25 rurban
843 // Catch fatals on the four dump calls (as file and zip, as html and mimified)
844 // FoafViewer: Check against external requirements, instead of fatal.
845 // Change output for xhtmldumps: using file:// urls to the local fs.
846 // Catch SOAP fatal by checking for GOOGLE_LICENSE_KEY
847 // Import GOOGLE_LICENSE_KEY and FORTUNE_DIR from config.ini.
849 // Revision 1.33 2004/06/08 19:48:16 rurban
850 // fixed foreign setup: no ugly skipped msg for the GenericPages, load english actionpages if translated not found
852 // Revision 1.32 2004/06/08 10:54:46 rurban
853 // better acl dump representation, read back acl and owner
855 // Revision 1.31 2004/06/06 16:58:51 rurban
856 // added more required ActionPages for foreign languages
857 // install now english ActionPages if no localized are found. (again)
858 // fixed default anon user level to be 0, instead of -1
859 // (wrong "required administrator to view this page"...)
861 // Revision 1.30 2004/06/04 12:40:21 rurban
862 // Restrict valid usernames to prevent from attacks against external auth or compromise
864 // Fix various WikiUser old issues with default IMAP,LDAP,POP3 configs. Removed these.
865 // Fxied more warnings
867 // Revision 1.29 2004/06/04 11:58:38 rurban
868 // added USE_TAGLINES
870 // Revision 1.28 2004/06/03 20:42:49 rurban
871 // fixed bad warning #964850
873 // Revision 1.27 2004/06/03 10:18:19 rurban
874 // fix FileUser locking issues, new config ENABLE_PAGEPERM
876 // Revision 1.26 2004/06/02 18:01:45 rurban
877 // init global FileFinder to add proper include paths at startup
878 // adds PHPWIKI_DIR if started from another dir, lib/pear also
879 // fix slashify for Windows
880 // fix USER_AUTH_POLICY=old, use only USER_AUTH_ORDER methods (besides HttpAuth)
882 // Revision 1.25 2004/05/27 17:49:05 rurban
883 // renamed DB_Session to DbSession (in CVS also)
884 // added WikiDB->getParam and WikiDB->getAuthParam method to get rid of globals
885 // remove leading slash in error message
886 // added force_unlock parameter to File_Passwd (no return on stale locks)
887 // fixed adodb session AffectedRows
888 // added FileFinder helpers to unify local filenames and DATA_PATH names
889 // editpage.php: new edit toolbar javascript on ENABLE_EDIT_TOOLBAR
891 // Revision 1.24 2004/05/18 13:33:13 rurban
892 // we already have a CGI function
894 // Revision 1.23 2004/05/17 17:43:29 rurban
895 // CGI: no PATH_INFO fix
897 // Revision 1.22 2004/05/16 22:07:35 rurban
898 // check more config-default and predefined constants
899 // various PagePerm fixes:
900 // fix default PagePerms, esp. edit and view for Bogo and Password users
901 // implemented Creator and Owner
902 // BOGOUSERS renamed to BOGOUSER
903 // fixed syntax errors in signin.tmpl
905 // Revision 1.21 2004/05/08 22:55:12 rurban
906 // Fixed longstanding sf.net:demo problem. endless loop, caused by an empty definition of
907 // WIKI_NAME_REGEXP. Exactly this constant wasn't checked for its default setting.
909 // Revision 1.20 2004/05/08 20:21:00 rurban
910 // remove php tags in Log
912 // Revision 1.19 2004/05/08 19:55:29 rurban
913 // support <span>inlined plugin-result</span>:
914 // if the plugin is parsed inside a line, use <span> instead of
915 // <div tightenable top bottom>
916 // e.g. for "This is the current Phpwiki <plugin SystemInfo version> version.
918 // Revision 1.18 2004/05/08 16:58:19 rurban
919 // don't ignore some false config values (e.g. USE_PATH_INFO false was ignored)
921 // Revision 1.17 2004/05/06 19:26:15 rurban
922 // improve stability, trying to find the InlineParser endless loop on sf.net
924 // remove end-of-zip comments to fix sf.net bug #777278 and probably #859628
926 // Revision 1.16 2004/05/02 15:10:05 rurban
927 // new finally reliable way to detect if /index.php is called directly
928 // and if to include lib/main.php
929 // new global AllActionPages
930 // SetupWiki now loads all mandatory pages: HOME_PAGE, action pages, and warns if not.
931 // WikiTranslation what=buttons for Carsten to create the missing MacOSX buttons
932 // PageGroupTestOne => subpages
933 // renamed PhpWikiRss to PhpWikiRecentChanges
934 // more docs, default configs, ...
936 // Revision 1.15 2004/05/01 15:59:29 rurban
937 // more php-4.0.6 compatibility: superglobals
939 // Revision 1.14 2004/04/29 23:25:12 rurban
940 // re-ordered locale init (as in 1.3.9)
941 // fixed loadfile with subpages, and merge/restore anyway
942 // (sf.net bug #844188)
944 // Revision 1.13 2004/04/29 21:54:05 rurban
947 // Revision 1.12 2004/04/27 16:16:27 rurban
948 // more subtle config problems with defaults
950 // Revision 1.11 2004/04/26 20:44:34 rurban
951 // locking table specific for better databases
953 // Revision 1.10 2004/04/26 13:22:32 rurban
954 // calculate bool old or dynamic constants later
956 // Revision 1.9 2004/04/26 12:15:01 rurban
957 // check default config values
959 // Revision 1.8 2004/04/23 16:55:59 zorloc
960 // If using Db auth and DBAUTH_AUTH_DSN is empty set DBAUTH_AUTH_DSN to $DBParams['dsn']
962 // Revision 1.7 2004/04/20 22:26:27 zorloc
963 // Removed Pear_Config for parse_ini_file().
965 // Revision 1.6 2004/04/20 18:10:27 rurban
966 // config refactoring:
967 // FileFinder is needed for WikiFarm scripts calling index.php
968 // config run-time calls moved to lib/IniConfig.php:fix_configs()
969 // added PHPWIKI_DIR smart-detection code (Theme finder)
970 // moved FileFind to lib/FileFinder.php
971 // cleaned lib/config.php
973 // Revision 1.5 2004/04/20 17:21:57 rurban
974 // WikiFarm code: honor predefined constants
976 // Revision 1.4 2004/04/20 17:08:19 rurban
977 // Some IniConfig fixes: prepend our private lib/pear dir
978 // switch from " to ' in the auth statements
979 // use error handling.
980 // WikiUserNew changes for the new "'$variable'" syntax
982 // TODO: optimization to put config vars into the session.
985 // (c-file-style: "gnu")
990 // c-hanging-comment-ender-p: nil
991 // indent-tabs-mode: nil