| blob | f84c091dbae8e4b719d98f6d11725ea542d77e5d |
1 /*!
2 * TableSorter for MediaWiki
3 *
4 * Written 2011 Leo Koppelkamm
5 * Based on tablesorter.com plugin, written (c) 2007 Christian Bach.
6 *
7 * Dual licensed under the MIT and GPL licenses:
8 * http://www.opensource.org/licenses/mit-license.php
9 * http://www.gnu.org/licenses/gpl.html
10 *
11 * Depends on mw.config (wgDigitTransformTable, wgDefaultDateFormat, wgPageContentLanguage)
12 * and mw.language.months.
13 *
14 * Uses 'tableSorterCollation' in mw.config (if available)
15 *
16 * Create a sortable table with multi-column sorting capabilities
17 *
18 * // Create a simple tablesorter interface
19 * $( 'table' ).tablesorter();
20 *
21 * // Create a tablesorter interface, initially sorting on the first and second column
22 * $( 'table' ).tablesorter( { sortList: [ { 0: 'desc' }, { 1: 'asc' } ] } );
23 *
24 * @param {string} [cssHeader="header"] A string of the class name to be appended to sortable
25 * tr elements in the thead of the table.
26 *
27 * @param {string} [cssAsc="headerSortUp"] A string of the class name to be appended to
28 * sortable tr elements in the thead on a ascending sort.
29 *
30 * @param {string} [cssDesc="headerSortDown"] A string of the class name to be appended to
31 * sortable tr elements in the thead on a descending sort.
32 *
33 * @param {string} [sortMultisortKey="shiftKey"] A string of the multi-column sort key.
34 *
35 * @param {boolean} [cancelSelection=true] Boolean flag indicating iftablesorter should cancel
36 * selection of the table headers text.
37 *
38 * @param {Array} [sortList] An array containing objects specifying sorting. By passing more
39 * than one object, multi-sorting will be applied. Object structure:
40 * { <Integer column index>: <String 'asc' or 'desc'> }
41 *
42 * @event sortEnd.tablesorter: Triggered as soon as any sorting has been applied.
43 *
44 * @author Christian Bach/christian.bach@polyester.se
45 */
46 ( function ( $, mw ) {
47 var ts,
48 parsers = [];
50 /* Parser utility functions */
52 function getParserById( name ) {
53 var i;
54 for ( i = 0; i < parsers.length; i++ ) {
55 if ( parsers[ i ].id.toLowerCase() === name.toLowerCase() ) {
56 return parsers[ i ];
57 }
58 }
59 return false;
60 }
62 function getElementSortKey( node ) {
63 var $node = $( node ),
64 // Use data-sort-value attribute.
65 // Use data() instead of attr() so that live value changes
66 // are processed as well (T40152).
67 data = $node.data( 'sortValue' );
69 if ( data !== null && data !== undefined ) {
70 // Cast any numbers or other stuff to a string, methods
71 // like charAt, toLowerCase and split are expected.
72 return String( data );
73 }
74 if ( !node ) {
75 return $node.text();
76 }
77 if ( node.tagName.toLowerCase() === 'img' ) {
78 return $node.attr( 'alt' ) || ''; // handle undefined alt
79 }
80 return $.map( $.makeArray( node.childNodes ), function ( elem ) {
81 if ( elem.nodeType === Node.ELEMENT_NODE ) {
82 return getElementSortKey( elem );
83 }
84 return $.text( elem );
85 } ).join( '' );
86 }
88 function detectParserForColumn( table, rows, column ) {
89 var l = parsers.length,
90 config = $( table ).data( 'tablesorter' ).config,
91 cellIndex,
92 nodeValue,
93 // Start with 1 because 0 is the fallback parser
94 i = 1,
95 lastRowIndex = -1,
96 rowIndex = 0,
97 concurrent = 0,
98 empty = 0,
99 needed = ( rows.length > 4 ) ? 5 : rows.length;
101 while ( i < l ) {
102 // if this is a child row, continue to the next row (as buildCache())
103 if ( rows[ rowIndex ] && !$( rows[ rowIndex ] ).hasClass( config.cssChildRow ) ) {
104 if ( rowIndex !== lastRowIndex ) {
105 lastRowIndex = rowIndex;
106 cellIndex = $( rows[ rowIndex ] ).data( 'columnToCell' )[ column ];
107 nodeValue = $.trim( getElementSortKey( rows[ rowIndex ].cells[ cellIndex ] ) );
108 }
109 } else {
110 nodeValue = '';
111 }
113 if ( nodeValue !== '' ) {
114 if ( parsers[ i ].is( nodeValue, table ) ) {
115 concurrent++;
116 rowIndex++;
117 if ( concurrent >= needed ) {
118 // Confirmed the parser for multiple cells, let's return it
119 return parsers[ i ];
120 }
121 } else {
122 // Check next parser, reset rows
123 i++;
124 rowIndex = 0;
125 concurrent = 0;
126 empty = 0;
127 }
128 } else {
129 // Empty cell
130 empty++;
131 rowIndex++;
132 if ( rowIndex >= rows.length ) {
133 if ( concurrent >= rows.length - empty ) {
134 // Confirmed the parser for all filled cells
135 return parsers[ i ];
136 }
137 // Check next parser, reset rows
138 i++;
139 rowIndex = 0;
140 concurrent = 0;
141 empty = 0;
142 }
143 }
144 }
146 // 0 is always the generic parser (text)
147 return parsers[ 0 ];
148 }
150 function buildParserCache( table, $headers ) {
151 var sortType, len, j, parser,
152 rows = table.tBodies[ 0 ].rows,
153 config = $( table ).data( 'tablesorter' ).config,
154 parsers = [];
156 if ( rows[ 0 ] ) {
157 len = config.columns;
158 for ( j = 0; j < len; j++ ) {
159 parser = false;
160 sortType = $headers.eq( config.columnToHeader[ j ] ).data( 'sortType' );
161 if ( sortType !== undefined ) {
162 parser = getParserById( sortType );
163 }
165 if ( parser === false ) {
166 parser = detectParserForColumn( table, rows, j );
167 }
169 parsers.push( parser );
170 }
171 }
172 return parsers;
173 }
175 /* Other utility functions */
177 function buildCache( table ) {
178 var i, j, $row, cols,
179 totalRows = ( table.tBodies[ 0 ] && table.tBodies[ 0 ].rows.length ) || 0,
180 config = $( table ).data( 'tablesorter' ).config,
181 parsers = config.parsers,
182 len = parsers.length,
183 cellIndex,
184 cache = {
185 row: [],
186 normalized: []
187 };
189 for ( i = 0; i < totalRows; i++ ) {
191 // Add the table data to main data array
192 $row = $( table.tBodies[ 0 ].rows[ i ] );
193 cols = [];
195 // if this is a child row, add it to the last row's children and
196 // continue to the next row
197 if ( $row.hasClass( config.cssChildRow ) ) {
198 cache.row[ cache.row.length - 1 ] = cache.row[ cache.row.length - 1 ].add( $row );
199 // go to the next for loop
200 continue;
201 }
203 cache.row.push( $row );
205 for ( j = 0; j < len; j++ ) {
206 cellIndex = $row.data( 'columnToCell' )[ j ];
207 cols.push( parsers[ j ].format( getElementSortKey( $row[ 0 ].cells[ cellIndex ] ) ) );
208 }
210 cols.push( cache.normalized.length ); // add position for rowCache
211 cache.normalized.push( cols );
212 cols = null;
213 }
215 return cache;
216 }
218 function appendToTable( table, cache ) {
219 var i, pos, l, j,
220 row = cache.row,
221 normalized = cache.normalized,
222 totalRows = normalized.length,
223 checkCell = ( normalized[ 0 ].length - 1 ),
224 fragment = document.createDocumentFragment();
226 for ( i = 0; i < totalRows; i++ ) {
227 pos = normalized[ i ][ checkCell ];
229 l = row[ pos ].length;
230 for ( j = 0; j < l; j++ ) {
231 fragment.appendChild( row[ pos ][ j ] );
232 }
234 }
235 table.tBodies[ 0 ].appendChild( fragment );
237 $( table ).trigger( 'sortEnd.tablesorter' );
238 }
240 /**
241 * Find all header rows in a thead-less table and put them in a <thead> tag.
242 * This only treats a row as a header row if it contains only <th>s (no <td>s)
243 * and if it is preceded entirely by header rows. The algorithm stops when
244 * it encounters the first non-header row.
245 *
246 * After this, it will look at all rows at the bottom for footer rows
247 * And place these in a tfoot using similar rules.
248 *
249 * @param {jQuery} $table object for a <table>
250 */
251 function emulateTHeadAndFoot( $table ) {
252 var $thead, $tfoot, i, len,
253 $rows = $table.find( '> tbody > tr' );
254 if ( !$table.get( 0 ).tHead ) {
255 $thead = $( '<thead>' );
256 $rows.each( function () {
257 if ( $( this ).children( 'td' ).length ) {
258 // This row contains a <td>, so it's not a header row
259 // Stop here
260 return false;
261 }
262 $thead.append( this );
263 } );
264 $table.find( ' > tbody:first' ).before( $thead );
265 }
266 if ( !$table.get( 0 ).tFoot ) {
267 $tfoot = $( '<tfoot>' );
268 len = $rows.length;
269 for ( i = len - 1; i >= 0; i-- ) {
270 if ( $( $rows[ i ] ).children( 'td' ).length ) {
271 break;
272 }
273 $tfoot.prepend( $( $rows[ i ] ) );
274 }
275 $table.append( $tfoot );
276 }
277 }
279 function uniqueElements( array ) {
280 var uniques = [];
281 $.each( array, function ( i, elem ) {
282 if ( elem !== undefined && $.inArray( elem, uniques ) === -1 ) {
283 uniques.push( elem );
284 }
285 } );
286 return uniques;
287 }
289 function buildHeaders( table, msg ) {
290 var config = $( table ).data( 'tablesorter' ).config,
291 maxSeen = 0,
292 colspanOffset = 0,
293 columns,
294 k,
295 $cell,
296 rowspan,
297 colspan,
298 headerCount,
299 longestTR,
300 headerIndex,
301 exploded,
302 $tableHeaders = $( [] ),
303 $tableRows = $( 'thead:eq(0) > tr', table );
305 if ( $tableRows.length <= 1 ) {
306 $tableHeaders = $tableRows.children( 'th' );
307 } else {
308 exploded = [];
310 // Loop through all the dom cells of the thead
311 $tableRows.each( function ( rowIndex, row ) {
312 $.each( row.cells, function ( columnIndex, cell ) {
313 var matrixRowIndex,
314 matrixColumnIndex;
316 rowspan = Number( cell.rowSpan );
317 colspan = Number( cell.colSpan );
319 // Skip the spots in the exploded matrix that are already filled
320 while ( exploded[ rowIndex ] && exploded[ rowIndex ][ columnIndex ] !== undefined ) {
321 ++columnIndex;
322 }
324 // Find the actual dimensions of the thead, by placing each cell
325 // in the exploded matrix rowspan times colspan times, with the proper offsets
326 for ( matrixColumnIndex = columnIndex; matrixColumnIndex < columnIndex + colspan; ++matrixColumnIndex ) {
327 for ( matrixRowIndex = rowIndex; matrixRowIndex < rowIndex + rowspan; ++matrixRowIndex ) {
328 if ( !exploded[ matrixRowIndex ] ) {
329 exploded[ matrixRowIndex ] = [];
330 }
331 exploded[ matrixRowIndex ][ matrixColumnIndex ] = cell;
332 }
333 }
334 } );
335 } );
336 // We want to find the row that has the most columns (ignoring colspan)
337 $.each( exploded, function ( index, cellArray ) {
338 headerCount = $( uniqueElements( cellArray ) ).filter( 'th' ).length;
339 if ( headerCount >= maxSeen ) {
340 maxSeen = headerCount;
341 longestTR = index;
342 }
343 } );
344 // We cannot use $.unique() here because it sorts into dom order, which is undesirable
345 $tableHeaders = $( uniqueElements( exploded[ longestTR ] ) ).filter( 'th' );
346 }
348 // as each header can span over multiple columns (using colspan=N),
349 // we have to bidirectionally map headers to their columns and columns to their headers
350 config.columnToHeader = [];
351 config.headerToColumns = [];
352 config.headerList = [];
353 headerIndex = 0;
354 $tableHeaders.each( function () {
355 $cell = $( this );
356 columns = [];
358 if ( !$cell.hasClass( config.unsortableClass ) ) {
359 $cell
360 .addClass( config.cssHeader )
361 .prop( 'tabIndex', 0 )
362 .attr( {
363 role: 'columnheader button',
364 title: msg[ 1 ]
365 } );
367 for ( k = 0; k < this.colSpan; k++ ) {
368 config.columnToHeader[ colspanOffset + k ] = headerIndex;
369 columns.push( colspanOffset + k );
370 }
372 config.headerToColumns[ headerIndex ] = columns;
374 $cell.data( {
375 headerIndex: headerIndex,
376 order: 0,
377 count: 0
378 } );
380 // add only sortable cells to headerList
381 config.headerList[ headerIndex ] = this;
382 headerIndex++;
383 }
385 colspanOffset += this.colSpan;
386 } );
388 // number of columns with extended colspan, inclusive unsortable
389 // parsers[j], cache[][j], columnToHeader[j], columnToCell[j] have so many elements
390 config.columns = colspanOffset;
392 return $tableHeaders.not( '.' + config.unsortableClass );
393 }
395 function isValueInArray( v, a ) {
396 var i;
397 for ( i = 0; i < a.length; i++ ) {
398 if ( a[ i ][ 0 ] === v ) {
399 return true;
400 }
401 }
402 return false;
403 }
405 /**
406 * Sets the sort count of the columns that are not affected by the sorting to have them sorted
407 * in default (ascending) order when their header cell is clicked the next time.
408 *
409 * @param {jQuery} $headers
410 * @param {Array} sortList 2D number array
411 * @param {Array} headerToColumns 2D number array
412 */
413 function setHeadersOrder( $headers, sortList, headerToColumns ) {
414 // Loop through all headers to retrieve the indices of the columns the header spans across:
415 $.each( headerToColumns, function ( headerIndex, columns ) {
417 $.each( columns, function ( i, columnIndex ) {
418 var header = $headers[ headerIndex ],
419 $header = $( header );
421 if ( !isValueInArray( columnIndex, sortList ) ) {
422 // Column shall not be sorted: Reset header count and order.
423 $header.data( {
424 order: 0,
425 count: 0
426 } );
427 } else {
428 // Column shall be sorted: Apply designated count and order.
429 $.each( sortList, function ( j, sortColumn ) {
430 if ( sortColumn[ 0 ] === i ) {
431 $header.data( {
432 order: sortColumn[ 1 ],
433 count: sortColumn[ 1 ] + 1
434 } );
435 return false;
436 }
437 } );
438 }
439 } );
441 } );
442 }
444 function setHeadersCss( table, $headers, list, css, msg, columnToHeader ) {
445 var i, len;
446 // Remove all header information and reset titles to default message
447 $headers.removeClass( css[ 0 ] ).removeClass( css[ 1 ] ).attr( 'title', msg[ 1 ] );
449 for ( i = 0, len = list.length; i < len; i++ ) {
450 $headers
451 .eq( columnToHeader[ list[ i ][ 0 ] ] )
452 .addClass( css[ list[ i ][ 1 ] ] )
453 .attr( 'title', msg[ list[ i ][ 1 ] ] );
454 }
455 }
457 function sortText( a, b ) {
458 return ( ( a < b ) ? -1 : ( ( a > b ) ? 1 : 0 ) );
459 }
461 function sortTextDesc( a, b ) {
462 return ( ( b < a ) ? -1 : ( ( b > a ) ? 1 : 0 ) );
463 }
465 function multisort( table, sortList, cache ) {
466 var i,
467 sortFn = [];
469 for ( i = 0; i < sortList.length; i++ ) {
470 sortFn[ i ] = ( sortList[ i ][ 1 ] ) ? sortTextDesc : sortText;
471 }
472 cache.normalized.sort( function ( array1, array2 ) {
473 var i, col, ret;
474 for ( i = 0; i < sortList.length; i++ ) {
475 col = sortList[ i ][ 0 ];
476 ret = sortFn[ i ].call( this, array1[ col ], array2[ col ] );
477 if ( ret !== 0 ) {
478 return ret;
479 }
480 }
481 // Fall back to index number column to ensure stable sort
482 return sortText.call( this, array1[ array1.length - 1 ], array2[ array2.length - 1 ] );
483 } );
484 return cache;
485 }
487 function buildTransformTable() {
488 var ascii, localised, i, digitClass,
489 digits = '0123456789,.'.split( '' ),
490 separatorTransformTable = mw.config.get( 'wgSeparatorTransformTable' ),
491 digitTransformTable = mw.config.get( 'wgDigitTransformTable' );
493 if ( separatorTransformTable === null || ( separatorTransformTable[ 0 ] === '' && digitTransformTable[ 2 ] === '' ) ) {
494 ts.transformTable = false;
495 } else {
496 ts.transformTable = {};
498 // Unpack the transform table
499 ascii = separatorTransformTable[ 0 ].split( '\t' ).concat( digitTransformTable[ 0 ].split( '\t' ) );
500 localised = separatorTransformTable[ 1 ].split( '\t' ).concat( digitTransformTable[ 1 ].split( '\t' ) );
502 // Construct regexes for number identification
503 for ( i = 0; i < ascii.length; i++ ) {
504 ts.transformTable[ localised[ i ] ] = ascii[ i ];
505 digits.push( mw.RegExp.escape( localised[ i ] ) );
506 }
507 }
508 digitClass = '[' + digits.join( '', digits ) + ']';
510 // We allow a trailing percent sign, which we just strip. This works fine
511 // if percents and regular numbers aren't being mixed.
512 ts.numberRegex = new RegExp( '^(' + '[-+\u2212]?[0-9][0-9,]*(\\.[0-9,]*)?(E[-+\u2212]?[0-9][0-9,]*)?' + // Fortran-style scientific
513 '|' + '[-+\u2212]?' + digitClass + '+[\\s\\xa0]*%?' + // Generic localised
514 ')$', 'i' );
515 }
517 function buildDateTable() {
518 var i, name,
519 regex = [];
521 ts.monthNames = {};
523 for ( i = 0; i < 12; i++ ) {
524 name = mw.language.months.names[ i ].toLowerCase();
525 ts.monthNames[ name ] = i + 1;
526 regex.push( mw.RegExp.escape( name ) );
527 name = mw.language.months.genitive[ i ].toLowerCase();
528 ts.monthNames[ name ] = i + 1;
529 regex.push( mw.RegExp.escape( name ) );
530 name = mw.language.months.abbrev[ i ].toLowerCase().replace( '.', '' );
531 ts.monthNames[ name ] = i + 1;
532 regex.push( mw.RegExp.escape( name ) );
533 }
535 // Build piped string
536 regex = regex.join( '|' );
538 // Build RegEx
539 // Any date formated with . , ' - or /
540 ts.dateRegex[ 0 ] = new RegExp( /^\s*(\d{1,2})[\,\.\-\/'\s]{1,2}(\d{1,2})[\,\.\-\/'\s]{1,2}(\d{2,4})\s*?/i );
542 // Written Month name, dmy
543 ts.dateRegex[ 1 ] = new RegExp( '^\\s*(\\d{1,2})[\\,\\.\\-\\/\'\\s]+(' + regex + ')' + '[\\,\\.\\-\\/\'\\s]+(\\d{2,4})\\s*$', 'i' );
545 // Written Month name, mdy
546 ts.dateRegex[ 2 ] = new RegExp( '^\\s*(' + regex + ')' + '[\\,\\.\\-\\/\'\\s]+(\\d{1,2})[\\,\\.\\-\\/\'\\s]+(\\d{2,4})\\s*$', 'i' );
548 }
550 /**
551 * Replace all rowspanned cells in the body with clones in each row, so sorting
552 * need not worry about them.
553 *
554 * @param {jQuery} $table jQuery object for a <table>
555 */
556 function explodeRowspans( $table ) {
557 var spanningRealCellIndex, rowSpan, colSpan,
558 cell, cellData, i, $tds, $clone, $nextRows,
559 rowspanCells = $table.find( '> tbody > tr > [rowspan]' ).get();
561 // Short circuit
562 if ( !rowspanCells.length ) {
563 return;
564 }
566 // First, we need to make a property like cellIndex but taking into
567 // account colspans. We also cache the rowIndex to avoid having to take
568 // cell.parentNode.rowIndex in the sorting function below.
569 $table.find( '> tbody > tr' ).each( function () {
570 var i,
571 col = 0,
572 len = this.cells.length;
573 for ( i = 0; i < len; i++ ) {
574 $( this.cells[ i ] ).data( 'tablesorter', {
575 realCellIndex: col,
576 realRowIndex: this.rowIndex
577 } );
578 col += this.cells[ i ].colSpan;
579 }
580 } );
582 // Split multi row cells into multiple cells with the same content.
583 // Sort by column then row index to avoid problems with odd table structures.
584 // Re-sort whenever a rowspanned cell's realCellIndex is changed, because it
585 // might change the sort order.
586 function resortCells() {
587 var cellAData,
588 cellBData,
589 ret;
590 rowspanCells = rowspanCells.sort( function ( a, b ) {
591 cellAData = $.data( a, 'tablesorter' );
592 cellBData = $.data( b, 'tablesorter' );
593 ret = cellAData.realCellIndex - cellBData.realCellIndex;
594 if ( !ret ) {
595 ret = cellAData.realRowIndex - cellBData.realRowIndex;
596 }
597 return ret;
598 } );
599 $.each( rowspanCells, function () {
600 $.data( this, 'tablesorter' ).needResort = false;
601 } );
602 }
603 resortCells();
605 function filterfunc() {
606 return $.data( this, 'tablesorter' ).realCellIndex >= spanningRealCellIndex;
607 }
609 function fixTdCellIndex() {
610 $.data( this, 'tablesorter' ).realCellIndex += colSpan;
611 if ( this.rowSpan > 1 ) {
612 $.data( this, 'tablesorter' ).needResort = true;
613 }
614 }
616 while ( rowspanCells.length ) {
617 if ( $.data( rowspanCells[ 0 ], 'tablesorter' ).needResort ) {
618 resortCells();
619 }
621 cell = rowspanCells.shift();
622 cellData = $.data( cell, 'tablesorter' );
623 rowSpan = cell.rowSpan;
624 colSpan = cell.colSpan;
625 spanningRealCellIndex = cellData.realCellIndex;
626 cell.rowSpan = 1;
627 $nextRows = $( cell ).parent().nextAll();
628 for ( i = 0; i < rowSpan - 1; i++ ) {
629 $tds = $( $nextRows[ i ].cells ).filter( filterfunc );
630 $clone = $( cell ).clone();
631 $clone.data( 'tablesorter', {
632 realCellIndex: spanningRealCellIndex,
633 realRowIndex: cellData.realRowIndex + i,
634 needResort: true
635 } );
636 if ( $tds.length ) {
637 $tds.each( fixTdCellIndex );
638 $tds.first().before( $clone );
639 } else {
640 $nextRows.eq( i ).append( $clone );
641 }
642 }
643 }
644 }
646 /**
647 * Build index to handle colspanned cells in the body.
648 * Set the cell index for each column in an array,
649 * so that colspaned cells set multiple in this array.
650 * columnToCell[collumnIndex] point at the real cell in this row.
651 *
652 * @param {jQuery} $table object for a <table>
653 */
654 function manageColspans( $table ) {
655 var i, j, k, $row,
656 $rows = $table.find( '> tbody > tr' ),
657 totalRows = $rows.length || 0,
658 config = $table.data( 'tablesorter' ).config,
659 columns = config.columns,
660 columnToCell, cellsInRow, index;
662 for ( i = 0; i < totalRows; i++ ) {
664 $row = $rows.eq( i );
665 // if this is a child row, continue to the next row (as buildCache())
666 if ( $row.hasClass( config.cssChildRow ) ) {
667 // go to the next for loop
668 continue;
669 }
671 columnToCell = [];
672 cellsInRow = ( $row[ 0 ].cells.length ) || 0; // all cells in this row
673 index = 0; // real cell index in this row
674 for ( j = 0; j < columns; index++ ) {
675 if ( index === cellsInRow ) {
676 // Row with cells less than columns: add empty cell
677 $row.append( '<td>' );
678 cellsInRow++;
679 }
680 for ( k = 0; k < $row[ 0 ].cells[ index ].colSpan; k++ ) {
681 columnToCell[ j++ ] = index;
682 }
683 }
684 // Store it in $row
685 $row.data( 'columnToCell', columnToCell );
686 }
687 }
689 function buildCollationTable() {
690 var key, keys = [];
691 ts.collationTable = mw.config.get( 'tableSorterCollation' );
692 ts.collationRegex = null;
693 if ( ts.collationTable ) {
694 // Build array of key names
695 for ( key in ts.collationTable ) {
696 // Check hasOwn to be safe
697 if ( ts.collationTable.hasOwnProperty( key ) ) {
698 keys.push( mw.RegExp.escape( key ) );
699 }
700 }
701 if ( keys.length ) {
702 ts.collationRegex = new RegExp( keys.join( '|' ), 'ig' );
703 }
704 }
705 }
707 function cacheRegexs() {
708 if ( ts.rgx ) {
709 return;
710 }
711 ts.rgx = {
712 IPAddress: [
713 new RegExp( /^\d{1,3}[\.]\d{1,3}[\.]\d{1,3}[\.]\d{1,3}$/ )
714 ],
715 currency: [
716 new RegExp( /(^[£$€¥]|[£$€¥]$)/ ),
717 new RegExp( /[£$€¥]/g )
718 ],
719 url: [
720 new RegExp( /^(https?|ftp|file):\/\/$/ ),
721 new RegExp( /(https?|ftp|file):\/\// )
722 ],
723 isoDate: [
724 new RegExp( /^([-+]?\d{1,4})-([01]\d)-([0-3]\d)([T\s]((([01]\d|2[0-3])(:?[0-5]\d)?|24:?00)?(:?([0-5]\d|60))?([.,]\d+)?)([zZ]|([\+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?/ ),
725 new RegExp( /^([-+]?\d{1,4})-([01]\d)-([0-3]\d)/ )
726 ],
727 usLongDate: [
728 new RegExp( /^[A-Za-z]{3,10}\.? [0-9]{1,2}, ([0-9]{4}|'?[0-9]{2}) (([0-2]?[0-9]:[0-5][0-9])|([0-1]?[0-9]:[0-5][0-9]\s(AM|PM)))$/ )
729 ],
730 time: [
731 new RegExp( /^(([0-2]?[0-9]:[0-5][0-9])|([0-1]?[0-9]:[0-5][0-9]\s(am|pm)))$/ )
732 ]
733 };
734 }
736 /**
737 * Converts sort objects [ { Integer: String }, ... ] to the internally used nested array
738 * structure [ [ Integer , Integer ], ... ]
739 *
740 * @param {Array} sortObjects List of sort objects.
741 * @return {Array} List of internal sort definitions.
742 */
743 function convertSortList( sortObjects ) {
744 var sortList = [];
745 $.each( sortObjects, function ( i, sortObject ) {
746 $.each( sortObject, function ( columnIndex, order ) {
747 var orderIndex = ( order === 'desc' ) ? 1 : 0;
748 sortList.push( [ parseInt( columnIndex, 10 ), orderIndex ] );
749 } );
750 } );
751 return sortList;
752 }
754 /* Public scope */
756 $.tablesorter = {
757 defaultOptions: {
758 cssHeader: 'headerSort',
759 cssAsc: 'headerSortUp',
760 cssDesc: 'headerSortDown',
761 cssChildRow: 'expand-child',
762 sortMultiSortKey: 'shiftKey',
763 unsortableClass: 'unsortable',
764 parsers: [],
765 cancelSelection: true,
766 sortList: [],
767 headerList: [],
768 headerToColumns: [],
769 columnToHeader: [],
770 columns: 0
771 },
773 dateRegex: [],
774 monthNames: {},
776 /**
777 * @param {jQuery} $tables
778 * @param {Object} [settings]
779 * @return {jQuery}
780 */
781 construct: function ( $tables, settings ) {
782 return $tables.each( function ( i, table ) {
783 // Declare and cache.
784 var $headers, cache, config, sortCSS, sortMsg,
785 $table = $( table ),
786 firstTime = true;
788 // Quit if no tbody
789 if ( !table.tBodies ) {
790 return;
791 }
792 if ( !table.tHead ) {
793 // No thead found. Look for rows with <th>s and
794 // move them into a <thead> tag or a <tfoot> tag
795 emulateTHeadAndFoot( $table );
797 // Still no thead? Then quit
798 if ( !table.tHead ) {
799 return;
800 }
801 }
802 $table.addClass( 'jquery-tablesorter' );
804 // Merge and extend
805 config = $.extend( {}, $.tablesorter.defaultOptions, settings );
807 // Save the settings where they read
808 $.data( table, 'tablesorter', { config: config } );
810 // Get the CSS class names, could be done elsewhere
811 sortCSS = [ config.cssAsc, config.cssDesc ];
812 // Messages tell the the user what the *next* state will be
813 // so are in reverse order to the CSS classes.
814 sortMsg = [ mw.msg( 'sort-descending' ), mw.msg( 'sort-ascending' ) ];
816 // Build headers
817 $headers = buildHeaders( table, sortMsg );
819 // Grab and process locale settings.
820 buildTransformTable();
821 buildDateTable();
823 // Precaching regexps can bring 10 fold
824 // performance improvements in some browsers.
825 cacheRegexs();
827 function setupForFirstSort() {
828 var $tfoot, $sortbottoms;
830 firstTime = false;
832 // Defer buildCollationTable to first sort. As user and site scripts
833 // may customize tableSorterCollation but load after $.ready(), other
834 // scripts may call .tablesorter() before they have done the
835 // tableSorterCollation customizations.
836 buildCollationTable();
838 // Legacy fix of .sortbottoms
839 // Wrap them inside a tfoot (because that's what they actually want to be)
840 // and put the <tfoot> at the end of the <table>
841 $sortbottoms = $table.find( '> tbody > tr.sortbottom' );
842 if ( $sortbottoms.length ) {
843 $tfoot = $table.children( 'tfoot' );
844 if ( $tfoot.length ) {
845 $tfoot.eq( 0 ).prepend( $sortbottoms );
846 } else {
847 $table.append( $( '<tfoot>' ).append( $sortbottoms ) );
848 }
849 }
851 explodeRowspans( $table );
852 manageColspans( $table );
854 // Try to auto detect column type, and store in tables config
855 config.parsers = buildParserCache( table, $headers );
856 }
858 // Apply event handling to headers
859 // this is too big, perhaps break it out?
860 $headers.on( 'keypress click', function ( e ) {
861 var cell, $cell, columns, newSortList, i,
862 totalRows,
863 j, s, o;
865 if ( e.type === 'click' && e.target.nodeName.toLowerCase() === 'a' ) {
866 // The user clicked on a link inside a table header.
867 // Do nothing and let the default link click action continue.
868 return true;
869 }
871 if ( e.type === 'keypress' && e.which !== 13 ) {
872 // Only handle keypresses on the "Enter" key.
873 return true;
874 }
876 if ( firstTime ) {
877 setupForFirstSort();
878 }
880 // Build the cache for the tbody cells
881 // to share between calculations for this sort action.
882 // Re-calculated each time a sort action is performed due to possiblity
883 // that sort values change. Shouldn't be too expensive, but if it becomes
884 // too slow an event based system should be implemented somehow where
885 // cells get event .change() and bubbles up to the <table> here
886 cache = buildCache( table );
888 totalRows = ( $table[ 0 ].tBodies[ 0 ] && $table[ 0 ].tBodies[ 0 ].rows.length ) || 0;
889 if ( totalRows > 0 ) {
890 cell = this;
891 $cell = $( cell );
893 // Get current column sort order
894 $cell.data( {
895 order: $cell.data( 'count' ) % 2,
896 count: $cell.data( 'count' ) + 1
897 } );
899 cell = this;
900 // Get current column index
901 columns = config.headerToColumns[ $cell.data( 'headerIndex' ) ];
902 newSortList = $.map( columns, function ( c ) {
903 // jQuery "helpfully" flattens the arrays...
904 return [ [ c, $cell.data( 'order' ) ] ];
905 } );
906 // Index of first column belonging to this header
907 i = columns[ 0 ];
909 if ( !e[ config.sortMultiSortKey ] ) {
910 // User only wants to sort on one column set
911 // Flush the sort list and add new columns
912 config.sortList = newSortList;
913 } else {
914 // Multi column sorting
915 // It is not possible for one column to belong to multiple headers,
916 // so this is okay - we don't need to check for every value in the columns array
917 if ( isValueInArray( i, config.sortList ) ) {
918 // The user has clicked on an already sorted column.
919 // Reverse the sorting direction for all tables.
920 for ( j = 0; j < config.sortList.length; j++ ) {
921 s = config.sortList[ j ];
922 o = config.headerList[ config.columnToHeader[ s[ 0 ] ] ];
923 if ( isValueInArray( s[ 0 ], newSortList ) ) {
924 $( o ).data( 'count', s[ 1 ] + 1 );
925 s[ 1 ] = $( o ).data( 'count' ) % 2;
926 }
927 }
928 } else {
929 // Add columns to sort list array
930 config.sortList = config.sortList.concat( newSortList );
931 }
932 }
934 // Reset order/counts of cells not affected by sorting
935 setHeadersOrder( $headers, config.sortList, config.headerToColumns );
937 // Set CSS for headers
938 setHeadersCss( $table[ 0 ], $headers, config.sortList, sortCSS, sortMsg, config.columnToHeader );
939 appendToTable(
940 $table[ 0 ], multisort( $table[ 0 ], config.sortList, cache )
941 );
943 // Stop normal event by returning false
944 return false;
945 }
947 // Cancel selection
948 } ).mousedown( function () {
949 if ( config.cancelSelection ) {
950 this.onselectstart = function () {
951 return false;
952 };
953 return false;
954 }
955 } );
957 /**
958 * Sorts the table. If no sorting is specified by passing a list of sort
959 * objects, the table is sorted according to the initial sorting order.
960 * Passing an empty array will reset sorting (basically just reset the headers
961 * making the table appear unsorted).
962 *
963 * @param {Array} [sortList] List of sort objects.
964 */
965 $table.data( 'tablesorter' ).sort = function ( sortList ) {
967 if ( firstTime ) {
968 setupForFirstSort();
969 }
971 if ( sortList === undefined ) {
972 sortList = config.sortList;
973 } else if ( sortList.length > 0 ) {
974 sortList = convertSortList( sortList );
975 }
977 // Set each column's sort count to be able to determine the correct sort
978 // order when clicking on a header cell the next time
979 setHeadersOrder( $headers, sortList, config.headerToColumns );
981 // re-build the cache for the tbody cells
982 cache = buildCache( table );
984 // set css for headers
985 setHeadersCss( table, $headers, sortList, sortCSS, sortMsg, config.columnToHeader );
987 // sort the table and append it to the dom
988 appendToTable( table, multisort( table, sortList, cache ) );
989 };
991 // sort initially
992 if ( config.sortList.length > 0 ) {
993 config.sortList = convertSortList( config.sortList );
994 $table.data( 'tablesorter' ).sort();
995 }
997 } );
998 },
1000 addParser: function ( parser ) {
1001 if ( !getParserById( parser.id ) ) {
1002 parsers.push( parser );
1003 }
1004 },
1006 formatDigit: function ( s ) {
1007 var out, c, p, i;
1008 if ( ts.transformTable !== false ) {
1009 out = '';
1010 for ( p = 0; p < s.length; p++ ) {
1011 c = s.charAt( p );
1012 if ( c in ts.transformTable ) {
1013 out += ts.transformTable[ c ];
1014 } else {
1015 out += c;
1016 }
1017 }
1018 s = out;
1019 }
1020 i = parseFloat( s.replace( /[, ]/g, '' ).replace( '\u2212', '-' ) );
1021 return isNaN( i ) ? -Infinity : i;
1022 },
1024 formatFloat: function ( s ) {
1025 var i = parseFloat( s );
1026 return isNaN( i ) ? -Infinity : i;
1027 },
1029 formatInt: function ( s ) {
1030 var i = parseInt( s, 10 );
1031 return isNaN( i ) ? -Infinity : i;
1032 },
1034 clearTableBody: function ( table ) {
1035 $( table.tBodies[ 0 ] ).empty();
1036 },
1038 getParser: function ( id ) {
1039 buildTransformTable();
1040 buildDateTable();
1041 cacheRegexs();
1042 buildCollationTable();
1044 return getParserById( id );
1045 },
1047 getParsers: function () { // for table diagnosis
1048 return parsers;
1049 }
1050 };
1052 // Shortcut
1053 ts = $.tablesorter;
1055 // Register as jQuery prototype method
1056 $.fn.tablesorter = function ( settings ) {
1057 return ts.construct( this, settings );
1058 };
1060 // Add default parsers
1061 ts.addParser( {
1062 id: 'text',
1063 is: function () {
1064 return true;
1065 },
1066 format: function ( s ) {
1067 var tsc;
1068 s = $.trim( s.toLowerCase() );
1069 if ( ts.collationRegex ) {
1070 tsc = ts.collationTable;
1071 s = s.replace( ts.collationRegex, function ( match ) {
1072 var r = tsc[ match ] ? tsc[ match ] : tsc[ match.toUpperCase() ];
1073 return r.toLowerCase();
1074 } );
1075 }
1076 return s;
1077 },
1078 type: 'text'
1079 } );
1081 ts.addParser( {
1082 id: 'IPAddress',
1083 is: function ( s ) {
1084 return ts.rgx.IPAddress[ 0 ].test( s );
1085 },
1086 format: function ( s ) {
1087 var i, item,
1088 a = s.split( '.' ),
1089 r = '';
1090 for ( i = 0; i < a.length; i++ ) {
1091 item = a[ i ];
1092 if ( item.length === 1 ) {
1093 r += '00' + item;
1094 } else if ( item.length === 2 ) {
1095 r += '0' + item;
1096 } else {
1097 r += item;
1098 }
1099 }
1100 return $.tablesorter.formatFloat( r );
1101 },
1102 type: 'numeric'
1103 } );
1105 ts.addParser( {
1106 id: 'currency',
1107 is: function ( s ) {
1108 return ts.rgx.currency[ 0 ].test( s );
1109 },
1110 format: function ( s ) {
1111 return $.tablesorter.formatDigit( s.replace( ts.rgx.currency[ 1 ], '' ) );
1112 },
1113 type: 'numeric'
1114 } );
1116 ts.addParser( {
1117 id: 'url',
1118 is: function ( s ) {
1119 return ts.rgx.url[ 0 ].test( s );
1120 },
1121 format: function ( s ) {
1122 return $.trim( s.replace( ts.rgx.url[ 1 ], '' ) );
1123 },
1124 type: 'text'
1125 } );
1127 ts.addParser( {
1128 id: 'isoDate',
1129 is: function ( s ) {
1130 return ts.rgx.isoDate[ 0 ].test( s );
1131 },
1132 format: function ( s ) {
1133 var isodate, matches;
1134 if ( !Date.prototype.toISOString ) {
1135 // Old browsers don't understand iso, Fallback to US date parsing and ignore the time part.
1136 matches = $.trim( s ).match( ts.rgx.isoDate[ 1 ] );
1137 if ( !matches ) {
1138 return $.tablesorter.formatFloat( 0 );
1139 }
1140 isodate = new Date( matches[ 2 ] + '/' + matches[ 3 ] + '/' + matches[ 1 ] );
1141 } else {
1142 matches = s.match( ts.rgx.isoDate[ 0 ] );
1143 if ( !matches ) {
1144 return $.tablesorter.formatFloat( 0 );
1145 }
1146 isodate = new Date( $.trim( matches[ 0 ] ) );
1147 }
1148 return $.tablesorter.formatFloat( ( isodate !== undefined ) ? isodate.getTime() : 0 );
1149 },
1150 type: 'numeric'
1151 } );
1153 ts.addParser( {
1154 id: 'usLongDate',
1155 is: function ( s ) {
1156 return ts.rgx.usLongDate[ 0 ].test( s );
1157 },
1158 format: function ( s ) {
1159 return $.tablesorter.formatFloat( new Date( s ).getTime() );
1160 },
1161 type: 'numeric'
1162 } );
1164 ts.addParser( {
1165 id: 'date',
1166 is: function ( s ) {
1167 return ( ts.dateRegex[ 0 ].test( s ) || ts.dateRegex[ 1 ].test( s ) || ts.dateRegex[ 2 ].test( s ) );
1168 },
1169 format: function ( s ) {
1170 var match, y;
1171 s = $.trim( s.toLowerCase() );
1173 if ( ( match = s.match( ts.dateRegex[ 0 ] ) ) !== null ) {
1174 if ( mw.config.get( 'wgDefaultDateFormat' ) === 'mdy' || mw.config.get( 'wgPageContentLanguage' ) === 'en' ) {
1175 s = [ match[ 3 ], match[ 1 ], match[ 2 ] ];
1176 } else if ( mw.config.get( 'wgDefaultDateFormat' ) === 'dmy' ) {
1177 s = [ match[ 3 ], match[ 2 ], match[ 1 ] ];
1178 } else {
1179 // If we get here, we don't know which order the dd-dd-dddd
1180 // date is in. So return something not entirely invalid.
1181 return '99999999';
1182 }
1183 } else if ( ( match = s.match( ts.dateRegex[ 1 ] ) ) !== null ) {
1184 s = [ match[ 3 ], String( ts.monthNames[ match[ 2 ] ] ), match[ 1 ] ];
1185 } else if ( ( match = s.match( ts.dateRegex[ 2 ] ) ) !== null ) {
1186 s = [ match[ 3 ], String( ts.monthNames[ match[ 1 ] ] ), match[ 2 ] ];
1187 } else {
1188 // Should never get here
1189 return '99999999';
1190 }
1192 // Pad Month and Day
1193 if ( s[ 1 ].length === 1 ) {
1194 s[ 1 ] = '0' + s[ 1 ];
1195 }
1196 if ( s[ 2 ].length === 1 ) {
1197 s[ 2 ] = '0' + s[ 2 ];
1198 }
1200 if ( ( y = parseInt( s[ 0 ], 10 ) ) < 100 ) {
1201 // Guestimate years without centuries
1202 if ( y < 30 ) {
1203 s[ 0 ] = 2000 + y;
1204 } else {
1205 s[ 0 ] = 1900 + y;
1206 }
1207 }
1208 while ( s[ 0 ].length < 4 ) {
1209 s[ 0 ] = '0' + s[ 0 ];
1210 }
1211 return parseInt( s.join( '' ), 10 );
1212 },
1213 type: 'numeric'
1214 } );
1216 ts.addParser( {
1217 id: 'time',
1218 is: function ( s ) {
1219 return ts.rgx.time[ 0 ].test( s );
1220 },
1221 format: function ( s ) {
1222 return $.tablesorter.formatFloat( new Date( '2000/01/01 ' + s ).getTime() );
1223 },
1224 type: 'numeric'
1225 } );
1227 ts.addParser( {
1228 id: 'number',
1229 is: function ( s ) {
1230 return $.tablesorter.numberRegex.test( $.trim( s ) );
1231 },
1232 format: function ( s ) {
1233 return $.tablesorter.formatDigit( s );
1234 },
1235 type: 'numeric'
1236 } );
1238 }( jQuery, mediaWiki ) );