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