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