boot.php

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