configurator.php

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