2 rcs_id('$Id: IniConfig.php,v 1.60 2004-11-06 03:06:58 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 $DBParams['dbtype'] = DATABASE_TYPE;
244 $DBParams['dsn'] = DATABASE_DSN;
245 if (defined('DATABASE_PREFIX'))
246 $DBParams['prefix'] = DATABASE_PREFIX;
247 elseif (isset($rs['DATABASE_PREFIX']))
248 $DBParams['prefix'] = $rs['DATABASE_PREFIX'];
249 $DBParams['db_session_table'] = @$rs['DATABASE_SESSION_TABLE'];
250 $DBParams['dba_handler'] = @$rs['DATABASE_DBA_HANDLER'];
251 $DBParams['directory'] = @$rs['DATABASE_DIRECTORY'];
252 $DBParams['timeout'] = @$rs['DATABASE_TIMEOUT'];
253 foreach (array('DATABASE_TYPE','DATABASE_DSN','DATABASE_SESSION_TABLE','DATABASE_DBA_HANDLER',
254 'DATABASE_DIRECTORY','DATABASE_TIMEOUT','DATABASE_PREFIX') as $item) {
257 // USE_DB_SESSION default logic:
258 if (!defined('USE_DB_SESSION')) {
259 if ($DBParams['db_session_table']
260 and in_array($DBParams['dbtype'], array('SQL','ADODB'/*,'dba'*/))) {
261 define('USE_DB_SESSION', true);
263 define('USE_DB_SESSION', false);
268 global $ExpireParams;
269 foreach (array('major','minor','author') as $major) {
270 foreach (array('max_age','min_age','min_keep','keep','max_keep') as $max) {
271 $item = strtoupper($major) . '_'. strtoupper($max);
272 if (defined($item)) $val = constant($item);
273 elseif (array_key_exists($item, $rs))
275 elseif (array_key_exists($item, $rsdef))
276 $val = $rsdef[$item];
277 if (!isset($ExpireParams[$major]))
278 $ExpireParams[$major] = array();
279 $ExpireParams[$major][$max] = $val;
284 // User authentication
285 if (!isset($GLOBALS['USER_AUTH_ORDER']))
286 if (isset($rs['USER_AUTH_ORDER']))
287 $GLOBALS['USER_AUTH_ORDER'] = preg_split('/\s*:\s*/',
288 $rs['USER_AUTH_ORDER']);
290 $GLOBALS['USER_AUTH_ORDER'] = array("PersonalPage");
292 // Now it's the external DB authentication stuff's turn
293 if (in_array('Db', $GLOBALS['USER_AUTH_ORDER']) && empty($rs['DBAUTH_AUTH_DSN'])) {
294 $rs['DBAUTH_AUTH_DSN'] = $DBParams['dsn'];
297 global $DBAuthParams;
298 $DBAP_MAP = array('DBAUTH_AUTH_DSN' => 'auth_dsn',
299 'DBAUTH_AUTH_CHECK' => 'auth_check',
300 'DBAUTH_AUTH_USER_EXISTS' => 'auth_user_exists',
301 'DBAUTH_AUTH_CRYPT_METHOD' => 'auth_crypt_method',
302 'DBAUTH_AUTH_UPDATE' => 'auth_update',
303 'DBAUTH_AUTH_CREATE' => 'auth_create',
304 'DBAUTH_PREF_SELECT' => 'pref_select',
305 'DBAUTH_PREF_UPDATE' => 'pref_update',
306 'DBAUTH_IS_MEMBER' => 'is_member',
307 'DBAUTH_GROUP_MEMBERS' => 'group_members',
308 'DBAUTH_USER_GROUPS' => 'user_groups'
310 foreach ($DBAP_MAP as $rskey => $apkey) {
311 if (defined($rskey)) {
312 $DBAuthParams[$apkey] = constant($rskey);
313 } elseif (isset($rs[$rskey])) {
314 $DBAuthParams[$apkey] = $rs[$rskey];
315 } elseif (isset($rsdef[$rskey])) {
316 $DBAuthParams[$apkey] = $rsdef[$rskey];
321 // optional values will be set to '' to simplify the logic.
322 foreach ($_IC_OPTIONAL_VALUE as $item) {
323 if (defined($item)) {
327 if (array_key_exists($item, $rs)) {
328 define($item, $rs[$item]);
335 global $LDAP_SET_OPTION;
336 if (defined('LDAP_SET_OPTION') and LDAP_SET_OPTION) {
337 $optlist = preg_split('/\s*:\s*/', LDAP_SET_OPTION);
338 foreach ($optlist as $opt) {
339 $bits = preg_split('/\s*=\s*/', $opt, 2);
340 if (count($bits) == 2) {
341 if (is_string($bits[0]) and defined($bits[0]))
342 $bits[0] = constant($bits[0]);
343 $LDAP_SET_OPTION[$bits[0]] = $bits[1];
346 // Possibly throw some sort of error?
351 // Default Wiki pages to force loading from pgsrc
352 global $GenericPages;
353 $GenericPages = preg_split('/\s*:\s*/', @$rs['DEFAULT_WIKI_PAGES']);
355 // Wiki name regexp: Should be a define(), but might needed to be changed at runtime
356 // (different LC_CHAR need different posix classes)
357 global $WikiNameRegexp;
358 $WikiNameRegexp = constant('WIKI_NAME_REGEXP');
359 if (!trim($WikiNameRegexp))
360 $WikiNameRegexp = '(?<![[:alnum:]])(?:[[:upper:]][[:lower:]]+){2,}(?![[:alnum:]])';
362 // Another "too-tricky" redefine
363 global $KeywordLinkRegexp;
364 if (!isset($rs['KEYWORDS'])) $rs['KEYWORDS'] = @$rsdef['KEYWORDS'];
365 if (!isset($rs['KEYWORDS'])) $rs['KEYWORDS'] = "Category:Topic";
366 $keywords = preg_split('/\s*:\s*/', $rs['KEYWORDS']);
367 if (empty($keywords)) $keywords = array("Category","Topic");
368 $KeywordLinkRegexp = '(?<=' . implode('|^', $keywords) . ')[[:upper:]].*$';
370 // TODO: can this be a constant?
371 global $DisabledActions;
372 if (!array_key_exists('DISABLED_ACTIONS',$rs) and array_key_exists('DISABLED_ACTIONS',$rsdef))
373 $rs['DISABLED_ACTIONS'] = @$rsdef['DISABLED_ACTIONS'];
374 if (array_key_exists('DISABLED_ACTIONS',$rs))
375 $DisabledActions = preg_split('/\s*:\s*/', $rs['DISABLED_ACTIONS']);
377 global $PLUGIN_CACHED_IMGTYPES;
378 $PLUGIN_CACHED_IMGTYPES = preg_split('/\s*[|:]\s*/', PLUGIN_CACHED_IMGTYPES);
379 if (empty($rs['PLUGIN_CACHED_CACHE_DIR']) and !empty($rsdef['PLUGIN_CACHED_CACHE_DIR']))
380 $rs['PLUGIN_CACHED_CACHE_DIR'] = $rsdef['PLUGIN_CACHED_CACHE_DIR'];
381 if (empty($rs['PLUGIN_CACHED_CACHE_DIR'])) {
382 if (!empty($rs['INCLUDE_PATH'])) {
383 ini_set('include_path', $rs['INCLUDE_PATH']);
385 if (!FindFile('/tmp/cache', 1)) {
386 if (!FindFile('/tmp', 1)) {
389 mkdir('/tmp/cache', 777);
391 // will throw an error if not exists.
392 define('PLUGIN_CACHED_CACHE_DIR', FindFile('/tmp/cache',false,1));
394 define('PLUGIN_CACHED_CACHE_DIR', $rs['PLUGIN_CACHED_CACHE_DIR']);
395 // will throw an error if not exists.
396 FindFile(PLUGIN_CACHED_CACHE_DIR);
399 // process the rest of the config.ini settings:
400 foreach ($rs as $item => $value) {
401 if (defined($item)) {
404 define($item, $value);
412 fixup_static_configs();
413 // Dump all globals and constants
414 // The question is if reading this is faster then doing IniConfig() + fixup_static_configs()
415 if (is_writable($dump)) {
418 fixup_dynamic_configs(); // store locale[] in config.php? This is too problematic.
421 // moved from lib/config.php
422 function fixup_static_configs() {
423 global $FieldSeparator, $charset, $WikiNameRegexp, $KeywordLinkRegexp, $AllActionPages;
424 global $HTTP_SERVER_VARS, $DBParams, $LANG;
426 // init FileFinder to add proper include paths
427 FindFile("lib/interwiki.map",true);
429 // "\x80"-"\x9f" (and "\x00" - "\x1f") are non-printing control
430 // chars in iso-8859-*
431 // $FieldSeparator = "\263"; // this is a superscript 3 in ISO-8859-1.
432 // $FieldSeparator = "\xFF"; // this byte should never appear in utf-8
433 // FIXME: get rid of constant. pref is dynamic and language specific
435 // Disabled: Let the admin decide which charset.
436 //if (isset($LANG) and in_array($LANG,array('zh')))
437 // $charset = 'utf-8';
438 if (strtolower($charset) == 'utf-8')
439 $FieldSeparator = "\xFF";
441 $FieldSeparator = "\x81";
443 if (!defined('DEFAULT_LANGUAGE')) // not needed anymore
444 define('DEFAULT_LANGUAGE', 'en');
446 $AllActionPages = explode(':',
447 'AllPages:BackLinks:CreatePage:DebugInfo:EditMetaData:FindPage:'
448 .'FullRecentChanges:FullTextSearch:FuzzyPages:InterWikiSearch:'
449 .'LikePages:MostPopular:'
450 .'OrphanedPages:PageDump:PageHistory:PageInfo:RandomPage:RateIt:'
451 .'RecentChanges:RecentEdits:RecentComments:RelatedChanges:TitleSearch:'
452 .'TranslateText:UpLoad:UserPreferences:WantedPages:WhoIsOnline:'
453 .'PhpWikiAdministration/Remove:PhpWikiAdministration/Chmod:'
454 .'PhpWikiAdministration/Rename:PhpWikiAdministration/Replace:'
455 .'PhpWikiAdministration/SetAcl:PhpWikiAdministration/Chown'
458 // If user has not defined PHPWIKI_DIR, and we need it
459 if (!defined('PHPWIKI_DIR') and !file_exists("themes/default")) {
460 $themes_dir = FindFile("themes");
461 define('PHPWIKI_DIR', dirname($themes_dir));
464 // If user has not defined DATA_PATH, we want to use relative URLs.
465 if (!defined('DATA_PATH')) {
466 // fix similar to the one suggested by jkalmbach for
467 // installations in the webrootdir, like "http://phpwiki.org/HomePage"
468 if (!defined('SCRIPT_NAME'))
469 define('SCRIPT_NAME', deduce_script_name());
470 $temp = dirname(SCRIPT_NAME);
471 if ( ($temp == '/') || ($temp == '\\') )
473 define('DATA_PATH', $temp);
476 define('DATA_PATH', '..');
480 //////////////////////////////////////////////////////////////////
483 if (empty($DBParams['dbtype']))
484 $DBParams['dbtype'] = 'dba';
486 if (!defined('THEME'))
487 define('THEME', 'default');
489 // check whether the crypt() function is needed and present
490 if (defined('ENCRYPTED_PASSWD') && !function_exists('crypt')) {
491 $error = sprintf(_("Encrypted passwords cannot be used: %s."),
492 "'function crypt()' not available in this version of php");
493 trigger_error($error);
496 if (!defined('ADMIN_PASSWD') or ADMIN_PASSWD == '')
497 trigger_error(_("The admin password cannot be empty. Please update your config/config.ini"));
499 if (defined('USE_DB_SESSION') and USE_DB_SESSION) {
500 if (! $DBParams['db_session_table'] ) {
501 $DBParams['db_session_table'] = @$DBParams['prefix'] . 'session';
502 trigger_error(sprintf(_("DATABASE_SESSION_TABLE configuration set to %s."),
503 $DBParams['db_session_table']),
508 if (!defined('ENABLE_USER_NEW')) define('ENABLE_USER_NEW',true);
509 if (!defined('ALLOW_USER_LOGIN'))
510 define('ALLOW_USER_LOGIN', defined('ALLOW_USER_PASSWORDS') && ALLOW_USER_PASSWORDS);
511 if (!defined('ALLOW_ANON_USER')) define('ALLOW_ANON_USER', true);
512 if (!defined('ALLOW_ANON_EDIT')) define('ALLOW_ANON_EDIT', false);
513 if (!defined('REQUIRE_SIGNIN_BEFORE_EDIT')) define('REQUIRE_SIGNIN_BEFORE_EDIT', ! ALLOW_ANON_EDIT);
514 if (!defined('ALLOW_BOGO_LOGIN')) define('ALLOW_BOGO_LOGIN', true);
515 if (!ENABLE_USER_NEW) {
516 if (!defined('ALLOW_HTTP_AUTH_LOGIN'))
517 define('ALLOW_HTTP_AUTH_LOGIN', false);
518 if (!defined('ALLOW_LDAP_LOGIN'))
519 define('ALLOW_LDAP_LOGIN', function_exists('ldap_connect') and defined('LDAP_AUTH_HOST'));
520 if (!defined('ALLOW_IMAP_LOGIN'))
521 define('ALLOW_IMAP_LOGIN', function_exists('imap_open') and defined('IMAP_AUTH_HOST'));
524 if (ALLOW_USER_LOGIN and !empty($DBAuthParams) and empty($DBAuthParams['auth_dsn'])) {
525 if (isset($DBParams['dsn']))
526 $DBAuthParams['auth_dsn'] = $DBParams['dsn'];
530 function fixup_dynamic_configs() {
531 global $WikiNameRegexp, $KeywordLinkRegexp;
532 global $HTTP_SERVER_VARS, $DBParams, $LANG;
534 if (defined('INCLUDE_PATH'))
535 ini_set('include_path', INCLUDE_PATH);
536 if (defined('SESSION_SAVE_PATH'))
537 ini_set('session.save_path', SESSION_SAVE_PATH);
538 if (!defined('DEFAULT_LANGUAGE')) // not needed anymore
539 define('DEFAULT_LANGUAGE', 'en');
541 update_locale(isset($LANG) ? $LANG : DEFAULT_LANGUAGE);
543 // Set up (possibly fake) gettext()
544 // Todo: this could be moved to fixup_static_configs()
545 if (!function_exists ('bindtextdomain')) {
548 function gettext ($text) {
550 if (!empty ($locale[$text]))
551 return $locale[$text];
556 return gettext($text);
560 // Working around really weird gettext problems: (4.3.2, 4.3.6 win)
561 // bindtextdomain() returns the current domain path.
562 // 1. If the script is not index.php but something like "de", on a different path
563 // then bindtextdomain() fails, but after chdir to the correct path it will work okay.
564 // 2. But the weird error "Undefined variable: bindtextdomain" is generated then.
565 $bindtextdomain_path = FindFile("locale", false, true);
567 $bindtextdomain_path = str_replace("/","\\",$bindtextdomain_path);
568 $bindtextdomain_real = @bindtextdomain("phpwiki", $bindtextdomain);
569 if ($bindtextdomain_real != $bindtextdomain_path) {
570 // this will happen with virtual_paths. chdir and try again.
571 chdir($bindtextdomain_path);
572 $bindtextdomain_real = @bindtextdomain("phpwiki", $bindtextdomain);
574 textdomain("phpwiki");
575 if ($bindtextdomain_real != $bindtextdomain_path) { // change back
576 chdir($bindtextdomain_real . (isWindows() ? "\\.." : "/.."));
579 // language dependent updates
580 $WikiNameRegexp = pcre_fix_posix_classes($WikiNameRegexp);
581 $KeywordLinkRegexp = pcre_fix_posix_classes($KeywordLinkRegexp);
583 //////////////////////////////////////////////////////////////////
584 // Autodetect URL settings:
586 foreach (array('SERVER_NAME','SERVER_PORT') as $var) {
587 //FIXME: for CGI without _SERVER
588 if (!defined($var) and !empty($HTTP_SERVER_VARS[$var]))
589 define($var, $HTTP_SERVER_VARS[$var]);
591 if (!defined('SERVER_PROTOCOL')) {
592 if (empty($HTTP_SERVER_VARS['HTTPS']) || $HTTP_SERVER_VARS['HTTPS'] == 'off')
593 define('SERVER_PROTOCOL', 'http');
595 define('SERVER_PROTOCOL', 'https');
598 if (!defined('SCRIPT_NAME'))
599 define('SCRIPT_NAME', deduce_script_name());
601 if (!defined('USE_PATH_INFO')) {
603 define('USE_PATH_INFO', false);
606 * If SCRIPT_NAME does not look like php source file,
607 * or user cgi we assume that php is getting run by an
608 * action handler in /cgi-bin. In this case,
609 * I think there is no way to get Apache to pass
610 * useful PATH_INFO to the php script (PATH_INFO
611 * is used to the the php interpreter where the
614 switch (php_sapi_name()) {
616 case 'apache2handler':
617 define('USE_PATH_INFO', true);
620 case 'apache2filter':
621 define('USE_PATH_INFO', false);
624 define('USE_PATH_INFO', ereg('\.(php3?|cgi)$', SCRIPT_NAME));
631 && SERVER_PORT != (SERVER_PROTOCOL == 'https' ? 443 : 80)) {
633 SERVER_PROTOCOL . '://' . SERVER_NAME . ':' . SERVER_PORT);
637 SERVER_PROTOCOL . '://' . SERVER_NAME);
640 if (VIRTUAL_PATH != SCRIPT_NAME) {
641 // Apache action handlers are used.
642 define('PATH_INFO_PREFIX', VIRTUAL_PATH . '/');
645 define('PATH_INFO_PREFIX', '/');
647 define('PHPWIKI_BASE_URL',
648 SERVER_URL . (USE_PATH_INFO ? VIRTUAL_PATH . '/' : SCRIPT_NAME));
650 if (!defined('VIRTUAL_PATH')) {
651 // We'd like to auto-detect when the cases where apaches
652 // 'Action' directive (or similar means) is used to
653 // redirect page requests to a cgi-handler.
655 // In cases like this, requests for e.g. /wiki/HomePage
656 // get redirected to a cgi-script called, say,
657 // /path/to/wiki/index.php. The script gets all
658 // of /wiki/HomePage as it's PATH_INFO.
661 // How to detect when this has happened reliably?
662 // How to pick out the "virtual path" (in this case '/wiki')?
664 // (Another time an redirect might occur is to a DirectoryIndex
665 // -- the requested URI is '/wikidir/', the request gets
666 // passed to '/wikidir/index.php'. In this case, the
667 // proper VIRTUAL_PATH is '/wikidir/index.php', since the
668 // pages will appear at e.g. '/wikidir/index.php/HomePage'.
671 $REDIRECT_URL = &$HTTP_SERVER_VARS['REDIRECT_URL'];
672 if (USE_PATH_INFO and isset($REDIRECT_URL)
673 and ! IsProbablyRedirectToIndex()) {
674 // FIXME: This is a hack, and won't work if the requested
675 // pagename has a slash in it.
676 $temp = strtr(dirname($REDIRECT_URL . 'x'),"\\",'/');
677 if ( ($temp == '/') || ($temp == '\\') )
679 define('VIRTUAL_PATH', $temp);
681 define('VIRTUAL_PATH', SCRIPT_NAME);
685 // Detect PrettyWiki setup (not loading index.php directly)
686 // $SCRIPT_FILENAME should be the same as __FILE__ in index.php
687 if (!isset($SCRIPT_FILENAME))
688 $SCRIPT_FILENAME = @$HTTP_SERVER_VARS['SCRIPT_FILENAME'];
689 if (!isset($SCRIPT_FILENAME))
690 $SCRIPT_FILENAME = @$HTTP_ENV_VARS['SCRIPT_FILENAME'];
691 if (!isset($SCRIPT_FILENAME))
692 $SCRIPT_FILENAME = dirname(__FILE__.'/../') . '/index.php';
694 $SCRIPT_FILENAME = strtr($SCRIPT_FILENAME, '/', '\\');
695 define('SCRIPT_FILENAME', $SCRIPT_FILENAME);
697 if (!defined('WIKI_NAME'))
698 define('WIKI_NAME', _("An unnamed PhpWiki"));
700 if (!defined('HOME_PAGE'))
701 define('HOME_PAGE', _("HomePage"));
704 // Get remote host name, if apache hasn't done it for us
705 if (empty($HTTP_SERVER_VARS['REMOTE_HOST']) && ENABLE_REVERSE_DNS)
706 $HTTP_SERVER_VARS['REMOTE_HOST'] = gethostbyaddr($HTTP_SERVER_VARS['REMOTE_ADDR']);
710 // $Log: not supported by cvs2svn $
711 // Revision 1.59 2004/11/05 20:53:35 rurban
712 // login cleanup: better debug msg on failing login,
713 // checked password less immediate login (bogo or anon),
714 // checked olduser pref session error,
715 // better PersonalPage without password warning on minimal password length=0
716 // (which is default now)
718 // Revision 1.58 2004/11/03 16:50:31 rurban
719 // some new defaults and constants, renamed USE_DOUBLECLICKEDIT to ENABLE_DOUBLECLICKEDIT
721 // Revision 1.57 2004/11/01 10:43:55 rurban
722 // seperate PassUser methods into seperate dir (memory usage)
723 // fix WikiUser (old) overlarge data session
724 // remove wikidb arg from various page class methods, use global ->_dbi instead
727 // Revision 1.56 2004/10/21 20:20:53 rurban
728 // From patch #970004 "Double clic to edit" by pixels.
730 // Revision 1.55 2004/10/14 19:23:58 rurban
731 // remove debugging prints
733 // Revision 1.54 2004/10/14 17:13:01 rurban
734 // use DATABASE_PREFIX
736 // Revision 1.53 2004/10/12 13:13:19 rurban
737 // php5 compatibility (5.0.1 ok)
739 // Revision 1.52 2004/10/04 23:38:07 rurban
742 // Revision 1.51 2004/09/20 13:40:19 rurban
743 // define all config.ini settings, only the supported will be taken from -default.
744 // support USE_EXTERNAL_HTML2PDF renderer (htmldoc tested)
746 // Revision 1.50 2004/09/06 09:28:58 rurban
747 // fix PLUGIN_CACHED_CACHE_DIR fallback logic. ini entry did not work before
749 // Revision 1.49 2004/07/13 13:07:27 rurban
750 // improved DB_SESSION logic
752 // Revision 1.48 2004/07/05 13:09:37 rurban
753 // ENABLE_RAW_HTML_LOCKEDONLY, ENABLE_RAW_HTML_SAFE
755 // Revision 1.47 2004/07/03 16:51:05 rurban
756 // optional DBADMIN_USER:DBADMIN_PASSWD for action=upgrade (if no ALTER permission)
757 // added atomic mysql REPLACE for PearDB as in ADODB
758 // fixed _lock_tables typo links => link
759 // fixes unserialize ADODB bug in line 180
761 // Revision 1.46 2004/07/02 09:55:58 rurban
762 // more stability fixes: new DISABLE_GETIMAGESIZE if your php crashes when loading LinkIcons: failing getimagesize in old phps; blockparser stabilized
764 // Revision 1.45 2004/07/01 08:51:21 rurban
765 // dumphtml: added exclude, print pagename before processing
767 // Revision 1.44 2004/06/29 08:52:22 rurban
768 // Use ...version() $need_content argument in WikiDB also:
769 // To reduce the memory footprint for larger sets of pagelists,
770 // we don't cache the content (only true or false) and
771 // we purge the pagedata (_cached_html) also.
772 // _cached_html is only cached for the current pagename.
773 // => Vastly improved page existance check, ACL check, ...
775 // Now only PagedList info=content or size needs the whole content, esp. if sortable.
777 // Revision 1.43 2004/06/29 06:48:02 rurban
778 // Improve LDAP auth and GROUP_LDAP membership:
779 // no error message on false password,
780 // added two new config vars: LDAP_OU_USERS and LDAP_OU_GROUP with GROUP_METHOD=LDAP
781 // fixed two group queries (this -> user)
782 // stdlib: ConvertOldMarkup still flawed
784 // Revision 1.42 2004/06/28 15:01:07 rurban
785 // fixed LDAP_SET_OPTION handling, LDAP error on connection problem
787 // Revision 1.41 2004/06/25 14:29:17 rurban
788 // WikiGroup refactoring:
789 // global group attached to user, code for not_current user.
790 // improved helpers for special groups (avoid double invocations)
791 // new experimental config option ENABLE_XHTML_XML (fails with IE, and document.write())
792 // fixed a XHTML validation error on userprefs.tmpl
794 // Revision 1.40 2004/06/22 07:12:48 rurban
795 // removed USE_TAGLINES constant
797 // Revision 1.39 2004/06/21 16:22:28 rurban
798 // add DEFAULT_DUMP_DIR and HTML_DUMP_DIR constants, for easier cmdline dumps,
799 // fixed dumping buttons locally (images/buttons/),
800 // support pages arg for dumphtml,
801 // optional directory arg for dumpserial + dumphtml,
802 // fix a AllPages warning,
803 // show dump warnings/errors on DEBUG,
804 // don't warn just ignore on wikilens pagelist columns, if not loaded.
805 // RateIt pagelist column is called "rating", not "ratingwidget" (Dan?)
807 // Revision 1.38 2004/06/21 08:39:36 rurban
808 // pear/Cache update from Cache-1.5.4 (added db and trifile container)
809 // pear/DB update from DB-1.6.1 (mysql bugfixes, php5 compat, DB_PORTABILITY features)
811 // Revision 1.37 2004/06/19 12:32:37 rurban
812 // new TEMP_DIR for ziplib
814 // Revision 1.36 2004/06/19 10:06:37 rurban
815 // Moved lib/plugincache-config.php to config/*.ini
816 // use PLUGIN_CACHED_* constants instead of global $CacheParams
818 // Revision 1.35 2004/06/15 09:15:52 rurban
819 // IMPORTANT: fixed passwd handling for passwords stored in prefs:
820 // fix encrypted usage, actually store and retrieve them from db
821 // fix bogologin with passwd set.
822 // fix php crashes with call-time pass-by-reference (references wrongly used
823 // in declaration AND call). This affected mainly Apache2 and IIS.
824 // (Thanks to John Cole to detect this!)
826 // Revision 1.34 2004/06/13 13:54:25 rurban
827 // Catch fatals on the four dump calls (as file and zip, as html and mimified)
828 // FoafViewer: Check against external requirements, instead of fatal.
829 // Change output for xhtmldumps: using file:// urls to the local fs.
830 // Catch SOAP fatal by checking for GOOGLE_LICENSE_KEY
831 // Import GOOGLE_LICENSE_KEY and FORTUNE_DIR from config.ini.
833 // Revision 1.33 2004/06/08 19:48:16 rurban
834 // fixed foreign setup: no ugly skipped msg for the GenericPages, load english actionpages if translated not found
836 // Revision 1.32 2004/06/08 10:54:46 rurban
837 // better acl dump representation, read back acl and owner
839 // Revision 1.31 2004/06/06 16:58:51 rurban
840 // added more required ActionPages for foreign languages
841 // install now english ActionPages if no localized are found. (again)
842 // fixed default anon user level to be 0, instead of -1
843 // (wrong "required administrator to view this page"...)
845 // Revision 1.30 2004/06/04 12:40:21 rurban
846 // Restrict valid usernames to prevent from attacks against external auth or compromise
848 // Fix various WikiUser old issues with default IMAP,LDAP,POP3 configs. Removed these.
849 // Fxied more warnings
851 // Revision 1.29 2004/06/04 11:58:38 rurban
852 // added USE_TAGLINES
854 // Revision 1.28 2004/06/03 20:42:49 rurban
855 // fixed bad warning #964850
857 // Revision 1.27 2004/06/03 10:18:19 rurban
858 // fix FileUser locking issues, new config ENABLE_PAGEPERM
860 // Revision 1.26 2004/06/02 18:01:45 rurban
861 // init global FileFinder to add proper include paths at startup
862 // adds PHPWIKI_DIR if started from another dir, lib/pear also
863 // fix slashify for Windows
864 // fix USER_AUTH_POLICY=old, use only USER_AUTH_ORDER methods (besides HttpAuth)
866 // Revision 1.25 2004/05/27 17:49:05 rurban
867 // renamed DB_Session to DbSession (in CVS also)
868 // added WikiDB->getParam and WikiDB->getAuthParam method to get rid of globals
869 // remove leading slash in error message
870 // added force_unlock parameter to File_Passwd (no return on stale locks)
871 // fixed adodb session AffectedRows
872 // added FileFinder helpers to unify local filenames and DATA_PATH names
873 // editpage.php: new edit toolbar javascript on ENABLE_EDIT_TOOLBAR
875 // Revision 1.24 2004/05/18 13:33:13 rurban
876 // we already have a CGI function
878 // Revision 1.23 2004/05/17 17:43:29 rurban
879 // CGI: no PATH_INFO fix
881 // Revision 1.22 2004/05/16 22:07:35 rurban
882 // check more config-default and predefined constants
883 // various PagePerm fixes:
884 // fix default PagePerms, esp. edit and view for Bogo and Password users
885 // implemented Creator and Owner
886 // BOGOUSERS renamed to BOGOUSER
887 // fixed syntax errors in signin.tmpl
889 // Revision 1.21 2004/05/08 22:55:12 rurban
890 // Fixed longstanding sf.net:demo problem. endless loop, caused by an empty definition of
891 // WIKI_NAME_REGEXP. Exactly this constant wasn't checked for its default setting.
893 // Revision 1.20 2004/05/08 20:21:00 rurban
894 // remove php tags in Log
896 // Revision 1.19 2004/05/08 19:55:29 rurban
897 // support <span>inlined plugin-result</span>:
898 // if the plugin is parsed inside a line, use <span> instead of
899 // <div tightenable top bottom>
900 // e.g. for "This is the current Phpwiki <plugin SystemInfo version> version.
902 // Revision 1.18 2004/05/08 16:58:19 rurban
903 // don't ignore some false config values (e.g. USE_PATH_INFO false was ignored)
905 // Revision 1.17 2004/05/06 19:26:15 rurban
906 // improve stability, trying to find the InlineParser endless loop on sf.net
908 // remove end-of-zip comments to fix sf.net bug #777278 and probably #859628
910 // Revision 1.16 2004/05/02 15:10:05 rurban
911 // new finally reliable way to detect if /index.php is called directly
912 // and if to include lib/main.php
913 // new global AllActionPages
914 // SetupWiki now loads all mandatory pages: HOME_PAGE, action pages, and warns if not.
915 // WikiTranslation what=buttons for Carsten to create the missing MacOSX buttons
916 // PageGroupTestOne => subpages
917 // renamed PhpWikiRss to PhpWikiRecentChanges
918 // more docs, default configs, ...
920 // Revision 1.15 2004/05/01 15:59:29 rurban
921 // more php-4.0.6 compatibility: superglobals
923 // Revision 1.14 2004/04/29 23:25:12 rurban
924 // re-ordered locale init (as in 1.3.9)
925 // fixed loadfile with subpages, and merge/restore anyway
926 // (sf.net bug #844188)
928 // Revision 1.13 2004/04/29 21:54:05 rurban
931 // Revision 1.12 2004/04/27 16:16:27 rurban
932 // more subtle config problems with defaults
934 // Revision 1.11 2004/04/26 20:44:34 rurban
935 // locking table specific for better databases
937 // Revision 1.10 2004/04/26 13:22:32 rurban
938 // calculate bool old or dynamic constants later
940 // Revision 1.9 2004/04/26 12:15:01 rurban
941 // check default config values
943 // Revision 1.8 2004/04/23 16:55:59 zorloc
944 // If using Db auth and DBAUTH_AUTH_DSN is empty set DBAUTH_AUTH_DSN to $DBParams['dsn']
946 // Revision 1.7 2004/04/20 22:26:27 zorloc
947 // Removed Pear_Config for parse_ini_file().
949 // Revision 1.6 2004/04/20 18:10:27 rurban
950 // config refactoring:
951 // FileFinder is needed for WikiFarm scripts calling index.php
952 // config run-time calls moved to lib/IniConfig.php:fix_configs()
953 // added PHPWIKI_DIR smart-detection code (Theme finder)
954 // moved FileFind to lib/FileFinder.php
955 // cleaned lib/config.php
957 // Revision 1.5 2004/04/20 17:21:57 rurban
958 // WikiFarm code: honor predefined constants
960 // Revision 1.4 2004/04/20 17:08:19 rurban
961 // Some IniConfig fixes: prepend our private lib/pear dir
962 // switch from " to ' in the auth statements
963 // use error handling.
964 // WikiUserNew changes for the new "'$variable'" syntax
966 // TODO: optimization to put config vars into the session.
969 // (c-file-style: "gnu")
974 // c-hanging-comment-ender-p: nil
975 // indent-tabs-mode: nil