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