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.2.0');
  26 define('GNUSOCIAL_LIFECYCLE', 'alpha2'); // 'dev', 'alpha[0-9]+', 'beta[0-9]+', 'rc[0-9]+', 'release'
  27
  28 define('GNUSOCIAL_VERSION', GNUSOCIAL_BASE_VERSION . '-' . GNUSOCIAL_LIFECYCLE);
  29
  30 define('GNUSOCIAL_CODENAME', 'Only a fixed bug is a good bug.');
  31
  32 define('AVATAR_PROFILE_SIZE', 96);
  33 define('AVATAR_STREAM_SIZE', 48);
  34 define('AVATAR_MINI_SIZE', 24);
  35
  36 define('NOTICES_PER_PAGE', 20);
  37 define('PROFILES_PER_PAGE', 20);
  38 define('MESSAGES_PER_PAGE', 20);
  39 define('GROUPS_PER_PAGE', 20);
  40 define('APPS_PER_PAGE', 20);
  41
  42 define('GROUPS_PER_MINILIST', 8);
  43 define('PROFILES_PER_MINILIST', 8);
  44
  45 define('FOREIGN_NOTICE_SEND', 1);
  46 define('FOREIGN_NOTICE_RECV', 2);
  47 define('FOREIGN_NOTICE_SEND_REPLY', 4);
  48
  49 define('FOREIGN_FRIEND_SEND', 1);
  50 define('FOREIGN_FRIEND_RECV', 2);
  51
  52 define('NOTICE_INBOX_SOURCE_SUB', 1);
  53 define('NOTICE_INBOX_SOURCE_GROUP', 2);
  54 define('NOTICE_INBOX_SOURCE_REPLY', 3);
  55 define('NOTICE_INBOX_SOURCE_FORWARD', 4);
  56 define('NOTICE_INBOX_SOURCE_PROFILE_TAG', 5);
  57 define('NOTICE_INBOX_SOURCE_GATEWAY', -1);
  58
  59 // append our extlib dir as the last-resort place to find libs
  60
  61 set_include_path(get_include_path() . PATH_SEPARATOR . INSTALLDIR . '/extlib/');
  62
  63 // To protect against upstream libraries which haven't updated
  64 // for PHP 5.3 where dl() function may not be present...
  65 if (!function_exists('dl')) {
  66     // function_exists() returns false for things in disable_functions,
  67     // but they still exist and we'll die if we try to redefine them.
  68     //
  69     // Fortunately trying to call the disabled one will only trigger
  70     // a warning, not a fatal, so it's safe to leave it for our case.
  71     // Callers will be suppressing warnings anyway.
  72     $disabled = array_filter(array_map('trim', explode(',', ini_get('disable_functions'))));
  73     if (!in_array('dl', $disabled)) {
  74         function dl($library) {
  75             return false;
  76         }
  77     }
  78 }
  79
  80 // global configuration object
  81
  82 require_once 'PEAR.php';
  83 require_once 'PEAR/Exception.php';
  84 global $_PEAR;
  85 $_PEAR = new PEAR;
  86 $_PEAR->setErrorHandling(PEAR_ERROR_CALLBACK, 'PEAR_ErrorToPEAR_Exception');
  87
  88 require_once 'DB.php';
  89 require_once 'DB/DataObject.php';
  90 require_once 'DB/DataObject/Cast.php'; # for dates
  91 global $_DB;
  92 $_DB = new DB;
  93
  94 require_once(INSTALLDIR.'/lib/language.php');
  95
  96 // This gets included before the config file, so that admin code and plugins
  97 // can use it
  98
  99 require_once(INSTALLDIR.'/lib/event.php');
 100 require_once(INSTALLDIR.'/lib/plugin.php');
 101
 102 function addPlugin($name, array $attrs=array())
 103 {
 104     return GNUsocial::addPlugin($name, $attrs);
 105 }
 106
 107 function _have_config()
 108 {
 109     return GNUsocial::haveConfig();
 110 }
 111
 112 function common_get_temp_dir()
 113 {
 114     // Try to get it from php.ini first
 115     $temp_path = trim(ini_get('upload_tmp_dir'));
 116
 117     // Is it empty?
 118     if (strlen($temp_path) == 0) {
 119         // Then try sys_get_temp_dir()
 120         $temp_path = trim(sys_get_temp_dir());
 121
 122         // Still empty?
 123         if (strlen($temp_path) == 0) {
 124             // Then set it to /tmp (ugly)
 125             // @TODO Hard-coded non-Windows stuff!
 126             $temp_path = '/tmp';
 127         }
 128     }
 129
 130     // Return found path
 131     return $temp_path;
 132 }
 133
 134 function GNUsocial_class_autoload($cls)
 135 {
 136     if (file_exists(INSTALLDIR.'/classes/' . $cls . '.php')) {
 137         require_once(INSTALLDIR.'/classes/' . $cls . '.php');
 138     } else if (file_exists(INSTALLDIR.'/lib/' . strtolower($cls) . '.php')) {
 139         require_once(INSTALLDIR.'/lib/' . strtolower($cls) . '.php');
 140     } else if (mb_substr($cls, -6) == 'Action' &&
 141                file_exists(INSTALLDIR.'/actions/' . strtolower(mb_substr($cls, 0, -6)) . '.php')) {
 142         require_once(INSTALLDIR.'/actions/' . strtolower(mb_substr($cls, 0, -6)) . '.php');
 143     } else if ($cls === 'OAuthRequest' || $cls === 'OAuthException') {
 144         require_once('OAuth.php');
 145     } else {
 146         Event::handle('Autoload', array(&$cls));
 147     }
 148 }
 149
 150
 151 // Autoload function queue, starting with our own discovery method
 152 spl_autoload_register('GNUsocial_class_autoload');
 153
 154 /**
 155  * Extlibs with namespaces (or directly in extlib/)
 156  * This covers libraries such as: Validate and \Michelf\Markdown
 157  *
 158  * The namespaced based structure is called "PSR-0 autoloading standard":
 159  *    \<Vendor Name>\(<Namespace>\)*<Class Name>
 160  * and is available here: http://www.php-fig.org/psr/psr-0/
 161 */
 162 spl_autoload_register(function($class){
 163     $class_path = preg_replace('{\\\\|_(?!.*\\\\)}', DIRECTORY_SEPARATOR, ltrim($class, '\\')).'.php';
 164     $file = INSTALLDIR.'/extlib/'.$class_path;
 165     if (file_exists($file)) {
 166         require_once $file;
 167         return;
 168     }
 169
 170     # Try if the system has this external library
 171     $file = '/usr/share/php/'.$class_path;
 172     if (file_exists($file)) {
 173         require_once $file;
 174         return;
 175     }
 176 });
 177
 178 require_once INSTALLDIR.'/lib/util.php';
 179 require_once INSTALLDIR.'/lib/action.php';
 180 require_once INSTALLDIR.'/lib/mail.php';
 181
 182 //set PEAR error handling to use regular PHP exceptions
 183 function PEAR_ErrorToPEAR_Exception(PEAR_Error $err)
 184 {
 185     //DB_DataObject throws error when an empty set would be returned
 186     //That behavior is weird, and not how the rest of StatusNet works.
 187     //So just ignore those errors.
 188     if ($err->getCode() == DB_DATAOBJECT_ERROR_NODATA) {
 189         return;
 190     }
 191
 192     $msg      = $err->getMessage();
 193     $userInfo = $err->getUserInfo();
 194
 195     // Log this; push the message up as an exception
 196
 197     common_log(LOG_ERR, "PEAR Error: $msg ($userInfo)");
 198
 199     // HACK: queue handlers get kicked by the long-query killer, and
 200     // keep the same broken connection. We die here to get a new
 201     // process started.
 202
 203     if (php_sapi_name() == 'cli' && preg_match('/nativecode=2006/', $userInfo)) {
 204         common_log(LOG_ERR, "Lost DB connection; dying.");
 205         exit(100);
 206     }
 207
 208     if ($err->getCode()) {
 209         throw new PEAR_Exception($err->getMessage(), $err->getCode());
 210     }
 211     throw new PEAR_Exception($err->getMessage());
 212 }