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
|
( function ( mw, $ ) {
/**
* Notifications list widget.
* All of its items must be of the mw.echo.ui.NotificationItem type.
*
* @class
* @extends mw.echo.ui.SortedListWidget
*
* @constructor
* @param {mw.echo.Controller} controller Echo notifications controller
* @param {mw.echo.dm.ModelManager} manager Model manager
* @param {Object} [config] Configuration object
* marked as read when they are seen.
* @cfg {string} [timestamp=0] A timestamp representing the latest item in
* the list.
* @cfg {jQuery} [$overlay] A jQuery element functioning as an overlay
* for popups.
*/
mw.echo.ui.NotificationsListWidget = function MwEchoUiNotificationsListWidget( controller, manager, config ) {
config = config || {};
// Parent constructor
mw.echo.ui.NotificationsListWidget.super.call(
this,
// Sorting callback
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();
},
config
);
// Initialize models
this.controller = controller;
this.manager = manager;
this.models = {};
// Properties
this.$overlay = config.$overlay || this.$element;
this.timestamp = config.timestamp || 0;
// Dummy 'loading' option widget
this.loadingOptionWidget = new mw.echo.ui.PlaceholderItemWidget();
this.resetLoadingOption();
this.manager.connect( this, {
update: 'resetDataFromModel',
discard: 'onModelManagerDiscard'
} );
this.$element
.addClass( 'mw-echo-ui-notificationsListWidget' );
};
/* Initialization */
OO.inheritClass( mw.echo.ui.NotificationsListWidget, mw.echo.ui.SortedListWidget );
/* Events */
/**
* @event modified
*
* The content of this list has changed.
* This event is to state that not only has the content changed
* but the actual DOM has been manipulated.
*/
/* Methods */
mw.echo.ui.NotificationsListWidget.prototype.onModelManagerDiscard = function ( modelName ) {
var i,
items = this.getItems();
// For the moment, this is only relevant for xwiki bundles.
// Local single items will not get their entire model removed, but
// local bundles may - when that happens, the condition below should
// also deal with local bundles and removing them specifically
if ( modelName === 'xwiki' ) {
for ( i = 0; i < items.length; i++ ) {
if ( items[ i ] instanceof mw.echo.ui.CrossWikiNotificationItemWidget ) {
this.removeItems( [ items[ i ] ] );
this.checkForEmptyNotificationsList();
return;
}
}
}
this.emit( 'modified' );
};
/**
* Respond to model manager update event.
* This event means we are repopulating the entire list and the
* associated models within it.
*
* @param {Object} models Object of new models to populate the
* list.
* @fires modified
*/
mw.echo.ui.NotificationsListWidget.prototype.resetDataFromModel = function ( models ) {
var i, modelId, model, subItems, subItem, widget,
itemWidgets = [],
$elements = $();
// Detach all attached models
for ( modelId in this.models ) {
this.detachModel( modelId );
}
// Attach and process new models
for ( modelId in models ) {
model = models[ modelId ];
this.attachModel( modelId, model );
// Build widgets based on the data in the model
if ( model.isGroup() ) {
if ( model.isForeign() ) {
// One Widget to Rule Them All
widget = new mw.echo.ui.CrossWikiNotificationItemWidget(
this.controller,
model,
{
$overlay: this.$overlay,
animateSorting: this.animated
}
);
} else {
// local bundle
widget = new mw.echo.ui.BundleNotificationItemWidget(
this.controller,
model,
{
$overlay: this.$overlay,
bundle: false,
animateSorting: this.animated
}
);
}
itemWidgets.push( widget );
$elements = $elements.add( widget.$element );
} else {
subItems = model.getItems();
// Separate widgets per item
for ( i = 0; i < subItems.length; i++ ) {
subItem = subItems[ i ];
widget = new mw.echo.ui.SingleNotificationItemWidget(
this.controller,
subItem,
{
$overlay: this.$overlay,
bundle: false
}
);
itemWidgets.push( widget );
$elements = $elements.add( widget.$element );
}
}
}
// Reset the current items and re-add the new item widgets
this.clearItems();
// fire render hook
mw.hook( 'ext.echo.notifications.beforeRender' ).fire( this.$element, $elements );
this.addItems( itemWidgets );
this.checkForEmptyNotificationsList();
this.emit( 'modified' );
};
/**
* Attach a model to the widget
*
* @param {string} modelId Symbolic name for the model
* @param {mw.echo.dm.SortedList} model Notifications list model
*/
mw.echo.ui.NotificationsListWidget.prototype.attachModel = function ( modelId, model ) {
this.models[ modelId ] = model;
};
/**
* Detach a model from the widget
*
* @param {string} modelId Notifications list model
*/
mw.echo.ui.NotificationsListWidget.prototype.detachModel = function ( modelId ) {
this.models[ modelId ].disconnect( this );
delete this.models[ modelId ];
};
/**
* Reset the loading 'dummy' option widget
*
* @param {string} [label] Label for the option widget
* @param {string} [link] Link for the option widget
* @fires modified
*/
mw.echo.ui.NotificationsListWidget.prototype.resetLoadingOption = function ( label, link ) {
this.loadingOptionWidget.setLabel( label || '' );
this.loadingOptionWidget.setLink( link || '' );
if ( this.isEmpty() ) {
this.addItems( [ this.loadingOptionWidget ] );
}
this.emit( 'modified' );
};
/**
* Check if the list of notifications is empty and udpate the placeholder
* widget as needed.
*/
mw.echo.ui.NotificationsListWidget.prototype.checkForEmptyNotificationsList = function () {
this.resetLoadingOption( this.isEmpty() ? mw.msg( 'echo-notification-placeholder' ) : '' );
};
/**
* Reset the 'initiallyUnseen' state of all items
*/
mw.echo.ui.NotificationsListWidget.prototype.resetInitiallyUnseenItems = function () {
var i,
itemWidgets = this.getItems();
for ( i = 0; i < itemWidgets.length; i++ ) {
itemWidgets[ i ].resetInitiallyUnseen();
}
};
}( mediaWiki, jQuery ) );
|