]> git.mxchange.org Git - friendica.git/blobdiff - src/App.php
Merge pull request #10813 from tobiasd/20211003-lengthcounter
[friendica.git] / src / App.php
index 7f22cfd91d7e42481eef44dabaa9409762bfbc5f..7c7496c3baf138a0b47d66b9241d2653d39354eb 100644 (file)
@@ -1,20 +1,41 @@
 <?php
 /**
- * @file src/App.php
+ * @copyright Copyright (C) 2010-2021, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
  */
+
 namespace Friendica;
 
 use Exception;
 use Friendica\App\Arguments;
 use Friendica\App\BaseURL;
-use Friendica\App\Authentication;
-use Friendica\Core\Config\Cache\ConfigCache;
-use Friendica\Core\Config\IConfiguration;
-use Friendica\Core\Config\IPConfiguration;
-use Friendica\Core\L10n\L10n;
+use Friendica\App\Module;
+use Friendica\Factory\ConfigFactory;
+use Friendica\Module\Maintenance;
+use Friendica\Security\Authentication;
+use Friendica\Core\Config\Cache;
+use Friendica\Core\Config\IConfig;
+use Friendica\Core\PConfig\IPConfig;
+use Friendica\Core\L10n;
 use Friendica\Core\System;
 use Friendica\Core\Theme;
 use Friendica\Database\Database;
+use Friendica\Model\Contact;
 use Friendica\Model\Profile;
 use Friendica\Module\Special\HTTPException as ModuleHTTPException;
 use Friendica\Network\HTTPException;
@@ -25,10 +46,7 @@ use Friendica\Util\Strings;
 use Psr\Log\LoggerInterface;
 
 /**
- *
- * class: App
- *
- * @brief Our main application structure for the life of this page.
+ * Our main application structure for the life of this page.
  *
  * Primarily deals with the URL that got us here
  * and tries to make some sense of it, and
@@ -39,33 +57,20 @@ use Psr\Log\LoggerInterface;
  */
 class App
 {
-       public $profile;
-       public $profile_uid;
-       public $user;
-       public $cid;
-       public $contact;
-       public $contacts;
-       public $page_contact;
-       public $content;
-       public $data = [];
-       /** @deprecated 2019.09 - use App\Arguments->getArgv() or Arguments->get() */
-       public $argv;
-       /** @deprecated 2019.09 - use App\Arguments->getArgc() */
-       public $argc;
-       public $timezone;
-       public $interactive = true;
-       public $identities;
-       public $theme_info = [];
-       public $category;
        // Allow themes to control internal parameters
        // by changing App values in theme.php
-
-       public $sourcename              = '';
-       public $videowidth              = 425;
-       public $videoheight             = 350;
-       public $force_max_items         = 0;
-       public $theme_events_in_profile = true;
-       public $queue;
+       private $theme_info = [
+               'videowidth'        => 425,
+               'videoheight'       => 350,
+               'events_in_profile' => true
+       ];
+
+       private $user_id       = 0;
+       private $nickname      = '';
+       private $timezone      = '';
+       private $profile_owner = 0;
+       private $contact_id    = 0;
+       private $queue         = [];
 
        /**
         * @var App\Mode The Mode of the Application
@@ -83,7 +88,7 @@ class App
        private $currentMobileTheme;
 
        /**
-        * @var IConfiguration The config
+        * @var IConfig The config
         */
        private $config;
 
@@ -118,14 +123,169 @@ class App
        private $process;
 
        /**
-        * @var IPConfiguration
+        * @var IPConfig
         */
        private $pConfig;
 
+       /**
+        * Set the user ID
+        *
+        * @param int $user_id
+        * @return void
+        */
+       public function setLoggedInUserId(int $user_id)
+       {
+               $this->user_id = $user_id;
+       }
+
+       /**
+        * Set the nickname
+        *
+        * @param int $user_id
+        * @return void
+        */
+       public function setLoggedInUserNickname(string $nickname)
+       {
+               $this->nickname = $nickname;
+       }
+
+       public function isLoggedIn()
+       {
+               return local_user() && $this->user_id && ($this->user_id == local_user());
+       }
+
+       /**
+        * Fetch the user id
+        * @return int 
+        */
+       public function getLoggedInUserId()
+       {
+               return $this->user_id;
+       }
+
+       /**
+        * Fetch the user nick name
+        * @return string
+        */
+       public function getLoggedInUserNickname()
+       {
+               return $this->nickname;
+       }
+
+       /**
+        * Set the profile owner ID
+        *
+        * @param int $owner_id
+        * @return void
+        */
+       public function setProfileOwner(int $owner_id)
+       {
+               $this->profile_owner = $owner_id;
+       }
+
+       /**
+        * Get the profile owner ID
+        *
+        * @return int
+        */
+       public function getProfileOwner():int
+       {
+               return $this->profile_owner;
+       }
+
+       /**
+        * Set the contact ID
+        *
+        * @param int $contact_id
+        * @return void
+        */
+       public function setContactId(int $contact_id)
+       {
+               $this->contact_id = $contact_id;
+       }
+
+       /**
+        * Get the contact ID
+        *
+        * @return int
+        */
+       public function getContactId():int
+       {
+               return $this->contact_id;
+       }
+
+       /**
+        * Set the timezone
+        *
+        * @param int $timezone
+        * @return void
+        */
+       public function setTimeZone(string $timezone)
+       {
+               $this->timezone = $timezone;
+       }
+
+       /**
+        * Get the timezone
+        *
+        * @return int
+        */
+       public function getTimeZone():string
+       {
+               return $this->timezone;
+       }
+
+       /**
+        * Set workerqueue information
+        *
+        * @param array $queue 
+        * @return void 
+        */
+       public function setQueue(array $queue)
+       {
+               $this->queue = $queue;
+       }
+
+       /**
+        * Fetch workerqueue information
+        *
+        * @return array 
+        */
+       public function getQueue()
+       {
+               return $this->queue ?? [];
+       }
+
+       /**
+        * Fetch a specific workerqueue field
+        *
+        * @param string $index 
+        * @return mixed 
+        */
+       public function getQueueValue(string $index)
+       {
+               return $this->queue[$index] ?? null;
+       }
+
+       public function setThemeInfoValue(string $index, $value)
+       {
+               $this->theme_info[$index] = $value;
+       }
+
+       public function getThemeInfo()
+       {
+               return $this->theme_info;
+       }
+
+       public function getThemeInfoValue(string $index, $default = null)
+       {
+               return $this->theme_info[$index] ?? $default;
+       }
+
        /**
         * Returns the current config cache of this node
         *
-        * @return ConfigCache
+        * @return Cache
         */
        public function getConfigCache()
        {
@@ -145,7 +305,7 @@ class App
 
        /**
         * @param Database        $database The Friendica Database
-        * @param IConfiguration   $config   The Configuration
+        * @param IConfig         $config   The Configuration
         * @param App\Mode        $mode     The mode of this Friendica app
         * @param BaseURL         $baseURL  The full base URL of this Friendica app
         * @param LoggerInterface $logger   The current app logger
@@ -153,9 +313,9 @@ class App
         * @param L10n            $l10n     The translator instance
         * @param App\Arguments   $args     The Friendica Arguments of the call
         * @param Core\Process    $process  The process methods
-        * @param IPConfiguration $pConfig  Personal configuration
+        * @param IPConfig        $pConfig  Personal configuration
         */
-       public function __construct(Database $database, IConfiguration $config, App\Mode $mode, BaseURL $baseURL, LoggerInterface $logger, Profiler $profiler, L10n $l10n, Arguments $args, Core\Process $process, IPConfiguration $pConfig)
+       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)
        {
                $this->database = $database;
                $this->config   = $config;
@@ -168,9 +328,6 @@ class App
                $this->process  = $process;
                $this->pConfig  = $pConfig;
 
-               $this->argv         = $args->getArgv();
-               $this->argc         = $args->getArgc();
-
                $this->load();
        }
 
@@ -196,7 +353,7 @@ class App
                        $this->profiler->update($this->config);
 
                        Core\Hook::loadHooks();
-                       $loader = new ConfigFileLoader($this->getBasePath());
+                       $loader = (new ConfigFactory())->createConfigFileLoader($this->getBasePath(), $_SERVER);
                        Core\Hook::callAll('load_config', $loader);
                }
 
@@ -226,43 +383,6 @@ class App
                }
        }
 
-       /**
-        * Returns the current UserAgent as a String
-        *
-        * @return string the UserAgent as a String
-        * @throws HTTPException\InternalServerErrorException
-        */
-       public function getUserAgent()
-       {
-               return
-                       FRIENDICA_PLATFORM . " '" .
-                       FRIENDICA_CODENAME . "' " .
-                       FRIENDICA_VERSION . '-' .
-                       DB_UPDATE_VERSION . '; ' .
-                       $this->baseURL->get();
-       }
-
-       /**
-        * Generates the site's default sender email address
-        *
-        * @return string
-        * @throws HTTPException\InternalServerErrorException
-        */
-       public function getSenderEmailAddress()
-       {
-               $sender_email = $this->config->get('config', 'sender_email');
-               if (empty($sender_email)) {
-                       $hostname = $this->baseURL->getHostname();
-                       if (strpos($hostname, ':')) {
-                               $hostname = substr($hostname, 0, strpos($hostname, ':'));
-                       }
-
-                       $sender_email = 'noreply@' . $hostname;
-               }
-
-               return $sender_email;
-       }
-
        /**
         * Returns the current theme name. May be overriden by the mobile theme name.
         *
@@ -338,10 +458,10 @@ class App
 
                $page_theme = null;
                // Find the theme that belongs to the user whose stuff we are looking at
-               if ($this->profile_uid && ($this->profile_uid != local_user())) {
+               if (!empty($this->profile_owner) && ($this->profile_owner != local_user())) {
                        // Allow folks to override user themes and always use their own on their own site.
                        // This works only if the user is on the same server
-                       $user = $this->database->selectFirst('user', ['theme'], ['uid' => $this->profile_uid]);
+                       $user = $this->database->selectFirst('user', ['theme'], ['uid' => $this->profile_owner]);
                        if ($this->database->isResult($user) && !$this->pConfig->get(local_user(), 'system', 'always_my_theme')) {
                                $page_theme = $user['theme'];
                        }
@@ -371,11 +491,11 @@ class App
 
                $page_mobile_theme = null;
                // Find the theme that belongs to the user whose stuff we are looking at
-               if ($this->profile_uid && ($this->profile_uid != local_user())) {
+               if (!empty($this->profile_owner) && ($this->profile_owner != local_user())) {
                        // Allow folks to override user themes and always use their own on their own site.
                        // This works only if the user is on the same server
                        if (!$this->pConfig->get(local_user(), 'system', 'always_my_theme')) {
-                               $page_mobile_theme = $this->pConfig->get($this->profile_uid, 'system', 'mobile-theme');
+                               $page_mobile_theme = $this->pConfig->get($this->profile_owner, 'system', 'mobile-theme');
                        }
                }
 
@@ -393,8 +513,6 @@ class App
        }
 
        /**
-        * @brief Return full URL to theme which is currently in effect.
-        *
         * Provide a sane default if nothing is chosen or the specified theme does not exist.
         *
         * @return string
@@ -434,14 +552,18 @@ class App
         *
         * @param App\Module     $module The determined module
         * @param App\Router     $router
-        * @param IPConfiguration $pconfig
+        * @param IPConfig       $pconfig
         * @param Authentication $auth The Authentication backend of the node
-        * @param App\Page $page The Friendica page printing container
+        * @param App\Page       $page The Friendica page printing container
+        *
         * @throws HTTPException\InternalServerErrorException
         * @throws \ImagickException
         */
-       public function runFrontend(App\Module $module, App\Router $router, IPConfiguration $pconfig, Authentication $auth, App\Page $page)
+       public function runFrontend(App\Module $module, App\Router $router, IPConfig $pconfig, Authentication $auth, App\Page $page, float $start_time)
        {
+               $this->profiler->set($start_time, 'start');
+               $this->profiler->set(microtime(true), 'classinit');
+
                $moduleName = $module->getName();
 
                try {
@@ -467,12 +589,7 @@ class App
                                Core\Hook::callAll('init_1');
                        }
 
-                       // Exclude the backend processes from the session management
-                       if ($this->mode->isBackend()) {
-                               Core\Worker::executeIfIdle();
-                       }
-
-                       if ($this->mode->isNormal()) {
+                       if ($this->mode->isNormal() && !$this->mode->isBackend()) {
                                $requester = HTTPSignature::getSigner('', $_SERVER);
                                if (!empty($requester)) {
                                        Profile::addVisitorCookieForHandle($requester);
@@ -480,7 +597,7 @@ class App
                        }
 
                        // ZRL
-                       if (!empty($_GET['zrl']) && $this->mode->isNormal()) {
+                       if (!empty($_GET['zrl']) && $this->mode->isNormal() && !$this->mode->isBackend()) {
                                if (!local_user()) {
                                        // Only continue when the given profile link seems valid
                                        // Valid profile links contain a path with "/profile/" and no query parameters
@@ -489,6 +606,11 @@ class App
                                                if (Core\Session::get('visitor_home') != $_GET["zrl"]) {
                                                        Core\Session::set('my_url', $_GET['zrl']);
                                                        Core\Session::set('authenticated', 0);
+
+                                                       $remote_contact = Contact::getByURL($_GET['zrl'], false, ['subscribe']);
+                                                       if (!empty($remote_contact['subscribe'])) {
+                                                               $_SESSION['remote_comment'] = $remote_contact['subscribe'];
+                                                       }
                                                }
 
                                                Model\Profile::zrlInit($this);
@@ -526,8 +648,6 @@ class App
                        // but we need "view" module for stylesheet
                        if ($this->mode->isInstall() && $moduleName !== 'install') {
                                $this->baseURL->redirect('install');
-                       } elseif (!$this->mode->isInstall() && !$this->mode->has(App\Mode::MAINTENANCEDISABLED) && $moduleName !== 'maintenance') {
-                               $this->baseURL->redirect('maintenance');
                        } else {
                                $this->checkURL();
                                Core\Update::check($this->getBasePath(), false, $this->mode);
@@ -568,20 +688,24 @@ class App
                                $this->baseURL->redirect('search');
                        }
 
-                       // Initialize module that can set the current theme in the init() method, either directly or via App->profile_uid
+                       // Initialize module that can set the current theme in the init() method, either directly or via App->setProfileOwner
                        $page['page_title'] = $moduleName;
 
-                       // determine the module class and save it to the module instance
-                       // @todo there's an implicit dependency due SESSION::start(), so it has to be called here (yet)
-                       $module = $module->determineClass($this->args, $router, $this->config);
+                       if (!$this->mode->isInstall() && !$this->mode->has(App\Mode::MAINTENANCEDISABLED)) {
+                               $module = new Module('maintenance', Maintenance::class);
+                       } else {
+                               // determine the module class and save it to the module instance
+                               // @todo there's an implicit dependency due SESSION::start(), so it has to be called here (yet)
+                               $module = $module->determineClass($this->args, $router, $this->config);
+                       }
 
                        // Let the module run it's internal process (init, get, post, ...)
-                       $module->run($this->l10n, $this->baseURL, $this->logger, $_SERVER, $_POST);
+                       $module->run($this->l10n, $this->baseURL, $this->logger, $this->profiler, $_SERVER, $_POST);
                } catch (HTTPException $e) {
                        ModuleHTTPException::rawContent($e);
                }
 
-               $page->run($this, $this->baseURL, $this->mode, $module, $this->l10n, $this->config, $pconfig);
+               $page->run($this, $this->baseURL, $this->mode, $module, $this->l10n, $this->profiler, $this->config, $pconfig);
        }
 
        /**