boot.php

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