boot.php

   1 <?php
   2 /** @file boot.php
   3  *
   4  * This file defines some global constants and includes the central App class.
   5  */
   6
   7 /**
   8  * Friendica
   9  *
  10  * Friendica is a communications platform for integrated social communications
  11  * utilising decentralised communications and linkage to several indie social
  12  * projects - as well as popular mainstream providers.
  13  *
  14  * Our mission is to free our friends and families from the clutches of
  15  * data-harvesting corporations, and pave the way to a future where social
  16  * communications are free and open and flow between alternate providers as
  17  * easily as email does today.
  18  */
  19
  20 require_once('include/autoloader.php');
  21
  22 use \Friendica\Core\Config;
  23
  24 require_once('include/config.php');
  25 require_once('include/network.php');
  26 require_once('include/plugin.php');
  27 require_once('include/text.php');
  28 require_once('include/datetime.php');
  29 require_once('include/pgettext.php');
  30 require_once('include/nav.php');
  31 require_once('include/cache.php');
  32 require_once('library/Mobile_Detect/Mobile_Detect.php');
  33 require_once('include/features.php');
  34 require_once('include/identity.php');
  35 require_once('update.php');
  36 require_once('include/dbstructure.php');
  37
  38 define ( 'FRIENDICA_PLATFORM',     'Friendica');
  39 define ( 'FRIENDICA_CODENAME',     'Asparagus');
  40 define ( 'FRIENDICA_VERSION',      '3.5.2-dev' );
  41 define ( 'DFRN_PROTOCOL_VERSION',  '2.23'    );
  42 define ( 'DB_UPDATE_VERSION',      1216      );
  43
  44 /**
  45  * @brief Constant with a HTML line break.
  46  *
  47  * Contains a HTML line break (br) element and a real carriage return with line
  48  * feed for the source.
  49  * This can be used in HTML and JavaScript where needed a line break.
  50  */
  51 define ( 'EOL',                    "<br />\r\n"     );
  52 define ( 'ATOM_TIME',              'Y-m-d\TH:i:s\Z' );
  53
  54
  55 /**
  56  * @brief Image storage quality.
  57  *
  58  * Lower numbers save space at cost of image detail.
  59  * For ease of upgrade, please do not change here. Change jpeg quality with
  60  * $a->config['system']['jpeg_quality'] = n;
  61  * in .htconfig.php, where n is netween 1 and 100, and with very poor results
  62  * below about 50
  63  *
  64  */
  65
  66 define ( 'JPEG_QUALITY',            100  );
  67 /**
  68  * $a->config['system']['png_quality'] from 0 (uncompressed) to 9
  69  */
  70 define ( 'PNG_QUALITY',             8  );
  71
  72 /**
  73  *
  74  * An alternate way of limiting picture upload sizes. Specify the maximum pixel
  75  * length that pictures are allowed to be (for non-square pictures, it will apply
  76  * to the longest side). Pictures longer than this length will be resized to be
  77  * this length (on the longest side, the other side will be scaled appropriately).
  78  * Modify this value using
  79  *
  80  *    $a->config['system']['max_image_length'] = n;
  81  *
  82  * in .htconfig.php
  83  *
  84  * If you don't want to set a maximum length, set to -1. The default value is
  85  * defined by 'MAX_IMAGE_LENGTH' below.
  86  *
  87  */
  88 define ( 'MAX_IMAGE_LENGTH',        -1  );
  89
  90
  91 /**
  92  * Not yet used
  93  */
  94
  95 define ( 'DEFAULT_DB_ENGINE',  'MyISAM'  );
  96
  97 /**
  98  * @name SSL Policy
  99  *
 100  * SSL redirection policies
 101  * @{
 102  */
 103 define ( 'SSL_POLICY_NONE',         0 );
 104 define ( 'SSL_POLICY_FULL',         1 );
 105 define ( 'SSL_POLICY_SELFSIGN',     2 );
 106 /* @}*/
 107
 108 /**
 109  * @name Logger
 110  *
 111  * log levels
 112  * @{
 113  */
 114 define ( 'LOGGER_NORMAL',          0 );
 115 define ( 'LOGGER_TRACE',           1 );
 116 define ( 'LOGGER_DEBUG',           2 );
 117 define ( 'LOGGER_DATA',            3 );
 118 define ( 'LOGGER_ALL',             4 );
 119 /* @}*/
 120
 121 /**
 122  * @name Cache
 123  *
 124  * Cache levels
 125  * @{
 126  */
 127 define ( 'CACHE_MONTH',            0 );
 128 define ( 'CACHE_WEEK',             1 );
 129 define ( 'CACHE_DAY',              2 );
 130 define ( 'CACHE_HOUR',             3 );
 131 define ( 'CACHE_HALF_HOUR',        4 );
 132 define ( 'CACHE_QUARTER_HOUR',     5 );
 133 define ( 'CACHE_FIVE_MINUTES',     6 );
 134 define ( 'CACHE_MINUTE',           7 );
 135 /* @}*/
 136
 137 /**
 138  * @name Register
 139  *
 140  * Registration policies
 141  * @{
 142  */
 143 define ( 'REGISTER_CLOSED',        0 );
 144 define ( 'REGISTER_APPROVE',       1 );
 145 define ( 'REGISTER_OPEN',          2 );
 146 /** @}*/
 147
 148 /**
 149  * @name Contact_is
 150  *
 151  * Relationship types
 152  * @{
 153  */
 154 define ( 'CONTACT_IS_FOLLOWER', 1);
 155 define ( 'CONTACT_IS_SHARING',  2);
 156 define ( 'CONTACT_IS_FRIEND',   3);
 157 /** @}*/
 158
 159 /**
 160  * @name Update
 161  *
 162  * DB update return values
 163  * @{
 164  */
 165 define ( 'UPDATE_SUCCESS', 0);
 166 define ( 'UPDATE_FAILED',  1);
 167 /** @}*/
 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 Network
 224  *
 225  * Network and protocol family types
 226  * @{
 227  */
 228 define ( 'NETWORK_DFRN',             'dfrn');    // Friendica, Mistpark, other DFRN implementations
 229 define ( 'NETWORK_ZOT',              'zot!');    // Zot!
 230 define ( 'NETWORK_OSTATUS',          'stat');    // status.net, identi.ca, GNU-social, other OStatus implementations
 231 define ( 'NETWORK_FEED',             'feed');    // RSS/Atom feeds with no known "post/notify" protocol
 232 define ( 'NETWORK_DIASPORA',         'dspr');    // Diaspora
 233 define ( 'NETWORK_MAIL',             'mail');    // IMAP/POP
 234 define ( 'NETWORK_MAIL2',            'mai2');    // extended IMAP/POP
 235 define ( 'NETWORK_FACEBOOK',         'face');    // Facebook API
 236 define ( 'NETWORK_LINKEDIN',         'lnkd');    // LinkedIn
 237 define ( 'NETWORK_XMPP',             'xmpp');    // XMPP
 238 define ( 'NETWORK_MYSPACE',          'mysp');    // MySpace
 239 define ( 'NETWORK_GPLUS',            'goog');    // Google+
 240 define ( 'NETWORK_PUMPIO',           'pump');    // pump.io
 241 define ( 'NETWORK_TWITTER',          'twit');    // Twitter
 242 define ( 'NETWORK_DIASPORA2',        'dspc');    // Diaspora connector
 243 define ( 'NETWORK_STATUSNET',        'stac');    // Statusnet connector
 244 define ( 'NETWORK_APPNET',           'apdn');    // app.net
 245 define ( 'NETWORK_NEWS',             'nntp');    // Network News Transfer Protocol
 246 define ( 'NETWORK_ICALENDAR',        'ical');    // iCalendar
 247 define ( 'NETWORK_PNUT',             'pnut');    // pnut.io
 248 define ( 'NETWORK_PHANTOM',          'unkn');    // Place holder
 249 /** @}*/
 250
 251 /**
 252  * These numbers are used in stored permissions
 253  * and existing allocations MUST NEVER BE CHANGED
 254  * OR RE-ASSIGNED! You may only add to them.
 255  */
 256 $netgroup_ids = array(
 257         NETWORK_DFRN     => (-1),
 258         NETWORK_ZOT      => (-2),
 259         NETWORK_OSTATUS  => (-3),
 260         NETWORK_FEED     => (-4),
 261         NETWORK_DIASPORA => (-5),
 262         NETWORK_MAIL     => (-6),
 263         NETWORK_MAIL2    => (-7),
 264         NETWORK_FACEBOOK => (-8),
 265         NETWORK_LINKEDIN => (-9),
 266         NETWORK_XMPP     => (-10),
 267         NETWORK_MYSPACE  => (-11),
 268         NETWORK_GPLUS    => (-12),
 269         NETWORK_PUMPIO   => (-13),
 270         NETWORK_TWITTER  => (-14),
 271         NETWORK_DIASPORA2 => (-15),
 272         NETWORK_STATUSNET => (-16),
 273         NETWORK_APPNET    => (-17),
 274         NETWORK_NEWS      => (-18),
 275         NETWORK_ICALENDAR => (-19),
 276         NETWORK_PNUT      => (-20),
 277
 278         NETWORK_PHANTOM  => (-127),
 279 );
 280
 281
 282 /**
 283  * Maximum number of "people who like (or don't like) this"  that we will list by name
 284  */
 285
 286 define ( 'MAX_LIKERS',    75);
 287
 288 /**
 289  * Communication timeout
 290  */
 291
 292 define ( 'ZCURL_TIMEOUT' , (-1));
 293
 294
 295 /**
 296  * @name Notify
 297  *
 298  * Email notification options
 299  * @{
 300  */
 301 define ( 'NOTIFY_INTRO',    0x0001 );
 302 define ( 'NOTIFY_CONFIRM',  0x0002 );
 303 define ( 'NOTIFY_WALL',     0x0004 );
 304 define ( 'NOTIFY_COMMENT',  0x0008 );
 305 define ( 'NOTIFY_MAIL',     0x0010 );
 306 define ( 'NOTIFY_SUGGEST',  0x0020 );
 307 define ( 'NOTIFY_PROFILE',  0x0040 );
 308 define ( 'NOTIFY_TAGSELF',  0x0080 );
 309 define ( 'NOTIFY_TAGSHARE', 0x0100 );
 310 define ( 'NOTIFY_POKE',     0x0200 );
 311 define ( 'NOTIFY_SHARE',    0x0400 );
 312
 313 define ( 'NOTIFY_SYSTEM',   0x8000 );
 314 /* @}*/
 315
 316
 317 /**
 318  * @name Term
 319  *
 320  * Tag/term types
 321  * @{
 322  */
 323 define ( 'TERM_UNKNOWN',   0 );
 324 define ( 'TERM_HASHTAG',   1 );
 325 define ( 'TERM_MENTION',   2 );
 326 define ( 'TERM_CATEGORY',  3 );
 327 define ( 'TERM_PCATEGORY', 4 );
 328 define ( 'TERM_FILE',      5 );
 329 define ( 'TERM_SAVEDSEARCH', 6 );
 330 define ( 'TERM_CONVERSATION', 7 );
 331
 332 define ( 'TERM_OBJ_POST',  1 );
 333 define ( 'TERM_OBJ_PHOTO', 2 );
 334
 335
 336
 337 /**
 338  * @name Namespaces
 339  *
 340  * Various namespaces we may need to parse
 341  * @{
 342  */
 343 define ( 'NAMESPACE_ZOT',             'http://purl.org/zot' );
 344 define ( 'NAMESPACE_DFRN' ,           'http://purl.org/macgirvin/dfrn/1.0' );
 345 define ( 'NAMESPACE_THREAD' ,         'http://purl.org/syndication/thread/1.0' );
 346 define ( 'NAMESPACE_TOMB' ,           'http://purl.org/atompub/tombstones/1.0' );
 347 define ( 'NAMESPACE_ACTIVITY',        'http://activitystrea.ms/spec/1.0/' );
 348 define ( 'NAMESPACE_ACTIVITY_SCHEMA', 'http://activitystrea.ms/schema/1.0/' );
 349 define ( 'NAMESPACE_MEDIA',           'http://purl.org/syndication/atommedia' );
 350 define ( 'NAMESPACE_SALMON_ME',       'http://salmon-protocol.org/ns/magic-env' );
 351 define ( 'NAMESPACE_OSTATUSSUB',      'http://ostatus.org/schema/1.0/subscribe' );
 352 define ( 'NAMESPACE_GEORSS',          'http://www.georss.org/georss' );
 353 define ( 'NAMESPACE_POCO',            'http://portablecontacts.net/spec/1.0' );
 354 define ( 'NAMESPACE_FEED',            'http://schemas.google.com/g/2010#updates-from' );
 355 define ( 'NAMESPACE_OSTATUS',         'http://ostatus.org/schema/1.0' );
 356 define ( 'NAMESPACE_STATUSNET',       'http://status.net/schema/api/1/' );
 357 define ( 'NAMESPACE_ATOM1',           'http://www.w3.org/2005/Atom' );
 358 /* @}*/
 359
 360 /**
 361  * @name Activity
 362  *
 363  * Activity stream defines
 364  * @{
 365  */
 366 define ( 'ACTIVITY_LIKE',        NAMESPACE_ACTIVITY_SCHEMA . 'like' );
 367 define ( 'ACTIVITY_DISLIKE',     NAMESPACE_DFRN            . '/dislike' );
 368 define ( 'ACTIVITY_ATTEND',      NAMESPACE_ZOT             . '/activity/attendyes' );
 369 define ( 'ACTIVITY_ATTENDNO',    NAMESPACE_ZOT             . '/activity/attendno' );
 370 define ( 'ACTIVITY_ATTENDMAYBE', NAMESPACE_ZOT             . '/activity/attendmaybe' );
 371
 372 define ( 'ACTIVITY_OBJ_HEART',   NAMESPACE_DFRN            . '/heart' );
 373
 374 define ( 'ACTIVITY_FRIEND',      NAMESPACE_ACTIVITY_SCHEMA . 'make-friend' );
 375 define ( 'ACTIVITY_REQ_FRIEND',  NAMESPACE_ACTIVITY_SCHEMA . 'request-friend' );
 376 define ( 'ACTIVITY_UNFRIEND',    NAMESPACE_ACTIVITY_SCHEMA . 'remove-friend' );
 377 define ( 'ACTIVITY_FOLLOW',      NAMESPACE_ACTIVITY_SCHEMA . 'follow' );
 378 define ( 'ACTIVITY_UNFOLLOW',    NAMESPACE_ACTIVITY_SCHEMA . 'stop-following' );
 379 define ( 'ACTIVITY_JOIN',        NAMESPACE_ACTIVITY_SCHEMA . 'join' );
 380
 381 define ( 'ACTIVITY_POST',        NAMESPACE_ACTIVITY_SCHEMA . 'post' );
 382 define ( 'ACTIVITY_UPDATE',      NAMESPACE_ACTIVITY_SCHEMA . 'update' );
 383 define ( 'ACTIVITY_TAG',         NAMESPACE_ACTIVITY_SCHEMA . 'tag' );
 384 define ( 'ACTIVITY_FAVORITE',    NAMESPACE_ACTIVITY_SCHEMA . 'favorite' );
 385 define ( 'ACTIVITY_SHARE',       NAMESPACE_ACTIVITY_SCHEMA . 'share' );
 386
 387 define ( 'ACTIVITY_POKE',        NAMESPACE_ZOT . '/activity/poke' );
 388 define ( 'ACTIVITY_MOOD',        NAMESPACE_ZOT . '/activity/mood' );
 389
 390 define ( 'ACTIVITY_OBJ_BOOKMARK', NAMESPACE_ACTIVITY_SCHEMA . 'bookmark' );
 391 define ( 'ACTIVITY_OBJ_COMMENT', NAMESPACE_ACTIVITY_SCHEMA . 'comment' );
 392 define ( 'ACTIVITY_OBJ_NOTE',    NAMESPACE_ACTIVITY_SCHEMA . 'note' );
 393 define ( 'ACTIVITY_OBJ_PERSON',  NAMESPACE_ACTIVITY_SCHEMA . 'person' );
 394 define ( 'ACTIVITY_OBJ_IMAGE',   NAMESPACE_ACTIVITY_SCHEMA . 'image' );
 395 define ( 'ACTIVITY_OBJ_PHOTO',   NAMESPACE_ACTIVITY_SCHEMA . 'photo' );
 396 define ( 'ACTIVITY_OBJ_VIDEO',   NAMESPACE_ACTIVITY_SCHEMA . 'video' );
 397 define ( 'ACTIVITY_OBJ_P_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'profile-photo' );
 398 define ( 'ACTIVITY_OBJ_ALBUM',   NAMESPACE_ACTIVITY_SCHEMA . 'photo-album' );
 399 define ( 'ACTIVITY_OBJ_EVENT',   NAMESPACE_ACTIVITY_SCHEMA . 'event' );
 400 define ( 'ACTIVITY_OBJ_GROUP',   NAMESPACE_ACTIVITY_SCHEMA . 'group' );
 401 define ( 'ACTIVITY_OBJ_TAGTERM', NAMESPACE_DFRN            . '/tagterm' );
 402 define ( 'ACTIVITY_OBJ_PROFILE', NAMESPACE_DFRN            . '/profile' );
 403 define ( 'ACTIVITY_OBJ_QUESTION', 'http://activityschema.org/object/question' );
 404 /* @}*/
 405
 406 /**
 407  * @name Gravity
 408  *
 409  * Item weight for query ordering
 410  * @{
 411  */
 412 define ( 'GRAVITY_PARENT',       0);
 413 define ( 'GRAVITY_LIKE',         3);
 414 define ( 'GRAVITY_COMMENT',      6);
 415 /* @}*/
 416
 417 /**
 418  * @name Priority
 419  *
 420  * Process priority for the worker
 421  * @{
 422  */
 423 define('PRIORITY_UNDEFINED',  0);
 424 define('PRIORITY_CRITICAL',  10);
 425 define('PRIORITY_HIGH',      20);
 426 define('PRIORITY_MEDIUM',    30);
 427 define('PRIORITY_LOW',       40);
 428 define('PRIORITY_NEGLIGIBLE',50);
 429 /* @}*/
 430
 431 /**
 432  * @name Social Relay settings
 433  *
 434  * See here: https://github.com/jaywink/social-relay
 435  * and here: https://wiki.diasporafoundation.org/Relay_servers_for_public_posts
 436  * @{
 437  */
 438 define('SR_SCOPE_NONE', '');
 439 define('SR_SCOPE_ALL',  'all');
 440 define('SR_SCOPE_TAGS', 'tags');
 441 /* @}*/
 442
 443 /**
 444  * Lowest possible date time value
 445  */
 446
 447 define ('NULL_DATE', '0001-01-01 00:00:00');
 448
 449
 450 // Normally this constant is defined - but not if "pcntl" isn't installed
 451 if (!defined("SIGTERM")) {
 452         define("SIGTERM", 15);
 453 }
 454 /**
 455  *
 456  * Reverse the effect of magic_quotes_gpc if it is enabled.
 457  * Please disable magic_quotes_gpc so we don't have to do this.
 458  * See http://php.net/manual/en/security.magicquotes.disabling.php
 459  *
 460  */
 461
 462 function startup() {
 463
 464         error_reporting(E_ERROR | E_WARNING | E_PARSE);
 465
 466         set_time_limit(0);
 467
 468         // This has to be quite large to deal with embedded private photos
 469         ini_set('pcre.backtrack_limit', 500000);
 470
 471
 472         if (get_magic_quotes_gpc()) {
 473                 $process = array(&$_GET, &$_POST, &$_COOKIE, &$_REQUEST);
 474                 while (list($key, $val) = each($process)) {
 475                         foreach ($val as $k => $v) {
 476                                 unset($process[$key][$k]);
 477                                 if (is_array($v)) {
 478                                         $process[$key][stripslashes($k)] = $v;
 479                                         $process[] = &$process[$key][stripslashes($k)];
 480                                 } else {
 481                                         $process[$key][stripslashes($k)] = stripslashes($v);
 482                                 }
 483                         }
 484                 }
 485                 unset($process);
 486         }
 487
 488 }
 489
 490 /**
 491  *
 492  * class: App
 493  *
 494  * @brief Our main application structure for the life of this page.
 495  *
 496  * Primarily deals with the URL that got us here
 497  * and tries to make some sense of it, and
 498  * stores our page contents and config storage
 499  * and anything else that might need to be passed around
 500  * before we spit the page out.
 501  *
 502  */
 503 class App {
 504
 505         /// @TODO decide indending as a colorful mixure is ahead ...
 506         public  $module_loaded = false;
 507         public  $query_string;
 508         public  $config;
 509         public  $page;
 510         public  $profile;
 511         public  $profile_uid;
 512         public  $user;
 513         public  $cid;
 514         public  $contact;
 515         public  $contacts;
 516         public  $page_contact;
 517         public  $content;
 518         public  $data = array();
 519         public  $error = false;
 520         public  $cmd;
 521         public  $argv;
 522         public  $argc;
 523         public  $module;
 524         public  $pager;
 525         public  $strings;
 526         public  $path;
 527         public  $hooks;
 528         public  $timezone;
 529         public  $interactive = true;
 530         public  $plugins;
 531         public  $apps = array();
 532         public  $identities;
 533         public  $is_mobile = false;
 534         public  $is_tablet = false;
 535         public  $is_friendica_app;
 536         public  $performance = array();
 537         public  $callstack = array();
 538         public  $theme_info = array();
 539         public  $backend = true;
 540
 541         public $nav_sel;
 542
 543         public $category;
 544
 545
 546         // Allow themes to control internal parameters
 547         // by changing App values in theme.php
 548
 549         public  $sourcename = '';
 550         public  $videowidth = 425;
 551         public  $videoheight = 350;
 552         public  $force_max_items = 0;
 553         public  $theme_thread_allow = true;
 554         public  $theme_events_in_profile = true;
 555
 556         /**
 557          * @brief An array for all theme-controllable parameters
 558          *
 559          * Mostly unimplemented yet. Only options 'template_engine' and
 560          * beyond are used.
 561          */
 562         public  $theme = array(
 563                 'sourcename'      => '',
 564                 'videowidth'      => 425,
 565                 'videoheight'     => 350,
 566                 'force_max_items' => 0,
 567                 'thread_allow'    => true,
 568                 'stylesheet'      => '',
 569                 'template_engine' => 'smarty3',
 570         );
 571
 572         /**
 573          * @brief An array of registered template engines ('name'=>'class name')
 574          */
 575         public $template_engines = array();
 576         /**
 577          * @brief An array of instanced template engines ('name'=>'instance')
 578          */
 579         public $template_engine_instance = array();
 580
 581         public $process_id;
 582
 583         private $ldelim = array(
 584                 'internal' => '',
 585                 'smarty3' => '{{'
 586         );
 587         private $rdelim = array(
 588                 'internal' => '',
 589                 'smarty3' => '}}'
 590         );
 591
 592         private $scheme;
 593         private $hostname;
 594         private $db;
 595
 596         private $curl_code;
 597         private $curl_content_type;
 598         private $curl_headers;
 599
 600         private $cached_profile_image;
 601         private $cached_profile_picdate;
 602
 603         private static $a;
 604
 605         /**
 606          * @brief App constructor.
 607          */
 608         function __construct() {
 609
 610                 global $default_timezone;
 611
 612                 $hostname = "";
 613
 614                 if (file_exists(".htpreconfig.php")) {
 615                         include ".htpreconfig.php";
 616                 }
 617
 618                 $this->timezone = ((x($default_timezone)) ? $default_timezone : 'UTC');
 619
 620                 date_default_timezone_set($this->timezone);
 621
 622                 $this->performance["start"] = microtime(true);
 623                 $this->performance["database"] = 0;
 624                 $this->performance["database_write"] = 0;
 625                 $this->performance["network"] = 0;
 626                 $this->performance["file"] = 0;
 627                 $this->performance["rendering"] = 0;
 628                 $this->performance["parser"] = 0;
 629                 $this->performance["marktime"] = 0;
 630                 $this->performance["markstart"] = microtime(true);
 631
 632                 $this->callstack["database"] = array();
 633                 $this->callstack["database_write"] = array();
 634                 $this->callstack["network"] = array();
 635                 $this->callstack["file"] = array();
 636                 $this->callstack["rendering"] = array();
 637                 $this->callstack["parser"] = array();
 638
 639                 $this->config = array();
 640                 $this->page = array();
 641                 $this->pager= array();
 642
 643                 $this->query_string = '';
 644
 645                 $this->process_id = uniqid("log", true);
 646
 647                 startup();
 648
 649                 set_include_path(
 650                                 'include' . PATH_SEPARATOR
 651                                 . 'library' . PATH_SEPARATOR
 652                                 . 'library/phpsec' . PATH_SEPARATOR
 653                                 . 'library/langdet' . PATH_SEPARATOR
 654                                 . '.' );
 655
 656
 657                 $this->scheme = 'http';
 658
 659                 if ((x($_SERVER, 'HTTPS') && $_SERVER['HTTPS']) ||
 660                                 (x($_SERVER, 'HTTP_FORWARDED') && preg_match("/proto=https/", $_SERVER['HTTP_FORWARDED'])) ||
 661                                 (x($_SERVER, 'HTTP_X_FORWARDED_PROTO') && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https') ||
 662                                 (x($_SERVER, 'HTTP_X_FORWARDED_SSL') && $_SERVER['HTTP_X_FORWARDED_SSL'] == 'on') ||
 663                                 (x($_SERVER, 'FRONT_END_HTTPS') && $_SERVER['FRONT_END_HTTPS'] == 'on') ||
 664                                 (x($_SERVER, 'SERVER_PORT') && (intval($_SERVER['SERVER_PORT']) == 443)) // XXX: reasonable assumption, but isn't this hardcoding too much?
 665                                 ) {
 666                         $this->scheme = 'https';
 667                 }
 668
 669                 if (x($_SERVER, 'SERVER_NAME')) {
 670                         $this->hostname = $_SERVER['SERVER_NAME'];
 671
 672                         if (x($_SERVER, 'SERVER_PORT') && $_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443) {
 673                                 $this->hostname .= ':' . $_SERVER['SERVER_PORT'];
 674                         }
 675                         /*
 676                          * Figure out if we are running at the top of a domain
 677                          * or in a sub-directory and adjust accordingly
 678                          */
 679
 680                         /// @TODO This kind of escaping breaks syntax-highlightning on CoolEdit (Midnight Commander)
 681                         $path = trim(dirname($_SERVER['SCRIPT_NAME']), '/\\');
 682                         if (isset($path) && strlen($path) && ($path != $this->path)) {
 683                                 $this->path = $path;
 684                         }
 685                 }
 686
 687                 if ($hostname != "") {
 688                         $this->hostname = $hostname;
 689                 }
 690
 691                 if (is_array($_SERVER["argv"]) && $_SERVER["argc"] > 1 && substr(end($_SERVER["argv"]), 0, 4) == "http" ) {
 692                         $this->set_baseurl(array_pop($_SERVER["argv"]));
 693                         $_SERVER["argc"] --;
 694                 }
 695
 696                 if ((x($_SERVER, 'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'], 0, 9) === "pagename=") {
 697                         $this->query_string = substr($_SERVER['QUERY_STRING'],9);
 698                         // removing trailing / - maybe a nginx problem
 699                         /// @TODO can be shortened by trim($str, '/') !
 700                         if (substr($this->query_string, 0, 1) == "/") {
 701                                 $this->query_string = substr($this->query_string, 1);
 702                         }
 703                 } elseif ((x($_SERVER, 'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'], 0, 2) === "q=") {
 704                         $this->query_string = substr($_SERVER['QUERY_STRING'],2);
 705                         // removing trailing / - maybe a nginx problem
 706                         /// @TODO can be shortened by trim($str, '/') !
 707                         if (substr($this->query_string, 0, 1) == "/") {
 708                                 $this->query_string = substr($this->query_string, 1);
 709                         }
 710                 }
 711
 712                 if (x($_GET, 'pagename')) {
 713                         $this->cmd = trim($_GET['pagename'], '/\\');
 714                 } elseif (x($_GET, 'q')) {
 715                         $this->cmd = trim($_GET['q'], '/\\');
 716                 }
 717
 718
 719                 // fix query_string
 720                 $this->query_string = str_replace($this->cmd."&",$this->cmd."?", $this->query_string);
 721
 722                 // unix style "homedir"
 723                 if (substr($this->cmd, 0, 1) === '~') {
 724                         $this->cmd = 'profile/' . substr($this->cmd, 1);
 725                 }
 726
 727                 // Diaspora style profile url
 728
 729                 if (substr($this->cmd,0,2) === 'u/') {
 730                         $this->cmd = 'profile/' . substr($this->cmd,2);
 731                 }
 732
 733
 734                 /*
 735                  *
 736                  * Break the URL path into C style argc/argv style arguments for our
 737                  * modules. Given "http://example.com/module/arg1/arg2", $this->argc
 738                  * will be 3 (integer) and $this->argv will contain:
 739                  *   [0] => 'module'
 740                  *   [1] => 'arg1'
 741                  *   [2] => 'arg2'
 742                  *
 743                  *
 744                  * There will always be one argument. If provided a naked domain
 745                  * URL, $this->argv[0] is set to "home".
 746                  *
 747                  */
 748
 749                 $this->argv = explode('/',$this->cmd);
 750                 $this->argc = count($this->argv);
 751                 if ((array_key_exists('0',$this->argv)) && strlen($this->argv[0])) {
 752                         $this->module = str_replace(".", "_", $this->argv[0]);
 753                         $this->module = str_replace("-", "_", $this->module);
 754                 } else {
 755                         $this->argc = 1;
 756                         $this->argv = array('home');
 757                         $this->module = 'home';
 758                 }
 759
 760                 /*
 761                  * See if there is any page number information, and initialise
 762                  * pagination
 763                  */
 764
 765                 $this->pager['page'] = ((x($_GET,'page') && intval($_GET['page']) > 0) ? intval($_GET['page']) : 1);
 766                 $this->pager['itemspage'] = 50;
 767                 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
 768                 if ($this->pager['start'] < 0) {
 769                         $this->pager['start'] = 0;
 770                 }
 771                 $this->pager['total'] = 0;
 772
 773                 /*
 774                  * Detect mobile devices
 775                  */
 776
 777                 $mobile_detect = new Mobile_Detect();
 778                 $this->is_mobile = $mobile_detect->isMobile();
 779                 $this->is_tablet = $mobile_detect->isTablet();
 780
 781                 // Friendica-Client
 782                 $this->is_friendica_app = ($_SERVER['HTTP_USER_AGENT'] == "Apache-HttpClient/UNAVAILABLE (java 1.4)");
 783
 784                 /*
 785                  * register template engines
 786                  */
 787                 $dc = get_declared_classes();
 788                 foreach ($dc as $k) {
 789                         if (in_array("ITemplateEngine", class_implements($k))){
 790                                 $this->register_template_engine($k);
 791                         }
 792                 }
 793
 794                 self::$a = $this;
 795
 796         }
 797
 798         public static function get_basepath() {
 799
 800                 $basepath = get_config("system", "basepath");
 801
 802                 if ($basepath == "") {
 803                         $basepath = dirname(__FILE__);
 804                 }
 805
 806                 if ($basepath == "") {
 807                         $basepath = $_SERVER["DOCUMENT_ROOT"];
 808                 }
 809
 810                 if ($basepath == "") {
 811                         $basepath = $_SERVER["PWD"];
 812                 }
 813
 814                 return $basepath;
 815         }
 816
 817         function get_scheme() {
 818                 return $this->scheme;
 819         }
 820
 821         /**
 822          * @brief Retrieves the Friendica instance base URL
 823          *
 824          * This function assembles the base URL from multiple parts:
 825          * - Protocol is determined either by the request or a combination of
 826          * system.ssl_policy and the $ssl parameter.
 827          * - Host name is determined either by system.hostname or inferred from request
 828          * - Path is inferred from SCRIPT_NAME
 829          *
 830          * Note: $ssl parameter value doesn't directly correlate with the resulting protocol
 831          *
 832          * @param bool $ssl Whether to append http or https under SSL_POLICY_SELFSIGN
 833          * @return string Friendica server base URL
 834          */
 835         function get_baseurl($ssl = false) {
 836
 837                 // Is the function called statically?
 838                 if (!(isset($this) && get_class($this) == __CLASS__)) {
 839                         return self::$a->get_baseurl($ssl);
 840                 }
 841
 842                 $scheme = $this->scheme;
 843
 844                 if (Config::get('system', 'ssl_policy') == SSL_POLICY_FULL) {
 845                         $scheme = 'https';
 846                 }
 847
 848                 //      Basically, we have $ssl = true on any links which can only be seen by a logged in user
 849                 //      (and also the login link). Anything seen by an outsider will have it turned off.
 850
 851                 if (Config::get('system', 'ssl_policy') == SSL_POLICY_SELFSIGN) {
 852                         if ($ssl) {
 853                                 $scheme = 'https';
 854                         } else {
 855                                 $scheme = 'http';
 856                         }
 857                 }
 858
 859                 if (Config::get('config', 'hostname') != '') {
 860                         $this->hostname = Config::get('config', 'hostname');
 861                 }
 862
 863                 return $scheme . "://" . $this->hostname . ((isset($this->path) && strlen($this->path)) ? '/' . $this->path : '' );
 864         }
 865
 866         /**
 867          * @brief Initializes the baseurl components
 868          *
 869          * Clears the baseurl cache to prevent inconstistencies
 870          *
 871          * @param string $url
 872          */
 873         function set_baseurl($url) {
 874                 $parsed = @parse_url($url);
 875
 876                 if ($parsed) {
 877                         $this->scheme = $parsed['scheme'];
 878
 879                         $hostname = $parsed['host'];
 880                         if (x($parsed, 'port')) {
 881                                 $hostname .= ':' . $parsed['port'];
 882                         }
 883                         if (x($parsed, 'path')) {
 884                                 $this->path = trim($parsed['path'], '\\/');
 885                         }
 886
 887                         if (file_exists(".htpreconfig.php")) {
 888                                 include ".htpreconfig.php";
 889                         }
 890
 891                         if (get_config('config', 'hostname') != '') {
 892                                 $this->hostname = get_config('config', 'hostname');
 893                         }
 894
 895                         if (!isset($this->hostname) OR ($this->hostname == '')) {
 896                                 $this->hostname = $hostname;
 897                         }
 898                 }
 899         }
 900
 901         function get_hostname() {
 902                 if (get_config('config', 'hostname') != "") {
 903                         $this->hostname = get_config('config', 'hostname');
 904                 }
 905
 906                 return $this->hostname;
 907         }
 908
 909         function set_hostname($h) {
 910                 $this->hostname = $h;
 911         }
 912
 913         function set_path($p) {
 914                 $this->path = trim(trim($p), '/');
 915         }
 916
 917         function get_path() {
 918                 return $this->path;
 919         }
 920
 921         function set_pager_total($n) {
 922                 $this->pager['total'] = intval($n);
 923         }
 924
 925         function set_pager_itemspage($n) {
 926                 $this->pager['itemspage'] = ((intval($n) > 0) ? intval($n) : 0);
 927                 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
 928         }
 929
 930         function set_pager_page($n) {
 931                 $this->pager['page'] = $n;
 932                 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
 933         }
 934
 935         function init_pagehead() {
 936                 $interval = ((local_user()) ? get_pconfig(local_user(),'system','update_interval') : 40000);
 937
 938                 // If the update is "deactivated" set it to the highest integer number (~24 days)
 939                 if ($interval < 0) {
 940                         $interval = 2147483647;
 941                 }
 942
 943                 if ($interval < 10000) {
 944                         $interval = 40000;
 945                 }
 946
 947                 // compose the page title from the sitename and the
 948                 // current module called
 949                 if (!$this->module == '') {
 950                     $this->page['title'] = $this->config['sitename'] . ' (' . $this->module . ')';
 951                 } else {
 952                         $this->page['title'] = $this->config['sitename'];
 953                 }
 954
 955                 /* put the head template at the beginning of page['htmlhead']
 956                  * since the code added by the modules frequently depends on it
 957                  * being first
 958                  */
 959                 if (!isset($this->page['htmlhead'])) {
 960                         $this->page['htmlhead'] = '';
 961                 }
 962
 963                 // If we're using Smarty, then doing replace_macros() will replace
 964                 // any unrecognized variables with a blank string. Since we delay
 965                 // replacing $stylesheet until later, we need to replace it now
 966                 // with another variable name
 967                 if ($this->theme['template_engine'] === 'smarty3') {
 968                         $stylesheet = $this->get_template_ldelim('smarty3') . '$stylesheet' . $this->get_template_rdelim('smarty3');
 969                 } else {
 970                         $stylesheet = '$stylesheet';
 971                 }
 972
 973                 $shortcut_icon = get_config("system", "shortcut_icon");
 974                 if ($shortcut_icon == "") {
 975                         $shortcut_icon = "images/friendica-32.png";
 976                 }
 977
 978                 $touch_icon = get_config("system", "touch_icon");
 979                 if ($touch_icon == "") {
 980                         $touch_icon = "images/friendica-128.png";
 981                 }
 982
 983                 // get data wich is needed for infinite scroll on the network page
 984                 $invinite_scroll = infinite_scroll_data($this->module);
 985
 986                 $tpl = get_markup_template('head.tpl');
 987                 $this->page['htmlhead'] = replace_macros($tpl,array(
 988                         '$baseurl' => $this->get_baseurl(), // FIXME for z_path!!!!
 989                         '$local_user' => local_user(),
 990                         '$generator' => 'Friendica' . ' ' . FRIENDICA_VERSION,
 991                         '$delitem' => t('Delete this item?'),
 992                         '$showmore' => t('show more'),
 993                         '$showfewer' => t('show fewer'),
 994                         '$update_interval' => $interval,
 995                         '$shortcut_icon' => $shortcut_icon,
 996                         '$touch_icon' => $touch_icon,
 997                         '$stylesheet' => $stylesheet,
 998                         '$infinite_scroll' => $invinite_scroll,
 999                 )) . $this->page['htmlhead'];
1000         }
1001
1002         function init_page_end() {
1003                 if (!isset($this->page['end'])) {
1004                         $this->page['end'] = '';
1005                 }
1006                 $tpl = get_markup_template('end.tpl');
1007                 $this->page['end'] = replace_macros($tpl,array(
1008                         '$baseurl' => $this->get_baseurl() // FIXME for z_path!!!!
1009                 )) . $this->page['end'];
1010         }
1011
1012         function set_curl_code($code) {
1013                 $this->curl_code = $code;
1014         }
1015
1016         function get_curl_code() {
1017                 return $this->curl_code;
1018         }
1019
1020         function set_curl_content_type($content_type) {
1021                 $this->curl_content_type = $content_type;
1022         }
1023
1024         function get_curl_content_type() {
1025                 return $this->curl_content_type;
1026         }
1027
1028         function set_curl_headers($headers) {
1029                 $this->curl_headers = $headers;
1030         }
1031
1032         function get_curl_headers() {
1033                 return $this->curl_headers;
1034         }
1035
1036         function get_cached_avatar_image($avatar_image){
1037                 return $avatar_image;
1038         }
1039
1040
1041         /**
1042          * @brief Removes the baseurl from an url. This avoids some mixed content problems.
1043          *
1044          * @param string $orig_url
1045          *
1046          * @return string The cleaned url
1047          */
1048         function remove_baseurl($orig_url){
1049
1050                 // Is the function called statically?
1051                 if (!(isset($this) && get_class($this) == __CLASS__)) {
1052                         return self::$a->remove_baseurl($orig_url);
1053                 }
1054
1055                 // Remove the hostname from the url if it is an internal link
1056                 $nurl = normalise_link($orig_url);
1057                 $base = normalise_link($this->get_baseurl());
1058                 $url = str_replace($base."/", "", $nurl);
1059
1060                 // if it is an external link return the orignal value
1061                 if ($url == normalise_link($orig_url)) {
1062                         return $orig_url;
1063                 } else {
1064                         return $url;
1065                 }
1066         }
1067
1068         /**
1069          * @brief Register template engine class
1070          *
1071          * If $name is "", is used class static property $class::$name
1072          *
1073          * @param string $class
1074          * @param string $name
1075          */
1076         function register_template_engine($class, $name = '') {
1077                 /// @TODO Really === and not just == ?
1078                 if ($name === "") {
1079                         $v = get_class_vars( $class );
1080                         if (x($v,"name")) $name = $v['name'];
1081                 }
1082                 if ($name === "") {
1083                         echo "template engine <tt>$class</tt> cannot be registered without a name.\n";
1084                         killme();
1085                 }
1086                 $this->template_engines[$name] = $class;
1087         }
1088
1089         /**
1090          * @brief Return template engine instance.
1091          *
1092          * If $name is not defined, return engine defined by theme,
1093          * or default
1094          *
1095          * @param strin $name Template engine name
1096          * @return object Template Engine instance
1097          */
1098         function template_engine($name = '') {
1099                 /// @TODO really type-check included?
1100                 if ($name !== "") {
1101                         $template_engine = $name;
1102                 } else {
1103                         $template_engine = 'smarty3';
1104                         if (x($this->theme, 'template_engine')) {
1105                                 $template_engine = $this->theme['template_engine'];
1106                         }
1107                 }
1108
1109                 if (isset($this->template_engines[$template_engine])){
1110                         if (isset($this->template_engine_instance[$template_engine])){
1111                                 return $this->template_engine_instance[$template_engine];
1112                         } else {
1113                                 $class = $this->template_engines[$template_engine];
1114                                 $obj = new $class;
1115                                 $this->template_engine_instance[$template_engine] = $obj;
1116                                 return $obj;
1117                         }
1118                 }
1119
1120                 echo "template engine <tt>$template_engine</tt> is not registered!\n"; killme();
1121         }
1122
1123         /**
1124          * @brief Returns the active template engine.
1125          *
1126          * @return string
1127          */
1128         function get_template_engine() {
1129                 return $this->theme['template_engine'];
1130         }
1131
1132         function set_template_engine($engine = 'smarty3') {
1133                 $this->theme['template_engine'] = $engine;
1134         }
1135
1136         function get_template_ldelim($engine = 'smarty3') {
1137                 return $this->ldelim[$engine];
1138         }
1139
1140         function get_template_rdelim($engine = 'smarty3') {
1141                 return $this->rdelim[$engine];
1142         }
1143
1144         function save_timestamp($stamp, $value) {
1145                 if (!isset($this->config['system']['profiler']) || !$this->config['system']['profiler']) {
1146                         return;
1147                 }
1148
1149                 $duration = (float)(microtime(true)-$stamp);
1150
1151                 if (!isset($this->performance[$value])) {
1152                         // Prevent ugly E_NOTICE
1153                         $this->performance[$value] = 0;
1154                 }
1155
1156                 $this->performance[$value] += (float)$duration;
1157                 $this->performance["marktime"] += (float)$duration;
1158
1159                 $callstack = $this->callstack();
1160
1161                 if (!isset($this->callstack[$value][$callstack])) {
1162                         // Prevent ugly E_NOTICE
1163                         $this->callstack[$value][$callstack] = 0;
1164                 }
1165
1166                 $this->callstack[$value][$callstack] += (float)$duration;
1167
1168         }
1169
1170         /**
1171          * @brief Log active processes into the "process" table
1172          */
1173         function start_process() {
1174                 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1);
1175
1176                 $command = basename($trace[0]["file"]);
1177
1178                 $this->remove_inactive_processes();
1179
1180                 q("START TRANSACTION");
1181
1182                 $r = q("SELECT `pid` FROM `process` WHERE `pid` = %d", intval(getmypid()));
1183                 if (!dbm::is_result($r)) {
1184                         q("INSERT INTO `process` (`pid`,`command`,`created`) VALUES (%d, '%s', '%s')",
1185                                 intval(getmypid()),
1186                                 dbesc($command),
1187                                 dbesc(datetime_convert()));
1188                 }
1189                 q("COMMIT");
1190         }
1191
1192         /**
1193          * @brief Remove inactive processes
1194          */
1195         function remove_inactive_processes() {
1196                 q("START TRANSACTION");
1197
1198                 $r = q("SELECT `pid` FROM `process`");
1199                 if (dbm::is_result($r)) {
1200                         foreach ($r AS $process) {
1201                                 if (!posix_kill($process["pid"], 0)) {
1202                                         q("DELETE FROM `process` WHERE `pid` = %d", intval($process["pid"]));
1203                                 }
1204                         }
1205                 }
1206                 q("COMMIT");
1207         }
1208
1209         /**
1210          * @brief Remove the active process from the "process" table
1211          */
1212         function end_process() {
1213                 q("DELETE FROM `process` WHERE `pid` = %d", intval(getmypid()));
1214         }
1215
1216         /**
1217          * @brief Returns a string with a callstack. Can be used for logging.
1218          *
1219          * @return string
1220          */
1221         function callstack() {
1222                 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 6);
1223
1224                 // We remove the first two items from the list since they contain data that we don't need.
1225                 array_shift($trace);
1226                 array_shift($trace);
1227
1228                 $callstack = array();
1229                 foreach ($trace AS $func) {
1230                         $callstack[] = $func["function"];
1231                 }
1232
1233                 return implode(", ", $callstack);
1234         }
1235
1236         function get_useragent() {
1237                 return
1238                         FRIENDICA_PLATFORM . " '" .
1239                         FRIENDICA_CODENAME . "' " .
1240                         FRIENDICA_VERSION . "-" .
1241                         DB_UPDATE_VERSION . "; " .
1242                         $this->get_baseurl();
1243         }
1244
1245         function is_friendica_app() {
1246                 return $this->is_friendica_app;
1247         }
1248
1249         /**
1250          * @brief Checks if the site is called via a backend process
1251          *
1252          * This isn't a perfect solution. But we need this check very early.
1253          * So we cannot wait until the modules are loaded.
1254          *
1255          * @return bool Is it a known backend?
1256          */
1257         function is_backend() {
1258                 static $backend = array();
1259                 $backend[] = "_well_known";
1260                 $backend[] = "api";
1261                 $backend[] = "dfrn_notify";
1262                 $backend[] = "fetch";
1263                 $backend[] = "hcard";
1264                 $backend[] = "hostxrd";
1265                 $backend[] = "nodeinfo";
1266                 $backend[] = "noscrape";
1267                 $backend[] = "p";
1268                 $backend[] = "poco";
1269                 $backend[] = "post";
1270                 $backend[] = "proxy";
1271                 $backend[] = "pubsub";
1272                 $backend[] = "pubsubhubbub";
1273                 $backend[] = "receive";
1274                 $backend[] = "rsd_xml";
1275                 $backend[] = "salmon";
1276                 $backend[] = "statistics_json";
1277                 $backend[] = "xrd";
1278
1279                 // Check if current module is in backend or backend flag is set
1280                 return (in_array($this->module, self::$backend) || $this->backend);
1281         }
1282
1283         /**
1284          * @brief Checks if the maximum number of database processes is reached
1285          *
1286          * @return bool Is the limit reached?
1287          */
1288         function max_processes_reached() {
1289
1290                 if ($this->is_backend()) {
1291                         $process = "backend";
1292                         $max_processes = get_config('system', 'max_processes_backend');
1293                         if (intval($max_processes) == 0) {
1294                                 $max_processes = 5;
1295                         }
1296                 } else {
1297                         $process = "frontend";
1298                         $max_processes = get_config('system', 'max_processes_frontend');
1299                         if (intval($max_processes) == 0) {
1300                                 $max_processes = 20;
1301                         }
1302                 }
1303
1304                 $processlist = dbm::processlist();
1305                 if ($processlist["list"] != "") {
1306                         logger("Processcheck: Processes: ".$processlist["amount"]." - Processlist: ".$processlist["list"], LOGGER_DEBUG);
1307
1308                         if ($processlist["amount"] > $max_processes) {
1309                                 logger("Processcheck: Maximum number of processes for ".$process." tasks (".$max_processes.") reached.", LOGGER_DEBUG);
1310                                 return true;
1311                         }
1312                 }
1313                 return false;
1314         }
1315
1316         /**
1317          * @brief Checks if the maximum load is reached
1318          *
1319          * @return bool Is the load reached?
1320          */
1321         function maxload_reached() {
1322
1323                 if ($this->is_backend()) {
1324                         $process = "backend";
1325                         $maxsysload = intval(get_config('system', 'maxloadavg'));
1326                         if ($maxsysload < 1) {
1327                                 $maxsysload = 50;
1328                         }
1329                 } else {
1330                         $process = "frontend";
1331                         $maxsysload = intval(get_config('system','maxloadavg_frontend'));
1332                         if ($maxsysload < 1) {
1333                                 $maxsysload = 50;
1334                         }
1335                 }
1336
1337                 $load = current_load();
1338                 if ($load) {
1339                         if (intval($load) > $maxsysload) {
1340                                 logger('system: load '.$load.' for '.$process.' tasks ('.$maxsysload.') too high.');
1341                                 return true;
1342                         }
1343                 }
1344                 return false;
1345         }
1346
1347         function proc_run($args) {
1348
1349                 if (!function_exists("proc_open")) {
1350                         return;
1351                 }
1352
1353                 // If the last worker fork was less than 10 seconds before then don't fork another one.
1354                 // This should prevent the forking of masses of workers.
1355                 $cachekey = "app:proc_run:started";
1356                 $result = Cache::get($cachekey);
1357
1358                 if (!is_null($result) AND (time() - $result) < 10) {
1359                         return;
1360                 }
1361
1362                 // Set the timestamp of the last proc_run
1363                 Cache::set($cachekey, time(), CACHE_MINUTE);
1364
1365                 array_unshift($args, ((x($this->config,'php_path')) && (strlen($this->config['php_path'])) ? $this->config['php_path'] : 'php'));
1366
1367                 // add baseurl to args. cli scripts can't construct it
1368                 $args[] = $this->get_baseurl();
1369
1370                 for ($x = 0; $x < count($args); $x ++) {
1371                         $args[$x] = escapeshellarg($args[$x]);
1372                 }
1373
1374                 $cmdline = implode($args, " ");
1375
1376                 if (get_config('system', 'proc_windows')) {
1377                         proc_close(proc_open('cmd /c start /b ' . $cmdline, array(), $foo, dirname(__FILE__)));
1378                 } else {
1379                         proc_close(proc_open($cmdline . " &", array(), $foo, dirname(__FILE__)));
1380                 }
1381
1382         }
1383
1384         /**
1385          * @brief Returns the system user that is executing the script
1386          *
1387          * This mostly returns something like "www-data".
1388          *
1389          * @return string system username
1390          */
1391         static function systemuser() {
1392                 if (!function_exists('posix_getpwuid') OR !function_exists('posix_geteuid')) {
1393                         return '';
1394                 }
1395
1396                 $processUser = posix_getpwuid(posix_geteuid());
1397                 return $processUser['name'];
1398         }
1399
1400         /**
1401          * @brief Checks if a given directory is usable for the system
1402          *
1403          * @return boolean the directory is usable
1404          */
1405         static function directory_usable($directory) {
1406
1407                 if ($directory == '') {
1408                         logger("Directory is empty. This shouldn't happen.", LOGGER_DEBUG);
1409                         return false;
1410                 }
1411
1412                 if (!file_exists($directory)) {
1413                         logger('Path "'.$directory.'" does not exist for user '.self::systemuser(), LOGGER_DEBUG);
1414                         return false;
1415                 }
1416                 if (is_file($directory)) {
1417                         logger('Path "'.$directory.'" is a file for user '.self::systemuser(), LOGGER_DEBUG);
1418                         return false;
1419                 }
1420                 if (!is_dir($directory)) {
1421                         logger('Path "'.$directory.'" is not a directory for user '.self::systemuser(), LOGGER_DEBUG);
1422                         return false;
1423                 }
1424                 if (!is_writable($directory)) {
1425                         logger('Path "'.$directory.'" is not writable for user '.self::systemuser(), LOGGER_DEBUG);
1426                         return false;
1427                 }
1428                 return true;
1429         }
1430 }
1431
1432 /**
1433  * @brief Retrieve the App structure
1434  *
1435  * Useful in functions which require it but don't get it passed to them
1436  */
1437 function get_app() {
1438         global $a;
1439         return $a;
1440 }
1441
1442
1443 /**
1444  * @brief Multi-purpose function to check variable state.
1445  *
1446  * Usage: x($var) or $x($array, 'key')
1447  *
1448  * returns false if variable/key is not set
1449  * if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0.
1450  * e.g. x('') or x(0) returns 0;
1451  *
1452  * @param string|array $s variable to check
1453  * @param string $k key inside the array to check
1454  *
1455  * @return bool|int
1456  */
1457 function x($s,$k = NULL) {
1458         if ($k != NULL) {
1459                 if ((is_array($s)) && (array_key_exists($k,$s))) {
1460                         if ($s[$k]) {
1461                                 return (int) 1;
1462                         }
1463                         return (int) 0;
1464                 }
1465                 return false;
1466         } else {
1467                 if (isset($s)) {
1468                         if ($s) {
1469                                 return (int) 1;
1470                         }
1471                         return (int) 0;
1472                 }
1473                 return false;
1474         }
1475 }
1476
1477
1478 /**
1479  * @brief Called from db initialisation if db is dead.
1480  */
1481 function system_unavailable() {
1482         include('system_unavailable.php');
1483         system_down();
1484         killme();
1485 }
1486
1487
1488 function clean_urls() {
1489         $a = get_app();
1490         return true;
1491 }
1492
1493 function z_path() {
1494         $base = App::get_baseurl();
1495
1496         if (! clean_urls()) {
1497                 $base .= '/?q=';
1498         }
1499
1500         return $base;
1501 }
1502
1503 /**
1504  * @brief Returns the baseurl.
1505  *
1506  * @see App::get_baseurl()
1507  *
1508  * @return string
1509  * @TODO Maybe super-flous and deprecated? Seems to only wrap App::get_baseurl()
1510  */
1511 function z_root() {
1512         return App::get_baseurl();
1513 }
1514
1515 /**
1516  * @brief Return absolut URL for given $path.
1517  *
1518  * @param string $path
1519  *
1520  * @return string
1521  */
1522 function absurl($path) {
1523         if (strpos($path,'/') === 0) {
1524                 return z_path() . $path;
1525         }
1526         return $path;
1527 }
1528
1529 /**
1530  * @brief Function to check if request was an AJAX (xmlhttprequest) request.
1531  *
1532  * @return boolean
1533  */
1534 function is_ajax() {
1535         return (!empty($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest');
1536 }
1537
1538 function check_db() {
1539
1540         $build = get_config('system','build');
1541         if (! x($build)) {
1542                 set_config('system','build',DB_UPDATE_VERSION);
1543                 $build = DB_UPDATE_VERSION;
1544         }
1545         if ($build != DB_UPDATE_VERSION) {
1546                 proc_run(PRIORITY_CRITICAL, 'include/dbupdate.php');
1547         }
1548
1549 }
1550
1551
1552 /**
1553  * Sets the base url for use in cmdline programs which don't have
1554  * $_SERVER variables
1555  */
1556 function check_url(App $a) {
1557
1558         $url = get_config('system','url');
1559
1560         // if the url isn't set or the stored url is radically different
1561         // than the currently visited url, store the current value accordingly.
1562         // "Radically different" ignores common variations such as http vs https
1563         // and www.example.com vs example.com.
1564         // We will only change the url to an ip address if there is no existing setting
1565
1566         if (! x($url)) {
1567                 $url = set_config('system','url',App::get_baseurl());
1568         }
1569         if ((! link_compare($url,App::get_baseurl())) && (! preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/",$a->get_hostname))) {
1570                 $url = set_config('system','url',App::get_baseurl());
1571         }
1572
1573         return;
1574 }
1575
1576
1577 /**
1578  * @brief Automatic database updates
1579  */
1580 function update_db(App $a) {
1581         $build = get_config('system','build');
1582         if (! x($build)) {
1583                 $build = set_config('system','build',DB_UPDATE_VERSION);
1584         }
1585
1586         if ($build != DB_UPDATE_VERSION) {
1587                 $stored = intval($build);
1588                 $current = intval(DB_UPDATE_VERSION);
1589                 if ($stored < $current) {
1590                         Config::load('database');
1591
1592                         // We're reporting a different version than what is currently installed.
1593                         // Run any existing update scripts to bring the database up to current.
1594
1595                         // make sure that boot.php and update.php are the same release, we might be
1596                         // updating right this very second and the correct version of the update.php
1597                         // file may not be here yet. This can happen on a very busy site.
1598
1599                         if (DB_UPDATE_VERSION == UPDATE_VERSION) {
1600                                 // Compare the current structure with the defined structure
1601
1602                                 $t = get_config('database','dbupdate_'.DB_UPDATE_VERSION);
1603                                 if ($t !== false) {
1604                                         return;
1605                                 }
1606
1607                                 set_config('database','dbupdate_'.DB_UPDATE_VERSION, time());
1608
1609                                 // run old update routine (wich could modify the schema and
1610                                 // conflits with new routine)
1611                                 for ($x = $stored; $x < NEW_UPDATE_ROUTINE_VERSION; $x++) {
1612                                         $r = run_update_function($x);
1613                                         if (!$r) {
1614                                                 break;
1615                                         }
1616                                 }
1617                                 if ($stored < NEW_UPDATE_ROUTINE_VERSION) {
1618                                         $stored = NEW_UPDATE_ROUTINE_VERSION;
1619                                 }
1620
1621                                 // run new update routine
1622                                 // it update the structure in one call
1623                                 $retval = update_structure(false, true);
1624                                 if ($retval) {
1625                                         update_fail(
1626                                                 DB_UPDATE_VERSION,
1627                                                 $retval
1628                                         );
1629                                         return;
1630                                 } else {
1631                                         set_config('database','dbupdate_'.DB_UPDATE_VERSION, 'success');
1632                                 }
1633
1634                                 // run any left update_nnnn functions in update.php
1635                                 for ($x = $stored; $x < $current; $x ++) {
1636                                         $r = run_update_function($x);
1637                                         if (!$r) {
1638                                                 break;
1639                                         }
1640                                 }
1641                         }
1642                 }
1643         }
1644
1645         return;
1646 }
1647
1648 function run_update_function($x) {
1649         if (function_exists('update_' . $x)) {
1650
1651                 // There could be a lot of processes running or about to run.
1652                 // We want exactly one process to run the update command.
1653                 // So store the fact that we're taking responsibility
1654                 // after first checking to see if somebody else already has.
1655
1656                 // If the update fails or times-out completely you may need to
1657                 // delete the config entry to try again.
1658
1659                 $t = get_config('database','update_' . $x);
1660                 if ($t !== false) {
1661                         return false;
1662                 }
1663                 set_config('database','update_' . $x, time());
1664
1665                 // call the specific update
1666
1667                 $func = 'update_' . $x;
1668                 $retval = $func();
1669
1670                 if ($retval) {
1671                         //send the administrator an e-mail
1672                         update_fail(
1673                                 $x,
1674                                 sprintf(t('Update %s failed. See error logs.'), $x)
1675                         );
1676                         return false;
1677                 } else {
1678                         set_config('database','update_' . $x, 'success');
1679                         set_config('system','build', $x + 1);
1680                         return true;
1681                 }
1682         } else {
1683                 set_config('database','update_' . $x, 'success');
1684                 set_config('system','build', $x + 1);
1685                 return true;
1686         }
1687         return true;
1688 }
1689
1690 /**
1691  * @brief Synchronise plugins:
1692  *
1693  * $a->config['system']['addon'] contains a comma-separated list of names
1694  * of plugins/addons which are used on this system.
1695  * Go through the database list of already installed addons, and if we have
1696  * an entry, but it isn't in the config list, call the uninstall procedure
1697  * and mark it uninstalled in the database (for now we'll remove it).
1698  * Then go through the config list and if we have a plugin that isn't installed,
1699  * call the install procedure and add it to the database.
1700  *
1701  * @param App $a
1702  *
1703  */
1704 function check_plugins(App $a) {
1705
1706         $r = q("SELECT * FROM `addon` WHERE `installed` = 1");
1707         if (dbm::is_result($r)) {
1708                 $installed = $r;
1709         } else {
1710                 $installed = array();
1711         }
1712
1713         $plugins = get_config('system','addon');
1714         $plugins_arr = array();
1715
1716         if ($plugins) {
1717                 $plugins_arr = explode(',',str_replace(' ', '',$plugins));
1718         }
1719
1720         $a->plugins = $plugins_arr;
1721
1722         $installed_arr = array();
1723
1724         if (count($installed)) {
1725                 foreach ($installed as $i) {
1726                         if (! in_array($i['name'],$plugins_arr)) {
1727                                 uninstall_plugin($i['name']);
1728                         } else {
1729                                 $installed_arr[] = $i['name'];
1730                         }
1731                 }
1732         }
1733
1734         if (count($plugins_arr)) {
1735                 foreach ($plugins_arr as $p) {
1736                         if (! in_array($p,$installed_arr)) {
1737                                 install_plugin($p);
1738                         }
1739                 }
1740         }
1741
1742
1743         load_hooks();
1744
1745         return;
1746 }
1747
1748 function get_guid($size=16, $prefix = "") {
1749
1750         if ($prefix == "") {
1751                 $a = get_app();
1752                 $prefix = hash("crc32", $a->get_hostname());
1753         }
1754
1755         while (strlen($prefix) < ($size - 13)) {
1756                 $prefix .= mt_rand();
1757         }
1758
1759         if ($size >= 24) {
1760                 $prefix = substr($prefix, 0, $size - 22);
1761                 return(str_replace(".", "", uniqid($prefix, true)));
1762         } else {
1763                 $prefix = substr($prefix, 0, max($size - 13, 0));
1764                 return(uniqid($prefix));
1765         }
1766 }
1767
1768 /**
1769  * @brief Wrapper for adding a login box.
1770  *
1771  * @param bool $register
1772  *      If $register == true provide a registration link.
1773  *      This will most always depend on the value of $a->config['register_policy'].
1774  * @param bool $hiddens
1775  *
1776  * @return string
1777  *      Returns the complete html for inserting into the page
1778  *
1779  * @hooks 'login_hook'
1780  *      string $o
1781  */
1782 function login($register = false, $hiddens=false) {
1783         $a = get_app();
1784         $o = "";
1785         $reg = false;
1786         if ($register) {
1787                 $reg = array(
1788                         'title' => t('Create a New Account'),
1789                         'desc' => t('Register')
1790                 );
1791         }
1792
1793         $noid = get_config('system','no_openid');
1794
1795         $dest_url = $a->query_string;
1796
1797         if (local_user()) {
1798                 $tpl = get_markup_template("logout.tpl");
1799         } else {
1800                 $a->page['htmlhead'] .= replace_macros(get_markup_template("login_head.tpl"),array(
1801                         '$baseurl' => $a->get_baseurl(true)
1802                 ));
1803
1804                 $tpl = get_markup_template("login.tpl");
1805                 $_SESSION['return_url'] = $a->query_string;
1806                 $a->module = 'login';
1807         }
1808
1809         $o .= replace_macros($tpl, array(
1810
1811                 '$dest_url'     => $dest_url,
1812                 '$logout'       => t('Logout'),
1813                 '$login'        => t('Login'),
1814
1815                 '$lname'        => array('username', t('Nickname or Email: ') , '', ''),
1816                 '$lpassword'    => array('password', t('Password: '), '', ''),
1817                 '$lremember'    => array('remember', t('Remember me'), 0,  ''),
1818
1819                 '$openid'       => !$noid,
1820                 '$lopenid'      => array('openid_url', t('Or login using OpenID: '),'',''),
1821
1822                 '$hiddens'      => $hiddens,
1823
1824                 '$register'     => $reg,
1825
1826                 '$lostpass'     => t('Forgot your password?'),
1827                 '$lostlink'     => t('Password Reset'),
1828
1829                 '$tostitle'     => t('Website Terms of Service'),
1830                 '$toslink'      => t('terms of service'),
1831
1832                 '$privacytitle' => t('Website Privacy Policy'),
1833                 '$privacylink'  => t('privacy policy'),
1834
1835         ));
1836
1837         call_hooks('login_hook',$o);
1838
1839         return $o;
1840 }
1841
1842 /**
1843  * @brief Used to end the current process, after saving session state.
1844  */
1845 function killme() {
1846
1847         if (!get_app()->is_backend()) {
1848                 session_write_close();
1849         }
1850
1851         exit();
1852 }
1853
1854 /**
1855  * @brief Redirect to another URL and terminate this process.
1856  */
1857 function goaway($s) {
1858         if (!strstr(normalise_link($s), "http://")) {
1859                 $s = App::get_baseurl()."/".$s;
1860         }
1861
1862         header("Location: $s");
1863         killme();
1864 }
1865
1866
1867 /**
1868  * @brief Returns the user id of locally logged in user or false.
1869  *
1870  * @return int|bool user id or false
1871  */
1872 function local_user() {
1873         if (x($_SESSION, 'authenticated') && x($_SESSION, 'uid')) {
1874                 return intval($_SESSION['uid']);
1875         }
1876         return false;
1877 }
1878
1879 /**
1880  * @brief Returns the public contact id of logged in user or false.
1881  *
1882  * @return int|bool public contact id or false
1883  */
1884 function public_contact() {
1885         static $public_contact_id = false;
1886
1887         if (!$public_contact_id && x($_SESSION, 'authenticated')) {
1888                 if (x($_SESSION, 'my_address')) {
1889                         // Local user
1890                         $public_contact_id = intval(get_contact($_SESSION['my_address'], 0));
1891                 } elseif (x($_SESSION, 'visitor_home')) {
1892                         // Remote user
1893                         $public_contact_id = intval(get_contact($_SESSION['visitor_home'], 0));
1894                 }
1895         } elseif (!x($_SESSION, 'authenticated')) {
1896                 $public_contact_id = false;
1897         }
1898
1899         return $public_contact_id;
1900 }
1901
1902 /**
1903  * @brief Returns contact id of authenticated site visitor or false
1904  *
1905  * @return int|bool visitor_id or false
1906  */
1907 function remote_user() {
1908         if ((x($_SESSION,'authenticated')) && (x($_SESSION,'visitor_id'))) {
1909                 return intval($_SESSION['visitor_id']);
1910         }
1911         return false;
1912 }
1913
1914 /**
1915  * @brief Show an error message to user.
1916  *
1917  * This function save text in session, to be shown to the user at next page load
1918  *
1919  * @param string $s - Text of notice
1920  */
1921 function notice($s) {
1922         $a = get_app();
1923         if (! x($_SESSION,'sysmsg')) {
1924                 $_SESSION['sysmsg'] = array();
1925         }
1926         if ($a->interactive) {
1927                 $_SESSION['sysmsg'][] = $s;
1928         }
1929 }
1930
1931 /**
1932  * @brief Show an info message to user.
1933  *
1934  * This function save text in session, to be shown to the user at next page load
1935  *
1936  * @param string $s - Text of notice
1937  */
1938 function info($s) {
1939         $a = get_app();
1940
1941         if (local_user() AND get_pconfig(local_user(),'system','ignore_info')) {
1942                 return;
1943         }
1944
1945         if (! x($_SESSION,'sysmsg_info')) {
1946                 $_SESSION['sysmsg_info'] = array();
1947         }
1948         if ($a->interactive) {
1949                 $_SESSION['sysmsg_info'][] = $s;
1950         }
1951 }
1952
1953
1954 /**
1955  * @brief Wrapper around config to limit the text length of an incoming message
1956  *
1957  * @return int
1958  */
1959 function get_max_import_size() {
1960         $a = get_app();
1961         return ((x($a->config,'max_import_size')) ? $a->config['max_import_size'] : 0 );
1962 }
1963
1964 /**
1965  * @brief Wrap calls to proc_close(proc_open()) and call hook
1966  *      so plugins can take part in process :)
1967  *
1968  * @param (integer|array) priority or parameter array, $cmd atrings are deprecated and are ignored
1969  *
1970  * next args are passed as $cmd command line
1971  * or: proc_run(PRIORITY_HIGH, "include/notifier.php", "drop", $drop_id);
1972  * or: proc_run(array('priority' => PRIORITY_HIGH, 'dont_fork' => true), "include/create_shadowentry.php", $post_id);
1973  *
1974  * @note $cmd and string args are surrounded with ""
1975  *
1976  * @hooks 'proc_run'
1977  *      array $arr
1978  */
1979 function proc_run($cmd){
1980
1981         $a = get_app();
1982
1983         $proc_args = func_get_args();
1984
1985         $args = array();
1986         if (!count($proc_args)) {
1987                 return;
1988         }
1989
1990         // Preserve the first parameter
1991         // It could contain a command, the priority or an parameter array
1992         // If we use the parameter array we have to protect it from the following function
1993         $run_parameter = array_shift($proc_args);
1994
1995         // expand any arrays
1996         foreach ($proc_args as $arg) {
1997                 if (is_array($arg)) {
1998                         foreach ($arg as $n) {
1999                                 $args[] = $n;
2000                         }
2001                 } else {
2002                         $args[] = $arg;
2003                 }
2004         }
2005
2006         // Now we add the run parameters back to the array
2007         array_unshift($args, $run_parameter);
2008
2009         $arr = array('args' => $args, 'run_cmd' => true);
2010
2011         call_hooks("proc_run", $arr);
2012         if (!$arr['run_cmd'] OR !count($args)) {
2013                 return;
2014         }
2015
2016         $priority = PRIORITY_MEDIUM;
2017         $dont_fork = get_config("system", "worker_dont_fork");
2018
2019         if (is_int($run_parameter)) {
2020                 $priority = $run_parameter;
2021         } elseif (is_array($run_parameter)) {
2022                 if (isset($run_parameter['priority'])) {
2023                         $priority = $run_parameter['priority'];
2024                 }
2025                 if (isset($run_parameter['dont_fork'])) {
2026                         $dont_fork = $run_parameter['dont_fork'];
2027                 }
2028         }
2029
2030         $argv = $args;
2031         array_shift($argv);
2032
2033         $parameters = json_encode($argv);
2034         $found = q("SELECT `id` FROM `workerqueue` WHERE `parameter` = '%s'",
2035                 dbesc($parameters));
2036
2037         if (!dbm::is_result($found)) {
2038                 q("INSERT INTO `workerqueue` (`parameter`, `created`, `priority`)
2039                         VALUES ('%s', '%s', %d)",
2040                         dbesc($parameters),
2041                         dbesc(datetime_convert()),
2042                         intval($priority));
2043         }
2044
2045         // Should we quit and wait for the poller to be called as a cronjob?
2046         if ($dont_fork) {
2047                 return;
2048         }
2049
2050         // Checking number of workers
2051         $workers = q("SELECT COUNT(*) AS `workers` FROM `workerqueue` WHERE `executed` > '%s'", dbesc(NULL_DATE));
2052
2053         // Get number of allowed number of worker threads
2054         $queues = intval(get_config("system", "worker_queues"));
2055
2056         if ($queues == 0) {
2057                 $queues = 4;
2058         }
2059
2060         // If there are already enough workers running, don't fork another one
2061         if ($workers[0]["workers"] >= $queues) {
2062                 return;
2063         }
2064
2065         // Now call the poller to execute the jobs that we just added to the queue
2066         $args = array("include/poller.php", "no_cron");
2067
2068         $a->proc_run($args);
2069 }
2070
2071 function current_theme(){
2072         $app_base_themes = array('duepuntozero', 'dispy', 'quattro');
2073
2074         $a = get_app();
2075
2076         $page_theme = null;
2077
2078         // Find the theme that belongs to the user whose stuff we are looking at
2079
2080         if ($a->profile_uid && ($a->profile_uid != local_user())) {
2081                 $r = q("select theme from user where uid = %d limit 1",
2082                         intval($a->profile_uid)
2083                 );
2084                 if (dbm::is_result($r)) {
2085                         $page_theme = $r[0]['theme'];
2086                 }
2087         }
2088
2089         // Allow folks to over-rule user themes and always use their own on their own site.
2090         // This works only if the user is on the same server
2091
2092         if ($page_theme && local_user() && (local_user() != $a->profile_uid)) {
2093                 if (get_pconfig(local_user(),'system','always_my_theme')) {
2094                         $page_theme = null;
2095                 }
2096         }
2097
2098 //              $mobile_detect = new Mobile_Detect();
2099 //              $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
2100         $is_mobile = $a->is_mobile || $a->is_tablet;
2101
2102         $standard_system_theme = Config::get('system', 'theme', '');
2103         $standard_theme_name = ((isset($_SESSION) && x($_SESSION,'theme')) ? $_SESSION['theme'] : $standard_system_theme);
2104
2105         if ($is_mobile) {
2106                 if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
2107                         $system_theme = $standard_system_theme;
2108                         $theme_name = $standard_theme_name;
2109                 } else {
2110                         $system_theme = Config::get('system', 'mobile-theme', '');
2111                         if ($system_theme == '') {
2112                                 $system_theme = $standard_system_theme;
2113                         }
2114                         $theme_name = ((isset($_SESSION) && x($_SESSION,'mobile-theme')) ? $_SESSION['mobile-theme'] : $system_theme);
2115
2116                         if ($theme_name === '---') {
2117                                 // user has selected to have the mobile theme be the same as the normal one
2118                                 $system_theme = $standard_system_theme;
2119                                 $theme_name = $standard_theme_name;
2120
2121                                 if ($page_theme) {
2122                                         $theme_name = $page_theme;
2123                                 }
2124                         }
2125                 }
2126         } else {
2127                 $system_theme = $standard_system_theme;
2128                 $theme_name = $standard_theme_name;
2129
2130                 if ($page_theme) {
2131                         $theme_name = $page_theme;
2132                 }
2133         }
2134
2135         if ($theme_name &&
2136                         (file_exists('view/theme/' . $theme_name . '/style.css') ||
2137                                         file_exists('view/theme/' . $theme_name . '/style.php'))) {
2138                 return($theme_name);
2139         }
2140
2141         foreach ($app_base_themes as $t) {
2142                 if (file_exists('view/theme/' . $t . '/style.css') ||
2143                                 file_exists('view/theme/' . $t . '/style.php')) {
2144                         return($t);
2145                 }
2146         }
2147
2148         $fallback = array_merge(glob('view/theme/*/style.css'),glob('view/theme/*/style.php'));
2149         if (count($fallback)) {
2150                 return (str_replace('view/theme/','', substr($fallback[0],0,-10)));
2151         }
2152
2153         /// @TODO No final return statement?
2154 }
2155
2156 /**
2157  * @brief Return full URL to theme which is currently in effect.
2158  *
2159  * Provide a sane default if nothing is chosen or the specified theme does not exist.
2160  *
2161  * @return string
2162  */
2163 function current_theme_url() {
2164         $a = get_app();
2165
2166         $t = current_theme();
2167
2168         $opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : '');
2169         if (file_exists('view/theme/' . $t . '/style.php')) {
2170                 return('view/theme/'.$t.'/style.pcss'.$opts);
2171         }
2172
2173         return('view/theme/'.$t.'/style.css');
2174 }
2175
2176 function feed_birthday($uid,$tz) {
2177
2178         /**
2179          *
2180          * Determine the next birthday, but only if the birthday is published
2181          * in the default profile. We _could_ also look for a private profile that the
2182          * recipient can see, but somebody could get mad at us if they start getting
2183          * public birthday greetings when they haven't made this info public.
2184          *
2185          * Assuming we are able to publish this info, we are then going to convert
2186          * the start time from the owner's timezone to UTC.
2187          *
2188          * This will potentially solve the problem found with some social networks
2189          * where birthdays are converted to the viewer's timezone and salutations from
2190          * elsewhere in the world show up on the wrong day. We will convert it to the
2191          * viewer's timezone also, but first we are going to convert it from the birthday
2192          * person's timezone to GMT - so the viewer may find the birthday starting at
2193          * 6:00PM the day before, but that will correspond to midnight to the birthday person.
2194          *
2195          */
2196
2197
2198         $birthday = '';
2199
2200         if (! strlen($tz)) {
2201                 $tz = 'UTC';
2202         }
2203
2204         $p = q("SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1",
2205                         intval($uid)
2206         );
2207
2208         if (dbm::is_result($p)) {
2209                 $tmp_dob = substr($p[0]['dob'],5);
2210                 if (intval($tmp_dob)) {
2211                         $y = datetime_convert($tz,$tz,'now','Y');
2212                         $bd = $y . '-' . $tmp_dob . ' 00:00';
2213                         $t_dob = strtotime($bd);
2214                         $now = strtotime(datetime_convert($tz,$tz,'now'));
2215                         if ($t_dob < $now) {
2216                                 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
2217                         }
2218                         $birthday = datetime_convert($tz,'UTC',$bd,ATOM_TIME);
2219                 }
2220         }
2221
2222         return $birthday;
2223 }
2224
2225 /**
2226  * @brief Check if current user has admin role.
2227  *
2228  * @return bool true if user is an admin
2229  */
2230 function is_site_admin() {
2231         $a = get_app();
2232
2233         $adminlist = explode(",", str_replace(" ", "", $a->config['admin_email']));
2234
2235         //if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && ($a->user['email'] === $a->config['admin_email']))
2236         if (local_user() && x($a->user,'email') && x($a->config,'admin_email') && in_array($a->user['email'], $adminlist)) {
2237                 return true;
2238         }
2239         return false;
2240 }
2241
2242 /**
2243  * @brief Returns querystring as string from a mapped array.
2244  *
2245  * @param array $params mapped array with query parameters
2246  * @param string $name of parameter, default null
2247  *
2248  * @return string
2249  */
2250 function build_querystring($params, $name = null) {
2251         $ret = "";
2252         foreach ($params as $key => $val) {
2253                 if (is_array($val)) {
2254                         /// @TODO maybe not compare against null, use is_null()
2255                         if ($name == null) {
2256                                 $ret .= build_querystring($val, $key);
2257                         } else {
2258                                 $ret .= build_querystring($val, $name."[$key]");
2259                         }
2260                 } else {
2261                         $val = urlencode($val);
2262                         /// @TODO maybe not compare against null, use is_null()
2263                         if ($name != null) {
2264                                 /// @TODO two string concated, can be merged to one
2265                                 $ret .= $name . "[$key]" . "=$val&";
2266                         } else {
2267                                 $ret .= "$key=$val&";
2268                         }
2269                 }
2270         }
2271         return $ret;
2272 }
2273
2274 function explode_querystring($query) {
2275         $arg_st = strpos($query, '?');
2276         if ($arg_st !== false) {
2277                 $base = substr($query, 0, $arg_st);
2278                 $arg_st += 1;
2279         } else {
2280                 $base = '';
2281                 $arg_st = 0;
2282         }
2283
2284         $args = explode('&', substr($query, $arg_st));
2285         foreach ($args as $k => $arg) {
2286                 /// @TODO really compare type-safe here?
2287                 if ($arg === '') {
2288                         unset($args[$k]);
2289                 }
2290         }
2291         $args = array_values($args);
2292
2293         if (!$base) {
2294                 $base = $args[0];
2295                 unset($args[0]);
2296                 $args = array_values($args);
2297         }
2298
2299         return array(
2300                 'base' => $base,
2301                 'args' => $args,
2302         );
2303 }
2304
2305 /**
2306 * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
2307 *
2308 * Taken from http://webcheatsheet.com/php/get_current_page_url.php
2309 */
2310 function curPageURL() {
2311         $pageURL = 'http';
2312         if ($_SERVER["HTTPS"] == "on") {
2313                 $pageURL .= "s";
2314         }
2315
2316         $pageURL .= "://";
2317
2318         if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
2319                 $pageURL .= $_SERVER["SERVER_NAME"].":".$_SERVER["SERVER_PORT"].$_SERVER["REQUEST_URI"];
2320         } else {
2321                 $pageURL .= $_SERVER["SERVER_NAME"].$_SERVER["REQUEST_URI"];
2322         }
2323         return $pageURL;
2324 }
2325
2326 function random_digits($digits) {
2327         $rn = '';
2328         for ($i = 0; $i < $digits; $i++) {
2329                 /// @TODO rand() is different to mt_rand() and maybe lesser "random"
2330                 $rn .= rand(0,9);
2331         }
2332         return $rn;
2333 }
2334
2335 function get_server() {
2336         $server = get_config("system", "directory");
2337
2338         if ($server == "") {
2339                 $server = "http://dir.friendi.ca";
2340         }
2341
2342         return($server);
2343 }
2344
2345 function get_cachefile($file, $writemode = true) {
2346         $cache = get_itemcachepath();
2347
2348         if ((! $cache) || (! is_dir($cache))) {
2349                 return("");
2350         }
2351
2352         $subfolder = $cache . "/" . substr($file, 0, 2);
2353
2354         $cachepath = $subfolder . "/" . $file;
2355
2356         if ($writemode) {
2357                 if (!is_dir($subfolder)) {
2358                         mkdir($subfolder);
2359                         chmod($subfolder, 0777);
2360                 }
2361         }
2362
2363         /// @TODO no need to put braces here
2364         return $cachepath;
2365 }
2366
2367 function clear_cache($basepath = "", $path = "") {
2368         if ($path == "") {
2369                 $basepath = get_itemcachepath();
2370                 $path = $basepath;
2371         }
2372
2373         if (($path == "") OR (!is_dir($path))) {
2374                 return;
2375         }
2376
2377         if (substr(realpath($path), 0, strlen($basepath)) != $basepath) {
2378                 return;
2379         }
2380
2381         $cachetime = (int)get_config('system','itemcache_duration');
2382         if ($cachetime == 0) {
2383                 $cachetime = 86400;
2384         }
2385
2386         if (is_writable($path)){
2387                 if ($dh = opendir($path)) {
2388                         while (($file = readdir($dh)) !== false) {
2389                                 $fullpath = $path."/".$file;
2390                                 if ((filetype($fullpath) == "dir") and ($file != ".") and ($file != "..")) {
2391                                         clear_cache($basepath, $fullpath);
2392                                 }
2393                                 if ((filetype($fullpath) == "file") and (filectime($fullpath) < (time() - $cachetime))) {
2394                                         unlink($fullpath);
2395                                 }
2396                         }
2397                         closedir($dh);
2398                 }
2399         }
2400 }
2401
2402 function get_itemcachepath() {
2403         // Checking, if the cache is deactivated
2404         $cachetime = (int)get_config('system','itemcache_duration');
2405         if ($cachetime < 0) {
2406                 return "";
2407         }
2408
2409         $itemcache = get_config('system','itemcache');
2410         if (($itemcache != "") AND App::directory_usable($itemcache)) {
2411                 return $itemcache;
2412         }
2413
2414         $temppath = get_temppath();
2415
2416         if ($temppath != "") {
2417                 $itemcache = $temppath."/itemcache";
2418                 if (!file_exists($itemcache) && !is_dir($itemcache)) {
2419                         mkdir($itemcache);
2420                 }
2421
2422                 if (App::directory_usable($itemcache)) {
2423                         set_config("system", "itemcache", $itemcache);
2424                         return $itemcache;
2425                 }
2426         }
2427         return "";
2428 }
2429
2430 /**
2431  * @brief Returns the path where spool files are stored
2432  *
2433  * @return string Spool path
2434  */
2435 function get_spoolpath() {
2436         $spoolpath = get_config('system','spoolpath');
2437         if (($spoolpath != "") AND App::directory_usable($spoolpath)) {
2438                 // We have a spool path and it is usable
2439                 return $spoolpath;
2440         }
2441
2442         // We don't have a working preconfigured spool path, so we take the temp path.
2443         $temppath = get_temppath();
2444
2445         if ($temppath != "") {
2446                 // To avoid any interferences with other systems we create our own directory
2447                 $spoolpath = $temppath."/spool";
2448                 if (!is_dir($spoolpath)) {
2449                         mkdir($spoolpath);
2450                 }
2451
2452                 if (App::directory_usable($spoolpath)) {
2453                         // The new path is usable, we are happy
2454                         set_config("system", "spoolpath", $spoolpath);
2455                         return $spoolpath;
2456                 } else {
2457                         // We can't create a subdirectory, strange.
2458                         // But the directory seems to work, so we use it but don't store it.
2459                         return $temppath;
2460                 }
2461         }
2462
2463         // Reaching this point means that the operating system is configured badly.
2464         return "";
2465 }
2466
2467 function get_temppath() {
2468         $a = get_app();
2469
2470         $temppath = get_config("system", "temppath");
2471
2472         if (($temppath != "") AND App::directory_usable($temppath)) {
2473                 // We have a temp path and it is usable
2474                 return $temppath;
2475         }
2476
2477         // We don't have a working preconfigured temp path, so we take the system path.
2478         $temppath = sys_get_temp_dir();
2479
2480         // Check if it is usable
2481         if (($temppath != "") AND App::directory_usable($temppath)) {
2482                 // To avoid any interferences with other systems we create our own directory
2483                 $new_temppath .= "/".$a->get_hostname();
2484                 if (!is_dir($new_temppath)) {
2485                         /// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
2486                         mkdir($new_temppath);
2487                 }
2488
2489                 if (App::directory_usable($new_temppath)) {
2490                         // The new path is usable, we are happy
2491                         set_config("system", "temppath", $new_temppath);
2492                         return $new_temppath;
2493                 } else {
2494                         // We can't create a subdirectory, strange.
2495                         // But the directory seems to work, so we use it but don't store it.
2496                         return $temppath;
2497                 }
2498         }
2499
2500         // Reaching this point means that the operating system is configured badly.
2501         return '';
2502 }
2503
2504 /// @deprecated
2505 function set_template_engine(App $a, $engine = 'internal') {
2506 /// @note This function is no longer necessary, but keep it as a wrapper to the class method
2507 /// to avoid breaking themes again unnecessarily
2508 /// @TODO maybe output a warning here so the theme developer can see it? PHP won't show such warnings like Java does.
2509
2510         $a->set_template_engine($engine);
2511 }
2512
2513 if (!function_exists('exif_imagetype')) {
2514         function exif_imagetype($file) {
2515                 $size = getimagesize($file);
2516                 return $size[2];
2517         }
2518 }
2519
2520 function validate_include(&$file) {
2521         $orig_file = $file;
2522
2523         $file = realpath($file);
2524
2525         if (strpos($file, getcwd()) !== 0) {
2526                 return false;
2527         }
2528
2529         $file = str_replace(getcwd()."/", "", $file, $count);
2530         if ($count != 1) {
2531                 return false;
2532         }
2533
2534         if ($orig_file !== $file) {
2535                 return false;
2536         }
2537
2538         $valid = false;
2539         if (strpos($file, "include/") === 0) {
2540                 $valid = true;
2541         }
2542
2543         if (strpos($file, "addon/") === 0) {
2544                 $valid = true;
2545         }
2546
2547         // Simply return flag
2548         return ($valid);
2549 }
2550
2551 function current_load() {
2552         if (!function_exists('sys_getloadavg')) {
2553                 return false;
2554         }
2555
2556         $load_arr = sys_getloadavg();
2557
2558         if (!is_array($load_arr)) {
2559                 return false;
2560         }
2561
2562         return max($load_arr[0], $load_arr[1]);
2563 }
2564
2565 /**
2566  * @brief get c-style args
2567  *
2568  * @return int
2569  */
2570 function argc() {
2571         return get_app()->argc;
2572 }
2573
2574 /**
2575  * @brief Returns the value of a argv key
2576  *
2577  * @param int $x argv key
2578  * @return string Value of the argv key
2579  */
2580 function argv($x) {
2581         if (array_key_exists($x,get_app()->argv)) {
2582                 return get_app()->argv[$x];
2583         }
2584
2585         return '';
2586 }
2587
2588 /**
2589  * @brief Get the data which is needed for infinite scroll
2590  *
2591  * For invinite scroll we need the page number of the actual page
2592  * and the the URI where the content of the next page comes from.
2593  * This data is needed for the js part in main.js.
2594  * Note: infinite scroll does only work for the network page (module)
2595  *
2596  * @param string $module The name of the module (e.g. "network")
2597  * @return array Of infinite scroll data
2598  *      'pageno' => $pageno The number of the actual page
2599  *      'reload_uri' => $reload_uri The URI of the content we have to load
2600  */
2601 function infinite_scroll_data($module) {
2602
2603         if (get_pconfig(local_user(),'system','infinite_scroll')
2604                 AND ($module == "network") AND ($_GET["mode"] != "minimal")) {
2605
2606                 // get the page number
2607                 if (is_string($_GET["page"])) {
2608                         $pageno = $_GET["page"];
2609                 } else {
2610                         $pageno = 1;
2611                 }
2612
2613                 $reload_uri = "";
2614
2615                 // try to get the uri from which we load the content
2616                 foreach ($_GET AS $param => $value) {
2617                         if (($param != "page") AND ($param != "q")) {
2618                                 $reload_uri .= "&" . $param . "=" . urlencode($value);
2619                         }
2620                 }
2621
2622                 if (($a->page_offset != "") AND !strstr($reload_uri, "&offset=")) {
2623                         $reload_uri .= "&offset=" . urlencode($a->page_offset);
2624                 }
2625
2626                 $arr = array("pageno" => $pageno, "reload_uri" => $reload_uri);
2627
2628                 return $arr;
2629         }
2630 }