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\Core\Addon;
24 use Friendica\Core\Config;
25 use Friendica\Core\L10n;
26 use Friendica\Core\Network;
27 use Friendica\Core\PConfig;
28 use Friendica\Core\System;
29 use Friendica\Core\Worker;
30 use Friendica\Database\DBM;
31 use Friendica\Database\DBStructure;
32 use Friendica\Model\Contact;
33 use Friendica\Util\DateTimeFormat;
35 require_once 'include/text.php';
37 define('FRIENDICA_PLATFORM', 'Friendica');
38 define('FRIENDICA_CODENAME', 'Asparagus');
39 define('FRIENDICA_VERSION', '3.6-dev');
40 define('DFRN_PROTOCOL_VERSION', '2.23');
41 define('DB_UPDATE_VERSION', 1248);
42 define('NEW_UPDATE_ROUTINE_VERSION', 1170);
45 * @brief Constants for the database update check
47 const DB_UPDATE_NOT_CHECKED = 0; // Database check wasn't executed before
48 const DB_UPDATE_SUCCESSFUL = 1; // Database check was successful
49 const DB_UPDATE_FAILED = 2; // Database check failed
52 * @brief Constant with a HTML line break.
54 * Contains a HTML line break (br) element and a real carriage return with line
55 * feed for the source.
56 * This can be used in HTML and JavaScript where needed a line break.
58 define('EOL', "<br />\r\n");
61 * @brief Image storage quality.
63 * Lower numbers save space at cost of image detail.
64 * For ease of upgrade, please do not change here. Change jpeg quality with
65 * $a->config['system']['jpeg_quality'] = n;
66 * in .htconfig.php, where n is netween 1 and 100, and with very poor results
69 define('JPEG_QUALITY', 100);
72 * $a->config['system']['png_quality'] from 0 (uncompressed) to 9
74 define('PNG_QUALITY', 8);
77 * An alternate way of limiting picture upload sizes. Specify the maximum pixel
78 * length that pictures are allowed to be (for non-square pictures, it will apply
79 * to the longest side). Pictures longer than this length will be resized to be
80 * this length (on the longest side, the other side will be scaled appropriately).
81 * Modify this value using
83 * $a->config['system']['max_image_length'] = n;
87 * If you don't want to set a maximum length, set to -1. The default value is
88 * defined by 'MAX_IMAGE_LENGTH' below.
90 define('MAX_IMAGE_LENGTH', -1);
95 define('DEFAULT_DB_ENGINE', 'InnoDB');
100 * SSL redirection policies
103 define('SSL_POLICY_NONE', 0);
104 define('SSL_POLICY_FULL', 1);
105 define('SSL_POLICY_SELFSIGN', 2);
114 define('LOGGER_NORMAL', 0);
115 define('LOGGER_TRACE', 1);
116 define('LOGGER_DEBUG', 2);
117 define('LOGGER_DATA', 3);
118 define('LOGGER_ALL', 4);
127 define('CACHE_MONTH', 0);
128 define('CACHE_WEEK', 1);
129 define('CACHE_DAY', 2);
130 define('CACHE_HOUR', 3);
131 define('CACHE_HALF_HOUR', 4);
132 define('CACHE_QUARTER_HOUR', 5);
133 define('CACHE_FIVE_MINUTES', 6);
134 define('CACHE_MINUTE', 7);
140 * Registration policies
143 define('REGISTER_CLOSED', 0);
144 define('REGISTER_APPROVE', 1);
145 define('REGISTER_OPEN', 2);
156 define('CONTACT_IS_FOLLOWER', 1);
157 define('CONTACT_IS_SHARING', 2);
158 define('CONTACT_IS_FRIEND', 3);
166 * DB update return values
169 define('UPDATE_SUCCESS', 0);
170 define('UPDATE_FAILED', 1);
176 * @name page/profile types
178 * PAGE_NORMAL is a typical personal profile account
179 * PAGE_SOAPBOX automatically approves all friend requests as CONTACT_IS_SHARING, (readonly)
180 * PAGE_COMMUNITY automatically approves all friend requests as CONTACT_IS_SHARING, but with
181 * write access to wall and comments (no email and not included in page owner's ACL lists)
182 * PAGE_FREELOVE automatically approves all friend requests as full friends (CONTACT_IS_FRIEND).
186 define('PAGE_NORMAL', 0);
187 define('PAGE_SOAPBOX', 1);
188 define('PAGE_COMMUNITY', 2);
189 define('PAGE_FREELOVE', 3);
190 define('PAGE_BLOG', 4);
191 define('PAGE_PRVGROUP', 5);
197 * @name account types
199 * ACCOUNT_TYPE_PERSON - the account belongs to a person
200 * Associated page types: PAGE_NORMAL, PAGE_SOAPBOX, PAGE_FREELOVE
202 * ACCOUNT_TYPE_ORGANISATION - the account belongs to an organisation
203 * Associated page type: PAGE_SOAPBOX
205 * ACCOUNT_TYPE_NEWS - the account is a news reflector
206 * Associated page type: PAGE_SOAPBOX
208 * ACCOUNT_TYPE_COMMUNITY - the account is community forum
209 * Associated page types: PAGE_COMMUNITY, PAGE_PRVGROUP
212 define('ACCOUNT_TYPE_PERSON', 0);
213 define('ACCOUNT_TYPE_ORGANISATION', 1);
214 define('ACCOUNT_TYPE_NEWS', 2);
215 define('ACCOUNT_TYPE_COMMUNITY', 3);
223 * Type of the community page
226 define('CP_NO_COMMUNITY_PAGE', -1);
227 define('CP_USERS_ON_SERVER', 0);
228 define('CP_GLOBAL_COMMUNITY', 1);
229 define('CP_USERS_AND_GLOBAL', 2);
237 * Different protocols that we are storing
240 define('PROTOCOL_UNKNOWN', 0);
241 define('PROTOCOL_DFRN', 1);
242 define('PROTOCOL_DIASPORA', 2);
243 define('PROTOCOL_OSTATUS_SALMON', 3);
244 define('PROTOCOL_OSTATUS_FEED', 4); // Deprecated
245 define('PROTOCOL_GS_CONVERSATION', 5); // Deprecated
246 define('PROTOCOL_SPLITTED_CONV', 6);
254 * Network and protocol family types
257 define('NETWORK_DFRN' , Network::DFRN); // Friendica, Mistpark, other DFRN implementations
258 define('NETWORK_ZOT' , Network::ZOT); // Zot! - Currently unsupported
259 define('NETWORK_OSTATUS' , Network::OSTATUS); // GNU-social, Pleroma, Mastodon, other OStatus implementations
260 define('NETWORK_FEED' , Network::FEED); // RSS/Atom feeds with no known "post/notify" protocol
261 define('NETWORK_DIASPORA' , Network::DIASPORA); // Diaspora
262 define('NETWORK_MAIL' , Network::MAIL); // IMAP/POP
263 define('NETWORK_FACEBOOK' , Network::FACEBOOK); // Facebook API
264 define('NETWORK_LINKEDIN' , Network::LINKEDIN); // LinkedIn
265 define('NETWORK_XMPP' , Network::XMPP); // XMPP - Currently unsupported
266 define('NETWORK_MYSPACE' , Network::MYSPACE); // MySpace - Currently unsupported
267 define('NETWORK_GPLUS' , Network::GPLUS); // Google+
268 define('NETWORK_PUMPIO' , Network::PUMPIO); // pump.io
269 define('NETWORK_TWITTER' , Network::TWITTER); // Twitter
270 define('NETWORK_DIASPORA2', Network::DIASPORA2); // Diaspora connector
271 define('NETWORK_STATUSNET', Network::STATUSNET); // Statusnet connector
272 define('NETWORK_APPNET' , Network::APPNET); // app.net - Dead protocol
273 define('NETWORK_NEWS' , Network::NEWS); // Network News Transfer Protocol - Currently unsupported
274 define('NETWORK_ICALENDAR', Network::ICALENDAR); // iCalendar - Currently unsupported
275 define('NETWORK_PNUT' , Network::PNUT); // pnut.io - Currently unsupported
276 define('NETWORK_PHANTOM' , Network::PHANTOM); // Place holder
282 * These numbers are used in stored permissions
283 * and existing allocations MUST NEVER BE CHANGED
284 * OR RE-ASSIGNED! You may only add to them.
287 NETWORK_DFRN => (-1),
289 NETWORK_OSTATUS => (-3),
290 NETWORK_FEED => (-4),
291 NETWORK_DIASPORA => (-5),
292 NETWORK_MAIL => (-6),
293 NETWORK_FACEBOOK => (-8),
294 NETWORK_LINKEDIN => (-9),
295 NETWORK_XMPP => (-10),
296 NETWORK_MYSPACE => (-11),
297 NETWORK_GPLUS => (-12),
298 NETWORK_PUMPIO => (-13),
299 NETWORK_TWITTER => (-14),
300 NETWORK_DIASPORA2 => (-15),
301 NETWORK_STATUSNET => (-16),
302 NETWORK_APPNET => (-17),
303 NETWORK_NEWS => (-18),
304 NETWORK_ICALENDAR => (-19),
305 NETWORK_PNUT => (-20),
307 NETWORK_PHANTOM => (-127),
311 * Maximum number of "people who like (or don't like) this" that we will list by name
313 define('MAX_LIKERS', 75);
316 * Communication timeout
318 define('ZCURL_TIMEOUT', (-1));
323 * Email notification options
326 define('NOTIFY_INTRO', 0x0001);
327 define('NOTIFY_CONFIRM', 0x0002);
328 define('NOTIFY_WALL', 0x0004);
329 define('NOTIFY_COMMENT', 0x0008);
330 define('NOTIFY_MAIL', 0x0010);
331 define('NOTIFY_SUGGEST', 0x0020);
332 define('NOTIFY_PROFILE', 0x0040);
333 define('NOTIFY_TAGSELF', 0x0080);
334 define('NOTIFY_TAGSHARE', 0x0100);
335 define('NOTIFY_POKE', 0x0200);
336 define('NOTIFY_SHARE', 0x0400);
338 define('SYSTEM_EMAIL', 0x4000);
340 define('NOTIFY_SYSTEM', 0x8000);
350 define('TERM_UNKNOWN', 0);
351 define('TERM_HASHTAG', 1);
352 define('TERM_MENTION', 2);
353 define('TERM_CATEGORY', 3);
354 define('TERM_PCATEGORY', 4);
355 define('TERM_FILE', 5);
356 define('TERM_SAVEDSEARCH', 6);
357 define('TERM_CONVERSATION', 7);
359 define('TERM_OBJ_POST', 1);
360 define('TERM_OBJ_PHOTO', 2);
365 * Various namespaces we may need to parse
368 define('NAMESPACE_ZOT', 'http://purl.org/zot');
369 define('NAMESPACE_DFRN', 'http://purl.org/macgirvin/dfrn/1.0');
370 define('NAMESPACE_THREAD', 'http://purl.org/syndication/thread/1.0');
371 define('NAMESPACE_TOMB', 'http://purl.org/atompub/tombstones/1.0');
372 define('NAMESPACE_ACTIVITY', 'http://activitystrea.ms/spec/1.0/');
373 define('NAMESPACE_ACTIVITY_SCHEMA', 'http://activitystrea.ms/schema/1.0/');
374 define('NAMESPACE_MEDIA', 'http://purl.org/syndication/atommedia');
375 define('NAMESPACE_SALMON_ME', 'http://salmon-protocol.org/ns/magic-env');
376 define('NAMESPACE_OSTATUSSUB', 'http://ostatus.org/schema/1.0/subscribe');
377 define('NAMESPACE_GEORSS', 'http://www.georss.org/georss');
378 define('NAMESPACE_POCO', 'http://portablecontacts.net/spec/1.0');
379 define('NAMESPACE_FEED', 'http://schemas.google.com/g/2010#updates-from');
380 define('NAMESPACE_OSTATUS', 'http://ostatus.org/schema/1.0');
381 define('NAMESPACE_STATUSNET', 'http://status.net/schema/api/1/');
382 define('NAMESPACE_ATOM1', 'http://www.w3.org/2005/Atom');
383 define('NAMESPACE_MASTODON', 'http://mastodon.social/schema/1.0');
389 * Activity stream defines
392 define('ACTIVITY_LIKE', NAMESPACE_ACTIVITY_SCHEMA . 'like');
393 define('ACTIVITY_DISLIKE', NAMESPACE_DFRN . '/dislike');
394 define('ACTIVITY_ATTEND', NAMESPACE_ZOT . '/activity/attendyes');
395 define('ACTIVITY_ATTENDNO', NAMESPACE_ZOT . '/activity/attendno');
396 define('ACTIVITY_ATTENDMAYBE', NAMESPACE_ZOT . '/activity/attendmaybe');
398 define('ACTIVITY_OBJ_HEART', NAMESPACE_DFRN . '/heart');
400 define('ACTIVITY_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'make-friend');
401 define('ACTIVITY_REQ_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'request-friend');
402 define('ACTIVITY_UNFRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'remove-friend');
403 define('ACTIVITY_FOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'follow');
404 define('ACTIVITY_UNFOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'stop-following');
405 define('ACTIVITY_JOIN', NAMESPACE_ACTIVITY_SCHEMA . 'join');
407 define('ACTIVITY_POST', NAMESPACE_ACTIVITY_SCHEMA . 'post');
408 define('ACTIVITY_UPDATE', NAMESPACE_ACTIVITY_SCHEMA . 'update');
409 define('ACTIVITY_TAG', NAMESPACE_ACTIVITY_SCHEMA . 'tag');
410 define('ACTIVITY_FAVORITE', NAMESPACE_ACTIVITY_SCHEMA . 'favorite');
411 define('ACTIVITY_UNFAVORITE', NAMESPACE_ACTIVITY_SCHEMA . 'unfavorite');
412 define('ACTIVITY_SHARE', NAMESPACE_ACTIVITY_SCHEMA . 'share');
413 define('ACTIVITY_DELETE', NAMESPACE_ACTIVITY_SCHEMA . 'delete');
415 define('ACTIVITY_POKE', NAMESPACE_ZOT . '/activity/poke');
417 define('ACTIVITY_OBJ_BOOKMARK', NAMESPACE_ACTIVITY_SCHEMA . 'bookmark');
418 define('ACTIVITY_OBJ_COMMENT', NAMESPACE_ACTIVITY_SCHEMA . 'comment');
419 define('ACTIVITY_OBJ_NOTE', NAMESPACE_ACTIVITY_SCHEMA . 'note');
420 define('ACTIVITY_OBJ_PERSON', NAMESPACE_ACTIVITY_SCHEMA . 'person');
421 define('ACTIVITY_OBJ_IMAGE', NAMESPACE_ACTIVITY_SCHEMA . 'image');
422 define('ACTIVITY_OBJ_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'photo');
423 define('ACTIVITY_OBJ_VIDEO', NAMESPACE_ACTIVITY_SCHEMA . 'video');
424 define('ACTIVITY_OBJ_P_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'profile-photo');
425 define('ACTIVITY_OBJ_ALBUM', NAMESPACE_ACTIVITY_SCHEMA . 'photo-album');
426 define('ACTIVITY_OBJ_EVENT', NAMESPACE_ACTIVITY_SCHEMA . 'event');
427 define('ACTIVITY_OBJ_GROUP', NAMESPACE_ACTIVITY_SCHEMA . 'group');
428 define('ACTIVITY_OBJ_TAGTERM', NAMESPACE_DFRN . '/tagterm');
429 define('ACTIVITY_OBJ_PROFILE', NAMESPACE_DFRN . '/profile');
430 define('ACTIVITY_OBJ_QUESTION', 'http://activityschema.org/object/question');
436 * Item weight for query ordering
439 define('GRAVITY_PARENT', 0);
440 define('GRAVITY_LIKE', 3);
441 define('GRAVITY_COMMENT', 6);
447 * Process priority for the worker
450 define('PRIORITY_UNDEFINED', 0);
451 define('PRIORITY_CRITICAL', 10);
452 define('PRIORITY_HIGH', 20);
453 define('PRIORITY_MEDIUM', 30);
454 define('PRIORITY_LOW', 40);
455 define('PRIORITY_NEGLIGIBLE', 50);
459 * @name Social Relay settings
461 * See here: https://github.com/jaywink/social-relay
462 * and here: https://wiki.diasporafoundation.org/Relay_servers_for_public_posts
465 define('SR_SCOPE_NONE', '');
466 define('SR_SCOPE_ALL', 'all');
467 define('SR_SCOPE_TAGS', 'tags');
471 * Lowest possible date time value
473 define('NULL_DATE', '0001-01-01 00:00:00');
475 // Normally this constant is defined - but not if "pcntl" isn't installed
476 if (!defined("SIGTERM")) {
477 define("SIGTERM", 15);
481 * Depending on the PHP version this constant does exist - or not.
482 * See here: http://php.net/manual/en/curl.constants.php#117928
484 if (!defined('CURLE_OPERATION_TIMEDOUT')) {
485 define('CURLE_OPERATION_TIMEDOUT', CURLE_OPERATION_TIMEOUTED);
488 * Reverse the effect of magic_quotes_gpc if it is enabled.
489 * Please disable magic_quotes_gpc so we don't have to do this.
490 * See http://php.net/manual/en/security.magicquotes.disabling.php
494 error_reporting(E_ERROR | E_WARNING | E_PARSE);
498 // This has to be quite large to deal with embedded private photos
499 ini_set('pcre.backtrack_limit', 500000);
501 if (get_magic_quotes_gpc()) {
502 $process = [&$_GET, &$_POST, &$_COOKIE, &$_REQUEST];
503 while (list($key, $val) = each($process)) {
504 foreach ($val as $k => $v) {
505 unset($process[$key][$k]);
507 $process[$key][stripslashes($k)] = $v;
508 $process[] = &$process[$key][stripslashes($k)];
510 $process[$key][stripslashes($k)] = stripslashes($v);
519 * @brief Retrieve the App structure
521 * Useful in functions which require it but don't get it passed to them
530 $a = new App(dirname(__DIR__));
537 * @brief Multi-purpose function to check variable state.
539 * Usage: x($var) or $x($array, 'key')
541 * returns false if variable/key is not set
542 * if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0.
543 * e.g. x('') or x(0) returns 0;
545 * @param string|array $s variable to check
546 * @param string $k key inside the array to check
550 function x($s, $k = null)
553 if ((is_array($s)) && (array_key_exists($k, $s))) {
572 * Return the provided variable value if it exists and is truthy or the provided
573 * default value instead.
575 * Works with initialized variables and potentially uninitialized array keys
578 * - defaults($var, $default)
579 * - defaults($array, 'key', $default)
581 * @brief Returns a defaut value if the provided variable or array key is falsy
585 function defaults() {
586 $args = func_get_args();
588 if (count($args) < 2) {
589 throw new BadFunctionCallException('defaults() requires at least 2 parameters');
591 if (count($args) > 3) {
592 throw new BadFunctionCallException('defaults() cannot use more than 3 parameters');
594 if (count($args) === 3 && is_null($args[1])) {
595 throw new BadFunctionCallException('defaults($arr, $key, $def) $key is null');
598 $default = array_pop($args);
600 if (call_user_func_array('x', $args)) {
601 if (count($args) === 1) {
604 $return = $args[0][$args[1]];
614 * @brief Returns the baseurl.
616 * @see System::baseUrl()
619 * @TODO Function is deprecated and only used in some addons
623 return System::baseUrl();
627 * @brief Return absolut URL for given $path.
629 * @param string $path given path
633 function absurl($path)
635 if (strpos($path, '/') === 0) {
636 return z_path() . $path;
642 * @brief Function to check if request was an AJAX (xmlhttprequest) request.
648 return (!empty($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest');
652 * @brief Function to check if request was an AJAX (xmlhttprequest) request.
654 * @param boolean $via_worker boolean Is the check run via the worker?
656 function check_db($via_worker)
658 $build = Config::get('system', 'build');
661 Config::set('system', 'build', DB_UPDATE_VERSION - 1);
662 $build = DB_UPDATE_VERSION;
665 // We don't support upgrading from very old versions anymore
666 if ($build < NEW_UPDATE_ROUTINE_VERSION) {
667 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.');
670 if ($build != DB_UPDATE_VERSION) {
671 // When we cannot execute the database update via the worker, we will do it directly
672 if (!Worker::add(PRIORITY_CRITICAL, 'DBUpdate') && $via_worker) {
679 * Sets the base url for use in cmdline programs which don't have
682 * @param object $a App
684 function check_url(App $a)
686 $url = Config::get('system', 'url');
688 // if the url isn't set or the stored url is radically different
689 // than the currently visited url, store the current value accordingly.
690 // "Radically different" ignores common variations such as http vs https
691 // and www.example.com vs example.com.
692 // We will only change the url to an ip address if there is no existing setting
694 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))) {
695 Config::set('system', 'url', System::baseUrl());
702 * @brief Automatic database updates
703 * @param object $a App
707 $build = Config::get('system', 'build');
709 if (empty($build) || ($build > DB_UPDATE_VERSION)) {
710 $build = DB_UPDATE_VERSION - 1;
711 Config::set('system', 'build', $build);
714 if ($build != DB_UPDATE_VERSION) {
715 require_once 'update.php';
717 $stored = intval($build);
718 $current = intval(DB_UPDATE_VERSION);
719 if ($stored < $current) {
720 Config::load('database');
722 // Compare the current structure with the defined structure
723 $t = Config::get('database', 'dbupdate_' . DB_UPDATE_VERSION);
728 Config::set('database', 'dbupdate_' . DB_UPDATE_VERSION, time());
730 // run update routine
731 // it update the structure in one call
732 $retval = DBStructure::update(false, true);
734 DBStructure::updateFail(
740 Config::set('database', 'dbupdate_' . DB_UPDATE_VERSION, 'success');
743 // run any left update_nnnn functions in update.php
744 for ($x = $stored + 1; $x <= $current; $x++) {
745 $r = run_update_function($x);
756 function run_update_function($x)
758 if (function_exists('update_' . $x)) {
759 // There could be a lot of processes running or about to run.
760 // We want exactly one process to run the update command.
761 // So store the fact that we're taking responsibility
762 // after first checking to see if somebody else already has.
763 // If the update fails or times-out completely you may need to
764 // delete the config entry to try again.
766 $t = Config::get('database', 'update_' . $x);
770 Config::set('database', 'update_' . $x, time());
772 // call the specific update
774 $func = 'update_' . $x;
778 //send the administrator an e-mail
779 DBStructure::updateFail(
781 L10n::t('Update %s failed. See error logs.', $x)
785 Config::set('database', 'update_' . $x, 'success');
786 Config::set('system', 'build', $x);
790 Config::set('database', 'update_' . $x, 'success');
791 Config::set('system', 'build', $x);
797 * @brief Synchronise addons:
799 * $a->config['system']['addon'] contains a comma-separated list of names
800 * of addons which are used on this system.
801 * Go through the database list of already installed addons, and if we have
802 * an entry, but it isn't in the config list, call the uninstall procedure
803 * and mark it uninstalled in the database (for now we'll remove it).
804 * Then go through the config list and if we have a addon that isn't installed,
805 * call the install procedure and add it to the database.
807 * @param object $a App
809 function check_addons(App $a)
811 $r = q("SELECT * FROM `addon` WHERE `installed` = 1");
812 if (DBM::is_result($r)) {
818 $addons = Config::get('system', 'addon');
822 $addons_arr = explode(',', str_replace(' ', '', $addons));
825 $a->addons = $addons_arr;
829 if (count($installed)) {
830 foreach ($installed as $i) {
831 if (!in_array($i['name'], $addons_arr)) {
832 Addon::uninstall($i['name']);
834 $installed_arr[] = $i['name'];
839 if (count($addons_arr)) {
840 foreach ($addons_arr as $p) {
841 if (!in_array($p, $installed_arr)) {
852 function get_guid($size = 16, $prefix = "")
856 $prefix = hash("crc32", $a->get_hostname());
859 while (strlen($prefix) < ($size - 13)) {
860 $prefix .= mt_rand();
864 $prefix = substr($prefix, 0, $size - 22);
865 return(str_replace(".", "", uniqid($prefix, true)));
867 $prefix = substr($prefix, 0, max($size - 13, 0));
868 return(uniqid($prefix));
873 * @brief Used to end the current process, after saving session state.
882 * @brief Redirect to another URL and terminate this process.
884 function goaway($path)
886 if (strstr(normalise_link($path), 'http://')) {
889 $url = System::baseUrl() . '/' . ltrim($path, '/');
892 header("Location: $url");
897 * @brief Returns the user id of locally logged in user or false.
899 * @return int|bool user id or false
901 function local_user()
903 if (x($_SESSION, 'authenticated') && x($_SESSION, 'uid')) {
904 return intval($_SESSION['uid']);
910 * @brief Returns the public contact id of logged in user or false.
912 * @return int|bool public contact id or false
914 function public_contact()
916 static $public_contact_id = false;
918 if (!$public_contact_id && x($_SESSION, 'authenticated')) {
919 if (x($_SESSION, 'my_address')) {
921 $public_contact_id = intval(Contact::getIdForURL($_SESSION['my_address'], 0));
922 } elseif (x($_SESSION, 'visitor_home')) {
924 $public_contact_id = intval(Contact::getIdForURL($_SESSION['visitor_home'], 0));
926 } elseif (!x($_SESSION, 'authenticated')) {
927 $public_contact_id = false;
930 return $public_contact_id;
934 * @brief Returns contact id of authenticated site visitor or false
936 * @return int|bool visitor_id or false
938 function remote_user()
940 // You cannot be both local and remote
944 if (x($_SESSION, 'authenticated') && x($_SESSION, 'visitor_id')) {
945 return intval($_SESSION['visitor_id']);
951 * @brief Show an error message to user.
953 * This function save text in session, to be shown to the user at next page load
955 * @param string $s - Text of notice
960 if (!x($_SESSION, 'sysmsg')) {
961 $_SESSION['sysmsg'] = [];
963 if ($a->interactive) {
964 $_SESSION['sysmsg'][] = $s;
969 * @brief Show an info message to user.
971 * This function save text in session, to be shown to the user at next page load
973 * @param string $s - Text of notice
979 if (local_user() && PConfig::get(local_user(), 'system', 'ignore_info')) {
983 if (!x($_SESSION, 'sysmsg_info')) {
984 $_SESSION['sysmsg_info'] = [];
986 if ($a->interactive) {
987 $_SESSION['sysmsg_info'][] = $s;
992 * @brief Wrapper around config to limit the text length of an incoming message
996 function get_max_import_size()
999 return (x($a->config, 'max_import_size') ? $a->config['max_import_size'] : 0);
1003 function current_theme()
1005 $app_base_themes = ['duepuntozero', 'dispy', 'quattro'];
1011 // Find the theme that belongs to the user whose stuff we are looking at
1013 if ($a->profile_uid && ($a->profile_uid != local_user())) {
1015 "select theme from user where uid = %d limit 1",
1016 intval($a->profile_uid)
1018 if (DBM::is_result($r)) {
1019 $page_theme = $r[0]['theme'];
1023 // Allow folks to over-rule user themes and always use their own on their own site.
1024 // This works only if the user is on the same server
1026 if ($page_theme && local_user() && (local_user() != $a->profile_uid)) {
1027 if (PConfig::get(local_user(), 'system', 'always_my_theme')) {
1032 // $mobile_detect = new Mobile_Detect();
1033 // $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
1034 $is_mobile = $a->is_mobile || $a->is_tablet;
1036 $standard_system_theme = Config::get('system', 'theme', '');
1037 $standard_theme_name = ((isset($_SESSION) && x($_SESSION, 'theme')) ? $_SESSION['theme'] : $standard_system_theme);
1040 if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
1041 $theme_name = $standard_theme_name;
1043 $system_theme = Config::get('system', 'mobile-theme', '');
1044 if ($system_theme == '') {
1045 $system_theme = $standard_system_theme;
1047 $theme_name = ((isset($_SESSION) && x($_SESSION, 'mobile-theme')) ? $_SESSION['mobile-theme'] : $system_theme);
1049 if ($theme_name === '---') {
1050 // user has selected to have the mobile theme be the same as the normal one
1051 $theme_name = $standard_theme_name;
1054 $theme_name = $page_theme;
1059 $theme_name = $standard_theme_name;
1062 $theme_name = $page_theme;
1067 && (file_exists('view/theme/' . $theme_name . '/style.css')
1068 || file_exists('view/theme/' . $theme_name . '/style.php'))
1070 return($theme_name);
1073 foreach ($app_base_themes as $t) {
1074 if (file_exists('view/theme/' . $t . '/style.css')
1075 || file_exists('view/theme/' . $t . '/style.php')
1081 $fallback = array_merge(glob('view/theme/*/style.css'), glob('view/theme/*/style.php'));
1082 if (count($fallback)) {
1083 return (str_replace('view/theme/', '', substr($fallback[0], 0, -10)));
1086 /// @TODO No final return statement?
1090 * @brief Return full URL to theme which is currently in effect.
1092 * Provide a sane default if nothing is chosen or the specified theme does not exist.
1096 function current_theme_url()
1100 $t = current_theme();
1102 $opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : '');
1103 if (file_exists('view/theme/' . $t . '/style.php')) {
1104 return('view/theme/' . $t . '/style.pcss' . $opts);
1107 return('view/theme/' . $t . '/style.css');
1110 function feed_birthday($uid, $tz)
1113 * Determine the next birthday, but only if the birthday is published
1114 * in the default profile. We _could_ also look for a private profile that the
1115 * recipient can see, but somebody could get mad at us if they start getting
1116 * public birthday greetings when they haven't made this info public.
1118 * Assuming we are able to publish this info, we are then going to convert
1119 * the start time from the owner's timezone to UTC.
1121 * This will potentially solve the problem found with some social networks
1122 * where birthdays are converted to the viewer's timezone and salutations from
1123 * elsewhere in the world show up on the wrong day. We will convert it to the
1124 * viewer's timezone also, but first we are going to convert it from the birthday
1125 * person's timezone to GMT - so the viewer may find the birthday starting at
1126 * 6:00PM the day before, but that will correspond to midnight to the birthday person.
1135 "SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1",
1139 if (DBM::is_result($p)) {
1140 $tmp_dob = substr($p[0]['dob'], 5);
1141 if (intval($tmp_dob)) {
1142 $y = DateTimeFormat::timezoneNow($tz, 'Y');
1143 $bd = $y . '-' . $tmp_dob . ' 00:00';
1144 $t_dob = strtotime($bd);
1145 $now = strtotime(DateTimeFormat::timezoneNow($tz));
1146 if ($t_dob < $now) {
1147 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
1149 $birthday = DateTimeFormat::convert($bd, 'UTC', $tz, DateTimeFormat::ATOM);
1157 * @brief Check if current user has admin role.
1159 * @return bool true if user is an admin
1161 function is_site_admin()
1165 $adminlist = explode(",", str_replace(" ", "", $a->config['admin_email']));
1167 //if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && ($a->user['email'] === $a->config['admin_email']))
1168 if (local_user() && x($a->user, 'email') && x($a->config, 'admin_email') && in_array($a->user['email'], $adminlist)) {
1175 * @brief Returns querystring as string from a mapped array.
1177 * @param array $params mapped array with query parameters
1178 * @param string $name of parameter, default null
1182 function build_querystring($params, $name = null)
1185 foreach ($params as $key => $val) {
1186 if (is_array($val)) {
1187 /// @TODO maybe not compare against null, use is_null()
1188 if ($name == null) {
1189 $ret .= build_querystring($val, $key);
1191 $ret .= build_querystring($val, $name . "[$key]");
1194 $val = urlencode($val);
1195 /// @TODO maybe not compare against null, use is_null()
1196 if ($name != null) {
1197 /// @TODO two string concated, can be merged to one
1198 $ret .= $name . "[$key]" . "=$val&";
1200 $ret .= "$key=$val&";
1207 function explode_querystring($query)
1209 $arg_st = strpos($query, '?');
1210 if ($arg_st !== false) {
1211 $base = substr($query, 0, $arg_st);
1218 $args = explode('&', substr($query, $arg_st));
1219 foreach ($args as $k => $arg) {
1220 /// @TODO really compare type-safe here?
1225 $args = array_values($args);
1230 $args = array_values($args);
1240 * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
1242 * Taken from http://webcheatsheet.com/php/get_current_page_url.php
1244 function curPageURL()
1247 if ($_SERVER["HTTPS"] == "on") {
1253 if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
1254 $pageURL .= $_SERVER["SERVER_NAME"] . ":" . $_SERVER["SERVER_PORT"] . $_SERVER["REQUEST_URI"];
1256 $pageURL .= $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"];
1261 function random_digits($digits)
1264 for ($i = 0; $i < $digits; $i++) {
1265 /// @TODO rand() is different to mt_rand() and maybe lesser "random"
1271 function get_server()
1273 $server = Config::get("system", "directory");
1275 if ($server == "") {
1276 $server = "http://dir.friendica.social";
1282 function get_temppath()
1286 $temppath = Config::get("system", "temppath");
1288 if (($temppath != "") && App::directory_usable($temppath)) {
1289 // We have a temp path and it is usable
1290 return App::realpath($temppath);
1293 // We don't have a working preconfigured temp path, so we take the system path.
1294 $temppath = sys_get_temp_dir();
1296 // Check if it is usable
1297 if (($temppath != "") && App::directory_usable($temppath)) {
1298 // Always store the real path, not the path through symlinks
1299 $temppath = App::realpath($temppath);
1301 // To avoid any interferences with other systems we create our own directory
1302 $new_temppath = $temppath . "/" . $a->get_hostname();
1303 if (!is_dir($new_temppath)) {
1304 /// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
1305 mkdir($new_temppath);
1308 if (App::directory_usable($new_temppath)) {
1309 // The new path is usable, we are happy
1310 Config::set("system", "temppath", $new_temppath);
1311 return $new_temppath;
1313 // We can't create a subdirectory, strange.
1314 // But the directory seems to work, so we use it but don't store it.
1319 // Reaching this point means that the operating system is configured badly.
1323 function get_cachefile($file, $writemode = true)
1325 $cache = get_itemcachepath();
1327 if ((!$cache) || (!is_dir($cache))) {
1331 $subfolder = $cache . "/" . substr($file, 0, 2);
1333 $cachepath = $subfolder . "/" . $file;
1336 if (!is_dir($subfolder)) {
1338 chmod($subfolder, 0777);
1342 /// @TODO no need to put braces here
1346 function clear_cache($basepath = "", $path = "")
1349 $basepath = get_itemcachepath();
1353 if (($path == "") || (!is_dir($path))) {
1357 if (substr(realpath($path), 0, strlen($basepath)) != $basepath) {
1361 $cachetime = (int) Config::get('system', 'itemcache_duration');
1362 if ($cachetime == 0) {
1366 if (is_writable($path)) {
1367 if ($dh = opendir($path)) {
1368 while (($file = readdir($dh)) !== false) {
1369 $fullpath = $path . "/" . $file;
1370 if ((filetype($fullpath) == "dir") && ($file != ".") && ($file != "..")) {
1371 clear_cache($basepath, $fullpath);
1373 if ((filetype($fullpath) == "file") && (filectime($fullpath) < (time() - $cachetime))) {
1382 function get_itemcachepath()
1384 // Checking, if the cache is deactivated
1385 $cachetime = (int) Config::get('system', 'itemcache_duration');
1386 if ($cachetime < 0) {
1390 $itemcache = Config::get('system', 'itemcache');
1391 if (($itemcache != "") && App::directory_usable($itemcache)) {
1392 return App::realpath($itemcache);
1395 $temppath = get_temppath();
1397 if ($temppath != "") {
1398 $itemcache = $temppath . "/itemcache";
1399 if (!file_exists($itemcache) && !is_dir($itemcache)) {
1403 if (App::directory_usable($itemcache)) {
1404 Config::set("system", "itemcache", $itemcache);
1412 * @brief Returns the path where spool files are stored
1414 * @return string Spool path
1416 function get_spoolpath()
1418 $spoolpath = Config::get('system', 'spoolpath');
1419 if (($spoolpath != "") && App::directory_usable($spoolpath)) {
1420 // We have a spool path and it is usable
1424 // We don't have a working preconfigured spool path, so we take the temp path.
1425 $temppath = get_temppath();
1427 if ($temppath != "") {
1428 // To avoid any interferences with other systems we create our own directory
1429 $spoolpath = $temppath . "/spool";
1430 if (!is_dir($spoolpath)) {
1434 if (App::directory_usable($spoolpath)) {
1435 // The new path is usable, we are happy
1436 Config::set("system", "spoolpath", $spoolpath);
1439 // We can't create a subdirectory, strange.
1440 // But the directory seems to work, so we use it but don't store it.
1445 // Reaching this point means that the operating system is configured badly.
1450 if (!function_exists('exif_imagetype')) {
1451 function exif_imagetype($file)
1453 $size = getimagesize($file);
1458 function validate_include(&$file)
1462 $file = realpath($file);
1464 if (strpos($file, getcwd()) !== 0) {
1468 $file = str_replace(getcwd() . "/", "", $file, $count);
1473 if ($orig_file !== $file) {
1478 if (strpos($file, "include/") === 0) {
1482 if (strpos($file, "addon/") === 0) {
1486 // Simply return flag
1490 function current_load()
1492 if (!function_exists('sys_getloadavg')) {
1496 $load_arr = sys_getloadavg();
1498 if (!is_array($load_arr)) {
1502 return max($load_arr[0], $load_arr[1]);
1506 * @brief get c-style args
1512 return get_app()->argc;
1516 * @brief Returns the value of a argv key
1518 * @param int $x argv key
1519 * @return string Value of the argv key
1523 if (array_key_exists($x, get_app()->argv)) {
1524 return get_app()->argv[$x];
1531 * @brief Get the data which is needed for infinite scroll
1533 * For invinite scroll we need the page number of the actual page
1534 * and the the URI where the content of the next page comes from.
1535 * This data is needed for the js part in main.js.
1536 * Note: infinite scroll does only work for the network page (module)
1538 * @param string $module The name of the module (e.g. "network")
1539 * @return array Of infinite scroll data
1540 * 'pageno' => $pageno The number of the actual page
1541 * 'reload_uri' => $reload_uri The URI of the content we have to load
1543 function infinite_scroll_data($module)
1545 if (PConfig::get(local_user(), 'system', 'infinite_scroll')
1546 && $module == 'network'
1547 && defaults($_GET, 'mode', '') != 'minimal'
1549 // get the page number
1550 $pageno = defaults($_GET, 'page', 1);
1554 // try to get the uri from which we load the content
1555 foreach ($_GET as $param => $value) {
1556 if (($param != "page") && ($param != "q")) {
1557 $reload_uri .= "&" . $param . "=" . urlencode($value);
1562 if ($a->page_offset != "" && !strstr($reload_uri, "&offset=")) {
1563 $reload_uri .= "&offset=" . urlencode($a->page_offset);
1566 $arr = ["pageno" => $pageno, "reload_uri" => $reload_uri];