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