lib/IniConfig.php

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