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