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