updates

.gitattributes

@@ -28,4 +28,5 @@ qodana.yaml export-ignore
 renovate.json export-ignore
 .coderabbit.yaml export-ignore
 sonar-project.properties export-ignore
+CHANGELOG.md export-ignore
 CLAUDE.md export-ignore

.github/workflows/ci.yml

@@ -73,11 +73,15 @@ jobs:
         run: mkdir -p build/logs
 
       - name: Run all CI checks
+        if: ${{ !matrix.coverage }}
         run: composer ci
 
-      - name: Generate coverage report
+      - name: Run CI checks with coverage
         if: ${{ matrix.coverage }}
-        run: ./vendor/bin/phpunit --colors=always --coverage-clover build/logs/clover.xml
+        run: |
+          composer lint
+          composer analyse
+          ./vendor/bin/phpunit --colors=always --coverage-clover build/logs/clover.xml
 
       - name: Upload coverage to Codecov
         if: ${{ matrix.coverage }}

.github/workflows/sonarcloud.yml

@@ -10,6 +10,8 @@ jobs:
     name: SonarCloud Analysis
     runs-on: ubuntu-latest
     if: github.repository == 'XOOPS/RegDom'
+    env:
+      SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
 
     steps:
       - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5
@@ -36,7 +38,7 @@ jobs:
         run: ./vendor/bin/phpunit --colors=always --coverage-clover build/logs/clover.xml
 
       - name: SonarCloud Scan
-        if: ${{ secrets.SONAR_TOKEN != '' }}
+        if: env.SONAR_TOKEN != ''
         uses: SonarSource/sonarqube-scan-action@a31c9398be7ace6bbfaf30c0bd5d415f843d45e9 # v7
         env:
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

CHANGELOG.md

@@ -0,0 +1,181 @@
+# RegDom ChangeLog
+
+All notable changes to this project will be documented in this file.
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+
+## [Unreleased]
+
+### Bug Fixes
+* Fix `getPublicSuffix()` PSL exception-rule handling — exception branch returned one label too many; now correctly returns the exception rule minus its leftmost label (e.g. `!city.kawasaki.jp` yields public suffix `kawasaki.jp`, not `city.kawasaki.jp`)
+* Fix `normalizeHost()` corrupting IPv6 addresses — the port-stripping regex `/:\d+$/` mistakenly treated the last hextet of addresses like `::1` as a port, truncating them; IPv6 literals are now parsed bracket-aware
+* Fix PSL cache storing IDN rules as Unicode — `bin/update-psl.php` now normalizes all rules to ASCII/punycode via `idn_to_ascii()`, matching the form used by `normalizeDomain()` at runtime; previously 457 Unicode keys were unreachable when `ext-intl` was loaded
+* Fix `composer.json` PHP constraint from `"^7.4 || ^8.5"` to `"^7.4 || ^8.0"` (previously excluded PHP 8.0–8.4)
+* Fix `normalizeDomain()` crash on empty string — `idn_to_ascii('')` throws `ValueError` on PHP 8.4+; added `$domain !== ''` guard
+* Fix PSL exception tests referencing `parliament.uk` (removed from the PSL); replaced with stable entries (`www.ck`, `city.kawasaki.jp`)
+* Fix `bin/update-psl.php` failing when run standalone on PHP 7.4 — `str_starts_with()` was called without loading the polyfill autoloader
+* Fix `bin/reloadpsl` calling removed methods (`clearDataDirectory()`, `getTree()`); rewritten as a simple wrapper
+* Fix `getMetadata()` unreachable statement
+
+### Security
+* Add `opcache_invalidate()` after atomic cache writes in `bin/update-psl.php`
+* Add `is_array()` validation for all three PSL cache keys (`NORMAL`, `WILDCARD`, `EXCEPTION`) in `loadRules()`
+* Add file size sanity check (100KB–10MB) before `include` in `loadRules()` to reject corrupt or tampered cache files
+* Replace suppressed `@unlink()` with explicit `file_exists()` guard on temp-file cleanup in `bin/update-psl.php`
+
+### Changed
+* Make `normalizeDomain()` a `private static` method (was instance method)
+* Replace `strpos()`/`substr()` patterns with `str_contains()`/`str_starts_with()`/`str_ends_with()` via `symfony/polyfill-php80`
+* Add `@throws PslCacheNotFoundException` PHPDoc tags to `PublicSuffixList::__construct()` and `loadRules()`
+* Add XOOPS copyright headers to all source files
+* Clarify `README.md` license section — library code is Apache-2.0, bundled PSL data is MPL-2.0
+
+### Added
+* Add `symfony/polyfill-php80` dependency for `str_contains`, `str_starts_with`, `str_ends_with` on PHP 7.4
+* Add `ext-intl` to `suggest` in `composer.json`
+
+### Tests
+* Add PSL exception-rule regression tests — `sub.city.kawasaki.jp`, `city.kawasaki.jp`, `sub.www.ck`, `www.ck` for both `getPublicSuffix()` and `getRegisteredDomain()`
+* Add IPv6 normalization tests — `[::1]`, `[::1]:443`, `[2001:db8::1]:8080` for `getRegisteredDomain()` and `domainMatches()`
+* Add IDN/punycode PSL cache tests — `公司.cn`, `xn--55qx5d.cn` for `isPublicSuffix()` and `getPublicSuffix()`
+* Add IDN integration tests — `test.公司.cn`, `test.xn--55qx5d.cn`, `公司.cn` through the full `RegisteredDomain` stack
+* Add `PslCacheNotFoundExceptionTest` — exception class, message, code, previous exception
+* Add edge case tests for `getRegisteredDomain()` — trailing dots, URLs with ports
+* Add `PublicSuffixList` tests — empty string, IP addresses, `isException`, normalization (dots, case)
+* Add `domainMatches()` tests for RFC 6265 cookie domain validation
+* Expand `getMetadata()` assertions — `needs_update`, wildcard/exception counts
+
+### Infrastructure
+* Add `declare(strict_types=1)` to `bin/update-psl.php`
+* Add Composer autoloader bootstrap to `bin/update-psl.php` for standalone execution
+* Add `composer ci` script chaining lint + analyse + test
+* Add `composer update-psl` and `auto-update-psl` scripts with `XOOPS_SKIP_PSL_UPDATE` support
+* Add GitHub Actions CI workflow — PHP 7.4–8.5 matrix, lowest-deps on 7.4, coverage on 8.3
+* Fix CI coverage matrix entry running tests twice — added `if: !matrix.coverage` guard
+* Fix SonarCloud workflow using `secrets` context in step-level `if:` — moved to job-level `env`
+* Add GitHub Copilot custom instructions (`.github/copilot-instructions.md`)
+* Add Dependabot configuration for Composer and GitHub Actions
+* Add Qodana static analysis workflow
+* Add `.editorconfig` (UTF-8, LF, PSR-12 indentation)
+* Remove `xsi:noNamespaceSchemaLocation` from `phpunit.xml.dist` to avoid XSD validation warnings on PHPUnit 9; `<source>` element works natively on PHPUnit 10+/11+
+* Standardize `.gitattributes` with LF enforcement and export-ignore list
+* Standardize `.gitignore` with local config overrides, build artifacts, PHPUnit cache
+* Track `phpcs.xml` in version control (was previously untracked, causing CI lint failure)
+* Fix PSR-4 autoload-dev mappings for `tests/unit/` and `tests/integration/`
+* Rewrite `README.md` with current API documentation and usage examples
+* Remove legacy config files (`.travis0.yml`, `phpcs.xml.dist`, `phpcs.xml0.dist`, `phpunit.xml0.dist`, `.scrutinizer0.yml`, `composer0.json`, `composer1.json`)
+
+## [2.0.2-beta2] - 2025-10-01
+
+### Changed
+* Rewrite `PublicSuffixList` — flat-file PSL cache (`data/psl.cache.php`) replaces tree-based data structure; three-category rule lookup (`NORMAL`, `WILDCARD`, `EXCEPTION`) with `O(1)` hash lookups
+* Rewrite `RegisteredDomain` — simplified API using `PublicSuffixList` for all PSL queries; added `domainMatches()` for RFC 6265 cookie domain validation
+* Replace `bin/reloadpsl` with `bin/update-psl.php` — HTTP conditional downloads (ETag/Last-Modified), atomic file writes, metadata tracking
+* Add custom exception `PslCacheNotFoundException` for missing/invalid cache files
+* Require `symfony/polyfill-mbstring` `^1.33`
+
+### Added
+* Add `getMetadata()` to `PublicSuffixList` — cache age, rule counts, staleness warning
+* Add `isException()` to `PublicSuffixList` — check if a domain is a PSL exception entry
+* Add `isPublicSuffix()` and `getPublicSuffix()` public methods to `PublicSuffixList`
+* Add integration test suite with real PSL data
+
+### Infrastructure
+* Add PHPStan static analysis (`phpstan.neon`, level max)
+* Add PHP_CodeSniffer with PSR-12 standard
+* Add `.scrutinizer.yml` configuration
+* Add `phpunit.xml.dist` with unit and integration test suites
+* Require PHPUnit `^9.6 || ^10.0 || ^11.0`
+
+## [2.0.2-beta1] - 2025-09-10
+
+### Added
+* Add `.gitattributes` with export-ignore rules
+* Add PHPStan configuration (`phpstan.neon`)
+* Add PHP_CodeSniffer as a dev dependency
+
+### Changed
+* Add `phpstan/phpstan` and `squizlabs/php_codesniffer` to `require-dev`
+* Remove backslash prefix from `isset()` calls in `PublicSuffixList`
+* Update `composer.json` dependencies
+
+## [2.0.1] - 2024-11-27
+
+### Added
+* Add `.github/CONTRIBUTING.md` with contribution guidelines
+* Add `.github/ISSUE_TEMPLATE/bug-report.yml` with PHP version dropdown (7.4–8.4)
+* Add `.github/ISSUE_TEMPLATE/feature-request.yml`
+
+### Changed
+* Add PHP 8.4 to Travis CI test matrix
+* Update `composer.json` PHP constraint
+
+## [2.0.0] - 2024-07-26
+
+### Changed
+* Bump `symfony/polyfill-mbstring` constraint from `^1.29.0` to `^1.30.0`
+
+## [2.0.0-Alpha] - 2024-07-08
+
+### Changed
+* Rename namespace from `Geekwright\RegDom` to `Xoops\RegDom`
+* Modernise codebase for PHP 7.4+ — short array syntax, type hints, Yoda conditions removed
+* Replace `PHPUnit_Framework_TestCase` with `PHPUnit\Framework\TestCase`
+* Improve `decodePunycode()` implementation
+* Add `is_string()` guard to curl return value
+* Remove redundant type casts and `else` keywords
+* Remove `PHP_VERSION_ID < 70000` compatibility code
+* Update Public Suffix List data
+
+### Added
+* Add GitHub Actions workflow for CI (`pr_tests.yml`)
+* Add Scrutinizer CI configuration
+* Add `symfony/polyfill-mbstring` `^1.29.0` as a runtime dependency
+* Add PSR-4 autoloading via Composer
+
+### Removed
+* Remove `/archive` directory with legacy files
+* Remove Travis CI configuration (`.travis.yml`)
+
+## Pre-release History
+
+### 2023-04-30
+* Tweak PHP version check for pre-7.0 compatibility (geekwright)
+* Fix `unserialize()` — limit allowed classes for security (geekwright)
+
+### 2022-04-08
+* Limit `unserialize()` to prevent object injection (geekwright)
+* Add Scrutinizer CI configuration (geekwright)
+
+### 2019-08-30
+* Remove array access with curly brackets for PHP 7.4 compatibility (geekwright)
+* Fix build for PHP 5.4 and 5.5 (geekwright)
+
+### 2018-02-07
+* Restructure unit tests (geekwright)
+* Simplify Travis CI configuration (geekwright)
+
+### 2017-10-03
+* Add PHP 7.2 support (geekwright)
+* Update Public Suffix List data (geekwright)
+* Fix CI configuration (geekwright)
+
+### 2017-02-03 — Initial OO Rewrite
+* Rewrite as OO library under `Geekwright\RegDom` namespace (geekwright)
+* Add Composer support with PSR-4 autoloading (geekwright)
+* Add `PublicSuffixList` class for PSL data management (geekwright)
+* Add `RegisteredDomain` class for domain extraction (geekwright)
+* Add `bin/reloadpsl` script for PSL updates (geekwright)
+* Add unit tests with PHPUnit (geekwright)
+* Add Scrutinizer CI and Travis CI configurations (geekwright)
+* Add workaround for missing `ext-intl` (geekwright)
+
+### 2012-10-02 — Original Import
+* Import Florian Sager's regdom-php library (Synchro/Marcus Bointon)
+* PHP include file for domain registration data (Synchro/Marcus Bointon)
+
+[Unreleased]: https://github.com/XOOPS/RegDom/compare/v2.0.2-beta2...HEAD
+[2.0.2-beta2]: https://github.com/XOOPS/RegDom/compare/v2.0.2-beta1...v2.0.2-beta2
+[2.0.2-beta1]: https://github.com/XOOPS/RegDom/compare/v2.0.1...v2.0.2-beta1
+[2.0.1]: https://github.com/XOOPS/RegDom/compare/v2.0.0...v2.0.1
+[2.0.0]: https://github.com/XOOPS/RegDom/compare/v2.0.0-Alpha...v2.0.0
+[2.0.0-Alpha]: https://github.com/XOOPS/RegDom/releases/tag/v2.0.0-Alpha

README.md

@@ -117,5 +117,9 @@ Marcus Bointon's adapted code: https://github.com/Synchro/regdom-php
 
 ## License
 
-Licensed under Apache License 2.0 or Mozilla Public License 2.0 (dual-licensed).
-See [LICENSE.txt](LICENSE.txt) for details.
+The PHP library code in this repository is licensed under the Apache License 2.0.
+See [LICENSE.txt](LICENSE.txt) for the full Apache 2.0 license text.
+
+The bundled Public Suffix List data/cache is derived from Mozilla's Public Suffix List
+and is available under the Mozilla Public License 2.0 (MPL-2.0). For details, see
+https://www.mozilla.org/en-US/MPL/2.0/ and https://publicsuffix.org/.

bin/update-psl.php

@@ -49,15 +49,23 @@
 // --- HTTP Conditional Download ---
 $headers = ['User-Agent: XOOPS-RegDom/1.1 (https://xoops.org)'];
 $meta = file_exists($metaPath) ? json_decode(file_get_contents($metaPath), true) : [];
-if (!empty($meta['etag'])) $headers[] = "If-None-Match: {$meta['etag']}";
-if (!empty($meta['last_modified'])) $headers[] = "If-Modified-Since: {$meta['last_modified']}";
+if (!empty($meta['etag'])) {
+    $headers[] = "If-None-Match: {$meta['etag']}";
+}
+if (!empty($meta['last_modified'])) {
+    $headers[] = "If-Modified-Since: {$meta['last_modified']}";
+}
 
 echo "Downloading from publicsuffix.org...\n";
 $context = stream_context_create(['http' => ['method' => 'GET', 'timeout' => 20, 'header' => implode("\r\n", $headers), 'ignore_errors' => true]]);
 $latestList = @file_get_contents($sourceUrl, false, $context);
 $responseHeaders = $http_response_header ?? [];
 $statusCode = 0;
-foreach ($responseHeaders as $header) if (preg_match('/^HTTP\/\d\.\d\s+(\d+)/', $header, $m)) $statusCode = (int)$m[1];
+foreach ($responseHeaders as $header) {
+    if (preg_match('/^HTTP\/\d\.\d\s+(\d+)/', $header, $m)) {
+        $statusCode = (int)$m[1];
+    }
+}
 
 if ($statusCode === 304) {
     echo "SUCCESS: Public Suffix List is already up-to-date (304 Not Modified).\n";
@@ -71,14 +79,44 @@
 
 // --- Parse and Generate Cache ---
 echo "Parsing rules...\n";
+
+// Normalize rule keys to ASCII/punycode so they match the form used by
+// PublicSuffixList::normalizeDomain() at runtime (which calls idn_to_ascii).
+$hasIntl = function_exists('idn_to_ascii');
+if (!$hasIntl) {
+    echo "WARNING: ext-intl not available — IDN rules will be stored as Unicode.\n";
+    echo "         Install ext-intl for correct internationalized domain handling.\n";
+}
+
+/**
+ * @param string $rule Raw rule text from the PSL (may be Unicode)
+ * @return string Normalised key (punycode when ext-intl is available)
+ */
+$normalizeRule = static function (string $rule) use ($hasIntl): string {
+    $rule = strtolower($rule);
+    if ($hasIntl) {
+        $ascii = idn_to_ascii($rule, IDNA_DEFAULT, INTL_IDNA_VARIANT_UTS46);
+        if ($ascii !== false) {
+            return $ascii;
+        }
+    }
+    return $rule;
+};
+
 $lines = explode("\n", $latestList);
 $rules = ['NORMAL' => [], 'WILDCARD' => [], 'EXCEPTION' => []];
 foreach ($lines as $line) {
     $line = trim($line);
-    if (empty($line) || str_starts_with($line, '//')) continue;
-    if (str_starts_with($line, '!')) $rules['EXCEPTION'][substr($line, 1)] = true;
-    elseif (str_starts_with($line, '*.')) $rules['WILDCARD'][substr($line, 2)] = true;
-    else $rules['NORMAL'][$line] = true;
+    if (empty($line) || str_starts_with($line, '//')) {
+        continue;
+    }
+    if (str_starts_with($line, '!')) {
+        $rules['EXCEPTION'][$normalizeRule(substr($line, 1))] = true;
+    } elseif (str_starts_with($line, '*.')) {
+        $rules['WILDCARD'][$normalizeRule(substr($line, 2))] = true;
+    } else {
+        $rules['NORMAL'][$normalizeRule($line)] = true;
+    }
 }
 
 $totalRules = count($rules['NORMAL']) + count($rules['WILDCARD']) + count($rules['EXCEPTION']);
@@ -92,7 +130,9 @@
 
 // --- Atomic Write to Caches ---
 $writePaths = ['bundled' => $bundledCachePath];
-if ($runtimeCachePath) $writePaths['runtime'] = $runtimeCachePath;
+if ($runtimeCachePath) {
+    $writePaths['runtime'] = $runtimeCachePath;
+}
 
 foreach ($writePaths as $type => $cachePath) {
     $tmpPath = $cachePath . '.tmp.' . getmypid();
@@ -103,15 +143,21 @@
         echo "SUCCESS: {$type} cache updated with {$totalRules} rules.\n";
     } else {
         echo "WARNING: Could not write {$type} cache to {$cachePath}.\n";
-        @unlink($tmpPath);
+        if (file_exists($tmpPath)) {
+            unlink($tmpPath);
+        }
     }
 }
 
 // --- Save Metadata ---
 $newMeta = ['updated' => date('c'), 'etag' => null, 'last_modified' => null];
 foreach ($responseHeaders as $header) {
-    if (stripos($header, 'ETag:') === 0) $newMeta['etag'] = trim(substr($header, 5));
-    if (stripos($header, 'Last-Modified:') === 0) $newMeta['last_modified'] = trim(substr($header, 14));
+    if (stripos($header, 'ETag:') === 0) {
+        $newMeta['etag'] = trim(substr($header, 5));
+    }
+    if (stripos($header, 'Last-Modified:') === 0) {
+        $newMeta['last_modified'] = trim(substr($header, 14));
+    }
 }
 file_put_contents($metaPath, json_encode($newMeta, JSON_PRETTY_PRINT));