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',
158 'WYSIWYG_BACKEND', 'PLUGIN_MARKUP_MAP',
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', 'ENABLE_MARKUP_TEMPLATE',
201 'ENABLE_MARKUP_MEDIAWIKI_TABLE',
202 'ENABLE_MARKUP_DIVSPAN', 'USE_BYTEA', 'UPLOAD_USERDIR', 'DISABLE_UNITS',
203 'ENABLE_SEARCHHIGHLIGHT', 'DISABLE_UPLOAD_ONLY_ALLOWED_EXTENSIONS',
204 'ENABLE_AUTH_OPENID', 'INSECURE_ACTIONS_LOCALHOST_ONLY',
205 'ENABLE_MAILNOTIFY', 'ENABLE_RECENTCHANGESBOX', 'ENABLE_PAGE_PUBLIC',
206 'ENABLE_AJAX', 'ENABLE_EXTERNAL_PAGES',
210 $rs = @parse_ini_file($file);
211 $rsdef = @parse_ini_file(dirname(__FILE__)."/../config/config-default.ini");
212 foreach ($rsdef as $k => $v) {
214 $rs[$k] = constant($k);
215 } elseif (!isset($rs[$k])) {
219 unset($k); unset($v);
221 foreach ($_IC_VALID_VALUE as $item) {
222 if (defined($item)) {
226 if (array_key_exists($item, $rs)) {
227 _check_int_constant($rs[$item]);
228 define($item, $rs[$item]);
230 //} elseif (array_key_exists($item, $rsdef)) {
231 // define($item, $rsdef[$item]);
232 // calculate them later or not at all:
233 } elseif (in_array($item,
234 array('DATABASE_PREFIX', 'SERVER_NAME', 'SERVER_PORT',
235 'SCRIPT_NAME', 'DATA_PATH', 'PHPWIKI_DIR', 'VIRTUAL_PATH',
236 'LDAP_AUTH_HOST','IMAP_AUTH_HOST','POP3_AUTH_HOST',
237 'PLUGIN_CACHED_CACHE_DIR','EXTERNAL_HTML2PDF_PAGELIST')))
240 } elseif (!defined("_PHPWIKI_INSTALL_RUNNING")) {
241 trigger_error(sprintf("missing config setting for %s",$item));
246 // Boolean options are slightly special - if they're set to any of
247 // '', 'false', '0', or 'no' (all case-insensitive) then the value will
248 // be a boolean false, otherwise if there is anything set it'll
250 foreach ($_IC_VALID_BOOL as $item) {
251 if (defined($item)) {
255 if (array_key_exists($item, $rs)) {
257 //} elseif (array_key_exists($item, $rsdef)) {
258 // $val = $rsdef[$item];
261 //trigger_error(sprintf("missing boolean config setting for %s",$item));
264 // calculate them later: old or dynamic constants
265 if (!array_key_exists($item, $rs) and
266 in_array($item, array('USE_PATH_INFO', 'USE_DB_SESSION',
267 'ALLOW_HTTP_AUTH_LOGIN', 'ALLOW_LDAP_LOGIN',
268 'ALLOW_IMAP_LOGIN', 'ALLOW_USER_LOGIN',
269 'REQUIRE_SIGNIN_BEFORE_EDIT',
270 'WIKIDB_NOCACHE_MARKUP',
271 'COMPRESS_OUTPUT', 'USE_BYTEA', 'READONLY',
277 define($item, false);
279 elseif (strtolower($val) == 'false' ||
280 strtolower($val) == 'no' ||
284 define($item, false);
295 foreach (array('DATABASE_TYPE' => 'dbtype',
296 'DATABASE_DSN' => 'dsn',
297 'DATABASE_SESSION_TABLE' => 'db_session_table',
298 'DATABASE_DBA_HANDLER' => 'dba_handler',
299 'DATABASE_DIRECTORY' => 'directory',
300 'DATABASE_TIMEOUT' => 'timeout',
301 'DATABASE_PREFIX' => 'prefix')
304 if (defined($item)) {
305 $DBParams[$k] = constant($item);
307 } elseif (array_key_exists($item, $rs)) {
308 $DBParams[$k] = $rs[$item];
309 define($item, $rs[$item]);
311 } elseif (array_key_exists($item, $rsdef)) {
312 $DBParams[$k] = $rsdef[$item];
313 define($item, $rsdef[$item]);
314 unset($rsdef[$item]);
317 $valid_database_types = array('SQL','ADODB','PDO','dba','file','flatfile','cvs','cvsclient');
318 if (!in_array(DATABASE_TYPE, $valid_database_types))
319 trigger_error(sprintf("Invalid DATABASE_TYPE=%s. Choose one of %s",
320 DATABASE_TYPE, join(",", $valid_database_types)),
322 unset($valid_database_types);
323 if (DATABASE_TYPE == 'PDO') {
324 if (!check_php_version(5))
325 trigger_error("Invalid DATABASE_TYPE=PDO. PDO requires at least php-5.0!",
327 // try to load it dynamically (unix only)
328 if (!loadPhpExtension("pdo")) {
329 echo $GLOBALS['php_errormsg'], "<br>\n";
330 trigger_error(sprintf("dl() problem: Required extension '%s' could not be loaded!",
335 // Detect readonly database, e.g. system mounted read-only for maintenance
336 // via dbh->readonly later. Unfortunately not possible as constant.
338 // USE_DB_SESSION default logic:
339 if (!defined('USE_DB_SESSION')) {
340 if ($DBParams['db_session_table']
341 and in_array($DBParams['dbtype'], array('SQL','ADODB','PDO'))) {
342 define('USE_DB_SESSION', true);
343 } elseif ($DBParams['dbtype'] == 'dba' and check_php_version(4,1,2)) {
344 define('USE_DB_SESSION', true); // Depends on db handler as well.
345 // BerkeleyDB on older php has problems
346 // with multiple db handles.
348 define('USE_DB_SESSION', false);
351 unset($item); unset($k);
354 global $ExpireParams;
355 foreach (array('major','minor','author') as $major) {
356 foreach (array('max_age','min_age','min_keep','keep','max_keep') as $max) {
357 $item = strtoupper($major) . '_'. strtoupper($max);
358 if (defined($item)) $val = constant($item);
359 elseif (array_key_exists($item, $rs))
361 elseif (array_key_exists($item, $rsdef))
362 $val = $rsdef[$item];
363 if (!isset($ExpireParams[$major]))
364 $ExpireParams[$major] = array();
365 $ExpireParams[$major][$max] = $val;
369 unset($item); unset($major); unset($max);
371 // User authentication
372 if (!isset($GLOBALS['USER_AUTH_ORDER'])) {
373 if (isset($rs['USER_AUTH_ORDER']))
374 $GLOBALS['USER_AUTH_ORDER'] = preg_split('/\s*:\s*/',
375 $rs['USER_AUTH_ORDER']);
377 $GLOBALS['USER_AUTH_ORDER'] = array("PersonalPage");
380 // Now it's the external DB authentication stuff's turn
381 if (in_array('Db', $GLOBALS['USER_AUTH_ORDER']) && empty($rs['DBAUTH_AUTH_DSN'])) {
382 $rs['DBAUTH_AUTH_DSN'] = $DBParams['dsn'];
385 global $DBAuthParams;
386 $DBAP_MAP = array('DBAUTH_AUTH_DSN' => 'auth_dsn',
387 'DBAUTH_AUTH_CHECK' => 'auth_check',
388 'DBAUTH_AUTH_USER_EXISTS' => 'auth_user_exists',
389 'DBAUTH_AUTH_CRYPT_METHOD' => 'auth_crypt_method',
390 'DBAUTH_AUTH_UPDATE' => 'auth_update',
391 'DBAUTH_AUTH_CREATE' => 'auth_create',
392 'DBAUTH_PREF_SELECT' => 'pref_select',
393 'DBAUTH_PREF_INSERT' => 'pref_insert',
394 'DBAUTH_PREF_UPDATE' => 'pref_update',
395 'DBAUTH_IS_MEMBER' => 'is_member',
396 'DBAUTH_GROUP_MEMBERS' => 'group_members',
397 'DBAUTH_USER_GROUPS' => 'user_groups'
399 foreach ($DBAP_MAP as $rskey => $apkey) {
400 if (defined($rskey)) {
401 $DBAuthParams[$apkey] = constant($rskey);
402 } elseif (isset($rs[$rskey])) {
403 $DBAuthParams[$apkey] = $rs[$rskey];
404 define($rskey, $rs[$rskey]);
405 } elseif (isset($rsdef[$rskey])) {
406 $DBAuthParams[$apkey] = $rsdef[$rskey];
407 define($rskey, $rsdef[$rskey]);
411 unset($rskey); unset($apkey);
413 // TODO: Currently unsupported on non-SQL. Nice to have for RhNavPlugin
415 if (array_key_exists('ACCESS_LOG_SQL', $rs)) {
416 // WikiDB_backend::isSql() not yet loaded
417 if (!in_array(DATABASE_TYPE, array('SQL','ADODB','PDO')))
418 // override false config setting on no SQL WikiDB database.
419 define('ACCESS_LOG_SQL', 0);
421 // SQL defaults to ACCESS_LOG_SQL = 2
423 define('ACCESS_LOG_SQL',
424 in_array(DATABASE_TYPE, array('SQL','ADODB','PDO')) ? 2 : 0);
427 global $PLUGIN_MARKUP_MAP;
428 $PLUGIN_MARKUP_MAP = array();
429 if (defined('PLUGIN_MARKUP_MAP') and trim(PLUGIN_MARKUP_MAP) != "") {
430 $_map = preg_split('/\s+/', PLUGIN_MARKUP_MAP);
431 foreach ($_map as $v) {
432 list($xml,$plugin) = split(':', $v);
433 if (!empty($xml) and !empty($plugin))
434 $PLUGIN_MARKUP_MAP[$xml] = $plugin;
436 unset($_map); unset($xml); unset($plugin); unset($v);
439 if (empty($rs['TEMP_DIR'])) {
440 $rs['TEMP_DIR'] = "/tmp";
442 $rs['TEMP_DIR'] = getenv("TEMP");
444 // optional values will be set to '' to simplify the logic.
445 foreach ($_IC_OPTIONAL_VALUE as $item) {
446 if (defined($item)) {
450 if (array_key_exists($item, $rs)) {
451 _check_int_constant($rs[$item]);
452 define($item, $rs[$item]);
458 if (USE_EXTERNAL_HTML2PDF) {
459 $item = 'EXTERNAL_HTML2PDF_PAGELIST';
460 if (defined($item)) {
462 } elseif (array_key_exists($item, $rs)) {
463 define($item, $rs[$item]);
465 } elseif (array_key_exists($item, $rsdef)) {
466 define($item, $rsdef[$item]);
472 global $LDAP_SET_OPTION;
473 if (defined('LDAP_SET_OPTION') and LDAP_SET_OPTION) {
474 $optlist = preg_split('/\s*:\s*/', LDAP_SET_OPTION);
475 foreach ($optlist as $opt) {
476 $bits = preg_split('/\s*=\s*/', $opt, 2);
477 if (count($bits) == 2) {
478 if (is_string($bits[0]) and defined($bits[0]))
479 $bits[0] = constant($bits[0]);
480 $LDAP_SET_OPTION[$bits[0]] = $bits[1];
483 // Possibly throw some sort of error?
486 unset($opt); unset($bits);
489 // Default Wiki pages to force loading from pgsrc
490 global $GenericPages;
491 $GenericPages = preg_split('/\s*:\s*/', @$rs['DEFAULT_WIKI_PAGES']);
493 // Wiki name regexp: Should be a define(), but might needed to be changed at runtime
494 // (different LC_CHAR need different posix classes)
495 global $WikiNameRegexp;
496 $WikiNameRegexp = constant('WIKI_NAME_REGEXP');
497 if (!trim($WikiNameRegexp))
498 $WikiNameRegexp = '(?<![[:alnum:]])(?:[[:upper:]][[:lower:]]+){2,}(?![[:alnum:]])';
500 // Got rid of global $KeywordLinkRegexp by using a TextSearchQuery instead
501 // of "Category:Topic"
502 if (!isset($rs['KEYWORDS'])) $rs['KEYWORDS'] = @$rsdef['KEYWORDS'];
503 if (!isset($rs['KEYWORDS'])) $rs['KEYWORDS'] = "Category* OR Topic*";
504 if ($rs['KEYWORDS'] == 'Category:Topic') $rs['KEYWORDS'] = "Category* OR Topic*";
505 if (!defined('KEYWORDS')) define('KEYWORDS', $rs['KEYWORDS']);
506 //if (empty($keywords)) $keywords = array("Category","Topic");
507 //$KeywordLinkRegexp = '(?<=' . implode('|^', $keywords) . ')[[:upper:]].*$';
509 // TODO: can this be a constant?
510 global $DisabledActions;
511 if (!array_key_exists('DISABLED_ACTIONS', $rs)
512 and array_key_exists('DISABLED_ACTIONS', $rsdef))
513 $rs['DISABLED_ACTIONS'] = @$rsdef['DISABLED_ACTIONS'];
514 if (array_key_exists('DISABLED_ACTIONS', $rs))
515 $DisabledActions = preg_split('/\s*:\s*/', $rs['DISABLED_ACTIONS']);
517 global $PLUGIN_CACHED_IMGTYPES;
518 $PLUGIN_CACHED_IMGTYPES = preg_split('/\s*[|:]\s*/', PLUGIN_CACHED_IMGTYPES);
520 if (!defined('PLUGIN_CACHED_CACHE_DIR')) {
521 if (empty($rs['PLUGIN_CACHED_CACHE_DIR']) and !empty($rsdef['PLUGIN_CACHED_CACHE_DIR']))
522 $rs['PLUGIN_CACHED_CACHE_DIR'] = $rsdef['PLUGIN_CACHED_CACHE_DIR'];
523 if (empty($rs['PLUGIN_CACHED_CACHE_DIR'])) {
524 if (!empty($rs['INCLUDE_PATH'])) {
525 @ini_set('include_path', $rs['INCLUDE_PATH']);
526 $GLOBALS['INCLUDE_PATH'] = $rs['INCLUDE_PATH'];
528 $rs['PLUGIN_CACHED_CACHE_DIR'] = TEMP_DIR . '/cache';
529 if (!FindFile($rs['PLUGIN_CACHED_CACHE_DIR'], 1)) { // [29ms]
530 FindFile(TEMP_DIR, false, 1); // TEMP must exist!
531 mkdir($rs['PLUGIN_CACHED_CACHE_DIR'], 0777);
533 // will throw an error if not exists.
534 define('PLUGIN_CACHED_CACHE_DIR', FindFile($rs['PLUGIN_CACHED_CACHE_DIR'],false,1));
536 define('PLUGIN_CACHED_CACHE_DIR', $rs['PLUGIN_CACHED_CACHE_DIR']);
537 // will throw an error if not exists.
538 FindFile(PLUGIN_CACHED_CACHE_DIR);
542 // process the rest of the config.ini settings:
543 foreach ($rs as $item => $v) {
544 if (defined($item)) {
547 _check_int_constant($v);
551 unset($item); unset($v);
556 fixup_static_configs($file); //[1ms]
557 // Dump all globals and constants
558 // The question is if reading this is faster then doing IniConfig() + fixup_static_configs()
559 if (is_writable($dump)) {
562 // store locale[] in config.php? This is too problematic.
563 fixup_dynamic_configs($file); // [100ms]
566 function _ignore_unknown_charset_warning(&$error) {
567 //htmlspecialchars(): charset `iso-8859-2' not supported, assuming iso-8859-1
568 if (preg_match('/^htmlspecialchars\(\): charset \`.+\' not supported, assuming iso-8859-1/',
571 return true; // Ignore error
576 // moved from lib/config.php [1ms]
577 function fixup_static_configs($file) {
578 global $FieldSeparator, $charset, $WikiNameRegexp, $AllActionPages;
579 global $HTTP_SERVER_VARS, $DBParams, $LANG, $ErrorManager;
580 // init FileFinder to add proper include paths
581 FindFile("lib/interwiki.map",true);
583 // "\x80"-"\x9f" (and "\x00" - "\x1f") are non-printing control
584 // chars in iso-8859-*
585 // $FieldSeparator = "\263"; // this is a superscript 3 in ISO-8859-1.
586 // $FieldSeparator = "\xFF"; // this byte should never appear in utf-8
587 // Get rid of constant. pref is dynamic and language specific
589 // Disabled: Let the admin decide which charset.
590 //if (isset($LANG) and in_array($LANG,array('zh')))
591 // $charset = 'utf-8';
592 if (strtolower($charset) == 'utf-8')
593 $FieldSeparator = "\xFF";
595 $FieldSeparator = "\x81";
597 // Some exotic charsets are not supported by htmlspecialchars, which just prints an E_WARNING.
598 // Even on simple 8bit charsets, where just <>& need to be replaced. For iso-8859-[2-4] e.g.
599 // See <php-src>/ext/standard/html.c
600 // For performance reasons we require a magic constant to ignore this warning.
601 if (defined('IGNORE_CHARSET_NOT_SUPPORTED_WARNING')
602 and IGNORE_CHARSET_NOT_SUPPORTED_WARNING)
604 $ErrorManager->pushErrorHandler
605 (new WikiFunctionCb('_ignore_unknown_charset_warning'));
607 // Used by SetupWiki to pull in required pages, if not translated, then in english.
608 // Also used by _WikiTranslation. Really important are only those which return pagelists
609 // or contain basic functionality.
611 All pages containing plugins of the same name as the filename:
613 grep -l '\?plugin ' *| perl -ne'$/=0;chop; s/%([\da-fA-F]{2})/pack("C",hex($1))/ge; next LINE if m{^(Help/|Template|Pgsrc)}; print "$_\n"; {local $/;open F,"<$_"; $f=join("",<F>);} push @a,$_ if $f=~/plugin $_/; END{print join(":",@a)};'
615 $AllActionPages = explode(':',
616 'AllPages:AllUsers:AppendText:AuthorHistory:'
617 .'BackLinks:BlogArchives:BlogJournal:'
619 .'FindPage:FullTextSearch:FuzzyPages:'
620 .'LikePages:LinkDatabase:LinkSearch:ListRelations:'
621 .'ModeratedPage:MostPopular:'
623 .'PageDump:PageHistory:PageInfo:PluginManager:'
624 .'RandomPage:RecentChanges:RecentComments:RelatedChanges:'
625 .'SearchHighlight:SemanticRelations:SemanticSearch:SystemInfo:'
627 .'UpLoad:UserPreferences:'
628 .'WantedPages:WatchPage:WhoIsOnline:WikiAdminSelect:WikiBlog:'
629 // plus some derivations
630 .'AllPagesCreatedByMe:AllPagesLastEditedByMe:AllPagesOwnedByMe:AllUserPages:'
631 .'FullRecentChanges:'
632 .'LeastPopular:LockedPages:'
633 .'MyRecentEdits:MyRecentChanges:'
634 .'PhpWikiAdministration:'
635 .'PhpWikiAdministration/Chown:'
636 .'PhpWikiAdministration/Markup:'
637 .'PhpWikiAdministration/Purge:'
638 .'PhpWikiAdministration/Remove:'
639 .'PhpWikiAdministration/Rename:'
640 .'PhpWikiAdministration/SearchReplace:'
641 .'PhpWikiAdministration/SetAcl:'
642 .'RecentChangesMyPages:RecentEdits:RecentNewPages:'
645 // Add some some action pages depending on configuration
646 if (defined('DEBUG') and DEBUG) {
647 $AllActionPages[] = 'DebugInfo';
648 $AllActionPages[] = 'EditMetaData';
649 $AllActionPages[] = 'SpellCheck'; // SpellCheck does not work
650 $AllActionPages[] = 'PhpWikiAdministration/Chmod';
652 // The GFORGE theme omits them
653 if (!defined('GFORGE') or !GFORGE) {
654 $AllActionPages[] = 'InterWikiSearch';
655 $AllActionPages[] = 'LdapSearch';
656 $AllActionPages[] = 'PasswordReset';
657 $AllActionPages[] = 'RateIt'; // RateIt works only in wikilens derived themes
658 $AllActionPages[] = 'TranslateText';
659 $AllActionPages[] = 'UriResolver';
661 if (defined('GFORGE') and GFORGE) {
662 if (defined('ENABLE_EXTERNAL_PAGES') and ENABLE_EXTERNAL_PAGES) {
663 $AllActionPages[] = 'ExternalPages';
667 // If user has not defined PHPWIKI_DIR, and we need it
668 if (!defined('PHPWIKI_DIR') and !file_exists("themes/default")) {
669 $themes_dir = FindFile("themes");
670 define('PHPWIKI_DIR', dirname($themes_dir));
673 // If user has not defined DATA_PATH, we want to use relative URLs.
674 if (!defined('DATA_PATH')) {
675 // fix similar to the one suggested by jkalmbach for
676 // installations in the webrootdir, like "http://phpwiki.org/HomePage"
677 if (!defined('SCRIPT_NAME'))
678 define('SCRIPT_NAME', deduce_script_name());
679 $temp = dirname(SCRIPT_NAME);
680 if ( ($temp == '/') || ($temp == '\\') )
682 define('DATA_PATH', $temp);
685 define('DATA_PATH', '..');
689 //////////////////////////////////////////////////////////////////
692 if (empty($DBParams['dbtype']))
693 $DBParams['dbtype'] = 'dba';
695 if (!defined('THEME'))
696 define('THEME', 'default');
698 /*$configurator_link = HTML(HTML::br(), "=>",
699 HTML::a(array('href'=>DATA_PATH."/configurator.php"),
700 _("Configurator")));*/
701 // check whether the crypt() function is needed and present
702 if (defined('ENCRYPTED_PASSWD') && !function_exists('crypt')) {
703 $error = sprintf("Encrypted passwords cannot be used: %s.",
704 "'function crypt()' not available in this version of php");
705 trigger_error($error, E_USER_WARNING);
706 if (!preg_match("/config\-dist\.ini$/", $file)) { // protect against recursion
707 include_once(dirname(__FILE__)."/install.php");
708 run_install("_part1");
713 // Basic configurator validation
714 if (!defined('ADMIN_USER') or ADMIN_USER == '') {
715 $error = sprintf("%s may not be empty. Please update your configuration.",
717 // protect against recursion
718 if (!preg_match("/config\-(dist|default)\.ini$/", $file)
719 and !defined("_PHPWIKI_INSTALL_RUNNING"))
721 include_once(dirname(__FILE__)."/install.php");
722 run_install("_part1");
723 trigger_error($error, E_USER_ERROR);
725 } elseif ($HTTP_SERVER_VARS["REQUEST_METHOD"] == "POST") {
726 $GLOBALS['HTTP_GET_VARS']['show'] = '_part1';
727 trigger_error($error, E_USER_WARNING);
730 if (!defined('ADMIN_PASSWD') or ADMIN_PASSWD == '') {
731 $error = sprintf("%s may not be empty. Please update your configuration.",
733 // protect against recursion
734 if (!preg_match("/config\-(dist|default)\.ini$/", $file)
735 and !defined("_PHPWIKI_INSTALL_RUNNING"))
737 include_once(dirname(__FILE__)."/install.php");
738 run_install("_part1");
739 trigger_error($error, E_USER_ERROR);
741 } elseif ($HTTP_SERVER_VARS["REQUEST_METHOD"] == "POST") {
742 $GLOBALS['HTTP_GET_VARS']['show'] = '_part1';
743 trigger_error($error, E_USER_WARNING);
747 if (defined('USE_DB_SESSION') and USE_DB_SESSION) {
748 if (! $DBParams['db_session_table'] ) {
749 $DBParams['db_session_table'] = @$DBParams['prefix'] . 'session';
750 trigger_error(sprintf("DATABASE_SESSION_TABLE configuration set to %s.",
751 $DBParams['db_session_table']),
756 if (!defined('ENABLE_USER_NEW')) define('ENABLE_USER_NEW',true);
757 if (!defined('ALLOW_USER_LOGIN'))
758 define('ALLOW_USER_LOGIN', defined('ALLOW_USER_PASSWORDS') && ALLOW_USER_PASSWORDS);
759 if (!defined('ALLOW_ANON_USER')) define('ALLOW_ANON_USER', true);
760 if (!defined('ALLOW_ANON_EDIT')) define('ALLOW_ANON_EDIT', false);
761 if (!defined('REQUIRE_SIGNIN_BEFORE_EDIT')) define('REQUIRE_SIGNIN_BEFORE_EDIT', ! ALLOW_ANON_EDIT);
762 if (!defined('ALLOW_BOGO_LOGIN')) define('ALLOW_BOGO_LOGIN', true);
763 if (!ENABLE_USER_NEW) {
764 if (!defined('ALLOW_HTTP_AUTH_LOGIN'))
765 define('ALLOW_HTTP_AUTH_LOGIN', false);
766 if (!defined('ALLOW_LDAP_LOGIN'))
767 define('ALLOW_LDAP_LOGIN', function_exists('ldap_connect') and defined('LDAP_AUTH_HOST'));
768 if (!defined('ALLOW_IMAP_LOGIN'))
769 define('ALLOW_IMAP_LOGIN', function_exists('imap_open') and defined('IMAP_AUTH_HOST'));
772 if (ALLOW_USER_LOGIN and !empty($DBAuthParams) and empty($DBAuthParams['auth_dsn'])) {
773 if (isset($DBParams['dsn']))
774 $DBAuthParams['auth_dsn'] = $DBParams['dsn'];
779 * Define constants which are client or request specific and should not be dumped statically.
780 * Such as the language, and the virtual and server paths, which might be overridden
781 * by startup scripts for wiki farms.
783 function fixup_dynamic_configs($file) {
784 global $WikiNameRegexp;
785 global $HTTP_SERVER_VARS, $DBParams, $LANG;
787 if (defined('INCLUDE_PATH') and INCLUDE_PATH) {
788 @ini_set('include_path', INCLUDE_PATH);
789 $GLOBALS['INCLUDE_PATH'] = INCLUDE_PATH;
791 if (defined('SESSION_SAVE_PATH') and SESSION_SAVE_PATH)
792 @ini_set('session.save_path', SESSION_SAVE_PATH);
793 if (!defined('DEFAULT_LANGUAGE')) // not needed anymore
794 define('DEFAULT_LANGUAGE', ''); // detect from client
797 if (!defined('GFORGE') or !GFORGE) {
798 // Disable update_locale because Zend Debugger crash
799 if(! extension_loaded('Zend Debugger')) {
800 update_locale(isset($LANG) ? $LANG : DEFAULT_LANGUAGE);
805 if (!defined("DEFAULT_LANGUAGE") or !DEFAULT_LANGUAGE) {
806 // TODO: defer this to WikiRequest::initializeLang()
807 $LANG = guessing_lang();
808 guessing_setlocale (LC_ALL,$LANG);
811 $LANG = DEFAULT_LANGUAGE;
814 // Set up (possibly fake) gettext()
815 // Todo: this could be moved to fixup_static_configs()
816 // Bug #1381464 with php-5.1.1
817 if (!function_exists ('bindtextdomain')
818 and !function_exists ('gettext')
819 and !function_exists ('_'))
823 function gettext ($text) {
825 if (!empty ($locale[$text]))
826 return $locale[$text];
830 return gettext($text);
837 // Working around really weird gettext problems: (4.3.2, 4.3.6 win)
838 // bindtextdomain() in returns the current domain path.
839 // 1. If the script is not index.php but something like "de", on a different path
840 // then bindtextdomain() fails, but after chdir to the correct path it will work okay.
841 // 2. But the weird error "Undefined variable: bindtextdomain" is generated then.
842 $bindtextdomain_path = FindFile("locale", false, true);
844 $bindtextdomain_path = str_replace("/", "\\", $bindtextdomain_path);
845 $bindtextdomain_real = @bindtextdomain("phpwiki", $bindtextdomain_path);
846 if (realpath($bindtextdomain_real) != realpath($bindtextdomain_path)) {
847 // this will happen with virtual_paths. chdir and try again.
848 chdir($bindtextdomain_path);
850 $bindtextdomain_real = @bindtextdomain("phpwiki", $bindtextdomain_path);
853 // tell gettext not to use unicode. PHP >= 4.2.0. Thanks to Kai Krakow.
854 if (defined('CHARSET') and function_exists('bind_textdomain_codeset'))
855 @bind_textdomain_codeset("phpwiki", CHARSET);
857 textdomain("phpwiki");
858 if ($chback) { // change back
859 chdir($bindtextdomain_real . (isWindows() ? "\\.." : "/.."));
863 // language dependent updates:
864 $WikiNameRegexp = pcre_fix_posix_classes($WikiNameRegexp);
865 //if ($KeywordLinkRegexp) $KeywordLinkRegexp = pcre_fix_posix_classes($KeywordLinkRegexp);
866 if (!defined('CATEGORY_GROUP_PAGE'))
867 define('CATEGORY_GROUP_PAGE',_("CategoryGroup"));
868 if (!defined('WIKI_NAME'))
869 define('WIKI_NAME', _("An unnamed PhpWiki"));
870 if (!defined('HOME_PAGE'))
871 define('HOME_PAGE', _("HomePage"));
874 //////////////////////////////////////////////////////////////////
875 // Autodetect URL settings:
877 foreach (array('SERVER_NAME','SERVER_PORT') as $var) {
878 //FIXME: for CGI without _SERVER
879 if (!defined($var) and !empty($HTTP_SERVER_VARS[$var]))
880 // IPV6 fix by matt brown, #1546571
881 // An IPv6 address must be surrounded by square brackets to form a valid server name.
882 if ($var == 'SERVER_NAME' &&
883 strstr($HTTP_SERVER_VARS[$var], ':')) {
884 define($var, '[' . $HTTP_SERVER_VARS[$var] . ']');
886 define($var, $HTTP_SERVER_VARS[$var]);
889 if (!defined('SERVER_NAME')) define('SERVER_NAME', '127.0.0.1');
890 if (!defined('SERVER_PORT')) define('SERVER_PORT', 80);
891 if (!defined('SERVER_PROTOCOL')) {
892 if (empty($HTTP_SERVER_VARS['HTTPS']) || $HTTP_SERVER_VARS['HTTPS'] == 'off')
893 define('SERVER_PROTOCOL', 'http');
895 define('SERVER_PROTOCOL', 'https');
898 if (!defined('SCRIPT_NAME'))
899 define('SCRIPT_NAME', deduce_script_name());
901 if (!defined('USE_PATH_INFO')) {
903 define('USE_PATH_INFO', false);
906 * If SCRIPT_NAME does not look like php source file,
907 * or user cgi we assume that php is getting run by an
908 * action handler in /cgi-bin. In this case,
909 * I think there is no way to get Apache to pass
910 * useful PATH_INFO to the php script (PATH_INFO
911 * is used to the the php interpreter where the
914 switch (php_sapi_name()) {
916 case 'apache2handler':
917 define('USE_PATH_INFO', true);
920 case 'apache2filter':
921 define('USE_PATH_INFO', false);
924 define('USE_PATH_INFO', ereg('\.(php3?|cgi)$', SCRIPT_NAME));
931 && SERVER_PORT != (SERVER_PROTOCOL == 'https' ? 443 : 80)) {
933 SERVER_PROTOCOL . '://' . SERVER_NAME . ':' . SERVER_PORT);
937 SERVER_PROTOCOL . '://' . SERVER_NAME);
940 if (!defined('VIRTUAL_PATH')) {
941 // We'd like to auto-detect when the cases where apaches
942 // 'Action' directive (or similar means) is used to
943 // redirect page requests to a cgi-handler.
945 // In cases like this, requests for e.g. /wiki/HomePage
946 // get redirected to a cgi-script called, say,
947 // /path/to/wiki/index.php. The script gets all
948 // of /wiki/HomePage as it's PATH_INFO.
951 // How to detect when this has happened reliably?
952 // How to pick out the "virtual path" (in this case '/wiki')?
954 // (Another time an redirect might occur is to a DirectoryIndex
955 // -- the requested URI is '/wikidir/', the request gets
956 // passed to '/wikidir/index.php'. In this case, the
957 // proper VIRTUAL_PATH is '/wikidir/index.php', since the
958 // pages will appear at e.g. '/wikidir/index.php/HomePage'.
961 $REDIRECT_URL = &$HTTP_SERVER_VARS['REDIRECT_URL'];
962 if (USE_PATH_INFO and isset($REDIRECT_URL)
963 and ! IsProbablyRedirectToIndex()) {
964 // FIXME: This is a hack, and won't work if the requested
965 // pagename has a slash in it.
966 $temp = strtr(dirname($REDIRECT_URL . 'x'),"\\",'/');
967 if ( ($temp == '/') || ($temp == '\\') )
969 define('VIRTUAL_PATH', $temp);
971 define('VIRTUAL_PATH', SCRIPT_NAME);
975 if (VIRTUAL_PATH != SCRIPT_NAME) {
976 // Apache action handlers are used.
977 define('PATH_INFO_PREFIX', VIRTUAL_PATH . '/');
980 define('PATH_INFO_PREFIX', '/');
982 define('PHPWIKI_BASE_URL',
983 SERVER_URL . (USE_PATH_INFO ? VIRTUAL_PATH . '/' : SCRIPT_NAME));
985 // Detect PrettyWiki setup (not loading index.php directly)
986 // $SCRIPT_FILENAME should be the same as __FILE__ in index.php
987 if (!isset($SCRIPT_FILENAME))
988 $SCRIPT_FILENAME = @$HTTP_SERVER_VARS['SCRIPT_FILENAME'];
989 if (!isset($SCRIPT_FILENAME))
990 $SCRIPT_FILENAME = @$HTTP_ENV_VARS['SCRIPT_FILENAME'];
991 if (!isset($SCRIPT_FILENAME))
992 $SCRIPT_FILENAME = dirname(__FILE__.'/../') . '/index.php';
994 $SCRIPT_FILENAME = str_replace('\\\\','\\',strtr($SCRIPT_FILENAME, '/', '\\'));
995 define('SCRIPT_FILENAME', $SCRIPT_FILENAME);
997 // Get remote host name, if apache hasn't done it for us
998 if (empty($HTTP_SERVER_VARS['REMOTE_HOST'])
999 and !empty($HTTP_SERVER_VARS['REMOTE_ADDR'])
1000 and ENABLE_REVERSE_DNS)
1001 $HTTP_SERVER_VARS['REMOTE_HOST'] = gethostbyaddr($HTTP_SERVER_VARS['REMOTE_ADDR']);
1005 // (c-file-style: "gnu")
1009 // c-basic-offset: 4
1010 // c-hanging-comment-ender-p: nil
1011 // indent-tabs-mode: nil