configurator.php

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