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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
|
( function () {
/**
* Notifications list data structure.
*
* This contains the list of mw.echo.dm.NotificationItem items
* in the specified order and reflects when the list has changed.
*
* @class
* @extends mw.echo.dm.SortedList
*
* @constructor
* @param {Object} config Configuration options
* @cfg {Function} [sortingCallback] A function defining the sorting order
* of items in this list.
* @cfg {string} [title] An optional title for this notifications list
* @cfg {string} [name='local'] Symbolic name for this list
* @cfg {string} [source='local'] Symbolic name for the source of this list.
* This is used mainly for recognizing where API actions should be by the
* controller.
* @cfg {string} [sourceURL] The URL for the article base of the remote
* group or wiki
* @cfg {string} [timestamp=0] A timestamp representing the latest item in
* the list.
*/
mw.echo.dm.NotificationsList = function MwEchoDmNotificationsList( config ) {
config = config || {};
// Parent constructor
mw.echo.dm.NotificationsList.super.call( this );
this.name = config.name || 'local';
this.source = config.source || 'local';
this.sourceURL = config.sourceURL || '';
this.title = config.title || '';
this.fallbackTimestamp = config.timestamp || 0;
// Sorting callback
this.setSortingCallback( config.sortingCallback || function ( a, b ) {
if ( !a.isRead() && b.isRead() ) {
return -1; // Unread items are always above read items
} else if ( a.isRead() && !b.isRead() ) {
return 1;
} else if ( !a.isForeign() && b.isForeign() ) {
return -1;
} else if ( a.isForeign() && !b.isForeign() ) {
return 1;
}
// Reverse sorting
if ( b.getTimestamp() < a.getTimestamp() ) {
return -1;
} else if ( b.getTimestamp() > a.getTimestamp() ) {
return 1;
}
// Fallback on IDs
return b.getId() - a.getId();
} );
// Events
this.aggregate( { update: 'itemUpdate' } );
};
/* Initialization */
OO.inheritClass( mw.echo.dm.NotificationsList, mw.echo.dm.SortedList );
/* Events */
/**
* @event update
* @param {mw.echo.dm.NotificationItem[]} items Current items in the list
*
* The list has been updated
*/
/**
* @event itemUpdate
* @param {mw.echo.dm.NotificationItem} item Item that has changed
*
* An item in the list has been updated
*/
/**
* @event discard
* @param {mw.echo.dm.NotificationItem} item Item that was discarded
*
* An item was discarded
*/
/* Methods */
/**
* Set the items in this list
*
* @param {mw.echo.dm.NotificationItem[]} items Items to insert into the list
* @fires update
*/
mw.echo.dm.NotificationsList.prototype.setItems = function ( items ) {
this.clearItems();
this.addItems( items );
this.emit( 'update', this.getItems() );
};
/**
* Discard items from the list.
*
* This is a more precise operation than 'removeItems' because when
* the list is resorting the position of a single item, it removes
* the item and reinserts it, which makes the 'remove' event unhelpful
* to differentiate between actually discarding items, and only
* temporarily moving them.
*
* @param {mw.echo.dm.NotificationItem[]} items Items to insert into the list
*/
mw.echo.dm.NotificationsList.prototype.discardItems = function ( items ) {
this.removeItems( items );
this.emit( 'discard', items );
};
/**
* Get an array of all items' IDs.
*
* @return {number[]} Item IDs
*/
mw.echo.dm.NotificationsList.prototype.getAllItemIds = function () {
var i,
idArray = [],
items = this.getItems();
for ( i = 0; i < items.length; i++ ) {
idArray.push( items[ i ].getId() );
}
return idArray;
};
/**
* Get an array of all items' IDs for a given type
*
* @param {string} type Notification type
* @return {number[]} Item IDs
*/
mw.echo.dm.NotificationsList.prototype.getAllItemIdsByType = function ( type ) {
var i,
idArray = [],
items = this.getItems();
for ( i = 0; i < items.length; i++ ) {
if ( items[ i ].getType() === type ) {
idArray.push( items[ i ].getId() );
}
}
return idArray;
};
/**
* Get the title associated with this list.
*
* @return {string} List title
*/
mw.echo.dm.NotificationsList.prototype.getTitle = function () {
return this.title;
};
/**
* Get the name associated with this list.
*
* @return {string} List name
*/
mw.echo.dm.NotificationsList.prototype.getName = function () {
return this.name;
};
/**
* Get the source associated with this list.
*
* @return {string} List source
*/
mw.echo.dm.NotificationsList.prototype.getSource = function () {
return this.source;
};
/**
* Get the source article url associated with this list.
*
* @return {string} List source article url
*/
mw.echo.dm.NotificationsList.prototype.getSourceURL = function () {
return this.sourceURL;
};
/**
* Get the timestamp of the list by taking the latest notification
* timestamp.
*
* @return {string} Latest timestamp
*/
mw.echo.dm.NotificationsList.prototype.getTimestamp = function () {
var items = this.getItems();
return (
// In the cases where we want a single timestamp for a
// group, the group is usually all unread, which makes
// the first item its newest
items.length > 0 ?
items[ 0 ].getTimestamp() :
this.fallbackTimestamp
);
};
/**
* Find all items that match the given IDs.
*
* @param {number[]} ids An array of item IDs
* @return {mw.echo.dm.NotificationItem[]} An array of matching items
*/
mw.echo.dm.NotificationsList.prototype.findByIds = function ( ids ) {
return this.getItems().filter( function ( item ) {
return ids.indexOf( item.getId() ) !== -1;
} );
};
/**
* A general method to get the number of notifications in this list
*
* @return {number} Item count
*/
mw.echo.dm.NotificationsList.prototype.getCount = function () {
return this.getItemCount();
};
/**
* Check if there are unseen items in this list
*
* @return {boolean} There are unseen items in the list
*/
mw.echo.dm.NotificationsList.prototype.hasUnseen = function () {
var isItemUnseen = function ( item ) {
return !item.isSeen();
},
items = this.getItems();
return !!items.some( isItemUnseen );
};
/**
* Set all notifications to seen
*
* @param {string} timestamp New seen timestamp
*/
mw.echo.dm.NotificationsList.prototype.updateSeenState = function ( timestamp ) {
this.getItems().forEach( function ( notification ) {
notification.toggleSeen(
notification.isRead() || notification.getTimestamp() < timestamp
);
} );
};
/**
* @inheritdoc
*/
mw.echo.dm.NotificationsList.prototype.isGroup = function () {
return false;
};
mw.echo.dm.NotificationsList.prototype.isForeign = function () {
return this.getSource() !== 'local';
};
}() );
|