src/App.php

   1 <?php
   2 /**
   3  * @file src/App.php
   4  */
   5 namespace Friendica;
   6
   7 use Exception;
   8 use Friendica\App\Arguments;
   9 use Friendica\App\BaseURL;
  10 use Friendica\App\Page;
  11 use Friendica\App\Authentication;
  12 use Friendica\Core\Config\Cache\ConfigCache;
  13 use Friendica\Core\Config\Configuration;
  14 use Friendica\Core\Config\PConfiguration;
  15 use Friendica\Core\L10n\L10n;
  16 use Friendica\Core\System;
  17 use Friendica\Core\Theme;
  18 use Friendica\Database\Database;
  19 use Friendica\Model\Profile;
  20 use Friendica\Module\Special\HTTPException as ModuleHTTPException;
  21 use Friendica\Network\HTTPException;
  22 use Friendica\Util\ConfigFileLoader;
  23 use Friendica\Util\HTTPSignature;
  24 use Friendica\Util\Profiler;
  25 use Friendica\Util\Strings;
  26 use Psr\Log\LoggerInterface;
  27
  28 /**
  29  *
  30  * class: App
  31  *
  32  * @brief Our main application structure for the life of this page.
  33  *
  34  * Primarily deals with the URL that got us here
  35  * and tries to make some sense of it, and
  36  * stores our page contents and config storage
  37  * and anything else that might need to be passed around
  38  * before we spit the page out.
  39  *
  40  */
  41 class App
  42 {
  43         /** @deprecated 2019.09 - use App\Arguments->getQueryString() */
  44         public $query_string;
  45         /**
  46          * @var Page The current page environment
  47          */
  48         public $page;
  49         public $profile;
  50         public $profile_uid;
  51         public $user;
  52         public $cid;
  53         public $contact;
  54         public $contacts;
  55         public $page_contact;
  56         public $content;
  57         public $data = [];
  58         /** @deprecated 2019.09 - use App\Arguments->getCommand() */
  59         public $cmd = '';
  60         /** @deprecated 2019.09 - use App\Arguments->getArgv() or Arguments->get() */
  61         public $argv;
  62         /** @deprecated 2019.09 - use App\Arguments->getArgc() */
  63         public $argc;
  64         /** @deprecated 2019.09 - Use App\Module->getName() instead */
  65         public $module;
  66         public $timezone;
  67         public $interactive = true;
  68         public $identities;
  69         /** @deprecated 2019.09 - Use App\Mode->isMobile() instead */
  70         public $is_mobile;
  71         /** @deprecated 2019.09 - Use App\Mode->isTable() instead */
  72         public $is_tablet;
  73         public $theme_info = [];
  74         public $category;
  75         // Allow themes to control internal parameters
  76         // by changing App values in theme.php
  77
  78         public $sourcename              = '';
  79         public $videowidth              = 425;
  80         public $videoheight             = 350;
  81         public $force_max_items         = 0;
  82         public $theme_events_in_profile = true;
  83         public $queue;
  84
  85         /**
  86          * @var App\Mode The Mode of the Application
  87          */
  88         private $mode;
  89
  90         /**
  91          * @var BaseURL
  92          */
  93         private $baseURL;
  94
  95         /** @var string The name of the current theme */
  96         private $currentTheme;
  97         /** @var string The name of the current mobile theme */
  98         private $currentMobileTheme;
  99
 100         /**
 101          * @var Configuration The config
 102          */
 103         private $config;
 104
 105         /**
 106          * @var LoggerInterface The logger
 107          */
 108         private $logger;
 109
 110         /**
 111          * @var Profiler The profiler of this app
 112          */
 113         private $profiler;
 114
 115         /**
 116          * @var Database The Friendica database connection
 117          */
 118         private $database;
 119
 120         /**
 121          * @var L10n The translator
 122          */
 123         private $l10n;
 124
 125         /**
 126          * @var App\Arguments
 127          */
 128         private $args;
 129
 130         /**
 131          * @var Core\Process The process methods
 132          */
 133         private $process;
 134
 135         /**
 136          * Returns the current config cache of this node
 137          *
 138          * @return ConfigCache
 139          */
 140         public function getConfigCache()
 141         {
 142                 return $this->config->getCache();
 143         }
 144
 145         /**
 146          * The basepath of this app
 147          *
 148          * @return string
 149          */
 150         public function getBasePath()
 151         {
 152                 // Don't use the basepath of the config table for basepath (it should always be the config-file one)
 153                 return $this->config->getCache()->get('system', 'basepath');
 154         }
 155
 156         /**
 157          * @deprecated 2019.09 - use Page->registerStylesheet instead
 158          * @see        Page::registerStylesheet()
 159          */
 160         public function registerStylesheet($path)
 161         {
 162                 $this->page->registerStylesheet($path);
 163         }
 164
 165         /**
 166          * @deprecated 2019.09 - use Page->registerFooterScript instead
 167          * @see        Page::registerFooterScript()
 168          */
 169         public function registerFooterScript($path)
 170         {
 171                 $this->page->registerFooterScript($path);
 172         }
 173
 174         /**
 175          * @param Database        $database The Friendica Database
 176          * @param Configuration   $config   The Configuration
 177          * @param App\Mode        $mode     The mode of this Friendica app
 178          * @param BaseURL         $baseURL  The full base URL of this Friendica app
 179          * @param LoggerInterface $logger   The current app logger
 180          * @param Profiler        $profiler The profiler of this application
 181          * @param L10n            $l10n     The translator instance
 182          * @param App\Arguments   $args     The Friendica Arguments of the call
 183          * @param Core\Process    $process  The process methods
 184          */
 185         public function __construct(Database $database, Configuration $config, App\Mode $mode, BaseURL $baseURL, LoggerInterface $logger, Profiler $profiler, L10n $l10n, Arguments $args, App\Module $module, App\Page $page, Core\Process $process)
 186         {
 187                 $this->database = $database;
 188                 $this->config   = $config;
 189                 $this->mode     = $mode;
 190                 $this->baseURL  = $baseURL;
 191                 $this->profiler = $profiler;
 192                 $this->logger   = $logger;
 193                 $this->l10n     = $l10n;
 194                 $this->args     = $args;
 195                 $this->process  = $process;
 196
 197                 $this->cmd          = $args->getCommand();
 198                 $this->argv         = $args->getArgv();
 199                 $this->argc         = $args->getArgc();
 200                 $this->query_string = $args->getQueryString();
 201                 $this->module       = $module->getName();
 202                 $this->page         = $page;
 203
 204                 $this->is_mobile = $mode->isMobile();
 205                 $this->is_tablet = $mode->isTablet();
 206
 207                 $this->load();
 208         }
 209
 210         /**
 211          * Load the whole app instance
 212          */
 213         public function load()
 214         {
 215                 set_time_limit(0);
 216
 217                 // This has to be quite large to deal with embedded private photos
 218                 ini_set('pcre.backtrack_limit', 500000);
 219
 220                 set_include_path(
 221                         get_include_path() . PATH_SEPARATOR
 222                         . $this->getBasePath() . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
 223                         . $this->getBasePath() . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
 224                         . $this->getBasePath());
 225
 226                 $this->profiler->reset();
 227
 228                 if ($this->mode->has(App\Mode::DBAVAILABLE)) {
 229                         $this->profiler->update($this->config);
 230
 231                         Core\Hook::loadHooks();
 232                         $loader = new ConfigFileLoader($this->getBasePath());
 233                         Core\Hook::callAll('load_config', $loader);
 234                 }
 235
 236                 $this->loadDefaultTimezone();
 237                 // Register template engines
 238                 Core\Renderer::registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
 239         }
 240
 241         /**
 242          * Loads the default timezone
 243          *
 244          * Include support for legacy $default_timezone
 245          *
 246          * @global string $default_timezone
 247          */
 248         private function loadDefaultTimezone()
 249         {
 250                 if ($this->config->get('system', 'default_timezone')) {
 251                         $this->timezone = $this->config->get('system', 'default_timezone');
 252                 } else {
 253                         global $default_timezone;
 254                         $this->timezone = !empty($default_timezone) ? $default_timezone : 'UTC';
 255                 }
 256
 257                 if ($this->timezone) {
 258                         date_default_timezone_set($this->timezone);
 259                 }
 260         }
 261
 262         /**
 263          * Returns the scheme of the current call
 264          *
 265          * @return string
 266          *
 267          * @deprecated 2019.06 - use BaseURL->getScheme() instead
 268          */
 269         public function getScheme()
 270         {
 271                 return $this->baseURL->getScheme();
 272         }
 273
 274         /**
 275          * Retrieves the Friendica instance base URL
 276          *
 277          * @param bool $ssl Whether to append http or https under BaseURL::SSL_POLICY_SELFSIGN
 278          *
 279          * @return string Friendica server base URL
 280          *
 281          * @deprecated 2019.09 - use BaseUrl->get($ssl) instead
 282          */
 283         public function getBaseURL($ssl = false)
 284         {
 285                 return $this->baseURL->get($ssl);
 286         }
 287
 288         /**
 289          * @brief      Initializes the baseurl components
 290          *
 291          * Clears the baseurl cache to prevent inconsistencies
 292          *
 293          * @param string $url
 294          *
 295          * @deprecated 2019.06 - use BaseURL->saveByURL($url) instead
 296          */
 297         public function setBaseURL($url)
 298         {
 299                 $this->baseURL->saveByURL($url);
 300         }
 301
 302         /**
 303          * Returns the current hostname
 304          *
 305          * @return string
 306          *
 307          * @deprecated 2019.06 - use BaseURL->getHostname() instead
 308          */
 309         public function getHostName()
 310         {
 311                 return $this->baseURL->getHostname();
 312         }
 313
 314         /**
 315          * Returns the sub-path of the full URL
 316          *
 317          * @return string
 318          *
 319          * @deprecated 2019.06 - use BaseURL->getUrlPath() instead
 320          */
 321         public function getURLPath()
 322         {
 323                 return $this->baseURL->getUrlPath();
 324         }
 325
 326         /**
 327          * Returns the current UserAgent as a String
 328          *
 329          * @return string the UserAgent as a String
 330          * @throws HTTPException\InternalServerErrorException
 331          */
 332         public function getUserAgent()
 333         {
 334                 return
 335                         FRIENDICA_PLATFORM . " '" .
 336                         FRIENDICA_CODENAME . "' " .
 337                         FRIENDICA_VERSION . '-' .
 338                         DB_UPDATE_VERSION . '; ' .
 339                         $this->getBaseURL();
 340         }
 341
 342         /**
 343          * Generates the site's default sender email address
 344          *
 345          * @return string
 346          * @throws HTTPException\InternalServerErrorException
 347          */
 348         public function getSenderEmailAddress()
 349         {
 350                 $sender_email = $this->config->get('config', 'sender_email');
 351                 if (empty($sender_email)) {
 352                         $hostname = $this->baseURL->getHostname();
 353                         if (strpos($hostname, ':')) {
 354                                 $hostname = substr($hostname, 0, strpos($hostname, ':'));
 355                         }
 356
 357                         $sender_email = 'noreply@' . $hostname;
 358                 }
 359
 360                 return $sender_email;
 361         }
 362
 363         /**
 364          * Returns the current theme name. May be overriden by the mobile theme name.
 365          *
 366          * @return string
 367          * @throws Exception
 368          */
 369         public function getCurrentTheme()
 370         {
 371                 if ($this->mode->isInstall()) {
 372                         return '';
 373                 }
 374
 375                 // Specific mobile theme override
 376                 if (($this->mode->isMobile() || $this->mode->isTablet()) && Core\Session::get('show-mobile', true)) {
 377                         $user_mobile_theme = $this->getCurrentMobileTheme();
 378
 379                         // --- means same mobile theme as desktop
 380                         if (!empty($user_mobile_theme) && $user_mobile_theme !== '---') {
 381                                 return $user_mobile_theme;
 382                         }
 383                 }
 384
 385                 if (!$this->currentTheme) {
 386                         $this->computeCurrentTheme();
 387                 }
 388
 389                 return $this->currentTheme;
 390         }
 391
 392         /**
 393          * Returns the current mobile theme name.
 394          *
 395          * @return string
 396          * @throws Exception
 397          */
 398         public function getCurrentMobileTheme()
 399         {
 400                 if ($this->mode->isInstall()) {
 401                         return '';
 402                 }
 403
 404                 if (is_null($this->currentMobileTheme)) {
 405                         $this->computeCurrentMobileTheme();
 406                 }
 407
 408                 return $this->currentMobileTheme;
 409         }
 410
 411         public function setCurrentTheme($theme)
 412         {
 413                 $this->currentTheme = $theme;
 414         }
 415
 416         public function setCurrentMobileTheme($theme)
 417         {
 418                 $this->currentMobileTheme = $theme;
 419         }
 420
 421         /**
 422          * Computes the current theme name based on the node settings, the page owner settings and the user settings
 423          *
 424          * @throws Exception
 425          */
 426         private function computeCurrentTheme()
 427         {
 428                 $system_theme = $this->config->get('system', 'theme');
 429                 if (!$system_theme) {
 430                         throw new Exception($this->l10n->t('No system theme config value set.'));
 431                 }
 432
 433                 // Sane default
 434                 $this->setCurrentTheme($system_theme);
 435
 436                 $page_theme = null;
 437                 // Find the theme that belongs to the user whose stuff we are looking at
 438                 if ($this->profile_uid && ($this->profile_uid != local_user())) {
 439                         // Allow folks to override user themes and always use their own on their own site.
 440                         // This works only if the user is on the same server
 441                         $user = $this->database->selectFirst('user', ['theme'], ['uid' => $this->profile_uid]);
 442                         if ($this->database->isResult($user) && !Core\PConfig::get(local_user(), 'system', 'always_my_theme')) {
 443                                 $page_theme = $user['theme'];
 444                         }
 445                 }
 446
 447                 $theme_name = $page_theme ?: Core\Session::get('theme', $system_theme);
 448
 449                 $theme_name = Strings::sanitizeFilePathItem($theme_name);
 450                 if ($theme_name
 451                     && in_array($theme_name, Theme::getAllowedList())
 452                     && (file_exists('view/theme/' . $theme_name . '/style.css')
 453                         || file_exists('view/theme/' . $theme_name . '/style.php'))
 454                 ) {
 455                         $this->setCurrentTheme($theme_name);
 456                 }
 457         }
 458
 459         /**
 460          * Computes the current mobile theme name based on the node settings, the page owner settings and the user settings
 461          */
 462         private function computeCurrentMobileTheme()
 463         {
 464                 $system_mobile_theme = $this->config->get('system', 'mobile-theme', '');
 465
 466                 // Sane default
 467                 $this->setCurrentMobileTheme($system_mobile_theme);
 468
 469                 $page_mobile_theme = null;
 470                 // Find the theme that belongs to the user whose stuff we are looking at
 471                 if ($this->profile_uid && ($this->profile_uid != local_user())) {
 472                         // Allow folks to override user themes and always use their own on their own site.
 473                         // This works only if the user is on the same server
 474                         if (!Core\PConfig::get(local_user(), 'system', 'always_my_theme')) {
 475                                 $page_mobile_theme = Core\PConfig::get($this->profile_uid, 'system', 'mobile-theme');
 476                         }
 477                 }
 478
 479                 $mobile_theme_name = $page_mobile_theme ?: Core\Session::get('mobile-theme', $system_mobile_theme);
 480
 481                 $mobile_theme_name = Strings::sanitizeFilePathItem($mobile_theme_name);
 482                 if ($mobile_theme_name == '---'
 483                         ||
 484                         in_array($mobile_theme_name, Theme::getAllowedList())
 485                         && (file_exists('view/theme/' . $mobile_theme_name . '/style.css')
 486                                 || file_exists('view/theme/' . $mobile_theme_name . '/style.php'))
 487                 ) {
 488                         $this->setCurrentMobileTheme($mobile_theme_name);
 489                 }
 490         }
 491
 492         /**
 493          * @brief Return full URL to theme which is currently in effect.
 494          *
 495          * Provide a sane default if nothing is chosen or the specified theme does not exist.
 496          *
 497          * @return string
 498          * @throws Exception
 499          */
 500         public function getCurrentThemeStylesheetPath()
 501         {
 502                 return Core\Theme::getStylesheetPath($this->getCurrentTheme());
 503         }
 504
 505         /**
 506          * Sets the base url for use in cmdline programs which don't have
 507          * $_SERVER variables
 508          */
 509         public function checkURL()
 510         {
 511                 $url = $this->config->get('system', 'url');
 512
 513                 // if the url isn't set or the stored url is radically different
 514                 // than the currently visited url, store the current value accordingly.
 515                 // "Radically different" ignores common variations such as http vs https
 516                 // and www.example.com vs example.com.
 517                 // We will only change the url to an ip address if there is no existing setting
 518
 519                 if (empty($url) || (!Util\Strings::compareLink($url, $this->getBaseURL())) && (!preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/", $this->baseURL->getHostname()))) {
 520                         $this->config->set('system', 'url', $this->getBaseURL());
 521                 }
 522         }
 523
 524         /**
 525          * Frontend App script
 526          *
 527          * The App object behaves like a container and a dispatcher at the same time, including a representation of the
 528          * request and a representation of the response.
 529          *
 530          * This probably should change to limit the size of this monster method.
 531          *
 532          * @param App\Module     $module The determined module
 533          * @param App\Router     $router
 534          * @param PConfiguration $pconfig
 535          * @param Authentication $auth The Authentication backend of the node
 536          * @throws HTTPException\InternalServerErrorException
 537          * @throws \ImagickException
 538          */
 539         public function runFrontend(App\Module $module, App\Router $router, PConfiguration $pconfig, Authentication $auth)
 540         {
 541                 $moduleName = $module->getName();
 542
 543                 try {
 544                         // Missing DB connection: ERROR
 545                         if ($this->mode->has(App\Mode::LOCALCONFIGPRESENT) && !$this->mode->has(App\Mode::DBAVAILABLE)) {
 546                                 throw new HTTPException\InternalServerErrorException('Apologies but the website is unavailable at the moment.');
 547                         }
 548
 549                         // Max Load Average reached: ERROR
 550                         if ($this->process->isMaxProcessesReached() || $this->process->isMaxLoadReached()) {
 551                                 header('Retry-After: 120');
 552                                 header('Refresh: 120; url=' . $this->baseURL->get() . "/" . $this->args->getQueryString());
 553
 554                                 throw new HTTPException\ServiceUnavailableException('The node is currently overloaded. Please try again later.');
 555                         }
 556
 557                         if (!$this->mode->isInstall()) {
 558                                 // Force SSL redirection
 559                                 if ($this->baseURL->checkRedirectHttps()) {
 560                                         System::externalRedirect($this->baseURL->get() . '/' . $this->args->getQueryString());
 561                                 }
 562
 563                                 Core\Hook::callAll('init_1');
 564                         }
 565
 566                         // Exclude the backend processes from the session management
 567                         if ($this->mode->isBackend()) {
 568                                 Core\Worker::executeIfIdle();
 569                         }
 570
 571                         if ($this->mode->isNormal()) {
 572                                 $requester = HTTPSignature::getSigner('', $_SERVER);
 573                                 if (!empty($requester)) {
 574                                         Profile::addVisitorCookieForHandle($requester);
 575                                 }
 576                         }
 577
 578                         // ZRL
 579                         if (!empty($_GET['zrl']) && $this->mode->isNormal()) {
 580                                 if (!local_user()) {
 581                                         // Only continue when the given profile link seems valid
 582                                         // Valid profile links contain a path with "/profile/" and no query parameters
 583                                         if ((parse_url($_GET['zrl'], PHP_URL_QUERY) == "") &&
 584                                             strstr(parse_url($_GET['zrl'], PHP_URL_PATH), "/profile/")) {
 585                                                 if (Core\Session::get('visitor_home') != $_GET["zrl"]) {
 586                                                         Core\Session::set('my_url', $_GET['zrl']);
 587                                                         Core\Session::set('authenticated', 0);
 588                                                 }
 589
 590                                                 Model\Profile::zrlInit($this);
 591                                         } else {
 592                                                 // Someone came with an invalid parameter, maybe as a DDoS attempt
 593                                                 // We simply stop processing here
 594                                                 $this->logger->debug('Invalid ZRL parameter.', ['zrl' => $_GET['zrl']]);
 595                                                 throw new HTTPException\ForbiddenException();
 596                                         }
 597                                 }
 598                         }
 599
 600                         if (!empty($_GET['owt']) && $this->mode->isNormal()) {
 601                                 $token = $_GET['owt'];
 602                                 Model\Profile::openWebAuthInit($token);
 603                         }
 604
 605                         $auth->withSession($this);
 606
 607                         if (empty($_SESSION['authenticated'])) {
 608                                 header('X-Account-Management-Status: none');
 609                         }
 610
 611                         $_SESSION['sysmsg']       = Core\Session::get('sysmsg', []);
 612                         $_SESSION['sysmsg_info']  = Core\Session::get('sysmsg_info', []);
 613                         $_SESSION['last_updated'] = Core\Session::get('last_updated', []);
 614
 615                         /*
 616                          * check_config() is responsible for running update scripts. These automatically
 617                          * update the DB schema whenever we push a new one out. It also checks to see if
 618                          * any addons have been added or removed and reacts accordingly.
 619                          */
 620
 621                         // in install mode, any url loads install module
 622                         // but we need "view" module for stylesheet
 623                         if ($this->mode->isInstall() && $moduleName !== 'install') {
 624                                 $this->baseURL->redirect('install');
 625                         } elseif (!$this->mode->isInstall() && !$this->mode->has(App\Mode::MAINTENANCEDISABLED) && $moduleName !== 'maintenance') {
 626                                 $this->baseURL->redirect('maintenance');
 627                         } else {
 628                                 $this->checkURL();
 629                                 Core\Update::check($this->getBasePath(), false, $this->mode);
 630                                 Core\Addon::loadAddons();
 631                                 Core\Hook::loadHooks();
 632                         }
 633
 634                         // Compatibility with the Android Diaspora client
 635                         if ($moduleName == 'stream') {
 636                                 $this->baseURL->redirect('network?order=post');
 637                         }
 638
 639                         if ($moduleName == 'conversations') {
 640                                 $this->baseURL->redirect('message');
 641                         }
 642
 643                         if ($moduleName == 'commented') {
 644                                 $this->baseURL->redirect('network?order=comment');
 645                         }
 646
 647                         if ($moduleName == 'liked') {
 648                                 $this->baseURL->redirect('network?order=comment');
 649                         }
 650
 651                         if ($moduleName == 'activity') {
 652                                 $this->baseURL->redirect('network?conv=1');
 653                         }
 654
 655                         if (($moduleName == 'status_messages') && ($this->args->getCommand() == 'status_messages/new')) {
 656                                 $this->baseURL->redirect('bookmarklet');
 657                         }
 658
 659                         if (($moduleName == 'user') && ($this->args->getCommand() == 'user/edit')) {
 660                                 $this->baseURL->redirect('settings');
 661                         }
 662
 663                         if (($moduleName == 'tag_followings') && ($this->args->getCommand() == 'tag_followings/manage')) {
 664                                 $this->baseURL->redirect('search');
 665                         }
 666
 667                         // Initialize module that can set the current theme in the init() method, either directly or via App->profile_uid
 668                         $this->page['page_title'] = $moduleName;
 669
 670                         // determine the module class and save it to the module instance
 671                         // @todo there's an implicit dependency due SESSION::start(), so it has to be called here (yet)
 672                         $module = $module->determineClass($this->args, $router, $this->config);
 673
 674                         // Let the module run it's internal process (init, get, post, ...)
 675                         $module->run($this->l10n, $this->baseURL, $this->logger, $_SERVER, $_POST);
 676                 } catch (HTTPException $e) {
 677                         ModuleHTTPException::rawContent($e);
 678                 }
 679
 680                 $this->page->run($this, $this->baseURL, $this->mode, $module, $this->l10n, $this->config, $pconfig);
 681         }
 682
 683         /**
 684          * Automatically redirects to relative or absolute URL
 685          * Should only be used if it isn't clear if the URL is either internal or external
 686          *
 687          * @param string $toUrl The target URL
 688          *
 689          * @throws HTTPException\InternalServerErrorException
 690          */
 691         public function redirect($toUrl)
 692         {
 693                 if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
 694                         Core\System::externalRedirect($toUrl);
 695                 } else {
 696                         $this->baseURL->redirect($toUrl);
 697                 }
 698         }
 699 }