3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2009-2010 StatusNet, Inc.
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.
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.
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/>.
21 if (!defined('STATUSNET') && !defined('LACONICA')) {
25 global $config, $_server, $_path;
28 * Global configuration setup and management.
32 protected static $have_config;
33 protected static $is_api;
34 protected static $is_ajax;
35 protected static $plugins = array();
38 * Configure and instantiate a plugin into the current configuration.
39 * Class definitions will be loaded from standard paths if necessary.
40 * Note that initialization events won't be fired until later.
42 * @param string $name class name & plugin file/subdir name
43 * @param array $attrs key/value pairs of public attributes to set on plugin instance
45 * @throws ServerException if plugin can't be found
47 public static function addPlugin($name, $attrs = null)
49 $name = ucfirst($name);
50 $pluginclass = "{$name}Plugin";
52 if (!class_exists($pluginclass)) {
54 $files = array("local/plugins/{$pluginclass}.php",
55 "local/plugins/{$name}/{$pluginclass}.php",
56 "local/{$pluginclass}.php",
57 "local/{$name}/{$pluginclass}.php",
58 "plugins/{$pluginclass}.php",
59 "plugins/{$name}/{$pluginclass}.php");
61 foreach ($files as $file) {
62 $fullpath = INSTALLDIR.'/'.$file;
63 if (@file_exists($fullpath)) {
64 include_once($fullpath);
68 if (!class_exists($pluginclass)) {
69 throw new ServerException("Plugin $name not found.", 500);
73 $inst = new $pluginclass();
75 foreach ($attrs as $aname => $avalue) {
76 $inst->$aname = $avalue;
80 // Record activated plugins for later display/config dump
81 self::$plugins[] = array($name, $attrs);
87 * Get a list of activated plugins in this process.
88 * @return array of (string $name, array $args) pairs
90 public static function getActivePlugins()
92 return self::$plugins;
96 * Initialize, or re-initialize, StatusNet global configuration
99 * If switching site configurations during script execution, be
100 * careful when working with leftover objects -- global settings
101 * affect many things and they may not behave as you expected.
103 * @param $server optional web server hostname for picking config
104 * @param $path optional URL path for picking config
105 * @param $conffile optional configuration file path
107 * @throws NoConfigException if config file can't be found
109 public static function init($server=null, $path=null, $conffile=null)
111 StatusNet::initDefaults($server, $path);
112 StatusNet::loadConfigFile($conffile);
114 // Load settings from database; note we need autoload for this
115 Config::loadSettings();
121 * Get identifier of the currently active site configuration
124 public static function currentSite()
126 return common_config('site', 'nickname');
130 * Change site configuration to site specified by nickname,
131 * if set up via Status_network. If not, sites other than
132 * the current will fail horribly.
134 * May throw exception or trigger a fatal error if the given
135 * site is missing or configured incorrectly.
137 * @param string $nickname
139 public static function switchSite($nickname)
141 if ($nickname == StatusNet::currentSite()) {
145 $sn = Status_network::staticGet('nickname', $nickname);
148 throw new Exception("No such site nickname '$nickname'");
151 $server = $sn->getServerName();
152 StatusNet::init($server);
156 * Pull all local sites from status_network table.
158 * Behavior undefined if site is not configured via Status_network.
160 * @return array of nicknames
162 public static function findAllSites()
165 $sn = new Status_network();
167 while ($sn->fetch()) {
168 $sites[] = $sn->nickname;
174 * Fire initialization events for all instantiated plugins.
176 protected static function initPlugins()
178 // Load default plugins
179 foreach (common_config('plugins', 'default') as $name => $params) {
180 $key = 'disable-' . $name;
181 if (common_config('plugins', $key)) {
185 if (is_null($params)) {
187 } else if (is_array($params)) {
188 if (count($params) == 0) {
191 $keys = array_keys($params);
192 if (is_string($keys[0])) {
193 addPlugin($name, $params);
195 foreach ($params as $paramset) {
196 addPlugin($name, $paramset);
203 // XXX: if plugins should check the schema at runtime, do that here.
204 if (common_config('db', 'schemacheck') == 'runtime') {
205 Event::handle('CheckSchema');
208 // Give plugins a chance to initialize in a fully-prepared environment
209 Event::handle('InitializePlugin');
213 * Quick-check if configuration has been established.
214 * Useful for functions which may get used partway through
215 * initialization to back off from fancier things.
219 public function haveConfig()
221 return self::$have_config;
224 public function isApi()
226 return self::$is_api;
229 public function setApi($mode)
231 self::$is_api = $mode;
234 public function isAjax()
236 return self::$is_ajax;
239 public function setAjax($mode)
241 self::$is_ajax = $mode;
245 * Build default configuration array
248 protected static function defaultConfig()
250 global $_server, $_path;
251 require(INSTALLDIR.'/lib/default.php');
256 * Establish default configuration based on given or default server and path
257 * Sets global $_server, $_path, and $config
259 public static function initDefaults($server, $path)
261 global $_server, $_path, $config;
263 Event::clearHandlers();
264 self::$plugins = array();
266 // try to figure out where we are. $server and $path
267 // can be set by including module, else we guess based
270 if (isset($server)) {
273 $_server = array_key_exists('SERVER_NAME', $_SERVER) ?
274 strtolower($_SERVER['SERVER_NAME']) :
281 $_path = (array_key_exists('SERVER_NAME', $_SERVER) && array_key_exists('SCRIPT_NAME', $_SERVER)) ?
282 self::_sn_to_path($_SERVER['SCRIPT_NAME']) :
286 // Set config values initially to default values
287 $default = self::defaultConfig();
290 // default configuration, overwritten in config.php
291 // Keep DB_DataObject's db config synced to ours...
293 $config['db'] = &PEAR::getStaticProperty('DB_DataObject','options');
295 $config['db'] = $default['db'];
297 // Backward compatibility
299 $config['site']['design'] =& $config['design'];
301 if (function_exists('date_default_timezone_set')) {
302 /* Work internally in UTC */
303 date_default_timezone_set('UTC');
307 protected function _sn_to_path($sn)
309 $past_root = substr($sn, 1);
310 $last_slash = strrpos($past_root, '/');
311 if ($last_slash > 0) {
312 $p = substr($past_root, 0, $last_slash);
320 * Load the default or specified configuration file.
321 * Modifies global $config and may establish plugins.
323 * @throws NoConfigException
325 protected function loadConfigFile($conffile=null)
327 global $_server, $_path, $config;
329 // From most general to most specific:
330 // server-wide, then vhost-wide, then for a path,
331 // finally for a dir (usually only need one of the last two).
333 if (isset($conffile)) {
334 $config_files = array($conffile);
336 $config_files = array('/etc/statusnet/statusnet.php',
337 '/etc/statusnet/laconica.php',
338 '/etc/laconica/laconica.php',
339 '/etc/statusnet/'.$_server.'.php',
340 '/etc/laconica/'.$_server.'.php');
342 if (strlen($_path) > 0) {
343 $config_files[] = '/etc/statusnet/'.$_server.'_'.$_path.'.php';
344 $config_files[] = '/etc/laconica/'.$_server.'_'.$_path.'.php';
347 $config_files[] = INSTALLDIR.'/config.php';
350 self::$have_config = false;
352 foreach ($config_files as $_config_file) {
353 if (@file_exists($_config_file)) {
354 // Ignore 0-byte config files
355 if (filesize($_config_file) > 0) {
356 include($_config_file);
357 self::$have_config = true;
362 if (!self::$have_config) {
363 throw new NoConfigException("No configuration file found.",
367 // Fixup for statusnet.ini
368 $_db_name = substr($config['db']['database'], strrpos($config['db']['database'], '/') + 1);
370 if ($_db_name != 'statusnet' && !array_key_exists('ini_'.$_db_name, $config['db'])) {
371 $config['db']['ini_'.$_db_name] = INSTALLDIR.'/classes/statusnet.ini';
374 // Backwards compatibility
375 if (array_key_exists('memcached', $config)) {
376 if ($config['memcached']['enabled']) {
377 addPlugin('Memcache', array('servers' => $config['memcached']['server']));
380 if (!empty($config['memcached']['base'])) {
381 $config['cache']['base'] = $config['memcached']['base'];
384 if (array_key_exists('xmpp', $config)) {
385 if ($config['xmpp']['enabled']) {
386 addPlugin('xmpp', array(
387 'server' => $config['xmpp']['server'],
388 'port' => $config['xmpp']['port'],
389 'user' => $config['xmpp']['user'],
390 'resource' => $config['xmpp']['resource'],
391 'encryption' => $config['xmpp']['encryption'],
392 'password' => $config['xmpp']['password'],
393 'host' => $config['xmpp']['host'],
394 'debug' => $config['xmpp']['debug'],
395 'public' => $config['xmpp']['public']
402 * Are we running from the web with HTTPS?
404 * @return boolean true if we're running with HTTPS; else false
407 static function isHTTPS()
409 // There are some exceptions to this; add them here!
410 if(empty($_SERVER['HTTPS'])) {
413 return $_SERVER['HTTPS'] !== 'off';
418 class NoConfigException extends Exception
422 function __construct($msg, $configFiles) {
423 parent::__construct($msg);
424 $this->configFiles = $configFiles;