boot.php

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