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 require_once(INSTALLDIR.'/lib/language.php');
  53
  54 // This gets included before the config file, so that admin code and plugins
  55 // can use it
  56
  57 require_once(INSTALLDIR.'/lib/event.php');
  58 require_once(INSTALLDIR.'/lib/plugin.php');
  59
  60 function _sn_to_path($sn)
  61 {
  62     $past_root = substr($sn, 1);
  63     $last_slash = strrpos($past_root, '/');
  64     if ($last_slash > 0) {
  65         $p = substr($past_root, 0, $last_slash);
  66     } else {
  67         $p = '';
  68     }
  69     return $p;
  70 }
  71
  72 // try to figure out where we are. $server and $path
  73 // can be set by including module, else we guess based
  74 // on HTTP info.
  75
  76 if (isset($server)) {
  77     $_server = $server;
  78 } else {
  79     $_server = array_key_exists('SERVER_NAME', $_SERVER) ?
  80       strtolower($_SERVER['SERVER_NAME']) :
  81     null;
  82 }
  83
  84 if (isset($path)) {
  85     $_path = $path;
  86 } else {
  87     $_path = (array_key_exists('SERVER_NAME', $_SERVER) && array_key_exists('SCRIPT_NAME', $_SERVER)) ?
  88       _sn_to_path($_SERVER['SCRIPT_NAME']) :
  89     null;
  90 }
  91
  92 // default configuration, overwritten in config.php
  93
  94 $config =
  95   array('site' =>
  96         array('name' => 'Just another Laconica microblog',
  97               'server' => $_server,
  98               'theme' => 'default',
  99               'path' => $_path,
 100               'logfile' => null,
 101               'logo' => null,
 102               'logdebug' => false,
 103               'fancy' => false,
 104               'locale_path' => INSTALLDIR.'/locale',
 105               'language' => 'en_US',
 106               'languages' => get_all_languages(),
 107               'email' =>
 108               array_key_exists('SERVER_ADMIN', $_SERVER) ? $_SERVER['SERVER_ADMIN'] : null,
 109               'broughtby' => null,
 110               'timezone' => 'UTC',
 111               'broughtbyurl' => null,
 112               'closed' => false,
 113               'inviteonly' => false,
 114               'openidonly' => false,
 115               'private' => false,
 116               'ssl' => 'never',
 117               'sslserver' => null,
 118               'shorturllength' => 30,
 119               'dupelimit' => 60, # default for same person saying the same thing
 120               'textlimit' => 140,
 121               ),
 122         'syslog' =>
 123         array('appname' => 'laconica', # for syslog
 124               'priority' => 'debug', # XXX: currently ignored
 125               'facility' => LOG_USER),
 126         'queue' =>
 127         array('enabled' => false,
 128               'subsystem' => 'db', # default to database, or 'stomp'
 129               'stomp_server' => null,
 130               'queue_basename' => 'laconica',
 131               'stomp_username' => null,
 132               'stomp_password' => null,
 133               ),
 134         'license' =>
 135         array('url' => 'http://creativecommons.org/licenses/by/3.0/',
 136               'title' => 'Creative Commons Attribution 3.0',
 137               'image' => 'http://i.creativecommons.org/l/by/3.0/80x15.png'),
 138         'mail' =>
 139         array('backend' => 'mail',
 140               'params' => null),
 141         'nickname' =>
 142         array('blacklist' => array(),
 143               'featured' => array()),
 144         'profile' =>
 145         array('banned' => array(),
 146               'biolimit' => null),
 147         'avatar' =>
 148         array('server' => null,
 149               'dir' => INSTALLDIR . '/avatar/',
 150               'path' => $_path . '/avatar/'),
 151         'background' =>
 152         array('server' => null,
 153               'dir' => INSTALLDIR . '/background/',
 154               'path' => $_path . '/background/'),
 155         'public' =>
 156         array('localonly' => true,
 157               'blacklist' => array(),
 158               'autosource' => array()),
 159         'theme' =>
 160         array('server' => null,
 161               'dir' => null,
 162               'path'=> null),
 163         'throttle' =>
 164         array('enabled' => false, // whether to throttle edits; false by default
 165               'count' => 20, // number of allowed messages in timespan
 166               'timespan' => 600), // timespan for throttling
 167         'xmpp' =>
 168         array('enabled' => false,
 169               'server' => 'INVALID SERVER',
 170               'port' => 5222,
 171               'user' => 'update',
 172               'encryption' => true,
 173               'resource' => 'uniquename',
 174               'password' => 'blahblahblah',
 175               'host' => null, # only set if != server
 176               'debug' => false, # print extra debug info
 177               'public' => array()), # JIDs of users who want to receive the public stream
 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' => 'Laconica', # 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               'desclimit' => null),
 266         'oohembed' => array('endpoint' => 'http://oohembed.com/oohembed/'),
 267         'search' =>
 268         array('type' => 'fulltext'),
 269         'sessions' =>
 270         array('handle' => false, // whether to handle sessions ourselves
 271               'debug' => false), // debugging output for sessions
 272         'design' =>
 273         array('backgroundcolor' => null, // null -> 'use theme default'
 274               'contentcolor' => null,
 275               'sidebarcolor' => null,
 276               'textcolor' => null,
 277               'linkcolor' => null,
 278               'backgroundimage' => null,
 279               'disposition' => null),
 280         'notice' =>
 281         array('contentlimit' => null),
 282         'message' =>
 283         array('contentlimit' => null),
 284         );
 285
 286 $config['db'] = &PEAR::getStaticProperty('DB_DataObject','options');
 287
 288 $config['db'] =
 289   array('database' => 'YOU HAVE TO SET THIS IN config.php',
 290         'schema_location' => INSTALLDIR . '/classes',
 291         'class_location' => INSTALLDIR . '/classes',
 292         'require_prefix' => 'classes/',
 293         'class_prefix' => '',
 294         'mirror' => null,
 295         'utf8' => true,
 296         'db_driver' => 'DB', # XXX: JanRain libs only work with DB
 297         'quote_identifiers' => false,
 298         'type' => 'mysql' );
 299
 300 // Backward compatibility
 301
 302 $config['site']['design'] =& $config['design'];
 303
 304 if (function_exists('date_default_timezone_set')) {
 305     /* Work internally in UTC */
 306     date_default_timezone_set('UTC');
 307 }
 308
 309 function addPlugin($name, $attrs = null)
 310 {
 311     $name = ucfirst($name);
 312     $pluginclass = "{$name}Plugin";
 313
 314     if (!class_exists($pluginclass)) {
 315
 316         $files = array("local/plugins/{$pluginclass}.php",
 317                        "local/plugins/{$name}/{$pluginclass}.php",
 318                        "local/{$pluginclass}.php",
 319                        "local/{$name}/{$pluginclass}.php",
 320                        "plugins/{$pluginclass}.php",
 321                        "plugins/{$name}/{$pluginclass}.php");
 322
 323         foreach ($files as $file) {
 324             $fullpath = INSTALLDIR.'/'.$file;
 325             if (@file_exists($fullpath)) {
 326                 include_once($fullpath);
 327                 break;
 328             }
 329         }
 330     }
 331
 332     $inst = new $pluginclass();
 333
 334     if (!empty($attrs)) {
 335         foreach ($attrs as $aname => $avalue) {
 336             $inst->$aname = $avalue;
 337         }
 338     }
 339     return $inst;
 340 }
 341
 342 // From most general to most specific:
 343 // server-wide, then vhost-wide, then for a path,
 344 // finally for a dir (usually only need one of the last two).
 345
 346 if (isset($conffile)) {
 347     $_config_files = array($conffile);
 348 } else {
 349     $_config_files = array('/etc/laconica/laconica.php',
 350                            '/etc/laconica/'.$_server.'.php');
 351
 352     if (strlen($_path) > 0) {
 353         $_config_files[] = '/etc/laconica/'.$_server.'_'.$_path.'.php';
 354     }
 355
 356     $_config_files[] = INSTALLDIR.'/config.php';
 357 }
 358
 359 $_have_a_config = false;
 360
 361 foreach ($_config_files as $_config_file) {
 362     if (@file_exists($_config_file)) {
 363         include_once($_config_file);
 364         $_have_a_config = true;
 365     }
 366 }
 367
 368 function _have_config()
 369 {
 370     global $_have_a_config;
 371     return $_have_a_config;
 372 }
 373
 374 // XXX: Throw a conniption if database not installed
 375
 376 // Fixup for laconica.ini
 377
 378 $_db_name = substr($config['db']['database'], strrpos($config['db']['database'], '/') + 1);
 379
 380 if ($_db_name != 'laconica' && !array_key_exists('ini_'.$_db_name, $config['db'])) {
 381     $config['db']['ini_'.$_db_name] = INSTALLDIR.'/classes/laconica.ini';
 382 }
 383
 384 function __autoload($cls)
 385 {
 386     if (file_exists(INSTALLDIR.'/classes/' . $cls . '.php')) {
 387         require_once(INSTALLDIR.'/classes/' . $cls . '.php');
 388     } else if (file_exists(INSTALLDIR.'/lib/' . strtolower($cls) . '.php')) {
 389         require_once(INSTALLDIR.'/lib/' . strtolower($cls) . '.php');
 390     } else if (mb_substr($cls, -6) == 'Action' &&
 391                file_exists(INSTALLDIR.'/actions/' . strtolower(mb_substr($cls, 0, -6)) . '.php')) {
 392         require_once(INSTALLDIR.'/actions/' . strtolower(mb_substr($cls, 0, -6)) . '.php');
 393     } else if ($cls == 'OAuthRequest') {
 394         require_once('OAuth.php');
 395     } else {
 396         Event::handle('Autoload', array(&$cls));
 397     }
 398 }
 399
 400 // XXX: how many of these could be auto-loaded on use?
 401 // XXX: note that these files should not use config options
 402 // at compile time since DB config options are not yet loaded.
 403
 404 require_once 'Validate.php';
 405 require_once 'markdown.php';
 406
 407 require_once INSTALLDIR.'/lib/util.php';
 408 require_once INSTALLDIR.'/lib/action.php';
 409 require_once INSTALLDIR.'/lib/theme.php';
 410 require_once INSTALLDIR.'/lib/mail.php';
 411 require_once INSTALLDIR.'/lib/subs.php';
 412 require_once INSTALLDIR.'/lib/Shorturl_api.php';
 413 require_once INSTALLDIR.'/lib/twitter.php';
 414
 415 require_once INSTALLDIR.'/lib/clientexception.php';
 416 require_once INSTALLDIR.'/lib/serverexception.php';
 417
 418 // Load settings from database; note we need autoload for this
 419
 420 Config::loadSettings();
 421
 422 // XXX: other formats here
 423
 424 define('NICKNAME_FMT', VALIDATE_NUM.VALIDATE_ALPHA_LOWER);
 425
 426 // Give plugins a chance to initialize in a fully-prepared environment
 427
 428 Event::handle('InitializePlugin');