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;
49 /** Administrator info */
50 public $adminNick, $adminPass, $adminEmail;
51 /** Should we skip writing the configuration file? */
52 public $skipConfig = false;
54 public static $dbModules = array(
56 'name' => 'MariaDB (or MySQL 5.5+)',
57 'check_module' => 'mysqli',
58 'scheme' => 'mysqli', // DSN prefix for PEAR::DB
61 'name' => 'PostgreSQL',
62 'check_module' => 'pgsql',
63 'scheme' => 'pgsql', // DSN prefix for PEAR::DB
68 * Attempt to include a PHP file and report if it worked, while
69 * suppressing the annoying warning messages on failure.
71 private function haveIncludeFile($filename) {
72 $old = error_reporting(error_reporting() & ~E_WARNING);
73 $ok = include_once($filename);
74 error_reporting($old);
79 * Check if all is ready for installation
83 function checkPrereqs()
87 $config = INSTALLDIR.'/config.php';
88 if (file_exists($config)) {
89 if (!is_writable($config) || filesize($config) > 0) {
90 if (filesize($config) == 0) {
91 $this->warning('Config file "config.php" already exists and is empty, but is not writable.');
93 $this->warning('Config file "config.php" already exists.');
99 if (version_compare(PHP_VERSION, '5.5.0', '<')) {
100 $this->warning('Require PHP version 5.5.0 or greater.');
104 $reqs = array('gd', 'curl', 'intl', 'json',
105 'xmlwriter', 'mbstring', 'xml', 'dom', 'simplexml');
107 foreach ($reqs as $req) {
108 if (!$this->checkExtension($req)) {
109 $this->warning(sprintf('Cannot load required extension: <code>%s</code>', $req));
114 // Make sure we have at least one database module available
115 $missingExtensions = array();
116 foreach (self::$dbModules as $type => $info) {
117 if (!$this->checkExtension($info['check_module'])) {
118 $missingExtensions[] = $info['check_module'];
122 if (count($missingExtensions) == count(self::$dbModules)) {
123 $req = implode(', ', $missingExtensions);
124 $this->warning(sprintf('Cannot find a database extension. You need at least one of %s.', $req));
128 // @fixme this check seems to be insufficient with Windows ACLs
129 if (!is_writable(INSTALLDIR)) {
130 $this->warning(sprintf('Cannot write config file to: <code>%s</code></p>', INSTALLDIR),
131 sprintf('On your server, try this command: <code>chmod a+w %s</code>', INSTALLDIR));
135 // Check the subdirs used for file uploads
136 $fileSubdirs = array('avatar', 'file');
137 foreach ($fileSubdirs as $fileSubdir) {
138 $fileFullPath = INSTALLDIR."/$fileSubdir";
139 if (!file_exists($fileFullPath)) {
140 $pass = $pass && mkdir($fileFullPath);
141 } elseif (!is_dir($fileFullPath)) {
142 $this->warning(sprintf('GNU social expected a directory but found something else on this path: %s', $fileFullPath),
143 'Either make sure it goes to a directory or remove it and a directory will be created.');
145 } elseif (!is_writable($fileFullPath)) {
146 $this->warning(sprintf('Cannot write to %s directory: <code>%s</code>', $fileSubdir, $fileFullPath),
147 sprintf('On your server, try this command: <code>chmod a+w %s</code>', $fileFullPath));
156 * Checks if a php extension is both installed and loaded
158 * @param string $name of extension to check
160 * @return boolean whether extension is installed and loaded
162 function checkExtension($name)
164 if (extension_loaded($name)) {
166 } elseif (function_exists('dl') && ini_get('enable_dl') && !ini_get('safe_mode')) {
167 // dl will throw a fatal error if it's disabled or we're in safe mode.
168 // More fun, it may not even exist under some SAPIs in 5.3.0 or later...
169 $soname = $name . '.' . PHP_SHLIB_SUFFIX;
170 if (PHP_SHLIB_SUFFIX == 'dll') {
171 $soname = "php_" . $soname;
180 * Basic validation on the database paramters
181 * Side effects: error output if not valid
183 * @return boolean success
185 function validateDb()
189 if (empty($this->host)) {
190 $this->updateStatus("No hostname specified.", true);
194 if (empty($this->database)) {
195 $this->updateStatus("No database specified.", true);
199 if (empty($this->username)) {
200 $this->updateStatus("No username specified.", true);
204 if (empty($this->sitename)) {
205 $this->updateStatus("No sitename specified.", true);
213 * Basic validation on the administrator user paramters
214 * Side effects: error output if not valid
216 * @return boolean success
218 function validateAdmin()
222 if (empty($this->adminNick)) {
223 $this->updateStatus("No initial user nickname specified.", true);
226 if ($this->adminNick && !preg_match('/^[0-9a-z]{1,64}$/', $this->adminNick)) {
227 $this->updateStatus('The user nickname "' . htmlspecialchars($this->adminNick) .
228 '" is invalid; should be plain letters and numbers no longer than 64 characters.', true);
231 // @fixme hardcoded list; should use Nickname::isValid()
232 // if/when it's safe to have loaded the infrastructure here
233 $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');
234 if (in_array($this->adminNick, $blacklist)) {
235 $this->updateStatus('The user nickname "' . htmlspecialchars($this->adminNick) .
236 '" is reserved.', true);
240 if (empty($this->adminPass)) {
241 $this->updateStatus("No initial user password specified.", true);
249 * Make sure a site profile was selected
251 * @return type boolean success
253 function validateSiteProfile()
255 if (empty($this->siteProfile)) {
256 $this->updateStatus("No site profile selected.", true);
264 * Set up the database with the appropriate function for the selected type...
265 * Saves database info into $this->db.
267 * @fixme escape things in the connection string in case we have a funny pass etc
268 * @return mixed array of database connection params on success, false on failure
270 function setupDatabase()
273 throw new Exception("Bad order of operations: DB already set up.");
275 $this->updateStatus("Starting installation...");
277 if (empty($this->password)) {
280 $auth = ":$this->password";
282 $scheme = self::$dbModules[$this->dbtype]['scheme'];
283 $dsn = "{$scheme}://{$this->username}{$auth}@{$this->host}/{$this->database}";
285 $this->updateStatus("Checking database...");
286 $conn = $this->connectDatabase($dsn);
288 if (!$conn instanceof DB_common) {
289 // Is not the right instance
290 throw new Exception('Cannot connect to database: ' . $conn->getMessage());
293 // ensure database encoding is UTF8
294 if ($this->dbtype == 'mysql') {
295 // @fixme utf8m4 support for mysql 5.5?
296 // Force the comms charset to utf8 for sanity
297 // This doesn't currently work. :P
298 //$conn->executes('set names utf8');
299 } else if ($this->dbtype == 'pgsql') {
300 $record = $conn->getRow('SHOW server_encoding');
301 if ($record->server_encoding != 'UTF8') {
302 $this->updateStatus("GNU social requires UTF8 character encoding. Your database is ". htmlentities($record->server_encoding));
307 $res = $this->updateStatus("Creating database tables...");
308 if (!$this->createCoreTables($conn)) {
309 $this->updateStatus("Error creating tables.", true);
313 foreach (array('sms_carrier' => 'SMS carrier',
314 'notice_source' => 'notice source',
315 'foreign_services' => 'foreign service')
317 $this->updateStatus(sprintf("Adding %s data to database...", $name));
318 $res = $this->runDbScript($scr.'.sql', $conn);
319 if ($res === false) {
320 $this->updateStatus(sprintf("Can't run %s script.", $name), true);
325 $db = array('type' => $this->dbtype, 'database' => $dsn);
330 * Open a connection to the database.
335 function connectDatabase($dsn)
338 return $_DB->connect($dsn);
342 * Create core tables on the given database connection.
344 * @param DB_common $conn
346 function createCoreTables(DB_common $conn)
348 $schema = Schema::get($conn);
349 $tableDefs = $this->getCoreSchema();
350 foreach ($tableDefs as $name => $def) {
351 if (defined('DEBUG_INSTALLER')) {
354 $schema->ensureTable($name, $def);
360 * Fetch the core table schema definitions.
362 * @return array of table names => table def arrays
364 function getCoreSchema()
367 include INSTALLDIR . '/db/core.php';
372 * Return a parseable PHP literal for the given value.
373 * This will include quotes for strings, etc.
378 function phpVal($val)
380 return var_export($val, true);
384 * Return an array of parseable PHP literal for the given values.
385 * These will include quotes for strings, etc.
390 function phpVals($map)
392 return array_map(array($this, 'phpVal'), $map);
396 * Write a stock configuration file.
398 * @return boolean success
400 * @fixme escape variables in output in case we have funny chars, apostrophes etc
404 $vals = $this->phpVals(array(
405 'sitename' => $this->sitename,
406 'server' => $this->server,
407 'path' => $this->path,
408 'ssl' => in_array($this->ssl, array('never', 'always'))
411 'db_database' => $this->db['database'],
412 'db_type' => $this->db['type']
415 // assemble configuration file in a string
417 "if (!defined('GNUSOCIAL')) { exit(1); }\n\n".
420 "\$config['site']['name'] = {$vals['sitename']};\n\n".
423 "\$config['site']['server'] = {$vals['server']};\n".
424 "\$config['site']['path'] = {$vals['path']}; \n\n".
425 "\$config['site']['ssl'] = {$vals['ssl']}; \n\n".
427 // checks if fancy URLs are enabled
428 ($this->fancy ? "\$config['site']['fancy'] = true;\n\n":'').
431 "\$config['db']['database'] = {$vals['db_database']};\n\n".
432 ($this->db['type'] == 'pgsql' ? "\$config['db']['quote_identifiers'] = true;\n\n":'').
433 "\$config['db']['type'] = {$vals['db_type']};\n\n".
435 "// Uncomment below for better performance. Just remember you must run\n".
436 "// php scripts/checkschema.php whenever your enabled plugins change!\n".
437 "//\$config['db']['schemacheck'] = 'script';\n\n";
439 // Normalize line endings for Windows servers
440 $cfg = str_replace("\n", PHP_EOL, $cfg);
442 // write configuration file out to install directory
443 $res = file_put_contents(INSTALLDIR.'/config.php', $cfg);
449 * Write the site profile. We do this after creating the initial user
450 * in case the site profile is set to single user. This gets around the
451 * 'chicken-and-egg' problem of the system requiring a valid user for
452 * single user mode, before the intial user is actually created. Yeah,
453 * we should probably do this in smarter way.
455 * @return int res number of bytes written
457 function writeSiteProfile()
459 $vals = $this->phpVals(array(
460 'site_profile' => $this->siteProfile,
461 'nickname' => $this->adminNick
466 "\$config['site']['profile'] = {$vals['site_profile']};\n";
468 if ($this->siteProfile == "singleuser") {
469 $cfg .= "\$config['singleuser']['nickname'] = {$vals['nickname']};\n\n";
474 // Normalize line endings for Windows servers
475 $cfg = str_replace("\n", PHP_EOL, $cfg);
477 // write configuration file out to install directory
478 $res = file_put_contents(INSTALLDIR.'/config.php', $cfg, FILE_APPEND);
484 * Install schema into the database
486 * @param string $filename location of database schema file
487 * @param DB_common $conn connection to database
489 * @return boolean - indicating success or failure
491 function runDbScript($filename, DB_common $conn)
493 $sql = trim(file_get_contents(INSTALLDIR . '/db/' . $filename));
494 $stmts = explode(';', $sql);
495 foreach ($stmts as $stmt) {
497 if (!mb_strlen($stmt)) {
501 $res = $conn->simpleQuery($stmt);
502 } catch (Exception $e) {
503 $error = $e->getMessage();
504 $this->updateStatus("ERROR ($error) for SQL '$stmt'");
512 * Create the initial admin user account.
513 * Side effect: may load portions of GNU social framework.
514 * Side effect: outputs program info
516 function registerInitialUser()
518 require_once INSTALLDIR . '/lib/common.php';
520 $data = array('nickname' => $this->adminNick,
521 'password' => $this->adminPass,
522 'fullname' => $this->adminNick);
523 if ($this->adminEmail) {
524 $data['email'] = $this->adminEmail;
527 $user = User::register($data, true); // true to skip email sending verification
528 } catch (Exception $e) {
532 // give initial user carte blanche
534 $user->grantRole('owner');
535 $user->grantRole('moderator');
536 $user->grantRole('administrator');
542 * The beef of the installer!
543 * Create database, config file, and admin user.
545 * Prerequisites: validation of input data.
547 * @return boolean success
553 $this->updateStatus("Initializing...");
554 ini_set('display_errors', 1);
555 error_reporting(E_ALL & ~E_STRICT & ~E_NOTICE);
556 if (!defined('GNUSOCIAL')) {
557 define('GNUSOCIAL', true);
559 if (!defined('STATUSNET')) {
560 define('STATUSNET', true);
563 require_once INSTALLDIR . '/lib/framework.php';
564 GNUsocial::initDefaults($this->server, $this->path);
566 if ($this->siteProfile == "singleuser") {
567 // Until we use ['site']['profile']==='singleuser' everywhere
568 $config['singleuser']['enabled'] = true;
572 $this->db = $this->setupDatabase();
574 // database connection failed, do not move on to create config file.
577 } catch (Exception $e) {
578 // Lower-level DB error!
579 $this->updateStatus("Database error: " . $e->getMessage(), true);
583 // Make sure we can write to the file twice
584 $oldUmask = umask(000);
586 if (!$this->skipConfig) {
587 $this->updateStatus("Writing config file...");
588 $res = $this->writeConf();
591 $this->updateStatus("Can't write config file.", true);
596 if (!empty($this->adminNick)) {
597 // Okay, cross fingers and try to register an initial user
598 if ($this->registerInitialUser()) {
600 "An initial user with the administrator role has been created."
604 "Could not create initial user account.",
611 if (!$this->skipConfig) {
612 $this->updateStatus("Setting site profile...");
613 $res = $this->writeSiteProfile();
616 $this->updateStatus("Can't write to config file.", true);
621 // Restore original umask
623 // Set permissions back to something decent
624 chmod(INSTALLDIR.'/config.php', 0644);
626 $scheme = $this->ssl === 'always' ? 'https' : 'http';
627 $link = "{$scheme}://{$this->server}/{$this->path}";
629 $this->updateStatus("GNU social has been installed at $link");
631 '<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>.'
638 * Output a pre-install-time warning message
639 * @param string $message HTML ok, but should be plaintext-able
640 * @param string $submessage HTML ok, but should be plaintext-able
642 abstract function warning($message, $submessage='');
645 * Output an install-time progress message
646 * @param string $message HTML ok, but should be plaintext-able
647 * @param boolean $error true if this should be marked as an error condition
649 abstract function updateStatus($status, $error=false);