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             'FCKeditor' => 'FCKeditor',
 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     concievably 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 knowledgable 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["Subpage Separator"] =
1347     new _define_optional('SUBPAGE_SEPARATOR', '"/"', "
1348 One character which separates pages from subpages. Defaults to '/', but '.' or ':' were also used.",
1349         "onchange=\"validate_ereg('Sorry, \'%s\' must be a single character. Currently only :, / or .', '^[/:.]$', 'SUBPAGE_SEPARATOR', this);\""
1350     );
1351
1352 $properties["InterWiki Map File"] =
1353     new _define('INTERWIKI_MAP_FILE', 'lib/interwiki.map', "
1354 InterWiki linking -- wiki-style links to other wikis on the web
1355
1356 The map will be taken from a page name InterWikiMap.
1357 If that page is not found (or is not locked), or map
1358 data can not be found in it, then the file specified
1359 by INTERWIKI_MAP_FILE (if any) will be used.");
1360
1361 $properties["WARN_NONPUBLIC_INTERWIKIMAP"] =
1362     new boolean_define('WARN_NONPUBLIC_INTERWIKIMAP');
1363
1364 $properties["Keyword Link Regexp"] =
1365     new _define_optional('KEYWORDS', '\"Category* OR Topic*\"', "
1366 Search term used for automatic page classification by keyword extraction.
1367
1368 Any links on a page to pages whose names match this search
1369 will be used keywords in the keywords html meta tag. This is an aid to
1370 classification by search engines. The value of the match is
1371 used as the keyword.
1372
1373 The default behavior is to match Category* or Topic* links.");
1374
1375 $properties["Author and Copyright Site Navigation Links"] =
1376     new _define_commented_optional('COPYRIGHTPAGE_TITLE', "GNU General Public License", "
1377
1378 These will be inserted as &lt;link rel&gt; tags in the html header of
1379 every page, for search engines and for browsers like Mozilla which
1380 take advantage of link rel site navigation.
1381
1382 If you have your own copyright and contact information pages change
1383 these as appropriate.");
1384
1385 $properties["COPYRIGHTPAGE URL"] =
1386     new _define_commented_optional('COPYRIGHTPAGE_URL', "http://www.gnu.org/copyleft/gpl.html#SEC1", "
1387
1388 Other useful alternatives to consider:
1389 <pre>
1390  COPYRIGHTPAGE_TITLE = \"GNU Free Documentation License\"
1391  COPYRIGHTPAGE_URL = \"http://www.gnu.org/copyleft/fdl.html\"
1392  COPYRIGHTPAGE_TITLE = \"Creative Commons License 2.0\"
1393  COPYRIGHTPAGE_URL = \"http://creativecommons.org/licenses/by/2.0/\"</pre>
1394 See http://creativecommons.org/learn/licenses/ for variations");
1395
1396 $properties["AUTHORPAGE_TITLE"] =
1397     new _define_commented_optional('AUTHORPAGE_TITLE', "The PhpWiki Programming Team", "
1398 Default Author Names");
1399 $properties["AUTHORPAGE_URL"] =
1400     new _define_commented_optional('AUTHORPAGE_URL', "http://phpwiki.fr/The%20PhpWiki%20programming%20team", "
1401 Default Author URL");
1402
1403 $properties["TOC_FULL_SYNTAX"] =
1404     new boolean_define_optional('TOC_FULL_SYNTAX');
1405
1406 $properties["ENABLE_MARKUP_COLOR"] =
1407     new boolean_define_optional('ENABLE_MARKUP_COLOR');
1408
1409 $properties["DISABLE_MARKUP_WIKIWORD"] =
1410     new boolean_define_optional('DISABLE_MARKUP_WIKIWORD');
1411
1412 $properties["ENABLE_MARKUP_DIVSPAN"] =
1413     new boolean_define_optional('ENABLE_MARKUP_DIVSPAN');
1414
1415 ///////////////////
1416
1417 $properties["Part Six"] =
1418     new part('_part6', $SEPARATOR . "\n", "
1419
1420 Part Six (optional):
1421 URL options -- you can probably skip this section.
1422
1423 For a pretty wiki (no index.php in the url) set a separate DATA_PATH.");
1424
1425 $properties["Server Name"] =
1426     new _define_commented_optional('SERVER_NAME', $_SERVER['SERVER_NAME'], "
1427 Canonical name of the server on which this PhpWiki resides.");
1428
1429 $properties["Server Port"] =
1430     new numeric_define_commented('SERVER_PORT', $_SERVER['SERVER_PORT'], "
1431 Canonical httpd port of the server on which this PhpWiki resides.",
1432         "onchange=\"validate_ereg('Sorry, \'%s\' is no valid port number.', '^[0-9]+$', 'SERVER_PORT', this);\"");
1433
1434 $properties["Server Protocol"] =
1435     new _define_selection_optional_commented('SERVER_PROTOCOL',
1436         array('http' => 'http',
1437             'https' => 'https'));
1438
1439 $properties["Script Name"] =
1440     new _define_commented_optional('SCRIPT_NAME', $scriptname);
1441
1442 $properties["Data Path"] =
1443     new _define_commented_optional('DATA_PATH', dirname($scriptname));
1444
1445 $properties["PhpWiki Install Directory"] =
1446     new _define_commented_optional('PHPWIKI_DIR', dirname(__FILE__));
1447
1448 $properties["Use PATH_INFO"] =
1449     new _define_selection_optional_commented('USE_PATH_INFO',
1450         array('' => 'automatic',
1451             'true' => 'use PATH_INFO',
1452             'false' => 'do not use PATH_INFO'), "
1453 PhpWiki will try to use short urls to pages, eg
1454 http://www.example.com/index.php/HomePage
1455 If you want to use urls like
1456 http://www.example.com/index.php?pagename=HomePage
1457 then define 'USE_PATH_INFO' as false by uncommenting the line below.
1458 NB:  If you are using Apache >= 2.0.30, then you may need to to use
1459 the directive \"AcceptPathInfo On\" in your Apache configuration file
1460 (or in an appropriate <.htaccess> file) for the short urls to work:
1461 See http://httpd.apache.org/docs-2.0/mod/core.html#acceptpathinfo
1462
1463 See also http://phpwiki.sourceforge.net/phpwiki/PrettyWiki for more ideas
1464 on prettifying your urls.
1465
1466 Default: PhpWiki will try to divine whether use of PATH_INFO
1467 is supported in by your webserver/PHP configuration, and will
1468 use PATH_INFO if it thinks that is possible.");
1469
1470 $properties["Virtual Path"] =
1471     new _define_commented_optional('VIRTUAL_PATH', '/SomeWiki', "
1472 VIRTUAL_PATH is the canonical URL path under which your your wiki
1473 appears. Normally this is the same as dirname(SCRIPT_NAME), however
1474 using e.g. separate starter scripts, apaches mod_actions (or mod_rewrite),
1475 you can make it something different.
1476
1477 If you do this, you should set VIRTUAL_PATH here or in the starter scripts.
1478
1479 E.g. your phpwiki might be installed at at /scripts/phpwiki/index.php,
1480 but you've made it accessible through eg. /wiki/HomePage.
1481
1482 One way to do this is to create a directory named 'wiki' in your
1483 server root. The directory contains only one file: an .htaccess
1484 file which reads something like:
1485 <pre>
1486     Action x-phpwiki-page /scripts/phpwiki/index.php
1487     SetHandler x-phpwiki-page
1488     DirectoryIndex /scripts/phpwiki/index.php
1489 </pre>
1490 In that case you should set VIRTUAL_PATH to '/wiki'.
1491
1492 (VIRTUAL_PATH is only used if USE_PATH_INFO is true.)
1493 ");
1494
1495 $upload_file_path = defined('UPLOAD_FILE_PATH') ? UPLOAD_FILE_PATH : getUploadFilePath();
1496 new _define_optional('UPLOAD_FILE_PATH', $temp);
1497
1498 $upload_data_path = defined('UPLOAD_DATA_PATH') ? UPLOAD_DATA_PATH : getUploadDataPath();
1499 new _define_optional('UPLOAD_DATA_PATH', $temp);
1500
1501 $temp = !empty($_ENV['TEMP']) ? $_ENV['TEMP'] : "/tmp";
1502 $properties["TEMP_DIR"] =
1503     new _define_optional('TEMP_DIR', $temp);
1504
1505 ///////////////////
1506
1507 $properties["Part Seven"] =
1508     new part('_part7', $SEPARATOR . "\n", "
1509
1510 Part Seven:
1511
1512 Miscellaneous settings
1513 ");
1514
1515 $properties["Strict Mailable Pagedumps"] =
1516     new boolean_define_optional('STRICT_MAILABLE_PAGEDUMPS',
1517         array('false' => "binary",
1518             'true' => "quoted-printable"));
1519
1520 $properties["Default local Dump Directory"] =
1521     new _define_optional('DEFAULT_DUMP_DIR');
1522
1523 $properties["Default local HTML Dump Directory"] =
1524     new _define_optional('HTML_DUMP_DIR');
1525
1526 $properties["HTML Dump Filename Suffix"] =
1527     new _define_optional('HTML_DUMP_SUFFIX');
1528
1529 $properties["Pagename of Recent Changes"] =
1530     new _define_optional('RECENT_CHANGES',
1531         "RecentChanges");
1532
1533 $properties["Disable HTTP Redirects"] =
1534     new boolean_define_commented_optional('DISABLE_HTTP_REDIRECT');
1535
1536 $properties["Disable GETIMAGESIZE"] =
1537     new boolean_define_commented_optional('DISABLE_GETIMAGESIZE');
1538
1539 $properties["EDITING_POLICY"] =
1540     new _define_optional('EDITING_POLICY');
1541
1542 $properties["TOOLBAR_PAGELINK_PULLDOWN"] =
1543     new _define_commented_optional('TOOLBAR_PAGELINK_PULLDOWN');
1544 $properties["TOOLBAR_TEMPLATE_PULLDOWN"] =
1545     new _define_commented_optional('TOOLBAR_TEMPLATE_PULLDOWN');
1546 $properties["TOOLBAR_IMAGE_PULLDOWN"] =
1547     new _define_commented_optional('TOOLBAR_IMAGE_PULLDOWN');
1548 $properties["FULLTEXTSEARCH_STOPLIST"] =
1549     new _define_commented_optional('FULLTEXTSEARCH_STOPLIST');
1550
1551 $properties["Part Seven A"] =
1552     new part('_part7a', $SEPARATOR . "\n", "
1553
1554 Part Seven A:
1555
1556 Optional Plugin Settings and external executables
1557 ");
1558
1559 $properties["FORTUNE_DIR"] =
1560     new _define_commented_optional('FORTUNE_DIR', "/usr/share/fortune");
1561 $properties["USE_EXTERNAL_HTML2PDF"] =
1562     new _define_commented_optional('USE_EXTERNAL_HTML2PDF', "htmldoc --quiet --format pdf14 --no-toc --no-title %s");
1563 $properties["EXTERNAL_HTML2PDF_PAGELIST"] =
1564     new _define_commented_optional('EXTERNAL_HTML2PDF_PAGELIST');
1565 $properties["BABYCART_PATH"] =
1566     new _define_commented_optional('BABYCART_PATH', "/usr/local/bin/babycart");
1567 $properties["GOOGLE_LICENSE_KEY"] =
1568     new _define_commented_optional('GOOGLE_LICENSE_KEY');
1569 $properties["RATEIT_IMGPREFIX"] =
1570     new _define_commented_optional('RATEIT_IMGPREFIX'); //BStar
1571 $properties["GRAPHVIZ_EXE"] =
1572     new _define_commented_optional('GRAPHVIZ_EXE', "/usr/bin/dot");
1573
1574 if (PHP_OS == "Darwin") // Mac OS X
1575     $ttfont = "/System/Library/Frameworks/JavaVM.framework/Versions/1.3.1/Home/lib/fonts/LucidaSansRegular.ttf";
1576 elseif (isWindows()) {
1577     $ttfont = $_ENV['windir'] . '\Fonts\Arial.ttf';
1578 } else {
1579     $ttfont = 'luximr'; // This is the only what sourceforge offered.
1580     //$ttfont = 'Helvetica';
1581 }
1582 $properties["TTFONT"] =
1583     new _define_commented_optional('TTFONT', $ttfont);
1584 $properties["VISUALWIKIFONT"] =
1585     new _define_commented_optional('VISUALWIKIFONT'); // Arial
1586 $properties["VISUALWIKI_ALLOWOPTIONS"] =
1587     new boolean_define_commented_optional('VISUALWIKI_ALLOWOPTIONS'); // false
1588 $properties["PLOTICUS_EXE"] =
1589     new _define_commented_optional('PLOTICUS_EXE'); // /usr/local/bin/pl
1590 $properties["PLOTICUS_PREFABS"] =
1591     new _define_commented_optional('PLOTICUS_PREFABS'); // /usr/share/ploticus
1592 $properties["MY_JABBER_ID"] =
1593     new _define_commented_optional('MY_JABBER_ID'); //
1594 $properties["PHPWEATHER_BASE_DIR"] =
1595     new _define_commented_optional('PHPWEATHER_BASE_DIR'); //
1596
1597 $properties["Part Eight"] =
1598     new part('_part8', $SEPARATOR . "\n", "
1599
1600 Part Eight:
1601
1602 Cached Plugin Settings. (pear Cache)
1603 ");
1604
1605 $properties["pear Cache USECACHE"] =
1606     new boolean_define_optional('PLUGIN_CACHED_USECACHE',
1607         array('true' => 'Enabled',
1608             'false' => 'Disabled'), "
1609 Enable or disable pear caching of plugins.");
1610 $properties["pear Cache Database Container"] =
1611     new _define_selection_optional('PLUGIN_CACHED_DATABASE',
1612         array('file' => 'file'), "
1613 Curently only file is supported.
1614 db, trifile and imgfile might be supported, but you must hack that by yourself.");
1615
1616 $properties["pear Cache cache directory"] =
1617     new _define_commented_optional('PLUGIN_CACHED_CACHE_DIR', "/tmp/cache", "
1618 Should be writable to the webserver.");
1619 $properties["pear Cache Filename Prefix"] =
1620     new _define_optional('PLUGIN_CACHED_FILENAME_PREFIX', "phpwiki", "");
1621 $properties["pear Cache HIGHWATER"] =
1622     new numeric_define_optional('PLUGIN_CACHED_HIGHWATER', "4194304", "
1623 Garbage collection parameter.");
1624 $properties["pear Cache LOWWATER"] =
1625     new numeric_define_optional('PLUGIN_CACHED_LOWWATER', "3145728", "
1626 Garbage collection parameter.");
1627 $properties["pear Cache MAXLIFETIME"] =
1628     new numeric_define_optional('PLUGIN_CACHED_MAXLIFETIME', "2592000", "
1629 Garbage collection parameter.");
1630 $properties["pear Cache MAXARGLEN"] =
1631     new numeric_define_optional('PLUGIN_CACHED_MAXARGLEN', "1000", "
1632 max. generated url length.");
1633 $properties["pear Cache FORCE_SYNCMAP"] =
1634     new boolean_define_optional('PLUGIN_CACHED_FORCE_SYNCMAP',
1635         array('true' => 'Enabled',
1636             'false' => 'Disabled'), "");
1637 $properties["pear Cache IMGTYPES"] =
1638     new list_define('PLUGIN_CACHED_IMGTYPES', "png|gif|gd|gd2|jpeg|wbmp|xbm|xpm", "
1639 Handle those image types via GD handles. Check your GD supported image types.");
1640
1641 $end = "\n" . $SEPARATOR . "\n";
1642
1643 // performance hack
1644 text_from_dist("_MAGIC_CLOSE_FILE");
1645
1646 // end of configuration options
1647 ///////////////////////////////
1648 // begin class definitions
1649
1650 /**
1651  * A basic config-dist.ini configuration line in the form of a variable.
1652  * (not needed anymore, we have only defines)
1653  *
1654  * Produces a string in the form "$name = value;"
1655  * e.g.:
1656  * $WikiNameRegexp = "value";
1657  */
1658 class _variable
1659 {
1660
1661     var $config_item_name;
1662     var $default_value;
1663     var $description;
1664     var $prefix;
1665     var $jscheck;
1666
1667     function _variable($config_item_name, $default_value = '', $description = '', $jscheck = '')
1668     {
1669         $this->config_item_name = $config_item_name;
1670         if (!$description)
1671             $description = text_from_dist($config_item_name);
1672         $this->description = $description;
1673         if (defined($config_item_name)
1674             and !preg_match("/(selection|boolean)/", get_class($this))
1675                 and !preg_match("/^(SCRIPT_NAME|VIRTUAL_PATH|TEMP_DIR)$/", $config_item_name)
1676         )
1677             $this->default_value = constant($config_item_name); // ignore given default value
1678         elseif ($config_item_name == $default_value)
1679             $this->default_value = ''; else
1680             $this->default_value = $default_value;
1681         $this->jscheck = $jscheck;
1682         if (preg_match("/variable/i", get_class($this)))
1683             $this->prefix = "\$";
1684         elseif (preg_match("/ini_set/i", get_class($this)))
1685             $this->prefix = "ini_get: "; else
1686             $this->prefix = "";
1687     }
1688
1689     function _define($config_item_name, $default_value = '', $description = '', $jscheck = '')
1690     {
1691         $this->_variable($config_item_name, $default_value, $description, $jscheck);
1692     }
1693
1694     function value()
1695     {
1696         global $HTTP_POST_VARS;
1697         if (isset($HTTP_POST_VARS[$this->config_item_name]))
1698             return $HTTP_POST_VARS[$this->config_item_name];
1699         else
1700             return $this->default_value;
1701     }
1702
1703     function _config_format($value)
1704     {
1705         return '';
1706         $v = $this->get_config_item_name();
1707         // handle arrays: a|b --> a['b']
1708         if (strpos($v, '|')) {
1709             list($a, $b) = explode('|', $v);
1710             $v = sprintf("%s['%s']", $a, $b);
1711         }
1712         if (preg_match("/[\"']/", $value))
1713             $value = '"' . $value . '"';
1714         return sprintf("%s = \"%s\"", $v, $value);
1715     }
1716
1717     function get_config_item_name()
1718     {
1719         return $this->config_item_name;
1720     }
1721
1722     function get_config_item_id()
1723     {
1724         return str_replace('|', '-', $this->config_item_name);
1725     }
1726
1727     function get_config_item_header()
1728     {
1729         if (strchr($this->config_item_name, '|')) {
1730             list($var, $param) = explode('|', $this->config_item_name);
1731             return "<b>" . $this->prefix . $var . "['" . $param . "']</b><br />";
1732         } elseif ($this->config_item_name[0] != '_')
1733             return "<b>" . $this->prefix . $this->config_item_name . "</b><br />"; else
1734             return '';
1735     }
1736
1737     function _get_description()
1738     {
1739         return $this->description;
1740     }
1741
1742     function _get_config_line($posted_value)
1743     {
1744         return "\n" . $this->_config_format($posted_value);
1745     }
1746
1747     function get_config($posted_value)
1748     {
1749         $d = stripHtml($this->_get_description());
1750         $d = str_replace("\n", "\n; ", $d) . $this->_get_config_line($posted_value) . "\n";
1751         return $d;
1752     }
1753
1754     function get_instructions($title)
1755     {
1756         global $tdwidth;
1757         $i = "<h3>" . $title . "</h3>\n    " . nl2p($this->_get_description()) . "\n";
1758         return "<tr>\n<td width=\"$tdwidth\" class=\"instructions\">\n" . $i . "</td>\n";
1759     }
1760
1761     function get_html()
1762     {
1763         $size = strlen($this->default_value) > 45 ? 90 : 50;
1764         return $this->get_config_item_header() .
1765             "<input type=\"text\" size=\"$50\" name=\"" . $this->get_config_item_name() . "\" value=\"" . htmlspecialchars($this->default_value) . "\" " .
1766             $this->jscheck . " />" . "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
1767     }
1768 }
1769
1770 class unchangeable_variable
1771     extends _variable
1772 {
1773     function _config_format($value)
1774     {
1775         return "";
1776     }
1777
1778     // function get_html() { return false; }
1779     function get_html()
1780     {
1781         return $this->get_config_item_header() .
1782             "<em>Not editable.</em>" .
1783             "<pre>" . $this->default_value . "</pre>";
1784     }
1785
1786     function _get_config_line($posted_value)
1787     {
1788         if ($this->description)
1789             $n = "\n";
1790         return "${n}" . $this->default_value;
1791     }
1792
1793     function get_instructions($title)
1794     {
1795         global $tdwidth;
1796         $i = "<h3>" . $title . "</h3>\n    " . nl2p($this->_get_description()) . "\n";
1797         // $i .= "<em>Not editable.</em><br />\n<pre>" . $this->default_value."</pre>";
1798         return '<tr><td style="width:100%" class="unchangeable-variable-top" colspan="2">' . "\n" . $i . "</td></tr>\n"
1799             . '<tr style="border-top: none;"><td class="unchangeable-variable-left" width="' . $tdwidth . '">&nbsp;</td>';
1800     }
1801 }
1802
1803 class unchangeable_define
1804     extends unchangeable_variable
1805 {
1806     function _get_config_line($posted_value)
1807     {
1808         if ($this->description)
1809             $n = "\n";
1810         if (!$posted_value)
1811             $posted_value = $this->default_value;
1812         return "${n}" . $this->_config_format($posted_value);
1813     }
1814
1815     function _config_format($value)
1816     {
1817         return sprintf("%s = \"%s\"", $this->get_config_item_name(), $value);
1818     }
1819 }
1820 class unchangeable_ini_set
1821     extends unchangeable_variable
1822 {
1823     function _config_format($value)
1824     {
1825         return "";
1826     }
1827 }
1828
1829 class _variable_selection
1830     extends _variable
1831 {
1832     function value()
1833     {
1834         global $HTTP_POST_VARS;
1835         if (!empty($HTTP_POST_VARS[$this->config_item_name]))
1836             return $HTTP_POST_VARS[$this->config_item_name];
1837         else {
1838             list($option, $label) = each($this->default_value);
1839             return $option;
1840         }
1841     }
1842
1843     function get_html()
1844     {
1845         $output = $this->get_config_item_header();
1846         $output .= '<select name="' . $this->get_config_item_name() . "\">\n";
1847         /* The first option is the default */
1848         $values = $this->default_value;
1849         if (defined($this->get_config_item_name()))
1850             $this->default_value = constant($this->get_config_item_name());
1851         else
1852             $this->default_value = null;
1853
1854         foreach ($values as $option => $label) {
1855             if (!is_null($this->default_value) && $this->default_value === $option)
1856                 $output .= "  <option value=\"$option\" selected=\"selected\">$label</option>\n";
1857             else
1858                 $output .= "  <option value=\"$option\">$label</option>\n";
1859         }
1860         $output .= "</select>\n";
1861         return $output;
1862     }
1863 }
1864
1865 class _define
1866     extends _variable
1867 {
1868     function _config_format($value)
1869     {
1870         return sprintf("%s = \"%s\"", $this->get_config_item_name(), $value);
1871     }
1872
1873     function _get_config_line($posted_value)
1874     {
1875         if ($this->description)
1876             $n = "\n";
1877         if ($posted_value == '')
1878             return "${n};" . $this->_config_format("");
1879         else
1880             return "${n}" . $this->_config_format($posted_value);
1881     }
1882
1883     function get_html()
1884     {
1885         $size = strlen($this->default_value) > 45 ? 90 : 50;
1886         return $this->get_config_item_header()
1887             . "<input type=\"text\" size=\"$size\" name=\"" . htmlentities($this->get_config_item_name())
1888             . "\" value=\"" . htmlentities($this->default_value) . "\" {$this->jscheck} />"
1889             . "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
1890     }
1891 }
1892
1893 class _define_commented
1894     extends _define
1895 {
1896     function _get_config_line($posted_value)
1897     {
1898         if ($this->description)
1899             $n = "\n";
1900         if ($posted_value == $this->default_value)
1901             return "${n};" . $this->_config_format($posted_value);
1902         elseif ($posted_value == '')
1903             return "${n};" . $this->_config_format(""); else
1904             return "${n}" . $this->_config_format($posted_value);
1905     }
1906 }
1907
1908 /**
1909  * We don't use _optional anymore, because INI-style config's don't need that.
1910  * IniConfig.php does the optional logic now.
1911  * But we use _optional for config-default.ini options
1912  */
1913 class _define_commented_optional
1914     extends _define_commented
1915 {
1916 }
1917
1918 class _define_optional
1919     extends _define
1920 {
1921 }
1922
1923 class _define_notempty
1924     extends _define
1925 {
1926     function get_html()
1927     {
1928         $s = $this->get_config_item_header()
1929             . "<input type=\"text\" size=\"50\" name=\"" . $this->get_config_item_name()
1930             . "\" value=\"" . $this->default_value . "\" {$this->jscheck} />";
1931         if (empty($this->default_value))
1932             return $s . "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: red\">Cannot be empty.</p>";
1933         else
1934             return $s . "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
1935     }
1936 }
1937
1938 class _variable_commented
1939     extends _variable
1940 {
1941     function _get_config_line($posted_value)
1942     {
1943         if ($this->description)
1944             $n = "\n";
1945         if ($posted_value == $this->default_value)
1946             return "${n};" . $this->_config_format($posted_value);
1947         elseif ($posted_value == '')
1948             return "${n};" . $this->_config_format(""); else
1949             return "${n}" . $this->_config_format($posted_value);
1950     }
1951 }
1952
1953 class numeric_define
1954     extends _define
1955 {
1956
1957     function numeric_define($config_item_name, $default_value = '', $description = '', $jscheck = '')
1958     {
1959         $this->_define($config_item_name, $default_value, $description, $jscheck);
1960         if (!$jscheck)
1961             $this->jscheck = "onchange=\"validate_ereg('Sorry, \'%s\' is not an integer.', '^[-+]?[0-9]+$', '" . $this->get_config_item_name() . "', this);\"";
1962     }
1963
1964     function _config_format($value)
1965     {
1966         //return sprintf("define('%s', %s);", $this->get_config_item_name(), $value);
1967         return sprintf("%s = %s", $this->get_config_item_name(), $value);
1968     }
1969
1970     function _get_config_line($posted_value)
1971     {
1972         if ($this->description)
1973             $n = "\n";
1974         if ($posted_value == '')
1975             return "${n};" . $this->_config_format('0');
1976         else
1977             return "${n}" . $this->_config_format($posted_value);
1978     }
1979 }
1980
1981 class numeric_define_optional
1982     extends numeric_define
1983 {
1984 }
1985
1986 class numeric_define_commented
1987     extends numeric_define
1988 {
1989     function _get_config_line($posted_value)
1990     {
1991         if ($this->description)
1992             $n = "\n";
1993         if ($posted_value == $this->default_value)
1994             return "${n};" . $this->_config_format($posted_value);
1995         elseif ($posted_value == '')
1996             return "${n};" . $this->_config_format('0'); else
1997             return "${n}" . $this->_config_format($posted_value);
1998     }
1999 }
2000
2001 class _define_selection
2002     extends _variable_selection
2003 {
2004     function _config_format($value)
2005     {
2006         return sprintf("%s = %s", $this->get_config_item_name(), $value);
2007     }
2008
2009     function _get_config_line($posted_value)
2010     {
2011         return _define::_get_config_line($posted_value);
2012     }
2013
2014     function get_html()
2015     {
2016         return _variable_selection::get_html();
2017     }
2018 }
2019
2020 class _define_selection_optional
2021     extends _define_selection
2022 {
2023 }
2024
2025 class _variable_selection_optional
2026     extends _variable_selection
2027 {
2028 }
2029
2030 class _define_selection_optional_commented
2031     extends _define_selection_optional
2032 {
2033     function _get_config_line($posted_value)
2034     {
2035         if ($this->description)
2036             $n = "\n";
2037         if ($posted_value == $this->default_value)
2038             return "${n};" . $this->_config_format($posted_value);
2039         elseif ($posted_value == '')
2040             return "${n};" . $this->_config_format(""); else
2041             return "${n}" . $this->_config_format($posted_value);
2042     }
2043 }
2044
2045 class _define_password
2046     extends _define
2047 {
2048
2049     function _define_password($config_item_name, $default_value = '', $description = '', $jscheck = '')
2050     {
2051         if ($config_item_name == $default_value) $default_value = '';
2052         $this->_define($config_item_name, $default_value, $description, $jscheck);
2053         if (!$jscheck)
2054             $this->jscheck = "onchange=\"validate_ereg('Sorry, \'%s\' cannot be empty.', '^.+$', '"
2055                 . $this->get_config_item_name() . "', this);\"";
2056     }
2057
2058     function _get_config_line($posted_value)
2059     {
2060         if ($this->description)
2061             $n = "\n";
2062         if ($posted_value == '') {
2063             $p = "${n};" . $this->_config_format("");
2064             $p .= "\n; If you used the passencrypt.php utility to encode the password";
2065             $p .= "\n; then uncomment this line:";
2066             $p .= "\n;ENCRYPTED_PASSWD = true";
2067             return $p;
2068         } else {
2069             $salt_length = max(CRYPT_SALT_LENGTH,
2070                 2 * CRYPT_STD_DES,
2071                 9 * CRYPT_EXT_DES,
2072                 12 * CRYPT_MD5,
2073                 16 * CRYPT_BLOWFISH);
2074             // generate an encrypted password
2075             $crypt_pass = crypt($posted_value, rand_ascii($salt_length));
2076             $p = "${n}" . $this->_config_format($crypt_pass);
2077             return $p . "\nENCRYPTED_PASSWD = true";
2078         }
2079     }
2080
2081     function get_html()
2082     {
2083         return _variable_password::get_html();
2084     }
2085 }
2086
2087 class _define_password_optional
2088     extends _define_password
2089 {
2090
2091     function _define_password_optional($config_item_name, $default_value = '', $description = '', $jscheck = '')
2092     {
2093         if ($config_item_name == $default_value) $default_value = '';
2094         if (!$jscheck) $this->jscheck = " ";
2095         $this->_define($config_item_name, $default_value, $description, $jscheck);
2096     }
2097
2098     function _get_config_line($posted_value)
2099     {
2100         if ($this->description)
2101             $n = "\n";
2102         if ($posted_value == '') {
2103             return "${n};" . $this->_config_format("");
2104         } else {
2105             return "${n}" . $this->_config_format($posted_value);
2106         }
2107     }
2108
2109     function get_html()
2110     {
2111         $s = $this->get_config_item_header();
2112         // dont re-encrypt already encrypted passwords
2113         $value = $this->value();
2114         $encrypted = !empty($GLOBALS['properties']["Encrypted Passwords"]) and
2115             $GLOBALS['properties']["Encrypted Passwords"]->value();
2116         if (empty($value))
2117             $encrypted = false;
2118         $s .= "<input type=\"" . ($encrypted ? "text" : "password") . "\" name=\"" . $this->get_config_item_name()
2119             . "\" value=\"" . $value . "\" {$this->jscheck} />";
2120         return $s;
2121     }
2122 }
2123
2124 class _define_password_commented_optional
2125     extends _define_password_optional
2126 {
2127 }
2128
2129 class _variable_password
2130     extends _variable
2131 {
2132     function _variable_password($config_item_name, $default_value = '', $description = '', $jscheck = '')
2133     {
2134         if ($config_item_name == $default_value) $default_value = '';
2135         $this->_define($config_item_name, $default_value, $description, $jscheck);
2136         if (!$jscheck)
2137             $this->jscheck = "onchange=\"validate_ereg('Sorry, \'%s\' cannot be empty.', '^.+$', '" . $this->get_config_item_name() . "', this);\"";
2138     }
2139
2140     function get_html()
2141     {
2142         global $HTTP_POST_VARS, $HTTP_GET_VARS;
2143         $s = $this->get_config_item_header();
2144         if (isset($HTTP_POST_VARS['create']) or isset($HTTP_GET_VARS['create'])) {
2145             $new_password = random_good_password();
2146             $this->default_value = $new_password;
2147             $s .= "Created password: <strong>$new_password</strong><br />&nbsp;<br />";
2148         }
2149         // dont re-encrypt already encrypted passwords
2150         $value = $this->value();
2151         $encrypted = !empty($GLOBALS['properties']["Encrypted Passwords"]) and
2152             $GLOBALS['properties']["Encrypted Passwords"]->value();
2153         if (empty($value))
2154             $encrypted = false;
2155         $s .= "<input type=\"" . ($encrypted ? "text" : "password") . "\" name=\"" . $this->get_config_item_name()
2156             . "\" value=\"" . $value . "\" {$this->jscheck} />"
2157             . "&nbsp;&nbsp;<input type=\"submit\" name=\"create\" value=\"Create Random Password\" />";
2158         if (empty($value))
2159             $s .= "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: red\">Cannot be empty.</p>";
2160         elseif (strlen($this->default_value) < 4)
2161             $s .= "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: red\">Must be longer than 4 chars.</p>"; else
2162             $s .= "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
2163         return $s;
2164     }
2165 }
2166
2167 class list_variable
2168     extends _variable
2169 {
2170     function _get_config_line($posted_value)
2171     {
2172         // split the phrase by any number of commas or space characters,
2173         // which include " ", \r, \t, \n and \f
2174         $list_values = preg_split("/[\s,]+/", $posted_value, -1, PREG_SPLIT_NO_EMPTY);
2175         if ($list_values)
2176             $list_values = join("|", $list_values);
2177         return _variable::_get_config_line($list_values);
2178     }
2179
2180     function get_html()
2181     {
2182         $list_values = explode("|", $this->default_value);
2183         $rows = max(3, count($list_values) + 1);
2184         $list_values = join("\n", $list_values);
2185         $ta = $this->get_config_item_header();
2186         $ta .= "<textarea cols=\"18\" rows=\"" . $rows . "\" name=\"" . $this->get_config_item_name() . "\" {$this->jscheck}>";
2187         $ta .= $list_values . "</textarea>";
2188         $ta .= "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
2189         return $ta;
2190     }
2191 }
2192
2193 class list_define
2194     extends _define
2195 {
2196     function _get_config_line($posted_value)
2197     {
2198         $list_values = preg_split("/[\s,]+/", $posted_value, -1, PREG_SPLIT_NO_EMPTY);
2199         if ($list_values)
2200             $list_values = join("|", $list_values);
2201         return _variable::_get_config_line($list_values);
2202     }
2203
2204     function get_html()
2205     {
2206         $list_values = explode("|", $this->default_value);
2207         $rows = max(3, count($list_values) + 1);
2208         if ($list_values)
2209             $list_values = join("\n", $list_values);
2210         $ta = $this->get_config_item_header();
2211         $ta .= "<textarea cols=\"18\" rows=\"" . $rows . "\" name=\"" . $this->get_config_item_name() . "\" {$this->jscheck}>";
2212         $ta .= $list_values . "</textarea>";
2213         $ta .= "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
2214         return $ta;
2215     }
2216 }
2217
2218 class array_variable
2219     extends _variable
2220 {
2221     function _config_format($value)
2222     {
2223         return sprintf("%s = \"%s\"", $this->get_config_item_name(),
2224             is_array($value) ? join(':', $value) : $value);
2225     }
2226
2227     function _get_config_line($posted_value)
2228     {
2229         // split the phrase by any number of commas or space characters,
2230         // which include " ", \r, \t, \n and \f
2231         $list_values = preg_split("/[\s,]+/", $posted_value, -1, PREG_SPLIT_NO_EMPTY);
2232         if (!empty($list_values)) {
2233             $list_values = "'" . join("', '", $list_values) . "'";
2234             return "\n" . $this->_config_format($list_values);
2235         } else
2236             return "\n;" . $this->_config_format('');
2237     }
2238
2239     function get_html()
2240     {
2241         if (is_array($this->default_value))
2242             $list_values = join("\n", $this->default_value);
2243         else
2244             $list_values = $this->default_value;
2245         $rows = max(3, count($this->default_value) + 1);
2246         $ta = $this->get_config_item_header();
2247         $ta .= "<textarea cols=\"18\" rows=\"" . $rows . "\" name=\"" . $this->get_config_item_name() . "\" {$this->jscheck}>";
2248         $ta .= $list_values . "</textarea>";
2249         $ta .= "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
2250         return $ta;
2251     }
2252 }
2253
2254 class array_define
2255     extends _define
2256 {
2257     function _config_format($value)
2258     {
2259         return sprintf("%s = \"%s\"", $this->get_config_item_name(),
2260             is_array($value) ? join(' : ', $value) : $value);
2261     }
2262
2263     function _get_config_line($posted_value)
2264     {
2265         // split the phrase by any number of commas or space characters,
2266         // which include " ", \r, \t, \n and \f
2267         $list_values = preg_split("/[\s,:]+/", $posted_value, -1, PREG_SPLIT_NO_EMPTY);
2268         if (!empty($list_values)) {
2269             $list_values = join(" : ", $list_values);
2270             return "\n" . $this->_config_format($list_values);
2271         } else
2272             return "\n;" . $this->_config_format('');
2273     }
2274
2275     function get_html()
2276     {
2277         if (!$this->default_value)
2278             $this->default_value = array();
2279         elseif (is_string($this->default_value))
2280             $this->default_value = preg_split("/[\s,:]+/", $this->default_value, -1, PREG_SPLIT_NO_EMPTY);
2281         $list_values = join(" : \n", $this->default_value);
2282         $rows = max(3, count($this->default_value) + 1);
2283         $ta = $this->get_config_item_header();
2284         $ta .= "<textarea cols=\"18\" rows=\"" . $rows . "\" name=\"" . $this->get_config_item_name() . "\" {$this->jscheck}>";
2285         $ta .= $list_values . "</textarea>";
2286         $ta .= "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
2287         return $ta;
2288     }
2289 }
2290
2291 /*
2292 class _ini_set
2293 extends _variable {
2294     function value() {
2295         global $HTTP_POST_VARS;
2296         if ($v = $HTTP_POST_VARS[$this->config_item_name])
2297             return $v;
2298         else {
2299             return ini_get($this->get_config_item_name);
2300         }
2301     }
2302     function _config_format($value) {
2303         return sprintf("ini_set('%s', '%s');", $this->get_config_item_name(), $value);
2304     }
2305     function _get_config_line($posted_value) {
2306         if ($posted_value && ! $posted_value == $this->default_value)
2307             return "\n" . $this->_config_format($posted_value);
2308         else
2309             return "\n;" . $this->_config_format($this->default_value);
2310     }
2311 }
2312 */
2313
2314 class boolean_define
2315     extends _define
2316 {
2317
2318     // adds ->values property, instead of ->default_value
2319     function boolean_define($config_item_name, $values = false, $description = '', $jscheck = '')
2320     {
2321         $this->config_item_name = $config_item_name;
2322         if (!$description)
2323             $description = text_from_dist($config_item_name);
2324         $this->description = $description;
2325         // TESTME: get boolean default value from config-default.ini
2326         if (defined($config_item_name))
2327             $this->default_value = constant($config_item_name); // ignore given default value
2328         elseif (is_array($values))
2329             list($this->default_value, $dummy) = $values[0];
2330         if (!$values)
2331             $values = array('false' => "Disabled",
2332                 'true' => "Enabled");
2333         $this->values = $values;
2334         $this->jscheck = $jscheck;
2335         $this->prefix = "";
2336     }
2337
2338     function _get_config_line($posted_value)
2339     {
2340         if ($this->description)
2341             $n = "\n";
2342         return "${n}" . $this->_config_format($posted_value);
2343     }
2344
2345     function _config_format($value)
2346     {
2347         if (strtolower(trim($value)) == 'false')
2348             $value = false;
2349         return sprintf("%s = %s", $this->get_config_item_name(),
2350             (bool)$value ? 'true' : 'false');
2351     }
2352
2353     //TODO: radiobuttons, no list
2354     function get_html()
2355     {
2356         $output = $this->get_config_item_header();
2357         $name = $this->get_config_item_name();
2358         $output .= '<select name="' . $name . "\" {$this->jscheck}>\n";
2359         $values = $this->values;
2360         $default_value = $this->default_value ? 'true' : 'false';
2361         /* There can usually only be two options, there can be
2362          * three options in the case of a boolean_define_commented_optional */
2363         while (list($option, $label) = each($values)) {
2364             if (!is_null($this->default_value) and $option === $default_value)
2365                 $output .= "  <option value=\"$option\" selected=\"selected\">$label</option>\n";
2366             else
2367                 $output .= "  <option value=\"$option\">$label</option>\n";
2368         }
2369         $output .= "</select>\n";
2370         return $output;
2371     }
2372 }
2373
2374 class boolean_define_optional
2375     extends boolean_define
2376 {
2377 }
2378
2379 class boolean_define_commented
2380     extends boolean_define
2381 {
2382     function _get_config_line($posted_value)
2383     {
2384         if ($this->description)
2385             $n = "\n";
2386         list($default_value, $label) = each($this->default_value);
2387         if ($posted_value == $default_value)
2388             return "${n};" . $this->_config_format($posted_value);
2389         elseif ($posted_value == '')
2390             return "${n};" . $this->_config_format('false'); else
2391             return "${n}" . $this->_config_format($posted_value);
2392     }
2393 }
2394
2395 class boolean_define_commented_optional
2396     extends boolean_define_commented
2397 {
2398 }
2399
2400 class part
2401     extends _variable
2402 {
2403     function value()
2404     {
2405         return;
2406     }
2407
2408     function get_config($posted_value)
2409     {
2410         $d = stripHtml($this->_get_description());
2411         global $SEPARATOR;
2412         return "\n" . $SEPARATOR . str_replace("\n", "\n; ", $d) . "\n" . $this->default_value;
2413     }
2414
2415     function get_instructions($title)
2416     {
2417         $id = preg_replace("/\W/", "", $this->config_item_name);
2418         $group_name = preg_replace("/\W/", "", $title);
2419         $i = '<tr class="header" id="'.$id.'">'."\n";
2420         $i .= '<td class="part" style="width:100%;background-color:#eee" colspan="2">'."\n";
2421         $i .= "<h2>" . $title . "</h2>\n    " . nl2p($this->_get_description()) . "\n";
2422         $i .= "<p><a href=\"javascript:toggle_group('$id')\" id=\"{$id}_text\">Hide options.</a></p>";
2423         return $i . "</td>\n";
2424     }
2425
2426     function get_html()
2427     {
2428         return "";
2429     }
2430 }
2431
2432 // html utility functions
2433 function nl2p($text)
2434 {
2435     preg_match_all("@\s*(<pre>.*?</pre>|<dl>.*?</dl>|.*?(?=\n\n|<pre>|<dl>|$))@s",
2436         $text, $m, PREG_PATTERN_ORDER);
2437
2438     $text = '';
2439     foreach ($m[1] as $par) {
2440         if (!($par = trim($par)))
2441             continue;
2442         if (!preg_match('/^<(pre|dl)>/', $par))
2443             $par = "<p>$par</p>";
2444         $text .= $par;
2445     }
2446     return $text;
2447 }
2448
2449 function text_from_dist($var)
2450 {
2451     static $distfile = 0;
2452     static $f;
2453
2454     if (!$distfile) {
2455         $sep = (substr(PHP_OS, 0, 3) == 'WIN' ? '\\' : '/');
2456         $distfile = dirname(__FILE__) . $sep . "config" . $sep . "config-dist.ini";
2457         $f = fopen($distfile, "r");
2458     }
2459     if ($var == '_MAGIC_CLOSE_FILE') {
2460         fclose($f);
2461         return '';
2462     }
2463     // if all vars would be in natural order as in the config-dist this would not be needed.
2464     fseek($f, 0);
2465     $par = "\n";
2466     while (!feof($f)) {
2467         $s = fgets($f);
2468         if (preg_match("/^; \w/", $s)) {
2469             $par .= (substr($s, 2) . " ");
2470         } elseif (preg_match("/^;\s*$/", $s)) {
2471             $par .= "\n\n";
2472         }
2473         if (preg_match("/^;?" . preg_quote($var) . "\s*=/", $s))
2474             return $par;
2475         if (preg_match("/^\s*$/", $s)) // new paragraph
2476             $par = "\n";
2477     }
2478     return '';
2479 }
2480
2481 function stripHtml($text)
2482 {
2483     $d = str_replace("<pre>", "", $text);
2484     $d = str_replace("</pre>", "", $d);
2485     $d = str_replace("<dl>", "", $d);
2486     $d = str_replace("</dl>", "", $d);
2487     $d = str_replace("<dt>", "", $d);
2488     $d = str_replace("</dt>", "", $d);
2489     $d = str_replace("<dd>", "", $d);
2490     $d = str_replace("</dd>", "", $d);
2491     $d = str_replace("<p>", "", $d);
2492     $d = str_replace("</p>", "", $d);
2493     //restore html entities into characters
2494     // http://www.php.net/manual/en/function.htmlentities.php
2495     $trans = get_html_translation_table(HTML_ENTITIES);
2496     $trans = array_flip($trans);
2497     $d = strtr($d, $trans);
2498     return $d;
2499 }
2500
2501 include_once(dirname(__FILE__) . "/lib/stdlib.php");
2502
2503 ////
2504 // Function to create better user passwords (much larger keyspace),
2505 // suitable for user passwords.
2506 // Sequence of random ASCII numbers, letters and some special chars.
2507 // Note: There exist other algorithms for easy-to-remember passwords.
2508 function random_good_password($minlength = 5, $maxlength = 8)
2509 {
2510     $newpass = '';
2511     // assume ASCII ordering (not valid on EBCDIC systems!)
2512     $valid_chars = "!#%&+-.0123456789=@ABCDEFGHIJKLMNOPQRSTUVWXYZ_abcdefghijklmnopqrstuvwxyz";
2513     $start = ord($valid_chars);
2514     $end = ord(substr($valid_chars, -1));
2515     $length = mt_rand($minlength, $maxlength);
2516     while ($length > 0) {
2517         $newchar = mt_rand($start, $end);
2518         if (!strrpos($valid_chars, $newchar)) continue; // skip holes
2519         $newpass .= sprintf("%c", $newchar);
2520         $length--;
2521     }
2522     return ($newpass);
2523 }
2524
2525 // debugging
2526 function printArray($a)
2527 {
2528     echo "<hr />\n<pre>\n";
2529     print_r($a);
2530     echo "\n</pre>\n<hr />\n";
2531 }
2532
2533 // end of class definitions
2534 /////////////////////////////
2535 // begin auto generation code
2536
2537 if (!empty($HTTP_POST_VARS['action'])
2538     and $HTTP_POST_VARS['action'] == 'make_config'
2539         and !empty($HTTP_POST_VARS['ADMIN_USER'])
2540             and !empty($HTTP_POST_VARS['ADMIN_PASSWD'])
2541 ) {
2542
2543     $timestamp = date('dS \of F, Y H:i:s');
2544
2545     $config = "
2546 ; This is a local configuration file for PhpWiki.
2547 ; It was automatically generated by the configurator script
2548 ; on the $timestamp.
2549 ;
2550 ; $preamble
2551 ";
2552
2553     $posted = $GLOBALS['HTTP_POST_VARS'];
2554     /*if (defined('DEBUG'))
2555      printArray($GLOBALS['HTTP_POST_VARS']);*/
2556
2557     foreach ($properties as $option_name => $a) {
2558         $posted_value = stripslashes($posted[$a->config_item_name]);
2559         $config .= $properties[$option_name]->get_config($posted_value);
2560     }
2561
2562     $config .= $end;
2563
2564     if (is_writable($fs_config_file)) {
2565         // We first check if the config-file exists.
2566         if (file_exists($fs_config_file)) {
2567             // We make a backup copy of the file
2568             $new_filename = preg_replace('/\.ini$/', '-' . time() . '.ini', $fs_config_file);
2569             if (@copy($fs_config_file, $new_filename)) {
2570                 $fp = @fopen($fs_config_file, 'w');
2571             }
2572         } else {
2573             $fp = @fopen($fs_config_file, 'w');
2574         }
2575     } else {
2576         $fp = false;
2577     }
2578
2579     if ($fp) {
2580         fputs($fp, utf8_encode($config));
2581         fclose($fp);
2582         echo "<p>The configuration was written to <code><b>$config_file</b></code>.</p>\n";
2583         if ($new_filename) {
2584             echo "<p>A backup was made to <code><b>$new_filename</b></code>.</p>\n";
2585         } else {
2586             ; //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";
2587         }
2588     } else {
2589         echo "<p>The configuration file could <b>not</b> be written.<br />\n",
2590         " You should copy the above configuration to a file, ",
2591         "and manually save it as <code><b>config/config.ini</b></code>.</p>\n";
2592     }
2593
2594     echo "<hr />\n<p>Here's the configuration file based on your answers:</p>\n";
2595     echo "<form method=\"get\" action=\"", $configurator, "\">\n";
2596     echo "<textarea id='config-output' readonly='readonly' style='width:100%;' rows='30' cols='100'>\n";
2597     echo htmlentities($config, ENT_COMPAT, "UTF-8");
2598     echo "</textarea></form>\n";
2599     echo "<hr />\n";
2600
2601     echo "<p>To make any corrections, <a href=\"configurator.php\">edit the settings again</a>.</p>\n";
2602
2603 } else { // first time or create password
2604     $posted = $GLOBALS['HTTP_POST_VARS'];
2605     // No action has been specified - we make a form.
2606
2607     if (!empty($GLOBALS['HTTP_GET_VARS']['start_debug']))
2608         $configurator .= ("?start_debug=" . $GLOBALS['HTTP_GET_VARS']['start_debug']);
2609     echo '
2610 <form action="', $configurator, '" method="post">
2611 <input type="hidden" name="action" value="make_config" />
2612 <table cellpadding="4" cellspacing="0">
2613 ';
2614
2615     while (list($property, $obj) = each($properties)) {
2616         echo $obj->get_instructions($property);
2617         if ($h = $obj->get_html()) {
2618             if (defined('DEBUG') and DEBUG) $h = get_class($obj) . "<br />\n" . $h;
2619             echo "<td>" . $h . "</td>\n";
2620         }
2621         echo '</tr>';
2622     }
2623
2624     echo '
2625 </table>
2626 <p><input type="submit" id="submit" value="Save ', $config_file, '" /> <input type="reset" value="Clear" /></p>
2627 </form>
2628 ';
2629 }
2630 ?>
2631 </body>
2632 </html>