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