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\BaseObject;
22 use Friendica\Core\Config;
23 use Friendica\Core\PConfig;
24 use Friendica\Core\Protocol;
25 use Friendica\Core\System;
26 use Friendica\Core\Session;
27 use Friendica\Database\DBA;
28 use Friendica\Model\Contact;
29 use Friendica\Model\Term;
30 use Friendica\Util\BasePath;
31 use Friendica\Util\DateTimeFormat;
33 define('FRIENDICA_PLATFORM', 'Friendica');
34 define('FRIENDICA_CODENAME', 'Dalmatian Bellflower');
35 define('FRIENDICA_VERSION', '2019.12-dev');
36 define('DFRN_PROTOCOL_VERSION', '2.23');
37 define('NEW_UPDATE_ROUTINE_VERSION', 1170);
40 * @brief Constant with a HTML line break.
42 * Contains a HTML line break (br) element and a real carriage return with line
43 * feed for the source.
44 * This can be used in HTML and JavaScript where needed a line break.
46 define('EOL', "<br />\r\n");
49 * @brief Image storage quality.
51 * Lower numbers save space at cost of image detail.
52 * For ease of upgrade, please do not change here. Set system.jpegquality = n in config/local.config.php,
53 * where n is between 1 and 100, and with very poor results below about 50
55 define('JPEG_QUALITY', 100);
58 * system.png_quality = n where is between 0 (uncompressed) to 9
60 define('PNG_QUALITY', 8);
63 * An alternate way of limiting picture upload sizes. Specify the maximum pixel
64 * length that pictures are allowed to be (for non-square pictures, it will apply
65 * to the longest side). Pictures longer than this length will be resized to be
66 * this length (on the longest side, the other side will be scaled appropriately).
67 * Modify this value using
70 * 'max_image_length' => 'n',
74 * in config/local.config.php
76 * If you don't want to set a maximum length, set to -1. The default value is
77 * defined by 'MAX_IMAGE_LENGTH' below.
79 define('MAX_IMAGE_LENGTH', -1);
84 define('DEFAULT_DB_ENGINE', 'InnoDB');
86 /** @deprecated since version 2019.03, please use \Friendica\Module\Register::CLOSED instead */
87 define('REGISTER_CLOSED', \Friendica\Module\Register::CLOSED);
88 /** @deprecated since version 2019.03, please use \Friendica\Module\Register::APPROVE instead */
89 define('REGISTER_APPROVE', \Friendica\Module\Register::APPROVE);
90 /** @deprecated since version 2019.03, please use \Friendica\Module\Register::OPEN instead */
91 define('REGISTER_OPEN', \Friendica\Module\Register::OPEN);
96 * Type of the community page
99 define('CP_NO_INTERNAL_COMMUNITY', -2);
100 define('CP_NO_COMMUNITY_PAGE', -1);
101 define('CP_USERS_ON_SERVER', 0);
102 define('CP_GLOBAL_COMMUNITY', 1);
103 define('CP_USERS_AND_GLOBAL', 2);
109 * These numbers are used in stored permissions
110 * and existing allocations MUST NEVER BE CHANGED
111 * OR RE-ASSIGNED! You may only add to them.
114 Protocol::DFRN => (-1),
115 Protocol::ZOT => (-2),
116 Protocol::OSTATUS => (-3),
117 Protocol::FEED => (-4),
118 Protocol::DIASPORA => (-5),
119 Protocol::MAIL => (-6),
120 Protocol::FACEBOOK => (-8),
121 Protocol::LINKEDIN => (-9),
122 Protocol::XMPP => (-10),
123 Protocol::MYSPACE => (-11),
124 Protocol::GPLUS => (-12),
125 Protocol::PUMPIO => (-13),
126 Protocol::TWITTER => (-14),
127 Protocol::DIASPORA2 => (-15),
128 Protocol::STATUSNET => (-16),
129 Protocol::NEWS => (-18),
130 Protocol::ICALENDAR => (-19),
131 Protocol::PNUT => (-20),
133 Protocol::PHANTOM => (-127),
137 * Maximum number of "people who like (or don't like) this" that we will list by name
139 define('MAX_LIKERS', 75);
144 * Email notification options
147 define('NOTIFY_INTRO', 1);
148 define('NOTIFY_CONFIRM', 2);
149 define('NOTIFY_WALL', 4);
150 define('NOTIFY_COMMENT', 8);
151 define('NOTIFY_MAIL', 16);
152 define('NOTIFY_SUGGEST', 32);
153 define('NOTIFY_PROFILE', 64);
154 define('NOTIFY_TAGSELF', 128);
155 define('NOTIFY_TAGSHARE', 256);
156 define('NOTIFY_POKE', 512);
157 define('NOTIFY_SHARE', 1024);
159 define('SYSTEM_EMAIL', 16384);
161 define('NOTIFY_SYSTEM', 32768);
165 /** @deprecated since 2019.03, use Term::UNKNOWN instead */
166 define('TERM_UNKNOWN', Term::UNKNOWN);
167 /** @deprecated since 2019.03, use Term::HASHTAG instead */
168 define('TERM_HASHTAG', Term::HASHTAG);
169 /** @deprecated since 2019.03, use Term::MENTION instead */
170 define('TERM_MENTION', Term::MENTION);
171 /** @deprecated since 2019.03, use Term::CATEGORY instead */
172 define('TERM_CATEGORY', Term::CATEGORY);
173 /** @deprecated since 2019.03, use Term::PCATEGORY instead */
174 define('TERM_PCATEGORY', Term::PCATEGORY);
175 /** @deprecated since 2019.03, use Term::FILE instead */
176 define('TERM_FILE', Term::FILE);
177 /** @deprecated since 2019.03, use Term::SAVEDSEARCH instead */
178 define('TERM_SAVEDSEARCH', Term::SAVEDSEARCH);
179 /** @deprecated since 2019.03, use Term::CONVERSATION instead */
180 define('TERM_CONVERSATION', Term::CONVERSATION);
182 /** @deprecated since 2019.03, use Term::OBJECT_TYPE_POST instead */
183 define('TERM_OBJ_POST', Term::OBJECT_TYPE_POST);
184 /** @deprecated since 2019.03, use Term::OBJECT_TYPE_PHOTO instead */
185 define('TERM_OBJ_PHOTO', Term::OBJECT_TYPE_PHOTO);
190 * Various namespaces we may need to parse
193 define('NAMESPACE_ZOT', 'http://purl.org/zot');
194 define('NAMESPACE_DFRN', 'http://purl.org/macgirvin/dfrn/1.0');
195 define('NAMESPACE_THREAD', 'http://purl.org/syndication/thread/1.0');
196 define('NAMESPACE_TOMB', 'http://purl.org/atompub/tombstones/1.0');
197 define('NAMESPACE_ACTIVITY2', 'https://www.w3.org/ns/activitystreams#');
198 define('NAMESPACE_ACTIVITY', 'http://activitystrea.ms/spec/1.0/');
199 define('NAMESPACE_ACTIVITY_SCHEMA', 'http://activitystrea.ms/schema/1.0/');
200 define('NAMESPACE_MEDIA', 'http://purl.org/syndication/atommedia');
201 define('NAMESPACE_SALMON_ME', 'http://salmon-protocol.org/ns/magic-env');
202 define('NAMESPACE_OSTATUSSUB', 'http://ostatus.org/schema/1.0/subscribe');
203 define('NAMESPACE_GEORSS', 'http://www.georss.org/georss');
204 define('NAMESPACE_POCO', 'http://portablecontacts.net/spec/1.0');
205 define('NAMESPACE_FEED', 'http://schemas.google.com/g/2010#updates-from');
206 define('NAMESPACE_OSTATUS', 'http://ostatus.org/schema/1.0');
207 define('NAMESPACE_STATUSNET', 'http://status.net/schema/api/1/');
208 define('NAMESPACE_ATOM1', 'http://www.w3.org/2005/Atom');
209 define('NAMESPACE_MASTODON', 'http://mastodon.social/schema/1.0');
215 * Activity stream defines
218 define('ACTIVITY_LIKE', NAMESPACE_ACTIVITY_SCHEMA . 'like');
219 define('ACTIVITY_DISLIKE', NAMESPACE_DFRN . '/dislike');
220 define('ACTIVITY_ATTEND', NAMESPACE_ZOT . '/activity/attendyes');
221 define('ACTIVITY_ATTENDNO', NAMESPACE_ZOT . '/activity/attendno');
222 define('ACTIVITY_ATTENDMAYBE', NAMESPACE_ZOT . '/activity/attendmaybe');
224 define('ACTIVITY_OBJ_HEART', NAMESPACE_DFRN . '/heart');
226 define('ACTIVITY_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'make-friend');
227 define('ACTIVITY_REQ_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'request-friend');
228 define('ACTIVITY_UNFRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'remove-friend');
229 define('ACTIVITY_FOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'follow');
230 define('ACTIVITY_UNFOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'stop-following');
231 define('ACTIVITY_JOIN', NAMESPACE_ACTIVITY_SCHEMA . 'join');
233 define('ACTIVITY_POST', NAMESPACE_ACTIVITY_SCHEMA . 'post');
234 define('ACTIVITY_UPDATE', NAMESPACE_ACTIVITY_SCHEMA . 'update');
235 define('ACTIVITY_TAG', NAMESPACE_ACTIVITY_SCHEMA . 'tag');
236 define('ACTIVITY_FAVORITE', NAMESPACE_ACTIVITY_SCHEMA . 'favorite');
237 define('ACTIVITY_UNFAVORITE', NAMESPACE_ACTIVITY_SCHEMA . 'unfavorite');
238 define('ACTIVITY_SHARE', NAMESPACE_ACTIVITY_SCHEMA . 'share');
239 define('ACTIVITY_DELETE', NAMESPACE_ACTIVITY_SCHEMA . 'delete');
240 define('ACTIVITY2_ANNOUNCE', NAMESPACE_ACTIVITY2 . 'Announce');
242 define('ACTIVITY_POKE', NAMESPACE_ZOT . '/activity/poke');
244 define('ACTIVITY_OBJ_BOOKMARK', NAMESPACE_ACTIVITY_SCHEMA . 'bookmark');
245 define('ACTIVITY_OBJ_COMMENT', NAMESPACE_ACTIVITY_SCHEMA . 'comment');
246 define('ACTIVITY_OBJ_NOTE', NAMESPACE_ACTIVITY_SCHEMA . 'note');
247 define('ACTIVITY_OBJ_PERSON', NAMESPACE_ACTIVITY_SCHEMA . 'person');
248 define('ACTIVITY_OBJ_IMAGE', NAMESPACE_ACTIVITY_SCHEMA . 'image');
249 define('ACTIVITY_OBJ_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'photo');
250 define('ACTIVITY_OBJ_VIDEO', NAMESPACE_ACTIVITY_SCHEMA . 'video');
251 define('ACTIVITY_OBJ_P_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'profile-photo');
252 define('ACTIVITY_OBJ_ALBUM', NAMESPACE_ACTIVITY_SCHEMA . 'photo-album');
253 define('ACTIVITY_OBJ_EVENT', NAMESPACE_ACTIVITY_SCHEMA . 'event');
254 define('ACTIVITY_OBJ_GROUP', NAMESPACE_ACTIVITY_SCHEMA . 'group');
255 define('ACTIVITY_OBJ_TAGTERM', NAMESPACE_DFRN . '/tagterm');
256 define('ACTIVITY_OBJ_PROFILE', NAMESPACE_DFRN . '/profile');
257 define('ACTIVITY_OBJ_QUESTION', 'http://activityschema.org/object/question');
263 * Item weight for query ordering
266 define('GRAVITY_PARENT', 0);
267 define('GRAVITY_ACTIVITY', 3);
268 define('GRAVITY_COMMENT', 6);
269 define('GRAVITY_UNKNOWN', 9);
275 * Process priority for the worker
278 define('PRIORITY_UNDEFINED', 0);
279 define('PRIORITY_CRITICAL', 10);
280 define('PRIORITY_HIGH', 20);
281 define('PRIORITY_MEDIUM', 30);
282 define('PRIORITY_LOW', 40);
283 define('PRIORITY_NEGLIGIBLE', 50);
287 * @name Social Relay settings
289 * See here: https://github.com/jaywink/social-relay
290 * and here: https://wiki.diasporafoundation.org/Relay_servers_for_public_posts
293 define('SR_SCOPE_NONE', '');
294 define('SR_SCOPE_ALL', 'all');
295 define('SR_SCOPE_TAGS', 'tags');
298 // Normally this constant is defined - but not if "pcntl" isn't installed
299 if (!defined("SIGTERM")) {
300 define("SIGTERM", 15);
304 * Depending on the PHP version this constant does exist - or not.
305 * See here: http://php.net/manual/en/curl.constants.php#117928
307 if (!defined('CURLE_OPERATION_TIMEDOUT')) {
308 define('CURLE_OPERATION_TIMEDOUT', CURLE_OPERATION_TIMEOUTED);
312 * @brief Retrieve the App structure
314 * Useful in functions which require it but don't get it passed to them
316 * @deprecated since version 2018.09
317 * @see BaseObject::getApp()
322 return BaseObject::getApp();
326 * Return the provided variable value if it exists and is truthy or the provided
327 * default value instead.
329 * Works with initialized variables and potentially uninitialized array keys
332 * - defaults($var, $default)
333 * - defaults($array, 'key', $default)
336 * @brief Returns a defaut value if the provided variable or array key is falsy
338 * @deprecated since version 2019.06, use native coalesce operator (??) instead
340 function defaults(...$args)
342 if (count($args) < 2) {
343 throw new BadFunctionCallException('defaults() requires at least 2 parameters');
345 if (count($args) > 3) {
346 throw new BadFunctionCallException('defaults() cannot use more than 3 parameters');
348 if (count($args) === 3 && is_null($args[1])) {
349 throw new BadFunctionCallException('defaults($arr, $key, $def) $key is null');
352 // The default value always is the last argument
353 $return = array_pop($args);
355 if (count($args) == 2 && is_array($args[0]) && !empty($args[0][$args[1]])) {
356 $return = $args[0][$args[1]];
359 if (count($args) == 1 && !empty($args[0])) {
367 * @brief Used to end the current process, after saving session state.
376 * @brief Returns the user id of locally logged in user or false.
378 * @return int|bool user id or false
380 function local_user()
382 if (!empty($_SESSION['authenticated']) && !empty($_SESSION['uid'])) {
383 return intval($_SESSION['uid']);
389 * @brief Returns the public contact id of logged in user or false.
391 * @return int|bool public contact id or false
393 function public_contact()
395 static $public_contact_id = false;
397 if (!$public_contact_id && !empty($_SESSION['authenticated'])) {
398 if (!empty($_SESSION['my_address'])) {
400 $public_contact_id = intval(Contact::getIdForURL($_SESSION['my_address'], 0, true));
401 } elseif (!empty($_SESSION['visitor_home'])) {
403 $public_contact_id = intval(Contact::getIdForURL($_SESSION['visitor_home'], 0, true));
405 } elseif (empty($_SESSION['authenticated'])) {
406 $public_contact_id = false;
409 return $public_contact_id;
413 * @brief Returns contact id of authenticated site visitor or false
415 * @return int|bool visitor_id or false
417 function remote_user()
419 if (empty($_SESSION['authenticated'])) {
423 if (!empty($_SESSION['visitor_id'])) {
424 return intval($_SESSION['visitor_id']);
431 * @brief Show an error message to user.
433 * This function save text in session, to be shown to the user at next page load
435 * @param string $s - Text of notice
439 if (empty($_SESSION)) {
444 if (empty($_SESSION['sysmsg'])) {
445 $_SESSION['sysmsg'] = [];
447 if ($a->interactive) {
448 $_SESSION['sysmsg'][] = $s;
453 * @brief Show an info message to user.
455 * This function save text in session, to be shown to the user at next page load
457 * @param string $s - Text of notice
463 if (local_user() && PConfig::get(local_user(), 'system', 'ignore_info')) {
467 if (empty($_SESSION['sysmsg_info'])) {
468 $_SESSION['sysmsg_info'] = [];
470 if ($a->interactive) {
471 $_SESSION['sysmsg_info'][] = $s;
475 function feed_birthday($uid, $tz)
478 * Determine the next birthday, but only if the birthday is published
479 * in the default profile. We _could_ also look for a private profile that the
480 * recipient can see, but somebody could get mad at us if they start getting
481 * public birthday greetings when they haven't made this info public.
483 * Assuming we are able to publish this info, we are then going to convert
484 * the start time from the owner's timezone to UTC.
486 * This will potentially solve the problem found with some social networks
487 * where birthdays are converted to the viewer's timezone and salutations from
488 * elsewhere in the world show up on the wrong day. We will convert it to the
489 * viewer's timezone also, but first we are going to convert it from the birthday
490 * person's timezone to GMT - so the viewer may find the birthday starting at
491 * 6:00PM the day before, but that will correspond to midnight to the birthday person.
499 $profile = DBA::selectFirst('profile', ['dob'], ['is-default' => true, 'uid' => $uid]);
500 if (DBA::isResult($profile)) {
501 $tmp_dob = substr($profile['dob'], 5);
502 if (intval($tmp_dob)) {
503 $y = DateTimeFormat::timezoneNow($tz, 'Y');
504 $bd = $y . '-' . $tmp_dob . ' 00:00';
505 $t_dob = strtotime($bd);
506 $now = strtotime(DateTimeFormat::timezoneNow($tz));
508 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
510 $birthday = DateTimeFormat::convert($bd, 'UTC', $tz, DateTimeFormat::ATOM);
518 * @brief Check if current user has admin role.
520 * @return bool true if user is an admin
522 function is_site_admin()
526 $admin_email = Config::get('config', 'admin_email');
528 $adminlist = explode(',', str_replace(' ', '', $admin_email));
530 return local_user() && $admin_email && in_array($a->user['email'] ?? '', $adminlist);
533 function explode_querystring($query)
535 $arg_st = strpos($query, '?');
536 if ($arg_st !== false) {
537 $base = substr($query, 0, $arg_st);
544 $args = explode('&', substr($query, $arg_st));
545 foreach ($args as $k => $arg) {
546 /// @TODO really compare type-safe here?
551 $args = array_values($args);
556 $args = array_values($args);
566 * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
568 * Taken from http://webcheatsheet.com/php/get_current_page_url.php
570 function curPageURL()
573 if (!empty($_SERVER["HTTPS"]) && ($_SERVER["HTTPS"] == "on")) {
579 if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
580 $pageURL .= $_SERVER["SERVER_NAME"] . ":" . $_SERVER["SERVER_PORT"] . $_SERVER["REQUEST_URI"];
582 $pageURL .= $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"];
587 function get_server()
589 $server = Config::get("system", "directory");
592 $server = "https://dir.friendica.social";
598 function get_temppath()
602 $temppath = Config::get("system", "temppath");
604 if (($temppath != "") && System::isDirectoryUsable($temppath)) {
605 // We have a temp path and it is usable
606 return BasePath::getRealPath($temppath);
609 // We don't have a working preconfigured temp path, so we take the system path.
610 $temppath = sys_get_temp_dir();
612 // Check if it is usable
613 if (($temppath != "") && System::isDirectoryUsable($temppath)) {
614 // Always store the real path, not the path through symlinks
615 $temppath = BasePath::getRealPath($temppath);
617 // To avoid any interferences with other systems we create our own directory
618 $new_temppath = $temppath . "/" . $a->getHostName();
619 if (!is_dir($new_temppath)) {
620 /// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
621 mkdir($new_temppath);
624 if (System::isDirectoryUsable($new_temppath)) {
625 // The new path is usable, we are happy
626 Config::set("system", "temppath", $new_temppath);
627 return $new_temppath;
629 // We can't create a subdirectory, strange.
630 // But the directory seems to work, so we use it but don't store it.
635 // Reaching this point means that the operating system is configured badly.
639 function get_cachefile($file, $writemode = true)
641 $cache = get_itemcachepath();
643 if ((!$cache) || (!is_dir($cache))) {
647 $subfolder = $cache . "/" . substr($file, 0, 2);
649 $cachepath = $subfolder . "/" . $file;
652 if (!is_dir($subfolder)) {
654 chmod($subfolder, 0777);
661 function clear_cache($basepath = "", $path = "")
664 $basepath = get_itemcachepath();
668 if (($path == "") || (!is_dir($path))) {
672 if (substr(realpath($path), 0, strlen($basepath)) != $basepath) {
676 $cachetime = (int) Config::get('system', 'itemcache_duration');
677 if ($cachetime == 0) {
681 if (is_writable($path)) {
682 if ($dh = opendir($path)) {
683 while (($file = readdir($dh)) !== false) {
684 $fullpath = $path . "/" . $file;
685 if ((filetype($fullpath) == "dir") && ($file != ".") && ($file != "..")) {
686 clear_cache($basepath, $fullpath);
688 if ((filetype($fullpath) == "file") && (filectime($fullpath) < (time() - $cachetime))) {
697 function get_itemcachepath()
699 // Checking, if the cache is deactivated
700 $cachetime = (int) Config::get('system', 'itemcache_duration');
701 if ($cachetime < 0) {
705 $itemcache = Config::get('system', 'itemcache');
706 if (($itemcache != "") && System::isDirectoryUsable($itemcache)) {
707 return BasePath::getRealPath($itemcache);
710 $temppath = get_temppath();
712 if ($temppath != "") {
713 $itemcache = $temppath . "/itemcache";
714 if (!file_exists($itemcache) && !is_dir($itemcache)) {
718 if (System::isDirectoryUsable($itemcache)) {
719 Config::set("system", "itemcache", $itemcache);
727 * @brief Returns the path where spool files are stored
729 * @return string Spool path
731 function get_spoolpath()
733 $spoolpath = Config::get('system', 'spoolpath');
734 if (($spoolpath != "") && System::isDirectoryUsable($spoolpath)) {
735 // We have a spool path and it is usable
739 // We don't have a working preconfigured spool path, so we take the temp path.
740 $temppath = get_temppath();
742 if ($temppath != "") {
743 // To avoid any interferences with other systems we create our own directory
744 $spoolpath = $temppath . "/spool";
745 if (!is_dir($spoolpath)) {
749 if (System::isDirectoryUsable($spoolpath)) {
750 // The new path is usable, we are happy
751 Config::set("system", "spoolpath", $spoolpath);
754 // We can't create a subdirectory, strange.
755 // But the directory seems to work, so we use it but don't store it.
760 // Reaching this point means that the operating system is configured badly.
764 if (!function_exists('exif_imagetype')) {
765 function exif_imagetype($file)
767 $size = getimagesize($file);
772 function validate_include(&$file)
776 $file = realpath($file);
778 if (strpos($file, getcwd()) !== 0) {
782 $file = str_replace(getcwd() . "/", "", $file, $count);
787 if ($orig_file !== $file) {
792 if (strpos($file, "include/") === 0) {
796 if (strpos($file, "addon/") === 0) {
800 // Simply return flag
805 * PHP 5 compatible dirname() with count parameter
807 * @see http://php.net/manual/en/function.dirname.php#113193
809 * @deprecated with PHP 7
810 * @param string $path
814 function rdirname($path, $levels = 1)
817 return dirname(rdirname($path, --$levels));
819 return dirname($path);