Fix client crash due to long output (#998)

fixes #966
Icinga · Mar 22, 2024 · 72c5675 · 72c5675
2 parents a034449 + 6e69867
commit 72c5675
Show file tree

Hide file tree

Showing 5 changed files with 46 additions and 12 deletions.
diff --git a/library/Icingadb/Util/PluginOutput.php b/library/Icingadb/Util/PluginOutput.php
@@ -64,6 +64,9 @@ class PluginOutput extends HtmlString
     /** @var bool Whether the output contains HTML */
     protected $isHtml;
 
+    /** @var int The maximum amount of characters to process */
+    protected $characterLimit = 1000;
+
     /** @var bool Whether output will be enriched */
     protected $enrichOutput = true;
 
@@ -93,6 +96,20 @@ public function isHtml(): bool
         return $this->isHtml;
     }
 
+    /**
+     * Set the maximum amount of characters to process
+     *
+     * @param int $limit
+     *
+     * @return $this
+     */
+    public function setCharacterLimit(int $limit): self
+    {
+        $this->characterLimit = $limit;
+
+        return $this;
+    }
+
     /**
      * Set whether the output should be enriched
      *
@@ -185,6 +202,10 @@ public function render()
             $output = $this->processHtml($output);
         }
 
+        if ($this->characterLimit) {
+            $output = substr($output, 0, $this->characterLimit);
+        }
+
         $this->renderedOutput = $output;
 
         return $output;

diff --git a/library/Icingadb/Widget/Detail/ObjectDetail.php b/library/Icingadb/Widget/Detail/ObjectDetail.php
@@ -423,7 +423,10 @@ protected function createPluginOutput(): array
         if (empty($this->object->state->output) && empty($this->object->state->long_output)) {
             $pluginOutput = new EmptyState(t('Output unavailable.'));
         } else {
-            $pluginOutput = new PluginOutputContainer(PluginOutput::fromObject($this->object));
+            $pluginOutput = new PluginOutputContainer(
+                PluginOutput::fromObject($this->object)
+                    ->setCharacterLimit(10000)
+            );
             CopyToClipboard::attachTo($pluginOutput);
         }
 

diff --git a/phpstan-baseline-7x.neon b/phpstan-baseline-7x.neon
@@ -125,6 +125,11 @@ parameters:
 			count: 1
 			path: library/Icingadb/Util/PerfData.php
 
+		-
+			message: "#^Method Icinga\\\\Module\\\\Icingadb\\\\Util\\\\PluginOutput\\:\\:render\\(\\) should return string but returns string\\|false\\|null\\.$#"
+			count: 1
+			path: library/Icingadb/Util/PluginOutput.php
+
 		-
 			message: "#^Parameter \\#1 \\$str of function trim expects string, string\\|null given\\.$#"
 			count: 1
@@ -135,6 +140,11 @@ parameters:
 			count: 1
 			path: library/Icingadb/Util/PluginOutput.php
 
+		-
+			message: "#^Property Icinga\\\\Module\\\\Icingadb\\\\Util\\\\PluginOutput\\:\\:\\$renderedOutput \\(string\\) does not accept string\\|false\\|null\\.$#"
+			count: 1
+			path: library/Icingadb/Util/PluginOutput.php
+
 		-
 			message: "#^Parameter \\#1 \\$str of function trim expects string, mixed given\\.$#"
 			count: 1

diff --git a/phpstan-baseline-8x.neon b/phpstan-baseline-8x.neon
@@ -125,11 +125,21 @@ parameters:
 			count: 1
 			path: library/Icingadb/Util/PerfData.php
 
+		-
+			message: "#^Method Icinga\\\\Module\\\\Icingadb\\\\Util\\\\PluginOutput\\:\\:render\\(\\) should return string but returns string\\|null\\.$#"
+			count: 1
+			path: library/Icingadb/Util/PluginOutput.php
+
 		-
 			message: "#^Parameter \\#1 \\$string of function trim expects string, string\\|null given\\.$#"
 			count: 1
 			path: library/Icingadb/Util/PluginOutput.php
 
+		-
+			message: "#^Property Icinga\\\\Module\\\\Icingadb\\\\Util\\\\PluginOutput\\:\\:\\$renderedOutput \\(string\\) does not accept string\\|null\\.$#"
+			count: 1
+			path: library/Icingadb/Util/PluginOutput.php
+
 		-
 			message: "#^Parameter \\#1 \\$string of function trim expects string, mixed given\\.$#"
 			count: 1

diff --git a/phpstan-baseline-standard.neon b/phpstan-baseline-standard.neon
@@ -5040,11 +5040,6 @@ parameters:
 			count: 1
 			path: library/Icingadb/Util/PluginOutput.php
 
-		-
-			message: "#^Method Icinga\\\\Module\\\\Icingadb\\\\Util\\\\PluginOutput\\:\\:render\\(\\) should return string but returns string\\|null\\.$#"
-			count: 1
-			path: library/Icingadb/Util/PluginOutput.php
-
 		-
 			message: "#^Parameter \\#1 \\$html of method Icinga\\\\Module\\\\Icingadb\\\\Util\\\\PluginOutput\\:\\:processHtml\\(\\) expects string, string\\|null given\\.$#"
 			count: 1
@@ -5067,19 +5062,14 @@ parameters:
 
 		-
 			message: "#^Parameter \\#1 \\$string of function substr expects string, string\\|null given\\.$#"
-			count: 2
+			count: 3
 			path: library/Icingadb/Util/PluginOutput.php
 
 		-
 			message: "#^Parameter \\#2 \\$subject of function preg_match expects string, string\\|null given\\.$#"
 			count: 1
 			path: library/Icingadb/Util/PluginOutput.php
 
-		-
-			message: "#^Property Icinga\\\\Module\\\\Icingadb\\\\Util\\\\PluginOutput\\:\\:\\$renderedOutput \\(string\\) does not accept string\\|null\\.$#"
-			count: 1
-			path: library/Icingadb/Util/PluginOutput.php
-
 		-
 			message: "#^Method Icinga\\\\Module\\\\Icingadb\\\\Web\\\\Control\\\\GridViewModeSwitcher\\:\\:getTitle\\(\\) should return string but returns string\\|null\\.$#"
 			count: 1