src/App.php

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