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