configurator.php

   1 <?php // $Id: configurator.php,v 1.47 2007-01-04 16:56:26 rurban Exp $
   2 /*
   3  * Copyright 2002,2003,2005 $ThePhpWikiProgrammingTeam
   4  * Copyright 2002 Martin Geisler <gimpster@gimpster.com>
   5  *
   6  * This file is part of PhpWiki.
   7  * Parts of this file were based on PHPWeather's configurator.php file.
   8  *   http://sourceforge.net/projects/phpweather/
   9  *
  10  * PhpWiki is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * PhpWiki is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with PhpWiki; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  23  */
  24
  25 /**
  26  * Starts automatically the first time by IniConfig("config/config.ini")
  27  * if it doesn't exist.
  28  *
  29  * DONE:
  30  * o Initial expand ?show=_part1 (the part id)
  31  * o read config-default.ini and use this as default_values
  32  * o commented / optional: non-default values should not be commented!
  33  *                         default values if optional can be omitted.
  34  * o validate input (fix javascript, add POST checks)
  35  * o start this automatically the first time
  36  * o fix include_path
  37  *
  38  * 1.3.11 TODO: (or 1.3.12?)
  39  * o parse_ini_file("config-dist.ini") for the commented vars
  40  * o check automatically for commented and optional vars
  41  * o fix _optional, to ignore existing config.ini and only use config-default.ini values
  42  * o mixin class for commented
  43  * o fix SQL quotes, AUTH_ORDER quotes and file forward slashes
  44  * o posted values validation, extend js validation for sane DB values
  45  * o read config-dist.ini into sections, comments, and optional/required settings
  46  *
  47  * A file config/config.ini will be automatically generated, if writable.
  48  *
  49  * NOTE: If you have a starterscript outside PHPWIKI_DIR but no
  50  * config/config.ini yet (very unlikely!), you must define DATA_PATH in the
  51  * starterscript, otherwise the webpath to configurator is unknown, and
  52  * subsequent requests will fail. (POST to save the INI)
  53  */
  54
  55 global $HTTP_SERVER_VARS, $HTTP_POST_VARS, $tdwidth;
  56 if (empty($_SERVER))    $_SERVER =& $GLOBALS['HTTP_SERVER_VARS'];
  57 if (empty($_GET))       $_GET    =& $GLOBALS['HTTP_GET_VARS'];
  58 if (empty($_ENV))       $_ENV    =& $GLOBALS['HTTP_ENV_VARS'];
  59 if (empty($_POST))      $_POST   =& $GLOBALS['HTTP_POST_VARS'];
  60
  61 if (empty($configurator))
  62     $configurator = "configurator.php";
  63 if (!strstr($_SERVER["SCRIPT_NAME"], $configurator) and defined('DATA_PATH'))
  64     $configurator = DATA_PATH . "/" . $configurator;
  65 $scriptname = str_replace('configurator.php', 'index.php', $_SERVER["SCRIPT_NAME"]);
  66 if (strstr($_SERVER["SCRIPT_NAME"],"/php")) {  // cgi got this different
  67     if (defined('DATA_PATH'))
  68         $scriptname = DATA_PATH . "/index.php";
  69     else
  70         $scriptname = str_replace('configurator.php', 'index.php', $_SERVER["PHP_SELF"]);
  71 }
  72
  73 $tdwidth = 700;
  74 $config_file = (substr(PHP_OS,0,3) == 'WIN') ? 'config\\config.ini' : 'config/config.ini';
  75 $fs_config_file = dirname(__FILE__) . (substr(PHP_OS,0,3) == 'WIN' ? '\\' : '/') . $config_file;
  76 if (isset($_POST['create']))  header('Location: '.$configurator.'?show=_part1&create=1#create');
  77
  78 // helpers from lib/WikiUser/HttpAuth.php
  79 if (!function_exists('_http_user')) {
  80     function _http_user() {
  81         if (!isset($_SERVER))
  82             $_SERVER = $GLOBALS['HTTP_SERVER_VARS'];
  83         if (!empty($_SERVER['PHP_AUTH_USER']))
  84             return array($_SERVER['PHP_AUTH_USER'], $_SERVER['PHP_AUTH_PW']);
  85         if (!empty($_SERVER['REMOTE_USER']))
  86             return array($_SERVER['REMOTE_USER'], $_SERVER['PHP_AUTH_PW']);
  87         if (!empty($GLOBALS['HTTP_ENV_VARS']['REMOTE_USER']))
  88             return array($GLOBALS['HTTP_ENV_VARS']['REMOTE_USER'],
  89                          $GLOBALS['HTTP_ENV_VARS']['PHP_AUTH_PW']);
  90         if (!empty($GLOBALS['REMOTE_USER']))
  91             return array($GLOBALS['REMOTE_USER'], $GLOBALS['PHP_AUTH_PW']);
  92
  93         // MsWindows IIS:
  94         if (!empty($_SERVER['HTTP_AUTHORIZATION'])) {
  95             list($userid, $passwd) = explode(':', base64_decode(substr($_SERVER['HTTP_AUTHORIZATION'], 6)));
  96             return array($userid, $passwd);
  97         }
  98         return array('','');
  99     }
 100     function _http_logout() {
 101         if (!isset($_SERVER))
 102             $_SERVER =& $GLOBALS['HTTP_SERVER_VARS'];
 103         // maybe we should random the realm to really force a logout. but the next login will fail.
 104         // better_srand(); $realm = microtime().rand();
 105         header('WWW-Authenticate: Basic realm="'.WIKI_NAME.'"');
 106         if (strstr(php_sapi_name(), 'apache'))
 107             header('HTTP/1.0 401 Unauthorized');
 108         else
 109             header("Status: 401 Access Denied"); //IIS and CGI need that
 110         unset($GLOBALS['REMOTE_USER']);
 111         unset($_SERVER['PHP_AUTH_USER']);
 112         unset($_SERVER['PHP_AUTH_PW']);
 113
 114         trigger_error("Permission denied. Require ADMIN_USER.", E_USER_ERROR);
 115         exit();
 116     }
 117 }
 118
 119 // If config.ini exists, we require ADMIN_USER access by faking HttpAuth.
 120 // So nobody can see or reset the password(s).
 121 if (file_exists($fs_config_file)) {
 122     // Require admin user
 123     if (!defined('ADMIN_USER') or !defined('ADMIN_PASSWD')) {
 124         if (!function_exists("IniConfig")) {
 125             include_once("lib/prepend.php");
 126             include_once("lib/IniConfig.php");
 127         }
 128         IniConfig($fs_config_file);
 129     }
 130     if (!defined('ADMIN_USER') or ADMIN_USER == '') {
 131         trigger_error("Configuration problem:\nADMIN_USER not defined in \"$fs_config_file\".\n"
 132                       . "Cannot continue: You have to fix that manually.", E_USER_ERROR);
 133         exit();
 134     }
 135
 136     list($admin_user, $admin_pw) = _http_user();
 137     //$required_user = ADMIN_USER;
 138     if (empty($admin_user) or $admin_user != ADMIN_USER)
 139     {
 140         _http_logout();
 141     }
 142     // check password
 143     if (ENCRYPTED_PASSWD and function_exists('crypt')) {
 144         if (crypt($admin_pw, ADMIN_PASSWD) != ADMIN_PASSWD)
 145             _http_logout();
 146     } elseif ($admin_pw != ADMIN_PASSWD) {
 147         _http_logout();
 148     }
 149 } else {
 150     if (!function_exists("IniConfig")) {
 151         include_once("lib/prepend.php");
 152         include_once("lib/IniConfig.php");
 153     }
 154     $def_file = (substr(PHP_OS,0,3) == 'WIN') ? 'config\\config-default.ini' : 'config/config-default.ini';
 155     $fs_def_file = dirname(__FILE__) . (substr(PHP_OS,0,3) == 'WIN' ? '\\' : '/') . $def_file;
 156     IniConfig($fs_def_file);
 157 }
 158
 159 echo '<','?xml version="1.0" encoding="iso-8859-1"?',">\n";
 160 ?>
 161 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 162   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 163 <html xmlns="http://www.w3.org/1999/xhtml">
 164 <head>
 165 <!-- $Id: configurator.php,v 1.47 2007-01-04 16:56:26 rurban Exp $ -->
 166 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
 167 <title>Configuration tool for PhpWiki <?php echo $config_file ?></title>
 168 <style type="text/css" media="screen">
 169 <!--
 170 /* TABLE { border: thin solid black } */
 171 body { font-family: Verdana, Arial, Helvetica, sans-serif; font-size: 80%; }
 172 pre { font-size: 120%; }
 173 td { border: thin solid black }
 174 tr { border: none }
 175 div.hint { border: thin solid red, background-color: #eeeeee; }
 176 tr.hidden { border: none; display: none; }
 177 td.part { background-color: #eeeeee; color: inherit; }
 178 td.instructions { background-color: #ffffee; width: <?php echo $tdwidth ?>px; color: inherit; }
 179 td.unchangeable-variable-top   { border-bottom: none; background-color: #ffffee; color:inherit; }
 180 td.unchangeable-variable-left  { border-top: none; background-color: #ffffee; color:inherit; }
 181 -->
 182 </style>
 183 <script language="JavaScript" type="text/javascript">
 184 <!--
 185 function update(accepted, error, value, output) {
 186   var msg = document.getElementById(output);
 187   if (accepted) {
 188     /* MSIE 5.0 fails here */
 189     if (msg && msg.innerHTML) { msg.innerHTML = "<font color=\"green\">Input accepted.</font>"; }
 190   } else {
 191     while ((index = error.indexOf("%s")) > -1) {
 192       error = error.substring(0, index) + value + error.substring(index+2);
 193     }
 194     if (msg) { msg.innerHTML = "<font color=\"red\">" + error + "</font>"; }
 195   }
 196   if (submit = document.getElementById('submit')) submit.disabled = accepted ? false : true;
 197 }
 198
 199 function validate(error, value, output, field) {
 200   update(field.value == value, error, field.value, output);
 201 }
 202
 203 function validate_ereg(error, ereg, output, field) {
 204   regex = new RegExp(ereg);
 205   update(regex.test(field.value), error, field.value, output);
 206 }
 207
 208 function validate_range(error, low, high, empty_ok, output, field) {
 209   update((empty_ok == 1 && field.value == "") ||
 210          (field.value >= low && field.value <= high),
 211          error, field.value, output);
 212 }
 213
 214 function toggle_group(id) {
 215   var text = document.getElementById(id + "_text");
 216   var do_hide = false;
 217   if (text.innerHTML == "Hide options.") {
 218     do_hide = true;
 219     text.innerHTML = "Show options.";
 220   } else {
 221     text.innerHTML = "Hide options.";
 222   }
 223
 224   var rows = document.getElementsByTagName('tr');
 225   var i = 0;
 226   for (i = 0; i < rows.length; i++) {
 227     var tr = rows[i];
 228     if (tr.className == 'header' && tr.id == id) {
 229       i++;
 230       break;
 231     }
 232   }
 233   for (; i < rows.length; i++) {
 234     var tr = rows[i];
 235     if (tr.className == 'header')
 236       break;
 237     tr.className = do_hide ? 'hidden': 'nonhidden';
 238   }
 239 }
 240
 241 function do_init() {
 242   // Hide all groups.  We do this via JavaScript to avoid
 243   // hiding the groups if JavaScript is not supported...
 244   var rows = document.getElementsByTagName('tr');
 245   var show = '<?php echo $_GET["show"] ?>';
 246   for (var i = 0; i < rows.length; i++) {
 247     var tr = rows[i];
 248     if (tr.className == 'header')
 249         if (!show || tr.id != show)
 250             toggle_group(tr.id);
 251   }
 252
 253   // Select text in textarea upon focus
 254   var area = document.getElementById('config-output');
 255   if (area) {
 256     listener = { handleEvent: function (e) { area.select(); } };
 257     area.addEventListener('focus', listener, false);
 258   }
 259 }
 260
 261 -->
 262 </script>
 263 </head>
 264 <body onload="do_init();">
 265
 266       <h1>Configuration for PhpWiki <?php echo $config_file ?></h1>
 267
 268 <div class="hint">
 269     Using this configurator.php is experimental!<br>
 270     On any configuration problems, please edit the resulting config.ini manually.
 271 </div>
 272
 273 <?php
 274 //define('DEBUG', 1);
 275 /**
 276  * The Configurator is a php script to aid in the configuration of PhpWiki.
 277  * Parts of this file were based on PHPWeather's configurator.php file.
 278  *   http://sourceforge.net/projects/phpweather/
 279  *
 280  * TO CHANGE THE CONFIGURATION OF YOUR PHPWIKI, DO *NOT* MODIFY THIS FILE!
 281  * more instructions go here
 282  *
 283  * Todo:
 284  *   * fix include_path
 285  *   * eval config.ini to get the actual settings.
 286  */
 287
 288 //////////////////////////////
 289 // begin configuration options
 290
 291 /**
 292  * Notes for the description parameter of $property:
 293  *
 294  * - Descriptive text will be changed into comments (preceeded by ; )
 295  *   for the final output to config.ini.
 296  *
 297  * - Only a limited set of html is allowed: pre, dl dt dd; it will be
 298  *   stripped from the final output.
 299  *
 300  * - Line breaks and spacing will be preserved for the final output.
 301  *
 302  * - Double line breaks are automatically converted to paragraphs
 303  *   for the html version of the descriptive text.
 304  *
 305  * - Double-quotes and dollar signs in the descriptive text must be
 306  *   escaped: \" and \$. Instead of escaping double-quotes you can use
 307  *   single (') quotes for the enclosing quotes.
 308  *
 309  * - Special characters like < and > must use html entities,
 310  *   they will be converted back to characters for the final output.
 311  */
 312
 313 $SEPARATOR = ";=========================================================================";
 314
 315 $preamble = "
 316 ; This is the main configuration file for PhpWiki in INI-style format.
 317 ; Note that certain characters are used as comment char and therefore
 318 ; these entries must be in double-quotes. Such as \":\", \";\", \",\" and \"|\"
 319 ; Take special care for DBAUTH_ sql statements. (Part 3a)
 320 ;
 321 ; This file is divided into several parts: Each one has different configuration
 322 ; settings you can change; in all cases the default should work on your system,
 323 ; however, we recommend you tailor things to your particular setting.
 324 ; Here undefined definitions get defined by config-default.ini settings.
 325 ";
 326
 327 // Detect not here listed configs:
 328 // for x in `perl -ne 'print $1,"\n" if /^;(\w+) =/' config/config-dist.ini`; do \
 329 //   grep \'$x\' configurator.php >/dev/null || echo $x ; done
 330
 331 $properties["Part Zero"] =
 332 new part('_part0', $SEPARATOR."\n", "
 333 Part Zero: (optional)
 334 Latest Development and Tricky Options");
 335
 336 if (defined('INCLUDE_PATH'))
 337     $include_path = INCLUDE_PATH;
 338 else {
 339   if (substr(PHP_OS,0,3) == 'WIN') {
 340       $include_path = dirname(__FILE__) . ';' . ini_get('include_path');
 341       if (strchr(ini_get('include_path'),'/'))
 342           $include_path = strtr($include_path,'\\','/');
 343   } else {
 344     $include_path = dirname(__FILE__) . ':' . ini_get('include_path');
 345   }
 346 }
 347
 348 $properties["PHP include_path"] =
 349 new _define('INCLUDE_PATH', $include_path);
 350
 351 // TODO: convert this a checkbox row as in tests/unit/test.pgp
 352 $properties["DEBUG"] =
 353 new numeric_define_optional('DEBUG', DEBUG);
 354
 355 $properties["ENABLE_EDIT_TOOLBAR"] =
 356 new boolean_define_commented_optional('ENABLE_EDIT_TOOLBAR');
 357
 358 $properties["JS_SEARCHREPLACE"] =
 359 new boolean_define_commented_optional('JS_SEARCHREPLACE');
 360
 361 // TESTME: use config-default:  = false
 362 $properties["ENABLE_DOUBLECLICKEDIT"] =
 363 new boolean_define_commented_optional('ENABLE_DOUBLECLICKEDIT');
 364
 365 $properties["ENABLE_WYSIWYG"] =
 366 new boolean_define_commented_optional('ENABLE_WYSIWYG');
 367
 368 $properties["WYSIWYG_BACKEND"] =
 369 new _define_selection(
 370 'WYSIWYG_BACKEND',
 371 array('Wikiwyg'   => 'Wikiwyg',
 372       'tinymce'   => 'tinymce',
 373       'FCKeditor' => 'FCKeditor',
 374       'spaw'      => 'spaw',
 375       'htmlarea3' => 'htmlarea3',
 376       'htmlarea2' => 'htmlarea2',
 377 ));
 378
 379 $properties["WYSIWYG_DEFAULT_PAGETYPE_HTML"] =
 380 new boolean_define_commented_optional('WYSIWYG_DEFAULT_PAGETYPE_HTML');
 381
 382 $properties["UPLOAD_USERDIR"] =
 383 new boolean_define_commented_optional('UPLOAD_USERDIR');
 384
 385 $properties["DISABLE_UNITS"] =
 386 new boolean_define_commented_optional('DISABLE_UNITS');
 387
 388 $properties["UNITS_EXE"] =
 389 new _define_commented_optional('UNITS_EXE');
 390
 391 $properties["ENABLE_XHTML_XML"] =
 392 new boolean_define_commented_optional('ENABLE_XHTML_XML');
 393
 394 $properties["ENABLE_SPAMASSASSIN"] =
 395 new boolean_define_commented_optional('ENABLE_SPAMASSASSIN');
 396
 397 $properties["ENABLE_SPAMBLOCKLIST"] =
 398 new boolean_define_optional('ENABLE_SPAMBLOCKLIST');
 399
 400 $properties["NUM_SPAM_LINKS"] =
 401 new numeric_define_optional('NUM_SPAM_LINKS');
 402
 403 $properties["GOOGLE_LINKS_NOFOLLOW"] =
 404 new boolean_define_commented_optional('GOOGLE_LINKS_NOFOLLOW');
 405
 406 $properties["ENABLE_LIVESEARCH"] =
 407 new boolean_define_commented_optional('ENABLE_LIVESEARCH');
 408
 409 $properties["ENABLE_ACDROPDOWN"] =
 410 new boolean_define_commented_optional('ENABLE_ACDROPDOWN');
 411
 412 $properties["ENABLE_DISCUSSION_LINK"] =
 413 new boolean_define_commented_optional('ENABLE_DISCUSSION_LINK');
 414
 415 $properties["ENABLE_CAPTCHA"] =
 416 new boolean_define_commented_optional('ENABLE_CAPTCHA');
 417
 418 $properties["USE_CAPTCHA_RANDOM_WORD"] =
 419 new boolean_define_commented_optional('USE_CAPTCHA_RANDOM_WORD');
 420
 421 $properties["USE_SAFE_DBSESSION"] =
 422 new boolean_define_commented_optional('USE_SAFE_DBSESSION');
 423
 424 $properties["BLOG_DEFAULT_EMPTY_PREFIX"] =
 425 new boolean_define_commented_optional('BLOG_DEFAULT_EMPTY_PREFIX');
 426
 427
 428 $properties["Part One"] =
 429 new part('_part1', $SEPARATOR."\n", "
 430 Part One: Authentication and security settings. See Part Three for more.");
 431
 432 $properties["Wiki Name"] =
 433 new _define_optional('WIKI_NAME', WIKI_NAME);
 434
 435 $properties["Admin Username"] =
 436 new _define_notempty('ADMIN_USER', ADMIN_USER, "
 437 You must set this! Username and password of the administrator.",
 438 "onchange=\"validate_ereg('Sorry, ADMIN_USER cannot be empty.', '^.+$', 'ADMIN_USER', this);\"");
 439
 440 $properties["Admin Password"] =
 441 new _define_password('ADMIN_PASSWD', ADMIN_PASSWD, "
 442 You must set this!
 443 For heaven's sake pick a good password.
 444
 445 If your version of PHP supports encrypted passwords, your password will be
 446 automatically encrypted within the generated config file.
 447 Use the \"Create Random Password\" button to create a good (random) password.
 448
 449 ADMIN_PASSWD is ignored on HttpAuth",
 450 "onchange=\"validate_ereg('Sorry, ADMIN_PASSWD must be at least 4 chars long.', '^....+$', 'ADMIN_PASSWD', this);\"");
 451
 452 $properties["Encrypted Passwords"] =
 453 new boolean_define
 454 ('ENCRYPTED_PASSWD',
 455  array('true'  => "true.  use crypt for all passwords",
 456        'false' => "false. use plaintest passwords (not recommended)"));
 457
 458 $properties["Reverse DNS"] =
 459 new boolean_define_optional
 460 ('ENABLE_REVERSE_DNS',
 461  array('true'  => "true. perform additional reverse dns lookups",
 462        'false' => "false. just record the address as given by the httpd server"));
 463
 464 $properties["ZIP Dump Authentication"] =
 465 new boolean_define_optional('ZIPDUMP_AUTH',
 466                     array('false' => "false. Everyone may download zip dumps",
 467                           'true'  => "true. Only admin may download zip dumps"));
 468
 469 $properties["Enable RawHtml Plugin"] =
 470 new boolean_define_commented_optional('ENABLE_RAW_HTML');
 471
 472 $properties["Allow RawHtml Plugin only on locked pages"] =
 473 new boolean_define_commented_optional('ENABLE_RAW_HTML_LOCKEDONLY');
 474
 475 $properties["Allow RawHtml Plugin if safe HTML code"] =
 476     new boolean_define_commented_optional('ENABLE_RAW_HTML_SAFE','', "
 477 If this is set, all unsafe html code is stripped automatically (experimental!)
 478 See <a href=\"http://chxo.com/scripts/safe_html-test.php\" target=\"_new\">chxo.com/scripts/safe_html-test.php</a>
 479 ");
 480
 481 $properties["Maximum Upload Size"] =
 482 new numeric_define_optional('MAX_UPLOAD_SIZE', MAX_UPLOAD_SIZE);
 483
 484 $properties["Minor Edit Timeout"] =
 485 new numeric_define_optional('MINOR_EDIT_TIMEOUT', MINOR_EDIT_TIMEOUT);
 486
 487 $properties["Disabled Actions"] =
 488 new array_define('DISABLED_ACTIONS', DISABLED_ACTIONS /*array()*/);
 489
 490 $properties["Moderate all Pagechanges"] =
 491 new boolean_define_commented_optional('ENABLE_MODERATEDPAGE_ALL');
 492
 493 $properties["Access Log File"] =
 494 new _define_commented_optional('ACCESS_LOG', ACCESS_LOG);
 495
 496 $properties["Access Log SQL"] =
 497 new _define_selection(
 498 'ACCESS_LOG_SQL',
 499 array('0' => 'disabled',
 500       '1' => 'read only',
 501       '2' => 'read + write'));
 502
 503 $properties["Compress Output"] =
 504 new boolean_define_commented_optional
 505 ( 'COMPRESS_OUTPUT',
 506   array(''      => 'undefined - GZIP compress when appropriate.',
 507         'false' => 'Never compress output.',
 508         'true'  => 'Always try to compress output.'));
 509
 510 $properties["HTTP Cache Control"] =
 511 new _define_selection_optional
 512 ('CACHE_CONTROL',
 513  array('LOOSE' => 'LOOSE',
 514        'STRICT' => 'STRICT',
 515        'NO_CACHE' => 'NO_CACHE',
 516        'ALLOW_STALE' => 'ALLOW_STALE'),
 517 "
 518 HTTP CACHE_CONTROL
 519
 520 This controls how PhpWiki sets the HTTP cache control
 521 headers (Expires: and Cache-Control:)
 522
 523 Choose one of:
 524
 525 <dl>
 526 <dt>NO_CACHE</dt>
 527 <dd>This is roughly the old (pre 1.3.4) behaviour.  PhpWiki will
 528     instruct proxies and browsers never to cache PhpWiki output.</dd>
 529
 530 <dt>STRICT</dt>
 531 <dd>Cached pages will be invalidated whenever the database global
 532     timestamp changes.  This should behave just like NONE (modulo
 533     bugs in PhpWiki and your proxies and browsers), except that
 534     things will be slightly more efficient.</dd>
 535
 536 <dt>LOOSE</dt>
 537 <dd>Cached pages will be invalidated whenever they are edited,
 538     or, if the pages include plugins, when the plugin output could
 539     concievably have changed.
 540
 541     <p>Behavior should be much like STRICT, except that sometimes
 542        wikilinks will show up as undefined (with the question mark)
 543        when in fact they refer to (recently) created pages.
 544        (Hitting your browsers reload or perhaps shift-reload button
 545        should fix the problem.)</p></dd>
 546
 547 <dt>ALLOW_STALE</dt>
 548 <dd>Proxies and browsers will be allowed to used stale pages.
 549     (The timeout for stale pages is controlled by CACHE_CONTROL_MAX_AGE.)
 550
 551     <p>This setting will result in quirky behavior.  When you edit a
 552        page your changes may not show up until you shift-reload the
 553        page, etc...</p>
 554
 555     <p>This setting is generally not advisable, however it may be useful
 556        in certain cases (e.g. if your wiki gets lots of page views,
 557        and few edits by knowledgable people who won't freak over the quirks.)</p>
 558 </dd>
 559
 560 The default is currently LOOSE.");
 561
 562 $properties["HTTP Cache Control Max Age"] =
 563 new numeric_define_optional('CACHE_CONTROL_MAX_AGE', CACHE_CONTROL_MAX_AGE);
 564
 565 $properties["Markup Caching"] =
 566 new boolean_define_commented_optional
 567 ('WIKIDB_NOCACHE_MARKUP',
 568  array('false' => 'Enable markup cache',
 569        'true'  => 'Disable markup cache'));
 570
 571 $properties["COOKIE_EXPIRATION_DAYS"] =
 572 new numeric_define_optional('COOKIE_EXPIRATION_DAYS', COOKIE_EXPIRATION_DAYS);
 573
 574 $properties["COOKIE_DOMAIN"] =
 575 new _define_commented_optional('COOKIE_DOMAIN', COOKIE_DOMAIN);
 576
 577 $properties["Path for PHP Session Support"] =
 578 new _define_optional('SESSION_SAVE_PATH', defined('SESSION_SAVE_PATH') ? SESSION_SAVE_PATH : ini_get('session.save_path'));
 579
 580 $properties["Force PHP Database Sessions"] =
 581 new boolean_define_commented_optional
 582 ('USE_DB_SESSION',
 583  array('false' => 'Disable database sessions, use files',
 584        'true'  => 'Enable database sessions'));
 585
 586 ///////// database selection
 587
 588 $properties["Part Two"] =
 589 new part('_part2', $SEPARATOR."\n", "
 590
 591 Part Two:
 592 Database Configuration
 593 ");
 594
 595 $properties["Database Type"] =
 596 new _define_selection("DATABASE_TYPE",
 597               array('dba'   => "dba",
 598                     'SQL'   => "SQL PEAR",
 599                     'ADODB' => "SQL ADODB",
 600                     'PDO'   => "PDO (php5 only)",
 601                     'file'   => "flatfile",
 602                     'cvs'   => "CVS File handler")/*, "
 603 Select the database backend type:
 604 Choose dba (default) to use one of the standard UNIX dba libraries. This is the fastest.
 605 Choose ADODB or SQL to use an SQL database with ADODB or PEAR.
 606 Choose PDO on php5 to use an SQL database. (experimental, no paging yet)
 607 flatfile is simple and slow.
 608 CVS is highly experimental and slow.
 609 Recommended is dba or SQL: PEAR or ADODB."*/);
 610
 611 $properties["SQL DSN Setup"] =
 612 new unchangeable_variable('_sqldsnstuff', "", "
 613 For SQL based backends, specify the database as a DSN
 614 The most general form of a DSN looks like:
 615 <pre>
 616   phptype(dbsyntax)://username:password@protocol+hostspec/database?option=value
 617 </pre>
 618 For a MySQL database, the following should work:
 619 <pre>
 620    mysql://user:password@host/databasename
 621 </pre>
 622 To connect over a unix socket, use something like
 623 <pre>
 624    mysql://user:password@unix(/path/to/socket)/databasename
 625 </pre>
 626 <pre>
 627   DATABASE_DSN = mysql://guest@:/var/lib/mysql/mysql.sock/phpwiki
 628   DATABASE_DSN = mysql://guest@localhost/phpwiki
 629   DATABASE_DSN = pgsql://localhost/user_phpwiki
 630 </pre>");
 631
 632 // Choose ADODB or SQL to use an SQL database with ADODB or PEAR.
 633 // Choose dba to use one of the standard UNIX dbm libraries.
 634
 635 $properties["SQL Type"] =
 636 new _variable_selection('_dsn_sqltype',
 637               array('mysql'  => "MySQL",
 638                     'pgsql'  => "PostgreSQL",
 639                     'mssql'  => "Microsoft SQL Server",
 640                     'oci8'   => "Oracle 8",
 641                     'mysqli' => "mysqli (only ADODB)",
 642                     'mysqlt' => "mysqlt (only ADODB)",
 643                     'ODBC'   => "ODBC (only ADODB or PDO)",
 644                     'firebird' => "Firebird (only PDO)",
 645                     'oracle'  => "Oracle (only PDO)",
 646 ), "
 647 SQL DB types. The DSN hosttype.");
 648
 649 $properties["SQL User"] =
 650 new _variable('_dsn_sqluser', "wikiuser", "
 651 SQL User Id:");
 652
 653 $properties["SQL Password"] =
 654 new _variable('_dsn_sqlpass', "", "
 655 SQL Password:");
 656
 657 $properties["SQL Database Host"] =
 658 new _variable('_dsn_sqlhostorsock', "localhost", "
 659 SQL Database Hostname:
 660
 661 To connect over a local named socket, use something like
 662 <pre>
 663   unix(/var/lib/mysql/mysql.sock)
 664 </pre>
 665 here.
 666 mysql on Windows via named pipes might need 127.0.0.1");
 667
 668 $properties["SQL Database Name"] =
 669 new _variable('_dsn_sqldbname', "phpwiki", "
 670 SQL Database Name:");
 671
 672 $dsn_sqltype = $properties["SQL Type"]->value();
 673 $dsn_sqluser = $properties["SQL User"]->value();
 674 $dsn_sqlpass = $properties["SQL Password"]->value();
 675 $dsn_sqlhostorsock = $properties["SQL Database Host"]->value();
 676 $dsn_sqldbname = $properties["SQL Database Name"]->value();
 677 $dsn_sqlstring = $dsn_sqltype."://{$dsn_sqluser}:{$dsn_sqlpass}@{$dsn_sqlhostorsock}/{$dsn_sqldbname}";
 678
 679 $properties["SQL dsn"] =
 680 new unchangeable_define("DATABASE_DSN",
 681                         $dsn_sqlstring, "
 682 Calculated from the settings above:");
 683
 684 $properties["Filename / Table name Prefix"] =
 685 new _define_commented('DATABASE_PREFIX', DATABASE_PREFIX, "
 686 Used by all DB types:
 687
 688 Prefix for filenames or table names, e.g. \"phpwiki_\"
 689
 690 Currently <b>you MUST EDIT THE SQL file too!</b> (in the schemas/
 691 directory because we aren't doing on the fly sql generation
 692 during the installation.
 693
 694 Note: This prefix is NOT prepended to the default DBAUTH_
 695       tables user, pref and member!
 696 ");
 697
 698 $properties["DATABASE_PERSISTENT"] =
 699 new boolean_define_commented_optional
 700 ('DATABASE_PERSISTENT',
 701  array('false' => "Disabled",
 702        'true'  => "Enabled"));
 703
 704 $properties["DB Session table"] =
 705 new _define_optional("DATABASE_SESSION_TABLE", DATABASE_SESSION_TABLE, "
 706 Tablename to store session information. Only supported by SQL backends.
 707
 708 A word of warning - any prefix defined above will be prepended to whatever is given here.
 709 ");
 710
 711 //TODO: $TEMP
 712 $temp = !empty($_ENV['TEMP']) ? $_ENV['TEMP'] : "/tmp";
 713 $properties["dba directory"] =
 714 new _define("DATABASE_DIRECTORY", $temp);
 715
 716 // TODO: list the available methods
 717 $properties["dba handler"] =
 718 new _define_selection('DATABASE_DBA_HANDLER',
 719               array('gdbm' => "gdbm - GNU database manager (not recommended anymore)",
 720                     'dbm'  => "DBM - Redhat default. On sf.net there's dbm and not gdbm anymore",
 721                     'db2'  => "DB2 - BerkeleyDB (Sleepycat) DB2",
 722                     'db3'  => "DB3 - BerkeleyDB (Sleepycat) DB3. Default on Windows but not on every Linux",
 723                     'db4'  => "DB4 - BerkeleyDB (Sleepycat) DB4."), "
 724 Use 'gdbm', 'dbm', 'db2', 'db3' or 'db4' depending on your DBA handler methods supported: <br >  "
 725                       . (function_exists("dba_handlers") ? join(", ",dba_handlers()) : "")
 726                       . "\n\nBetter not use other hacks such as inifile, flatfile or cdb");
 727
 728 $properties["dba timeout"] =
 729 new numeric_define("DATABASE_TIMEOUT", DATABASE_TIMEOUT, "
 730 Recommended values are 10-20 seconds. The more load the server has, the higher the timeout.");
 731
 732 $properties["DATABASE_OPTIMISE_FREQUENCY"] =
 733 new numeric_define_optional('DATABASE_OPTIMISE_FREQUENCY', DATABASE_OPTIMISE_FREQUENCY);
 734
 735 $properties["DBADMIN_USER"] =
 736 new _define_optional('DBADMIN_USER', DBADMIN_USER);
 737
 738 $properties["DBADMIN_PASSWD"] =
 739 new _define_password_optional('DBADMIN_PASSWD', DBADMIN_PASSWD);
 740
 741 $properties["USECACHE"] =
 742 new boolean_define_commented_optional('USECACHE');
 743
 744 ///////////////////
 745
 746 $properties["Page Revisions"] =
 747 new unchangeable_variable('_parttworevisions', "", "
 748
 749 Section 2a: Archive Cleanup
 750 The next section controls how many old revisions of each page are kept in the database.
 751
 752 There are two basic classes of revisions: major and minor. Which
 753 class a revision belongs in is determined by whether the author
 754 checked the \"this is a minor revision\" checkbox when they saved the
 755 page.
 756
 757 There is, additionally, a third class of revisions: author
 758 revisions. The most recent non-mergable revision from each distinct
 759 author is and author revision.
 760
 761 The expiry parameters for each of those three classes of revisions
 762 can be adjusted seperately. For each class there are five
 763 parameters (usually, only two or three of the five are actually
 764 set) which control how long those revisions are kept in the
 765 database.
 766 <dl>
 767    <dt>max_keep:</dt> <dd>If set, this specifies an absolute maximum for the
 768             number of archived revisions of that class. This is
 769             meant to be used as a safety cap when a non-zero
 770             min_age is specified. It should be set relatively high,
 771             and it's purpose is to prevent malicious or accidental
 772             database overflow due to someone causing an
 773             unreasonable number of edits in a short period of time.</dd>
 774
 775   <dt>min_age:</dt>  <dd>Revisions younger than this (based upon the supplanted
 776             date) will be kept unless max_keep is exceeded. The age
 777             should be specified in days. It should be a
 778             non-negative, real number,</dd>
 779
 780   <dt>min_keep:</dt> <dd>At least this many revisions will be kept.</dd>
 781
 782   <dt>keep:</dt>     <dd>No more than this many revisions will be kept.</dd>
 783
 784   <dt>max_age:</dt>  <dd>No revision older than this age will be kept.</dd>
 785 </dl>
 786 Supplanted date: Revisions are timestamped at the instant that they
 787 cease being the current revision. Revision age is computed using
 788 this timestamp, not the edit time of the page.
 789
 790 Merging: When a minor revision is deleted, if the preceding
 791 revision is by the same author, the minor revision is merged with
 792 the preceding revision before it is deleted. Essentially: this
 793 replaces the content (and supplanted timestamp) of the previous
 794 revision with the content after the merged minor edit, the rest of
 795 the page metadata for the preceding version (summary, mtime, ...)
 796 is not changed.
 797 ");
 798
 799 // For now the expiration parameters are statically inserted as
 800 // an unchangeable property. You'll have to edit the resulting
 801 // config file if you really want to change these from the default.
 802
 803 $properties["Major Edits: keep minimum days"] =
 804     new numeric_define('MAJOR_MIN_KEEP', MAJOR_MIN_KEEP, "
 805 Default: Keep for unlimited time.
 806 Set to 0 to enable archive cleanup");
 807 $properties["Minor Edits: keep minumum days"] =
 808     new numeric_define('MINOR_MIN_KEEP', MINOR_MIN_KEEP, "
 809 Default: Keep for unlimited time.
 810 Set to 0 to enable archive cleanup");
 811
 812 $properties["Major Edits: how many"] =
 813     new numeric_define('MAJOR_KEEP', MAJOR_KEEP, "
 814 Keep up to 8 major edits");
 815 $properties["Major Edits: how many days"] =
 816     new numeric_define('MAJOR_MAX_AGE', MAJOR_MAX_AGE, "
 817 keep them no longer than a month");
 818
 819 $properties["Minor Edits: how many"] =
 820     new numeric_define("MINOR_KEEP", MINOR_KEEP, "
 821 Keep up to 4 minor edits");
 822 $properties["Minor Edits: how many days"] =
 823     new numeric_define("MINOR_MAX_AGE", "7", "
 824 keep them no longer than a week");
 825
 826 $properties["per Author: how many"] =
 827     new numeric_define("AUTHOR_KEEP", "8", "
 828 Keep the latest contributions of the last 8 authors,");
 829 $properties["per Author: how many days"] =
 830     new numeric_define("AUTHOR_MAX_AGE", "365", "
 831 up to a year.");
 832 $properties["per Author: keep minumum days"] =
 833     new numeric_define("AUTHOR_MIN_AGE", "7", "
 834 Additionally, (in the case of a particularly active page) try to
 835 keep the latest contributions of all authors in the last week (even if there are more than eight of them,)");
 836 $properties["per Author: max revisions"] =
 837     new numeric_define("AUTHOR_MAX_KEEP", "20", "
 838 but in no case keep more than twenty unique author revisions.");
 839
 840 /////////////////////////////////////////////////////////////////////
 841
 842 $properties["Part Three"] =
 843 new part('_part3', $SEPARATOR."\n", "
 844
 845 Part Three: (optional)
 846 Basic User Authentication Setup
 847 ");
 848
 849 $properties["Publicly viewable"] =
 850 new boolean_define_optional('ALLOW_ANON_USER',
 851                     array('true'  => "true. Permit anonymous view. (Default)",
 852                           'false' => "false. Force login even on view (strictly private)"), "
 853 If ALLOW_ANON_USER is false, you have to login before viewing any page or doing any other action on a page.");
 854
 855 $properties["Allow anonymous edit"] =
 856 new boolean_define_optional('ALLOW_ANON_EDIT',
 857                     array('true'  => "true. Permit anonymous users to edit. (Default)",
 858                           'false' => "false. Force login on edit (moderately locked)"), "
 859 If ALLOW_ANON_EDIT is false, you have to login before editing or changing any page. See below.");
 860
 861 $properties["Allow Bogo Login"] =
 862 new boolean_define_optional('ALLOW_BOGO_LOGIN',
 863                     array('true'  => "true. Users may Sign In with any WikiWord, without password. (Default)",
 864                           'false' => "false. Require stricter authentication."), "
 865 If ALLOW_BOGO_LOGIN is false, you may not login with any wikiword username and empty password.
 866 If true, users are allowed to create themselves with any WikiWord username. See below.");
 867
 868 $properties["Allow User Passwords"] =
 869 new boolean_define_optional('ALLOW_USER_PASSWORDS',
 870                     array('true'  => "True user authentication with password checking. (Default)",
 871                           'false' => "false. Ignore authentication settings below."), "
 872 If ALLOW_USER_PASSWORDS is true, the authentication settings below define where and how to
 873 check against given username/passwords. For completely security disable BOGO_LOGIN and ANON_EDIT above.");
 874
 875 $properties["User Authentication Methods"] =
 876     new array_define('USER_AUTH_ORDER', array("PersonalPage", "Db"), "
 877 Many different methods can be used to check user's passwords.
 878 Try any of these in the given order:
 879 <dl>
 880 <dt>BogoLogin</dt>
 881         <dd>WikiWord username, with no *actual* password checking,
 882         although the user will still have to enter one.</dd>
 883 <dt>PersonalPage</dt>
 884         <dd>Store passwords in the users homepage metadata (simple)</dd>
 885 <dt>Db</dt>
 886         <dd>Use DBAUTH_AUTH_* (see below) with PearDB or ADODB only.</dd>
 887 <dt>LDAP</dt>
 888         <dd>Authenticate against LDAP_AUTH_HOST with LDAP_BASE_DN.</dd>
 889 <dt>IMAP</dt>
 890         <dd>Authenticate against IMAP_AUTH_HOST (email account)</dd>
 891 <dt>POP3</dt>
 892         <dd>Authenticate against POP3_AUTH_HOST (email account)</dd>
 893 <dt>Session</dt>
 894         <dd>Get username and level from a PHP session variable. (e.g. for gforge)</dd>
 895 <dt>File</dt>
 896         <dd>Store username:crypted-passwords in .htaccess like files.
 897          Use Apache's htpasswd to manage this file.</dd>
 898 <dt>HttpAuth</dt>
 899         <dd>Use the protection by the webserver (.htaccess/.htpasswd) (experimental)
 900         Enforcing HTTP Auth not yet. Note that the ADMIN_USER should exist also.
 901         Using HttpAuth disables all other methods and no userauth sessions are used.</dd>
 902 </dl>
 903
 904 Several of these methods can be used together, in the manner specified by
 905 USER_AUTH_POLICY, below.  To specify multiple authentication methods,
 906 separate the name of each one with colons.
 907 <pre>
 908   USER_AUTH_ORDER = 'PersonalPage : Db'
 909   USER_AUTH_ORDER = 'BogoLogin : PersonalPage'
 910 </pre>");
 911
 912 $properties["PASSWORD_LENGTH_MINIMUM"] =
 913 new numeric_define('PASSWORD_LENGTH_MINIMUM', PASSWORD_LENGTH_MINIMUM);
 914
 915 $properties["USER_AUTH_POLICY"] =
 916 new _define_selection('USER_AUTH_POLICY',
 917               array('first-only' => "first-only - use only the first method in USER_AUTH_ORDER",
 918                     'old'       => "old - ignore USER_AUTH_ORDER (legacy)",
 919                     'strict'    => "strict - check all methods for userid + password (recommended)",
 920                     'stacked'   => "stacked - check all methods for userid, and if found for password"), "
 921 The following policies are available for user authentication:
 922 <dl>
 923 <dt>first-only</dt>
 924         <dd>use only the first method in USER_AUTH_ORDER</dd>
 925 <dt>old</dt>
 926         <dd>ignore USER_AUTH_ORDER and try to use all available
 927         methods as in the previous PhpWiki releases (slow)</dd>
 928 <dt>strict</dt>
 929         <dd>check if the user exists for all methods:
 930         on the first existing user, try the password.
 931         dont try the other methods on failure then</dd>
 932 <dt>stacked</dt>
 933         <dd>check the given user - password combination for all
 934         methods and return true on the first success.</dd></dl>");
 935
 936 $properties["ENABLE_USER_NEW"] =
 937 new boolean_define_commented_optional('ENABLE_USER_NEW');
 938
 939 $properties["ENABLE_PAGEPERM"] =
 940 new boolean_define_commented_optional('ENABLE_PAGEPERM');
 941
 942 ///////////////////
 943
 944 $properties["Part Three A"] =
 945 new part('_part3a', $SEPARATOR."\n", "
 946
 947 Part Three A: (optional)
 948 Group Membership");
 949
 950 $properties["Group membership"] =
 951 new _define_selection("GROUP_METHOD",
 952               array('WIKIPAGE' => "WIKIPAGE - List at \"CategoryGroup\". (Slowest, but easiest to maintain)",
 953                     '"NONE"'   => "NONE - Disable group membership (Fastest)",
 954                     'DB'       => "DB - SQL Database, Optionally external. See USERS/GROUPS queries",
 955                     'FILE'     => "Flatfile. See AUTH_GROUP_FILE below.",
 956                     'LDAP'     => "LDAP - See \"LDAP authentication options\" above. (Experimental)"), "
 957 Group membership.  PhpWiki supports defining permissions for a group as
 958 well as for individual users.  This defines how group membership information
 959 is obtained.  Supported values are:
 960 <dl>
 961 <dt>\"NONE\"</dt>
 962           <dd>Disable group membership (Fastest). Note the required quoting.</dd>
 963 <dt>WIKIPAGE</dt>
 964           <dd>Define groups as list at \"CategoryGroup\". (Slowest, but easiest to maintain)</dd>
 965 <dt>DB</dt>
 966           <dd>Stored in an SQL database. Optionally external. See USERS/GROUPS queries</dd>
 967 <dt>FILE</dt>
 968           <dd>Flatfile. See AUTH_GROUP_FILE below.</dd>
 969 <dt>LDAP</dt>
 970           <dd>LDAP groups. See \"LDAP authentication options\" above and
 971           lib/WikiGroup.php. (experimental)</dd></dl>");
 972
 973 $properties["CATEGORY_GROUP_PAGE"] =
 974   new _define_optional('CATEGORY_GROUP_PAGE', _("CategoryGroup"), "
 975 If GROUP_METHOD = WIKIPAGE:
 976
 977 Page where all groups are listed.");
 978
 979 $properties["AUTH_GROUP_FILE"] =
 980   new _define_optional('AUTH_GROUP_FILE', _("/etc/groups"), "
 981 For GROUP_METHOD = FILE, the file given below is referenced to obtain
 982 group membership information.  It should be in the same format as the
 983 standard unix /etc/groups(5) file.");
 984
 985 $properties["Part Three B"] =
 986 new part('_part3b', $SEPARATOR."\n", "
 987
 988 Part Three B: (optional)
 989 External database authentication and authorization.
 990
 991 If USER_AUTH_ORDER includes Db, or GROUP_METHOD = DB, the options listed
 992 below define the SQL queries used to obtain the information out of the
 993 database, and (optionally) store the information back to the DB.");
 994
 995 $properties["DBAUTH_AUTH_DSN"] =
 996   new _define_optional('DBAUTH_AUTH_DSN', $dsn_sqlstring, "
 997 A database DSN to connect to.  Defaults to the DSN specified for the Wiki as a whole.");
 998
 999 $properties["User Exists Query"] =
1000   new _define('DBAUTH_AUTH_USER_EXISTS', "SELECT userid FROM user WHERE userid='\$userid'", "
1001 USER/PASSWORD queries:
1002
1003 For USER_AUTH_POLICY=strict and the Db method is required");
1004
1005 $properties["Check Query"] =
1006   new _define_optional('DBAUTH_AUTH_CHECK', "SELECT IF(passwd='\$password',1,0) AS ok FROM user WHERE userid='\$userid'", "
1007
1008 Check to see if the supplied username/password pair is OK
1009
1010 Plaintext passwords: (DBAUTH_AUTH_CRYPT_METHOD = plain)<br>
1011 ; DBAUTH_AUTH_CHECK = \"SELECT IF(passwd='\$password',1,0) AS ok FROM user WHERE userid='\$userid'\"
1012
1013 database-hashed passwords (more secure):<br>
1014 ; DBAUTH_AUTH_CHECK = \"SELECT IF(passwd=PASSWORD('\$password'),1,0) AS ok FROM user WHERE userid='\$userid'\"");
1015
1016 $properties["Crypt Method"] =
1017 new _define_selection_optional
1018 ('DBAUTH_AUTH_CRYPT_METHOD',
1019  array('plain' => 'plain',
1020        'crypt' => 'crypt'), "
1021 If you want to use Unix crypt()ed passwords, you can use DBAUTH_AUTH_CHECK
1022 to get the password out of the database with a simple SELECT query, and
1023 specify DBAUTH_AUTH_USER_EXISTS and DBAUTH_AUTH_CRYPT_METHOD:
1024
1025 ; DBAUTH_AUTH_CHECK = \"SELECT passwd FROM user where userid='\$userid'\" <br>
1026 ; DBAUTH_AUTH_CRYPT_METHOD = crypt");
1027
1028 $properties["Update the user's authentication credential"] =
1029     new _define('DBAUTH_AUTH_UPDATE', "UPDATE user SET passwd='\$password' WHERE userid='\$userid'", "
1030 If this is not defined but DBAUTH_AUTH_CHECK is, then the user will be unable to update their
1031 password.
1032
1033 Plaintext passwords:<br>
1034   DBAUTH_AUTH_UPDATE = \"UPDATE user SET passwd='\$password' WHERE userid='\$userid'\"<br>
1035 Database-hashed passwords:<br>
1036   DBAUTH_AUTH_UPDATE = \"UPDATE user SET passwd=PASSWORD('\$password') WHERE userid='\$userid'\"");
1037
1038 $properties["Allow the user to create their own account"] =
1039     new _define_optional('DBAUTH_AUTH_CREATE', "INSERT INTO user SET passwd=PASSWORD('\$password'),userid='\$userid'", "
1040 If this is empty, Db users cannot subscribe by their own.");
1041
1042 $properties["USER/PREFERENCE queries"] =
1043     new _define_optional('DBAUTH_PREF_SELECT', "SELECT prefs FROM user WHERE userid='\$userid'", "
1044 If you choose to store your preferences in an external database, enable
1045 the following queries.  Note that if you choose to store user preferences
1046 in the 'user' table, only registered users get their prefs from the database,
1047 self-created users do not.  Better to use the special 'pref' table.
1048
1049 The prefs field stores the serialized form of the user's preferences array,
1050 to ease the complication of storage.
1051 <pre>
1052   DBAUTH_PREF_SELECT = \"SELECT prefs FROM user WHERE userid='\$userid'\"
1053   DBAUTH_PREF_SELECT = \"SELECT prefs FROM pref WHERE userid='\$userid'\"
1054 </pre>");
1055
1056 $properties["Update the user's preferences"] =
1057     new _define_optional('DBAUTH_PREF_UPDATE', "UPDATE user SET prefs='\$pref_blob' WHERE userid='\$userid'", "
1058 Note that REPLACE works only with mysql and destroy all other columns!
1059
1060 Mysql: DBAUTH_PREF_UPDATE = \"REPLACE INTO pref SET prefs='\$pref_blob',userid='\$userid'\"");
1061
1062 $properties["Create new user's preferences"] =
1063     new _define_optional('DBAUTH_PREF_INSERT', "INSERT INTO pref (userid,prefs) VALUES ('\$userid','\$pref_blob')", "
1064 Define this if new user can be create by themselves.
1065 ");
1066
1067 $properties["USERS/GROUPS queries"] =
1068     new _define_optional('DBAUTH_IS_MEMBER', "SELECT user FROM user WHERE user='\$userid' AND group='\$groupname'", "
1069 You can define 1:n or n:m user<=>group relations, as you wish.
1070
1071 Sample configurations:
1072
1073 only one group per user (1:n):<br>
1074    DBAUTH_IS_MEMBER = \"SELECT user FROM user WHERE user='\$userid' AND group='\$groupname'\"<br>
1075    DBAUTH_GROUP_MEMBERS = \"SELECT user FROM user WHERE group='\$groupname'\"<br>
1076    DBAUTH_USER_GROUPS = \"SELECT group FROM user WHERE user='\$userid'\"<br>
1077 multiple groups per user (n:m):<br>
1078    DBAUTH_IS_MEMBER = \"SELECT userid FROM member WHERE userid='\$userid' AND groupname='\$groupname'\"<br>
1079    DBAUTH_GROUP_MEMBERS = \"SELECT DISTINCT userid FROM member WHERE groupname='\$groupname'\"<br>
1080    DBAUTH_USER_GROUPS = \"SELECT groupname FROM member WHERE userid='\$userid'\"<br>");
1081 $properties["DBAUTH_GROUP_MEMBERS"] =
1082     new _define_optional('DBAUTH_GROUP_MEMBERS', "SELECT user FROM user WHERE group='\$groupname'", "");
1083 $properties["DBAUTH_USER_GROUPS"] =
1084     new _define_optional('DBAUTH_USER_GROUPS', "SELECT group FROM user WHERE user='\$userid'", "");
1085
1086 if (function_exists('ldap_connect')) {
1087
1088 $properties["LDAP AUTH Host"] =
1089   new _define_optional('LDAP_AUTH_HOST', "ldap://localhost:389", "
1090 If USER_AUTH_ORDER contains Ldap:
1091
1092 The LDAP server to connect to.  Can either be a hostname, or a complete
1093 URL to the server (useful if you want to use ldaps or specify a different
1094 port number).");
1095
1096 $properties["LDAP BASE DN"] =
1097   new _define_optional('LDAP_BASE_DN', "ou=mycompany.com,o=My Company", "
1098 The organizational or domain BASE DN: e.g. \"dc=mydomain,dc=com\".
1099
1100 Note: ou=Users and ou=Groups are used for GroupLdap Membership
1101 Better use LDAP_OU_USERS and LDAP_OU_GROUP with GROUP_METHOD=LDAP.");
1102
1103 $properties["LDAP SET OPTION"] =
1104     new _define_optional('LDAP_SET_OPTION', "LDAP_OPT_PROTOCOL_VERSION=3:LDAP_OPT_REFERRALS=0", "
1105 Some LDAP servers need some more options, such as the Windows Active
1106 Directory Server.  Specify the options (as allowed by the PHP LDAP module)
1107 and their values as NAME=value pairs separated by colons.");
1108
1109 $properties["LDAP AUTH USER"] =
1110     new _define_optional('LDAP_AUTH_USER', "CN=ldapuser,ou=Users,o=Development,dc=mycompany.com", "
1111 DN to initially bind to the LDAP server as. This is needed if the server doesn't
1112 allow anonymous queries. (Windows Active Directory Server)");
1113
1114 $properties["LDAP AUTH PASSWORD"] =
1115     new _define_optional('LDAP_AUTH_PASSWORD', "secret", "
1116 Password to use to initially bind to the LDAP server, as the DN
1117 specified in the LDAP_AUTH_USER option (above).");
1118
1119 $properties["LDAP SEARCH FIELD"] =
1120     new _define_optional('LDAP_SEARCH_FIELD', "uid", "
1121 If you want to match usernames against an attribute other than uid,
1122 specify it here. Default: uid
1123
1124 e.g.: LDAP_SEARCH_FIELD = sAMAccountName");
1125
1126 $properties["LDAP OU USERS"] =
1127     new _define_optional('LDAP_OU_USERS', "ou=Users", "
1128 If you have an organizational unit for all users, define it here.
1129 This narrows the search, and is needed for LDAP group membership (if GROUP_METHOD=LDAP)
1130 Default: ou=Users");
1131
1132 $properties["LDAP OU GROUP"] =
1133     new _define_optional('LDAP_OU_GROUP', "ou=Groups", "
1134 If you have an organizational unit for all groups, define it here.
1135 This narrows the search, and is needed for LDAP group membership (if GROUP_METHOD=LDAP)
1136 The entries in this ou must have a gidNumber and cn attribute.
1137 Default: ou=Groups");
1138
1139 } else { // function_exists('ldap_connect')
1140
1141 $properties["LDAP Authentication"] =
1142 new unchangeable_variable('LDAP Authentication', "
1143 ; If USER_AUTH_ORDER contains Ldap:
1144 ;
1145 ; The LDAP server to connect to.  Can either be a hostname, or a complete
1146 ; URL to the server (useful if you want to use ldaps or specify a different
1147 ; port number).
1148 ;LDAP_AUTH_HOST = \"ldap://localhost:389\"
1149 ;
1150 ; The organizational or domain BASE DN: e.g. \"dc=mydomain,dc=com\".
1151 ;
1152 ; Note: ou=Users and ou=Groups are used for GroupLdap Membership
1153 ; Better use LDAP_OU_USERS and LDAP_OU_GROUP with GROUP_METHOD=LDAP.
1154 ;LDAP_BASE_DN = \"ou=Users,o=Development,dc=mycompany.com\"
1155
1156 ; Some LDAP servers need some more options, such as the Windows Active
1157 ; Directory Server.  Specify the options (as allowed by the PHP LDAP module)
1158 ; and their values as NAME=value pairs separated by colons.
1159 ; LDAP_SET_OPTION = \"LDAP_OPT_PROTOCOL_VERSION=3:LDAP_OPT_REFERRALS=0\"
1160
1161 ; DN to initially bind to the LDAP server as. This is needed if the server doesn't
1162 ; allow anonymous queries. (Windows Active Directory Server)
1163 ; LDAP_AUTH_USER = \"CN=ldapuser,ou=Users,o=Development,dc=mycompany.com\"
1164
1165 ; Password to use to initially bind to the LDAP server, as the DN
1166 ; specified in the LDAP_AUTH_USER option (above).
1167 ; LDAP_AUTH_PASSWORD = secret
1168
1169 ; If you want to match usernames against an attribute other than uid,
1170 ; specify it here. Default: uid
1171 ; LDAP_SEARCH_FIELD = sAMAccountName
1172
1173 ; If you have an organizational unit for all users, define it here.
1174 ; This narrows the search, and is needed for LDAP group membership (if GROUP_METHOD=LDAP)
1175 ; Default: ou=Users
1176 ; LDAP_OU_USERS = ou=Users
1177
1178 ; If you have an organizational unit for all groups, define it here.
1179 ; This narrows the search, and is needed for LDAP group membership (if GROUP_METHOD=LDAP)
1180 ; The entries in this ou must have a gidNumber and cn attribute.
1181 ; Default: ou=Groups
1182 ; LDAP_OU_GROUP = ou=Groups", "
1183 ; Ignored. No LDAP support in this php. configure --with-ldap");
1184 }
1185
1186 if (function_exists('imap_open')) {
1187
1188 $properties["IMAP Auth Host"] =
1189   new _define_optional('IMAP_AUTH_HOST', 'localhost:143/imap/notls', "
1190 If USER_AUTH_ORDER contains IMAP:
1191
1192 The IMAP server to check usernames from. Defaults to localhost.
1193
1194 Some IMAP_AUTH_HOST samples:
1195   localhost, localhost:143/imap/notls,
1196   localhost:993/imap/ssl/novalidate-cert (SuSE refuses non-SSL conections)");
1197
1198 } else { // function_exists('imap_open')
1199
1200 $properties["IMAP Authentication"] =
1201   new unchangeable_variable('IMAP_AUTH_HOST',"
1202 ; If USER_AUTH_ORDER contains IMAP:
1203 ; The IMAP server to check usernames from. Defaults to localhost.
1204 ;
1205 ; Some IMAP_AUTH_HOST samples:
1206 ;   localhost, localhost:143/imap/notls,
1207 ;   localhost:993/imap/ssl/novalidate-cert (SuSE refuses non-SSL conections)
1208 ;IMAP_AUTH_HOST = localhost:143/imap/notls", "
1209 Ignored. No IMAP support in this php. configure --with-imap");
1210
1211 }
1212
1213 $properties["POP3 Authentication"] =
1214   new _define_optional('POP3_AUTH_HOST', 'localhost:110', "
1215 If USER_AUTH_ORDER contains POP3:
1216
1217 The POP3 mail server to check usernames and passwords against.");
1218 $properties["File Authentication"] =
1219   new _define_optional('AUTH_USER_FILE', '/etc/shadow', "
1220 If USER_AUTH_ORDER contains File:
1221
1222 File to read for authentication information.
1223 Popular choices are /etc/shadow and /etc/httpd/.htpasswd");
1224
1225 $properties["File Storable?"] =
1226 new boolean_define_commented_optional('AUTH_USER_FILE_STORABLE');
1227
1228 $properties["Session Auth USER"] =
1229   new _define_optional('AUTH_SESS_USER', 'userid', "
1230 If USER_AUTH_ORDER contains Session:
1231
1232 Name of the session variable which holds the already authenticated username.
1233 Sample: 'userid', 'user[username]', 'user->username'");
1234
1235 $properties["Session Auth LEVEL"] =
1236   new numeric_define('AUTH_SESS_LEVEL', '2', "
1237 Which level will the user be? 1 = Bogo or 2 = Pass");
1238
1239 /////////////////////////////////////////////////////////////////////
1240
1241 $properties["Part Four"] =
1242 new part('_part4', $SEPARATOR."\n", "
1243
1244 Part Four:
1245 Page appearance and layout");
1246
1247 $properties["Theme"] =
1248 new _define_selection_optional('THEME',
1249               array('default'  => "default",
1250                     'MacOSX'   => "MacOSX",
1251                     'smaller'  => 'smaller',
1252                     'Wordpress'=> 'Wordpress',
1253                     'Portland' => "Portland",
1254                     'Sidebar'  => "Sidebar",
1255                     'Crao'     => 'Crao',
1256                     'wikilens' => 'wikilens (Ratings)',
1257                     'shamino_com' => 'shamino_com',
1258                     'SpaceWiki' => "SpaceWiki",
1259                     'Hawaiian' => "Hawaiian",
1260                     'MonoBook'  => 'MonoBook [experimental]',
1261                     'blog'      => 'blog [experimental]',
1262                     ), "
1263 THEME
1264
1265 Most of the page appearance is controlled by files in the theme
1266 subdirectory.
1267
1268 There are a number of pre-defined themes shipped with PhpWiki.
1269 Or you may create your own, e.g. by copying and then modifying one of
1270 stock themes.
1271 <pre>
1272   THEME = default
1273   THEME = MacOSX
1274   THEME = MonoBook (WikiPedia)
1275   THEME = smaller
1276   THEME = Wordpress
1277   THEME = Portland
1278   THEME = Sidebar
1279   THEME = Crao
1280   THEME = wikilens (with Ratings)
1281   THEME = Hawaiian
1282   THEME = SpaceWiki
1283   THEME = Hawaiian
1284 </pre>
1285
1286 Problems:
1287 <pre>
1288   THEME = blog     (Kubrick)   [experimental. Several links missing]
1289 </pre>");
1290
1291 $properties["Character Set"] =
1292     new _define_optional('CHARSET', 'iso-8859-1');
1293
1294 $properties["Ignore Charset Not Supported Warning"] =
1295     new _define_optional('IGNORE_CHARSET_NOT_SUPPORTED_WARNING');
1296
1297 $properties["Language"] =
1298 new _define_selection_optional('DEFAULT_LANGUAGE',
1299                array('en' => "English",
1300                      ''   => "<empty> (user-specific)",
1301                      'fr' => "Fran~is",
1302                      'de' => "Deutsch",
1303                      'nl' => "Nederlands",
1304                      'es' => "Espa~l",
1305                      'sv' => "Svenska",
1306                      'it' => "Italiano",
1307                      'ja' => "Japanese",
1308                      'zh' => "Chinese"), "
1309 Select your language/locale - default language is \"en\" for English.
1310 Other languages available:<pre>
1311 English \"en\"  (English    - HomePage)
1312 German  \"de\" (Deutsch    - StartSeite)
1313 French  \"fr\" (Fran~is   - Accueil)
1314 Dutch   \"nl\" (Nederlands - ThuisPagina)
1315 Spanish \"es\" (Espa~l    - P~inaPrincipal)
1316 Swedish \"sv\" (Svenska    - Framsida)
1317 Italian \"it\" (Italiano   - PaginaPrincipale)
1318 Japanese \"ja\" (Japanese   - ~~~~~~)
1319 Chinese  \"zh\" (Chinese)
1320 </pre>
1321 If you set DEFAULT_LANGUAGE to the empty string, your systems default language
1322 (as determined by the applicable environment variables) will be
1323 used.");
1324
1325 $properties["Wiki Page Source"] =
1326 new _define_optional('WIKI_PGSRC', 'pgsrc', "
1327 WIKI_PGSRC -- specifies the source for the initial page contents of
1328 the Wiki. The setting of WIKI_PGSRC only has effect when the wiki is
1329 accessed for the first time (or after clearing the database.)
1330 WIKI_PGSRC can either name a directory or a zip file. In either case
1331 WIKI_PGSRC is scanned for files -- one file per page.
1332 <pre>
1333 // Default (old) behavior:
1334 define('WIKI_PGSRC', 'pgsrc');
1335 // New style:
1336 define('WIKI_PGSRC', 'wiki.zip');
1337 define('WIKI_PGSRC',
1338        '../Logs/Hamwiki/hamwiki-20010830.zip');
1339 </pre>");
1340
1341 $properties["Default Wiki Page Source"] =
1342 new _define('DEFAULT_WIKI_PGSRC', 'pgsrc', "
1343 DEFAULT_WIKI_PGSRC is only used when the language is *not* the
1344 default (English) and when reading from a directory: in that case
1345 some English pages are inserted into the wiki as well.
1346 DEFAULT_WIKI_PGSRC defines where the English pages reside.
1347 ");
1348
1349 $properties["Generic Pages"] =
1350 new array_variable('DEFAULT_WIKI_PAGES', array('ReleaseNotes', 'SteveWainstead', 'TestPage'), "
1351 These are ':'-seperated pages which will get loaded untranslated from DEFAULT_WIKI_PGSRC.
1352 ");
1353
1354 ///////////////////
1355
1356 $properties["Part Five"] =
1357 new part('_part5', $SEPARATOR."\n", "
1358
1359 Part Five:
1360 Mark-up options");
1361
1362 $properties["Allowed Protocols"] =
1363 new list_define('ALLOWED_PROTOCOLS', 'http|https|mailto|ftp|news|nntp|ssh|gopher', "
1364 Allowed protocols for links - be careful not to allow \"javascript:\"
1365 URL of these types will be automatically linked.
1366 within a named link [name|uri] one more protocol is defined: phpwiki");
1367
1368 $properties["Inline Images"] =
1369     new list_define('INLINE_IMAGES', 'png|jpg|gif');
1370
1371 $properties["WikiName Regexp"] =
1372 new _define('WIKI_NAME_REGEXP', "(?<![[:alnum:]])(?:[[:upper:]][[:lower:]]+){2,}(?![[:alnum:]])", "
1373 Perl regexp for WikiNames (\"bumpy words\")
1374 (?&lt;!..) &amp; (?!...) used instead of '\b' because \b matches '_' as well");
1375
1376 $properties["Subpage Separator"] =
1377 new _define_optional('SUBPAGE_SEPARATOR', '"/"', "
1378 One character which seperates pages from subpages. Defaults to '/', but '.' or ':' were also used.",
1379 "onchange=\"validate_ereg('Sorry, \'%s\' must be a single character. Currently only :, / or .', '^[/:.]$', 'SUBPAGE_SEPARATOR', this);\""
1380 );
1381
1382 $properties["InterWiki Map File"] =
1383 new _define('INTERWIKI_MAP_FILE', 'lib/interwiki.map', "
1384 InterWiki linking -- wiki-style links to other wikis on the web
1385
1386 The map will be taken from a page name InterWikiMap.
1387 If that page is not found (or is not locked), or map
1388 data can not be found in it, then the file specified
1389 by INTERWIKI_MAP_FILE (if any) will be used.");
1390
1391 $properties["WARN_NONPUBLIC_INTERWIKIMAP"] =
1392 new boolean_define('WARN_NONPUBLIC_INTERWIKIMAP');
1393
1394 $properties["Keyword Link Regexp"] =
1395 new _define_optional('KEYWORDS', '\"Category* OR Topic*\"', "
1396 Search term used for automatic page classification by keyword extraction.
1397
1398 Any links on a page to pages whose names match this search
1399 will be used keywords in the keywords html meta tag. This is an aid to
1400 classification by search engines. The value of the match is
1401 used as the keyword.
1402
1403 The default behavior is to match Category* or Topic* links.");
1404
1405 $properties["Author and Copyright Site Navigation Links"] =
1406 new _define_commented_optional('COPYRIGHTPAGE_TITLE', "GNU General Public License", "
1407
1408 These will be inserted as <link rel> tags in the html header of
1409 every page, for search engines and for browsers like Mozilla which
1410 take advantage of link rel site navigation.
1411
1412 If you have your own copyright and contact information pages change
1413 these as appropriate.");
1414
1415 $properties["COPYRIGHTPAGE URL"] =
1416 new _define_commented_optional('COPYRIGHTPAGE_URL', "http://www.gnu.org/copyleft/gpl.html#SEC1", "
1417
1418 Other useful alternatives to consider:
1419 <pre>
1420  COPYRIGHTPAGE_TITLE = \"GNU Free Documentation License\"
1421  COPYRIGHTPAGE_URL = \"http://www.gnu.org/copyleft/fdl.html\"
1422  COPYRIGHTPAGE_TITLE = \"Creative Commons License 2.0\"
1423  COPYRIGHTPAGE_URL = \"http://creativecommons.org/licenses/by/2.0/\"</pre>
1424 See http://creativecommons.org/learn/licenses/ for variations");
1425
1426 $properties["AUTHORPAGE_TITLE"] =
1427     new _define_commented_optional('AUTHORPAGE_TITLE', "The PhpWiki Programming Team", "
1428 Default Author Names");
1429 $properties["AUTHORPAGE_URL"] =
1430     new _define_commented_optional('AUTHORPAGE_URL', "http://phpwiki.org/ThePhpWikiProgrammingTeam", "
1431 Default Author URL");
1432
1433 $properties["TOC_FULL_SYNTAX"] =
1434 new boolean_define_optional('TOC_FULL_SYNTAX');
1435
1436 $properties["ENABLE_MARKUP_COLOR"] =
1437 new boolean_define_optional('ENABLE_MARKUP_COLOR');
1438
1439 $properties["ENABLE_MARKUP_TEMPLATE"] =
1440 new boolean_define_optional('ENABLE_MARKUP_TEMPLATE');
1441
1442 $properties["DISABLE_MARKUP_WIKIWORD"] =
1443 new boolean_define_optional('DISABLE_MARKUP_WIKIWORD');
1444
1445 $properties["ENABLE_MARKUP_DIVSPAN" ] =
1446 new boolean_define_optional('ENABLE_MARKUP_DIVSPAN');
1447
1448 ///////////////////
1449
1450 $properties["Part Six"] =
1451 new part('_part6', $SEPARATOR."\n", "
1452
1453 Part Six (optional):
1454 URL options -- you can probably skip this section.
1455
1456 For a pretty wiki (no index.php in the url) set a seperate DATA_PATH.");
1457
1458 $properties["Server Name"] =
1459     new _define_commented_optional('SERVER_NAME', $_SERVER['SERVER_NAME'], "
1460 Canonical name of the server on which this PhpWiki resides.");
1461
1462 $properties["Server Port"] =
1463     new numeric_define_commented('SERVER_PORT', $_SERVER['SERVER_PORT'], "
1464 Canonical httpd port of the server on which this PhpWiki resides.",
1465 "onchange=\"validate_ereg('Sorry, \'%s\' is no valid port number.', '^[0-9]+$', 'SERVER_PORT', this);\"");
1466
1467 $properties["Server Protocol"] =
1468     new _define_selection_optional_commented('SERVER_PROTOCOL',
1469                     array('http'  => 'http',
1470                           'https' => 'https'));
1471
1472 $properties["Script Name"] =
1473     new _define_commented_optional('SCRIPT_NAME', $scriptname);
1474
1475 $properties["Data Path"] =
1476     new _define_commented_optional('DATA_PATH', dirname($scriptname));
1477
1478 $properties["PhpWiki Install Directory"] =
1479 new _define_commented_optional('PHPWIKI_DIR', dirname(__FILE__));
1480
1481 $properties["Use PATH_INFO"] =
1482 new _define_selection_optional_commented('USE_PATH_INFO',
1483                     array(''      => 'automatic',
1484                           'true'  => 'use PATH_INFO',
1485                           'false' => 'do not use PATH_INFO'), "
1486 PhpWiki will try to use short urls to pages, eg
1487 http://www.example.com/index.php/HomePage
1488 If you want to use urls like
1489 http://www.example.com/index.php?pagename=HomePage
1490 then define 'USE_PATH_INFO' as false by uncommenting the line below.
1491 NB:  If you are using Apache >= 2.0.30, then you may need to to use
1492 the directive \"AcceptPathInfo On\" in your Apache configuration file
1493 (or in an appropriate <.htaccess> file) for the short urls to work:
1494 See http://httpd.apache.org/docs-2.0/mod/core.html#acceptpathinfo
1495
1496 See also http://phpwiki.sourceforge.net/phpwiki/PrettyWiki for more ideas
1497 on prettifying your urls.
1498
1499 Default: PhpWiki will try to divine whether use of PATH_INFO
1500 is supported in by your webserver/PHP configuration, and will
1501 use PATH_INFO if it thinks that is possible.");
1502
1503 $properties["Virtual Path"] =
1504 new _define_commented_optional('VIRTUAL_PATH', '/SomeWiki', "
1505 VIRTUAL_PATH is the canonical URL path under which your your wiki
1506 appears. Normally this is the same as dirname(SCRIPT_NAME), however
1507 using e.g. seperate starter scripts, apaches mod_actions (or mod_rewrite),
1508 you can make it something different.
1509
1510 If you do this, you should set VIRTUAL_PATH here or in the starter scripts.
1511
1512 E.g. your phpwiki might be installed at at /scripts/phpwiki/index.php,
1513 but you've made it accessible through eg. /wiki/HomePage.
1514
1515 One way to do this is to create a directory named 'wiki' in your
1516 server root. The directory contains only one file: an .htaccess
1517 file which reads something like:
1518 <pre>
1519     Action x-phpwiki-page /scripts/phpwiki/index.php
1520     SetHandler x-phpwiki-page
1521     DirectoryIndex /scripts/phpwiki/index.php
1522 </pre>
1523 In that case you should set VIRTUAL_PATH to '/wiki'.
1524
1525 (VIRTUAL_PATH is only used if USE_PATH_INFO is true.)
1526 ");
1527
1528 $temp = !empty($_ENV['TEMP']) ? $_ENV['TEMP'] : "/tmp";
1529 $properties["TEMP_DIR"] =
1530 new _define_optional('TEMP_DIR', $temp);
1531
1532 ///////////////////
1533
1534 $properties["Part Seven"] =
1535 new part('_part7', $SEPARATOR."\n", "
1536
1537 Part Seven:
1538
1539 Miscellaneous settings
1540 ");
1541
1542 $properties["Strict Mailable Pagedumps"] =
1543     new boolean_define_optional('STRICT_MAILABLE_PAGEDUMPS',
1544      array('false' => "binary",
1545            'true'  => "quoted-printable"));
1546
1547 $properties["Default local Dump Directory"] =
1548     new _define_optional('DEFAULT_DUMP_DIR');
1549
1550 $properties["Default local HTML Dump Directory"] =
1551     new _define_optional('HTML_DUMP_DIR');
1552
1553 $properties["HTML Dump Filename Suffix"] =
1554     new _define_optional('HTML_DUMP_SUFFIX');
1555
1556 $properties["Pagename of Recent Changes"] =
1557     new _define_optional('RECENT_CHANGES',
1558                          "RecentChanges");
1559
1560 $properties["Disable HTTP Redirects"] =
1561     new boolean_define_commented_optional('DISABLE_HTTP_REDIRECT');
1562
1563 $properties["Disable GETIMAGESIZE"] =
1564     new boolean_define_commented_optional('DISABLE_GETIMAGESIZE');
1565
1566 $properties["EDITING_POLICY"] =
1567     new _define_optional('EDITING_POLICY');
1568
1569 $properties["TOOLBAR_PAGELINK_PULLDOWN"] =
1570     new _define_commented_optional('TOOLBAR_PAGELINK_PULLDOWN');
1571 $properties["TOOLBAR_TEMPLATE_PULLDOWN"] =
1572     new _define_commented_optional('TOOLBAR_TEMPLATE_PULLDOWN');
1573 $properties["FULLTEXTSEARCH_STOPLIST"] =
1574     new _define_commented_optional('FULLTEXTSEARCH_STOPLIST');
1575
1576 $properties["Part Seven A"] =
1577     new part('_part7a', $SEPARATOR."\n", "
1578
1579 Part Seven A:
1580
1581 Optional Plugin Settings and external executables
1582 ");
1583
1584 $properties["FORTUNE_DIR"] =
1585   new _define_commented_optional('FORTUNE_DIR', "/usr/share/fortune");
1586 $properties["USE_EXTERNAL_HTML2PDF"] =
1587     new _define_commented_optional('USE_EXTERNAL_HTML2PDF', "htmldoc --quiet --format pdf14 --no-toc --no-title %s");
1588 $properties["BABYCART_PATH"] =
1589     new _define_commented_optional('BABYCART_PATH', "/usr/local/bin/babycart");
1590 $properties["GOOGLE_LICENSE_KEY"] =
1591   new _define_commented_optional('GOOGLE_LICENSE_KEY');
1592 $properties["RATEIT_IMGPREFIX"] =
1593     new _define_commented_optional('RATEIT_IMGPREFIX'); //BStar
1594 $properties["GRAPHVIZ_EXE"] =
1595     new _define_commented_optional('GRAPHVIZ_EXE'); // /usr/local/bin/dot
1596 $properties["VISUALWIKIFONT"] =
1597     new _define_commented_optional('VISUALWIKIFONT'); // Arial
1598 $properties["VISUALWIKI_ALLOWOPTIONS"] =
1599     new boolean_define_commented_optional('VISUALWIKI_ALLOWOPTIONS'); // false
1600 $properties["PLOTICUS_EXE"] =
1601     new _define_commented_optional('PLOTICUS_EXE'); // /usr/local/bin/pl
1602 $properties["PLOTICUS_PREFABS"] =
1603     new _define_commented_optional('PLOTICUS_PREFABS'); // /usr/share/ploticus
1604 $properties["MY_JABBER_ID"] =
1605     new _define_commented_optional('MY_JABBER_ID'); //
1606 $properties["PHPWEATHER_BASE_DIR"] =
1607     new _define_commented_optional('PHPWEATHER_BASE_DIR'); //
1608 $properties["HIGHLIGHT_EXE"] =
1609     new _define_commented_optional('HIGHLIGHT_EXE'); // /usr/local/bin/highlight
1610 $properties["HIGHLIGHT_DATA_DIR"] =
1611     new _define_commented_optional('HIGHLIGHT_DATA_DIR'); // /usr/share/highlight
1612
1613
1614 $properties["Part Eight"] =
1615 new part('_part8', $SEPARATOR."\n", "
1616
1617 Part Eight:
1618
1619 Cached Plugin Settings. (pear Cache)
1620 ");
1621
1622 $properties["pear Cache USECACHE"] =
1623 new boolean_define_optional('PLUGIN_CACHED_USECACHE',
1624                     array('true'  => 'Enabled',
1625                           'false' => 'Disabled'), "
1626 Enable or disable pear caching of plugins.");
1627 $properties["pear Cache Database Container"] =
1628 new _define_selection_optional('PLUGIN_CACHED_DATABASE',
1629                                array('file' => 'file'), "
1630 Curently only file is supported.
1631 db, trifile and imgfile might be supported, but you must hack that by yourself.");
1632
1633 $properties["pear Cache cache directory"] =
1634 new _define_commented_optional('PLUGIN_CACHED_CACHE_DIR', "/tmp/cache", "
1635 Should be writable to the webserver.");
1636 $properties["pear Cache Filename Prefix"] =
1637 new _define_optional('PLUGIN_CACHED_FILENAME_PREFIX', "phpwiki", "");
1638 $properties["pear Cache HIGHWATER"] =
1639 new numeric_define_optional('PLUGIN_CACHED_HIGHWATER', "4194304", "
1640 Garbage collection parameter.");
1641 $properties["pear Cache LOWWATER"] =
1642 new numeric_define_optional('PLUGIN_CACHED_LOWWATER', "3145728", "
1643 Garbage collection parameter.");
1644 $properties["pear Cache MAXLIFETIME"] =
1645 new numeric_define_optional('PLUGIN_CACHED_MAXLIFETIME', "2592000", "
1646 Garbage collection parameter.");
1647 $properties["pear Cache MAXARGLEN"] =
1648 new numeric_define_optional('PLUGIN_CACHED_MAXARGLEN', "1000", "
1649 max. generated url length.");
1650 $properties["pear Cache FORCE_SYNCMAP"] =
1651 new boolean_define_optional('PLUGIN_CACHED_FORCE_SYNCMAP',
1652                     array('true'  => 'Enabled',
1653                           'false' => 'Disabled'), "");
1654 $properties["pear Cache IMGTYPES"] =
1655 new list_define('PLUGIN_CACHED_IMGTYPES', "png|gif|gd|gd2|jpeg|wbmp|xbm|xpm", "
1656 Handle those image types via GD handles. Check your GD supported image types.");
1657
1658 $end = "\n".$SEPARATOR."\n";
1659
1660 // performance hack
1661 text_from_dist("_MAGIC_CLOSE_FILE");
1662
1663 // end of configuration options
1664 ///////////////////////////////
1665 // begin class definitions
1666
1667 /**
1668  * A basic config-dist.ini configuration line in the form of a variable.
1669  * (not needed anymore, we have only defines)
1670  *
1671  * Produces a string in the form "$name = value;"
1672  * e.g.:
1673  * $WikiNameRegexp = "value";
1674  */
1675 class _variable {
1676
1677     var $config_item_name;
1678     var $default_value;
1679     var $description;
1680     var $prefix;
1681     var $jscheck;
1682
1683     function _variable($config_item_name, $default_value, $description = '', $jscheck = '') {
1684         $this->config_item_name = $config_item_name;
1685         if (!$description)
1686             $description = text_from_dist($config_item_name);
1687         $this->description = $description;
1688         if (defined($config_item_name)
1689             and !preg_match("/(selection|boolean)/", get_class($this))
1690             and !preg_match("/^(SCRIPT_NAME|VIRTUAL_PATH|TEMP_DIR)$/", $config_item_name))
1691             $this->default_value = constant($config_item_name); // ignore given default value
1692         elseif ($config_item_name == $default_value)
1693             $this->default_value = '';
1694         else
1695             $this->default_value = $default_value;
1696         $this->jscheck = $jscheck;
1697         if (preg_match("/variable/i", get_class($this)))
1698             $this->prefix = "\$";
1699         elseif (preg_match("/ini_set/i", get_class($this)))
1700             $this->prefix = "ini_get: ";
1701         else
1702             $this->prefix = "";
1703     }
1704
1705     function value() {
1706       global $HTTP_POST_VARS;
1707       if (isset($HTTP_POST_VARS[$this->config_item_name]))
1708           return $HTTP_POST_VARS[$this->config_item_name];
1709       else
1710           return $this->default_value;
1711     }
1712
1713     function _config_format($value) {
1714         return '';
1715         $v = $this->get_config_item_name();
1716         // handle arrays: a|b --> a['b']
1717         if (strpos($v, '|')) {
1718             list($a, $b) = explode('|', $v);
1719             $v = sprintf("%s['%s']", $a, $b);
1720         }
1721         if (preg_match("/[\"']/", $value))
1722             $value = '"' . $value . '"';
1723         return sprintf("%s = \"%s\"", $v, $value);
1724     }
1725
1726     function get_config_item_name() {
1727         return $this->config_item_name;
1728     }
1729
1730     function get_config_item_id() {
1731         return str_replace('|', '-', $this->config_item_name);
1732     }
1733
1734     function get_config_item_header() {
1735        if (strchr($this->config_item_name,'|')) {
1736           list($var,$param) = explode('|',$this->config_item_name);
1737           return "<b>" . $this->prefix . $var . "['" . $param . "']</b><br />";
1738        }
1739        elseif ($this->config_item_name[0] != '_')
1740           return "<b>" . $this->prefix . $this->config_item_name . "</b><br />";
1741        else
1742           return '';
1743     }
1744
1745     function _get_description() {
1746         return $this->description;
1747     }
1748
1749     function _get_config_line($posted_value) {
1750         return "\n" . $this->_config_format($posted_value);
1751     }
1752
1753     function get_config($posted_value) {
1754         $d = stripHtml($this->_get_description());
1755         $d = str_replace("\n", "\n; ", $d) . $this->_get_config_line($posted_value) ."\n";
1756         return $d;
1757     }
1758
1759     function get_instructions($title) {
1760         global $tdwidth;
1761         $i = "<h3>" . $title . "</h3>\n    " . nl2p($this->_get_description()) . "\n";
1762         return "<tr>\n<td width=\"$tdwidth\" class=\"instructions\">\n" . $i . "</td>\n";
1763     }
1764
1765     function get_html() {
1766         $size = strlen($this->default_value) > 45 ? 90 : 50;
1767         return $this->get_config_item_header() .
1768             "<input type=\"text\" size=\"$50\" name=\"" . $this->get_config_item_name() . "\" value=\"" . htmlspecialchars($this->default_value) . "\" " .
1769             $this->jscheck . " />" . "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
1770     }
1771 }
1772
1773 class unchangeable_variable
1774 extends _variable {
1775     function _config_format($value) {
1776         return "";
1777     }
1778     // function get_html() { return false; }
1779     function get_html() {
1780         return $this->get_config_item_header() .
1781         "<em>Not editable.</em>" .
1782         "<pre>" . $this->default_value."</pre>";
1783     }
1784     function _get_config_line($posted_value) {
1785         if ($this->description)
1786             $n = "\n";
1787         return "${n}".$this->default_value;
1788     }
1789     function get_instructions($title) {
1790         global $tdwidth;
1791         $i = "<h3>" . $title . "</h3>\n    " . nl2p($this->_get_description()) . "\n";
1792         // $i .= "<em>Not editable.</em><br />\n<pre>" . $this->default_value."</pre>";
1793         return '<tr><td width="100%" class="unchangeable-variable-top" colspan="2">'."\n".$i."</td></tr>\n"
1794         . '<tr style="border-top: none;"><td class="unchangeable-variable-left" width="'.$tdwidth.'">&nbsp;</td>';
1795     }
1796 }
1797
1798 class unchangeable_define
1799 extends unchangeable_variable {
1800     function _get_config_line($posted_value) {
1801         if ($this->description)
1802             $n = "\n";
1803         if (!$posted_value)
1804             $posted_value = $this->default_value;
1805         return "${n}".$this->_config_format($posted_value);
1806     }
1807     function _config_format($value) {
1808         return sprintf("%s = \"%s\"", $this->get_config_item_name(), $value);
1809     }
1810 }
1811 class unchangeable_ini_set
1812 extends unchangeable_variable {
1813     function _config_format($value) {
1814         return "";
1815     }
1816 }
1817
1818 class _variable_selection
1819 extends _variable {
1820     function value() {
1821         global $HTTP_POST_VARS;
1822         if (!empty($HTTP_POST_VARS[$this->config_item_name]))
1823             return $HTTP_POST_VARS[$this->config_item_name];
1824         else {
1825             list($option, $label) = each($this->default_value);
1826             return $option;
1827         }
1828     }
1829     function get_html() {
1830         $output = $this->get_config_item_header();
1831         $output .= '<select name="' . $this->get_config_item_name() . "\">\n";
1832         /* The first option is the default */
1833         $values = $this->default_value;
1834         if (defined($this->get_config_item_name()))
1835             $this->default_value = constant($this->get_config_item_name());
1836         else
1837             $this->default_value = null;
1838         while(list($option, $label) = each($values)) {
1839             if (!is_null($this->default_value) and $this->default_value === $option)
1840                 $output .= "  <option value=\"$option\" selected=\"selected\">$label</option>\n";
1841             else
1842                 $output .= "  <option value=\"$option\">$label</option>\n";
1843         }
1844         $output .= "</select>\n";
1845         return $output;
1846     }
1847 }
1848
1849
1850 class _define
1851 extends _variable {
1852     function _config_format($value) {
1853         return sprintf("%s = \"%s\"", $this->get_config_item_name(), $value);
1854     }
1855     function _get_config_line($posted_value) {
1856         if ($this->description)
1857             $n = "\n";
1858         if ($posted_value == '')
1859             return "${n};" . $this->_config_format("");
1860         else
1861             return "${n}" . $this->_config_format($posted_value);
1862     }
1863     function get_html() {
1864         $size = strlen($this->default_value) > 45 ? 90 : 50;
1865         return $this->get_config_item_header()
1866             . "<input type=\"text\" size=\"$size\" name=\"" . htmlentities($this->get_config_item_name())
1867             . "\" value=\"" . htmlentities($this->default_value) . "\" {$this->jscheck} />"
1868             . "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
1869     }
1870 }
1871
1872 class _define_commented
1873 extends _define {
1874     function _get_config_line($posted_value) {
1875         if ($this->description)
1876             $n = "\n";
1877         if ($posted_value == $this->default_value)
1878             return "${n};" . $this->_config_format($posted_value);
1879         elseif ($posted_value == '')
1880             return "${n};" . $this->_config_format("");
1881         else
1882             return "${n}" . $this->_config_format($posted_value);
1883     }
1884 }
1885
1886 /**
1887  * We don't use _optional anymore, because INI-style config's don't need that.
1888  * IniConfig.php does the optional logic now.
1889  * But we use _optional for config-default.ini options
1890  */
1891 class _define_commented_optional
1892 extends _define_commented { }
1893
1894 class _define_optional
1895 extends _define { }
1896
1897 class _define_notempty
1898 extends _define {
1899     function get_html() {
1900         $s = $this->get_config_item_header()
1901             . "<input type=\"text\" size=\"50\" name=\"" . $this->get_config_item_name()
1902             . "\" value=\"" . $this->default_value . "\" {$this->jscheck} />";
1903         if (empty($this->default_value))
1904             return $s . "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: red\">Cannot be empty.</p>";
1905         else
1906             return $s . "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
1907     }
1908 }
1909
1910 class _variable_commented
1911 extends _variable {
1912     function _get_config_line($posted_value) {
1913         if ($this->description)
1914             $n = "\n";
1915         if ($posted_value == $this->default_value)
1916             return "${n};" . $this->_config_format($posted_value);
1917         elseif ($posted_value == '')
1918             return "${n};" . $this->_config_format("");
1919         else
1920             return "${n}" . $this->_config_format($posted_value);
1921     }
1922 }
1923
1924 class numeric_define
1925 extends _define {
1926
1927     function numeric_define($config_item_name, $default_value, $description = '', $jscheck = '') {
1928         $this->_define($config_item_name, $default_value, $description, $jscheck);
1929         if (!$jscheck)
1930             $this->jscheck = "onchange=\"validate_ereg('Sorry, \'%s\' is not an integer.', '^[-+]?[0-9]+$', '" . $this->get_config_item_name() . "', this);\"";
1931     }
1932     function _config_format($value) {
1933         //return sprintf("define('%s', %s);", $this->get_config_item_name(), $value);
1934         return sprintf("%s = %s", $this->get_config_item_name(), $value);
1935     }
1936     function _get_config_line($posted_value) {
1937         if ($this->description)
1938             $n = "\n";
1939         if ($posted_value == '')
1940             return "${n};" . $this->_config_format('0');
1941         else
1942             return "${n}" . $this->_config_format($posted_value);
1943     }
1944 }
1945
1946 class numeric_define_optional
1947 extends numeric_define {}
1948
1949 class numeric_define_commented
1950 extends numeric_define {
1951     function _get_config_line($posted_value) {
1952         if ($this->description)
1953             $n = "\n";
1954         if ($posted_value == $this->default_value)
1955             return "${n};" . $this->_config_format($posted_value);
1956         elseif ($posted_value == '')
1957             return "${n};" . $this->_config_format('0');
1958         else
1959             return "${n}" . $this->_config_format($posted_value);
1960     }
1961 }
1962
1963 class _define_selection
1964 extends _variable_selection {
1965     function _config_format($value) {
1966         return sprintf("%s = %s", $this->get_config_item_name(), $value);
1967     }
1968     function _get_config_line($posted_value) {
1969         return _define::_get_config_line($posted_value);
1970     }
1971     function get_html() {
1972         return _variable_selection::get_html();
1973     }
1974 }
1975
1976 class _define_selection_optional
1977 extends _define_selection { }
1978
1979 class _variable_selection_optional
1980 extends _variable_selection { }
1981
1982 class _define_selection_optional_commented
1983 extends _define_selection_optional {
1984     function _get_config_line($posted_value) {
1985         if ($this->description)
1986             $n = "\n";
1987         if ($posted_value == $this->default_value)
1988             return "${n};" . $this->_config_format($posted_value);
1989         elseif ($posted_value == '')
1990             return "${n};" . $this->_config_format("");
1991         else
1992             return "${n}" . $this->_config_format($posted_value);
1993     }
1994 }
1995
1996 class _define_password
1997 extends _define {
1998
1999     function _define_password($config_item_name, $default_value, $description = '', $jscheck = '') {
2000         if ($config_item_name == $default_value) $default_value = '';
2001         $this->_define($config_item_name, $default_value, $description, $jscheck);
2002         if (!$jscheck)
2003             $this->jscheck = "onchange=\"validate_ereg('Sorry, \'%s\' cannot be empty.', '^.+$', '"
2004                 . $this->get_config_item_name() . "', this);\"";
2005     }
2006     function _get_config_line($posted_value) {
2007         if ($this->description)
2008             $n = "\n";
2009         if ($posted_value == '') {
2010             $p = "${n};" . $this->_config_format("");
2011             $p .= "\n; If you used the passencrypt.php utility to encode the password";
2012             $p .= "\n; then uncomment this line:";
2013             $p .= "\n;ENCRYPTED_PASSWD = true";
2014             return $p;
2015         } else {
2016             if (function_exists('crypt')) {
2017                 $salt_length = max(CRYPT_SALT_LENGTH,
2018                                     2 * CRYPT_STD_DES,
2019                                     9 * CRYPT_EXT_DES,
2020                                    12 * CRYPT_MD5,
2021                                    16 * CRYPT_BLOWFISH);
2022                 // generate an encrypted password
2023                 $crypt_pass = crypt($posted_value, rand_ascii($salt_length));
2024                 $p = "${n}" . $this->_config_format($crypt_pass);
2025                 return $p . "\nENCRYPTED_PASSWD = true";
2026             } else {
2027                 $p = "${n}" . $this->_config_format($posted_value);
2028                 $p .= "\n; Encrypted passwords cannot be used:";
2029                 $p .= "\n; 'function crypt()' not available in this version of php";
2030                 $p .= "\nENCRYPTED_PASSWD = false";
2031                 return $p;
2032             }
2033         }
2034     }
2035     function get_html() {
2036         return _variable_password::get_html();
2037     }
2038 }
2039
2040 class _define_password_optional
2041 extends _define_password {
2042
2043     function _define_password_optional($config_item_name, $default_value, $description = '', $jscheck = '') {
2044         if ($config_item_name == $default_value) $default_value = '';
2045         if (!$jscheck) $this->jscheck = " ";
2046         $this->_define($config_item_name, $default_value, $description, $jscheck);
2047     }
2048
2049     function _get_config_line($posted_value) {
2050         if ($this->description)
2051             $n = "\n";
2052         if ($posted_value == '') {
2053             return "${n};" . $this->_config_format("");
2054         } else {
2055             return "${n}" . $this->_config_format($posted_value);
2056         }
2057     }
2058     function get_html() {
2059         $s = $this->get_config_item_header();
2060         // dont re-encrypt already encrypted passwords
2061         $value = $this->value();
2062         $encrypted = !empty($GLOBALS['properties']["Encrypted Passwords"]) and
2063                      $GLOBALS['properties']["Encrypted Passwords"]->value();
2064         if (empty($value))
2065             $encrypted = false;
2066         $s .= "<input type=\"". ($encrypted ? "text" : "password") . "\" name=\"" . $this->get_config_item_name()
2067            . "\" value=\"" . $value . "\" {$this->jscheck} />";
2068         return $s;
2069     }
2070 }
2071
2072 class _define_password_commented_optional
2073 extends _define_password_optional { }
2074
2075 class _variable_password
2076 extends _variable {
2077     function _variable_password($config_item_name, $default_value, $description = '', $jscheck = '') {
2078         if ($config_item_name == $default_value) $default_value = '';
2079         $this->_define($config_item_name, $default_value, $description, $jscheck);
2080         if (!$jscheck)
2081             $this->jscheck = "onchange=\"validate_ereg('Sorry, \'%s\' cannot be empty.', '^.+$', '" . $this->get_config_item_name() . "', this);\"";
2082     }
2083     function get_html() {
2084         global $HTTP_POST_VARS, $HTTP_GET_VARS;
2085         $s = $this->get_config_item_header();
2086         if (isset($HTTP_POST_VARS['create']) or isset($HTTP_GET_VARS['create'])) {
2087             $new_password = random_good_password();
2088             $this->default_value = $new_password;
2089             $s .= "Created password: <strong>$new_password</strong><br />&nbsp;<br />";
2090         }
2091         // dont re-encrypt already encrypted passwords
2092         $value = $this->value();
2093         $encrypted = !empty($GLOBALS['properties']["Encrypted Passwords"]) and
2094                      $GLOBALS['properties']["Encrypted Passwords"]->value();
2095         if (empty($value))
2096             $encrypted = false;
2097         $s .= "<input type=\"". ($encrypted ? "text" : "password") . "\" name=\"" . $this->get_config_item_name()
2098            . "\" value=\"" . $value . "\" {$this->jscheck} />"
2099            . "&nbsp;&nbsp;<input type=\"submit\" name=\"create\" value=\"Create Random Password\" />";
2100         if (empty($value))
2101             $s .= "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: red\">Cannot be empty.</p>";
2102         elseif (strlen($this->default_value) < 4)
2103             $s .= "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: red\">Must be longer than 4 chars.</p>";
2104         else
2105             $s .= "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
2106         return $s;
2107     }
2108 }
2109
2110 class list_variable
2111 extends _variable {
2112     function _get_config_line($posted_value) {
2113         // split the phrase by any number of commas or space characters,
2114         // which include " ", \r, \t, \n and \f
2115         $list_values = preg_split("/[\s,]+/", $posted_value, -1, PREG_SPLIT_NO_EMPTY);
2116         $list_values = join("|", $list_values);
2117         return _variable::_get_config_line($list_values);
2118     }
2119     function get_html() {
2120         $list_values = explode("|", $this->default_value);
2121         $rows = max(3, count($list_values) +1);
2122         $list_values = join("\n", $list_values);
2123         $ta = $this->get_config_item_header();
2124         $ta .= "<textarea cols=\"18\" rows=\"". $rows ."\" name=\"".$this->get_config_item_name()."\" {$this->jscheck}>";
2125         $ta .= $list_values . "</textarea>";
2126         $ta .= "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
2127         return $ta;
2128     }
2129 }
2130
2131 class list_define
2132 extends _define {
2133     function _get_config_line($posted_value) {
2134         $list_values = preg_split("/[\s,]+/", $posted_value, -1, PREG_SPLIT_NO_EMPTY);
2135         $list_values = join("|", $list_values);
2136         return _variable::_get_config_line($list_values);
2137     }
2138     function get_html() {
2139         $list_values = explode("|", $this->default_value);
2140         $rows = max(3, count($list_values) +1);
2141         $list_values = join("\n", $list_values);
2142         $ta = $this->get_config_item_header();
2143         $ta .= "<textarea cols=\"18\" rows=\"". $rows ."\" name=\"".$this->get_config_item_name()."\" {$this->jscheck}>";
2144         $ta .= $list_values . "</textarea>";
2145         $ta .= "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
2146         return $ta;
2147     }
2148 }
2149
2150 class array_variable
2151 extends _variable {
2152     function _config_format($value) {
2153         return sprintf("%s = \"%s\"", $this->get_config_item_name(),
2154                        is_array($value) ? join(':', $value) : $value);
2155     }
2156     function _get_config_line($posted_value) {
2157         // split the phrase by any number of commas or space characters,
2158         // which include " ", \r, \t, \n and \f
2159         $list_values = preg_split("/[\s,]+/", $posted_value, -1, PREG_SPLIT_NO_EMPTY);
2160         if (!empty($list_values)) {
2161             $list_values = "'".join("', '", $list_values)."'";
2162             return "\n" . $this->_config_format($list_values);
2163         } else
2164             return "\n;" . $this->_config_format('');
2165     }
2166     function get_html() {
2167         $list_values = join("\n", $this->default_value);
2168         $rows = max(3, count($this->default_value) +1);
2169         $ta = $this->get_config_item_header();
2170         $ta .= "<textarea cols=\"18\" rows=\"". $rows ."\" name=\"".$this->get_config_item_name()."\" {$this->jscheck}>";
2171         $ta .= $list_values . "</textarea>";
2172         $ta .= "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
2173         return $ta;
2174     }
2175 }
2176
2177 class array_define
2178 extends _define {
2179     function _config_format($value) {
2180         return sprintf("%s = \"%s\"", $this->get_config_item_name(),
2181                        is_array($value) ? join(' : ', $value) : $value);
2182     }
2183     function _get_config_line($posted_value) {
2184         // split the phrase by any number of commas or space characters,
2185         // which include " ", \r, \t, \n and \f
2186         $list_values = preg_split("/[\s,:]+/", $posted_value, -1, PREG_SPLIT_NO_EMPTY);
2187         if (!empty($list_values)) {
2188             $list_values = join(" : ", $list_values);
2189             return "\n" . $this->_config_format($list_values);
2190         } else
2191             return "\n;" . $this->_config_format('');
2192     }
2193     function get_html () {
2194         if (!$this->default_value)
2195             $this->default_value = array();
2196         elseif (is_string($this->default_value))
2197             $this->default_value = preg_split("/[\s,:]+/", $this->default_value, -1, PREG_SPLIT_NO_EMPTY);
2198         $list_values = join(" : \n", $this->default_value);
2199         $rows = max(3, count($this->default_value) + 1);
2200         $ta = $this->get_config_item_header();
2201         $ta .= "<textarea cols=\"18\" rows=\"". $rows ."\" name=\"".$this->get_config_item_name()."\" {$this->jscheck}>";
2202         $ta .= $list_values . "</textarea>";
2203         $ta .= "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
2204         return $ta;
2205     }
2206 }
2207
2208 /*
2209 class _ini_set
2210 extends _variable {
2211     function value() {
2212         global $HTTP_POST_VARS;
2213         if ($v = $HTTP_POST_VARS[$this->config_item_name])
2214             return $v;
2215         else {
2216             return ini_get($this->get_config_item_name);
2217         }
2218     }
2219     function _config_format($value) {
2220         return sprintf("ini_set('%s', '%s');", $this->get_config_item_name(), $value);
2221     }
2222     function _get_config_line($posted_value) {
2223         if ($posted_value && ! $posted_value == $this->default_value)
2224             return "\n" . $this->_config_format($posted_value);
2225         else
2226             return "\n;" . $this->_config_format($this->default_value);
2227     }
2228 }
2229 */
2230
2231 class boolean_define
2232 extends _define {
2233
2234     // adds ->values property, instead of ->default_value
2235     function boolean_define($config_item_name, $values = false, $description = '', $jscheck = '') {
2236         $this->config_item_name = $config_item_name;
2237         if (!$description)
2238             $description = text_from_dist($config_item_name);
2239         $this->description = $description;
2240         // TESTME: get boolean default value from config-default.ini
2241         if (defined($config_item_name))
2242             $this->default_value = constant($config_item_name); // ignore given default value
2243         elseif (is_array($values))
2244             list($this->default_value,$dummy) = $values[0];
2245         if (!$values)
2246             $values = array('false' => "Disabled",
2247                             'true'  => "Enabled");
2248         $this->values  = $values;
2249         $this->jscheck = $jscheck;
2250         $this->prefix = "";
2251     }
2252     function _get_config_line($posted_value) {
2253         if ($this->description)
2254             $n = "\n";
2255         return "${n}" . $this->_config_format($posted_value);
2256     }
2257     function _config_format($value) {
2258         if (strtolower(trim($value)) == 'false')
2259             $value = false;
2260         return sprintf("%s = %s", $this->get_config_item_name(),
2261                        (bool)$value ? 'true' : 'false');
2262     }
2263     //TODO: radiobuttons, no list
2264     function get_html() {
2265         $output = $this->get_config_item_header();
2266         $name = $this->get_config_item_name();
2267         $output .= '<select name="' . $name . "\" {$this->jscheck}>\n";
2268         $values = $this->values;
2269         $default_value = $this->default_value ? 'true' : 'false';
2270         /* There can usually only be two options, there can be
2271          * three options in the case of a boolean_define_commented_optional */
2272         while (list($option, $label) = each($values)) {
2273             if (!is_null($this->default_value) and $option === $default_value)
2274                 $output .= "  <option value=\"$option\" selected=\"selected\">$label</option>\n";
2275             else
2276                 $output .= "  <option value=\"$option\">$label</option>\n";
2277         }
2278         $output .= "</select>\n";
2279         return $output;
2280     }
2281 }
2282
2283 class boolean_define_optional
2284 extends boolean_define {}
2285
2286 class boolean_define_commented
2287 extends boolean_define {
2288     function _get_config_line($posted_value) {
2289         if ($this->description)
2290             $n = "\n";
2291         list($default_value, $label) = each($this->default_value);
2292         if ($posted_value == $default_value)
2293             return "${n};" . $this->_config_format($posted_value);
2294         elseif ($posted_value == '')
2295             return "${n};" . $this->_config_format('false');
2296         else
2297             return "${n}" . $this->_config_format($posted_value);
2298     }
2299 }
2300
2301 class boolean_define_commented_optional
2302 extends boolean_define_commented {}
2303
2304 class part
2305 extends _variable {
2306     function value () { return; }
2307     function get_config($posted_value) {
2308         $d = stripHtml($this->_get_description());
2309         global $SEPARATOR;
2310         return "\n".$SEPARATOR . str_replace("\n", "\n; ", $d) ."\n".$this->default_value;
2311     }
2312     function get_instructions($title) {
2313         $id = preg_replace("/\W/","",$this->config_item_name);
2314         $group_name = preg_replace("/\W/","",$title);
2315         $i = "<tr class=\"header\" id=\"$id\">\n<td class=\"part\" width=\"100%\" colspan=\"2\" bgcolor=\"#eeeeee\">\n";
2316         $i .= "<h2>" . $title . "</h2>\n    " . nl2p($this->_get_description()) ."\n";
2317         $i .= "<p><a href=\"javascript:toggle_group('$id')\" id=\"{$id}_text\">Hide options.</a></p>";
2318         return  $i ."</td>\n";
2319     }
2320     function get_html() {
2321         return "";
2322     }
2323 }
2324
2325 // html utility functions
2326 function nl2p($text) {
2327   preg_match_all("@\s*(<pre>.*?</pre>|<dl>.*?</dl>|.*?(?=\n\n|<pre>|<dl>|$))@s",
2328                  $text, $m, PREG_PATTERN_ORDER);
2329
2330   $text = '';
2331   foreach ($m[1] as $par) {
2332     if (!($par = trim($par)))
2333       continue;
2334     if (!preg_match('/^<(pre|dl)>/', $par))
2335       $par = "<p>$par</p>";
2336     $text .= $par;
2337   }
2338   return $text;
2339 }
2340
2341 function text_from_dist($var) {
2342     static $distfile = 0;
2343     static $f;
2344
2345     if (!$distfile) {
2346         $sep = (substr(PHP_OS,0,3) == 'WIN' ? '\\' : '/');
2347         $distfile = dirname(__FILE__) . $sep . "config" . $sep . "config-dist.ini";
2348         $f = fopen($distfile, "r");
2349     }
2350     if ($var == '_MAGIC_CLOSE_FILE') {
2351         fclose($f);
2352         return;
2353     }
2354     // if all vars would be in natural order as in the config-dist this would not be needed.
2355     fseek($f, 0);
2356     $par = "\n";
2357     while (!feof($f)) {
2358         $s = fgets($f);
2359         if (preg_match("/^; \w/", $s)) {
2360             $par .= (substr($s,2) . " ");
2361         } elseif (preg_match("/^;\s*$/", $s)) {
2362             $par .= "\n\n";
2363         }
2364         if (preg_match("/^;?".preg_quote($var)."\s*=/", $s))
2365             return $par;
2366         if (preg_match("/^\s*$/", $s)) // new paragraph
2367             $par = "\n";
2368     }
2369     return '';
2370 }
2371
2372 function stripHtml($text) {
2373         $d = str_replace("<pre>", "", $text);
2374         $d = str_replace("</pre>", "", $d);
2375         $d = str_replace("<dl>", "", $d);
2376         $d = str_replace("</dl>", "", $d);
2377         $d = str_replace("<dt>", "", $d);
2378         $d = str_replace("</dt>", "", $d);
2379         $d = str_replace("<dd>", "", $d);
2380         $d = str_replace("</dd>", "", $d);
2381         $d = str_replace("<p>", "", $d);
2382         $d = str_replace("</p>", "", $d);
2383         //restore html entities into characters
2384         // http://www.php.net/manual/en/function.htmlentities.php
2385         $trans = get_html_translation_table (HTML_ENTITIES);
2386         $trans = array_flip ($trans);
2387         $d = strtr($d, $trans);
2388         return $d;
2389 }
2390
2391 include_once(dirname(__FILE__)."/lib/stdlib.php");
2392
2393 ////
2394 // Function to create better user passwords (much larger keyspace),
2395 // suitable for user passwords.
2396 // Sequence of random ASCII numbers, letters and some special chars.
2397 // Note: There exist other algorithms for easy-to-remember passwords.
2398 function random_good_password ($minlength = 5, $maxlength = 8) {
2399   $newpass = '';
2400   // assume ASCII ordering (not valid on EBCDIC systems!)
2401   $valid_chars = "!#%&+-.0123456789=@ABCDEFGHIJKLMNOPQRSTUVWXYZ_abcdefghijklmnopqrstuvwxyz";
2402   $start = ord($valid_chars);
2403   $end   = ord(substr($valid_chars,-1));
2404   better_srand();
2405   if (function_exists('mt_rand')) // mersenne twister
2406       $length = mt_rand($minlength, $maxlength);
2407   else  // the usually bad glibc rand()
2408       $length = rand($minlength, $maxlength);
2409   while ($length > 0) {
2410       if (function_exists('mt_rand'))
2411           $newchar = mt_rand($start, $end);
2412       else
2413           $newchar = rand($start, $end);
2414       if (! strrpos($valid_chars,$newchar) ) continue; // skip holes
2415       $newpass .= sprintf("%c", $newchar);
2416       $length--;
2417   }
2418   return($newpass);
2419 }
2420
2421 // debugging
2422 function printArray($a) {
2423     echo "<hr />\n<pre>\n";
2424     print_r($a);
2425     echo "\n</pre>\n<hr />\n";
2426 }
2427
2428 // end of class definitions
2429 /////////////////////////////
2430 // begin auto generation code
2431
2432 if (!function_exists('is_a')) {
2433   function is_a($object, $class) {
2434     $class = strtolower($class);
2435     return (get_class($object) == $class) or is_subclass_of($object, $class);
2436   }
2437 }
2438
2439
2440 if (!empty($HTTP_POST_VARS['action'])
2441     and $HTTP_POST_VARS['action'] == 'make_config'
2442     and !empty($HTTP_POST_VARS['ADMIN_USER'])
2443     and !empty($HTTP_POST_VARS['ADMIN_PASSWD'])
2444     )
2445 {
2446
2447     $timestamp = date ('dS of F, Y H:i:s');
2448
2449     $config = "
2450 ; This is a local configuration file for PhpWiki.
2451 ; It was automatically generated by the configurator script
2452 ; on the $timestamp.
2453 ;
2454 ; $preamble
2455 ";
2456
2457     $posted = $GLOBALS['HTTP_POST_VARS'];
2458     /*if (defined('DEBUG'))
2459      printArray($GLOBALS['HTTP_POST_VARS']);*/
2460
2461     foreach ($properties as $option_name => $a) {
2462         $posted_value = stripslashes($posted[$a->config_item_name]);
2463         $config .= $properties[$option_name]->get_config($posted_value);
2464     }
2465
2466     $config .= $end;
2467
2468     if (is_writable($fs_config_file)) {
2469       // We first check if the config-file exists.
2470       if (file_exists($fs_config_file)) {
2471         // We make a backup copy of the file
2472         $new_filename = preg_replace('/\.ini$/', '-' . time() . '.ini', $fs_config_file);
2473         if (@copy($fs_config_file, $new_filename)) {
2474             $fp = @fopen($fs_config_file, 'w');
2475         }
2476       } else {
2477         $fp = @fopen($fs_config_file, 'w');
2478       }
2479     }
2480     else {
2481       $fp = false;
2482     }
2483
2484     if ($fp) {
2485         fputs($fp, $config);
2486         fclose($fp);
2487         echo "<p>The configuration was written to <code><b>$config_file</b></code>.</p>\n";
2488         if ($new_filename) {
2489             echo "<p>A backup was made to <code><b>$new_filename</b></code>.</p>\n";
2490         } else {
2491             ; //echo "<p><strong>You must rename or copy this</strong> <code><b>$config_file</b></code> <strong>file to</strong> <code><b>config/config.ini</b></code>.</p>\n";
2492         }
2493     } else {
2494         echo "<p>The configuration file could <b>not</b> be written.<br />\n",
2495             " You should copy the above configuration to a file, ",
2496             "and manually save it as <code><b>config/config.ini</b></code>.</p>\n";
2497     }
2498
2499     echo "<hr />\n<p>Here's the configuration file based on your answers:</p>\n";
2500     echo "<form method=\"get\" action=\"", $configurator, "\">\n";
2501     echo "<textarea id='config-output' readonly='readonly' style='width:100%;' rows='30' cols='100'>\n";
2502     echo htmlentities($config);
2503     echo "</textarea></form>\n";
2504     echo "<hr />\n";
2505
2506     echo "<p>To make any corrections, <a href=\"configurator.php\">edit the settings again</a>.</p>\n";
2507
2508 } else { // first time or create password
2509     $posted = $GLOBALS['HTTP_POST_VARS'];
2510     // No action has been specified - we make a form.
2511
2512     if (!empty($GLOBALS['HTTP_GET_VARS']['start_debug']))
2513         $configurator .= ("?start_debug=" . $GLOBALS['HTTP_GET_VARS']['start_debug']);
2514     echo '
2515 <form action="',$configurator,'" method="post">
2516 <input type="hidden" name="action" value="make_config" />
2517 <table cellpadding="4" cellspacing="0">
2518 ';
2519
2520     while (list($property, $obj) = each($properties)) {
2521         echo $obj->get_instructions($property);
2522         if ($h = $obj->get_html()) {
2523             if (defined('DEBUG') and DEBUG)  $h = get_class($obj) . "<br />\n" . $h;
2524             echo "<td>".$h."</td>\n";
2525         }
2526         echo '</tr>';
2527     }
2528
2529     echo '
2530 </table>
2531 <p><input type="submit" id="submit" value="Save ',$config_file,'" /> <input type="reset" value="Clear" /></p>
2532 </form>
2533 ';
2534 }
2535 ?>
2536 </body>
2537 </html>