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