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 use Friendica\Database\DBStructure;
  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
  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',      1238);
  47 define('NEW_UPDATE_ROUTINE_VERSION', 1170);
  48
  49 /**
  50  * @brief Constants for the database update check
  51  */
  52 const DB_UPDATE_NOT_CHECKED = 0; // Database check wasn't executed before
  53 const DB_UPDATE_SUCCESSFUL = 1;  // Database check was successful
  54 const DB_UPDATE_FAILED = 2;      // Database check failed
  55
  56 /**
  57  * @brief Constant with a HTML line break.
  58  *
  59  * Contains a HTML line break (br) element and a real carriage return with line
  60  * feed for the source.
  61  * This can be used in HTML and JavaScript where needed a line break.
  62  */
  63 define('EOL',                    "<br />\r\n");
  64 define('ATOM_TIME',              'Y-m-d\TH:i:s\Z');
  65
  66 /**
  67  * @brief Image storage quality.
  68  *
  69  * Lower numbers save space at cost of image detail.
  70  * For ease of upgrade, please do not change here. Change jpeg quality with
  71  * $a->config['system']['jpeg_quality'] = n;
  72  * in .htconfig.php, where n is netween 1 and 100, and with very poor results
  73  * below about 50
  74  */
  75 define('JPEG_QUALITY',            100);
  76
  77 /**
  78  * $a->config['system']['png_quality'] from 0 (uncompressed) to 9
  79  */
  80 define('PNG_QUALITY',             8);
  81
  82 /**
  83  * An alternate way of limiting picture upload sizes. Specify the maximum pixel
  84  * length that pictures are allowed to be (for non-square pictures, it will apply
  85  * to the longest side). Pictures longer than this length will be resized to be
  86  * this length (on the longest side, the other side will be scaled appropriately).
  87  * Modify this value using
  88  *
  89  *    $a->config['system']['max_image_length'] = n;
  90  *
  91  * in .htconfig.php
  92  *
  93  * If you don't want to set a maximum length, set to -1. The default value is
  94  * defined by 'MAX_IMAGE_LENGTH' below.
  95  */
  96 define('MAX_IMAGE_LENGTH',        -1);
  97
  98 /**
  99  * Not yet used
 100  */
 101 define('DEFAULT_DB_ENGINE',  'InnoDB');
 102
 103 /**
 104  * @name SSL Policy
 105  *
 106  * SSL redirection policies
 107  * @{
 108  */
 109 define('SSL_POLICY_NONE',         0);
 110 define('SSL_POLICY_FULL',         1);
 111 define('SSL_POLICY_SELFSIGN',     2);
 112 /* @}*/
 113
 114 /**
 115  * @name Logger
 116  *
 117  * log levels
 118  * @{
 119  */
 120 define('LOGGER_NORMAL',          0);
 121 define('LOGGER_TRACE',           1);
 122 define('LOGGER_DEBUG',           2);
 123 define('LOGGER_DATA',            3);
 124 define('LOGGER_ALL',             4);
 125 /* @}*/
 126
 127 /**
 128  * @name Cache
 129  *
 130  * Cache levels
 131  * @{
 132  */
 133 define('CACHE_MONTH',            0);
 134 define('CACHE_WEEK',             1);
 135 define('CACHE_DAY',              2);
 136 define('CACHE_HOUR',             3);
 137 define('CACHE_HALF_HOUR',        4);
 138 define('CACHE_QUARTER_HOUR',     5);
 139 define('CACHE_FIVE_MINUTES',     6);
 140 define('CACHE_MINUTE',           7);
 141 /* @}*/
 142
 143 /**
 144  * @name Register
 145  *
 146  * Registration policies
 147  * @{
 148  */
 149 define('REGISTER_CLOSED',        0);
 150 define('REGISTER_APPROVE',       1);
 151 define('REGISTER_OPEN',          2);
 152 /**
 153  * @}
 154 */
 155
 156 /**
 157  * @name Contact_is
 158  *
 159  * Relationship types
 160  * @{
 161  */
 162 define('CONTACT_IS_FOLLOWER', 1);
 163 define('CONTACT_IS_SHARING',  2);
 164 define('CONTACT_IS_FRIEND',   3);
 165 /**
 166  *  @}
 167  */
 168
 169 /**
 170  * @name Update
 171  *
 172  * DB update return values
 173  * @{
 174  */
 175 define('UPDATE_SUCCESS', 0);
 176 define('UPDATE_FAILED',  1);
 177 /**
 178  * @}
 179  */
 180
 181 /**
 182  * @name page/profile types
 183  *
 184  * PAGE_NORMAL is a typical personal profile account
 185  * PAGE_SOAPBOX automatically approves all friend requests as CONTACT_IS_SHARING, (readonly)
 186  * PAGE_COMMUNITY automatically approves all friend requests as CONTACT_IS_SHARING, but with
 187  *      write access to wall and comments (no email and not included in page owner's ACL lists)
 188  * PAGE_FREELOVE automatically approves all friend requests as full friends (CONTACT_IS_FRIEND).
 189  *
 190  * @{
 191  */
 192 define('PAGE_NORMAL',            0);
 193 define('PAGE_SOAPBOX',           1);
 194 define('PAGE_COMMUNITY',         2);
 195 define('PAGE_FREELOVE',          3);
 196 define('PAGE_BLOG',              4);
 197 define('PAGE_PRVGROUP',          5);
 198 /**
 199  * @}
 200  */
 201
 202 /**
 203  * @name account types
 204  *
 205  * ACCOUNT_TYPE_PERSON - the account belongs to a person
 206  *      Associated page types: PAGE_NORMAL, PAGE_SOAPBOX, PAGE_FREELOVE
 207  *
 208  * ACCOUNT_TYPE_ORGANISATION - the account belongs to an organisation
 209  *      Associated page type: PAGE_SOAPBOX
 210  *
 211  * ACCOUNT_TYPE_NEWS - the account is a news reflector
 212  *      Associated page type: PAGE_SOAPBOX
 213  *
 214  * ACCOUNT_TYPE_COMMUNITY - the account is community forum
 215  *      Associated page types: PAGE_COMMUNITY, PAGE_PRVGROUP
 216  * @{
 217  */
 218 define('ACCOUNT_TYPE_PERSON',      0);
 219 define('ACCOUNT_TYPE_ORGANISATION', 1);
 220 define('ACCOUNT_TYPE_NEWS',        2);
 221 define('ACCOUNT_TYPE_COMMUNITY',   3);
 222 /**
 223  * @}
 224  */
 225
 226 /**
 227  * @name CP
 228  *
 229  * Type of the community page
 230  * @{
 231  */
 232 define('CP_NO_COMMUNITY_PAGE',   -1);
 233 define('CP_USERS_ON_SERVER',     0);
 234 define('CP_GLOBAL_COMMUNITY',    1);
 235 /**
 236  * @}
 237  */
 238
 239 /**
 240  * @name Protocols
 241  *
 242  * Different protocols that we are storing
 243  * @{
 244  */
 245 define('PROTOCOL_UNKNOWN',         0);
 246 define('PROTOCOL_DFRN',            1);
 247 define('PROTOCOL_DIASPORA',        2);
 248 define('PROTOCOL_OSTATUS_SALMON',  3);
 249 define('PROTOCOL_OSTATUS_FEED',    4); // Deprecated
 250 define('PROTOCOL_GS_CONVERSATION', 5); // Deprecated
 251 define('PROTOCOL_SPLITTED_CONV',   6);
 252 /**
 253  * @}
 254  */
 255
 256 /**
 257  * @name Network
 258  *
 259  * Network and protocol family types
 260  * @{
 261  */
 262 define('NETWORK_DFRN',             'dfrn');    // Friendica, Mistpark, other DFRN implementations
 263 define('NETWORK_ZOT',              'zot!');    // Zot! - Currently unsupported
 264 define('NETWORK_OSTATUS',          'stat');    // GNU-social, Pleroma, Mastodon, other OStatus implementations
 265 define('NETWORK_FEED',             'feed');    // RSS/Atom feeds with no known "post/notify" protocol
 266 define('NETWORK_DIASPORA',         'dspr');    // Diaspora
 267 define('NETWORK_MAIL',             'mail');    // IMAP/POP
 268 define('NETWORK_FACEBOOK',         'face');    // Facebook API
 269 define('NETWORK_LINKEDIN',         'lnkd');    // LinkedIn
 270 define('NETWORK_XMPP',             'xmpp');    // XMPP - Currently unsupported
 271 define('NETWORK_MYSPACE',          'mysp');    // MySpace - Currently unsupported
 272 define('NETWORK_GPLUS',            'goog');    // Google+
 273 define('NETWORK_PUMPIO',           'pump');    // pump.io
 274 define('NETWORK_TWITTER',          'twit');    // Twitter
 275 define('NETWORK_DIASPORA2',        'dspc');    // Diaspora connector
 276 define('NETWORK_STATUSNET',        'stac');    // Statusnet connector
 277 define('NETWORK_APPNET',           'apdn');    // app.net - Dead protocol
 278 define('NETWORK_NEWS',             'nntp');    // Network News Transfer Protocol - Currently unsupported
 279 define('NETWORK_ICALENDAR',        'ical');    // iCalendar - Currently unsupported
 280 define('NETWORK_PNUT',             'pnut');    // pnut.io - Currently unsupported
 281 define('NETWORK_PHANTOM',          'unkn');    // Place holder
 282 /**
 283  * @}
 284  */
 285
 286 /**
 287  * These numbers are used in stored permissions
 288  * and existing allocations MUST NEVER BE CHANGED
 289  * OR RE-ASSIGNED! You may only add to them.
 290  */
 291 $netgroup_ids = array(
 292         NETWORK_DFRN     => (-1),
 293         NETWORK_ZOT      => (-2),
 294         NETWORK_OSTATUS  => (-3),
 295         NETWORK_FEED     => (-4),
 296         NETWORK_DIASPORA => (-5),
 297         NETWORK_MAIL     => (-6),
 298         NETWORK_FACEBOOK => (-8),
 299         NETWORK_LINKEDIN => (-9),
 300         NETWORK_XMPP     => (-10),
 301         NETWORK_MYSPACE  => (-11),
 302         NETWORK_GPLUS    => (-12),
 303         NETWORK_PUMPIO   => (-13),
 304         NETWORK_TWITTER  => (-14),
 305         NETWORK_DIASPORA2 => (-15),
 306         NETWORK_STATUSNET => (-16),
 307         NETWORK_APPNET    => (-17),
 308         NETWORK_NEWS      => (-18),
 309         NETWORK_ICALENDAR => (-19),
 310         NETWORK_PNUT      => (-20),
 311
 312         NETWORK_PHANTOM  => (-127),
 313 );
 314
 315 /**
 316  * Maximum number of "people who like (or don't like) this"  that we will list by name
 317  */
 318 define('MAX_LIKERS',    75);
 319
 320 /**
 321  * Communication timeout
 322  */
 323 define('ZCURL_TIMEOUT', (-1));
 324
 325 /**
 326  * @name Notify
 327  *
 328  * Email notification options
 329  * @{
 330  */
 331 define('NOTIFY_INTRO',    0x0001);
 332 define('NOTIFY_CONFIRM',  0x0002);
 333 define('NOTIFY_WALL',     0x0004);
 334 define('NOTIFY_COMMENT',  0x0008);
 335 define('NOTIFY_MAIL',     0x0010);
 336 define('NOTIFY_SUGGEST',  0x0020);
 337 define('NOTIFY_PROFILE',  0x0040);
 338 define('NOTIFY_TAGSELF',  0x0080);
 339 define('NOTIFY_TAGSHARE', 0x0100);
 340 define('NOTIFY_POKE',     0x0200);
 341 define('NOTIFY_SHARE',    0x0400);
 342
 343 define('SYSTEM_EMAIL',    0x4000);
 344
 345 define('NOTIFY_SYSTEM',   0x8000);
 346 /* @}*/
 347
 348
 349 /**
 350  * @name Term
 351  *
 352  * Tag/term types
 353  * @{
 354  */
 355 define('TERM_UNKNOWN',   0);
 356 define('TERM_HASHTAG',   1);
 357 define('TERM_MENTION',   2);
 358 define('TERM_CATEGORY',  3);
 359 define('TERM_PCATEGORY', 4);
 360 define('TERM_FILE',      5);
 361 define('TERM_SAVEDSEARCH', 6);
 362 define('TERM_CONVERSATION', 7);
 363
 364 define('TERM_OBJ_POST',  1);
 365 define('TERM_OBJ_PHOTO', 2);
 366
 367 /**
 368  * @name Namespaces
 369  *
 370  * Various namespaces we may need to parse
 371  * @{
 372  */
 373 define('NAMESPACE_ZOT',             'http://purl.org/zot');
 374 define('NAMESPACE_DFRN',            'http://purl.org/macgirvin/dfrn/1.0');
 375 define('NAMESPACE_THREAD',          'http://purl.org/syndication/thread/1.0');
 376 define('NAMESPACE_TOMB',            'http://purl.org/atompub/tombstones/1.0');
 377 define('NAMESPACE_ACTIVITY',        'http://activitystrea.ms/spec/1.0/');
 378 define('NAMESPACE_ACTIVITY_SCHEMA', 'http://activitystrea.ms/schema/1.0/');
 379 define('NAMESPACE_MEDIA',           'http://purl.org/syndication/atommedia');
 380 define('NAMESPACE_SALMON_ME',       'http://salmon-protocol.org/ns/magic-env');
 381 define('NAMESPACE_OSTATUSSUB',      'http://ostatus.org/schema/1.0/subscribe');
 382 define('NAMESPACE_GEORSS',          'http://www.georss.org/georss');
 383 define('NAMESPACE_POCO',            'http://portablecontacts.net/spec/1.0');
 384 define('NAMESPACE_FEED',            'http://schemas.google.com/g/2010#updates-from');
 385 define('NAMESPACE_OSTATUS',         'http://ostatus.org/schema/1.0');
 386 define('NAMESPACE_STATUSNET',       'http://status.net/schema/api/1/');
 387 define('NAMESPACE_ATOM1',           'http://www.w3.org/2005/Atom');
 388 define('NAMESPACE_MASTODON',        'http://mastodon.social/schema/1.0');
 389 /* @}*/
 390
 391 /**
 392  * @name Activity
 393  *
 394  * Activity stream defines
 395  * @{
 396  */
 397 define('ACTIVITY_LIKE',        NAMESPACE_ACTIVITY_SCHEMA . 'like');
 398 define('ACTIVITY_DISLIKE',     NAMESPACE_DFRN            . '/dislike');
 399 define('ACTIVITY_ATTEND',      NAMESPACE_ZOT             . '/activity/attendyes');
 400 define('ACTIVITY_ATTENDNO',    NAMESPACE_ZOT             . '/activity/attendno');
 401 define('ACTIVITY_ATTENDMAYBE', NAMESPACE_ZOT             . '/activity/attendmaybe');
 402
 403 define('ACTIVITY_OBJ_HEART',   NAMESPACE_DFRN            . '/heart');
 404
 405 define('ACTIVITY_FRIEND',      NAMESPACE_ACTIVITY_SCHEMA . 'make-friend');
 406 define('ACTIVITY_REQ_FRIEND',  NAMESPACE_ACTIVITY_SCHEMA . 'request-friend');
 407 define('ACTIVITY_UNFRIEND',    NAMESPACE_ACTIVITY_SCHEMA . 'remove-friend');
 408 define('ACTIVITY_FOLLOW',      NAMESPACE_ACTIVITY_SCHEMA . 'follow');
 409 define('ACTIVITY_UNFOLLOW',    NAMESPACE_ACTIVITY_SCHEMA . 'stop-following');
 410 define('ACTIVITY_JOIN',        NAMESPACE_ACTIVITY_SCHEMA . 'join');
 411
 412 define('ACTIVITY_POST',        NAMESPACE_ACTIVITY_SCHEMA . 'post');
 413 define('ACTIVITY_UPDATE',      NAMESPACE_ACTIVITY_SCHEMA . 'update');
 414 define('ACTIVITY_TAG',         NAMESPACE_ACTIVITY_SCHEMA . 'tag');
 415 define('ACTIVITY_FAVORITE',    NAMESPACE_ACTIVITY_SCHEMA . 'favorite');
 416 define('ACTIVITY_UNFAVORITE',  NAMESPACE_ACTIVITY_SCHEMA . 'unfavorite');
 417 define('ACTIVITY_SHARE',       NAMESPACE_ACTIVITY_SCHEMA . 'share');
 418 define('ACTIVITY_DELETE',      NAMESPACE_ACTIVITY_SCHEMA . 'delete');
 419
 420 define('ACTIVITY_POKE',        NAMESPACE_ZOT . '/activity/poke');
 421
 422 define('ACTIVITY_OBJ_BOOKMARK', NAMESPACE_ACTIVITY_SCHEMA . 'bookmark');
 423 define('ACTIVITY_OBJ_COMMENT', NAMESPACE_ACTIVITY_SCHEMA . 'comment');
 424 define('ACTIVITY_OBJ_NOTE',    NAMESPACE_ACTIVITY_SCHEMA . 'note');
 425 define('ACTIVITY_OBJ_PERSON',  NAMESPACE_ACTIVITY_SCHEMA . 'person');
 426 define('ACTIVITY_OBJ_IMAGE',   NAMESPACE_ACTIVITY_SCHEMA . 'image');
 427 define('ACTIVITY_OBJ_PHOTO',   NAMESPACE_ACTIVITY_SCHEMA . 'photo');
 428 define('ACTIVITY_OBJ_VIDEO',   NAMESPACE_ACTIVITY_SCHEMA . 'video');
 429 define('ACTIVITY_OBJ_P_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'profile-photo');
 430 define('ACTIVITY_OBJ_ALBUM',   NAMESPACE_ACTIVITY_SCHEMA . 'photo-album');
 431 define('ACTIVITY_OBJ_EVENT',   NAMESPACE_ACTIVITY_SCHEMA . 'event');
 432 define('ACTIVITY_OBJ_GROUP',   NAMESPACE_ACTIVITY_SCHEMA . 'group');
 433 define('ACTIVITY_OBJ_TAGTERM', NAMESPACE_DFRN            . '/tagterm');
 434 define('ACTIVITY_OBJ_PROFILE', NAMESPACE_DFRN            . '/profile');
 435 define('ACTIVITY_OBJ_QUESTION', 'http://activityschema.org/object/question');
 436 /* @}*/
 437
 438 /**
 439  * @name Gravity
 440  *
 441  * Item weight for query ordering
 442  * @{
 443  */
 444 define('GRAVITY_PARENT',       0);
 445 define('GRAVITY_LIKE',         3);
 446 define('GRAVITY_COMMENT',      6);
 447 /* @}*/
 448
 449 /**
 450  * @name Priority
 451  *
 452  * Process priority for the worker
 453  * @{
 454  */
 455 define('PRIORITY_UNDEFINED',   0);
 456 define('PRIORITY_CRITICAL',   10);
 457 define('PRIORITY_HIGH',       20);
 458 define('PRIORITY_MEDIUM',     30);
 459 define('PRIORITY_LOW',        40);
 460 define('PRIORITY_NEGLIGIBLE', 50);
 461 /* @}*/
 462
 463 /**
 464  * @name Social Relay settings
 465  *
 466  * See here: https://github.com/jaywink/social-relay
 467  * and here: https://wiki.diasporafoundation.org/Relay_servers_for_public_posts
 468  * @{
 469  */
 470 define('SR_SCOPE_NONE', '');
 471 define('SR_SCOPE_ALL',  'all');
 472 define('SR_SCOPE_TAGS', 'tags');
 473 /* @}*/
 474
 475 /**
 476  * Lowest possible date time value
 477  */
 478 define('NULL_DATE', '0001-01-01 00:00:00');
 479
 480 // Normally this constant is defined - but not if "pcntl" isn't installed
 481 if (!defined("SIGTERM")) {
 482         define("SIGTERM", 15);
 483 }
 484
 485 /**
 486  * Depending on the PHP version this constant does exist - or not.
 487  * See here: http://php.net/manual/en/curl.constants.php#117928
 488  */
 489 if (!defined('CURLE_OPERATION_TIMEDOUT')) {
 490         define('CURLE_OPERATION_TIMEDOUT', CURLE_OPERATION_TIMEOUTED);
 491 }
 492 /**
 493  * Reverse the effect of magic_quotes_gpc if it is enabled.
 494  * Please disable magic_quotes_gpc so we don't have to do this.
 495  * See http://php.net/manual/en/security.magicquotes.disabling.php
 496  */
 497 function startup()
 498 {
 499         error_reporting(E_ERROR | E_WARNING | E_PARSE);
 500
 501         set_time_limit(0);
 502
 503         // This has to be quite large to deal with embedded private photos
 504         ini_set('pcre.backtrack_limit', 500000);
 505
 506         if (get_magic_quotes_gpc()) {
 507                 $process = array(&$_GET, &$_POST, &$_COOKIE, &$_REQUEST);
 508                 while (list($key, $val) = each($process)) {
 509                         foreach ($val as $k => $v) {
 510                                 unset($process[$key][$k]);
 511                                 if (is_array($v)) {
 512                                         $process[$key][stripslashes($k)] = $v;
 513                                         $process[] = &$process[$key][stripslashes($k)];
 514                                 } else {
 515                                         $process[$key][stripslashes($k)] = stripslashes($v);
 516                                 }
 517                         }
 518                 }
 519                 unset($process);
 520         }
 521 }
 522
 523 /**
 524  * @brief Retrieve the App structure
 525  *
 526  * Useful in functions which require it but don't get it passed to them
 527  *
 528  * @return App
 529  */
 530 function get_app()
 531 {
 532         global $a;
 533
 534         if (empty($a)) {
 535                 $a = new App(dirname(__DIR__));
 536         }
 537
 538         return $a;
 539 }
 540
 541 /**
 542  * @brief Multi-purpose function to check variable state.
 543  *
 544  * Usage: x($var) or $x($array, 'key')
 545  *
 546  * returns false if variable/key is not set
 547  * if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0.
 548  * e.g. x('') or x(0) returns 0;
 549  *
 550  * @param string|array $s variable to check
 551  * @param string       $k key inside the array to check
 552  *
 553  * @return bool|int
 554  */
 555 function x($s, $k = null)
 556 {
 557         if ($k != null) {
 558                 if ((is_array($s)) && (array_key_exists($k, $s))) {
 559                         if ($s[$k]) {
 560                                 return (int) 1;
 561                         }
 562                         return (int) 0;
 563                 }
 564                 return false;
 565         } else {
 566                 if (isset($s)) {
 567                         if ($s) {
 568                                 return (int) 1;
 569                         }
 570                         return (int) 0;
 571                 }
 572                 return false;
 573         }
 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 = DBStructure::update(false, true);
 708                                 if ($retval) {
 709                                         DBStructure::updateFail(
 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                         DBStructure::updateFail(
 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         if (!get_app()->is_backend()) {
 932                 session_write_close();
 933         }
 934
 935         exit();
 936 }
 937
 938 /**
 939  * @brief Redirect to another URL and terminate this process.
 940  */
 941 function goaway($s)
 942 {
 943         if (!strstr(normalise_link($s), "http://")) {
 944                 $s = System::baseUrl() . "/" . $s;
 945         }
 946
 947         header("Location: $s");
 948         killme();
 949 }
 950
 951 /**
 952  * @brief Returns the user id of locally logged in user or false.
 953  *
 954  * @return int|bool user id or false
 955  */
 956 function local_user()
 957 {
 958         if (x($_SESSION, 'authenticated') && x($_SESSION, 'uid')) {
 959                 return intval($_SESSION['uid']);
 960         }
 961         return false;
 962 }
 963
 964 /**
 965  * @brief Returns the public contact id of logged in user or false.
 966  *
 967  * @return int|bool public contact id or false
 968  */
 969 function public_contact()
 970 {
 971         static $public_contact_id = false;
 972
 973         if (!$public_contact_id && x($_SESSION, 'authenticated')) {
 974                 if (x($_SESSION, 'my_address')) {
 975                         // Local user
 976                         $public_contact_id = intval(Contact::getIdForURL($_SESSION['my_address'], 0));
 977                 } elseif (x($_SESSION, 'visitor_home')) {
 978                         // Remote user
 979                         $public_contact_id = intval(Contact::getIdForURL($_SESSION['visitor_home'], 0));
 980                 }
 981         } elseif (!x($_SESSION, 'authenticated')) {
 982                 $public_contact_id = false;
 983         }
 984
 985         return $public_contact_id;
 986 }
 987
 988 /**
 989  * @brief Returns contact id of authenticated site visitor or false
 990  *
 991  * @return int|bool visitor_id or false
 992  */
 993 function remote_user()
 994 {
 995         // You cannot be both local and remote
 996         if (local_user()) {
 997                 return false;
 998         }
 999         if ((x($_SESSION, 'authenticated')) && (x($_SESSION, 'visitor_id'))) {
1000                 return intval($_SESSION['visitor_id']);
1001         }
1002         return false;
1003 }
1004
1005 /**
1006  * @brief Show an error message to user.
1007  *
1008  * This function save text in session, to be shown to the user at next page load
1009  *
1010  * @param string $s - Text of notice
1011  */
1012 function notice($s)
1013 {
1014         $a = get_app();
1015         if (!x($_SESSION, 'sysmsg')) {
1016                 $_SESSION['sysmsg'] = array();
1017         }
1018         if ($a->interactive) {
1019                 $_SESSION['sysmsg'][] = $s;
1020         }
1021 }
1022
1023 /**
1024  * @brief Show an info message to user.
1025  *
1026  * This function save text in session, to be shown to the user at next page load
1027  *
1028  * @param string $s - Text of notice
1029  */
1030 function info($s)
1031 {
1032         $a = get_app();
1033
1034         if (local_user() && PConfig::get(local_user(), 'system', 'ignore_info')) {
1035                 return;
1036         }
1037
1038         if (!x($_SESSION, 'sysmsg_info')) {
1039                 $_SESSION['sysmsg_info'] = array();
1040         }
1041         if ($a->interactive) {
1042                 $_SESSION['sysmsg_info'][] = $s;
1043         }
1044 }
1045
1046 /**
1047  * @brief Wrapper around config to limit the text length of an incoming message
1048  *
1049  * @return int
1050  */
1051 function get_max_import_size()
1052 {
1053         $a = get_app();
1054         return ((x($a->config, 'max_import_size')) ? $a->config['max_import_size'] : 0 );
1055 }
1056
1057
1058 function current_theme()
1059 {
1060         $app_base_themes = array('duepuntozero', 'dispy', 'quattro');
1061
1062         $a = get_app();
1063
1064         $page_theme = null;
1065
1066         // Find the theme that belongs to the user whose stuff we are looking at
1067
1068         if ($a->profile_uid && ($a->profile_uid != local_user())) {
1069                 $r = q(
1070                         "select theme from user where uid = %d limit 1",
1071                         intval($a->profile_uid)
1072                 );
1073                 if (DBM::is_result($r)) {
1074                         $page_theme = $r[0]['theme'];
1075                 }
1076         }
1077
1078         // Allow folks to over-rule user themes and always use their own on their own site.
1079         // This works only if the user is on the same server
1080
1081         if ($page_theme && local_user() && (local_user() != $a->profile_uid)) {
1082                 if (PConfig::get(local_user(), 'system', 'always_my_theme')) {
1083                         $page_theme = null;
1084                 }
1085         }
1086
1087 //              $mobile_detect = new Mobile_Detect();
1088 //              $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
1089         $is_mobile = $a->is_mobile || $a->is_tablet;
1090
1091         $standard_system_theme = Config::get('system', 'theme', '');
1092         $standard_theme_name = ((isset($_SESSION) && x($_SESSION, 'theme')) ? $_SESSION['theme'] : $standard_system_theme);
1093
1094         if ($is_mobile) {
1095                 if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
1096                         $system_theme = $standard_system_theme;
1097                         $theme_name = $standard_theme_name;
1098                 } else {
1099                         $system_theme = Config::get('system', 'mobile-theme', '');
1100                         if ($system_theme == '') {
1101                                 $system_theme = $standard_system_theme;
1102                         }
1103                         $theme_name = ((isset($_SESSION) && x($_SESSION, 'mobile-theme')) ? $_SESSION['mobile-theme'] : $system_theme);
1104
1105                         if ($theme_name === '---') {
1106                                 // user has selected to have the mobile theme be the same as the normal one
1107                                 $system_theme = $standard_system_theme;
1108                                 $theme_name = $standard_theme_name;
1109
1110                                 if ($page_theme) {
1111                                         $theme_name = $page_theme;
1112                                 }
1113                         }
1114                 }
1115         } else {
1116                 $system_theme = $standard_system_theme;
1117                 $theme_name = $standard_theme_name;
1118
1119                 if ($page_theme) {
1120                         $theme_name = $page_theme;
1121                 }
1122         }
1123
1124         if ($theme_name
1125                 && (file_exists('view/theme/' . $theme_name . '/style.css')
1126                 || file_exists('view/theme/' . $theme_name . '/style.php'))
1127         ) {
1128                 return($theme_name);
1129         }
1130
1131         foreach ($app_base_themes as $t) {
1132                 if (file_exists('view/theme/' . $t . '/style.css')
1133                         || file_exists('view/theme/' . $t . '/style.php')
1134                 ) {
1135                         return($t);
1136                 }
1137         }
1138
1139         $fallback = array_merge(glob('view/theme/*/style.css'), glob('view/theme/*/style.php'));
1140         if (count($fallback)) {
1141                 return (str_replace('view/theme/', '', substr($fallback[0], 0, -10)));
1142         }
1143
1144         /// @TODO No final return statement?
1145 }
1146
1147 /**
1148  * @brief Return full URL to theme which is currently in effect.
1149  *
1150  * Provide a sane default if nothing is chosen or the specified theme does not exist.
1151  *
1152  * @return string
1153  */
1154 function current_theme_url()
1155 {
1156         $a = get_app();
1157
1158         $t = current_theme();
1159
1160         $opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : '');
1161         if (file_exists('view/theme/' . $t . '/style.php')) {
1162                 return('view/theme/' . $t . '/style.pcss' . $opts);
1163         }
1164
1165         return('view/theme/' . $t . '/style.css');
1166 }
1167
1168 function feed_birthday($uid, $tz)
1169 {
1170         /**
1171          * Determine the next birthday, but only if the birthday is published
1172          * in the default profile. We _could_ also look for a private profile that the
1173          * recipient can see, but somebody could get mad at us if they start getting
1174          * public birthday greetings when they haven't made this info public.
1175          *
1176          * Assuming we are able to publish this info, we are then going to convert
1177          * the start time from the owner's timezone to UTC.
1178          *
1179          * This will potentially solve the problem found with some social networks
1180          * where birthdays are converted to the viewer's timezone and salutations from
1181          * elsewhere in the world show up on the wrong day. We will convert it to the
1182          * viewer's timezone also, but first we are going to convert it from the birthday
1183          * person's timezone to GMT - so the viewer may find the birthday starting at
1184          * 6:00PM the day before, but that will correspond to midnight to the birthday person.
1185          */
1186         $birthday = '';
1187
1188         if (!strlen($tz)) {
1189                 $tz = 'UTC';
1190         }
1191
1192         $p = q(
1193                 "SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1",
1194                 intval($uid)
1195         );
1196
1197         if (DBM::is_result($p)) {
1198                 $tmp_dob = substr($p[0]['dob'], 5);
1199                 if (intval($tmp_dob)) {
1200                         $y = datetime_convert($tz, $tz, 'now', 'Y');
1201                         $bd = $y . '-' . $tmp_dob . ' 00:00';
1202                         $t_dob = strtotime($bd);
1203                         $now = strtotime(datetime_convert($tz, $tz, 'now'));
1204                         if ($t_dob < $now) {
1205                                 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
1206                         }
1207                         $birthday = datetime_convert($tz, 'UTC', $bd, ATOM_TIME);
1208                 }
1209         }
1210
1211         return $birthday;
1212 }
1213
1214 /**
1215  * @brief Check if current user has admin role.
1216  *
1217  * @return bool true if user is an admin
1218  */
1219 function is_site_admin()
1220 {
1221         $a = get_app();
1222
1223         $adminlist = explode(",", str_replace(" ", "", $a->config['admin_email']));
1224
1225         //if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && ($a->user['email'] === $a->config['admin_email']))
1226         if (local_user() && x($a->user, 'email') && x($a->config, 'admin_email') && in_array($a->user['email'], $adminlist)) {
1227                 return true;
1228         }
1229         return false;
1230 }
1231
1232 /**
1233  * @brief Returns querystring as string from a mapped array.
1234  *
1235  * @param array  $params mapped array with query parameters
1236  * @param string $name   of parameter, default null
1237  *
1238  * @return string
1239  */
1240 function build_querystring($params, $name = null)
1241 {
1242         $ret = "";
1243         foreach ($params as $key => $val) {
1244                 if (is_array($val)) {
1245                         /// @TODO maybe not compare against null, use is_null()
1246                         if ($name == null) {
1247                                 $ret .= build_querystring($val, $key);
1248                         } else {
1249                                 $ret .= build_querystring($val, $name . "[$key]");
1250                         }
1251                 } else {
1252                         $val = urlencode($val);
1253                         /// @TODO maybe not compare against null, use is_null()
1254                         if ($name != null) {
1255                                 /// @TODO two string concated, can be merged to one
1256                                 $ret .= $name . "[$key]" . "=$val&";
1257                         } else {
1258                                 $ret .= "$key=$val&";
1259                         }
1260                 }
1261         }
1262         return $ret;
1263 }
1264
1265 function explode_querystring($query)
1266 {
1267         $arg_st = strpos($query, '?');
1268         if ($arg_st !== false) {
1269                 $base = substr($query, 0, $arg_st);
1270                 $arg_st += 1;
1271         } else {
1272                 $base = '';
1273                 $arg_st = 0;
1274         }
1275
1276         $args = explode('&', substr($query, $arg_st));
1277         foreach ($args as $k => $arg) {
1278                 /// @TODO really compare type-safe here?
1279                 if ($arg === '') {
1280                         unset($args[$k]);
1281                 }
1282         }
1283         $args = array_values($args);
1284
1285         if (!$base) {
1286                 $base = $args[0];
1287                 unset($args[0]);
1288                 $args = array_values($args);
1289         }
1290
1291         return array(
1292                 'base' => $base,
1293                 'args' => $args,
1294         );
1295 }
1296
1297 /**
1298  * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
1299  *
1300  * Taken from http://webcheatsheet.com/php/get_current_page_url.php
1301  */
1302 function curPageURL()
1303 {
1304         $pageURL = 'http';
1305         if ($_SERVER["HTTPS"] == "on") {
1306                 $pageURL .= "s";
1307         }
1308
1309         $pageURL .= "://";
1310
1311         if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
1312                 $pageURL .= $_SERVER["SERVER_NAME"] . ":" . $_SERVER["SERVER_PORT"] . $_SERVER["REQUEST_URI"];
1313         } else {
1314                 $pageURL .= $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"];
1315         }
1316         return $pageURL;
1317 }
1318
1319 function random_digits($digits)
1320 {
1321         $rn = '';
1322         for ($i = 0; $i < $digits; $i++) {
1323                 /// @TODO rand() is different to mt_rand() and maybe lesser "random"
1324                 $rn .= rand(0, 9);
1325         }
1326         return $rn;
1327 }
1328
1329 function get_server()
1330 {
1331         $server = Config::get("system", "directory");
1332
1333         if ($server == "") {
1334                 $server = "http://dir.friendica.social";
1335         }
1336
1337         return($server);
1338 }
1339
1340 function get_temppath()
1341 {
1342         $a = get_app();
1343
1344         $temppath = Config::get("system", "temppath");
1345
1346         if (($temppath != "") && App::directory_usable($temppath)) {
1347                 // We have a temp path and it is usable
1348                 return App::realpath($temppath);
1349         }
1350
1351         // We don't have a working preconfigured temp path, so we take the system path.
1352         $temppath = sys_get_temp_dir();
1353
1354         // Check if it is usable
1355         if (($temppath != "") && App::directory_usable($temppath)) {
1356                 // Always store the real path, not the path through symlinks
1357                 $temppath = App::realpath($temppath);
1358
1359                 // To avoid any interferences with other systems we create our own directory
1360                 $new_temppath = $temppath . "/" . $a->get_hostname();
1361                 if (!is_dir($new_temppath)) {
1362                         /// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
1363                         mkdir($new_temppath);
1364                 }
1365
1366                 if (App::directory_usable($new_temppath)) {
1367                         // The new path is usable, we are happy
1368                         Config::set("system", "temppath", $new_temppath);
1369                         return $new_temppath;
1370                 } else {
1371                         // We can't create a subdirectory, strange.
1372                         // But the directory seems to work, so we use it but don't store it.
1373                         return $temppath;
1374                 }
1375         }
1376
1377         // Reaching this point means that the operating system is configured badly.
1378         return '';
1379 }
1380
1381 function get_cachefile($file, $writemode = true)
1382 {
1383         $cache = get_itemcachepath();
1384
1385         if ((!$cache) || (!is_dir($cache))) {
1386                 return("");
1387         }
1388
1389         $subfolder = $cache . "/" . substr($file, 0, 2);
1390
1391         $cachepath = $subfolder . "/" . $file;
1392
1393         if ($writemode) {
1394                 if (!is_dir($subfolder)) {
1395                         mkdir($subfolder);
1396                         chmod($subfolder, 0777);
1397                 }
1398         }
1399
1400         /// @TODO no need to put braces here
1401         return $cachepath;
1402 }
1403
1404 function clear_cache($basepath = "", $path = "")
1405 {
1406         if ($path == "") {
1407                 $basepath = get_itemcachepath();
1408                 $path = $basepath;
1409         }
1410
1411         if (($path == "") || (!is_dir($path))) {
1412                 return;
1413         }
1414
1415         if (substr(realpath($path), 0, strlen($basepath)) != $basepath) {
1416                 return;
1417         }
1418
1419         $cachetime = (int) Config::get('system', 'itemcache_duration');
1420         if ($cachetime == 0) {
1421                 $cachetime = 86400;
1422         }
1423
1424         if (is_writable($path)) {
1425                 if ($dh = opendir($path)) {
1426                         while (($file = readdir($dh)) !== false) {
1427                                 $fullpath = $path . "/" . $file;
1428                                 if ((filetype($fullpath) == "dir") && ($file != ".") && ($file != "..")) {
1429                                         clear_cache($basepath, $fullpath);
1430                                 }
1431                                 if ((filetype($fullpath) == "file") && (filectime($fullpath) < (time() - $cachetime))) {
1432                                         unlink($fullpath);
1433                                 }
1434                         }
1435                         closedir($dh);
1436                 }
1437         }
1438 }
1439
1440 function get_itemcachepath()
1441 {
1442         // Checking, if the cache is deactivated
1443         $cachetime = (int) Config::get('system', 'itemcache_duration');
1444         if ($cachetime < 0) {
1445                 return "";
1446         }
1447
1448         $itemcache = Config::get('system', 'itemcache');
1449         if (($itemcache != "") && App::directory_usable($itemcache)) {
1450                 return App::realpath($itemcache);
1451         }
1452
1453         $temppath = get_temppath();
1454
1455         if ($temppath != "") {
1456                 $itemcache = $temppath . "/itemcache";
1457                 if (!file_exists($itemcache) && !is_dir($itemcache)) {
1458                         mkdir($itemcache);
1459                 }
1460
1461                 if (App::directory_usable($itemcache)) {
1462                         Config::set("system", "itemcache", $itemcache);
1463                         return $itemcache;
1464                 }
1465         }
1466         return "";
1467 }
1468
1469 /**
1470  * @brief Returns the path where spool files are stored
1471  *
1472  * @return string Spool path
1473  */
1474 function get_spoolpath()
1475 {
1476         $spoolpath = Config::get('system', 'spoolpath');
1477         if (($spoolpath != "") && App::directory_usable($spoolpath)) {
1478                 // We have a spool path and it is usable
1479                 return $spoolpath;
1480         }
1481
1482         // We don't have a working preconfigured spool path, so we take the temp path.
1483         $temppath = get_temppath();
1484
1485         if ($temppath != "") {
1486                 // To avoid any interferences with other systems we create our own directory
1487                 $spoolpath = $temppath . "/spool";
1488                 if (!is_dir($spoolpath)) {
1489                         mkdir($spoolpath);
1490                 }
1491
1492                 if (App::directory_usable($spoolpath)) {
1493                         // The new path is usable, we are happy
1494                         Config::set("system", "spoolpath", $spoolpath);
1495                         return $spoolpath;
1496                 } else {
1497                         // We can't create a subdirectory, strange.
1498                         // But the directory seems to work, so we use it but don't store it.
1499                         return $temppath;
1500                 }
1501         }
1502
1503         // Reaching this point means that the operating system is configured badly.
1504         return "";
1505 }
1506
1507
1508 if (!function_exists('exif_imagetype')) {
1509         function exif_imagetype($file)
1510         {
1511                 $size = getimagesize($file);
1512                 return $size[2];
1513         }
1514 }
1515
1516 function validate_include(&$file)
1517 {
1518         $orig_file = $file;
1519
1520         $file = realpath($file);
1521
1522         if (strpos($file, getcwd()) !== 0) {
1523                 return false;
1524         }
1525
1526         $file = str_replace(getcwd() . "/", "", $file, $count);
1527         if ($count != 1) {
1528                 return false;
1529         }
1530
1531         if ($orig_file !== $file) {
1532                 return false;
1533         }
1534
1535         $valid = false;
1536         if (strpos($file, "include/") === 0) {
1537                 $valid = true;
1538         }
1539
1540         if (strpos($file, "addon/") === 0) {
1541                 $valid = true;
1542         }
1543
1544         // Simply return flag
1545         return ($valid);
1546 }
1547
1548 function current_load()
1549 {
1550         if (!function_exists('sys_getloadavg')) {
1551                 return false;
1552         }
1553
1554         $load_arr = sys_getloadavg();
1555
1556         if (!is_array($load_arr)) {
1557                 return false;
1558         }
1559
1560         return max($load_arr[0], $load_arr[1]);
1561 }
1562
1563 /**
1564  * @brief get c-style args
1565  *
1566  * @return int
1567  */
1568 function argc()
1569 {
1570         return get_app()->argc;
1571 }
1572
1573 /**
1574  * @brief Returns the value of a argv key
1575  *
1576  * @param int $x argv key
1577  * @return string Value of the argv key
1578  */
1579 function argv($x)
1580 {
1581         if (array_key_exists($x, get_app()->argv)) {
1582                 return get_app()->argv[$x];
1583         }
1584
1585         return '';
1586 }
1587
1588 /**
1589  * @brief Get the data which is needed for infinite scroll
1590  *
1591  * For invinite scroll we need the page number of the actual page
1592  * and the the URI where the content of the next page comes from.
1593  * This data is needed for the js part in main.js.
1594  * Note: infinite scroll does only work for the network page (module)
1595  *
1596  * @param string $module The name of the module (e.g. "network")
1597  * @return array Of infinite scroll data
1598  *      'pageno' => $pageno The number of the actual page
1599  *      'reload_uri' => $reload_uri The URI of the content we have to load
1600  */
1601 function infinite_scroll_data($module)
1602 {
1603         if (PConfig::get(local_user(), 'system', 'infinite_scroll')
1604                 && ($module == "network") && ($_GET["mode"] != "minimal")
1605         ) {
1606                 // get the page number
1607                 if (is_string($_GET["page"])) {
1608                         $pageno = $_GET["page"];
1609                 } else {
1610                         $pageno = 1;
1611                 }
1612
1613                 $reload_uri = "";
1614
1615                 // try to get the uri from which we load the content
1616                 foreach ($_GET as $param => $value) {
1617                         if (($param != "page") && ($param != "q")) {
1618                                 $reload_uri .= "&" . $param . "=" . urlencode($value);
1619                         }
1620                 }
1621
1622                 if (($a->page_offset != "") && ! strstr($reload_uri, "&offset=")) {
1623                         $reload_uri .= "&offset=" . urlencode($a->page_offset);
1624                 }
1625
1626                 $arr = array("pageno" => $pageno, "reload_uri" => $reload_uri);
1627
1628                 return $arr;
1629         }
1630 }