boot.php

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