]> git.mxchange.org Git - friendica.git/blob - src/App.php
Cleanup namespace
[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\Process The process methods
122          */
123         private $process;
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          * Fetch the user id
159          * @return int 
160          */
161         public function getLoggedInUserId()
162         {
163                 return $this->user_id;
164         }
165
166         /**
167          * Fetch the user nick name
168          * @return string
169          */
170         public function getLoggedInUserNickname()
171         {
172                 return $this->nickname;
173         }
174
175         /**
176          * Set the profile owner ID
177          *
178          * @param int $owner_id
179          * @return void
180          */
181         public function setProfileOwner(int $owner_id)
182         {
183                 $this->profile_owner = $owner_id;
184         }
185
186         /**
187          * Get the profile owner ID
188          *
189          * @return int
190          */
191         public function getProfileOwner():int
192         {
193                 return $this->profile_owner;
194         }
195
196         /**
197          * Set the contact ID
198          *
199          * @param int $contact_id
200          * @return void
201          */
202         public function setContactId(int $contact_id)
203         {
204                 $this->contact_id = $contact_id;
205         }
206
207         /**
208          * Get the contact ID
209          *
210          * @return int
211          */
212         public function getContactId():int
213         {
214                 return $this->contact_id;
215         }
216
217         /**
218          * Set the timezone
219          *
220          * @param string $timezone A valid time zone identifier, see https://www.php.net/manual/en/timezones.php
221          * @return void
222          */
223         public function setTimeZone(string $timezone)
224         {
225                 $this->timezone = (new \DateTimeZone($timezone))->getName();
226                 DateTimeFormat::setLocalTimeZone($this->timezone);
227         }
228
229         /**
230          * Get the timezone
231          *
232          * @return int
233          */
234         public function getTimeZone():string
235         {
236                 return $this->timezone;
237         }
238
239         /**
240          * Set workerqueue information
241          *
242          * @param array $queue 
243          * @return void 
244          */
245         public function setQueue(array $queue)
246         {
247                 $this->queue = $queue;
248         }
249
250         /**
251          * Fetch workerqueue information
252          *
253          * @return array 
254          */
255         public function getQueue()
256         {
257                 return $this->queue ?? [];
258         }
259
260         /**
261          * Fetch a specific workerqueue field
262          *
263          * @param string $index 
264          * @return mixed 
265          */
266         public function getQueueValue(string $index)
267         {
268                 return $this->queue[$index] ?? null;
269         }
270
271         public function setThemeInfoValue(string $index, $value)
272         {
273                 $this->theme_info[$index] = $value;
274         }
275
276         public function getThemeInfo()
277         {
278                 return $this->theme_info;
279         }
280
281         public function getThemeInfoValue(string $index, $default = null)
282         {
283                 return $this->theme_info[$index] ?? $default;
284         }
285
286         /**
287          * Returns the current config cache of this node
288          *
289          * @return Cache
290          */
291         public function getConfigCache()
292         {
293                 return $this->config->getCache();
294         }
295
296         /**
297          * The basepath of this app
298          *
299          * @return string
300          */
301         public function getBasePath()
302         {
303                 // Don't use the basepath of the config table for basepath (it should always be the config-file one)
304                 return $this->config->getCache()->get('system', 'basepath');
305         }
306
307         /**
308          * @param Database                    $database The Friendica Database
309          * @param IManageConfigValues         $config   The Configuration
310          * @param App\Mode                    $mode     The mode of this Friendica app
311          * @param BaseURL                     $baseURL  The full base URL of this Friendica app
312          * @param LoggerInterface             $logger   The current app logger
313          * @param Profiler                    $profiler The profiler of this application
314          * @param L10n                        $l10n     The translator instance
315          * @param App\Arguments               $args     The Friendica Arguments of the call
316          * @param Core\Process                $process  The process methods
317          * @param IManagePersonalConfigValues $pConfig  Personal configuration
318          */
319         public function __construct(Database $database, IManageConfigValues $config, App\Mode $mode, BaseURL $baseURL, LoggerInterface $logger, Profiler $profiler, L10n $l10n, Arguments $args, Core\Process $process, IManagePersonalConfigValues $pConfig)
320         {
321                 $this->database = $database;
322                 $this->config   = $config;
323                 $this->mode     = $mode;
324                 $this->baseURL  = $baseURL;
325                 $this->profiler = $profiler;
326                 $this->logger   = $logger;
327                 $this->l10n     = $l10n;
328                 $this->args     = $args;
329                 $this->process  = $process;
330                 $this->pConfig  = $pConfig;
331
332                 $this->load();
333         }
334
335         /**
336          * Load the whole app instance
337          */
338         public function load()
339         {
340                 set_time_limit(0);
341
342                 // Ensure that all "strtotime" operations do run timezone independent
343                 date_default_timezone_set('UTC');
344
345                 // This has to be quite large to deal with embedded private photos
346                 ini_set('pcre.backtrack_limit', 500000);
347
348                 set_include_path(
349                         get_include_path() . PATH_SEPARATOR
350                         . $this->getBasePath() . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
351                         . $this->getBasePath() . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
352                         . $this->getBasePath());
353
354                 $this->profiler->reset();
355
356                 if ($this->mode->has(App\Mode::DBAVAILABLE)) {
357                         $this->profiler->update($this->config);
358
359                         Core\Hook::loadHooks();
360                         $loader = (new Config())->createConfigFileLoader($this->getBasePath(), $_SERVER);
361                         Core\Hook::callAll('load_config', $loader);
362                 }
363
364                 $this->loadDefaultTimezone();
365                 // Register template engines
366                 Core\Renderer::registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
367         }
368
369         /**
370          * Loads the default timezone
371          *
372          * Include support for legacy $default_timezone
373          *
374          * @global string $default_timezone
375          */
376         private function loadDefaultTimezone()
377         {
378                 if ($this->config->get('system', 'default_timezone')) {
379                         $timezone = $this->config->get('system', 'default_timezone', 'UTC');
380                 } else {
381                         global $default_timezone;
382                         $timezone = $default_timezone ?? '' ?: 'UTC';
383                 }
384
385                 $this->setTimeZone($timezone);
386         }
387
388         /**
389          * Returns the current theme name. May be overriden by the mobile theme name.
390          *
391          * @return string
392          * @throws Exception
393          */
394         public function getCurrentTheme()
395         {
396                 if ($this->mode->isInstall()) {
397                         return '';
398                 }
399
400                 // Specific mobile theme override
401                 if (($this->mode->isMobile() || $this->mode->isTablet()) && Core\Session::get('show-mobile', true)) {
402                         $user_mobile_theme = $this->getCurrentMobileTheme();
403
404                         // --- means same mobile theme as desktop
405                         if (!empty($user_mobile_theme) && $user_mobile_theme !== '---') {
406                                 return $user_mobile_theme;
407                         }
408                 }
409
410                 if (!$this->currentTheme) {
411                         $this->computeCurrentTheme();
412                 }
413
414                 return $this->currentTheme;
415         }
416
417         /**
418          * Returns the current mobile theme name.
419          *
420          * @return string
421          * @throws Exception
422          */
423         public function getCurrentMobileTheme()
424         {
425                 if ($this->mode->isInstall()) {
426                         return '';
427                 }
428
429                 if (is_null($this->currentMobileTheme)) {
430                         $this->computeCurrentMobileTheme();
431                 }
432
433                 return $this->currentMobileTheme;
434         }
435
436         public function setCurrentTheme($theme)
437         {
438                 $this->currentTheme = $theme;
439         }
440
441         public function setCurrentMobileTheme($theme)
442         {
443                 $this->currentMobileTheme = $theme;
444         }
445
446         /**
447          * Computes the current theme name based on the node settings, the page owner settings and the user settings
448          *
449          * @throws Exception
450          */
451         private function computeCurrentTheme()
452         {
453                 $system_theme = $this->config->get('system', 'theme');
454                 if (!$system_theme) {
455                         throw new Exception($this->l10n->t('No system theme config value set.'));
456                 }
457
458                 // Sane default
459                 $this->setCurrentTheme($system_theme);
460
461                 $page_theme = null;
462                 // Find the theme that belongs to the user whose stuff we are looking at
463                 if (!empty($this->profile_owner) && ($this->profile_owner != local_user())) {
464                         // Allow folks to override user themes and always use their own on their own site.
465                         // This works only if the user is on the same server
466                         $user = $this->database->selectFirst('user', ['theme'], ['uid' => $this->profile_owner]);
467                         if ($this->database->isResult($user) && !$this->pConfig->get(local_user(), 'system', 'always_my_theme')) {
468                                 $page_theme = $user['theme'];
469                         }
470                 }
471
472                 $theme_name = $page_theme ?: Core\Session::get('theme', $system_theme);
473
474                 $theme_name = Strings::sanitizeFilePathItem($theme_name);
475                 if ($theme_name
476                     && in_array($theme_name, Theme::getAllowedList())
477                     && (file_exists('view/theme/' . $theme_name . '/style.css')
478                         || file_exists('view/theme/' . $theme_name . '/style.php'))
479                 ) {
480                         $this->setCurrentTheme($theme_name);
481                 }
482         }
483
484         /**
485          * Computes the current mobile theme name based on the node settings, the page owner settings and the user settings
486          */
487         private function computeCurrentMobileTheme()
488         {
489                 $system_mobile_theme = $this->config->get('system', 'mobile-theme', '');
490
491                 // Sane default
492                 $this->setCurrentMobileTheme($system_mobile_theme);
493
494                 $page_mobile_theme = null;
495                 // Find the theme that belongs to the user whose stuff we are looking at
496                 if (!empty($this->profile_owner) && ($this->profile_owner != local_user())) {
497                         // Allow folks to override user themes and always use their own on their own site.
498                         // This works only if the user is on the same server
499                         if (!$this->pConfig->get(local_user(), 'system', 'always_my_theme')) {
500                                 $page_mobile_theme = $this->pConfig->get($this->profile_owner, 'system', 'mobile-theme');
501                         }
502                 }
503
504                 $mobile_theme_name = $page_mobile_theme ?: Core\Session::get('mobile-theme', $system_mobile_theme);
505
506                 $mobile_theme_name = Strings::sanitizeFilePathItem($mobile_theme_name);
507                 if ($mobile_theme_name == '---'
508                         ||
509                         in_array($mobile_theme_name, Theme::getAllowedList())
510                         && (file_exists('view/theme/' . $mobile_theme_name . '/style.css')
511                                 || file_exists('view/theme/' . $mobile_theme_name . '/style.php'))
512                 ) {
513                         $this->setCurrentMobileTheme($mobile_theme_name);
514                 }
515         }
516
517         /**
518          * Provide a sane default if nothing is chosen or the specified theme does not exist.
519          *
520          * @return string
521          * @throws Exception
522          */
523         public function getCurrentThemeStylesheetPath()
524         {
525                 return Core\Theme::getStylesheetPath($this->getCurrentTheme());
526         }
527
528         /**
529          * Sets the base url for use in cmdline programs which don't have
530          * $_SERVER variables
531          */
532         public function checkURL()
533         {
534                 $url = $this->config->get('system', 'url');
535
536                 // if the url isn't set or the stored url is radically different
537                 // than the currently visited url, store the current value accordingly.
538                 // "Radically different" ignores common variations such as http vs https
539                 // and www.example.com vs example.com.
540                 // We will only change the url to an ip address if there is no existing setting
541
542                 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()))) {
543                         $this->config->set('system', 'url', $this->baseURL->get());
544                 }
545         }
546
547         /**
548          * Frontend App script
549          *
550          * The App object behaves like a container and a dispatcher at the same time, including a representation of the
551          * request and a representation of the response.
552          *
553          * This probably should change to limit the size of this monster method.
554          *
555          * @param App\Module                  $module The determined module
556          * @param App\Router                  $router
557          * @param IManagePersonalConfigValues $pconfig
558          * @param Authentication              $auth The Authentication backend of the node
559          * @param App\Page                    $page The Friendica page printing container
560          *
561          * @throws HTTPException\InternalServerErrorException
562          * @throws \ImagickException
563          */
564         public function runFrontend(App\Module $module, App\Router $router, IManagePersonalConfigValues $pconfig, Authentication $auth, App\Page $page, float $start_time)
565         {
566                 $this->profiler->set($start_time, 'start');
567                 $this->profiler->set(microtime(true), 'classinit');
568
569                 $moduleName = $module->getName();
570
571                 try {
572                         // Missing DB connection: ERROR
573                         if ($this->mode->has(App\Mode::LOCALCONFIGPRESENT) && !$this->mode->has(App\Mode::DBAVAILABLE)) {
574                                 throw new HTTPException\InternalServerErrorException('Apologies but the website is unavailable at the moment.');
575                         }
576
577                         // Max Load Average reached: ERROR
578                         if ($this->process->isMaxProcessesReached() || $this->process->isMaxLoadReached()) {
579                                 header('Retry-After: 120');
580                                 header('Refresh: 120; url=' . $this->baseURL->get() . "/" . $this->args->getQueryString());
581
582                                 throw new HTTPException\ServiceUnavailableException('The node is currently overloaded. Please try again later.');
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 = new Module('maintenance', 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 = $module->determineClass($this->args, $router, $this->config);
704                         }
705
706                         // Let the module run it's internal process (init, get, post, ...)
707                         $module->run($this->l10n, $this->baseURL, $this->logger, $this->profiler, $_SERVER, $_POST);
708                 } catch (HTTPException $e) {
709                         ModuleHTTPException::rawContent($e);
710                 }
711
712                 $page->run($this, $this->baseURL, $this->mode, $module, $this->l10n, $this->profiler, $this->config, $pconfig);
713         }
714
715         /**
716          * Automatically redirects to relative or absolute URL
717          * Should only be used if it isn't clear if the URL is either internal or external
718          *
719          * @param string $toUrl The target URL
720          *
721          * @throws HTTPException\InternalServerErrorException
722          */
723         public function redirect($toUrl)
724         {
725                 if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
726                         Core\System::externalRedirect($toUrl);
727                 } else {
728                         $this->baseURL->redirect($toUrl);
729                 }
730         }
731 }