boot.php

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