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 require_once __DIR__ . DIRECTORY_SEPARATOR . 'vendor' . DIRECTORY_SEPARATOR . 'autoload.php';
23 use Friendica\BaseObject;
24 use Friendica\Core\Addon;
25 use Friendica\Core\Cache;
26 use Friendica\Core\Config;
27 use Friendica\Core\L10n;
28 use Friendica\Core\PConfig;
29 use Friendica\Core\Protocol;
30 use Friendica\Core\System;
31 use Friendica\Core\Update;
32 use Friendica\Core\Worker;
33 use Friendica\Database\DBA;
34 use Friendica\Model\Contact;
35 use Friendica\Model\Conversation;
36 use Friendica\Util\DateTimeFormat;
38 require_once 'include/text.php';
40 define('FRIENDICA_PLATFORM', 'Friendica');
41 define('FRIENDICA_CODENAME', 'The Tazmans Flax-lily');
42 define('FRIENDICA_VERSION', '2018.12-dev');
43 define('DFRN_PROTOCOL_VERSION', '2.23');
44 define('NEW_UPDATE_ROUTINE_VERSION', 1170);
47 * @brief Constant with a HTML line break.
49 * Contains a HTML line break (br) element and a real carriage return with line
50 * feed for the source.
51 * This can be used in HTML and JavaScript where needed a line break.
53 define('EOL', "<br />\r\n");
56 * @brief Image storage quality.
58 * Lower numbers save space at cost of image detail.
59 * For ease of upgrade, please do not change here. Set system.jpegquality = n in config/local.config.php,
60 * where n is between 1 and 100, and with very poor results below about 50
62 define('JPEG_QUALITY', 100);
65 * system.png_quality = n where is between 0 (uncompressed) to 9
67 define('PNG_QUALITY', 8);
70 * An alternate way of limiting picture upload sizes. Specify the maximum pixel
71 * length that pictures are allowed to be (for non-square pictures, it will apply
72 * to the longest side). Pictures longer than this length will be resized to be
73 * this length (on the longest side, the other side will be scaled appropriately).
74 * Modify this value using
77 * 'max_image_length' => 'n',
81 * in config/local.config.php
83 * If you don't want to set a maximum length, set to -1. The default value is
84 * defined by 'MAX_IMAGE_LENGTH' below.
86 define('MAX_IMAGE_LENGTH', -1);
91 define('DEFAULT_DB_ENGINE', 'InnoDB');
96 * SSL redirection policies
99 define('SSL_POLICY_NONE', 0);
100 define('SSL_POLICY_FULL', 1);
101 define('SSL_POLICY_SELFSIGN', 2);
107 * Registration policies
110 define('REGISTER_CLOSED', 0);
111 define('REGISTER_APPROVE', 1);
112 define('REGISTER_OPEN', 2);
120 * Type of the community page
123 define('CP_NO_INTERNAL_COMMUNITY', -2);
124 define('CP_NO_COMMUNITY_PAGE', -1);
125 define('CP_USERS_ON_SERVER', 0);
126 define('CP_GLOBAL_COMMUNITY', 1);
127 define('CP_USERS_AND_GLOBAL', 2);
133 * These numbers are used in stored permissions
134 * and existing allocations MUST NEVER BE CHANGED
135 * OR RE-ASSIGNED! You may only add to them.
138 Protocol::DFRN => (-1),
139 Protocol::ZOT => (-2),
140 Protocol::OSTATUS => (-3),
141 Protocol::FEED => (-4),
142 Protocol::DIASPORA => (-5),
143 Protocol::MAIL => (-6),
144 Protocol::FACEBOOK => (-8),
145 Protocol::LINKEDIN => (-9),
146 Protocol::XMPP => (-10),
147 Protocol::MYSPACE => (-11),
148 Protocol::GPLUS => (-12),
149 Protocol::PUMPIO => (-13),
150 Protocol::TWITTER => (-14),
151 Protocol::DIASPORA2 => (-15),
152 Protocol::STATUSNET => (-16),
153 Protocol::NEWS => (-18),
154 Protocol::ICALENDAR => (-19),
155 Protocol::PNUT => (-20),
157 Protocol::PHANTOM => (-127),
161 * Maximum number of "people who like (or don't like) this" that we will list by name
163 define('MAX_LIKERS', 75);
168 * Email notification options
171 define('NOTIFY_INTRO', 0x0001);
172 define('NOTIFY_CONFIRM', 0x0002);
173 define('NOTIFY_WALL', 0x0004);
174 define('NOTIFY_COMMENT', 0x0008);
175 define('NOTIFY_MAIL', 0x0010);
176 define('NOTIFY_SUGGEST', 0x0020);
177 define('NOTIFY_PROFILE', 0x0040);
178 define('NOTIFY_TAGSELF', 0x0080);
179 define('NOTIFY_TAGSHARE', 0x0100);
180 define('NOTIFY_POKE', 0x0200);
181 define('NOTIFY_SHARE', 0x0400);
183 define('SYSTEM_EMAIL', 0x4000);
185 define('NOTIFY_SYSTEM', 0x8000);
195 define('TERM_UNKNOWN', 0);
196 define('TERM_HASHTAG', 1);
197 define('TERM_MENTION', 2);
198 define('TERM_CATEGORY', 3);
199 define('TERM_PCATEGORY', 4);
200 define('TERM_FILE', 5);
201 define('TERM_SAVEDSEARCH', 6);
202 define('TERM_CONVERSATION', 7);
204 define('TERM_OBJ_POST', 1);
205 define('TERM_OBJ_PHOTO', 2);
210 * Various namespaces we may need to parse
213 define('NAMESPACE_ZOT', 'http://purl.org/zot');
214 define('NAMESPACE_DFRN', 'http://purl.org/macgirvin/dfrn/1.0');
215 define('NAMESPACE_THREAD', 'http://purl.org/syndication/thread/1.0');
216 define('NAMESPACE_TOMB', 'http://purl.org/atompub/tombstones/1.0');
217 define('NAMESPACE_ACTIVITY', 'http://activitystrea.ms/spec/1.0/');
218 define('NAMESPACE_ACTIVITY_SCHEMA', 'http://activitystrea.ms/schema/1.0/');
219 define('NAMESPACE_MEDIA', 'http://purl.org/syndication/atommedia');
220 define('NAMESPACE_SALMON_ME', 'http://salmon-protocol.org/ns/magic-env');
221 define('NAMESPACE_OSTATUSSUB', 'http://ostatus.org/schema/1.0/subscribe');
222 define('NAMESPACE_GEORSS', 'http://www.georss.org/georss');
223 define('NAMESPACE_POCO', 'http://portablecontacts.net/spec/1.0');
224 define('NAMESPACE_FEED', 'http://schemas.google.com/g/2010#updates-from');
225 define('NAMESPACE_OSTATUS', 'http://ostatus.org/schema/1.0');
226 define('NAMESPACE_STATUSNET', 'http://status.net/schema/api/1/');
227 define('NAMESPACE_ATOM1', 'http://www.w3.org/2005/Atom');
228 define('NAMESPACE_MASTODON', 'http://mastodon.social/schema/1.0');
234 * Activity stream defines
237 define('ACTIVITY_LIKE', NAMESPACE_ACTIVITY_SCHEMA . 'like');
238 define('ACTIVITY_DISLIKE', NAMESPACE_DFRN . '/dislike');
239 define('ACTIVITY_ATTEND', NAMESPACE_ZOT . '/activity/attendyes');
240 define('ACTIVITY_ATTENDNO', NAMESPACE_ZOT . '/activity/attendno');
241 define('ACTIVITY_ATTENDMAYBE', NAMESPACE_ZOT . '/activity/attendmaybe');
243 define('ACTIVITY_OBJ_HEART', NAMESPACE_DFRN . '/heart');
245 define('ACTIVITY_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'make-friend');
246 define('ACTIVITY_REQ_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'request-friend');
247 define('ACTIVITY_UNFRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'remove-friend');
248 define('ACTIVITY_FOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'follow');
249 define('ACTIVITY_UNFOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'stop-following');
250 define('ACTIVITY_JOIN', NAMESPACE_ACTIVITY_SCHEMA . 'join');
252 define('ACTIVITY_POST', NAMESPACE_ACTIVITY_SCHEMA . 'post');
253 define('ACTIVITY_UPDATE', NAMESPACE_ACTIVITY_SCHEMA . 'update');
254 define('ACTIVITY_TAG', NAMESPACE_ACTIVITY_SCHEMA . 'tag');
255 define('ACTIVITY_FAVORITE', NAMESPACE_ACTIVITY_SCHEMA . 'favorite');
256 define('ACTIVITY_UNFAVORITE', NAMESPACE_ACTIVITY_SCHEMA . 'unfavorite');
257 define('ACTIVITY_SHARE', NAMESPACE_ACTIVITY_SCHEMA . 'share');
258 define('ACTIVITY_DELETE', NAMESPACE_ACTIVITY_SCHEMA . 'delete');
260 define('ACTIVITY_POKE', NAMESPACE_ZOT . '/activity/poke');
262 define('ACTIVITY_OBJ_BOOKMARK', NAMESPACE_ACTIVITY_SCHEMA . 'bookmark');
263 define('ACTIVITY_OBJ_COMMENT', NAMESPACE_ACTIVITY_SCHEMA . 'comment');
264 define('ACTIVITY_OBJ_NOTE', NAMESPACE_ACTIVITY_SCHEMA . 'note');
265 define('ACTIVITY_OBJ_PERSON', NAMESPACE_ACTIVITY_SCHEMA . 'person');
266 define('ACTIVITY_OBJ_IMAGE', NAMESPACE_ACTIVITY_SCHEMA . 'image');
267 define('ACTIVITY_OBJ_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'photo');
268 define('ACTIVITY_OBJ_VIDEO', NAMESPACE_ACTIVITY_SCHEMA . 'video');
269 define('ACTIVITY_OBJ_P_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'profile-photo');
270 define('ACTIVITY_OBJ_ALBUM', NAMESPACE_ACTIVITY_SCHEMA . 'photo-album');
271 define('ACTIVITY_OBJ_EVENT', NAMESPACE_ACTIVITY_SCHEMA . 'event');
272 define('ACTIVITY_OBJ_GROUP', NAMESPACE_ACTIVITY_SCHEMA . 'group');
273 define('ACTIVITY_OBJ_TAGTERM', NAMESPACE_DFRN . '/tagterm');
274 define('ACTIVITY_OBJ_PROFILE', NAMESPACE_DFRN . '/profile');
275 define('ACTIVITY_OBJ_QUESTION', 'http://activityschema.org/object/question');
281 * Item weight for query ordering
284 define('GRAVITY_PARENT', 0);
285 define('GRAVITY_ACTIVITY', 3);
286 define('GRAVITY_COMMENT', 6);
287 define('GRAVITY_UNKNOWN', 9);
293 * Process priority for the worker
296 define('PRIORITY_UNDEFINED', 0);
297 define('PRIORITY_CRITICAL', 10);
298 define('PRIORITY_HIGH', 20);
299 define('PRIORITY_MEDIUM', 30);
300 define('PRIORITY_LOW', 40);
301 define('PRIORITY_NEGLIGIBLE', 50);
305 * @name Social Relay settings
307 * See here: https://github.com/jaywink/social-relay
308 * and here: https://wiki.diasporafoundation.org/Relay_servers_for_public_posts
311 define('SR_SCOPE_NONE', '');
312 define('SR_SCOPE_ALL', 'all');
313 define('SR_SCOPE_TAGS', 'tags');
316 // Normally this constant is defined - but not if "pcntl" isn't installed
317 if (!defined("SIGTERM")) {
318 define("SIGTERM", 15);
322 * Depending on the PHP version this constant does exist - or not.
323 * See here: http://php.net/manual/en/curl.constants.php#117928
325 if (!defined('CURLE_OPERATION_TIMEDOUT')) {
326 define('CURLE_OPERATION_TIMEDOUT', CURLE_OPERATION_TIMEOUTED);
330 * @brief Retrieve the App structure
332 * Useful in functions which require it but don't get it passed to them
338 return BaseObject::getApp();
342 * @brief Multi-purpose function to check variable state.
344 * Usage: x($var) or x($array, 'key')
346 * returns false if variable/key is not set
347 * if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0.
348 * e.g. x('') or x(0) returns 0;
350 * @deprecated since version 2018.12
351 * @param string|array $s variable to check
352 * @param string $k key inside the array to check
356 function x($s, $k = null)
359 if ((is_array($s)) && (array_key_exists($k, $s))) {
378 * Return the provided variable value if it exists and is truthy or the provided
379 * default value instead.
381 * Works with initialized variables and potentially uninitialized array keys
384 * - defaults($var, $default)
385 * - defaults($array, 'key', $default)
388 * @brief Returns a defaut value if the provided variable or array key is falsy
391 function defaults(...$args)
393 if (count($args) < 2) {
394 throw new BadFunctionCallException('defaults() requires at least 2 parameters');
396 if (count($args) > 3) {
397 throw new BadFunctionCallException('defaults() cannot use more than 3 parameters');
399 if (count($args) === 3 && is_null($args[1])) {
400 throw new BadFunctionCallException('defaults($arr, $key, $def) $key is null');
403 // The default value always is the last argument
404 $return = array_pop($args);
406 if (count($args) == 2 && is_array($args[0]) && !empty($args[0][$args[1]])) {
407 $return = $args[0][$args[1]];
410 if (count($args) == 1 && !empty($args[0])) {
418 * @brief Used to end the current process, after saving session state.
427 * @brief Returns the user id of locally logged in user or false.
429 * @return int|bool user id or false
431 function local_user()
433 if (!empty($_SESSION['authenticated']) && !empty($_SESSION['uid'])) {
434 return intval($_SESSION['uid']);
440 * @brief Returns the public contact id of logged in user or false.
442 * @return int|bool public contact id or false
444 function public_contact()
446 static $public_contact_id = false;
448 if (!$public_contact_id && !empty($_SESSION['authenticated'])) {
449 if (!empty($_SESSION['my_address'])) {
451 $public_contact_id = intval(Contact::getIdForURL($_SESSION['my_address'], 0, true));
452 } elseif (!empty($_SESSION['visitor_home'])) {
454 $public_contact_id = intval(Contact::getIdForURL($_SESSION['visitor_home'], 0, true));
456 } elseif (empty($_SESSION['authenticated'])) {
457 $public_contact_id = false;
460 return $public_contact_id;
464 * @brief Returns contact id of authenticated site visitor or false
466 * @return int|bool visitor_id or false
468 function remote_user()
470 // You cannot be both local and remote.
471 // Unncommented by rabuzarus because remote authentication to local
472 // profiles wasn't possible anymore (2018-04-12).
473 // if (local_user()) {
477 if (empty($_SESSION)) {
481 if (!empty($_SESSION['authenticated']) && !empty($_SESSION['visitor_id'])) {
482 return intval($_SESSION['visitor_id']);
488 * @brief Show an error message to user.
490 * This function save text in session, to be shown to the user at next page load
492 * @param string $s - Text of notice
496 if (empty($_SESSION)) {
501 if (empty($_SESSION['sysmsg'])) {
502 $_SESSION['sysmsg'] = [];
504 if ($a->interactive) {
505 $_SESSION['sysmsg'][] = $s;
510 * @brief Show an info message to user.
512 * This function save text in session, to be shown to the user at next page load
514 * @param string $s - Text of notice
520 if (local_user() && PConfig::get(local_user(), 'system', 'ignore_info')) {
524 if (empty($_SESSION['sysmsg_info'])) {
525 $_SESSION['sysmsg_info'] = [];
527 if ($a->interactive) {
528 $_SESSION['sysmsg_info'][] = $s;
532 function feed_birthday($uid, $tz)
535 * Determine the next birthday, but only if the birthday is published
536 * in the default profile. We _could_ also look for a private profile that the
537 * recipient can see, but somebody could get mad at us if they start getting
538 * public birthday greetings when they haven't made this info public.
540 * Assuming we are able to publish this info, we are then going to convert
541 * the start time from the owner's timezone to UTC.
543 * This will potentially solve the problem found with some social networks
544 * where birthdays are converted to the viewer's timezone and salutations from
545 * elsewhere in the world show up on the wrong day. We will convert it to the
546 * viewer's timezone also, but first we are going to convert it from the birthday
547 * person's timezone to GMT - so the viewer may find the birthday starting at
548 * 6:00PM the day before, but that will correspond to midnight to the birthday person.
556 $profile = DBA::selectFirst('profile', ['dob'], ['is-default' => true, 'uid' => $uid]);
557 if (DBA::isResult($profile)) {
558 $tmp_dob = substr($profile['dob'], 5);
559 if (intval($tmp_dob)) {
560 $y = DateTimeFormat::timezoneNow($tz, 'Y');
561 $bd = $y . '-' . $tmp_dob . ' 00:00';
562 $t_dob = strtotime($bd);
563 $now = strtotime(DateTimeFormat::timezoneNow($tz));
565 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
567 $birthday = DateTimeFormat::convert($bd, 'UTC', $tz, DateTimeFormat::ATOM);
575 * @brief Check if current user has admin role.
577 * @return bool true if user is an admin
579 function is_site_admin()
583 $admin_email = Config::get('config', 'admin_email');
585 $adminlist = explode(',', str_replace(' ', '', $admin_email));
587 return local_user() && $admin_email && in_array(defaults($a->user, 'email', ''), $adminlist);
591 * @brief Returns querystring as string from a mapped array.
593 * @param array $params mapped array with query parameters
594 * @param string $name of parameter, default null
598 function build_querystring($params, $name = null)
601 foreach ($params as $key => $val) {
602 if (is_array($val)) {
603 /// @TODO maybe not compare against null, use is_null()
605 $ret .= build_querystring($val, $key);
607 $ret .= build_querystring($val, $name . "[$key]");
610 $val = urlencode($val);
611 /// @TODO maybe not compare against null, use is_null()
613 /// @TODO two string concated, can be merged to one
614 $ret .= $name . "[$key]" . "=$val&";
616 $ret .= "$key=$val&";
623 function explode_querystring($query)
625 $arg_st = strpos($query, '?');
626 if ($arg_st !== false) {
627 $base = substr($query, 0, $arg_st);
634 $args = explode('&', substr($query, $arg_st));
635 foreach ($args as $k => $arg) {
636 /// @TODO really compare type-safe here?
641 $args = array_values($args);
646 $args = array_values($args);
656 * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
658 * Taken from http://webcheatsheet.com/php/get_current_page_url.php
660 function curPageURL()
663 if (!empty($_SERVER["HTTPS"]) && ($_SERVER["HTTPS"] == "on")) {
669 if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
670 $pageURL .= $_SERVER["SERVER_NAME"] . ":" . $_SERVER["SERVER_PORT"] . $_SERVER["REQUEST_URI"];
672 $pageURL .= $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"];
677 function get_server()
679 $server = Config::get("system", "directory");
682 $server = "https://dir.friendica.social";
688 function get_temppath()
692 $temppath = Config::get("system", "temppath");
694 if (($temppath != "") && App::isDirectoryUsable($temppath)) {
695 // We have a temp path and it is usable
696 return App::getRealPath($temppath);
699 // We don't have a working preconfigured temp path, so we take the system path.
700 $temppath = sys_get_temp_dir();
702 // Check if it is usable
703 if (($temppath != "") && App::isDirectoryUsable($temppath)) {
704 // Always store the real path, not the path through symlinks
705 $temppath = App::getRealPath($temppath);
707 // To avoid any interferences with other systems we create our own directory
708 $new_temppath = $temppath . "/" . $a->getHostName();
709 if (!is_dir($new_temppath)) {
710 /// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
711 mkdir($new_temppath);
714 if (App::isDirectoryUsable($new_temppath)) {
715 // The new path is usable, we are happy
716 Config::set("system", "temppath", $new_temppath);
717 return $new_temppath;
719 // We can't create a subdirectory, strange.
720 // But the directory seems to work, so we use it but don't store it.
725 // Reaching this point means that the operating system is configured badly.
729 function get_cachefile($file, $writemode = true)
731 $cache = get_itemcachepath();
733 if ((!$cache) || (!is_dir($cache))) {
737 $subfolder = $cache . "/" . substr($file, 0, 2);
739 $cachepath = $subfolder . "/" . $file;
742 if (!is_dir($subfolder)) {
744 chmod($subfolder, 0777);
751 function clear_cache($basepath = "", $path = "")
754 $basepath = get_itemcachepath();
758 if (($path == "") || (!is_dir($path))) {
762 if (substr(realpath($path), 0, strlen($basepath)) != $basepath) {
766 $cachetime = (int) Config::get('system', 'itemcache_duration');
767 if ($cachetime == 0) {
771 if (is_writable($path)) {
772 if ($dh = opendir($path)) {
773 while (($file = readdir($dh)) !== false) {
774 $fullpath = $path . "/" . $file;
775 if ((filetype($fullpath) == "dir") && ($file != ".") && ($file != "..")) {
776 clear_cache($basepath, $fullpath);
778 if ((filetype($fullpath) == "file") && (filectime($fullpath) < (time() - $cachetime))) {
787 function get_itemcachepath()
789 // Checking, if the cache is deactivated
790 $cachetime = (int) Config::get('system', 'itemcache_duration');
791 if ($cachetime < 0) {
795 $itemcache = Config::get('system', 'itemcache');
796 if (($itemcache != "") && App::isDirectoryUsable($itemcache)) {
797 return App::getRealPath($itemcache);
800 $temppath = get_temppath();
802 if ($temppath != "") {
803 $itemcache = $temppath . "/itemcache";
804 if (!file_exists($itemcache) && !is_dir($itemcache)) {
808 if (App::isDirectoryUsable($itemcache)) {
809 Config::set("system", "itemcache", $itemcache);
817 * @brief Returns the path where spool files are stored
819 * @return string Spool path
821 function get_spoolpath()
823 $spoolpath = Config::get('system', 'spoolpath');
824 if (($spoolpath != "") && App::isDirectoryUsable($spoolpath)) {
825 // We have a spool path and it is usable
829 // We don't have a working preconfigured spool path, so we take the temp path.
830 $temppath = get_temppath();
832 if ($temppath != "") {
833 // To avoid any interferences with other systems we create our own directory
834 $spoolpath = $temppath . "/spool";
835 if (!is_dir($spoolpath)) {
839 if (App::isDirectoryUsable($spoolpath)) {
840 // The new path is usable, we are happy
841 Config::set("system", "spoolpath", $spoolpath);
844 // We can't create a subdirectory, strange.
845 // But the directory seems to work, so we use it but don't store it.
850 // Reaching this point means that the operating system is configured badly.
854 if (!function_exists('exif_imagetype')) {
855 function exif_imagetype($file)
857 $size = getimagesize($file);
862 function validate_include(&$file)
866 $file = realpath($file);
868 if (strpos($file, getcwd()) !== 0) {
872 $file = str_replace(getcwd() . "/", "", $file, $count);
877 if ($orig_file !== $file) {
882 if (strpos($file, "include/") === 0) {
886 if (strpos($file, "addon/") === 0) {
890 // Simply return flag