Zpool: add new module

2026-10-29 00:03:58 +01:00 · 2024-08-28 10:55:04 +08:00
parent 5842ad1d56
commit d946cf27fe
13 changed files with 487 additions and 0 deletions
@@ -70,3 +70,4 @@
 #include "modules/wifi/wifi.h"
 #include "modules/wm/wm.h"
 #include "modules/wmtheme/wmtheme.h"
+#include "modules/zpool/zpool.h"
@@ -70,3 +70,4 @@
 #include "modules/wifi/option.h"
 #include "modules/wm/option.h"
 #include "modules/wmtheme/option.h"
+#include "modules/zpool/option.h"
@@ -0,0 +1,14 @@
+#pragma once
+
+// This file will be included in "fastfetch.h", do NOT put unnecessary things here
+
+#include "common/option.h"
+#include "common/percent.h"
+
+typedef struct FFZpoolOptions
+{
+    FFModuleBaseInfo moduleInfo;
+    FFModuleArgs moduleArgs;
+
+    FFColorRangeConfig percent;
+} FFZpoolOptions;
@@ -0,0 +1,217 @@
+#include "common/printing.h"
+#include "common/jsonconfig.h"
+#include "common/percent.h"
+#include "detection/zpool/zpool.h"
+#include "modules/zpool/zpool.h"
+#include "util/stringUtils.h"
+
+#define FF_ZPOOL_NUM_FORMAT_ARGS 9
+
+static void printZpool(FFZpoolOptions* options, FFZpoolResult* result, uint8_t index)
+{
+    FF_STRBUF_AUTO_DESTROY buffer = ffStrbufCreate();
+    if (options->moduleArgs.key.length == 0)
+    {
+        if (result->name.length > 0)
+            ffStrbufSetF(&buffer, "%s (%s)", FF_ZPOOL_MODULE_NAME, result->name.chars);
+        else
+            ffStrbufSetS(&buffer, FF_ZPOOL_MODULE_NAME);
+    }
+    else
+    {
+        ffStrbufClear(&buffer);
+        FF_PARSE_FORMAT_STRING_CHECKED(&buffer, &options->moduleArgs.key, 2, ((FFformatarg[]){
+            {FF_FORMAT_ARG_TYPE_UINT8, &index, "index"},
+            {FF_FORMAT_ARG_TYPE_STRBUF, &result->name, "name"},
+        }));
+    }
+
+    FF_STRBUF_AUTO_DESTROY usedPretty = ffStrbufCreate();
+    ffParseSize(result->used, &usedPretty);
+
+    FF_STRBUF_AUTO_DESTROY totalPretty = ffStrbufCreate();
+    ffParseSize(result->total, &totalPretty);
+
+    double bytesPercentage = result->total > 0 ? (double) result->used / (double) result->total * 100.0 : 0;
+    double fragPercentage = (double) result->fragmentation;
+
+    if(options->moduleArgs.outputFormat.length == 0)
+    {
+        ffPrintLogoAndKey(buffer.chars, index, &options->moduleArgs, FF_PRINT_TYPE_NO_CUSTOM_KEY);
+
+        ffStrbufClear(&buffer);
+        ffStrbufSetF(&buffer, "%s / %s (", usedPretty.chars, totalPretty.chars);
+        ffPercentAppendNum(&buffer, bytesPercentage, options->percent, false, &options->moduleArgs);
+        ffStrbufAppendS(&buffer, ", ");
+        ffPercentAppendNum(&buffer, fragPercentage, options->percent, false, &options->moduleArgs);
+        ffStrbufAppendF(&buffer, " frag) - %s", result->status.chars);
+        ffStrbufPutTo(&buffer, stdout);
+    }
+    else
+    {
+        FF_STRBUF_AUTO_DESTROY bytesPercentageNum = ffStrbufCreate();
+        ffPercentAppendNum(&bytesPercentageNum, bytesPercentage, options->percent, false, &options->moduleArgs);
+        FF_STRBUF_AUTO_DESTROY bytesPercentageBar = ffStrbufCreate();
+        ffPercentAppendBar(&bytesPercentageBar, bytesPercentage, options->percent, &options->moduleArgs);
+
+        FF_STRBUF_AUTO_DESTROY fragPercentageNum = ffStrbufCreate();
+        ffPercentAppendNum(&fragPercentageNum, fragPercentage, options->percent, false, &options->moduleArgs);
+        FF_STRBUF_AUTO_DESTROY fragPercentageBar = ffStrbufCreate();
+        ffPercentAppendBar(&fragPercentageBar, fragPercentage, options->percent, &options->moduleArgs);
+
+        FF_PRINT_FORMAT_CHECKED(buffer.chars, 0, &options->moduleArgs, FF_PRINT_TYPE_NO_CUSTOM_KEY, FF_ZPOOL_NUM_FORMAT_ARGS, ((FFformatarg[]) {
+            {FF_FORMAT_ARG_TYPE_STRBUF, &result->name, "name"},
+            {FF_FORMAT_ARG_TYPE_STRBUF, &result->state, "state"},
+            {FF_FORMAT_ARG_TYPE_STRBUF, &result->status, "status"},
+            {FF_FORMAT_ARG_TYPE_STRBUF, &usedPretty, "size-used"},
+            {FF_FORMAT_ARG_TYPE_STRBUF, &totalPretty, "size-total"},
+            {FF_FORMAT_ARG_TYPE_STRBUF, &bytesPercentageNum, "size-percentage"},
+            {FF_FORMAT_ARG_TYPE_STRBUF, &fragPercentage, "frag-percentage"},
+            {FF_FORMAT_ARG_TYPE_STRBUF, &bytesPercentageBar, "size-percentage-bar"},
+            {FF_FORMAT_ARG_TYPE_STRBUF, &fragPercentageBar, "frag-percentage-bar"},
+        }));
+    }
+}
+
+void ffPrintZpool(FFZpoolOptions* options)
+{
+    FF_LIST_AUTO_DESTROY results = ffListCreate(sizeof(FFZpoolResult));
+
+    const char* error = ffDetectZpool(&results);
+
+    if (error)
+    {
+        ffPrintError(FF_ZPOOL_MODULE_NAME, 0, &options->moduleArgs, FF_PRINT_TYPE_DEFAULT, "%s", error);
+        return;
+    }
+    if(results.length == 0)
+    {
+        ffPrintError(FF_ZPOOL_MODULE_NAME, 0, &options->moduleArgs, FF_PRINT_TYPE_DEFAULT, "%s", "No zpool found");
+        return;
+    }
+
+    for(uint32_t i = 0; i < results.length; i++)
+    {
+        FFZpoolResult* result = FF_LIST_GET(FFZpoolResult, results, i);
+        uint8_t index = results.length == 1 ? 0 : (uint8_t) (i + 1);
+        printZpool(options, result, index);
+    }
+
+    FF_LIST_FOR_EACH(FFZpoolResult, result, results)
+    {
+        ffStrbufDestroy(&result->name);
+        ffStrbufDestroy(&result->state);
+    }
+}
+
+bool ffParseZpoolCommandOptions(FFZpoolOptions* options, const char* key, const char* value)
+{
+    const char* subKey = ffOptionTestPrefix(key, FF_ZPOOL_MODULE_NAME);
+    if (!subKey) return false;
+    if (ffOptionParseModuleArgs(key, subKey, value, &options->moduleArgs))
+        return true;
+
+    if (ffPercentParseCommandOptions(key, subKey, value, &options->percent))
+        return true;
+
+    return false;
+}
+
+void ffParseZpoolJsonObject(FFZpoolOptions* options, yyjson_val* module)
+{
+    yyjson_val *key_, *val;
+    size_t idx, max;
+    yyjson_obj_foreach(module, idx, max, key_, val)
+    {
+        const char* key = yyjson_get_str(key_);
+        if(ffStrEqualsIgnCase(key, "type"))
+            continue;
+
+        if (ffJsonConfigParseModuleArgs(key, val, &options->moduleArgs))
+            continue;
+
+        if (ffPercentParseJsonObject(key, val, &options->percent))
+            continue;
+
+        ffPrintError(FF_ZPOOL_MODULE_NAME, 0, &options->moduleArgs, FF_PRINT_TYPE_DEFAULT, "Unknown JSON key %s", key);
+    }
+}
+
+void ffGenerateZpoolJsonConfig(FFZpoolOptions* options, yyjson_mut_doc* doc, yyjson_mut_val* module)
+{
+    __attribute__((__cleanup__(ffDestroyZpoolOptions))) FFZpoolOptions defaultOptions;
+    ffInitZpoolOptions(&defaultOptions);
+
+    ffJsonConfigGenerateModuleArgsConfig(doc, module, &defaultOptions.moduleArgs, &options->moduleArgs);
+
+    ffPercentGenerateJsonConfig(doc, module, defaultOptions.percent, options->percent);
+}
+
+void ffGenerateZpoolJsonResult(FF_MAYBE_UNUSED FFZpoolOptions* options, yyjson_mut_doc* doc, yyjson_mut_val* module)
+{
+    FF_LIST_AUTO_DESTROY results = ffListCreate(sizeof(FFZpoolResult));
+
+    const char* error = ffDetectZpool(&results);
+    if (error)
+    {
+        yyjson_mut_obj_add_str(doc, module, "error", error);
+        return;
+    }
+
+    yyjson_mut_val* arr = yyjson_mut_obj_add_arr(doc, module, "result");
+
+    FF_LIST_FOR_EACH(FFZpoolResult, zpool, results)
+    {
+        yyjson_mut_val* obj = yyjson_mut_arr_add_obj(doc, arr);
+        yyjson_mut_obj_add_strbuf(doc, obj, "name", &zpool->name);
+        yyjson_mut_obj_add_strbuf(doc, obj, "state", &zpool->state);
+        yyjson_mut_obj_add_strbuf(doc, obj, "status", &zpool->status);
+        yyjson_mut_obj_add_uint(doc, obj, "used", zpool->used);
+        yyjson_mut_obj_add_uint(doc, obj, "total", zpool->total);
+        yyjson_mut_obj_add_uint(doc, obj, "version", zpool->version);
+        yyjson_mut_obj_add_uint(doc, obj, "fragmentation", zpool->fragmentation);
+    }
+
+    FF_LIST_FOR_EACH(FFZpoolResult, battery, results)
+    {
+        ffStrbufDestroy(&battery->name);
+        ffStrbufDestroy(&battery->state);
+    }
+}
+
+void ffPrintZpoolHelpFormat(void)
+{
+    FF_PRINT_MODULE_FORMAT_HELP_CHECKED(FF_ZPOOL_MODULE_NAME, "{3} / {4} ({5}, {6} frag)", FF_ZPOOL_NUM_FORMAT_ARGS, ((const char* []) {
+        "Zpool name - name",
+        "Zpool state - state",
+        "Zpool health status - status",
+        "Size used - size-used",
+        "Size total - size-total",
+        "Size percentage num - size-percentage",
+        "Fragmentation percentage num - frag-percentage",
+        "Size percentage bar - size-percentage-bar",
+        "Fragmentation percentage bar - frag-percentage-bar",
+    }));
+}
+
+void ffInitZpoolOptions(FFZpoolOptions* options)
+{
+    ffOptionInitModuleBaseInfo(
+        &options->moduleInfo,
+        FF_ZPOOL_MODULE_NAME,
+        "Print zfs pools",
+        ffParseZpoolCommandOptions,
+        ffParseZpoolJsonObject,
+        ffPrintZpool,
+        ffGenerateZpoolJsonResult,
+        ffPrintZpoolHelpFormat,
+        ffGenerateZpoolJsonConfig
+    );
+    ffOptionInitModuleArg(&options->moduleArgs, "󱑛");
+    options->percent = (FFColorRangeConfig) { 50, 80 };
+}
+
+void ffDestroyZpoolOptions(FFZpoolOptions* options)
+{
+    ffOptionDestroyModuleArg(&options->moduleArgs);
+}
@@ -0,0 +1,9 @@
+#pragma once
+
+#include "fastfetch.h"
+
+#define FF_ZPOOL_MODULE_NAME "Zpool"
+
+void ffPrintZpool(FFZpoolOptions* options);
+void ffInitZpoolOptions(FFZpoolOptions* options);
+void ffDestroyZpoolOptions(FFZpoolOptions* options);