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