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 $plugins = array();
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.
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
44 * @throws ServerException if plugin can't be found
46 public static function addPlugin($name, $attrs = null)
48 $name = ucfirst($name);
49 $pluginclass = "{$name}Plugin";
51 if (!class_exists($pluginclass)) {
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");
60 foreach ($files as $file) {
61 $fullpath = INSTALLDIR.'/'.$file;
62 if (@file_exists($fullpath)) {
63 include_once($fullpath);
67 if (!class_exists($pluginclass)) {
68 throw new ServerException("Plugin $name not found.", 500);
72 $inst = new $pluginclass();
74 foreach ($attrs as $aname => $avalue) {
75 $inst->$aname = $avalue;
79 // Record activated plugins for later display/config dump
80 self::$plugins[] = array($name, $attrs);
86 * Get a list of activated plugins in this process.
87 * @return array of (string $name, array $args) pairs
89 public static function getActivePlugins()
91 return self::$plugins;
95 * Initialize, or re-initialize, StatusNet global configuration
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.
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
106 * @throws NoConfigException if config file can't be found
108 public static function init($server=null, $path=null, $conffile=null)
110 StatusNet::initDefaults($server, $path);
111 StatusNet::loadConfigFile($conffile);
113 // Load settings from database; note we need autoload for this
114 Config::loadSettings();
120 * Get identifier of the currently active site configuration
123 public static function currentSite()
125 return common_config('site', 'nickname');
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.
133 * May throw exception or trigger a fatal error if the given
134 * site is missing or configured incorrectly.
136 * @param string $nickname
138 public static function switchSite($nickname)
140 if ($nickname == StatusNet::currentSite()) {
144 $sn = Status_network::staticGet('nickname', $nickname);
147 throw new Exception("No such site nickname '$nickname'");
150 $server = $sn->getServerName();
151 StatusNet::init($server);
155 * Pull all local sites from status_network table.
157 * Behavior undefined if site is not configured via Status_network.
159 * @return array of nicknames
161 public static function findAllSites()
164 $sn = new Status_network();
166 while ($sn->fetch()) {
167 $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 if (is_null($params)) {
182 } else if (is_array($params)) {
183 if (count($params) == 0) {
186 $keys = array_keys($params);
187 if (is_string($keys[0])) {
188 addPlugin($name, $params);
190 foreach ($params as $paramset) {
191 addPlugin($name, $paramset);
198 // XXX: if plugins should check the schema at runtime, do that here.
199 if (common_config('db', 'schemacheck') == 'runtime') {
200 Event::handle('CheckSchema');
203 // Give plugins a chance to initialize in a fully-prepared environment
204 Event::handle('InitializePlugin');
208 * Quick-check if configuration has been established.
209 * Useful for functions which may get used partway through
210 * initialization to back off from fancier things.
214 public function haveConfig()
216 return self::$have_config;
219 public function isApi()
221 return self::$is_api;
224 public function setApi($mode)
226 self::$is_api = $mode;
230 * Build default configuration array
233 protected static function defaultConfig()
235 global $_server, $_path;
236 require(INSTALLDIR.'/lib/default.php');
241 * Establish default configuration based on given or default server and path
242 * Sets global $_server, $_path, and $config
244 protected static function initDefaults($server, $path)
246 global $_server, $_path, $config;
248 Event::clearHandlers();
249 self::$plugins = array();
251 // try to figure out where we are. $server and $path
252 // can be set by including module, else we guess based
255 if (isset($server)) {
258 $_server = array_key_exists('SERVER_NAME', $_SERVER) ?
259 strtolower($_SERVER['SERVER_NAME']) :
266 $_path = (array_key_exists('SERVER_NAME', $_SERVER) && array_key_exists('SCRIPT_NAME', $_SERVER)) ?
267 self::_sn_to_path($_SERVER['SCRIPT_NAME']) :
271 // Set config values initially to default values
272 $default = self::defaultConfig();
275 // default configuration, overwritten in config.php
276 // Keep DB_DataObject's db config synced to ours...
278 $config['db'] = &PEAR::getStaticProperty('DB_DataObject','options');
280 $config['db'] = $default['db'];
282 // Backward compatibility
284 $config['site']['design'] =& $config['design'];
286 if (function_exists('date_default_timezone_set')) {
287 /* Work internally in UTC */
288 date_default_timezone_set('UTC');
292 protected function _sn_to_path($sn)
294 $past_root = substr($sn, 1);
295 $last_slash = strrpos($past_root, '/');
296 if ($last_slash > 0) {
297 $p = substr($past_root, 0, $last_slash);
305 * Load the default or specified configuration file.
306 * Modifies global $config and may establish plugins.
308 * @throws NoConfigException
310 protected function loadConfigFile($conffile=null)
312 global $_server, $_path, $config;
314 // From most general to most specific:
315 // server-wide, then vhost-wide, then for a path,
316 // finally for a dir (usually only need one of the last two).
318 if (isset($conffile)) {
319 $config_files = array($conffile);
321 $config_files = array('/etc/statusnet/statusnet.php',
322 '/etc/statusnet/laconica.php',
323 '/etc/laconica/laconica.php',
324 '/etc/statusnet/'.$_server.'.php',
325 '/etc/laconica/'.$_server.'.php');
327 if (strlen($_path) > 0) {
328 $config_files[] = '/etc/statusnet/'.$_server.'_'.$_path.'.php';
329 $config_files[] = '/etc/laconica/'.$_server.'_'.$_path.'.php';
332 $config_files[] = INSTALLDIR.'/config.php';
335 self::$have_config = false;
337 foreach ($config_files as $_config_file) {
338 if (@file_exists($_config_file)) {
339 // Ignore 0-byte config files
340 if (filesize($_config_file) > 0) {
341 include($_config_file);
342 self::$have_config = true;
347 if (!self::$have_config) {
348 throw new NoConfigException("No configuration file found.",
352 // Fixup for statusnet.ini
353 $_db_name = substr($config['db']['database'], strrpos($config['db']['database'], '/') + 1);
355 if ($_db_name != 'statusnet' && !array_key_exists('ini_'.$_db_name, $config['db'])) {
356 $config['db']['ini_'.$_db_name] = INSTALLDIR.'/classes/statusnet.ini';
359 // Backwards compatibility
361 if (array_key_exists('memcached', $config)) {
362 if ($config['memcached']['enabled']) {
363 addPlugin('Memcache', array('servers' => $config['memcached']['server']));
366 if (!empty($config['memcached']['base'])) {
367 $config['cache']['base'] = $config['memcached']['base'];
373 class NoConfigException extends Exception
377 function __construct($msg, $configFiles) {
378 parent::__construct($msg);
379 $this->configFiles = $configFiles;