icinga2/lib/methods/plugineventtask.hpp

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

#ifndef PLUGINEVENTTASK_H
#define PLUGINEVENTTASK_H

#include "methods/i2-methods.hpp"
#include "icinga/service.hpp"
#include "base/process.hpp"

namespace icinga
{

/**
 * Implements event handlers based on external plugins.
 *
 * @ingroup methods
 */
class PluginEventTask
{
public:
	static void ScriptFunc(const Checkable::Ptr& service,
		const Dictionary::Ptr& resolvedMacros, bool useResolvedMacros);

private:
	PluginEventTask();

	static void ProcessFinishedHandler(const Checkable::Ptr& checkable,
		const Value& commandLine, const ProcessResult& pr);
};

}

#endif /* PLUGINEVENTTASK_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`
Refactor commands and implement event handlers. Fixes #3877 Fixes #4001 2013-06-13 05:33:00 -04:00
			`#ifndef PLUGINEVENTTASK_H`
			`#define PLUGINEVENTTASK_H`

Rename C++ header files. Fixes #6291 2014-05-25 10:23:35 -04:00			`#include "methods/i2-methods.hpp"`
			`#include "icinga/service.hpp"`
Fix event command execution not calling finish handler fixes #6856 2014-08-06 11:49:29 -04:00			`#include "base/process.hpp"`
Refactor commands and implement event handlers. Fixes #3877 Fixes #4001 2013-06-13 05:33:00 -04:00
			`namespace icinga`
			`{`

			`/**`
			`* Implements event handlers based on external plugins.`
			`*`
Move methods to a separate library. Refs #4959 2013-11-04 08:41:24 -05:00			`* @ingroup methods`
Refactor commands and implement event handlers. Fixes #3877 Fixes #4001 2013-06-13 05:33:00 -04:00			`*/`
Build libraries as static libraries 2017-12-31 01:22:16 -05:00			`class PluginEventTask`
Refactor commands and implement event handlers. Fixes #3877 Fixes #4001 2013-06-13 05:33:00 -04:00			`{`
			`public:`
Implement support for executing remote commands fixes #7559 2014-11-13 05:23:57 -05:00			`static void ScriptFunc(const Checkable::Ptr& service,`
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 Dictionary::Ptr& resolvedMacros, bool useResolvedMacros);`
Refactor commands and implement event handlers. Fixes #3877 Fixes #4001 2013-06-13 05:33:00 -04:00
			`private:`
Apply clang-tidy fix 'modernize-redundant-void-arg' 2018-01-03 22:25:35 -05:00			`PluginEventTask();`
Fix event command execution not calling finish handler fixes #6856 2014-08-06 11:49:29 -04:00
Improve log messages for failed commands fixes #6970 2014-08-21 05:25:04 -04:00			`static void ProcessFinishedHandler(const Checkable::Ptr& checkable,`
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 Value& commandLine, const ProcessResult& pr);`
Refactor commands and implement event handlers. Fixes #3877 Fixes #4001 2013-06-13 05:33:00 -04:00			`};`

			`}`

			`#endif /* PLUGINEVENTTASK_H */`