]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/statusnet.php
d94d856c9a01f7a9a67e321c11b3a0f9f43bd29c
[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             $key = 'disable-' . $name;
180             if (common_config('plugins', $key)) {
181                 continue;
182             }
183
184             if (is_null($params)) {
185                 addPlugin($name);
186             } else if (is_array($params)) {
187                 if (count($params) == 0) {
188                     addPlugin($name);
189                 } else {
190                     $keys = array_keys($params);
191                     if (is_string($keys[0])) {
192                         addPlugin($name, $params);
193                     } else {
194                         foreach ($params as $paramset) {
195                             addPlugin($name, $paramset);
196                         }
197                     }
198                 }
199             }
200         }
201
202         // XXX: if plugins should check the schema at runtime, do that here.
203         if (common_config('db', 'schemacheck') == 'runtime') {
204             Event::handle('CheckSchema');
205         }
206
207         // Give plugins a chance to initialize in a fully-prepared environment
208         Event::handle('InitializePlugin');
209     }
210
211     /**
212      * Quick-check if configuration has been established.
213      * Useful for functions which may get used partway through
214      * initialization to back off from fancier things.
215      *
216      * @return bool
217      */
218     public function haveConfig()
219     {
220         return self::$have_config;
221     }
222
223     public function isApi()
224     {
225         return self::$is_api;
226     }
227
228     public function setApi($mode)
229     {
230         self::$is_api = $mode;
231     }
232
233     /**
234      * Build default configuration array
235      * @return array
236      */
237     protected static function defaultConfig()
238     {
239         global $_server, $_path;
240         require(INSTALLDIR.'/lib/default.php');
241         return $default;
242     }
243
244     /**
245      * Establish default configuration based on given or default server and path
246      * Sets global $_server, $_path, and $config
247      */
248     public static function initDefaults($server, $path)
249     {
250         global $_server, $_path, $config;
251
252         Event::clearHandlers();
253         self::$plugins = array();
254
255         // try to figure out where we are. $server and $path
256         // can be set by including module, else we guess based
257         // on HTTP info.
258
259         if (isset($server)) {
260             $_server = $server;
261         } else {
262             $_server = array_key_exists('SERVER_NAME', $_SERVER) ?
263               strtolower($_SERVER['SERVER_NAME']) :
264             null;
265         }
266
267         if (isset($path)) {
268             $_path = $path;
269         } else {
270             $_path = (array_key_exists('SERVER_NAME', $_SERVER) && array_key_exists('SCRIPT_NAME', $_SERVER)) ?
271               self::_sn_to_path($_SERVER['SCRIPT_NAME']) :
272             null;
273         }
274
275         // Set config values initially to default values
276         $default = self::defaultConfig();
277         $config = $default;
278
279         // default configuration, overwritten in config.php
280         // Keep DB_DataObject's db config synced to ours...
281
282         $config['db'] = &PEAR::getStaticProperty('DB_DataObject','options');
283
284         $config['db'] = $default['db'];
285
286         // Backward compatibility
287
288         $config['site']['design'] =& $config['design'];
289
290         if (function_exists('date_default_timezone_set')) {
291             /* Work internally in UTC */
292             date_default_timezone_set('UTC');
293         }
294     }
295
296     protected function _sn_to_path($sn)
297     {
298         $past_root = substr($sn, 1);
299         $last_slash = strrpos($past_root, '/');
300         if ($last_slash > 0) {
301             $p = substr($past_root, 0, $last_slash);
302         } else {
303             $p = '';
304         }
305         return $p;
306     }
307
308     /**
309      * Load the default or specified configuration file.
310      * Modifies global $config and may establish plugins.
311      *
312      * @throws NoConfigException
313      */
314     protected function loadConfigFile($conffile=null)
315     {
316         global $_server, $_path, $config;
317
318         // From most general to most specific:
319         // server-wide, then vhost-wide, then for a path,
320         // finally for a dir (usually only need one of the last two).
321
322         if (isset($conffile)) {
323             $config_files = array($conffile);
324         } else {
325             $config_files = array('/etc/statusnet/statusnet.php',
326                                   '/etc/statusnet/laconica.php',
327                                   '/etc/laconica/laconica.php',
328                                   '/etc/statusnet/'.$_server.'.php',
329                                   '/etc/laconica/'.$_server.'.php');
330
331             if (strlen($_path) > 0) {
332                 $config_files[] = '/etc/statusnet/'.$_server.'_'.$_path.'.php';
333                 $config_files[] = '/etc/laconica/'.$_server.'_'.$_path.'.php';
334             }
335
336             $config_files[] = INSTALLDIR.'/config.php';
337         }
338
339         self::$have_config = false;
340
341         foreach ($config_files as $_config_file) {
342             if (@file_exists($_config_file)) {
343                 // Ignore 0-byte config files
344                 if (filesize($_config_file) > 0) {
345                     include($_config_file);
346                     self::$have_config = true;
347                 }
348             }
349         }
350
351         if (!self::$have_config) {
352             throw new NoConfigException("No configuration file found.",
353                                         $config_files);
354         }
355
356         // Fixup for statusnet.ini
357         $_db_name = substr($config['db']['database'], strrpos($config['db']['database'], '/') + 1);
358
359         if ($_db_name != 'statusnet' && !array_key_exists('ini_'.$_db_name, $config['db'])) {
360             $config['db']['ini_'.$_db_name] = INSTALLDIR.'/classes/statusnet.ini';
361         }
362
363         // Backwards compatibility
364         if (array_key_exists('memcached', $config)) {
365             if ($config['memcached']['enabled']) {
366                 addPlugin('Memcache', array('servers' => $config['memcached']['server']));
367             }
368
369             if (!empty($config['memcached']['base'])) {
370                 $config['cache']['base'] = $config['memcached']['base'];
371             }
372         }
373         if (array_key_exists('xmpp', $config)) {
374             if ($config['xmpp']['enabled']) {
375                 addPlugin('xmpp', array(
376                     'server' => $config['xmpp']['server'],
377                     'port' => $config['xmpp']['port'],
378                     'user' => $config['xmpp']['user'],
379                     'resource' => $config['xmpp']['resource'],
380                     'encryption' => $config['xmpp']['encryption'],
381                     'password' => $config['xmpp']['password'],
382                     'host' => $config['xmpp']['host'],
383                     'debug' => $config['xmpp']['debug'],
384                     'public' => $config['xmpp']['public']
385                 ));
386             }
387         }
388     }
389
390     /**
391      * Are we running from the web with HTTPS?
392      *
393      * @return boolean true if we're running with HTTPS; else false
394      */
395
396     static function isHTTPS()
397     {
398         // There are some exceptions to this; add them here!
399         return !empty($_SERVER['HTTPS']);
400     }
401 }
402
403 class NoConfigException extends Exception
404 {
405     public $configFiles;
406
407     function __construct($msg, $configFiles) {
408         parent::__construct($msg);
409         $this->configFiles = $configFiles;
410     }
411 }