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