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