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
  35     /**
  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.
  39      *
  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
  42      *
  43      * @throws ServerException if plugin can't be found
  44      */
  45     public static function addPlugin($name, $attrs = null)
  46     {
  47         $name = ucfirst($name);
  48         $pluginclass = "{$name}Plugin";
  49
  50         if (!class_exists($pluginclass)) {
  51
  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");
  58
  59             foreach ($files as $file) {
  60                 $fullpath = INSTALLDIR.'/'.$file;
  61                 if (@file_exists($fullpath)) {
  62                     include_once($fullpath);
  63                     break;
  64                 }
  65             }
  66             if (!class_exists($pluginclass)) {
  67                 throw new ServerException("Plugin $name not found.", 500);
  68             }
  69         }
  70
  71         $inst = new $pluginclass();
  72         if (!empty($attrs)) {
  73             foreach ($attrs as $aname => $avalue) {
  74                 $inst->$aname = $avalue;
  75             }
  76         }
  77         return true;
  78     }
  79
  80     /**
  81      * Initialize, or re-initialize, StatusNet global configuration
  82      * and plugins.
  83      *
  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.
  87      *
  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
  91      *
  92      * @throws NoConfigException if config file can't be found
  93      */
  94     public static function init($server=null, $path=null, $conffile=null)
  95     {
  96         StatusNet::initDefaults($server, $path);
  97         StatusNet::loadConfigFile($conffile);
  98
  99         // Load settings from database; note we need autoload for this
 100         Config::loadSettings();
 101
 102         self::initPlugins();
 103     }
 104
 105     /**
 106      * Fire initialization events for all instantiated plugins.
 107      */
 108     protected static function initPlugins()
 109     {
 110         // Load default plugins
 111         foreach (common_config('plugins', 'default') as $name => $params) {
 112             if (is_null($params)) {
 113                 addPlugin($name);
 114             } else if (is_array($params)) {
 115                 if (count($params) == 0) {
 116                     addPlugin($name);
 117                 } else {
 118                     $keys = array_keys($params);
 119                     if (is_string($keys[0])) {
 120                         addPlugin($name, $params);
 121                     } else {
 122                         foreach ($params as $paramset) {
 123                             addPlugin($name, $paramset);
 124                         }
 125                     }
 126                 }
 127             }
 128         }
 129
 130         // XXX: if plugins should check the schema at runtime, do that here.
 131         if (common_config('db', 'schemacheck') == 'runtime') {
 132             Event::handle('CheckSchema');
 133         }
 134
 135         // Give plugins a chance to initialize in a fully-prepared environment
 136         Event::handle('InitializePlugin');
 137     }
 138
 139     /**
 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.
 143      *
 144      * @return bool
 145      */
 146     public function haveConfig()
 147     {
 148         return self::$have_config;
 149     }
 150
 151     public function isApi()
 152     {
 153         return self::$is_api;
 154     }
 155
 156     public function setApi($mode)
 157     {
 158         self::$is_api = $mode;
 159     }
 160
 161     /**
 162      * Build default configuration array
 163      * @return array
 164      */
 165     protected static function defaultConfig()
 166     {
 167         global $_server, $_path;
 168         require(INSTALLDIR.'/lib/default.php');
 169         return $default;
 170     }
 171
 172     /**
 173      * Establish default configuration based on given or default server and path
 174      * Sets global $_server, $_path, and $config
 175      */
 176     protected static function initDefaults($server, $path)
 177     {
 178         global $_server, $_path, $config;
 179
 180         Event::clearHandlers();
 181
 182         // try to figure out where we are. $server and $path
 183         // can be set by including module, else we guess based
 184         // on HTTP info.
 185
 186         if (isset($server)) {
 187             $_server = $server;
 188         } else {
 189             $_server = array_key_exists('SERVER_NAME', $_SERVER) ?
 190               strtolower($_SERVER['SERVER_NAME']) :
 191             null;
 192         }
 193
 194         if (isset($path)) {
 195             $_path = $path;
 196         } else {
 197             $_path = (array_key_exists('SERVER_NAME', $_SERVER) && array_key_exists('SCRIPT_NAME', $_SERVER)) ?
 198               self::_sn_to_path($_SERVER['SCRIPT_NAME']) :
 199             null;
 200         }
 201
 202         // Set config values initially to default values
 203         $default = self::defaultConfig();
 204         $config = $default;
 205
 206         // default configuration, overwritten in config.php
 207         // Keep DB_DataObject's db config synced to ours...
 208
 209         $config['db'] = &PEAR::getStaticProperty('DB_DataObject','options');
 210
 211         $config['db'] = $default['db'];
 212
 213         // Backward compatibility
 214
 215         $config['site']['design'] =& $config['design'];
 216
 217         if (function_exists('date_default_timezone_set')) {
 218             /* Work internally in UTC */
 219             date_default_timezone_set('UTC');
 220         }
 221     }
 222
 223     protected function _sn_to_path($sn)
 224     {
 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);
 229         } else {
 230             $p = '';
 231         }
 232         return $p;
 233     }
 234
 235     /**
 236      * Load the default or specified configuration file.
 237      * Modifies global $config and may establish plugins.
 238      *
 239      * @throws NoConfigException
 240      */
 241     protected function loadConfigFile($conffile=null)
 242     {
 243         global $_server, $_path, $config;
 244
 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).
 248
 249         if (isset($conffile)) {
 250             $config_files = array($conffile);
 251         } else {
 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');
 257
 258             if (strlen($_path) > 0) {
 259                 $config_files[] = '/etc/statusnet/'.$_server.'_'.$_path.'.php';
 260                 $config_files[] = '/etc/laconica/'.$_server.'_'.$_path.'.php';
 261             }
 262
 263             $config_files[] = INSTALLDIR.'/config.php';
 264         }
 265
 266         self::$have_config = false;
 267
 268         foreach ($config_files as $_config_file) {
 269             if (@file_exists($_config_file)) {
 270                 include($_config_file);
 271                 self::$have_config = true;
 272             }
 273         }
 274
 275         if (!self::$have_config) {
 276             throw new NoConfigException("No configuration file found.",
 277                                         $config_files);
 278         }
 279
 280         // Fixup for statusnet.ini
 281         $_db_name = substr($config['db']['database'], strrpos($config['db']['database'], '/') + 1);
 282
 283         if ($_db_name != 'statusnet' && !array_key_exists('ini_'.$_db_name, $config['db'])) {
 284             $config['db']['ini_'.$_db_name] = INSTALLDIR.'/classes/statusnet.ini';
 285         }
 286
 287         // Backwards compatibility
 288
 289         if (array_key_exists('memcached', $config)) {
 290             if ($config['memcached']['enabled']) {
 291                 addPlugin('Memcache', array('servers' => $config['memcached']['server']));
 292             }
 293
 294             if (!empty($config['memcached']['base'])) {
 295                 $config['cache']['base'] = $config['memcached']['base'];
 296             }
 297         }
 298     }
 299 }
 300
 301 class NoConfigException extends Exception
 302 {
 303     public $config_files;
 304
 305     function __construct($msg, $config_files) {
 306         parent::__construct($msg);
 307         $this->config_files = $config_files;
 308     }
 309 }