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