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\Config;
26 use Friendica\Util\Lock;
28 require_once 'include/config.php';
29 require_once 'include/network.php';
30 require_once 'include/plugin.php';
31 require_once 'include/text.php';
32 require_once 'include/datetime.php';
33 require_once 'include/pgettext.php';
34 require_once 'include/nav.php';
35 require_once 'include/cache.php';
36 require_once 'include/features.php';
37 require_once 'include/identity.php';
38 require_once 'update.php';
39 require_once 'include/dbstructure.php';
40 require_once 'include/poller.php';
42 define ( 'FRIENDICA_PLATFORM', 'Friendica');
43 define ( 'FRIENDICA_CODENAME', 'Asparagus');
44 define ( 'FRIENDICA_VERSION', '3.6-dev' );
45 define ( 'DFRN_PROTOCOL_VERSION', '2.23' );
46 define ( 'DB_UPDATE_VERSION', 1235 );
49 * @brief Constant with a HTML line break.
51 * Contains a HTML line break (br) element and a real carriage return with line
52 * feed for the source.
53 * This can be used in HTML and JavaScript where needed a line break.
55 define ( 'EOL', "<br />\r\n" );
56 define ( 'ATOM_TIME', 'Y-m-d\TH:i:s\Z' );
59 * @brief Image storage quality.
61 * Lower numbers save space at cost of image detail.
62 * For ease of upgrade, please do not change here. Change jpeg quality with
63 * $a->config['system']['jpeg_quality'] = n;
64 * 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 );
77 * An alternate way of limiting picture upload sizes. Specify the maximum pixel
78 * length that pictures are allowed to be (for non-square pictures, it will apply
79 * to the longest side). Pictures longer than this length will be resized to be
80 * this length (on the longest side, the other side will be scaled appropriately).
81 * Modify this value using
83 * $a->config['system']['max_image_length'] = n;
87 * If you don't want to set a maximum length, set to -1. The default value is
88 * defined by 'MAX_IMAGE_LENGTH' below.
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 );
128 define ( 'CACHE_MONTH', 0 );
129 define ( 'CACHE_WEEK', 1 );
130 define ( 'CACHE_DAY', 2 );
131 define ( 'CACHE_HOUR', 3 );
132 define ( 'CACHE_HALF_HOUR', 4 );
133 define ( 'CACHE_QUARTER_HOUR', 5 );
134 define ( 'CACHE_FIVE_MINUTES', 6 );
135 define ( 'CACHE_MINUTE', 7 );
141 * Registration policies
144 define ( 'REGISTER_CLOSED', 0 );
145 define ( 'REGISTER_APPROVE', 1 );
146 define ( 'REGISTER_OPEN', 2 );
155 define ( 'CONTACT_IS_FOLLOWER', 1);
156 define ( 'CONTACT_IS_SHARING', 2);
157 define ( 'CONTACT_IS_FRIEND', 3);
163 * DB update return values
166 define ( 'UPDATE_SUCCESS', 0);
167 define ( 'UPDATE_FAILED', 1);
171 * @name page/profile types
173 * PAGE_NORMAL is a typical personal profile account
174 * PAGE_SOAPBOX automatically approves all friend requests as CONTACT_IS_SHARING, (readonly)
175 * PAGE_COMMUNITY automatically approves all friend requests as CONTACT_IS_SHARING, but with
176 * write access to wall and comments (no email and not included in page owner's ACL lists)
177 * PAGE_FREELOVE automatically approves all friend requests as full friends (CONTACT_IS_FRIEND).
181 define ( 'PAGE_NORMAL', 0 );
182 define ( 'PAGE_SOAPBOX', 1 );
183 define ( 'PAGE_COMMUNITY', 2 );
184 define ( 'PAGE_FREELOVE', 3 );
185 define ( 'PAGE_BLOG', 4 );
186 define ( 'PAGE_PRVGROUP', 5 );
190 * @name account types
192 * ACCOUNT_TYPE_PERSON - the account belongs to a person
193 * Associated page types: PAGE_NORMAL, PAGE_SOAPBOX, PAGE_FREELOVE
195 * ACCOUNT_TYPE_ORGANISATION - the account belongs to an organisation
196 * Associated page type: PAGE_SOAPBOX
198 * ACCOUNT_TYPE_NEWS - the account is a news reflector
199 * Associated page type: PAGE_SOAPBOX
201 * ACCOUNT_TYPE_COMMUNITY - the account is community forum
202 * Associated page types: PAGE_COMMUNITY, PAGE_PRVGROUP
205 define ( 'ACCOUNT_TYPE_PERSON', 0 );
206 define ( 'ACCOUNT_TYPE_ORGANISATION',1 );
207 define ( 'ACCOUNT_TYPE_NEWS', 2 );
208 define ( 'ACCOUNT_TYPE_COMMUNITY', 3 );
214 * Type of the community page
217 define ( 'CP_NO_COMMUNITY_PAGE', -1 );
218 define ( 'CP_USERS_ON_SERVER', 0 );
219 define ( 'CP_GLOBAL_COMMUNITY', 1 );
225 * Different protocols that we are storing
228 define('PROTOCOL_UNKNOWN', 0);
229 define('PROTOCOL_DFRN', 1);
230 define('PROTOCOL_DIASPORA', 2);
231 define('PROTOCOL_OSTATUS_SALMON', 3);
232 define('PROTOCOL_OSTATUS_FEED', 4); // Deprecated
233 define('PROTOCOL_GS_CONVERSATION', 5); // Deprecated
234 define('PROTOCOL_SPLITTED_CONV', 6);
240 * Network and protocol family types
243 define ( 'NETWORK_DFRN', 'dfrn'); // Friendica, Mistpark, other DFRN implementations
244 define ( 'NETWORK_ZOT', 'zot!'); // Zot!
245 define ( 'NETWORK_OSTATUS', 'stat'); // status.net, identi.ca, GNU-social, other OStatus implementations
246 define ( 'NETWORK_FEED', 'feed'); // RSS/Atom feeds with no known "post/notify" protocol
247 define ( 'NETWORK_DIASPORA', 'dspr'); // Diaspora
248 define ( 'NETWORK_MAIL', 'mail'); // IMAP/POP
249 define ( 'NETWORK_MAIL2', 'mai2'); // extended IMAP/POP
250 define ( 'NETWORK_FACEBOOK', 'face'); // Facebook API
251 define ( 'NETWORK_LINKEDIN', 'lnkd'); // LinkedIn
252 define ( 'NETWORK_XMPP', 'xmpp'); // XMPP
253 define ( 'NETWORK_MYSPACE', 'mysp'); // MySpace
254 define ( 'NETWORK_GPLUS', 'goog'); // Google+
255 define ( 'NETWORK_PUMPIO', 'pump'); // pump.io
256 define ( 'NETWORK_TWITTER', 'twit'); // Twitter
257 define ( 'NETWORK_DIASPORA2', 'dspc'); // Diaspora connector
258 define ( 'NETWORK_STATUSNET', 'stac'); // Statusnet connector
259 define ( 'NETWORK_APPNET', 'apdn'); // app.net
260 define ( 'NETWORK_NEWS', 'nntp'); // Network News Transfer Protocol
261 define ( 'NETWORK_ICALENDAR', 'ical'); // iCalendar
262 define ( 'NETWORK_PNUT', 'pnut'); // pnut.io
263 define ( 'NETWORK_PHANTOM', 'unkn'); // Place holder
267 * These numbers are used in stored permissions
268 * and existing allocations MUST NEVER BE CHANGED
269 * OR RE-ASSIGNED! You may only add to them.
271 $netgroup_ids = array(
272 NETWORK_DFRN => (-1),
274 NETWORK_OSTATUS => (-3),
275 NETWORK_FEED => (-4),
276 NETWORK_DIASPORA => (-5),
277 NETWORK_MAIL => (-6),
278 NETWORK_MAIL2 => (-7),
279 NETWORK_FACEBOOK => (-8),
280 NETWORK_LINKEDIN => (-9),
281 NETWORK_XMPP => (-10),
282 NETWORK_MYSPACE => (-11),
283 NETWORK_GPLUS => (-12),
284 NETWORK_PUMPIO => (-13),
285 NETWORK_TWITTER => (-14),
286 NETWORK_DIASPORA2 => (-15),
287 NETWORK_STATUSNET => (-16),
288 NETWORK_APPNET => (-17),
289 NETWORK_NEWS => (-18),
290 NETWORK_ICALENDAR => (-19),
291 NETWORK_PNUT => (-20),
293 NETWORK_PHANTOM => (-127),
297 * Maximum number of "people who like (or don't like) this" that we will list by name
299 define ( 'MAX_LIKERS', 75);
302 * Communication timeout
304 define ( 'ZCURL_TIMEOUT' , (-1));
309 * Email notification options
312 define ( 'NOTIFY_INTRO', 0x0001 );
313 define ( 'NOTIFY_CONFIRM', 0x0002 );
314 define ( 'NOTIFY_WALL', 0x0004 );
315 define ( 'NOTIFY_COMMENT', 0x0008 );
316 define ( 'NOTIFY_MAIL', 0x0010 );
317 define ( 'NOTIFY_SUGGEST', 0x0020 );
318 define ( 'NOTIFY_PROFILE', 0x0040 );
319 define ( 'NOTIFY_TAGSELF', 0x0080 );
320 define ( 'NOTIFY_TAGSHARE', 0x0100 );
321 define ( 'NOTIFY_POKE', 0x0200 );
322 define ( 'NOTIFY_SHARE', 0x0400 );
324 define ( 'SYSTEM_EMAIL', 0x4000 );
326 define ( 'NOTIFY_SYSTEM', 0x8000 );
336 define ( 'TERM_UNKNOWN', 0 );
337 define ( 'TERM_HASHTAG', 1 );
338 define ( 'TERM_MENTION', 2 );
339 define ( 'TERM_CATEGORY', 3 );
340 define ( 'TERM_PCATEGORY', 4 );
341 define ( 'TERM_FILE', 5 );
342 define ( 'TERM_SAVEDSEARCH', 6 );
343 define ( 'TERM_CONVERSATION', 7 );
345 define ( 'TERM_OBJ_POST', 1 );
346 define ( 'TERM_OBJ_PHOTO', 2 );
351 * Various namespaces we may need to parse
354 define ( 'NAMESPACE_ZOT', 'http://purl.org/zot' );
355 define ( 'NAMESPACE_DFRN' , 'http://purl.org/macgirvin/dfrn/1.0' );
356 define ( 'NAMESPACE_THREAD' , 'http://purl.org/syndication/thread/1.0' );
357 define ( 'NAMESPACE_TOMB' , 'http://purl.org/atompub/tombstones/1.0' );
358 define ( 'NAMESPACE_ACTIVITY', 'http://activitystrea.ms/spec/1.0/' );
359 define ( 'NAMESPACE_ACTIVITY_SCHEMA', 'http://activitystrea.ms/schema/1.0/' );
360 define ( 'NAMESPACE_MEDIA', 'http://purl.org/syndication/atommedia' );
361 define ( 'NAMESPACE_SALMON_ME', 'http://salmon-protocol.org/ns/magic-env' );
362 define ( 'NAMESPACE_OSTATUSSUB', 'http://ostatus.org/schema/1.0/subscribe' );
363 define ( 'NAMESPACE_GEORSS', 'http://www.georss.org/georss' );
364 define ( 'NAMESPACE_POCO', 'http://portablecontacts.net/spec/1.0' );
365 define ( 'NAMESPACE_FEED', 'http://schemas.google.com/g/2010#updates-from' );
366 define ( 'NAMESPACE_OSTATUS', 'http://ostatus.org/schema/1.0' );
367 define ( 'NAMESPACE_STATUSNET', 'http://status.net/schema/api/1/' );
368 define ( 'NAMESPACE_ATOM1', 'http://www.w3.org/2005/Atom' );
369 define ( 'NAMESPACE_MASTODON', 'http://mastodon.social/schema/1.0' );
375 * Activity stream defines
378 define ( 'ACTIVITY_LIKE', NAMESPACE_ACTIVITY_SCHEMA . 'like' );
379 define ( 'ACTIVITY_DISLIKE', NAMESPACE_DFRN . '/dislike' );
380 define ( 'ACTIVITY_ATTEND', NAMESPACE_ZOT . '/activity/attendyes' );
381 define ( 'ACTIVITY_ATTENDNO', NAMESPACE_ZOT . '/activity/attendno' );
382 define ( 'ACTIVITY_ATTENDMAYBE', NAMESPACE_ZOT . '/activity/attendmaybe' );
384 define ( 'ACTIVITY_OBJ_HEART', NAMESPACE_DFRN . '/heart' );
386 define ( 'ACTIVITY_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'make-friend' );
387 define ( 'ACTIVITY_REQ_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'request-friend' );
388 define ( 'ACTIVITY_UNFRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'remove-friend' );
389 define ( 'ACTIVITY_FOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'follow' );
390 define ( 'ACTIVITY_UNFOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'stop-following' );
391 define ( 'ACTIVITY_JOIN', NAMESPACE_ACTIVITY_SCHEMA . 'join' );
393 define ( 'ACTIVITY_POST', NAMESPACE_ACTIVITY_SCHEMA . 'post' );
394 define ( 'ACTIVITY_UPDATE', NAMESPACE_ACTIVITY_SCHEMA . 'update' );
395 define ( 'ACTIVITY_TAG', NAMESPACE_ACTIVITY_SCHEMA . 'tag' );
396 define ( 'ACTIVITY_FAVORITE', NAMESPACE_ACTIVITY_SCHEMA . 'favorite' );
397 define ( 'ACTIVITY_UNFAVORITE', NAMESPACE_ACTIVITY_SCHEMA . 'unfavorite' );
398 define ( 'ACTIVITY_SHARE', NAMESPACE_ACTIVITY_SCHEMA . 'share' );
399 define ( 'ACTIVITY_DELETE', NAMESPACE_ACTIVITY_SCHEMA . 'delete' );
401 define ( 'ACTIVITY_POKE', NAMESPACE_ZOT . '/activity/poke' );
402 define ( 'ACTIVITY_MOOD', NAMESPACE_ZOT . '/activity/mood' );
404 define ( 'ACTIVITY_OBJ_BOOKMARK', NAMESPACE_ACTIVITY_SCHEMA . 'bookmark' );
405 define ( 'ACTIVITY_OBJ_COMMENT', NAMESPACE_ACTIVITY_SCHEMA . 'comment' );
406 define ( 'ACTIVITY_OBJ_NOTE', NAMESPACE_ACTIVITY_SCHEMA . 'note' );
407 define ( 'ACTIVITY_OBJ_PERSON', NAMESPACE_ACTIVITY_SCHEMA . 'person' );
408 define ( 'ACTIVITY_OBJ_IMAGE', NAMESPACE_ACTIVITY_SCHEMA . 'image' );
409 define ( 'ACTIVITY_OBJ_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'photo' );
410 define ( 'ACTIVITY_OBJ_VIDEO', NAMESPACE_ACTIVITY_SCHEMA . 'video' );
411 define ( 'ACTIVITY_OBJ_P_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'profile-photo' );
412 define ( 'ACTIVITY_OBJ_ALBUM', NAMESPACE_ACTIVITY_SCHEMA . 'photo-album' );
413 define ( 'ACTIVITY_OBJ_EVENT', NAMESPACE_ACTIVITY_SCHEMA . 'event' );
414 define ( 'ACTIVITY_OBJ_GROUP', NAMESPACE_ACTIVITY_SCHEMA . 'group' );
415 define ( 'ACTIVITY_OBJ_TAGTERM', NAMESPACE_DFRN . '/tagterm' );
416 define ( 'ACTIVITY_OBJ_PROFILE', NAMESPACE_DFRN . '/profile' );
417 define ( 'ACTIVITY_OBJ_QUESTION', 'http://activityschema.org/object/question' );
423 * Item weight for query ordering
426 define ( 'GRAVITY_PARENT', 0);
427 define ( 'GRAVITY_LIKE', 3);
428 define ( 'GRAVITY_COMMENT', 6);
434 * Process priority for the worker
437 define('PRIORITY_UNDEFINED', 0);
438 define('PRIORITY_CRITICAL', 10);
439 define('PRIORITY_HIGH', 20);
440 define('PRIORITY_MEDIUM', 30);
441 define('PRIORITY_LOW', 40);
442 define('PRIORITY_NEGLIGIBLE',50);
446 * @name Social Relay settings
448 * See here: https://github.com/jaywink/social-relay
449 * and here: https://wiki.diasporafoundation.org/Relay_servers_for_public_posts
452 define('SR_SCOPE_NONE', '');
453 define('SR_SCOPE_ALL', 'all');
454 define('SR_SCOPE_TAGS', 'tags');
458 * Lowest possible date time value
460 define ('NULL_DATE', '0001-01-01 00:00:00');
462 // Normally this constant is defined - but not if "pcntl" isn't installed
463 if (!defined("SIGTERM")) {
464 define("SIGTERM", 15);
468 * Depending on the PHP version this constant does exist - or not.
469 * See here: http://php.net/manual/en/curl.constants.php#117928
471 if (!defined('CURLE_OPERATION_TIMEDOUT')) {
472 define('CURLE_OPERATION_TIMEDOUT', CURLE_OPERATION_TIMEOUTED);
476 * Reverse the effect of magic_quotes_gpc if it is enabled.
477 * Please disable magic_quotes_gpc so we don't have to do this.
478 * See http://php.net/manual/en/security.magicquotes.disabling.php
482 error_reporting(E_ERROR | E_WARNING | E_PARSE);
486 // This has to be quite large to deal with embedded private photos
487 ini_set('pcre.backtrack_limit', 500000);
489 if (get_magic_quotes_gpc()) {
490 $process = array(&$_GET, &$_POST, &$_COOKIE, &$_REQUEST);
491 while (list($key, $val) = each($process)) {
492 foreach ($val as $k => $v) {
493 unset($process[$key][$k]);
495 $process[$key][stripslashes($k)] = $v;
496 $process[] = &$process[$key][stripslashes($k)];
498 $process[$key][stripslashes($k)] = stripslashes($v);
507 * @brief Retrieve the App structure
509 * Useful in functions which require it but don't get it passed to them
515 $a = new App(dirname(__DIR__));
522 * @brief Multi-purpose function to check variable state.
524 * Usage: x($var) or $x($array, 'key')
526 * returns false if variable/key is not set
527 * if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0.
528 * e.g. x('') or x(0) returns 0;
530 * @param string|array $s variable to check
531 * @param string $k key inside the array to check
535 function x($s, $k = NULL) {
537 if ((is_array($s)) && (array_key_exists($k, $s))) {
556 * @brief Called from db initialisation if db is dead.
558 function system_unavailable() {
559 include('system_unavailable.php');
565 * @brief Returns the baseurl.
567 * @see System::baseUrl()
570 * @TODO Function is deprecated and only used in some addons
573 return System::baseUrl();
577 * @brief Return absolut URL for given $path.
579 * @param string $path
583 function absurl($path) {
584 if (strpos($path, '/') === 0) {
585 return z_path() . $path;
591 * @brief Function to check if request was an AJAX (xmlhttprequest) request.
596 return (!empty($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest');
600 * @brief Function to check if request was an AJAX (xmlhttprequest) request.
602 * @param $via_worker boolean Is the check run via the poller?
604 function check_db($via_worker) {
606 $build = get_config('system', 'build');
608 set_config('system', 'build', DB_UPDATE_VERSION);
609 $build = DB_UPDATE_VERSION;
611 if ($build != DB_UPDATE_VERSION) {
612 // When we cannot execute the database update via the worker, we will do it directly
613 if (!proc_run(PRIORITY_CRITICAL, 'include/dbupdate.php') && $via_worker) {
614 update_db(get_app());
620 * Sets the base url for use in cmdline programs which don't have
623 function check_url(App $a) {
625 $url = get_config('system', 'url');
627 // if the url isn't set or the stored url is radically different
628 // than the currently visited url, store the current value accordingly.
629 // "Radically different" ignores common variations such as http vs https
630 // and www.example.com vs example.com.
631 // We will only change the url to an ip address if there is no existing setting
634 $url = set_config('system', 'url', System::baseUrl());
636 if ((!link_compare($url, System::baseUrl())) && (!preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/", $a->get_hostname))) {
637 $url = set_config('system', 'url', System::baseUrl());
644 * @brief Automatic database updates
646 function update_db(App $a) {
647 $build = get_config('system', 'build');
649 $build = set_config('system', 'build', DB_UPDATE_VERSION);
652 if ($build != DB_UPDATE_VERSION) {
653 $stored = intval($build);
654 $current = intval(DB_UPDATE_VERSION);
655 if ($stored < $current) {
656 Config::load('database');
658 // We're reporting a different version than what is currently installed.
659 // Run any existing update scripts to bring the database up to current.
660 // make sure that boot.php and update.php are the same release, we might be
661 // updating right this very second and the correct version of the update.php
662 // file may not be here yet. This can happen on a very busy site.
664 if (DB_UPDATE_VERSION == UPDATE_VERSION) {
665 // Compare the current structure with the defined structure
667 $t = get_config('database', 'dbupdate_' . DB_UPDATE_VERSION);
672 set_config('database', 'dbupdate_' . DB_UPDATE_VERSION, time());
674 // run old update routine (wich could modify the schema and
675 // conflits with new routine)
676 for ($x = $stored; $x < NEW_UPDATE_ROUTINE_VERSION; $x++) {
677 $r = run_update_function($x);
682 if ($stored < NEW_UPDATE_ROUTINE_VERSION) {
683 $stored = NEW_UPDATE_ROUTINE_VERSION;
686 // run new update routine
687 // it update the structure in one call
688 $retval = update_structure(false, true);
696 set_config('database', 'dbupdate_' . DB_UPDATE_VERSION, 'success');
699 // run any left update_nnnn functions in update.php
700 for ($x = $stored; $x < $current; $x ++) {
701 $r = run_update_function($x);
713 function run_update_function($x) {
714 if (function_exists('update_' . $x)) {
716 // There could be a lot of processes running or about to run.
717 // We want exactly one process to run the update command.
718 // So store the fact that we're taking responsibility
719 // after first checking to see if somebody else already has.
720 // If the update fails or times-out completely you may need to
721 // delete the config entry to try again.
723 $t = get_config('database', 'update_' . $x);
727 set_config('database', 'update_' . $x, time());
729 // call the specific update
731 $func = 'update_' . $x;
735 //send the administrator an e-mail
738 sprintf(t('Update %s failed. See error logs.'), $x)
742 set_config('database', 'update_' . $x, 'success');
743 set_config('system', 'build', $x + 1);
747 set_config('database', 'update_' . $x, 'success');
748 set_config('system', 'build', $x + 1);
755 * @brief Synchronise plugins:
757 * $a->config['system']['addon'] contains a comma-separated list of names
758 * of plugins/addons which are used on this system.
759 * Go through the database list of already installed addons, and if we have
760 * an entry, but it isn't in the config list, call the uninstall procedure
761 * and mark it uninstalled in the database (for now we'll remove it).
762 * Then go through the config list and if we have a plugin that isn't installed,
763 * call the install procedure and add it to the database.
768 function check_plugins(App $a) {
770 $r = q("SELECT * FROM `addon` WHERE `installed` = 1");
771 if (dbm::is_result($r)) {
774 $installed = array();
777 $plugins = get_config('system', 'addon');
778 $plugins_arr = array();
781 $plugins_arr = explode(',', str_replace(' ', '', $plugins));
784 $a->plugins = $plugins_arr;
786 $installed_arr = array();
788 if (count($installed)) {
789 foreach ($installed as $i) {
790 if (!in_array($i['name'], $plugins_arr)) {
791 uninstall_plugin($i['name']);
793 $installed_arr[] = $i['name'];
798 if (count($plugins_arr)) {
799 foreach ($plugins_arr as $p) {
800 if (!in_array($p, $installed_arr)) {
811 function get_guid($size = 16, $prefix = "") {
814 $prefix = hash("crc32", $a->get_hostname());
817 while (strlen($prefix) < ($size - 13)) {
818 $prefix .= mt_rand();
822 $prefix = substr($prefix, 0, $size - 22);
823 return(str_replace(".", "", uniqid($prefix, true)));
825 $prefix = substr($prefix, 0, max($size - 13, 0));
826 return(uniqid($prefix));
831 * @brief Wrapper for adding a login box.
833 * @param bool $register
834 * If $register == true provide a registration link.
835 * This will most always depend on the value of $a->config['register_policy'].
836 * @param bool $hiddens
839 * Returns the complete html for inserting into the page
841 * @hooks 'login_hook'
844 function login($register = false, $hiddens = false) {
850 'title' => t('Create a New Account'),
851 'desc' => t('Register')
855 $noid = get_config('system', 'no_openid');
857 $dest_url = $a->query_string;
860 $tpl = get_markup_template("logout.tpl");
862 $a->page['htmlhead'] .= replace_macros(get_markup_template("login_head.tpl"), array(
863 '$baseurl' => $a->get_baseurl(true)
866 $tpl = get_markup_template("login.tpl");
867 $_SESSION['return_url'] = $a->query_string;
868 $a->module = 'login';
871 $o .= replace_macros($tpl, array(
873 '$dest_url' => $dest_url,
874 '$logout' => t('Logout'),
875 '$login' => t('Login'),
877 '$lname' => array('username', t('Nickname or Email: ') , '', ''),
878 '$lpassword' => array('password', t('Password: '), '', ''),
879 '$lremember' => array('remember', t('Remember me'), 0, ''),
882 '$lopenid' => array('openid_url', t('Or login using OpenID: '),'',''),
884 '$hiddens' => $hiddens,
888 '$lostpass' => t('Forgot your password?'),
889 '$lostlink' => t('Password Reset'),
891 '$tostitle' => t('Website Terms of Service'),
892 '$toslink' => t('terms of service'),
894 '$privacytitle' => t('Website Privacy Policy'),
895 '$privacylink' => t('privacy policy'),
898 call_hooks('login_hook', $o);
904 * @brief Used to end the current process, after saving session state.
907 global $session_exists;
909 if (!get_app()->is_backend()) {
910 if (!$session_exists) {
913 session_write_close();
921 * @brief Redirect to another URL and terminate this process.
923 function goaway($s) {
924 if (!strstr(normalise_link($s), "http://")) {
925 $s = System::baseUrl() . "/" . $s;
928 header("Location: $s");
933 * @brief Returns the user id of locally logged in user or false.
935 * @return int|bool user id or false
937 function local_user() {
938 if (x($_SESSION, 'authenticated') && x($_SESSION, 'uid')) {
939 return intval($_SESSION['uid']);
945 * @brief Returns the public contact id of logged in user or false.
947 * @return int|bool public contact id or false
949 function public_contact() {
950 static $public_contact_id = false;
952 if (!$public_contact_id && x($_SESSION, 'authenticated')) {
953 if (x($_SESSION, 'my_address')) {
955 $public_contact_id = intval(get_contact($_SESSION['my_address'], 0));
956 } elseif (x($_SESSION, 'visitor_home')) {
958 $public_contact_id = intval(get_contact($_SESSION['visitor_home'], 0));
960 } elseif (!x($_SESSION, 'authenticated')) {
961 $public_contact_id = false;
964 return $public_contact_id;
968 * @brief Returns contact id of authenticated site visitor or false
970 * @return int|bool visitor_id or false
972 function remote_user() {
973 // You cannot be both local and remote
977 if ((x($_SESSION, 'authenticated')) && (x($_SESSION, 'visitor_id'))) {
978 return intval($_SESSION['visitor_id']);
984 * @brief Show an error message to user.
986 * This function save text in session, to be shown to the user at next page load
988 * @param string $s - Text of notice
990 function notice($s) {
992 if (!x($_SESSION, 'sysmsg')) {
993 $_SESSION['sysmsg'] = array();
995 if ($a->interactive) {
996 $_SESSION['sysmsg'][] = $s;
1001 * @brief Show an info message to user.
1003 * This function save text in session, to be shown to the user at next page load
1005 * @param string $s - Text of notice
1010 if (local_user() && get_pconfig(local_user(), 'system', 'ignore_info')) {
1014 if (!x($_SESSION, 'sysmsg_info')) {
1015 $_SESSION['sysmsg_info'] = array();
1017 if ($a->interactive) {
1018 $_SESSION['sysmsg_info'][] = $s;
1023 * @brief Wrapper around config to limit the text length of an incoming message
1027 function get_max_import_size() {
1029 return ((x($a->config, 'max_import_size')) ? $a->config['max_import_size'] : 0 );
1033 * @brief Wrap calls to proc_close(proc_open()) and call hook
1034 * so plugins can take part in process :)
1036 * @param (integer|array) priority or parameter array, $cmd atrings are deprecated and are ignored
1038 * next args are passed as $cmd command line
1039 * or: proc_run(PRIORITY_HIGH, "include/notifier.php", "drop", $drop_id);
1040 * or: proc_run(array('priority' => PRIORITY_HIGH, 'dont_fork' => true), "include/create_shadowentry.php", $post_id);
1042 * @note $cmd and string args are surrounded with ""
1047 * @return boolean "false" if proc_run couldn't be executed
1049 function proc_run($cmd) {
1053 $proc_args = func_get_args();
1056 if (!count($proc_args)) {
1060 // Preserve the first parameter
1061 // It could contain a command, the priority or an parameter array
1062 // If we use the parameter array we have to protect it from the following function
1063 $run_parameter = array_shift($proc_args);
1065 // expand any arrays
1066 foreach ($proc_args as $arg) {
1067 if (is_array($arg)) {
1068 foreach ($arg as $n) {
1076 // Now we add the run parameters back to the array
1077 array_unshift($args, $run_parameter);
1079 $arr = array('args' => $args, 'run_cmd' => true);
1081 call_hooks("proc_run", $arr);
1082 if (!$arr['run_cmd'] || ! count($args)) {
1086 $priority = PRIORITY_MEDIUM;
1087 $dont_fork = get_config("system", "worker_dont_fork");
1088 $created = datetime_convert();
1090 if (is_int($run_parameter)) {
1091 $priority = $run_parameter;
1092 } elseif (is_array($run_parameter)) {
1093 if (isset($run_parameter['priority'])) {
1094 $priority = $run_parameter['priority'];
1096 if (isset($run_parameter['created'])) {
1097 $created = $run_parameter['created'];
1099 if (isset($run_parameter['dont_fork'])) {
1100 $dont_fork = $run_parameter['dont_fork'];
1107 $parameters = json_encode($argv);
1108 $found = dba::exists('workerqueue', array('parameter' => $parameters, 'done' => false));
1110 // Quit if there was a database error - a precaution for the update process to 3.5.3
1111 if (dba::errorNo() != 0) {
1116 dba::insert('workerqueue', array('parameter' => $parameters, 'created' => $created, 'priority' => $priority));
1119 // Should we quit and wait for the poller to be called as a cronjob?
1124 // If there is a lock then we don't have to check for too much worker
1125 if (!Lock::set('poller_worker', 0)) {
1129 // If there are already enough workers running, don't fork another one
1130 $quit = poller_too_much_workers();
1131 Lock::remove('poller_worker');
1137 // Now call the poller to execute the jobs that we just added to the queue
1138 $args = array("include/poller.php", "no_cron");
1140 $a->proc_run($args);
1145 function current_theme() {
1146 $app_base_themes = array('duepuntozero', 'dispy', 'quattro');
1152 // Find the theme that belongs to the user whose stuff we are looking at
1154 if ($a->profile_uid && ($a->profile_uid != local_user())) {
1155 $r = q("select theme from user where uid = %d limit 1",
1156 intval($a->profile_uid)
1158 if (dbm::is_result($r)) {
1159 $page_theme = $r[0]['theme'];
1163 // Allow folks to over-rule user themes and always use their own on their own site.
1164 // This works only if the user is on the same server
1166 if ($page_theme && local_user() && (local_user() != $a->profile_uid)) {
1167 if (get_pconfig(local_user(), 'system', 'always_my_theme')) {
1172 // $mobile_detect = new Mobile_Detect();
1173 // $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
1174 $is_mobile = $a->is_mobile || $a->is_tablet;
1176 $standard_system_theme = Config::get('system', 'theme', '');
1177 $standard_theme_name = ((isset($_SESSION) && x($_SESSION, 'theme')) ? $_SESSION['theme'] : $standard_system_theme);
1180 if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
1181 $system_theme = $standard_system_theme;
1182 $theme_name = $standard_theme_name;
1184 $system_theme = Config::get('system', 'mobile-theme', '');
1185 if ($system_theme == '') {
1186 $system_theme = $standard_system_theme;
1188 $theme_name = ((isset($_SESSION) && x($_SESSION, 'mobile-theme')) ? $_SESSION['mobile-theme'] : $system_theme);
1190 if ($theme_name === '---') {
1191 // user has selected to have the mobile theme be the same as the normal one
1192 $system_theme = $standard_system_theme;
1193 $theme_name = $standard_theme_name;
1196 $theme_name = $page_theme;
1201 $system_theme = $standard_system_theme;
1202 $theme_name = $standard_theme_name;
1205 $theme_name = $page_theme;
1210 (file_exists('view/theme/' . $theme_name . '/style.css') ||
1211 file_exists('view/theme/' . $theme_name . '/style.php'))) {
1212 return($theme_name);
1215 foreach ($app_base_themes as $t) {
1216 if (file_exists('view/theme/' . $t . '/style.css') ||
1217 file_exists('view/theme/' . $t . '/style.php')) {
1222 $fallback = array_merge(glob('view/theme/*/style.css'), glob('view/theme/*/style.php'));
1223 if (count($fallback)) {
1224 return (str_replace('view/theme/', '', substr($fallback[0], 0, -10)));
1227 /// @TODO No final return statement?
1231 * @brief Return full URL to theme which is currently in effect.
1233 * Provide a sane default if nothing is chosen or the specified theme does not exist.
1237 function current_theme_url() {
1240 $t = current_theme();
1242 $opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : '');
1243 if (file_exists('view/theme/' . $t . '/style.php')) {
1244 return('view/theme/' . $t . '/style.pcss' . $opts);
1247 return('view/theme/' . $t . '/style.css');
1250 function feed_birthday($uid, $tz) {
1254 * Determine the next birthday, but only if the birthday is published
1255 * in the default profile. We _could_ also look for a private profile that the
1256 * recipient can see, but somebody could get mad at us if they start getting
1257 * public birthday greetings when they haven't made this info public.
1259 * Assuming we are able to publish this info, we are then going to convert
1260 * the start time from the owner's timezone to UTC.
1262 * This will potentially solve the problem found with some social networks
1263 * where birthdays are converted to the viewer's timezone and salutations from
1264 * elsewhere in the world show up on the wrong day. We will convert it to the
1265 * viewer's timezone also, but first we are going to convert it from the birthday
1266 * person's timezone to GMT - so the viewer may find the birthday starting at
1267 * 6:00PM the day before, but that will correspond to midnight to the birthday person.
1276 $p = q("SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1",
1280 if (dbm::is_result($p)) {
1281 $tmp_dob = substr($p[0]['dob'], 5);
1282 if (intval($tmp_dob)) {
1283 $y = datetime_convert($tz, $tz, 'now', 'Y');
1284 $bd = $y . '-' . $tmp_dob . ' 00:00';
1285 $t_dob = strtotime($bd);
1286 $now = strtotime(datetime_convert($tz, $tz, 'now'));
1287 if ($t_dob < $now) {
1288 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
1290 $birthday = datetime_convert($tz, 'UTC', $bd, ATOM_TIME);
1298 * @brief Check if current user has admin role.
1300 * @return bool true if user is an admin
1302 function is_site_admin() {
1305 $adminlist = explode(",", str_replace(" ", "", $a->config['admin_email']));
1307 //if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && ($a->user['email'] === $a->config['admin_email']))
1308 if (local_user() && x($a->user, 'email') && x($a->config, 'admin_email') && in_array($a->user['email'], $adminlist)) {
1315 * @brief Returns querystring as string from a mapped array.
1317 * @param array $params mapped array with query parameters
1318 * @param string $name of parameter, default null
1322 function build_querystring($params, $name = null) {
1324 foreach ($params as $key => $val) {
1325 if (is_array($val)) {
1326 /// @TODO maybe not compare against null, use is_null()
1327 if ($name == null) {
1328 $ret .= build_querystring($val, $key);
1330 $ret .= build_querystring($val, $name . "[$key]");
1333 $val = urlencode($val);
1334 /// @TODO maybe not compare against null, use is_null()
1335 if ($name != null) {
1336 /// @TODO two string concated, can be merged to one
1337 $ret .= $name . "[$key]" . "=$val&";
1339 $ret .= "$key=$val&";
1346 function explode_querystring($query) {
1347 $arg_st = strpos($query, '?');
1348 if ($arg_st !== false) {
1349 $base = substr($query, 0, $arg_st);
1356 $args = explode('&', substr($query, $arg_st));
1357 foreach ($args as $k => $arg) {
1358 /// @TODO really compare type-safe here?
1363 $args = array_values($args);
1368 $args = array_values($args);
1378 * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
1380 * Taken from http://webcheatsheet.com/php/get_current_page_url.php
1382 function curPageURL() {
1384 if ($_SERVER["HTTPS"] == "on") {
1390 if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
1391 $pageURL .= $_SERVER["SERVER_NAME"] . ":" . $_SERVER["SERVER_PORT"] . $_SERVER["REQUEST_URI"];
1393 $pageURL .= $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"];
1398 function random_digits($digits) {
1400 for ($i = 0; $i < $digits; $i++) {
1401 /// @TODO rand() is different to mt_rand() and maybe lesser "random"
1407 function get_server() {
1408 $server = get_config("system", "directory");
1410 if ($server == "") {
1411 $server = "http://dir.friendica.social";
1417 function get_temppath() {
1420 $temppath = get_config("system", "temppath");
1422 if (($temppath != "") && App::directory_usable($temppath)) {
1423 // We have a temp path and it is usable
1424 return App::realpath($temppath);
1427 // We don't have a working preconfigured temp path, so we take the system path.
1428 $temppath = sys_get_temp_dir();
1430 // Check if it is usable
1431 if (($temppath != "") && App::directory_usable($temppath)) {
1432 // Always store the real path, not the path through symlinks
1433 $temppath = App::realpath($temppath);
1435 // To avoid any interferences with other systems we create our own directory
1436 $new_temppath = $temppath . "/" . $a->get_hostname();
1437 if (!is_dir($new_temppath)) {
1438 /// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
1439 mkdir($new_temppath);
1442 if (App::directory_usable($new_temppath)) {
1443 // The new path is usable, we are happy
1444 set_config("system", "temppath", $new_temppath);
1445 return $new_temppath;
1447 // We can't create a subdirectory, strange.
1448 // But the directory seems to work, so we use it but don't store it.
1453 // Reaching this point means that the operating system is configured badly.
1457 function get_cachefile($file, $writemode = true) {
1458 $cache = get_itemcachepath();
1460 if ((!$cache) || (!is_dir($cache))) {
1464 $subfolder = $cache . "/" . substr($file, 0, 2);
1466 $cachepath = $subfolder . "/" . $file;
1469 if (!is_dir($subfolder)) {
1471 chmod($subfolder, 0777);
1475 /// @TODO no need to put braces here
1479 function clear_cache($basepath = "", $path = "") {
1481 $basepath = get_itemcachepath();
1485 if (($path == "") || (!is_dir($path))) {
1489 if (substr(realpath($path), 0, strlen($basepath)) != $basepath) {
1493 $cachetime = (int) get_config('system', 'itemcache_duration');
1494 if ($cachetime == 0) {
1498 if (is_writable($path)) {
1499 if ($dh = opendir($path)) {
1500 while (($file = readdir($dh)) !== false) {
1501 $fullpath = $path . "/" . $file;
1502 if ((filetype($fullpath) == "dir") && ($file != ".") && ($file != "..")) {
1503 clear_cache($basepath, $fullpath);
1505 if ((filetype($fullpath) == "file") && (filectime($fullpath) < (time() - $cachetime))) {
1514 function get_itemcachepath() {
1515 // Checking, if the cache is deactivated
1516 $cachetime = (int) get_config('system', 'itemcache_duration');
1517 if ($cachetime < 0) {
1521 $itemcache = get_config('system', 'itemcache');
1522 if (($itemcache != "") && App::directory_usable($itemcache)) {
1523 return App::realpath($itemcache);
1526 $temppath = get_temppath();
1528 if ($temppath != "") {
1529 $itemcache = $temppath . "/itemcache";
1530 if (!file_exists($itemcache) && !is_dir($itemcache)) {
1534 if (App::directory_usable($itemcache)) {
1535 set_config("system", "itemcache", $itemcache);
1543 * @brief Returns the path where spool files are stored
1545 * @return string Spool path
1547 function get_spoolpath() {
1548 $spoolpath = get_config('system', 'spoolpath');
1549 if (($spoolpath != "") && App::directory_usable($spoolpath)) {
1550 // We have a spool path and it is usable
1554 // We don't have a working preconfigured spool path, so we take the temp path.
1555 $temppath = get_temppath();
1557 if ($temppath != "") {
1558 // To avoid any interferences with other systems we create our own directory
1559 $spoolpath = $temppath . "/spool";
1560 if (!is_dir($spoolpath)) {
1564 if (App::directory_usable($spoolpath)) {
1565 // The new path is usable, we are happy
1566 set_config("system", "spoolpath", $spoolpath);
1569 // We can't create a subdirectory, strange.
1570 // But the directory seems to work, so we use it but don't store it.
1575 // Reaching this point means that the operating system is configured badly.
1580 function set_template_engine(App $a, $engine = 'internal') {
1581 /// @note This function is no longer necessary, but keep it as a wrapper to the class method
1582 /// to avoid breaking themes again unnecessarily
1583 /// @TODO maybe output a warning here so the theme developer can see it? PHP won't show such warnings like Java does.
1585 $a->set_template_engine($engine);
1588 if (!function_exists('exif_imagetype')) {
1589 function exif_imagetype($file) {
1590 $size = getimagesize($file);
1595 function validate_include(&$file) {
1598 $file = realpath($file);
1600 if (strpos($file, getcwd()) !== 0) {
1604 $file = str_replace(getcwd() . "/", "", $file, $count);
1609 if ($orig_file !== $file) {
1614 if (strpos($file, "include/") === 0) {
1618 if (strpos($file, "addon/") === 0) {
1622 // Simply return flag
1626 function current_load() {
1627 if (!function_exists('sys_getloadavg')) {
1631 $load_arr = sys_getloadavg();
1633 if (!is_array($load_arr)) {
1637 return max($load_arr[0], $load_arr[1]);
1641 * @brief get c-style args
1646 return get_app()->argc;
1650 * @brief Returns the value of a argv key
1652 * @param int $x argv key
1653 * @return string Value of the argv key
1656 if (array_key_exists($x, get_app()->argv)) {
1657 return get_app()->argv[$x];
1664 * @brief Get the data which is needed for infinite scroll
1666 * For invinite scroll we need the page number of the actual page
1667 * and the the URI where the content of the next page comes from.
1668 * This data is needed for the js part in main.js.
1669 * Note: infinite scroll does only work for the network page (module)
1671 * @param string $module The name of the module (e.g. "network")
1672 * @return array Of infinite scroll data
1673 * 'pageno' => $pageno The number of the actual page
1674 * 'reload_uri' => $reload_uri The URI of the content we have to load
1676 function infinite_scroll_data($module) {
1678 if (get_pconfig(local_user(), 'system', 'infinite_scroll')
1679 && ($module == "network") && ($_GET["mode"] != "minimal")) {
1681 // get the page number
1682 if (is_string($_GET["page"])) {
1683 $pageno = $_GET["page"];
1690 // try to get the uri from which we load the content
1691 foreach ($_GET AS $param => $value) {
1692 if (($param != "page") && ($param != "q")) {
1693 $reload_uri .= "&" . $param . "=" . urlencode($value);
1697 if (($a->page_offset != "") && ! strstr($reload_uri, "&offset=")) {
1698 $reload_uri .= "&offset=" . urlencode($a->page_offset);
1701 $arr = array("pageno" => $pageno, "reload_uri" => $reload_uri);