boot.php

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