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