2 rcs_id('$Id: IniConfig.php,v 1.64 2004-11-09 17:11:03 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',
120 //'DATABASE_PREFIX', 'DATABASE_DSN', 'DATABASE_TYPE', 'DATABASE_DBHANDLER',
121 'INTERWIKI_MAP_FILE', 'COPYRIGHTPAGE_TITLE', 'COPYRIGHTPAGE_URL',
122 'AUTHORPAGE_TITLE', 'AUTHORPAGE_URL',
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',
128 'SERVER_NAME','SERVER_PORT','SCRIPT_NAME', 'DATA_PATH', 'PHPWIKI_DIR', 'VIRTUAL_PATH',
131 // Optional values which need to be defined.
132 // These are not defined in config-default.ini and empty if not defined.
133 $_IC_OPTIONAL_VALUE = array
136 'LDAP_AUTH_HOST','LDAP_SET_OPTION','LDAP_BASE_DN', 'LDAP_AUTH_USER',
137 'LDAP_AUTH_PASSWORD','LDAP_SEARCH_FIELD','LDAP_OU_GROUP','LDAP_OU_USERS',
138 'AUTH_USER_FILE','DBAUTH_AUTH_DSN',
139 'IMAP_AUTH_HOST', 'POP3_AUTH_HOST',
140 'AUTH_USER_FILE', 'AUTH_GROUP_FILE', 'AUTH_SESS_USER', 'AUTH_SESS_LEVEL',
141 'GOOGLE_LICENSE_KEY','FORTUNE_DIR',
142 'DISABLE_GETIMAGESIZE','DBADMIN_USER','DBADMIN_PASSWD',
146 // List of all valid config options to be define()d which take booleans.
147 $_IC_VALID_BOOL = array
148 ('ENABLE_USER_NEW', 'ENABLE_PAGEPERM', 'ENABLE_EDIT_TOOLBAR', 'JS_SEARCHREPLACE',
149 'ENABLE_XHTML_XML', 'ENABLE_DOUBLECLICKEDIT',
150 'USECACHE', 'WIKIDB_NOCACHE_MARKUP',
151 'ENABLE_REVERSE_DNS', 'ENCRYPTED_PASSWD', 'ZIPDUMP_AUTH',
152 'ENABLE_RAW_HTML', 'ENABLE_RAW_HTML_LOCKEDONLY', 'ENABLE_RAW_HTML_SAFE',
153 'STRICT_MAILABLE_PAGEDUMPS', 'COMPRESS_OUTPUT',
154 'ALLOW_ANON_USER', 'ALLOW_ANON_EDIT',
155 'ALLOW_BOGO_LOGIN', 'ALLOW_USER_PASSWORDS',
156 'AUTH_USER_FILE_STORABLE', 'ALLOW_HTTP_AUTH_LOGIN',
157 'ALLOW_USER_LOGIN', 'ALLOW_LDAP_LOGIN', 'ALLOW_IMAP_LOGIN',
158 'WARN_NONPUBLIC_INTERWIKIMAP', 'USE_PATH_INFO',
159 'DISABLE_HTTP_REDIRECT',
160 'PLUGIN_CACHED_USECACHE', 'PLUGIN_CACHED_FORCE_SYNCMAP',
163 if(!file_exists($file)){
164 trigger_error("Datasource file '$file' does not exist", E_USER_ERROR);
168 $rs = @parse_ini_file($file);
169 $rsdef = @parse_ini_file(dirname(__FILE__)."/../config/config-default.ini");
170 foreach ($rsdef as $k => $v) {
172 $rs[$k] = constant($k);
173 } elseif (!isset($rs[$k])) {
177 unset($k); unset($v);
179 foreach ($_IC_VALID_VALUE as $item) {
180 if (defined($item)) {
184 if (array_key_exists($item, $rs)) {
185 define($item, $rs[$item]);
187 //} elseif (array_key_exists($item, $rsdef)) {
188 // define($item, $rsdef[$item]);
189 // calculate them later or not at all:
190 } elseif (in_array($item,
191 array('DATABASE_PREFIX', 'SERVER_NAME', 'SERVER_PORT',
192 'SCRIPT_NAME', 'DATA_PATH', 'PHPWIKI_DIR', 'VIRTUAL_PATH',
193 'LDAP_AUTH_HOST','IMAP_AUTH_HOST','POP3_AUTH_HOST',
194 'PLUGIN_CACHED_CACHE_DIR')))
198 trigger_error(sprintf("missing config setting for %s",$item));
203 // Boolean options are slightly special - if they're set to any of
204 // '', 'false', '0', or 'no' (all case-insensitive) then the value will
205 // be a boolean false, otherwise if there is anything set it'll
207 foreach ($_IC_VALID_BOOL as $item) {
208 if (defined($item)) {
212 if (array_key_exists($item, $rs)) {
214 //} elseif (array_key_exists($item, $rsdef)) {
215 // $val = $rsdef[$item];
217 $val = false; //trigger_error(sprintf("missing boolean config setting for %s",$item));
220 // calculate them later: old or dynamic constants
221 if (!array_key_exists($item, $rs) and
222 in_array($item,array('USE_PATH_INFO', 'USE_DB_SESSION',
223 'ALLOW_HTTP_AUTH_LOGIN', 'ALLOW_LDAP_LOGIN',
224 'ALLOW_IMAP_LOGIN', 'ALLOW_USER_LOGIN',
225 'REQUIRE_SIGNIN_BEFORE_EDIT',
226 'WIKIDB_NOCACHE_MARKUP')))
231 define($item, false);
233 elseif (strtolower($val) == 'false' ||
234 strtolower($val) == 'no' ||
238 define($item, false);
249 foreach (array('DATABASE_TYPE' => 'dbtype',
250 'DATABASE_DSN' => 'dsn',
251 'DATABASE_SESSION_TABLE' => 'db_session_table',
252 'DATABASE_DBA_HANDLER' => 'dba_handler',
253 'DATABASE_DIRECTORY' => 'directory',
254 'DATABASE_TIMEOUT' => 'timeout',
255 'DATABASE_PREFIX' => 'prefix')
258 if (defined($item)) {
259 $DBParams[$k] = constant($item);
261 } elseif (array_key_exists($item, $rs)) {
262 $DBParams[$k] = $rs[$item];
263 define($item, $rs[$item]);
265 } elseif (array_key_exists($item, $rsdef)) {
266 $DBParams[$k] = $rsdef[$item];
267 define($item, $rsdef[$item]);
268 unset($rsdef[$item]);
271 // USE_DB_SESSION default logic:
272 if (!defined('USE_DB_SESSION')) {
273 if ($DBParams['db_session_table']
274 and in_array($DBParams['dbtype'], array('SQL','ADODB'))) {
275 define('USE_DB_SESSION', true);
276 } elseif ($DBParams['dbtype'] == 'dba' and check_php_version(4,1,2)) {
277 define('USE_DB_SESSION', true);
279 define('USE_DB_SESSION', false);
282 unset($item); unset($k);
285 global $ExpireParams;
286 foreach (array('major','minor','author') as $major) {
287 foreach (array('max_age','min_age','min_keep','keep','max_keep') as $max) {
288 $item = strtoupper($major) . '_'. strtoupper($max);
289 if (defined($item)) $val = constant($item);
290 elseif (array_key_exists($item, $rs))
292 elseif (array_key_exists($item, $rsdef))
293 $val = $rsdef[$item];
294 if (!isset($ExpireParams[$major]))
295 $ExpireParams[$major] = array();
296 $ExpireParams[$major][$max] = $val;
300 unset($item); unset($major); unset($max);
302 // User authentication
303 if (!isset($GLOBALS['USER_AUTH_ORDER']))
304 if (isset($rs['USER_AUTH_ORDER']))
305 $GLOBALS['USER_AUTH_ORDER'] = preg_split('/\s*:\s*/',
306 $rs['USER_AUTH_ORDER']);
308 $GLOBALS['USER_AUTH_ORDER'] = array("PersonalPage");
310 // Now it's the external DB authentication stuff's turn
311 if (in_array('Db', $GLOBALS['USER_AUTH_ORDER']) && empty($rs['DBAUTH_AUTH_DSN'])) {
312 $rs['DBAUTH_AUTH_DSN'] = $DBParams['dsn'];
315 global $DBAuthParams;
316 $DBAP_MAP = array('DBAUTH_AUTH_DSN' => 'auth_dsn',
317 'DBAUTH_AUTH_CHECK' => 'auth_check',
318 'DBAUTH_AUTH_USER_EXISTS' => 'auth_user_exists',
319 'DBAUTH_AUTH_CRYPT_METHOD' => 'auth_crypt_method',
320 'DBAUTH_AUTH_UPDATE' => 'auth_update',
321 'DBAUTH_AUTH_CREATE' => 'auth_create',
322 'DBAUTH_PREF_SELECT' => 'pref_select',
323 'DBAUTH_PREF_UPDATE' => 'pref_update',
324 'DBAUTH_IS_MEMBER' => 'is_member',
325 'DBAUTH_GROUP_MEMBERS' => 'group_members',
326 'DBAUTH_USER_GROUPS' => 'user_groups'
328 foreach ($DBAP_MAP as $rskey => $apkey) {
329 if (defined($rskey)) {
330 $DBAuthParams[$apkey] = constant($rskey);
331 } elseif (isset($rs[$rskey])) {
332 $DBAuthParams[$apkey] = $rs[$rskey];
333 define($rskey, $rs[$rskey]);
334 } elseif (isset($rsdef[$rskey])) {
335 $DBAuthParams[$apkey] = $rsdef[$rskey];
336 define($rskey, $rsdef[$rskey]);
340 unset($rskey); unset($apkey);
342 // currently unsupported on non-SQL
343 if (!empty($rs['ACCESS_LOG_SQL'])) {
344 if (!in_array($DBParams['dbtype'], array('SQL','ADODB')))
345 define('ACCESS_LOG_SQL', 0);
348 define('ACCESS_LOG_SQL', 0);
350 // optional values will be set to '' to simplify the logic.
351 foreach ($_IC_OPTIONAL_VALUE as $item) {
352 if (defined($item)) {
356 if (array_key_exists($item, $rs)) {
357 define($item, $rs[$item]);
365 global $LDAP_SET_OPTION;
366 if (defined('LDAP_SET_OPTION') and LDAP_SET_OPTION) {
367 $optlist = preg_split('/\s*:\s*/', LDAP_SET_OPTION);
368 foreach ($optlist as $opt) {
369 $bits = preg_split('/\s*=\s*/', $opt, 2);
370 if (count($bits) == 2) {
371 if (is_string($bits[0]) and defined($bits[0]))
372 $bits[0] = constant($bits[0]);
373 $LDAP_SET_OPTION[$bits[0]] = $bits[1];
376 // Possibly throw some sort of error?
379 unset($opt); unset($bits);
382 // Default Wiki pages to force loading from pgsrc
383 global $GenericPages;
384 $GenericPages = preg_split('/\s*:\s*/', @$rs['DEFAULT_WIKI_PAGES']);
386 // Wiki name regexp: Should be a define(), but might needed to be changed at runtime
387 // (different LC_CHAR need different posix classes)
388 global $WikiNameRegexp;
389 $WikiNameRegexp = constant('WIKI_NAME_REGEXP');
390 if (!trim($WikiNameRegexp))
391 $WikiNameRegexp = '(?<![[:alnum:]])(?:[[:upper:]][[:lower:]]+){2,}(?![[:alnum:]])';
393 // Another "too-tricky" redefine
394 global $KeywordLinkRegexp;
395 if (!isset($rs['KEYWORDS'])) $rs['KEYWORDS'] = @$rsdef['KEYWORDS'];
396 if (!isset($rs['KEYWORDS'])) $rs['KEYWORDS'] = "Category:Topic";
397 $keywords = preg_split('/\s*:\s*/', $rs['KEYWORDS']);
398 if (empty($keywords)) $keywords = array("Category","Topic");
399 $KeywordLinkRegexp = '(?<=' . implode('|^', $keywords) . ')[[:upper:]].*$';
401 // TODO: can this be a constant?
402 global $DisabledActions;
403 if (!array_key_exists('DISABLED_ACTIONS',$rs) and array_key_exists('DISABLED_ACTIONS',$rsdef))
404 $rs['DISABLED_ACTIONS'] = @$rsdef['DISABLED_ACTIONS'];
405 if (array_key_exists('DISABLED_ACTIONS',$rs))
406 $DisabledActions = preg_split('/\s*:\s*/', $rs['DISABLED_ACTIONS']);
408 global $PLUGIN_CACHED_IMGTYPES;
409 $PLUGIN_CACHED_IMGTYPES = preg_split('/\s*[|:]\s*/', PLUGIN_CACHED_IMGTYPES);
410 if (empty($rs['PLUGIN_CACHED_CACHE_DIR']) and !empty($rsdef['PLUGIN_CACHED_CACHE_DIR']))
411 $rs['PLUGIN_CACHED_CACHE_DIR'] = $rsdef['PLUGIN_CACHED_CACHE_DIR'];
412 if (empty($rs['PLUGIN_CACHED_CACHE_DIR'])) {
413 if (!empty($rs['INCLUDE_PATH'])) {
414 ini_set('include_path', $rs['INCLUDE_PATH']);
416 if (!FindFile('/tmp/cache', 1)) { // [29ms]
417 if (!FindFile('/tmp', 1)) {
420 mkdir('/tmp/cache', 777);
422 // will throw an error if not exists.
423 define('PLUGIN_CACHED_CACHE_DIR', FindFile('/tmp/cache',false,1));
425 define('PLUGIN_CACHED_CACHE_DIR', $rs['PLUGIN_CACHED_CACHE_DIR']);
426 // will throw an error if not exists.
427 FindFile(PLUGIN_CACHED_CACHE_DIR);
430 // process the rest of the config.ini settings:
431 foreach ($rs as $item => $v) {
432 if (defined($item)) {
438 unset($item); unset($v);
443 fixup_static_configs(); //[1ms]
444 // Dump all globals and constants
445 // The question is if reading this is faster then doing IniConfig() + fixup_static_configs()
446 if (is_writable($dump)) {
449 // store locale[] in config.php? This is too problematic.
450 fixup_dynamic_configs(); // [100ms]
453 // moved from lib/config.php [1ms]
454 function fixup_static_configs() {
455 global $FieldSeparator, $charset, $WikiNameRegexp, $KeywordLinkRegexp, $AllActionPages;
456 global $HTTP_SERVER_VARS, $DBParams, $LANG;
458 // init FileFinder to add proper include paths
459 FindFile("lib/interwiki.map",true);
461 // "\x80"-"\x9f" (and "\x00" - "\x1f") are non-printing control
462 // chars in iso-8859-*
463 // $FieldSeparator = "\263"; // this is a superscript 3 in ISO-8859-1.
464 // $FieldSeparator = "\xFF"; // this byte should never appear in utf-8
465 // FIXME: get rid of constant. pref is dynamic and language specific
467 // Disabled: Let the admin decide which charset.
468 //if (isset($LANG) and in_array($LANG,array('zh')))
469 // $charset = 'utf-8';
470 if (strtolower($charset) == 'utf-8')
471 $FieldSeparator = "\xFF";
473 $FieldSeparator = "\x81";
475 if (!defined('DEFAULT_LANGUAGE')) // not needed anymore
476 define('DEFAULT_LANGUAGE', 'en');
478 $AllActionPages = explode(':',
479 'AllPages:BackLinks:CreatePage:DebugInfo:EditMetaData:FindPage:'
480 .'FullRecentChanges:FullTextSearch:FuzzyPages:InterWikiSearch:'
481 .'LikePages:MostPopular:'
482 .'OrphanedPages:PageDump:PageHistory:PageInfo:RandomPage:RateIt:'
483 .'RecentChanges:RecentEdits:RecentComments:RelatedChanges:TitleSearch:'
484 .'TranslateText:UpLoad:UserPreferences:WantedPages:WhoIsOnline:'
485 .'PhpWikiAdministration/Remove:PhpWikiAdministration/Chmod:'
486 .'PhpWikiAdministration/Rename:PhpWikiAdministration/Replace:'
487 .'PhpWikiAdministration/SetAcl:PhpWikiAdministration/Chown'
490 // If user has not defined PHPWIKI_DIR, and we need it
491 if (!defined('PHPWIKI_DIR') and !file_exists("themes/default")) {
492 $themes_dir = FindFile("themes");
493 define('PHPWIKI_DIR', dirname($themes_dir));
496 // If user has not defined DATA_PATH, we want to use relative URLs.
497 if (!defined('DATA_PATH')) {
498 // fix similar to the one suggested by jkalmbach for
499 // installations in the webrootdir, like "http://phpwiki.org/HomePage"
500 if (!defined('SCRIPT_NAME'))
501 define('SCRIPT_NAME', deduce_script_name());
502 $temp = dirname(SCRIPT_NAME);
503 if ( ($temp == '/') || ($temp == '\\') )
505 define('DATA_PATH', $temp);
508 define('DATA_PATH', '..');
512 //////////////////////////////////////////////////////////////////
515 if (empty($DBParams['dbtype']))
516 $DBParams['dbtype'] = 'dba';
518 if (!defined('THEME'))
519 define('THEME', 'default');
521 // check whether the crypt() function is needed and present
522 if (defined('ENCRYPTED_PASSWD') && !function_exists('crypt')) {
523 $error = sprintf(_("Encrypted passwords cannot be used: %s."),
524 "'function crypt()' not available in this version of php");
525 trigger_error($error);
528 if (!defined('ADMIN_PASSWD') or ADMIN_PASSWD == '')
529 trigger_error(_("The admin password cannot be empty. Please update your config/config.ini"));
531 if (defined('USE_DB_SESSION') and USE_DB_SESSION) {
532 if (! $DBParams['db_session_table'] ) {
533 $DBParams['db_session_table'] = @$DBParams['prefix'] . 'session';
534 trigger_error(sprintf(_("DATABASE_SESSION_TABLE configuration set to %s."),
535 $DBParams['db_session_table']),
540 if (!defined('ENABLE_USER_NEW')) define('ENABLE_USER_NEW',true);
541 if (!defined('ALLOW_USER_LOGIN'))
542 define('ALLOW_USER_LOGIN', defined('ALLOW_USER_PASSWORDS') && ALLOW_USER_PASSWORDS);
543 if (!defined('ALLOW_ANON_USER')) define('ALLOW_ANON_USER', true);
544 if (!defined('ALLOW_ANON_EDIT')) define('ALLOW_ANON_EDIT', false);
545 if (!defined('REQUIRE_SIGNIN_BEFORE_EDIT')) define('REQUIRE_SIGNIN_BEFORE_EDIT', ! ALLOW_ANON_EDIT);
546 if (!defined('ALLOW_BOGO_LOGIN')) define('ALLOW_BOGO_LOGIN', true);
547 if (!ENABLE_USER_NEW) {
548 if (!defined('ALLOW_HTTP_AUTH_LOGIN'))
549 define('ALLOW_HTTP_AUTH_LOGIN', false);
550 if (!defined('ALLOW_LDAP_LOGIN'))
551 define('ALLOW_LDAP_LOGIN', function_exists('ldap_connect') and defined('LDAP_AUTH_HOST'));
552 if (!defined('ALLOW_IMAP_LOGIN'))
553 define('ALLOW_IMAP_LOGIN', function_exists('imap_open') and defined('IMAP_AUTH_HOST'));
556 if (ALLOW_USER_LOGIN and !empty($DBAuthParams) and empty($DBAuthParams['auth_dsn'])) {
557 if (isset($DBParams['dsn']))
558 $DBAuthParams['auth_dsn'] = $DBParams['dsn'];
562 function fixup_dynamic_configs() {
563 global $WikiNameRegexp, $KeywordLinkRegexp;
564 global $HTTP_SERVER_VARS, $DBParams, $LANG;
566 if (defined('INCLUDE_PATH'))
567 ini_set('include_path', INCLUDE_PATH);
568 if (defined('SESSION_SAVE_PATH'))
569 ini_set('session.save_path', SESSION_SAVE_PATH);
570 if (!defined('DEFAULT_LANGUAGE')) // not needed anymore
571 define('DEFAULT_LANGUAGE', 'en');
573 update_locale(isset($LANG) ? $LANG : DEFAULT_LANGUAGE);
575 // Set up (possibly fake) gettext()
576 // Todo: this could be moved to fixup_static_configs()
577 if (!function_exists ('bindtextdomain')) {
580 function gettext ($text) {
582 if (!empty ($locale[$text]))
583 return $locale[$text];
588 return gettext($text);
592 // Working around really weird gettext problems: (4.3.2, 4.3.6 win)
593 // bindtextdomain() returns the current domain path.
594 // 1. If the script is not index.php but something like "de", on a different path
595 // then bindtextdomain() fails, but after chdir to the correct path it will work okay.
596 // 2. But the weird error "Undefined variable: bindtextdomain" is generated then.
597 $bindtextdomain_path = FindFile("locale", false, true);
599 $bindtextdomain_path = str_replace("/","\\",$bindtextdomain_path);
600 $bindtextdomain_real = @bindtextdomain("phpwiki", $bindtextdomain);
601 if ($bindtextdomain_real != $bindtextdomain_path) {
602 // this will happen with virtual_paths. chdir and try again.
603 chdir($bindtextdomain_path);
604 $bindtextdomain_real = @bindtextdomain("phpwiki", $bindtextdomain);
606 textdomain("phpwiki");
607 if ($bindtextdomain_real != $bindtextdomain_path) { // change back
608 chdir($bindtextdomain_real . (isWindows() ? "\\.." : "/.."));
611 // language dependent updates
612 $WikiNameRegexp = pcre_fix_posix_classes($WikiNameRegexp);
613 $KeywordLinkRegexp = pcre_fix_posix_classes($KeywordLinkRegexp);
615 //////////////////////////////////////////////////////////////////
616 // Autodetect URL settings:
618 foreach (array('SERVER_NAME','SERVER_PORT') as $var) {
619 //FIXME: for CGI without _SERVER
620 if (!defined($var) and !empty($HTTP_SERVER_VARS[$var]))
621 define($var, $HTTP_SERVER_VARS[$var]);
623 if (!defined('SERVER_PROTOCOL')) {
624 if (empty($HTTP_SERVER_VARS['HTTPS']) || $HTTP_SERVER_VARS['HTTPS'] == 'off')
625 define('SERVER_PROTOCOL', 'http');
627 define('SERVER_PROTOCOL', 'https');
630 if (!defined('SCRIPT_NAME'))
631 define('SCRIPT_NAME', deduce_script_name());
633 if (!defined('USE_PATH_INFO')) {
635 define('USE_PATH_INFO', false);
638 * If SCRIPT_NAME does not look like php source file,
639 * or user cgi we assume that php is getting run by an
640 * action handler in /cgi-bin. In this case,
641 * I think there is no way to get Apache to pass
642 * useful PATH_INFO to the php script (PATH_INFO
643 * is used to the the php interpreter where the
646 switch (php_sapi_name()) {
648 case 'apache2handler':
649 define('USE_PATH_INFO', true);
652 case 'apache2filter':
653 define('USE_PATH_INFO', false);
656 define('USE_PATH_INFO', ereg('\.(php3?|cgi)$', SCRIPT_NAME));
663 && SERVER_PORT != (SERVER_PROTOCOL == 'https' ? 443 : 80)) {
665 SERVER_PROTOCOL . '://' . SERVER_NAME . ':' . SERVER_PORT);
669 SERVER_PROTOCOL . '://' . SERVER_NAME);
672 if (!defined('VIRTUAL_PATH')) {
673 // We'd like to auto-detect when the cases where apaches
674 // 'Action' directive (or similar means) is used to
675 // redirect page requests to a cgi-handler.
677 // In cases like this, requests for e.g. /wiki/HomePage
678 // get redirected to a cgi-script called, say,
679 // /path/to/wiki/index.php. The script gets all
680 // of /wiki/HomePage as it's PATH_INFO.
683 // How to detect when this has happened reliably?
684 // How to pick out the "virtual path" (in this case '/wiki')?
686 // (Another time an redirect might occur is to a DirectoryIndex
687 // -- the requested URI is '/wikidir/', the request gets
688 // passed to '/wikidir/index.php'. In this case, the
689 // proper VIRTUAL_PATH is '/wikidir/index.php', since the
690 // pages will appear at e.g. '/wikidir/index.php/HomePage'.
693 $REDIRECT_URL = &$HTTP_SERVER_VARS['REDIRECT_URL'];
694 if (USE_PATH_INFO and isset($REDIRECT_URL)
695 and ! IsProbablyRedirectToIndex()) {
696 // FIXME: This is a hack, and won't work if the requested
697 // pagename has a slash in it.
698 $temp = strtr(dirname($REDIRECT_URL . 'x'),"\\",'/');
699 if ( ($temp == '/') || ($temp == '\\') )
701 define('VIRTUAL_PATH', $temp);
703 define('VIRTUAL_PATH', SCRIPT_NAME);
707 if (VIRTUAL_PATH != SCRIPT_NAME) {
708 // Apache action handlers are used.
709 define('PATH_INFO_PREFIX', VIRTUAL_PATH . '/');
712 define('PATH_INFO_PREFIX', '/');
714 define('PHPWIKI_BASE_URL',
715 SERVER_URL . (USE_PATH_INFO ? VIRTUAL_PATH . '/' : SCRIPT_NAME));
718 // Detect PrettyWiki setup (not loading index.php directly)
719 // $SCRIPT_FILENAME should be the same as __FILE__ in index.php
720 if (!isset($SCRIPT_FILENAME))
721 $SCRIPT_FILENAME = @$HTTP_SERVER_VARS['SCRIPT_FILENAME'];
722 if (!isset($SCRIPT_FILENAME))
723 $SCRIPT_FILENAME = @$HTTP_ENV_VARS['SCRIPT_FILENAME'];
724 if (!isset($SCRIPT_FILENAME))
725 $SCRIPT_FILENAME = dirname(__FILE__.'/../') . '/index.php';
727 $SCRIPT_FILENAME = str_replace('\\\\','\\',strtr($SCRIPT_FILENAME, '/', '\\'));
728 define('SCRIPT_FILENAME', $SCRIPT_FILENAME);
730 if (!defined('WIKI_NAME'))
731 define('WIKI_NAME', _("An unnamed PhpWiki"));
733 if (!defined('HOME_PAGE'))
734 define('HOME_PAGE', _("HomePage"));
736 // Get remote host name, if apache hasn't done it for us
737 if (empty($HTTP_SERVER_VARS['REMOTE_HOST'])
738 and !empty($HTTP_SERVER_VARS['REMOTE_ADDR'])
739 and ENABLE_REVERSE_DNS)
740 $HTTP_SERVER_VARS['REMOTE_HOST'] = gethostbyaddr($HTTP_SERVER_VARS['REMOTE_ADDR']);
744 // $Log: not supported by cvs2svn $
745 // Revision 1.63 2004/11/07 16:47:32 rurban
748 // Revision 1.62 2004/11/07 16:02:51 rurban
749 // new sql access log (for spam prevention), and restructured access log class
750 // dbh->quote (generic)
751 // pear_db: mysql specific parts seperated (using replace)
753 // Revision 1.61 2004/11/06 17:01:30 rurban
754 // unify DATABASE constants init as with DBAUTH
756 // Revision 1.60 2004/11/06 03:06:58 rurban
757 // make use of dumped static config state in config/config.php (if writable)
759 // Revision 1.59 2004/11/05 20:53:35 rurban
760 // login cleanup: better debug msg on failing login,
761 // checked password less immediate login (bogo or anon),
762 // checked olduser pref session error,
763 // better PersonalPage without password warning on minimal password length=0
764 // (which is default now)
766 // Revision 1.58 2004/11/03 16:50:31 rurban
767 // some new defaults and constants, renamed USE_DOUBLECLICKEDIT to ENABLE_DOUBLECLICKEDIT
769 // Revision 1.57 2004/11/01 10:43:55 rurban
770 // seperate PassUser methods into seperate dir (memory usage)
771 // fix WikiUser (old) overlarge data session
772 // remove wikidb arg from various page class methods, use global ->_dbi instead
775 // Revision 1.56 2004/10/21 20:20:53 rurban
776 // From patch #970004 "Double clic to edit" by pixels.
778 // Revision 1.55 2004/10/14 19:23:58 rurban
779 // remove debugging prints
781 // Revision 1.54 2004/10/14 17:13:01 rurban
782 // use DATABASE_PREFIX
784 // Revision 1.53 2004/10/12 13:13:19 rurban
785 // php5 compatibility (5.0.1 ok)
787 // Revision 1.52 2004/10/04 23:38:07 rurban
790 // Revision 1.51 2004/09/20 13:40:19 rurban
791 // define all config.ini settings, only the supported will be taken from -default.
792 // support USE_EXTERNAL_HTML2PDF renderer (htmldoc tested)
794 // Revision 1.50 2004/09/06 09:28:58 rurban
795 // fix PLUGIN_CACHED_CACHE_DIR fallback logic. ini entry did not work before
797 // Revision 1.49 2004/07/13 13:07:27 rurban
798 // improved DB_SESSION logic
800 // Revision 1.48 2004/07/05 13:09:37 rurban
801 // ENABLE_RAW_HTML_LOCKEDONLY, ENABLE_RAW_HTML_SAFE
803 // Revision 1.47 2004/07/03 16:51:05 rurban
804 // optional DBADMIN_USER:DBADMIN_PASSWD for action=upgrade (if no ALTER permission)
805 // added atomic mysql REPLACE for PearDB as in ADODB
806 // fixed _lock_tables typo links => link
807 // fixes unserialize ADODB bug in line 180
809 // Revision 1.46 2004/07/02 09:55:58 rurban
810 // more stability fixes: new DISABLE_GETIMAGESIZE if your php crashes when loading LinkIcons: failing getimagesize in old phps; blockparser stabilized
812 // Revision 1.45 2004/07/01 08:51:21 rurban
813 // dumphtml: added exclude, print pagename before processing
815 // Revision 1.44 2004/06/29 08:52:22 rurban
816 // Use ...version() $need_content argument in WikiDB also:
817 // To reduce the memory footprint for larger sets of pagelists,
818 // we don't cache the content (only true or false) and
819 // we purge the pagedata (_cached_html) also.
820 // _cached_html is only cached for the current pagename.
821 // => Vastly improved page existance check, ACL check, ...
823 // Now only PagedList info=content or size needs the whole content, esp. if sortable.
825 // Revision 1.43 2004/06/29 06:48:02 rurban
826 // Improve LDAP auth and GROUP_LDAP membership:
827 // no error message on false password,
828 // added two new config vars: LDAP_OU_USERS and LDAP_OU_GROUP with GROUP_METHOD=LDAP
829 // fixed two group queries (this -> user)
830 // stdlib: ConvertOldMarkup still flawed
832 // Revision 1.42 2004/06/28 15:01:07 rurban
833 // fixed LDAP_SET_OPTION handling, LDAP error on connection problem
835 // Revision 1.41 2004/06/25 14:29:17 rurban
836 // WikiGroup refactoring:
837 // global group attached to user, code for not_current user.
838 // improved helpers for special groups (avoid double invocations)
839 // new experimental config option ENABLE_XHTML_XML (fails with IE, and document.write())
840 // fixed a XHTML validation error on userprefs.tmpl
842 // Revision 1.40 2004/06/22 07:12:48 rurban
843 // removed USE_TAGLINES constant
845 // Revision 1.39 2004/06/21 16:22:28 rurban
846 // add DEFAULT_DUMP_DIR and HTML_DUMP_DIR constants, for easier cmdline dumps,
847 // fixed dumping buttons locally (images/buttons/),
848 // support pages arg for dumphtml,
849 // optional directory arg for dumpserial + dumphtml,
850 // fix a AllPages warning,
851 // show dump warnings/errors on DEBUG,
852 // don't warn just ignore on wikilens pagelist columns, if not loaded.
853 // RateIt pagelist column is called "rating", not "ratingwidget" (Dan?)
855 // Revision 1.38 2004/06/21 08:39:36 rurban
856 // pear/Cache update from Cache-1.5.4 (added db and trifile container)
857 // pear/DB update from DB-1.6.1 (mysql bugfixes, php5 compat, DB_PORTABILITY features)
859 // Revision 1.37 2004/06/19 12:32:37 rurban
860 // new TEMP_DIR for ziplib
862 // Revision 1.36 2004/06/19 10:06:37 rurban
863 // Moved lib/plugincache-config.php to config/*.ini
864 // use PLUGIN_CACHED_* constants instead of global $CacheParams
866 // Revision 1.35 2004/06/15 09:15:52 rurban
867 // IMPORTANT: fixed passwd handling for passwords stored in prefs:
868 // fix encrypted usage, actually store and retrieve them from db
869 // fix bogologin with passwd set.
870 // fix php crashes with call-time pass-by-reference (references wrongly used
871 // in declaration AND call). This affected mainly Apache2 and IIS.
872 // (Thanks to John Cole to detect this!)
874 // Revision 1.34 2004/06/13 13:54:25 rurban
875 // Catch fatals on the four dump calls (as file and zip, as html and mimified)
876 // FoafViewer: Check against external requirements, instead of fatal.
877 // Change output for xhtmldumps: using file:// urls to the local fs.
878 // Catch SOAP fatal by checking for GOOGLE_LICENSE_KEY
879 // Import GOOGLE_LICENSE_KEY and FORTUNE_DIR from config.ini.
881 // Revision 1.33 2004/06/08 19:48:16 rurban
882 // fixed foreign setup: no ugly skipped msg for the GenericPages, load english actionpages if translated not found
884 // Revision 1.32 2004/06/08 10:54:46 rurban
885 // better acl dump representation, read back acl and owner
887 // Revision 1.31 2004/06/06 16:58:51 rurban
888 // added more required ActionPages for foreign languages
889 // install now english ActionPages if no localized are found. (again)
890 // fixed default anon user level to be 0, instead of -1
891 // (wrong "required administrator to view this page"...)
893 // Revision 1.30 2004/06/04 12:40:21 rurban
894 // Restrict valid usernames to prevent from attacks against external auth or compromise
896 // Fix various WikiUser old issues with default IMAP,LDAP,POP3 configs. Removed these.
897 // Fxied more warnings
899 // Revision 1.29 2004/06/04 11:58:38 rurban
900 // added USE_TAGLINES
902 // Revision 1.28 2004/06/03 20:42:49 rurban
903 // fixed bad warning #964850
905 // Revision 1.27 2004/06/03 10:18:19 rurban
906 // fix FileUser locking issues, new config ENABLE_PAGEPERM
908 // Revision 1.26 2004/06/02 18:01:45 rurban
909 // init global FileFinder to add proper include paths at startup
910 // adds PHPWIKI_DIR if started from another dir, lib/pear also
911 // fix slashify for Windows
912 // fix USER_AUTH_POLICY=old, use only USER_AUTH_ORDER methods (besides HttpAuth)
914 // Revision 1.25 2004/05/27 17:49:05 rurban
915 // renamed DB_Session to DbSession (in CVS also)
916 // added WikiDB->getParam and WikiDB->getAuthParam method to get rid of globals
917 // remove leading slash in error message
918 // added force_unlock parameter to File_Passwd (no return on stale locks)
919 // fixed adodb session AffectedRows
920 // added FileFinder helpers to unify local filenames and DATA_PATH names
921 // editpage.php: new edit toolbar javascript on ENABLE_EDIT_TOOLBAR
923 // Revision 1.24 2004/05/18 13:33:13 rurban
924 // we already have a CGI function
926 // Revision 1.23 2004/05/17 17:43:29 rurban
927 // CGI: no PATH_INFO fix
929 // Revision 1.22 2004/05/16 22:07:35 rurban
930 // check more config-default and predefined constants
931 // various PagePerm fixes:
932 // fix default PagePerms, esp. edit and view for Bogo and Password users
933 // implemented Creator and Owner
934 // BOGOUSERS renamed to BOGOUSER
935 // fixed syntax errors in signin.tmpl
937 // Revision 1.21 2004/05/08 22:55:12 rurban
938 // Fixed longstanding sf.net:demo problem. endless loop, caused by an empty definition of
939 // WIKI_NAME_REGEXP. Exactly this constant wasn't checked for its default setting.
941 // Revision 1.20 2004/05/08 20:21:00 rurban
942 // remove php tags in Log
944 // Revision 1.19 2004/05/08 19:55:29 rurban
945 // support <span>inlined plugin-result</span>:
946 // if the plugin is parsed inside a line, use <span> instead of
947 // <div tightenable top bottom>
948 // e.g. for "This is the current Phpwiki <plugin SystemInfo version> version.
950 // Revision 1.18 2004/05/08 16:58:19 rurban
951 // don't ignore some false config values (e.g. USE_PATH_INFO false was ignored)
953 // Revision 1.17 2004/05/06 19:26:15 rurban
954 // improve stability, trying to find the InlineParser endless loop on sf.net
956 // remove end-of-zip comments to fix sf.net bug #777278 and probably #859628
958 // Revision 1.16 2004/05/02 15:10:05 rurban
959 // new finally reliable way to detect if /index.php is called directly
960 // and if to include lib/main.php
961 // new global AllActionPages
962 // SetupWiki now loads all mandatory pages: HOME_PAGE, action pages, and warns if not.
963 // WikiTranslation what=buttons for Carsten to create the missing MacOSX buttons
964 // PageGroupTestOne => subpages
965 // renamed PhpWikiRss to PhpWikiRecentChanges
966 // more docs, default configs, ...
968 // Revision 1.15 2004/05/01 15:59:29 rurban
969 // more php-4.0.6 compatibility: superglobals
971 // Revision 1.14 2004/04/29 23:25:12 rurban
972 // re-ordered locale init (as in 1.3.9)
973 // fixed loadfile with subpages, and merge/restore anyway
974 // (sf.net bug #844188)
976 // Revision 1.13 2004/04/29 21:54:05 rurban
979 // Revision 1.12 2004/04/27 16:16:27 rurban
980 // more subtle config problems with defaults
982 // Revision 1.11 2004/04/26 20:44:34 rurban
983 // locking table specific for better databases
985 // Revision 1.10 2004/04/26 13:22:32 rurban
986 // calculate bool old or dynamic constants later
988 // Revision 1.9 2004/04/26 12:15:01 rurban
989 // check default config values
991 // Revision 1.8 2004/04/23 16:55:59 zorloc
992 // If using Db auth and DBAUTH_AUTH_DSN is empty set DBAUTH_AUTH_DSN to $DBParams['dsn']
994 // Revision 1.7 2004/04/20 22:26:27 zorloc
995 // Removed Pear_Config for parse_ini_file().
997 // Revision 1.6 2004/04/20 18:10:27 rurban
998 // config refactoring:
999 // FileFinder is needed for WikiFarm scripts calling index.php
1000 // config run-time calls moved to lib/IniConfig.php:fix_configs()
1001 // added PHPWIKI_DIR smart-detection code (Theme finder)
1002 // moved FileFind to lib/FileFinder.php
1003 // cleaned lib/config.php
1005 // Revision 1.5 2004/04/20 17:21:57 rurban
1006 // WikiFarm code: honor predefined constants
1008 // Revision 1.4 2004/04/20 17:08:19 rurban
1009 // Some IniConfig fixes: prepend our private lib/pear dir
1010 // switch from " to ' in the auth statements
1011 // use error handling.
1012 // WikiUserNew changes for the new "'$variable'" syntax
1013 // in the statements
1014 // TODO: optimization to put config vars into the session.
1017 // (c-file-style: "gnu")
1021 // c-basic-offset: 4
1022 // c-hanging-comment-ender-p: nil
1023 // indent-tabs-mode: nil