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