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