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