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
243
244
245
246
247
248
249
250
251
252
253
254
255
|
<?php
/**
* Caches the result of EchoUnreadWikis::getUnreadCounts() and interprets the results in various useful ways.
*
* If the user has disabled cross-wiki notifications in their preferences
* (see {@see EchoForeignNotifications::isEnabledByUser}), this class
* won't do anything and will behave as if the user has no foreign notifications. For example, getCount() will
* return 0. If you need to get foreign notification information for a user even though they may not have
* enabled the preference, set $forceEnable=true in the constructor.
*/
class EchoForeignNotifications {
/**
* @var User
*/
protected $user;
/**
* @var bool
*/
protected $enabled = false;
/**
* @var int[] [(str) section => (int) count, ...]
*/
protected $counts = [ EchoAttributeManager::ALERT => 0, EchoAttributeManager::MESSAGE => 0 ];
/**
* @var array[] [(str) section => (string[]) wikis, ...]
*/
protected $wikis = [ EchoAttributeManager::ALERT => [], EchoAttributeManager::MESSAGE => [] ];
/**
* @var array [(str) section => (MWTimestamp) timestamp, ...]
*/
protected $timestamps = [ EchoAttributeManager::ALERT => false, EchoAttributeManager::MESSAGE => false ];
/**
* @var array[] [(str) wiki => [ (str) section => (MWTimestamp) timestamp, ...], ...]
*/
protected $wikiTimestamps = [];
/**
* @var bool
*/
protected $populated = false;
/**
* @param User $user
* @param bool $forceEnable Ignore the user's preferences and act as if they've enabled cross-wiki notifications
*/
public function __construct( User $user, $forceEnable = false ) {
$this->user = $user;
$this->enabled = $forceEnable || $this->isEnabledByUser();
}
/**
* Whether the user has enabled cross-wiki notifications.
* @return bool
*/
public function isEnabledByUser() {
return (bool)$this->user->getOption( 'echo-cross-wiki-notifications' );
}
/**
* @param string $section Name of section
* @return int
*/
public function getCount( $section = EchoAttributeManager::ALL ) {
$this->populate();
if ( $section === EchoAttributeManager::ALL ) {
$count = array_sum( $this->counts );
} else {
$count = $this->counts[$section] ?? 0;
}
return MWEchoNotifUser::capNotificationCount( $count );
}
/**
* @param string $section Name of section
* @return MWTimestamp|false
*/
public function getTimestamp( $section = EchoAttributeManager::ALL ) {
$this->populate();
if ( $section === EchoAttributeManager::ALL ) {
$max = false;
/** @var MWTimestamp $timestamp */
foreach ( $this->timestamps as $timestamp ) {
// $timestamp < $max = invert 0
// $timestamp > $max = invert 1
if ( $timestamp !== false && ( $max === false || $timestamp->diff( $max )->invert === 1 ) ) {
$max = $timestamp;
}
}
return $max;
}
return $this->timestamps[$section] ?? false;
}
/**
* @param string $section Name of section
* @return string[]
*/
public function getWikis( $section = EchoAttributeManager::ALL ) {
$this->populate();
if ( $section === EchoAttributeManager::ALL ) {
$all = [];
foreach ( $this->wikis as $wikis ) {
$all = array_merge( $all, $wikis );
}
return array_unique( $all );
}
return $this->wikis[$section] ?? [];
}
public function getWikiTimestamp( $wiki, $section = EchoAttributeManager::ALL ) {
$this->populate();
if ( !isset( $this->wikiTimestamps[$wiki] ) ) {
return false;
}
if ( $section === EchoAttributeManager::ALL ) {
$max = false;
foreach ( $this->wikiTimestamps[$wiki] as $section => $ts ) {
// $ts < $max = invert 0
// $ts > $max = invert 1
if ( $max === false || $ts->diff( $max )->invert === 1 ) {
$max = $ts;
}
}
return $max;
}
return $this->wikiTimestamps[$wiki][$section] ?? false;
}
protected function populate() {
if ( $this->populated ) {
return;
}
if ( !$this->enabled ) {
return;
}
$unreadWikis = EchoUnreadWikis::newFromUser( $this->user );
if ( !$unreadWikis ) {
return;
}
$unreadCounts = $unreadWikis->getUnreadCounts();
if ( !$unreadCounts ) {
return;
}
foreach ( $unreadCounts as $wiki => $sections ) {
// exclude current wiki
if ( $wiki === wfWikiID() ) {
continue;
}
foreach ( $sections as $section => $data ) {
if ( $data['count'] > 0 ) {
$this->counts[$section] += $data['count'];
$this->wikis[$section][] = $wiki;
$timestamp = new MWTimestamp( $data['ts'] );
$this->wikiTimestamps[$wiki][$section] = $timestamp;
// We need $this->timestamp[$section] to be the max timestamp
// across all wikis.
// $timestamp < $this->timestamps[$section] = invert 0
// $timestamp > $this->timestamps[$section] = invert 1
if (
$this->timestamps[$section] === false ||
$timestamp->diff( $this->timestamps[$section] )->invert === 1
) {
$this->timestamps[$section] = new MWTimestamp( $data['ts'] );
}
}
}
}
$this->populated = true;
}
/**
* @param string[] $wikis
* @return array[] [(string) wiki => (array) data]
*/
public static function getApiEndpoints( array $wikis ) {
global $wgConf;
$wgConf->loadFullData();
$data = [];
foreach ( $wikis as $wiki ) {
$siteFromDB = $wgConf->siteFromDB( $wiki );
list( $major, $minor ) = $siteFromDB;
$server = $wgConf->get( 'wgServer', $wiki, $major, [ 'lang' => $minor, 'site' => $major ] );
$scriptPath = $wgConf->get( 'wgScriptPath', $wiki, $major, [ 'lang' => $minor, 'site' => $major ] );
$articlePath = $wgConf->get( 'wgArticlePath', $wiki, $major, [ 'lang' => $minor, 'site' => $major ] );
$data[$wiki] = [
'title' => static::getWikiTitle( $wiki, $siteFromDB ),
'url' => wfExpandUrl( $server . $scriptPath . '/api.php', PROTO_INTERNAL ),
// We need this to link to Special:Notifications page
'base' => wfExpandUrl( $server . $articlePath, PROTO_INTERNAL ),
];
}
return $data;
}
/**
* @param string $wikiId
* @param array|null $siteFromDB $wgConf->siteFromDB( $wikiId ) result
* @return mixed|string
*/
protected static function getWikiTitle( $wikiId, array $siteFromDB = null ) {
global $wgConf, $wgLang;
$msg = wfMessage( 'project-localized-name-' . $wikiId );
// check if WikimediaMessages localized project names are available
if ( $msg->exists() ) {
return $msg->text();
} else {
// don't fetch $site, $langCode if known already
if ( $siteFromDB === null ) {
$siteFromDB = $wgConf->siteFromDB( $wikiId );
}
list( $site, $langCode ) = $siteFromDB;
// try to fetch site name for this specific wiki, or fallback to the
// general project's sitename if there is no override
$wikiName = $wgConf->get( 'wgSitename', $wikiId ) ?: $wgConf->get( 'wgSitename', $site );
$langName = Language::fetchLanguageName( $langCode, $wgLang->getCode() );
if ( !$langName ) {
// if we can't find a language name (in language-agnostic
// project like mediawikiwiki), including the language name
// doesn't make much sense
return $wikiName;
}
// ... or use generic fallback
return wfMessage( 'echo-foreign-wiki-lang', $wikiName, $langName )->text();
}
}
}
|