5 * @extends OO.ui.Widget
8 * @param {mw.rcfilters.dm.FiltersViewModel} filtersViewModel View model
9 * @param {mw.rcfilters.dm.ChangesListViewModel} changesListViewModel View model
10 * @param {mw.rcfilters.Controller} controller
11 * @param {jQuery} $changesListRoot Root element of the changes list to attach to
12 * @param {Object} [config] Configuration object
14 mw
.rcfilters
.ui
.ChangesListWrapperWidget
= function MwRcfiltersUiChangesListWrapperWidget(
21 config
= $.extend( {}, config
, {
22 $element
: $changesListRoot
26 mw
.rcfilters
.ui
.ChangesListWrapperWidget
.parent
.call( this, config
);
28 this.filtersViewModel
= filtersViewModel
;
29 this.changesListViewModel
= changesListViewModel
;
30 this.controller
= controller
;
31 this.highlightClasses
= null;
32 this.filtersModelInitialized
= false;
35 this.filtersViewModel
.connect( this, {
36 itemUpdate
: 'onItemUpdate',
37 highlightChange
: 'onHighlightChange',
38 initialize
: 'onFiltersModelInitialize'
40 this.changesListViewModel
.connect( this, {
41 invalidate
: 'onModelInvalidate',
42 update
: 'onModelUpdate'
46 .addClass( 'mw-rcfilters-ui-changesListWrapperWidget' )
47 // We handle our own display/hide of the empty results message
48 // We keep the timeout class here and remove it later, since at this
49 // stage it is still needed to identify that the timeout occurred.
50 .removeClass( 'mw-changeslist-empty' );
55 OO
.inheritClass( mw
.rcfilters
.ui
.ChangesListWrapperWidget
, OO
.ui
.Widget
);
58 * Respond to filters model initialize event
60 mw
.rcfilters
.ui
.ChangesListWrapperWidget
.prototype.onFiltersModelInitialize = function () {
61 this.filtersModelInitialized
= true;
62 // Set up highlight containers. We need to wait for the filters model
63 // to be initialized, so we can make sure we have all the css class definitions
64 // we get from the server with our filters
65 this.setupHighlightContainers( this.$element
);
69 * Get all available highlight classes
71 * @return {string[]} An array of available highlight class names
73 mw
.rcfilters
.ui
.ChangesListWrapperWidget
.prototype.getHighlightClasses = function () {
74 if ( !this.highlightClasses
|| !this.highlightClasses
.length
) {
75 this.highlightClasses
= this.filtersViewModel
.getItemsSupportingHighlights()
76 .map( function ( filterItem
) {
77 return filterItem
.getCssClass();
81 return this.highlightClasses
;
85 * Respond to the highlight feature being toggled on and off
87 * @param {boolean} highlightEnabled
89 mw
.rcfilters
.ui
.ChangesListWrapperWidget
.prototype.onHighlightChange = function ( highlightEnabled
) {
90 if ( highlightEnabled
) {
91 this.applyHighlight();
93 this.clearHighlight();
98 * Respond to a filter item model update
100 mw
.rcfilters
.ui
.ChangesListWrapperWidget
.prototype.onItemUpdate = function () {
101 if ( this.filtersModelInitialized
&& this.filtersViewModel
.isHighlightEnabled() ) {
102 this.clearHighlight();
103 this.applyHighlight();
108 * Respond to changes list model invalidate
110 mw
.rcfilters
.ui
.ChangesListWrapperWidget
.prototype.onModelInvalidate = function () {
111 $( 'body' ).addClass( 'mw-rcfilters-ui-loading' );
115 * Respond to changes list model update
117 * @param {jQuery|string} $changesListContent The content of the updated changes list
118 * @param {jQuery} $fieldset The content of the updated fieldset
119 * @param {string} noResultsDetails Type of no result error
120 * @param {boolean} isInitialDOM Whether $changesListContent is the existing (already attached) DOM
121 * @param {boolean} from Timestamp of the new changes
123 mw
.rcfilters
.ui
.ChangesListWrapperWidget
.prototype.onModelUpdate = function (
124 $changesListContent
, $fieldset
, noResultsDetails
, isInitialDOM
, from
127 $message
= $( '<div>' )
128 .addClass( 'mw-rcfilters-ui-changesListWrapperWidget-results' ),
129 isEmpty
= $changesListContent
=== 'NO_RESULTS',
130 // For enhanced mode, we have to load these modules, which are
131 // not loaded for the 'regular' mode in the backend
132 loaderPromise
= mw
.user
.options
.get( 'usenewrc' ) ?
133 mw
.loader
.using( [ 'mediawiki.special.changeslist.enhanced', 'mediawiki.icon' ] ) :
134 $.Deferred().resolve(),
137 this.$element
.toggleClass( 'mw-changeslist', !isEmpty
);
139 this.$element
.empty();
141 if ( this.filtersViewModel
.hasConflict() ) {
142 conflictItem
= this.filtersViewModel
.getFirstConflictedItem();
147 .addClass( 'mw-rcfilters-ui-changesListWrapperWidget-results-conflict' )
148 .text( mw
.message( 'rcfilters-noresults-conflict' ).text() ),
150 .addClass( 'mw-rcfilters-ui-changesListWrapperWidget-results-message' )
151 .text( mw
.message( conflictItem
.getCurrentConflictResultMessage() ).text() )
157 .addClass( 'mw-rcfilters-ui-changesListWrapperWidget-results-noresult' )
158 .text( mw
.msg( this.getMsgKeyForNoResults( noResultsDetails
) ) )
161 this.$element
.removeClass( 'mw-changeslist-timeout' );
162 this.$element
.removeClass( 'mw-changeslist-notargetpage' );
165 this.$element
.append( $message
);
167 if ( !isInitialDOM
) {
168 this.$element
.empty().append( $changesListContent
);
171 this.emphasizeNewChanges( from );
175 // Set up highlight containers
176 this.setupHighlightContainers( this.$element
);
179 this.applyHighlight();
183 this.$element
.prepend( $( '<div>' ).addClass( 'mw-changeslist-overlay' ) );
185 loaderPromise
.done( function () {
186 if ( !isInitialDOM
&& !isEmpty
) {
187 // Make sure enhanced RC re-initializes correctly
188 mw
.hook( 'wikipage.content' ).fire( widget
.$element
);
191 $( 'body' ).removeClass( 'mw-rcfilters-ui-loading' );
195 /** Toggles overlay class on changes list
197 * @param {boolean} isVisible True if overlay should be visible
199 mw
.rcfilters
.ui
.ChangesListWrapperWidget
.prototype.toggleOverlay = function ( isVisible
) {
200 this.$element
.toggleClass( 'mw-rcfilters-ui-changesListWrapperWidget--overlaid', isVisible
);
204 * Map a reason for having no results to its message key
206 * @param {string} reason One of the NO_RESULTS_* "constant" that represent
207 * a reason for having no results
208 * @return {string} Key for the message that explains why there is no results in this case
210 mw
.rcfilters
.ui
.ChangesListWrapperWidget
.prototype.getMsgKeyForNoResults = function ( reason
) {
211 var reasonMsgKeyMap
= {
212 NO_RESULTS_NORMAL
: 'recentchanges-noresult',
213 NO_RESULTS_TIMEOUT
: 'recentchanges-timeout',
214 NO_RESULTS_NETWORK_ERROR
: 'recentchanges-network',
215 NO_RESULTS_NO_TARGET_PAGE
: 'recentchanges-notargetpage'
217 return reasonMsgKeyMap
[ reason
];
221 * Emphasize the elements (or groups) newer than the 'from' parameter
222 * @param {string} from Anything newer than this is considered 'new'
224 mw
.rcfilters
.ui
.ChangesListWrapperWidget
.prototype.emphasizeNewChanges = function ( from ) {
227 $newChanges
= $( [] ),
228 selector
= this.inEnhancedMode() ?
229 'table.mw-enhanced-rc[data-mw-ts]' :
231 set = this.$element
.find( selector
),
234 set.each( function ( index
) {
235 var $this = $( this ),
236 ts
= $this.data( 'mw-ts' );
239 $newChanges
= $newChanges
.add( $this );
242 // guards against putting the marker after the last element
243 if ( index
=== ( length
- 1 ) ) {
250 $indicator
= $( '<div>' )
251 .addClass( 'mw-rcfilters-ui-changesListWrapperWidget-previousChangesIndicator' );
253 $firstNew
.after( $indicator
);
262 * Set up the highlight containers with all color circle indicators.
264 * @param {jQuery|string} $content The content of the updated changes list
266 mw
.rcfilters
.ui
.ChangesListWrapperWidget
.prototype.setupHighlightContainers = function ( $content
) {
267 var $enhancedTopPageCell
, $enhancedNestedPagesCell
,
269 highlightClass
= 'mw-rcfilters-ui-changesListWrapperWidget-highlights',
270 $highlights
= $( '<div>' )
271 .addClass( highlightClass
)
274 .addClass( 'mw-rcfilters-ui-changesListWrapperWidget-highlights-circle' )
275 .addClass( 'mw-rcfilters-ui-changesListWrapperWidget-highlights-color-none' )
276 .prop( 'data-color', 'none' )
279 if ( $( '.mw-rcfilters-ui-changesListWrapperWidget-highlights' ).length
) {
284 mw
.rcfilters
.HighlightColors
.forEach( function ( color
) {
287 .addClass( 'mw-rcfilters-ui-changesListWrapperWidget-highlights-color-' + color
)
288 .addClass( 'mw-rcfilters-ui-changesListWrapperWidget-highlights-circle' )
289 .prop( 'data-color', color
)
293 if ( this.inEnhancedMode() ) {
294 $enhancedTopPageCell
= $content
.find( 'table.mw-enhanced-rc.mw-collapsible' );
295 $enhancedNestedPagesCell
= $content
.find( 'td.mw-enhanced-rc-nested' );
297 // Enhanced RC highlight containers
298 $content
.find( 'table.mw-enhanced-rc tr:first-child' )
299 .addClass( 'mw-rcfilters-ui-changesListWrapperWidget-enhanced-toplevel' )
302 .append( $highlights
.clone() )
305 // We are adding and changing cells in a table that, despite having nested rows,
306 // is actually all one big table. To prevent the highlights cell in the "nested"
307 // rows from stretching out the cell with the flags and timestamp in the top row,
308 // we give the latter colspan=2. Then to make things line up again, we add
309 // an empty <td> to the "nested" rows.
311 // Set colspan=2 on cell with flags and timestamp in top row
312 $content
.find( 'table.mw-enhanced-rc tr:first-child td.mw-enhanced-rc' )
313 .prop( 'colspan', '2' );
314 // Add empty <td> to nested rows to compensate
315 $enhancedNestedPagesCell
.parent().prepend( $( '<td>' ) );
316 // Add highlights cell to nested rows
317 $enhancedNestedPagesCell
320 .append( $highlights
.clone().addClass( 'mw-enhanced-rc-nested' ) )
323 // We need to target the nested rows differently than the top rows so that the
324 // LESS rules applies correctly. In top rows, the rule should highlight all but
325 // the first 2 cells td:not( :nth-child( -n+2 ) and the nested rows, the rule
326 // should highlight all but the first 4 cells td:not( :nth-child( -n+4 )
327 $enhancedNestedPagesCell
329 .addClass( 'mw-rcfilters-ui-changesListWrapperWidget-enhanced-nested' );
331 // Go over pages that have sub results
332 // HACK: We really only can collect those by targetting the collapsible class
333 $enhancedTopPageCell
.each( function () {
334 var collectedClasses
,
337 // Go over <tr>s and pick up all recognized classes
338 collectedClasses
= widget
.getHighlightClasses().filter( function ( className
) {
339 return $table
.find( 'tr' ).hasClass( className
);
342 $table
.find( 'tr:first-child' )
343 .addClass( collectedClasses
.join( ' ' ) );
346 $content
.addClass( 'mw-rcfilters-ui-changesListWrapperWidget-enhancedView' );
349 $content
.find( 'ul.special li' )
350 .prepend( $highlights
.clone() );
352 $content
.removeClass( 'mw-rcfilters-ui-changesListWrapperWidget-enhancedView' );
357 * In enhanced mode, we need to check whether the grouped results all have the
358 * same active highlights in order to see whether the "parent" of the group should
359 * be grey or highlighted normally.
361 * This is called every time highlights are applied.
363 mw
.rcfilters
.ui
.ChangesListWrapperWidget
.prototype.updateEnhancedParentHighlight = function () {
364 var activeHighlightClasses
,
365 $enhancedTopPageCell
= this.$element
.find( 'table.mw-enhanced-rc.mw-collapsible' );
367 activeHighlightClasses
= this.filtersViewModel
.getCurrentlyUsedHighlightColors().map( function ( color
) {
368 return 'mw-rcfilters-highlight-color-' + color
;
371 // Go over top pages and their children, and figure out if all sub-pages have the
372 // same highlights between themselves. If they do, the parent should be highlighted
373 // with all colors. If classes are different, the parent should receive a grey
375 $enhancedTopPageCell
.each( function () {
376 var firstChildClasses
, $rowsWithDifferentHighlights
,
379 // Collect the relevant classes from the first nested child
380 firstChildClasses
= activeHighlightClasses
.filter( function ( className
) {
381 return $table
.find( 'tr:nth-child(2)' ).hasClass( className
);
383 // Filter the non-head rows and see if they all have the same classes
385 $rowsWithDifferentHighlights
= $table
.find( 'tr:not(:first-child)' ).filter( function () {
386 var classesInThisRow
,
389 classesInThisRow
= activeHighlightClasses
.filter( function ( className
) {
390 return $this.hasClass( className
);
393 return !OO
.compare( firstChildClasses
, classesInThisRow
);
396 // If classes are different, tag the row for using grey color
397 $table
.find( 'tr:first-child' )
398 .toggleClass( 'mw-rcfilters-ui-changesListWrapperWidget-enhanced-grey', $rowsWithDifferentHighlights
.length
> 0 );
403 * @return {boolean} Whether the changes are grouped by page
405 mw
.rcfilters
.ui
.ChangesListWrapperWidget
.prototype.inEnhancedMode = function () {
406 var uri
= new mw
.Uri();
407 return ( uri
.query
.enhanced
!== undefined && Number( uri
.query
.enhanced
) ) ||
408 ( uri
.query
.enhanced
=== undefined && Number( mw
.user
.options
.get( 'usenewrc' ) ) );
412 * Apply color classes based on filters highlight configuration
414 mw
.rcfilters
.ui
.ChangesListWrapperWidget
.prototype.applyHighlight = function () {
415 if ( !this.filtersViewModel
.isHighlightEnabled() ) {
419 this.filtersViewModel
.getHighlightedItems().forEach( function ( filterItem
) {
420 var $elements
= this.$element
.find( '.' + filterItem
.getCssClass() );
422 // Add highlight class to all highlighted list items
425 'mw-rcfilters-highlighted ' +
426 'mw-rcfilters-highlight-color-' + filterItem
.getHighlightColor()
429 // Track the filters for each item in .data( 'highlightedFilters' )
430 $elements
.each( function () {
431 var filters
= $( this ).data( 'highlightedFilters' );
434 $( this ).data( 'highlightedFilters', filters
);
436 if ( filters
.indexOf( filterItem
.getLabel() ) === -1 ) {
437 filters
.push( filterItem
.getLabel() );
441 // Apply a title to each highlighted item, with a list of filters
442 this.$element
.find( '.mw-rcfilters-highlighted' ).each( function () {
443 var filters
= $( this ).data( 'highlightedFilters' );
445 if ( filters
&& filters
.length
) {
446 $( this ).attr( 'title', mw
.msg(
447 'rcfilters-highlighted-filters-list',
448 filters
.join( mw
.msg( 'comma-separator' ) )
453 if ( this.inEnhancedMode() ) {
454 this.updateEnhancedParentHighlight();
457 // Turn on highlights
458 this.$element
.addClass( 'mw-rcfilters-ui-changesListWrapperWidget-highlighted' );
462 * Remove all color classes
464 mw
.rcfilters
.ui
.ChangesListWrapperWidget
.prototype.clearHighlight = function () {
465 // Remove highlight classes
466 mw
.rcfilters
.HighlightColors
.forEach( function ( color
) {
468 .find( '.mw-rcfilters-highlight-color-' + color
)
469 .removeClass( 'mw-rcfilters-highlight-color-' + color
);
472 this.$element
.find( '.mw-rcfilters-highlighted' )
473 .removeAttr( 'title' )
474 .removeData( 'highlightedFilters' )
475 .removeClass( 'mw-rcfilters-highlighted' );
477 // Remove grey from enhanced rows
478 this.$element
.find( '.mw-rcfilters-ui-changesListWrapperWidget-enhanced-grey' )
479 .removeClass( 'mw-rcfilters-ui-changesListWrapperWidget-enhanced-grey' );
481 // Turn off highlights
482 this.$element
.removeClass( 'mw-rcfilters-ui-changesListWrapperWidget-highlighted' );