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