1 <?php // -*-php-*- $Id$
3 * Copyright 2002,2003,2005 $ThePhpWikiProgrammingTeam
4 * Copyright 2002 Martin Geisler <gimpster@gimpster.com>
5 * Copyright 2008-2009 Marc-Etienne Vargenau, Alcatel-Lucent
7 * This file is part of PhpWiki.
8 * Parts of this file were based on PHPWeather's configurator.php file.
9 * http://sourceforge.net/projects/phpweather/
11 * PhpWiki is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * PhpWiki is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with PhpWiki; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27 * Starts automatically the first time by IniConfig("config/config.ini")
28 * if it doesn't exist.
31 * o Initial expand ?show=_part1 (the part id)
32 * o read config-default.ini and use this as default_values
33 * o commented / optional: non-default values should not be commented!
34 * default values if optional can be omitted.
35 * o validate input (fix javascript, add POST checks)
36 * o start this automatically the first time
39 * 1.3.11 TODO: (or 1.3.12?)
40 * o parse_ini_file("config-dist.ini") for the commented vars
41 * o check automatically for commented and optional vars
42 * o fix _optional, to ignore existing config.ini and only use config-default.ini values
43 * o mixin class for commented
44 * o fix SQL quotes, AUTH_ORDER quotes and file forward slashes
45 * o posted values validation, extend js validation for sane DB values
46 * o read config-dist.ini into sections, comments, and optional/required settings
48 * A file config/config.ini will be automatically generated, if writable.
50 * NOTE: If you have a starterscript outside PHPWIKI_DIR but no
51 * config/config.ini yet (very unlikely!), you must define DATA_PATH in the
52 * starterscript, otherwise the webpath to configurator is unknown, and
53 * subsequent requests will fail. (POST to save the INI)
56 global $HTTP_SERVER_VARS, $HTTP_POST_VARS, $tdwidth;
57 if (empty($_SERVER)) $_SERVER =& $GLOBALS['HTTP_SERVER_VARS'];
58 if (empty($_GET)) $_GET =& $GLOBALS['HTTP_GET_VARS'];
59 if (empty($_ENV)) $_ENV =& $GLOBALS['HTTP_ENV_VARS'];
60 if (empty($_POST)) $_POST =& $GLOBALS['HTTP_POST_VARS'];
62 if (empty($configurator))
63 $configurator = "configurator.php";
64 if (!strstr($_SERVER["SCRIPT_NAME"], $configurator) and defined('DATA_PATH'))
65 $configurator = DATA_PATH . "/" . $configurator;
66 $scriptname = str_replace('configurator.php', 'index.php', $_SERVER["SCRIPT_NAME"]);
67 if (strstr($_SERVER["SCRIPT_NAME"],"/php")) { // cgi got this different
68 if (defined('DATA_PATH'))
69 $scriptname = DATA_PATH . "/index.php";
71 $scriptname = str_replace('configurator.php', 'index.php', $_SERVER["PHP_SELF"]);
75 $config_file = (substr(PHP_OS,0,3) == 'WIN') ? 'config\\config.ini' : 'config/config.ini';
76 $fs_config_file = dirname(__FILE__) . (substr(PHP_OS,0,3) == 'WIN' ? '\\' : '/') . $config_file;
77 if (isset($_POST['create'])) header('Location: '.$configurator.'?show=_part1&create=1#create');
79 // helpers from lib/WikiUser/HttpAuth.php
80 if (!function_exists('_http_user')) {
81 function _http_user() {
83 $_SERVER = $GLOBALS['HTTP_SERVER_VARS'];
84 if (!empty($_SERVER['PHP_AUTH_USER']))
85 return array($_SERVER['PHP_AUTH_USER'], $_SERVER['PHP_AUTH_PW']);
86 if (!empty($_SERVER['REMOTE_USER']))
87 return array($_SERVER['REMOTE_USER'], $_SERVER['PHP_AUTH_PW']);
88 if (!empty($GLOBALS['HTTP_ENV_VARS']['REMOTE_USER']))
89 return array($GLOBALS['HTTP_ENV_VARS']['REMOTE_USER'],
90 $GLOBALS['HTTP_ENV_VARS']['PHP_AUTH_PW']);
91 if (!empty($GLOBALS['REMOTE_USER']))
92 return array($GLOBALS['REMOTE_USER'], $GLOBALS['PHP_AUTH_PW']);
95 if (!empty($_SERVER['HTTP_AUTHORIZATION'])) {
96 list($userid, $passwd) = explode(':', base64_decode(substr($_SERVER['HTTP_AUTHORIZATION'], 6)));
97 return array($userid, $passwd);
101 function _http_logout() {
102 if (!isset($_SERVER))
103 $_SERVER =& $GLOBALS['HTTP_SERVER_VARS'];
104 // maybe we should random the realm to really force a logout. but the next login will fail.
105 // better_srand(); $realm = microtime().rand();
106 header('WWW-Authenticate: Basic realm="'.WIKI_NAME.'"');
107 if (strstr(php_sapi_name(), 'apache'))
108 header('HTTP/1.0 401 Unauthorized');
110 header("Status: 401 Access Denied"); //IIS and CGI need that
111 unset($GLOBALS['REMOTE_USER']);
112 unset($_SERVER['PHP_AUTH_USER']);
113 unset($_SERVER['PHP_AUTH_PW']);
115 trigger_error("Permission denied. Require ADMIN_USER.", E_USER_ERROR);
120 // If config.ini exists, we require ADMIN_USER access by faking HttpAuth.
121 // So nobody can see or reset the password(s).
122 if (file_exists($fs_config_file)) {
123 // Require admin user
124 if (!defined('ADMIN_USER') or !defined('ADMIN_PASSWD')) {
125 if (!function_exists("IniConfig")) {
126 include_once("lib/prepend.php");
127 include_once("lib/IniConfig.php");
129 IniConfig($fs_config_file);
131 if (!defined('ADMIN_USER') or ADMIN_USER == '') {
132 trigger_error("Configuration problem:\nADMIN_USER not defined in \"$fs_config_file\".\n"
133 . "Cannot continue: You have to fix that manually.", E_USER_ERROR);
137 list($admin_user, $admin_pw) = _http_user();
138 //$required_user = ADMIN_USER;
139 if (empty($admin_user) or $admin_user != ADMIN_USER)
144 if (ENCRYPTED_PASSWD and function_exists('crypt')) {
145 if (crypt($admin_pw, ADMIN_PASSWD) != ADMIN_PASSWD)
147 } elseif ($admin_pw != ADMIN_PASSWD) {
151 if (!function_exists("IniConfig")) {
152 include_once("lib/prepend.php");
153 include_once("lib/IniConfig.php");
155 $def_file = (substr(PHP_OS,0,3) == 'WIN') ? 'config\\config-default.ini' : 'config/config-default.ini';
156 $fs_def_file = dirname(__FILE__) . (substr(PHP_OS,0,3) == 'WIN' ? '\\' : '/') . $def_file;
157 IniConfig($fs_def_file);
160 echo '<','?xml version="1.0" encoding="utf-8"?',">\n";
162 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
163 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
164 <html xmlns="http://www.w3.org/1999/xhtml">
167 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
168 <title>Configuration tool for PhpWiki <?php echo $config_file ?></title>
169 <style type="text/css" media="screen">
171 /* TABLE { border: thin solid black } */
172 body { font-family: Verdana, Arial, Helvetica, sans-serif; font-size: 80%; }
173 pre { font-size: 120%; }
174 td { border: thin solid black }
176 div.hint { background-color: #eeeeee; }
177 tr.hidden { border: none; display: none; }
178 td.part { background-color: #eeeeee; color: inherit; }
179 td.instructions { background-color: #ffffee; width: <?php echo $tdwidth ?>px; color: inherit; }
180 td.unchangeable-variable-top { border-bottom: none; background-color: #ffffee; color:inherit; }
181 td.unchangeable-variable-left { border-top: none; background-color: #ffffee; color:inherit; }
184 <script language="JavaScript" type="text/javascript">
186 function update(accepted, error, value, output) {
187 var msg = document.getElementById(output);
189 /* MSIE 5.0 fails here */
190 if (msg && msg.innerHTML) { msg.innerHTML = "<font color=\"green\">Input accepted.</font>"; }
192 while ((index = error.indexOf("%s")) > -1) {
193 error = error.substring(0, index) + value + error.substring(index+2);
195 if (msg) { msg.innerHTML = "<font color=\"red\">" + error + "</font>"; }
197 if (submit = document.getElementById('submit')) submit.disabled = accepted ? false : true;
200 function validate(error, value, output, field) {
201 update(field.value == value, error, field.value, output);
204 function validate_ereg(error, ereg, output, field) {
205 regex = new RegExp(ereg);
206 update(regex.test(field.value), error, field.value, output);
209 function validate_range(error, low, high, empty_ok, output, field) {
210 update((empty_ok == 1 && field.value == "") ||
211 (field.value >= low && field.value <= high),
212 error, field.value, output);
215 function toggle_group(id) {
216 var text = document.getElementById(id + "_text");
218 if (text.innerHTML == "Hide options.") {
220 text.innerHTML = "Show options.";
222 text.innerHTML = "Hide options.";
225 var rows = document.getElementsByTagName('tr');
227 for (i = 0; i < rows.length; i++) {
229 if (tr.className == 'header' && tr.id == id) {
234 for (; i < rows.length; i++) {
236 if (tr.className == 'header')
238 tr.className = do_hide ? 'hidden': 'nonhidden';
243 // Hide all groups. We do this via JavaScript to avoid
244 // hiding the groups if JavaScript is not supported...
245 var rows = document.getElementsByTagName('tr');
246 var show = '<?php echo $_GET["show"] ?>';
247 for (var i = 0; i < rows.length; i++) {
249 if (tr.className == 'header')
250 if (!show || tr.id != show)
254 // Select text in textarea upon focus
255 var area = document.getElementById('config-output');
257 listener = { handleEvent: function (e) { area.select(); } };
258 area.addEventListener('focus', listener, false);
265 <body onload="do_init();">
267 <h1>Configuration for PhpWiki <?php echo $config_file ?></h1>
270 Using this configurator.php is experimental!<br />
271 On any configuration problems, please edit the resulting config.ini manually.
276 //define('DEBUG', 1);
278 * The Configurator is a php script to aid in the configuration of PhpWiki.
279 * Parts of this file were based on PHPWeather's configurator.php file.
280 * http://sourceforge.net/projects/phpweather/
282 * TO CHANGE THE CONFIGURATION OF YOUR PHPWIKI, DO *NOT* MODIFY THIS FILE!
283 * more instructions go here
287 * * eval config.ini to get the actual settings.
290 //////////////////////////////
291 // begin configuration options
294 * Notes for the description parameter of $property:
296 * - Descriptive text will be changed into comments (preceeded by ; )
297 * for the final output to config.ini.
299 * - Only a limited set of html is allowed: pre, dl dt dd; it will be
300 * stripped from the final output.
302 * - Line breaks and spacing will be preserved for the final output.
304 * - Double line breaks are automatically converted to paragraphs
305 * for the html version of the descriptive text.
307 * - Double-quotes and dollar signs in the descriptive text must be
308 * escaped: \" and \$. Instead of escaping double-quotes you can use
309 * single (') quotes for the enclosing quotes.
311 * - Special characters like < and > must use html entities,
312 * they will be converted back to characters for the final output.
315 $SEPARATOR = ";=========================================================================";
318 ; This is the main configuration file for PhpWiki in INI-style format.
319 ; Note that certain characters are used as comment char and therefore
320 ; these entries must be in double-quotes. Such as \":\", \";\", \",\" and \"|\"
321 ; Take special care for DBAUTH_ sql statements. (Part 3a)
323 ; This file is divided into several parts: Each one has different configuration
324 ; settings you can change; in all cases the default should work on your system,
325 ; however, we recommend you tailor things to your particular setting.
326 ; Here undefined definitions get defined by config-default.ini settings.
329 // Detect not here listed configs:
330 // for x in `perl -ne 'print $1,"\n" if /^;(\w+) =/' config/config-dist.ini`; do \
331 // grep \'$x\' configurator.php >/dev/null || echo $x ; done
333 $properties["Part Zero"] =
334 new part('_part0', $SEPARATOR."\n", "
335 Part Zero: (optional)
336 Latest Development and Tricky Options");
338 if (defined('INCLUDE_PATH'))
339 $include_path = INCLUDE_PATH;
341 if (substr(PHP_OS,0,3) == 'WIN') {
342 $include_path = dirname(__FILE__) . ';' . ini_get('include_path');
343 if (strchr(ini_get('include_path'),'/'))
344 $include_path = strtr($include_path,'\\','/');
346 $include_path = dirname(__FILE__) . ':' . ini_get('include_path');
350 $properties["PHP include_path"] =
351 new _define('INCLUDE_PATH', $include_path);
353 // TODO: Convert this to a checkbox row as in tests/unit/test.php
354 $properties["DEBUG"] =
355 new numeric_define_optional('DEBUG', DEBUG);
357 $properties["ENABLE_EDIT_TOOLBAR"] =
358 new boolean_define_commented_optional('ENABLE_EDIT_TOOLBAR');
360 $properties["JS_SEARCHREPLACE"] =
361 new boolean_define_commented_optional('JS_SEARCHREPLACE');
363 // TESTME: use config-default: = false
364 $properties["ENABLE_DOUBLECLICKEDIT"] =
365 new boolean_define_commented_optional('ENABLE_DOUBLECLICKEDIT');
367 $properties["ENABLE_WYSIWYG"] =
368 new boolean_define_commented_optional('ENABLE_WYSIWYG');
370 $properties["WYSIWYG_BACKEND"] =
371 new _define_selection(
373 array('Wikiwyg' => 'Wikiwyg',
374 'tinymce' => 'tinymce',
375 'FCKeditor' => 'FCKeditor',
377 'htmlarea3' => 'htmlarea3',
378 'htmlarea2' => 'htmlarea2',
381 $properties["WYSIWYG_DEFAULT_PAGETYPE_HTML"] =
382 new boolean_define_commented_optional('WYSIWYG_DEFAULT_PAGETYPE_HTML');
384 $properties["UPLOAD_USERDIR"] =
385 new boolean_define_commented_optional('UPLOAD_USERDIR');
387 $properties["DISABLE_UNITS"] =
388 new boolean_define_commented_optional('DISABLE_UNITS');
390 $properties["UNITS_EXE"] =
391 new _define_commented_optional('UNITS_EXE');
393 $properties["ENABLE_XHTML_XML"] =
394 new boolean_define_commented_optional('ENABLE_XHTML_XML');
396 $properties["ENABLE_SPAMASSASSIN"] =
397 new boolean_define_commented_optional('ENABLE_SPAMASSASSIN');
399 $properties["ENABLE_SPAMBLOCKLIST"] =
400 new boolean_define_optional('ENABLE_SPAMBLOCKLIST');
402 $properties["NUM_SPAM_LINKS"] =
403 new numeric_define_optional('NUM_SPAM_LINKS');
405 $properties["GOOGLE_LINKS_NOFOLLOW"] =
406 new boolean_define_commented_optional('GOOGLE_LINKS_NOFOLLOW');
408 $properties["ENABLE_LIVESEARCH"] =
409 new boolean_define_commented_optional('ENABLE_LIVESEARCH');
411 $properties["ENABLE_ACDROPDOWN"] =
412 new boolean_define_commented_optional('ENABLE_ACDROPDOWN');
414 $properties["ENABLE_DISCUSSION_LINK"] =
415 new boolean_define_commented_optional('ENABLE_DISCUSSION_LINK');
417 $properties["ENABLE_CAPTCHA"] =
418 new boolean_define_commented_optional('ENABLE_CAPTCHA');
420 $properties["USE_CAPTCHA_RANDOM_WORD"] =
421 new boolean_define_commented_optional('USE_CAPTCHA_RANDOM_WORD');
423 $properties["USE_SAFE_DBSESSION"] =
424 new boolean_define_commented_optional('USE_SAFE_DBSESSION');
426 $properties["BLOG_DEFAULT_EMPTY_PREFIX"] =
427 new boolean_define_commented_optional('BLOG_DEFAULT_EMPTY_PREFIX');
429 $properties["ENABLE_SEARCHHIGHLIGHT"] =
430 new boolean_define_commented_optional('ENABLE_SEARCHHIGHLIGHT');
432 $properties["Part One"] =
433 new part('_part1', $SEPARATOR."\n", "
434 Part One: Authentication and security settings. See Part Three for more.");
436 $properties["Wiki Name"] =
437 new _define_optional('WIKI_NAME', WIKI_NAME);
439 $properties["Admin Username"] =
440 new _define_notempty('ADMIN_USER', ADMIN_USER, "
441 You must set this! Username and password of the administrator.",
442 "onchange=\"validate_ereg('Sorry, ADMIN_USER cannot be empty.', '^.+$', 'ADMIN_USER', this);\"");
444 $properties["Admin Password"] =
445 new _define_password('ADMIN_PASSWD', ADMIN_PASSWD, "
447 For heaven's sake pick a good password.
449 If your version of PHP supports encrypted passwords, your password will be
450 automatically encrypted within the generated config file.
451 Use the \"Create Random Password\" button to create a good (random) password.
453 ADMIN_PASSWD is ignored on HttpAuth",
454 "onchange=\"validate_ereg('Sorry, ADMIN_PASSWD must be at least 4 chars long.', '^....+$', 'ADMIN_PASSWD', this);\"");
456 $properties["Encrypted Passwords"] =
459 array('true' => "true. use crypt for all passwords",
460 'false' => "false. use plaintest passwords (not recommended)"));
462 $properties["Reverse DNS"] =
463 new boolean_define_optional
464 ('ENABLE_REVERSE_DNS',
465 array('true' => "true. perform additional reverse dns lookups",
466 'false' => "false. just record the address as given by the httpd server"));
468 $properties["ZIP Dump Authentication"] =
469 new boolean_define_optional('ZIPDUMP_AUTH',
470 array('false' => "false. Everyone may download zip dumps",
471 'true' => "true. Only admin may download zip dumps"));
473 $properties["Enable RawHtml Plugin"] =
474 new boolean_define_commented_optional('ENABLE_RAW_HTML');
476 $properties["Allow RawHtml Plugin only on locked pages"] =
477 new boolean_define_commented_optional('ENABLE_RAW_HTML_LOCKEDONLY');
479 $properties["Allow RawHtml Plugin if safe HTML code"] =
480 new boolean_define_commented_optional('ENABLE_RAW_HTML_SAFE','', "
481 If this is set, all unsafe html code is stripped automatically (experimental!)
482 See <a href=\"http://chxo.com/scripts/safe_html-test.php\" target=\"_new\">chxo.com/scripts/safe_html-test.php</a>
485 $properties["Maximum Upload Size"] =
486 new numeric_define_optional('MAX_UPLOAD_SIZE', MAX_UPLOAD_SIZE);
488 $properties["Minor Edit Timeout"] =
489 new numeric_define_optional('MINOR_EDIT_TIMEOUT', MINOR_EDIT_TIMEOUT);
491 $properties["Disabled Actions"] =
492 new array_define('DISABLED_ACTIONS', DISABLED_ACTIONS /*array()*/);
494 $properties["Moderate all Pagechanges"] =
495 new boolean_define_commented_optional('ENABLE_MODERATEDPAGE_ALL');
497 $properties["Access Log File"] =
498 new _define_commented_optional('ACCESS_LOG', ACCESS_LOG);
500 $properties["Access Log SQL"] =
501 new _define_selection(
503 array('0' => 'disabled',
505 '2' => 'read + write'));
507 $properties["Compress Output"] =
508 new boolean_define_commented_optional
510 array('' => 'undefined - GZIP compress when appropriate.',
511 'false' => 'Never compress output.',
512 'true' => 'Always try to compress output.'));
514 $properties["HTTP Cache Control"] =
515 new _define_selection_optional
517 array('LOOSE' => 'LOOSE',
518 'STRICT' => 'STRICT',
519 'NO_CACHE' => 'NO_CACHE',
520 'ALLOW_STALE' => 'ALLOW_STALE'),
524 This controls how PhpWiki sets the HTTP cache control
525 headers (Expires: and Cache-Control:)
530 <dd>This is roughly the old (pre 1.3.4) behaviour. PhpWiki will
531 instruct proxies and browsers never to cache PhpWiki output.</dd>
533 <dd>Cached pages will be invalidated whenever the database global
534 timestamp changes. This should behave just like NONE (modulo
535 bugs in PhpWiki and your proxies and browsers), except that
536 things will be slightly more efficient.</dd>
538 <dd>Cached pages will be invalidated whenever they are edited,
539 or, if the pages include plugins, when the plugin output could
540 concievably have changed.
541 <p>Behavior should be much like STRICT, except that sometimes
542 wikilinks will show up as undefined (with the question mark)
543 when in fact they refer to (recently) created pages.
544 (Hitting your browsers reload or perhaps shift-reload button
545 should fix the problem.)</p></dd>
547 <dd>Proxies and browsers will be allowed to used stale pages.
548 (The timeout for stale pages is controlled by CACHE_CONTROL_MAX_AGE.)
549 <p>This setting will result in quirky behavior. When you edit a
550 page your changes may not show up until you shift-reload the
552 <p>This setting is generally not advisable, however it may be useful
553 in certain cases (e.g. if your wiki gets lots of page views,
554 and few edits by knowledgable people who won't freak over the quirks.)</p>
557 The default is currently LOOSE.");
559 $properties["HTTP Cache Control Max Age"] =
560 new numeric_define_optional('CACHE_CONTROL_MAX_AGE', CACHE_CONTROL_MAX_AGE);
562 $properties["Markup Caching"] =
563 new boolean_define_commented_optional
564 ('WIKIDB_NOCACHE_MARKUP',
565 array('false' => 'Enable markup cache',
566 'true' => 'Disable markup cache'));
568 $properties["COOKIE_EXPIRATION_DAYS"] =
569 new numeric_define_optional('COOKIE_EXPIRATION_DAYS', COOKIE_EXPIRATION_DAYS);
571 $properties["COOKIE_DOMAIN"] =
572 new _define_commented_optional('COOKIE_DOMAIN', COOKIE_DOMAIN);
574 $properties["Path for PHP Session Support"] =
575 new _define_optional('SESSION_SAVE_PATH', defined('SESSION_SAVE_PATH') ? SESSION_SAVE_PATH : ini_get('session.save_path'));
577 $properties["Force PHP Database Sessions"] =
578 new boolean_define_commented_optional
580 array('false' => 'Disable database sessions, use files',
581 'true' => 'Enable database sessions'));
583 ///////// database selection
585 $properties["Part Two"] =
586 new part('_part2', $SEPARATOR."\n", "
589 Database Configuration
592 $properties["Database Type"] =
593 new _define_selection("DATABASE_TYPE",
594 array('dba' => "dba",
596 'ADODB' => "SQL ADODB",
597 'PDO' => "PDO (php5 only)",
598 'file' => "flatfile",
599 'cvs' => "CVS File handler")/*, "
600 Select the database backend type:
601 Choose dba (default) to use one of the standard UNIX dba libraries. This is the fastest.
602 Choose ADODB or SQL to use an SQL database with ADODB or PEAR.
603 Choose PDO on php5 to use an SQL database. (experimental, no paging yet)
604 flatfile is simple and slow.
605 CVS is highly experimental and slow.
606 Recommended is dba or SQL: PEAR or ADODB."*/);
608 $properties["SQL DSN Setup"] =
609 new unchangeable_variable('_sqldsnstuff', "", "
610 For SQL based backends, specify the database as a DSN
611 The most general form of a DSN looks like:
613 phptype(dbsyntax)://username:password@protocol+hostspec/database?option=value
615 For a MySQL database, the following should work:
617 mysql://user:password@host/databasename
619 To connect over a unix socket, use something like
621 mysql://user:password@unix(/path/to/socket)/databasename
624 DATABASE_DSN = mysql://guest@:/var/lib/mysql/mysql.sock/phpwiki
625 DATABASE_DSN = mysql://guest@localhost/phpwiki
626 DATABASE_DSN = pgsql://localhost/user_phpwiki
629 // Choose ADODB or SQL to use an SQL database with ADODB or PEAR.
630 // Choose dba to use one of the standard UNIX dbm libraries.
632 $properties["SQL Type"] =
633 new _variable_selection('_dsn_sqltype',
634 array('mysql' => "MySQL",
635 'pgsql' => "PostgreSQL",
636 'mssql' => "Microsoft SQL Server",
637 'oci8' => "Oracle 8",
638 'mysqli' => "mysqli (only ADODB)",
639 'mysqlt' => "mysqlt (only ADODB)",
640 'ODBC' => "ODBC (only ADODB or PDO)",
641 'firebird' => "Firebird (only PDO)",
642 'oracle' => "Oracle (only PDO)"), "
643 SQL DB types. The DSN hosttype.");
645 $properties["SQL User"] =
646 new _variable('_dsn_sqluser', "wikiuser", "
649 $properties["SQL Password"] =
650 new _variable('_dsn_sqlpass', "", "
653 $properties["SQL Database Host"] =
654 new _variable('_dsn_sqlhostorsock', "localhost", "
655 SQL Database Hostname:
657 To connect over a local named socket, use something like
659 unix(/var/lib/mysql/mysql.sock)
662 mysql on Windows via named pipes might need 127.0.0.1");
664 $properties["SQL Database Name"] =
665 new _variable('_dsn_sqldbname', "phpwiki", "
666 SQL Database Name:");
668 $dsn_sqltype = $properties["SQL Type"]->value();
669 $dsn_sqluser = $properties["SQL User"]->value();
670 $dsn_sqlpass = $properties["SQL Password"]->value();
671 $dsn_sqlhostorsock = $properties["SQL Database Host"]->value();
672 $dsn_sqldbname = $properties["SQL Database Name"]->value();
673 $dsn_sqlstring = $dsn_sqltype."://{$dsn_sqluser}:{$dsn_sqlpass}@{$dsn_sqlhostorsock}/{$dsn_sqldbname}";
675 $properties["SQL dsn"] =
676 new unchangeable_define("DATABASE_DSN",
678 Calculated from the settings above:");
680 $properties["Filename / Table name Prefix"] =
681 new _define_commented('DATABASE_PREFIX', DATABASE_PREFIX, "
682 Used by all DB types:
684 Prefix for filenames or table names, e.g. \"phpwiki_\"
686 Currently <b>you MUST EDIT THE SQL file too!</b> (in the schemas/
687 directory because we aren't doing on the fly sql generation
688 during the installation.
690 Note: This prefix is NOT prepended to the default DBAUTH_
691 tables user, pref and member!
694 $properties["DATABASE_PERSISTENT"] =
695 new boolean_define_commented_optional
696 ('DATABASE_PERSISTENT',
697 array('false' => "Disabled",
698 'true' => "Enabled"));
700 $properties["DB Session table"] =
701 new _define_optional("DATABASE_SESSION_TABLE", DATABASE_SESSION_TABLE, "
702 Tablename to store session information. Only supported by SQL backends.
704 A word of warning - any prefix defined above will be prepended to whatever is given here.
708 $temp = !empty($_ENV['TEMP']) ? $_ENV['TEMP'] : "/tmp";
709 $properties["dba directory"] =
710 new _define("DATABASE_DIRECTORY", $temp);
712 // TODO: list the available methods
713 $properties["dba handler"] =
714 new _define_selection('DATABASE_DBA_HANDLER',
715 array('gdbm' => "gdbm - GNU database manager (not recommended anymore)",
716 'dbm' => "DBM - Redhat default. On sf.net there's dbm and not gdbm anymore",
717 'db2' => "DB2 - BerkeleyDB (Sleepycat) DB2",
718 'db3' => "DB3 - BerkeleyDB (Sleepycat) DB3. Default on Windows but not on every Linux",
719 'db4' => "DB4 - BerkeleyDB (Sleepycat) DB4."), "
720 Use 'gdbm', 'dbm', 'db2', 'db3' or 'db4' depending on your DBA handler methods supported: <br /> "
721 . (function_exists("dba_handlers") ? join(", ",dba_handlers()) : "")
722 . "\n\nBetter not use other hacks such as inifile, flatfile or cdb");
724 $properties["dba timeout"] =
725 new numeric_define("DATABASE_TIMEOUT", DATABASE_TIMEOUT, "
726 Recommended values are 10-20 seconds. The more load the server has, the higher the timeout.");
728 $properties["DATABASE_OPTIMISE_FREQUENCY"] =
729 new numeric_define_optional('DATABASE_OPTIMISE_FREQUENCY', DATABASE_OPTIMISE_FREQUENCY);
731 $properties["DBADMIN_USER"] =
732 new _define_optional('DBADMIN_USER', DBADMIN_USER);
734 $properties["DBADMIN_PASSWD"] =
735 new _define_password_optional('DBADMIN_PASSWD', DBADMIN_PASSWD);
737 $properties["USECACHE"] =
738 new boolean_define_commented_optional('USECACHE');
742 $properties["Page Revisions"] =
743 new unchangeable_variable('_parttworevisions', "", "
745 Section 2a: Archive Cleanup
746 The next section controls how many old revisions of each page are kept in the database.
748 There are two basic classes of revisions: major and minor. Which
749 class a revision belongs in is determined by whether the author
750 checked the \"this is a minor revision\" checkbox when they saved the
753 There is, additionally, a third class of revisions: author
754 revisions. The most recent non-mergable revision from each distinct
755 author is and author revision.
757 The expiry parameters for each of those three classes of revisions
758 can be adjusted seperately. For each class there are five
759 parameters (usually, only two or three of the five are actually
760 set) which control how long those revisions are kept in the
763 <dt>max_keep:</dt> <dd>If set, this specifies an absolute maximum for the
764 number of archived revisions of that class. This is
765 meant to be used as a safety cap when a non-zero
766 min_age is specified. It should be set relatively high,
767 and it's purpose is to prevent malicious or accidental
768 database overflow due to someone causing an
769 unreasonable number of edits in a short period of time.</dd>
771 <dt>min_age:</dt> <dd>Revisions younger than this (based upon the supplanted
772 date) will be kept unless max_keep is exceeded. The age
773 should be specified in days. It should be a
774 non-negative, real number,</dd>
776 <dt>min_keep:</dt> <dd>At least this many revisions will be kept.</dd>
778 <dt>keep:</dt> <dd>No more than this many revisions will be kept.</dd>
780 <dt>max_age:</dt> <dd>No revision older than this age will be kept.</dd>
782 Supplanted date: Revisions are timestamped at the instant that they
783 cease being the current revision. Revision age is computed using
784 this timestamp, not the edit time of the page.
786 Merging: When a minor revision is deleted, if the preceding
787 revision is by the same author, the minor revision is merged with
788 the preceding revision before it is deleted. Essentially: this
789 replaces the content (and supplanted timestamp) of the previous
790 revision with the content after the merged minor edit, the rest of
791 the page metadata for the preceding version (summary, mtime, ...)
795 // For now the expiration parameters are statically inserted as
796 // an unchangeable property. You'll have to edit the resulting
797 // config file if you really want to change these from the default.
799 $properties["Major Edits: keep minimum days"] =
800 new numeric_define('MAJOR_MIN_KEEP', MAJOR_MIN_KEEP, "
801 Default: Keep for unlimited time.
802 Set to 0 to enable archive cleanup");
803 $properties["Minor Edits: keep minumum days"] =
804 new numeric_define('MINOR_MIN_KEEP', MINOR_MIN_KEEP, "
805 Default: Keep for unlimited time.
806 Set to 0 to enable archive cleanup");
808 $properties["Major Edits: how many"] =
809 new numeric_define('MAJOR_KEEP', MAJOR_KEEP, "
810 Keep up to 8 major edits");
811 $properties["Major Edits: how many days"] =
812 new numeric_define('MAJOR_MAX_AGE', MAJOR_MAX_AGE, "
813 keep them no longer than a month");
815 $properties["Minor Edits: how many"] =
816 new numeric_define("MINOR_KEEP", MINOR_KEEP, "
817 Keep up to 4 minor edits");
818 $properties["Minor Edits: how many days"] =
819 new numeric_define("MINOR_MAX_AGE", "7", "
820 keep them no longer than a week");
822 $properties["per Author: how many"] =
823 new numeric_define("AUTHOR_KEEP", "8", "
824 Keep the latest contributions of the last 8 authors,");
825 $properties["per Author: how many days"] =
826 new numeric_define("AUTHOR_MAX_AGE", "365", "
828 $properties["per Author: keep minumum days"] =
829 new numeric_define("AUTHOR_MIN_AGE", "7", "
830 Additionally, (in the case of a particularly active page) try to
831 keep the latest contributions of all authors in the last week (even if there are more than eight of them,)");
832 $properties["per Author: max revisions"] =
833 new numeric_define("AUTHOR_MAX_KEEP", "20", "
834 but in no case keep more than twenty unique author revisions.");
836 /////////////////////////////////////////////////////////////////////
838 $properties["Part Three"] =
839 new part('_part3', $SEPARATOR."\n", "
841 Part Three: (optional)
842 Basic User Authentication Setup
845 $properties["Publicly viewable"] =
846 new boolean_define_optional('ALLOW_ANON_USER',
847 array('true' => "true. Permit anonymous view. (Default)",
848 'false' => "false. Force login even on view (strictly private)"), "
849 If ALLOW_ANON_USER is false, you have to login before viewing any page or doing any other action on a page.");
851 $properties["Allow anonymous edit"] =
852 new boolean_define_optional('ALLOW_ANON_EDIT',
853 array('true' => "true. Permit anonymous users to edit. (Default)",
854 'false' => "false. Force login on edit (moderately locked)"), "
855 If ALLOW_ANON_EDIT is false, you have to login before editing or changing any page. See below.");
857 $properties["Allow Bogo Login"] =
858 new boolean_define_optional('ALLOW_BOGO_LOGIN',
859 array('true' => "true. Users may Sign In with any WikiWord, without password. (Default)",
860 'false' => "false. Require stricter authentication."), "
861 If ALLOW_BOGO_LOGIN is false, you may not login with any wikiword username and empty password.
862 If true, users are allowed to create themselves with any WikiWord username. See below.");
864 $properties["Allow User Passwords"] =
865 new boolean_define_optional('ALLOW_USER_PASSWORDS',
866 array('true' => "True user authentication with password checking. (Default)",
867 'false' => "false. Ignore authentication settings below."), "
868 If ALLOW_USER_PASSWORDS is true, the authentication settings below define where and how to
869 check against given username/passwords. For completely security disable BOGO_LOGIN and ANON_EDIT above.");
871 $properties["User Authentication Methods"] =
872 new array_define('USER_AUTH_ORDER', array("PersonalPage", "Db"), "
873 Many different methods can be used to check user's passwords.
874 Try any of these in the given order:
877 <dd>WikiWord username, with no *actual* password checking,
878 although the user will still have to enter one.</dd>
879 <dt>PersonalPage</dt>
880 <dd>Store passwords in the users homepage metadata (simple)</dd>
882 <dd>Use DBAUTH_AUTH_* (see below) with PearDB or ADODB only.</dd>
884 <dd>Authenticate against LDAP_AUTH_HOST with LDAP_BASE_DN.</dd>
886 <dd>Authenticate against IMAP_AUTH_HOST (email account)</dd>
888 <dd>Authenticate against POP3_AUTH_HOST (email account)</dd>
890 <dd>Get username and level from a PHP session variable. (e.g. for gforge)</dd>
892 <dd>Store username:crypted-passwords in .htaccess like files.
893 Use Apache's htpasswd to manage this file.</dd>
895 <dd>Use the protection by the webserver (.htaccess/.htpasswd) (experimental)
896 Enforcing HTTP Auth not yet. Note that the ADMIN_USER should exist also.
897 Using HttpAuth disables all other methods and no userauth sessions are used.</dd>
900 Several of these methods can be used together, in the manner specified by
901 USER_AUTH_POLICY, below. To specify multiple authentication methods,
902 separate the name of each one with colons.
904 USER_AUTH_ORDER = 'PersonalPage : Db'
905 USER_AUTH_ORDER = 'BogoLogin : PersonalPage'
908 $properties["ENABLE_AUTH_OPENID"] =
909 new boolean_define('ENABLE_AUTH_OPENID');
911 $properties["PASSWORD_LENGTH_MINIMUM"] =
912 new numeric_define('PASSWORD_LENGTH_MINIMUM', PASSWORD_LENGTH_MINIMUM);
914 $properties["USER_AUTH_POLICY"] =
915 new _define_selection('USER_AUTH_POLICY',
916 array('first-only' => "first-only - use only the first method in USER_AUTH_ORDER",
917 'old' => "old - ignore USER_AUTH_ORDER (legacy)",
918 'strict' => "strict - check all methods for userid + password (recommended)",
919 'stacked' => "stacked - check all methods for userid, and if found for password"), "
920 The following policies are available for user authentication:
923 <dd>use only the first method in USER_AUTH_ORDER</dd>
925 <dd>ignore USER_AUTH_ORDER and try to use all available
926 methods as in the previous PhpWiki releases (slow)</dd>
928 <dd>check if the user exists for all methods:
929 on the first existing user, try the password.
930 dont try the other methods on failure then</dd>
932 <dd>check the given user - password combination for all
933 methods and return true on the first success.</dd></dl>");
935 $properties["ENABLE_USER_NEW"] =
936 new boolean_define_commented_optional('ENABLE_USER_NEW');
938 $properties["ENABLE_PAGEPERM"] =
939 new boolean_define_commented_optional('ENABLE_PAGEPERM');
943 $properties["Part Three A"] =
944 new part('_part3a', $SEPARATOR."\n", "
946 Part Three A: (optional)
949 $properties["Group membership"] =
950 new _define_selection("GROUP_METHOD",
951 array('WIKIPAGE' => "WIKIPAGE - List at \"CategoryGroup\". (Slowest, but easiest to maintain)",
952 '"NONE"' => "NONE - Disable group membership (Fastest)",
953 'DB' => "DB - SQL Database, Optionally external. See USERS/GROUPS queries",
954 'FILE' => "Flatfile. See AUTH_GROUP_FILE below.",
955 'LDAP' => "LDAP - See \"LDAP authentication options\" above. (Experimental)"), "
956 Group membership. PhpWiki supports defining permissions for a group as
957 well as for individual users. This defines how group membership information
958 is obtained. Supported values are:
961 <dd>Disable group membership (Fastest). Note the required quoting.</dd>
963 <dd>Define groups as list at \"CategoryGroup\". (Slowest, but easiest to maintain)</dd>
965 <dd>Stored in an SQL database. Optionally external. See USERS/GROUPS queries</dd>
967 <dd>Flatfile. See AUTH_GROUP_FILE below.</dd>
969 <dd>LDAP groups. See \"LDAP authentication options\" above and
970 lib/WikiGroup.php. (experimental)</dd></dl>");
972 $properties["CATEGORY_GROUP_PAGE"] =
973 new _define_optional('CATEGORY_GROUP_PAGE', _("CategoryGroup"), "
974 If GROUP_METHOD = WIKIPAGE:
976 Page where all groups are listed.");
978 $properties["AUTH_GROUP_FILE"] =
979 new _define_optional('AUTH_GROUP_FILE', _("/etc/groups"), "
980 For GROUP_METHOD = FILE, the file given below is referenced to obtain
981 group membership information. It should be in the same format as the
982 standard unix /etc/groups(5) file.");
984 $properties["Part Three B"] =
985 new part('_part3b', $SEPARATOR."\n", "
987 Part Three B: (optional)
988 External database authentication and authorization.
990 If USER_AUTH_ORDER includes Db, or GROUP_METHOD = DB, the options listed
991 below define the SQL queries used to obtain the information out of the
992 database, and (optionally) store the information back to the DB.");
994 $properties["DBAUTH_AUTH_DSN"] =
995 new _define_optional('DBAUTH_AUTH_DSN', $dsn_sqlstring, "
996 A database DSN to connect to. Defaults to the DSN specified for the Wiki as a whole.");
998 $properties["User Exists Query"] =
999 new _define('DBAUTH_AUTH_USER_EXISTS', "SELECT userid FROM user WHERE userid='\$userid'", "
1000 USER/PASSWORD queries:
1002 For USER_AUTH_POLICY=strict and the Db method is required");
1004 $properties["Check Query"] =
1005 new _define_optional('DBAUTH_AUTH_CHECK', "SELECT IF(passwd='\$password',1,0) AS ok FROM user WHERE userid='\$userid'", "
1007 Check to see if the supplied username/password pair is OK
1009 Plaintext passwords: (DBAUTH_AUTH_CRYPT_METHOD = plain)<br />
1010 ; DBAUTH_AUTH_CHECK = \"SELECT IF(passwd='\$password',1,0) AS ok FROM user WHERE userid='\$userid'\"
1012 database-hashed passwords (more secure):<br />
1013 ; DBAUTH_AUTH_CHECK = \"SELECT IF(passwd=PASSWORD('\$password'),1,0) AS ok FROM user WHERE userid='\$userid'\"");
1015 $properties["Crypt Method"] =
1016 new _define_selection_optional
1017 ('DBAUTH_AUTH_CRYPT_METHOD',
1018 array('plain' => 'plain',
1019 'crypt' => 'crypt'), "
1020 If you want to use Unix crypt()ed passwords, you can use DBAUTH_AUTH_CHECK
1021 to get the password out of the database with a simple SELECT query, and
1022 specify DBAUTH_AUTH_USER_EXISTS and DBAUTH_AUTH_CRYPT_METHOD:
1024 ; DBAUTH_AUTH_CHECK = \"SELECT passwd FROM user where userid='\$userid'\" <br />
1025 ; DBAUTH_AUTH_CRYPT_METHOD = crypt");
1027 $properties["Update the user's authentication credential"] =
1028 new _define('DBAUTH_AUTH_UPDATE', "UPDATE user SET passwd='\$password' WHERE userid='\$userid'", "
1029 If this is not defined but DBAUTH_AUTH_CHECK is, then the user will be unable to update their
1032 Plaintext passwords:<br />
1033 DBAUTH_AUTH_UPDATE = \"UPDATE user SET passwd='\$password' WHERE userid='\$userid'\"<br />
1034 Database-hashed passwords:<br />
1035 DBAUTH_AUTH_UPDATE = \"UPDATE user SET passwd=PASSWORD('\$password') WHERE userid='\$userid'\"");
1037 $properties["Allow the user to create their own account"] =
1038 new _define_optional('DBAUTH_AUTH_CREATE', "INSERT INTO user SET passwd=PASSWORD('\$password'),userid='\$userid'", "
1039 If this is empty, Db users cannot subscribe by their own.");
1041 $properties["USER/PREFERENCE queries"] =
1042 new _define_optional('DBAUTH_PREF_SELECT', "SELECT prefs FROM user WHERE userid='\$userid'", "
1043 If you choose to store your preferences in an external database, enable
1044 the following queries. Note that if you choose to store user preferences
1045 in the 'user' table, only registered users get their prefs from the database,
1046 self-created users do not. Better to use the special 'pref' table.
1048 The prefs field stores the serialized form of the user's preferences array,
1049 to ease the complication of storage.
1051 DBAUTH_PREF_SELECT = \"SELECT prefs FROM user WHERE userid='\$userid'\"
1052 DBAUTH_PREF_SELECT = \"SELECT prefs FROM pref WHERE userid='\$userid'\"
1055 $properties["Update the user's preferences"] =
1056 new _define_optional('DBAUTH_PREF_UPDATE', "UPDATE user SET prefs='\$pref_blob' WHERE userid='\$userid'", "
1057 Note that REPLACE works only with mysql and destroy all other columns!
1059 Mysql: DBAUTH_PREF_UPDATE = \"REPLACE INTO pref SET prefs='\$pref_blob',userid='\$userid'\"");
1061 $properties["Create new user's preferences"] =
1062 new _define_optional('DBAUTH_PREF_INSERT', "INSERT INTO pref (userid,prefs) VALUES ('\$userid','\$pref_blob')", "
1063 Define this if new user can be create by themselves.
1066 $properties["USERS/GROUPS queries"] =
1067 new _define_optional('DBAUTH_IS_MEMBER', "SELECT user FROM user WHERE user='\$userid' AND group='\$groupname'", "
1068 You can define 1:n or n:m user<=>group relations, as you wish.
1070 Sample configurations:
1072 only one group per user (1:n):<br />
1073 DBAUTH_IS_MEMBER = \"SELECT user FROM user WHERE user='\$userid' AND group='\$groupname'\"<br />
1074 DBAUTH_GROUP_MEMBERS = \"SELECT user FROM user WHERE group='\$groupname'\"<br />
1075 DBAUTH_USER_GROUPS = \"SELECT group FROM user WHERE user='\$userid'\"<br />
1076 multiple groups per user (n:m):<br />
1077 DBAUTH_IS_MEMBER = \"SELECT userid FROM member WHERE userid='\$userid' AND groupname='\$groupname'\"<br />
1078 DBAUTH_GROUP_MEMBERS = \"SELECT DISTINCT userid FROM member WHERE groupname='\$groupname'\"<br />
1079 DBAUTH_USER_GROUPS = \"SELECT groupname FROM member WHERE userid='\$userid'\"<br />");
1080 $properties["DBAUTH_GROUP_MEMBERS"] =
1081 new _define_optional('DBAUTH_GROUP_MEMBERS', "SELECT user FROM user WHERE group='\$groupname'", "");
1082 $properties["DBAUTH_USER_GROUPS"] =
1083 new _define_optional('DBAUTH_USER_GROUPS', "SELECT group FROM user WHERE user='\$userid'", "");
1085 if (function_exists('ldap_connect')) {
1087 $properties["LDAP AUTH Host"] =
1088 new _define_optional('LDAP_AUTH_HOST', "ldap://localhost:389", "
1089 If USER_AUTH_ORDER contains Ldap:
1091 The LDAP server to connect to. Can either be a hostname, or a complete
1092 URL to the server (useful if you want to use ldaps or specify a different
1095 $properties["LDAP BASE DN"] =
1096 new _define_optional('LDAP_BASE_DN', "ou=mycompany.com,o=My Company", "
1097 The organizational or domain BASE DN: e.g. \"dc=mydomain,dc=com\".
1099 Note: ou=Users and ou=Groups are used for GroupLdap Membership
1100 Better use LDAP_OU_USERS and LDAP_OU_GROUP with GROUP_METHOD=LDAP.");
1102 $properties["LDAP SET OPTION"] =
1103 new _define_optional('LDAP_SET_OPTION', "LDAP_OPT_PROTOCOL_VERSION=3:LDAP_OPT_REFERRALS=0", "
1104 Some LDAP servers need some more options, such as the Windows Active
1105 Directory Server. Specify the options (as allowed by the PHP LDAP module)
1106 and their values as NAME=value pairs separated by colons.");
1108 $properties["LDAP AUTH USER"] =
1109 new _define_optional('LDAP_AUTH_USER', "CN=ldapuser,ou=Users,o=Development,dc=mycompany.com", "
1110 DN to initially bind to the LDAP server as. This is needed if the server doesn't
1111 allow anonymous queries. (Windows Active Directory Server)");
1113 $properties["LDAP AUTH PASSWORD"] =
1114 new _define_optional('LDAP_AUTH_PASSWORD', "secret", "
1115 Password to use to initially bind to the LDAP server, as the DN
1116 specified in the LDAP_AUTH_USER option (above).");
1118 $properties["LDAP SEARCH FIELD"] =
1119 new _define_optional('LDAP_SEARCH_FIELD', "uid", "
1120 If you want to match usernames against an attribute other than uid,
1121 specify it here. Default: uid
1123 e.g.: LDAP_SEARCH_FIELD = sAMAccountName");
1125 $properties["LDAP OU USERS"] =
1126 new _define_optional('LDAP_OU_USERS', "ou=Users", "
1127 If you have an organizational unit for all users, define it here.
1128 This narrows the search, and is needed for LDAP group membership (if GROUP_METHOD=LDAP)
1129 Default: ou=Users");
1131 $properties["LDAP OU GROUP"] =
1132 new _define_optional('LDAP_OU_GROUP', "ou=Groups", "
1133 If you have an organizational unit for all groups, define it here.
1134 This narrows the search, and is needed for LDAP group membership (if GROUP_METHOD=LDAP)
1135 The entries in this ou must have a gidNumber and cn attribute.
1136 Default: ou=Groups");
1138 } else { // function_exists('ldap_connect')
1140 $properties["LDAP Authentication"] =
1141 new unchangeable_variable('LDAP Authentication', "
1142 ; If USER_AUTH_ORDER contains Ldap:
1144 ; The LDAP server to connect to. Can either be a hostname, or a complete
1145 ; URL to the server (useful if you want to use ldaps or specify a different
1147 ;LDAP_AUTH_HOST = \"ldap://localhost:389\"
1149 ; The organizational or domain BASE DN: e.g. \"dc=mydomain,dc=com\".
1151 ; Note: ou=Users and ou=Groups are used for GroupLdap Membership
1152 ; Better use LDAP_OU_USERS and LDAP_OU_GROUP with GROUP_METHOD=LDAP.
1153 ;LDAP_BASE_DN = \"ou=Users,o=Development,dc=mycompany.com\"
1155 ; Some LDAP servers need some more options, such as the Windows Active
1156 ; Directory Server. Specify the options (as allowed by the PHP LDAP module)
1157 ; and their values as NAME=value pairs separated by colons.
1158 ; LDAP_SET_OPTION = \"LDAP_OPT_PROTOCOL_VERSION=3:LDAP_OPT_REFERRALS=0\"
1160 ; DN to initially bind to the LDAP server as. This is needed if the server doesn't
1161 ; allow anonymous queries. (Windows Active Directory Server)
1162 ; LDAP_AUTH_USER = \"CN=ldapuser,ou=Users,o=Development,dc=mycompany.com\"
1164 ; Password to use to initially bind to the LDAP server, as the DN
1165 ; specified in the LDAP_AUTH_USER option (above).
1166 ; LDAP_AUTH_PASSWORD = secret
1168 ; If you want to match usernames against an attribute other than uid,
1169 ; specify it here. Default: uid
1170 ; LDAP_SEARCH_FIELD = sAMAccountName
1172 ; If you have an organizational unit for all users, define it here.
1173 ; This narrows the search, and is needed for LDAP group membership (if GROUP_METHOD=LDAP)
1175 ; LDAP_OU_USERS = ou=Users
1177 ; If you have an organizational unit for all groups, define it here.
1178 ; This narrows the search, and is needed for LDAP group membership (if GROUP_METHOD=LDAP)
1179 ; The entries in this ou must have a gidNumber and cn attribute.
1180 ; Default: ou=Groups
1181 ; LDAP_OU_GROUP = ou=Groups", "
1182 ; Ignored. No LDAP support in this php. configure --with-ldap");
1185 if (function_exists('imap_open')) {
1187 $properties["IMAP Auth Host"] =
1188 new _define_optional('IMAP_AUTH_HOST', 'localhost:143/imap/notls', "
1189 If USER_AUTH_ORDER contains IMAP:
1191 The IMAP server to check usernames from. Defaults to localhost.
1193 Some IMAP_AUTH_HOST samples:
1194 localhost, localhost:143/imap/notls,
1195 localhost:993/imap/ssl/novalidate-cert (SuSE refuses non-SSL conections)");
1197 } else { // function_exists('imap_open')
1199 $properties["IMAP Authentication"] =
1200 new unchangeable_variable('IMAP_AUTH_HOST',"
1201 ; If USER_AUTH_ORDER contains IMAP:
1202 ; The IMAP server to check usernames from. Defaults to localhost.
1204 ; Some IMAP_AUTH_HOST samples:
1205 ; localhost, localhost:143/imap/notls,
1206 ; localhost:993/imap/ssl/novalidate-cert (SuSE refuses non-SSL conections)
1207 ;IMAP_AUTH_HOST = localhost:143/imap/notls", "
1208 Ignored. No IMAP support in this php. configure --with-imap");
1212 $properties["POP3 Authentication"] =
1213 new _define_optional('POP3_AUTH_HOST', 'localhost:110', "
1214 If USER_AUTH_ORDER contains POP3:
1216 The POP3 mail server to check usernames and passwords against.");
1217 $properties["File Authentication"] =
1218 new _define_optional('AUTH_USER_FILE', '/etc/shadow', "
1219 If USER_AUTH_ORDER contains File:
1221 File to read for authentication information.
1222 Popular choices are /etc/shadow and /etc/httpd/.htpasswd");
1224 $properties["File Storable?"] =
1225 new boolean_define_commented_optional('AUTH_USER_FILE_STORABLE');
1227 $properties["Session Auth USER"] =
1228 new _define_optional('AUTH_SESS_USER', 'userid', "
1229 If USER_AUTH_ORDER contains Session:
1231 Name of the session variable which holds the already authenticated username.
1232 Sample: 'userid', 'user[username]', 'user->username'");
1234 $properties["Session Auth LEVEL"] =
1235 new numeric_define('AUTH_SESS_LEVEL', '2', "
1236 Which level will the user be? 1 = Bogo or 2 = Pass");
1238 /////////////////////////////////////////////////////////////////////
1240 $properties["Part Four"] =
1241 new part('_part4', $SEPARATOR."\n", "
1244 Page appearance and layout");
1246 $properties["Theme"] =
1247 new _define_selection_optional('THEME',
1248 array('default' => "default",
1249 'MacOSX' => "MacOSX",
1250 'smaller' => 'smaller',
1251 'Wordpress'=> 'Wordpress',
1252 'Portland' => "Portland",
1253 'Sidebar' => "Sidebar",
1255 'wikilens' => 'wikilens (Ratings)',
1256 'shamino_com' => 'shamino_com',
1257 'SpaceWiki' => "SpaceWiki",
1258 'Hawaiian' => "Hawaiian",
1259 'MonoBook' => 'MonoBook [experimental]',
1260 'blog' => 'blog [experimental]',
1264 Most of the page appearance is controlled by files in the theme
1267 There are a number of pre-defined themes shipped with PhpWiki.
1268 Or you may create your own, e.g. by copying and then modifying one of
1273 THEME = MonoBook (WikiPedia)
1279 THEME = wikilens (with Ratings)
1287 THEME = blog (Kubrick) [experimental. Several links missing]
1290 $properties["Character Set"] =
1291 new _define_optional('CHARSET', 'iso-8859-1');
1293 $properties["Ignore Charset Not Supported Warning"] =
1294 new _define_optional('IGNORE_CHARSET_NOT_SUPPORTED_WARNING');
1296 $properties["Language"] =
1297 new _define_selection_optional('DEFAULT_LANGUAGE',
1298 array('en' => "English",
1299 '' => "<empty> (user-specific)",
1302 'nl' => "Nederlands",
1307 'zh' => "Chinese"), "
1308 Select your language/locale - default language is \"en\" for English.
1309 Other languages available:<pre>
1310 English \"en\" (English - HomePage)
1311 German \"de\" (Deutsch - StartSeite)
1312 French \"fr\" (Français - Accueil)
1313 Dutch \"nl\" (Nederlands - ThuisPagina)
1314 Spanish \"es\" (Español - PáginaPrincipal)
1315 Swedish \"sv\" (Svenska - Framsida)
1316 Italian \"it\" (Italiano - PaginaPrincipale)
1317 Japanese \"ja\" (Japanese - ホームページ)
1318 Chinese \"zh\" (Chinese - 首頁)
1320 If you set DEFAULT_LANGUAGE to the empty string, your systems default language
1321 (as determined by the applicable environment variables) will be
1324 $properties["Wiki Page Source"] =
1325 new _define_optional('WIKI_PGSRC', 'pgsrc', "
1326 WIKI_PGSRC -- specifies the source for the initial page contents of
1327 the Wiki. The setting of WIKI_PGSRC only has effect when the wiki is
1328 accessed for the first time (or after clearing the database.)
1329 WIKI_PGSRC can either name a directory or a zip file. In either case
1330 WIKI_PGSRC is scanned for files -- one file per page.
1332 // Default (old) behavior:
1333 define('WIKI_PGSRC', 'pgsrc');
1335 define('WIKI_PGSRC', 'wiki.zip');
1336 define('WIKI_PGSRC',
1337 '../Logs/Hamwiki/hamwiki-20010830.zip');
1340 $properties["Default Wiki Page Source"] =
1341 new _define('DEFAULT_WIKI_PGSRC', 'pgsrc', "
1342 DEFAULT_WIKI_PGSRC is only used when the language is *not* the
1343 default (English) and when reading from a directory: in that case
1344 some English pages are inserted into the wiki as well.
1345 DEFAULT_WIKI_PGSRC defines where the English pages reside.
1348 $properties["Generic Pages"] =
1349 new array_variable('DEFAULT_WIKI_PAGES', array('ReleaseNotes', 'SteveWainstead', 'TestPage'), "
1350 These are ':'-seperated pages which will get loaded untranslated from DEFAULT_WIKI_PGSRC.
1355 $properties["Part Five"] =
1356 new part('_part5', $SEPARATOR."\n", "
1361 $properties["Allowed Protocols"] =
1362 new list_define('ALLOWED_PROTOCOLS', 'http|https|mailto|ftp|news|nntp|ssh|gopher', "
1363 Allowed protocols for links - be careful not to allow \"javascript:\"
1364 URL of these types will be automatically linked.
1365 within a named link [name|uri] one more protocol is defined: phpwiki");
1367 $properties["Inline Images"] =
1368 new list_define('INLINE_IMAGES', 'png|jpg|jpeg|gif');
1370 $properties["WikiName Regexp"] =
1371 new _define('WIKI_NAME_REGEXP', "(?<![[:alnum:]])(?:[[:upper:]][[:lower:]]+){2,}(?![[:alnum:]])", "
1372 Perl regexp for WikiNames (\"bumpy words\")
1373 (?<!..) & (?!...) used instead of '\b' because \b matches '_' as well");
1375 $properties["Subpage Separator"] =
1376 new _define_optional('SUBPAGE_SEPARATOR', '"/"', "
1377 One character which seperates pages from subpages. Defaults to '/', but '.' or ':' were also used.",
1378 "onchange=\"validate_ereg('Sorry, \'%s\' must be a single character. Currently only :, / or .', '^[/:.]$', 'SUBPAGE_SEPARATOR', this);\""
1381 $properties["InterWiki Map File"] =
1382 new _define('INTERWIKI_MAP_FILE', 'lib/interwiki.map', "
1383 InterWiki linking -- wiki-style links to other wikis on the web
1385 The map will be taken from a page name InterWikiMap.
1386 If that page is not found (or is not locked), or map
1387 data can not be found in it, then the file specified
1388 by INTERWIKI_MAP_FILE (if any) will be used.");
1390 $properties["WARN_NONPUBLIC_INTERWIKIMAP"] =
1391 new boolean_define('WARN_NONPUBLIC_INTERWIKIMAP');
1393 $properties["Keyword Link Regexp"] =
1394 new _define_optional('KEYWORDS', '\"Category* OR Topic*\"', "
1395 Search term used for automatic page classification by keyword extraction.
1397 Any links on a page to pages whose names match this search
1398 will be used keywords in the keywords html meta tag. This is an aid to
1399 classification by search engines. The value of the match is
1400 used as the keyword.
1402 The default behavior is to match Category* or Topic* links.");
1404 $properties["Author and Copyright Site Navigation Links"] =
1405 new _define_commented_optional('COPYRIGHTPAGE_TITLE', "GNU General Public License", "
1407 These will be inserted as <link rel> tags in the html header of
1408 every page, for search engines and for browsers like Mozilla which
1409 take advantage of link rel site navigation.
1411 If you have your own copyright and contact information pages change
1412 these as appropriate.");
1414 $properties["COPYRIGHTPAGE URL"] =
1415 new _define_commented_optional('COPYRIGHTPAGE_URL', "http://www.gnu.org/copyleft/gpl.html#SEC1", "
1417 Other useful alternatives to consider:
1419 COPYRIGHTPAGE_TITLE = \"GNU Free Documentation License\"
1420 COPYRIGHTPAGE_URL = \"http://www.gnu.org/copyleft/fdl.html\"
1421 COPYRIGHTPAGE_TITLE = \"Creative Commons License 2.0\"
1422 COPYRIGHTPAGE_URL = \"http://creativecommons.org/licenses/by/2.0/\"</pre>
1423 See http://creativecommons.org/learn/licenses/ for variations");
1425 $properties["AUTHORPAGE_TITLE"] =
1426 new _define_commented_optional('AUTHORPAGE_TITLE', "The PhpWiki Programming Team", "
1427 Default Author Names");
1428 $properties["AUTHORPAGE_URL"] =
1429 new _define_commented_optional('AUTHORPAGE_URL', "http://phpwiki.org/ThePhpWikiProgrammingTeam", "
1430 Default Author URL");
1432 $properties["TOC_FULL_SYNTAX"] =
1433 new boolean_define_optional('TOC_FULL_SYNTAX');
1435 $properties["ENABLE_MARKUP_COLOR"] =
1436 new boolean_define_optional('ENABLE_MARKUP_COLOR');
1438 $properties["DISABLE_MARKUP_WIKIWORD"] =
1439 new boolean_define_optional('DISABLE_MARKUP_WIKIWORD');
1441 $properties["ENABLE_MARKUP_DIVSPAN" ] =
1442 new boolean_define_optional('ENABLE_MARKUP_DIVSPAN');
1446 $properties["Part Six"] =
1447 new part('_part6', $SEPARATOR."\n", "
1449 Part Six (optional):
1450 URL options -- you can probably skip this section.
1452 For a pretty wiki (no index.php in the url) set a seperate DATA_PATH.");
1454 $properties["Server Name"] =
1455 new _define_commented_optional('SERVER_NAME', $_SERVER['SERVER_NAME'], "
1456 Canonical name of the server on which this PhpWiki resides.");
1458 $properties["Server Port"] =
1459 new numeric_define_commented('SERVER_PORT', $_SERVER['SERVER_PORT'], "
1460 Canonical httpd port of the server on which this PhpWiki resides.",
1461 "onchange=\"validate_ereg('Sorry, \'%s\' is no valid port number.', '^[0-9]+$', 'SERVER_PORT', this);\"");
1463 $properties["Server Protocol"] =
1464 new _define_selection_optional_commented('SERVER_PROTOCOL',
1465 array('http' => 'http',
1466 'https' => 'https'));
1468 $properties["Script Name"] =
1469 new _define_commented_optional('SCRIPT_NAME', $scriptname);
1471 $properties["Data Path"] =
1472 new _define_commented_optional('DATA_PATH', dirname($scriptname));
1474 $properties["PhpWiki Install Directory"] =
1475 new _define_commented_optional('PHPWIKI_DIR', dirname(__FILE__));
1477 $properties["Use PATH_INFO"] =
1478 new _define_selection_optional_commented('USE_PATH_INFO',
1479 array('' => 'automatic',
1480 'true' => 'use PATH_INFO',
1481 'false' => 'do not use PATH_INFO'), "
1482 PhpWiki will try to use short urls to pages, eg
1483 http://www.example.com/index.php/HomePage
1484 If you want to use urls like
1485 http://www.example.com/index.php?pagename=HomePage
1486 then define 'USE_PATH_INFO' as false by uncommenting the line below.
1487 NB: If you are using Apache >= 2.0.30, then you may need to to use
1488 the directive \"AcceptPathInfo On\" in your Apache configuration file
1489 (or in an appropriate <.htaccess> file) for the short urls to work:
1490 See http://httpd.apache.org/docs-2.0/mod/core.html#acceptpathinfo
1492 See also http://phpwiki.sourceforge.net/phpwiki/PrettyWiki for more ideas
1493 on prettifying your urls.
1495 Default: PhpWiki will try to divine whether use of PATH_INFO
1496 is supported in by your webserver/PHP configuration, and will
1497 use PATH_INFO if it thinks that is possible.");
1499 $properties["Virtual Path"] =
1500 new _define_commented_optional('VIRTUAL_PATH', '/SomeWiki', "
1501 VIRTUAL_PATH is the canonical URL path under which your your wiki
1502 appears. Normally this is the same as dirname(SCRIPT_NAME), however
1503 using e.g. seperate starter scripts, apaches mod_actions (or mod_rewrite),
1504 you can make it something different.
1506 If you do this, you should set VIRTUAL_PATH here or in the starter scripts.
1508 E.g. your phpwiki might be installed at at /scripts/phpwiki/index.php,
1509 but you've made it accessible through eg. /wiki/HomePage.
1511 One way to do this is to create a directory named 'wiki' in your
1512 server root. The directory contains only one file: an .htaccess
1513 file which reads something like:
1515 Action x-phpwiki-page /scripts/phpwiki/index.php
1516 SetHandler x-phpwiki-page
1517 DirectoryIndex /scripts/phpwiki/index.php
1519 In that case you should set VIRTUAL_PATH to '/wiki'.
1521 (VIRTUAL_PATH is only used if USE_PATH_INFO is true.)
1524 $upload_file_path = defined('UPLOAD_FILE_PATH') ? UPLOAD_FILE_PATH : getUploadFilePath();
1525 new _define_optional('UPLOAD_FILE_PATH', $temp);
1527 $upload_data_path = defined('UPLOAD_DATA_PATH') ? UPLOAD_DATA_PATH : getUploadDataPath();
1528 new _define_optional('UPLOAD_DATA_PATH', $temp);
1530 $temp = !empty($_ENV['TEMP']) ? $_ENV['TEMP'] : "/tmp";
1531 $properties["TEMP_DIR"] =
1532 new _define_optional('TEMP_DIR', $temp);
1536 $properties["Part Seven"] =
1537 new part('_part7', $SEPARATOR."\n", "
1541 Miscellaneous settings
1544 $properties["Strict Mailable Pagedumps"] =
1545 new boolean_define_optional('STRICT_MAILABLE_PAGEDUMPS',
1546 array('false' => "binary",
1547 'true' => "quoted-printable"));
1549 $properties["Default local Dump Directory"] =
1550 new _define_optional('DEFAULT_DUMP_DIR');
1552 $properties["Default local HTML Dump Directory"] =
1553 new _define_optional('HTML_DUMP_DIR');
1555 $properties["HTML Dump Filename Suffix"] =
1556 new _define_optional('HTML_DUMP_SUFFIX');
1558 $properties["Pagename of Recent Changes"] =
1559 new _define_optional('RECENT_CHANGES',
1562 $properties["Disable HTTP Redirects"] =
1563 new boolean_define_commented_optional('DISABLE_HTTP_REDIRECT');
1565 $properties["Disable GETIMAGESIZE"] =
1566 new boolean_define_commented_optional('DISABLE_GETIMAGESIZE');
1568 $properties["EDITING_POLICY"] =
1569 new _define_optional('EDITING_POLICY');
1571 $properties["TOOLBAR_PAGELINK_PULLDOWN"] =
1572 new _define_commented_optional('TOOLBAR_PAGELINK_PULLDOWN');
1573 $properties["TOOLBAR_TEMPLATE_PULLDOWN"] =
1574 new _define_commented_optional('TOOLBAR_TEMPLATE_PULLDOWN');
1575 $properties["TOOLBAR_IMAGE_PULLDOWN"] =
1576 new _define_commented_optional('TOOLBAR_IMAGE_PULLDOWN');
1577 $properties["FULLTEXTSEARCH_STOPLIST"] =
1578 new _define_commented_optional('FULLTEXTSEARCH_STOPLIST');
1580 $properties["Part Seven A"] =
1581 new part('_part7a', $SEPARATOR."\n", "
1585 Optional Plugin Settings and external executables
1588 $properties["FORTUNE_DIR"] =
1589 new _define_commented_optional('FORTUNE_DIR', "/usr/share/fortune");
1590 $properties["USE_EXTERNAL_HTML2PDF"] =
1591 new _define_commented_optional('USE_EXTERNAL_HTML2PDF', "htmldoc --quiet --format pdf14 --no-toc --no-title %s");
1592 $properties["EXTERNAL_HTML2PDF_PAGELIST"] =
1593 new _define_commented_optional('EXTERNAL_HTML2PDF_PAGELIST');
1594 $properties["BABYCART_PATH"] =
1595 new _define_commented_optional('BABYCART_PATH', "/usr/local/bin/babycart");
1596 $properties["GOOGLE_LICENSE_KEY"] =
1597 new _define_commented_optional('GOOGLE_LICENSE_KEY');
1598 $properties["RATEIT_IMGPREFIX"] =
1599 new _define_commented_optional('RATEIT_IMGPREFIX'); //BStar
1600 $properties["GRAPHVIZ_EXE"] =
1601 new _define_commented_optional('GRAPHVIZ_EXE'); // /usr/local/bin/dot
1603 if (PHP_OS == "Darwin") // Mac OS X
1604 $ttfont = "/System/Library/Frameworks/JavaVM.framework/Versions/1.3.1/Home/lib/fonts/LucidaSansRegular.ttf";
1605 elseif (isWindows()) {
1606 $ttfont = $_ENV['windir'].'\Fonts\Arial.ttf';
1608 $ttfont = 'luximr'; // This is the only what sourceforge offered.
1609 //$ttfont = 'Helvetica';
1611 $properties["TTFONT"] =
1612 new _define_commented_optional('TTFONT',$ttfont);
1613 $properties["VISUALWIKIFONT"] =
1614 new _define_commented_optional('VISUALWIKIFONT'); // Arial
1615 $properties["VISUALWIKI_ALLOWOPTIONS"] =
1616 new boolean_define_commented_optional('VISUALWIKI_ALLOWOPTIONS'); // false
1617 $properties["PLOTICUS_EXE"] =
1618 new _define_commented_optional('PLOTICUS_EXE'); // /usr/local/bin/pl
1619 $properties["PLOTICUS_PREFABS"] =
1620 new _define_commented_optional('PLOTICUS_PREFABS'); // /usr/share/ploticus
1621 $properties["MY_JABBER_ID"] =
1622 new _define_commented_optional('MY_JABBER_ID'); //
1623 $properties["PHPWEATHER_BASE_DIR"] =
1624 new _define_commented_optional('PHPWEATHER_BASE_DIR'); //
1625 $properties["HIGHLIGHT_EXE"] =
1626 new _define_commented_optional('HIGHLIGHT_EXE'); // /usr/local/bin/highlight
1627 $properties["HIGHLIGHT_DATA_DIR"] =
1628 new _define_commented_optional('HIGHLIGHT_DATA_DIR'); // /usr/share/highlight
1631 $properties["Part Eight"] =
1632 new part('_part8', $SEPARATOR."\n", "
1636 Cached Plugin Settings. (pear Cache)
1639 $properties["pear Cache USECACHE"] =
1640 new boolean_define_optional('PLUGIN_CACHED_USECACHE',
1641 array('true' => 'Enabled',
1642 'false' => 'Disabled'), "
1643 Enable or disable pear caching of plugins.");
1644 $properties["pear Cache Database Container"] =
1645 new _define_selection_optional('PLUGIN_CACHED_DATABASE',
1646 array('file' => 'file'), "
1647 Curently only file is supported.
1648 db, trifile and imgfile might be supported, but you must hack that by yourself.");
1650 $properties["pear Cache cache directory"] =
1651 new _define_commented_optional('PLUGIN_CACHED_CACHE_DIR', "/tmp/cache", "
1652 Should be writable to the webserver.");
1653 $properties["pear Cache Filename Prefix"] =
1654 new _define_optional('PLUGIN_CACHED_FILENAME_PREFIX', "phpwiki", "");
1655 $properties["pear Cache HIGHWATER"] =
1656 new numeric_define_optional('PLUGIN_CACHED_HIGHWATER', "4194304", "
1657 Garbage collection parameter.");
1658 $properties["pear Cache LOWWATER"] =
1659 new numeric_define_optional('PLUGIN_CACHED_LOWWATER', "3145728", "
1660 Garbage collection parameter.");
1661 $properties["pear Cache MAXLIFETIME"] =
1662 new numeric_define_optional('PLUGIN_CACHED_MAXLIFETIME', "2592000", "
1663 Garbage collection parameter.");
1664 $properties["pear Cache MAXARGLEN"] =
1665 new numeric_define_optional('PLUGIN_CACHED_MAXARGLEN', "1000", "
1666 max. generated url length.");
1667 $properties["pear Cache FORCE_SYNCMAP"] =
1668 new boolean_define_optional('PLUGIN_CACHED_FORCE_SYNCMAP',
1669 array('true' => 'Enabled',
1670 'false' => 'Disabled'), "");
1671 $properties["pear Cache IMGTYPES"] =
1672 new list_define('PLUGIN_CACHED_IMGTYPES', "png|gif|gd|gd2|jpeg|wbmp|xbm|xpm", "
1673 Handle those image types via GD handles. Check your GD supported image types.");
1675 $end = "\n".$SEPARATOR."\n";
1678 text_from_dist("_MAGIC_CLOSE_FILE");
1680 // end of configuration options
1681 ///////////////////////////////
1682 // begin class definitions
1685 * A basic config-dist.ini configuration line in the form of a variable.
1686 * (not needed anymore, we have only defines)
1688 * Produces a string in the form "$name = value;"
1690 * $WikiNameRegexp = "value";
1694 var $config_item_name;
1700 function _variable($config_item_name, $default_value='', $description = '', $jscheck = '') {
1701 $this->config_item_name = $config_item_name;
1703 $description = text_from_dist($config_item_name);
1704 $this->description = $description;
1705 if (defined($config_item_name)
1706 and !preg_match("/(selection|boolean)/", get_class($this))
1707 and !preg_match("/^(SCRIPT_NAME|VIRTUAL_PATH|TEMP_DIR)$/", $config_item_name))
1708 $this->default_value = constant($config_item_name); // ignore given default value
1709 elseif ($config_item_name == $default_value)
1710 $this->default_value = '';
1712 $this->default_value = $default_value;
1713 $this->jscheck = $jscheck;
1714 if (preg_match("/variable/i", get_class($this)))
1715 $this->prefix = "\$";
1716 elseif (preg_match("/ini_set/i", get_class($this)))
1717 $this->prefix = "ini_get: ";
1722 function _define($config_item_name, $default_value='', $description = '', $jscheck = '') {
1723 $this->_variable($config_item_name, $default_value, $description, $jscheck);
1727 global $HTTP_POST_VARS;
1728 if (isset($HTTP_POST_VARS[$this->config_item_name]))
1729 return $HTTP_POST_VARS[$this->config_item_name];
1731 return $this->default_value;
1734 function _config_format($value) {
1736 $v = $this->get_config_item_name();
1737 // handle arrays: a|b --> a['b']
1738 if (strpos($v, '|')) {
1739 list($a, $b) = explode('|', $v);
1740 $v = sprintf("%s['%s']", $a, $b);
1742 if (preg_match("/[\"']/", $value))
1743 $value = '"' . $value . '"';
1744 return sprintf("%s = \"%s\"", $v, $value);
1747 function get_config_item_name() {
1748 return $this->config_item_name;
1751 function get_config_item_id() {
1752 return str_replace('|', '-', $this->config_item_name);
1755 function get_config_item_header() {
1756 if (strchr($this->config_item_name,'|')) {
1757 list($var,$param) = explode('|',$this->config_item_name);
1758 return "<b>" . $this->prefix . $var . "['" . $param . "']</b><br />";
1760 elseif ($this->config_item_name[0] != '_')
1761 return "<b>" . $this->prefix . $this->config_item_name . "</b><br />";
1766 function _get_description() {
1767 return $this->description;
1770 function _get_config_line($posted_value) {
1771 return "\n" . $this->_config_format($posted_value);
1774 function get_config($posted_value) {
1775 $d = stripHtml($this->_get_description());
1776 $d = str_replace("\n", "\n; ", $d) . $this->_get_config_line($posted_value) ."\n";
1780 function get_instructions($title) {
1782 $i = "<h3>" . $title . "</h3>\n " . nl2p($this->_get_description()) . "\n";
1783 return "<tr>\n<td width=\"$tdwidth\" class=\"instructions\">\n" . $i . "</td>\n";
1786 function get_html() {
1787 $size = strlen($this->default_value) > 45 ? 90 : 50;
1788 return $this->get_config_item_header() .
1789 "<input type=\"text\" size=\"$50\" name=\"" . $this->get_config_item_name() . "\" value=\"" . htmlspecialchars($this->default_value) . "\" " .
1790 $this->jscheck . " />" . "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
1794 class unchangeable_variable
1796 function _config_format($value) {
1799 // function get_html() { return false; }
1800 function get_html() {
1801 return $this->get_config_item_header() .
1802 "<em>Not editable.</em>" .
1803 "<pre>" . $this->default_value."</pre>";
1805 function _get_config_line($posted_value) {
1806 if ($this->description)
1808 return "${n}".$this->default_value;
1810 function get_instructions($title) {
1812 $i = "<h3>" . $title . "</h3>\n " . nl2p($this->_get_description()) . "\n";
1813 // $i .= "<em>Not editable.</em><br />\n<pre>" . $this->default_value."</pre>";
1814 return '<tr><td width="100%" class="unchangeable-variable-top" colspan="2">'."\n".$i."</td></tr>\n"
1815 . '<tr style="border-top: none;"><td class="unchangeable-variable-left" width="'.$tdwidth.'"> </td>';
1819 class unchangeable_define
1820 extends unchangeable_variable {
1821 function _get_config_line($posted_value) {
1822 if ($this->description)
1825 $posted_value = $this->default_value;
1826 return "${n}".$this->_config_format($posted_value);
1828 function _config_format($value) {
1829 return sprintf("%s = \"%s\"", $this->get_config_item_name(), $value);
1832 class unchangeable_ini_set
1833 extends unchangeable_variable {
1834 function _config_format($value) {
1839 class _variable_selection
1842 global $HTTP_POST_VARS;
1843 if (!empty($HTTP_POST_VARS[$this->config_item_name]))
1844 return $HTTP_POST_VARS[$this->config_item_name];
1846 list($option, $label) = each($this->default_value);
1850 function get_html() {
1851 $output = $this->get_config_item_header();
1852 $output .= '<select name="' . $this->get_config_item_name() . "\">\n";
1853 /* The first option is the default */
1854 $values = $this->default_value;
1855 if (defined($this->get_config_item_name()))
1856 $this->default_value = constant($this->get_config_item_name());
1858 $this->default_value = null;
1860 foreach ($values as $option => $label) {
1861 if (!is_null($this->default_value) && $this->default_value === $option)
1862 $output .= " <option value=\"$option\" selected=\"selected\">$label</option>\n";
1864 $output .= " <option value=\"$option\">$label</option>\n";
1866 $output .= "</select>\n";
1874 function _config_format($value) {
1875 return sprintf("%s = \"%s\"", $this->get_config_item_name(), $value);
1877 function _get_config_line($posted_value) {
1878 if ($this->description)
1880 if ($posted_value == '')
1881 return "${n};" . $this->_config_format("");
1883 return "${n}" . $this->_config_format($posted_value);
1885 function get_html() {
1886 $size = strlen($this->default_value) > 45 ? 90 : 50;
1887 return $this->get_config_item_header()
1888 . "<input type=\"text\" size=\"$size\" name=\"" . htmlentities($this->get_config_item_name())
1889 . "\" value=\"" . htmlentities($this->default_value) . "\" {$this->jscheck} />"
1890 . "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
1894 class _define_commented
1896 function _get_config_line($posted_value) {
1897 if ($this->description)
1899 if ($posted_value == $this->default_value)
1900 return "${n};" . $this->_config_format($posted_value);
1901 elseif ($posted_value == '')
1902 return "${n};" . $this->_config_format("");
1904 return "${n}" . $this->_config_format($posted_value);
1909 * We don't use _optional anymore, because INI-style config's don't need that.
1910 * IniConfig.php does the optional logic now.
1911 * But we use _optional for config-default.ini options
1913 class _define_commented_optional
1914 extends _define_commented { }
1916 class _define_optional
1919 class _define_notempty
1921 function get_html() {
1922 $s = $this->get_config_item_header()
1923 . "<input type=\"text\" size=\"50\" name=\"" . $this->get_config_item_name()
1924 . "\" value=\"" . $this->default_value . "\" {$this->jscheck} />";
1925 if (empty($this->default_value))
1926 return $s . "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: red\">Cannot be empty.</p>";
1928 return $s . "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
1932 class _variable_commented
1934 function _get_config_line($posted_value) {
1935 if ($this->description)
1937 if ($posted_value == $this->default_value)
1938 return "${n};" . $this->_config_format($posted_value);
1939 elseif ($posted_value == '')
1940 return "${n};" . $this->_config_format("");
1942 return "${n}" . $this->_config_format($posted_value);
1946 class numeric_define
1949 function numeric_define($config_item_name, $default_value='', $description = '', $jscheck = '') {
1950 $this->_define($config_item_name, $default_value, $description, $jscheck);
1952 $this->jscheck = "onchange=\"validate_ereg('Sorry, \'%s\' is not an integer.', '^[-+]?[0-9]+$', '" . $this->get_config_item_name() . "', this);\"";
1954 function _config_format($value) {
1955 //return sprintf("define('%s', %s);", $this->get_config_item_name(), $value);
1956 return sprintf("%s = %s", $this->get_config_item_name(), $value);
1958 function _get_config_line($posted_value) {
1959 if ($this->description)
1961 if ($posted_value == '')
1962 return "${n};" . $this->_config_format('0');
1964 return "${n}" . $this->_config_format($posted_value);
1968 class numeric_define_optional
1969 extends numeric_define {}
1971 class numeric_define_commented
1972 extends numeric_define {
1973 function _get_config_line($posted_value) {
1974 if ($this->description)
1976 if ($posted_value == $this->default_value)
1977 return "${n};" . $this->_config_format($posted_value);
1978 elseif ($posted_value == '')
1979 return "${n};" . $this->_config_format('0');
1981 return "${n}" . $this->_config_format($posted_value);
1985 class _define_selection
1986 extends _variable_selection {
1987 function _config_format($value) {
1988 return sprintf("%s = %s", $this->get_config_item_name(), $value);
1990 function _get_config_line($posted_value) {
1991 return _define::_get_config_line($posted_value);
1993 function get_html() {
1994 return _variable_selection::get_html();
1998 class _define_selection_optional
1999 extends _define_selection { }
2001 class _variable_selection_optional
2002 extends _variable_selection { }
2004 class _define_selection_optional_commented
2005 extends _define_selection_optional {
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 _define_password
2021 function _define_password($config_item_name, $default_value='', $description = '', $jscheck = '') {
2022 if ($config_item_name == $default_value) $default_value = '';
2023 $this->_define($config_item_name, $default_value, $description, $jscheck);
2025 $this->jscheck = "onchange=\"validate_ereg('Sorry, \'%s\' cannot be empty.', '^.+$', '"
2026 . $this->get_config_item_name() . "', this);\"";
2028 function _get_config_line($posted_value) {
2029 if ($this->description)
2031 if ($posted_value == '') {
2032 $p = "${n};" . $this->_config_format("");
2033 $p .= "\n; If you used the passencrypt.php utility to encode the password";
2034 $p .= "\n; then uncomment this line:";
2035 $p .= "\n;ENCRYPTED_PASSWD = true";
2038 if (function_exists('crypt')) {
2039 $salt_length = max(CRYPT_SALT_LENGTH,
2043 16 * CRYPT_BLOWFISH);
2044 // generate an encrypted password
2045 $crypt_pass = crypt($posted_value, rand_ascii($salt_length));
2046 $p = "${n}" . $this->_config_format($crypt_pass);
2047 return $p . "\nENCRYPTED_PASSWD = true";
2049 $p = "${n}" . $this->_config_format($posted_value);
2050 $p .= "\n; Encrypted passwords cannot be used:";
2051 $p .= "\n; 'function crypt()' not available in this version of php";
2052 $p .= "\nENCRYPTED_PASSWD = false";
2057 function get_html() {
2058 return _variable_password::get_html();
2062 class _define_password_optional
2063 extends _define_password {
2065 function _define_password_optional($config_item_name, $default_value='', $description = '', $jscheck = '') {
2066 if ($config_item_name == $default_value) $default_value = '';
2067 if (!$jscheck) $this->jscheck = " ";
2068 $this->_define($config_item_name, $default_value, $description, $jscheck);
2071 function _get_config_line($posted_value) {
2072 if ($this->description)
2074 if ($posted_value == '') {
2075 return "${n};" . $this->_config_format("");
2077 return "${n}" . $this->_config_format($posted_value);
2080 function get_html() {
2081 $s = $this->get_config_item_header();
2082 // dont re-encrypt already encrypted passwords
2083 $value = $this->value();
2084 $encrypted = !empty($GLOBALS['properties']["Encrypted Passwords"]) and
2085 $GLOBALS['properties']["Encrypted Passwords"]->value();
2088 $s .= "<input type=\"". ($encrypted ? "text" : "password") . "\" name=\"" . $this->get_config_item_name()
2089 . "\" value=\"" . $value . "\" {$this->jscheck} />";
2094 class _define_password_commented_optional
2095 extends _define_password_optional { }
2097 class _variable_password
2099 function _variable_password($config_item_name, $default_value='', $description = '', $jscheck = '') {
2100 if ($config_item_name == $default_value) $default_value = '';
2101 $this->_define($config_item_name, $default_value, $description, $jscheck);
2103 $this->jscheck = "onchange=\"validate_ereg('Sorry, \'%s\' cannot be empty.', '^.+$', '" . $this->get_config_item_name() . "', this);\"";
2105 function get_html() {
2106 global $HTTP_POST_VARS, $HTTP_GET_VARS;
2107 $s = $this->get_config_item_header();
2108 if (isset($HTTP_POST_VARS['create']) or isset($HTTP_GET_VARS['create'])) {
2109 $new_password = random_good_password();
2110 $this->default_value = $new_password;
2111 $s .= "Created password: <strong>$new_password</strong><br /> <br />";
2113 // dont re-encrypt already encrypted passwords
2114 $value = $this->value();
2115 $encrypted = !empty($GLOBALS['properties']["Encrypted Passwords"]) and
2116 $GLOBALS['properties']["Encrypted Passwords"]->value();
2119 $s .= "<input type=\"". ($encrypted ? "text" : "password") . "\" name=\"" . $this->get_config_item_name()
2120 . "\" value=\"" . $value . "\" {$this->jscheck} />"
2121 . " <input type=\"submit\" name=\"create\" value=\"Create Random Password\" />";
2123 $s .= "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: red\">Cannot be empty.</p>";
2124 elseif (strlen($this->default_value) < 4)
2125 $s .= "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: red\">Must be longer than 4 chars.</p>";
2127 $s .= "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
2134 function _get_config_line($posted_value) {
2135 // split the phrase by any number of commas or space characters,
2136 // which include " ", \r, \t, \n and \f
2137 $list_values = preg_split("/[\s,]+/", $posted_value, -1, PREG_SPLIT_NO_EMPTY);
2139 $list_values = join("|", $list_values);
2140 return _variable::_get_config_line($list_values);
2142 function get_html() {
2143 $list_values = explode("|", $this->default_value);
2144 $rows = max(3, count($list_values) +1);
2145 $list_values = join("\n", $list_values);
2146 $ta = $this->get_config_item_header();
2147 $ta .= "<textarea cols=\"18\" rows=\"". $rows ."\" name=\"".$this->get_config_item_name()."\" {$this->jscheck}>";
2148 $ta .= $list_values . "</textarea>";
2149 $ta .= "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
2156 function _get_config_line($posted_value) {
2157 $list_values = preg_split("/[\s,]+/", $posted_value, -1, PREG_SPLIT_NO_EMPTY);
2159 $list_values = join("|", $list_values);
2160 return _variable::_get_config_line($list_values);
2162 function get_html() {
2163 $list_values = explode("|", $this->default_value);
2164 $rows = max(3, count($list_values) +1);
2166 $list_values = join("\n", $list_values);
2167 $ta = $this->get_config_item_header();
2168 $ta .= "<textarea cols=\"18\" rows=\"". $rows ."\" name=\"".$this->get_config_item_name()."\" {$this->jscheck}>";
2169 $ta .= $list_values . "</textarea>";
2170 $ta .= "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
2175 class array_variable
2177 function _config_format($value) {
2178 return sprintf("%s = \"%s\"", $this->get_config_item_name(),
2179 is_array($value) ? join(':', $value) : $value);
2181 function _get_config_line($posted_value) {
2182 // split the phrase by any number of commas or space characters,
2183 // which include " ", \r, \t, \n and \f
2184 $list_values = preg_split("/[\s,]+/", $posted_value, -1, PREG_SPLIT_NO_EMPTY);
2185 if (!empty($list_values)) {
2186 $list_values = "'".join("', '", $list_values)."'";
2187 return "\n" . $this->_config_format($list_values);
2189 return "\n;" . $this->_config_format('');
2191 function get_html() {
2192 if (is_array($this->default_value))
2193 $list_values = join("\n", $this->default_value);
2195 $list_values = $this->default_value;
2196 $rows = max(3, count($this->default_value) +1);
2197 $ta = $this->get_config_item_header();
2198 $ta .= "<textarea cols=\"18\" rows=\"". $rows ."\" name=\"".$this->get_config_item_name()."\" {$this->jscheck}>";
2199 $ta .= $list_values . "</textarea>";
2200 $ta .= "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
2207 function _config_format($value) {
2208 return sprintf("%s = \"%s\"", $this->get_config_item_name(),
2209 is_array($value) ? join(' : ', $value) : $value);
2211 function _get_config_line($posted_value) {
2212 // split the phrase by any number of commas or space characters,
2213 // which include " ", \r, \t, \n and \f
2214 $list_values = preg_split("/[\s,:]+/", $posted_value, -1, PREG_SPLIT_NO_EMPTY);
2215 if (!empty($list_values)) {
2216 $list_values = join(" : ", $list_values);
2217 return "\n" . $this->_config_format($list_values);
2219 return "\n;" . $this->_config_format('');
2221 function get_html () {
2222 if (!$this->default_value)
2223 $this->default_value = array();
2224 elseif (is_string($this->default_value))
2225 $this->default_value = preg_split("/[\s,:]+/", $this->default_value, -1, PREG_SPLIT_NO_EMPTY);
2226 $list_values = join(" : \n", $this->default_value);
2227 $rows = max(3, count($this->default_value) + 1);
2228 $ta = $this->get_config_item_header();
2229 $ta .= "<textarea cols=\"18\" rows=\"". $rows ."\" name=\"".$this->get_config_item_name()."\" {$this->jscheck}>";
2230 $ta .= $list_values . "</textarea>";
2231 $ta .= "<p id=\"" . $this->get_config_item_id() . "\" style=\"color: green\">Input accepted.</p>";
2236 class boolean_define
2239 // adds ->values property, instead of ->default_value
2240 function boolean_define($config_item_name, $values = false, $description = '', $jscheck = '') {
2241 $this->config_item_name = $config_item_name;
2243 $description = text_from_dist($config_item_name);
2244 $this->description = $description;
2245 // TESTME: get boolean default value from config-default.ini
2246 if (defined($config_item_name))
2247 $this->default_value = constant($config_item_name); // ignore given default value
2248 elseif (is_array($values))
2249 list($this->default_value,$dummy) = $values[0];
2251 $values = array('false' => "Disabled",
2252 'true' => "Enabled");
2253 $this->values = $values;
2254 $this->jscheck = $jscheck;
2257 function _get_config_line($posted_value) {
2258 if ($this->description)
2260 return "${n}" . $this->_config_format($posted_value);
2262 function _config_format($value) {
2263 if (strtolower(trim($value)) == 'false')
2265 return sprintf("%s = %s", $this->get_config_item_name(),
2266 (bool)$value ? 'true' : 'false');
2268 //TODO: radiobuttons, no list
2269 function get_html() {
2270 $output = $this->get_config_item_header();
2271 $name = $this->get_config_item_name();
2272 $output .= '<select name="' . $name . "\" {$this->jscheck}>\n";
2273 $values = $this->values;
2274 $default_value = $this->default_value ? 'true' : 'false';
2275 /* There can usually only be two options, there can be
2276 * three options in the case of a boolean_define_commented_optional */
2277 while (list($option, $label) = each($values)) {
2278 if (!is_null($this->default_value) and $option === $default_value)
2279 $output .= " <option value=\"$option\" selected=\"selected\">$label</option>\n";
2281 $output .= " <option value=\"$option\">$label</option>\n";
2283 $output .= "</select>\n";
2288 class boolean_define_optional
2289 extends boolean_define {}
2291 class boolean_define_commented
2292 extends boolean_define {
2293 function _get_config_line($posted_value) {
2294 if ($this->description)
2296 list($default_value, $label) = each($this->default_value);
2297 if ($posted_value == $default_value)
2298 return "${n};" . $this->_config_format($posted_value);
2299 elseif ($posted_value == '')
2300 return "${n};" . $this->_config_format('false');
2302 return "${n}" . $this->_config_format($posted_value);
2306 class boolean_define_commented_optional
2307 extends boolean_define_commented {}
2311 function value () { return; }
2312 function get_config($posted_value) {
2313 $d = stripHtml($this->_get_description());
2315 return "\n".$SEPARATOR . str_replace("\n", "\n; ", $d) ."\n".$this->default_value;
2317 function get_instructions($title) {
2318 $id = preg_replace("/\W/","",$this->config_item_name);
2319 $group_name = preg_replace("/\W/","",$title);
2320 $i = "<tr class=\"header\" id=\"$id\">\n<td class=\"part\" width=\"100%\" colspan=\"2\" bgcolor=\"#eeeeee\">\n";
2321 $i .= "<h2>" . $title . "</h2>\n " . nl2p($this->_get_description()) ."\n";
2322 $i .= "<p><a href=\"javascript:toggle_group('$id')\" id=\"{$id}_text\">Hide options.</a></p>";
2323 return $i ."</td>\n";
2325 function get_html() {
2330 // html utility functions
2331 function nl2p($text) {
2332 preg_match_all("@\s*(<pre>.*?</pre>|<dl>.*?</dl>|.*?(?=\n\n|<pre>|<dl>|$))@s",
2333 $text, $m, PREG_PATTERN_ORDER);
2336 foreach ($m[1] as $par) {
2337 if (!($par = trim($par)))
2339 if (!preg_match('/^<(pre|dl)>/', $par))
2340 $par = "<p>$par</p>";
2346 function text_from_dist($var) {
2347 static $distfile = 0;
2351 $sep = (substr(PHP_OS,0,3) == 'WIN' ? '\\' : '/');
2352 $distfile = dirname(__FILE__) . $sep . "config" . $sep . "config-dist.ini";
2353 $f = fopen($distfile, "r");
2355 if ($var == '_MAGIC_CLOSE_FILE') {
2359 // if all vars would be in natural order as in the config-dist this would not be needed.
2364 if (preg_match("/^; \w/", $s)) {
2365 $par .= (substr($s,2) . " ");
2366 } elseif (preg_match("/^;\s*$/", $s)) {
2369 if (preg_match("/^;?".preg_quote($var)."\s*=/", $s))
2371 if (preg_match("/^\s*$/", $s)) // new paragraph
2377 function stripHtml($text) {
2378 $d = str_replace("<pre>", "", $text);
2379 $d = str_replace("</pre>", "", $d);
2380 $d = str_replace("<dl>", "", $d);
2381 $d = str_replace("</dl>", "", $d);
2382 $d = str_replace("<dt>", "", $d);
2383 $d = str_replace("</dt>", "", $d);
2384 $d = str_replace("<dd>", "", $d);
2385 $d = str_replace("</dd>", "", $d);
2386 $d = str_replace("<p>", "", $d);
2387 $d = str_replace("</p>", "", $d);
2388 //restore html entities into characters
2389 // http://www.php.net/manual/en/function.htmlentities.php
2390 $trans = get_html_translation_table (HTML_ENTITIES);
2391 $trans = array_flip ($trans);
2392 $d = strtr($d, $trans);
2396 include_once(dirname(__FILE__)."/lib/stdlib.php");
2399 // Function to create better user passwords (much larger keyspace),
2400 // suitable for user passwords.
2401 // Sequence of random ASCII numbers, letters and some special chars.
2402 // Note: There exist other algorithms for easy-to-remember passwords.
2403 function random_good_password ($minlength = 5, $maxlength = 8) {
2405 // assume ASCII ordering (not valid on EBCDIC systems!)
2406 $valid_chars = "!#%&+-.0123456789=@ABCDEFGHIJKLMNOPQRSTUVWXYZ_abcdefghijklmnopqrstuvwxyz";
2407 $start = ord($valid_chars);
2408 $end = ord(substr($valid_chars,-1));
2410 if (function_exists('mt_rand')) // mersenne twister
2411 $length = mt_rand($minlength, $maxlength);
2412 else // the usually bad glibc rand()
2413 $length = rand($minlength, $maxlength);
2414 while ($length > 0) {
2415 if (function_exists('mt_rand'))
2416 $newchar = mt_rand($start, $end);
2418 $newchar = rand($start, $end);
2419 if (! strrpos($valid_chars,$newchar) ) continue; // skip holes
2420 $newpass .= sprintf("%c", $newchar);
2427 function printArray($a) {
2428 echo "<hr />\n<pre>\n";
2430 echo "\n</pre>\n<hr />\n";
2433 // end of class definitions
2434 /////////////////////////////
2435 // begin auto generation code
2437 if (!function_exists('is_a')) {
2438 function is_a($object, $class) {
2439 $class = strtolower($class);
2440 return (get_class($object) == $class) or is_subclass_of($object, $class);
2445 if (!empty($HTTP_POST_VARS['action'])
2446 and $HTTP_POST_VARS['action'] == 'make_config'
2447 and !empty($HTTP_POST_VARS['ADMIN_USER'])
2448 and !empty($HTTP_POST_VARS['ADMIN_PASSWD'])
2452 $timestamp = date ('dS of F, Y H:i:s');
2455 ; This is a local configuration file for PhpWiki.
2456 ; It was automatically generated by the configurator script
2457 ; on the $timestamp.
2462 $posted = $GLOBALS['HTTP_POST_VARS'];
2463 /*if (defined('DEBUG'))
2464 printArray($GLOBALS['HTTP_POST_VARS']);*/
2466 foreach ($properties as $option_name => $a) {
2467 $posted_value = stripslashes($posted[$a->config_item_name]);
2468 $config .= $properties[$option_name]->get_config($posted_value);
2473 if (is_writable($fs_config_file)) {
2474 // We first check if the config-file exists.
2475 if (file_exists($fs_config_file)) {
2476 // We make a backup copy of the file
2477 $new_filename = preg_replace('/\.ini$/', '-' . time() . '.ini', $fs_config_file);
2478 if (@copy($fs_config_file, $new_filename)) {
2479 $fp = @fopen($fs_config_file, 'w');
2482 $fp = @fopen($fs_config_file, 'w');
2490 fputs($fp, utf8_encode($config));
2492 echo "<p>The configuration was written to <code><b>$config_file</b></code>.</p>\n";
2493 if ($new_filename) {
2494 echo "<p>A backup was made to <code><b>$new_filename</b></code>.</p>\n";
2496 ; //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";
2499 echo "<p>The configuration file could <b>not</b> be written.<br />\n",
2500 " You should copy the above configuration to a file, ",
2501 "and manually save it as <code><b>config/config.ini</b></code>.</p>\n";
2504 echo "<hr />\n<p>Here's the configuration file based on your answers:</p>\n";
2505 echo "<form method=\"get\" action=\"", $configurator, "\">\n";
2506 echo "<textarea id='config-output' readonly='readonly' style='width:100%;' rows='30' cols='100'>\n";
2507 echo htmlentities($config, ENT_COMPAT, "UTF-8");
2508 echo "</textarea></form>\n";
2511 echo "<p>To make any corrections, <a href=\"configurator.php\">edit the settings again</a>.</p>\n";
2513 } else { // first time or create password
2514 $posted = $GLOBALS['HTTP_POST_VARS'];
2515 // No action has been specified - we make a form.
2517 if (!empty($GLOBALS['HTTP_GET_VARS']['start_debug']))
2518 $configurator .= ("?start_debug=" . $GLOBALS['HTTP_GET_VARS']['start_debug']);
2520 <form action="',$configurator,'" method="post">
2521 <input type="hidden" name="action" value="make_config" />
2522 <table cellpadding="4" cellspacing="0">
2525 while (list($property, $obj) = each($properties)) {
2526 echo $obj->get_instructions($property);
2527 if ($h = $obj->get_html()) {
2528 if (defined('DEBUG') and DEBUG) $h = get_class($obj) . "<br />\n" . $h;
2529 echo "<td>".$h."</td>\n";
2536 <p><input type="submit" id="submit" value="Save ',$config_file,'" /> <input type="reset" value="Clear" /></p>