From 0645c9fc2c7f801ba3c7d68a17c137a63ada299f Mon Sep 17 00:00:00 2001
From: Lorenz Kästle <12514511+RincewindsHat@users.noreply.github.com>
Date: Tue, 18 Feb 2025 21:58:34 +0100
Subject: Implement new output functionality

---
 lib/output.h | 87 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 87 insertions(+)
 create mode 100644 lib/output.h

(limited to 'lib/output.h')

diff --git a/lib/output.h b/lib/output.h
new file mode 100644
index 00000000..c7455d29
--- /dev/null
+++ b/lib/output.h
@@ -0,0 +1,87 @@
+#pragma once
+
+#include "../config.h"
+#include "./perfdata.h"
+#include "./states.h"
+
+/*
+ * A partial check result
+ */
+typedef struct {
+	mp_state_enum state;         // OK, Warning, Critical ... set explicitly
+	mp_state_enum default_state; // OK, Warning, Critical .. if not set explicitly
+	bool state_set_explicitly;   // was the state set explicitly (or should it be derived from subchecks)
+
+	char *output;                    // Text output for humans ("Filesystem xyz is fine", "Could not create TCP connection to..")
+	pd_list *perfdata;               // Performance data for this check
+	struct subcheck_list *subchecks; // subchecks deeper in the hierarchy
+} mp_subcheck;
+
+/*
+ * A list of subchecks, used in subchecks and the main check
+ */
+typedef struct subcheck_list {
+	mp_subcheck subcheck;
+	struct subcheck_list *next;
+} mp_subcheck_list;
+
+/*
+ * Possible output formats
+ */
+typedef enum output_format {
+	MP_FORMAT_ONE_LINE,
+	MP_FORMAT_ICINGA_WEB_2,
+	MP_FORMAT_SUMMARY_ONLY,
+	MP_FORMAT_TEST_JSON,
+} mp_output_format;
+
+#define MP_FORMAT_DEFAULT MP_FORMAT_ICINGA_WEB_2
+
+/*
+ * The main state object of a plugin. Exists only ONCE per plugin.
+ * This is the "root" of a tree of singular checks.
+ * The final result is always derived from the children and the "worst" state
+ * in the first layer of subchecks
+ */
+typedef struct {
+	mp_output_format format; // The output format
+	char *summary;           // Overall summary, if not set a summary will be automatically generated
+	mp_subcheck_list *subchecks;
+} mp_check;
+
+mp_check mp_check_init(void);
+mp_subcheck mp_subcheck_init(void);
+
+mp_subcheck mp_set_subcheck_state(mp_subcheck, mp_state_enum);
+mp_subcheck mp_set_subcheck_default_state(mp_subcheck, mp_state_enum);
+
+int mp_add_subcheck_to_check(mp_check check[static 1], mp_subcheck);
+int mp_add_subcheck_to_subcheck(mp_subcheck check[static 1], mp_subcheck);
+
+void mp_add_perfdata_to_subcheck(mp_subcheck check[static 1], mp_perfdata);
+
+void mp_add_summary(mp_check check[static 1], char *summary);
+
+mp_state_enum mp_compute_check_state(mp_check);
+mp_state_enum mp_compute_subcheck_state(mp_subcheck);
+
+typedef struct {
+	bool parsing_success;
+	mp_output_format output_format;
+} parsed_output_format;
+parsed_output_format mp_parse_output_format(char *format_string);
+
+// TODO free and stuff
+// void mp_cleanup_check(mp_check check[static 1]);
+
+char *mp_fmt_output(mp_check);
+
+void mp_print_output(mp_check);
+
+/*
+ * ==================
+ * Exit functionality
+ * ==================
+ */
+
+void mp_exit(mp_check) __attribute__((noreturn));
-- 
cgit v1.2.3-74-g34f1