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