src/App.php

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