More work on cache

components/HashedStaticCache.php

@@ -4,7 +4,7 @@
 
 namespace app\components;
 
-use app\models\backgroundJobs\IBackgroundJob;
+use app\models\backgroundJobs\{BuildStaticCache, IBackgroundJob};
 use app\models\settings\AntragsgruenApp;
 
 class HashedStaticCache
@@ -94,7 +94,7 @@ public function getCacheKey(): string
         return $this->cacheKey;
     }
 
-    public function getCached(callable $method, ?callable $cacheOutdatedDecorator = null): mixed
+    public function getCached(?callable $method, ?callable $cacheOutdatedDecorator = null): mixed
     {
         if (!$this->skipCache) {
             // Hint: don't even try to aquire a lock if a cache item already exists
@@ -110,16 +110,32 @@ public function getCached(callable $method, ?callable $cacheOutdatedDecorator =
             // Check if the cache item has been generated in the meantime
             $cached = $this->getCache();
             if ($cached !== false) {
+                // @TODO Check age - trigger rebuild async or rebuild synchronously if too old
                 ResourceLock::unlockCache($this);
                 return $this->returnDecoratedCache($cached, $cacheOutdatedDecorator);
             }
 
-            // @TODO call backgroundjob if set
+            if ($method) {
+                $result = $method();
+            } elseif ($this->rebuildBackgroundJob) {
+                $this->rebuildBackgroundJob->execute();
+
+                $result = $this->rebuildBackgroundJob->getResult();
+            } else {
+                throw new \Exception('Either a callback or a background job needs to be provided');
+            }
 
-            $result = $method();
             ResourceLock::unlockCache($this);
         } else {
-            $result = $method();
+            if ($method) {
+                $result = $method();
+            } elseif ($this->rebuildBackgroundJob) {
+                $this->rebuildBackgroundJob->execute();
+
+                $result = $this->rebuildBackgroundJob->getResult();
+            } else {
+                throw new \Exception('Either a callback or a background job needs to be provided');
+            }
         }
 
         if (!$this->skipCache) {

models/backgroundJobs/BuildStaticCache.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+namespace app\models\backgroundJobs;
+
+use app\components\mail\Base;
+use app\components\RequestContext;
+use app\models\db\Consultation;
+use app\models\db\EMailLog;
+use app\models\exceptions\MailNotSent;
+use app\models\settings\AntragsgruenApp;
+use app\views\consultation\LayoutHelper;
+use Symfony\Component\Mailer\Exception\TransportExceptionInterface;
+
+class BuildStaticCache extends IBackgroundJob
+{
+    public const TYPE_ID = 'BUILD_STATIC_CACHE';
+
+    public const CACHE_ID_CONSULTATION_HOME = 'CONSULTATION_HOME';
+
+    private ?string $result = null;
+
+    public function __construct(
+        public string $cacheId,
+        ?Consultation $consultation,
+        public bool $adminMode
+    ) {
+        $this->consultation = $consultation;
+    }
+
+    public function getTypeId(): string
+    {
+        return self::TYPE_ID;
+    }
+
+    public function execute(): void
+    {
+        $this->result = match ($this->cacheId) {
+            self::CACHE_ID_CONSULTATION_HOME => $this->getConsultationHome(),
+            default => null,
+        };
+    }
+
+    public function getResult(): ?string
+    {
+        return $this->result;
+    }
+
+    private function getConsultationHome(): string
+    {
+        return LayoutHelper::renderHomePageList($this->consultation, $this->adminMode);
+    }
+}

models/backgroundJobs/IBackgroundJob.php

@@ -25,6 +25,7 @@ public static function getAllBackgroundJobs(): array
     {
         return [
             SendNotification::TYPE_ID => SendNotification::class,
+            BuildStaticCache::TYPE_ID => BuildStaticCache::class,
         ];
     }
 

views/consultation/LayoutHelper.php

@@ -4,6 +4,7 @@
 
 namespace app\views\consultation;
 
+use app\models\backgroundJobs\BuildStaticCache;
 use app\components\{HashedStaticCache, HTMLTools, IMotionStatusFilter, MotionSorter, Tools, UrlHelper};
 use app\models\IMotionList;
 use app\models\settings\{AntragsgruenApp, Consultation as ConsultationSettings, Privileges};
@@ -26,14 +27,20 @@ private static function getHomePageCacheForType(Consultation $consultation, stri
             $cache->setSkipCache(true);
         }
 
-        if ($type === 'index_layout_agenda' && User::havePrivilege($consultation, Privileges::PRIVILEGE_CONTENT_EDIT, null)) {
+        $contentAdmin = User::havePrivilege($consultation, Privileges::PRIVILEGE_CONTENT_EDIT, null);
+
+        if ($type === 'index_layout_agenda' && $contentAdmin) {
             $cache->setSkipCache(true);
         }
         if (!in_array($type, ['index_layout_std', 'index_layout_tags', 'index_layout_agenda', 'index_layout_discussion_tags'])) {
             // Disable cache for plugin homepages, to prevent accidental over-caching
             $cache->setSkipCache(true);
         }
 
+        $cache->setRebuildBackgroundJob(
+            new BuildStaticCache(BuildStaticCache::CACHE_ID_CONSULTATION_HOME, $consultation, $contentAdmin)
+        );
+
         return $cache;
     }
 
@@ -54,6 +61,32 @@ public static function getHomePageCache(Consultation $consultation): HashedStati
         return self::getHomePageCacheForType($consultation, $consultation->getSettings()->getStartLayoutView());
     }
 
+    public static function renderHomePageList(Consultation $consultation, bool $contentAdmin): string
+    {
+        $output = '';
+        $resolutionMode = $consultation->getSettings()->startLayoutResolutions;
+        list($imotions, $resolutions) = MotionSorter::getIMotionsAndResolutions($consultation->motions);
+        if (count($resolutions) > 0 && $resolutionMode === ConsultationSettings::START_LAYOUT_RESOLUTIONS_ABOVE) {
+            $output .= \Yii::$app->controller->renderPartial('_index_resolutions', ['consultation' => $consultation, 'resolutions' => $resolutions]);
+        }
+
+        if (count($consultation->motionTypes) > 0 && $consultation->getSettings()->getStartLayoutView()) {
+            if ($resolutionMode === ConsultationSettings::START_LAYOUT_RESOLUTIONS_DEFAULT) {
+                $toShowImotions = $resolutions;
+            } else {
+                $toShowImotions = $imotions;
+            }
+            $output .= \Yii::$app->controller->renderPartial($consultation->getSettings()->getStartLayoutView(), [
+                'consultation' => $consultation,
+                'admin' => $contentAdmin,
+                'imotions' => $toShowImotions,
+                'isResolutionList' => ($resolutionMode === ConsultationSettings::START_LAYOUT_RESOLUTIONS_DEFAULT),
+                'skipTitle' => false,
+            ]);
+        }
+        return $output;
+    }
+
     public static function getTagMotionListCache(Consultation $consultation, ConsultationSettingsTag $tag, bool $isResolutionList): HashedStaticCache
     {
         $cache = HashedStaticCache::getInstance('tagMotionListCache', [

views/consultation/index.php

@@ -1,6 +1,7 @@
 <?php
 
 use app\models\db\{Amendment, AmendmentComment, AmendmentSupporter, Consultation, Motion, MotionComment, MotionSupporter, User};
+use app\models\backgroundJobs\BuildStaticCache;
 use app\components\{HashedStaticCache, MotionSorter, UrlHelper};
 use app\models\settings\{Privileges, Consultation as ConsultationSettings};
 use yii\helpers\Html;
@@ -147,31 +148,7 @@
     $cache->setSkipCache(true);
 }
 
-echo $cache->getCached(function () use ($consultation, $layout, $contentAdmin) {
-    $output = '';
-    $resolutionMode = $consultation->getSettings()->startLayoutResolutions;
-    list($imotions, $resolutions) = MotionSorter::getIMotionsAndResolutions($consultation->motions);
-    if (count($resolutions) > 0 && $resolutionMode === ConsultationSettings::START_LAYOUT_RESOLUTIONS_ABOVE) {
-        $output .= $this->render('_index_resolutions', ['consultation' => $consultation, 'resolutions' => $resolutions]);
-    }
-
-    if (count($consultation->motionTypes) > 0 && $consultation->getSettings()->getStartLayoutView()) {
-        if ($resolutionMode === ConsultationSettings::START_LAYOUT_RESOLUTIONS_DEFAULT) {
-            $toShowImotions = $resolutions;
-        } else {
-            $toShowImotions = $imotions;
-        }
-        $output .= $this->render($consultation->getSettings()->getStartLayoutView(), [
-            'consultation' => $consultation,
-            'layout' => $layout,
-            'admin' => $contentAdmin,
-            'imotions' => $toShowImotions,
-            'isResolutionList' => ($resolutionMode === ConsultationSettings::START_LAYOUT_RESOLUTIONS_DEFAULT),
-            'skipTitle' => false,
-        ]);
-    }
-    return $output;
-});
+echo $cache->getCached(null, null); // @TODO indicate age
 
 echo $this->render('_index_private_comment_list', [
     'myMotionComments' => $myMotionComments,

views/consultation/index_layout_tags.php

@@ -1,10 +1,9 @@
 <?php
 
 use app\models\sectionTypes\ISectionType;
-use app\views\consultation\LayoutHelper;
 use app\components\{MotionSorter, UrlHelper};
 use app\models\layoutHooks\Layout as LayoutHooks;
-use app\models\db\{Amendment, AmendmentComment, Consultation, ConsultationSettingsTag, IMotion, ISupporter, Motion, MotionComment, User};
+use app\models\db\{Amendment, Consultation, ConsultationSettingsTag, IMotion, ISupporter, Motion};
 use yii\helpers\Html;
 
 /**