lib/common.php

   1 <?php
   2 /*
   3  * Laconica - a distributed open-source microblogging tool
   4  * Copyright (C) 2008, Controlez-Vous, 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 // try to figure out where we are
  59
  60 $_server = array_key_exists('SERVER_NAME', $_SERVER) ?
  61   strtolower($_SERVER['SERVER_NAME']) :
  62   null;
  63 $_path = array_key_exists('SCRIPT_NAME', $_SERVER) ?
  64   substr($_SERVER['SCRIPT_NAME'], 1, strrpos($_SERVER['SCRIPT_NAME'], '/') - 1) :
  65   null;
  66
  67 // default configuration, overwritten in config.php
  68
  69 $config =
  70   array('site' =>
  71         array('name' => 'Just another Laconica microblog',
  72               'server' => $_server,
  73               'theme' => 'default',
  74               'skin' => 'default',
  75               'design' =>
  76               array('backgroundcolor' => '#F0F2F5',
  77                     'contentcolor' => '#FFFFFF',
  78                     'sidebarcolor' => '#CEE1E9',
  79                     'textcolor' => '#000000',
  80                     'linkcolor' => '#002E6E',
  81                     'backgroundimage' => null),
  82               'path' => $_path,
  83               'logfile' => null,
  84               'logo' => null,
  85               'logdebug' => false,
  86               'fancy' => false,
  87               'locale_path' => INSTALLDIR.'/locale',
  88               'language' => 'en_US',
  89               'languages' => get_all_languages(),
  90               'email' =>
  91               array_key_exists('SERVER_ADMIN', $_SERVER) ? $_SERVER['SERVER_ADMIN'] : null,
  92               'broughtby' => null,
  93               'timezone' => 'UTC',
  94               'broughtbyurl' => null,
  95               'closed' => false,
  96               'inviteonly' => false,
  97               'private' => false,
  98               'ssl' => 'never',
  99               'sslserver' => null,
 100               'dupelimit' => 60), # default for same person saying the same thing
 101         'syslog' =>
 102         array('appname' => 'laconica', # for syslog
 103               'priority' => 'debug'), # XXX: currently ignored
 104         'queue' =>
 105         array('enabled' => false),
 106         'license' =>
 107         array('url' => 'http://creativecommons.org/licenses/by/3.0/',
 108               'title' => 'Creative Commons Attribution 3.0',
 109               'image' => 'http://i.creativecommons.org/l/by/3.0/80x15.png'),
 110         'mail' =>
 111         array('backend' => 'mail',
 112               'params' => null),
 113         'nickname' =>
 114         array('blacklist' => array(),
 115               'featured' => array()),
 116         'profile' =>
 117         array('banned' => array()),
 118         'avatar' =>
 119         array('server' => null,
 120               'dir' => INSTALLDIR . '/avatar/',
 121               'path' => $_path . '/avatar/'),
 122         'background' =>
 123         array('server' => null,
 124               'dir' => INSTALLDIR . '/background/',
 125               'path' => $_path . '/background/'),
 126         'public' =>
 127         array('localonly' => true,
 128               'blacklist' => array(),
 129               'autosource' => array()),
 130         'theme' =>
 131         array('server' => null),
 132         'throttle' =>
 133         array('enabled' => false, // whether to throttle edits; false by default
 134               'count' => 20, // number of allowed messages in timespan
 135               'timespan' => 600), // timespan for throttling
 136         'xmpp' =>
 137         array('enabled' => false,
 138               'server' => 'INVALID SERVER',
 139               'port' => 5222,
 140               'user' => 'update',
 141               'encryption' => true,
 142               'resource' => 'uniquename',
 143               'password' => 'blahblahblah',
 144               'host' => null, # only set if != server
 145               'debug' => false, # print extra debug info
 146               'public' => array()), # JIDs of users who want to receive the public stream
 147         'sphinx' =>
 148         array('enabled' => false,
 149               'server' => 'localhost',
 150               'port' => 3312),
 151         'tag' =>
 152         array('dropoff' => 864000.0),
 153         'popular' =>
 154         array('dropoff' => 864000.0),
 155         'daemon' =>
 156         array('piddir' => '/var/run',
 157               'user' => false,
 158               'group' => false),
 159         'twitterbridge' =>
 160         array('enabled' => false),
 161         'integration' =>
 162         array('source' => 'Laconica', # source attribute for Twitter
 163               'taguri' => $_server.',2009'), # base for tag URIs
 164         'memcached' =>
 165         array('enabled' => false,
 166               'server' => 'localhost',
 167               'base' => null,
 168               'port' => 11211),
 169                 'ping' =>
 170         array('notify' => array()),
 171         'inboxes' =>
 172         array('enabled' => true), # on by default for new sites
 173         'newuser' =>
 174         array('subscribe' => null,
 175               'welcome' => null),
 176         'snapshot' =>
 177         array('run' => 'web',
 178               'frequency' => 10000,
 179               'reporturl' => 'http://laconi.ca/stats/report'),
 180         'attachments' =>
 181         array('supported' => array('image/png',
 182             'image/jpeg',
 183             'image/gif',
 184             'image/svg+xml',
 185             'audio/mpeg',
 186             'audio/x-speex',
 187             'application/ogg',
 188             'application/pdf',
 189             'application/vnd.oasis.opendocument.text',
 190             'application/vnd.oasis.opendocument.text-template',
 191             'application/vnd.oasis.opendocument.graphics',
 192             'application/vnd.oasis.opendocument.graphics-template',
 193             'application/vnd.oasis.opendocument.presentation',
 194             'application/vnd.oasis.opendocument.presentation-template',
 195             'application/vnd.oasis.opendocument.spreadsheet',
 196             'application/vnd.oasis.opendocument.spreadsheet-template',
 197             'application/vnd.oasis.opendocument.chart',
 198             'application/vnd.oasis.opendocument.chart-template',
 199             'application/vnd.oasis.opendocument.image',
 200             'application/vnd.oasis.opendocument.image-template',
 201             'application/vnd.oasis.opendocument.formula',
 202             'application/vnd.oasis.opendocument.formula-template',
 203             'application/vnd.oasis.opendocument.text-master',
 204             'application/vnd.oasis.opendocument.text-web',
 205             'application/x-zip',
 206             'application/zip',
 207             'text/plain',
 208             'video/mpeg',
 209             'video/mp4',
 210             'video/quicktime',
 211             'video/mpeg'),
 212         'file_quota' => 5000000,
 213         'user_quota' => 50000000,
 214         'monthly_quota' => 15000000,
 215         ),
 216         'group' =>
 217         array('maxaliases' => 3),
 218         );
 219
 220 $config['db'] = &PEAR::getStaticProperty('DB_DataObject','options');
 221
 222 $config['db'] =
 223   array('database' => 'YOU HAVE TO SET THIS IN config.php',
 224         'schema_location' => INSTALLDIR . '/classes',
 225         'class_location' => INSTALLDIR . '/classes',
 226         'require_prefix' => 'classes/',
 227         'class_prefix' => '',
 228         'mirror' => null,
 229         'utf8' => true,
 230         'db_driver' => 'DB', # XXX: JanRain libs only work with DB
 231         'quote_identifiers' => false,
 232         'type' => 'mysql' );
 233
 234 if (function_exists('date_default_timezone_set')) {
 235     /* Work internally in UTC */
 236     date_default_timezone_set('UTC');
 237 }
 238
 239 // From most general to most specific:
 240 // server-wide, then vhost-wide, then for a path,
 241 // finally for a dir (usually only need one of the last two).
 242
 243 $_config_files = array('/etc/laconica/laconica.php',
 244                   '/etc/laconica/'.$_server.'.php');
 245
 246 if (strlen($_path) > 0) {
 247     $_config_files[] = '/etc/laconica/'.$_server.'_'.$_path.'.php';
 248 }
 249
 250 $_config_files[] = INSTALLDIR.'/config.php';
 251
 252 $_have_a_config = false;
 253
 254 foreach ($_config_files as $_config_file) {
 255     if (@file_exists($_config_file)) {
 256         include_once($_config_file);
 257         $_have_a_config = true;
 258     }
 259 }
 260
 261 function _have_config()
 262 {
 263     global $_have_a_config;
 264     return $_have_a_config;
 265 }
 266
 267 // XXX: Throw a conniption if database not installed
 268
 269 // Fixup for laconica.ini
 270
 271 $_db_name = substr($config['db']['database'], strrpos($config['db']['database'], '/') + 1);
 272
 273 if ($_db_name != 'laconica' && !array_key_exists('ini_'.$_db_name, $config['db'])) {
 274     $config['db']['ini_'.$_db_name] = INSTALLDIR.'/classes/laconica.ini';
 275 }
 276
 277 // XXX: how many of these could be auto-loaded on use?
 278
 279 require_once 'Validate.php';
 280 require_once 'markdown.php';
 281
 282 require_once INSTALLDIR.'/lib/util.php';
 283 require_once INSTALLDIR.'/lib/action.php';
 284 require_once INSTALLDIR.'/lib/theme.php';
 285 require_once INSTALLDIR.'/lib/mail.php';
 286 require_once INSTALLDIR.'/lib/subs.php';
 287 require_once INSTALLDIR.'/lib/Shorturl_api.php';
 288 require_once INSTALLDIR.'/lib/twitter.php';
 289
 290 require_once INSTALLDIR.'/lib/clientexception.php';
 291 require_once INSTALLDIR.'/lib/serverexception.php';
 292
 293 // XXX: other formats here
 294
 295 define('NICKNAME_FMT', VALIDATE_NUM.VALIDATE_ALPHA_LOWER);
 296
 297 function __autoload($class)
 298 {
 299     if ($class == 'OAuthRequest') {
 300         require_once('OAuth.php');
 301     } else if (file_exists(INSTALLDIR.'/classes/' . $class . '.php')) {
 302         require_once(INSTALLDIR.'/classes/' . $class . '.php');
 303     } else if (file_exists(INSTALLDIR.'/lib/' . strtolower($class) . '.php')) {
 304         require_once(INSTALLDIR.'/lib/' . strtolower($class) . '.php');
 305     } else if (mb_substr($class, -6) == 'Action' &&
 306                file_exists(INSTALLDIR.'/actions/' . strtolower(mb_substr($class, 0, -6)) . '.php')) {
 307         require_once(INSTALLDIR.'/actions/' . strtolower(mb_substr($class, 0, -6)) . '.php');
 308     }
 309 }
 310
 311 // Give plugins a chance to initialize in a fully-prepared environment
 312
 313 Event::handle('InitializePlugin');