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