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