4 * StatusNet - the distributed open-source microblogging tool
5 * Copyright (C) 2009-2010, StatusNet, Inc.
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.
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.
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/>.
20 * @category Installation
21 * @package Installation
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/
40 * @link http://status.net
43 abstract class Installer
46 public $sitename, $server, $path, $fancy, $siteProfile, $ssl;
48 public $host, $database, $dbtype, $username, $password, $db;
50 public $avatarDir, $fileDir;
51 /** Administrator info */
52 public $adminNick, $adminPass, $adminEmail;
53 /** Should we skip writing the configuration file? */
54 public $skipConfig = false;
56 public static $dbModules = array(
58 'name' => 'MariaDB (or MySQL 5.5+)',
59 'check_module' => 'mysqli',
60 'scheme' => 'mysqli', // DSN prefix for PEAR::DB
63 'name' => 'PostgreSQL',
64 'check_module' => 'pgsql',
65 'scheme' => 'pgsql', // DSN prefix for PEAR::DB
70 * Attempt to include a PHP file and report if it worked, while
71 * suppressing the annoying warning messages on failure.
73 private function haveIncludeFile($filename) {
74 $old = error_reporting(error_reporting() & ~E_WARNING);
75 $ok = include_once($filename);
76 error_reporting($old);
81 * Check if all is ready for installation
85 function checkPrereqs()
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.');
95 $this->warning('Config file "config.php" already exists.');
101 if (version_compare(PHP_VERSION, '5.5.0', '<')) {
102 $this->warning('Require PHP version 5.5.0 or greater.');
106 $reqs = array('gd', 'curl', 'intl', 'json',
107 'xmlwriter', 'mbstring', 'xml', 'dom', 'simplexml');
109 foreach ($reqs as $req) {
110 if (!$this->checkExtension($req)) {
111 $this->warning(sprintf('Cannot load required extension: <code>%s</code>', $req));
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'];
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));
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));
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];
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.');
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));
166 * Checks if a php extension is both installed and loaded
168 * @param string $name of extension to check
170 * @return boolean whether extension is installed and loaded
172 function checkExtension($name)
174 if (extension_loaded($name)) {
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;
190 * Basic validation on the database paramters
191 * Side effects: error output if not valid
193 * @return boolean success
195 function validateDb()
199 if (empty($this->host)) {
200 $this->updateStatus("No hostname specified.", true);
204 if (empty($this->database)) {
205 $this->updateStatus("No database specified.", true);
209 if (empty($this->username)) {
210 $this->updateStatus("No username specified.", true);
214 if (empty($this->sitename)) {
215 $this->updateStatus("No sitename specified.", true);
223 * Basic validation on the administrator user paramters
224 * Side effects: error output if not valid
226 * @return boolean success
228 function validateAdmin()
232 if (empty($this->adminNick)) {
233 $this->updateStatus("No initial user nickname specified.", true);
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);
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);
250 if (empty($this->adminPass)) {
251 $this->updateStatus("No initial user password specified.", true);
259 * Make sure a site profile was selected
261 * @return type boolean success
263 function validateSiteProfile()
265 if (empty($this->siteProfile)) {
266 $this->updateStatus("No site profile selected.", true);
274 * Set up the database with the appropriate function for the selected type...
275 * Saves database info into $this->db.
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
280 function setupDatabase()
283 throw new Exception("Bad order of operations: DB already set up.");
285 $this->updateStatus("Starting installation...");
287 if (empty($this->password)) {
290 $auth = ":$this->password";
292 $scheme = self::$dbModules[$this->dbtype]['scheme'];
293 $dsn = "{$scheme}://{$this->username}{$auth}@{$this->host}/{$this->database}";
295 $this->updateStatus("Checking database...");
296 $conn = $this->connectDatabase($dsn);
298 if (!$conn instanceof DB_common) {
299 // Is not the right instance
300 throw new Exception('Cannot connect to database: ' . $conn->getMessage());
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));
317 $res = $this->updateStatus("Creating database tables...");
318 if (!$this->createCoreTables($conn)) {
319 $this->updateStatus("Error creating tables.", true);
323 foreach (array('sms_carrier' => 'SMS carrier',
324 'notice_source' => 'notice source',
325 'foreign_services' => 'foreign service')
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);
335 $db = array('type' => $this->dbtype, 'database' => $dsn);
340 * Open a connection to the database.
345 function connectDatabase($dsn)
348 return $_DB->connect($dsn);
352 * Create core tables on the given database connection.
354 * @param DB_common $conn
356 function createCoreTables(DB_common $conn)
358 $schema = Schema::get($conn);
359 $tableDefs = $this->getCoreSchema();
360 foreach ($tableDefs as $name => $def) {
361 if (defined('DEBUG_INSTALLER')) {
364 $schema->ensureTable($name, $def);
370 * Fetch the core table schema definitions.
372 * @return array of table names => table def arrays
374 function getCoreSchema()
377 include INSTALLDIR . '/db/core.php';
382 * Return a parseable PHP literal for the given value.
383 * This will include quotes for strings, etc.
388 function phpVal($val)
390 return var_export($val, true);
394 * Return an array of parseable PHP literal for the given values.
395 * These will include quotes for strings, etc.
400 function phpVals($map)
402 return array_map(array($this, 'phpVal'), $map);
406 * Write a stock configuration file.
408 * @return boolean success
410 * @fixme escape variables in output in case we have funny chars, apostrophes etc
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'))
421 'db_database' => $this->db['database'],
422 'db_type' => $this->db['type']
425 // assemble configuration file in a string
427 "if (!defined('GNUSOCIAL')) { exit(1); }\n\n".
430 "\$config['site']['name'] = {$vals['sitename']};\n\n".
433 "\$config['site']['server'] = {$vals['server']};\n".
434 "\$config['site']['path'] = {$vals['path']}; \n\n".
435 "\$config['site']['ssl'] = {$vals['ssl']}; \n\n".
437 // checks if fancy URLs are enabled
438 ($this->fancy ? "\$config['site']['fancy'] = true;\n\n":'').
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".
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";
449 // Normalize line endings for Windows servers
450 $cfg = str_replace("\n", PHP_EOL, $cfg);
452 // write configuration file out to install directory
453 $res = file_put_contents(INSTALLDIR.'/config.php', $cfg);
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.
465 * @return int res number of bytes written
467 function writeSiteProfile()
469 $vals = $this->phpVals(array(
470 'site_profile' => $this->siteProfile,
471 'nickname' => $this->adminNick
476 "\$config['site']['profile'] = {$vals['site_profile']};\n";
478 if ($this->siteProfile == "singleuser") {
479 $cfg .= "\$config['singleuser']['nickname'] = {$vals['nickname']};\n\n";
484 // Normalize line endings for Windows servers
485 $cfg = str_replace("\n", PHP_EOL, $cfg);
487 // write configuration file out to install directory
488 $res = file_put_contents(INSTALLDIR.'/config.php', $cfg, FILE_APPEND);
494 * Install schema into the database
496 * @param string $filename location of database schema file
497 * @param DB_common $conn connection to database
499 * @return boolean - indicating success or failure
501 function runDbScript($filename, DB_common $conn)
503 $sql = trim(file_get_contents(INSTALLDIR . '/db/' . $filename));
504 $stmts = explode(';', $sql);
505 foreach ($stmts as $stmt) {
507 if (!mb_strlen($stmt)) {
511 $res = $conn->simpleQuery($stmt);
512 } catch (Exception $e) {
513 $error = $e->getMessage();
514 $this->updateStatus("ERROR ($error) for SQL '$stmt'");
522 * Create the initial admin user account.
523 * Side effect: may load portions of GNU social framework.
524 * Side effect: outputs program info
526 function registerInitialUser()
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';
533 $data = array('nickname' => $this->adminNick,
534 'password' => $this->adminPass,
535 'fullname' => $this->adminNick);
536 if ($this->adminEmail) {
537 $data['email'] = $this->adminEmail;
540 $user = User::register($data, true); // true to skip email sending verification
541 } catch (Exception $e) {
545 // give initial user carte blanche
547 $user->grantRole('owner');
548 $user->grantRole('moderator');
549 $user->grantRole('administrator');
555 * The beef of the installer!
556 * Create database, config file, and admin user.
558 * Prerequisites: validation of input data.
560 * @return boolean success
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);
572 if (!defined('STATUSNET')) {
573 define('STATUSNET', true);
576 require_once INSTALLDIR . '/lib/framework.php';
577 GNUsocial::initDefaults($this->server, $this->path);
579 if ($this->siteProfile == "singleuser") {
580 // Until we use ['site']['profile']==='singleuser' everywhere
581 $config['singleuser']['enabled'] = true;
585 $this->db = $this->setupDatabase();
587 // database connection failed, do not move on to create config file.
590 } catch (Exception $e) {
591 // Lower-level DB error!
592 $this->updateStatus("Database error: " . $e->getMessage(), true);
596 if (!$this->skipConfig) {
597 // Make sure we can write to the file twice
598 $oldUmask = umask(000);
600 $this->updateStatus("Writing config file...");
601 $res = $this->writeConf();
604 $this->updateStatus("Can't write config file.", true);
609 if (!empty($this->adminNick)) {
610 // Okay, cross fingers and try to register an initial user
611 if ($this->registerInitialUser()) {
613 "An initial user with the administrator role has been created."
617 "Could not create initial user account.",
624 if (!$this->skipConfig) {
625 $this->updateStatus("Setting site profile...");
626 $res = $this->writeSiteProfile();
629 $this->updateStatus("Can't write to config file.", true);
633 // Restore original umask
635 // Set permissions back to something decent
636 chmod(INSTALLDIR.'/config.php', 0644);
639 $scheme = $this->ssl === 'always' ? 'https' : 'http';
640 $link = "{$scheme}://{$this->server}/{$this->path}";
642 $this->updateStatus("GNU social has been installed at $link");
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>.'
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
655 abstract function warning($message, $submessage='');
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
662 abstract function updateStatus($status, $error=false);