AP endpoints are now cached

[friendica.git] / src / App / Mode.php

diff --git a/src/App/Mode.php b/src/App/Mode.php
index 0a5f98e24f2617d03abc4cbc9ca52d2cb7b80d09..3e7b9f0d1679a0fa07a362c8393c785d0d1452e9 100644 (file)
--- a/src/App/Mode.php
+++ b/src/App/Mode.php
@@ -1,9 +1,28 @@
 <?php
+/**
+ * @copyright Copyright (C) 2010-2022, 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\App;
 
 use Detection\MobileDetect;
-use Friendica\Core\Config\Cache\ConfigCache;
+use Friendica\Core\Config\ValueObject\Cache;
 use Friendica\Database\Database;
 use Friendica\Util\BasePath;
 
@@ -19,12 +38,58 @@ class Mode
        const DBCONFIGAVAILABLE   = 4;
        const MAINTENANCEDISABLED = 8;
 
+       const UNDEFINED = 0;
+       const INDEX = 1;
+       const DAEMON = 2;
+       const WORKER = 3;
+
+       const BACKEND_CONTENT_TYPES = ['application/jrd+json', 'text/xml',
+               'application/rss+xml', 'application/atom+xml', 'application/activity+json'];
+
+       /**
+        * A list of modules, which are backend methods
+        *
+        * @var array
+        */
+       const BACKEND_MODULES = [
+               '_well_known',
+               'api',
+               'dfrn_notify',
+               'feed',
+               'fetch',
+               'followers',
+               'following',
+               'hcard',
+               'hostxrd',
+               'inbox',
+               'manifest',
+               'nodeinfo',
+               'noscrape',
+               'objects',
+               'outbox',
+               'poco',
+               'post',
+               'pubsub',
+               'pubsubhubbub',
+               'receive',
+               'rsd_xml',
+               'salmon',
+               'statistics_json',
+               'xrd',
+       ];
+
        /***
         * @var int The mode of this Application
         *
         */
        private $mode;
 
+       /***
+        * @var int Who executes this Application
+        *
+        */
+       private $executor = self::UNDEFINED;
+
        /**
         * @var bool True, if the call is a backend call
         */
@@ -65,7 +130,7 @@ class Mode
         *
         * @throws \Exception
         */
-       public function determine(BasePath $basepath, Database $database, ConfigCache $configCache)
+       public function determine(BasePath $basepath, Database $database, Cache $configCache)
        {
                $mode = 0;
 
@@ -106,17 +171,22 @@ class Mode
        /**
         * Checks if the site is called via a backend process
         *
-        * @param bool         $isBackend    True, if the call is from a backend script (daemon, worker, ...)
-        * @param Module       $module       The pre-loaded module (just name, not class!)
-        * @param array        $server       The $_SERVER variable
-        * @param MobileDetect $mobileDetect The mobile detection library
+        * @param bool             $isBackend    True, if the call is from a backend script (daemon, worker, ...)
+        * @param array            $server       The $_SERVER variable
+        * @param Arguments        $args         The Friendica App arguments
+        * @param MobileDetect     $mobileDetect The mobile detection library
         *
         * @return Mode returns the determined mode
         */
-       public function determineRunMode(bool $isBackend, Module $module, array $server, MobileDetect $mobileDetect)
+       public function determineRunMode(bool $isBackend, array $server, Arguments $args, MobileDetect $mobileDetect)
        {
-               $isBackend = $isBackend ||
-                            $module->isBackend();
+               foreach (self::BACKEND_CONTENT_TYPES as $type) {
+                       if (strpos(strtolower($server['HTTP_ACCEPT'] ?? ''), $type) !== false) {
+                               $isBackend = true;
+                       }
+               }
+
+               $isBackend = $isBackend || in_array($args->getModuleName(), static::BACKEND_MODULES);
                $isMobile  = $mobileDetect->isMobile();
                $isTablet  = $mobileDetect->isTablet();
                $isAjax    = strtolower($server['HTTP_X_REQUESTED_WITH'] ?? '') == 'xmlhttprequest';
@@ -136,6 +206,31 @@ class Mode
                return ($this->mode & $mode) > 0;
        }
 
+       /**
+        * Set the execution mode
+        *
+        * @param integer $executor Execution Mode
+        * @return void
+        */
+       public function setExecutor(int $executor)
+       {
+               $this->executor = $executor;
+
+               // Daemon and worker are always backend
+               if (in_array($executor, [self::DAEMON, self::WORKER])) {
+                       $this->isBackend = true;
+               }
+       }
+
+       /*isBackend = true;*
+        * get the execution mode
+        *
+        * @return int Execution Mode
+        */
+       public function getExecutor()
+       {
+               return $this->executor;
+       }
 
        /**
         * Install mode is when the local config file is missing or the DB schema hasn't been installed yet.