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