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     /**
 174      * Fire initialization events for all instantiated plugins.
 175      */
 176     protected static function initPlugins()
 177     {
 178         // Load default plugins
 179         foreach (common_config('plugins', 'default') as $name => $params) {
 180             if (is_null($params)) {
 181                 addPlugin($name);
 182             } else if (is_array($params)) {
 183                 if (count($params) == 0) {
 184                     addPlugin($name);
 185                 } else {
 186                     $keys = array_keys($params);
 187                     if (is_string($keys[0])) {
 188                         addPlugin($name, $params);
 189                     } else {
 190                         foreach ($params as $paramset) {
 191                             addPlugin($name, $paramset);
 192                         }
 193                     }
 194                 }
 195             }
 196         }
 197
 198         // XXX: if plugins should check the schema at runtime, do that here.
 199         if (common_config('db', 'schemacheck') == 'runtime') {
 200             Event::handle('CheckSchema');
 201         }
 202
 203         // Give plugins a chance to initialize in a fully-prepared environment
 204         Event::handle('InitializePlugin');
 205     }
 206
 207     /**
 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.
 211      *
 212      * @return bool
 213      */
 214     public function haveConfig()
 215     {
 216         return self::$have_config;
 217     }
 218
 219     public function isApi()
 220     {
 221         return self::$is_api;
 222     }
 223
 224     public function setApi($mode)
 225     {
 226         self::$is_api = $mode;
 227     }
 228
 229     /**
 230      * Build default configuration array
 231      * @return array
 232      */
 233     protected static function defaultConfig()
 234     {
 235         global $_server, $_path;
 236         require(INSTALLDIR.'/lib/default.php');
 237         return $default;
 238     }
 239
 240     /**
 241      * Establish default configuration based on given or default server and path
 242      * Sets global $_server, $_path, and $config
 243      */
 244     protected static function initDefaults($server, $path)
 245     {
 246         global $_server, $_path, $config;
 247
 248         Event::clearHandlers();
 249         self::$plugins = array();
 250
 251         // try to figure out where we are. $server and $path
 252         // can be set by including module, else we guess based
 253         // on HTTP info.
 254
 255         if (isset($server)) {
 256             $_server = $server;
 257         } else {
 258             $_server = array_key_exists('SERVER_NAME', $_SERVER) ?
 259               strtolower($_SERVER['SERVER_NAME']) :
 260             null;
 261         }
 262
 263         if (isset($path)) {
 264             $_path = $path;
 265         } else {
 266             $_path = (array_key_exists('SERVER_NAME', $_SERVER) && array_key_exists('SCRIPT_NAME', $_SERVER)) ?
 267               self::_sn_to_path($_SERVER['SCRIPT_NAME']) :
 268             null;
 269         }
 270
 271         // Set config values initially to default values
 272         $default = self::defaultConfig();
 273         $config = $default;
 274
 275         // default configuration, overwritten in config.php
 276         // Keep DB_DataObject's db config synced to ours...
 277
 278         $config['db'] = &PEAR::getStaticProperty('DB_DataObject','options');
 279
 280         $config['db'] = $default['db'];
 281
 282         // Backward compatibility
 283
 284         $config['site']['design'] =& $config['design'];
 285
 286         if (function_exists('date_default_timezone_set')) {
 287             /* Work internally in UTC */
 288             date_default_timezone_set('UTC');
 289         }
 290     }
 291
 292     protected function _sn_to_path($sn)
 293     {
 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);
 298         } else {
 299             $p = '';
 300         }
 301         return $p;
 302     }
 303
 304     /**
 305      * Load the default or specified configuration file.
 306      * Modifies global $config and may establish plugins.
 307      *
 308      * @throws NoConfigException
 309      */
 310     protected function loadConfigFile($conffile=null)
 311     {
 312         global $_server, $_path, $config;
 313
 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).
 317
 318         if (isset($conffile)) {
 319             $config_files = array($conffile);
 320         } else {
 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');
 326
 327             if (strlen($_path) > 0) {
 328                 $config_files[] = '/etc/statusnet/'.$_server.'_'.$_path.'.php';
 329                 $config_files[] = '/etc/laconica/'.$_server.'_'.$_path.'.php';
 330             }
 331
 332             $config_files[] = INSTALLDIR.'/config.php';
 333         }
 334
 335         self::$have_config = false;
 336
 337         foreach ($config_files as $_config_file) {
 338             if (@file_exists($_config_file)) {
 339                 include($_config_file);
 340                 self::$have_config = true;
 341             }
 342         }
 343
 344         if (!self::$have_config) {
 345             throw new NoConfigException("No configuration file found.",
 346                                         $config_files);
 347         }
 348
 349         // Fixup for statusnet.ini
 350         $_db_name = substr($config['db']['database'], strrpos($config['db']['database'], '/') + 1);
 351
 352         if ($_db_name != 'statusnet' && !array_key_exists('ini_'.$_db_name, $config['db'])) {
 353             $config['db']['ini_'.$_db_name] = INSTALLDIR.'/classes/statusnet.ini';
 354         }
 355
 356         // Backwards compatibility
 357
 358         if (array_key_exists('memcached', $config)) {
 359             if ($config['memcached']['enabled']) {
 360                 addPlugin('Memcache', array('servers' => $config['memcached']['server']));
 361             }
 362
 363             if (!empty($config['memcached']['base'])) {
 364                 $config['cache']['base'] = $config['memcached']['base'];
 365             }
 366         }
 367     }
 368 }
 369
 370 class NoConfigException extends Exception
 371 {
 372     public $configFiles;
 373
 374     function __construct($msg, $configFiles) {
 375         parent::__construct($msg);
 376         $this->configFiles = $configFiles;
 377     }
 378 }