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