x-tools /
xtools
| Total Complexity | 63 |
| Total Lines | 399 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
Complex classes like UserRights 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 UserRights, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 18 | class UserRights extends Model |
||
| 19 | { |
||
| 20 | /** @var I18nHelper For i18n and l10n. */ |
||
| 21 | protected $i18n; |
||
| 22 | |||
| 23 | /** @var string[] Rights changes, keyed by timestamp then 'added' and 'removed'. */ |
||
| 24 | protected $rightsChanges; |
||
| 25 | |||
| 26 | /** @var string[] Localized names of the rights. */ |
||
| 27 | protected $rightsNames; |
||
| 28 | |||
| 29 | /** @var string[] Global rights changes (log), keyed by timestamp then 'added' and 'removed'. */ |
||
| 30 | protected $globalRightsChanges; |
||
| 31 | |||
| 32 | /** @var array The current and former rights of the user. */ |
||
| 33 | protected $rightsStates = []; |
||
| 34 | |||
| 35 | /** |
||
| 36 | * Get user rights changes of the given user. |
||
| 37 | * @param int|null $limit |
||
| 38 | * @return string[] Keyed by timestamp then 'added' and 'removed'. |
||
| 39 | */ |
||
| 40 | public function getRightsChanges(?int $limit = null): array |
||
| 41 | { |
||
| 42 | if (!isset($this->rightsChanges)) { |
||
| 43 | $logData = $this->getRepository() |
||
| 44 | ->getRightsChanges($this->project, $this->user); |
||
|
Bug
introduced
by
|
|||
| 45 | |||
| 46 | $this->rightsChanges = $this->processRightsChanges($logData); |
||
| 47 | |||
| 48 | $acDate = $this->getAutoconfirmedTimestamp(); |
||
| 49 | if (false !== $acDate) { |
||
| 50 | $this->rightsChanges[$acDate] = [ |
||
| 51 | 'logId' => null, |
||
| 52 | 'performer' => null, |
||
| 53 | 'comment' => null, |
||
| 54 | 'added' => ['autoconfirmed'], |
||
| 55 | 'removed' => [], |
||
| 56 | 'grantType' => strtotime($acDate) > time() ? 'pending' : 'automatic', |
||
| 57 | 'type' => 'local', |
||
| 58 | ]; |
||
| 59 | krsort($this->rightsChanges); |
||
| 60 | } |
||
| 61 | } |
||
| 62 | |||
| 63 | return array_slice($this->rightsChanges, 0, $limit, true); |
||
| 64 | } |
||
| 65 | |||
| 66 | /** |
||
| 67 | * Checks the user rights log to see whether the user is an admin or used to be one. |
||
| 68 | * @return string|false One of false (never an admin), 'current' or 'former'. |
||
| 69 | */ |
||
| 70 | public function getAdminStatus() |
||
| 71 | { |
||
| 72 | $rightsStates = $this->getRightsStates(); |
||
| 73 | |||
| 74 | if (in_array('sysop', $rightsStates['local']['current'])) { |
||
| 75 | return 'current'; |
||
| 76 | } elseif (in_array('sysop', $rightsStates['local']['former'])) { |
||
| 77 | return 'former'; |
||
| 78 | } else { |
||
| 79 | return false; |
||
| 80 | } |
||
| 81 | } |
||
| 82 | |||
| 83 | /** |
||
| 84 | * Get a list of the current and former rights of the user. |
||
| 85 | * @return array With keys 'local' and 'global', each with keys 'current' and 'former'. |
||
| 86 | */ |
||
| 87 | public function getRightsStates(): array |
||
| 88 | { |
||
| 89 | if (count($this->rightsStates) > 0) { |
||
| 90 | return $this->rightsStates; |
||
| 91 | } |
||
| 92 | |||
| 93 | foreach (['local', 'global'] as $type) { |
||
| 94 | [$currentRights, $rightsChanges] = $this->getCurrentRightsAndChanges($type); |
||
| 95 | |||
| 96 | $former = []; |
||
| 97 | |||
| 98 | // We'll keep track of added rights, which we'll later compare with the |
||
| 99 | // current rights to ensure the list of former rights is complete. |
||
| 100 | // This is because sometimes rights were removed but there mysteriously |
||
| 101 | // is no log entry of it. |
||
| 102 | $added = []; |
||
| 103 | |||
| 104 | foreach ($rightsChanges as $change) { |
||
| 105 | $former = array_diff( |
||
| 106 | array_merge($former, $change['removed']), |
||
| 107 | $change['added'] |
||
| 108 | ); |
||
| 109 | |||
| 110 | $added = array_unique(array_merge($added, $change['added'])); |
||
| 111 | } |
||
| 112 | |||
| 113 | // Also tag on rights that were previously added but mysteriously |
||
| 114 | // don't have a log entry for when they were removed. |
||
| 115 | $former = array_merge( |
||
| 116 | array_diff($added, $currentRights), |
||
| 117 | $former |
||
| 118 | ); |
||
| 119 | |||
| 120 | // Remove the current rights for good measure. Autoconfirmed is a special case -- it can never be former, |
||
| 121 | // but will end up in $former from the above code. |
||
| 122 | $former = array_diff(array_unique($former), $currentRights, ['autoconfirmed']); |
||
| 123 | |||
| 124 | $this->rightsStates[$type] = [ |
||
| 125 | 'current' => $currentRights, |
||
| 126 | 'former' => $former, |
||
| 127 | ]; |
||
| 128 | } |
||
| 129 | |||
| 130 | return $this->rightsStates; |
||
| 131 | } |
||
| 132 | |||
| 133 | /** |
||
| 134 | * Get a list of the current rights (of given type) and the log. |
||
| 135 | * @param string $type 'local' or 'global' |
||
| 136 | * @return array [string[] current rights, array rights changes]. |
||
| 137 | */ |
||
| 138 | private function getCurrentRightsAndChanges(string $type): array |
||
| 139 | { |
||
| 140 | // Current rights are not fetched from the log because really old |
||
| 141 | // log entries contained little or no metadata, and the rights |
||
| 142 | // changes may be undetectable. |
||
| 143 | if ('local' === $type) { |
||
| 144 | $currentRights = $this->user->getUserRights($this->project); |
||
| 145 | $rightsChanges = $this->getRightsChanges(); |
||
| 146 | |||
| 147 | $acDate = $this->getAutoconfirmedTimestamp(); |
||
| 148 | if (false !== $acDate && strtotime($acDate) <= time()) { |
||
| 149 | $currentRights[] = 'autoconfirmed'; |
||
| 150 | } |
||
| 151 | } else { |
||
| 152 | $currentRights = $this->user->getGlobalUserRights($this->project); |
||
| 153 | $rightsChanges = $this->getGlobalRightsChanges(); |
||
| 154 | } |
||
| 155 | |||
| 156 | return [$currentRights, $rightsChanges]; |
||
| 157 | } |
||
| 158 | |||
| 159 | /** |
||
| 160 | * Get a list of the current and former global rights of the user. |
||
| 161 | * @return array With keys 'current' and 'former'. |
||
| 162 | */ |
||
| 163 | public function getGlobalRightsStates(): array |
||
| 164 | { |
||
| 165 | return $this->getRightsStates()['global']; |
||
| 166 | } |
||
| 167 | |||
| 168 | /** |
||
| 169 | * Get global user rights changes of the given user. |
||
| 170 | * @param int|null $limit |
||
| 171 | * @return string[] Keyed by timestamp then 'added' and 'removed'. |
||
| 172 | */ |
||
| 173 | public function getGlobalRightsChanges(?int $limit = null): array |
||
| 174 | { |
||
| 175 | if (!isset($this->globalRightsChanges)) { |
||
| 176 | $logData = $this->getRepository() |
||
| 177 | ->getGlobalRightsChanges($this->project, $this->user); |
||
| 178 | $this->globalRightsChanges = $this->processRightsChanges($logData); |
||
| 179 | } |
||
| 180 | |||
| 181 | return array_slice($this->globalRightsChanges, 0, $limit, true); |
||
| 182 | } |
||
| 183 | |||
| 184 | /** |
||
| 185 | * Get the localized names for the user groups, fetched from on-wiki system messages. |
||
| 186 | * @return string[] Localized names keyed by database value. |
||
| 187 | */ |
||
| 188 | public function getRightsNames(): array |
||
| 189 | { |
||
| 190 | if (isset($this->rightsNames)) { |
||
| 191 | return $this->rightsNames; |
||
| 192 | } |
||
| 193 | |||
| 194 | $this->rightsNames = $this->getRepository() |
||
| 195 | ->getRightsNames($this->project, $this->i18n->getLang()); |
||
| 196 | |||
| 197 | return $this->rightsNames; |
||
| 198 | } |
||
| 199 | |||
| 200 | /** |
||
| 201 | * Get the localized translation for the given user right. |
||
| 202 | * @param string $name The name of the right, such as 'sysop'. |
||
| 203 | * @return string |
||
| 204 | */ |
||
| 205 | public function getRightsName(string $name): string |
||
| 206 | { |
||
| 207 | return $this->getRightsNames()[$name] ?? $name; |
||
| 208 | } |
||
| 209 | |||
| 210 | /** |
||
| 211 | * Process the given rights changes, sorting an putting in a human-readable format. |
||
| 212 | * @param array $logData As fetched with EditCounterRepository::getRightsChanges. |
||
| 213 | * @return array |
||
| 214 | */ |
||
| 215 | private function processRightsChanges(array $logData): array |
||
| 305 | } |
||
| 306 | |||
| 307 | /** |
||
| 308 | * Check the given log entry for rights changes that are set to automatically expire, |
||
| 309 | * and add entries to $rightsChanges accordingly. |
||
| 310 | * @param array $rightsChanges |
||
| 311 | * @param array $row Log entry row from database. |
||
| 312 | * @param array $params Unserialized log params. |
||
| 313 | * @param string[] $added List of added user rights. |
||
| 314 | */ |
||
| 315 | private function setAutoRemovals(array &$rightsChanges, array $row, array $params, array $added): void |
||
| 316 | { |
||
| 317 | foreach ($added as $index => $entry) { |
||
| 318 | $newMetadata = $params['newmetadata'][$index] ?? $params['newMetadata'][$index] ?? null; |
||
| 319 | |||
| 320 | // Skip if no expiry was set. |
||
| 321 | if (null === $newMetadata || empty($newMetadata['expiry']) |
||
| 322 | ) { |
||
| 323 | continue; |
||
| 324 | } |
||
| 325 | |||
| 326 | $expiry = $newMetadata['expiry']; |
||
| 327 | |||
| 328 | if (isset($rightsChanges[$expiry]) && !in_array($entry, $rightsChanges[$expiry]['removed'])) { |
||
| 329 | // Temporary right expired. |
||
| 330 | $rightsChanges[$expiry]['removed'][] = $entry; |
||
| 331 | } else { |
||
| 332 | // Temporary right was added. |
||
| 333 | $rightsChanges[$expiry] = [ |
||
| 334 | 'logId' => $row['log_id'], |
||
| 335 | 'performer' => $row['performer'], |
||
| 336 | 'comment' => null, |
||
| 337 | 'added' => [], |
||
| 338 | 'removed' => [$entry], |
||
| 339 | 'grantType' => strtotime($expiry) > time() ? 'pending' : 'automatic', |
||
| 340 | 'type' => $row['type'], |
||
| 341 | ]; |
||
| 342 | } |
||
| 343 | } |
||
| 344 | |||
| 345 | // Resort because the auto-removal timestamp could be before other rights changes. |
||
| 346 | ksort($rightsChanges); |
||
| 347 | } |
||
| 348 | |||
| 349 | private function unsetAutoRemoval(array &$rightsChanges, array $removed): void |
||
| 350 | { |
||
| 351 | foreach ($rightsChanges as $timestamp => $change) { |
||
| 352 | if ('pending' === $change['grantType']) { |
||
| 353 | $rightsChanges[$timestamp]['removed'] = array_diff($rightsChanges[$timestamp]['removed'], $removed); |
||
| 354 | if (empty($rightsChanges[$timestamp]['removed'])) { |
||
| 355 | unset($rightsChanges[$timestamp]); |
||
| 356 | } |
||
| 357 | } |
||
| 358 | } |
||
| 359 | } |
||
| 360 | |||
| 361 | /** |
||
| 362 | * Get the timestamp of when the user became autoconfirmed. |
||
| 363 | * @return string|false YmdHis format, or false if date is in the future or if AC status could not be determined. |
||
| 364 | */ |
||
| 365 | private function getAutoconfirmedTimestamp() |
||
| 417 | } |
||
| 418 | } |
||
| 419 |
Loading history...