Files
cacti/scripts/ss_gexport.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

100 lines
3.2 KiB
PHP
Executable File

#!/usr/bin/env 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);
if (!isset($called_by_script_server)) {
include_once(__DIR__ . '/../include/cli_check.php');
array_shift($_SERVER['argv']);
print call_user_func_array('ss_gexport', $_SERVER['argv']);
}
function ss_gexport(string $cmd = 'index', string $arg1 = '', string $arg2 = '') : mixed {
if ($cmd == 'index') {
if (db_table_exists('graph_exports')) {
$exports = db_fetch_assoc('SELECT id FROM graph_exports ORDER BY id');
if (cacti_sizeof($exports)) {
foreach ($exports as $export) {
print $export['id'] . PHP_EOL;
}
}
}
} elseif ($cmd == 'query') {
$arg = $arg1;
if ($arg1 == 'exportId') {
if (db_table_exists('graph_exports')) {
$arr = db_fetch_assoc('SELECT id FROM graph_exports ORDER BY id');
if (cacti_sizeof($arr)) {
foreach ($arr as $item) {
print $item['id'] . '!' . $item['id'] . PHP_EOL;
}
}
}
} elseif ($arg1 == 'exportName') {
if (db_table_exists('graph_exports')) {
$arr = db_fetch_assoc('SELECT id, name FROM graph_exports ORDER BY id');
if (cacti_sizeof($arr)) {
foreach ($arr as $item) {
print $item['id'] . '!' . $item['name'] . PHP_EOL;
}
}
}
}
} elseif ($cmd == 'get') {
$arg = $arg1;
$index = $arg2;
$value = 'U';
if (db_table_exists('graph_exports')) {
switch($arg) {
case 'lastRuntime':
$value = db_fetch_cell_prepared('SELECT last_runtime
FROM graph_exports
WHERE id = ?',
[$index]);
break;
case 'totalGraphs':
$value = db_fetch_cell_prepared('SELECT total_graphs
FROM graph_exports
WHERE id = ?',
[$index]);
break;
}
}
return ($value === '' || $value === false || $value === null ? 'U' : $value);
}
return 'U';
}