boot.php

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