friendica/mod/install.php

554 lines
17 KiB
PHP
Raw Normal View History

2010-08-16 00:49:29 -04:00
<?php
/**
* @file mod/install.php
*/
use Friendica\App;
2017-08-26 02:04:21 -04:00
use Friendica\Core\System;
2017-11-07 22:57:46 -05:00
use Friendica\Database\DBM;
2017-12-14 16:13:02 -05:00
use Friendica\Database\DBStructure;
use Friendica\Object\Image;
2017-04-30 00:01:26 -04:00
$install_wizard_pass = 1;
function install_init(App $a) {
// $baseurl/install/testrwrite to test if rewite in .htaccess is working
if ($a->argc == 2 && $a->argv[1] == "testrewrite") {
echo "ok";
killme();
}
2015-11-13 04:56:06 -05:00
// We overwrite current theme css, because during install we could not have a working mod_rewrite
// so we could not have a css at all. Here we set a static css file for the install procedure pages
$a->config['system']['theme'] = "../install";
$a->theme['stylesheet'] = System::baseUrl()."/view/install/style.css";
global $install_wizard_pass;
if (x($_POST, 'pass')) {
$install_wizard_pass = intval($_POST['pass']);
}
}
2010-08-16 00:49:29 -04:00
function install_post(App $a) {
2017-10-11 08:56:36 -04:00
global $install_wizard_pass;
2010-08-16 00:49:29 -04:00
switch($install_wizard_pass) {
case 1:
case 2:
return;
break; // just in case return don't return :)
case 3:
$urlpath = $a->get_path();
$dbhost = notags(trim($_POST['dbhost']));
$dbuser = notags(trim($_POST['dbuser']));
$dbpass = notags(trim($_POST['dbpass']));
$dbdata = notags(trim($_POST['dbdata']));
$phpath = notags(trim($_POST['phpath']));
2012-12-28 16:51:50 -05:00
require_once("include/dba.php");
2017-10-11 08:56:36 -04:00
if (!dba::connect($dbhost, $dbuser, $dbpass, $dbdata, true)) {
$a->data['db_conn_failed'] = true;
2011-03-21 20:34:29 -04:00
}
return;
break;
2012-08-18 15:28:49 -04:00
case 4:
$urlpath = $a->get_path();
$dbhost = notags(trim($_POST['dbhost']));
$dbuser = notags(trim($_POST['dbuser']));
$dbpass = notags(trim($_POST['dbpass']));
$dbdata = notags(trim($_POST['dbdata']));
$phpath = notags(trim($_POST['phpath']));
$timezone = notags(trim($_POST['timezone']));
2016-04-06 14:18:33 -04:00
$language = notags(trim($_POST['language']));
$adminmail = notags(trim($_POST['adminmail']));
2018-01-19 11:25:48 -05:00
$rino = 1;
// connect to db
2017-10-11 08:56:36 -04:00
dba::connect($dbhost, $dbuser, $dbpass, $dbdata, true);
$tpl = get_markup_template('htconfig.tpl');
$txt = replace_macros($tpl,[
'$dbhost' => $dbhost,
'$dbuser' => $dbuser,
'$dbpass' => $dbpass,
'$dbdata' => $dbdata,
'$timezone' => $timezone,
2016-04-06 14:18:33 -04:00
'$language' => $language,
'$urlpath' => $urlpath,
'$phpath' => $phpath,
'$adminmail' => $adminmail,
'$rino' => $rino
]);
$result = file_put_contents('.htconfig.php', $txt);
if (! $result) {
$a->data['txt'] = $txt;
}
2017-10-11 08:56:36 -04:00
$errors = load_database();
if ($errors) {
$a->data['db_failed'] = $errors;
} else {
$a->data['db_installed'] = true;
}
2010-08-16 00:49:29 -04:00
return;
break;
}
2010-08-16 00:49:29 -04:00
}
function install_content(App $a) {
2010-08-16 00:49:29 -04:00
2017-10-11 08:56:36 -04:00
global $install_wizard_pass;
$o = '';
$wizard_status = "";
2013-05-23 01:30:53 -04:00
$install_title = t('Friendica Communications Server - Setup');
if (x($a->data, 'db_conn_failed')) {
$install_wizard_pass = 2;
$wizard_status = t('Could not connect to database.');
}
if (x($a->data, 'db_create_failed')) {
$install_wizard_pass = 2;
$wizard_status = t('Could not create table.');
}
$db_return_text = "";
if (x($a->data, 'db_installed')) {
$txt = '<p style="font-size: 130%;">';
$txt .= t('Your Friendica site database has been installed.') . EOL;
$db_return_text .= $txt;
2011-03-21 20:34:29 -04:00
}
if (x($a->data, 'db_failed')) {
$txt = t('You may need to import the file "database.sql" manually using phpmyadmin or mysql.') . EOL;
$txt .= t('Please see the file "INSTALL.txt".') . EOL ."<hr>";
$txt .= "<pre>".$a->data['db_failed'] . "</pre>". EOL;
$db_return_text .= $txt;
2011-03-21 20:34:29 -04:00
}
2017-10-11 08:56:36 -04:00
if (dba::$connected) {
2011-03-21 20:34:29 -04:00
$r = q("SELECT COUNT(*) as `total` FROM `user`");
2017-11-07 22:57:46 -05:00
if (DBM::is_result($r) && $r[0]['total']) {
$tpl = get_markup_template('install.tpl');
return replace_macros($tpl, [
'$title' => $install_title,
'$pass' => '',
'$status' => t('Database already in use.'),
'$text' => '',
]);
2011-03-21 20:34:29 -04:00
}
}
if (x($a->data, 'txt') && strlen($a->data['txt'])) {
$db_return_text .= manual_config($a);
}
if ($db_return_text != "") {
2012-08-18 15:28:49 -04:00
$tpl = get_markup_template('install.tpl');
return replace_macros($tpl, [
'$title' => $install_title,
'$pass' => "",
'$text' => $db_return_text . what_next(),
]);
}
switch ($install_wizard_pass) {
case 1: { // System check
$checks = [];
2010-08-16 00:49:29 -04:00
check_funcs($checks);
2010-08-16 00:49:29 -04:00
check_imagik($checks);
check_htconfig($checks);
2010-08-16 00:49:29 -04:00
check_smarty3($checks);
check_keys($checks);
if (x($_POST, 'phpath')) {
2012-02-10 17:03:43 -05:00
$phpath = notags(trim($_POST['phpath']));
}
check_php($phpath, $checks);
check_htaccess($checks);
/// @TODO Maybe move this out?
function check_passed($v, $c) {
if ($c['required']) {
$v = $v && $c['status'];
}
return $v;
}
$checkspassed = array_reduce($checks, "check_passed", true);
$tpl = get_markup_template('install_checks.tpl');
$o .= replace_macros($tpl, [
'$title' => $install_title,
'$pass' => t('System check'),
'$checks' => $checks,
'$passed' => $checkspassed,
'$see_install' => t('Please see the file "INSTALL.txt".'),
'$next' => t('Next'),
'$reload' => t('Check again'),
'$phpath' => $phpath,
'$baseurl' => System::baseUrl(),
]);
return $o;
}; break;
case 2: { // Database config
$dbhost = ((x($_POST, 'dbhost')) ? notags(trim($_POST['dbhost'])) : 'localhost');
$dbuser = notags(trim($_POST['dbuser']));
$dbpass = notags(trim($_POST['dbpass']));
$dbdata = notags(trim($_POST['dbdata']));
2012-02-10 17:03:43 -05:00
$phpath = notags(trim($_POST['phpath']));
$tpl = get_markup_template('install_db.tpl');
$o .= replace_macros($tpl, [
'$title' => $install_title,
'$pass' => t('Database connection'),
'$info_01' => t('In order to install Friendica we need to know how to connect to your database.'),
'$info_02' => t('Please contact your hosting provider or site administrator if you have questions about these settings.'),
'$info_03' => t('The database you specify below should already exist. If it does not, please create it before continuing.'),
'$status' => $wizard_status,
'$dbhost' => ['dbhost', t('Database Server Name'), $dbhost, '', 'required'],
'$dbuser' => ['dbuser', t('Database Login Name'), $dbuser, '', 'required', 'autofocus'],
'$dbpass' => ['dbpass', t('Database Login Password'), $dbpass, t("For security reasons the password must not be empty"), 'required'],
'$dbdata' => ['dbdata', t('Database Name'), $dbdata, '', 'required'],
'$adminmail' => ['adminmail', t('Site administrator email address'), $adminmail, t('Your account email address must match this in order to use the web admin panel.'), 'required', 'autofocus', 'email'],
'$lbl_10' => t('Please select a default timezone for your website'),
'$baseurl' => System::baseUrl(),
'$phpath' => $phpath,
'$submit' => t('Submit'),
]);
return $o;
}; break;
case 3: { // Site settings
2012-12-28 16:51:50 -05:00
require_once('include/datetime.php');
$dbhost = ((x($_POST, 'dbhost')) ? notags(trim($_POST['dbhost'])) : 'localhost');
$dbuser = notags(trim($_POST['dbuser']));
$dbpass = notags(trim($_POST['dbpass']));
$dbdata = notags(trim($_POST['dbdata']));
2012-02-10 17:03:43 -05:00
$phpath = notags(trim($_POST['phpath']));
$adminmail = notags(trim($_POST['adminmail']));
$timezone = ((x($_POST, 'timezone')) ? ($_POST['timezone']) : 'America/Los_Angeles');
2016-04-06 14:18:33 -04:00
/* Installed langs */
$lang_choices = get_available_languages();
$tpl = get_markup_template('install_settings.tpl');
$o .= replace_macros($tpl, [
'$title' => $install_title,
'$pass' => t('Site settings'),
'$status' => $wizard_status,
'$dbhost' => $dbhost,
'$dbuser' => $dbuser,
'$dbpass' => $dbpass,
'$dbdata' => $dbdata,
'$phpath' => $phpath,
'$adminmail' => ['adminmail', t('Site administrator email address'), $adminmail, t('Your account email address must match this in order to use the web admin panel.'), 'required', 'autofocus', 'email'],
'$timezone' => field_timezone('timezone', t('Please select a default timezone for your website'), $timezone, ''),
'$language' => ['language', t('System Language:'), 'en', t('Set the default language for your Friendica installation interface and to send emails.'), $lang_choices],
'$baseurl' => System::baseUrl(),
'$submit' => t('Submit'),
]);
return $o;
}; break;
}
}
2010-08-16 00:49:29 -04:00
/**
* checks : array passed to template
* title : string
* status : boolean
* required : boolean
* help : string optional
*/
function check_add(&$checks, $title, $status, $required, $help) {
$checks[] = [
'title' => $title,
'status' => $status,
'required' => $required,
'help' => $help,
];
2010-08-16 00:49:29 -04:00
}
function check_php(&$phpath, &$checks) {
$passed = $passed2 = $passed3 = false;
if (strlen($phpath)) {
$passed = file_exists($phpath);
} else {
$phpath = trim(shell_exec('which php'));
$passed = strlen($phpath);
}
$help = "";
if (!$passed) {
$help .= t('Could not find a command line version of PHP in the web server PATH.'). EOL;
2017-12-03 04:26:26 -05:00
$help .= t("If you don't have a command line version of PHP installed on your server, you will not be able to run the background processing. See <a href='https://github.com/friendica/friendica/blob/master/doc/Install.md#set-up-the-worker'>'Setup the worker'</a>") . EOL;
$help .= EOL . EOL;
$tpl = get_markup_template('field_input.tpl');
$help .= replace_macros($tpl, [
'$field' => ['phpath', t('PHP executable path'), $phpath, t('Enter full path to php executable. You can leave this blank to continue the installation.')],
]);
$phpath = "";
}
check_add($checks, t('Command line PHP').($passed?" (<tt>$phpath</tt>)":""), $passed, false, $help);
if ($passed) {
$cmd = "$phpath -v";
$result = trim(shell_exec($cmd));
$passed2 = ( strpos($result, "(cli)") !== false);
list($result) = explode("\n", $result);
$help = "";
if (!$passed2) {
$help .= t('PHP executable is not the php cli binary (could be cgi-fgci version)'). EOL;
$help .= t('Found PHP version: ')."<tt>$result</tt>";
}
check_add($checks, t('PHP cli binary'), $passed2, true, $help);
}
if ($passed2) {
$str = autoname(8);
$cmd = "$phpath testargs.php $str";
$result = trim(shell_exec($cmd));
$passed3 = $result == $str;
$help = "";
if (!$passed3) {
$help .= t('The command line version of PHP on your system does not have "register_argc_argv" enabled.'). EOL;
$help .= t('This is required for message delivery to work.');
}
check_add($checks, t('PHP register_argc_argv'), $passed3, true, $help);
2010-08-16 00:49:29 -04:00
}
2010-08-16 00:49:29 -04:00
}
function check_keys(&$checks) {
$help = '';
$res = false;
if (function_exists('openssl_pkey_new')) {
$res = openssl_pkey_new([
'digest_alg' => 'sha1',
'private_key_bits' => 4096,
'encrypt_key' => false
]);
}
// Get private key
if (! $res) {
$help .= t('Error: the "openssl_pkey_new" function on this system is not able to generate encryption keys'). EOL;
$help .= t('If running under Windows, please see "http://www.php.net/manual/en/openssl.installation.php".');
2010-12-22 17:07:27 -05:00
}
check_add($checks, t('Generate encryption keys'), $res, true, $help);
}
function check_funcs(&$checks) {
$ck_funcs = [];
check_add($ck_funcs, t('libCurl PHP module'), true, true, "");
check_add($ck_funcs, t('GD graphics PHP module'), true, true, "");
check_add($ck_funcs, t('OpenSSL PHP module'), true, true, "");
check_add($ck_funcs, t('PDO or MySQLi PHP module'), true, true, "");
check_add($ck_funcs, t('mb_string PHP module'), true, true, "");
2016-04-27 14:16:35 -04:00
check_add($ck_funcs, t('XML PHP module'), true, true, "");
check_add($ck_funcs, t('iconv module'), true, true, "");
if (function_exists('apache_get_modules')) {
if (! in_array('mod_rewrite',apache_get_modules())) {
2012-04-17 01:58:52 -04:00
check_add($ck_funcs, t('Apache mod_rewrite module'), false, true, t('Error: Apache webserver mod-rewrite module is required but not installed.'));
} else {
2012-04-17 01:58:52 -04:00
check_add($ck_funcs, t('Apache mod_rewrite module'), true, true, "");
}
}
if (! function_exists('curl_init')) {
$ck_funcs[0]['status'] = false;
$ck_funcs[0]['help'] = t('Error: libCURL PHP module required but not installed.');
}
if (! function_exists('imagecreatefromjpeg')) {
$ck_funcs[1]['status'] = false;
$ck_funcs[1]['help'] = t('Error: GD graphics PHP module with JPEG support required but not installed.');
}
if (! function_exists('openssl_public_encrypt')) {
$ck_funcs[2]['status'] = false;
$ck_funcs[2]['help'] = t('Error: openssl PHP module required but not installed.');
}
if (! function_exists('mysqli_connect') && !class_exists('pdo')) {
$ck_funcs[3]['status'] = false;
$ck_funcs[3]['help'] = t('Error: PDO or MySQLi PHP module required but not installed.');
}
2017-04-25 02:10:14 -04:00
if (!function_exists('mysqli_connect') && class_exists('pdo') && !in_array('mysql', PDO::getAvailableDrivers())) {
$ck_funcs[3]['status'] = false;
$ck_funcs[3]['help'] = t('Error: The MySQL driver for PDO is not installed.');
}
if (! function_exists('mb_strlen')) {
$ck_funcs[4]['status'] = false;
$ck_funcs[4]['help'] = t('Error: mb_string PHP module required but not installed.');
}
if (! function_exists('iconv_strlen')) {
$ck_funcs[7]['status'] = false;
$ck_funcs[7]['help'] = t('Error: iconv PHP module required but not installed.');
}
$checks = array_merge($checks, $ck_funcs);
2016-04-27 14:16:35 -04:00
// check for XML DOM Documents being able to be generated
try {
$xml = new DOMDocument();
} catch (Exception $e) {
2016-04-27 14:23:06 -04:00
$ck_funcs[6]['status'] = false;
$ck_funcs[6]['help'] = t('Error, XML PHP module required but not installed.');
2016-04-27 14:16:35 -04:00
}
}
function check_htconfig(&$checks) {
$status = true;
$help = "";
if ((file_exists('.htconfig.php') && !is_writable('.htconfig.php')) ||
(!file_exists('.htconfig.php') && !is_writable('.'))) {
$status = false;
$help = t('The web installer needs to be able to create a file called ".htconfig.php" in the top folder of your web server and it is unable to do so.') .EOL;
$help .= t('This is most often a permission setting, as the web server may not be able to write files in your folder - even if you can.').EOL;
$help .= t('At the end of this procedure, we will give you a text to save in a file named .htconfig.php in your Friendica top folder.').EOL;
$help .= t('You can alternatively skip this procedure and perform a manual installation. Please see the file "INSTALL.txt" for instructions.').EOL;
2010-08-16 00:49:29 -04:00
}
check_add($checks, t('.htconfig.php is writable'), $status, false, $help);
2010-08-16 00:49:29 -04:00
}
function check_smarty3(&$checks) {
$status = true;
$help = "";
if (!is_writable('view/smarty3')) {
$status = false;
$help = t('Friendica uses the Smarty3 template engine to render its web views. Smarty3 compiles templates to PHP to speed up rendering.') .EOL;
$help .= t('In order to store these compiled templates, the web server needs to have write access to the directory view/smarty3/ under the Friendica top level folder.').EOL;
$help .= t('Please ensure that the user that your web server runs as (e.g. www-data) has write access to this folder.').EOL;
$help .= t('Note: as a security measure, you should give the web server write access to view/smarty3/ only--not the template files (.tpl) that it contains.').EOL;
}
check_add($checks, t('view/smarty3 is writable'), $status, true, $help);
}
function check_htaccess(&$checks) {
$status = true;
$help = "";
if (function_exists('curl_init')) {
$test = fetch_url(System::baseUrl()."/install/testrewrite");
if ($test != "ok") {
$test = fetch_url(normalise_link(System::baseUrl()."/install/testrewrite"));
}
if ($test != "ok") {
$status = false;
$help = t('Url rewrite in .htaccess is not working. Check your server configuration.');
}
check_add($checks, t('Url rewrite is working'), $status, true, $help);
} else {
// cannot check modrewrite if libcurl is not installed
/// @TODO Maybe issue warning here?
}
}
function check_imagik(&$checks) {
$imagick = false;
$gif = false;
if (class_exists('Imagick')) {
$imagick = true;
$supported = Image::supportedTypes();
if (array_key_exists('image/gif', $supported)) {
$gif = true;
}
}
if ($imagick == false) {
check_add($checks, t('ImageMagick PHP extension is not installed'), $imagick, false, "");
} else {
check_add($checks, t('ImageMagick PHP extension is installed'), $imagick, false, "");
if ($imagick) {
check_add($checks, t('ImageMagick supports GIF'), $gif, false, "");
}
}
}
function manual_config(App $a) {
$data = htmlentities($a->data['txt'],ENT_COMPAT, 'UTF-8');
$o = t('The database configuration file ".htconfig.php" could not be written. Please use the enclosed text to create a configuration file in your web server root.');
2010-11-15 22:27:15 -05:00
$o .= "<textarea rows=\"24\" cols=\"80\" >$data</textarea>";
return $o;
2010-08-16 00:49:29 -04:00
}
function load_database_rem($v, $i) {
$l = trim($i);
if (strlen($l)>1 && ($l[0] == "-" || ($l[0] == "/" && $l[1] == "*"))) {
return $v;
} else {
return $v."\n".$i;
}
}
2017-10-11 08:56:36 -04:00
function load_database() {
2017-12-14 17:18:53 -05:00
$errors = DBStructure::update(false, true);
2010-08-16 00:49:29 -04:00
return $errors;
}
2012-04-17 01:58:52 -04:00
function what_next() {
$baseurl = System::baseUrl();
return
t('<h1>What next</h1>')
2017-11-19 16:47:21 -05:00
."<p>".t('IMPORTANT: You will need to [manually] setup a scheduled task for the worker.')
.t('Please see the file "INSTALL.txt".')
."</p><p>"
2012-09-02 04:47:04 -04:00
.t("Go to your new Friendica node <a href='$baseurl/register'>registration page</a> and register as new user. Remember to use the same email you have entered as administrator email. This will allow you to enter the site admin panel.")
."</p>";
}