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\Authentication;
  11 use Friendica\Core\Config\Cache;
  12 use Friendica\Core\Config\IConfig;
  13 use Friendica\Core\PConfig\IPConfig;
  14 use Friendica\Core\L10n;
  15 use Friendica\Core\System;
  16 use Friendica\Core\Theme;
  17 use Friendica\Database\Database;
  18 use Friendica\Model\Profile;
  19 use Friendica\Module\Special\HTTPException as ModuleHTTPException;
  20 use Friendica\Network\HTTPException;
  21 use Friendica\Util\ConfigFileLoader;
  22 use Friendica\Util\HTTPSignature;
  23 use Friendica\Util\Profiler;
  24 use Friendica\Util\Strings;
  25 use Psr\Log\LoggerInterface;
  26
  27 /**
  28  *
  29  * class: App
  30  *
  31  * Our main application structure for the life of this page.
  32  *
  33  * Primarily deals with the URL that got us here
  34  * and tries to make some sense of it, and
  35  * stores our page contents and config storage
  36  * and anything else that might need to be passed around
  37  * before we spit the page out.
  38  *
  39  */
  40 class App
  41 {
  42         public $profile;
  43         public $profile_uid;
  44         public $user;
  45         public $cid;
  46         public $contact;
  47         public $contacts;
  48         public $page_contact;
  49         public $content;
  50         public $data = [];
  51         /** @deprecated 2019.09 - use App\Arguments->getArgv() or Arguments->get() */
  52         public $argv;
  53         /** @deprecated 2019.09 - use App\Arguments->getArgc() */
  54         public $argc;
  55         public $timezone;
  56         public $interactive = true;
  57         public $identities;
  58         public $theme_info = [];
  59         public $category;
  60         // Allow themes to control internal parameters
  61         // by changing App values in theme.php
  62
  63         public $sourcename              = '';
  64         public $videowidth              = 425;
  65         public $videoheight             = 350;
  66         public $force_max_items         = 0;
  67         public $theme_events_in_profile = true;
  68         public $queue;
  69
  70         /**
  71          * @var App\Mode The Mode of the Application
  72          */
  73         private $mode;
  74
  75         /**
  76          * @var BaseURL
  77          */
  78         private $baseURL;
  79
  80         /** @var string The name of the current theme */
  81         private $currentTheme;
  82         /** @var string The name of the current mobile theme */
  83         private $currentMobileTheme;
  84
  85         /**
  86          * @var IConfig The config
  87          */
  88         private $config;
  89
  90         /**
  91          * @var LoggerInterface The logger
  92          */
  93         private $logger;
  94
  95         /**
  96          * @var Profiler The profiler of this app
  97          */
  98         private $profiler;
  99
 100         /**
 101          * @var Database The Friendica database connection
 102          */
 103         private $database;
 104
 105         /**
 106          * @var L10n The translator
 107          */
 108         private $l10n;
 109
 110         /**
 111          * @var App\Arguments
 112          */
 113         private $args;
 114
 115         /**
 116          * @var Core\Process The process methods
 117          */
 118         private $process;
 119
 120         /**
 121          * @var IPConfig
 122          */
 123         private $pConfig;
 124
 125         /**
 126          * Returns the current config cache of this node
 127          *
 128          * @return Cache
 129          */
 130         public function getConfigCache()
 131         {
 132                 return $this->config->getCache();
 133         }
 134
 135         /**
 136          * The basepath of this app
 137          *
 138          * @return string
 139          */
 140         public function getBasePath()
 141         {
 142                 // Don't use the basepath of the config table for basepath (it should always be the config-file one)
 143                 return $this->config->getCache()->get('system', 'basepath');
 144         }
 145
 146         /**
 147          * @param Database        $database The Friendica Database
 148          * @param IConfig         $config   The Configuration
 149          * @param App\Mode        $mode     The mode of this Friendica app
 150          * @param BaseURL         $baseURL  The full base URL of this Friendica app
 151          * @param LoggerInterface $logger   The current app logger
 152          * @param Profiler        $profiler The profiler of this application
 153          * @param L10n            $l10n     The translator instance
 154          * @param App\Arguments   $args     The Friendica Arguments of the call
 155          * @param Core\Process    $process  The process methods
 156          * @param IPConfig        $pConfig  Personal configuration
 157          */
 158         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)
 159         {
 160                 $this->database = $database;
 161                 $this->config   = $config;
 162                 $this->mode     = $mode;
 163                 $this->baseURL  = $baseURL;
 164                 $this->profiler = $profiler;
 165                 $this->logger   = $logger;
 166                 $this->l10n     = $l10n;
 167                 $this->args     = $args;
 168                 $this->process  = $process;
 169                 $this->pConfig  = $pConfig;
 170
 171                 $this->argv         = $args->getArgv();
 172                 $this->argc         = $args->getArgc();
 173
 174                 $this->load();
 175         }
 176
 177         /**
 178          * Load the whole app instance
 179          */
 180         public function load()
 181         {
 182                 set_time_limit(0);
 183
 184                 // This has to be quite large to deal with embedded private photos
 185                 ini_set('pcre.backtrack_limit', 500000);
 186
 187                 set_include_path(
 188                         get_include_path() . PATH_SEPARATOR
 189                         . $this->getBasePath() . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
 190                         . $this->getBasePath() . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
 191                         . $this->getBasePath());
 192
 193                 $this->profiler->reset();
 194
 195                 if ($this->mode->has(App\Mode::DBAVAILABLE)) {
 196                         $this->profiler->update($this->config);
 197
 198                         Core\Hook::loadHooks();
 199                         $loader = new ConfigFileLoader($this->getBasePath());
 200                         Core\Hook::callAll('load_config', $loader);
 201                 }
 202
 203                 $this->loadDefaultTimezone();
 204                 // Register template engines
 205                 Core\Renderer::registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
 206         }
 207
 208         /**
 209          * Loads the default timezone
 210          *
 211          * Include support for legacy $default_timezone
 212          *
 213          * @global string $default_timezone
 214          */
 215         private function loadDefaultTimezone()
 216         {
 217                 if ($this->config->get('system', 'default_timezone')) {
 218                         $this->timezone = $this->config->get('system', 'default_timezone');
 219                 } else {
 220                         global $default_timezone;
 221                         $this->timezone = !empty($default_timezone) ? $default_timezone : 'UTC';
 222                 }
 223
 224                 if ($this->timezone) {
 225                         date_default_timezone_set($this->timezone);
 226                 }
 227         }
 228
 229         /**
 230          * Returns the current UserAgent as a String
 231          *
 232          * @return string the UserAgent as a String
 233          * @throws HTTPException\InternalServerErrorException
 234          */
 235         public function getUserAgent()
 236         {
 237                 return
 238                         FRIENDICA_PLATFORM . " '" .
 239                         FRIENDICA_CODENAME . "' " .
 240                         FRIENDICA_VERSION . '-' .
 241                         DB_UPDATE_VERSION . '; ' .
 242                         $this->baseURL->get();
 243         }
 244
 245         /**
 246          * Returns the current theme name. May be overriden by the mobile theme name.
 247          *
 248          * @return string
 249          * @throws Exception
 250          */
 251         public function getCurrentTheme()
 252         {
 253                 if ($this->mode->isInstall()) {
 254                         return '';
 255                 }
 256
 257                 // Specific mobile theme override
 258                 if (($this->mode->isMobile() || $this->mode->isTablet()) && Core\Session::get('show-mobile', true)) {
 259                         $user_mobile_theme = $this->getCurrentMobileTheme();
 260
 261                         // --- means same mobile theme as desktop
 262                         if (!empty($user_mobile_theme) && $user_mobile_theme !== '---') {
 263                                 return $user_mobile_theme;
 264                         }
 265                 }
 266
 267                 if (!$this->currentTheme) {
 268                         $this->computeCurrentTheme();
 269                 }
 270
 271                 return $this->currentTheme;
 272         }
 273
 274         /**
 275          * Returns the current mobile theme name.
 276          *
 277          * @return string
 278          * @throws Exception
 279          */
 280         public function getCurrentMobileTheme()
 281         {
 282                 if ($this->mode->isInstall()) {
 283                         return '';
 284                 }
 285
 286                 if (is_null($this->currentMobileTheme)) {
 287                         $this->computeCurrentMobileTheme();
 288                 }
 289
 290                 return $this->currentMobileTheme;
 291         }
 292
 293         public function setCurrentTheme($theme)
 294         {
 295                 $this->currentTheme = $theme;
 296         }
 297
 298         public function setCurrentMobileTheme($theme)
 299         {
 300                 $this->currentMobileTheme = $theme;
 301         }
 302
 303         /**
 304          * Computes the current theme name based on the node settings, the page owner settings and the user settings
 305          *
 306          * @throws Exception
 307          */
 308         private function computeCurrentTheme()
 309         {
 310                 $system_theme = $this->config->get('system', 'theme');
 311                 if (!$system_theme) {
 312                         throw new Exception($this->l10n->t('No system theme config value set.'));
 313                 }
 314
 315                 // Sane default
 316                 $this->setCurrentTheme($system_theme);
 317
 318                 $page_theme = null;
 319                 // Find the theme that belongs to the user whose stuff we are looking at
 320                 if ($this->profile_uid && ($this->profile_uid != local_user())) {
 321                         // Allow folks to override user themes and always use their own on their own site.
 322                         // This works only if the user is on the same server
 323                         $user = $this->database->selectFirst('user', ['theme'], ['uid' => $this->profile_uid]);
 324                         if ($this->database->isResult($user) && !$this->pConfig->get(local_user(), 'system', 'always_my_theme')) {
 325                                 $page_theme = $user['theme'];
 326                         }
 327                 }
 328
 329                 $theme_name = $page_theme ?: Core\Session::get('theme', $system_theme);
 330
 331                 $theme_name = Strings::sanitizeFilePathItem($theme_name);
 332                 if ($theme_name
 333                     && in_array($theme_name, Theme::getAllowedList())
 334                     && (file_exists('view/theme/' . $theme_name . '/style.css')
 335                         || file_exists('view/theme/' . $theme_name . '/style.php'))
 336                 ) {
 337                         $this->setCurrentTheme($theme_name);
 338                 }
 339         }
 340
 341         /**
 342          * Computes the current mobile theme name based on the node settings, the page owner settings and the user settings
 343          */
 344         private function computeCurrentMobileTheme()
 345         {
 346                 $system_mobile_theme = $this->config->get('system', 'mobile-theme', '');
 347
 348                 // Sane default
 349                 $this->setCurrentMobileTheme($system_mobile_theme);
 350
 351                 $page_mobile_theme = null;
 352                 // Find the theme that belongs to the user whose stuff we are looking at
 353                 if ($this->profile_uid && ($this->profile_uid != local_user())) {
 354                         // Allow folks to override user themes and always use their own on their own site.
 355                         // This works only if the user is on the same server
 356                         if (!$this->pConfig->get(local_user(), 'system', 'always_my_theme')) {
 357                                 $page_mobile_theme = $this->pConfig->get($this->profile_uid, 'system', 'mobile-theme');
 358                         }
 359                 }
 360
 361                 $mobile_theme_name = $page_mobile_theme ?: Core\Session::get('mobile-theme', $system_mobile_theme);
 362
 363                 $mobile_theme_name = Strings::sanitizeFilePathItem($mobile_theme_name);
 364                 if ($mobile_theme_name == '---'
 365                         ||
 366                         in_array($mobile_theme_name, Theme::getAllowedList())
 367                         && (file_exists('view/theme/' . $mobile_theme_name . '/style.css')
 368                                 || file_exists('view/theme/' . $mobile_theme_name . '/style.php'))
 369                 ) {
 370                         $this->setCurrentMobileTheme($mobile_theme_name);
 371                 }
 372         }
 373
 374         /**
 375          * Provide a sane default if nothing is chosen or the specified theme does not exist.
 376          *
 377          * @return string
 378          * @throws Exception
 379          */
 380         public function getCurrentThemeStylesheetPath()
 381         {
 382                 return Core\Theme::getStylesheetPath($this->getCurrentTheme());
 383         }
 384
 385         /**
 386          * Sets the base url for use in cmdline programs which don't have
 387          * $_SERVER variables
 388          */
 389         public function checkURL()
 390         {
 391                 $url = $this->config->get('system', 'url');
 392
 393                 // if the url isn't set or the stored url is radically different
 394                 // than the currently visited url, store the current value accordingly.
 395                 // "Radically different" ignores common variations such as http vs https
 396                 // and www.example.com vs example.com.
 397                 // We will only change the url to an ip address if there is no existing setting
 398
 399                 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()))) {
 400                         $this->config->set('system', 'url', $this->baseURL->get());
 401                 }
 402         }
 403
 404         /**
 405          * Frontend App script
 406          *
 407          * The App object behaves like a container and a dispatcher at the same time, including a representation of the
 408          * request and a representation of the response.
 409          *
 410          * This probably should change to limit the size of this monster method.
 411          *
 412          * @param App\Module     $module The determined module
 413          * @param App\Router     $router
 414          * @param IPConfig       $pconfig
 415          * @param Authentication $auth The Authentication backend of the node
 416          * @param App\Page       $page The Friendica page printing container
 417          *
 418          * @throws HTTPException\InternalServerErrorException
 419          * @throws \ImagickException
 420          */
 421         public function runFrontend(App\Module $module, App\Router $router, IPConfig $pconfig, Authentication $auth, App\Page $page)
 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()) {
 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()) {
 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, $_SERVER, $_POST);
 558                 } catch (HTTPException $e) {
 559                         ModuleHTTPException::rawContent($e);
 560                 }
 561
 562                 $page->run($this, $this->baseURL, $this->mode, $module, $this->l10n, $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 }