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