]> git.mxchange.org Git - friendica.git/blob - boot.php
Fixes:
[friendica.git] / boot.php
1 <?php
2 /**
3  * @file boot.php
4  * This file defines some global constants and includes the central App class.
5  */
6
7 /**
8  * Friendica
9  *
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.
13  *
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.
18  */
19
20 require_once __DIR__ . DIRECTORY_SEPARATOR . 'vendor' . DIRECTORY_SEPARATOR . 'autoload.php';
21
22 use Friendica\App;
23 use Friendica\BaseObject;
24 use Friendica\Core\Addon;
25 use Friendica\Core\Cache;
26 use Friendica\Core\Config;
27 use Friendica\Core\L10n;
28 use Friendica\Core\PConfig;
29 use Friendica\Core\Protocol;
30 use Friendica\Core\System;
31 use Friendica\Core\Worker;
32 use Friendica\Database\DBM;
33 use Friendica\Database\DBStructure;
34 use Friendica\Model\Contact;
35 use Friendica\Model\Conversation;
36 use Friendica\Util\DateTimeFormat;
37
38 require_once 'include/text.php';
39
40 define('FRIENDICA_PLATFORM',     'Friendica');
41 define('FRIENDICA_CODENAME',     'The Tazmans Flax-lily');
42 define('FRIENDICA_VERSION',      '2018.08-dev');
43 define('DFRN_PROTOCOL_VERSION',  '2.23');
44 define('DB_UPDATE_VERSION',      1279);
45 define('NEW_UPDATE_ROUTINE_VERSION', 1170);
46
47 /**
48  * @brief Constants for the database update check
49  */
50 const DB_UPDATE_NOT_CHECKED = 0; // Database check wasn't executed before
51 const DB_UPDATE_SUCCESSFUL = 1;  // Database check was successful
52 const DB_UPDATE_FAILED = 2;      // Database check failed
53
54 /**
55  * @brief Constant with a HTML line break.
56  *
57  * Contains a HTML line break (br) element and a real carriage return with line
58  * feed for the source.
59  * This can be used in HTML and JavaScript where needed a line break.
60  */
61 define('EOL',                    "<br />\r\n");
62
63 /**
64  * @brief Image storage quality.
65  *
66  * Lower numbers save space at cost of image detail.
67  * For ease of upgrade, please do not change here. Set [system] jpegquality = n in config/local.ini.php,
68  * where n is between 1 and 100, and with very poor results below about 50
69  */
70 define('JPEG_QUALITY',            100);
71
72 /**
73  * [system] png_quality = n where is between 0 (uncompressed) to 9
74  */
75 define('PNG_QUALITY',             8);
76
77 /**
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
83  *
84  * [system]
85  * max_image_length = n;
86  *
87  * in config/local.ini.php
88  *
89  * If you don't want to set a maximum length, set to -1. The default value is
90  * defined by 'MAX_IMAGE_LENGTH' below.
91  */
92 define('MAX_IMAGE_LENGTH',        -1);
93
94 /**
95  * Not yet used
96  */
97 define('DEFAULT_DB_ENGINE',  'InnoDB');
98
99 /**
100  * @name SSL Policy
101  *
102  * SSL redirection policies
103  * @{
104  */
105 define('SSL_POLICY_NONE',         0);
106 define('SSL_POLICY_FULL',         1);
107 define('SSL_POLICY_SELFSIGN',     2);
108 /* @}*/
109
110 /**
111  * @name Logger
112  *
113  * log levels
114  * @{
115  */
116 define('LOGGER_WARNING',         0);
117 define('LOGGER_INFO',            1);
118 define('LOGGER_TRACE',           2);
119 define('LOGGER_DEBUG',           3);
120 define('LOGGER_DATA',            4);
121 define('LOGGER_ALL',             5);
122 /* @}*/
123
124 /**
125  * @name Cache
126  * @deprecated since version 3.6
127  * @see Cache
128  *
129  * Cache levels
130  * @{
131  */
132 define('CACHE_MONTH',            Cache::MONTH);
133 define('CACHE_WEEK',             Cache::WEEK);
134 define('CACHE_DAY',              Cache::DAY);
135 define('CACHE_HOUR',             Cache::HOUR);
136 define('CACHE_HALF_HOUR',        Cache::HALF_HOUR);
137 define('CACHE_QUARTER_HOUR',     Cache::QUARTER_HOUR);
138 define('CACHE_FIVE_MINUTES',     Cache::FIVE_MINUTES);
139 define('CACHE_MINUTE',           Cache::MINUTE);
140 /* @}*/
141
142 /**
143  * @name Register
144  *
145  * Registration policies
146  * @{
147  */
148 define('REGISTER_CLOSED',        0);
149 define('REGISTER_APPROVE',       1);
150 define('REGISTER_OPEN',          2);
151 /**
152  * @}
153 */
154
155 /**
156  * @name Contact_is
157  *
158  * Relationship types
159  * @{
160  */
161 define('CONTACT_IS_FOLLOWER', 1);
162 define('CONTACT_IS_SHARING',  2);
163 define('CONTACT_IS_FRIEND',   3);
164 /**
165  *  @}
166  */
167
168 /**
169  * @name Update
170  *
171  * DB update return values
172  * @{
173  */
174 define('UPDATE_SUCCESS', 0);
175 define('UPDATE_FAILED',  1);
176 /**
177  * @}
178  */
179
180 /**
181  * @name page/profile types
182  *
183  * PAGE_NORMAL is a typical personal profile account
184  * PAGE_SOAPBOX automatically approves all friend requests as CONTACT_IS_SHARING, (readonly)
185  * PAGE_COMMUNITY automatically approves all friend requests as CONTACT_IS_SHARING, but with
186  *      write access to wall and comments (no email and not included in page owner's ACL lists)
187  * PAGE_FREELOVE automatically approves all friend requests as full friends (CONTACT_IS_FRIEND).
188  *
189  * @{
190  */
191 define('PAGE_NORMAL',            0);
192 define('PAGE_SOAPBOX',           1);
193 define('PAGE_COMMUNITY',         2);
194 define('PAGE_FREELOVE',          3);
195 define('PAGE_BLOG',              4);
196 define('PAGE_PRVGROUP',          5);
197 /**
198  * @}
199  */
200
201 /**
202  * @name account types
203  *
204  * ACCOUNT_TYPE_PERSON - the account belongs to a person
205  *      Associated page types: PAGE_NORMAL, PAGE_SOAPBOX, PAGE_FREELOVE
206  *
207  * ACCOUNT_TYPE_ORGANISATION - the account belongs to an organisation
208  *      Associated page type: PAGE_SOAPBOX
209  *
210  * ACCOUNT_TYPE_NEWS - the account is a news reflector
211  *      Associated page type: PAGE_SOAPBOX
212  *
213  * ACCOUNT_TYPE_COMMUNITY - the account is community forum
214  *      Associated page types: PAGE_COMMUNITY, PAGE_PRVGROUP
215  *
216  * ACCOUNT_TYPE_RELAY - the account is a relay
217  *      This will only be assigned to contacts, not to user accounts
218  * @{
219  */
220 define('ACCOUNT_TYPE_PERSON',      0);
221 define('ACCOUNT_TYPE_ORGANISATION', 1);
222 define('ACCOUNT_TYPE_NEWS',        2);
223 define('ACCOUNT_TYPE_COMMUNITY',   3);
224 define('ACCOUNT_TYPE_RELAY',       4);
225 /**
226  * @}
227  */
228
229 /**
230  * @name CP
231  *
232  * Type of the community page
233  * @{
234  */
235 define('CP_NO_INTERNAL_COMMUNITY', -2);
236 define('CP_NO_COMMUNITY_PAGE',     -1);
237 define('CP_USERS_ON_SERVER',        0);
238 define('CP_GLOBAL_COMMUNITY',       1);
239 define('CP_USERS_AND_GLOBAL',       2);
240 /**
241  * @}
242  */
243
244 /**
245  * @name Protocols
246  * @deprecated since version 3.6
247  * @see Conversation
248  *
249  * Different protocols that we are storing
250  * @{
251  */
252 define('PROTOCOL_UNKNOWN'        , Conversation::PROTOCOL_UNKNOWN);
253 define('PROTOCOL_DFRN'           , Conversation::PROTOCOL_DFRN);
254 define('PROTOCOL_DIASPORA'       , Conversation::PROTOCOL_DIASPORA);
255 define('PROTOCOL_OSTATUS_SALMON' , Conversation::PROTOCOL_OSTATUS_SALMON);
256 define('PROTOCOL_OSTATUS_FEED'   , Conversation::PROTOCOL_OSTATUS_FEED);    // Deprecated
257 define('PROTOCOL_GS_CONVERSATION', Conversation::PROTOCOL_GS_CONVERSATION); // Deprecated
258 define('PROTOCOL_SPLITTED_CONV'  , Conversation::PROTOCOL_SPLITTED_CONV);
259 /**
260  * @}
261  */
262
263 /**
264  * @name Network constants
265  * @deprecated since version 3.6
266  * @see Protocol
267  *
268  * Network and protocol family types
269  * @{
270  */
271 define('NETWORK_DFRN'     , Protocol::DFRN);      // Friendica, Mistpark, other DFRN implementations
272 define('NETWORK_ZOT'      , Protocol::ZOT);       // Zot! - Currently unsupported
273 define('NETWORK_OSTATUS'  , Protocol::OSTATUS);   // GNU-social, Pleroma, Mastodon, other OStatus implementations
274 define('NETWORK_FEED'     , Protocol::FEED);      // RSS/Atom feeds with no known "post/notify" protocol
275 define('NETWORK_DIASPORA' , Protocol::DIASPORA);  // Diaspora
276 define('NETWORK_MAIL'     , Protocol::MAIL);      // IMAP/POP
277 define('NETWORK_FACEBOOK' , Protocol::FACEBOOK);  // Facebook API
278 define('NETWORK_LINKEDIN' , Protocol::LINKEDIN);  // LinkedIn
279 define('NETWORK_XMPP'     , Protocol::XMPP);      // XMPP - Currently unsupported
280 define('NETWORK_MYSPACE'  , Protocol::MYSPACE);   // MySpace - Currently unsupported
281 define('NETWORK_GPLUS'    , Protocol::GPLUS);     // Google+
282 define('NETWORK_PUMPIO'   , Protocol::PUMPIO);    // pump.io
283 define('NETWORK_TWITTER'  , Protocol::TWITTER);   // Twitter
284 define('NETWORK_DIASPORA2', Protocol::DIASPORA2); // Diaspora connector
285 define('NETWORK_STATUSNET', Protocol::STATUSNET); // Statusnet connector
286 define('NETWORK_APPNET'   , Protocol::APPNET);    // app.net - Dead protocol
287 define('NETWORK_NEWS'     , Protocol::NEWS);      // Network News Transfer Protocol - Currently unsupported
288 define('NETWORK_ICALENDAR', Protocol::ICALENDAR); // iCalendar - Currently unsupported
289 define('NETWORK_PNUT'     , Protocol::PNUT);      // pnut.io - Currently unsupported
290 define('NETWORK_PHANTOM'  , Protocol::PHANTOM);   // Place holder
291 /**
292  * @}
293  */
294
295 /**
296  * These numbers are used in stored permissions
297  * and existing allocations MUST NEVER BE CHANGED
298  * OR RE-ASSIGNED! You may only add to them.
299  */
300 $netgroup_ids = [
301         NETWORK_DFRN     => (-1),
302         NETWORK_ZOT      => (-2),
303         NETWORK_OSTATUS  => (-3),
304         NETWORK_FEED     => (-4),
305         NETWORK_DIASPORA => (-5),
306         NETWORK_MAIL     => (-6),
307         NETWORK_FACEBOOK => (-8),
308         NETWORK_LINKEDIN => (-9),
309         NETWORK_XMPP     => (-10),
310         NETWORK_MYSPACE  => (-11),
311         NETWORK_GPLUS    => (-12),
312         NETWORK_PUMPIO   => (-13),
313         NETWORK_TWITTER  => (-14),
314         NETWORK_DIASPORA2 => (-15),
315         NETWORK_STATUSNET => (-16),
316         NETWORK_APPNET    => (-17),
317         NETWORK_NEWS      => (-18),
318         NETWORK_ICALENDAR => (-19),
319         NETWORK_PNUT      => (-20),
320
321         NETWORK_PHANTOM  => (-127),
322 ];
323
324 /**
325  * Maximum number of "people who like (or don't like) this"  that we will list by name
326  */
327 define('MAX_LIKERS',    75);
328
329 /**
330  * Communication timeout
331  */
332 define('ZCURL_TIMEOUT', (-1));
333
334 /**
335  * @name Notify
336  *
337  * Email notification options
338  * @{
339  */
340 define('NOTIFY_INTRO',    0x0001);
341 define('NOTIFY_CONFIRM',  0x0002);
342 define('NOTIFY_WALL',     0x0004);
343 define('NOTIFY_COMMENT',  0x0008);
344 define('NOTIFY_MAIL',     0x0010);
345 define('NOTIFY_SUGGEST',  0x0020);
346 define('NOTIFY_PROFILE',  0x0040);
347 define('NOTIFY_TAGSELF',  0x0080);
348 define('NOTIFY_TAGSHARE', 0x0100);
349 define('NOTIFY_POKE',     0x0200);
350 define('NOTIFY_SHARE',    0x0400);
351
352 define('SYSTEM_EMAIL',    0x4000);
353
354 define('NOTIFY_SYSTEM',   0x8000);
355 /* @}*/
356
357
358 /**
359  * @name Term
360  *
361  * Tag/term types
362  * @{
363  */
364 define('TERM_UNKNOWN',   0);
365 define('TERM_HASHTAG',   1);
366 define('TERM_MENTION',   2);
367 define('TERM_CATEGORY',  3);
368 define('TERM_PCATEGORY', 4);
369 define('TERM_FILE',      5);
370 define('TERM_SAVEDSEARCH', 6);
371 define('TERM_CONVERSATION', 7);
372
373 define('TERM_OBJ_POST',  1);
374 define('TERM_OBJ_PHOTO', 2);
375
376 /**
377  * @name Namespaces
378  *
379  * Various namespaces we may need to parse
380  * @{
381  */
382 define('NAMESPACE_ZOT',             'http://purl.org/zot');
383 define('NAMESPACE_DFRN',            'http://purl.org/macgirvin/dfrn/1.0');
384 define('NAMESPACE_THREAD',          'http://purl.org/syndication/thread/1.0');
385 define('NAMESPACE_TOMB',            'http://purl.org/atompub/tombstones/1.0');
386 define('NAMESPACE_ACTIVITY',        'http://activitystrea.ms/spec/1.0/');
387 define('NAMESPACE_ACTIVITY_SCHEMA', 'http://activitystrea.ms/schema/1.0/');
388 define('NAMESPACE_MEDIA',           'http://purl.org/syndication/atommedia');
389 define('NAMESPACE_SALMON_ME',       'http://salmon-protocol.org/ns/magic-env');
390 define('NAMESPACE_OSTATUSSUB',      'http://ostatus.org/schema/1.0/subscribe');
391 define('NAMESPACE_GEORSS',          'http://www.georss.org/georss');
392 define('NAMESPACE_POCO',            'http://portablecontacts.net/spec/1.0');
393 define('NAMESPACE_FEED',            'http://schemas.google.com/g/2010#updates-from');
394 define('NAMESPACE_OSTATUS',         'http://ostatus.org/schema/1.0');
395 define('NAMESPACE_STATUSNET',       'http://status.net/schema/api/1/');
396 define('NAMESPACE_ATOM1',           'http://www.w3.org/2005/Atom');
397 define('NAMESPACE_MASTODON',        'http://mastodon.social/schema/1.0');
398 /* @}*/
399
400 /**
401  * @name Activity
402  *
403  * Activity stream defines
404  * @{
405  */
406 define('ACTIVITY_LIKE',        NAMESPACE_ACTIVITY_SCHEMA . 'like');
407 define('ACTIVITY_DISLIKE',     NAMESPACE_DFRN            . '/dislike');
408 define('ACTIVITY_ATTEND',      NAMESPACE_ZOT             . '/activity/attendyes');
409 define('ACTIVITY_ATTENDNO',    NAMESPACE_ZOT             . '/activity/attendno');
410 define('ACTIVITY_ATTENDMAYBE', NAMESPACE_ZOT             . '/activity/attendmaybe');
411
412 define('ACTIVITY_OBJ_HEART',   NAMESPACE_DFRN            . '/heart');
413
414 define('ACTIVITY_FRIEND',      NAMESPACE_ACTIVITY_SCHEMA . 'make-friend');
415 define('ACTIVITY_REQ_FRIEND',  NAMESPACE_ACTIVITY_SCHEMA . 'request-friend');
416 define('ACTIVITY_UNFRIEND',    NAMESPACE_ACTIVITY_SCHEMA . 'remove-friend');
417 define('ACTIVITY_FOLLOW',      NAMESPACE_ACTIVITY_SCHEMA . 'follow');
418 define('ACTIVITY_UNFOLLOW',    NAMESPACE_ACTIVITY_SCHEMA . 'stop-following');
419 define('ACTIVITY_JOIN',        NAMESPACE_ACTIVITY_SCHEMA . 'join');
420
421 define('ACTIVITY_POST',        NAMESPACE_ACTIVITY_SCHEMA . 'post');
422 define('ACTIVITY_UPDATE',      NAMESPACE_ACTIVITY_SCHEMA . 'update');
423 define('ACTIVITY_TAG',         NAMESPACE_ACTIVITY_SCHEMA . 'tag');
424 define('ACTIVITY_FAVORITE',    NAMESPACE_ACTIVITY_SCHEMA . 'favorite');
425 define('ACTIVITY_UNFAVORITE',  NAMESPACE_ACTIVITY_SCHEMA . 'unfavorite');
426 define('ACTIVITY_SHARE',       NAMESPACE_ACTIVITY_SCHEMA . 'share');
427 define('ACTIVITY_DELETE',      NAMESPACE_ACTIVITY_SCHEMA . 'delete');
428
429 define('ACTIVITY_POKE',        NAMESPACE_ZOT . '/activity/poke');
430
431 define('ACTIVITY_OBJ_BOOKMARK', NAMESPACE_ACTIVITY_SCHEMA . 'bookmark');
432 define('ACTIVITY_OBJ_COMMENT', NAMESPACE_ACTIVITY_SCHEMA . 'comment');
433 define('ACTIVITY_OBJ_NOTE',    NAMESPACE_ACTIVITY_SCHEMA . 'note');
434 define('ACTIVITY_OBJ_PERSON',  NAMESPACE_ACTIVITY_SCHEMA . 'person');
435 define('ACTIVITY_OBJ_IMAGE',   NAMESPACE_ACTIVITY_SCHEMA . 'image');
436 define('ACTIVITY_OBJ_PHOTO',   NAMESPACE_ACTIVITY_SCHEMA . 'photo');
437 define('ACTIVITY_OBJ_VIDEO',   NAMESPACE_ACTIVITY_SCHEMA . 'video');
438 define('ACTIVITY_OBJ_P_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'profile-photo');
439 define('ACTIVITY_OBJ_ALBUM',   NAMESPACE_ACTIVITY_SCHEMA . 'photo-album');
440 define('ACTIVITY_OBJ_EVENT',   NAMESPACE_ACTIVITY_SCHEMA . 'event');
441 define('ACTIVITY_OBJ_GROUP',   NAMESPACE_ACTIVITY_SCHEMA . 'group');
442 define('ACTIVITY_OBJ_TAGTERM', NAMESPACE_DFRN            . '/tagterm');
443 define('ACTIVITY_OBJ_PROFILE', NAMESPACE_DFRN            . '/profile');
444 define('ACTIVITY_OBJ_QUESTION', 'http://activityschema.org/object/question');
445 /* @}*/
446
447 /**
448  * @name Gravity
449  *
450  * Item weight for query ordering
451  * @{
452  */
453 define('GRAVITY_PARENT',       0);
454 define('GRAVITY_ACTIVITY',     3);
455 define('GRAVITY_COMMENT',      6);
456 define('GRAVITY_UNKNOWN',      9);
457 /* @}*/
458
459 /**
460  * @name Priority
461  *
462  * Process priority for the worker
463  * @{
464  */
465 define('PRIORITY_UNDEFINED',   0);
466 define('PRIORITY_CRITICAL',   10);
467 define('PRIORITY_HIGH',       20);
468 define('PRIORITY_MEDIUM',     30);
469 define('PRIORITY_LOW',        40);
470 define('PRIORITY_NEGLIGIBLE', 50);
471 /* @}*/
472
473 /**
474  * @name Social Relay settings
475  *
476  * See here: https://github.com/jaywink/social-relay
477  * and here: https://wiki.diasporafoundation.org/Relay_servers_for_public_posts
478  * @{
479  */
480 define('SR_SCOPE_NONE', '');
481 define('SR_SCOPE_ALL',  'all');
482 define('SR_SCOPE_TAGS', 'tags');
483 /* @}*/
484
485 /**
486  * Lowest possible date time value
487  */
488 define('NULL_DATE', '0001-01-01 00:00:00');
489
490 // Normally this constant is defined - but not if "pcntl" isn't installed
491 if (!defined("SIGTERM")) {
492         define("SIGTERM", 15);
493 }
494
495 /**
496  * Depending on the PHP version this constant does exist - or not.
497  * See here: http://php.net/manual/en/curl.constants.php#117928
498  */
499 if (!defined('CURLE_OPERATION_TIMEDOUT')) {
500         define('CURLE_OPERATION_TIMEDOUT', CURLE_OPERATION_TIMEOUTED);
501 }
502
503 /**
504  * @brief Retrieve the App structure
505  *
506  * Useful in functions which require it but don't get it passed to them
507  *
508  * @return App
509  */
510 function get_app()
511 {
512         return BaseObject::getApp();
513 }
514
515 /**
516  * @brief Multi-purpose function to check variable state.
517  *
518  * Usage: x($var) or $x($array, 'key')
519  *
520  * returns false if variable/key is not set
521  * if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0.
522  * e.g. x('') or x(0) returns 0;
523  *
524  * @param string|array $s variable to check
525  * @param string       $k key inside the array to check
526  *
527  * @return bool|int
528  */
529 function x($s, $k = null)
530 {
531         if ($k != null) {
532                 if ((is_array($s)) && (array_key_exists($k, $s))) {
533                         if ($s[$k]) {
534                                 return (int) 1;
535                         }
536                         return (int) 0;
537                 }
538                 return false;
539         } else {
540                 if (isset($s)) {
541                         if ($s) {
542                                 return (int) 1;
543                         }
544                         return (int) 0;
545                 }
546                 return false;
547         }
548 }
549
550 /**
551  * Return the provided variable value if it exists and is truthy or the provided
552  * default value instead.
553  *
554  * Works with initialized variables and potentially uninitialized array keys
555  *
556  * Usages:
557  * - defaults($var, $default)
558  * - defaults($array, 'key', $default)
559  *
560  * @brief Returns a defaut value if the provided variable or array key is falsy
561  * @see x()
562  * @return mixed
563  */
564 function defaults() {
565         $args = func_get_args();
566
567         if (count($args) < 2) {
568                 throw new BadFunctionCallException('defaults() requires at least 2 parameters');
569         }
570         if (count($args) > 3) {
571                 throw new BadFunctionCallException('defaults() cannot use more than 3 parameters');
572         }
573         if (count($args) === 3 && is_null($args[1])) {
574                 throw new BadFunctionCallException('defaults($arr, $key, $def) $key is null');
575         }
576
577         $default = array_pop($args);
578
579         if (call_user_func_array('x', $args)) {
580                 if (count($args) === 1) {
581                         $return = $args[0];
582                 } else {
583                         $return = $args[0][$args[1]];
584                 }
585         } else {
586                 $return = $default;
587         }
588
589         return $return;
590 }
591
592 /**
593  * @brief Returns the baseurl.
594  *
595  * @see System::baseUrl()
596  *
597  * @return string
598  * @TODO Function is deprecated and only used in some addons
599  */
600 function z_root()
601 {
602         return System::baseUrl();
603 }
604
605 /**
606  * @brief Return absolut URL for given $path.
607  *
608  * @param string $path given path
609  *
610  * @return string
611  */
612 function absurl($path)
613 {
614         if (strpos($path, '/') === 0) {
615                 return z_path() . $path;
616         }
617         return $path;
618 }
619
620 /**
621  * @brief Function to check if request was an AJAX (xmlhttprequest) request.
622  *
623  * @return boolean
624  */
625 function is_ajax()
626 {
627         return (!empty($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest');
628 }
629
630 /**
631  * @brief Function to check if request was an AJAX (xmlhttprequest) request.
632  *
633  * @param boolean $via_worker boolean Is the check run via the worker?
634  */
635 function check_db($via_worker)
636 {
637         $build = Config::get('system', 'build');
638
639         if (empty($build)) {
640                 Config::set('system', 'build', DB_UPDATE_VERSION - 1);
641                 $build = DB_UPDATE_VERSION - 1;
642         }
643
644         // We don't support upgrading from very old versions anymore
645         if ($build < NEW_UPDATE_ROUTINE_VERSION) {
646                 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.');
647         }
648
649         if ($build < DB_UPDATE_VERSION) {
650                 // When we cannot execute the database update via the worker, we will do it directly
651                 if (!Worker::add(PRIORITY_CRITICAL, 'DBUpdate') && $via_worker) {
652                         update_db();
653                 }
654         }
655 }
656
657 /**
658  * Sets the base url for use in cmdline programs which don't have
659  * $_SERVER variables
660  *
661  * @param object $a App
662  */
663 function check_url(App $a)
664 {
665         $url = Config::get('system', 'url');
666
667         // if the url isn't set or the stored url is radically different
668         // than the currently visited url, store the current value accordingly.
669         // "Radically different" ignores common variations such as http vs https
670         // and www.example.com vs example.com.
671         // We will only change the url to an ip address if there is no existing setting
672
673         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()))) {
674                 Config::set('system', 'url', System::baseUrl());
675         }
676
677         return;
678 }
679
680 /**
681  * @brief Automatic database updates
682  * @param object $a App
683  */
684 function update_db()
685 {
686         $build = Config::get('system', 'build');
687
688         if (empty($build) || ($build > DB_UPDATE_VERSION)) {
689                 $build = DB_UPDATE_VERSION - 1;
690                 Config::set('system', 'build', $build);
691         }
692
693         if ($build != DB_UPDATE_VERSION) {
694                 require_once 'update.php';
695
696                 $stored = intval($build);
697                 $current = intval(DB_UPDATE_VERSION);
698                 if ($stored < $current) {
699                         Config::load('database');
700
701                         // Compare the current structure with the defined structure
702                         $t = Config::get('database', 'dbupdate_' . DB_UPDATE_VERSION);
703                         if (!is_null($t)) {
704                                 return;
705                         }
706
707                         // run the pre_update_nnnn functions in update.php
708                         for ($x = $stored + 1; $x <= $current; $x++) {
709                                 $r = run_update_function($x, 'pre_update');
710                                 if (!$r) {
711                                         break;
712                                 }
713                         }
714
715                         Config::set('database', 'dbupdate_' . DB_UPDATE_VERSION, time());
716
717                         // update the structure in one call
718                         $retval = DBStructure::update(false, true);
719                         if ($retval) {
720                                 DBStructure::updateFail(
721                                         DB_UPDATE_VERSION,
722                                         $retval
723                                 );
724                                 return;
725                         } else {
726                                 Config::set('database', 'dbupdate_' . DB_UPDATE_VERSION, 'success');
727                         }
728
729                         // run the update_nnnn functions in update.php
730                         for ($x = $stored + 1; $x <= $current; $x++) {
731                                 $r = run_update_function($x, 'update');
732                                 if (!$r) {
733                                         break;
734                                 }
735                         }
736                 }
737         }
738
739         return;
740 }
741
742 function run_update_function($x, $prefix)
743 {
744         $funcname = $prefix . '_' . $x;
745
746         if (function_exists($funcname)) {
747                 // There could be a lot of processes running or about to run.
748                 // We want exactly one process to run the update command.
749                 // So store the fact that we're taking responsibility
750                 // after first checking to see if somebody else already has.
751                 // If the update fails or times-out completely you may need to
752                 // delete the config entry to try again.
753
754                 $t = Config::get('database', $funcname);
755                 if (!is_null($t)) {
756                         return false;
757                 }
758                 Config::set('database', $funcname, time());
759
760                 // call the specific update
761                 $retval = $funcname();
762
763                 if ($retval) {
764                         //send the administrator an e-mail
765                         DBStructure::updateFail(
766                                 $x,
767                                 L10n::t('Update %s failed. See error logs.', $x)
768                         );
769                         return false;
770                 } else {
771                         Config::set('database', $funcname, 'success');
772
773                         if ($prefix == 'update') {
774                                 Config::set('system', 'build', $x);
775                         }
776
777                         return true;
778                 }
779         } else {
780                 Config::set('database', $funcname, 'success');
781
782                 if ($prefix == 'update') {
783                         Config::set('system', 'build', $x);
784                 }
785
786                 return true;
787         }
788 }
789
790 /**
791  * @brief Synchronise addons:
792  *
793  * system.addon contains a comma-separated list of names
794  * of addons which are used on this system.
795  * Go through the database list of already installed addons, and if we have
796  * an entry, but it isn't in the config list, call the uninstall procedure
797  * and mark it uninstalled in the database (for now we'll remove it).
798  * Then go through the config list and if we have a addon that isn't installed,
799  * call the install procedure and add it to the database.
800  *
801  * @param object $a App
802  */
803 function check_addons(App $a)
804 {
805         $r = q("SELECT * FROM `addon` WHERE `installed` = 1");
806         if (DBM::is_result($r)) {
807                 $installed = $r;
808         } else {
809                 $installed = [];
810         }
811
812         $addons = Config::get('system', 'addon');
813         $addons_arr = [];
814
815         if ($addons) {
816                 $addons_arr = explode(',', str_replace(' ', '', $addons));
817         }
818
819         $a->addons = $addons_arr;
820
821         $installed_arr = [];
822
823         if (count($installed)) {
824                 foreach ($installed as $i) {
825                         if (!in_array($i['name'], $addons_arr)) {
826                                 Addon::uninstall($i['name']);
827                         } else {
828                                 $installed_arr[] = $i['name'];
829                         }
830                 }
831         }
832
833         if (count($addons_arr)) {
834                 foreach ($addons_arr as $p) {
835                         if (!in_array($p, $installed_arr)) {
836                                 Addon::install($p);
837                         }
838                 }
839         }
840
841         Addon::loadHooks();
842
843         return;
844 }
845
846 /**
847  * @brief Used to end the current process, after saving session state.
848  * @deprecated
849  */
850 function killme()
851 {
852         exit();
853 }
854
855 /**
856  * @brief Redirect to another URL and terminate this process.
857  */
858 function goaway($path)
859 {
860         if (strstr(normalise_link($path), 'http://')) {
861                 $url = $path;
862         } else {
863                 $url = System::baseUrl() . '/' . ltrim($path, '/');
864         }
865
866         header("Location: $url");
867         killme();
868 }
869
870 /**
871  * @brief Returns the user id of locally logged in user or false.
872  *
873  * @return int|bool user id or false
874  */
875 function local_user()
876 {
877         if (!empty($_SESSION['authenticated']) && !empty($_SESSION['uid'])) {
878                 return intval($_SESSION['uid']);
879         }
880         return false;
881 }
882
883 /**
884  * @brief Returns the public contact id of logged in user or false.
885  *
886  * @return int|bool public contact id or false
887  */
888 function public_contact()
889 {
890         static $public_contact_id = false;
891
892         if (!$public_contact_id && x($_SESSION, 'authenticated')) {
893                 if (x($_SESSION, 'my_address')) {
894                         // Local user
895                         $public_contact_id = intval(Contact::getIdForURL($_SESSION['my_address'], 0, true));
896                 } elseif (x($_SESSION, 'visitor_home')) {
897                         // Remote user
898                         $public_contact_id = intval(Contact::getIdForURL($_SESSION['visitor_home'], 0, true));
899                 }
900         } elseif (!x($_SESSION, 'authenticated')) {
901                 $public_contact_id = false;
902         }
903
904         return $public_contact_id;
905 }
906
907 /**
908  * @brief Returns contact id of authenticated site visitor or false
909  *
910  * @return int|bool visitor_id or false
911  */
912 function remote_user()
913 {
914         // You cannot be both local and remote.
915         // Unncommented by rabuzarus because remote authentication to local
916         // profiles wasn't possible anymore (2018-04-12).
917 //      if (local_user()) {
918 //              return false;
919 //      }
920
921         if (empty($_SESSION)) {
922                 return false;
923         }
924
925         if (x($_SESSION, 'authenticated') && x($_SESSION, 'visitor_id')) {
926                 return intval($_SESSION['visitor_id']);
927         }
928         return false;
929 }
930
931 /**
932  * @brief Show an error message to user.
933  *
934  * This function save text in session, to be shown to the user at next page load
935  *
936  * @param string $s - Text of notice
937  */
938 function notice($s)
939 {
940         if (empty($_SESSION)) {
941                 return;
942         }
943
944         $a = get_app();
945         if (!x($_SESSION, 'sysmsg')) {
946                 $_SESSION['sysmsg'] = [];
947         }
948         if ($a->interactive) {
949                 $_SESSION['sysmsg'][] = $s;
950         }
951 }
952
953 /**
954  * @brief Show an info message to user.
955  *
956  * This function save text in session, to be shown to the user at next page load
957  *
958  * @param string $s - Text of notice
959  */
960 function info($s)
961 {
962         $a = get_app();
963
964         if (local_user() && PConfig::get(local_user(), 'system', 'ignore_info')) {
965                 return;
966         }
967
968         if (!x($_SESSION, 'sysmsg_info')) {
969                 $_SESSION['sysmsg_info'] = [];
970         }
971         if ($a->interactive) {
972                 $_SESSION['sysmsg_info'][] = $s;
973         }
974 }
975
976 function feed_birthday($uid, $tz)
977 {
978         /**
979          * Determine the next birthday, but only if the birthday is published
980          * in the default profile. We _could_ also look for a private profile that the
981          * recipient can see, but somebody could get mad at us if they start getting
982          * public birthday greetings when they haven't made this info public.
983          *
984          * Assuming we are able to publish this info, we are then going to convert
985          * the start time from the owner's timezone to UTC.
986          *
987          * This will potentially solve the problem found with some social networks
988          * where birthdays are converted to the viewer's timezone and salutations from
989          * elsewhere in the world show up on the wrong day. We will convert it to the
990          * viewer's timezone also, but first we are going to convert it from the birthday
991          * person's timezone to GMT - so the viewer may find the birthday starting at
992          * 6:00PM the day before, but that will correspond to midnight to the birthday person.
993          */
994         $birthday = '';
995
996         if (!strlen($tz)) {
997                 $tz = 'UTC';
998         }
999
1000         $p = q(
1001                 "SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1",
1002                 intval($uid)
1003         );
1004
1005         if (DBM::is_result($p)) {
1006                 $tmp_dob = substr($p[0]['dob'], 5);
1007                 if (intval($tmp_dob)) {
1008                         $y = DateTimeFormat::timezoneNow($tz, 'Y');
1009                         $bd = $y . '-' . $tmp_dob . ' 00:00';
1010                         $t_dob = strtotime($bd);
1011                         $now = strtotime(DateTimeFormat::timezoneNow($tz));
1012                         if ($t_dob < $now) {
1013                                 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
1014                         }
1015                         $birthday = DateTimeFormat::convert($bd, 'UTC', $tz, DateTimeFormat::ATOM);
1016                 }
1017         }
1018
1019         return $birthday;
1020 }
1021
1022 /**
1023  * @brief Check if current user has admin role.
1024  *
1025  * @return bool true if user is an admin
1026  */
1027 function is_site_admin()
1028 {
1029         $a = get_app();
1030
1031         $admin_email = Config::get('config', 'admin_email');
1032
1033         $adminlist = explode(',', str_replace(' ', '', $admin_email));
1034
1035         return local_user() && $admin_email && in_array(defaults($a->user, 'email', ''), $adminlist);
1036 }
1037
1038 /**
1039  * @brief Returns querystring as string from a mapped array.
1040  *
1041  * @param array  $params mapped array with query parameters
1042  * @param string $name   of parameter, default null
1043  *
1044  * @return string
1045  */
1046 function build_querystring($params, $name = null)
1047 {
1048         $ret = "";
1049         foreach ($params as $key => $val) {
1050                 if (is_array($val)) {
1051                         /// @TODO maybe not compare against null, use is_null()
1052                         if ($name == null) {
1053                                 $ret .= build_querystring($val, $key);
1054                         } else {
1055                                 $ret .= build_querystring($val, $name . "[$key]");
1056                         }
1057                 } else {
1058                         $val = urlencode($val);
1059                         /// @TODO maybe not compare against null, use is_null()
1060                         if ($name != null) {
1061                                 /// @TODO two string concated, can be merged to one
1062                                 $ret .= $name . "[$key]" . "=$val&";
1063                         } else {
1064                                 $ret .= "$key=$val&";
1065                         }
1066                 }
1067         }
1068         return $ret;
1069 }
1070
1071 function explode_querystring($query)
1072 {
1073         $arg_st = strpos($query, '?');
1074         if ($arg_st !== false) {
1075                 $base = substr($query, 0, $arg_st);
1076                 $arg_st += 1;
1077         } else {
1078                 $base = '';
1079                 $arg_st = 0;
1080         }
1081
1082         $args = explode('&', substr($query, $arg_st));
1083         foreach ($args as $k => $arg) {
1084                 /// @TODO really compare type-safe here?
1085                 if ($arg === '') {
1086                         unset($args[$k]);
1087                 }
1088         }
1089         $args = array_values($args);
1090
1091         if (!$base) {
1092                 $base = $args[0];
1093                 unset($args[0]);
1094                 $args = array_values($args);
1095         }
1096
1097         return [
1098                 'base' => $base,
1099                 'args' => $args,
1100         ];
1101 }
1102
1103 /**
1104  * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
1105  *
1106  * Taken from http://webcheatsheet.com/php/get_current_page_url.php
1107  */
1108 function curPageURL()
1109 {
1110         $pageURL = 'http';
1111         if ($_SERVER["HTTPS"] == "on") {
1112                 $pageURL .= "s";
1113         }
1114
1115         $pageURL .= "://";
1116
1117         if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
1118                 $pageURL .= $_SERVER["SERVER_NAME"] . ":" . $_SERVER["SERVER_PORT"] . $_SERVER["REQUEST_URI"];
1119         } else {
1120                 $pageURL .= $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"];
1121         }
1122         return $pageURL;
1123 }
1124
1125 function random_digits($digits)
1126 {
1127         $rn = '';
1128         for ($i = 0; $i < $digits; $i++) {
1129                 /// @TODO Avoid rand/mt_rand, when it comes to cryptography, they are generating predictable (seedable) numbers.
1130                 $rn .= rand(0, 9);
1131         }
1132         return $rn;
1133 }
1134
1135 function get_server()
1136 {
1137         $server = Config::get("system", "directory");
1138
1139         if ($server == "") {
1140                 $server = "https://dir.friendica.social";
1141         }
1142
1143         return $server;
1144 }
1145
1146 function get_temppath()
1147 {
1148         $a = get_app();
1149
1150         $temppath = Config::get("system", "temppath");
1151
1152         if (($temppath != "") && App::directory_usable($temppath)) {
1153                 // We have a temp path and it is usable
1154                 return App::realpath($temppath);
1155         }
1156
1157         // We don't have a working preconfigured temp path, so we take the system path.
1158         $temppath = sys_get_temp_dir();
1159
1160         // Check if it is usable
1161         if (($temppath != "") && App::directory_usable($temppath)) {
1162                 // Always store the real path, not the path through symlinks
1163                 $temppath = App::realpath($temppath);
1164
1165                 // To avoid any interferences with other systems we create our own directory
1166                 $new_temppath = $temppath . "/" . $a->get_hostname();
1167                 if (!is_dir($new_temppath)) {
1168                         /// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
1169                         mkdir($new_temppath);
1170                 }
1171
1172                 if (App::directory_usable($new_temppath)) {
1173                         // The new path is usable, we are happy
1174                         Config::set("system", "temppath", $new_temppath);
1175                         return $new_temppath;
1176                 } else {
1177                         // We can't create a subdirectory, strange.
1178                         // But the directory seems to work, so we use it but don't store it.
1179                         return $temppath;
1180                 }
1181         }
1182
1183         // Reaching this point means that the operating system is configured badly.
1184         return '';
1185 }
1186
1187 function get_cachefile($file, $writemode = true)
1188 {
1189         $cache = get_itemcachepath();
1190
1191         if ((!$cache) || (!is_dir($cache))) {
1192                 return "";
1193         }
1194
1195         $subfolder = $cache . "/" . substr($file, 0, 2);
1196
1197         $cachepath = $subfolder . "/" . $file;
1198
1199         if ($writemode) {
1200                 if (!is_dir($subfolder)) {
1201                         mkdir($subfolder);
1202                         chmod($subfolder, 0777);
1203                 }
1204         }
1205
1206         return $cachepath;
1207 }
1208
1209 function clear_cache($basepath = "", $path = "")
1210 {
1211         if ($path == "") {
1212                 $basepath = get_itemcachepath();
1213                 $path = $basepath;
1214         }
1215
1216         if (($path == "") || (!is_dir($path))) {
1217                 return;
1218         }
1219
1220         if (substr(realpath($path), 0, strlen($basepath)) != $basepath) {
1221                 return;
1222         }
1223
1224         $cachetime = (int) Config::get('system', 'itemcache_duration');
1225         if ($cachetime == 0) {
1226                 $cachetime = 86400;
1227         }
1228
1229         if (is_writable($path)) {
1230                 if ($dh = opendir($path)) {
1231                         while (($file = readdir($dh)) !== false) {
1232                                 $fullpath = $path . "/" . $file;
1233                                 if ((filetype($fullpath) == "dir") && ($file != ".") && ($file != "..")) {
1234                                         clear_cache($basepath, $fullpath);
1235                                 }
1236                                 if ((filetype($fullpath) == "file") && (filectime($fullpath) < (time() - $cachetime))) {
1237                                         unlink($fullpath);
1238                                 }
1239                         }
1240                         closedir($dh);
1241                 }
1242         }
1243 }
1244
1245 function get_itemcachepath()
1246 {
1247         // Checking, if the cache is deactivated
1248         $cachetime = (int) Config::get('system', 'itemcache_duration');
1249         if ($cachetime < 0) {
1250                 return "";
1251         }
1252
1253         $itemcache = Config::get('system', 'itemcache');
1254         if (($itemcache != "") && App::directory_usable($itemcache)) {
1255                 return App::realpath($itemcache);
1256         }
1257
1258         $temppath = get_temppath();
1259
1260         if ($temppath != "") {
1261                 $itemcache = $temppath . "/itemcache";
1262                 if (!file_exists($itemcache) && !is_dir($itemcache)) {
1263                         mkdir($itemcache);
1264                 }
1265
1266                 if (App::directory_usable($itemcache)) {
1267                         Config::set("system", "itemcache", $itemcache);
1268                         return $itemcache;
1269                 }
1270         }
1271         return "";
1272 }
1273
1274 /**
1275  * @brief Returns the path where spool files are stored
1276  *
1277  * @return string Spool path
1278  */
1279 function get_spoolpath()
1280 {
1281         $spoolpath = Config::get('system', 'spoolpath');
1282         if (($spoolpath != "") && App::directory_usable($spoolpath)) {
1283                 // We have a spool path and it is usable
1284                 return $spoolpath;
1285         }
1286
1287         // We don't have a working preconfigured spool path, so we take the temp path.
1288         $temppath = get_temppath();
1289
1290         if ($temppath != "") {
1291                 // To avoid any interferences with other systems we create our own directory
1292                 $spoolpath = $temppath . "/spool";
1293                 if (!is_dir($spoolpath)) {
1294                         mkdir($spoolpath);
1295                 }
1296
1297                 if (App::directory_usable($spoolpath)) {
1298                         // The new path is usable, we are happy
1299                         Config::set("system", "spoolpath", $spoolpath);
1300                         return $spoolpath;
1301                 } else {
1302                         // We can't create a subdirectory, strange.
1303                         // But the directory seems to work, so we use it but don't store it.
1304                         return $temppath;
1305                 }
1306         }
1307
1308         // Reaching this point means that the operating system is configured badly.
1309         return "";
1310 }
1311
1312 if (!function_exists('exif_imagetype')) {
1313         function exif_imagetype($file)
1314         {
1315                 $size = getimagesize($file);
1316                 return $size[2];
1317         }
1318 }
1319
1320 function validate_include(&$file)
1321 {
1322         $orig_file = $file;
1323
1324         $file = realpath($file);
1325
1326         if (strpos($file, getcwd()) !== 0) {
1327                 return false;
1328         }
1329
1330         $file = str_replace(getcwd() . "/", "", $file, $count);
1331         if ($count != 1) {
1332                 return false;
1333         }
1334
1335         if ($orig_file !== $file) {
1336                 return false;
1337         }
1338
1339         $valid = false;
1340         if (strpos($file, "include/") === 0) {
1341                 $valid = true;
1342         }
1343
1344         if (strpos($file, "addon/") === 0) {
1345                 $valid = true;
1346         }
1347
1348         // Simply return flag
1349         return $valid;
1350 }
1351
1352 function current_load()
1353 {
1354         if (!function_exists('sys_getloadavg')) {
1355                 return false;
1356         }
1357
1358         $load_arr = sys_getloadavg();
1359
1360         if (!is_array($load_arr)) {
1361                 return false;
1362         }
1363
1364         return max($load_arr[0], $load_arr[1]);
1365 }
1366
1367 /**
1368  * @brief get c-style args
1369  *
1370  * @return int
1371  */
1372 function argc()
1373 {
1374         return get_app()->argc;
1375 }
1376
1377 /**
1378  * @brief Returns the value of a argv key
1379  *
1380  * @param int $x argv key
1381  * @return string Value of the argv key
1382  */
1383 function argv($x)
1384 {
1385         if (array_key_exists($x, get_app()->argv)) {
1386                 return get_app()->argv[$x];
1387         }
1388
1389         return '';
1390 }
1391
1392 /**
1393  * @brief Get the data which is needed for infinite scroll
1394  *
1395  * For invinite scroll we need the page number of the actual page
1396  * and the the URI where the content of the next page comes from.
1397  * This data is needed for the js part in main.js.
1398  * Note: infinite scroll does only work for the network page (module)
1399  *
1400  * @param string $module The name of the module (e.g. "network")
1401  * @return array Of infinite scroll data
1402  *      'pageno' => $pageno The number of the actual page
1403  *      'reload_uri' => $reload_uri The URI of the content we have to load
1404  */
1405 function infinite_scroll_data($module)
1406 {
1407         if (PConfig::get(local_user(), 'system', 'infinite_scroll')
1408                 && $module == 'network'
1409                 && defaults($_GET, 'mode', '') != 'minimal'
1410         ) {
1411                 // get the page number
1412                 $pageno = defaults($_GET, 'page', 1);
1413
1414                 $reload_uri = "";
1415
1416                 // try to get the uri from which we load the content
1417                 foreach ($_GET as $param => $value) {
1418                         if (($param != "page") && ($param != "q")) {
1419                                 $reload_uri .= "&" . $param . "=" . urlencode($value);
1420                         }
1421                 }
1422
1423                 $a = get_app();
1424                 if ($a->page_offset != "" && !strstr($reload_uri, "&offset=")) {
1425                         $reload_uri .= "&offset=" . urlencode($a->page_offset);
1426                 }
1427
1428                 $arr = ["pageno" => $pageno, "reload_uri" => $reload_uri];
1429
1430                 return $arr;
1431         }
1432 }