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
25 * Representation of a pair of user and title for watchlist entries.
31 * Constant to specify that user rights 'editmywatchlist' and
32 * 'viewmywatchlist' should not be checked.
35 const IGNORE_USER_RIGHTS
= 0;
38 * Constant to specify that user rights 'editmywatchlist' and
39 * 'viewmywatchlist' should be checked.
42 const CHECK_USER_RIGHTS
= 1;
54 private $loaded = false;
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.
71 public static function fromUserTitle( $user, $title,
72 $checkRights = WatchedItem
::CHECK_USER_RIGHTS
74 $wl = new WatchedItem
;
77 $wl->mCheckRights
= $checkRights;
86 protected function getTitle() {
91 * Helper to retrieve the title namespace
94 protected function getTitleNs() {
95 return $this->getTitle()->getNamespace();
99 * Helper to retrieve the title DBkey
102 protected function getTitleDBkey() {
103 return $this->getTitle()->getDBkey();
107 * Helper to retrieve the user id
110 protected function getUserId() {
111 return $this->mUser
->getId();
115 * Return an array of conditions to select or update the appropriate database
120 private function dbCond() {
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
) {
135 $this->loaded
= true;
137 // Only loggedin user can have a watchlist
138 if ( $this->mUser
->isAnon() ) {
139 $this->watched
= false;
143 // some pages cannot be watched
144 if ( !$this->getTitle()->isWatchable() ) {
145 $this->watched
= false;
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;
159 $this->watched
= true;
160 $this->timestamp
= $row->wl_notificationtimestamp
;
166 * @param string $what 'viewmywatchlist' or 'editmywatchlist'
169 private function isAllowed( $what ) {
170 return !$this->mCheckRights ||
$this->mUser
->isAllowed( $what );
174 * Is mTitle being watched by mUser?
177 public function isWatched() {
178 if ( !$this->isAllowed( 'viewmywatchlist' ) ) {
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' ) ) {
198 if ( $this->watched
) {
199 return $this->timestamp
;
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( $force = '', $oldid = 0 ) {
213 // Only loggedin user can have a watchlist
214 if ( wfReadOnly() ||
$this->mUser
->isAnon() ||
!$this->isAllowed( 'editmywatchlist' ) ) {
218 if ( $force != 'force' ) {
220 if ( !$this->watched ||
$this->timestamp
=== null ) {
225 $title = $this->getTitle();
227 // No oldid given, assuming latest revision; clear the timestamp.
228 $notificationTimestamp = null;
229 } elseif ( !$title->getNextRevisionID( $oldid ) ) {
230 // Oldid given and is the latest revision for this title; clear the timestamp.
231 $notificationTimestamp = null;
233 // See if the version marked as read is more recent than the one we're viewing.
234 // Call load() if it wasn't called before due to $force.
237 if ( $this->timestamp
=== null ) {
238 // This can only happen if $force is enabled.
239 $notificationTimestamp = null;
241 // Oldid given and isn't the latest; update the timestamp.
242 // This will result in no further notification emails being sent!
243 $notificationTimestamp = Revision
::getTimestampFromId( $title, $oldid );
244 // We need to go one second to the future because of various strict comparisons
245 // throughout the codebase
246 $ts = new MWTimestamp( $notificationTimestamp );
247 $ts->timestamp
->add( new DateInterval( 'PT1S' ) );
248 $notificationTimestamp = $ts->getTimestamp( TS_MW
);
250 if ( $notificationTimestamp < $this->timestamp
) {
251 if ( $force != 'force' ) {
254 // This is a little silly…
255 $notificationTimestamp = $this->timestamp
;
261 // If the page is watched by the user (or may be watched), update the timestamp on any
263 $dbw = wfGetDB( DB_MASTER
);
264 $dbw->update( 'watchlist', array( 'wl_notificationtimestamp' => $notificationTimestamp ),
265 $this->dbCond(), __METHOD__
);
266 $this->timestamp
= null;
270 * @param WatchedItem[] $items
273 public static function batchAddWatch( array $items ) {
275 if ( wfReadOnly() ) {
280 foreach ( $items as $item ) {
281 // Only loggedin user can have a watchlist
282 if ( $item->mUser
->isAnon() ||
!$item->isAllowed( 'editmywatchlist' ) ) {
286 'wl_user' => $item->getUserId(),
287 'wl_namespace' => MWNamespace
::getSubject( $item->getTitleNs() ),
288 'wl_title' => $item->getTitleDBkey(),
289 'wl_notificationtimestamp' => null,
291 // Every single watched page needs now to be listed in watchlist;
292 // namespace:page and namespace_talk:page need separate entries:
294 'wl_user' => $item->getUserId(),
295 'wl_namespace' => MWNamespace
::getTalk( $item->getTitleNs() ),
296 'wl_title' => $item->getTitleDBkey(),
297 'wl_notificationtimestamp' => null
299 $item->watched
= true;
306 $dbw = wfGetDB( DB_MASTER
);
307 foreach ( array_chunk( $rows, 100 ) as $toInsert ) {
308 // Use INSERT IGNORE to avoid overwriting the notification timestamp
309 // if there's already an entry for this page
310 $dbw->insert( 'watchlist', $toInsert, __METHOD__
, 'IGNORE' );
317 * Given a title and user (assumes the object is setup), add the watch to the database.
320 public function addWatch() {
321 return self
::batchAddWatch( array( $this ) );
325 * Same as addWatch, only the opposite.
328 public function removeWatch() {
330 // Only loggedin user can have a watchlist
331 if ( wfReadOnly() ||
$this->mUser
->isAnon() ||
!$this->isAllowed( 'editmywatchlist' ) ) {
336 $dbw = wfGetDB( DB_MASTER
);
337 $dbw->delete( 'watchlist',
339 'wl_user' => $this->getUserId(),
340 'wl_namespace' => MWNamespace
::getSubject( $this->getTitleNs() ),
341 'wl_title' => $this->getTitleDBkey(),
344 if ( $dbw->affectedRows() ) {
348 # the following code compensates the new behavior, introduced by the
349 # enotif patch, that every single watched page needs now to be listed
350 # in watchlist namespace:page and namespace_talk:page had separate
351 # entries: clear them
352 $dbw->delete( 'watchlist',
354 'wl_user' => $this->getUserId(),
355 'wl_namespace' => MWNamespace
::getTalk( $this->getTitleNs() ),
356 'wl_title' => $this->getTitleDBkey(),
360 if ( $dbw->affectedRows() ) {
364 $this->watched
= false;
370 * Check if the given title already is watched by the user, and if so
371 * add watches on a new title. To be used for page renames and such.
373 * @param Title $ot Page title to duplicate entries from, if present
374 * @param Title $nt Page title to add watches on
376 public static function duplicateEntries( $ot, $nt ) {
377 WatchedItem
::doDuplicateEntries( $ot->getSubjectPage(), $nt->getSubjectPage() );
378 WatchedItem
::doDuplicateEntries( $ot->getTalkPage(), $nt->getTalkPage() );
382 * Handle duplicate entries. Backend for duplicateEntries().
389 private static function doDuplicateEntries( $ot, $nt ) {
390 $oldnamespace = $ot->getNamespace();
391 $newnamespace = $nt->getNamespace();
392 $oldtitle = $ot->getDBkey();
393 $newtitle = $nt->getDBkey();
395 $dbw = wfGetDB( DB_MASTER
);
396 $res = $dbw->select( 'watchlist',
397 array( 'wl_user', 'wl_notificationtimestamp' ),
398 array( 'wl_namespace' => $oldnamespace, 'wl_title' => $oldtitle ),
399 __METHOD__
, 'FOR UPDATE'
401 # Construct array to replace into the watchlist
403 foreach ( $res as $s ) {
405 'wl_user' => $s->wl_user
,
406 'wl_namespace' => $newnamespace,
407 'wl_title' => $newtitle,
408 'wl_notificationtimestamp' => $s->wl_notificationtimestamp
,
412 if ( empty( $values ) ) {
418 # Note that multi-row replace is very efficient for MySQL but may be inefficient for
419 # some other DBMSes, mostly due to poor simulation by us
422 array( array( 'wl_user', 'wl_namespace', 'wl_title' ) ),