boot.php

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