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