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)) {
 701                 $url = Config::set('system', 'url', System::baseUrl());
 702         }
 703         if ((!link_compare($url, System::baseUrl())) && (!preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/", $a->get_hostname))) {
 704                 $url = Config::set('system', 'url', System::baseUrl());
 705         }
 706
 707         return;
 708 }
 709
 710 /**
 711  * @brief Automatic database updates
 712  * @param object $a App
 713  */
 714 function update_db(App $a)
 715 {
 716         $build = Config::get('system', 'build');
 717
 718         if (empty($build)) {
 719                 Config::set('system', 'build', DB_UPDATE_VERSION);
 720                 $build = DB_UPDATE_VERSION;
 721         }
 722
 723         if ($build != DB_UPDATE_VERSION) {
 724                 require_once 'update.php';
 725
 726                 $stored = intval($build);
 727                 $current = intval(DB_UPDATE_VERSION);
 728                 if ($stored < $current) {
 729                         Config::load('database');
 730
 731                         // Compare the current structure with the defined structure
 732                         $t = Config::get('database', 'dbupdate_' . DB_UPDATE_VERSION);
 733                         if (!is_null($t)) {
 734                                 return;
 735                         }
 736
 737                         Config::set('database', 'dbupdate_' . DB_UPDATE_VERSION, time());
 738
 739                         // run update routine
 740                         // it update the structure in one call
 741                         $retval = DBStructure::update(false, true);
 742                         if ($retval) {
 743                                 DBStructure::updateFail(
 744                                         DB_UPDATE_VERSION,
 745                                         $retval
 746                                 );
 747                                 return;
 748                         } else {
 749                                 Config::set('database', 'dbupdate_' . DB_UPDATE_VERSION, 'success');
 750                         }
 751
 752                         // run any left update_nnnn functions in update.php
 753                         for ($x = $stored + 1; $x <= $current; $x++) {
 754                                 $r = run_update_function($x);
 755                                 if (!$r) {
 756                                         break;
 757                                 }
 758                         }
 759                 }
 760         }
 761
 762         return;
 763 }
 764
 765 function run_update_function($x)
 766 {
 767         if (function_exists('update_' . $x)) {
 768                 // There could be a lot of processes running or about to run.
 769                 // We want exactly one process to run the update command.
 770                 // So store the fact that we're taking responsibility
 771                 // after first checking to see if somebody else already has.
 772                 // If the update fails or times-out completely you may need to
 773                 // delete the config entry to try again.
 774
 775                 $t = Config::get('database', 'update_' . $x);
 776                 if (!is_null($t)) {
 777                         return false;
 778                 }
 779                 Config::set('database', 'update_' . $x, time());
 780
 781                 // call the specific update
 782
 783                 $func = 'update_' . $x;
 784                 $retval = $func();
 785
 786                 if ($retval) {
 787                         //send the administrator an e-mail
 788                         DBStructure::updateFail(
 789                                 $x,
 790                                 sprintf(t('Update %s failed. See error logs.'), $x)
 791                         );
 792                         return false;
 793                 } else {
 794                         Config::set('database', 'update_' . $x, 'success');
 795                         Config::set('system', 'build', $x + 1);
 796                         return true;
 797                 }
 798         } else {
 799                 Config::set('database', 'update_' . $x, 'success');
 800                 Config::set('system', 'build', $x + 1);
 801                 return true;
 802         }
 803         return true;
 804 }
 805
 806 /**
 807  * @brief Synchronise plugins:
 808  *
 809  * $a->config['system']['addon'] contains a comma-separated list of names
 810  * of plugins/addons which are used on this system.
 811  * Go through the database list of already installed addons, and if we have
 812  * an entry, but it isn't in the config list, call the uninstall procedure
 813  * and mark it uninstalled in the database (for now we'll remove it).
 814  * Then go through the config list and if we have a plugin that isn't installed,
 815  * call the install procedure and add it to the database.
 816  *
 817  * @param object $a App
 818  */
 819 function check_plugins(App $a)
 820 {
 821         $r = q("SELECT * FROM `addon` WHERE `installed` = 1");
 822         if (DBM::is_result($r)) {
 823                 $installed = $r;
 824         } else {
 825                 $installed = array();
 826         }
 827
 828         $plugins = Config::get('system', 'addon');
 829         $plugins_arr = array();
 830
 831         if ($plugins) {
 832                 $plugins_arr = explode(',', str_replace(' ', '', $plugins));
 833         }
 834
 835         $a->plugins = $plugins_arr;
 836
 837         $installed_arr = array();
 838
 839         if (count($installed)) {
 840                 foreach ($installed as $i) {
 841                         if (!in_array($i['name'], $plugins_arr)) {
 842                                 uninstall_plugin($i['name']);
 843                         } else {
 844                                 $installed_arr[] = $i['name'];
 845                         }
 846                 }
 847         }
 848
 849         if (count($plugins_arr)) {
 850                 foreach ($plugins_arr as $p) {
 851                         if (!in_array($p, $installed_arr)) {
 852                                 install_plugin($p);
 853                         }
 854                 }
 855         }
 856
 857         load_hooks();
 858
 859         return;
 860 }
 861
 862 function get_guid($size = 16, $prefix = "")
 863 {
 864         if ($prefix == "") {
 865                 $a = get_app();
 866                 $prefix = hash("crc32", $a->get_hostname());
 867         }
 868
 869         while (strlen($prefix) < ($size - 13)) {
 870                 $prefix .= mt_rand();
 871         }
 872
 873         if ($size >= 24) {
 874                 $prefix = substr($prefix, 0, $size - 22);
 875                 return(str_replace(".", "", uniqid($prefix, true)));
 876         } else {
 877                 $prefix = substr($prefix, 0, max($size - 13, 0));
 878                 return(uniqid($prefix));
 879         }
 880 }
 881
 882 /**
 883  * @brief Used to end the current process, after saving session state.
 884  */
 885 function killme()
 886 {
 887         if (!get_app()->is_backend()) {
 888                 session_write_close();
 889         }
 890
 891         exit();
 892 }
 893
 894 /**
 895  * @brief Redirect to another URL and terminate this process.
 896  */
 897 function goaway($path)
 898 {
 899         if (strstr(normalise_link($path), 'http://')) {
 900                 $url = $path;
 901         } else {
 902                 $url = System::baseUrl() . '/' . ltrim($path, '/');
 903         }
 904
 905         header("Location: $url");
 906         killme();
 907 }
 908
 909 /**
 910  * @brief Returns the user id of locally logged in user or false.
 911  *
 912  * @return int|bool user id or false
 913  */
 914 function local_user()
 915 {
 916         if (x($_SESSION, 'authenticated') && x($_SESSION, 'uid')) {
 917                 return intval($_SESSION['uid']);
 918         }
 919         return false;
 920 }
 921
 922 /**
 923  * @brief Returns the public contact id of logged in user or false.
 924  *
 925  * @return int|bool public contact id or false
 926  */
 927 function public_contact()
 928 {
 929         static $public_contact_id = false;
 930
 931         if (!$public_contact_id && x($_SESSION, 'authenticated')) {
 932                 if (x($_SESSION, 'my_address')) {
 933                         // Local user
 934                         $public_contact_id = intval(Contact::getIdForURL($_SESSION['my_address'], 0));
 935                 } elseif (x($_SESSION, 'visitor_home')) {
 936                         // Remote user
 937                         $public_contact_id = intval(Contact::getIdForURL($_SESSION['visitor_home'], 0));
 938                 }
 939         } elseif (!x($_SESSION, 'authenticated')) {
 940                 $public_contact_id = false;
 941         }
 942
 943         return $public_contact_id;
 944 }
 945
 946 /**
 947  * @brief Returns contact id of authenticated site visitor or false
 948  *
 949  * @return int|bool visitor_id or false
 950  */
 951 function remote_user()
 952 {
 953         // You cannot be both local and remote
 954         if (local_user()) {
 955                 return false;
 956         }
 957         if (x($_SESSION, 'authenticated') && x($_SESSION, 'visitor_id')) {
 958                 return intval($_SESSION['visitor_id']);
 959         }
 960         return false;
 961 }
 962
 963 /**
 964  * @brief Show an error message to user.
 965  *
 966  * This function save text in session, to be shown to the user at next page load
 967  *
 968  * @param string $s - Text of notice
 969  */
 970 function notice($s)
 971 {
 972         $a = get_app();
 973         if (!x($_SESSION, 'sysmsg')) {
 974                 $_SESSION['sysmsg'] = array();
 975         }
 976         if ($a->interactive) {
 977                 $_SESSION['sysmsg'][] = $s;
 978         }
 979 }
 980
 981 /**
 982  * @brief Show an info message to user.
 983  *
 984  * This function save text in session, to be shown to the user at next page load
 985  *
 986  * @param string $s - Text of notice
 987  */
 988 function info($s)
 989 {
 990         $a = get_app();
 991
 992         if (local_user() && PConfig::get(local_user(), 'system', 'ignore_info')) {
 993                 return;
 994         }
 995
 996         if (!x($_SESSION, 'sysmsg_info')) {
 997                 $_SESSION['sysmsg_info'] = array();
 998         }
 999         if ($a->interactive) {
1000                 $_SESSION['sysmsg_info'][] = $s;
1001         }
1002 }
1003
1004 /**
1005  * @brief Wrapper around config to limit the text length of an incoming message
1006  *
1007  * @return int
1008  */
1009 function get_max_import_size()
1010 {
1011         $a = get_app();
1012         return (x($a->config, 'max_import_size') ? $a->config['max_import_size'] : 0);
1013 }
1014
1015
1016 function current_theme()
1017 {
1018         $app_base_themes = array('duepuntozero', 'dispy', 'quattro');
1019
1020         $a = get_app();
1021
1022         $page_theme = null;
1023
1024         // Find the theme that belongs to the user whose stuff we are looking at
1025
1026         if ($a->profile_uid && ($a->profile_uid != local_user())) {
1027                 $r = q(
1028                         "select theme from user where uid = %d limit 1",
1029                         intval($a->profile_uid)
1030                 );
1031                 if (DBM::is_result($r)) {
1032                         $page_theme = $r[0]['theme'];
1033                 }
1034         }
1035
1036         // Allow folks to over-rule user themes and always use their own on their own site.
1037         // This works only if the user is on the same server
1038
1039         if ($page_theme && local_user() && (local_user() != $a->profile_uid)) {
1040                 if (PConfig::get(local_user(), 'system', 'always_my_theme')) {
1041                         $page_theme = null;
1042                 }
1043         }
1044
1045 //              $mobile_detect = new Mobile_Detect();
1046 //              $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
1047         $is_mobile = $a->is_mobile || $a->is_tablet;
1048
1049         $standard_system_theme = Config::get('system', 'theme', '');
1050         $standard_theme_name = ((isset($_SESSION) && x($_SESSION, 'theme')) ? $_SESSION['theme'] : $standard_system_theme);
1051
1052         if ($is_mobile) {
1053                 if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
1054                         $system_theme = $standard_system_theme;
1055                         $theme_name = $standard_theme_name;
1056                 } else {
1057                         $system_theme = Config::get('system', 'mobile-theme', '');
1058                         if ($system_theme == '') {
1059                                 $system_theme = $standard_system_theme;
1060                         }
1061                         $theme_name = ((isset($_SESSION) && x($_SESSION, 'mobile-theme')) ? $_SESSION['mobile-theme'] : $system_theme);
1062
1063                         if ($theme_name === '---') {
1064                                 // user has selected to have the mobile theme be the same as the normal one
1065                                 $system_theme = $standard_system_theme;
1066                                 $theme_name = $standard_theme_name;
1067
1068                                 if ($page_theme) {
1069                                         $theme_name = $page_theme;
1070                                 }
1071                         }
1072                 }
1073         } else {
1074                 $system_theme = $standard_system_theme;
1075                 $theme_name = $standard_theme_name;
1076
1077                 if ($page_theme) {
1078                         $theme_name = $page_theme;
1079                 }
1080         }
1081
1082         if ($theme_name
1083                 && (file_exists('view/theme/' . $theme_name . '/style.css')
1084                 || file_exists('view/theme/' . $theme_name . '/style.php'))
1085         ) {
1086                 return($theme_name);
1087         }
1088
1089         foreach ($app_base_themes as $t) {
1090                 if (file_exists('view/theme/' . $t . '/style.css')
1091                         || file_exists('view/theme/' . $t . '/style.php')
1092                 ) {
1093                         return($t);
1094                 }
1095         }
1096
1097         $fallback = array_merge(glob('view/theme/*/style.css'), glob('view/theme/*/style.php'));
1098         if (count($fallback)) {
1099                 return (str_replace('view/theme/', '', substr($fallback[0], 0, -10)));
1100         }
1101
1102         /// @TODO No final return statement?
1103 }
1104
1105 /**
1106  * @brief Return full URL to theme which is currently in effect.
1107  *
1108  * Provide a sane default if nothing is chosen or the specified theme does not exist.
1109  *
1110  * @return string
1111  */
1112 function current_theme_url()
1113 {
1114         $a = get_app();
1115
1116         $t = current_theme();
1117
1118         $opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : '');
1119         if (file_exists('view/theme/' . $t . '/style.php')) {
1120                 return('view/theme/' . $t . '/style.pcss' . $opts);
1121         }
1122
1123         return('view/theme/' . $t . '/style.css');
1124 }
1125
1126 function feed_birthday($uid, $tz)
1127 {
1128         /**
1129          * Determine the next birthday, but only if the birthday is published
1130          * in the default profile. We _could_ also look for a private profile that the
1131          * recipient can see, but somebody could get mad at us if they start getting
1132          * public birthday greetings when they haven't made this info public.
1133          *
1134          * Assuming we are able to publish this info, we are then going to convert
1135          * the start time from the owner's timezone to UTC.
1136          *
1137          * This will potentially solve the problem found with some social networks
1138          * where birthdays are converted to the viewer's timezone and salutations from
1139          * elsewhere in the world show up on the wrong day. We will convert it to the
1140          * viewer's timezone also, but first we are going to convert it from the birthday
1141          * person's timezone to GMT - so the viewer may find the birthday starting at
1142          * 6:00PM the day before, but that will correspond to midnight to the birthday person.
1143          */
1144         $birthday = '';
1145
1146         if (!strlen($tz)) {
1147                 $tz = 'UTC';
1148         }
1149
1150         $p = q(
1151                 "SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1",
1152                 intval($uid)
1153         );
1154
1155         if (DBM::is_result($p)) {
1156                 $tmp_dob = substr($p[0]['dob'], 5);
1157                 if (intval($tmp_dob)) {
1158                         $y = datetime_convert($tz, $tz, 'now', 'Y');
1159                         $bd = $y . '-' . $tmp_dob . ' 00:00';
1160                         $t_dob = strtotime($bd);
1161                         $now = strtotime(datetime_convert($tz, $tz, 'now'));
1162                         if ($t_dob < $now) {
1163                                 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
1164                         }
1165                         $birthday = datetime_convert($tz, 'UTC', $bd, ATOM_TIME);
1166                 }
1167         }
1168
1169         return $birthday;
1170 }
1171
1172 /**
1173  * @brief Check if current user has admin role.
1174  *
1175  * @return bool true if user is an admin
1176  */
1177 function is_site_admin()
1178 {
1179         $a = get_app();
1180
1181         $adminlist = explode(",", str_replace(" ", "", $a->config['admin_email']));
1182
1183         //if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && ($a->user['email'] === $a->config['admin_email']))
1184         if (local_user() && x($a->user, 'email') && x($a->config, 'admin_email') && in_array($a->user['email'], $adminlist)) {
1185                 return true;
1186         }
1187         return false;
1188 }
1189
1190 /**
1191  * @brief Returns querystring as string from a mapped array.
1192  *
1193  * @param array  $params mapped array with query parameters
1194  * @param string $name   of parameter, default null
1195  *
1196  * @return string
1197  */
1198 function build_querystring($params, $name = null)
1199 {
1200         $ret = "";
1201         foreach ($params as $key => $val) {
1202                 if (is_array($val)) {
1203                         /// @TODO maybe not compare against null, use is_null()
1204                         if ($name == null) {
1205                                 $ret .= build_querystring($val, $key);
1206                         } else {
1207                                 $ret .= build_querystring($val, $name . "[$key]");
1208                         }
1209                 } else {
1210                         $val = urlencode($val);
1211                         /// @TODO maybe not compare against null, use is_null()
1212                         if ($name != null) {
1213                                 /// @TODO two string concated, can be merged to one
1214                                 $ret .= $name . "[$key]" . "=$val&";
1215                         } else {
1216                                 $ret .= "$key=$val&";
1217                         }
1218                 }
1219         }
1220         return $ret;
1221 }
1222
1223 function explode_querystring($query)
1224 {
1225         $arg_st = strpos($query, '?');
1226         if ($arg_st !== false) {
1227                 $base = substr($query, 0, $arg_st);
1228                 $arg_st += 1;
1229         } else {
1230                 $base = '';
1231                 $arg_st = 0;
1232         }
1233
1234         $args = explode('&', substr($query, $arg_st));
1235         foreach ($args as $k => $arg) {
1236                 /// @TODO really compare type-safe here?
1237                 if ($arg === '') {
1238                         unset($args[$k]);
1239                 }
1240         }
1241         $args = array_values($args);
1242
1243         if (!$base) {
1244                 $base = $args[0];
1245                 unset($args[0]);
1246                 $args = array_values($args);
1247         }
1248
1249         return array(
1250                 'base' => $base,
1251                 'args' => $args,
1252         );
1253 }
1254
1255 /**
1256  * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
1257  *
1258  * Taken from http://webcheatsheet.com/php/get_current_page_url.php
1259  */
1260 function curPageURL()
1261 {
1262         $pageURL = 'http';
1263         if ($_SERVER["HTTPS"] == "on") {
1264                 $pageURL .= "s";
1265         }
1266
1267         $pageURL .= "://";
1268
1269         if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
1270                 $pageURL .= $_SERVER["SERVER_NAME"] . ":" . $_SERVER["SERVER_PORT"] . $_SERVER["REQUEST_URI"];
1271         } else {
1272                 $pageURL .= $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"];
1273         }
1274         return $pageURL;
1275 }
1276
1277 function random_digits($digits)
1278 {
1279         $rn = '';
1280         for ($i = 0; $i < $digits; $i++) {
1281                 /// @TODO rand() is different to mt_rand() and maybe lesser "random"
1282                 $rn .= rand(0, 9);
1283         }
1284         return $rn;
1285 }
1286
1287 function get_server()
1288 {
1289         $server = Config::get("system", "directory");
1290
1291         if ($server == "") {
1292                 $server = "http://dir.friendica.social";
1293         }
1294
1295         return($server);
1296 }
1297
1298 function get_temppath()
1299 {
1300         $a = get_app();
1301
1302         $temppath = Config::get("system", "temppath");
1303
1304         if (($temppath != "") && App::directory_usable($temppath)) {
1305                 // We have a temp path and it is usable
1306                 return App::realpath($temppath);
1307         }
1308
1309         // We don't have a working preconfigured temp path, so we take the system path.
1310         $temppath = sys_get_temp_dir();
1311
1312         // Check if it is usable
1313         if (($temppath != "") && App::directory_usable($temppath)) {
1314                 // Always store the real path, not the path through symlinks
1315                 $temppath = App::realpath($temppath);
1316
1317                 // To avoid any interferences with other systems we create our own directory
1318                 $new_temppath = $temppath . "/" . $a->get_hostname();
1319                 if (!is_dir($new_temppath)) {
1320                         /// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
1321                         mkdir($new_temppath);
1322                 }
1323
1324                 if (App::directory_usable($new_temppath)) {
1325                         // The new path is usable, we are happy
1326                         Config::set("system", "temppath", $new_temppath);
1327                         return $new_temppath;
1328                 } else {
1329                         // We can't create a subdirectory, strange.
1330                         // But the directory seems to work, so we use it but don't store it.
1331                         return $temppath;
1332                 }
1333         }
1334
1335         // Reaching this point means that the operating system is configured badly.
1336         return '';
1337 }
1338
1339 function get_cachefile($file, $writemode = true)
1340 {
1341         $cache = get_itemcachepath();
1342
1343         if ((!$cache) || (!is_dir($cache))) {
1344                 return("");
1345         }
1346
1347         $subfolder = $cache . "/" . substr($file, 0, 2);
1348
1349         $cachepath = $subfolder . "/" . $file;
1350
1351         if ($writemode) {
1352                 if (!is_dir($subfolder)) {
1353                         mkdir($subfolder);
1354                         chmod($subfolder, 0777);
1355                 }
1356         }
1357
1358         /// @TODO no need to put braces here
1359         return $cachepath;
1360 }
1361
1362 function clear_cache($basepath = "", $path = "")
1363 {
1364         if ($path == "") {
1365                 $basepath = get_itemcachepath();
1366                 $path = $basepath;
1367         }
1368
1369         if (($path == "") || (!is_dir($path))) {
1370                 return;
1371         }
1372
1373         if (substr(realpath($path), 0, strlen($basepath)) != $basepath) {
1374                 return;
1375         }
1376
1377         $cachetime = (int) Config::get('system', 'itemcache_duration');
1378         if ($cachetime == 0) {
1379                 $cachetime = 86400;
1380         }
1381
1382         if (is_writable($path)) {
1383                 if ($dh = opendir($path)) {
1384                         while (($file = readdir($dh)) !== false) {
1385                                 $fullpath = $path . "/" . $file;
1386                                 if ((filetype($fullpath) == "dir") && ($file != ".") && ($file != "..")) {
1387                                         clear_cache($basepath, $fullpath);
1388                                 }
1389                                 if ((filetype($fullpath) == "file") && (filectime($fullpath) < (time() - $cachetime))) {
1390                                         unlink($fullpath);
1391                                 }
1392                         }
1393                         closedir($dh);
1394                 }
1395         }
1396 }
1397
1398 function get_itemcachepath()
1399 {
1400         // Checking, if the cache is deactivated
1401         $cachetime = (int) Config::get('system', 'itemcache_duration');
1402         if ($cachetime < 0) {
1403                 return "";
1404         }
1405
1406         $itemcache = Config::get('system', 'itemcache');
1407         if (($itemcache != "") && App::directory_usable($itemcache)) {
1408                 return App::realpath($itemcache);
1409         }
1410
1411         $temppath = get_temppath();
1412
1413         if ($temppath != "") {
1414                 $itemcache = $temppath . "/itemcache";
1415                 if (!file_exists($itemcache) && !is_dir($itemcache)) {
1416                         mkdir($itemcache);
1417                 }
1418
1419                 if (App::directory_usable($itemcache)) {
1420                         Config::set("system", "itemcache", $itemcache);
1421                         return $itemcache;
1422                 }
1423         }
1424         return "";
1425 }
1426
1427 /**
1428  * @brief Returns the path where spool files are stored
1429  *
1430  * @return string Spool path
1431  */
1432 function get_spoolpath()
1433 {
1434         $spoolpath = Config::get('system', 'spoolpath');
1435         if (($spoolpath != "") && App::directory_usable($spoolpath)) {
1436                 // We have a spool path and it is usable
1437                 return $spoolpath;
1438         }
1439
1440         // We don't have a working preconfigured spool path, so we take the temp path.
1441         $temppath = get_temppath();
1442
1443         if ($temppath != "") {
1444                 // To avoid any interferences with other systems we create our own directory
1445                 $spoolpath = $temppath . "/spool";
1446                 if (!is_dir($spoolpath)) {
1447                         mkdir($spoolpath);
1448                 }
1449
1450                 if (App::directory_usable($spoolpath)) {
1451                         // The new path is usable, we are happy
1452                         Config::set("system", "spoolpath", $spoolpath);
1453                         return $spoolpath;
1454                 } else {
1455                         // We can't create a subdirectory, strange.
1456                         // But the directory seems to work, so we use it but don't store it.
1457                         return $temppath;
1458                 }
1459         }
1460
1461         // Reaching this point means that the operating system is configured badly.
1462         return "";
1463 }
1464
1465
1466 if (!function_exists('exif_imagetype')) {
1467         function exif_imagetype($file)
1468         {
1469                 $size = getimagesize($file);
1470                 return $size[2];
1471         }
1472 }
1473
1474 function validate_include(&$file)
1475 {
1476         $orig_file = $file;
1477
1478         $file = realpath($file);
1479
1480         if (strpos($file, getcwd()) !== 0) {
1481                 return false;
1482         }
1483
1484         $file = str_replace(getcwd() . "/", "", $file, $count);
1485         if ($count != 1) {
1486                 return false;
1487         }
1488
1489         if ($orig_file !== $file) {
1490                 return false;
1491         }
1492
1493         $valid = false;
1494         if (strpos($file, "include/") === 0) {
1495                 $valid = true;
1496         }
1497
1498         if (strpos($file, "addon/") === 0) {
1499                 $valid = true;
1500         }
1501
1502         // Simply return flag
1503         return ($valid);
1504 }
1505
1506 function current_load()
1507 {
1508         if (!function_exists('sys_getloadavg')) {
1509                 return false;
1510         }
1511
1512         $load_arr = sys_getloadavg();
1513
1514         if (!is_array($load_arr)) {
1515                 return false;
1516         }
1517
1518         return max($load_arr[0], $load_arr[1]);
1519 }
1520
1521 /**
1522  * @brief get c-style args
1523  *
1524  * @return int
1525  */
1526 function argc()
1527 {
1528         return get_app()->argc;
1529 }
1530
1531 /**
1532  * @brief Returns the value of a argv key
1533  *
1534  * @param int $x argv key
1535  * @return string Value of the argv key
1536  */
1537 function argv($x)
1538 {
1539         if (array_key_exists($x, get_app()->argv)) {
1540                 return get_app()->argv[$x];
1541         }
1542
1543         return '';
1544 }
1545
1546 /**
1547  * @brief Get the data which is needed for infinite scroll
1548  *
1549  * For invinite scroll we need the page number of the actual page
1550  * and the the URI where the content of the next page comes from.
1551  * This data is needed for the js part in main.js.
1552  * Note: infinite scroll does only work for the network page (module)
1553  *
1554  * @param string $module The name of the module (e.g. "network")
1555  * @return array Of infinite scroll data
1556  *      'pageno' => $pageno The number of the actual page
1557  *      'reload_uri' => $reload_uri The URI of the content we have to load
1558  */
1559 function infinite_scroll_data($module)
1560 {
1561         if (PConfig::get(local_user(), 'system', 'infinite_scroll')
1562                 && $module == 'network'
1563                 && defaults($_GET, 'mode', '') != 'minimal'
1564         ) {
1565                 // get the page number
1566                 $pageno = defaults($_GET, 'page', 1);
1567
1568                 $reload_uri = "";
1569
1570                 // try to get the uri from which we load the content
1571                 foreach ($_GET as $param => $value) {
1572                         if (($param != "page") && ($param != "q")) {
1573                                 $reload_uri .= "&" . $param . "=" . urlencode($value);
1574                         }
1575                 }
1576
1577                 $a = get_app();
1578                 if ($a->page_offset != "" && !strstr($reload_uri, "&offset=")) {
1579                         $reload_uri .= "&offset=" . urlencode($a->page_offset);
1580                 }
1581
1582                 $arr = array("pageno" => $pageno, "reload_uri" => $reload_uri);
1583
1584                 return $arr;
1585         }
1586 }