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