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