<?php /** * StatusNet - the distributed open-source microblogging tool * Copyright (C) 2009-2010, StatusNet, Inc. * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public License * along with this program. If not, see <http://www.gnu.org/licenses/>. * * @category Installation * @package Installation * * @author Adrian Lang <mail@adrianlang.de> * @author Brenda Wallace <shiny@cpan.org> * @author Brett Taylor <brett@webfroot.co.nz> * @author Brion Vibber <brion@pobox.com> * @author CiaranG <ciaran@ciarang.com> * @author Craig Andrews <candrews@integralblue.com> * @author Eric Helgeson <helfire@Erics-MBP.local> * @author Evan Prodromou <evan@status.net> * @author Mikael Nordfeldth <mmn@hethane.se> * @author Robin Millette <millette@controlyourself.ca> * @author Sarven Capadisli <csarven@status.net> * @author Tom Adams <tom@holizz.com> * @author Zach Copley <zach@status.net> * @copyright 2009-2010 StatusNet, Inc http://status.net * @copyright 2009-2014 Free Software Foundation, Inc http://www.fsf.org * @license GNU Affero General Public License http://www.gnu.org/licenses/ * @version 1.0.x * @link http://status.net */ abstract class Installer { /** Web site info */ public $sitename, $server, $path, $fancy, $siteProfile, $ssl; /** DB info */ public $host, $database, $dbtype, $username, $password, $db; /** Administrator info */ public $adminNick, $adminPass, $adminEmail; /** Should we skip writing the configuration file? */ public $skipConfig = false; public static $dbModules = array( 'mysql' => array( 'name' => 'MariaDB (or MySQL 5.5+)', 'check_module' => 'mysqli', 'scheme' => 'mysqli', // DSN prefix for PEAR::DB ), /* 'pgsql' => array( 'name' => 'PostgreSQL', 'check_module' => 'pgsql', 'scheme' => 'pgsql', // DSN prefix for PEAR::DB ),*/ ); /** * Attempt to include a PHP file and report if it worked, while * suppressing the annoying warning messages on failure. */ private function haveIncludeFile($filename) { $old = error_reporting(error_reporting() & ~E_WARNING); $ok = include_once($filename); error_reporting($old); return $ok; } /** * Check if all is ready for installation * * @return void */ function checkPrereqs() { $pass = true; $config = INSTALLDIR.'/config.php'; if (file_exists($config)) { if (!is_writable($config) || filesize($config) > 0) { if (filesize($config) == 0) { $this->warning('Config file "config.php" already exists and is empty, but is not writable.'); } else { $this->warning('Config file "config.php" already exists.'); } $pass = false; } } if (version_compare(PHP_VERSION, '5.3.2', '<')) { $this->warning('Require PHP version 5.3.2 or greater.'); $pass = false; } $reqs = array('gd', 'curl', 'intl', 'json', 'xmlwriter', 'mbstring', 'xml', 'dom', 'simplexml'); foreach ($reqs as $req) { if (!$this->checkExtension($req)) { $this->warning(sprintf('Cannot load required extension: <code>%s</code>', $req)); $pass = false; } } // Make sure we have at least one database module available $missingExtensions = array(); foreach (self::$dbModules as $type => $info) { if (!$this->checkExtension($info['check_module'])) { $missingExtensions[] = $info['check_module']; } } if (count($missingExtensions) == count(self::$dbModules)) { $req = implode(', ', $missingExtensions); $this->warning(sprintf('Cannot find a database extension. You need at least one of %s.', $req)); $pass = false; } // @fixme this check seems to be insufficient with Windows ACLs if (!is_writable(INSTALLDIR)) { $this->warning(sprintf('Cannot write config file to: <code>%s</code></p>', INSTALLDIR), sprintf('On your server, try this command: <code>chmod a+w %s</code>', INSTALLDIR)); $pass = false; } // Check the subdirs used for file uploads $fileSubdirs = array('avatar', 'background', 'file'); foreach ($fileSubdirs as $fileSubdir) { $fileFullPath = INSTALLDIR."/$fileSubdir/"; if (!is_writable($fileFullPath)) { $this->warning(sprintf('Cannot write to %s directory: <code>%s</code>', $fileSubdir, $fileFullPath), sprintf('On your server, try this command: <code>chmod a+w %s</code>', $fileFullPath)); $pass = false; } } return $pass; } /** * Checks if a php extension is both installed and loaded * * @param string $name of extension to check * * @return boolean whether extension is installed and loaded */ function checkExtension($name) { if (extension_loaded($name)) { return true; } elseif (function_exists('dl') && ini_get('enable_dl') && !ini_get('safe_mode')) { // dl will throw a fatal error if it's disabled or we're in safe mode. // More fun, it may not even exist under some SAPIs in 5.3.0 or later... $soname = $name . '.' . PHP_SHLIB_SUFFIX; if (PHP_SHLIB_SUFFIX == 'dll') { $soname = "php_" . $soname; } return @dl($soname); } else { return false; } } /** * Basic validation on the database paramters * Side effects: error output if not valid * * @return boolean success */ function validateDb() { $fail = false; if (empty($this->host)) { $this->updateStatus("No hostname specified.", true); $fail = true; } if (empty($this->database)) { $this->updateStatus("No database specified.", true); $fail = true; } if (empty($this->username)) { $this->updateStatus("No username specified.", true); $fail = true; } if (empty($this->sitename)) { $this->updateStatus("No sitename specified.", true); $fail = true; } return !$fail; } /** * Basic validation on the administrator user paramters * Side effects: error output if not valid * * @return boolean success */ function validateAdmin() { $fail = false; if (empty($this->adminNick)) { $this->updateStatus("No initial user nickname specified.", true); $fail = true; } if ($this->adminNick && !preg_match('/^[0-9a-z]{1,64}$/', $this->adminNick)) { $this->updateStatus('The user nickname "' . htmlspecialchars($this->adminNick) . '" is invalid; should be plain letters and numbers no longer than 64 characters.', true); $fail = true; } // @fixme hardcoded list; should use Nickname::isValid() // if/when it's safe to have loaded the infrastructure here $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'); if (in_array($this->adminNick, $blacklist)) { $this->updateStatus('The user nickname "' . htmlspecialchars($this->adminNick) . '" is reserved.', true); $fail = true; } if (empty($this->adminPass)) { $this->updateStatus("No initial user password specified.", true); $fail = true; } return !$fail; } /** * Make sure a site profile was selected * * @return type boolean success */ function validateSiteProfile() { if (empty($this->siteProfile)) { $this->updateStatus("No site profile selected.", true); return false; } return true; } /** * Set up the database with the appropriate function for the selected type... * Saves database info into $this->db. * * @fixme escape things in the connection string in case we have a funny pass etc * @return mixed array of database connection params on success, false on failure */ function setupDatabase() { if ($this->db) { throw new Exception("Bad order of operations: DB already set up."); } $this->updateStatus("Starting installation..."); if (empty($this->password)) { $auth = ''; } else { $auth = ":$this->password"; } $scheme = self::$dbModules[$this->dbtype]['scheme']; $dsn = "{$scheme}://{$this->username}{$auth}@{$this->host}/{$this->database}"; $this->updateStatus("Checking database..."); $conn = $this->connectDatabase($dsn); // ensure database encoding is UTF8 if ($this->dbtype == 'mysql') { // @fixme utf8m4 support for mysql 5.5? // Force the comms charset to utf8 for sanity // This doesn't currently work. :P //$conn->executes('set names utf8'); } else if ($this->dbtype == 'pgsql') { $record = $conn->getRow('SHOW server_encoding'); if ($record->server_encoding != 'UTF8') { $this->updateStatus("GNU social requires UTF8 character encoding. Your database is ". htmlentities($record->server_encoding)); return false; } } if (!$conn instanceof DB_common) { // Is not the right instance throw new Exception('Cannot connect to database: ' . $conn->getMessage()); } $res = $this->updateStatus("Creating database tables..."); if (!$this->createCoreTables($conn)) { $this->updateStatus("Error creating tables.", true); return false; } foreach (array('sms_carrier' => 'SMS carrier', 'notice_source' => 'notice source', 'foreign_services' => 'foreign service') as $scr => $name) { $this->updateStatus(sprintf("Adding %s data to database...", $name)); $res = $this->runDbScript($scr.'.sql', $conn); if ($res === false) { $this->updateStatus(sprintf("Can't run %s script.", $name), true); return false; } } $db = array('type' => $this->dbtype, 'database' => $dsn); return $db; } /** * Open a connection to the database. * * @param <type> $dsn * @return <type> */ function connectDatabase($dsn) { global $_DB; return $_DB->connect($dsn); } /** * Create core tables on the given database connection. * * @param DB_common $conn */ function createCoreTables(DB_common $conn) { $schema = Schema::get($conn); $tableDefs = $this->getCoreSchema(); foreach ($tableDefs as $name => $def) { if (defined('DEBUG_INSTALLER')) { echo " $name "; } $schema->ensureTable($name, $def); } return true; } /** * Fetch the core table schema definitions. * * @return array of table names => table def arrays */ function getCoreSchema() { $schema = array(); include INSTALLDIR . '/db/core.php'; return $schema; } /** * Return a parseable PHP literal for the given value. * This will include quotes for strings, etc. * * @param mixed $val * @return string */ function phpVal($val) { return var_export($val, true); } /** * Return an array of parseable PHP literal for the given values. * These will include quotes for strings, etc. * * @param mixed $val * @return array */ function phpVals($map) { return array_map(array($this, 'phpVal'), $map); } /** * Write a stock configuration file. * * @return boolean success * * @fixme escape variables in output in case we have funny chars, apostrophes etc */ function writeConf() { $vals = $this->phpVals(array( 'sitename' => $this->sitename, 'server' => $this->server, 'path' => $this->path, 'ssl' => in_array($this->ssl, array('never', 'sometimes', 'always')) ? $this->ssl : 'never', 'db_database' => $this->db['database'], 'db_type' => $this->db['type'] )); // assemble configuration file in a string $cfg = "<?php\n". "if (!defined('GNUSOCIAL')) { exit(1); }\n\n". // site name "\$config['site']['name'] = {$vals['sitename']};\n\n". // site location "\$config['site']['server'] = {$vals['server']};\n". "\$config['site']['path'] = {$vals['path']}; \n\n". "\$config['site']['ssl'] = {$vals['ssl']}; \n\n". // checks if fancy URLs are enabled ($this->fancy ? "\$config['site']['fancy'] = true;\n\n":''). // database "\$config['db']['database'] = {$vals['db_database']};\n\n". ($this->db['type'] == 'pgsql' ? "\$config['db']['quote_identifiers'] = true;\n\n":''). "\$config['db']['type'] = {$vals['db_type']};\n\n". "// Uncomment below for better performance. Just remember you must run\n". "// php scripts/checkschema.php whenever your enabled plugins change!\n". "//\$config['db']['schemacheck'] = 'script';\n\n"; // Normalize line endings for Windows servers $cfg = str_replace("\n", PHP_EOL, $cfg); // write configuration file out to install directory $res = file_put_contents(INSTALLDIR.'/config.php', $cfg); return $res; } /** * Write the site profile. We do this after creating the initial user * in case the site profile is set to single user. This gets around the * 'chicken-and-egg' problem of the system requiring a valid user for * single user mode, before the intial user is actually created. Yeah, * we should probably do this in smarter way. * * @return int res number of bytes written */ function writeSiteProfile() { $vals = $this->phpVals(array( 'site_profile' => $this->siteProfile, 'nickname' => $this->adminNick )); $cfg = // site profile "\$config['site']['profile'] = {$vals['site_profile']};\n"; if ($this->siteProfile == "singleuser") { $cfg .= "\$config['singleuser']['nickname'] = {$vals['nickname']};\n\n"; } else { $cfg .= "\n"; } // Normalize line endings for Windows servers $cfg = str_replace("\n", PHP_EOL, $cfg); // write configuration file out to install directory $res = file_put_contents(INSTALLDIR.'/config.php', $cfg, FILE_APPEND); return $res; } /** * Install schema into the database * * @param string $filename location of database schema file * @param DB_common $conn connection to database * * @return boolean - indicating success or failure */ function runDbScript($filename, DB_common $conn) { $sql = trim(file_get_contents(INSTALLDIR . '/db/' . $filename)); $stmts = explode(';', $sql); foreach ($stmts as $stmt) { $stmt = trim($stmt); if (!mb_strlen($stmt)) { continue; } try { $res = $conn->simpleQuery($stmt); } catch (Exception $e) { $error = $e->getMessage(); $this->updateStatus("ERROR ($error) for SQL '$stmt'"); return false; } } return true; } /** * Create the initial admin user account. * Side effect: may load portions of GNU social framework. * Side effect: outputs program info */ function registerInitialUser() { require_once INSTALLDIR . '/lib/common.php'; $data = array('nickname' => $this->adminNick, 'password' => $this->adminPass, 'fullname' => $this->adminNick); if ($this->adminEmail) { $data['email'] = $this->adminEmail; } try { $user = User::register($data); } catch (Exception $e) { return false; } // give initial user carte blanche $user->grantRole('owner'); $user->grantRole('moderator'); $user->grantRole('administrator'); return true; } /** * The beef of the installer! * Create database, config file, and admin user. * * Prerequisites: validation of input data. * * @return boolean success */ function doInstall() { global $config; $this->updateStatus("Initializing..."); ini_set('display_errors', 1); error_reporting(E_ALL & ~E_STRICT & ~E_NOTICE); if (!defined('GNUSOCIAL')) { define('GNUSOCIAL', true); } if (!defined('STATUSNET')) { define('STATUSNET', true); } require_once INSTALLDIR . '/lib/framework.php'; GNUsocial::initDefaults($this->server, $this->path); if ($this->siteProfile == "singleuser") { // Until we use ['site']['profile']==='singleuser' everywhere $config['singleuser']['enabled'] = true; } try { $this->db = $this->setupDatabase(); if (!$this->db) { // database connection failed, do not move on to create config file. return false; } } catch (Exception $e) { // Lower-level DB error! $this->updateStatus("Database error: " . $e->getMessage(), true); return false; } // Make sure we can write to the file twice $oldUmask = umask(000); if (!$this->skipConfig) { $this->updateStatus("Writing config file..."); $res = $this->writeConf(); if (!$res) { $this->updateStatus("Can't write config file.", true); return false; } } if (!empty($this->adminNick)) { // Okay, cross fingers and try to register an initial user if ($this->registerInitialUser()) { $this->updateStatus( "An initial user with the administrator role has been created." ); } else { $this->updateStatus( "Could not create initial user account.", true ); return false; } } if (!$this->skipConfig) { $this->updateStatus("Setting site profile..."); $res = $this->writeSiteProfile(); if (!$res) { $this->updateStatus("Can't write to config file.", true); return false; } } // Restore original umask umask($oldUmask); // Set permissions back to something decent chmod(INSTALLDIR.'/config.php', 0644); $scheme = $this->ssl === 'always' ? 'https' : 'http'; $link = "{$scheme}://{$this->server}/{$this->path}"; $this->updateStatus("GNU social has been installed at $link"); $this->updateStatus( '<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>.' ); return true; } /** * Output a pre-install-time warning message * @param string $message HTML ok, but should be plaintext-able * @param string $submessage HTML ok, but should be plaintext-able */ abstract function warning($message, $submessage=''); /** * Output an install-time progress message * @param string $message HTML ok, but should be plaintext-able * @param boolean $error true if this should be marked as an error condition */ abstract function updateStatus($status, $error=false); }