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