2 rcs_id('$Id: IniConfig.php,v 1.9 2004-04-26 12:15:01 rurban Exp $');
5 * A configurator intended to read it's config from a PHP-style INI file,
6 * instead of a PHP file.
8 * Pass a filename to the IniConfig() function and it will read all it's
9 * definitions from there, all by itself, and proceed to do a mass-define
10 * of all valid PHPWiki config items. In this way, we can hopefully be
11 * totally backwards-compatible with the old index.php method, while still
12 * providing a much tastier on-going experience.
14 * @author: Joby Walker, Reini Urban, Matthew Palmer
17 * Copyright 2004 $ThePhpWikiProgrammingTeam
19 * This file is part of PhpWiki.
21 * PhpWiki is free software; you can redistribute it and/or modify
22 * it under the terms of the GNU General Public License as published by
23 * the Free Software Foundation; either version 2 of the License, or
24 * (at your option) any later version.
26 * PhpWiki is distributed in the hope that it will be useful,
27 * but WITHOUT ANY WARRANTY; without even the implied warranty of
28 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
29 * GNU General Public License for more details.
31 * You should have received a copy of the GNU General Public License
32 * along with PhpWiki; if not, write to the Free Software
33 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
37 * - Convert the value lists to provide defaults, so that every "if
38 * (defined())" and "if (!defined())" can fuck off to the dismal hole
41 * - Resurrect the larger "config object" code (in config/) so it'll aid the
42 * GUI config writers, and allow us to do proper validation and default
45 * - Get rid of WikiNameRegexp and KeywordLinkRegexp as globals by finding
46 * everywhere that uses them as variables and modify the code to use
47 * them as constants. Will involve hacking around
48 * pcre_fix_posix_classes (probably with redefines()).
51 include_once (dirname(__FILE__)."/config.php");
52 include_once (dirname(__FILE__)."/FileFinder.php");
54 function IniConfig($file) {
56 //FindFile("pear/Config.php");
57 //require_once("Config.php");
59 // List of all valid config options to be define()d which take "values" (not
60 // booleans). Needs to be categorised, and generally made a lot tidier.
61 $_IC_VALID_VALUE = array
62 ('DEBUG', 'WIKI_NAME', 'ADMIN_USER', 'ADMIN_PASSWD',
63 'HTML_DUMP_SUFFIX', 'MAX_UPLOAD_SIZE', 'MINOR_EDIT_TIMEOUT',
64 'ACCESS_LOG', 'CACHE_CONTROL', 'CACHE_CONTROL_MAX_AGE',
65 'PASSWORD_LENGTH_MINIMUM', 'USER_AUTH_POLICY', 'LDAP_AUTH_HOST',
66 'LDAP_BASE_DN', 'LDAP_AUTH_USER', 'LDAP_AUTH_PASSWORD',
67 'LDAP_SEARCH_FIELD', 'IMAP_AUTH_HOST', 'POP3_AUTH_HOST',
68 'AUTH_USER_FILE', 'AUTH_SESS_USER', 'AUTH_SESS_LEVEL', 'GROUP_METHOD',
69 'AUTH_GROUP_FILE', 'EDITING_POLICY', 'THEME', 'CHARSET',
70 'DEFAULT_LANGUAGE', 'WIKI_PGSRC', 'DEFAULT_WIKI_PGSRC',
71 'ALLOWED_PROTOCOLS', 'INLINE_IMAGES', 'SUBPAGE_SEPARATOR',
72 'INTERWIKI_MAP_FILE', 'COPYRIGHTPAGE_TITLE', 'COPYRIGHTPAGE_URL',
73 'AUTHORPAGE_TITLE', 'AUTHORPAGE_URL', 'SERVER_NAME', 'SERVER_PORT',
74 'SCRIPT_NAME', 'DATA_PATH', 'PHPWIKI_DIR', 'VIRTUAL_PATH');
76 // List of all valid config options to be define()d which take booleans.
77 $_IC_VALID_BOOL = array
78 ('ENABLE_USER_NEW', 'ENABLE_EDIT_TOOLBAR', 'JS_SEARCHREPLACE',
79 'ENABLE_REVERSE_DNS', 'ENCRYPTED_PASSWD', 'ZIPDUMP_AUTH',
80 'ENABLE_RAW_HTML', 'STRICT_MAILABLE_PAGEDUMPS', 'COMPRESS_OUTPUT',
81 'WIKIDB_NOCACHE_MARKUP', 'ALLOW_ANON_USER', 'ALLOW_ANON_EDIT',
82 'ALLOW_BOGO_LOGIN', 'ALLOW_USER_PASSWORDS',
83 'AUTH_USER_FILE_STORABLE', 'ALLOW_HTTP_AUTH_LOGIN',
84 'ALLOW_USER_LOGIN', 'ALLOW_LDAP_LOGIN', 'ALLOW_IMAP_LOGIN',
85 'WARN_NONPUBLIC_INTERWIKIMAP', 'USE_PATH_INFO',
86 'DISABLE_HTTP_REDIRECT');
88 if(!file_exists($file)){
89 trigger_error("Datasource file '$file' does not exist", E_USER_ERROR);
93 $rs = @parse_ini_file($file);
94 $rsdef = @parse_ini_file(dirname(__FILE__)."/../config/config-default.ini");
96 foreach ($_IC_VALID_VALUE as $item) {
97 if (defined($item)) continue;
98 if (array_key_exists($item, $rs)) {
99 define($item, $rs[$item]);
100 } elseif (array_key_exists($item, $rsdef)) {
101 define($item, $rsdef[$item]);
102 } elseif (in_array($item,array('SERVER_NAME', 'SERVER_PORT',
103 'SCRIPT_NAME', 'DATA_PATH', 'PHPWIKI_DIR', 'VIRTUAL_PATH'))) {
106 trigger_error(sprintf("missing config setting for %s",$item));
110 // Boolean options are slightly special - if they're set to any of
111 // 'false', '0', or 'no' (all case-insensitive) then the value will
112 // be a boolean false, otherwise if there is anything set it'll
114 foreach ($_IC_VALID_BOOL as $item) {
115 if (defined($item)) continue;
116 if (array_key_exists($item, $rs)) {
118 } elseif (array_key_exists($item, $rsdef)) {
119 $val = $rsdef[$item];
121 ; //trigger_error(sprintf("missing boolean config setting for %s",$item));
123 if (!$val and !defined($item)) {
124 define($item, false);
126 else if (strtolower($val) == 'false' ||
127 strtolower($val) == 'no' ||
130 define($item, false);
138 // Special handling for some config options
139 if ($val = @$rs['INCLUDE_PATH']) {
140 ini_set('include_path', $val);
143 if ($val = @$rs['SESSION_SAVE_PATH']) {
144 ini_set('session.save_path', $val);
149 $DBParams['dbtype'] = @$rs['DATABASE_TYPE'];
150 $DBParams['prefix'] = @$rs['DATABASE_PREFIX'];
151 $DBParams['dsn'] = @$rs['DATABASE_DSN'];
152 $DBParams['db_session_table'] = @$rs['DATABASE_SESSION_TABLE'];
153 $DBParams['dba_handler'] = @$rs['DATABASE_DBA_HANDLER'];
154 $DBParams['directory'] = @$rs['DATABASE_DIRECTORY'];
155 $DBParams['timeout'] = @$rs['DATABASE_TIMEOUT'];
156 if (!defined('USE_DB_SESSION') and $DBParams['db_session_table']) {
157 define('USE_DB_SESSION', true);
161 global $ExpiryParams;
163 $ExpiryParams['major'] = array(
164 'max_age' => @$rs['MAJOR_MAX_AGE'],
165 'min_age' => @$rs['MAJOR_MIN_AGE'],
166 'min_keep' => @$rs['MAJOR_MIN_KEEP'],
167 'keep' => @$rs['MAJOR_KEEP'],
168 'max_keep' => @$rs['MAJOR_MAX_KEEP']
171 $ExpiryParams['minor'] = array(
172 'max_age' => @$rs['MINOR_MAX_AGE'],
173 'min_age' => @$rs['MINOR_MIN_AGE'],
174 'min_keep' => @$rs['MINOR_MIN_KEEP'],
175 'keep' => @$rs['MINOR_KEEP'],
176 'max_keep' => @$rs['MINOR_MAX_KEEP']
179 $ExpiryParams['author'] = array(
180 'max_age' => @$rs['AUTHOR_MAX_AGE'],
181 'min_age' => @$rs['AUTHOR_MIN_AGE'],
182 'min_keep' => @$rs['AUTHOR_MIN_KEEP'],
183 'keep' => @$rs['AUTHOR_KEEP'],
184 'max_keep' => @$rs['AUTHOR_MAX_KEEP']
187 // User authentication
188 global $USER_AUTH_ORDER;
189 $USER_AUTH_ORDER = preg_split('/\s*:\s*/', @$rs['USER_AUTH_ORDER']);
192 global $LDAP_SET_OPTION;
193 $optlist = preg_split('/\s*:\s*/', @$rs['LDAP_SET_OPTION']);
194 foreach ($optlist as $opt) {
195 $bits = preg_split('/\s*=\s*/', $opt, 2);
196 if (count($bits) == 2) {
197 $LDAP_SET_OPTION[$bits[0]] = $bits[1];
200 // Possibly throw some sort of error?
204 // Now it's the external DB authentication stuff's turn
205 if (in_array('Db', $USER_AUTH_ORDER) && empty($rs['DBAUTH_AUTH_DSN'])) {
206 $rs['DBAUTH_AUTH_DSN'] = $DBParams['dsn'];
209 global $DBAuthParams;
210 $DBAP_MAP = array('DBAUTH_AUTH_DSN' => 'auth_dsn',
211 'DBAUTH_AUTH_CHECK' => 'auth_check',
212 'DBAUTH_AUTH_USER_EXISTS' => 'auth_user_exists',
213 'DBAUTH_AUTH_CRYPT_METHOD' => 'auth_crypt_method',
214 'DBAUTH_AUTH_UPDATE' => 'auth_update',
215 'DBAUTH_AUTH_CREATE' => 'auth_create',
216 'DBAUTH_PREF_SELECT' => 'pref_select',
217 'DBAUTH_PREF_UPDATE' => 'pref_update',
218 'DBAUTH_IS_MEMBER' => 'is_member',
219 'DBAUTH_GROUP_MEMBERS' => 'group_members',
220 'DBAUTH_USER_GROUPS' => 'user_groups'
223 foreach ($DBAP_MAP as $rskey => $apkey) {
224 if (isset($rs[$rskey])) {
225 $DBAuthParams[$apkey] = $rs[$rskey];
229 // Default Wiki pages
230 global $GenericPages;
231 if (!isset($rs['DEFAULT_WIKI_PAGES']))
232 $rs['DEFAULT_WIKI_PAGES'] = "ReleaseNotes:SteveWainstead:TestPage";
233 $GenericPages = preg_split('/\s*:\s*/', @$rs['DEFAULT_WIKI_PAGES']);
235 // Wiki name regexp. Should be a define(), but too many places want
236 // to use it as a variable for me to be bothered changing them all.
237 // Major TODO item, there.
238 global $WikiNameRegexp;
239 $WikiNameRegexp = @$rs['WIKI_NAME_REGEXP'];
241 // Another "too-tricky" redefine
242 global $KeywordLinkRegexp;
243 if (!isset($rs['KEYWORDS']))
244 $rs['KEYWORDS'] = "Category:Topic";
245 $keywords = preg_split('/\s*:\s*/', $rs['KEYWORDS']);
246 $KeywordLinkRegexp = '(?<=' . implode('|^', $keywords) . ')[[:upper:]].*$';
248 global $DisabledActions;
249 $DisabledActions = preg_split('/\s*:\s*/', @$rs['DISABLED_ACTIONS']);
254 // moved from lib/config.php
255 function fix_configs() {
256 global $FieldSeparator, $charset, $WikiNameRegexp, $KeywordLinkRegexp;
257 global $DisabledActions, $HTTP_SERVER_VARS, $DBParams, $LANG;
259 // "\x80"-"\x9f" (and "\x00" - "\x1f") are non-printing control
260 // chars in iso-8859-*
261 // $FieldSeparator = "\263"; //this is a superscript 3 in ISO-8859-1.
262 // $FieldSeparator = "\xFF"; // this byte should never appear in utf-8
263 // FIXME: get rid of constant. pref is dynamic and language specific
265 if (isset($GLOBALS['LANG']) and in_array($GLOBALS['LANG'],array('ja','zh')))
267 if (strtolower($charset) == 'utf-8')
268 $FieldSeparator = "\xFF";
270 $FieldSeparator = "\x81";
272 if (!defined('DEFAULT_LANGUAGE'))
273 define('DEFAULT_LANGUAGE', 'en');
276 // Set up (possibly fake) gettext()
278 if (!function_exists ('bindtextdomain')) {
281 function gettext ($text) {
283 if (!empty ($locale[$text]))
284 return $locale[$text];
289 return gettext($text);
293 // Working around really weird gettext problems: (4.3.2, 4.3.6 win)
294 // bindtextdomain() returns the current domain path.
295 // 1. If the script is not index.php but something like "de", on a different path
296 // then bindtextdomain() fails, but after chdir to the correct path it will work okay.
297 // 2. But the weird error "Undefined variable: bindtextdomain" is generated then.
298 $bindtextdomain_path = FindFile("locale", false, true);
300 $bindtextdomain_path = str_replace("/","\\",$bindtextdomain_path);
301 $bindtextdomain_real = @bindtextdomain("phpwiki", $bindtextdomain);
302 if ($bindtextdomain_real != $bindtextdomain_path) {
303 // this will happen with virtual_paths. chdir and try again.
304 chdir($bindtextdomain_path);
305 $bindtextdomain_real = @bindtextdomain("phpwiki", $bindtextdomain);
307 textdomain("phpwiki");
308 if ($bindtextdomain_real != $bindtextdomain_path) { // change back
309 chdir($bindtextdomain_real . (isWindows() ? "\\.." : "/.."));
313 $WikiNameRegexp = pcre_fix_posix_classes($WikiNameRegexp);
314 $KeywordLinkRegexp = pcre_fix_posix_classes($KeywordLinkRegexp);
316 //////////////////////////////////////////////////////////////////
317 // Autodetect URL settings:
319 if (!defined('SERVER_NAME')) define('SERVER_NAME', $HTTP_SERVER_VARS['SERVER_NAME']);
320 if (!defined('SERVER_PORT')) define('SERVER_PORT', $HTTP_SERVER_VARS['SERVER_PORT']);
321 if (!defined('SERVER_PROTOCOL')) {
322 if (empty($HTTP_SERVER_VARS['HTTPS']) || $HTTP_SERVER_VARS['HTTPS'] == 'off')
323 define('SERVER_PROTOCOL', 'http');
325 define('SERVER_PROTOCOL', 'https');
328 if (!defined('SCRIPT_NAME'))
329 define('SCRIPT_NAME', deduce_script_name());
331 if (!defined('USE_PATH_INFO')) {
333 * If SCRIPT_NAME does not look like php source file,
334 * or user cgi we assume that php is getting run by an
335 * action handler in /cgi-bin. In this case,
336 * I think there is no way to get Apache to pass
337 * useful PATH_INFO to the php script (PATH_INFO
338 * is used to the the php interpreter where the
341 switch (php_sapi_name()) {
343 case 'apache2handler':
344 define('USE_PATH_INFO', true);
347 case 'apache2filter':
348 define('USE_PATH_INFO', false);
351 define('USE_PATH_INFO', ereg('\.(php3?|cgi)$', SCRIPT_NAME));
356 // If user has not defined DATA_PATH, we want to use relative URLs.
357 if (!defined('DATA_PATH') && USE_PATH_INFO)
358 define('DATA_PATH', '..');
360 // If user has not defined PHPWIKI_DIR, and we need it
361 if (!defined('PHPWIKI_DIR') and !file_exists("themes/default")) {
362 $themes_dir = FindFile("themes");
363 define('PHPWIKI_DIR', dirname($themes_dir));
366 if (!defined('VIRTUAL_PATH')) {
367 // We'd like to auto-detect when the cases where apaches
368 // 'Action' directive (or similar means) is used to
369 // redirect page requests to a cgi-handler.
371 // In cases like this, requests for e.g. /wiki/HomePage
372 // get redirected to a cgi-script called, say,
373 // /path/to/wiki/index.php. The script gets all
374 // of /wiki/HomePage as it's PATH_INFO.
377 // How to detect when this has happened reliably?
378 // How to pick out the "virtual path" (in this case '/wiki')?
380 // (Another time an redirect might occur is to a DirectoryIndex
381 // -- the requested URI is '/wikidir/', the request gets
382 // passed to '/wikidir/index.php'. In this case, the
383 // proper VIRTUAL_PATH is '/wikidir/index.php', since the
384 // pages will appear at e.g. '/wikidir/index.php/HomePage'.
387 $REDIRECT_URL = &$HTTP_SERVER_VARS['REDIRECT_URL'];
388 if (USE_PATH_INFO and isset($REDIRECT_URL)
389 and ! IsProbablyRedirectToIndex()) {
390 // FIXME: This is a hack, and won't work if the requested
391 // pagename has a slash in it.
392 define('VIRTUAL_PATH', dirname($REDIRECT_URL . 'x'));
394 define('VIRTUAL_PATH', SCRIPT_NAME);
399 && SERVER_PORT != (SERVER_PROTOCOL == 'https' ? 443 : 80)) {
401 SERVER_PROTOCOL . '://' . SERVER_NAME . ':' . SERVER_PORT);
405 SERVER_PROTOCOL . '://' . SERVER_NAME);
408 if (VIRTUAL_PATH != SCRIPT_NAME) {
409 // Apache action handlers are used.
410 define('PATH_INFO_PREFIX', VIRTUAL_PATH . '/');
413 define('PATH_INFO_PREFIX', '/');
416 define('PHPWIKI_BASE_URL',
417 SERVER_URL . (USE_PATH_INFO ? VIRTUAL_PATH . '/' : SCRIPT_NAME));
419 //////////////////////////////////////////////////////////////////
422 if (empty($DBParams['dbtype']))
423 $DBParams['dbtype'] = 'dba';
425 if (!defined('THEME'))
426 define('THEME', 'default');
428 update_locale(isset($LANG) ? $LANG : DEFAULT_LANGUAGE);
430 if (!defined('WIKI_NAME'))
431 define('WIKI_NAME', _("An unnamed PhpWiki"));
433 if (!defined('HOME_PAGE'))
434 define('HOME_PAGE', _("HomePage"));
438 if (!defined('ACCESS_LOG'))
439 define('ACCESS_LOG', '');
442 // Get remote host name, if apache hasn't done it for us
443 if (empty($HTTP_SERVER_VARS['REMOTE_HOST']) && ENABLE_REVERSE_DNS)
444 $HTTP_SERVER_VARS['REMOTE_HOST'] = gethostbyaddr($HTTP_SERVER_VARS['REMOTE_ADDR']);
446 // check whether the crypt() function is needed and present
447 if (defined('ENCRYPTED_PASSWD') && !function_exists('crypt')) {
448 $error = sprintf(_("Encrypted passwords cannot be used: %s."),
449 "'function crypt()' not available in this version of php");
450 trigger_error($error);
453 if (!defined('ADMIN_PASSWD') or ADMIN_PASSWD == '')
454 trigger_error(_("The admin password cannot be empty. Please update your /index.php"));
456 if (defined('USE_DB_SESSION') and USE_DB_SESSION) {
457 if (! $DBParams['db_session_table'] ) {
458 trigger_error(_("Empty db_session_table. Turn USE_DB_SESSION off or define the table name."),
460 // this is flawed. constants cannot be changed.
461 define('USE_DB_SESSION',false);
464 // default: true (since v1.3.8)
465 if (!defined('USE_DB_SESSION'))
466 define('USE_DB_SESSION',true);
469 if (!defined('ENABLE_USER_NEW')) define('ENABLE_USER_NEW',true);
470 if (!defined('ALLOW_USER_LOGIN'))
471 define('ALLOW_USER_LOGIN', defined('ALLOW_USER_PASSWORDS') && ALLOW_USER_PASSWORDS);
472 if (!defined('ALLOW_ANON_USER')) define('ALLOW_ANON_USER', true);
473 if (!defined('ALLOW_ANON_EDIT')) define('ALLOW_ANON_EDIT', false);
474 if (!defined('REQUIRE_SIGNIN_BEFORE_EDIT')) define('REQUIRE_SIGNIN_BEFORE_EDIT', ! ALLOW_ANON_EDIT);
475 if (!defined('ALLOW_BOGO_LOGIN')) define('ALLOW_BOGO_LOGIN', true);
477 if (ALLOW_USER_LOGIN and !empty($DBAuthParams) and empty($DBAuthParams['auth_dsn'])) {
478 if (isset($DBParams['dsn']))
479 $DBAuthParams['auth_dsn'] = $DBParams['dsn'];
484 // $Log: not supported by cvs2svn $
485 // Revision 1.8 2004/04/23 16:55:59 zorloc
486 // If using Db auth and DBAUTH_AUTH_DSN is empty set DBAUTH_AUTH_DSN to $DBParams['dsn']
488 // Revision 1.7 2004/04/20 22:26:27 zorloc
489 // Removed Pear_Config for parse_ini_file().
491 // Revision 1.6 2004/04/20 18:10:27 rurban
492 // config refactoring:
493 // FileFinder is needed for WikiFarm scripts calling index.php
494 // config run-time calls moved to lib/IniConfig.php:fix_configs()
495 // added PHPWIKI_DIR smart-detection code (Theme finder)
496 // moved FileFind to lib/FileFinder.php
497 // cleaned lib/config.php
499 // Revision 1.5 2004/04/20 17:21:57 rurban
500 // WikiFarm code: honor predefined constants
502 // Revision 1.4 2004/04/20 17:08:19 rurban
503 // Some IniConfig fixes: prepend our private lib/pear dir
504 // switch from " to ' in the auth statements
505 // use error handling.
506 // WikiUserNew changes for the new "'$variable'" syntax
508 // TODO: optimization to put config vars into the session.
511 // (c-file-style: "gnu")
516 // c-hanging-comment-ender-p: nil
517 // indent-tabs-mode: nil