cacti/tests/Unit/Plugin/PluginRealmFilenameTest.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                     |
 +-------------------------------------------------------------------------+
*/

require_once dirname(__DIR__, 2) . '/Helpers/CactiStubs.php';
require_once dirname(__DIR__, 3) . '/include/global.php';
require_once dirname(__DIR__, 2) . '/Helpers/FakeMySQLPDO.php';

// MySQL reports SELECT row counts; SQLite requires buffering to provide the
// same contract to Cacti's production db_fetch_assoc_return() helper.
class PluginRealmFilenameStatement extends PDOStatement {
	private ?array $rows = null;

	protected function __construct() {
	}

	public function execute(?array $params = null): bool {
		$result     = parent::execute($params);
		$this->rows = $this->columnCount() > 0 ? parent::fetchAll(PDO::FETCH_ASSOC) : null;

		return $result;
	}

	public function rowCount(): int {
		return $this->rows === null ? parent::rowCount() : count($this->rows);
	}

	public function fetchAll(int $mode = PDO::FETCH_DEFAULT, mixed ...$args): array {
		return $this->rows ?? parent::fetchAll($mode, ...$args);
	}
}

function plugin_realm_filename_setup(string $plugin, string $file): bool {
	return api_plugin_register_realm($plugin, $file, 'Filename fixture', false);
}

test('plugin realm registration retains quoted filenames and existing realm IDs (#7968)', function ($file, $unrelated = null) {
	$keys  = ['database_hostname', 'database_port', 'database_default', 'database_sessions', 'database_total_queries', 'config', 'database_log', 'database_last_error', 'affected_rows', 'error_logged'];
	$saved = [];

	foreach ($keys as $key) {
		$saved[$key] = [array_key_exists($key, $GLOBALS), $GLOBALS[$key] ?? null];
	}

	try {
		$db = new FakeMySQLPDO();
		$db->setAttribute(PDO::ATTR_STATEMENT_CLASS, [PluginRealmFilenameStatement::class, []]);
		$db->exec('CREATE TABLE settings (name TEXT PRIMARY KEY, value TEXT)');
		$db->exec('CREATE TABLE plugin_realms (id INTEGER PRIMARY KEY, plugin TEXT, file TEXT, display TEXT)');
		$db->exec('CREATE TABLE poller (id INTEGER, last_status TEXT, disabled TEXT)');

		if ($unrelated !== null) {
			$db->prepare('INSERT INTO plugin_realms VALUES (6, ?, ?, ?)')->execute(['realm_fixture', $unrelated, 'Unrelated']);
		}
		$db->prepare('INSERT INTO plugin_realms VALUES (7, ?, ?, ?)')->execute(['realm_fixture', $file, 'Old caption']);
		$GLOBALS['database_hostname']      = 'realm-filename-test';
		$GLOBALS['database_port']          = 0;
		$GLOBALS['database_default']       = 'realm-filename-test';
		$GLOBALS['database_sessions']      = ['realm-filename-test:0:realm-filename-test' => $db];
		$GLOBALS['database_total_queries'] = 0;
		expect(plugin_realm_filename_setup('realm_fixture', $file))->toBeTrue();
		$realms = $db->query('SELECT id, file, display FROM plugin_realms')->fetchAll(PDO::FETCH_ASSOC);
		expect($realms)->toHaveCount($unrelated === null ? 1 : 2);
		$target = $db->query('SELECT id, file, display FROM plugin_realms WHERE id = 7')->fetchAll(PDO::FETCH_ASSOC)[0];
		expect((int) $target['id'])->toBe(7);
		expect($target['file'])->toBe($file);
		expect($target['display'])->toBe('Filename fixture');

		if ($unrelated !== null) {
			$other = $db->query('SELECT file, display FROM plugin_realms WHERE id = 6')->fetchAll(PDO::FETCH_ASSOC)[0];
			expect($other['file'])->toBe($unrelated);
			expect($other['display'])->toBe('Unrelated');
		}
	} finally {
		foreach ($saved as $key => [$exists, $value]) {
			if ($exists) {
				$GLOBALS[$key] = $value;
			} else {
				unset($GLOBALS[$key]);
			}
		}
	}
})->with([
	'index.php',
	'quote"file.php',
	"quote'file.php",
	'quote"file.php,other.php',
	['foo_bar.php', 'other.php,fooXbar.php'],
	['foo%bar.php', 'other.php,fooZZbar.php'],
	['bang!file.php,third.php', 'other.php,bangfile.php'],
]);