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