lib/common.php

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