Repository navigation
INFO: back off compat to 1.2.29 - #21
Merged
Merged
Conversation
TheWitness
requested review from
bmfmancini,
browniebraun,
cigamit and
xmacan
and
a balanced review from Copilot
September 30, 2026 14:52
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Repository compatibility guidance and the changelog must be updated to match the new minimum version.
Review effort: Balanced
Findings: 1
Open (2)
What changed in this PR
Lowers the plugin’s minimum supported Cacti version from 1.2.32 to 1.2.29.
Changes:
- Updates the
INFOcompatibility floor.
| File | Description |
|---|---|
INFO |
Sets minimum Cacti compatibility to 1.2.29. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
added 7 commits
September 30, 2026 16:01
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 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.
Align the compat metadata (and the contributor-guide references) with the team decision to standardize the minimum supported Cacti version at 1.2.29; the previously proposed 1.2.32 floor was not adopted.
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.
Summary
Two fleet-wide consistency changes for this plugin:
manifest.json+ prune mechanism, and consolidates the single-filethemes/directory into the conventionalcss/directory.Unique-key assessment
This plugin is not affected by the Cacti 1.2.29–1.2.31
db_update_table()unique-key drop: it does not calldb_update_table(), so no re-introduction helper is required.themes/→css/themes/common.cssis relocated tocss/common.css(git mv, history preserved) to match the fleet convention, andplugin_tags_page_head()'s stylesheet reference is repointed. The retiredthemes/directory is recorded as a manifest tombstone so it is removed from an upgrading install.File manifest + upgrade pruning
manifest.jsonwithtombstones=["themes/"],expected(the current top-level tree; directories carry a trailing/), andwhitelist(empty — no user-writable runtime tree).tags_prune_files()(appended tosetup.php, called from the version-change branch ofplugin_tags_upgrade()ininclude/database.php, gated onif ($new != $old)) removes the tombstonedthemes/tree plus the dev-onlytests/tree on upgrade, refuses any path resolving outside the plugin directory (a tamperedmanifest.json), warns in the Cacti log on any file/directory it cannot remove, leaveswhitelist/.git*alone, and logs — without removing — any unaccounted top-level entry.tests/bin/validate-manifest.php(wired intoplugin-ci-workflow.yml) fails on drift betweenexpectedand the real top-level tree.tests/Unit/PruneFilesTest.php.include/database.phpis added to the coverage source set (its new gated prune call is exercised by the drift-path tests).TagsCheckConfigTestand the relevantTagsConfigAndNavigationTestcase sandboxbase_path(a temp tree with a copy ofINFO, emptyinclude/stubs, and no manifest) so the prune is a no-op there while the new call line stays covered.Validation
php -lclean on all changed PHP files; full Pest suite green (46 passed) and patch-coverage passes at 100% (68/68 changed measured lines); manifest drift-check passes and the translation template is up to date.Revision: hardening & fleet cleanup
Since the initial description, this PR also:
phpunit.xmlon upgrade (alongside the dev-onlytests/tree) and leaves.md*lint configs in place — the drift check now ignorestests/,phpunit.xml,.git*,.md*, and whitelisted paths../..traversal segment or resolves outside the plugin directory (including via a symlinked directory), and protects a directory when a whitelisted entry lives beneath it — each with added unit coverage.tags_prune_files()/tags_rmtree()(theplugin_tags_prefix is reserved for lifecycle/hook-registration functions).tests/Unit/PruneFilesTest.phpthe full standard GPL v2 header and aligns the Project Structure block in.github/copilot-instructions.md.