]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/installer.php
Split up source and source_link. Never trust HTML!
[quix0rs-gnu-social.git] / 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     /** Administrator info */
50     public $adminNick, $adminPass, $adminEmail;
51     /** Should we skip writing the configuration file? */
52     public $skipConfig = false;
53
54     public static $dbModules = array(
55         'mysql' => array(
56             'name' => 'MariaDB (or MySQL 5.5+)',
57             'check_module' => 'mysqli',
58             'scheme' => 'mysqli', // DSN prefix for PEAR::DB
59         ),
60 /*        'pgsql' => array(
61             'name' => 'PostgreSQL',
62             'check_module' => 'pgsql',
63             'scheme' => 'pgsql', // DSN prefix for PEAR::DB
64         ),*/
65     );
66
67     /**
68      * Attempt to include a PHP file and report if it worked, while
69      * suppressing the annoying warning messages on failure.
70      */
71     private function haveIncludeFile($filename) {
72         $old = error_reporting(error_reporting() & ~E_WARNING);
73         $ok = include_once($filename);
74         error_reporting($old);
75         return $ok;
76     }
77
78     /**
79      * Check if all is ready for installation
80      *
81      * @return void
82      */
83     function checkPrereqs()
84     {
85         $pass = true;
86
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.');
92                 } else {
93                     $this->warning('Config file "config.php" already exists.');
94                 }
95                 $pass = false;
96             }
97         }
98
99         if (version_compare(PHP_VERSION, '5.5.0', '<')) {
100             $this->warning('Require PHP version 5.5.0 or greater.');
101             $pass = false;
102         }
103
104         $reqs = array('gd', 'curl', 'intl', 'json',
105                       'xmlwriter', 'mbstring', 'xml', 'dom', 'simplexml');
106
107         foreach ($reqs as $req) {
108             if (!$this->checkExtension($req)) {
109                 $this->warning(sprintf('Cannot load required extension: <code>%s</code>', $req));
110                 $pass = false;
111             }
112         }
113
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'];
119             }
120         }
121
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));
125             $pass = false;
126         }
127
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));
132             $pass = false;
133         }
134
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.');
144                 $pass = false;
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));
148                 $pass = false;
149             }
150         }
151
152         return $pass;
153     }
154
155     /**
156      * Checks if a php extension is both installed and loaded
157      *
158      * @param string $name of extension to check
159      *
160      * @return boolean whether extension is installed and loaded
161      */
162     function checkExtension($name)
163     {
164         if (extension_loaded($name)) {
165             return true;
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;
172             }
173             return @dl($soname);
174         } else {
175             return false;
176         }
177     }
178
179     /**
180      * Basic validation on the database paramters
181      * Side effects: error output if not valid
182      *
183      * @return boolean success
184      */
185     function validateDb()
186     {
187         $fail = false;
188
189         if (empty($this->host)) {
190             $this->updateStatus("No hostname specified.", true);
191             $fail = true;
192         }
193
194         if (empty($this->database)) {
195             $this->updateStatus("No database specified.", true);
196             $fail = true;
197         }
198
199         if (empty($this->username)) {
200             $this->updateStatus("No username specified.", true);
201             $fail = true;
202         }
203
204         if (empty($this->sitename)) {
205             $this->updateStatus("No sitename specified.", true);
206             $fail = true;
207         }
208
209         return !$fail;
210     }
211
212     /**
213      * Basic validation on the administrator user paramters
214      * Side effects: error output if not valid
215      *
216      * @return boolean success
217      */
218     function validateAdmin()
219     {
220         $fail = false;
221
222         if (empty($this->adminNick)) {
223             $this->updateStatus("No initial user nickname specified.", true);
224             $fail = true;
225         }
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);
229             $fail = true;
230         }
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);
237             $fail = true;
238         }
239
240         if (empty($this->adminPass)) {
241             $this->updateStatus("No initial user password specified.", true);
242             $fail = true;
243         }
244
245         return !$fail;
246     }
247
248     /**
249      * Make sure a site profile was selected
250      *
251      * @return type boolean success
252      */
253     function validateSiteProfile()
254     {
255         if (empty($this->siteProfile))  {
256             $this->updateStatus("No site profile selected.", true);
257             return false;
258         }
259
260         return true;
261     }
262
263     /**
264      * Set up the database with the appropriate function for the selected type...
265      * Saves database info into $this->db.
266      *
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
269      */
270     function setupDatabase()
271     {
272         if ($this->db) {
273             throw new Exception("Bad order of operations: DB already set up.");
274         }
275         $this->updateStatus("Starting installation...");
276
277         if (empty($this->password)) {
278             $auth = '';
279         } else {
280             $auth = ":$this->password";
281         }
282         $scheme = self::$dbModules[$this->dbtype]['scheme'];
283         $dsn = "{$scheme}://{$this->username}{$auth}@{$this->host}/{$this->database}";
284
285         $this->updateStatus("Checking database...");
286         $conn = $this->connectDatabase($dsn);
287
288         // ensure database encoding is UTF8
289         if ($this->dbtype == 'mysql') {
290             // @fixme utf8m4 support for mysql 5.5?
291             // Force the comms charset to utf8 for sanity
292             // This doesn't currently work. :P
293             //$conn->executes('set names utf8');
294         } else if ($this->dbtype == 'pgsql') {
295             $record = $conn->getRow('SHOW server_encoding');
296             if ($record->server_encoding != 'UTF8') {
297                 $this->updateStatus("GNU social requires UTF8 character encoding. Your database is ". htmlentities($record->server_encoding));
298                 return false;
299             }
300         }
301
302         if (!$conn instanceof DB_common) {
303             // Is not the right instance
304             throw new Exception('Cannot connect to database: ' . $conn->getMessage());
305         }
306
307         $res = $this->updateStatus("Creating database tables...");
308         if (!$this->createCoreTables($conn)) {
309             $this->updateStatus("Error creating tables.", true);
310             return false;
311         }
312
313         foreach (array('sms_carrier' => 'SMS carrier',
314                     'notice_source' => 'notice source',
315                     'foreign_services' => 'foreign service')
316               as $scr => $name) {
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);
321                 return false;
322             }
323         }
324
325         $db = array('type' => $this->dbtype, 'database' => $dsn);
326         return $db;
327     }
328
329     /**
330      * Open a connection to the database.
331      *
332      * @param <type> $dsn
333      * @return <type>
334      */
335     function connectDatabase($dsn)
336     {
337         global $_DB;
338         return $_DB->connect($dsn);
339     }
340
341     /**
342      * Create core tables on the given database connection.
343      *
344      * @param DB_common $conn
345      */
346     function createCoreTables(DB_common $conn)
347     {
348         $schema = Schema::get($conn);
349         $tableDefs = $this->getCoreSchema();
350         foreach ($tableDefs as $name => $def) {
351             if (defined('DEBUG_INSTALLER')) {
352                 echo " $name ";
353             }
354             $schema->ensureTable($name, $def);
355         }
356         return true;
357     }
358
359     /**
360      * Fetch the core table schema definitions.
361      *
362      * @return array of table names => table def arrays
363      */
364     function getCoreSchema()
365     {
366         $schema = array();
367         include INSTALLDIR . '/db/core.php';
368         return $schema;
369     }
370
371     /**
372      * Return a parseable PHP literal for the given value.
373      * This will include quotes for strings, etc.
374      *
375      * @param mixed $val
376      * @return string
377      */
378     function phpVal($val)
379     {
380         return var_export($val, true);
381     }
382
383     /**
384      * Return an array of parseable PHP literal for the given values.
385      * These will include quotes for strings, etc.
386      *
387      * @param mixed $val
388      * @return array
389      */
390     function phpVals($map)
391     {
392         return array_map(array($this, 'phpVal'), $map);
393     }
394
395     /**
396      * Write a stock configuration file.
397      *
398      * @return boolean success
399      *
400      * @fixme escape variables in output in case we have funny chars, apostrophes etc
401      */
402     function writeConf()
403     {
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'))
409                      ? $this->ssl
410                      : 'never',
411             'db_database' => $this->db['database'],
412             'db_type' => $this->db['type']
413         ));
414
415         // assemble configuration file in a string
416         $cfg =  "<?php\n".
417                 "if (!defined('GNUSOCIAL')) { exit(1); }\n\n".
418
419                 // site name
420                 "\$config['site']['name'] = {$vals['sitename']};\n\n".
421
422                 // site location
423                 "\$config['site']['server'] = {$vals['server']};\n".
424                 "\$config['site']['path'] = {$vals['path']}; \n\n".
425                 "\$config['site']['ssl'] = {$vals['ssl']}; \n\n".
426
427                 // checks if fancy URLs are enabled
428                 ($this->fancy ? "\$config['site']['fancy'] = true;\n\n":'').
429
430                 // database
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".
434
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";
438
439         // Normalize line endings for Windows servers
440         $cfg = str_replace("\n", PHP_EOL, $cfg);
441
442         // write configuration file out to install directory
443         $res = file_put_contents(INSTALLDIR.'/config.php', $cfg);
444
445         return $res;
446     }
447
448     /**
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.
454      *
455      * @return int res number of bytes written
456      */
457     function writeSiteProfile()
458     {
459         $vals = $this->phpVals(array(
460             'site_profile' => $this->siteProfile,
461             'nickname' => $this->adminNick
462         ));
463
464         $cfg =
465         // site profile
466         "\$config['site']['profile'] = {$vals['site_profile']};\n";
467
468         if ($this->siteProfile == "singleuser") {
469             $cfg .= "\$config['singleuser']['nickname'] = {$vals['nickname']};\n\n";
470         } else {
471             $cfg .= "\n";
472         }
473
474         // Normalize line endings for Windows servers
475         $cfg = str_replace("\n", PHP_EOL, $cfg);
476
477         // write configuration file out to install directory
478         $res = file_put_contents(INSTALLDIR.'/config.php', $cfg, FILE_APPEND);
479
480         return $res;
481     }
482
483     /**
484      * Install schema into the database
485      *
486      * @param string    $filename location of database schema file
487      * @param DB_common $conn     connection to database
488      *
489      * @return boolean - indicating success or failure
490      */
491     function runDbScript($filename, DB_common $conn)
492     {
493         $sql = trim(file_get_contents(INSTALLDIR . '/db/' . $filename));
494         $stmts = explode(';', $sql);
495         foreach ($stmts as $stmt) {
496             $stmt = trim($stmt);
497             if (!mb_strlen($stmt)) {
498                 continue;
499             }
500             try {
501                 $res = $conn->simpleQuery($stmt);
502             } catch (Exception $e) {
503                 $error = $e->getMessage();
504                 $this->updateStatus("ERROR ($error) for SQL '$stmt'");
505                 return false;
506             }
507         }
508         return true;
509     }
510
511     /**
512      * Create the initial admin user account.
513      * Side effect: may load portions of GNU social framework.
514      * Side effect: outputs program info
515      */
516     function registerInitialUser()
517     {
518         require_once INSTALLDIR . '/lib/common.php';
519
520         $data = array('nickname' => $this->adminNick,
521                       'password' => $this->adminPass,
522                       'fullname' => $this->adminNick);
523         if ($this->adminEmail) {
524             $data['email'] = $this->adminEmail;
525         }
526         try {
527             $user = User::register($data, true);    // true to skip email sending verification
528         } catch (Exception $e) {
529             return false;
530         }
531
532         // give initial user carte blanche
533
534         $user->grantRole('owner');
535         $user->grantRole('moderator');
536         $user->grantRole('administrator');
537
538         return true;
539     }
540
541     /**
542      * The beef of the installer!
543      * Create database, config file, and admin user.
544      *
545      * Prerequisites: validation of input data.
546      *
547      * @return boolean success
548      */
549     function doInstall()
550     {
551         global $config;
552
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);
558         }
559         if (!defined('STATUSNET')) {
560             define('STATUSNET', true);
561         }
562
563         require_once INSTALLDIR . '/lib/framework.php';
564         GNUsocial::initDefaults($this->server, $this->path);
565
566         if ($this->siteProfile == "singleuser") {
567             // Until we use ['site']['profile']==='singleuser' everywhere
568             $config['singleuser']['enabled'] = true;
569         }
570
571         try {
572             $this->db = $this->setupDatabase();
573             if (!$this->db) {
574                 // database connection failed, do not move on to create config file.
575                 return false;
576             }
577         } catch (Exception $e) {
578             // Lower-level DB error!
579             $this->updateStatus("Database error: " . $e->getMessage(), true);
580             return false;
581         }
582
583         // Make sure we can write to the file twice
584         $oldUmask = umask(000); 
585
586         if (!$this->skipConfig) {
587             $this->updateStatus("Writing config file...");
588             $res = $this->writeConf();
589
590             if (!$res) {
591                 $this->updateStatus("Can't write config file.", true);
592                 return false;
593             }
594         }
595
596         if (!empty($this->adminNick)) {
597             // Okay, cross fingers and try to register an initial user
598             if ($this->registerInitialUser()) {
599                 $this->updateStatus(
600                     "An initial user with the administrator role has been created."
601                 );
602             } else {
603                 $this->updateStatus(
604                     "Could not create initial user account.",
605                     true
606                 );
607                 return false;
608             }
609         }
610
611         if (!$this->skipConfig) {
612             $this->updateStatus("Setting site profile...");
613             $res = $this->writeSiteProfile();
614
615             if (!$res) {
616                 $this->updateStatus("Can't write to config file.", true);
617                 return false;
618             }
619         }
620
621         // Restore original umask
622         umask($oldUmask);
623         // Set permissions back to something decent
624         chmod(INSTALLDIR.'/config.php', 0644);
625         
626         $scheme = $this->ssl === 'always' ? 'https' : 'http';
627         $link = "{$scheme}://{$this->server}/{$this->path}";
628
629         $this->updateStatus("GNU social has been installed at $link");
630         $this->updateStatus(
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>.'
632         );
633
634         return true;
635     }
636
637     /**
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
641      */
642     abstract function warning($message, $submessage='');
643
644     /**
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
648      */
649     abstract function updateStatus($status, $error=false);
650
651 }