mirror of
https://github.com/Cacti/plugin_thold.git
synced 2026-11-01 09:36:57 +09:00
* INFO: set compat to 1.2.32 * docs: update Copilot instructions Cacti baseline to 1.2.32 (matches INFO compat) * INFO: back off compat to 1.2.29 * Add manifest.json + upgrade-time file pruning * Prune phpunit.xml on upgrade and ignore markdown-lint configs 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. * Move thold_functions.php and thold_webapi.php into includes/; flatten css The main threshold library becomes includes/functions.php and the web API helper becomes includes/webapi.php; every caller (setup.php, includes/*, the CLI/poller/notify entry points and the test suite) loads them from includes/. Each per-theme stylesheet css/<theme>/main.css becomes css/<theme>.css so users can drop their own css/<theme>.css into the css base, and the page_head hook looks there. Old paths are tombstoned so existing installs drop the stale copies on upgrade. * Regenerate cacti.pot for the includes/ file relocations Moving the plugin's library files into includes/ changed the source-reference lines in the translation template; regenerate it so the 'Verify translation template' CI check passes. * Harden the hook-include test and make RPN integer ops explicit The HookFunctionsIncludeTest invokes real hooks with placeholder input purely to execute their relocated include_once lines; it now swallows engine notices/warnings/deprecations during those calls (and restores the error handler and config afterward) so it cannot trip the suite's failOnDeprecation or leak state into other tests. The RPN % and ^ operators now cast their operands to int explicitly, matching their long-standing integer-truncation behaviour while silencing the implicit float-to-int conversion deprecation. * Harden prune against tampered-manifest path traversal 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. * docs: update and align the Project Structure block Point the structure tree at the relocated files (libraries now under includes/, data files under docs/, stylesheets under css/) and align the trailing '# ...' comments to a single column so they no longer drift right. * docs/tests: standardize test header and correct manifest-contract notes - 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. * refactor: rename prune helpers to the plugin-slug function prefix 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. * chore: set the Cacti compatibility floor to 1.2.29 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. --------- Co-authored-by: Copilot <copilot@users.noreply.github.com>
106 lines
4.3 KiB
PHP
106 lines
4.3 KiB
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/ |
|
|
+-------------------------------------------------------------------------+
|
|
*/
|
|
|
|
/*
|
|
* Unit coverage for plugin_thold_csp_nonce().
|
|
*
|
|
* The helper is defined in includes/functions.php (the library every plugin page
|
|
* includes), so these tests load that file directly - without setup.php - to
|
|
* guard against the helper regressing back into a file the pages do not load.
|
|
*
|
|
* The helper has two branches that hinge on whether Cacti's global
|
|
* CactiSecureHeaders class is present. A single PHP process can only ever
|
|
* see the class as present or absent, never both, so the class-present
|
|
* branch is exercised in an isolated child process that defines a
|
|
* controlled double, rather than by mutating global state in this process
|
|
* or asserting on the source text.
|
|
*/
|
|
|
|
beforeAll(function () {
|
|
require_once __DIR__ . '/../../includes/functions.php';
|
|
});
|
|
|
|
test('csp nonce returns an empty string when CactiSecureHeaders is unavailable', function () {
|
|
if (class_exists('CactiSecureHeaders')) {
|
|
$this->markTestSkipped('CactiSecureHeaders is present in this runtime; the delegation path is covered by the isolated-process test.');
|
|
}
|
|
|
|
expect(plugin_thold_csp_nonce())->toBe('');
|
|
});
|
|
|
|
test('csp nonce helper is declared to return a string', function () {
|
|
$ref = new ReflectionFunction('plugin_thold_csp_nonce');
|
|
|
|
expect((string) $ref->getReturnType())->toBe('string');
|
|
});
|
|
|
|
test('csp nonce delegates to CactiSecureHeaders when the class is available', function () {
|
|
$wrapper = realpath(__DIR__ . '/../../includes/functions.php');
|
|
expect($wrapper)->not->toBeFalse();
|
|
|
|
// includes/functions.php loads without a running Cacti, but hand the child the
|
|
// unit bootstrap too so any Cacti stubs it might reference exist at load time.
|
|
$bootstrap = realpath(__DIR__ . '/../bootstrap-unit.php');
|
|
|
|
// Run in a clean child process so the double never leaks into the rest
|
|
// of the suite and the delegation branch is genuinely invoked.
|
|
$script = <<<'CHILD'
|
|
<?php
|
|
error_reporting(0);
|
|
ini_set('display_errors', '0');
|
|
|
|
class CactiSecureHeaders {
|
|
public static function getNonceAttribute(): string {
|
|
return ' nonce="pest-controlled-double"';
|
|
}
|
|
}
|
|
|
|
if (isset($argv[2]) && $argv[2] !== '' && is_file($argv[2])) {
|
|
try { require $argv[2]; } catch (\Throwable $e) { /* no Cacti host locally */ }
|
|
}
|
|
|
|
require $argv[1];
|
|
|
|
echo "<<<" . plugin_thold_csp_nonce() . ">>>";
|
|
CHILD;
|
|
|
|
$tmp = tempnam(sys_get_temp_dir(), 'csp_');
|
|
expect($tmp)->not->toBeFalse();
|
|
|
|
try {
|
|
file_put_contents($tmp, $script);
|
|
|
|
$command = escapeshellarg(PHP_BINARY) . ' ' . escapeshellarg($tmp) . ' ' . escapeshellarg($wrapper) . ' ' . escapeshellarg($bootstrap === false ? '' : $bootstrap);
|
|
$output = shell_exec($command);
|
|
|
|
expect($output)->not->toBeNull();
|
|
|
|
preg_match('/<<<(.*)>>>/s', (string) $output, $matches);
|
|
expect($matches)->toHaveKey(1);
|
|
expect($matches[1])->toBe(' nonce="pest-controlled-double"');
|
|
} finally {
|
|
@unlink($tmp);
|
|
}
|
|
});
|