boot.php

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