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