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