boot.php

   1 <?php
   2 /** @file boot.php
   3  *
   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 require_once __DIR__ . DIRECTORY_SEPARATOR . 'vendor' . DIRECTORY_SEPARATOR . 'autoload.php';
  21
  22 use Friendica\App;
  23 use Friendica\Core\Addon;
  24 use Friendica\Core\Config;
  25 use Friendica\Core\L10n;
  26 use Friendica\Core\PConfig;
  27 use Friendica\Core\System;
  28 use Friendica\Core\Worker;
  29 use Friendica\Database\DBM;
  30 use Friendica\Database\DBStructure;
  31 use Friendica\Model\Contact;
  32 use Friendica\Util\DateTimeFormat;
  33
  34 require_once 'include/text.php';
  35
  36 define('FRIENDICA_PLATFORM',     'Friendica');
  37 define('FRIENDICA_CODENAME',     'Asparagus');
  38 define('FRIENDICA_VERSION',      '3.6-dev');
  39 define('DFRN_PROTOCOL_VERSION',  '2.23');
  40 define('DB_UPDATE_VERSION',      1249);
  41 define('NEW_UPDATE_ROUTINE_VERSION', 1170);
  42
  43 /**
  44  * @brief Constants for the database update check
  45  */
  46 const DB_UPDATE_NOT_CHECKED = 0; // Database check wasn't executed before
  47 const DB_UPDATE_SUCCESSFUL = 1;  // Database check was successful
  48 const DB_UPDATE_FAILED = 2;      // Database check failed
  49
  50 /**
  51  * @brief Constant with a HTML line break.
  52  *
  53  * Contains a HTML line break (br) element and a real carriage return with line
  54  * feed for the source.
  55  * This can be used in HTML and JavaScript where needed a line break.
  56  */
  57 define('EOL',                    "<br />\r\n");
  58
  59 /**
  60  * @brief Image storage quality.
  61  *
  62  * Lower numbers save space at cost of image detail.
  63  * For ease of upgrade, please do not change here. Change jpeg quality with
  64  * $a->config['system']['jpeg_quality'] = n;
  65  * in .htconfig.php, where n is netween 1 and 100, and with very poor results
  66  * below about 50
  67  */
  68 define('JPEG_QUALITY',            100);
  69
  70 /**
  71  * $a->config['system']['png_quality'] from 0 (uncompressed) to 9
  72  */
  73 define('PNG_QUALITY',             8);
  74
  75 /**
  76  * An alternate way of limiting picture upload sizes. Specify the maximum pixel
  77  * length that pictures are allowed to be (for non-square pictures, it will apply
  78  * to the longest side). Pictures longer than this length will be resized to be
  79  * this length (on the longest side, the other side will be scaled appropriately).
  80  * Modify this value using
  81  *
  82  *    $a->config['system']['max_image_length'] = n;
  83  *
  84  * in .htconfig.php
  85  *
  86  * If you don't want to set a maximum length, set to -1. The default value is
  87  * defined by 'MAX_IMAGE_LENGTH' below.
  88  */
  89 define('MAX_IMAGE_LENGTH',        -1);
  90
  91 /**
  92  * Not yet used
  93  */
  94 define('DEFAULT_DB_ENGINE',  'InnoDB');
  95
  96 /**
  97  * @name SSL Policy
  98  *
  99  * SSL redirection policies
 100  * @{
 101  */
 102 define('SSL_POLICY_NONE',         0);
 103 define('SSL_POLICY_FULL',         1);
 104 define('SSL_POLICY_SELFSIGN',     2);
 105 /* @}*/
 106
 107 /**
 108  * @name Logger
 109  *
 110  * log levels
 111  * @{
 112  */
 113 define('LOGGER_NORMAL',          0);
 114 define('LOGGER_TRACE',           1);
 115 define('LOGGER_DEBUG',           2);
 116 define('LOGGER_DATA',            3);
 117 define('LOGGER_ALL',             4);
 118 /* @}*/
 119
 120 /**
 121  * @name Cache
 122  *
 123  * Cache levels
 124  * @{
 125  */
 126 define('CACHE_MONTH',            0);
 127 define('CACHE_WEEK',             1);
 128 define('CACHE_DAY',              2);
 129 define('CACHE_HOUR',             3);
 130 define('CACHE_HALF_HOUR',        4);
 131 define('CACHE_QUARTER_HOUR',     5);
 132 define('CACHE_FIVE_MINUTES',     6);
 133 define('CACHE_MINUTE',           7);
 134 /* @}*/
 135
 136 /**
 137  * @name Register
 138  *
 139  * Registration policies
 140  * @{
 141  */
 142 define('REGISTER_CLOSED',        0);
 143 define('REGISTER_APPROVE',       1);
 144 define('REGISTER_OPEN',          2);
 145 /**
 146  * @}
 147 */
 148
 149 /**
 150  * @name Contact_is
 151  *
 152  * Relationship types
 153  * @{
 154  */
 155 define('CONTACT_IS_FOLLOWER', 1);
 156 define('CONTACT_IS_SHARING',  2);
 157 define('CONTACT_IS_FRIEND',   3);
 158 /**
 159  *  @}
 160  */
 161
 162 /**
 163  * @name Update
 164  *
 165  * DB update return values
 166  * @{
 167  */
 168 define('UPDATE_SUCCESS', 0);
 169 define('UPDATE_FAILED',  1);
 170 /**
 171  * @}
 172  */
 173
 174 /**
 175  * @name page/profile types
 176  *
 177  * PAGE_NORMAL is a typical personal profile account
 178  * PAGE_SOAPBOX automatically approves all friend requests as CONTACT_IS_SHARING, (readonly)
 179  * PAGE_COMMUNITY automatically approves all friend requests as CONTACT_IS_SHARING, but with
 180  *      write access to wall and comments (no email and not included in page owner's ACL lists)
 181  * PAGE_FREELOVE automatically approves all friend requests as full friends (CONTACT_IS_FRIEND).
 182  *
 183  * @{
 184  */
 185 define('PAGE_NORMAL',            0);
 186 define('PAGE_SOAPBOX',           1);
 187 define('PAGE_COMMUNITY',         2);
 188 define('PAGE_FREELOVE',          3);
 189 define('PAGE_BLOG',              4);
 190 define('PAGE_PRVGROUP',          5);
 191 /**
 192  * @}
 193  */
 194
 195 /**
 196  * @name account types
 197  *
 198  * ACCOUNT_TYPE_PERSON - the account belongs to a person
 199  *      Associated page types: PAGE_NORMAL, PAGE_SOAPBOX, PAGE_FREELOVE
 200  *
 201  * ACCOUNT_TYPE_ORGANISATION - the account belongs to an organisation
 202  *      Associated page type: PAGE_SOAPBOX
 203  *
 204  * ACCOUNT_TYPE_NEWS - the account is a news reflector
 205  *      Associated page type: PAGE_SOAPBOX
 206  *
 207  * ACCOUNT_TYPE_COMMUNITY - the account is community forum
 208  *      Associated page types: PAGE_COMMUNITY, PAGE_PRVGROUP
 209  * @{
 210  */
 211 define('ACCOUNT_TYPE_PERSON',      0);
 212 define('ACCOUNT_TYPE_ORGANISATION', 1);
 213 define('ACCOUNT_TYPE_NEWS',        2);
 214 define('ACCOUNT_TYPE_COMMUNITY',   3);
 215 /**
 216  * @}
 217  */
 218
 219 /**
 220  * @name CP
 221  *
 222  * Type of the community page
 223  * @{
 224  */
 225 define('CP_NO_COMMUNITY_PAGE',  -1);
 226 define('CP_USERS_ON_SERVER',     0);
 227 define('CP_GLOBAL_COMMUNITY',    1);
 228 define('CP_USERS_AND_GLOBAL',    2);
 229 /**
 230  * @}
 231  */
 232
 233 /**
 234  * @name Protocols
 235  *
 236  * Different protocols that we are storing
 237  * @{
 238  */
 239 define('PROTOCOL_UNKNOWN',         0);
 240 define('PROTOCOL_DFRN',            1);
 241 define('PROTOCOL_DIASPORA',        2);
 242 define('PROTOCOL_OSTATUS_SALMON',  3);
 243 define('PROTOCOL_OSTATUS_FEED',    4); // Deprecated
 244 define('PROTOCOL_GS_CONVERSATION', 5); // Deprecated
 245 define('PROTOCOL_SPLITTED_CONV',   6);
 246 /**
 247  * @}
 248  */
 249
 250 /**
 251  * @name Network
 252  *
 253  * Network and protocol family types
 254  * @{
 255  */
 256 define('NETWORK_DFRN',             'dfrn');    // Friendica, Mistpark, other DFRN implementations
 257 define('NETWORK_ZOT',              'zot!');    // Zot! - Currently unsupported
 258 define('NETWORK_OSTATUS',          'stat');    // GNU-social, Pleroma, Mastodon, other OStatus implementations
 259 define('NETWORK_FEED',             'feed');    // RSS/Atom feeds with no known "post/notify" protocol
 260 define('NETWORK_DIASPORA',         'dspr');    // Diaspora
 261 define('NETWORK_MAIL',             'mail');    // IMAP/POP
 262 define('NETWORK_FACEBOOK',         'face');    // Facebook API
 263 define('NETWORK_LINKEDIN',         'lnkd');    // LinkedIn
 264 define('NETWORK_XMPP',             'xmpp');    // XMPP - Currently unsupported
 265 define('NETWORK_MYSPACE',          'mysp');    // MySpace - Currently unsupported
 266 define('NETWORK_GPLUS',            'goog');    // Google+
 267 define('NETWORK_PUMPIO',           'pump');    // pump.io
 268 define('NETWORK_TWITTER',          'twit');    // Twitter
 269 define('NETWORK_DIASPORA2',        'dspc');    // Diaspora connector
 270 define('NETWORK_STATUSNET',        'stac');    // Statusnet connector
 271 define('NETWORK_APPNET',           'apdn');    // app.net - Dead protocol
 272 define('NETWORK_NEWS',             'nntp');    // Network News Transfer Protocol - Currently unsupported
 273 define('NETWORK_ICALENDAR',        'ical');    // iCalendar - Currently unsupported
 274 define('NETWORK_PNUT',             'pnut');    // pnut.io - Currently unsupported
 275 define('NETWORK_PHANTOM',          'unkn');    // Place holder
 276 /**
 277  * @}
 278  */
 279
 280 /**
 281  * These numbers are used in stored permissions
 282  * and existing allocations MUST NEVER BE CHANGED
 283  * OR RE-ASSIGNED! You may only add to them.
 284  */
 285 $netgroup_ids = [
 286         NETWORK_DFRN     => (-1),
 287         NETWORK_ZOT      => (-2),
 288         NETWORK_OSTATUS  => (-3),
 289         NETWORK_FEED     => (-4),
 290         NETWORK_DIASPORA => (-5),
 291         NETWORK_MAIL     => (-6),
 292         NETWORK_FACEBOOK => (-8),
 293         NETWORK_LINKEDIN => (-9),
 294         NETWORK_XMPP     => (-10),
 295         NETWORK_MYSPACE  => (-11),
 296         NETWORK_GPLUS    => (-12),
 297         NETWORK_PUMPIO   => (-13),
 298         NETWORK_TWITTER  => (-14),
 299         NETWORK_DIASPORA2 => (-15),
 300         NETWORK_STATUSNET => (-16),
 301         NETWORK_APPNET    => (-17),
 302         NETWORK_NEWS      => (-18),
 303         NETWORK_ICALENDAR => (-19),
 304         NETWORK_PNUT      => (-20),
 305
 306         NETWORK_PHANTOM  => (-127),
 307 ];
 308
 309 /**
 310  * Maximum number of "people who like (or don't like) this"  that we will list by name
 311  */
 312 define('MAX_LIKERS',    75);
 313
 314 /**
 315  * Communication timeout
 316  */
 317 define('ZCURL_TIMEOUT', (-1));
 318
 319 /**
 320  * @name Notify
 321  *
 322  * Email notification options
 323  * @{
 324  */
 325 define('NOTIFY_INTRO',    0x0001);
 326 define('NOTIFY_CONFIRM',  0x0002);
 327 define('NOTIFY_WALL',     0x0004);
 328 define('NOTIFY_COMMENT',  0x0008);
 329 define('NOTIFY_MAIL',     0x0010);
 330 define('NOTIFY_SUGGEST',  0x0020);
 331 define('NOTIFY_PROFILE',  0x0040);
 332 define('NOTIFY_TAGSELF',  0x0080);
 333 define('NOTIFY_TAGSHARE', 0x0100);
 334 define('NOTIFY_POKE',     0x0200);
 335 define('NOTIFY_SHARE',    0x0400);
 336
 337 define('SYSTEM_EMAIL',    0x4000);
 338
 339 define('NOTIFY_SYSTEM',   0x8000);
 340 /* @}*/
 341
 342
 343 /**
 344  * @name Term
 345  *
 346  * Tag/term types
 347  * @{
 348  */
 349 define('TERM_UNKNOWN',   0);
 350 define('TERM_HASHTAG',   1);
 351 define('TERM_MENTION',   2);
 352 define('TERM_CATEGORY',  3);
 353 define('TERM_PCATEGORY', 4);
 354 define('TERM_FILE',      5);
 355 define('TERM_SAVEDSEARCH', 6);
 356 define('TERM_CONVERSATION', 7);
 357
 358 define('TERM_OBJ_POST',  1);
 359 define('TERM_OBJ_PHOTO', 2);
 360
 361 /**
 362  * @name Namespaces
 363  *
 364  * Various namespaces we may need to parse
 365  * @{
 366  */
 367 define('NAMESPACE_ZOT',             'http://purl.org/zot');
 368 define('NAMESPACE_DFRN',            'http://purl.org/macgirvin/dfrn/1.0');
 369 define('NAMESPACE_THREAD',          'http://purl.org/syndication/thread/1.0');
 370 define('NAMESPACE_TOMB',            'http://purl.org/atompub/tombstones/1.0');
 371 define('NAMESPACE_ACTIVITY',        'http://activitystrea.ms/spec/1.0/');
 372 define('NAMESPACE_ACTIVITY_SCHEMA', 'http://activitystrea.ms/schema/1.0/');
 373 define('NAMESPACE_MEDIA',           'http://purl.org/syndication/atommedia');
 374 define('NAMESPACE_SALMON_ME',       'http://salmon-protocol.org/ns/magic-env');
 375 define('NAMESPACE_OSTATUSSUB',      'http://ostatus.org/schema/1.0/subscribe');
 376 define('NAMESPACE_GEORSS',          'http://www.georss.org/georss');
 377 define('NAMESPACE_POCO',            'http://portablecontacts.net/spec/1.0');
 378 define('NAMESPACE_FEED',            'http://schemas.google.com/g/2010#updates-from');
 379 define('NAMESPACE_OSTATUS',         'http://ostatus.org/schema/1.0');
 380 define('NAMESPACE_STATUSNET',       'http://status.net/schema/api/1/');
 381 define('NAMESPACE_ATOM1',           'http://www.w3.org/2005/Atom');
 382 define('NAMESPACE_MASTODON',        'http://mastodon.social/schema/1.0');
 383 /* @}*/
 384
 385 /**
 386  * @name Activity
 387  *
 388  * Activity stream defines
 389  * @{
 390  */
 391 define('ACTIVITY_LIKE',        NAMESPACE_ACTIVITY_SCHEMA . 'like');
 392 define('ACTIVITY_DISLIKE',     NAMESPACE_DFRN            . '/dislike');
 393 define('ACTIVITY_ATTEND',      NAMESPACE_ZOT             . '/activity/attendyes');
 394 define('ACTIVITY_ATTENDNO',    NAMESPACE_ZOT             . '/activity/attendno');
 395 define('ACTIVITY_ATTENDMAYBE', NAMESPACE_ZOT             . '/activity/attendmaybe');
 396
 397 define('ACTIVITY_OBJ_HEART',   NAMESPACE_DFRN            . '/heart');
 398
 399 define('ACTIVITY_FRIEND',      NAMESPACE_ACTIVITY_SCHEMA . 'make-friend');
 400 define('ACTIVITY_REQ_FRIEND',  NAMESPACE_ACTIVITY_SCHEMA . 'request-friend');
 401 define('ACTIVITY_UNFRIEND',    NAMESPACE_ACTIVITY_SCHEMA . 'remove-friend');
 402 define('ACTIVITY_FOLLOW',      NAMESPACE_ACTIVITY_SCHEMA . 'follow');
 403 define('ACTIVITY_UNFOLLOW',    NAMESPACE_ACTIVITY_SCHEMA . 'stop-following');
 404 define('ACTIVITY_JOIN',        NAMESPACE_ACTIVITY_SCHEMA . 'join');
 405
 406 define('ACTIVITY_POST',        NAMESPACE_ACTIVITY_SCHEMA . 'post');
 407 define('ACTIVITY_UPDATE',      NAMESPACE_ACTIVITY_SCHEMA . 'update');
 408 define('ACTIVITY_TAG',         NAMESPACE_ACTIVITY_SCHEMA . 'tag');
 409 define('ACTIVITY_FAVORITE',    NAMESPACE_ACTIVITY_SCHEMA . 'favorite');
 410 define('ACTIVITY_UNFAVORITE',  NAMESPACE_ACTIVITY_SCHEMA . 'unfavorite');
 411 define('ACTIVITY_SHARE',       NAMESPACE_ACTIVITY_SCHEMA . 'share');
 412 define('ACTIVITY_DELETE',      NAMESPACE_ACTIVITY_SCHEMA . 'delete');
 413
 414 define('ACTIVITY_POKE',        NAMESPACE_ZOT . '/activity/poke');
 415
 416 define('ACTIVITY_OBJ_BOOKMARK', NAMESPACE_ACTIVITY_SCHEMA . 'bookmark');
 417 define('ACTIVITY_OBJ_COMMENT', NAMESPACE_ACTIVITY_SCHEMA . 'comment');
 418 define('ACTIVITY_OBJ_NOTE',    NAMESPACE_ACTIVITY_SCHEMA . 'note');
 419 define('ACTIVITY_OBJ_PERSON',  NAMESPACE_ACTIVITY_SCHEMA . 'person');
 420 define('ACTIVITY_OBJ_IMAGE',   NAMESPACE_ACTIVITY_SCHEMA . 'image');
 421 define('ACTIVITY_OBJ_PHOTO',   NAMESPACE_ACTIVITY_SCHEMA . 'photo');
 422 define('ACTIVITY_OBJ_VIDEO',   NAMESPACE_ACTIVITY_SCHEMA . 'video');
 423 define('ACTIVITY_OBJ_P_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'profile-photo');
 424 define('ACTIVITY_OBJ_ALBUM',   NAMESPACE_ACTIVITY_SCHEMA . 'photo-album');
 425 define('ACTIVITY_OBJ_EVENT',   NAMESPACE_ACTIVITY_SCHEMA . 'event');
 426 define('ACTIVITY_OBJ_GROUP',   NAMESPACE_ACTIVITY_SCHEMA . 'group');
 427 define('ACTIVITY_OBJ_TAGTERM', NAMESPACE_DFRN            . '/tagterm');
 428 define('ACTIVITY_OBJ_PROFILE', NAMESPACE_DFRN            . '/profile');
 429 define('ACTIVITY_OBJ_QUESTION', 'http://activityschema.org/object/question');
 430 /* @}*/
 431
 432 /**
 433  * @name Gravity
 434  *
 435  * Item weight for query ordering
 436  * @{
 437  */
 438 define('GRAVITY_PARENT',       0);
 439 define('GRAVITY_LIKE',         3);
 440 define('GRAVITY_COMMENT',      6);
 441 /* @}*/
 442
 443 /**
 444  * @name Priority
 445  *
 446  * Process priority for the worker
 447  * @{
 448  */
 449 define('PRIORITY_UNDEFINED',   0);
 450 define('PRIORITY_CRITICAL',   10);
 451 define('PRIORITY_HIGH',       20);
 452 define('PRIORITY_MEDIUM',     30);
 453 define('PRIORITY_LOW',        40);
 454 define('PRIORITY_NEGLIGIBLE', 50);
 455 /* @}*/
 456
 457 /**
 458  * @name Social Relay settings
 459  *
 460  * See here: https://github.com/jaywink/social-relay
 461  * and here: https://wiki.diasporafoundation.org/Relay_servers_for_public_posts
 462  * @{
 463  */
 464 define('SR_SCOPE_NONE', '');
 465 define('SR_SCOPE_ALL',  'all');
 466 define('SR_SCOPE_TAGS', 'tags');
 467 /* @}*/
 468
 469 /**
 470  * Lowest possible date time value
 471  */
 472 define('NULL_DATE', '0001-01-01 00:00:00');
 473
 474 // Normally this constant is defined - but not if "pcntl" isn't installed
 475 if (!defined("SIGTERM")) {
 476         define("SIGTERM", 15);
 477 }
 478
 479 /**
 480  * Depending on the PHP version this constant does exist - or not.
 481  * See here: http://php.net/manual/en/curl.constants.php#117928
 482  */
 483 if (!defined('CURLE_OPERATION_TIMEDOUT')) {
 484         define('CURLE_OPERATION_TIMEDOUT', CURLE_OPERATION_TIMEOUTED);
 485 }
 486 /**
 487  * Reverse the effect of magic_quotes_gpc if it is enabled.
 488  * Please disable magic_quotes_gpc so we don't have to do this.
 489  * See http://php.net/manual/en/security.magicquotes.disabling.php
 490  */
 491 function startup()
 492 {
 493         error_reporting(E_ERROR | E_WARNING | E_PARSE);
 494
 495         set_time_limit(0);
 496
 497         // This has to be quite large to deal with embedded private photos
 498         ini_set('pcre.backtrack_limit', 500000);
 499
 500         if (get_magic_quotes_gpc()) {
 501                 $process = [&$_GET, &$_POST, &$_COOKIE, &$_REQUEST];
 502                 while (list($key, $val) = each($process)) {
 503                         foreach ($val as $k => $v) {
 504                                 unset($process[$key][$k]);
 505                                 if (is_array($v)) {
 506                                         $process[$key][stripslashes($k)] = $v;
 507                                         $process[] = &$process[$key][stripslashes($k)];
 508                                 } else {
 509                                         $process[$key][stripslashes($k)] = stripslashes($v);
 510                                 }
 511                         }
 512                 }
 513                 unset($process);
 514         }
 515 }
 516
 517 /**
 518  * @brief Retrieve the App structure
 519  *
 520  * Useful in functions which require it but don't get it passed to them
 521  *
 522  * @return App
 523  */
 524 function get_app()
 525 {
 526         global $a;
 527
 528         if (empty($a)) {
 529                 $a = new App(dirname(__DIR__));
 530         }
 531
 532         return $a;
 533 }
 534
 535 /**
 536  * @brief Multi-purpose function to check variable state.
 537  *
 538  * Usage: x($var) or $x($array, 'key')
 539  *
 540  * returns false if variable/key is not set
 541  * if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0.
 542  * e.g. x('') or x(0) returns 0;
 543  *
 544  * @param string|array $s variable to check
 545  * @param string       $k key inside the array to check
 546  *
 547  * @return bool|int
 548  */
 549 function x($s, $k = null)
 550 {
 551         if ($k != null) {
 552                 if ((is_array($s)) && (array_key_exists($k, $s))) {
 553                         if ($s[$k]) {
 554                                 return (int) 1;
 555                         }
 556                         return (int) 0;
 557                 }
 558                 return false;
 559         } else {
 560                 if (isset($s)) {
 561                         if ($s) {
 562                                 return (int) 1;
 563                         }
 564                         return (int) 0;
 565                 }
 566                 return false;
 567         }
 568 }
 569
 570 /**
 571  * Return the provided variable value if it exists and is truthy or the provided
 572  * default value instead.
 573  *
 574  * Works with initialized variables and potentially uninitialized array keys
 575  *
 576  * Usages:
 577  * - defaults($var, $default)
 578  * - defaults($array, 'key', $default)
 579  *
 580  * @brief Returns a defaut value if the provided variable or array key is falsy
 581  * @see x()
 582  * @return mixed
 583  */
 584 function defaults() {
 585         $args = func_get_args();
 586
 587         if (count($args) < 2) {
 588                 throw new BadFunctionCallException('defaults() requires at least 2 parameters');
 589         }
 590         if (count($args) > 3) {
 591                 throw new BadFunctionCallException('defaults() cannot use more than 3 parameters');
 592         }
 593         if (count($args) === 3 && is_null($args[1])) {
 594                 throw new BadFunctionCallException('defaults($arr, $key, $def) $key is null');
 595         }
 596
 597         $default = array_pop($args);
 598
 599         if (call_user_func_array('x', $args)) {
 600                 if (count($args) === 1) {
 601                         $return = $args[0];
 602                 } else {
 603                         $return = $args[0][$args[1]];
 604                 }
 605         } else {
 606                 $return = $default;
 607         }
 608
 609         return $return;
 610 }
 611
 612 /**
 613  * @brief Returns the baseurl.
 614  *
 615  * @see System::baseUrl()
 616  *
 617  * @return string
 618  * @TODO Function is deprecated and only used in some addons
 619  */
 620 function z_root()
 621 {
 622         return System::baseUrl();
 623 }
 624
 625 /**
 626  * @brief Return absolut URL for given $path.
 627  *
 628  * @param string $path given path
 629  *
 630  * @return string
 631  */
 632 function absurl($path)
 633 {
 634         if (strpos($path, '/') === 0) {
 635                 return z_path() . $path;
 636         }
 637         return $path;
 638 }
 639
 640 /**
 641  * @brief Function to check if request was an AJAX (xmlhttprequest) request.
 642  *
 643  * @return boolean
 644  */
 645 function is_ajax()
 646 {
 647         return (!empty($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest');
 648 }
 649
 650 /**
 651  * @brief Function to check if request was an AJAX (xmlhttprequest) request.
 652  *
 653  * @param boolean $via_worker boolean Is the check run via the worker?
 654  */
 655 function check_db($via_worker)
 656 {
 657         $build = Config::get('system', 'build');
 658
 659         if (empty($build)) {
 660                 Config::set('system', 'build', DB_UPDATE_VERSION - 1);
 661                 $build = DB_UPDATE_VERSION;
 662         }
 663
 664         // We don't support upgrading from very old versions anymore
 665         if ($build < NEW_UPDATE_ROUTINE_VERSION) {
 666                 die('You try to update from a version prior to database version 1170. The direct upgrade path is not supported. Please update to version 3.5.4 before updating to this version.');
 667         }
 668
 669         if ($build != DB_UPDATE_VERSION) {
 670                 // When we cannot execute the database update via the worker, we will do it directly
 671                 if (!Worker::add(PRIORITY_CRITICAL, 'DBUpdate') && $via_worker) {
 672                         update_db();
 673                 }
 674         }
 675 }
 676
 677 /**
 678  * Sets the base url for use in cmdline programs which don't have
 679  * $_SERVER variables
 680  *
 681  * @param object $a App
 682  */
 683 function check_url(App $a)
 684 {
 685         $url = Config::get('system', 'url');
 686
 687         // if the url isn't set or the stored url is radically different
 688         // than the currently visited url, store the current value accordingly.
 689         // "Radically different" ignores common variations such as http vs https
 690         // and www.example.com vs example.com.
 691         // We will only change the url to an ip address if there is no existing setting
 692
 693         if (empty($url) || (!link_compare($url, System::baseUrl())) && (!preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/", $a->get_hostname))) {
 694                 Config::set('system', 'url', System::baseUrl());
 695         }
 696
 697         return;
 698 }
 699
 700 /**
 701  * @brief Automatic database updates
 702  * @param object $a App
 703  */
 704 function update_db()
 705 {
 706         $build = Config::get('system', 'build');
 707
 708         if (empty($build) || ($build > DB_UPDATE_VERSION)) {
 709                 $build = DB_UPDATE_VERSION - 1;
 710                 Config::set('system', 'build', $build);
 711         }
 712
 713         if ($build != DB_UPDATE_VERSION) {
 714                 require_once 'update.php';
 715
 716                 $stored = intval($build);
 717                 $current = intval(DB_UPDATE_VERSION);
 718                 if ($stored < $current) {
 719                         Config::load('database');
 720
 721                         // Compare the current structure with the defined structure
 722                         $t = Config::get('database', 'dbupdate_' . DB_UPDATE_VERSION);
 723                         if (!is_null($t)) {
 724                                 return;
 725                         }
 726
 727                         Config::set('database', 'dbupdate_' . DB_UPDATE_VERSION, time());
 728
 729                         // run update routine
 730                         // it update the structure in one call
 731                         $retval = DBStructure::update(false, true);
 732                         if ($retval) {
 733                                 DBStructure::updateFail(
 734                                         DB_UPDATE_VERSION,
 735                                         $retval
 736                                 );
 737                                 return;
 738                         } else {
 739                                 Config::set('database', 'dbupdate_' . DB_UPDATE_VERSION, 'success');
 740                         }
 741
 742                         // run any left update_nnnn functions in update.php
 743                         for ($x = $stored + 1; $x <= $current; $x++) {
 744                                 $r = run_update_function($x);
 745                                 if (!$r) {
 746                                         break;
 747                                 }
 748                         }
 749                 }
 750         }
 751
 752         return;
 753 }
 754
 755 function run_update_function($x)
 756 {
 757         if (function_exists('update_' . $x)) {
 758                 // There could be a lot of processes running or about to run.
 759                 // We want exactly one process to run the update command.
 760                 // So store the fact that we're taking responsibility
 761                 // after first checking to see if somebody else already has.
 762                 // If the update fails or times-out completely you may need to
 763                 // delete the config entry to try again.
 764
 765                 $t = Config::get('database', 'update_' . $x);
 766                 if (!is_null($t)) {
 767                         return false;
 768                 }
 769                 Config::set('database', 'update_' . $x, time());
 770
 771                 // call the specific update
 772
 773                 $func = 'update_' . $x;
 774                 $retval = $func();
 775
 776                 if ($retval) {
 777                         //send the administrator an e-mail
 778                         DBStructure::updateFail(
 779                                 $x,
 780                                 L10n::t('Update %s failed. See error logs.', $x)
 781                         );
 782                         return false;
 783                 } else {
 784                         Config::set('database', 'update_' . $x, 'success');
 785                         Config::set('system', 'build', $x);
 786                         return true;
 787                 }
 788         } else {
 789                 Config::set('database', 'update_' . $x, 'success');
 790                 Config::set('system', 'build', $x);
 791                 return true;
 792         }
 793 }
 794
 795 /**
 796  * @brief Synchronise addons:
 797  *
 798  * $a->config['system']['addon'] contains a comma-separated list of names
 799  * of addons which are used on this system.
 800  * Go through the database list of already installed addons, and if we have
 801  * an entry, but it isn't in the config list, call the uninstall procedure
 802  * and mark it uninstalled in the database (for now we'll remove it).
 803  * Then go through the config list and if we have a addon that isn't installed,
 804  * call the install procedure and add it to the database.
 805  *
 806  * @param object $a App
 807  */
 808 function check_addons(App $a)
 809 {
 810         $r = q("SELECT * FROM `addon` WHERE `installed` = 1");
 811         if (DBM::is_result($r)) {
 812                 $installed = $r;
 813         } else {
 814                 $installed = [];
 815         }
 816
 817         $addons = Config::get('system', 'addon');
 818         $addons_arr = [];
 819
 820         if ($addons) {
 821                 $addons_arr = explode(',', str_replace(' ', '', $addons));
 822         }
 823
 824         $a->addons = $addons_arr;
 825
 826         $installed_arr = [];
 827
 828         if (count($installed)) {
 829                 foreach ($installed as $i) {
 830                         if (!in_array($i['name'], $addons_arr)) {
 831                                 Addon::uninstall($i['name']);
 832                         } else {
 833                                 $installed_arr[] = $i['name'];
 834                         }
 835                 }
 836         }
 837
 838         if (count($addons_arr)) {
 839                 foreach ($addons_arr as $p) {
 840                         if (!in_array($p, $installed_arr)) {
 841                                 Addon::install($p);
 842                         }
 843                 }
 844         }
 845
 846         Addon::loadHooks();
 847
 848         return;
 849 }
 850
 851 function get_guid($size = 16, $prefix = "")
 852 {
 853         if ($prefix == "") {
 854                 $a = get_app();
 855                 $prefix = hash("crc32", $a->get_hostname());
 856         }
 857
 858         while (strlen($prefix) < ($size - 13)) {
 859                 $prefix .= mt_rand();
 860         }
 861
 862         if ($size >= 24) {
 863                 $prefix = substr($prefix, 0, $size - 22);
 864                 return(str_replace(".", "", uniqid($prefix, true)));
 865         } else {
 866                 $prefix = substr($prefix, 0, max($size - 13, 0));
 867                 return(uniqid($prefix));
 868         }
 869 }
 870
 871 /**
 872  * @brief Used to end the current process, after saving session state.
 873  * @deprecated
 874  */
 875 function killme()
 876 {
 877         exit();
 878 }
 879
 880 /**
 881  * @brief Redirect to another URL and terminate this process.
 882  */
 883 function goaway($path)
 884 {
 885         if (strstr(normalise_link($path), 'http://')) {
 886                 $url = $path;
 887         } else {
 888                 $url = System::baseUrl() . '/' . ltrim($path, '/');
 889         }
 890
 891         header("Location: $url");
 892         killme();
 893 }
 894
 895 /**
 896  * @brief Returns the user id of locally logged in user or false.
 897  *
 898  * @return int|bool user id or false
 899  */
 900 function local_user()
 901 {
 902         if (x($_SESSION, 'authenticated') && x($_SESSION, 'uid')) {
 903                 return intval($_SESSION['uid']);
 904         }
 905         return false;
 906 }
 907
 908 /**
 909  * @brief Returns the public contact id of logged in user or false.
 910  *
 911  * @return int|bool public contact id or false
 912  */
 913 function public_contact()
 914 {
 915         static $public_contact_id = false;
 916
 917         if (!$public_contact_id && x($_SESSION, 'authenticated')) {
 918                 if (x($_SESSION, 'my_address')) {
 919                         // Local user
 920                         $public_contact_id = intval(Contact::getIdForURL($_SESSION['my_address'], 0));
 921                 } elseif (x($_SESSION, 'visitor_home')) {
 922                         // Remote user
 923                         $public_contact_id = intval(Contact::getIdForURL($_SESSION['visitor_home'], 0));
 924                 }
 925         } elseif (!x($_SESSION, 'authenticated')) {
 926                 $public_contact_id = false;
 927         }
 928
 929         return $public_contact_id;
 930 }
 931
 932 /**
 933  * @brief Returns contact id of authenticated site visitor or false
 934  *
 935  * @return int|bool visitor_id or false
 936  */
 937 function remote_user()
 938 {
 939         // You cannot be both local and remote
 940         if (local_user()) {
 941                 return false;
 942         }
 943         if (x($_SESSION, 'authenticated') && x($_SESSION, 'visitor_id')) {
 944                 return intval($_SESSION['visitor_id']);
 945         }
 946         return false;
 947 }
 948
 949 /**
 950  * @brief Show an error message to user.
 951  *
 952  * This function save text in session, to be shown to the user at next page load
 953  *
 954  * @param string $s - Text of notice
 955  */
 956 function notice($s)
 957 {
 958         $a = get_app();
 959         if (!x($_SESSION, 'sysmsg')) {
 960                 $_SESSION['sysmsg'] = [];
 961         }
 962         if ($a->interactive) {
 963                 $_SESSION['sysmsg'][] = $s;
 964         }
 965 }
 966
 967 /**
 968  * @brief Show an info message to user.
 969  *
 970  * This function save text in session, to be shown to the user at next page load
 971  *
 972  * @param string $s - Text of notice
 973  */
 974 function info($s)
 975 {
 976         $a = get_app();
 977
 978         if (local_user() && PConfig::get(local_user(), 'system', 'ignore_info')) {
 979                 return;
 980         }
 981
 982         if (!x($_SESSION, 'sysmsg_info')) {
 983                 $_SESSION['sysmsg_info'] = [];
 984         }
 985         if ($a->interactive) {
 986                 $_SESSION['sysmsg_info'][] = $s;
 987         }
 988 }
 989
 990 /**
 991  * @brief Wrapper around config to limit the text length of an incoming message
 992  *
 993  * @return int
 994  */
 995 function get_max_import_size()
 996 {
 997         $a = get_app();
 998         return (x($a->config, 'max_import_size') ? $a->config['max_import_size'] : 0);
 999 }
1000
1001
1002 function current_theme()
1003 {
1004         $app_base_themes = ['duepuntozero', 'dispy', 'quattro'];
1005
1006         $a = get_app();
1007
1008         $page_theme = null;
1009
1010         // Find the theme that belongs to the user whose stuff we are looking at
1011
1012         if ($a->profile_uid && ($a->profile_uid != local_user())) {
1013                 $r = q(
1014                         "select theme from user where uid = %d limit 1",
1015                         intval($a->profile_uid)
1016                 );
1017                 if (DBM::is_result($r)) {
1018                         $page_theme = $r[0]['theme'];
1019                 }
1020         }
1021
1022         // Allow folks to over-rule user themes and always use their own on their own site.
1023         // This works only if the user is on the same server
1024
1025         if ($page_theme && local_user() && (local_user() != $a->profile_uid)) {
1026                 if (PConfig::get(local_user(), 'system', 'always_my_theme')) {
1027                         $page_theme = null;
1028                 }
1029         }
1030
1031 //              $mobile_detect = new Mobile_Detect();
1032 //              $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
1033         $is_mobile = $a->is_mobile || $a->is_tablet;
1034
1035         $standard_system_theme = Config::get('system', 'theme', '');
1036         $standard_theme_name = ((isset($_SESSION) && x($_SESSION, 'theme')) ? $_SESSION['theme'] : $standard_system_theme);
1037
1038         if ($is_mobile) {
1039                 if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
1040                         $theme_name = $standard_theme_name;
1041                 } else {
1042                         $system_theme = Config::get('system', 'mobile-theme', '');
1043                         if ($system_theme == '') {
1044                                 $system_theme = $standard_system_theme;
1045                         }
1046                         $theme_name = ((isset($_SESSION) && x($_SESSION, 'mobile-theme')) ? $_SESSION['mobile-theme'] : $system_theme);
1047
1048                         if ($theme_name === '---') {
1049                                 // user has selected to have the mobile theme be the same as the normal one
1050                                 $theme_name = $standard_theme_name;
1051
1052                                 if ($page_theme) {
1053                                         $theme_name = $page_theme;
1054                                 }
1055                         }
1056                 }
1057         } else {
1058                 $theme_name = $standard_theme_name;
1059
1060                 if ($page_theme) {
1061                         $theme_name = $page_theme;
1062                 }
1063         }
1064
1065         if ($theme_name
1066                 && (file_exists('view/theme/' . $theme_name . '/style.css')
1067                 || file_exists('view/theme/' . $theme_name . '/style.php'))
1068         ) {
1069                 return($theme_name);
1070         }
1071
1072         foreach ($app_base_themes as $t) {
1073                 if (file_exists('view/theme/' . $t . '/style.css')
1074                         || file_exists('view/theme/' . $t . '/style.php')
1075                 ) {
1076                         return($t);
1077                 }
1078         }
1079
1080         $fallback = array_merge(glob('view/theme/*/style.css'), glob('view/theme/*/style.php'));
1081         if (count($fallback)) {
1082                 return (str_replace('view/theme/', '', substr($fallback[0], 0, -10)));
1083         }
1084
1085         /// @TODO No final return statement?
1086 }
1087
1088 /**
1089  * @brief Return full URL to theme which is currently in effect.
1090  *
1091  * Provide a sane default if nothing is chosen or the specified theme does not exist.
1092  *
1093  * @return string
1094  */
1095 function current_theme_url()
1096 {
1097         $a = get_app();
1098
1099         $t = current_theme();
1100
1101         $opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : '');
1102         if (file_exists('view/theme/' . $t . '/style.php')) {
1103                 return('view/theme/' . $t . '/style.pcss' . $opts);
1104         }
1105
1106         return('view/theme/' . $t . '/style.css');
1107 }
1108
1109 function feed_birthday($uid, $tz)
1110 {
1111         /**
1112          * Determine the next birthday, but only if the birthday is published
1113          * in the default profile. We _could_ also look for a private profile that the
1114          * recipient can see, but somebody could get mad at us if they start getting
1115          * public birthday greetings when they haven't made this info public.
1116          *
1117          * Assuming we are able to publish this info, we are then going to convert
1118          * the start time from the owner's timezone to UTC.
1119          *
1120          * This will potentially solve the problem found with some social networks
1121          * where birthdays are converted to the viewer's timezone and salutations from
1122          * elsewhere in the world show up on the wrong day. We will convert it to the
1123          * viewer's timezone also, but first we are going to convert it from the birthday
1124          * person's timezone to GMT - so the viewer may find the birthday starting at
1125          * 6:00PM the day before, but that will correspond to midnight to the birthday person.
1126          */
1127         $birthday = '';
1128
1129         if (!strlen($tz)) {
1130                 $tz = 'UTC';
1131         }
1132
1133         $p = q(
1134                 "SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1",
1135                 intval($uid)
1136         );
1137
1138         if (DBM::is_result($p)) {
1139                 $tmp_dob = substr($p[0]['dob'], 5);
1140                 if (intval($tmp_dob)) {
1141                         $y = DateTimeFormat::timezoneNow($tz, 'Y');
1142                         $bd = $y . '-' . $tmp_dob . ' 00:00';
1143                         $t_dob = strtotime($bd);
1144                         $now = strtotime(DateTimeFormat::timezoneNow($tz));
1145                         if ($t_dob < $now) {
1146                                 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
1147                         }
1148                         $birthday = DateTimeFormat::convert($bd, 'UTC', $tz, DateTimeFormat::ATOM);
1149                 }
1150         }
1151
1152         return $birthday;
1153 }
1154
1155 /**
1156  * @brief Check if current user has admin role.
1157  *
1158  * @return bool true if user is an admin
1159  */
1160 function is_site_admin()
1161 {
1162         $a = get_app();
1163
1164         $adminlist = explode(",", str_replace(" ", "", $a->config['admin_email']));
1165
1166         //if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && ($a->user['email'] === $a->config['admin_email']))
1167         if (local_user() && x($a->user, 'email') && x($a->config, 'admin_email') && in_array($a->user['email'], $adminlist)) {
1168                 return true;
1169         }
1170         return false;
1171 }
1172
1173 /**
1174  * @brief Returns querystring as string from a mapped array.
1175  *
1176  * @param array  $params mapped array with query parameters
1177  * @param string $name   of parameter, default null
1178  *
1179  * @return string
1180  */
1181 function build_querystring($params, $name = null)
1182 {
1183         $ret = "";
1184         foreach ($params as $key => $val) {
1185                 if (is_array($val)) {
1186                         /// @TODO maybe not compare against null, use is_null()
1187                         if ($name == null) {
1188                                 $ret .= build_querystring($val, $key);
1189                         } else {
1190                                 $ret .= build_querystring($val, $name . "[$key]");
1191                         }
1192                 } else {
1193                         $val = urlencode($val);
1194                         /// @TODO maybe not compare against null, use is_null()
1195                         if ($name != null) {
1196                                 /// @TODO two string concated, can be merged to one
1197                                 $ret .= $name . "[$key]" . "=$val&";
1198                         } else {
1199                                 $ret .= "$key=$val&";
1200                         }
1201                 }
1202         }
1203         return $ret;
1204 }
1205
1206 function explode_querystring($query)
1207 {
1208         $arg_st = strpos($query, '?');
1209         if ($arg_st !== false) {
1210                 $base = substr($query, 0, $arg_st);
1211                 $arg_st += 1;
1212         } else {
1213                 $base = '';
1214                 $arg_st = 0;
1215         }
1216
1217         $args = explode('&', substr($query, $arg_st));
1218         foreach ($args as $k => $arg) {
1219                 /// @TODO really compare type-safe here?
1220                 if ($arg === '') {
1221                         unset($args[$k]);
1222                 }
1223         }
1224         $args = array_values($args);
1225
1226         if (!$base) {
1227                 $base = $args[0];
1228                 unset($args[0]);
1229                 $args = array_values($args);
1230         }
1231
1232         return [
1233                 'base' => $base,
1234                 'args' => $args,
1235         ];
1236 }
1237
1238 /**
1239  * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
1240  *
1241  * Taken from http://webcheatsheet.com/php/get_current_page_url.php
1242  */
1243 function curPageURL()
1244 {
1245         $pageURL = 'http';
1246         if ($_SERVER["HTTPS"] == "on") {
1247                 $pageURL .= "s";
1248         }
1249
1250         $pageURL .= "://";
1251
1252         if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
1253                 $pageURL .= $_SERVER["SERVER_NAME"] . ":" . $_SERVER["SERVER_PORT"] . $_SERVER["REQUEST_URI"];
1254         } else {
1255                 $pageURL .= $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"];
1256         }
1257         return $pageURL;
1258 }
1259
1260 function random_digits($digits)
1261 {
1262         $rn = '';
1263         for ($i = 0; $i < $digits; $i++) {
1264                 /// @TODO rand() is different to mt_rand() and maybe lesser "random"
1265                 $rn .= rand(0, 9);
1266         }
1267         return $rn;
1268 }
1269
1270 function get_server()
1271 {
1272         $server = Config::get("system", "directory");
1273
1274         if ($server == "") {
1275                 $server = "http://dir.friendica.social";
1276         }
1277
1278         return($server);
1279 }
1280
1281 function get_temppath()
1282 {
1283         $a = get_app();
1284
1285         $temppath = Config::get("system", "temppath");
1286
1287         if (($temppath != "") && App::directory_usable($temppath)) {
1288                 // We have a temp path and it is usable
1289                 return App::realpath($temppath);
1290         }
1291
1292         // We don't have a working preconfigured temp path, so we take the system path.
1293         $temppath = sys_get_temp_dir();
1294
1295         // Check if it is usable
1296         if (($temppath != "") && App::directory_usable($temppath)) {
1297                 // Always store the real path, not the path through symlinks
1298                 $temppath = App::realpath($temppath);
1299
1300                 // To avoid any interferences with other systems we create our own directory
1301                 $new_temppath = $temppath . "/" . $a->get_hostname();
1302                 if (!is_dir($new_temppath)) {
1303                         /// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
1304                         mkdir($new_temppath);
1305                 }
1306
1307                 if (App::directory_usable($new_temppath)) {
1308                         // The new path is usable, we are happy
1309                         Config::set("system", "temppath", $new_temppath);
1310                         return $new_temppath;
1311                 } else {
1312                         // We can't create a subdirectory, strange.
1313                         // But the directory seems to work, so we use it but don't store it.
1314                         return $temppath;
1315                 }
1316         }
1317
1318         // Reaching this point means that the operating system is configured badly.
1319         return '';
1320 }
1321
1322 function get_cachefile($file, $writemode = true)
1323 {
1324         $cache = get_itemcachepath();
1325
1326         if ((!$cache) || (!is_dir($cache))) {
1327                 return("");
1328         }
1329
1330         $subfolder = $cache . "/" . substr($file, 0, 2);
1331
1332         $cachepath = $subfolder . "/" . $file;
1333
1334         if ($writemode) {
1335                 if (!is_dir($subfolder)) {
1336                         mkdir($subfolder);
1337                         chmod($subfolder, 0777);
1338                 }
1339         }
1340
1341         /// @TODO no need to put braces here
1342         return $cachepath;
1343 }
1344
1345 function clear_cache($basepath = "", $path = "")
1346 {
1347         if ($path == "") {
1348                 $basepath = get_itemcachepath();
1349                 $path = $basepath;
1350         }
1351
1352         if (($path == "") || (!is_dir($path))) {
1353                 return;
1354         }
1355
1356         if (substr(realpath($path), 0, strlen($basepath)) != $basepath) {
1357                 return;
1358         }
1359
1360         $cachetime = (int) Config::get('system', 'itemcache_duration');
1361         if ($cachetime == 0) {
1362                 $cachetime = 86400;
1363         }
1364
1365         if (is_writable($path)) {
1366                 if ($dh = opendir($path)) {
1367                         while (($file = readdir($dh)) !== false) {
1368                                 $fullpath = $path . "/" . $file;
1369                                 if ((filetype($fullpath) == "dir") && ($file != ".") && ($file != "..")) {
1370                                         clear_cache($basepath, $fullpath);
1371                                 }
1372                                 if ((filetype($fullpath) == "file") && (filectime($fullpath) < (time() - $cachetime))) {
1373                                         unlink($fullpath);
1374                                 }
1375                         }
1376                         closedir($dh);
1377                 }
1378         }
1379 }
1380
1381 function get_itemcachepath()
1382 {
1383         // Checking, if the cache is deactivated
1384         $cachetime = (int) Config::get('system', 'itemcache_duration');
1385         if ($cachetime < 0) {
1386                 return "";
1387         }
1388
1389         $itemcache = Config::get('system', 'itemcache');
1390         if (($itemcache != "") && App::directory_usable($itemcache)) {
1391                 return App::realpath($itemcache);
1392         }
1393
1394         $temppath = get_temppath();
1395
1396         if ($temppath != "") {
1397                 $itemcache = $temppath . "/itemcache";
1398                 if (!file_exists($itemcache) && !is_dir($itemcache)) {
1399                         mkdir($itemcache);
1400                 }
1401
1402                 if (App::directory_usable($itemcache)) {
1403                         Config::set("system", "itemcache", $itemcache);
1404                         return $itemcache;
1405                 }
1406         }
1407         return "";
1408 }
1409
1410 /**
1411  * @brief Returns the path where spool files are stored
1412  *
1413  * @return string Spool path
1414  */
1415 function get_spoolpath()
1416 {
1417         $spoolpath = Config::get('system', 'spoolpath');
1418         if (($spoolpath != "") && App::directory_usable($spoolpath)) {
1419                 // We have a spool path and it is usable
1420                 return $spoolpath;
1421         }
1422
1423         // We don't have a working preconfigured spool path, so we take the temp path.
1424         $temppath = get_temppath();
1425
1426         if ($temppath != "") {
1427                 // To avoid any interferences with other systems we create our own directory
1428                 $spoolpath = $temppath . "/spool";
1429                 if (!is_dir($spoolpath)) {
1430                         mkdir($spoolpath);
1431                 }
1432
1433                 if (App::directory_usable($spoolpath)) {
1434                         // The new path is usable, we are happy
1435                         Config::set("system", "spoolpath", $spoolpath);
1436                         return $spoolpath;
1437                 } else {
1438                         // We can't create a subdirectory, strange.
1439                         // But the directory seems to work, so we use it but don't store it.
1440                         return $temppath;
1441                 }
1442         }
1443
1444         // Reaching this point means that the operating system is configured badly.
1445         return "";
1446 }
1447
1448
1449 if (!function_exists('exif_imagetype')) {
1450         function exif_imagetype($file)
1451         {
1452                 $size = getimagesize($file);
1453                 return $size[2];
1454         }
1455 }
1456
1457 function validate_include(&$file)
1458 {
1459         $orig_file = $file;
1460
1461         $file = realpath($file);
1462
1463         if (strpos($file, getcwd()) !== 0) {
1464                 return false;
1465         }
1466
1467         $file = str_replace(getcwd() . "/", "", $file, $count);
1468         if ($count != 1) {
1469                 return false;
1470         }
1471
1472         if ($orig_file !== $file) {
1473                 return false;
1474         }
1475
1476         $valid = false;
1477         if (strpos($file, "include/") === 0) {
1478                 $valid = true;
1479         }
1480
1481         if (strpos($file, "addon/") === 0) {
1482                 $valid = true;
1483         }
1484
1485         // Simply return flag
1486         return ($valid);
1487 }
1488
1489 function current_load()
1490 {
1491         if (!function_exists('sys_getloadavg')) {
1492                 return false;
1493         }
1494
1495         $load_arr = sys_getloadavg();
1496
1497         if (!is_array($load_arr)) {
1498                 return false;
1499         }
1500
1501         return max($load_arr[0], $load_arr[1]);
1502 }
1503
1504 /**
1505  * @brief get c-style args
1506  *
1507  * @return int
1508  */
1509 function argc()
1510 {
1511         return get_app()->argc;
1512 }
1513
1514 /**
1515  * @brief Returns the value of a argv key
1516  *
1517  * @param int $x argv key
1518  * @return string Value of the argv key
1519  */
1520 function argv($x)
1521 {
1522         if (array_key_exists($x, get_app()->argv)) {
1523                 return get_app()->argv[$x];
1524         }
1525
1526         return '';
1527 }
1528
1529 /**
1530  * @brief Get the data which is needed for infinite scroll
1531  *
1532  * For invinite scroll we need the page number of the actual page
1533  * and the the URI where the content of the next page comes from.
1534  * This data is needed for the js part in main.js.
1535  * Note: infinite scroll does only work for the network page (module)
1536  *
1537  * @param string $module The name of the module (e.g. "network")
1538  * @return array Of infinite scroll data
1539  *      'pageno' => $pageno The number of the actual page
1540  *      'reload_uri' => $reload_uri The URI of the content we have to load
1541  */
1542 function infinite_scroll_data($module)
1543 {
1544         if (PConfig::get(local_user(), 'system', 'infinite_scroll')
1545                 && $module == 'network'
1546                 && defaults($_GET, 'mode', '') != 'minimal'
1547         ) {
1548                 // get the page number
1549                 $pageno = defaults($_GET, 'page', 1);
1550
1551                 $reload_uri = "";
1552
1553                 // try to get the uri from which we load the content
1554                 foreach ($_GET as $param => $value) {
1555                         if (($param != "page") && ($param != "q")) {
1556                                 $reload_uri .= "&" . $param . "=" . urlencode($value);
1557                         }
1558                 }
1559
1560                 $a = get_app();
1561                 if ($a->page_offset != "" && !strstr($reload_uri, "&offset=")) {
1562                         $reload_uri .= "&offset=" . urlencode($a->page_offset);
1563                 }
1564
1565                 $arr = ["pageno" => $pageno, "reload_uri" => $reload_uri];
1566
1567                 return $arr;
1568         }
1569 }