mirror of
https://github.com/Cacti/cacti.git
synced 2026-10-23 03:27:02 +09:00
* PHPStan Level 8 - Phase 1 Conversion
Reduces the real (no-baseline) PHPStan level 8 error count from ~2,724 to 425
and regenerates phpstan-baseline.neon accordingly (8,941 -> 1,921 lines).
Core type-safety changes
- lib/database.php: narrow db_fetch_row()/db_fetch_row_prepared() to return
array (was bool|array) and db_fetch_assoc()/db_fetch_assoc_prepared() to
return array (was mixed); the _prepared workers coerce the connection-failure
path to an empty array so the declared type is honest. empty()/cacti_sizeof()
checks are unaffected.
- lib/database.php: narrow $db_conn guards from is_object() to instanceof PDO in
the transaction/quote/insert-id helpers so the PDO calls resolve.
- lib/mib_cache.php: the fluent MibCache methods mib()/object()/table()/row()
now return self instead of a bare object so chained calls type-check.
Type-safety casts and guards (mechanical, behaviour-preserving)
- Cast string|false/|null builtin results feeding string parameters
(json_decode, base64_encode, trim, htmle, preg_replace, explode, etc.).
- Cast int|string / int|false values feeding int id/pid parameters.
- Guard resource|false fopen()/popen() handles before fwrite/fclose/fread, and
wrap foreach over array|false/list|false results with `?: []`.
Genuine bugs found and fixed
- cli/add_tree.php / lib/api_tree.php: site tree nodes could not be created via
the CLI - the --site-id option was never parsed, $nodeTypes had no 'site'
entry (passing null to api_tree_item_save(int $type) -> TypeError), and
api_tree_item_save() never persisted site_id. All three fixed.
- tree.php: leaves_exist() is typed : int but returned db_fetch_assoc_prepared()
(an array of rows) for a SELECT COUNT(*); now uses db_fetch_cell_prepared()
and returns the scalar count.
- lib/mib_cache.php: $entries_per_object was a float (division / ceil) used as
an array key (PHP 8.1 implicit float-to-int key deprecation); now cast to int.
Config
- .phpstan.neon: add notIdentical.alwaysTrue and booleanAnd.alwaysFalse to the
existing always-true/false ignore family (same "PHPStan gets confused"
dynamic-constant cause already covered by identical.alwaysTrue,
notEqual.alwaysTrue, booleanAnd.leftAlwaysTrue, etc.).
- phpstan-baseline.neon: regenerated; the remaining 425 entries are the
untouched long tail for Phase 2.
* Remove redundant @phpstan-ignore comments
Follow-up cleanup for the level 8 Phase 1 work. Removes 14 inline
@phpstan-ignore comments that no longer suppress any reported error:
- cli/repair_database.php: `@phpstan-ignore booleanAnd.alwaysFalse` is now
covered by the global booleanAnd.alwaysFalse ignore added to .phpstan.neon.
- 13 others (host.php, include/global.php, include/session.php,
lib/api_automation.php x2, lib/functions.php x2, lib/html_utility.php x2,
lib/installer.php, lib/package.php, lib/reports.php, lib/rrd.php) no longer
match any reported error after the type-safety fixes (e.g. the
db_fetch_row_prepared() return-type narrowing removed the offset-assign
errors the api_automation ignores were suppressing).
Verified with reportUnmatchedIgnoredErrors enabled: 0 unmatched ignores
remain and the full level 8 run still reports 0 errors.
* ci: satisfy validator ratchet and refresh security sink baselines
- lib/api_tree.php: give the new tree-item site_id a real numeric
constraint ('^[-0-9]+$', matching html_reports.php) instead of an
empty regex, so the validator constraint ratchet passes without
bumping its baseline.
- tests/security/baselines: refresh the three sink/hotspot signatures
whose code text changed from the (string) casts added in this branch
(lib/poller.php setsid, cli/rrdresize.php json_encode, lib/import.php
simplexml_load_string).
* ci(js): allow DOMPurify 3.4.16 and update sync_js pin test
The dependabot bump (#8134) moved package.json/package-lock.json to
DOMPurify 3.4.16 on develop but left tests/js/sync_js.test.mjs pinned to
3.4.15, so the PR merge commit fails the 'DOMPurify is pinned' contract.
Bring package.json/package-lock.json to 3.4.16 (matching develop) and
update the pin test to expect 3.4.16.
* test: update sql.php null-handling assertion for the (string) cast
This branch changed scripts/sql.php from trim(\ ?? '') to
trim((string) \) (the phpstan-safe form that coerces both null and
false from shell_exec()). Update SqlScriptsTest's null-return assertion
to match the new cast instead of the removed '?? ''.
* fix: address Copilot review - ownership IDs, fopen guards, mib_cache bound
- chown()/chgrp(): pass integer UID/GID from fileowner()/filegroup()
(guarding the false lookup) instead of string-casting them, which made
them resolve account/group names like '1001' and fail. Covers
lib/api_device.php, lib/boost.php and poller_maintenance.php (x2).
- fopen() failure now short-circuits instead of reporting success:
lib/package.php returns false, lib/clog_webapi.php and utilities.php
render an error, and snmpagent_mibcachechild.php skips the cache write
and sentinel unlink so a concurrent writer's lock is preserved.
- lib/mib_cache.php: keep the float quotient as the loop bound and cast
only the array offset, so a non-even entries/columns split no longer
truncates the loop and drops a cached row.
* revert: keep db_fetch_* returning false on error; baseline Level 8 instead
Per review, restoring the intentional fail-safe: db_fetch_row[_prepared]()
return bool|array and db_fetch_assoc[_prepared]() return mixed again, so a
genuine SQL error (not just a missing connection) is signalled as false and
the === false checks in cdef_is_in_use(), boost_process_* and aggregate.php
work as before. Dropped the is_array() ? : [] coercion.
Level 8 stays green by regenerating phpstan-baseline.neon to capture the
re-introduced bool|array/mixed call-site errors (the ~1,850 the narrowing
had eliminated). Tightening those callers to drop them from the baseline is
Phase 2 work.
---------
Co-authored-by: TheWitness <copilot@users.noreply.github.com>
354 lines
10 KiB
PHP
354 lines
10 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/ |
|
|
+-------------------------------------------------------------------------+
|
|
*/
|
|
|
|
// since we'll have additional headers, tell php when to flush them
|
|
ob_start();
|
|
|
|
$guest_account = true;
|
|
$auth_json = true;
|
|
$gtype = 'png';
|
|
|
|
require('./include/auth.php');
|
|
require_once(CACTI_PATH_LIBRARY . '/rrd.php');
|
|
|
|
api_plugin_hook_function('graph_image');
|
|
|
|
// set the json variable for request validation handling
|
|
srv('json', true);
|
|
|
|
// ================= input validation =================
|
|
gfrv('graph_start');
|
|
gfrv('graph_end');
|
|
gfrv('graph_height');
|
|
gfrv('graph_width');
|
|
gfrv('local_graph_id');
|
|
|
|
if (isrv('graph_nolegend')) {
|
|
srv('graph_nolegend', 'true');
|
|
}
|
|
|
|
gfrv('graph_theme', FILTER_CALLBACK, ['options' => 'sanitize_search_string']);
|
|
|
|
cacti_session_close();
|
|
|
|
$graph_data_array = [];
|
|
|
|
// override: graph start time (unix time)
|
|
if (!ierv('graph_start') && grv('graph_start') < FILTER_VALIDATE_MAX_DATE_AS_INT) {
|
|
$graph_data_array['graph_start'] = grv('graph_start');
|
|
}
|
|
|
|
// override: graph end time (unix time)
|
|
if (!ierv('graph_end') && grv('graph_end') < FILTER_VALIDATE_MAX_DATE_AS_INT) {
|
|
$graph_data_array['graph_end'] = grv('graph_end');
|
|
}
|
|
|
|
// override: graph height (in pixels)
|
|
if (!ierv('graph_height') && grv('graph_height') < 3000) {
|
|
$graph_data_array['graph_height'] = grv('graph_height');
|
|
}
|
|
|
|
// override: graph width (in pixels)
|
|
if (!ierv('graph_width') && grv('graph_width') < 3000) {
|
|
$graph_data_array['graph_width'] = grv('graph_width');
|
|
}
|
|
|
|
// override: skip drawing the legend?
|
|
if (!ierv('graph_nolegend')) {
|
|
$graph_data_array['graph_nolegend'] = grv('graph_nolegend');
|
|
}
|
|
|
|
// print RRDtool graph source?
|
|
if (!ierv('show_source')) {
|
|
$graph_data_array['print_source'] = grv('show_source');
|
|
}
|
|
|
|
// disable cache check
|
|
if (isrv('disable_cache')) {
|
|
$graph_data_array['disable_cache'] = true;
|
|
}
|
|
|
|
// set the theme
|
|
if (isrv('graph_theme')) {
|
|
$graph_data_array['graph_theme'] = cacti_validate_theme(grv('graph_theme'));
|
|
}
|
|
|
|
if (isrv('rra_id')) {
|
|
if (gnrv('rra_id') == 'all') {
|
|
$rra_id = 'all';
|
|
} else {
|
|
$rra_id = gfrv('rra_id');
|
|
}
|
|
} else {
|
|
$rra_id = null;
|
|
}
|
|
|
|
$graph_data_array['graphv'] = true;
|
|
|
|
// Determine the graph type of the output
|
|
if (!isrv('image_format')) {
|
|
$type = db_fetch_cell_prepared('SELECT image_format_id
|
|
FROM graph_templates_graph
|
|
WHERE local_graph_id = ?',
|
|
[grv('local_graph_id')]);
|
|
|
|
switch($type) {
|
|
case '1':
|
|
$gtype = 'png';
|
|
|
|
break;
|
|
case '3':
|
|
$gtype = 'svg+xml';
|
|
|
|
break;
|
|
default:
|
|
$gtype = 'png';
|
|
|
|
break;
|
|
}
|
|
} else {
|
|
switch(cacti_strtolower(gnrv('image_format'))) {
|
|
case 'png':
|
|
$graph_data_array['image_format'] = 'png';
|
|
|
|
break;
|
|
case 'svg':
|
|
$gtype = 'svg+xml';
|
|
|
|
break;
|
|
default:
|
|
$gtype = 'png';
|
|
|
|
break;
|
|
}
|
|
}
|
|
|
|
$graph_data_array['image_format'] = $gtype;
|
|
|
|
if (POLLER_ID == 1 || read_config_option('storage_location')) { // @phpstan-ignore-line
|
|
$xport_meta = [];
|
|
|
|
$output = rrdtool_function_graph(grv('local_graph_id'), $rra_id, $graph_data_array, null, $xport_meta, $_SESSION[SESS_USER_ID]);
|
|
|
|
ob_end_clean();
|
|
} else {
|
|
if (isrv('rra_id')) {
|
|
if (gnrv('rra_id') == 'all') {
|
|
$rra_id = 'all';
|
|
} else {
|
|
$rra_id = gfrv('rra_id');
|
|
}
|
|
}
|
|
|
|
// get the theme
|
|
if (!isrv('graph_theme')) {
|
|
$graph_data_array['graph_theme'] = cacti_validate_theme(get_selected_theme());
|
|
}
|
|
|
|
if (isset($_SESSION[SESS_USER_ID])) {
|
|
$graph_data_array['effective_user'] = $_SESSION[SESS_USER_ID];
|
|
}
|
|
|
|
$url = CACTI_PATH_URL . 'remote_agent.php?action=graph_json';
|
|
$url .= '&local_graph_id=' . grv('local_graph_id');
|
|
$url .= '&rra_id=' . $rra_id;
|
|
|
|
foreach ($graph_data_array as $variable => $value) {
|
|
$url .= '&' . rawurlencode((string)$variable) . '=' . rawurlencode((string)$value);
|
|
}
|
|
|
|
$output = call_remote_data_collector(1, $url);
|
|
}
|
|
|
|
$oarray = ['type' => $gtype, 'local_graph_id' => grv('local_graph_id'), 'rra_id' => $rra_id];
|
|
|
|
if ($output !== false && $output != '') {
|
|
$decoded = remote_graph_json_envelope($output);
|
|
|
|
if (is_array($decoded)) {
|
|
unset($decoded['type'], $decoded['local_graph_id'], $decoded['rra_id']);
|
|
$oarray = array_merge($decoded, $oarray);
|
|
// No further parsing needed if it was already JSON
|
|
} elseif (str_contains($output, 'image = ')) {
|
|
// Find the beginning of the image definition row
|
|
$image_begin_pos = strpos($output, 'image = ');
|
|
|
|
// Parse and populate everything before the image definition row
|
|
if ($image_begin_pos > 0) {
|
|
$header_lines = explode("\n", substr($output, 0, $image_begin_pos));
|
|
} else {
|
|
$header_lines = [];
|
|
}
|
|
|
|
// Check for additional data points from graphv output
|
|
$graph_start_pos = strpos($output, 'graph_start =', (int) $image_begin_pos);
|
|
|
|
if (!$graph_start_pos) {
|
|
// Find the end of the line of the image definition row, after this the raw image data will come
|
|
$image_data_line_end = strpos($output, "\n", (int) $image_begin_pos);
|
|
|
|
if ($image_data_line_end !== false) {
|
|
$image_data_pos = $image_data_line_end + 1;
|
|
|
|
// Insert the raw image data to the array
|
|
$oarray['image'] = base64_encode(substr($output, $image_data_pos));
|
|
}
|
|
} else {
|
|
// Find the end of the line of the image definition row, after this the raw image data will come
|
|
$image_data_line_end = strpos($output, "\n", (int) $image_begin_pos);
|
|
|
|
if ($image_data_line_end !== false) {
|
|
$image_data_pos = $image_data_line_end + 1;
|
|
|
|
// Insert the raw image data to the array
|
|
$oarray['image'] = base64_encode(substr($output, $image_data_pos, $graph_start_pos - $image_data_pos));
|
|
}
|
|
|
|
// Get the datapoints to the end of the file.
|
|
$datapoints_start_pos = strpos($output, 'datapoints =');
|
|
|
|
if ($datapoints_start_pos !== false) {
|
|
$datapoints = substr($output, $datapoints_start_pos);
|
|
|
|
// Get rid of the 'datapoints =' line
|
|
$dp_output = explode("\n", $datapoints);
|
|
unset($dp_output[0]);
|
|
|
|
$datapoints = json_decode(implode("\n", $dp_output), true);
|
|
|
|
if (is_array($datapoints)) {
|
|
foreach ($datapoints as $name => $value) {
|
|
$oarray[$name] = $value;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
foreach ($header_lines as $line) {
|
|
if (str_contains($line, ' = ')) {
|
|
$parts = explode(' = ', $line);
|
|
$oarray[$parts[0]] = trim($parts[1]);
|
|
}
|
|
}
|
|
} else {
|
|
$output = false;
|
|
}
|
|
}
|
|
|
|
if ($output !== false && $output != '') {
|
|
if (isset($oarray['meta'])) {
|
|
foreach ($oarray['meta']['legend'] as $key => $value) {
|
|
$legend = trim(preg_replace('/[^a-z0-9 _()]/i', '', $value));
|
|
|
|
if ($legend) {
|
|
$color = (isset($xport_meta['legend'][$legend])) ? $xport_meta['legend'][$legend] : '';
|
|
$oarray['meta']['legend'][$key] = ['legend' => $legend, 'color' => $color];
|
|
} else {
|
|
unset($oarray['meta']['legend'][$key]);
|
|
}
|
|
}
|
|
}
|
|
|
|
$replacement_legend = rrdtool_replacement_legend(grv('local_graph_id'));
|
|
|
|
if (cacti_sizeof($replacement_legend) && isset($oarray['meta']['legend'])) {
|
|
$oarray['meta']['legend'] = $replacement_legend;
|
|
}
|
|
|
|
/**
|
|
* remove the unknown data and business hours columns from the
|
|
* output data as it interferes with the hover output.
|
|
*/
|
|
if (isset($oarray['data']) && isset($xport_meta['ignoreItems'])) {
|
|
$new_array = [];
|
|
|
|
foreach ($oarray['data'] as $index => $data) {
|
|
foreach ($data as $i => $value) {
|
|
if ($i == 0 || $i > $xport_meta['ignoreItems']) {
|
|
$new_array[$index][] = $value;
|
|
}
|
|
}
|
|
}
|
|
|
|
$oarray['data'] = $new_array;
|
|
}
|
|
} else {
|
|
// image type now png
|
|
$oarray['type'] = 'png';
|
|
|
|
ob_start();
|
|
|
|
$graph_data_array['get_error'] = true;
|
|
|
|
$null_param = [];
|
|
|
|
rrdtool_function_graph(grv('local_graph_id'), $rra_id, $graph_data_array, null, $null_param, $_SESSION[SESS_USER_ID]);
|
|
|
|
$error = ob_get_contents();
|
|
|
|
ob_end_clean();
|
|
|
|
if (read_config_option('stats_poller') == '') {
|
|
$error = __('The Cacti Poller has not run yet.');
|
|
}
|
|
|
|
if (isset($graph_data_array['graph_width']) && isset($graph_data_array['graph_height'])) {
|
|
$image = rrdtool_create_error_image((string) $error, $graph_data_array['graph_width'], $graph_data_array['graph_height']);
|
|
} else {
|
|
$image = rrdtool_create_error_image((string) $error);
|
|
}
|
|
|
|
if (isset($graph_data_array['graph_width'])) {
|
|
if (isset($graph_data_array['graph_nolegend'])) {
|
|
$oarray['image_width'] = round($graph_data_array['graph_width'] * 1.24, 0);
|
|
$oarray['image_height'] = round($graph_data_array['graph_height'] * 1.45, 0);
|
|
} else {
|
|
$oarray['image_width'] = round($graph_data_array['graph_width'] * 1.15, 0);
|
|
$oarray['image_height'] = round($graph_data_array['graph_height'] * 1.8, 0);
|
|
}
|
|
} else {
|
|
$oarray['image_width'] = round(db_fetch_cell_prepared('SELECT width
|
|
FROM graph_templates_graph
|
|
WHERE local_graph_id = ?',
|
|
[grv('local_graph_id')]), 0);
|
|
|
|
$oarray['image_height'] = round(db_fetch_cell_prepared('SELECT height
|
|
FROM graph_templates_graph
|
|
WHERE local_graph_id = ?',
|
|
[grv('local_graph_id')]), 0);
|
|
}
|
|
|
|
if ($image != false) {
|
|
$oarray['image'] = base64_encode($image);
|
|
} else {
|
|
$oarray['image'] = base64_encode((string) file_get_contents(__DIR__ . '/images/cacti_error_image.png'));
|
|
}
|
|
}
|
|
|
|
header('Content-Type: application/json');
|
|
header('Cache-Control: max-age=15');
|
|
$json = json_encode($oarray);
|
|
header('Content-Length: ' . strlen((string) $json));
|
|
print $json;
|