1 <?php // $Id: configurator.php,v 1.42 2005-10-31 17:02:57 rurban Exp $
3 * Copyright 2002,2003,2005 $ThePhpWikiProgrammingTeam
4 * Copyright 2002 Martin Geisler <gimpster@gimpster.com>
6 * This file is part of PhpWiki.
7 * Parts of this file were based on PHPWeather's configurator.php file.
8 * http://sourceforge.net/projects/phpweather/
10 * PhpWiki is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * PhpWiki is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with PhpWiki; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
26 * Starts automatically the first time by IniConfig("config/config.ini")
27 * if it doesn't exist.
30 * o Initial expand ?show=_part1 (the part id)
31 * o read config-default.ini and use this as default_values
32 * o commented / optional: non-default values should not be commented!
33 * default values if optional can be omitted.
34 * o validate input (fix javascript, add POST checks)
35 * o start this automatically the first time
38 * 1.3.11 TODO: (or 1.3.12?)
39 * o parse_ini_file("config-dist.ini") for the commented vars
40 * o check automatically for commented and optional vars
41 * o fix _optional, to ignore existing config.ini and only use config-default.ini values
42 * o mixin class for commented
43 * o fix SQL quotes, AUTH_ORDER quotes and file forward slashes
44 * o posted values validation, extend js validation for sane DB values
45 * o read config-dist.ini into sections, comments, and optional/required settings
47 * A file config/config.ini will be automatically generated, if writable.
49 * NOTE: If you have a starterscript outside PHPWIKI_DIR but no
50 * config/config.ini yet (very unlikely!), you must define DATA_PATH in the
51 * starterscript, otherwise the webpath to configurator is unknown, and
52 * subsequent requests will fail. (POST to save the INI)
55 global $HTTP_SERVER_VARS, $HTTP_POST_VARS, $tdwidth;
56 if (empty($_GET)) $_GET =& $GLOBALS['HTTP_GET_VARS'];
57 if (empty($_ENV)) $_ENV =& $GLOBALS['HTTP_ENV_VARS'];
59 if (empty($configurator))
60 $configurator = "configurator.php";
61 if (!strstr($HTTP_SERVER_VARS["SCRIPT_NAME"], $configurator) and defined('DATA_PATH'))
62 $configurator = DATA_PATH . "/" . $configurator;
63 $scriptname = str_replace('configurator.php', 'index.php', $HTTP_SERVER_VARS["SCRIPT_NAME"]);
66 $config_file = (substr(PHP_OS,0,3) == 'WIN') ? 'config\\config.ini' : 'config/config.ini';
67 $fs_config_file = dirname(__FILE__) . (substr(PHP_OS,0,3) == 'WIN' ? '\\' : '/') . $config_file;
68 if (isset($HTTP_POST_VARS['create'])) header('Location: '.$configurator.'?show=_part1&create=1#create');
70 // helpers from lib/WikiUser/HttpAuth.php
71 if (!function_exists('_http_user')) {
72 function _http_user() {
74 $_SERVER = $GLOBALS['HTTP_SERVER_VARS'];
75 if (!empty($_SERVER['PHP_AUTH_USER']))
76 return array($_SERVER['PHP_AUTH_USER'], $_SERVER['PHP_AUTH_PW']);
77 if (!empty($_SERVER['REMOTE_USER']))
78 return array($_SERVER['REMOTE_USER'], $_SERVER['PHP_AUTH_PW']);
79 if (!empty($GLOBALS['HTTP_ENV_VARS']['REMOTE_USER']))
80 return array($GLOBALS['HTTP_ENV_VARS']['REMOTE_USER'],
81 $GLOBALS['HTTP_ENV_VARS']['PHP_AUTH_PW']);
82 if (!empty($GLOBALS['REMOTE_USER']))
83 return array($GLOBALS['REMOTE_USER'], $GLOBALS['PHP_AUTH_PW']);
86 if (!empty($_SERVER['HTTP_AUTHORIZATION'])) {
87 list($userid, $passwd) = explode(':', base64_decode(substr($_SERVER['HTTP_AUTHORIZATION'], 6)));
88 return array($userid, $passwd);
92 function _http_logout() {
94 $_SERVER =& $GLOBALS['HTTP_SERVER_VARS'];
95 // maybe we should random the realm to really force a logout. but the next login will fail.
96 // better_srand(); $realm = microtime().rand();
97 header('WWW-Authenticate: Basic realm="'.WIKI_NAME.'"');
98 if (strstr(php_sapi_name(), 'apache'))
99 header('HTTP/1.0 401 Unauthorized');
101 header("Status: 401 Access Denied"); //IIS and CGI need that
102 unset($GLOBALS['REMOTE_USER']);
103 unset($_SERVER['PHP_AUTH_USER']);
104 unset($_SERVER['PHP_AUTH_PW']);
106 trigger_error("Permission denied. Require ADMIN_USER.", E_USER_ERROR);
111 // If config.ini exists, we require ADMIN_USER access by faking HttpAuth.
112 // So nobody can see or reset the password(s).
113 if (file_exists($fs_config_file)) {
114 // Require admin user
115 if (!defined('ADMIN_USER') or !defined('ADMIN_PASSWD')) {
116 if (!function_exists("IniConfig")) {
117 include_once("lib/prepend.php");
118 include_once("lib/IniConfig.php");
120 IniConfig($fs_config_file);
122 if (!defined('ADMIN_USER') or ADMIN_USER == '') {
123 trigger_error("Configuration problem:\nADMIN_USER not defined in \"$fs_config_file\".\n"
124 . "Cannot continue: You have to fix that manually.", E_USER_ERROR);
128 list($admin_user, $admin_pw) = _http_user();
129 //$required_user = ADMIN_USER;
130 if (empty($admin_user) or $admin_user != ADMIN_USER)
135 if (ENCRYPTED_PASSWD and function_exists('crypt')) {
136 if (crypt($admin_pw, ADMIN_PASSWD) != ADMIN_PASSWD)
138 } elseif ($admin_pw != ADMIN_PASSWD) {
142 if (!function_exists("IniConfig")) {
143 include_once("lib/prepend.php");
144 include_once("lib/IniConfig.php");
146 $def_file = (substr(PHP_OS,0,3) == 'WIN') ? 'config\\config-default.ini' : 'config/config-default.ini';
147 $fs_def_file = dirname(__FILE__) . (substr(PHP_OS,0,3) == 'WIN' ? '\\' : '/') . $def_file;
148 IniConfig($fs_def_file);
151 echo '<','?xml version="1.0" encoding="iso-8859-1"?',">\n";
153 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
154 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
155 <html xmlns="http://www.w3.org/1999/xhtml">
157 <!-- $Id: configurator.php,v 1.42 2005-10-31 17:02:57 rurban Exp $ -->
158 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
159 <title>Configuration tool for PhpWiki <?php echo $config_file ?></title>
160 <style type="text/css" media="screen">
162 /* TABLE { border: thin solid black } */
163 body { font-family: Verdana, Arial, Helvetica, sans-serif; font-size: 80%; }
164 pre { font-size: 120%; }
165 td { border: thin solid black }
167 div.hint { border: thin solid red, background-color: #eeeeee; }
168 tr.hidden { border: none; display: none; }
169 td.part { background-color: #eeeeee; color: inherit; }
170 td.instructions { background-color: #ffffee; width: <?php echo $tdwidth ?>px; color: inherit; }
171 td.unchangeable-variable-top { border-bottom: none; background-color: #ffffee; color:inherit; }
172 td.unchangeable-variable-left { border-top: none; background-color: #ffffee; color:inherit; }
175 <script language="JavaScript" type="text/javascript">
177 function update(accepted, error, value, output) {
178 var msg = document.getElementById(output);
180 /* MSIE 5.0 fails here */
181 if (msg && msg.innerHTML) { msg.innerHTML = "<font color=\"green\">Input accepted.</font>"; }
183 while ((index = error.indexOf("%s")) > -1) {
184 error = error.substring(0, index) + value + error.substring(index+2);
186 if (msg) { msg.innerHTML = "<font color=\"red\">" + error + "</font>"; }
188 if (submit = document.getElementById('submit')) submit.disabled = accepted ? false : true;
191 function validate(error, value, output, field) {
192 update(field.value == value, error, field.value, output);
195 function validate_ereg(error, ereg, output, field) {
196 regex = new RegExp(ereg);
197 update(regex.test(field.value), error, field.value, output);
200 function validate_range(error, low, high, empty_ok, output, field) {
201 update((empty_ok == 1 && field.value == "") ||
202 (field.value >= low && field.value <= high),
203 error, field.value, output);
206 function toggle_group(id) {
207 var text = document.getElementById(id + "_text");
209 if (text.innerHTML == "Hide options.") {
211 text.innerHTML = "Show options.";
213 text.innerHTML = "Hide options.";
216 var rows = document.getElementsByTagName('tr');
218 for (i = 0; i < rows.length; i++) {
220 if (tr.className == 'header' && tr.id == id) {
225 for (; i < rows.length; i++) {
227 if (tr.className == 'header')
229 tr.className = do_hide ? 'hidden': 'nonhidden';
234 // Hide all groups. We do this via JavaScript to avoid
235 // hiding the groups if JavaScript is not supported...
236 var rows = document.getElementsByTagName('tr');
237 var show = '<?php echo $_GET["show"] ?>';
238 for (var i = 0; i < rows.length; i++) {
240 if (tr.className == 'header')
241 if (!show || tr.id != show)
245 // Select text in textarea upon focus
246 var area = document.getElementById('config-output');
248 listener = { handleEvent: function (e) { area.select(); } };
249 area.addEventListener('focus', listener, false);
256 <body onload="do_init();">
258 <h1>Configuration for PhpWiki <?php echo $config_file ?></h1>
261 Using this configurator.php is experimental!<br>
262 On any configuration problems, please edit the resulting config.ini manually.
266 //define('DEBUG', 1);
268 * The Configurator is a php script to aid in the configuration of PhpWiki.
269 * Parts of this file were based on PHPWeather's configurator.php file.
270 * http://sourceforge.net/projects/phpweather/
272 * TO CHANGE THE CONFIGURATION OF YOUR PHPWIKI, DO *NOT* MODIFY THIS FILE!
273 * more instructions go here
277 * * eval config.ini to get the actual settings.
280 //////////////////////////////
281 // begin configuration options
284 * Notes for the description parameter of $property:
286 * - Descriptive text will be changed into comments (preceeded by ; )
287 * for the final output to config.ini.
289 * - Only a limited set of html is allowed: pre, dl dt dd; it will be
290 * stripped from the final output.
292 * - Line breaks and spacing will be preserved for the final output.
294 * - Double line breaks are automatically converted to paragraphs
295 * for the html version of the descriptive text.
297 * - Double-quotes and dollar signs in the descriptive text must be
298 * escaped: \" and \$. Instead of escaping double-quotes you can use
299 * single (') quotes for the enclosing quotes.
301 * - Special characters like < and > must use html entities,
302 * they will be converted back to characters for the final output.
305 $SEPARATOR = ";=========================================================================";
308 ; This is the main configuration file for PhpWiki in INI-style format.
309 ; Note that certain characters are used as comment char and therefore
310 ; these entries must be in double-quotes. Such as \":\", \";\", \",\" and \"|\"
311 ; Take special care for DBAUTH_ sql statements. (Part 3a)
313 ; This file is divided into several parts: Each one has different configuration
314 ; settings you can change; in all cases the default should work on your system,
315 ; however, we recommend you tailor things to your particular setting.
316 ; Here undefined definitions get defined by config-default.ini settings.
319 $properties["Part Zero"] =
320 new part('_part0', $SEPARATOR."\n", "
321 Part Zero: (optional)
322 Latest Development and Tricky Options");
324 if (defined('INCLUDE_PATH'))
325 $include_path = INCLUDE_PATH;
327 if (substr(PHP_OS,0,3) == 'WIN') {
328 $include_path = dirname(__FILE__) . ';' . ini_get('include_path');
329 if (strchr(ini_get('include_path'),'/'))
330 $include_path = strtr($include_path,'\\','/');
332 $include_path = dirname(__FILE__) . ':' . ini_get('include_path');
336 $properties["PHP include_path"] =
337 new _define('INCLUDE_PATH', $include_path);
339 // TODO: convert this a checkbox row as in tests/unit/test.pgp
340 $properties["DEBUG"] =
341 new numeric_define_optional('DEBUG', DEBUG);
343 // TODO: bring the default to the front
344 $properties["ENABLE_USER_NEW"] =
345 new boolean_define_commented_optional
347 array('true' => "Enabled",
348 'false' => "Disabled."));
350 $properties["ENABLE_PAGEPERM"] =
351 new boolean_define_commented_optional
353 array('true' => "Enabled",
354 'false' => "Disabled."));
356 $properties["ENABLE_EDIT_TOOLBAR"] =
357 new boolean_define_commented_optional
358 ('ENABLE_EDIT_TOOLBAR',
359 array('true' => "Enabled",
360 'false' => "Disabled."));
362 $properties["JS_SEARCHREPLACE"] =
363 new boolean_define_commented_optional
365 array('true' => "Enabled",
366 'false' => "Disabled"));
368 $properties["ENABLE_DOUBLECLICKEDIT"] =
369 new boolean_define_commented_optional
370 ('ENABLE_DOUBLECLICKEDIT',
371 array('true' => "Enabled",
372 'false' => "Disabled"));
374 $properties["ENABLE_WYSIWYG"] =
375 new boolean_define_commented_optional
377 array('false' => "Disabled",
378 'true' => "Enabled"));
380 $properties["WYSIWYG_BACKEND"] =
381 new _define_selection(
383 array('tinymce' => 'tinymce',
384 'FCKeditor' => 'FCKeditor',
386 'htmlarea3' => 'htmlarea3',
387 'htmlarea2' => 'htmlarea2',
390 $properties["WYSIWYG_DEFAULT_PAGETYPE_HTML"] =
391 new boolean_define_commented_optional
392 ('WYSIWYG_DEFAULT_PAGETYPE_HTML',
393 array('false' => "Disabled",
394 'true' => "Enabled"));
396 $properties["ENABLE_XHTML_XML"] =
397 new boolean_define_commented_optional
399 array('false' => "Disabled",
400 'true' => "Enabled"));
402 $properties["ENABLE_SPAMASSASSIN"] =
403 new boolean_define_commented_optional
404 ('ENABLE_SPAMASSASSIN',
405 array('true' => "Enabled",
406 'false' => "Disabled"));
408 $properties["ENABLE_SPAMBLOCKLIST"] =
409 new boolean_define_optional
410 ('ENABLE_SPAMBLOCKLIST',
411 array('true' => "Enabled",
412 'false' => "Disabled"));
414 $properties["NUM_SPAM_LINKS"] =
415 new numeric_define_optional('NUM_SPAM_LINKS', "20", "
416 If more than this number of external links appear on non-authenticated
417 edits it will be rejected as spam.");
419 $properties["GOOGLE_LINKS_NOFOLLOW"] =
420 new boolean_define_commented_optional
421 ('GOOGLE_LINKS_NOFOLLOW',
422 array('true' => "Enabled",
423 'false' => "Disabled"));
425 $properties["ENABLE_LIVESEARCH"] =
426 new boolean_define_commented_optional
427 ('ENABLE_LIVESEARCH',
428 array('true' => "Enabled",
429 'false' => "Disabled"));
431 $properties["ENABLE_ACDROPDOWN"] =
432 new boolean_define_commented_optional
433 ('ENABLE_ACDROPDOWN',
434 array('true' => "Enabled",
435 'false' => "Disabled"));
437 $properties["ENABLE_DISCUSSION_LINK"] =
438 new boolean_define_commented_optional
439 ('ENABLE_DISCUSSION_LINK',
440 array('true' => "Enabled",
441 'false' => "Disabled"));
443 $properties["ENABLE_CAPTCHA"] =
444 new boolean_define_commented_optional
446 array('true' => "Enabled",
447 'false' => "Disabled"));
449 $properties["USE_SAFE_DBSESSION"] =
450 new boolean_define_commented_optional
451 ('USE_SAFE_DBSESSION',
452 array('false' => "Disabled",
453 'true' => "Enabled"));
455 $properties["Part One"] =
456 new part('_part1', $SEPARATOR."\n", "
457 Part One: Authentication and security settings. See Part Three for more.");
459 $properties["Wiki Name"] =
460 new _define_optional('WIKI_NAME', WIKI_NAME);
462 $properties["Admin Username"] =
463 new _define_notempty('ADMIN_USER', ADMIN_USER, "
464 You must set this! Username and password of the administrator.",
465 "onchange=\"validate_ereg('Sorry, ADMIN_USER cannot be empty.', '^.+$', 'ADMIN_USER', this);\"");
467 $properties["Admin Password"] =
468 new _define_password('ADMIN_PASSWD', ADMIN_PASSWD, "
470 For heaven's sake pick a good password.
472 If your version of PHP supports encrypted passwords, your password will be
473 automatically encrypted within the generated config file.
474 Use the \"Create Random Password\" button to create a good (random) password.
476 ADMIN_PASSWD is ignored on HttpAuth",
477 "onchange=\"validate_ereg('Sorry, ADMIN_PASSWD must be at least 4 chars long.', '^....+$', 'ADMIN_PASSWD', this);\"");
479 $properties["Encrypted Passwords"] =
482 array('true' => "true. use crypt for all passwords",
483 'false' => "false. use plaintest passwords (not recommended)"));
485 $properties["Reverse DNS"] =
486 new boolean_define_optional
487 ('ENABLE_REVERSE_DNS',
488 array('true' => "true. perform additional reverse dns lookups",
489 'false' => "false. just record the address as given by the httpd server"));
491 $properties["ZIPdump Authentication"] =
492 new boolean_define_optional('ZIPDUMP_AUTH',
493 array('false' => "false. Everyone may download zip dumps",
494 'true' => "true. Only admin may download zip dumps"));
496 $properties["Enable RawHtml Plugin"] =
497 new boolean_define_commented_optional
499 array('true' => "Enabled",
500 'false' => "Disabled"));
502 $properties["Allow RawHtml Plugin only on locked pages"] =
503 new boolean_define_commented_optional
504 ('ENABLE_RAW_HTML_LOCKEDONLY',
505 array('true' => "Enabled",
506 'false' => "Disabled"));
508 $properties["Allow RawHtml Plugin if safe HTML code"] =
509 new boolean_define_commented_optional
510 ('ENABLE_RAW_HTML_SAFE',
511 array('true' => "Enabled",
512 'false' => "Disabled"), "
513 If this is set, all unsafe html code is stripped automatically (experimental!)
514 See <a href=\"http://chxo.com/scripts/safe_html-test.php\" target=\"_new\">chxo.com/scripts/safe_html-test.php</a>
517 $properties["Maximum Upload Size"] =
518 new numeric_define_optional('MAX_UPLOAD_SIZE', MAX_UPLOAD_SIZE);
520 $properties["Minor Edit Timeout"] =
521 new numeric_define_optional('MINOR_EDIT_TIMEOUT', MINOR_EDIT_TIMEOUT);
523 $properties["Disabled Actions"] =
524 new array_define('DISABLED_ACTIONS', DISABLED_ACTIONS /*array()*/);
526 $properties["Moderate all Pagechanges"] =
527 new boolean_define_commented_optional
528 ('ENABLE_MODERATEDPAGE_ALL',
529 array('false' => "Disabled",
530 'true' => "Enabled"));
532 $properties["Access Log File"] =
533 new _define_commented_optional('ACCESS_LOG', ACCESS_LOG);
535 $properties["Access Log SQL"] =
536 new _define_selection(
538 array('0' => 'disabled',
540 '2' => 'read + write'));
542 $properties["Compress Output"] =
543 new boolean_define_commented_optional
545 array('' => 'undefined - GZIP compress when appropriate.',
546 'false' => 'Never compress output.',
547 'true' => 'Always try to compress output.'));
549 $properties["HTTP Cache Control"] =
550 new _define_selection_optional
552 array('LOOSE' => 'LOOSE',
553 'STRICT' => 'STRICT',
554 'NO_CACHE' => 'NO_CACHE',
555 'ALLOW_STALE' => 'ALLOW_STALE'),
559 This controls how PhpWiki sets the HTTP cache control
560 headers (Expires: and Cache-Control:)
566 <dd>This is roughly the old (pre 1.3.4) behaviour. PhpWiki will
567 instruct proxies and browsers never to cache PhpWiki output.</dd>
570 <dd>Cached pages will be invalidated whenever the database global
571 timestamp changes. This should behave just like NONE (modulo
572 bugs in PhpWiki and your proxies and browsers), except that
573 things will be slightly more efficient.</dd>
576 <dd>Cached pages will be invalidated whenever they are edited,
577 or, if the pages include plugins, when the plugin output could
578 concievably have changed.
580 <p>Behavior should be much like STRICT, except that sometimes
581 wikilinks will show up as undefined (with the question mark)
582 when in fact they refer to (recently) created pages.
583 (Hitting your browsers reload or perhaps shift-reload button
584 should fix the problem.)</p></dd>
587 <dd>Proxies and browsers will be allowed to used stale pages.
588 (The timeout for stale pages is controlled by CACHE_CONTROL_MAX_AGE.)
590 <p>This setting will result in quirky behavior. When you edit a
591 page your changes may not show up until you shift-reload the
594 <p>This setting is generally not advisable, however it may be useful
595 in certain cases (e.g. if your wiki gets lots of page views,
596 and few edits by knowledgable people who won't freak over the quirks.)</p>
599 The default is currently LOOSE.");
601 $properties["HTTP Cache Control Max Age"] =
602 new numeric_define_optional('CACHE_CONTROL_MAX_AGE', CACHE_CONTROL_MAX_AGE);
604 $properties["Markup Caching"] =
605 new boolean_define_commented_optional
606 ('WIKIDB_NOCACHE_MARKUP',
607 array('false' => 'Enable markup cache',
608 'true' => 'Disable markup cache'));
610 $properties["COOKIE_EXPIRATION_DAYS"] =
611 new numeric_define_optional('COOKIE_EXPIRATION_DAYS', COOKIE_EXPIRATION_DAYS);
613 $properties["COOKIE_DOMAIN"] =
614 new _define_commented_optional('COOKIE_DOMAIN', COOKIE_DOMAIN);
616 $properties["Path for PHP Session Support"] =
617 new _define_optional('SESSION_SAVE_PATH', defined('SESSION_SAVE_PATH') ? SESSION_SAVE_PATH : ini_get('session.save_path'));
619 $properties["Force PHP Database Sessions"] =
620 new boolean_define_commented_optional
622 array('false' => 'Disable database sessions, use files',
623 'true' => 'Enable database sessions'));
625 ///////// database selection
627 $properties["Part Two"] =
628 new part('_part2', $SEPARATOR."\n", "
631 Database Configuration
634 $properties["Database Type"] =
635 new _define_selection("DATABASE_TYPE",
636 array('dba' => "dba",
638 'ADODB' => "SQL ADODB",
639 'PDO' => "PDO (php5 only)",
640 'file' => "flatfile",
641 'cvs' => "CVS File handler")/*, "
642 Select the database backend type:
643 Choose dba (default) to use one of the standard UNIX dba libraries. This is the fastest.
644 Choose ADODB or SQL to use an SQL database with ADODB or PEAR.
645 Choose PDO on php5 to use an SQL database. (experimental, no paging yet)
646 flatfile is simple and slow.
647 CVS is highly experimental and slow.
648 Recommended is dba or SQL: PEAR or ADODB."*/);
650 $properties["SQL DSN Setup"] =
651 new unchangeable_variable('_sqldsnstuff', "", "
652 For SQL based backends, specify the database as a DSN
653 The most general form of a DSN looks like:
655 phptype(dbsyntax)://username:password@protocol+hostspec/database?option=value
657 For a MySQL database, the following should work:
659 mysql://user:password@host/databasename
661 To connect over a unix socket, use something like
663 mysql://user:password@unix(/path/to/socket)/databasename
666 DATABASE_DSN = mysql://guest@:/var/lib/mysql/mysql.sock/phpwiki
667 DATABASE_DSN = mysql://guest@localhost/phpwiki
668 DATABASE_DSN = pgsql://localhost/user_phpwiki
671 // Choose ADODB or SQL to use an SQL database with ADODB or PEAR.
672 // Choose dba to use one of the standard UNIX dbm libraries.
674 $properties["SQL Type"] =
675 new _variable_selection('_dsn_sqltype',
676 array('mysql' => "MySQL",
677 'pgsql' => "PostgreSQL",
678 'mssql' => "Microsoft SQL Server",
679 'oci8' => "Oracle 8",
680 'mysqli' => "mysqli (only ADODB)",
681 'mysqlt' => "mysqlt (only ADODB)",
682 'ODBC' => "ODBC (only ADODB or PDO)",
683 'firebird' => "Firebird (only PDO)",
684 'oracle' => "Oracle (only PDO)",
686 SQL DB types. The DSN hosttype.");
688 $properties["SQL User"] =
689 new _variable('_dsn_sqluser', "wikiuser", "
692 $properties["SQL Password"] =
693 new _variable('_dsn_sqlpass', "", "
696 $properties["SQL Database Host"] =
697 new _variable('_dsn_sqlhostorsock', "localhost", "
698 SQL Database Hostname:
700 To connect over a local named socket, use something like
702 unix(/var/lib/mysql/mysql.sock)
705 mysql on Windows via named pipes might need 127.0.0.1");
707 $properties["SQL Database Name"] =
708 new _variable('_dsn_sqldbname', "phpwiki", "
709 SQL Database Name:");
711 $dsn_sqltype = $properties["SQL Type"]->value();
712 $dsn_sqluser = $properties["SQL User"]->value();
713 $dsn_sqlpass = $properties["SQL Password"]->value();
714 $dsn_sqlhostorsock = $properties["SQL Database Host"]->value();
715 $dsn_sqldbname = $properties["SQL Database Name"]->value();
716 $dsn_sqlstring = $dsn_sqltype."://{$dsn_sqluser}:{$dsn_sqlpass}@{$dsn_sqlhostorsock}/{$dsn_sqldbname}";
718 $properties["SQL dsn"] =
719 new unchangeable_define("DATABASE_DSN",
721 Calculated from the settings above:");
723 $properties["Filename / Table name Prefix"] =
724 new _define_commented("DATABASE_PREFIX", DATABASE_PREFIX, "
725 Used by all DB types:
727 Prefix for filenames or table names, e.g. \"phpwiki_\"
729 Currently <b>you MUST EDIT THE SQL file too!</b> (in the schemas/
730 directory because we aren't doing on the fly sql generation
731 during the installation.");
733 $properties["DATABASE_PERSISTENT"] =
734 new boolean_define_commented_optional
735 ('DATABASE_PERSISTENT',
736 array('false' => "Disabled",
737 'true' => "Enabled"));
739 $properties["DB Session table"] =
740 new _define_optional("DATABASE_SESSION_TABLE", DATABASE_SESSION_TABLE, "
741 Tablename to store session information. Only supported by SQL backends.
743 A word of warning - any prefix defined above will be prepended to whatever is given here.
747 $temp = !empty($_ENV['TEMP']) ? $_ENV['TEMP'] : "/tmp";
748 $properties["dba directory"] =
749 new _define("DATABASE_DIRECTORY", $temp);
751 // TODO: list the available methods
752 $properties["dba handler"] =
753 new _define_selection('DATABASE_DBA_HANDLER',
754 array('gdbm' => "gdbm - GNU database manager (not recommended anymore)",
755 'dbm' => "DBM - Redhat default. On sf.net there's dbm and not gdbm anymore",
756 'db2' => "DB2 - BerkeleyDB (Sleepycat) DB2",
757 'db3' => "DB3 - BerkeleyDB (Sleepycat) DB3. Default on Windows but not on every Linux",
758 'db4' => "DB4 - BerkeleyDB (Sleepycat) DB4."), "
759 Use 'gdbm', 'dbm', 'db2', 'db3' or 'db4' depending on your DBA handler methods supported: <br > "
760 . (function_exists("dba_handlers") ? join(", ",dba_handlers()) : "")
761 . "\n\nBetter not use other hacks such as inifile, flatfile or cdb");
763 $properties["dba timeout"] =
764 new numeric_define("DATABASE_TIMEOUT", DATABASE_TIMEOUT, "
765 Recommended values are 10-20 seconds. The more load the server has, the higher the timeout.");
767 $properties["DBADMIN_USER"] =
768 new _define_optional('DBADMIN_USER', DBADMIN_USER. "
769 If action=upgrade detects mysql problems, but has no ALTER permissions,
770 give here a database username which has the necessary ALTER or CREATE permissions.
771 Of course you can fix your database manually. See lib/upgrade.php for known issues.");
773 $properties["DBADMIN_PASSWD"] =
774 new _define_password_optional('DBADMIN_PASSWD', DBADMIN_PASSWD);
776 $properties["USECACHE"] =
777 new boolean_define_commented_optional
779 array('true' => "Enabled",
780 'false' => "Disabled"));
784 $properties["Page Revisions"] =
785 new unchangeable_variable('_parttworevisions', "", "
787 Section 2a: Archive Cleanup
788 The next section controls how many old revisions of each page are kept in the database.
790 There are two basic classes of revisions: major and minor. Which
791 class a revision belongs in is determined by whether the author
792 checked the \"this is a minor revision\" checkbox when they saved the
795 There is, additionally, a third class of revisions: author
796 revisions. The most recent non-mergable revision from each distinct
797 author is and author revision.
799 The expiry parameters for each of those three classes of revisions
800 can be adjusted seperately. For each class there are five
801 parameters (usually, only two or three of the five are actually
802 set) which control how long those revisions are kept in the
805 <dt>max_keep:</dt> <dd>If set, this specifies an absolute maximum for the
806 number of archived revisions of that class. This is
807 meant to be used as a safety cap when a non-zero
808 min_age is specified. It should be set relatively high,
809 and it's purpose is to prevent malicious or accidental
810 database overflow due to someone causing an
811 unreasonable number of edits in a short period of time.</dd>
813 <dt>min_age:</dt> <dd>Revisions younger than this (based upon the supplanted
814 date) will be kept unless max_keep is exceeded. The age
815 should be specified in days. It should be a
816 non-negative, real number,</dd>
818 <dt>min_keep:</dt> <dd>At least this many revisions will be kept.</dd>
820 <dt>keep:</dt> <dd>No more than this many revisions will be kept.</dd>
822 <dt>max_age:</dt> <dd>No revision older than this age will be kept.</dd>
824 Supplanted date: Revisions are timestamped at the instant that they
825 cease being the current revision. Revision age is computed using
826 this timestamp, not the edit time of the page.
828 Merging: When a minor revision is deleted, if the preceding
829 revision is by the same author, the minor revision is merged with
830 the preceding revision before it is deleted. Essentially: this
831 replaces the content (and supplanted timestamp) of the previous
832 revision with the content after the merged minor edit, the rest of
833 the page metadata for the preceding version (summary, mtime, ...)
837 // For now the expiration parameters are statically inserted as
838 // an unchangeable property. You'll have to edit the resulting
839 // config file if you really want to change these from the default.
841 $properties["Major Edits: keep minimum days"] =
842 new numeric_define("MAJOR_MIN_KEEP", MAJOR_MIN_KEEP, "
843 Default: Keep for unlimited time.
844 Set to 0 to enable archive cleanup");
845 $properties["Minor Edits: keep minumum days"] =
846 new numeric_define("MINOR_MIN_KEEP", MINOR_MIN_KEEP, "
847 Default: Keep for unlimited time.
848 Set to 0 to enable archive cleanup");
850 $properties["Major Edits: how many"] =
851 new numeric_define("MAJOR_KEEP", MAJOR_KEEP, "
852 Keep up to 8 major edits");
853 $properties["Major Edits: how many days"] =
854 new numeric_define("MAJOR_MAX_AGE", MAJOR_MAX_AGE, "
855 keep them no longer than a month");
857 $properties["Minor Edits: how many"] =
858 new numeric_define("MINOR_KEEP", MINOR_KEEP, "
859 Keep up to 4 minor edits");
860 $properties["Minor Edits: how many days"] =
861 new numeric_define("MINOR_MAX_AGE", "7", "
862 keep them no longer than a week");
864 $properties["per Author: how many"] =
865 new numeric_define("AUTHOR_KEEP", "8", "
866 Keep the latest contributions of the last 8 authors,");
867 $properties["per Author: how many days"] =
868 new numeric_define("AUTHOR_MAX_AGE", "365", "
870 $properties["per Author: keep minumum days"] =
871 new numeric_define("AUTHOR_MIN_AGE", "7", "
872 Additionally, (in the case of a particularly active page) try to
873 keep the latest contributions of all authors in the last week (even if there are more than eight of them,)");
874 $properties["per Author: max revisions"] =
875 new numeric_define("AUTHOR_MAX_KEEP", "20", "
876 but in no case keep more than twenty unique author revisions.");
878 /////////////////////////////////////////////////////////////////////
880 $properties["Part Three"] =
881 new part('_part3', $SEPARATOR."\n", "
883 Part Three: (optional)
884 Basic User Authentication Setup
887 $properties["Publicly viewable"] =
888 new boolean_define_optional('ALLOW_ANON_USER',
889 array('true' => "true. Permit anonymous view. (Default)",
890 'false' => "false. Force login even on view (strictly private)"), "
891 If ALLOW_ANON_USER is false, you have to login before viewing any page or doing any other action on a page.");
893 $properties["Allow anonymous edit"] =
894 new boolean_define_optional('ALLOW_ANON_EDIT',
895 array('true' => "true. Permit anonymous users to edit. (Default)",
896 'false' => "false. Force login on edit (moderately locked)"), "
897 If ALLOW_ANON_EDIT is false, you have to login before editing or changing any page. See below.");
899 $properties["Allow Bogo Login"] =
900 new boolean_define_optional('ALLOW_BOGO_LOGIN',
901 array('true' => "true. Users may Sign In with any WikiWord, without password. (Default)",
902 'false' => "false. Require stricter authentication."), "
903 If ALLOW_BOGO_LOGIN is false, you may not login with any wikiword username and empty password.
904 If true, users are allowed to create themselves with any WikiWord username. See below.");
906 $properties["Allow User Passwords"] =
907 new boolean_define_optional('ALLOW_USER_PASSWORDS',
908 array('true' => "True user authentication with password checking. (Default)",
909 'false' => "false. Ignore authentication settings below."), "
910 If ALLOW_USER_PASSWORDS is true, the authentication settings below define where and how to
911 check against given username/passwords. For completely security disable BOGO_LOGIN and ANON_EDIT above.");
913 $properties["User Authentication Methods"] =
914 new array_define('USER_AUTH_ORDER', array("PersonalPage", "Db"), "
915 Many different methods can be used to check user's passwords.
916 Try any of these in the given order:
919 <dd>WikiWord username, with no *actual* password checking,
920 although the user will still have to enter one.</dd>
921 <dt>PersonalPage</dt>
922 <dd>Store passwords in the users homepage metadata (simple)</dd>
924 <dd>Use DBAUTH_AUTH_* (see below) with PearDB or ADODB only.</dd>
926 <dd>Authenticate against LDAP_AUTH_HOST with LDAP_BASE_DN.</dd>
928 <dd>Authenticate against IMAP_AUTH_HOST (email account)</dd>
930 <dd>Authenticate against POP3_AUTH_HOST (email account)</dd>
932 <dd>Get username and level from a PHP session variable. (e.g. for gforge)</dd>
934 <dd>Store username:crypted-passwords in .htaccess like files.
935 Use Apache's htpasswd to manage this file.</dd>
937 <dd>Use the protection by the webserver (.htaccess/.htpasswd) (experimental)
938 Enforcing HTTP Auth not yet. Note that the ADMIN_USER should exist also.
939 Using HttpAuth disables all other methods and no userauth sessions are used.</dd>
942 Several of these methods can be used together, in the manner specified by
943 USER_AUTH_POLICY, below. To specify multiple authentication methods,
944 separate the name of each one with colons.
946 USER_AUTH_ORDER = 'PersonalPage : Db'
947 USER_AUTH_ORDER = 'BogoLogin : PersonalPage'
950 $properties["PASSWORD_LENGTH_MINIMUM"] =
951 new numeric_define("PASSWORD_LENGTH_MINIMUM", "6");
953 $properties["USER_AUTH_POLICY"] =
954 new _define_selection('USER_AUTH_POLICY',
955 array('first-only' => "first-only - use only the first method in USER_AUTH_ORDER",
956 'old' => "old - ignore USER_AUTH_ORDER (legacy)",
957 'strict' => "strict - check all methods for userid + password (recommended)",
958 'stacked' => "stacked - check all methods for userid, and if found for password"), "
959 The following policies are available for user authentication:
962 <dd>use only the first method in USER_AUTH_ORDER</dd>
964 <dd>ignore USER_AUTH_ORDER and try to use all available
965 methods as in the previous PhpWiki releases (slow)</dd>
967 <dd>check if the user exists for all methods:
968 on the first existing user, try the password.
969 dont try the other methods on failure then</dd>
971 <dd>check the given user - password combination for all
972 methods and return true on the first success.</dd></dl>");
976 $properties["Part Three A"] =
977 new part('_part3a', $SEPARATOR."\n", "
979 Part Three A: (optional)
982 $properties["Group membership"] =
983 new _define_selection("GROUP_METHOD",
984 array('WIKIPAGE' => "WIKIPAGE - List at \"CategoryGroup\". (Slowest, but easiest to maintain)",
985 '"NONE"' => "NONE - Disable group membership (Fastest)",
986 'DB' => "DB - SQL Database, Optionally external. See USERS/GROUPS queries",
987 'FILE' => "Flatfile. See AUTH_GROUP_FILE below.",
988 'LDAP' => "LDAP - See \"LDAP authentication options\" above. (Experimental)"), "
989 Group membership. PhpWiki supports defining permissions for a group as
990 well as for individual users. This defines how group membership information
991 is obtained. Supported values are:
994 <dd>Disable group membership (Fastest). Note the required quoting.</dd>
996 <dd>Define groups as list at \"CategoryGroup\". (Slowest, but easiest to maintain)</dd>
998 <dd>Stored in an SQL database. Optionally external. See USERS/GROUPS queries</dd>
1000 <dd>Flatfile. See AUTH_GROUP_FILE below.</dd>
1002 <dd>LDAP groups. See \"LDAP authentication options\" above and
1003 lib/WikiGroup.php. (experimental)</dd></dl>");
1005 $properties["CATEGORY_GROUP_PAGE"] =
1006 new _define_optional('CATEGORY_GROUP_PAGE', _("CategoryGroup"), "
1007 If GROUP_METHOD = WIKIPAGE:
1009 Page where all groups are listed.");
1011 $properties["AUTH_GROUP_FILE"] =
1012 new _define_optional('AUTH_GROUP_FILE', _("/etc/groups"), "
1013 For GROUP_METHOD = FILE, the file given below is referenced to obtain
1014 group membership information. It should be in the same format as the
1015 standard unix /etc/groups(5) file.");
1017 $properties["Part Three B"] =
1018 new part('_part3b', $SEPARATOR."\n", "
1020 Part Three B: (optional)
1021 External database authentication and authorization.
1023 If USER_AUTH_ORDER includes Db, or GROUP_METHOD = DB, the options listed
1024 below define the SQL queries used to obtain the information out of the
1025 database, and (optionally) store the information back to the DB.");
1027 $properties["DBAUTH_AUTH_DSN"] =
1028 new _define_optional('DBAUTH_AUTH_DSN', $dsn_sqlstring, "
1029 A database DSN to connect to. Defaults to the DSN specified for the Wiki as a whole.");
1031 $properties["User Exists Query"] =
1032 new _define('DBAUTH_AUTH_USER_EXISTS', "SELECT userid FROM user WHERE userid='\$userid'", "
1033 USER/PASSWORD queries:
1035 For USER_AUTH_POLICY=strict and the Db method is required");
1037 $properties["Check Query"] =
1038 new _define_optional('DBAUTH_AUTH_CHECK', "SELECT IF(passwd='\$password',1,0) AS ok FROM user WHERE userid='\$userid'", "
1040 Check to see if the supplied username/password pair is OK
1042 Plaintext passwords: (DBAUTH_AUTH_CRYPT_METHOD = plain)<br>
1043 ; DBAUTH_AUTH_CHECK = \"SELECT IF(passwd='\$password',1,0) AS ok FROM user WHERE userid='\$userid'\"
1045 database-hashed passwords (more secure):<br>
1046 ; DBAUTH_AUTH_CHECK = \"SELECT IF(passwd=PASSWORD('\$password'),1,0) AS ok FROM user WHERE userid='\$userid'\"");
1048 $properties["Crypt Method"] =
1049 new _define_selection_optional
1050 ('DBAUTH_AUTH_CRYPT_METHOD',
1051 array('plain' => 'plain',
1052 'crypt' => 'crypt'), "
1053 If you want to use Unix crypt()ed passwords, you can use DBAUTH_AUTH_CHECK
1054 to get the password out of the database with a simple SELECT query, and
1055 specify DBAUTH_AUTH_USER_EXISTS and DBAUTH_AUTH_CRYPT_METHOD:
1057 ; DBAUTH_AUTH_CHECK = \"SELECT passwd FROM user where userid='\$userid'\" <br>
1058 ; DBAUTH_AUTH_CRYPT_METHOD = crypt");
1060 $properties["Update the user's authentication credential"] =
1061 new _define('DBAUTH_AUTH_UPDATE', "UPDATE user SET passwd='\$password' WHERE userid='\$userid'", "
1062 If this is not defined but DBAUTH_AUTH_CHECK is, then the user will be unable to update their
1065 Plaintext passwords:<br>
1066 DBAUTH_AUTH_UPDATE = \"UPDATE user SET passwd='\$password' WHERE userid='\$userid'\"<br>
1067 Database-hashed passwords:<br>
1068 DBAUTH_AUTH_UPDATE = \"UPDATE user SET passwd=PASSWORD('\$password') WHERE userid='\$userid'\"");
1070 $properties["Allow the user to create their own account"] =
1071 new _define_optional('DBAUTH_AUTH_CREATE', "INSERT INTO user SET passwd=PASSWORD('\$password'),userid='\$userid'", "
1072 If this is empty, Db users cannot subscribe by their own.");
1074 $properties["USER/PREFERENCE queries"] =
1075 new _define_optional('DBAUTH_PREF_SELECT', "SELECT prefs FROM user WHERE userid='\$userid'", "
1076 If you choose to store your preferences in an external database, enable
1077 the following queries. Note that if you choose to store user preferences
1078 in the 'user' table, only registered users get their prefs from the database,
1079 self-created users do not. Better to use the special 'pref' table.
1081 The prefs field stores the serialized form of the user's preferences array,
1082 to ease the complication of storage.
1084 DBAUTH_PREF_SELECT = \"SELECT prefs FROM user WHERE userid='\$userid'\"
1085 DBAUTH_PREF_SELECT = \"SELECT prefs FROM pref WHERE userid='\$userid'\"
1088 $properties["Update the user's preferences"] =
1089 new _define_optional('DBAUTH_PREF_UPDATE', "UPDATE user SET prefs='\$pref_blob' WHERE userid='\$userid'", "
1090 Note that REPLACE works only with mysql and destroy all other columns!
1092 Mysql: DBAUTH_PREF_UPDATE = \"REPLACE INTO pref SET prefs='\$pref_blob',userid='\$userid'\"");
1094 $properties["USERS/GROUPS queries"] =
1095 new _define_optional('DBAUTH_IS_MEMBER', "SELECT user FROM user WHERE user='\$userid' AND group='\$groupname'", "
1096 You can define 1:n or n:m user<=>group relations, as you wish.
1098 Sample configurations:
1100 only one group per user (1:n):<br>
1101 DBAUTH_IS_MEMBER = \"SELECT user FROM user WHERE user='\$userid' AND group='\$groupname'\"<br>
1102 DBAUTH_GROUP_MEMBERS = \"SELECT user FROM user WHERE group='\$groupname'\"<br>
1103 DBAUTH_USER_GROUPS = \"SELECT group FROM user WHERE user='\$userid'\"<br>
1104 multiple groups per user (n:m):<br>
1105 DBAUTH_IS_MEMBER = \"SELECT userid FROM member WHERE userid='\$userid' AND groupname='\$groupname'\"<br>
1106 DBAUTH_GROUP_MEMBERS = \"SELECT DISTINCT userid FROM member WHERE groupname='\$groupname'\"<br>
1107 DBAUTH_USER_GROUPS = \"SELECT groupname FROM member WHERE userid='\$userid'\"<br>");
1108 $properties["DBAUTH_GROUP_MEMBERS"] =
1109 new _define_optional('DBAUTH_GROUP_MEMBERS', "SELECT user FROM user WHERE group='\$groupname'", "");
1110 $properties["DBAUTH_USER_GROUPS"] =
1111 new _define_optional('DBAUTH_USER_GROUPS', "SELECT group FROM user WHERE user='\$userid'", "");
1113 if (function_exists('ldap_connect')) {
1115 $properties["LDAP AUTH Host"] =
1116 new _define_optional('LDAP_AUTH_HOST', "ldap://localhost:389", "
1117 If USER_AUTH_ORDER contains Ldap:
1119 The LDAP server to connect to. Can either be a hostname, or a complete
1120 URL to the server (useful if you want to use ldaps or specify a different
1123 $properties["LDAP BASE DN"] =
1124 new _define_optional('LDAP_BASE_DN', "ou=mycompany.com,o=My Company", "
1125 The organizational or domain BASE DN: e.g. \"dc=mydomain,dc=com\".
1127 Note: ou=Users and ou=Groups are used for GroupLdap Membership
1128 Better use LDAP_OU_USERS and LDAP_OU_GROUP with GROUP_METHOD=LDAP.");
1130 $properties["LDAP SET OPTION"] =
1131 new _define_optional('LDAP_SET_OPTION', "LDAP_OPT_PROTOCOL_VERSION=3:LDAP_OPT_REFERRALS=0", "
1132 Some LDAP servers need some more options, such as the Windows Active
1133 Directory Server. Specify the options (as allowed by the PHP LDAP module)
1134 and their values as NAME=value pairs separated by colons.");
1136 $properties["LDAP AUTH USER"] =
1137 new _define_optional('LDAP_AUTH_USER', "CN=ldapuser,ou=Users,o=Development,dc=mycompany.com", "
1138 DN to initially bind to the LDAP server as. This is needed if the server doesn't
1139 allow anonymous queries. (Windows Active Directory Server)");
1141 $properties["LDAP AUTH PASSWORD"] =
1142 new _define_optional('LDAP_AUTH_PASSWORD', "secret", "
1143 Password to use to initially bind to the LDAP server, as the DN
1144 specified in the LDAP_AUTH_USER option (above).");
1146 $properties["LDAP SEARCH FIELD"] =
1147 new _define_optional('LDAP_SEARCH_FIELD', "uid", "
1148 If you want to match usernames against an attribute other than uid,
1149 specify it here. Default: uid
1151 e.g.: LDAP_SEARCH_FIELD = sAMAccountName");
1153 $properties["LDAP OU USERS"] =
1154 new _define_optional('LDAP_OU_USERS', "ou=Users", "
1155 If you have an organizational unit for all users, define it here.
1156 This narrows the search, and is needed for LDAP group membership (if GROUP_METHOD=LDAP)
1157 Default: ou=Users");
1159 $properties["LDAP OU GROUP"] =
1160 new _define_optional('LDAP_OU_GROUP', "ou=Groups", "
1161 If you have an organizational unit for all groups, define it here.
1162 This narrows the search, and is needed for LDAP group membership (if GROUP_METHOD=LDAP)
1163 The entries in this ou must have a gidNumber and cn attribute.
1164 Default: ou=Groups");
1166 } else { // function_exists('ldap_connect')
1168 $properties["LDAP Authentication"] =
1169 new unchangeable_variable('LDAP Authentication', "
1170 ; If USER_AUTH_ORDER contains Ldap:
1172 ; The LDAP server to connect to. Can either be a hostname, or a complete
1173 ; URL to the server (useful if you want to use ldaps or specify a different
1175 ;LDAP_AUTH_HOST = \"ldap://localhost:389\"
1177 ; The organizational or domain BASE DN: e.g. \"dc=mydomain,dc=com\".
1179 ; Note: ou=Users and ou=Groups are used for GroupLdap Membership
1180 ; Better use LDAP_OU_USERS and LDAP_OU_GROUP with GROUP_METHOD=LDAP.
1181 ;LDAP_BASE_DN = \"ou=Users,o=Development,dc=mycompany.com\"
1183 ; Some LDAP servers need some more options, such as the Windows Active
1184 ; Directory Server. Specify the options (as allowed by the PHP LDAP module)
1185 ; and their values as NAME=value pairs separated by colons.
1186 ; LDAP_SET_OPTION = \"LDAP_OPT_PROTOCOL_VERSION=3:LDAP_OPT_REFERRALS=0\"
1188 ; DN to initially bind to the LDAP server as. This is needed if the server doesn't
1189 ; allow anonymous queries. (Windows Active Directory Server)
1190 ; LDAP_AUTH_USER = \"CN=ldapuser,ou=Users,o=Development,dc=mycompany.com\"
1192 ; Password to use to initially bind to the LDAP server, as the DN
1193 ; specified in the LDAP_AUTH_USER option (above).
1194 ; LDAP_AUTH_PASSWORD = secret
1196 ; If you want to match usernames against an attribute other than uid,
1197 ; specify it here. Default: uid
1198 ; LDAP_SEARCH_FIELD = sAMAccountName
1200 ; If you have an organizational unit for all users, define it here.
1201 ; This narrows the search, and is needed for LDAP group membership (if GROUP_METHOD=LDAP)
1203 ; LDAP_OU_USERS = ou=Users
1205 ; If you have an organizational unit for all groups, define it here.
1206 ; This narrows the search, and is needed for LDAP group membership (if GROUP_METHOD=LDAP)
1207 ; The entries in this ou must have a gidNumber and cn attribute.
1208 ; Default: ou=Groups
1209 ; LDAP_OU_GROUP = ou=Groups", "
1210 ; Ignored. No LDAP support in this php. configure --with-ldap");
1213 if (function_exists('imap_open')) {
1215 $properties["IMAP Auth Host"] =
1216 new _define_optional('IMAP_AUTH_HOST', 'localhost:143/imap/notls', "
1217 If USER_AUTH_ORDER contains IMAP:
1219 The IMAP server to check usernames from. Defaults to localhost.
1221 Some IMAP_AUTH_HOST samples:
1222 localhost, localhost:143/imap/notls,
1223 localhost:993/imap/ssl/novalidate-cert (SuSE refuses non-SSL conections)");
1225 } else { // function_exists('imap_open')
1227 $properties["IMAP Authentication"] =
1228 new unchangeable_variable('IMAP_AUTH_HOST',"
1229 ; If USER_AUTH_ORDER contains IMAP:
1230 ; The IMAP server to check usernames from. Defaults to localhost.
1232 ; Some IMAP_AUTH_HOST samples:
1233 ; localhost, localhost:143/imap/notls,
1234 ; localhost:993/imap/ssl/novalidate-cert (SuSE refuses non-SSL conections)
1235 ;IMAP_AUTH_HOST = localhost:143/imap/notls", "
1236 Ignored. No IMAP support in this php. configure --with-imap");
1240 $properties["POP3 Authentication"] =
1241 new _define_optional('POP3_AUTH_HOST', 'localhost:110', "
1242 If USER_AUTH_ORDER contains POP3:
1244 The POP3 mail server to check usernames and passwords against.");
1245 $properties["File Authentication"] =
1246 new _define_optional('AUTH_USER_FILE', '/etc/shadow', "
1247 If USER_AUTH_ORDER contains File:
1249 File to read for authentication information.
1250 Popular choices are /etc/shadow and /etc/httpd/.htpasswd");
1252 $properties["File Storable?"] =
1253 new boolean_define_commented_optional
1254 ('AUTH_USER_FILE_STORABLE',
1255 array('false' => "Disabled",
1256 'true' => "Enabled"), "
1257 Defines whether the user is able to change their own password via PhpWiki.
1258 Note that this means that the webserver user must be able to write to the
1259 file specified in AUTH_USER_FILE.");
1261 $properties["Session Auth USER"] =
1262 new _define_optional('AUTH_SESS_USER', 'userid', "
1263 If USER_AUTH_ORDER contains Session:
1265 Name of the session variable which holds the already authenticated username.
1266 Sample: 'userid', 'user[username]', 'user->username'");
1268 $properties["Session Auth LEVEL"] =
1269 new numeric_define('AUTH_SESS_LEVEL', '2', "
1270 Which level will the user be? 1 = Bogo or 2 = Pass");
1272 /////////////////////////////////////////////////////////////////////
1274 $properties["Part Four"] =
1275 new part('_part4', $SEPARATOR."\n", "
1278 Page appearance and layout");
1280 $properties["Theme"] =
1281 new _define_selection_optional('THEME',
1282 array('default' => "default",
1283 'MacOSX' => "MacOSX",
1284 'smaller' => 'smaller',
1285 'Wordpress'=> 'Wordpress',
1286 'Portland' => "Portland",
1287 'Sidebar' => "Sidebar",
1289 'wikilens' => 'wikilens (Ratings)',
1290 'shamino_com' => 'shamino_com',
1291 'SpaceWiki' => "SpaceWiki",
1292 'Hawaiian' => "Hawaiian",
1293 'MonoBook' => 'MonoBook [experimental]',
1294 'blog' => 'blog [experimental]',
1298 Most of the page appearance is controlled by files in the theme
1301 There are a number of pre-defined themes shipped with PhpWiki.
1302 Or you may create your own (e.g. by copying and then modifying one of
1312 THEME = wikilens (Ratings)
1320 THEME = MonoBook (WikiPedia) [experimental. MSIE problems]
1321 THEME = blog (Kubrick) [experimental. Several links missing]
1324 $properties["Character Set"] =
1325 new _define_optional('CHARSET', 'iso-8859-1', "
1326 Select a valid charset name to be inserted into the xml/html pages,
1327 and to reference links to the stylesheets (css). For more info see:
1328 http://www.iana.org/assignments/character-sets. Note that PhpWiki
1329 has been extensively tested only with the latin1 (iso-8859-1)
1332 If you change the default from iso-8859-1 PhpWiki may not work
1333 properly and it will require code modifications. However, character
1334 sets similar to iso-8859-1 may work with little or no modification
1335 depending on your setup. The database must also support the same
1336 charset, and of course the same is true for the web browser. (Some
1337 work is in progress hopefully to allow more flexibility in this
1338 area in the future).");
1340 $properties["Language"] =
1341 new _define_selection_optional('DEFAULT_LANGUAGE',
1342 array('en' => "English",
1343 '' => "<empty> (user-specific)",
1346 'nl' => "Nederlands",
1351 'zh' => "Chinese"), "
1352 Select your language/locale - default language is \"en\" for English.
1353 Other languages available:<pre>
1354 English \"en\" (English - HomePage)
1355 German \"de\" (Deutsch - StartSeite)
1356 French \"fr\" (Fran~is - Accueil)
1357 Dutch \"nl\" (Nederlands - ThuisPagina)
1358 Spanish \"es\" (Espa~l - P~inaPrincipal)
1359 Swedish \"sv\" (Svenska - Framsida)
1360 Italian \"it\" (Italiano - PaginaPrincipale)
1361 Japanese \"ja\" (Japanese - ~~~~~~)
1362 Chinese \"zh\" (Chinese)
1364 If you set DEFAULT_LANGUAGE to the empty string, your systems default language
1365 (as determined by the applicable environment variables) will be
1368 $properties["Wiki Page Source"] =
1369 new _define_optional('WIKI_PGSRC', 'pgsrc', "
1370 WIKI_PGSRC -- specifies the source for the initial page contents of
1371 the Wiki. The setting of WIKI_PGSRC only has effect when the wiki is
1372 accessed for the first time (or after clearing the database.)
1373 WIKI_PGSRC can either name a directory or a zip file. In either case
1374 WIKI_PGSRC is scanned for files -- one file per page.
1376 // Default (old) behavior:
1377 define('WIKI_PGSRC', 'pgsrc');
1379 define('WIKI_PGSRC', 'wiki.zip');
1380 define('WIKI_PGSRC',
1381 '../Logs/Hamwiki/hamwiki-20010830.zip');
1385 $properties["Default Wiki Page Source"] =
1386 new _define('DEFAULT_WIKI_PGSRC', 'pgsrc', "
1387 DEFAULT_WIKI_PGSRC is only used when the language is *not* the
1388 default (English) and when reading from a directory: in that case
1389 some English pages are inserted into the wiki as well.
1390 DEFAULT_WIKI_PGSRC defines where the English pages reside.
1392 FIXME: is this really needed?
1395 $properties["Generic Pages"] =
1396 new array_variable('GenericPages', array('ReleaseNotes', 'SteveWainstead', 'TestPage'), "
1397 These are the pages which will get loaded from DEFAULT_WIKI_PGSRC.
1399 FIXME: is this really needed? Cannot we just copy these pages into
1400 the localized pgsrc?
1406 $properties["Part Five"] =
1407 new part('_part5', $SEPARATOR."\n", "
1412 $properties["Allowed Protocols"] =
1413 new list_define('ALLOWED_PROTOCOLS', 'http|https|mailto|ftp|news|nntp|ssh|gopher', "
1414 Allowed protocols for links - be careful not to allow \"javascript:\"
1415 URL of these types will be automatically linked.
1416 within a named link [name|uri] one more protocol is defined: phpwiki");
1418 $properties["Inline Images"] =
1419 new list_define('INLINE_IMAGES', 'png|jpg|gif', "
1420 URLs ending with the following extension should be inlined as images.
1421 Scripts shoud not be allowed!");
1423 $properties["WikiName Regexp"] =
1424 new _define('WIKI_NAME_REGEXP', "(?<![[:alnum:]])(?:[[:upper:]][[:lower:]]+){2,}(?![[:alnum:]])", "
1425 Perl regexp for WikiNames (\"bumpy words\")
1426 (?<!..) & (?!...) used instead of '\b' because \b matches '_' as well");
1428 $properties["Subpage Separator"] =
1429 new _define_optional('SUBPAGE_SEPARATOR', '"/"', "
1430 One character which seperates pages from subpages. Defaults to '/', but '.' or ':' were also used.",
1431 "onchange=\"validate_ereg('Sorry, \'%s\' must be a single character. Currently only :, / or .', '^[/:.]$', 'SUBPAGE_SEPARATOR', this);\""
1434 $properties["InterWiki Map File"] =
1435 new _define('INTERWIKI_MAP_FILE', 'lib/interwiki.map', "
1436 InterWiki linking -- wiki-style links to other wikis on the web
1438 The map will be taken from a page name InterWikiMap.
1439 If that page is not found (or is not locked), or map
1440 data can not be found in it, then the file specified
1441 by INTERWIKI_MAP_FILE (if any) will be used.");
1443 $properties["WARN_NONPUBLIC_INTERWIKIMAP"] =
1444 new boolean_define('WARN_NONPUBLIC_INTERWIKIMAP',
1445 array('true' => "true",
1446 'false' => "false"), "
1447 Display a warning if the internal lib/interwiki.map is used, and
1448 not the public InterWikiMap page. This map is not readable from outside.");
1451 $properties["Keyword Link Regexp"] =
1452 new _define_optional('KEYWORDS', '\"Category* OR Topic*\"', "
1453 Search term used for automatic page classification by keyword extraction.
1455 Any links on a page to pages whose names match this search
1456 will be used keywords in the keywords html meta tag. This is an aid to
1457 classification by search engines. The value of the match is
1458 used as the keyword.
1460 The default behavior is to match Category* or Topic* links.");
1462 $properties["Author and Copyright Site Navigation Links"] =
1463 new _define_commented_optional('COPYRIGHTPAGE_TITLE', "GNU General Public License", "
1465 These will be inserted as <link rel> tags in the html header of
1466 every page, for search engines and for browsers like Mozilla which
1467 take advantage of link rel site navigation.
1469 If you have your own copyright and contact information pages change
1470 these as appropriate.");
1472 $properties["COPYRIGHTPAGE URL"] =
1473 new _define_commented_optional('COPYRIGHTPAGE_URL', "http://www.gnu.org/copyleft/gpl.html#SEC1", "
1475 Other useful alternatives to consider:
1477 COPYRIGHTPAGE_TITLE = \"GNU Free Documentation License\"
1478 COPYRIGHTPAGE_URL = \"http://www.gnu.org/copyleft/fdl.html\"
1479 COPYRIGHTPAGE_TITLE = \"Creative Commons License 2.0\"
1480 COPYRIGHTPAGE_URL = \"http://creativecommons.org/licenses/by/2.0/\"</pre>
1481 See http://creativecommons.org/learn/licenses/ for variations");
1483 $properties["AUTHORPAGE_TITLE"] =
1484 new _define_commented_optional('AUTHORPAGE_TITLE', "The PhpWiki Programming Team", "
1485 Default Author Names");
1486 $properties["AUTHORPAGE_URL"] =
1487 new _define_commented_optional('AUTHORPAGE_URL', "http://phpwiki.org/ThePhpWikiProgrammingTeam", "
1488 Default Author URL");
1490 $properties["TOC_FULL_SYNTAX"] =
1491 new boolean_define_optional
1493 array('true' => "Enabled",
1494 'false' => "Disabled"), "
1495 Allow full markup in headers to be parsed by the CreateToc plugin.
1497 If false you may not use WikiWords or [] links or any other markup in
1498 headers in pages with the CreateToc plugin. But if false the parsing is
1499 faster and more stable.");
1501 $properties["ENABLE_MARKUP_COLOR"] =
1502 new boolean_define_optional
1503 ('ENABLE_MARKUP_COLOR',
1504 array('true' => "Enabled",
1505 'false' => "Disabled"), "
1506 If disabled the %color=... %% syntax will be disabled. Since 1.3.11
1509 $properties["ENABLE_MARKUP_TEMPLATE"] =
1510 new boolean_define_optional
1511 ('ENABLE_MARKUP_TEMPLATE',
1512 array('true' => "Enabled",
1513 'false' => "Disabled"), "
1514 Enable mediawiki-style {{TemplatePage|vars=value|...}} syntax. Since 1.3.11
1515 Default: undefined. Enabled automatically on the MonoBook theme if undefined.");
1519 $properties["Part Six"] =
1520 new part('_part6', $SEPARATOR."\n", "
1522 Part Six (optional):
1523 URL options -- you can probably skip this section.
1525 For a pretty wiki (no index.php in the url) set a seperate DATA_PATH.");
1527 global $HTTP_SERVER_VARS;
1528 $properties["Server Name"] =
1529 new _define_commented_optional('SERVER_NAME', $HTTP_SERVER_VARS['SERVER_NAME'], "
1530 Canonical name of the server on which this PhpWiki resides.");
1532 $properties["Server Port"] =
1533 new numeric_define_commented('SERVER_PORT', $HTTP_SERVER_VARS['SERVER_PORT'], "
1534 Canonical httpd port of the server on which this PhpWiki resides.",
1535 "onchange=\"validate_ereg('Sorry, \'%s\' is no valid port number.', '^[0-9]+$', 'SERVER_PORT', this);\"");
1537 $properties["Script Name"] =
1538 new _define_commented_optional('SCRIPT_NAME', $scriptname, "
1539 Relative URL (from the server root) of the PhpWiki script.");
1541 $properties["Data Path"] =
1542 new _define_commented_optional('DATA_PATH', dirname($scriptname), "
1543 URL of the PhpWiki install directory. (You only need to set this
1544 if you've moved index.php out of the install directory.) This can
1545 be either a relative URL (from the directory where the top-level
1546 PhpWiki script is) or an absolute one.");
1549 $properties["PhpWiki Install Directory"] =
1550 new _define_commented_optional('PHPWIKI_DIR', dirname(__FILE__), "
1551 Path to the PhpWiki install directory. This is the local
1552 filesystem counterpart to DATA_PATH. (If you have to set
1553 DATA_PATH, your probably have to set this as well.) This can be
1554 either an absolute path, or a relative path interpreted from the
1555 directory where the top-level PhpWiki script (normally index.php)
1558 $properties["Use PATH_INFO"] =
1559 new _define_selection_optional_commented('USE_PATH_INFO',
1560 array('' => 'automatic',
1561 'true' => 'use PATH_INFO',
1562 'false' => 'do not use PATH_INFO'), "
1563 PhpWiki will try to use short urls to pages, eg
1564 http://www.example.com/index.php/HomePage
1565 If you want to use urls like
1566 http://www.example.com/index.php?pagename=HomePage
1567 then define 'USE_PATH_INFO' as false by uncommenting the line below.
1568 NB: If you are using Apache >= 2.0.30, then you may need to to use
1569 the directive \"AcceptPathInfo On\" in your Apache configuration file
1570 (or in an appropriate <.htaccess> file) for the short urls to work:
1571 See http://httpd.apache.org/docs-2.0/mod/core.html#acceptpathinfo
1573 See also http://phpwiki.sourceforge.net/phpwiki/PrettyWiki for more ideas
1574 on prettifying your urls.
1576 Default: PhpWiki will try to divine whether use of PATH_INFO
1577 is supported in by your webserver/PHP configuration, and will
1578 use PATH_INFO if it thinks that is possible.");
1580 $properties["Virtual Path"] =
1581 new _define_commented_optional('VIRTUAL_PATH', '/SomeWiki', "
1582 VIRTUAL_PATH is the canonical URL path under which your your wiki
1583 appears. Normally this is the same as dirname(SCRIPT_NAME), however
1584 using e.g. seperate starter scripts, apaches mod_actions (or mod_rewrite),
1585 you can make it something different.
1587 If you do this, you should set VIRTUAL_PATH here or in the starter scripts.
1589 E.g. your phpwiki might be installed at at /scripts/phpwiki/index.php,
1590 but you've made it accessible through eg. /wiki/HomePage.
1592 One way to do this is to create a directory named 'wiki' in your
1593 server root. The directory contains only one file: an .htaccess
1594 file which reads something like:
1596 Action x-phpwiki-page /scripts/phpwiki/index.php
1597 SetHandler x-phpwiki-page
1598 DirectoryIndex /scripts/phpwiki/index.php
1600 In that case you should set VIRTUAL_PATH to '/wiki'.
1602 (VIRTUAL_PATH is only used if USE_PATH_INFO is true.)
1607 $properties["Part Seven"] =
1608 new part('_part7', $SEPARATOR."\n", "
1612 Miscellaneous settings
1615 $properties["Strict Mailable Pagedumps"] =
1616 new boolean_define_optional
1617 ('STRICT_MAILABLE_PAGEDUMPS',
1618 array('false' => "binary",
1619 'true' => "quoted-printable"),
1621 If you define this to true, (MIME-type) page-dumps (either zip dumps,
1622 or \"dumps to directory\" will be encoded using the quoted-printable
1623 encoding. If you're actually thinking of mailing the raw page dumps,
1624 then this might be useful, since (among other things,) it ensures
1625 that all lines in the message body are under 80 characters in length.
1627 Also, setting this will cause a few additional mail headers
1628 to be generated, so that the resulting dumps are valid
1629 RFC 2822 e-mail messages.
1631 Probably, you can just leave this set to false, in which case you get
1632 raw ('binary' content-encoding) page dumps.");
1634 $properties["HTML Dump Filename Suffix"] =
1635 new _define_optional('HTML_DUMP_SUFFIX', ".html", "
1636 Here you can change the filename suffix used for XHTML page dumps.
1637 If you don't want any suffix just comment this out.");
1639 $properties["Default local Dump Directory"] =
1640 new _define_optional('DEFAULT_DUMP_DIR', "/tmp/wikidump", "
1641 Specify the default directory for local backups.");
1643 $properties["Default local HTML Dump Directory"] =
1644 new _define_optional('HTML_DUMP_DIR', "/tmp/wikidumphtml", "
1645 Specify the default directory for local XHTML dumps.");
1647 $properties["Pagename of Recent Changes"] =
1648 new _define_optional('RECENT_CHANGES', 'RecentChanges', "
1649 Page name of RecentChanges page. Used for RSS Auto-discovery.");
1651 $properties["Disable HTTP Redirects"] =
1652 new boolean_define_commented_optional
1653 ('DISABLE_HTTP_REDIRECT',
1654 array('false' => 'Enable HTTP Redirects',
1655 'true' => 'Disable HTTP Redirects'),
1657 (You probably don't need to touch this.)
1659 PhpWiki uses HTTP redirects for some of it's functionality.
1660 (e.g. after saving changes, PhpWiki redirects your browser to
1661 view the page you just saved.)
1663 Some web service providers (notably free European Lycos) don't seem to
1664 allow these redirects. (On Lycos the result in an \"Internal Server Error\"
1665 report.) In that case you can set DISABLE_HTTP_REDIRECT to true.
1666 (In which case, PhpWiki will revert to sneakier tricks to try to
1667 redirect the browser...)");
1669 $properties["Disable GETIMAGESIZE"] =
1670 new boolean_define_commented_optional
1671 ('DISABLE_GETIMAGESIZE',
1672 array('false' => 'Enable',
1673 'true' => 'Disable'), "
1674 Set GETIMAGESIZE to disabled, if your php fails to calculate the size on
1675 inlined images, or you don't want to disable too small images to be inlined.
1677 Per default too small ploaded or external images are not displayed,
1678 to prevent from external 1 pixel spam.");
1680 $properties["EDITING_POLICY"] =
1681 new _define_optional('EDITING_POLICY', "EditingPolicy", "
1682 An interim page which gets displayed on every edit attempt, if it exists.");
1684 $properties["ENABLE_MODERATEDPAGE_ALL"] =
1685 new boolean_define_commented_optional
1686 ('ENABLE_MODERATEDPAGE_ALL',
1687 array('false' => 'Disable',
1688 'true' => 'Enable'), "
1691 $properties["FORTUNE_DIR"] =
1692 new _define_commented_optional('FORTUNE_DIR', "/usr/share/fortune", "
1694 $properties["DBADMIN_USER"] =
1695 new _define_commented_optional('DBADMIN_USER', "", "
1697 $properties["DBADMIN_PASSWD"] =
1698 new _define_commented_optional('DBADMIN_PASSWD', "", "
1700 $properties["USE_EXTERNAL_HTML2PDF"] =
1701 new _define_commented_optional('USE_EXTERNAL_HTML2PDF', "htmldoc --quiet --format pdf14 --no-toc --no-title %s", "
1703 $properties["BABYCART_PATH"] =
1704 new _define_commented_optional('BABYCART_PATH', "/usr/local/bin/babycart", "
1707 $properties["Part Seven A"] =
1708 new part('_part7a', $SEPARATOR."\n", "
1712 Cached Plugin Settings. (pear Cache)
1715 $properties["pear Cache USECACHE"] =
1716 new boolean_define_optional('PLUGIN_CACHED_USECACHE',
1717 array('true' => 'Enabled',
1718 'false' => 'Disabled'), "
1719 Enable or disable pear caching of plugins.");
1720 $properties["pear Cache Database Container"] =
1721 new _define_selection_optional('PLUGIN_CACHED_DATABASE',
1722 array('file' => 'file'), "
1723 Curently only file is supported.
1724 db, trifile and imgfile might be supported, but you must hack that by yourself.");
1726 $properties["pear Cache cache directory"] =
1727 new _define_commented_optional('PLUGIN_CACHED_CACHE_DIR', "/tmp/cache", "
1728 Should be writable to the webserver.");
1729 $properties["pear Cache Filename Prefix"] =
1730 new _define_optional('PLUGIN_CACHED_FILENAME_PREFIX', "phpwiki", "");
1731 $properties["pear Cache HIGHWATER"] =
1732 new numeric_define_optional('PLUGIN_CACHED_HIGHWATER', "4194304", "
1733 Garbage collection parameter.");
1734 $properties["pear Cache LOWWATER"] =
1735 new numeric_define_optional('PLUGIN_CACHED_LOWWATER', "3145728", "
1736 Garbage collection parameter.");
1737 $properties["pear Cache MAXLIFETIME"] =
1738 new numeric_define_optional('PLUGIN_CACHED_MAXLIFETIME', "2592000", "
1739 Garbage collection parameter.");
1740 $properties["pear Cache MAXARGLEN"] =
1741 new numeric_define_optional('PLUGIN_CACHED_MAXARGLEN', "1000", "
1742 max. generated url length.");
1743 $properties["pear Cache FORCE_SYNCMAP"] =
1744 new boolean_define_optional('PLUGIN_CACHED_FORCE_SYNCMAP',
1745 array('true' => 'Enabled',
1746 'false' => 'Disabled'), "");
1747 $properties["pear Cache IMGTYPES"] =
1748 new list_define('PLUGIN_CACHED_IMGTYPES', "png|gif|gd|gd2|jpeg|wbmp|xbm|xpm", "
1749 Handle those image types via GD handles. Check your GD supported image types.");
1751 $end = "\n".$SEPARATOR."\n";
1754 text_from_dist("_MAGIC_CLOSE_FILE");
1756 // end of configuration options
1757 ///////////////////////////////
1758 // begin class definitions
1761 * A basic config-dist.ini configuration line in the form of a variable.
1762 * (not needed anymore, we have only defines)
1764 * Produces a string in the form "$name = value;"
1766 * $WikiNameRegexp = "value";
1770 var $config_item_name;
1776 function _variable($config_item_name, $default_value, $description = '', $jscheck = '') {
1777 $this->config_item_name = $config_item_name;
1779 $description = text_from_dist($config_item_name);
1780 $this->description = $description;
1781 // TODO: get boolean default value from config-default.ini
1782 if (defined($config_item_name)
1783 and !preg_match("/(selection|boolean)/", get_class($this))
1784 and !preg_match("/(SCRIPT_NAME|VIRTUAL_PATH)/", $config_item_name))
1785 $this->default_value = constant($config_item_name); // ignore given default value
1786 elseif ($config_item_name == $default_value)
1787 $this->default_value = '';
1789 $this->default_value = $default_value;
1790 $this->jscheck = $jscheck;
1791 if (preg_match("/variable/i", get_class($this)))
1792 $this->prefix = "\$";
1793 elseif (preg_match("/ini_set/i", get_class($this)))
1794 $this->prefix = "ini_get: ";
1800 global $HTTP_POST_VARS;
1801 if (isset($HTTP_POST_VARS[$this->config_item_name]))
1802 return $HTTP_POST_VARS[$this->config_item_name];
1804 return $this->default_value;
1807 function _config_format($value) {
1809 $v = $this->get_config_item_name();
1810 // handle arrays: a|b --> a['b']
1811 if (strpos($v, '|')) {
1812 list($a, $b) = explode('|', $v);
1813 $v = sprintf("%s['%s']", $a, $b);
1815 if (preg_match("/[\"']/", $value))
1816 $value = '"' . $value . '"';
1817 return sprintf("%s = \"%s\"", $v, $value);
1820 function get_config_item_name() {
1821 return $this->config_item_name;
1824 function get_config_item_id() {
1825 return str_replace('|', '-', $this->config_item_name);
1828 function get_config_item_header() {
1829 if (strchr($this->config_item_name,'|')) {
1830 list($var,$param) = explode('|',$this->config_item_name);
1831 return "<b>" . $this->prefix . $var . "['" . $param . "']</b><br />";
1833 elseif ($this->config_item_name[0] != '_')
1834 return "<b>" . $this->prefix . $this->config_item_name . "</b><br />";
1839 function _get_description() {
1840 return $this->description;
1843 function _get_config_line($posted_value) {
1844 return "\n" . $this->_config_format($posted_value);
1847 function get_config($posted_value) {
1848 $d = stripHtml($this->_get_description());
1849 $d = str_replace("\n", "\n; ", $d) . $this->_get_config_line($posted_value) ."\n";
1853 function get_instructions($title) {
1855 $i = "<h3>" . $title . "</h3>\n " . nl2p($this->_get_description()) . "\n";
1856 return "<tr>\n<td width=\"$tdwidth\" class=\"instructions\">\n" . $i . "</td>\n";
1859 function get_html() {
1860 $size = strlen($this->default_value) > 45 ? 90 : 50;
1861 return $this->get_config_item_header() .
1862 "<input type=\"text\" size=\"$50\" name=\"" . $this->get_config_item_name() . "\" value=\"" . htmlspecialchars($this->default_value) . "\" " .
1863 $this->jscheck . " />" . "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
1867 class unchangeable_variable
1869 function _config_format($value) {
1872 // function get_html() { return false; }
1873 function get_html() {
1874 return $this->get_config_item_header() .
1875 "<em>Not editable.</em>" .
1876 "<pre>" . $this->default_value."</pre>";
1878 function _get_config_line($posted_value) {
1879 if ($this->description)
1881 return "${n}".$this->default_value;
1883 function get_instructions($title) {
1885 $i = "<h3>" . $title . "</h3>\n " . nl2p($this->_get_description()) . "\n";
1886 // $i .= "<em>Not editable.</em><br />\n<pre>" . $this->default_value."</pre>";
1887 return '<tr><td width="100%" class="unchangeable-variable-top" colspan="2">'."\n".$i."</td></tr>\n"
1888 . '<tr style="border-top: none;"><td class="unchangeable-variable-left" width="'.$tdwidth.'"> </td>';
1892 class unchangeable_define
1893 extends unchangeable_variable {
1894 function _get_config_line($posted_value) {
1895 if ($this->description)
1898 $posted_value = $this->default_value;
1899 return "${n}".$this->_config_format($posted_value);
1901 function _config_format($value) {
1902 return sprintf("%s = \"%s\"", $this->get_config_item_name(), $value);
1905 class unchangeable_ini_set
1906 extends unchangeable_variable {
1907 function _config_format($value) {
1912 class _variable_selection
1915 global $HTTP_POST_VARS;
1916 if (!empty($HTTP_POST_VARS[$this->config_item_name]))
1917 return $HTTP_POST_VARS[$this->config_item_name];
1919 list($option, $label) = each($this->default_value);
1923 function get_html() {
1924 $output = $this->get_config_item_header();
1925 $output .= '<select name="' . $this->get_config_item_name() . "\">\n";
1926 /* The first option is the default */
1927 $values = $this->default_value;
1928 if (defined($this->get_config_item_name()))
1929 $this->default_value = constant($this->get_config_item_name());
1931 $this->default_value = null;
1932 while(list($option, $label) = each($values)) {
1933 if (!is_null($this->default_value) and $this->default_value === $option)
1934 $output .= " <option value=\"$option\" selected=\"selected\">$label</option>\n";
1936 $output .= " <option value=\"$option\">$label</option>\n";
1938 $output .= "</select>\n";
1946 function _config_format($value) {
1947 return sprintf("%s = \"%s\"", $this->get_config_item_name(), $value);
1949 function _get_config_line($posted_value) {
1950 if ($this->description)
1952 if ($posted_value == '')
1953 return "${n};" . $this->_config_format("");
1955 return "${n}" . $this->_config_format($posted_value);
1957 function get_html() {
1958 $size = strlen($this->default_value) > 45 ? 90 : 50;
1959 return $this->get_config_item_header()
1960 . "<input type=\"text\" size=\"$size\" name=\"" . htmlentities($this->get_config_item_name())
1961 . "\" value=\"" . htmlentities($this->default_value) . "\" {$this->jscheck} />"
1962 . "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
1966 class _define_commented
1968 function _get_config_line($posted_value) {
1969 if ($this->description)
1971 if ($posted_value == $this->default_value)
1972 return "${n};" . $this->_config_format($posted_value);
1973 elseif ($posted_value == '')
1974 return "${n};" . $this->_config_format("");
1976 return "${n}" . $this->_config_format($posted_value);
1981 * We don't use _optional anymore, because INI-style config's don't need that.
1982 * IniConfig.php does the optional logic now.
1983 * But we use _optional for config-default.ini options
1985 class _define_commented_optional
1986 extends _define_commented { }
1988 class _define_optional
1991 class _define_notempty
1993 function get_html() {
1994 $s = $this->get_config_item_header()
1995 . "<input type=\"text\" size=\"50\" name=\"" . $this->get_config_item_name()
1996 . "\" value=\"" . $this->default_value . "\" {$this->jscheck} />";
1997 if (empty($this->default_value))
1998 return $s . "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: red\">Cannot be empty.</p>";
2000 return $s . "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
2004 class _variable_commented
2006 function _get_config_line($posted_value) {
2007 if ($this->description)
2009 if ($posted_value == $this->default_value)
2010 return "${n};" . $this->_config_format($posted_value);
2011 elseif ($posted_value == '')
2012 return "${n};" . $this->_config_format("");
2014 return "${n}" . $this->_config_format($posted_value);
2018 class numeric_define
2021 function numeric_define($config_item_name, $default_value, $description = '', $jscheck = '') {
2022 $this->_define($config_item_name, $default_value, $description, $jscheck);
2024 $this->jscheck = "onchange=\"validate_ereg('Sorry, \'%s\' is not an integer.', '^[-+]?[0-9]+$', '" . $this->get_config_item_name() . "', this);\"";
2026 function _config_format($value) {
2027 //return sprintf("define('%s', %s);", $this->get_config_item_name(), $value);
2028 return sprintf("%s = %s", $this->get_config_item_name(), $value);
2030 function _get_config_line($posted_value) {
2031 if ($this->description)
2033 if ($posted_value == '')
2034 return "${n};" . $this->_config_format('0');
2036 return "${n}" . $this->_config_format($posted_value);
2040 class numeric_define_optional
2041 extends numeric_define {}
2043 class numeric_define_commented
2044 extends numeric_define {
2045 function _get_config_line($posted_value) {
2046 if ($this->description)
2048 if ($posted_value == $this->default_value)
2049 return "${n};" . $this->_config_format($posted_value);
2050 elseif ($posted_value == '')
2051 return "${n};" . $this->_config_format('0');
2053 return "${n}" . $this->_config_format($posted_value);
2057 class _define_selection
2058 extends _variable_selection {
2059 function _config_format($value) {
2060 return sprintf("%s = %s", $this->get_config_item_name(), $value);
2062 function _get_config_line($posted_value) {
2063 return _define::_get_config_line($posted_value);
2065 function get_html() {
2066 return _variable_selection::get_html();
2070 class _define_selection_optional
2071 extends _define_selection { }
2073 class _variable_selection_optional
2074 extends _variable_selection { }
2076 class _define_selection_optional_commented
2077 extends _define_selection_optional {
2078 function _get_config_line($posted_value) {
2079 if ($this->description)
2081 if ($posted_value == $this->default_value)
2082 return "${n};" . $this->_config_format($posted_value);
2083 elseif ($posted_value == '')
2084 return "${n};" . $this->_config_format("");
2086 return "${n}" . $this->_config_format($posted_value);
2090 class _define_password
2093 function _define_password($config_item_name, $default_value, $description = '', $jscheck = '') {
2094 if ($config_item_name == $default_value) $default_value = '';
2095 $this->_define($config_item_name, $default_value, $description, $jscheck);
2097 $this->jscheck = "onchange=\"validate_ereg('Sorry, \'%s\' cannot be empty.', '^.+$', '"
2098 . $this->get_config_item_name() . "', this);\"";
2100 function _get_config_line($posted_value) {
2101 if ($this->description)
2103 if ($posted_value == '') {
2104 $p = "${n};" . $this->_config_format("");
2105 $p .= "\n; If you used the passencrypt.php utility to encode the password";
2106 $p .= "\n; then uncomment this line:";
2107 $p .= "\n;ENCRYPTED_PASSWD = true";
2110 if (function_exists('crypt')) {
2111 $salt_length = max(CRYPT_SALT_LENGTH,
2115 16 * CRYPT_BLOWFISH);
2116 // generate an encrypted password
2117 $crypt_pass = crypt($posted_value, rand_ascii($salt_length));
2118 $p = "${n}" . $this->_config_format($crypt_pass);
2119 return $p . "\nENCRYPTED_PASSWD = true";
2121 $p = "${n}" . $this->_config_format($posted_value);
2122 $p .= "\n; Encrypted passwords cannot be used:";
2123 $p .= "\n; 'function crypt()' not available in this version of php";
2124 $p .= "\nENCRYPTED_PASSWD = false";
2129 function get_html() {
2130 return _variable_password::get_html();
2134 class _define_password_optional
2135 extends _define_password {
2137 function _define_password_optional($config_item_name, $default_value, $description = '', $jscheck = '') {
2138 if ($config_item_name == $default_value) $default_value = '';
2139 $this->_define($config_item_name, $default_value, $description, $jscheck);
2142 function _get_config_line($posted_value) {
2143 if ($this->description)
2145 if ($posted_value == '') {
2146 return "${n};" . $this->_config_format("");
2148 return "${n}" . $this->_config_format($posted_value);
2154 class _define_password_commented_optional
2155 extends _define_password_optional { }
2157 class _variable_password
2159 function _variable_password($config_item_name, $default_value, $description = '', $jscheck = '') {
2160 if ($config_item_name == $default_value) $default_value = '';
2161 $this->_define($config_item_name, $default_value, $description, $jscheck);
2163 $this->jscheck = "onchange=\"validate_ereg('Sorry, \'%s\' cannot be empty.', '^.+$', '" . $this->get_config_item_name() . "', this);\"";
2165 function get_html() {
2166 global $HTTP_POST_VARS, $HTTP_GET_VARS;
2167 $s = $this->get_config_item_header();
2168 if (isset($HTTP_POST_VARS['create']) or isset($HTTP_GET_VARS['create'])) {
2169 $new_password = random_good_password();
2170 $this->default_value = $new_password;
2171 $s .= "Created password: <strong>$new_password</strong><br /> <br />";
2173 // dont re-encrypt already encrypted passwords
2174 $value = $this->value();
2175 $encrypted = !empty($GLOBALS['properties']["Encrypted Passwords"]) and
2176 $GLOBALS['properties']["Encrypted Passwords"]->value();
2179 $s .= "<input type=\"". ($encrypted ? "text" : "password") . "\" name=\"" . $this->get_config_item_name()
2180 . "\" value=\"" . $value . "\" {$this->jscheck} />"
2181 . " <input type=\"submit\" name=\"create\" value=\"Create Random Password\" />";
2183 $s .= "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: red\">Cannot be empty.</p>";
2184 elseif (strlen($this->default_value) < 4)
2185 $s .= "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: red\">Must be longer than 4 chars.</p>";
2187 $s .= "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
2194 function _get_config_line($posted_value) {
2195 // split the phrase by any number of commas or space characters,
2196 // which include " ", \r, \t, \n and \f
2197 $list_values = preg_split("/[\s,]+/", $posted_value, -1, PREG_SPLIT_NO_EMPTY);
2198 $list_values = join("|", $list_values);
2199 return _variable::_get_config_line($list_values);
2201 function get_html() {
2202 $list_values = explode("|", $this->default_value);
2203 $rows = max(3, count($list_values) +1);
2204 $list_values = join("\n", $list_values);
2205 $ta = $this->get_config_item_header();
2206 $ta .= "<textarea cols=\"18\" rows=\"". $rows ."\" name=\"".$this->get_config_item_name()."\" {$this->jscheck}>";
2207 $ta .= $list_values . "</textarea>";
2208 $ta .= "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
2215 function _get_config_line($posted_value) {
2216 $list_values = preg_split("/[\s,]+/", $posted_value, -1, PREG_SPLIT_NO_EMPTY);
2217 $list_values = join("|", $list_values);
2218 return _variable::_get_config_line($list_values);
2220 function get_html() {
2221 $list_values = explode("|", $this->default_value);
2222 $rows = max(3, count($list_values) +1);
2223 $list_values = join("\n", $list_values);
2224 $ta = $this->get_config_item_header();
2225 $ta .= "<textarea cols=\"18\" rows=\"". $rows ."\" name=\"".$this->get_config_item_name()."\" {$this->jscheck}>";
2226 $ta .= $list_values . "</textarea>";
2227 $ta .= "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
2232 class array_variable
2234 function _config_format($value) {
2235 return sprintf("%s = \"%s\"", $this->get_config_item_name(),
2236 is_array($value) ? join(':', $value) : $value);
2238 function _get_config_line($posted_value) {
2239 // split the phrase by any number of commas or space characters,
2240 // which include " ", \r, \t, \n and \f
2241 $list_values = preg_split("/[\s,]+/", $posted_value, -1, PREG_SPLIT_NO_EMPTY);
2242 if (!empty($list_values)) {
2243 $list_values = "'".join("', '", $list_values)."'";
2244 return "\n" . $this->_config_format($list_values);
2246 return "\n;" . $this->_config_format('');
2248 function get_html() {
2249 $list_values = join("\n", $this->default_value);
2250 $rows = max(3, count($this->default_value) +1);
2251 $ta = $this->get_config_item_header();
2252 $ta .= "<textarea cols=\"18\" rows=\"". $rows ."\" name=\"".$this->get_config_item_name()."\" {$this->jscheck}>";
2253 $ta .= $list_values . "</textarea>";
2254 $ta .= "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
2261 function _config_format($value) {
2262 return sprintf("%s = \"%s\"", $this->get_config_item_name(),
2263 is_array($value) ? join(' : ', $value) : $value);
2265 function _get_config_line($posted_value) {
2266 // split the phrase by any number of commas or space characters,
2267 // which include " ", \r, \t, \n and \f
2268 $list_values = preg_split("/[\s,:]+/", $posted_value, -1, PREG_SPLIT_NO_EMPTY);
2269 if (!empty($list_values)) {
2270 $list_values = join(" : ", $list_values);
2271 return "\n" . $this->_config_format($list_values);
2273 return "\n;" . $this->_config_format('');
2275 function get_html() {
2276 if (!$this->default_value)
2277 $this->default_value = array();
2278 elseif (is_string($this->default_value))
2279 $this->default_value = preg_split("/[\s,:]+/", $this->default_value, -1, PREG_SPLIT_NO_EMPTY);
2280 $list_values = join(" : \n", $this->default_value);
2281 $rows = max(3, count($this->default_value) + 1);
2282 $ta = $this->get_config_item_header();
2283 $ta .= "<textarea cols=\"18\" rows=\"". $rows ."\" name=\"".$this->get_config_item_name()."\" {$this->jscheck}>";
2284 $ta .= $list_values . "</textarea>";
2285 $ta .= "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
2294 global $HTTP_POST_VARS;
2295 if ($v = $HTTP_POST_VARS[$this->config_item_name])
2298 return ini_get($this->get_config_item_name);
2301 function _config_format($value) {
2302 return sprintf("ini_set('%s', '%s');", $this->get_config_item_name(), $value);
2304 function _get_config_line($posted_value) {
2305 if ($posted_value && ! $posted_value == $this->default_value)
2306 return "\n" . $this->_config_format($posted_value);
2308 return "\n;" . $this->_config_format($this->default_value);
2313 class boolean_define
2315 function _get_config_line($posted_value) {
2316 if ($this->description)
2318 return "${n}" . $this->_config_format($posted_value);
2320 function _config_format($value) {
2321 if (strtolower(trim($value)) == 'false')
2323 return sprintf("%s = %s", $this->get_config_item_name(),
2324 (bool)$value ? 'true' : 'false');
2326 function get_html() {
2327 $output = $this->get_config_item_header();
2328 $name = $this->get_config_item_name();
2329 $output .= '<select name="' . $name . "\" {$this->jscheck}>\n";
2330 $values = $this->default_value;
2332 $this->default_value = constant($name);
2334 $this->default_value = null;
2335 list($option, $label) = each($values);
2336 $output .= " <option value=\"$option\" selected=\"selected\">$label</option>\n";
2338 /* There can usually, only be two options, there can be
2339 * three options in the case of a boolean_define_commented_optional */
2340 while (list($option, $label) = each($values)) {
2341 if (!is_null($this->default_value) and $this->default_value === $option)
2342 $output .= " <option value=\"$option\" selected=\"selected\">$label</option>\n";
2344 $output .= " <option value=\"$option\">$label</option>\n";
2346 $output .= "</select>\n";
2351 class boolean_define_optional
2352 extends boolean_define {}
2354 class boolean_define_commented
2355 extends boolean_define {
2356 function _get_config_line($posted_value) {
2357 if ($this->description)
2359 list($default_value, $label) = each($this->default_value);
2360 if ($posted_value == $default_value)
2361 return "${n};" . $this->_config_format($posted_value);
2362 elseif ($posted_value == '')
2363 return "${n};" . $this->_config_format('false');
2365 return "${n}" . $this->_config_format($posted_value);
2369 class boolean_define_commented_optional
2370 extends boolean_define_commented {}
2374 function value () { return; }
2375 function get_config($posted_value) {
2376 $d = stripHtml($this->_get_description());
2378 return "\n".$SEPARATOR . str_replace("\n", "\n; ", $d) ."\n".$this->default_value;
2380 function get_instructions($title) {
2381 $id = preg_replace("/\W/","",$this->config_item_name);
2382 $group_name = preg_replace("/\W/","",$title);
2383 $i = "<tr class=\"header\" id=\"$id\">\n<td class=\"part\" width=\"100%\" colspan=\"2\" bgcolor=\"#eeeeee\">\n";
2384 $i .= "<h2>" . $title . "</h2>\n " . nl2p($this->_get_description()) ."\n";
2385 $i .= "<p><a href=\"javascript:toggle_group('$id')\" id=\"{$id}_text\">Hide options.</a></p>";
2386 return $i ."</td>\n";
2388 function get_html() {
2393 // html utility functions
2394 function nl2p($text) {
2395 preg_match_all("@\s*(<pre>.*?</pre>|<dl>.*?</dl>|.*?(?=\n\n|<pre>|<dl>|$))@s",
2396 $text, $m, PREG_PATTERN_ORDER);
2399 foreach ($m[1] as $par) {
2400 if (!($par = trim($par)))
2402 if (!preg_match('/^<(pre|dl)>/', $par))
2403 $par = "<p>$par</p>";
2409 function text_from_dist($var) {
2410 static $distfile = 0;
2414 $sep = (substr(PHP_OS,0,3) == 'WIN' ? '\\' : '/');
2415 $distfile = dirname(__FILE__) . $sep . "config" . $sep . "config-dist.ini";
2416 $f = fopen($distfile, "r");
2418 if ($var == '_MAGIC_CLOSE_FILE') {
2422 // if all vars would be in natural order as in the config-dist this would not be needed.
2427 if (preg_match("/^; \w/", $s)) {
2428 $par .= (substr($s,2) . " ");
2429 } elseif (preg_match("/^;\s*$/", $s)) {
2432 if (preg_match("/^;?".preg_quote($var)."\s*=/", $s))
2434 if (preg_match("/^\s*$/", $s)) // new paragraph
2440 function stripHtml($text) {
2441 $d = str_replace("<pre>", "", $text);
2442 $d = str_replace("</pre>", "", $d);
2443 $d = str_replace("<dl>", "", $d);
2444 $d = str_replace("</dl>", "", $d);
2445 $d = str_replace("<dt>", "", $d);
2446 $d = str_replace("</dt>", "", $d);
2447 $d = str_replace("<dd>", "", $d);
2448 $d = str_replace("</dd>", "", $d);
2449 $d = str_replace("<p>", "", $d);
2450 $d = str_replace("</p>", "", $d);
2451 //restore html entities into characters
2452 // http://www.php.net/manual/en/function.htmlentities.php
2453 $trans = get_html_translation_table (HTML_ENTITIES);
2454 $trans = array_flip ($trans);
2455 $d = strtr($d, $trans);
2459 include_once(dirname(__FILE__)."/lib/stdlib.php");
2462 // Function to create better user passwords (much larger keyspace),
2463 // suitable for user passwords.
2464 // Sequence of random ASCII numbers, letters and some special chars.
2465 // Note: There exist other algorithms for easy-to-remember passwords.
2466 function random_good_password ($minlength = 5, $maxlength = 8) {
2468 // assume ASCII ordering (not valid on EBCDIC systems!)
2469 $valid_chars = "!#%&+-.0123456789=@ABCDEFGHIJKLMNOPQRSTUVWXYZ_abcdefghijklmnopqrstuvwxyz";
2470 $start = ord($valid_chars);
2471 $end = ord(substr($valid_chars,-1));
2473 if (function_exists('mt_rand')) // mersenne twister
2474 $length = mt_rand($minlength, $maxlength);
2475 else // the usually bad glibc rand()
2476 $length = rand($minlength, $maxlength);
2477 while ($length > 0) {
2478 if (function_exists('mt_rand'))
2479 $newchar = mt_rand($start, $end);
2481 $newchar = rand($start, $end);
2482 if (! strrpos($valid_chars,$newchar) ) continue; // skip holes
2483 $newpass .= sprintf("%c", $newchar);
2490 function printArray($a) {
2491 echo "<hr />\n<pre>\n";
2493 echo "\n</pre>\n<hr />\n";
2496 // end of class definitions
2497 /////////////////////////////
2498 // begin auto generation code
2500 if (!function_exists('is_a')) {
2501 function is_a($object, $class) {
2502 $class = strtolower($class);
2503 return (get_class($object) == $class) or is_subclass_of($object, $class);
2508 if (!empty($HTTP_POST_VARS['action'])
2509 and $HTTP_POST_VARS['action'] == 'make_config'
2510 and !empty($HTTP_POST_VARS['ADMIN_USER'])
2511 and !empty($HTTP_POST_VARS['ADMIN_PASSWD'])
2515 $timestamp = date ('dS of F, Y H:i:s');
2518 ; This is a local configuration file for PhpWiki.
2519 ; It was automatically generated by the configurator script
2520 ; on the $timestamp.
2525 $posted = $GLOBALS['HTTP_POST_VARS'];
2526 /*if (defined('DEBUG'))
2527 printArray($GLOBALS['HTTP_POST_VARS']);*/
2529 foreach ($properties as $option_name => $a) {
2530 $posted_value = stripslashes($posted[$a->config_item_name]);
2531 $config .= $properties[$option_name]->get_config($posted_value);
2536 if (is_writable($fs_config_file)) {
2537 // We first check if the config-file exists.
2538 if (file_exists($fs_config_file)) {
2539 // We make a backup copy of the file
2540 $new_filename = preg_replace('/\.ini$/', '-' . time() . '.ini', $fs_config_file);
2541 if (@copy($fs_config_file, $new_filename)) {
2542 $fp = @fopen($fs_config_file, 'w');
2545 $fp = @fopen($fs_config_file, 'w');
2553 fputs($fp, $config);
2555 echo "<p>The configuration was written to <code><b>$config_file</b></code>.</p>\n";
2556 if ($new_filename) {
2557 echo "<p>A backup was made to <code><b>$new_filename</b></code>.</p>\n";
2559 ; //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";
2562 echo "<p>The configuration file could <b>not</b> be written.<br />\n",
2563 " You should copy the above configuration to a file, ",
2564 "and manually save it as <code><b>config/config.ini</b></code>.</p>\n";
2567 echo "<hr />\n<p>Here's the configuration file based on your answers:</p>\n";
2568 echo "<form method=\"get\" action=\"", $configurator, "\">\n";
2569 echo "<textarea id='config-output' readonly='readonly' style='width:100%;' rows='30' cols='100'>\n";
2570 echo htmlentities($config);
2571 echo "</textarea></form>\n";
2574 echo "<p>To make any corrections, <a href=\"configurator.php\">edit the settings again</a>.</p>\n";
2576 } else { // first time or create password
2577 $posted = $GLOBALS['HTTP_POST_VARS'];
2578 // No action has been specified - we make a form.
2580 if (!empty($GLOBALS['HTTP_GET_VARS']['start_debug']))
2581 $configurator .= ("?start_debug=" . $GLOBALS['HTTP_GET_VARS']['start_debug']);
2583 <form action="',$configurator,'" method="post">
2584 <input type="hidden" name="action" value="make_config" />
2585 <table cellpadding="4" cellspacing="0">
2588 while (list($property, $obj) = each($properties)) {
2589 echo $obj->get_instructions($property);
2590 if ($h = $obj->get_html()) {
2591 if (defined('DEBUG') and DEBUG) $h = get_class($obj) . "<br />\n" . $h;
2592 echo "<td>".$h."</td>\n";
2599 <p><input type="submit" id="submit" value="Save ',$config_file,'" /> <input type="reset" value="Clear" /></p>