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