File: install.php

package info (click to toggle)
dokuwiki 2025-05-14.a%2Bdfsg-4
links: PTS, VCS
area: main
in suites: forky, sid
size: 24,920 kB
sloc: php: 99,723; javascript: 3,741; sh: 599; makefile: 70; xml: 34
file content (705 lines) | stat: -rw-r--r-- 21,058 bytes
<?php

/*><div style="width:60%; margin: auto; background-color: #fcc;
                border: 1px solid #faa; padding: 0.5em 1em;">
    <h1 style="font-size: 120%">No PHP Support</h1>

    It seems this server has no PHP support enabled. You will need to
    enable PHP before you can install and run DokuWiki. Contact your hosting
    provider if you're unsure what this means.

</div>*/

use dokuwiki\PassHash;

if (!defined('DOKU_INC')) define('DOKU_INC', __DIR__ . '/');
if (!defined('DOKU_CONF')) define('DOKU_CONF', DOKU_INC . 'conf/');
if (!defined('DOKU_LOCAL')) define('DOKU_LOCAL', DOKU_INC . 'conf/');

// load and initialize the core system
require_once(DOKU_INC . 'inc/init.php');
require_once(DOKU_INC . 'inc/pageutils.php');

// check for error reporting override or set error reporting to sane values
if (!defined('DOKU_E_LEVEL')) {
    error_reporting(E_ALL ^ E_NOTICE);
} else {
    error_reporting(DOKU_E_LEVEL);
}

// language strings
require_once(DOKU_INC . 'inc/lang/en/lang.php');
if (isset($_REQUEST['l']) && !is_array($_REQUEST['l'])) {
    $LC = preg_replace('/[^a-z\-]+/', '', $_REQUEST['l']);
}
if (empty($LC)) $LC = 'en';
if ($LC && $LC != 'en') {
    require_once(DOKU_INC . 'inc/lang/' . $LC . '/lang.php');
}

// initialise variables ...
$error = [];

// begin output
header('Content-Type: text/html; charset=utf-8');
?>
    <!DOCTYPE html>
    <html lang="<?php echo $LC ?>" dir="<?php echo $lang['direction'] ?>">
    <head>
        <meta charset="utf-8"/>
        <title><?php echo $lang['i_installer'] ?></title>
        <style>
            body {
                width: 90%;
                margin: 0 auto;
                font: 84% Verdana, Helvetica, Arial, sans-serif;
            }

            img {
                border: none
            }

            br.cl {
                clear: both;
            }

            code {
                font-size: 110%;
                color: #800000;
            }

            fieldset {
                border: none
            }

            label {
                display: block;
                margin-top: 0.5em;
            }

            select.text, input.text {
                width: 30em;
                margin: 0 0.5em;
            }

            a {
                text-decoration: none
            }
        </style>
        <script>
            function acltoggle() {
                var cb = document.getElementById('acl');
                var fs = document.getElementById('acldep');
                if (!cb || !fs) return;
                if (cb.checked) {
                    fs.style.display = '';
                } else {
                    fs.style.display = 'none';
                }
            }

            window.onload = function () {
                acltoggle();
                var cb = document.getElementById('acl');
                if (cb) cb.onchange = acltoggle;
            };
        </script>
    </head>
    <body style="">
    <h1 style="float:left">
        <img src="lib/exe/fetch.php?media=wiki:dokuwiki-128.png"
             style="vertical-align: middle;" alt="" height="64" width="64"/>
        <?php echo $lang['i_installer'] ?>
    </h1>
    <div style="float:right; margin: 1em;">
        <?php langsel() ?>
    </div>
    <br class="cl"/>

    <div style="float: right; width: 34%;">
        <?php
        if (file_exists(DOKU_INC . 'inc/lang/' . $LC . '/install.html')) {
            include(DOKU_INC . 'inc/lang/' . $LC . '/install.html');
        } else {
            echo "<div lang=\"en\" dir=\"ltr\">\n";
            include(DOKU_INC . 'inc/lang/en/install.html');
            echo "</div>\n";
        }
        ?>
        <a style="
                background: transparent
                url(data/dont-panic-if-you-see-this-in-your-logs-it-means-your-directory-permissions-are-correct.png)
                left top no-repeat;
                display: block; width:380px; height:73px; border:none; clear:both;"
           target="_blank"
           href="https://www.dokuwiki.org/security#web_access_security"></a>
    </div>

    <div style="float: left; width: 58%;">
        <?php
        try {
            if (!(check_functions() && check_permissions())) {
                echo '<p>' . $lang['i_problems'] . '</p>';
                print_errors();
                print_retry();
            } elseif (!check_configs()) {
                echo '<p>' . $lang['i_modified'] . '</p>';
                print_errors();
            } elseif (check_data($_REQUEST['d'])) {
                // check_data has sanitized all input parameters
                if (!store_data($_REQUEST['d'])) {
                    echo '<p>' . $lang['i_failure'] . '</p>';
                    print_errors();
                } else {
                    echo '<p>' . $lang['i_success'] . '</p>';
                }
            } else {
                print_errors();
                print_form($_REQUEST['d']);
            }
        } catch (Exception $e) {
            echo 'Caught exception: ', $e->getMessage(), "\n";
        }
        ?>
    </div>


    <div style="clear: both">
        <a href="https://dokuwiki.org/"><img src="lib/tpl/dokuwiki/images/button-dw.png" alt="driven by DokuWiki"/></a>
        <a href="https://php.net"><img src="lib/tpl/dokuwiki/images/button-php.gif" alt="powered by PHP"/></a>
    </div>
    </body>
    </html>
<?php

/**
 * Print the input form
 *
 * @param array $d submitted entry 'd' of request data
 */
function print_form($d)
{
    global $lang;
    global $LC;

    include(DOKU_CONF . 'license.php');

    if (!is_array($d)) $d = [];
    $d = array_map('hsc', $d);

    if (!isset($d['acl'])) $d['acl'] = 1;
    if (!isset($d['pop'])) $d['pop'] = 1;

    ?>
    <form action="" method="post">
        <input type="hidden" name="l" value="<?php echo $LC ?>"/>
        <fieldset>
            <label for="title"><?php echo $lang['i_wikiname'] ?>
                <input type="text" name="d[title]" id="title" value="<?php echo $d['title'] ?>" style="width: 20em;"/>
            </label>

            <fieldset style="margin-top: 1em;">
                <label for="acl">
                    <input type="checkbox" name="d[acl]"
                           id="acl" <?php echo(($d['acl'] ? ' checked="checked"' : '')); ?> />
                    <?php echo $lang['i_enableacl'] ?></label>

                <fieldset id="acldep">
                    <label for="superuser"><?php echo $lang['i_superuser'] ?></label>
                    <input class="text" type="text" name="d[superuser]" id="superuser"
                           value="<?php echo $d['superuser'] ?>"/>

                    <label for="fullname"><?php echo $lang['fullname'] ?></label>
                    <input class="text" type="text" name="d[fullname]" id="fullname"
                           value="<?php echo $d['fullname'] ?>"/>

                    <label for="email"><?php echo $lang['email'] ?></label>
                    <input class="text" type="text" name="d[email]" id="email" value="<?php echo $d['email'] ?>"/>

                    <label for="password"><?php echo $lang['pass'] ?></label>
                    <input class="text" type="password" name="d[password]" id="password"/>

                    <label for="confirm"><?php echo $lang['passchk'] ?></label>
                    <input class="text" type="password" name="d[confirm]" id="confirm"/>

                    <label for="policy"><?php echo $lang['i_policy'] ?></label>
                    <select class="text" name="d[policy]" id="policy">
                        <option value="0" <?php echo ($d['policy'] == 0) ? 'selected="selected"' : '' ?>><?php
                            echo $lang['i_pol0'] ?></option>
                        <option value="1" <?php echo ($d['policy'] == 1) ? 'selected="selected"' : '' ?>><?php
                            echo $lang['i_pol1'] ?></option>
                        <option value="2" <?php echo ($d['policy'] == 2) ? 'selected="selected"' : '' ?>><?php
                            echo $lang['i_pol2'] ?></option>
                    </select>

                    <label for="allowreg">
                        <input type="checkbox" name="d[allowreg]" id="allowreg" <?php
                        echo(($d['allowreg'] ? ' checked="checked"' : '')); ?> />
                        <?php echo $lang['i_allowreg'] ?>
                    </label>
                </fieldset>
            </fieldset>

            <fieldset>
                <p><?php echo $lang['i_license'] ?></p>
                <?php
                $license[] = ['name' => $lang['i_license_none'], 'url' => ''];
                if (empty($d['license'])) $d['license'] = 'cc-by-sa';
                foreach ($license as $key => $lic) {
                    echo '<label for="lic_' . $key . '">';
                    echo '<input type="radio" name="d[license]" value="' . hsc($key) . '" id="lic_' . $key . '"' .
                        (($d['license'] === $key) ? ' checked="checked"' : '') . '>';
                    echo hsc($lic['name']);
                    if ($lic['url']) echo ' <a href="' . $lic['url'] . '" target="_blank"><sup>[?]</sup></a>';
                    echo '</label>';
                }
                ?>
            </fieldset>

            <fieldset>
                <p><?php echo $lang['i_pop_field'] ?></p>
                <label for="pop">
                    <input type="checkbox" name="d[pop]" id="pop" <?php
                    echo(($d['pop'] ? ' checked="checked"' : '')); ?> />
                    <?php echo $lang['i_pop_label'] ?>
                    <a href="https://www.dokuwiki.org/popularity" target="_blank"><sup>[?]</sup></a>
                </label>
            </fieldset>

        </fieldset>
        <fieldset id="process">
            <button type="submit" name="submit"><?php echo $lang['btn_save'] ?></button>
        </fieldset>
    </form>
    <?php
}

function print_retry()
{
    global $lang;
    global $LC;
    ?>
    <form action="" method="get">
        <fieldset>
            <input type="hidden" name="l" value="<?php echo $LC ?>"/>
            <button type="submit"><?php echo $lang['i_retry']; ?></button>
        </fieldset>
    </form>
    <?php
}

/**
 * Check validity of data
 *
 * @param array $d
 * @return bool ok?
 * @author Andreas Gohr
 *
 */
function check_data(&$d)
{
    static $form_default = [
        'title' => '',
        'acl' => '1',
        'superuser' => '',
        'fullname' => '',
        'email' => '',
        'password' => '',
        'confirm' => '',
        'policy' => '0',
        'allowreg' => '0',
        'license' => 'cc-by-sa'
    ];
    global $lang;
    global $error;

    if (!is_array($d)) $d = [];
    foreach ($d as $k => $v) {
        if (is_array($v))
            unset($d[$k]);
        else $d[$k] = (string)$v;
    }

    //autolowercase the username
    $d['superuser'] = isset($d['superuser']) ? strtolower($d['superuser']) : "";

    $ok = false;

    if (isset($_REQUEST['submit'])) {
        $ok = true;

        // check input
        if (empty($d['title'])) {
            $error[] = sprintf($lang['i_badval'], $lang['i_wikiname']);
            $ok = false;
        }
        if (isset($d['acl'])) {
            if (empty($d['superuser']) || ($d['superuser'] !== cleanID($d['superuser']))) {
                $error[] = sprintf($lang['i_badval'], $lang['i_superuser']);
                $ok = false;
            }
            if (empty($d['password'])) {
                $error[] = sprintf($lang['i_badval'], $lang['pass']);
                $ok = false;
            } elseif (!isset($d['confirm']) || $d['confirm'] != $d['password']) {
                $error[] = sprintf($lang['i_badval'], $lang['passchk']);
                $ok = false;
            }
            if (empty($d['fullname']) || strstr($d['fullname'], ':')) {
                $error[] = sprintf($lang['i_badval'], $lang['fullname']);
                $ok = false;
            }
            if (empty($d['email']) || strstr($d['email'], ':') || !strstr($d['email'], '@')) {
                $error[] = sprintf($lang['i_badval'], $lang['email']);
                $ok = false;
            }
        } else {
            // Since default = 1, browser won't send acl=0 when user untick acl
            $d['acl'] = '0';
        }
    }
    $d = array_merge($form_default, $d);
    return $ok;
}

/**
 * Writes the data to the config files
 *
 * @param array $d
 * @return bool
 * @throws Exception
 *
 * @author  Chris Smith <chris@jalakai.co.uk>
 */
function store_data($d)
{
    global $LC;
    $ok = true;
    $d['policy'] = (int)$d['policy'];

    // create local.php
    $now = date('r');
    $output = <<<EOT
<?php
/**
 * Dokuwiki's Main Configuration File - Local Settings
 * Auto-generated by install script
 * Date: $now
 */

EOT;
    // add any config options set by a previous installer
    $preset = __DIR__ . '/install.conf';
    if (file_exists($preset)) {
        $output .= "# preset config options\n";
        $output .= file_get_contents($preset);
        $output .= "\n\n";
        $output .= "# options selected in installer\n";
        @unlink($preset);
    }

    $output .= '$conf[\'title\'] = \'' . addslashes($d['title']) . "';\n";
    $output .= '$conf[\'lang\'] = \'' . addslashes($LC) . "';\n";
    $output .= '$conf[\'license\'] = \'' . addslashes($d['license']) . "';\n";
    if ($d['acl']) {
        $output .= '$conf[\'useacl\'] = 1' . ";\n";
        $output .= "\$conf['superuser'] = '@admin';\n";
    }
    if (!$d['allowreg']) {
        $output .= '$conf[\'disableactions\'] = \'register\'' . ";\n";
    }
    $ok = $ok && fileWrite(DOKU_LOCAL . 'local.php', $output);

    if ($d['acl']) {
        // hash the password
        $phash = new PassHash();
        $pass = $phash->hash_bcrypt($d['password']);

        // create users.auth.php
        $output = <<<EOT
# users.auth.php
# <?php exit()?>
# Don't modify the lines above
#
# Userfile
#
# Auto-generated by install script
# Date: $now
#
# Format:
# login:passwordhash:Real Name:email:groups,comma,separated

EOT;
        // --- user:bcryptpasswordhash:Real Name:email:groups,comma,seperated
        $output = $output . "\n" . implode(':', [
                $d['superuser'],
                $pass,
                $d['fullname'],
                $d['email'],
                'admin,user',
            ]) . "\n";
        $ok = $ok && fileWrite(DOKU_LOCAL . 'users.auth.php', $output);

        // create acl.auth.php
        $output = <<<EOT
# acl.auth.php
# <?php exit()?>
# Don't modify the lines above
#
# Access Control Lists
#
# Auto-generated by install script
# Date: $now

EOT;
        if ($d['policy'] == 2) {
            $output .= "*               @ALL          0\n";
            $output .= "*               @user         8\n";
        } elseif ($d['policy'] == 1) {
            $output .= "*               @ALL          1\n";
            $output .= "*               @user         8\n";
        } else {
            $output .= "*               @ALL          8\n";
        }
        $ok = $ok && fileWrite(DOKU_LOCAL . 'acl.auth.php', $output);
    }

    // enable popularity submission
    if (isset($d['pop']) && $d['pop']) {
        @touch(DOKU_INC . 'data/cache/autosubmit.txt');
    }

    // disable auth plugins til needed
    $output = <<<EOT
<?php
/*
 * Local plugin enable/disable settings
 *
 * Auto-generated by install script
 * Date: $now
 */

\$plugins['authad']    = 0;
\$plugins['authldap']  = 0;
\$plugins['authmysql'] = 0;
\$plugins['authpgsql'] = 0;

EOT;
    $ok = $ok && fileWrite(DOKU_LOCAL . 'plugins.local.php', $output);

    return $ok;
}

/**
 * Write the given content to a file
 *
 * @param string $filename
 * @param string $data
 * @return bool
 *
 * @author  Chris Smith <chris@jalakai.co.uk>
 */
function fileWrite($filename, $data)
{
    global $error;
    global $lang;

    if (($fp = @fopen($filename, 'wb')) === false) {
        $filename = str_replace($_SERVER['DOCUMENT_ROOT'], '{DOCUMENT_ROOT}/', $filename);
        $error[] = sprintf($lang['i_writeerr'], $filename);
        return false;
    }

    if (!empty($data)) {
        fwrite($fp, $data);
    }
    fclose($fp);
    return true;
}


/**
 * check installation dependent local config files and tests for a known
 * unmodified main config file
 *
 * @return bool
 *
 * @author      Chris Smith <chris@jalakai.co.uk>
 */
function check_configs()
{
    global $error;
    global $lang;

    $ok = true;

    $config_files = [
        'local' => DOKU_LOCAL . 'local.php',
        'users' => DOKU_LOCAL . 'users.auth.php',
        'auth' => DOKU_LOCAL . 'acl.auth.php'
    ];

    // configs shouldn't exist
    foreach ($config_files as $file) {
        if (file_exists($file) && filesize($file)) {
            $file = str_replace($_SERVER['DOCUMENT_ROOT'], '{DOCUMENT_ROOT}/', $file);
            $error[] = sprintf($lang['i_confexists'], $file);
            $ok = false;
        }
    }
    return $ok;
}


/**
 * Check other installation dir/file permission requirements
 *
 * @return bool
 *
 * @author      Chris Smith <chris@jalakai.co.uk>
 */
function check_permissions()
{
    global $error;
    global $lang;

    $dirs = [
        'conf' => DOKU_LOCAL,
        'data' => DOKU_INC . 'data',
        'pages' => DOKU_INC . 'data/pages',
        'attic' => DOKU_INC . 'data/attic',
        'media' => DOKU_INC . 'data/media',
        'media_attic' => DOKU_INC . 'data/media_attic',
        'media_meta' => DOKU_INC . 'data/media_meta',
        'meta' => DOKU_INC . 'data/meta',
        'cache' => DOKU_INC . 'data/cache',
        'locks' => DOKU_INC . 'data/locks',
        'index' => DOKU_INC . 'data/index',
        'tmp' => DOKU_INC . 'data/tmp'
    ];

    $ok = true;
    foreach ($dirs as $dir) {
        if (!file_exists("$dir/.") || !is_writable($dir)) {
            $dir = str_replace($_SERVER['DOCUMENT_ROOT'], '{DOCUMENT_ROOT}', $dir);
            $error[] = sprintf($lang['i_permfail'], $dir);
            $ok = false;
        }
    }
    return $ok;
}

/**
 * Check the availability of functions used in DokuWiki and the PHP version
 *
 * @return bool
 *
 * @author Andreas Gohr <andi@splitbrain.org>
 */
function check_functions()
{
    global $error;
    global $lang;
    $ok = true;

    if (version_compare(phpversion(), '7.4.0', '<')) {
        $error[] = sprintf($lang['i_phpver'], phpversion(), '7.4.0');
        $ok = false;
    }

    if (ini_get('mbstring.func_overload') != 0) {
        $error[] = $lang['i_mbfuncoverload'];
        $ok = false;
    }

    try {
        random_bytes(1);
    } catch (Exception $th) {
        // If an appropriate source of randomness cannot be found, an Exception will be thrown by PHP 7+
        $error[] = $lang['i_urandom'];
        $ok = false;
    }

    if (ini_get('mbstring.func_overload') != 0) {
        $error[] = $lang['i_mbfuncoverload'];
        $ok = false;
    }

    $funcs = explode(' ', 'addslashes call_user_func chmod copy fgets ' .
        'file file_exists fseek flush filesize ftell fopen ' .
        'glob header ignore_user_abort ini_get mkdir ' .
        'ob_start opendir parse_ini_file readfile realpath ' .
        'rename rmdir serialize session_start unlink usleep ' .
        'preg_replace file_get_contents htmlspecialchars_decode ' .
        'spl_autoload_register stream_select fsockopen pack xml_parser_create');

    if (!function_exists('mail')) {
        if (strpos(ini_get('disable_functions'), 'mail') !== false) {
            $disabled = $lang['i_disabled'];
        } else {
            $disabled = "";
        }
        $error[] = sprintf($lang['i_funcnmail'], $disabled);
    }

    foreach ($funcs as $func) {
        if (!function_exists($func)) {
            $error[] = sprintf($lang['i_funcna'], $func);
            $ok = false;
        }
    }
    return $ok;
}

/**
 * Print language selection
 *
 * @author Andreas Gohr <andi@splitbrain.org>
 */
function langsel()
{
    global $lang;
    global $LC;

    $dir = DOKU_INC . 'inc/lang';
    $dh = opendir($dir);
    if (!$dh) return;

    $langs = [];
    while (($file = readdir($dh)) !== false) {
        if (preg_match('/^[._]/', $file)) continue;
        if (is_dir($dir . '/' . $file) && file_exists($dir . '/' . $file . '/lang.php')) {
            $langs[] = $file;
        }
    }
    closedir($dh);
    sort($langs);

    echo '<form action="">';
    echo $lang['i_chooselang'];
    echo ': <select name="l" onchange="submit()">';
    foreach ($langs as $l) {
        $sel = ($l == $LC) ? 'selected="selected"' : '';
        echo '<option value="' . $l . '" ' . $sel . '>' . $l . '</option>';
    }
    echo '</select> ';
    echo '<button type="submit">' . $lang['btn_update'] . '</button>';
    echo '</form>';
}

/**
 * Print global error array
 *
 * @author Andreas Gohr <andi@splitbrain.org>
 */
function print_errors()
{
    global $error;
    if (!empty($error)) {
        echo '<ul>';
        foreach ($error as $err) {
            echo "<li>$err</li>";
        }
        echo '</ul>';
    }
}