XOOPS /
XoopsCore25
| Total Complexity | 47 |
| Total Lines | 197 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
Complex classes like PublicSuffixList often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use PublicSuffixList, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 22 | class PublicSuffixList |
||
| 23 | { |
||
| 24 | /** |
||
| 25 | * @var array{'NORMAL': array<string, true>, 'WILDCARD': array<string, true>, 'EXCEPTION': array<string, true>}|null |
||
| 26 | */ |
||
| 27 | private static ?array $rules = null; |
||
| 28 | |||
| 29 | public function __construct() |
||
| 33 | } |
||
| 34 | } |
||
| 35 | |||
| 36 | /** |
||
| 37 | * @return array{'NORMAL': array<string, true>, 'WILDCARD': array<string, true>, 'EXCEPTION': array<string, true>} |
||
| 38 | */ |
||
| 39 | private function loadRules(): array |
||
| 40 | { |
||
| 41 | $paths = []; |
||
| 42 | if (defined('XOOPS_VAR_PATH') && is_string(XOOPS_VAR_PATH) && XOOPS_VAR_PATH !== '') { |
||
|
introduced
by
|
|||
| 43 | $paths[] = XOOPS_VAR_PATH . '/cache/regdom/psl.cache.php'; |
||
| 44 | } |
||
| 45 | $paths[] = __DIR__ . '/../data/psl.cache.php'; |
||
| 46 | |||
| 47 | foreach ($paths as $path) { |
||
| 48 | if (is_file($path) && is_readable($path)) { |
||
| 49 | $rules = include $path; |
||
| 50 | |||
| 51 | if ( |
||
| 52 | is_array($rules) |
||
| 53 | && isset($rules['NORMAL'], $rules['WILDCARD'], $rules['EXCEPTION']) |
||
| 54 | && is_array($rules['NORMAL']) |
||
| 55 | && is_array($rules['WILDCARD']) |
||
| 56 | ) { |
||
| 57 | $totalRules = count($rules['NORMAL']) + count($rules['WILDCARD']); |
||
| 58 | if ($totalRules > 1000 && $totalRules < 100000) { |
||
| 59 | /** @var array{'NORMAL': array<string, true>, 'WILDCARD': array<string, true>, 'EXCEPTION': array<string, true>} $rules */ |
||
| 60 | return $rules; |
||
| 61 | } |
||
| 62 | } |
||
| 63 | } |
||
| 64 | } |
||
| 65 | // Last resort: throw an exception instead of logging |
||
| 66 | throw new \Xoops\RegDom\Exception\PslCacheNotFoundException('No valid PSL cache found. Run `composer run update-psl` to generate one.'); |
||
| 67 | } |
||
| 68 | |||
| 69 | /** |
||
| 70 | * Checks if a given domain is a public suffix (e.g., 'com', 'co.uk'). |
||
| 71 | */ |
||
| 72 | public function isPublicSuffix(string $domain): bool |
||
| 73 | { |
||
| 74 | $domain = $this->normalizeDomain($domain); |
||
| 75 | if ($domain === '' || filter_var($domain, FILTER_VALIDATE_IP)) { |
||
| 76 | return false; |
||
| 77 | } |
||
| 78 | |||
| 79 | if (isset(self::$rules['EXCEPTION'][$domain])) { |
||
| 80 | return false; |
||
| 81 | } |
||
| 82 | if (isset(self::$rules['NORMAL'][$domain])) { |
||
| 83 | return true; |
||
| 84 | } |
||
| 85 | |||
| 86 | $parts = explode('.', $domain); |
||
| 87 | if (count($parts) >= 2) { |
||
| 88 | array_shift($parts); |
||
| 89 | $parent = implode('.', $parts); |
||
| 90 | if (isset(self::$rules['WILDCARD'][$parent])) { |
||
| 91 | return true; |
||
| 92 | } |
||
| 93 | } |
||
| 94 | |||
| 95 | return false; |
||
| 96 | } |
||
| 97 | |||
| 98 | /** |
||
| 99 | * Gets the public suffix portion of a full domain. |
||
| 100 | */ |
||
| 101 | public function getPublicSuffix(string $domain): ?string |
||
| 102 | { |
||
| 103 | $domain = $this->normalizeDomain($domain); |
||
| 104 | if ($domain === '' || filter_var($domain, FILTER_VALIDATE_IP)) { |
||
| 105 | return null; |
||
| 106 | } |
||
| 107 | |||
| 108 | $parts = explode('.', $domain); |
||
| 109 | $n = count($parts); |
||
| 110 | for ($i = 0; $i < $n; $i++) { |
||
| 111 | $testSuffix = implode('.', array_slice($parts, $i)); |
||
| 112 | if (isset(self::$rules['EXCEPTION'][$testSuffix])) { |
||
| 113 | return $i > 0 ? implode('.', array_slice($parts, $i - 1)) : null; |
||
| 114 | } |
||
| 115 | if (isset(self::$rules['NORMAL'][$testSuffix])) { |
||
| 116 | return $testSuffix; |
||
| 117 | } |
||
| 118 | if ($i < $n - 1) { |
||
| 119 | $parent = implode('.', array_slice($parts, $i + 1)); |
||
| 120 | if (isset(self::$rules['WILDCARD'][$parent])) { |
||
| 121 | return $testSuffix; |
||
| 122 | } |
||
| 123 | } |
||
| 124 | } |
||
| 125 | return null; |
||
| 126 | } |
||
| 127 | |||
| 128 | /** |
||
| 129 | * Gets metadata about the loaded PSL cache, including a warning flag if the data is stale. |
||
| 130 | * |
||
| 131 | * @return array{ |
||
| 132 | * active_cache: string|null, |
||
| 133 | * last_updated: string|null, |
||
| 134 | * days_old: int|null, |
||
| 135 | * rule_counts: array<string, int>, |
||
| 136 | * needs_update: bool, |
||
| 137 | * error?: string |
||
| 138 | * } Metadata about the active cache. |
||
| 139 | */ |
||
| 140 | public function getMetadata(): array |
||
| 141 | { |
||
| 142 | // Add a guard clause to handle the case where rules are not loaded. |
||
| 143 | if (self::$rules === null) { |
||
| 144 | return [ |
||
| 145 | 'active_cache' => null, |
||
| 146 | 'last_updated' => null, |
||
| 147 | 'days_old' => null, |
||
| 148 | 'rule_counts' => ['normal' => 0, 'wildcard' => 0, 'exception' => 0], |
||
| 149 | 'needs_update' => true, |
||
| 150 | 'error' => 'Rules not loaded', |
||
| 151 | ]; |
||
| 152 | } |
||
| 153 | |||
| 154 | $runtimePath = null; |
||
| 155 | // Add is_string() to ensure the constant is safe to use. |
||
| 156 | if (defined('XOOPS_VAR_PATH') && is_string(XOOPS_VAR_PATH) && XOOPS_VAR_PATH !== '') { |
||
| 157 | $runtimePath = XOOPS_VAR_PATH . '/cache/regdom/psl.cache.php'; |
||
| 158 | } |
||
| 159 | $bundledPath = __DIR__ . '/../data/psl.cache.php'; |
||
| 160 | |||
| 161 | $activeCache = null; |
||
| 162 | $lastUpdated = null; |
||
| 163 | |||
| 164 | if ($runtimePath && file_exists($runtimePath)) { |
||
| 165 | $activeCache = 'runtime'; |
||
| 166 | $lastUpdated = filemtime($runtimePath); |
||
| 167 | } elseif (file_exists($bundledPath)) { |
||
| 168 | $activeCache = 'bundled'; |
||
| 169 | $lastUpdated = filemtime($bundledPath); |
||
| 170 | } |
||
| 171 | |||
| 172 | // Cast the result of floor() to an integer to match the docblock. |
||
| 173 | $daysOld = $lastUpdated ? (int) floor((time() - $lastUpdated) / 86400) : null; |
||
| 174 | |||
| 175 | $metadata = [ |
||
| 176 | 'active_cache' => $activeCache, |
||
| 177 | 'last_updated' => $lastUpdated ? date('Y-m-d H:i:s T', $lastUpdated) : null, |
||
| 178 | 'days_old' => $daysOld, |
||
| 179 | 'rule_counts' => [ |
||
| 180 | 'normal' => count(self::$rules['NORMAL']), |
||
| 181 | 'wildcard' => count(self::$rules['WILDCARD']), |
||
| 182 | 'exception' => count(self::$rules['EXCEPTION']), |
||
| 183 | ], |
||
| 184 | 'needs_update' => false, |
||
| 185 | ]; |
||
| 186 | |||
| 187 | if ($metadata['days_old'] && $metadata['days_old'] > 180) { |
||
| 188 | $metadata['needs_update'] = true; |
||
| 189 | } |
||
| 190 | |||
| 191 | return $metadata; |
||
| 192 | } |
||
| 193 | |||
| 194 | /** |
||
| 195 | * Normalizes a domain string for consistent processing. |
||
| 196 | */ |
||
| 197 | private function normalizeDomain(string $domain): string |
||
| 198 | { |
||
| 199 | $domain = strtolower(trim($domain)); |
||
| 200 | // Handles both leading and trailing dots |
||
| 201 | $domain = trim($domain, '.'); |
||
| 202 | |||
| 203 | if (function_exists('idn_to_ascii')) { |
||
| 204 | $domain = idn_to_ascii($domain, IDNA_DEFAULT, INTL_IDNA_VARIANT_UTS46) ?: $domain; |
||
| 205 | } |
||
| 206 | |||
| 207 | return $domain; |
||
| 208 | } |
||
| 209 | |||
| 210 | /** |
||
| 211 | * Checks if a domain is an explicit exception in the PSL. |
||
| 212 | * @param string $domain The domain to check. |
||
| 213 | * @return bool |
||
| 214 | */ |
||
| 215 | public function isException(string $domain): bool |
||
| 219 | } |
||
| 220 | } |
||
| 221 |
Loading history...