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