3 * @file mod/install.php
7 use Friendica\Core\L10n;
8 use Friendica\Core\System;
9 use Friendica\Database\DBM;
10 use Friendica\Database\DBStructure;
11 use Friendica\Object\Image;
12 use Friendica\Util\Network;
13 use Friendica\Util\Temporal;
15 $install_wizard_pass = 1;
17 function install_init(App $a) {
19 // $baseurl/install/testrwrite to test if rewite in .htaccess is working
20 if ($a->argc == 2 && $a->argv[1] == "testrewrite") {
25 // We overwrite current theme css, because during install we could not have a working mod_rewrite
26 // so we could not have a css at all. Here we set a static css file for the install procedure pages
27 $a->config['system']['theme'] = "../install";
28 $a->theme['stylesheet'] = System::baseUrl()."/view/install/style.css";
30 global $install_wizard_pass;
31 if (x($_POST, 'pass')) {
32 $install_wizard_pass = intval($_POST['pass']);
37 function install_post(App $a) {
38 global $install_wizard_pass;
40 switch($install_wizard_pass) {
44 break; // just in case return don't return :)
46 $urlpath = $a->get_path();
47 $dbhost = notags(trim($_POST['dbhost']));
48 $dbuser = notags(trim($_POST['dbuser']));
49 $dbpass = notags(trim($_POST['dbpass']));
50 $dbdata = notags(trim($_POST['dbdata']));
51 $phpath = notags(trim($_POST['phpath']));
53 require_once("include/dba.php");
54 if (!dba::connect($dbhost, $dbuser, $dbpass, $dbdata, true)) {
55 $a->data['db_conn_failed'] = true;
61 $urlpath = $a->get_path();
62 $dbhost = notags(trim($_POST['dbhost']));
63 $dbuser = notags(trim($_POST['dbuser']));
64 $dbpass = notags(trim($_POST['dbpass']));
65 $dbdata = notags(trim($_POST['dbdata']));
66 $phpath = notags(trim($_POST['phpath']));
67 $timezone = notags(trim($_POST['timezone']));
68 $language = notags(trim($_POST['language']));
69 $adminmail = notags(trim($_POST['adminmail']));
73 dba::connect($dbhost, $dbuser, $dbpass, $dbdata, true);
75 $tpl = get_markup_template('htconfig.tpl');
76 $txt = replace_macros($tpl,[
81 '$timezone' => $timezone,
82 '$language' => $language,
83 '$urlpath' => $urlpath,
85 '$adminmail' => $adminmail,
90 $result = file_put_contents('.htconfig.php', $txt);
92 $a->data['txt'] = $txt;
95 $errors = load_database();
99 $a->data['db_failed'] = $errors;
101 $a->data['db_installed'] = true;
109 function install_content(App $a) {
111 global $install_wizard_pass;
114 $install_title = L10n::t('Friendica Communications Server - Setup');
118 if (x($a->data, 'db_conn_failed')) {
119 $install_wizard_pass = 2;
120 $wizard_status = L10n::t('Could not connect to database.');
122 if (x($a->data, 'db_create_failed')) {
123 $install_wizard_pass = 2;
124 $wizard_status = L10n::t('Could not create table.');
127 $db_return_text = "";
128 if (x($a->data, 'db_installed')) {
129 $txt = '<p style="font-size: 130%;">';
130 $txt .= L10n::t('Your Friendica site database has been installed.') . EOL;
131 $db_return_text .= $txt;
134 if (x($a->data, 'db_failed')) {
135 $txt = L10n::t('You may need to import the file "database.sql" manually using phpmyadmin or mysql.') . EOL;
136 $txt .= L10n::t('Please see the file "INSTALL.txt".') . EOL ."<hr>";
137 $txt .= "<pre>".$a->data['db_failed'] . "</pre>". EOL;
138 $db_return_text .= $txt;
141 if (dba::$connected) {
142 $r = q("SELECT COUNT(*) as `total` FROM `user`");
143 if (DBM::is_result($r) && $r[0]['total']) {
144 $tpl = get_markup_template('install.tpl');
145 return replace_macros($tpl, [
146 '$title' => $install_title,
148 '$status' => L10n::t('Database already in use.'),
154 if (x($a->data, 'txt') && strlen($a->data['txt'])) {
155 $db_return_text .= manual_config($a);
158 if ($db_return_text != "") {
159 $tpl = get_markup_template('install.tpl');
160 return replace_macros($tpl, [
161 '$title' => $install_title,
163 '$text' => $db_return_text . what_next(),
167 switch ($install_wizard_pass) {
168 case 1: { // System check
173 check_funcs($checks);
175 check_imagik($checks);
177 check_htconfig($checks);
179 check_smarty3($checks);
183 if (x($_POST, 'phpath')) {
184 $phpath = notags(trim($_POST['phpath']));
187 check_php($phpath, $checks);
189 check_htaccess($checks);
191 /// @TODO Maybe move this out?
192 function check_passed($v, $c) {
193 if ($c['required']) {
194 $v = $v && $c['status'];
198 $checkspassed = array_reduce($checks, "check_passed", true);
202 $tpl = get_markup_template('install_checks.tpl');
203 $o .= replace_macros($tpl, [
204 '$title' => $install_title,
205 '$pass' => L10n::t('System check'),
206 '$checks' => $checks,
207 '$passed' => $checkspassed,
208 '$see_install' => L10n::t('Please see the file "INSTALL.txt".'),
209 '$next' => L10n::t('Next'),
210 '$reload' => L10n::t('Check again'),
211 '$phpath' => $phpath,
212 '$baseurl' => System::baseUrl(),
217 case 2: { // Database config
219 $dbhost = ((x($_POST, 'dbhost')) ? notags(trim($_POST['dbhost'])) : 'localhost');
220 $dbuser = notags(trim($_POST['dbuser']));
221 $dbpass = notags(trim($_POST['dbpass']));
222 $dbdata = notags(trim($_POST['dbdata']));
223 $phpath = notags(trim($_POST['phpath']));
226 $tpl = get_markup_template('install_db.tpl');
227 $o .= replace_macros($tpl, [
228 '$title' => $install_title,
229 '$pass' => L10n::t('Database connection'),
230 '$info_01' => L10n::t('In order to install Friendica we need to know how to connect to your database.'),
231 '$info_02' => L10n::t('Please contact your hosting provider or site administrator if you have questions about these settings.'),
232 '$info_03' => L10n::t('The database you specify below should already exist. If it does not, please create it before continuing.'),
234 '$status' => $wizard_status,
236 '$dbhost' => ['dbhost', L10n::t('Database Server Name'), $dbhost, '', 'required'],
237 '$dbuser' => ['dbuser', L10n::t('Database Login Name'), $dbuser, '', 'required', 'autofocus'],
238 '$dbpass' => ['dbpass', L10n::t('Database Login Password'), $dbpass, L10n::t("For security reasons the password must not be empty"), 'required'],
239 '$dbdata' => ['dbdata', L10n::t('Database Name'), $dbdata, '', 'required'],
240 '$adminmail' => ['adminmail', L10n::t('Site administrator email address'), $adminmail, L10n::t('Your account email address must match this in order to use the web admin panel.'), 'required', 'autofocus', 'email'],
244 '$lbl_10' => L10n::t('Please select a default timezone for your website'),
246 '$baseurl' => System::baseUrl(),
248 '$phpath' => $phpath,
250 '$submit' => L10n::t('Submit'),
255 case 3: { // Site settings
256 $dbhost = ((x($_POST, 'dbhost')) ? notags(trim($_POST['dbhost'])) : 'localhost');
257 $dbuser = notags(trim($_POST['dbuser']));
258 $dbpass = notags(trim($_POST['dbpass']));
259 $dbdata = notags(trim($_POST['dbdata']));
260 $phpath = notags(trim($_POST['phpath']));
262 $adminmail = notags(trim($_POST['adminmail']));
263 $timezone = ((x($_POST, 'timezone')) ? ($_POST['timezone']) : 'America/Los_Angeles');
264 /* Installed langs */
265 $lang_choices = L10n::getAvailableLanguages();
267 $tpl = get_markup_template('install_settings.tpl');
268 $o .= replace_macros($tpl, [
269 '$title' => $install_title,
270 '$pass' => L10n::t('Site settings'),
272 '$status' => $wizard_status,
274 '$dbhost' => $dbhost,
275 '$dbuser' => $dbuser,
276 '$dbpass' => $dbpass,
277 '$dbdata' => $dbdata,
278 '$phpath' => $phpath,
280 '$adminmail' => ['adminmail', L10n::t('Site administrator email address'), $adminmail, L10n::t('Your account email address must match this in order to use the web admin panel.'), 'required', 'autofocus', 'email'],
283 '$timezone' => Temporal::getTimezoneField('timezone', L10n::t('Please select a default timezone for your website'), $timezone, ''),
284 '$language' => ['language', L10n::t('System Language:'), 'en', L10n::t('Set the default language for your Friendica installation interface and to send emails.'), $lang_choices],
285 '$baseurl' => System::baseUrl(),
289 '$submit' => L10n::t('Submit'),
299 * checks : array passed to template
303 * help : string optional
305 function check_add(&$checks, $title, $status, $required, $help) {
309 'required' => $required,
314 function check_php(&$phpath, &$checks) {
315 $passed = $passed2 = $passed3 = false;
316 if (strlen($phpath)) {
317 $passed = file_exists($phpath);
319 $phpath = trim(shell_exec('which php'));
320 $passed = strlen($phpath);
324 $help .= L10n::t('Could not find a command line version of PHP in the web server PATH.'). EOL;
325 $help .= L10n::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;
327 $tpl = get_markup_template('field_input.tpl');
328 $help .= replace_macros($tpl, [
329 '$field' => ['phpath', L10n::t('PHP executable path'), $phpath, L10n::t('Enter full path to php executable. You can leave this blank to continue the installation.')],
334 check_add($checks, L10n::t('Command line PHP').($passed?" (<tt>$phpath</tt>)":""), $passed, false, $help);
338 $result = trim(shell_exec($cmd));
339 $passed2 = ( strpos($result, "(cli)") !== false);
340 list($result) = explode("\n", $result);
343 $help .= L10n::t("PHP executable is not the php cli binary \x28could be cgi-fgci version\x29"). EOL;
344 $help .= L10n::t('Found PHP version: ')."<tt>$result</tt>";
346 check_add($checks, L10n::t('PHP cli binary'), $passed2, true, $help);
352 $cmd = "$phpath testargs.php $str";
353 $result = trim(shell_exec($cmd));
354 $passed3 = $result == $str;
357 $help .= L10n::t('The command line version of PHP on your system does not have "register_argc_argv" enabled.'). EOL;
358 $help .= L10n::t('This is required for message delivery to work.');
360 check_add($checks, L10n::t('PHP register_argc_argv'), $passed3, true, $help);
366 function check_keys(&$checks) {
372 if (function_exists('openssl_pkey_new')) {
373 $res = openssl_pkey_new([
374 'digest_alg' => 'sha1',
375 'private_key_bits' => 4096,
376 'encrypt_key' => false
383 $help .= L10n::t('Error: the "openssl_pkey_new" function on this system is not able to generate encryption keys'). EOL;
384 $help .= L10n::t('If running under Windows, please see "http://www.php.net/manual/en/openssl.installation.php".');
386 check_add($checks, L10n::t('Generate encryption keys'), $res, true, $help);
391 function check_funcs(&$checks) {
393 check_add($ck_funcs, L10n::t('libCurl PHP module'), true, true, "");
394 check_add($ck_funcs, L10n::t('GD graphics PHP module'), true, true, "");
395 check_add($ck_funcs, L10n::t('OpenSSL PHP module'), true, true, "");
396 check_add($ck_funcs, L10n::t('PDO or MySQLi PHP module'), true, true, "");
397 check_add($ck_funcs, L10n::t('mb_string PHP module'), true, true, "");
398 check_add($ck_funcs, L10n::t('XML PHP module'), true, true, "");
399 check_add($ck_funcs, L10n::t('iconv module'), true, true, "");
401 if (function_exists('apache_get_modules')) {
402 if (! in_array('mod_rewrite',apache_get_modules())) {
403 check_add($ck_funcs, L10n::t('Apache mod_rewrite module'), false, true, L10n::t('Error: Apache webserver mod-rewrite module is required but not installed.'));
405 check_add($ck_funcs, L10n::t('Apache mod_rewrite module'), true, true, "");
409 if (! function_exists('curl_init')) {
410 $ck_funcs[0]['status'] = false;
411 $ck_funcs[0]['help'] = L10n::t('Error: libCURL PHP module required but not installed.');
413 if (! function_exists('imagecreatefromjpeg')) {
414 $ck_funcs[1]['status'] = false;
415 $ck_funcs[1]['help'] = L10n::t('Error: GD graphics PHP module with JPEG support required but not installed.');
417 if (! function_exists('openssl_public_encrypt')) {
418 $ck_funcs[2]['status'] = false;
419 $ck_funcs[2]['help'] = L10n::t('Error: openssl PHP module required but not installed.');
421 if (! function_exists('mysqli_connect') && !class_exists('pdo')) {
422 $ck_funcs[3]['status'] = false;
423 $ck_funcs[3]['help'] = L10n::t('Error: PDO or MySQLi PHP module required but not installed.');
425 if (!function_exists('mysqli_connect') && class_exists('pdo') && !in_array('mysql', PDO::getAvailableDrivers())) {
426 $ck_funcs[3]['status'] = false;
427 $ck_funcs[3]['help'] = L10n::t('Error: The MySQL driver for PDO is not installed.');
429 if (! function_exists('mb_strlen')) {
430 $ck_funcs[4]['status'] = false;
431 $ck_funcs[4]['help'] = L10n::t('Error: mb_string PHP module required but not installed.');
433 if (! function_exists('iconv_strlen')) {
434 $ck_funcs[7]['status'] = false;
435 $ck_funcs[7]['help'] = L10n::t('Error: iconv PHP module required but not installed.');
438 $checks = array_merge($checks, $ck_funcs);
440 // check for XML DOM Documents being able to be generated
442 $xml = new DOMDocument();
443 } catch (Exception $e) {
444 $ck_funcs[6]['status'] = false;
445 $ck_funcs[6]['help'] = L10n::t('Error, XML PHP module required but not installed.');
450 function check_htconfig(&$checks) {
453 if ((file_exists('.htconfig.php') && !is_writable('.htconfig.php')) ||
454 (!file_exists('.htconfig.php') && !is_writable('.'))) {
457 $help = L10n::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;
458 $help .= L10n::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;
459 $help .= L10n::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;
460 $help .= L10n::t('You can alternatively skip this procedure and perform a manual installation. Please see the file "INSTALL.txt" for instructions.').EOL;
463 check_add($checks, L10n::t('.htconfig.php is writable'), $status, false, $help);
467 function check_smarty3(&$checks) {
470 if (!is_writable('view/smarty3')) {
473 $help = L10n::t('Friendica uses the Smarty3 template engine to render its web views. Smarty3 compiles templates to PHP to speed up rendering.') .EOL;
474 $help .= L10n::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;
475 $help .= L10n::t("Please ensure that the user that your web server runs as \x28e.g. www-data\x29 has write access to this folder.").EOL;
476 $help .= L10n::t("Note: as a security measure, you should give the web server write access to view/smarty3/ only--not the template files \x28.tpl\x29 that it contains.").EOL;
479 check_add($checks, L10n::t('view/smarty3 is writable'), $status, true, $help);
483 function check_htaccess(&$checks) {
486 if (function_exists('curl_init')) {
487 $test = Network::fetchUrl(System::baseUrl()."/install/testrewrite");
490 $test = Network::fetchUrl(normalise_link(System::baseUrl()."/install/testrewrite"));
495 $help = L10n::t('Url rewrite in .htaccess is not working. Check your server configuration.');
497 check_add($checks, L10n::t('Url rewrite is working'), $status, true, $help);
499 // cannot check modrewrite if libcurl is not installed
500 /// @TODO Maybe issue warning here?
504 function check_imagik(&$checks) {
508 if (class_exists('Imagick')) {
510 $supported = Image::supportedTypes();
511 if (array_key_exists('image/gif', $supported)) {
515 if ($imagick == false) {
516 check_add($checks, L10n::t('ImageMagick PHP extension is not installed'), $imagick, false, "");
518 check_add($checks, L10n::t('ImageMagick PHP extension is installed'), $imagick, false, "");
520 check_add($checks, L10n::t('ImageMagick supports GIF'), $gif, false, "");
525 function manual_config(App $a) {
526 $data = htmlentities($a->data['txt'],ENT_COMPAT, 'UTF-8');
527 $o = L10n::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.');
528 $o .= "<textarea rows=\"24\" cols=\"80\" >$data</textarea>";
532 function load_database_rem($v, $i) {
534 if (strlen($l)>1 && ($l[0] == "-" || ($l[0] == "/" && $l[1] == "*"))) {
541 function load_database() {
542 $errors = DBStructure::update(false, true);
547 function what_next() {
548 $baseurl = System::baseUrl();
550 L10n::t('<h1>What next</h1>')
551 ."<p>".L10n::t('IMPORTANT: You will need to [manually] setup a scheduled task for the worker.')
552 .L10n::t('Please see the file "INSTALL.txt".')
554 .L10n::t('Go to your new Friendica node <a href="%s/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.', $baseurl)