poller_intropage.php

<?php
/* vim: ts=4
 +-------------------------------------------------------------------------+
 | Copyright (C) 2004-2026 The Cacti Group, Inc.                           |
 | Copyright (C) 2004-2025 Petr Macek                                      |
 |                                                                         |
 | 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.   |
 +-------------------------------------------------------------------------+
 | https://github.com/xmacan/                                              |
 | http://www.cacti.net/                                                   |
 +-------------------------------------------------------------------------+
*/

$dir = __DIR__;
chdir($dir);

include('../../include/cli_check.php');

global $config;

include_once($config['base_path'] . '/lib/reports.php');
include_once($config['base_path'] . '/plugins/intropage/includes/functions.php');

// let PHP run just as long as it has to
ini_set('max_execution_time', '0');

error_reporting(E_ALL);

// record the start time
$poller_start = microtime(true);
$start_date   = date('Y-m-d H:i:s');
$force        = false;
$debug        = false;
$checks       = 0;

global $config, $database_default, $purged_r, $purged_n;

$run_from_poller = true;

// process calling arguments
$parms = $_SERVER['argv'];
array_shift($parms);

if (cacti_sizeof($parms)) {
	$shortopts = 'VvHh';

	$longopts = [
		'force',
		'debug',
		'version',
		'help'
	];

	$options = getopt($shortopts, $longopts);

	foreach ($options as $arg => $value) {
		switch($arg) {
			case 'force':
				$force = true;

				break;
			case 'debug':
				$debug = true;

				break;
			case 'version':
			case 'V':
			case 'v':
				display_version();
				exit(0);
			case 'help':
			case 'H':
			case 'h':
				display_help();
				exit(0);
			default:
				print "ERROR: Invalid Argument: ($arg)" . PHP_EOL . PHP_EOL;
				display_help();
				exit(1);
		}
	}
}

intropage_debug('Intropage Starting Checks');

// silently end if the registered process is still running, or process table missing
if (function_exists('register_process_start')) {
	if (!register_process_start('intropage', 'master', $config['poller_id'], (int) read_config_option('intropage_timeout'))) {
		intropage_debug('Another Intropage Process Still Running');
		exit(0);
	}
}

// Make intropage first to gather correct stats
intropage_correct_load_order();

$stats = intropage_gather_stats();

$poller_end = microtime(true);

$pstats = 'Time:' . round($poller_end - $poller_start, 2) . ', Checks:' . $stats['checks'] . ', Panels:' . $stats['panels'] . ', Trends:' . $stats['trends'];

cacti_log('INTROPAGE STATS: ' . $pstats, false, 'SYSTEM');
set_config_option('stats_intropage', $pstats);

if (function_exists('unregister_process')) {
	unregister_process('intropage', 'master', $config['poller_id']);
}

exit(0);

/**
 * Ensures the Intropage plugin's hook execution order is first among
 * registered plugins, moving it up repeatedly until its plugin_config
 * id is 1, so its stats reflect other plugins' completed poller
 * activity. Called from this script's main flow before gathering
 * stats.
 *
 * @return void
 */
function intropage_correct_load_order(): void {
	while (true) {
		$intro_order = db_fetch_cell('SELECT id FROM plugin_config WHERE directory="intropage"');

		if ($intro_order > 1) {
			api_plugin_moveup('intropage');
		} else {
			break;
		}
	}
}

/**
 * Runs each due panel's trend-collection and data-update functions
 * (per-panel refresh/trend intervals), impersonating the owning user
 * via a faked session variable where needed, then purges old trend
 * records and refreshes the auto-refresh threshold timestamp. Called
 * from this script's main flow as the core poller collection step.
 *
 * @return array Summary counts: 'checks' (panels processed),
 *               'panels' (data-update functions run), and 'trends'
 *               (trend functions run).
 *
 * @global array $config           Cacti global configuration array
 *                                 (declared but not directly used
 *                                 here).
 * @global bool  $force            Reserved/declared for parity with
 *                                 this script's other functions; not
 *                                 used directly here.
 * @global int   $checks           Reset to 0 here, then incremented for
 *                                 each panel processed; the final
 *                                 count is included in the returned
 *                                 summary.
 * @global bool  $run_from_poller  Reserved/declared for parity with
 *                                 this script's other functions; not
 *                                 used directly here.
 */
function intropage_gather_stats(): array {
	global $config, $force, $checks, $run_from_poller;

	$logging = read_config_option('log_verbosity', true);
	$trends  = 0;
	$pdata   = 0;
	$checks  = 0;

	$panels = initialize_panel_library();

	$upanels = db_fetch_assoc('SELECT pd.panel_id, pd.name, ud.id, ud.user_id, level,
		pd.refresh, ud.refresh_interval, pd.update_func
		FROM plugin_intropage_panel_definition AS pd
		LEFT JOIN plugin_intropage_panel_data AS ud
		ON pd.panel_id = ud.panel_id
		WHERE UNIX_TIMESTAMP(last_update) < UNIX_TIMESTAMP() - refresh_interval
		OR (last_update IS NULL AND level = 0)');

	$tpanels = db_fetch_assoc('SELECT pd.panel_id, pd.name, ud.id, ud.user_id, level,
		pd.refresh, ud.trend_interval, ud.refresh_interval, pd.trends_func
		FROM plugin_intropage_panel_definition AS pd
		LEFT JOIN plugin_intropage_panel_data AS ud
		ON pd.panel_id = ud.panel_id
		WHERE UNIX_TIMESTAMP(last_trend_update) < UNIX_TIMESTAMP() - trend_interval
		AND pd.trends_func != ""
		OR (last_update IS NULL AND level = 0)');

	if (cacti_sizeof($tpanels)) {
		$done_trends = [];

		foreach ($tpanels as $panel) {
			$start = microtime(true);

			// Get trends next
			if (isset($panel['trends_func']) && $panel['trends_func'] != '' && is_panel_enabled($panel['panel_id'])) {
				$function      = $panel['trends_func'];
				$function_name = (string) $function;

				if (function_exists($function)) {
					db_execute_prepared('UPDATE plugin_intropage_panel_data
						SET last_trend_update = NOW()
						WHERE id = ?',
						[$panel['id']]);

					// we need run it only once. Example - graph host panel gathers data for all users
					if (!array_key_exists($panel['panel_id'], $done_trends)) {
						$function();
						$trends++;
					}

					$done_trends[$panel['panel_id']] = 1;

					if ($logging >= 5) {
						cacti_log(sprintf('DEBUG: gathering trend function:%s, duration:%4.3f', $function_name,  microtime(true) - $start), false, 'INTROPAGE');
					}

					intropage_debug(sprintf('gathering trend function:%s, duration:%4.3f', $function_name, microtime(true) - $start));
				} else {
					cacti_log('WARNING: Unable to find update function ' . $function . ' for panel ' . $panel['name'], false, 'INTROPAGE');
				}
			}
		}
	}

	foreach ($upanels as $upanel) {
		$start = microtime(true);

		// Fake a session variable
		if ($upanel['user_id'] > 0) {
			$_SESSION['sess_user_id'] = $upanel['user_id'];
		}

		// Required plugin is not installed, but entry not purged
		if (!isset($panels[$upanel['panel_id']])) {
			continue;
		}

		$panel = $panels[$upanel['panel_id']];

		if ($upanel['refresh_interval'] == 0) {
			db_execute_prepared('UPDATE plugin_intropage_panel_data
				SET refresh_interval = ?
				WHERE id = ?',
				[$panel['refresh'], $upanel['id']]);

			$upanel['refresh_interval'] = $panel['refresh'];
		}

		// process normal panels
		if (isset($panel['update_func']) && $panel['update_func'] != '' && is_panel_enabled($upanel['panel_id'])) {
			$qpanel = get_panel($upanel['panel_id'], $upanel['user_id']);

			$function      = $panel['update_func'];
			$function_name = (string) $function;

			if (function_exists($function)) {
				$data = $function($qpanel, $upanel['user_id']);

				if (is_string($data)) {
					cacti_log(sprintf('WARNING: Problem with data gathering, function %s, returned (string) %s', $function_name, $data), false, 'INTROPAGE');
				} elseif (is_int($data) && $data != 0) {
					cacti_log(sprintf('WARNING: Problem with data gathering, function %s, returned (int) %d', $function_name, $data), false, 'INTROPAGE');
				}

				if ($logging >= 5) {
					cacti_log(sprintf('DEBUG: gathering data function:%s, duration:%4.3f', $function_name,  microtime(true) - $start), false, 'INTROPAGE');
				}

				intropage_debug(sprintf('gathering data function:%s, duration:%4.3f', $function_name, microtime(true) - $start));
			} else {
				cacti_log('WARNING: Unable to find update function ' . $function . ' for panel ' . $panel['name'], false, 'INTROPAGE');
			}

			$pdata++;
		}

		$checks++;
	}

	// end of gathering data

	// cleaning old data
	intropage_debug('Purging old Intropage Trends');

	db_execute("DELETE FROM plugin_intropage_trends
		WHERE cur_timestamp < date_sub(now(), INTERVAL 2 DAY) AND
		name IN (
			'poller', 'cpuload', 'failed_polls', 'thold_trig', 'thold_brea', 'thold_disa',
			'host_down', 'host_reco', 'host_disa',
			'poller_output',
			'syslog_incoming', 'syslog_total', 'syslog_alert', 'syslog_levels',
			'dsstats_all', 'dsstats_null', 'boost_mem_size', 'boost_pending'
		)");

	// automatic autorefresh
	intropage_debug('Checking Triggered Thresholds');

	db_execute("UPDATE plugin_intropage_trends
		SET cur_timestamp = now()
		WHERE name = 'ar_poller_finish'");

	return ['checks' => $checks, 'panels' => $pdata, 'trends' => $trends];
}

/**
 * Prints a debug message to stdout when CLI debug output is enabled.
 * Called throughout this script to report collection progress.
 *
 * @param string $message The debug message to print.
 *
 * @return void
 *
 * @global bool $debug Whether debug output ('--debug' CLI flag) is
 *                     enabled; when false, this function is a no-op.
 */
function intropage_debug(string $message): void {
	global $debug;

	if ($debug) {
		print trim($message) . PHP_EOL;
	}
}

/**
 * Prints this poller script's version and copyright banner, loading the
 * plugin's version info from setup.php if not already available. Called
 * from display_help() and when invoked with '--version'/'-v'/'-V'.
 *
 * @return void
 *
 * @global array $config Cacti global configuration array; used to
 *                       locate and include setup.php.
 */
function display_version(): void {
	global $config;

	if (!function_exists('plugin_intropage_version')) {
		include_once($config['base_path'] . '/plugins/intropage/setup.php');
	}

	$info = plugin_intropage_version();
	print 'Cacti Intropage Poller, Version ' . $info['version'] . ', ' . COPYRIGHT_YEARS . PHP_EOL;
}

/*
 * display_help
 * displays the usage of the function
 */
/**
 * Prints the version banner followed by this script's command-line
 * usage summary. Called when invoked with '--help'/'-h'/'-H' or with
 * an invalid argument.
 *
 * @return void
 */
function display_help(): void {
	display_version();

	print PHP_EOL;
	print 'usage: poller_intropage.php [--force] [--debug]' . PHP_EOL . PHP_EOL;
	print '  --force       - force execution, e.g. for testing' . PHP_EOL;
	print '  --debug       - debug execution, e.g. for testing' . PHP_EOL . PHP_EOL;
}