setup.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/                                                   |
 +-------------------------------------------------------------------------+
*/

/**
 * Return the CSP nonce attribute for inline <script> tags, safely across
 * Cacti versions. Newer Cacti releases enforce a Content-Security-Policy that
 * requires a per-request nonce on parser-inserted scripts; older releases lack
 * the CactiSecureHeaders class, so this returns an empty string there.
 *
 * @return string The nonce attribute when supported, otherwise empty string.
 */
function plugin_servcheck_csp_nonce(): string {
	if (class_exists('CactiSecureHeaders')) {
		return CactiSecureHeaders::getNonceAttribute();
	}

	return '';
}

/**
 * Registers this plugin's Cacti hooks (navigation breadcrumbs, config
 * arrays, poller_bottom, data source replication, settings, page_head)
 * and its servcheck_*.php realm, then creates the plugin's database
 * tables. Invoked by the Cacti plugin framework when the plugin is
 * installed/enabled.
 *
 * @return void
 */
function plugin_servcheck_install(): void {
	api_plugin_register_hook('servcheck', 'draw_navigation_text', 'plugin_servcheck_draw_navigation_text', 'setup.php');
	api_plugin_register_hook('servcheck', 'config_arrays',        'plugin_servcheck_config_arrays',        'setup.php');
	api_plugin_register_hook('servcheck', 'poller_bottom',        'plugin_servcheck_poller_bottom',        'setup.php');
	api_plugin_register_hook('servcheck', 'replicate_out',        'servcheck_replicate_out',               'setup.php');
	api_plugin_register_hook('servcheck', 'config_settings',      'servcheck_config_settings',             'setup.php');
	api_plugin_register_hook('servcheck', 'page_head',            'servcheck_page_head',                   'setup.php');

	api_plugin_register_realm('servcheck', 'servcheck_test.php,servcheck_restapi.php,servcheck_credential.php,servcheck_curl_code.php,servcheck_proxy.php,servcheck_ca.php', __('Service Check Admin', 'servcheck'), 1);

	plugin_servcheck_setup_table();
}

/**
 * Drops all of this plugin's database tables. Invoked by the Cacti
 * plugin framework when the plugin is uninstalled.
 *
 * @return void
 */
function plugin_servcheck_uninstall(): void {
	db_execute('DROP TABLE IF EXISTS plugin_servcheck_test');
	db_execute('DROP TABLE IF EXISTS plugin_servcheck_log');
	db_execute('DROP TABLE IF EXISTS plugin_servcheck_proxies');
	db_execute('DROP TABLE IF EXISTS plugin_servcheck_proxy');
	db_execute('DROP TABLE IF EXISTS plugin_servcheck_processes');
	db_execute('DROP TABLE IF EXISTS plugin_servcheck_contacts');
	db_execute('DROP TABLE IF EXISTS plugin_servcheck_ca');
	db_execute('DROP TABLE IF EXISTS plugin_servcheck_restapi_method');
	db_execute('DROP TABLE IF EXISTS plugin_servcheck_credential');
}

/**
 * Runs any pending database schema upgrade for this plugin. Invoked by
 * plugin_servcheck_config_arrays() (the 'config_arrays' hook) only when
 * the current page is index.php, plugins.php, or servcheck_test.php -
 * not on every page load.
 *
 * @return bool Always true.
 */
function plugin_servcheck_check_config(): bool {
	// Here we will check to ensure everything is configured
	plugin_servcheck_upgrade();

	return true;
}

/**
 * Applies version-gated schema migrations for this plugin based on
 * comparing the installed version recorded in plugin_config against the
 * current INFO file version. Called from
 * plugin_servcheck_check_config(), which is itself only invoked when
 * the current page is index.php, plugins.php, or servcheck_test.php.
 *
 * @return bool Always true after completing the migration.
 *
 * @global array $config Cacti global configuration array (declared but
 *                       not directly used here).
 */
function plugin_servcheck_upgrade(): bool {
	global $config;

	require_once(__DIR__ . '/includes/functions.php');

	$info = plugin_servcheck_version();
	$new  = $info['version'];
	$old  = db_fetch_cell('SELECT version FROM plugin_config WHERE directory="servcheck"');

	// Nothing to do when the recorded version already matches the code. This
	// guard is important: plugin_servcheck_config_arrays() reaches this function
	// on every index.php/plugins.php/servcheck_test.php load, and the hook
	// re-registration below calls api_plugin_replicate_config() -> replicate_out(),
	// which fatals when core lib/poller.php is not loaded on that request.
	if ($old == $new) {
		return true;
	}

	db_execute_prepared('UPDATE plugin_realms
		SET file = ?
		WHERE file LIKE "%servcheck_test.php%"',
		['servcheck_test.php,servcheck_restapi.php,servcheck_credential.php,servcheck_curl_code.php,servcheck_proxy.php,servcheck_ca.php']);

	// Registering the replicate_out hook makes api_plugin_register_hook() call
	// api_plugin_replicate_config() -> replicate_out(), which lives in core
	// lib/poller.php and is not otherwise loaded on these pages.
	if (!function_exists('replicate_out')) {
		if (defined('CACTI_PATH_LIBRARY') && file_exists(CACTI_PATH_LIBRARY . '/poller.php')) {
			include_once(CACTI_PATH_LIBRARY . '/poller.php');
		} elseif (isset($config['library_path']) && file_exists($config['library_path'] . '/poller.php')) {
			include_once($config['library_path'] . '/poller.php');
		}
	}

	api_plugin_register_hook('servcheck', 'replicate_out', 'servcheck_replicate_out', 'setup.php', true);
	api_plugin_register_hook('servcheck', 'config_settings', 'servcheck_config_settings', 'setup.php', true);

	// Register page_head here as well so installs that predate this hook pick it
	// up on upgrade and load the plugin's stylesheets.
	api_plugin_register_hook('servcheck', 'page_head', 'servcheck_page_head', 'setup.php');

	if (cacti_version_compare($old, '0.3', '<')) {
		if (!db_column_exists('plugin_servcheck_test', 'ipaddress')) {
			db_add_column('plugin_servcheck_test', ['name' => 'ipaddress', 'type' => 'varchar(46)', 'NULL' => false, 'default' => '', 'after' => 'hostname']);
		}

		if (!db_column_exists('plugin_servcheck_test', 'external_id')) {
			db_add_column('plugin_servcheck_test', ['name' => 'external_id', 'type' => 'varchar(20)', 'NULL' => false, 'default' => '', 'after' => 'notes']);
		}

		db_execute('DROP TABLE IF EXISTS plugin_servcheck_contacts');

		// 0.3 contains a lot of changes. I tried to convert old data but for sure make a backup

		db_execute('CREATE TABLE plugin_servcheck_test_backup AS SELECT * FROM plugin_servcheck_test');
		db_execute('CREATE TABLE plugin_servcheck_log_backup AS SELECT * FROM plugin_servcheck_log');
		db_execute('CREATE TABLE plugin_servcheck_proxies_backup AS SELECT * FROM plugin_servcheck_proxies');

		if (db_table_exists('plugin_servcheck_restapi_method')) {
			db_execute('CREATE TABLE plugin_servcheck_restapi_method_backup AS SELECT * FROM plugin_servcheck_restapi_method');
		}

		if (db_column_exists('plugin_servcheck_test', 'display_name')) {
			db_execute('ALTER TABLE plugin_servcheck_test RENAME COLUMN display_name TO name');
		}

		if (db_column_exists('plugin_servcheck_test', 'ca')) {
			db_execute('ALTER TABLE plugin_servcheck_test RENAME COLUMN ca TO ca_id');
		}

		if (db_column_exists('plugin_servcheck_test', 'proxy_server')) {
			db_execute('ALTER TABLE plugin_servcheck_test RENAME COLUMN proxy_server TO proxy_id');
		}

		if (db_column_exists('plugin_servcheck_test', 'timeout_trigger')) {
			db_execute('ALTER TABLE plugin_servcheck_test RENAME COLUMN timeout_trigger TO duration_trigger');
			db_execute('ALTER TABLE plugin_servcheck_test MODIFY duration_trigger decimal(4,2) default "0"');
		}

		api_plugin_db_add_column('servcheck', 'plugin_servcheck_test', ['name' => 'duration_count', 'type' => 'int(3)', 'NULL' => false, 'unsigned' => true, 'default' => '3', 'after' => 'duration_trigger']);
		api_plugin_db_add_column('servcheck', 'plugin_servcheck_test', ['name' => 'snmp_oid', 'type' => 'varchar(255)', 'NULL' => false, 'default' => '']);
		api_plugin_db_add_column('servcheck', 'plugin_servcheck_test', ['name' => 'ssh_command', 'type' => 'varchar(255)', 'NULL' => false, 'default' => '']);
		api_plugin_db_add_column('servcheck', 'plugin_servcheck_test', ['name' => 'cred_id', 'type' => 'int(11)', 'NULL' => false, 'unsigned' => true, 'default' => '0']);
		api_plugin_db_add_column('servcheck', 'plugin_servcheck_test', ['name' => 'triggered_duration', 'type' => 'int(11)', 'NULL' => false, 'unsigned' => true, 'default' => '0']);
		db_add_column('plugin_servcheck_test', ['name' => 'attempt', 'type' => 'int(2)', 'NULL' => false, 'default' => '3', 'after' => 'type']);
		db_add_column('plugin_servcheck_test', ['name' => 'notify', 'type' => 'char(2)', 'NULL' => false, 'default' => 'on']);

		db_execute('ALTER TABLE plugin_servcheck_log MODIFY curl_return_code int(3) default NULL');
		db_execute('ALTER TABLE plugin_servcheck_log MODIFY cert_expire timestamp default "0000-00-00 00:00:00"');
		db_add_column('plugin_servcheck_log', ['name' => 'attempt', 'type' => 'int(2)', 'NULL' => false, 'default' => '0', 'after' => 'enabled']);

		$exist = db_fetch_cell("SELECT COUNT(*)
			FROM information_schema.tables
			WHERE table_schema = SCHEMA()
			AND table_name = 'plugin_servcheck_proxies'");

		if ($exist) {
			db_execute('ALTER TABLE plugin_servcheck_proxies RENAME TO plugin_servcheck_proxy');
		}

		api_plugin_db_add_column('servcheck', 'plugin_servcheck_proxy', ['name' => 'cred_id', 'type' => 'int(11)', 'NULL' => false, 'unsigned' => true, 'default' => '0']);

		$data              = [];
		$data['columns'][] = ['name' => 'id', 'type' => 'int(11)', 'NULL' => false, 'auto_increment' => true];
		$data['columns'][] = ['name' => 'name', 'type' => 'varchar(100)', 'NULL' => true, 'default' => ''];
		$data['columns'][] = ['name' => 'type', 'type' => "enum('userpass','basic','apikey', 'oauth2', 'cookie', 'snmp','snmp3','sshkey')", 'NULL' => false, 'default' => 'userpass'];
		$data['columns'][] = ['name' => 'data', 'type' => 'text', 'NULL' => true, 'default' => ''];
		$data['primary']   = 'id';
		$data['type']      = 'InnoDB';
		$data['comment']   = 'Holds Credentials';
		api_plugin_db_table_create('servcheck', 'plugin_servcheck_credential', $data);

		// convert log data from 0.2 version

		if (!db_column_exists('plugin_servcheck_log', 'duration')) {
			api_plugin_db_add_column('servcheck', 'plugin_servcheck_log', ['name' => 'curl_response', 'type' => 'text', 'NULL' => true, 'default' => null]);
			api_plugin_db_add_column('servcheck', 'plugin_servcheck_log', ['name' => 'duration', 'type' => 'float', 'NULL' => false, 'default' => 0]);

			db_execute('UPDATE plugin_servcheck_log SET total_time = 0  WHERE total_time IS NULL');
			db_execute('UPDATE plugin_servcheck_log SET duration = total_time');
			db_execute("UPDATE plugin_servcheck_log SET curl_response = CONCAT(
				'HTTP code: ', http_code, ', ',
				'DNS time: ', ROUND(namelookup_time,3), ', ',
				'Conn. time: ', ROUND(connect_time,3), ', ',
				'Redir. time: ', ROUND(redirect_time,3), ', ',
				'Redir. count: ', redirect_count, ', ',
				'Download: ', ROUND(size_download,3), ', ',
				'Speed: ', ROUND(speed_download,3), ', ',
				'CURL code: ', curl_return_code
				)");

			db_remove_column('plugin_servcheck_log', 'http_code');
			db_remove_column('plugin_servcheck_log', 'total_time');
			db_remove_column('plugin_servcheck_log', 'namelookup_time');
			db_remove_column('plugin_servcheck_log', 'connect_time');
			db_remove_column('plugin_servcheck_log', 'redirect_time');
			db_remove_column('plugin_servcheck_log', 'redirect_count');
			db_remove_column('plugin_servcheck_log', 'size_download');
			db_remove_column('plugin_servcheck_log', 'speed_download');
			db_remove_column('plugin_servcheck_log', 'curl_return_code');
		}

		// convert credentials to separated tab

		$records = db_fetch_assoc("SELECT * FROM plugin_servcheck_test
			WHERE (username != '' OR password !='') AND type != 'restapi'");

		if (cacti_sizeof($records)) {
			foreach ($records as $record) {
				$cred             = [];
				$cred['type']     = 'userpass';
				$cred['username'] = servcheck_show_text($record['username']);
				$cred['password'] = servcheck_show_text($record['password']);

				$enc = servcheck_encrypt_credential($cred);

				db_execute_prepared('INSERT INTO plugin_servcheck_credential
					(name, type, data) VALUES (?, ?, ?)',
					['upgrade/convert_test_' . $record['id'], $cred['type'], $enc]);

				db_execute_prepared('UPDATE plugin_servcheck_test
					SET cred_id = ? WHERE id = ?',
					[db_fetch_insert_id(), $record['id']]);
			}
		}

		$records = db_fetch_assoc("SELECT * FROM plugin_servcheck_proxy WHERE username != '' OR password !=''");

		if (cacti_sizeof($records)) {
			foreach ($records as $record) {
				$cred             = [];
				$cred['type']     = 'userpass';
				$cred['username'] = $record['username'];
				$cred['password'] = $record['password'];

				$enc = servcheck_encrypt_credential($cred);

				db_execute_prepared('INSERT INTO plugin_servcheck_credential
					(name, type, data) VALUES (?, ?, ?)',
					['upgrade/convert_proxy_' . $record['id'], $cred['type'], $enc]);

				db_execute_prepared('UPDATE plugin_servcheck_proxy
					SET cred_id = ? WHERE id = ?',
					[db_fetch_insert_id(), $record['id']]);
			}
		}

		if (db_table_exists('plugin_servcheck_restapi_method')) {
			$records = db_fetch_assoc('SELECT * FROM plugin_servcheck_restapi_method');

			if (cacti_sizeof($records)) {
				foreach ($records as $record) {
					if ($record['type'] == 'no') {
						continue;
					}

					$cred = [];

					if ($record['type'] == 'basic') {
						$cred['type']     = 'basic';
						$cred['username'] = servcheck_show_text($record['username']);
						$cred['password'] = servcheck_show_text($record['password']);
						$cred['data_url'] = $record['data_url'];
					} elseif ($record['type'] == 'apikey') {
						$cred['type']          = 'apikey';
						$cred['option_apikey'] = 'post';
						$cred['token_name']    = $record['username'];
						$cred['data_url']      = $record['data_url'];
						$cred['token_value']   = servcheck_show_text($record['cred_value']);
					} elseif ($record['type'] == 'oauth2') {
						$cred['type']                = 'oauth2';
						$cred['oauth_client_id']     = servcheck_show_text($record['username']);
						$cred['oauth_client_secret'] = servcheck_show_text($record['password']);
						$cred['token_value']         = servcheck_show_text($record['cred_value']);
						$cred['token_name']          = $record['cred_name'];
						$cred['cred_validity']       = $record['cred_validity'];
						$cred['data_url']            = $record['data_url'];
						$cred['login_url']           = $record['login_url'];
					} elseif ($record['type'] == 'cookie') {
						$cred['type']          = 'cookie';
						$cred['option_cookie'] = 'json';
						$cred['username']      = servcheck_show_text($record['username']);
						$cred['password']      = servcheck_show_text($record['password']);
						$cred['data_url']      = $record['data_url'];
						$cred['login_url']     = $record['login_url'];
					}

					if (!isset($cred['type'])) {
						continue;
					}

					$enc = servcheck_encrypt_credential($cred);

					$test_id = db_fetch_cell_prepared('SELECT id FROM plugin_servcheck_test
						WHERE restapi_id = ? LIMIT 1',
						[$record['id']]);

					db_execute_prepared('INSERT INTO plugin_servcheck_credential
						(name, type, data) VALUES (?, ?, ?)',
						['upgrade/convert_restapi_' . $record['id'], $cred['type'], $enc]);

					db_execute_prepared('UPDATE plugin_servcheck_test
						set type = ?, cred_id = ?
						WHERE id = ?',
						['rest_' . $cred['type'], db_fetch_insert_id(), $test_id]);
				}
			}
		}

		db_remove_column('plugin_servcheck_test', 'username');
		db_remove_column('plugin_servcheck_test', 'password');
		db_remove_column('plugin_servcheck_test', 'restapi_id');
		db_remove_column('plugin_servcheck_proxy', 'username');
		db_remove_column('plugin_servcheck_proxy', 'password');

		db_execute('DROP TABLE IF EXISTS plugin_servcheck_processes');
	}

	if (cacti_version_compare($old, '0.4', '<')) {
		if (db_column_exists('plugin_servcheck_test', 'lastcheck')) {
			db_execute('ALTER TABLE plugin_servcheck_test RENAME COLUMN lastcheck TO last_check');
		}

		if (db_column_exists('plugin_servcheck_log', 'lastcheck')) {
			db_execute('ALTER TABLE plugin_servcheck_log RENAME COLUMN lastcheck TO last_check');
		}

		if (!db_column_exists('plugin_servcheck_test', 'cpu_user')) {
			api_plugin_db_add_column('servcheck', 'plugin_servcheck_test', ['name' => 'cpu_user', 'type' => 'double', 'NULL' => false, 'default' => '0', 'after' => 'triggered_duration']);
			api_plugin_db_add_column('servcheck', 'plugin_servcheck_test', ['name' => 'cpu_system', 'type' => 'double', 'NULL' => false, 'default' => '0', 'after' => 'cpu_user']);
			api_plugin_db_add_column('servcheck', 'plugin_servcheck_test', ['name' => 'memory', 'type' => 'int(11)', 'NULL' => false, 'default' => '0', 'after' => 'cpu_system']);
			api_plugin_db_add_column('servcheck', 'plugin_servcheck_test', ['name' => 'last_result', 'type' => 'varchar(20)', 'NULL' => false, 'default' => 'not yet', 'after' => 'last_exp_notify']);
			api_plugin_db_add_column('servcheck', 'plugin_servcheck_test', ['name' => 'last_result_search', 'type' => 'varchar(20)', 'NULL' => false, 'default' => 'not yet', 'after' => 'last_result']);
			api_plugin_db_add_column('servcheck', 'plugin_servcheck_test', ['name' => 'last_attempt', 'type' => 'int(2)', 'NULL' => false, 'default' => '0', 'after' => 'last_result_search']);
			api_plugin_db_add_column('servcheck', 'plugin_servcheck_test', ['name' => 'last_error', 'type' => 'varchar(256)', 'NULL' => true, 'default' => 'NULL', 'after' => 'last_attempt']);
			api_plugin_db_add_column('servcheck', 'plugin_servcheck_test', ['name' => 'run_script', 'type' => 'varchar(2)', 'NULL' => false, 'default' => 'on', 'after' => 'attempt']);
		}

		if (!db_column_exists('plugin_servcheck_test', 'last_duration')) {
			api_plugin_db_add_column('servcheck', 'plugin_servcheck_test', ['name' => 'last_duration', 'type' => 'float', 'NULL' => false, 'default' => '0', 'after' => 'memory']);
		}

		if (!db_column_exists('plugin_servcheck_log', 'cpu_user')) {
			api_plugin_db_add_column('servcheck', 'plugin_servcheck_log', ['name' => 'cpu_user', 'type' => 'double', 'NULL' => false, 'default' => '0', 'after' => 'duration']);
			api_plugin_db_add_column('servcheck', 'plugin_servcheck_log', ['name' => 'cpu_system', 'type' => 'double', 'NULL' => false, 'default' => '0', 'after' => 'cpu_user']);
			api_plugin_db_add_column('servcheck', 'plugin_servcheck_log', ['name' => 'memory', 'type' => 'int(11)', 'NULL' => false, 'default' => '0', 'after' => 'cpu_system']);
			api_plugin_db_add_column('servcheck', 'plugin_servcheck_log', ['name' => 'returned_data_size', 'type' => 'int(11)', 'NULL' => false, 'default' => '0', 'after' => 'memory']);
		}
	}

	// Set the new version
	db_execute_prepared("UPDATE plugin_config
		SET version = ?, author = ?, webpage = ?
		WHERE directory = 'servcheck'",
		[$info['version'], $info['author'], $info['homepage']]
	);

	servcheck_prune_files();

	return true;
}

/**
 * Reads this plugin's version/author metadata from its INFO file.
 * Invoked by the Cacti plugin framework to display plugin information,
 * and called from plugin_servcheck_upgrade() and
 * poller_servcheck.php's/servcheck_process.php's display_version().
 *
 * @return array The plugin's INFO file 'info' section (name, version,
 *               author, etc.).
 *
 * @global array $config Cacti global configuration array; used to
 *                       locate the plugin's INFO file.
 */
function plugin_servcheck_version(): array {
	global $config;
	$info = parse_ini_file($config['base_path'] . '/plugins/servcheck/INFO', true);

	if (!is_array($info) || !isset($info['info']) || !is_array($info['info'])) {
		return [];
	}

	return $info['info'];
}

/**
 * Creates all of this plugin's database tables (service check tests and
 * their check log, HTTP proxies, CA certificates, credentials). Called
 * from plugin_servcheck_install() during plugin installation.
 *
 * @return void
 */
function plugin_servcheck_setup_table(): void {
	$data              = [];
	$data['columns'][] = ['name' => 'id', 'type' => 'int(11)', 'NULL' => false, 'auto_increment' => true];
	$data['columns'][] = ['name' => 'type', 'type' => 'varchar(30)', 'NULL' => false, 'default' => 'web_http'];
	$data['columns'][] = ['name' => 'notify', 'type' => 'char(2)', 'NULL' => false, 'default' => 'on'];
	$data['columns'][] = ['name' => 'name', 'type' => 'varchar(64)', 'NULL' => false, 'default' => ''];
	$data['columns'][] = ['name' => 'poller_id', 'type' => 'int(11)', 'NULL' => false, 'unsigned' => true, 'default' => '1'];
	$data['columns'][] = ['name' => 'enabled', 'type' => 'varchar(2)', 'NULL' => false, 'default' => 'on'];
	$data['columns'][] = ['name' => 'attempt', 'type' => 'int(2)', 'NULL' => false, 'default' => '3'];
	$data['columns'][] = ['name' => 'run_script', 'type' => 'varchar(2)', 'NULL' => false, 'default' => 'on'];
	$data['columns'][] = ['name' => 'hostname', 'type' => 'varchar(120)', 'NULL' => false, 'default' => ''];
	$data['columns'][] = ['name' => 'ipaddress', 'type' => 'varchar(46)', 'NULL' => false, 'default' => ''];
	$data['columns'][] = ['name' => 'path', 'type' => 'varchar(256)', 'NULL' => false];
	$data['columns'][] = ['name' => 'dns_query', 'type' => 'varchar(100)', 'NULL' => false, 'default' => ''];
	$data['columns'][] = ['name' => 'ldapsearch', 'type' => 'varchar(200)', 'NULL' => false, 'default' => ''];
	$data['columns'][] = ['name' => 'snmp_oid', 'type' => 'varchar(255)', 'NULL' => false, 'default' => ''];
	$data['columns'][] = ['name' => 'ssh_command', 'type' => 'varchar(255)', 'NULL' => false, 'default' => ''];
	$data['columns'][] = ['name' => 'search', 'type' => 'varchar(1024)', 'NULL' => false];
	$data['columns'][] = ['name' => 'search_maint', 'type' => 'varchar(1024)', 'NULL' => false];
	$data['columns'][] = ['name' => 'search_failed', 'type' => 'varchar(1024)', 'NULL' => false];
	$data['columns'][] = ['name' => 'requiresauth', 'type' => 'varchar(2)', 'NULL' => false, 'default' => ''];
	$data['columns'][] = ['name' => 'proxy_id', 'type' => 'int(11)', 'NULL' => false, 'unsigned' => true, 'default' => '0'];
	$data['columns'][] = ['name' => 'ca_id', 'type' => 'int(11)', 'NULL' => false, 'unsigned' => true, 'default' => '0'];
	$data['columns'][] = ['name' => 'cred_id', 'type' => 'int(11)', 'NULL' => false, 'unsigned' => true, 'default' => '0'];
	$data['columns'][] = ['name' => 'checkcert', 'type' => 'char(2)', 'NULL' => false, 'default' => 'on'];
	$data['columns'][] = ['name' => 'certexpirenotify', 'type' => 'char(2)', 'NULL' => false, 'default' => 'on'];
	$data['columns'][] = ['name' => 'notify_list', 'type' => 'int(10)', 'NULL' => false, 'unsigned' => true, 'default' => '0'];
	$data['columns'][] = ['name' => 'notify_accounts', 'type' => 'varchar(256)', 'NULL' => false];
	$data['columns'][] = ['name' => 'notify_extra', 'type' => 'varchar(256)', 'NULL' => false];
	$data['columns'][] = ['name' => 'notify_format', 'type' => 'int(3)', 'NULL' => false, 'unsigned' => true, 'default' => '0'];
	$data['columns'][] = ['name' => 'notes', 'type' => 'text', 'NULL' => false, 'default' => ''];
	$data['columns'][] = ['name' => 'external_id', 'type' => 'varchar(20)', 'NULL' => false, 'default' => ''];
	$data['columns'][] = ['name' => 'how_often', 'type' => 'int(11)', 'NULL' => false, 'unsigned' => true, 'default' => '1'];
	$data['columns'][] = ['name' => 'downtrigger', 'type' => 'int(11)', 'NULL' => false, 'unsigned' => true, 'default' => '3'];
	$data['columns'][] = ['name' => 'duration_trigger', 'type' => 'decimal(4,2)', 'NULL' => false, 'unsigned' => true, 'default' => '0'];
	$data['columns'][] = ['name' => 'duration_count', 'type' => 'int(3)', 'NULL' => false, 'unsigned' => true, 'default' => '3'];
	$data['columns'][] = ['name' => 'stats_ok', 'type' => 'int(11)', 'NULL' => false, 'unsigned' => true, 'default' => '0'];
	$data['columns'][] = ['name' => 'stats_bad', 'type' => 'int(11)', 'NULL' => false, 'unsigned' => true, 'default' => '0'];
	$data['columns'][] = ['name' => 'failures', 'type' => 'int(11)', 'NULL' => false, 'unsigned' => true, 'default' => '0'];
	$data['columns'][] = ['name' => 'triggered', 'type' => 'int(11)', 'NULL' => false, 'unsigned' => true, 'default' => '0'];
	$data['columns'][] = ['name' => 'triggered_duration', 'type' => 'int(11)', 'NULL' => false, 'unsigned' => true, 'default' => '0'];
	$data['columns'][] = ['name' => 'cpu_user', 'type' => 'double', 'NULL' => false, 'default' => '0'];
	$data['columns'][] = ['name' => 'cpu_system', 'type' => 'double', 'NULL' => false, 'default' => '0'];
	$data['columns'][] = ['name' => 'memory', 'type' => 'int(11)', 'NULL' => false, 'default' => '0'];
	$data['columns'][] = ['name' => 'last_check', 'type' => 'timestamp', 'NULL' => false, 'default' => '0000-00-00 00:00:00'];
	$data['columns'][] = ['name' => 'last_exp_notify', 'type' => 'timestamp', 'NULL' => false, 'default' => '0000-00-00 00:00:00'];
	$data['columns'][] = ['name' => 'last_result', 'type' => 'varchar(20)', 'NULL' => false, 'default' => 'not yet'];
	$data['columns'][] = ['name' => 'last_result_search', 'type' => 'varchar(20)', 'NULL' => false, 'default' => 'not yet'];
	$data['columns'][] = ['name' => 'last_attempt', 'type' => 'int(2)', 'NULL' => false, 'default' => '0'];
	$data['columns'][] = ['name' => 'last_error', 'type' => 'varchar(256)', 'NULL' => true, 'default' => 'NULL'];
	$data['columns'][] = ['name' => 'last_returned_data', 'type' => 'blob', 'NULL' => true, 'default' => ''];
	$data['columns'][] = ['name' => 'last_duration', 'type' => 'float', 'NULL' => false, 'default' => '0'];
	$data['primary']   = 'id';
	$data['keys'][]    = ['name' => 'last_check', 'columns' => 'last_check'];
	$data['keys'][]    = ['name' => 'triggered', 'columns' => 'triggered'];
	$data['keys'][]    = ['name' => 'enabled', 'columns' => 'enabled'];
	$data['type']      = 'InnoDB';
	$data['comment']   = 'Holds servcheck Service Check Definitions';

	api_plugin_db_table_create('servcheck', 'plugin_servcheck_test', $data);

	$data              = [];
	$data['columns'][] = ['name' => 'id', 'type' => 'int(11)', 'NULL' => false, 'auto_increment' => true];
	$data['columns'][] = ['name' => 'test_id', 'type' => 'int(11)', 'NULL' => false, 'unsigned' => true, 'default' => '0'];
	$data['columns'][] = ['name' => 'attempt', 'type' => 'int(2)', 'NULL' => false, 'default' => '0'];
	$data['columns'][] = ['name' => 'result', 'type' => "enum('ok','not yet','error')", 'NULL' => false, 'default' => 'not yet'];
	$data['columns'][] = ['name' => 'result_search', 'type' => "enum('ok','not ok','failed ok','failed not ok', 'maint ok','not yet', 'not tested')", 'NULL' => false, 'default' => 'not yet'];
	$data['columns'][] = ['name' => 'curl_response', 'type' => 'text', 'NULL' => true, 'default' => null];
	$data['columns'][] = ['name' => 'cert_expire', 'type' => 'timestamp', 'NULL' => false, 'default' => '0000-00-00 00:00:00'];
	$data['columns'][] = ['name' => 'error', 'type' => 'varchar(256)', 'NULL' => true, 'default' => 'NULL'];
	$data['columns'][] = ['name' => 'duration', 'type' => 'float', 'NULL' => false, 'default' => 0];
	$data['columns'][] = ['name' => 'cpu_user', 'type' => 'double', 'NULL' => false, 'default' => '0'];
	$data['columns'][] = ['name' => 'cpu_system', 'type' => 'double', 'NULL' => false, 'default' => '0'];
	$data['columns'][] = ['name' => 'memory', 'type' => 'int(11)', 'NULL' => false, 'default' => '0'];
	$data['columns'][] = ['name' => 'returned_data_size', 'type' => 'int(11)', 'NULL' => false, 'default' => '0'];
	$data['columns'][] = ['name' => 'last_check', 'type' => 'timestamp', 'NULL' => false, 'default' => '0000-00-00 00:00:00'];
	$data['primary']   = 'id';
	$data['keys'][]    = ['name' => 'test_id', 'columns' => 'test_id'];
	$data['keys'][]    = ['name' => 'last_check', 'columns' => 'last_check'];
	$data['keys'][]    = ['name' => 'result', 'columns' => 'result'];
	$data['type']      = 'InnoDB';
	$data['comment']   = 'Holds servcheck Service Check Logs';

	api_plugin_db_table_create('servcheck', 'plugin_servcheck_log', $data);

	$data              = [];
	$data['columns'][] = ['name' => 'id', 'type' => 'int(11)', 'NULL' => false, 'auto_increment' => true];
	$data['columns'][] = ['name' => 'name', 'type' => 'varchar(30)', 'NULL' => true, 'default' => ''];
	$data['columns'][] = ['name' => 'hostname', 'type' => 'varchar(64)', 'NULL' => true, 'default' => ''];
	$data['columns'][] = ['name' => 'http_port', 'type' => 'mediumint(8)', 'NULL' => true, 'default' => '80'];
	$data['columns'][] = ['name' => 'https_port', 'type' => 'mediumint(8)', 'NULL' => true, 'default' => '443'];
	$data['columns'][] = ['name' => 'cred_id', 'type' => 'int(11)', 'NULL' => false, 'unsigned' => true, 'default' => '0'];
	$data['primary']   = 'id';
	$data['keys'][]    = ['name' => 'hostname', 'columns' => 'hostname'];
	$data['keys'][]    = ['name' => 'name', 'columns' => 'name'];
	$data['type']      = 'InnoDB';
	$data['comment']   = 'Holds Proxy Information for Connections';

	api_plugin_db_table_create('servcheck', 'plugin_servcheck_proxy', $data);

	$data              = [];
	$data['columns'][] = ['name' => 'id', 'type' => 'int(11)', 'NULL' => false, 'auto_increment' => true];
	$data['columns'][] = ['name' => 'name', 'type' => 'varchar(100)', 'NULL' => false, 'default' => ''];
	$data['columns'][] = ['name' => 'cert', 'type' => 'text'];
	$data['primary']   = 'id';
	$data['type']      = 'InnoDB';
	$data['comment']   = 'Holds CA certificates';

	api_plugin_db_table_create('servcheck', 'plugin_servcheck_ca', $data);

	$data              = [];
	$data['columns'][] = ['name' => 'id', 'type' => 'int(11)', 'NULL' => false, 'auto_increment' => true];
	$data['columns'][] = ['name' => 'name', 'type' => 'varchar(100)', 'NULL' => true, 'default' => ''];
	$data['columns'][] = ['name' => 'type', 'type' => "enum('userpass','basic','apikey', 'oauth2', 'cookie', 'snmp','snmp3','sshkey')", 'NULL' => false, 'default' => 'userpass'];
	$data['columns'][] = ['name' => 'data', 'type' => 'text', 'NULL' => true, 'default' => ''];
	$data['primary']   = 'id';
	$data['type']      = 'InnoDB';
	$data['comment']   = 'Holds Credentials';

	api_plugin_db_table_create('servcheck', 'plugin_servcheck_credential', $data);
}

/**
 * Launches a background poller_servcheck.php process to run the
 * configured service checks. Invoked by the Cacti plugin framework via
 * the 'poller_bottom' hook at the end of each poller cycle.
 *
 * @return void
 *
 * @global array $config Cacti global configuration array; used to
 *                       resolve the PHP binary and this plugin's poller
 *                       script path.
 */
function plugin_servcheck_poller_bottom(): void {
	global $config;

	require_once($config['library_path'] . '/database.php');

	if (!function_exists('exec_background')) {
		include_once($config['library_path'] . '/poller.php');
	}

	$command_string = trim(read_config_option('path_php_binary'));

	// If its not set, just assume its in the path
	if (trim($command_string) == '') {
		$command_string = 'php';
	}
	$extra_args = ' -q ' . $config['base_path'] . '/plugins/servcheck/poller_servcheck.php';

	exec_background($command_string, $extra_args);
}

/**
 * Adds this plugin's 'Service Checker' entry to the Management menu, and
 * triggers a schema-upgrade check when the currently displayed page is
 * one of this plugin's own pages (or the main index/plugins pages).
 * Invoked by the Cacti plugin framework via the 'config_arrays' hook.
 *
 * @return void
 *
 * @global array $menu                       Cacti's registered admin
 *                                           menu; a 'Service Checker'
 *                                           entry is added under
 *                                           'Management'.
 * @global array $user_auth_realms           Reserved/declared for parity
 *                                           with other hook
 *                                           implementations; not used
 *                                           directly here.
 * @global array $user_auth_realm_filenames  Reserved/declared for parity
 *                                           with other hook
 *                                           implementations; not used
 *                                           directly here.
 */
function plugin_servcheck_config_arrays(): void {
	global $menu, $user_auth_realms, $user_auth_realm_filenames;

	$menu[__('Management')]['plugins/servcheck/servcheck_test.php'] = __('Service Checker', 'servcheck');

	$files = ['index.php', 'plugins.php', 'servcheck_test.php'];

	if (in_array(get_current_page(), $files, true)) {
		plugin_servcheck_check_config();
	}
}

/**
 * Adds this plugin's page breadcrumb/navigation entries (service check,
 * REST API, credential, web proxy, and CA list/edit/save views).
 * Invoked by the Cacti plugin framework via the 'draw_navigation_text'
 * hook.
 *
 * @param array $nav Cacti's registered navigation text entries.
 *
 * @return array The $nav array with this plugin's entries added.
 */
function plugin_servcheck_draw_navigation_text($nav): array {
	$nav['servcheck_test.php:'] = [
		'title'   => __('Service Checks', 'servcheck'),
		'mapping' => 'index.php:',
		'url'     => 'servcheck_test.php',
		'level'   => '1'
	];

	$nav['servcheck_test.php:edit'] = [
		'title'   => __('Service Check Edit', 'servcheck'),
		'mapping' => 'index.php:',
		'url'     => 'servcheck_test.php',
		'level'   => '1'
	];

	$nav['servcheck_test.php:save'] = [
		'title'   => __('Service Check Save', 'servcheck'),
		'mapping' => 'index.php:',
		'url'     => 'servcheck_test.php',
		'level'   => '1'
	];

	$nav['servcheck_restapi.php:'] = [
		'title'   => __('Rest API', 'servcheck'),
		'mapping' => 'index.php:',
		'url'     => 'servcheck_restapi.php',
		'level'   => '1'
	];

	$nav['servcheck_restapi.php:edit'] = [
		'title'   => __('Rest API Edit', 'servcheck'),
		'mapping' => 'index.php:',
		'url'     => 'servcheck_restapi.php',
		'level'   => '1'
	];

	$nav['servcheck_restapi.php:save'] = [
		'title'   => __('Rest API Save', 'servcheck'),
		'mapping' => 'index.php:',
		'url'     => 'servcheck_restapi.php',
		'level'   => '1'
	];

	$nav['servcheck_credential.php:'] = [
		'title'   => __('Credential', 'servcheck'),
		'mapping' => 'index.php:',
		'url'     => 'servcheck_credential.php',
		'level'   => '1'
	];

	$nav['servcheck_credential.php:edit'] = [
		'title'   => __('Credential Edit', 'servcheck'),
		'mapping' => 'index.php:',
		'url'     => 'servcheck_credential.php',
		'level'   => '1'
	];

	$nav['servcheck_credential.php:save'] = [
		'title'   => __('Credential Save', 'servcheck'),
		'mapping' => 'index.php:',
		'url'     => 'servcheck_credential.php',
		'level'   => '1'
	];

	$nav['servcheck_proxy.php:'] = [
		'title'   => __('Web Proxy', 'servcheck'),
		'mapping' => 'index.php:',
		'url'     => 'servcheck_proxy.php',
		'level'   => '1'
	];

	$nav['servcheck_proxy.php:edit'] = [
		'title'   => __('Web Proxy Edit', 'servcheck'),
		'mapping' => 'index.php:',
		'url'     => 'servcheck_proxy.php',
		'level'   => '1'
	];

	$nav['servcheck_proxy.php:save'] = [
		'title'   => __('Save Web Proxy', 'servcheck'),
		'mapping' => 'index.php:',
		'url'     => 'servcheck_proxy.php',
		'level'   => '1'
	];

	$nav['servcheck_ca.php:'] = [
		'title'   => __('CA', 'servcheck'),
		'mapping' => 'index.php:',
		'url'     => 'servcheck_ca.php',
		'level'   => '1'
	];

	$nav['servcheck_ca.php:edit'] = [
		'title'   => __('CA Edit', 'servcheck'),
		'mapping' => 'index.php:',
		'url'     => 'servcheck_ca.php',
		'level'   => '1'
	];

	$nav['servcheck_ca.php:save'] = [
		'title'   => __('Save CA', 'servcheck'),
		'mapping' => 'index.php:',
		'url'     => 'servcheck_ca.php',
		'level'   => '1'
	];

	return $nav;
}

/**
 * Replicates this plugin's configuration tables (proxies, tests,
 * credentials, CAs) out to a remote data collector poller. Invoked by
 * the Cacti plugin framework via the 'replicate_out' hook during data
 * collector replication.
 *
 * @param array $data Replication context, including 'remote_poller_id',
 *                    'rcnn_id' (remote connection id), and 'class'
 *                    (replication scope, e.g. 'all').
 *
 * @return array The $data array, unmodified, returned for hook chaining.
 */
function servcheck_replicate_out($data): array {
	global $config;

	if (!function_exists('replicate_out_table')) {
		include_once($config['library_path'] . '/poller.php');
	}

	$remote_poller_id = $data['remote_poller_id'];
	$rcnn_id          = $data['rcnn_id'];
	$class            = $data['class'];

	cacti_log('INFO: Replicating for the servcheck Plugin', false, 'REPLICATE');

	$tables = [
		'plugin_servcheck_proxy',
		'plugin_servcheck_test',
		'plugin_servcheck_credential',
		'plugin_servcheck_ca'
	];

	if ($class == 'all') {
		foreach ($tables as $table) {
			$tdata = db_fetch_assoc('SELECT * FROM ' . $table);
			replicate_out_table($rcnn_id, $tdata, $table, $remote_poller_id);
		}
	}

	return $data;
}

/**
 * Registers this plugin's 'Servcheck' Settings tab and its
 * configuration fields (notification preferences, command-execution
 * enablement, certificate expiry thresholds, data retention, process
 * limits). Invoked by the Cacti plugin framework via the
 * 'config_settings' hook when rendering the Settings page.
 *
 * @return void
 *
 * @global array $tabs     Cacti's registered settings tabs; a
 *                         'servcheck' entry is added.
 * @global array $settings Cacti's registered settings fields; a
 *                         'servcheck' entry is added with this plugin's
 *                         field definitions.
 */
function servcheck_config_settings(): void {
	global $tabs, $settings;

	$tabs['servcheck'] = __('Servcheck', 'servcheck');

	$settings['servcheck'] = [
		'servcheck_display_header' => [
			'friendly_name' => __('Notification Preferences', 'servcheck'),
			'method'        => 'spacer',
		],
		'servcheck_send_email_separately' => [
			'friendly_name' => __('Send Email separately for each address', 'servcheck'),
			'description'   => __('If checked, this will cause all Emails to be sent separately for each address.', 'servcheck'),
			'method'        => 'checkbox',
			'default'       => '',
		],
		'servcheck_disable_notification' => [
			'friendly_name' => __('Stop sending all notification', 'servcheck'),
			'description'   => __('If checked, servcheck will not send any emails. You can also disable notification only for specific tests', 'servcheck'),
			'method'        => 'checkbox',
			'default'       => '',
		],
		'servcheck_enable_scripts' => [
			'friendly_name' => __('Enable Command Execution', 'servcheck'),
			'description'   => __('Checking this box will enable the ability to run commands on Servcheck events. You can enable or disable it for each test.', 'servcheck'),
			'method'        => 'checkbox',
			'default'       => ''
		],
		'servcheck_change_command' => [
			'friendly_name' => __('Status Change Command', 'servcheck'),
			'description'   => __('When a basic or search or certificate expiration test returns different result, run the following command... This command must NOT include command line arguments... However, the following variables can be pulled from the environment of the script:<br>&#060SERVCHECK_TEST_NAME&#062 &#060SERVCHECK_EXTERNAL_ID&#062 &#060SERVCHECK_TEST_TYPE&#062 &#060SERVCHECK_POLLER_ID&#062 &#060SERVCHECK_RESULT&#062 &#060SERVCHECK_RESULT_SEARCH&#062 &#060SERVCHECK_CERTIFICATE_EXPIRATION&#062', 'servcheck'),
			'method'        => 'filepath',
			'file_type'     => 'binary',
			'size'          => '100',
			'max_length'    => '100',
			'default'       => ''
		],
		'servcheck_processes' => [
			'friendly_name' => __('Concurrent Check Processes', 'servcheck'),
			'description'   => __('The number of service check processes to run concurrently.  Increasing this number to 2 times the number of cores is not advised.', 'servcheck'),
			'method'        => 'drop_array',
			'default'       => 8,
			'array'         => [
				'1'  => __('1 Process', 'servcheck'),
				'2'  => __('%d Processes', 2, 'servcheck'),
				'3'  => __('%d Processes', 3, 'servcheck'),
				'4'  => __('%d Processes', 4, 'servcheck'),
				'5'  => __('%d Processes', 5, 'servcheck'),
				'6'  => __('%d Processes', 6, 'servcheck'),
				'7'  => __('%d Processes', 7, 'servcheck'),
				'8'  => __('%d Processes', 8, 'servcheck'),
				'9'  => __('%d Processes', 9, 'servcheck'),
				'10' => __('%d Processes', 10, 'servcheck'),
				'15' => __('%d Processes', 15, 'servcheck'),
				'20' => __('%d Processes', 20, 'servcheck'),
				'25' => __('%d Processes', 25, 'servcheck'),
				'30' => __('%d Processes', 30, 'servcheck')
			]
		],
		'servcheck_certificate_expiry_days' => [
			'friendly_name' => __('Certificate expiry date advanced notification email', 'servcheck'),
			'description'   => __('If SSL/TLS service certificate expiration is enabled, set how many days advanced notice period before certificate expiry date the system will send notification', 'servcheck'),
			'method'        => 'drop_array',
			'default'       => 7,
			'array'         => [
				'-1' => __('Disabled', 'servcheck'),
				'3'  => __('3 days in advance', 'servcheck'),
				'7'  => __('1 week in advance', 'servcheck'),
				'21' => __('3 weeks in advance', 'servcheck'),
				'30' => __('30 days in advance', 'servcheck'),
				'60' => __('60 days in advance', 'servcheck'),
				'90' => __('90 days in advance', 'servcheck'),
			]
		],
		'servcheck_data_retention' => [
			'friendly_name' => __('How long to keep logs', 'servcheck'),
			'description'   => __('Enter the period after which older logs will be automatically deleted.', 'servcheck'),
			'method'        => 'drop_array',
			'default'       => 8,
			'array'         => [
				'0'   => __('Never', 'servcheck'),
				'1'   => __('%d hours', 24, 'servcheck'),
				'7'   => __('%d days', 7, 'servcheck'),
				'90'  => __('%d days', 90, 'servcheck'),
				'180' => __('%d days', 180, 'servcheck'),
				'365' => __('%d year', 1, 'servcheck'),
			]
		],
		'servcheck_test_max_duration' => [
			'friendly_name' => __('Maximum test duration in seconds', 'servcheck'),
			'description'   => __('The default value for tests where runtime testing is not enabled. If enabled, the max. duration is calculated as the duration threshold + 2 seconds.', 'servcheck'),
			'method'        => 'textbox',
			'max_length'    => 2,
			'default'       => '3',
		],
		'servcheck_web_header' => [
			'friendly_name' => __('HTTP/HTTPS Check Settings', 'servcheck'),
			'method'        => 'spacer',
		],
		'servcheck_user_agent' => [
			'friendly_name' => __('User Agent', 'servcheck'),
			'description'   => __('The User-Agent string sent with HTTP/HTTPS and other cURL based service checks. Some sites block old or uncommon browsers, so you can set a current User-Agent here. Leave blank to use the built-in default.', 'servcheck'),
			'method'        => 'textbox',
			'size'          => '100',
			'max_length'    => '255',
			'default'       => 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/110.0.0.0 Safari/537.36',
		]
	];
}

/**
 * Injects this plugin's common and theme-specific stylesheets into the
 * page head. Invoked by the Cacti plugin framework via the 'page_head'
 * hook.
 *
 * @return void
 *
 * @global array $config Cacti global configuration array; used to
 *                       locate the theme CSS files.
 */
function servcheck_page_head(): void {
	global $config;

	$selectedTheme = get_selected_theme();

	print get_md5_include_css('plugins/servcheck/css/common.css');

	if (file_exists($config['base_path'] . '/plugins/servcheck/css/' . $selectedTheme . '.css')) {
		print get_md5_include_css('plugins/servcheck/css/' . $selectedTheme . '.css');
	}
}

/**
 * Removes files and directories that a previous version of this plugin
 * shipped but that have since moved or been deleted, using the tombstone
 * and whitelist lists in manifest.json. Whitelisted (user-data) paths and
 * any VCS metadata (.git*) are never touched; the dev-only tests/ tree is
 * removed. Any path that resolves outside the plugin directory (a tampered
 * manifest.json) is refused, and any file/directory that cannot be removed
 * (e.g. read-only) is reported to the Cacti log. Any top-level entry that is
 * neither expected nor a tombstone nor whitelisted is logged to the Cacti
 * log and left in place. Called on a plugin version change.
 *
 * @return void
 *
 * @global array $config Cacti global configuration array; used to resolve
 *                       the plugin directory.
 */
function servcheck_prune_files(): void {
	global $config;

	$plugin_dir    = $config['base_path'] . '/plugins/servcheck';
	$manifest_path = $plugin_dir . '/manifest.json';

	if (!is_readable($manifest_path)) {
		return;
	}

	$manifest = json_decode((string) file_get_contents($manifest_path), true);

	if (!is_array($manifest)) {
		cacti_log('WARNING: servcheck manifest.json could not be parsed; skipping file prune', false, 'SERVCHECK');

		return;
	}

	$tombstones = isset($manifest['tombstones']) && is_array($manifest['tombstones']) ? $manifest['tombstones'] : [];
	$expected   = isset($manifest['expected'])   && is_array($manifest['expected'])   ? $manifest['expected']   : [];
	$whitelist  = isset($manifest['whitelist'])  && is_array($manifest['whitelist'])  ? $manifest['whitelist']  : [];

	$protected = function (string $rel) use ($whitelist): bool {
		if (strncmp($rel, '.git', 4) === 0 || strncmp($rel, '.md', 3) === 0) {
			return true;
		}

		foreach ($whitelist as $entry) {
			$entry = trim((string) $entry, '/');

			if ($entry !== '' && ($rel === $entry
				|| strncmp($rel, $entry . '/', strlen($entry) + 1) === 0
				|| strncmp($entry, $rel . '/', strlen($rel) + 1) === 0)) {
				return true;
			}
		}

		return false;
	};

	// Security: resolve the plugin directory so a tampered manifest.json
	// cannot steer the prune outside of it.
	$plugin_real = realpath($plugin_dir);

	// Remove tombstoned (moved/deleted) paths plus the dev-only tests/
	// tree and the phpunit.xml test configuration.
	$remove   = $tombstones;
	$remove[] = 'tests/';
	$remove[] = 'phpunit.xml';

	foreach ($remove as $rel) {
		$rel = trim((string) $rel, '/');

		if ($rel === '' || $protected($rel)) {
			continue;
		}

		// A tombstone must never contain '.'/'..' segments; a tampered manifest
		// could use them to escape the plugin directory or target its root.
		$segments = explode('/', $rel);

		if (in_array('.', $segments, true) || in_array('..', $segments, true)) {
			cacti_log(sprintf('WARNING: servcheck prune refused to remove %s: path contains a traversal segment (tampered manifest.json?)', $rel), false, 'SERVCHECK');

			continue;
		}

		$path = $plugin_dir . '/' . $rel;

		if (!is_link($path) && !file_exists($path)) {
			continue;
		}

		// Refuse any path that, after resolving symlinks and ../ segments,
		// escapes the plugin directory (protects user data from a tampered
		// manifest.json).
		$anchor = is_link($path) ? dirname($path) : $path;
		$real   = realpath($anchor);

		if ($real === false || ($real !== $plugin_real && strncmp($real, $plugin_real . DIRECTORY_SEPARATOR, strlen((string) $plugin_real) + 1) !== 0)) {
			cacti_log(sprintf('WARNING: servcheck prune refused to remove %s: path resolves outside the plugin directory (tampered manifest.json?)', $rel), false, 'SERVCHECK');

			continue;
		}

		if (is_dir($path) && !is_link($path)) {
			$removed = servcheck_rmtree($path);
		} else {
			$removed = @unlink($path);
		}

		if (!$removed) {
			cacti_log(sprintf('WARNING: servcheck upgrade could not remove %s (check file/directory permissions)', $rel), false, 'SERVCHECK');
		}
	}

	// Surface any top-level entry the manifest does not account for.
	$known = [];

	foreach (array_merge($expected, $tombstones) as $entry) {
		$top = explode('/', trim((string) $entry, '/'))[0];

		if ($top !== '') {
			$known[$top] = true;
		}
	}

	$entries = scandir($plugin_dir);

	foreach (($entries !== false ? $entries : []) as $entry) {
		if ($entry === '.' || $entry === '..' || $entry === 'tests' || $entry === 'phpunit.xml' || $protected($entry) || isset($known[$entry])) {
			continue;
		}

		cacti_log(sprintf('WARNING: servcheck upgrade found a file/directory not described in manifest.json: %s (left in place)', $entry), false, 'SERVCHECK');
	}
}

/**
 * Recursively deletes a directory and its contents. Symlinks are removed
 * without being followed. Helper for servcheck_prune_files().
 *
 * @param string $dir Absolute path to the directory to remove.
 *
 * @return bool True if the directory and everything under it was removed;
 *              false if any entry could not be deleted.
 */
function servcheck_rmtree(string $dir): bool {
	$entries = scandir($dir);
	$ok      = true;

	foreach (($entries !== false ? $entries : []) as $entry) {
		if ($entry === '.' || $entry === '..') {
			continue;
		}

		$path = $dir . '/' . $entry;

		if (is_dir($path) && !is_link($path)) {
			if (!servcheck_rmtree($path)) {
				$ok = false;
			}
		} elseif (!@unlink($path)) {
			$ok = false;
		}
	}

	if (!@rmdir($dir)) {
		$ok = false;
	}

	return $ok;
}