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                          * Figure out if we are running at the top of a domain
 674                          * or in a sub-directory and adjust accordingly
 675                          */
 676
 677                         $path = trim(dirname($_SERVER['SCRIPT_NAME']),'/\\');
 678                         if (isset($path) && strlen($path) && ($path != $this->path))
 679                                 $this->path = $path;
 680                 }
 681
 682                 if ($hostname != "")
 683                         $this->hostname = $hostname;
 684
 685                 if (is_array($_SERVER["argv"]) && $_SERVER["argc"]>1 && substr(end($_SERVER["argv"]), 0, 4)=="http" ) {
 686                         $this->set_baseurl(array_pop($_SERVER["argv"]) );
 687                         $_SERVER["argc"] --;
 688                 }
 689
 690                 #set_include_path("include/$this->hostname" . PATH_SEPARATOR . get_include_path());
 691
 692                 if ((x($_SERVER,'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'],0,9) === "pagename=") {
 693                         $this->query_string = substr($_SERVER['QUERY_STRING'],9);
 694                         // removing trailing / - maybe a nginx problem
 695                         if (substr($this->query_string, 0, 1) == "/")
 696                                 $this->query_string = substr($this->query_string, 1);
 697                 } elseif ((x($_SERVER,'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'],0,2) === "q=") {
 698                         $this->query_string = substr($_SERVER['QUERY_STRING'],2);
 699                         // removing trailing / - maybe a nginx problem
 700                         if (substr($this->query_string, 0, 1) == "/")
 701                                 $this->query_string = substr($this->query_string, 1);
 702                 }
 703
 704                 if (x($_GET,'pagename')) {
 705                         $this->cmd = trim($_GET['pagename'],'/\\');
 706                 } elseif (x($_GET,'q')) {
 707                         $this->cmd = trim($_GET['q'],'/\\');
 708                 }
 709
 710
 711                 // fix query_string
 712                 $this->query_string = str_replace($this->cmd."&",$this->cmd."?", $this->query_string);
 713
 714                 // unix style "homedir"
 715
 716                 if (substr($this->cmd,0,1) === '~') {
 717                         $this->cmd = 'profile/' . substr($this->cmd,1);
 718                 }
 719
 720                 // Diaspora style profile url
 721
 722                 if (substr($this->cmd,0,2) === 'u/') {
 723                         $this->cmd = 'profile/' . substr($this->cmd,2);
 724                 }
 725
 726
 727                 /*
 728                  *
 729                  * Break the URL path into C style argc/argv style arguments for our
 730                  * modules. Given "http://example.com/module/arg1/arg2", $this->argc
 731                  * will be 3 (integer) and $this->argv will contain:
 732                  *   [0] => 'module'
 733                  *   [1] => 'arg1'
 734                  *   [2] => 'arg2'
 735                  *
 736                  *
 737                  * There will always be one argument. If provided a naked domain
 738                  * URL, $this->argv[0] is set to "home".
 739                  *
 740                  */
 741
 742                 $this->argv = explode('/',$this->cmd);
 743                 $this->argc = count($this->argv);
 744                 if ((array_key_exists('0',$this->argv)) && strlen($this->argv[0])) {
 745                         $this->module = str_replace(".", "_", $this->argv[0]);
 746                         $this->module = str_replace("-", "_", $this->module);
 747                 } else {
 748                         $this->argc = 1;
 749                         $this->argv = array('home');
 750                         $this->module = 'home';
 751                 }
 752
 753                 /*
 754                  * See if there is any page number information, and initialise
 755                  * pagination
 756                  */
 757
 758                 $this->pager['page'] = ((x($_GET,'page') && intval($_GET['page']) > 0) ? intval($_GET['page']) : 1);
 759                 $this->pager['itemspage'] = 50;
 760                 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
 761                 if ($this->pager['start'] < 0) {
 762                         $this->pager['start'] = 0;
 763                 }
 764                 $this->pager['total'] = 0;
 765
 766                 /*
 767                  * Detect mobile devices
 768                  */
 769
 770                 $mobile_detect = new Mobile_Detect();
 771                 $this->is_mobile = $mobile_detect->isMobile();
 772                 $this->is_tablet = $mobile_detect->isTablet();
 773
 774                 // Friendica-Client
 775                 $this->is_friendica_app = ($_SERVER['HTTP_USER_AGENT'] == "Apache-HttpClient/UNAVAILABLE (java 1.4)");
 776
 777                 /*
 778                  * register template engines
 779                  */
 780                 $dc = get_declared_classes();
 781                 foreach ($dc as $k) {
 782                         if (in_array("ITemplateEngine", class_implements($k))){
 783                                 $this->register_template_engine($k);
 784                         }
 785                 }
 786
 787                 self::$a = $this;
 788
 789         }
 790
 791         public static function get_basepath() {
 792
 793                 $basepath = get_config("system", "basepath");
 794
 795                 if ($basepath == "") {
 796                         $basepath = dirname(__FILE__);
 797                 }
 798
 799                 if ($basepath == "") {
 800                         $basepath = $_SERVER["DOCUMENT_ROOT"];
 801                 }
 802
 803                 if ($basepath == "") {
 804                         $basepath = $_SERVER["PWD"];
 805                 }
 806
 807                 return($basepath);
 808         }
 809
 810         function get_scheme() {
 811                 return($this->scheme);
 812         }
 813
 814         /**
 815          * @brief Retrieves the Friendica instance base URL
 816          *
 817          * This function assembles the base URL from multiple parts:
 818          * - Protocol is determined either by the request or a combination of
 819          * system.ssl_policy and the $ssl parameter.
 820          * - Host name is determined either by system.hostname or inferred from request
 821          * - Path is inferred from SCRIPT_NAME
 822          *
 823          * Note: $ssl parameter value doesn't directly correlate with the resulting protocol
 824          *
 825          * @param bool $ssl Whether to append http or https under SSL_POLICY_SELFSIGN
 826          * @return string Friendica server base URL
 827          */
 828         function get_baseurl($ssl = false) {
 829
 830                 // Is the function called statically?
 831                 if (!(isset($this) && get_class($this) == __CLASS__)) {
 832                         return self::$a->get_baseurl($ssl);
 833                 }
 834
 835                 $scheme = $this->scheme;
 836
 837                 if (Config::get('system', 'ssl_policy') == SSL_POLICY_FULL) {
 838                         $scheme = 'https';
 839                 }
 840
 841                 //      Basically, we have $ssl = true on any links which can only be seen by a logged in user
 842                 //      (and also the login link). Anything seen by an outsider will have it turned off.
 843
 844                 if (Config::get('system', 'ssl_policy') == SSL_POLICY_SELFSIGN) {
 845                         if ($ssl) {
 846                                 $scheme = 'https';
 847                         } else {
 848                                 $scheme = 'http';
 849                         }
 850                 }
 851
 852                 if (Config::get('config', 'hostname') != '') {
 853                         $this->hostname = Config::get('config', 'hostname');
 854                 }
 855
 856                 return $scheme . "://" . $this->hostname . ((isset($this->path) && strlen($this->path)) ? '/' . $this->path : '' );
 857         }
 858
 859         /**
 860          * @brief Initializes the baseurl components
 861          *
 862          * Clears the baseurl cache to prevent inconstistencies
 863          *
 864          * @param string $url
 865          */
 866         function set_baseurl($url) {
 867                 $parsed = @parse_url($url);
 868
 869                 if ($parsed) {
 870                         $this->scheme = $parsed['scheme'];
 871
 872                         $hostname = $parsed['host'];
 873                         if (x($parsed, 'port')) {
 874                                 $hostname .= ':' . $parsed['port'];
 875                         }
 876                         if (x($parsed, 'path')) {
 877                                 $this->path = trim($parsed['path'], '\\/');
 878                         }
 879
 880                         if (file_exists(".htpreconfig.php")) {
 881                                 include(".htpreconfig.php");
 882                         }
 883
 884                         if (get_config('config', 'hostname') != '') {
 885                                 $this->hostname = get_config('config', 'hostname');
 886                         }
 887
 888                         if (!isset($this->hostname) OR ($this->hostname == '')) {
 889                                 $this->hostname = $hostname;
 890                         }
 891                 }
 892         }
 893
 894         function get_hostname() {
 895                 if (get_config('config','hostname') != "") {
 896                         $this->hostname = get_config('config','hostname');
 897                 }
 898
 899                 return $this->hostname;
 900         }
 901
 902         function set_hostname($h) {
 903                 $this->hostname = $h;
 904         }
 905
 906         function set_path($p) {
 907                 $this->path = trim(trim($p),'/');
 908         }
 909
 910         function get_path() {
 911                 return $this->path;
 912         }
 913
 914         function set_pager_total($n) {
 915                 $this->pager['total'] = intval($n);
 916         }
 917
 918         function set_pager_itemspage($n) {
 919                 $this->pager['itemspage'] = ((intval($n) > 0) ? intval($n) : 0);
 920                 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
 921         }
 922
 923         function set_pager_page($n) {
 924                 $this->pager['page'] = $n;
 925                 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
 926         }
 927
 928         function init_pagehead() {
 929                 $interval = ((local_user()) ? get_pconfig(local_user(),'system','update_interval') : 40000);
 930
 931                 // If the update is "deactivated" set it to the highest integer number (~24 days)
 932                 if ($interval < 0) {
 933                         $interval = 2147483647;
 934                 }
 935
 936                 if ($interval < 10000) {
 937                         $interval = 40000;
 938                 }
 939
 940                 // compose the page title from the sitename and the
 941                 // current module called
 942                 if (!$this->module=='') {
 943                         $this->page['title'] = $this->config['sitename'].' ('.$this->module.')';
 944                 } else {
 945                         $this->page['title'] = $this->config['sitename'];
 946                 }
 947
 948                 /* put the head template at the beginning of page['htmlhead']
 949                  * since the code added by the modules frequently depends on it
 950                  * being first
 951                  */
 952                 if (!isset($this->page['htmlhead'])) {
 953                         $this->page['htmlhead'] = '';
 954                 }
 955
 956                 // If we're using Smarty, then doing replace_macros() will replace
 957                 // any unrecognized variables with a blank string. Since we delay
 958                 // replacing $stylesheet until later, we need to replace it now
 959                 // with another variable name
 960                 if ($this->theme['template_engine'] === 'smarty3') {
 961                         $stylesheet = $this->get_template_ldelim('smarty3') . '$stylesheet' . $this->get_template_rdelim('smarty3');
 962                 } else {
 963                         $stylesheet = '$stylesheet';
 964                 }
 965
 966                 $shortcut_icon = get_config("system", "shortcut_icon");
 967                 if ($shortcut_icon == "") {
 968                         $shortcut_icon = "images/friendica-32.png";
 969                 }
 970
 971                 $touch_icon = get_config("system", "touch_icon");
 972                 if ($touch_icon == "") {
 973                         $touch_icon = "images/friendica-128.png";
 974                 }
 975
 976                 // get data wich is needed for infinite scroll on the network page
 977                 $invinite_scroll = infinite_scroll_data($this->module);
 978
 979                 $tpl = get_markup_template('head.tpl');
 980                 $this->page['htmlhead'] = replace_macros($tpl,array(
 981                         '$baseurl' => $this->get_baseurl(), // FIXME for z_path!!!!
 982                         '$local_user' => local_user(),
 983                         '$generator' => 'Friendica' . ' ' . FRIENDICA_VERSION,
 984                         '$delitem' => t('Delete this item?'),
 985                         '$showmore' => t('show more'),
 986                         '$showfewer' => t('show fewer'),
 987                         '$update_interval' => $interval,
 988                         '$shortcut_icon' => $shortcut_icon,
 989                         '$touch_icon' => $touch_icon,
 990                         '$stylesheet' => $stylesheet,
 991                         '$infinite_scroll' => $invinite_scroll,
 992                 )) . $this->page['htmlhead'];
 993         }
 994
 995         function init_page_end() {
 996                 if (!isset($this->page['end'])) {
 997                         $this->page['end'] = '';
 998                 }
 999                 $tpl = get_markup_template('end.tpl');
1000                 $this->page['end'] = replace_macros($tpl,array(
1001                         '$baseurl' => $this->get_baseurl() // FIXME for z_path!!!!
1002                 )) . $this->page['end'];
1003         }
1004
1005         function set_curl_code($code) {
1006                 $this->curl_code = $code;
1007         }
1008
1009         function get_curl_code() {
1010                 return $this->curl_code;
1011         }
1012
1013         function set_curl_content_type($content_type) {
1014                 $this->curl_content_type = $content_type;
1015         }
1016
1017         function get_curl_content_type() {
1018                 return $this->curl_content_type;
1019         }
1020
1021         function set_curl_headers($headers) {
1022                 $this->curl_headers = $headers;
1023         }
1024
1025         function get_curl_headers() {
1026                 return $this->curl_headers;
1027         }
1028
1029         function get_cached_avatar_image($avatar_image){
1030                 return $avatar_image;
1031
1032                 // The following code is deactivated. It doesn't seem to make any sense and it slows down the system.
1033                 /*
1034                 if ($this->cached_profile_image[$avatar_image])
1035                         return $this->cached_profile_image[$avatar_image];
1036
1037                 $path_parts = explode("/",$avatar_image);
1038                 $common_filename = $path_parts[count($path_parts)-1];
1039
1040                 if ($this->cached_profile_picdate[$common_filename]){
1041                         $this->cached_profile_image[$avatar_image] = $avatar_image . $this->cached_profile_picdate[$common_filename];
1042                 } else {
1043                         $r = q("SELECT `contact`.`avatar-date` AS picdate FROM `contact` WHERE `contact`.`thumb` like '%%/%s'",
1044                                 $common_filename);
1045                         if (! dbm::is_result($r)) {
1046                                 $this->cached_profile_image[$avatar_image] = $avatar_image;
1047                         } else {
1048                                 $this->cached_profile_picdate[$common_filename] = "?rev=".urlencode($r[0]['picdate']);
1049                                 $this->cached_profile_image[$avatar_image] = $avatar_image.$this->cached_profile_picdate[$common_filename];
1050                         }
1051                 }
1052                 return $this->cached_profile_image[$avatar_image];
1053                 */
1054         }
1055
1056
1057         /**
1058          * @brief Removes the baseurl from an url. This avoids some mixed content problems.
1059          *
1060          * @param string $orig_url
1061          *
1062          * @return string The cleaned url
1063          */
1064         function remove_baseurl($orig_url){
1065
1066                 // Is the function called statically?
1067                 if (!(isset($this) && get_class($this) == __CLASS__)) {
1068                         return(self::$a->remove_baseurl($orig_url));
1069                 }
1070
1071                 // Remove the hostname from the url if it is an internal link
1072                 $nurl = normalise_link($orig_url);
1073                 $base = normalise_link($this->get_baseurl());
1074                 $url = str_replace($base."/", "", $nurl);
1075
1076                 // if it is an external link return the orignal value
1077                 if ($url == normalise_link($orig_url)) {
1078                         return $orig_url;
1079                 } else {
1080                         return $url;
1081                 }
1082         }
1083
1084         /**
1085          * @brief Register template engine class
1086          *
1087          * If $name is "", is used class static property $class::$name
1088          *
1089          * @param string $class
1090          * @param string $name
1091          */
1092         function register_template_engine($class, $name = '') {
1093                 if ($name===""){
1094                         $v = get_class_vars( $class );
1095                         if (x($v,"name")) $name = $v['name'];
1096                 }
1097                 if ($name===""){
1098                         echo "template engine <tt>$class</tt> cannot be registered without a name.\n";
1099                         killme();
1100                 }
1101                 $this->template_engines[$name] = $class;
1102         }
1103
1104         /**
1105          * @brief Return template engine instance.
1106          *
1107          * If $name is not defined, return engine defined by theme,
1108          * or default
1109          *
1110          * @param strin $name Template engine name
1111          * @return object Template Engine instance
1112          */
1113         function template_engine($name = ''){
1114                 if ($name!=="") {
1115                         $template_engine = $name;
1116                 } else {
1117                         $template_engine = 'smarty3';
1118                         if (x($this->theme, 'template_engine')) {
1119                                 $template_engine = $this->theme['template_engine'];
1120                         }
1121                 }
1122
1123                 if (isset($this->template_engines[$template_engine])){
1124                         if (isset($this->template_engine_instance[$template_engine])){
1125                                 return $this->template_engine_instance[$template_engine];
1126                         } else {
1127                                 $class = $this->template_engines[$template_engine];
1128                                 $obj = new $class;
1129                                 $this->template_engine_instance[$template_engine] = $obj;
1130                                 return $obj;
1131                         }
1132                 }
1133
1134                 echo "template engine <tt>$template_engine</tt> is not registered!\n"; killme();
1135         }
1136
1137         /**
1138          * @brief Returns the active template engine.
1139          *
1140          * @return string
1141          */
1142         function get_template_engine() {
1143                 return $this->theme['template_engine'];
1144         }
1145
1146         function set_template_engine($engine = 'smarty3') {
1147                 $this->theme['template_engine'] = $engine;
1148                 /*
1149                 $this->theme['template_engine'] = 'smarty3';
1150
1151                 switch($engine) {
1152                         case 'smarty3':
1153                                 if (is_writable('view/smarty3/'))
1154                                         $this->theme['template_engine'] = 'smarty3';
1155                                 break;
1156                         default:
1157                                 break;
1158                 }
1159                 */
1160         }
1161
1162         function get_template_ldelim($engine = 'smarty3') {
1163                 return $this->ldelim[$engine];
1164         }
1165
1166         function get_template_rdelim($engine = 'smarty3') {
1167                 return $this->rdelim[$engine];
1168         }
1169
1170         function save_timestamp($stamp, $value) {
1171                 if (!isset($this->config['system']['profiler']) || !$this->config['system']['profiler']) {
1172                         return;
1173                 }
1174
1175                 $duration = (float)(microtime(true)-$stamp);
1176
1177                 if (!isset($this->performance[$value])) {
1178                         // Prevent ugly E_NOTICE
1179                         $this->performance[$value] = 0;
1180                 }
1181
1182                 $this->performance[$value] += (float)$duration;
1183                 $this->performance["marktime"] += (float)$duration;
1184
1185                 $callstack = $this->callstack();
1186
1187                 if (!isset($this->callstack[$value][$callstack])) {
1188                         // Prevent ugly E_NOTICE
1189                         $this->callstack[$value][$callstack] = 0;
1190                 }
1191
1192                 $this->callstack[$value][$callstack] += (float)$duration;
1193
1194         }
1195
1196         /**
1197          * @brief Log active processes into the "process" table
1198          */
1199         function start_process() {
1200                 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1);
1201
1202                 $command = basename($trace[0]["file"]);
1203
1204                 $this->remove_inactive_processes();
1205
1206                 q("START TRANSACTION");
1207
1208                 $r = q("SELECT `pid` FROM `process` WHERE `pid` = %d", intval(getmypid()));
1209                 if (!dbm::is_result($r)) {
1210                         q("INSERT INTO `process` (`pid`,`command`,`created`) VALUES (%d, '%s', '%s')",
1211                                 intval(getmypid()),
1212                                 dbesc($command),
1213                                 dbesc(datetime_convert()));
1214                 }
1215                 q("COMMIT");
1216         }
1217
1218         /**
1219          * @brief Remove inactive processes
1220          */
1221         function remove_inactive_processes() {
1222                 q("START TRANSACTION");
1223
1224                 $r = q("SELECT `pid` FROM `process`");
1225                 if (dbm::is_result($r)) {
1226                         foreach ($r AS $process) {
1227                                 if (!posix_kill($process["pid"], 0)) {
1228                                         q("DELETE FROM `process` WHERE `pid` = %d", intval($process["pid"]));
1229                                 }
1230                         }
1231                 }
1232                 q("COMMIT");
1233         }
1234
1235         /**
1236          * @brief Remove the active process from the "process" table
1237          */
1238         function end_process() {
1239                 q("DELETE FROM `process` WHERE `pid` = %d", intval(getmypid()));
1240         }
1241
1242         /**
1243          * @brief Returns a string with a callstack. Can be used for logging.
1244          *
1245          * @return string
1246          */
1247         function callstack() {
1248                 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 6);
1249
1250                 // We remove the first two items from the list since they contain data that we don't need.
1251                 array_shift($trace);
1252                 array_shift($trace);
1253
1254                 $callstack = array();
1255                 foreach ($trace AS $func) {
1256                         $callstack[] = $func["function"];
1257                 }
1258
1259                 return implode(", ", $callstack);
1260         }
1261
1262         function get_useragent() {
1263                 return(FRIENDICA_PLATFORM." '".FRIENDICA_CODENAME."' ".FRIENDICA_VERSION."-".DB_UPDATE_VERSION."; ".$this->get_baseurl());
1264         }
1265
1266         function is_friendica_app() {
1267                 return($this->is_friendica_app);
1268         }
1269
1270         /**
1271          * @brief Checks if the site is called via a backend process
1272          *
1273          * This isn't a perfect solution. But we need this check very early.
1274          * So we cannot wait until the modules are loaded.
1275          *
1276          * @return bool Is it a known backend?
1277          */
1278         function is_backend() {
1279                 static $backend = array(
1280                         "_well_known",
1281                         "api",
1282                         "dfrn_notify",
1283                         "fetch",
1284                         "hcard",
1285                         "hostxrd",
1286                         "nodeinfo",
1287                         "noscrape",
1288                         "p",
1289                         "poco",
1290                         "post",
1291                         "proxy",
1292                         "pubsub",
1293                         "pubsubhubbub",
1294                         "receive",
1295                         "rsd_xml",
1296                         "salmon",
1297                         "statistics_json",
1298                         "xrd",
1299                 );
1300
1301                 if (in_array($this->module, $backend)) {
1302                         return(true);
1303                 } else {
1304                         return($this->backend);
1305                 }
1306         }
1307
1308         /**
1309          * @brief Checks if the maximum number of database processes is reached
1310          *
1311          * @return bool Is the limit reached?
1312          */
1313         function max_processes_reached() {
1314
1315                 if ($this->is_backend()) {
1316                         $process = "backend";
1317                         $max_processes = get_config('system', 'max_processes_backend');
1318                         if (intval($max_processes) == 0) {
1319                                 $max_processes = 5;
1320                         }
1321                 } else {
1322                         $process = "frontend";
1323                         $max_processes = get_config('system', 'max_processes_frontend');
1324                         if (intval($max_processes) == 0) {
1325                                 $max_processes = 20;
1326                         }
1327                 }
1328
1329                 $processlist = dbm::processlist();
1330                 if ($processlist["list"] != "") {
1331                         logger("Processcheck: Processes: ".$processlist["amount"]." - Processlist: ".$processlist["list"], LOGGER_DEBUG);
1332
1333                         if ($processlist["amount"] > $max_processes) {
1334                                 logger("Processcheck: Maximum number of processes for ".$process." tasks (".$max_processes.") reached.", LOGGER_DEBUG);
1335                                 return true;
1336                         }
1337                 }
1338                 return false;
1339         }
1340
1341         /**
1342          * @brief Checks if the maximum load is reached
1343          *
1344          * @return bool Is the load reached?
1345          */
1346         function maxload_reached() {
1347
1348                 if ($this->is_backend()) {
1349                         $process = "backend";
1350                         $maxsysload = intval(get_config('system', 'maxloadavg'));
1351                         if ($maxsysload < 1) {
1352                                 $maxsysload = 50;
1353                         }
1354                 } else {
1355                         $process = "frontend";
1356                         $maxsysload = intval(get_config('system','maxloadavg_frontend'));
1357                         if ($maxsysload < 1) {
1358                                 $maxsysload = 50;
1359                         }
1360                 }
1361
1362                 $load = current_load();
1363                 if ($load) {
1364                         if (intval($load) > $maxsysload) {
1365                                 logger('system: load '.$load.' for '.$process.' tasks ('.$maxsysload.') too high.');
1366                                 return true;
1367                         }
1368                 }
1369                 return false;
1370         }
1371
1372         function proc_run($args) {
1373
1374                 if (!function_exists("proc_open")) {
1375                         return;
1376                 }
1377
1378                 // If the last worker fork was less than 10 seconds before then don't fork another one.
1379                 // This should prevent the forking of masses of workers.
1380                 $cachekey = "app:proc_run:started";
1381                 $result = Cache::get($cachekey);
1382                 /// @TODO maybe merge these both into one if() ?
1383                 if (!is_null($result)) {
1384                         if ((time() - $result) < 10) {
1385                                 return;
1386                         }
1387                 }
1388                 // Set the timestamp of the last proc_run
1389                 Cache::set($cachekey, time(), CACHE_MINUTE);
1390
1391                 array_unshift($args, ((x($this->config,'php_path')) && (strlen($this->config['php_path'])) ? $this->config['php_path'] : 'php'));
1392
1393                 // add baseurl to args. cli scripts can't construct it
1394                 $args[] = $this->get_baseurl();
1395
1396                 for ($x = 0; $x < count($args); $x ++) {
1397                         $args[$x] = escapeshellarg($args[$x]);
1398                 }
1399
1400                 $cmdline = implode($args," ");
1401
1402                 if (get_config('system','proc_windows')) {
1403                         proc_close(proc_open('cmd /c start /b ' . $cmdline,array(),$foo,dirname(__FILE__)));
1404                 } else {
1405                         proc_close(proc_open($cmdline." &",array(),$foo,dirname(__FILE__)));
1406                 }
1407         }
1408
1409         /**
1410          * @brief Returns the system user that is executing the script
1411          *
1412          * This mostly returns something like "www-data".
1413          *
1414          * @return string system username
1415          */
1416         static function systemuser() {
1417                 if (!function_exists('posix_getpwuid') OR !function_exists('posix_geteuid')) {
1418                         return '';
1419                 }
1420
1421                 $processUser = posix_getpwuid(posix_geteuid());
1422                 return $processUser['name'];
1423         }
1424
1425         /**
1426          * @brief Checks if a given directory is usable for the system
1427          *
1428          * @return boolean the directory is usable
1429          */
1430         static function directory_usable($directory) {
1431
1432                 if ($directory == '') {
1433                         logger("Directory is empty. This shouldn't happen.", LOGGER_DEBUG);
1434                         return false;
1435                 }
1436
1437                 if (!file_exists($directory)) {
1438                         logger('Path "'.$directory.'" does not exist for user '.self::systemuser(), LOGGER_DEBUG);
1439                         return false;
1440                 }
1441                 if (is_file($directory)) {
1442                         logger('Path "'.$directory.'" is a file for user '.self::systemuser(), LOGGER_DEBUG);
1443                         return false;
1444                 }
1445                 if (!is_dir($directory)) {
1446                         logger('Path "'.$directory.'" is not a directory for user '.self::systemuser(), LOGGER_DEBUG);
1447                         return false;
1448                 }
1449                 if (!is_writable($directory)) {
1450                         logger('Path "'.$directory.'" is not writable for user '.self::systemuser(), LOGGER_DEBUG);
1451                         return false;
1452                 }
1453                 return true;
1454         }
1455 }
1456
1457 /**
1458  * @brief Retrieve the App structure
1459  *
1460  * Useful in functions which require it but don't get it passed to them
1461  */
1462 function get_app() {
1463         global $a;
1464         return $a;
1465 }
1466
1467
1468 /**
1469  * @brief Multi-purpose function to check variable state.
1470  *
1471  * Usage: x($var) or $x($array, 'key')
1472  *
1473  * returns false if variable/key is not set
1474  * if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0.
1475  * e.g. x('') or x(0) returns 0;
1476  *
1477  * @param string|array $s variable to check
1478  * @param string $k key inside the array to check
1479  *
1480  * @return bool|int
1481  */
1482 function x($s,$k = NULL) {
1483         if ($k != NULL) {
1484                 if ((is_array($s)) && (array_key_exists($k,$s))) {
1485                         if ($s[$k]) {
1486                                 return (int) 1;
1487                         }
1488                         return (int) 0;
1489                 }
1490                 return false;
1491         } else {
1492                 if (isset($s)) {
1493                         if ($s) {
1494                                 return (int) 1;
1495                         }
1496                         return (int) 0;
1497                 }
1498                 return false;
1499         }
1500 }
1501
1502
1503 /**
1504  * @brief Called from db initialisation if db is dead.
1505  */
1506 function system_unavailable() {
1507         include('system_unavailable.php');
1508         system_down();
1509         killme();
1510 }
1511
1512
1513 function clean_urls() {
1514         $a = get_app();
1515         return true;
1516 }
1517
1518 function z_path() {
1519         $base = App::get_baseurl();
1520
1521         if (! clean_urls()) {
1522                 $base .= '/?q=';
1523         }
1524
1525         return $base;
1526 }
1527
1528 /**
1529  * @brief Returns the baseurl.
1530  *
1531  * @see App::get_baseurl()
1532  *
1533  * @return string
1534  * @TODO Maybe super-flous and deprecated? Seems to only wrap App::get_baseurl()
1535  */
1536 function z_root() {
1537         return App::get_baseurl();
1538 }
1539
1540 /**
1541  * @brief Return absolut URL for given $path.
1542  *
1543  * @param string $path
1544  *
1545  * @return string
1546  */
1547 function absurl($path) {
1548         if (strpos($path,'/') === 0) {
1549                 return z_path() . $path;
1550         }
1551         return $path;
1552 }
1553
1554 /**
1555  * @brief Function to check if request was an AJAX (xmlhttprequest) request.
1556  *
1557  * @return boolean
1558  */
1559 function is_ajax() {
1560         return (!empty($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest');
1561 }
1562
1563 function check_db() {
1564
1565         $build = get_config('system','build');
1566         if (! x($build)) {
1567                 set_config('system','build',DB_UPDATE_VERSION);
1568                 $build = DB_UPDATE_VERSION;
1569         }
1570         if ($build != DB_UPDATE_VERSION) {
1571                 proc_run(PRIORITY_CRITICAL, 'include/dbupdate.php');
1572         }
1573
1574 }
1575
1576
1577 /**
1578  * Sets the base url for use in cmdline programs which don't have
1579  * $_SERVER variables
1580  */
1581 function check_url(App $a) {
1582
1583         $url = get_config('system','url');
1584
1585         // if the url isn't set or the stored url is radically different
1586         // than the currently visited url, store the current value accordingly.
1587         // "Radically different" ignores common variations such as http vs https
1588         // and www.example.com vs example.com.
1589         // We will only change the url to an ip address if there is no existing setting
1590
1591         if (! x($url)) {
1592                 $url = set_config('system','url',App::get_baseurl());
1593         }
1594         if ((! link_compare($url,App::get_baseurl())) && (! preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/",$a->get_hostname))) {
1595                 $url = set_config('system','url',App::get_baseurl());
1596         }
1597
1598         return;
1599 }
1600
1601
1602 /**
1603  * @brief Automatic database updates
1604  */
1605 function update_db(App $a) {
1606         $build = get_config('system','build');
1607         if (! x($build)) {
1608                 $build = set_config('system','build',DB_UPDATE_VERSION);
1609         }
1610
1611         if ($build != DB_UPDATE_VERSION) {
1612                 $stored = intval($build);
1613                 $current = intval(DB_UPDATE_VERSION);
1614                 if ($stored < $current) {
1615                         Config::load('database');
1616
1617                         // We're reporting a different version than what is currently installed.
1618                         // Run any existing update scripts to bring the database up to current.
1619
1620                         // make sure that boot.php and update.php are the same release, we might be
1621                         // updating right this very second and the correct version of the update.php
1622                         // file may not be here yet. This can happen on a very busy site.
1623
1624                         if (DB_UPDATE_VERSION == UPDATE_VERSION) {
1625                                 // Compare the current structure with the defined structure
1626
1627                                 $t = get_config('database','dbupdate_'.DB_UPDATE_VERSION);
1628                                 if ($t !== false) {
1629                                         return;
1630                                 }
1631
1632                                 set_config('database','dbupdate_'.DB_UPDATE_VERSION, time());
1633
1634                                 // run old update routine (wich could modify the schema and
1635                                 // conflits with new routine)
1636                                 for ($x = $stored; $x < NEW_UPDATE_ROUTINE_VERSION; $x++) {
1637                                         $r = run_update_function($x);
1638                                         if (!$r) {
1639                                                 break;
1640                                         }
1641                                 }
1642                                 if ($stored < NEW_UPDATE_ROUTINE_VERSION) {
1643                                         $stored = NEW_UPDATE_ROUTINE_VERSION;
1644                                 }
1645
1646                                 // run new update routine
1647                                 // it update the structure in one call
1648                                 $retval = update_structure(false, true);
1649                                 if ($retval) {
1650                                         update_fail(
1651                                                 DB_UPDATE_VERSION,
1652                                                 $retval
1653                                         );
1654                                         return;
1655                                 } else {
1656                                         set_config('database','dbupdate_'.DB_UPDATE_VERSION, 'success');
1657                                 }
1658
1659                                 // run any left update_nnnn functions in update.php
1660                                 for ($x = $stored; $x < $current; $x ++) {
1661                                         $r = run_update_function($x);
1662                                         if (!$r) {
1663                                                 break;
1664                                         }
1665                                 }
1666                         }
1667                 }
1668         }
1669
1670         return;
1671 }
1672
1673 function run_update_function($x) {
1674         if (function_exists('update_' . $x)) {
1675
1676                 // There could be a lot of processes running or about to run.
1677                 // We want exactly one process to run the update command.
1678                 // So store the fact that we're taking responsibility
1679                 // after first checking to see if somebody else already has.
1680
1681                 // If the update fails or times-out completely you may need to
1682                 // delete the config entry to try again.
1683
1684                 $t = get_config('database','update_' . $x);
1685                 if ($t !== false) {
1686                         return false;
1687                 }
1688                 set_config('database','update_' . $x, time());
1689
1690                 // call the specific update
1691
1692                 $func = 'update_' . $x;
1693                 $retval = $func();
1694
1695                 if ($retval) {
1696                         //send the administrator an e-mail
1697                         update_fail(
1698                                 $x,
1699                                 sprintf(t('Update %s failed. See error logs.'), $x)
1700                         );
1701                         return false;
1702                 } else {
1703                         set_config('database','update_' . $x, 'success');
1704                         set_config('system','build', $x + 1);
1705                         return true;
1706                 }
1707         } else {
1708                 set_config('database','update_' . $x, 'success');
1709                 set_config('system','build', $x + 1);
1710                 return true;
1711         }
1712         return true;
1713 }
1714
1715 /**
1716  * @brief Synchronise plugins:
1717  *
1718  * $a->config['system']['addon'] contains a comma-separated list of names
1719  * of plugins/addons which are used on this system.
1720  * Go through the database list of already installed addons, and if we have
1721  * an entry, but it isn't in the config list, call the uninstall procedure
1722  * and mark it uninstalled in the database (for now we'll remove it).
1723  * Then go through the config list and if we have a plugin that isn't installed,
1724  * call the install procedure and add it to the database.
1725  *
1726  * @param App $a
1727  *
1728  */
1729 function check_plugins(App $a) {
1730
1731         $r = q("SELECT * FROM `addon` WHERE `installed` = 1");
1732         if (dbm::is_result($r)) {
1733                 $installed = $r;
1734         } else {
1735                 $installed = array();
1736         }
1737
1738         $plugins = get_config('system','addon');
1739         $plugins_arr = array();
1740
1741         if ($plugins) {
1742                 $plugins_arr = explode(',',str_replace(' ', '',$plugins));
1743         }
1744
1745         $a->plugins = $plugins_arr;
1746
1747         $installed_arr = array();
1748
1749         if (count($installed)) {
1750                 foreach ($installed as $i) {
1751                         if (! in_array($i['name'],$plugins_arr)) {
1752                                 uninstall_plugin($i['name']);
1753                         } else {
1754                                 $installed_arr[] = $i['name'];
1755                         }
1756                 }
1757         }
1758
1759         if (count($plugins_arr)) {
1760                 foreach ($plugins_arr as $p) {
1761                         if (! in_array($p,$installed_arr)) {
1762                                 install_plugin($p);
1763                         }
1764                 }
1765         }
1766
1767
1768         load_hooks();
1769
1770         return;
1771 }
1772
1773 function get_guid($size=16, $prefix = "") {
1774
1775         if ($prefix == "") {
1776                 $a = get_app();
1777                 $prefix = hash("crc32", $a->get_hostname());
1778         }
1779
1780         while (strlen($prefix) < ($size - 13))
1781                 $prefix .= mt_rand();
1782
1783         if ($size >= 24) {
1784                 $prefix = substr($prefix, 0, $size - 22);
1785                 return(str_replace(".", "", uniqid($prefix, true)));
1786         } else {
1787                 $prefix = substr($prefix, 0, max($size - 13, 0));
1788                 return(uniqid($prefix));
1789         }
1790 }
1791
1792 /**
1793  * @brief Wrapper for adding a login box.
1794  *
1795  * @param bool $register
1796  *      If $register == true provide a registration link.
1797  *      This will most always depend on the value of $a->config['register_policy'].
1798  * @param bool $hiddens
1799  *
1800  * @return string
1801  *      Returns the complete html for inserting into the page
1802  *
1803  * @hooks 'login_hook'
1804  *      string $o
1805  */
1806 function login($register = false, $hiddens=false) {
1807         $a = get_app();
1808         $o = "";
1809         $reg = false;
1810         if ($register) {
1811                 $reg = array(
1812                         'title' => t('Create a New Account'),
1813                         'desc' => t('Register')
1814                 );
1815         }
1816
1817         $noid = get_config('system','no_openid');
1818
1819         $dest_url = $a->query_string;
1820
1821         if (local_user()) {
1822                 $tpl = get_markup_template("logout.tpl");
1823         } else {
1824                 $a->page['htmlhead'] .= replace_macros(get_markup_template("login_head.tpl"),array(
1825                         '$baseurl'              => $a->get_baseurl(true)
1826                 ));
1827
1828                 $tpl = get_markup_template("login.tpl");
1829                 $_SESSION['return_url'] = $a->query_string;
1830                 $a->module = 'login';
1831         }
1832
1833         $o .= replace_macros($tpl, array(
1834
1835                 '$dest_url'     => $dest_url,
1836                 '$logout'       => t('Logout'),
1837                 '$login'        => t('Login'),
1838
1839                 '$lname'        => array('username', t('Nickname or Email: ') , '', ''),
1840                 '$lpassword'    => array('password', t('Password: '), '', ''),
1841                 '$lremember'    => array('remember', t('Remember me'), 0,  ''),
1842
1843                 '$openid'       => !$noid,
1844                 '$lopenid'      => array('openid_url', t('Or login using OpenID: '),'',''),
1845
1846                 '$hiddens'      => $hiddens,
1847
1848                 '$register'     => $reg,
1849
1850                 '$lostpass'     => t('Forgot your password?'),
1851                 '$lostlink'     => t('Password Reset'),
1852
1853                 '$tostitle'     => t('Website Terms of Service'),
1854                 '$toslink'      => t('terms of service'),
1855
1856                 '$privacytitle' => t('Website Privacy Policy'),
1857                 '$privacylink'  => t('privacy policy'),
1858
1859         ));
1860
1861         call_hooks('login_hook',$o);
1862
1863         return $o;
1864 }
1865
1866 /**
1867  * @brief Used to end the current process, after saving session state.
1868  */
1869 function killme() {
1870
1871         if (!get_app()->is_backend()) {
1872                 session_write_close();
1873         }
1874
1875         exit;
1876 }
1877
1878 /**
1879  * @brief Redirect to another URL and terminate this process.
1880  */
1881 function goaway($s) {
1882         if (!strstr(normalise_link($s), "http://")) {
1883                 $s = App::get_baseurl()."/".$s;
1884         }
1885
1886         header("Location: $s");
1887         killme();
1888 }
1889
1890
1891 /**
1892  * @brief Returns the user id of locally logged in user or false.
1893  *
1894  * @return int|bool user id or false
1895  */
1896 function local_user() {
1897         if (x($_SESSION, 'authenticated') && x($_SESSION, 'uid')) {
1898                 return intval($_SESSION['uid']);
1899         }
1900         return false;
1901 }
1902
1903 /**
1904  * @brief Returns the public contact id of logged in user or false.
1905  *
1906  * @return int|bool public contact id or false
1907  */
1908 function public_contact() {
1909         static $public_contact_id = false;
1910
1911         if (!$public_contact_id && x($_SESSION, 'authenticated')) {
1912                 if (x($_SESSION, 'my_address')) {
1913                         // Local user
1914                         $public_contact_id = intval(get_contact($_SESSION['my_address'], 0));
1915                 } else if (x($_SESSION, 'visitor_home')) {
1916                         // Remote user
1917                         $public_contact_id = intval(get_contact($_SESSION['visitor_home'], 0));
1918                 }
1919         } else if (!x($_SESSION, 'authenticated')) {
1920                 $public_contact_id = false;
1921         }
1922
1923         return $public_contact_id;
1924 }
1925
1926 /**
1927  * @brief Returns contact id of authenticated site visitor or false
1928  *
1929  * @return int|bool visitor_id or false
1930  */
1931 function remote_user() {
1932         if ((x($_SESSION,'authenticated')) && (x($_SESSION,'visitor_id'))) {
1933                 return intval($_SESSION['visitor_id']);
1934         }
1935         return false;
1936 }
1937
1938 /**
1939  * @brief Show an error message to user.
1940  *
1941  * This function save text in session, to be shown to the user at next page load
1942  *
1943  * @param string $s - Text of notice
1944  */
1945 function notice($s) {
1946         $a = get_app();
1947         if (! x($_SESSION,'sysmsg')) {
1948                 $_SESSION['sysmsg'] = array();
1949         }
1950         if ($a->interactive) {
1951                 $_SESSION['sysmsg'][] = $s;
1952         }
1953 }
1954
1955 /**
1956  * @brief Show an info message to user.
1957  *
1958  * This function save text in session, to be shown to the user at next page load
1959  *
1960  * @param string $s - Text of notice
1961  */
1962 function info($s) {
1963         $a = get_app();
1964
1965         if (local_user() AND get_pconfig(local_user(),'system','ignore_info')) {
1966                 return;
1967         }
1968
1969         if (! x($_SESSION,'sysmsg_info')) {
1970                 $_SESSION['sysmsg_info'] = array();
1971         }
1972         if ($a->interactive) {
1973                 $_SESSION['sysmsg_info'][] = $s;
1974         }
1975 }
1976
1977
1978 /**
1979  * @brief Wrapper around config to limit the text length of an incoming message
1980  *
1981  * @return int
1982  */
1983 function get_max_import_size() {
1984         $a = get_app();
1985         return ((x($a->config,'max_import_size')) ? $a->config['max_import_size'] : 0 );
1986 }
1987
1988 /**
1989  * @brief Wrap calls to proc_close(proc_open()) and call hook
1990  *      so plugins can take part in process :)
1991  *
1992  * @param (integer|array) priority or parameter array, $cmd atrings are deprecated and are ignored
1993  *
1994  * next args are passed as $cmd command line
1995  * or: proc_run(PRIORITY_HIGH, "include/notifier.php", "drop", $drop_id);
1996  * or: proc_run(array('priority' => PRIORITY_HIGH, 'dont_fork' => true), "include/create_shadowentry.php", $post_id);
1997  *
1998  * @note $cmd and string args are surrounded with ""
1999  *
2000  * @hooks 'proc_run'
2001  *      array $arr
2002  */
2003 function proc_run($cmd){
2004
2005         $a = get_app();
2006
2007         $proc_args = func_get_args();
2008
2009         $args = array();
2010         if (!count($proc_args)) {
2011                 return;
2012         }
2013
2014         // Preserve the first parameter
2015         // It could contain a command, the priority or an parameter array
2016         // If we use the parameter array we have to protect it from the following function
2017         $run_parameter = array_shift($proc_args);
2018
2019         // expand any arrays
2020         foreach ($proc_args as $arg) {
2021                 if (is_array($arg)) {
2022                         foreach ($arg as $n) {
2023                                 $args[] = $n;
2024                         }
2025                 } else {
2026                         $args[] = $arg;
2027                 }
2028         }
2029
2030         // Now we add the run parameters back to the array
2031         array_unshift($args, $run_parameter);
2032
2033         $arr = array('args' => $args, 'run_cmd' => true);
2034
2035         call_hooks("proc_run", $arr);
2036         if (!$arr['run_cmd'] OR !count($args)) {
2037                 return;
2038         }
2039
2040         $priority = PRIORITY_MEDIUM;
2041         $dont_fork = get_config("system", "worker_dont_fork");
2042
2043         if (is_int($run_parameter)) {
2044                 $priority = $run_parameter;
2045         } elseif (is_array($run_parameter)) {
2046                 if (isset($run_parameter['priority'])) {
2047                         $priority = $run_parameter['priority'];
2048                 }
2049                 if (isset($run_parameter['dont_fork'])) {
2050                         $dont_fork = $run_parameter['dont_fork'];
2051                 }
2052         }
2053
2054         $argv = $args;
2055         array_shift($argv);
2056
2057         $parameters = json_encode($argv);
2058         $found = q("SELECT `id` FROM `workerqueue` WHERE `parameter` = '%s'",
2059                 dbesc($parameters));
2060
2061         if (!dbm::is_result($found)) {
2062                 q("INSERT INTO `workerqueue` (`parameter`, `created`, `priority`)
2063                         VALUES ('%s', '%s', %d)",
2064                         dbesc($parameters),
2065                         dbesc(datetime_convert()),
2066                         intval($priority));
2067         }
2068
2069         // Should we quit and wait for the poller to be called as a cronjob?
2070         if ($dont_fork) {
2071                 return;
2072         }
2073
2074         // Checking number of workers
2075         $workers = q("SELECT COUNT(*) AS `workers` FROM `workerqueue` WHERE `executed` > '%s'", dbesc(NULL_DATE));
2076
2077         // Get number of allowed number of worker threads
2078         $queues = intval(get_config("system", "worker_queues"));
2079
2080         if ($queues == 0) {
2081                 $queues = 4;
2082         }
2083
2084         // If there are already enough workers running, don't fork another one
2085         if ($workers[0]["workers"] >= $queues) {
2086                 return;
2087         }
2088
2089         // Now call the poller to execute the jobs that we just added to the queue
2090         $args = array("include/poller.php", "no_cron");
2091
2092         $a->proc_run($args);
2093 }
2094
2095 function current_theme(){
2096         $app_base_themes = array('duepuntozero', 'dispy', 'quattro');
2097
2098         $a = get_app();
2099
2100         $page_theme = null;
2101
2102         // Find the theme that belongs to the user whose stuff we are looking at
2103
2104         if ($a->profile_uid && ($a->profile_uid != local_user())) {
2105                 $r = q("select theme from user where uid = %d limit 1",
2106                         intval($a->profile_uid)
2107                 );
2108                 if (dbm::is_result($r)) {
2109                         $page_theme = $r[0]['theme'];
2110                 }
2111         }
2112
2113         // Allow folks to over-rule user themes and always use their own on their own site.
2114         // This works only if the user is on the same server
2115
2116         if ($page_theme && local_user() && (local_user() != $a->profile_uid)) {
2117                 if (get_pconfig(local_user(),'system','always_my_theme')) {
2118                         $page_theme = null;
2119                 }
2120         }
2121
2122 //              $mobile_detect = new Mobile_Detect();
2123 //              $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
2124         $is_mobile = $a->is_mobile || $a->is_tablet;
2125
2126         $standard_system_theme = Config::get('system', 'theme', '');
2127         $standard_theme_name = ((isset($_SESSION) && x($_SESSION,'theme')) ? $_SESSION['theme'] : $standard_system_theme);
2128
2129         if ($is_mobile) {
2130                 if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
2131                         $system_theme = $standard_system_theme;
2132                         $theme_name = $standard_theme_name;
2133                 } else {
2134                         $system_theme = Config::get('system', 'mobile-theme', '');
2135                         if ($system_theme == '') {
2136                                 $system_theme = $standard_system_theme;
2137                         }
2138                         $theme_name = ((isset($_SESSION) && x($_SESSION,'mobile-theme')) ? $_SESSION['mobile-theme'] : $system_theme);
2139
2140                         if ($theme_name === '---') {
2141                                 // user has selected to have the mobile theme be the same as the normal one
2142                                 $system_theme = $standard_system_theme;
2143                                 $theme_name = $standard_theme_name;
2144
2145                                 if ($page_theme) {
2146                                         $theme_name = $page_theme;
2147                                 }
2148                         }
2149                 }
2150         } else {
2151                 $system_theme = $standard_system_theme;
2152                 $theme_name = $standard_theme_name;
2153
2154                 if ($page_theme) {
2155                         $theme_name = $page_theme;
2156                 }
2157         }
2158
2159         if ($theme_name &&
2160                         (file_exists('view/theme/' . $theme_name . '/style.css') ||
2161                                         file_exists('view/theme/' . $theme_name . '/style.php'))) {
2162                 return($theme_name);
2163         }
2164
2165         foreach ($app_base_themes as $t) {
2166                 if (file_exists('view/theme/' . $t . '/style.css') ||
2167                                 file_exists('view/theme/' . $t . '/style.php')) {
2168                         return($t);
2169                 }
2170         }
2171
2172         $fallback = array_merge(glob('view/theme/*/style.css'),glob('view/theme/*/style.php'));
2173         if (count($fallback)) {
2174                 return (str_replace('view/theme/','', substr($fallback[0],0,-10)));
2175         }
2176
2177         /// @TODO No final return statement?
2178
2179 }
2180
2181 /**
2182  * @brief Return full URL to theme which is currently in effect.
2183  *
2184  * Provide a sane default if nothing is chosen or the specified theme does not exist.
2185  *
2186  * @return string
2187  */
2188 function current_theme_url() {
2189         $a = get_app();
2190
2191         $t = current_theme();
2192
2193         $opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : '');
2194         if (file_exists('view/theme/' . $t . '/style.php')) {
2195                 return('view/theme/'.$t.'/style.pcss'.$opts);
2196         }
2197
2198         return('view/theme/'.$t.'/style.css');
2199 }
2200
2201 function feed_birthday($uid,$tz) {
2202
2203         /**
2204          *
2205          * Determine the next birthday, but only if the birthday is published
2206          * in the default profile. We _could_ also look for a private profile that the
2207          * recipient can see, but somebody could get mad at us if they start getting
2208          * public birthday greetings when they haven't made this info public.
2209          *
2210          * Assuming we are able to publish this info, we are then going to convert
2211          * the start time from the owner's timezone to UTC.
2212          *
2213          * This will potentially solve the problem found with some social networks
2214          * where birthdays are converted to the viewer's timezone and salutations from
2215          * elsewhere in the world show up on the wrong day. We will convert it to the
2216          * viewer's timezone also, but first we are going to convert it from the birthday
2217          * person's timezone to GMT - so the viewer may find the birthday starting at
2218          * 6:00PM the day before, but that will correspond to midnight to the birthday person.
2219          *
2220          */
2221
2222
2223         $birthday = '';
2224
2225         if (! strlen($tz)) {
2226                 $tz = 'UTC';
2227         }
2228
2229         $p = q("SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1",
2230                         intval($uid)
2231         );
2232
2233         if (dbm::is_result($p)) {
2234                 $tmp_dob = substr($p[0]['dob'],5);
2235                 if (intval($tmp_dob)) {
2236                         $y = datetime_convert($tz,$tz,'now','Y');
2237                         $bd = $y . '-' . $tmp_dob . ' 00:00';
2238                         $t_dob = strtotime($bd);
2239                         $now = strtotime(datetime_convert($tz,$tz,'now'));
2240                         if ($t_dob < $now) {
2241                                 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
2242                         }
2243                         $birthday = datetime_convert($tz,'UTC',$bd,ATOM_TIME);
2244                 }
2245         }
2246
2247         return $birthday;
2248 }
2249
2250 /**
2251  * @brief Check if current user has admin role.
2252  *
2253  * @return bool true if user is an admin
2254  */
2255 function is_site_admin() {
2256         $a = get_app();
2257
2258         $adminlist = explode(",", str_replace(" ", "", $a->config['admin_email']));
2259
2260         //if (local_user() && x($a->user,'email') && x($a->config,'admin_email') && ($a->user['email'] === $a->config['admin_email']))
2261         if (local_user() && x($a->user,'email') && x($a->config,'admin_email') && in_array($a->user['email'], $adminlist))
2262                 return true;
2263         return false;
2264 }
2265
2266 /**
2267  * @brief Returns querystring as string from a mapped array.
2268  *
2269  * @param array $params mapped array with query parameters
2270  * @param string $name of parameter, default null
2271  *
2272  * @return string
2273  */
2274 function build_querystring($params, $name=null) {
2275         $ret = "";
2276         foreach ($params as $key=>$val) {
2277                 if (is_array($val)) {
2278                         if ($name==null) {
2279                                 $ret .= build_querystring($val, $key);
2280                         } else {
2281                                 $ret .= build_querystring($val, $name."[$key]");
2282                         }
2283                 } else {
2284                         $val = urlencode($val);
2285                         if ($name!=null) {
2286                                 $ret.=$name."[$key]"."=$val&";
2287                         } else {
2288                                 $ret.= "$key=$val&";
2289                         }
2290                 }
2291         }
2292         return $ret;
2293 }
2294
2295 function explode_querystring($query) {
2296         $arg_st = strpos($query, '?');
2297         if ($arg_st !== false) {
2298                 $base = substr($query, 0, $arg_st);
2299                 $arg_st += 1;
2300         } else {
2301                 $base = '';
2302                 $arg_st = 0;
2303         }
2304
2305         $args = explode('&', substr($query, $arg_st));
2306         foreach ($args as $k=>$arg) {
2307                 if ($arg === '') {
2308                         unset($args[$k]);
2309                 }
2310         }
2311         $args = array_values($args);
2312
2313         if (!$base) {
2314                 $base = $args[0];
2315                 unset($args[0]);
2316                 $args = array_values($args);
2317         }
2318
2319         return array(
2320                 'base' => $base,
2321                 'args' => $args,
2322         );
2323 }
2324
2325 /**
2326 * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
2327 *
2328 * Taken from http://webcheatsheet.com/php/get_current_page_url.php
2329 */
2330 function curPageURL() {
2331         $pageURL = 'http';
2332         if ($_SERVER["HTTPS"] == "on") {
2333                 $pageURL .= "s";
2334         }
2335         $pageURL .= "://";
2336         if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
2337                 $pageURL .= $_SERVER["SERVER_NAME"].":".$_SERVER["SERVER_PORT"].$_SERVER["REQUEST_URI"];
2338         } else {
2339                 $pageURL .= $_SERVER["SERVER_NAME"].$_SERVER["REQUEST_URI"];
2340         }
2341         return $pageURL;
2342 }
2343
2344 function random_digits($digits) {
2345         $rn = '';
2346         for ($i = 0; $i < $digits; $i++) {
2347                 $rn .= rand(0,9);
2348         }
2349         return $rn;
2350 }
2351
2352 function get_server() {
2353         $server = get_config("system", "directory");
2354
2355         if ($server == "") {
2356                 $server = "http://dir.friendi.ca";
2357         }
2358
2359         return($server);
2360 }
2361
2362 function get_cachefile($file, $writemode = true) {
2363         $cache = get_itemcachepath();
2364
2365         if ((! $cache) || (! is_dir($cache))) {
2366                 return("");
2367         }
2368
2369         $subfolder = $cache."/".substr($file, 0, 2);
2370
2371         $cachepath = $subfolder."/".$file;
2372
2373         if ($writemode) {
2374                 if (!is_dir($subfolder)) {
2375                         mkdir($subfolder);
2376                         chmod($subfolder, 0777);
2377                 }
2378         }
2379
2380         return($cachepath);
2381 }
2382
2383 function clear_cache($basepath = "", $path = "") {
2384         if ($path == "") {
2385                 $basepath = get_itemcachepath();
2386                 $path = $basepath;
2387         }
2388
2389         if (($path == "") OR (!is_dir($path))) {
2390                 return;
2391         }
2392
2393         if (substr(realpath($path), 0, strlen($basepath)) != $basepath) {
2394                 return;
2395         }
2396
2397         $cachetime = (int)get_config('system','itemcache_duration');
2398         if ($cachetime == 0) {
2399                 $cachetime = 86400;
2400         }
2401
2402         if (is_writable($path)){
2403                 if ($dh = opendir($path)) {
2404                         while (($file = readdir($dh)) !== false) {
2405                                 $fullpath = $path."/".$file;
2406                                 if ((filetype($fullpath) == "dir") and ($file != ".") and ($file != "..")) {
2407                                         clear_cache($basepath, $fullpath);
2408                                 }
2409                                 if ((filetype($fullpath) == "file") and (filectime($fullpath) < (time() - $cachetime))) {
2410                                         unlink($fullpath);
2411                                 }
2412                         }
2413                         closedir($dh);
2414                 }
2415         }
2416 }
2417
2418 function get_itemcachepath() {
2419         // Checking, if the cache is deactivated
2420         $cachetime = (int)get_config('system','itemcache_duration');
2421         if ($cachetime < 0) {
2422                 return "";
2423         }
2424
2425         $itemcache = get_config('system','itemcache');
2426         if (($itemcache != "") AND App::directory_usable($itemcache)) {
2427                 return $itemcache;
2428         }
2429
2430         $temppath = get_temppath();
2431
2432         if ($temppath != "") {
2433                 $itemcache = $temppath."/itemcache";
2434                 if (!file_exists($itemcache) && !is_dir($itemcache)) {
2435                         mkdir($itemcache);
2436                 }
2437
2438                 if (App::directory_usable($itemcache)) {
2439                         set_config("system", "itemcache", $itemcache);
2440                         return $itemcache;
2441                 }
2442         }
2443         return "";
2444 }
2445
2446 /**
2447  * @brief Returns the path where spool files are stored
2448  *
2449  * @return string Spool path
2450  */
2451 function get_spoolpath() {
2452         $spoolpath = get_config('system','spoolpath');
2453         if (($spoolpath != "") AND App::directory_usable($spoolpath)) {
2454                 // We have a spool path and it is usable
2455                 return $spoolpath;
2456         }
2457
2458         // We don't have a working preconfigured spool path, so we take the temp path.
2459         $temppath = get_temppath();
2460
2461         if ($temppath != "") {
2462                 // To avoid any interferences with other systems we create our own directory
2463                 $spoolpath = $temppath."/spool";
2464                 if (!is_dir($spoolpath)) {
2465                         mkdir($spoolpath);
2466                 }
2467
2468                 if (App::directory_usable($spoolpath)) {
2469                         // The new path is usable, we are happy
2470                         set_config("system", "spoolpath", $spoolpath);
2471                         return $spoolpath;
2472                 } else {
2473                         // We can't create a subdirectory, strange.
2474                         // But the directory seems to work, so we use it but don't store it.
2475                         return $temppath;
2476                 }
2477         }
2478
2479         // Reaching this point means that the operating system is configured badly.
2480         return "";
2481 }
2482
2483 function get_temppath() {
2484         $a = get_app();
2485
2486         $temppath = get_config("system", "temppath");
2487
2488         if (($temppath != "") AND App::directory_usable($temppath)) {
2489                 // We have a temp path and it is usable
2490                 return $temppath;
2491         }
2492
2493         // We don't have a working preconfigured temp path, so we take the system path.
2494         $temppath = sys_get_temp_dir();
2495
2496         // Check if it is usable
2497         if (($temppath != "") AND App::directory_usable($temppath)) {
2498                 // To avoid any interferences with other systems we create our own directory
2499                 $new_temppath .= "/".$a->get_hostname();
2500                 if (!is_dir($new_temppath))
2501                         mkdir($new_temppath);
2502
2503                 if (App::directory_usable($new_temppath)) {
2504                         // The new path is usable, we are happy
2505                         set_config("system", "temppath", $new_temppath);
2506                         return $new_temppath;
2507                 } else {
2508                         // We can't create a subdirectory, strange.
2509                         // But the directory seems to work, so we use it but don't store it.
2510                         return $temppath;
2511                 }
2512         }
2513
2514         // Reaching this point means that the operating system is configured badly.
2515         return '';
2516 }
2517
2518 /// @deprecated
2519 function set_template_engine(App $a, $engine = 'internal') {
2520 /// @note This function is no longer necessary, but keep it as a wrapper to the class method
2521 /// to avoid breaking themes again unnecessarily
2522
2523         $a->set_template_engine($engine);
2524 }
2525
2526 if (!function_exists('exif_imagetype')) {
2527         function exif_imagetype($file) {
2528                 $size = getimagesize($file);
2529                 return($size[2]);
2530         }
2531 }
2532
2533 function validate_include(&$file) {
2534         $orig_file = $file;
2535
2536         $file = realpath($file);
2537
2538         if (strpos($file, getcwd()) !== 0) {
2539                 return false;
2540         }
2541
2542         $file = str_replace(getcwd()."/", "", $file, $count);
2543         if ($count != 1) {
2544                 return false;
2545         }
2546
2547         if ($orig_file !== $file) {
2548                 return false;
2549         }
2550
2551         $valid = false;
2552         if (strpos($file, "include/") === 0) {
2553                 $valid = true;
2554         }
2555
2556         if (strpos($file, "addon/") === 0) {
2557                 $valid = true;
2558         }
2559
2560         // Simply return flag
2561         return ($valid);
2562 }
2563
2564 function current_load() {
2565         if (!function_exists('sys_getloadavg')) {
2566                 return false;
2567         }
2568
2569         $load_arr = sys_getloadavg();
2570
2571         if (!is_array($load_arr)) {
2572                 return false;
2573         }
2574
2575         return max($load_arr[0], $load_arr[1]);
2576 }
2577
2578 /**
2579  * @brief get c-style args
2580  *
2581  * @return int
2582  */
2583 function argc() {
2584         return get_app()->argc;
2585 }
2586
2587 /**
2588  * @brief Returns the value of a argv key
2589  *
2590  * @param int $x argv key
2591  * @return string Value of the argv key
2592  */
2593 function argv($x) {
2594         if (array_key_exists($x,get_app()->argv)) {
2595                 return get_app()->argv[$x];
2596         }
2597
2598         return '';
2599 }
2600
2601 /**
2602  * @brief Get the data which is needed for infinite scroll
2603  *
2604  * For invinite scroll we need the page number of the actual page
2605  * and the the URI where the content of the next page comes from.
2606  * This data is needed for the js part in main.js.
2607  * Note: infinite scroll does only work for the network page (module)
2608  *
2609  * @param string $module The name of the module (e.g. "network")
2610  * @return array Of infinite scroll data
2611  *      'pageno' => $pageno The number of the actual page
2612  *      'reload_uri' => $reload_uri The URI of the content we have to load
2613  */
2614 function infinite_scroll_data($module) {
2615
2616         if (get_pconfig(local_user(),'system','infinite_scroll')
2617                 AND ($module == "network") AND ($_GET["mode"] != "minimal")) {
2618
2619                 // get the page number
2620                 if (is_string($_GET["page"]))
2621                         $pageno = $_GET["page"];
2622                 else
2623                         $pageno = 1;
2624
2625                 $reload_uri = "";
2626
2627                 // try to get the uri from which we load the content
2628                 foreach ($_GET AS $param => $value)
2629                         if (($param != "page") AND ($param != "q"))
2630                                 $reload_uri .= "&".$param."=".urlencode($value);
2631
2632                 if (($a->page_offset != "") AND !strstr($reload_uri, "&offset="))
2633                         $reload_uri .= "&offset=".urlencode($a->page_offset);
2634
2635                 $arr = array("pageno" => $pageno, "reload_uri" => $reload_uri);
2636
2637                 return $arr;
2638         }
2639 }