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