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 use Friendica\Core\Protocol;
  21 use Friendica\Core\System;
  22 use Friendica\Database\DBA;
  23 use Friendica\DI;
  24 use Friendica\Model\Contact;
  25 use Friendica\Model\Term;
  26 use Friendica\Util\BasePath;
  27 use Friendica\Util\DateTimeFormat;
  28
  29 define('FRIENDICA_PLATFORM',     'Friendica');
  30 define('FRIENDICA_CODENAME',     'Dalmatian Bellflower');
  31 define('FRIENDICA_VERSION',      '2020.03-dev');
  32 define('DFRN_PROTOCOL_VERSION',  '2.23');
  33 define('NEW_UPDATE_ROUTINE_VERSION', 1170);
  34
  35 /**
  36  * Constant with a HTML line break.
  37  *
  38  * Contains a HTML line break (br) element and a real carriage return with line
  39  * feed for the source.
  40  * This can be used in HTML and JavaScript where needed a line break.
  41  */
  42 define('EOL',                    "<br />\r\n");
  43
  44 /**
  45  * Image storage quality.
  46  *
  47  * Lower numbers save space at cost of image detail.
  48  * For ease of upgrade, please do not change here. Set system.jpegquality = n in config/local.config.php,
  49  * where n is between 1 and 100, and with very poor results below about 50
  50  */
  51 define('JPEG_QUALITY',            100);
  52
  53 /**
  54  * system.png_quality = n where is between 0 (uncompressed) to 9
  55  */
  56 define('PNG_QUALITY',             8);
  57
  58 /**
  59  * An alternate way of limiting picture upload sizes. Specify the maximum pixel
  60  * length that pictures are allowed to be (for non-square pictures, it will apply
  61  * to the longest side). Pictures longer than this length will be resized to be
  62  * this length (on the longest side, the other side will be scaled appropriately).
  63  * Modify this value using
  64  *
  65  * 'system' => [
  66  *      'max_image_length' => 'n',
  67  *      ...
  68  * ],
  69  *
  70  * in config/local.config.php
  71  *
  72  * If you don't want to set a maximum length, set to -1. The default value is
  73  * defined by 'MAX_IMAGE_LENGTH' below.
  74  */
  75 define('MAX_IMAGE_LENGTH',        -1);
  76
  77 /**
  78  * Not yet used
  79  */
  80 define('DEFAULT_DB_ENGINE',  'InnoDB');
  81
  82 /** @deprecated since version 2019.03, please use \Friendica\Module\Register::CLOSED instead */
  83 define('REGISTER_CLOSED',        \Friendica\Module\Register::CLOSED);
  84 /** @deprecated since version 2019.03, please use \Friendica\Module\Register::APPROVE instead */
  85 define('REGISTER_APPROVE',       \Friendica\Module\Register::APPROVE);
  86 /** @deprecated since version 2019.03, please use \Friendica\Module\Register::OPEN instead */
  87 define('REGISTER_OPEN',          \Friendica\Module\Register::OPEN);
  88
  89 /**
  90  * @name CP
  91  *
  92  * Type of the community page
  93  * @{
  94  */
  95 define('CP_NO_INTERNAL_COMMUNITY', -2);
  96 define('CP_NO_COMMUNITY_PAGE',     -1);
  97 define('CP_USERS_ON_SERVER',        0);
  98 define('CP_GLOBAL_COMMUNITY',       1);
  99 define('CP_USERS_AND_GLOBAL',       2);
 100 /**
 101  * @}
 102  */
 103
 104 /**
 105  * These numbers are used in stored permissions
 106  * and existing allocations MUST NEVER BE CHANGED
 107  * OR RE-ASSIGNED! You may only add to them.
 108  */
 109 $netgroup_ids = [
 110         Protocol::DFRN     => (-1),
 111         Protocol::ZOT      => (-2),
 112         Protocol::OSTATUS  => (-3),
 113         Protocol::FEED     => (-4),
 114         Protocol::DIASPORA => (-5),
 115         Protocol::MAIL     => (-6),
 116         Protocol::FACEBOOK => (-8),
 117         Protocol::LINKEDIN => (-9),
 118         Protocol::XMPP     => (-10),
 119         Protocol::MYSPACE  => (-11),
 120         Protocol::GPLUS    => (-12),
 121         Protocol::PUMPIO   => (-13),
 122         Protocol::TWITTER  => (-14),
 123         Protocol::DIASPORA2 => (-15),
 124         Protocol::STATUSNET => (-16),
 125         Protocol::NEWS      => (-18),
 126         Protocol::ICALENDAR => (-19),
 127         Protocol::PNUT      => (-20),
 128
 129         Protocol::PHANTOM  => (-127),
 130 ];
 131
 132 /**
 133  * Maximum number of "people who like (or don't like) this"  that we will list by name
 134  */
 135 define('MAX_LIKERS',    75);
 136
 137 /**
 138  * @name Notify
 139  *
 140  * Email notification options
 141  * @{
 142  */
 143 define('NOTIFY_WALL',         4);
 144 define('NOTIFY_COMMENT',      8);
 145 define('NOTIFY_MAIL',        16);
 146 define('NOTIFY_SUGGEST',     32);
 147 define('NOTIFY_PROFILE',     64);
 148 define('NOTIFY_TAGSELF',    128);
 149 define('NOTIFY_TAGSHARE',   256);
 150 define('NOTIFY_POKE',       512);
 151 define('NOTIFY_SHARE',     1024);
 152
 153 define('NOTIFY_SYSTEM',   32768);
 154 /* @}*/
 155
 156
 157 /** @deprecated since 2019.03, use Term::UNKNOWN instead */
 158 define('TERM_UNKNOWN',   Term::UNKNOWN);
 159 /** @deprecated since 2019.03, use Term::HASHTAG instead */
 160 define('TERM_HASHTAG',   Term::HASHTAG);
 161 /** @deprecated since 2019.03, use Term::MENTION instead */
 162 define('TERM_MENTION',   Term::MENTION);
 163 /** @deprecated since 2019.03, use Term::CATEGORY instead */
 164 define('TERM_CATEGORY',  Term::CATEGORY);
 165 /** @deprecated since 2019.03, use Term::PCATEGORY instead */
 166 define('TERM_PCATEGORY', Term::PCATEGORY);
 167 /** @deprecated since 2019.03, use Term::FILE instead */
 168 define('TERM_FILE',      Term::FILE);
 169 /** @deprecated since 2019.03, use Term::SAVEDSEARCH instead */
 170 define('TERM_SAVEDSEARCH', Term::SAVEDSEARCH);
 171 /** @deprecated since 2019.03, use Term::CONVERSATION instead */
 172 define('TERM_CONVERSATION', Term::CONVERSATION);
 173
 174 /** @deprecated since 2019.03, use Term::OBJECT_TYPE_POST instead */
 175 define('TERM_OBJ_POST',  Term::OBJECT_TYPE_POST);
 176 /** @deprecated since 2019.03, use Term::OBJECT_TYPE_PHOTO instead */
 177 define('TERM_OBJ_PHOTO', Term::OBJECT_TYPE_PHOTO);
 178
 179 /**
 180  * @name Gravity
 181  *
 182  * Item weight for query ordering
 183  * @{
 184  */
 185 define('GRAVITY_PARENT',       0);
 186 define('GRAVITY_ACTIVITY',     3);
 187 define('GRAVITY_COMMENT',      6);
 188 define('GRAVITY_UNKNOWN',      9);
 189 /* @}*/
 190
 191 /**
 192  * @name Priority
 193  *
 194  * Process priority for the worker
 195  * @{
 196  */
 197 define('PRIORITY_UNDEFINED',   0);
 198 define('PRIORITY_CRITICAL',   10);
 199 define('PRIORITY_HIGH',       20);
 200 define('PRIORITY_MEDIUM',     30);
 201 define('PRIORITY_LOW',        40);
 202 define('PRIORITY_NEGLIGIBLE', 50);
 203 /* @}*/
 204
 205 /**
 206  * @name Social Relay settings
 207  *
 208  * See here: https://github.com/jaywink/social-relay
 209  * and here: https://wiki.diasporafoundation.org/Relay_servers_for_public_posts
 210  * @{
 211  */
 212 define('SR_SCOPE_NONE', '');
 213 define('SR_SCOPE_ALL',  'all');
 214 define('SR_SCOPE_TAGS', 'tags');
 215 /* @}*/
 216
 217 // Normally this constant is defined - but not if "pcntl" isn't installed
 218 if (!defined("SIGTERM")) {
 219         define("SIGTERM", 15);
 220 }
 221
 222 /**
 223  * Depending on the PHP version this constant does exist - or not.
 224  * See here: http://php.net/manual/en/curl.constants.php#117928
 225  */
 226 if (!defined('CURLE_OPERATION_TIMEDOUT')) {
 227         define('CURLE_OPERATION_TIMEDOUT', CURLE_OPERATION_TIMEOUTED);
 228 }
 229
 230 /**
 231  * Returns the user id of locally logged in user or false.
 232  *
 233  * @return int|bool user id or false
 234  */
 235 function local_user()
 236 {
 237         if (!empty($_SESSION['authenticated']) && !empty($_SESSION['uid'])) {
 238                 return intval($_SESSION['uid']);
 239         }
 240         return false;
 241 }
 242
 243 /**
 244  * Returns the public contact id of logged in user or false.
 245  *
 246  * @return int|bool public contact id or false
 247  */
 248 function public_contact()
 249 {
 250         static $public_contact_id = false;
 251
 252         if (!$public_contact_id && !empty($_SESSION['authenticated'])) {
 253                 if (!empty($_SESSION['my_address'])) {
 254                         // Local user
 255                         $public_contact_id = intval(Contact::getIdForURL($_SESSION['my_address'], 0, true));
 256                 } elseif (!empty($_SESSION['visitor_home'])) {
 257                         // Remote user
 258                         $public_contact_id = intval(Contact::getIdForURL($_SESSION['visitor_home'], 0, true));
 259                 }
 260         } elseif (empty($_SESSION['authenticated'])) {
 261                 $public_contact_id = false;
 262         }
 263
 264         return $public_contact_id;
 265 }
 266
 267 /**
 268  * Returns contact id of authenticated site visitor or false
 269  *
 270  * @return int|bool visitor_id or false
 271  */
 272 function remote_user()
 273 {
 274         if (empty($_SESSION['authenticated'])) {
 275                 return false;
 276         }
 277
 278         if (!empty($_SESSION['visitor_id'])) {
 279                 return intval($_SESSION['visitor_id']);
 280         }
 281
 282         return false;
 283 }
 284
 285 /**
 286  * Show an error message to user.
 287  *
 288  * This function save text in session, to be shown to the user at next page load
 289  *
 290  * @param string $s - Text of notice
 291  */
 292 function notice($s)
 293 {
 294         if (empty($_SESSION)) {
 295                 return;
 296         }
 297
 298         $a = DI::app();
 299         if (empty($_SESSION['sysmsg'])) {
 300                 $_SESSION['sysmsg'] = [];
 301         }
 302         if ($a->interactive) {
 303                 $_SESSION['sysmsg'][] = $s;
 304         }
 305 }
 306
 307 /**
 308  * Show an info message to user.
 309  *
 310  * This function save text in session, to be shown to the user at next page load
 311  *
 312  * @param string $s - Text of notice
 313  */
 314 function info($s)
 315 {
 316         $a = DI::app();
 317
 318         if (local_user() && DI::pConfig()->get(local_user(), 'system', 'ignore_info')) {
 319                 return;
 320         }
 321
 322         if (empty($_SESSION['sysmsg_info'])) {
 323                 $_SESSION['sysmsg_info'] = [];
 324         }
 325         if ($a->interactive) {
 326                 $_SESSION['sysmsg_info'][] = $s;
 327         }
 328 }
 329
 330 function feed_birthday($uid, $tz)
 331 {
 332         /**
 333          * Determine the next birthday, but only if the birthday is published
 334          * in the default profile. We _could_ also look for a private profile that the
 335          * recipient can see, but somebody could get mad at us if they start getting
 336          * public birthday greetings when they haven't made this info public.
 337          *
 338          * Assuming we are able to publish this info, we are then going to convert
 339          * the start time from the owner's timezone to UTC.
 340          *
 341          * This will potentially solve the problem found with some social networks
 342          * where birthdays are converted to the viewer's timezone and salutations from
 343          * elsewhere in the world show up on the wrong day. We will convert it to the
 344          * viewer's timezone also, but first we are going to convert it from the birthday
 345          * person's timezone to GMT - so the viewer may find the birthday starting at
 346          * 6:00PM the day before, but that will correspond to midnight to the birthday person.
 347          */
 348         $birthday = '';
 349
 350         if (!strlen($tz)) {
 351                 $tz = 'UTC';
 352         }
 353
 354         $profile = DBA::selectFirst('profile', ['dob'], ['uid' => $uid]);
 355         if (DBA::isResult($profile)) {
 356                 $tmp_dob = substr($profile['dob'], 5);
 357                 if (intval($tmp_dob)) {
 358                         $y = DateTimeFormat::timezoneNow($tz, 'Y');
 359                         $bd = $y . '-' . $tmp_dob . ' 00:00';
 360                         $t_dob = strtotime($bd);
 361                         $now = strtotime(DateTimeFormat::timezoneNow($tz));
 362                         if ($t_dob < $now) {
 363                                 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
 364                         }
 365                         $birthday = DateTimeFormat::convert($bd, 'UTC', $tz, DateTimeFormat::ATOM);
 366                 }
 367         }
 368
 369         return $birthday;
 370 }
 371
 372 /**
 373  * Check if current user has admin role.
 374  *
 375  * @return bool true if user is an admin
 376  */
 377 function is_site_admin()
 378 {
 379         $a = DI::app();
 380
 381         $admin_email = DI::config()->get('config', 'admin_email');
 382
 383         $adminlist = explode(',', str_replace(' ', '', $admin_email));
 384
 385         return local_user() && $admin_email && in_array($a->user['email'] ?? '', $adminlist);
 386 }
 387
 388 function explode_querystring($query)
 389 {
 390         $arg_st = strpos($query, '?');
 391         if ($arg_st !== false) {
 392                 $base = substr($query, 0, $arg_st);
 393                 $arg_st += 1;
 394         } else {
 395                 $base = '';
 396                 $arg_st = 0;
 397         }
 398
 399         $args = explode('&', substr($query, $arg_st));
 400         foreach ($args as $k => $arg) {
 401                 /// @TODO really compare type-safe here?
 402                 if ($arg === '') {
 403                         unset($args[$k]);
 404                 }
 405         }
 406         $args = array_values($args);
 407
 408         if (!$base) {
 409                 $base = $args[0];
 410                 unset($args[0]);
 411                 $args = array_values($args);
 412         }
 413
 414         return [
 415                 'base' => $base,
 416                 'args' => $args,
 417         ];
 418 }
 419
 420 /**
 421  * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
 422  *
 423  * Taken from http://webcheatsheet.com/php/get_current_page_url.php
 424  */
 425 function curPageURL()
 426 {
 427         $pageURL = 'http';
 428         if (!empty($_SERVER["HTTPS"]) && ($_SERVER["HTTPS"] == "on")) {
 429                 $pageURL .= "s";
 430         }
 431
 432         $pageURL .= "://";
 433
 434         if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
 435                 $pageURL .= $_SERVER["SERVER_NAME"] . ":" . $_SERVER["SERVER_PORT"] . $_SERVER["REQUEST_URI"];
 436         } else {
 437                 $pageURL .= $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"];
 438         }
 439         return $pageURL;
 440 }
 441
 442 function get_temppath()
 443 {
 444         $temppath = DI::config()->get("system", "temppath");
 445
 446         if (($temppath != "") && System::isDirectoryUsable($temppath)) {
 447                 // We have a temp path and it is usable
 448                 return BasePath::getRealPath($temppath);
 449         }
 450
 451         // We don't have a working preconfigured temp path, so we take the system path.
 452         $temppath = sys_get_temp_dir();
 453
 454         // Check if it is usable
 455         if (($temppath != "") && System::isDirectoryUsable($temppath)) {
 456                 // Always store the real path, not the path through symlinks
 457                 $temppath = BasePath::getRealPath($temppath);
 458
 459                 // To avoid any interferences with other systems we create our own directory
 460                 $new_temppath = $temppath . "/" . DI::baseUrl()->getHostname();
 461                 if (!is_dir($new_temppath)) {
 462                         /// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
 463                         mkdir($new_temppath);
 464                 }
 465
 466                 if (System::isDirectoryUsable($new_temppath)) {
 467                         // The new path is usable, we are happy
 468                         DI::config()->set("system", "temppath", $new_temppath);
 469                         return $new_temppath;
 470                 } else {
 471                         // We can't create a subdirectory, strange.
 472                         // But the directory seems to work, so we use it but don't store it.
 473                         return $temppath;
 474                 }
 475         }
 476
 477         // Reaching this point means that the operating system is configured badly.
 478         return '';
 479 }
 480
 481 function get_cachefile($file, $writemode = true)
 482 {
 483         $cache = get_itemcachepath();
 484
 485         if ((!$cache) || (!is_dir($cache))) {
 486                 return "";
 487         }
 488
 489         $subfolder = $cache . "/" . substr($file, 0, 2);
 490
 491         $cachepath = $subfolder . "/" . $file;
 492
 493         if ($writemode) {
 494                 if (!is_dir($subfolder)) {
 495                         mkdir($subfolder);
 496                         chmod($subfolder, 0777);
 497                 }
 498         }
 499
 500         return $cachepath;
 501 }
 502
 503 function clear_cache($basepath = "", $path = "")
 504 {
 505         if ($path == "") {
 506                 $basepath = get_itemcachepath();
 507                 $path = $basepath;
 508         }
 509
 510         if (($path == "") || (!is_dir($path))) {
 511                 return;
 512         }
 513
 514         if (substr(realpath($path), 0, strlen($basepath)) != $basepath) {
 515                 return;
 516         }
 517
 518         $cachetime = (int) DI::config()->get('system', 'itemcache_duration');
 519         if ($cachetime == 0) {
 520                 $cachetime = 86400;
 521         }
 522
 523         if (is_writable($path)) {
 524                 if ($dh = opendir($path)) {
 525                         while (($file = readdir($dh)) !== false) {
 526                                 $fullpath = $path . "/" . $file;
 527                                 if ((filetype($fullpath) == "dir") && ($file != ".") && ($file != "..")) {
 528                                         clear_cache($basepath, $fullpath);
 529                                 }
 530                                 if ((filetype($fullpath) == "file") && (filectime($fullpath) < (time() - $cachetime))) {
 531                                         unlink($fullpath);
 532                                 }
 533                         }
 534                         closedir($dh);
 535                 }
 536         }
 537 }
 538
 539 function get_itemcachepath()
 540 {
 541         // Checking, if the cache is deactivated
 542         $cachetime = (int) DI::config()->get('system', 'itemcache_duration');
 543         if ($cachetime < 0) {
 544                 return "";
 545         }
 546
 547         $itemcache = DI::config()->get('system', 'itemcache');
 548         if (($itemcache != "") && System::isDirectoryUsable($itemcache)) {
 549                 return BasePath::getRealPath($itemcache);
 550         }
 551
 552         $temppath = get_temppath();
 553
 554         if ($temppath != "") {
 555                 $itemcache = $temppath . "/itemcache";
 556                 if (!file_exists($itemcache) && !is_dir($itemcache)) {
 557                         mkdir($itemcache);
 558                 }
 559
 560                 if (System::isDirectoryUsable($itemcache)) {
 561                         DI::config()->set("system", "itemcache", $itemcache);
 562                         return $itemcache;
 563                 }
 564         }
 565         return "";
 566 }
 567
 568 /**
 569  * Returns the path where spool files are stored
 570  *
 571  * @return string Spool path
 572  */
 573 function get_spoolpath()
 574 {
 575         $spoolpath = DI::config()->get('system', 'spoolpath');
 576         if (($spoolpath != "") && System::isDirectoryUsable($spoolpath)) {
 577                 // We have a spool path and it is usable
 578                 return $spoolpath;
 579         }
 580
 581         // We don't have a working preconfigured spool path, so we take the temp path.
 582         $temppath = get_temppath();
 583
 584         if ($temppath != "") {
 585                 // To avoid any interferences with other systems we create our own directory
 586                 $spoolpath = $temppath . "/spool";
 587                 if (!is_dir($spoolpath)) {
 588                         mkdir($spoolpath);
 589                 }
 590
 591                 if (System::isDirectoryUsable($spoolpath)) {
 592                         // The new path is usable, we are happy
 593                         DI::config()->set("system", "spoolpath", $spoolpath);
 594                         return $spoolpath;
 595                 } else {
 596                         // We can't create a subdirectory, strange.
 597                         // But the directory seems to work, so we use it but don't store it.
 598                         return $temppath;
 599                 }
 600         }
 601
 602         // Reaching this point means that the operating system is configured badly.
 603         return "";
 604 }
 605
 606 if (!function_exists('exif_imagetype')) {
 607         function exif_imagetype($file)
 608         {
 609                 $size = getimagesize($file);
 610                 return $size[2];
 611         }
 612 }
 613
 614 function validate_include(&$file)
 615 {
 616         $orig_file = $file;
 617
 618         $file = realpath($file);
 619
 620         if (strpos($file, getcwd()) !== 0) {
 621                 return false;
 622         }
 623
 624         $file = str_replace(getcwd() . "/", "", $file, $count);
 625         if ($count != 1) {
 626                 return false;
 627         }
 628
 629         if ($orig_file !== $file) {
 630                 return false;
 631         }
 632
 633         $valid = false;
 634         if (strpos($file, "include/") === 0) {
 635                 $valid = true;
 636         }
 637
 638         if (strpos($file, "addon/") === 0) {
 639                 $valid = true;
 640         }
 641
 642         // Simply return flag
 643         return $valid;
 644 }