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