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-rc' );
  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($via_worker) {
 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                 // When we cannot execute the database update via the worker, we will do it directly
 603                 if (!proc_run(PRIORITY_CRITICAL, 'include/dbupdate.php') && $via_worker) {
 604                         update_db(get_app());
 605                 }
 606         }
 607 }
 608
 609 /**
 610  * Sets the base url for use in cmdline programs which don't have
 611  * $_SERVER variables
 612  */
 613 function check_url(App $a) {
 614
 615         $url = get_config('system', 'url');
 616
 617         // if the url isn't set or the stored url is radically different
 618         // than the currently visited url, store the current value accordingly.
 619         // "Radically different" ignores common variations such as http vs https
 620         // and www.example.com vs example.com.
 621         // We will only change the url to an ip address if there is no existing setting
 622
 623         if (!x($url)) {
 624                 $url = set_config('system', 'url', System::baseUrl());
 625         }
 626         if ((!link_compare($url, System::baseUrl())) && (!preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/", $a->get_hostname))) {
 627                 $url = set_config('system', 'url', System::baseUrl());
 628         }
 629
 630         return;
 631 }
 632
 633 /**
 634  * @brief Automatic database updates
 635  */
 636 function update_db(App $a) {
 637         $build = get_config('system', 'build');
 638         if (!x($build)) {
 639                 $build = set_config('system', 'build', DB_UPDATE_VERSION);
 640         }
 641
 642         if ($build != DB_UPDATE_VERSION) {
 643                 $stored = intval($build);
 644                 $current = intval(DB_UPDATE_VERSION);
 645                 if ($stored < $current) {
 646                         Config::load('database');
 647
 648                         // We're reporting a different version than what is currently installed.
 649                         // Run any existing update scripts to bring the database up to current.
 650                         // make sure that boot.php and update.php are the same release, we might be
 651                         // updating right this very second and the correct version of the update.php
 652                         // file may not be here yet. This can happen on a very busy site.
 653
 654                         if (DB_UPDATE_VERSION == UPDATE_VERSION) {
 655                                 // Compare the current structure with the defined structure
 656
 657                                 $t = get_config('database', 'dbupdate_' . DB_UPDATE_VERSION);
 658                                 if ($t !== false) {
 659                                         return;
 660                                 }
 661
 662                                 set_config('database', 'dbupdate_' . DB_UPDATE_VERSION, time());
 663
 664                                 // run old update routine (wich could modify the schema and
 665                                 // conflits with new routine)
 666                                 for ($x = $stored; $x < NEW_UPDATE_ROUTINE_VERSION; $x++) {
 667                                         $r = run_update_function($x);
 668                                         if (!$r) {
 669                                                 break;
 670                                         }
 671                                 }
 672                                 if ($stored < NEW_UPDATE_ROUTINE_VERSION) {
 673                                         $stored = NEW_UPDATE_ROUTINE_VERSION;
 674                                 }
 675
 676                                 // run new update routine
 677                                 // it update the structure in one call
 678                                 $retval = update_structure(false, true);
 679                                 if ($retval) {
 680                                         update_fail(
 681                                                 DB_UPDATE_VERSION,
 682                                                 $retval
 683                                         );
 684                                         return;
 685                                 } else {
 686                                         set_config('database', 'dbupdate_' . DB_UPDATE_VERSION, 'success');
 687                                 }
 688
 689                                 // run any left update_nnnn functions in update.php
 690                                 for ($x = $stored; $x < $current; $x ++) {
 691                                         $r = run_update_function($x);
 692                                         if (!$r) {
 693                                                 break;
 694                                         }
 695                                 }
 696                         }
 697                 }
 698         }
 699
 700         return;
 701 }
 702
 703 function run_update_function($x) {
 704         if (function_exists('update_' . $x)) {
 705
 706                 // There could be a lot of processes running or about to run.
 707                 // We want exactly one process to run the update command.
 708                 // So store the fact that we're taking responsibility
 709                 // after first checking to see if somebody else already has.
 710                 // If the update fails or times-out completely you may need to
 711                 // delete the config entry to try again.
 712
 713                 $t = get_config('database', 'update_' . $x);
 714                 if ($t !== false) {
 715                         return false;
 716                 }
 717                 set_config('database', 'update_' . $x, time());
 718
 719                 // call the specific update
 720
 721                 $func = 'update_' . $x;
 722                 $retval = $func();
 723
 724                 if ($retval) {
 725                         //send the administrator an e-mail
 726                         update_fail(
 727                                 $x,
 728                                 sprintf(t('Update %s failed. See error logs.'), $x)
 729                         );
 730                         return false;
 731                 } else {
 732                         set_config('database', 'update_' . $x, 'success');
 733                         set_config('system', 'build', $x + 1);
 734                         return true;
 735                 }
 736         } else {
 737                 set_config('database', 'update_' . $x, 'success');
 738                 set_config('system', 'build', $x + 1);
 739                 return true;
 740         }
 741         return true;
 742 }
 743
 744 /**
 745  * @brief Synchronise plugins:
 746  *
 747  * $a->config['system']['addon'] contains a comma-separated list of names
 748  * of plugins/addons which are used on this system.
 749  * Go through the database list of already installed addons, and if we have
 750  * an entry, but it isn't in the config list, call the uninstall procedure
 751  * and mark it uninstalled in the database (for now we'll remove it).
 752  * Then go through the config list and if we have a plugin that isn't installed,
 753  * call the install procedure and add it to the database.
 754  *
 755  * @param App $a
 756  *
 757  */
 758 function check_plugins(App $a) {
 759
 760         $r = q("SELECT * FROM `addon` WHERE `installed` = 1");
 761         if (dbm::is_result($r)) {
 762                 $installed = $r;
 763         } else {
 764                 $installed = array();
 765         }
 766
 767         $plugins = get_config('system', 'addon');
 768         $plugins_arr = array();
 769
 770         if ($plugins) {
 771                 $plugins_arr = explode(',', str_replace(' ', '', $plugins));
 772         }
 773
 774         $a->plugins = $plugins_arr;
 775
 776         $installed_arr = array();
 777
 778         if (count($installed)) {
 779                 foreach ($installed as $i) {
 780                         if (!in_array($i['name'], $plugins_arr)) {
 781                                 uninstall_plugin($i['name']);
 782                         } else {
 783                                 $installed_arr[] = $i['name'];
 784                         }
 785                 }
 786         }
 787
 788         if (count($plugins_arr)) {
 789                 foreach ($plugins_arr as $p) {
 790                         if (!in_array($p, $installed_arr)) {
 791                                 install_plugin($p);
 792                         }
 793                 }
 794         }
 795
 796         load_hooks();
 797
 798         return;
 799 }
 800
 801 function get_guid($size = 16, $prefix = "") {
 802         if ($prefix == "") {
 803                 $a = get_app();
 804                 $prefix = hash("crc32", $a->get_hostname());
 805         }
 806
 807         while (strlen($prefix) < ($size - 13)) {
 808                 $prefix .= mt_rand();
 809         }
 810
 811         if ($size >= 24) {
 812                 $prefix = substr($prefix, 0, $size - 22);
 813                 return(str_replace(".", "", uniqid($prefix, true)));
 814         } else {
 815                 $prefix = substr($prefix, 0, max($size - 13, 0));
 816                 return(uniqid($prefix));
 817         }
 818 }
 819
 820 /**
 821  * @brief Wrapper for adding a login box.
 822  *
 823  * @param bool $register
 824  *      If $register == true provide a registration link.
 825  *      This will most always depend on the value of $a->config['register_policy'].
 826  * @param bool $hiddens
 827  *
 828  * @return string
 829  *      Returns the complete html for inserting into the page
 830  *
 831  * @hooks 'login_hook'
 832  *      string $o
 833  */
 834 function login($register = false, $hiddens = false) {
 835         $a = get_app();
 836         $o = "";
 837         $reg = false;
 838         if ($register) {
 839                 $reg = array(
 840                         'title' => t('Create a New Account'),
 841                         'desc' => t('Register')
 842                 );
 843         }
 844
 845         $noid = get_config('system', 'no_openid');
 846
 847         $dest_url = $a->query_string;
 848
 849         if (local_user()) {
 850                 $tpl = get_markup_template("logout.tpl");
 851         } else {
 852                 $a->page['htmlhead'] .= replace_macros(get_markup_template("login_head.tpl"), array(
 853                         '$baseurl' => $a->get_baseurl(true)
 854                 ));
 855
 856                 $tpl = get_markup_template("login.tpl");
 857                 $_SESSION['return_url'] = $a->query_string;
 858                 $a->module = 'login';
 859         }
 860
 861         $o .= replace_macros($tpl, array(
 862
 863                 '$dest_url'     => $dest_url,
 864                 '$logout'       => t('Logout'),
 865                 '$login'        => t('Login'),
 866
 867                 '$lname'        => array('username', t('Nickname or Email: ') , '', ''),
 868                 '$lpassword'    => array('password', t('Password: '), '', ''),
 869                 '$lremember'    => array('remember', t('Remember me'), 0,  ''),
 870
 871                 '$openid'       => !$noid,
 872                 '$lopenid'      => array('openid_url', t('Or login using OpenID: '),'',''),
 873
 874                 '$hiddens'      => $hiddens,
 875
 876                 '$register'     => $reg,
 877
 878                 '$lostpass'     => t('Forgot your password?'),
 879                 '$lostlink'     => t('Password Reset'),
 880
 881                 '$tostitle'     => t('Website Terms of Service'),
 882                 '$toslink'      => t('terms of service'),
 883
 884                 '$privacytitle' => t('Website Privacy Policy'),
 885                 '$privacylink'  => t('privacy policy'),
 886         ));
 887
 888         call_hooks('login_hook', $o);
 889
 890         return $o;
 891 }
 892
 893 /**
 894  * @brief Used to end the current process, after saving session state.
 895  */
 896 function killme() {
 897         if (!get_app()->is_backend()) {
 898                 session_write_close();
 899         }
 900
 901         exit();
 902 }
 903
 904 /**
 905  * @brief Redirect to another URL and terminate this process.
 906  */
 907 function goaway($s) {
 908         if (!strstr(normalise_link($s), "http://")) {
 909                 $s = System::baseUrl() . "/" . $s;
 910         }
 911
 912         header("Location: $s");
 913         killme();
 914 }
 915
 916 /**
 917  * @brief Returns the user id of locally logged in user or false.
 918  *
 919  * @return int|bool user id or false
 920  */
 921 function local_user() {
 922         if (x($_SESSION, 'authenticated') && x($_SESSION, 'uid')) {
 923                 return intval($_SESSION['uid']);
 924         }
 925         return false;
 926 }
 927
 928 /**
 929  * @brief Returns the public contact id of logged in user or false.
 930  *
 931  * @return int|bool public contact id or false
 932  */
 933 function public_contact() {
 934         static $public_contact_id = false;
 935
 936         if (!$public_contact_id && x($_SESSION, 'authenticated')) {
 937                 if (x($_SESSION, 'my_address')) {
 938                         // Local user
 939                         $public_contact_id = intval(get_contact($_SESSION['my_address'], 0));
 940                 } elseif (x($_SESSION, 'visitor_home')) {
 941                         // Remote user
 942                         $public_contact_id = intval(get_contact($_SESSION['visitor_home'], 0));
 943                 }
 944         } elseif (!x($_SESSION, 'authenticated')) {
 945                 $public_contact_id = false;
 946         }
 947
 948         return $public_contact_id;
 949 }
 950
 951 /**
 952  * @brief Returns contact id of authenticated site visitor or false
 953  *
 954  * @return int|bool visitor_id or false
 955  */
 956 function remote_user() {
 957         // You cannot be both local and remote
 958         if (local_user()) {
 959                 return false;
 960         }
 961         if ((x($_SESSION, 'authenticated')) && (x($_SESSION, 'visitor_id'))) {
 962                 return intval($_SESSION['visitor_id']);
 963         }
 964         return false;
 965 }
 966
 967 /**
 968  * @brief Show an error message to user.
 969  *
 970  * This function save text in session, to be shown to the user at next page load
 971  *
 972  * @param string $s - Text of notice
 973  */
 974 function notice($s) {
 975         $a = get_app();
 976         if (!x($_SESSION, 'sysmsg')) {
 977                 $_SESSION['sysmsg'] = array();
 978         }
 979         if ($a->interactive) {
 980                 $_SESSION['sysmsg'][] = $s;
 981         }
 982 }
 983
 984 /**
 985  * @brief Show an info message to user.
 986  *
 987  * This function save text in session, to be shown to the user at next page load
 988  *
 989  * @param string $s - Text of notice
 990  */
 991 function info($s) {
 992         $a = get_app();
 993
 994         if (local_user() && get_pconfig(local_user(), 'system', 'ignore_info')) {
 995                 return;
 996         }
 997
 998         if (!x($_SESSION, 'sysmsg_info')) {
 999                 $_SESSION['sysmsg_info'] = array();
1000         }
1001         if ($a->interactive) {
1002                 $_SESSION['sysmsg_info'][] = $s;
1003         }
1004 }
1005
1006 /**
1007  * @brief Wrapper around config to limit the text length of an incoming message
1008  *
1009  * @return int
1010  */
1011 function get_max_import_size() {
1012         $a = get_app();
1013         return ((x($a->config, 'max_import_size')) ? $a->config['max_import_size'] : 0 );
1014 }
1015
1016 /**
1017  * @brief Wrap calls to proc_close(proc_open()) and call hook
1018  *      so plugins can take part in process :)
1019  *
1020  * @param (integer|array) priority or parameter array, $cmd atrings are deprecated and are ignored
1021  *
1022  * next args are passed as $cmd command line
1023  * or: proc_run(PRIORITY_HIGH, "include/notifier.php", "drop", $drop_id);
1024  * or: proc_run(array('priority' => PRIORITY_HIGH, 'dont_fork' => true), "include/create_shadowentry.php", $post_id);
1025  *
1026  * @note $cmd and string args are surrounded with ""
1027  *
1028  * @hooks 'proc_run'
1029  *      array $arr
1030  *
1031  * @return boolean "false" if proc_run couldn't be executed
1032  */
1033 function proc_run($cmd) {
1034
1035         $a = get_app();
1036
1037         $proc_args = func_get_args();
1038
1039         $args = array();
1040         if (!count($proc_args)) {
1041                 return false;
1042         }
1043
1044         // Preserve the first parameter
1045         // It could contain a command, the priority or an parameter array
1046         // If we use the parameter array we have to protect it from the following function
1047         $run_parameter = array_shift($proc_args);
1048
1049         // expand any arrays
1050         foreach ($proc_args as $arg) {
1051                 if (is_array($arg)) {
1052                         foreach ($arg as $n) {
1053                                 $args[] = $n;
1054                         }
1055                 } else {
1056                         $args[] = $arg;
1057                 }
1058         }
1059
1060         // Now we add the run parameters back to the array
1061         array_unshift($args, $run_parameter);
1062
1063         $arr = array('args' => $args, 'run_cmd' => true);
1064
1065         call_hooks("proc_run", $arr);
1066         if (!$arr['run_cmd'] || ! count($args)) {
1067                 return true;
1068         }
1069
1070         $priority = PRIORITY_MEDIUM;
1071         $dont_fork = get_config("system", "worker_dont_fork");
1072         $created = datetime_convert();
1073
1074         if (is_int($run_parameter)) {
1075                 $priority = $run_parameter;
1076         } elseif (is_array($run_parameter)) {
1077                 if (isset($run_parameter['priority'])) {
1078                         $priority = $run_parameter['priority'];
1079                 }
1080                 if (isset($run_parameter['created'])) {
1081                         $created = $run_parameter['created'];
1082                 }
1083                 if (isset($run_parameter['dont_fork'])) {
1084                         $dont_fork = $run_parameter['dont_fork'];
1085                 }
1086         }
1087
1088         $argv = $args;
1089         array_shift($argv);
1090
1091         $parameters = json_encode($argv);
1092         $found = dba::exists('workerqueue', array('parameter' => $parameters, 'done' => false));
1093
1094         // Quit if there was a database error - a precaution for the update process to 3.5.3
1095         if (dba::errorNo() != 0) {
1096                 return false;
1097         }
1098
1099         if (!$found) {
1100                 dba::insert('workerqueue', array('parameter' => $parameters, 'created' => $created, 'priority' => $priority));
1101         }
1102
1103         // Should we quit and wait for the poller to be called as a cronjob?
1104         if ($dont_fork) {
1105                 return true;
1106         }
1107
1108         // If there is a lock then we don't have to check for too much worker
1109         if (!Lock::set('poller_worker', 0)) {
1110                 return true;
1111         }
1112
1113         // If there are already enough workers running, don't fork another one
1114         $quit = poller_too_much_workers();
1115         Lock::remove('poller_worker');
1116
1117         if ($quit) {
1118                 return true;
1119         }
1120
1121         // Now call the poller to execute the jobs that we just added to the queue
1122         $args = array("include/poller.php", "no_cron");
1123
1124         $a->proc_run($args);
1125
1126         return true;
1127 }
1128
1129 function current_theme() {
1130         $app_base_themes = array('duepuntozero', 'dispy', 'quattro');
1131
1132         $a = get_app();
1133
1134         $page_theme = null;
1135
1136         // Find the theme that belongs to the user whose stuff we are looking at
1137
1138         if ($a->profile_uid && ($a->profile_uid != local_user())) {
1139                 $r = q("select theme from user where uid = %d limit 1",
1140                         intval($a->profile_uid)
1141                 );
1142                 if (dbm::is_result($r)) {
1143                         $page_theme = $r[0]['theme'];
1144                 }
1145         }
1146
1147         // Allow folks to over-rule user themes and always use their own on their own site.
1148         // This works only if the user is on the same server
1149
1150         if ($page_theme && local_user() && (local_user() != $a->profile_uid)) {
1151                 if (get_pconfig(local_user(), 'system', 'always_my_theme')) {
1152                         $page_theme = null;
1153                 }
1154         }
1155
1156 //              $mobile_detect = new Mobile_Detect();
1157 //              $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
1158         $is_mobile = $a->is_mobile || $a->is_tablet;
1159
1160         $standard_system_theme = Config::get('system', 'theme', '');
1161         $standard_theme_name = ((isset($_SESSION) && x($_SESSION, 'theme')) ? $_SESSION['theme'] : $standard_system_theme);
1162
1163         if ($is_mobile) {
1164                 if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
1165                         $system_theme = $standard_system_theme;
1166                         $theme_name = $standard_theme_name;
1167                 } else {
1168                         $system_theme = Config::get('system', 'mobile-theme', '');
1169                         if ($system_theme == '') {
1170                                 $system_theme = $standard_system_theme;
1171                         }
1172                         $theme_name = ((isset($_SESSION) && x($_SESSION, 'mobile-theme')) ? $_SESSION['mobile-theme'] : $system_theme);
1173
1174                         if ($theme_name === '---') {
1175                                 // user has selected to have the mobile theme be the same as the normal one
1176                                 $system_theme = $standard_system_theme;
1177                                 $theme_name = $standard_theme_name;
1178
1179                                 if ($page_theme) {
1180                                         $theme_name = $page_theme;
1181                                 }
1182                         }
1183                 }
1184         } else {
1185                 $system_theme = $standard_system_theme;
1186                 $theme_name = $standard_theme_name;
1187
1188                 if ($page_theme) {
1189                         $theme_name = $page_theme;
1190                 }
1191         }
1192
1193         if ($theme_name &&
1194                 (file_exists('view/theme/' . $theme_name . '/style.css') ||
1195                 file_exists('view/theme/' . $theme_name . '/style.php'))) {
1196                 return($theme_name);
1197         }
1198
1199         foreach ($app_base_themes as $t) {
1200                 if (file_exists('view/theme/' . $t . '/style.css') ||
1201                         file_exists('view/theme/' . $t . '/style.php')) {
1202                         return($t);
1203                 }
1204         }
1205
1206         $fallback = array_merge(glob('view/theme/*/style.css'), glob('view/theme/*/style.php'));
1207         if (count($fallback)) {
1208                 return (str_replace('view/theme/', '', substr($fallback[0], 0, -10)));
1209         }
1210
1211         /// @TODO No final return statement?
1212 }
1213
1214 /**
1215  * @brief Return full URL to theme which is currently in effect.
1216  *
1217  * Provide a sane default if nothing is chosen or the specified theme does not exist.
1218  *
1219  * @return string
1220  */
1221 function current_theme_url() {
1222         $a = get_app();
1223
1224         $t = current_theme();
1225
1226         $opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : '');
1227         if (file_exists('view/theme/' . $t . '/style.php')) {
1228                 return('view/theme/' . $t . '/style.pcss' . $opts);
1229         }
1230
1231         return('view/theme/' . $t . '/style.css');
1232 }
1233
1234 function feed_birthday($uid, $tz) {
1235
1236         /**
1237          *
1238          * Determine the next birthday, but only if the birthday is published
1239          * in the default profile. We _could_ also look for a private profile that the
1240          * recipient can see, but somebody could get mad at us if they start getting
1241          * public birthday greetings when they haven't made this info public.
1242          *
1243          * Assuming we are able to publish this info, we are then going to convert
1244          * the start time from the owner's timezone to UTC.
1245          *
1246          * This will potentially solve the problem found with some social networks
1247          * where birthdays are converted to the viewer's timezone and salutations from
1248          * elsewhere in the world show up on the wrong day. We will convert it to the
1249          * viewer's timezone also, but first we are going to convert it from the birthday
1250          * person's timezone to GMT - so the viewer may find the birthday starting at
1251          * 6:00PM the day before, but that will correspond to midnight to the birthday person.
1252          *
1253          */
1254         $birthday = '';
1255
1256         if (!strlen($tz)) {
1257                 $tz = 'UTC';
1258         }
1259
1260         $p = q("SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1",
1261                         intval($uid)
1262         );
1263
1264         if (dbm::is_result($p)) {
1265                 $tmp_dob = substr($p[0]['dob'], 5);
1266                 if (intval($tmp_dob)) {
1267                         $y = datetime_convert($tz, $tz, 'now', 'Y');
1268                         $bd = $y . '-' . $tmp_dob . ' 00:00';
1269                         $t_dob = strtotime($bd);
1270                         $now = strtotime(datetime_convert($tz, $tz, 'now'));
1271                         if ($t_dob < $now) {
1272                                 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
1273                         }
1274                         $birthday = datetime_convert($tz, 'UTC', $bd, ATOM_TIME);
1275                 }
1276         }
1277
1278         return $birthday;
1279 }
1280
1281 /**
1282  * @brief Check if current user has admin role.
1283  *
1284  * @return bool true if user is an admin
1285  */
1286 function is_site_admin() {
1287         $a = get_app();
1288
1289         $adminlist = explode(",", str_replace(" ", "", $a->config['admin_email']));
1290
1291         //if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && ($a->user['email'] === $a->config['admin_email']))
1292         if (local_user() && x($a->user, 'email') && x($a->config, 'admin_email') && in_array($a->user['email'], $adminlist)) {
1293                 return true;
1294         }
1295         return false;
1296 }
1297
1298 /**
1299  * @brief Returns querystring as string from a mapped array.
1300  *
1301  * @param array $params mapped array with query parameters
1302  * @param string $name of parameter, default null
1303  *
1304  * @return string
1305  */
1306 function build_querystring($params, $name = null) {
1307         $ret = "";
1308         foreach ($params as $key => $val) {
1309                 if (is_array($val)) {
1310                         /// @TODO maybe not compare against null, use is_null()
1311                         if ($name == null) {
1312                                 $ret .= build_querystring($val, $key);
1313                         } else {
1314                                 $ret .= build_querystring($val, $name . "[$key]");
1315                         }
1316                 } else {
1317                         $val = urlencode($val);
1318                         /// @TODO maybe not compare against null, use is_null()
1319                         if ($name != null) {
1320                                 /// @TODO two string concated, can be merged to one
1321                                 $ret .= $name . "[$key]" . "=$val&";
1322                         } else {
1323                                 $ret .= "$key=$val&";
1324                         }
1325                 }
1326         }
1327         return $ret;
1328 }
1329
1330 function explode_querystring($query) {
1331         $arg_st = strpos($query, '?');
1332         if ($arg_st !== false) {
1333                 $base = substr($query, 0, $arg_st);
1334                 $arg_st += 1;
1335         } else {
1336                 $base = '';
1337                 $arg_st = 0;
1338         }
1339
1340         $args = explode('&', substr($query, $arg_st));
1341         foreach ($args as $k => $arg) {
1342                 /// @TODO really compare type-safe here?
1343                 if ($arg === '') {
1344                         unset($args[$k]);
1345                 }
1346         }
1347         $args = array_values($args);
1348
1349         if (!$base) {
1350                 $base = $args[0];
1351                 unset($args[0]);
1352                 $args = array_values($args);
1353         }
1354
1355         return array(
1356                 'base' => $base,
1357                 'args' => $args,
1358         );
1359 }
1360
1361 /**
1362  * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
1363  *
1364  * Taken from http://webcheatsheet.com/php/get_current_page_url.php
1365  */
1366 function curPageURL() {
1367         $pageURL = 'http';
1368         if ($_SERVER["HTTPS"] == "on") {
1369                 $pageURL .= "s";
1370         }
1371
1372         $pageURL .= "://";
1373
1374         if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
1375                 $pageURL .= $_SERVER["SERVER_NAME"] . ":" . $_SERVER["SERVER_PORT"] . $_SERVER["REQUEST_URI"];
1376         } else {
1377                 $pageURL .= $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"];
1378         }
1379         return $pageURL;
1380 }
1381
1382 function random_digits($digits) {
1383         $rn = '';
1384         for ($i = 0; $i < $digits; $i++) {
1385                 /// @TODO rand() is different to mt_rand() and maybe lesser "random"
1386                 $rn .= rand(0, 9);
1387         }
1388         return $rn;
1389 }
1390
1391 function get_server() {
1392         $server = get_config("system", "directory");
1393
1394         if ($server == "") {
1395                 $server = "http://dir.friendica.social";
1396         }
1397
1398         return($server);
1399 }
1400
1401 function get_temppath() {
1402         $a = get_app();
1403
1404         $temppath = get_config("system", "temppath");
1405
1406         if (($temppath != "") && App::directory_usable($temppath)) {
1407                 // We have a temp path and it is usable
1408                 return App::realpath($temppath);
1409         }
1410
1411         // We don't have a working preconfigured temp path, so we take the system path.
1412         $temppath = sys_get_temp_dir();
1413
1414         // Check if it is usable
1415         if (($temppath != "") && App::directory_usable($temppath)) {
1416                 // Always store the real path, not the path through symlinks
1417                 $temppath = App::realpath($temppath);
1418
1419                 // To avoid any interferences with other systems we create our own directory
1420                 $new_temppath = $temppath . "/" . $a->get_hostname();
1421                 if (!is_dir($new_temppath)) {
1422                         /// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
1423                         mkdir($new_temppath);
1424                 }
1425
1426                 if (App::directory_usable($new_temppath)) {
1427                         // The new path is usable, we are happy
1428                         set_config("system", "temppath", $new_temppath);
1429                         return $new_temppath;
1430                 } else {
1431                         // We can't create a subdirectory, strange.
1432                         // But the directory seems to work, so we use it but don't store it.
1433                         return $temppath;
1434                 }
1435         }
1436
1437         // Reaching this point means that the operating system is configured badly.
1438         return '';
1439 }
1440
1441 function get_cachefile($file, $writemode = true) {
1442         $cache = get_itemcachepath();
1443
1444         if ((!$cache) || (!is_dir($cache))) {
1445                 return("");
1446         }
1447
1448         $subfolder = $cache . "/" . substr($file, 0, 2);
1449
1450         $cachepath = $subfolder . "/" . $file;
1451
1452         if ($writemode) {
1453                 if (!is_dir($subfolder)) {
1454                         mkdir($subfolder);
1455                         chmod($subfolder, 0777);
1456                 }
1457         }
1458
1459         /// @TODO no need to put braces here
1460         return $cachepath;
1461 }
1462
1463 function clear_cache($basepath = "", $path = "") {
1464         if ($path == "") {
1465                 $basepath = get_itemcachepath();
1466                 $path = $basepath;
1467         }
1468
1469         if (($path == "") || (!is_dir($path))) {
1470                 return;
1471         }
1472
1473         if (substr(realpath($path), 0, strlen($basepath)) != $basepath) {
1474                 return;
1475         }
1476
1477         $cachetime = (int) get_config('system', 'itemcache_duration');
1478         if ($cachetime == 0) {
1479                 $cachetime = 86400;
1480         }
1481
1482         if (is_writable($path)) {
1483                 if ($dh = opendir($path)) {
1484                         while (($file = readdir($dh)) !== false) {
1485                                 $fullpath = $path . "/" . $file;
1486                                 if ((filetype($fullpath) == "dir") && ($file != ".") && ($file != "..")) {
1487                                         clear_cache($basepath, $fullpath);
1488                                 }
1489                                 if ((filetype($fullpath) == "file") && (filectime($fullpath) < (time() - $cachetime))) {
1490                                         unlink($fullpath);
1491                                 }
1492                         }
1493                         closedir($dh);
1494                 }
1495         }
1496 }
1497
1498 function get_itemcachepath() {
1499         // Checking, if the cache is deactivated
1500         $cachetime = (int) get_config('system', 'itemcache_duration');
1501         if ($cachetime < 0) {
1502                 return "";
1503         }
1504
1505         $itemcache = get_config('system', 'itemcache');
1506         if (($itemcache != "") && App::directory_usable($itemcache)) {
1507                 return App::realpath($itemcache);
1508         }
1509
1510         $temppath = get_temppath();
1511
1512         if ($temppath != "") {
1513                 $itemcache = $temppath . "/itemcache";
1514                 if (!file_exists($itemcache) && !is_dir($itemcache)) {
1515                         mkdir($itemcache);
1516                 }
1517
1518                 if (App::directory_usable($itemcache)) {
1519                         set_config("system", "itemcache", $itemcache);
1520                         return $itemcache;
1521                 }
1522         }
1523         return "";
1524 }
1525
1526 /**
1527  * @brief Returns the path where spool files are stored
1528  *
1529  * @return string Spool path
1530  */
1531 function get_spoolpath() {
1532         $spoolpath = get_config('system', 'spoolpath');
1533         if (($spoolpath != "") && App::directory_usable($spoolpath)) {
1534                 // We have a spool path and it is usable
1535                 return $spoolpath;
1536         }
1537
1538         // We don't have a working preconfigured spool path, so we take the temp path.
1539         $temppath = get_temppath();
1540
1541         if ($temppath != "") {
1542                 // To avoid any interferences with other systems we create our own directory
1543                 $spoolpath = $temppath . "/spool";
1544                 if (!is_dir($spoolpath)) {
1545                         mkdir($spoolpath);
1546                 }
1547
1548                 if (App::directory_usable($spoolpath)) {
1549                         // The new path is usable, we are happy
1550                         set_config("system", "spoolpath", $spoolpath);
1551                         return $spoolpath;
1552                 } else {
1553                         // We can't create a subdirectory, strange.
1554                         // But the directory seems to work, so we use it but don't store it.
1555                         return $temppath;
1556                 }
1557         }
1558
1559         // Reaching this point means that the operating system is configured badly.
1560         return "";
1561 }
1562
1563 /// @deprecated
1564 function set_template_engine(App $a, $engine = 'internal') {
1565 /// @note This function is no longer necessary, but keep it as a wrapper to the class method
1566 /// to avoid breaking themes again unnecessarily
1567 /// @TODO maybe output a warning here so the theme developer can see it? PHP won't show such warnings like Java does.
1568
1569         $a->set_template_engine($engine);
1570 }
1571
1572 if (!function_exists('exif_imagetype')) {
1573         function exif_imagetype($file) {
1574                 $size = getimagesize($file);
1575                 return $size[2];
1576         }
1577 }
1578
1579 function validate_include(&$file) {
1580         $orig_file = $file;
1581
1582         $file = realpath($file);
1583
1584         if (strpos($file, getcwd()) !== 0) {
1585                 return false;
1586         }
1587
1588         $file = str_replace(getcwd() . "/", "", $file, $count);
1589         if ($count != 1) {
1590                 return false;
1591         }
1592
1593         if ($orig_file !== $file) {
1594                 return false;
1595         }
1596
1597         $valid = false;
1598         if (strpos($file, "include/") === 0) {
1599                 $valid = true;
1600         }
1601
1602         if (strpos($file, "addon/") === 0) {
1603                 $valid = true;
1604         }
1605
1606         // Simply return flag
1607         return ($valid);
1608 }
1609
1610 function current_load() {
1611         if (!function_exists('sys_getloadavg')) {
1612                 return false;
1613         }
1614
1615         $load_arr = sys_getloadavg();
1616
1617         if (!is_array($load_arr)) {
1618                 return false;
1619         }
1620
1621         return max($load_arr[0], $load_arr[1]);
1622 }
1623
1624 /**
1625  * @brief get c-style args
1626  *
1627  * @return int
1628  */
1629 function argc() {
1630         return get_app()->argc;
1631 }
1632
1633 /**
1634  * @brief Returns the value of a argv key
1635  *
1636  * @param int $x argv key
1637  * @return string Value of the argv key
1638  */
1639 function argv($x) {
1640         if (array_key_exists($x, get_app()->argv)) {
1641                 return get_app()->argv[$x];
1642         }
1643
1644         return '';
1645 }
1646
1647 /**
1648  * @brief Get the data which is needed for infinite scroll
1649  *
1650  * For invinite scroll we need the page number of the actual page
1651  * and the the URI where the content of the next page comes from.
1652  * This data is needed for the js part in main.js.
1653  * Note: infinite scroll does only work for the network page (module)
1654  *
1655  * @param string $module The name of the module (e.g. "network")
1656  * @return array Of infinite scroll data
1657  *      'pageno' => $pageno The number of the actual page
1658  *      'reload_uri' => $reload_uri The URI of the content we have to load
1659  */
1660 function infinite_scroll_data($module) {
1661
1662         if (get_pconfig(local_user(), 'system', 'infinite_scroll')
1663                 && ($module == "network") && ($_GET["mode"] != "minimal")) {
1664
1665                 // get the page number
1666                 if (is_string($_GET["page"])) {
1667                         $pageno = $_GET["page"];
1668                 } else {
1669                         $pageno = 1;
1670                 }
1671
1672                 $reload_uri = "";
1673
1674                 // try to get the uri from which we load the content
1675                 foreach ($_GET AS $param => $value) {
1676                         if (($param != "page") && ($param != "q")) {
1677                                 $reload_uri .= "&" . $param . "=" . urlencode($value);
1678                         }
1679                 }
1680
1681                 if (($a->page_offset != "") && ! strstr($reload_uri, "&offset=")) {
1682                         $reload_uri .= "&offset=" . urlencode($a->page_offset);
1683                 }
1684
1685                 $arr = array("pageno" => $pageno, "reload_uri" => $reload_uri);
1686
1687                 return $arr;
1688         }
1689 }