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