lib/framework.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2008-2010, StatusNet, 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('STATUSNET') && !defined('LACONICA')) { exit(1); }
  21
  22 define('STATUSNET_BASE_VERSION', '1.1.1');
  23 define('STATUSNET_LIFECYCLE', 'release'); // 'dev', 'alpha[0-9]+', 'beta[0-9]+', 'rc[0-9]+', 'release'
  24 define('STATUSNET_VERSION', STATUSNET_BASE_VERSION . '-' . STATUSNET_LIFECYCLE);
  25
  26 define('LACONICA_VERSION', STATUSNET_VERSION); // compatibility
  27
  28 define('STATUSNET_CODENAME', 'OK');
  29
  30 define('AVATAR_PROFILE_SIZE', 96);
  31 define('AVATAR_STREAM_SIZE', 48);
  32 define('AVATAR_MINI_SIZE', 24);
  33
  34 define('NOTICES_PER_PAGE', 20);
  35 define('PROFILES_PER_PAGE', 20);
  36 define('MESSAGES_PER_PAGE', 20);
  37 define('GROUPS_PER_PAGE', 20);
  38
  39 define('FOREIGN_NOTICE_SEND', 1);
  40 define('FOREIGN_NOTICE_RECV', 2);
  41 define('FOREIGN_NOTICE_SEND_REPLY', 4);
  42
  43 define('FOREIGN_FRIEND_SEND', 1);
  44 define('FOREIGN_FRIEND_RECV', 2);
  45
  46 define('NOTICE_INBOX_SOURCE_SUB', 1);
  47 define('NOTICE_INBOX_SOURCE_GROUP', 2);
  48 define('NOTICE_INBOX_SOURCE_REPLY', 3);
  49 define('NOTICE_INBOX_SOURCE_FORWARD', 4);
  50 define('NOTICE_INBOX_SOURCE_PROFILE_TAG', 5);
  51 define('NOTICE_INBOX_SOURCE_GATEWAY', -1);
  52
  53 // append our extlib dir as the last-resort place to find libs
  54
  55 set_include_path(get_include_path() . PATH_SEPARATOR . INSTALLDIR . '/extlib/');
  56
  57 // To protect against upstream libraries which haven't updated
  58 // for PHP 5.3 where dl() function may not be present...
  59 if (!function_exists('dl')) {
  60     // function_exists() returns false for things in disable_functions,
  61     // but they still exist and we'll die if we try to redefine them.
  62     //
  63     // Fortunately trying to call the disabled one will only trigger
  64     // a warning, not a fatal, so it's safe to leave it for our case.
  65     // Callers will be suppressing warnings anyway.
  66     $disabled = array_filter(array_map('trim', explode(',', ini_get('disable_functions'))));
  67     if (!in_array('dl', $disabled)) {
  68         function dl($library) {
  69             return false;
  70         }
  71     }
  72 }
  73
  74 // global configuration object
  75
  76 require_once 'PEAR.php';
  77 require_once 'PEAR/Exception.php';
  78 global $_PEAR;
  79 $_PEAR = new PEAR;
  80 $_PEAR->setErrorHandling(PEAR_ERROR_CALLBACK, 'PEAR_ErrorToPEAR_Exception');
  81
  82 require_once 'DB.php';
  83 require_once 'DB/DataObject.php';
  84 require_once 'DB/DataObject/Cast.php'; # for dates
  85 global $_DB;
  86 $_DB = new DB;
  87
  88 require_once(INSTALLDIR.'/lib/language.php');
  89
  90 // This gets included before the config file, so that admin code and plugins
  91 // can use it
  92
  93 require_once(INSTALLDIR.'/lib/event.php');
  94 require_once(INSTALLDIR.'/lib/plugin.php');
  95
  96 function addPlugin($name, $attrs = null)
  97 {
  98     return StatusNet::addPlugin($name, $attrs);
  99 }
 100
 101 function _have_config()
 102 {
 103     return StatusNet::haveConfig();
 104 }
 105
 106 function __autoload($cls)
 107 {
 108     if (file_exists(INSTALLDIR.'/classes/' . $cls . '.php')) {
 109         require_once(INSTALLDIR.'/classes/' . $cls . '.php');
 110     } else if (file_exists(INSTALLDIR.'/lib/' . strtolower($cls) . '.php')) {
 111         require_once(INSTALLDIR.'/lib/' . strtolower($cls) . '.php');
 112     } else if (mb_substr($cls, -6) == 'Action' &&
 113                file_exists(INSTALLDIR.'/actions/' . strtolower(mb_substr($cls, 0, -6)) . '.php')) {
 114         require_once(INSTALLDIR.'/actions/' . strtolower(mb_substr($cls, 0, -6)) . '.php');
 115     } else if ($cls == 'OAuthRequest') {
 116         require_once('OAuth.php');
 117     } else {
 118         Event::handle('Autoload', array(&$cls));
 119     }
 120 }
 121
 122 // XXX: how many of these could be auto-loaded on use?
 123 // XXX: note that these files should not use config options
 124 // at compile time since DB config options are not yet loaded.
 125
 126 require_once 'Validate.php';
 127 require_once 'markdown.php';
 128
 129 // XXX: other formats here
 130
 131 /**
 132  * Avoid the NICKNAME_FMT constant; use the Nickname class instead.
 133  *
 134  * Nickname::DISPLAY_FMT is more suitable for inserting into regexes;
 135  * note that it includes the [] and repeating bits, so should be wrapped
 136  * directly in a capture paren usually.
 137  *
 138  * For validation, use Nickname::normalize(), Nickname::isValid() etc.
 139  *
 140  * @deprecated
 141  */
 142 define('NICKNAME_FMT', VALIDATE_NUM.VALIDATE_ALPHA_LOWER);
 143
 144 require_once INSTALLDIR.'/lib/util.php';
 145 require_once INSTALLDIR.'/lib/action.php';
 146 require_once INSTALLDIR.'/lib/mail.php';
 147
 148 require_once INSTALLDIR.'/lib/clientexception.php';
 149 require_once INSTALLDIR.'/lib/serverexception.php';
 150
 151
 152 //set PEAR error handling to use regular PHP exceptions
 153 function PEAR_ErrorToPEAR_Exception($err)
 154 {
 155     //DB_DataObject throws error when an empty set would be returned
 156     //That behavior is weird, and not how the rest of StatusNet works.
 157     //So just ignore those errors.
 158     if ($err->getCode() == DB_DATAOBJECT_ERROR_NODATA) {
 159         return;
 160     }
 161
 162     $msg      = $err->getMessage();
 163     $userInfo = $err->getUserInfo();
 164
 165     // Log this; push the message up as an exception
 166
 167     common_log(LOG_ERR, "PEAR Error: $msg ($userInfo)");
 168
 169     // HACK: queue handlers get kicked by the long-query killer, and
 170     // keep the same broken connection. We die here to get a new
 171     // process started.
 172
 173     if (php_sapi_name() == 'cli' && preg_match('/nativecode=2006/', $userInfo)) {
 174         common_log(LOG_ERR, "Lost DB connection; dying.");
 175         exit(100);
 176     }
 177
 178     if ($err->getCode()) {
 179         throw new PEAR_Exception($err->getMessage(), $err->getCode());
 180     }
 181     throw new PEAR_Exception($err->getMessage());
 182 }