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