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',      1277);
  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         global $a;
 512
 513         if (empty($a)) {
 514                 $a = new App(dirname(__DIR__));
 515                 BaseObject::setApp($a);
 516         }
 517
 518         return $a;
 519 }
 520
 521 /**
 522  * @brief Multi-purpose function to check variable state.
 523  *
 524  * Usage: x($var) or $x($array, 'key')
 525  *
 526  * returns false if variable/key is not set
 527  * if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0.
 528  * e.g. x('') or x(0) returns 0;
 529  *
 530  * @param string|array $s variable to check
 531  * @param string       $k key inside the array to check
 532  *
 533  * @return bool|int
 534  */
 535 function x($s, $k = null)
 536 {
 537         if ($k != null) {
 538                 if ((is_array($s)) && (array_key_exists($k, $s))) {
 539                         if ($s[$k]) {
 540                                 return (int) 1;
 541                         }
 542                         return (int) 0;
 543                 }
 544                 return false;
 545         } else {
 546                 if (isset($s)) {
 547                         if ($s) {
 548                                 return (int) 1;
 549                         }
 550                         return (int) 0;
 551                 }
 552                 return false;
 553         }
 554 }
 555
 556 /**
 557  * Return the provided variable value if it exists and is truthy or the provided
 558  * default value instead.
 559  *
 560  * Works with initialized variables and potentially uninitialized array keys
 561  *
 562  * Usages:
 563  * - defaults($var, $default)
 564  * - defaults($array, 'key', $default)
 565  *
 566  * @brief Returns a defaut value if the provided variable or array key is falsy
 567  * @see x()
 568  * @return mixed
 569  */
 570 function defaults() {
 571         $args = func_get_args();
 572
 573         if (count($args) < 2) {
 574                 throw new BadFunctionCallException('defaults() requires at least 2 parameters');
 575         }
 576         if (count($args) > 3) {
 577                 throw new BadFunctionCallException('defaults() cannot use more than 3 parameters');
 578         }
 579         if (count($args) === 3 && is_null($args[1])) {
 580                 throw new BadFunctionCallException('defaults($arr, $key, $def) $key is null');
 581         }
 582
 583         $default = array_pop($args);
 584
 585         if (call_user_func_array('x', $args)) {
 586                 if (count($args) === 1) {
 587                         $return = $args[0];
 588                 } else {
 589                         $return = $args[0][$args[1]];
 590                 }
 591         } else {
 592                 $return = $default;
 593         }
 594
 595         return $return;
 596 }
 597
 598 /**
 599  * @brief Returns the baseurl.
 600  *
 601  * @see System::baseUrl()
 602  *
 603  * @return string
 604  * @TODO Function is deprecated and only used in some addons
 605  */
 606 function z_root()
 607 {
 608         return System::baseUrl();
 609 }
 610
 611 /**
 612  * @brief Return absolut URL for given $path.
 613  *
 614  * @param string $path given path
 615  *
 616  * @return string
 617  */
 618 function absurl($path)
 619 {
 620         if (strpos($path, '/') === 0) {
 621                 return z_path() . $path;
 622         }
 623         return $path;
 624 }
 625
 626 /**
 627  * @brief Function to check if request was an AJAX (xmlhttprequest) request.
 628  *
 629  * @return boolean
 630  */
 631 function is_ajax()
 632 {
 633         return (!empty($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest');
 634 }
 635
 636 /**
 637  * @brief Function to check if request was an AJAX (xmlhttprequest) request.
 638  *
 639  * @param boolean $via_worker boolean Is the check run via the worker?
 640  */
 641 function check_db($via_worker)
 642 {
 643         $build = Config::get('system', 'build');
 644
 645         if (empty($build)) {
 646                 Config::set('system', 'build', DB_UPDATE_VERSION - 1);
 647                 $build = DB_UPDATE_VERSION - 1;
 648         }
 649
 650         // We don't support upgrading from very old versions anymore
 651         if ($build < NEW_UPDATE_ROUTINE_VERSION) {
 652                 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.');
 653         }
 654
 655         if ($build < DB_UPDATE_VERSION) {
 656                 // When we cannot execute the database update via the worker, we will do it directly
 657                 if (!Worker::add(PRIORITY_CRITICAL, 'DBUpdate') && $via_worker) {
 658                         update_db();
 659                 }
 660         }
 661 }
 662
 663 /**
 664  * Sets the base url for use in cmdline programs which don't have
 665  * $_SERVER variables
 666  *
 667  * @param object $a App
 668  */
 669 function check_url(App $a)
 670 {
 671         $url = Config::get('system', 'url');
 672
 673         // if the url isn't set or the stored url is radically different
 674         // than the currently visited url, store the current value accordingly.
 675         // "Radically different" ignores common variations such as http vs https
 676         // and www.example.com vs example.com.
 677         // We will only change the url to an ip address if there is no existing setting
 678
 679         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()))) {
 680                 Config::set('system', 'url', System::baseUrl());
 681         }
 682
 683         return;
 684 }
 685
 686 /**
 687  * @brief Automatic database updates
 688  * @param object $a App
 689  */
 690 function update_db()
 691 {
 692         $build = Config::get('system', 'build');
 693
 694         if (empty($build) || ($build > DB_UPDATE_VERSION)) {
 695                 $build = DB_UPDATE_VERSION - 1;
 696                 Config::set('system', 'build', $build);
 697         }
 698
 699         if ($build != DB_UPDATE_VERSION) {
 700                 require_once 'update.php';
 701
 702                 $stored = intval($build);
 703                 $current = intval(DB_UPDATE_VERSION);
 704                 if ($stored < $current) {
 705                         Config::load('database');
 706
 707                         // Compare the current structure with the defined structure
 708                         $t = Config::get('database', 'dbupdate_' . DB_UPDATE_VERSION);
 709                         if (!is_null($t)) {
 710                                 return;
 711                         }
 712
 713                         Config::set('database', 'dbupdate_' . DB_UPDATE_VERSION, time());
 714
 715                         // run update routine
 716                         // it update the structure in one call
 717                         $retval = DBStructure::update(false, true);
 718                         if ($retval) {
 719                                 DBStructure::updateFail(
 720                                         DB_UPDATE_VERSION,
 721                                         $retval
 722                                 );
 723                                 return;
 724                         } else {
 725                                 Config::set('database', 'dbupdate_' . DB_UPDATE_VERSION, 'success');
 726                         }
 727
 728                         // run any left update_nnnn functions in update.php
 729                         for ($x = $stored + 1; $x <= $current; $x++) {
 730                                 $r = run_update_function($x);
 731                                 if (!$r) {
 732                                         break;
 733                                 }
 734                         }
 735                 }
 736         }
 737
 738         return;
 739 }
 740
 741 function run_update_function($x)
 742 {
 743         if (function_exists('update_' . $x)) {
 744                 // There could be a lot of processes running or about to run.
 745                 // We want exactly one process to run the update command.
 746                 // So store the fact that we're taking responsibility
 747                 // after first checking to see if somebody else already has.
 748                 // If the update fails or times-out completely you may need to
 749                 // delete the config entry to try again.
 750
 751                 $t = Config::get('database', 'update_' . $x);
 752                 if (!is_null($t)) {
 753                         return false;
 754                 }
 755                 Config::set('database', 'update_' . $x, time());
 756
 757                 // call the specific update
 758
 759                 $func = 'update_' . $x;
 760                 $retval = $func();
 761
 762                 if ($retval) {
 763                         //send the administrator an e-mail
 764                         DBStructure::updateFail(
 765                                 $x,
 766                                 L10n::t('Update %s failed. See error logs.', $x)
 767                         );
 768                         return false;
 769                 } else {
 770                         Config::set('database', 'update_' . $x, 'success');
 771                         Config::set('system', 'build', $x);
 772                         return true;
 773                 }
 774         } else {
 775                 Config::set('database', 'update_' . $x, 'success');
 776                 Config::set('system', 'build', $x);
 777                 return true;
 778         }
 779 }
 780
 781 /**
 782  * @brief Synchronise addons:
 783  *
 784  * $a->config['system']['addon'] contains a comma-separated list of names
 785  * of addons which are used on this system.
 786  * Go through the database list of already installed addons, and if we have
 787  * an entry, but it isn't in the config list, call the uninstall procedure
 788  * and mark it uninstalled in the database (for now we'll remove it).
 789  * Then go through the config list and if we have a addon that isn't installed,
 790  * call the install procedure and add it to the database.
 791  *
 792  * @param object $a App
 793  */
 794 function check_addons(App $a)
 795 {
 796         $r = q("SELECT * FROM `addon` WHERE `installed` = 1");
 797         if (DBM::is_result($r)) {
 798                 $installed = $r;
 799         } else {
 800                 $installed = [];
 801         }
 802
 803         $addons = Config::get('system', 'addon');
 804         $addons_arr = [];
 805
 806         if ($addons) {
 807                 $addons_arr = explode(',', str_replace(' ', '', $addons));
 808         }
 809
 810         $a->addons = $addons_arr;
 811
 812         $installed_arr = [];
 813
 814         if (count($installed)) {
 815                 foreach ($installed as $i) {
 816                         if (!in_array($i['name'], $addons_arr)) {
 817                                 Addon::uninstall($i['name']);
 818                         } else {
 819                                 $installed_arr[] = $i['name'];
 820                         }
 821                 }
 822         }
 823
 824         if (count($addons_arr)) {
 825                 foreach ($addons_arr as $p) {
 826                         if (!in_array($p, $installed_arr)) {
 827                                 Addon::install($p);
 828                         }
 829                 }
 830         }
 831
 832         Addon::loadHooks();
 833
 834         return;
 835 }
 836
 837 /**
 838  * @brief Used to end the current process, after saving session state.
 839  * @deprecated
 840  */
 841 function killme()
 842 {
 843         exit();
 844 }
 845
 846 /**
 847  * @brief Redirect to another URL and terminate this process.
 848  */
 849 function goaway($path)
 850 {
 851         if (strstr(normalise_link($path), 'http://')) {
 852                 $url = $path;
 853         } else {
 854                 $url = System::baseUrl() . '/' . ltrim($path, '/');
 855         }
 856
 857         header("Location: $url");
 858         killme();
 859 }
 860
 861 /**
 862  * @brief Returns the user id of locally logged in user or false.
 863  *
 864  * @return int|bool user id or false
 865  */
 866 function local_user()
 867 {
 868         if (!empty($_SESSION['authenticated']) && !empty($_SESSION['uid'])) {
 869                 return intval($_SESSION['uid']);
 870         }
 871         return false;
 872 }
 873
 874 /**
 875  * @brief Returns the public contact id of logged in user or false.
 876  *
 877  * @return int|bool public contact id or false
 878  */
 879 function public_contact()
 880 {
 881         static $public_contact_id = false;
 882
 883         if (!$public_contact_id && x($_SESSION, 'authenticated')) {
 884                 if (x($_SESSION, 'my_address')) {
 885                         // Local user
 886                         $public_contact_id = intval(Contact::getIdForURL($_SESSION['my_address'], 0, true));
 887                 } elseif (x($_SESSION, 'visitor_home')) {
 888                         // Remote user
 889                         $public_contact_id = intval(Contact::getIdForURL($_SESSION['visitor_home'], 0, true));
 890                 }
 891         } elseif (!x($_SESSION, 'authenticated')) {
 892                 $public_contact_id = false;
 893         }
 894
 895         return $public_contact_id;
 896 }
 897
 898 /**
 899  * @brief Returns contact id of authenticated site visitor or false
 900  *
 901  * @return int|bool visitor_id or false
 902  */
 903 function remote_user()
 904 {
 905         // You cannot be both local and remote.
 906         // Unncommented by rabuzarus because remote authentication to local
 907         // profiles wasn't possible anymore (2018-04-12).
 908 //      if (local_user()) {
 909 //              return false;
 910 //      }
 911
 912         if (empty($_SESSION)) {
 913                 return false;
 914         }
 915
 916         if (x($_SESSION, 'authenticated') && x($_SESSION, 'visitor_id')) {
 917                 return intval($_SESSION['visitor_id']);
 918         }
 919         return false;
 920 }
 921
 922 /**
 923  * @brief Show an error message to user.
 924  *
 925  * This function save text in session, to be shown to the user at next page load
 926  *
 927  * @param string $s - Text of notice
 928  */
 929 function notice($s)
 930 {
 931         if (empty($_SESSION)) {
 932                 return;
 933         }
 934
 935         $a = get_app();
 936         if (!x($_SESSION, 'sysmsg')) {
 937                 $_SESSION['sysmsg'] = [];
 938         }
 939         if ($a->interactive) {
 940                 $_SESSION['sysmsg'][] = $s;
 941         }
 942 }
 943
 944 /**
 945  * @brief Show an info message to user.
 946  *
 947  * This function save text in session, to be shown to the user at next page load
 948  *
 949  * @param string $s - Text of notice
 950  */
 951 function info($s)
 952 {
 953         $a = get_app();
 954
 955         if (local_user() && PConfig::get(local_user(), 'system', 'ignore_info')) {
 956                 return;
 957         }
 958
 959         if (!x($_SESSION, 'sysmsg_info')) {
 960                 $_SESSION['sysmsg_info'] = [];
 961         }
 962         if ($a->interactive) {
 963                 $_SESSION['sysmsg_info'][] = $s;
 964         }
 965 }
 966
 967 /**
 968  * @brief Wrapper around config to limit the text length of an incoming message
 969  *
 970  * @return int
 971  */
 972 function get_max_import_size()
 973 {
 974         $a = get_app();
 975         return (x($a->config, 'max_import_size') ? $a->config['max_import_size'] : 0);
 976 }
 977
 978 function feed_birthday($uid, $tz)
 979 {
 980         /**
 981          * Determine the next birthday, but only if the birthday is published
 982          * in the default profile. We _could_ also look for a private profile that the
 983          * recipient can see, but somebody could get mad at us if they start getting
 984          * public birthday greetings when they haven't made this info public.
 985          *
 986          * Assuming we are able to publish this info, we are then going to convert
 987          * the start time from the owner's timezone to UTC.
 988          *
 989          * This will potentially solve the problem found with some social networks
 990          * where birthdays are converted to the viewer's timezone and salutations from
 991          * elsewhere in the world show up on the wrong day. We will convert it to the
 992          * viewer's timezone also, but first we are going to convert it from the birthday
 993          * person's timezone to GMT - so the viewer may find the birthday starting at
 994          * 6:00PM the day before, but that will correspond to midnight to the birthday person.
 995          */
 996         $birthday = '';
 997
 998         if (!strlen($tz)) {
 999                 $tz = 'UTC';
1000         }
1001
1002         $p = q(
1003                 "SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1",
1004                 intval($uid)
1005         );
1006
1007         if (DBM::is_result($p)) {
1008                 $tmp_dob = substr($p[0]['dob'], 5);
1009                 if (intval($tmp_dob)) {
1010                         $y = DateTimeFormat::timezoneNow($tz, 'Y');
1011                         $bd = $y . '-' . $tmp_dob . ' 00:00';
1012                         $t_dob = strtotime($bd);
1013                         $now = strtotime(DateTimeFormat::timezoneNow($tz));
1014                         if ($t_dob < $now) {
1015                                 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
1016                         }
1017                         $birthday = DateTimeFormat::convert($bd, 'UTC', $tz, DateTimeFormat::ATOM);
1018                 }
1019         }
1020
1021         return $birthday;
1022 }
1023
1024 /**
1025  * @brief Check if current user has admin role.
1026  *
1027  * @return bool true if user is an admin
1028  */
1029 function is_site_admin()
1030 {
1031         $a = get_app();
1032
1033         $adminlist = explode(",", str_replace(" ", "", $a->config['admin_email']));
1034
1035         //if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && ($a->user['email'] === $a->config['admin_email']))
1036         /// @TODO This if() + 2 returns can be shrinked into one return
1037         if (local_user() && x($a->user, 'email') && x($a->config, 'admin_email') && in_array($a->user['email'], $adminlist)) {
1038                 return true;
1039         }
1040         return false;
1041 }
1042
1043 /**
1044  * @brief Returns querystring as string from a mapped array.
1045  *
1046  * @param array  $params mapped array with query parameters
1047  * @param string $name   of parameter, default null
1048  *
1049  * @return string
1050  */
1051 function build_querystring($params, $name = null)
1052 {
1053         $ret = "";
1054         foreach ($params as $key => $val) {
1055                 if (is_array($val)) {
1056                         /// @TODO maybe not compare against null, use is_null()
1057                         if ($name == null) {
1058                                 $ret .= build_querystring($val, $key);
1059                         } else {
1060                                 $ret .= build_querystring($val, $name . "[$key]");
1061                         }
1062                 } else {
1063                         $val = urlencode($val);
1064                         /// @TODO maybe not compare against null, use is_null()
1065                         if ($name != null) {
1066                                 /// @TODO two string concated, can be merged to one
1067                                 $ret .= $name . "[$key]" . "=$val&";
1068                         } else {
1069                                 $ret .= "$key=$val&";
1070                         }
1071                 }
1072         }
1073         return $ret;
1074 }
1075
1076 function explode_querystring($query)
1077 {
1078         $arg_st = strpos($query, '?');
1079         if ($arg_st !== false) {
1080                 $base = substr($query, 0, $arg_st);
1081                 $arg_st += 1;
1082         } else {
1083                 $base = '';
1084                 $arg_st = 0;
1085         }
1086
1087         $args = explode('&', substr($query, $arg_st));
1088         foreach ($args as $k => $arg) {
1089                 /// @TODO really compare type-safe here?
1090                 if ($arg === '') {
1091                         unset($args[$k]);
1092                 }
1093         }
1094         $args = array_values($args);
1095
1096         if (!$base) {
1097                 $base = $args[0];
1098                 unset($args[0]);
1099                 $args = array_values($args);
1100         }
1101
1102         return [
1103                 'base' => $base,
1104                 'args' => $args,
1105         ];
1106 }
1107
1108 /**
1109  * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
1110  *
1111  * Taken from http://webcheatsheet.com/php/get_current_page_url.php
1112  */
1113 function curPageURL()
1114 {
1115         $pageURL = 'http';
1116         if ($_SERVER["HTTPS"] == "on") {
1117                 $pageURL .= "s";
1118         }
1119
1120         $pageURL .= "://";
1121
1122         if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
1123                 $pageURL .= $_SERVER["SERVER_NAME"] . ":" . $_SERVER["SERVER_PORT"] . $_SERVER["REQUEST_URI"];
1124         } else {
1125                 $pageURL .= $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"];
1126         }
1127         return $pageURL;
1128 }
1129
1130 function random_digits($digits)
1131 {
1132         $rn = '';
1133         for ($i = 0; $i < $digits; $i++) {
1134                 /// @TODO Avoid rand/mt_rand, when it comes to cryptography, they are generating predictable (seedable) numbers.
1135                 $rn .= rand(0, 9);
1136         }
1137         return $rn;
1138 }
1139
1140 function get_server()
1141 {
1142         $server = Config::get("system", "directory");
1143
1144         if ($server == "") {
1145                 $server = "https://dir.friendica.social";
1146         }
1147
1148         return $server;
1149 }
1150
1151 function get_temppath()
1152 {
1153         $a = get_app();
1154
1155         $temppath = Config::get("system", "temppath");
1156
1157         if (($temppath != "") && App::directory_usable($temppath)) {
1158                 // We have a temp path and it is usable
1159                 return App::realpath($temppath);
1160         }
1161
1162         // We don't have a working preconfigured temp path, so we take the system path.
1163         $temppath = sys_get_temp_dir();
1164
1165         // Check if it is usable
1166         if (($temppath != "") && App::directory_usable($temppath)) {
1167                 // Always store the real path, not the path through symlinks
1168                 $temppath = App::realpath($temppath);
1169
1170                 // To avoid any interferences with other systems we create our own directory
1171                 $new_temppath = $temppath . "/" . $a->get_hostname();
1172                 if (!is_dir($new_temppath)) {
1173                         /// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
1174                         mkdir($new_temppath);
1175                 }
1176
1177                 if (App::directory_usable($new_temppath)) {
1178                         // The new path is usable, we are happy
1179                         Config::set("system", "temppath", $new_temppath);
1180                         return $new_temppath;
1181                 } else {
1182                         // We can't create a subdirectory, strange.
1183                         // But the directory seems to work, so we use it but don't store it.
1184                         return $temppath;
1185                 }
1186         }
1187
1188         // Reaching this point means that the operating system is configured badly.
1189         return '';
1190 }
1191
1192 function get_cachefile($file, $writemode = true)
1193 {
1194         $cache = get_itemcachepath();
1195
1196         if ((!$cache) || (!is_dir($cache))) {
1197                 return "";
1198         }
1199
1200         $subfolder = $cache . "/" . substr($file, 0, 2);
1201
1202         $cachepath = $subfolder . "/" . $file;
1203
1204         if ($writemode) {
1205                 if (!is_dir($subfolder)) {
1206                         mkdir($subfolder);
1207                         chmod($subfolder, 0777);
1208                 }
1209         }
1210
1211         return $cachepath;
1212 }
1213
1214 function clear_cache($basepath = "", $path = "")
1215 {
1216         if ($path == "") {
1217                 $basepath = get_itemcachepath();
1218                 $path = $basepath;
1219         }
1220
1221         if (($path == "") || (!is_dir($path))) {
1222                 return;
1223         }
1224
1225         if (substr(realpath($path), 0, strlen($basepath)) != $basepath) {
1226                 return;
1227         }
1228
1229         $cachetime = (int) Config::get('system', 'itemcache_duration');
1230         if ($cachetime == 0) {
1231                 $cachetime = 86400;
1232         }
1233
1234         if (is_writable($path)) {
1235                 if ($dh = opendir($path)) {
1236                         while (($file = readdir($dh)) !== false) {
1237                                 $fullpath = $path . "/" . $file;
1238                                 if ((filetype($fullpath) == "dir") && ($file != ".") && ($file != "..")) {
1239                                         clear_cache($basepath, $fullpath);
1240                                 }
1241                                 if ((filetype($fullpath) == "file") && (filectime($fullpath) < (time() - $cachetime))) {
1242                                         unlink($fullpath);
1243                                 }
1244                         }
1245                         closedir($dh);
1246                 }
1247         }
1248 }
1249
1250 function get_itemcachepath()
1251 {
1252         // Checking, if the cache is deactivated
1253         $cachetime = (int) Config::get('system', 'itemcache_duration');
1254         if ($cachetime < 0) {
1255                 return "";
1256         }
1257
1258         $itemcache = Config::get('system', 'itemcache');
1259         if (($itemcache != "") && App::directory_usable($itemcache)) {
1260                 return App::realpath($itemcache);
1261         }
1262
1263         $temppath = get_temppath();
1264
1265         if ($temppath != "") {
1266                 $itemcache = $temppath . "/itemcache";
1267                 if (!file_exists($itemcache) && !is_dir($itemcache)) {
1268                         mkdir($itemcache);
1269                 }
1270
1271                 if (App::directory_usable($itemcache)) {
1272                         Config::set("system", "itemcache", $itemcache);
1273                         return $itemcache;
1274                 }
1275         }
1276         return "";
1277 }
1278
1279 /**
1280  * @brief Returns the path where spool files are stored
1281  *
1282  * @return string Spool path
1283  */
1284 function get_spoolpath()
1285 {
1286         $spoolpath = Config::get('system', 'spoolpath');
1287         if (($spoolpath != "") && App::directory_usable($spoolpath)) {
1288                 // We have a spool path and it is usable
1289                 return $spoolpath;
1290         }
1291
1292         // We don't have a working preconfigured spool path, so we take the temp path.
1293         $temppath = get_temppath();
1294
1295         if ($temppath != "") {
1296                 // To avoid any interferences with other systems we create our own directory
1297                 $spoolpath = $temppath . "/spool";
1298                 if (!is_dir($spoolpath)) {
1299                         mkdir($spoolpath);
1300                 }
1301
1302                 if (App::directory_usable($spoolpath)) {
1303                         // The new path is usable, we are happy
1304                         Config::set("system", "spoolpath", $spoolpath);
1305                         return $spoolpath;
1306                 } else {
1307                         // We can't create a subdirectory, strange.
1308                         // But the directory seems to work, so we use it but don't store it.
1309                         return $temppath;
1310                 }
1311         }
1312
1313         // Reaching this point means that the operating system is configured badly.
1314         return "";
1315 }
1316
1317 if (!function_exists('exif_imagetype')) {
1318         function exif_imagetype($file)
1319         {
1320                 $size = getimagesize($file);
1321                 return $size[2];
1322         }
1323 }
1324
1325 function validate_include(&$file)
1326 {
1327         $orig_file = $file;
1328
1329         $file = realpath($file);
1330
1331         if (strpos($file, getcwd()) !== 0) {
1332                 return false;
1333         }
1334
1335         $file = str_replace(getcwd() . "/", "", $file, $count);
1336         if ($count != 1) {
1337                 return false;
1338         }
1339
1340         if ($orig_file !== $file) {
1341                 return false;
1342         }
1343
1344         $valid = false;
1345         if (strpos($file, "include/") === 0) {
1346                 $valid = true;
1347         }
1348
1349         if (strpos($file, "addon/") === 0) {
1350                 $valid = true;
1351         }
1352
1353         // Simply return flag
1354         return $valid;
1355 }
1356
1357 function current_load()
1358 {
1359         if (!function_exists('sys_getloadavg')) {
1360                 return false;
1361         }
1362
1363         $load_arr = sys_getloadavg();
1364
1365         if (!is_array($load_arr)) {
1366                 return false;
1367         }
1368
1369         return max($load_arr[0], $load_arr[1]);
1370 }
1371
1372 /**
1373  * @brief get c-style args
1374  *
1375  * @return int
1376  */
1377 function argc()
1378 {
1379         return get_app()->argc;
1380 }
1381
1382 /**
1383  * @brief Returns the value of a argv key
1384  *
1385  * @param int $x argv key
1386  * @return string Value of the argv key
1387  */
1388 function argv($x)
1389 {
1390         if (array_key_exists($x, get_app()->argv)) {
1391                 return get_app()->argv[$x];
1392         }
1393
1394         return '';
1395 }
1396
1397 /**
1398  * @brief Get the data which is needed for infinite scroll
1399  *
1400  * For invinite scroll we need the page number of the actual page
1401  * and the the URI where the content of the next page comes from.
1402  * This data is needed for the js part in main.js.
1403  * Note: infinite scroll does only work for the network page (module)
1404  *
1405  * @param string $module The name of the module (e.g. "network")
1406  * @return array Of infinite scroll data
1407  *      'pageno' => $pageno The number of the actual page
1408  *      'reload_uri' => $reload_uri The URI of the content we have to load
1409  */
1410 function infinite_scroll_data($module)
1411 {
1412         if (PConfig::get(local_user(), 'system', 'infinite_scroll')
1413                 && $module == 'network'
1414                 && defaults($_GET, 'mode', '') != 'minimal'
1415         ) {
1416                 // get the page number
1417                 $pageno = defaults($_GET, 'page', 1);
1418
1419                 $reload_uri = "";
1420
1421                 // try to get the uri from which we load the content
1422                 foreach ($_GET as $param => $value) {
1423                         if (($param != "page") && ($param != "q")) {
1424                                 $reload_uri .= "&" . $param . "=" . urlencode($value);
1425                         }
1426                 }
1427
1428                 $a = get_app();
1429                 if ($a->page_offset != "" && !strstr($reload_uri, "&offset=")) {
1430                         $reload_uri .= "&offset=" . urlencode($a->page_offset);
1431                 }
1432
1433                 $arr = ["pageno" => $pageno, "reload_uri" => $reload_uri];
1434
1435                 return $arr;
1436         }
1437 }