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