3 * @file mod/install.php
6 use Friendica\Core\L10n;
7 use Friendica\Core\System;
8 use Friendica\Database\DBM;
9 use Friendica\Database\DBStructure;
10 use Friendica\Object\Image;
12 $install_wizard_pass = 1;
14 function install_init(App $a) {
16 // $baseurl/install/testrwrite to test if rewite in .htaccess is working
17 if ($a->argc == 2 && $a->argv[1] == "testrewrite") {
22 // We overwrite current theme css, because during install we could not have a working mod_rewrite
23 // so we could not have a css at all. Here we set a static css file for the install procedure pages
24 $a->config['system']['theme'] = "../install";
25 $a->theme['stylesheet'] = System::baseUrl()."/view/install/style.css";
27 global $install_wizard_pass;
28 if (x($_POST, 'pass')) {
29 $install_wizard_pass = intval($_POST['pass']);
34 function install_post(App $a) {
35 global $install_wizard_pass;
37 switch($install_wizard_pass) {
41 break; // just in case return don't return :)
43 $urlpath = $a->get_path();
44 $dbhost = notags(trim($_POST['dbhost']));
45 $dbuser = notags(trim($_POST['dbuser']));
46 $dbpass = notags(trim($_POST['dbpass']));
47 $dbdata = notags(trim($_POST['dbdata']));
48 $phpath = notags(trim($_POST['phpath']));
50 require_once("include/dba.php");
51 if (!dba::connect($dbhost, $dbuser, $dbpass, $dbdata, true)) {
52 $a->data['db_conn_failed'] = true;
58 $urlpath = $a->get_path();
59 $dbhost = notags(trim($_POST['dbhost']));
60 $dbuser = notags(trim($_POST['dbuser']));
61 $dbpass = notags(trim($_POST['dbpass']));
62 $dbdata = notags(trim($_POST['dbdata']));
63 $phpath = notags(trim($_POST['phpath']));
64 $timezone = notags(trim($_POST['timezone']));
65 $language = notags(trim($_POST['language']));
66 $adminmail = notags(trim($_POST['adminmail']));
70 dba::connect($dbhost, $dbuser, $dbpass, $dbdata, true);
72 $tpl = get_markup_template('htconfig.tpl');
73 $txt = replace_macros($tpl,[
78 '$timezone' => $timezone,
79 '$language' => $language,
80 '$urlpath' => $urlpath,
82 '$adminmail' => $adminmail,
87 $result = file_put_contents('.htconfig.php', $txt);
89 $a->data['txt'] = $txt;
92 $errors = load_database();
96 $a->data['db_failed'] = $errors;
98 $a->data['db_installed'] = true;
106 function install_content(App $a) {
108 global $install_wizard_pass;
111 $install_title = L10n::t('Friendica Communications Server - Setup');
115 if (x($a->data, 'db_conn_failed')) {
116 $install_wizard_pass = 2;
117 $wizard_status = L10n::t('Could not connect to database.');
119 if (x($a->data, 'db_create_failed')) {
120 $install_wizard_pass = 2;
121 $wizard_status = L10n::t('Could not create table.');
124 $db_return_text = "";
125 if (x($a->data, 'db_installed')) {
126 $txt = '<p style="font-size: 130%;">';
127 $txt .= L10n::t('Your Friendica site database has been installed.') . EOL;
128 $db_return_text .= $txt;
131 if (x($a->data, 'db_failed')) {
132 $txt = L10n::t('You may need to import the file "database.sql" manually using phpmyadmin or mysql.') . EOL;
133 $txt .= L10n::t('Please see the file "INSTALL.txt".') . EOL ."<hr>";
134 $txt .= "<pre>".$a->data['db_failed'] . "</pre>". EOL;
135 $db_return_text .= $txt;
138 if (dba::$connected) {
139 $r = q("SELECT COUNT(*) as `total` FROM `user`");
140 if (DBM::is_result($r) && $r[0]['total']) {
141 $tpl = get_markup_template('install.tpl');
142 return replace_macros($tpl, [
143 '$title' => $install_title,
145 '$status' => L10n::t('Database already in use.'),
151 if (x($a->data, 'txt') && strlen($a->data['txt'])) {
152 $db_return_text .= manual_config($a);
155 if ($db_return_text != "") {
156 $tpl = get_markup_template('install.tpl');
157 return replace_macros($tpl, [
158 '$title' => $install_title,
160 '$text' => $db_return_text . what_next(),
164 switch ($install_wizard_pass) {
165 case 1: { // System check
170 check_funcs($checks);
172 check_imagik($checks);
174 check_htconfig($checks);
176 check_smarty3($checks);
180 if (x($_POST, 'phpath')) {
181 $phpath = notags(trim($_POST['phpath']));
184 check_php($phpath, $checks);
186 check_htaccess($checks);
188 /// @TODO Maybe move this out?
189 function check_passed($v, $c) {
190 if ($c['required']) {
191 $v = $v && $c['status'];
195 $checkspassed = array_reduce($checks, "check_passed", true);
199 $tpl = get_markup_template('install_checks.tpl');
200 $o .= replace_macros($tpl, [
201 '$title' => $install_title,
202 '$pass' => L10n::t('System check'),
203 '$checks' => $checks,
204 '$passed' => $checkspassed,
205 '$see_install' => L10n::t('Please see the file "INSTALL.txt".'),
206 '$next' => L10n::t('Next'),
207 '$reload' => L10n::t('Check again'),
208 '$phpath' => $phpath,
209 '$baseurl' => System::baseUrl(),
214 case 2: { // Database config
216 $dbhost = ((x($_POST, 'dbhost')) ? notags(trim($_POST['dbhost'])) : 'localhost');
217 $dbuser = notags(trim($_POST['dbuser']));
218 $dbpass = notags(trim($_POST['dbpass']));
219 $dbdata = notags(trim($_POST['dbdata']));
220 $phpath = notags(trim($_POST['phpath']));
223 $tpl = get_markup_template('install_db.tpl');
224 $o .= replace_macros($tpl, [
225 '$title' => $install_title,
226 '$pass' => L10n::t('Database connection'),
227 '$info_01' => L10n::t('In order to install Friendica we need to know how to connect to your database.'),
228 '$info_02' => L10n::t('Please contact your hosting provider or site administrator if you have questions about these settings.'),
229 '$info_03' => L10n::t('The database you specify below should already exist. If it does not, please create it before continuing.'),
231 '$status' => $wizard_status,
233 '$dbhost' => ['dbhost', L10n::t('Database Server Name'), $dbhost, '', 'required'],
234 '$dbuser' => ['dbuser', L10n::t('Database Login Name'), $dbuser, '', 'required', 'autofocus'],
235 '$dbpass' => ['dbpass', L10n::t('Database Login Password'), $dbpass, L10n::t("For security reasons the password must not be empty"), 'required'],
236 '$dbdata' => ['dbdata', L10n::t('Database Name'), $dbdata, '', 'required'],
237 '$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'],
241 '$lbl_10' => L10n::t('Please select a default timezone for your website'),
243 '$baseurl' => System::baseUrl(),
245 '$phpath' => $phpath,
247 '$submit' => L10n::t('Submit'),
252 case 3: { // Site settings
253 require_once('include/datetime.php');
254 $dbhost = ((x($_POST, 'dbhost')) ? notags(trim($_POST['dbhost'])) : 'localhost');
255 $dbuser = notags(trim($_POST['dbuser']));
256 $dbpass = notags(trim($_POST['dbpass']));
257 $dbdata = notags(trim($_POST['dbdata']));
258 $phpath = notags(trim($_POST['phpath']));
260 $adminmail = notags(trim($_POST['adminmail']));
261 $timezone = ((x($_POST, 'timezone')) ? ($_POST['timezone']) : 'America/Los_Angeles');
262 /* Installed langs */
263 $lang_choices = L10n::getAvailableLanguages();
265 $tpl = get_markup_template('install_settings.tpl');
266 $o .= replace_macros($tpl, [
267 '$title' => $install_title,
268 '$pass' => L10n::t('Site settings'),
270 '$status' => $wizard_status,
272 '$dbhost' => $dbhost,
273 '$dbuser' => $dbuser,
274 '$dbpass' => $dbpass,
275 '$dbdata' => $dbdata,
276 '$phpath' => $phpath,
278 '$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'],
281 '$timezone' => field_timezone('timezone', L10n::t('Please select a default timezone for your website'), $timezone, ''),
282 '$language' => ['language', L10n::t('System Language:'), 'en', L10n::t('Set the default language for your Friendica installation interface and to send emails.'), $lang_choices],
283 '$baseurl' => System::baseUrl(),
287 '$submit' => L10n::t('Submit'),
297 * checks : array passed to template
301 * help : string optional
303 function check_add(&$checks, $title, $status, $required, $help) {
307 'required' => $required,
312 function check_php(&$phpath, &$checks) {
313 $passed = $passed2 = $passed3 = false;
314 if (strlen($phpath)) {
315 $passed = file_exists($phpath);
317 $phpath = trim(shell_exec('which php'));
318 $passed = strlen($phpath);
322 $help .= L10n::t('Could not find a command line version of PHP in the web server PATH.'). EOL;
323 $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;
325 $tpl = get_markup_template('field_input.tpl');
326 $help .= replace_macros($tpl, [
327 '$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.')],
332 check_add($checks, L10n::t('Command line PHP').($passed?" (<tt>$phpath</tt>)":""), $passed, false, $help);
336 $result = trim(shell_exec($cmd));
337 $passed2 = ( strpos($result, "(cli)") !== false);
338 list($result) = explode("\n", $result);
341 $help .= L10n::t('PHP executable is not the php cli binary (could be cgi-fgci version)'). EOL;
342 $help .= L10n::t('Found PHP version: ')."<tt>$result</tt>";
344 check_add($checks, L10n::t('PHP cli binary'), $passed2, true, $help);
350 $cmd = "$phpath testargs.php $str";
351 $result = trim(shell_exec($cmd));
352 $passed3 = $result == $str;
355 $help .= L10n::t('The command line version of PHP on your system does not have "register_argc_argv" enabled.'). EOL;
356 $help .= L10n::t('This is required for message delivery to work.');
358 check_add($checks, L10n::t('PHP register_argc_argv'), $passed3, true, $help);
364 function check_keys(&$checks) {
370 if (function_exists('openssl_pkey_new')) {
371 $res = openssl_pkey_new([
372 'digest_alg' => 'sha1',
373 'private_key_bits' => 4096,
374 'encrypt_key' => false
381 $help .= L10n::t('Error: the "openssl_pkey_new" function on this system is not able to generate encryption keys'). EOL;
382 $help .= L10n::t('If running under Windows, please see "http://www.php.net/manual/en/openssl.installation.php".');
384 check_add($checks, L10n::t('Generate encryption keys'), $res, true, $help);
389 function check_funcs(&$checks) {
391 check_add($ck_funcs, L10n::t('libCurl PHP module'), true, true, "");
392 check_add($ck_funcs, L10n::t('GD graphics PHP module'), true, true, "");
393 check_add($ck_funcs, L10n::t('OpenSSL PHP module'), true, true, "");
394 check_add($ck_funcs, L10n::t('PDO or MySQLi PHP module'), true, true, "");
395 check_add($ck_funcs, L10n::t('mb_string PHP module'), true, true, "");
396 check_add($ck_funcs, L10n::t('XML PHP module'), true, true, "");
397 check_add($ck_funcs, L10n::t('iconv module'), true, true, "");
399 if (function_exists('apache_get_modules')) {
400 if (! in_array('mod_rewrite',apache_get_modules())) {
401 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.'));
403 check_add($ck_funcs, L10n::t('Apache mod_rewrite module'), true, true, "");
407 if (! function_exists('curl_init')) {
408 $ck_funcs[0]['status'] = false;
409 $ck_funcs[0]['help'] = L10n::t('Error: libCURL PHP module required but not installed.');
411 if (! function_exists('imagecreatefromjpeg')) {
412 $ck_funcs[1]['status'] = false;
413 $ck_funcs[1]['help'] = L10n::t('Error: GD graphics PHP module with JPEG support required but not installed.');
415 if (! function_exists('openssl_public_encrypt')) {
416 $ck_funcs[2]['status'] = false;
417 $ck_funcs[2]['help'] = L10n::t('Error: openssl PHP module required but not installed.');
419 if (! function_exists('mysqli_connect') && !class_exists('pdo')) {
420 $ck_funcs[3]['status'] = false;
421 $ck_funcs[3]['help'] = L10n::t('Error: PDO or MySQLi PHP module required but not installed.');
423 if (!function_exists('mysqli_connect') && class_exists('pdo') && !in_array('mysql', PDO::getAvailableDrivers())) {
424 $ck_funcs[3]['status'] = false;
425 $ck_funcs[3]['help'] = L10n::t('Error: The MySQL driver for PDO is not installed.');
427 if (! function_exists('mb_strlen')) {
428 $ck_funcs[4]['status'] = false;
429 $ck_funcs[4]['help'] = L10n::t('Error: mb_string PHP module required but not installed.');
431 if (! function_exists('iconv_strlen')) {
432 $ck_funcs[7]['status'] = false;
433 $ck_funcs[7]['help'] = L10n::t('Error: iconv PHP module required but not installed.');
436 $checks = array_merge($checks, $ck_funcs);
438 // check for XML DOM Documents being able to be generated
440 $xml = new DOMDocument();
441 } catch (Exception $e) {
442 $ck_funcs[6]['status'] = false;
443 $ck_funcs[6]['help'] = L10n::t('Error, XML PHP module required but not installed.');
448 function check_htconfig(&$checks) {
451 if ((file_exists('.htconfig.php') && !is_writable('.htconfig.php')) ||
452 (!file_exists('.htconfig.php') && !is_writable('.'))) {
455 $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;
456 $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;
457 $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;
458 $help .= L10n::t('You can alternatively skip this procedure and perform a manual installation. Please see the file "INSTALL.txt" for instructions.').EOL;
461 check_add($checks, L10n::t('.htconfig.php is writable'), $status, false, $help);
465 function check_smarty3(&$checks) {
468 if (!is_writable('view/smarty3')) {
471 $help = L10n::t('Friendica uses the Smarty3 template engine to render its web views. Smarty3 compiles templates to PHP to speed up rendering.') .EOL;
472 $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;
473 $help .= L10n::t('Please ensure that the user that your web server runs as (e.g. www-data) has write access to this folder.').EOL;
474 $help .= L10n::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;
477 check_add($checks, L10n::t('view/smarty3 is writable'), $status, true, $help);
481 function check_htaccess(&$checks) {
484 if (function_exists('curl_init')) {
485 $test = fetch_url(System::baseUrl()."/install/testrewrite");
488 $test = fetch_url(normalise_link(System::baseUrl()."/install/testrewrite"));
493 $help = L10n::t('Url rewrite in .htaccess is not working. Check your server configuration.');
495 check_add($checks, L10n::t('Url rewrite is working'), $status, true, $help);
497 // cannot check modrewrite if libcurl is not installed
498 /// @TODO Maybe issue warning here?
502 function check_imagik(&$checks) {
506 if (class_exists('Imagick')) {
508 $supported = Image::supportedTypes();
509 if (array_key_exists('image/gif', $supported)) {
513 if ($imagick == false) {
514 check_add($checks, L10n::t('ImageMagick PHP extension is not installed'), $imagick, false, "");
516 check_add($checks, L10n::t('ImageMagick PHP extension is installed'), $imagick, false, "");
518 check_add($checks, L10n::t('ImageMagick supports GIF'), $gif, false, "");
523 function manual_config(App $a) {
524 $data = htmlentities($a->data['txt'],ENT_COMPAT, 'UTF-8');
525 $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.');
526 $o .= "<textarea rows=\"24\" cols=\"80\" >$data</textarea>";
530 function load_database_rem($v, $i) {
532 if (strlen($l)>1 && ($l[0] == "-" || ($l[0] == "/" && $l[1] == "*"))) {
539 function load_database() {
540 $errors = DBStructure::update(false, true);
545 function what_next() {
546 $baseurl = System::baseUrl();
548 L10n::t('<h1>What next</h1>')
549 ."<p>".L10n::t('IMPORTANT: You will need to [manually] setup a scheduled task for the worker.')
550 .L10n::t('Please see the file "INSTALL.txt".')
552 .L10n::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.")