1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Watchlist
*/
/**
* Representation of a pair of user and title for watchlist entries.
*
* @author Tim Starling
* @author Addshore
*
* @ingroup Watchlist
*/
class WatchedItem {
/**
* @deprecated since 1.27, see User::IGNORE_USER_RIGHTS
*/
const IGNORE_USER_RIGHTS = User::IGNORE_USER_RIGHTS;
/**
* @deprecated since 1.27, see User::CHECK_USER_RIGHTS
*/
const CHECK_USER_RIGHTS = User::CHECK_USER_RIGHTS;
/**
* @deprecated Internal class use only
*/
const DEPRECATED_USAGE_TIMESTAMP = -100;
/**
* @var bool
* @deprecated Internal class use only
*/
public $checkRights = User::CHECK_USER_RIGHTS;
/**
* @var Title
* @deprecated Internal class use only
*/
private $title;
/**
* @var LinkTarget
*/
private $linkTarget;
/**
* @var User
*/
private $user;
/**
* @var null|string the value of the wl_notificationtimestamp field
*/
private $notificationTimestamp;
/**
* @param User $user
* @param LinkTarget $linkTarget
* @param null|string $notificationTimestamp the value of the wl_notificationtimestamp field
* @param bool|null $checkRights DO NOT USE - used internally for backward compatibility
*/
public function __construct(
User $user,
LinkTarget $linkTarget,
$notificationTimestamp,
$checkRights = null
) {
$this->user = $user;
$this->linkTarget = $linkTarget;
$this->notificationTimestamp = $notificationTimestamp;
if ( $checkRights !== null ) {
$this->checkRights = $checkRights;
}
}
/**
* @return User
*/
public function getUser() {
return $this->user;
}
/**
* @return LinkTarget
*/
public function getLinkTarget() {
return $this->linkTarget;
}
/**
* Get the notification timestamp of this entry.
*
* @return bool|null|string
*/
public function getNotificationTimestamp() {
// Back compat for objects constructed using self::fromUserTitle
if ( $this->notificationTimestamp === self::DEPRECATED_USAGE_TIMESTAMP ) {
// wfDeprecated( __METHOD__, '1.27' );
if ( $this->checkRights && !$this->user->isAllowed( 'viewmywatchlist' ) ) {
return false;
}
$item = WatchedItemStore::getDefaultInstance()
->loadWatchedItem( $this->user, $this->linkTarget );
if ( $item ) {
$this->notificationTimestamp = $item->getNotificationTimestamp();
} else {
$this->notificationTimestamp = false;
}
}
return $this->notificationTimestamp;
}
/**
* Back compat pre 1.27 with the WatchedItemStore introduction
* @todo remove in 1.28/9
* -------------------------------------------------
*/
/**
* @return Title
* @deprecated Internal class use only
*/
public function getTitle() {
if ( !$this->title ) {
if ( $this->linkTarget instanceof Title ) {
$this->title = $this->linkTarget;
} else {
$this->title = Title::newFromLinkTarget( $this->linkTarget );
}
}
return $this->title;
}
/**
* @deprecated since 1.27 Use the constructor, WatchedItemStore::getWatchedItem()
* or WatchedItemStore::loadWatchedItem()
*/
public static function fromUserTitle( $user, $title, $checkRights = User::CHECK_USER_RIGHTS ) {
// wfDeprecated( __METHOD__, '1.27' );
return new self( $user, $title, self::DEPRECATED_USAGE_TIMESTAMP, (bool)$checkRights );
}
/**
* @deprecated since 1.27 Use WatchedItemStore::resetNotificationTimestamp()
*/
public function resetNotificationTimestamp( $force = '', $oldid = 0 ) {
// wfDeprecated( __METHOD__, '1.27' );
if ( $this->checkRights && !$this->user->isAllowed( 'editmywatchlist' ) ) {
return;
}
WatchedItemStore::getDefaultInstance()->resetNotificationTimestamp(
$this->user,
$this->getTitle(),
$force,
$oldid
);
}
/**
* @deprecated since 1.27 Use WatchedItemStore::addWatchBatch()
*/
public static function batchAddWatch( array $items ) {
// wfDeprecated( __METHOD__, '1.27' );
$userTargetCombinations = [];
/** @var WatchedItem $watchedItem */
foreach ( $items as $watchedItem ) {
if ( $watchedItem->checkRights && !$watchedItem->getUser()->isAllowed( 'editmywatchlist' ) ) {
continue;
}
$userTargetCombinations[] = [
$watchedItem->getUser(),
$watchedItem->getTitle()->getSubjectPage()
];
$userTargetCombinations[] = [
$watchedItem->getUser(),
$watchedItem->getTitle()->getTalkPage()
];
}
$store = WatchedItemStore::getDefaultInstance();
return $store->addWatchBatch( $userTargetCombinations );
}
/**
* @deprecated since 1.27 Use User::addWatch()
* @return bool
*/
public function addWatch() {
// wfDeprecated( __METHOD__, '1.27' );
$this->user->addWatch( $this->getTitle(), $this->checkRights );
return true;
}
/**
* @deprecated since 1.27 Use User::removeWatch()
* @return bool
*/
public function removeWatch() {
// wfDeprecated( __METHOD__, '1.27' );
if ( $this->checkRights && !$this->user->isAllowed( 'editmywatchlist' ) ) {
return false;
}
$this->user->removeWatch( $this->getTitle(), $this->checkRights );
return true;
}
/**
* @deprecated since 1.27 Use User::isWatched()
* @return bool
*/
public function isWatched() {
// wfDeprecated( __METHOD__, '1.27' );
return $this->user->isWatched( $this->getTitle(), $this->checkRights );
}
/**
* @deprecated since 1.27 Use WatchedItemStore::duplicateAllAssociatedEntries()
*/
public static function duplicateEntries( Title $oldTitle, Title $newTitle ) {
// wfDeprecated( __METHOD__, '1.27' );
$store = WatchedItemStore::getDefaultInstance();
$store->duplicateAllAssociatedEntries( $oldTitle, $newTitle );
}
}
|
