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