ipfixprobe - introduce output TEXT plugin

Author: Pavel Siska

src/plugins/CMakeLists.txt

@@ -1 +1,2 @@
 add_subdirectory(input)
+add_subdirectory(output)

src/plugins/output/CMakeLists.txt

@@ -0,0 +1 @@
+add_subdirectory(text)

src/plugins/output/text/CMakeLists.txt

@@ -0,0 +1,18 @@
+project(ipfixprobe-output-text VERSION 1.0.0 DESCRIPTION "ipfixprobe-output-text plugin")
+
+add_library(ipfixprobe-output-text SHARED
+    src/text.hpp
+    src/text.cpp
+)
+
+set_target_properties(ipfixprobe-output-text PROPERTIES
+    CXX_VISIBILITY_PRESET hidden
+    VISIBILITY_INLINES_HIDDEN YES
+)
+
+target_include_directories(ipfixprobe-output-text PRIVATE ${CMAKE_SOURCE_DIR}/include/)
+
+install(
+    TARGETS ipfixprobe-output-text
+    LIBRARY DESTINATION "${INSTALL_DIR_LIB}/ipfixprobe/output/"
+)

src/plugins/output/text/README.md

@@ -1,29 +1,13 @@
 /**
- * \file text.cpp
- * \brief Prints exported fields
- * \author Jiri Havranek <[email protected]>
- * \date 2021
- */
-/*
- * Copyright (C) 2021 CESNET
- *
- * LICENSE TERMS
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- *    notice, this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in
- *    the documentation and/or other materials provided with the
- *    distribution.
- * 3. Neither the name of the Company nor the names of its contributors
- *    may be used to endorse or promote products derived from this
- *    software without specific prior written permission.
- *
+ * @file
+ * @brief Prints exported fields
+ * @author Jiri Havranek <[email protected]>
+ * @author Pavel Siska <[email protected]>
+ * @date 2025
  *
+ * Copyright (c) 2025 CESNET
  *
+ * SPDX-License-Identifier: BSD-3-Clause
  */
 
 #include "text.hpp"
@@ -34,18 +18,28 @@
 #include <ostream>
 #include <string>
 
-namespace ipxp {
+#include <ipfixprobe/pluginFactory/pluginManifest.hpp>
+#include <ipfixprobe/pluginFactory/pluginRegistrar.hpp>
 
-__attribute__((constructor)) static void register_this_plugin()
-{
-	static PluginRecord rec = PluginRecord("text", []() { return new TextExporter(); });
-	register_plugin(&rec);
-}
+namespace ipxp {
 
-TextExporter::TextExporter()
+static const PluginManifest textPluginManifest = {
+	.name = "text",
+	.description = "Output plugin for text export",
+	.pluginVersion = "1.0.0",
+	.apiVersion = "1.0.0",
+	.usage =
+		[]() {
+			TextOptParser parser;
+			parser.usage(std::cout);
+		},
+};
+
+TextExporter::TextExporter(const std::string& params)
 	: m_out(&std::cout)
 	, m_hide_mac(false)
 {
+	init(params.c_str());
 }
 
 TextExporter::~TextExporter()
@@ -168,4 +162,6 @@ void TextExporter::print_basic_flow(const Flow& flow)
 		   << static_cast<unsigned>(flow.dst_tcp_flags) << " " << time_begin << "->" << time_end;
 }
 
+static const PluginRegistrar<TextExporter, OutputPluginFactory> textRegistrar(textPluginManifest);
+
 } // namespace ipxp

src/plugins/output/text.cpp src/plugins/output/text/src/text.cppsrc/plugins/output/text.cpp renamed to src/plugins/output/text/src/text.cpp

@@ -1,40 +1,23 @@
 /**
- * \file text.hpp
- * \brief Prints exported fields
- * \author Jiri Havranek <[email protected]>
- * \date 2021
- */
-/*
- * Copyright (C) 2021 CESNET
- *
- * LICENSE TERMS
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- *    notice, this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in
- *    the documentation and/or other materials provided with the
- *    distribution.
- * 3. Neither the name of the Company nor the names of its contributors
- *    may be used to endorse or promote products derived from this
- *    software without specific prior written permission.
- *
+ * @file
+ * @brief Prints exported fields
+ * @author Jiri Havranek <[email protected]>
+ * @author Pavel Siska <[email protected]>
+ * @date 2025
  *
+ * Copyright (c) 2025 CESNET
  *
+ * SPDX-License-Identifier: BSD-3-Clause
  */
 
-#ifndef IPXP_OUTPUT_TEXT_HPP
-#define IPXP_OUTPUT_TEXT_HPP
+#pragma once
 
 #include <string>
 
 #include <ipfixprobe/flowifc.hpp>
 #include <ipfixprobe/options.hpp>
-#include <ipfixprobe/output.hpp>
-#include <ipfixprobe/process.hpp>
+#include <ipfixprobe/outputPlugin.hpp>
+#include <ipfixprobe/processPlugin.hpp>
 #include <ipfixprobe/utils.hpp>
 
 namespace ipxp {
@@ -77,7 +60,7 @@ class TextOptParser : public OptionsParser {
 
 class TextExporter : public OutputPlugin {
 public:
-	TextExporter();
+	TextExporter(const std::string& params);
 	~TextExporter();
 	void init(const char* params);
 	void init(const char* params, Plugins& plugins);
@@ -94,4 +77,3 @@ class TextExporter : public OutputPlugin {
 };
 
 } // namespace ipxp
-#endif /* IPXP_OUTPUT_TEXT_HPP */