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