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