5 * This file defines some global constants and includes the central App class.
11 * Friendica is a communications platform for integrated social communications
12 * utilising decentralised communications and linkage to several indie social
13 * projects - as well as popular mainstream providers.
15 * Our mission is to free our friends and families from the clutches of
16 * data-harvesting corporations, and pave the way to a future where social
17 * communications are free and open and flow between alternate providers as
18 * easily as email does today.
21 require_once __DIR__ . DIRECTORY_SEPARATOR . 'vendor' . DIRECTORY_SEPARATOR . 'autoload.php';
24 use Friendica\Core\Addon;
25 use Friendica\Core\System;
26 use Friendica\Core\Cache;
27 use Friendica\Core\Config;
28 use Friendica\Core\PConfig;
29 use Friendica\Core\Worker;
30 use Friendica\Database\DBM;
31 use Friendica\Model\Contact;
32 use Friendica\Database\DBStructure;
33 use Friendica\Module\Login;
35 require_once 'include/network.php';
36 require_once 'include/text.php';
37 require_once 'include/datetime.php';
38 require_once 'include/pgettext.php';
40 define('FRIENDICA_PLATFORM', 'Friendica');
41 define('FRIENDICA_CODENAME', 'Asparagus');
42 define('FRIENDICA_VERSION', '3.6-dev');
43 define('DFRN_PROTOCOL_VERSION', '2.23');
44 define('DB_UPDATE_VERSION', 1242);
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");
62 define('ATOM_TIME', 'Y-m-d\TH:i:s\Z');
65 * @brief Image storage quality.
67 * Lower numbers save space at cost of image detail.
68 * For ease of upgrade, please do not change here. Change jpeg quality with
69 * $a->config['system']['jpeg_quality'] = n;
70 * in .htconfig.php, where n is netween 1 and 100, and with very poor results
73 define('JPEG_QUALITY', 100);
76 * $a->config['system']['png_quality'] from 0 (uncompressed) to 9
78 define('PNG_QUALITY', 8);
81 * An alternate way of limiting picture upload sizes. Specify the maximum pixel
82 * length that pictures are allowed to be (for non-square pictures, it will apply
83 * to the longest side). Pictures longer than this length will be resized to be
84 * this length (on the longest side, the other side will be scaled appropriately).
85 * Modify this value using
87 * $a->config['system']['max_image_length'] = n;
91 * If you don't want to set a maximum length, set to -1. The default value is
92 * defined by 'MAX_IMAGE_LENGTH' below.
94 define('MAX_IMAGE_LENGTH', -1);
99 define('DEFAULT_DB_ENGINE', 'InnoDB');
104 * SSL redirection policies
107 define('SSL_POLICY_NONE', 0);
108 define('SSL_POLICY_FULL', 1);
109 define('SSL_POLICY_SELFSIGN', 2);
118 define('LOGGER_NORMAL', 0);
119 define('LOGGER_TRACE', 1);
120 define('LOGGER_DEBUG', 2);
121 define('LOGGER_DATA', 3);
122 define('LOGGER_ALL', 4);
131 define('CACHE_MONTH', 0);
132 define('CACHE_WEEK', 1);
133 define('CACHE_DAY', 2);
134 define('CACHE_HOUR', 3);
135 define('CACHE_HALF_HOUR', 4);
136 define('CACHE_QUARTER_HOUR', 5);
137 define('CACHE_FIVE_MINUTES', 6);
138 define('CACHE_MINUTE', 7);
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
216 define('ACCOUNT_TYPE_PERSON', 0);
217 define('ACCOUNT_TYPE_ORGANISATION', 1);
218 define('ACCOUNT_TYPE_NEWS', 2);
219 define('ACCOUNT_TYPE_COMMUNITY', 3);
227 * Type of the community page
230 define('CP_NO_COMMUNITY_PAGE', -1);
231 define('CP_USERS_ON_SERVER', 0);
232 define('CP_GLOBAL_COMMUNITY', 1);
233 define('CP_USERS_AND_GLOBAL', 2);
241 * Different protocols that we are storing
244 define('PROTOCOL_UNKNOWN', 0);
245 define('PROTOCOL_DFRN', 1);
246 define('PROTOCOL_DIASPORA', 2);
247 define('PROTOCOL_OSTATUS_SALMON', 3);
248 define('PROTOCOL_OSTATUS_FEED', 4); // Deprecated
249 define('PROTOCOL_GS_CONVERSATION', 5); // Deprecated
250 define('PROTOCOL_SPLITTED_CONV', 6);
258 * Network and protocol family types
261 define('NETWORK_DFRN', 'dfrn'); // Friendica, Mistpark, other DFRN implementations
262 define('NETWORK_ZOT', 'zot!'); // Zot! - Currently unsupported
263 define('NETWORK_OSTATUS', 'stat'); // GNU-social, Pleroma, Mastodon, other OStatus implementations
264 define('NETWORK_FEED', 'feed'); // RSS/Atom feeds with no known "post/notify" protocol
265 define('NETWORK_DIASPORA', 'dspr'); // Diaspora
266 define('NETWORK_MAIL', 'mail'); // IMAP/POP
267 define('NETWORK_FACEBOOK', 'face'); // Facebook API
268 define('NETWORK_LINKEDIN', 'lnkd'); // LinkedIn
269 define('NETWORK_XMPP', 'xmpp'); // XMPP - Currently unsupported
270 define('NETWORK_MYSPACE', 'mysp'); // MySpace - Currently unsupported
271 define('NETWORK_GPLUS', 'goog'); // Google+
272 define('NETWORK_PUMPIO', 'pump'); // pump.io
273 define('NETWORK_TWITTER', 'twit'); // Twitter
274 define('NETWORK_DIASPORA2', 'dspc'); // Diaspora connector
275 define('NETWORK_STATUSNET', 'stac'); // Statusnet connector
276 define('NETWORK_APPNET', 'apdn'); // app.net - Dead protocol
277 define('NETWORK_NEWS', 'nntp'); // Network News Transfer Protocol - Currently unsupported
278 define('NETWORK_ICALENDAR', 'ical'); // iCalendar - Currently unsupported
279 define('NETWORK_PNUT', 'pnut'); // pnut.io - Currently unsupported
280 define('NETWORK_PHANTOM', 'unkn'); // Place holder
286 * These numbers are used in stored permissions
287 * and existing allocations MUST NEVER BE CHANGED
288 * OR RE-ASSIGNED! You may only add to them.
291 NETWORK_DFRN => (-1),
293 NETWORK_OSTATUS => (-3),
294 NETWORK_FEED => (-4),
295 NETWORK_DIASPORA => (-5),
296 NETWORK_MAIL => (-6),
297 NETWORK_FACEBOOK => (-8),
298 NETWORK_LINKEDIN => (-9),
299 NETWORK_XMPP => (-10),
300 NETWORK_MYSPACE => (-11),
301 NETWORK_GPLUS => (-12),
302 NETWORK_PUMPIO => (-13),
303 NETWORK_TWITTER => (-14),
304 NETWORK_DIASPORA2 => (-15),
305 NETWORK_STATUSNET => (-16),
306 NETWORK_APPNET => (-17),
307 NETWORK_NEWS => (-18),
308 NETWORK_ICALENDAR => (-19),
309 NETWORK_PNUT => (-20),
311 NETWORK_PHANTOM => (-127),
315 * Maximum number of "people who like (or don't like) this" that we will list by name
317 define('MAX_LIKERS', 75);
320 * Communication timeout
322 define('ZCURL_TIMEOUT', (-1));
327 * Email notification options
330 define('NOTIFY_INTRO', 0x0001);
331 define('NOTIFY_CONFIRM', 0x0002);
332 define('NOTIFY_WALL', 0x0004);
333 define('NOTIFY_COMMENT', 0x0008);
334 define('NOTIFY_MAIL', 0x0010);
335 define('NOTIFY_SUGGEST', 0x0020);
336 define('NOTIFY_PROFILE', 0x0040);
337 define('NOTIFY_TAGSELF', 0x0080);
338 define('NOTIFY_TAGSHARE', 0x0100);
339 define('NOTIFY_POKE', 0x0200);
340 define('NOTIFY_SHARE', 0x0400);
342 define('SYSTEM_EMAIL', 0x4000);
344 define('NOTIFY_SYSTEM', 0x8000);
354 define('TERM_UNKNOWN', 0);
355 define('TERM_HASHTAG', 1);
356 define('TERM_MENTION', 2);
357 define('TERM_CATEGORY', 3);
358 define('TERM_PCATEGORY', 4);
359 define('TERM_FILE', 5);
360 define('TERM_SAVEDSEARCH', 6);
361 define('TERM_CONVERSATION', 7);
363 define('TERM_OBJ_POST', 1);
364 define('TERM_OBJ_PHOTO', 2);
369 * Various namespaces we may need to parse
372 define('NAMESPACE_ZOT', 'http://purl.org/zot');
373 define('NAMESPACE_DFRN', 'http://purl.org/macgirvin/dfrn/1.0');
374 define('NAMESPACE_THREAD', 'http://purl.org/syndication/thread/1.0');
375 define('NAMESPACE_TOMB', 'http://purl.org/atompub/tombstones/1.0');
376 define('NAMESPACE_ACTIVITY', 'http://activitystrea.ms/spec/1.0/');
377 define('NAMESPACE_ACTIVITY_SCHEMA', 'http://activitystrea.ms/schema/1.0/');
378 define('NAMESPACE_MEDIA', 'http://purl.org/syndication/atommedia');
379 define('NAMESPACE_SALMON_ME', 'http://salmon-protocol.org/ns/magic-env');
380 define('NAMESPACE_OSTATUSSUB', 'http://ostatus.org/schema/1.0/subscribe');
381 define('NAMESPACE_GEORSS', 'http://www.georss.org/georss');
382 define('NAMESPACE_POCO', 'http://portablecontacts.net/spec/1.0');
383 define('NAMESPACE_FEED', 'http://schemas.google.com/g/2010#updates-from');
384 define('NAMESPACE_OSTATUS', 'http://ostatus.org/schema/1.0');
385 define('NAMESPACE_STATUSNET', 'http://status.net/schema/api/1/');
386 define('NAMESPACE_ATOM1', 'http://www.w3.org/2005/Atom');
387 define('NAMESPACE_MASTODON', 'http://mastodon.social/schema/1.0');
393 * Activity stream defines
396 define('ACTIVITY_LIKE', NAMESPACE_ACTIVITY_SCHEMA . 'like');
397 define('ACTIVITY_DISLIKE', NAMESPACE_DFRN . '/dislike');
398 define('ACTIVITY_ATTEND', NAMESPACE_ZOT . '/activity/attendyes');
399 define('ACTIVITY_ATTENDNO', NAMESPACE_ZOT . '/activity/attendno');
400 define('ACTIVITY_ATTENDMAYBE', NAMESPACE_ZOT . '/activity/attendmaybe');
402 define('ACTIVITY_OBJ_HEART', NAMESPACE_DFRN . '/heart');
404 define('ACTIVITY_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'make-friend');
405 define('ACTIVITY_REQ_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'request-friend');
406 define('ACTIVITY_UNFRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'remove-friend');
407 define('ACTIVITY_FOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'follow');
408 define('ACTIVITY_UNFOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'stop-following');
409 define('ACTIVITY_JOIN', NAMESPACE_ACTIVITY_SCHEMA . 'join');
411 define('ACTIVITY_POST', NAMESPACE_ACTIVITY_SCHEMA . 'post');
412 define('ACTIVITY_UPDATE', NAMESPACE_ACTIVITY_SCHEMA . 'update');
413 define('ACTIVITY_TAG', NAMESPACE_ACTIVITY_SCHEMA . 'tag');
414 define('ACTIVITY_FAVORITE', NAMESPACE_ACTIVITY_SCHEMA . 'favorite');
415 define('ACTIVITY_UNFAVORITE', NAMESPACE_ACTIVITY_SCHEMA . 'unfavorite');
416 define('ACTIVITY_SHARE', NAMESPACE_ACTIVITY_SCHEMA . 'share');
417 define('ACTIVITY_DELETE', NAMESPACE_ACTIVITY_SCHEMA . 'delete');
419 define('ACTIVITY_POKE', NAMESPACE_ZOT . '/activity/poke');
421 define('ACTIVITY_OBJ_BOOKMARK', NAMESPACE_ACTIVITY_SCHEMA . 'bookmark');
422 define('ACTIVITY_OBJ_COMMENT', NAMESPACE_ACTIVITY_SCHEMA . 'comment');
423 define('ACTIVITY_OBJ_NOTE', NAMESPACE_ACTIVITY_SCHEMA . 'note');
424 define('ACTIVITY_OBJ_PERSON', NAMESPACE_ACTIVITY_SCHEMA . 'person');
425 define('ACTIVITY_OBJ_IMAGE', NAMESPACE_ACTIVITY_SCHEMA . 'image');
426 define('ACTIVITY_OBJ_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'photo');
427 define('ACTIVITY_OBJ_VIDEO', NAMESPACE_ACTIVITY_SCHEMA . 'video');
428 define('ACTIVITY_OBJ_P_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'profile-photo');
429 define('ACTIVITY_OBJ_ALBUM', NAMESPACE_ACTIVITY_SCHEMA . 'photo-album');
430 define('ACTIVITY_OBJ_EVENT', NAMESPACE_ACTIVITY_SCHEMA . 'event');
431 define('ACTIVITY_OBJ_GROUP', NAMESPACE_ACTIVITY_SCHEMA . 'group');
432 define('ACTIVITY_OBJ_TAGTERM', NAMESPACE_DFRN . '/tagterm');
433 define('ACTIVITY_OBJ_PROFILE', NAMESPACE_DFRN . '/profile');
434 define('ACTIVITY_OBJ_QUESTION', 'http://activityschema.org/object/question');
440 * Item weight for query ordering
443 define('GRAVITY_PARENT', 0);
444 define('GRAVITY_LIKE', 3);
445 define('GRAVITY_COMMENT', 6);
451 * Process priority for the worker
454 define('PRIORITY_UNDEFINED', 0);
455 define('PRIORITY_CRITICAL', 10);
456 define('PRIORITY_HIGH', 20);
457 define('PRIORITY_MEDIUM', 30);
458 define('PRIORITY_LOW', 40);
459 define('PRIORITY_NEGLIGIBLE', 50);
463 * @name Social Relay settings
465 * See here: https://github.com/jaywink/social-relay
466 * and here: https://wiki.diasporafoundation.org/Relay_servers_for_public_posts
469 define('SR_SCOPE_NONE', '');
470 define('SR_SCOPE_ALL', 'all');
471 define('SR_SCOPE_TAGS', 'tags');
475 * Lowest possible date time value
477 define('NULL_DATE', '0001-01-01 00:00:00');
479 // Normally this constant is defined - but not if "pcntl" isn't installed
480 if (!defined("SIGTERM")) {
481 define("SIGTERM", 15);
485 * Depending on the PHP version this constant does exist - or not.
486 * See here: http://php.net/manual/en/curl.constants.php#117928
488 if (!defined('CURLE_OPERATION_TIMEDOUT')) {
489 define('CURLE_OPERATION_TIMEDOUT', CURLE_OPERATION_TIMEOUTED);
492 * Reverse the effect of magic_quotes_gpc if it is enabled.
493 * Please disable magic_quotes_gpc so we don't have to do this.
494 * See http://php.net/manual/en/security.magicquotes.disabling.php
498 error_reporting(E_ERROR | E_WARNING | E_PARSE);
502 // This has to be quite large to deal with embedded private photos
503 ini_set('pcre.backtrack_limit', 500000);
505 if (get_magic_quotes_gpc()) {
506 $process = [&$_GET, &$_POST, &$_COOKIE, &$_REQUEST];
507 while (list($key, $val) = each($process)) {
508 foreach ($val as $k => $v) {
509 unset($process[$key][$k]);
511 $process[$key][stripslashes($k)] = $v;
512 $process[] = &$process[$key][stripslashes($k)];
514 $process[$key][stripslashes($k)] = stripslashes($v);
523 * @brief Retrieve the App structure
525 * Useful in functions which require it but don't get it passed to them
534 $a = new App(dirname(__DIR__));
541 * @brief Multi-purpose function to check variable state.
543 * Usage: x($var) or $x($array, 'key')
545 * returns false if variable/key is not set
546 * if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0.
547 * e.g. x('') or x(0) returns 0;
549 * @param string|array $s variable to check
550 * @param string $k key inside the array to check
554 function x($s, $k = null)
557 if ((is_array($s)) && (array_key_exists($k, $s))) {
576 * Return the provided variable value if it exists and is truthy or the provided
577 * default value instead.
579 * Works with initialized variables and potentially uninitialized array keys
582 * - defaults($var, $default)
583 * - defaults($array, 'key', $default)
585 * @brief Returns a defaut value if the provided variable or array key is falsy
589 function defaults() {
590 $args = func_get_args();
592 if (count($args) < 2) {
593 throw new BadFunctionCallException('defaults() requires at least 2 parameters');
595 if (count($args) > 3) {
596 throw new BadFunctionCallException('defaults() cannot use more than 3 parameters');
598 if (count($args) === 3 && is_null($args[1])) {
599 throw new BadFunctionCallException('defaults($arr, $key, $def) $key is null');
602 $default = array_pop($args);
604 if (call_user_func_array('x', $args)) {
605 if (count($args) === 1) {
608 $return = $args[0][$args[1]];
618 * @brief Returns the baseurl.
620 * @see System::baseUrl()
623 * @TODO Function is deprecated and only used in some addons
627 return System::baseUrl();
631 * @brief Return absolut URL for given $path.
633 * @param string $path given path
637 function absurl($path)
639 if (strpos($path, '/') === 0) {
640 return z_path() . $path;
646 * @brief Function to check if request was an AJAX (xmlhttprequest) request.
652 return (!empty($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest');
656 * @brief Function to check if request was an AJAX (xmlhttprequest) request.
658 * @param boolean $via_worker boolean Is the check run via the worker?
660 function check_db($via_worker)
662 $build = Config::get('system', 'build');
665 Config::set('system', 'build', DB_UPDATE_VERSION - 1);
666 $build = DB_UPDATE_VERSION;
669 // We don't support upgrading from very old versions anymore
670 if ($build < NEW_UPDATE_ROUTINE_VERSION) {
671 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.');
674 if ($build != DB_UPDATE_VERSION) {
675 // When we cannot execute the database update via the worker, we will do it directly
676 if (!Worker::add(PRIORITY_CRITICAL, 'DBUpdate') && $via_worker) {
683 * Sets the base url for use in cmdline programs which don't have
686 * @param object $a App
688 function check_url(App $a)
690 $url = Config::get('system', 'url');
692 // if the url isn't set or the stored url is radically different
693 // than the currently visited url, store the current value accordingly.
694 // "Radically different" ignores common variations such as http vs https
695 // and www.example.com vs example.com.
696 // We will only change the url to an ip address if there is no existing setting
698 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))) {
699 Config::set('system', 'url', System::baseUrl());
706 * @brief Automatic database updates
707 * @param object $a App
711 $build = Config::get('system', 'build');
713 if (empty($build) || ($build > DB_UPDATE_VERSION)) {
714 $build = DB_UPDATE_VERSION - 1;
715 Config::set('system', 'build', $build);
718 if ($build != DB_UPDATE_VERSION) {
719 require_once 'update.php';
721 $stored = intval($build);
722 $current = intval(DB_UPDATE_VERSION);
723 if ($stored < $current) {
724 Config::load('database');
726 // Compare the current structure with the defined structure
727 $t = Config::get('database', 'dbupdate_' . DB_UPDATE_VERSION);
732 Config::set('database', 'dbupdate_' . DB_UPDATE_VERSION, time());
734 // run update routine
735 // it update the structure in one call
736 $retval = DBStructure::update(false, true);
738 DBStructure::updateFail(
744 Config::set('database', 'dbupdate_' . DB_UPDATE_VERSION, 'success');
747 // run any left update_nnnn functions in update.php
748 for ($x = $stored + 1; $x <= $current; $x++) {
749 $r = run_update_function($x);
760 function run_update_function($x)
762 if (function_exists('update_' . $x)) {
763 // There could be a lot of processes running or about to run.
764 // We want exactly one process to run the update command.
765 // So store the fact that we're taking responsibility
766 // after first checking to see if somebody else already has.
767 // If the update fails or times-out completely you may need to
768 // delete the config entry to try again.
770 $t = Config::get('database', 'update_' . $x);
774 Config::set('database', 'update_' . $x, time());
776 // call the specific update
778 $func = 'update_' . $x;
782 //send the administrator an e-mail
783 DBStructure::updateFail(
785 sprintf(t('Update %s failed. See error logs.'), $x)
789 Config::set('database', 'update_' . $x, 'success');
790 Config::set('system', 'build', $x);
794 Config::set('database', 'update_' . $x, 'success');
795 Config::set('system', 'build', $x);
801 * @brief Synchronise addons:
803 * $a->config['system']['addon'] contains a comma-separated list of names
804 * of addons which are used on this system.
805 * Go through the database list of already installed addons, and if we have
806 * an entry, but it isn't in the config list, call the uninstall procedure
807 * and mark it uninstalled in the database (for now we'll remove it).
808 * Then go through the config list and if we have a addon that isn't installed,
809 * call the install procedure and add it to the database.
811 * @param object $a App
813 function check_addons(App $a)
815 $r = q("SELECT * FROM `addon` WHERE `installed` = 1");
816 if (DBM::is_result($r)) {
822 $addons = Config::get('system', 'addon');
826 $addons_arr = explode(',', str_replace(' ', '', $addons));
829 $a->addons = $addons_arr;
833 if (count($installed)) {
834 foreach ($installed as $i) {
835 if (!in_array($i['name'], $addons_arr)) {
836 Addon::uninstall($i['name']);
838 $installed_arr[] = $i['name'];
843 if (count($addons_arr)) {
844 foreach ($addons_arr as $p) {
845 if (!in_array($p, $installed_arr)) {
856 function get_guid($size = 16, $prefix = "")
860 $prefix = hash("crc32", $a->get_hostname());
863 while (strlen($prefix) < ($size - 13)) {
864 $prefix .= mt_rand();
868 $prefix = substr($prefix, 0, $size - 22);
869 return(str_replace(".", "", uniqid($prefix, true)));
871 $prefix = substr($prefix, 0, max($size - 13, 0));
872 return(uniqid($prefix));
877 * @brief Used to end the current process, after saving session state.
881 if (!get_app()->is_backend()) {
882 session_write_close();
889 * @brief Redirect to another URL and terminate this process.
891 function goaway($path)
893 if (strstr(normalise_link($path), 'http://')) {
896 $url = System::baseUrl() . '/' . ltrim($path, '/');
899 header("Location: $url");
904 * @brief Returns the user id of locally logged in user or false.
906 * @return int|bool user id or false
908 function local_user()
910 if (x($_SESSION, 'authenticated') && x($_SESSION, 'uid')) {
911 return intval($_SESSION['uid']);
917 * @brief Returns the public contact id of logged in user or false.
919 * @return int|bool public contact id or false
921 function public_contact()
923 static $public_contact_id = false;
925 if (!$public_contact_id && x($_SESSION, 'authenticated')) {
926 if (x($_SESSION, 'my_address')) {
928 $public_contact_id = intval(Contact::getIdForURL($_SESSION['my_address'], 0));
929 } elseif (x($_SESSION, 'visitor_home')) {
931 $public_contact_id = intval(Contact::getIdForURL($_SESSION['visitor_home'], 0));
933 } elseif (!x($_SESSION, 'authenticated')) {
934 $public_contact_id = false;
937 return $public_contact_id;
941 * @brief Returns contact id of authenticated site visitor or false
943 * @return int|bool visitor_id or false
945 function remote_user()
947 // You cannot be both local and remote
951 if (x($_SESSION, 'authenticated') && x($_SESSION, 'visitor_id')) {
952 return intval($_SESSION['visitor_id']);
958 * @brief Show an error message to user.
960 * This function save text in session, to be shown to the user at next page load
962 * @param string $s - Text of notice
967 if (!x($_SESSION, 'sysmsg')) {
968 $_SESSION['sysmsg'] = [];
970 if ($a->interactive) {
971 $_SESSION['sysmsg'][] = $s;
976 * @brief Show an info message to user.
978 * This function save text in session, to be shown to the user at next page load
980 * @param string $s - Text of notice
986 if (local_user() && PConfig::get(local_user(), 'system', 'ignore_info')) {
990 if (!x($_SESSION, 'sysmsg_info')) {
991 $_SESSION['sysmsg_info'] = [];
993 if ($a->interactive) {
994 $_SESSION['sysmsg_info'][] = $s;
999 * @brief Wrapper around config to limit the text length of an incoming message
1003 function get_max_import_size()
1006 return (x($a->config, 'max_import_size') ? $a->config['max_import_size'] : 0);
1010 function current_theme()
1012 $app_base_themes = ['duepuntozero', 'dispy', 'quattro'];
1018 // Find the theme that belongs to the user whose stuff we are looking at
1020 if ($a->profile_uid && ($a->profile_uid != local_user())) {
1022 "select theme from user where uid = %d limit 1",
1023 intval($a->profile_uid)
1025 if (DBM::is_result($r)) {
1026 $page_theme = $r[0]['theme'];
1030 // Allow folks to over-rule user themes and always use their own on their own site.
1031 // This works only if the user is on the same server
1033 if ($page_theme && local_user() && (local_user() != $a->profile_uid)) {
1034 if (PConfig::get(local_user(), 'system', 'always_my_theme')) {
1039 // $mobile_detect = new Mobile_Detect();
1040 // $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
1041 $is_mobile = $a->is_mobile || $a->is_tablet;
1043 $standard_system_theme = Config::get('system', 'theme', '');
1044 $standard_theme_name = ((isset($_SESSION) && x($_SESSION, 'theme')) ? $_SESSION['theme'] : $standard_system_theme);
1047 if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
1048 $theme_name = $standard_theme_name;
1050 $system_theme = Config::get('system', 'mobile-theme', '');
1051 if ($system_theme == '') {
1052 $system_theme = $standard_system_theme;
1054 $theme_name = ((isset($_SESSION) && x($_SESSION, 'mobile-theme')) ? $_SESSION['mobile-theme'] : $system_theme);
1056 if ($theme_name === '---') {
1057 // user has selected to have the mobile theme be the same as the normal one
1058 $theme_name = $standard_theme_name;
1061 $theme_name = $page_theme;
1066 $theme_name = $standard_theme_name;
1069 $theme_name = $page_theme;
1074 && (file_exists('view/theme/' . $theme_name . '/style.css')
1075 || file_exists('view/theme/' . $theme_name . '/style.php'))
1077 return($theme_name);
1080 foreach ($app_base_themes as $t) {
1081 if (file_exists('view/theme/' . $t . '/style.css')
1082 || file_exists('view/theme/' . $t . '/style.php')
1088 $fallback = array_merge(glob('view/theme/*/style.css'), glob('view/theme/*/style.php'));
1089 if (count($fallback)) {
1090 return (str_replace('view/theme/', '', substr($fallback[0], 0, -10)));
1093 /// @TODO No final return statement?
1097 * @brief Return full URL to theme which is currently in effect.
1099 * Provide a sane default if nothing is chosen or the specified theme does not exist.
1103 function current_theme_url()
1107 $t = current_theme();
1109 $opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : '');
1110 if (file_exists('view/theme/' . $t . '/style.php')) {
1111 return('view/theme/' . $t . '/style.pcss' . $opts);
1114 return('view/theme/' . $t . '/style.css');
1117 function feed_birthday($uid, $tz)
1120 * Determine the next birthday, but only if the birthday is published
1121 * in the default profile. We _could_ also look for a private profile that the
1122 * recipient can see, but somebody could get mad at us if they start getting
1123 * public birthday greetings when they haven't made this info public.
1125 * Assuming we are able to publish this info, we are then going to convert
1126 * the start time from the owner's timezone to UTC.
1128 * This will potentially solve the problem found with some social networks
1129 * where birthdays are converted to the viewer's timezone and salutations from
1130 * elsewhere in the world show up on the wrong day. We will convert it to the
1131 * viewer's timezone also, but first we are going to convert it from the birthday
1132 * person's timezone to GMT - so the viewer may find the birthday starting at
1133 * 6:00PM the day before, but that will correspond to midnight to the birthday person.
1142 "SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1",
1146 if (DBM::is_result($p)) {
1147 $tmp_dob = substr($p[0]['dob'], 5);
1148 if (intval($tmp_dob)) {
1149 $y = datetime_convert($tz, $tz, 'now', 'Y');
1150 $bd = $y . '-' . $tmp_dob . ' 00:00';
1151 $t_dob = strtotime($bd);
1152 $now = strtotime(datetime_convert($tz, $tz, 'now'));
1153 if ($t_dob < $now) {
1154 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
1156 $birthday = datetime_convert($tz, 'UTC', $bd, ATOM_TIME);
1164 * @brief Check if current user has admin role.
1166 * @return bool true if user is an admin
1168 function is_site_admin()
1172 $adminlist = explode(",", str_replace(" ", "", $a->config['admin_email']));
1174 //if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && ($a->user['email'] === $a->config['admin_email']))
1175 if (local_user() && x($a->user, 'email') && x($a->config, 'admin_email') && in_array($a->user['email'], $adminlist)) {
1182 * @brief Returns querystring as string from a mapped array.
1184 * @param array $params mapped array with query parameters
1185 * @param string $name of parameter, default null
1189 function build_querystring($params, $name = null)
1192 foreach ($params as $key => $val) {
1193 if (is_array($val)) {
1194 /// @TODO maybe not compare against null, use is_null()
1195 if ($name == null) {
1196 $ret .= build_querystring($val, $key);
1198 $ret .= build_querystring($val, $name . "[$key]");
1201 $val = urlencode($val);
1202 /// @TODO maybe not compare against null, use is_null()
1203 if ($name != null) {
1204 /// @TODO two string concated, can be merged to one
1205 $ret .= $name . "[$key]" . "=$val&";
1207 $ret .= "$key=$val&";
1214 function explode_querystring($query)
1216 $arg_st = strpos($query, '?');
1217 if ($arg_st !== false) {
1218 $base = substr($query, 0, $arg_st);
1225 $args = explode('&', substr($query, $arg_st));
1226 foreach ($args as $k => $arg) {
1227 /// @TODO really compare type-safe here?
1232 $args = array_values($args);
1237 $args = array_values($args);
1247 * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
1249 * Taken from http://webcheatsheet.com/php/get_current_page_url.php
1251 function curPageURL()
1254 if ($_SERVER["HTTPS"] == "on") {
1260 if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
1261 $pageURL .= $_SERVER["SERVER_NAME"] . ":" . $_SERVER["SERVER_PORT"] . $_SERVER["REQUEST_URI"];
1263 $pageURL .= $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"];
1268 function random_digits($digits)
1271 for ($i = 0; $i < $digits; $i++) {
1272 /// @TODO rand() is different to mt_rand() and maybe lesser "random"
1278 function get_server()
1280 $server = Config::get("system", "directory");
1282 if ($server == "") {
1283 $server = "http://dir.friendica.social";
1289 function get_temppath()
1293 $temppath = Config::get("system", "temppath");
1295 if (($temppath != "") && App::directory_usable($temppath)) {
1296 // We have a temp path and it is usable
1297 return App::realpath($temppath);
1300 // We don't have a working preconfigured temp path, so we take the system path.
1301 $temppath = sys_get_temp_dir();
1303 // Check if it is usable
1304 if (($temppath != "") && App::directory_usable($temppath)) {
1305 // Always store the real path, not the path through symlinks
1306 $temppath = App::realpath($temppath);
1308 // To avoid any interferences with other systems we create our own directory
1309 $new_temppath = $temppath . "/" . $a->get_hostname();
1310 if (!is_dir($new_temppath)) {
1311 /// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
1312 mkdir($new_temppath);
1315 if (App::directory_usable($new_temppath)) {
1316 // The new path is usable, we are happy
1317 Config::set("system", "temppath", $new_temppath);
1318 return $new_temppath;
1320 // We can't create a subdirectory, strange.
1321 // But the directory seems to work, so we use it but don't store it.
1326 // Reaching this point means that the operating system is configured badly.
1330 function get_cachefile($file, $writemode = true)
1332 $cache = get_itemcachepath();
1334 if ((!$cache) || (!is_dir($cache))) {
1338 $subfolder = $cache . "/" . substr($file, 0, 2);
1340 $cachepath = $subfolder . "/" . $file;
1343 if (!is_dir($subfolder)) {
1345 chmod($subfolder, 0777);
1349 /// @TODO no need to put braces here
1353 function clear_cache($basepath = "", $path = "")
1356 $basepath = get_itemcachepath();
1360 if (($path == "") || (!is_dir($path))) {
1364 if (substr(realpath($path), 0, strlen($basepath)) != $basepath) {
1368 $cachetime = (int) Config::get('system', 'itemcache_duration');
1369 if ($cachetime == 0) {
1373 if (is_writable($path)) {
1374 if ($dh = opendir($path)) {
1375 while (($file = readdir($dh)) !== false) {
1376 $fullpath = $path . "/" . $file;
1377 if ((filetype($fullpath) == "dir") && ($file != ".") && ($file != "..")) {
1378 clear_cache($basepath, $fullpath);
1380 if ((filetype($fullpath) == "file") && (filectime($fullpath) < (time() - $cachetime))) {
1389 function get_itemcachepath()
1391 // Checking, if the cache is deactivated
1392 $cachetime = (int) Config::get('system', 'itemcache_duration');
1393 if ($cachetime < 0) {
1397 $itemcache = Config::get('system', 'itemcache');
1398 if (($itemcache != "") && App::directory_usable($itemcache)) {
1399 return App::realpath($itemcache);
1402 $temppath = get_temppath();
1404 if ($temppath != "") {
1405 $itemcache = $temppath . "/itemcache";
1406 if (!file_exists($itemcache) && !is_dir($itemcache)) {
1410 if (App::directory_usable($itemcache)) {
1411 Config::set("system", "itemcache", $itemcache);
1419 * @brief Returns the path where spool files are stored
1421 * @return string Spool path
1423 function get_spoolpath()
1425 $spoolpath = Config::get('system', 'spoolpath');
1426 if (($spoolpath != "") && App::directory_usable($spoolpath)) {
1427 // We have a spool path and it is usable
1431 // We don't have a working preconfigured spool path, so we take the temp path.
1432 $temppath = get_temppath();
1434 if ($temppath != "") {
1435 // To avoid any interferences with other systems we create our own directory
1436 $spoolpath = $temppath . "/spool";
1437 if (!is_dir($spoolpath)) {
1441 if (App::directory_usable($spoolpath)) {
1442 // The new path is usable, we are happy
1443 Config::set("system", "spoolpath", $spoolpath);
1446 // We can't create a subdirectory, strange.
1447 // But the directory seems to work, so we use it but don't store it.
1452 // Reaching this point means that the operating system is configured badly.
1457 if (!function_exists('exif_imagetype')) {
1458 function exif_imagetype($file)
1460 $size = getimagesize($file);
1465 function validate_include(&$file)
1469 $file = realpath($file);
1471 if (strpos($file, getcwd()) !== 0) {
1475 $file = str_replace(getcwd() . "/", "", $file, $count);
1480 if ($orig_file !== $file) {
1485 if (strpos($file, "include/") === 0) {
1489 if (strpos($file, "addon/") === 0) {
1493 // Simply return flag
1497 function current_load()
1499 if (!function_exists('sys_getloadavg')) {
1503 $load_arr = sys_getloadavg();
1505 if (!is_array($load_arr)) {
1509 return max($load_arr[0], $load_arr[1]);
1513 * @brief get c-style args
1519 return get_app()->argc;
1523 * @brief Returns the value of a argv key
1525 * @param int $x argv key
1526 * @return string Value of the argv key
1530 if (array_key_exists($x, get_app()->argv)) {
1531 return get_app()->argv[$x];
1538 * @brief Get the data which is needed for infinite scroll
1540 * For invinite scroll we need the page number of the actual page
1541 * and the the URI where the content of the next page comes from.
1542 * This data is needed for the js part in main.js.
1543 * Note: infinite scroll does only work for the network page (module)
1545 * @param string $module The name of the module (e.g. "network")
1546 * @return array Of infinite scroll data
1547 * 'pageno' => $pageno The number of the actual page
1548 * 'reload_uri' => $reload_uri The URI of the content we have to load
1550 function infinite_scroll_data($module)
1552 if (PConfig::get(local_user(), 'system', 'infinite_scroll')
1553 && $module == 'network'
1554 && defaults($_GET, 'mode', '') != 'minimal'
1556 // get the page number
1557 $pageno = defaults($_GET, 'page', 1);
1561 // try to get the uri from which we load the content
1562 foreach ($_GET as $param => $value) {
1563 if (($param != "page") && ($param != "q")) {
1564 $reload_uri .= "&" . $param . "=" . urlencode($value);
1569 if ($a->page_offset != "" && !strstr($reload_uri, "&offset=")) {
1570 $reload_uri .= "&offset=" . urlencode($a->page_offset);
1573 $arr = ["pageno" => $pageno, "reload_uri" => $reload_uri];