]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/installer.php
Core and Default plugins separated, now loads on install
[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 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, $adminUpdates;
51     /** Should we skip writing the configuration file? */
52     public $skipConfig = false;
53
54     public static $dbModules = array(
55         'mysql' => array(
56             'name' => 'MySQL',
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.2.3', '<')) {
100             $this->warning('Require PHP version 5.2.3 or greater.');
101             $pass = false;
102         }
103
104         // Look for known library bugs
105         $str = "abcdefghijklmnopqrstuvwxyz";
106         $replaced = preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
107         if ($str != $replaced) {
108             $this->warning('PHP is linked to a version of the PCRE library ' .
109                            'that does not support Unicode properties. ' .
110                            'If you are running Red Hat Enterprise Linux / ' .
111                            'CentOS 5.4 or earlier, see <a href="' .
112                            'http://status.net/wiki/Red_Hat_Enterprise_Linux#PCRE_library' .
113                            '">our documentation page</a> on fixing this.');
114             $pass = false;
115         }
116
117         $reqs = array('gd', 'curl',
118                       'xmlwriter', 'mbstring', 'xml', 'dom', 'simplexml');
119
120         foreach ($reqs as $req) {
121             if (!$this->checkExtension($req)) {
122                 $this->warning(sprintf('Cannot load required extension: <code>%s</code>', $req));
123                 $pass = false;
124             }
125         }
126
127         // Make sure we have at least one database module available
128         $missingExtensions = array();
129         foreach (self::$dbModules as $type => $info) {
130             if (!$this->checkExtension($info['check_module'])) {
131                 $missingExtensions[] = $info['check_module'];
132             }
133         }
134
135         if (count($missingExtensions) == count(self::$dbModules)) {
136             $req = implode(', ', $missingExtensions);
137             $this->warning(sprintf('Cannot find a database extension. You need at least one of %s.', $req));
138             $pass = false;
139         }
140
141         // @fixme this check seems to be insufficient with Windows ACLs
142         if (!is_writable(INSTALLDIR)) {
143             $this->warning(sprintf('Cannot write config file to: <code>%s</code></p>', INSTALLDIR),
144                            sprintf('On your server, try this command: <code>chmod a+w %s</code>', INSTALLDIR));
145             $pass = false;
146         }
147
148         // Check the subdirs used for file uploads
149         $fileSubdirs = array('avatar', 'background', 'file');
150         foreach ($fileSubdirs as $fileSubdir) {
151             $fileFullPath = INSTALLDIR."/$fileSubdir/";
152             if (!is_writable($fileFullPath)) {
153                 $this->warning(sprintf('Cannot write to %s directory: <code>%s</code>', $fileSubdir, $fileFullPath),
154                                sprintf('On your server, try this command: <code>chmod a+w %s</code>', $fileFullPath));
155                 $pass = false;
156             }
157         }
158
159         return $pass;
160     }
161
162     /**
163      * Checks if a php extension is both installed and loaded
164      *
165      * @param string $name of extension to check
166      *
167      * @return boolean whether extension is installed and loaded
168      */
169     function checkExtension($name)
170     {
171         if (extension_loaded($name)) {
172             return true;
173         } elseif (function_exists('dl') && ini_get('enable_dl') && !ini_get('safe_mode')) {
174             // dl will throw a fatal error if it's disabled or we're in safe mode.
175             // More fun, it may not even exist under some SAPIs in 5.3.0 or later...
176             $soname = $name . '.' . PHP_SHLIB_SUFFIX;
177             if (PHP_SHLIB_SUFFIX == 'dll') {
178                 $soname = "php_" . $soname;
179             }
180             return @dl($soname);
181         } else {
182             return false;
183         }
184     }
185
186     /**
187      * Basic validation on the database paramters
188      * Side effects: error output if not valid
189      *
190      * @return boolean success
191      */
192     function validateDb()
193     {
194         $fail = false;
195
196         if (empty($this->host)) {
197             $this->updateStatus("No hostname specified.", true);
198             $fail = true;
199         }
200
201         if (empty($this->database)) {
202             $this->updateStatus("No database specified.", true);
203             $fail = true;
204         }
205
206         if (empty($this->username)) {
207             $this->updateStatus("No username specified.", true);
208             $fail = true;
209         }
210
211         if (empty($this->sitename)) {
212             $this->updateStatus("No sitename specified.", true);
213             $fail = true;
214         }
215
216         return !$fail;
217     }
218
219     /**
220      * Basic validation on the administrator user paramters
221      * Side effects: error output if not valid
222      *
223      * @return boolean success
224      */
225     function validateAdmin()
226     {
227         $fail = false;
228
229         if (empty($this->adminNick)) {
230             $this->updateStatus("No initial StatusNet user nickname specified.", true);
231             $fail = true;
232         }
233         if ($this->adminNick && !preg_match('/^[0-9a-z]{1,64}$/', $this->adminNick)) {
234             $this->updateStatus('The user nickname "' . htmlspecialchars($this->adminNick) .
235                          '" is invalid; should be plain letters and numbers no longer than 64 characters.', true);
236             $fail = true;
237         }
238         // @fixme hardcoded list; should use Nickname::isValid()
239         // if/when it's safe to have loaded the infrastructure here
240         $blacklist = array('main', 'panel', 'twitter', 'settings', 'rsd.xml', 'favorited', 'featured', 'favoritedrss', 'featuredrss', 'rss', 'getfile', 'api', 'groups', 'group', 'peopletag', 'tag', 'user', 'message', 'conversation', 'bookmarklet', 'notice', 'attachment', 'search', 'index.php', 'doc', 'opensearch', 'robots.txt', 'xd_receiver.html', 'facebook');
241         if (in_array($this->adminNick, $blacklist)) {
242             $this->updateStatus('The user nickname "' . htmlspecialchars($this->adminNick) .
243                          '" is reserved.', true);
244             $fail = true;
245         }
246
247         if (empty($this->adminPass)) {
248             $this->updateStatus("No initial StatusNet user password specified.", true);
249             $fail = true;
250         }
251
252         return !$fail;
253     }
254
255     /**
256      * Make sure a site profile was selected
257      *
258      * @return type boolean success
259      */
260     function validateSiteProfile()
261     {
262         $fail = false;
263
264         $sprofile = $this->siteProfile;
265
266         if (empty($sprofile))  {
267             $this->updateStatus("No site profile selected.", true);
268             $fail = true;
269         }
270
271         return !$fail;
272     }
273
274     /**
275      * Set up the database with the appropriate function for the selected type...
276      * Saves database info into $this->db.
277      *
278      * @fixme escape things in the connection string in case we have a funny pass etc
279      * @return mixed array of database connection params on success, false on failure
280      */
281     function setupDatabase()
282     {
283         if ($this->db) {
284             throw new Exception("Bad order of operations: DB already set up.");
285         }
286         $this->updateStatus("Starting installation...");
287
288         if (empty($this->password)) {
289             $auth = '';
290         } else {
291             $auth = ":$this->password";
292         }
293         $scheme = self::$dbModules[$this->dbtype]['scheme'];
294         $dsn = "{$scheme}://{$this->username}{$auth}@{$this->host}/{$this->database}";
295
296         $this->updateStatus("Checking database...");
297         $conn = $this->connectDatabase($dsn);
298
299         // ensure database encoding is UTF8
300         if ($this->dbtype == 'mysql') {
301             // @fixme utf8m4 support for mysql 5.5?
302             // Force the comms charset to utf8 for sanity
303             // This doesn't currently work. :P
304             //$conn->executes('set names utf8');
305         } else if ($this->dbtype == 'pgsql') {
306             $record = $conn->getRow('SHOW server_encoding');
307             if ($record->server_encoding != 'UTF8') {
308                 $this->updateStatus("StatusNet requires UTF8 character encoding. Your database is ". htmlentities($record->server_encoding));
309                 return false;
310             }
311         }
312
313         $res = $this->updateStatus("Creating database tables...");
314         if (!$this->createCoreTables($conn)) {
315             $this->updateStatus("Error creating tables.", true);
316             return false;
317         }
318
319         foreach (array('sms_carrier' => 'SMS carrier',
320                     'notice_source' => 'notice source',
321                     'foreign_services' => 'foreign service')
322               as $scr => $name) {
323             $this->updateStatus(sprintf("Adding %s data to database...", $name));
324             $res = $this->runDbScript($scr.'.sql', $conn);
325             if ($res === false) {
326                 $this->updateStatus(sprintf("Can't run %s script.", $name), true);
327                 return false;
328             }
329         }
330
331         $db = array('type' => $this->dbtype, 'database' => $dsn);
332         return $db;
333     }
334
335     /**
336      * Open a connection to the database.
337      *
338      * @param <type> $dsn
339      * @return <type>
340      */
341     function connectDatabase($dsn)
342     {
343         global $_DB;
344         return $_DB->connect($dsn);
345     }
346
347     /**
348      * Create core tables on the given database connection.
349      *
350      * @param DB_common $conn
351      */
352     function createCoreTables(DB_common $conn)
353     {
354         $schema = Schema::get($conn);
355         $tableDefs = $this->getCoreSchema();
356         foreach ($tableDefs as $name => $def) {
357             if (defined('DEBUG_INSTALLER')) {
358                 echo " $name ";
359             }
360             $schema->ensureTable($name, $def);
361         }
362         return true;
363     }
364
365     /**
366      * Fetch the core table schema definitions.
367      *
368      * @return array of table names => table def arrays
369      */
370     function getCoreSchema()
371     {
372         $schema = array();
373         include INSTALLDIR . '/db/core.php';
374         return $schema;
375     }
376
377     /**
378      * Return a parseable PHP literal for the given value.
379      * This will include quotes for strings, etc.
380      *
381      * @param mixed $val
382      * @return string
383      */
384     function phpVal($val)
385     {
386         return var_export($val, true);
387     }
388
389     /**
390      * Return an array of parseable PHP literal for the given values.
391      * These will include quotes for strings, etc.
392      *
393      * @param mixed $val
394      * @return array
395      */
396     function phpVals($map)
397     {
398         return array_map(array($this, 'phpVal'), $map);
399     }
400
401     /**
402      * Write a stock configuration file.
403      *
404      * @return boolean success
405      *
406      * @fixme escape variables in output in case we have funny chars, apostrophes etc
407      */
408     function writeConf()
409     {
410         $vals = $this->phpVals(array(
411             'sitename' => $this->sitename,
412             'server' => $this->server,
413             'path' => $this->path,
414             'ssl' => in_array($this->ssl, array('never', 'sometimes', 'always'))
415                      ? $this->ssl
416                      : 'never',
417             'db_database' => $this->db['database'],
418             'db_type' => $this->db['type']
419         ));
420
421         // assemble configuration file in a string
422         $cfg =  "<?php\n".
423                 "if (!defined('GNUSOCIAL')) { exit(1); }\n\n".
424
425                 // site name
426                 "\$config['site']['name'] = {$vals['sitename']};\n\n".
427
428                 // site location
429                 "\$config['site']['server'] = {$vals['server']};\n".
430                 "\$config['site']['path'] = {$vals['path']}; \n\n".
431                 "\$config['site']['ssl'] = {$vals['ssl']}; \n\n".
432
433                 // checks if fancy URLs are enabled
434                 ($this->fancy ? "\$config['site']['fancy'] = true;\n\n":'').
435
436                 // database
437                 "\$config['db']['database'] = {$vals['db_database']};\n\n".
438                 ($this->db['type'] == 'pgsql' ? "\$config['db']['quote_identifiers'] = true;\n\n":'').
439                 "\$config['db']['type'] = {$vals['db_type']};\n\n";
440
441         // Normalize line endings for Windows servers
442         $cfg = str_replace("\n", PHP_EOL, $cfg);
443
444         // write configuration file out to install directory
445         $res = file_put_contents(INSTALLDIR.'/config.php', $cfg);
446
447         return $res;
448     }
449
450     /**
451      * Write the site profile. We do this after creating the initial user
452      * in case the site profile is set to single user. This gets around the
453      * 'chicken-and-egg' problem of the system requiring a valid user for
454      * single user mode, before the intial user is actually created. Yeah,
455      * we should probably do this in smarter way.
456      *
457      * @return int res number of bytes written
458      */
459     function writeSiteProfile()
460     {
461         $vals = $this->phpVals(array(
462             'site_profile' => $this->siteProfile,
463             'nickname' => $this->adminNick
464         ));
465
466         $cfg =
467         // site profile
468         "\$config['site']['profile'] = {$vals['site_profile']};\n";
469
470         if ($this->siteProfile == "singleuser") {
471             $cfg .= "\$config['singleuser']['nickname'] = {$vals['nickname']};\n\n";
472         } else {
473             $cfg .= "\n";
474         }
475
476         // Normalize line endings for Windows servers
477         $cfg = str_replace("\n", PHP_EOL, $cfg);
478
479         // write configuration file out to install directory
480         $res = file_put_contents(INSTALLDIR.'/config.php', $cfg, FILE_APPEND);
481
482         return $res;
483     }
484
485     /**
486      * Install schema into the database
487      *
488      * @param string    $filename location of database schema file
489      * @param DB_common $conn     connection to database
490      *
491      * @return boolean - indicating success or failure
492      */
493     function runDbScript($filename, DB_common $conn)
494     {
495         $sql = trim(file_get_contents(INSTALLDIR . '/db/' . $filename));
496         $stmts = explode(';', $sql);
497         foreach ($stmts as $stmt) {
498             $stmt = trim($stmt);
499             if (!mb_strlen($stmt)) {
500                 continue;
501             }
502             try {
503                 $res = $conn->simpleQuery($stmt);
504             } catch (Exception $e) {
505                 $error = $e->getMessage();
506                 $this->updateStatus("ERROR ($error) for SQL '$stmt'");
507                 return false;
508             }
509         }
510         return true;
511     }
512
513     /**
514      * Create the initial admin user account.
515      * Side effect: may load portions of StatusNet framework.
516      * Side effect: outputs program info
517      */
518     function registerInitialUser()
519     {
520         require_once INSTALLDIR . '/lib/common.php';
521
522         $data = array('nickname' => $this->adminNick,
523                       'password' => $this->adminPass,
524                       'fullname' => $this->adminNick);
525         if ($this->adminEmail) {
526             $data['email'] = $this->adminEmail;
527         }
528         $user = User::register($data);
529
530         if (empty($user)) {
531             return false;
532         }
533
534         // give initial user carte blanche
535
536         $user->grantRole('owner');
537         $user->grantRole('moderator');
538         $user->grantRole('administrator');
539
540         // Attempt to do a remote subscribe to update@status.net
541         // Will fail if instance is on a private network.
542
543         if ($this->adminUpdates && class_exists('Ostatus_profile')) {
544             try {
545                 $oprofile = Ostatus_profile::ensureProfileURL('http://update.status.net/');
546                 Subscription::start($user->getProfile(), $oprofile->localProfile());
547                 $this->updateStatus("Set up subscription to <a href='http://update.status.net/'>update@status.net</a>.");
548             } catch (Exception $e) {
549                 $this->updateStatus("Could not set up subscription to <a href='http://update.status.net/'>update@status.net</a>.", true);
550             }
551         }
552
553         return true;
554     }
555
556     /**
557      * The beef of the installer!
558      * Create database, config file, and admin user.
559      *
560      * Prerequisites: validation of input data.
561      *
562      * @return boolean success
563      */
564     function doInstall()
565     {
566         $this->updateStatus("Initializing...");
567         ini_set('display_errors', 1);
568         error_reporting(E_ALL);
569         if (!defined('GNUSOCIAL')) {
570             define('GNUSOCIAL', true);
571         }
572         if (!defined('STATUSNET')) {
573             define('STATUSNET', true);
574         }
575         require_once INSTALLDIR . '/lib/framework.php';
576         StatusNet::initDefaults($this->server, $this->path);
577
578         try {
579             $this->db = $this->setupDatabase();
580             if (!$this->db) {
581                 // database connection failed, do not move on to create config file.
582                 return false;
583             }
584         } catch (Exception $e) {
585             // Lower-level DB error!
586             $this->updateStatus("Database error: " . $e->getMessage(), true);
587             return false;
588         }
589
590         // Make sure we can write to the file twice
591         $oldUmask = umask(000); 
592
593         if (!$this->skipConfig) {
594             $this->updateStatus("Writing config file...");
595             $res = $this->writeConf();
596
597             if (!$res) {
598                 $this->updateStatus("Can't write config file.", true);
599                 return false;
600             }
601         }
602
603         if (!empty($this->adminNick)) {
604             // Okay, cross fingers and try to register an initial user
605             if ($this->registerInitialUser()) {
606                 $this->updateStatus(
607                     "An initial user with the administrator role has been created."
608                 );
609             } else {
610                 $this->updateStatus(
611                     "Could not create initial GNU social user.",
612                     true
613                 );
614                 return false;
615             }
616         }
617
618         if (!$this->skipConfig) {
619             $this->updateStatus("Setting site profile...");
620             $res = $this->writeSiteProfile();
621
622             if (!$res) {
623                 $this->updateStatus("Can't write to config file.", true);
624                 return false;
625             }
626         }
627
628         // Restore original umask
629         umask($oldUmask);
630         // Set permissions back to something decent
631         chmod(INSTALLDIR.'/config.php', 0644);
632         
633         $scheme = $this->ssl === 'always' ? 'https' : 'http';
634         $link = "{$scheme}://{$this->server}/{$this->path}";
635
636         $this->updateStatus("StatusNet has been installed at $link");
637         $this->updateStatus(
638             "<strong>DONE!</strong> You can visit your <a href='$link'>new StatusNet site</a> (login as '$this->adminNick'). If this is your first StatusNet install, you may want to poke around our <a href='http://status.net/wiki/Getting_started'>Getting Started guide</a>."
639         );
640
641         return true;
642     }
643
644     /**
645      * Output a pre-install-time warning message
646      * @param string $message HTML ok, but should be plaintext-able
647      * @param string $submessage HTML ok, but should be plaintext-able
648      */
649     abstract function warning($message, $submessage='');
650
651     /**
652      * Output an install-time progress message
653      * @param string $message HTML ok, but should be plaintext-able
654      * @param boolean $error true if this should be marked as an error condition
655      */
656     abstract function updateStatus($status, $error=false);
657
658 }