lib/installer.php

   1 <?php
   2
   3 /**
   4  * StatusNet - the distributed open-source microblogging tool
   5  * Copyright (C) 2009-2010, StatusNet, Inc.
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  *
  20  * @category Installation
  21  * @package  Installation
  22  *
  23  * @author   Adrian Lang <mail@adrianlang.de>
  24  * @author   Brenda Wallace <shiny@cpan.org>
  25  * @author   Brett Taylor <brett@webfroot.co.nz>
  26  * @author   Brion Vibber <brion@pobox.com>
  27  * @author   CiaranG <ciaran@ciarang.com>
  28  * @author   Craig Andrews <candrews@integralblue.com>
  29  * @author   Eric Helgeson <helfire@Erics-MBP.local>
  30  * @author   Evan Prodromou <evan@status.net>
  31  * @author   Mikael Nordfeldth <mmn@hethane.se>
  32  * @author   Robin Millette <millette@controlyourself.ca>
  33  * @author   Sarven Capadisli <csarven@status.net>
  34  * @author   Tom Adams <tom@holizz.com>
  35  * @author   Zach Copley <zach@status.net>
  36  * @copyright 2009-2010 StatusNet, Inc http://status.net
  37  * @copyright 2009-2014 Free Software Foundation, Inc http://www.fsf.org
  38  * @license  GNU Affero General Public License http://www.gnu.org/licenses/
  39  * @version  1.0.x
  40  * @link     http://status.net
  41  */
  42
  43 abstract class Installer
  44 {
  45     /** Web site info */
  46     public $sitename, $server, $path, $fancy, $siteProfile, $ssl;
  47     /** DB info */
  48     public $host, $database, $dbtype, $username, $password, $db;
  49     /** Storage info */
  50     public $avatarDir, $fileDir;
  51     /** Administrator info */
  52     public $adminNick, $adminPass, $adminEmail;
  53     /** Should we skip writing the configuration file? */
  54     public $skipConfig = false;
  55
  56     public static $dbModules = array(
  57         'mysql' => array(
  58             'name' => 'MariaDB (or MySQL 5.5+)',
  59             'check_module' => 'mysqli',
  60             'scheme' => 'mysqli', // DSN prefix for PEAR::DB
  61         ),
  62 /*        'pgsql' => array(
  63             'name' => 'PostgreSQL',
  64             'check_module' => 'pgsql',
  65             'scheme' => 'pgsql', // DSN prefix for PEAR::DB
  66         ),*/
  67     );
  68
  69     /**
  70      * Attempt to include a PHP file and report if it worked, while
  71      * suppressing the annoying warning messages on failure.
  72      */
  73     private function haveIncludeFile($filename) {
  74         $old = error_reporting(error_reporting() & ~E_WARNING);
  75         $ok = include_once($filename);
  76         error_reporting($old);
  77         return $ok;
  78     }
  79
  80     /**
  81      * Check if all is ready for installation
  82      *
  83      * @return void
  84      */
  85     function checkPrereqs()
  86     {
  87         $pass = true;
  88
  89         $config = INSTALLDIR.'/config.php';
  90         if (!$this->skipConfig && file_exists($config)) {
  91             if (!is_writable($config) || filesize($config) > 0) {
  92                 if (filesize($config) == 0) {
  93                     $this->warning('Config file "config.php" already exists and is empty, but is not writable.');
  94                 } else {
  95                     $this->warning('Config file "config.php" already exists.');
  96                 }
  97                 $pass = false;
  98             }
  99         }
 100
 101         if (version_compare(PHP_VERSION, '5.5.0', '<')) {
 102             $this->warning('Require PHP version 5.5.0 or greater.');
 103             $pass = false;
 104         }
 105
 106         $reqs = array('gd', 'curl', 'intl', 'json',
 107                       'xmlwriter', 'mbstring', 'xml', 'dom', 'simplexml');
 108
 109         foreach ($reqs as $req) {
 110             if (!$this->checkExtension($req)) {
 111                 $this->warning(sprintf('Cannot load required extension: <code>%s</code>', $req));
 112                 $pass = false;
 113             }
 114         }
 115
 116         // Make sure we have at least one database module available
 117         $missingExtensions = array();
 118         foreach (self::$dbModules as $type => $info) {
 119             if (!$this->checkExtension($info['check_module'])) {
 120                 $missingExtensions[] = $info['check_module'];
 121             }
 122         }
 123
 124         if (count($missingExtensions) == count(self::$dbModules)) {
 125             $req = implode(', ', $missingExtensions);
 126             $this->warning(sprintf('Cannot find a database extension. You need at least one of %s.', $req));
 127             $pass = false;
 128         }
 129
 130         // @fixme this check seems to be insufficient with Windows ACLs
 131         if (!$this->skipConfig && !is_writable(INSTALLDIR)) {
 132             $this->warning(sprintf('Cannot write config file to: <code>%s</code></p>', INSTALLDIR),
 133                            sprintf('On your server, try this command: <code>chmod a+w %s</code>', INSTALLDIR));
 134             $pass = false;
 135         }
 136
 137         // Check the subdirs used for file uploads
 138         // TODO get another flag for this --skipFileSubdirCreation
 139         if (!$this->skipConfig) {
 140             define('GNUSOCIAL', true);
 141             define('STATUSNET', true);
 142             require_once INSTALLDIR . '/lib/language.php';
 143             $_server=$this->server; $_path=$this->path; // We won't be using those so it's safe to do this small hack
 144             require_once INSTALLDIR.DIRECTORY_SEPARATOR.'lib'.DIRECTORY_SEPARATOR.'default.php';
 145             $fileSubdirs = [empty($this->avatarDir) ? $default['avatar']['dir'] : $this->avatarDir,
 146                             empty($this->fileDir)   ? $default['attachments']['dir'] : $this->fileDir];
 147             unset($default);
 148             foreach ($fileSubdirs as $fileFullPath) {
 149                 if (!file_exists($fileFullPath)) {
 150                     $pass = $pass && mkdir($fileFullPath);
 151                 } elseif (!is_dir($fileFullPath)) {
 152                     $this->warning(sprintf('GNU social expected a directory but found something else on this path: %s', $fileFullPath),
 153                                    'Either make sure it goes to a directory or remove it and a directory will be created.');
 154                     $pass = false;
 155                 } elseif (!is_writable($fileFullPath)) {
 156                     $this->warning(sprintf('Cannot write to %s directory: <code>%s</code>', $fileSubdir, $fileFullPath),
 157                                    sprintf('On your server, try this command: <code>chmod a+w %s</code>', $fileFullPath));
 158                     $pass = false;
 159                 }
 160             }
 161         }
 162         return $pass;
 163     }
 164
 165     /**
 166      * Checks if a php extension is both installed and loaded
 167      *
 168      * @param string $name of extension to check
 169      *
 170      * @return boolean whether extension is installed and loaded
 171      */
 172     function checkExtension($name)
 173     {
 174         if (extension_loaded($name)) {
 175             return true;
 176         } elseif (function_exists('dl') && ini_get('enable_dl') && !ini_get('safe_mode')) {
 177             // dl will throw a fatal error if it's disabled or we're in safe mode.
 178             // More fun, it may not even exist under some SAPIs in 5.3.0 or later...
 179             $soname = $name . '.' . PHP_SHLIB_SUFFIX;
 180             if (PHP_SHLIB_SUFFIX == 'dll') {
 181                 $soname = "php_" . $soname;
 182             }
 183             return @dl($soname);
 184         } else {
 185             return false;
 186         }
 187     }
 188
 189     /**
 190      * Basic validation on the database paramters
 191      * Side effects: error output if not valid
 192      *
 193      * @return boolean success
 194      */
 195     function validateDb()
 196     {
 197         $fail = false;
 198
 199         if (empty($this->host)) {
 200             $this->updateStatus("No hostname specified.", true);
 201             $fail = true;
 202         }
 203
 204         if (empty($this->database)) {
 205             $this->updateStatus("No database specified.", true);
 206             $fail = true;
 207         }
 208
 209         if (empty($this->username)) {
 210             $this->updateStatus("No username specified.", true);
 211             $fail = true;
 212         }
 213
 214         if (empty($this->sitename)) {
 215             $this->updateStatus("No sitename specified.", true);
 216             $fail = true;
 217         }
 218
 219         return !$fail;
 220     }
 221
 222     /**
 223      * Basic validation on the administrator user paramters
 224      * Side effects: error output if not valid
 225      *
 226      * @return boolean success
 227      */
 228     function validateAdmin()
 229     {
 230         $fail = false;
 231
 232         if (empty($this->adminNick)) {
 233             $this->updateStatus("No initial user nickname specified.", true);
 234             $fail = true;
 235         }
 236         if ($this->adminNick && !preg_match('/^[0-9a-z]{1,64}$/', $this->adminNick)) {
 237             $this->updateStatus('The user nickname "' . htmlspecialchars($this->adminNick) .
 238                          '" is invalid; should be plain letters and numbers no longer than 64 characters.', true);
 239             $fail = true;
 240         }
 241         // @fixme hardcoded list; should use Nickname::isValid()
 242         // if/when it's safe to have loaded the infrastructure here
 243         $blacklist = array('main', 'panel', 'twitter', 'settings', 'rsd.xml', 'favorited', 'featured', 'favoritedrss', 'featuredrss', 'rss', 'getfile', 'api', 'groups', 'group', 'peopletag', 'tag', 'user', 'message', 'conversation', 'notice', 'attachment', 'search', 'index.php', 'doc', 'opensearch', 'robots.txt', 'xd_receiver.html', 'facebook', 'activity');
 244         if (in_array($this->adminNick, $blacklist)) {
 245             $this->updateStatus('The user nickname "' . htmlspecialchars($this->adminNick) .
 246                          '" is reserved.', true);
 247             $fail = true;
 248         }
 249
 250         if (empty($this->adminPass)) {
 251             $this->updateStatus("No initial user password specified.", true);
 252             $fail = true;
 253         }
 254
 255         return !$fail;
 256     }
 257
 258     /**
 259      * Make sure a site profile was selected
 260      *
 261      * @return type boolean success
 262      */
 263     function validateSiteProfile()
 264     {
 265         if (empty($this->siteProfile))  {
 266             $this->updateStatus("No site profile selected.", true);
 267             return false;
 268         }
 269
 270         return true;
 271     }
 272
 273     /**
 274      * Set up the database with the appropriate function for the selected type...
 275      * Saves database info into $this->db.
 276      *
 277      * @fixme escape things in the connection string in case we have a funny pass etc
 278      * @return mixed array of database connection params on success, false on failure
 279      */
 280     function setupDatabase()
 281     {
 282         if ($this->db) {
 283             throw new Exception("Bad order of operations: DB already set up.");
 284         }
 285         $this->updateStatus("Starting installation...");
 286
 287         if (empty($this->password)) {
 288             $auth = '';
 289         } else {
 290             $auth = ":$this->password";
 291         }
 292         $scheme = self::$dbModules[$this->dbtype]['scheme'];
 293         $dsn = "{$scheme}://{$this->username}{$auth}@{$this->host}/{$this->database}";
 294
 295         $this->updateStatus("Checking database...");
 296         $conn = $this->connectDatabase($dsn);
 297
 298         if (!$conn instanceof DB_common) {
 299             // Is not the right instance
 300             throw new Exception('Cannot connect to database: ' . $conn->getMessage());
 301         }
 302
 303         // ensure database encoding is UTF8
 304         if ($this->dbtype == 'mysql') {
 305             // @fixme utf8m4 support for mysql 5.5?
 306             // Force the comms charset to utf8 for sanity
 307             // This doesn't currently work. :P
 308             //$conn->executes('set names utf8');
 309         } else if ($this->dbtype == 'pgsql') {
 310             $record = $conn->getRow('SHOW server_encoding');
 311             if ($record->server_encoding != 'UTF8') {
 312                 $this->updateStatus("GNU social requires UTF8 character encoding. Your database is ". htmlentities($record->server_encoding));
 313                 return false;
 314             }
 315         }
 316
 317         $res = $this->updateStatus("Creating database tables...");
 318         if (!$this->createCoreTables($conn)) {
 319             $this->updateStatus("Error creating tables.", true);
 320             return false;
 321         }
 322
 323         foreach (array('sms_carrier' => 'SMS carrier',
 324                     'notice_source' => 'notice source',
 325                     'foreign_services' => 'foreign service')
 326               as $scr => $name) {
 327             $this->updateStatus(sprintf("Adding %s data to database...", $name));
 328             $res = $this->runDbScript($scr.'.sql', $conn);
 329             if ($res === false) {
 330                 $this->updateStatus(sprintf("Can't run %s script.", $name), true);
 331                 return false;
 332             }
 333         }
 334
 335         $db = array('type' => $this->dbtype, 'database' => $dsn);
 336         return $db;
 337     }
 338
 339     /**
 340      * Open a connection to the database.
 341      *
 342      * @param <type> $dsn
 343      * @return <type>
 344      */
 345     function connectDatabase($dsn)
 346     {
 347         global $_DB;
 348         return $_DB->connect($dsn);
 349     }
 350
 351     /**
 352      * Create core tables on the given database connection.
 353      *
 354      * @param DB_common $conn
 355      */
 356     function createCoreTables(DB_common $conn)
 357     {
 358         $schema = Schema::get($conn);
 359         $tableDefs = $this->getCoreSchema();
 360         foreach ($tableDefs as $name => $def) {
 361             if (defined('DEBUG_INSTALLER')) {
 362                 echo " $name ";
 363             }
 364             $schema->ensureTable($name, $def);
 365         }
 366         return true;
 367     }
 368
 369     /**
 370      * Fetch the core table schema definitions.
 371      *
 372      * @return array of table names => table def arrays
 373      */
 374     function getCoreSchema()
 375     {
 376         $schema = array();
 377         include INSTALLDIR . '/db/core.php';
 378         return $schema;
 379     }
 380
 381     /**
 382      * Return a parseable PHP literal for the given value.
 383      * This will include quotes for strings, etc.
 384      *
 385      * @param mixed $val
 386      * @return string
 387      */
 388     function phpVal($val)
 389     {
 390         return var_export($val, true);
 391     }
 392
 393     /**
 394      * Return an array of parseable PHP literal for the given values.
 395      * These will include quotes for strings, etc.
 396      *
 397      * @param mixed $val
 398      * @return array
 399      */
 400     function phpVals($map)
 401     {
 402         return array_map(array($this, 'phpVal'), $map);
 403     }
 404
 405     /**
 406      * Write a stock configuration file.
 407      *
 408      * @return boolean success
 409      *
 410      * @fixme escape variables in output in case we have funny chars, apostrophes etc
 411      */
 412     function writeConf()
 413     {
 414         $vals = $this->phpVals(array(
 415             'sitename' => $this->sitename,
 416             'server' => $this->server,
 417             'path' => $this->path,
 418             'ssl' => in_array($this->ssl, array('never', 'always'))
 419                      ? $this->ssl
 420                      : 'never',
 421             'db_database' => $this->db['database'],
 422             'db_type' => $this->db['type']
 423         ));
 424
 425         // assemble configuration file in a string
 426         $cfg =  "<?php\n".
 427                 "if (!defined('GNUSOCIAL')) { exit(1); }\n\n".
 428
 429                 // site name
 430                 "\$config['site']['name'] = {$vals['sitename']};\n\n".
 431
 432                 // site location
 433                 "\$config['site']['server'] = {$vals['server']};\n".
 434                 "\$config['site']['path'] = {$vals['path']}; \n\n".
 435                 "\$config['site']['ssl'] = {$vals['ssl']}; \n\n".
 436
 437                 // checks if fancy URLs are enabled
 438                 ($this->fancy ? "\$config['site']['fancy'] = true;\n\n":'').
 439
 440                 // database
 441                 "\$config['db']['database'] = {$vals['db_database']};\n\n".
 442                 ($this->db['type'] == 'pgsql' ? "\$config['db']['quote_identifiers'] = true;\n\n":'').
 443                 "\$config['db']['type'] = {$vals['db_type']};\n\n".
 444
 445                 "// Uncomment below for better performance. Just remember you must run\n".
 446                 "// php scripts/checkschema.php whenever your enabled plugins change!\n".
 447                 "//\$config['db']['schemacheck'] = 'script';\n\n";
 448
 449         // Normalize line endings for Windows servers
 450         $cfg = str_replace("\n", PHP_EOL, $cfg);
 451
 452         // write configuration file out to install directory
 453         $res = file_put_contents(INSTALLDIR.'/config.php', $cfg);
 454
 455         return $res;
 456     }
 457
 458     /**
 459      * Write the site profile. We do this after creating the initial user
 460      * in case the site profile is set to single user. This gets around the
 461      * 'chicken-and-egg' problem of the system requiring a valid user for
 462      * single user mode, before the intial user is actually created. Yeah,
 463      * we should probably do this in smarter way.
 464      *
 465      * @return int res number of bytes written
 466      */
 467     function writeSiteProfile()
 468     {
 469         $vals = $this->phpVals(array(
 470             'site_profile' => $this->siteProfile,
 471             'nickname' => $this->adminNick
 472         ));
 473
 474         $cfg =
 475         // site profile
 476         "\$config['site']['profile'] = {$vals['site_profile']};\n";
 477
 478         if ($this->siteProfile == "singleuser") {
 479             $cfg .= "\$config['singleuser']['nickname'] = {$vals['nickname']};\n\n";
 480         } else {
 481             $cfg .= "\n";
 482         }
 483
 484         // Normalize line endings for Windows servers
 485         $cfg = str_replace("\n", PHP_EOL, $cfg);
 486
 487         // write configuration file out to install directory
 488         $res = file_put_contents(INSTALLDIR.'/config.php', $cfg, FILE_APPEND);
 489
 490         return $res;
 491     }
 492
 493     /**
 494      * Install schema into the database
 495      *
 496      * @param string    $filename location of database schema file
 497      * @param DB_common $conn     connection to database
 498      *
 499      * @return boolean - indicating success or failure
 500      */
 501     function runDbScript($filename, DB_common $conn)
 502     {
 503         $sql = trim(file_get_contents(INSTALLDIR . '/db/' . $filename));
 504         $stmts = explode(';', $sql);
 505         foreach ($stmts as $stmt) {
 506             $stmt = trim($stmt);
 507             if (!mb_strlen($stmt)) {
 508                 continue;
 509             }
 510             try {
 511                 $res = $conn->simpleQuery($stmt);
 512             } catch (Exception $e) {
 513                 $error = $e->getMessage();
 514                 $this->updateStatus("ERROR ($error) for SQL '$stmt'");
 515                 return false;
 516             }
 517         }
 518         return true;
 519     }
 520
 521     /**
 522      * Create the initial admin user account.
 523      * Side effect: may load portions of GNU social framework.
 524      * Side effect: outputs program info
 525      */
 526     function registerInitialUser()
 527     {
 528         // initalize hostname from install arguments, so it can be used to find
 529         // the /etc config file from the commandline installer
 530         $server = $this->server;
 531         require_once INSTALLDIR . '/lib/common.php';
 532
 533         $data = array('nickname' => $this->adminNick,
 534                       'password' => $this->adminPass,
 535                       'fullname' => $this->adminNick);
 536         if ($this->adminEmail) {
 537             $data['email'] = $this->adminEmail;
 538         }
 539         try {
 540             $user = User::register($data, true);    // true to skip email sending verification
 541         } catch (Exception $e) {
 542             return false;
 543         }
 544
 545         // give initial user carte blanche
 546
 547         $user->grantRole('owner');
 548         $user->grantRole('moderator');
 549         $user->grantRole('administrator');
 550
 551         return true;
 552     }
 553
 554     /**
 555      * The beef of the installer!
 556      * Create database, config file, and admin user.
 557      *
 558      * Prerequisites: validation of input data.
 559      *
 560      * @return boolean success
 561      */
 562     function doInstall()
 563     {
 564         global $config;
 565
 566         $this->updateStatus("Initializing...");
 567         ini_set('display_errors', 1);
 568         error_reporting(E_ALL & ~E_STRICT & ~E_NOTICE);
 569         if (!defined('GNUSOCIAL')) {
 570             define('GNUSOCIAL', true);
 571         }
 572         if (!defined('STATUSNET')) {
 573             define('STATUSNET', true);
 574         }
 575
 576         require_once INSTALLDIR . '/lib/framework.php';
 577         GNUsocial::initDefaults($this->server, $this->path);
 578
 579         if ($this->siteProfile == "singleuser") {
 580             // Until we use ['site']['profile']==='singleuser' everywhere
 581             $config['singleuser']['enabled'] = true;
 582         }
 583
 584         try {
 585             $this->db = $this->setupDatabase();
 586             if (!$this->db) {
 587                 // database connection failed, do not move on to create config file.
 588                 return false;
 589             }
 590         } catch (Exception $e) {
 591             // Lower-level DB error!
 592             $this->updateStatus("Database error: " . $e->getMessage(), true);
 593             return false;
 594         }
 595
 596         if (!$this->skipConfig) {
 597         // Make sure we can write to the file twice
 598         $oldUmask = umask(000);
 599
 600             $this->updateStatus("Writing config file...");
 601             $res = $this->writeConf();
 602
 603             if (!$res) {
 604                 $this->updateStatus("Can't write config file.", true);
 605                 return false;
 606             }
 607         }
 608
 609         if (!empty($this->adminNick)) {
 610             // Okay, cross fingers and try to register an initial user
 611             if ($this->registerInitialUser()) {
 612                 $this->updateStatus(
 613                     "An initial user with the administrator role has been created."
 614                 );
 615             } else {
 616                 $this->updateStatus(
 617                     "Could not create initial user account.",
 618                     true
 619                 );
 620                 return false;
 621             }
 622         }
 623
 624         if (!$this->skipConfig) {
 625             $this->updateStatus("Setting site profile...");
 626             $res = $this->writeSiteProfile();
 627
 628             if (!$res) {
 629                 $this->updateStatus("Can't write to config file.", true);
 630                 return false;
 631             }
 632
 633         // Restore original umask
 634         umask($oldUmask);
 635         // Set permissions back to something decent
 636         chmod(INSTALLDIR.'/config.php', 0644);
 637         }
 638
 639         $scheme = $this->ssl === 'always' ? 'https' : 'http';
 640         $link = "{$scheme}://{$this->server}/{$this->path}";
 641
 642         $this->updateStatus("GNU social has been installed at $link");
 643         $this->updateStatus(
 644             '<strong>DONE!</strong> You can visit your <a href="'.htmlspecialchars($link).'">new GNU social site</a> (log in as "'.htmlspecialchars($this->adminNick).'"). If this is your first GNU social install, make your experience the best possible by visiting our resource site to join the <a href="https://gnu.io/social/resources/">mailing list or IRC</a>. <a href="'.htmlspecialchars($link).'/doc/faq">FAQ is found here</a>.'
 645         );
 646
 647         return true;
 648     }
 649
 650     /**
 651      * Output a pre-install-time warning message
 652      * @param string $message HTML ok, but should be plaintext-able
 653      * @param string $submessage HTML ok, but should be plaintext-able
 654      */
 655     abstract function warning($message, $submessage='');
 656
 657     /**
 658      * Output an install-time progress message
 659      * @param string $message HTML ok, but should be plaintext-able
 660      * @param boolean $error true if this should be marked as an error condition
 661      */
 662     abstract function updateStatus($status, $error=false);
 663
 664 }