icinga2/lib/icinga/pluginutility.hpp

// SPDX-FileCopyrightText: 2012 Icinga GmbH <https://icinga.com>
// SPDX-License-Identifier: GPL-2.0-or-later

#ifndef PLUGINUTILITY_H
#define PLUGINUTILITY_H

#include "icinga/i2-icinga.hpp"
#include "icinga/checkable.hpp"
#include "icinga/checkcommand.hpp"
#include "icinga/macroprocessor.hpp"
#include <vector>

namespace icinga
{

struct ProcessResult;

/**
 * Utility functions for plugin-based checks.
 *
 * @ingroup icinga
 */
class PluginUtility
{
public:
	static void ExecuteCommand(const Command::Ptr& commandObj,
		const CheckResult::Ptr& cr, const MacroProcessor::ResolverList& macroResolvers,
		const Dictionary::Ptr& resolvedMacros, bool useResolvedMacros, int timeout,
		const std::function<void(const Value& commandLine, const ProcessResult&)>& callback = std::function<void(const Value& commandLine, const ProcessResult&)>());

	static ServiceState ExitStatusToState(int exitStatus);
	static std::pair<String, String> ParseCheckOutput(const String& output);

	static Array::Ptr SplitPerfdata(const String& perfdata);
	static String FormatPerfdata(const Array::Ptr& perfdata, bool normalize = false);

private:
	PluginUtility();
};

}

#endif /* PLUGINUTILITY_H */
Replace all existing copyright headers with `SPDX` headers I've used the following command to replace the original copyright header lines in a C-style comment block: ``` $ find . \( -type d \( -name '\..' -o -name third-party -o -name scripts -o -name prefix -o -name malloc -o -name server -o -name docker -o -name build -o -name doc \) -prune \) -o -type f -exec perl -pi -e 's{/\[^]\(\sc\s\)\s(\d{4})\sIcinga\s+GmbH[^]\/}{// SPDX-FileCopyrightText: \1 Icinga GmbH <https://icinga.com>\n// SPDX-License-Identifier: GPL-2.0-or-later}gi' {} + ``` For files that use shell-style comments (#) like CMakeLists.txt, I've used this command: ``` $ find . \( -type d \( -name '\..' -o -name third-party -o -name scripts -o -name prefix -o -name malloc -o -name server -o -name docker -o -name build -o -name doc \) -prune \) -o -type f -exec perl -pi -e 's{#.\(\sc\s\)\s(\d{4})\sIcinga\s+GmbH.}{# SPDX-FileCopyrightText: \1 Icinga GmbH <https://icinga.com>\n# SPDX-License-Identifier: GPL-2.0-or-later}gi' {} + ``` And for SQL files: ``` $ find . \( -type d \( -name '\..' -o -name third-party -o -name scripts -o -name prefix -o -name malloc -o -name server -o -name docker -o -name build -o -name doc \) -prune \) -o -type f \( -name '.sql' \) -exec perl -pi -e 's{--.\(c\)\s(\d{4})\sIcinga\sGmbH.}{-- SPDX-FileCopyrightText: \1 Icinga GmbH <https://icinga.com>\n-- SPDX-License-Identifier: GPL-2.0-or-later}gi' {} + $ find . \( -type d \( -name '\..' -o -name third-party -o -name scripts -o -name prefix -o -name malloc -o -name server -o -name docker -o -name build -o -name doc \) -prune \) -o -type f \( -name '.sql' \) -exec perl -pi -e 's{-- Copyright \(c\)\s(\d{4})\sIcinga\s+Development\sTeam.*}{-- SPDX-FileCopyrightText: \1 Icinga GmbH <https://icinga.com>\n-- SPDX-License-Identifier: GPL-2.0-or-later}gi' {} + ``` 2026-01-27 09:06:40 -05:00			`// SPDX-FileCopyrightText: 2012 Icinga GmbH <https://icinga.com>`
			`// SPDX-License-Identifier: GPL-2.0-or-later`
Added missing GPL headers and Visual Studio filters. 2012-07-09 14:32:02 -04:00
Move methods to a separate library. Refs #4959 2013-11-04 08:41:24 -05:00			`#ifndef PLUGINUTILITY_H`
			`#define PLUGINUTILITY_H`
Implemented rudimentary service checks. 2012-06-13 07:42:55 -04:00
Rename C++ header files. Fixes #6291 2014-05-25 10:23:35 -04:00			`#include "icinga/i2-icinga.hpp"`
			`#include "icinga/checkable.hpp"`
			`#include "icinga/checkcommand.hpp"`
			`#include "icinga/macroprocessor.hpp"`
Move methods to a separate library. Refs #4959 2013-11-04 08:41:24 -05:00			`#include <vector>`
Refactor #includes (Part 2). 2013-03-16 16:18:53 -04:00
Implemented rudimentary service checks. 2012-06-13 07:42:55 -04:00			`namespace icinga`
			`{`

Remove unnecessary includes. Fixes #6189 2014-05-11 11:14:35 -04:00			`struct ProcessResult;`

Updated doxygen documentation. 2012-09-17 07:35:55 -04:00			`/**`
Move methods to a separate library. Refs #4959 2013-11-04 08:41:24 -05:00			`* Utility functions for plugin-based checks.`
Updated doxygen documentation. 2012-09-17 07:35:55 -04:00			`*`
			`* @ingroup icinga`
			`*/`
Build libraries as static libraries 2017-12-31 01:22:16 -05:00			`class PluginUtility`
Implemented rudimentary service checks. 2012-06-13 07:42:55 -04:00			`{`
			`public:`
Fix compiler warnings by removing unused variables 2023-03-31 06:38:24 -04:00			`static void ExecuteCommand(const Command::Ptr& commandObj,`
Whitespace fix What does this change? * Remove use of spaces for formatting These could be found by using `grep -r -l -P '^\t+ +[^]' Removal of training whitespaces * A few lines longer than 120 chars 2017-12-19 09:50:05 -05:00			`const CheckResult::Ptr& cr, const MacroProcessor::ResolverList& macroResolvers,`
Fix that check_timeout was used for Event/Notification commands too We may add specific timeouts for event/notification commands later, for now the original timeout inside the EventCommand/NotificationCommand is used. fixes #6304 2018-09-28 08:32:57 -04:00			`const Dictionary::Ptr& resolvedMacros, bool useResolvedMacros, int timeout,`
Whitespace fix What does this change? * Remove use of spaces for formatting These could be found by using `grep -r -l -P '^\t+ +[^]' Removal of training whitespaces * A few lines longer than 120 chars 2017-12-19 09:50:05 -05:00			`const std::function<void(const Value& commandLine, const ProcessResult&)>& callback = std::function<void(const Value& commandLine, const ProcessResult&)>());`
Implement support for optional command arguments. Fixes #5933 2014-04-26 07:16:08 -04:00
Implemented the PROCESS_SERVICE_CHECK_RESULT external command. 2013-01-22 06:05:36 -05:00			`static ServiceState ExitStatusToState(int exitStatus);`
Don't parse perfdata if enable_perfdata is false fixes #7032 2014-09-07 06:27:06 -04:00			`static std::pair<String, String> ParseCheckOutput(const String& output);`
Implemented the PROCESS_SERVICE_CHECK_RESULT external command. 2013-01-22 06:05:36 -05:00
Fix problems with PNP4Nagios fixes #7268 2014-09-17 09:38:39 -04:00			`static Array::Ptr SplitPerfdata(const String& perfdata);`
PluginUtility::FormatPerfdata(): normalize UoMs if desired 2021-05-11 10:47:03 -04:00			`static String FormatPerfdata(const Array::Ptr& perfdata, bool normalize = false);`
Implement performance data parser. Refs #2710 2013-11-07 07:37:58 -05:00
Implemented rudimentary service checks. 2012-06-13 07:42:55 -04:00			`private:`
Apply clang-tidy fix 'modernize-redundant-void-arg' 2018-01-03 22:25:35 -05:00			`PluginUtility();`
Implemented rudimentary service checks. 2012-06-13 07:42:55 -04:00			`};`

			`}`

Move methods to a separate library. Refs #4959 2013-11-04 08:41:24 -05:00			`#endif /* PLUGINUTILITY_H */`