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\Database\DBA;
26 use Friendica\Model\Contact;
27 use Friendica\Util\BasePath;
28 use Friendica\Util\DateTimeFormat;
30 define('FRIENDICA_PLATFORM', 'Friendica');
31 define('FRIENDICA_CODENAME', 'The Tazmans Flax-lily');
32 define('FRIENDICA_VERSION', '2019.03-dev');
33 define('DFRN_PROTOCOL_VERSION', '2.23');
34 define('NEW_UPDATE_ROUTINE_VERSION', 1170);
37 * @brief Constant with a HTML line break.
39 * Contains a HTML line break (br) element and a real carriage return with line
40 * feed for the source.
41 * This can be used in HTML and JavaScript where needed a line break.
43 define('EOL', "<br />\r\n");
46 * @brief Image storage quality.
48 * Lower numbers save space at cost of image detail.
49 * For ease of upgrade, please do not change here. Set system.jpegquality = n in config/local.config.php,
50 * where n is between 1 and 100, and with very poor results below about 50
52 define('JPEG_QUALITY', 100);
55 * system.png_quality = n where is between 0 (uncompressed) to 9
57 define('PNG_QUALITY', 8);
60 * An alternate way of limiting picture upload sizes. Specify the maximum pixel
61 * length that pictures are allowed to be (for non-square pictures, it will apply
62 * to the longest side). Pictures longer than this length will be resized to be
63 * this length (on the longest side, the other side will be scaled appropriately).
64 * Modify this value using
67 * 'max_image_length' => 'n',
71 * in config/local.config.php
73 * If you don't want to set a maximum length, set to -1. The default value is
74 * defined by 'MAX_IMAGE_LENGTH' below.
76 define('MAX_IMAGE_LENGTH', -1);
81 define('DEFAULT_DB_ENGINE', 'InnoDB');
86 * SSL redirection policies
89 define('SSL_POLICY_NONE', 0);
90 define('SSL_POLICY_FULL', 1);
91 define('SSL_POLICY_SELFSIGN', 2);
97 * Type of the community page
100 define('CP_NO_INTERNAL_COMMUNITY', -2);
101 define('CP_NO_COMMUNITY_PAGE', -1);
102 define('CP_USERS_ON_SERVER', 0);
103 define('CP_GLOBAL_COMMUNITY', 1);
104 define('CP_USERS_AND_GLOBAL', 2);
110 * These numbers are used in stored permissions
111 * and existing allocations MUST NEVER BE CHANGED
112 * OR RE-ASSIGNED! You may only add to them.
115 Protocol::DFRN => (-1),
116 Protocol::ZOT => (-2),
117 Protocol::OSTATUS => (-3),
118 Protocol::FEED => (-4),
119 Protocol::DIASPORA => (-5),
120 Protocol::MAIL => (-6),
121 Protocol::FACEBOOK => (-8),
122 Protocol::LINKEDIN => (-9),
123 Protocol::XMPP => (-10),
124 Protocol::MYSPACE => (-11),
125 Protocol::GPLUS => (-12),
126 Protocol::PUMPIO => (-13),
127 Protocol::TWITTER => (-14),
128 Protocol::DIASPORA2 => (-15),
129 Protocol::STATUSNET => (-16),
130 Protocol::NEWS => (-18),
131 Protocol::ICALENDAR => (-19),
132 Protocol::PNUT => (-20),
134 Protocol::PHANTOM => (-127),
138 * Maximum number of "people who like (or don't like) this" that we will list by name
140 define('MAX_LIKERS', 75);
145 * Email notification options
148 define('NOTIFY_INTRO', 1);
149 define('NOTIFY_CONFIRM', 2);
150 define('NOTIFY_WALL', 4);
151 define('NOTIFY_COMMENT', 8);
152 define('NOTIFY_MAIL', 16);
153 define('NOTIFY_SUGGEST', 32);
154 define('NOTIFY_PROFILE', 64);
155 define('NOTIFY_TAGSELF', 128);
156 define('NOTIFY_TAGSHARE', 256);
157 define('NOTIFY_POKE', 512);
158 define('NOTIFY_SHARE', 1024);
160 define('SYSTEM_EMAIL', 16384);
162 define('NOTIFY_SYSTEM', 32768);
172 define('TERM_UNKNOWN', 0);
173 define('TERM_HASHTAG', 1);
174 define('TERM_MENTION', 2);
175 define('TERM_CATEGORY', 3);
176 define('TERM_PCATEGORY', 4);
177 define('TERM_FILE', 5);
178 define('TERM_SAVEDSEARCH', 6);
179 define('TERM_CONVERSATION', 7);
181 define('TERM_OBJ_POST', 1);
182 define('TERM_OBJ_PHOTO', 2);
187 * Various namespaces we may need to parse
190 define('NAMESPACE_ZOT', 'http://purl.org/zot');
191 define('NAMESPACE_DFRN', 'http://purl.org/macgirvin/dfrn/1.0');
192 define('NAMESPACE_THREAD', 'http://purl.org/syndication/thread/1.0');
193 define('NAMESPACE_TOMB', 'http://purl.org/atompub/tombstones/1.0');
194 define('NAMESPACE_ACTIVITY', 'http://activitystrea.ms/spec/1.0/');
195 define('NAMESPACE_ACTIVITY_SCHEMA', 'http://activitystrea.ms/schema/1.0/');
196 define('NAMESPACE_MEDIA', 'http://purl.org/syndication/atommedia');
197 define('NAMESPACE_SALMON_ME', 'http://salmon-protocol.org/ns/magic-env');
198 define('NAMESPACE_OSTATUSSUB', 'http://ostatus.org/schema/1.0/subscribe');
199 define('NAMESPACE_GEORSS', 'http://www.georss.org/georss');
200 define('NAMESPACE_POCO', 'http://portablecontacts.net/spec/1.0');
201 define('NAMESPACE_FEED', 'http://schemas.google.com/g/2010#updates-from');
202 define('NAMESPACE_OSTATUS', 'http://ostatus.org/schema/1.0');
203 define('NAMESPACE_STATUSNET', 'http://status.net/schema/api/1/');
204 define('NAMESPACE_ATOM1', 'http://www.w3.org/2005/Atom');
205 define('NAMESPACE_MASTODON', 'http://mastodon.social/schema/1.0');
211 * Activity stream defines
214 define('ACTIVITY_LIKE', NAMESPACE_ACTIVITY_SCHEMA . 'like');
215 define('ACTIVITY_DISLIKE', NAMESPACE_DFRN . '/dislike');
216 define('ACTIVITY_ATTEND', NAMESPACE_ZOT . '/activity/attendyes');
217 define('ACTIVITY_ATTENDNO', NAMESPACE_ZOT . '/activity/attendno');
218 define('ACTIVITY_ATTENDMAYBE', NAMESPACE_ZOT . '/activity/attendmaybe');
220 define('ACTIVITY_OBJ_HEART', NAMESPACE_DFRN . '/heart');
222 define('ACTIVITY_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'make-friend');
223 define('ACTIVITY_REQ_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'request-friend');
224 define('ACTIVITY_UNFRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'remove-friend');
225 define('ACTIVITY_FOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'follow');
226 define('ACTIVITY_UNFOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'stop-following');
227 define('ACTIVITY_JOIN', NAMESPACE_ACTIVITY_SCHEMA . 'join');
229 define('ACTIVITY_POST', NAMESPACE_ACTIVITY_SCHEMA . 'post');
230 define('ACTIVITY_UPDATE', NAMESPACE_ACTIVITY_SCHEMA . 'update');
231 define('ACTIVITY_TAG', NAMESPACE_ACTIVITY_SCHEMA . 'tag');
232 define('ACTIVITY_FAVORITE', NAMESPACE_ACTIVITY_SCHEMA . 'favorite');
233 define('ACTIVITY_UNFAVORITE', NAMESPACE_ACTIVITY_SCHEMA . 'unfavorite');
234 define('ACTIVITY_SHARE', NAMESPACE_ACTIVITY_SCHEMA . 'share');
235 define('ACTIVITY_DELETE', NAMESPACE_ACTIVITY_SCHEMA . 'delete');
237 define('ACTIVITY_POKE', NAMESPACE_ZOT . '/activity/poke');
239 define('ACTIVITY_OBJ_BOOKMARK', NAMESPACE_ACTIVITY_SCHEMA . 'bookmark');
240 define('ACTIVITY_OBJ_COMMENT', NAMESPACE_ACTIVITY_SCHEMA . 'comment');
241 define('ACTIVITY_OBJ_NOTE', NAMESPACE_ACTIVITY_SCHEMA . 'note');
242 define('ACTIVITY_OBJ_PERSON', NAMESPACE_ACTIVITY_SCHEMA . 'person');
243 define('ACTIVITY_OBJ_IMAGE', NAMESPACE_ACTIVITY_SCHEMA . 'image');
244 define('ACTIVITY_OBJ_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'photo');
245 define('ACTIVITY_OBJ_VIDEO', NAMESPACE_ACTIVITY_SCHEMA . 'video');
246 define('ACTIVITY_OBJ_P_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'profile-photo');
247 define('ACTIVITY_OBJ_ALBUM', NAMESPACE_ACTIVITY_SCHEMA . 'photo-album');
248 define('ACTIVITY_OBJ_EVENT', NAMESPACE_ACTIVITY_SCHEMA . 'event');
249 define('ACTIVITY_OBJ_GROUP', NAMESPACE_ACTIVITY_SCHEMA . 'group');
250 define('ACTIVITY_OBJ_TAGTERM', NAMESPACE_DFRN . '/tagterm');
251 define('ACTIVITY_OBJ_PROFILE', NAMESPACE_DFRN . '/profile');
252 define('ACTIVITY_OBJ_QUESTION', 'http://activityschema.org/object/question');
258 * Item weight for query ordering
261 define('GRAVITY_PARENT', 0);
262 define('GRAVITY_ACTIVITY', 3);
263 define('GRAVITY_COMMENT', 6);
264 define('GRAVITY_UNKNOWN', 9);
270 * Process priority for the worker
273 define('PRIORITY_UNDEFINED', 0);
274 define('PRIORITY_CRITICAL', 10);
275 define('PRIORITY_HIGH', 20);
276 define('PRIORITY_MEDIUM', 30);
277 define('PRIORITY_LOW', 40);
278 define('PRIORITY_NEGLIGIBLE', 50);
282 * @name Social Relay settings
284 * See here: https://github.com/jaywink/social-relay
285 * and here: https://wiki.diasporafoundation.org/Relay_servers_for_public_posts
288 define('SR_SCOPE_NONE', '');
289 define('SR_SCOPE_ALL', 'all');
290 define('SR_SCOPE_TAGS', 'tags');
293 // Normally this constant is defined - but not if "pcntl" isn't installed
294 if (!defined("SIGTERM")) {
295 define("SIGTERM", 15);
299 * Depending on the PHP version this constant does exist - or not.
300 * See here: http://php.net/manual/en/curl.constants.php#117928
302 if (!defined('CURLE_OPERATION_TIMEDOUT')) {
303 define('CURLE_OPERATION_TIMEDOUT', CURLE_OPERATION_TIMEOUTED);
307 * @brief Retrieve the App structure
309 * Useful in functions which require it but don't get it passed to them
311 * @deprecated since version 2018.09
312 * @see BaseObject::getApp()
317 return BaseObject::getApp();
321 * Return the provided variable value if it exists and is truthy or the provided
322 * default value instead.
324 * Works with initialized variables and potentially uninitialized array keys
327 * - defaults($var, $default)
328 * - defaults($array, 'key', $default)
331 * @brief Returns a defaut value if the provided variable or array key is falsy
334 function defaults(...$args)
336 if (count($args) < 2) {
337 throw new BadFunctionCallException('defaults() requires at least 2 parameters');
339 if (count($args) > 3) {
340 throw new BadFunctionCallException('defaults() cannot use more than 3 parameters');
342 if (count($args) === 3 && is_null($args[1])) {
343 throw new BadFunctionCallException('defaults($arr, $key, $def) $key is null');
346 // The default value always is the last argument
347 $return = array_pop($args);
349 if (count($args) == 2 && is_array($args[0]) && !empty($args[0][$args[1]])) {
350 $return = $args[0][$args[1]];
353 if (count($args) == 1 && !empty($args[0])) {
361 * @brief Used to end the current process, after saving session state.
370 * @brief Returns the user id of locally logged in user or false.
372 * @return int|bool user id or false
374 function local_user()
376 if (!empty($_SESSION['authenticated']) && !empty($_SESSION['uid'])) {
377 return intval($_SESSION['uid']);
383 * @brief Returns the public contact id of logged in user or false.
385 * @return int|bool public contact id or false
387 function public_contact()
389 static $public_contact_id = false;
391 if (!$public_contact_id && !empty($_SESSION['authenticated'])) {
392 if (!empty($_SESSION['my_address'])) {
394 $public_contact_id = intval(Contact::getIdForURL($_SESSION['my_address'], 0, true));
395 } elseif (!empty($_SESSION['visitor_home'])) {
397 $public_contact_id = intval(Contact::getIdForURL($_SESSION['visitor_home'], 0, true));
399 } elseif (empty($_SESSION['authenticated'])) {
400 $public_contact_id = false;
403 return $public_contact_id;
407 * @brief Returns contact id of authenticated site visitor or false
409 * @return int|bool visitor_id or false
411 function remote_user()
413 // You cannot be both local and remote.
414 // Unncommented by rabuzarus because remote authentication to local
415 // profiles wasn't possible anymore (2018-04-12).
416 // if (local_user()) {
420 if (empty($_SESSION)) {
424 if (!empty($_SESSION['authenticated']) && !empty($_SESSION['visitor_id'])) {
425 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(defaults($a->user, 'email', ''), $adminlist);
534 * @brief Returns querystring as string from a mapped array.
536 * @param array $params mapped array with query parameters
537 * @param string $name of parameter, default null
541 function build_querystring($params, $name = null)
544 foreach ($params as $key => $val) {
545 if (is_array($val)) {
546 /// @TODO maybe not compare against null, use is_null()
548 $ret .= build_querystring($val, $key);
550 $ret .= build_querystring($val, $name . "[$key]");
553 $val = urlencode($val);
554 /// @TODO maybe not compare against null, use is_null()
556 /// @TODO two string concated, can be merged to one
557 $ret .= $name . "[$key]" . "=$val&";
559 $ret .= "$key=$val&";
566 function explode_querystring($query)
568 $arg_st = strpos($query, '?');
569 if ($arg_st !== false) {
570 $base = substr($query, 0, $arg_st);
577 $args = explode('&', substr($query, $arg_st));
578 foreach ($args as $k => $arg) {
579 /// @TODO really compare type-safe here?
584 $args = array_values($args);
589 $args = array_values($args);
599 * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
601 * Taken from http://webcheatsheet.com/php/get_current_page_url.php
603 function curPageURL()
606 if (!empty($_SERVER["HTTPS"]) && ($_SERVER["HTTPS"] == "on")) {
612 if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
613 $pageURL .= $_SERVER["SERVER_NAME"] . ":" . $_SERVER["SERVER_PORT"] . $_SERVER["REQUEST_URI"];
615 $pageURL .= $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"];
620 function get_server()
622 $server = Config::get("system", "directory");
625 $server = "https://dir.friendica.social";
631 function get_temppath()
635 $temppath = Config::get("system", "temppath");
637 if (($temppath != "") && BasePath::isDirectoryUsable($temppath)) {
638 // We have a temp path and it is usable
639 return BasePath::getRealPath($temppath);
642 // We don't have a working preconfigured temp path, so we take the system path.
643 $temppath = sys_get_temp_dir();
645 // Check if it is usable
646 if (($temppath != "") && BasePath::isDirectoryUsable($temppath)) {
647 // Always store the real path, not the path through symlinks
648 $temppath = BasePath::getRealPath($temppath);
650 // To avoid any interferences with other systems we create our own directory
651 $new_temppath = $temppath . "/" . $a->getHostName();
652 if (!is_dir($new_temppath)) {
653 /// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
654 mkdir($new_temppath);
657 if (BasePath::isDirectoryUsable($new_temppath)) {
658 // The new path is usable, we are happy
659 Config::set("system", "temppath", $new_temppath);
660 return $new_temppath;
662 // We can't create a subdirectory, strange.
663 // But the directory seems to work, so we use it but don't store it.
668 // Reaching this point means that the operating system is configured badly.
672 function get_cachefile($file, $writemode = true)
674 $cache = get_itemcachepath();
676 if ((!$cache) || (!is_dir($cache))) {
680 $subfolder = $cache . "/" . substr($file, 0, 2);
682 $cachepath = $subfolder . "/" . $file;
685 if (!is_dir($subfolder)) {
687 chmod($subfolder, 0777);
694 function clear_cache($basepath = "", $path = "")
697 $basepath = get_itemcachepath();
701 if (($path == "") || (!is_dir($path))) {
705 if (substr(realpath($path), 0, strlen($basepath)) != $basepath) {
709 $cachetime = (int) Config::get('system', 'itemcache_duration');
710 if ($cachetime == 0) {
714 if (is_writable($path)) {
715 if ($dh = opendir($path)) {
716 while (($file = readdir($dh)) !== false) {
717 $fullpath = $path . "/" . $file;
718 if ((filetype($fullpath) == "dir") && ($file != ".") && ($file != "..")) {
719 clear_cache($basepath, $fullpath);
721 if ((filetype($fullpath) == "file") && (filectime($fullpath) < (time() - $cachetime))) {
730 function get_itemcachepath()
732 // Checking, if the cache is deactivated
733 $cachetime = (int) Config::get('system', 'itemcache_duration');
734 if ($cachetime < 0) {
738 $itemcache = Config::get('system', 'itemcache');
739 if (($itemcache != "") && BasePath::isDirectoryUsable($itemcache)) {
740 return BasePath::getRealPath($itemcache);
743 $temppath = get_temppath();
745 if ($temppath != "") {
746 $itemcache = $temppath . "/itemcache";
747 if (!file_exists($itemcache) && !is_dir($itemcache)) {
751 if (BasePath::isDirectoryUsable($itemcache)) {
752 Config::set("system", "itemcache", $itemcache);
760 * @brief Returns the path where spool files are stored
762 * @return string Spool path
764 function get_spoolpath()
766 $spoolpath = Config::get('system', 'spoolpath');
767 if (($spoolpath != "") && BasePath::isDirectoryUsable($spoolpath)) {
768 // We have a spool path and it is usable
772 // We don't have a working preconfigured spool path, so we take the temp path.
773 $temppath = get_temppath();
775 if ($temppath != "") {
776 // To avoid any interferences with other systems we create our own directory
777 $spoolpath = $temppath . "/spool";
778 if (!is_dir($spoolpath)) {
782 if (BasePath::isDirectoryUsable($spoolpath)) {
783 // The new path is usable, we are happy
784 Config::set("system", "spoolpath", $spoolpath);
787 // We can't create a subdirectory, strange.
788 // But the directory seems to work, so we use it but don't store it.
793 // Reaching this point means that the operating system is configured badly.
797 if (!function_exists('exif_imagetype')) {
798 function exif_imagetype($file)
800 $size = getimagesize($file);
805 function validate_include(&$file)
809 $file = realpath($file);
811 if (strpos($file, getcwd()) !== 0) {
815 $file = str_replace(getcwd() . "/", "", $file, $count);
820 if ($orig_file !== $file) {
825 if (strpos($file, "include/") === 0) {
829 if (strpos($file, "addon/") === 0) {
833 // Simply return flag
838 * PHP 5 compatible dirname() with count parameter
840 * @see http://php.net/manual/en/function.dirname.php#113193
842 * @deprecated with PHP 7
843 * @param string $path
847 function rdirname($path, $levels = 1)
850 return dirname(rdirname($path, --$levels));
852 return dirname($path);