3 * @file_tag_unsave_file boot.php
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\PConfig;
27 use Friendica\Core\Protocol;
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\Model\Conversation;
34 use Friendica\Util\DateTimeFormat;
36 require_once 'include/text.php';
38 define('FRIENDICA_PLATFORM', 'Friendica');
39 define('FRIENDICA_CODENAME', 'Asparagus');
40 define('FRIENDICA_VERSION', '3.6-dev');
41 define('DFRN_PROTOCOL_VERSION', '2.23');
42 define('DB_UPDATE_VERSION', 1256);
43 define('NEW_UPDATE_ROUTINE_VERSION', 1170);
46 * @brief Constants for the database update check
48 const DB_UPDATE_NOT_CHECKED = 0; // Database check wasn't executed before
49 const DB_UPDATE_SUCCESSFUL = 1; // Database check was successful
50 const DB_UPDATE_FAILED = 2; // Database check failed
53 * @brief Constant with a HTML line break.
55 * Contains a HTML line break (br) element and a real carriage return with line
56 * feed for the source.
57 * This can be used in HTML and JavaScript where needed a line break.
59 define('EOL', "<br />\r\n");
62 * @brief Image storage quality.
64 * Lower numbers save space at cost of image detail.
65 * For ease of upgrade, please do not change here. Change jpeg quality with
66 * $a->config['system']['jpeg_quality'] = n;
67 * in .htconfig.php, where n is netween 1 and 100, and with very poor results
70 define('JPEG_QUALITY', 100);
73 * $a->config['system']['png_quality'] from 0 (uncompressed) to 9
75 define('PNG_QUALITY', 8);
78 * An alternate way of limiting picture upload sizes. Specify the maximum pixel
79 * length that pictures are allowed to be (for non-square pictures, it will apply
80 * to the longest side). Pictures longer than this length will be resized to be
81 * this length (on the longest side, the other side will be scaled appropriately).
82 * Modify this value using
84 * $a->config['system']['max_image_length'] = n;
88 * If you don't want to set a maximum length, set to -1. The default value is
89 * defined by 'MAX_IMAGE_LENGTH' below.
91 define('MAX_IMAGE_LENGTH', -1);
96 define('DEFAULT_DB_ENGINE', 'InnoDB');
101 * SSL redirection policies
104 define('SSL_POLICY_NONE', 0);
105 define('SSL_POLICY_FULL', 1);
106 define('SSL_POLICY_SELFSIGN', 2);
115 define('LOGGER_NORMAL', 0);
116 define('LOGGER_TRACE', 1);
117 define('LOGGER_DEBUG', 2);
118 define('LOGGER_DATA', 3);
119 define('LOGGER_ALL', 4);
125 * Registration policies
128 define('REGISTER_CLOSED', 0);
129 define('REGISTER_APPROVE', 1);
130 define('REGISTER_OPEN', 2);
141 define('CONTACT_IS_FOLLOWER', 1);
142 define('CONTACT_IS_SHARING', 2);
143 define('CONTACT_IS_FRIEND', 3);
151 * DB update return values
154 define('UPDATE_SUCCESS', 0);
155 define('UPDATE_FAILED', 1);
161 * @name page/profile types
163 * PAGE_NORMAL is a typical personal profile account
164 * PAGE_SOAPBOX automatically approves all friend requests as CONTACT_IS_SHARING, (readonly)
165 * PAGE_COMMUNITY automatically approves all friend requests as CONTACT_IS_SHARING, but with
166 * write access to wall and comments (no email and not included in page owner's ACL lists)
167 * PAGE_FREELOVE automatically approves all friend requests as full friends (CONTACT_IS_FRIEND).
171 define('PAGE_NORMAL', 0);
172 define('PAGE_SOAPBOX', 1);
173 define('PAGE_COMMUNITY', 2);
174 define('PAGE_FREELOVE', 3);
175 define('PAGE_BLOG', 4);
176 define('PAGE_PRVGROUP', 5);
182 * @name account types
184 * ACCOUNT_TYPE_PERSON - the account belongs to a person
185 * Associated page types: PAGE_NORMAL, PAGE_SOAPBOX, PAGE_FREELOVE
187 * ACCOUNT_TYPE_ORGANISATION - the account belongs to an organisation
188 * Associated page type: PAGE_SOAPBOX
190 * ACCOUNT_TYPE_NEWS - the account is a news reflector
191 * Associated page type: PAGE_SOAPBOX
193 * ACCOUNT_TYPE_COMMUNITY - the account is community forum
194 * Associated page types: PAGE_COMMUNITY, PAGE_PRVGROUP
197 define('ACCOUNT_TYPE_PERSON', 0);
198 define('ACCOUNT_TYPE_ORGANISATION', 1);
199 define('ACCOUNT_TYPE_NEWS', 2);
200 define('ACCOUNT_TYPE_COMMUNITY', 3);
208 * Type of the community page
211 define('CP_NO_COMMUNITY_PAGE', -1);
212 define('CP_USERS_ON_SERVER', 0);
213 define('CP_GLOBAL_COMMUNITY', 1);
214 define('CP_USERS_AND_GLOBAL', 2);
221 * @deprecated since version 3.6
224 * Different protocols that we are storing
227 define('PROTOCOL_UNKNOWN' , Conversation::PROTOCOL_UNKNOWN);
228 define('PROTOCOL_DFRN' , Conversation::PROTOCOL_DFRN);
229 define('PROTOCOL_DIASPORA' , Conversation::PROTOCOL_DIASPORA);
230 define('PROTOCOL_OSTATUS_SALMON' , Conversation::PROTOCOL_OSTATUS_SALMON);
231 define('PROTOCOL_OSTATUS_FEED' , Conversation::PROTOCOL_OSTATUS_FEED); // Deprecated
232 define('PROTOCOL_GS_CONVERSATION', Conversation::PROTOCOL_GS_CONVERSATION); // Deprecated
233 define('PROTOCOL_SPLITTED_CONV' , Conversation::PROTOCOL_SPLITTED_CONV);
239 * @name Network constants
240 * @deprecated since version 3.6
243 * Network and protocol family types
246 define('NETWORK_DFRN' , Protocol::DFRN); // Friendica, Mistpark, other DFRN implementations
247 define('NETWORK_ZOT' , Protocol::ZOT); // Zot! - Currently unsupported
248 define('NETWORK_OSTATUS' , Protocol::OSTATUS); // GNU-social, Pleroma, Mastodon, other OStatus implementations
249 define('NETWORK_FEED' , Protocol::FEED); // RSS/Atom feeds with no known "post/notify" protocol
250 define('NETWORK_DIASPORA' , Protocol::DIASPORA); // Diaspora
251 define('NETWORK_MAIL' , Protocol::MAIL); // IMAP/POP
252 define('NETWORK_FACEBOOK' , Protocol::FACEBOOK); // Facebook API
253 define('NETWORK_LINKEDIN' , Protocol::LINKEDIN); // LinkedIn
254 define('NETWORK_XMPP' , Protocol::XMPP); // XMPP - Currently unsupported
255 define('NETWORK_MYSPACE' , Protocol::MYSPACE); // MySpace - Currently unsupported
256 define('NETWORK_GPLUS' , Protocol::GPLUS); // Google+
257 define('NETWORK_PUMPIO' , Protocol::PUMPIO); // pump.io
258 define('NETWORK_TWITTER' , Protocol::TWITTER); // Twitter
259 define('NETWORK_DIASPORA2', Protocol::DIASPORA2); // Diaspora connector
260 define('NETWORK_STATUSNET', Protocol::STATUSNET); // Statusnet connector
261 define('NETWORK_APPNET' , Protocol::APPNET); // app.net - Dead protocol
262 define('NETWORK_NEWS' , Protocol::NEWS); // Network News Transfer Protocol - Currently unsupported
263 define('NETWORK_ICALENDAR', Protocol::ICALENDAR); // iCalendar - Currently unsupported
264 define('NETWORK_PNUT' , Protocol::PNUT); // pnut.io - Currently unsupported
265 define('NETWORK_PHANTOM' , Protocol::PHANTOM); // Place holder
271 * These numbers are used in stored permissions
272 * and existing allocations MUST NEVER BE CHANGED
273 * OR RE-ASSIGNED! You may only add to them.
276 NETWORK_DFRN => (-1),
278 NETWORK_OSTATUS => (-3),
279 NETWORK_FEED => (-4),
280 NETWORK_DIASPORA => (-5),
281 NETWORK_MAIL => (-6),
282 NETWORK_FACEBOOK => (-8),
283 NETWORK_LINKEDIN => (-9),
284 NETWORK_XMPP => (-10),
285 NETWORK_MYSPACE => (-11),
286 NETWORK_GPLUS => (-12),
287 NETWORK_PUMPIO => (-13),
288 NETWORK_TWITTER => (-14),
289 NETWORK_DIASPORA2 => (-15),
290 NETWORK_STATUSNET => (-16),
291 NETWORK_APPNET => (-17),
292 NETWORK_NEWS => (-18),
293 NETWORK_ICALENDAR => (-19),
294 NETWORK_PNUT => (-20),
296 NETWORK_PHANTOM => (-127),
300 * Maximum number of "people who like (or don't like) this" that we will list by name
302 define('MAX_LIKERS', 75);
305 * Communication timeout
307 define('ZCURL_TIMEOUT', (-1));
312 * Email notification options
315 define('NOTIFY_INTRO', 0x0001);
316 define('NOTIFY_CONFIRM', 0x0002);
317 define('NOTIFY_WALL', 0x0004);
318 define('NOTIFY_COMMENT', 0x0008);
319 define('NOTIFY_MAIL', 0x0010);
320 define('NOTIFY_SUGGEST', 0x0020);
321 define('NOTIFY_PROFILE', 0x0040);
322 define('NOTIFY_TAGSELF', 0x0080);
323 define('NOTIFY_TAGSHARE', 0x0100);
324 define('NOTIFY_POKE', 0x0200);
325 define('NOTIFY_SHARE', 0x0400);
327 define('SYSTEM_EMAIL', 0x4000);
329 define('NOTIFY_SYSTEM', 0x8000);
339 define('TERM_UNKNOWN', 0);
340 define('TERM_HASHTAG', 1);
341 define('TERM_MENTION', 2);
342 define('TERM_CATEGORY', 3);
343 define('TERM_PCATEGORY', 4);
344 define('TERM_FILE', 5);
345 define('TERM_SAVEDSEARCH', 6);
346 define('TERM_CONVERSATION', 7);
348 define('TERM_OBJ_POST', 1);
349 define('TERM_OBJ_PHOTO', 2);
354 * Various namespaces we may need to parse
357 define('NAMESPACE_ZOT', 'http://purl.org/zot');
358 define('NAMESPACE_DFRN', 'http://purl.org/macgirvin/dfrn/1.0');
359 define('NAMESPACE_THREAD', 'http://purl.org/syndication/thread/1.0');
360 define('NAMESPACE_TOMB', 'http://purl.org/atompub/tombstones/1.0');
361 define('NAMESPACE_ACTIVITY', 'http://activitystrea.ms/spec/1.0/');
362 define('NAMESPACE_ACTIVITY_SCHEMA', 'http://activitystrea.ms/schema/1.0/');
363 define('NAMESPACE_MEDIA', 'http://purl.org/syndication/atommedia');
364 define('NAMESPACE_SALMON_ME', 'http://salmon-protocol.org/ns/magic-env');
365 define('NAMESPACE_OSTATUSSUB', 'http://ostatus.org/schema/1.0/subscribe');
366 define('NAMESPACE_GEORSS', 'http://www.georss.org/georss');
367 define('NAMESPACE_POCO', 'http://portablecontacts.net/spec/1.0');
368 define('NAMESPACE_FEED', 'http://schemas.google.com/g/2010#updates-from');
369 define('NAMESPACE_OSTATUS', 'http://ostatus.org/schema/1.0');
370 define('NAMESPACE_STATUSNET', 'http://status.net/schema/api/1/');
371 define('NAMESPACE_ATOM1', 'http://www.w3.org/2005/Atom');
372 define('NAMESPACE_MASTODON', 'http://mastodon.social/schema/1.0');
378 * Activity stream defines
381 define('ACTIVITY_LIKE', NAMESPACE_ACTIVITY_SCHEMA . 'like');
382 define('ACTIVITY_DISLIKE', NAMESPACE_DFRN . '/dislike');
383 define('ACTIVITY_ATTEND', NAMESPACE_ZOT . '/activity/attendyes');
384 define('ACTIVITY_ATTENDNO', NAMESPACE_ZOT . '/activity/attendno');
385 define('ACTIVITY_ATTENDMAYBE', NAMESPACE_ZOT . '/activity/attendmaybe');
387 define('ACTIVITY_OBJ_HEART', NAMESPACE_DFRN . '/heart');
389 define('ACTIVITY_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'make-friend');
390 define('ACTIVITY_REQ_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'request-friend');
391 define('ACTIVITY_UNFRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'remove-friend');
392 define('ACTIVITY_FOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'follow');
393 define('ACTIVITY_UNFOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'stop-following');
394 define('ACTIVITY_JOIN', NAMESPACE_ACTIVITY_SCHEMA . 'join');
396 define('ACTIVITY_POST', NAMESPACE_ACTIVITY_SCHEMA . 'post');
397 define('ACTIVITY_UPDATE', NAMESPACE_ACTIVITY_SCHEMA . 'update');
398 define('ACTIVITY_TAG', NAMESPACE_ACTIVITY_SCHEMA . 'tag');
399 define('ACTIVITY_FAVORITE', NAMESPACE_ACTIVITY_SCHEMA . 'favorite');
400 define('ACTIVITY_UNFAVORITE', NAMESPACE_ACTIVITY_SCHEMA . 'unfavorite');
401 define('ACTIVITY_SHARE', NAMESPACE_ACTIVITY_SCHEMA . 'share');
402 define('ACTIVITY_DELETE', NAMESPACE_ACTIVITY_SCHEMA . 'delete');
404 define('ACTIVITY_POKE', NAMESPACE_ZOT . '/activity/poke');
406 define('ACTIVITY_OBJ_BOOKMARK', NAMESPACE_ACTIVITY_SCHEMA . 'bookmark');
407 define('ACTIVITY_OBJ_COMMENT', NAMESPACE_ACTIVITY_SCHEMA . 'comment');
408 define('ACTIVITY_OBJ_NOTE', NAMESPACE_ACTIVITY_SCHEMA . 'note');
409 define('ACTIVITY_OBJ_PERSON', NAMESPACE_ACTIVITY_SCHEMA . 'person');
410 define('ACTIVITY_OBJ_IMAGE', NAMESPACE_ACTIVITY_SCHEMA . 'image');
411 define('ACTIVITY_OBJ_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'photo');
412 define('ACTIVITY_OBJ_VIDEO', NAMESPACE_ACTIVITY_SCHEMA . 'video');
413 define('ACTIVITY_OBJ_P_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'profile-photo');
414 define('ACTIVITY_OBJ_ALBUM', NAMESPACE_ACTIVITY_SCHEMA . 'photo-album');
415 define('ACTIVITY_OBJ_EVENT', NAMESPACE_ACTIVITY_SCHEMA . 'event');
416 define('ACTIVITY_OBJ_GROUP', NAMESPACE_ACTIVITY_SCHEMA . 'group');
417 define('ACTIVITY_OBJ_TAGTERM', NAMESPACE_DFRN . '/tagterm');
418 define('ACTIVITY_OBJ_PROFILE', NAMESPACE_DFRN . '/profile');
419 define('ACTIVITY_OBJ_QUESTION', 'http://activityschema.org/object/question');
425 * Item weight for query ordering
428 define('GRAVITY_PARENT', 0);
429 define('GRAVITY_LIKE', 3);
430 define('GRAVITY_COMMENT', 6);
436 * Process priority for the worker
439 define('PRIORITY_UNDEFINED', 0);
440 define('PRIORITY_CRITICAL', 10);
441 define('PRIORITY_HIGH', 20);
442 define('PRIORITY_MEDIUM', 30);
443 define('PRIORITY_LOW', 40);
444 define('PRIORITY_NEGLIGIBLE', 50);
448 * @name Social Relay settings
450 * See here: https://github.com/jaywink/social-relay
451 * and here: https://wiki.diasporafoundation.org/Relay_servers_for_public_posts
454 define('SR_SCOPE_NONE', '');
455 define('SR_SCOPE_ALL', 'all');
456 define('SR_SCOPE_TAGS', 'tags');
460 * Lowest possible date time value
462 define('NULL_DATE', '0001-01-01 00:00:00');
464 // Normally this constant is defined - but not if "pcntl" isn't installed
465 if (!defined("SIGTERM")) {
466 define("SIGTERM", 15);
470 * Depending on the PHP version this constant does exist - or not.
471 * See here: http://php.net/manual/en/curl.constants.php#117928
473 if (!defined('CURLE_OPERATION_TIMEDOUT')) {
474 define('CURLE_OPERATION_TIMEDOUT', CURLE_OPERATION_TIMEOUTED);
477 * Reverse the effect of magic_quotes_gpc if it is enabled.
478 * Please disable magic_quotes_gpc so we don't have to do this.
479 * See http://php.net/manual/en/security.magicquotes.disabling.php
483 error_reporting(E_ERROR | E_WARNING | E_PARSE);
487 // This has to be quite large to deal with embedded private photos
488 ini_set('pcre.backtrack_limit', 500000);
490 if (get_magic_quotes_gpc()) {
491 $process = [&$_GET, &$_POST, &$_COOKIE, &$_REQUEST];
492 while (list($key, $val) = each($process)) {
493 foreach ($val as $k => $v) {
494 unset($process[$key][$k]);
496 $process[$key][stripslashes($k)] = $v;
497 $process[] = &$process[$key][stripslashes($k)];
499 $process[$key][stripslashes($k)] = stripslashes($v);
508 * @brief Retrieve the App structure
510 * Useful in functions which require it but don't get it passed to them
519 $a = new App(dirname(__DIR__));
526 * @brief Multi-purpose function to check variable state.
528 * Usage: x($var) or $x($array, 'key')
530 * returns false if variable/key is not set
531 * if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0.
532 * e.g. x('') or x(0) returns 0;
534 * @param string|array $s variable to check
535 * @param string $k key inside the array to check
539 function x($s, $k = null)
542 if ((is_array($s)) && (array_key_exists($k, $s))) {
561 * Return the provided variable value if it exists and is truthy or the provided
562 * default value instead.
564 * Works with initialized variables and potentially uninitialized array keys
567 * - defaults($var, $default)
568 * - defaults($array, 'key', $default)
570 * @brief Returns a defaut value if the provided variable or array key is falsy
574 function defaults() {
575 $args = func_get_args();
577 if (count($args) < 2) {
578 throw new BadFunctionCallException('defaults() requires at least 2 parameters');
580 if (count($args) > 3) {
581 throw new BadFunctionCallException('defaults() cannot use more than 3 parameters');
583 if (count($args) === 3 && is_null($args[1])) {
584 throw new BadFunctionCallException('defaults($arr, $key, $def) $key is null');
587 $default = array_pop($args);
589 if (call_user_func_array('x', $args)) {
590 if (count($args) === 1) {
593 $return = $args[0][$args[1]];
603 * @brief Returns the baseurl.
605 * @see System::baseUrl()
608 * @TODO Function is deprecated and only used in some addons
612 return System::baseUrl();
616 * @brief Return absolut URL for given $path.
618 * @param string $path given path
622 function absurl($path)
624 if (strpos($path, '/') === 0) {
625 return z_path() . $path;
631 * @brief Function to check if request was an AJAX (xmlhttprequest) request.
637 return (!empty($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest');
641 * @brief Function to check if request was an AJAX (xmlhttprequest) request.
643 * @param boolean $via_worker boolean Is the check run via the worker?
645 function check_db($via_worker)
647 $build = Config::get('system', 'build');
650 Config::set('system', 'build', DB_UPDATE_VERSION - 1);
651 $build = DB_UPDATE_VERSION - 1;
654 // We don't support upgrading from very old versions anymore
655 if ($build < NEW_UPDATE_ROUTINE_VERSION) {
656 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.');
659 if ($build < DB_UPDATE_VERSION) {
660 // When we cannot execute the database update via the worker, we will do it directly
661 if (!Worker::add(PRIORITY_CRITICAL, 'DBUpdate') && $via_worker) {
668 * Sets the base url for use in cmdline programs which don't have
671 * @param object $a App
673 function check_url(App $a)
675 $url = Config::get('system', 'url');
677 // if the url isn't set or the stored url is radically different
678 // than the currently visited url, store the current value accordingly.
679 // "Radically different" ignores common variations such as http vs https
680 // and www.example.com vs example.com.
681 // We will only change the url to an ip address if there is no existing setting
683 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))) {
684 Config::set('system', 'url', System::baseUrl());
691 * @brief Automatic database updates
692 * @param object $a App
696 $build = Config::get('system', 'build');
698 if (empty($build) || ($build > DB_UPDATE_VERSION)) {
699 $build = DB_UPDATE_VERSION - 1;
700 Config::set('system', 'build', $build);
703 if ($build != DB_UPDATE_VERSION) {
704 require_once 'update.php';
706 $stored = intval($build);
707 $current = intval(DB_UPDATE_VERSION);
708 if ($stored < $current) {
709 Config::load('database');
711 // Compare the current structure with the defined structure
712 $t = Config::get('database', 'dbupdate_' . DB_UPDATE_VERSION);
717 Config::set('database', 'dbupdate_' . DB_UPDATE_VERSION, time());
719 // run update routine
720 // it update the structure in one call
721 $retval = DBStructure::update(false, true);
723 DBStructure::updateFail(
729 Config::set('database', 'dbupdate_' . DB_UPDATE_VERSION, 'success');
732 // run any left update_nnnn functions in update.php
733 for ($x = $stored + 1; $x <= $current; $x++) {
734 $r = run_update_function($x);
745 function run_update_function($x)
747 if (function_exists('update_' . $x)) {
748 // There could be a lot of processes running or about to run.
749 // We want exactly one process to run the update command.
750 // So store the fact that we're taking responsibility
751 // after first checking to see if somebody else already has.
752 // If the update fails or times-out completely you may need to
753 // delete the config entry to try again.
755 $t = Config::get('database', 'update_' . $x);
759 Config::set('database', 'update_' . $x, time());
761 // call the specific update
763 $func = 'update_' . $x;
767 //send the administrator an e-mail
768 DBStructure::updateFail(
770 L10n::t('Update %s failed. See error logs.', $x)
774 Config::set('database', 'update_' . $x, 'success');
775 Config::set('system', 'build', $x);
779 Config::set('database', 'update_' . $x, 'success');
780 Config::set('system', 'build', $x);
786 * @brief Synchronise addons:
788 * $a->config['system']['addon'] contains a comma-separated list of names
789 * of addons which are used on this system.
790 * Go through the database list of already installed addons, and if we have
791 * an entry, but it isn't in the config list, call the uninstall procedure
792 * and mark it uninstalled in the database (for now we'll remove it).
793 * Then go through the config list and if we have a addon that isn't installed,
794 * call the install procedure and add it to the database.
796 * @param object $a App
798 function check_addons(App $a)
800 $r = q("SELECT * FROM `addon` WHERE `installed` = 1");
801 if (DBM::is_result($r)) {
807 $addons = Config::get('system', 'addon');
811 $addons_arr = explode(',', str_replace(' ', '', $addons));
814 $a->addons = $addons_arr;
818 if (count($installed)) {
819 foreach ($installed as $i) {
820 if (!in_array($i['name'], $addons_arr)) {
821 Addon::uninstall($i['name']);
823 $installed_arr[] = $i['name'];
828 if (count($addons_arr)) {
829 foreach ($addons_arr as $p) {
830 if (!in_array($p, $installed_arr)) {
841 function get_guid($size = 16, $prefix = '')
843 if (is_bool($prefix) && !$prefix) {
845 } elseif ($prefix == '') {
847 $prefix = hash('crc32', $a->get_hostname());
850 while (strlen($prefix) < ($size - 13)) {
851 $prefix .= mt_rand();
855 $prefix = substr($prefix, 0, $size - 22);
856 return str_replace('.', '', uniqid($prefix, true));
858 $prefix = substr($prefix, 0, max($size - 13, 0));
859 return uniqid($prefix);
864 * @brief Used to end the current process, after saving session state.
873 * @brief Redirect to another URL and terminate this process.
875 function goaway($path)
877 if (strstr(normalise_link($path), 'http://')) {
880 $url = System::baseUrl() . '/' . ltrim($path, '/');
883 header("Location: $url");
888 * @brief Returns the user id of locally logged in user or false.
890 * @return int|bool user id or false
892 function local_user()
894 if (x($_SESSION, 'authenticated') && x($_SESSION, 'uid')) {
895 return intval($_SESSION['uid']);
901 * @brief Returns the public contact id of logged in user or false.
903 * @return int|bool public contact id or false
905 function public_contact()
907 static $public_contact_id = false;
909 if (!$public_contact_id && x($_SESSION, 'authenticated')) {
910 if (x($_SESSION, 'my_address')) {
912 $public_contact_id = intval(Contact::getIdForURL($_SESSION['my_address'], 0, true));
913 } elseif (x($_SESSION, 'visitor_home')) {
915 $public_contact_id = intval(Contact::getIdForURL($_SESSION['visitor_home'], 0, true));
917 } elseif (!x($_SESSION, 'authenticated')) {
918 $public_contact_id = false;
921 return $public_contact_id;
925 * @brief Returns contact id of authenticated site visitor or false
927 * @return int|bool visitor_id or false
929 function remote_user()
931 // You cannot be both local and remote
935 if (x($_SESSION, 'authenticated') && x($_SESSION, 'visitor_id')) {
936 return intval($_SESSION['visitor_id']);
942 * @brief Show an error message to user.
944 * This function save text in session, to be shown to the user at next page load
946 * @param string $s - Text of notice
951 if (!x($_SESSION, 'sysmsg')) {
952 $_SESSION['sysmsg'] = [];
954 if ($a->interactive) {
955 $_SESSION['sysmsg'][] = $s;
960 * @brief Show an info message to user.
962 * This function save text in session, to be shown to the user at next page load
964 * @param string $s - Text of notice
970 if (local_user() && PConfig::get(local_user(), 'system', 'ignore_info')) {
974 if (!x($_SESSION, 'sysmsg_info')) {
975 $_SESSION['sysmsg_info'] = [];
977 if ($a->interactive) {
978 $_SESSION['sysmsg_info'][] = $s;
983 * @brief Wrapper around config to limit the text length of an incoming message
987 function get_max_import_size()
990 return (x($a->config, 'max_import_size') ? $a->config['max_import_size'] : 0);
994 function current_theme()
996 $app_base_themes = ['duepuntozero', 'dispy', 'quattro'];
1002 // Find the theme that belongs to the user whose stuff we are looking at
1004 if ($a->profile_uid && ($a->profile_uid != local_user())) {
1006 "select theme from user where uid = %d limit 1",
1007 intval($a->profile_uid)
1009 if (DBM::is_result($r)) {
1010 $page_theme = $r[0]['theme'];
1014 // Allow folks to over-rule user themes and always use their own on their own site.
1015 // This works only if the user is on the same server
1017 if ($page_theme && local_user() && (local_user() != $a->profile_uid)) {
1018 if (PConfig::get(local_user(), 'system', 'always_my_theme')) {
1023 // $mobile_detect = new Mobile_Detect();
1024 // $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
1025 $is_mobile = $a->is_mobile || $a->is_tablet;
1027 $standard_system_theme = Config::get('system', 'theme', '');
1028 $standard_theme_name = ((isset($_SESSION) && x($_SESSION, 'theme')) ? $_SESSION['theme'] : $standard_system_theme);
1031 if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
1032 $theme_name = $standard_theme_name;
1034 $system_theme = Config::get('system', 'mobile-theme', '');
1035 if ($system_theme == '') {
1036 $system_theme = $standard_system_theme;
1038 $theme_name = ((isset($_SESSION) && x($_SESSION, 'mobile-theme')) ? $_SESSION['mobile-theme'] : $system_theme);
1040 if ($theme_name === '---') {
1041 // user has selected to have the mobile theme be the same as the normal one
1042 $theme_name = $standard_theme_name;
1045 $theme_name = $page_theme;
1050 $theme_name = $standard_theme_name;
1053 $theme_name = $page_theme;
1058 && (file_exists('view/theme/' . $theme_name . '/style.css')
1059 || file_exists('view/theme/' . $theme_name . '/style.php'))
1061 return($theme_name);
1064 foreach ($app_base_themes as $t) {
1065 if (file_exists('view/theme/' . $t . '/style.css')
1066 || file_exists('view/theme/' . $t . '/style.php')
1072 $fallback = array_merge(glob('view/theme/*/style.css'), glob('view/theme/*/style.php'));
1073 if (count($fallback)) {
1074 return (str_replace('view/theme/', '', substr($fallback[0], 0, -10)));
1077 /// @TODO No final return statement?
1081 * @brief Return full URL to theme which is currently in effect.
1083 * Provide a sane default if nothing is chosen or the specified theme does not exist.
1087 function current_theme_url()
1091 $t = current_theme();
1093 $opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : '');
1094 if (file_exists('view/theme/' . $t . '/style.php')) {
1095 return('view/theme/' . $t . '/style.pcss' . $opts);
1098 return('view/theme/' . $t . '/style.css');
1101 function feed_birthday($uid, $tz)
1104 * Determine the next birthday, but only if the birthday is published
1105 * in the default profile. We _could_ also look for a private profile that the
1106 * recipient can see, but somebody could get mad at us if they start getting
1107 * public birthday greetings when they haven't made this info public.
1109 * Assuming we are able to publish this info, we are then going to convert
1110 * the start time from the owner's timezone to UTC.
1112 * This will potentially solve the problem found with some social networks
1113 * where birthdays are converted to the viewer's timezone and salutations from
1114 * elsewhere in the world show up on the wrong day. We will convert it to the
1115 * viewer's timezone also, but first we are going to convert it from the birthday
1116 * person's timezone to GMT - so the viewer may find the birthday starting at
1117 * 6:00PM the day before, but that will correspond to midnight to the birthday person.
1126 "SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1",
1130 if (DBM::is_result($p)) {
1131 $tmp_dob = substr($p[0]['dob'], 5);
1132 if (intval($tmp_dob)) {
1133 $y = DateTimeFormat::timezoneNow($tz, 'Y');
1134 $bd = $y . '-' . $tmp_dob . ' 00:00';
1135 $t_dob = strtotime($bd);
1136 $now = strtotime(DateTimeFormat::timezoneNow($tz));
1137 if ($t_dob < $now) {
1138 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
1140 $birthday = DateTimeFormat::convert($bd, 'UTC', $tz, DateTimeFormat::ATOM);
1148 * @brief Check if current user has admin role.
1150 * @return bool true if user is an admin
1152 function is_site_admin()
1156 $adminlist = explode(",", str_replace(" ", "", $a->config['admin_email']));
1158 //if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && ($a->user['email'] === $a->config['admin_email']))
1159 if (local_user() && x($a->user, 'email') && x($a->config, 'admin_email') && in_array($a->user['email'], $adminlist)) {
1166 * @brief Returns querystring as string from a mapped array.
1168 * @param array $params mapped array with query parameters
1169 * @param string $name of parameter, default null
1173 function build_querystring($params, $name = null)
1176 foreach ($params as $key => $val) {
1177 if (is_array($val)) {
1178 /// @TODO maybe not compare against null, use is_null()
1179 if ($name == null) {
1180 $ret .= build_querystring($val, $key);
1182 $ret .= build_querystring($val, $name . "[$key]");
1185 $val = urlencode($val);
1186 /// @TODO maybe not compare against null, use is_null()
1187 if ($name != null) {
1188 /// @TODO two string concated, can be merged to one
1189 $ret .= $name . "[$key]" . "=$val&";
1191 $ret .= "$key=$val&";
1198 function explode_querystring($query)
1200 $arg_st = strpos($query, '?');
1201 if ($arg_st !== false) {
1202 $base = substr($query, 0, $arg_st);
1209 $args = explode('&', substr($query, $arg_st));
1210 foreach ($args as $k => $arg) {
1211 /// @TODO really compare type-safe here?
1216 $args = array_values($args);
1221 $args = array_values($args);
1231 * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
1233 * Taken from http://webcheatsheet.com/php/get_current_page_url.php
1235 function curPageURL()
1238 if ($_SERVER["HTTPS"] == "on") {
1244 if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
1245 $pageURL .= $_SERVER["SERVER_NAME"] . ":" . $_SERVER["SERVER_PORT"] . $_SERVER["REQUEST_URI"];
1247 $pageURL .= $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"];
1252 function random_digits($digits)
1255 for ($i = 0; $i < $digits; $i++) {
1256 /// @TODO rand() is different to mt_rand() and maybe lesser "random"
1262 function get_server()
1264 $server = Config::get("system", "directory");
1266 if ($server == "") {
1267 $server = "http://dir.friendica.social";
1273 function get_temppath()
1277 $temppath = Config::get("system", "temppath");
1279 if (($temppath != "") && App::directory_usable($temppath)) {
1280 // We have a temp path and it is usable
1281 return App::realpath($temppath);
1284 // We don't have a working preconfigured temp path, so we take the system path.
1285 $temppath = sys_get_temp_dir();
1287 // Check if it is usable
1288 if (($temppath != "") && App::directory_usable($temppath)) {
1289 // Always store the real path, not the path through symlinks
1290 $temppath = App::realpath($temppath);
1292 // To avoid any interferences with other systems we create our own directory
1293 $new_temppath = $temppath . "/" . $a->get_hostname();
1294 if (!is_dir($new_temppath)) {
1295 /// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
1296 mkdir($new_temppath);
1299 if (App::directory_usable($new_temppath)) {
1300 // The new path is usable, we are happy
1301 Config::set("system", "temppath", $new_temppath);
1302 return $new_temppath;
1304 // We can't create a subdirectory, strange.
1305 // But the directory seems to work, so we use it but don't store it.
1310 // Reaching this point means that the operating system is configured badly.
1314 function get_cachefile($file, $writemode = true)
1316 $cache = get_itemcachepath();
1318 if ((!$cache) || (!is_dir($cache))) {
1322 $subfolder = $cache . "/" . substr($file, 0, 2);
1324 $cachepath = $subfolder . "/" . $file;
1327 if (!is_dir($subfolder)) {
1329 chmod($subfolder, 0777);
1333 /// @TODO no need to put braces here
1337 function clear_cache($basepath = "", $path = "")
1340 $basepath = get_itemcachepath();
1344 if (($path == "") || (!is_dir($path))) {
1348 if (substr(realpath($path), 0, strlen($basepath)) != $basepath) {
1352 $cachetime = (int) Config::get('system', 'itemcache_duration');
1353 if ($cachetime == 0) {
1357 if (is_writable($path)) {
1358 if ($dh = opendir($path)) {
1359 while (($file = readdir($dh)) !== false) {
1360 $fullpath = $path . "/" . $file;
1361 if ((filetype($fullpath) == "dir") && ($file != ".") && ($file != "..")) {
1362 clear_cache($basepath, $fullpath);
1364 if ((filetype($fullpath) == "file") && (filectime($fullpath) < (time() - $cachetime))) {
1373 function get_itemcachepath()
1375 // Checking, if the cache is deactivated
1376 $cachetime = (int) Config::get('system', 'itemcache_duration');
1377 if ($cachetime < 0) {
1381 $itemcache = Config::get('system', 'itemcache');
1382 if (($itemcache != "") && App::directory_usable($itemcache)) {
1383 return App::realpath($itemcache);
1386 $temppath = get_temppath();
1388 if ($temppath != "") {
1389 $itemcache = $temppath . "/itemcache";
1390 if (!file_exists($itemcache) && !is_dir($itemcache)) {
1394 if (App::directory_usable($itemcache)) {
1395 Config::set("system", "itemcache", $itemcache);
1403 * @brief Returns the path where spool files are stored
1405 * @return string Spool path
1407 function get_spoolpath()
1409 $spoolpath = Config::get('system', 'spoolpath');
1410 if (($spoolpath != "") && App::directory_usable($spoolpath)) {
1411 // We have a spool path and it is usable
1415 // We don't have a working preconfigured spool path, so we take the temp path.
1416 $temppath = get_temppath();
1418 if ($temppath != "") {
1419 // To avoid any interferences with other systems we create our own directory
1420 $spoolpath = $temppath . "/spool";
1421 if (!is_dir($spoolpath)) {
1425 if (App::directory_usable($spoolpath)) {
1426 // The new path is usable, we are happy
1427 Config::set("system", "spoolpath", $spoolpath);
1430 // We can't create a subdirectory, strange.
1431 // But the directory seems to work, so we use it but don't store it.
1436 // Reaching this point means that the operating system is configured badly.
1441 if (!function_exists('exif_imagetype')) {
1442 function exif_imagetype($file)
1444 $size = getimagesize($file);
1449 function validate_include(&$file)
1453 $file = realpath($file);
1455 if (strpos($file, getcwd()) !== 0) {
1459 $file = str_replace(getcwd() . "/", "", $file, $count);
1464 if ($orig_file !== $file) {
1469 if (strpos($file, "include/") === 0) {
1473 if (strpos($file, "addon/") === 0) {
1477 // Simply return flag
1481 function current_load()
1483 if (!function_exists('sys_getloadavg')) {
1487 $load_arr = sys_getloadavg();
1489 if (!is_array($load_arr)) {
1493 return max($load_arr[0], $load_arr[1]);
1497 * @brief get c-style args
1503 return get_app()->argc;
1507 * @brief Returns the value of a argv key
1509 * @param int $x argv key
1510 * @return string Value of the argv key
1514 if (array_key_exists($x, get_app()->argv)) {
1515 return get_app()->argv[$x];
1522 * @brief Get the data which is needed for infinite scroll
1524 * For invinite scroll we need the page number of the actual page
1525 * and the the URI where the content of the next page comes from.
1526 * This data is needed for the js part in main.js.
1527 * Note: infinite scroll does only work for the network page (module)
1529 * @param string $module The name of the module (e.g. "network")
1530 * @return array Of infinite scroll data
1531 * 'pageno' => $pageno The number of the actual page
1532 * 'reload_uri' => $reload_uri The URI of the content we have to load
1534 function infinite_scroll_data($module)
1536 if (PConfig::get(local_user(), 'system', 'infinite_scroll')
1537 && $module == 'network'
1538 && defaults($_GET, 'mode', '') != 'minimal'
1540 // get the page number
1541 $pageno = defaults($_GET, 'page', 1);
1545 // try to get the uri from which we load the content
1546 foreach ($_GET as $param => $value) {
1547 if (($param != "page") && ($param != "q")) {
1548 $reload_uri .= "&" . $param . "=" . urlencode($value);
1553 if ($a->page_offset != "" && !strstr($reload_uri, "&offset=")) {
1554 $reload_uri .= "&offset=" . urlencode($a->page_offset);
1557 $arr = ["pageno" => $pageno, "reload_uri" => $reload_uri];