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