4 * A configurator intended to read its config from a PHP-style INI file,
5 * instead of a PHP file.
7 * Pass a filename to the IniConfig() function and it will read all it's
8 * definitions from there, all by itself, and proceed to do a mass-define
9 * of all valid PHPWiki config items. In this way, we can hopefully be
10 * totally backwards-compatible with the old index.php method, while still
11 * providing a much tastier on-going experience.
13 * @author: Joby Walker, Reini Urban, Matthew Palmer
16 * Copyright 2004,2005,2006,2007 $ThePhpWikiProgrammingTeam
17 * Copyright 2008-2009 Marc-Etienne Vargenau, Alcatel-Lucent
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(\""
90 .addslashes(serialize($val))."\");\n");
92 // cannot be optimized, maybe leave away predefined consts somehow
93 foreach (get_defined_constants() as $var => $val) {
94 if (substr($var,0,4) != "PHP_" and substr($var,0,2) != "E_"
95 and substr($var,0,2) != "T_" and substr($var,0,2) != "M_")
96 fwrite($fp, "if(!defined('".$var."')) define('".$var."',unserialize(\""
97 .addslashes(serialize($val))."\"));\n");
99 fwrite($fp, "return 'noerr';}");
104 function _check_int_constant(&$c) {
105 // if int value == string value, force int type
106 if (sprintf("%d",(int)$c) === $c) { // DEBUG & _DEBUG_bla
111 function IniConfig($file) {
113 // check config/config.php dump for faster startup
114 $dump = substr($file, 0, -3)."php";
115 if (isWindows($dump)) $dump = str_replace("/","\\",$dump);
116 if (file_exists($dump) and is_readable($dump) and sort_file_mtime($dump, $file) < 0) {
118 if (function_exists('wiki_configrestore') and (wiki_configrestore() === 'noerr')) {
119 fixup_dynamic_configs();
124 // First-time installer detection here...
125 // Similar to SetupWiki()
126 if (!file_exists($file)) {
127 // We need to DATA_PATH for configurator, or pass the posted values
128 // somewhow to the script
129 include_once(dirname(__FILE__)."/install.php");
130 run_install("_part1");
131 if (!defined("_PHPWIKI_INSTALL_RUNNING"))
132 trigger_error("Datasource file '$file' does not exist", E_USER_ERROR);
136 // List of all valid config options to be define()d which take "values" (not
137 // booleans). Needs to be categorised, and generally made a lot tidier.
138 $_IC_VALID_VALUE = array
139 ('WIKI_NAME', 'ADMIN_USER', 'ADMIN_PASSWD',
140 'DEFAULT_DUMP_DIR', 'HTML_DUMP_DIR',
141 'HTML_DUMP_SUFFIX', 'MAX_UPLOAD_SIZE', 'MINOR_EDIT_TIMEOUT',
142 'ACCESS_LOG', 'CACHE_CONTROL', 'CACHE_CONTROL_MAX_AGE',
143 'COOKIE_EXPIRATION_DAYS', 'COOKIE_DOMAIN',
144 'PASSWORD_LENGTH_MINIMUM', 'USER_AUTH_POLICY',
146 'EDITING_POLICY', 'THEME', 'CHARSET',
147 'WIKI_PGSRC', 'DEFAULT_WIKI_PGSRC',
148 'ALLOWED_PROTOCOLS', 'INLINE_IMAGES', 'SUBPAGE_SEPARATOR', /*'KEYWORDS',*/
150 //'DATABASE_PREFIX', 'DATABASE_DSN', 'DATABASE_TYPE', 'DATABASE_DBHANDLER',
151 'DATABASE_OPTIMISE_FREQUENCY',
152 'INTERWIKI_MAP_FILE', 'COPYRIGHTPAGE_TITLE', 'COPYRIGHTPAGE_URL',
153 'AUTHORPAGE_TITLE', 'AUTHORPAGE_URL',
155 'PLUGIN_CACHED_DATABASE', 'PLUGIN_CACHED_FILENAME_PREFIX',
156 'PLUGIN_CACHED_HIGHWATER', 'PLUGIN_CACHED_LOWWATER', 'PLUGIN_CACHED_MAXLIFETIME',
157 'PLUGIN_CACHED_MAXARGLEN', 'PLUGIN_CACHED_IMGTYPES',
160 'SERVER_NAME','SERVER_PORT','SCRIPT_NAME', 'DATA_PATH', 'PHPWIKI_DIR', 'VIRTUAL_PATH',
161 'EXTERNAL_HTML2PDF_PAGELIST', 'PLUGIN_CACHED_CACHE_DIR'
164 // Optional values which need to be defined.
165 // These are not defined in config-default.ini and empty if not defined.
166 $_IC_OPTIONAL_VALUE = array
168 'DEBUG', 'TEMP_DIR', 'DEFAULT_LANGUAGE',
169 'LDAP_AUTH_HOST','LDAP_SET_OPTION','LDAP_BASE_DN', 'LDAP_AUTH_USER',
170 'LDAP_AUTH_PASSWORD','LDAP_SEARCH_FIELD','LDAP_OU_GROUP','LDAP_OU_USERS',
171 'AUTH_USER_FILE','DBAUTH_AUTH_DSN',
172 'IMAP_AUTH_HOST', 'POP3_AUTH_HOST',
173 'AUTH_USER_FILE', 'AUTH_GROUP_FILE', 'AUTH_SESS_USER', 'AUTH_SESS_LEVEL',
174 'GOOGLE_LICENSE_KEY','FORTUNE_DIR',
175 'DISABLE_GETIMAGESIZE','DBADMIN_USER','DBADMIN_PASSWD',
177 'TOOLBAR_PAGELINK_PULLDOWN', 'TOOLBAR_TEMPLATE_PULLDOWN', 'TOOLBAR_IMAGE_PULLDOWN',
178 'EXTERNAL_LINK_TARGET', 'ACCESS_LOG_SQL', 'USE_EXTERNAL_HTML2PDF',
179 'LOGIN_LOG','LDAP_SEARCH_FILTER'
182 // List of all valid config options to be define()d which take booleans.
183 $_IC_VALID_BOOL = array
184 ('ENABLE_USER_NEW', 'ENABLE_PAGEPERM', 'ENABLE_EDIT_TOOLBAR', 'JS_SEARCHREPLACE',
185 'ENABLE_XHTML_XML', 'ENABLE_DOUBLECLICKEDIT', 'ENABLE_LIVESEARCH', 'ENABLE_ACDROPDOWN',
186 'USECACHE', 'WIKIDB_NOCACHE_MARKUP',
187 'ENABLE_REVERSE_DNS', 'ENCRYPTED_PASSWD', 'ZIPDUMP_AUTH',
188 'ENABLE_RAW_HTML', 'ENABLE_RAW_HTML_LOCKEDONLY', 'ENABLE_RAW_HTML_SAFE',
189 'STRICT_MAILABLE_PAGEDUMPS', 'COMPRESS_OUTPUT',
190 'ALLOW_ANON_USER', 'ALLOW_ANON_EDIT',
191 'ALLOW_BOGO_LOGIN', 'ALLOW_USER_PASSWORDS',
192 'AUTH_USER_FILE_STORABLE', 'ALLOW_HTTP_AUTH_LOGIN',
193 'ALLOW_USER_LOGIN', 'ALLOW_LDAP_LOGIN', 'ALLOW_IMAP_LOGIN',
194 'WARN_NONPUBLIC_INTERWIKIMAP', 'USE_PATH_INFO',
195 'DISABLE_HTTP_REDIRECT',
196 'PLUGIN_CACHED_USECACHE', 'PLUGIN_CACHED_FORCE_SYNCMAP',
197 'BLOG_DEFAULT_EMPTY_PREFIX', 'DATABASE_PERSISTENT',
198 'ENABLE_DISCUSSION_LINK', 'ENABLE_CAPTCHA',
199 'ENABLE_WYSIWYG', 'WYSIWYG_DEFAULT_PAGETYPE_HTML',
200 'DISABLE_MARKUP_WIKIWORD', 'ENABLE_MARKUP_COLOR',
201 'ENABLE_MARKUP_DIVSPAN', 'USE_BYTEA', 'UPLOAD_USERDIR', 'DISABLE_UNITS',
202 'ENABLE_SEARCHHIGHLIGHT', 'DISABLE_UPLOAD_ONLY_ALLOWED_EXTENSIONS',
203 'ENABLE_AUTH_OPENID', 'INSECURE_ACTIONS_LOCALHOST_ONLY',
204 'ENABLE_MAILNOTIFY', 'ENABLE_RECENTCHANGESBOX', 'ENABLE_PAGE_PUBLIC',
205 'ENABLE_AJAX', 'ENABLE_EXTERNAL_PAGES',
209 $rs = @parse_ini_file($file);
210 $rsdef = @parse_ini_file(dirname(__FILE__)."/../config/config-default.ini");
211 foreach ($rsdef as $k => $v) {
213 $rs[$k] = constant($k);
214 } elseif (!isset($rs[$k])) {
218 unset($k); unset($v);
220 foreach ($_IC_VALID_VALUE as $item) {
221 if (defined($item)) {
225 if (array_key_exists($item, $rs)) {
226 _check_int_constant($rs[$item]);
227 define($item, $rs[$item]);
229 //} elseif (array_key_exists($item, $rsdef)) {
230 // define($item, $rsdef[$item]);
231 // calculate them later or not at all:
232 } elseif (in_array($item,
233 array('DATABASE_PREFIX', 'SERVER_NAME', 'SERVER_PORT',
234 'SCRIPT_NAME', 'DATA_PATH', 'PHPWIKI_DIR', 'VIRTUAL_PATH',
235 'LDAP_AUTH_HOST','IMAP_AUTH_HOST','POP3_AUTH_HOST',
236 'PLUGIN_CACHED_CACHE_DIR','EXTERNAL_HTML2PDF_PAGELIST')))
239 } elseif (!defined("_PHPWIKI_INSTALL_RUNNING")) {
240 trigger_error(sprintf("missing config setting for %s",$item));
245 // Boolean options are slightly special - if they're set to any of
246 // '', 'false', '0', or 'no' (all case-insensitive) then the value will
247 // be a boolean false, otherwise if there is anything set it'll
249 foreach ($_IC_VALID_BOOL as $item) {
250 if (defined($item)) {
254 if (array_key_exists($item, $rs)) {
256 //} elseif (array_key_exists($item, $rsdef)) {
257 // $val = $rsdef[$item];
260 //trigger_error(sprintf("missing boolean config setting for %s",$item));
263 // calculate them later: old or dynamic constants
264 if (!array_key_exists($item, $rs) and
265 in_array($item, array('USE_PATH_INFO', 'USE_DB_SESSION',
266 'ALLOW_HTTP_AUTH_LOGIN', 'ALLOW_LDAP_LOGIN',
267 'ALLOW_IMAP_LOGIN', 'ALLOW_USER_LOGIN',
268 'REQUIRE_SIGNIN_BEFORE_EDIT',
269 'WIKIDB_NOCACHE_MARKUP',
270 'COMPRESS_OUTPUT', 'USE_BYTEA', 'READONLY',
276 define($item, false);
278 elseif (strtolower($val) == 'false' ||
279 strtolower($val) == 'no' ||
283 define($item, false);
294 foreach (array('DATABASE_TYPE' => 'dbtype',
295 'DATABASE_DSN' => 'dsn',
296 'DATABASE_SESSION_TABLE' => 'db_session_table',
297 'DATABASE_DBA_HANDLER' => 'dba_handler',
298 'DATABASE_DIRECTORY' => 'directory',
299 'DATABASE_TIMEOUT' => 'timeout',
300 'DATABASE_PREFIX' => 'prefix')
303 if (defined($item)) {
304 $DBParams[$k] = constant($item);
306 } elseif (array_key_exists($item, $rs)) {
307 $DBParams[$k] = $rs[$item];
308 define($item, $rs[$item]);
310 } elseif (array_key_exists($item, $rsdef)) {
311 $DBParams[$k] = $rsdef[$item];
312 define($item, $rsdef[$item]);
313 unset($rsdef[$item]);
316 $valid_database_types = array('SQL','ADODB','PDO','dba','file','flatfile','cvs','cvsclient');
317 if (!in_array(DATABASE_TYPE, $valid_database_types))
318 trigger_error(sprintf("Invalid DATABASE_TYPE=%s. Choose one of %s",
319 DATABASE_TYPE, join(",", $valid_database_types)),
321 unset($valid_database_types);
322 if (DATABASE_TYPE == 'PDO') {
323 if (!check_php_version(5))
324 trigger_error("Invalid DATABASE_TYPE=PDO. PDO requires at least php-5.0!",
326 // try to load it dynamically (unix only)
327 if (!loadPhpExtension("pdo")) {
328 echo $GLOBALS['php_errormsg'], "<br>\n";
329 trigger_error(sprintf("dl() problem: Required extension '%s' could not be loaded!",
334 // Detect readonly database, e.g. system mounted read-only for maintenance
335 // via dbh->readonly later. Unfortunately not possible as constant.
337 // USE_DB_SESSION default logic:
338 if (!defined('USE_DB_SESSION')) {
339 if ($DBParams['db_session_table']
340 and in_array($DBParams['dbtype'], array('SQL','ADODB','PDO'))) {
341 define('USE_DB_SESSION', true);
342 } elseif ($DBParams['dbtype'] == 'dba' and check_php_version(4,1,2)) {
343 define('USE_DB_SESSION', true); // Depends on db handler as well.
344 // BerkeleyDB on older php has problems
345 // with multiple db handles.
347 define('USE_DB_SESSION', false);
350 unset($item); unset($k);
353 global $ExpireParams;
354 foreach (array('major','minor','author') as $major) {
355 foreach (array('max_age','min_age','min_keep','keep','max_keep') as $max) {
356 $item = strtoupper($major) . '_'. strtoupper($max);
357 if (defined($item)) $val = constant($item);
358 elseif (array_key_exists($item, $rs))
360 elseif (array_key_exists($item, $rsdef))
361 $val = $rsdef[$item];
362 if (!isset($ExpireParams[$major]))
363 $ExpireParams[$major] = array();
364 $ExpireParams[$major][$max] = $val;
368 unset($item); unset($major); unset($max);
370 // User authentication
371 if (!isset($GLOBALS['USER_AUTH_ORDER'])) {
372 if (isset($rs['USER_AUTH_ORDER']))
373 $GLOBALS['USER_AUTH_ORDER'] = preg_split('/\s*:\s*/',
374 $rs['USER_AUTH_ORDER']);
376 $GLOBALS['USER_AUTH_ORDER'] = array("PersonalPage");
379 // Now it's the external DB authentication stuff's turn
380 if (in_array('Db', $GLOBALS['USER_AUTH_ORDER']) && empty($rs['DBAUTH_AUTH_DSN'])) {
381 $rs['DBAUTH_AUTH_DSN'] = $DBParams['dsn'];
384 global $DBAuthParams;
385 $DBAP_MAP = array('DBAUTH_AUTH_DSN' => 'auth_dsn',
386 'DBAUTH_AUTH_CHECK' => 'auth_check',
387 'DBAUTH_AUTH_USER_EXISTS' => 'auth_user_exists',
388 'DBAUTH_AUTH_CRYPT_METHOD' => 'auth_crypt_method',
389 'DBAUTH_AUTH_UPDATE' => 'auth_update',
390 'DBAUTH_AUTH_CREATE' => 'auth_create',
391 'DBAUTH_PREF_SELECT' => 'pref_select',
392 'DBAUTH_PREF_INSERT' => 'pref_insert',
393 'DBAUTH_PREF_UPDATE' => 'pref_update',
394 'DBAUTH_IS_MEMBER' => 'is_member',
395 'DBAUTH_GROUP_MEMBERS' => 'group_members',
396 'DBAUTH_USER_GROUPS' => 'user_groups'
398 foreach ($DBAP_MAP as $rskey => $apkey) {
399 if (defined($rskey)) {
400 $DBAuthParams[$apkey] = constant($rskey);
401 } elseif (isset($rs[$rskey])) {
402 $DBAuthParams[$apkey] = $rs[$rskey];
403 define($rskey, $rs[$rskey]);
404 } elseif (isset($rsdef[$rskey])) {
405 $DBAuthParams[$apkey] = $rsdef[$rskey];
406 define($rskey, $rsdef[$rskey]);
410 unset($rskey); unset($apkey);
412 // TODO: Currently unsupported on non-SQL. Nice to have for RhNavPlugin
414 if (array_key_exists('ACCESS_LOG_SQL', $rs)) {
415 // WikiDB_backend::isSql() not yet loaded
416 if (!in_array(DATABASE_TYPE, array('SQL','ADODB','PDO')))
417 // override false config setting on no SQL WikiDB database.
418 define('ACCESS_LOG_SQL', 0);
420 // SQL defaults to ACCESS_LOG_SQL = 2
422 define('ACCESS_LOG_SQL',
423 in_array(DATABASE_TYPE, array('SQL','ADODB','PDO')) ? 2 : 0);
426 if (empty($rs['TEMP_DIR'])) {
427 $rs['TEMP_DIR'] = "/tmp";
429 $rs['TEMP_DIR'] = getenv("TEMP");
431 // optional values will be set to '' to simplify the logic.
432 foreach ($_IC_OPTIONAL_VALUE as $item) {
433 if (defined($item)) {
437 if (array_key_exists($item, $rs)) {
438 _check_int_constant($rs[$item]);
439 define($item, $rs[$item]);
445 if (USE_EXTERNAL_HTML2PDF) {
446 $item = 'EXTERNAL_HTML2PDF_PAGELIST';
447 if (defined($item)) {
449 } elseif (array_key_exists($item, $rs)) {
450 define($item, $rs[$item]);
452 } elseif (array_key_exists($item, $rsdef)) {
453 define($item, $rsdef[$item]);
459 global $LDAP_SET_OPTION;
460 if (defined('LDAP_SET_OPTION') and LDAP_SET_OPTION) {
461 $optlist = preg_split('/\s*:\s*/', LDAP_SET_OPTION);
462 foreach ($optlist as $opt) {
463 $bits = preg_split('/\s*=\s*/', $opt, 2);
464 if (count($bits) == 2) {
465 if (is_string($bits[0]) and defined($bits[0]))
466 $bits[0] = constant($bits[0]);
467 $LDAP_SET_OPTION[$bits[0]] = $bits[1];
470 // Possibly throw some sort of error?
473 unset($opt); unset($bits);
476 // Default Wiki pages to force loading from pgsrc
477 global $GenericPages;
478 $GenericPages = preg_split('/\s*:\s*/', @$rs['DEFAULT_WIKI_PAGES']);
480 // Wiki name regexp: Should be a define(), but might needed to be changed at runtime
481 // (different LC_CHAR need different posix classes)
482 global $WikiNameRegexp;
483 $WikiNameRegexp = constant('WIKI_NAME_REGEXP');
484 if (!trim($WikiNameRegexp))
485 $WikiNameRegexp = '(?<![[:alnum:]])(?:[[:upper:]][[:lower:]]+){2,}(?![[:alnum:]])';
487 // Got rid of global $KeywordLinkRegexp by using a TextSearchQuery instead
488 // of "Category:Topic"
489 if (!isset($rs['KEYWORDS'])) $rs['KEYWORDS'] = @$rsdef['KEYWORDS'];
490 if (!isset($rs['KEYWORDS'])) $rs['KEYWORDS'] = "Category* OR Topic*";
491 if ($rs['KEYWORDS'] == 'Category:Topic') $rs['KEYWORDS'] = "Category* OR Topic*";
492 if (!defined('KEYWORDS')) define('KEYWORDS', $rs['KEYWORDS']);
493 //if (empty($keywords)) $keywords = array("Category","Topic");
494 //$KeywordLinkRegexp = '(?<=' . implode('|^', $keywords) . ')[[:upper:]].*$';
496 // TODO: can this be a constant?
497 global $DisabledActions;
498 if (!array_key_exists('DISABLED_ACTIONS', $rs)
499 and array_key_exists('DISABLED_ACTIONS', $rsdef))
500 $rs['DISABLED_ACTIONS'] = @$rsdef['DISABLED_ACTIONS'];
501 if (array_key_exists('DISABLED_ACTIONS', $rs))
502 $DisabledActions = preg_split('/\s*:\s*/', $rs['DISABLED_ACTIONS']);
504 global $PLUGIN_CACHED_IMGTYPES;
505 $PLUGIN_CACHED_IMGTYPES = preg_split('/\s*[|:]\s*/', PLUGIN_CACHED_IMGTYPES);
507 if (!defined('PLUGIN_CACHED_CACHE_DIR')) {
508 if (empty($rs['PLUGIN_CACHED_CACHE_DIR']) and !empty($rsdef['PLUGIN_CACHED_CACHE_DIR']))
509 $rs['PLUGIN_CACHED_CACHE_DIR'] = $rsdef['PLUGIN_CACHED_CACHE_DIR'];
510 if (empty($rs['PLUGIN_CACHED_CACHE_DIR'])) {
511 if (!empty($rs['INCLUDE_PATH'])) {
512 @ini_set('include_path', $rs['INCLUDE_PATH']);
513 $GLOBALS['INCLUDE_PATH'] = $rs['INCLUDE_PATH'];
515 $rs['PLUGIN_CACHED_CACHE_DIR'] = TEMP_DIR . '/cache';
516 if (!FindFile($rs['PLUGIN_CACHED_CACHE_DIR'], 1)) { // [29ms]
517 FindFile(TEMP_DIR, false, 1); // TEMP must exist!
518 mkdir($rs['PLUGIN_CACHED_CACHE_DIR'], 0777);
520 // will throw an error if not exists.
521 define('PLUGIN_CACHED_CACHE_DIR', FindFile($rs['PLUGIN_CACHED_CACHE_DIR'],false,1));
523 define('PLUGIN_CACHED_CACHE_DIR', $rs['PLUGIN_CACHED_CACHE_DIR']);
524 // will throw an error if not exists.
525 FindFile(PLUGIN_CACHED_CACHE_DIR);
529 // process the rest of the config.ini settings:
530 foreach ($rs as $item => $v) {
531 if (defined($item)) {
534 _check_int_constant($v);
538 unset($item); unset($v);
543 fixup_static_configs($file); //[1ms]
544 // Dump all globals and constants
545 // The question is if reading this is faster then doing IniConfig() + fixup_static_configs()
546 if (is_writable($dump)) {
549 // store locale[] in config.php? This is too problematic.
550 fixup_dynamic_configs($file); // [100ms]
553 function _ignore_unknown_charset_warning(&$error) {
554 //htmlspecialchars(): charset `iso-8859-2' not supported, assuming iso-8859-1
555 if (preg_match('/^htmlspecialchars\(\): charset \`.+\' not supported, assuming iso-8859-1/',
558 return true; // Ignore error
563 // moved from lib/config.php [1ms]
564 function fixup_static_configs($file) {
565 global $FieldSeparator, $charset, $WikiNameRegexp, $AllActionPages;
566 global $HTTP_SERVER_VARS, $DBParams, $LANG, $ErrorManager;
567 // init FileFinder to add proper include paths
568 FindFile("lib/interwiki.map",true);
570 // "\x80"-"\x9f" (and "\x00" - "\x1f") are non-printing control
571 // chars in iso-8859-*
572 // $FieldSeparator = "\263"; // this is a superscript 3 in ISO-8859-1.
573 // $FieldSeparator = "\xFF"; // this byte should never appear in utf-8
574 // Get rid of constant. pref is dynamic and language specific
576 // Disabled: Let the admin decide which charset.
577 //if (isset($LANG) and in_array($LANG,array('zh')))
578 // $charset = 'utf-8';
579 if (strtolower($charset) == 'utf-8')
580 $FieldSeparator = "\xFF";
582 $FieldSeparator = "\x81";
584 // Some exotic charsets are not supported by htmlspecialchars, which just prints an E_WARNING.
585 // Even on simple 8bit charsets, where just <>& need to be replaced. For iso-8859-[2-4] e.g.
586 // See <php-src>/ext/standard/html.c
587 // For performance reasons we require a magic constant to ignore this warning.
588 if (defined('IGNORE_CHARSET_NOT_SUPPORTED_WARNING')
589 and IGNORE_CHARSET_NOT_SUPPORTED_WARNING)
591 $ErrorManager->pushErrorHandler
592 (new WikiFunctionCb('_ignore_unknown_charset_warning'));
595 // All pages containing plugins of the same name as the filename
596 $ActionPages = explode(':',
597 'AllPages:AllUsers:AppendText:AuthorHistory:'
600 .'FullTextSearch:FuzzyPages:'
601 .'LikePages:LinkDatabase:LinkSearch:ListRelations:'
602 .'ModeratedPage:MostPopular:'
605 .'PageDump:PageHistory:PageInfo:PluginManager:'
606 .'RateIt:' // RateIt works only in wikilens derived themes
607 .'RandomPage:RecentChanges:RelatedChanges:RecentEdits:'
608 .'SearchHighlight:SemanticRelations:SemanticSearch:SystemInfo:'
610 .'UpLoad:UserPreferences:'
611 .'UserRatings:' // UserRatings works only in wikilens derived themes
612 .'WantedPages:WatchPage:WhoIsOnline:WikiAdminSelect');
614 // The GFORGE theme omits them
615 if (!defined('GFORGE') or !GFORGE) {
616 // Add some some action pages depending on configuration
617 if (defined('DEBUG') and DEBUG) {
618 $ActionPages[] = 'DebugInfo';
619 $ActionPages[] = 'EditMetaData';
620 $ActionPages[] = 'SpellCheck'; // SpellCheck does not work
622 $ActionPages[] = 'BlogArchives';
623 $ActionPages[] = 'BlogJournal';
624 $ActionPages[] = 'InterWikiSearch';
625 $ActionPages[] = 'LdapSearch';
626 $ActionPages[] = 'PasswordReset';
627 $ActionPages[] = 'RecentComments';
628 $ActionPages[] = 'TranslateText';
629 $ActionPages[] = 'UriResolver';
630 $ActionPages[] = 'WikiBlog';
633 global $AllAllowedPlugins;
634 $AllAllowedPlugins = $ActionPages;
635 // Add plugins that have no corresponding action page
636 $AllAllowedPlugins[] = 'AsciiSVG';
637 $AllAllowedPlugins[] = 'BoxRight';
638 $AllAllowedPlugins[] = 'CalendarList';
639 $AllAllowedPlugins[] = 'Calendar';
640 $AllAllowedPlugins[] = 'CategoryPage';
641 $AllAllowedPlugins[] = 'Chart';
642 $AllAllowedPlugins[] = 'Comment';
643 $AllAllowedPlugins[] = 'CreateBib';
644 $AllAllowedPlugins[] = 'CreateToc';
645 $AllAllowedPlugins[] = 'CurrentTime';
646 $AllAllowedPlugins[] = 'DeadEndPages';
647 $AllAllowedPlugins[] = 'Diff';
648 $AllAllowedPlugins[] = 'DynamicIncludePage';
649 $AllAllowedPlugins[] = 'ExternalSearch';
650 $AllAllowedPlugins[] = 'FileInfo';
651 $AllAllowedPlugins[] = 'GoogleMaps';
652 $AllAllowedPlugins[] = 'GooglePlugin';
653 $AllAllowedPlugins[] = 'GoTo';
654 $AllAllowedPlugins[] = 'HelloWorld';
655 $AllAllowedPlugins[] = 'IncludePage';
656 $AllAllowedPlugins[] = 'IncludePages';
657 $AllAllowedPlugins[] = 'IncludeSiteMap';
658 $AllAllowedPlugins[] = 'IncludeTree';
659 $AllAllowedPlugins[] = 'ListPages';
660 $AllAllowedPlugins[] = 'ListSubpages';
661 $AllAllowedPlugins[] = 'MediawikiTable';
662 $AllAllowedPlugins[] = 'NoCache';
663 $AllAllowedPlugins[] = 'OldStyleTable';
664 $AllAllowedPlugins[] = 'PageGroup';
665 $AllAllowedPlugins[] = 'PageTrail';
666 $AllAllowedPlugins[] = 'PhotoAlbum';
667 $AllAllowedPlugins[] = 'PhpHighlight';
668 $AllAllowedPlugins[] = 'PopularTags';
669 $AllAllowedPlugins[] = 'PopUp';
670 $AllAllowedPlugins[] = 'PrevNext';
671 $AllAllowedPlugins[] = 'Processing';
672 $AllAllowedPlugins[] = 'RawHtml';
673 $AllAllowedPlugins[] = 'RecentChangesCached';
674 $AllAllowedPlugins[] = 'RecentReferrers';
675 $AllAllowedPlugins[] = 'RedirectTo';
676 $AllAllowedPlugins[] = 'RichTable';
677 $AllAllowedPlugins[] = 'RssFeed';
678 $AllAllowedPlugins[] = 'SemanticSearchAdvanced';
679 $AllAllowedPlugins[] = 'SiteMap';
680 $AllAllowedPlugins[] = 'SyncWiki';
681 $AllAllowedPlugins[] = 'SyntaxHighlighter';
682 $AllAllowedPlugins[] = 'Template';
683 $AllAllowedPlugins[] = 'Transclude';
684 $AllAllowedPlugins[] = 'UnfoldSubpages';
685 $AllAllowedPlugins[] = 'Video';
686 $AllAllowedPlugins[] = 'WikiAdminChown';
687 $AllAllowedPlugins[] = 'WikiAdminPurge';
688 $AllAllowedPlugins[] = 'WikiAdminRemove';
689 $AllAllowedPlugins[] = 'WikiAdminRename';
690 $AllAllowedPlugins[] = 'WikiAdminSearchReplace';
691 $AllAllowedPlugins[] = 'WikiAdminSetAcl';
692 $AllAllowedPlugins[] = 'WikiAdminUtils';
693 $AllAllowedPlugins[] = 'WikicreoleTable';
694 $AllAllowedPlugins[] = 'WikiForm';
695 $AllAllowedPlugins[] = 'WikiFormRich';
696 $AllAllowedPlugins[] = 'WikiPoll';
697 $AllAllowedPlugins[] = 'YouTube';
699 // Used by SetupWiki to pull in required pages, if not translated, then in english.
700 // Also used by _WikiTranslation. Really important are only those which return pagelists
701 // or contain basic functionality.
702 $AllActionPages = $ActionPages;
703 $AllActionPages[] = 'AllPagesCreatedByMe';
704 $AllActionPages[] = 'AllPagesLastEditedByMe';
705 $AllActionPages[] = 'AllPagesOwnedByMe';
706 $AllActionPages[] = 'AllUserPages';
707 $AllActionPages[] = 'FullRecentChanges';
708 $AllActionPages[] = 'LeastPopular';
709 $AllActionPages[] = 'LockedPages';
710 $AllActionPages[] = 'MyRecentEdits';
711 $AllActionPages[] = 'MyRecentChanges';
712 $AllActionPages[] = 'PhpWikiAdministration';
713 $AllActionPages[] = 'PhpWikiAdministration/Chown';
714 $AllActionPages[] = 'PhpWikiAdministration/Purge';
715 $AllActionPages[] = 'PhpWikiAdministration/Remove';
716 $AllActionPages[] = 'PhpWikiAdministration/Rename';
717 $AllActionPages[] = 'PhpWikiAdministration/SearchReplace';
718 $AllActionPages[] = 'PhpWikiAdministration/SetAcl';
719 $AllActionPages[] = 'RecentChangesMyPages';
720 $AllActionPages[] = 'RecentEdits';
721 $AllActionPages[] = 'RecentNewPages';
722 $AllActionPages[] = 'UserContribs';
724 // The GFORGE theme omits them
725 if (!defined('GFORGE') or !GFORGE) {
726 // Add some some action pages depending on configuration
727 if (defined('DEBUG') and DEBUG) {
728 $AllActionPages[] = 'PhpWikiAdministration/Chmod';
730 $AllActionPages[] = 'PhpWikiAdministration/Markup';
733 if (defined('GFORGE') and GFORGE) {
734 if (defined('ENABLE_EXTERNAL_PAGES') and ENABLE_EXTERNAL_PAGES) {
735 $AllAllowedPlugins[] = 'WikiAdminSetExternal';
736 $AllActionPages[] = 'ExternalPages';
740 // If user has not defined PHPWIKI_DIR, and we need it
741 if (!defined('PHPWIKI_DIR') and !file_exists("themes/default")) {
742 $themes_dir = FindFile("themes");
743 define('PHPWIKI_DIR', dirname($themes_dir));
746 // If user has not defined DATA_PATH, we want to use relative URLs.
747 if (!defined('DATA_PATH')) {
748 // fix similar to the one suggested by jkalmbach for
749 // installations in the webrootdir, like "http://phpwiki.org/HomePage"
750 if (!defined('SCRIPT_NAME'))
751 define('SCRIPT_NAME', deduce_script_name());
752 $temp = dirname(SCRIPT_NAME);
753 if ( ($temp == '/') || ($temp == '\\') )
755 define('DATA_PATH', $temp);
758 define('DATA_PATH', '..');
762 //////////////////////////////////////////////////////////////////
765 if (empty($DBParams['dbtype']))
766 $DBParams['dbtype'] = 'dba';
768 if (!defined('THEME'))
769 define('THEME', 'default');
771 /*$configurator_link = HTML(HTML::br(), "=>",
772 HTML::a(array('href'=>DATA_PATH."/configurator.php"),
773 _("Configurator")));*/
774 // check whether the crypt() function is needed and present
775 if (defined('ENCRYPTED_PASSWD') && !function_exists('crypt')) {
776 $error = sprintf("Encrypted passwords cannot be used: %s.",
777 "'function crypt()' not available in this version of php");
778 trigger_error($error, E_USER_WARNING);
779 if (!preg_match("/config\-dist\.ini$/", $file)) { // protect against recursion
780 include_once(dirname(__FILE__)."/install.php");
781 run_install("_part1");
786 // Basic configurator validation
787 if (!defined('ADMIN_USER') or ADMIN_USER == '') {
788 $error = sprintf("%s may not be empty. Please update your configuration.",
790 // protect against recursion
791 if (!preg_match("/config\-(dist|default)\.ini$/", $file)
792 and !defined("_PHPWIKI_INSTALL_RUNNING"))
794 include_once(dirname(__FILE__)."/install.php");
795 run_install("_part1");
796 trigger_error($error, E_USER_ERROR);
798 } elseif ($HTTP_SERVER_VARS["REQUEST_METHOD"] == "POST") {
799 $GLOBALS['HTTP_GET_VARS']['show'] = '_part1';
800 trigger_error($error, E_USER_WARNING);
803 if (!defined('ADMIN_PASSWD') or ADMIN_PASSWD == '') {
804 $error = sprintf("%s may not be empty. Please update your configuration.",
806 // protect against recursion
807 if (!preg_match("/config\-(dist|default)\.ini$/", $file)
808 and !defined("_PHPWIKI_INSTALL_RUNNING"))
810 include_once(dirname(__FILE__)."/install.php");
811 run_install("_part1");
812 trigger_error($error, E_USER_ERROR);
814 } elseif ($HTTP_SERVER_VARS["REQUEST_METHOD"] == "POST") {
815 $GLOBALS['HTTP_GET_VARS']['show'] = '_part1';
816 trigger_error($error, E_USER_WARNING);
820 if (defined('USE_DB_SESSION') and USE_DB_SESSION) {
821 if (! $DBParams['db_session_table'] ) {
822 $DBParams['db_session_table'] = @$DBParams['prefix'] . 'session';
823 trigger_error(sprintf("DATABASE_SESSION_TABLE configuration set to %s.",
824 $DBParams['db_session_table']),
829 if (!defined('ENABLE_USER_NEW')) define('ENABLE_USER_NEW',true);
830 if (!defined('ALLOW_USER_LOGIN'))
831 define('ALLOW_USER_LOGIN', defined('ALLOW_USER_PASSWORDS') && ALLOW_USER_PASSWORDS);
832 if (!defined('ALLOW_ANON_USER')) define('ALLOW_ANON_USER', true);
833 if (!defined('ALLOW_ANON_EDIT')) define('ALLOW_ANON_EDIT', false);
834 if (!defined('REQUIRE_SIGNIN_BEFORE_EDIT')) define('REQUIRE_SIGNIN_BEFORE_EDIT', ! ALLOW_ANON_EDIT);
835 if (!defined('ALLOW_BOGO_LOGIN')) define('ALLOW_BOGO_LOGIN', true);
836 if (!ENABLE_USER_NEW) {
837 if (!defined('ALLOW_HTTP_AUTH_LOGIN'))
838 define('ALLOW_HTTP_AUTH_LOGIN', false);
839 if (!defined('ALLOW_LDAP_LOGIN'))
840 define('ALLOW_LDAP_LOGIN', function_exists('ldap_connect') and defined('LDAP_AUTH_HOST'));
841 if (!defined('ALLOW_IMAP_LOGIN'))
842 define('ALLOW_IMAP_LOGIN', function_exists('imap_open') and defined('IMAP_AUTH_HOST'));
845 if (ALLOW_USER_LOGIN and !empty($DBAuthParams) and empty($DBAuthParams['auth_dsn'])) {
846 if (isset($DBParams['dsn']))
847 $DBAuthParams['auth_dsn'] = $DBParams['dsn'];
852 * Define constants which are client or request specific and should not be dumped statically.
853 * Such as the language, and the virtual and server paths, which might be overridden
854 * by startup scripts for wiki farms.
856 function fixup_dynamic_configs($file) {
857 global $WikiNameRegexp;
858 global $HTTP_SERVER_VARS, $DBParams, $LANG;
860 if (defined('INCLUDE_PATH') and INCLUDE_PATH) {
861 @ini_set('include_path', INCLUDE_PATH);
862 $GLOBALS['INCLUDE_PATH'] = INCLUDE_PATH;
864 if (defined('SESSION_SAVE_PATH') and SESSION_SAVE_PATH)
865 @ini_set('session.save_path', SESSION_SAVE_PATH);
866 if (!defined('DEFAULT_LANGUAGE')) // not needed anymore
867 define('DEFAULT_LANGUAGE', ''); // detect from client
870 if (!defined('GFORGE') or !GFORGE) {
871 // Disable update_locale because Zend Debugger crash
872 if(! extension_loaded('Zend Debugger')) {
873 update_locale(isset($LANG) ? $LANG : DEFAULT_LANGUAGE);
878 if (!defined("DEFAULT_LANGUAGE") or !DEFAULT_LANGUAGE) {
879 // TODO: defer this to WikiRequest::initializeLang()
880 $LANG = guessing_lang();
881 guessing_setlocale (LC_ALL,$LANG);
884 $LANG = DEFAULT_LANGUAGE;
887 // Set up (possibly fake) gettext()
888 // Todo: this could be moved to fixup_static_configs()
889 // Bug #1381464 with php-5.1.1
890 if (!function_exists ('bindtextdomain')
891 and !function_exists ('gettext')
892 and !function_exists ('_'))
896 function gettext ($text) {
898 if (!empty ($locale[$text]))
899 return $locale[$text];
903 return gettext($text);
910 // Working around really weird gettext problems: (4.3.2, 4.3.6 win)
911 // bindtextdomain() in returns the current domain path.
912 // 1. If the script is not index.php but something like "de", on a different path
913 // then bindtextdomain() fails, but after chdir to the correct path it will work okay.
914 // 2. But the weird error "Undefined variable: bindtextdomain" is generated then.
915 $bindtextdomain_path = FindFile("locale", false, true);
917 $bindtextdomain_path = str_replace("/", "\\", $bindtextdomain_path);
918 $bindtextdomain_real = @bindtextdomain("phpwiki", $bindtextdomain_path);
919 if (realpath($bindtextdomain_real) != realpath($bindtextdomain_path)) {
920 // this will happen with virtual_paths. chdir and try again.
921 chdir($bindtextdomain_path);
923 $bindtextdomain_real = @bindtextdomain("phpwiki", $bindtextdomain_path);
926 // tell gettext not to use unicode. PHP >= 4.2.0. Thanks to Kai Krakow.
927 if (defined('CHARSET') and function_exists('bind_textdomain_codeset'))
928 @bind_textdomain_codeset("phpwiki", CHARSET);
930 textdomain("phpwiki");
931 if ($chback) { // change back
932 chdir($bindtextdomain_real . (isWindows() ? "\\.." : "/.."));
936 // language dependent updates:
937 $WikiNameRegexp = pcre_fix_posix_classes($WikiNameRegexp);
938 //if ($KeywordLinkRegexp) $KeywordLinkRegexp = pcre_fix_posix_classes($KeywordLinkRegexp);
939 if (!defined('CATEGORY_GROUP_PAGE'))
940 define('CATEGORY_GROUP_PAGE',_("CategoryGroup"));
941 if (!defined('WIKI_NAME'))
942 define('WIKI_NAME', _("An unnamed PhpWiki"));
943 if (!defined('HOME_PAGE'))
944 define('HOME_PAGE', _("HomePage"));
947 //////////////////////////////////////////////////////////////////
948 // Autodetect URL settings:
950 foreach (array('SERVER_NAME','SERVER_PORT') as $var) {
951 //FIXME: for CGI without _SERVER
952 if (!defined($var) and !empty($HTTP_SERVER_VARS[$var]))
953 // IPV6 fix by matt brown, #1546571
954 // An IPv6 address must be surrounded by square brackets to form a valid server name.
955 if ($var == 'SERVER_NAME' &&
956 strstr($HTTP_SERVER_VARS[$var], ':')) {
957 define($var, '[' . $HTTP_SERVER_VARS[$var] . ']');
959 define($var, $HTTP_SERVER_VARS[$var]);
962 if (!defined('SERVER_NAME')) define('SERVER_NAME', '127.0.0.1');
963 if (!defined('SERVER_PORT')) define('SERVER_PORT', 80);
964 if (!defined('SERVER_PROTOCOL')) {
965 if (empty($HTTP_SERVER_VARS['HTTPS']) || $HTTP_SERVER_VARS['HTTPS'] == 'off')
966 define('SERVER_PROTOCOL', 'http');
968 define('SERVER_PROTOCOL', 'https');
971 if (!defined('SCRIPT_NAME'))
972 define('SCRIPT_NAME', deduce_script_name());
974 if (!defined('USE_PATH_INFO')) {
976 define('USE_PATH_INFO', false);
979 * If SCRIPT_NAME does not look like php source file,
980 * or user cgi we assume that php is getting run by an
981 * action handler in /cgi-bin. In this case,
982 * I think there is no way to get Apache to pass
983 * useful PATH_INFO to the php script (PATH_INFO
984 * is used to the the php interpreter where the
987 switch (php_sapi_name()) {
989 case 'apache2handler':
990 define('USE_PATH_INFO', true);
993 case 'apache2filter':
994 define('USE_PATH_INFO', false);
997 define('USE_PATH_INFO', ereg('\.(php3?|cgi)$', SCRIPT_NAME));
1004 && SERVER_PORT != (SERVER_PROTOCOL == 'https' ? 443 : 80)) {
1005 define('SERVER_URL',
1006 SERVER_PROTOCOL . '://' . SERVER_NAME . ':' . SERVER_PORT);
1009 define('SERVER_URL',
1010 SERVER_PROTOCOL . '://' . SERVER_NAME);
1013 if (!defined('VIRTUAL_PATH')) {
1014 // We'd like to auto-detect when the cases where apaches
1015 // 'Action' directive (or similar means) is used to
1016 // redirect page requests to a cgi-handler.
1018 // In cases like this, requests for e.g. /wiki/HomePage
1019 // get redirected to a cgi-script called, say,
1020 // /path/to/wiki/index.php. The script gets all
1021 // of /wiki/HomePage as it's PATH_INFO.
1024 // How to detect when this has happened reliably?
1025 // How to pick out the "virtual path" (in this case '/wiki')?
1027 // (Another time an redirect might occur is to a DirectoryIndex
1028 // -- the requested URI is '/wikidir/', the request gets
1029 // passed to '/wikidir/index.php'. In this case, the
1030 // proper VIRTUAL_PATH is '/wikidir/index.php', since the
1031 // pages will appear at e.g. '/wikidir/index.php/HomePage'.
1034 $REDIRECT_URL = &$HTTP_SERVER_VARS['REDIRECT_URL'];
1035 if (USE_PATH_INFO and isset($REDIRECT_URL)
1036 and ! IsProbablyRedirectToIndex()) {
1037 // FIXME: This is a hack, and won't work if the requested
1038 // pagename has a slash in it.
1039 $temp = strtr(dirname($REDIRECT_URL . 'x'),"\\",'/');
1040 if ( ($temp == '/') || ($temp == '\\') )
1042 define('VIRTUAL_PATH', $temp);
1044 define('VIRTUAL_PATH', SCRIPT_NAME);
1048 if (VIRTUAL_PATH != SCRIPT_NAME) {
1049 // Apache action handlers are used.
1050 define('PATH_INFO_PREFIX', VIRTUAL_PATH . '/');
1053 define('PATH_INFO_PREFIX', '/');
1055 define('PHPWIKI_BASE_URL',
1056 SERVER_URL . (USE_PATH_INFO ? VIRTUAL_PATH . '/' : SCRIPT_NAME));
1058 // Detect PrettyWiki setup (not loading index.php directly)
1059 // $SCRIPT_FILENAME should be the same as __FILE__ in index.php
1060 if (!isset($SCRIPT_FILENAME))
1061 $SCRIPT_FILENAME = @$HTTP_SERVER_VARS['SCRIPT_FILENAME'];
1062 if (!isset($SCRIPT_FILENAME))
1063 $SCRIPT_FILENAME = @$HTTP_ENV_VARS['SCRIPT_FILENAME'];
1064 if (!isset($SCRIPT_FILENAME))
1065 $SCRIPT_FILENAME = dirname(__FILE__.'/../') . '/index.php';
1067 $SCRIPT_FILENAME = str_replace('\\\\','\\',strtr($SCRIPT_FILENAME, '/', '\\'));
1068 define('SCRIPT_FILENAME', $SCRIPT_FILENAME);
1070 // Get remote host name, if apache hasn't done it for us
1071 if (empty($HTTP_SERVER_VARS['REMOTE_HOST'])
1072 and !empty($HTTP_SERVER_VARS['REMOTE_ADDR'])
1073 and ENABLE_REVERSE_DNS)
1074 $HTTP_SERVER_VARS['REMOTE_HOST'] = gethostbyaddr($HTTP_SERVER_VARS['REMOTE_ADDR']);
1078 // (c-file-style: "gnu")
1082 // c-basic-offset: 4
1083 // c-hanging-comment-ender-p: nil
1084 // indent-tabs-mode: nil