Files
cacti/scripts/query_host_cpu.php
Thomas VincentandTheWitness a515cea185 fix(scripts): return 'U' on error in ss_webseer, ss_gexport, query_host_cpu (#6941)
* fix(scripts): return 'U' on error in ss_webseer, ss_gexport, query_host_cpu

Data source scripts must return 'U' (RRDtool unknown) on error rather than
'0', which is a valid data value and silently poisons graphs.

- ss_webseer.php: replace empty() guard with strict $value === '' comparison
  (empty('0') is true in PHP, corrupting a valid zero reading); return 'U'
  on fallthrough instead of false
- ss_gexport.php: return 'U' on fallthrough instead of null
- query_host_cpu.php: print 'U' when requested index absent in get handler

Adds DatasourceScriptErrorReturnTest.php with source-scan tests for each
corrected return path including regression guards for the empty() trap.
Uses tab indentation to match repo conventions.

Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>

* fix(ss_webseer): catch false/null returns from db_fetch_cell_prepared

db_fetch_cell_prepared() returns false when the query finds no row or
fails. The previous check ($value === '') passed false and null through
as-is, returning a non-'U' value to rrdtool and causing NaN spikes.
Extend the guard to treat false and null the same as empty string.

Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>

* test(scripts): add GPL header to DatasourceScriptErrorReturnTest

Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>

* test(scripts): add false/null guard tests for ss_gexport and ss_webseer

Adds source-scan assertions verifying both scripts handle false and null
returns from db_fetch_cell_prepared, and a behavioural dataset confirming
the guard expression maps all three sentinel values to 'U'.

Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>

---------

Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>
Co-authored-by: TheWitness <thewitness@cacti.net>
2026-04-04 12:43:03 -04:00

155 lines
6.6 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/ |
+-------------------------------------------------------------------------+
*/
error_reporting(0);
include(__DIR__ . '/../include/cli_check.php');
include(__DIR__ . '/../lib/snmp.php');
$oids = [
'index' => '.1.3.6.1.2.1.25.3.3.1',
'usage' => '.1.3.6.1.2.1.25.3.3.1'
];
$hostname = $_SERVER['argv'][1];
$host_id = intval($_SERVER['argv'][2]);
$snmp_auth = $_SERVER['argv'][3];
$cmd = $_SERVER['argv'][4];
// support for SNMP V2 and SNMP V3 parameters
$snmp = explode(':', $snmp_auth);
$snmp_version = intval($snmp[0]);
$snmp_port = intval($snmp[1]);
$snmp_timeout = intval($snmp[2]);
$snmp_retries = intval($snmp[3]);
$max_oids = intval($snmp[4]);
$snmp_auth_username = '';
$snmp_auth_password = '';
$snmp_auth_protocol = '';
$snmp_priv_passphrase = '';
$snmp_priv_protocol = '';
$snmp_context = '';
$snmp_community = '';
if ($snmp_version == 3) {
$snmp_auth_username = $snmp[6];
$snmp_auth_password = $snmp[7];
$snmp_auth_protocol = $snmp[8];
$snmp_priv_passphrase = $snmp[9];
$snmp_priv_protocol = $snmp[10];
$snmp_context = $snmp[11];
} else {
$snmp_community = $snmp[5];
}
// process INDEX requests
if ($cmd == 'index') {
$arr_index = get_indexes($hostname, $snmp_community, $snmp_version, $snmp_auth_username, $snmp_auth_password, $snmp_auth_protocol, $snmp_priv_passphrase, $snmp_priv_protocol, $snmp_context, $snmp_port, $snmp_timeout, $snmp_retries, $max_oids);
for ($i = 0; ($i < cacti_sizeof($arr_index)); $i++) {
print $arr_index[$i] . PHP_EOL;
}
// process NUM_INDEXES requests
} elseif ($cmd == 'num_indexes') {
$arr_index = get_indexes($hostname, $snmp_community, $snmp_version, $snmp_auth_username, $snmp_auth_password, $snmp_auth_protocol, $snmp_priv_passphrase, $snmp_priv_protocol, $snmp_context, $snmp_port, $snmp_timeout, $snmp_retries, $max_oids);
print cacti_sizeof($arr_index) . PHP_EOL;
// process QUERY requests
} elseif ($cmd == 'query') {
$arg = $_SERVER['argv'][5];
$arr_index = get_indexes($hostname, $snmp_community, $snmp_version, $snmp_auth_username, $snmp_auth_password, $snmp_auth_protocol, $snmp_priv_passphrase, $snmp_priv_protocol, $snmp_context, $snmp_port, $snmp_timeout, $snmp_retries, $max_oids);
$arr = get_cpu_usage($hostname, $snmp_community, $snmp_version, $snmp_auth_username, $snmp_auth_password, $snmp_auth_protocol, $snmp_priv_passphrase, $snmp_priv_protocol, $snmp_context, $snmp_port, $snmp_timeout, $snmp_retries, $max_oids);
for ($i = 0; ($i < cacti_sizeof($arr_index)); $i++) {
if ($arg == 'usage') {
print $arr_index[$i] . '!' . $arr[$i] . PHP_EOL;
} elseif ($arg == 'index') {
print $arr_index[$i] . '!' . $arr_index[$i] . PHP_EOL;
}
}
} elseif ($cmd == 'get') {
$arg = $_SERVER['argv'][5];
$index = $_SERVER['argv'][6];
$arr_index = get_indexes($hostname, $snmp_community, $snmp_version, $snmp_auth_username, $snmp_auth_password, $snmp_auth_protocol, $snmp_priv_passphrase, $snmp_priv_protocol, $snmp_context, $snmp_port, $snmp_timeout, $snmp_retries, $max_oids);
$arr = get_cpu_usage($hostname, $snmp_community, $snmp_version, $snmp_auth_username, $snmp_auth_password, $snmp_auth_protocol, $snmp_priv_passphrase, $snmp_priv_protocol, $snmp_context, $snmp_port, $snmp_timeout, $snmp_retries, $max_oids);
if (isset($arr_index[$index])) {
print $arr[$index];
} else {
// Index absent — return U so RRDtool records an unknown sample.
print 'U';
}
}
function get_cpu_usage(string $hostname, string $snmp_community, int $snmp_version, string $snmp_auth_username, string $snmp_auth_password,
string $snmp_auth_protocol, string $snmp_priv_passphrase, string $snmp_priv_protocol, string $snmp_context, int $snmp_port,
int $snmp_timeout, int $snmp_retries, int $max_oids) : array {
$arr = reindex(cacti_snmp_walk($hostname, $snmp_community, '.1.3.6.1.2.1.25.3.3.1', $snmp_version, $snmp_auth_username, $snmp_auth_password, $snmp_auth_protocol, $snmp_priv_passphrase, $snmp_priv_protocol, $snmp_context, $snmp_port, $snmp_timeout, $snmp_retries, $max_oids, SNMP_POLLER));
$return_arr = [];
$j = 0;
for ($i = 0; ($i < cacti_sizeof($arr)); $i++) {
if (preg_match('/^[0-9]+$/', $arr[$i])) {
$return_arr[$j] = $arr[$i];
$j++;
}
}
return $return_arr;
}
function get_indexes(string $hostname, string $snmp_community, int $snmp_version, string $snmp_auth_username, string $snmp_auth_password,
string $snmp_auth_protocol, string $snmp_priv_passphrase, string $snmp_priv_protocol, string $snmp_context, int $snmp_port,
int $snmp_timeout, int $snmp_retries, int $max_oids) : array {
$arr = reindex(cacti_snmp_walk($hostname, $snmp_community, '.1.3.6.1.2.1.25.3.3.1', $snmp_version, $snmp_auth_username, $snmp_auth_password, $snmp_auth_protocol, $snmp_priv_passphrase, $snmp_priv_protocol, $snmp_context, $snmp_port, $snmp_timeout, $snmp_retries, $max_oids, SNMP_POLLER));
$return_arr = [];
$j = 0;
for ($i = 0; ($i < cacti_sizeof($arr)); $i++) {
if (preg_match('/^[0-9]+$/', $arr[$i])) {
$return_arr[$j] = $j;
$j++;
}
}
return $return_arr;
}
function reindex(array $arr) : array {
$return_arr = [];
for ($i = 0; ($i < cacti_sizeof($arr)); $i++) {
$return_arr[$i] = $arr[$i]['value'];
}
return $return_arr;
}