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', 'beta5'); // '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', 'Not decided yet');
  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 define('PEOPLETAGS_PER_PAGE', 20);
  42
  43 define('GROUPS_PER_MINILIST', 8);
  44 define('PROFILES_PER_MINILIST', 8);
  45
  46 define('FOREIGN_NOTICE_SEND', 1);
  47 define('FOREIGN_NOTICE_RECV', 2);
  48 define('FOREIGN_NOTICE_SEND_REPLY', 4);
  49
  50 define('FOREIGN_FRIEND_SEND', 1);
  51 define('FOREIGN_FRIEND_RECV', 2);
  52
  53 define('NOTICE_INBOX_SOURCE_SUB', 1);
  54 define('NOTICE_INBOX_SOURCE_GROUP', 2);
  55 define('NOTICE_INBOX_SOURCE_REPLY', 3);
  56 define('NOTICE_INBOX_SOURCE_FORWARD', 4);
  57 define('NOTICE_INBOX_SOURCE_PROFILE_TAG', 5);
  58 define('NOTICE_INBOX_SOURCE_GATEWAY', -1);
  59
  60 /**
  61  * StatusNet had this string as valid path characters: '\pN\pL\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\'\@'
  62  * Some of those characters can be troublesome when auto-linking plain text. Such as "http://some.com/)"
  63  * URL encoding should be used whenever a weird character is used, the following strings are not definitive.
  64  */
  65 define('URL_REGEX_VALID_PATH_CHARS',        '\pN\pL\,\!\.\:\-\_\+\/\@\=\;\%\~\*');
  66 define('URL_REGEX_VALID_QSTRING_CHARS',     URL_REGEX_VALID_PATH_CHARS    . '\&');
  67 define('URL_REGEX_VALID_FRAGMENT_CHARS',    URL_REGEX_VALID_QSTRING_CHARS . '\?\#');
  68 define('URL_REGEX_EXCLUDED_END_CHARS',      '\?\.\,\!\#\:\'');  // don't include these if they are directly after a URL
  69 define('URL_REGEX_DOMAIN_NAME', '(?:(?!-)[A-Za-z0-9\-]{1,63}(?<!-)\.)+[A-Za-z]{2,10}');
  70
  71 // append our extlib dir as the last-resort place to find libs
  72
  73 set_include_path(get_include_path() . PATH_SEPARATOR . INSTALLDIR . '/extlib/');
  74
  75 // To protect against upstream libraries which haven't updated
  76 // for PHP 5.3 where dl() function may not be present...
  77 if (!function_exists('dl')) {
  78     // function_exists() returns false for things in disable_functions,
  79     // but they still exist and we'll die if we try to redefine them.
  80     //
  81     // Fortunately trying to call the disabled one will only trigger
  82     // a warning, not a fatal, so it's safe to leave it for our case.
  83     // Callers will be suppressing warnings anyway.
  84     $disabled = array_filter(array_map('trim', explode(',', ini_get('disable_functions'))));
  85     if (!in_array('dl', $disabled)) {
  86         function dl($library) {
  87             return false;
  88         }
  89     }
  90 }
  91
  92 // global configuration object
  93
  94 require_once 'PEAR.php';
  95 require_once 'PEAR/Exception.php';
  96 global $_PEAR;
  97 $_PEAR = new PEAR;
  98 $_PEAR->setErrorHandling(PEAR_ERROR_CALLBACK, 'PEAR_ErrorToPEAR_Exception');
  99
 100 require_once 'DB.php';
 101 require_once 'DB/DataObject.php';
 102 require_once 'DB/DataObject/Cast.php'; # for dates
 103 global $_DB;
 104 $_DB = new DB;
 105
 106 require_once(INSTALLDIR.'/lib/language.php');
 107
 108 // This gets included before the config file, so that admin code and plugins
 109 // can use it
 110
 111 require_once(INSTALLDIR.'/lib/event.php');
 112 require_once(INSTALLDIR.'/lib/plugin.php');
 113
 114 function addPlugin($name, array $attrs=array())
 115 {
 116     return GNUsocial::addPlugin($name, $attrs);
 117 }
 118
 119 function _have_config()
 120 {
 121     return GNUsocial::haveConfig();
 122 }
 123
 124 function GNUsocial_class_autoload($cls)
 125 {
 126     if (file_exists(INSTALLDIR.'/classes/' . $cls . '.php')) {
 127         require_once(INSTALLDIR.'/classes/' . $cls . '.php');
 128     } else if (file_exists(INSTALLDIR.'/lib/' . strtolower($cls) . '.php')) {
 129         require_once(INSTALLDIR.'/lib/' . strtolower($cls) . '.php');
 130     } else if (mb_substr($cls, -6) == 'Action' &&
 131                file_exists(INSTALLDIR.'/actions/' . strtolower(mb_substr($cls, 0, -6)) . '.php')) {
 132         require_once(INSTALLDIR.'/actions/' . strtolower(mb_substr($cls, 0, -6)) . '.php');
 133     } else if ($cls === 'OAuthRequest' || $cls === 'OAuthException') {
 134         require_once('OAuth.php');
 135     } else {
 136         Event::handle('Autoload', array(&$cls));
 137     }
 138 }
 139
 140 // Autoload function queue, starting with our own discovery method
 141 spl_autoload_register('GNUsocial_class_autoload');
 142
 143 /**
 144  * Extlibs with namespaces (or directly in extlib/)
 145  * This covers libraries such as: Validate and \Michelf\Markdown
 146  *
 147  * The namespaced based structure is called "PSR-0 autoloading standard":
 148  *    \<Vendor Name>\(<Namespace>\)*<Class Name>
 149  * and is available here: http://www.php-fig.org/psr/psr-0/
 150 */
 151 spl_autoload_register(function($class){
 152     $class_base = preg_replace('{\\\\|_(?!.*\\\\)}', DIRECTORY_SEPARATOR, ltrim($class, '\\'));
 153     $file = INSTALLDIR."/extlib/{$class_base}.php";
 154     if (file_exists($file)) {
 155         require_once $file;
 156         return;
 157     }
 158
 159     # Try if the system has this external library
 160     $file = "/usr/share/php/{$class_base}.php";
 161     if (file_exists($file)) {
 162         require_once $file;
 163         return;
 164     }
 165 });
 166
 167 require_once INSTALLDIR.'/lib/util.php';
 168 require_once INSTALLDIR.'/lib/action.php';
 169 require_once INSTALLDIR.'/lib/mail.php';
 170
 171 //set PEAR error handling to use regular PHP exceptions
 172 function PEAR_ErrorToPEAR_Exception(PEAR_Error $err)
 173 {
 174     //DB_DataObject throws error when an empty set would be returned
 175     //That behavior is weird, and not how the rest of StatusNet works.
 176     //So just ignore those errors.
 177     if ($err->getCode() == DB_DATAOBJECT_ERROR_NODATA) {
 178         return;
 179     }
 180
 181     $msg      = $err->getMessage();
 182     $userInfo = $err->getUserInfo();
 183
 184     // Log this; push the message up as an exception
 185
 186     common_log(LOG_ERR, "PEAR Error: $msg ($userInfo)");
 187
 188     // HACK: queue handlers get kicked by the long-query killer, and
 189     // keep the same broken connection. We die here to get a new
 190     // process started.
 191
 192     if (php_sapi_name() == 'cli' && preg_match('/nativecode=2006/', $userInfo)) {
 193         common_log(LOG_ERR, "Lost DB connection; dying.");
 194         exit(100);
 195     }
 196
 197     if ($err->getCode()) {
 198         throw new PEAR_Exception($err->getMessage(), $err->getCode());
 199     }
 200     throw new PEAR_Exception($err->getMessage());
 201 }