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