lib/IniConfig.php

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