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.
21 use Friendica\Core\Config;
22 use Friendica\Core\PConfig;
23 use Friendica\Core\Protocol;
24 use Friendica\Core\System;
25 use Friendica\Database\DBA;
27 use Friendica\Model\Contact;
28 use Friendica\Model\Term;
29 use Friendica\Util\BasePath;
30 use Friendica\Util\DateTimeFormat;
32 define('FRIENDICA_PLATFORM', 'Friendica');
33 define('FRIENDICA_CODENAME', 'Dalmatian Bellflower');
34 define('FRIENDICA_VERSION', '2020.03-dev');
35 define('DFRN_PROTOCOL_VERSION', '2.23');
36 define('NEW_UPDATE_ROUTINE_VERSION', 1170);
39 * @brief Constant with a HTML line break.
41 * Contains a HTML line break (br) element and a real carriage return with line
42 * feed for the source.
43 * This can be used in HTML and JavaScript where needed a line break.
45 define('EOL', "<br />\r\n");
48 * @brief Image storage quality.
50 * Lower numbers save space at cost of image detail.
51 * For ease of upgrade, please do not change here. Set system.jpegquality = n in config/local.config.php,
52 * where n is between 1 and 100, and with very poor results below about 50
54 define('JPEG_QUALITY', 100);
57 * system.png_quality = n where is between 0 (uncompressed) to 9
59 define('PNG_QUALITY', 8);
62 * An alternate way of limiting picture upload sizes. Specify the maximum pixel
63 * length that pictures are allowed to be (for non-square pictures, it will apply
64 * to the longest side). Pictures longer than this length will be resized to be
65 * this length (on the longest side, the other side will be scaled appropriately).
66 * Modify this value using
69 * 'max_image_length' => 'n',
73 * in config/local.config.php
75 * If you don't want to set a maximum length, set to -1. The default value is
76 * defined by 'MAX_IMAGE_LENGTH' below.
78 define('MAX_IMAGE_LENGTH', -1);
83 define('DEFAULT_DB_ENGINE', 'InnoDB');
85 /** @deprecated since version 2019.03, please use \Friendica\Module\Register::CLOSED instead */
86 define('REGISTER_CLOSED', \Friendica\Module\Register::CLOSED);
87 /** @deprecated since version 2019.03, please use \Friendica\Module\Register::APPROVE instead */
88 define('REGISTER_APPROVE', \Friendica\Module\Register::APPROVE);
89 /** @deprecated since version 2019.03, please use \Friendica\Module\Register::OPEN instead */
90 define('REGISTER_OPEN', \Friendica\Module\Register::OPEN);
95 * Type of the community page
98 define('CP_NO_INTERNAL_COMMUNITY', -2);
99 define('CP_NO_COMMUNITY_PAGE', -1);
100 define('CP_USERS_ON_SERVER', 0);
101 define('CP_GLOBAL_COMMUNITY', 1);
102 define('CP_USERS_AND_GLOBAL', 2);
108 * These numbers are used in stored permissions
109 * and existing allocations MUST NEVER BE CHANGED
110 * OR RE-ASSIGNED! You may only add to them.
113 Protocol::DFRN => (-1),
114 Protocol::ZOT => (-2),
115 Protocol::OSTATUS => (-3),
116 Protocol::FEED => (-4),
117 Protocol::DIASPORA => (-5),
118 Protocol::MAIL => (-6),
119 Protocol::FACEBOOK => (-8),
120 Protocol::LINKEDIN => (-9),
121 Protocol::XMPP => (-10),
122 Protocol::MYSPACE => (-11),
123 Protocol::GPLUS => (-12),
124 Protocol::PUMPIO => (-13),
125 Protocol::TWITTER => (-14),
126 Protocol::DIASPORA2 => (-15),
127 Protocol::STATUSNET => (-16),
128 Protocol::NEWS => (-18),
129 Protocol::ICALENDAR => (-19),
130 Protocol::PNUT => (-20),
132 Protocol::PHANTOM => (-127),
136 * Maximum number of "people who like (or don't like) this" that we will list by name
138 define('MAX_LIKERS', 75);
143 * Email notification options
146 define('NOTIFY_INTRO', 1);
147 define('NOTIFY_CONFIRM', 2);
148 define('NOTIFY_WALL', 4);
149 define('NOTIFY_COMMENT', 8);
150 define('NOTIFY_MAIL', 16);
151 define('NOTIFY_SUGGEST', 32);
152 define('NOTIFY_PROFILE', 64);
153 define('NOTIFY_TAGSELF', 128);
154 define('NOTIFY_TAGSHARE', 256);
155 define('NOTIFY_POKE', 512);
156 define('NOTIFY_SHARE', 1024);
158 define('SYSTEM_EMAIL', 16384);
160 define('NOTIFY_SYSTEM', 32768);
164 /** @deprecated since 2019.03, use Term::UNKNOWN instead */
165 define('TERM_UNKNOWN', Term::UNKNOWN);
166 /** @deprecated since 2019.03, use Term::HASHTAG instead */
167 define('TERM_HASHTAG', Term::HASHTAG);
168 /** @deprecated since 2019.03, use Term::MENTION instead */
169 define('TERM_MENTION', Term::MENTION);
170 /** @deprecated since 2019.03, use Term::CATEGORY instead */
171 define('TERM_CATEGORY', Term::CATEGORY);
172 /** @deprecated since 2019.03, use Term::PCATEGORY instead */
173 define('TERM_PCATEGORY', Term::PCATEGORY);
174 /** @deprecated since 2019.03, use Term::FILE instead */
175 define('TERM_FILE', Term::FILE);
176 /** @deprecated since 2019.03, use Term::SAVEDSEARCH instead */
177 define('TERM_SAVEDSEARCH', Term::SAVEDSEARCH);
178 /** @deprecated since 2019.03, use Term::CONVERSATION instead */
179 define('TERM_CONVERSATION', Term::CONVERSATION);
181 /** @deprecated since 2019.03, use Term::OBJECT_TYPE_POST instead */
182 define('TERM_OBJ_POST', Term::OBJECT_TYPE_POST);
183 /** @deprecated since 2019.03, use Term::OBJECT_TYPE_PHOTO instead */
184 define('TERM_OBJ_PHOTO', Term::OBJECT_TYPE_PHOTO);
189 * Item weight for query ordering
192 define('GRAVITY_PARENT', 0);
193 define('GRAVITY_ACTIVITY', 3);
194 define('GRAVITY_COMMENT', 6);
195 define('GRAVITY_UNKNOWN', 9);
201 * Process priority for the worker
204 define('PRIORITY_UNDEFINED', 0);
205 define('PRIORITY_CRITICAL', 10);
206 define('PRIORITY_HIGH', 20);
207 define('PRIORITY_MEDIUM', 30);
208 define('PRIORITY_LOW', 40);
209 define('PRIORITY_NEGLIGIBLE', 50);
213 * @name Social Relay settings
215 * See here: https://github.com/jaywink/social-relay
216 * and here: https://wiki.diasporafoundation.org/Relay_servers_for_public_posts
219 define('SR_SCOPE_NONE', '');
220 define('SR_SCOPE_ALL', 'all');
221 define('SR_SCOPE_TAGS', 'tags');
224 // Normally this constant is defined - but not if "pcntl" isn't installed
225 if (!defined("SIGTERM")) {
226 define("SIGTERM", 15);
230 * Depending on the PHP version this constant does exist - or not.
231 * See here: http://php.net/manual/en/curl.constants.php#117928
233 if (!defined('CURLE_OPERATION_TIMEDOUT')) {
234 define('CURLE_OPERATION_TIMEDOUT', CURLE_OPERATION_TIMEOUTED);
238 * @brief Used to end the current process, after saving session state.
247 * @brief Returns the user id of locally logged in user or false.
249 * @return int|bool user id or false
251 function local_user()
253 if (!empty($_SESSION['authenticated']) && !empty($_SESSION['uid'])) {
254 return intval($_SESSION['uid']);
260 * @brief Returns the public contact id of logged in user or false.
262 * @return int|bool public contact id or false
264 function public_contact()
266 static $public_contact_id = false;
268 if (!$public_contact_id && !empty($_SESSION['authenticated'])) {
269 if (!empty($_SESSION['my_address'])) {
271 $public_contact_id = intval(Contact::getIdForURL($_SESSION['my_address'], 0, true));
272 } elseif (!empty($_SESSION['visitor_home'])) {
274 $public_contact_id = intval(Contact::getIdForURL($_SESSION['visitor_home'], 0, true));
276 } elseif (empty($_SESSION['authenticated'])) {
277 $public_contact_id = false;
280 return $public_contact_id;
284 * @brief Returns contact id of authenticated site visitor or false
286 * @return int|bool visitor_id or false
288 function remote_user()
290 if (empty($_SESSION['authenticated'])) {
294 if (!empty($_SESSION['visitor_id'])) {
295 return intval($_SESSION['visitor_id']);
302 * @brief Show an error message to user.
304 * This function save text in session, to be shown to the user at next page load
306 * @param string $s - Text of notice
310 if (empty($_SESSION)) {
315 if (empty($_SESSION['sysmsg'])) {
316 $_SESSION['sysmsg'] = [];
318 if ($a->interactive) {
319 $_SESSION['sysmsg'][] = $s;
324 * @brief Show an info message to user.
326 * This function save text in session, to be shown to the user at next page load
328 * @param string $s - Text of notice
334 if (local_user() && PConfig::get(local_user(), 'system', 'ignore_info')) {
338 if (empty($_SESSION['sysmsg_info'])) {
339 $_SESSION['sysmsg_info'] = [];
341 if ($a->interactive) {
342 $_SESSION['sysmsg_info'][] = $s;
346 function feed_birthday($uid, $tz)
349 * Determine the next birthday, but only if the birthday is published
350 * in the default profile. We _could_ also look for a private profile that the
351 * recipient can see, but somebody could get mad at us if they start getting
352 * public birthday greetings when they haven't made this info public.
354 * Assuming we are able to publish this info, we are then going to convert
355 * the start time from the owner's timezone to UTC.
357 * This will potentially solve the problem found with some social networks
358 * where birthdays are converted to the viewer's timezone and salutations from
359 * elsewhere in the world show up on the wrong day. We will convert it to the
360 * viewer's timezone also, but first we are going to convert it from the birthday
361 * person's timezone to GMT - so the viewer may find the birthday starting at
362 * 6:00PM the day before, but that will correspond to midnight to the birthday person.
370 $profile = DBA::selectFirst('profile', ['dob'], ['is-default' => true, 'uid' => $uid]);
371 if (DBA::isResult($profile)) {
372 $tmp_dob = substr($profile['dob'], 5);
373 if (intval($tmp_dob)) {
374 $y = DateTimeFormat::timezoneNow($tz, 'Y');
375 $bd = $y . '-' . $tmp_dob . ' 00:00';
376 $t_dob = strtotime($bd);
377 $now = strtotime(DateTimeFormat::timezoneNow($tz));
379 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
381 $birthday = DateTimeFormat::convert($bd, 'UTC', $tz, DateTimeFormat::ATOM);
389 * @brief Check if current user has admin role.
391 * @return bool true if user is an admin
393 function is_site_admin()
397 $admin_email = Config::get('config', 'admin_email');
399 $adminlist = explode(',', str_replace(' ', '', $admin_email));
401 return local_user() && $admin_email && in_array($a->user['email'] ?? '', $adminlist);
404 function explode_querystring($query)
406 $arg_st = strpos($query, '?');
407 if ($arg_st !== false) {
408 $base = substr($query, 0, $arg_st);
415 $args = explode('&', substr($query, $arg_st));
416 foreach ($args as $k => $arg) {
417 /// @TODO really compare type-safe here?
422 $args = array_values($args);
427 $args = array_values($args);
437 * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
439 * Taken from http://webcheatsheet.com/php/get_current_page_url.php
441 function curPageURL()
444 if (!empty($_SERVER["HTTPS"]) && ($_SERVER["HTTPS"] == "on")) {
450 if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
451 $pageURL .= $_SERVER["SERVER_NAME"] . ":" . $_SERVER["SERVER_PORT"] . $_SERVER["REQUEST_URI"];
453 $pageURL .= $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"];
458 function get_server()
460 $server = Config::get("system", "directory");
463 $server = "https://dir.friendica.social";
469 function get_temppath()
471 $temppath = Config::get("system", "temppath");
473 if (($temppath != "") && System::isDirectoryUsable($temppath)) {
474 // We have a temp path and it is usable
475 return BasePath::getRealPath($temppath);
478 // We don't have a working preconfigured temp path, so we take the system path.
479 $temppath = sys_get_temp_dir();
481 // Check if it is usable
482 if (($temppath != "") && System::isDirectoryUsable($temppath)) {
483 // Always store the real path, not the path through symlinks
484 $temppath = BasePath::getRealPath($temppath);
486 // To avoid any interferences with other systems we create our own directory
487 $new_temppath = $temppath . "/" . DI::baseUrl()->getHostname();
488 if (!is_dir($new_temppath)) {
489 /// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
490 mkdir($new_temppath);
493 if (System::isDirectoryUsable($new_temppath)) {
494 // The new path is usable, we are happy
495 Config::set("system", "temppath", $new_temppath);
496 return $new_temppath;
498 // We can't create a subdirectory, strange.
499 // But the directory seems to work, so we use it but don't store it.
504 // Reaching this point means that the operating system is configured badly.
508 function get_cachefile($file, $writemode = true)
510 $cache = get_itemcachepath();
512 if ((!$cache) || (!is_dir($cache))) {
516 $subfolder = $cache . "/" . substr($file, 0, 2);
518 $cachepath = $subfolder . "/" . $file;
521 if (!is_dir($subfolder)) {
523 chmod($subfolder, 0777);
530 function clear_cache($basepath = "", $path = "")
533 $basepath = get_itemcachepath();
537 if (($path == "") || (!is_dir($path))) {
541 if (substr(realpath($path), 0, strlen($basepath)) != $basepath) {
545 $cachetime = (int) Config::get('system', 'itemcache_duration');
546 if ($cachetime == 0) {
550 if (is_writable($path)) {
551 if ($dh = opendir($path)) {
552 while (($file = readdir($dh)) !== false) {
553 $fullpath = $path . "/" . $file;
554 if ((filetype($fullpath) == "dir") && ($file != ".") && ($file != "..")) {
555 clear_cache($basepath, $fullpath);
557 if ((filetype($fullpath) == "file") && (filectime($fullpath) < (time() - $cachetime))) {
566 function get_itemcachepath()
568 // Checking, if the cache is deactivated
569 $cachetime = (int) Config::get('system', 'itemcache_duration');
570 if ($cachetime < 0) {
574 $itemcache = Config::get('system', 'itemcache');
575 if (($itemcache != "") && System::isDirectoryUsable($itemcache)) {
576 return BasePath::getRealPath($itemcache);
579 $temppath = get_temppath();
581 if ($temppath != "") {
582 $itemcache = $temppath . "/itemcache";
583 if (!file_exists($itemcache) && !is_dir($itemcache)) {
587 if (System::isDirectoryUsable($itemcache)) {
588 Config::set("system", "itemcache", $itemcache);
596 * @brief Returns the path where spool files are stored
598 * @return string Spool path
600 function get_spoolpath()
602 $spoolpath = Config::get('system', 'spoolpath');
603 if (($spoolpath != "") && System::isDirectoryUsable($spoolpath)) {
604 // We have a spool path and it is usable
608 // We don't have a working preconfigured spool path, so we take the temp path.
609 $temppath = get_temppath();
611 if ($temppath != "") {
612 // To avoid any interferences with other systems we create our own directory
613 $spoolpath = $temppath . "/spool";
614 if (!is_dir($spoolpath)) {
618 if (System::isDirectoryUsable($spoolpath)) {
619 // The new path is usable, we are happy
620 Config::set("system", "spoolpath", $spoolpath);
623 // We can't create a subdirectory, strange.
624 // But the directory seems to work, so we use it but don't store it.
629 // Reaching this point means that the operating system is configured badly.
633 if (!function_exists('exif_imagetype')) {
634 function exif_imagetype($file)
636 $size = getimagesize($file);
641 function validate_include(&$file)
645 $file = realpath($file);
647 if (strpos($file, getcwd()) !== 0) {
651 $file = str_replace(getcwd() . "/", "", $file, $count);
656 if ($orig_file !== $file) {
661 if (strpos($file, "include/") === 0) {
665 if (strpos($file, "addon/") === 0) {
669 // Simply return flag
674 * PHP 5 compatible dirname() with count parameter
676 * @see http://php.net/manual/en/function.dirname.php#113193
678 * @deprecated with PHP 7
679 * @param string $path
683 function rdirname($path, $levels = 1)
686 return dirname(rdirname($path, --$levels));
688 return dirname($path);