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 /** @deprecated since 2019.03, use Term::UNKNOWN instead */
 138 define('TERM_UNKNOWN',   Term::UNKNOWN);
 139 /** @deprecated since 2019.03, use Term::HASHTAG instead */
 140 define('TERM_HASHTAG',   Term::HASHTAG);
 141 /** @deprecated since 2019.03, use Term::MENTION instead */
 142 define('TERM_MENTION',   Term::MENTION);
 143 /** @deprecated since 2019.03, use Term::CATEGORY instead */
 144 define('TERM_CATEGORY',  Term::CATEGORY);
 145 /** @deprecated since 2019.03, use Term::PCATEGORY instead */
 146 define('TERM_PCATEGORY', Term::PCATEGORY);
 147 /** @deprecated since 2019.03, use Term::FILE instead */
 148 define('TERM_FILE',      Term::FILE);
 149 /** @deprecated since 2019.03, use Term::SAVEDSEARCH instead */
 150 define('TERM_SAVEDSEARCH', Term::SAVEDSEARCH);
 151 /** @deprecated since 2019.03, use Term::CONVERSATION instead */
 152 define('TERM_CONVERSATION', Term::CONVERSATION);
 153
 154 /** @deprecated since 2019.03, use Term::OBJECT_TYPE_POST instead */
 155 define('TERM_OBJ_POST',  Term::OBJECT_TYPE_POST);
 156 /** @deprecated since 2019.03, use Term::OBJECT_TYPE_PHOTO instead */
 157 define('TERM_OBJ_PHOTO', Term::OBJECT_TYPE_PHOTO);
 158
 159 /**
 160  * @name Gravity
 161  *
 162  * Item weight for query ordering
 163  * @{
 164  */
 165 define('GRAVITY_PARENT',       0);
 166 define('GRAVITY_ACTIVITY',     3);
 167 define('GRAVITY_COMMENT',      6);
 168 define('GRAVITY_UNKNOWN',      9);
 169 /* @}*/
 170
 171 /**
 172  * @name Priority
 173  *
 174  * Process priority for the worker
 175  * @{
 176  */
 177 define('PRIORITY_UNDEFINED',   0);
 178 define('PRIORITY_CRITICAL',   10);
 179 define('PRIORITY_HIGH',       20);
 180 define('PRIORITY_MEDIUM',     30);
 181 define('PRIORITY_LOW',        40);
 182 define('PRIORITY_NEGLIGIBLE', 50);
 183 /* @}*/
 184
 185 /**
 186  * @name Social Relay settings
 187  *
 188  * See here: https://github.com/jaywink/social-relay
 189  * and here: https://wiki.diasporafoundation.org/Relay_servers_for_public_posts
 190  * @{
 191  */
 192 define('SR_SCOPE_NONE', '');
 193 define('SR_SCOPE_ALL',  'all');
 194 define('SR_SCOPE_TAGS', 'tags');
 195 /* @}*/
 196
 197 // Normally this constant is defined - but not if "pcntl" isn't installed
 198 if (!defined("SIGTERM")) {
 199         define("SIGTERM", 15);
 200 }
 201
 202 /**
 203  * Depending on the PHP version this constant does exist - or not.
 204  * See here: http://php.net/manual/en/curl.constants.php#117928
 205  */
 206 if (!defined('CURLE_OPERATION_TIMEDOUT')) {
 207         define('CURLE_OPERATION_TIMEDOUT', CURLE_OPERATION_TIMEOUTED);
 208 }
 209
 210 /**
 211  * Returns the user id of locally logged in user or false.
 212  *
 213  * @return int|bool user id or false
 214  */
 215 function local_user()
 216 {
 217         if (!empty($_SESSION['authenticated']) && !empty($_SESSION['uid'])) {
 218                 return intval($_SESSION['uid']);
 219         }
 220         return false;
 221 }
 222
 223 /**
 224  * Returns the public contact id of logged in user or false.
 225  *
 226  * @return int|bool public contact id or false
 227  */
 228 function public_contact()
 229 {
 230         static $public_contact_id = false;
 231
 232         if (!$public_contact_id && !empty($_SESSION['authenticated'])) {
 233                 if (!empty($_SESSION['my_address'])) {
 234                         // Local user
 235                         $public_contact_id = intval(Contact::getIdForURL($_SESSION['my_address'], 0, true));
 236                 } elseif (!empty($_SESSION['visitor_home'])) {
 237                         // Remote user
 238                         $public_contact_id = intval(Contact::getIdForURL($_SESSION['visitor_home'], 0, true));
 239                 }
 240         } elseif (empty($_SESSION['authenticated'])) {
 241                 $public_contact_id = false;
 242         }
 243
 244         return $public_contact_id;
 245 }
 246
 247 /**
 248  * Returns contact id of authenticated site visitor or false
 249  *
 250  * @return int|bool visitor_id or false
 251  */
 252 function remote_user()
 253 {
 254         if (empty($_SESSION['authenticated'])) {
 255                 return false;
 256         }
 257
 258         if (!empty($_SESSION['visitor_id'])) {
 259                 return intval($_SESSION['visitor_id']);
 260         }
 261
 262         return false;
 263 }
 264
 265 /**
 266  * Show an error message to user.
 267  *
 268  * This function save text in session, to be shown to the user at next page load
 269  *
 270  * @param string $s - Text of notice
 271  */
 272 function notice($s)
 273 {
 274         if (empty($_SESSION)) {
 275                 return;
 276         }
 277
 278         $a = DI::app();
 279         if (empty($_SESSION['sysmsg'])) {
 280                 $_SESSION['sysmsg'] = [];
 281         }
 282         if ($a->interactive) {
 283                 $_SESSION['sysmsg'][] = $s;
 284         }
 285 }
 286
 287 /**
 288  * Show an info message to user.
 289  *
 290  * This function save text in session, to be shown to the user at next page load
 291  *
 292  * @param string $s - Text of notice
 293  */
 294 function info($s)
 295 {
 296         $a = DI::app();
 297
 298         if (local_user() && DI::pConfig()->get(local_user(), 'system', 'ignore_info')) {
 299                 return;
 300         }
 301
 302         if (empty($_SESSION['sysmsg_info'])) {
 303                 $_SESSION['sysmsg_info'] = [];
 304         }
 305         if ($a->interactive) {
 306                 $_SESSION['sysmsg_info'][] = $s;
 307         }
 308 }
 309
 310 function feed_birthday($uid, $tz)
 311 {
 312         /**
 313          * Determine the next birthday, but only if the birthday is published
 314          * in the default profile. We _could_ also look for a private profile that the
 315          * recipient can see, but somebody could get mad at us if they start getting
 316          * public birthday greetings when they haven't made this info public.
 317          *
 318          * Assuming we are able to publish this info, we are then going to convert
 319          * the start time from the owner's timezone to UTC.
 320          *
 321          * This will potentially solve the problem found with some social networks
 322          * where birthdays are converted to the viewer's timezone and salutations from
 323          * elsewhere in the world show up on the wrong day. We will convert it to the
 324          * viewer's timezone also, but first we are going to convert it from the birthday
 325          * person's timezone to GMT - so the viewer may find the birthday starting at
 326          * 6:00PM the day before, but that will correspond to midnight to the birthday person.
 327          */
 328         $birthday = '';
 329
 330         if (!strlen($tz)) {
 331                 $tz = 'UTC';
 332         }
 333
 334         $profile = DBA::selectFirst('profile', ['dob'], ['uid' => $uid]);
 335         if (DBA::isResult($profile)) {
 336                 $tmp_dob = substr($profile['dob'], 5);
 337                 if (intval($tmp_dob)) {
 338                         $y = DateTimeFormat::timezoneNow($tz, 'Y');
 339                         $bd = $y . '-' . $tmp_dob . ' 00:00';
 340                         $t_dob = strtotime($bd);
 341                         $now = strtotime(DateTimeFormat::timezoneNow($tz));
 342                         if ($t_dob < $now) {
 343                                 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
 344                         }
 345                         $birthday = DateTimeFormat::convert($bd, 'UTC', $tz, DateTimeFormat::ATOM);
 346                 }
 347         }
 348
 349         return $birthday;
 350 }
 351
 352 /**
 353  * Check if current user has admin role.
 354  *
 355  * @return bool true if user is an admin
 356  */
 357 function is_site_admin()
 358 {
 359         $a = DI::app();
 360
 361         $admin_email = DI::config()->get('config', 'admin_email');
 362
 363         $adminlist = explode(',', str_replace(' ', '', $admin_email));
 364
 365         return local_user() && $admin_email && in_array($a->user['email'] ?? '', $adminlist);
 366 }
 367
 368 function explode_querystring($query)
 369 {
 370         $arg_st = strpos($query, '?');
 371         if ($arg_st !== false) {
 372                 $base = substr($query, 0, $arg_st);
 373                 $arg_st += 1;
 374         } else {
 375                 $base = '';
 376                 $arg_st = 0;
 377         }
 378
 379         $args = explode('&', substr($query, $arg_st));
 380         foreach ($args as $k => $arg) {
 381                 /// @TODO really compare type-safe here?
 382                 if ($arg === '') {
 383                         unset($args[$k]);
 384                 }
 385         }
 386         $args = array_values($args);
 387
 388         if (!$base) {
 389                 $base = $args[0];
 390                 unset($args[0]);
 391                 $args = array_values($args);
 392         }
 393
 394         return [
 395                 'base' => $base,
 396                 'args' => $args,
 397         ];
 398 }
 399
 400 /**
 401  * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
 402  *
 403  * Taken from http://webcheatsheet.com/php/get_current_page_url.php
 404  */
 405 function curPageURL()
 406 {
 407         $pageURL = 'http';
 408         if (!empty($_SERVER["HTTPS"]) && ($_SERVER["HTTPS"] == "on")) {
 409                 $pageURL .= "s";
 410         }
 411
 412         $pageURL .= "://";
 413
 414         if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
 415                 $pageURL .= $_SERVER["SERVER_NAME"] . ":" . $_SERVER["SERVER_PORT"] . $_SERVER["REQUEST_URI"];
 416         } else {
 417                 $pageURL .= $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"];
 418         }
 419         return $pageURL;
 420 }
 421
 422 function get_temppath()
 423 {
 424         $temppath = DI::config()->get("system", "temppath");
 425
 426         if (($temppath != "") && System::isDirectoryUsable($temppath)) {
 427                 // We have a temp path and it is usable
 428                 return BasePath::getRealPath($temppath);
 429         }
 430
 431         // We don't have a working preconfigured temp path, so we take the system path.
 432         $temppath = sys_get_temp_dir();
 433
 434         // Check if it is usable
 435         if (($temppath != "") && System::isDirectoryUsable($temppath)) {
 436                 // Always store the real path, not the path through symlinks
 437                 $temppath = BasePath::getRealPath($temppath);
 438
 439                 // To avoid any interferences with other systems we create our own directory
 440                 $new_temppath = $temppath . "/" . DI::baseUrl()->getHostname();
 441                 if (!is_dir($new_temppath)) {
 442                         /// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
 443                         mkdir($new_temppath);
 444                 }
 445
 446                 if (System::isDirectoryUsable($new_temppath)) {
 447                         // The new path is usable, we are happy
 448                         DI::config()->set("system", "temppath", $new_temppath);
 449                         return $new_temppath;
 450                 } else {
 451                         // We can't create a subdirectory, strange.
 452                         // But the directory seems to work, so we use it but don't store it.
 453                         return $temppath;
 454                 }
 455         }
 456
 457         // Reaching this point means that the operating system is configured badly.
 458         return '';
 459 }
 460
 461 function get_cachefile($file, $writemode = true)
 462 {
 463         $cache = get_itemcachepath();
 464
 465         if ((!$cache) || (!is_dir($cache))) {
 466                 return "";
 467         }
 468
 469         $subfolder = $cache . "/" . substr($file, 0, 2);
 470
 471         $cachepath = $subfolder . "/" . $file;
 472
 473         if ($writemode) {
 474                 if (!is_dir($subfolder)) {
 475                         mkdir($subfolder);
 476                         chmod($subfolder, 0777);
 477                 }
 478         }
 479
 480         return $cachepath;
 481 }
 482
 483 function clear_cache($basepath = "", $path = "")
 484 {
 485         if ($path == "") {
 486                 $basepath = get_itemcachepath();
 487                 $path = $basepath;
 488         }
 489
 490         if (($path == "") || (!is_dir($path))) {
 491                 return;
 492         }
 493
 494         if (substr(realpath($path), 0, strlen($basepath)) != $basepath) {
 495                 return;
 496         }
 497
 498         $cachetime = (int) DI::config()->get('system', 'itemcache_duration');
 499         if ($cachetime == 0) {
 500                 $cachetime = 86400;
 501         }
 502
 503         if (is_writable($path)) {
 504                 if ($dh = opendir($path)) {
 505                         while (($file = readdir($dh)) !== false) {
 506                                 $fullpath = $path . "/" . $file;
 507                                 if ((filetype($fullpath) == "dir") && ($file != ".") && ($file != "..")) {
 508                                         clear_cache($basepath, $fullpath);
 509                                 }
 510                                 if ((filetype($fullpath) == "file") && (filectime($fullpath) < (time() - $cachetime))) {
 511                                         unlink($fullpath);
 512                                 }
 513                         }
 514                         closedir($dh);
 515                 }
 516         }
 517 }
 518
 519 function get_itemcachepath()
 520 {
 521         // Checking, if the cache is deactivated
 522         $cachetime = (int) DI::config()->get('system', 'itemcache_duration');
 523         if ($cachetime < 0) {
 524                 return "";
 525         }
 526
 527         $itemcache = DI::config()->get('system', 'itemcache');
 528         if (($itemcache != "") && System::isDirectoryUsable($itemcache)) {
 529                 return BasePath::getRealPath($itemcache);
 530         }
 531
 532         $temppath = get_temppath();
 533
 534         if ($temppath != "") {
 535                 $itemcache = $temppath . "/itemcache";
 536                 if (!file_exists($itemcache) && !is_dir($itemcache)) {
 537                         mkdir($itemcache);
 538                 }
 539
 540                 if (System::isDirectoryUsable($itemcache)) {
 541                         DI::config()->set("system", "itemcache", $itemcache);
 542                         return $itemcache;
 543                 }
 544         }
 545         return "";
 546 }
 547
 548 /**
 549  * Returns the path where spool files are stored
 550  *
 551  * @return string Spool path
 552  */
 553 function get_spoolpath()
 554 {
 555         $spoolpath = DI::config()->get('system', 'spoolpath');
 556         if (($spoolpath != "") && System::isDirectoryUsable($spoolpath)) {
 557                 // We have a spool path and it is usable
 558                 return $spoolpath;
 559         }
 560
 561         // We don't have a working preconfigured spool path, so we take the temp path.
 562         $temppath = get_temppath();
 563
 564         if ($temppath != "") {
 565                 // To avoid any interferences with other systems we create our own directory
 566                 $spoolpath = $temppath . "/spool";
 567                 if (!is_dir($spoolpath)) {
 568                         mkdir($spoolpath);
 569                 }
 570
 571                 if (System::isDirectoryUsable($spoolpath)) {
 572                         // The new path is usable, we are happy
 573                         DI::config()->set("system", "spoolpath", $spoolpath);
 574                         return $spoolpath;
 575                 } else {
 576                         // We can't create a subdirectory, strange.
 577                         // But the directory seems to work, so we use it but don't store it.
 578                         return $temppath;
 579                 }
 580         }
 581
 582         // Reaching this point means that the operating system is configured badly.
 583         return "";
 584 }
 585
 586 if (!function_exists('exif_imagetype')) {
 587         function exif_imagetype($file)
 588         {
 589                 $size = getimagesize($file);
 590                 return $size[2];
 591         }
 592 }
 593
 594 function validate_include(&$file)
 595 {
 596         $orig_file = $file;
 597
 598         $file = realpath($file);
 599
 600         if (strpos($file, getcwd()) !== 0) {
 601                 return false;
 602         }
 603
 604         $file = str_replace(getcwd() . "/", "", $file, $count);
 605         if ($count != 1) {
 606                 return false;
 607         }
 608
 609         if ($orig_file !== $file) {
 610                 return false;
 611         }
 612
 613         $valid = false;
 614         if (strpos($file, "include/") === 0) {
 615                 $valid = true;
 616         }
 617
 618         if (strpos($file, "addon/") === 0) {
 619                 $valid = true;
 620         }
 621
 622         // Simply return flag
 623         return $valid;
 624 }