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\Worker;
32 use Friendica\Database\DBM;
33 use Friendica\Database\DBStructure;
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.08-dev');
43 define('DFRN_PROTOCOL_VERSION', '2.23');
44 define('DB_UPDATE_VERSION', 1279);
45 define('NEW_UPDATE_ROUTINE_VERSION', 1170);
48 * @brief Constants for the database update check
50 const DB_UPDATE_NOT_CHECKED = 0; // Database check wasn't executed before
51 const DB_UPDATE_SUCCESSFUL = 1; // Database check was successful
52 const DB_UPDATE_FAILED = 2; // Database check failed
55 * @brief Constant with a HTML line break.
57 * Contains a HTML line break (br) element and a real carriage return with line
58 * feed for the source.
59 * This can be used in HTML and JavaScript where needed a line break.
61 define('EOL', "<br />\r\n");
64 * @brief Image storage quality.
66 * Lower numbers save space at cost of image detail.
67 * For ease of upgrade, please do not change here. Set [system] jpegquality = n in config/local.ini.php,
68 * where n is between 1 and 100, and with very poor results below about 50
70 define('JPEG_QUALITY', 100);
73 * [system] png_quality = n where is between 0 (uncompressed) to 9
75 define('PNG_QUALITY', 8);
78 * An alternate way of limiting picture upload sizes. Specify the maximum pixel
79 * length that pictures are allowed to be (for non-square pictures, it will apply
80 * to the longest side). Pictures longer than this length will be resized to be
81 * this length (on the longest side, the other side will be scaled appropriately).
82 * Modify this value using
85 * max_image_length = n;
87 * in config/local.ini.php
89 * If you don't want to set a maximum length, set to -1. The default value is
90 * defined by 'MAX_IMAGE_LENGTH' below.
92 define('MAX_IMAGE_LENGTH', -1);
97 define('DEFAULT_DB_ENGINE', 'InnoDB');
102 * SSL redirection policies
105 define('SSL_POLICY_NONE', 0);
106 define('SSL_POLICY_FULL', 1);
107 define('SSL_POLICY_SELFSIGN', 2);
116 define('LOGGER_NORMAL', 0);
117 define('LOGGER_TRACE', 1);
118 define('LOGGER_DEBUG', 2);
119 define('LOGGER_DATA', 3);
120 define('LOGGER_ALL', 4);
125 * @deprecated since version 3.6
131 define('CACHE_MONTH', Cache::MONTH);
132 define('CACHE_WEEK', Cache::WEEK);
133 define('CACHE_DAY', Cache::DAY);
134 define('CACHE_HOUR', Cache::HOUR);
135 define('CACHE_HALF_HOUR', Cache::HALF_HOUR);
136 define('CACHE_QUARTER_HOUR', Cache::QUARTER_HOUR);
137 define('CACHE_FIVE_MINUTES', Cache::FIVE_MINUTES);
138 define('CACHE_MINUTE', Cache::MINUTE);
144 * Registration policies
147 define('REGISTER_CLOSED', 0);
148 define('REGISTER_APPROVE', 1);
149 define('REGISTER_OPEN', 2);
160 define('CONTACT_IS_FOLLOWER', 1);
161 define('CONTACT_IS_SHARING', 2);
162 define('CONTACT_IS_FRIEND', 3);
170 * DB update return values
173 define('UPDATE_SUCCESS', 0);
174 define('UPDATE_FAILED', 1);
180 * @name page/profile types
182 * PAGE_NORMAL is a typical personal profile account
183 * PAGE_SOAPBOX automatically approves all friend requests as CONTACT_IS_SHARING, (readonly)
184 * PAGE_COMMUNITY automatically approves all friend requests as CONTACT_IS_SHARING, but with
185 * write access to wall and comments (no email and not included in page owner's ACL lists)
186 * PAGE_FREELOVE automatically approves all friend requests as full friends (CONTACT_IS_FRIEND).
190 define('PAGE_NORMAL', 0);
191 define('PAGE_SOAPBOX', 1);
192 define('PAGE_COMMUNITY', 2);
193 define('PAGE_FREELOVE', 3);
194 define('PAGE_BLOG', 4);
195 define('PAGE_PRVGROUP', 5);
201 * @name account types
203 * ACCOUNT_TYPE_PERSON - the account belongs to a person
204 * Associated page types: PAGE_NORMAL, PAGE_SOAPBOX, PAGE_FREELOVE
206 * ACCOUNT_TYPE_ORGANISATION - the account belongs to an organisation
207 * Associated page type: PAGE_SOAPBOX
209 * ACCOUNT_TYPE_NEWS - the account is a news reflector
210 * Associated page type: PAGE_SOAPBOX
212 * ACCOUNT_TYPE_COMMUNITY - the account is community forum
213 * Associated page types: PAGE_COMMUNITY, PAGE_PRVGROUP
215 * ACCOUNT_TYPE_RELAY - the account is a relay
216 * This will only be assigned to contacts, not to user accounts
219 define('ACCOUNT_TYPE_PERSON', 0);
220 define('ACCOUNT_TYPE_ORGANISATION', 1);
221 define('ACCOUNT_TYPE_NEWS', 2);
222 define('ACCOUNT_TYPE_COMMUNITY', 3);
223 define('ACCOUNT_TYPE_RELAY', 4);
231 * Type of the community page
234 define('CP_NO_INTERNAL_COMMUNITY', -2);
235 define('CP_NO_COMMUNITY_PAGE', -1);
236 define('CP_USERS_ON_SERVER', 0);
237 define('CP_GLOBAL_COMMUNITY', 1);
238 define('CP_USERS_AND_GLOBAL', 2);
245 * @deprecated since version 3.6
248 * Different protocols that we are storing
251 define('PROTOCOL_UNKNOWN' , Conversation::PROTOCOL_UNKNOWN);
252 define('PROTOCOL_DFRN' , Conversation::PROTOCOL_DFRN);
253 define('PROTOCOL_DIASPORA' , Conversation::PROTOCOL_DIASPORA);
254 define('PROTOCOL_OSTATUS_SALMON' , Conversation::PROTOCOL_OSTATUS_SALMON);
255 define('PROTOCOL_OSTATUS_FEED' , Conversation::PROTOCOL_OSTATUS_FEED); // Deprecated
256 define('PROTOCOL_GS_CONVERSATION', Conversation::PROTOCOL_GS_CONVERSATION); // Deprecated
257 define('PROTOCOL_SPLITTED_CONV' , Conversation::PROTOCOL_SPLITTED_CONV);
263 * @name Network constants
264 * @deprecated since version 3.6
267 * Network and protocol family types
270 define('NETWORK_DFRN' , Protocol::DFRN); // Friendica, Mistpark, other DFRN implementations
271 define('NETWORK_ZOT' , Protocol::ZOT); // Zot! - Currently unsupported
272 define('NETWORK_OSTATUS' , Protocol::OSTATUS); // GNU-social, Pleroma, Mastodon, other OStatus implementations
273 define('NETWORK_FEED' , Protocol::FEED); // RSS/Atom feeds with no known "post/notify" protocol
274 define('NETWORK_DIASPORA' , Protocol::DIASPORA); // Diaspora
275 define('NETWORK_MAIL' , Protocol::MAIL); // IMAP/POP
276 define('NETWORK_FACEBOOK' , Protocol::FACEBOOK); // Facebook API
277 define('NETWORK_LINKEDIN' , Protocol::LINKEDIN); // LinkedIn
278 define('NETWORK_XMPP' , Protocol::XMPP); // XMPP - Currently unsupported
279 define('NETWORK_MYSPACE' , Protocol::MYSPACE); // MySpace - Currently unsupported
280 define('NETWORK_GPLUS' , Protocol::GPLUS); // Google+
281 define('NETWORK_PUMPIO' , Protocol::PUMPIO); // pump.io
282 define('NETWORK_TWITTER' , Protocol::TWITTER); // Twitter
283 define('NETWORK_DIASPORA2', Protocol::DIASPORA2); // Diaspora connector
284 define('NETWORK_STATUSNET', Protocol::STATUSNET); // Statusnet connector
285 define('NETWORK_APPNET' , Protocol::APPNET); // app.net - Dead protocol
286 define('NETWORK_NEWS' , Protocol::NEWS); // Network News Transfer Protocol - Currently unsupported
287 define('NETWORK_ICALENDAR', Protocol::ICALENDAR); // iCalendar - Currently unsupported
288 define('NETWORK_PNUT' , Protocol::PNUT); // pnut.io - Currently unsupported
289 define('NETWORK_PHANTOM' , Protocol::PHANTOM); // Place holder
295 * These numbers are used in stored permissions
296 * and existing allocations MUST NEVER BE CHANGED
297 * OR RE-ASSIGNED! You may only add to them.
300 NETWORK_DFRN => (-1),
302 NETWORK_OSTATUS => (-3),
303 NETWORK_FEED => (-4),
304 NETWORK_DIASPORA => (-5),
305 NETWORK_MAIL => (-6),
306 NETWORK_FACEBOOK => (-8),
307 NETWORK_LINKEDIN => (-9),
308 NETWORK_XMPP => (-10),
309 NETWORK_MYSPACE => (-11),
310 NETWORK_GPLUS => (-12),
311 NETWORK_PUMPIO => (-13),
312 NETWORK_TWITTER => (-14),
313 NETWORK_DIASPORA2 => (-15),
314 NETWORK_STATUSNET => (-16),
315 NETWORK_APPNET => (-17),
316 NETWORK_NEWS => (-18),
317 NETWORK_ICALENDAR => (-19),
318 NETWORK_PNUT => (-20),
320 NETWORK_PHANTOM => (-127),
324 * Maximum number of "people who like (or don't like) this" that we will list by name
326 define('MAX_LIKERS', 75);
329 * Communication timeout
331 define('ZCURL_TIMEOUT', (-1));
336 * Email notification options
339 define('NOTIFY_INTRO', 0x0001);
340 define('NOTIFY_CONFIRM', 0x0002);
341 define('NOTIFY_WALL', 0x0004);
342 define('NOTIFY_COMMENT', 0x0008);
343 define('NOTIFY_MAIL', 0x0010);
344 define('NOTIFY_SUGGEST', 0x0020);
345 define('NOTIFY_PROFILE', 0x0040);
346 define('NOTIFY_TAGSELF', 0x0080);
347 define('NOTIFY_TAGSHARE', 0x0100);
348 define('NOTIFY_POKE', 0x0200);
349 define('NOTIFY_SHARE', 0x0400);
351 define('SYSTEM_EMAIL', 0x4000);
353 define('NOTIFY_SYSTEM', 0x8000);
363 define('TERM_UNKNOWN', 0);
364 define('TERM_HASHTAG', 1);
365 define('TERM_MENTION', 2);
366 define('TERM_CATEGORY', 3);
367 define('TERM_PCATEGORY', 4);
368 define('TERM_FILE', 5);
369 define('TERM_SAVEDSEARCH', 6);
370 define('TERM_CONVERSATION', 7);
372 define('TERM_OBJ_POST', 1);
373 define('TERM_OBJ_PHOTO', 2);
378 * Various namespaces we may need to parse
381 define('NAMESPACE_ZOT', 'http://purl.org/zot');
382 define('NAMESPACE_DFRN', 'http://purl.org/macgirvin/dfrn/1.0');
383 define('NAMESPACE_THREAD', 'http://purl.org/syndication/thread/1.0');
384 define('NAMESPACE_TOMB', 'http://purl.org/atompub/tombstones/1.0');
385 define('NAMESPACE_ACTIVITY', 'http://activitystrea.ms/spec/1.0/');
386 define('NAMESPACE_ACTIVITY_SCHEMA', 'http://activitystrea.ms/schema/1.0/');
387 define('NAMESPACE_MEDIA', 'http://purl.org/syndication/atommedia');
388 define('NAMESPACE_SALMON_ME', 'http://salmon-protocol.org/ns/magic-env');
389 define('NAMESPACE_OSTATUSSUB', 'http://ostatus.org/schema/1.0/subscribe');
390 define('NAMESPACE_GEORSS', 'http://www.georss.org/georss');
391 define('NAMESPACE_POCO', 'http://portablecontacts.net/spec/1.0');
392 define('NAMESPACE_FEED', 'http://schemas.google.com/g/2010#updates-from');
393 define('NAMESPACE_OSTATUS', 'http://ostatus.org/schema/1.0');
394 define('NAMESPACE_STATUSNET', 'http://status.net/schema/api/1/');
395 define('NAMESPACE_ATOM1', 'http://www.w3.org/2005/Atom');
396 define('NAMESPACE_MASTODON', 'http://mastodon.social/schema/1.0');
402 * Activity stream defines
405 define('ACTIVITY_LIKE', NAMESPACE_ACTIVITY_SCHEMA . 'like');
406 define('ACTIVITY_DISLIKE', NAMESPACE_DFRN . '/dislike');
407 define('ACTIVITY_ATTEND', NAMESPACE_ZOT . '/activity/attendyes');
408 define('ACTIVITY_ATTENDNO', NAMESPACE_ZOT . '/activity/attendno');
409 define('ACTIVITY_ATTENDMAYBE', NAMESPACE_ZOT . '/activity/attendmaybe');
411 define('ACTIVITY_OBJ_HEART', NAMESPACE_DFRN . '/heart');
413 define('ACTIVITY_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'make-friend');
414 define('ACTIVITY_REQ_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'request-friend');
415 define('ACTIVITY_UNFRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'remove-friend');
416 define('ACTIVITY_FOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'follow');
417 define('ACTIVITY_UNFOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'stop-following');
418 define('ACTIVITY_JOIN', NAMESPACE_ACTIVITY_SCHEMA . 'join');
420 define('ACTIVITY_POST', NAMESPACE_ACTIVITY_SCHEMA . 'post');
421 define('ACTIVITY_UPDATE', NAMESPACE_ACTIVITY_SCHEMA . 'update');
422 define('ACTIVITY_TAG', NAMESPACE_ACTIVITY_SCHEMA . 'tag');
423 define('ACTIVITY_FAVORITE', NAMESPACE_ACTIVITY_SCHEMA . 'favorite');
424 define('ACTIVITY_UNFAVORITE', NAMESPACE_ACTIVITY_SCHEMA . 'unfavorite');
425 define('ACTIVITY_SHARE', NAMESPACE_ACTIVITY_SCHEMA . 'share');
426 define('ACTIVITY_DELETE', NAMESPACE_ACTIVITY_SCHEMA . 'delete');
428 define('ACTIVITY_POKE', NAMESPACE_ZOT . '/activity/poke');
430 define('ACTIVITY_OBJ_BOOKMARK', NAMESPACE_ACTIVITY_SCHEMA . 'bookmark');
431 define('ACTIVITY_OBJ_COMMENT', NAMESPACE_ACTIVITY_SCHEMA . 'comment');
432 define('ACTIVITY_OBJ_NOTE', NAMESPACE_ACTIVITY_SCHEMA . 'note');
433 define('ACTIVITY_OBJ_PERSON', NAMESPACE_ACTIVITY_SCHEMA . 'person');
434 define('ACTIVITY_OBJ_IMAGE', NAMESPACE_ACTIVITY_SCHEMA . 'image');
435 define('ACTIVITY_OBJ_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'photo');
436 define('ACTIVITY_OBJ_VIDEO', NAMESPACE_ACTIVITY_SCHEMA . 'video');
437 define('ACTIVITY_OBJ_P_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'profile-photo');
438 define('ACTIVITY_OBJ_ALBUM', NAMESPACE_ACTIVITY_SCHEMA . 'photo-album');
439 define('ACTIVITY_OBJ_EVENT', NAMESPACE_ACTIVITY_SCHEMA . 'event');
440 define('ACTIVITY_OBJ_GROUP', NAMESPACE_ACTIVITY_SCHEMA . 'group');
441 define('ACTIVITY_OBJ_TAGTERM', NAMESPACE_DFRN . '/tagterm');
442 define('ACTIVITY_OBJ_PROFILE', NAMESPACE_DFRN . '/profile');
443 define('ACTIVITY_OBJ_QUESTION', 'http://activityschema.org/object/question');
449 * Item weight for query ordering
452 define('GRAVITY_PARENT', 0);
453 define('GRAVITY_ACTIVITY', 3);
454 define('GRAVITY_COMMENT', 6);
455 define('GRAVITY_UNKNOWN', 9);
461 * Process priority for the worker
464 define('PRIORITY_UNDEFINED', 0);
465 define('PRIORITY_CRITICAL', 10);
466 define('PRIORITY_HIGH', 20);
467 define('PRIORITY_MEDIUM', 30);
468 define('PRIORITY_LOW', 40);
469 define('PRIORITY_NEGLIGIBLE', 50);
473 * @name Social Relay settings
475 * See here: https://github.com/jaywink/social-relay
476 * and here: https://wiki.diasporafoundation.org/Relay_servers_for_public_posts
479 define('SR_SCOPE_NONE', '');
480 define('SR_SCOPE_ALL', 'all');
481 define('SR_SCOPE_TAGS', 'tags');
485 * Lowest possible date time value
487 define('NULL_DATE', '0001-01-01 00:00:00');
489 // Normally this constant is defined - but not if "pcntl" isn't installed
490 if (!defined("SIGTERM")) {
491 define("SIGTERM", 15);
495 * Depending on the PHP version this constant does exist - or not.
496 * See here: http://php.net/manual/en/curl.constants.php#117928
498 if (!defined('CURLE_OPERATION_TIMEDOUT')) {
499 define('CURLE_OPERATION_TIMEDOUT', CURLE_OPERATION_TIMEOUTED);
503 * @brief Retrieve the App structure
505 * Useful in functions which require it but don't get it passed to them
511 return BaseObject::getApp();
515 * @brief Multi-purpose function to check variable state.
517 * Usage: x($var) or $x($array, 'key')
519 * returns false if variable/key is not set
520 * if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0.
521 * e.g. x('') or x(0) returns 0;
523 * @param string|array $s variable to check
524 * @param string $k key inside the array to check
528 function x($s, $k = null)
531 if ((is_array($s)) && (array_key_exists($k, $s))) {
550 * Return the provided variable value if it exists and is truthy or the provided
551 * default value instead.
553 * Works with initialized variables and potentially uninitialized array keys
556 * - defaults($var, $default)
557 * - defaults($array, 'key', $default)
559 * @brief Returns a defaut value if the provided variable or array key is falsy
563 function defaults() {
564 $args = func_get_args();
566 if (count($args) < 2) {
567 throw new BadFunctionCallException('defaults() requires at least 2 parameters');
569 if (count($args) > 3) {
570 throw new BadFunctionCallException('defaults() cannot use more than 3 parameters');
572 if (count($args) === 3 && is_null($args[1])) {
573 throw new BadFunctionCallException('defaults($arr, $key, $def) $key is null');
576 $default = array_pop($args);
578 if (call_user_func_array('x', $args)) {
579 if (count($args) === 1) {
582 $return = $args[0][$args[1]];
592 * @brief Returns the baseurl.
594 * @see System::baseUrl()
597 * @TODO Function is deprecated and only used in some addons
601 return System::baseUrl();
605 * @brief Return absolut URL for given $path.
607 * @param string $path given path
611 function absurl($path)
613 if (strpos($path, '/') === 0) {
614 return z_path() . $path;
620 * @brief Function to check if request was an AJAX (xmlhttprequest) request.
626 return (!empty($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest');
630 * @brief Function to check if request was an AJAX (xmlhttprequest) request.
632 * @param boolean $via_worker boolean Is the check run via the worker?
634 function check_db($via_worker)
636 $build = Config::get('system', 'build');
639 Config::set('system', 'build', DB_UPDATE_VERSION - 1);
640 $build = DB_UPDATE_VERSION - 1;
643 // We don't support upgrading from very old versions anymore
644 if ($build < NEW_UPDATE_ROUTINE_VERSION) {
645 die('You try to update from a version prior to database version 1170. The direct upgrade path is not supported. Please update to version 3.5.4 before updating to this version.');
648 if ($build < DB_UPDATE_VERSION) {
649 // When we cannot execute the database update via the worker, we will do it directly
650 if (!Worker::add(PRIORITY_CRITICAL, 'DBUpdate') && $via_worker) {
657 * Sets the base url for use in cmdline programs which don't have
660 * @param object $a App
662 function check_url(App $a)
664 $url = Config::get('system', 'url');
666 // if the url isn't set or the stored url is radically different
667 // than the currently visited url, store the current value accordingly.
668 // "Radically different" ignores common variations such as http vs https
669 // and www.example.com vs example.com.
670 // We will only change the url to an ip address if there is no existing setting
672 if (empty($url) || (!link_compare($url, System::baseUrl())) && (!preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/", $a->get_hostname()))) {
673 Config::set('system', 'url', System::baseUrl());
680 * @brief Automatic database updates
681 * @param object $a App
685 $build = Config::get('system', 'build');
687 if (empty($build) || ($build > DB_UPDATE_VERSION)) {
688 $build = DB_UPDATE_VERSION - 1;
689 Config::set('system', 'build', $build);
692 if ($build != DB_UPDATE_VERSION) {
693 require_once 'update.php';
695 $stored = intval($build);
696 $current = intval(DB_UPDATE_VERSION);
697 if ($stored < $current) {
698 Config::load('database');
700 // Compare the current structure with the defined structure
701 $t = Config::get('database', 'dbupdate_' . DB_UPDATE_VERSION);
706 // run the pre_update_nnnn functions in update.php
707 for ($x = $stored + 1; $x <= $current; $x++) {
708 $r = run_update_function($x, 'pre_update');
714 Config::set('database', 'dbupdate_' . DB_UPDATE_VERSION, time());
716 // update the structure in one call
717 $retval = DBStructure::update(false, true);
719 DBStructure::updateFail(
725 Config::set('database', 'dbupdate_' . DB_UPDATE_VERSION, 'success');
728 // run the update_nnnn functions in update.php
729 for ($x = $stored + 1; $x <= $current; $x++) {
730 $r = run_update_function($x, 'update');
741 function run_update_function($x, $prefix)
743 $funcname = $prefix . '_' . $x;
745 if (function_exists($funcname)) {
746 // There could be a lot of processes running or about to run.
747 // We want exactly one process to run the update command.
748 // So store the fact that we're taking responsibility
749 // after first checking to see if somebody else already has.
750 // If the update fails or times-out completely you may need to
751 // delete the config entry to try again.
753 $t = Config::get('database', $funcname);
757 Config::set('database', $funcname, time());
759 // call the specific update
760 $retval = $funcname();
763 //send the administrator an e-mail
764 DBStructure::updateFail(
766 L10n::t('Update %s failed. See error logs.', $x)
770 Config::set('database', $funcname, 'success');
772 Config::set('system', 'build', $x);
777 Config::set('database', $funcname, 'success');
779 Config::set('system', 'build', $x);
786 * @brief Synchronise addons:
788 * system.addon contains a comma-separated list of names
789 * of addons which are used on this system.
790 * Go through the database list of already installed addons, and if we have
791 * an entry, but it isn't in the config list, call the uninstall procedure
792 * and mark it uninstalled in the database (for now we'll remove it).
793 * Then go through the config list and if we have a addon that isn't installed,
794 * call the install procedure and add it to the database.
796 * @param object $a App
798 function check_addons(App $a)
800 $r = q("SELECT * FROM `addon` WHERE `installed` = 1");
801 if (DBM::is_result($r)) {
807 $addons = Config::get('system', 'addon');
811 $addons_arr = explode(',', str_replace(' ', '', $addons));
814 $a->addons = $addons_arr;
818 if (count($installed)) {
819 foreach ($installed as $i) {
820 if (!in_array($i['name'], $addons_arr)) {
821 Addon::uninstall($i['name']);
823 $installed_arr[] = $i['name'];
828 if (count($addons_arr)) {
829 foreach ($addons_arr as $p) {
830 if (!in_array($p, $installed_arr)) {
842 * @brief Used to end the current process, after saving session state.
851 * @brief Redirect to another URL and terminate this process.
853 function goaway($path)
855 if (strstr(normalise_link($path), 'http://')) {
858 $url = System::baseUrl() . '/' . ltrim($path, '/');
861 header("Location: $url");
866 * @brief Returns the user id of locally logged in user or false.
868 * @return int|bool user id or false
870 function local_user()
872 if (!empty($_SESSION['authenticated']) && !empty($_SESSION['uid'])) {
873 return intval($_SESSION['uid']);
879 * @brief Returns the public contact id of logged in user or false.
881 * @return int|bool public contact id or false
883 function public_contact()
885 static $public_contact_id = false;
887 if (!$public_contact_id && x($_SESSION, 'authenticated')) {
888 if (x($_SESSION, 'my_address')) {
890 $public_contact_id = intval(Contact::getIdForURL($_SESSION['my_address'], 0, true));
891 } elseif (x($_SESSION, 'visitor_home')) {
893 $public_contact_id = intval(Contact::getIdForURL($_SESSION['visitor_home'], 0, true));
895 } elseif (!x($_SESSION, 'authenticated')) {
896 $public_contact_id = false;
899 return $public_contact_id;
903 * @brief Returns contact id of authenticated site visitor or false
905 * @return int|bool visitor_id or false
907 function remote_user()
909 // You cannot be both local and remote.
910 // Unncommented by rabuzarus because remote authentication to local
911 // profiles wasn't possible anymore (2018-04-12).
912 // if (local_user()) {
916 if (empty($_SESSION)) {
920 if (x($_SESSION, 'authenticated') && x($_SESSION, 'visitor_id')) {
921 return intval($_SESSION['visitor_id']);
927 * @brief Show an error message to user.
929 * This function save text in session, to be shown to the user at next page load
931 * @param string $s - Text of notice
935 if (empty($_SESSION)) {
940 if (!x($_SESSION, 'sysmsg')) {
941 $_SESSION['sysmsg'] = [];
943 if ($a->interactive) {
944 $_SESSION['sysmsg'][] = $s;
949 * @brief Show an info message to user.
951 * This function save text in session, to be shown to the user at next page load
953 * @param string $s - Text of notice
959 if (local_user() && PConfig::get(local_user(), 'system', 'ignore_info')) {
963 if (!x($_SESSION, 'sysmsg_info')) {
964 $_SESSION['sysmsg_info'] = [];
966 if ($a->interactive) {
967 $_SESSION['sysmsg_info'][] = $s;
971 function feed_birthday($uid, $tz)
974 * Determine the next birthday, but only if the birthday is published
975 * in the default profile. We _could_ also look for a private profile that the
976 * recipient can see, but somebody could get mad at us if they start getting
977 * public birthday greetings when they haven't made this info public.
979 * Assuming we are able to publish this info, we are then going to convert
980 * the start time from the owner's timezone to UTC.
982 * This will potentially solve the problem found with some social networks
983 * where birthdays are converted to the viewer's timezone and salutations from
984 * elsewhere in the world show up on the wrong day. We will convert it to the
985 * viewer's timezone also, but first we are going to convert it from the birthday
986 * person's timezone to GMT - so the viewer may find the birthday starting at
987 * 6:00PM the day before, but that will correspond to midnight to the birthday person.
996 "SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1",
1000 if (DBM::is_result($p)) {
1001 $tmp_dob = substr($p[0]['dob'], 5);
1002 if (intval($tmp_dob)) {
1003 $y = DateTimeFormat::timezoneNow($tz, 'Y');
1004 $bd = $y . '-' . $tmp_dob . ' 00:00';
1005 $t_dob = strtotime($bd);
1006 $now = strtotime(DateTimeFormat::timezoneNow($tz));
1007 if ($t_dob < $now) {
1008 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
1010 $birthday = DateTimeFormat::convert($bd, 'UTC', $tz, DateTimeFormat::ATOM);
1018 * @brief Check if current user has admin role.
1020 * @return bool true if user is an admin
1022 function is_site_admin()
1026 $admin_email = Config::get('config', 'admin_email');
1028 $adminlist = explode(',', str_replace(' ', '', $admin_email));
1030 return local_user() && $admin_email && in_array(defaults($a->user, 'email', ''), $adminlist);
1034 * @brief Returns querystring as string from a mapped array.
1036 * @param array $params mapped array with query parameters
1037 * @param string $name of parameter, default null
1041 function build_querystring($params, $name = null)
1044 foreach ($params as $key => $val) {
1045 if (is_array($val)) {
1046 /// @TODO maybe not compare against null, use is_null()
1047 if ($name == null) {
1048 $ret .= build_querystring($val, $key);
1050 $ret .= build_querystring($val, $name . "[$key]");
1053 $val = urlencode($val);
1054 /// @TODO maybe not compare against null, use is_null()
1055 if ($name != null) {
1056 /// @TODO two string concated, can be merged to one
1057 $ret .= $name . "[$key]" . "=$val&";
1059 $ret .= "$key=$val&";
1066 function explode_querystring($query)
1068 $arg_st = strpos($query, '?');
1069 if ($arg_st !== false) {
1070 $base = substr($query, 0, $arg_st);
1077 $args = explode('&', substr($query, $arg_st));
1078 foreach ($args as $k => $arg) {
1079 /// @TODO really compare type-safe here?
1084 $args = array_values($args);
1089 $args = array_values($args);
1099 * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
1101 * Taken from http://webcheatsheet.com/php/get_current_page_url.php
1103 function curPageURL()
1106 if ($_SERVER["HTTPS"] == "on") {
1112 if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
1113 $pageURL .= $_SERVER["SERVER_NAME"] . ":" . $_SERVER["SERVER_PORT"] . $_SERVER["REQUEST_URI"];
1115 $pageURL .= $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"];
1120 function random_digits($digits)
1123 for ($i = 0; $i < $digits; $i++) {
1124 /// @TODO Avoid rand/mt_rand, when it comes to cryptography, they are generating predictable (seedable) numbers.
1130 function get_server()
1132 $server = Config::get("system", "directory");
1134 if ($server == "") {
1135 $server = "https://dir.friendica.social";
1141 function get_temppath()
1145 $temppath = Config::get("system", "temppath");
1147 if (($temppath != "") && App::directory_usable($temppath)) {
1148 // We have a temp path and it is usable
1149 return App::realpath($temppath);
1152 // We don't have a working preconfigured temp path, so we take the system path.
1153 $temppath = sys_get_temp_dir();
1155 // Check if it is usable
1156 if (($temppath != "") && App::directory_usable($temppath)) {
1157 // Always store the real path, not the path through symlinks
1158 $temppath = App::realpath($temppath);
1160 // To avoid any interferences with other systems we create our own directory
1161 $new_temppath = $temppath . "/" . $a->get_hostname();
1162 if (!is_dir($new_temppath)) {
1163 /// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
1164 mkdir($new_temppath);
1167 if (App::directory_usable($new_temppath)) {
1168 // The new path is usable, we are happy
1169 Config::set("system", "temppath", $new_temppath);
1170 return $new_temppath;
1172 // We can't create a subdirectory, strange.
1173 // But the directory seems to work, so we use it but don't store it.
1178 // Reaching this point means that the operating system is configured badly.
1182 function get_cachefile($file, $writemode = true)
1184 $cache = get_itemcachepath();
1186 if ((!$cache) || (!is_dir($cache))) {
1190 $subfolder = $cache . "/" . substr($file, 0, 2);
1192 $cachepath = $subfolder . "/" . $file;
1195 if (!is_dir($subfolder)) {
1197 chmod($subfolder, 0777);
1204 function clear_cache($basepath = "", $path = "")
1207 $basepath = get_itemcachepath();
1211 if (($path == "") || (!is_dir($path))) {
1215 if (substr(realpath($path), 0, strlen($basepath)) != $basepath) {
1219 $cachetime = (int) Config::get('system', 'itemcache_duration');
1220 if ($cachetime == 0) {
1224 if (is_writable($path)) {
1225 if ($dh = opendir($path)) {
1226 while (($file = readdir($dh)) !== false) {
1227 $fullpath = $path . "/" . $file;
1228 if ((filetype($fullpath) == "dir") && ($file != ".") && ($file != "..")) {
1229 clear_cache($basepath, $fullpath);
1231 if ((filetype($fullpath) == "file") && (filectime($fullpath) < (time() - $cachetime))) {
1240 function get_itemcachepath()
1242 // Checking, if the cache is deactivated
1243 $cachetime = (int) Config::get('system', 'itemcache_duration');
1244 if ($cachetime < 0) {
1248 $itemcache = Config::get('system', 'itemcache');
1249 if (($itemcache != "") && App::directory_usable($itemcache)) {
1250 return App::realpath($itemcache);
1253 $temppath = get_temppath();
1255 if ($temppath != "") {
1256 $itemcache = $temppath . "/itemcache";
1257 if (!file_exists($itemcache) && !is_dir($itemcache)) {
1261 if (App::directory_usable($itemcache)) {
1262 Config::set("system", "itemcache", $itemcache);
1270 * @brief Returns the path where spool files are stored
1272 * @return string Spool path
1274 function get_spoolpath()
1276 $spoolpath = Config::get('system', 'spoolpath');
1277 if (($spoolpath != "") && App::directory_usable($spoolpath)) {
1278 // We have a spool path and it is usable
1282 // We don't have a working preconfigured spool path, so we take the temp path.
1283 $temppath = get_temppath();
1285 if ($temppath != "") {
1286 // To avoid any interferences with other systems we create our own directory
1287 $spoolpath = $temppath . "/spool";
1288 if (!is_dir($spoolpath)) {
1292 if (App::directory_usable($spoolpath)) {
1293 // The new path is usable, we are happy
1294 Config::set("system", "spoolpath", $spoolpath);
1297 // We can't create a subdirectory, strange.
1298 // But the directory seems to work, so we use it but don't store it.
1303 // Reaching this point means that the operating system is configured badly.
1307 if (!function_exists('exif_imagetype')) {
1308 function exif_imagetype($file)
1310 $size = getimagesize($file);
1315 function validate_include(&$file)
1319 $file = realpath($file);
1321 if (strpos($file, getcwd()) !== 0) {
1325 $file = str_replace(getcwd() . "/", "", $file, $count);
1330 if ($orig_file !== $file) {
1335 if (strpos($file, "include/") === 0) {
1339 if (strpos($file, "addon/") === 0) {
1343 // Simply return flag
1347 function current_load()
1349 if (!function_exists('sys_getloadavg')) {
1353 $load_arr = sys_getloadavg();
1355 if (!is_array($load_arr)) {
1359 return max($load_arr[0], $load_arr[1]);
1363 * @brief get c-style args
1369 return get_app()->argc;
1373 * @brief Returns the value of a argv key
1375 * @param int $x argv key
1376 * @return string Value of the argv key
1380 if (array_key_exists($x, get_app()->argv)) {
1381 return get_app()->argv[$x];
1388 * @brief Get the data which is needed for infinite scroll
1390 * For invinite scroll we need the page number of the actual page
1391 * and the the URI where the content of the next page comes from.
1392 * This data is needed for the js part in main.js.
1393 * Note: infinite scroll does only work for the network page (module)
1395 * @param string $module The name of the module (e.g. "network")
1396 * @return array Of infinite scroll data
1397 * 'pageno' => $pageno The number of the actual page
1398 * 'reload_uri' => $reload_uri The URI of the content we have to load
1400 function infinite_scroll_data($module)
1402 if (PConfig::get(local_user(), 'system', 'infinite_scroll')
1403 && $module == 'network'
1404 && defaults($_GET, 'mode', '') != 'minimal'
1406 // get the page number
1407 $pageno = defaults($_GET, 'page', 1);
1411 // try to get the uri from which we load the content
1412 foreach ($_GET as $param => $value) {
1413 if (($param != "page") && ($param != "q")) {
1414 $reload_uri .= "&" . $param . "=" . urlencode($value);
1419 if ($a->page_offset != "" && !strstr($reload_uri, "&offset=")) {
1420 $reload_uri .= "&offset=" . urlencode($a->page_offset);
1423 $arr = ["pageno" => $pageno, "reload_uri" => $reload_uri];