]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/statusnet.php
Forgot to commit the JS for ModPlus. :)
[quix0rs-gnu-social.git] / lib / statusnet.php
1 <?php
2 /**
3  * StatusNet - the distributed open-source microblogging tool
4  * Copyright (C) 2009-2010 StatusNet, Inc.
5  *
6  * This program is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU Affero General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU Affero General Public License for more details.
15  *
16  * You should have received a copy of the GNU Affero General Public License
17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
18  *
19  */
20
21 if (!defined('STATUSNET') && !defined('LACONICA')) {
22     exit(1);
23 }
24
25 global $config, $_server, $_path;
26
27 /**
28  * Global configuration setup and management.
29  */
30 class StatusNet
31 {
32     protected static $have_config;
33     protected static $is_api;
34     protected static $plugins = array();
35
36     /**
37      * Configure and instantiate a plugin into the current configuration.
38      * Class definitions will be loaded from standard paths if necessary.
39      * Note that initialization events won't be fired until later.
40      *
41      * @param string $name class name & plugin file/subdir name
42      * @param array $attrs key/value pairs of public attributes to set on plugin instance
43      *
44      * @throws ServerException if plugin can't be found
45      */
46     public static function addPlugin($name, $attrs = null)
47     {
48         $name = ucfirst($name);
49         $pluginclass = "{$name}Plugin";
50
51         if (!class_exists($pluginclass)) {
52
53             $files = array("local/plugins/{$pluginclass}.php",
54                            "local/plugins/{$name}/{$pluginclass}.php",
55                            "local/{$pluginclass}.php",
56                            "local/{$name}/{$pluginclass}.php",
57                            "plugins/{$pluginclass}.php",
58                            "plugins/{$name}/{$pluginclass}.php");
59
60             foreach ($files as $file) {
61                 $fullpath = INSTALLDIR.'/'.$file;
62                 if (@file_exists($fullpath)) {
63                     include_once($fullpath);
64                     break;
65                 }
66             }
67             if (!class_exists($pluginclass)) {
68                 throw new ServerException("Plugin $name not found.", 500);
69             }
70         }
71
72         $inst = new $pluginclass();
73         if (!empty($attrs)) {
74             foreach ($attrs as $aname => $avalue) {
75                 $inst->$aname = $avalue;
76             }
77         }
78
79         // Record activated plugins for later display/config dump
80         self::$plugins[] = array($name, $attrs);
81
82         return true;
83     }
84
85     /**
86      * Get a list of activated plugins in this process.
87      * @return array of (string $name, array $args) pairs
88      */
89     public static function getActivePlugins()
90     {
91         return self::$plugins;
92     }
93
94     /**
95      * Initialize, or re-initialize, StatusNet global configuration
96      * and plugins.
97      *
98      * If switching site configurations during script execution, be
99      * careful when working with leftover objects -- global settings
100      * affect many things and they may not behave as you expected.
101      *
102      * @param $server optional web server hostname for picking config
103      * @param $path optional URL path for picking config
104      * @param $conffile optional configuration file path
105      *
106      * @throws NoConfigException if config file can't be found
107      */
108     public static function init($server=null, $path=null, $conffile=null)
109     {
110         StatusNet::initDefaults($server, $path);
111         StatusNet::loadConfigFile($conffile);
112
113         // Load settings from database; note we need autoload for this
114         Config::loadSettings();
115
116         self::initPlugins();
117     }
118
119     /**
120      * Get identifier of the currently active site configuration
121      * @return string
122      */
123     public static function currentSite()
124     {
125         return common_config('site', 'nickname');
126     }
127
128     /**
129      * Change site configuration to site specified by nickname,
130      * if set up via Status_network. If not, sites other than
131      * the current will fail horribly.
132      *
133      * May throw exception or trigger a fatal error if the given
134      * site is missing or configured incorrectly.
135      *
136      * @param string $nickname
137      */
138     public static function switchSite($nickname)
139     {
140         if ($nickname == StatusNet::currentSite()) {
141             return true;
142         }
143
144         $sn = Status_network::staticGet('nickname', $nickname);
145         if (empty($sn)) {
146             return false;
147             throw new Exception("No such site nickname '$nickname'");
148         }
149
150         $server = $sn->getServerName();
151         StatusNet::init($server);
152     }
153
154     /**
155      * Pull all local sites from status_network table.
156      *
157      * Behavior undefined if site is not configured via Status_network.
158      *
159      * @return array of nicknames
160      */
161     public static function findAllSites()
162     {
163         $sites = array();
164         $sn = new Status_network();
165         $sn->find();
166         while ($sn->fetch()) {
167             $sites[] = $sn->nickname;
168         }
169         return $sites;
170     }
171
172     /**
173      * Fire initialization events for all instantiated plugins.
174      */
175     protected static function initPlugins()
176     {
177         // Load default plugins
178         foreach (common_config('plugins', 'default') as $name => $params) {
179             if (is_null($params)) {
180                 addPlugin($name);
181             } else if (is_array($params)) {
182                 if (count($params) == 0) {
183                     addPlugin($name);
184                 } else {
185                     $keys = array_keys($params);
186                     if (is_string($keys[0])) {
187                         addPlugin($name, $params);
188                     } else {
189                         foreach ($params as $paramset) {
190                             addPlugin($name, $paramset);
191                         }
192                     }
193                 }
194             }
195         }
196
197         // XXX: if plugins should check the schema at runtime, do that here.
198         if (common_config('db', 'schemacheck') == 'runtime') {
199             Event::handle('CheckSchema');
200         }
201
202         // Give plugins a chance to initialize in a fully-prepared environment
203         Event::handle('InitializePlugin');
204     }
205
206     /**
207      * Quick-check if configuration has been established.
208      * Useful for functions which may get used partway through
209      * initialization to back off from fancier things.
210      *
211      * @return bool
212      */
213     public function haveConfig()
214     {
215         return self::$have_config;
216     }
217
218     public function isApi()
219     {
220         return self::$is_api;
221     }
222
223     public function setApi($mode)
224     {
225         self::$is_api = $mode;
226     }
227
228     /**
229      * Build default configuration array
230      * @return array
231      */
232     protected static function defaultConfig()
233     {
234         global $_server, $_path;
235         require(INSTALLDIR.'/lib/default.php');
236         return $default;
237     }
238
239     /**
240      * Establish default configuration based on given or default server and path
241      * Sets global $_server, $_path, and $config
242      */
243     protected static function initDefaults($server, $path)
244     {
245         global $_server, $_path, $config;
246
247         Event::clearHandlers();
248         self::$plugins = array();
249
250         // try to figure out where we are. $server and $path
251         // can be set by including module, else we guess based
252         // on HTTP info.
253
254         if (isset($server)) {
255             $_server = $server;
256         } else {
257             $_server = array_key_exists('SERVER_NAME', $_SERVER) ?
258               strtolower($_SERVER['SERVER_NAME']) :
259             null;
260         }
261
262         if (isset($path)) {
263             $_path = $path;
264         } else {
265             $_path = (array_key_exists('SERVER_NAME', $_SERVER) && array_key_exists('SCRIPT_NAME', $_SERVER)) ?
266               self::_sn_to_path($_SERVER['SCRIPT_NAME']) :
267             null;
268         }
269
270         // Set config values initially to default values
271         $default = self::defaultConfig();
272         $config = $default;
273
274         // default configuration, overwritten in config.php
275         // Keep DB_DataObject's db config synced to ours...
276
277         $config['db'] = &PEAR::getStaticProperty('DB_DataObject','options');
278
279         $config['db'] = $default['db'];
280
281         // Backward compatibility
282
283         $config['site']['design'] =& $config['design'];
284
285         if (function_exists('date_default_timezone_set')) {
286             /* Work internally in UTC */
287             date_default_timezone_set('UTC');
288         }
289     }
290
291     protected function _sn_to_path($sn)
292     {
293         $past_root = substr($sn, 1);
294         $last_slash = strrpos($past_root, '/');
295         if ($last_slash > 0) {
296             $p = substr($past_root, 0, $last_slash);
297         } else {
298             $p = '';
299         }
300         return $p;
301     }
302
303     /**
304      * Load the default or specified configuration file.
305      * Modifies global $config and may establish plugins.
306      *
307      * @throws NoConfigException
308      */
309     protected function loadConfigFile($conffile=null)
310     {
311         global $_server, $_path, $config;
312
313         // From most general to most specific:
314         // server-wide, then vhost-wide, then for a path,
315         // finally for a dir (usually only need one of the last two).
316
317         if (isset($conffile)) {
318             $config_files = array($conffile);
319         } else {
320             $config_files = array('/etc/statusnet/statusnet.php',
321                                   '/etc/statusnet/laconica.php',
322                                   '/etc/laconica/laconica.php',
323                                   '/etc/statusnet/'.$_server.'.php',
324                                   '/etc/laconica/'.$_server.'.php');
325
326             if (strlen($_path) > 0) {
327                 $config_files[] = '/etc/statusnet/'.$_server.'_'.$_path.'.php';
328                 $config_files[] = '/etc/laconica/'.$_server.'_'.$_path.'.php';
329             }
330
331             $config_files[] = INSTALLDIR.'/config.php';
332         }
333
334         self::$have_config = false;
335
336         foreach ($config_files as $_config_file) {
337             if (@file_exists($_config_file)) {
338                 // Ignore 0-byte config files
339                 if (filesize($_config_file) > 0) {
340                     include($_config_file);
341                     self::$have_config = true;
342                 }
343             }
344         }
345
346         if (!self::$have_config) {
347             throw new NoConfigException("No configuration file found.",
348                                         $config_files);
349         }
350
351         // Fixup for statusnet.ini
352         $_db_name = substr($config['db']['database'], strrpos($config['db']['database'], '/') + 1);
353
354         if ($_db_name != 'statusnet' && !array_key_exists('ini_'.$_db_name, $config['db'])) {
355             $config['db']['ini_'.$_db_name] = INSTALLDIR.'/classes/statusnet.ini';
356         }
357
358         // Backwards compatibility
359
360         if (array_key_exists('memcached', $config)) {
361             if ($config['memcached']['enabled']) {
362                 addPlugin('Memcache', array('servers' => $config['memcached']['server']));
363             }
364
365             if (!empty($config['memcached']['base'])) {
366                 $config['cache']['base'] = $config['memcached']['base'];
367             }
368         }
369     }
370
371     /**
372      * Are we running from the web with HTTPS?
373      *
374      * @return boolean true if we're running with HTTPS; else false
375      */
376
377     static function isHTTPS()
378     {
379         // There are some exceptions to this; add them here!
380         return !empty($_SERVER['HTTPS']);
381     }
382 }
383
384 class NoConfigException extends Exception
385 {
386     public $configFiles;
387
388     function __construct($msg, $configFiles) {
389         parent::__construct($msg);
390         $this->configFiles = $configFiles;
391     }
392 }