src/App.php

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