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\Addon;
23 use Friendica\Core\Cache;
24 use Friendica\Core\Config;
25 use Friendica\Core\L10n;
26 use Friendica\Core\PConfig;
27 use Friendica\Core\Protocol;
28 use Friendica\Core\System;
29 use Friendica\Core\Update;
30 use Friendica\Core\Worker;
31 use Friendica\Database\DBA;
32 use Friendica\Model\Contact;
33 use Friendica\Model\Conversation;
34 use Friendica\Util\DateTimeFormat;
36 define('FRIENDICA_PLATFORM', 'Friendica');
37 define('FRIENDICA_CODENAME', 'The Tazmans Flax-lily');
38 define('FRIENDICA_VERSION', '2019.03-dev');
39 define('DFRN_PROTOCOL_VERSION', '2.23');
40 define('NEW_UPDATE_ROUTINE_VERSION', 1170);
43 * @brief Constant with a HTML line break.
45 * Contains a HTML line break (br) element and a real carriage return with line
46 * feed for the source.
47 * This can be used in HTML and JavaScript where needed a line break.
49 define('EOL', "<br />\r\n");
52 * @brief Image storage quality.
54 * Lower numbers save space at cost of image detail.
55 * For ease of upgrade, please do not change here. Set system.jpegquality = n in config/local.config.php,
56 * where n is between 1 and 100, and with very poor results below about 50
58 define('JPEG_QUALITY', 100);
61 * system.png_quality = n where is between 0 (uncompressed) to 9
63 define('PNG_QUALITY', 8);
66 * An alternate way of limiting picture upload sizes. Specify the maximum pixel
67 * length that pictures are allowed to be (for non-square pictures, it will apply
68 * to the longest side). Pictures longer than this length will be resized to be
69 * this length (on the longest side, the other side will be scaled appropriately).
70 * Modify this value using
73 * 'max_image_length' => 'n',
77 * in config/local.config.php
79 * If you don't want to set a maximum length, set to -1. The default value is
80 * defined by 'MAX_IMAGE_LENGTH' below.
82 define('MAX_IMAGE_LENGTH', -1);
87 define('DEFAULT_DB_ENGINE', 'InnoDB');
92 * SSL redirection policies
95 define('SSL_POLICY_NONE', 0);
96 define('SSL_POLICY_FULL', 1);
97 define('SSL_POLICY_SELFSIGN', 2);
103 * Registration policies
106 define('REGISTER_CLOSED', 0);
107 define('REGISTER_APPROVE', 1);
108 define('REGISTER_OPEN', 2);
116 * Type of the community page
119 define('CP_NO_INTERNAL_COMMUNITY', -2);
120 define('CP_NO_COMMUNITY_PAGE', -1);
121 define('CP_USERS_ON_SERVER', 0);
122 define('CP_GLOBAL_COMMUNITY', 1);
123 define('CP_USERS_AND_GLOBAL', 2);
129 * These numbers are used in stored permissions
130 * and existing allocations MUST NEVER BE CHANGED
131 * OR RE-ASSIGNED! You may only add to them.
134 Protocol::DFRN => (-1),
135 Protocol::ZOT => (-2),
136 Protocol::OSTATUS => (-3),
137 Protocol::FEED => (-4),
138 Protocol::DIASPORA => (-5),
139 Protocol::MAIL => (-6),
140 Protocol::FACEBOOK => (-8),
141 Protocol::LINKEDIN => (-9),
142 Protocol::XMPP => (-10),
143 Protocol::MYSPACE => (-11),
144 Protocol::GPLUS => (-12),
145 Protocol::PUMPIO => (-13),
146 Protocol::TWITTER => (-14),
147 Protocol::DIASPORA2 => (-15),
148 Protocol::STATUSNET => (-16),
149 Protocol::NEWS => (-18),
150 Protocol::ICALENDAR => (-19),
151 Protocol::PNUT => (-20),
153 Protocol::PHANTOM => (-127),
157 * Maximum number of "people who like (or don't like) this" that we will list by name
159 define('MAX_LIKERS', 75);
164 * Email notification options
167 define('NOTIFY_INTRO', 1);
168 define('NOTIFY_CONFIRM', 2);
169 define('NOTIFY_WALL', 4);
170 define('NOTIFY_COMMENT', 8);
171 define('NOTIFY_MAIL', 16);
172 define('NOTIFY_SUGGEST', 32);
173 define('NOTIFY_PROFILE', 64);
174 define('NOTIFY_TAGSELF', 128);
175 define('NOTIFY_TAGSHARE', 256);
176 define('NOTIFY_POKE', 512);
177 define('NOTIFY_SHARE', 1024);
179 define('SYSTEM_EMAIL', 16384);
181 define('NOTIFY_SYSTEM', 32768);
191 define('TERM_UNKNOWN', 0);
192 define('TERM_HASHTAG', 1);
193 define('TERM_MENTION', 2);
194 define('TERM_CATEGORY', 3);
195 define('TERM_PCATEGORY', 4);
196 define('TERM_FILE', 5);
197 define('TERM_SAVEDSEARCH', 6);
198 define('TERM_CONVERSATION', 7);
200 define('TERM_OBJ_POST', 1);
201 define('TERM_OBJ_PHOTO', 2);
206 * Various namespaces we may need to parse
209 define('NAMESPACE_ZOT', 'http://purl.org/zot');
210 define('NAMESPACE_DFRN', 'http://purl.org/macgirvin/dfrn/1.0');
211 define('NAMESPACE_THREAD', 'http://purl.org/syndication/thread/1.0');
212 define('NAMESPACE_TOMB', 'http://purl.org/atompub/tombstones/1.0');
213 define('NAMESPACE_ACTIVITY', 'http://activitystrea.ms/spec/1.0/');
214 define('NAMESPACE_ACTIVITY_SCHEMA', 'http://activitystrea.ms/schema/1.0/');
215 define('NAMESPACE_MEDIA', 'http://purl.org/syndication/atommedia');
216 define('NAMESPACE_SALMON_ME', 'http://salmon-protocol.org/ns/magic-env');
217 define('NAMESPACE_OSTATUSSUB', 'http://ostatus.org/schema/1.0/subscribe');
218 define('NAMESPACE_GEORSS', 'http://www.georss.org/georss');
219 define('NAMESPACE_POCO', 'http://portablecontacts.net/spec/1.0');
220 define('NAMESPACE_FEED', 'http://schemas.google.com/g/2010#updates-from');
221 define('NAMESPACE_OSTATUS', 'http://ostatus.org/schema/1.0');
222 define('NAMESPACE_STATUSNET', 'http://status.net/schema/api/1/');
223 define('NAMESPACE_ATOM1', 'http://www.w3.org/2005/Atom');
224 define('NAMESPACE_MASTODON', 'http://mastodon.social/schema/1.0');
230 * Activity stream defines
233 define('ACTIVITY_LIKE', NAMESPACE_ACTIVITY_SCHEMA . 'like');
234 define('ACTIVITY_DISLIKE', NAMESPACE_DFRN . '/dislike');
235 define('ACTIVITY_ATTEND', NAMESPACE_ZOT . '/activity/attendyes');
236 define('ACTIVITY_ATTENDNO', NAMESPACE_ZOT . '/activity/attendno');
237 define('ACTIVITY_ATTENDMAYBE', NAMESPACE_ZOT . '/activity/attendmaybe');
239 define('ACTIVITY_OBJ_HEART', NAMESPACE_DFRN . '/heart');
241 define('ACTIVITY_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'make-friend');
242 define('ACTIVITY_REQ_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'request-friend');
243 define('ACTIVITY_UNFRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'remove-friend');
244 define('ACTIVITY_FOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'follow');
245 define('ACTIVITY_UNFOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'stop-following');
246 define('ACTIVITY_JOIN', NAMESPACE_ACTIVITY_SCHEMA . 'join');
248 define('ACTIVITY_POST', NAMESPACE_ACTIVITY_SCHEMA . 'post');
249 define('ACTIVITY_UPDATE', NAMESPACE_ACTIVITY_SCHEMA . 'update');
250 define('ACTIVITY_TAG', NAMESPACE_ACTIVITY_SCHEMA . 'tag');
251 define('ACTIVITY_FAVORITE', NAMESPACE_ACTIVITY_SCHEMA . 'favorite');
252 define('ACTIVITY_UNFAVORITE', NAMESPACE_ACTIVITY_SCHEMA . 'unfavorite');
253 define('ACTIVITY_SHARE', NAMESPACE_ACTIVITY_SCHEMA . 'share');
254 define('ACTIVITY_DELETE', NAMESPACE_ACTIVITY_SCHEMA . 'delete');
256 define('ACTIVITY_POKE', NAMESPACE_ZOT . '/activity/poke');
258 define('ACTIVITY_OBJ_BOOKMARK', NAMESPACE_ACTIVITY_SCHEMA . 'bookmark');
259 define('ACTIVITY_OBJ_COMMENT', NAMESPACE_ACTIVITY_SCHEMA . 'comment');
260 define('ACTIVITY_OBJ_NOTE', NAMESPACE_ACTIVITY_SCHEMA . 'note');
261 define('ACTIVITY_OBJ_PERSON', NAMESPACE_ACTIVITY_SCHEMA . 'person');
262 define('ACTIVITY_OBJ_IMAGE', NAMESPACE_ACTIVITY_SCHEMA . 'image');
263 define('ACTIVITY_OBJ_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'photo');
264 define('ACTIVITY_OBJ_VIDEO', NAMESPACE_ACTIVITY_SCHEMA . 'video');
265 define('ACTIVITY_OBJ_P_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'profile-photo');
266 define('ACTIVITY_OBJ_ALBUM', NAMESPACE_ACTIVITY_SCHEMA . 'photo-album');
267 define('ACTIVITY_OBJ_EVENT', NAMESPACE_ACTIVITY_SCHEMA . 'event');
268 define('ACTIVITY_OBJ_GROUP', NAMESPACE_ACTIVITY_SCHEMA . 'group');
269 define('ACTIVITY_OBJ_TAGTERM', NAMESPACE_DFRN . '/tagterm');
270 define('ACTIVITY_OBJ_PROFILE', NAMESPACE_DFRN . '/profile');
271 define('ACTIVITY_OBJ_QUESTION', 'http://activityschema.org/object/question');
277 * Item weight for query ordering
280 define('GRAVITY_PARENT', 0);
281 define('GRAVITY_ACTIVITY', 3);
282 define('GRAVITY_COMMENT', 6);
283 define('GRAVITY_UNKNOWN', 9);
289 * Process priority for the worker
292 define('PRIORITY_UNDEFINED', 0);
293 define('PRIORITY_CRITICAL', 10);
294 define('PRIORITY_HIGH', 20);
295 define('PRIORITY_MEDIUM', 30);
296 define('PRIORITY_LOW', 40);
297 define('PRIORITY_NEGLIGIBLE', 50);
301 * @name Social Relay settings
303 * See here: https://github.com/jaywink/social-relay
304 * and here: https://wiki.diasporafoundation.org/Relay_servers_for_public_posts
307 define('SR_SCOPE_NONE', '');
308 define('SR_SCOPE_ALL', 'all');
309 define('SR_SCOPE_TAGS', 'tags');
312 // Normally this constant is defined - but not if "pcntl" isn't installed
313 if (!defined("SIGTERM")) {
314 define("SIGTERM", 15);
318 * Depending on the PHP version this constant does exist - or not.
319 * See here: http://php.net/manual/en/curl.constants.php#117928
321 if (!defined('CURLE_OPERATION_TIMEDOUT')) {
322 define('CURLE_OPERATION_TIMEDOUT', CURLE_OPERATION_TIMEOUTED);
326 * @brief Retrieve the App structure
328 * Useful in functions which require it but don't get it passed to them
330 * @deprecated since version 2018.09
331 * @see BaseObject::getApp()
336 return BaseObject::getApp();
340 * Return the provided variable value if it exists and is truthy or the provided
341 * default value instead.
343 * Works with initialized variables and potentially uninitialized array keys
346 * - defaults($var, $default)
347 * - defaults($array, 'key', $default)
350 * @brief Returns a defaut value if the provided variable or array key is falsy
353 function defaults(...$args)
355 if (count($args) < 2) {
356 throw new BadFunctionCallException('defaults() requires at least 2 parameters');
358 if (count($args) > 3) {
359 throw new BadFunctionCallException('defaults() cannot use more than 3 parameters');
361 if (count($args) === 3 && is_null($args[1])) {
362 throw new BadFunctionCallException('defaults($arr, $key, $def) $key is null');
365 // The default value always is the last argument
366 $return = array_pop($args);
368 if (count($args) == 2 && is_array($args[0]) && !empty($args[0][$args[1]])) {
369 $return = $args[0][$args[1]];
372 if (count($args) == 1 && !empty($args[0])) {
380 * @brief Used to end the current process, after saving session state.
389 * @brief Returns the user id of locally logged in user or false.
391 * @return int|bool user id or false
393 function local_user()
395 if (!empty($_SESSION['authenticated']) && !empty($_SESSION['uid'])) {
396 return intval($_SESSION['uid']);
402 * @brief Returns the public contact id of logged in user or false.
404 * @return int|bool public contact id or false
406 function public_contact()
408 static $public_contact_id = false;
410 if (!$public_contact_id && !empty($_SESSION['authenticated'])) {
411 if (!empty($_SESSION['my_address'])) {
413 $public_contact_id = intval(Contact::getIdForURL($_SESSION['my_address'], 0, true));
414 } elseif (!empty($_SESSION['visitor_home'])) {
416 $public_contact_id = intval(Contact::getIdForURL($_SESSION['visitor_home'], 0, true));
418 } elseif (empty($_SESSION['authenticated'])) {
419 $public_contact_id = false;
422 return $public_contact_id;
426 * @brief Returns contact id of authenticated site visitor or false
428 * @return int|bool visitor_id or false
430 function remote_user()
432 // You cannot be both local and remote.
433 // Unncommented by rabuzarus because remote authentication to local
434 // profiles wasn't possible anymore (2018-04-12).
435 // if (local_user()) {
439 if (empty($_SESSION)) {
443 if (!empty($_SESSION['authenticated']) && !empty($_SESSION['visitor_id'])) {
444 return intval($_SESSION['visitor_id']);
450 * @brief Show an error message to user.
452 * This function save text in session, to be shown to the user at next page load
454 * @param string $s - Text of notice
458 if (empty($_SESSION)) {
463 if (empty($_SESSION['sysmsg'])) {
464 $_SESSION['sysmsg'] = [];
466 if ($a->interactive) {
467 $_SESSION['sysmsg'][] = $s;
472 * @brief Show an info message to user.
474 * This function save text in session, to be shown to the user at next page load
476 * @param string $s - Text of notice
482 if (local_user() && PConfig::get(local_user(), 'system', 'ignore_info')) {
486 if (empty($_SESSION['sysmsg_info'])) {
487 $_SESSION['sysmsg_info'] = [];
489 if ($a->interactive) {
490 $_SESSION['sysmsg_info'][] = $s;
494 function feed_birthday($uid, $tz)
497 * Determine the next birthday, but only if the birthday is published
498 * in the default profile. We _could_ also look for a private profile that the
499 * recipient can see, but somebody could get mad at us if they start getting
500 * public birthday greetings when they haven't made this info public.
502 * Assuming we are able to publish this info, we are then going to convert
503 * the start time from the owner's timezone to UTC.
505 * This will potentially solve the problem found with some social networks
506 * where birthdays are converted to the viewer's timezone and salutations from
507 * elsewhere in the world show up on the wrong day. We will convert it to the
508 * viewer's timezone also, but first we are going to convert it from the birthday
509 * person's timezone to GMT - so the viewer may find the birthday starting at
510 * 6:00PM the day before, but that will correspond to midnight to the birthday person.
518 $profile = DBA::selectFirst('profile', ['dob'], ['is-default' => true, 'uid' => $uid]);
519 if (DBA::isResult($profile)) {
520 $tmp_dob = substr($profile['dob'], 5);
521 if (intval($tmp_dob)) {
522 $y = DateTimeFormat::timezoneNow($tz, 'Y');
523 $bd = $y . '-' . $tmp_dob . ' 00:00';
524 $t_dob = strtotime($bd);
525 $now = strtotime(DateTimeFormat::timezoneNow($tz));
527 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
529 $birthday = DateTimeFormat::convert($bd, 'UTC', $tz, DateTimeFormat::ATOM);
537 * @brief Check if current user has admin role.
539 * @return bool true if user is an admin
541 function is_site_admin()
545 $admin_email = Config::get('config', 'admin_email');
547 $adminlist = explode(',', str_replace(' ', '', $admin_email));
549 return local_user() && $admin_email && in_array(defaults($a->user, 'email', ''), $adminlist);
553 * @brief Returns querystring as string from a mapped array.
555 * @param array $params mapped array with query parameters
556 * @param string $name of parameter, default null
560 function build_querystring($params, $name = null)
563 foreach ($params as $key => $val) {
564 if (is_array($val)) {
565 /// @TODO maybe not compare against null, use is_null()
567 $ret .= build_querystring($val, $key);
569 $ret .= build_querystring($val, $name . "[$key]");
572 $val = urlencode($val);
573 /// @TODO maybe not compare against null, use is_null()
575 /// @TODO two string concated, can be merged to one
576 $ret .= $name . "[$key]" . "=$val&";
578 $ret .= "$key=$val&";
585 function explode_querystring($query)
587 $arg_st = strpos($query, '?');
588 if ($arg_st !== false) {
589 $base = substr($query, 0, $arg_st);
596 $args = explode('&', substr($query, $arg_st));
597 foreach ($args as $k => $arg) {
598 /// @TODO really compare type-safe here?
603 $args = array_values($args);
608 $args = array_values($args);
618 * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
620 * Taken from http://webcheatsheet.com/php/get_current_page_url.php
622 function curPageURL()
625 if (!empty($_SERVER["HTTPS"]) && ($_SERVER["HTTPS"] == "on")) {
631 if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
632 $pageURL .= $_SERVER["SERVER_NAME"] . ":" . $_SERVER["SERVER_PORT"] . $_SERVER["REQUEST_URI"];
634 $pageURL .= $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"];
639 function get_server()
641 $server = Config::get("system", "directory");
644 $server = "https://dir.friendica.social";
650 function get_temppath()
654 $temppath = Config::get("system", "temppath");
656 if (($temppath != "") && App::isDirectoryUsable($temppath)) {
657 // We have a temp path and it is usable
658 return App::getRealPath($temppath);
661 // We don't have a working preconfigured temp path, so we take the system path.
662 $temppath = sys_get_temp_dir();
664 // Check if it is usable
665 if (($temppath != "") && App::isDirectoryUsable($temppath)) {
666 // Always store the real path, not the path through symlinks
667 $temppath = App::getRealPath($temppath);
669 // To avoid any interferences with other systems we create our own directory
670 $new_temppath = $temppath . "/" . $a->getHostName();
671 if (!is_dir($new_temppath)) {
672 /// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
673 mkdir($new_temppath);
676 if (App::isDirectoryUsable($new_temppath)) {
677 // The new path is usable, we are happy
678 Config::set("system", "temppath", $new_temppath);
679 return $new_temppath;
681 // We can't create a subdirectory, strange.
682 // But the directory seems to work, so we use it but don't store it.
687 // Reaching this point means that the operating system is configured badly.
691 function get_cachefile($file, $writemode = true)
693 $cache = get_itemcachepath();
695 if ((!$cache) || (!is_dir($cache))) {
699 $subfolder = $cache . "/" . substr($file, 0, 2);
701 $cachepath = $subfolder . "/" . $file;
704 if (!is_dir($subfolder)) {
706 chmod($subfolder, 0777);
713 function clear_cache($basepath = "", $path = "")
716 $basepath = get_itemcachepath();
720 if (($path == "") || (!is_dir($path))) {
724 if (substr(realpath($path), 0, strlen($basepath)) != $basepath) {
728 $cachetime = (int) Config::get('system', 'itemcache_duration');
729 if ($cachetime == 0) {
733 if (is_writable($path)) {
734 if ($dh = opendir($path)) {
735 while (($file = readdir($dh)) !== false) {
736 $fullpath = $path . "/" . $file;
737 if ((filetype($fullpath) == "dir") && ($file != ".") && ($file != "..")) {
738 clear_cache($basepath, $fullpath);
740 if ((filetype($fullpath) == "file") && (filectime($fullpath) < (time() - $cachetime))) {
749 function get_itemcachepath()
751 // Checking, if the cache is deactivated
752 $cachetime = (int) Config::get('system', 'itemcache_duration');
753 if ($cachetime < 0) {
757 $itemcache = Config::get('system', 'itemcache');
758 if (($itemcache != "") && App::isDirectoryUsable($itemcache)) {
759 return App::getRealPath($itemcache);
762 $temppath = get_temppath();
764 if ($temppath != "") {
765 $itemcache = $temppath . "/itemcache";
766 if (!file_exists($itemcache) && !is_dir($itemcache)) {
770 if (App::isDirectoryUsable($itemcache)) {
771 Config::set("system", "itemcache", $itemcache);
779 * @brief Returns the path where spool files are stored
781 * @return string Spool path
783 function get_spoolpath()
785 $spoolpath = Config::get('system', 'spoolpath');
786 if (($spoolpath != "") && App::isDirectoryUsable($spoolpath)) {
787 // We have a spool path and it is usable
791 // We don't have a working preconfigured spool path, so we take the temp path.
792 $temppath = get_temppath();
794 if ($temppath != "") {
795 // To avoid any interferences with other systems we create our own directory
796 $spoolpath = $temppath . "/spool";
797 if (!is_dir($spoolpath)) {
801 if (App::isDirectoryUsable($spoolpath)) {
802 // The new path is usable, we are happy
803 Config::set("system", "spoolpath", $spoolpath);
806 // We can't create a subdirectory, strange.
807 // But the directory seems to work, so we use it but don't store it.
812 // Reaching this point means that the operating system is configured badly.
816 if (!function_exists('exif_imagetype')) {
817 function exif_imagetype($file)
819 $size = getimagesize($file);
824 function validate_include(&$file)
828 $file = realpath($file);
830 if (strpos($file, getcwd()) !== 0) {
834 $file = str_replace(getcwd() . "/", "", $file, $count);
839 if ($orig_file !== $file) {
844 if (strpos($file, "include/") === 0) {
848 if (strpos($file, "addon/") === 0) {
852 // Simply return flag
857 * PHP 5 compatible dirname() with count parameter
859 * @see http://php.net/manual/en/function.dirname.php#113193
861 * @deprecated with PHP 7
862 * @param string $path
866 function rdirname($path, $levels = 1)
869 return dirname(rdirname($path, --$levels));
871 return dirname($path);