Fix use of RawMessage in Status::getMessage()
[mediawiki.git] / includes / WatchedItem.php
blobb597f99d93e5d1c06ef2113ae90487e06577b035
1 <?php
2 /**
3 * Accessor and mutator for watchlist entries.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
20 * @file
21 * @ingroup Watchlist
24 /**
25 * Representation of a pair of user and title for watchlist entries.
27 * @ingroup Watchlist
29 class WatchedItem {
30 /** @var Title */
31 private $mTitle;
33 /** @var User */
34 private $mUser;
36 /** @var int */
37 private $mCheckRights;
39 /** @var bool */
40 private $loaded = false;
42 /** @var bool */
43 private $watched;
45 /** @var string */
46 private $timestamp;
48 /**
49 * Constant to specify that user rights 'editmywatchlist' and
50 * 'viewmywatchlist' should not be checked.
51 * @since 1.22
53 const IGNORE_USER_RIGHTS = 0;
55 /**
56 * Constant to specify that user rights 'editmywatchlist' and
57 * 'viewmywatchlist' should be checked.
58 * @since 1.22
60 const CHECK_USER_RIGHTS = 1;
62 /**
63 * Create a WatchedItem object with the given user and title
64 * @since 1.22 $checkRights parameter added
65 * @param User $user The user to use for (un)watching
66 * @param Title $title The title we're going to (un)watch
67 * @param int $checkRights Whether to check the 'viewmywatchlist' and 'editmywatchlist' rights.
68 * Pass either WatchedItem::IGNORE_USER_RIGHTS or WatchedItem::CHECK_USER_RIGHTS.
69 * @return WatchedItem
71 public static function fromUserTitle( $user, $title,
72 $checkRights = WatchedItem::CHECK_USER_RIGHTS
73 ) {
74 $wl = new WatchedItem;
75 $wl->mUser = $user;
76 $wl->mTitle = $title;
77 $wl->mCheckRights = $checkRights;
79 return $wl;
82 /**
83 * Title being watched
84 * @return Title
86 protected function getTitle() {
87 return $this->mTitle;
90 /**
91 * Helper to retrieve the title namespace
92 * @return int
94 protected function getTitleNs() {
95 return $this->getTitle()->getNamespace();
98 /**
99 * Helper to retrieve the title DBkey
100 * @return string
102 protected function getTitleDBkey() {
103 return $this->getTitle()->getDBkey();
107 * Helper to retrieve the user id
108 * @return int
110 protected function getUserId() {
111 return $this->mUser->getId();
115 * Return an array of conditions to select or update the appropriate database
116 * row.
118 * @return array
120 private function dbCond() {
121 return [
122 'wl_user' => $this->getUserId(),
123 'wl_namespace' => $this->getTitleNs(),
124 'wl_title' => $this->getTitleDBkey(),
129 * Load the object from the database
131 private function load() {
132 if ( $this->loaded ) {
133 return;
135 $this->loaded = true;
137 // Only loggedin user can have a watchlist
138 if ( $this->mUser->isAnon() ) {
139 $this->watched = false;
140 return;
143 // some pages cannot be watched
144 if ( !$this->getTitle()->isWatchable() ) {
145 $this->watched = false;
146 return;
149 # Pages and their talk pages are considered equivalent for watching;
150 # remember that talk namespaces are numbered as page namespace+1.
152 $dbr = wfGetDB( DB_SLAVE );
153 $row = $dbr->selectRow( 'watchlist', 'wl_notificationtimestamp',
154 $this->dbCond(), __METHOD__ );
156 if ( $row === false ) {
157 $this->watched = false;
158 } else {
159 $this->watched = true;
160 $this->timestamp = $row->wl_notificationtimestamp;
165 * Check permissions
166 * @param string $what 'viewmywatchlist' or 'editmywatchlist'
167 * @return bool
169 private function isAllowed( $what ) {
170 return !$this->mCheckRights || $this->mUser->isAllowed( $what );
174 * Is mTitle being watched by mUser?
175 * @return bool
177 public function isWatched() {
178 if ( !$this->isAllowed( 'viewmywatchlist' ) ) {
179 return false;
182 $this->load();
183 return $this->watched;
187 * Get the notification timestamp of this entry.
189 * @return bool|null|string False if the page is not watched, the value of
190 * the wl_notificationtimestamp field otherwise
192 public function getNotificationTimestamp() {
193 if ( !$this->isAllowed( 'viewmywatchlist' ) ) {
194 return false;
197 $this->load();
198 if ( $this->watched ) {
199 return $this->timestamp;
200 } else {
201 return false;
206 * Reset the notification timestamp of this entry
208 * @param bool $force Whether to force the write query to be executed even if the
209 * page is not watched or the notification timestamp is already NULL.
210 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
212 public function resetNotificationTimestamp(
213 $force = '', $oldid = 0
215 // Only loggedin user can have a watchlist
216 if ( wfReadOnly() || $this->mUser->isAnon() || !$this->isAllowed( 'editmywatchlist' ) ) {
217 return;
220 if ( $force != 'force' ) {
221 $this->load();
222 if ( !$this->watched || $this->timestamp === null ) {
223 return;
227 $title = $this->getTitle();
228 if ( !$oldid ) {
229 // No oldid given, assuming latest revision; clear the timestamp.
230 $notificationTimestamp = null;
231 } elseif ( !$title->getNextRevisionID( $oldid ) ) {
232 // Oldid given and is the latest revision for this title; clear the timestamp.
233 $notificationTimestamp = null;
234 } else {
235 // See if the version marked as read is more recent than the one we're viewing.
236 // Call load() if it wasn't called before due to $force.
237 $this->load();
239 if ( $this->timestamp === null ) {
240 // This can only happen if $force is enabled.
241 $notificationTimestamp = null;
242 } else {
243 // Oldid given and isn't the latest; update the timestamp.
244 // This will result in no further notification emails being sent!
245 $notificationTimestamp = Revision::getTimestampFromId( $title, $oldid );
246 // We need to go one second to the future because of various strict comparisons
247 // throughout the codebase
248 $ts = new MWTimestamp( $notificationTimestamp );
249 $ts->timestamp->add( new DateInterval( 'PT1S' ) );
250 $notificationTimestamp = $ts->getTimestamp( TS_MW );
252 if ( $notificationTimestamp < $this->timestamp ) {
253 if ( $force != 'force' ) {
254 return;
255 } else {
256 // This is a little silly…
257 $notificationTimestamp = $this->timestamp;
263 // If the page is watched by the user (or may be watched), update the timestamp
264 $job = new ActivityUpdateJob(
265 $title,
267 'type' => 'updateWatchlistNotification',
268 'userid' => $this->getUserId(),
269 'notifTime' => $notificationTimestamp,
270 'curTime' => time()
273 // Try to run this post-send
274 DeferredUpdates::addCallableUpdate( function() use ( $job ) {
275 $job->run();
276 } );
278 $this->timestamp = null;
282 * @param WatchedItem[] $items
283 * @return bool
285 public static function batchAddWatch( array $items ) {
287 if ( wfReadOnly() ) {
288 return false;
291 $rows = [];
292 foreach ( $items as $item ) {
293 // Only loggedin user can have a watchlist
294 if ( $item->mUser->isAnon() || !$item->isAllowed( 'editmywatchlist' ) ) {
295 continue;
297 $rows[] = [
298 'wl_user' => $item->getUserId(),
299 'wl_namespace' => MWNamespace::getSubject( $item->getTitleNs() ),
300 'wl_title' => $item->getTitleDBkey(),
301 'wl_notificationtimestamp' => null,
303 // Every single watched page needs now to be listed in watchlist;
304 // namespace:page and namespace_talk:page need separate entries:
305 $rows[] = [
306 'wl_user' => $item->getUserId(),
307 'wl_namespace' => MWNamespace::getTalk( $item->getTitleNs() ),
308 'wl_title' => $item->getTitleDBkey(),
309 'wl_notificationtimestamp' => null
311 $item->watched = true;
314 if ( !$rows ) {
315 return false;
318 $dbw = wfGetDB( DB_MASTER );
319 foreach ( array_chunk( $rows, 100 ) as $toInsert ) {
320 // Use INSERT IGNORE to avoid overwriting the notification timestamp
321 // if there's already an entry for this page
322 $dbw->insert( 'watchlist', $toInsert, __METHOD__, 'IGNORE' );
325 return true;
329 * Given a title and user (assumes the object is setup), add the watch to the database.
330 * @return bool
332 public function addWatch() {
333 return self::batchAddWatch( [ $this ] );
337 * Same as addWatch, only the opposite.
338 * @return bool
340 public function removeWatch() {
342 // Only loggedin user can have a watchlist
343 if ( wfReadOnly() || $this->mUser->isAnon() || !$this->isAllowed( 'editmywatchlist' ) ) {
344 return false;
347 $success = false;
348 $dbw = wfGetDB( DB_MASTER );
349 $dbw->delete( 'watchlist',
351 'wl_user' => $this->getUserId(),
352 'wl_namespace' => MWNamespace::getSubject( $this->getTitleNs() ),
353 'wl_title' => $this->getTitleDBkey(),
354 ], __METHOD__
356 if ( $dbw->affectedRows() ) {
357 $success = true;
360 # the following code compensates the new behavior, introduced by the
361 # enotif patch, that every single watched page needs now to be listed
362 # in watchlist namespace:page and namespace_talk:page had separate
363 # entries: clear them
364 $dbw->delete( 'watchlist',
366 'wl_user' => $this->getUserId(),
367 'wl_namespace' => MWNamespace::getTalk( $this->getTitleNs() ),
368 'wl_title' => $this->getTitleDBkey(),
369 ], __METHOD__
372 if ( $dbw->affectedRows() ) {
373 $success = true;
376 $this->watched = false;
378 return $success;
382 * @deprecated since 1.27. See WatchedItemStore::duplicateEntry
384 * @param Title $oldTitle
385 * @param Title $newTitle
387 public static function duplicateEntries( Title $oldTitle, Title $newTitle ) {
388 $store = WatchedItemStore::getDefaultInstance();
389 $store->duplicateEntry( $oldTitle->getSubjectPage(), $newTitle->getSubjectPage() );
390 $store->duplicateEntry( $oldTitle->getTalkPage(), $newTitle->getTalkPage() );