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