summaryrefslogtreecommitdiffstats
path: root/library/Icingadb/Data
diff options
context:
space:
mode:
Diffstat (limited to 'library/Icingadb/Data')
-rw-r--r--library/Icingadb/Data/CsvResultSet.php79
-rw-r--r--library/Icingadb/Data/CsvResultSetUtils.php106
-rw-r--r--library/Icingadb/Data/JsonResultSet.php74
-rw-r--r--library/Icingadb/Data/JsonResultSetUtils.php132
-rw-r--r--library/Icingadb/Data/VolatileCsvResults.php15
-rw-r--r--library/Icingadb/Data/VolatileJsonResults.php15
6 files changed, 274 insertions, 147 deletions
diff --git a/library/Icingadb/Data/CsvResultSet.php b/library/Icingadb/Data/CsvResultSet.php
index 746a7e4..d65364e 100644
--- a/library/Icingadb/Data/CsvResultSet.php
+++ b/library/Icingadb/Data/CsvResultSet.php
@@ -4,82 +4,9 @@
namespace Icinga\Module\Icingadb\Data;
-use DateTime;
-use DateTimeZone;
-use Icinga\Module\Icingadb\Redis\VolatileStateResults;
-use ipl\Orm\Model;
-use ipl\Orm\Query;
+use ipl\Orm\ResultSet;
-class CsvResultSet extends VolatileStateResults
+class CsvResultSet extends ResultSet
{
- protected $isCacheDisabled = true;
-
- /**
- * @return array<string, ?string>
- */
- public function current(): array
- {
- return $this->extractKeysAndValues(parent::current());
- }
-
- protected function formatValue(string $key, $value): ?string
- {
- if (
- $value
- && (
- $key === 'id'
- || substr($key, -3) === '_id'
- || substr($key, -3) === '.id'
- || substr($key, -9) === '_checksum'
- || substr($key, -4) === '_bin'
- )
- ) {
- $value = bin2hex($value);
- }
-
- if (is_bool($value)) {
- return $value ? 'true' : 'false';
- } elseif (is_string($value)) {
- return '"' . str_replace('"', '""', $value) . '"';
- } elseif (is_array($value)) {
- return '"' . implode(',', $value) . '"';
- } elseif ($value instanceof DateTime) {
- return $value->setTimezone(new DateTimeZone('UTC'))
- ->format('Y-m-d\TH:i:s.vP');
- } else {
- return $value;
- }
- }
-
- protected function extractKeysAndValues(Model $model, string $path = ''): array
- {
- $keysAndValues = [];
- foreach ($model as $key => $value) {
- $keyPath = ($path ? $path . '.' : '') . $key;
- if ($value instanceof Model) {
- $keysAndValues += $this->extractKeysAndValues($value, $keyPath);
- } else {
- $keysAndValues[$keyPath] = $this->formatValue($key, $value);
- }
- }
-
- return $keysAndValues;
- }
-
- public static function stream(Query $query): void
- {
- $query->setResultSetClass(__CLASS__);
-
- foreach ($query as $i => $keysAndValues) {
- if ($i === 0) {
- echo implode(',', array_keys($keysAndValues));
- }
-
- echo "\r\n";
-
- echo implode(',', array_values($keysAndValues));
- }
-
- exit;
- }
+ use CsvResultSetUtils;
}
diff --git a/library/Icingadb/Data/CsvResultSetUtils.php b/library/Icingadb/Data/CsvResultSetUtils.php
new file mode 100644
index 0000000..61995d3
--- /dev/null
+++ b/library/Icingadb/Data/CsvResultSetUtils.php
@@ -0,0 +1,106 @@
+<?php
+
+/* Icinga DB Web | (c) 2024 Icinga GmbH | GPLv2 */
+
+namespace Icinga\Module\Icingadb\Data;
+
+use DateTime;
+use DateTimeZone;
+use Icinga\Module\Icingadb\Model\Host;
+use Icinga\Module\Icingadb\Model\Service;
+use ipl\Orm\Model;
+use ipl\Orm\Query;
+
+trait CsvResultSetUtils
+{
+ /**
+ * @return array<string, ?string>
+ */
+ public function current(): array
+ {
+ return $this->extractKeysAndValues(parent::current());
+ }
+
+ protected function formatValue(string $key, $value): ?string
+ {
+ if (
+ $value
+ && (
+ $key === 'id'
+ || substr($key, -3) === '_id'
+ || substr($key, -3) === '.id'
+ || substr($key, -9) === '_checksum'
+ || substr($key, -4) === '_bin'
+ )
+ ) {
+ $value = bin2hex($value);
+ }
+
+ if (is_bool($value)) {
+ return $value ? 'true' : 'false';
+ } elseif (is_string($value)) {
+ return '"' . str_replace('"', '""', $value) . '"';
+ } elseif (is_array($value)) {
+ return '"' . implode(',', $value) . '"';
+ } elseif ($value instanceof DateTime) {
+ return $value->setTimezone(new DateTimeZone('UTC'))
+ ->format('Y-m-d\TH:i:s.vP');
+ } else {
+ return $value;
+ }
+ }
+
+ protected function extractKeysAndValues(Model $model, string $path = ''): array
+ {
+ $keysAndValues = [];
+ foreach ($model as $key => $value) {
+ $keyPath = ($path ? $path . '.' : '') . $key;
+ if ($value instanceof Model) {
+ $keysAndValues += $this->extractKeysAndValues($value, $keyPath);
+ } else {
+ $keysAndValues[$keyPath] = $this->formatValue($key, $value);
+ }
+ }
+
+ return $keysAndValues;
+ }
+
+ public static function stream(Query $query): void
+ {
+ if ($query->getModel() instanceof Host || $query->getModel() instanceof Service) {
+ $query->setResultSetClass(VolatileCsvResults::class);
+ } else {
+ $query->setResultSetClass(__CLASS__);
+ }
+
+ if ($query->hasLimit()) {
+ // Custom limits should still apply
+ $query->peekAhead(false);
+ $offset = $query->getOffset();
+ } else {
+ $query->limit(1000);
+ $query->peekAhead();
+ $offset = 0;
+ }
+
+ do {
+ $query->offset($offset);
+ $result = $query->execute()->disableCache();
+ foreach ($result as $i => $keysAndValues) {
+ if ($i === 0) {
+ echo implode(',', array_keys($keysAndValues));
+ }
+
+ echo "\r\n";
+
+ echo implode(',', array_values($keysAndValues));
+
+ JsonResultSet::giveMeMoreTime();
+ }
+
+ $offset += 1000;
+ } while ($result->hasMore());
+
+ exit;
+ }
+}
diff --git a/library/Icingadb/Data/JsonResultSet.php b/library/Icingadb/Data/JsonResultSet.php
index 73cd9ef..715437a 100644
--- a/library/Icingadb/Data/JsonResultSet.php
+++ b/library/Icingadb/Data/JsonResultSet.php
@@ -4,77 +4,9 @@
namespace Icinga\Module\Icingadb\Data;
-use DateTime;
-use DateTimeZone;
-use Icinga\Module\Icingadb\Redis\VolatileStateResults;
-use Icinga\Util\Json;
-use ipl\Orm\Model;
-use ipl\Orm\Query;
+use ipl\Orm\ResultSet;
-class JsonResultSet extends VolatileStateResults
+class JsonResultSet extends ResultSet
{
- protected $isCacheDisabled = true;
-
- /**
- * @return array<string, ?string>
- */
- public function current(): array
- {
- return $this->createObject(parent::current());
- }
-
- protected function formatValue(string $key, $value): ?string
- {
- if (
- $value
- && (
- $key === 'id'
- || substr($key, -3) === '_id'
- || substr($key, -3) === '.id'
- || substr($key, -9) === '_checksum'
- || substr($key, -4) === '_bin'
- )
- ) {
- $value = bin2hex($value);
- }
-
- if ($value instanceof DateTime) {
- return $value->setTimezone(new DateTimeZone('UTC'))
- ->format('Y-m-d\TH:i:s.vP');
- }
-
- return $value;
- }
-
- protected function createObject(Model $model): array
- {
- $keysAndValues = [];
- foreach ($model as $key => $value) {
- if ($value instanceof Model) {
- $keysAndValues[$key] = $this->createObject($value);
- } else {
- $keysAndValues[$key] = $this->formatValue($key, $value);
- }
- }
-
- return $keysAndValues;
- }
-
- public static function stream(Query $query): void
- {
- $query->setResultSetClass(__CLASS__);
-
- echo '[';
- foreach ($query as $i => $object) {
- if ($i > 0) {
- echo ",\n";
- }
-
- echo Json::sanitize($object);
- }
-
- echo ']';
-
- exit;
- }
+ use JsonResultSetUtils;
}
diff --git a/library/Icingadb/Data/JsonResultSetUtils.php b/library/Icingadb/Data/JsonResultSetUtils.php
new file mode 100644
index 0000000..422a5b2
--- /dev/null
+++ b/library/Icingadb/Data/JsonResultSetUtils.php
@@ -0,0 +1,132 @@
+<?php
+
+/* Icinga DB Web | (c) 2024 Icinga GmbH | GPLv2 */
+
+namespace Icinga\Module\Icingadb\Data;
+
+use DateTime;
+use DateTimeZone;
+use Icinga\Module\Icingadb\Model\Host;
+use Icinga\Module\Icingadb\Model\Service;
+use Icinga\Util\Json;
+use ipl\Orm\Model;
+use ipl\Orm\Query;
+
+trait JsonResultSetUtils
+{
+ /**
+ * @return array<string, ?string>
+ */
+ public function current(): array
+ {
+ return $this->createObject(parent::current());
+ }
+
+ protected function formatValue(string $key, $value)
+ {
+ if (
+ $value
+ && (
+ $key === 'id'
+ || substr($key, -3) === '_id'
+ || substr($key, -3) === '.id'
+ || substr($key, -9) === '_checksum'
+ || substr($key, -4) === '_bin'
+ )
+ ) {
+ $value = bin2hex($value);
+ }
+
+ if ($value instanceof DateTime) {
+ return $value->setTimezone(new DateTimeZone('UTC'))
+ ->format('Y-m-d\TH:i:s.vP');
+ }
+
+ return $value;
+ }
+
+ protected function createObject(Model $model): array
+ {
+ $keysAndValues = [];
+ foreach ($model as $key => $value) {
+ if ($value instanceof Model) {
+ $keysAndValues[$key] = $this->createObject($value);
+ } else {
+ $keysAndValues[$key] = $this->formatValue($key, $value);
+ }
+ }
+
+ return $keysAndValues;
+ }
+
+ public static function stream(Query $query): void
+ {
+ if ($query->getModel() instanceof Host || $query->getModel() instanceof Service) {
+ $query->setResultSetClass(VolatileJsonResults::class);
+ } else {
+ $query->setResultSetClass(__CLASS__);
+ }
+
+ if ($query->hasLimit()) {
+ // Custom limits should still apply
+ $query->peekAhead(false);
+ $offset = $query->getOffset();
+ } else {
+ $query->limit(1000);
+ $query->peekAhead();
+ $offset = 0;
+ }
+
+ echo '[';
+
+ do {
+ $query->offset($offset);
+ $result = $query->execute()->disableCache();
+ foreach ($result as $i => $object) {
+ if ($i > 0 || $offset !== 0) {
+ echo ",\n";
+ }
+
+ echo Json::sanitize($object);
+
+ self::giveMeMoreTime();
+ }
+
+ $offset += 1000;
+ } while ($result->hasMore());
+
+ echo ']';
+
+ exit;
+ }
+
+ /**
+ * Grant the caller more time to work with
+ *
+ * This resets the execution time before it runs out. The advantage of this, compared with no execution time
+ * limit at all, is that only the caller can bypass the limit. Any other (faulty) code will still be stopped.
+ *
+ * @internal Don't use outside of {@see JsonResultSet::stream()} or {@see CsvResultSet::stream()}
+ *
+ * @return void
+ */
+ public static function giveMeMoreTime()
+ {
+ $spent = getrusage();
+ if ($spent !== false) {
+ $maxExecutionTime = ini_get('max_execution_time');
+ if (! $maxExecutionTime || ! is_numeric($maxExecutionTime)) {
+ $maxExecutionTime = 30;
+ } else {
+ $maxExecutionTime = (int) $maxExecutionTime;
+ }
+
+ if ($maxExecutionTime > 0) {
+ $timeRemaining = $maxExecutionTime - $spent['ru_utime.tv_sec'] % $maxExecutionTime;
+ if ($timeRemaining <= 5) {
+ set_time_limit($maxExecutionTime);
+ }
+ }
+ }
+ }
+}
diff --git a/library/Icingadb/Data/VolatileCsvResults.php b/library/Icingadb/Data/VolatileCsvResults.php
new file mode 100644
index 0000000..7d9f8ab
--- /dev/null
+++ b/library/Icingadb/Data/VolatileCsvResults.php
@@ -0,0 +1,15 @@
+<?php
+
+/* Icinga DB Web | (c) 2024 Icinga GmbH | GPLv2 */
+
+namespace Icinga\Module\Icingadb\Data;
+
+use Icinga\Module\Icingadb\Redis\VolatileStateResults;
+
+/**
+ * @internal This class is supposed to be used by {@see CsvResultSet::stream()} only.
+ */
+final class VolatileCsvResults extends VolatileStateResults
+{
+ use CsvResultSetUtils;
+}
diff --git a/library/Icingadb/Data/VolatileJsonResults.php b/library/Icingadb/Data/VolatileJsonResults.php
new file mode 100644
index 0000000..034fb0e
--- /dev/null
+++ b/library/Icingadb/Data/VolatileJsonResults.php
@@ -0,0 +1,15 @@
+<?php
+
+/* Icinga DB Web | (c) 2024 Icinga GmbH | GPLv2 */
+
+namespace Icinga\Module\Icingadb\Data;
+
+use Icinga\Module\Icingadb\Redis\VolatileStateResults;
+
+/**
+ * @internal This class is supposed to be used by {@see JsonResultSet::stream()} only.
+ */
+final class VolatileJsonResults extends VolatileStateResults
+{
+ use JsonResultSetUtils;
+}
generated by cgit v1.2.3 (git 2.39.1) at 2024-07-01 12:01:30 +0000