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\App;
  21 use Friendica\BaseObject;
  22 use Friendica\Core\Config;
  23 use Friendica\Core\PConfig;
  24 use Friendica\Core\Protocol;
  25 use Friendica\Core\System;
  26 use Friendica\Core\Session;
  27 use Friendica\Database\DBA;
  28 use Friendica\Model\Contact;
  29 use Friendica\Model\Term;
  30 use Friendica\Util\BasePath;
  31 use Friendica\Util\DateTimeFormat;
  32
  33 define('FRIENDICA_PLATFORM',     'Friendica');
  34 define('FRIENDICA_CODENAME',     'Dalmatian Bellflower');
  35 define('FRIENDICA_VERSION',      '2019.12-dev');
  36 define('DFRN_PROTOCOL_VERSION',  '2.23');
  37 define('NEW_UPDATE_ROUTINE_VERSION', 1170);
  38
  39 /**
  40  * @brief Constant with a HTML line break.
  41  *
  42  * Contains a HTML line break (br) element and a real carriage return with line
  43  * feed for the source.
  44  * This can be used in HTML and JavaScript where needed a line break.
  45  */
  46 define('EOL',                    "<br />\r\n");
  47
  48 /**
  49  * @brief Image storage quality.
  50  *
  51  * Lower numbers save space at cost of image detail.
  52  * For ease of upgrade, please do not change here. Set system.jpegquality = n in config/local.config.php,
  53  * where n is between 1 and 100, and with very poor results below about 50
  54  */
  55 define('JPEG_QUALITY',            100);
  56
  57 /**
  58  * system.png_quality = n where is between 0 (uncompressed) to 9
  59  */
  60 define('PNG_QUALITY',             8);
  61
  62 /**
  63  * An alternate way of limiting picture upload sizes. Specify the maximum pixel
  64  * length that pictures are allowed to be (for non-square pictures, it will apply
  65  * to the longest side). Pictures longer than this length will be resized to be
  66  * this length (on the longest side, the other side will be scaled appropriately).
  67  * Modify this value using
  68  *
  69  * 'system' => [
  70  *      'max_image_length' => 'n',
  71  *      ...
  72  * ],
  73  *
  74  * in config/local.config.php
  75  *
  76  * If you don't want to set a maximum length, set to -1. The default value is
  77  * defined by 'MAX_IMAGE_LENGTH' below.
  78  */
  79 define('MAX_IMAGE_LENGTH',        -1);
  80
  81 /**
  82  * Not yet used
  83  */
  84 define('DEFAULT_DB_ENGINE',  'InnoDB');
  85
  86 /** @deprecated since version 2019.03, please use \Friendica\Module\Register::CLOSED instead */
  87 define('REGISTER_CLOSED',        \Friendica\Module\Register::CLOSED);
  88 /** @deprecated since version 2019.03, please use \Friendica\Module\Register::APPROVE instead */
  89 define('REGISTER_APPROVE',       \Friendica\Module\Register::APPROVE);
  90 /** @deprecated since version 2019.03, please use \Friendica\Module\Register::OPEN instead */
  91 define('REGISTER_OPEN',          \Friendica\Module\Register::OPEN);
  92
  93 /**
  94  * @name CP
  95  *
  96  * Type of the community page
  97  * @{
  98  */
  99 define('CP_NO_INTERNAL_COMMUNITY', -2);
 100 define('CP_NO_COMMUNITY_PAGE',     -1);
 101 define('CP_USERS_ON_SERVER',        0);
 102 define('CP_GLOBAL_COMMUNITY',       1);
 103 define('CP_USERS_AND_GLOBAL',       2);
 104 /**
 105  * @}
 106  */
 107
 108 /**
 109  * These numbers are used in stored permissions
 110  * and existing allocations MUST NEVER BE CHANGED
 111  * OR RE-ASSIGNED! You may only add to them.
 112  */
 113 $netgroup_ids = [
 114         Protocol::DFRN     => (-1),
 115         Protocol::ZOT      => (-2),
 116         Protocol::OSTATUS  => (-3),
 117         Protocol::FEED     => (-4),
 118         Protocol::DIASPORA => (-5),
 119         Protocol::MAIL     => (-6),
 120         Protocol::FACEBOOK => (-8),
 121         Protocol::LINKEDIN => (-9),
 122         Protocol::XMPP     => (-10),
 123         Protocol::MYSPACE  => (-11),
 124         Protocol::GPLUS    => (-12),
 125         Protocol::PUMPIO   => (-13),
 126         Protocol::TWITTER  => (-14),
 127         Protocol::DIASPORA2 => (-15),
 128         Protocol::STATUSNET => (-16),
 129         Protocol::NEWS      => (-18),
 130         Protocol::ICALENDAR => (-19),
 131         Protocol::PNUT      => (-20),
 132
 133         Protocol::PHANTOM  => (-127),
 134 ];
 135
 136 /**
 137  * Maximum number of "people who like (or don't like) this"  that we will list by name
 138  */
 139 define('MAX_LIKERS',    75);
 140
 141 /**
 142  * @name Notify
 143  *
 144  * Email notification options
 145  * @{
 146  */
 147 define('NOTIFY_INTRO',        1);
 148 define('NOTIFY_CONFIRM',      2);
 149 define('NOTIFY_WALL',         4);
 150 define('NOTIFY_COMMENT',      8);
 151 define('NOTIFY_MAIL',        16);
 152 define('NOTIFY_SUGGEST',     32);
 153 define('NOTIFY_PROFILE',     64);
 154 define('NOTIFY_TAGSELF',    128);
 155 define('NOTIFY_TAGSHARE',   256);
 156 define('NOTIFY_POKE',       512);
 157 define('NOTIFY_SHARE',     1024);
 158
 159 define('SYSTEM_EMAIL',    16384);
 160
 161 define('NOTIFY_SYSTEM',   32768);
 162 /* @}*/
 163
 164
 165 /** @deprecated since 2019.03, use Term::UNKNOWN instead */
 166 define('TERM_UNKNOWN',   Term::UNKNOWN);
 167 /** @deprecated since 2019.03, use Term::HASHTAG instead */
 168 define('TERM_HASHTAG',   Term::HASHTAG);
 169 /** @deprecated since 2019.03, use Term::MENTION instead */
 170 define('TERM_MENTION',   Term::MENTION);
 171 /** @deprecated since 2019.03, use Term::CATEGORY instead */
 172 define('TERM_CATEGORY',  Term::CATEGORY);
 173 /** @deprecated since 2019.03, use Term::PCATEGORY instead */
 174 define('TERM_PCATEGORY', Term::PCATEGORY);
 175 /** @deprecated since 2019.03, use Term::FILE instead */
 176 define('TERM_FILE',      Term::FILE);
 177 /** @deprecated since 2019.03, use Term::SAVEDSEARCH instead */
 178 define('TERM_SAVEDSEARCH', Term::SAVEDSEARCH);
 179 /** @deprecated since 2019.03, use Term::CONVERSATION instead */
 180 define('TERM_CONVERSATION', Term::CONVERSATION);
 181
 182 /** @deprecated since 2019.03, use Term::OBJECT_TYPE_POST instead */
 183 define('TERM_OBJ_POST',  Term::OBJECT_TYPE_POST);
 184 /** @deprecated since 2019.03, use Term::OBJECT_TYPE_PHOTO instead */
 185 define('TERM_OBJ_PHOTO', Term::OBJECT_TYPE_PHOTO);
 186
 187 /**
 188  * @name Namespaces
 189  *
 190  * Various namespaces we may need to parse
 191  * @{
 192  */
 193 define('NAMESPACE_ZOT',             'http://purl.org/zot');
 194 define('NAMESPACE_DFRN',            'http://purl.org/macgirvin/dfrn/1.0');
 195 define('NAMESPACE_THREAD',          'http://purl.org/syndication/thread/1.0');
 196 define('NAMESPACE_TOMB',            'http://purl.org/atompub/tombstones/1.0');
 197 define('NAMESPACE_ACTIVITY2',       'https://www.w3.org/ns/activitystreams#');
 198 define('NAMESPACE_ACTIVITY',        'http://activitystrea.ms/spec/1.0/');
 199 define('NAMESPACE_ACTIVITY_SCHEMA', 'http://activitystrea.ms/schema/1.0/');
 200 define('NAMESPACE_MEDIA',           'http://purl.org/syndication/atommedia');
 201 define('NAMESPACE_SALMON_ME',       'http://salmon-protocol.org/ns/magic-env');
 202 define('NAMESPACE_OSTATUSSUB',      'http://ostatus.org/schema/1.0/subscribe');
 203 define('NAMESPACE_GEORSS',          'http://www.georss.org/georss');
 204 define('NAMESPACE_POCO',            'http://portablecontacts.net/spec/1.0');
 205 define('NAMESPACE_FEED',            'http://schemas.google.com/g/2010#updates-from');
 206 define('NAMESPACE_OSTATUS',         'http://ostatus.org/schema/1.0');
 207 define('NAMESPACE_STATUSNET',       'http://status.net/schema/api/1/');
 208 define('NAMESPACE_ATOM1',           'http://www.w3.org/2005/Atom');
 209 define('NAMESPACE_MASTODON',        'http://mastodon.social/schema/1.0');
 210 /* @}*/
 211
 212 /**
 213  * @name Activity
 214  *
 215  * Activity stream defines
 216  * @{
 217  */
 218 define('ACTIVITY_LIKE',        NAMESPACE_ACTIVITY_SCHEMA . 'like');
 219 define('ACTIVITY_DISLIKE',     NAMESPACE_DFRN            . '/dislike');
 220 define('ACTIVITY_ATTEND',      NAMESPACE_ZOT             . '/activity/attendyes');
 221 define('ACTIVITY_ATTENDNO',    NAMESPACE_ZOT             . '/activity/attendno');
 222 define('ACTIVITY_ATTENDMAYBE', NAMESPACE_ZOT             . '/activity/attendmaybe');
 223
 224 define('ACTIVITY_OBJ_HEART',   NAMESPACE_DFRN            . '/heart');
 225
 226 define('ACTIVITY_FRIEND',      NAMESPACE_ACTIVITY_SCHEMA . 'make-friend');
 227 define('ACTIVITY_REQ_FRIEND',  NAMESPACE_ACTIVITY_SCHEMA . 'request-friend');
 228 define('ACTIVITY_UNFRIEND',    NAMESPACE_ACTIVITY_SCHEMA . 'remove-friend');
 229 define('ACTIVITY_FOLLOW',      NAMESPACE_ACTIVITY_SCHEMA . 'follow');
 230 define('ACTIVITY_UNFOLLOW',    NAMESPACE_ACTIVITY_SCHEMA . 'stop-following');
 231 define('ACTIVITY_JOIN',        NAMESPACE_ACTIVITY_SCHEMA . 'join');
 232
 233 define('ACTIVITY_POST',        NAMESPACE_ACTIVITY_SCHEMA . 'post');
 234 define('ACTIVITY_UPDATE',      NAMESPACE_ACTIVITY_SCHEMA . 'update');
 235 define('ACTIVITY_TAG',         NAMESPACE_ACTIVITY_SCHEMA . 'tag');
 236 define('ACTIVITY_FAVORITE',    NAMESPACE_ACTIVITY_SCHEMA . 'favorite');
 237 define('ACTIVITY_UNFAVORITE',  NAMESPACE_ACTIVITY_SCHEMA . 'unfavorite');
 238 define('ACTIVITY_SHARE',       NAMESPACE_ACTIVITY_SCHEMA . 'share');
 239 define('ACTIVITY_DELETE',      NAMESPACE_ACTIVITY_SCHEMA . 'delete');
 240 define('ACTIVITY2_ANNOUNCE',   NAMESPACE_ACTIVITY2       . 'Announce');
 241
 242 define('ACTIVITY_POKE',        NAMESPACE_ZOT . '/activity/poke');
 243
 244 define('ACTIVITY_OBJ_BOOKMARK', NAMESPACE_ACTIVITY_SCHEMA . 'bookmark');
 245 define('ACTIVITY_OBJ_COMMENT', NAMESPACE_ACTIVITY_SCHEMA . 'comment');
 246 define('ACTIVITY_OBJ_NOTE',    NAMESPACE_ACTIVITY_SCHEMA . 'note');
 247 define('ACTIVITY_OBJ_PERSON',  NAMESPACE_ACTIVITY_SCHEMA . 'person');
 248 define('ACTIVITY_OBJ_IMAGE',   NAMESPACE_ACTIVITY_SCHEMA . 'image');
 249 define('ACTIVITY_OBJ_PHOTO',   NAMESPACE_ACTIVITY_SCHEMA . 'photo');
 250 define('ACTIVITY_OBJ_VIDEO',   NAMESPACE_ACTIVITY_SCHEMA . 'video');
 251 define('ACTIVITY_OBJ_P_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'profile-photo');
 252 define('ACTIVITY_OBJ_ALBUM',   NAMESPACE_ACTIVITY_SCHEMA . 'photo-album');
 253 define('ACTIVITY_OBJ_EVENT',   NAMESPACE_ACTIVITY_SCHEMA . 'event');
 254 define('ACTIVITY_OBJ_GROUP',   NAMESPACE_ACTIVITY_SCHEMA . 'group');
 255 define('ACTIVITY_OBJ_TAGTERM', NAMESPACE_DFRN            . '/tagterm');
 256 define('ACTIVITY_OBJ_PROFILE', NAMESPACE_DFRN            . '/profile');
 257 define('ACTIVITY_OBJ_QUESTION', 'http://activityschema.org/object/question');
 258 /* @}*/
 259
 260 /**
 261  * @name Gravity
 262  *
 263  * Item weight for query ordering
 264  * @{
 265  */
 266 define('GRAVITY_PARENT',       0);
 267 define('GRAVITY_ACTIVITY',     3);
 268 define('GRAVITY_COMMENT',      6);
 269 define('GRAVITY_UNKNOWN',      9);
 270 /* @}*/
 271
 272 /**
 273  * @name Priority
 274  *
 275  * Process priority for the worker
 276  * @{
 277  */
 278 define('PRIORITY_UNDEFINED',   0);
 279 define('PRIORITY_CRITICAL',   10);
 280 define('PRIORITY_HIGH',       20);
 281 define('PRIORITY_MEDIUM',     30);
 282 define('PRIORITY_LOW',        40);
 283 define('PRIORITY_NEGLIGIBLE', 50);
 284 /* @}*/
 285
 286 /**
 287  * @name Social Relay settings
 288  *
 289  * See here: https://github.com/jaywink/social-relay
 290  * and here: https://wiki.diasporafoundation.org/Relay_servers_for_public_posts
 291  * @{
 292  */
 293 define('SR_SCOPE_NONE', '');
 294 define('SR_SCOPE_ALL',  'all');
 295 define('SR_SCOPE_TAGS', 'tags');
 296 /* @}*/
 297
 298 // Normally this constant is defined - but not if "pcntl" isn't installed
 299 if (!defined("SIGTERM")) {
 300         define("SIGTERM", 15);
 301 }
 302
 303 /**
 304  * Depending on the PHP version this constant does exist - or not.
 305  * See here: http://php.net/manual/en/curl.constants.php#117928
 306  */
 307 if (!defined('CURLE_OPERATION_TIMEDOUT')) {
 308         define('CURLE_OPERATION_TIMEDOUT', CURLE_OPERATION_TIMEOUTED);
 309 }
 310
 311 /**
 312  * @brief Retrieve the App structure
 313  *
 314  * Useful in functions which require it but don't get it passed to them
 315  *
 316  * @deprecated since version 2018.09
 317  * @see BaseObject::getApp()
 318  * @return App
 319  */
 320 function get_app()
 321 {
 322         return BaseObject::getApp();
 323 }
 324
 325 /**
 326  * @brief Used to end the current process, after saving session state.
 327  * @deprecated
 328  */
 329 function killme()
 330 {
 331         exit();
 332 }
 333
 334 /**
 335  * @brief Returns the user id of locally logged in user or false.
 336  *
 337  * @return int|bool user id or false
 338  */
 339 function local_user()
 340 {
 341         if (!empty($_SESSION['authenticated']) && !empty($_SESSION['uid'])) {
 342                 return intval($_SESSION['uid']);
 343         }
 344         return false;
 345 }
 346
 347 /**
 348  * @brief Returns the public contact id of logged in user or false.
 349  *
 350  * @return int|bool public contact id or false
 351  */
 352 function public_contact()
 353 {
 354         static $public_contact_id = false;
 355
 356         if (!$public_contact_id && !empty($_SESSION['authenticated'])) {
 357                 if (!empty($_SESSION['my_address'])) {
 358                         // Local user
 359                         $public_contact_id = intval(Contact::getIdForURL($_SESSION['my_address'], 0, true));
 360                 } elseif (!empty($_SESSION['visitor_home'])) {
 361                         // Remote user
 362                         $public_contact_id = intval(Contact::getIdForURL($_SESSION['visitor_home'], 0, true));
 363                 }
 364         } elseif (empty($_SESSION['authenticated'])) {
 365                 $public_contact_id = false;
 366         }
 367
 368         return $public_contact_id;
 369 }
 370
 371 /**
 372  * @brief Returns contact id of authenticated site visitor or false
 373  *
 374  * @return int|bool visitor_id or false
 375  */
 376 function remote_user()
 377 {
 378         if (empty($_SESSION['authenticated'])) {
 379                 return false;
 380         }
 381
 382         if (!empty($_SESSION['visitor_id'])) {
 383                 return intval($_SESSION['visitor_id']);
 384         }
 385
 386         return false;
 387 }
 388
 389 /**
 390  * @brief Show an error message to user.
 391  *
 392  * This function save text in session, to be shown to the user at next page load
 393  *
 394  * @param string $s - Text of notice
 395  */
 396 function notice($s)
 397 {
 398         if (empty($_SESSION)) {
 399                 return;
 400         }
 401
 402         $a = \get_app();
 403         if (empty($_SESSION['sysmsg'])) {
 404                 $_SESSION['sysmsg'] = [];
 405         }
 406         if ($a->interactive) {
 407                 $_SESSION['sysmsg'][] = $s;
 408         }
 409 }
 410
 411 /**
 412  * @brief Show an info message to user.
 413  *
 414  * This function save text in session, to be shown to the user at next page load
 415  *
 416  * @param string $s - Text of notice
 417  */
 418 function info($s)
 419 {
 420         $a = \get_app();
 421
 422         if (local_user() && PConfig::get(local_user(), 'system', 'ignore_info')) {
 423                 return;
 424         }
 425
 426         if (empty($_SESSION['sysmsg_info'])) {
 427                 $_SESSION['sysmsg_info'] = [];
 428         }
 429         if ($a->interactive) {
 430                 $_SESSION['sysmsg_info'][] = $s;
 431         }
 432 }
 433
 434 function feed_birthday($uid, $tz)
 435 {
 436         /**
 437          * Determine the next birthday, but only if the birthday is published
 438          * in the default profile. We _could_ also look for a private profile that the
 439          * recipient can see, but somebody could get mad at us if they start getting
 440          * public birthday greetings when they haven't made this info public.
 441          *
 442          * Assuming we are able to publish this info, we are then going to convert
 443          * the start time from the owner's timezone to UTC.
 444          *
 445          * This will potentially solve the problem found with some social networks
 446          * where birthdays are converted to the viewer's timezone and salutations from
 447          * elsewhere in the world show up on the wrong day. We will convert it to the
 448          * viewer's timezone also, but first we are going to convert it from the birthday
 449          * person's timezone to GMT - so the viewer may find the birthday starting at
 450          * 6:00PM the day before, but that will correspond to midnight to the birthday person.
 451          */
 452         $birthday = '';
 453
 454         if (!strlen($tz)) {
 455                 $tz = 'UTC';
 456         }
 457
 458         $profile = DBA::selectFirst('profile', ['dob'], ['is-default' => true, 'uid' => $uid]);
 459         if (DBA::isResult($profile)) {
 460                 $tmp_dob = substr($profile['dob'], 5);
 461                 if (intval($tmp_dob)) {
 462                         $y = DateTimeFormat::timezoneNow($tz, 'Y');
 463                         $bd = $y . '-' . $tmp_dob . ' 00:00';
 464                         $t_dob = strtotime($bd);
 465                         $now = strtotime(DateTimeFormat::timezoneNow($tz));
 466                         if ($t_dob < $now) {
 467                                 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
 468                         }
 469                         $birthday = DateTimeFormat::convert($bd, 'UTC', $tz, DateTimeFormat::ATOM);
 470                 }
 471         }
 472
 473         return $birthday;
 474 }
 475
 476 /**
 477  * @brief Check if current user has admin role.
 478  *
 479  * @return bool true if user is an admin
 480  */
 481 function is_site_admin()
 482 {
 483         $a = \get_app();
 484
 485         $admin_email = Config::get('config', 'admin_email');
 486
 487         $adminlist = explode(',', str_replace(' ', '', $admin_email));
 488
 489         return local_user() && $admin_email && in_array($a->user['email'] ?? '', $adminlist);
 490 }
 491
 492 function explode_querystring($query)
 493 {
 494         $arg_st = strpos($query, '?');
 495         if ($arg_st !== false) {
 496                 $base = substr($query, 0, $arg_st);
 497                 $arg_st += 1;
 498         } else {
 499                 $base = '';
 500                 $arg_st = 0;
 501         }
 502
 503         $args = explode('&', substr($query, $arg_st));
 504         foreach ($args as $k => $arg) {
 505                 /// @TODO really compare type-safe here?
 506                 if ($arg === '') {
 507                         unset($args[$k]);
 508                 }
 509         }
 510         $args = array_values($args);
 511
 512         if (!$base) {
 513                 $base = $args[0];
 514                 unset($args[0]);
 515                 $args = array_values($args);
 516         }
 517
 518         return [
 519                 'base' => $base,
 520                 'args' => $args,
 521         ];
 522 }
 523
 524 /**
 525  * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
 526  *
 527  * Taken from http://webcheatsheet.com/php/get_current_page_url.php
 528  */
 529 function curPageURL()
 530 {
 531         $pageURL = 'http';
 532         if (!empty($_SERVER["HTTPS"]) && ($_SERVER["HTTPS"] == "on")) {
 533                 $pageURL .= "s";
 534         }
 535
 536         $pageURL .= "://";
 537
 538         if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
 539                 $pageURL .= $_SERVER["SERVER_NAME"] . ":" . $_SERVER["SERVER_PORT"] . $_SERVER["REQUEST_URI"];
 540         } else {
 541                 $pageURL .= $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"];
 542         }
 543         return $pageURL;
 544 }
 545
 546 function get_server()
 547 {
 548         $server = Config::get("system", "directory");
 549
 550         if ($server == "") {
 551                 $server = "https://dir.friendica.social";
 552         }
 553
 554         return $server;
 555 }
 556
 557 function get_temppath()
 558 {
 559         $a = \get_app();
 560
 561         $temppath = Config::get("system", "temppath");
 562
 563         if (($temppath != "") && System::isDirectoryUsable($temppath)) {
 564                 // We have a temp path and it is usable
 565                 return BasePath::getRealPath($temppath);
 566         }
 567
 568         // We don't have a working preconfigured temp path, so we take the system path.
 569         $temppath = sys_get_temp_dir();
 570
 571         // Check if it is usable
 572         if (($temppath != "") && System::isDirectoryUsable($temppath)) {
 573                 // Always store the real path, not the path through symlinks
 574                 $temppath = BasePath::getRealPath($temppath);
 575
 576                 // To avoid any interferences with other systems we create our own directory
 577                 $new_temppath = $temppath . "/" . $a->getHostName();
 578                 if (!is_dir($new_temppath)) {
 579                         /// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
 580                         mkdir($new_temppath);
 581                 }
 582
 583                 if (System::isDirectoryUsable($new_temppath)) {
 584                         // The new path is usable, we are happy
 585                         Config::set("system", "temppath", $new_temppath);
 586                         return $new_temppath;
 587                 } else {
 588                         // We can't create a subdirectory, strange.
 589                         // But the directory seems to work, so we use it but don't store it.
 590                         return $temppath;
 591                 }
 592         }
 593
 594         // Reaching this point means that the operating system is configured badly.
 595         return '';
 596 }
 597
 598 function get_cachefile($file, $writemode = true)
 599 {
 600         $cache = get_itemcachepath();
 601
 602         if ((!$cache) || (!is_dir($cache))) {
 603                 return "";
 604         }
 605
 606         $subfolder = $cache . "/" . substr($file, 0, 2);
 607
 608         $cachepath = $subfolder . "/" . $file;
 609
 610         if ($writemode) {
 611                 if (!is_dir($subfolder)) {
 612                         mkdir($subfolder);
 613                         chmod($subfolder, 0777);
 614                 }
 615         }
 616
 617         return $cachepath;
 618 }
 619
 620 function clear_cache($basepath = "", $path = "")
 621 {
 622         if ($path == "") {
 623                 $basepath = get_itemcachepath();
 624                 $path = $basepath;
 625         }
 626
 627         if (($path == "") || (!is_dir($path))) {
 628                 return;
 629         }
 630
 631         if (substr(realpath($path), 0, strlen($basepath)) != $basepath) {
 632                 return;
 633         }
 634
 635         $cachetime = (int) Config::get('system', 'itemcache_duration');
 636         if ($cachetime == 0) {
 637                 $cachetime = 86400;
 638         }
 639
 640         if (is_writable($path)) {
 641                 if ($dh = opendir($path)) {
 642                         while (($file = readdir($dh)) !== false) {
 643                                 $fullpath = $path . "/" . $file;
 644                                 if ((filetype($fullpath) == "dir") && ($file != ".") && ($file != "..")) {
 645                                         clear_cache($basepath, $fullpath);
 646                                 }
 647                                 if ((filetype($fullpath) == "file") && (filectime($fullpath) < (time() - $cachetime))) {
 648                                         unlink($fullpath);
 649                                 }
 650                         }
 651                         closedir($dh);
 652                 }
 653         }
 654 }
 655
 656 function get_itemcachepath()
 657 {
 658         // Checking, if the cache is deactivated
 659         $cachetime = (int) Config::get('system', 'itemcache_duration');
 660         if ($cachetime < 0) {
 661                 return "";
 662         }
 663
 664         $itemcache = Config::get('system', 'itemcache');
 665         if (($itemcache != "") && System::isDirectoryUsable($itemcache)) {
 666                 return BasePath::getRealPath($itemcache);
 667         }
 668
 669         $temppath = get_temppath();
 670
 671         if ($temppath != "") {
 672                 $itemcache = $temppath . "/itemcache";
 673                 if (!file_exists($itemcache) && !is_dir($itemcache)) {
 674                         mkdir($itemcache);
 675                 }
 676
 677                 if (System::isDirectoryUsable($itemcache)) {
 678                         Config::set("system", "itemcache", $itemcache);
 679                         return $itemcache;
 680                 }
 681         }
 682         return "";
 683 }
 684
 685 /**
 686  * @brief Returns the path where spool files are stored
 687  *
 688  * @return string Spool path
 689  */
 690 function get_spoolpath()
 691 {
 692         $spoolpath = Config::get('system', 'spoolpath');
 693         if (($spoolpath != "") && System::isDirectoryUsable($spoolpath)) {
 694                 // We have a spool path and it is usable
 695                 return $spoolpath;
 696         }
 697
 698         // We don't have a working preconfigured spool path, so we take the temp path.
 699         $temppath = get_temppath();
 700
 701         if ($temppath != "") {
 702                 // To avoid any interferences with other systems we create our own directory
 703                 $spoolpath = $temppath . "/spool";
 704                 if (!is_dir($spoolpath)) {
 705                         mkdir($spoolpath);
 706                 }
 707
 708                 if (System::isDirectoryUsable($spoolpath)) {
 709                         // The new path is usable, we are happy
 710                         Config::set("system", "spoolpath", $spoolpath);
 711                         return $spoolpath;
 712                 } else {
 713                         // We can't create a subdirectory, strange.
 714                         // But the directory seems to work, so we use it but don't store it.
 715                         return $temppath;
 716                 }
 717         }
 718
 719         // Reaching this point means that the operating system is configured badly.
 720         return "";
 721 }
 722
 723 if (!function_exists('exif_imagetype')) {
 724         function exif_imagetype($file)
 725         {
 726                 $size = getimagesize($file);
 727                 return $size[2];
 728         }
 729 }
 730
 731 function validate_include(&$file)
 732 {
 733         $orig_file = $file;
 734
 735         $file = realpath($file);
 736
 737         if (strpos($file, getcwd()) !== 0) {
 738                 return false;
 739         }
 740
 741         $file = str_replace(getcwd() . "/", "", $file, $count);
 742         if ($count != 1) {
 743                 return false;
 744         }
 745
 746         if ($orig_file !== $file) {
 747                 return false;
 748         }
 749
 750         $valid = false;
 751         if (strpos($file, "include/") === 0) {
 752                 $valid = true;
 753         }
 754
 755         if (strpos($file, "addon/") === 0) {
 756                 $valid = true;
 757         }
 758
 759         // Simply return flag
 760         return $valid;
 761 }
 762
 763 /**
 764  * PHP 5 compatible dirname() with count parameter
 765  *
 766  * @see http://php.net/manual/en/function.dirname.php#113193
 767  *
 768  * @deprecated with PHP 7
 769  * @param string $path
 770  * @param int    $levels
 771  * @return string
 772  */
 773 function rdirname($path, $levels = 1)
 774 {
 775         if ($levels > 1) {
 776                 return dirname(rdirname($path, --$levels));
 777         } else {
 778                 return dirname($path);
 779         }
 780 }