mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/Echo
synced 2024-12-03 20:06:59 +00:00
fcd2f41151
When we fetch the pages per wiki, the API returns an object that defines the local wiki we are in as its dbName; this then gets stored into the model as the source, which forces us to check against the dbName whenever we want to perform an operation so we can tell the API layer to fetch and perform the actions locally, rather than use a foreign API. The term 'local' makes no sense for naming the model (and upcoming tech debt work will fix this) but it makes sense in the context of the API layer -- and hence, the source name should follow suit. This fix makes sure that the local wiki objects always have their sources defined to be 'local', and thus making us use the test for dbName in very specific points (when we get the data) rather than throughout the codebase, randonly. This is also the first step to allow proper updating of things like seenTime accross wikis, especially in cases where we view a remote wiki as if it is local (in the Special:Notifications page) Change-Id: I94633a1cd074580cbc5029d7c75d179e908e5c52
174 lines
4.7 KiB
JavaScript
174 lines
4.7 KiB
JavaScript
( function ( $, mw ) {
|
|
/**
|
|
* A filter for cross-wiki unread notifications
|
|
*
|
|
* @class
|
|
* @extends OO.ui.Widget
|
|
* @mixins OO.ui.mixin.PendingElement
|
|
*
|
|
* @constructor
|
|
* @param {mw.echo.Controller} controller Echo controller
|
|
* @param {mw.echo.dm.FiltersModel} filtersModel Filter model
|
|
* @param {Object} [config] Configuration object
|
|
*/
|
|
mw.echo.ui.CrossWikiUnreadFilterWidget = function MwEchoUiCrossWikiUnreadFilterWidget( controller, filtersModel, config ) {
|
|
var titleWidget, subtitleWidget;
|
|
|
|
config = config || {};
|
|
|
|
// Parent
|
|
mw.echo.ui.CrossWikiUnreadFilterWidget.parent.call( this,
|
|
// Sorting callback
|
|
function ( a, b ) {
|
|
var diff;
|
|
|
|
// Local source is always first
|
|
if ( a.getSource() === 'local' ) {
|
|
return -1;
|
|
} else if ( b.getSource() === 'local' ) {
|
|
return 1;
|
|
}
|
|
|
|
diff = Number( b.getTotalCount() ) - Number( a.getTotalCount() );
|
|
if ( diff !== 0 ) {
|
|
return diff;
|
|
}
|
|
|
|
// Fallback on Source
|
|
return b.getSource() - a.getSource();
|
|
},
|
|
// Config
|
|
config
|
|
);
|
|
// Mixin
|
|
OO.ui.mixin.PendingElement.call( this, config );
|
|
|
|
this.controller = controller;
|
|
this.model = filtersModel;
|
|
this.previousPageSelected = null;
|
|
|
|
titleWidget = new OO.ui.LabelWidget( {
|
|
classes: [ 'mw-echo-ui-crossWikiUnreadFilterWidget-title' ],
|
|
label: mw.msg( 'echo-specialpage-pagefilters-title' )
|
|
} );
|
|
subtitleWidget = new OO.ui.LabelWidget( {
|
|
classes: [ 'mw-echo-ui-crossWikiUnreadFilterWidget-subtitle' ],
|
|
label: mw.msg( 'echo-specialpage-pagefilters-subtitle' )
|
|
} );
|
|
|
|
// Events
|
|
this.aggregate( { choose: 'pageFilterChoose' } );
|
|
this.connect( this, { pageFilterChoose: 'onPageFilterChoose' } );
|
|
|
|
this.$element
|
|
.addClass( 'mw-echo-ui-crossWikiUnreadFilterWidget' )
|
|
.append(
|
|
titleWidget.$element,
|
|
subtitleWidget.$element,
|
|
this.$group
|
|
.addClass( 'mw-echo-ui-crossWikiUnreadFilterWidget-group' )
|
|
);
|
|
};
|
|
|
|
/* Initialization */
|
|
|
|
OO.inheritClass( mw.echo.ui.CrossWikiUnreadFilterWidget, mw.echo.ui.SortedListWidget );
|
|
OO.mixinClass( mw.echo.ui.CrossWikiUnreadFilterWidget, OO.ui.mixin.PendingElement );
|
|
|
|
/* Events */
|
|
|
|
/**
|
|
* @event filter
|
|
* @param {string} source Source symbolic name
|
|
* @param {number} [pageId] Chosen page ID
|
|
*
|
|
* A source page filter was chosen
|
|
*/
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Respond to choose event in one of the page filter widgets
|
|
*
|
|
* @param {mw.echo.ui.PageFilterWidget} widget The widget the event originated from
|
|
* @param {mw.echo.ui.PageNotificationsOptionWidget} item The chosen item
|
|
* @fires filter
|
|
*/
|
|
mw.echo.ui.CrossWikiUnreadFilterWidget.prototype.onPageFilterChoose = function ( widget, item ) {
|
|
var source = widget.getSource(),
|
|
page = item && item.getData();
|
|
|
|
if ( item ) {
|
|
this.setItemSelected( item );
|
|
// Emit a choice
|
|
this.emit( 'filter', source, page );
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Set the selected item
|
|
*
|
|
* @param {mw.echo.ui.PageNotificationsOptionWidget} item Item to select
|
|
*/
|
|
mw.echo.ui.CrossWikiUnreadFilterWidget.prototype.setItemSelected = function ( item ) {
|
|
// Unselect the previous item
|
|
if ( this.previousPageSelected ) {
|
|
this.previousPageSelected.setSelected( false );
|
|
}
|
|
item.setSelected( true );
|
|
this.previousPageSelected = item;
|
|
};
|
|
|
|
/**
|
|
* Populate the sources
|
|
*/
|
|
mw.echo.ui.CrossWikiUnreadFilterWidget.prototype.populateSources = function () {
|
|
this.pushPending();
|
|
this.controller.fetchUnreadPagesByWiki()
|
|
.then( this.populateDataFromModel.bind( this ) )
|
|
.always( this.popPending.bind( this ) );
|
|
};
|
|
|
|
/**
|
|
* Populate the widget from the model data
|
|
*/
|
|
mw.echo.ui.CrossWikiUnreadFilterWidget.prototype.populateDataFromModel = function () {
|
|
var i, source, widget, selectedWidget, item,
|
|
widgets = [],
|
|
sourcePageModel = this.model.getSourcePagesModel(),
|
|
selectedSource = sourcePageModel.getCurrentSource(),
|
|
selectedPage = sourcePageModel.getCurrentPage(),
|
|
sources = sourcePageModel.getSourcesArray();
|
|
|
|
for ( i = 0; i < sources.length; i++ ) {
|
|
source = sources[ i ];
|
|
widget = new mw.echo.ui.PageFilterWidget(
|
|
sourcePageModel,
|
|
source,
|
|
{
|
|
title: sourcePageModel.getSourceTitle( source ),
|
|
unreadCount: sourcePageModel.getSourceTotalCount( source ),
|
|
initialSelection: this.previousPageSelected && this.previousPageSelected.getData()
|
|
}
|
|
);
|
|
|
|
widgets.push( widget );
|
|
}
|
|
|
|
this.clearItems();
|
|
this.addItems( widgets );
|
|
|
|
// Select the current source
|
|
selectedWidget = this.getItemFromData( selectedSource );
|
|
if ( selectedPage ) {
|
|
// Select a specific page
|
|
item = selectedWidget.getItemFromData( selectedPage );
|
|
} else {
|
|
// The wiki title is selected
|
|
item = selectedWidget.getTitleItem();
|
|
}
|
|
this.setItemSelected( item );
|
|
};
|
|
|
|
} )( jQuery, mediaWiki );
|