boot.php

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