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