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