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'));
594 // Used by SetupWiki to pull in required pages, if not translated, then in english.
595 // Also used by _WikiTranslation. Really important are only those which return pagelists
596 // or contain basic functionality.
598 All pages containing plugins of the same name as the filename:
600 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)};'
602 $AllActionPages = explode(':',
603 'AllPages:AllUsers:AppendText:AuthorHistory:'
606 .'FindPage:FullTextSearch:FuzzyPages:'
607 .'LikePages:LinkDatabase:LinkSearch:ListRelations:'
608 .'ModeratedPage:MostPopular:'
611 .'PageDump:PageHistory:PageInfo:PluginManager:'
612 .'RandomPage:RecentChanges:RelatedChanges:'
613 .'SearchHighlight:SemanticRelations:SemanticSearch:SystemInfo:'
615 .'UpLoad:UserPreferences:'
616 .'WantedPages:WatchPage:WhoIsOnline:WikiAdminSelect:'
617 // plus some derivations
618 .'AllPagesCreatedByMe:AllPagesLastEditedByMe:AllPagesOwnedByMe:AllUserPages:'
619 .'FullRecentChanges:'
620 .'LeastPopular:LockedPages:'
621 .'MyRecentEdits:MyRecentChanges:'
622 .'PhpWikiAdministration:'
623 .'PhpWikiAdministration/Chown:'
624 .'PhpWikiAdministration/Purge:'
625 .'PhpWikiAdministration/Remove:'
626 .'PhpWikiAdministration/Rename:'
627 .'PhpWikiAdministration/SearchReplace:'
628 .'PhpWikiAdministration/SetAcl:'
629 .'RecentChangesMyPages:RecentEdits:RecentNewPages:'
632 // The GFORGE theme omits them
633 if (!defined('GFORGE') or !GFORGE) {
634 // Add some some action pages depending on configuration
635 if (defined('DEBUG') and DEBUG) {
636 $AllActionPages[] = 'DebugInfo';
637 $AllActionPages[] = 'EditMetaData';
638 $AllActionPages[] = 'SpellCheck'; // SpellCheck does not work
639 $AllActionPages[] = 'PhpWikiAdministration/Chmod';
641 $AllActionPages[] = 'BlogArchives';
642 $AllActionPages[] = 'BlogJournal';
643 $AllActionPages[] = 'InterWikiSearch';
644 $AllActionPages[] = 'LdapSearch';
645 $AllActionPages[] = 'PasswordReset';
646 $AllActionPages[] = 'PhpWikiAdministration/Markup';
647 $AllActionPages[] = 'RateIt'; // RateIt works only in wikilens derived themes
648 $AllActionPages[] = 'RecentComments';
649 $AllActionPages[] = 'TranslateText';
650 $AllActionPages[] = 'UriResolver';
651 $AllActionPages[] = 'WikiBlog';
653 if (defined('GFORGE') and GFORGE) {
654 if (defined('ENABLE_EXTERNAL_PAGES') and ENABLE_EXTERNAL_PAGES) {
655 $AllActionPages[] = 'ExternalPages';
659 // If user has not defined PHPWIKI_DIR, and we need it
660 if (!defined('PHPWIKI_DIR') and !file_exists("themes/default")) {
661 $themes_dir = FindFile("themes");
662 define('PHPWIKI_DIR', dirname($themes_dir));
665 // If user has not defined DATA_PATH, we want to use relative URLs.
666 if (!defined('DATA_PATH')) {
667 // fix similar to the one suggested by jkalmbach for
668 // installations in the webrootdir, like "http://phpwiki.org/HomePage"
669 if (!defined('SCRIPT_NAME'))
670 define('SCRIPT_NAME', deduce_script_name());
671 $temp = dirname(SCRIPT_NAME);
672 if ( ($temp == '/') || ($temp == '\\') )
674 define('DATA_PATH', $temp);
677 define('DATA_PATH', '..');
681 //////////////////////////////////////////////////////////////////
684 if (empty($DBParams['dbtype']))
685 $DBParams['dbtype'] = 'dba';
687 if (!defined('THEME'))
688 define('THEME', 'default');
690 /*$configurator_link = HTML(HTML::br(), "=>",
691 HTML::a(array('href'=>DATA_PATH."/configurator.php"),
692 _("Configurator")));*/
693 // check whether the crypt() function is needed and present
694 if (defined('ENCRYPTED_PASSWD') && !function_exists('crypt')) {
695 $error = sprintf("Encrypted passwords cannot be used: %s.",
696 "'function crypt()' not available in this version of php");
697 trigger_error($error, E_USER_WARNING);
698 if (!preg_match("/config\-dist\.ini$/", $file)) { // protect against recursion
699 include_once(dirname(__FILE__)."/install.php");
700 run_install("_part1");
705 // Basic configurator validation
706 if (!defined('ADMIN_USER') or ADMIN_USER == '') {
707 $error = sprintf("%s may not be empty. Please update your configuration.",
709 // protect against recursion
710 if (!preg_match("/config\-(dist|default)\.ini$/", $file)
711 and !defined("_PHPWIKI_INSTALL_RUNNING"))
713 include_once(dirname(__FILE__)."/install.php");
714 run_install("_part1");
715 trigger_error($error, E_USER_ERROR);
717 } elseif ($HTTP_SERVER_VARS["REQUEST_METHOD"] == "POST") {
718 $GLOBALS['HTTP_GET_VARS']['show'] = '_part1';
719 trigger_error($error, E_USER_WARNING);
722 if (!defined('ADMIN_PASSWD') or ADMIN_PASSWD == '') {
723 $error = sprintf("%s may not be empty. Please update your configuration.",
725 // protect against recursion
726 if (!preg_match("/config\-(dist|default)\.ini$/", $file)
727 and !defined("_PHPWIKI_INSTALL_RUNNING"))
729 include_once(dirname(__FILE__)."/install.php");
730 run_install("_part1");
731 trigger_error($error, E_USER_ERROR);
733 } elseif ($HTTP_SERVER_VARS["REQUEST_METHOD"] == "POST") {
734 $GLOBALS['HTTP_GET_VARS']['show'] = '_part1';
735 trigger_error($error, E_USER_WARNING);
739 if (defined('USE_DB_SESSION') and USE_DB_SESSION) {
740 if (! $DBParams['db_session_table'] ) {
741 $DBParams['db_session_table'] = @$DBParams['prefix'] . 'session';
742 trigger_error(sprintf("DATABASE_SESSION_TABLE configuration set to %s.",
743 $DBParams['db_session_table']),
748 if (!defined('ENABLE_USER_NEW')) define('ENABLE_USER_NEW',true);
749 if (!defined('ALLOW_USER_LOGIN'))
750 define('ALLOW_USER_LOGIN', defined('ALLOW_USER_PASSWORDS') && ALLOW_USER_PASSWORDS);
751 if (!defined('ALLOW_ANON_USER')) define('ALLOW_ANON_USER', true);
752 if (!defined('ALLOW_ANON_EDIT')) define('ALLOW_ANON_EDIT', false);
753 if (!defined('REQUIRE_SIGNIN_BEFORE_EDIT')) define('REQUIRE_SIGNIN_BEFORE_EDIT', ! ALLOW_ANON_EDIT);
754 if (!defined('ALLOW_BOGO_LOGIN')) define('ALLOW_BOGO_LOGIN', true);
755 if (!ENABLE_USER_NEW) {
756 if (!defined('ALLOW_HTTP_AUTH_LOGIN'))
757 define('ALLOW_HTTP_AUTH_LOGIN', false);
758 if (!defined('ALLOW_LDAP_LOGIN'))
759 define('ALLOW_LDAP_LOGIN', function_exists('ldap_connect') and defined('LDAP_AUTH_HOST'));
760 if (!defined('ALLOW_IMAP_LOGIN'))
761 define('ALLOW_IMAP_LOGIN', function_exists('imap_open') and defined('IMAP_AUTH_HOST'));
764 if (ALLOW_USER_LOGIN and !empty($DBAuthParams) and empty($DBAuthParams['auth_dsn'])) {
765 if (isset($DBParams['dsn']))
766 $DBAuthParams['auth_dsn'] = $DBParams['dsn'];
771 * Define constants which are client or request specific and should not be dumped statically.
772 * Such as the language, and the virtual and server paths, which might be overridden
773 * by startup scripts for wiki farms.
775 function fixup_dynamic_configs($file) {
776 global $WikiNameRegexp;
777 global $HTTP_SERVER_VARS, $DBParams, $LANG;
779 if (defined('INCLUDE_PATH') and INCLUDE_PATH) {
780 @ini_set('include_path', INCLUDE_PATH);
781 $GLOBALS['INCLUDE_PATH'] = INCLUDE_PATH;
783 if (defined('SESSION_SAVE_PATH') and SESSION_SAVE_PATH)
784 @ini_set('session.save_path', SESSION_SAVE_PATH);
785 if (!defined('DEFAULT_LANGUAGE')) // not needed anymore
786 define('DEFAULT_LANGUAGE', ''); // detect from client
789 if (!defined('GFORGE') or !GFORGE) {
790 // Disable update_locale because Zend Debugger crash
791 if(! extension_loaded('Zend Debugger')) {
792 update_locale(isset($LANG) ? $LANG : DEFAULT_LANGUAGE);
797 if (!defined("DEFAULT_LANGUAGE") or !DEFAULT_LANGUAGE) {
798 // TODO: defer this to WikiRequest::initializeLang()
799 $LANG = guessing_lang();
800 guessing_setlocale (LC_ALL,$LANG);
803 $LANG = DEFAULT_LANGUAGE;
806 // Set up (possibly fake) gettext()
807 // Todo: this could be moved to fixup_static_configs()
808 // Bug #1381464 with php-5.1.1
809 if (!function_exists ('bindtextdomain')
810 and !function_exists ('gettext')
811 and !function_exists ('_'))
815 function gettext ($text) {
817 if (!empty ($locale[$text]))
818 return $locale[$text];
822 return gettext($text);
829 // Working around really weird gettext problems: (4.3.2, 4.3.6 win)
830 // bindtextdomain() in returns the current domain path.
831 // 1. If the script is not index.php but something like "de", on a different path
832 // then bindtextdomain() fails, but after chdir to the correct path it will work okay.
833 // 2. But the weird error "Undefined variable: bindtextdomain" is generated then.
834 $bindtextdomain_path = FindFile("locale", false, true);
836 $bindtextdomain_path = str_replace("/", "\\", $bindtextdomain_path);
837 $bindtextdomain_real = @bindtextdomain("phpwiki", $bindtextdomain_path);
838 if (realpath($bindtextdomain_real) != realpath($bindtextdomain_path)) {
839 // this will happen with virtual_paths. chdir and try again.
840 chdir($bindtextdomain_path);
842 $bindtextdomain_real = @bindtextdomain("phpwiki", $bindtextdomain_path);
845 // tell gettext not to use unicode. PHP >= 4.2.0. Thanks to Kai Krakow.
846 if (defined('CHARSET') and function_exists('bind_textdomain_codeset'))
847 @bind_textdomain_codeset("phpwiki", CHARSET);
849 textdomain("phpwiki");
850 if ($chback) { // change back
851 chdir($bindtextdomain_real . (isWindows() ? "\\.." : "/.."));
855 // language dependent updates:
856 $WikiNameRegexp = pcre_fix_posix_classes($WikiNameRegexp);
857 //if ($KeywordLinkRegexp) $KeywordLinkRegexp = pcre_fix_posix_classes($KeywordLinkRegexp);
858 if (!defined('CATEGORY_GROUP_PAGE'))
859 define('CATEGORY_GROUP_PAGE',_("CategoryGroup"));
860 if (!defined('WIKI_NAME'))
861 define('WIKI_NAME', _("An unnamed PhpWiki"));
862 if (!defined('HOME_PAGE'))
863 define('HOME_PAGE', _("HomePage"));
866 //////////////////////////////////////////////////////////////////
867 // Autodetect URL settings:
869 foreach (array('SERVER_NAME','SERVER_PORT') as $var) {
870 //FIXME: for CGI without _SERVER
871 if (!defined($var) and !empty($HTTP_SERVER_VARS[$var]))
872 // IPV6 fix by matt brown, #1546571
873 // An IPv6 address must be surrounded by square brackets to form a valid server name.
874 if ($var == 'SERVER_NAME' &&
875 strstr($HTTP_SERVER_VARS[$var], ':')) {
876 define($var, '[' . $HTTP_SERVER_VARS[$var] . ']');
878 define($var, $HTTP_SERVER_VARS[$var]);
881 if (!defined('SERVER_NAME')) define('SERVER_NAME', '127.0.0.1');
882 if (!defined('SERVER_PORT')) define('SERVER_PORT', 80);
883 if (!defined('SERVER_PROTOCOL')) {
884 if (empty($HTTP_SERVER_VARS['HTTPS']) || $HTTP_SERVER_VARS['HTTPS'] == 'off')
885 define('SERVER_PROTOCOL', 'http');
887 define('SERVER_PROTOCOL', 'https');
890 if (!defined('SCRIPT_NAME'))
891 define('SCRIPT_NAME', deduce_script_name());
893 if (!defined('USE_PATH_INFO')) {
895 define('USE_PATH_INFO', false);
898 * If SCRIPT_NAME does not look like php source file,
899 * or user cgi we assume that php is getting run by an
900 * action handler in /cgi-bin. In this case,
901 * I think there is no way to get Apache to pass
902 * useful PATH_INFO to the php script (PATH_INFO
903 * is used to the the php interpreter where the
906 switch (php_sapi_name()) {
908 case 'apache2handler':
909 define('USE_PATH_INFO', true);
912 case 'apache2filter':
913 define('USE_PATH_INFO', false);
916 define('USE_PATH_INFO', ereg('\.(php3?|cgi)$', SCRIPT_NAME));
923 && SERVER_PORT != (SERVER_PROTOCOL == 'https' ? 443 : 80)) {
925 SERVER_PROTOCOL . '://' . SERVER_NAME . ':' . SERVER_PORT);
929 SERVER_PROTOCOL . '://' . SERVER_NAME);
932 if (!defined('VIRTUAL_PATH')) {
933 // We'd like to auto-detect when the cases where apaches
934 // 'Action' directive (or similar means) is used to
935 // redirect page requests to a cgi-handler.
937 // In cases like this, requests for e.g. /wiki/HomePage
938 // get redirected to a cgi-script called, say,
939 // /path/to/wiki/index.php. The script gets all
940 // of /wiki/HomePage as it's PATH_INFO.
943 // How to detect when this has happened reliably?
944 // How to pick out the "virtual path" (in this case '/wiki')?
946 // (Another time an redirect might occur is to a DirectoryIndex
947 // -- the requested URI is '/wikidir/', the request gets
948 // passed to '/wikidir/index.php'. In this case, the
949 // proper VIRTUAL_PATH is '/wikidir/index.php', since the
950 // pages will appear at e.g. '/wikidir/index.php/HomePage'.
953 $REDIRECT_URL = &$HTTP_SERVER_VARS['REDIRECT_URL'];
954 if (USE_PATH_INFO and isset($REDIRECT_URL)
955 and ! IsProbablyRedirectToIndex()) {
956 // FIXME: This is a hack, and won't work if the requested
957 // pagename has a slash in it.
958 $temp = strtr(dirname($REDIRECT_URL . 'x'),"\\",'/');
959 if ( ($temp == '/') || ($temp == '\\') )
961 define('VIRTUAL_PATH', $temp);
963 define('VIRTUAL_PATH', SCRIPT_NAME);
967 if (VIRTUAL_PATH != SCRIPT_NAME) {
968 // Apache action handlers are used.
969 define('PATH_INFO_PREFIX', VIRTUAL_PATH . '/');
972 define('PATH_INFO_PREFIX', '/');
974 define('PHPWIKI_BASE_URL',
975 SERVER_URL . (USE_PATH_INFO ? VIRTUAL_PATH . '/' : SCRIPT_NAME));
977 // Detect PrettyWiki setup (not loading index.php directly)
978 // $SCRIPT_FILENAME should be the same as __FILE__ in index.php
979 if (!isset($SCRIPT_FILENAME))
980 $SCRIPT_FILENAME = @$HTTP_SERVER_VARS['SCRIPT_FILENAME'];
981 if (!isset($SCRIPT_FILENAME))
982 $SCRIPT_FILENAME = @$HTTP_ENV_VARS['SCRIPT_FILENAME'];
983 if (!isset($SCRIPT_FILENAME))
984 $SCRIPT_FILENAME = dirname(__FILE__.'/../') . '/index.php';
986 $SCRIPT_FILENAME = str_replace('\\\\','\\',strtr($SCRIPT_FILENAME, '/', '\\'));
987 define('SCRIPT_FILENAME', $SCRIPT_FILENAME);
989 // Get remote host name, if apache hasn't done it for us
990 if (empty($HTTP_SERVER_VARS['REMOTE_HOST'])
991 and !empty($HTTP_SERVER_VARS['REMOTE_ADDR'])
992 and ENABLE_REVERSE_DNS)
993 $HTTP_SERVER_VARS['REMOTE_HOST'] = gethostbyaddr($HTTP_SERVER_VARS['REMOTE_ADDR']);
997 // (c-file-style: "gnu")
1001 // c-basic-offset: 4
1002 // c-hanging-comment-ender-p: nil
1003 // indent-tabs-mode: nil