lib/IniConfig.php

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