resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.FilterItem.js

   1 ( function ( mw ) {
   2         /**
   3          * Filter item model
   4          *
   5          * @mixins OO.EventEmitter
   6          *
   7          * @constructor
   8          * @param {string} param Filter param name
   9          * @param {mw.rcfilters.dm.FilterGroup} groupModel Filter group model
  10          * @param {Object} config Configuration object
  11          * @cfg {string} [group] The group this item belongs to
  12          * @cfg {string} [label] The label for the filter
  13          * @cfg {string} [description] The description of the filter
  14          * @cfg {boolean} [active=true] The filter is active and affecting the result
  15          * @cfg {string[]} [excludes=[]] A list of filter names this filter, if
  16          *  selected, makes inactive.
  17          * @cfg {boolean} [selected] The item is selected
  18          * @cfg {string[]} [subset] Defining the names of filters that are a subset of this filter
  19          * @cfg {Object} [conflicts] Defines the conflicts for this filter
  20          * @cfg {string} [cssClass] The class identifying the results that match this filter
  21          */
  22         mw.rcfilters.dm.FilterItem = function MwRcfiltersDmFilterItem( param, groupModel, config ) {
  23                 config = config || {};
  24
  25                 // Mixin constructor
  26                 OO.EventEmitter.call( this );
  27
  28                 this.param = param;
  29                 this.groupModel = groupModel;
  30                 this.name = this.groupModel.getNamePrefix() + param;
  31
  32                 this.label = config.label || this.name;
  33                 this.description = config.description;
  34                 this.selected = !!config.selected;
  35
  36                 // Interaction definitions
  37                 this.subset = config.subset || [];
  38                 this.conflicts = config.conflicts || {};
  39                 this.superset = [];
  40
  41                 // Interaction states
  42                 this.included = false;
  43                 this.conflicted = false;
  44                 this.fullyCovered = false;
  45
  46                 // Highlight
  47                 this.cssClass = config.cssClass;
  48                 this.highlightColor = null;
  49                 this.highlightEnabled = false;
  50         };
  51
  52         /* Initialization */
  53
  54         OO.initClass( mw.rcfilters.dm.FilterItem );
  55         OO.mixinClass( mw.rcfilters.dm.FilterItem, OO.EventEmitter );
  56
  57         /* Events */
  58
  59         /**
  60          * @event update
  61          *
  62          * The state of this filter has changed
  63          */
  64
  65         /* Methods */
  66
  67         /**
  68          * Return the representation of the state of this item.
  69          *
  70          * @return {Object} State of the object
  71          */
  72         mw.rcfilters.dm.FilterItem.prototype.getState = function () {
  73                 return {
  74                         selected: this.isSelected(),
  75                         included: this.isIncluded(),
  76                         conflicted: this.isConflicted(),
  77                         fullyCovered: this.isFullyCovered()
  78                 };
  79         };
  80
  81         /**
  82          * Get the name of this filter
  83          *
  84          * @return {string} Filter name
  85          */
  86         mw.rcfilters.dm.FilterItem.prototype.getName = function () {
  87                 return this.name;
  88         };
  89
  90         /**
  91          * Get the param name or value of this filter
  92          *
  93          * @return {string} Filter param name
  94          */
  95         mw.rcfilters.dm.FilterItem.prototype.getParamName = function () {
  96                 return this.param;
  97         };
  98
  99         /**
 100          * Get the message for the display area for the currently active conflict
 101          *
 102          * @return {string} Conflict result message key
 103          */
 104         mw.rcfilters.dm.FilterItem.prototype.getCurrentConflictResultMessage = function () {
 105                 var details = {};
 106
 107                 // First look in filter's own conflicts
 108                 details = this.getConflictDetails( this.getOwnConflicts(), 'globalDescription' );
 109                 if ( !details.message ) {
 110                         // Fall back onto conflicts in the group
 111                         details = this.getConflictDetails( this.getGroupModel().getConflicts(), 'globalDescription' );
 112                 }
 113
 114                 return details.message;
 115         };
 116
 117         /**
 118          * Get the details of the active conflict on this filter
 119          *
 120          * @param {Object} conflicts Conflicts to examine
 121          * @param {string} [key='contextDescription'] Message key
 122          * @return {Object} Object with conflict message and conflict items
 123          * @return {string} return.message Conflict message
 124          * @return {string[]} return.names Conflicting item labels
 125          */
 126         mw.rcfilters.dm.FilterItem.prototype.getConflictDetails = function ( conflicts, key ) {
 127                 var group,
 128                         conflictMessage = '',
 129                         itemLabels = [];
 130
 131                 key = key || 'contextDescription';
 132
 133                 $.each( conflicts, function ( filterName, conflict ) {
 134                         if ( !conflict.item.isSelected() ) {
 135                                 return;
 136                         }
 137
 138                         if ( !conflictMessage ) {
 139                                 conflictMessage = conflict[ key ];
 140                                 group = conflict.group;
 141                         }
 142
 143                         if ( group === conflict.group ) {
 144                                 itemLabels.push( mw.msg( 'quotation-marks', conflict.item.getLabel() ) );
 145                         }
 146                 } );
 147
 148                 return {
 149                         message: conflictMessage,
 150                         names: itemLabels
 151                 };
 152
 153         };
 154
 155         /**
 156          * Get the message representing the state of this model.
 157          *
 158          * @return {string} State message
 159          */
 160         mw.rcfilters.dm.FilterItem.prototype.getStateMessage = function () {
 161                 var messageKey, details, superset,
 162                         affectingItems = [];
 163
 164                 if ( this.isSelected() ) {
 165                         if ( this.isConflicted() ) {
 166                                 // First look in filter's own conflicts
 167                                 details = this.getConflictDetails( this.getOwnConflicts() );
 168                                 if ( !details.message ) {
 169                                         // Fall back onto conflicts in the group
 170                                         details = this.getConflictDetails( this.getGroupModel().getConflicts() );
 171                                 }
 172
 173                                 messageKey = details.message;
 174                                 affectingItems = details.names;
 175                         } else if ( this.isIncluded() ) {
 176                                 superset = this.getSuperset();
 177                                 // For this message we need to collect the affecting superset
 178                                 affectingItems = this.getGroupModel().getSelectedItems( this )
 179                                         .filter( function ( item ) {
 180                                                 return superset.indexOf( item.getName() ) !== -1;
 181                                         } )
 182                                         .map( function ( item ) {
 183                                                 return mw.msg( 'quotation-marks', item.getLabel() );
 184                                         } );
 185
 186                                 messageKey = 'rcfilters-state-message-subset';
 187                         } else if ( this.isFullyCovered() ) {
 188                                 affectingItems = this.getGroupModel().getSelectedItems( this )
 189                                         .map( function ( item ) {
 190                                                 return mw.msg( 'quotation-marks', item.getLabel() );
 191                                         } );
 192
 193                                 messageKey = 'rcfilters-state-message-fullcoverage';
 194                         }
 195                 }
 196
 197                 if ( messageKey ) {
 198                         // Build message
 199                         return mw.msg(
 200                                 messageKey,
 201                                 mw.language.listToText( affectingItems ),
 202                                 affectingItems.length
 203                         );
 204                 }
 205
 206                 // Display description
 207                 return this.getDescription();
 208         };
 209
 210         /**
 211          * Get the model of the group this filter belongs to
 212          *
 213          * @return {mw.rcfilters.dm.FilterGroup} Filter group model
 214          */
 215         mw.rcfilters.dm.FilterItem.prototype.getGroupModel = function () {
 216                 return this.groupModel;
 217         };
 218
 219         /**
 220          * Get the group name this filter belongs to
 221          *
 222          * @return {string} Filter group name
 223          */
 224         mw.rcfilters.dm.FilterItem.prototype.getGroupName = function () {
 225                 return this.groupModel.getName();
 226         };
 227
 228         /**
 229          * Get the label of this filter
 230          *
 231          * @return {string} Filter label
 232          */
 233         mw.rcfilters.dm.FilterItem.prototype.getLabel = function () {
 234                 return this.label;
 235         };
 236
 237         /**
 238          * Get the description of this filter
 239          *
 240          * @return {string} Filter description
 241          */
 242         mw.rcfilters.dm.FilterItem.prototype.getDescription = function () {
 243                 return this.description;
 244         };
 245
 246         /**
 247          * Get the default value of this filter
 248          *
 249          * @return {boolean} Filter default
 250          */
 251         mw.rcfilters.dm.FilterItem.prototype.getDefault = function () {
 252                 return this.default;
 253         };
 254
 255         /**
 256          * Get filter subset
 257          * This is a list of filter names that are defined to be included
 258          * when this filter is selected.
 259          *
 260          * @return {string[]} Filter subset
 261          */
 262         mw.rcfilters.dm.FilterItem.prototype.getSubset = function () {
 263                 return this.subset;
 264         };
 265
 266         /**
 267          * Get filter superset
 268          * This is a generated list of filters that define this filter
 269          * to be included when either of them is selected.
 270          *
 271          * @return {string[]} Filter superset
 272          */
 273         mw.rcfilters.dm.FilterItem.prototype.getSuperset = function () {
 274                 return this.superset;
 275         };
 276
 277         /**
 278          * Get the selected state of this filter
 279          *
 280          * @return {boolean} Filter is selected
 281          */
 282         mw.rcfilters.dm.FilterItem.prototype.isSelected = function () {
 283                 return this.selected;
 284         };
 285
 286         /**
 287          * Check whether the filter is currently in a conflict state
 288          *
 289          * @return {boolean} Filter is in conflict state
 290          */
 291         mw.rcfilters.dm.FilterItem.prototype.isConflicted = function () {
 292                 return this.conflicted;
 293         };
 294
 295         /**
 296          * Check whether the filter is currently in an already included subset
 297          *
 298          * @return {boolean} Filter is in an already-included subset
 299          */
 300         mw.rcfilters.dm.FilterItem.prototype.isIncluded = function () {
 301                 return this.included;
 302         };
 303
 304         /**
 305          * Check whether the filter is currently fully covered
 306          *
 307          * @return {boolean} Filter is in fully-covered state
 308          */
 309         mw.rcfilters.dm.FilterItem.prototype.isFullyCovered = function () {
 310                 return this.fullyCovered;
 311         };
 312
 313         /**
 314          * Get all conflicts associated with this filter or its group
 315          *
 316          * Conflict object is set up by filter name keys and conflict
 317          * definition. For example:
 318          *              {
 319          *                      filterName: {
 320          *                              filter: filterName,
 321          *                              group: group1,
 322          *                              label: itemLabel,
 323          *                              item: itemModel
 324          *                      }
 325          *                      filterName2: {
 326          *                              filter: filterName2,
 327          *                              group: group2
 328          *                              label: itemLabel2,
 329          *                              item: itemModel2
 330          *                      }
 331          *              }
 332          *
 333          * @return {Object} Filter conflicts
 334          */
 335         mw.rcfilters.dm.FilterItem.prototype.getConflicts = function () {
 336                 return $.extend( {}, this.conflicts, this.getGroupModel().getConflicts() );
 337         };
 338
 339         /**
 340          * Get the conflicts associated with this filter
 341          *
 342          * @return {Object} Filter conflicts
 343          */
 344         mw.rcfilters.dm.FilterItem.prototype.getOwnConflicts = function () {
 345                 return this.conflicts;
 346         };
 347
 348         /**
 349          * Set conflicts for this filter. See #getConflicts for the expected
 350          * structure of the definition.
 351          *
 352          * @param {Object} conflicts Conflicts for this filter
 353          */
 354         mw.rcfilters.dm.FilterItem.prototype.setConflicts = function ( conflicts ) {
 355                 this.conflicts = conflicts || {};
 356         };
 357
 358         /**
 359          * Set filter superset
 360          *
 361          * @param {string[]} superset Filter superset
 362          */
 363         mw.rcfilters.dm.FilterItem.prototype.setSuperset = function ( superset ) {
 364                 this.superset = superset || [];
 365         };
 366
 367         /**
 368          * Set filter subset
 369          *
 370          * @param {string[]} subset Filter subset
 371          */
 372         mw.rcfilters.dm.FilterItem.prototype.setSubset = function ( subset ) {
 373                 this.subset = subset || [];
 374         };
 375
 376         /**
 377          * Check whether a filter exists in the subset list for this filter
 378          *
 379          * @param {string} filterName Filter name
 380          * @return {boolean} Filter name is in the subset list
 381          */
 382         mw.rcfilters.dm.FilterItem.prototype.existsInSubset = function ( filterName ) {
 383                 return this.subset.indexOf( filterName ) > -1;
 384         };
 385
 386         /**
 387          * Check whether this item has a potential conflict with the given item
 388          *
 389          * This checks whether the given item is in the list of conflicts of
 390          * the current item, but makes no judgment about whether the conflict
 391          * is currently at play (either one of the items may not be selected)
 392          *
 393          * @param {mw.rcfilters.dm.FilterItem} filterItem Filter item
 394          * @return {boolean} This item has a conflict with the given item
 395          */
 396         mw.rcfilters.dm.FilterItem.prototype.existsInConflicts = function ( filterItem ) {
 397                 return Object.prototype.hasOwnProperty.call( this.getConflicts(), filterItem.getName() );
 398         };
 399
 400         /**
 401          * Set the state of this filter as being conflicted
 402          * (This means any filters in its conflicts are selected)
 403          *
 404          * @param {boolean} [conflicted] Filter is in conflict state
 405          * @fires update
 406          */
 407         mw.rcfilters.dm.FilterItem.prototype.toggleConflicted = function ( conflicted ) {
 408                 conflicted = conflicted === undefined ? !this.conflicted : conflicted;
 409
 410                 if ( this.conflicted !== conflicted ) {
 411                         this.conflicted = conflicted;
 412                         this.emit( 'update' );
 413                 }
 414         };
 415
 416         /**
 417          * Set the state of this filter as being already included
 418          * (This means any filters in its superset are selected)
 419          *
 420          * @param {boolean} [included] Filter is included as part of a subset
 421          * @fires update
 422          */
 423         mw.rcfilters.dm.FilterItem.prototype.toggleIncluded = function ( included ) {
 424                 included = included === undefined ? !this.included : included;
 425
 426                 if ( this.included !== included ) {
 427                         this.included = included;
 428                         this.emit( 'update' );
 429                 }
 430         };
 431
 432         /**
 433          * Toggle the selected state of the item
 434          *
 435          * @param {boolean} [isSelected] Filter is selected
 436          * @fires update
 437          */
 438         mw.rcfilters.dm.FilterItem.prototype.toggleSelected = function ( isSelected ) {
 439                 isSelected = isSelected === undefined ? !this.selected : isSelected;
 440
 441                 if ( this.selected !== isSelected ) {
 442                         this.selected = isSelected;
 443                         this.emit( 'update' );
 444                 }
 445         };
 446
 447         /**
 448          * Toggle the fully covered state of the item
 449          *
 450          * @param {boolean} [isFullyCovered] Filter is fully covered
 451          * @fires update
 452          */
 453         mw.rcfilters.dm.FilterItem.prototype.toggleFullyCovered = function ( isFullyCovered ) {
 454                 isFullyCovered = isFullyCovered === undefined ? !this.fullycovered : isFullyCovered;
 455
 456                 if ( this.fullyCovered !== isFullyCovered ) {
 457                         this.fullyCovered = isFullyCovered;
 458                         this.emit( 'update' );
 459                 }
 460         };
 461
 462         /**
 463          * Set the highlight color
 464          *
 465          * @param {string|null} highlightColor
 466          */
 467         mw.rcfilters.dm.FilterItem.prototype.setHighlightColor = function ( highlightColor ) {
 468                 if ( this.highlightColor !== highlightColor ) {
 469                         this.highlightColor = highlightColor;
 470                         this.emit( 'update' );
 471                 }
 472         };
 473
 474         /**
 475          * Clear the highlight color
 476          */
 477         mw.rcfilters.dm.FilterItem.prototype.clearHighlightColor = function () {
 478                 this.setHighlightColor( null );
 479         };
 480
 481         /**
 482          * Get the highlight color, or null if none is configured
 483          *
 484          * @return {string|null}
 485          */
 486         mw.rcfilters.dm.FilterItem.prototype.getHighlightColor = function () {
 487                 return this.highlightColor;
 488         };
 489
 490         /**
 491          * Get the CSS class that matches changes that fit this filter
 492          * or null if none is configured
 493          *
 494          * @return {string|null}
 495          */
 496         mw.rcfilters.dm.FilterItem.prototype.getCssClass = function () {
 497                 return this.cssClass;
 498         };
 499
 500         /**
 501          * Toggle the highlight feature on and off for this filter.
 502          * It only works if highlight is supported for this filter.
 503          *
 504          * @param {boolean} enable Highlight should be enabled
 505          */
 506         mw.rcfilters.dm.FilterItem.prototype.toggleHighlight = function ( enable ) {
 507                 enable = enable === undefined ? !this.highlightEnabled : enable;
 508
 509                 if ( !this.isHighlightSupported() ) {
 510                         return;
 511                 }
 512
 513                 if ( enable === this.highlightEnabled ) {
 514                         return;
 515                 }
 516
 517                 this.highlightEnabled = enable;
 518                 this.emit( 'update' );
 519         };
 520
 521         /**
 522          * Check if the highlight feature is currently enabled for this filter
 523          *
 524          * @return {boolean}
 525          */
 526         mw.rcfilters.dm.FilterItem.prototype.isHighlightEnabled = function () {
 527                 return !!this.highlightEnabled;
 528         };
 529
 530         /**
 531          * Check if the highlight feature is supported for this filter
 532          *
 533          * @return {boolean}
 534          */
 535         mw.rcfilters.dm.FilterItem.prototype.isHighlightSupported = function () {
 536                 return !!this.getCssClass();
 537         };
 538
 539         /**
 540          * Check if the filter is currently highlighted
 541          *
 542          * @return {boolean}
 543          */
 544         mw.rcfilters.dm.FilterItem.prototype.isHighlighted = function () {
 545                 return this.isHighlightEnabled() && !!this.getHighlightColor();
 546         };
 547 }( mediaWiki ) );