From fd429b5169a1f00df1525cf7ae3aa6948a16ff4f Mon Sep 17 00:00:00 2001
From: Robin Wieschendorf <mail@robinwieschendorf.de>
Date: Thu, 22 Jun 2023 18:37:49 +0200
Subject: [PATCH 1/2] feat: load description von ./docs/description.md and use
 moduleinfo.json description as fallback

---
 src/Classes/IndexController.php   |  4 ++++
 src/Classes/LazyLoader.php        |  6 ++++++
 src/Classes/Module.php            | 13 +++++++++++++
 src/Templates/ModuleInfo.tmpl.php | 19 ++++++++++---------
 4 files changed, 33 insertions(+), 9 deletions(-)

diff --git a/src/Classes/IndexController.php b/src/Classes/IndexController.php
index 3a9016af..59a04f0d 100644
--- a/src/Classes/IndexController.php
+++ b/src/Classes/IndexController.php
@@ -308,6 +308,8 @@ public function invokeLazyModuleInfo()
         $moduleLoader = ModuleLoader::create(Config::getDependenyMode());
         $module = $moduleLoader->loadByArchiveNameAndVersion($archiveName, $version);
 
+        $description = $module->getDescriptionMd() !== '' ? $module->getDescriptionMd() : $module->getDescription();
+
         if ($data == 'installationMd') {
             return ['content' => $module->getInstallationMd()];
         } elseif ($data == 'usageMd') {
@@ -316,6 +318,8 @@ public function invokeLazyModuleInfo()
             return ['content' => $module->getChangeLogMd()];
         } elseif ($data == 'readmeMd') {
             return ['content' => $module->getReadmeMd()];
+        } elseif ($data == 'descriptionMd') {
+            return ['content' => $description];
         }
     }
 
diff --git a/src/Classes/LazyLoader.php b/src/Classes/LazyLoader.php
index 04b449cb..388607de 100644
--- a/src/Classes/LazyLoader.php
+++ b/src/Classes/LazyLoader.php
@@ -46,6 +46,12 @@ public static function loadModuleReadme($module, $target, $default = '')
         return self::createScript($target, $url, $default);
     }
 
+    public static function loadModuleDescription($module, $target, $default = '')
+    {
+        $url = self::createUrl($module, 'descriptionMd');
+        return self::createScript($target, $url, $default);
+    }
+
     public static function loadModuleInstallation($module, $target, $default = '')
     {
         $url = self::createUrl($module, 'installationMd');
diff --git a/src/Classes/Module.php b/src/Classes/Module.php
index 90793205..034fee3e 100644
--- a/src/Classes/Module.php
+++ b/src/Classes/Module.php
@@ -415,6 +415,19 @@ public function getReadmeMd(): string
         return FileHelper::readMarkdown($path);
     }
 
+    /**
+     * Liefert die description.md als HTML.
+     */
+    public function getDescriptionMd(): string
+    {
+        $docFilePath = $this->getDocFilePath('description.md');
+        if (!$docFilePath) {
+            return '';
+        }
+        $path = $this->getUrlOrLocalRootPath() . $docFilePath;
+        return FileHelper::readMarkdown($path);
+    }
+
     /**
      * Liefert den absoluten Pfad zur modulehash.json
      *
diff --git a/src/Templates/ModuleInfo.tmpl.php b/src/Templates/ModuleInfo.tmpl.php
index 733fdc34..37c9f40e 100644
--- a/src/Templates/ModuleInfo.tmpl.php
+++ b/src/Templates/ModuleInfo.tmpl.php
@@ -1,5 +1,9 @@
 <?php
 
+/**
+ * @phpcs:disable Generic.Files.LineLength.TooLong
+ */
+
 defined('LOADED_FROM_INDEX') && LOADED_FROM_INDEX ?? die('Access denied.');
 
 use RobinTheHood\ModifiedModuleLoaderClient\LazyLoader;
@@ -209,14 +213,10 @@
                             </div>
 
                             <h2>Beschreibung</h2>
-                            <div class="markdown-body">
-                                <p>
-                                    <?php if ($module->getDescription()) { ?>
-                                        <?= $module->getDescription() ?>
-                                    <?php } else { ?>
-                                        Keine Beschreibung vorhanden.
-                                    <?php } ?>
-                                </p>
+                            <div id="description">
+                                <div class="markdown-body" style="padding-bottom: 30px">
+                                        Beschreibung wird geladen. Bitte warten...
+                                </div>
                             </div>
                         </div>
 
@@ -379,7 +379,7 @@
                                     <div class="markdown-body">
                                         README.md Wird geladen. Bitte warten...
                                     </div>
-                                 </div>
+                                </div>
                             </div>
                         </div>
 
@@ -403,6 +403,7 @@
             </div>
         </div>
 
+        <?= LazyLoader::loadModuleDescription($module, '#description .markdown-body', 'Es ist keine Beschreibung vorhanden.'); ?>
         <?= LazyLoader::loadModuleReadme($module, '#readme .markdown-body', 'Es ist keine README.md vorhanden.'); ?>
         <?= LazyLoader::loadModuleInstallation($module, '#v-pills-install .markdown-body', 'Es ist keine manuelle Installationanleitung vorhanden.'); ?>
         <?= LazyLoader::loadModuleUsage($module, '#v-pills-usage .markdown-body', 'Es ist keine Bedienungsanleitung vorhanden.'); ?>

From db7964e5bfba9705b50b47dfb208a0affb80f04b Mon Sep 17 00:00:00 2001
From: Robin Wieschendorf <mail@robinwieschendorf.de>
Date: Thu, 22 Jun 2023 18:44:13 +0200
Subject: [PATCH 2/2] fix: possible module null value

---
 psalm-baseline.xml              | 6 ------
 src/Classes/IndexController.php | 4 ++++
 2 files changed, 4 insertions(+), 6 deletions(-)

diff --git a/psalm-baseline.xml b/psalm-baseline.xml
index 4cbddfa9..3c5b1600 100644
--- a/psalm-baseline.xml
+++ b/psalm-baseline.xml
@@ -9,11 +9,5 @@
     <ForbiddenCode occurrences="1">
       <code>shell_exec($command)</code>
     </ForbiddenCode>
-    <PossiblyNullReference occurrences="4">
-      <code>getChangeLogMd</code>
-      <code>getInstallationMd</code>
-      <code>getReadmeMd</code>
-      <code>getUsageMd</code>
-    </PossiblyNullReference>
   </file>
 </files>
diff --git a/src/Classes/IndexController.php b/src/Classes/IndexController.php
index 59a04f0d..0cd9732b 100644
--- a/src/Classes/IndexController.php
+++ b/src/Classes/IndexController.php
@@ -308,6 +308,10 @@ public function invokeLazyModuleInfo()
         $moduleLoader = ModuleLoader::create(Config::getDependenyMode());
         $module = $moduleLoader->loadByArchiveNameAndVersion($archiveName, $version);
 
+        if (!$module) {
+            return ['content' => ''];
+        }
+
         $description = $module->getDescriptionMd() !== '' ? $module->getDescriptionMd() : $module->getDescription();
 
         if ($data == 'installationMd') {