mod/install.php

   1 <?php
   2
   3 $install_wizard_pass=1;
   4
   5
   6 function install_init(&$a){
   7
   8         // $baseurl/install/testrwrite to test if rewite in .htaccess is working
   9         if ($a->argc==2 && $a->argv[1]=="testrewrite") {
  10                 echo "ok";
  11                 killme();
  12         }
  13         global $install_wizard_pass;
  14         if (x($_POST,'pass'))
  15                 $install_wizard_pass = intval($_POST['pass']);
  16
  17 }
  18
  19 function install_post(&$a) {
  20         global $install_wizard_pass, $db;
  21
  22         switch($install_wizard_pass) {
  23                 case 1:
  24                 case 2:
  25                         return;
  26                         break; // just in case return don't return :)
  27                 case 3:
  28                         $urlpath = $a->get_path();
  29                         $dbhost = notags(trim($_POST['dbhost']));
  30                         $dbuser = notags(trim($_POST['dbuser']));
  31                         $dbpass = notags(trim($_POST['dbpass']));
  32                         $dbdata = notags(trim($_POST['dbdata']));
  33                         $phpath = notags(trim($_POST['phpath']));
  34
  35                         require_once("dba.php");
  36                         unset($db);
  37                         $db = new dba($dbhost, $dbuser, $dbpass, $dbdata, true);
  38                         /*if(get_db_errno()) {
  39                                 unset($db);
  40                                 $db = new dba($dbhost, $dbuser, $dbpass, '', true);
  41
  42                                 if(! get_db_errno()) {
  43                                         $r = q("CREATE DATABASE '%s'",
  44                                                         dbesc($dbdata)
  45                                         );
  46                                         if($r) {
  47                                                 unset($db);
  48                                                 $db = new dba($dbhost, $dbuser, $dbpass, $dbdata, true);
  49                                         } else {
  50                                                 $a->data['db_create_failed']=true;
  51                                         }
  52                                 } else {
  53                                         $a->data['db_conn_failed']=true;
  54                                         return;
  55                                 }
  56                         }*/
  57                         if(get_db_errno()) {
  58                                 $a->data['db_conn_failed']=true;
  59                         }
  60
  61                         return;
  62                         break;
  63                 case 4:
  64                         $urlpath = $a->get_path();
  65                         $dbhost = notags(trim($_POST['dbhost']));
  66                         $dbuser = notags(trim($_POST['dbuser']));
  67                         $dbpass = notags(trim($_POST['dbpass']));
  68                         $dbdata = notags(trim($_POST['dbdata']));
  69                         $phpath = notags(trim($_POST['phpath']));
  70                         $timezone = notags(trim($_POST['timezone']));
  71                         $adminmail = notags(trim($_POST['adminmail']));
  72
  73                         // connect to db
  74                         $db = new dba($dbhost, $dbuser, $dbpass, $dbdata, true);
  75
  76                         $tpl = get_intltext_template('htconfig.tpl');
  77                         $txt = replace_macros($tpl,array(
  78                                 '$dbhost' => $dbhost,
  79                                 '$dbuser' => $dbuser,
  80                                 '$dbpass' => $dbpass,
  81                                 '$dbdata' => $dbdata,
  82                                 '$timezone' => $timezone,
  83                                 '$urlpath' => $urlpath,
  84                                 '$phpath' => $phpath,
  85                                 '$adminmail' => $adminmail
  86                         ));
  87
  88                         $result = file_put_contents('.htconfig.php', $txt);
  89                         if(! $result) {
  90                                 $a->data['txt'] = $txt;
  91                         }
  92
  93                         $errors = load_database($db);
  94
  95                         if($errors)
  96                                 $a->data['db_failed'] = $errors;
  97                         else
  98                                 $a->data['db_installed'] = true;
  99
 100                         return;
 101                 break;
 102         }
 103 }
 104
 105 function get_db_errno() {
 106         if(class_exists('mysqli'))
 107                 return mysqli_connect_errno();
 108         else
 109                 return mysql_errno();
 110 }
 111
 112 function install_content(&$a) {
 113
 114         global $install_wizard_pass, $db;
 115         $o = '';
 116         $wizard_status = "";
 117         $install_title = t('Friendica Social Communications Server - Setup');
 118
 119
 120
 121         if(x($a->data,'db_conn_failed')) {
 122                 $install_wizard_pass = 2;
 123                 $wizard_status =  t('Could not connect to database.');
 124         }
 125         if(x($a->data,'db_create_failed')) {
 126                 $install_wizard_pass = 2;
 127                 $wizard_status =  t('Could not create table.');
 128         }
 129
 130         $db_return_text="";
 131         if(x($a->data,'db_installed')) {
 132                 $txt = '<p style="font-size: 130%;">';
 133                 $txt .= t('Your Friendica site database has been installed.') . EOL;
 134                 $db_return_text .= $txt;
 135         }
 136
 137         if(x($a->data,'db_failed')) {
 138                 $txt = t('You may need to import the file "database.sql" manually using phpmyadmin or mysql.') . EOL;
 139                 $txt .= t('Please see the file "INSTALL.txt".') . EOL ."<hr>" ;
 140                 $txt .= "<pre>".$a->data['db_failed'] . "</pre>". EOL ;
 141                 $db_return_text .= $txt;
 142         }
 143
 144         if($db && $db->connected) {
 145                 $r = q("SELECT COUNT(*) as `total` FROM `user`");
 146                 if($r && count($r) && $r[0]['total']) {
 147                         $tpl = get_markup_template('install.tpl');
 148                         return replace_macros($tpl, array(
 149                                 '$title' => $install_title,
 150                                 '$pass' => '',
 151                                 '$status' => t('Permission denied.'),
 152                                 '$text' => '',
 153                         ));
 154                 }
 155         }
 156
 157         if(x($a->data,'txt') && strlen($a->data['txt'])) {
 158                 $db_return_text .= manual_config($a);
 159         }
 160
 161         if ($db_return_text!="") {
 162                 $tpl = get_markup_template('install.tpl');
 163                 return replace_macros($tpl, array(
 164                         '$title' => $install_title,
 165                         '$pass' => "",
 166                         '$text' => $db_return_text . what_next(),
 167                 ));
 168         }
 169
 170         switch ($install_wizard_pass){
 171                 case 1: { // System check
 172
 173
 174                         $checks = array();
 175
 176                         check_funcs($checks);
 177
 178                         check_htconfig($checks);
 179
 180                         check_smarty3($checks);
 181
 182                         check_keys($checks);
 183
 184                         if(x($_POST,'phpath'))
 185                                 $phpath = notags(trim($_POST['phpath']));
 186
 187                         check_php($phpath, $checks);
 188
 189             check_htaccess($checks);
 190
 191                         function check_passed($v, $c){
 192                                 if ($c['required'])
 193                                         $v = $v && $c['status'];
 194                                 return $v;
 195                         }
 196                         $checkspassed = array_reduce($checks, "check_passed", true);
 197
 198
 199
 200                         $tpl = get_markup_template('install_checks.tpl');
 201                         $o .= replace_macros($tpl, array(
 202                                 '$title' => $install_title,
 203                                 '$pass' => t('System check'),
 204                                 '$checks' => $checks,
 205                                 '$passed' => $checkspassed,
 206                                 '$see_install' => t('Please see the file "INSTALL.txt".'),
 207                                 '$next' => t('Next'),
 208                                 '$reload' => t('Check again'),
 209                                 '$phpath' => $phpath,
 210                                 '$baseurl' => $a->get_baseurl(),
 211                         ));
 212                         return $o;
 213                 }; break;
 214
 215                 case 2: { // Database config
 216
 217                         $dbhost = ((x($_POST,'dbhost')) ? notags(trim($_POST['dbhost'])) : 'localhost');
 218                         $dbuser = notags(trim($_POST['dbuser']));
 219                         $dbpass = notags(trim($_POST['dbpass']));
 220                         $dbdata = notags(trim($_POST['dbdata']));
 221                         $phpath = notags(trim($_POST['phpath']));
 222
 223
 224                         $tpl = get_markup_template('install_db.tpl');
 225
 226                         $includes = array(
 227                                 '$field_input'  => 'field_input.tpl',
 228                                 '$field_password' => 'field_password.tpl',
 229                         );
 230                         $includes = set_template_includes($a->theme['template_engine'], $includes);
 231
 232                         $o .= replace_macros($tpl,$includes + array(
 233                                 '$title' => $install_title,
 234                                 '$pass' => t('Database connection'),
 235                                 '$info_01' => t('In order to install Friendica we need to know how to connect to your database.'),
 236                                 '$info_02' => t('Please contact your hosting provider or site administrator if you have questions about these settings.'),
 237                                 '$info_03' => t('The database you specify below should already exist. If it does not, please create it before continuing.'),
 238
 239                                 '$status' => $wizard_status,
 240
 241                                 '$dbhost' => array('dbhost', t('Database Server Name'), $dbhost, ''),
 242                                 '$dbuser' => array('dbuser', t('Database Login Name'), $dbuser, ''),
 243                                 '$dbpass' => array('dbpass', t('Database Login Password'), $dbpass, ''),
 244                                 '$dbdata' => array('dbdata', t('Database Name'), $dbdata, ''),
 245                                 '$adminmail' => array('adminmail', t('Site administrator email address'), $adminmail, t('Your account email address must match this in order to use the web admin panel.')),
 246
 247
 248
 249                                 '$lbl_10' => t('Please select a default timezone for your website'),
 250
 251                                 '$baseurl' => $a->get_baseurl(),
 252
 253                                 '$phpath' => $phpath,
 254
 255                                 '$submit' => t('Submit'),
 256
 257                         ));
 258                         return $o;
 259                 }; break;
 260                 case 3: { // Site settings
 261                         require_once('datetime.php');
 262                         $dbhost = ((x($_POST,'dbhost')) ? notags(trim($_POST['dbhost'])) : 'localhost');
 263                         $dbuser = notags(trim($_POST['dbuser']));
 264                         $dbpass = notags(trim($_POST['dbpass']));
 265                         $dbdata = notags(trim($_POST['dbdata']));
 266                         $phpath = notags(trim($_POST['phpath']));
 267
 268                         $adminmail = notags(trim($_POST['adminmail']));
 269                         $timezone = ((x($_POST,'timezone')) ? ($_POST['timezone']) : 'America/Los_Angeles');
 270
 271                         $tpl = get_markup_template('install_settings.tpl');
 272
 273                         $includes = array(
 274                                 '$field_input' => 'field_input.tpl',
 275                         );
 276                         $includes = set_template_includes($a->theme['template_engine'], $includes);
 277
 278                         $o .= replace_macros($tpl, $includes + array(
 279                                 '$title' => $install_title,
 280                                 '$pass' => t('Site settings'),
 281
 282                                 '$status' => $wizard_status,
 283
 284                                 '$dbhost' => $dbhost,
 285                                 '$dbuser' => $dbuser,
 286                                 '$dbpass' => $dbpass,
 287                                 '$dbdata' => $dbdata,
 288                                 '$phpath' => $phpath,
 289
 290                                 '$adminmail' => array('adminmail', t('Site administrator email address'), $adminmail, t('Your account email address must match this in order to use the web admin panel.')),
 291
 292
 293                                 '$timezone' => field_timezone('timezone', t('Please select a default timezone for your website'), $timezone, ''),
 294
 295                                 '$baseurl' => $a->get_baseurl(),
 296
 297
 298
 299                                 '$submit' => t('Submit'),
 300
 301                         ));
 302                         return $o;
 303                 }; break;
 304
 305         }
 306 }
 307
 308 /**
 309  * checks   : array passed to template
 310  * title    : string
 311  * status   : boolean
 312  * required : boolean
 313  * help         : string optional
 314  */
 315 function check_add(&$checks, $title, $status, $required, $help){
 316         $checks[] = array(
 317                 'title' => $title,
 318                 'status' => $status,
 319                 'required' => $required,
 320                 'help'  => $help,
 321         );
 322 }
 323
 324 function check_php(&$phpath, &$checks) {
 325         if (strlen($phpath)){
 326                 $passed = file_exists($phpath);
 327         } else {
 328                 $phpath = trim(shell_exec('which php'));
 329                 $passed = strlen($phpath);
 330         }
 331         $help = "";
 332         if(!$passed) {
 333                 $help .= t('Could not find a command line version of PHP in the web server PATH.'). EOL;
 334                 $help .= t("If you don't have a command line version of PHP installed on server, you will not be able to run background polling via cron. See <a href='http://friendica.com/node/27'>'Activating scheduled tasks'</a>") . EOL ;
 335                 $help .= EOL . EOL ;
 336                 $tpl = get_markup_template('field_input.tpl');
 337                 $help .= replace_macros($tpl, array(
 338                         '$field' => array('phpath', t('PHP executable path'), $phpath, t('Enter full path to php executable. You can leave this blank to continue the installation.')),
 339                 ));
 340                 $phpath="";
 341         }
 342
 343         check_add($checks, t('Command line PHP').($passed?" (<tt>$phpath</tt>)":""), $passed, false, $help);
 344
 345         if($passed) {
 346                 $str = autoname(8);
 347                 $cmd = "$phpath testargs.php $str";
 348                 $result = trim(shell_exec($cmd));
 349                 $passed2 = $result == $str;
 350                 $help = "";
 351                 if(!$passed2) {
 352                         $help .= t('The command line version of PHP on your system does not have "register_argc_argv" enabled.'). EOL;
 353                         $help .= t('This is required for message delivery to work.');
 354                 }
 355                 check_add($checks, t('PHP register_argc_argv'), $passed, true, $help);
 356         }
 357
 358
 359 }
 360
 361 function check_keys(&$checks) {
 362
 363         $help = '';
 364
 365         $res = false;
 366
 367         if(function_exists('openssl_pkey_new'))
 368                 $res=openssl_pkey_new(array(
 369                 'digest_alg' => 'sha1',
 370                 'private_key_bits' => 4096,
 371                 'encrypt_key' => false ));
 372
 373         // Get private key
 374
 375         if(! $res) {
 376                 $help .= t('Error: the "openssl_pkey_new" function on this system is not able to generate encryption keys'). EOL;
 377                 $help .= t('If running under Windows, please see "http://www.php.net/manual/en/openssl.installation.php".');
 378         }
 379         check_add($checks, t('Generate encryption keys'), $res, true, $help);
 380
 381 }
 382
 383
 384 function check_funcs(&$checks) {
 385         $ck_funcs = array();
 386         check_add($ck_funcs, t('libCurl PHP module'), true, true, "");
 387         check_add($ck_funcs, t('GD graphics PHP module'), true, true, "");
 388         check_add($ck_funcs, t('OpenSSL PHP module'), true, true, "");
 389         check_add($ck_funcs, t('mysqli PHP module'), true, true, "");
 390         check_add($ck_funcs, t('mb_string PHP module'), true, true, "");
 391
 392
 393         if(function_exists('apache_get_modules')){
 394                 if (! in_array('mod_rewrite',apache_get_modules())) {
 395                         check_add($ck_funcs, t('Apache mod_rewrite module'), false, true, t('Error: Apache webserver mod-rewrite module is required but not installed.'));
 396                 } else {
 397                         check_add($ck_funcs, t('Apache mod_rewrite module'), true, true, "");
 398                 }
 399         }
 400
 401         if(! function_exists('curl_init')){
 402                 $ck_funcs[0]['status']= false;
 403                 $ck_funcs[0]['help']= t('Error: libCURL PHP module required but not installed.');
 404         }
 405         if(! function_exists('imagecreatefromjpeg')){
 406                 $ck_funcs[1]['status']= false;
 407                 $ck_funcs[1]['help']= t('Error: GD graphics PHP module with JPEG support required but not installed.');
 408         }
 409         if(! function_exists('openssl_public_encrypt')) {
 410                 $ck_funcs[2]['status']= false;
 411                 $ck_funcs[2]['help']= t('Error: openssl PHP module required but not installed.');
 412         }
 413         if(! function_exists('mysqli_connect')){
 414                 $ck_funcs[3]['status']= false;
 415                 $ck_funcs[3]['help']= t('Error: mysqli PHP module required but not installed.');
 416         }
 417         if(! function_exists('mb_strlen')){
 418                 $ck_funcs[4]['status']= false;
 419                 $ck_funcs[4]['help']= t('Error: mb_string PHP module required but not installed.');
 420         }
 421
 422         $checks = array_merge($checks, $ck_funcs);
 423
 424         /*if((x($_SESSION,'sysmsg')) && is_array($_SESSION['sysmsg']) && count($_SESSION['sysmsg']))
 425                 notice( t('Please see the file "INSTALL.txt".') . EOL);*/
 426 }
 427
 428
 429 function check_htconfig(&$checks) {
 430         $status = true;
 431         $help = "";
 432         if(     (file_exists('.htconfig.php') && !is_writable('.htconfig.php')) ||
 433                 (!file_exists('.htconfig.php') && !is_writable('.')) ) {
 434
 435                 $status=false;
 436                 $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;
 437                 $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;
 438                 $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;
 439                 $help .= t('You can alternatively skip this procedure and perform a manual installation. Please see the file "INSTALL.txt" for instructions.').EOL;
 440         }
 441
 442         check_add($checks, t('.htconfig.php is writable'), $status, false, $help);
 443
 444 }
 445
 446 function check_smarty3(&$checks) {
 447         $status = true;
 448         $help = "";
 449         if(     !is_writable('view/smarty3') ) {
 450
 451                 $status=false;
 452                 $help = t('Friendica uses the Smarty3 template engine to render its web views. Smarty3 compiles templates to PHP to speed up rendering.') .EOL;
 453                 $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;
 454                 $help .= t('Please ensure that the user that your web server runs as (e.g. www-data) has write access to this folder.').EOL;
 455                 $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;
 456         }
 457
 458         check_add($checks, t('view/smarty3 is writable'), $status, true, $help);
 459
 460 }
 461
 462 function check_htaccess(&$checks) {
 463         $a = get_app();
 464         $status = true;
 465         $help = "";
 466         if (function_exists('curl_init')){
 467         $test = fetch_url($a->get_baseurl()."/install/testrewrite");
 468         if ($test!="ok") {
 469             $status = false;
 470             $help = t('Url rewrite in .htaccess is not working. Check your server configuration.');
 471         }
 472         check_add($checks, t('Url rewrite is working'), $status, true, $help);
 473     } else {
 474         // cannot check modrewrite if libcurl is not installed
 475     }
 476
 477 }
 478
 479
 480 function manual_config(&$a) {
 481         $data = htmlentities($a->data['txt'],ENT_COMPAT,'UTF-8');
 482         $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.');
 483         $o .= "<textarea rows=\"24\" cols=\"80\" >$data</textarea>";
 484         return $o;
 485 }
 486
 487 function load_database_rem($v, $i){
 488         $l = trim($i);
 489         if (strlen($l)>1 && ($l[0]=="-" || ($l[0]=="/" && $l[1]=="*"))){
 490                 return $v;
 491         } else  {
 492                 return $v."\n".$i;
 493         }
 494 }
 495
 496
 497 function load_database($db) {
 498
 499         $str = file_get_contents('database.sql');
 500         $arr = explode(';',$str);
 501         $errors = false;
 502         foreach($arr as $a) {
 503                 if(strlen(trim($a))) {
 504                         $r = @$db->q(trim($a));
 505                         if(! $r) {
 506                                 $errors .=  t('Errors encountered creating database tables.') . $a . EOL;
 507                         }
 508                 }
 509         }
 510         return $errors;
 511 }
 512
 513 function what_next() {
 514         $a = get_app();
 515         $baseurl = $a->get_baseurl();
 516         return
 517                 t('<h1>What next</h1>')
 518                 ."<p>".t('IMPORTANT: You will need to [manually] setup a scheduled task for the poller.')
 519                 .t('Please see the file "INSTALL.txt".')
 520                 ."</p><p>"
 521                 .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.")
 522                 ."</p>";
 523 }
 524
 525