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.0dev');
  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               'design' =>
  98               array('backgroundcolor' => '#CEE1E9',
  99                     'contentcolor' => '#FFFFFF',
 100                     'sidebarcolor' => '#C8D1D5',
 101                     'textcolor' => '#000000',
 102                     'linkcolor' => '#002E6E',
 103                     'backgroundimage' => null,
 104                     'disposition' => 1),
 105               'path' => $_path,
 106               'logfile' => null,
 107               'logo' => null,
 108               'logdebug' => false,
 109               'fancy' => false,
 110               'locale_path' => INSTALLDIR.'/locale',
 111               'language' => 'en_US',
 112               'languages' => get_all_languages(),
 113               'email' =>
 114               array_key_exists('SERVER_ADMIN', $_SERVER) ? $_SERVER['SERVER_ADMIN'] : null,
 115               'broughtby' => null,
 116               'timezone' => 'UTC',
 117               'broughtbyurl' => null,
 118               'closed' => false,
 119               'inviteonly' => false,
 120               'private' => false,
 121               'ssl' => 'never',
 122               'sslserver' => null,
 123               'shorturllength' => 30,
 124               'dupelimit' => 60), # default for same person saying the same thing
 125         'syslog' =>
 126         array('appname' => 'laconica', # for syslog
 127               'priority' => 'debug'), # XXX: currently ignored
 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         'avatar' =>
 149         array('server' => null,
 150               'dir' => INSTALLDIR . '/avatar/',
 151               'path' => $_path . '/avatar/'),
 152         'background' =>
 153         array('server' => null,
 154               'dir' => INSTALLDIR . '/background/',
 155               'path' => $_path . '/background/'),
 156         'public' =>
 157         array('localonly' => true,
 158               'blacklist' => array(),
 159               'autosource' => array()),
 160         'theme' =>
 161         array('server' => null,
 162               'dir' => null,
 163               'path'=> null),
 164         'throttle' =>
 165         array('enabled' => false, // whether to throttle edits; false by default
 166               'count' => 20, // number of allowed messages in timespan
 167               'timespan' => 600), // timespan for throttling
 168         'xmpp' =>
 169         array('enabled' => false,
 170               'server' => 'INVALID SERVER',
 171               'port' => 5222,
 172               'user' => 'update',
 173               'encryption' => true,
 174               'resource' => 'uniquename',
 175               'password' => 'blahblahblah',
 176               'host' => null, # only set if != server
 177               'debug' => false, # print extra debug info
 178               'public' => array()), # JIDs of users who want to receive the public stream
 179         'invite' =>
 180         array('enabled' => true),
 181         'sphinx' =>
 182         array('enabled' => false,
 183               'server' => 'localhost',
 184               'port' => 3312),
 185         'tag' =>
 186         array('dropoff' => 864000.0),
 187         'popular' =>
 188         array('dropoff' => 864000.0),
 189         'daemon' =>
 190         array('piddir' => '/var/run',
 191               'user' => false,
 192               'group' => false),
 193         'twitterbridge' =>
 194         array('enabled' => false),
 195         'integration' =>
 196         array('source' => 'Laconica', # source attribute for Twitter
 197               'taguri' => $_server.',2009'), # base for tag URIs
 198         'memcached' =>
 199         array('enabled' => false,
 200               'server' => 'localhost',
 201               'base' => null,
 202               'port' => 11211),
 203                 'ping' =>
 204         array('notify' => array()),
 205         'inboxes' =>
 206         array('enabled' => true), # on by default for new sites
 207         'newuser' =>
 208         array('subscribe' => null,
 209               'welcome' => null),
 210         'snapshot' =>
 211         array('run' => 'web',
 212               'frequency' => 10000,
 213               'reporturl' => 'http://laconi.ca/stats/report'),
 214         'attachments' =>
 215         array('server' => null,
 216               'dir' => INSTALLDIR . '/file/',
 217               'path' => $_path . '/file/',
 218               'supported' => array('image/png',
 219                                    'image/jpeg',
 220                                    'image/gif',
 221                                    'image/svg+xml',
 222                                    'audio/mpeg',
 223                                    'audio/x-speex',
 224                                    'application/ogg',
 225                                    'application/pdf',
 226                                    'application/vnd.oasis.opendocument.text',
 227                                    'application/vnd.oasis.opendocument.text-template',
 228                                    'application/vnd.oasis.opendocument.graphics',
 229                                    'application/vnd.oasis.opendocument.graphics-template',
 230                                    'application/vnd.oasis.opendocument.presentation',
 231                                    'application/vnd.oasis.opendocument.presentation-template',
 232                                    'application/vnd.oasis.opendocument.spreadsheet',
 233                                    'application/vnd.oasis.opendocument.spreadsheet-template',
 234                                    'application/vnd.oasis.opendocument.chart',
 235                                    'application/vnd.oasis.opendocument.chart-template',
 236                                    'application/vnd.oasis.opendocument.image',
 237                                    'application/vnd.oasis.opendocument.image-template',
 238                                    'application/vnd.oasis.opendocument.formula',
 239                                    'application/vnd.oasis.opendocument.formula-template',
 240                                    'application/vnd.oasis.opendocument.text-master',
 241                                    'application/vnd.oasis.opendocument.text-web',
 242                                    'application/x-zip',
 243                                    'application/zip',
 244                                    'text/plain',
 245                                    'video/mpeg',
 246                                    'video/mp4',
 247                                    'video/quicktime',
 248                                    'video/mpeg'),
 249         'file_quota' => 5000000,
 250         'user_quota' => 50000000,
 251         'monthly_quota' => 15000000,
 252         'uploads' => true,
 253         'filecommand' => '/usr/bin/file',
 254         ),
 255         'group' =>
 256         array('maxaliases' => 3),
 257         'oohembed' => array('endpoint' => 'http://oohembed.com/oohembed/'),
 258         'search' =>
 259         array('type' => 'fulltext'),
 260         'sessions' =>
 261         array('handle' => false, // whether to handle sessions ourselves
 262               'debug' => false), // debugging output for sessions
 263         );
 264
 265 $config['db'] = &PEAR::getStaticProperty('DB_DataObject','options');
 266
 267 $config['db'] =
 268   array('database' => 'YOU HAVE TO SET THIS IN config.php',
 269         'schema_location' => INSTALLDIR . '/classes',
 270         'class_location' => INSTALLDIR . '/classes',
 271         'require_prefix' => 'classes/',
 272         'class_prefix' => '',
 273         'mirror' => null,
 274         'utf8' => true,
 275         'db_driver' => 'DB', # XXX: JanRain libs only work with DB
 276         'quote_identifiers' => false,
 277         'type' => 'mysql' );
 278
 279 if (function_exists('date_default_timezone_set')) {
 280     /* Work internally in UTC */
 281     date_default_timezone_set('UTC');
 282 }
 283
 284 // From most general to most specific:
 285 // server-wide, then vhost-wide, then for a path,
 286 // finally for a dir (usually only need one of the last two).
 287
 288 if (isset($conffile)) {
 289     $_config_files = array($conffile);
 290 } else {
 291     $_config_files = array('/etc/laconica/laconica.php',
 292                            '/etc/laconica/'.$_server.'.php');
 293
 294     if (strlen($_path) > 0) {
 295         $_config_files[] = '/etc/laconica/'.$_server.'_'.$_path.'.php';
 296     }
 297
 298     $_config_files[] = INSTALLDIR.'/config.php';
 299 }
 300
 301 $_have_a_config = false;
 302
 303 foreach ($_config_files as $_config_file) {
 304     if (@file_exists($_config_file)) {
 305         include_once($_config_file);
 306         $_have_a_config = true;
 307     }
 308 }
 309
 310 function _have_config()
 311 {
 312     global $_have_a_config;
 313     return $_have_a_config;
 314 }
 315
 316 // XXX: Throw a conniption if database not installed
 317
 318 // Fixup for laconica.ini
 319
 320 $_db_name = substr($config['db']['database'], strrpos($config['db']['database'], '/') + 1);
 321
 322 if ($_db_name != 'laconica' && !array_key_exists('ini_'.$_db_name, $config['db'])) {
 323     $config['db']['ini_'.$_db_name] = INSTALLDIR.'/classes/laconica.ini';
 324 }
 325
 326 // XXX: how many of these could be auto-loaded on use?
 327
 328 require_once 'Validate.php';
 329 require_once 'markdown.php';
 330
 331 require_once INSTALLDIR.'/lib/util.php';
 332 require_once INSTALLDIR.'/lib/action.php';
 333 require_once INSTALLDIR.'/lib/theme.php';
 334 require_once INSTALLDIR.'/lib/mail.php';
 335 require_once INSTALLDIR.'/lib/subs.php';
 336 require_once INSTALLDIR.'/lib/Shorturl_api.php';
 337 require_once INSTALLDIR.'/lib/twitter.php';
 338
 339 require_once INSTALLDIR.'/lib/clientexception.php';
 340 require_once INSTALLDIR.'/lib/serverexception.php';
 341
 342 // XXX: other formats here
 343
 344 define('NICKNAME_FMT', VALIDATE_NUM.VALIDATE_ALPHA_LOWER);
 345
 346 function __autoload($class)
 347 {
 348     if ($class == 'OAuthRequest') {
 349         require_once('OAuth.php');
 350     } else if (file_exists(INSTALLDIR.'/classes/' . $class . '.php')) {
 351         require_once(INSTALLDIR.'/classes/' . $class . '.php');
 352     } else if (file_exists(INSTALLDIR.'/lib/' . strtolower($class) . '.php')) {
 353         require_once(INSTALLDIR.'/lib/' . strtolower($class) . '.php');
 354     } else if (mb_substr($class, -6) == 'Action' &&
 355                file_exists(INSTALLDIR.'/actions/' . strtolower(mb_substr($class, 0, -6)) . '.php')) {
 356         require_once(INSTALLDIR.'/actions/' . strtolower(mb_substr($class, 0, -6)) . '.php');
 357     }
 358 }
 359
 360 // Give plugins a chance to initialize in a fully-prepared environment
 361
 362 Event::handle('InitializePlugin');