boot.php

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