5 * This file defines some global constants and includes the central App class.
11 * Friendica is a communications platform for integrated social communications
12 * utilising decentralised communications and linkage to several indie social
13 * projects - as well as popular mainstream providers.
15 * Our mission is to free our friends and families from the clutches of
16 * data-harvesting corporations, and pave the way to a future where social
17 * communications are free and open and flow between alternate providers as
18 * easily as email does today.
21 require_once __DIR__ . DIRECTORY_SEPARATOR . 'vendor' . DIRECTORY_SEPARATOR . 'autoload.php';
24 use Friendica\Core\System;
25 use Friendica\Core\Cache;
26 use Friendica\Core\Config;
27 use Friendica\Core\PConfig;
28 use Friendica\Core\Worker;
29 use Friendica\Database\DBM;
30 use Friendica\Object\Contact;
31 use Friendica\Util\Lock;
33 require_once 'include/network.php';
34 require_once 'include/plugin.php';
35 require_once 'include/text.php';
36 require_once 'include/datetime.php';
37 require_once 'include/pgettext.php';
38 require_once 'include/nav.php';
39 require_once 'include/identity.php';
40 require_once 'update.php';
41 require_once 'include/dbstructure.php';
43 define('FRIENDICA_PLATFORM', 'Friendica');
44 define('FRIENDICA_CODENAME', 'Asparagus');
45 define('FRIENDICA_VERSION', '3.6-dev');
46 define('DFRN_PROTOCOL_VERSION', '2.23');
47 define('DB_UPDATE_VERSION', 1235);
50 * @brief Constant with a HTML line break.
52 * Contains a HTML line break (br) element and a real carriage return with line
53 * feed for the source.
54 * This can be used in HTML and JavaScript where needed a line break.
56 define('EOL', "<br />\r\n");
57 define('ATOM_TIME', 'Y-m-d\TH:i:s\Z');
60 * @brief Image storage quality.
62 * Lower numbers save space at cost of image detail.
63 * For ease of upgrade, please do not change here. Change jpeg quality with
64 * $a->config['system']['jpeg_quality'] = n;
65 * in .htconfig.php, where n is netween 1 and 100, and with very poor results
68 define('JPEG_QUALITY', 100);
71 * $a->config['system']['png_quality'] from 0 (uncompressed) to 9
73 define('PNG_QUALITY', 8);
76 * An alternate way of limiting picture upload sizes. Specify the maximum pixel
77 * length that pictures are allowed to be (for non-square pictures, it will apply
78 * to the longest side). Pictures longer than this length will be resized to be
79 * this length (on the longest side, the other side will be scaled appropriately).
80 * Modify this value using
82 * $a->config['system']['max_image_length'] = n;
86 * If you don't want to set a maximum length, set to -1. The default value is
87 * defined by 'MAX_IMAGE_LENGTH' below.
89 define('MAX_IMAGE_LENGTH', -1);
94 define('DEFAULT_DB_ENGINE', 'InnoDB');
99 * SSL redirection policies
102 define('SSL_POLICY_NONE', 0);
103 define('SSL_POLICY_FULL', 1);
104 define('SSL_POLICY_SELFSIGN', 2);
113 define('LOGGER_NORMAL', 0);
114 define('LOGGER_TRACE', 1);
115 define('LOGGER_DEBUG', 2);
116 define('LOGGER_DATA', 3);
117 define('LOGGER_ALL', 4);
126 define('CACHE_MONTH', 0);
127 define('CACHE_WEEK', 1);
128 define('CACHE_DAY', 2);
129 define('CACHE_HOUR', 3);
130 define('CACHE_HALF_HOUR', 4);
131 define('CACHE_QUARTER_HOUR', 5);
132 define('CACHE_FIVE_MINUTES', 6);
133 define('CACHE_MINUTE', 7);
139 * Registration policies
142 define('REGISTER_CLOSED', 0);
143 define('REGISTER_APPROVE', 1);
144 define('REGISTER_OPEN', 2);
155 define('CONTACT_IS_FOLLOWER', 1);
156 define('CONTACT_IS_SHARING', 2);
157 define('CONTACT_IS_FRIEND', 3);
165 * DB update return values
168 define('UPDATE_SUCCESS', 0);
169 define('UPDATE_FAILED', 1);
175 * @name page/profile types
177 * PAGE_NORMAL is a typical personal profile account
178 * PAGE_SOAPBOX automatically approves all friend requests as CONTACT_IS_SHARING, (readonly)
179 * PAGE_COMMUNITY automatically approves all friend requests as CONTACT_IS_SHARING, but with
180 * write access to wall and comments (no email and not included in page owner's ACL lists)
181 * PAGE_FREELOVE automatically approves all friend requests as full friends (CONTACT_IS_FRIEND).
185 define('PAGE_NORMAL', 0);
186 define('PAGE_SOAPBOX', 1);
187 define('PAGE_COMMUNITY', 2);
188 define('PAGE_FREELOVE', 3);
189 define('PAGE_BLOG', 4);
190 define('PAGE_PRVGROUP', 5);
196 * @name account types
198 * ACCOUNT_TYPE_PERSON - the account belongs to a person
199 * Associated page types: PAGE_NORMAL, PAGE_SOAPBOX, PAGE_FREELOVE
201 * ACCOUNT_TYPE_ORGANISATION - the account belongs to an organisation
202 * Associated page type: PAGE_SOAPBOX
204 * ACCOUNT_TYPE_NEWS - the account is a news reflector
205 * Associated page type: PAGE_SOAPBOX
207 * ACCOUNT_TYPE_COMMUNITY - the account is community forum
208 * Associated page types: PAGE_COMMUNITY, PAGE_PRVGROUP
211 define('ACCOUNT_TYPE_PERSON', 0);
212 define('ACCOUNT_TYPE_ORGANISATION', 1);
213 define('ACCOUNT_TYPE_NEWS', 2);
214 define('ACCOUNT_TYPE_COMMUNITY', 3);
222 * Type of the community page
225 define('CP_NO_COMMUNITY_PAGE', -1);
226 define('CP_USERS_ON_SERVER', 0);
227 define('CP_GLOBAL_COMMUNITY', 1);
235 * Different protocols that we are storing
238 define('PROTOCOL_UNKNOWN', 0);
239 define('PROTOCOL_DFRN', 1);
240 define('PROTOCOL_DIASPORA', 2);
241 define('PROTOCOL_OSTATUS_SALMON', 3);
242 define('PROTOCOL_OSTATUS_FEED', 4); // Deprecated
243 define('PROTOCOL_GS_CONVERSATION', 5); // Deprecated
244 define('PROTOCOL_SPLITTED_CONV', 6);
252 * Network and protocol family types
255 define('NETWORK_DFRN', 'dfrn'); // Friendica, Mistpark, other DFRN implementations
256 define('NETWORK_ZOT', 'zot!'); // Zot! - Currently unsupported
257 define('NETWORK_OSTATUS', 'stat'); // GNU-social, Pleroma, Mastodon, other OStatus implementations
258 define('NETWORK_FEED', 'feed'); // RSS/Atom feeds with no known "post/notify" protocol
259 define('NETWORK_DIASPORA', 'dspr'); // Diaspora
260 define('NETWORK_MAIL', 'mail'); // IMAP/POP
261 define('NETWORK_FACEBOOK', 'face'); // Facebook API
262 define('NETWORK_LINKEDIN', 'lnkd'); // LinkedIn
263 define('NETWORK_XMPP', 'xmpp'); // XMPP - Currently unsupported
264 define('NETWORK_MYSPACE', 'mysp'); // MySpace - Currently unsupported
265 define('NETWORK_GPLUS', 'goog'); // Google+
266 define('NETWORK_PUMPIO', 'pump'); // pump.io
267 define('NETWORK_TWITTER', 'twit'); // Twitter
268 define('NETWORK_DIASPORA2', 'dspc'); // Diaspora connector
269 define('NETWORK_STATUSNET', 'stac'); // Statusnet connector
270 define('NETWORK_APPNET', 'apdn'); // app.net - Dead protocol
271 define('NETWORK_NEWS', 'nntp'); // Network News Transfer Protocol - Currently unsupported
272 define('NETWORK_ICALENDAR', 'ical'); // iCalendar - Currently unsupported
273 define('NETWORK_PNUT', 'pnut'); // pnut.io - Currently unsupported
274 define('NETWORK_PHANTOM', 'unkn'); // Place holder
280 * These numbers are used in stored permissions
281 * and existing allocations MUST NEVER BE CHANGED
282 * OR RE-ASSIGNED! You may only add to them.
284 $netgroup_ids = array(
285 NETWORK_DFRN => (-1),
287 NETWORK_OSTATUS => (-3),
288 NETWORK_FEED => (-4),
289 NETWORK_DIASPORA => (-5),
290 NETWORK_MAIL => (-6),
291 NETWORK_FACEBOOK => (-8),
292 NETWORK_LINKEDIN => (-9),
293 NETWORK_XMPP => (-10),
294 NETWORK_MYSPACE => (-11),
295 NETWORK_GPLUS => (-12),
296 NETWORK_PUMPIO => (-13),
297 NETWORK_TWITTER => (-14),
298 NETWORK_DIASPORA2 => (-15),
299 NETWORK_STATUSNET => (-16),
300 NETWORK_APPNET => (-17),
301 NETWORK_NEWS => (-18),
302 NETWORK_ICALENDAR => (-19),
303 NETWORK_PNUT => (-20),
305 NETWORK_PHANTOM => (-127),
309 * Maximum number of "people who like (or don't like) this" that we will list by name
311 define('MAX_LIKERS', 75);
314 * Communication timeout
316 define('ZCURL_TIMEOUT', (-1));
321 * Email notification options
324 define('NOTIFY_INTRO', 0x0001);
325 define('NOTIFY_CONFIRM', 0x0002);
326 define('NOTIFY_WALL', 0x0004);
327 define('NOTIFY_COMMENT', 0x0008);
328 define('NOTIFY_MAIL', 0x0010);
329 define('NOTIFY_SUGGEST', 0x0020);
330 define('NOTIFY_PROFILE', 0x0040);
331 define('NOTIFY_TAGSELF', 0x0080);
332 define('NOTIFY_TAGSHARE', 0x0100);
333 define('NOTIFY_POKE', 0x0200);
334 define('NOTIFY_SHARE', 0x0400);
336 define('SYSTEM_EMAIL', 0x4000);
338 define('NOTIFY_SYSTEM', 0x8000);
348 define('TERM_UNKNOWN', 0);
349 define('TERM_HASHTAG', 1);
350 define('TERM_MENTION', 2);
351 define('TERM_CATEGORY', 3);
352 define('TERM_PCATEGORY', 4);
353 define('TERM_FILE', 5);
354 define('TERM_SAVEDSEARCH', 6);
355 define('TERM_CONVERSATION', 7);
357 define('TERM_OBJ_POST', 1);
358 define('TERM_OBJ_PHOTO', 2);
363 * Various namespaces we may need to parse
366 define('NAMESPACE_ZOT', 'http://purl.org/zot');
367 define('NAMESPACE_DFRN', 'http://purl.org/macgirvin/dfrn/1.0');
368 define('NAMESPACE_THREAD', 'http://purl.org/syndication/thread/1.0');
369 define('NAMESPACE_TOMB', 'http://purl.org/atompub/tombstones/1.0');
370 define('NAMESPACE_ACTIVITY', 'http://activitystrea.ms/spec/1.0/');
371 define('NAMESPACE_ACTIVITY_SCHEMA', 'http://activitystrea.ms/schema/1.0/');
372 define('NAMESPACE_MEDIA', 'http://purl.org/syndication/atommedia');
373 define('NAMESPACE_SALMON_ME', 'http://salmon-protocol.org/ns/magic-env');
374 define('NAMESPACE_OSTATUSSUB', 'http://ostatus.org/schema/1.0/subscribe');
375 define('NAMESPACE_GEORSS', 'http://www.georss.org/georss');
376 define('NAMESPACE_POCO', 'http://portablecontacts.net/spec/1.0');
377 define('NAMESPACE_FEED', 'http://schemas.google.com/g/2010#updates-from');
378 define('NAMESPACE_OSTATUS', 'http://ostatus.org/schema/1.0');
379 define('NAMESPACE_STATUSNET', 'http://status.net/schema/api/1/');
380 define('NAMESPACE_ATOM1', 'http://www.w3.org/2005/Atom');
381 define('NAMESPACE_MASTODON', 'http://mastodon.social/schema/1.0');
387 * Activity stream defines
390 define('ACTIVITY_LIKE', NAMESPACE_ACTIVITY_SCHEMA . 'like');
391 define('ACTIVITY_DISLIKE', NAMESPACE_DFRN . '/dislike');
392 define('ACTIVITY_ATTEND', NAMESPACE_ZOT . '/activity/attendyes');
393 define('ACTIVITY_ATTENDNO', NAMESPACE_ZOT . '/activity/attendno');
394 define('ACTIVITY_ATTENDMAYBE', NAMESPACE_ZOT . '/activity/attendmaybe');
396 define('ACTIVITY_OBJ_HEART', NAMESPACE_DFRN . '/heart');
398 define('ACTIVITY_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'make-friend');
399 define('ACTIVITY_REQ_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'request-friend');
400 define('ACTIVITY_UNFRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'remove-friend');
401 define('ACTIVITY_FOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'follow');
402 define('ACTIVITY_UNFOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'stop-following');
403 define('ACTIVITY_JOIN', NAMESPACE_ACTIVITY_SCHEMA . 'join');
405 define('ACTIVITY_POST', NAMESPACE_ACTIVITY_SCHEMA . 'post');
406 define('ACTIVITY_UPDATE', NAMESPACE_ACTIVITY_SCHEMA . 'update');
407 define('ACTIVITY_TAG', NAMESPACE_ACTIVITY_SCHEMA . 'tag');
408 define('ACTIVITY_FAVORITE', NAMESPACE_ACTIVITY_SCHEMA . 'favorite');
409 define('ACTIVITY_UNFAVORITE', NAMESPACE_ACTIVITY_SCHEMA . 'unfavorite');
410 define('ACTIVITY_SHARE', NAMESPACE_ACTIVITY_SCHEMA . 'share');
411 define('ACTIVITY_DELETE', NAMESPACE_ACTIVITY_SCHEMA . 'delete');
413 define('ACTIVITY_POKE', NAMESPACE_ZOT . '/activity/poke');
414 define('ACTIVITY_MOOD', NAMESPACE_ZOT . '/activity/mood');
416 define('ACTIVITY_OBJ_BOOKMARK', NAMESPACE_ACTIVITY_SCHEMA . 'bookmark');
417 define('ACTIVITY_OBJ_COMMENT', NAMESPACE_ACTIVITY_SCHEMA . 'comment');
418 define('ACTIVITY_OBJ_NOTE', NAMESPACE_ACTIVITY_SCHEMA . 'note');
419 define('ACTIVITY_OBJ_PERSON', NAMESPACE_ACTIVITY_SCHEMA . 'person');
420 define('ACTIVITY_OBJ_IMAGE', NAMESPACE_ACTIVITY_SCHEMA . 'image');
421 define('ACTIVITY_OBJ_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'photo');
422 define('ACTIVITY_OBJ_VIDEO', NAMESPACE_ACTIVITY_SCHEMA . 'video');
423 define('ACTIVITY_OBJ_P_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'profile-photo');
424 define('ACTIVITY_OBJ_ALBUM', NAMESPACE_ACTIVITY_SCHEMA . 'photo-album');
425 define('ACTIVITY_OBJ_EVENT', NAMESPACE_ACTIVITY_SCHEMA . 'event');
426 define('ACTIVITY_OBJ_GROUP', NAMESPACE_ACTIVITY_SCHEMA . 'group');
427 define('ACTIVITY_OBJ_TAGTERM', NAMESPACE_DFRN . '/tagterm');
428 define('ACTIVITY_OBJ_PROFILE', NAMESPACE_DFRN . '/profile');
429 define('ACTIVITY_OBJ_QUESTION', 'http://activityschema.org/object/question');
435 * Item weight for query ordering
438 define('GRAVITY_PARENT', 0);
439 define('GRAVITY_LIKE', 3);
440 define('GRAVITY_COMMENT', 6);
446 * Process priority for the worker
449 define('PRIORITY_UNDEFINED', 0);
450 define('PRIORITY_CRITICAL', 10);
451 define('PRIORITY_HIGH', 20);
452 define('PRIORITY_MEDIUM', 30);
453 define('PRIORITY_LOW', 40);
454 define('PRIORITY_NEGLIGIBLE', 50);
458 * @name Social Relay settings
460 * See here: https://github.com/jaywink/social-relay
461 * and here: https://wiki.diasporafoundation.org/Relay_servers_for_public_posts
464 define('SR_SCOPE_NONE', '');
465 define('SR_SCOPE_ALL', 'all');
466 define('SR_SCOPE_TAGS', 'tags');
470 * Lowest possible date time value
472 define('NULL_DATE', '0001-01-01 00:00:00');
474 // Normally this constant is defined - but not if "pcntl" isn't installed
475 if (!defined("SIGTERM")) {
476 define("SIGTERM", 15);
480 * Depending on the PHP version this constant does exist - or not.
481 * See here: http://php.net/manual/en/curl.constants.php#117928
483 if (!defined('CURLE_OPERATION_TIMEDOUT')) {
484 define('CURLE_OPERATION_TIMEDOUT', CURLE_OPERATION_TIMEOUTED);
487 * Reverse the effect of magic_quotes_gpc if it is enabled.
488 * Please disable magic_quotes_gpc so we don't have to do this.
489 * See http://php.net/manual/en/security.magicquotes.disabling.php
493 error_reporting(E_ERROR | E_WARNING | E_PARSE);
497 // This has to be quite large to deal with embedded private photos
498 ini_set('pcre.backtrack_limit', 500000);
500 if (get_magic_quotes_gpc()) {
501 $process = array(&$_GET, &$_POST, &$_COOKIE, &$_REQUEST);
502 while (list($key, $val) = each($process)) {
503 foreach ($val as $k => $v) {
504 unset($process[$key][$k]);
506 $process[$key][stripslashes($k)] = $v;
507 $process[] = &$process[$key][stripslashes($k)];
509 $process[$key][stripslashes($k)] = stripslashes($v);
518 * @brief Retrieve the App structure
520 * Useful in functions which require it but don't get it passed to them
527 $a = new App(dirname(__DIR__));
534 * @brief Multi-purpose function to check variable state.
536 * Usage: x($var) or $x($array, 'key')
538 * returns false if variable/key is not set
539 * if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0.
540 * e.g. x('') or x(0) returns 0;
542 * @param string|array $s variable to check
543 * @param string $k key inside the array to check
547 function x($s, $k = null)
550 if ((is_array($s)) && (array_key_exists($k, $s))) {
569 * @brief Called from db initialisation if db is dead.
571 function system_unavailable()
573 include 'system_unavailable.php';
579 * @brief Returns the baseurl.
581 * @see System::baseUrl()
584 * @TODO Function is deprecated and only used in some addons
588 return System::baseUrl();
592 * @brief Return absolut URL for given $path.
594 * @param string $path given path
598 function absurl($path)
600 if (strpos($path, '/') === 0) {
601 return z_path() . $path;
607 * @brief Function to check if request was an AJAX (xmlhttprequest) request.
613 return (!empty($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest');
617 * @brief Function to check if request was an AJAX (xmlhttprequest) request.
619 * @param boolean $via_worker boolean Is the check run via the worker?
621 function check_db($via_worker)
623 $build = Config::get('system', 'build');
625 Config::set('system', 'build', DB_UPDATE_VERSION);
626 $build = DB_UPDATE_VERSION;
628 if ($build != DB_UPDATE_VERSION) {
629 // When we cannot execute the database update via the worker, we will do it directly
630 if (!Worker::add(PRIORITY_CRITICAL, 'DBUpdate') && $via_worker) {
631 update_db(get_app());
637 * Sets the base url for use in cmdline programs which don't have
640 * @param object $a App
642 function check_url(App $a)
644 $url = Config::get('system', 'url');
646 // if the url isn't set or the stored url is radically different
647 // than the currently visited url, store the current value accordingly.
648 // "Radically different" ignores common variations such as http vs https
649 // and www.example.com vs example.com.
650 // We will only change the url to an ip address if there is no existing setting
653 $url = Config::set('system', 'url', System::baseUrl());
655 if ((!link_compare($url, System::baseUrl())) && (!preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/", $a->get_hostname))) {
656 $url = Config::set('system', 'url', System::baseUrl());
663 * @brief Automatic database updates
664 * @param object $a App
666 function update_db(App $a)
668 $build = Config::get('system', 'build');
670 $build = Config::set('system', 'build', DB_UPDATE_VERSION);
673 if ($build != DB_UPDATE_VERSION) {
674 $stored = intval($build);
675 $current = intval(DB_UPDATE_VERSION);
676 if ($stored < $current) {
677 Config::load('database');
679 // We're reporting a different version than what is currently installed.
680 // Run any existing update scripts to bring the database up to current.
681 // make sure that boot.php and update.php are the same release, we might be
682 // updating right this very second and the correct version of the update.php
683 // file may not be here yet. This can happen on a very busy site.
685 if (DB_UPDATE_VERSION == UPDATE_VERSION) {
686 // Compare the current structure with the defined structure
688 $t = Config::get('database', 'dbupdate_' . DB_UPDATE_VERSION);
693 Config::set('database', 'dbupdate_' . DB_UPDATE_VERSION, time());
695 // run old update routine (wich could modify the schema and
696 // conflits with new routine)
697 for ($x = $stored; $x < NEW_UPDATE_ROUTINE_VERSION; $x++) {
698 $r = run_update_function($x);
703 if ($stored < NEW_UPDATE_ROUTINE_VERSION) {
704 $stored = NEW_UPDATE_ROUTINE_VERSION;
707 // run new update routine
708 // it update the structure in one call
709 $retval = update_structure(false, true);
717 Config::set('database', 'dbupdate_' . DB_UPDATE_VERSION, 'success');
720 // run any left update_nnnn functions in update.php
721 for ($x = $stored; $x < $current; $x ++) {
722 $r = run_update_function($x);
734 function run_update_function($x)
736 if (function_exists('update_' . $x)) {
737 // There could be a lot of processes running or about to run.
738 // We want exactly one process to run the update command.
739 // So store the fact that we're taking responsibility
740 // after first checking to see if somebody else already has.
741 // If the update fails or times-out completely you may need to
742 // delete the config entry to try again.
744 $t = Config::get('database', 'update_' . $x);
748 Config::set('database', 'update_' . $x, time());
750 // call the specific update
752 $func = 'update_' . $x;
756 //send the administrator an e-mail
759 sprintf(t('Update %s failed. See error logs.'), $x)
763 Config::set('database', 'update_' . $x, 'success');
764 Config::set('system', 'build', $x + 1);
768 Config::set('database', 'update_' . $x, 'success');
769 Config::set('system', 'build', $x + 1);
776 * @brief Synchronise plugins:
778 * $a->config['system']['addon'] contains a comma-separated list of names
779 * of plugins/addons which are used on this system.
780 * Go through the database list of already installed addons, and if we have
781 * an entry, but it isn't in the config list, call the uninstall procedure
782 * and mark it uninstalled in the database (for now we'll remove it).
783 * Then go through the config list and if we have a plugin that isn't installed,
784 * call the install procedure and add it to the database.
786 * @param object $a App
788 function check_plugins(App $a)
790 $r = q("SELECT * FROM `addon` WHERE `installed` = 1");
791 if (DBM::is_result($r)) {
794 $installed = array();
797 $plugins = Config::get('system', 'addon');
798 $plugins_arr = array();
801 $plugins_arr = explode(',', str_replace(' ', '', $plugins));
804 $a->plugins = $plugins_arr;
806 $installed_arr = array();
808 if (count($installed)) {
809 foreach ($installed as $i) {
810 if (!in_array($i['name'], $plugins_arr)) {
811 uninstall_plugin($i['name']);
813 $installed_arr[] = $i['name'];
818 if (count($plugins_arr)) {
819 foreach ($plugins_arr as $p) {
820 if (!in_array($p, $installed_arr)) {
831 function get_guid($size = 16, $prefix = "")
835 $prefix = hash("crc32", $a->get_hostname());
838 while (strlen($prefix) < ($size - 13)) {
839 $prefix .= mt_rand();
843 $prefix = substr($prefix, 0, $size - 22);
844 return(str_replace(".", "", uniqid($prefix, true)));
846 $prefix = substr($prefix, 0, max($size - 13, 0));
847 return(uniqid($prefix));
852 * @brief Wrapper for adding a login box.
854 * @param bool $register If $register == true provide a registration link.
855 * This will most always depend on the value of $a->config['register_policy'].
856 * @param bool $hiddens optional
858 * @return string Returns the complete html for inserting into the page
860 * @hooks 'login_hook'
863 function login($register = false, $hiddens = false)
870 'title' => t('Create a New Account'),
871 'desc' => t('Register')
875 $noid = Config::get('system', 'no_openid');
877 $dest_url = $a->query_string;
880 $tpl = get_markup_template("logout.tpl");
882 $a->page['htmlhead'] .= replace_macros(
883 get_markup_template("login_head.tpl"),
885 '$baseurl' => $a->get_baseurl(true)
889 $tpl = get_markup_template("login.tpl");
890 $_SESSION['return_url'] = $a->query_string;
891 $a->module = 'login';
894 $o .= replace_macros(
897 '$dest_url' => $dest_url,
898 '$logout' => t('Logout'),
899 '$login' => t('Login'),
901 '$lname' => array('username', t('Nickname or Email: ') , '', ''),
902 '$lpassword' => array('password', t('Password: '), '', ''),
903 '$lremember' => array('remember', t('Remember me'), 0, ''),
906 '$lopenid' => array('openid_url', t('Or login using OpenID: '),'',''),
908 '$hiddens' => $hiddens,
912 '$lostpass' => t('Forgot your password?'),
913 '$lostlink' => t('Password Reset'),
915 '$tostitle' => t('Website Terms of Service'),
916 '$toslink' => t('terms of service'),
918 '$privacytitle' => t('Website Privacy Policy'),
919 '$privacylink' => t('privacy policy'),
923 call_hooks('login_hook', $o);
929 * @brief Used to end the current process, after saving session state.
933 global $session_exists;
935 if (!get_app()->is_backend()) {
936 if (!$session_exists) {
939 session_write_close();
947 * @brief Redirect to another URL and terminate this process.
951 if (!strstr(normalise_link($s), "http://")) {
952 $s = System::baseUrl() . "/" . $s;
955 header("Location: $s");
960 * @brief Returns the user id of locally logged in user or false.
962 * @return int|bool user id or false
964 function local_user()
966 if (x($_SESSION, 'authenticated') && x($_SESSION, 'uid')) {
967 return intval($_SESSION['uid']);
973 * @brief Returns the public contact id of logged in user or false.
975 * @return int|bool public contact id or false
977 function public_contact()
979 static $public_contact_id = false;
981 if (!$public_contact_id && x($_SESSION, 'authenticated')) {
982 if (x($_SESSION, 'my_address')) {
984 $public_contact_id = intval(Contact::getIdForURL($_SESSION['my_address'], 0));
985 } elseif (x($_SESSION, 'visitor_home')) {
987 $public_contact_id = intval(Contact::getIdForURL($_SESSION['visitor_home'], 0));
989 } elseif (!x($_SESSION, 'authenticated')) {
990 $public_contact_id = false;
993 return $public_contact_id;
997 * @brief Returns contact id of authenticated site visitor or false
999 * @return int|bool visitor_id or false
1001 function remote_user()
1003 // You cannot be both local and remote
1007 if ((x($_SESSION, 'authenticated')) && (x($_SESSION, 'visitor_id'))) {
1008 return intval($_SESSION['visitor_id']);
1014 * @brief Show an error message to user.
1016 * This function save text in session, to be shown to the user at next page load
1018 * @param string $s - Text of notice
1023 if (!x($_SESSION, 'sysmsg')) {
1024 $_SESSION['sysmsg'] = array();
1026 if ($a->interactive) {
1027 $_SESSION['sysmsg'][] = $s;
1032 * @brief Show an info message to user.
1034 * This function save text in session, to be shown to the user at next page load
1036 * @param string $s - Text of notice
1042 if (local_user() && PConfig::get(local_user(), 'system', 'ignore_info')) {
1046 if (!x($_SESSION, 'sysmsg_info')) {
1047 $_SESSION['sysmsg_info'] = array();
1049 if ($a->interactive) {
1050 $_SESSION['sysmsg_info'][] = $s;
1055 * @brief Wrapper around config to limit the text length of an incoming message
1059 function get_max_import_size()
1062 return ((x($a->config, 'max_import_size')) ? $a->config['max_import_size'] : 0 );
1066 function current_theme()
1068 $app_base_themes = array('duepuntozero', 'dispy', 'quattro');
1074 // Find the theme that belongs to the user whose stuff we are looking at
1076 if ($a->profile_uid && ($a->profile_uid != local_user())) {
1078 "select theme from user where uid = %d limit 1",
1079 intval($a->profile_uid)
1081 if (DBM::is_result($r)) {
1082 $page_theme = $r[0]['theme'];
1086 // Allow folks to over-rule user themes and always use their own on their own site.
1087 // This works only if the user is on the same server
1089 if ($page_theme && local_user() && (local_user() != $a->profile_uid)) {
1090 if (PConfig::get(local_user(), 'system', 'always_my_theme')) {
1095 // $mobile_detect = new Mobile_Detect();
1096 // $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
1097 $is_mobile = $a->is_mobile || $a->is_tablet;
1099 $standard_system_theme = Config::get('system', 'theme', '');
1100 $standard_theme_name = ((isset($_SESSION) && x($_SESSION, 'theme')) ? $_SESSION['theme'] : $standard_system_theme);
1103 if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
1104 $system_theme = $standard_system_theme;
1105 $theme_name = $standard_theme_name;
1107 $system_theme = Config::get('system', 'mobile-theme', '');
1108 if ($system_theme == '') {
1109 $system_theme = $standard_system_theme;
1111 $theme_name = ((isset($_SESSION) && x($_SESSION, 'mobile-theme')) ? $_SESSION['mobile-theme'] : $system_theme);
1113 if ($theme_name === '---') {
1114 // user has selected to have the mobile theme be the same as the normal one
1115 $system_theme = $standard_system_theme;
1116 $theme_name = $standard_theme_name;
1119 $theme_name = $page_theme;
1124 $system_theme = $standard_system_theme;
1125 $theme_name = $standard_theme_name;
1128 $theme_name = $page_theme;
1133 && (file_exists('view/theme/' . $theme_name . '/style.css')
1134 || file_exists('view/theme/' . $theme_name . '/style.php'))
1136 return($theme_name);
1139 foreach ($app_base_themes as $t) {
1140 if (file_exists('view/theme/' . $t . '/style.css')
1141 || file_exists('view/theme/' . $t . '/style.php')
1147 $fallback = array_merge(glob('view/theme/*/style.css'), glob('view/theme/*/style.php'));
1148 if (count($fallback)) {
1149 return (str_replace('view/theme/', '', substr($fallback[0], 0, -10)));
1152 /// @TODO No final return statement?
1156 * @brief Return full URL to theme which is currently in effect.
1158 * Provide a sane default if nothing is chosen or the specified theme does not exist.
1162 function current_theme_url()
1166 $t = current_theme();
1168 $opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : '');
1169 if (file_exists('view/theme/' . $t . '/style.php')) {
1170 return('view/theme/' . $t . '/style.pcss' . $opts);
1173 return('view/theme/' . $t . '/style.css');
1176 function feed_birthday($uid, $tz)
1179 * Determine the next birthday, but only if the birthday is published
1180 * in the default profile. We _could_ also look for a private profile that the
1181 * recipient can see, but somebody could get mad at us if they start getting
1182 * public birthday greetings when they haven't made this info public.
1184 * Assuming we are able to publish this info, we are then going to convert
1185 * the start time from the owner's timezone to UTC.
1187 * This will potentially solve the problem found with some social networks
1188 * where birthdays are converted to the viewer's timezone and salutations from
1189 * elsewhere in the world show up on the wrong day. We will convert it to the
1190 * viewer's timezone also, but first we are going to convert it from the birthday
1191 * person's timezone to GMT - so the viewer may find the birthday starting at
1192 * 6:00PM the day before, but that will correspond to midnight to the birthday person.
1201 "SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1",
1205 if (DBM::is_result($p)) {
1206 $tmp_dob = substr($p[0]['dob'], 5);
1207 if (intval($tmp_dob)) {
1208 $y = datetime_convert($tz, $tz, 'now', 'Y');
1209 $bd = $y . '-' . $tmp_dob . ' 00:00';
1210 $t_dob = strtotime($bd);
1211 $now = strtotime(datetime_convert($tz, $tz, 'now'));
1212 if ($t_dob < $now) {
1213 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
1215 $birthday = datetime_convert($tz, 'UTC', $bd, ATOM_TIME);
1223 * @brief Check if current user has admin role.
1225 * @return bool true if user is an admin
1227 function is_site_admin()
1231 $adminlist = explode(",", str_replace(" ", "", $a->config['admin_email']));
1233 //if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && ($a->user['email'] === $a->config['admin_email']))
1234 if (local_user() && x($a->user, 'email') && x($a->config, 'admin_email') && in_array($a->user['email'], $adminlist)) {
1241 * @brief Returns querystring as string from a mapped array.
1243 * @param array $params mapped array with query parameters
1244 * @param string $name of parameter, default null
1248 function build_querystring($params, $name = null)
1251 foreach ($params as $key => $val) {
1252 if (is_array($val)) {
1253 /// @TODO maybe not compare against null, use is_null()
1254 if ($name == null) {
1255 $ret .= build_querystring($val, $key);
1257 $ret .= build_querystring($val, $name . "[$key]");
1260 $val = urlencode($val);
1261 /// @TODO maybe not compare against null, use is_null()
1262 if ($name != null) {
1263 /// @TODO two string concated, can be merged to one
1264 $ret .= $name . "[$key]" . "=$val&";
1266 $ret .= "$key=$val&";
1273 function explode_querystring($query)
1275 $arg_st = strpos($query, '?');
1276 if ($arg_st !== false) {
1277 $base = substr($query, 0, $arg_st);
1284 $args = explode('&', substr($query, $arg_st));
1285 foreach ($args as $k => $arg) {
1286 /// @TODO really compare type-safe here?
1291 $args = array_values($args);
1296 $args = array_values($args);
1306 * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
1308 * Taken from http://webcheatsheet.com/php/get_current_page_url.php
1310 function curPageURL()
1313 if ($_SERVER["HTTPS"] == "on") {
1319 if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
1320 $pageURL .= $_SERVER["SERVER_NAME"] . ":" . $_SERVER["SERVER_PORT"] . $_SERVER["REQUEST_URI"];
1322 $pageURL .= $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"];
1327 function random_digits($digits)
1330 for ($i = 0; $i < $digits; $i++) {
1331 /// @TODO rand() is different to mt_rand() and maybe lesser "random"
1337 function get_server()
1339 $server = Config::get("system", "directory");
1341 if ($server == "") {
1342 $server = "http://dir.friendica.social";
1348 function get_temppath()
1352 $temppath = Config::get("system", "temppath");
1354 if (($temppath != "") && App::directory_usable($temppath)) {
1355 // We have a temp path and it is usable
1356 return App::realpath($temppath);
1359 // We don't have a working preconfigured temp path, so we take the system path.
1360 $temppath = sys_get_temp_dir();
1362 // Check if it is usable
1363 if (($temppath != "") && App::directory_usable($temppath)) {
1364 // Always store the real path, not the path through symlinks
1365 $temppath = App::realpath($temppath);
1367 // To avoid any interferences with other systems we create our own directory
1368 $new_temppath = $temppath . "/" . $a->get_hostname();
1369 if (!is_dir($new_temppath)) {
1370 /// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
1371 mkdir($new_temppath);
1374 if (App::directory_usable($new_temppath)) {
1375 // The new path is usable, we are happy
1376 Config::set("system", "temppath", $new_temppath);
1377 return $new_temppath;
1379 // We can't create a subdirectory, strange.
1380 // But the directory seems to work, so we use it but don't store it.
1385 // Reaching this point means that the operating system is configured badly.
1389 function get_cachefile($file, $writemode = true)
1391 $cache = get_itemcachepath();
1393 if ((!$cache) || (!is_dir($cache))) {
1397 $subfolder = $cache . "/" . substr($file, 0, 2);
1399 $cachepath = $subfolder . "/" . $file;
1402 if (!is_dir($subfolder)) {
1404 chmod($subfolder, 0777);
1408 /// @TODO no need to put braces here
1412 function clear_cache($basepath = "", $path = "")
1415 $basepath = get_itemcachepath();
1419 if (($path == "") || (!is_dir($path))) {
1423 if (substr(realpath($path), 0, strlen($basepath)) != $basepath) {
1427 $cachetime = (int) Config::get('system', 'itemcache_duration');
1428 if ($cachetime == 0) {
1432 if (is_writable($path)) {
1433 if ($dh = opendir($path)) {
1434 while (($file = readdir($dh)) !== false) {
1435 $fullpath = $path . "/" . $file;
1436 if ((filetype($fullpath) == "dir") && ($file != ".") && ($file != "..")) {
1437 clear_cache($basepath, $fullpath);
1439 if ((filetype($fullpath) == "file") && (filectime($fullpath) < (time() - $cachetime))) {
1448 function get_itemcachepath()
1450 // Checking, if the cache is deactivated
1451 $cachetime = (int) Config::get('system', 'itemcache_duration');
1452 if ($cachetime < 0) {
1456 $itemcache = Config::get('system', 'itemcache');
1457 if (($itemcache != "") && App::directory_usable($itemcache)) {
1458 return App::realpath($itemcache);
1461 $temppath = get_temppath();
1463 if ($temppath != "") {
1464 $itemcache = $temppath . "/itemcache";
1465 if (!file_exists($itemcache) && !is_dir($itemcache)) {
1469 if (App::directory_usable($itemcache)) {
1470 Config::set("system", "itemcache", $itemcache);
1478 * @brief Returns the path where spool files are stored
1480 * @return string Spool path
1482 function get_spoolpath()
1484 $spoolpath = Config::get('system', 'spoolpath');
1485 if (($spoolpath != "") && App::directory_usable($spoolpath)) {
1486 // We have a spool path and it is usable
1490 // We don't have a working preconfigured spool path, so we take the temp path.
1491 $temppath = get_temppath();
1493 if ($temppath != "") {
1494 // To avoid any interferences with other systems we create our own directory
1495 $spoolpath = $temppath . "/spool";
1496 if (!is_dir($spoolpath)) {
1500 if (App::directory_usable($spoolpath)) {
1501 // The new path is usable, we are happy
1502 Config::set("system", "spoolpath", $spoolpath);
1505 // We can't create a subdirectory, strange.
1506 // But the directory seems to work, so we use it but don't store it.
1511 // Reaching this point means that the operating system is configured badly.
1516 if (!function_exists('exif_imagetype')) {
1517 function exif_imagetype($file)
1519 $size = getimagesize($file);
1524 function validate_include(&$file)
1528 $file = realpath($file);
1530 if (strpos($file, getcwd()) !== 0) {
1534 $file = str_replace(getcwd() . "/", "", $file, $count);
1539 if ($orig_file !== $file) {
1544 if (strpos($file, "include/") === 0) {
1548 if (strpos($file, "addon/") === 0) {
1552 // Simply return flag
1556 function current_load()
1558 if (!function_exists('sys_getloadavg')) {
1562 $load_arr = sys_getloadavg();
1564 if (!is_array($load_arr)) {
1568 return max($load_arr[0], $load_arr[1]);
1572 * @brief get c-style args
1578 return get_app()->argc;
1582 * @brief Returns the value of a argv key
1584 * @param int $x argv key
1585 * @return string Value of the argv key
1589 if (array_key_exists($x, get_app()->argv)) {
1590 return get_app()->argv[$x];
1597 * @brief Get the data which is needed for infinite scroll
1599 * For invinite scroll we need the page number of the actual page
1600 * and the the URI where the content of the next page comes from.
1601 * This data is needed for the js part in main.js.
1602 * Note: infinite scroll does only work for the network page (module)
1604 * @param string $module The name of the module (e.g. "network")
1605 * @return array Of infinite scroll data
1606 * 'pageno' => $pageno The number of the actual page
1607 * 'reload_uri' => $reload_uri The URI of the content we have to load
1609 function infinite_scroll_data($module)
1611 if (PConfig::get(local_user(), 'system', 'infinite_scroll')
1612 && ($module == "network") && ($_GET["mode"] != "minimal")
1614 // get the page number
1615 if (is_string($_GET["page"])) {
1616 $pageno = $_GET["page"];
1623 // try to get the uri from which we load the content
1624 foreach ($_GET as $param => $value) {
1625 if (($param != "page") && ($param != "q")) {
1626 $reload_uri .= "&" . $param . "=" . urlencode($value);
1630 if (($a->page_offset != "") && ! strstr($reload_uri, "&offset=")) {
1631 $reload_uri .= "&offset=" . urlencode($a->page_offset);
1634 $arr = array("pageno" => $pageno, "reload_uri" => $reload_uri);