poller_mikrotik.php

#!/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/                                                   |
 +-------------------------------------------------------------------------+
*/

$no_http_headers = true;

chdir(__DIR__);
chdir('../..');
include('./include/global.php');
include_once('./lib/poller.php');
include_once('./lib/snmp.php');
include_once('./lib/ping.php');
include_once('./plugins/mikrotik/RouterOS/routeros_api.class.php');

global $config;

ini_set('memory_limit', '256M');

if ($config['poller_id'] > 1) {
	exit;
}

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

global $debug, $start, $seed, $key, $forcerun;

$debug          = false;
$forcerun       = false;
$forcediscovery = false;
$mainrun        = false;
$host_id        = '';
$start          = '';
$seed           = '';
$key            = '';

if (cacti_sizeof($parms)) {
	foreach ($parms as $parameter) {
		if (strpos($parameter, '=')) {
			[$arg, $value] = explode('=', $parameter);
		} else {
			$arg   = $parameter;
			$value = '';
		}

		switch ($arg) {
			case '-d':
			case '--debug':
				$debug = true;

				break;
			case '--host-id':
				$host_id = $value;

				break;
			case '--seed':
				$seed = $value;

				break;
			case '--key':
				$key = $value;

				break;
			case '-f':
			case '--force':
				$forcerun = true;

				break;
			case '-fd':
			case '--force-discovery':
				$forcediscovery = true;

				break;
			case '-M':
				$mainrun = true;

				break;
			case '-s':
			case '--start':
				$start = $value;

				break;
			case '-v':
			case '-V':
			case '--version':
				display_version();
				exit;
			case '--help':
			case '-H':
			case '-h':
				display_help();
				exit;
			default:
				print 'ERROR: Invalid Parameter ' . $parameter . "\n\n";
				display_help();
				exit;
		}
	}
}

// Check for mandatory parameters
if (!$mainrun && $host_id == '') {
	print "FATAL: You must specify a Cacti host-id run\n";
	exit;
}

// Do not process if not enabled
if (read_config_option('mikrotik_enabled') == '' || db_fetch_cell("SELECT status FROM plugin_config WHERE directory='mikrotik'") != 1) {
	print "WARNING: The MikroTik Collection is Down!  Exiting\n";
	exit(0);
}

if ($seed == '') {
	$seed = rand();
}

if ($start == '') {
	$start = microtime(true);
}

if ($mainrun) {
	process_hosts();
	getLatestVersion();
} else {
	checkHost((int) $host_id);
}

exit(0);

/**
 * Periodically (at most hourly) checks MikroTik's public RouterOS
 * version feed for the latest stable release and version-check date,
 * caching the result in Cacti settings for display/comparison against
 * devices' installed firmware. Called from this script's main flow on
 * every poller run.
 *
 * @return void
 */
function getLatestVersion(): void {
	$t = intval(read_config_option('mikrotik_latestversioncheck'));

	if ($t == 0 || time() - $t > 3600) {
		$latest = file_get_contents('http://upgrade.mikrotik.com/routeros/LATEST.6');

		if ($latest) {
			$latest = explode(' ', $latest);

			if (isset($latest[1])) {
				$latest_version = $latest[0];
				$latest_date    = $latest[1];

				if ($latest_version != '') {
					set_config_option('mikrotik_latestversion', $latest_version);
					set_config_option('mikrotik_latestversion_date', $latest_date);
				}
			}
		}
		set_config_option('mikrotik_latestversioncheck', time());
	}
}

/**
 * Determines whether a scheduled collection task is due to run, based
 * on elapsed time vs. frequency or a forced-run flag. Called from
 * process_hosts()/checkHost() to decide whether autodiscovery/other
 * periodic subtasks should run this cycle.
 *
 * @param float $start     The current run's start time (from
 *                         microtime(true)).
 * @param int|string|null $lastrun   The Unix timestamp of the task's last run.
 * @param int|string|null $frequency The task's configured run frequency in
 *                         seconds; -1 disables the task.
 *
 * @return bool True if the task is due to run, false otherwise.
 *
 * @global bool $forcerun Whether this run was started with '--force',
 *                        in which case the task always runs.
 */
function runCollector(float $start, int|string|null $lastrun, int|string|null $frequency): bool {
	global $forcerun;

	// Settings arrive straight from read_config_option(); an unset last-run is '' or null.
	$lastrun   = (int) $lastrun;
	$frequency = (int) $frequency;

	if ($frequency == -1) {
		return false;
	}

	if (empty($lastrun)) {
		return true;
	}

	if ($start - $lastrun > ($frequency - 55)) {
		return true;
	}

	if ($forcerun) {
		return true;
	} else {
		return false;
	}
}

/**
 * Prints a debug message to stdout when CLI debug output is enabled,
 * prefixed with the elapsed time since the first debug call. Called
 * throughout this script to report progress during collection.
 *
 * @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 debug(string $message): void {
	global $debug;
	static $timer = 0;

	$mytime = time();

	if ($timer == 0) {
		$elapsed = 0;
		$timer   = $mytime;
	} else {
		$elapsed = $mytime - $timer;
	}

	if ($debug) {
		print 'DEBUG: Elapsed: ' . $elapsed . ', Message: ' . trim($message) . "\n";
		flush();
	}
}

/**
 * Scans every enabled, SNMP-capable Cacti host to detect which ones are
 * MikroTik devices, registering supported hosts for collection. Called
 * from process_hosts() when autodiscovery is due to run.
 *
 * @return bool Always returns true after completing discovery.
 *
 * @global bool  $debug Whether debug output is enabled (declared but
 *                      not directly used here; debug() reads it
 *                      itself).
 * @global float $start Declared but not read here.
 */
function autoDiscoverHosts(): bool {
	global $debug, $start;

	$hosts = db_fetch_assoc("SELECT *
		FROM host
		WHERE snmp_version>0
		AND disabled!='on'
		AND status!=1");

	$template_id = db_fetch_cell('SELECT id
		FROM host_template
		WHERE hash="d364e2b9570f166ab33c8df8bd503887"');

	debug("Starting AutoDiscovery for '" . cacti_sizeof($hosts) . "' Hosts");

	// set a process lock
	db_execute('REPLACE INTO plugin_mikrotik_processes (pid, taskid) VALUES (' . getmypid() . ', 0)');

	if (cacti_sizeof($hosts)) {
		foreach ($hosts as $host) {
			debug("AutoDiscovery Check for Host '" . $host['description'] . ' [' . $host['hostname'] . "]'");

			if (strpos($host['snmp_sysDescr'], 'RouterOS') !== false && strpos($host['snmp_sysDescr'], 'SwOS') === false) {
				debug("Host '" . $host['description'] . '[' . $host['hostname'] . "]' Supports MikroTik Resources");
				db_execute('INSERT INTO plugin_mikrotik_system (host_id) VALUES (' . $host['id'] . ') ON DUPLICATE KEY UPDATE host_id=VALUES(host_id)');
			} elseif ($host['host_template_id'] == $template_id) {
				debug("Host '" . $host['description'] . '[' . $host['hostname'] . "]' Supports MikroTik Resources");
				db_execute('INSERT INTO plugin_mikrotik_system (host_id) VALUES (' . $host['id'] . ') ON DUPLICATE KEY UPDATE host_id=VALUES(host_id)');
			}
		}
	}

	// remove the process lock
	db_execute('DELETE FROM plugin_mikrotik_processes WHERE pid=' . getmypid());
	set_config_option('mikrotik_autodiscovery_lastrun', time());

	return true;
}

/**
 * Master process orchestrating a full MikroTik collection cycle: runs
 * autodiscovery when due, purges stale process locks, checks whether
 * any of the various data-type collectors are due to run at all
 * (exiting early if none are), then launches a background per-host
 * collector process (process_host()) for every discovered MikroTik
 * device, respecting the configured concurrency limit, and waits for
 * all of them to finish before updating per-collector last-run
 * timestamps and launching graph automation. Called from this script's
 * main flow when run with the '-M' (main run) flag.
 *
 * @return void
 *
 * @global float $start The run's start time (from microtime(true)),
 *                      used to decide which sub-collectors are due and
 *                      to compute overall run duration.
 * @global mixed $seed  A random value identifying this run, used to tag
 *                      and track the per-host collector processes it
 *                      launches.
 * @global mixed $key   Reserved/declared for parity with other
 *                      functions in this file; assigned per-host
 *                      during launch.
 */
function process_hosts(): void {
	global $start, $seed, $key;

	print "NOTE: Processing Hosts Begins\n";

	/* All time/dates will be stored in timestamps
	 * Get Autodiscovery Lastrun Information
	 */
	$auto_discovery_lastrun = read_config_option('mikrotik_autodiscovery_lastrun');

	// Get Collection Frequencies (in seconds)
	$auto_discovery_freq = read_config_option('mikrotik_autodiscovery_freq');

	// Set the booleans based upon current times
	if (read_config_option('mikrotik_autodiscovery') == 'on') {
		print "NOTE: Auto Discovery Starting\n";

		if (runCollector($start, $auto_discovery_lastrun, $auto_discovery_freq)) {
			autoDiscoverHosts();
		}

		print "NOTE: Auto Discovery Complete\n";
	}

	// Purge collectors that run longer than 10 minutes
	db_execute('DELETE FROM plugin_mikrotik_processes WHERE (UNIX_TIMESTAMP() - UNIX_TIMESTAMP(started)) > 600');

	// Do not process collectors are still running
	if (db_fetch_cell('SELECT count(*) FROM plugin_mikrotik_processes') > 0) {
		print "WARNING: Another MikroTik Collector is still running!  Exiting\n";
		exit(0);
	}

	$types = ['storage', 'trees', 'users', 'queues', 'interfaces', 'wireless_aps', 'wireless_reg'];
	$run   = false;

	foreach ($types as $t) {
		$lastrun = read_config_option('mikrotik_' . $t . '_lastrun');
		$freq    = read_config_option('mikrotik_' . $t . '_freq');

		if (runCollector($start, $lastrun, $freq)) {
			$run = true;
		}
	}

	if (!$run) {
		print "No collectors scheduled for this run, exiting\n";
		exit;
	}

	/* The hosts to scan will
	 *  1) Not be disabled,
	 *  2) Be linked to the host table
	 *  3) Be up and operational
	 */
	$hosts = db_fetch_assoc("SELECT hm.host_id, h.description, h.hostname
		FROM plugin_mikrotik_system AS hm
		INNER JOIN host AS h
		ON h.id=hm.host_id
		WHERE h.disabled!='on'
		AND h.status!=1");

	// Remove entries from  down and disabled hosts
	db_execute("DELETE FROM plugin_mikrotik_processor
		WHERE host_id IN(SELECT id FROM host AS h WHERE disabled='on' OR h.status=1)");

	$concurrent_processes = read_config_option('mikrotik_concurrent_processes');

	print "NOTE: Launching Collectors Starting\n";

	$i = 0;

	if (cacti_sizeof($hosts)) {
		foreach ($hosts as $host) {
			while (true) {
				$processes = db_fetch_cell('SELECT COUNT(*) FROM plugin_mikrotik_processes');

				if ($processes < $concurrent_processes) {
					// put a placeholder in place to prevent overloads on slow systems
					$key = rand();
					db_execute_prepared('INSERT INTO plugin_mikrotik_processes (pid, taskid, started) VALUES (?, ?, NOW())', [$key, $seed]);

					print "NOTE: Launching Host Collector For: '" . $host['description'] . '[' . $host['hostname'] . "]'\n";
					process_host($host['host_id'], $seed, $key);
					usleep(10000);

					break;
				} else {
					sleep(1);
				}
			}
		}
	}

	// taking a break cause for slow systems slow
	sleep(5);

	print "NOTE: All Hosts Launched, proceeding to wait for completion\n";

	// wait for all processes to end or max run time
	while (true) {
		$processes_left = db_fetch_cell_prepared('SELECT count(*) FROM plugin_mikrotik_processes WHERE taskid = ?', [$seed]);
		$pl             = db_fetch_cell('SELECT count(*) FROM plugin_mikrotik_processes');

		if ($processes_left == 0) {
			print "NOTE: All Processes Complete, Exiting\n";

			break;
		} else {
			print "NOTE: Waiting on '$processes_left' Processes\n";
			sleep(2);
		}
	}

	print "NOTE: Updating Last Run Statistics\n";

	// Update the last runtimes
	// All time/dates will be stored in timestamps;
	// Get Collector Lastrun Information
	$storage_lastrun      = read_config_option('mikrotik_storage_lastrun');
	$trees_lastrun        = read_config_option('mikrotik_trees_lastrun');
	$users_lastrun        = read_config_option('mikrotik_users_lastrun');
	$queues_lastrun       = read_config_option('mikrotik_queues_lastrun');
	$interfaces_lastrun   = read_config_option('mikrotik_interfaces_lastrun');
	$processor_lastrun    = read_config_option('mikrotik_processor_lastrun');
	$wireless_reg_lastrun = read_config_option('mikrotik_wireless_reg_lastrun');

	// Get Collection Frequencies (in seconds)
	$storage_freq        = read_config_option('mikrotik_storage_freq');
	$processor_freq      = read_config_option('mikrotik_processor_freq');
	$trees_freq          = read_config_option('mikrotik_trees_freq');
	$users_freq          = read_config_option('mikrotik_users_freq');
	$queues_freq         = read_config_option('mikrotik_queues_freq');
	$interfaces_freq     = read_config_option('mikrotik_interfaces_freq');
	$wireless_reg_freq   = read_config_option('mikrotik_wireless_reg_freq');

	// set the collector statistics
	if (runCollector($start, $storage_lastrun, $storage_freq)) {
		set_config_option('mikrotik_storage_lastrun', $start);
	}

	if (runCollector($start, $trees_lastrun, $trees_freq)) {
		set_config_option('mikrotik_trees_lastrun', $start);

		// for users that are active, increment data
		db_execute("UPDATE plugin_mikrotik_trees
			SET curBytes=IF(prevBytes>0 AND bytes>prevBytes,(bytes-prevBytes)/$trees_freq,0),
			curPackets=IF(prevPackets>0 AND packets>prevPackets,(packets-prevPackets)/$trees_freq,0),
			curHCBytes=IF(prevHCBytes>0 AND HCBytes>prevHCBytes,(HCBytes-prevHCBytes)/$trees_freq,0)
			WHERE present=1");

		// for users that are active, store previous data
		db_execute('UPDATE plugin_mikrotik_trees
			SET prevBytes=bytes,
			prevPackets=packets,
			prevHCBytes=HCBytes
			WHERE present=1');

		// for users that are inactive, clear information
		db_execute('UPDATE plugin_mikrotik_trees
			SET bytes=0, packets=0, HCBytes=0,
			curBytes=0, curPackets=0, curHCBytes=0,
			prevBytes=0, prevPackets=0, prevHCBytes=0
			WHERE present=0');
	}

	if (runCollector($start, $users_lastrun, $users_freq)) {
		set_config_option('mikrotik_users_lastrun', $start);

		// for users that are active, increment data
		db_execute("UPDATE plugin_mikrotik_users
			SET curBytesIn=IF(prevBytesIn>0 AND bytesIn>prevBytesIn,(bytesIn-prevBytesIn)/$users_freq,0),
			curBytesOut=IF(prevBytesIn>0 AND bytesOut>prevBytesOut,(bytesOut-prevBytesOut)/$users_freq,0),
			curPacketsIn=IF(prevPacketsIn>0 AND packetsIn>prevPacketsIn,(packetsIn-prevPacketsIn)/$users_freq,0),
			curPacketsOut=IF(prevPacketsOut>0 AND packetsOut>prevPacketsOut,(packetsOut-prevPacketsOut)/$users_freq,0)
			WHERE present=1");

		// for users that are active, store previous data
		db_execute('UPDATE plugin_mikrotik_users
			SET prevBytesIn=bytesIn,
			prevBytesOut=bytesOut,
			prevPacketsIn=packetsIn,
			prevPacketsOut=packetsOut
			WHERE present=1');

		// for users that are inactive, clear information
		db_execute('UPDATE plugin_mikrotik_users
			SET bytesIn=0, bytesOut=0, packetsIn=0, packetsOut=0,
			curBytesIn=0, curBytesOut=0, curPacketsIn=0, curPacketsOut=0,
			prevBytesIn=0, prevBytesOut=0, prevPacketsIn=0, prevPacketsOut=0,
			connectTime=0
			WHERE present=0 AND userType=0');
	}

	if (runCollector($start, $wireless_reg_lastrun, $wireless_reg_freq)) {
		set_config_option('mikrotik_wireless_reg_lastrun', $start);

		// for users that are active, increment data
		db_execute("UPDATE plugin_mikrotik_wireless_registrations
			SET curTxBytes=IF(prevTxBytes>0 AND TxBytes>prevTxBytes,(TxBytes-prevTxBytes)/$wireless_reg_freq,0),
			curRxBytes=IF(prevRxBytes>0 AND RxBytes>prevRxBytes,(RxBytes-prevRxBytes)/$wireless_reg_freq,0),
			curTxPackets=IF(prevTxPackets>0 AND TxPackets>prevTxPackets,(TxPackets-prevTxPackets)/$wireless_reg_freq,0),
			curRxPackets=IF(prevRxPackets>0 AND RxPackets>prevRxPackets,(RxPackets-prevRxPackets)/$wireless_reg_freq,0)
			WHERE present=1");

		// for users that are active, store previous data
		db_execute('UPDATE plugin_mikrotik_wireless_registrations
			SET prevTxBytes=TxBytes,
			prevRxBytes=RxBytes,
			prevTxPackets=TxPackets,
			prevRxPackets=RxPackets
			WHERE present=1');

		// for users that are inactive, clear information
		db_execute('UPDATE plugin_mikrotik_wireless_registrations
			SET TxBytes=0, TxPackets=0, RxBytes=0, RxPackets=0,
			curTxBytes=0, curTxPackets=0, curRxBytes=0, curRxPackets=0,
			prevTxBytes=0, prevTxPackets=0, prevRxBytes=0, prevRxPackets=0,
			Uptime=0
			WHERE present=0');
	}

	if (runCollector($start, $processor_lastrun, $processor_freq)) {
		set_config_option('mikrotik_processor_lastrun', $start);
	}

	if (runCollector($start, $interfaces_lastrun, $interfaces_freq)) {
		global $mikrotikInterfaces;

		set_config_option('mikrotik_interfaces_lastrun', $start);

		$sql = '';

		foreach ($mikrotikInterfaces as $key => $oid) {
			if ($key == 'index') {
				continue;
			}

			if ($key == 'name') {
				continue;
			}

			$sql .= (strlen($sql) ? ',' : '') . 'cur' . $key . '=IF(prev' . $key . '>0 AND ' . $key . '>prev' . $key . ',(' . $key . '-prev' . $key . ')/' . $interfaces_freq . ',0)';
		}

		// for users that are active, increment data
		db_execute("UPDATE plugin_mikrotik_interfaces SET $sql WHERE present=1");

		$sql = '';

		foreach ($mikrotikInterfaces as $key => $oid) {
			if ($key == 'index') {
				continue;
			}

			if ($key == 'name') {
				continue;
			}

			$sql .= (strlen($sql) ? ',' : '') . 'prev' . $key . '=' . $key;
		}

		// for users that are active, store previous data
		db_execute("UPDATE plugin_mikrotik_interfaces SET $sql WHERE present=1");

		$sql = '';

		foreach ($mikrotikInterfaces as $key => $oid) {
			if ($key == 'index') {
				continue;
			}

			if ($key == 'name') {
				continue;
			}

			$sql .= (strlen($sql) ? ',' : '') . $key . '=0, cur' . $key . '=0, prev' . $key . '=0';
		}

		// for users that are inactive, clear information
		db_execute("UPDATE plugin_mikrotik_interfaces SET $sql WHERE present=0");
	}

	if (runCollector($start, $queues_lastrun, $queues_freq)) {
		set_config_option('mikrotik_queues_lastrun', $start);

		// for users that are active, increment data
		db_execute("UPDATE plugin_mikrotik_queues
			SET curBytesIn=IF(prevBytesIn>0 AND bytesIn>prevBytesIn,(bytesIn-prevBytesIn)/$queues_freq,0),
			curBytesOut=IF(prevBytesIn>0 AND bytesOut>prevBytesOut,(bytesOut-prevBytesOut)/$queues_freq,0),
			curPacketsIn=IF(prevPacketsIn>0 AND packetsIn>prevPacketsIn,(packetsIn-prevPacketsIn)/$queues_freq,0),
			curPacketsOut=IF(prevPacketsOut>0 AND packetsOut>prevPacketsOut,(packetsOut-prevPacketsOut)/$queues_freq,0),
			curQueuesIn=IF(prevQueuesIn>0 AND queuesIn>prevQueuesIn,(queuesIn-prevQueuesIn)/$queues_freq,0),
			curQueuesOut=IF(prevQueuesOut>0 AND queuesOut>prevQueuesOut,(queuesOut-prevQueuesOut)/$queues_freq,0),
			curDroppedIn=IF(prevDroppedIn>0 AND droppedIn>prevDroppedIn,(droppedIn-prevDroppedIn)/$queues_freq,0),
			curDroppedOut=IF(prevDroppedOut>0 AND droppedOut>prevDroppedOut,(droppedOut-prevDroppedOut)/$queues_freq,0)
			WHERE present=1");

		// for users that are active, store previous data
		db_execute('UPDATE plugin_mikrotik_queues
			SET prevBytesIn=bytesIn,
			prevBytesOut=bytesOut,
			prevPacketsIn=packetsIn,
			prevPacketsOut=packetsOut,
			prevQueuesIn=QueuesIn,
			prevQueuesOut=QueuesOut,
			prevDroppedIn=DroppedIn,
			prevDroppedOut=DroppedOut
			WHERE present=1');

		// for users that are inactive, clear information
		db_execute('UPDATE plugin_mikrotik_queues
			SET bytesIn=0, bytesOut=0, packetsIn=0, packetsOut=0, queuesIn=0, queuesOut=0, droppedIn=0, droppedOut=0,
			curBytesIn=0, curBytesOut=0, curPacketsIn=0, curPacketsOut=0, curQueuesIn=0, curQueuesOut=0, curDroppedIn=0, curDroppedOut=0,
			prevBytesIn=0, prevBytesOut=0, prevPacketsIn=0, prevPacketsOut=0, prevQueuesIn=0, prevQueuesOut=0, prevDroppedIn=0, prevDroppedOut=0
			WHERE present=0');
	}

	if (read_config_option('mikrotik_autopurge') == 'on') {
		print "NOTE: Auto Purging Hosts\n";

		$dead_hosts = db_fetch_assoc('SELECT host_id FROM plugin_mikrotik_system AS hr
			LEFT JOIN host AS h
			ON h.id=hr.host_id
			WHERE h.id IS NULL');

		if (cacti_sizeof($dead_hosts)) {
			foreach ($dead_hosts as $host) {
				db_execute('DELETE FROM plugin_mikrotik_processor WHERE host_id=' . $host['host_id']);
				db_execute('DELETE FROM plugin_mikrotik_system WHERE host_id=' . $host['host_id']);
				db_execute('DELETE FROM plugin_mikrotik_trees WHERE host_id=' . $host['host_id']);
				db_execute('DELETE FROM plugin_mikrotik_users WHERE host_id=' . $host['host_id']);
				db_execute('DELETE FROM plugin_mikrotik_queues WHERE host_id=' . $host['host_id']);
				print "Purging Host with ID '" . $host['host_id'] . "'\n";
			}
		}
	}

	print "NOTE: Updating Summary Statistics for Each Host\n";

	// update some statistics in system
	$stats = db_fetch_assoc('SELECT h.id AS host_id,
		h.status AS host_status,
		AVG(`load`) AS cpuPercent,
		COUNT(`load`) AS numCpus
		FROM host AS h
		INNER JOIN plugin_mikrotik_system AS hrs
		ON h.id=hrs.host_id
		LEFT JOIN plugin_mikrotik_processor AS hrp
		ON hrp.host_id=hrs.host_id
		GROUP BY h.id, h.status');

	if (cacti_sizeof($stats)) {
		$sql_insert = '';

		$sql_prefix = 'INSERT INTO plugin_mikrotik_system
			(host_id, host_status, cpuPercent, numCpus) VALUES ';

		$sql_suffix = ' ON DUPLICATE KEY UPDATE
			host_status=VALUES(host_status),
			cpuPercent=VALUES(cpuPercent),
			numCpus=VALUES(numCpus)';

		$j = 0;

		foreach ($stats as $s) {
			$sql_insert .= (strlen($sql_insert) ? ', ' : '') . '(' .
				$s['host_id'] . ', ' .
				$s['host_status'] . ', ' .
				(!empty($s['cpuPercent']) ? $s['cpuPercent'] : '0') . ', ' .
				(!empty($s['numCpus']) ? $s['numCpus'] : '0') . ')';

			$j++;

			if (($j % 200) == 0) {
				db_execute($sql_prefix . $sql_insert . $sql_suffix);
				$sql_insert = '';
			}
		}

		if (strlen($sql_insert)) {
			db_execute($sql_prefix . $sql_insert . $sql_suffix);
		}
	}

	// update the memory information
	db_execute('INSERT INTO plugin_mikrotik_system
		(host_id, memSize, memUsed, diskSize, diskUsed)
		SELECT host_id,
		SUM(CASE WHEN description="main memory" THEN size * allocationUnits ELSE 0 END) AS memSize,
		SUM(CASE WHEN description="main memory" THEN (used / size) * 100 ELSE 0 END) AS memUsed,
		SUM(CASE WHEN description="system disk" THEN size * allocationUnits ELSE 0 END) AS diskSize,
		SUM(CASE WHEN description="system disk" THEN (used / size) * 100 ELSE 0 END) AS diskUsed
		FROM plugin_mikrotik_storage
		WHERE description IN("main memory", "system disk")
		GROUP BY host_id
		ON DUPLICATE KEY UPDATE
			memSize=VALUES(memSize),
			memUsed=VALUES(memUsed),
			diskSize=VALUES(diskSize),
			diskUsed=VALUES(diskUsed)');

	// update the user information
	db_execute('INSERT INTO plugin_mikrotik_system
		(host_id, users)
		SELECT host_id,
		COUNT(name) AS users
		FROM plugin_mikrotik_users
		WHERE present=1
		GROUP BY host_id
		ON DUPLICATE KEY UPDATE
			users=VALUES(users)');

	// update the maxProcesses information
	db_execute('UPDATE plugin_mikrotik_system SET maxProcesses=processes WHERE processes>maxProcesses');

	print "NOTE: Detecting Host Types Based Upon Host Types Table\n";

	// for hosts that are down, clear information
	db_execute('UPDATE plugin_mikrotik_system
		SET users=0, cpuPercent=0, processes=0, memUsed=0, diskUsed=0, uptime=0, sysUptime=0
		WHERE host_status IN (0,1)');

	// Clear tables when disabled
	if ($storage_freq == -1) {
		db_execute('TRUNCATE plugin_mikrotik_storage');
	} else {
		db_execute('DELETE FROM plugin_mikrotik_storage WHERE host_id NOT IN (SELECT id FROM host)');
	}

	if ($processor_freq == -1) {
		db_execute('TRUNCATE plugin_mikrotik_processor');
	} else {
		db_execute('DELETE FROM plugin_mikrotik_processor WHERE host_id NOT IN (SELECT id FROM host)');
	}

	if ($trees_freq == -1) {
		db_execute('TRUNCATE plugin_mikrotik_trees');
	} else {
		db_execute('DELETE FROM plugin_mikrotik_trees WHERE host_id NOT IN (SELECT id FROM host)');
	}

	if ($users_freq == -1) {
		db_execute('TRUNCATE plugin_mikrotik_users');
	} else {
		db_execute('DELETE FROM plugin_mikrotik_users WHERE host_id NOT IN (SELECT id FROM host)');
	}

	if ($queues_freq == -1) {
		db_execute('TRUNCATE plugin_mikrotik_queues');
	} else {
		db_execute('DELETE FROM plugin_mikrotik_queues WHERE host_id NOT IN (SELECT id FROM host)');
	}

	if ($interfaces_freq == -1) {
		db_execute('TRUNCATE plugin_mikrotik_interfaces');
	} else {
		db_execute('DELETE FROM plugin_mikrotik_interfaces WHERE host_id NOT IN (SELECT id FROM host)');
	}

	// prune old tables of orphan hosts
	db_execute('DELETE FROM plugin_mikrotik_system WHERE host_id NOT IN (SELECT id FROM host)');
	db_execute('DELETE FROM plugin_mikrotik_system_health WHERE host_id NOT IN (SELECT id FROM host)');

	// take time and log performance data
	$end = microtime(true);

	$interfaces = db_fetch_cell('SELECT count(*) FROM plugin_mikrotik_interfaces WHERE present=1');
	$queues     = db_fetch_cell('SELECT count(*) FROM plugin_mikrotik_queues WHERE present=1');
	$users      = db_fetch_cell('SELECT count(*) FROM plugin_mikrotik_users WHERE present=1');
	$trees      = db_fetch_cell('SELECT count(*) FROM plugin_mikrotik_trees WHERE present=1');
	$waps       = db_fetch_cell('SELECT count(*) FROM plugin_mikrotik_wireless_aps WHERE present=1');
	$wreg       = db_fetch_cell('SELECT count(*) FROM plugin_mikrotik_wireless_registrations WHERE present=1');

	$cacti_stats = sprintf(
		'Time:%0.2f Processes:%s Hosts:%s Interfaces:%s Queues:%s Users:%s Trees:%s Waps:%s Wreg:%s',
		$end - $start,
		$concurrent_processes,
		sizeof($hosts),
		$interfaces,
		$queues,
		$users,
		$trees,
		$waps,
		$wreg
	);

	// log to the database
	set_config_option('stats_mikrotik', $cacti_stats);

	// log to the logfile
	cacti_log('MIKROTIK STATS: ' . $cacti_stats , true, 'SYSTEM');
	print "NOTE: MikroTik Polling Completed, $cacti_stats\n";

	// launch the graph creation process
	process_graphs();
}

/**
 * Launches a background poller_mikrotik.php worker process to collect
 * data for a single host. Called from process_hosts() for each
 * discovered MikroTik device, respecting the configured concurrency
 * limit.
 *
 * @param int   $host_id The host id to collect data for.
 * @param mixed $seed    The current run's seed value, used to tag the
 *                       launched process.
 * @param mixed $key     The placeholder process-lock key to pass
 *                       through so the worker can remove it once it
 *                       registers its own lock.
 *
 * @return void
 *
 * @global array $config   Cacti global configuration array; used to
 *                         resolve the PHP binary and this plugin's
 *                         poller script path.
 * @global bool  $debug    Whether debug output is enabled, propagated
 *                         to the worker via '--debug'.
 * @global float $start    The current run's start time, propagated to
 *                         the worker via '--start'.
 * @global bool  $forcerun Whether this run was forced, propagated to
 *                         the worker via '--force'.
 */
function process_host(int $host_id, $seed, $key): void {
	global $config, $debug, $start, $forcerun;

	exec_background(read_config_option('path_php_binary'),' -q ' .
		$config['base_path'] . '/plugins/mikrotik/poller_mikrotik.php' .
		' --host-id=' . $host_id .
		' --start=' . $start .
		' --seed=' . $seed .
		' --key=' . $key .
		($forcerun ? ' --force' : '') .
		($debug ? ' --debug' : ''));
}

/**
 * Launches a background poller_graphs.php process to run graph
 * automation once all per-host data collection has completed. Called
 * from process_hosts() at the end of a collection cycle.
 *
 * @return void
 *
 * @global array $config   Cacti global configuration array; used to
 *                         resolve the PHP binary and poller_graphs.php
 *                         path.
 * @global bool  $debug    Whether debug output is enabled, propagated
 *                         via '--debug'.
 * @global float $start    Reserved/declared for parity with
 *                         process_host(); not used directly here.
 * @global bool  $forcerun Whether this run was forced, propagated via
 *                         '--force'.
 */
function process_graphs(): void {
	global $config, $debug, $start, $forcerun;

	exec_background(read_config_option('path_php_binary'),' -q ' .
		$config['base_path'] . '/plugins/mikrotik/poller_graphs.php' .
		($forcerun ? ' --force' : '') .
		($debug ? ' --debug' : ''));
}

/**
 * Runs the full set of per-host MikroTik collectors for a single device
 * (system info, users, storage, trees, queues, interfaces, wireless
 * APs/registrations, processor, and DNS/DHCP/list details), each only
 * when its own configured collection interval is due, skipping
 * everything beyond system info if the device is detected as down.
 * Called from this script's main flow when run with a specific
 * '--host-id' (i.e. as a per-host worker launched by process_host()).
 *
 * @param int $host_id The host id to collect data for.
 *
 * @return void
 *
 * @global array $config Cacti global configuration array; used to load
 *                       the MikroTik SNMP MIB when supported.
 * @global float $start  The current run's start time, used to decide
 *                       which sub-collectors are due.
 * @global mixed $seed   The current run's seed value, used to register
 *                       this worker's process lock.
 * @global mixed $key    The placeholder process-lock key from the
 *                       launching process_host() call, removed once
 *                       this worker registers its own lock.
 */
function checkHost(int $host_id): void {
	global $config, $start, $seed, $key;

	// All time/dates will be stored in timestamps;
	// Get Collector Lastrun Information
	$storage_lastrun      = read_config_option('mikrotik_storage_lastrun');
	$trees_lastrun        = read_config_option('mikrotik_trees_lastrun');
	$users_lastrun        = read_config_option('mikrotik_users_lastrun');
	$queues_lastrun       = read_config_option('mikrotik_queues_lastrun');
	$interfaces_lastrun   = read_config_option('mikrotik_interfaces_lastrun');
	$list_lastrun         = read_config_option('mikrotik_list_lastrun');
	$processor_lastrun    = read_config_option('mikrotik_processor_lastrun');
	$wireless_aps_lastrun = read_config_option('mikrotik_wireless_aps_lastrun');
	$wireless_reg_lastrun = read_config_option('mikrotik_wireless_reg_lastrun');

	// Get Collection Frequencies (in seconds)
	$storage_freq       = read_config_option('mikrotik_storage_freq');
	$trees_freq         = read_config_option('mikrotik_trees_freq');
	$users_freq         = read_config_option('mikrotik_users_freq');
	$queues_freq        = read_config_option('mikrotik_queues_freq');
	$interfaces_freq    = read_config_option('mikrotik_interfaces_freq');
	$list_freq          = read_config_option('mikrotik_dns_dhcp_list_freq');
	$processor_freq     = read_config_option('mikrotik_processor_freq');
	$wireless_aps_freq  = read_config_option('mikrotik_wireless_aps_freq');
	$wireless_reg_freq  = read_config_option('mikrotik_wireless_reg_freq');

	// remove the key process and insert the set a process lock
	if (!empty($key)) {
		db_execute("DELETE FROM plugin_mikrotik_processes WHERE pid=$key");
	}
	db_execute('REPLACE INTO plugin_mikrotik_processes (pid, taskid) VALUES (' . getmypid() . ", $seed)");

	// obtain host information
	$host = db_fetch_row_prepared('SELECT * FROM host WHERE id = ?', [$host_id]);

	if (!is_array($host)) {
		db_execute('DELETE FROM plugin_mikrotik_processes WHERE pid=' . getmypid());
		return;
	}

	if (function_exists('snmp_read_mib')) {
		debug('Function snmp_read_mib() EXISTS!');
		snmp_read_mib($config['base_path'] . '/plugins/mikrotik/MIKROTIK-MIB.txt');
	} else {
		putenv('MIBS=all');
	}

	$system_up = collect_system($host);

	if (!$system_up) {
		cacti_log('MikroTik System: ' . $host['id'] . ' Is down and will not be interrogated');
	} else {
		if (runCollector($start, $users_lastrun, $users_freq)) {
			collect_users($host);

			$time_to_live   = read_config_option('mikrotik_user_exclusion_ttl');
			$user_exclusion = read_config_option('mikrotik_user_exclusion');

			if (empty($time_to_live)) {
				$time_to_live = 3600;

				set_config_option('mikrotik_user_exclusion_ttl', $time_to_live);
			}

			if ($user_exclusion != '') {
				// Remove old records
				db_execute_prepared('DELETE FROM plugin_mikrotik_users
					WHERE userType = 0
					AND name RLIKE ?
					AND present = 0
					AND host_id = ?
					AND last_seen < FROM_UNIXTIME(UNIX_TIMESTAMP() - ?)',
					[$user_exclusion, $host['id'], $time_to_live]);
			} else {
				// Remove old records
				db_execute_prepared('DELETE FROM plugin_mikrotik_users
					WHERE userType = 0
					AND present = 0
					AND host_id = ?
					AND last_seen < FROM_UNIXTIME(UNIX_TIMESTAMP() - ?)',
					[$host['id'], $time_to_live]);
			}
		}

		if (runCollector($start, $trees_lastrun, $trees_freq)) {
			collect_trees($host);
		}

		if (runCollector($start, $queues_lastrun, $queues_freq)) {
			collect_queues($host);
			collect_pppoe_users_api($host);
		}

		if (runCollector($start, $interfaces_lastrun, $interfaces_freq)) {
			collect_interfaces($host);
		}

		if (runCollector($start, $list_lastrun, $list_freq)) {
			set_config_option('mikrotik_list_lasrun', $start);

			collect_dhcp_details($host);
			collect_dns_details($host);
			collect_list_details($host);
		}

		if (runCollector($start, $processor_lastrun, $processor_freq)) {
			collect_processor($host);
		}

		if (runCollector($start, $storage_lastrun, $storage_freq)) {
			collect_storage($host);
		}

		if (runCollector($start, $wireless_aps_lastrun, $wireless_aps_freq)) {
			collect_wireless_aps($host);
		}

		if (runCollector($start, $wireless_reg_lastrun, $wireless_reg_freq)) {
			collect_wireless_reg($host);
		}

		if (!function_exists('snmp_read_mib')) {
			putenv('MIBS=');
		}
	}

	// remove the process lock
	db_execute('DELETE FROM plugin_mikrotik_processes WHERE pid=' . getmypid());
}

/**
 * Queries a device's Host Resources System group, MIB-II system group,
 * and MikroTik-specific system/health OIDs via SNMP, maps the returned
 * values to their plugin_mikrotik_system/plugin_mikrotik_system_health
 * columns (parsing/normalizing date, uptime, and health metric scaling
 * along the way), and updates the device's rows with the collected
 * values. Called from checkHost() for every device, on every run, to
 * determine whether the device is reachable before running other
 * collectors.
 *
 * @param array $host Reference, the Cacti host row to collect data
 *                    for, providing SNMP connection settings.
 *
 * @return bool True if the device responded and was successfully
 *              collected, false if the initial SNMP walk failed
 *              (device considered down).
 *
 * @global array $mikrotikSystem Map of OID => plugin_mikrotik_system
 *                               column name, used to translate SNMP
 *                               results into database columns.
 * @global array $config         Cacti global configuration array
 *                               (declared but not directly used
 *                               here).
 */
function collect_system(array &$host): bool {
	global $mikrotikSystem, $config;

	if (cacti_sizeof($host)) {
		// Collect system mib information first
		debug("Polling System from '" . $host['description'] . '[' . $host['hostname'] . "]'");
		$hostMib   = cacti_snmp_walk($host['hostname'], $host['snmp_community'], '.1.3.6.1.2.1.25.1', $host['snmp_version'],
			$host['snmp_username'], $host['snmp_password'],
			$host['snmp_auth_protocol'], $host['snmp_priv_passphrase'], $host['snmp_priv_protocol'],
			$host['snmp_context'], $host['snmp_port'], $host['snmp_timeout'],
			read_config_option('snmp_retries'), $host['max_oids'], SNMP_WEBUI, $host['snmp_engine_id']);

		if ($hostMib == false) {
			return false;
		}

		$systemMib = cacti_snmp_walk($host['hostname'], $host['snmp_community'], '.1.3.6.1.2.1.1', $host['snmp_version'],
			$host['snmp_username'], $host['snmp_password'],
			$host['snmp_auth_protocol'], $host['snmp_priv_passphrase'], $host['snmp_priv_protocol'],
			$host['snmp_context'], $host['snmp_port'], $host['snmp_timeout'],
			read_config_option('snmp_retries'), $host['max_oids'], SNMP_WEBUI, $host['snmp_engine_id']);

		$hostMib = array_merge($hostMib, $systemMib);

		$set_string = '';

		// Locate the values names
		if (cacti_sizeof($hostMib)) {
			foreach ($hostMib as $mib) {
				// do some cleanup
				if (substr($mib['oid'], 0, 1) != '.') {
					$mib['oid'] = '.' . trim($mib['oid']);
				}

				if (substr($mib['value'], 0, 4) == 'OID:') {
					$mib['value'] = str_replace('OID:', '', $mib['value']);
				}

				$key = array_search($mib['oid'], $mikrotikSystem, true);

				if ($key == 'date') {
					$mib['value'] = mikrotik_dateParse($mib['value']);
				} elseif ($key == 'uptime') {
					[$days, $hours, $minutes, $seconds] = explode(':', $mib['value']);
					$mib['value']                       = (((int) $days * 86400) + ((int) $hours * 3600) + ((int) $minutes * 60) + (int) $seconds) * 100;
				}

				if (!empty($key)) {
					$set_string .= (strlen($set_string) ? ',' : '') . $key . '=' . db_qstr(trim($mib['value'], ' "'));
				}
			}
		}

		// Update the values
		if (strlen($set_string)) {
			db_execute("UPDATE plugin_mikrotik_system SET $set_string WHERE host_id=" . $host['id']);
		}

		// system mibs
		$tikInfoOIDs = [
			'softwareId'            => '.1.3.6.1.4.1.14988.1.1.4.1.0',
			'licVersion'            => '.1.3.6.1.4.1.14988.1.1.4.4.0',
			'firmwareVersion'       => '.1.3.6.1.4.1.14988.1.1.7.4.0',
			'firmwareVersionLatest' => '.1.3.6.1.4.1.14988.1.1.7.7.0',
			'serialNumber'          => '.1.3.6.1.4.1.14988.1.1.7.3.0'
		];

		foreach ($tikInfoOIDs as $key => $oid) {
			$tikInfoData[$key] = cacti_snmp_get($host['hostname'], $host['snmp_community'], $oid, $host['snmp_version'],
				$host['snmp_username'], $host['snmp_password'],
				$host['snmp_auth_protocol'], $host['snmp_priv_passphrase'], $host['snmp_priv_protocol'],
				$host['snmp_context'], $host['snmp_port'], $host['snmp_timeout'],
				read_config_option('snmp_retries'), SNMP_WEBUI, $host['snmp_engine_id']);

			db_execute("UPDATE plugin_mikrotik_system SET $key=" . db_qstr($tikInfoData[$key]) . ' WHERE host_id=' . $host['id']);
		}

		// Load the MikroTik MIB to get good values
		putenv('MIBS=All');

		// health oids
		$tikHealthOIDs = [
			'HlCoreVoltage'            => '.1.3.6.1.4.1.14988.1.1.3.1.0',
			'HlThreeDotThreeVoltage'   => '.1.3.6.1.4.1.14988.1.1.3.2.0',
			'HlFiveVoltage'            => '.1.3.6.1.4.1.14988.1.1.3.3.0',
			'HlTwelveVoltage'          => '.1.3.6.1.4.1.14988.1.1.3.4.0',
			'HlSensorTemperature'      => '.1.3.6.1.4.1.14988.1.1.3.5.0',
			'HlCpuTemperature'         => '.1.3.6.1.4.1.14988.1.1.3.6.0',
			'HlBoardTemperature'       => '.1.3.6.1.4.1.14988.1.1.3.7.0',
			'HlVoltage'                => '.1.3.6.1.4.1.14988.1.1.3.8.0',
			'HlActiveFan'              => '.1.3.6.1.4.1.14988.1.1.3.9.0',
			'HlTemperature'            => '.1.3.6.1.4.1.14988.1.1.3.10.0',
			'HlProcessorTemperature'   => '.1.3.6.1.4.1.14988.1.1.3.11.0',
			'HlPower'                  => '.1.3.6.1.4.1.14988.1.1.3.12.0',
			'HlCurrent'                => '.1.3.6.1.4.1.14988.1.1.3.13.0',
			'HlProcessorFrequency'     => '.1.3.6.1.4.1.14988.1.1.3.14.0',
			'HlPowerSupplyState'       => '.1.3.6.1.4.1.14988.1.1.3.15.0',
			'HlBackupPowerSupplyState' => '.1.3.6.1.4.1.14988.1.1.3.16.0',
			'HlFanSpeed1'              => '.1.3.6.1.4.1.14988.1.1.3.17.0',
			'HlFanSpeed2'              => '.1.3.6.1.4.1.14988.1.1.3.18.0'
		];

		$healthMibs = cacti_snmp_walk($host['hostname'], $host['snmp_community'], '.1.3.6.1.4.1.14988.1.1.3', $host['snmp_version'],
			$host['snmp_username'], $host['snmp_password'],
			$host['snmp_auth_protocol'], $host['snmp_priv_passphrase'], $host['snmp_priv_protocol'],
			$host['snmp_context'], $host['snmp_port'], $host['snmp_timeout'],
			read_config_option('snmp_retries'), $host['max_oids'], SNMP_WEBUI, $host['snmp_engine_id']);

		$set_string = '';

		// Locate the values names
		if (cacti_sizeof($healthMibs)) {
			foreach ($healthMibs as $mib) {
				// do some cleanup
				if (substr($mib['oid'], 0, 1) != '.') {
					$mib['oid'] = '.' . trim($mib['oid']);
				}

				if (substr($mib['value'], 0, 4) == 'OID:') {
					$mib['value'] = str_replace('OID:', '', $mib['value']);
				}

				$key = array_search($mib['oid'], $tikHealthOIDs, true);

				// Attempt to Compensate for missing MikroTik MIB
				if ($key == 'HlCoreVoltage') {
					if ($mib['value'] > 150) {
						$mib['value'] /= 10;
					}
				} elseif ($key == 'HlThreeDotThreeVoltage') {
					if ($mib['value'] > 10) {
						$mib['value'] /= 10;
					}
				} elseif ($key == 'HlFiveVoltage') {
					if ($mib['value'] > 10) {
						$mib['value'] /= 10;
					}
				} elseif ($key == 'HlTwelveVoltage') {
					if ($mib['value'] > 40) {
						$mib['value'] /= 10;
					}
				} elseif ($key == 'HlSensorTemperature') {
					if ($mib['value'] > 100) {
						$mib['value'] /= 10;
					}
				} elseif ($key == 'HlCpuTemperature') {
					if ($mib['value'] > 100) {
						$mib['value'] /= 10;
					}
				} elseif ($key == 'HlBoardTemperature') {
					if ($mib['value'] > 100) {
						$mib['value'] /= 10;
					}
				} elseif ($key == 'HlVoltage') {
					if ($mib['value'] > 150) {
						$mib['value'] /= 10;
					}
				} elseif ($key == 'HlTemperature') {
					if ($mib['value'] > 100) {
						$mib['value'] /= 10;
					}
				} elseif ($key == 'HlProcessorTemperature') {
					if ($mib['value'] > 100) {
						$mib['value'] /= 10;
					}
				} elseif ($key == 'HlPower') {
					if ($mib['value'] > 100) {
						$mib['value'] /= 10;
					}
				} elseif ($key == 'HlCurrent') {
					if ($mib['value'] > 100) {
						$mib['value'] /= 10;
					}
				}

				if (!empty($key)) {
					$set_string .= (strlen($set_string) ? ',' : '') . $key . '=' . (is_numeric($mib['value']) ? $mib['value'] : db_qstr(trim($mib['value'], ' "')));
				}
			}
		}

		// Update the values
		if (strlen($set_string)) {
			db_execute('INSERT IGNORE INTO plugin_mikrotik_system_health (host_id) VALUES (' . $host['id'] . ')');
			db_execute("UPDATE plugin_mikrotik_system_health SET $set_string WHERE host_id=" . $host['id']);
		}

		return true;
	}

	return false;
}

/**
 * Parses a Host Resources hrSystemDate-style comma-separated date/time
 * string (dropping any sub-second fraction) into a normalized date/time
 * string, falling back to the current time if the value can't be
 * parsed. Called from collect_system() to normalize the system date
 * field.
 *
 * @param string $value The raw date/time string returned by the device.
 *
 * @return string The normalized date/time string.
 */
function mikrotik_dateParse(string $value): string {
	$value = explode(',', $value);

	if (isset($value[1]) && strpos($value[1], '.')) {
		$value[1] = substr($value[1], 0, (int) strpos($value[1], '.'));
	}

	$date1 = trim($value[0] . ' ' . ($value[1] ?? ''));

	if (strtotime($date1) === false) {
		$value = date('Y-m-d H:i:s');
	} else {
		$value = $date1;
	}

	return $value;
}

/**
 * Normalizes a MAC address value returned via SNMP into a colon-
 * separated hex string, passing already-hex-formatted values through
 * unchanged. Called from collect result-processing code when a
 * collected field represents a MAC address.
 *
 * @param string $value The raw MAC address value (either already
 *                      hex-formatted, or raw binary octets).
 *
 * @return string The MAC address as a colon-separated hex string.
 */
function mikrotik_macParse(string $value): string {
	if (is_hexadecimal($value)) {
		return $value;
	} else {
		$newval = '';

		for ($i = 0; $i < strlen($value); $i++) {
			$newval .= (strlen($newval) ? ':' : '') . bin2hex($value[$i]);
		}

		return ($newval);
	}
}

/**
 * Splits a table entry's full OID into its base table OID and trailing
 * index portion, supporting multi-component (compound) indexes of a
 * given depth. Called from collectHostIndexedOid() while processing
 * walked table rows.
 *
 * @param string $oid   The full OID (base + index) to split.
 * @param int    $depth The number of trailing dot-separated components
 *                      that make up the index (1 for a simple scalar
 *                      index, more for compound indexes).
 *
 * @return array A two-element [base, index] array, or an empty array if
 *               no index portion could be extracted.
 */
function mikrotik_splitBaseIndex(string $oid, int $depth = 1): array {
	$oid        = strrev($oid);
	$parts      = explode('.', $oid);
	$index      = '';

	for ($i = 0; $i < $depth; $i++) {
		$index .= ($i > 0 ? '.' : '') . $parts[$i];
		unset($parts[$i]);
	}

	$base  = strrev(implode('.', $parts));
	$index = strrev($index);

	if ($index != '') {
		return [$base, $index];
	} else {
		return [];
	}
}

/**
 * Generic MikroTik indexed-table collector: walks every OID column
 * defined in a table's SNMP tree map for a device, reassembles the
 * per-index rows (supporting compound indexes via $depth), and
 * bulk-upserts the resulting rows into the target table, either
 * marking rows no longer present as absent (default) or deleting them
 * outright when $preserve is false. Called from collect_trees(),
 * collect_users(), collect_queues(), collect_interfaces(),
 * collect_processor(), collect_storage(), collect_wireless_aps(), and
 * collect_wireless_reg() for each MikroTik table type.
 *
 * @param array  $host     Reference, the Cacti host row to collect data
 *                         for, providing SNMP connection settings.
 * @param array  $tree     Map of column name => OID defining the
 *                         table's SNMP structure to walk.
 * @param string $table    The plugin_mikrotik_* database table to
 *                         upsert the collected rows into.
 * @param string $name     A display name for this table, used in
 *                         debug/log messages.
 * @param bool   $preserve Whether to keep rows no longer seen (marking
 *                         them absent) rather than deleting them.
 * @param int    $depth    The number of trailing OID components making
 *                         up each row's index, passed through to
 *                         mikrotik_splitBaseIndex().
 *
 * @return void
 */
function collectHostIndexedOid(array &$host, array $tree, string $table, string $name, bool $preserve = false, int $depth = 1): void {
	static $types;

	debug("Beginning Processing for '" . $host['description'] . '[' . $host['hostname'] . "]', Table '$name'");

	if (cacti_sizeof($host)) {
		// mark for deletion
		if ($name == 'users') {
			db_execute("UPDATE $table SET present=0 WHERE host_id=" . $host['id'] . ' AND userType=0');
		} else {
			db_execute("UPDATE $table SET present=0 WHERE host_id=" . $host['id']);
		}

		debug("Polling $name from '" . $host['description'] . '[' . $host['hostname'] . "]'");
		$treeMib   = [];
		$goodVals  = [];

		foreach ($tree as $mname => $oid) {
			if ($name == 'processor') {
				// collect
			} elseif ($mname == 'mac') {
				// collect
			} elseif ($mname == 'apBSSID') {
				// collect
			} elseif ($mname == 'date') {
				// collect
			} elseif ($mname != 'baseOID') {
				// collect
			} else {
				continue;
			}

			$walk = cacti_snmp_walk($host['hostname'], $host['snmp_community'], $oid, $host['snmp_version'],
				$host['snmp_username'], $host['snmp_password'],
				$host['snmp_auth_protocol'], $host['snmp_priv_passphrase'], $host['snmp_priv_protocol'],
				$host['snmp_context'], $host['snmp_port'], $host['snmp_timeout'],
				read_config_option('snmp_retries'), $host['max_oids'], SNMP_WEBUI, $host['snmp_engine_id']);

			if (cacti_sizeof($walk)) {
				$goodVals[$mname] = true;
			} else {
				$goodVals[$mname] = false;
			}

			if (($mname == 'index' || $mname == 'name' || $mname == 'apSSID' || $mname == 'Strength') && !sizeof($walk)) {
				debug('No Index Information for OID: ' . $oid . ' on ' . $host['description'] . ' returning');

				return;
			}

			if ($goodVals[$mname]) {
				$treeMib = array_merge($treeMib, $walk);
			}

			debug('Polled: ' . $host['description'] . ', OID: ' . $oid . ', Size: ' . sizeof($walk));
		}

		$set_string = '';
		$values     = '';
		$sql_suffix = '';
		$sql_prefix = "INSERT INTO $table";

		if (cacti_sizeof($tree)) {
			foreach ($tree as $mname => $oid) {
				if ($mname != 'baseOID' && $mname != 'index') {
					if ($goodVals[$mname] == true) {
						$values .= (strlen($values) ? '`, `' : '`') . $mname;
						$sql_suffix .= (!strlen($sql_suffix) ? ' ON DUPLICATE KEY UPDATE `index`=VALUES(`index`), `' : ', `') . $mname . '`=VALUES(`' . $mname . '`)';
					}
				}
			}
		}

		$sql_prefix .= ' (`host_id`, `index`, ' . ($preserve ? '`last_seen`, ' : '') . $values . '`) VALUES ';
		$sql_suffix .= ', present=1' . ($preserve ? ', last_seen=NOW()' : '');

		// Locate the values names
		$prevIndex    = '';
		$new_array    = [];

		if (cacti_sizeof($treeMib)) {
			foreach ($treeMib as $mib) {
				// do some cleanup
				if (substr($mib['oid'], 0, 1) != '.') {
					$mib['oid'] = '.' . $mib['oid'];
				}

				if (substr($mib['value'], 0, 4) == 'OID:') {
					$mib['value'] = trim(str_replace('OID:', '', $mib['value']));
				}

				$splitIndex = mikrotik_splitBaseIndex($mib['oid'], $depth);

				if (cacti_sizeof($splitIndex)) {
					if ($name == 'wireless_registrations') {
						$parts = explode('.', $splitIndex[1]);
						$index = '';

						for ($i = 0; $i < 6; $i++) {
							$index .= ($i > 0 ? ':' : '') . substr('0' . dechex((int) $parts[$i]), -2);
						}
					} else {
						$index = $splitIndex[1];
					}

					$oid   = $splitIndex[0];
					$key   = array_search($oid, $tree, true);

					if (!empty($key) && $goodVals[$key] == true) {
						if ($key == 'type') {
							if ($mib['value'] == '.1.3.6.1.2.1.25.2.1.1') {
								$new_array[$index][$key] = 11;
							} elseif ($mib['value'] == '.1.3.6.1.2.1.25.2.1.4') {
								$new_array[$index][$key] = 14;
							}
						} elseif ($key == 'name') {
							$new_array[$index][$key] = str_replace('<', '', str_replace('>', '', $mib['value']));
						} elseif ($key == 'date') {
							$new_array[$index][$key] = mikrotik_dateParse($mib['value']);
						} elseif ($key == 'mac') {
							$new_array[$index][$key] = mikrotik_macParse($mib['value']);
						} elseif ($key != 'index') {
							$new_array[$index][$key] = $mib['value'];
						}

						if (!empty($key) && $key != 'index') {
							debug("Key:'" . $key . "', Orig:'" . $mib['oid'] . "', Val:'" . (isset($new_array[$index]) ? $new_array[$index][$key] : '(Index not defined)') . "', Index:'" . $index . "', Base:'" . $oid . "'");
						}
					}
				} else {
					print "WARNING: Error parsing OID value\n";
				}
			}
		}

		// dump the output to the database
		$sql_insert = '';

		if (cacti_sizeof($new_array)) {
			foreach ($new_array as $index => $item) {
				$sql_insert .= (strlen($sql_insert) ? '), (' : '(') . $host['id'] . ", '" . $index . "', " . ($preserve ? 'NOW(), ' : '');
				$i = 0;

				foreach ($tree as $mname => $oid) {
					if ($mname != 'baseOID' && $mname != 'index') {
						if ($goodVals[$mname] == true) {
							$sql_insert .= ($i > 0 ? ', ' : '') . (isset($item[$mname]) && $item[$mname] != '' ? db_qstr($item[$mname]) : "''");
							$i++;
						}
					}
				}
			}
			$sql_insert .= ')';
		}

		// print $sql_prefix . $sql_insert . $sql_suffix . "\n";

		if (strlen($sql_insert)) {
			db_execute($sql_prefix . $sql_insert . $sql_suffix);
		}

		if (!$preserve) {
			db_execute_prepared("DELETE FROM $table
				WHERE host_id = ?
				AND present = 0",
				[$host['id']]);
		}
	}
}

/**
 * Collects a device's queue tree (trees) table via
 * collectHostIndexedOid(). Called from checkHost() when this
 * collector's interval is due.
 *
 * @param array $host Reference, the Cacti host row to collect data for.
 *
 * @return void
 *
 * @global array $mikrotikTrees The trees SNMP tree map (column => OID).
 */
function collect_trees(array &$host): void {
	global $mikrotikTrees;
	collectHostIndexedOid($host, $mikrotikTrees, 'plugin_mikrotik_trees', 'trees', true);
}

/**
 * Collects a device's PPP/hotspot user (users) table via
 * collectHostIndexedOid(). Called from checkHost() when this
 * collector's interval is due.
 *
 * @param array $host Reference, the Cacti host row to collect data for.
 *
 * @return void
 *
 * @global array $mikrotikUsers The users SNMP tree map (column => OID).
 */
function collect_users(array &$host): void {
	global $mikrotikUsers;
	collectHostIndexedOid($host, $mikrotikUsers, 'plugin_mikrotik_users', 'users', true);
}

/**
 * Collects a device's firewall address-list entries via the RouterOS
 * API (not SNMP), upserting them into plugin_mikrotik_lists and
 * marking/purging entries no longer present, or purging all entries if
 * the API call indicates the address-list feature isn't available.
 * Called from collect_dhcp_details()-style API collectors when this
 * collector's interval is due and the RouterOS API is enabled with
 * valid credentials.
 *
 * @param array $host Reference, the Cacti host row to collect data for,
 *                    providing its stored RouterOS API credentials.
 *
 * @return void
 */
function collect_list_details(array &$host): void {
	$rows = [];

	$api        = new RouterosAPI();
	$api->debug = false;

	$creds = db_fetch_row_prepared('SELECT *
		FROM plugin_mikrotik_credentials
		WHERE host_id = ?',
		[$host['id']]);

	$start = microtime(true);

	if (is_array($creds) && cacti_sizeof($creds) && read_config_option('mikrotik_api_enabled') == 'on') {
		if ($api->connect($host['hostname'], $creds['user'], $creds['password'])) {
			$noServer = false;

			$api->write('/ip/firewall/address-list/print');

			$read  = $api->read(false);

			if (isset($read[0]) && $read[0] == '!trap') {
				$noServer = true;
			}

			$array = $api->parseResponse($read);

			$end = microtime(true);

			$sql   = [];
			$sql2  = [];
			$list  = [];

			if ($noServer === false && cacti_sizeof($array) > 0) {
				cacti_log('MIKROTIK RouterOS API STATS: Device[' . $host['id'] . '], API Returned ' . sizeof($array) . ' Address List Entries in ' . round($end - $start,2) . ' seconds.', false, 'SYSTEM');
			}

			if (cacti_sizeof($array) && $noServer === false) {
				foreach ($array as $row) {
					$list['host_id']  = $host['id'];
					$list['dynamic']  = $row['dynamic'] ?? '0';
					$list['disabled'] = $row['disabled'] ?? '0';
					$list['list']     = $row['list'] ?? 'N/A';
					$list['address']  = $row['address'] ?? '';
					$list['created']  = isset($row['creation-time']) ? date('Y-m-d H:i:s', (int) strtotime(str_replace('/', ' ', $row['creation-time']))) : date('Y-m-d H:i:s');
					$list['timeout']  = isset($row['timeout']) ? mikrotik_parse_ttl($row['timeout']) : '-1';

					$sql[] = '(' .
						$list['host_id'] . ',' .
						db_qstr($list['dynamic']) . ',' .
						db_qstr($list['disabled']) . ',' .
						db_qstr($list['list']) . ',' .
						db_qstr($list['address']) . ',' .
						db_qstr($list['created']) . ',' .
						db_qstr($list['timeout']) . ', 1)';
				}
			}

			if (cacti_sizeof($sql)) {
				db_execute_prepared('UPDATE plugin_mikrotik_lists
					SET present = 0
					WHERE host_id = ?',
					[$host['id']]);

				db_execute('INSERT INTO plugin_mikrotik_lists
					(`host_id`, `dynamic`, `disabled`, `list`, `address`, `created`, `timeout`, `present`)
					VALUES ' . implode(', ', $sql) . '
					ON DUPLICATE KEY UPDATE
						dynamic=VALUES(dynamic),
						disabled=VALUES(disabled),
						timeout=VALUES(timeout),
						created=VALUES(created),
						present=1');

				db_execute_prepared('UPDATE plugin_mikrotik_lists
					SET timeout= 0
					WHERE present = 0
					AND host_id = ?',
					[$host['id']]);
			}

			if ($noServer === true) {
				db_execute_prepared('DELETE FROM plugin_mikrotik_lists WHERE host_id = ?', [$host['id']]);
			} else {
				$retention = read_config_option('mikrotik_list_retention');

				if ($retention > 0) {
					db_execute_prepared('DELETE FROM plugin_mikrotik_lists
						WHERE UNIX_TIMESTAMP(last_updated) < UNIX_TIMESTAMP() - ?
						AND host_id = ?',
						[$retention, $host['id']]);
				}
			}

			$api->disconnect();
		} else {
			cacti_log('ERROR: Device[' . $host['id'] . '] for RouterOS API Call Timed Out.  Check for an invalid API password!');
		}
	}
}

/**
 * Collects a device's DNS cache/static entries via the RouterOS API
 * (not SNMP), upserting them into their plugin_mikrotik_dns table and
 * marking/purging entries no longer present. Called from checkHost()
 * when this collector's interval is due and the RouterOS API is
 * enabled with valid credentials.
 *
 * @param array $host Reference, the Cacti host row to collect data for,
 *                    providing its stored RouterOS API credentials.
 *
 * @return void
 */
function collect_dns_details(array &$host): void {
	$rows = [];

	$api        = new RouterosAPI();
	$api->debug = false;

	$creds = db_fetch_row_prepared('SELECT *
		FROM plugin_mikrotik_credentials
		WHERE host_id = ?',
		[$host['id']]);

	$start = microtime(true);

	if (is_array($creds) && cacti_sizeof($creds) && read_config_option('mikrotik_api_enabled') == 'on') {
		if ($api->connect($host['hostname'], $creds['user'], $creds['password'])) {
			$noServer = false;

			$api->write('/ip/dns/cache/print');

			$read  = $api->read(false);

			if (isset($read[0]) && $read[0] == '!trap') {
				$noServer = true;
			}

			$array = $api->parseResponse($read);

			$end = microtime(true);

			$sql  = [];
			$sql2 = [];
			$dns  = [];

			if ($noServer === false && cacti_sizeof($array) > 0) {
				cacti_log('MIKROTIK RouterOS API STATS: Device[' . $host['id'] . '], API Returned ' . sizeof($array) . ' DNS Cache Entries in ' . round($end - $start,2) . ' seconds.', false, 'SYSTEM');
			}

			if (cacti_sizeof($array) && $noServer === false) {
				foreach ($array as $row) {
					if (isset($row['type']) && $row['type'] != '-1') {
						$dns['host_id'] = $host['id'];
						$dns['type']    = $row['type'] ?? '-1';
						$dns['data']    = $row['data'] ?? '-';
						$dns['name']    = $row['name'] ?? '';
						$dns['ttl']     = isset($row['ttl']) ? mikrotik_parse_ttl($row['ttl']) : '0';
						$dns['static']  = $row['static'] ?? 'false';

						$sql[] = '(' .
							$dns['host_id'] . ',' .
							db_qstr($dns['type']) . ',' .
							db_qstr($dns['data']) . ',' .
							db_qstr($dns['name']) . ',' .
							db_qstr($dns['ttl']) . ',' .
							db_qstr($dns['static']) . ', 1)';
					}
				}
			}

			if (cacti_sizeof($sql)) {
				db_execute_prepared('UPDATE plugin_mikrotik_dns
					SET present = 0
					WHERE host_id = ?',
					[$host['id']]);

				db_execute('INSERT INTO plugin_mikrotik_dns
					(`host_id`, `type`, `data`, `name`, `ttl`, `static`, `present`)
					VALUES ' . implode(', ', $sql) . '
					ON DUPLICATE KEY UPDATE
						ttl=VALUES(ttl),
						static=VALUES(static),
						present=1');

				db_execute_prepared('UPDATE plugin_mikrotik_dns
					SET ttl= 0
					WHERE present = 0
					AND host_id = ?',
					[$host['id']]);

				db_execute_prepared('DELETE FROM plugin_mikrotik_dns
					WHERE host_id = ?
					AND type = "-1"',
					[$host['id']]);
			}

			if ($noServer === true) {
				db_execute_prepared('DELETE FROM plugin_mikrotik_dns
					WHERE host_id = ?', [$host['id']]);
			} else {
				$retention = read_config_option('mikrotik_dns_retention');

				if ($retention > 0) {
					db_execute_prepared('DELETE FROM plugin_mikrotik_dns
						WHERE UNIX_TIMESTAMP(last_updated) < UNIX_TIMESTAMP() - ?
						AND host_id = ?',
						[$retention, $host['id']]);
				}
			}

			$api->disconnect();
		} else {
			cacti_log('ERROR: Device[' . $host['id'] . '] for RouterOS API Call Timed Out.  Check for an invalid API password!');
		}
	}
}

/**
 * Parses a RouterOS-formatted TTL/duration string (e.g. '1d02h03m04s')
 * into a total number of seconds. Called from collect_list_details()
 * and other RouterOS API collectors to normalize timeout/lease values.
 *
 * @param string $ttl The RouterOS duration string to parse.
 *
 * @return int The total duration in seconds.
 */
function mikrotik_parse_ttl(string $ttl): int {
	$time = 0;

	if (strpos($ttl, 'd') !== false) {
		$parts  = explode('d', $ttl);
		$time  += (int) $parts[0] * 86400;
		$ttl    = $parts[1];
	}

	if (strpos($ttl, 'h') !== false) {
		$parts  = explode('h', $ttl);
		$time  += (int) $parts[0] * 3600;
		$ttl    = $parts[1];
	}

	if (strpos($ttl, 'm') !== false) {
		$parts  = explode('m', $ttl);
		$time  += (int) $parts[0] * 60;
		$ttl    = $parts[1];
	}

	if (strpos($ttl, 's') !== false) {
		$parts  = explode('s', $ttl);
		$time  += (int) $parts[0];
		$ttl    = $parts[1];
	}

	return $time;
}

/**
 * Collects a device's DHCP lease details via the RouterOS API (not
 * SNMP), upserting them into plugin_mikrotik_dhcp and marking/purging
 * leases no longer present. Called from checkHost() when this
 * collector's interval is due and the RouterOS API is enabled with
 * valid credentials.
 *
 * @param array $host Reference, the Cacti host row to collect data for,
 *                    providing its stored RouterOS API credentials.
 *
 * @return void
 */
function collect_dhcp_details(array &$host): void {
	$rows = [];

	$api        = new RouterosAPI();
	$api->debug = false;

	$rekey_array = [
		'host_id', 'address', 'mac_address', 'client_id', 'address_lists',
		'server', 'dhcp_option', 'status', 'expires_after',
		'last_seen', 'active_address', 'active_mac_address', 'active_client_id',
		'active_server', 'hostname', 'radius', 'dynamic', 'blocked',
		'disabled', 'present', 'last_updated'
	];

	// Put the queues into an array
	$entries = array_rekey(
		db_fetch_assoc_prepared('SELECT *
			FROM plugin_mikrotik_dhcp
			WHERE host_id = ?',
			[$host['id']]),
		'mac_address', $rekey_array);

	$creds = db_fetch_row_prepared('SELECT *
		FROM plugin_mikrotik_credentials
		WHERE host_id = ?',
		[$host['id']]);

	$start = microtime(true);

	if (is_array($creds) && cacti_sizeof($creds) && read_config_option('mikrotik_api_enabled') == 'on') {
		if ($api->connect($host['hostname'], $creds['user'], $creds['password'])) {
			$noServer = false;

			$api->write('/ip/dhcp-server/lease/print');

			$read  = $api->read(false);

			if (isset($read[0]) && $read[0] == '!trap') {
				$noServer = true;
			}

			$array = $api->parseResponse($read);

			$end = microtime(true);

			$sql  = [];
			$sql2 = [];

			if ($noServer === false && cacti_sizeof($array) > 0) {
				cacti_log('MIKROTIK RouterOS API STATS: Device[' . $host['id'] . '], API Returned ' . sizeof($array) . ' DHCP Leases in ' . round($end - $start,2) . ' seconds.', false, 'SYSTEM');
			}

			if (cacti_sizeof($array) && $noServer === false) {
				foreach ($array as $row) {
					$mac_address = $row['mac-address'] ?? '-99';

					if (isset($entries[$mac_address]) && $mac_address != 99) {
						$dhcp = $entries[$mac_address];
					}

					if (isset($row['mac-address']) && isset($row['host-name'])) {
						if ($row['mac-address'] != '' && $row['host-name'] != '') {
							$sql2[] = '(' . db_qstr($row['mac-address']) . ', ' . db_qstr($row['host-name']) . ')';
						}
					}

					$dhcp['host_id']            = $host['id'];
					$dhcp['address']            = $row['address'] ?? 'N/A';
					$dhcp['mac_address']        = $row['mac-address'] ?? 'N/A';
					$dhcp['client_id']          = $row['client-id'] ?? '';
					$dhcp['address_lists']      = $row['address-lists'] ?? 'N/A';
					$dhcp['server']             = $row['server'] ?? 'N/A';
					$dhcp['dhcp_option']        = $row['dhcp-option'] ?? 'N/A';
					$dhcp['status']             = $row['status'] ?? 'N/A';
					$dhcp['expires_after']      = isset($row['expires-after']) ? uptimeToSeconds($row['expires-after']) : 0;
					$dhcp['last_seen']          = isset($row['last-seen']) ? uptimeToSeconds($row['last-seen']) : 0;
					$dhcp['active_address']     = isset($row['active_address']) ? $row['active-address'] : '';
					$dhcp['active_mac_address'] = $row['active-mac-address'] ?? '';
					$dhcp['active_client_id']   = $row['active-client-id'] ?? '';
					$dhcp['active_server']      = $row['active-server'] ?? '';
					$dhcp['hostname']           = $row['host-name'] ?? '';
					$dhcp['radius']             = isset($row['radius']) ? ($row['radius'] == 'true' ? 1 : 0) : 0;
					$dhcp['dynamic']            = isset($row['dynamic']) ? ($row['dynamic'] == 'true' ? 1 : 0) : 0;
					$dhcp['blocked']            = isset($row['blocked']) ? ($row['blocked'] == 'true' ? 1 : 0) : 0;
					$dhcp['disabled']           = isset($row['disabled']) ? ($row['disabled'] == 'true' ? 1 : 0) : 0;

					$sql[] = '(' .
						$dhcp['host_id'] . ',' .
						db_qstr($dhcp['address']) . ',' .
						db_qstr($dhcp['mac_address']) . ',' .
						db_qstr($dhcp['client_id']) . ',' .
						db_qstr($dhcp['address_lists']) . ',' .
						db_qstr($dhcp['server']) . ',' .
						db_qstr($dhcp['dhcp_option']) . ',' .
						db_qstr($dhcp['status']) . ',' .
						$dhcp['expires_after'] . ',' .
						$dhcp['last_seen'] . ',' .
						db_qstr($dhcp['active_address']) . ',' .
						db_qstr($dhcp['active_mac_address']) . ',' .
						db_qstr($dhcp['active_client_id']) . ',' .
						db_qstr($dhcp['active_server']) . ',' .
						db_qstr($dhcp['hostname']) . ',' .
						$dhcp['radius'] . ',' .
						$dhcp['dynamic'] . ',' .
						$dhcp['blocked'] . ',' .
						$dhcp['disabled'] . ',' .
						'1' . ',' .
						'NOW()' . ')';
				}
			}

			if (cacti_sizeof($sql)) {
				db_execute('INSERT INTO plugin_mikrotik_dhcp
					(`' . implode('`,`', $rekey_array) . '`)
					VALUES ' . implode(', ', $sql) . '
					ON DUPLICATE KEY UPDATE address=VALUES(address),
					mac_address=VALUES(mac_address), client_id=VALUES(client_id),
					address_lists=VALUES(address_lists), dhcp_option=VALUES(dhcp_option),
					status=VALUES(status), expires_after=VALUES(expires_after),
					last_seen=VALUES(last_seen), active_address=VALUES(active_address),
					active_mac_address=VALUES(active_mac_address), active_client_id=VALUES(active_client_id),
					hostname=VALUES(hostname), radius=VALUES(radius),
					dynamic=VALUES(dynamic), blocked=VALUES(blocked),
					disabled=VALUES(disabled), present=VALUES(present), last_updated=VALUES(last_updated)');
			}

			if (cacti_sizeof($sql2)) {
				db_execute('REPLACE INTO plugin_mikrotik_mac2hostname
					(mac_address, hostname)
					VALUES ' . implode(', ', $sql2));
			}

			if ($noServer === true) {
				db_execute_prepared('DELETE FROM plugin_mikrotik_dhcp WHERE host_id = ?', [$host['id']]);
			} else {
				$retention = read_config_option('mikrotik_dhcp_retention');

				if ($retention > 0) {
					db_execute_prepared('DELETE FROM plugin_mikrotik_dhcp
						WHERE UNIX_TIMESTAMP(last_updated) < UNIX_TIMESTAMP() - ?
						AND host_id = ?',
						[$retention, $host['id']]);
				}
			}

			$api->disconnect();
		} else {
			cacti_log('ERROR: Device[' . $host['id'] . '] for RouterOS API Call Timed Out.  Check for an invalid API password!');
		}
	}
}

/**
 * Collects PPPoE user session details via the RouterOS API (not SNMP),
 * upserting them into plugin_mikrotik_users and marking sessions no
 * longer present as absent. Called from checkHost() when this
 * collector's interval is due and the RouterOS API is enabled with
 * valid credentials.
 *
 * @param array $host Reference, the Cacti host row to collect data for,
 *                    providing its stored RouterOS API credentials.
 *
 * @return void
 */
function collect_pppoe_users_api(array &$host): void {
	$rows = [];

	$api        = new RouterosAPI();
	$api->debug = false;

	$rekey_array = [
		'host_id', 'name', 'index', 'userType', 'serverID', 'domain',
		'bytesIn', 'bytesOut', 'packetsIn', 'packetsOut',
		'curBytesIn', 'curBytesOut', 'curPacketsIn', 'curPacketsOut',
		'prevBytesIn', 'prevBytesOut', 'prevPacketsIn', 'prevPacketsOut',
		'present', 'last_seen'
	];

	// Put the queues into an array
	$users = array_rekey(db_fetch_assoc_prepared("SELECT
		host_id, '0' AS `index`, '1' AS userType, '0' AS serverID, SUBSTRING(name, 7) AS name, '' AS domain,
		BytesIn AS bytesIn, BytesOut AS bytesOut, PacketsIn as packetsIn, PacketsOut AS packetsOut,
		curBytesIn, curBytesOut, curPacketsIn, curPacketsOut,
		prevBytesIn, prevBytesOut, prevPacketsIn, prevPacketsOut, present, last_seen
		FROM plugin_mikrotik_queues
		WHERE host_id = ?
		AND name LIKE 'PPPOE-%'", [$host['id']]),
		'name', $rekey_array);

	$creds = db_fetch_row_prepared('SELECT *
		FROM plugin_mikrotik_credentials
		WHERE host_id = ?',
		[$host['id']]);

	$start = microtime(true);

	if (is_array($creds) && cacti_sizeof($creds) && read_config_option('mikrotik_api_enabled') == 'on') {
		if ($api->connect($host['hostname'], $creds['user'], $creds['password'])) {
			$api->write('/ppp/active/getall');

			$read  = $api->read(false);
			$array = $api->parseResponse($read);

			$end = microtime(true);

			$sql   = [];

			cacti_log('MIKROTIK RouterOS API STATS: Device[' . $host['id'] . '], API Returned ' . sizeof($array) . ' PPPoe Users in ' . round($end - $start,2) . ' seconds.', false, 'SYSTEM');

			if (cacti_sizeof($array)) {
				foreach ($array as $row) {
					if (!isset($row['name'])) {
						continue;
					}
					$name = $row['name'];

					if (isset($users[$name])) {
						$user = $users[$name];

						$user['mac']           = $row['caller-id'];
						$user['ip']            = $row['address'];
						$user['connectTime']   = uptimeToSeconds($row['uptime']);
						$user['host_id']       = $host['id'];
						$user['radius']        = ($row['radius'] == 'true' ? 1 : 0);
						$user['limitBytesIn']  = $row['limit-bytes-in'];
						$user['limitBytesOut'] = $row['limit-bytes-out'];
						$user['userType']      = 1;

						$sql[] = '(' .
							$user['host_id'] . ',' .
							$user['index'] . ',' .
							$user['userType'] . ',' .
							$user['serverID'] . ',' .
							db_qstr($user['name']) . ',' .
							db_qstr($user['domain']) . ',' .
							db_qstr($user['mac']) . ',' .
							db_qstr($user['ip']) . ',' .
							$user['connectTime'] . ',' .
							$user['bytesIn'] . ',' .
							$user['bytesOut'] . ',' .
							$user['packetsIn'] . ',' .
							$user['packetsOut'] . ',' .
							$user['curBytesIn'] . ',' .
							$user['curBytesOut'] . ',' .
							$user['curPacketsIn'] . ',' .
							$user['curPacketsOut'] . ',' .
							$user['prevBytesIn'] . ',' .
							$user['prevBytesOut'] . ',' .
							$user['prevPacketsIn'] . ',' .
							$user['prevPacketsOut'] . ',' .
							$user['limitBytesIn'] . ',' .
							$user['limitBytesOut'] . ',' .
							$user['radius'] . ',' .
							$user['present'] . ',' .
							db_qstr($user['last_seen']) . ')';
					}
				}

				if (cacti_sizeof($sql)) {
					db_execute('INSERT INTO plugin_mikrotik_users
						(host_id, `index`, userType, serverID, name, domain, mac, ip, connectTime,
						bytesIn, bytesOut, packetsIn, packetsOut,
						curBytesIn, curBytesOut, curPacketsIn, curPacketsOut,
						prevBytesIn, prevBytesOut, prevPacketsIn, prevPacketsOut,
						limitBytesIn, limitBytesOut, radius, present, last_seen)
						VALUES ' . implode(', ', $sql) . '
						ON DUPLICATE KEY UPDATE connectTime=VALUES(connectTime),
						bytesIn=VALUES(bytesIn), bytesOut=VALUES(bytesOut),
						packetsIn=VALUES(packetsIn), packetsOut=VALUES(packetsOut),
						curBytesIn=VALUES(curBytesIn), curBytesOut=VALUES(curBytesOut),
						curPacketsIn=VALUES(curPacketsIn), curPacketsOut=VALUES(curPacketsOut),
						prevBytesIn=VALUES(prevBytesIn), prevBytesOut=VALUES(prevBytesOut),
						prevPacketsIn=VALUES(prevPacketsIn), prevPacketsOut=VALUES(prevPacketsOut),
						limitBytesIn=VALUES(limitBytesIn), limitBytesOut=VALUES(limitBytesOut),
						radius=VALUES(radius), present=VALUES(present), last_seen=VALUES(last_seen)');
				}
			}

			$idle_users = db_fetch_assoc_prepared('SELECT name
				FROM plugin_mikrotik_users
				WHERE last_seen < FROM_UNIXTIME(UNIX_TIMESTAMP() - ?)
				AND present=1
				AND host_id = ?',
				[read_config_option('mikrotik_queues_freq'), $host['id']]);

			db_execute_prepared('UPDATE IGNORE plugin_mikrotik_users SET
				bytesIn=0, bytesOut=0, packetsIn=0, packetsOut=0, connectTime=0,
				curBytesIn=0, curBytesOut=0, curPacketsIn=0, curPacketsOut=0,
				prevBytesIn=0, prevBytesOut=0, prevPacketsIn=0, prevPacketsOut=0, present=0
				WHERE host_id = ?
				AND userType = 1
				AND last_seen < FROM_UNIXTIME(UNIX_TIMESTAMP() - ?)',
				[$host['id'], read_config_option('mikrotik_queues_freq')]);

			$api->disconnect();
		} else {
			cacti_log('ERROR: Device[' . $host['id'] . '] for RouterOS API Call Timed Out.  Check for an invalid API password!');
		}
	}
}

/**
 * Parses a RouterOS-formatted uptime string (e.g. '1w2d3h4m5s' or
 * 'never') into a total number of seconds by successively splitting
 * off the w/d/h/m/s suffix-delimited components; only this
 * suffix-based format is recognized (a colon-formatted time portion,
 * e.g. '03:04:05', is not parsed). Called from RouterOS API
 * collectors (e.g. collect_pppoe_users_api()) to normalize session/
 * device uptime values.
 *
 * @param string $value The RouterOS uptime string to parse.
 *
 * @return int The total uptime in seconds (0 for 'never').
 */
function uptimeToSeconds(string $value): int {
	$uptime = 0;

	// handle 'never'
	if ($value == 'never') {
		return 0;
	}

	// remove weeks first
	$parts = explode('w', $value);

	if (cacti_sizeof($parts) == 2) {
		$uptime += (int) $parts[0] * 86400 * 7;
		$value   = $parts[1];
	} else {
		$value   = $parts[0];
	}

	// remove days
	$parts = explode('d', $value);

	if (cacti_sizeof($parts) == 2) {
		$uptime += (int) $parts[0] * 86400;
		$value   = $parts[1];
	} else {
		$value   = $parts[0];
	}

	// remove hours
	$parts = explode('h', $value);

	if (cacti_sizeof($parts) == 2) {
		$uptime += (int) $parts[0] * 3600;
		$value   = $parts[1];
	} else {
		$value   = $parts[0];
	}

	// remove minutes
	$parts = explode('m', $value);

	if (cacti_sizeof($parts) == 2) {
		$uptime += (int) $parts[0] * 60;
		$value   = $parts[1];
	} else {
		$value   = $parts[0];
	}

	// remove seconds
	$parts = explode('s', $value);

	if (cacti_sizeof($parts) == 2) {
		$uptime += (int) $parts[0];
	}

	return $uptime;
}

/**
 * Collects a device's simple queues table via collectHostIndexedOid().
 * Called from checkHost() when this collector's interval is due.
 *
 * @param array $host Reference, the Cacti host row to collect data for.
 *
 * @return void
 *
 * @global array $mikrotikQueueSimpleEntry The simple-queue SNMP tree
 *                                        map (column => OID).
 */
function collect_queues(array &$host): void {
	global $mikrotikQueueSimpleEntry;
	collectHostIndexedOid($host, $mikrotikQueueSimpleEntry, 'plugin_mikrotik_queues', 'queues', true);
}

/**
 * Collects a device's interfaces table via collectHostIndexedOid().
 * Called from checkHost() when this collector's interval is due.
 *
 * @param array $host Reference, the Cacti host row to collect data for.
 *
 * @return void
 *
 * @global array $mikrotikInterfaces The interfaces SNMP tree map
 *                                  (column => OID).
 */
function collect_interfaces(array &$host): void {
	global $mikrotikInterfaces;
	collectHostIndexedOid($host, $mikrotikInterfaces, 'plugin_mikrotik_interfaces', 'interfaces', true);
}

/**
 * Collects a device's processor table via collectHostIndexedOid().
 * Called from checkHost() when this collector's interval is due.
 *
 * @param array $host Reference, the Cacti host row to collect data for.
 *
 * @return void
 *
 * @global array $mikrotikProcessor The processor SNMP tree map (column
 *                                 => OID).
 */
function collect_processor(array &$host): void {
	global $mikrotikProcessor;
	collectHostIndexedOid($host, $mikrotikProcessor, 'plugin_mikrotik_processor', 'processor');
}

/**
 * Collects a device's storage table via collectHostIndexedOid(). Called
 * from checkHost() when this collector's interval is due.
 *
 * @param array $host Reference, the Cacti host row to collect data for.
 *
 * @return void
 *
 * @global array $mikrotikStorage The storage SNMP tree map (column =>
 *                                OID).
 */
function collect_storage(array &$host): void {
	global $mikrotikStorage;
	collectHostIndexedOid($host, $mikrotikStorage, 'plugin_mikrotik_storage', 'storage');
}

/**
 * Collects a device's wireless access-point table via
 * collectHostIndexedOid(). Called from checkHost() when this
 * collector's interval is due.
 *
 * @param array $host Reference, the Cacti host row to collect data for.
 *
 * @return void
 *
 * @global array $mikrotikWirelessAps The wireless AP SNMP tree map
 *                                   (column => OID).
 */
function collect_wireless_aps(array &$host): void {
	global $mikrotikWirelessAps;
	collectHostIndexedOid($host, $mikrotikWirelessAps, 'plugin_mikrotik_wireless_aps', 'wireless_aps', false);
}

/**
 * Collects a device's wireless client registrations table (using a
 * 7-component compound index) via collectHostIndexedOid(). Called from
 * checkHost() when this collector's interval is due.
 *
 * @param array $host Reference, the Cacti host row to collect data for.
 *
 * @return void
 *
 * @global array $mikrotikWirelessRegistrations The wireless
 *                                              registration SNMP tree
 *                                              map (column => OID).
 */
function collect_wireless_reg(array &$host): void {
	global $mikrotikWirelessRegistrations;
	collectHostIndexedOid($host, $mikrotikWirelessRegistrations, 'plugin_mikrotik_wireless_registrations', 'wireless_registrations', true, 7);
}

/**
 * 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'.
 *
 * @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_mikrotik_version')) {
		include_once($config['base_path'] . '/plugins/mikrotik/setup.php');
	}

	$info = plugin_mikrotik_version();
	print 'MikroTik Poller Process, Version ' . $info['version'] . ', ' . COPYRIGHT_YEARS . "\n";
}

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

	print "\nThe main MikroTik poller process script for Cacti.\n\n";
	print "usage: \n";
	print "master process: poller_mikrotik.php [-M] [-f] [-fd] [-d]\n";
	print "child  process: poller_mikrotik.php --host-id=N [--seed=N] [-f] [-d]\n\n";
}