src/App.php

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