configurator.php

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