Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
87.62% |
92 / 105 |
|
71.43% |
10 / 14 |
CRAP | |
0.00% |
0 / 1 |
| TalkPageNotificationManager | |
87.62% |
92 / 105 |
|
71.43% |
10 / 14 |
38.46 | |
0.00% |
0 / 1 |
| __construct | |
100.00% |
7 / 7 |
|
100.00% |
1 / 1 |
1 | |||
| userHasNewMessages | |
100.00% |
6 / 6 |
|
100.00% |
1 / 1 |
3 | |||
| clearForPageView | |
62.96% |
17 / 27 |
|
0.00% |
0 / 1 |
9.49 | |||
| setUserHasNewMessages | |
100.00% |
6 / 6 |
|
100.00% |
1 / 1 |
2 | |||
| removeUserHasNewMessages | |
80.00% |
4 / 5 |
|
0.00% |
0 / 1 |
2.03 | |||
| getLatestSeenMessageTimestamp | |
92.31% |
12 / 13 |
|
0.00% |
0 / 1 |
6.02 | |||
| clearInstanceCache | |
100.00% |
2 / 2 |
|
100.00% |
1 / 1 |
1 | |||
| isTalkDisabled | |
100.00% |
1 / 1 |
|
100.00% |
1 / 1 |
2 | |||
| dbCheckNewUserMessages | |
100.00% |
7 / 7 |
|
100.00% |
1 / 1 |
1 | |||
| dbUpdateNewUserMessages | |
92.86% |
13 / 14 |
|
0.00% |
0 / 1 |
4.01 | |||
| dbDeleteNewUserMessages | |
100.00% |
9 / 9 |
|
100.00% |
1 / 1 |
2 | |||
| getQueryFieldAndId | |
100.00% |
6 / 6 |
|
100.00% |
1 / 1 |
2 | |||
| getCacheKey | |
100.00% |
1 / 1 |
|
100.00% |
1 / 1 |
2 | |||
| touchUser | |
100.00% |
1 / 1 |
|
100.00% |
1 / 1 |
1 | |||
| 1 | <?php |
| 2 | /** |
| 3 | * This program is free software; you can redistribute it and/or modify |
| 4 | * it under the terms of the GNU General Public License as published by |
| 5 | * the Free Software Foundation; either version 2 of the License, or |
| 6 | * (at your option) any later version. |
| 7 | * |
| 8 | * This program is distributed in the hope that it will be useful, |
| 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 11 | * GNU General Public License for more details. |
| 12 | * |
| 13 | * You should have received a copy of the GNU General Public License along |
| 14 | * with this program; if not, write to the Free Software Foundation, Inc., |
| 15 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
| 16 | * http://www.gnu.org/copyleft/gpl.html |
| 17 | * |
| 18 | * @file |
| 19 | */ |
| 20 | |
| 21 | namespace MediaWiki\User; |
| 22 | |
| 23 | use MediaWiki\Config\ServiceOptions; |
| 24 | use MediaWiki\Deferred\DeferredUpdates; |
| 25 | use MediaWiki\HookContainer\HookContainer; |
| 26 | use MediaWiki\HookContainer\HookRunner; |
| 27 | use MediaWiki\MainConfigNames; |
| 28 | use MediaWiki\Revision\RevisionLookup; |
| 29 | use MediaWiki\Revision\RevisionRecord; |
| 30 | use MediaWiki\Utils\MWTimestamp; |
| 31 | use Wikimedia\Rdbms\IConnectionProvider; |
| 32 | use Wikimedia\Rdbms\ReadOnlyMode; |
| 33 | |
| 34 | /** |
| 35 | * Manages user talk page notifications |
| 36 | * |
| 37 | * @since 1.35 |
| 38 | * @ingroup User |
| 39 | */ |
| 40 | class TalkPageNotificationManager { |
| 41 | |
| 42 | /** |
| 43 | * @internal For use by ServiceWiring |
| 44 | */ |
| 45 | public const CONSTRUCTOR_OPTIONS = [ |
| 46 | MainConfigNames::DisableAnonTalk |
| 47 | ]; |
| 48 | |
| 49 | private array $userMessagesCache = []; |
| 50 | private bool $disableAnonTalk; |
| 51 | private IConnectionProvider $dbProvider; |
| 52 | private ReadOnlyMode $readOnlyMode; |
| 53 | private RevisionLookup $revisionLookup; |
| 54 | private HookRunner $hookRunner; |
| 55 | private UserFactory $userFactory; |
| 56 | |
| 57 | /** |
| 58 | * @param ServiceOptions $serviceOptions |
| 59 | * @param IConnectionProvider $dbProvider |
| 60 | * @param ReadOnlyMode $readOnlyMode |
| 61 | * @param RevisionLookup $revisionLookup |
| 62 | * @param HookContainer $hookContainer |
| 63 | * @param UserFactory $userFactory |
| 64 | */ |
| 65 | public function __construct( |
| 66 | ServiceOptions $serviceOptions, |
| 67 | IConnectionProvider $dbProvider, |
| 68 | ReadOnlyMode $readOnlyMode, |
| 69 | RevisionLookup $revisionLookup, |
| 70 | HookContainer $hookContainer, |
| 71 | UserFactory $userFactory |
| 72 | ) { |
| 73 | $serviceOptions->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS ); |
| 74 | $this->disableAnonTalk = $serviceOptions->get( MainConfigNames::DisableAnonTalk ); |
| 75 | $this->dbProvider = $dbProvider; |
| 76 | $this->readOnlyMode = $readOnlyMode; |
| 77 | $this->revisionLookup = $revisionLookup; |
| 78 | $this->hookRunner = new HookRunner( $hookContainer ); |
| 79 | $this->userFactory = $userFactory; |
| 80 | } |
| 81 | |
| 82 | /** |
| 83 | * Check if the user has new messages. |
| 84 | * @param UserIdentity $user |
| 85 | * @return bool whether the user has new messages |
| 86 | */ |
| 87 | public function userHasNewMessages( UserIdentity $user ): bool { |
| 88 | $userKey = $this->getCacheKey( $user ); |
| 89 | |
| 90 | // Load the newtalk status if it is unloaded |
| 91 | if ( !isset( $this->userMessagesCache[$userKey] ) ) { |
| 92 | if ( $this->isTalkDisabled( $user ) ) { |
| 93 | // Anon disabled by configuration. |
| 94 | $this->userMessagesCache[$userKey] = false; |
| 95 | } else { |
| 96 | $this->userMessagesCache[$userKey] = $this->dbCheckNewUserMessages( $user ); |
| 97 | } |
| 98 | } |
| 99 | |
| 100 | return (bool)$this->userMessagesCache[$userKey]; |
| 101 | } |
| 102 | |
| 103 | /** |
| 104 | * Clear notifications when the user's own talk page is viewed |
| 105 | * |
| 106 | * @param UserIdentity $user |
| 107 | * @param RevisionRecord|null $oldRev If it is an old revision view, the |
| 108 | * old revision. If it is a current revision view, this should be null. |
| 109 | */ |
| 110 | public function clearForPageView( |
| 111 | UserIdentity $user, |
| 112 | ?RevisionRecord $oldRev = null |
| 113 | ) { |
| 114 | // Abort if the hook says so. (Echo doesn't abort, it just queues its own update) |
| 115 | if ( !$this->hookRunner->onUserClearNewTalkNotification( |
| 116 | $user, |
| 117 | $oldRev ? $oldRev->getId() : 0 |
| 118 | ) ) { |
| 119 | return; |
| 120 | } |
| 121 | |
| 122 | if ( $this->isTalkDisabled( $user ) ) { |
| 123 | return; |
| 124 | } |
| 125 | |
| 126 | // Nothing to do if there are no messages |
| 127 | if ( !$this->userHasNewMessages( $user ) ) { |
| 128 | return; |
| 129 | } |
| 130 | |
| 131 | // If there is a subsequent revision after the one being viewed, use |
| 132 | // its timestamp as the new notification timestamp. If there is no |
| 133 | // subsequent revision, the notification is cleared. |
| 134 | if ( $oldRev ) { |
| 135 | $newRev = $this->revisionLookup->getNextRevision( $oldRev ); |
| 136 | if ( $newRev ) { |
| 137 | DeferredUpdates::addCallableUpdate( |
| 138 | function () use ( $user, $newRev ) { |
| 139 | $this->dbDeleteNewUserMessages( $user ); |
| 140 | $this->dbUpdateNewUserMessages( $user, $newRev ); |
| 141 | } |
| 142 | ); |
| 143 | return; |
| 144 | } |
| 145 | } |
| 146 | |
| 147 | // Update the cache now so that the skin doesn't show a notification |
| 148 | $userKey = $this->getCacheKey( $user ); |
| 149 | $this->userMessagesCache[$userKey] = false; |
| 150 | |
| 151 | // Defer the DB delete |
| 152 | DeferredUpdates::addCallableUpdate( |
| 153 | function () use ( $user ) { |
| 154 | $this->touchUser( $user ); |
| 155 | $this->dbDeleteNewUserMessages( $user ); |
| 156 | } |
| 157 | ); |
| 158 | } |
| 159 | |
| 160 | /** |
| 161 | * Update the talk page messages status. |
| 162 | * |
| 163 | * @param UserIdentity $user |
| 164 | * @param RevisionRecord|null $curRev New, as yet unseen revision of the user talk page. |
| 165 | * Null is acceptable in case the revision is not known. This will indicate that new messages |
| 166 | * exist, but will not affect the latest seen message timestamp |
| 167 | */ |
| 168 | public function setUserHasNewMessages( |
| 169 | UserIdentity $user, |
| 170 | ?RevisionRecord $curRev = null |
| 171 | ): void { |
| 172 | if ( $this->isTalkDisabled( $user ) ) { |
| 173 | return; |
| 174 | } |
| 175 | |
| 176 | $userKey = $this->getCacheKey( $user ); |
| 177 | $this->userMessagesCache[$userKey] = true; |
| 178 | $this->touchUser( $user ); |
| 179 | $this->dbUpdateNewUserMessages( $user, $curRev ); |
| 180 | } |
| 181 | |
| 182 | /** |
| 183 | * Remove the new messages status |
| 184 | */ |
| 185 | public function removeUserHasNewMessages( UserIdentity $user ): void { |
| 186 | if ( $this->isTalkDisabled( $user ) ) { |
| 187 | return; |
| 188 | } |
| 189 | |
| 190 | $userKey = $this->getCacheKey( $user ); |
| 191 | $this->userMessagesCache[$userKey] = false; |
| 192 | |
| 193 | $this->dbDeleteNewUserMessages( $user ); |
| 194 | } |
| 195 | |
| 196 | /** |
| 197 | * Returns the timestamp of the latest revision of the user talkpage |
| 198 | * that the user has already seen in TS_MW format. |
| 199 | * If the user has no new messages, returns null |
| 200 | * |
| 201 | * @param UserIdentity $user |
| 202 | * @return string|null |
| 203 | */ |
| 204 | public function getLatestSeenMessageTimestamp( UserIdentity $user ): ?string { |
| 205 | $userKey = $this->getCacheKey( $user ); |
| 206 | // Don't use self::userHasNewMessages here to avoid an extra DB query |
| 207 | // in case the value is not cached already |
| 208 | if ( $this->isTalkDisabled( $user ) || |
| 209 | ( isset( $this->userMessagesCache[$userKey] ) && !$this->userMessagesCache[$userKey] ) |
| 210 | ) { |
| 211 | return null; |
| 212 | } |
| 213 | |
| 214 | [ $field, $id ] = $this->getQueryFieldAndId( $user ); |
| 215 | // Get the "last viewed rev" timestamp from the oldest message notification |
| 216 | $timestamp = $this->dbProvider->getReplicaDatabase()->newSelectQueryBuilder() |
| 217 | ->select( 'MIN(user_last_timestamp)' ) |
| 218 | ->from( 'user_newtalk' ) |
| 219 | ->where( [ $field => $id ] ) |
| 220 | ->caller( __METHOD__ )->fetchField(); |
| 221 | if ( $timestamp ) { |
| 222 | // TODO: Now that User::setNewTalk() was removed, it should be possible to |
| 223 | // cache *not* having a new message as well (if $timestamp is null). |
| 224 | $this->userMessagesCache[$userKey] = true; |
| 225 | } |
| 226 | return $timestamp !== null ? MWTimestamp::convert( TS_MW, $timestamp ) : null; |
| 227 | } |
| 228 | |
| 229 | /** |
| 230 | * Remove the cached newtalk status for the given user |
| 231 | * @internal There should be no need to call this other than from User::clearInstanceCache |
| 232 | * @param UserIdentity $user |
| 233 | */ |
| 234 | public function clearInstanceCache( UserIdentity $user ): void { |
| 235 | $userKey = $this->getCacheKey( $user ); |
| 236 | $this->userMessagesCache[$userKey] = null; |
| 237 | } |
| 238 | |
| 239 | /** |
| 240 | * Check whether the talk page is disabled for a user |
| 241 | * @param UserIdentity $user |
| 242 | * @return bool |
| 243 | */ |
| 244 | private function isTalkDisabled( UserIdentity $user ): bool { |
| 245 | return !$user->isRegistered() && $this->disableAnonTalk; |
| 246 | } |
| 247 | |
| 248 | /** |
| 249 | * Internal uncached check for new messages |
| 250 | * @param UserIdentity $user |
| 251 | * @return bool True if the user has new messages |
| 252 | */ |
| 253 | private function dbCheckNewUserMessages( UserIdentity $user ): bool { |
| 254 | [ $field, $id ] = $this->getQueryFieldAndId( $user ); |
| 255 | $ok = $this->dbProvider->getReplicaDatabase()->newSelectQueryBuilder() |
| 256 | ->select( $field ) |
| 257 | ->from( 'user_newtalk' ) |
| 258 | ->where( [ $field => $id ] ) |
| 259 | ->caller( __METHOD__ )->fetchField(); |
| 260 | return (bool)$ok; |
| 261 | } |
| 262 | |
| 263 | /** |
| 264 | * Add or update the new messages flag |
| 265 | * @param UserIdentity $user |
| 266 | * @param RevisionRecord|null $curRev New, as yet unseen revision of the |
| 267 | * user talk page. Ignored if null. |
| 268 | * @return bool True if successful, false otherwise |
| 269 | */ |
| 270 | private function dbUpdateNewUserMessages( |
| 271 | UserIdentity $user, |
| 272 | ?RevisionRecord $curRev = null |
| 273 | ): bool { |
| 274 | if ( $this->readOnlyMode->isReadOnly() ) { |
| 275 | return false; |
| 276 | } |
| 277 | |
| 278 | if ( $curRev ) { |
| 279 | $prevRev = $this->revisionLookup->getPreviousRevision( $curRev ); |
| 280 | $ts = $prevRev ? $prevRev->getTimestamp() : null; |
| 281 | } else { |
| 282 | $ts = null; |
| 283 | } |
| 284 | |
| 285 | // Mark the user as having new messages since this revision |
| 286 | $dbw = $this->dbProvider->getPrimaryDatabase(); |
| 287 | [ $field, $id ] = $this->getQueryFieldAndId( $user ); |
| 288 | $dbw->newInsertQueryBuilder() |
| 289 | ->insertInto( 'user_newtalk' ) |
| 290 | ->ignore() |
| 291 | ->row( [ $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ] ) |
| 292 | ->caller( __METHOD__ )->execute(); |
| 293 | return (bool)$dbw->affectedRows(); |
| 294 | } |
| 295 | |
| 296 | /** |
| 297 | * Clear the new messages flag for the given user |
| 298 | * @param UserIdentity $user |
| 299 | * @return bool True if successful, false otherwise |
| 300 | */ |
| 301 | private function dbDeleteNewUserMessages( UserIdentity $user ): bool { |
| 302 | if ( $this->readOnlyMode->isReadOnly() ) { |
| 303 | return false; |
| 304 | } |
| 305 | $dbw = $this->dbProvider->getPrimaryDatabase(); |
| 306 | [ $field, $id ] = $this->getQueryFieldAndId( $user ); |
| 307 | $dbw->newDeleteQueryBuilder() |
| 308 | ->deleteFrom( 'user_newtalk' ) |
| 309 | ->where( [ $field => $id ] ) |
| 310 | ->caller( __METHOD__ )->execute(); |
| 311 | return (bool)$dbw->affectedRows(); |
| 312 | } |
| 313 | |
| 314 | /** |
| 315 | * Get the field name and id for the user_newtalk table query |
| 316 | * @param UserIdentity $user |
| 317 | * @return array ( string $field, string|int $id ) |
| 318 | */ |
| 319 | private function getQueryFieldAndId( UserIdentity $user ): array { |
| 320 | if ( $user->isRegistered() ) { |
| 321 | $field = 'user_id'; |
| 322 | $id = $user->getId(); |
| 323 | } else { |
| 324 | $field = 'user_ip'; |
| 325 | $id = $user->getName(); |
| 326 | } |
| 327 | return [ $field, $id ]; |
| 328 | } |
| 329 | |
| 330 | /** |
| 331 | * Gets a unique key for various caches. |
| 332 | * @param UserIdentity $user |
| 333 | * @return string |
| 334 | */ |
| 335 | private function getCacheKey( UserIdentity $user ): string { |
| 336 | return $user->isRegistered() ? "u:{$user->getId()}" : "anon:{$user->getName()}"; |
| 337 | } |
| 338 | |
| 339 | /** |
| 340 | * Update the user touched timestamp |
| 341 | */ |
| 342 | private function touchUser( UserIdentity $user ) { |
| 343 | // Ideally this would not be in User, it would be in its own service |
| 344 | // or something |
| 345 | $this->userFactory->newFromUserIdentity( $user )->touch(); |
| 346 | } |
| 347 | } |