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',      1209      );
  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_richtext_editor = true;
 534         public  $theme_events_in_profile = true;
 535
 536         /**
 537          * @brief An array for all theme-controllable parameters
 538          *
 539          * Mostly unimplemented yet. Only options 'template_engine' and
 540          * beyond are used.
 541          */
 542         public  $theme = array(
 543                 'sourcename' => '',
 544                 'videowidth' => 425,
 545                 'videoheight' => 350,
 546                 'force_max_items' => 0,
 547                 'thread_allow' => true,
 548                 'stylesheet' => '',
 549                 'template_engine' => 'smarty3',
 550         );
 551
 552         /**
 553          * @brief An array of registered template engines ('name'=>'class name')
 554          */
 555         public $template_engines = array();
 556         /**
 557          * @brief An array of instanced template engines ('name'=>'instance')
 558          */
 559         public $template_engine_instance = array();
 560
 561         public $process_id;
 562
 563         private $ldelim = array(
 564                 'internal' => '',
 565                 'smarty3' => '{{'
 566         );
 567         private $rdelim = array(
 568                 'internal' => '',
 569                 'smarty3' => '}}'
 570         );
 571
 572         private $scheme;
 573         private $hostname;
 574         private $baseurl;
 575         private $db;
 576
 577         private $curl_code;
 578         private $curl_content_type;
 579         private $curl_headers;
 580
 581         private $cached_profile_image;
 582         private $cached_profile_picdate;
 583
 584         private static $a;
 585
 586         /**
 587          * @brief App constructor.
 588          */
 589         function __construct() {
 590
 591                 global $default_timezone;
 592
 593                 $hostname = "";
 594
 595                 if (file_exists(".htpreconfig.php"))
 596                         @include(".htpreconfig.php");
 597
 598                 $this->timezone = ((x($default_timezone)) ? $default_timezone : 'UTC');
 599
 600                 date_default_timezone_set($this->timezone);
 601
 602                 $this->performance["start"] = microtime(true);
 603                 $this->performance["database"] = 0;
 604                 $this->performance["database_write"] = 0;
 605                 $this->performance["network"] = 0;
 606                 $this->performance["file"] = 0;
 607                 $this->performance["rendering"] = 0;
 608                 $this->performance["parser"] = 0;
 609                 $this->performance["marktime"] = 0;
 610                 $this->performance["markstart"] = microtime(true);
 611
 612                 $this->callstack["database"] = array();
 613                 $this->callstack["database_write"] = array();
 614                 $this->callstack["network"] = array();
 615                 $this->callstack["file"] = array();
 616                 $this->callstack["rendering"] = array();
 617                 $this->callstack["parser"] = array();
 618
 619                 $this->config = array();
 620                 $this->page = array();
 621                 $this->pager= array();
 622
 623                 $this->query_string = '';
 624
 625                 $this->process_id = uniqid("log", true);
 626
 627                 startup();
 628
 629                 set_include_path(
 630                                 'include' . PATH_SEPARATOR
 631                                 . 'library' . PATH_SEPARATOR
 632                                 . 'library/phpsec' . PATH_SEPARATOR
 633                                 . 'library/langdet' . PATH_SEPARATOR
 634                                 . '.' );
 635
 636
 637                 $this->scheme = 'http';
 638                 if((x($_SERVER,'HTTPS') && $_SERVER['HTTPS']) ||
 639                    (x($_SERVER['HTTP_FORWARDED']) && preg_match("/proto=https/", $_SERVER['HTTP_FORWARDED'])) ||
 640                    (x($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https') ||
 641                    (x($_SERVER['HTTP_X_FORWARDED_SSL']) && $_SERVER['HTTP_X_FORWARDED_SSL'] == 'on') ||
 642                    (x($_SERVER['FRONT_END_HTTPS']) && $_SERVER['FRONT_END_HTTPS'] == 'on') ||
 643                    (x($_SERVER,'SERVER_PORT') && (intval($_SERVER['SERVER_PORT']) == 443)) // XXX: reasonable assumption, but isn't this hardcoding too much?
 644                    ) {
 645                         $this->scheme = 'https';
 646                    }
 647
 648                 if(x($_SERVER,'SERVER_NAME')) {
 649                         $this->hostname = $_SERVER['SERVER_NAME'];
 650
 651                         if(x($_SERVER,'SERVER_PORT') && $_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443)
 652                                 $this->hostname .= ':' . $_SERVER['SERVER_PORT'];
 653                         /*
 654                          * Figure out if we are running at the top of a domain
 655                          * or in a sub-directory and adjust accordingly
 656                          */
 657
 658                         $path = trim(dirname($_SERVER['SCRIPT_NAME']),'/\\');
 659                         if(isset($path) && strlen($path) && ($path != $this->path))
 660                                 $this->path = $path;
 661                 }
 662
 663                 if ($hostname != "")
 664                         $this->hostname = $hostname;
 665
 666                 if (is_array($_SERVER["argv"]) && $_SERVER["argc"]>1 && substr(end($_SERVER["argv"]), 0, 4)=="http" ) {
 667                         $this->set_baseurl(array_pop($_SERVER["argv"]) );
 668                         $_SERVER["argc"] --;
 669                 }
 670
 671                 #set_include_path("include/$this->hostname" . PATH_SEPARATOR . get_include_path());
 672
 673                 if((x($_SERVER,'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'],0,9) === "pagename=") {
 674                         $this->query_string = substr($_SERVER['QUERY_STRING'],9);
 675                         // removing trailing / - maybe a nginx problem
 676                         if (substr($this->query_string, 0, 1) == "/")
 677                                 $this->query_string = substr($this->query_string, 1);
 678                 } elseif((x($_SERVER,'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'],0,2) === "q=") {
 679                         $this->query_string = substr($_SERVER['QUERY_STRING'],2);
 680                         // removing trailing / - maybe a nginx problem
 681                         if (substr($this->query_string, 0, 1) == "/")
 682                                 $this->query_string = substr($this->query_string, 1);
 683                 }
 684
 685                 if (x($_GET,'pagename'))
 686                         $this->cmd = trim($_GET['pagename'],'/\\');
 687                 elseif (x($_GET,'q'))
 688                         $this->cmd = trim($_GET['q'],'/\\');
 689
 690
 691                 // fix query_string
 692                 $this->query_string = str_replace($this->cmd."&",$this->cmd."?", $this->query_string);
 693
 694
 695                 // unix style "homedir"
 696
 697                 if(substr($this->cmd,0,1) === '~')
 698                         $this->cmd = 'profile/' . substr($this->cmd,1);
 699
 700                 // Diaspora style profile url
 701
 702                 if(substr($this->cmd,0,2) === 'u/')
 703                         $this->cmd = 'profile/' . substr($this->cmd,2);
 704
 705
 706                 /*
 707                  *
 708                  * Break the URL path into C style argc/argv style arguments for our
 709                  * modules. Given "http://example.com/module/arg1/arg2", $this->argc
 710                  * will be 3 (integer) and $this->argv will contain:
 711                  *   [0] => 'module'
 712                  *   [1] => 'arg1'
 713                  *   [2] => 'arg2'
 714                  *
 715                  *
 716                  * There will always be one argument. If provided a naked domain
 717                  * URL, $this->argv[0] is set to "home".
 718                  *
 719                  */
 720
 721                 $this->argv = explode('/',$this->cmd);
 722                 $this->argc = count($this->argv);
 723                 if((array_key_exists('0',$this->argv)) && strlen($this->argv[0])) {
 724                         $this->module = str_replace(".", "_", $this->argv[0]);
 725                         $this->module = str_replace("-", "_", $this->module);
 726                 }
 727                 else {
 728                         $this->argc = 1;
 729                         $this->argv = array('home');
 730                         $this->module = 'home';
 731                 }
 732
 733                 /*
 734                  * See if there is any page number information, and initialise
 735                  * pagination
 736                  */
 737
 738                 $this->pager['page'] = ((x($_GET,'page') && intval($_GET['page']) > 0) ? intval($_GET['page']) : 1);
 739                 $this->pager['itemspage'] = 50;
 740                 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
 741                 if($this->pager['start'] < 0)
 742                         $this->pager['start'] = 0;
 743                 $this->pager['total'] = 0;
 744
 745                 /*
 746                  * Detect mobile devices
 747                  */
 748
 749                 $mobile_detect = new Mobile_Detect();
 750                 $this->is_mobile = $mobile_detect->isMobile();
 751                 $this->is_tablet = $mobile_detect->isTablet();
 752
 753                 // Friendica-Client
 754                 $this->is_friendica_app = ($_SERVER['HTTP_USER_AGENT'] == "Apache-HttpClient/UNAVAILABLE (java 1.4)");
 755
 756                 /*
 757                  * register template engines
 758                  */
 759                 $dc = get_declared_classes();
 760                 foreach ($dc as $k) {
 761                         if (in_array("ITemplateEngine", class_implements($k))){
 762                                 $this->register_template_engine($k);
 763                         }
 764                 }
 765
 766                 self::$a = $this;
 767
 768         }
 769
 770         public static function get_basepath() {
 771
 772                 $basepath = get_config("system", "basepath");
 773
 774                 if ($basepath == "")
 775                         $basepath = dirname(__FILE__);
 776
 777                 if ($basepath == "")
 778                         $basepath = $_SERVER["DOCUMENT_ROOT"];
 779
 780                 if ($basepath == "")
 781                         $basepath = $_SERVER["PWD"];
 782
 783                 return($basepath);
 784         }
 785
 786         function get_scheme() {
 787                 return($this->scheme);
 788         }
 789
 790         /**
 791          * @brief Retrieves the Friendica instance base URL
 792          *
 793          * This function assembles the base URL from multiple parts:
 794          * - Protocol is determined either by the request or a combination of
 795          * system.ssl_policy and the $ssl parameter.
 796          * - Host name is determined either by system.hostname or inferred from request
 797          * - Path is inferred from SCRIPT_NAME
 798          *
 799          * Caches the result (depending on $ssl value) for performance.
 800          *
 801          * Note: $ssl parameter value doesn't directly correlate with the resulting protocol
 802          *
 803          * @param bool $ssl Whether to append http or https under SSL_POLICY_SELFSIGN
 804          * @return string Friendica server base URL
 805          */
 806         function get_baseurl($ssl = false) {
 807
 808                 // Is the function called statically?
 809                 if (!is_object($this)) {
 810                         return self::$a->get_baseurl($ssl);
 811                 }
 812
 813                 // Arbitrary values, the resulting url protocol can be different
 814                 $cache_index = $ssl ? 'https' : 'http';
 815
 816                 // Cached value found, nothing to process
 817                 if (isset($this->baseurl[$cache_index])) {
 818                         return $this->baseurl[$cache_index];
 819                 }
 820
 821                 $scheme = $this->scheme;
 822
 823                 if ((x($this->config, 'system')) && (x($this->config['system'], 'ssl_policy'))) {
 824                         if (intval($this->config['system']['ssl_policy']) === SSL_POLICY_FULL) {
 825                                 $scheme = 'https';
 826                         }
 827
 828                         //      Basically, we have $ssl = true on any links which can only be seen by a logged in user
 829                         //      (and also the login link). Anything seen by an outsider will have it turned off.
 830
 831                         if ($this->config['system']['ssl_policy'] == SSL_POLICY_SELFSIGN) {
 832                                 if ($ssl) {
 833                                         $scheme = 'https';
 834                                 } else {
 835                                         $scheme = 'http';
 836                                 }
 837                         }
 838                 }
 839
 840                 if (get_config('config', 'hostname') != '') {
 841                         $this->hostname = get_config('config', 'hostname');
 842                 }
 843
 844                 $this->baseurl[$cache_index] = $scheme . "://" . $this->hostname . ((isset($this->path) && strlen($this->path)) ? '/' . $this->path : '' );
 845
 846                 return $this->baseurl[$cache_index];
 847         }
 848
 849         /**
 850          * @brief Initializes the baseurl components
 851          *
 852          * Clears the baseurl cache to prevent inconstistencies
 853          *
 854          * @param string $url
 855          */
 856         function set_baseurl($url) {
 857                 $parsed = @parse_url($url);
 858
 859                 $this->baseurl = [];
 860
 861                 if($parsed) {
 862                         $this->scheme = $parsed['scheme'];
 863
 864                         $hostname = $parsed['host'];
 865                         if (x($parsed, 'port')) {
 866                                 $hostname .= ':' . $parsed['port'];
 867                         }
 868                         if (x($parsed, 'path')) {
 869                                 $this->path = trim($parsed['path'], '\\/');
 870                         }
 871
 872                         if (file_exists(".htpreconfig.php")) {
 873                                 @include(".htpreconfig.php");
 874                         }
 875
 876                         if (get_config('config', 'hostname') != '') {
 877                                 $this->hostname = get_config('config', 'hostname');
 878                         }
 879
 880                         if (!isset($this->hostname) OR ($this->hostname == '')) {
 881                                 $this->hostname = $hostname;
 882                         }
 883                 }
 884         }
 885
 886         function get_hostname() {
 887                 if (get_config('config','hostname') != "")
 888                         $this->hostname = get_config('config','hostname');
 889
 890                 return $this->hostname;
 891         }
 892
 893         function set_hostname($h) {
 894                 $this->hostname = $h;
 895         }
 896
 897         function set_path($p) {
 898                 $this->path = trim(trim($p),'/');
 899         }
 900
 901         function get_path() {
 902                 return $this->path;
 903         }
 904
 905         function set_pager_total($n) {
 906                 $this->pager['total'] = intval($n);
 907         }
 908
 909         function set_pager_itemspage($n) {
 910                 $this->pager['itemspage'] = ((intval($n) > 0) ? intval($n) : 0);
 911                 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
 912         }
 913
 914         function set_pager_page($n) {
 915                 $this->pager['page'] = $n;
 916                 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
 917         }
 918
 919         function init_pagehead() {
 920                 $interval = ((local_user()) ? get_pconfig(local_user(),'system','update_interval') : 40000);
 921
 922                 // If the update is "deactivated" set it to the highest integer number (~24 days)
 923                 if ($interval < 0)
 924                         $interval = 2147483647;
 925
 926                 if($interval < 10000)
 927                         $interval = 40000;
 928
 929                 // compose the page title from the sitename and the
 930                 // current module called
 931                 if (!$this->module=='')
 932                 {
 933                     $this->page['title'] = $this->config['sitename'].' ('.$this->module.')';
 934                 } else {
 935                     $this->page['title'] = $this->config['sitename'];
 936                 }
 937
 938                 /* put the head template at the beginning of page['htmlhead']
 939                  * since the code added by the modules frequently depends on it
 940                  * being first
 941                  */
 942                 if(!isset($this->page['htmlhead']))
 943                         $this->page['htmlhead'] = '';
 944
 945                 // If we're using Smarty, then doing replace_macros() will replace
 946                 // any unrecognized variables with a blank string. Since we delay
 947                 // replacing $stylesheet until later, we need to replace it now
 948                 // with another variable name
 949                 if($this->theme['template_engine'] === 'smarty3')
 950                         $stylesheet = $this->get_template_ldelim('smarty3') . '$stylesheet' . $this->get_template_rdelim('smarty3');
 951                 else
 952                         $stylesheet = '$stylesheet';
 953
 954                 $shortcut_icon = get_config("system", "shortcut_icon");
 955                 if ($shortcut_icon == "")
 956                         $shortcut_icon = "images/friendica-32.png";
 957
 958                 $touch_icon = get_config("system", "touch_icon");
 959                 if ($touch_icon == "")
 960                         $touch_icon = "images/friendica-128.png";
 961
 962                 // get data wich is needed for infinite scroll on the network page
 963                 $invinite_scroll = infinite_scroll_data($this->module);
 964
 965                 $tpl = get_markup_template('head.tpl');
 966                 $this->page['htmlhead'] = replace_macros($tpl,array(
 967                         '$baseurl' => $this->get_baseurl(), // FIXME for z_path!!!!
 968                         '$local_user' => local_user(),
 969                         '$generator' => 'Friendica' . ' ' . FRIENDICA_VERSION,
 970                         '$delitem' => t('Delete this item?'),
 971                         '$comment' => t('Comment'),
 972                         '$showmore' => t('show more'),
 973                         '$showfewer' => t('show fewer'),
 974                         '$update_interval' => $interval,
 975                         '$shortcut_icon' => $shortcut_icon,
 976                         '$touch_icon' => $touch_icon,
 977                         '$stylesheet' => $stylesheet,
 978                         '$infinite_scroll' => $invinite_scroll,
 979                 )) . $this->page['htmlhead'];
 980         }
 981
 982         function init_page_end() {
 983                 if(!isset($this->page['end']))
 984                         $this->page['end'] = '';
 985                 $tpl = get_markup_template('end.tpl');
 986                 $this->page['end'] = replace_macros($tpl,array(
 987                         '$baseurl' => $this->get_baseurl() // FIXME for z_path!!!!
 988                 )) . $this->page['end'];
 989         }
 990
 991         function set_curl_code($code) {
 992                 $this->curl_code = $code;
 993         }
 994
 995         function get_curl_code() {
 996                 return $this->curl_code;
 997         }
 998
 999         function set_curl_content_type($content_type) {
1000                 $this->curl_content_type = $content_type;
1001         }
1002
1003         function get_curl_content_type() {
1004                 return $this->curl_content_type;
1005         }
1006
1007         function set_curl_headers($headers) {
1008                 $this->curl_headers = $headers;
1009         }
1010
1011         function get_curl_headers() {
1012                 return $this->curl_headers;
1013         }
1014
1015         function get_cached_avatar_image($avatar_image){
1016                 return $avatar_image;
1017
1018                 // The following code is deactivated. It doesn't seem to make any sense and it slows down the system.
1019                 /*
1020                 if($this->cached_profile_image[$avatar_image])
1021                         return $this->cached_profile_image[$avatar_image];
1022
1023                 $path_parts = explode("/",$avatar_image);
1024                 $common_filename = $path_parts[count($path_parts)-1];
1025
1026                 if($this->cached_profile_picdate[$common_filename]){
1027                         $this->cached_profile_image[$avatar_image] = $avatar_image . $this->cached_profile_picdate[$common_filename];
1028                 } else {
1029                         $r = q("SELECT `contact`.`avatar-date` AS picdate FROM `contact` WHERE `contact`.`thumb` like '%%/%s'",
1030                                 $common_filename);
1031                         if (! dbm::is_result($r)) {
1032                                 $this->cached_profile_image[$avatar_image] = $avatar_image;
1033                         } else {
1034                                 $this->cached_profile_picdate[$common_filename] = "?rev=".urlencode($r[0]['picdate']);
1035                                 $this->cached_profile_image[$avatar_image] = $avatar_image.$this->cached_profile_picdate[$common_filename];
1036                         }
1037                 }
1038                 return $this->cached_profile_image[$avatar_image];
1039                 */
1040         }
1041
1042
1043         /**
1044          * @brief Removes the baseurl from an url. This avoids some mixed content problems.
1045          *
1046          * @param string $orig_url
1047          *
1048          * @return string The cleaned url
1049          */
1050         function remove_baseurl($orig_url){
1051
1052                 // Is the function called statically?
1053                 if (!is_object($this)) {
1054                         return(self::$a->remove_baseurl($orig_url));
1055                 }
1056
1057                 // Remove the hostname from the url if it is an internal link
1058                 $nurl = normalise_link($orig_url);
1059                 $base = normalise_link($this->get_baseurl());
1060                 $url = str_replace($base."/", "", $nurl);
1061
1062                 // if it is an external link return the orignal value
1063                 if ($url == normalise_link($orig_url)) {
1064                         return $orig_url;
1065                 } else {
1066                         return $url;
1067                 }
1068         }
1069
1070         /**
1071          * @brief Register template engine class
1072          *
1073          * If $name is "", is used class static property $class::$name
1074          *
1075          * @param string $class
1076          * @param string $name
1077          */
1078         function register_template_engine($class, $name = '') {
1079                 if ($name===""){
1080                         $v = get_class_vars( $class );
1081                         if(x($v,"name")) $name = $v['name'];
1082                 }
1083                 if ($name===""){
1084                         echo "template engine <tt>$class</tt> cannot be registered without a name.\n";
1085                         killme();
1086                 }
1087                 $this->template_engines[$name] = $class;
1088         }
1089
1090         /**
1091          * @brief Return template engine instance.
1092          *
1093          * If $name is not defined, return engine defined by theme,
1094          * or default
1095          *
1096          * @param strin $name Template engine name
1097          * @return object Template Engine instance
1098          */
1099         function template_engine($name = ''){
1100                 if ($name!=="") {
1101                         $template_engine = $name;
1102                 } else {
1103                         $template_engine = 'smarty3';
1104                         if (x($this->theme, 'template_engine')) {
1105                                 $template_engine = $this->theme['template_engine'];
1106                         }
1107                 }
1108
1109                 if (isset($this->template_engines[$template_engine])){
1110                         if(isset($this->template_engine_instance[$template_engine])){
1111                                 return $this->template_engine_instance[$template_engine];
1112                         } else {
1113                                 $class = $this->template_engines[$template_engine];
1114                                 $obj = new $class;
1115                                 $this->template_engine_instance[$template_engine] = $obj;
1116                                 return $obj;
1117                         }
1118                 }
1119
1120                 echo "template engine <tt>$template_engine</tt> is not registered!\n"; killme();
1121         }
1122
1123         /**
1124          * @brief Returns the active template engine.
1125          *
1126          * @return string
1127          */
1128         function get_template_engine() {
1129                 return $this->theme['template_engine'];
1130         }
1131
1132         function set_template_engine($engine = 'smarty3') {
1133                 $this->theme['template_engine'] = $engine;
1134                 /*
1135                 $this->theme['template_engine'] = 'smarty3';
1136
1137                 switch($engine) {
1138                         case 'smarty3':
1139                                 if(is_writable('view/smarty3/'))
1140                                         $this->theme['template_engine'] = 'smarty3';
1141                                 break;
1142                         default:
1143                                 break;
1144                 }
1145                 */
1146         }
1147
1148         function get_template_ldelim($engine = 'smarty3') {
1149                 return $this->ldelim[$engine];
1150         }
1151
1152         function get_template_rdelim($engine = 'smarty3') {
1153                 return $this->rdelim[$engine];
1154         }
1155
1156         function save_timestamp($stamp, $value) {
1157                 if (!isset($this->config['system']['profiler']) || !$this->config['system']['profiler'])
1158                         return;
1159
1160                 $duration = (float)(microtime(true)-$stamp);
1161
1162                 if (!isset($this->performance[$value])) {
1163                         // Prevent ugly E_NOTICE
1164                         $this->performance[$value] = 0;
1165                 }
1166
1167                 $this->performance[$value] += (float)$duration;
1168                 $this->performance["marktime"] += (float)$duration;
1169
1170                 $callstack = $this->callstack();
1171
1172                 if (!isset($this->callstack[$value][$callstack])) {
1173                         // Prevent ugly E_NOTICE
1174                         $this->callstack[$value][$callstack] = 0;
1175                 }
1176
1177                 $this->callstack[$value][$callstack] += (float)$duration;
1178
1179         }
1180
1181         /**
1182          * @brief Log active processes into the "process" table
1183          */
1184         function start_process() {
1185                 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1);
1186
1187                 $command = basename($trace[0]["file"]);
1188
1189                 $this->remove_inactive_processes();
1190
1191                 q("START TRANSACTION");
1192
1193                 $r = q("SELECT `pid` FROM `process` WHERE `pid` = %d", intval(getmypid()));
1194                 if (!dbm::is_result($r)) {
1195                         q("INSERT INTO `process` (`pid`,`command`,`created`) VALUES (%d, '%s', '%s')",
1196                                 intval(getmypid()),
1197                                 dbesc($command),
1198                                 dbesc(datetime_convert()));
1199                 }
1200                 q("COMMIT");
1201         }
1202
1203         /**
1204          * @brief Remove inactive processes
1205          */
1206         function remove_inactive_processes() {
1207                 q("START TRANSACTION");
1208
1209                 $r = q("SELECT `pid` FROM `process`");
1210                 if (dbm::is_result($r)) {
1211                         foreach ($r AS $process) {
1212                                 if (!posix_kill($process["pid"], 0)) {
1213                                         q("DELETE FROM `process` WHERE `pid` = %d", intval($process["pid"]));
1214                                 }
1215                         }
1216                 }
1217                 q("COMMIT");
1218         }
1219
1220         /**
1221          * @brief Remove the active process from the "process" table
1222          */
1223         function end_process() {
1224                 q("DELETE FROM `process` WHERE `pid` = %d", intval(getmypid()));
1225         }
1226
1227         /**
1228          * @brief Returns a string with a callstack. Can be used for logging.
1229          *
1230          * @return string
1231          */
1232         function callstack() {
1233                 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 6);
1234
1235                 // We remove the first two items from the list since they contain data that we don't need.
1236                 array_shift($trace);
1237                 array_shift($trace);
1238
1239                 $callstack = array();
1240                 foreach ($trace AS $func)
1241                         $callstack[] = $func["function"];
1242
1243                 return implode(", ", $callstack);
1244         }
1245
1246         function get_useragent() {
1247                 return(FRIENDICA_PLATFORM." '".FRIENDICA_CODENAME."' ".FRIENDICA_VERSION."-".DB_UPDATE_VERSION."; ".$this->get_baseurl());
1248         }
1249
1250         function is_friendica_app() {
1251                 return($this->is_friendica_app);
1252         }
1253
1254         /**
1255          * @brief Checks if the site is called via a backend process
1256          *
1257          * This isn't a perfect solution. But we need this check very early.
1258          * So we cannot wait until the modules are loaded.
1259          *
1260          * @return bool Is it a known backend?
1261          */
1262         function is_backend() {
1263                 $backend = array();
1264                 $backend[] = "_well_known";
1265                 $backend[] = "api";
1266                 $backend[] = "dfrn_notify";
1267                 $backend[] = "fetch";
1268                 $backend[] = "hcard";
1269                 $backend[] = "hostxrd";
1270                 $backend[] = "nodeinfo";
1271                 $backend[] = "noscrape";
1272                 $backend[] = "p";
1273                 $backend[] = "poco";
1274                 $backend[] = "post";
1275                 $backend[] = "proxy";
1276                 $backend[] = "pubsub";
1277                 $backend[] = "pubsubhubbub";
1278                 $backend[] = "receive";
1279                 $backend[] = "rsd_xml";
1280                 $backend[] = "salmon";
1281                 $backend[] = "statistics_json";
1282                 $backend[] = "xrd";
1283
1284                 if (in_array($this->module, $backend))
1285                         return(true);
1286                 else
1287                         return($this->backend);
1288         }
1289
1290         /**
1291          * @brief Checks if the maximum number of database processes is reached
1292          *
1293          * @return bool Is the limit reached?
1294          */
1295         function max_processes_reached() {
1296
1297                 if ($this->is_backend()) {
1298                         $process = "backend";
1299                         $max_processes = get_config('system', 'max_processes_backend');
1300                         if (intval($max_processes) == 0)
1301                                 $max_processes = 5;
1302                 } else {
1303                         $process = "frontend";
1304                         $max_processes = get_config('system', 'max_processes_frontend');
1305                         if (intval($max_processes) == 0)
1306                                 $max_processes = 20;
1307                 }
1308
1309                 $processlist = dbm::processlist();
1310                 if ($processlist["list"] != "") {
1311                         logger("Processcheck: Processes: ".$processlist["amount"]." - Processlist: ".$processlist["list"], LOGGER_DEBUG);
1312
1313                         if ($processlist["amount"] > $max_processes) {
1314                                 logger("Processcheck: Maximum number of processes for ".$process." tasks (".$max_processes.") reached.", LOGGER_DEBUG);
1315                                 return true;
1316                         }
1317                 }
1318                 return false;
1319         }
1320
1321         /**
1322          * @brief Checks if the maximum load is reached
1323          *
1324          * @return bool Is the load reached?
1325          */
1326         function maxload_reached() {
1327
1328                 if ($this->is_backend()) {
1329                         $process = "backend";
1330                         $maxsysload = intval(get_config('system', 'maxloadavg'));
1331                         if ($maxsysload < 1)
1332                                 $maxsysload = 50;
1333                 } else {
1334                         $process = "frontend";
1335                         $maxsysload = intval(get_config('system','maxloadavg_frontend'));
1336                         if ($maxsysload < 1)
1337                                 $maxsysload = 50;
1338                 }
1339
1340                 $load = current_load();
1341                 if ($load) {
1342                         if (intval($load) > $maxsysload) {
1343                                 logger('system: load '.$load.' for '.$process.' tasks ('.$maxsysload.') too high.');
1344                                 return true;
1345                         }
1346                 }
1347                 return false;
1348         }
1349
1350         /**
1351          * @brief Checks if the process is already running
1352          *
1353          * @param string $taskname The name of the task that will be used for the name of the lockfile
1354          * @param string $task The path and name of the php script
1355          * @param int $timeout The timeout after which a task should be killed
1356          *
1357          * @return bool Is the process running?
1358          */
1359         function is_already_running($taskname, $task = "", $timeout = 540) {
1360
1361                 $lockpath = get_lockpath();
1362                 if ($lockpath != '') {
1363                         $pidfile = new pidfile($lockpath, $taskname);
1364                         if ($pidfile->is_already_running()) {
1365                                 logger("Already running");
1366                                 if ($pidfile->running_time() > $timeout) {
1367                                         $pidfile->kill();
1368                                         logger("killed stale process");
1369                                         // Calling a new instance
1370                                         if ($task != "")
1371                                                 proc_run(PRIORITY_MEDIUM, $task);
1372                                 }
1373                                 return true;
1374                         }
1375                 }
1376                 return false;
1377         }
1378
1379         function proc_run($args) {
1380
1381                 if (!function_exists("proc_open")) {
1382                         return;
1383                 }
1384
1385                 // Add the php path if it is a php call
1386                 if (count($args) && ($args[0] === 'php' OR !is_string($args[0]))) {
1387
1388                         // If the last worker fork was less than 10 seconds before then don't fork another one.
1389                         // This should prevent the forking of masses of workers.
1390                         if (get_config("system", "worker")) {
1391                                 if ((time() - get_config("system", "proc_run_started")) < 10)
1392                                         return;
1393
1394                                 // Set the timestamp of the last proc_run
1395                                 set_config("system", "proc_run_started", time());
1396                         }
1397
1398                         $args[0] = ((x($this->config,'php_path')) && (strlen($this->config['php_path'])) ? $this->config['php_path'] : 'php');
1399                 }
1400
1401                 // add baseurl to args. cli scripts can't construct it
1402                 $args[] = $this->get_baseurl();
1403
1404                 for($x = 0; $x < count($args); $x ++)
1405                         $args[$x] = escapeshellarg($args[$x]);
1406
1407                 $cmdline = implode($args," ");
1408
1409                 if(get_config('system','proc_windows'))
1410                         proc_close(proc_open('cmd /c start /b ' . $cmdline,array(),$foo,dirname(__FILE__)));
1411                 else
1412                         proc_close(proc_open($cmdline." &",array(),$foo,dirname(__FILE__)));
1413
1414         }
1415 }
1416
1417 /**
1418  * @brief Retrieve the App structure
1419  *
1420  * Useful in functions which require it but don't get it passed to them
1421  */
1422 function get_app() {
1423         global $a;
1424         return $a;
1425 }
1426
1427
1428 /**
1429  * @brief Multi-purpose function to check variable state.
1430  *
1431  * Usage: x($var) or $x($array, 'key')
1432  *
1433  * returns false if variable/key is not set
1434  * if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0.
1435  * e.g. x('') or x(0) returns 0;
1436  *
1437  * @param string|array $s variable to check
1438  * @param string $k key inside the array to check
1439  *
1440  * @return bool|int
1441  */
1442 function x($s,$k = NULL) {
1443         if($k != NULL) {
1444                 if((is_array($s)) && (array_key_exists($k,$s))) {
1445                         if($s[$k])
1446                                 return (int) 1;
1447                         return (int) 0;
1448         }
1449                 return false;
1450         }
1451         else {
1452                 if(isset($s)) {
1453                         if($s) {
1454                                 return (int) 1;
1455                         }
1456                         return (int) 0;
1457                 }
1458                 return false;
1459         }
1460 }
1461
1462
1463 /**
1464  * @brief Called from db initialisation if db is dead.
1465  */
1466 function system_unavailable() {
1467         include('system_unavailable.php');
1468         system_down();
1469         killme();
1470 }
1471
1472
1473 function clean_urls() {
1474         $a = get_app();
1475         //      if($a->config['system']['clean_urls'])
1476         return true;
1477         //      return false;
1478 }
1479
1480 function z_path() {
1481         $base = App::get_baseurl();
1482
1483         if(! clean_urls())
1484                 $base .= '/?q=';
1485
1486         return $base;
1487 }
1488
1489 /**
1490  * @brief Returns the baseurl.
1491  *
1492  * @see App::get_baseurl()
1493  *
1494  * @return string
1495  * @TODO Maybe super-flous and deprecated? Seems to only wrap App::get_baseurl()
1496  */
1497 function z_root() {
1498         return App::get_baseurl();
1499 }
1500
1501 /**
1502  * @brief Return absolut URL for given $path.
1503  *
1504  * @param string $path
1505  *
1506  * @return string
1507  */
1508 function absurl($path) {
1509         if(strpos($path,'/') === 0)
1510                 return z_path() . $path;
1511         return $path;
1512 }
1513
1514 /**
1515  * @brief Function to check if request was an AJAX (xmlhttprequest) request.
1516  *
1517  * @return boolean
1518  */
1519 function is_ajax() {
1520         return (!empty($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest');
1521 }
1522
1523 function check_db() {
1524
1525         $build = get_config('system','build');
1526         if(! x($build)) {
1527                 set_config('system','build',DB_UPDATE_VERSION);
1528                 $build = DB_UPDATE_VERSION;
1529         }
1530         if($build != DB_UPDATE_VERSION)
1531                 proc_run(PRIORITY_CRITICAL, 'include/dbupdate.php');
1532
1533 }
1534
1535
1536 /**
1537  * Sets the base url for use in cmdline programs which don't have
1538  * $_SERVER variables
1539  */
1540 function check_url(&$a) {
1541
1542         $url = get_config('system','url');
1543
1544         // if the url isn't set or the stored url is radically different
1545         // than the currently visited url, store the current value accordingly.
1546         // "Radically different" ignores common variations such as http vs https
1547         // and www.example.com vs example.com.
1548         // We will only change the url to an ip address if there is no existing setting
1549
1550         if(! x($url))
1551                 $url = set_config('system','url',$a->get_baseurl());
1552         if((! link_compare($url,$a->get_baseurl())) && (! preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/",$a->get_hostname)))
1553                 $url = set_config('system','url',$a->get_baseurl());
1554
1555         return;
1556 }
1557
1558
1559 /**
1560  * @brief Automatic database updates
1561  */
1562 function update_db(&$a) {
1563         $build = get_config('system','build');
1564         if(! x($build))
1565                 $build = set_config('system','build',DB_UPDATE_VERSION);
1566
1567         if($build != DB_UPDATE_VERSION) {
1568                 $stored = intval($build);
1569                 $current = intval(DB_UPDATE_VERSION);
1570                 if($stored < $current) {
1571                         load_config('database');
1572
1573                         // We're reporting a different version than what is currently installed.
1574                         // Run any existing update scripts to bring the database up to current.
1575
1576                         // make sure that boot.php and update.php are the same release, we might be
1577                         // updating right this very second and the correct version of the update.php
1578                         // file may not be here yet. This can happen on a very busy site.
1579
1580                         if(DB_UPDATE_VERSION == UPDATE_VERSION) {
1581                                 // Compare the current structure with the defined structure
1582
1583                                 $t = get_config('database','dbupdate_'.DB_UPDATE_VERSION);
1584                                 if($t !== false)
1585                                         return;
1586
1587                                 set_config('database','dbupdate_'.DB_UPDATE_VERSION, time());
1588
1589                                 // run old update routine (wich could modify the schema and
1590                                 // conflits with new routine)
1591                                 for ($x = $stored; $x < NEW_UPDATE_ROUTINE_VERSION; $x++) {
1592                                         $r = run_update_function($x);
1593                                         if (!$r) break;
1594                                 }
1595                                 if ($stored < NEW_UPDATE_ROUTINE_VERSION) $stored = NEW_UPDATE_ROUTINE_VERSION;
1596
1597
1598                                 // run new update routine
1599                                 // it update the structure in one call
1600                                 $retval = update_structure(false, true);
1601                                 if($retval) {
1602                                         update_fail(
1603                                                 DB_UPDATE_VERSION,
1604                                                 $retval
1605                                         );
1606                                         return;
1607                                 } else {
1608                                         set_config('database','dbupdate_'.DB_UPDATE_VERSION, 'success');
1609                                 }
1610
1611                                 // run any left update_nnnn functions in update.php
1612                                 for($x = $stored; $x < $current; $x ++) {
1613                                         $r = run_update_function($x);
1614                                         if (!$r) break;
1615                                 }
1616                         }
1617                 }
1618         }
1619
1620         return;
1621 }
1622
1623 function run_update_function($x) {
1624         if(function_exists('update_' . $x)) {
1625
1626                 // There could be a lot of processes running or about to run.
1627                 // We want exactly one process to run the update command.
1628                 // So store the fact that we're taking responsibility
1629                 // after first checking to see if somebody else already has.
1630
1631                 // If the update fails or times-out completely you may need to
1632                 // delete the config entry to try again.
1633
1634                 $t = get_config('database','update_' . $x);
1635                 if($t !== false)
1636                         return false;
1637                 set_config('database','update_' . $x, time());
1638
1639                 // call the specific update
1640
1641                 $func = 'update_' . $x;
1642                 $retval = $func();
1643
1644                 if($retval) {
1645                         //send the administrator an e-mail
1646                         update_fail(
1647                                 $x,
1648                                 sprintf(t('Update %s failed. See error logs.'), $x)
1649                         );
1650                         return false;
1651                 } else {
1652                         set_config('database','update_' . $x, 'success');
1653                         set_config('system','build', $x + 1);
1654                         return true;
1655                 }
1656         } else {
1657                 set_config('database','update_' . $x, 'success');
1658                 set_config('system','build', $x + 1);
1659                 return true;
1660         }
1661         return true;
1662 }
1663
1664 /**
1665  * @brief Synchronise plugins:
1666  *
1667  * $a->config['system']['addon'] contains a comma-separated list of names
1668  * of plugins/addons which are used on this system.
1669  * Go through the database list of already installed addons, and if we have
1670  * an entry, but it isn't in the config list, call the uninstall procedure
1671  * and mark it uninstalled in the database (for now we'll remove it).
1672  * Then go through the config list and if we have a plugin that isn't installed,
1673  * call the install procedure and add it to the database.
1674  *
1675  * @param App $a
1676  *
1677          */
1678 function check_plugins(&$a) {
1679
1680         $r = q("SELECT * FROM `addon` WHERE `installed` = 1");
1681         if (dbm::is_result($r))
1682                 $installed = $r;
1683         else
1684                 $installed = array();
1685
1686         $plugins = get_config('system','addon');
1687         $plugins_arr = array();
1688
1689         if($plugins)
1690                 $plugins_arr = explode(',',str_replace(' ', '',$plugins));
1691
1692         $a->plugins = $plugins_arr;
1693
1694         $installed_arr = array();
1695
1696         if(count($installed)) {
1697                 foreach($installed as $i) {
1698                         if(! in_array($i['name'],$plugins_arr)) {
1699                                 uninstall_plugin($i['name']);
1700                         }
1701                         else {
1702                                 $installed_arr[] = $i['name'];
1703                         }
1704                 }
1705         }
1706
1707         if(count($plugins_arr)) {
1708                 foreach($plugins_arr as $p) {
1709                         if(! in_array($p,$installed_arr)) {
1710                                 install_plugin($p);
1711                         }
1712                 }
1713         }
1714
1715
1716         load_hooks();
1717
1718         return;
1719 }
1720
1721 function get_guid($size=16, $prefix = "") {
1722
1723         if ($prefix == "") {
1724                 $a = get_app();
1725                 $prefix = hash("crc32", $a->get_hostname());
1726         }
1727
1728         while (strlen($prefix) < ($size - 13))
1729                 $prefix .= mt_rand();
1730
1731         if ($size >= 24) {
1732                 $prefix = substr($prefix, 0, $size - 22);
1733                 return(str_replace(".", "", uniqid($prefix, true)));
1734         } else {
1735                 $prefix = substr($prefix, 0, max($size - 13, 0));
1736                 return(uniqid($prefix));
1737         }
1738 }
1739
1740 /**
1741  * @brief Wrapper for adding a login box.
1742  *
1743  * @param bool $register
1744  *      If $register == true provide a registration link.
1745  *      This will most always depend on the value of $a->config['register_policy'].
1746  * @param bool $hiddens
1747  *
1748  * @return string
1749  *      Returns the complete html for inserting into the page
1750  *
1751  * @hooks 'login_hook'
1752  *      string $o
1753  */
1754 function login($register = false, $hiddens=false) {
1755         $a = get_app();
1756         $o = "";
1757         $reg = false;
1758         if ($register) {
1759                 $reg = array(
1760                         'title' => t('Create a New Account'),
1761                         'desc' => t('Register')
1762                 );
1763         }
1764
1765         $noid = get_config('system','no_openid');
1766
1767         $dest_url = $a->query_string;
1768
1769         if(local_user()) {
1770                 $tpl = get_markup_template("logout.tpl");
1771         }
1772         else {
1773                 $a->page['htmlhead'] .= replace_macros(get_markup_template("login_head.tpl"),array(
1774                         '$baseurl'              => $a->get_baseurl(true)
1775                 ));
1776
1777                 $tpl = get_markup_template("login.tpl");
1778                 $_SESSION['return_url'] = $a->query_string;
1779                 $a->module = 'login';
1780         }
1781
1782         $o .= replace_macros($tpl, array(
1783
1784                 '$dest_url'     => $dest_url,
1785                 '$logout'       => t('Logout'),
1786                 '$login'        => t('Login'),
1787
1788                 '$lname'        => array('username', t('Nickname or Email: ') , '', ''),
1789                 '$lpassword'    => array('password', t('Password: '), '', ''),
1790                 '$lremember'    => array('remember', t('Remember me'), 0,  ''),
1791
1792                 '$openid'       => !$noid,
1793                 '$lopenid'      => array('openid_url', t('Or login using OpenID: '),'',''),
1794
1795                 '$hiddens'      => $hiddens,
1796
1797                 '$register'     => $reg,
1798
1799                 '$lostpass'     => t('Forgot your password?'),
1800                 '$lostlink'     => t('Password Reset'),
1801
1802                 '$tostitle'     => t('Website Terms of Service'),
1803                 '$toslink'      => t('terms of service'),
1804
1805                 '$privacytitle' => t('Website Privacy Policy'),
1806                 '$privacylink'  => t('privacy policy'),
1807
1808         ));
1809
1810         call_hooks('login_hook',$o);
1811
1812         return $o;
1813 }
1814
1815 /**
1816  * @brief Used to end the current process, after saving session state.
1817  */
1818 function killme() {
1819
1820         if (!get_app()->is_backend())
1821                 session_write_close();
1822
1823         exit;
1824 }
1825
1826 /**
1827  * @brief Redirect to another URL and terminate this process.
1828  */
1829 function goaway($s) {
1830         if (!strstr(normalise_link($s), "http://"))
1831                 $s = App::get_baseurl()."/".$s;
1832
1833         header("Location: $s");
1834         killme();
1835 }
1836
1837
1838 /**
1839  * @brief Returns the user id of locally logged in user or false.
1840  *
1841  * @return int|bool user id or false
1842  */
1843 function local_user() {
1844         if((x($_SESSION,'authenticated')) && (x($_SESSION,'uid')))
1845                 return intval($_SESSION['uid']);
1846         return false;
1847 }
1848
1849 /**
1850  * @brief Returns contact id of authenticated site visitor or false
1851  *
1852  * @return int|bool visitor_id or false
1853  */
1854 function remote_user() {
1855         if((x($_SESSION,'authenticated')) && (x($_SESSION,'visitor_id')))
1856                 return intval($_SESSION['visitor_id']);
1857         return false;
1858 }
1859
1860 /**
1861  * @brief Show an error message to user.
1862  *
1863  * This function save text in session, to be shown to the user at next page load
1864  *
1865  * @param string $s - Text of notice
1866  */
1867 function notice($s) {
1868         $a = get_app();
1869         if(! x($_SESSION,'sysmsg'))     $_SESSION['sysmsg'] = array();
1870         if($a->interactive)
1871                 $_SESSION['sysmsg'][] = $s;
1872 }
1873
1874 /**
1875  * @brief Show an info message to user.
1876  *
1877  * This function save text in session, to be shown to the user at next page load
1878  *
1879  * @param string $s - Text of notice
1880  */
1881 function info($s) {
1882         $a = get_app();
1883
1884         if (local_user() AND get_pconfig(local_user(),'system','ignore_info'))
1885                 return;
1886
1887         if(! x($_SESSION,'sysmsg_info')) $_SESSION['sysmsg_info'] = array();
1888         if($a->interactive)
1889                 $_SESSION['sysmsg_info'][] = $s;
1890 }
1891
1892
1893 /**
1894  * @brief Wrapper around config to limit the text length of an incoming message
1895  *
1896  * @return int
1897  */
1898 function get_max_import_size() {
1899         $a = get_app();
1900         return ((x($a->config,'max_import_size')) ? $a->config['max_import_size'] : 0 );
1901 }
1902
1903 /**
1904  * @brief Wrap calls to proc_close(proc_open()) and call hook
1905  *      so plugins can take part in process :)
1906  *
1907  * @param (string|integer|array) $cmd program to run, priority or parameter array
1908  *
1909  * next args are passed as $cmd command line
1910  * e.g.: proc_run("ls","-la","/tmp");
1911  * or: proc_run(PRIORITY_HIGH, "include/notifier.php", "drop", $drop_id);
1912  * or: proc_run(array('priority' => PRIORITY_HIGH, 'dont_fork' => true), "include/create_shadowentry.php", $post_id);
1913  *
1914  * @note $cmd and string args are surrounded with ""
1915  *
1916  * @hooks 'proc_run'
1917  *      array $arr
1918  */
1919 function proc_run($cmd){
1920
1921         $a = get_app();
1922
1923         $proc_args = func_get_args();
1924
1925         $args = array();
1926         if (!count($proc_args)) {
1927                 return;
1928         }
1929
1930         // Preserve the first parameter
1931         // It could contain a command, the priority or an parameter array
1932         // If we use the parameter array we have to protect it from the following function
1933         $run_parameter = array_shift($proc_args);
1934
1935         // expand any arrays
1936         foreach ($proc_args as $arg) {
1937                 if (is_array($arg)) {
1938                         foreach ($arg as $n) {
1939                                 $args[] = $n;
1940                         }
1941                 } else {
1942                         $args[] = $arg;
1943                 }
1944         }
1945
1946         // Now we add the run parameters back to the array
1947         array_unshift($args, $run_parameter);
1948
1949         $arr = array('args' => $args, 'run_cmd' => true);
1950
1951         call_hooks("proc_run", $arr);
1952         if (!$arr['run_cmd'] OR !count($args))
1953                 return;
1954
1955         if (!get_config("system", "worker") OR (is_string($run_parameter) AND ($run_parameter != 'php'))) {
1956                 $a->proc_run($args);
1957                 return;
1958         }
1959
1960         $priority = PRIORITY_MEDIUM;
1961         $dont_fork = get_config("system", "worker_dont_fork");
1962
1963         if (is_int($run_parameter)) {
1964                 $priority = $run_parameter;
1965         } elseif (is_array($run_parameter)) {
1966                 if (isset($run_parameter['priority'])) {
1967                         $priority = $run_parameter['priority'];
1968                 }
1969                 if (isset($run_parameter['dont_fork'])) {
1970                         $dont_fork = $run_parameter['dont_fork'];
1971                 }
1972         }
1973
1974         $argv = $args;
1975         array_shift($argv);
1976
1977         $parameters = json_encode($argv);
1978         $found = q("SELECT `id` FROM `workerqueue` WHERE `parameter` = '%s'",
1979                 dbesc($parameters));
1980
1981         if (!$found)
1982                 q("INSERT INTO `workerqueue` (`parameter`, `created`, `priority`)
1983                         VALUES ('%s', '%s', %d)",
1984                         dbesc($parameters),
1985                         dbesc(datetime_convert()),
1986                         intval($priority));
1987
1988         // Should we quit and wait for the poller to be called as a cronjob?
1989         if ($dont_fork) {
1990                 return;
1991         }
1992
1993         // Checking number of workers
1994         $workers = q("SELECT COUNT(*) AS `workers` FROM `workerqueue` WHERE `executed` != '0000-00-00 00:00:00'");
1995
1996         // Get number of allowed number of worker threads
1997         $queues = intval(get_config("system", "worker_queues"));
1998
1999         if ($queues == 0)
2000                 $queues = 4;
2001
2002         // If there are already enough workers running, don't fork another one
2003         if ($workers[0]["workers"] >= $queues)
2004                 return;
2005
2006         // Now call the poller to execute the jobs that we just added to the queue
2007         $args = array("php", "include/poller.php", "no_cron");
2008
2009         $a->proc_run($args);
2010 }
2011
2012 function current_theme(){
2013         $app_base_themes = array('duepuntozero', 'dispy', 'quattro');
2014
2015         $a = get_app();
2016
2017         $page_theme = null;
2018
2019         // Find the theme that belongs to the user whose stuff we are looking at
2020
2021         if($a->profile_uid && ($a->profile_uid != local_user())) {
2022                 $r = q("select theme from user where uid = %d limit 1",
2023                         intval($a->profile_uid)
2024                 );
2025                 if (dbm::is_result($r))
2026                         $page_theme = $r[0]['theme'];
2027         }
2028
2029         // Allow folks to over-rule user themes and always use their own on their own site.
2030         // This works only if the user is on the same server
2031
2032         if($page_theme && local_user() && (local_user() != $a->profile_uid)) {
2033                 if(get_pconfig(local_user(),'system','always_my_theme'))
2034                         $page_theme = null;
2035         }
2036
2037 //              $mobile_detect = new Mobile_Detect();
2038 //              $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
2039         $is_mobile = $a->is_mobile || $a->is_tablet;
2040
2041         $standard_system_theme = ((isset($a->config['system']['theme'])) ? $a->config['system']['theme'] : '');
2042         $standard_theme_name = ((isset($_SESSION) && x($_SESSION,'theme')) ? $_SESSION['theme'] : $standard_system_theme);
2043
2044         if($is_mobile) {
2045                 if(isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
2046                         $system_theme = $standard_system_theme;
2047                         $theme_name = $standard_theme_name;
2048                 }
2049                 else {
2050                         $system_theme = ((isset($a->config['system']['mobile-theme'])) ? $a->config['system']['mobile-theme'] : $standard_system_theme);
2051                         $theme_name = ((isset($_SESSION) && x($_SESSION,'mobile-theme')) ? $_SESSION['mobile-theme'] : $system_theme);
2052
2053                         if($theme_name === '---') {
2054                                 // user has selected to have the mobile theme be the same as the normal one
2055                                 $system_theme = $standard_system_theme;
2056                                 $theme_name = $standard_theme_name;
2057
2058                                 if($page_theme)
2059                                         $theme_name = $page_theme;
2060                         }
2061                 }
2062         }
2063         else {
2064                 $system_theme = $standard_system_theme;
2065                 $theme_name = $standard_theme_name;
2066
2067                 if($page_theme)
2068                         $theme_name = $page_theme;
2069         }
2070
2071         if($theme_name &&
2072                         (file_exists('view/theme/' . $theme_name . '/style.css') ||
2073                                         file_exists('view/theme/' . $theme_name . '/style.php')))
2074                 return($theme_name);
2075
2076         foreach($app_base_themes as $t) {
2077                 if(file_exists('view/theme/' . $t . '/style.css')||
2078                                 file_exists('view/theme/' . $t . '/style.php'))
2079                         return($t);
2080         }
2081
2082         $fallback = array_merge(glob('view/theme/*/style.css'),glob('view/theme/*/style.php'));
2083         if(count($fallback))
2084                 return (str_replace('view/theme/','', substr($fallback[0],0,-10)));
2085
2086 }
2087
2088 /**
2089  * @brief Return full URL to theme which is currently in effect.
2090  *
2091  * Provide a sane default if nothing is chosen or the specified theme does not exist.
2092  *
2093  * @return string
2094  */
2095 function current_theme_url() {
2096         $a = get_app();
2097
2098         $t = current_theme();
2099
2100         $opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : '');
2101         if (file_exists('view/theme/' . $t . '/style.php'))
2102                 return('view/theme/'.$t.'/style.pcss'.$opts);
2103
2104         return('view/theme/'.$t.'/style.css');
2105 }
2106
2107 function feed_birthday($uid,$tz) {
2108
2109         /**
2110          *
2111          * Determine the next birthday, but only if the birthday is published
2112          * in the default profile. We _could_ also look for a private profile that the
2113          * recipient can see, but somebody could get mad at us if they start getting
2114          * public birthday greetings when they haven't made this info public.
2115          *
2116          * Assuming we are able to publish this info, we are then going to convert
2117          * the start time from the owner's timezone to UTC.
2118          *
2119          * This will potentially solve the problem found with some social networks
2120          * where birthdays are converted to the viewer's timezone and salutations from
2121          * elsewhere in the world show up on the wrong day. We will convert it to the
2122          * viewer's timezone also, but first we are going to convert it from the birthday
2123          * person's timezone to GMT - so the viewer may find the birthday starting at
2124          * 6:00PM the day before, but that will correspond to midnight to the birthday person.
2125          *
2126          */
2127
2128
2129         $birthday = '';
2130
2131         if(! strlen($tz))
2132                 $tz = 'UTC';
2133
2134         $p = q("SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1",
2135                         intval($uid)
2136         );
2137
2138         if (dbm::is_result($p)) {
2139                 $tmp_dob = substr($p[0]['dob'],5);
2140                 if(intval($tmp_dob)) {
2141                         $y = datetime_convert($tz,$tz,'now','Y');
2142                         $bd = $y . '-' . $tmp_dob . ' 00:00';
2143                         $t_dob = strtotime($bd);
2144                         $now = strtotime(datetime_convert($tz,$tz,'now'));
2145                         if($t_dob < $now)
2146                                 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
2147                         $birthday = datetime_convert($tz,'UTC',$bd,ATOM_TIME);
2148                 }
2149         }
2150
2151         return $birthday;
2152 }
2153
2154 /**
2155  * @brief Check if current user has admin role.
2156  *
2157  * @return bool true if user is an admin
2158  */
2159 function is_site_admin() {
2160         $a = get_app();
2161
2162         $adminlist = explode(",", str_replace(" ", "", $a->config['admin_email']));
2163
2164         //if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && ($a->user['email'] === $a->config['admin_email']))
2165         if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && in_array($a->user['email'], $adminlist))
2166                 return true;
2167         return false;
2168 }
2169
2170 /**
2171  * @brief Returns querystring as string from a mapped array.
2172  *
2173  * @param array $params mapped array with query parameters
2174  * @param string $name of parameter, default null
2175  *
2176  * @return string
2177  */
2178 function build_querystring($params, $name=null) {
2179         $ret = "";
2180         foreach($params as $key=>$val) {
2181                 if(is_array($val)) {
2182                         if($name==null) {
2183                                 $ret .= build_querystring($val, $key);
2184                         } else {
2185                                 $ret .= build_querystring($val, $name."[$key]");
2186                         }
2187                 } else {
2188                         $val = urlencode($val);
2189                         if($name!=null) {
2190                                 $ret.=$name."[$key]"."=$val&";
2191                         } else {
2192                                 $ret.= "$key=$val&";
2193                         }
2194                 }
2195         }
2196         return $ret;
2197 }
2198
2199 function explode_querystring($query) {
2200         $arg_st = strpos($query, '?');
2201         if($arg_st !== false) {
2202                 $base = substr($query, 0, $arg_st);
2203                 $arg_st += 1;
2204         } else {
2205                 $base = '';
2206                 $arg_st = 0;
2207         }
2208
2209         $args = explode('&', substr($query, $arg_st));
2210         foreach($args as $k=>$arg) {
2211                 if($arg === '')
2212                         unset($args[$k]);
2213         }
2214         $args = array_values($args);
2215
2216         if(!$base) {
2217                 $base = $args[0];
2218                 unset($args[0]);
2219                 $args = array_values($args);
2220         }
2221
2222         return array(
2223                 'base' => $base,
2224                 'args' => $args,
2225         );
2226 }
2227
2228 /**
2229 * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
2230 *
2231 * Taken from http://webcheatsheet.com/php/get_current_page_url.php
2232 */
2233 function curPageURL() {
2234         $pageURL = 'http';
2235         if ($_SERVER["HTTPS"] == "on") {$pageURL .= "s";}
2236         $pageURL .= "://";
2237         if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
2238                 $pageURL .= $_SERVER["SERVER_NAME"].":".$_SERVER["SERVER_PORT"].$_SERVER["REQUEST_URI"];
2239         } else {
2240                 $pageURL .= $_SERVER["SERVER_NAME"].$_SERVER["REQUEST_URI"];
2241         }
2242         return $pageURL;
2243 }
2244
2245 function random_digits($digits) {
2246         $rn = '';
2247         for($i = 0; $i < $digits; $i++) {
2248                 $rn .= rand(0,9);
2249         }
2250         return $rn;
2251 }
2252
2253 function get_server() {
2254         $server = get_config("system", "directory");
2255
2256         if ($server == "")
2257                 $server = "http://dir.friendi.ca";
2258
2259         return($server);
2260 }
2261
2262 function get_cachefile($file, $writemode = true) {
2263         $cache = get_itemcachepath();
2264
2265         if ((! $cache) || (! is_dir($cache)))
2266                 return("");
2267
2268         $subfolder = $cache."/".substr($file, 0, 2);
2269
2270         $cachepath = $subfolder."/".$file;
2271
2272         if ($writemode) {
2273                 if (!is_dir($subfolder)) {
2274                         mkdir($subfolder);
2275                         chmod($subfolder, 0777);
2276                 }
2277         }
2278
2279         return($cachepath);
2280 }
2281
2282 function clear_cache($basepath = "", $path = "") {
2283         if ($path == "") {
2284                 $basepath = get_itemcachepath();
2285                 $path = $basepath;
2286         }
2287
2288         if (($path == "") OR (!is_dir($path)))
2289                 return;
2290
2291         if (substr(realpath($path), 0, strlen($basepath)) != $basepath)
2292                 return;
2293
2294         $cachetime = (int)get_config('system','itemcache_duration');
2295         if ($cachetime == 0)
2296                 $cachetime = 86400;
2297
2298         if (is_writable($path)){
2299                 if ($dh = opendir($path)) {
2300                         while (($file = readdir($dh)) !== false) {
2301                                 $fullpath = $path."/".$file;
2302                                 if ((filetype($fullpath) == "dir") and ($file != ".") and ($file != ".."))
2303                                         clear_cache($basepath, $fullpath);
2304                                 if ((filetype($fullpath) == "file") and (filectime($fullpath) < (time() - $cachetime)))
2305                                         unlink($fullpath);
2306                         }
2307                         closedir($dh);
2308                 }
2309         }
2310 }
2311
2312 function get_itemcachepath() {
2313         // Checking, if the cache is deactivated
2314         $cachetime = (int)get_config('system','itemcache_duration');
2315         if ($cachetime < 0)
2316                 return "";
2317
2318         $itemcache = get_config('system','itemcache');
2319         if (($itemcache != "") AND is_dir($itemcache) AND is_writable($itemcache))
2320                 return($itemcache);
2321
2322         $temppath = get_temppath();
2323
2324         if ($temppath != "") {
2325                 $itemcache = $temppath."/itemcache";
2326                 if(!file_exists($itemcache) && !is_dir($itemcache)) {
2327                         mkdir($itemcache);
2328                 }
2329
2330                 if (is_dir($itemcache) AND is_writable($itemcache)) {
2331                         set_config("system", "itemcache", $itemcache);
2332                         return($itemcache);
2333                 }
2334         }
2335         return "";
2336 }
2337
2338 function get_lockpath() {
2339         $lockpath = get_config('system','lockpath');
2340         if (($lockpath != "") AND is_dir($lockpath) AND is_writable($lockpath))
2341                 return($lockpath);
2342
2343         $temppath = get_temppath();
2344
2345         if ($temppath != "") {
2346                 $lockpath = $temppath."/lock";
2347
2348                 if (!is_dir($lockpath))
2349                         mkdir($lockpath);
2350                 elseif (!is_writable($lockpath))
2351                         $lockpath = $temppath;
2352
2353                 if (is_dir($lockpath) AND is_writable($lockpath)) {
2354                         set_config("system", "lockpath", $lockpath);
2355                         return($lockpath);
2356                 }
2357         }
2358         return "";
2359 }
2360
2361 /**
2362  * @brief Returns the path where spool files are stored
2363  *
2364  * @return string Spool path
2365  */
2366 function get_spoolpath() {
2367         $spoolpath = get_config('system','spoolpath');
2368         if (($spoolpath != "") AND is_dir($spoolpath) AND is_writable($spoolpath)) {
2369                 return($spoolpath);
2370         }
2371
2372         $temppath = get_temppath();
2373
2374         if ($temppath != "") {
2375                 $spoolpath = $temppath."/spool";
2376
2377                 if (!is_dir($spoolpath)) {
2378                         mkdir($spoolpath);
2379                 } elseif (!is_writable($spoolpath)) {
2380                         $spoolpath = $temppath;
2381                 }
2382
2383                 if (is_dir($spoolpath) AND is_writable($spoolpath)) {
2384                         set_config("system", "spoolpath", $spoolpath);
2385                         return($spoolpath);
2386                 }
2387         }
2388         return "";
2389 }
2390
2391 function get_temppath() {
2392         $a = get_app();
2393
2394         $temppath = get_config("system","temppath");
2395         if (($temppath != "") AND is_dir($temppath) AND is_writable($temppath))
2396                 return($temppath);
2397
2398         $temppath = sys_get_temp_dir();
2399         if (($temppath != "") AND is_dir($temppath) AND is_writable($temppath)) {
2400                 $temppath .= "/".$a->get_hostname();
2401                 if (!is_dir($temppath))
2402                         mkdir($temppath);
2403
2404                 if (is_dir($temppath) AND is_writable($temppath)) {
2405                         set_config("system", "temppath", $temppath);
2406                         return($temppath);
2407                 }
2408         }
2409
2410         return("");
2411 }
2412
2413 function set_template_engine(&$a, $engine = 'internal') {
2414 /// @note This function is no longer necessary, but keep it as a wrapper to the class method
2415 /// to avoid breaking themes again unnecessarily
2416
2417         $a->set_template_engine($engine);
2418 }
2419
2420 if(!function_exists('exif_imagetype')) {
2421         function exif_imagetype($file) {
2422                 $size = getimagesize($file);
2423                 return($size[2]);
2424         }
2425 }
2426
2427 function validate_include(&$file) {
2428         $orig_file = $file;
2429
2430         $file = realpath($file);
2431
2432         if (strpos($file, getcwd()) !== 0)
2433                 return false;
2434
2435         $file = str_replace(getcwd()."/", "", $file, $count);
2436         if ($count != 1)
2437                 return false;
2438
2439         if ($orig_file !== $file)
2440                 return false;
2441
2442         $valid = false;
2443         if (strpos($file, "include/") === 0)
2444                 $valid = true;
2445
2446         if (strpos($file, "addon/") === 0)
2447                 $valid = true;
2448
2449         if (!$valid)
2450                 return false;
2451
2452         return true;
2453 }
2454
2455 function current_load() {
2456         if (!function_exists('sys_getloadavg'))
2457                 return false;
2458
2459         $load_arr = sys_getloadavg();
2460
2461         if (!is_array($load_arr))
2462                 return false;
2463
2464         return max($load_arr[0], $load_arr[1]);
2465 }
2466
2467 /**
2468  * @brief get c-style args
2469  *
2470  * @return int
2471  */
2472 function argc() {
2473         return get_app()->argc;
2474 }
2475
2476 /**
2477  * @brief Returns the value of a argv key
2478  *
2479  * @param int $x argv key
2480  * @return string Value of the argv key
2481  */
2482 function argv($x) {
2483         if(array_key_exists($x,get_app()->argv))
2484                 return get_app()->argv[$x];
2485
2486         return '';
2487 }
2488
2489 /**
2490  * @brief Get the data which is needed for infinite scroll
2491  *
2492  * For invinite scroll we need the page number of the actual page
2493  * and the the URI where the content of the next page comes from.
2494  * This data is needed for the js part in main.js.
2495  * Note: infinite scroll does only work for the network page (module)
2496  *
2497  * @param string $module The name of the module (e.g. "network")
2498  * @return array Of infinite scroll data
2499  *      'pageno' => $pageno The number of the actual page
2500  *      'reload_uri' => $reload_uri The URI of the content we have to load
2501  */
2502 function infinite_scroll_data($module) {
2503
2504         if (get_pconfig(local_user(),'system','infinite_scroll')
2505                 AND ($module == "network") AND ($_GET["mode"] != "minimal")) {
2506
2507                 // get the page number
2508                 if (is_string($_GET["page"]))
2509                         $pageno = $_GET["page"];
2510                 else
2511                         $pageno = 1;
2512
2513                 $reload_uri = "";
2514
2515                 // try to get the uri from which we load the content
2516                 foreach ($_GET AS $param => $value)
2517                         if (($param != "page") AND ($param != "q"))
2518                                 $reload_uri .= "&".$param."=".urlencode($value);
2519
2520                 if (($a->page_offset != "") AND !strstr($reload_uri, "&offset="))
2521                         $reload_uri .= "&offset=".urlencode($a->page_offset);
2522
2523                 $arr = array("pageno" => $pageno, "reload_uri" => $reload_uri);
2524
2525                 return $arr;
2526         }
2527 }