boot.php

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