Repository navigation
Split library files into includes/, add the file manifest + upgrade prune, set compat to 1.2.29 - #32
Merged
Merged
Conversation
TheWitness
requested review from
bmfmancini,
browniebraun,
cigamit and
xmacan
and
a balanced review from Copilot
September 30, 2026 02:51
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The new minimum version conflicts with the repository’s documented Cacti 1.2.17+ compatibility baseline.
Review effort: Balanced
Findings: 1
What changed in this PR
Updates QuickTree’s declared minimum Cacti version from 1.2.17 to 1.2.32.
Changes:
- Raises the
compatmetadata value to Cacti 1.2.32.
| File | Description |
|---|---|
INFO |
Updates the minimum compatible Cacti version. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
added 5 commits
September 30, 2026 10:53
phpunit.xml ships in the repo for CI but is a dev-only test artifact, so it is removed from manifest.json 'expected', pruned from installs on upgrade (like tests/), and excluded from the manifest drift check. The retired markdown-lint configs (.mdlrc, .md_style.rb) are deleted, and .md* is now ignored like .git*: protected from pruning and excluded from drift if it reappears.
The QuickTree UI form-wrapper library moves into a new includes/ directory as helpers.php; quicktree.php and the unit test load it from there. The old path is tombstoned so existing installs drop the stale top-level copy on upgrade.
The request-sanitizing library moves into includes/ as security.php; quicktree.php and the unit/integration tests load it from there. The old path is tombstoned so existing installs drop the stale top-level copy on upgrade.
added 4 commits
September 30, 2026 22:18
The upgrade-time prune now rejects any tombstone containing '.'/'..' segments (which could escape the plugin directory or resolve to its root) and treats ancestors of whitelist entries as protected, so a tombstone on a parent directory can no longer delete a whitelisted file beneath it.
The trailing '# ...' comments in the Project Structure block drifted further right down the tree; align them all to a single column.
- Use the full license header (from the plugin's own setup.php) in tests/Unit/PruneFilesTest.php instead of the abbreviated copyright banner. - Document that the manifest drift check and the upgrade-time prune also handle phpunit.xml and .md* files, matching the implemented behavior.
The repository naming contract reserves the plugin_<name>_ prefix for plugin lifecycle / hook-registration functions; all other functions use the plain <name>_ prefix. Rename the internal upgrade helpers accordingly: plugin_<name>_prune_files() -> <name>_prune_files() plugin_<name>_rmtree() -> <name>_rmtree() The call site, unit tests, and the copilot-instructions.md references are updated to match. No behavioral change.
TheWitness
changed the title
cigamit
approved these changes
Oct 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Split library files into
includes/, add the file manifest + upgrade-time prune, set compat to 1.2.29Two fleet-wide consistency changes for
plugin_quicktree.File relocations (repointed at the entry points)
quicktree_security.php→includes/security.phpui_helpers.php→includes/helpers.phpFile manifest + upgrade-time pruning
manifest.json:tombstones(quicktree_security.php,ui_helpers.php),expected(the current top-level tree, directories with a trailing/), andwhitelist(empty — no user-writable runtime tree).quicktree_prune_files()(insetup.php, called from the version-change branch ofquicktree_check_upgrade()) removes the tombstoned paths, the dev-onlytests/tree, andphpunit.xml; leaveswhitelist,.git*, and.md*files alone; and logs — without removing — any unaccounted top-level entry../..traversal segment or resolves outside the plugin directory (including via a symlinked directory), and protects a directory when a whitelisted entry lives beneath it. Warns in the Cacti log on anything it cannot remove.tests/bin/validate-manifest.php(wired intoplugin-ci-workflow.yml) fails on drift betweenexpectedand the real top-level tree (it ignorestests/,phpunit.xml,.git*,.md*, and whitelisted paths).Compatibility
INFOcompatfloor set to 1.2.29.Docs & tests
tests/Unit/PruneFilesTest.php(tombstone/tests//phpunit.xmlremoval, whitelist &.gitprotection, traversal-segment and symlink-escape refusal, whitelist-ancestor protection), using the full standard GPL v2 header.QuicktreeCheckUpgradeTestand theconfig_arrayscases sandboxbase_path(a temp tree with a copy ofINFOand no manifest) so the prune is a no-op there while the new call line stays covered..github/copilot-instructions.mdto the new layout.Validation
php -lclean on all changed PHP files; full Pest suite green; patch-coverage passes at 100% of changed measured lines; manifest drift-check passes and the translation template is up to date.