Split library files into includes/, add the file manifest + upgrade prune, set compat to 1.2.29

.github/copilot-instructions.md

@@ -24,15 +24,15 @@ When generating code for this repository:
 ## Project Structure
 
 ```
-quicktree/               # Repository root (install to plugins/quicktree/ in Cacti)
-├── images/                # UI icons
-├── locales/                 # Internationalization files
-├── quicktree.css              # Client-side styling
-├── quicktree.js                 # Client-side add/remove graph interactions
-├── quicktree.php                  # Main playlist view / management page
-├── INFO                              # Plugin metadata (name, version, compat)
+quicktree/        # Repository root (install to plugins/quicktree/ in Cacti)
+├── images/       # UI icons
+├── locales/      # Internationalization files
+├── quicktree.css # Client-side styling
+├── quicktree.js  # Client-side add/remove graph interactions
+├── quicktree.php # Main playlist view / management page
+├── INFO          # Plugin metadata (name, version, compat)
 ├── README.md
-└── setup.php                          # Plugin install/uninstall/upgrade hooks
+└── setup.php     # Plugin install/uninstall/upgrade hooks
 ```
 
 ## Naming Conventions
@@ -173,3 +173,7 @@ existing code or adding new code, not just in dedicated cleanup passes:
   line, `@param` lines, a blank comment line, then `@return`. Infer parameter/return types from
   actual usage; don't change the function's real type-hints in the same pass (let static analysis
   flag mismatches separately). Skip vendored third-party library files.
+
+## File manifest & upgrade pruning
+
+The plugin ships a root `manifest.json` with three arrays: `tombstones` (files/directories older versions shipped that have since moved or been removed), `expected` (the top-level files and directories that ship today, directories written with a trailing `/`), and `whitelist` (paths holding user data that must never be touched). Keep `expected` current: CI runs `tests/bin/validate-manifest.php`, which fails on any drift between `expected` and the real top-level tree (it ignores `tests/`, `phpunit.xml`, `.git*`, `.md*`, and whitelisted paths). Custom customer CSS/theme files belong in `expected`, and stylesheets live in `css/` (not `themes/`). On upgrade, `quicktree_prune_files()` deletes the tombstoned paths, the dev-only `tests/` tree, and the `phpunit.xml` test config, leaves `whitelist`, `.git*`, and `.md*` alone, and logs (without removing) any top-level entry the manifest does not account for. As a safety measure it refuses any tombstone that resolves outside the plugin directory (a tampered manifest.json) and logs a warning for any file or directory it cannot remove. When you move or delete a shipped file, add its old path to `tombstones` and update `expected` in the same change.

.github/workflows/plugin-ci-workflow.yml

@@ -88,6 +88,9 @@ jobs:
     - name: Check PHP version
       run: php -v
 
+    - name: Validate plugin manifest (expected-file drift)
+      run: php cacti/plugins/quicktree/tests/bin/validate-manifest.php
+
     - name: Run apt-get update
       run: sudo apt-get update
 

INFO

@@ -20,7 +20,7 @@
 ; +-------------------------------------------------------------------------+
 
 [info]
-compat = 1.2.17
+compat = 1.2.29
 author=The Cacti Group, Howard Jones
 homepage=https://github.com/howardjones/cacti-quicktree
 longname=QuickTree for Cacti

manifest.json

@@ -0,0 +1,22 @@
+{
+    "tombstones": [
+        "quicktree_security.php",
+        "ui_helpers.php"
+    ],
+    "expected": [
+        "CHANGELOG.md",
+        "INFO",
+        "LICENSE",
+        "README.md",
+        "css/",
+        "images/",
+        "includes/",
+        "index.php",
+        "js/",
+        "locales/",
+        "manifest.json",
+        "quicktree.php",
+        "setup.php"
+    ],
+    "whitelist": []
+}

phpunit.xml

@@ -25,10 +25,9 @@
     -->
     <source>
         <include>
-            <file>quicktree.php</file>
             <file>setup.php</file>
-            <file>quicktree_security.php</file>
-            <file>ui_helpers.php</file>
+            <file>includes/security.php</file>
+            <file>includes/helpers.php</file>
         </include>
     </source>
 </phpunit>

quicktree.php

@@ -27,8 +27,8 @@
 
 chdir('../../');
 include_once('include/auth.php');
-include_once('plugins/quicktree/ui_helpers.php');
-include_once('plugins/quicktree/quicktree_security.php');
+include_once('plugins/quicktree/includes/helpers.php');
+include_once('plugins/quicktree/includes/security.php');
 
 /** @var array<string,mixed> $config */
 define('QUICKTREE_BASE_URI', $config['url_path'] . 'plugins/quicktree/');

setup.php

@@ -439,5 +439,177 @@ function quicktree_check_upgrade(): void {
 				]
 			);
 		}
+
+		quicktree_prune_files();
+	}
+}
+
+/**
+ * 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 quicktree_prune_files(): void {
+	global $config;
+
+	$plugin_dir    = $config['base_path'] . '/plugins/quicktree';
+	$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: quicktree manifest.json could not be parsed; skipping file prune', false, 'QUICKTREE');
+
+		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: quicktree prune refused to remove %s: path contains a traversal segment (tampered manifest.json?)', $rel), false, 'QUICKTREE');
+
+			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: quicktree prune refused to remove %s: path resolves outside the plugin directory (tampered manifest.json?)', $rel), false, 'QUICKTREE');
+
+			continue;
+		}
+
+		if (is_dir($path) && !is_link($path)) {
+			$removed = quicktree_rmtree($path);
+		} else {
+			$removed = @unlink($path);
+		}
+
+		if (!$removed) {
+			cacti_log(sprintf('WARNING: quicktree upgrade could not remove %s (check file/directory permissions)', $rel), false, 'QUICKTREE');
+		}
+	}
+
+	// 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: quicktree upgrade found a file/directory not described in manifest.json: %s (left in place)', $entry), false, 'QUICKTREE');
+	}
+}
+
+/**
+ * Recursively deletes a directory and its contents. Symlinks are removed
+ * without being followed. Helper for quicktree_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 quicktree_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 (!quicktree_rmtree($path)) {
+				$ok = false;
+			}
+		} elseif (!@unlink($path)) {
+			$ok = false;
+		}
+	}
+
+	if (!@rmdir($dir)) {
+		$ok = false;
 	}
+
+	return $ok;
 }

tests/Integration/QuicktreeRedirectSafetyTest.php

@@ -15,7 +15,7 @@
 		$contents = file_get_contents($path);
 		expect($contents)->not->toBeFalse();
 
-		expect($contents)->toContain("include_once('plugins/quicktree/quicktree_security.php');");
+		expect($contents)->toContain("include_once('plugins/quicktree/includes/security.php');");
 		expect($contents)->toContain("\$location = quicktree_normalize_location(get_nfilter_request_var('location'));");
 		expect($contents)->toContain("header('Location: quicktree.php?location=' . \$location);");
 		expect($contents)->toContain("form_start('quicktree.php?location=' . \$location, 'quicktree_form');");

tests/Unit/FormWrapperTest.php

@@ -14,7 +14,7 @@
  * $GLOBALS['__test_request_vars'], which lets this file drive both branches
  * of quicktree_action_form_begin().
  */
-require_once __DIR__ . '/../../ui_helpers.php';
+require_once __DIR__ . '/../../includes/helpers.php';
 
 describe('shared quicktree action-form wrappers', function () {
 	it('begin/end wrapper includes top header when header var is not set', function () {
@@ -51,7 +51,7 @@
 	it('quicktree.php includes ui helper file', function () {
 		$source = file_get_contents(realpath(__DIR__ . '/../../quicktree.php'));
 
-		expect(preg_match('/(?:include_once|require_once)\s*\(\s*[\'"]plugins\/quicktree\/ui_helpers\.php[\'"]\s*\)\s*;/', $source))->toBe(1);
+		expect(preg_match('/(?:include_once|require_once)\s*\(\s*[\'"]plugins\/quicktree\/includes\/helpers\.php[\'"]\s*\)\s*;/', $source))->toBe(1);
 	});
 
 	it('quicktree.php uses begin wrapper in add-tree and add-branch', function () {

tests/Unit/LocationNormalizationTest.php

@@ -7,7 +7,7 @@
  +-------------------------------------------------------------------------+
 */
 
-require_once __DIR__ . '/../../quicktree_security.php';
+require_once __DIR__ . '/../../includes/security.php';
 
 describe('quicktree location normalization', function () {
 	it('allows only the supported quicktree locations', function () {