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