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