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 $is_ajax;
  35     protected static $plugins = array();
  36
  37     /**
  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.
  41      *
  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
  44      *
  45      * @throws ServerException if plugin can't be found
  46      */
  47     public static function addPlugin($name, $attrs = null)
  48     {
  49         $name = ucfirst($name);
  50         $pluginclass = "{$name}Plugin";
  51
  52         if (!class_exists($pluginclass)) {
  53
  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");
  60
  61             foreach ($files as $file) {
  62                 $fullpath = INSTALLDIR.'/'.$file;
  63                 if (@file_exists($fullpath)) {
  64                     include_once($fullpath);
  65                     break;
  66                 }
  67             }
  68             if (!class_exists($pluginclass)) {
  69                 throw new ServerException("Plugin $name not found.", 500);
  70             }
  71         }
  72
  73         $inst = new $pluginclass();
  74         if (!empty($attrs)) {
  75             foreach ($attrs as $aname => $avalue) {
  76                 $inst->$aname = $avalue;
  77             }
  78         }
  79
  80         // Record activated plugins for later display/config dump
  81         self::$plugins[] = array($name, $attrs);
  82
  83         return true;
  84     }
  85
  86     /**
  87      * Get a list of activated plugins in this process.
  88      * @return array of (string $name, array $args) pairs
  89      */
  90     public static function getActivePlugins()
  91     {
  92         return self::$plugins;
  93     }
  94
  95     /**
  96      * Initialize, or re-initialize, StatusNet global configuration
  97      * and plugins.
  98      *
  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.
 102      *
 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
 106      *
 107      * @throws NoConfigException if config file can't be found
 108      */
 109     public static function init($server=null, $path=null, $conffile=null)
 110     {
 111         Router::clear();
 112
 113         StatusNet::initDefaults($server, $path);
 114         StatusNet::loadConfigFile($conffile);
 115
 116         // Load settings from database; note we need autoload for this
 117         Config::loadSettings();
 118
 119         self::initPlugins();
 120     }
 121
 122     /**
 123      * Get identifier of the currently active site configuration
 124      * @return string
 125      */
 126     public static function currentSite()
 127     {
 128         return common_config('site', 'nickname');
 129     }
 130
 131     /**
 132      * Change site configuration to site specified by nickname,
 133      * if set up via Status_network. If not, sites other than
 134      * the current will fail horribly.
 135      *
 136      * May throw exception or trigger a fatal error if the given
 137      * site is missing or configured incorrectly.
 138      *
 139      * @param string $nickname
 140      */
 141     public static function switchSite($nickname)
 142     {
 143         if ($nickname == StatusNet::currentSite()) {
 144             return true;
 145         }
 146
 147         $sn = Status_network::staticGet('nickname', $nickname);
 148         if (empty($sn)) {
 149             return false;
 150             throw new Exception("No such site nickname '$nickname'");
 151         }
 152
 153         $server = $sn->getServerName();
 154         StatusNet::init($server);
 155     }
 156
 157     /**
 158      * Pull all local sites from status_network table.
 159      *
 160      * Behavior undefined if site is not configured via Status_network.
 161      *
 162      * @return array of nicknames
 163      */
 164     public static function findAllSites()
 165     {
 166         $sites = array();
 167         $sn = new Status_network();
 168         $sn->find();
 169         while ($sn->fetch()) {
 170             $sites[] = $sn->nickname;
 171         }
 172         return $sites;
 173     }
 174
 175     /**
 176      * Fire initialization events for all instantiated plugins.
 177      */
 178     protected static function initPlugins()
 179     {
 180         // Load default plugins
 181         foreach (common_config('plugins', 'default') as $name => $params) {
 182             $key = 'disable-' . $name;
 183             if (common_config('plugins', $key)) {
 184                 continue;
 185             }
 186
 187             if (is_null($params)) {
 188                 addPlugin($name);
 189             } else if (is_array($params)) {
 190                 if (count($params) == 0) {
 191                     addPlugin($name);
 192                 } else {
 193                     $keys = array_keys($params);
 194                     if (is_string($keys[0])) {
 195                         addPlugin($name, $params);
 196                     } else {
 197                         foreach ($params as $paramset) {
 198                             addPlugin($name, $paramset);
 199                         }
 200                     }
 201                 }
 202             }
 203         }
 204
 205         // XXX: if plugins should check the schema at runtime, do that here.
 206         if (common_config('db', 'schemacheck') == 'runtime') {
 207             Event::handle('CheckSchema');
 208         }
 209
 210         // Give plugins a chance to initialize in a fully-prepared environment
 211         Event::handle('InitializePlugin');
 212     }
 213
 214     /**
 215      * Quick-check if configuration has been established.
 216      * Useful for functions which may get used partway through
 217      * initialization to back off from fancier things.
 218      *
 219      * @return bool
 220      */
 221     public function haveConfig()
 222     {
 223         return self::$have_config;
 224     }
 225
 226     public function isApi()
 227     {
 228         return self::$is_api;
 229     }
 230
 231     public function setApi($mode)
 232     {
 233         self::$is_api = $mode;
 234     }
 235
 236     public function isAjax()
 237     {
 238         return self::$is_ajax;
 239     }
 240
 241     public function setAjax($mode)
 242     {
 243         self::$is_ajax = $mode;
 244     }
 245
 246     /**
 247      * Build default configuration array
 248      * @return array
 249      */
 250     protected static function defaultConfig()
 251     {
 252         global $_server, $_path;
 253         require(INSTALLDIR.'/lib/default.php');
 254         return $default;
 255     }
 256
 257     /**
 258      * Establish default configuration based on given or default server and path
 259      * Sets global $_server, $_path, and $config
 260      */
 261     public static function initDefaults($server, $path)
 262     {
 263         global $_server, $_path, $config;
 264
 265         Event::clearHandlers();
 266         self::$plugins = array();
 267
 268         // try to figure out where we are. $server and $path
 269         // can be set by including module, else we guess based
 270         // on HTTP info.
 271
 272         if (isset($server)) {
 273             $_server = $server;
 274         } else {
 275             $_server = array_key_exists('SERVER_NAME', $_SERVER) ?
 276               strtolower($_SERVER['SERVER_NAME']) :
 277             null;
 278         }
 279
 280         if (isset($path)) {
 281             $_path = $path;
 282         } else {
 283             $_path = (array_key_exists('SERVER_NAME', $_SERVER) && array_key_exists('SCRIPT_NAME', $_SERVER)) ?
 284               self::_sn_to_path($_SERVER['SCRIPT_NAME']) :
 285             null;
 286         }
 287
 288         // Set config values initially to default values
 289         $default = self::defaultConfig();
 290         $config = $default;
 291
 292         // default configuration, overwritten in config.php
 293         // Keep DB_DataObject's db config synced to ours...
 294
 295         $config['db'] = &PEAR::getStaticProperty('DB_DataObject','options');
 296
 297         $config['db'] = $default['db'];
 298
 299         if (function_exists('date_default_timezone_set')) {
 300             /* Work internally in UTC */
 301             date_default_timezone_set('UTC');
 302         }
 303     }
 304
 305     protected function _sn_to_path($sn)
 306     {
 307         $past_root = substr($sn, 1);
 308         $last_slash = strrpos($past_root, '/');
 309         if ($last_slash > 0) {
 310             $p = substr($past_root, 0, $last_slash);
 311         } else {
 312             $p = '';
 313         }
 314         return $p;
 315     }
 316
 317     /**
 318      * Load the default or specified configuration file.
 319      * Modifies global $config and may establish plugins.
 320      *
 321      * @throws NoConfigException
 322      */
 323     protected function loadConfigFile($conffile=null)
 324     {
 325         global $_server, $_path, $config;
 326
 327         // From most general to most specific:
 328         // server-wide, then vhost-wide, then for a path,
 329         // finally for a dir (usually only need one of the last two).
 330
 331         if (isset($conffile)) {
 332             $config_files = array($conffile);
 333         } else {
 334             $config_files = array('/etc/statusnet/statusnet.php',
 335                                   '/etc/statusnet/laconica.php',
 336                                   '/etc/laconica/laconica.php',
 337                                   '/etc/statusnet/'.$_server.'.php',
 338                                   '/etc/laconica/'.$_server.'.php');
 339
 340             if (strlen($_path) > 0) {
 341                 $config_files[] = '/etc/statusnet/'.$_server.'_'.$_path.'.php';
 342                 $config_files[] = '/etc/laconica/'.$_server.'_'.$_path.'.php';
 343             }
 344
 345             $config_files[] = INSTALLDIR.'/config.php';
 346         }
 347
 348         self::$have_config = false;
 349
 350         foreach ($config_files as $_config_file) {
 351             if (@file_exists($_config_file)) {
 352                 // Ignore 0-byte config files
 353                 if (filesize($_config_file) > 0) {
 354                     include($_config_file);
 355                     self::$have_config = true;
 356                 }
 357             }
 358         }
 359
 360         if (!self::$have_config) {
 361             throw new NoConfigException("No configuration file found.",
 362                                         $config_files);
 363         }
 364
 365         // Fixup for statusnet.ini
 366         $_db_name = substr($config['db']['database'], strrpos($config['db']['database'], '/') + 1);
 367
 368         if ($_db_name != 'statusnet' && !array_key_exists('ini_'.$_db_name, $config['db'])) {
 369             $config['db']['ini_'.$_db_name] = INSTALLDIR.'/classes/statusnet.ini';
 370         }
 371
 372         // Backwards compatibility
 373         if (array_key_exists('memcached', $config)) {
 374             if ($config['memcached']['enabled']) {
 375                 addPlugin('Memcache', array('servers' => $config['memcached']['server']));
 376             }
 377
 378             if (!empty($config['memcached']['base'])) {
 379                 $config['cache']['base'] = $config['memcached']['base'];
 380             }
 381         }
 382         if (array_key_exists('xmpp', $config)) {
 383             if ($config['xmpp']['enabled']) {
 384                 addPlugin('xmpp', array(
 385                     'server' => $config['xmpp']['server'],
 386                     'port' => $config['xmpp']['port'],
 387                     'user' => $config['xmpp']['user'],
 388                     'resource' => $config['xmpp']['resource'],
 389                     'encryption' => $config['xmpp']['encryption'],
 390                     'password' => $config['xmpp']['password'],
 391                     'host' => $config['xmpp']['host'],
 392                     'debug' => $config['xmpp']['debug'],
 393                     'public' => $config['xmpp']['public']
 394                 ));
 395             }
 396         }
 397     }
 398
 399     /**
 400      * Are we running from the web with HTTPS?
 401      *
 402      * @return boolean true if we're running with HTTPS; else false
 403      */
 404
 405     static function isHTTPS()
 406     {
 407         // There are some exceptions to this; add them here!
 408         if(empty($_SERVER['HTTPS'])) {
 409             return false;
 410         } else {
 411             return $_SERVER['HTTPS'] !== 'off';
 412         }
 413     }
 414 }
 415
 416 class NoConfigException extends Exception
 417 {
 418     public $configFiles;
 419
 420     function __construct($msg, $configFiles) {
 421         parent::__construct($msg);
 422         $this->configFiles = $configFiles;
 423     }
 424 }