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               'path' => $_path,
  76               'logfile' => null,
  77               'logo' => null,
  78               'logdebug' => false,
  79               'fancy' => false,
  80               'locale_path' => INSTALLDIR.'/locale',
  81               'language' => 'en_US',
  82               'languages' => get_all_languages(),
  83               'email' =>
  84               array_key_exists('SERVER_ADMIN', $_SERVER) ? $_SERVER['SERVER_ADMIN'] : null,
  85               'broughtby' => null,
  86               'timezone' => 'UTC',
  87               'broughtbyurl' => null,
  88               'closed' => false,
  89               'inviteonly' => false,
  90               'private' => false,
  91               'ssl' => 'never',
  92               'sslserver' => null,
  93               'dupelimit' => 60), # default for same person saying the same thing
  94         'syslog' =>
  95         array('appname' => 'laconica', # for syslog
  96               'priority' => 'debug'), # XXX: currently ignored
  97         'queue' =>
  98         array('enabled' => false),
  99         'license' =>
 100         array('url' => 'http://creativecommons.org/licenses/by/3.0/',
 101               'title' => 'Creative Commons Attribution 3.0',
 102               'image' => 'http://i.creativecommons.org/l/by/3.0/80x15.png'),
 103         'mail' =>
 104         array('backend' => 'mail',
 105               'params' => null),
 106         'nickname' =>
 107         array('blacklist' => array(),
 108               'featured' => array()),
 109         'profile' =>
 110         array('banned' => array()),
 111         'avatar' =>
 112         array('server' => null),
 113         'public' =>
 114         array('localonly' => true,
 115               'blacklist' => array(),
 116               'autosource' => array()),
 117         'theme' =>
 118         array('server' => null),
 119         'throttle' =>
 120         array('enabled' => false, // whether to throttle edits; false by default
 121               'count' => 20, // number of allowed messages in timespan
 122               'timespan' => 600), // timespan for throttling
 123         'xmpp' =>
 124         array('enabled' => false,
 125               'server' => 'INVALID SERVER',
 126               'port' => 5222,
 127               'user' => 'update',
 128               'encryption' => true,
 129               'resource' => 'uniquename',
 130               'password' => 'blahblahblah',
 131               'host' => null, # only set if != server
 132               'debug' => false, # print extra debug info
 133               'public' => array()), # JIDs of users who want to receive the public stream
 134         'sphinx' =>
 135         array('enabled' => false,
 136               'server' => 'localhost',
 137               'port' => 3312),
 138         'tag' =>
 139         array('dropoff' => 864000.0),
 140         'popular' =>
 141         array('dropoff' => 864000.0),
 142         'daemon' =>
 143         array('piddir' => '/var/run',
 144               'user' => false,
 145               'group' => false),
 146         'twitterbridge' =>
 147         array('enabled' => false),
 148         'integration' =>
 149         array('source' => 'Laconica', # source attribute for Twitter
 150               'taguri' => $_server.',2009'), # base for tag URIs
 151         'memcached' =>
 152         array('enabled' => false,
 153               'server' => 'localhost',
 154               'port' => 11211),
 155                 'ping' =>
 156         array('notify' => array()),
 157         'inboxes' =>
 158         array('enabled' => true), # on by default for new sites
 159         'newuser' =>
 160         array('subscribe' => null,
 161               'welcome' => null),
 162         );
 163
 164 $config['db'] = &PEAR::getStaticProperty('DB_DataObject','options');
 165
 166 $config['db'] =
 167   array('database' => 'YOU HAVE TO SET THIS IN config.php',
 168         'schema_location' => INSTALLDIR . '/classes',
 169         'class_location' => INSTALLDIR . '/classes',
 170         'require_prefix' => 'classes/',
 171         'class_prefix' => '',
 172         'mirror' => null,
 173         'db_driver' => 'DB', # XXX: JanRain libs only work with DB
 174         'quote_identifiers' => false,
 175         'type' => 'mysql' );
 176
 177 if (function_exists('date_default_timezone_set')) {
 178     /* Work internally in UTC */
 179     date_default_timezone_set('UTC');
 180 }
 181
 182 // From most general to most specific:
 183 // server-wide, then vhost-wide, then for a path,
 184 // finally for a dir (usually only need one of the last two).
 185
 186 $_config_files = array('/etc/laconica/laconica.php',
 187                   '/etc/laconica/'.$_server.'.php');
 188
 189 if (strlen($_path) > 0) {
 190     $_config_files[] = '/etc/laconica/'.$_server.'_'.$_path.'.php';
 191 }
 192
 193 $_config_files[] = INSTALLDIR.'/config.php';
 194
 195 $_have_a_config = false;
 196
 197 foreach ($_config_files as $_config_file) {
 198     if (@file_exists($_config_file)) {
 199         include_once($_config_file);
 200         $_have_a_config = true;
 201     }
 202 }
 203
 204 function _have_config()
 205 {
 206     global $_have_a_config;
 207     return $_have_a_config;
 208 }
 209
 210 // XXX: Throw a conniption if database not installed
 211
 212 // Fixup for laconica.ini
 213
 214 $_db_name = substr($config['db']['database'], strrpos($config['db']['database'], '/') + 1);
 215
 216 if ($_db_name != 'laconica' && !array_key_exists('ini_'.$_db_name, $config['db'])) {
 217     $config['db']['ini_'.$_db_name] = INSTALLDIR.'/classes/laconica.ini';
 218 }
 219
 220 // XXX: how many of these could be auto-loaded on use?
 221
 222 require_once('Validate.php');
 223 require_once('markdown.php');
 224
 225 require_once(INSTALLDIR.'/lib/util.php');
 226 require_once(INSTALLDIR.'/lib/action.php');
 227 require_once(INSTALLDIR.'/lib/theme.php');
 228 require_once(INSTALLDIR.'/lib/mail.php');
 229 require_once(INSTALLDIR.'/lib/subs.php');
 230 require_once(INSTALLDIR.'/lib/Shorturl_api.php');
 231 require_once(INSTALLDIR.'/lib/twitter.php');
 232
 233 require_once(INSTALLDIR.'/lib/clientexception.php');
 234 require_once(INSTALLDIR.'/lib/serverexception.php');
 235
 236 // XXX: other formats here
 237
 238 define('NICKNAME_FMT', VALIDATE_NUM.VALIDATE_ALPHA_LOWER);
 239
 240 function __autoload($class)
 241 {
 242     if ($class == 'OAuthRequest') {
 243         require_once('OAuth.php');
 244     } else if (file_exists(INSTALLDIR.'/classes/' . $class . '.php')) {
 245         require_once(INSTALLDIR.'/classes/' . $class . '.php');
 246     } else if (file_exists(INSTALLDIR.'/lib/' . strtolower($class) . '.php')) {
 247         require_once(INSTALLDIR.'/lib/' . strtolower($class) . '.php');
 248     } else if (mb_substr($class, -6) == 'Action' &&
 249                file_exists(INSTALLDIR.'/actions/' . strtolower(mb_substr($class, 0, -6)) . '.php')) {
 250         require_once(INSTALLDIR.'/actions/' . strtolower(mb_substr($class, 0, -6)) . '.php');
 251     }
 252 }
 253
 254 // Give plugins a chance to initialize in a fully-prepared environment
 255
 256 Event::handle('InitializePlugin');