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