lib/common.php

   1 <?php
   2 /*
   3  * StatusNet - a 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('LACONICA')) { exit(1); }
  21
  22 define('LACONICA_VERSION', '0.8.1pre1');
  23
  24 define('AVATAR_PROFILE_SIZE', 96);
  25 define('AVATAR_STREAM_SIZE', 48);
  26 define('AVATAR_MINI_SIZE', 24);
  27
  28 define('NOTICES_PER_PAGE', 20);
  29 define('PROFILES_PER_PAGE', 20);
  30
  31 define('FOREIGN_NOTICE_SEND', 1);
  32 define('FOREIGN_NOTICE_RECV', 2);
  33 define('FOREIGN_NOTICE_SEND_REPLY', 4);
  34
  35 define('FOREIGN_FRIEND_SEND', 1);
  36 define('FOREIGN_FRIEND_RECV', 2);
  37
  38 define_syslog_variables();
  39
  40 # append our extlib dir as the last-resort place to find libs
  41
  42 set_include_path(get_include_path() . PATH_SEPARATOR . INSTALLDIR . '/extlib/');
  43
  44 # global configuration object
  45
  46 require_once('PEAR.php');
  47 require_once('DB/DataObject.php');
  48 require_once('DB/DataObject/Cast.php'); # for dates
  49
  50 if (!function_exists('gettext')) {
  51     require_once("php-gettext/gettext.inc");
  52 }
  53 require_once(INSTALLDIR.'/lib/language.php');
  54
  55 // This gets included before the config file, so that admin code and plugins
  56 // can use it
  57
  58 require_once(INSTALLDIR.'/lib/event.php');
  59 require_once(INSTALLDIR.'/lib/plugin.php');
  60
  61 function _sn_to_path($sn)
  62 {
  63     $past_root = substr($sn, 1);
  64     $last_slash = strrpos($past_root, '/');
  65     if ($last_slash > 0) {
  66         $p = substr($past_root, 0, $last_slash);
  67     } else {
  68         $p = '';
  69     }
  70     return $p;
  71 }
  72
  73 // try to figure out where we are. $server and $path
  74 // can be set by including module, else we guess based
  75 // on HTTP info.
  76
  77 if (isset($server)) {
  78     $_server = $server;
  79 } else {
  80     $_server = array_key_exists('SERVER_NAME', $_SERVER) ?
  81       strtolower($_SERVER['SERVER_NAME']) :
  82     null;
  83 }
  84
  85 if (isset($path)) {
  86     $_path = $path;
  87 } else {
  88     $_path = (array_key_exists('SERVER_NAME', $_SERVER) && array_key_exists('SCRIPT_NAME', $_SERVER)) ?
  89       _sn_to_path($_SERVER['SCRIPT_NAME']) :
  90     null;
  91 }
  92
  93 // default configuration, overwritten in config.php
  94
  95 $config =
  96   array('site' =>
  97         array('name' => 'Just another StatusNet microblog',
  98               'server' => $_server,
  99               'theme' => 'default',
 100               'path' => $_path,
 101               'logfile' => null,
 102               'logo' => null,
 103               'logdebug' => false,
 104               'fancy' => false,
 105               'locale_path' => INSTALLDIR.'/locale',
 106               'language' => 'en_US',
 107               'languages' => get_all_languages(),
 108               'email' =>
 109               array_key_exists('SERVER_ADMIN', $_SERVER) ? $_SERVER['SERVER_ADMIN'] : null,
 110               'broughtby' => null,
 111               'timezone' => 'UTC',
 112               'broughtbyurl' => null,
 113               'closed' => false,
 114               'inviteonly' => false,
 115               'openidonly' => false,
 116               'private' => false,
 117               'ssl' => 'never',
 118               'sslserver' => null,
 119               'shorturllength' => 30,
 120               'dupelimit' => 60), # default for same person saying the same thing
 121         'syslog' =>
 122         array('appname' => 'laconica', # for syslog
 123               'priority' => 'debug', # XXX: currently ignored
 124               'facility' => LOG_USER),
 125         'queue' =>
 126         array('enabled' => false,
 127               'subsystem' => 'db', # default to database, or 'stomp'
 128               'stomp_server' => null,
 129               'queue_basename' => 'laconica',
 130               'stomp_username' => null,
 131               'stomp_password' => null,
 132               ),
 133         'license' =>
 134         array('url' => 'http://creativecommons.org/licenses/by/3.0/',
 135               'title' => 'Creative Commons Attribution 3.0',
 136               'image' => 'http://i.creativecommons.org/l/by/3.0/80x15.png'),
 137         'mail' =>
 138         array('backend' => 'mail',
 139               'params' => null),
 140         'nickname' =>
 141         array('blacklist' => array(),
 142               'featured' => array()),
 143         'profile' =>
 144         array('banned' => array()),
 145         'avatar' =>
 146         array('server' => null,
 147               'dir' => INSTALLDIR . '/avatar/',
 148               'path' => $_path . '/avatar/'),
 149         'background' =>
 150         array('server' => null,
 151               'dir' => INSTALLDIR . '/background/',
 152               'path' => $_path . '/background/'),
 153         'public' =>
 154         array('localonly' => true,
 155               'blacklist' => array(),
 156               'autosource' => array()),
 157         'theme' =>
 158         array('server' => null,
 159               'dir' => null,
 160               'path'=> null),
 161         'throttle' =>
 162         array('enabled' => false, // whether to throttle edits; false by default
 163               'count' => 20, // number of allowed messages in timespan
 164               'timespan' => 600), // timespan for throttling
 165         'xmpp' =>
 166         array('enabled' => false,
 167               'server' => 'INVALID SERVER',
 168               'port' => 5222,
 169               'user' => 'update',
 170               'encryption' => true,
 171               'resource' => 'uniquename',
 172               'password' => 'blahblahblah',
 173               'host' => null, # only set if != server
 174               'debug' => false, # print extra debug info
 175               'public' => array()), # JIDs of users who want to receive the public stream
 176         'openid' =>
 177         array('enabled' => true),
 178         'invite' =>
 179         array('enabled' => true),
 180         'sphinx' =>
 181         array('enabled' => false,
 182               'server' => 'localhost',
 183               'port' => 3312),
 184         'tag' =>
 185         array('dropoff' => 864000.0),
 186         'popular' =>
 187         array('dropoff' => 864000.0),
 188         'daemon' =>
 189         array('piddir' => '/var/run',
 190               'user' => false,
 191               'group' => false),
 192         'emailpost' =>
 193         array('enabled' => true),
 194         'sms' =>
 195         array('enabled' => true),
 196         'twitter' =>
 197         array('enabled' => true),
 198         'twitterbridge' =>
 199         array('enabled' => false),
 200         'integration' =>
 201         array('source' => 'StatusNet', # source attribute for Twitter
 202               'taguri' => $_server.',2009'), # base for tag URIs
 203         'twitter' =>
 204         array('consumer_key'    => null,
 205               'consumer_secret' => null),
 206         'memcached' =>
 207         array('enabled' => false,
 208               'server' => 'localhost',
 209               'base' => null,
 210               'port' => 11211),
 211                 'ping' =>
 212         array('notify' => array()),
 213         'inboxes' =>
 214         array('enabled' => true), # on by default for new sites
 215         'newuser' =>
 216         array('default' => null,
 217               'welcome' => null),
 218         'snapshot' =>
 219         array('run' => 'web',
 220               'frequency' => 10000,
 221               'reporturl' => 'http://laconi.ca/stats/report'),
 222         'attachments' =>
 223         array('server' => null,
 224               'dir' => INSTALLDIR . '/file/',
 225               'path' => $_path . '/file/',
 226               'supported' => array('image/png',
 227                                    'image/jpeg',
 228                                    'image/gif',
 229                                    'image/svg+xml',
 230                                    'audio/mpeg',
 231                                    'audio/x-speex',
 232                                    'application/ogg',
 233                                    'application/pdf',
 234                                    'application/vnd.oasis.opendocument.text',
 235                                    'application/vnd.oasis.opendocument.text-template',
 236                                    'application/vnd.oasis.opendocument.graphics',
 237                                    'application/vnd.oasis.opendocument.graphics-template',
 238                                    'application/vnd.oasis.opendocument.presentation',
 239                                    'application/vnd.oasis.opendocument.presentation-template',
 240                                    'application/vnd.oasis.opendocument.spreadsheet',
 241                                    'application/vnd.oasis.opendocument.spreadsheet-template',
 242                                    'application/vnd.oasis.opendocument.chart',
 243                                    'application/vnd.oasis.opendocument.chart-template',
 244                                    'application/vnd.oasis.opendocument.image',
 245                                    'application/vnd.oasis.opendocument.image-template',
 246                                    'application/vnd.oasis.opendocument.formula',
 247                                    'application/vnd.oasis.opendocument.formula-template',
 248                                    'application/vnd.oasis.opendocument.text-master',
 249                                    'application/vnd.oasis.opendocument.text-web',
 250                                    'application/x-zip',
 251                                    'application/zip',
 252                                    'text/plain',
 253                                    'video/mpeg',
 254                                    'video/mp4',
 255                                    'video/quicktime',
 256                                    'video/mpeg'),
 257         'file_quota' => 5000000,
 258         'user_quota' => 50000000,
 259         'monthly_quota' => 15000000,
 260         'uploads' => true,
 261         'filecommand' => '/usr/bin/file',
 262         ),
 263         'group' =>
 264         array('maxaliases' => 3),
 265         'oohembed' => array('endpoint' => 'http://oohembed.com/oohembed/'),
 266         'search' =>
 267         array('type' => 'fulltext'),
 268         'sessions' =>
 269         array('handle' => false, // whether to handle sessions ourselves
 270               'debug' => false), // debugging output for sessions
 271         'design' =>
 272         array('backgroundcolor' => null, // null -> 'use theme default'
 273               'contentcolor' => null,
 274               'sidebarcolor' => null,
 275               'textcolor' => null,
 276               'linkcolor' => null,
 277               'backgroundimage' => null,
 278               'disposition' => null),
 279         );
 280
 281 $config['db'] = &PEAR::getStaticProperty('DB_DataObject','options');
 282
 283 $config['db'] =
 284   array('database' => 'YOU HAVE TO SET THIS IN config.php',
 285         'schema_location' => INSTALLDIR . '/classes',
 286         'class_location' => INSTALLDIR . '/classes',
 287         'require_prefix' => 'classes/',
 288         'class_prefix' => '',
 289         'mirror' => null,
 290         'utf8' => true,
 291         'db_driver' => 'DB', # XXX: JanRain libs only work with DB
 292         'quote_identifiers' => false,
 293         'type' => 'mysql' );
 294
 295 // Backward compatibility
 296
 297 $config['site']['design'] =& $config['design'];
 298
 299 if (function_exists('date_default_timezone_set')) {
 300     /* Work internally in UTC */
 301     date_default_timezone_set('UTC');
 302 }
 303
 304 function addPlugin($name, $attrs = null)
 305 {
 306     $name = ucfirst($name);
 307     $pluginclass = "{$name}Plugin";
 308
 309     if (!class_exists($pluginclass)) {
 310
 311         $files = array("local/plugins/{$pluginclass}.php",
 312                        "local/plugins/{$name}/{$pluginclass}.php",
 313                        "local/{$pluginclass}.php",
 314                        "local/{$name}/{$pluginclass}.php",
 315                        "plugins/{$pluginclass}.php",
 316                        "plugins/{$name}/{$pluginclass}.php");
 317
 318         foreach ($files as $file) {
 319             $fullpath = INSTALLDIR.'/'.$file;
 320             if (@file_exists($fullpath)) {
 321                 include_once($fullpath);
 322                 break;
 323             }
 324         }
 325     }
 326
 327     $inst = new $pluginclass();
 328
 329     if (!empty($attrs)) {
 330         foreach ($attrs as $aname => $avalue) {
 331             $inst->$aname = $avalue;
 332         }
 333     }
 334     return $inst;
 335 }
 336
 337 // From most general to most specific:
 338 // server-wide, then vhost-wide, then for a path,
 339 // finally for a dir (usually only need one of the last two).
 340
 341 if (isset($conffile)) {
 342     $_config_files = array($conffile);
 343 } else {
 344     $_config_files = array('/etc/laconica/laconica.php',
 345                            '/etc/laconica/'.$_server.'.php');
 346
 347     if (strlen($_path) > 0) {
 348         $_config_files[] = '/etc/laconica/'.$_server.'_'.$_path.'.php';
 349     }
 350
 351     $_config_files[] = INSTALLDIR.'/config.php';
 352 }
 353
 354 $_have_a_config = false;
 355
 356 foreach ($_config_files as $_config_file) {
 357     if (@file_exists($_config_file)) {
 358         include_once($_config_file);
 359         $_have_a_config = true;
 360     }
 361 }
 362
 363 function _have_config()
 364 {
 365     global $_have_a_config;
 366     return $_have_a_config;
 367 }
 368
 369 // XXX: Throw a conniption if database not installed
 370
 371 // Fixup for laconica.ini
 372
 373 $_db_name = substr($config['db']['database'], strrpos($config['db']['database'], '/') + 1);
 374
 375 if ($_db_name != 'laconica' && !array_key_exists('ini_'.$_db_name, $config['db'])) {
 376     $config['db']['ini_'.$_db_name] = INSTALLDIR.'/classes/laconica.ini';
 377 }
 378
 379 // Ignore openidonly if OpenID is disabled
 380
 381 if (!$config['openid']['enabled']) {
 382     $config['site']['openidonly'] = false;
 383 }
 384
 385 // XXX: how many of these could be auto-loaded on use?
 386
 387 require_once 'Validate.php';
 388 require_once 'markdown.php';
 389
 390 require_once INSTALLDIR.'/lib/util.php';
 391 require_once INSTALLDIR.'/lib/action.php';
 392 require_once INSTALLDIR.'/lib/theme.php';
 393 require_once INSTALLDIR.'/lib/mail.php';
 394 require_once INSTALLDIR.'/lib/subs.php';
 395 require_once INSTALLDIR.'/lib/Shorturl_api.php';
 396 require_once INSTALLDIR.'/lib/twitter.php';
 397
 398 require_once INSTALLDIR.'/lib/clientexception.php';
 399 require_once INSTALLDIR.'/lib/serverexception.php';
 400
 401 // XXX: other formats here
 402
 403 define('NICKNAME_FMT', VALIDATE_NUM.VALIDATE_ALPHA_LOWER);
 404
 405 function __autoload($class)
 406 {
 407     if ($class == 'OAuthRequest') {
 408         require_once('OAuth.php');
 409     } else if (file_exists(INSTALLDIR.'/classes/' . $class . '.php')) {
 410         require_once(INSTALLDIR.'/classes/' . $class . '.php');
 411     } else if (file_exists(INSTALLDIR.'/lib/' . strtolower($class) . '.php')) {
 412         require_once(INSTALLDIR.'/lib/' . strtolower($class) . '.php');
 413     } else if (mb_substr($class, -6) == 'Action' &&
 414                file_exists(INSTALLDIR.'/actions/' . strtolower(mb_substr($class, 0, -6)) . '.php')) {
 415         require_once(INSTALLDIR.'/actions/' . strtolower(mb_substr($class, 0, -6)) . '.php');
 416     }
 417 }
 418
 419 // Give plugins a chance to initialize in a fully-prepared environment
 420
 421 Event::handle('InitializePlugin');