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