Added better example how to use include_path for various platforms (and also multi...

[SourceForge/phpwiki.git] / index.php

<?php // -*-php-*-\r
\r
/*\r
Copyright 1999, 2000, 2001, 2002 $ThePhpWikiProgrammingTeam = array(\r
"Steve Wainstead", "Clifford A. Adams", "Lawrence Akka", \r
"Scott R. Anderson", "Jon Åslund", "Neil Brown", "Jeff Dairiki",\r
"Stéphane Gourichon", "Jan Hidders", "Arno Hollosi", "John Jorgensen",\r
"Antti Kaihola", "Jeremie Kass", "Carsten Klapp", "Marco Milanesi",\r
"Grant Morgan", "Jan Nieuwenhuizen", "Aredridel Niothke", \r
"Pablo Roca Rozas", "Sandino Araico Sánchez", "Joel Uckelman", \r
"Reini Urban", "Tim Voght");\r
\r
This file is part of PhpWiki.\r
\r
PhpWiki is free software; you can redistribute it and/or modify\r
it under the terms of the GNU General Public License as published by\r
the Free Software Foundation; either version 2 of the License, or\r
(at your option) any later version.\r
\r
PhpWiki is distributed in the hope that it will be useful,\r
but WITHOUT ANY WARRANTY; without even the implied warranty of\r
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
GNU General Public License for more details.\r
\r
You should have received a copy of the GNU General Public License\r
along with PhpWiki; if not, write to the Free Software\r
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
*/\r
\r
\r
/////////////////////////////////////////////////////////////////////\r
/*\r
  This is the starting file for PhpWiki. All this file does is set\r
  configuration options, and at the end of the file it includes() the\r
  file lib/main.php, where the real action begins.\r
\r
  This file is divided into six parts: Parts Zero, One, Two, Three,\r
  Four and Five. Each one has different configuration settings you can\r
  change; in all cases the default should work on your system,\r
  however, we recommend you tailor things to your particular setting.\r
*/\r
\r
/////////////////////////////////////////////////////////////////////\r
// Part Zero: If PHP needs help in finding where you installed the\r
//   rest of the PhpWiki code, you can set the include_path here.\r
\r
// NOTE: phpwiki uses the PEAR library of php code for SQL database\r
// access. Your PHP is probably already configured to set\r
// include_path so that PHP can find the pear code. If not (or if you\r
// change include_path here) make sure you include the path to the\r
// PEAR code in include_path. (To find the PEAR code on your system,\r
// search for a file named 'PEAR.php'. Some common locations are:\r
//\r
//   Unixish systems:\r
//     /usr/share/php\r
//     /usr/local/share/php\r
//   Mac OS X:\r
//     /System/Library/PHP\r
//\r
// The above examples are already included by PhpWiki. You shouldn't\r
// have to change this unless you see a WikiFatalError:\r
//\r
//     lib/FileFinder.php:82: Fatal[256]: DB.php: file not found\r
//\r
// Define the include path for this wiki: pear plus the phpwiki path\r
// $include_path = '.:/Apache/php/pear:/prog/php/phpwiki';\r
//\r
// // Windows needs ';' as path delimiter. cygwin, mac and unix ':'\r
// if (substr(PHP_OS,0,3) == 'WIN') {\r
//     $include_path = implode(';',explode(':',$include_path));\r
// } elseif (substr(PHP_OS,0,6) == 'CYGWIN') {\r
//     $include_path = '.:/usr/local/lib/php/pear:/usr/src/php/phpwiki';\r
// } else {\r
//     ;\r
// }\r
//ini_set('include_path', $include_path);\r
\r
/////////////////////////////////////////////////////////////////////\r
// Part Null: Don't touch this!\r
\r
define ('PHPWIKI_VERSION', '1.3.2-jeffs-hacks');\r
require "lib/prepend.php";\r
rcs_id('$Id: index.php,v 1.70 2002-01-20 18:19:25 rurban Exp $');\r
\r
/////////////////////////////////////////////////////////////////////\r
//\r
// Part One:\r
// Authentication and security settings:\r
// \r
/////////////////////////////////////////////////////////////////////\r
\r
// The name of your wiki.\r
// This is used to generate a keywords meta tag in the HTML templates,\r
// in bookmark titles for any bookmarks made to pages in your wiki,\r
// and during RSS generation for the <title> of the RSS channel.\r
//define('WIKI_NAME', 'PhpWiki');\r
\r
// If set, we will perform reverse dns lookups to try to convert the\r
// users IP number to a host name, even if the http server didn't do\r
// it for us.\r
define('ENABLE_REVERSE_DNS', true);\r
\r
// Username and password of administrator.\r
// Set these to your preferences. For heaven's sake\r
// pick a good password!\r
define('ADMIN_USER', "");\r
define('ADMIN_PASSWD', "");\r
\r
// If true, only the admin user can make zip dumps, else zip dumps\r
// require no authentication.\r
define('ZIPDUMP_AUTH', false);\r
\r
// This setting determines the type of page dumps. Must be one of\r
// "quoted-printable" or "binary".\r
$pagedump_format = "quoted-printable";\r
\r
// The maximum file upload size.\r
define('MAX_UPLOAD_SIZE', 16 * 1024 * 1024);\r
\r
// If the last edit is older than MINOR_EDIT_TIMEOUT seconds, the\r
// default state for the "minor edit" checkbox on the edit page form\r
// will be off.\r
define("MINOR_EDIT_TIMEOUT", 7 * 24 * 3600);\r
\r
// Actions listed in this array will not be allowed.\r
//$DisabledActions = array('dumpserial', 'loadfile');\r
\r
// PhpWiki can generate an access_log (in "NCSA combined log" format)\r
// for you. If you want one, define this to the name of the log file.\r
//define('ACCESS_LOG', '/tmp/wiki_access_log');\r
\r
\r
// If ALLOW_BOGO_LOGIN is true, users are allowed to login (with\r
// any/no password) using any userid which: 1) is not the ADMIN_USER,\r
// 2) is a valid WikiWord (matches $WikiNameRegexp.)\r
define('ALLOW_BOGO_LOGIN', true);\r
\r
// The login code now uses PHP's session support. Usually, the default\r
// configuration of PHP is to store the session state information in\r
// /tmp. That probably will work fine, but fails e.g. on clustered\r
// servers where each server has their own distinct /tmp (this is the\r
// case on SourceForge's project web server.) You can specify an\r
// alternate directory in which to store state information like so\r
// (whatever user your httpd runs as must have read/write permission\r
// in this directory):\r
\r
//ini_set('session.save_path', 'some_other_directory');\r
\r
\r
/////////////////////////////////////////////////////////////////////\r
//\r
// Part Two:\r
// Database Selection\r
//\r
/////////////////////////////////////////////////////////////////////\r
\r
//\r
// This array holds the parameters which select the database to use.\r
//\r
// Not all of these parameters are used by any particular DB backend.\r
//\r
$DBParams = array(\r
   // Select the database type:\r
   //'dbtype' => 'SQL',\r
   'dbtype'   => 'dba',\r
   \r
   // For SQL based backends, specify the database as a DSN\r
   // The most general form of a DSN looks like:\r
   //\r
   //   phptype(dbsyntax)://username:password@protocol+hostspec/database\r
   //\r
   // For a MySQL database, the following should work:\r
   //\r
   //   mysql://user:password@host/databasename\r
   //\r
   // FIXME: My version Pear::DB seems to be broken enough that there\r
   //        is no way to connect to a mysql server over a socket right now.\r
   //'dsn' => 'mysql://guest@:/var/lib/mysql/mysql.sock/test',\r
   //'dsn' => 'mysql://guest@localhost/test',\r
   //'dsn' => 'pgsql://localhost/test',\r
   \r
   // Used by all DB types:\r
\r
   // prefix for filenames or table names\r
   /* \r
    * currently you MUST EDIT THE SQL file too (in the schemas/\r
    * directory because we aren't doing on the fly sql generation\r
    * during the installation.\r
   */\r
   //'prefix' => 'phpwiki_',\r
   \r
   // Used by 'dba'\r
   'directory'     => "/tmp",\r
   'dba_handler'   => 'gdbm',   // Either of 'gdbm' or 'db2' work great for me.\r
   //'dba_handler' => 'db2',\r
   //'dba_handler' => 'db3',    // doesn't work at all for me....\r
   'timeout'   => 20,\r
   //'timeout' => 5\r
);\r
\r
/////////////////////////////////////////////////////////////////////\r
//\r
// The next section controls how many old revisions of each page are\r
// kept in the database.\r
//\r
// There are two basic classes of revisions: major and minor. Which\r
// class a revision belongs in is determined by whether the author\r
// checked the "this is a minor revision" checkbox when they saved the\r
// page.\r
// \r
// There is, additionally, a third class of revisions: author\r
// revisions. The most recent non-mergable revision from each distinct\r
// author is and author revision.\r
//\r
// The expiry parameters for each of those three classes of revisions\r
// can be adjusted seperately. For each class there are five\r
// parameters (usually, only two or three of the five are actually\r
// set) which control how long those revisions are kept in the\r
// database.\r
//\r
//   max_keep: If set, this specifies an absolute maximum for the\r
//             number of archived revisions of that class. This is\r
//             meant to be used as a safety cap when a non-zero\r
//             min_age is specified. It should be set relatively high,\r
//             and it's purpose is to prevent malicious or accidental\r
//             database overflow due to someone causing an\r
//             unreasonable number of edits in a short period of time.\r
//\r
//   min_age:  Revisions younger than this (based upon the supplanted\r
//             date) will be kept unless max_keep is exceeded. The age\r
//             should be specified in days. It should be a\r
//             non-negative, real number,\r
//\r
//   min_keep: At least this many revisions will be kept.\r
//\r
//   keep:     No more than this many revisions will be kept.\r
//\r
//   max_age:  No revision older than this age will be kept.\r
//\r
// Supplanted date: Revisions are timestamped at the instant that they\r
// cease being the current revision. Revision age is computed using\r
// this timestamp, not the edit time of the page.\r
//\r
// Merging: When a minor revision is deleted, if the preceding\r
// revision is by the same author, the minor revision is merged with\r
// the preceding revision before it is deleted. Essentially: this\r
// replaces the content (and supplanted timestamp) of the previous\r
// revision with the content after the merged minor edit, the rest of\r
// the page metadata for the preceding version (summary, mtime, ...)\r
// is not changed.\r
//\r
// Keep up to 8 major edits, but keep them no longer than a month.\r
$ExpireParams['major'] = array('max_age' => 32,\r
                               'keep'    => 8);\r
// Keep up to 4 minor edits, but keep them no longer than a week.\r
$ExpireParams['minor'] = array('max_age' => 7,\r
                               'keep'    => 4);\r
// Keep the latest contributions of the last 8 authors up to a year.\r
// Additionally, (in the case of a particularly active page) try to\r
// keep the latest contributions of all authors in the last week (even\r
// if there are more than eight of them,) but in no case keep more\r
// than twenty unique author revisions.\r
$ExpireParams['author'] = array('max_age'  => 365,\r
                                'keep'     => 8,\r
                                'min_age'  => 7,\r
                                'max_keep' => 20);\r
\r
/////////////////////////////////////////////////////////////////////\r
// \r
// Part Three:\r
// Page appearance and layout\r
//\r
/////////////////////////////////////////////////////////////////////\r
\r
/* THEME\r
 *\r
 * Most of the page appearance is controlled by files in the theme\r
 * subdirectory.\r
 *\r
 * There are a number of pre-defined themes shipped with PhpWiki.\r
 * Or you may create your own (e.g. by copying and then modifying one of\r
 * stock themes.)\r
 *\r
 * Pick one.\r
 */\r
//define('THEME', 'default');\r
//define('THEME', 'Hawaiian');\r
//define('THEME', 'MacOSX');\r
//define('THEME', 'Portland');\r
//define('THEME', 'WikiTrek');\r
\r
// Select a valid charset name to be inserted into the xml/html pages,\r
// and to reference links to the stylesheets (css). For more info see:\r
// <http://www.iana.org/assignments/character-sets>. Note that PhpWiki\r
// has been extensively tested only with the latin1 (iso-8859-1)\r
// character set.\r
//\r
// If you change the default from iso-8859-1 PhpWiki may not work\r
// properly and it will require code modifications. However, character\r
// sets similar to iso-8859-1 may work with little or no modification\r
// depending on your setup. The database must also support the same\r
// charset, and of course the same is true for the web browser. (Some\r
// work is in progress hopefully to allow more flexibility in this\r
// area in the future).\r
define("CHARSET", "iso-8859-1");\r
\r
// Select your language/locale - default language is "C" for English.\r
// Other languages available:\r
// English "C"  (English    - HomePage)\r
// Dutch   "nl" (Nederlands - ThuisPagina)\r
// Spanish "es" (Español    - PáginaPrincipal)\r
// French  "fr" (Français   - Accueil)\r
// German  "de" (Deutsch    - StartSeite)\r
// Swedish "sv" (Svenska    - Framsida)\r
// Italian "it" (Italiano   - PaginaPrincipale)\r
//\r
// If you set $LANG to the empty string, your systems default language\r
// (as determined by the applicable environment variables) will be\r
// used.\r
//\r
// Note that on some systems, apprently using these short forms for\r
// the locale won't work. On my home system 'LANG=de' won't result in\r
// german pages. Somehow the system must recognize the locale as a\r
// valid locale before gettext() will work, i.e., use 'de_DE',\r
// 'nl_NL'.\r
$LANG='C';\r
//$LANG='nl_NL';\r
\r
// Setting the LANG environment variable (accomplished above) may or\r
// may not be sufficient to cause PhpWiki to produce dates in your\r
// native language. (It depends on the configuration of the operating\r
// system on your http server.)  The problem is that, e.g. 'de' is\r
// often not a valid locale.\r
//\r
// A standard locale name is typically of  the  form\r
// language[_territory][.codeset][@modifier],  where  language is\r
// an ISO 639 language code, territory is an ISO 3166 country code,\r
// and codeset  is  a  character  set or encoding identifier like\r
// ISO-8859-1 or UTF-8.\r
//\r
// You can tailor the locale used for time and date formatting by\r
// setting the LC_TIME environment variable. You'll have to experiment\r
// to find the correct setting:\r
//putenv('LC_TIME=de_DE');\r
\r
\r
/* WIKI_PGSRC -- specifies the source for the initial page contents of\r
 * the Wiki. The setting of WIKI_PGSRC only has effect when the wiki is\r
 * accessed for the first time (or after clearing the database.)\r
 * WIKI_PGSRC can either name a directory or a zip file. In either case\r
 * WIKI_PGSRC is scanned for files -- one file per page.\r
 */\r
define('WIKI_PGSRC', "pgsrc"); // Default (old) behavior.\r
//define('WIKI_PGSRC', 'wiki.zip'); // New style.\r
//define('WIKI_PGSRC', '../../../Logs/Hamwiki/hamwiki-20010830.zip'); // New style.\r
\r
/*\r
 * DEFAULT_WIKI_PGSRC is only used when the language is *not* the\r
 * default (English) and when reading from a directory: in that case\r
 * some English pages are inserted into the wiki as well.\r
 * DEFAULT_WIKI_PGSRC defines where the English pages reside.\r
 */\r
// FIXME: is this really needed?  Can't we just copy these pages into\r
// the localized pgsrc?\r
define('DEFAULT_WIKI_PGSRC', "pgsrc");\r
// These are the pages which will get loaded from DEFAULT_WIKI_PGSRC.   \r
$GenericPages = array("ReleaseNotes", "SteveWainstead", "TestPage");\r
\r
/////////////////////////////////////////////////////////////////////\r
//\r
// Part four:\r
// Mark-up options.\r
// \r
/////////////////////////////////////////////////////////////////////\r
\r
// allowed protocols for links - be careful not to allow "javascript:"\r
// URL of these types will be automatically linked.\r
// within a named link [name|uri] one more protocol is defined: phpwiki\r
$AllowedProtocols = "http|https|mailto|ftp|news|nntp|ssh|gopher";\r
\r
// URLs ending with the following extension should be inlined as images\r
$InlineImages = "png|jpg|gif|tiff|tif";\r
\r
// Perl regexp for WikiNames ("bumpy words")\r
// (?<!..) & (?!...) used instead of '\b' because \b matches '_' as well\r
$WikiNameRegexp = "(?<![[:alnum:]])([[:upper:]][[:lower:]]+){2,}(?![[:alnum:]])";\r
\r
// InterWiki linking -- wiki-style links to other wikis on the web\r
//\r
// Intermap file for InterWikiLinks -- define other wikis there\r
// Leave this undefined to disable InterWiki linking.\r
define('INTERWIKI_MAP_FILE', "lib/interwiki.map");\r
\r
\r
/////////////////////////////////////////////////////////////////////\r
//\r
// Part five:\r
// URL options -- you can probably skip this section.\r
//\r
/////////////////////////////////////////////////////////////////////\r
/******************************************************************\r
 *\r
 * The following section contains settings which you can use to tailor\r
 * the URLs which PhpWiki generates.\r
 *\r
 * Any of these parameters which are left undefined will be deduced\r
 * automatically. You need only set them explicitly if the\r
 * auto-detected values prove to be incorrect.\r
 *\r
 * In most cases the auto-detected values should work fine, so\r
 * hopefully you don't need to mess with this section.\r
 *\r
 ******************************************************************/\r
\r
/*\r
 * Canonical name and httpd port of the server on which this PhpWiki\r
 * resides.\r
 */\r
//define('SERVER_NAME', 'some.host.com');\r
//define('SERVER_PORT', 80);\r
\r
/*\r
 * Relative URL (from the server root) of the PhpWiki\r
 * script.\r
 */\r
//define('SCRIPT_NAME', '/some/where/index.php');\r
\r
/*\r
 * URL of the PhpWiki install directory.  (You only need to set this\r
 * if you've moved index.php out of the install directory.)  This can\r
 * be either a relative URL (from the directory where the top-level\r
 * PhpWiki script is) or an absolute one.\r
 */\r
//define('DATA_PATH', '/some/where/phpwiki');\r
\r
/*\r
 * Path to the PhpWiki install directory.  This is the local\r
 * filesystem counterpart to DATA_PATH.  (If you have to set\r
 * DATA_PATH, your probably have to set this as well.)  This can be\r
 * either an absolute path, or a relative path interpreted from the\r
 * directory where the top-level PhpWiki script (normally index.php)\r
 * resides.\r
 */\r
//define('PHPWIKI_DIR', '/htdocs/some/where/phpwiki');\r
\r
\r
/*\r
 * Define to 'true' to use PATH_INFO to pass the pagename's.\r
 * e.g. http://www.some.where/index.php/HomePage instead\r
 * of http://www.some.where/index.php?pagename=HomePage\r
 * FIXME: more docs (maybe in README).\r
 */\r
//define('USE_PATH_INFO', false);\r
\r
/*\r
 * VIRTUAL_PATH is the canonical URL path under which your your wiki\r
 * appears. Normally this is the same as dirname(SCRIPT_NAME), however\r
 * using, e.g. apaches mod_actions (or mod_rewrite), you can make it\r
 * something different.\r
 *\r
 * If you do this, you should set VIRTUAL_PATH here.\r
 *\r
 * E.g. your phpwiki might be installed at at /scripts/phpwiki/index.php,\r
 * but  * you've made it accessible through eg. /wiki/HomePage.\r
 *\r
 * One way to do this is to create a directory named 'wiki' in your\r
 * server root. The directory contains only one file: an .htaccess\r
 * file which reads something like:\r
 *\r
 *    Action x-phpwiki-page /scripts/phpwiki/index.php\r
 *    SetHandler x-phpwiki-page\r
 *    DirectoryIndex /scripts/phpwiki/index.php\r
 *\r
 * In that case you should set VIRTUAL_PATH to '/wiki'.\r
 *\r
 * (VIRTUAL_PATH is only used if USE_PATH_INFO is true.)\r
 */\r
//define('VIRTUAL_PATH', '/SomeWiki');\r
\r
\r
////////////////////////////////////////////////////////////////\r
// Okay... fire up the code:\r
////////////////////////////////////////////////////////////////\r
\r
include "lib/main.php";\r
\r
// (c-file-style: "gnu")\r
// Local Variables:\r
// mode: php\r
// tab-width: 8\r
// c-basic-offset: 4\r
// c-hanging-comment-ender-p: nil\r
// indent-tabs-mode: nil\r
// End:   \r
?>\r