Configuration for PhpWiki

NO_CACHE

This is roughly the old (pre 1.3.4) behaviour. PhpWiki will instruct proxies and browsers never to cache PhpWiki output.

STRICT

Cached pages will be invalidated whenever the database global timestamp changes. This should behave just like NONE (modulo bugs in PhpWiki and your proxies and browsers), except that things will be slightly more efficient.

LOOSE

Cached pages will be invalidated whenever they are edited, or, if the pages include plugins, when the plugin output could concievably have changed.

Behavior should be much like STRICT, except that sometimes wikilinks will show up as undefined (with the question mark) when in fact they refer to (recently) created pages. (Hitting your browsers reload or perhaps shift-reload button should fix the problem.)

ALLOW_STALE

Proxies and browsers will be allowed to used stale pages. (The timeout for stale pages is controlled by CACHE_CONTROL_MAX_AGE.)

This setting will result in quirky behavior. When you edit a page your changes may not show up until you shift-reload the page, etc...

This setting is generally not advisable, however it may be useful in certain cases (e.g. if your wiki gets lots of page views, and few edits by knowledgable people who won't freak over the quirks.)

  phptype(dbsyntax)://username:password@protocol+hostspec/database?option=value

   mysql://user:password@host/databasename

   mysql://user:password@unix(/path/to/socket)/databasename

  DATABASE_DSN = mysql://guest@:/var/lib/mysql/mysql.sock/phpwiki
  DATABASE_DSN = mysql://guest@localhost/phpwiki
  DATABASE_DSN = pgsql://localhost/user_phpwiki

  unix(/var/lib/mysql/mysql.sock)

max_keep:

If set, this specifies an absolute maximum for the number of archived revisions of that class. This is meant to be used as a safety cap when a non-zero min_age is specified. It should be set relatively high, and it's purpose is to prevent malicious or accidental database overflow due to someone causing an unreasonable number of edits in a short period of time.

min_age:

Revisions younger than this (based upon the supplanted date) will be kept unless max_keep is exceeded. The age should be specified in days. It should be a non-negative, real number,

min_keep:

At least this many revisions will be kept.

keep:

No more than this many revisions will be kept.

max_age:

No revision older than this age will be kept.

BogoLogin

WikiWord username, with no *actual* password checking, although the user will still have to enter one.

PersonalPage

Store passwords in the users homepage metadata (simple)

Db

Use DBAUTH_AUTH_* (see below) with PearDB or ADODB only.

LDAP

Authenticate against LDAP_AUTH_HOST with LDAP_BASE_DN.

IMAP

Authenticate against IMAP_AUTH_HOST (email account)

POP3

Authenticate against POP3_AUTH_HOST (email account)

Session

Get username and level from a PHP session variable. (e.g. for FusionForge)

File

Store username:crypted-passwords in .htaccess like files. Use Apache's htpasswd to manage this file.

HttpAuth

Use the protection by the webserver (.htaccess/.htpasswd) (experimental) Enforcing HTTP Auth not yet. Note that the ADMIN_USER should exist also. Using HttpAuth disables all other methods and no userauth sessions are used.

  USER_AUTH_ORDER = 'PersonalPage : Db'
  USER_AUTH_ORDER = 'BogoLogin : PersonalPage'

first-only

use only the first method in USER_AUTH_ORDER

old

ignore USER_AUTH_ORDER and try to use all available methods as in the previous PhpWiki releases (slow)

strict

check if the user exists for all methods: on the first existing user, try the password. dont try the other methods on failure then

stacked

check the given user - password combination for all methods and return true on the first success.

\"NONE\"

Disable group membership (Fastest). Note the required quoting.

WIKIPAGE

Define groups as list at \"CategoryGroup\". (Slowest, but easiest to maintain)

DB

Stored in an SQL database. Optionally external. See USERS/GROUPS queries

FILE

Flatfile. See AUTH_GROUP_FILE below.

LDAP

LDAP groups. See \"LDAP authentication options\" above and lib/WikiGroup.php. (experimental)

  DBAUTH_PREF_SELECT = \"SELECT prefs FROM user WHERE userid='\$userid'\"
  DBAUTH_PREF_SELECT = \"SELECT prefs FROM pref WHERE userid='\$userid'\"

  THEME = Sidebar (default)
  THEME = default
  THEME = MacOSX
  THEME = MonoBook (WikiPedia)
  THEME = smaller
  THEME = Wordpress
  THEME = Portland
  THEME = Crao
  THEME = wikilens (with Ratings)
  THEME = Hawaiian
  THEME = SpaceWiki
  THEME = Hawaiian
  THEME = blog     (Kubrick)   [experimental]

English  \"en\" (English    - HomePage)
German   \"de\" (Deutsch    - StartSeite)
French   \"fr\" (Français   - Accueil)
Dutch    \"nl\" (Nederlands - ThuisPagina)
Spanish  \"es\" (Español    - PáginaPrincipal)
Swedish  \"sv\" (Svenska    - Framsida)
Italian  \"it\" (Italiano   - PaginaPrincipale)
Japanese \"ja\" (Japanese   - ホームページ)
Chinese  \"zh\" (Chinese    - 首頁)

// Default (old) behavior:
define('WIKI_PGSRC', 'pgsrc');
// New style:
define('WIKI_PGSRC', 'wiki.zip');
define('WIKI_PGSRC',
       '../Logs/Hamwiki/hamwiki-20010830.zip');

    Action x-phpwiki-page /scripts/phpwiki/index.php
    SetHandler x-phpwiki-page
    DirectoryIndex /scripts/phpwiki/index.php

" . $title . "

get_config_item_id() . "\" style=\"color: green\">Input accepted.

" . $this->default_value . "

" . $title . "

" . $this->default_value."

get_config_item_id() . "\" style=\"color: green\">Input accepted.

get_config_item_id() . "\" style=\"color: red\">Cannot be empty.

get_config_item_id() . "\" style=\"color: green\">Input accepted.

get_config_item_id() . "\" style=\"color: red\">Cannot be empty.

get_config_item_id() . "\" style=\"color: red\">Must be longer than 4 chars.

get_config_item_id() . "\" style=\"color: green\">Input accepted.

get_config_item_id() . "\" style=\"color: green\">Input accepted.

get_config_item_id() . "\" style=\"color: green\">Input accepted.

get_config_item_id() . "\" style=\"color: green\">Input accepted.

get_config_item_id() . "\" style=\"color: green\">Input accepted.

" . $title . "

Hide options.

.*?

.*?

|
|$))@s",
        $text, $m, PREG_PATTERN_ORDER);

    $text = '';
    foreach ($m[1] as $par) {
        if (!($par = trim($par)))
            continue;
        if (!preg_match('/^<(pre|dl)>/', $par))
            $par = "
$par
";
        $text .= $par;
    }
    return $text;
}

function text_from_dist($var)
{
    static $distfile = 0;
    static $f;

    if (!$distfile) {
        $sep = (substr(PHP_OS, 0, 3) == 'WIN' ? '\\' : '/');
        $distfile = dirname(__FILE__) . $sep . "config" . $sep . "config-dist.ini";
        $f = fopen($distfile, "r");
    }
    if ($var == '_MAGIC_CLOSE_FILE') {
        fclose($f);
        return;
    }
    // if all vars would be in natural order as in the config-dist this would not be needed.
    fseek($f, 0);
    $par = "\n";
    while (!feof($f)) {
        $s = fgets($f);
        if (preg_match("/^; \w/", $s)) {
            $par .= (substr($s, 2) . " ");
        } elseif (preg_match("/^;\s*$/", $s)) {
            $par .= "\n\n";
        }
        if (preg_match("/^;?" . preg_quote($var) . "\s*=/", $s))
            return $par;
        if (preg_match("/^\s*$/", $s)) // new paragraph
            $par = "\n";
    }
    return '';
}

function stripHtml($text)
{
    $d = str_replace("
", "", $text);
    $d = str_replace("
", "", $d);
    $d = str_replace("
", "", $d);
    $d = str_replace("
", "", $d);
    $d = str_replace("
", "", $d);
    $d = str_replace("
", "", $d);
    $d = str_replace("
", "", $d);
    $d = str_replace("
", "", $d);
    $d = str_replace("
", "", $d);
    $d = str_replace("
", "", $d);
    //restore html entities into characters
    // http://www.php.net/manual/en/function.htmlentities.php
    $trans = get_html_translation_table(HTML_ENTITIES);
    $trans = array_flip($trans);
    $d = strtr($d, $trans);
    return $d;
}

include_once(dirname(__FILE__) . "/lib/stdlib.php");

////
// Function to create better user passwords (much larger keyspace),
// suitable for user passwords.
// Sequence of random ASCII numbers, letters and some special chars.
// Note: There exist other algorithms for easy-to-remember passwords.
function random_good_password($minlength = 5, $maxlength = 8)
{
    $newpass = '';
    // assume ASCII ordering (not valid on EBCDIC systems!)
    $valid_chars = "!#%&+-.0123456789=@ABCDEFGHIJKLMNOPQRSTUVWXYZ_abcdefghijklmnopqrstuvwxyz";
    $start = ord($valid_chars);
    $end = ord(substr($valid_chars, -1));
    better_srand();
    if (function_exists('mt_rand')) // mersenne twister
        $length = mt_rand($minlength, $maxlength);
    else // the usually bad glibc rand()
        $length = rand($minlength, $maxlength);
    while ($length > 0) {
        if (function_exists('mt_rand'))
            $newchar = mt_rand($start, $end);
        else
            $newchar = rand($start, $end);
        if (!strrpos($valid_chars, $newchar)) continue; // skip holes
        $newpass .= sprintf("%c", $newchar);
        $length--;
    }
    return ($newpass);
}

// debugging
function printArray($a)
{
    echo "
\n
\n";
    print_r($a);
    echo "\n
\n
\n";
}

// end of class definitions
/////////////////////////////
// begin auto generation code

if (!function_exists('is_a')) {
    function is_a($object, $class)
    {
        $class = strtolower($class);
        return (get_class($object) == $class) or is_subclass_of($object, $class);
    }
}

if (!empty($HTTP_POST_VARS['action'])
    and $HTTP_POST_VARS['action'] == 'make_config'
        and !empty($HTTP_POST_VARS['ADMIN_USER'])
            and !empty($HTTP_POST_VARS['ADMIN_PASSWD'])
) {

    $timestamp = date('dS \of F, Y H:i:s');

    $config = "
; This is a local configuration file for PhpWiki.
; It was automatically generated by the configurator script
; on the $timestamp.
;
; $preamble
";

    $posted = $GLOBALS['HTTP_POST_VARS'];
    /*if (defined('DEBUG'))
     printArray($GLOBALS['HTTP_POST_VARS']);*/

    foreach ($properties as $option_name => $a) {
        $posted_value = stripslashes($posted[$a->config_item_name]);
        $config .= $properties[$option_name]->get_config($posted_value);
    }

    $config .= $end;

    if (is_writable($fs_config_file)) {
        // We first check if the config-file exists.
        if (file_exists($fs_config_file)) {
            // We make a backup copy of the file
            $new_filename = preg_replace('/\.ini$/', '-' . time() . '.ini', $fs_config_file);
            if (@copy($fs_config_file, $new_filename)) {
                $fp = @fopen($fs_config_file, 'w');
            }
        } else {
            $fp = @fopen($fs_config_file, 'w');
        }
    } else {
        $fp = false;
    }

    if ($fp) {
        fputs($fp, utf8_encode($config));
        fclose($fp);
        echo "
The configuration was written to $config_file.
\n";
        if ($new_filename) {
            echo "
A backup was made to $new_filename.
\n";
        } else {
            ; //echo "
You must rename or copy this $config_file file to config/config.ini.
\n";
        }
    } else {
        echo "
The configuration file could not be written.
\n",
        " You should copy the above configuration to a file, ",
        "and manually save it as config/config.ini.
\n";
    }

    echo "
\n
Here's the configuration file based on your answers:
\n";
    echo "
\n";
    echo "\n";
    echo htmlentities($config, ENT_COMPAT, "UTF-8");
    echo "
\n";
    echo "
\n";

    echo "
To make any corrections, edit the settings again.
\n";

} else { // first time or create password
    $posted = $GLOBALS['HTTP_POST_VARS'];
    // No action has been specified - we make a form.

    if (!empty($GLOBALS['HTTP_GET_VARS']['start_debug']))
        $configurator .= ("?start_debug=" . $GLOBALS['HTTP_GET_VARS']['start_debug']);
    echo '



';

    while (list($property, $obj) = each($properties)) {
        echo $obj->get_instructions($property);
        if ($h = $obj->get_html()) {
            if (defined('DEBUG') and DEBUG) $h = get_class($obj) . "
\n" . $h;
            echo "\n";
        }
        echo '';
    }

    echo '
" . $h . "
 

';
}
?>