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