includes/WatchedItem.php

   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  * @ingroup Watchlist
  20  */
  21
  22 /**
  23  * Representation of a pair of user and title for watchlist entries.
  24  *
  25  * @author Tim Starling
  26  * @author Addshore
  27  *
  28  * @ingroup Watchlist
  29  */
  30 class WatchedItem {
  31
  32         /**
  33          * @deprecated since 1.27, see User::IGNORE_USER_RIGHTS
  34          */
  35         const IGNORE_USER_RIGHTS = User::IGNORE_USER_RIGHTS;
  36
  37         /**
  38          * @deprecated since 1.27, see User::CHECK_USER_RIGHTS
  39          */
  40         const CHECK_USER_RIGHTS = User::CHECK_USER_RIGHTS;
  41
  42         /**
  43          * @deprecated Internal class use only
  44          */
  45         const DEPRECATED_USAGE_TIMESTAMP = -100;
  46
  47         /**
  48          * @var bool
  49          * @deprecated Internal class use only
  50          */
  51         public $checkRights = User::CHECK_USER_RIGHTS;
  52
  53         /**
  54          * @var Title
  55          * @deprecated Internal class use only
  56          */
  57         private $title;
  58
  59         /**
  60          * @var LinkTarget
  61          */
  62         private $linkTarget;
  63
  64         /**
  65          * @var User
  66          */
  67         private $user;
  68
  69         /**
  70          * @var null|string the value of the wl_notificationtimestamp field
  71          */
  72         private $notificationTimestamp;
  73
  74         /**
  75          * @param User $user
  76          * @param LinkTarget $linkTarget
  77          * @param null|string $notificationTimestamp the value of the wl_notificationtimestamp field
  78          * @param bool|null $checkRights DO NOT USE - used internally for backward compatibility
  79          */
  80         public function __construct(
  81                 User $user,
  82                 LinkTarget $linkTarget,
  83                 $notificationTimestamp,
  84                 $checkRights = null
  85         ) {
  86                 $this->user = $user;
  87                 $this->linkTarget = $linkTarget;
  88                 $this->notificationTimestamp = $notificationTimestamp;
  89                 if ( $checkRights !== null ) {
  90                         $this->checkRights = $checkRights;
  91                 }
  92         }
  93
  94         /**
  95          * @return User
  96          */
  97         public function getUser() {
  98                 return $this->user;
  99         }
 100
 101         /**
 102          * @return LinkTarget
 103          */
 104         public function getLinkTarget() {
 105                 return $this->linkTarget;
 106         }
 107
 108         /**
 109          * Get the notification timestamp of this entry.
 110          *
 111          * @return bool|null|string
 112          */
 113         public function getNotificationTimestamp() {
 114                 // Back compat for objects constructed using self::fromUserTitle
 115                 if ( $this->notificationTimestamp === self::DEPRECATED_USAGE_TIMESTAMP ) {
 116                         // wfDeprecated( __METHOD__, '1.27' );
 117                         if ( $this->checkRights && !$this->user->isAllowed( 'viewmywatchlist' ) ) {
 118                                 return false;
 119                         }
 120                         $item = WatchedItemStore::getDefaultInstance()
 121                                 ->loadWatchedItem( $this->user, $this->linkTarget );
 122                         if ( $item ) {
 123                                 $this->notificationTimestamp = $item->getNotificationTimestamp();
 124                         } else {
 125                                 $this->notificationTimestamp = false;
 126                         }
 127                 }
 128                 return $this->notificationTimestamp;
 129         }
 130
 131         /**
 132          * Back compat pre 1.27 with the WatchedItemStore introduction
 133          * @todo remove in 1.28/9
 134          * -------------------------------------------------
 135          */
 136
 137         /**
 138          * @return Title
 139          * @deprecated Internal class use only
 140          */
 141         public function getTitle() {
 142                 if ( !$this->title ) {
 143                         $this->title = Title::newFromLinkTarget( $this->linkTarget );
 144                 }
 145                 return $this->title;
 146         }
 147
 148         /**
 149          * @deprecated since 1.27 Use the constructor, WatchedItemStore::getWatchedItem()
 150          *             or WatchedItemStore::loadWatchedItem()
 151          */
 152         public static function fromUserTitle( $user, $title, $checkRights = User::CHECK_USER_RIGHTS ) {
 153                 // wfDeprecated( __METHOD__, '1.27' );
 154                 return new self( $user, $title, self::DEPRECATED_USAGE_TIMESTAMP, (bool)$checkRights );
 155         }
 156
 157         /**
 158          * @deprecated since 1.27 Use WatchedItemStore::resetNotificationTimestamp()
 159          */
 160         public function resetNotificationTimestamp( $force = '', $oldid = 0 ) {
 161                 // wfDeprecated( __METHOD__, '1.27' );
 162                 if ( $this->checkRights && !$this->user->isAllowed( 'editmywatchlist' ) ) {
 163                         return;
 164                 }
 165                 WatchedItemStore::getDefaultInstance()->resetNotificationTimestamp(
 166                         $this->user,
 167                         $this->getTitle(),
 168                         $force,
 169                         $oldid
 170                 );
 171         }
 172
 173         /**
 174          * @deprecated since 1.27 Use WatchedItemStore::addWatchBatch()
 175          */
 176         public static function batchAddWatch( array $items ) {
 177                 // wfDeprecated( __METHOD__, '1.27' );
 178                 if ( !$items ) {
 179                         return false;
 180                 }
 181
 182                 $targets = [];
 183                 $users = [];
 184                 /** @var WatchedItem $watchedItem */
 185                 foreach ( $items as $watchedItem ) {
 186                         $user = $watchedItem->getUser();
 187                         if ( $watchedItem->checkRights && !$user->isAllowed( 'editmywatchlist' ) ) {
 188                                 continue;
 189                         }
 190                         $userId = $user->getId();
 191                         $users[$userId] = $user;
 192                         $targets[$userId][] = $watchedItem->getTitle()->getSubjectPage();
 193                         $targets[$userId][] = $watchedItem->getTitle()->getTalkPage();
 194                 }
 195
 196                 $store = WatchedItemStore::getDefaultInstance();
 197                 $success = true;
 198                 foreach ( $users as $userId => $user ) {
 199                         $success &= $store->addWatchBatchForUser( $user, $targets[$userId] );
 200                 }
 201
 202                 return $success;
 203         }
 204
 205         /**
 206          * @deprecated since 1.27 Use User::addWatch()
 207          * @return bool
 208          */
 209         public function addWatch() {
 210                 // wfDeprecated( __METHOD__, '1.27' );
 211                 $this->user->addWatch( $this->getTitle(), $this->checkRights );
 212                 return true;
 213         }
 214
 215         /**
 216          * @deprecated since 1.27 Use User::removeWatch()
 217          * @return bool
 218          */
 219         public function removeWatch() {
 220                 // wfDeprecated( __METHOD__, '1.27' );
 221                 if ( $this->checkRights && !$this->user->isAllowed( 'editmywatchlist' ) ) {
 222                         return false;
 223                 }
 224                 $this->user->removeWatch( $this->getTitle(), $this->checkRights );
 225                 return true;
 226         }
 227
 228         /**
 229          * @deprecated since 1.27 Use User::isWatched()
 230          * @return bool
 231          */
 232         public function isWatched() {
 233                 // wfDeprecated( __METHOD__, '1.27' );
 234                 return $this->user->isWatched( $this->getTitle(), $this->checkRights );
 235         }
 236
 237         /**
 238          * @deprecated since 1.27 Use WatchedItemStore::duplicateAllAssociatedEntries()
 239          */
 240         public static function duplicateEntries( Title $oldTitle, Title $newTitle ) {
 241                 // wfDeprecated( __METHOD__, '1.27' );
 242                 $store = WatchedItemStore::getDefaultInstance();
 243                 $store->duplicateAllAssociatedEntries( $oldTitle, $newTitle );
 244         }
 245
 246 }