lib/IniConfig.php

   1 <?php
   2 rcs_id('$Id: IniConfig.php,v 1.59 2004-11-05 20:53:35 rurban Exp $');
   3
   4 /**
   5  * A configurator intended to read it's config from a PHP-style INI file,
   6  * instead of a PHP file.
   7  *
   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.
  13  *
  14  * @author: Joby Walker, Reini Urban, Matthew Palmer
  15  */
  16 /*
  17  * Copyright 2004 $ThePhpWikiProgrammingTeam
  18  *
  19  * This file is part of PhpWiki.
  20  *
  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.
  25  *
  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.
  30  *
  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
  34  */
  35
  36 /**
  37  * DONE:
  38  * - Convert the value lists to provide defaults, so that every "if
  39  *      (defined())" and "if (!defined())" can fuck off to the dismal hole
  40  *      it belongs in.
  41  * TODO:
  42  * - Old-style index.php => config/config.ini converter.
  43  *
  44  * - config.ini => config.php dumper for faster startup.
  45  *
  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)
  52  *
  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
  55  *   value handling.
  56  *
  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()).
  61  */
  62
  63 include_once (dirname(__FILE__)."/config.php");
  64 include_once (dirname(__FILE__)."/FileFinder.php");
  65
  66 function IniConfig($file) {
  67
  68     // List of all valid config options to be define()d which take "values" (not
  69     // booleans). Needs to be categorised, and generally made a lot tidier.
  70     $_IC_VALID_VALUE = array
  71         ('WIKI_NAME', 'ADMIN_USER', 'ADMIN_PASSWD',
  72          'DEFAULT_DUMP_DIR', 'HTML_DUMP_DIR',
  73          'HTML_DUMP_SUFFIX', 'MAX_UPLOAD_SIZE', 'MINOR_EDIT_TIMEOUT',
  74          'ACCESS_LOG', 'CACHE_CONTROL', 'CACHE_CONTROL_MAX_AGE',
  75          'COOKIE_EXPIRATION_DAYS', 'COOKIE_DOMAIN',
  76          'PASSWORD_LENGTH_MINIMUM', 'USER_AUTH_POLICY',
  77          'GROUP_METHOD',
  78          'EDITING_POLICY', 'THEME', 'CHARSET',
  79          'DEFAULT_LANGUAGE', 'WIKI_PGSRC', 'DEFAULT_WIKI_PGSRC',
  80          'ALLOWED_PROTOCOLS', 'INLINE_IMAGES', 'SUBPAGE_SEPARATOR',
  81          'DATABASE_PREFIX', 'DATABASE_DSN', 'DATABASE_TYPE',
  82          'INTERWIKI_MAP_FILE', 'COPYRIGHTPAGE_TITLE', 'COPYRIGHTPAGE_URL',
  83          'AUTHORPAGE_TITLE', 'AUTHORPAGE_URL', 'SERVER_NAME', 'SERVER_PORT',
  84          'SCRIPT_NAME', 'DATA_PATH', 'PHPWIKI_DIR', 'VIRTUAL_PATH',
  85          'WIKI_NAME_REGEXP',
  86          'PLUGIN_CACHED_DATABASE', 'PLUGIN_CACHED_FILENAME_PREFIX',
  87          'PLUGIN_CACHED_HIGHWATER', 'PLUGIN_CACHED_LOWWATER', 'PLUGIN_CACHED_MAXLIFETIME',
  88          'PLUGIN_CACHED_MAXARGLEN', 'PLUGIN_CACHED_IMGTYPES'
  89          );
  90
  91     // Optional values which need to be defined.
  92     // These are not defined in config-default.ini and empty if not defined.
  93     $_IC_OPTIONAL_VALUE = array
  94         (
  95          'DEBUG', 'TEMP_DIR',
  96          'LDAP_AUTH_HOST','LDAP_SET_OPTION','LDAP_BASE_DN', 'LDAP_AUTH_USER',
  97          'LDAP_AUTH_PASSWORD','LDAP_SEARCH_FIELD','LDAP_OU_GROUP','LDAP_OU_USERS',
  98          'AUTH_USER_FILE','DBAUTH_AUTH_DSN',
  99          'IMAP_AUTH_HOST', 'POP3_AUTH_HOST',
 100          'AUTH_USER_FILE', 'AUTH_GROUP_FILE', 'AUTH_SESS_USER', 'AUTH_SESS_LEVEL',
 101          'GOOGLE_LICENSE_KEY','FORTUNE_DIR',
 102          'DISABLE_GETIMAGESIZE','DBADMIN_USER','DBADMIN_PASSWD'
 103          );
 104
 105     // List of all valid config options to be define()d which take booleans.
 106     $_IC_VALID_BOOL = array
 107         ('ENABLE_USER_NEW', 'ENABLE_PAGEPERM', 'ENABLE_EDIT_TOOLBAR', 'JS_SEARCHREPLACE',
 108          'ENABLE_REVERSE_DNS', 'ENCRYPTED_PASSWD', 'ZIPDUMP_AUTH',
 109          'ENABLE_RAW_HTML', 'ENABLE_RAW_HTML_LOCKEDONLY', 'ENABLE_RAW_HTML_SAFE',
 110          'STRICT_MAILABLE_PAGEDUMPS', 'COMPRESS_OUTPUT',
 111          'WIKIDB_NOCACHE_MARKUP', 'ALLOW_ANON_USER', 'ALLOW_ANON_EDIT',
 112          'ALLOW_BOGO_LOGIN', 'ALLOW_USER_PASSWORDS',
 113          'AUTH_USER_FILE_STORABLE', 'ALLOW_HTTP_AUTH_LOGIN',
 114          'ALLOW_USER_LOGIN', 'ALLOW_LDAP_LOGIN', 'ALLOW_IMAP_LOGIN',
 115          'WARN_NONPUBLIC_INTERWIKIMAP', 'USE_PATH_INFO',
 116          'DISABLE_HTTP_REDIRECT',
 117          'PLUGIN_CACHED_USECACHE', 'PLUGIN_CACHED_FORCE_SYNCMAP',
 118          'ENABLE_XHTML_XML', 'ENABLE_DOUBLECLICKEDIT'
 119          );
 120
 121     if(!file_exists($file)){
 122         trigger_error("Datasource file '$file' does not exist", E_USER_ERROR);
 123         exit();
 124     }
 125
 126     $rs = @parse_ini_file($file);
 127     $rsdef = @parse_ini_file(dirname(__FILE__)."/../config/config-default.ini");
 128     foreach ($rsdef as $k => $v) {
 129         if (defined($k)) {
 130             $rs[$k] = constant($k);
 131         } elseif (!isset($rs[$k])) {
 132             $rs[$k] = $v;
 133         }
 134     }
 135
 136     foreach ($_IC_VALID_VALUE as $item) {
 137         if (defined($item)) {
 138             unset($rs[$item]);
 139             continue;
 140         }
 141         if (array_key_exists($item, $rs)) {
 142             define($item, $rs[$item]);
 143             unset($rs[$item]);
 144         //} elseif (array_key_exists($item, $rsdef)) {
 145         //    define($item, $rsdef[$item]);
 146         // calculate them later or not at all:
 147         } elseif (in_array($item,
 148                            array('DATABASE_PREFIX', 'SERVER_NAME', 'SERVER_PORT',
 149                                  'SCRIPT_NAME', 'DATA_PATH', 'PHPWIKI_DIR', 'VIRTUAL_PATH',
 150                                  'LDAP_AUTH_HOST','IMAP_AUTH_HOST','POP3_AUTH_HOST',
 151                                  'PLUGIN_CACHED_CACHE_DIR')))
 152         {
 153             ;
 154         } else {
 155             trigger_error(sprintf("missing config setting for %s",$item));
 156         }
 157     }
 158
 159     // Boolean options are slightly special - if they're set to any of
 160     // '', 'false', '0', or 'no' (all case-insensitive) then the value will
 161     // be a boolean false, otherwise if there is anything set it'll
 162     // be true.
 163     foreach ($_IC_VALID_BOOL as $item) {
 164         if (defined($item)) {
 165             unset($rs[$item]);
 166             continue;
 167         }
 168         if (array_key_exists($item, $rs)) {
 169             $val = $rs[$item];
 170         //} elseif (array_key_exists($item, $rsdef)) {
 171         //    $val = $rsdef[$item];
 172         } else {
 173             $val = false; //trigger_error(sprintf("missing boolean config setting for %s",$item));
 174         }
 175
 176         // calculate them later: old or dynamic constants
 177         if (!array_key_exists($item, $rs) and
 178             in_array($item,array('USE_PATH_INFO', 'USE_DB_SESSION',
 179                                  'ALLOW_HTTP_AUTH_LOGIN', 'ALLOW_LDAP_LOGIN',
 180                                  'ALLOW_IMAP_LOGIN', 'ALLOW_USER_LOGIN',
 181                                  'REQUIRE_SIGNIN_BEFORE_EDIT',
 182                                  'WIKIDB_NOCACHE_MARKUP')))
 183         {
 184             ;
 185         }
 186         elseif (!$val) {
 187             define($item, false);
 188         }
 189         elseif (strtolower($val) == 'false' ||
 190                 strtolower($val) == 'no' ||
 191                 $val == '' ||
 192                 $val == false ||
 193                 $val == '0') {
 194             define($item, false);
 195         }
 196         else {
 197             define($item, true);
 198         }
 199         unset($rs[$item]);
 200     }
 201
 202     // Special handling for some config options
 203     if (!empty($rs['INCLUDE_PATH'])) {
 204         ini_set('include_path', $rs['INCLUDE_PATH']);
 205     }
 206     if (!empty($rs['SESSION_SAVE_PATH'])) {
 207         ini_set('session.save_path', $rs['SESSION_SAVE_PATH']);
 208     }
 209
 210     // Database
 211     global $DBParams;
 212     $DBParams['dbtype'] = DATABASE_TYPE;
 213     $DBParams['dsn'] = DATABASE_DSN;
 214     if (defined('DATABASE_PREFIX'))
 215         $DBParams['prefix'] = DATABASE_PREFIX;
 216     elseif (isset($rs['DATABASE_PREFIX']))
 217         $DBParams['prefix'] = $rs['DATABASE_PREFIX'];
 218     $DBParams['db_session_table'] = @$rs['DATABASE_SESSION_TABLE'];
 219     $DBParams['dba_handler'] = @$rs['DATABASE_DBA_HANDLER'];
 220     $DBParams['directory'] = @$rs['DATABASE_DIRECTORY'];
 221     $DBParams['timeout'] = @$rs['DATABASE_TIMEOUT'];
 222     foreach (array('DATABASE_TYPE','DATABASE_DSN','DATABASE_SESSION_TABLE','DATABASE_DBA_HANDLER',
 223                    'DATABASE_DIRECTORY','DATABASE_TIMEOUT','DATABASE_PREFIX') as $item) {
 224         unset($rs[$item]);
 225     }
 226     // USE_DB_SESSION default logic:
 227     if (!defined('USE_DB_SESSION')) {
 228         if ($DBParams['db_session_table']
 229             and in_array($DBParams['dbtype'], array('SQL','ADODB'/*,'dba'*/))) {
 230             define('USE_DB_SESSION', true);
 231         } else {
 232             define('USE_DB_SESSION', false);
 233         }
 234     }
 235
 236     // Expiry stuff
 237     global $ExpireParams;
 238     foreach (array('major','minor','author') as $major) {
 239         foreach (array('max_age','min_age','min_keep','keep','max_keep') as $max) {
 240             $item = strtoupper($major) . '_'. strtoupper($max);
 241             if (defined($item)) $val = constant($item);
 242             elseif (array_key_exists($item, $rs))
 243                 $val = $rs[$item];
 244             elseif (array_key_exists($item, $rsdef))
 245                 $val = $rsdef[$item];
 246             if (!isset($ExpireParams[$major]))
 247                 $ExpireParams[$major] = array();
 248             $ExpireParams[$major][$max] = $val;
 249             unset($rs[$item]);
 250         }
 251     }
 252
 253     // User authentication
 254     if (!isset($GLOBALS['USER_AUTH_ORDER']))
 255         if (isset($rs['USER_AUTH_ORDER']))
 256             $GLOBALS['USER_AUTH_ORDER'] = preg_split('/\s*:\s*/',
 257                                                      $rs['USER_AUTH_ORDER']);
 258         else
 259             $GLOBALS['USER_AUTH_ORDER'] = array("PersonalPage");
 260
 261     // Now it's the external DB authentication stuff's turn
 262     if (in_array('Db', $GLOBALS['USER_AUTH_ORDER']) && empty($rs['DBAUTH_AUTH_DSN'])) {
 263         $rs['DBAUTH_AUTH_DSN'] = $DBParams['dsn'];
 264     }
 265
 266     global $DBAuthParams;
 267     $DBAP_MAP = array('DBAUTH_AUTH_DSN' => 'auth_dsn',
 268                       'DBAUTH_AUTH_CHECK' => 'auth_check',
 269                       'DBAUTH_AUTH_USER_EXISTS' => 'auth_user_exists',
 270                       'DBAUTH_AUTH_CRYPT_METHOD' => 'auth_crypt_method',
 271                       'DBAUTH_AUTH_UPDATE' => 'auth_update',
 272                       'DBAUTH_AUTH_CREATE' => 'auth_create',
 273                       'DBAUTH_PREF_SELECT' => 'pref_select',
 274                       'DBAUTH_PREF_UPDATE' => 'pref_update',
 275                       'DBAUTH_IS_MEMBER' => 'is_member',
 276                       'DBAUTH_GROUP_MEMBERS' => 'group_members',
 277                       'DBAUTH_USER_GROUPS' => 'user_groups'
 278                       );
 279     foreach ($DBAP_MAP as $rskey => $apkey) {
 280         if (defined($rskey)) {
 281             $DBAuthParams[$apkey] = constant($rskey);
 282         } elseif (isset($rs[$rskey])) {
 283             $DBAuthParams[$apkey] = $rs[$rskey];
 284         } elseif (isset($rsdef[$rskey])) {
 285             $DBAuthParams[$apkey] = $rsdef[$rskey];
 286         }
 287         unset($rs[$rskey]);
 288     }
 289
 290     // optional values will be set to '' to simplify the logic.
 291     foreach ($_IC_OPTIONAL_VALUE as $item) {
 292         if (defined($item)) {
 293             unset($rs[$item]);
 294             continue;
 295         }
 296         if (array_key_exists($item, $rs)) {
 297             define($item, $rs[$item]);
 298             unset($rs[$item]);
 299         } else
 300             define($item, '');
 301     }
 302
 303     // LDAP bind options
 304     global $LDAP_SET_OPTION;
 305     if (defined('LDAP_SET_OPTION') and LDAP_SET_OPTION) {
 306         $optlist = preg_split('/\s*:\s*/', LDAP_SET_OPTION);
 307         foreach ($optlist as $opt) {
 308             $bits = preg_split('/\s*=\s*/', $opt, 2);
 309             if (count($bits) == 2) {
 310                 if (is_string($bits[0]) and defined($bits[0]))
 311                     $bits[0] = constant($bits[0]);
 312                 $LDAP_SET_OPTION[$bits[0]] = $bits[1];
 313             }
 314             else {
 315                 // Possibly throw some sort of error?
 316             }
 317         }
 318     }
 319
 320     // Default Wiki pages to force loading from pgsrc
 321     global $GenericPages;
 322     $GenericPages = preg_split('/\s*:\s*/', @$rs['DEFAULT_WIKI_PAGES']);
 323
 324     // Wiki name regexp:  Should be a define(), but might needed to be changed at runtime
 325     // (different LC_CHAR need different posix classes)
 326     global $WikiNameRegexp;
 327     $WikiNameRegexp = constant('WIKI_NAME_REGEXP');
 328     if (!trim($WikiNameRegexp))
 329        $WikiNameRegexp = '(?<![[:alnum:]])(?:[[:upper:]][[:lower:]]+){2,}(?![[:alnum:]])';
 330
 331     // Another "too-tricky" redefine
 332     global $KeywordLinkRegexp;
 333     if (!isset($rs['KEYWORDS'])) $rs['KEYWORDS'] = @$rsdef['KEYWORDS'];
 334     if (!isset($rs['KEYWORDS'])) $rs['KEYWORDS'] = "Category:Topic";
 335     $keywords = preg_split('/\s*:\s*/', $rs['KEYWORDS']);
 336     if (empty($keywords)) $keywords = array("Category","Topic");
 337     $KeywordLinkRegexp = '(?<=' . implode('|^', $keywords) . ')[[:upper:]].*$';
 338
 339     global $DisabledActions;
 340     if (!array_key_exists('DISABLED_ACTIONS',$rs) and array_key_exists('DISABLED_ACTIONS',$rsdef))
 341         $rs['DISABLED_ACTIONS'] = @$rsdef['DISABLED_ACTIONS'];
 342     if (array_key_exists('DISABLED_ACTIONS',$rs))
 343         $DisabledActions = preg_split('/\s*:\s*/', $rs['DISABLED_ACTIONS']);
 344
 345     /*global $AllowedProtocols, $InlineImages;
 346     $AllowedProtocols = constant("ALLOWED_PROTOCOLS");
 347     $InlineImages = constant("INLINE_IMAGES");*/
 348
 349     global $PLUGIN_CACHED_IMGTYPES;
 350     $PLUGIN_CACHED_IMGTYPES = preg_split('/\s*[|:]\s*/', PLUGIN_CACHED_IMGTYPES);
 351     if (empty($rs['PLUGIN_CACHED_CACHE_DIR']) and !empty($rsdef['PLUGIN_CACHED_CACHE_DIR']))
 352         $rs['PLUGIN_CACHED_CACHE_DIR'] = $rsdef['PLUGIN_CACHED_CACHE_DIR'];
 353     if (empty($rs['PLUGIN_CACHED_CACHE_DIR'])) {
 354         if (!FindFile('/tmp/cache', 1)) {
 355             if (!FindFile('/tmp', 1)) {
 356                 mkdir('/tmp', 777);
 357             }
 358             mkdir('/tmp/cache', 777);
 359         }
 360         // will throw an error if not exists.
 361         define('PLUGIN_CACHED_CACHE_DIR', FindFile('/tmp/cache',false,1));
 362     } else {
 363         define('PLUGIN_CACHED_CACHE_DIR', $rs['PLUGIN_CACHED_CACHE_DIR']);
 364         // will throw an error if not exists.
 365         FindFile(PLUGIN_CACHED_CACHE_DIR);
 366     }
 367
 368     // process the rest of the config.ini settings:
 369     foreach ($rs as $item => $value) {
 370         if (defined($item)) {
 371             continue;
 372         } else {
 373             define($item, $value);
 374         }
 375     }
 376
 377     unset($rs);
 378     unset($rsdef);
 379     fix_configs();
 380 }
 381
 382 // moved from lib/config.php
 383 function fix_configs() {
 384     global $FieldSeparator, $charset, $WikiNameRegexp, $KeywordLinkRegexp, $AllActionPages;
 385     global $HTTP_SERVER_VARS, $DBParams, $LANG;
 386
 387     // init FileFinder to add proper include paths
 388     require_once(dirname(__FILE__)."/FileFinder.php");
 389     FindFile("lib/interwiki.map",true);
 390
 391     // "\x80"-"\x9f" (and "\x00" - "\x1f") are non-printing control
 392     // chars in iso-8859-*
 393     // $FieldSeparator = "\263"; // this is a superscript 3 in ISO-8859-1.
 394     // $FieldSeparator = "\xFF"; // this byte should never appear in utf-8
 395     // FIXME: get rid of constant. pref is dynamic and language specific
 396     $charset = CHARSET;
 397     // Disabled: Let the admin decide which charset.
 398     //if (isset($LANG) and in_array($LANG,array('zh')))
 399     //    $charset = 'utf-8';
 400     if (strtolower($charset) == 'utf-8')
 401         $FieldSeparator = "\xFF";
 402     else
 403         $FieldSeparator = "\x81";
 404
 405     if (!defined('DEFAULT_LANGUAGE')) // not needed anymore
 406         define('DEFAULT_LANGUAGE', 'en');
 407     update_locale(isset($LANG) ? $LANG : DEFAULT_LANGUAGE);
 408
 409     // Set up (possibly fake) gettext()
 410     //
 411     if (!function_exists ('bindtextdomain')) {
 412         $locale = array();
 413
 414         function gettext ($text) {
 415             global $locale;
 416             if (!empty ($locale[$text]))
 417                 return $locale[$text];
 418             return $text;
 419         }
 420
 421         function _ ($text) {
 422             return gettext($text);
 423         }
 424     }
 425     else {
 426         // Working around really weird gettext problems: (4.3.2, 4.3.6 win)
 427         // bindtextdomain() returns the current domain path.
 428         // 1. If the script is not index.php but something like "de", on a different path
 429         //    then bindtextdomain() fails, but after chdir to the correct path it will work okay.
 430         // 2. But the weird error "Undefined variable: bindtextdomain" is generated then.
 431         $bindtextdomain_path = FindFile("locale", false, true);
 432         if (isWindows())
 433             $bindtextdomain_path = str_replace("/","\\",$bindtextdomain_path);
 434         $bindtextdomain_real = @bindtextdomain("phpwiki", $bindtextdomain);
 435         if ($bindtextdomain_real != $bindtextdomain_path) {
 436             // this will happen with virtual_paths. chdir and try again.
 437             chdir($bindtextdomain_path);
 438             $bindtextdomain_real = @bindtextdomain("phpwiki", $bindtextdomain);
 439         }
 440         textdomain("phpwiki");
 441         if ($bindtextdomain_real != $bindtextdomain_path) { // change back
 442             chdir($bindtextdomain_real . (isWindows() ? "\\.." : "/.."));
 443         }
 444     }
 445
 446     $WikiNameRegexp = pcre_fix_posix_classes($WikiNameRegexp);
 447     $KeywordLinkRegexp = pcre_fix_posix_classes($KeywordLinkRegexp);
 448
 449     $AllActionPages = explode(':',
 450                               'AllPages:BackLinks:CreatePage:DebugInfo:EditMetaData:FindPage:'
 451                               .'FullRecentChanges:FullTextSearch:FuzzyPages:InterWikiSearch:'
 452                               .'LikePages:MostPopular:'
 453                               .'OrphanedPages:PageDump:PageHistory:PageInfo:RandomPage:RateIt:'
 454                               .'RecentChanges:RecentEdits:RecentComments:RelatedChanges:TitleSearch:'
 455                               .'TranslateText:UpLoad:UserPreferences:WantedPages:WhoIsOnline:'
 456                               .'PhpWikiAdministration/Remove:PhpWikiAdministration/Chmod:'
 457                               .'PhpWikiAdministration/Rename:PhpWikiAdministration/Replace:'
 458                               .'PhpWikiAdministration/SetAcl:PhpWikiAdministration/Chown'
 459                               );
 460
 461     //////////////////////////////////////////////////////////////////
 462     // Autodetect URL settings:
 463     //
 464     foreach (array('SERVER_NAME','SERVER_PORT') as $var) {
 465         //FIXME: for CGI without _SERVER
 466         if (!defined($var) and !empty($HTTP_SERVER_VARS[$var]))
 467             define($var, $HTTP_SERVER_VARS[$var]);
 468     }
 469     if (!defined('SERVER_PROTOCOL')) {
 470         if (empty($HTTP_SERVER_VARS['HTTPS']) || $HTTP_SERVER_VARS['HTTPS'] == 'off')
 471             define('SERVER_PROTOCOL', 'http');
 472         else
 473             define('SERVER_PROTOCOL', 'https');
 474     }
 475
 476     if (!defined('SCRIPT_NAME'))
 477         define('SCRIPT_NAME', deduce_script_name());
 478
 479     if (!defined('USE_PATH_INFO')) {
 480         if (isCGI())
 481             define('USE_PATH_INFO', false);
 482         else {
 483             /*
 484              * If SCRIPT_NAME does not look like php source file,
 485              * or user cgi we assume that php is getting run by an
 486              * action handler in /cgi-bin.  In this case,
 487              * I think there is no way to get Apache to pass
 488              * useful PATH_INFO to the php script (PATH_INFO
 489              * is used to the the php interpreter where the
 490              * php script is...)
 491              */
 492             switch (php_sapi_name()) {
 493             case 'apache':
 494             case 'apache2handler':
 495                 define('USE_PATH_INFO', true);
 496                 break;
 497             case 'cgi':
 498             case 'apache2filter':
 499                 define('USE_PATH_INFO', false);
 500                 break;
 501             default:
 502                 define('USE_PATH_INFO', ereg('\.(php3?|cgi)$', SCRIPT_NAME));
 503                 break;
 504             }
 505         }
 506     }
 507
 508     // If user has not defined PHPWIKI_DIR, and we need it
 509     if (!defined('PHPWIKI_DIR') and !file_exists("themes/default")) {
 510         $themes_dir = FindFile("themes");
 511         define('PHPWIKI_DIR', dirname($themes_dir));
 512     }
 513
 514     if (!defined('VIRTUAL_PATH')) {
 515         // We'd like to auto-detect when the cases where apaches
 516         // 'Action' directive (or similar means) is used to
 517         // redirect page requests to a cgi-handler.
 518         //
 519         // In cases like this, requests for e.g. /wiki/HomePage
 520         // get redirected to a cgi-script called, say,
 521         // /path/to/wiki/index.php.  The script gets all
 522         // of /wiki/HomePage as it's PATH_INFO.
 523         //
 524         // The problem is:
 525         //   How to detect when this has happened reliably?
 526         //   How to pick out the "virtual path" (in this case '/wiki')?
 527         //
 528         // (Another time an redirect might occur is to a DirectoryIndex
 529         // -- the requested URI is '/wikidir/', the request gets
 530         // passed to '/wikidir/index.php'.  In this case, the
 531         // proper VIRTUAL_PATH is '/wikidir/index.php', since the
 532         // pages will appear at e.g. '/wikidir/index.php/HomePage'.
 533         //
 534
 535         $REDIRECT_URL = &$HTTP_SERVER_VARS['REDIRECT_URL'];
 536         if (USE_PATH_INFO and isset($REDIRECT_URL)
 537             and ! IsProbablyRedirectToIndex()) {
 538             // FIXME: This is a hack, and won't work if the requested
 539             // pagename has a slash in it.
 540             $temp = strtr(dirname($REDIRECT_URL . 'x'),"\\",'/');
 541             if ( ($temp == '/') || ($temp == '\\') )
 542                 $temp = '';
 543             define('VIRTUAL_PATH', $temp);
 544         } else {
 545             define('VIRTUAL_PATH', SCRIPT_NAME);
 546         }
 547     }
 548
 549     // If user has not defined DATA_PATH, we want to use relative URLs.
 550     if (!defined('DATA_PATH')) {
 551         // fix similar to the one suggested by jkalmbach for
 552         // installations in the webrootdir, like "http://phpwiki.org/HomePage"
 553         $temp = dirname(SCRIPT_NAME);
 554         if ( ($temp == '/') || ($temp == '\\') )
 555             $temp = '';
 556         define('DATA_PATH', $temp);
 557         /*
 558         if (USE_PATH_INFO)
 559             define('DATA_PATH', '..');
 560         */
 561     }
 562
 563     if (SERVER_PORT
 564         && SERVER_PORT != (SERVER_PROTOCOL == 'https' ? 443 : 80)) {
 565         define('SERVER_URL',
 566                SERVER_PROTOCOL . '://' . SERVER_NAME . ':' . SERVER_PORT);
 567     }
 568     else {
 569         define('SERVER_URL',
 570                SERVER_PROTOCOL . '://' . SERVER_NAME);
 571     }
 572
 573     if (VIRTUAL_PATH != SCRIPT_NAME) {
 574         // Apache action handlers are used.
 575         define('PATH_INFO_PREFIX', VIRTUAL_PATH . '/');
 576     }
 577     else
 578         define('PATH_INFO_PREFIX', '/');
 579
 580     define('PHPWIKI_BASE_URL',
 581            SERVER_URL . (USE_PATH_INFO ? VIRTUAL_PATH . '/' : SCRIPT_NAME));
 582
 583     // Detect PrettyWiki setup (not loading index.php directly)
 584     // $SCRIPT_FILENAME should be the same as __FILE__ in index.php
 585     if (!isset($SCRIPT_FILENAME))
 586         $SCRIPT_FILENAME = @$HTTP_SERVER_VARS['SCRIPT_FILENAME'];
 587     if (!isset($SCRIPT_FILENAME))
 588         $SCRIPT_FILENAME = @$HTTP_ENV_VARS['SCRIPT_FILENAME'];
 589     if (!isset($SCRIPT_FILENAME))
 590         $SCRIPT_FILENAME = dirname(__FILE__.'/../') . '/index.php';
 591     if (isWindows())
 592         $SCRIPT_FILENAME = strtr($SCRIPT_FILENAME, '/', '\\');
 593     define('SCRIPT_FILENAME', $SCRIPT_FILENAME);
 594
 595     //////////////////////////////////////////////////////////////////
 596     // Select database
 597     //
 598     if (empty($DBParams['dbtype']))
 599         $DBParams['dbtype'] = 'dba';
 600
 601     if (!defined('THEME'))
 602         define('THEME', 'default');
 603
 604     if (!defined('WIKI_NAME'))
 605         define('WIKI_NAME', _("An unnamed PhpWiki"));
 606
 607     if (!defined('HOME_PAGE'))
 608         define('HOME_PAGE', _("HomePage"));
 609
 610     // FIXME: delete
 611     // Access log
 612     if (!defined('ACCESS_LOG'))
 613         define('ACCESS_LOG', '');
 614
 615     // FIXME: delete
 616     // Get remote host name, if apache hasn't done it for us
 617     if (empty($HTTP_SERVER_VARS['REMOTE_HOST']) && ENABLE_REVERSE_DNS)
 618         $HTTP_SERVER_VARS['REMOTE_HOST'] = gethostbyaddr($HTTP_SERVER_VARS['REMOTE_ADDR']);
 619
 620     // check whether the crypt() function is needed and present
 621     if (defined('ENCRYPTED_PASSWD') && !function_exists('crypt')) {
 622         $error = sprintf(_("Encrypted passwords cannot be used: %s."),
 623                          "'function crypt()' not available in this version of php");
 624         trigger_error($error);
 625     }
 626
 627     if (!defined('ADMIN_PASSWD') or ADMIN_PASSWD == '')
 628         trigger_error(_("The admin password cannot be empty. Please update your config/config.ini"));
 629
 630     if (defined('USE_DB_SESSION') and USE_DB_SESSION) {
 631         if (! $DBParams['db_session_table'] ) {
 632             $DBParams['db_session_table'] = @$DBParams['prefix'] . 'session';
 633             trigger_error(sprintf(_("DATABASE_SESSION_TABLE configuration set to %s."),
 634                                   $DBParams['db_session_table']),
 635                           E_USER_ERROR);
 636         }
 637     }
 638     // legacy:
 639     if (!defined('ENABLE_USER_NEW')) define('ENABLE_USER_NEW',true);
 640     if (!defined('ALLOW_USER_LOGIN'))
 641         define('ALLOW_USER_LOGIN', defined('ALLOW_USER_PASSWORDS') && ALLOW_USER_PASSWORDS);
 642     if (!defined('ALLOW_ANON_USER')) define('ALLOW_ANON_USER', true);
 643     if (!defined('ALLOW_ANON_EDIT')) define('ALLOW_ANON_EDIT', false);
 644     if (!defined('REQUIRE_SIGNIN_BEFORE_EDIT')) define('REQUIRE_SIGNIN_BEFORE_EDIT', ! ALLOW_ANON_EDIT);
 645     if (!defined('ALLOW_BOGO_LOGIN')) define('ALLOW_BOGO_LOGIN', true);
 646     if (!ENABLE_USER_NEW) {
 647       if (!defined('ALLOW_HTTP_AUTH_LOGIN'))
 648           define('ALLOW_HTTP_AUTH_LOGIN', false);
 649       if (!defined('ALLOW_LDAP_LOGIN'))
 650           define('ALLOW_LDAP_LOGIN', function_exists('ldap_connect') and defined('LDAP_AUTH_HOST'));
 651       if (!defined('ALLOW_IMAP_LOGIN'))
 652           define('ALLOW_IMAP_LOGIN', function_exists('imap_open') and defined('IMAP_AUTH_HOST'));
 653     }
 654
 655     if (ALLOW_USER_LOGIN and !empty($DBAuthParams) and empty($DBAuthParams['auth_dsn'])) {
 656         if (isset($DBParams['dsn']))
 657             $DBAuthParams['auth_dsn'] = $DBParams['dsn'];
 658     }
 659 }
 660
 661 // $Log: not supported by cvs2svn $
 662 // Revision 1.58  2004/11/03 16:50:31  rurban
 663 // some new defaults and constants, renamed USE_DOUBLECLICKEDIT to ENABLE_DOUBLECLICKEDIT
 664 //
 665 // Revision 1.57  2004/11/01 10:43:55  rurban
 666 // seperate PassUser methods into seperate dir (memory usage)
 667 // fix WikiUser (old) overlarge data session
 668 // remove wikidb arg from various page class methods, use global ->_dbi instead
 669 // ...
 670 //
 671 // Revision 1.56  2004/10/21 20:20:53  rurban
 672 // From patch #970004 "Double clic to edit" by pixels.
 673 //
 674 // Revision 1.55  2004/10/14 19:23:58  rurban
 675 // remove debugging prints
 676 //
 677 // Revision 1.54  2004/10/14 17:13:01  rurban
 678 // use DATABASE_PREFIX
 679 //
 680 // Revision 1.53  2004/10/12 13:13:19  rurban
 681 // php5 compatibility (5.0.1 ok)
 682 //
 683 // Revision 1.52  2004/10/04 23:38:07  rurban
 684 // unittest fix
 685 //
 686 // Revision 1.51  2004/09/20 13:40:19  rurban
 687 // define all config.ini settings, only the supported will be taken from -default.
 688 // support USE_EXTERNAL_HTML2PDF renderer (htmldoc tested)
 689 //
 690 // Revision 1.50  2004/09/06 09:28:58  rurban
 691 // fix PLUGIN_CACHED_CACHE_DIR fallback logic. ini entry did not work before
 692 //
 693 // Revision 1.49  2004/07/13 13:07:27  rurban
 694 // improved DB_SESSION logic
 695 //
 696 // Revision 1.48  2004/07/05 13:09:37  rurban
 697 // ENABLE_RAW_HTML_LOCKEDONLY, ENABLE_RAW_HTML_SAFE
 698 //
 699 // Revision 1.47  2004/07/03 16:51:05  rurban
 700 // optional DBADMIN_USER:DBADMIN_PASSWD for action=upgrade (if no ALTER permission)
 701 // added atomic mysql REPLACE for PearDB as in ADODB
 702 // fixed _lock_tables typo links => link
 703 // fixes unserialize ADODB bug in line 180
 704 //
 705 // Revision 1.46  2004/07/02 09:55:58  rurban
 706 // more stability fixes: new DISABLE_GETIMAGESIZE if your php crashes when loading LinkIcons: failing getimagesize in old phps; blockparser stabilized
 707 //
 708 // Revision 1.45  2004/07/01 08:51:21  rurban
 709 // dumphtml: added exclude, print pagename before processing
 710 //
 711 // Revision 1.44  2004/06/29 08:52:22  rurban
 712 // Use ...version() $need_content argument in WikiDB also:
 713 // To reduce the memory footprint for larger sets of pagelists,
 714 // we don't cache the content (only true or false) and
 715 // we purge the pagedata (_cached_html) also.
 716 // _cached_html is only cached for the current pagename.
 717 // => Vastly improved page existance check, ACL check, ...
 718 //
 719 // Now only PagedList info=content or size needs the whole content, esp. if sortable.
 720 //
 721 // Revision 1.43  2004/06/29 06:48:02  rurban
 722 // Improve LDAP auth and GROUP_LDAP membership:
 723 //   no error message on false password,
 724 //   added two new config vars: LDAP_OU_USERS and LDAP_OU_GROUP with GROUP_METHOD=LDAP
 725 //   fixed two group queries (this -> user)
 726 // stdlib: ConvertOldMarkup still flawed
 727 //
 728 // Revision 1.42  2004/06/28 15:01:07  rurban
 729 // fixed LDAP_SET_OPTION handling, LDAP error on connection problem
 730 //
 731 // Revision 1.41  2004/06/25 14:29:17  rurban
 732 // WikiGroup refactoring:
 733 //   global group attached to user, code for not_current user.
 734 //   improved helpers for special groups (avoid double invocations)
 735 // new experimental config option ENABLE_XHTML_XML (fails with IE, and document.write())
 736 // fixed a XHTML validation error on userprefs.tmpl
 737 //
 738 // Revision 1.40  2004/06/22 07:12:48  rurban
 739 // removed USE_TAGLINES constant
 740 //
 741 // Revision 1.39  2004/06/21 16:22:28  rurban
 742 // add DEFAULT_DUMP_DIR and HTML_DUMP_DIR constants, for easier cmdline dumps,
 743 // fixed dumping buttons locally (images/buttons/),
 744 // support pages arg for dumphtml,
 745 // optional directory arg for dumpserial + dumphtml,
 746 // fix a AllPages warning,
 747 // show dump warnings/errors on DEBUG,
 748 // don't warn just ignore on wikilens pagelist columns, if not loaded.
 749 // RateIt pagelist column is called "rating", not "ratingwidget" (Dan?)
 750 //
 751 // Revision 1.38  2004/06/21 08:39:36  rurban
 752 // pear/Cache update from Cache-1.5.4 (added db and trifile container)
 753 // pear/DB update from DB-1.6.1 (mysql bugfixes, php5 compat, DB_PORTABILITY features)
 754 //
 755 // Revision 1.37  2004/06/19 12:32:37  rurban
 756 // new TEMP_DIR for ziplib
 757 //
 758 // Revision 1.36  2004/06/19 10:06:37  rurban
 759 // Moved lib/plugincache-config.php to config/*.ini
 760 // use PLUGIN_CACHED_* constants instead of global $CacheParams
 761 //
 762 // Revision 1.35  2004/06/15 09:15:52  rurban
 763 // IMPORTANT: fixed passwd handling for passwords stored in prefs:
 764 //   fix encrypted usage, actually store and retrieve them from db
 765 //   fix bogologin with passwd set.
 766 // fix php crashes with call-time pass-by-reference (references wrongly used
 767 //   in declaration AND call). This affected mainly Apache2 and IIS.
 768 //   (Thanks to John Cole to detect this!)
 769 //
 770 // Revision 1.34  2004/06/13 13:54:25  rurban
 771 // Catch fatals on the four dump calls (as file and zip, as html and mimified)
 772 // FoafViewer: Check against external requirements, instead of fatal.
 773 // Change output for xhtmldumps: using file:// urls to the local fs.
 774 // Catch SOAP fatal by checking for GOOGLE_LICENSE_KEY
 775 // Import GOOGLE_LICENSE_KEY and FORTUNE_DIR from config.ini.
 776 //
 777 // Revision 1.33  2004/06/08 19:48:16  rurban
 778 // fixed foreign setup: no ugly skipped msg for the GenericPages, load english actionpages if translated not found
 779 //
 780 // Revision 1.32  2004/06/08 10:54:46  rurban
 781 // better acl dump representation, read back acl and owner
 782 //
 783 // Revision 1.31  2004/06/06 16:58:51  rurban
 784 // added more required ActionPages for foreign languages
 785 // install now english ActionPages if no localized are found. (again)
 786 // fixed default anon user level to be 0, instead of -1
 787 //   (wrong "required administrator to view this page"...)
 788 //
 789 // Revision 1.30  2004/06/04 12:40:21  rurban
 790 // Restrict valid usernames to prevent from attacks against external auth or compromise
 791 // possible holes.
 792 // Fix various WikiUser old issues with default IMAP,LDAP,POP3 configs. Removed these.
 793 // Fxied more warnings
 794 //
 795 // Revision 1.29  2004/06/04 11:58:38  rurban
 796 // added USE_TAGLINES
 797 //
 798 // Revision 1.28  2004/06/03 20:42:49  rurban
 799 // fixed bad warning #964850
 800 //
 801 // Revision 1.27  2004/06/03 10:18:19  rurban
 802 // fix FileUser locking issues, new config ENABLE_PAGEPERM
 803 //
 804 // Revision 1.26  2004/06/02 18:01:45  rurban
 805 // init global FileFinder to add proper include paths at startup
 806 //   adds PHPWIKI_DIR if started from another dir, lib/pear also
 807 // fix slashify for Windows
 808 // fix USER_AUTH_POLICY=old, use only USER_AUTH_ORDER methods (besides HttpAuth)
 809 //
 810 // Revision 1.25  2004/05/27 17:49:05  rurban
 811 // renamed DB_Session to DbSession (in CVS also)
 812 // added WikiDB->getParam and WikiDB->getAuthParam method to get rid of globals
 813 // remove leading slash in error message
 814 // added force_unlock parameter to File_Passwd (no return on stale locks)
 815 // fixed adodb session AffectedRows
 816 // added FileFinder helpers to unify local filenames and DATA_PATH names
 817 // editpage.php: new edit toolbar javascript on ENABLE_EDIT_TOOLBAR
 818 //
 819 // Revision 1.24  2004/05/18 13:33:13  rurban
 820 // we already have a CGI function
 821 //
 822 // Revision 1.23  2004/05/17 17:43:29  rurban
 823 // CGI: no PATH_INFO fix
 824 //
 825 // Revision 1.22  2004/05/16 22:07:35  rurban
 826 // check more config-default and predefined constants
 827 // various PagePerm fixes:
 828 //   fix default PagePerms, esp. edit and view for Bogo and Password users
 829 //   implemented Creator and Owner
 830 //   BOGOUSERS renamed to BOGOUSER
 831 // fixed syntax errors in signin.tmpl
 832 //
 833 // Revision 1.21  2004/05/08 22:55:12  rurban
 834 // Fixed longstanding sf.net:demo problem. endless loop, caused by an empty definition of
 835 // WIKI_NAME_REGEXP. Exactly this constant wasn't checked for its default setting.
 836 //
 837 // Revision 1.20  2004/05/08 20:21:00  rurban
 838 // remove php tags in Log
 839 //
 840 // Revision 1.19  2004/05/08 19:55:29  rurban
 841 // support <span>inlined plugin-result</span>:
 842 //   if the plugin is parsed inside a line, use <span> instead of
 843 //   <div tightenable top bottom>
 844 //   e.g. for "This is the current Phpwiki <plugin SystemInfo version> version.
 845 //
 846 // Revision 1.18  2004/05/08 16:58:19  rurban
 847 // don't ignore some false config values (e.g. USE_PATH_INFO false was ignored)
 848 //
 849 // Revision 1.17  2004/05/06 19:26:15  rurban
 850 // improve stability, trying to find the InlineParser endless loop on sf.net
 851 //
 852 // remove end-of-zip comments to fix sf.net bug #777278 and probably #859628
 853 //
 854 // Revision 1.16  2004/05/02 15:10:05  rurban
 855 // new finally reliable way to detect if /index.php is called directly
 856 //   and if to include lib/main.php
 857 // new global AllActionPages
 858 // SetupWiki now loads all mandatory pages: HOME_PAGE, action pages, and warns if not.
 859 // WikiTranslation what=buttons for Carsten to create the missing MacOSX buttons
 860 // PageGroupTestOne => subpages
 861 // renamed PhpWikiRss to PhpWikiRecentChanges
 862 // more docs, default configs, ...
 863 //
 864 // Revision 1.15  2004/05/01 15:59:29  rurban
 865 // more php-4.0.6 compatibility: superglobals
 866 //
 867 // Revision 1.14  2004/04/29 23:25:12  rurban
 868 // re-ordered locale init (as in 1.3.9)
 869 // fixed loadfile with subpages, and merge/restore anyway
 870 //   (sf.net bug #844188)
 871 //
 872 // Revision 1.13  2004/04/29 21:54:05  rurban
 873 // typo
 874 //
 875 // Revision 1.12  2004/04/27 16:16:27  rurban
 876 // more subtle config problems with defaults
 877 //
 878 // Revision 1.11  2004/04/26 20:44:34  rurban
 879 // locking table specific for better databases
 880 //
 881 // Revision 1.10  2004/04/26 13:22:32  rurban
 882 // calculate bool old or dynamic constants later
 883 //
 884 // Revision 1.9  2004/04/26 12:15:01  rurban
 885 // check default config values
 886 //
 887 // Revision 1.8  2004/04/23 16:55:59  zorloc
 888 // If using Db auth and DBAUTH_AUTH_DSN is empty set DBAUTH_AUTH_DSN to $DBParams['dsn']
 889 //
 890 // Revision 1.7  2004/04/20 22:26:27  zorloc
 891 // Removed Pear_Config for parse_ini_file().
 892 //
 893 // Revision 1.6  2004/04/20 18:10:27  rurban
 894 // config refactoring:
 895 //   FileFinder is needed for WikiFarm scripts calling index.php
 896 //   config run-time calls moved to lib/IniConfig.php:fix_configs()
 897 //   added PHPWIKI_DIR smart-detection code (Theme finder)
 898 //   moved FileFind to lib/FileFinder.php
 899 //   cleaned lib/config.php
 900 //
 901 // Revision 1.5  2004/04/20 17:21:57  rurban
 902 // WikiFarm code: honor predefined constants
 903 //
 904 // Revision 1.4  2004/04/20 17:08:19  rurban
 905 // Some IniConfig fixes: prepend our private lib/pear dir
 906 //   switch from " to ' in the auth statements
 907 //   use error handling.
 908 // WikiUserNew changes for the new "'$variable'" syntax
 909 //   in the statements
 910 // TODO: optimization to put config vars into the session.
 911 //
 912
 913 // (c-file-style: "gnu")
 914 // Local Variables:
 915 // mode: php
 916 // tab-width: 8
 917 // c-basic-offset: 4
 918 // c-hanging-comment-ender-p: nil
 919 // indent-tabs-mode: nil
 920 // End:
 921 ?>