4 * This file defines some global constants and includes the central App class.
10 * Friendica is a communications platform for integrated social communications
11 * utilising decentralised communications and linkage to several indie social
12 * projects - as well as popular mainstream providers.
14 * Our mission is to free our friends and families from the clutches of
15 * data-harvesting corporations, and pave the way to a future where social
16 * communications are free and open and flow between alternate providers as
17 * easily as email does today.
20 use Friendica\Core\Protocol;
21 use Friendica\Core\System;
22 use Friendica\Database\DBA;
24 use Friendica\Model\Contact;
25 use Friendica\Model\Term;
26 use Friendica\Util\BasePath;
27 use Friendica\Util\DateTimeFormat;
29 define('FRIENDICA_PLATFORM', 'Friendica');
30 define('FRIENDICA_CODENAME', 'Dalmatian Bellflower');
31 define('FRIENDICA_VERSION', '2020.03-dev');
32 define('DFRN_PROTOCOL_VERSION', '2.23');
33 define('NEW_UPDATE_ROUTINE_VERSION', 1170);
36 * Constant with a HTML line break.
38 * Contains a HTML line break (br) element and a real carriage return with line
39 * feed for the source.
40 * This can be used in HTML and JavaScript where needed a line break.
42 define('EOL', "<br />\r\n");
45 * Image storage quality.
47 * Lower numbers save space at cost of image detail.
48 * For ease of upgrade, please do not change here. Set system.jpegquality = n in config/local.config.php,
49 * where n is between 1 and 100, and with very poor results below about 50
51 define('JPEG_QUALITY', 100);
54 * system.png_quality = n where is between 0 (uncompressed) to 9
56 define('PNG_QUALITY', 8);
59 * An alternate way of limiting picture upload sizes. Specify the maximum pixel
60 * length that pictures are allowed to be (for non-square pictures, it will apply
61 * to the longest side). Pictures longer than this length will be resized to be
62 * this length (on the longest side, the other side will be scaled appropriately).
63 * Modify this value using
66 * 'max_image_length' => 'n',
70 * in config/local.config.php
72 * If you don't want to set a maximum length, set to -1. The default value is
73 * defined by 'MAX_IMAGE_LENGTH' below.
75 define('MAX_IMAGE_LENGTH', -1);
80 define('DEFAULT_DB_ENGINE', 'InnoDB');
82 /** @deprecated since version 2019.03, please use \Friendica\Module\Register::CLOSED instead */
83 define('REGISTER_CLOSED', \Friendica\Module\Register::CLOSED);
84 /** @deprecated since version 2019.03, please use \Friendica\Module\Register::APPROVE instead */
85 define('REGISTER_APPROVE', \Friendica\Module\Register::APPROVE);
86 /** @deprecated since version 2019.03, please use \Friendica\Module\Register::OPEN instead */
87 define('REGISTER_OPEN', \Friendica\Module\Register::OPEN);
92 * Type of the community page
95 define('CP_NO_INTERNAL_COMMUNITY', -2);
96 define('CP_NO_COMMUNITY_PAGE', -1);
97 define('CP_USERS_ON_SERVER', 0);
98 define('CP_GLOBAL_COMMUNITY', 1);
99 define('CP_USERS_AND_GLOBAL', 2);
105 * These numbers are used in stored permissions
106 * and existing allocations MUST NEVER BE CHANGED
107 * OR RE-ASSIGNED! You may only add to them.
110 Protocol::DFRN => (-1),
111 Protocol::ZOT => (-2),
112 Protocol::OSTATUS => (-3),
113 Protocol::FEED => (-4),
114 Protocol::DIASPORA => (-5),
115 Protocol::MAIL => (-6),
116 Protocol::FACEBOOK => (-8),
117 Protocol::LINKEDIN => (-9),
118 Protocol::XMPP => (-10),
119 Protocol::MYSPACE => (-11),
120 Protocol::GPLUS => (-12),
121 Protocol::PUMPIO => (-13),
122 Protocol::TWITTER => (-14),
123 Protocol::DIASPORA2 => (-15),
124 Protocol::STATUSNET => (-16),
125 Protocol::NEWS => (-18),
126 Protocol::ICALENDAR => (-19),
127 Protocol::PNUT => (-20),
129 Protocol::PHANTOM => (-127),
133 * Maximum number of "people who like (or don't like) this" that we will list by name
135 define('MAX_LIKERS', 75);
140 * Email notification options
143 define('NOTIFY_INTRO', 1);
144 define('NOTIFY_CONFIRM', 2);
145 define('NOTIFY_WALL', 4);
146 define('NOTIFY_COMMENT', 8);
147 define('NOTIFY_MAIL', 16);
148 define('NOTIFY_SUGGEST', 32);
149 define('NOTIFY_PROFILE', 64);
150 define('NOTIFY_TAGSELF', 128);
151 define('NOTIFY_TAGSHARE', 256);
152 define('NOTIFY_POKE', 512);
153 define('NOTIFY_SHARE', 1024);
155 define('SYSTEM_EMAIL', 16384);
157 define('NOTIFY_SYSTEM', 32768);
161 /** @deprecated since 2019.03, use Term::UNKNOWN instead */
162 define('TERM_UNKNOWN', Term::UNKNOWN);
163 /** @deprecated since 2019.03, use Term::HASHTAG instead */
164 define('TERM_HASHTAG', Term::HASHTAG);
165 /** @deprecated since 2019.03, use Term::MENTION instead */
166 define('TERM_MENTION', Term::MENTION);
167 /** @deprecated since 2019.03, use Term::CATEGORY instead */
168 define('TERM_CATEGORY', Term::CATEGORY);
169 /** @deprecated since 2019.03, use Term::PCATEGORY instead */
170 define('TERM_PCATEGORY', Term::PCATEGORY);
171 /** @deprecated since 2019.03, use Term::FILE instead */
172 define('TERM_FILE', Term::FILE);
173 /** @deprecated since 2019.03, use Term::SAVEDSEARCH instead */
174 define('TERM_SAVEDSEARCH', Term::SAVEDSEARCH);
175 /** @deprecated since 2019.03, use Term::CONVERSATION instead */
176 define('TERM_CONVERSATION', Term::CONVERSATION);
178 /** @deprecated since 2019.03, use Term::OBJECT_TYPE_POST instead */
179 define('TERM_OBJ_POST', Term::OBJECT_TYPE_POST);
180 /** @deprecated since 2019.03, use Term::OBJECT_TYPE_PHOTO instead */
181 define('TERM_OBJ_PHOTO', Term::OBJECT_TYPE_PHOTO);
186 * Item weight for query ordering
189 define('GRAVITY_PARENT', 0);
190 define('GRAVITY_ACTIVITY', 3);
191 define('GRAVITY_COMMENT', 6);
192 define('GRAVITY_UNKNOWN', 9);
198 * Process priority for the worker
201 define('PRIORITY_UNDEFINED', 0);
202 define('PRIORITY_CRITICAL', 10);
203 define('PRIORITY_HIGH', 20);
204 define('PRIORITY_MEDIUM', 30);
205 define('PRIORITY_LOW', 40);
206 define('PRIORITY_NEGLIGIBLE', 50);
210 * @name Social Relay settings
212 * See here: https://github.com/jaywink/social-relay
213 * and here: https://wiki.diasporafoundation.org/Relay_servers_for_public_posts
216 define('SR_SCOPE_NONE', '');
217 define('SR_SCOPE_ALL', 'all');
218 define('SR_SCOPE_TAGS', 'tags');
221 // Normally this constant is defined - but not if "pcntl" isn't installed
222 if (!defined("SIGTERM")) {
223 define("SIGTERM", 15);
227 * Depending on the PHP version this constant does exist - or not.
228 * See here: http://php.net/manual/en/curl.constants.php#117928
230 if (!defined('CURLE_OPERATION_TIMEDOUT')) {
231 define('CURLE_OPERATION_TIMEDOUT', CURLE_OPERATION_TIMEOUTED);
235 * Returns the user id of locally logged in user or false.
237 * @return int|bool user id or false
239 function local_user()
241 if (!empty($_SESSION['authenticated']) && !empty($_SESSION['uid'])) {
242 return intval($_SESSION['uid']);
248 * Returns the public contact id of logged in user or false.
250 * @return int|bool public contact id or false
252 function public_contact()
254 static $public_contact_id = false;
256 if (!$public_contact_id && !empty($_SESSION['authenticated'])) {
257 if (!empty($_SESSION['my_address'])) {
259 $public_contact_id = intval(Contact::getIdForURL($_SESSION['my_address'], 0, true));
260 } elseif (!empty($_SESSION['visitor_home'])) {
262 $public_contact_id = intval(Contact::getIdForURL($_SESSION['visitor_home'], 0, true));
264 } elseif (empty($_SESSION['authenticated'])) {
265 $public_contact_id = false;
268 return $public_contact_id;
272 * Returns contact id of authenticated site visitor or false
274 * @return int|bool visitor_id or false
276 function remote_user()
278 if (empty($_SESSION['authenticated'])) {
282 if (!empty($_SESSION['visitor_id'])) {
283 return intval($_SESSION['visitor_id']);
290 * Show an error message to user.
292 * This function save text in session, to be shown to the user at next page load
294 * @param string $s - Text of notice
298 if (empty($_SESSION)) {
303 if (empty($_SESSION['sysmsg'])) {
304 $_SESSION['sysmsg'] = [];
306 if ($a->interactive) {
307 $_SESSION['sysmsg'][] = $s;
312 * Show an info message to user.
314 * This function save text in session, to be shown to the user at next page load
316 * @param string $s - Text of notice
322 if (local_user() && DI::pConfig()->get(local_user(), 'system', 'ignore_info')) {
326 if (empty($_SESSION['sysmsg_info'])) {
327 $_SESSION['sysmsg_info'] = [];
329 if ($a->interactive) {
330 $_SESSION['sysmsg_info'][] = $s;
334 function feed_birthday($uid, $tz)
337 * Determine the next birthday, but only if the birthday is published
338 * in the default profile. We _could_ also look for a private profile that the
339 * recipient can see, but somebody could get mad at us if they start getting
340 * public birthday greetings when they haven't made this info public.
342 * Assuming we are able to publish this info, we are then going to convert
343 * the start time from the owner's timezone to UTC.
345 * This will potentially solve the problem found with some social networks
346 * where birthdays are converted to the viewer's timezone and salutations from
347 * elsewhere in the world show up on the wrong day. We will convert it to the
348 * viewer's timezone also, but first we are going to convert it from the birthday
349 * person's timezone to GMT - so the viewer may find the birthday starting at
350 * 6:00PM the day before, but that will correspond to midnight to the birthday person.
358 $profile = DBA::selectFirst('profile', ['dob'], ['is-default' => true, 'uid' => $uid]);
359 if (DBA::isResult($profile)) {
360 $tmp_dob = substr($profile['dob'], 5);
361 if (intval($tmp_dob)) {
362 $y = DateTimeFormat::timezoneNow($tz, 'Y');
363 $bd = $y . '-' . $tmp_dob . ' 00:00';
364 $t_dob = strtotime($bd);
365 $now = strtotime(DateTimeFormat::timezoneNow($tz));
367 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
369 $birthday = DateTimeFormat::convert($bd, 'UTC', $tz, DateTimeFormat::ATOM);
377 * Check if current user has admin role.
379 * @return bool true if user is an admin
381 function is_site_admin()
385 $admin_email = DI::config()->get('config', 'admin_email');
387 $adminlist = explode(',', str_replace(' ', '', $admin_email));
389 return local_user() && $admin_email && in_array($a->user['email'] ?? '', $adminlist);
392 function explode_querystring($query)
394 $arg_st = strpos($query, '?');
395 if ($arg_st !== false) {
396 $base = substr($query, 0, $arg_st);
403 $args = explode('&', substr($query, $arg_st));
404 foreach ($args as $k => $arg) {
405 /// @TODO really compare type-safe here?
410 $args = array_values($args);
415 $args = array_values($args);
425 * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
427 * Taken from http://webcheatsheet.com/php/get_current_page_url.php
429 function curPageURL()
432 if (!empty($_SERVER["HTTPS"]) && ($_SERVER["HTTPS"] == "on")) {
438 if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
439 $pageURL .= $_SERVER["SERVER_NAME"] . ":" . $_SERVER["SERVER_PORT"] . $_SERVER["REQUEST_URI"];
441 $pageURL .= $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"];
446 function get_temppath()
448 $temppath = DI::config()->get("system", "temppath");
450 if (($temppath != "") && System::isDirectoryUsable($temppath)) {
451 // We have a temp path and it is usable
452 return BasePath::getRealPath($temppath);
455 // We don't have a working preconfigured temp path, so we take the system path.
456 $temppath = sys_get_temp_dir();
458 // Check if it is usable
459 if (($temppath != "") && System::isDirectoryUsable($temppath)) {
460 // Always store the real path, not the path through symlinks
461 $temppath = BasePath::getRealPath($temppath);
463 // To avoid any interferences with other systems we create our own directory
464 $new_temppath = $temppath . "/" . DI::baseUrl()->getHostname();
465 if (!is_dir($new_temppath)) {
466 /// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
467 mkdir($new_temppath);
470 if (System::isDirectoryUsable($new_temppath)) {
471 // The new path is usable, we are happy
472 DI::config()->set("system", "temppath", $new_temppath);
473 return $new_temppath;
475 // We can't create a subdirectory, strange.
476 // But the directory seems to work, so we use it but don't store it.
481 // Reaching this point means that the operating system is configured badly.
485 function get_cachefile($file, $writemode = true)
487 $cache = get_itemcachepath();
489 if ((!$cache) || (!is_dir($cache))) {
493 $subfolder = $cache . "/" . substr($file, 0, 2);
495 $cachepath = $subfolder . "/" . $file;
498 if (!is_dir($subfolder)) {
500 chmod($subfolder, 0777);
507 function clear_cache($basepath = "", $path = "")
510 $basepath = get_itemcachepath();
514 if (($path == "") || (!is_dir($path))) {
518 if (substr(realpath($path), 0, strlen($basepath)) != $basepath) {
522 $cachetime = (int) DI::config()->get('system', 'itemcache_duration');
523 if ($cachetime == 0) {
527 if (is_writable($path)) {
528 if ($dh = opendir($path)) {
529 while (($file = readdir($dh)) !== false) {
530 $fullpath = $path . "/" . $file;
531 if ((filetype($fullpath) == "dir") && ($file != ".") && ($file != "..")) {
532 clear_cache($basepath, $fullpath);
534 if ((filetype($fullpath) == "file") && (filectime($fullpath) < (time() - $cachetime))) {
543 function get_itemcachepath()
545 // Checking, if the cache is deactivated
546 $cachetime = (int) DI::config()->get('system', 'itemcache_duration');
547 if ($cachetime < 0) {
551 $itemcache = DI::config()->get('system', 'itemcache');
552 if (($itemcache != "") && System::isDirectoryUsable($itemcache)) {
553 return BasePath::getRealPath($itemcache);
556 $temppath = get_temppath();
558 if ($temppath != "") {
559 $itemcache = $temppath . "/itemcache";
560 if (!file_exists($itemcache) && !is_dir($itemcache)) {
564 if (System::isDirectoryUsable($itemcache)) {
565 DI::config()->set("system", "itemcache", $itemcache);
573 * Returns the path where spool files are stored
575 * @return string Spool path
577 function get_spoolpath()
579 $spoolpath = DI::config()->get('system', 'spoolpath');
580 if (($spoolpath != "") && System::isDirectoryUsable($spoolpath)) {
581 // We have a spool path and it is usable
585 // We don't have a working preconfigured spool path, so we take the temp path.
586 $temppath = get_temppath();
588 if ($temppath != "") {
589 // To avoid any interferences with other systems we create our own directory
590 $spoolpath = $temppath . "/spool";
591 if (!is_dir($spoolpath)) {
595 if (System::isDirectoryUsable($spoolpath)) {
596 // The new path is usable, we are happy
597 DI::config()->set("system", "spoolpath", $spoolpath);
600 // We can't create a subdirectory, strange.
601 // But the directory seems to work, so we use it but don't store it.
606 // Reaching this point means that the operating system is configured badly.
610 if (!function_exists('exif_imagetype')) {
611 function exif_imagetype($file)
613 $size = getimagesize($file);
618 function validate_include(&$file)
622 $file = realpath($file);
624 if (strpos($file, getcwd()) !== 0) {
628 $file = str_replace(getcwd() . "/", "", $file, $count);
633 if ($orig_file !== $file) {
638 if (strpos($file, "include/") === 0) {
642 if (strpos($file, "addon/") === 0) {
646 // Simply return flag