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-05-dev');
43 define('DFRN_PROTOCOL_VERSION', '2.23');
44 define('DB_UPDATE_VERSION', 1259);
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. Change jpeg quality with
68 * $a->config['system']['jpeg_quality'] = n;
69 * in .htconfig.php, where n is netween 1 and 100, and with very poor results
72 define('JPEG_QUALITY', 100);
75 * $a->config['system']['png_quality'] from 0 (uncompressed) to 9
77 define('PNG_QUALITY', 8);
80 * An alternate way of limiting picture upload sizes. Specify the maximum pixel
81 * length that pictures are allowed to be (for non-square pictures, it will apply
82 * to the longest side). Pictures longer than this length will be resized to be
83 * this length (on the longest side, the other side will be scaled appropriately).
84 * Modify this value using
86 * $a->config['system']['max_image_length'] = n;
90 * If you don't want to set a maximum length, set to -1. The default value is
91 * defined by 'MAX_IMAGE_LENGTH' below.
93 define('MAX_IMAGE_LENGTH', -1);
98 define('DEFAULT_DB_ENGINE', 'InnoDB');
103 * SSL redirection policies
106 define('SSL_POLICY_NONE', 0);
107 define('SSL_POLICY_FULL', 1);
108 define('SSL_POLICY_SELFSIGN', 2);
117 define('LOGGER_NORMAL', 0);
118 define('LOGGER_TRACE', 1);
119 define('LOGGER_DEBUG', 2);
120 define('LOGGER_DATA', 3);
121 define('LOGGER_ALL', 4);
126 * @deprecated since version 3.6
132 define('CACHE_MONTH', Cache::MONTH);
133 define('CACHE_WEEK', Cache::WEEK);
134 define('CACHE_DAY', Cache::DAY);
135 define('CACHE_HOUR', Cache::HOUR);
136 define('CACHE_HALF_HOUR', Cache::HALF_HOUR);
137 define('CACHE_QUARTER_HOUR', Cache::QUARTER_HOUR);
138 define('CACHE_FIVE_MINUTES', Cache::FIVE_MINUTES);
139 define('CACHE_MINUTE', Cache::MINUTE);
145 * Registration policies
148 define('REGISTER_CLOSED', 0);
149 define('REGISTER_APPROVE', 1);
150 define('REGISTER_OPEN', 2);
161 define('CONTACT_IS_FOLLOWER', 1);
162 define('CONTACT_IS_SHARING', 2);
163 define('CONTACT_IS_FRIEND', 3);
171 * DB update return values
174 define('UPDATE_SUCCESS', 0);
175 define('UPDATE_FAILED', 1);
181 * @name page/profile types
183 * PAGE_NORMAL is a typical personal profile account
184 * PAGE_SOAPBOX automatically approves all friend requests as CONTACT_IS_SHARING, (readonly)
185 * PAGE_COMMUNITY automatically approves all friend requests as CONTACT_IS_SHARING, but with
186 * write access to wall and comments (no email and not included in page owner's ACL lists)
187 * PAGE_FREELOVE automatically approves all friend requests as full friends (CONTACT_IS_FRIEND).
191 define('PAGE_NORMAL', 0);
192 define('PAGE_SOAPBOX', 1);
193 define('PAGE_COMMUNITY', 2);
194 define('PAGE_FREELOVE', 3);
195 define('PAGE_BLOG', 4);
196 define('PAGE_PRVGROUP', 5);
202 * @name account types
204 * ACCOUNT_TYPE_PERSON - the account belongs to a person
205 * Associated page types: PAGE_NORMAL, PAGE_SOAPBOX, PAGE_FREELOVE
207 * ACCOUNT_TYPE_ORGANISATION - the account belongs to an organisation
208 * Associated page type: PAGE_SOAPBOX
210 * ACCOUNT_TYPE_NEWS - the account is a news reflector
211 * Associated page type: PAGE_SOAPBOX
213 * ACCOUNT_TYPE_COMMUNITY - the account is community forum
214 * Associated page types: PAGE_COMMUNITY, PAGE_PRVGROUP
216 * ACCOUNT_TYPE_RELAY - the account is a relay
217 * This will only be assigned to contacts, not to user accounts
220 define('ACCOUNT_TYPE_PERSON', 0);
221 define('ACCOUNT_TYPE_ORGANISATION', 1);
222 define('ACCOUNT_TYPE_NEWS', 2);
223 define('ACCOUNT_TYPE_COMMUNITY', 3);
224 define('ACCOUNT_TYPE_RELAY', 4);
232 * Type of the community page
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_LIKE', 3);
454 define('GRAVITY_COMMENT', 6);
460 * Process priority for the worker
463 define('PRIORITY_UNDEFINED', 0);
464 define('PRIORITY_CRITICAL', 10);
465 define('PRIORITY_HIGH', 20);
466 define('PRIORITY_MEDIUM', 30);
467 define('PRIORITY_LOW', 40);
468 define('PRIORITY_NEGLIGIBLE', 50);
472 * @name Social Relay settings
474 * See here: https://github.com/jaywink/social-relay
475 * and here: https://wiki.diasporafoundation.org/Relay_servers_for_public_posts
478 define('SR_SCOPE_NONE', '');
479 define('SR_SCOPE_ALL', 'all');
480 define('SR_SCOPE_TAGS', 'tags');
484 * Lowest possible date time value
486 define('NULL_DATE', '0001-01-01 00:00:00');
488 // Normally this constant is defined - but not if "pcntl" isn't installed
489 if (!defined("SIGTERM")) {
490 define("SIGTERM", 15);
494 * Depending on the PHP version this constant does exist - or not.
495 * See here: http://php.net/manual/en/curl.constants.php#117928
497 if (!defined('CURLE_OPERATION_TIMEDOUT')) {
498 define('CURLE_OPERATION_TIMEDOUT', CURLE_OPERATION_TIMEOUTED);
501 * Reverse the effect of magic_quotes_gpc if it is enabled.
502 * Please disable magic_quotes_gpc so we don't have to do this.
503 * See http://php.net/manual/en/security.magicquotes.disabling.php
507 error_reporting(E_ERROR | E_WARNING | E_PARSE);
511 // This has to be quite large to deal with embedded private photos
512 ini_set('pcre.backtrack_limit', 500000);
514 if (get_magic_quotes_gpc()) {
515 $process = [&$_GET, &$_POST, &$_COOKIE, &$_REQUEST];
516 while (list($key, $val) = each($process)) {
517 foreach ($val as $k => $v) {
518 unset($process[$key][$k]);
520 $process[$key][stripslashes($k)] = $v;
521 $process[] = &$process[$key][stripslashes($k)];
523 $process[$key][stripslashes($k)] = stripslashes($v);
532 * @brief Retrieve the App structure
534 * Useful in functions which require it but don't get it passed to them
543 $a = new App(dirname(__DIR__));
544 BaseObject::setApp($a);
551 * @brief Multi-purpose function to check variable state.
553 * Usage: x($var) or $x($array, 'key')
555 * returns false if variable/key is not set
556 * if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0.
557 * e.g. x('') or x(0) returns 0;
559 * @param string|array $s variable to check
560 * @param string $k key inside the array to check
564 function x($s, $k = null)
567 if ((is_array($s)) && (array_key_exists($k, $s))) {
586 * Return the provided variable value if it exists and is truthy or the provided
587 * default value instead.
589 * Works with initialized variables and potentially uninitialized array keys
592 * - defaults($var, $default)
593 * - defaults($array, 'key', $default)
595 * @brief Returns a defaut value if the provided variable or array key is falsy
599 function defaults() {
600 $args = func_get_args();
602 if (count($args) < 2) {
603 throw new BadFunctionCallException('defaults() requires at least 2 parameters');
605 if (count($args) > 3) {
606 throw new BadFunctionCallException('defaults() cannot use more than 3 parameters');
608 if (count($args) === 3 && is_null($args[1])) {
609 throw new BadFunctionCallException('defaults($arr, $key, $def) $key is null');
612 $default = array_pop($args);
614 if (call_user_func_array('x', $args)) {
615 if (count($args) === 1) {
618 $return = $args[0][$args[1]];
628 * @brief Returns the baseurl.
630 * @see System::baseUrl()
633 * @TODO Function is deprecated and only used in some addons
637 return System::baseUrl();
641 * @brief Return absolut URL for given $path.
643 * @param string $path given path
647 function absurl($path)
649 if (strpos($path, '/') === 0) {
650 return z_path() . $path;
656 * @brief Function to check if request was an AJAX (xmlhttprequest) request.
662 return (!empty($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest');
666 * @brief Function to check if request was an AJAX (xmlhttprequest) request.
668 * @param boolean $via_worker boolean Is the check run via the worker?
670 function check_db($via_worker)
672 $build = Config::get('system', 'build');
675 Config::set('system', 'build', DB_UPDATE_VERSION - 1);
676 $build = DB_UPDATE_VERSION - 1;
679 // We don't support upgrading from very old versions anymore
680 if ($build < NEW_UPDATE_ROUTINE_VERSION) {
681 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.');
684 if ($build < DB_UPDATE_VERSION) {
685 // When we cannot execute the database update via the worker, we will do it directly
686 if (!Worker::add(PRIORITY_CRITICAL, 'DBUpdate') && $via_worker) {
693 * Sets the base url for use in cmdline programs which don't have
696 * @param object $a App
698 function check_url(App $a)
700 $url = Config::get('system', 'url');
702 // if the url isn't set or the stored url is radically different
703 // than the currently visited url, store the current value accordingly.
704 // "Radically different" ignores common variations such as http vs https
705 // and www.example.com vs example.com.
706 // We will only change the url to an ip address if there is no existing setting
708 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))) {
709 Config::set('system', 'url', System::baseUrl());
716 * @brief Automatic database updates
717 * @param object $a App
721 $build = Config::get('system', 'build');
723 if (empty($build) || ($build > DB_UPDATE_VERSION)) {
724 $build = DB_UPDATE_VERSION - 1;
725 Config::set('system', 'build', $build);
728 if ($build != DB_UPDATE_VERSION) {
729 require_once 'update.php';
731 $stored = intval($build);
732 $current = intval(DB_UPDATE_VERSION);
733 if ($stored < $current) {
734 Config::load('database');
736 // Compare the current structure with the defined structure
737 $t = Config::get('database', 'dbupdate_' . DB_UPDATE_VERSION);
742 Config::set('database', 'dbupdate_' . DB_UPDATE_VERSION, time());
744 // run update routine
745 // it update the structure in one call
746 $retval = DBStructure::update(false, true);
748 DBStructure::updateFail(
754 Config::set('database', 'dbupdate_' . DB_UPDATE_VERSION, 'success');
757 // run any left update_nnnn functions in update.php
758 for ($x = $stored + 1; $x <= $current; $x++) {
759 $r = run_update_function($x);
770 function run_update_function($x)
772 if (function_exists('update_' . $x)) {
773 // There could be a lot of processes running or about to run.
774 // We want exactly one process to run the update command.
775 // So store the fact that we're taking responsibility
776 // after first checking to see if somebody else already has.
777 // If the update fails or times-out completely you may need to
778 // delete the config entry to try again.
780 $t = Config::get('database', 'update_' . $x);
784 Config::set('database', 'update_' . $x, time());
786 // call the specific update
788 $func = 'update_' . $x;
792 //send the administrator an e-mail
793 DBStructure::updateFail(
795 L10n::t('Update %s failed. See error logs.', $x)
799 Config::set('database', 'update_' . $x, 'success');
800 Config::set('system', 'build', $x);
804 Config::set('database', 'update_' . $x, 'success');
805 Config::set('system', 'build', $x);
811 * @brief Synchronise addons:
813 * $a->config['system']['addon'] contains a comma-separated list of names
814 * of addons which are used on this system.
815 * Go through the database list of already installed addons, and if we have
816 * an entry, but it isn't in the config list, call the uninstall procedure
817 * and mark it uninstalled in the database (for now we'll remove it).
818 * Then go through the config list and if we have a addon that isn't installed,
819 * call the install procedure and add it to the database.
821 * @param object $a App
823 function check_addons(App $a)
825 $r = q("SELECT * FROM `addon` WHERE `installed` = 1");
826 if (DBM::is_result($r)) {
832 $addons = Config::get('system', 'addon');
836 $addons_arr = explode(',', str_replace(' ', '', $addons));
839 $a->addons = $addons_arr;
843 if (count($installed)) {
844 foreach ($installed as $i) {
845 if (!in_array($i['name'], $addons_arr)) {
846 Addon::uninstall($i['name']);
848 $installed_arr[] = $i['name'];
853 if (count($addons_arr)) {
854 foreach ($addons_arr as $p) {
855 if (!in_array($p, $installed_arr)) {
866 function get_guid($size = 16, $prefix = '')
868 if (is_bool($prefix) && !$prefix) {
870 } elseif ($prefix == '') {
872 $prefix = hash('crc32', $a->get_hostname());
875 while (strlen($prefix) < ($size - 13)) {
876 $prefix .= mt_rand();
880 $prefix = substr($prefix, 0, $size - 22);
881 return str_replace('.', '', uniqid($prefix, true));
883 $prefix = substr($prefix, 0, max($size - 13, 0));
884 return uniqid($prefix);
889 * @brief Used to end the current process, after saving session state.
898 * @brief Redirect to another URL and terminate this process.
900 function goaway($path)
902 if (strstr(normalise_link($path), 'http://')) {
905 $url = System::baseUrl() . '/' . ltrim($path, '/');
908 header("Location: $url");
913 * @brief Returns the user id of locally logged in user or false.
915 * @return int|bool user id or false
917 function local_user()
919 if (x($_SESSION, 'authenticated') && x($_SESSION, 'uid')) {
920 return intval($_SESSION['uid']);
926 * @brief Returns the public contact id of logged in user or false.
928 * @return int|bool public contact id or false
930 function public_contact()
932 static $public_contact_id = false;
934 if (!$public_contact_id && x($_SESSION, 'authenticated')) {
935 if (x($_SESSION, 'my_address')) {
937 $public_contact_id = intval(Contact::getIdForURL($_SESSION['my_address'], 0, true));
938 } elseif (x($_SESSION, 'visitor_home')) {
940 $public_contact_id = intval(Contact::getIdForURL($_SESSION['visitor_home'], 0, true));
942 } elseif (!x($_SESSION, 'authenticated')) {
943 $public_contact_id = false;
946 return $public_contact_id;
950 * @brief Returns contact id of authenticated site visitor or false
952 * @return int|bool visitor_id or false
954 function remote_user()
956 // You cannot be both local and remote.
957 // Unncommented by rabuzarus because remote authentication to local
958 // profiles wasn't possible anymore (2018-04-12).
959 // if (local_user()) {
962 if (x($_SESSION, 'authenticated') && x($_SESSION, 'visitor_id')) {
963 return intval($_SESSION['visitor_id']);
969 * @brief Show an error 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
978 if (!x($_SESSION, 'sysmsg')) {
979 $_SESSION['sysmsg'] = [];
981 if ($a->interactive) {
982 $_SESSION['sysmsg'][] = $s;
987 * @brief Show an info message to user.
989 * This function save text in session, to be shown to the user at next page load
991 * @param string $s - Text of notice
997 if (local_user() && PConfig::get(local_user(), 'system', 'ignore_info')) {
1001 if (!x($_SESSION, 'sysmsg_info')) {
1002 $_SESSION['sysmsg_info'] = [];
1004 if ($a->interactive) {
1005 $_SESSION['sysmsg_info'][] = $s;
1010 * @brief Wrapper around config to limit the text length of an incoming message
1014 function get_max_import_size()
1017 return (x($a->config, 'max_import_size') ? $a->config['max_import_size'] : 0);
1021 function current_theme()
1023 $app_base_themes = ['duepuntozero', 'dispy', 'quattro'];
1029 // Find the theme that belongs to the user whose stuff we are looking at
1031 if ($a->profile_uid && ($a->profile_uid != local_user())) {
1033 "select theme from user where uid = %d limit 1",
1034 intval($a->profile_uid)
1036 if (DBM::is_result($r)) {
1037 $page_theme = $r[0]['theme'];
1041 // Allow folks to over-rule user themes and always use their own on their own site.
1042 // This works only if the user is on the same server
1044 if ($page_theme && local_user() && (local_user() != $a->profile_uid)) {
1045 if (PConfig::get(local_user(), 'system', 'always_my_theme')) {
1050 // $mobile_detect = new Mobile_Detect();
1051 // $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
1052 $is_mobile = $a->is_mobile || $a->is_tablet;
1054 $standard_system_theme = Config::get('system', 'theme', '');
1055 $standard_theme_name = ((isset($_SESSION) && x($_SESSION, 'theme')) ? $_SESSION['theme'] : $standard_system_theme);
1058 if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
1059 $theme_name = $standard_theme_name;
1061 $system_theme = Config::get('system', 'mobile-theme', '');
1062 if ($system_theme == '') {
1063 $system_theme = $standard_system_theme;
1065 $theme_name = ((isset($_SESSION) && x($_SESSION, 'mobile-theme')) ? $_SESSION['mobile-theme'] : $system_theme);
1067 if ($theme_name === '---') {
1068 // user has selected to have the mobile theme be the same as the normal one
1069 $theme_name = $standard_theme_name;
1072 $theme_name = $page_theme;
1077 $theme_name = $standard_theme_name;
1080 $theme_name = $page_theme;
1085 && (file_exists('view/theme/' . $theme_name . '/style.css')
1086 || file_exists('view/theme/' . $theme_name . '/style.php'))
1088 return($theme_name);
1091 foreach ($app_base_themes as $t) {
1092 if (file_exists('view/theme/' . $t . '/style.css')
1093 || file_exists('view/theme/' . $t . '/style.php')
1099 $fallback = array_merge(glob('view/theme/*/style.css'), glob('view/theme/*/style.php'));
1100 if (count($fallback)) {
1101 return (str_replace('view/theme/', '', substr($fallback[0], 0, -10)));
1104 /// @TODO No final return statement?
1108 * @brief Return full URL to theme which is currently in effect.
1110 * Provide a sane default if nothing is chosen or the specified theme does not exist.
1114 function current_theme_url()
1118 $t = current_theme();
1120 $opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : '');
1121 if (file_exists('view/theme/' . $t . '/style.php')) {
1122 return('view/theme/' . $t . '/style.pcss' . $opts);
1125 return('view/theme/' . $t . '/style.css');
1128 function feed_birthday($uid, $tz)
1131 * Determine the next birthday, but only if the birthday is published
1132 * in the default profile. We _could_ also look for a private profile that the
1133 * recipient can see, but somebody could get mad at us if they start getting
1134 * public birthday greetings when they haven't made this info public.
1136 * Assuming we are able to publish this info, we are then going to convert
1137 * the start time from the owner's timezone to UTC.
1139 * This will potentially solve the problem found with some social networks
1140 * where birthdays are converted to the viewer's timezone and salutations from
1141 * elsewhere in the world show up on the wrong day. We will convert it to the
1142 * viewer's timezone also, but first we are going to convert it from the birthday
1143 * person's timezone to GMT - so the viewer may find the birthday starting at
1144 * 6:00PM the day before, but that will correspond to midnight to the birthday person.
1153 "SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1",
1157 if (DBM::is_result($p)) {
1158 $tmp_dob = substr($p[0]['dob'], 5);
1159 if (intval($tmp_dob)) {
1160 $y = DateTimeFormat::timezoneNow($tz, 'Y');
1161 $bd = $y . '-' . $tmp_dob . ' 00:00';
1162 $t_dob = strtotime($bd);
1163 $now = strtotime(DateTimeFormat::timezoneNow($tz));
1164 if ($t_dob < $now) {
1165 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
1167 $birthday = DateTimeFormat::convert($bd, 'UTC', $tz, DateTimeFormat::ATOM);
1175 * @brief Check if current user has admin role.
1177 * @return bool true if user is an admin
1179 function is_site_admin()
1183 $adminlist = explode(",", str_replace(" ", "", $a->config['admin_email']));
1185 //if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && ($a->user['email'] === $a->config['admin_email']))
1186 if (local_user() && x($a->user, 'email') && x($a->config, 'admin_email') && in_array($a->user['email'], $adminlist)) {
1193 * @brief Returns querystring as string from a mapped array.
1195 * @param array $params mapped array with query parameters
1196 * @param string $name of parameter, default null
1200 function build_querystring($params, $name = null)
1203 foreach ($params as $key => $val) {
1204 if (is_array($val)) {
1205 /// @TODO maybe not compare against null, use is_null()
1206 if ($name == null) {
1207 $ret .= build_querystring($val, $key);
1209 $ret .= build_querystring($val, $name . "[$key]");
1212 $val = urlencode($val);
1213 /// @TODO maybe not compare against null, use is_null()
1214 if ($name != null) {
1215 /// @TODO two string concated, can be merged to one
1216 $ret .= $name . "[$key]" . "=$val&";
1218 $ret .= "$key=$val&";
1225 function explode_querystring($query)
1227 $arg_st = strpos($query, '?');
1228 if ($arg_st !== false) {
1229 $base = substr($query, 0, $arg_st);
1236 $args = explode('&', substr($query, $arg_st));
1237 foreach ($args as $k => $arg) {
1238 /// @TODO really compare type-safe here?
1243 $args = array_values($args);
1248 $args = array_values($args);
1258 * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
1260 * Taken from http://webcheatsheet.com/php/get_current_page_url.php
1262 function curPageURL()
1265 if ($_SERVER["HTTPS"] == "on") {
1271 if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
1272 $pageURL .= $_SERVER["SERVER_NAME"] . ":" . $_SERVER["SERVER_PORT"] . $_SERVER["REQUEST_URI"];
1274 $pageURL .= $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"];
1279 function random_digits($digits)
1282 for ($i = 0; $i < $digits; $i++) {
1283 /// @TODO rand() is different to mt_rand() and maybe lesser "random"
1289 function get_server()
1291 $server = Config::get("system", "directory");
1293 if ($server == "") {
1294 $server = "http://dir.friendica.social";
1300 function get_temppath()
1304 $temppath = Config::get("system", "temppath");
1306 if (($temppath != "") && App::directory_usable($temppath)) {
1307 // We have a temp path and it is usable
1308 return App::realpath($temppath);
1311 // We don't have a working preconfigured temp path, so we take the system path.
1312 $temppath = sys_get_temp_dir();
1314 // Check if it is usable
1315 if (($temppath != "") && App::directory_usable($temppath)) {
1316 // Always store the real path, not the path through symlinks
1317 $temppath = App::realpath($temppath);
1319 // To avoid any interferences with other systems we create our own directory
1320 $new_temppath = $temppath . "/" . $a->get_hostname();
1321 if (!is_dir($new_temppath)) {
1322 /// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
1323 mkdir($new_temppath);
1326 if (App::directory_usable($new_temppath)) {
1327 // The new path is usable, we are happy
1328 Config::set("system", "temppath", $new_temppath);
1329 return $new_temppath;
1331 // We can't create a subdirectory, strange.
1332 // But the directory seems to work, so we use it but don't store it.
1337 // Reaching this point means that the operating system is configured badly.
1341 function get_cachefile($file, $writemode = true)
1343 $cache = get_itemcachepath();
1345 if ((!$cache) || (!is_dir($cache))) {
1349 $subfolder = $cache . "/" . substr($file, 0, 2);
1351 $cachepath = $subfolder . "/" . $file;
1354 if (!is_dir($subfolder)) {
1356 chmod($subfolder, 0777);
1360 /// @TODO no need to put braces here
1364 function clear_cache($basepath = "", $path = "")
1367 $basepath = get_itemcachepath();
1371 if (($path == "") || (!is_dir($path))) {
1375 if (substr(realpath($path), 0, strlen($basepath)) != $basepath) {
1379 $cachetime = (int) Config::get('system', 'itemcache_duration');
1380 if ($cachetime == 0) {
1384 if (is_writable($path)) {
1385 if ($dh = opendir($path)) {
1386 while (($file = readdir($dh)) !== false) {
1387 $fullpath = $path . "/" . $file;
1388 if ((filetype($fullpath) == "dir") && ($file != ".") && ($file != "..")) {
1389 clear_cache($basepath, $fullpath);
1391 if ((filetype($fullpath) == "file") && (filectime($fullpath) < (time() - $cachetime))) {
1400 function get_itemcachepath()
1402 // Checking, if the cache is deactivated
1403 $cachetime = (int) Config::get('system', 'itemcache_duration');
1404 if ($cachetime < 0) {
1408 $itemcache = Config::get('system', 'itemcache');
1409 if (($itemcache != "") && App::directory_usable($itemcache)) {
1410 return App::realpath($itemcache);
1413 $temppath = get_temppath();
1415 if ($temppath != "") {
1416 $itemcache = $temppath . "/itemcache";
1417 if (!file_exists($itemcache) && !is_dir($itemcache)) {
1421 if (App::directory_usable($itemcache)) {
1422 Config::set("system", "itemcache", $itemcache);
1430 * @brief Returns the path where spool files are stored
1432 * @return string Spool path
1434 function get_spoolpath()
1436 $spoolpath = Config::get('system', 'spoolpath');
1437 if (($spoolpath != "") && App::directory_usable($spoolpath)) {
1438 // We have a spool path and it is usable
1442 // We don't have a working preconfigured spool path, so we take the temp path.
1443 $temppath = get_temppath();
1445 if ($temppath != "") {
1446 // To avoid any interferences with other systems we create our own directory
1447 $spoolpath = $temppath . "/spool";
1448 if (!is_dir($spoolpath)) {
1452 if (App::directory_usable($spoolpath)) {
1453 // The new path is usable, we are happy
1454 Config::set("system", "spoolpath", $spoolpath);
1457 // We can't create a subdirectory, strange.
1458 // But the directory seems to work, so we use it but don't store it.
1463 // Reaching this point means that the operating system is configured badly.
1468 if (!function_exists('exif_imagetype')) {
1469 function exif_imagetype($file)
1471 $size = getimagesize($file);
1476 function validate_include(&$file)
1480 $file = realpath($file);
1482 if (strpos($file, getcwd()) !== 0) {
1486 $file = str_replace(getcwd() . "/", "", $file, $count);
1491 if ($orig_file !== $file) {
1496 if (strpos($file, "include/") === 0) {
1500 if (strpos($file, "addon/") === 0) {
1504 // Simply return flag
1508 function current_load()
1510 if (!function_exists('sys_getloadavg')) {
1514 $load_arr = sys_getloadavg();
1516 if (!is_array($load_arr)) {
1520 return max($load_arr[0], $load_arr[1]);
1524 * @brief get c-style args
1530 return get_app()->argc;
1534 * @brief Returns the value of a argv key
1536 * @param int $x argv key
1537 * @return string Value of the argv key
1541 if (array_key_exists($x, get_app()->argv)) {
1542 return get_app()->argv[$x];
1549 * @brief Get the data which is needed for infinite scroll
1551 * For invinite scroll we need the page number of the actual page
1552 * and the the URI where the content of the next page comes from.
1553 * This data is needed for the js part in main.js.
1554 * Note: infinite scroll does only work for the network page (module)
1556 * @param string $module The name of the module (e.g. "network")
1557 * @return array Of infinite scroll data
1558 * 'pageno' => $pageno The number of the actual page
1559 * 'reload_uri' => $reload_uri The URI of the content we have to load
1561 function infinite_scroll_data($module)
1563 if (PConfig::get(local_user(), 'system', 'infinite_scroll')
1564 && $module == 'network'
1565 && defaults($_GET, 'mode', '') != 'minimal'
1567 // get the page number
1568 $pageno = defaults($_GET, 'page', 1);
1572 // try to get the uri from which we load the content
1573 foreach ($_GET as $param => $value) {
1574 if (($param != "page") && ($param != "q")) {
1575 $reload_uri .= "&" . $param . "=" . urlencode($value);
1580 if ($a->page_offset != "" && !strstr($reload_uri, "&offset=")) {
1581 $reload_uri .= "&offset=" . urlencode($a->page_offset);
1584 $arr = ["pageno" => $pageno, "reload_uri" => $reload_uri];