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