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