boot.php

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