mirror of
https://github.com/Cacti/plugin_thold.git
synced 2026-10-23 03:27:05 +09:00
* INFO: set compat to 1.2.32 * docs: update Copilot instructions Cacti baseline to 1.2.32 (matches INFO compat) * INFO: back off compat to 1.2.29 * Add manifest.json + upgrade-time file pruning * Prune phpunit.xml on upgrade and ignore markdown-lint configs phpunit.xml ships in the repo for CI but is a dev-only test artifact, so it is removed from manifest.json 'expected', pruned from installs on upgrade (like tests/), and excluded from the manifest drift check. The retired markdown-lint configs (.mdlrc, .md_style.rb) are deleted, and .md* is now ignored like .git*: protected from pruning and excluded from drift if it reappears. * Move thold_functions.php and thold_webapi.php into includes/; flatten css The main threshold library becomes includes/functions.php and the web API helper becomes includes/webapi.php; every caller (setup.php, includes/*, the CLI/poller/notify entry points and the test suite) loads them from includes/. Each per-theme stylesheet css/<theme>/main.css becomes css/<theme>.css so users can drop their own css/<theme>.css into the css base, and the page_head hook looks there. Old paths are tombstoned so existing installs drop the stale copies on upgrade. * Regenerate cacti.pot for the includes/ file relocations Moving the plugin's library files into includes/ changed the source-reference lines in the translation template; regenerate it so the 'Verify translation template' CI check passes. * Harden the hook-include test and make RPN integer ops explicit The HookFunctionsIncludeTest invokes real hooks with placeholder input purely to execute their relocated include_once lines; it now swallows engine notices/warnings/deprecations during those calls (and restores the error handler and config afterward) so it cannot trip the suite's failOnDeprecation or leak state into other tests. The RPN % and ^ operators now cast their operands to int explicitly, matching their long-standing integer-truncation behaviour while silencing the implicit float-to-int conversion deprecation. * Harden prune against tampered-manifest path traversal The upgrade-time prune now rejects any tombstone containing '.'/'..' segments (which could escape the plugin directory or resolve to its root) and treats ancestors of whitelist entries as protected, so a tombstone on a parent directory can no longer delete a whitelisted file beneath it. * docs: update and align the Project Structure block Point the structure tree at the relocated files (libraries now under includes/, data files under docs/, stylesheets under css/) and align the trailing '# ...' comments to a single column so they no longer drift right. * docs/tests: standardize test header and correct manifest-contract notes - Use the full license header (from the plugin's own setup.php) in tests/Unit/PruneFilesTest.php instead of the abbreviated copyright banner. - Document that the manifest drift check and the upgrade-time prune also handle phpunit.xml and .md* files, matching the implemented behavior. * refactor: rename prune helpers to the plugin-slug function prefix The repository naming contract reserves the plugin_<name>_ prefix for plugin lifecycle / hook-registration functions; all other functions use the plain <name>_ prefix. Rename the internal upgrade helpers accordingly: plugin_<name>_prune_files() -> <name>_prune_files() plugin_<name>_rmtree() -> <name>_rmtree() The call site, unit tests, and the copilot-instructions.md references are updated to match. No behavioral change. * chore: set the Cacti compatibility floor to 1.2.29 Align the compat metadata (and the contributor-guide references) with the team decision to standardize the minimum supported Cacti version at 1.2.29; the previously proposed 1.2.32 floor was not adopted. --------- Co-authored-by: Copilot <copilot@users.noreply.github.com>
214 lines
5.9 KiB
PHP
214 lines
5.9 KiB
PHP
<?php
|
|
/*
|
|
+-------------------------------------------------------------------------+
|
|
| Copyright (C) 2004-2026 The Cacti Group |
|
|
| |
|
|
| This program is free software; you can redistribute it and/or |
|
|
| modify it under the terms of the GNU General Public License |
|
|
| as published by the Free Software Foundation; either version 2 |
|
|
| of the License, or (at your option) any later version. |
|
|
| |
|
|
| This program is distributed in the hope that it will be useful, |
|
|
| but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
|
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
|
| GNU General Public License for more details. |
|
|
+-------------------------------------------------------------------------+
|
|
| Cacti: The Complete RRDTool-based Graphing Solution |
|
|
+-------------------------------------------------------------------------+
|
|
| This code is designed, written, and maintained by the Cacti Group. See |
|
|
| about.php and/or the AUTHORS file for specific developer information. |
|
|
+-------------------------------------------------------------------------+
|
|
| http://www.cacti.net/ |
|
|
+-------------------------------------------------------------------------+
|
|
*/
|
|
|
|
$notification_registered = false;
|
|
$pid = 0;
|
|
$thread = 1;
|
|
|
|
if (function_exists('pcntl_async_signals')) {
|
|
pcntl_async_signals(true);
|
|
} else {
|
|
declare(ticks = 100);
|
|
}
|
|
|
|
chdir(__DIR__);
|
|
chdir('../../');
|
|
|
|
require_once('./include/cli_check.php');
|
|
require_once($config['base_path'] . '/lib/rrd.php');
|
|
require($config['base_path'] . '/plugins/thold/includes/arrays.php');
|
|
require_once($config['base_path'] . '/plugins/thold/includes/functions.php');
|
|
require_once($config['library_path'] . '/snmp.php');
|
|
require_once($config['base_path'] . '/lib/time.php');
|
|
|
|
// install signal handlers for Linux/UNIX only
|
|
if (function_exists('pcntl_signal')) {
|
|
pcntl_signal(SIGTERM, 'sig_handler');
|
|
pcntl_signal(SIGINT, 'sig_handler');
|
|
}
|
|
|
|
// help with microtime(true)
|
|
// ini_set('precision', 16);
|
|
|
|
// process calling arguments
|
|
$parms = $_SERVER['argv'];
|
|
array_shift($parms);
|
|
|
|
$debug = false;
|
|
|
|
global $thread;
|
|
|
|
if (sizeof($parms)) {
|
|
foreach ($parms as $parameter) {
|
|
if (strpos($parameter, '=')) {
|
|
[$arg, $value] = explode('=', $parameter);
|
|
} else {
|
|
$arg = $parameter;
|
|
$value = '';
|
|
}
|
|
|
|
switch ($arg) {
|
|
case '-d':
|
|
case '--debug':
|
|
$debug = true;
|
|
|
|
break;
|
|
case '--thread':
|
|
if (!ctype_digit((string) $value) || (int) $value <= 0) {
|
|
print 'FATAL: The Thread ID must be numeric and greater than 0.' . PHP_EOL;
|
|
display_help();
|
|
exit(1);
|
|
}
|
|
|
|
cacti_log('WARNING: thold_notify.php --thread is deprecated and ignored; notification ownership is automatic.', false, 'THOLD');
|
|
|
|
break;
|
|
case '-v':
|
|
case '--version':
|
|
case '-V':
|
|
display_version();
|
|
exit;
|
|
case '--help':
|
|
case '-h':
|
|
case '-H':
|
|
display_help();
|
|
exit;
|
|
default:
|
|
print 'ERROR: Invalid Parameter ' . $parameter . "\n\n";
|
|
display_help();
|
|
exit(1);
|
|
}
|
|
}
|
|
}
|
|
|
|
thold_cli_debug('Thold Notification Main Collector Started');
|
|
|
|
$timeout = 3600;
|
|
|
|
if (!thold_notification_main($thread, $timeout)) {
|
|
exit(1);
|
|
}
|
|
|
|
exit(0);
|
|
|
|
/**
|
|
* sig_handler - provides a generic means to catch exceptions to the Cacti log.
|
|
*
|
|
* @param $signo - (int) the signal that was thrown by the interface.
|
|
*
|
|
* @returns - null
|
|
*/
|
|
function sig_handler($signo) {
|
|
global $thread;
|
|
|
|
switch ($signo) {
|
|
case SIGTERM:
|
|
case SIGINT:
|
|
thold_cacti_log('WARNING: Thold Daemon Notification Child Process with PID[' . getmypid() . '] terminated by user', $thread);
|
|
thold_notification_shutdown();
|
|
|
|
exit;
|
|
|
|
break;
|
|
default:
|
|
// ignore all other signals
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Logs a debug message from the notification daemon to the Cacti log,
|
|
* only when global debug mode or the thold_daemon_debug setting is
|
|
* enabled.
|
|
*
|
|
* @param string $message The message to log.
|
|
* @param mixed $thread The worker thread identifier, passed through
|
|
* to thold_cacti_log() for log-line context.
|
|
*
|
|
* @return void
|
|
*
|
|
* @global bool $debug Whether debug output is enabled.
|
|
*/
|
|
function thold_daemon_debug($message, $thread) {
|
|
global $debug;
|
|
|
|
$daemon_debug = read_config_option('thold_daemon_debug');
|
|
|
|
if ($debug || $daemon_debug) {
|
|
thold_cacti_log($message, $thread);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Prints a timestamped debug message directly to stdout when global
|
|
* debug mode is enabled.
|
|
*
|
|
* @param string $string The message to print.
|
|
*
|
|
* @return void
|
|
*
|
|
* @global bool $debug Whether debug output is enabled.
|
|
*/
|
|
function thold_cli_debug($string) {
|
|
global $debug;
|
|
|
|
if ($debug) {
|
|
$output = date('Y-m-d H:i:s') . ' DEBUG: ' . trim($string);
|
|
|
|
print $output . PHP_EOL;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Prints this script's name, version, and copyright banner to stdout.
|
|
*
|
|
* @return void
|
|
*
|
|
* @global array $config Cacti global configuration array; used to
|
|
* locate setup.php when plugin_thold_version()
|
|
* isn't already loaded.
|
|
*/
|
|
function display_version() {
|
|
global $config;
|
|
|
|
if (!function_exists('plugin_thold_version')) {
|
|
include_once($config['base_path'] . '/plugins/thold/setup.php');
|
|
}
|
|
|
|
$info = plugin_thold_version();
|
|
print 'Threshold Notification Processor, Version ' . $info['version'] . ', ' . COPYRIGHT_YEARS . PHP_EOL;
|
|
}
|
|
|
|
/**
|
|
* Prints this script's version banner followed by its command-line
|
|
* usage instructions to stdout.
|
|
*
|
|
* @return void
|
|
*/
|
|
function display_help() {
|
|
display_version();
|
|
|
|
print PHP_EOL . 'usage: thold_notify.php [--thread=N] [--debug]' . PHP_EOL . PHP_EOL;
|
|
print 'The Threshold Notification Processor for the Thold Plugin.' . PHP_EOL;
|
|
}
|