install.php

<?php

// install.php -- Web-based installation script
// Thanks to the phpBB crew for an example on how this can be done.
// ------------------------------------------------------------------------
// Copyright (c) 2001 - 2004 The phpBugTracker Group
// ------------------------------------------------------------------------
// This file is part of phpBugTracker
//
// phpBugTracker is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// phpBugTracker is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with phpBugTracker; if not, write to the Free Software Foundation,
// Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
// ------------------------------------------------------------------------
// $Id: install.php,v 1.62 2008/10/06 03:41:20 brycen Exp $

error_reporting(E_ALL);
ini_set('display_errors', true);
set_include_path('./inc/pear' . PATH_SEPARATOR . get_include_path());

require_once('inc/functions.php');
define('THEME', 'default');
define('RAWERROR', true);

$log_text = "";
$num_errors = 0;

//// Handle a database error
//function handle_install_error($obj) {
//    global $log_text;
//
//    $log_text .= "<div class=\"error\">";
//    $log_text .= htmlentities($obj->message) . '<br>' . htmlentities($obj->userinfo);
//    $log_text .= "</div>\n";
//}

function log_query($str) {
    global $db, $log_text, $num_errors;

    $log_text .= "SQL: " . $str . "<br>\n";
    try {
        $db->query($str);
    } catch (Exception $exc) {
        $num_errors = $num_errors + 1;
        $log_text .= "<div class=\"error\">";
        $log_text .= htmlentities(get_class($exc) . ':' . $exc->getCode() . ' ' . $exc->getMessage());
        $log_text .= "</div>\n";
    }
    $log_text .= "<br>\n";
}

// Template class
class InstallTemplate {

    var $vars;

    function __construct($vars = array()) {
        $this->vars = $vars;
    }

    function render($content_template, $page_title, $wrap_file = '') {
        extract($this->vars);
        $path = defined('TEMPLATE_PATH') ? './templates/' . THEME . '/' . TEMPLATE_PATH . '/' : './templates/' . THEME . '/';
        require($wrap_file ? $path . $wrap_file : $path . 'wrap.php');
    }

    function assign($var, $value = '') {
        if (is_array($var)) {
            foreach ($var as $k => $v) {
                $this->vars[$k] = $v;
            }
        } else {
            $this->vars[$var] = $value;
        }
    }

}

$t = new InstallTemplate(array(
    'template_path' => 'templates/default'));

$db_types = array(
    'mysqli' => 'MySQL >= 4.1',
        //'mysql' => 'MySQL < 4.1',
        //'oci8' => 'Oracle 8.1.x',
        //'pgsql' => 'PostgreSQL',
        //'mssql' => 'Microsoft SQL Server',
);

@ini_set("magic_quotes_runtime", 0); // runtime quotes will kill the included sql
@ini_set("magic_quotes_sybase", 0);

if (!empty($_POST)) {
    $tables = array(
        '/^#.*/' => '',
        '/^--.*/' => '',
        '/TBL_ACTIVE_SESSIONS/' => $_POST['tbl_prefix'] . 'active_sessions',
        '/TBL_DB_SEQUENCE/' => $_POST['tbl_prefix'] . 'db_sequence',
        '/TBL_ATTACHMENT/' => $_POST['tbl_prefix'] . 'attachment',
        '/TBL_AUTH_GROUP/' => $_POST['tbl_prefix'] . 'auth_group',
        '/TBL_AUTH_PERM/' => $_POST['tbl_prefix'] . 'auth_perm',
        '/TBL_AUTH_USER/' => $_POST['tbl_prefix'] . 'auth_user',
        '/TBL_BUG_CC/' => $_POST['tbl_prefix'] . 'bug_cc',
        '/TBL_BUG_DEPENDENCY/' => $_POST['tbl_prefix'] . 'bug_dependency',
        '/TBL_BUG_GROUP/' => $_POST['tbl_prefix'] . 'bug_group',
        '/TBL_BUG_HISTORY/' => $_POST['tbl_prefix'] . 'bug_history',
        '/TBL_BUG_VOTE/' => $_POST['tbl_prefix'] . 'bug_vote',
        '/TBL_BUG/' => $_POST['tbl_prefix'] . 'bug',
        '/TBL_COMMENT/' => $_POST['tbl_prefix'] . 'comment',
        '/TBL_COMPONENT/' => $_POST['tbl_prefix'] . 'component',
        '/TBL_CONFIGURATION/' => $_POST['tbl_prefix'] . 'configuration',
        '/TBL_GROUP_PERM/' => $_POST['tbl_prefix'] . 'group_perm',
        '/TBL_OS/' => $_POST['tbl_prefix'] . 'os',
        '/TBL_PROJECT_GROUP/' => $_POST['tbl_prefix'] . 'project_group',
        '/TBL_PROJECT/' => $_POST['tbl_prefix'] . 'project',
        '/TBL_RESOLUTION/' => $_POST['tbl_prefix'] . 'resolution',
        '/TBL_SAVED_QUERY/' => $_POST['tbl_prefix'] . 'saved_query',
        '/TBL_SEVERITY/' => $_POST['tbl_prefix'] . 'severity',
        '/TBL_PRIORITY/' => $_POST['tbl_prefix'] . 'priority',
        '/TBL_STATUS/' => $_POST['tbl_prefix'] . 'status',
        '/TBL_USER_GROUP/' => $_POST['tbl_prefix'] . 'user_group',
        '/TBL_USER_PERM/' => $_POST['tbl_prefix'] . 'user_perm',
        '/TBL_USER_PREF/' => $_POST['tbl_prefix'] . 'user_pref',
        '/TBL_VERSION/' => $_POST['tbl_prefix'] . 'version',
        '/TBL_PROJECT_PERM/' => $_POST['tbl_prefix'] . 'project_perm',
        '/TBL_DATABASE/' => $_POST['tbl_prefix'] . 'database_server',
        '/TBL_SITE/' => $_POST['tbl_prefix'] . 'site',
        '/TBL_BOOKMARK/' => $_POST['tbl_prefix'] . 'bookmark',
        '/OPTION_ADMIN_EMAIL/' => $_POST['admin_login'],
        '/OPTION_ADMIN_PASS/' => $_POST['encrypt_pass'] ? md5($_POST['admin_pass']) : $_POST['admin_pass'],
        '/OPTION_PHPBT_EMAIL/' => $_POST['phpbt_email'],
        '/OPTION_ENCRYPT_PASS/' => $_POST['encrypt_pass'],
        '/OPTION_INSTALL_URL/' => 'http://' . $_SERVER['SERVER_NAME'] . dirname($_SERVER['PHP_SELF']),
    );
    // Bug #1501163 '/OPTION_INSTALL_URL/' => 'http://'.$_SERVER['SERVER_NAME'].dirname($_SERVER['SCRIPT_NAME']),
}

if (file_exists('config.php')) {
    require_once('config.php');
}
if (defined('DB_HOST')) { // Already configured
    header("Location: index.php");
}

function db_type_options($selected = 0) {
    global $db_types;

    foreach ($db_types as $val => $item) {
        if ($selected == $val and $selected != '')
            $sel = ' selected';
        else
            $sel = '';
        echo "<option value=\"$val\"$sel>$item</option>";
    }
}

function grab_config_file() {
    global $t, $_POST;

    foreach ($_POST as $key => $val) {
        $patterns[] = '{' . $key . '}';
        $replacements[] = $val;
    }
    $patterns[] = '{PEAR_PATH}';
    $replacements[] = defined('PEAR_PATH') ? PEAR_PATH : '';

    $contents = join('', file('config-dist.php'));
    return str_replace($patterns, $replacements, $contents);
}

function test_database(&$params, $testonly = false) {
    // PEAR::DB
    //define('PEAR_PATH', ''); // Set this to '/some/path/' to not use system-wide PEAR
    //define('PEAR_PATH', 'inc/pear/'); // use a locally installed Pear
    //if (!@include_once(PEAR_PATH . 'DB.php')) {
    //    $error_message = translate("Failed loading Pear:DB");
    //    $error_info = translate("Please check your Pear installation and the defined PEAR_PATH in install.php");
    //    $error_info .= " <a href='http://pear.php.net/'>http://pear.php.net/</a>";
    //    require('templates/default/install-dbfailure.html');
    //    exit;
    //}
    $dsn = array(
        'phptype' => $params['db_type'],
        'hostspec' => $params['db_host'],
        'database' => $params['db_database'],
        'username' => $params['db_user'],
        'password' => $params['db_pass']
    );

    if (!empty($params['db_port'])) {
        $dsn['port'] = $params['db_port'];
    }

    //$db = DB::Connect($dsn, array('debug' => 2));
    require_once 'inc/pdo_adapter.php';
    $db = new PdoAdapter();
    try {
        $db->connect($dsn);
        $db->query("set names utf8");
    } catch (Exception $exc) {
        $trace = $exc->getTraceAsString();
        $error_message = get_class($exc) . ':' . $exc->getCode() . ' ' . $exc->getMessage();
        $error_info = '';
        require('templates/default/install-dbfailure.html.php');
        exit;
    }
    if ($testonly) {
        require('templates/default/install-dbsuccess.html');
        exit;
    } else {
        return $db;
    }
}

function create_tables() {
    global $_POST, $tables;
    global $db, $log_text, $num_errors;

    $tableExist = true;
    try {
        $query = 'select count(*) from ' . $_POST['tbl_prefix'] . 'configuration';
        $db->getOne($query);
    } catch (Exception $e) {
        $tableExist = false;
    }
    if ($tableExist && empty($_POST['force_install'])) {
        $op = $_POST['op'];
        $db_type = $_POST['db_type'];
        $db_host = $_POST['db_host'];
        $db_database = $_POST['db_database'];
        $db_user = $_POST['db_user'];
        $db_pass = $_POST['db_pass'];
        $tbl_prefix = $_POST['tbl_prefix'];
        $phpbt_email = $_POST['phpbt_email'];
        $admin_login = $_POST['admin_login'];
        $admin_pass = $_POST['admin_pass'];
        $admin_pass2 = $_POST['admin_pass2'];
        $encrypt_pass = $_POST['encrypt_pass'];
        require('templates/default/install-question.html');
        exit;
    }

    //$db->setOption('optimize', 'portability');
    //$db->setErrorHandling(PEAR_ERROR_CALLBACK, "handle_install_error");

    $q1 = file('schemas/' . $_POST['db_type'] . '.in');
    $q2 = file('schemas/common.in');
    $q_temp_ary = array_merge($q1, $q2);
    $queries = preg_replace(array_keys($tables), array_values($tables), $q_temp_ary);
    $do_query = '';
    foreach ($queries as $query) {
        // First, collect multi-line queries into one line, then run the query
        if ($query{0} == '#') {
            continue;
        }
        $do_query .= chop($query);
        if (empty($do_query) or substr($do_query, -1) != ';') {
            continue;
        }
        if ($_POST['db_type'] == 'oci8') {
            $do_query = substr($do_query, 0, -1);
        }
        log_query(stripslashes($do_query));
        syslog(LOG_DEBUG, stripslashes($do_query));
        $do_query = '';
    }
    /* !! BAD! Must figure out how to get db_version from config-dist.php... */
    /* !! Must manually be updated when DB_VERSION changes !! */
    $dbVersion = 21; // DB_VERSION
    $query = preg_replace(array_keys($tables), array_values($tables), 'INSERT INTO TBL_CONFIGURATION (varname,varvalue,description,vartype) VALUES (\'DB_VERSION\', ' . /* !!! */ $dbVersion /* !!! */ . ', \'Database Version <b>Warning:</b> Changing this might make things go horribly wrong, so do not change it.\', \'mixed\')');
    log_query($query);

    if ($num_errors > 0) {
        require('templates/default/install-failure.html');
        exit;
    }
}

function check_vars() {
    global $_POST;

    $error = '';
    if (!$_POST['db_host'] = trim($_POST['db_host'])) {
        $error = translate("Please enter the host name for your database server");
    } elseif (!$_POST['db_database'] = trim($_POST['db_database'])) {
        $error = translate("Please enter the name of the database you will be using");
    } elseif (!$_POST['db_user'] = trim($_POST['db_user'])) {
        $error = translate("Please enter the user name for connecting to the database");
    } elseif (!$_POST['phpbt_email'] = trim($_POST['phpbt_email'])) {
        $error = translate("Please enter the phpBT email address");
    } elseif (!$_POST['admin_login'] = trim($_POST['admin_login'])) {
        $error = translate("Please enter the admin login");
    } elseif (!bt_valid_email($_POST['admin_login'])) {
        $error = translate("Please use a valid email address for the admin login");
    } elseif (!$_POST['admin_pass'] = trim($_POST['admin_pass'])) {
        $error = translate("Please enter the admin password");
    } elseif (!$_POST['admin_pass2'] = trim($_POST['admin_pass2'])) {
        $error = translate("Please confirm the admin password");
    } elseif ($_POST['admin_pass'] != $_POST['admin_pass2']) {
        $error = translate("The admin passwords don't match");
    }

    if (!empty($error)) {
        show_front($error);
        return false;
    } else {
        return true;
    }
}

function dump_config_file() {
    global $db;

    if (!check_vars())
        return;
    $db = test_database($_POST);
    if (empty($_POST['no_install']))
        create_tables();
    header('Content-Type: text/x-delimtext; name="config.php"');
    header('Content-disposition: attachment; filename=config.php');
    echo grab_config_file();
}

function save_config_file() {
    global $db;

    if (!check_vars())
        return;
    $db = test_database($_POST);
    if (empty($_POST['no_install']))
        create_tables();
    if (!$fp = @fopen('config.php', 'w')) {
        show_front(translate("Error writing to config.php"));
    } else {
        fwrite($fp, grab_config_file());
        fclose($fp);
    }
    show_finished();
}

function show_finished() {
    global $t, $_POST;

    $login = $_POST['admin_login'];
    if (!empty($_POST['no_install'])) {
        header("Location: upgrade.php");
        exit;
    }
    require('templates/default/install-complete.html');
}

function show_front($error = '') {
    global $t, $_POST, $select;

    extract($_POST);
    $error = $error;
    $default_email = 'phpbt@' . $_SERVER['SERVER_NAME'];
    $OPTION_INSTALL_URL = 'http://' . $_SERVER['SERVER_NAME'] . dirname($_SERVER['PHP_SELF']);
    require('templates/default/install.html.php');
}

if (isset($_POST['op'])) {
    switch ($_POST['op']) {
        case 'save_config_file' : save_config_file();
            break;
        case 'dump_config_file' : dump_config_file();
            break;
    }
} elseif (isset($_GET['op'])) {
    switch ($_GET['op']) {
        case 'dbtest' : test_database($_GET, true);
            break;
    }
} else {
    $error = '';

    if (get_magic_quotes_gpc()) {
        $error .= "<p><hr></p><p>magic_quotes_gpc is ON!</p>" .
                "<p>You must have magic_quotes_gpc set to OFF either in php.ini or in " .
                ".htaccess (see <a href=\"http://php.net/magic_quotes\">http://php.net/magic_quotes</a> for more info).</p><p><hr></p>";
    }

    if (get_magic_quotes_runtime()) {
        $error .= "<p><hr></p><p>magic_quotes_runtime is ON!</p>" .
                "<p>You must have magic_quotes_runtime set to OFF either in php.ini or in " .
                ".htaccess (see <a href=\"http://php.net/magic_quotes\">http://php.net/magic_quotes</a> for more info).</p><p><hr></p>";
    }

    show_front($error);
}