tablesorter: Keyboard accessibility for sort headers.
[lhc/web/wiklou.git] / resources / jquery / 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, wgMonthNames, wgMonthNamesShort,
12 * wgDefaultDateFormat, wgContentLanguage)
13 * Uses 'tableSorterCollation' in mw.config (if available)
14 */
15 /**
16 *
17 * @description Create a sortable table with multi-column sorting capabilitys
18 *
19 * @example $( 'table' ).tablesorter();
20 * @desc Create a simple tablesorter interface.
21 *
22 * @example $( 'table' ).tablesorter( { sortList: [ { 0: 'desc' }, { 1: 'asc' } ] } );
23 * @desc Create a tablesorter interface initially sorting on the first and second column.
24 *
25 * @option String cssHeader ( optional ) A string of the class name to be appended
26 * to sortable tr elements in the thead of the table. Default value:
27 * "header"
28 *
29 * @option String cssAsc ( optional ) A string of the class name to be appended to
30 * sortable tr elements in the thead on a ascending sort. Default value:
31 * "headerSortUp"
32 *
33 * @option String cssDesc ( optional ) A string of the class name to be appended
34 * to sortable tr elements in the thead on a descending sort. Default
35 * value: "headerSortDown"
36 *
37 * @option String sortInitialOrder ( optional ) A string of the inital sorting
38 * order can be asc or desc. Default value: "asc"
39 *
40 * @option String sortMultisortKey ( optional ) A string of the multi-column sort
41 * key. Default value: "shiftKey"
42 *
43 * @option Boolean sortLocaleCompare ( optional ) Boolean flag indicating whatever
44 * to use String.localeCampare method or not. Set to false.
45 *
46 * @option Boolean cancelSelection ( optional ) Boolean flag indicating if
47 * tablesorter should cancel selection of the table headers text.
48 * Default value: true
49 *
50 * @option Array sortList ( optional ) An array containing objects specifying sorting.
51 * By passing more than one object, multi-sorting will be applied. Object structure:
52 * { <Integer column index>: <String 'asc' or 'desc'> }
53 * Default value: []
54 *
55 * @option Boolean debug ( optional ) Boolean flag indicating if tablesorter
56 * should display debuging information usefull for development.
57 *
58 * @event sortEnd.tablesorter: Triggered as soon as any sorting has been applied.
59 *
60 * @type jQuery
61 *
62 * @name tablesorter
63 *
64 * @cat Plugins/Tablesorter
65 *
66 * @author Christian Bach/christian.bach@polyester.se
67 */
68
69 ( function ( $, mw ) {
70 /*jshint onevar:false */
71
72 /* Local scope */
73
74 var ts,
75 parsers = [];
76
77 /* Parser utility functions */
78
79 function getParserById( name ) {
80 var len = parsers.length;
81 for ( var i = 0; i < len; i++ ) {
82 if ( parsers[i].id.toLowerCase() === name.toLowerCase() ) {
83 return parsers[i];
84 }
85 }
86 return false;
87 }
88
89 function getElementSortKey( node ) {
90 var $node = $( node ),
91 // Use data-sort-value attribute.
92 // Use data() instead of attr() so that live value changes
93 // are processed as well (bug 38152).
94 data = $node.data( 'sortValue' );
95
96 if ( data !== null && data !== undefined ) {
97 // Cast any numbers or other stuff to a string, methods
98 // like charAt, toLowerCase and split are expected.
99 return String( data );
100 } else {
101 if ( !node ) {
102 return $node.text();
103 } else if ( node.tagName.toLowerCase() === 'img' ) {
104 return $node.attr( 'alt' ) || ''; // handle undefined alt
105 } else {
106 return $.map( $.makeArray( node.childNodes ), function( elem ) {
107 // 1 is for document.ELEMENT_NODE (the constant is undefined on old browsers)
108 if ( elem.nodeType === 1 ) {
109 return getElementSortKey( elem );
110 } else {
111 return $.text( elem );
112 }
113 } ).join( '' );
114 }
115 }
116 }
117
118 function detectParserForColumn( table, rows, cellIndex ) {
119 var l = parsers.length,
120 nodeValue,
121 // Start with 1 because 0 is the fallback parser
122 i = 1,
123 rowIndex = 0,
124 concurrent = 0,
125 needed = ( rows.length > 4 ) ? 5 : rows.length;
126
127 while ( i < l ) {
128 if ( rows[rowIndex] && rows[rowIndex].cells[cellIndex] ) {
129 nodeValue = $.trim( getElementSortKey( rows[rowIndex].cells[cellIndex] ) );
130 } else {
131 nodeValue = '';
132 }
133
134 if ( nodeValue !== '') {
135 if ( parsers[i].is( nodeValue, table ) ) {
136 concurrent++;
137 rowIndex++;
138 if ( concurrent >= needed ) {
139 // Confirmed the parser for multiple cells, let's return it
140 return parsers[i];
141 }
142 } else {
143 // Check next parser, reset rows
144 i++;
145 rowIndex = 0;
146 concurrent = 0;
147 }
148 } else {
149 // Empty cell
150 rowIndex++;
151 if ( rowIndex > rows.length ) {
152 rowIndex = 0;
153 i++;
154 }
155 }
156 }
157
158 // 0 is always the generic parser (text)
159 return parsers[0];
160 }
161
162 function buildParserCache( table, $headers ) {
163 var rows = table.tBodies[0].rows,
164 sortType,
165 parsers = [];
166
167 if ( rows[0] ) {
168
169 var cells = rows[0].cells,
170 len = cells.length,
171 i, parser;
172
173 for ( i = 0; i < len; i++ ) {
174 parser = false;
175 sortType = $headers.eq( i ).data( 'sortType' );
176 if ( sortType !== undefined ) {
177 parser = getParserById( sortType );
178 }
179
180 if ( parser === false ) {
181 parser = detectParserForColumn( table, rows, i );
182 }
183
184 parsers.push( parser );
185 }
186 }
187 return parsers;
188 }
189
190 /* Other utility functions */
191
192 function buildCache( table ) {
193 var totalRows = ( table.tBodies[0] && table.tBodies[0].rows.length ) || 0,
194 totalCells = ( table.tBodies[0].rows[0] && table.tBodies[0].rows[0].cells.length ) || 0,
195 parsers = table.config.parsers,
196 cache = {
197 row: [],
198 normalized: []
199 };
200
201 for ( var i = 0; i < totalRows; ++i ) {
202
203 // Add the table data to main data array
204 var $row = $( table.tBodies[0].rows[i] ),
205 cols = [];
206
207 // if this is a child row, add it to the last row's children and
208 // continue to the next row
209 if ( $row.hasClass( table.config.cssChildRow ) ) {
210 cache.row[cache.row.length - 1] = cache.row[cache.row.length - 1].add( $row );
211 // go to the next for loop
212 continue;
213 }
214
215 cache.row.push( $row );
216
217 for ( var j = 0; j < totalCells; ++j ) {
218 cols.push( parsers[j].format( getElementSortKey( $row[0].cells[j] ), table, $row[0].cells[j] ) );
219 }
220
221 cols.push( cache.normalized.length ); // add position for rowCache
222 cache.normalized.push( cols );
223 cols = null;
224 }
225
226 return cache;
227 }
228
229 function appendToTable( table, cache ) {
230 var row = cache.row,
231 normalized = cache.normalized,
232 totalRows = normalized.length,
233 checkCell = ( normalized[0].length - 1 ),
234 fragment = document.createDocumentFragment();
235
236 for ( var i = 0; i < totalRows; i++ ) {
237 var pos = normalized[i][checkCell];
238
239 var l = row[pos].length;
240
241 for ( var j = 0; j < l; j++ ) {
242 fragment.appendChild( row[pos][j] );
243 }
244
245 }
246 table.tBodies[0].appendChild( fragment );
247
248 $( table ).trigger( 'sortEnd.tablesorter' );
249 }
250
251 /**
252 * Find all header rows in a thead-less table and put them in a <thead> tag.
253 * This only treats a row as a header row if it contains only <th>s (no <td>s)
254 * and if it is preceded entirely by header rows. The algorithm stops when
255 * it encounters the first non-header row.
256 *
257 * After this, it will look at all rows at the bottom for footer rows
258 * And place these in a tfoot using similar rules.
259 * @param $table jQuery object for a <table>
260 */
261 function emulateTHeadAndFoot( $table ) {
262 var $rows = $table.find( '> tbody > tr' );
263 if( !$table.get(0).tHead ) {
264 var $thead = $( '<thead>' );
265 $rows.each( function () {
266 if ( $(this).children( 'td' ).length > 0 ) {
267 // This row contains a <td>, so it's not a header row
268 // Stop here
269 return false;
270 }
271 $thead.append( this );
272 } );
273 $table.find(' > tbody:first').before( $thead );
274 }
275 if( !$table.get(0).tFoot ) {
276 var $tfoot = $( '<tfoot>' );
277 var len = $rows.length;
278 for ( var i = len-1; i >= 0; i-- ) {
279 if( $( $rows[i] ).children( 'td' ).length > 0 ){
280 break;
281 }
282 $tfoot.prepend( $( $rows[i] ));
283 }
284 $table.append( $tfoot );
285 }
286 }
287
288 function buildHeaders( table, msg ) {
289 var maxSeen = 0,
290 longest,
291 realCellIndex = 0,
292 $tableHeaders = $( [] ),
293 $tableRows = $( 'thead:eq(0) > tr', table );
294 if ( $tableRows.length <= 1 ) {
295 $tableHeaders = $tableRows.children( 'th' );
296 } else {
297 // We need to find the cells of the row containing the most columns
298 var rowspan,
299 i,
300 headersIndex = [];
301 $tableRows.each( function ( rowIndex ) {
302 $.each( this.cells, function( index2, cell ) {
303 rowspan = Number( cell.rowSpan );
304 for ( i = 0; i < rowspan; i++ ) {
305 if ( headersIndex[rowIndex+i] === undefined ) {
306 headersIndex[rowIndex+i] = $( [] );
307 }
308 headersIndex[rowIndex+i].push( cell );
309 }
310 } );
311 } );
312 $.each( headersIndex, function ( index, cellArray ) {
313 if ( cellArray.length >= maxSeen ) {
314 maxSeen = cellArray.length;
315 longest = index;
316 }
317 } );
318 $tableHeaders = headersIndex[longest];
319 }
320 $tableHeaders.each( function ( index ) {
321 this.column = realCellIndex;
322
323 var colspan = this.colspan;
324 colspan = colspan ? parseInt( colspan, 10 ) : 1;
325 realCellIndex += colspan;
326
327 this.order = 0;
328 this.count = 0;
329
330 if ( $( this ).is( '.unsortable' ) ) {
331 this.sortDisabled = true;
332 }
333
334 if ( !this.sortDisabled ) {
335 $( this )
336 .addClass( table.config.cssHeader )
337 .attr( 'title', msg[1] )
338 .prop( 'tabIndex', 0 ).attr( 'role', 'button' );
339 }
340
341 // add cell to headerList
342 table.config.headerList[index] = this;
343 } );
344
345 return $tableHeaders;
346
347 }
348
349 /**
350 * Sets the sort count of the columns that are not affected by the sorting to have them sorted
351 * in default (ascending) order when their header cell is clicked the next time.
352 *
353 * @param {jQuery} $headers
354 * @param {Number[][]} sortList
355 * @param {Number[][]} headerToColumns
356 */
357 function setHeadersOrder( $headers, sortList, headerToColumns ) {
358 // Loop through all headers to retrieve the indices of the columns the header spans across:
359 $.each( headerToColumns, function( headerIndex, columns ) {
360
361 $.each( columns, function( i, columnIndex ) {
362 var header = $headers[headerIndex];
363
364 if ( !isValueInArray( columnIndex, sortList ) ) {
365 // Column shall not be sorted: Reset header count and order.
366 header.order = 0;
367 header.count = 0;
368 } else {
369 // Column shall be sorted: Apply designated count and order.
370 $.each( sortList, function( j, sortColumn ) {
371 if ( sortColumn[0] === i ) {
372 header.order = sortColumn[1];
373 header.count = sortColumn[1] + 1;
374 return false;
375 }
376 } );
377 }
378 } );
379
380 } );
381 }
382
383 function isValueInArray( v, a ) {
384 var l = a.length;
385 for ( var i = 0; i < l; i++ ) {
386 if ( a[i][0] === v ) {
387 return true;
388 }
389 }
390 return false;
391 }
392
393 function setHeadersCss( table, $headers, list, css, msg, columnToHeader ) {
394 // Remove all header information and reset titles to default message
395 $headers.removeClass( css[0] ).removeClass( css[1] ).attr( 'title', msg[1] );
396
397 for ( var i = 0; i < list.length; i++ ) {
398 $headers.eq( columnToHeader[ list[i][0] ] )
399 .addClass( css[ list[i][1] ] )
400 .attr( 'title', msg[ list[i][1] ] );
401 }
402 }
403
404 function sortText( a, b ) {
405 return ( (a < b) ? -1 : ((a > b) ? 1 : 0) );
406 }
407
408 function sortTextDesc( a, b ) {
409 return ( (b < a) ? -1 : ((b > a) ? 1 : 0) );
410 }
411
412 function multisort( table, sortList, cache ) {
413 var sortFn = [];
414 var len = sortList.length;
415 for ( var i = 0; i < len; i++ ) {
416 sortFn[i] = ( sortList[i][1] ) ? sortTextDesc : sortText;
417 }
418 cache.normalized.sort( function ( array1, array2 ) {
419 var col, ret;
420 for ( var i = 0; i < len; i++ ) {
421 col = sortList[i][0];
422 ret = sortFn[i].call( this, array1[col], array2[col] );
423 if ( ret !== 0 ) {
424 return ret;
425 }
426 }
427 // Fall back to index number column to ensure stable sort
428 return sortText.call( this, array1[array1.length - 1], array2[array2.length - 1] );
429 } );
430 return cache;
431 }
432
433 function buildTransformTable() {
434 var digits = '0123456789,.'.split( '' );
435 var separatorTransformTable = mw.config.get( 'wgSeparatorTransformTable' );
436 var digitTransformTable = mw.config.get( 'wgDigitTransformTable' );
437 if ( separatorTransformTable === null || ( separatorTransformTable[0] === '' && digitTransformTable[2] === '' ) ) {
438 ts.transformTable = false;
439 } else {
440 ts.transformTable = {};
441
442 // Unpack the transform table
443 var ascii = separatorTransformTable[0].split( '\t' ).concat( digitTransformTable[0].split( '\t' ) );
444 var localised = separatorTransformTable[1].split( '\t' ).concat( digitTransformTable[1].split( '\t' ) );
445
446 // Construct regex for number identification
447 for ( var i = 0; i < ascii.length; i++ ) {
448 ts.transformTable[localised[i]] = ascii[i];
449 digits.push( $.escapeRE( localised[i] ) );
450 }
451 }
452 var digitClass = '[' + digits.join( '', digits ) + ']';
453
454 // We allow a trailing percent sign, which we just strip. This works fine
455 // if percents and regular numbers aren't being mixed.
456 ts.numberRegex = new RegExp('^(' + '[-+\u2212]?[0-9][0-9,]*(\\.[0-9,]*)?(E[-+\u2212]?[0-9][0-9,]*)?' + // Fortran-style scientific
457 '|' + '[-+\u2212]?' + digitClass + '+[\\s\\xa0]*%?' + // Generic localised
458 ')$', 'i');
459 }
460
461 function buildDateTable() {
462 var regex = [];
463 ts.monthNames = {};
464
465 for ( var i = 1; i < 13; i++ ) {
466 var name = mw.config.get( 'wgMonthNames' )[i].toLowerCase();
467 ts.monthNames[name] = i;
468 regex.push( $.escapeRE( name ) );
469 name = mw.config.get( 'wgMonthNamesShort' )[i].toLowerCase().replace( '.', '' );
470 ts.monthNames[name] = i;
471 regex.push( $.escapeRE( name ) );
472 }
473
474 // Build piped string
475 regex = regex.join( '|' );
476
477 // Build RegEx
478 // Any date formated with . , ' - or /
479 ts.dateRegex[0] = new RegExp( /^\s*(\d{1,2})[\,\.\-\/'\s]{1,2}(\d{1,2})[\,\.\-\/'\s]{1,2}(\d{2,4})\s*?/i);
480
481 // Written Month name, dmy
482 ts.dateRegex[1] = new RegExp( '^\\s*(\\d{1,2})[\\,\\.\\-\\/\'\\s]+(' + regex + ')' + '[\\,\\.\\-\\/\'\\s]+(\\d{2,4})\\s*$', 'i' );
483
484 // Written Month name, mdy
485 ts.dateRegex[2] = new RegExp( '^\\s*(' + regex + ')' + '[\\,\\.\\-\\/\'\\s]+(\\d{1,2})[\\,\\.\\-\\/\'\\s]+(\\d{2,4})\\s*$', 'i' );
486
487 }
488
489 /**
490 * Replace all rowspanned cells in the body with clones in each row, so sorting
491 * need not worry about them.
492 *
493 * @param $table jQuery object for a <table>
494 */
495 function explodeRowspans( $table ) {
496 var rowspanCells = $table.find( '> tbody > tr > [rowspan]' ).get();
497
498 // Short circuit
499 if ( !rowspanCells.length ) {
500 return;
501 }
502
503 // First, we need to make a property like cellIndex but taking into
504 // account colspans. We also cache the rowIndex to avoid having to take
505 // cell.parentNode.rowIndex in the sorting function below.
506 $table.find( '> tbody > tr' ).each( function () {
507 var col = 0;
508 var l = this.cells.length;
509 for ( var i = 0; i < l; i++ ) {
510 this.cells[i].realCellIndex = col;
511 this.cells[i].realRowIndex = this.rowIndex;
512 col += this.cells[i].colSpan;
513 }
514 } );
515
516 // Split multi row cells into multiple cells with the same content.
517 // Sort by column then row index to avoid problems with odd table structures.
518 // Re-sort whenever a rowspanned cell's realCellIndex is changed, because it
519 // might change the sort order.
520 function resortCells() {
521 rowspanCells = rowspanCells.sort( function ( a, b ) {
522 var ret = a.realCellIndex - b.realCellIndex;
523 if ( !ret ) {
524 ret = a.realRowIndex - b.realRowIndex;
525 }
526 return ret;
527 } );
528 $.each( rowspanCells, function () {
529 this.needResort = false;
530 } );
531 }
532 resortCells();
533
534 var spanningRealCellIndex, rowSpan, colSpan;
535 function filterfunc() {
536 return this.realCellIndex >= spanningRealCellIndex;
537 }
538
539 function fixTdCellIndex() {
540 this.realCellIndex += colSpan;
541 if ( this.rowSpan > 1 ) {
542 this.needResort = true;
543 }
544 }
545
546 while ( rowspanCells.length ) {
547 if ( rowspanCells[0].needResort ) {
548 resortCells();
549 }
550
551 var cell = rowspanCells.shift();
552 rowSpan = cell.rowSpan;
553 colSpan = cell.colSpan;
554 spanningRealCellIndex = cell.realCellIndex;
555 cell.rowSpan = 1;
556 var $nextRows = $( cell ).parent().nextAll();
557 for ( var i = 0; i < rowSpan - 1; i++ ) {
558 var $tds = $( $nextRows[i].cells ).filter( filterfunc );
559 var $clone = $( cell ).clone();
560 $clone[0].realCellIndex = spanningRealCellIndex;
561 if ( $tds.length ) {
562 $tds.each( fixTdCellIndex );
563 $tds.first().before( $clone );
564 } else {
565 $nextRows.eq( i ).append( $clone );
566 }
567 }
568 }
569 }
570
571 function buildCollationTable() {
572 ts.collationTable = mw.config.get( 'tableSorterCollation' );
573 ts.collationRegex = null;
574 if ( ts.collationTable ) {
575 var keys = [];
576
577 // Build array of key names
578 for ( var key in ts.collationTable ) {
579 if ( ts.collationTable.hasOwnProperty(key) ) { //to be safe
580 keys.push(key);
581 }
582 }
583 if (keys.length) {
584 ts.collationRegex = new RegExp( '[' + keys.join( '' ) + ']', 'ig' );
585 }
586 }
587 }
588
589 function cacheRegexs() {
590 if ( ts.rgx ) {
591 return;
592 }
593 ts.rgx = {
594 IPAddress: [
595 new RegExp( /^\d{1,3}[\.]\d{1,3}[\.]\d{1,3}[\.]\d{1,3}$/)
596 ],
597 currency: [
598 new RegExp( /(^[£$€¥]|[£$€¥]$)/),
599 new RegExp( /[£$€¥]/g)
600 ],
601 url: [
602 new RegExp( /^(https?|ftp|file):\/\/$/),
603 new RegExp( /(https?|ftp|file):\/\//)
604 ],
605 isoDate: [
606 new RegExp( /^\d{4}[\/\-]\d{1,2}[\/\-]\d{1,2}$/)
607 ],
608 usLongDate: [
609 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)))$/)
610 ],
611 time: [
612 new RegExp( /^(([0-2]?[0-9]:[0-5][0-9])|([0-1]?[0-9]:[0-5][0-9]\s(am|pm)))$/)
613 ]
614 };
615 }
616
617 /**
618 * Converts sort objects [ { Integer: String }, ... ] to the internally used nested array
619 * structure [ [ Integer , Integer ], ... ]
620 *
621 * @param sortObjects {Array} List of sort objects.
622 * @return {Array} List of internal sort definitions.
623 */
624
625 function convertSortList( sortObjects ) {
626 var sortList = [];
627 $.each( sortObjects, function( i, sortObject ) {
628 $.each ( sortObject, function( columnIndex, order ) {
629 var orderIndex = ( order === 'desc' ) ? 1 : 0;
630 sortList.push( [parseInt( columnIndex, 10 ), orderIndex] );
631 } );
632 } );
633 return sortList;
634 }
635
636 /* Public scope */
637
638 $.tablesorter = {
639
640 defaultOptions: {
641 cssHeader: 'headerSort',
642 cssAsc: 'headerSortUp',
643 cssDesc: 'headerSortDown',
644 cssChildRow: 'expand-child',
645 sortInitialOrder: 'asc',
646 sortMultiSortKey: 'shiftKey',
647 sortLocaleCompare: false,
648 parsers: {},
649 widgets: [],
650 headers: {},
651 cancelSelection: true,
652 sortList: [],
653 headerList: [],
654 selectorHeaders: 'thead tr:eq(0) th',
655 debug: false
656 },
657
658 dateRegex: [],
659 monthNames: {},
660
661 /**
662 * @param $tables {jQuery}
663 * @param settings {Object} (optional)
664 */
665 construct: function ( $tables, settings ) {
666 return $tables.each( function ( i, table ) {
667 // Declare and cache.
668 var $headers, cache, config,
669 headerToColumns, columnToHeader, colspanOffset,
670 $table = $( table ),
671 firstTime = true;
672
673 // Quit if no tbody
674 if ( !table.tBodies ) {
675 return;
676 }
677 if ( !table.tHead ) {
678 // No thead found. Look for rows with <th>s and
679 // move them into a <thead> tag or a <tfoot> tag
680 emulateTHeadAndFoot( $table );
681
682 // Still no thead? Then quit
683 if ( !table.tHead ) {
684 return;
685 }
686 }
687 $table.addClass( 'jquery-tablesorter' );
688
689 // FIXME config should probably not be stored in the plain table node
690 // New config object.
691 table.config = {};
692
693 // Merge and extend.
694 config = $.extend( table.config, $.tablesorter.defaultOptions, settings );
695
696 // Save the settings where they read
697 $.data( table, 'tablesorter', { config: config } );
698
699 // Get the CSS class names, could be done else where.
700 var sortCSS = [ config.cssDesc, config.cssAsc ];
701 var sortMsg = [ mw.msg( 'sort-descending' ), mw.msg( 'sort-ascending' ) ];
702
703 // Build headers
704 $headers = buildHeaders( table, sortMsg );
705
706 // Grab and process locale settings
707 buildTransformTable();
708 buildDateTable();
709 buildCollationTable();
710
711 // Precaching regexps can bring 10 fold
712 // performance improvements in some browsers.
713 cacheRegexs();
714
715 function setupForFirstSort() {
716 firstTime = false;
717
718 // Legacy fix of .sortbottoms
719 // Wrap them inside inside a tfoot (because that's what they actually want to be) &
720 // and put the <tfoot> at the end of the <table>
721 var $sortbottoms = $table.find( '> tbody > tr.sortbottom' );
722 if ( $sortbottoms.length ) {
723 var $tfoot = $table.children( 'tfoot' );
724 if ( $tfoot.length ) {
725 $tfoot.eq(0).prepend( $sortbottoms );
726 } else {
727 $table.append( $( '<tfoot>' ).append( $sortbottoms ) );
728 }
729 }
730
731 explodeRowspans( $table );
732
733 // try to auto detect column type, and store in tables config
734 table.config.parsers = buildParserCache( table, $headers );
735 }
736
737 // as each header can span over multiple columns (using colspan=N),
738 // we have to bidirectionally map headers to their columns and columns to their headers
739 headerToColumns = [];
740 columnToHeader = [];
741 colspanOffset = 0;
742 $headers.each( function ( headerIndex ) {
743 var columns = [];
744 for ( var i = 0; i < this.colSpan; i++ ) {
745 columnToHeader[ colspanOffset + i ] = headerIndex;
746 columns.push( colspanOffset + i );
747 }
748
749 headerToColumns[ headerIndex ] = columns;
750 colspanOffset += this.colSpan;
751 } );
752
753 // Apply event handling to headers
754 // this is too big, perhaps break it out?
755 $headers.filter( ':not(.unsortable)' ).on( 'keypress click', function ( e ) {
756 if ( e.type === 'click' && e.target.nodeName.toLowerCase() === 'a' ) {
757 // The user clicked on a link inside a table header.
758 // Do nothing and let the default link click action continue.
759 return true;
760 }
761
762 if ( e.type === 'keypress' && e.which !== 13 ) {
763 // Only handle keypresses on the "Enter" key.
764 return true;
765 }
766
767 if ( firstTime ) {
768 setupForFirstSort();
769 }
770
771 // Build the cache for the tbody cells
772 // to share between calculations for this sort action.
773 // Re-calculated each time a sort action is performed due to possiblity
774 // that sort values change. Shouldn't be too expensive, but if it becomes
775 // too slow an event based system should be implemented somehow where
776 // cells get event .change() and bubbles up to the <table> here
777 cache = buildCache( table );
778
779 var totalRows = ( $table[0].tBodies[0] && $table[0].tBodies[0].rows.length ) || 0;
780 if ( !table.sortDisabled && totalRows > 0 ) {
781 // Get current column sort order
782 this.order = this.count % 2;
783 this.count++;
784
785 var cell = this;
786 // Get current column index
787 var columns = headerToColumns[this.column];
788 var newSortList = $.map( columns, function (c) {
789 // jQuery "helpfully" flattens the arrays...
790 return [[c, cell.order]];
791 });
792 // Index of first column belonging to this header
793 var i = columns[0];
794
795 if ( !e[config.sortMultiSortKey] ) {
796 // User only wants to sort on one column set
797 // Flush the sort list and add new columns
798 config.sortList = newSortList;
799 } else {
800 // Multi column sorting
801 // It is not possible for one column to belong to multiple headers,
802 // so this is okay - we don't need to check for every value in the columns array
803 if ( isValueInArray( i, config.sortList ) ) {
804 // The user has clicked on an already sorted column.
805 // Reverse the sorting direction for all tables.
806 for ( var j = 0; j < config.sortList.length; j++ ) {
807 var s = config.sortList[j],
808 o = config.headerList[s[0]];
809 if ( isValueInArray( s[0], newSortList ) ) {
810 o.count = s[1];
811 o.count++;
812 s[1] = o.count % 2;
813 }
814 }
815 } else {
816 // Add columns to sort list array
817 config.sortList = config.sortList.concat( newSortList );
818 }
819 }
820
821 // Reset order/counts of cells not affected by sorting
822 setHeadersOrder( $headers, config.sortList, headerToColumns );
823
824 // Set CSS for headers
825 setHeadersCss( $table[0], $headers, config.sortList, sortCSS, sortMsg, columnToHeader );
826 appendToTable(
827 $table[0], multisort( $table[0], config.sortList, cache )
828 );
829
830 // Stop normal event by returning false
831 return false;
832 }
833
834 // Cancel selection
835 } ).mousedown( function () {
836 if ( config.cancelSelection ) {
837 this.onselectstart = function () {
838 return false;
839 };
840 return false;
841 }
842 } );
843
844 /**
845 * Sorts the table. If no sorting is specified by passing a list of sort
846 * objects, the table is sorted according to the initial sorting order.
847 * Passing an empty array will reset sorting (basically just reset the headers
848 * making the table appear unsorted).
849 *
850 * @param sortList {Array} (optional) List of sort objects.
851 */
852 $table.data( 'tablesorter' ).sort = function( sortList ) {
853
854 if ( firstTime ) {
855 setupForFirstSort();
856 }
857
858 if ( sortList === undefined ) {
859 sortList = config.sortList;
860 } else if ( sortList.length > 0 ) {
861 sortList = convertSortList( sortList );
862 }
863
864 // Set each column's sort count to be able to determine the correct sort
865 // order when clicking on a header cell the next time
866 setHeadersOrder( $headers, sortList, headerToColumns );
867
868 // re-build the cache for the tbody cells
869 cache = buildCache( table );
870
871 // set css for headers
872 setHeadersCss( table, $headers, sortList, sortCSS, sortMsg, columnToHeader );
873
874 // sort the table and append it to the dom
875 appendToTable( table, multisort( table, sortList, cache ) );
876 };
877
878 // sort initially
879 if ( config.sortList.length > 0 ) {
880 setupForFirstSort();
881 config.sortList = convertSortList( config.sortList );
882 $table.data( 'tablesorter' ).sort();
883 }
884
885 } );
886 },
887
888 addParser: function ( parser ) {
889 var l = parsers.length,
890 a = true;
891 for ( var i = 0; i < l; i++ ) {
892 if ( parsers[i].id.toLowerCase() === parser.id.toLowerCase() ) {
893 a = false;
894 }
895 }
896 if ( a ) {
897 parsers.push( parser );
898 }
899 },
900
901 formatDigit: function ( s ) {
902 var out, c, p, i;
903 if ( ts.transformTable !== false ) {
904 out = '';
905 for ( p = 0; p < s.length; p++ ) {
906 c = s.charAt(p);
907 if ( c in ts.transformTable ) {
908 out += ts.transformTable[c];
909 } else {
910 out += c;
911 }
912 }
913 s = out;
914 }
915 i = parseFloat( s.replace( /[, ]/g, '' ).replace( '\u2212', '-' ) );
916 return isNaN( i ) ? 0 : i;
917 },
918
919 formatFloat: function ( s ) {
920 var i = parseFloat(s);
921 return isNaN( i ) ? 0 : i;
922 },
923
924 formatInt: function ( s ) {
925 var i = parseInt( s, 10 );
926 return isNaN( i ) ? 0 : i;
927 },
928
929 clearTableBody: function ( table ) {
930 $( table.tBodies[0] ).empty();
931 }
932 };
933
934 // Shortcut
935 ts = $.tablesorter;
936
937 // Register as jQuery prototype method
938 $.fn.tablesorter = function ( settings ) {
939 return ts.construct( this, settings );
940 };
941
942 // Add default parsers
943 ts.addParser( {
944 id: 'text',
945 is: function () {
946 return true;
947 },
948 format: function ( s ) {
949 s = $.trim( s.toLowerCase() );
950 if ( ts.collationRegex ) {
951 var tsc = ts.collationTable;
952 s = s.replace( ts.collationRegex, function ( match ) {
953 var r = tsc[match] ? tsc[match] : tsc[match.toUpperCase()];
954 return r.toLowerCase();
955 } );
956 }
957 return s;
958 },
959 type: 'text'
960 } );
961
962 ts.addParser( {
963 id: 'IPAddress',
964 is: function ( s ) {
965 return ts.rgx.IPAddress[0].test(s);
966 },
967 format: function ( s ) {
968 var a = s.split( '.' ),
969 r = '',
970 l = a.length;
971 for ( var i = 0; i < l; i++ ) {
972 var item = a[i];
973 if ( item.length === 1 ) {
974 r += '00' + item;
975 } else if ( item.length === 2 ) {
976 r += '0' + item;
977 } else {
978 r += item;
979 }
980 }
981 return $.tablesorter.formatFloat(r);
982 },
983 type: 'numeric'
984 } );
985
986 ts.addParser( {
987 id: 'currency',
988 is: function ( s ) {
989 return ts.rgx.currency[0].test(s);
990 },
991 format: function ( s ) {
992 return $.tablesorter.formatDigit( s.replace( ts.rgx.currency[1], '' ) );
993 },
994 type: 'numeric'
995 } );
996
997 ts.addParser( {
998 id: 'url',
999 is: function ( s ) {
1000 return ts.rgx.url[0].test(s);
1001 },
1002 format: function ( s ) {
1003 return $.trim( s.replace( ts.rgx.url[1], '' ) );
1004 },
1005 type: 'text'
1006 } );
1007
1008 ts.addParser( {
1009 id: 'isoDate',
1010 is: function ( s ) {
1011 return ts.rgx.isoDate[0].test(s);
1012 },
1013 format: function ( s ) {
1014 return $.tablesorter.formatFloat((s !== '') ? new Date(s.replace(
1015 new RegExp( /-/g), '/')).getTime() : '0' );
1016 },
1017 type: 'numeric'
1018 } );
1019
1020 ts.addParser( {
1021 id: 'usLongDate',
1022 is: function ( s ) {
1023 return ts.rgx.usLongDate[0].test(s);
1024 },
1025 format: function ( s ) {
1026 return $.tablesorter.formatFloat( new Date(s).getTime() );
1027 },
1028 type: 'numeric'
1029 } );
1030
1031 ts.addParser( {
1032 id: 'date',
1033 is: function ( s ) {
1034 return ( ts.dateRegex[0].test(s) || ts.dateRegex[1].test(s) || ts.dateRegex[2].test(s ));
1035 },
1036 format: function ( s ) {
1037 var match;
1038 s = $.trim( s.toLowerCase() );
1039
1040 if ( ( match = s.match( ts.dateRegex[0] ) ) !== null ) {
1041 if ( mw.config.get( 'wgDefaultDateFormat' ) === 'mdy' || mw.config.get( 'wgContentLanguage' ) === 'en' ) {
1042 s = [ match[3], match[1], match[2] ];
1043 } else if ( mw.config.get( 'wgDefaultDateFormat' ) === 'dmy' ) {
1044 s = [ match[3], match[2], match[1] ];
1045 } else {
1046 // If we get here, we don't know which order the dd-dd-dddd
1047 // date is in. So return something not entirely invalid.
1048 return '99999999';
1049 }
1050 } else if ( ( match = s.match( ts.dateRegex[1] ) ) !== null ) {
1051 s = [ match[3], '' + ts.monthNames[match[2]], match[1] ];
1052 } else if ( ( match = s.match( ts.dateRegex[2] ) ) !== null ) {
1053 s = [ match[3], '' + ts.monthNames[match[1]], match[2] ];
1054 } else {
1055 // Should never get here
1056 return '99999999';
1057 }
1058
1059 // Pad Month and Day
1060 if ( s[1].length === 1 ) {
1061 s[1] = '0' + s[1];
1062 }
1063 if ( s[2].length === 1 ) {
1064 s[2] = '0' + s[2];
1065 }
1066
1067 var y;
1068 if ( ( y = parseInt( s[0], 10) ) < 100 ) {
1069 // Guestimate years without centuries
1070 if ( y < 30 ) {
1071 s[0] = 2000 + y;
1072 } else {
1073 s[0] = 1900 + y;
1074 }
1075 }
1076 while ( s[0].length < 4 ) {
1077 s[0] = '0' + s[0];
1078 }
1079 return parseInt( s.join( '' ), 10 );
1080 },
1081 type: 'numeric'
1082 } );
1083
1084 ts.addParser( {
1085 id: 'time',
1086 is: function ( s ) {
1087 return ts.rgx.time[0].test(s);
1088 },
1089 format: function ( s ) {
1090 return $.tablesorter.formatFloat( new Date( '2000/01/01 ' + s ).getTime() );
1091 },
1092 type: 'numeric'
1093 } );
1094
1095 ts.addParser( {
1096 id: 'number',
1097 is: function ( s ) {
1098 return $.tablesorter.numberRegex.test( $.trim( s ));
1099 },
1100 format: function ( s ) {
1101 return $.tablesorter.formatDigit(s);
1102 },
1103 type: 'numeric'
1104 } );
1105
1106 }( jQuery, mediaWiki ) );