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