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