lib/common.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2008, 2009, 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 if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
  21
  22 //exit with 200 response, if this is checking fancy from the installer
  23 if (isset($_REQUEST['p']) && $_REQUEST['p'] == 'check-fancy') {  exit; }
  24
  25 define('STATUSNET_VERSION', '0.9.0dev');
  26 define('LACONICA_VERSION', STATUSNET_VERSION); // compatibility
  27
  28 define('STATUSNET_CODENAME', 'Stand');
  29
  30 define('AVATAR_PROFILE_SIZE', 96);
  31 define('AVATAR_STREAM_SIZE', 48);
  32 define('AVATAR_MINI_SIZE', 24);
  33
  34 define('NOTICES_PER_PAGE', 20);
  35 define('PROFILES_PER_PAGE', 20);
  36
  37 define('FOREIGN_NOTICE_SEND', 1);
  38 define('FOREIGN_NOTICE_RECV', 2);
  39 define('FOREIGN_NOTICE_SEND_REPLY', 4);
  40
  41 define('FOREIGN_FRIEND_SEND', 1);
  42 define('FOREIGN_FRIEND_RECV', 2);
  43
  44 # append our extlib dir as the last-resort place to find libs
  45
  46 set_include_path(get_include_path() . PATH_SEPARATOR . INSTALLDIR . '/extlib/');
  47
  48 # global configuration object
  49
  50 require_once('PEAR.php');
  51 require_once('DB/DataObject.php');
  52 require_once('DB/DataObject/Cast.php'); # for dates
  53
  54 if (!function_exists('gettext')) {
  55     require_once("php-gettext/gettext.inc");
  56 }
  57
  58 require_once(INSTALLDIR.'/lib/language.php');
  59
  60 // This gets included before the config file, so that admin code and plugins
  61 // can use it
  62
  63 require_once(INSTALLDIR.'/lib/event.php');
  64 require_once(INSTALLDIR.'/lib/plugin.php');
  65
  66 function _sn_to_path($sn)
  67 {
  68     $past_root = substr($sn, 1);
  69     $last_slash = strrpos($past_root, '/');
  70     if ($last_slash > 0) {
  71         $p = substr($past_root, 0, $last_slash);
  72     } else {
  73         $p = '';
  74     }
  75     return $p;
  76 }
  77
  78 // try to figure out where we are. $server and $path
  79 // can be set by including module, else we guess based
  80 // on HTTP info.
  81
  82 if (isset($server)) {
  83     $_server = $server;
  84 } else {
  85     $_server = array_key_exists('SERVER_NAME', $_SERVER) ?
  86       strtolower($_SERVER['SERVER_NAME']) :
  87     null;
  88 }
  89
  90 if (isset($path)) {
  91     $_path = $path;
  92 } else {
  93     $_path = (array_key_exists('SERVER_NAME', $_SERVER) && array_key_exists('SCRIPT_NAME', $_SERVER)) ?
  94       _sn_to_path($_SERVER['SCRIPT_NAME']) :
  95     null;
  96 }
  97
  98 require_once(INSTALLDIR.'/lib/default.php');
  99
 100 // Set config values initially to default values
 101
 102 $config = $default;
 103
 104 // default configuration, overwritten in config.php
 105
 106 $config['db'] = &PEAR::getStaticProperty('DB_DataObject','options');
 107
 108 $config['db'] = $default['db'];
 109
 110 // Backward compatibility
 111
 112 $config['site']['design'] =& $config['design'];
 113
 114 if (function_exists('date_default_timezone_set')) {
 115     /* Work internally in UTC */
 116     date_default_timezone_set('UTC');
 117 }
 118
 119 function addPlugin($name, $attrs = null)
 120 {
 121     $name = ucfirst($name);
 122     $pluginclass = "{$name}Plugin";
 123
 124     if (!class_exists($pluginclass)) {
 125
 126         $files = array("local/plugins/{$pluginclass}.php",
 127                        "local/plugins/{$name}/{$pluginclass}.php",
 128                        "local/{$pluginclass}.php",
 129                        "local/{$name}/{$pluginclass}.php",
 130                        "plugins/{$pluginclass}.php",
 131                        "plugins/{$name}/{$pluginclass}.php");
 132
 133         foreach ($files as $file) {
 134             $fullpath = INSTALLDIR.'/'.$file;
 135             if (@file_exists($fullpath)) {
 136                 include_once($fullpath);
 137                 break;
 138             }
 139         }
 140     }
 141
 142     $inst = new $pluginclass();
 143
 144     if (!empty($attrs)) {
 145         foreach ($attrs as $aname => $avalue) {
 146             $inst->$aname = $avalue;
 147         }
 148     }
 149     return $inst;
 150 }
 151
 152 // From most general to most specific:
 153 // server-wide, then vhost-wide, then for a path,
 154 // finally for a dir (usually only need one of the last two).
 155
 156 if (isset($conffile)) {
 157     $_config_files = array($conffile);
 158 } else {
 159     $_config_files = array('/etc/statusnet/statusnet.php',
 160                            '/etc/statusnet/laconica.php',
 161                            '/etc/laconica/laconica.php',
 162                            '/etc/statusnet/'.$_server.'.php',
 163                            '/etc/laconica/'.$_server.'.php');
 164
 165     if (strlen($_path) > 0) {
 166         $_config_files[] = '/etc/statusnet/'.$_server.'_'.$_path.'.php';
 167         $_config_files[] = '/etc/laconica/'.$_server.'_'.$_path.'.php';
 168     }
 169
 170     $_config_files[] = INSTALLDIR.'/config.php';
 171 }
 172
 173 global $_have_a_config;
 174 $_have_a_config = false;
 175
 176 foreach ($_config_files as $_config_file) {
 177     if (@file_exists($_config_file)) {
 178         include_once($_config_file);
 179         $_have_a_config = true;
 180     }
 181 }
 182
 183 function _have_config()
 184 {
 185     global $_have_a_config;
 186     return $_have_a_config;
 187 }
 188
 189 // XXX: Throw a conniption if database not installed
 190 // XXX: Find a way to use htmlwriter for this instead of handcoded markup
 191 if (!_have_config()) {
 192   echo '<p>'. _('No configuration file found. ') .'</p>';
 193   echo '<p>'. _('I looked for configuration files in the following places: ') .'<br/> '. implode($_config_files, '<br/>');
 194   echo '<p>'. _('You may wish to run the installer to fix this.') .'</p>';
 195   echo '<a href="install.php">'. _('Go to the installer.') .'</a>';
 196   exit;
 197 }
 198 // Fixup for statusnet.ini
 199
 200 $_db_name = substr($config['db']['database'], strrpos($config['db']['database'], '/') + 1);
 201
 202 if ($_db_name != 'statusnet' && !array_key_exists('ini_'.$_db_name, $config['db'])) {
 203     $config['db']['ini_'.$_db_name] = INSTALLDIR.'/classes/statusnet.ini';
 204 }
 205
 206 function __autoload($cls)
 207 {
 208     if (file_exists(INSTALLDIR.'/classes/' . $cls . '.php')) {
 209         require_once(INSTALLDIR.'/classes/' . $cls . '.php');
 210     } else if (file_exists(INSTALLDIR.'/lib/' . strtolower($cls) . '.php')) {
 211         require_once(INSTALLDIR.'/lib/' . strtolower($cls) . '.php');
 212     } else if (mb_substr($cls, -6) == 'Action' &&
 213                file_exists(INSTALLDIR.'/actions/' . strtolower(mb_substr($cls, 0, -6)) . '.php')) {
 214         require_once(INSTALLDIR.'/actions/' . strtolower(mb_substr($cls, 0, -6)) . '.php');
 215     } else if ($cls == 'OAuthRequest') {
 216         require_once('OAuth.php');
 217     } else {
 218         Event::handle('Autoload', array(&$cls));
 219     }
 220 }
 221
 222 // XXX: how many of these could be auto-loaded on use?
 223 // XXX: note that these files should not use config options
 224 // at compile time since DB config options are not yet loaded.
 225
 226 require_once 'Validate.php';
 227 require_once 'markdown.php';
 228
 229 require_once INSTALLDIR.'/lib/util.php';
 230 require_once INSTALLDIR.'/lib/action.php';
 231 require_once INSTALLDIR.'/lib/mail.php';
 232 require_once INSTALLDIR.'/lib/subs.php';
 233
 234 require_once INSTALLDIR.'/lib/clientexception.php';
 235 require_once INSTALLDIR.'/lib/serverexception.php';
 236
 237 // Load settings from database; note we need autoload for this
 238
 239 Config::loadSettings();
 240
 241 // XXX: if plugins should check the schema at runtime, do that here.
 242
 243 if ($config['db']['schemacheck'] == 'runtime') {
 244     Event::handle('CheckSchema');
 245 }
 246
 247 // XXX: other formats here
 248
 249 define('NICKNAME_FMT', VALIDATE_NUM.VALIDATE_ALPHA_LOWER);
 250
 251 // Give plugins a chance to initialize in a fully-prepared environment
 252
 253 Event::handle('InitializePlugin');