2 rcs_id('$Id: IniConfig.php,v 1.69 2004-12-23 14:07:34 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");
67 * Speed-up iniconfig loading.
69 * Dump the static parts of the parsed config/config.ini settings to a fast-loadable config.php file.
70 * The dynamic parts are then evaluated as before.
71 * Requires write-permissions to config/config.php
73 function save_dump($file) {
74 $vars =& $GLOBALS; // copy + unset not possible
76 foreach (array("SERVER","ENV","GET","POST","REQUEST","COOKIE","FILES") as $key) {
77 $ignore["HTTP_".$key."_VARS"]++;
80 foreach (array("HTTP_POST_FILES","GLOBALS","RUNTIMER","ErrorManager",'RCS_IDS','LANG',
81 'HOME_PAGE','request','SCRIPT_NAME','VIRTUAL_PATH','SCRIPT_FILENAME') as $key)
83 $fp = fopen($file, "wb");
84 fwrite($fp,"<?php\n");
85 fwrite($fp,"function wiki_configrestore(){\n");
86 //TODO: optimize this by removing ignore, big serialized array and merge into existing GLOBALS
87 foreach ($vars as $var => $val) {
89 fwrite($fp, "\$GLOBALS['".$var."']=unserialize(\"".addslashes(serialize($val))."\");\n");
91 // cannot be optimized, maybe leave away predefined consts somehow
92 foreach (get_defined_constants() as $var => $val) {
93 if (substr($var,0,4) != "PHP_" and substr($var,0,2) != "E_" and substr($var,0,2) != "T_" and substr($var,0,2) != "M_")
94 fwrite($fp, "if(!defined('".$var."')) define('".$var."',unserialize(\"".addslashes(serialize($val))."\"));\n");
96 fwrite($fp, "return 'noerr';}");
101 function IniConfig($file) {
103 // check config/config.php dump for faster startup
104 $dump = substr($file, 0, -3)."php";
105 if (isWindows($dump)) $dump = str_replace("/","\\",$dump);
106 if (file_exists($dump) and is_readable($dump) and sort_file_mtime($dump, $file) < 0) {
108 if (function_exists('wiki_configrestore') and (wiki_configrestore() === 'noerr')) {
109 fixup_dynamic_configs();
114 if (!file_exists($file)) {
115 // first-time installer detection here...
116 // similar to SetupWiki()
117 include(dirname(__FILE__)."/install.php");
118 trigger_error("Datasource file '$file' does not exist", E_USER_ERROR);
122 // List of all valid config options to be define()d which take "values" (not
123 // booleans). Needs to be categorised, and generally made a lot tidier.
124 $_IC_VALID_VALUE = array
125 ('WIKI_NAME', 'ADMIN_USER', 'ADMIN_PASSWD',
126 'DEFAULT_DUMP_DIR', 'HTML_DUMP_DIR',
127 'HTML_DUMP_SUFFIX', 'MAX_UPLOAD_SIZE', 'MINOR_EDIT_TIMEOUT',
128 'ACCESS_LOG', 'CACHE_CONTROL', 'CACHE_CONTROL_MAX_AGE',
129 'COOKIE_EXPIRATION_DAYS', 'COOKIE_DOMAIN',
130 'PASSWORD_LENGTH_MINIMUM', 'USER_AUTH_POLICY',
132 'EDITING_POLICY', 'THEME', 'CHARSET',
133 'WIKI_PGSRC', 'DEFAULT_WIKI_PGSRC',
134 'ALLOWED_PROTOCOLS', 'INLINE_IMAGES', 'SUBPAGE_SEPARATOR', /*'KEYWORDS',*/
136 //'DATABASE_PREFIX', 'DATABASE_DSN', 'DATABASE_TYPE', 'DATABASE_DBHANDLER',
137 'INTERWIKI_MAP_FILE', 'COPYRIGHTPAGE_TITLE', 'COPYRIGHTPAGE_URL',
138 'AUTHORPAGE_TITLE', 'AUTHORPAGE_URL',
140 'PLUGIN_CACHED_DATABASE', 'PLUGIN_CACHED_FILENAME_PREFIX',
141 'PLUGIN_CACHED_HIGHWATER', 'PLUGIN_CACHED_LOWWATER', 'PLUGIN_CACHED_MAXLIFETIME',
142 'PLUGIN_CACHED_MAXARGLEN', 'PLUGIN_CACHED_IMGTYPES',
144 'SERVER_NAME','SERVER_PORT','SCRIPT_NAME', 'DATA_PATH', 'PHPWIKI_DIR', 'VIRTUAL_PATH',
147 // Optional values which need to be defined.
148 // These are not defined in config-default.ini and empty if not defined.
149 $_IC_OPTIONAL_VALUE = array
151 'DEBUG', 'TEMP_DIR', 'DEFAULT_LANGUAGE',
152 'LDAP_AUTH_HOST','LDAP_SET_OPTION','LDAP_BASE_DN', 'LDAP_AUTH_USER',
153 'LDAP_AUTH_PASSWORD','LDAP_SEARCH_FIELD','LDAP_OU_GROUP','LDAP_OU_USERS',
154 'AUTH_USER_FILE','DBAUTH_AUTH_DSN',
155 'IMAP_AUTH_HOST', 'POP3_AUTH_HOST',
156 'AUTH_USER_FILE', 'AUTH_GROUP_FILE', 'AUTH_SESS_USER', 'AUTH_SESS_LEVEL',
157 'GOOGLE_LICENSE_KEY','FORTUNE_DIR',
158 'DISABLE_GETIMAGESIZE','DBADMIN_USER','DBADMIN_PASSWD',
162 // List of all valid config options to be define()d which take booleans.
163 $_IC_VALID_BOOL = array
164 ('ENABLE_USER_NEW', 'ENABLE_PAGEPERM', 'ENABLE_EDIT_TOOLBAR', 'JS_SEARCHREPLACE',
165 'ENABLE_XHTML_XML', 'ENABLE_DOUBLECLICKEDIT',
166 'USECACHE', 'WIKIDB_NOCACHE_MARKUP',
167 'ENABLE_REVERSE_DNS', 'ENCRYPTED_PASSWD', 'ZIPDUMP_AUTH',
168 'ENABLE_RAW_HTML', 'ENABLE_RAW_HTML_LOCKEDONLY', 'ENABLE_RAW_HTML_SAFE',
169 'STRICT_MAILABLE_PAGEDUMPS', 'COMPRESS_OUTPUT',
170 'ALLOW_ANON_USER', 'ALLOW_ANON_EDIT',
171 'ALLOW_BOGO_LOGIN', 'ALLOW_USER_PASSWORDS',
172 'AUTH_USER_FILE_STORABLE', 'ALLOW_HTTP_AUTH_LOGIN',
173 'ALLOW_USER_LOGIN', 'ALLOW_LDAP_LOGIN', 'ALLOW_IMAP_LOGIN',
174 'WARN_NONPUBLIC_INTERWIKIMAP', 'USE_PATH_INFO',
175 'DISABLE_HTTP_REDIRECT',
176 'PLUGIN_CACHED_USECACHE', 'PLUGIN_CACHED_FORCE_SYNCMAP',
177 'BLOG_EMPTY_DEFAULT_PREFIX',
180 $rs = @parse_ini_file($file);
181 $rsdef = @parse_ini_file(dirname(__FILE__)."/../config/config-default.ini");
182 foreach ($rsdef as $k => $v) {
184 $rs[$k] = constant($k);
185 } elseif (!isset($rs[$k])) {
189 unset($k); unset($v);
191 foreach ($_IC_VALID_VALUE as $item) {
192 if (defined($item)) {
196 if (array_key_exists($item, $rs)) {
197 define($item, $rs[$item]);
199 //} elseif (array_key_exists($item, $rsdef)) {
200 // define($item, $rsdef[$item]);
201 // calculate them later or not at all:
202 } elseif (in_array($item,
203 array('DATABASE_PREFIX', 'SERVER_NAME', 'SERVER_PORT',
204 'SCRIPT_NAME', 'DATA_PATH', 'PHPWIKI_DIR', 'VIRTUAL_PATH',
205 'LDAP_AUTH_HOST','IMAP_AUTH_HOST','POP3_AUTH_HOST',
206 'PLUGIN_CACHED_CACHE_DIR')))
210 trigger_error(sprintf("missing config setting for %s",$item));
215 // Boolean options are slightly special - if they're set to any of
216 // '', 'false', '0', or 'no' (all case-insensitive) then the value will
217 // be a boolean false, otherwise if there is anything set it'll
219 foreach ($_IC_VALID_BOOL as $item) {
220 if (defined($item)) {
224 if (array_key_exists($item, $rs)) {
226 //} elseif (array_key_exists($item, $rsdef)) {
227 // $val = $rsdef[$item];
229 $val = false; //trigger_error(sprintf("missing boolean config setting for %s",$item));
232 // calculate them later: old or dynamic constants
233 if (!array_key_exists($item, $rs) and
234 in_array($item,array('USE_PATH_INFO', 'USE_DB_SESSION',
235 'ALLOW_HTTP_AUTH_LOGIN', 'ALLOW_LDAP_LOGIN',
236 'ALLOW_IMAP_LOGIN', 'ALLOW_USER_LOGIN',
237 'REQUIRE_SIGNIN_BEFORE_EDIT',
238 'WIKIDB_NOCACHE_MARKUP')))
243 define($item, false);
245 elseif (strtolower($val) == 'false' ||
246 strtolower($val) == 'no' ||
250 define($item, false);
261 foreach (array('DATABASE_TYPE' => 'dbtype',
262 'DATABASE_DSN' => 'dsn',
263 'DATABASE_SESSION_TABLE' => 'db_session_table',
264 'DATABASE_DBA_HANDLER' => 'dba_handler',
265 'DATABASE_DIRECTORY' => 'directory',
266 'DATABASE_TIMEOUT' => 'timeout',
267 'DATABASE_PREFIX' => 'prefix')
270 if (defined($item)) {
271 $DBParams[$k] = constant($item);
273 } elseif (array_key_exists($item, $rs)) {
274 $DBParams[$k] = $rs[$item];
275 define($item, $rs[$item]);
277 } elseif (array_key_exists($item, $rsdef)) {
278 $DBParams[$k] = $rsdef[$item];
279 define($item, $rsdef[$item]);
280 unset($rsdef[$item]);
283 // USE_DB_SESSION default logic:
284 if (!defined('USE_DB_SESSION')) {
285 if ($DBParams['db_session_table']
286 and in_array($DBParams['dbtype'], array('SQL','ADODB'))) {
287 define('USE_DB_SESSION', true);
288 } elseif ($DBParams['dbtype'] == 'dba' and check_php_version(4,1,2)) {
289 define('USE_DB_SESSION', true);
291 define('USE_DB_SESSION', false);
294 unset($item); unset($k);
297 global $ExpireParams;
298 foreach (array('major','minor','author') as $major) {
299 foreach (array('max_age','min_age','min_keep','keep','max_keep') as $max) {
300 $item = strtoupper($major) . '_'. strtoupper($max);
301 if (defined($item)) $val = constant($item);
302 elseif (array_key_exists($item, $rs))
304 elseif (array_key_exists($item, $rsdef))
305 $val = $rsdef[$item];
306 if (!isset($ExpireParams[$major]))
307 $ExpireParams[$major] = array();
308 $ExpireParams[$major][$max] = $val;
312 unset($item); unset($major); unset($max);
314 // User authentication
315 if (!isset($GLOBALS['USER_AUTH_ORDER']))
316 if (isset($rs['USER_AUTH_ORDER']))
317 $GLOBALS['USER_AUTH_ORDER'] = preg_split('/\s*:\s*/',
318 $rs['USER_AUTH_ORDER']);
320 $GLOBALS['USER_AUTH_ORDER'] = array("PersonalPage");
322 // Now it's the external DB authentication stuff's turn
323 if (in_array('Db', $GLOBALS['USER_AUTH_ORDER']) && empty($rs['DBAUTH_AUTH_DSN'])) {
324 $rs['DBAUTH_AUTH_DSN'] = $DBParams['dsn'];
327 global $DBAuthParams;
328 $DBAP_MAP = array('DBAUTH_AUTH_DSN' => 'auth_dsn',
329 'DBAUTH_AUTH_CHECK' => 'auth_check',
330 'DBAUTH_AUTH_USER_EXISTS' => 'auth_user_exists',
331 'DBAUTH_AUTH_CRYPT_METHOD' => 'auth_crypt_method',
332 'DBAUTH_AUTH_UPDATE' => 'auth_update',
333 'DBAUTH_AUTH_CREATE' => 'auth_create',
334 'DBAUTH_PREF_SELECT' => 'pref_select',
335 'DBAUTH_PREF_UPDATE' => 'pref_update',
336 'DBAUTH_IS_MEMBER' => 'is_member',
337 'DBAUTH_GROUP_MEMBERS' => 'group_members',
338 'DBAUTH_USER_GROUPS' => 'user_groups'
340 foreach ($DBAP_MAP as $rskey => $apkey) {
341 if (defined($rskey)) {
342 $DBAuthParams[$apkey] = constant($rskey);
343 } elseif (isset($rs[$rskey])) {
344 $DBAuthParams[$apkey] = $rs[$rskey];
345 define($rskey, $rs[$rskey]);
346 } elseif (isset($rsdef[$rskey])) {
347 $DBAuthParams[$apkey] = $rsdef[$rskey];
348 define($rskey, $rsdef[$rskey]);
352 unset($rskey); unset($apkey);
354 // currently unsupported on non-SQL
355 if (!empty($rs['ACCESS_LOG_SQL'])) {
356 if (!in_array($DBParams['dbtype'], array('SQL','ADODB')))
357 define('ACCESS_LOG_SQL', 0);
360 define('ACCESS_LOG_SQL', 0);
362 // optional values will be set to '' to simplify the logic.
363 foreach ($_IC_OPTIONAL_VALUE as $item) {
364 if (defined($item)) {
368 if (array_key_exists($item, $rs)) {
369 define($item, $rs[$item]);
377 global $LDAP_SET_OPTION;
378 if (defined('LDAP_SET_OPTION') and LDAP_SET_OPTION) {
379 $optlist = preg_split('/\s*:\s*/', LDAP_SET_OPTION);
380 foreach ($optlist as $opt) {
381 $bits = preg_split('/\s*=\s*/', $opt, 2);
382 if (count($bits) == 2) {
383 if (is_string($bits[0]) and defined($bits[0]))
384 $bits[0] = constant($bits[0]);
385 $LDAP_SET_OPTION[$bits[0]] = $bits[1];
388 // Possibly throw some sort of error?
391 unset($opt); unset($bits);
394 // Default Wiki pages to force loading from pgsrc
395 global $GenericPages;
396 $GenericPages = preg_split('/\s*:\s*/', @$rs['DEFAULT_WIKI_PAGES']);
398 // Wiki name regexp: Should be a define(), but might needed to be changed at runtime
399 // (different LC_CHAR need different posix classes)
400 global $WikiNameRegexp;
401 $WikiNameRegexp = constant('WIKI_NAME_REGEXP');
402 if (!trim($WikiNameRegexp))
403 $WikiNameRegexp = '(?<![[:alnum:]])(?:[[:upper:]][[:lower:]]+){2,}(?![[:alnum:]])';
405 // got rid of global $KeywordLinkRegexp by using a TextSearchQuery instead of "Category:Topic"
406 if (!isset($rs['KEYWORDS'])) $rs['KEYWORDS'] = @$rsdef['KEYWORDS'];
407 if (!isset($rs['KEYWORDS'])) $rs['KEYWORDS'] = "Category* OR Topic*";
408 if ($rs['KEYWORDS'] == 'Category:Topic') $rs['KEYWORDS'] = "Category* OR Topic*";
409 if (!defined('KEYWORDS')) define('KEYWORDS', $rs['KEYWORDS']);
410 //if (empty($keywords)) $keywords = array("Category","Topic");
411 //$KeywordLinkRegexp = '(?<=' . implode('|^', $keywords) . ')[[:upper:]].*$';
413 // TODO: can this be a constant?
414 global $DisabledActions;
415 if (!array_key_exists('DISABLED_ACTIONS', $rs) and array_key_exists('DISABLED_ACTIONS', $rsdef))
416 $rs['DISABLED_ACTIONS'] = @$rsdef['DISABLED_ACTIONS'];
417 if (array_key_exists('DISABLED_ACTIONS', $rs))
418 $DisabledActions = preg_split('/\s*:\s*/', $rs['DISABLED_ACTIONS']);
420 global $PLUGIN_CACHED_IMGTYPES;
421 $PLUGIN_CACHED_IMGTYPES = preg_split('/\s*[|:]\s*/', PLUGIN_CACHED_IMGTYPES);
422 if (empty($rs['PLUGIN_CACHED_CACHE_DIR']) and !empty($rsdef['PLUGIN_CACHED_CACHE_DIR']))
423 $rs['PLUGIN_CACHED_CACHE_DIR'] = $rsdef['PLUGIN_CACHED_CACHE_DIR'];
424 if (empty($rs['PLUGIN_CACHED_CACHE_DIR'])) {
425 if (!empty($rs['INCLUDE_PATH'])) {
426 ini_set('include_path', $rs['INCLUDE_PATH']);
428 if (!FindFile('/tmp/cache', 1)) { // [29ms]
429 if (!FindFile('/tmp', 1)) {
432 mkdir('/tmp/cache', 777);
434 // will throw an error if not exists.
435 define('PLUGIN_CACHED_CACHE_DIR', FindFile('/tmp/cache',false,1));
437 define('PLUGIN_CACHED_CACHE_DIR', $rs['PLUGIN_CACHED_CACHE_DIR']);
438 // will throw an error if not exists.
439 FindFile(PLUGIN_CACHED_CACHE_DIR);
442 // process the rest of the config.ini settings:
443 foreach ($rs as $item => $v) {
444 if (defined($item)) {
450 unset($item); unset($v);
455 fixup_static_configs(); //[1ms]
456 // Dump all globals and constants
457 // The question is if reading this is faster then doing IniConfig() + fixup_static_configs()
458 if (is_writable($dump)) {
461 // store locale[] in config.php? This is too problematic.
462 fixup_dynamic_configs(); // [100ms]
465 // moved from lib/config.php [1ms]
466 function fixup_static_configs() {
467 global $FieldSeparator, $charset, $WikiNameRegexp, $KeywordLinkRegexp, $AllActionPages;
468 global $HTTP_SERVER_VARS, $DBParams, $LANG;
470 // init FileFinder to add proper include paths
471 FindFile("lib/interwiki.map",true);
473 // "\x80"-"\x9f" (and "\x00" - "\x1f") are non-printing control
474 // chars in iso-8859-*
475 // $FieldSeparator = "\263"; // this is a superscript 3 in ISO-8859-1.
476 // $FieldSeparator = "\xFF"; // this byte should never appear in utf-8
477 // FIXME: get rid of constant. pref is dynamic and language specific
479 // Disabled: Let the admin decide which charset.
480 //if (isset($LANG) and in_array($LANG,array('zh')))
481 // $charset = 'utf-8';
482 if (strtolower($charset) == 'utf-8')
483 $FieldSeparator = "\xFF";
485 $FieldSeparator = "\x81";
487 $AllActionPages = explode(':',
488 'AllPages:BackLinks:CreatePage:DebugInfo:EditMetaData:FindPage:'
489 .'FullRecentChanges:FullTextSearch:FuzzyPages:InterWikiSearch:'
490 .'LikePages:MostPopular:'
491 .'OrphanedPages:PageDump:PageHistory:PageInfo:RandomPage:RateIt:'
492 .'RecentChanges:RecentEdits:RecentComments:RelatedChanges:TitleSearch:'
493 .'TranslateText:UpLoad:UserPreferences:WantedPages:WhoIsOnline:'
494 .'PhpWikiAdministration/Remove:PhpWikiAdministration/Chmod:'
495 .'PhpWikiAdministration/Rename:PhpWikiAdministration/Replace:'
496 .'PhpWikiAdministration/SetAcl:PhpWikiAdministration/Chown'
499 // If user has not defined PHPWIKI_DIR, and we need it
500 if (!defined('PHPWIKI_DIR') and !file_exists("themes/default")) {
501 $themes_dir = FindFile("themes");
502 define('PHPWIKI_DIR', dirname($themes_dir));
505 // If user has not defined DATA_PATH, we want to use relative URLs.
506 if (!defined('DATA_PATH')) {
507 // fix similar to the one suggested by jkalmbach for
508 // installations in the webrootdir, like "http://phpwiki.org/HomePage"
509 if (!defined('SCRIPT_NAME'))
510 define('SCRIPT_NAME', deduce_script_name());
511 $temp = dirname(SCRIPT_NAME);
512 if ( ($temp == '/') || ($temp == '\\') )
514 define('DATA_PATH', $temp);
517 define('DATA_PATH', '..');
521 //////////////////////////////////////////////////////////////////
524 if (empty($DBParams['dbtype']))
525 $DBParams['dbtype'] = 'dba';
527 if (!defined('THEME'))
528 define('THEME', 'default');
530 // check whether the crypt() function is needed and present
531 if (defined('ENCRYPTED_PASSWD') && !function_exists('crypt')) {
532 $error = sprintf("Encrypted passwords cannot be used: %s.",
533 "'function crypt()' not available in this version of php");
534 trigger_error($error);
537 if (!defined('ADMIN_PASSWD') or ADMIN_PASSWD == '')
538 trigger_error("The admin password cannot be empty. Please update your config/config.ini");
540 if (defined('USE_DB_SESSION') and USE_DB_SESSION) {
541 if (! $DBParams['db_session_table'] ) {
542 $DBParams['db_session_table'] = @$DBParams['prefix'] . 'session';
543 trigger_error(sprintf("DATABASE_SESSION_TABLE configuration set to %s.",
544 $DBParams['db_session_table']),
549 if (!defined('ENABLE_USER_NEW')) define('ENABLE_USER_NEW',true);
550 if (!defined('ALLOW_USER_LOGIN'))
551 define('ALLOW_USER_LOGIN', defined('ALLOW_USER_PASSWORDS') && ALLOW_USER_PASSWORDS);
552 if (!defined('ALLOW_ANON_USER')) define('ALLOW_ANON_USER', true);
553 if (!defined('ALLOW_ANON_EDIT')) define('ALLOW_ANON_EDIT', false);
554 if (!defined('REQUIRE_SIGNIN_BEFORE_EDIT')) define('REQUIRE_SIGNIN_BEFORE_EDIT', ! ALLOW_ANON_EDIT);
555 if (!defined('ALLOW_BOGO_LOGIN')) define('ALLOW_BOGO_LOGIN', true);
556 if (!ENABLE_USER_NEW) {
557 if (!defined('ALLOW_HTTP_AUTH_LOGIN'))
558 define('ALLOW_HTTP_AUTH_LOGIN', false);
559 if (!defined('ALLOW_LDAP_LOGIN'))
560 define('ALLOW_LDAP_LOGIN', function_exists('ldap_connect') and defined('LDAP_AUTH_HOST'));
561 if (!defined('ALLOW_IMAP_LOGIN'))
562 define('ALLOW_IMAP_LOGIN', function_exists('imap_open') and defined('IMAP_AUTH_HOST'));
565 if (ALLOW_USER_LOGIN and !empty($DBAuthParams) and empty($DBAuthParams['auth_dsn'])) {
566 if (isset($DBParams['dsn']))
567 $DBAuthParams['auth_dsn'] = $DBParams['dsn'];
572 * Define constants which are client or request specific and should not be dumped statically.
573 * Such as the language, and the virtual and server paths, which might be overridden
574 * by startup scripts for wiki farms.
576 function fixup_dynamic_configs() {
577 global $WikiNameRegexp, $KeywordLinkRegexp;
578 global $HTTP_SERVER_VARS, $DBParams, $LANG;
580 if (defined('INCLUDE_PATH'))
581 ini_set('include_path', INCLUDE_PATH);
582 if (defined('SESSION_SAVE_PATH'))
583 ini_set('session.save_path', SESSION_SAVE_PATH);
584 if (!defined('DEFAULT_LANGUAGE')) // not needed anymore
585 define('DEFAULT_LANGUAGE', ''); // detect from client
587 update_locale(isset($LANG) ? $LANG : DEFAULT_LANGUAGE);
589 // Set up (possibly fake) gettext()
590 // Todo: this could be moved to fixup_static_configs()
591 if (!function_exists ('bindtextdomain')) {
594 function gettext ($text) {
596 if (!empty ($locale[$text]))
597 return $locale[$text];
602 return gettext($text);
606 // Working around really weird gettext problems: (4.3.2, 4.3.6 win)
607 // bindtextdomain() returns the current domain path.
608 // 1. If the script is not index.php but something like "de", on a different path
609 // then bindtextdomain() fails, but after chdir to the correct path it will work okay.
610 // 2. But the weird error "Undefined variable: bindtextdomain" is generated then.
611 $bindtextdomain_path = FindFile("locale", false, true);
614 $bindtextdomain_path = str_replace("/", "\\", $bindtextdomain_path);
615 $bindtextdomain_real = @bindtextdomain("phpwiki", $bindtextdomain_path);
616 if ($bindtextdomain_real != $bindtextdomain_path) {
617 // this will happen with virtual_paths. chdir and try again.
618 chdir($bindtextdomain_path);
620 $bindtextdomain_real = @bindtextdomain("phpwiki", $bindtextdomain_path);
622 textdomain("phpwiki");
623 if ($chback) { // change back
624 chdir($bindtextdomain_real . (isWindows() ? "\\.." : "/.."));
628 // language dependent updates:
629 $WikiNameRegexp = pcre_fix_posix_classes($WikiNameRegexp);
630 $KeywordLinkRegexp = pcre_fix_posix_classes($KeywordLinkRegexp);
631 if (!defined('CATEGORY_GROUP_PAGE'))
632 define('CATEGORY_GROUP_PAGE',_("CategoryGroup"));
633 if (!defined('WIKI_NAME'))
634 define('WIKI_NAME', _("An unnamed PhpWiki"));
635 if (!defined('HOME_PAGE'))
636 define('HOME_PAGE', _("HomePage"));
639 //////////////////////////////////////////////////////////////////
640 // Autodetect URL settings:
642 foreach (array('SERVER_NAME','SERVER_PORT') as $var) {
643 //FIXME: for CGI without _SERVER
644 if (!defined($var) and !empty($HTTP_SERVER_VARS[$var]))
645 define($var, $HTTP_SERVER_VARS[$var]);
647 if (!defined('SERVER_PROTOCOL')) {
648 if (empty($HTTP_SERVER_VARS['HTTPS']) || $HTTP_SERVER_VARS['HTTPS'] == 'off')
649 define('SERVER_PROTOCOL', 'http');
651 define('SERVER_PROTOCOL', 'https');
654 if (!defined('SCRIPT_NAME'))
655 define('SCRIPT_NAME', deduce_script_name());
657 if (!defined('USE_PATH_INFO')) {
659 define('USE_PATH_INFO', false);
662 * If SCRIPT_NAME does not look like php source file,
663 * or user cgi we assume that php is getting run by an
664 * action handler in /cgi-bin. In this case,
665 * I think there is no way to get Apache to pass
666 * useful PATH_INFO to the php script (PATH_INFO
667 * is used to the the php interpreter where the
670 switch (php_sapi_name()) {
672 case 'apache2handler':
673 define('USE_PATH_INFO', true);
676 case 'apache2filter':
677 define('USE_PATH_INFO', false);
680 define('USE_PATH_INFO', ereg('\.(php3?|cgi)$', SCRIPT_NAME));
687 && SERVER_PORT != (SERVER_PROTOCOL == 'https' ? 443 : 80)) {
689 SERVER_PROTOCOL . '://' . SERVER_NAME . ':' . SERVER_PORT);
693 SERVER_PROTOCOL . '://' . SERVER_NAME);
696 if (!defined('VIRTUAL_PATH')) {
697 // We'd like to auto-detect when the cases where apaches
698 // 'Action' directive (or similar means) is used to
699 // redirect page requests to a cgi-handler.
701 // In cases like this, requests for e.g. /wiki/HomePage
702 // get redirected to a cgi-script called, say,
703 // /path/to/wiki/index.php. The script gets all
704 // of /wiki/HomePage as it's PATH_INFO.
707 // How to detect when this has happened reliably?
708 // How to pick out the "virtual path" (in this case '/wiki')?
710 // (Another time an redirect might occur is to a DirectoryIndex
711 // -- the requested URI is '/wikidir/', the request gets
712 // passed to '/wikidir/index.php'. In this case, the
713 // proper VIRTUAL_PATH is '/wikidir/index.php', since the
714 // pages will appear at e.g. '/wikidir/index.php/HomePage'.
717 $REDIRECT_URL = &$HTTP_SERVER_VARS['REDIRECT_URL'];
718 if (USE_PATH_INFO and isset($REDIRECT_URL)
719 and ! IsProbablyRedirectToIndex()) {
720 // FIXME: This is a hack, and won't work if the requested
721 // pagename has a slash in it.
722 $temp = strtr(dirname($REDIRECT_URL . 'x'),"\\",'/');
723 if ( ($temp == '/') || ($temp == '\\') )
725 define('VIRTUAL_PATH', $temp);
727 define('VIRTUAL_PATH', SCRIPT_NAME);
731 if (VIRTUAL_PATH != SCRIPT_NAME) {
732 // Apache action handlers are used.
733 define('PATH_INFO_PREFIX', VIRTUAL_PATH . '/');
736 define('PATH_INFO_PREFIX', '/');
738 define('PHPWIKI_BASE_URL',
739 SERVER_URL . (USE_PATH_INFO ? VIRTUAL_PATH . '/' : SCRIPT_NAME));
741 // Detect PrettyWiki setup (not loading index.php directly)
742 // $SCRIPT_FILENAME should be the same as __FILE__ in index.php
743 if (!isset($SCRIPT_FILENAME))
744 $SCRIPT_FILENAME = @$HTTP_SERVER_VARS['SCRIPT_FILENAME'];
745 if (!isset($SCRIPT_FILENAME))
746 $SCRIPT_FILENAME = @$HTTP_ENV_VARS['SCRIPT_FILENAME'];
747 if (!isset($SCRIPT_FILENAME))
748 $SCRIPT_FILENAME = dirname(__FILE__.'/../') . '/index.php';
750 $SCRIPT_FILENAME = str_replace('\\\\','\\',strtr($SCRIPT_FILENAME, '/', '\\'));
751 define('SCRIPT_FILENAME', $SCRIPT_FILENAME);
753 // Get remote host name, if apache hasn't done it for us
754 if (empty($HTTP_SERVER_VARS['REMOTE_HOST'])
755 and !empty($HTTP_SERVER_VARS['REMOTE_ADDR'])
756 and ENABLE_REVERSE_DNS)
757 $HTTP_SERVER_VARS['REMOTE_HOST'] = gethostbyaddr($HTTP_SERVER_VARS['REMOTE_ADDR']);
761 // $Log: not supported by cvs2svn $
762 // Revision 1.68 2004/12/14 21:35:15 rurban
763 // support new BLOG_EMPTY_DEFAULT_PREFIX
765 // Revision 1.67 2004/11/30 09:51:35 rurban
766 // changed KEYWORDS from pageprefix to search term. added installer detection.
768 // Revision 1.66 2004/11/17 17:23:12 rurban
769 // fixed chdir back from locale
771 // Revision 1.65 2004/11/11 10:31:26 rurban
772 // Disable default options in config-dist.ini
773 // Add new CATEGORY_GROUP_PAGE root page: Default: Translation of "CategoryGroup"
774 // Clarify more options.
776 // Revision 1.64 2004/11/09 17:11:03 rurban
777 // * revert to the wikidb ref passing. there's no memory abuse there.
778 // * use new wikidb->_cache->_id_cache[] instead of wikidb->_iwpcache, to effectively
779 // store page ids with getPageLinks (GleanDescription) of all existing pages, which
780 // are also needed at the rendering for linkExistingWikiWord().
781 // pass options to pageiterator.
782 // use this cache also for _get_pageid()
783 // This saves about 8 SELECT count per page (num all pagelinks).
784 // * fix passing of all page fields to the pageiterator.
785 // * fix overlarge session data which got broken with the latest ACCESS_LOG_SQL changes
787 // Revision 1.63 2004/11/07 16:47:32 rurban
790 // Revision 1.62 2004/11/07 16:02:51 rurban
791 // new sql access log (for spam prevention), and restructured access log class
792 // dbh->quote (generic)
793 // pear_db: mysql specific parts seperated (using replace)
795 // Revision 1.61 2004/11/06 17:01:30 rurban
796 // unify DATABASE constants init as with DBAUTH
798 // Revision 1.60 2004/11/06 03:06:58 rurban
799 // make use of dumped static config state in config/config.php (if writable)
801 // Revision 1.59 2004/11/05 20:53:35 rurban
802 // login cleanup: better debug msg on failing login,
803 // checked password less immediate login (bogo or anon),
804 // checked olduser pref session error,
805 // better PersonalPage without password warning on minimal password length=0
806 // (which is default now)
808 // Revision 1.58 2004/11/03 16:50:31 rurban
809 // some new defaults and constants, renamed USE_DOUBLECLICKEDIT to ENABLE_DOUBLECLICKEDIT
811 // Revision 1.57 2004/11/01 10:43:55 rurban
812 // seperate PassUser methods into seperate dir (memory usage)
813 // fix WikiUser (old) overlarge data session
814 // remove wikidb arg from various page class methods, use global ->_dbi instead
817 // Revision 1.56 2004/10/21 20:20:53 rurban
818 // From patch #970004 "Double clic to edit" by pixels.
820 // Revision 1.55 2004/10/14 19:23:58 rurban
821 // remove debugging prints
823 // Revision 1.54 2004/10/14 17:13:01 rurban
824 // use DATABASE_PREFIX
826 // Revision 1.53 2004/10/12 13:13:19 rurban
827 // php5 compatibility (5.0.1 ok)
829 // Revision 1.52 2004/10/04 23:38:07 rurban
832 // Revision 1.51 2004/09/20 13:40:19 rurban
833 // define all config.ini settings, only the supported will be taken from -default.
834 // support USE_EXTERNAL_HTML2PDF renderer (htmldoc tested)
836 // Revision 1.50 2004/09/06 09:28:58 rurban
837 // fix PLUGIN_CACHED_CACHE_DIR fallback logic. ini entry did not work before
839 // Revision 1.49 2004/07/13 13:07:27 rurban
840 // improved DB_SESSION logic
842 // Revision 1.48 2004/07/05 13:09:37 rurban
843 // ENABLE_RAW_HTML_LOCKEDONLY, ENABLE_RAW_HTML_SAFE
845 // Revision 1.47 2004/07/03 16:51:05 rurban
846 // optional DBADMIN_USER:DBADMIN_PASSWD for action=upgrade (if no ALTER permission)
847 // added atomic mysql REPLACE for PearDB as in ADODB
848 // fixed _lock_tables typo links => link
849 // fixes unserialize ADODB bug in line 180
851 // Revision 1.46 2004/07/02 09:55:58 rurban
852 // more stability fixes: new DISABLE_GETIMAGESIZE if your php crashes when loading LinkIcons: failing getimagesize in old phps; blockparser stabilized
854 // Revision 1.45 2004/07/01 08:51:21 rurban
855 // dumphtml: added exclude, print pagename before processing
857 // Revision 1.44 2004/06/29 08:52:22 rurban
858 // Use ...version() $need_content argument in WikiDB also:
859 // To reduce the memory footprint for larger sets of pagelists,
860 // we don't cache the content (only true or false) and
861 // we purge the pagedata (_cached_html) also.
862 // _cached_html is only cached for the current pagename.
863 // => Vastly improved page existance check, ACL check, ...
865 // Now only PagedList info=content or size needs the whole content, esp. if sortable.
867 // Revision 1.43 2004/06/29 06:48:02 rurban
868 // Improve LDAP auth and GROUP_LDAP membership:
869 // no error message on false password,
870 // added two new config vars: LDAP_OU_USERS and LDAP_OU_GROUP with GROUP_METHOD=LDAP
871 // fixed two group queries (this -> user)
872 // stdlib: ConvertOldMarkup still flawed
874 // Revision 1.42 2004/06/28 15:01:07 rurban
875 // fixed LDAP_SET_OPTION handling, LDAP error on connection problem
877 // Revision 1.41 2004/06/25 14:29:17 rurban
878 // WikiGroup refactoring:
879 // global group attached to user, code for not_current user.
880 // improved helpers for special groups (avoid double invocations)
881 // new experimental config option ENABLE_XHTML_XML (fails with IE, and document.write())
882 // fixed a XHTML validation error on userprefs.tmpl
884 // Revision 1.40 2004/06/22 07:12:48 rurban
885 // removed USE_TAGLINES constant
887 // Revision 1.39 2004/06/21 16:22:28 rurban
888 // add DEFAULT_DUMP_DIR and HTML_DUMP_DIR constants, for easier cmdline dumps,
889 // fixed dumping buttons locally (images/buttons/),
890 // support pages arg for dumphtml,
891 // optional directory arg for dumpserial + dumphtml,
892 // fix a AllPages warning,
893 // show dump warnings/errors on DEBUG,
894 // don't warn just ignore on wikilens pagelist columns, if not loaded.
895 // RateIt pagelist column is called "rating", not "ratingwidget" (Dan?)
897 // Revision 1.38 2004/06/21 08:39:36 rurban
898 // pear/Cache update from Cache-1.5.4 (added db and trifile container)
899 // pear/DB update from DB-1.6.1 (mysql bugfixes, php5 compat, DB_PORTABILITY features)
901 // Revision 1.37 2004/06/19 12:32:37 rurban
902 // new TEMP_DIR for ziplib
904 // Revision 1.36 2004/06/19 10:06:37 rurban
905 // Moved lib/plugincache-config.php to config/*.ini
906 // use PLUGIN_CACHED_* constants instead of global $CacheParams
908 // Revision 1.35 2004/06/15 09:15:52 rurban
909 // IMPORTANT: fixed passwd handling for passwords stored in prefs:
910 // fix encrypted usage, actually store and retrieve them from db
911 // fix bogologin with passwd set.
912 // fix php crashes with call-time pass-by-reference (references wrongly used
913 // in declaration AND call). This affected mainly Apache2 and IIS.
914 // (Thanks to John Cole to detect this!)
916 // Revision 1.34 2004/06/13 13:54:25 rurban
917 // Catch fatals on the four dump calls (as file and zip, as html and mimified)
918 // FoafViewer: Check against external requirements, instead of fatal.
919 // Change output for xhtmldumps: using file:// urls to the local fs.
920 // Catch SOAP fatal by checking for GOOGLE_LICENSE_KEY
921 // Import GOOGLE_LICENSE_KEY and FORTUNE_DIR from config.ini.
923 // Revision 1.33 2004/06/08 19:48:16 rurban
924 // fixed foreign setup: no ugly skipped msg for the GenericPages, load english actionpages if translated not found
926 // Revision 1.32 2004/06/08 10:54:46 rurban
927 // better acl dump representation, read back acl and owner
929 // Revision 1.31 2004/06/06 16:58:51 rurban
930 // added more required ActionPages for foreign languages
931 // install now english ActionPages if no localized are found. (again)
932 // fixed default anon user level to be 0, instead of -1
933 // (wrong "required administrator to view this page"...)
935 // Revision 1.30 2004/06/04 12:40:21 rurban
936 // Restrict valid usernames to prevent from attacks against external auth or compromise
938 // Fix various WikiUser old issues with default IMAP,LDAP,POP3 configs. Removed these.
939 // Fxied more warnings
941 // Revision 1.29 2004/06/04 11:58:38 rurban
942 // added USE_TAGLINES
944 // Revision 1.28 2004/06/03 20:42:49 rurban
945 // fixed bad warning #964850
947 // Revision 1.27 2004/06/03 10:18:19 rurban
948 // fix FileUser locking issues, new config ENABLE_PAGEPERM
950 // Revision 1.26 2004/06/02 18:01:45 rurban
951 // init global FileFinder to add proper include paths at startup
952 // adds PHPWIKI_DIR if started from another dir, lib/pear also
953 // fix slashify for Windows
954 // fix USER_AUTH_POLICY=old, use only USER_AUTH_ORDER methods (besides HttpAuth)
956 // Revision 1.25 2004/05/27 17:49:05 rurban
957 // renamed DB_Session to DbSession (in CVS also)
958 // added WikiDB->getParam and WikiDB->getAuthParam method to get rid of globals
959 // remove leading slash in error message
960 // added force_unlock parameter to File_Passwd (no return on stale locks)
961 // fixed adodb session AffectedRows
962 // added FileFinder helpers to unify local filenames and DATA_PATH names
963 // editpage.php: new edit toolbar javascript on ENABLE_EDIT_TOOLBAR
965 // Revision 1.24 2004/05/18 13:33:13 rurban
966 // we already have a CGI function
968 // Revision 1.23 2004/05/17 17:43:29 rurban
969 // CGI: no PATH_INFO fix
971 // Revision 1.22 2004/05/16 22:07:35 rurban
972 // check more config-default and predefined constants
973 // various PagePerm fixes:
974 // fix default PagePerms, esp. edit and view for Bogo and Password users
975 // implemented Creator and Owner
976 // BOGOUSERS renamed to BOGOUSER
977 // fixed syntax errors in signin.tmpl
979 // Revision 1.21 2004/05/08 22:55:12 rurban
980 // Fixed longstanding sf.net:demo problem. endless loop, caused by an empty definition of
981 // WIKI_NAME_REGEXP. Exactly this constant wasn't checked for its default setting.
983 // Revision 1.20 2004/05/08 20:21:00 rurban
984 // remove php tags in Log
986 // Revision 1.19 2004/05/08 19:55:29 rurban
987 // support <span>inlined plugin-result</span>:
988 // if the plugin is parsed inside a line, use <span> instead of
989 // <div tightenable top bottom>
990 // e.g. for "This is the current Phpwiki <plugin SystemInfo version> version.
992 // Revision 1.18 2004/05/08 16:58:19 rurban
993 // don't ignore some false config values (e.g. USE_PATH_INFO false was ignored)
995 // Revision 1.17 2004/05/06 19:26:15 rurban
996 // improve stability, trying to find the InlineParser endless loop on sf.net
998 // remove end-of-zip comments to fix sf.net bug #777278 and probably #859628
1000 // Revision 1.16 2004/05/02 15:10:05 rurban
1001 // new finally reliable way to detect if /index.php is called directly
1002 // and if to include lib/main.php
1003 // new global AllActionPages
1004 // SetupWiki now loads all mandatory pages: HOME_PAGE, action pages, and warns if not.
1005 // WikiTranslation what=buttons for Carsten to create the missing MacOSX buttons
1006 // PageGroupTestOne => subpages
1007 // renamed PhpWikiRss to PhpWikiRecentChanges
1008 // more docs, default configs, ...
1010 // Revision 1.15 2004/05/01 15:59:29 rurban
1011 // more php-4.0.6 compatibility: superglobals
1013 // Revision 1.14 2004/04/29 23:25:12 rurban
1014 // re-ordered locale init (as in 1.3.9)
1015 // fixed loadfile with subpages, and merge/restore anyway
1016 // (sf.net bug #844188)
1018 // Revision 1.13 2004/04/29 21:54:05 rurban
1021 // Revision 1.12 2004/04/27 16:16:27 rurban
1022 // more subtle config problems with defaults
1024 // Revision 1.11 2004/04/26 20:44:34 rurban
1025 // locking table specific for better databases
1027 // Revision 1.10 2004/04/26 13:22:32 rurban
1028 // calculate bool old or dynamic constants later
1030 // Revision 1.9 2004/04/26 12:15:01 rurban
1031 // check default config values
1033 // Revision 1.8 2004/04/23 16:55:59 zorloc
1034 // If using Db auth and DBAUTH_AUTH_DSN is empty set DBAUTH_AUTH_DSN to $DBParams['dsn']
1036 // Revision 1.7 2004/04/20 22:26:27 zorloc
1037 // Removed Pear_Config for parse_ini_file().
1039 // Revision 1.6 2004/04/20 18:10:27 rurban
1040 // config refactoring:
1041 // FileFinder is needed for WikiFarm scripts calling index.php
1042 // config run-time calls moved to lib/IniConfig.php:fix_configs()
1043 // added PHPWIKI_DIR smart-detection code (Theme finder)
1044 // moved FileFind to lib/FileFinder.php
1045 // cleaned lib/config.php
1047 // Revision 1.5 2004/04/20 17:21:57 rurban
1048 // WikiFarm code: honor predefined constants
1050 // Revision 1.4 2004/04/20 17:08:19 rurban
1051 // Some IniConfig fixes: prepend our private lib/pear dir
1052 // switch from " to ' in the auth statements
1053 // use error handling.
1054 // WikiUserNew changes for the new "'$variable'" syntax
1055 // in the statements
1056 // TODO: optimization to put config vars into the session.
1059 // (c-file-style: "gnu")
1063 // c-basic-offset: 4
1064 // c-hanging-comment-ender-p: nil
1065 // indent-tabs-mode: nil