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;
36 * Configure and instantiate a plugin into the current configuration.
37 * Class definitions will be loaded from standard paths if necessary.
38 * Note that initialization events won't be fired until later.
40 * @param string $name class name & plugin file/subdir name
41 * @param array $attrs key/value pairs of public attributes to set on plugin instance
43 * @throws ServerException if plugin can't be found
45 public static function addPlugin($name, $attrs = null)
47 $name = ucfirst($name);
48 $pluginclass = "{$name}Plugin";
50 if (!class_exists($pluginclass)) {
52 $files = array("local/plugins/{$pluginclass}.php",
53 "local/plugins/{$name}/{$pluginclass}.php",
54 "local/{$pluginclass}.php",
55 "local/{$name}/{$pluginclass}.php",
56 "plugins/{$pluginclass}.php",
57 "plugins/{$name}/{$pluginclass}.php");
59 foreach ($files as $file) {
60 $fullpath = INSTALLDIR.'/'.$file;
61 if (@file_exists($fullpath)) {
62 include_once($fullpath);
66 if (!class_exists($pluginclass)) {
67 throw new ServerException("Plugin $name not found.", 500);
71 $inst = new $pluginclass();
73 foreach ($attrs as $aname => $avalue) {
74 $inst->$aname = $avalue;
81 * Initialize, or re-initialize, StatusNet global configuration
84 * If switching site configurations during script execution, be
85 * careful when working with leftover objects -- global settings
86 * affect many things and they may not behave as you expected.
88 * @param $server optional web server hostname for picking config
89 * @param $path optional URL path for picking config
90 * @param $conffile optional configuration file path
92 * @throws NoConfigException if config file can't be found
94 public static function init($server=null, $path=null, $conffile=null)
96 StatusNet::initDefaults($server, $path);
97 StatusNet::loadConfigFile($conffile);
99 // Load settings from database; note we need autoload for this
100 Config::loadSettings();
106 * Fire initialization events for all instantiated plugins.
108 protected static function initPlugins()
110 // Load default plugins
111 foreach (common_config('plugins', 'default') as $name => $params) {
112 if (is_null($params)) {
114 } else if (is_array($params)) {
115 if (count($params) == 0) {
118 $keys = array_keys($params);
119 if (is_string($keys[0])) {
120 addPlugin($name, $params);
122 foreach ($params as $paramset) {
123 addPlugin($name, $paramset);
130 // XXX: if plugins should check the schema at runtime, do that here.
131 if (common_config('db', 'schemacheck') == 'runtime') {
132 Event::handle('CheckSchema');
135 // Give plugins a chance to initialize in a fully-prepared environment
136 Event::handle('InitializePlugin');
140 * Quick-check if configuration has been established.
141 * Useful for functions which may get used partway through
142 * initialization to back off from fancier things.
146 public function haveConfig()
148 return self::$have_config;
151 public function isApi()
153 return self::$is_api;
156 public function setApi($mode)
158 self::$is_api = $mode;
162 * Build default configuration array
165 protected static function defaultConfig()
167 global $_server, $_path;
168 require(INSTALLDIR.'/lib/default.php');
173 * Establish default configuration based on given or default server and path
174 * Sets global $_server, $_path, and $config
176 protected static function initDefaults($server, $path)
178 global $_server, $_path, $config;
180 Event::clearHandlers();
182 // try to figure out where we are. $server and $path
183 // can be set by including module, else we guess based
186 if (isset($server)) {
189 $_server = array_key_exists('SERVER_NAME', $_SERVER) ?
190 strtolower($_SERVER['SERVER_NAME']) :
197 $_path = (array_key_exists('SERVER_NAME', $_SERVER) && array_key_exists('SCRIPT_NAME', $_SERVER)) ?
198 self::_sn_to_path($_SERVER['SCRIPT_NAME']) :
202 // Set config values initially to default values
203 $default = self::defaultConfig();
206 // default configuration, overwritten in config.php
207 // Keep DB_DataObject's db config synced to ours...
209 $config['db'] = &PEAR::getStaticProperty('DB_DataObject','options');
211 $config['db'] = $default['db'];
213 // Backward compatibility
215 $config['site']['design'] =& $config['design'];
217 if (function_exists('date_default_timezone_set')) {
218 /* Work internally in UTC */
219 date_default_timezone_set('UTC');
223 protected function _sn_to_path($sn)
225 $past_root = substr($sn, 1);
226 $last_slash = strrpos($past_root, '/');
227 if ($last_slash > 0) {
228 $p = substr($past_root, 0, $last_slash);
236 * Load the default or specified configuration file.
237 * Modifies global $config and may establish plugins.
239 * @throws NoConfigException
241 protected function loadConfigFile($conffile=null)
243 global $_server, $_path, $config;
245 // From most general to most specific:
246 // server-wide, then vhost-wide, then for a path,
247 // finally for a dir (usually only need one of the last two).
249 if (isset($conffile)) {
250 $config_files = array($conffile);
252 $config_files = array('/etc/statusnet/statusnet.php',
253 '/etc/statusnet/laconica.php',
254 '/etc/laconica/laconica.php',
255 '/etc/statusnet/'.$_server.'.php',
256 '/etc/laconica/'.$_server.'.php');
258 if (strlen($_path) > 0) {
259 $config_files[] = '/etc/statusnet/'.$_server.'_'.$_path.'.php';
260 $config_files[] = '/etc/laconica/'.$_server.'_'.$_path.'.php';
263 $config_files[] = INSTALLDIR.'/config.php';
266 self::$have_config = false;
268 foreach ($config_files as $_config_file) {
269 if (@file_exists($_config_file)) {
270 include($_config_file);
271 self::$have_config = true;
275 if (!self::$have_config) {
276 throw new NoConfigException("No configuration file found.",
280 // Fixup for statusnet.ini
281 $_db_name = substr($config['db']['database'], strrpos($config['db']['database'], '/') + 1);
283 if ($_db_name != 'statusnet' && !array_key_exists('ini_'.$_db_name, $config['db'])) {
284 $config['db']['ini_'.$_db_name] = INSTALLDIR.'/classes/statusnet.ini';
287 // Backwards compatibility
289 if (array_key_exists('memcached', $config)) {
290 if ($config['memcached']['enabled']) {
291 addPlugin('Memcache', array('servers' => $config['memcached']['server']));
294 if (!empty($config['memcached']['base'])) {
295 $config['cache']['base'] = $config['memcached']['base'];
301 class NoConfigException extends Exception
303 public $config_files;
305 function __construct($msg, $config_files) {
306 parent::__construct($msg);
307 $this->config_files = $config_files;