Expected:	" + + escapeText( expected ) + + "
Result:	" + + escapeText( actual ) + "
Diff:	" + + diff + "
Message:	" + + "Diff suppressed as the depth of object is more than current max depth (" + + QUnit.config.maxDepth + "). Hint: Use `QUnit.dump.maxDepth` to " + + " run with a higher max depth or " + + "Rerun without max depth.
Message:	" + + "Diff suppressed as the expected and actual results have an equivalent" + + " serialization
Source:	" + + escapeText( details.source ) + "

Source:	" + + escapeText( details.source ) + "

Expected:	" + - expected + - "
Result:	" + - actual + "
Diff:	" + - diff + "
Message:	" + - "Diff suppressed as the depth of object is more than current max depth (" + - QUnit.config.maxDepth + "). Hint: Use `QUnit.dump.maxDepth` to " + - " run with a higher max depth or " + - "Rerun without max depth.
Source:	" + - escapeText( details.source ) + "

Source:	" + - escapeText( details.source ) + "

' ).addClass( 'mw-spinner' ).attr( 'title', '...' ); + $spinner = $( '

' ).addClass( 'mw-spinner' ).attr( 'title', '...' ); if ( opts.id !== undefined ) { $spinner.attr( 'id', 'mw-spinner-' + opts.id ); } diff --git a/resources/src/jquery/jquery.suggestions.js b/resources/src/jquery/jquery.suggestions.js index 884ecb6e96..f3e4e09313 100644 --- a/resources/src/jquery/jquery.suggestions.js +++ b/resources/src/jquery/jquery.suggestions.js @@ -353,7 +353,6 @@ $results.empty(); expWidth = -1; for ( i = 0; i < context.config.suggestions.length; i++ ) { - /*jshint loopfunc:true */ text = context.config.suggestions[ i ]; $result = $( '

' ) .addClass( 'suggestions-result' ) @@ -758,9 +757,9 @@ 46, // delete 8 // backspace ]; - if ( context.data.keypressedCount === 0 - && e.which === context.data.keypressed - && $.inArray( e.which, allowed ) !== -1 + if ( context.data.keypressedCount === 0 && + e.which === context.data.keypressed && + $.inArray( e.which, allowed ) !== -1 ) { $.suggestions.keypress( e, context, context.data.keypressed ); } diff --git a/resources/src/jquery/jquery.tablesorter.js b/resources/src/jquery/jquery.tablesorter.js index 62be0d8c4a..4da05e63ef 100644 --- a/resources/src/jquery/jquery.tablesorter.js +++ b/resources/src/jquery/jquery.tablesorter.js @@ -407,8 +407,8 @@ * in default (ascending) order when their header cell is clicked the next time. * * @param {jQuery} $headers - * @param {number[][]} sortList - * @param {number[][]} headerToColumns + * @param {Array} sortList 2D number array + * @param {Array} headerToColumns 2D number array */ function setHeadersOrder( $headers, sortList, headerToColumns ) { // Loop through all headers to retrieve the indices of the columns the header spans across: @@ -442,10 +442,11 @@ } function setHeadersCss( table, $headers, list, css, msg, columnToHeader ) { + var i, len; // Remove all header information and reset titles to default message $headers.removeClass( css[ 0 ] ).removeClass( css[ 1 ] ).attr( 'title', msg[ 1 ] ); - for ( var i = 0; i < list.length; i++ ) { + for ( i = 0, len = list.length; i < len; i++ ) { $headers .eq( columnToHeader[ list[ i ][ 0 ] ] ) .addClass( css[ list[ i ][ 1 ] ] ) @@ -686,12 +687,10 @@ } function buildCollationTable() { + var key, keys = []; ts.collationTable = mw.config.get( 'tableSorterCollation' ); ts.collationRegex = null; if ( ts.collationTable ) { - var key, - keys = []; - // Build array of key names for ( key in ts.collationTable ) { // Check hasOwn to be safe @@ -755,298 +754,300 @@ /* Public scope */ $.tablesorter = { - defaultOptions: { - cssHeader: 'headerSort', - cssAsc: 'headerSortUp', - cssDesc: 'headerSortDown', - cssChildRow: 'expand-child', - sortMultiSortKey: 'shiftKey', - unsortableClass: 'unsortable', - parsers: [], - cancelSelection: true, - sortList: [], - headerList: [], - headerToColumns: [], - columnToHeader: [], - columns: 0 - }, - - dateRegex: [], - monthNames: {}, - - /** - * @param {jQuery} $tables - * @param {Object} [settings] - */ - construct: function ( $tables, settings ) { - return $tables.each( function ( i, table ) { - // Declare and cache. - var $headers, cache, config, sortCSS, sortMsg, - $table = $( table ), - firstTime = true; - - // Quit if no tbody - if ( !table.tBodies ) { + defaultOptions: { + cssHeader: 'headerSort', + cssAsc: 'headerSortUp', + cssDesc: 'headerSortDown', + cssChildRow: 'expand-child', + sortMultiSortKey: 'shiftKey', + unsortableClass: 'unsortable', + parsers: [], + cancelSelection: true, + sortList: [], + headerList: [], + headerToColumns: [], + columnToHeader: [], + columns: 0 + }, + + dateRegex: [], + monthNames: {}, + + /** + * @param {jQuery} $tables + * @param {Object} [settings] + * @return {jQuery} + */ + construct: function ( $tables, settings ) { + return $tables.each( function ( i, table ) { + // Declare and cache. + var $headers, cache, config, sortCSS, sortMsg, + $table = $( table ), + firstTime = true; + + // Quit if no tbody + if ( !table.tBodies ) { + return; + } + if ( !table.tHead ) { + // No thead found. Look for rows with s and + // move them into a tag or a tag + emulateTHeadAndFoot( $table ); + + // Still no thead? Then quit + if ( !table.tHead ) { return; } - if ( !table.tHead ) { - // No thead found. Look for rows with s and - // move them into a tag or a tag - emulateTHeadAndFoot( $table ); + } + $table.addClass( 'jquery-tablesorter' ); - // Still no thead? Then quit - if ( !table.tHead ) { - return; - } - } - $table.addClass( 'jquery-tablesorter' ); - - // Merge and extend - config = $.extend( {}, $.tablesorter.defaultOptions, settings ); - - // Save the settings where they read - $.data( table, 'tablesorter', { config: config } ); - - // Get the CSS class names, could be done elsewhere - sortCSS = [ config.cssAsc, config.cssDesc ]; - // Messages tell the the user what the *next* state will be - // so are in reverse order to the CSS classes. - sortMsg = [ mw.msg( 'sort-descending' ), mw.msg( 'sort-ascending' ) ]; - - // Build headers - $headers = buildHeaders( table, sortMsg ); - - // Grab and process locale settings. - buildTransformTable(); - buildDateTable(); - - // Precaching regexps can bring 10 fold - // performance improvements in some browsers. - cacheRegexs(); - - function setupForFirstSort() { - firstTime = false; - - // Defer buildCollationTable to first sort. As user and site scripts - // may customize tableSorterCollation but load after $.ready(), other - // scripts may call .tablesorter() before they have done the - // tableSorterCollation customizations. - buildCollationTable(); - - // Legacy fix of .sortbottoms - // Wrap them inside a tfoot (because that's what they actually want to be) - // and put the at the end of the - var $tfoot, - $sortbottoms = $table.find( '> tbody > tr.sortbottom' ); - if ( $sortbottoms.length ) { - $tfoot = $table.children( 'tfoot' ); - if ( $tfoot.length ) { - $tfoot.eq( 0 ).prepend( $sortbottoms ); - } else { - $table.append( $( '' ).append( $sortbottoms ) ); - } - } + // Merge and extend + config = $.extend( {}, $.tablesorter.defaultOptions, settings ); - explodeRowspans( $table ); - manageColspans( $table ); + // Save the settings where they read + $.data( table, 'tablesorter', { config: config } ); - // Try to auto detect column type, and store in tables config - config.parsers = buildParserCache( table, $headers ); - } + // Get the CSS class names, could be done elsewhere + sortCSS = [ config.cssAsc, config.cssDesc ]; + // Messages tell the the user what the *next* state will be + // so are in reverse order to the CSS classes. + sortMsg = [ mw.msg( 'sort-descending' ), mw.msg( 'sort-ascending' ) ]; - // Apply event handling to headers - // this is too big, perhaps break it out? - $headers.on( 'keypress click', function ( e ) { - var cell, $cell, columns, newSortList, i, - totalRows, - j, s, o; - - if ( e.type === 'click' && e.target.nodeName.toLowerCase() === 'a' ) { - // The user clicked on a link inside a table header. - // Do nothing and let the default link click action continue. - return true; - } + // Build headers + $headers = buildHeaders( table, sortMsg ); - if ( e.type === 'keypress' && e.which !== 13 ) { - // Only handle keypresses on the "Enter" key. - return true; - } + // Grab and process locale settings. + buildTransformTable(); + buildDateTable(); - if ( firstTime ) { - setupForFirstSort(); + // Precaching regexps can bring 10 fold + // performance improvements in some browsers. + cacheRegexs(); + + function setupForFirstSort() { + var $tfoot, $sortbottoms; + + firstTime = false; + + // Defer buildCollationTable to first sort. As user and site scripts + // may customize tableSorterCollation but load after $.ready(), other + // scripts may call .tablesorter() before they have done the + // tableSorterCollation customizations. + buildCollationTable(); + + // Legacy fix of .sortbottoms + // Wrap them inside a tfoot (because that's what they actually want to be) + // and put the at the end of the

+ $sortbottoms = $table.find( '> tbody > tr.sortbottom' ); + if ( $sortbottoms.length ) { + $tfoot = $table.children( 'tfoot' ); + if ( $tfoot.length ) { + $tfoot.eq( 0 ).prepend( $sortbottoms ); + } else { + $table.append( $( '' ).append( $sortbottoms ) ); } + } - // Build the cache for the tbody cells - // to share between calculations for this sort action. - // Re-calculated each time a sort action is performed due to possiblity - // that sort values change. Shouldn't be too expensive, but if it becomes - // too slow an event based system should be implemented somehow where - // cells get event .change() and bubbles up to the

here - cache = buildCache( table ); - - totalRows = ( $table[ 0 ].tBodies[ 0 ] && $table[ 0 ].tBodies[ 0 ].rows.length ) || 0; - if ( totalRows > 0 ) { - cell = this; - $cell = $( cell ); - - // Get current column sort order - $cell.data( { - order: $cell.data( 'count' ) % 2, - count: $cell.data( 'count' ) + 1 - } ); + explodeRowspans( $table ); + manageColspans( $table ); - cell = this; - // Get current column index - columns = config.headerToColumns[ $cell.data( 'headerIndex' ) ]; - newSortList = $.map( columns, function ( c ) { - // jQuery "helpfully" flattens the arrays... - return [ [ c, $cell.data( 'order' ) ] ]; - } ); - // Index of first column belonging to this header - i = columns[ 0 ]; + // Try to auto detect column type, and store in tables config + config.parsers = buildParserCache( table, $headers ); + } - if ( !e[ config.sortMultiSortKey ] ) { - // User only wants to sort on one column set - // Flush the sort list and add new columns - config.sortList = newSortList; - } else { - // Multi column sorting - // It is not possible for one column to belong to multiple headers, - // so this is okay - we don't need to check for every value in the columns array - if ( isValueInArray( i, config.sortList ) ) { - // The user has clicked on an already sorted column. - // Reverse the sorting direction for all tables. - for ( j = 0; j < config.sortList.length; j++ ) { - s = config.sortList[ j ]; - o = config.headerList[ config.columnToHeader[ s[ 0 ] ] ]; - if ( isValueInArray( s[ 0 ], newSortList ) ) { - $( o ).data( 'count', s[ 1 ] + 1 ); - s[ 1 ] = $( o ).data( 'count' ) % 2; - } + // Apply event handling to headers + // this is too big, perhaps break it out? + $headers.on( 'keypress click', function ( e ) { + var cell, $cell, columns, newSortList, i, + totalRows, + j, s, o; + + if ( e.type === 'click' && e.target.nodeName.toLowerCase() === 'a' ) { + // The user clicked on a link inside a table header. + // Do nothing and let the default link click action continue. + return true; + } + + if ( e.type === 'keypress' && e.which !== 13 ) { + // Only handle keypresses on the "Enter" key. + return true; + } + + if ( firstTime ) { + setupForFirstSort(); + } + + // Build the cache for the tbody cells + // to share between calculations for this sort action. + // Re-calculated each time a sort action is performed due to possiblity + // that sort values change. Shouldn't be too expensive, but if it becomes + // too slow an event based system should be implemented somehow where + // cells get event .change() and bubbles up to the

here + cache = buildCache( table ); + + totalRows = ( $table[ 0 ].tBodies[ 0 ] && $table[ 0 ].tBodies[ 0 ].rows.length ) || 0; + if ( totalRows > 0 ) { + cell = this; + $cell = $( cell ); + + // Get current column sort order + $cell.data( { + order: $cell.data( 'count' ) % 2, + count: $cell.data( 'count' ) + 1 + } ); + + cell = this; + // Get current column index + columns = config.headerToColumns[ $cell.data( 'headerIndex' ) ]; + newSortList = $.map( columns, function ( c ) { + // jQuery "helpfully" flattens the arrays... + return [ [ c, $cell.data( 'order' ) ] ]; + } ); + // Index of first column belonging to this header + i = columns[ 0 ]; + + if ( !e[ config.sortMultiSortKey ] ) { + // User only wants to sort on one column set + // Flush the sort list and add new columns + config.sortList = newSortList; + } else { + // Multi column sorting + // It is not possible for one column to belong to multiple headers, + // so this is okay - we don't need to check for every value in the columns array + if ( isValueInArray( i, config.sortList ) ) { + // The user has clicked on an already sorted column. + // Reverse the sorting direction for all tables. + for ( j = 0; j < config.sortList.length; j++ ) { + s = config.sortList[ j ]; + o = config.headerList[ config.columnToHeader[ s[ 0 ] ] ]; + if ( isValueInArray( s[ 0 ], newSortList ) ) { + $( o ).data( 'count', s[ 1 ] + 1 ); + s[ 1 ] = $( o ).data( 'count' ) % 2; } - } else { - // Add columns to sort list array - config.sortList = config.sortList.concat( newSortList ); } + } else { + // Add columns to sort list array + config.sortList = config.sortList.concat( newSortList ); } + } - // Reset order/counts of cells not affected by sorting - setHeadersOrder( $headers, config.sortList, config.headerToColumns ); + // Reset order/counts of cells not affected by sorting + setHeadersOrder( $headers, config.sortList, config.headerToColumns ); - // Set CSS for headers - setHeadersCss( $table[ 0 ], $headers, config.sortList, sortCSS, sortMsg, config.columnToHeader ); - appendToTable( - $table[ 0 ], multisort( $table[ 0 ], config.sortList, cache ) - ); + // Set CSS for headers + setHeadersCss( $table[ 0 ], $headers, config.sortList, sortCSS, sortMsg, config.columnToHeader ); + appendToTable( + $table[ 0 ], multisort( $table[ 0 ], config.sortList, cache ) + ); - // Stop normal event by returning false - return false; - } + // Stop normal event by returning false + return false; + } - // Cancel selection - } ).mousedown( function () { - if ( config.cancelSelection ) { - this.onselectstart = function () { - return false; - }; + // Cancel selection + } ).mousedown( function () { + if ( config.cancelSelection ) { + this.onselectstart = function () { return false; - } - } ); + }; + return false; + } + } ); - /** - * Sorts the table. If no sorting is specified by passing a list of sort - * objects, the table is sorted according to the initial sorting order. - * Passing an empty array will reset sorting (basically just reset the headers - * making the table appear unsorted). - * - * @param {Array} [sortList] List of sort objects. - */ - $table.data( 'tablesorter' ).sort = function ( sortList ) { - - if ( firstTime ) { - setupForFirstSort(); - } + /** + * Sorts the table. If no sorting is specified by passing a list of sort + * objects, the table is sorted according to the initial sorting order. + * Passing an empty array will reset sorting (basically just reset the headers + * making the table appear unsorted). + * + * @param {Array} [sortList] List of sort objects. + */ + $table.data( 'tablesorter' ).sort = function ( sortList ) { + + if ( firstTime ) { + setupForFirstSort(); + } - if ( sortList === undefined ) { - sortList = config.sortList; - } else if ( sortList.length > 0 ) { - sortList = convertSortList( sortList ); - } + if ( sortList === undefined ) { + sortList = config.sortList; + } else if ( sortList.length > 0 ) { + sortList = convertSortList( sortList ); + } - // Set each column's sort count to be able to determine the correct sort - // order when clicking on a header cell the next time - setHeadersOrder( $headers, sortList, config.headerToColumns ); + // Set each column's sort count to be able to determine the correct sort + // order when clicking on a header cell the next time + setHeadersOrder( $headers, sortList, config.headerToColumns ); - // re-build the cache for the tbody cells - cache = buildCache( table ); + // re-build the cache for the tbody cells + cache = buildCache( table ); - // set css for headers - setHeadersCss( table, $headers, sortList, sortCSS, sortMsg, config.columnToHeader ); + // set css for headers + setHeadersCss( table, $headers, sortList, sortCSS, sortMsg, config.columnToHeader ); - // sort the table and append it to the dom - appendToTable( table, multisort( table, sortList, cache ) ); - }; + // sort the table and append it to the dom + appendToTable( table, multisort( table, sortList, cache ) ); + }; - // sort initially - if ( config.sortList.length > 0 ) { - config.sortList = convertSortList( config.sortList ); - $table.data( 'tablesorter' ).sort(); - } + // sort initially + if ( config.sortList.length > 0 ) { + config.sortList = convertSortList( config.sortList ); + $table.data( 'tablesorter' ).sort(); + } - } ); - }, + } ); + }, - addParser: function ( parser ) { - if ( !getParserById( parser.id ) ) { - parsers.push( parser ); - } - }, - - formatDigit: function ( s ) { - var out, c, p, i; - if ( ts.transformTable !== false ) { - out = ''; - for ( p = 0; p < s.length; p++ ) { - c = s.charAt( p ); - if ( c in ts.transformTable ) { - out += ts.transformTable[ c ]; - } else { - out += c; - } + addParser: function ( parser ) { + if ( !getParserById( parser.id ) ) { + parsers.push( parser ); + } + }, + + formatDigit: function ( s ) { + var out, c, p, i; + if ( ts.transformTable !== false ) { + out = ''; + for ( p = 0; p < s.length; p++ ) { + c = s.charAt( p ); + if ( c in ts.transformTable ) { + out += ts.transformTable[ c ]; + } else { + out += c; } - s = out; } - i = parseFloat( s.replace( /[, ]/g, '' ).replace( '\u2212', '-' ) ); - return isNaN( i ) ? 0 : i; - }, + s = out; + } + i = parseFloat( s.replace( /[, ]/g, '' ).replace( '\u2212', '-' ) ); + return isNaN( i ) ? 0 : i; + }, - formatFloat: function ( s ) { - var i = parseFloat( s ); - return isNaN( i ) ? 0 : i; - }, + formatFloat: function ( s ) { + var i = parseFloat( s ); + return isNaN( i ) ? 0 : i; + }, - formatInt: function ( s ) { - var i = parseInt( s, 10 ); - return isNaN( i ) ? 0 : i; - }, + formatInt: function ( s ) { + var i = parseInt( s, 10 ); + return isNaN( i ) ? 0 : i; + }, - clearTableBody: function ( table ) { - $( table.tBodies[ 0 ] ).empty(); - }, + clearTableBody: function ( table ) { + $( table.tBodies[ 0 ] ).empty(); + }, - getParser: function ( id ) { - buildTransformTable(); - buildDateTable(); - cacheRegexs(); - buildCollationTable(); + getParser: function ( id ) { + buildTransformTable(); + buildDateTable(); + cacheRegexs(); + buildCollationTable(); - return getParserById( id ); - }, + return getParserById( id ); + }, - getParsers: function () { // for table diagnosis - return parsers; - } - }; + getParsers: function () { // for table diagnosis + return parsers; + } + }; // Shortcut ts = $.tablesorter; @@ -1063,9 +1064,10 @@ return true; }, format: function ( s ) { + var tsc; s = $.trim( s.toLowerCase() ); if ( ts.collationRegex ) { - var tsc = ts.collationTable; + tsc = ts.collationTable; s = s.replace( ts.collationRegex, function ( match ) { var r = tsc[ match ] ? tsc[ match ] : tsc[ match.toUpperCase() ]; return r.toLowerCase(); @@ -1135,7 +1137,7 @@ if ( !matches ) { return $.tablesorter.formatFloat( 0 ); } - isodate = new Date( matches[ 2 ] + '/' + matches[ 3 ] + '/' + matches[ 1 ] ); + isodate = new Date( matches[ 2 ] + '/' + matches[ 3 ] + '/' + matches[ 1 ] ); } else { matches = s.match( ts.rgx.isoDate[ 0 ] ); if ( !matches ) { diff --git a/resources/src/jquery/jquery.textSelection.js b/resources/src/jquery/jquery.textSelection.js index 5e93ba62c1..c897302c6c 100644 --- a/resources/src/jquery/jquery.textSelection.js +++ b/resources/src/jquery/jquery.textSelection.js @@ -32,13 +32,17 @@ /** * Helper function to get an IE TextRange object for an element + * + * @param {HTMLElement} element + * @return {TextRange} */ - function rangeForElementIE( e ) { - if ( e.nodeName.toLowerCase() === 'input' ) { - return e.createTextRange(); + function rangeForElementIE( element ) { + var sel; + if ( element.nodeName.toLowerCase() === 'input' ) { + return element.createTextRange(); } else { - var sel = document.body.createTextRange(); - sel.moveToElementText( e ); + sel = document.body.createTextRange(); + sel.moveToElementText( element ); return sel; } } @@ -47,6 +51,8 @@ * Helper function for IE for activating the textarea. Called only in the * IE-specific code paths below; makes use of IE-specific non-standard * function setActive() if possible to avoid screen flicker. + * + * @param {HTMLElement} element */ function activateElementOnIE( element ) { if ( element.setActive ) { @@ -59,12 +65,16 @@ fn = { /** * Get the contents of the textarea + * + * @return {string} */ getContents: function () { return this.val(); }, /** * Set the contents of the textarea, replacing anything that was there before + * + * @param {string} content */ setContents: function ( content ) { this.val( content ); @@ -72,6 +82,8 @@ /** * Get the currently selected text in this textarea. Will focus the textarea * in some browsers (IE/Opera) + * + * @return {string} */ getSelection: function () { var retval, range, @@ -96,7 +108,9 @@ * Inserts text at the beginning and end of a text selection, optionally * inserting text at the caret when selection is empty. * + * @param {Object} options Options * FIXME document the options parameters + * @return {jQuery} */ encapsulateSelection: function ( options ) { return this.each( function () { @@ -132,6 +146,11 @@ * Do the splitlines stuff. * * Wrap each line of the selected text with pre and post + * + * @param {string} selText Selected text + * @param {string} pre Text before + * @param {string} post Text after + * @return {string} Wrapped text */ function doSplitLines( selText, pre, post ) { var i, @@ -268,14 +287,16 @@ * * Will focus the textarea in some browsers (IE/Opera) * + * @param {Object} options Options * FIXME document the options parameters + * @return {number} Position */ getCaretPosition: function ( options ) { function getCaret( e ) { var caretPos = 0, endPos = 0, preText, rawPreText, periText, - rawPeriText, postText, rawPostText, + rawPeriText, postText, // IE Support preFinished, periFinished, @@ -310,7 +331,7 @@ // Load the text values we need to compare preText = rawPreText = preRange.text; periText = rawPeriText = periRange.text; - postText = rawPostText = postRange.text; + postText = postRange.text; /* * Check each range for trimmed newlines by shrinking the range by 1 @@ -347,9 +368,7 @@ postFinished = true; } else { postRange.moveEnd( 'character', -1 ); - if ( postRange.text === postText ) { - rawPostText += '\r\n'; - } else { + if ( postRange.text !== postText ) { postFinished = true; } } @@ -367,7 +386,9 @@ return getCaret( this.get( 0 ) ); }, /** + * @param {Object} options options * FIXME document the options parameters + * @return {jQuery} */ setSelection: function ( options ) { return this.each( function () { @@ -412,10 +433,11 @@ * Scroll a textarea to the current cursor position. You can set the cursor * position with setSelection() * - * @param {boolean} options Whether to force a scroll even if the caret position - * is already visible. Defaults to false - * - * FIXME document the options parameters (function body suggests options.force is a boolean, not options itself) + * @param {Object} options options + * @cfg {boolean} [force=false] Whether to force a scroll even if the caret position + * is already visible. + * FIXME document the options parameters + * @return {jQuery} */ scrollToCaretPosition: function ( options ) { function getLineLength( e ) { diff --git a/resources/src/json-skip.js b/resources/src/json-skip.js deleted file mode 100644 index 0a1e1c268a..0000000000 --- a/resources/src/json-skip.js +++ /dev/null @@ -1,4 +0,0 @@ -/*! - * Skip function for json2.js. - */ -return !!( window.JSON && JSON.stringify && JSON.parse ); diff --git a/resources/src/mediawiki.action/mediawiki.action.edit.preview.js b/resources/src/mediawiki.action/mediawiki.action.edit.preview.js index 3b19b35817..f26c336da1 100644 --- a/resources/src/mediawiki.action/mediawiki.action.edit.preview.js +++ b/resources/src/mediawiki.action/mediawiki.action.edit.preview.js @@ -245,7 +245,11 @@ $( '' ).addClass( 'comment' ).html( // There is no equivalent to rawParams mw.message( 'parentheses' ).escaped() - .replace( '$1', parse.parsedsummary ) + // .replace() use $ as start of a pattern. + // $$ is the pattern for '$'. + // The inner .replace() duplicates any $ and + // the outer .replace() simplifies the $$. + .replace( '$1', parse.parsedsummary.replace( /\$/g, '$$$$' ) ) ) ); } diff --git a/resources/src/mediawiki.action/mediawiki.action.edit.stash.js b/resources/src/mediawiki.action/mediawiki.action.edit.stash.js index 6c639575da..c8d3fad631 100644 --- a/resources/src/mediawiki.action/mediawiki.action.edit.stash.js +++ b/resources/src/mediawiki.action/mediawiki.action.edit.stash.js @@ -1,6 +1,7 @@ /*! * Scripts for pre-emptive edit preparing on action=edit */ +/* eslint-disable no-use-before-define */ ( function ( mw, $ ) { if ( !mw.config.get( 'wgAjaxEditStash' ) ) { return; @@ -138,10 +139,10 @@ if ( // Reverts may involve use (undo) links; stash as they review the diff. // Since the form has a pre-filled summary, stash the edit immediately. - mw.util.getParamValue( 'undo' ) !== null + mw.util.getParamValue( 'undo' ) !== null || // Pressing "show changes" and "preview" also signify that the user will // probably save the page soon - || $.inArray( $form.find( '#mw-edit-mode' ).val(), [ 'preview', 'diff' ] ) > -1 + $.inArray( $form.find( '#mw-edit-mode' ).val(), [ 'preview', 'diff' ] ) > -1 ) { checkStash(); } diff --git a/resources/src/mediawiki.action/mediawiki.action.history.js b/resources/src/mediawiki.action/mediawiki.action.history.js index 077d5e3a09..b3b0af239d 100644 --- a/resources/src/mediawiki.action/mediawiki.action.history.js +++ b/resources/src/mediawiki.action/mediawiki.action.history.js @@ -10,6 +10,7 @@ jQuery( function ( $ ) { * @ignore * @context {Element} input * @param {jQuery.Event} e + * @return {boolean} False to cancel the default event */ function updateDiffRadios() { var nextState = 'before', diff --git a/resources/src/mediawiki.action/mediawiki.action.history.styles.css b/resources/src/mediawiki.action/mediawiki.action.history.styles.css index 5b08f95ae5..cad530bf12 100644 --- a/resources/src/mediawiki.action/mediawiki.action.history.styles.css +++ b/resources/src/mediawiki.action/mediawiki.action.history.styles.css @@ -10,8 +10,8 @@ } #pagehistory li.selected { - background-color: #f9f9f9; - border: 1px dashed #aaa; + background-color: #f8f9fa; + border: 1px dashed #a2a9b1; } .mw-history-revisionactions { diff --git a/resources/src/mediawiki.action/mediawiki.action.view.dblClickEdit.js b/resources/src/mediawiki.action/mediawiki.action.view.dblClickEdit.js index 2be29f0963..7439754668 100644 --- a/resources/src/mediawiki.action/mediawiki.action.view.dblClickEdit.js +++ b/resources/src/mediawiki.action/mediawiki.action.view.dblClickEdit.js @@ -4,11 +4,12 @@ ( function ( mw, $ ) { $( function () { mw.util.$content.dblclick( function ( e ) { + var $a; // Recheck preference so extensions can do a hack to disable this code. if ( parseInt( mw.user.options.get( 'editondblclick' ), 10 ) ) { e.preventDefault(); // Trigger native HTMLElement click instead of opening URL (bug 43052) - var $a = $( '#ca-edit a' ); + $a = $( '#ca-edit a' ); // Not every page has an edit link (bug 57713) if ( $a.length ) { $a.get( 0 ).click(); diff --git a/resources/src/mediawiki.action/mediawiki.action.view.filepage.css b/resources/src/mediawiki.action/mediawiki.action.view.filepage.css index d5520a1f97..1f0365eced 100644 --- a/resources/src/mediawiki.action/mediawiki.action.view.filepage.css +++ b/resources/src/mediawiki.action/mediawiki.action.view.filepage.css @@ -46,8 +46,8 @@ */ #filetoc { text-align: center; - border: 1px solid #aaa; - background-color: #f9f9f9; + border: 1px solid #a2a9b1; + background-color: #f8f9fa; padding: 5px; font-size: 95%; margin-bottom: 0.5em; @@ -99,13 +99,13 @@ .mw_metadata td, .mw_metadata th { - border: 1px solid #aaa; + border: 1px solid #a2a9b1; padding-left: 5px; padding-right: 5px; } .mw_metadata th { - background-color: #f9f9f9; + background-color: #f8f9fa; } .mw_metadata td { diff --git a/resources/src/mediawiki.action/mediawiki.action.view.redirect.js b/resources/src/mediawiki.action/mediawiki.action.view.redirect.js index 29a5a79f9b..39a122d981 100644 --- a/resources/src/mediawiki.action/mediawiki.action.view.redirect.js +++ b/resources/src/mediawiki.action/mediawiki.action.view.redirect.js @@ -28,7 +28,7 @@ } // Note that this will update the hash in a modern browser, retaining back behaviour - history.replaceState( /*data=*/ history.state, /*title=*/ document.title, /*url=*/ canonical ); + history.replaceState( /* data= */ history.state, /* title= */ document.title, /* url= */ canonical ); if ( shouldChangeFragment ) { // Specification for history.replaceState() doesn't require browser to scroll, // so scroll to be sure (see also T110501). Support for IE9 and IE10. diff --git a/resources/src/mediawiki.language/languages/ga.js b/resources/src/mediawiki.language/languages/ga.js index a4c911a339..e1362114c1 100644 --- a/resources/src/mediawiki.language/languages/ga.js +++ b/resources/src/mediawiki.language/languages/ga.js @@ -3,7 +3,6 @@ */ mediaWiki.language.convertGrammar = function ( word, form ) { - /*jshint onecase:true */ var grammarForms = mediaWiki.language.getData( 'ga', 'grammarForms' ); if ( grammarForms && grammarForms[ form ] ) { return grammarForms[ form ][ word ]; diff --git a/resources/src/mediawiki.language/languages/he.js b/resources/src/mediawiki.language/languages/he.js index 945f02fed2..5bf8c4df91 100644 --- a/resources/src/mediawiki.language/languages/he.js +++ b/resources/src/mediawiki.language/languages/he.js @@ -21,7 +21,7 @@ mediaWiki.language.convertGrammar = function ( word, form ) { } // Add a hyphen (maqaf) before numbers and non-Hebrew letters - if ( word.slice( 0, 1 ) < '×' || word.slice( 0, 1 ) > '×ª' ) { + if ( word.slice( 0, 1 ) < '×' || word.slice( 0, 1 ) > '×ª' ) { word = 'Ö¾' + word; } } diff --git a/resources/src/mediawiki.language/languages/hy.js b/resources/src/mediawiki.language/languages/hy.js index 935d466d14..bb6f61dffe 100644 --- a/resources/src/mediawiki.language/languages/hy.js +++ b/resources/src/mediawiki.language/languages/hy.js @@ -3,7 +3,6 @@ */ mediaWiki.language.convertGrammar = function ( word, form ) { - /*jshint onecase:true */ var grammarForms = mediaWiki.language.getData( 'hy', 'grammarForms' ); if ( grammarForms && grammarForms[ form ] ) { return grammarForms[ form ][ word ]; diff --git a/resources/src/mediawiki.language/mediawiki.language.js b/resources/src/mediawiki.language/mediawiki.language.js index cf3ef79746..fc2af3d0d8 100644 --- a/resources/src/mediawiki.language/mediawiki.language.js +++ b/resources/src/mediawiki.language/mediawiki.language.js @@ -3,154 +3,155 @@ */ ( function ( mw, $ ) { -/** - * @class mw.language - */ -$.extend( mw.language, { - /** - * Process the PLURAL template substitution - * - * @private - * @param {Object} template Template object - * @param {string} template.title - * @param {Array} template.parameters - * @return {string} + * @class mw.language */ - procPLURAL: function ( template ) { - if ( template.title && template.parameters && mw.language.convertPlural ) { - // Check if we have forms to replace - if ( template.parameters.length === 0 ) { - return ''; + $.extend( mw.language, { + + /** + * Process the PLURAL template substitution + * + * @private + * @param {Object} template Template object + * @param {string} template.title + * @param {Array} template.parameters + * @return {string} + */ + procPLURAL: function ( template ) { + var count; + if ( template.title && template.parameters && mw.language.convertPlural ) { + // Check if we have forms to replace + if ( template.parameters.length === 0 ) { + return ''; + } + // Restore the count into a Number ( if it got converted earlier ) + count = mw.language.convertNumber( template.title, true ); + // Do convertPlural call + return mw.language.convertPlural( parseInt( count, 10 ), template.parameters ); } - // Restore the count into a Number ( if it got converted earlier ) - var count = mw.language.convertNumber( template.title, true ); - // Do convertPlural call - return mw.language.convertPlural( parseInt( count, 10 ), template.parameters ); - } - // Could not process plural return first form or nothing - if ( template.parameters[ 0 ] ) { - return template.parameters[ 0 ]; - } - return ''; - }, + // Could not process plural return first form or nothing + if ( template.parameters[ 0 ] ) { + return template.parameters[ 0 ]; + } + return ''; + }, - /** - * Plural form transformations, needed for some languages. - * - * @param {number} count Non-localized quantifier - * @param {Array} forms List of plural forms - * @param {Object} [explicitPluralForms] List of explicit plural forms - * @return {string} Correct form for quantifier in this language - */ - convertPlural: function ( count, forms, explicitPluralForms ) { - var pluralRules, - pluralFormIndex = 0; + /** + * Plural form transformations, needed for some languages. + * + * @param {number} count Non-localized quantifier + * @param {Array} forms List of plural forms + * @param {Object} [explicitPluralForms] List of explicit plural forms + * @return {string} Correct form for quantifier in this language + */ + convertPlural: function ( count, forms, explicitPluralForms ) { + var pluralRules, + pluralFormIndex = 0; - if ( explicitPluralForms && ( explicitPluralForms[ count ] !== undefined ) ) { - return explicitPluralForms[ count ]; - } + if ( explicitPluralForms && ( explicitPluralForms[ count ] !== undefined ) ) { + return explicitPluralForms[ count ]; + } - if ( !forms || forms.length === 0 ) { - return ''; - } + if ( !forms || forms.length === 0 ) { + return ''; + } - pluralRules = mw.language.getData( mw.config.get( 'wgUserLanguage' ), 'pluralRules' ); - if ( !pluralRules ) { - // default fallback. - return ( count === 1 ) ? forms[ 0 ] : forms[ 1 ]; - } - pluralFormIndex = mw.cldr.getPluralForm( count, pluralRules ); - pluralFormIndex = Math.min( pluralFormIndex, forms.length - 1 ); - return forms[ pluralFormIndex ]; - }, + pluralRules = mw.language.getData( mw.config.get( 'wgUserLanguage' ), 'pluralRules' ); + if ( !pluralRules ) { + // default fallback. + return ( count === 1 ) ? forms[ 0 ] : forms[ 1 ]; + } + pluralFormIndex = mw.cldr.getPluralForm( count, pluralRules ); + pluralFormIndex = Math.min( pluralFormIndex, forms.length - 1 ); + return forms[ pluralFormIndex ]; + }, - /** - * Pads an array to a specific length by copying the last one element. - * - * @private - * @param {Array} forms Number of forms given to convertPlural - * @param {number} count Number of forms required - * @return {Array} Padded array of forms - */ - preConvertPlural: function ( forms, count ) { - while ( forms.length < count ) { - forms.push( forms[ forms.length - 1 ] ); - } - return forms; - }, + /** + * Pads an array to a specific length by copying the last one element. + * + * @private + * @param {Array} forms Number of forms given to convertPlural + * @param {number} count Number of forms required + * @return {Array} Padded array of forms + */ + preConvertPlural: function ( forms, count ) { + while ( forms.length < count ) { + forms.push( forms[ forms.length - 1 ] ); + } + return forms; + }, - /** - * Provides an alternative text depending on specified gender. - * - * Usage in message text: `{{gender:[gender|user object]|masculine|feminine|neutral}}`. - * If second or third parameter are not specified, masculine is used. - * - * These details may be overridden per language. - * - * @param {string} gender 'male', 'female', or anything else for neutral. - * @param {Array} forms List of gender forms - * @return {string} - */ - gender: function ( gender, forms ) { - if ( !forms || forms.length === 0 ) { - return ''; - } - forms = mw.language.preConvertPlural( forms, 2 ); - if ( gender === 'male' ) { - return forms[ 0 ]; - } - if ( gender === 'female' ) { - return forms[ 1 ]; - } - return ( forms.length === 3 ) ? forms[ 2 ] : forms[ 0 ]; - }, + /** + * Provides an alternative text depending on specified gender. + * + * Usage in message text: `{{gender:[gender|user object]|masculine|feminine|neutral}}`. + * If second or third parameter are not specified, masculine is used. + * + * These details may be overridden per language. + * + * @param {string} gender 'male', 'female', or anything else for neutral. + * @param {Array} forms List of gender forms + * @return {string} + */ + gender: function ( gender, forms ) { + if ( !forms || forms.length === 0 ) { + return ''; + } + forms = mw.language.preConvertPlural( forms, 2 ); + if ( gender === 'male' ) { + return forms[ 0 ]; + } + if ( gender === 'female' ) { + return forms[ 1 ]; + } + return ( forms.length === 3 ) ? forms[ 2 ] : forms[ 0 ]; + }, - /** - * Grammatical transformations, needed for inflected languages. - * Invoked by putting `{{grammar:form|word}}` in a message. - * - * The rules can be defined in $wgGrammarForms global or computed - * dynamically by overriding this method per language. - * - * @param {string} word - * @param {string} form - * @return {string} - */ - convertGrammar: function ( word, form ) { - var grammarForms = mw.language.getData( mw.config.get( 'wgUserLanguage' ), 'grammarForms' ); - if ( grammarForms && grammarForms[ form ] ) { - return grammarForms[ form ][ word ] || word; - } - return word; - }, + /** + * Grammatical transformations, needed for inflected languages. + * Invoked by putting `{{grammar:form|word}}` in a message. + * + * The rules can be defined in $wgGrammarForms global or computed + * dynamically by overriding this method per language. + * + * @param {string} word + * @param {string} form + * @return {string} + */ + convertGrammar: function ( word, form ) { + var grammarForms = mw.language.getData( mw.config.get( 'wgUserLanguage' ), 'grammarForms' ); + if ( grammarForms && grammarForms[ form ] ) { + return grammarForms[ form ][ word ] || word; + } + return word; + }, - /** - * Turn a list of string into a simple list using commas and 'and'. - * - * See Language::listToText in languages/Language.php - * - * @param {string[]} list - * @return {string} - */ - listToText: function ( list ) { - var text = '', - i = 0; + /** + * Turn a list of string into a simple list using commas and 'and'. + * + * See Language::listToText in languages/Language.php + * + * @param {string[]} list + * @return {string} + */ + listToText: function ( list ) { + var text = '', + i = 0; - for ( ; i < list.length; i++ ) { - text += list[ i ]; - if ( list.length - 2 === i ) { - text += mw.msg( 'and' ) + mw.msg( 'word-separator' ); - } else if ( list.length - 1 !== i ) { - text += mw.msg( 'comma-separator' ); + for ( ; i < list.length; i++ ) { + text += list[ i ]; + if ( list.length - 2 === i ) { + text += mw.msg( 'and' ) + mw.msg( 'word-separator' ); + } else if ( list.length - 1 !== i ) { + text += mw.msg( 'comma-separator' ); + } } - } - return text; - }, + return text; + }, - setSpecialCharacters: function ( data ) { - this.specialCharacters = data; - } -} ); + setSpecialCharacters: function ( data ) { + this.specialCharacters = data; + } + } ); }( mediaWiki, jQuery ) ); diff --git a/resources/src/mediawiki.language/mediawiki.language.numbers.js b/resources/src/mediawiki.language/mediawiki.language.numbers.js index 268985f8e4..83277cb00f 100644 --- a/resources/src/mediawiki.language/mediawiki.language.numbers.js +++ b/resources/src/mediawiki.language/mediawiki.language.numbers.js @@ -15,11 +15,12 @@ * @return {string} */ function replicate( str, num ) { + var buf = []; + if ( num <= 0 || !str ) { return ''; } - var buf = []; while ( num-- ) { buf.push( str ); } @@ -43,12 +44,14 @@ * @return {string} */ function pad( text, size, ch, end ) { + var out, padStr; + if ( !ch ) { ch = '0'; } - var out = String( text ), - padStr = replicate( ch, Math.ceil( ( size - out.length ) / ch.length ) ); + out = String( text ); + padStr = replicate( ch, Math.ceil( ( size - out.length ) / ch.length ) ); return end ? out + padStr : padStr + out; } @@ -69,15 +72,6 @@ * @return {string} */ function commafyNumber( value, pattern, options ) { - options = options || { - group: ',', - decimal: '.' - }; - - if ( isNaN( value ) ) { - return value; - } - var padLength, patternDigits, index, @@ -92,6 +86,15 @@ groupSize2 = 0, pieces = []; + options = options || { + group: ',', + decimal: '.' + }; + + if ( isNaN( value ) ) { + return value; + } + if ( patternParts[ 1 ] ) { // Pad fractional with trailing zeros padLength = ( patternParts[ 1 ] && patternParts[ 1 ].lastIndexOf( '0' ) + 1 ); @@ -155,6 +158,31 @@ return valueParts.join( options.decimal ); } + /** + * Helper function to flip transformation tables. + * + * @param {...Object} Transformation tables + * @return {Object} + */ + function flipTransform() { + var i, key, table, flipped = {}; + + // Ensure we strip thousand separators. This might be overwritten. + flipped[ ',' ] = ''; + + for ( i = 0; i < arguments.length; i++ ) { + table = arguments[ i ]; + for ( key in table ) { + if ( table.hasOwnProperty( key ) ) { + // The thousand separator should be deleted + flipped[ table[ key ] ] = key === ',' ? '' : key; + } + } + } + + return flipped; + } + $.extend( mw.language, { /** @@ -165,46 +193,55 @@ * @return {number|string} Formatted number */ convertNumber: function ( num, integer ) { - var i, tmp, transformTable, numberString, convertedNumber, pattern; - - pattern = mw.language.getData( mw.config.get( 'wgUserLanguage' ), - 'digitGroupingPattern' ) || '#,##0.###'; + var transformTable, digitTransformTable, separatorTransformTable, + i, numberString, convertedNumber, pattern; - // Set the target transform table: - transformTable = mw.language.getDigitTransformTable(); - - if ( !transformTable ) { + // Quick shortcut for plain numbers + if ( integer && parseInt( num, 10 ) === num ) { return num; } - // Check if the 'restore' to Latin number flag is set: + // Load the transformation tables (can be empty) + digitTransformTable = mw.language.getDigitTransformTable(); + separatorTransformTable = mw.language.getSeparatorTransformTable(); + if ( integer ) { - if ( parseInt( num, 10 ) === num ) { - return num; - } - tmp = []; - for ( i in transformTable ) { - tmp[ transformTable[ i ] ] = i; - } - transformTable = tmp; + // Reverse the digit transformation tables if we are doing unformatting + transformTable = flipTransform( separatorTransformTable, digitTransformTable ); numberString = String( num ); } else { - // Ignore transform table if wgTranslateNumerals is false - if ( !mw.config.get( 'wgTranslateNumerals' ) ) { - transformTable = []; + // This check being here means that digits can still be unformatted + // even if we do not produce them. This seems sane behavior. + if ( mw.config.get( 'wgTranslateNumerals' ) ) { + transformTable = digitTransformTable; } + + // Commaying is more complex, so we handle it here separately. + // When unformatting, we just use separatorTransformTable. + pattern = mw.language.getData( mw.config.get( 'wgUserLanguage' ), + 'digitGroupingPattern' ) || '#,##0.###'; numberString = mw.language.commafy( num, pattern ); } - convertedNumber = ''; - for ( i = 0; i < numberString.length; i++ ) { - if ( transformTable[ numberString[ i ] ] ) { - convertedNumber += transformTable[ numberString[ i ] ]; - } else { - convertedNumber += numberString[ i ]; + if ( transformTable ) { + convertedNumber = ''; + for ( i = 0; i < numberString.length; i++ ) { + if ( transformTable.hasOwnProperty( numberString[ i ] ) ) { + convertedNumber += transformTable[ numberString[ i ] ]; + } else { + convertedNumber += numberString[ i ]; + } } + } else { + convertedNumber = numberString; } - return integer ? parseInt( convertedNumber, 10 ) : convertedNumber; + + if ( integer ) { + // Parse string to integer. This loses decimals! + convertedNumber = parseInt( convertedNumber, 10 ); + } + + return convertedNumber; }, /** diff --git a/resources/src/mediawiki.legacy/oldshared.css b/resources/src/mediawiki.legacy/oldshared.css index 7ccf59e548..4daf77f262 100644 --- a/resources/src/mediawiki.legacy/oldshared.css +++ b/resources/src/mediawiki.legacy/oldshared.css @@ -5,7 +5,7 @@ */ /* For clarity, explicitly state some recommendations from - * http://www.w3.org/TR/CSS21/sample.html to make sure the editsection links scale right + * https://www.w3.org/TR/CSS21/sample.html to make sure the editsection links scale right */ h1 { diff --git a/resources/src/mediawiki.legacy/protect.js b/resources/src/mediawiki.legacy/protect.js index 6226c90b8d..aa49ae138e 100644 --- a/resources/src/mediawiki.legacy/protect.js +++ b/resources/src/mediawiki.legacy/protect.js @@ -1,242 +1,245 @@ ( function ( mw, $ ) { -var ProtectionForm = window.ProtectionForm = { - /** - * Set up the protection chaining interface (i.e. "unlock move permissions" checkbox) - * on the protection form - */ - init: function () { - var $cell = $( '' ).append( $cell ); - - if ( !$( '#mwProtectSet' ).length ) { - return false; - } - - if ( mw.config.get( 'wgCascadeableLevels' ) !== undefined ) { - $( 'form#mw-Protect-Form' ).submit( this.toggleUnchainedInputs.bind( ProtectionForm, true ) ); - } - this.getExpirySelectors().each( function () { - $( this ).change( ProtectionForm.updateExpiryList.bind( ProtectionForm, this ) ); - } ); - this.getExpiryInputs().each( function () { - $( this ).on( 'keyup change', ProtectionForm.updateExpiry.bind( ProtectionForm, this ) ); - } ); - this.getLevelSelectors().each( function () { - $( this ).change( ProtectionForm.updateLevels.bind( ProtectionForm, this ) ); - } ); - - $( '#mwProtectSet > tbody > tr:first' ).after( $row ); - - // If there is only one protection type, there is nothing to chain - if ( $( '[id ^= mw-protect-table-]' ).length > 1 ) { - $cell.append( - $( '' ) - .attr( { id: 'mwProtectUnchained', type: 'checkbox' } ) - .click( this.onChainClick.bind( this ) ) - .prop( 'checked', !this.areAllTypesMatching() ), - document.createTextNode( ' ' ), - $( '' ) - .attr( 'for', 'mwProtectUnchained' ) - .text( mw.msg( 'protect-unchain-permissions' ) ) - ); - - this.toggleUnchainedInputs( !this.areAllTypesMatching() ); - } - - $( '#mwProtect-reason' ).byteLimit( 180 ); - - this.updateCascadeCheckbox(); - }, - - /** - * Sets the disabled attribute on the cascade checkbox depending on the current selected levels - */ - updateCascadeCheckbox: function () { - this.getLevelSelectors().each( function () { - if ( !ProtectionForm.isCascadeableLevel( $( this ).val() ) ) { - $( '#mwProtect-cascade' ).prop( { checked: false, disabled: true } ); + var ProtectionForm = window.ProtectionForm = { + /** + * Set up the protection chaining interface (i.e. "unlock move permissions" checkbox) + * on the protection form + * + * @return {boolean} + */ + init: function () { + var $cell = $( '' ).append( $cell ); + + if ( !$( '#mwProtectSet' ).length ) { return false; - } else { - $( '#mwProtect-cascade' ).prop( 'disabled', false ); } - } ); - }, - - /** - * Checks if a certain protection level is cascadeable. - * - * @param {string} level - * @return {boolean} - */ - isCascadeableLevel: function ( level ) { - return $.inArray( level, mw.config.get( 'wgCascadeableLevels' ) ) !== -1; - }, - - /** - * When protection levels are locked together, update the rest - * when one action's level changes - * - * @param {Element} source Level selector that changed - */ - updateLevels: function ( source ) { - if ( !this.isUnchained() ) { - this.setAllSelectors( source.selectedIndex ); - } - this.updateCascadeCheckbox(); - }, - - /** - * When protection levels are locked together, update the - * expiries when one changes - * - * @param {Element} source expiry input that changed - */ - - updateExpiry: function ( source ) { - if ( !this.isUnchained() ) { + + if ( mw.config.get( 'wgCascadeableLevels' ) !== undefined ) { + $( 'form#mw-Protect-Form' ).submit( this.toggleUnchainedInputs.bind( ProtectionForm, true ) ); + } + this.getExpirySelectors().each( function () { + $( this ).change( ProtectionForm.updateExpiryList.bind( ProtectionForm, this ) ); + } ); this.getExpiryInputs().each( function () { - this.value = source.value; + $( this ).on( 'keyup change', ProtectionForm.updateExpiry.bind( ProtectionForm, this ) ); } ); - } - if ( this.isUnchained() ) { - $( '#' + source.id.replace( /^mwProtect-(\w+)-expires$/, 'mwProtectExpirySelection-$1' ) ).val( 'othertime' ); - } else { - this.getExpirySelectors().each( function () { - this.value = 'othertime'; + this.getLevelSelectors().each( function () { + $( this ).change( ProtectionForm.updateLevels.bind( ProtectionForm, this ) ); } ); - } - }, - - /** - * When protection levels are locked together, update the - * expiry lists when one changes and clear the custom inputs - * - * @param {Element} source Expiry selector that changed - */ - updateExpiryList: function ( source ) { - if ( !this.isUnchained() ) { - this.getExpirySelectors().each( function () { - this.value = source.value; + + $( '#mwProtectSet > tbody > tr:first' ).after( $row ); + + // If there is only one protection type, there is nothing to chain + if ( $( '[id ^= mw-protect-table-]' ).length > 1 ) { + $cell.append( + $( '' ) + .attr( { id: 'mwProtectUnchained', type: 'checkbox' } ) + .click( this.onChainClick.bind( this ) ) + .prop( 'checked', !this.areAllTypesMatching() ), + document.createTextNode( ' ' ), + $( '' ) + .attr( 'for', 'mwProtectUnchained' ) + .text( mw.msg( 'protect-unchain-permissions' ) ) + ); + + this.toggleUnchainedInputs( !this.areAllTypesMatching() ); + } + + $( '#mwProtect-reason' ).byteLimit( 180 ); + + this.updateCascadeCheckbox(); + return true; + }, + + /** + * Sets the disabled attribute on the cascade checkbox depending on the current selected levels + */ + updateCascadeCheckbox: function () { + this.getLevelSelectors().each( function () { + if ( !ProtectionForm.isCascadeableLevel( $( this ).val() ) ) { + $( '#mwProtect-cascade' ).prop( { checked: false, disabled: true } ); + return false; + } else { + $( '#mwProtect-cascade' ).prop( 'disabled', false ); + } } ); - this.getExpiryInputs().each( function () { - this.value = ''; + }, + + /** + * Checks if a certain protection level is cascadeable. + * + * @param {string} level + * @return {boolean} + */ + isCascadeableLevel: function ( level ) { + return $.inArray( level, mw.config.get( 'wgCascadeableLevels' ) ) !== -1; + }, + + /** + * When protection levels are locked together, update the rest + * when one action's level changes + * + * @param {Element} source Level selector that changed + */ + updateLevels: function ( source ) { + if ( !this.isUnchained() ) { + this.setAllSelectors( source.selectedIndex ); + } + this.updateCascadeCheckbox(); + }, + + /** + * When protection levels are locked together, update the + * expiries when one changes + * + * @param {Element} source expiry input that changed + */ + + updateExpiry: function ( source ) { + if ( !this.isUnchained() ) { + this.getExpiryInputs().each( function () { + this.value = source.value; + } ); + } + if ( this.isUnchained() ) { + $( '#' + source.id.replace( /^mwProtect-(\w+)-expires$/, 'mwProtectExpirySelection-$1' ) ).val( 'othertime' ); + } else { + this.getExpirySelectors().each( function () { + this.value = 'othertime'; + } ); + } + }, + + /** + * When protection levels are locked together, update the + * expiry lists when one changes and clear the custom inputs + * + * @param {Element} source Expiry selector that changed + */ + updateExpiryList: function ( source ) { + if ( !this.isUnchained() ) { + this.getExpirySelectors().each( function () { + this.value = source.value; + } ); + this.getExpiryInputs().each( function () { + this.value = ''; + } ); + } + }, + + /** + * Update chain status and enable/disable various bits of the UI + * when the user changes the "unlock move permissions" checkbox + */ + onChainClick: function () { + this.toggleUnchainedInputs( this.isUnchained() ); + if ( !this.isUnchained() ) { + this.setAllSelectors( this.getMaxLevel() ); + } + this.updateCascadeCheckbox(); + }, + + /** + * Returns true if the named attribute in all objects in the given array are matching + * + * @param {Object[]} objects + * @param {string} attrName + * @return {boolean} + */ + matchAttribute: function ( objects, attrName ) { + return $.map( objects, function ( object ) { + return object[ attrName ]; + } ).filter( function ( item, index, a ) { + return index === a.indexOf( item ); + } ).length === 1; + }, + + /** + * Are all actions protected at the same level, with the same expiry time? + * + * @return {boolean} + */ + areAllTypesMatching: function () { + return this.matchAttribute( this.getLevelSelectors(), 'selectedIndex' ) && + this.matchAttribute( this.getExpirySelectors(), 'selectedIndex' ) && + this.matchAttribute( this.getExpiryInputs(), 'value' ); + }, + + /** + * Is protection chaining off? + * + * @return {boolean} + */ + isUnchained: function () { + var element = document.getElementById( 'mwProtectUnchained' ); + return element ? + element.checked : + true; // No control, so we need to let the user set both levels + }, + + /** + * Find the highest protection level in any selector + * + * @return {number} + */ + getMaxLevel: function () { + return Math.max.apply( Math, this.getLevelSelectors().map( function () { + return this.selectedIndex; + } ) ); + }, + + /** + * Protect all actions at the specified level + * + * @param {number} index Protection level + */ + setAllSelectors: function ( index ) { + this.getLevelSelectors().each( function () { + this.selectedIndex = index; } ); + }, + + /** + * Get a list of all protection selectors on the page + * + * @return {jQuery} + */ + getLevelSelectors: function () { + return $( 'select[id ^= mwProtect-level-]' ); + }, + + /** + * Get a list of all expiry inputs on the page + * + * @return {jQuery} + */ + getExpiryInputs: function () { + return $( 'input[id ^= mwProtect-][id $= -expires]' ); + }, + + /** + * Get a list of all expiry selector lists on the page + * + * @return {jQuery} + */ + getExpirySelectors: function () { + return $( 'select[id ^= mwProtectExpirySelection-]' ); + }, + + /** + * Enable/disable protection selectors and expiry inputs + * + * @param {boolean} val Enable? + */ + toggleUnchainedInputs: function ( val ) { + var setDisabled = function () { this.disabled = !val; }; + this.getLevelSelectors().slice( 1 ).each( setDisabled ); + this.getExpiryInputs().slice( 1 ).each( setDisabled ); + this.getExpirySelectors().slice( 1 ).each( setDisabled ); } - }, - - /** - * Update chain status and enable/disable various bits of the UI - * when the user changes the "unlock move permissions" checkbox - */ - onChainClick: function () { - this.toggleUnchainedInputs( this.isUnchained() ); - if ( !this.isUnchained() ) { - this.setAllSelectors( this.getMaxLevel() ); - } - this.updateCascadeCheckbox(); - }, - - /** - * Returns true if the named attribute in all objects in the given array are matching - * - * @param {Object[]} objects - * @param {string} attrName - * @return {boolean} - */ - matchAttribute: function ( objects, attrName ) { - return $.map( objects, function ( object ) { - return object[ attrName ]; - } ).filter( function ( item, index, a ) { - return index === a.indexOf( item ); - } ).length === 1; - }, - - /** - * Are all actions protected at the same level, with the same expiry time? - * - * @return {boolean} - */ - areAllTypesMatching: function () { - return this.matchAttribute( this.getLevelSelectors(), 'selectedIndex' ) - && this.matchAttribute( this.getExpirySelectors(), 'selectedIndex' ) - && this.matchAttribute( this.getExpiryInputs(), 'value' ); - }, - - /** - * Is protection chaining off? - * - * @return {boolean} - */ - isUnchained: function () { - var element = document.getElementById( 'mwProtectUnchained' ); - return element - ? element.checked - : true; // No control, so we need to let the user set both levels - }, - - /** - * Find the highest protection level in any selector - * - * @return {number} - */ - getMaxLevel: function () { - return Math.max.apply( Math, this.getLevelSelectors().map( function () { - return this.selectedIndex; - } ) ); - }, - - /** - * Protect all actions at the specified level - * - * @param {number} index Protection level - */ - setAllSelectors: function ( index ) { - this.getLevelSelectors().each( function () { - this.selectedIndex = index; - } ); - }, - - /** - * Get a list of all protection selectors on the page - * - * @return {jQuery} - */ - getLevelSelectors: function () { - return $( 'select[id ^= mwProtect-level-]' ); - }, - - /** - * Get a list of all expiry inputs on the page - * - * @return {jQuery} - */ - getExpiryInputs: function () { - return $( 'input[id ^= mwProtect-][id $= -expires]' ); - }, - - /** - * Get a list of all expiry selector lists on the page - * - * @return {jQuery} - */ - getExpirySelectors: function () { - return $( 'select[id ^= mwProtectExpirySelection-]' ); - }, - - /** - * Enable/disable protection selectors and expiry inputs - * - * @param {boolean} val Enable? - */ - toggleUnchainedInputs: function ( val ) { - var setDisabled = function () { this.disabled = !val; }; - this.getLevelSelectors().slice( 1 ).each( setDisabled ); - this.getExpiryInputs().slice( 1 ).each( setDisabled ); - this.getExpirySelectors().slice( 1 ).each( setDisabled ); - } -}; - -$( ProtectionForm.init.bind( ProtectionForm ) ); + }; + + $( ProtectionForm.init.bind( ProtectionForm ) ); }( mediaWiki, jQuery ) ); diff --git a/resources/src/mediawiki.legacy/shared.css b/resources/src/mediawiki.legacy/shared.css index 1522de1e75..81896def52 100644 --- a/resources/src/mediawiki.legacy/shared.css +++ b/resources/src/mediawiki.legacy/shared.css @@ -124,6 +124,16 @@ span.comment { font-family: serif; } +/* Underline preference */ + +.mw-underline-always a { + text-decoration: underline; +} + +.mw-underline-never a { + text-decoration: none; +} + /** * rev_deleted stuff */ @@ -234,7 +244,7 @@ input#wpSummary { .catlinks li { display: inline-block; line-height: 1.25em; - border-left: 1px solid #aaa; + border-left: 1px solid #a2a9b1; margin: 0.125em 0; padding: 0 0.5em; zoom: 1; @@ -343,8 +353,8 @@ a.new { */ table.wikitable { margin: 1em 0; - background-color: #f9f9f9; - border: 1px solid #aaa; + background-color: #f8f9fa; + border: 1px solid #a2a9b1; border-collapse: collapse; color: #000; } @@ -353,13 +363,13 @@ table.wikitable > tr > th, table.wikitable > tr > td, table.wikitable > * > tr > th, table.wikitable > * > tr > td { - border: 1px solid #aaa; + border: 1px solid #a2a9b1; padding: 0.2em 0.4em; } table.wikitable > tr > th, table.wikitable > * > tr > th { - background-color: #f2f2f2; + background-color: #eaecf0; text-align: center; } @@ -472,7 +482,7 @@ table.wikitable > caption { .mw-datatable, .mw-datatable td, .mw-datatable th { - border: 1px solid #aaa; + border: 1px solid #a2a9b1; padding: 0 0.15em 0 0.15em; } @@ -485,7 +495,7 @@ table.wikitable > caption { } .mw-datatable tr:hover td { - background-color: #eef; + background-color: #eaf3ff; } /* Correct directionality when page dir is different from site/user dir */ diff --git a/resources/src/mediawiki.legacy/wikibits.js b/resources/src/mediawiki.legacy/wikibits.js index 38271a01d1..8062849030 100644 --- a/resources/src/mediawiki.legacy/wikibits.js +++ b/resources/src/mediawiki.legacy/wikibits.js @@ -166,13 +166,16 @@ /** * @deprecated since 1.17 Use mw.loader instead. Warnings added in 1.25. + * @param {string} url + * @return {HTMLElement} Script tag */ function importScriptURI( url ) { + var s; if ( loadedScripts[ url ] ) { return null; } loadedScripts[ url ] = true; - var s = document.createElement( 'script' ); + s = document.createElement( 'script' ); s.setAttribute( 'src', url ); document.getElementsByTagName( 'head' )[ 0 ].appendChild( s ); return s; @@ -187,6 +190,9 @@ /** * @deprecated since 1.17 Use mw.loader instead. Warnings added in 1.25. + * @param {string} url + * @param {string} media + * @return {HTMLElement} Link tag */ function importStylesheetURI( url, media ) { var l = document.createElement( 'link' ); diff --git a/resources/src/mediawiki.less/mediawiki.ui/variables.less b/resources/src/mediawiki.less/mediawiki.ui/variables.less index 28ad10ae56..9688f1f8fc 100644 --- a/resources/src/mediawiki.less/mediawiki.ui/variables.less +++ b/resources/src/mediawiki.less/mediawiki.ui/variables.less @@ -26,9 +26,9 @@ // Orange; for contextual use of returning to a past action @colorRegressive: #ff5d00; // Red; for contextual use of a negative action of high severity -@colorDestructive: #c33; -@colorDestructiveHighlight: #e53939; -@colorDestructiveActive: #873636; +@colorDestructive: #d33; +@colorDestructiveHighlight: #ff4242; +@colorDestructiveActive: #b32424; // Orange; for contextual use of a potentially negative action of medium severity @colorMediumSevere: #ff5d00; // Yellow; for contextual use of a potentially negative action of low severity @@ -50,7 +50,7 @@ @colorWarningText: #705000; // UI colors -@colorFieldBorder: #9aa0a7; +@colorFieldBorder: #a2a9b1; @colorShadow: @colorGray14; @colorPlaceholder: @colorGray10; @colorNeutral: @colorGray7; diff --git a/resources/src/mediawiki.messagePoster/mediawiki.messagePoster.MessagePoster.js b/resources/src/mediawiki.messagePoster/mediawiki.messagePoster.MessagePoster.js index c51a07a10c..64642b26bf 100644 --- a/resources/src/mediawiki.messagePoster/mediawiki.messagePoster.MessagePoster.js +++ b/resources/src/mediawiki.messagePoster/mediawiki.messagePoster.MessagePoster.js @@ -1,4 +1,3 @@ -/*global OO*/ ( function ( mw ) { /** * This is the abstract base class for MessagePoster implementations. diff --git a/resources/src/mediawiki.messagePoster/mediawiki.messagePoster.WikitextMessagePoster.js b/resources/src/mediawiki.messagePoster/mediawiki.messagePoster.WikitextMessagePoster.js index 862454d88b..a2dbcd4919 100644 --- a/resources/src/mediawiki.messagePoster/mediawiki.messagePoster.WikitextMessagePoster.js +++ b/resources/src/mediawiki.messagePoster/mediawiki.messagePoster.WikitextMessagePoster.js @@ -1,4 +1,3 @@ -/*global OO*/ ( function ( mw, $ ) { /** * This is an implementation of MessagePoster for wikitext talk pages. diff --git a/resources/src/mediawiki.messagePoster/mediawiki.messagePoster.factory.js b/resources/src/mediawiki.messagePoster/mediawiki.messagePoster.factory.js index 68fb2aae0e..b069d4ab4d 100644 --- a/resources/src/mediawiki.messagePoster/mediawiki.messagePoster.factory.js +++ b/resources/src/mediawiki.messagePoster/mediawiki.messagePoster.factory.js @@ -1,4 +1,3 @@ -/*global OO */ ( function ( mw, $ ) { /** * Factory for MessagePoster objects. This provides a pluggable to way to script the action @@ -100,7 +99,6 @@ * @param {mw.Title} title Title being posted to * @param {mw.Api} api mw.Api instance that the instance should use * @return {mw.messagePoster.MessagePoster} - * */ MessagePosterFactory.prototype.createForContentModel = function ( contentModel, title, api ) { return new this.contentModelToClass[ contentModel ]( title, api ); diff --git a/resources/src/mediawiki.skinning/content.css b/resources/src/mediawiki.skinning/content.css index 022fa28e54..e1df01d896 100644 --- a/resources/src/mediawiki.skinning/content.css +++ b/resources/src/mediawiki.skinning/content.css @@ -10,8 +10,8 @@ .toc, .mw-warning, .toccolours { - border: 1px solid #aaa; - background-color: #f9f9f9; + border: 1px solid #a2a9b1; + background-color: #f8f9fa; padding: 5px; font-size: 95%; } @@ -89,7 +89,7 @@ table.toc td { display: table-cell; /* Text decorations are not propagated to the contents of inline blocks and inline tables, - according to , and 'display: table-cell' + according to , and 'display: table-cell' generates an inline table when used without any parent table-rows and tables. */ text-decoration: inherit; @@ -147,9 +147,9 @@ div.thumb { } div.thumbinner { - border: 1px solid #ccc; + border: 1px solid #c8ccd1; padding: 3px; - background-color: #f9f9f9; + background-color: #f8f9fa; font-size: 94%; text-align: center; /* new block formatting context, @@ -158,7 +158,7 @@ div.thumbinner { } html .thumbimage { - border: 1px solid #ccc; + border: 1px solid #c8ccd1; } html .thumbcaption { @@ -199,7 +199,7 @@ div.magnify a { } img.thumbborder { - border: 1px solid #ddd; + border: 1px solid #eaecf0; } /* Directionality-specific styles for thumbnails - their positioning depends on content language */ diff --git a/resources/src/mediawiki.skinning/elements.css b/resources/src/mediawiki.skinning/elements.css index 9c52b2a00d..83b78a897c 100644 --- a/resources/src/mediawiki.skinning/elements.css +++ b/resources/src/mediawiki.skinning/elements.css @@ -88,8 +88,8 @@ img { hr { height: 1px; - color: #aaa; - background-color: #aaa; + color: #a2a9b1; + background-color: #a2a9b1; border: 0; margin: .2em 0; } @@ -108,7 +108,7 @@ h6 { overflow: hidden; padding-top: .5em; padding-bottom: .17em; - border-bottom: 1px solid #aaa; + border-bottom: 1px solid #a2a9b1; } h1 { @@ -204,8 +204,8 @@ pre, code, tt, kbd, samp, .mw-code { code { color: #000; - background-color: #f9f9f9; - border: 1px solid #ddd; + background-color: #f8f9fa; + border: 1px solid #eaecf0; border-radius: 2px; padding: 1px 4px; } @@ -213,8 +213,8 @@ code { pre, .mw-code { color: #000; - background-color: #f9f9f9; - border: 1px solid #ddd; + background-color: #f8f9fa; + border: 1px solid #eaecf0; padding: 1em; /* Wrap lines in overflow. T2260, T103780 */ white-space: pre-wrap; diff --git a/resources/src/mediawiki.skinning/interface.css b/resources/src/mediawiki.skinning/interface.css index 4ca2096661..7dbcd4dc28 100644 --- a/resources/src/mediawiki.skinning/interface.css +++ b/resources/src/mediawiki.skinning/interface.css @@ -8,8 +8,8 @@ /* Categories */ .catlinks { - border: 1px solid #aaa; - background-color: #f9f9f9; + border: 1px solid #a2a9b1; + background-color: #f8f9fa; padding: 5px; margin-top: 1em; clear: both; diff --git a/resources/src/mediawiki.special/mediawiki.special.apisandbox.js b/resources/src/mediawiki.special/mediawiki.special.apisandbox.js index 98ed3eecfb..43321fe236 100644 --- a/resources/src/mediawiki.special/mediawiki.special.apisandbox.js +++ b/resources/src/mediawiki.special/mediawiki.special.apisandbox.js @@ -1,4 +1,4 @@ -/*global OO */ +/* eslint-disable no-use-before-define */ ( function ( $, mw, OO ) { 'use strict'; var ApiSandbox, Util, WidgetMethods, Validators, @@ -26,7 +26,11 @@ }, apiCheckValid: function () { var that = this; - return this.isValid().done( function ( ok ) { + return this.getValidity().then( function () { + return $.Deferred().resolve( true ).promise(); + }, function () { + return $.Deferred().resolve( false ).promise(); + } ).done( function ( ok ) { ok = ok || suppressErrors; that.setIcon( ok ? null : 'alert' ); that.setIconTitle( ok ? '' : mw.message( 'apisandbox-alert-field' ).plain() ); @@ -35,18 +39,19 @@ }, dateTimeInputWidget: { - isValid: function () { - var ok = !Util.apiBool( this.paramInfo.required ) || this.getApiValue() !== ''; - return $.Deferred().resolve( ok ).promise(); + getValidity: function () { + if ( !Util.apiBool( this.paramInfo.required ) || this.getApiValue() !== '' ) { + return $.Deferred().resolve().promise(); + } else { + return $.Deferred().reject().promise(); + } } }, tokenWidget: { alertTokenError: function ( code, error ) { windowManager.openWindow( 'errorAlert', { - title: mw.message( - 'apisandbox-results-fixtoken-fail', this.paramInfo.tokentype - ).parse(), + title: Util.parseMsg( 'apisandbox-results-fixtoken-fail', this.paramInfo.tokentype ), message: error, actions: [ { @@ -137,7 +142,17 @@ } }, apiCheckValid: function () { - var ok = this.getApiValue() !== undefined || suppressErrors; + var ok = true, + pi = this.paramInfo; + + if ( !suppressErrors ) { + ok = this.getApiValue() !== undefined && !( + pi.allspecifier !== undefined && + this.getItemsData().length > 1 && + this.getItemsData().indexOf( pi.allspecifier ) !== -1 + ); + } + this.setIcon( ok ? null : 'alert' ); this.setIconTitle( ok ? '' : mw.message( 'apisandbox-alert-field' ).plain() ); return $.Deferred().resolve( ok ).promise(); @@ -201,7 +216,7 @@ }; /** - * @class mw.special.ApiSandbox.Utils + * @class mw.special.ApiSandbox.Util * @private */ Util = { @@ -372,7 +387,7 @@ } ); widget.setIcon = widget.input.setIcon.bind( widget.input ); widget.setIconTitle = widget.input.setIconTitle.bind( widget.input ); - widget.isValid = widget.input.isValid.bind( widget.input ); + widget.getValidity = widget.input.getValidity.bind( widget.input ); widget.paramInfo = pi; $.extend( widget, WidgetMethods.textInputWidget ); if ( Util.apiBool( pi.enforcerange ) ) { @@ -382,19 +397,25 @@ break; case 'limit': - widget = new OO.ui.NumberInputWidget( { - required: Util.apiBool( pi.required ), - isInteger: true + widget = new OO.ui.TextInputWidget( { + required: Util.apiBool( pi.required ) } ); - widget.setIcon = widget.input.setIcon.bind( widget.input ); - widget.setIconTitle = widget.input.setIconTitle.bind( widget.input ); - widget.isValid = widget.input.isValid.bind( widget.input ); - widget.input.setValidation( function ( value ) { - return value === 'max' || widget.validateNumber( value ); + widget.setValidation( function ( value ) { + var n, pi = this.paramInfo; + + if ( value === 'max' ) { + return true; + } else { + n = +value; + return !isNaN( n ) && isFinite( n ) && + Math.floor( n ) === n && + n >= pi.min && n <= pi.apiSandboxMax; + } } ); + pi.min = pi.min || 0; + pi.apiSandboxMax = mw.config.get( 'apihighlimits' ) ? pi.highmax : pi.max; widget.paramInfo = pi; $.extend( widget, WidgetMethods.textInputWidget ); - widget.setRange( pi.min || 0, mw.config.get( 'apihighlimits' ) ? pi.highmax : pi.max ); multiMode = 'enter'; break; @@ -428,6 +449,13 @@ return a.data - b.data; } ); if ( Util.apiBool( pi.multi ) ) { + if ( pi.allspecifier !== undefined ) { + items.unshift( new OO.ui.MenuOptionWidget( { + data: pi.allspecifier, + label: mw.message( 'apisandbox-multivalue-all-namespaces', pi.allspecifier ).text() + } ) ); + } + widget = new OO.ui.CapsuleMultiselectWidget( { menu: { items: items } } ); @@ -451,6 +479,13 @@ return new OO.ui.MenuOptionWidget( { data: String( v ), label: String( v ) } ); } ); if ( Util.apiBool( pi.multi ) ) { + if ( pi.allspecifier !== undefined ) { + items.unshift( new OO.ui.MenuOptionWidget( { + data: pi.allspecifier, + label: mw.message( 'apisandbox-multivalue-all-values', pi.allspecifier ).text() + } ) ); + } + widget = new OO.ui.CapsuleMultiselectWidget( { menu: { items: items } } ); @@ -553,17 +588,42 @@ }, /** - * Parse an HTML string, adding target="_blank" to any links + * Parse an HTML string and call Util.fixupHTML() * * @param {string} html HTML to parse * @return {jQuery} */ parseHTML: function ( html ) { var $ret = $( $.parseHTML( html ) ); - $ret.filter( 'a' ).add( $ret.find( 'a' ) ) + return Util.fixupHTML( $ret ); + }, + + /** + * Parse an i18n message and call Util.fixupHTML() + * + * @param {string} key Key of message to get + * @param {...Mixed} parameters Values for $N replacements + * @return {jQuery} + */ + parseMsg: function () { + var $ret = mw.message.apply( mw.message, arguments ).parseDom(); + return Util.fixupHTML( $ret ); + }, + + /** + * Fix HTML for ApiSandbox display + * + * Fixes are: + * - Add target="_blank" to any links + * + * @param {jQuery} $html DOM to process + * @return {jQuery} + */ + fixupHTML: function ( $html ) { + $html.filter( 'a' ).add( $html.find( 'a' ) ) .filter( '[href]:not([target])' ) .attr( 'target', '_blank' ); - return $ret; + return $html; } }; @@ -645,7 +705,7 @@ $content .empty() - .append( $( '

' ).append( mw.message( 'apisandbox-intro' ).parse() ) ) + .append( $( '

' ).append( Util.parseMsg( 'apisandbox-intro' ) ) ) .append( $( '

', { id: 'mw-apisandbox-ui' } ) .append( $toolbar ) @@ -701,6 +761,8 @@ /** * Update the current query when the page hash changes + * + * @return {boolean} Successful */ loadFromHash: function () { var params, m, re, @@ -856,8 +918,8 @@ $.when.apply( $, deferreds ).done( function () { if ( $.inArray( false, arguments ) !== -1 ) { windowManager.openWindow( 'errorAlert', { - title: mw.message( 'apisandbox-submit-invalid-fields-title' ).parse(), - message: mw.message( 'apisandbox-submit-invalid-fields-message' ).parse(), + title: Util.parseMsg( 'apisandbox-submit-invalid-fields-title' ), + message: Util.parseMsg( 'apisandbox-submit-invalid-fields-message' ), actions: [ { action: 'accept', @@ -902,7 +964,7 @@ readOnly: true, value: mw.util.wikiScript( 'api' ) + '?' + query } ), { - label: mw.message( 'apisandbox-request-url-label' ).parse() + label: Util.parseMsg( 'apisandbox-request-url-label' ) } ).$element, $result @@ -965,10 +1027,16 @@ $result.empty(); if ( /^text\/mediawiki-api-prettyprint-wrapped(?:;|$)/.test( ct ) ) { - data = $.parseJSON( data ); + data = JSON.parse( data ); if ( data.modules.length ) { mw.loader.load( data.modules ); } + if ( data.status && data.status !== 200 ) { + $( '

' ) + .addClass( 'api-pretty-header api-pretty-status' ) + .append( Util.parseMsg( 'api-format-prettyprint-status', data.status, data.statustext ) ) + .appendTo( $result ); + } $result.append( Util.parseHTML( data.html ) ); loadTime = data.time; } else if ( ( m = data.match( /][\s\S]*<\/pre>/ ) ) ) { @@ -1001,7 +1069,7 @@ framed: false, icon: 'info', popup: { - $content: $( '

' ).append( mw.message( 'apisandbox-continue-help' ).parse() ), + $content: $( '

' ).append( Util.parseMsg( 'apisandbox-continue-help' ) ), padded: true } } ).$element @@ -1150,9 +1218,7 @@ if ( that.widgets[ name ] !== undefined ) { windowManager.openWindow( 'errorAlert', { - title: mw.message( - 'apisandbox-dynamic-error-exists', name - ).parse(), + title: Util.parseMsg( 'apisandbox-dynamic-error-exists', name ), actions: [ { action: 'accept', @@ -1331,16 +1397,22 @@ if ( pi.parameters[ i ].highmax !== undefined ) { dl.append( $( '

', { addClass: 'info', - append: Util.parseHTML( mw.message( - 'api-help-param-limit2', pi.parameters[ i ].max, pi.parameters[ i ].highmax - ).parse() ) + append: [ + Util.parseMsg( + 'api-help-param-limit2', pi.parameters[ i ].max, pi.parameters[ i ].highmax + ), + ' ', + Util.parseMsg( 'apisandbox-param-limit' ) + ] } ) ); } else { dl.append( $( '

', { addClass: 'info', - append: Util.parseHTML( mw.message( - 'api-help-param-limit', pi.parameters[ i ].max - ).parse() ) + append: [ + Util.parseMsg( 'api-help-param-limit', pi.parameters[ i ].max ), + ' ', + Util.parseMsg( 'apisandbox-param-limit' ) + ] } ) ); } break; @@ -1356,11 +1428,11 @@ if ( tmp !== '' ) { dl.append( $( '

', { addClass: 'info', - append: Util.parseHTML( mw.message( + append: Util.parseMsg( 'api-help-param-integer-' + tmp, Util.apiBool( pi.parameters[ i ].multi ) ? 2 : 1, pi.parameters[ i ].min, pi.parameters[ i ].max - ).parse() ) + ) } ) ); } break; @@ -1440,7 +1512,7 @@ items.push( new OO.ui.FieldLayout( new OO.ui.Widget( {} ).toggle( false ), { align: 'top', - label: Util.parseHTML( mw.message( 'apisandbox-no-parameters' ).parse() ) + label: Util.parseMsg( 'apisandbox-no-parameters' ) } ) ); } diff --git a/resources/src/mediawiki.special/mediawiki.special.changeslist.css b/resources/src/mediawiki.special/mediawiki.special.changeslist.css index a06aa95ca4..3e1bd4e8c4 100644 --- a/resources/src/mediawiki.special/mediawiki.special.changeslist.css +++ b/resources/src/mediawiki.special/mediawiki.special.changeslist.css @@ -26,7 +26,7 @@ } .mw-plusminus-null { - color: #aaa; /* gray */ + color: #a2a9b1; /* gray */ } /* diff --git a/resources/src/mediawiki.special/mediawiki.special.edittags.js b/resources/src/mediawiki.special/mediawiki.special.edittags.js index 69a2a67ab3..3e6e684332 100644 --- a/resources/src/mediawiki.special/mediawiki.special.edittags.js +++ b/resources/src/mediawiki.special/mediawiki.special.edittags.js @@ -6,9 +6,10 @@ var $tagList = $( '#mw-edittags-tag-list' ); if ( $tagList.length ) { $tagList.chosen( { - /*jscs:disable requireCamelCaseOrUpperCaseIdentifiers */ + /* eslint-disable camelcase */ placeholder_text_multiple: mw.msg( 'tags-edit-chosen-placeholder' ), no_results_text: mw.msg( 'tags-edit-chosen-no-results' ) + /* eslint-enable camelcase */ } ); } diff --git a/resources/src/mediawiki.special/mediawiki.special.recentchanges.js b/resources/src/mediawiki.special/mediawiki.special.recentchanges.js index bdd45bc824..29c0feaf17 100644 --- a/resources/src/mediawiki.special/mediawiki.special.recentchanges.js +++ b/resources/src/mediawiki.special/mediawiki.special.recentchanges.js @@ -21,7 +21,6 @@ $checkboxes.prop( 'disabled', isAllNS ); }, - /** */ init: function () { $select = $( '#namespace' ); $checkboxes = $( '#nsassociated, #nsinvert' ); diff --git a/resources/src/mediawiki.special/mediawiki.special.search.styles.css b/resources/src/mediawiki.special/mediawiki.special.search.styles.css index 5191f92b16..ebe9ed94ce 100644 --- a/resources/src/mediawiki.special/mediawiki.special.search.styles.css +++ b/resources/src/mediawiki.special/mediawiki.special.search.styles.css @@ -53,9 +53,9 @@ font-size: 97%; } .mw-search-profile-tabs { - background-color: #f3f3f3; + background-color: #f8f9fa; margin-top: 1em; - border: 1px solid #c0c0c0; + border: 1px solid #c8ccd1; } .search-types { float: left; @@ -76,7 +76,7 @@ padding: 0.5em; } .search-types .current a { - color: #333; + color: #222; cursor: default; } .search-types .current a:hover { @@ -86,7 +86,7 @@ float: right; padding: 0.5em; padding-right: 0.75em; - color: #666; + color: #54595d; font-size: 95%; } #mw-search-top-table div.oo-ui-actionFieldLayout { @@ -96,8 +96,8 @@ #mw-searchoptions { margin: 0; padding: 0.5em 0.75em 0.75em 0.75em; - background-color: #f9f9f9; - border: 1px solid #c0c0c0; + background-color: #f8f9fa; + border: 1px solid #c8ccd1; border-top-width: 0; } #mw-searchoptions legend { @@ -119,7 +119,7 @@ } #mw-searchoptions .divider { clear: both; - border-bottom: 1px solid #ddd; + border-bottom: 1px solid #eaecf0; padding-top: 0.5em; margin-bottom: 0.5em; } @@ -130,7 +130,7 @@ #mw-search-interwiki { float: right; width: 18em; - border: 1px solid #aaa; + border: 1px solid #a2a9b1; margin-top: 2ex; } .searchalttitle, @@ -150,12 +150,12 @@ font-size: 97%; text-align: left; padding: 0.15em 0.15em 0.2em 0.2em; - background-color: #ececec; - border-top: 1px solid #bbb; + background-color: #eaecf0; + border-top: 1px solid #c8ccd1; } .searchdidyoumean { font-size: 127%; margin-top: 0.8em; /* Note that this color won't affect the link, as desired. */ - color: #c00; + color: #d33; } diff --git a/resources/src/mediawiki.special/mediawiki.special.upload.js b/resources/src/mediawiki.special/mediawiki.special.upload.js index dd483675f1..f818096377 100644 --- a/resources/src/mediawiki.special/mediawiki.special.upload.js +++ b/resources/src/mediawiki.special/mediawiki.special.upload.js @@ -5,8 +5,11 @@ * @class mw.special.upload * @singleton */ + +/* eslint-disable no-use-before-define */ +/* global Uint8Array */ + ( function ( mw, $ ) { - /*jshint latedef:false */ var uploadWarning, uploadLicense, ajaxUploadDestCheck = mw.config.get( 'wgAjaxUploadDestCheck' ), $license = $( '#wpLicense' ); @@ -266,6 +269,8 @@ $( function () { /** * Is the FileAPI available with sufficient functionality? + * + * @return {boolean} */ function hasFileAPI() { return window.FileReader !== undefined; @@ -421,9 +426,8 @@ }, mw.config.get( 'wgFileCanRotate' ) ? function ( data ) { try { meta = mw.libs.jpegmeta( data, file.fileName ); - // jscs:disable requireCamelCaseOrUpperCaseIdentifiers, disallowDanglingUnderscores + // eslint-disable-next-line no-underscore-dangle, camelcase meta._binary_data = null; - // jscs:enable } catch ( e ) { meta = null; } @@ -499,6 +503,9 @@ /** * Check if the file does not exceed the maximum size + * + * @param {File} file + * @return {boolean} */ function checkMaxUploadSize( file ) { var maxSize, $error; @@ -531,10 +538,11 @@ if ( hasFileAPI() ) { // Update thumbnail when the file selection control is updated. $( '#wpUploadFile' ).change( function () { + var file; clearPreview(); if ( this.files && this.files.length ) { // Note: would need to be updated to handle multiple files. - var file = this.files[ 0 ]; + file = this.files[ 0 ]; if ( !checkMaxUploadSize( file ) ) { return; diff --git a/resources/src/mediawiki.special/mediawiki.special.watchlist.js b/resources/src/mediawiki.special/mediawiki.special.watchlist.js index a35f4d1064..9ca98c08ee 100644 --- a/resources/src/mediawiki.special/mediawiki.special.watchlist.js +++ b/resources/src/mediawiki.special/mediawiki.special.watchlist.js @@ -1,15 +1,63 @@ /*! * JavaScript for Special:Watchlist - * - * This script is only loaded, if the user opt-in a setting in Special:Preferences, - * that the watchlist should be automatically reloaded, when a filter option is - * changed in the header form. */ -jQuery( function ( $ ) { - // add a listener on all form elements in the header form - $( '#mw-watchlist-form input, #mw-watchlist-form select' ).on( 'change', function () { - // submit the form, when one of the input fields was changed - $( '#mw-watchlist-form' ).submit(); +( function ( mw, $, OO ) { + $( function () { + var $progressBar, $resetForm = $( '#mw-watchlist-resetbutton' ); + + // If the user wants to reset their watchlist, use an API call to do so (no reload required) + // Adapted from a user script by User:NQ of English Wikipedia + // (User:NQ/WatchlistResetConfirm.js) + $resetForm.submit( function ( event ) { + var $button = $resetForm.find( 'input[name=mw-watchlist-reset-submit]' ); + + event.preventDefault(); + + // Disable reset button to prevent multiple concurrent requests + $button.prop( 'disabled', true ); + + // Show progress bar + if ( $progressBar ) { + $progressBar.css( 'visibility', 'visible' ); + } else { + $progressBar = new OO.ui.ProgressBarWidget( { progress: false } ).$element; + $progressBar.css( { + position: 'absolute', + width: '100%' + } ); + $resetForm.append( $progressBar ); + } + + // Use action=setnotificationtimestamp to mark all as visited, + // then set all watchlist lines accordingly + new mw.Api().postWithToken( 'csrf', { + formatversion: 2, + action: 'setnotificationtimestamp', + entirewatchlist: true + } ).done( function () { + // Enable button again + $button.prop( 'disabled', false ); + // Hide the button because further clicks can not generate any visual changes + $button.css( 'visibility', 'hidden' ); + $progressBar.css( 'visibility', 'hidden' ); + $( '.mw-changeslist-line-watched' ) + .removeClass( 'mw-changeslist-line-watched' ) + .addClass( 'mw-changeslist-line-not-watched' ); + } ).fail( function () { + // On error, fall back to server-side reset + // First remove this submit listener and then re-submit the form + $resetForm.off( 'submit' ).submit(); + } ); + } ); + + // if the user wishes to reload the watchlist whenever a filter changes + if ( mw.user.options.get( 'watchlistreloadautomatically' ) ) { + // add a listener on all form elements in the header form + $( '#mw-watchlist-form input, #mw-watchlist-form select' ).on( 'change', function () { + // submit the form when one of the input fields is modified + $( '#mw-watchlist-form' ).submit(); + } ); + } } ); -} ); +}( mediaWiki, jQuery, OO ) ); diff --git a/resources/src/mediawiki.toolbar/toolbar.js b/resources/src/mediawiki.toolbar/toolbar.js index bb26c0fc2e..e9fc024605 100644 --- a/resources/src/mediawiki.toolbar/toolbar.js +++ b/resources/src/mediawiki.toolbar/toolbar.js @@ -28,6 +28,11 @@ * current cursor position. * @param {string} [button.imageId] `id` attribute of the button HTML element. Can be * used to define the image with CSS if it's not provided as `imageFile`. + * @param {string} [speedTip] + * @param {string} [tagOpen] + * @param {string} [tagClose] + * @param {string} [sampleText] + * @param {string} [imageId] */ function insertButton( button, speedTip, tagOpen, tagClose, sampleText, imageId ) { var $button; diff --git a/resources/src/mediawiki.widgets.datetime/CalendarWidget.js b/resources/src/mediawiki.widgets.datetime/CalendarWidget.js index 31b1cd5b44..54a5a850bc 100644 --- a/resources/src/mediawiki.widgets.datetime/CalendarWidget.js +++ b/resources/src/mediawiki.widgets.datetime/CalendarWidget.js @@ -202,6 +202,7 @@ return this.selected; }; + // eslint-disable-next-line valid-jsdoc /** * Set the selected dates * @@ -250,6 +251,7 @@ return this.focusedDate; }; + // eslint-disable-next-line valid-jsdoc /** * Set the currently-focused date * @@ -498,6 +500,7 @@ * * @protected * @param {jQuery.Event} e Key down event + * @return {boolean} False to cancel the default event */ mw.widgets.datetime.CalendarWidget.prototype.onKeyDown = function ( e ) { var focusedDate = this.getFocusedDate(); diff --git a/resources/src/mediawiki.widgets.datetime/DateTimeFormatter.js b/resources/src/mediawiki.widgets.datetime/DateTimeFormatter.js index 1c542341d3..1793849368 100644 --- a/resources/src/mediawiki.widgets.datetime/DateTimeFormatter.js +++ b/resources/src/mediawiki.widgets.datetime/DateTimeFormatter.js @@ -21,23 +21,21 @@ * Defaults to the current date and time (with 0 milliseconds). */ mw.widgets.datetime.DateTimeFormatter = function MwWidgetsDatetimeDateTimeFormatter( config ) { - var statick = this.constructor[ 'static' ]; - - statick.setupDefaults(); + this.constructor.static.setupDefaults(); config = $.extend( { format: '@default', local: false, - fullZones: statick.fullZones, - shortZones: statick.shortZones + fullZones: this.constructor.static.fullZones, + shortZones: this.constructor.static.shortZones }, config ); // Mixin constructors OO.EventEmitter.call( this ); // Properties - if ( statick.formats[ config.format ] ) { - this.format = statick.formats[ config.format ]; + if ( this.constructor.static.formats[ config.format ] ) { + this.format = this.constructor.static.formats[ config.format ]; } else { this.format = config.format; } @@ -70,7 +68,7 @@ * @inheritable * @property {Object} */ - mw.widgets.datetime.DateTimeFormatter[ 'static' ].formats = {}; + mw.widgets.datetime.DateTimeFormatter.static.formats = {}; /** * Default time zone indicators @@ -79,7 +77,7 @@ * @inheritable * @property {string[]} */ - mw.widgets.datetime.DateTimeFormatter[ 'static' ].fullZones = null; + mw.widgets.datetime.DateTimeFormatter.static.fullZones = null; /** * Default abbreviated time zone indicators @@ -88,9 +86,9 @@ * @inheritable * @property {string[]} */ - mw.widgets.datetime.DateTimeFormatter[ 'static' ].shortZones = null; + mw.widgets.datetime.DateTimeFormatter.static.shortZones = null; - mw.widgets.datetime.DateTimeFormatter[ 'static' ].setupDefaults = function () { + mw.widgets.datetime.DateTimeFormatter.static.setupDefaults = function () { if ( !this.fullZones ) { this.fullZones = [ mw.msg( 'timezone-utc' ), @@ -127,6 +125,7 @@ return this.local; }; + // eslint-disable-next-line valid-jsdoc /** * Toggle whether dates are in local time or UTC * @@ -464,7 +463,7 @@ * - 'clip': "Jan 32" => "Jan 31", "Feb 32" => "Feb 28" (or 29), "Feb 0" => "Feb 1", etc. * @return {Date} Adjusted date */ - mw.widgets.datetime.DateTimeFormatter.prototype.adjustComponent = function ( date /*, component, delta, mode */ ) { + mw.widgets.datetime.DateTimeFormatter.prototype.adjustComponent = function ( date /* , component, delta, mode */ ) { // Should be overridden by subclass return date; }; diff --git a/resources/src/mediawiki.widgets.datetime/DateTimeInputWidget.js b/resources/src/mediawiki.widgets.datetime/DateTimeInputWidget.js index a3088ec5ca..e9bedf5b32 100644 --- a/resources/src/mediawiki.widgets.datetime/DateTimeInputWidget.js +++ b/resources/src/mediawiki.widgets.datetime/DateTimeInputWidget.js @@ -177,7 +177,7 @@ /* Static properties */ - mw.widgets.datetime.DateTimeInputWidget[ 'static' ].supportsSimpleLabel = false; + mw.widgets.datetime.DateTimeInputWidget.static.supportsSimpleLabel = false; /* Events */ @@ -583,6 +583,7 @@ * @private * @param {jQuery} $field * @param {jQuery.Event} e Key down event + * @return {boolean} False to cancel the default event */ mw.widgets.datetime.DateTimeInputWidget.prototype.onFieldKeyDown = function ( $field, e ) { var spec = $field.data( 'mw-widgets-datetime-dateTimeInputWidget-fieldSpec' ); @@ -704,6 +705,7 @@ * @private * @param {jQuery} $field * @param {jQuery.Event} e Change event + * @return {boolean} False to cancel the default event */ mw.widgets.datetime.DateTimeInputWidget.prototype.onFieldWheel = function ( $field, e ) { var delta = 0, diff --git a/resources/src/mediawiki.widgets.datetime/DiscordianDateTimeFormatter.js b/resources/src/mediawiki.widgets.datetime/DiscordianDateTimeFormatter.js index fbf323844b..b280eadc03 100644 --- a/resources/src/mediawiki.widgets.datetime/DiscordianDateTimeFormatter.js +++ b/resources/src/mediawiki.widgets.datetime/DiscordianDateTimeFormatter.js @@ -32,7 +32,7 @@ /** * @inheritdoc */ - mw.widgets.datetime.DiscordianDateTimeFormatter[ 'static' ].formats = { + mw.widgets.datetime.DiscordianDateTimeFormatter.static.formats = { '@time': '${hour|0}:${minute|0}:${second|0}', '@date': '$!{dow|full}${not-intercalary|1|, }${season|full}${not-intercalary|1| }${day|#}, ${year|#}', '@datetime': '$!{dow|full}${not-intercalary|1|, }${season|full}${not-intercalary|1| }${day|#}, ${year|#} ${hour|0}:${minute|0}:${second|0} $!{zone|short}', diff --git a/resources/src/mediawiki.widgets.datetime/ProlepticGregorianDateTimeFormatter.js b/resources/src/mediawiki.widgets.datetime/ProlepticGregorianDateTimeFormatter.js index f60b34bdcc..9e9b15ff26 100644 --- a/resources/src/mediawiki.widgets.datetime/ProlepticGregorianDateTimeFormatter.js +++ b/resources/src/mediawiki.widgets.datetime/ProlepticGregorianDateTimeFormatter.js @@ -26,13 +26,11 @@ * @cfg {number} [weekStartsOn=0] What day the week starts on: 0 is Sunday, 1 is Monday, 6 is Saturday. */ mw.widgets.datetime.ProlepticGregorianDateTimeFormatter = function MwWidgetsDatetimeProlepticGregorianDateTimeFormatter( config ) { - var statick = this.constructor[ 'static' ]; - - statick.setupDefaults(); + this.constructor.static.setupDefaults(); config = $.extend( { weekStartsOn: 0, - hour12Periods: statick.hour12Periods + hour12Periods: this.constructor.static.hour12Periods }, config ); if ( config.fullMonthNames && !config.shortMonthNames ) { @@ -60,11 +58,11 @@ }.bind( this ) ); } config = $.extend( { - fullMonthNames: statick.fullMonthNames, - shortMonthNames: statick.shortMonthNames, - fullDayNames: statick.fullDayNames, - shortDayNames: statick.shortDayNames, - dayLetters: statick.dayLetters + fullMonthNames: this.constructor.static.fullMonthNames, + shortMonthNames: this.constructor.static.shortMonthNames, + fullDayNames: this.constructor.static.fullDayNames, + shortDayNames: this.constructor.static.shortDayNames, + dayLetters: this.constructor.static.dayLetters }, config ); // Parent constructor @@ -89,7 +87,7 @@ /** * @inheritdoc */ - mw.widgets.datetime.ProlepticGregorianDateTimeFormatter[ 'static' ].formats = { + mw.widgets.datetime.ProlepticGregorianDateTimeFormatter.static.formats = { '@time': '${hour|0}:${minute|0}:${second|0}', '@date': '$!{dow|short} ${day|#} ${month|short} ${year|#}', '@datetime': '$!{dow|short} ${day|#} ${month|short} ${year|#} ${hour|0}:${minute|0}:${second|0} $!{zone|short}', @@ -103,7 +101,7 @@ * @inheritable * @property {Object} */ - mw.widgets.datetime.ProlepticGregorianDateTimeFormatter[ 'static' ].fullMonthNames = null; + mw.widgets.datetime.ProlepticGregorianDateTimeFormatter.static.fullMonthNames = null; /** * Default abbreviated month names. @@ -112,7 +110,7 @@ * @inheritable * @property {Object} */ - mw.widgets.datetime.ProlepticGregorianDateTimeFormatter[ 'static' ].shortMonthNames = null; + mw.widgets.datetime.ProlepticGregorianDateTimeFormatter.static.shortMonthNames = null; /** * Default full day of week names. @@ -121,7 +119,7 @@ * @inheritable * @property {Object} */ - mw.widgets.datetime.ProlepticGregorianDateTimeFormatter[ 'static' ].fullDayNames = null; + mw.widgets.datetime.ProlepticGregorianDateTimeFormatter.static.fullDayNames = null; /** * Default abbreviated day of week names. @@ -130,7 +128,7 @@ * @inheritable * @property {Object} */ - mw.widgets.datetime.ProlepticGregorianDateTimeFormatter[ 'static' ].shortDayNames = null; + mw.widgets.datetime.ProlepticGregorianDateTimeFormatter.static.shortDayNames = null; /** * Default day letters. @@ -139,7 +137,7 @@ * @inheritable * @property {string[]} */ - mw.widgets.datetime.ProlepticGregorianDateTimeFormatter[ 'static' ].dayLetters = null; + mw.widgets.datetime.ProlepticGregorianDateTimeFormatter.static.dayLetters = null; /** * Default AM/PM indicators @@ -148,10 +146,10 @@ * @inheritable * @property {string[]} */ - mw.widgets.datetime.ProlepticGregorianDateTimeFormatter[ 'static' ].hour12Periods = null; + mw.widgets.datetime.ProlepticGregorianDateTimeFormatter.static.hour12Periods = null; - mw.widgets.datetime.ProlepticGregorianDateTimeFormatter[ 'static' ].setupDefaults = function () { - mw.widgets.datetime.DateTimeFormatter[ 'static' ].setupDefaults.call( this ); + mw.widgets.datetime.ProlepticGregorianDateTimeFormatter.static.setupDefaults = function () { + mw.widgets.datetime.DateTimeFormatter.static.setupDefaults.call( this ); if ( this.fullMonthNames && !this.shortMonthNames ) { this.shortMonthNames = {}; diff --git a/resources/src/mediawiki.widgets/MediaSearch/broken-image.png b/resources/src/mediawiki.widgets/MediaSearch/broken-image.png new file mode 100644 index 0000000000..f5be958407 Binary files /dev/null and b/resources/src/mediawiki.widgets/MediaSearch/broken-image.png differ diff --git a/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.APIResultsProvider.js b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.APIResultsProvider.js new file mode 100644 index 0000000000..dd07b928a4 --- /dev/null +++ b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.APIResultsProvider.js @@ -0,0 +1,229 @@ +/*! + * MediaWiki Widgets - APIResultsProvider class. + * + * @copyright 2011-2016 VisualEditor Team and others; see http://ve.mit-license.org + */ +( function ( $, mw ) { + + /** + * API Results Provider object. + * + * @class + * @mixins OO.EventEmitter + * + * @constructor + * @param {string} apiurl The URL to the api + * @param {Object} [config] Configuration options + * @cfg {number} fetchLimit The default number of results to fetch + * @cfg {string} lang The language of the API + * @cfg {number} offset Initial offset, if relevant, to call results from + * @cfg {Object} ajaxSettings The settings for the ajax call + * @cfg {Object} staticParams The data parameters that are static and should + * always be sent to the API request, as opposed to user parameters. + * @cfg {Object} userParams Initial user parameters to be sent as data to + * the API request. These can change per request, like the search query term + * or sizing parameters for images, etc. + */ + mw.widgets.APIResultsProvider = function MwWidgetsAPIResultsProvider( apiurl, config ) { + config = config || {}; + + this.setAPIurl( apiurl ); + this.setDefaultFetchLimit( config.fetchLimit || 30 ); + this.setLang( config.lang ); + this.setOffset( config.offset || 0 ); + this.setAjaxSettings( config.ajaxSettings || {} ); + + this.staticParams = config.staticParams || {}; + this.userParams = config.userParams || {}; + + this.toggleDepleted( false ); + + // Mixin constructors + OO.EventEmitter.call( this ); + }; + + /* Setup */ + OO.mixinClass( mw.widgets.APIResultsProvider, OO.EventEmitter ); + + /* Methods */ + + /** + * Get results from the source + * + * @param {number} howMany Number of results to ask for + * @return {jQuery.Promise} Promise that is resolved into an array + * of available results, or is rejected if no results are available. + */ + mw.widgets.APIResultsProvider.prototype.getResults = function () { + var xhr, + deferred = $.Deferred(), + allParams = $.extend( {}, this.getStaticParams(), this.getUserParams() ); + + xhr = $.getJSON( this.getAPIurl(), allParams ) + .done( function ( data ) { + if ( + $.type( data ) !== 'array' || + ( + $.type( data ) === 'array' && + data.length === 0 + ) + ) { + deferred.resolve(); + } else { + deferred.resolve( data ); + } + } ); + return deferred.promise( { abort: xhr.abort } ); + }; + + /** + * Set API url + * + * @param {string} apiurl API url + */ + mw.widgets.APIResultsProvider.prototype.setAPIurl = function ( apiurl ) { + this.apiurl = apiurl; + }; + + /** + * Set api url + * + * @return {string} API url + */ + mw.widgets.APIResultsProvider.prototype.getAPIurl = function () { + return this.apiurl; + }; + + /** + * Get the static, non-changing data parameters sent to the API + * + * @return {Object} Data parameters + */ + mw.widgets.APIResultsProvider.prototype.getStaticParams = function () { + return this.staticParams; + }; + + /** + * Get the user-inputted dynamic data parameters sent to the API + * + * @return {Object} Data parameters + */ + mw.widgets.APIResultsProvider.prototype.getUserParams = function () { + return this.userParams; + }; + + /** + * Set the data parameters sent to the API + * + * @param {Object} params User defined data parameters + */ + mw.widgets.APIResultsProvider.prototype.setUserParams = function ( params ) { + // Asymmetrically compare (params is subset of this.userParams) + if ( !OO.compare( params, this.userParams, true ) ) { + this.userParams = $.extend( {}, this.userParams, params ); + this.reset(); + } + }; + + /** + * Reset the provider + */ + mw.widgets.APIResultsProvider.prototype.reset = function () { + // Reset offset + this.setOffset( 0 ); + // Reset depleted status + this.toggleDepleted( false ); + }; + + /** + * Get fetch limit or 'page' size. This is the number + * of results per request. + * + * @return {number} limit + */ + mw.widgets.APIResultsProvider.prototype.getDefaultFetchLimit = function () { + return this.limit; + }; + + /** + * Set limit + * + * @param {number} limit Default number of results to fetch from the API + */ + mw.widgets.APIResultsProvider.prototype.setDefaultFetchLimit = function ( limit ) { + this.limit = limit; + }; + + /** + * Get provider API language + * + * @return {string} Provider API language + */ + mw.widgets.APIResultsProvider.prototype.getLang = function () { + return this.lang; + }; + + /** + * Set provider API language + * + * @param {string} lang Provider API language + */ + mw.widgets.APIResultsProvider.prototype.setLang = function ( lang ) { + this.lang = lang; + }; + + /** + * Get result offset + * + * @return {number} Offset Results offset for the upcoming request + */ + mw.widgets.APIResultsProvider.prototype.getOffset = function () { + return this.offset; + }; + + /** + * Set result offset + * + * @param {number} offset Results offset for the upcoming request + */ + mw.widgets.APIResultsProvider.prototype.setOffset = function ( offset ) { + this.offset = offset; + }; + + /** + * Check whether the provider is depleted and has no more results + * to hand off. + * + * @return {boolean} The provider is depleted + */ + mw.widgets.APIResultsProvider.prototype.isDepleted = function () { + return this.depleted; + }; + + /** + * Toggle depleted state + * + * @param {boolean} isDepleted The provider is depleted + */ + mw.widgets.APIResultsProvider.prototype.toggleDepleted = function ( isDepleted ) { + this.depleted = isDepleted !== undefined ? isDepleted : !this.depleted; + }; + + /** + * Get the default ajax settings + * + * @return {Object} Ajax settings + */ + mw.widgets.APIResultsProvider.prototype.getAjaxSettings = function () { + return this.ajaxSettings; + }; + + /** + * Get the default ajax settings + * + * @param {Object} settings Ajax settings + */ + mw.widgets.APIResultsProvider.prototype.setAjaxSettings = function ( settings ) { + this.ajaxSettings = settings; + }; +}( jQuery, mediaWiki ) ); diff --git a/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.APIResultsQueue.js b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.APIResultsQueue.js new file mode 100644 index 0000000000..3bc1d51bac --- /dev/null +++ b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.APIResultsQueue.js @@ -0,0 +1,224 @@ +/*! + * MediaWiki Widgets - APIResultsQueue class. + * + * @copyright 2011-2016 VisualEditor Team and others; see http://ve.mit-license.org + */ +( function ( $, mw ) { + + /** + * API Results Queue object. + * + * @class + * @mixins OO.EventEmitter + * + * @constructor + * @param {Object} [config] Configuration options + * @cfg {number} limit The default number of results to fetch + * @cfg {number} threshold The default number of extra results + * that the queue should always strive to have on top of the + * individual requests for items. + */ + mw.widgets.APIResultsQueue = function MwWidgetsAPIResultsQueue( config ) { + config = config || {}; + + this.fileRepoPromise = null; + this.providers = []; + this.providerPromises = []; + this.queue = []; + + this.params = {}; + + this.limit = config.limit || 20; + this.setThreshold( config.threshold || 10 ); + + // Mixin constructors + OO.EventEmitter.call( this ); + }; + + /* Setup */ + OO.mixinClass( mw.widgets.APIResultsQueue, OO.EventEmitter ); + + /* Methods */ + + /** + * Set up the queue and its resources. + * This should be overridden if there are any setup steps to perform. + * + * @return {jQuery.Promise} Promise that resolves when the resources + * are set up. Note: The promise must have an .abort() functionality. + */ + mw.widgets.APIResultsQueue.prototype.setup = function () { + return $.Deferred().resolve().promise( { abort: $.noop } ); + }; + + /** + * Get items from the queue + * + * @param {number} [howMany] How many items to retrieve. Defaults to the + * default limit supplied on initialization. + * @return {jQuery.Promise} Promise that resolves into an array of items. + */ + mw.widgets.APIResultsQueue.prototype.get = function ( howMany ) { + var fetchingPromise = null, + me = this; + + howMany = howMany || this.limit; + + // Check if the queue has enough items + if ( this.queue.length < howMany + this.threshold ) { + // Call for more results + fetchingPromise = this.queryProviders( howMany + this.threshold ) + .then( function ( items ) { + // Add to the queue + me.queue = me.queue.concat.apply( me.queue, items ); + } ); + } + + return $.when( fetchingPromise ) + .then( function () { + return me.queue.splice( 0, howMany ); + } ); + + }; + + /** + * Get results from all providers + * + * @param {number} [howMany] How many items to retrieve. Defaults to the + * default limit supplied on initialization. + * @return {jQuery.Promise} Promise that is resolved into an array + * of fetched items. Note: The promise must have an .abort() functionality. + */ + mw.widgets.APIResultsQueue.prototype.queryProviders = function ( howMany ) { + var i, len, + queue = this; + + // Make sure there are resources set up + return this.setup() + .then( function () { + // Abort previous requests + for ( i = 0, len = queue.providerPromises.length; i < len; i++ ) { + queue.providerPromises[ i ].abort(); + } + queue.providerPromises = []; + // Set up the query to all providers + for ( i = 0, len = queue.providers.length; i < len; i++ ) { + if ( !queue.providers[ i ].isDepleted() ) { + queue.providerPromises.push( + queue.providers[ i ].getResults( howMany ) + ); + } + } + + return $.when.apply( $, queue.providerPromises ) + .then( Array.prototype.concat.bind( [] ) ); + } ); + }; + + /** + * Set the search query for all the providers. + * + * This also makes sure to abort any previous promises. + * + * @param {Object} params API search parameters + */ + mw.widgets.APIResultsQueue.prototype.setParams = function ( params ) { + var i, len; + if ( !OO.compare( params, this.params, true ) ) { + this.reset(); + this.params = $.extend( this.params, params ); + // Reset queue + this.queue = []; + // Reset promises + for ( i = 0, len = this.providerPromises.length; i < len; i++ ) { + this.providerPromises[ i ].abort(); + } + // Change queries + for ( i = 0, len = this.providers.length; i < len; i++ ) { + this.providers[ i ].setUserParams( this.params ); + } + } + }; + + /** + * Reset the queue and all its providers + */ + mw.widgets.APIResultsQueue.prototype.reset = function () { + var i, len; + // Reset queue + this.queue = []; + // Reset promises + for ( i = 0, len = this.providerPromises.length; i < len; i++ ) { + this.providerPromises[ i ].abort(); + } + // Change queries + for ( i = 0, len = this.providers.length; i < len; i++ ) { + this.providers[ i ].reset(); + } + }; + + /** + * Get the data parameters sent to the API + * + * @return {Object} params API search parameters + */ + mw.widgets.APIResultsQueue.prototype.getParams = function () { + return this.params; + }; + + /** + * Set the providers + * + * @param {mw.widgets.APIResultsProvider[]} providers An array of providers + */ + mw.widgets.APIResultsQueue.prototype.setProviders = function ( providers ) { + this.providers = providers; + }; + + /** + * Add a provider to the group + * + * @param {mw.widgets.APIResultsProvider} provider A provider object + */ + mw.widgets.APIResultsQueue.prototype.addProvider = function ( provider ) { + this.providers.push( provider ); + }; + + /** + * Set the providers + * + * @return {mw.widgets.APIResultsProvider[]} providers An array of providers + */ + mw.widgets.APIResultsQueue.prototype.getProviders = function () { + return this.providers; + }; + + /** + * Get the queue size + * + * @return {number} Queue size + */ + mw.widgets.APIResultsQueue.prototype.getQueueSize = function () { + return this.queue.length; + }; + + /** + * Set queue threshold + * + * @param {number} threshold Queue threshold, below which we will + * request more items + */ + mw.widgets.APIResultsQueue.prototype.setThreshold = function ( threshold ) { + this.threshold = threshold; + }; + + /** + * Get queue threshold + * + * @return {number} threshold Queue threshold, below which we will + * request more items + */ + mw.widgets.APIResultsQueue.prototype.getThreshold = function () { + return this.threshold; + }; +}( jQuery, mediaWiki ) ); diff --git a/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaResourceProvider.js b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaResourceProvider.js new file mode 100644 index 0000000000..d767109c2d --- /dev/null +++ b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaResourceProvider.js @@ -0,0 +1,322 @@ +/*! + * MediaWiki Widgets - MediaResourceProvider class. + * + * @copyright 2011-2016 VisualEditor Team and others; see AUTHORS.txt + * @license The MIT License (MIT); see LICENSE.txt + */ +( function ( $, mw ) { + + /** + * MediaWiki media resource provider. + * + * @class + * @extends mw.widgets.APIResultsProvider + * + * @constructor + * @param {string} apiurl The API url + * @param {Object} [config] Configuration options + * @cfg {string} [scriptDirUrl] The url of the API script + */ + mw.widgets.MediaResourceProvider = function MwWidgetsMediaResourceProvider( apiurl, config ) { + config = config || {}; + + // Parent constructor + mw.widgets.MediaResourceProvider.super.call( this, apiurl, config ); + + // Fetching configuration + this.scriptDirUrl = config.scriptDirUrl; + this.isLocal = config.local !== undefined; + + if ( this.isLocal ) { + this.setAPIurl( mw.util.wikiScript( 'api' ) ); + } else { + // If 'apiurl' is set, use that. Otherwise, build the url + // from scriptDirUrl and /api.php suffix + this.setAPIurl( this.getAPIurl() || ( this.scriptDirUrl + '/api.php' ) ); + } + + this.siteInfoPromise = null; + this.thumbSizes = []; + this.imageSizes = []; + }; + + /* Inheritance */ + OO.inheritClass( mw.widgets.MediaResourceProvider, mw.widgets.APIResultsProvider ); + + /* Methods */ + + /** + * @inheritdoc + */ + mw.widgets.MediaResourceProvider.prototype.getStaticParams = function () { + return $.extend( + {}, + // Parent method + mw.widgets.MediaResourceProvider.super.prototype.getStaticParams.call( this ), + { + action: 'query', + iiprop: 'dimensions|url|mediatype|extmetadata|timestamp|user', + iiextmetadatalanguage: this.getLang(), + prop: 'imageinfo' + } + ); + }; + + /** + * Initialize the source and get the site info. + * + * Connect to the api url and retrieve the siteinfo parameters + * that are required for fetching results. + * + * @return {jQuery.Promise} Promise that resolves when the class + * properties are set. + */ + mw.widgets.MediaResourceProvider.prototype.loadSiteInfo = function () { + var provider = this; + + if ( !this.siteInfoPromise ) { + this.siteInfoPromise = new mw.Api().get( { + action: 'query', + meta: 'siteinfo' + } ) + .then( function ( data ) { + provider.setImageSizes( data.query.general.imagelimits || [] ); + provider.setThumbSizes( data.query.general.thumblimits || [] ); + provider.setUserParams( { + // Standard width per resource + iiurlwidth: provider.getStandardWidth() + } ); + } ); + } + return this.siteInfoPromise; + }; + + /** + * Override parent method and get results from the source + * + * @param {number} [howMany] The number of items to pull from the API + * @return {jQuery.Promise} Promise that is resolved into an array + * of available results, or is rejected if no results are available. + */ + mw.widgets.MediaResourceProvider.prototype.getResults = function ( howMany ) { + var xhr, + aborted = false, + provider = this; + + return this.loadSiteInfo() + .then( function () { + if ( aborted ) { + return $.Deferred().reject(); + } + xhr = provider.fetchAPIresults( howMany ); + return xhr; + } ) + .then( + function ( results ) { + if ( !results || results.length === 0 ) { + provider.toggleDepleted( true ); + return []; + } + return results; + }, + // Process failed, return an empty promise + function () { + provider.toggleDepleted( true ); + return $.Deferred().resolve( [] ); + } + ) + .promise( { abort: function () { + aborted = true; + if ( xhr ) { + xhr.abort(); + } + } } ); + }; + + /** + * Get continuation API data + * + * @param {number} howMany The number of results to retrieve + * @return {Object} API request data + */ + mw.widgets.MediaResourceProvider.prototype.getContinueData = function () { + return {}; + }; + + /** + * Set continuation data for the next page + * + * @param {Object} continueData Continuation data + */ + mw.widgets.MediaResourceProvider.prototype.setContinue = function () { + }; + + /** + * Sort the results + * + * @param {Object[]} results API results + * @return {Object[]} Sorted results + */ + mw.widgets.MediaResourceProvider.prototype.sort = function ( results ) { + return results; + }; + + /** + * Call the API for search results. + * + * @param {number} howMany The number of results to retrieve + * @return {jQuery.Promise} Promise that resolves with an array of objects that contain + * the fetched data. + */ + mw.widgets.MediaResourceProvider.prototype.fetchAPIresults = function ( howMany ) { + var xhr, api, + provider = this; + + if ( !this.isValid() ) { + return $.Deferred().reject().promise( { abort: $.noop } ); + } + + api = this.isLocal ? new mw.Api() : new mw.ForeignApi( this.getAPIurl(), { anonymous: true } ); + xhr = api.get( $.extend( {}, this.getStaticParams(), this.getUserParams(), this.getContinueData( howMany ) ) ); + return xhr + .then( function ( data ) { + var page, newObj, raw, + results = []; + + if ( data.error ) { + provider.toggleDepleted( true ); + return []; + } + + if ( data.continue ) { + // Update the offset for next time + provider.setContinue( data.continue ); + } else { + // This is the last available set of results. Mark as depleted! + provider.toggleDepleted( true ); + } + + // If the source returned no results, it will not have a + // query property + if ( data.query ) { + raw = data.query.pages; + if ( raw ) { + // Strip away the page ids + for ( page in raw ) { + if ( !raw[ page ].imageinfo ) { + // The search may give us pages that belong to the File: + // namespace but have no files in them, either because + // they were deleted or imported wrongly, or just started + // as pages. In that case, the response will not include + // imageinfo. Skip those files. + continue; + } + newObj = raw[ page ].imageinfo[ 0 ]; + newObj.title = raw[ page ].title; + newObj.index = raw[ page ].index; + results.push( newObj ); + } + } + } + return provider.sort( results ); + } ) + .promise( { abort: xhr.abort } ); + }; + + /** + * Set name + * + * @param {string} name + */ + mw.widgets.MediaResourceProvider.prototype.setName = function ( name ) { + this.name = name; + }; + + /** + * Get name + * + * @return {string} name + */ + mw.widgets.MediaResourceProvider.prototype.getName = function () { + return this.name; + }; + + /** + * Get standard width, based on the provider source's thumb sizes. + * + * @return {number|undefined} fetchWidth + */ + mw.widgets.MediaResourceProvider.prototype.getStandardWidth = function () { + return ( this.thumbSizes && this.thumbSizes[ this.thumbSizes.length - 1 ] ) || + ( this.imageSizes && this.imageSizes[ 0 ] ) || + // Fall back on a number + 300; + }; + + /** + * Get prop + * + * @return {string} prop + */ + mw.widgets.MediaResourceProvider.prototype.getFetchProp = function () { + return this.fetchProp; + }; + + /** + * Set prop + * + * @param {string} prop + */ + mw.widgets.MediaResourceProvider.prototype.setFetchProp = function ( prop ) { + this.fetchProp = prop; + }; + + /** + * Set thumb sizes + * + * @param {number[]} sizes Available thumbnail sizes + */ + mw.widgets.MediaResourceProvider.prototype.setThumbSizes = function ( sizes ) { + this.thumbSizes = sizes; + }; + + /** + * Set image sizes + * + * @param {number[]} sizes Available image sizes + */ + mw.widgets.MediaResourceProvider.prototype.setImageSizes = function ( sizes ) { + this.imageSizes = sizes; + }; + + /** + * Get thumb sizes + * + * @return {number[]} sizes Available thumbnail sizes + */ + mw.widgets.MediaResourceProvider.prototype.getThumbSizes = function () { + return this.thumbSizes; + }; + + /** + * Get image sizes + * + * @return {number[]} sizes Available image sizes + */ + mw.widgets.MediaResourceProvider.prototype.getImageSizes = function () { + return this.imageSizes; + }; + + /** + * Check if this source is valid. + * + * @return {boolean} Source is valid + */ + mw.widgets.MediaResourceProvider.prototype.isValid = function () { + return this.isLocal || + // If we don't have either 'apiurl' or 'scriptDirUrl' + // the source is invalid, and we will skip it + this.apiurl !== undefined || + this.scriptDirUrl !== undefined; + }; +}( jQuery, mediaWiki ) ); diff --git a/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaResourceQueue.js b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaResourceQueue.js new file mode 100644 index 0000000000..34fa44b4ec --- /dev/null +++ b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaResourceQueue.js @@ -0,0 +1,68 @@ +/*! + * MediaWiki Widgets - MediaResourceQueue class. + * + * @copyright 2011-2016 VisualEditor Team and others; see AUTHORS.txt + * @license The MIT License (MIT); see LICENSE.txt + */ +( function ( $, mw ) { + + /** + * MediaWiki media resource queue. + * + * @class + * @extends mw.widgets.APIResultsQueue + * + * @constructor + * @param {Object} [config] Configuration options + * @cfg {number} maxHeight The maximum height of the media, used in the + * search call to the API. + */ + mw.widgets.MediaResourceQueue = function MwWidgetsMediaResourceQueue( config ) { + config = config || {}; + + // Parent constructor + mw.widgets.MediaResourceQueue.super.call( this, config ); + + this.maxHeight = config.maxHeight || 200; + }; + + /* Inheritance */ + OO.inheritClass( mw.widgets.MediaResourceQueue, mw.widgets.APIResultsQueue ); + + /** + * Fetch the file repos. + * + * @return {jQuery.Promise} Promise that resolves when the resources are set up + */ + mw.widgets.MediaResourceQueue.prototype.getFileRepos = function () { + var defaultSource = [ { + url: mw.util.wikiScript( 'api' ), + local: '' + } ]; + + if ( !this.fileRepoPromise ) { + this.fileRepoPromise = new mw.Api().get( { + action: 'query', + meta: 'filerepoinfo' + } ).then( + function ( resp ) { + return resp.query && resp.query.repos || defaultSource; + }, + function () { + return $.Deferred().resolve( defaultSource ); + } + ); + } + + return this.fileRepoPromise; + }; + + /** + * Get image maximum height + * + * @return {string} Image max height + */ + mw.widgets.MediaResourceQueue.prototype.getMaxHeight = function () { + return this.maxHeight; + }; +}( jQuery, mediaWiki ) ); diff --git a/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaResultWidget.css b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaResultWidget.css new file mode 100644 index 0000000000..bc752b5719 --- /dev/null +++ b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaResultWidget.css @@ -0,0 +1,89 @@ +/*! + * MediaWiki Widgets - MediaResultWidget styles. + * + * @copyright 2011-2016 VisualEditor Team and others; see AUTHORS.txt + * @license The MIT License (MIT); see LICENSE.txt + */ + +.mw-widget-mediaResultWidget { + display: inline-block; + position: relative; + padding: 0; + margin: 2px; + overflow: hidden; + box-sizing: border-box; + text-align: center; +} + +.mw-widget-mediaResultWidget-error { + background-color: #f3f3f3; +} + +.mw-widget-mediaResultWidget-thumbnail { + opacity: 0; + display: inline-block; + /* stylelint-disable no-unsupported-browser-features */ + -webkit-transition: opacity 400ms; + -moz-transition: opacity 400ms; + transition: opacity 400ms; + /* stylelint-enable no-unsupported-browser-features */ +} + +.mw-widget-mediaResultWidget-done .mw-widget-mediaResultWidget-thumbnail, +.mw-widget-mediaResultWidget-error .mw-widget-mediaResultWidget-thumbnail { + opacity: 1; +} + +.mw-widget-mediaResultWidget-crop { + background-size: cover; /* stylelint-disable-line no-unsupported-browser-features */ + background-position: center center; +} + +.mw-widget-mediaResultWidget-overlay { + position: absolute; + top: 0; + bottom: 0; + left: 0; + right: 0; + box-shadow: inset 0 0 0 1px #ccc; +} + +.mw-widget-mediaResultWidget.oo-ui-optionWidget-highlighted, +.mw-widget-mediaResultWidget.oo-ui-optionWidget-selected { + box-shadow: 0 0 0.3em #a7dcff, 0 0 0 #fff; +} + +.mw-widget-mediaResultWidget-error .mw-widget-mediaResultWidget-thumbnail { + /* @embed */ + background-image: url( broken-image.png ); + background-size: auto; /* stylelint-disable-line no-unsupported-browser-features */ + background-position: center center; + background-repeat: no-repeat; +} + +.mw-widget-mediaResultWidget .mw-widget-mediaResultWidget-nameLabel { + position: absolute; + bottom: 0; + left: 0; + right: 0; + overflow: hidden; + padding: 0.5em; + color: #fff; + text-shadow: 1px 1px #000; /* stylelint-disable-line no-unsupported-browser-features */ + line-height: 1.125em; + background-color: rgba( 0, 0, 0, 0.5 ); + text-overflow: ellipsis; + text-align: left; +} + +.mw-widget-mediaResultWidget.oo-ui-optionWidget-highlighted .mw-widget-mediaResultWidget-nameLabel { + background-color: rgba( 0, 0, 0, 0.75 ); +} + +.mw-widget-mediaResultWidget.oo-ui-optionWidget-selected .mw-widget-mediaResultWidget-nameLabel { + background-color: #000; +} + +.mw-widget-mediaSearchWidget-noresults { + padding-top: 1em; +} diff --git a/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaResultWidget.js b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaResultWidget.js new file mode 100644 index 0000000000..7607e84258 --- /dev/null +++ b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaResultWidget.js @@ -0,0 +1,274 @@ +/*! + * MediaWiki Widgets - MediaResultWidget class. + * + * @copyright 2011-2016 VisualEditor Team and others; see AUTHORS.txt + * @license The MIT License (MIT); see LICENSE.txt + */ +( function ( $, mw ) { + + /** + * Creates an mw.widgets.MediaResultWidget object. + * + * @class + * @extends OO.ui.OptionWidget + * + * @constructor + * @param {Object} [config] Configuration options + * @cfg {number} [rowHeight] Height of the row this result is part of + * @cfg {number} [maxRowWidth] A limit for the width of the row this + * result is a part of. + * @cfg {number} [minWidth] Minimum width for the result + * @cfg {number} [maxWidth] Maximum width for the result + */ + mw.widgets.MediaResultWidget = function MwWidgetsMediaResultWidget( config ) { + // Configuration initialization + config = config || {}; + + // Parent constructor + mw.widgets.MediaResultWidget.super.call( this, config ); + + // Properties + this.setRowHeight( config.rowHeight || 150 ); + this.maxRowWidth = config.maxRowWidth || 500; + this.minWidth = config.minWidth || this.maxRowWidth / 5; + this.maxWidth = config.maxWidth || this.maxRowWidth * 2 / 3; + + this.imageDimensions = {}; + + this.isAudio = this.data.mediatype === 'AUDIO'; + + // Store the thumbnail url + this.thumbUrl = this.data.thumburl; + this.src = null; + this.row = null; + + this.$thumb = $( '' ) + .addClass( 'mw-widget-mediaResultWidget-thumbnail' ) + .on( { + load: this.onThumbnailLoad.bind( this ), + error: this.onThumbnailError.bind( this ) + } ); + this.$overlay = $( '

' ) + .addClass( 'mw-widget-mediaResultWidget-overlay' ); + + this.calculateSizing( this.data ); + + // Get wiki default thumbnail size + this.defaultThumbSize = mw.config.get( 'wgVisualEditorConfig' ) + .defaultUserOptions.defaultthumbsize; + + // Initialization + this.setLabel( new mw.Title( this.data.title ).getNameText() ); + this.$label.addClass( 'mw-widget-mediaResultWidget-nameLabel' ); + + this.$element + .addClass( 'mw-widget-mediaResultWidget ve-ui-texture-pending' ) + .prepend( this.$thumb, this.$overlay ); + }; + + /* Inheritance */ + + OO.inheritClass( mw.widgets.MediaResultWidget, OO.ui.OptionWidget ); + + /* Static methods */ + + // Copied from ve.dm.MWImageNode + mw.widgets.MediaResultWidget.static.resizeToBoundingBox = function ( imageDimensions, boundingBox ) { + var newDimensions = OO.copy( imageDimensions ), + scale = Math.min( + boundingBox.height / imageDimensions.height, + boundingBox.width / imageDimensions.width + ); + + if ( scale < 1 ) { + // Scale down + newDimensions = { + width: Math.floor( newDimensions.width * scale ), + height: Math.floor( newDimensions.height * scale ) + }; + } + return newDimensions; + }; + + /* Methods */ + /** */ + mw.widgets.MediaResultWidget.prototype.onThumbnailLoad = function () { + this.$thumb.first().addClass( 've-ui-texture-transparency' ); + this.$element + .addClass( 'mw-widget-mediaResultWidget-done' ) + .removeClass( 've-ui-texture-pending' ); + }; + + /** */ + mw.widgets.MediaResultWidget.prototype.onThumbnailError = function () { + this.$thumb.last() + .css( 'background-image', '' ) + .addClass( 've-ui-texture-alert' ); + this.$element + .addClass( 'mw-widget-mediaResultWidget-error' ) + .removeClass( 've-ui-texture-pending' ); + }; + + /** + * Resize the thumbnail and wrapper according to row height and bounding boxes, if given. + * + * @param {Object} originalDimensions Original image dimensions with width and height values + * @param {Object} [boundingBox] Specific bounding box, if supplied + */ + mw.widgets.MediaResultWidget.prototype.calculateSizing = function ( originalDimensions, boundingBox ) { + var wrapperPadding, + imageDimensions = {}; + + boundingBox = boundingBox || {}; + + if ( this.isAudio ) { + // HACK: We are getting the wrong information from the + // API about audio files. Set their thumbnail to square 120px + imageDimensions = { + width: 120, + height: 120 + }; + } else { + // Get the image within the bounding box + imageDimensions = this.constructor.static.resizeToBoundingBox( + // Image original dimensions + { + width: originalDimensions.width || originalDimensions.thumbwidth, + height: originalDimensions.height || originalDimensions.thumbwidth + }, + // Bounding box + { + width: boundingBox.width || this.getImageMaxWidth(), + height: boundingBox.height || this.getRowHeight() + } + ); + } + this.imageDimensions = imageDimensions; + // Set the thumbnail size + this.$thumb.css( this.imageDimensions ); + + // Set the box size + wrapperPadding = this.calculateWrapperPadding( this.imageDimensions ); + this.$element.css( wrapperPadding ); + }; + + /** + * Replace the empty .src attribute of the image with the + * actual src. + */ + mw.widgets.MediaResultWidget.prototype.lazyLoad = function () { + if ( !this.hasSrc() ) { + this.src = this.thumbUrl; + this.$thumb.attr( 'src', this.thumbUrl ); + } + }; + + /** + * Retrieve the store dimensions object + * + * @return {Object} Thumb dimensions + */ + mw.widgets.MediaResultWidget.prototype.getDimensions = function () { + return this.dimensions; + }; + + /** + * Resize thumbnail and element according to the resize factor + * + * @param {number} resizeFactor The resizing factor for the image + */ + mw.widgets.MediaResultWidget.prototype.resizeThumb = function ( resizeFactor ) { + var boundingBox, + imageOriginalWidth = this.imageDimensions.width, + wrapperWidth = this.$element.width(); + // Set the new row height + this.setRowHeight( Math.ceil( this.getRowHeight() * resizeFactor ) ); + + boundingBox = { + width: Math.ceil( this.imageDimensions.width * resizeFactor ), + height: this.getRowHeight() + }; + + this.calculateSizing( this.data, boundingBox ); + + // We need to adjust the wrapper this time to fit the "perfect" + // dimensions, regardless of how small the image is + if ( imageOriginalWidth < wrapperWidth ) { + boundingBox.width = wrapperWidth * resizeFactor; + } + this.$element.css( this.calculateWrapperPadding( boundingBox ) ); + }; + + /** + * Adjust the wrapper padding for small images + * + * @param {Object} thumbDimensions Thumbnail dimensions + * @return {Object} Css styling for the wrapper + */ + mw.widgets.MediaResultWidget.prototype.calculateWrapperPadding = function ( thumbDimensions ) { + var css = { + height: this.rowHeight, + width: thumbDimensions.width, + lineHeight: this.getRowHeight() + 'px' + }; + + // Check if the image is too thin so we can make a bit of space around it + if ( thumbDimensions.width < this.minWidth ) { + css.width = this.minWidth; + } + + return css; + }; + + /** + * Set the row height for all size calculations + * + * @return {number} rowHeight Row height + */ + mw.widgets.MediaResultWidget.prototype.getRowHeight = function () { + return this.rowHeight; + }; + + /** + * Set the row height for all size calculations + * + * @param {number} rowHeight Row height + */ + mw.widgets.MediaResultWidget.prototype.setRowHeight = function ( rowHeight ) { + this.rowHeight = rowHeight; + }; + + mw.widgets.MediaResultWidget.prototype.setImageMaxWidth = function ( width ) { + this.maxWidth = width; + }; + mw.widgets.MediaResultWidget.prototype.getImageMaxWidth = function () { + return this.maxWidth; + }; + + /** + * Set the row this result is in. + * + * @param {number} row Row number + */ + mw.widgets.MediaResultWidget.prototype.setRow = function ( row ) { + this.row = row; + }; + + /** + * Get the row this result is in. + * + * @return {number} row Row number + */ + mw.widgets.MediaResultWidget.prototype.getRow = function () { + return this.row; + }; + + /** + * Check if the image has a src attribute already + * + * @return {boolean} Thumbnail has its source attribute set + */ + mw.widgets.MediaResultWidget.prototype.hasSrc = function () { + return !!this.src; + }; +}( jQuery, mediaWiki ) ); diff --git a/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaSearchProvider.js b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaSearchProvider.js new file mode 100644 index 0000000000..a46d911004 --- /dev/null +++ b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaSearchProvider.js @@ -0,0 +1,69 @@ +/*! + * MediaWiki Widgets - MediaSearchProvider class. + * + * @copyright 2011-2016 VisualEditor Team and others; see AUTHORS.txt + * @license The MIT License (MIT); see LICENSE.txt + */ +( function ( $, mw ) { + + /** + * MediaWiki media search provider. + * + * @class + * @extends mw.widgets.MediaResourceProvider + * + * @constructor + * @param {string} apiurl The API url + * @param {Object} [config] Configuration options + */ + mw.widgets.MediaSearchProvider = function MwWidgetsMediaSearchProvider( apiurl, config ) { + config = config || {}; + + config.staticParams = $.extend( { + generator: 'search', + gsrnamespace: mw.config.get( 'wgNamespaceIds' ).file + }, config.staticParams ); + + // Parent constructor + mw.widgets.MediaSearchProvider.super.call( this, apiurl, config ); + }; + + /* Inheritance */ + OO.inheritClass( mw.widgets.MediaSearchProvider, mw.widgets.MediaResourceProvider ); + + /* Methods */ + + /** + * @inheritdoc + */ + mw.widgets.MediaSearchProvider.prototype.getContinueData = function ( howMany ) { + return { + gsroffset: this.getOffset(), + gsrlimit: howMany || this.getDefaultFetchLimit() + }; + }; + + /** + * @inheritdoc + */ + mw.widgets.MediaSearchProvider.prototype.setContinue = function ( continueData ) { + // Update the offset for next time + this.setOffset( continueData.gsroffset ); + }; + + /** + * @inheritdoc + */ + mw.widgets.MediaSearchProvider.prototype.sort = function ( results ) { + return results.sort( function ( a, b ) { + return a.index - b.index; + } ); + }; + + /** + * @inheritdoc + */ + mw.widgets.MediaSearchProvider.prototype.isValid = function () { + return this.getUserParams().gsrsearch && mw.widgets.MediaSearchProvider.super.prototype.isValid.call( this ); + }; +}( jQuery, mediaWiki ) ); diff --git a/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaSearchQueue.js b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaSearchQueue.js new file mode 100644 index 0000000000..7ee98bb66d --- /dev/null +++ b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaSearchQueue.js @@ -0,0 +1,82 @@ +/*! + * MediaWiki Widgets - MediaSearchQueue class. + * + * @copyright 2011-2016 VisualEditor Team and others; see AUTHORS.txt + * @license The MIT License (MIT); see LICENSE.txt + */ +( function ( $, mw ) { + + /** + * MediaWiki media resource queue. + * + * @class + * @extends mw.widgets.MediaResourceQueue + * + * @constructor + * @param {Object} [config] Configuration options + * @cfg {number} maxHeight The maximum height of the media, used in the + * search call to the API. + */ + mw.widgets.MediaSearchQueue = function MwWidgetsMediaSearchQueue( config ) { + config = config || {}; + + // Parent constructor + mw.widgets.MediaSearchQueue.super.call( this, config ); + + this.searchQuery = ''; + }; + + /* Inheritance */ + OO.inheritClass( mw.widgets.MediaSearchQueue, mw.widgets.MediaResourceQueue ); + + /** + * Override parent method to set up the providers according to + * the file repos + * + * @return {jQuery.Promise} Promise that resolves when the resources are set up + */ + mw.widgets.MediaSearchQueue.prototype.setup = function () { + var i, len, + queue = this; + + return this.getFileRepos().then( function ( sources ) { + if ( queue.providers.length === 0 ) { + // Set up the providers + for ( i = 0, len = sources.length; i < len; i++ ) { + queue.providers.push( new mw.widgets.MediaSearchProvider( + sources[ i ].apiurl, + { + name: sources[ i ].name, + local: sources[ i ].local, + scriptDirUrl: sources[ i ].scriptDirUrl, + userParams: { + gsrsearch: queue.getSearchQuery() + }, + staticParams: { + iiurlheight: queue.getMaxHeight() + } + } ) + ); + } + } + } ); + }; + + /** + * Set the search query + * + * @param {string} searchQuery API search query + */ + mw.widgets.MediaSearchQueue.prototype.setSearchQuery = function ( searchQuery ) { + this.setParams( { gsrsearch: searchQuery } ); + }; + + /** + * Get the search query + * + * @return {string} API search query + */ + mw.widgets.MediaSearchQueue.prototype.getSearchQuery = function () { + return this.getParams().gsrsearch; + }; +}( jQuery, mediaWiki ) ); diff --git a/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaSearchWidget.css b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaSearchWidget.css new file mode 100644 index 0000000000..3d28ef8ff8 --- /dev/null +++ b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaSearchWidget.css @@ -0,0 +1,10 @@ +/*! + * MediaWiki Widgets - MediaSearchWidget styles. + * + * @copyright 2011-2016 VisualEditor Team and others; see AUTHORS.txt + * @license The MIT License (MIT); see LICENSE.txt + */ + +.mw-widget-mediaSearchWidget .oo-ui-searchWidget-query .oo-ui-inputWidget { + max-width: none; +} diff --git a/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaSearchWidget.js b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaSearchWidget.js new file mode 100644 index 0000000000..c6938e874e --- /dev/null +++ b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaSearchWidget.js @@ -0,0 +1,462 @@ +/*! + * MediaWiki Widgets - MediaSearchWidget class. + * + * @copyright 2011-2016 VisualEditor Team and others; see AUTHORS.txt + * @license The MIT License (MIT); see LICENSE.txt + */ +( function ( $, mw ) { + + /** + * Creates an mw.widgets.MediaSearchWidget object. + * + * @class + * @extends OO.ui.SearchWidget + * + * @constructor + * @param {Object} [config] Configuration options + * @param {number} [size] Vertical size of thumbnails + */ + mw.widgets.MediaSearchWidget = function MwWidgetsMediaSearchWidget( config ) { + // Configuration initialization + config = $.extend( { + placeholder: mw.msg( 'mw-widgets-mediasearch-input-placeholder' ) + }, config ); + + // Parent constructor + mw.widgets.MediaSearchWidget.super.call( this, config ); + + // Properties + this.providers = {}; + this.lastQueryValue = ''; + this.searchQueue = new mw.widgets.MediaSearchQueue( { + limit: this.constructor.static.limit, + threshold: this.constructor.static.threshold + } ); + + this.queryTimeout = null; + this.itemCache = {}; + this.promises = []; + this.lang = config.lang || 'en'; + this.$panels = config.$panels; + + this.externalLinkUrlProtocolsRegExp = new RegExp( + '^(' + mw.config.get( 'wgUrlProtocols' ) + ')', + 'i' + ); + + // Masonry fit properties + this.rows = []; + this.rowHeight = config.rowHeight || 200; + this.layoutQueue = []; + this.numItems = 0; + this.currentItemCache = []; + + this.resultsSize = {}; + + this.selected = null; + + this.noItemsMessage = new OO.ui.LabelWidget( { + label: mw.msg( 'mw-widgets-mediasearch-noresults' ), + classes: [ 'mw-widget-mediaSearchWidget-noresults' ] + } ); + this.noItemsMessage.toggle( false ); + + // Events + this.$results.on( 'scroll', this.onResultsScroll.bind( this ) ); + this.$query.append( this.noItemsMessage.$element ); + this.results.connect( this, { + add: 'onResultsAdd', + remove: 'onResultsRemove' + } ); + + this.resizeHandler = OO.ui.debounce( this.afterResultsResize.bind( this ), 500 ); + + // Initialization + this.$element.addClass( 'mw-widget-mediaSearchWidget' ); + }; + + /* Inheritance */ + + OO.inheritClass( mw.widgets.MediaSearchWidget, OO.ui.SearchWidget ); + + /* Static properties */ + + mw.widgets.MediaSearchWidget.static.limit = 10; + + mw.widgets.MediaSearchWidget.static.threshold = 5; + + /* Methods */ + + /** + * Respond to window resize and check if the result display should + * be updated. + */ + mw.widgets.MediaSearchWidget.prototype.afterResultsResize = function () { + var items = this.currentItemCache; + + if ( + items.length > 0 && + ( + this.resultsSize.width !== this.$results.width() || + this.resultsSize.height !== this.$results.height() + ) + ) { + this.resetRows(); + this.itemCache = {}; + this.processQueueResults( items ); + if ( this.results.getItems().length > 0 ) { + this.lazyLoadResults(); + } + + // Cache the size + this.resultsSize = { + width: this.$results.width(), + height: this.$results.height() + }; + } + }; + + /** + * Teardown the widget; disconnect the window resize event. + */ + mw.widgets.MediaSearchWidget.prototype.teardown = function () { + $( window ).off( 'resize', this.resizeHandler ); + }; + + /** + * Setup the widget; activate the resize event. + */ + mw.widgets.MediaSearchWidget.prototype.setup = function () { + $( window ).on( 'resize', this.resizeHandler ); + }; + + /** + * Query all sources for media. + * + * @method + */ + mw.widgets.MediaSearchWidget.prototype.queryMediaQueue = function () { + var search = this, + value = this.getQueryValue(); + + if ( value === '' ) { + return; + } + + this.query.pushPending(); + search.noItemsMessage.toggle( false ); + + this.searchQueue.setSearchQuery( value ); + this.searchQueue.get( this.constructor.static.limit ) + .then( function ( items ) { + if ( items.length > 0 ) { + search.processQueueResults( items ); + search.currentItemCache = search.currentItemCache.concat( items ); + } + + search.query.popPending(); + search.noItemsMessage.toggle( search.results.getItems().length === 0 ); + if ( search.results.getItems().length > 0 ) { + search.lazyLoadResults(); + } + + } ); + }; + + /** + * Process the media queue giving more items + * + * @method + * @param {Object[]} items Given items by the media queue + */ + mw.widgets.MediaSearchWidget.prototype.processQueueResults = function ( items ) { + var i, len, title, + resultWidgets = [], + inputSearchQuery = this.getQueryValue(), + queueSearchQuery = this.searchQueue.getSearchQuery(); + + if ( inputSearchQuery === '' || queueSearchQuery !== inputSearchQuery ) { + return; + } + + for ( i = 0, len = items.length; i < len; i++ ) { + title = new mw.Title( items[ i ].title ).getMainText(); + // Do not insert duplicates + if ( !Object.prototype.hasOwnProperty.call( this.itemCache, title ) ) { + this.itemCache[ title ] = true; + resultWidgets.push( + new mw.widgets.MediaResultWidget( { + data: items[ i ], + rowHeight: this.rowHeight, + maxWidth: this.results.$element.width() / 3, + minWidth: 30, + rowWidth: this.results.$element.width() + } ) + ); + } + } + this.results.addItems( resultWidgets ); + + }; + + /** + * Get the sanitized query value from the input + * + * @return {string} Query value + */ + mw.widgets.MediaSearchWidget.prototype.getQueryValue = function () { + var queryValue = this.query.getValue().trim(); + + if ( queryValue.match( this.externalLinkUrlProtocolsRegExp ) ) { + queryValue = queryValue.match( /.+\/([^\/]+)/ )[ 1 ]; + } + return queryValue; + }; + + /** + * Handle search value change + * + * @param {string} value New value + */ + mw.widgets.MediaSearchWidget.prototype.onQueryChange = function () { + // Get the sanitized query value + var queryValue = this.getQueryValue(); + + if ( queryValue === this.lastQueryValue ) { + return; + } + + // Parent method + mw.widgets.MediaSearchWidget.super.prototype.onQueryChange.apply( this, arguments ); + + // Reset + this.itemCache = {}; + this.currentItemCache = []; + this.resetRows(); + + // Empty the results queue + this.layoutQueue = []; + + // Change resource queue query + this.searchQueue.setSearchQuery( queryValue ); + this.lastQueryValue = queryValue; + + // Queue + clearTimeout( this.queryTimeout ); + this.queryTimeout = setTimeout( this.queryMediaQueue.bind( this ), 350 ); + }; + + /** + * Handle results scroll events. + * + * @param {jQuery.Event} e Scroll event + */ + mw.widgets.MediaSearchWidget.prototype.onResultsScroll = function () { + var position = this.$results.scrollTop() + this.$results.outerHeight(), + threshold = this.results.$element.outerHeight() - this.rowHeight * 3; + + // Check if we need to ask for more results + if ( !this.query.isPending() && position > threshold ) { + this.queryMediaQueue(); + } + + this.lazyLoadResults(); + }; + + /** + * Lazy-load the images that are visible. + */ + mw.widgets.MediaSearchWidget.prototype.lazyLoadResults = function () { + var i, elementTop, + items = this.results.getItems(), + resultsScrollTop = this.$results.scrollTop(), + position = resultsScrollTop + this.$results.outerHeight(); + + // Lazy-load results + for ( i = 0; i < items.length; i++ ) { + elementTop = items[ i ].$element.position().top; + if ( elementTop <= position && !items[ i ].hasSrc() ) { + // Load the image + items[ i ].lazyLoad(); + } + } + }; + + /** + * Reset all the rows; destroy the jQuery elements and reset + * the rows array. + */ + mw.widgets.MediaSearchWidget.prototype.resetRows = function () { + var i, len; + + for ( i = 0, len = this.rows.length; i < len; i++ ) { + this.rows[ i ].$element.remove(); + } + + this.rows = []; + this.itemCache = {}; + }; + + /** + * Find an available row at the end. Either we will need to create a new + * row or use the last available row if it isn't full. + * + * @return {number} Row index + */ + mw.widgets.MediaSearchWidget.prototype.getAvailableRow = function () { + var row; + + if ( this.rows.length === 0 ) { + row = 0; + } else { + row = this.rows.length - 1; + } + + if ( !this.rows[ row ] ) { + // Create new row + this.rows[ row ] = { + isFull: false, + width: 0, + items: [], + $element: $( '

' ) + .addClass( 'mw-widget-mediaResultWidget-row' ) + .css( { + overflow: 'hidden' + } ) + .data( 'row', row ) + .attr( 'data-full', false ) + }; + // Append to results + this.results.$element.append( this.rows[ row ].$element ); + } else if ( this.rows[ row ].isFull ) { + row++; + // Create new row + this.rows[ row ] = { + isFull: false, + width: 0, + items: [], + $element: $( '

' ) + .addClass( 'mw-widget-mediaResultWidget-row' ) + .css( { + overflow: 'hidden' + } ) + .data( 'row', row ) + .attr( 'data-full', false ) + }; + // Append to results + this.results.$element.append( this.rows[ row ].$element ); + } + + return row; + }; + + /** + * Respond to add results event in the results widget. + * Override the way SelectWidget and GroupElement append the items + * into the group so we can append them in groups of rows. + * + * @param {mw.widgets.MediaResultWidget[]} items An array of item elements + */ + mw.widgets.MediaSearchWidget.prototype.onResultsAdd = function ( items ) { + var search = this; + + // Add method to a queue; this queue will only run when the widget + // is visible + this.layoutQueue.push( function () { + var i, j, ilen, jlen, itemWidth, row, effectiveWidth, + resizeFactor, + maxRowWidth = search.results.$element.width() - 15; + + // Go over the added items + row = search.getAvailableRow(); + for ( i = 0, ilen = items.length; i < ilen; i++ ) { + itemWidth = items[ i ].$element.outerWidth( true ); + + // Add items to row until it is full + if ( search.rows[ row ].width + itemWidth >= maxRowWidth ) { + // Mark this row as full + search.rows[ row ].isFull = true; + search.rows[ row ].$element.attr( 'data-full', true ); + + // Find the resize factor + effectiveWidth = search.rows[ row ].width; + resizeFactor = maxRowWidth / effectiveWidth; + + search.rows[ row ].$element.attr( 'data-effectiveWidth', effectiveWidth ); + search.rows[ row ].$element.attr( 'data-resizeFactor', resizeFactor ); + search.rows[ row ].$element.attr( 'data-row', row ); + + // Resize all images in the row to fit the width + for ( j = 0, jlen = search.rows[ row ].items.length; j < jlen; j++ ) { + search.rows[ row ].items[ j ].resizeThumb( resizeFactor ); + } + + // find another row + row = search.getAvailableRow(); + } + + // Add the cumulative + search.rows[ row ].width += itemWidth; + + // Store reference to the item and to the row + search.rows[ row ].items.push( items[ i ] ); + items[ i ].setRow( row ); + + // Append the item + search.rows[ row ].$element.append( items[ i ].$element ); + } + + // If we have less than 4 rows, call for more images + if ( search.rows.length < 4 ) { + search.queryMediaQueue(); + } + } ); + this.runLayoutQueue(); + }; + + /** + * Run layout methods from the queue only if the element is visible. + */ + mw.widgets.MediaSearchWidget.prototype.runLayoutQueue = function () { + var i, len; + + if ( this.$element.is( ':visible' ) ) { + for ( i = 0, len = this.layoutQueue.length; i < len; i++ ) { + this.layoutQueue.pop()(); + } + } + }; + + /** + * Respond to removing results event in the results widget. + * Clear the relevant rows. + * + * @param {OO.ui.OptionWidget[]} items Removed items + */ + mw.widgets.MediaSearchWidget.prototype.onResultsRemove = function ( items ) { + if ( items.length > 0 ) { + // In the case of the media search widget, if any items are removed + // all are removed (new search) + this.resetRows(); + this.currentItemCache = []; + } + }; + + /** + * Set language for the search results. + * + * @param {string} lang Language + */ + mw.widgets.MediaSearchWidget.prototype.setLang = function ( lang ) { + this.lang = lang; + }; + + /** + * Get language for the search results. + * + * @return {string} lang Language + */ + mw.widgets.MediaSearchWidget.prototype.getLang = function () { + return this.lang; + }; +}( jQuery, mediaWiki ) ); diff --git a/resources/src/mediawiki.widgets/mw.widgets.CalendarWidget.js b/resources/src/mediawiki.widgets/mw.widgets.CalendarWidget.js index 3daa70ace0..57a3d9c0bc 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.CalendarWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.CalendarWidget.js @@ -4,7 +4,7 @@ * @copyright 2011-2015 MediaWiki Widgets Team and others; see AUTHORS.txt * @license The MIT License (MIT); see LICENSE.txt */ -/*global moment */ +/* global moment */ ( function ( $, mw ) { /** @@ -175,87 +175,87 @@ selected = moment( this.getDate(), this.getDateFormat() ); switch ( this.displayLayer ) { - case 'month': - this.labelButton.setLabel( this.moment.format( 'MMMM YYYY' ) ); - this.upButton.toggle( true ); - - // First week displayed is the first week spanned by the month, unless it begins on Monday, in - // which case first week displayed is the previous week. This makes the calendar "balanced" - // and also neatly handles 28-day February sometimes spanning only 4 weeks. - currentDay = moment( this.moment ).startOf( 'month' ).subtract( 1, 'day' ).startOf( 'week' ); - - // Day-of-week labels. Localisation-independent: works with weeks starting on Saturday, Sunday - // or Monday. - for ( i = 0; i < 7; i++ ) { - items.push( - $( '

' ) - .addClass( 'mw-widget-calendarWidget-day-heading' ) - .text( currentDay.format( 'dd' ) ) - ); - currentDay.add( 1, 'day' ); - } - currentDay.subtract( 7, 'days' ); - - // Actual calendar month. Always displays 6 weeks, for consistency (months can span 4 to 6 - // weeks). - for ( i = 0; i < 42; i++ ) { - items.push( - $( '

' ) - .addClass( 'mw-widget-calendarWidget-item mw-widget-calendarWidget-day' ) - .toggleClass( 'mw-widget-calendarWidget-day-additional', !currentDay.isSame( this.moment, 'month' ) ) - .toggleClass( 'mw-widget-calendarWidget-day-today', currentDay.isSame( today, 'day' ) ) - .toggleClass( 'mw-widget-calendarWidget-item-selected', currentDay.isSame( selected, 'day' ) ) - .text( currentDay.format( 'D' ) ) - .data( 'date', currentDay.date() ) - .data( 'month', currentDay.month() ) - .data( 'year', currentDay.year() ) - ); - currentDay.add( 1, 'day' ); - } - break; - - case 'year': - this.labelButton.setLabel( this.moment.format( 'YYYY' ) ); - this.upButton.toggle( true ); - - currentMonth = moment( this.moment ).startOf( 'year' ); - for ( i = 0; i < 12; i++ ) { - items.push( - $( '

' ) - .addClass( 'mw-widget-calendarWidget-item mw-widget-calendarWidget-month' ) - .toggleClass( 'mw-widget-calendarWidget-item-selected', currentMonth.isSame( selected, 'month' ) ) - .text( currentMonth.format( 'MMMM' ) ) - .data( 'month', currentMonth.month() ) - ); - currentMonth.add( 1, 'month' ); - } - // Shuffle the array to display months in columns rather than rows. - items = [ - items[ 0 ], items[ 6 ], // | January | July | - items[ 1 ], items[ 7 ], // | February | August | - items[ 2 ], items[ 8 ], // | March | September | - items[ 3 ], items[ 9 ], // | April | October | - items[ 4 ], items[ 10 ], // | May | November | - items[ 5 ], items[ 11 ] // | June | December | - ]; - break; - - case 'duodecade': - this.labelButton.setLabel( null ); - this.upButton.toggle( false ); - - currentYear = moment( { year: Math.floor( this.moment.year() / 20 ) * 20 } ); - for ( i = 0; i < 20; i++ ) { - items.push( - $( '

' ) - .addClass( 'mw-widget-calendarWidget-item mw-widget-calendarWidget-year' ) - .toggleClass( 'mw-widget-calendarWidget-item-selected', currentYear.isSame( selected, 'year' ) ) - .text( currentYear.format( 'YYYY' ) ) - .data( 'year', currentYear.year() ) - ); - currentYear.add( 1, 'year' ); - } - break; + case 'month': + this.labelButton.setLabel( this.moment.format( 'MMMM YYYY' ) ); + this.upButton.toggle( true ); + + // First week displayed is the first week spanned by the month, unless it begins on Monday, in + // which case first week displayed is the previous week. This makes the calendar "balanced" + // and also neatly handles 28-day February sometimes spanning only 4 weeks. + currentDay = moment( this.moment ).startOf( 'month' ).subtract( 1, 'day' ).startOf( 'week' ); + + // Day-of-week labels. Localisation-independent: works with weeks starting on Saturday, Sunday + // or Monday. + for ( i = 0; i < 7; i++ ) { + items.push( + $( '

' ) + .addClass( 'mw-widget-calendarWidget-day-heading' ) + .text( currentDay.format( 'dd' ) ) + ); + currentDay.add( 1, 'day' ); + } + currentDay.subtract( 7, 'days' ); + + // Actual calendar month. Always displays 6 weeks, for consistency (months can span 4 to 6 + // weeks). + for ( i = 0; i < 42; i++ ) { + items.push( + $( '

' ) + .addClass( 'mw-widget-calendarWidget-item mw-widget-calendarWidget-day' ) + .toggleClass( 'mw-widget-calendarWidget-day-additional', !currentDay.isSame( this.moment, 'month' ) ) + .toggleClass( 'mw-widget-calendarWidget-day-today', currentDay.isSame( today, 'day' ) ) + .toggleClass( 'mw-widget-calendarWidget-item-selected', currentDay.isSame( selected, 'day' ) ) + .text( currentDay.format( 'D' ) ) + .data( 'date', currentDay.date() ) + .data( 'month', currentDay.month() ) + .data( 'year', currentDay.year() ) + ); + currentDay.add( 1, 'day' ); + } + break; + + case 'year': + this.labelButton.setLabel( this.moment.format( 'YYYY' ) ); + this.upButton.toggle( true ); + + currentMonth = moment( this.moment ).startOf( 'year' ); + for ( i = 0; i < 12; i++ ) { + items.push( + $( '

' ) + .addClass( 'mw-widget-calendarWidget-item mw-widget-calendarWidget-month' ) + .toggleClass( 'mw-widget-calendarWidget-item-selected', currentMonth.isSame( selected, 'month' ) ) + .text( currentMonth.format( 'MMMM' ) ) + .data( 'month', currentMonth.month() ) + ); + currentMonth.add( 1, 'month' ); + } + // Shuffle the array to display months in columns rather than rows. + items = [ + items[ 0 ], items[ 6 ], // | January | July | + items[ 1 ], items[ 7 ], // | February | August | + items[ 2 ], items[ 8 ], // | March | September | + items[ 3 ], items[ 9 ], // | April | October | + items[ 4 ], items[ 10 ], // | May | November | + items[ 5 ], items[ 11 ] // | June | December | + ]; + break; + + case 'duodecade': + this.labelButton.setLabel( null ); + this.upButton.toggle( false ); + + currentYear = moment( { year: Math.floor( this.moment.year() / 20 ) * 20 } ); + for ( i = 0; i < 20; i++ ) { + items.push( + $( '

' ) + .addClass( 'mw-widget-calendarWidget-item mw-widget-calendarWidget-year' ) + .toggleClass( 'mw-widget-calendarWidget-item-selected', currentYear.isSame( selected, 'year' ) ) + .text( currentYear.format( 'YYYY' ) ) + .data( 'year', currentYear.year() ) + ); + currentYear.add( 1, 'year' ); + } + break; } this.$body.append.apply( this.$body, items ); @@ -369,15 +369,15 @@ */ mw.widgets.CalendarWidget.prototype.onPrevButtonClick = function () { switch ( this.displayLayer ) { - case 'month': - this.moment.subtract( 1, 'month' ); - break; - case 'year': - this.moment.subtract( 1, 'year' ); - break; - case 'duodecade': - this.moment.subtract( 20, 'years' ); - break; + case 'month': + this.moment.subtract( 1, 'month' ); + break; + case 'year': + this.moment.subtract( 1, 'year' ); + break; + case 'duodecade': + this.moment.subtract( 20, 'years' ); + break; } this.updateUI( 'previous' ); }; @@ -389,15 +389,15 @@ */ mw.widgets.CalendarWidget.prototype.onNextButtonClick = function () { switch ( this.displayLayer ) { - case 'month': - this.moment.add( 1, 'month' ); - break; - case 'year': - this.moment.add( 1, 'year' ); - break; - case 'duodecade': - this.moment.add( 20, 'years' ); - break; + case 'month': + this.moment.add( 1, 'month' ); + break; + case 'year': + this.moment.add( 1, 'year' ); + break; + case 'duodecade': + this.moment.add( 20, 'years' ); + break; } this.updateUI( 'next' ); }; @@ -408,6 +408,7 @@ * what gets clicked. * * @private + * @param {jQuery.Event} e Click event */ mw.widgets.CalendarWidget.prototype.onBodyClick = function ( e ) { var @@ -504,6 +505,7 @@ * * @private * @param {jQuery.Event} e Mouse click event + * @return {boolean} False to cancel the default event */ mw.widgets.CalendarWidget.prototype.onClick = function ( e ) { if ( !this.isDisabled() && e.which === 1 ) { @@ -517,39 +519,38 @@ * * @private * @param {jQuery.Event} e Key down event + * @return {boolean} False to cancel the default event */ mw.widgets.CalendarWidget.prototype.onKeyDown = function ( e ) { var - /*jshint -W024*/ dir = OO.ui.Element.static.getDir( this.$element ), - /*jshint +W024*/ nextDirectionKey = dir === 'ltr' ? OO.ui.Keys.RIGHT : OO.ui.Keys.LEFT, prevDirectionKey = dir === 'ltr' ? OO.ui.Keys.LEFT : OO.ui.Keys.RIGHT, changed = true; if ( !this.isDisabled() ) { switch ( e.which ) { - case prevDirectionKey: - this.moment.subtract( 1, this.precision === 'month' ? 'month' : 'day' ); - break; - case nextDirectionKey: - this.moment.add( 1, this.precision === 'month' ? 'month' : 'day' ); - break; - case OO.ui.Keys.UP: - this.moment.subtract( 1, this.precision === 'month' ? 'month' : 'week' ); - break; - case OO.ui.Keys.DOWN: - this.moment.add( 1, this.precision === 'month' ? 'month' : 'week' ); - break; - case OO.ui.Keys.PAGEUP: - this.moment.subtract( 1, this.precision === 'month' ? 'year' : 'month' ); - break; - case OO.ui.Keys.PAGEDOWN: - this.moment.add( 1, this.precision === 'month' ? 'year' : 'month' ); - break; - default: - changed = false; - break; + case prevDirectionKey: + this.moment.subtract( 1, this.precision === 'month' ? 'month' : 'day' ); + break; + case nextDirectionKey: + this.moment.add( 1, this.precision === 'month' ? 'month' : 'day' ); + break; + case OO.ui.Keys.UP: + this.moment.subtract( 1, this.precision === 'month' ? 'month' : 'week' ); + break; + case OO.ui.Keys.DOWN: + this.moment.add( 1, this.precision === 'month' ? 'month' : 'week' ); + break; + case OO.ui.Keys.PAGEUP: + this.moment.subtract( 1, this.precision === 'month' ? 'year' : 'month' ); + break; + case OO.ui.Keys.PAGEDOWN: + this.moment.add( 1, this.precision === 'month' ? 'year' : 'month' ); + break; + default: + changed = false; + break; } if ( changed ) { diff --git a/resources/src/mediawiki.widgets/mw.widgets.CategoryCapsuleItemWidget.js b/resources/src/mediawiki.widgets/mw.widgets.CategoryCapsuleItemWidget.js index 4d86cfd596..488d9e099f 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.CategoryCapsuleItemWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.CategoryCapsuleItemWidget.js @@ -94,7 +94,8 @@ * @extends mw.Title * * @constructor - * @inheritdoc + * @param {string} title + * @param {number} [namespace] */ function ForeignTitle( title, namespace ) { // We only need to handle categories here... but we don't know the target language. @@ -109,11 +110,10 @@ }; /** - * @class mw.widgets.CategoryCapsuleItemWidget - * * Category selector capsule item widget. Extends OO.ui.CapsuleItemWidget with the ability to link * to the given page, and to show its existence status (i.e., whether it is a redlink). * + * @class mw.widgets.CategoryCapsuleItemWidget * @uses mw.Api * @extends OO.ui.CapsuleItemWidget * @@ -146,7 +146,6 @@ this.$label.replaceWith( this.$link ); this.setLabelElement( this.$link ); - /*jshint -W024*/ if ( !this.constructor.static.pageExistenceCaches[ this.apiUrl ] ) { this.constructor.static.pageExistenceCaches[ this.apiUrl ] = new PageExistenceCache( new mw.ForeignApi( this.apiUrl ) ); @@ -156,7 +155,6 @@ .done( function ( exists ) { widget.setMissing( !exists ); } ); - /*jshint +W024*/ }; /* Setup */ @@ -165,7 +163,6 @@ /* Static Properties */ - /*jshint -W024*/ /** * Map of API URLs to PageExistenceCache objects. * @@ -176,7 +173,6 @@ mw.widgets.CategoryCapsuleItemWidget.static.pageExistenceCaches = { '': new PageExistenceCache() }; - /*jshint +W024*/ /* Methods */ diff --git a/resources/src/mediawiki.widgets/mw.widgets.CategorySelector.js b/resources/src/mediawiki.widgets/mw.widgets.CategorySelector.js index 267eebbfc3..422c048e76 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.CategorySelector.js +++ b/resources/src/mediawiki.widgets/mw.widgets.CategorySelector.js @@ -52,6 +52,7 @@ menu: { filterFromInput: false }, + placeholder: mw.msg( 'mw-widgets-categoryselector-add-category-placeholder' ), // This allows the user to both select non-existent categories, and prevents the selector from // being wiped from #onMenuItemsChange when we change the available options in the dropdown allowArbitrary: true @@ -366,7 +367,7 @@ prop: 'categories', cllimit: this.limit, titles: 'Category:' + input - } ).done( function ( res ) { + } ).done( function ( res ) { var categories = []; $.each( res.query.pages, function ( index, page ) { diff --git a/resources/src/mediawiki.widgets/mw.widgets.ComplexTitleInputWidget.js b/resources/src/mediawiki.widgets/mw.widgets.ComplexTitleInputWidget.js index ddae9b1f7f..8f48ec3d50 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.ComplexTitleInputWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.ComplexTitleInputWidget.js @@ -51,7 +51,6 @@ OO.inheritClass( mw.widgets.ComplexTitleInputWidget, OO.ui.Widget ); /* Static Methods */ - /*jshint -W024*/ /** * @inheritdoc @@ -85,8 +84,6 @@ return state; }; - /*jshint +W024*/ - /* Methods */ /** diff --git a/resources/src/mediawiki.widgets/mw.widgets.DateInputWidget.js b/resources/src/mediawiki.widgets/mw.widgets.DateInputWidget.js index ed251f24ee..7f5e608f91 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.DateInputWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.DateInputWidget.js @@ -4,7 +4,7 @@ * @copyright 2011-2015 MediaWiki Widgets Team and others; see AUTHORS.txt * @license The MIT License (MIT); see LICENSE.txt */ -/*global moment */ +/* global moment */ ( function ( $, mw ) { /** @@ -87,6 +87,8 @@ * calendar uses relative positioning. */ mw.widgets.DateInputWidget = function MWWDateInputWidget( config ) { + var placeholderDateFormat, mustBeAfter, mustBeBefore; + // Config initialization config = $.extend( { precision: 'day', @@ -99,7 +101,6 @@ } } - var placeholderDateFormat, mustBeAfter, mustBeBefore; if ( config.placeholderDateFormat ) { placeholderDateFormat = config.placeholderDateFormat; } else if ( config.inputFormat ) { @@ -412,6 +413,8 @@ * @return {string} Format string */ mw.widgets.DateInputWidget.prototype.getDisplayFormat = function () { + var localeData, llll, lll, ll, format; + if ( this.displayFormat !== undefined ) { return this.displayFormat; } @@ -430,11 +433,11 @@ // We try to construct it as 'llll - (lll - ll)' and hope for the best. // This seems to work well for many languages (maybe even all?). - var localeData = moment.localeData( moment.locale() ), - llll = localeData.longDateFormat( 'llll' ), - lll = localeData.longDateFormat( 'lll' ), - ll = localeData.longDateFormat( 'll' ), - format = llll.replace( lll.replace( ll, '' ), '' ); + localeData = moment.localeData( moment.locale() ); + llll = localeData.longDateFormat( 'llll' ); + lll = localeData.longDateFormat( 'lll' ); + ll = localeData.longDateFormat( 'll' ); + format = llll.replace( lll.replace( ll, '' ), '' ); return format; } @@ -485,6 +488,7 @@ * * @private * @param {jQuery.Event} e Mouse click event + * @return {boolean} False to cancel the default event */ mw.widgets.DateInputWidget.prototype.onClick = function ( e ) { if ( !this.isDisabled() && e.which === 1 ) { @@ -498,6 +502,7 @@ * * @private * @param {jQuery.Event} e Key press event + * @return {boolean} False to cancel the default event */ mw.widgets.DateInputWidget.prototype.onKeyPress = function ( e ) { if ( !this.isDisabled() && @@ -513,6 +518,7 @@ * * @private * @param {jQuery.Event} e Key press event + * @return {boolean} False to cancel the default event */ mw.widgets.DateInputWidget.prototype.onCalendarKeyPress = function ( e ) { if ( !this.isDisabled() && e.which === OO.ui.Keys.ENTER ) { @@ -527,6 +533,7 @@ * * @private * @param {jQuery.Event} e Mouse click event + * @return {boolean} False to cancel the default event */ mw.widgets.DateInputWidget.prototype.onCalendarClick = function ( e ) { if ( diff --git a/resources/src/mediawiki.widgets/mw.widgets.NamespaceInputWidget.js b/resources/src/mediawiki.widgets/mw.widgets.NamespaceInputWidget.js index c88395e13f..aa0c739f5e 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.NamespaceInputWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.NamespaceInputWidget.js @@ -36,6 +36,8 @@ /** * @private + * @param {Object} [config] Configuration options + * @return {Object[]} Dropdown options */ mw.widgets.NamespaceInputWidget.prototype.getNamespaceDropdownOptions = function ( config ) { var options, diff --git a/resources/src/mediawiki.widgets/mw.widgets.SearchInputWidget.js b/resources/src/mediawiki.widgets/mw.widgets.SearchInputWidget.js index d816335e72..0a73befdf7 100755 --- a/resources/src/mediawiki.widgets/mw.widgets.SearchInputWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.SearchInputWidget.js @@ -13,6 +13,7 @@ * @extends mw.widgets.TitleInputWidget * * @constructor + * @param {Object} [config] Configuration options * @cfg {boolean} [pushPending=true] Visually mark the input field as "pending", while * requesting suggestions. * @cfg {boolean} [performSearchOnClick=true] If true, the script will start a search when- @@ -33,7 +34,8 @@ icon: 'search', maxLength: undefined, performSearchOnClick: true, - dataLocation: 'header' + dataLocation: 'header', + namespace: 0 }, config ); // Parent constructor @@ -77,12 +79,12 @@ * @inheritdoc mw.widgets.TitleWidget */ mw.widgets.SearchInputWidget.prototype.getSuggestionsPromise = function () { - var api = new mw.Api(), + var api = this.getApi(), promise, self = this; // reuse the searchSuggest function from mw.searchSuggest - promise = mw.searchSuggest.request( api, this.getQueryValue(), $.noop, this.limit ); + promise = mw.searchSuggest.request( api, this.getQueryValue(), $.noop, this.limit, this.getNamespace() ); // tracking purposes promise.done( function ( data, jqXHR ) { diff --git a/resources/src/mediawiki.widgets/mw.widgets.TitleInputWidget.js b/resources/src/mediawiki.widgets/mw.widgets.TitleInputWidget.js index 101a6060d2..a78ad82b4a 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.TitleInputWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.TitleInputWidget.js @@ -15,6 +15,7 @@ * @mixins OO.ui.mixin.LookupElement * * @constructor + * @param {Object} [config] Configuration options * @cfg {boolean} [suggestions=true] Display search suggestions * @cfg {RegExp|Function|string} [validate] Perform title validation */ diff --git a/resources/src/mediawiki.widgets/mw.widgets.TitleSearchWidget.js b/resources/src/mediawiki.widgets/mw.widgets.TitleSearchWidget.js index 96f95491eb..5ba9481a0c 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.TitleSearchWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.TitleSearchWidget.js @@ -15,6 +15,7 @@ * @mixins mw.widgets.TitleWidget * * @constructor + * @param {Object} [config] Configuration options */ mw.widgets.TitleSearchWidget = function MwWidgetsTitleSearchWidget( config ) { config = config || {}; diff --git a/resources/src/mediawiki.widgets/mw.widgets.TitleWidget.js b/resources/src/mediawiki.widgets/mw.widgets.TitleWidget.js index 222586f6e3..3a4581d5dc 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.TitleWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.TitleWidget.js @@ -6,16 +6,6 @@ */ ( function ( $, mw ) { - var interwikiPrefixesPromise = new mw.Api().get( { - action: 'query', - meta: 'siteinfo', - siprop: 'interwikimap' - } ).then( function ( data ) { - return $.map( data.query.interwikimap, function ( interwiki ) { - return interwiki.prefix; - } ); - } ); - /** * Mixin for title widgets * @@ -30,13 +20,13 @@ * @cfg {boolean} [relative=true] If a namespace is set, display titles relative to it * @cfg {boolean} [suggestions=true] Display search suggestions * @cfg {boolean} [showRedirectTargets=true] Show the targets of redirects - * @cfg {boolean} [showRedlink] Show red link to exact match if it doesn't exist * @cfg {boolean} [showImages] Show page images * @cfg {boolean} [showDescriptions] Show page descriptions * @cfg {boolean} [excludeCurrentPage] Exclude the current page from suggestions * @cfg {boolean} [validateTitle=true] Whether the input must be a valid title (if set to true, * the widget will marks itself red for invalid inputs, including an empty query). * @cfg {Object} [cache] Result cache which implements a 'set' method, taking keyed values as an argument + * @cfg {mw.Api} [api] API object to use, creates a default mw.Api instance if not specified */ mw.widgets.TitleWidget = function MwWidgetsTitleWidget( config ) { // Config initialization @@ -52,12 +42,12 @@ this.relative = config.relative !== undefined ? config.relative : true; this.suggestions = config.suggestions !== undefined ? config.suggestions : true; this.showRedirectTargets = config.showRedirectTargets !== false; - this.showRedlink = !!config.showRedlink; this.showImages = !!config.showImages; this.showDescriptions = !!config.showDescriptions; this.excludeCurrentPage = !!config.excludeCurrentPage; this.validateTitle = config.validateTitle !== undefined ? config.validateTitle : true; this.cache = config.cache; + this.api = config.api || new mw.Api(); // Initialization this.$element.addClass( 'mw-widget-titleWidget' ); @@ -67,6 +57,10 @@ OO.initClass( mw.widgets.TitleWidget ); + /* Static properties */ + + mw.widgets.TitleWidget.static.interwikiPrefixesPromiseCache = {}; + /* Methods */ /** @@ -95,6 +89,29 @@ this.namespace = namespace; }; + mw.widgets.TitleWidget.prototype.getInterwikiPrefixesPromise = function () { + var api = this.getApi(), + cache = this.constructor.static.interwikiPrefixesPromiseCache, + key = api.defaults.ajax.url; + if ( !cache.hasOwnProperty( key ) ) { + cache[ key ] = api.get( { + action: 'query', + meta: 'siteinfo', + siprop: 'interwikimap', + // Cache client-side for a day since this info is mostly static + maxage: 60 * 60 * 24, + smaxage: 60 * 60 * 24, + // Workaround T97096 by setting uselang=content + uselang: 'content' + } ).then( function ( data ) { + return $.map( data.query.interwikimap, function ( interwiki ) { + return interwiki.prefix; + } ); + } ); + } + return cache[ key ]; + }; + /** * Get a promise which resolves with an API repsonse for suggested * links for the current query. @@ -103,6 +120,7 @@ */ mw.widgets.TitleWidget.prototype.getSuggestionsPromise = function () { var req, + api = this.getApi(), query = this.getQueryValue(), widget = this, promiseAbortObject = { abort: function () { @@ -110,7 +128,7 @@ } }; if ( mw.Title.newFromText( query ) ) { - return interwikiPrefixesPromise.then( function ( interwikiPrefixes ) { + return this.getInterwikiPrefixesPromise().then( function ( interwikiPrefixes ) { var params, interwiki = query.substring( 0, query.indexOf( ':' ) ); if ( @@ -144,11 +162,11 @@ params.prop.push( 'pageterms' ); params.wbptterms = 'description'; } - req = new mw.Api().get( params ); + req = api.get( params ); promiseAbortObject.abort = req.abort.bind( req ); // TODO ew return req.then( function ( ret ) { if ( ret.query === undefined ) { - ret = new mw.Api().get( { action: 'query', titles: query } ); + ret = api.get( { action: 'query', titles: query } ); promiseAbortObject.abort = ret.abort.bind( ret ); } return ret; @@ -162,6 +180,15 @@ } }; + /** + * Get the API object for title requests + * + * @return {mw.Api} MediaWiki API + */ + mw.widgets.TitleWidget.prototype.getApi = function () { + return this.api; + }; + /** * Get option widgets from the server response * @@ -246,13 +273,6 @@ ) ); - if ( !pageExists ) { - pageData[ this.getQueryValue() ] = { - missing: true, known: false, redirect: false, disambiguation: false, - description: mw.msg( 'mw-widgets-titleinput-description-new-page' ) - }; - } - if ( this.cache ) { this.cache.set( pageData ); } @@ -261,10 +281,7 @@ if ( pageExists && !pageExistsExact ) { titles.unshift( this.getQueryValue() ); } - // Offer the exact text as a new page if the title is valid - if ( this.showRedlink && !pageExists && titleObj ) { - titles.push( this.getQueryValue() ); - } + for ( i = 0, len = titles.length; i < len; i++ ) { page = pageData[ titles[ i ] ] || {}; items.push( new mw.widgets.TitleOptionWidget( this.getOptionWidgetData( titles[ i ], page ) ) ); @@ -281,14 +298,18 @@ * @return {Object} Data for option widget */ mw.widgets.TitleWidget.prototype.getOptionWidgetData = function ( title, data ) { - var mwTitle = new mw.Title( title ); + var mwTitle = new mw.Title( title ), + description = data.description; + if ( data.missing && !description ) { + description = mw.msg( 'mw-widgets-titleinput-description-new-page' ); + } return { - data: this.namespace !== null && this.relative - ? mwTitle.getRelativeText( this.namespace ) - : title, + data: this.namespace !== null && this.relative ? + mwTitle.getRelativeText( this.namespace ) : + title, url: mwTitle.getUrl(), imageUrl: this.showImages ? data.imageUrl : null, - description: this.showDescriptions ? data.description : null, + description: this.showDescriptions ? description : null, missing: data.missing, redirect: data.redirect, disambiguation: data.disambiguation, diff --git a/resources/src/mediawiki.widgets/mw.widgets.UserInputWidget.js b/resources/src/mediawiki.widgets/mw.widgets.UserInputWidget.js index 164fd20d0a..2b3a59f5c0 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.UserInputWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.UserInputWidget.js @@ -90,6 +90,7 @@ * * @method * @param {Mixed} response Response from server + * @return {Object} */ mw.widgets.UserInputWidget.prototype.getLookupCacheDataFromResponse = function ( response ) { return response.query.allusers || {}; diff --git a/resources/src/mediawiki/ForeignApi.js b/resources/src/mediawiki/ForeignApi.js index f51403fd39..1a3cdd5a3f 100644 --- a/resources/src/mediawiki/ForeignApi.js +++ b/resources/src/mediawiki/ForeignApi.js @@ -50,12 +50,12 @@ this.apiUrl = String( url ); this.anonymous = options && options.anonymous; - options = $.extend( /*deep=*/ true, + options = $.extend( /* deep=*/ true, { ajax: { url: this.apiUrl, xhrFields: { - withCredentials: this.anonymous ? false : true + withCredentials: !this.anonymous } }, parameters: { diff --git a/resources/src/mediawiki/api.js b/resources/src/mediawiki/api.js index b7579ff182..a174f58425 100644 --- a/resources/src/mediawiki/api.js +++ b/resources/src/mediawiki/api.js @@ -253,6 +253,7 @@ } ) // AJAX success just means "200 OK" response, also check API error codes .done( function ( result, textStatus, jqXHR ) { + var code; if ( result === undefined || result === null || result === '' ) { apiDeferred.reject( 'ok-but-empty', 'OK response but empty result (check HTTP headers?)', @@ -260,7 +261,12 @@ jqXHR ); } else if ( result.error ) { - var code = result.error.code === undefined ? 'unknown' : result.error.code; + // errorformat=bc + code = result.error.code === undefined ? 'unknown' : result.error.code; + apiDeferred.reject( code, result, result, jqXHR ); + } else if ( result.errors ) { + // errorformat!=bc + code = result.errors[ 0 ].code === undefined ? 'unknown' : result.errors[ 0 ].code; apiDeferred.reject( code, result, result, jqXHR ); } else { apiDeferred.resolve( result, jqXHR ); @@ -333,8 +339,8 @@ } ); } - // Different error, pass on to let caller handle the error code - return this; + // Let caller handle the error code + return $.Deferred().rejectWith( this, arguments ); } ); } ).promise( { abort: function () { @@ -353,6 +359,7 @@ * * @since 1.22 * @param {string} type Token type + * @param {string} [assert] * @return {jQuery.Promise} Received token. */ getToken: function ( type, assert ) { @@ -361,6 +368,10 @@ promiseGroup = promises[ this.defaults.ajax.url ]; d = promiseGroup && promiseGroup[ type + 'Token' ]; + if ( !promiseGroup ) { + promiseGroup = promises[ this.defaults.ajax.url ] = {}; + } + if ( !d ) { apiPromise = this.get( { action: 'query', @@ -380,16 +391,13 @@ // Clear promise. Do not cache errors. delete promiseGroup[ type + 'Token' ]; - // Pass on to allow the caller to handle the error - return this; + // Let caller handle the error code + return $.Deferred().rejectWith( this, arguments ); } ) // Attach abort handler .promise( { abort: apiPromise.abort } ); // Store deferred now so that we can use it again even if it isn't ready yet - if ( !promiseGroup ) { - promiseGroup = promises[ this.defaults.ajax.url ] = {}; - } promiseGroup[ type + 'Token' ] = d; } diff --git a/resources/src/mediawiki/api/edit.js b/resources/src/mediawiki/api/edit.js index bb3a913f06..21fad5e573 100644 --- a/resources/src/mediawiki/api/edit.js +++ b/resources/src/mediawiki/api/edit.js @@ -121,13 +121,13 @@ var basetimestamp, curtimestamp, api = this; return api.get( { - action: 'query', - prop: 'revisions', - rvprop: [ 'content', 'timestamp' ], - titles: String( title ), - formatversion: '2', - curtimestamp: true - } ) + action: 'query', + prop: 'revisions', + rvprop: [ 'content', 'timestamp' ], + titles: String( title ), + formatversion: '2', + curtimestamp: true + } ) .then( function ( data ) { var page, revision; if ( !data.query || !data.query.pages ) { diff --git a/resources/src/mediawiki/api/parse.js b/resources/src/mediawiki/api/parse.js index 418fd2306f..f38e88b5c3 100644 --- a/resources/src/mediawiki/api/parse.js +++ b/resources/src/mediawiki/api/parse.js @@ -16,11 +16,12 @@ * @return {string} return.done.data Parsed HTML of `wikitext`. */ parse: function ( content, additionalParams ) { - var apiPromise, config = $.extend( { - formatversion: 2, - action: 'parse', - contentmodel: 'wikitext' - }, additionalParams ); + var apiPromise, + config = $.extend( { + formatversion: 2, + action: 'parse', + contentmodel: 'wikitext' + }, additionalParams ); if ( mw.Title && content instanceof mw.Title ) { // Parse existing page diff --git a/resources/src/mediawiki/api/upload.js b/resources/src/mediawiki/api/upload.js index 8169449807..351ceb2ca3 100644 --- a/resources/src/mediawiki/api/upload.js +++ b/resources/src/mediawiki/api/upload.js @@ -34,7 +34,8 @@ * @return {string} */ function getFirstKey( obj ) { - for ( var key in obj ) { + var key; + for ( key in obj ) { if ( obj.hasOwnProperty( key ) ) { return key; } @@ -45,6 +46,7 @@ * Get new iframe object for an upload. * * @private + * @param {string} id * @return {HTMLIframeElement} */ function getNewIframe( id ) { @@ -58,6 +60,8 @@ * Shortcut for getting hidden inputs * * @private + * @param {string} name + * @param {string} val * @return {jQuery} */ function getHiddenInput( name, val ) { @@ -373,6 +377,7 @@ * * @param {string} filekey * @param {Object} data + * @return {jQuery.Promise} */ uploadFromStash: function ( filekey, data ) { data.filekey = filekey; diff --git a/resources/src/mediawiki/api/watch.js b/resources/src/mediawiki/api/watch.js index 84a234f751..f68697ff8d 100644 --- a/resources/src/mediawiki/api/watch.js +++ b/resources/src/mediawiki/api/watch.js @@ -12,13 +12,13 @@ * @param {string|mw.Title|string[]|mw.Title[]} pages Full page name or instance of mw.Title, or an * array thereof. If an array is passed, the return value passed to the promise will also be an * array of appropriate objects. + * @param {Object} [addParams] * @return {jQuery.Promise} * @return {Function} return.done * @return {Object|Object[]} return.done.watch Object or list of objects (depends on the `pages` * parameter) * @return {string} return.done.watch.title Full pagename * @return {boolean} return.done.watch.watched Whether the page is now watched or unwatched - * @return {string} return.done.watch.message Parsed HTML of the confirmational interface message */ function doWatchInternal( pages, addParams ) { // XXX: Parameter addParams is undocumented because we inherit this diff --git a/resources/src/mediawiki/htmlform/hide-if.js b/resources/src/mediawiki/htmlform/hide-if.js index 0fbbcbe5d3..5f6009720a 100644 --- a/resources/src/mediawiki/htmlform/hide-if.js +++ b/resources/src/mediawiki/htmlform/hide-if.js @@ -4,8 +4,6 @@ */ ( function ( mw, $ ) { - /*jshint -W024*/ - /** * Helper function for hide-if to find the nearby form field. * @@ -204,7 +202,7 @@ mw.hook( 'htmlform.enhance' ).add( function ( $root ) { $root.find( '.mw-htmlform-hide-if' ).each( function () { - var v, i, fields, test, func, spec, self, modules, data,extraModules, + var v, i, fields, test, func, spec, self, modules, data, extraModules, $el = $( this ); modules = []; diff --git a/resources/src/mediawiki/htmlform/htmlform.Element.js b/resources/src/mediawiki/htmlform/htmlform.Element.js index 37474f6833..4f672fc786 100644 --- a/resources/src/mediawiki/htmlform/htmlform.Element.js +++ b/resources/src/mediawiki/htmlform/htmlform.Element.js @@ -10,6 +10,7 @@ * Currently only supports passing 'hide-if' data. * * @ignore + * @param {Object} [config] Configuration options */ mw.htmlform.Element = function ( config ) { // Configuration initialization diff --git a/resources/src/mediawiki/htmlform/multiselect.js b/resources/src/mediawiki/htmlform/multiselect.js index 9ab253262c..37c0554acd 100644 --- a/resources/src/mediawiki/htmlform/multiselect.js +++ b/resources/src/mediawiki/htmlform/multiselect.js @@ -18,8 +18,8 @@ } ); $oldContainer.find( 'input' ).each( function () { var $oldInput = $( this ), - checked = $oldInput.prop( 'checked' ), - $option = $( '

' ), - $row = $( '

' ), + $row = $( '

' ); $( '' ) - .append( $( '#' ).css( 'width', '4em' ) ) + .append( $( '#' ).css( 'width', '4em' ) ) .append( $( 'SQL' ) ) - .append( $( 'Time' ).css( 'width', '8em' ) ) + .append( $( 'Time' ).css( 'width', '8em' ) ) .append( $( 'Call' ).css( 'width', '18em' ) ) .appendTo( $table ); diff --git a/resources/src/mediawiki/mediawiki.errorLogger.js b/resources/src/mediawiki/mediawiki.errorLogger.js index 46b8479724..e86aff6b78 100644 --- a/resources/src/mediawiki/mediawiki.errorLogger.js +++ b/resources/src/mediawiki/mediawiki.errorLogger.js @@ -38,6 +38,12 @@ /** * Dumb window.onerror handler which forwards the errors via mw.track. * + * @param {string} errorMessage + * @param {string} url + * @param {number} lineNumber + * @param {number} [columnNumber] + * @param {Error|Mixed} [errorObject] + * @return {boolean} True to prevent the default action * @fires global_error */ window.onerror = function ( errorMessage, url, lineNumber, columnNumber, errorObject ) { diff --git a/resources/src/mediawiki/mediawiki.experiments.js b/resources/src/mediawiki/mediawiki.experiments.js index 49ff4115b5..0c9ea97c14 100644 --- a/resources/src/mediawiki/mediawiki.experiments.js +++ b/resources/src/mediawiki/mediawiki.experiments.js @@ -1,4 +1,3 @@ -/* jshint bitwise:false */ ( function ( mw, $ ) { var CONTROL_BUCKET = 'control', @@ -17,6 +16,7 @@ * @see https://jsbin.com/kejewi/4/watch?js,console */ function hashString( string ) { + /* eslint-disable no-bitwise */ var hash = 0, i = string.length; @@ -30,6 +30,7 @@ hash += ( hash << 15 ); return hash >>> 0; + /* eslint-enable no-bitwise */ } /** diff --git a/resources/src/mediawiki/mediawiki.feedback.js b/resources/src/mediawiki/mediawiki.feedback.js index 0b3ea043e8..6abdf83877 100644 --- a/resources/src/mediawiki/mediawiki.feedback.js +++ b/resources/src/mediawiki/mediawiki.feedback.js @@ -6,8 +6,6 @@ * @author Moriel Schottlender, 2015 * @since 1.19 */ -/*jshint esversion:5 */ -/*global OO*/ ( function ( mw, $ ) { /** * This is a way of getting simple feedback from users. It's useful @@ -296,7 +294,7 @@ this.feedbackSubjectInput.getValue() ); - this.actions.setAbilities( { submit: isValid } ); + this.actions.setAbilities( { submit: isValid } ); }; /** @@ -458,10 +456,10 @@ if ( secondaryCode === 'http' ) { fb.status = 'error3'; // ajax request failed - mw.log.warn( 'Feedback report failed with HTTP error: ' + details.textStatus ); + mw.log.warn( 'Feedback report failed with HTTP error: ' + details.textStatus ); } else { fb.status = 'error2'; - mw.log.warn( 'Feedback report failed with API error: ' + secondaryCode ); + mw.log.warn( 'Feedback report failed with API error: ' + secondaryCode ); } } else { fb.status = 'error1'; diff --git a/resources/src/mediawiki/mediawiki.filewarning.js b/resources/src/mediawiki/mediawiki.filewarning.js index 882affe17f..72bf3d7696 100644 --- a/resources/src/mediawiki/mediawiki.filewarning.js +++ b/resources/src/mediawiki/mediawiki.filewarning.js @@ -4,7 +4,6 @@ * @author Mark Holmquist, 2015 * @since 1.25 */ -/*global OO*/ ( function ( mw, $, oo ) { var warningConfig = mw.config.get( 'wgFileWarning' ), warningMessages = warningConfig.messages, diff --git a/resources/src/mediawiki/mediawiki.inspect.js b/resources/src/mediawiki/mediawiki.inspect.js index a74aef3b3c..fdaa989dc5 100644 --- a/resources/src/mediawiki/mediawiki.inspect.js +++ b/resources/src/mediawiki/mediawiki.inspect.js @@ -4,7 +4,9 @@ * @author Ori Livneh * @since 1.22 */ -/*jshint devel:true */ + +/* eslint-disable no-console */ + ( function ( mw, $ ) { var inspect, @@ -18,11 +20,12 @@ } function humanSize( bytes ) { - if ( !$.isNumeric( bytes ) || bytes === 0 ) { return bytes; } - var i = 0, + var i, units = [ '', ' KiB', ' MiB', ' GiB', ' TiB', ' PiB' ]; - for ( ; bytes >= 1024; bytes /= 1024 ) { i++; } + if ( !$.isNumeric( bytes ) || bytes === 0 ) { return bytes; } + + for ( i = 0; bytes >= 1024; bytes /= 1024 ) { i++; } // Maintain one decimal for kB and above, but don't // add ".0" for bytes. return bytes.toFixed( i > 0 ? 1 : 0 ) + units[ i ]; @@ -187,6 +190,8 @@ /** * Generate a breakdown of all loaded modules and their size in * kilobytes. Modules are ordered from largest to smallest. + * + * @return {Object[]} Size reports */ size: function () { // Map each module to a descriptor object. @@ -212,6 +217,8 @@ /** * For each module with styles, count the number of selectors, and * count how many match against some element currently in the DOM. + * + * @return {Object[]} CSS reports */ css: function () { var modules = []; @@ -229,7 +236,7 @@ allSelectors: stats.total, matchedSelectors: stats.matched, percentMatched: stats.total !== 0 ? - ( stats.matched / stats.total * 100 ).toFixed( 2 ) + '%' : null + ( stats.matched / stats.total * 100 ).toFixed( 2 ) + '%' : null } ); } ); sortByProperty( modules, 'allSelectors', true ); @@ -240,6 +247,8 @@ * Report stats on mw.loader.store: the number of localStorage * cache hits and misses, the number of items purged from the * cache, and the total size of the module blob in localStorage. + * + * @return {Object[]} Store stats */ store: function () { var raw, stats = { enabled: mw.loader.store.enabled }; @@ -247,7 +256,7 @@ $.extend( stats, mw.loader.store.stats ); try { raw = localStorage.getItem( mw.loader.store.getStoreKey() ); - stats.totalSizeInBytes = $.byteLength( raw ); + stats.totalSizeInBytes = $.byteLength( raw ); stats.totalSize = humanSize( $.byteLength( raw ) ); } catch ( e ) {} } @@ -278,8 +287,8 @@ // Grep module's CSS if ( - $.isPlainObject( module.style ) && $.isArray( module.style.css ) - && pattern.test( module.style.css.join( '' ) ) + $.isPlainObject( module.style ) && $.isArray( module.style.css ) && + pattern.test( module.style.css.join( '' ) ) ) { // Module's CSS source matches return true; diff --git a/resources/src/mediawiki/mediawiki.jqueryMsg.js b/resources/src/mediawiki/mediawiki.jqueryMsg.js index 2646cffe98..c82b9cbfb9 100644 --- a/resources/src/mediawiki/mediawiki.jqueryMsg.js +++ b/resources/src/mediawiki/mediawiki.jqueryMsg.js @@ -136,6 +136,7 @@ function getFailableParserFn( options ) { return function ( args ) { var fallback, + // eslint-disable-next-line new-cap parser = new mw.jqueryMsg.parser( options ), key = args[ 0 ], argsArray = $.isArray( args[ 1 ] ) ? args[ 1 ] : slice.call( args, 1 ); @@ -212,10 +213,11 @@ } return function () { + var failableResult; if ( !failableParserFn ) { failableParserFn = getFailableParserFn( options ); } - var failableResult = failableParserFn( arguments ); + failableResult = failableParserFn( arguments ); if ( format === 'text' || format === 'escaped' ) { return failableResult.text(); } else { @@ -250,10 +252,11 @@ var failableParserFn; return function () { + var $target; if ( !failableParserFn ) { failableParserFn = getFailableParserFn( options ); } - var $target = this.empty(); + $target = this.empty(); appendWithoutParsing( $target, failableParserFn( arguments ) ); return $target; }; @@ -272,6 +275,7 @@ this.settings.onlyCurlyBraceTransform = ( this.settings.format === 'text' || this.settings.format === 'escaped' ); this.astCache = {}; + // eslint-disable-next-line new-cap this.emitter = new mw.jqueryMsg.htmlEmitter( this.settings.language, this.settings.magic ); }; @@ -292,10 +296,10 @@ /** * Fetch the message string associated with a key, return parsed structure. Memoized. - * Note that we pass '[' + key + ']' back for a missing message here. + * Note that we pass 'â§¼' + key + 'â§½' back for a missing message here. * * @param {string} key - * @return {string|Array} string of '[key]' if message missing, simple string if possible, array of arrays if needs parsing + * @return {string|Array} string of 'â§¼keyâ§½' if message missing, simple string if possible, array of arrays if needs parsing */ getAst: function ( key ) { var wikiText; @@ -303,7 +307,7 @@ if ( !this.astCache.hasOwnProperty( key ) ) { wikiText = this.settings.messages.get( key ); if ( typeof wikiText !== 'string' ) { - wikiText = '\\[' + key + '\\]'; + wikiText = 'â§¼' + key + 'â§½'; } this.astCache[ key ] = this.wikiTextToAst( wikiText ); } @@ -903,7 +907,8 @@ /** * Starts the parse * - * @param {Function} rootExpression root parse function + * @param {Function} rootExpression Root parse function + * @return {Array|null} */ function start( rootExpression ) { var result = nOrMore( 0, rootExpression )(); @@ -933,10 +938,13 @@ /** * htmlEmitter - object which primarily exists to emit HTML from parser ASTs + * + * @param {Object} language + * @param {Object} magic */ mw.jqueryMsg.htmlEmitter = function ( language, magic ) { - this.language = language; var jmsg = this; + this.language = language; $.each( magic, function ( key, val ) { jmsg[ key.toLowerCase() ] = function () { return val; @@ -1046,6 +1054,7 @@ * It may, though, if the wikitext appears in extension-controlled content. * * @param {string[]} nodes + * @return {jQuery} */ wikilink: function ( nodes ) { var page, anchor, url, $el; @@ -1275,7 +1284,7 @@ * @return {number|string} Formatted number */ formatnum: function ( nodes ) { - var isInteger = ( nodes[ 1 ] && nodes[ 1 ] === 'R' ) ? true : false, + var isInteger = !!nodes[ 1 ] && nodes[ 1 ] === 'R', number = nodes[ 0 ]; return this.language.convertNumber( number, isInteger ); @@ -1371,6 +1380,6 @@ return function () { return reusableParent.msg( this.key, this.parameters ).contents().detach(); }; - } )(); + }() ); }( mediaWiki, jQuery ) ); diff --git a/resources/src/mediawiki/mediawiki.js b/resources/src/mediawiki/mediawiki.js index 6280c95eaa..fceeb64c4b 100644 --- a/resources/src/mediawiki/mediawiki.js +++ b/resources/src/mediawiki/mediawiki.js @@ -7,7 +7,9 @@ * @alternateClassName mediaWiki * @singleton */ -/*jshint latedef:false */ + +/* eslint-disable no-use-before-define */ + ( function ( $ ) { 'use strict'; @@ -31,7 +33,7 @@ * @return {string} hash as an seven-character base 36 string */ function fnv132( str ) { - /*jshint bitwise:false */ + /* eslint-disable no-bitwise */ var hash = 0x811C9DC5, i; @@ -46,6 +48,7 @@ } return hash; + /* eslint-enable no-bitwise */ } StringSet = window.Set || ( function () { @@ -301,6 +304,7 @@ return mw.format.apply( null, [ this.map.get( this.key ) ].concat( this.parameters ) ); }, + // eslint-disable-next-line valid-jsdoc /** * Add (does not replace) parameters for `$N` placeholder values. * @@ -325,12 +329,15 @@ var text; if ( !this.exists() ) { - // Use as text if key does not exist - if ( this.format === 'escaped' || this.format === 'parse' ) { - // format 'escaped' and 'parse' need to have the brackets and key html escaped - return mw.html.escape( '<' + this.key + '>' ); - } - return '<' + this.key + '>'; + // Use â§¼keyâ§½ as text if key does not exist + // Err on the side of safety, ensure that the output + // is always html safe in the event the message key is + // missing, since in that case its highly likely the + // message key is user-controlled. + // 'â§¼' is used instead of '<' to side-step any + // double-escaping issues. + // (Keep synchronised with Message::toString() in PHP.) + return 'â§¼' + mw.html.escape( this.key ) + 'â§½'; } if ( this.format === 'plain' || this.format === 'text' || this.format === 'parse' ) { @@ -412,6 +419,7 @@ } }; + /* eslint-disable no-console */ log = ( function () { // Also update the restoration of methods in mediawiki.log.js // when adding or removing methods here. @@ -460,9 +468,9 @@ log.deprecate = !Object.defineProperty ? function ( obj, key, val ) { obj[ key ] = val; } : function ( obj, key, val, msg, logName ) { + var logged = new StringSet(); logName = logName || key; msg = 'Use of "' + logName + '" is deprecated.' + ( msg ? ( ' ' + msg ) : '' ); - var logged = new StringSet(); function uniqueTrace() { var trace = new Error().stack; if ( logged.has( trace ) ) { @@ -500,6 +508,7 @@ return log; }() ); + /* eslint-enable no-console */ /** * @class mw @@ -1109,7 +1118,7 @@ } if ( registry[ module ].skip !== null ) { - /*jshint evil:true */ + // eslint-disable-next-line no-new-func skip = new Function( registry[ module ].skip ); registry[ module ].skip = null; if ( skip() ) { @@ -1149,7 +1158,7 @@ ) ); } - unresolved.add( module ); + unresolved.add( module ); sortDependencies( deps[ i ], resolved, unresolved ); } } @@ -1162,12 +1171,13 @@ * @private * @param {string[]} modules Array of string module names * @return {Array} List of dependencies, including 'module'. + * @throws {Error} If an unregistered module or a dependency loop is encountered */ function resolve( modules ) { - var resolved = []; - $.each( modules, function ( idx, module ) { - sortDependencies( module, resolved ); - } ); + var i, resolved = []; + for ( i = 0; i < modules.length; i++ ) { + sortDependencies( modules[ i ], resolved ); + } return resolved; } @@ -1235,6 +1245,8 @@ * Utility function for execute() * * @ignore + * @param {string} [media] Media attribute + * @param {string} url URL */ function addLink( media, url ) { var el = document.createElement( 'link' ); @@ -1294,9 +1306,9 @@ } ); }; - implicitDependencies = ( $.inArray( module, legacyModules ) !== -1 ) - ? [] - : legacyModules; + implicitDependencies = ( $.inArray( module, legacyModules ) !== -1 ) ? + [] : + legacyModules; if ( module === 'user' ) { // Implicit dependency on the site module. Not real dependency because @@ -1304,9 +1316,9 @@ implicitDependencies.push( 'site' ); } - legacyWait = implicitDependencies.length - ? mw.loader.using( implicitDependencies ) - : $.Deferred().resolve(); + legacyWait = implicitDependencies.length ? + mw.loader.using( implicitDependencies ) : + $.Deferred().resolve(); legacyWait.always( function () { try { @@ -1500,6 +1512,8 @@ * to a query string of the form foo.bar,baz|bar.baz,quux * * @private + * @param {Object} moduleMap Module map + * @return {string} Module query string */ function buildModulesString( moduleMap ) { var p, prefix, @@ -1635,9 +1649,9 @@ prefix = modules[ i ].substr( 0, lastDotIndex ); suffix = modules[ i ].slice( lastDotIndex + 1 ); - bytesAdded = hasOwn.call( moduleMap, prefix ) - ? suffix.length + 3 // '%2C'.length == 3 - : modules[ i ].length + 3; // '%7C'.length == 3 + bytesAdded = hasOwn.call( moduleMap, prefix ) ? + suffix.length + 3 : // '%2C'.length == 3 + modules[ i ].length + 3; // '%7C'.length == 3 // If the url would become too long, create a new one, // but don't create empty requests @@ -1777,11 +1791,13 @@ return true; } ); asyncEval( implementations, function ( err ) { + var failed; // Not good, the cached mw.loader.implement calls failed! This should // never happen, barring ResourceLoader bugs, browser bugs and PEBKACs. // Depending on how corrupt the string is, it is likely that some // modules' implement() succeeded while the ones after the error will // never run and leave their modules in the 'loading' state forever. + mw.loader.store.stats.failed++; // Since this is an error not caused by an individual module but by // something that infected the implement call itself, don't take any @@ -1790,7 +1806,7 @@ mw.track( 'resourceloader.exception', { exception: err, source: 'store-eval' } ); // Re-add the failed ones that are still pending back to the batch - var failed = $.grep( sourceModules, function ( module ) { + failed = $.grep( sourceModules, function ( module ) { return registry[ module ].state === 'loading'; } ); batchRequest( failed ); @@ -1985,8 +2001,12 @@ deferred.fail( error ); } - // Resolve entire dependency map - dependencies = resolve( dependencies ); + try { + // Resolve entire dependency map + dependencies = resolve( dependencies ); + } catch ( e ) { + return deferred.reject( e ).promise(); + } if ( allReady( dependencies ) ) { // Run ready immediately deferred.resolve( mw.loader.require ); @@ -2139,6 +2159,8 @@ * * @protected * @since 1.27 + * @param {string} moduleName Module name + * @return {Mixed} Exported value */ require: function ( moduleName ) { var state = mw.loader.getState( moduleName ); @@ -2184,7 +2206,7 @@ items: {}, // Cache hit stats - stats: { hits: 0, misses: 0, expired: 0 }, + stats: { hits: 0, misses: 0, expired: 0, failed: 0 }, /** * Construct a JSON-serializable object representing the content of the store. @@ -2305,6 +2327,7 @@ * * @param {string} module Module name * @param {Object} descriptor The module's descriptor as set in the registry + * @return {boolean} Module was set */ set: function ( module, descriptor ) { var args, key, src; @@ -2325,7 +2348,7 @@ // Partial descriptor // (e.g. skipped module, or style module with state=ready) $.inArray( undefined, [ descriptor.script, descriptor.style, - descriptor.messages, descriptor.templates ] ) !== -1 + descriptor.messages, descriptor.templates ] ) !== -1 ) { // Decline to store return false; @@ -2349,7 +2372,7 @@ } } catch ( e ) { mw.track( 'resourceloader.exception', { exception: e, source: 'store-localstorage-json' } ); - return; + return false; } src = 'mw.loader.implement(' + args.join( ',' ) + ');'; @@ -2358,11 +2381,14 @@ } mw.loader.store.items[ key ] = src; mw.loader.store.update(); + return true; }, /** * Iterate through the module store, removing any item that does not correspond * (in name and version) to an item in the module registry. + * + * @return {boolean} Store was pruned */ prune: function () { var key, module; @@ -2381,6 +2407,7 @@ delete mw.loader.store.items[ key ]; } } + return true; }, /** @@ -2504,7 +2531,7 @@ * - this.Raw: The raw value is directly included. * - this.Cdata: The raw value is directly included. An exception is * thrown if it contains any illegal ETAGO delimiter. - * See . + * See . * @return {string} HTML */ element: function ( name, attrs, contents ) { @@ -2562,6 +2589,8 @@ * Wrapper object for raw HTML passed to mw.html.element(). * * @class mw.html.Raw + * @constructor + * @param {string} value */ Raw: function ( value ) { this.value = value; @@ -2571,6 +2600,8 @@ * Wrapper object for CDATA element contents passed to mw.html.element() * * @class mw.html.Cdata + * @constructor + * @param {string} value */ Cdata: function ( value ) { this.value = value; @@ -2669,6 +2700,7 @@ */ remove: list.remove, + // eslint-disable-next-line valid-jsdoc /** * Run a hook. * @@ -2702,6 +2734,7 @@ * @param {string} [data.module] Name of module which caused the error */ function logError( topic, data ) { + /* eslint-disable no-console */ var msg, e = data.exception, source = data.source, @@ -2723,6 +2756,7 @@ console.error( String( e ), e ); } } + /* eslint-enable no-console */ } // Subscribe to error streams diff --git a/resources/src/mediawiki/mediawiki.log.js b/resources/src/mediawiki/mediawiki.log.js index c886817799..4d23604ca1 100644 --- a/resources/src/mediawiki/mediawiki.log.js +++ b/resources/src/mediawiki/mediawiki.log.js @@ -52,11 +52,11 @@ if ( !$log.length ) { $log = $( '

' ).css( { - overflow: 'auto', - height: '150px', - backgroundColor: 'white', - borderTop: 'solid 2px #ADADAD' - } ); + overflow: 'auto', + height: '150px', + backgroundColor: 'white', + borderTop: 'solid 2px #ADADAD' + } ); hovzer = $.getFootHovzer(); hovzer.$.append( $log ); hovzer.update(); diff --git a/resources/src/mediawiki/mediawiki.notification.js b/resources/src/mediawiki/mediawiki.notification.js index 36b45f177f..e1287dbc56 100644 --- a/resources/src/mediawiki/mediawiki.notification.js +++ b/resources/src/mediawiki/mediawiki.notification.js @@ -23,9 +23,11 @@ * @alternateClassName mw.Notification * @constructor * @private + * @param {mw.Message|jQuery|HTMLElement|string} message + * @param {Object} options */ function Notification( message, options ) { - var $notification, $notificationTitle, $notificationContent; + var $notification, $notificationContent; $notification = $( '

' ) .data( 'mw.notification', this ) @@ -48,7 +50,7 @@ } if ( options.title ) { - $notificationTitle = $( '

' ) + $( '

' ) .text( options.title ) .appendTo( $notification ); } @@ -227,7 +229,7 @@ $area.hide(); notif.$notification.remove(); } else { - notif.$notification.slideUp( 'fast', function () { + notif.$notification.slideUp( 'fast', function () { $( this ).remove(); } ); } @@ -260,7 +262,8 @@ * @ignore */ function init() { - var offset, $window = $( window ); + var offset, + isFloating = false; $area = $( '

' ) // Pause auto-hide timers when the mouse is in the notification area. @@ -287,13 +290,17 @@ $area.hide(); function updateAreaMode() { - var isFloating = $window.scrollTop() > offset.top; + var shouldFloat = window.pageYOffset > offset.top; + if ( isFloating === shouldFloat ) { + return; + } + isFloating = shouldFloat; $area .toggleClass( 'mw-notification-area-floating', isFloating ) .toggleClass( 'mw-notification-area-layout', !isFloating ); } - $window.on( 'scroll', updateAreaMode ); + $( window ).on( 'scroll', updateAreaMode ); // Initial mode updateAreaMode(); diff --git a/resources/src/mediawiki/mediawiki.searchSuggest.js b/resources/src/mediawiki/mediawiki.searchSuggest.js index 7c7aca39fa..bcb6c339df 100644 --- a/resources/src/mediawiki/mediawiki.searchSuggest.js +++ b/resources/src/mediawiki/mediawiki.searchSuggest.js @@ -4,12 +4,12 @@ ( function ( mw, $ ) { mw.searchSuggest = { // queries the wiki and calls response with the result - request: function ( api, query, response, maxRows ) { + request: function ( api, query, response, maxRows, namespace ) { return api.get( { formatversion: 2, action: 'opensearch', search: query, - namespace: 0, + namespace: namespace || 0, limit: maxRows, suggest: true } ).done( function ( data, jqXHR ) { @@ -22,7 +22,7 @@ }; $( function () { - var api, map, searchboxesSelectors, + var api, searchboxesSelectors, // Region where the suggestions box will appear directly below // (using the same width). Can be a container element or the input // itself, depending on what suits best in the environment. @@ -34,23 +34,6 @@ $searchInput = $( '#searchInput' ), previousSearchText = $searchInput.val(); - // Compatibility map - map = { - // SimpleSearch is broken in Opera < 9.6 - opera: [ [ '>=', 9.6 ] ], - // Older Konquerors are unable to position the suggestions correctly (bug 50805) - konqueror: [ [ '>=', '4.11' ] ], - docomo: false, - blackberry: false, - // Support for iOS 6 or higher. It has not been tested on iOS 5 or lower - ipod: [ [ '>=', 6 ] ], - iphone: [ [ '>=', 6 ] ] - }; - - if ( !$.client.test( map ) ) { - return; - } - // Compute form data for search suggestions functionality. function getFormData( context ) { var $form, baseHref, linkParams; @@ -92,13 +75,15 @@ } /** - * defines the location of autocomplete. Typically either + * Defines the location of autocomplete. Typically either * header, which is in the top right of vector (for example) * and content which identifies the main search bar on - * Special:Search. Defaults to header for skins that don't set + * Special:Search. Defaults to header for skins that don't set * explicitly. * * @ignore + * @param {Object} context + * @return {string} */ function getInputLocation( context ) { return context.config.$region @@ -112,6 +97,7 @@ * 'this' is the search input box (jQuery object) * * @ignore + * @param {Object} metadata */ function onAfterUpdate( metadata ) { var context = this.data( 'suggestionsContext' ); @@ -254,7 +240,7 @@ cache: true, highlightInput: true } ) - .bind( 'paste cut drop', function () { + .on( 'paste cut drop', function () { // make sure paste and cut events from the mouse and drag&drop events // trigger the keypress handler and cause the suggestions to update $( this ).trigger( 'keypress' ); diff --git a/resources/src/mediawiki/mediawiki.storage.js b/resources/src/mediawiki/mediawiki.storage.js index a9d17ff70d..20f8efb659 100644 --- a/resources/src/mediawiki/mediawiki.storage.js +++ b/resources/src/mediawiki/mediawiki.storage.js @@ -1,65 +1,91 @@ ( function ( mw ) { 'use strict'; - /** - * Library for storing device specific information. It should be used for storing simple - * strings and is not suitable for storing large chunks of data. - * - * @class mw.storage - * @singleton - */ - mw.storage = { - - localStorage: ( function () { - // Catch exceptions to avoid fatal in Chrome's "Block data storage" mode - // which throws when accessing the localStorage property itself, as opposed - // to the standard behaviour of throwing on getItem/setItem. (T148998) + // Catch exceptions to avoid fatal in Chrome's "Block data storage" mode + // which throws when accessing the localStorage property itself, as opposed + // to the standard behaviour of throwing on getItem/setItem. (T148998) + var + localStorage = ( function () { try { return window.localStorage; } catch ( e ) {} }() ), - - /** - * Retrieve value from device storage. - * - * @param {string} key Key of item to retrieve - * @return {string|boolean} False when localStorage not available, otherwise string - */ - get: function ( key ) { + sessionStorage = ( function () { try { - return mw.storage.localStorage.getItem( key ); + return window.sessionStorage; } catch ( e ) {} - return false; - }, + }() ); - /** - * Set a value in device storage. - * - * @param {string} key Key name to store under - * @param {string} value Value to be stored - * @return {boolean} Whether the save succeeded or not - */ - set: function ( key, value ) { - try { - mw.storage.localStorage.setItem( key, value ); - return true; - } catch ( e ) {} - return false; - }, + /** + * A wrapper for an HTML5 Storage interface (`localStorage` or `sessionStorage`) + * that is safe to call on all browsers. + * + * @class mw.SafeStorage + * @private + */ - /** - * Remove a value from device storage. - * - * @param {string} key Key of item to remove - * @return {boolean} Whether the save succeeded or not - */ - remove: function ( key ) { - try { - mw.storage.localStorage.removeItem( key ); - return true; - } catch ( e ) {} - return false; - } + /** + * @ignore + * @param {Object|undefined} store The Storage instance to wrap around + */ + function SafeStorage( store ) { + this.store = store; + } + + /** + * Retrieve value from device storage. + * + * @param {string} key Key of item to retrieve + * @return {string|boolean} False when localStorage not available, otherwise string + */ + SafeStorage.prototype.get = function ( key ) { + try { + return this.store.getItem( key ); + } catch ( e ) {} + return false; + }; + + /** + * Set a value in device storage. + * + * @param {string} key Key name to store under + * @param {string} value Value to be stored + * @return {boolean} Whether the save succeeded or not + */ + SafeStorage.prototype.set = function ( key, value ) { + try { + this.store.setItem( key, value ); + return true; + } catch ( e ) {} + return false; + }; + + /** + * Remove a value from device storage. + * + * @param {string} key Key of item to remove + * @return {boolean} Whether the save succeeded or not + */ + SafeStorage.prototype.remove = function ( key ) { + try { + this.store.removeItem( key ); + return true; + } catch ( e ) {} + return false; }; + /** + * @class + * @singleton + * @extends mw.SafeStorage + */ + mw.storage = new SafeStorage( localStorage ); + + /** + * @class + * @singleton + * @extends mw.SafeStorage + */ + mw.storage.session = new SafeStorage( sessionStorage ); + }( mediaWiki ) ); diff --git a/resources/src/mediawiki/mediawiki.template.mustache.js b/resources/src/mediawiki/mediawiki.template.mustache.js index 7f62256adf..9f5e5c4e9f 100644 --- a/resources/src/mediawiki/mediawiki.template.mustache.js +++ b/resources/src/mediawiki/mediawiki.template.mustache.js @@ -1,4 +1,4 @@ -/*global Mustache */ +/* global Mustache */ ( function ( mw, $ ) { // Register mustache compiler mw.template.registerCompiler( 'mustache', { @@ -16,6 +16,7 @@ * @param {Object} data Data to render * @param {Object} partialTemplates Map partial names to Mustache template objects * returned by mw.template.get() + * @return {jQuery} Rendered HTML */ render: function ( data, partialTemplates ) { var partials = {}; diff --git a/resources/src/mediawiki/mediawiki.user.blockcookie.js b/resources/src/mediawiki/mediawiki.user.blockcookie.js new file mode 100644 index 0000000000..ffff039e86 --- /dev/null +++ b/resources/src/mediawiki/mediawiki.user.blockcookie.js @@ -0,0 +1,23 @@ +( function ( mw ) { + + // If a user has been autoblocked, a cookie is set. + // Its value is replicated here in localStorage to guard against cookie-removal. + // This module will only be loaded when $wgCookieSetOnAutoblock is true. + // Ref: https://phabricator.wikimedia.org/T5233 + + if ( !mw.cookie.get( 'BlockID' ) && mw.storage.get( 'blockID' ) ) { + // The block ID exists in storage, but not in the cookie. + mw.cookie.set( 'BlockID', mw.storage.get( 'blockID' ) ); + + } else if ( parseInt( mw.cookie.get( 'BlockID' ), 10 ) > 0 && !mw.storage.get( 'blockID' ) ) { + // The block ID exists in the cookie, but not in storage. + // (When a block expires the cookie remains but its value is '', hence the integer check above.) + mw.storage.set( 'blockID', mw.cookie.get( 'BlockID' ) ); + + } else if ( mw.cookie.get( 'BlockID' ) === '' && mw.storage.get( 'blockID' ) ) { + // If only the empty string is in the cookie, remove the storage value. The block is no longer valid. + mw.storage.remove( 'blockID' ); + + } + +}( mediaWiki ) ); diff --git a/resources/src/mediawiki/mediawiki.user.js b/resources/src/mediawiki/mediawiki.user.js index 63e7de87ef..c4c91f95b1 100644 --- a/resources/src/mediawiki/mediawiki.user.js +++ b/resources/src/mediawiki/mediawiki.user.js @@ -2,10 +2,9 @@ * @class mw.user * @singleton */ +/* global Uint32Array */ ( function ( mw, $ ) { - var i, - userInfoPromise, - byteToHex = []; + var userInfoPromise; /** * Get the current user's groups or rights @@ -20,12 +19,6 @@ return userInfoPromise; } - // Map from numbers 0-255 to a hex string (with padding) - for ( i = 0; i < 256; i++ ) { - // Padding: Add a full byte (0x100, 256) and strip the extra character - byteToHex[ i ] = ( i + 256 ).toString( 16 ).slice( 1 ); - } - // mw.user with the properties options and tokens gets defined in mediawiki.js. $.extend( mw.user, { @@ -50,30 +43,27 @@ * @return {string} 64 bit integer in hex format, padded */ generateRandomSessionId: function () { - /*jshint bitwise:false */ - var rnds, i, r, - hexRnds = new Array( 8 ), + var rnds, i, + hexRnds = new Array( 2 ), // Support: IE 11 crypto = window.crypto || window.msCrypto; - // Based on https://github.com/broofa/node-uuid/blob/bfd9f96127/uuid.js if ( crypto && crypto.getRandomValues ) { - // Fill an array with 8 random values, each of which is 8 bits. - // Note that Uint8Array is array-like but does not implement Array. - rnds = new Uint8Array( 8 ); + // Fill an array with 2 random values, each of which is 32 bits. + // Note that Uint32Array is array-like but does not implement Array. + rnds = new Uint32Array( 2 ); crypto.getRandomValues( rnds ); } else { - rnds = new Array( 8 ); - for ( i = 0; i < 8; i++ ) { - if ( ( i & 3 ) === 0 ) { - r = Math.random() * 0x100000000; - } - rnds[ i ] = r >>> ( ( i & 3 ) << 3 ) & 255; - } + rnds = [ + Math.floor( Math.random() * 0x100000000 ), + Math.floor( Math.random() * 0x100000000 ) + ]; } - // Convert from number to hex - for ( i = 0; i < 8; i++ ) { - hexRnds[ i ] = byteToHex[ rnds[ i ] ]; + // Convert number to a string with 16 hex characters + for ( i = 0; i < 2; i++ ) { + // Add 0x100000000 before converting to hex and strip the extra character + // after converting to keep the leading zeros. + hexRnds[ i ] = ( rnds[ i ] + 0x100000000 ).toString( 16 ).slice( 1 ); } // Concatenation of two random integers with entropy n and m @@ -108,10 +98,11 @@ * unavailable, or Date for when the user registered. */ getRegistration: function () { + var registration; if ( mw.user.isAnon() ) { return false; } - var registration = mw.config.get( 'wgUserRegistration' ); + registration = mw.config.get( 'wgUserRegistration' ); // Registration may be unavailable if the user signed up before MediaWiki // began tracking this. return !registration ? null : new Date( registration ); diff --git a/resources/src/mediawiki/mediawiki.util.js b/resources/src/mediawiki/mediawiki.util.js index 654f232c3d..a8188dbcbd 100644 --- a/resources/src/mediawiki/mediawiki.util.js +++ b/resources/src/mediawiki/mediawiki.util.js @@ -50,6 +50,7 @@ * Encode the string like PHP's rawurlencode * * @param {string} str String to be encoded. + * @return {string} Encoded string */ rawurlencode: function ( str ) { str = String( str ); @@ -62,6 +63,7 @@ * Encode the string like Sanitizer::escapeId in PHP * * @param {string} str String to be encoded. + * @return {string} Encoded string */ escapeId: function ( str ) { str = String( str ); @@ -80,6 +82,7 @@ * of `wfUrlencode` in PHP. * * @param {string} str String to be encoded. + * @return {string} Encoded string */ wikiUrlencode: function ( str ) { return util.rawurlencode( str ) @@ -124,9 +127,9 @@ query = $.param( params ); } if ( query ) { - url = title - ? util.wikiScript() + '?title=' + util.wikiUrlencode( title ) + '&' + query - : util.wikiScript() + '?' + query; + url = title ? + util.wikiScript() + '?title=' + util.wikiUrlencode( title ) + '&' + query : + util.wikiScript() + '?' + query; } else { url = mw.config.get( 'wgArticlePath' ) .replace( '$1', util.wikiUrlencode( title ).replace( /\$/g, '$$$$' ) ); @@ -188,12 +191,10 @@ * @return {Mixed} Parameter value or null. */ getParamValue: function ( param, url ) { - if ( url === undefined ) { - url = location.href; - } // Get last match, stop at hash var re = new RegExp( '^[^#]*[&?]' + mw.RegExp.escape( param ) + '=([^&#]*)' ), - m = re.exec( url ); + m = re.exec( url !== undefined ? url : location.href ); + if ( m ) { // Beware that decodeURIComponent is not required to understand '+' // by spec, as encodeURIComponent does not produce it. @@ -414,20 +415,15 @@ html5EmailRegexp = new RegExp( // start of string - '^' - + + '^' + // User part which is liberal :p - '[' + rfc5322Atext + '\\.]+' - + + '[' + rfc5322Atext + '\\.]+' + // 'at' - '@' - + + '@' + // Domain first part - '[' + rfc1034LdhStr + ']+' - + + '[' + rfc1034LdhStr + ']+' + // Optional second part and following are separated by a dot - '(?:\\.[' + rfc1034LdhStr + ']+)*' - + + '(?:\\.[' + rfc1034LdhStr + ']+)*' + // End of string '$', // RegExp is case insensitive @@ -444,13 +440,15 @@ * @return {boolean} */ isIPv4Address: function ( address, allowBlock ) { + var block, RE_IP_BYTE, RE_IP_ADD; + if ( typeof address !== 'string' ) { return false; } - var block = allowBlock ? '(?:\\/(?:3[0-2]|[12]?\\d))?' : '', - RE_IP_BYTE = '(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9]?[0-9])', - RE_IP_ADD = '(?:' + RE_IP_BYTE + '\\.){3}' + RE_IP_BYTE; + block = allowBlock ? '(?:\\/(?:3[0-2]|[12]?\\d))?' : ''; + RE_IP_BYTE = '(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9]?[0-9])'; + RE_IP_ADD = '(?:' + RE_IP_BYTE + '\\.){3}' + RE_IP_BYTE; return ( new RegExp( '^' + RE_IP_ADD + block + '$' ).test( address ) ); }, @@ -463,19 +461,21 @@ * @return {boolean} */ isIPv6Address: function ( address, allowBlock ) { + var block, RE_IPV6_ADD; + if ( typeof address !== 'string' ) { return false; } - var block = allowBlock ? '(?:\\/(?:12[0-8]|1[01][0-9]|[1-9]?\\d))?' : '', - RE_IPV6_ADD = - '(?:' + // starts with "::" (including "::") - ':(?::|(?::' + '[0-9A-Fa-f]{1,4}' + '){1,7})' + - '|' + // ends with "::" (except "::") - '[0-9A-Fa-f]{1,4}' + '(?::' + '[0-9A-Fa-f]{1,4}' + '){0,6}::' + - '|' + // contains no "::" - '[0-9A-Fa-f]{1,4}' + '(?::' + '[0-9A-Fa-f]{1,4}' + '){7}' + - ')'; + block = allowBlock ? '(?:\\/(?:12[0-8]|1[01][0-9]|[1-9]?\\d))?' : ''; + RE_IPV6_ADD = + '(?:' + // starts with "::" (including "::") + ':(?::|(?::' + '[0-9A-Fa-f]{1,4}' + '){1,7})' + + '|' + // ends with "::" (except "::") + '[0-9A-Fa-f]{1,4}' + '(?::' + '[0-9A-Fa-f]{1,4}' + '){0,6}::' + + '|' + // contains no "::" + '[0-9A-Fa-f]{1,4}' + '(?::' + '[0-9A-Fa-f]{1,4}' + '){7}' + + ')'; if ( new RegExp( '^' + RE_IPV6_ADD + block + '$' ).test( address ) ) { return true; @@ -485,9 +485,9 @@ RE_IPV6_ADD = '[0-9A-Fa-f]{1,4}' + '(?:::?' + '[0-9A-Fa-f]{1,4}' + '){1,6}'; return ( - new RegExp( '^' + RE_IPV6_ADD + block + '$' ).test( address ) - && /::/.test( address ) - && !/::.*::/.test( address ) + new RegExp( '^' + RE_IPV6_ADD + block + '$' ).test( address ) && + /::/.test( address ) && + !/::.*::/.test( address ) ); }, diff --git a/resources/src/mediawiki/mediawiki.viewport.js b/resources/src/mediawiki/mediawiki.viewport.js index 6396331f90..b453ac8d44 100644 --- a/resources/src/mediawiki/mediawiki.viewport.js +++ b/resources/src/mediawiki/mediawiki.viewport.js @@ -18,6 +18,7 @@ * * @ignore * @private + * @return {Object} Viewport positions */ makeViewportFromWindow: function () { var $window = $( window ), @@ -85,7 +86,7 @@ */ isElementCloseToViewport: function ( el, threshold, rectangle ) { var viewport = rectangle ? $.extend( {}, rectangle ) : this.makeViewportFromWindow(); - threshold = threshold || 50 ; + threshold = threshold || 50; viewport.top -= threshold; viewport.left -= threshold; diff --git a/resources/src/mediawiki/page/gallery-slideshow.js b/resources/src/mediawiki/page/gallery-slideshow.js index cf448b0183..094c4df360 100644 --- a/resources/src/mediawiki/page/gallery-slideshow.js +++ b/resources/src/mediawiki/page/gallery-slideshow.js @@ -207,6 +207,8 @@ /** * Gets the height of the interface elements and the * gallery's caption. + * + * @return {number} Height */ mw.GallerySlideshow.prototype.getChromeHeight = function () { return this.$interface.outerHeight() + this.$galleryCaption.outerHeight(); @@ -335,7 +337,7 @@ if ( this.imageInfoCache[ imageSrc ] === undefined ) { api = new mw.Api(); // TODO: This supports only gallery of images - title = new mw.Title.newFromImg( $img ); + title = mw.Title.newFromImg( $img ); params = { action: 'query', formatversion: 2, @@ -450,11 +452,10 @@ }; // Bootstrap all slideshow galleries - $( function () { - $( '.mw-gallery-slideshow' ).each( function () { - /*jshint -W031 */ + mw.hook( 'wikipage.content' ).add( function ( $content ) { + $content.find( '.mw-gallery-slideshow' ).each( function () { + // eslint-disable-next-line no-new new mw.GallerySlideshow( this ); - /*jshint +W031 */ } ); } ); }( mediaWiki, jQuery, OO ) ); diff --git a/resources/src/mediawiki/page/gallery.css b/resources/src/mediawiki/page/gallery.css index 474d541d83..b7a9132dfe 100644 --- a/resources/src/mediawiki/page/gallery.css +++ b/resources/src/mediawiki/page/gallery.css @@ -28,8 +28,8 @@ li.gallerycaption { li.gallerybox div.thumb { text-align: center; - border: 1px solid #ccc; - background-color: #f9f9f9; + border: 1px solid #c8ccd1; + background-color: #f8f9fa; margin: 2px; } diff --git a/resources/src/mediawiki/page/image-pagination.js b/resources/src/mediawiki/page/image-pagination.js index 02bc1de949..6038a574c8 100644 --- a/resources/src/mediawiki/page/image-pagination.js +++ b/resources/src/mediawiki/page/image-pagination.js @@ -1,8 +1,10 @@ /*! * Implement AJAX navigation for multi-page images so the user may browse without a full page reload. */ + +/* eslint-disable no-use-before-define */ + ( function ( mw, $ ) { - /*jshint latedef:false */ var jqXhr, $multipageimage, $spinner, cache = {}, cacheOrder = []; diff --git a/resources/src/mediawiki/page/patrol.ajax.js b/resources/src/mediawiki/page/patrol.ajax.js index 89bbbe79d8..6d6d46dd94 100644 --- a/resources/src/mediawiki/page/patrol.ajax.js +++ b/resources/src/mediawiki/page/patrol.ajax.js @@ -35,11 +35,12 @@ rcid: rcid } ) .done( function ( data ) { + var title; // Remove all patrollinks from the page (including any spinners inside). $patrolLinks.closest( '.patrollink' ).remove(); if ( data.patrol !== undefined ) { // Success - var title = new mw.Title( data.patrol.title ); + title = new mw.Title( data.patrol.title ); mw.notify( mw.msg( 'markedaspatrollednotify', title.toText() ) ); } else { // This should never happen as errors should trigger fail diff --git a/resources/src/mediawiki/page/rollback.js b/resources/src/mediawiki/page/rollback.js index 83d14b3ed3..d94b158538 100644 --- a/resources/src/mediawiki/page/rollback.js +++ b/resources/src/mediawiki/page/rollback.js @@ -30,6 +30,7 @@ $spinner = $.createSpinner( { size: 'small', type: 'inline' } ); $link.hide().after( $spinner ); + // @todo: data.messageHtml is no more. Convert to using errorformat=html. api = new mw.Api(); api.rollback( page, user ) .then( function ( data ) { @@ -43,9 +44,9 @@ } $( e.delegateTarget ).remove(); }, function ( errorCode, data ) { - var message = data && data.error && data.error.messageHtml - ? $.parseHTML( data.error.messageHtml ) - : mw.msg( 'rollbackfailed' ), + var message = data && data.error && data.error.messageHtml ? + $.parseHTML( data.error.messageHtml ) : + mw.msg( 'rollbackfailed' ), type = errorCode === 'alreadyrolled' ? 'warn' : 'error'; mw.notify( message, { diff --git a/resources/src/mediawiki/page/startup.js b/resources/src/mediawiki/page/startup.js index 282799ad36..076357a40c 100644 --- a/resources/src/mediawiki/page/startup.js +++ b/resources/src/mediawiki/page/startup.js @@ -3,6 +3,7 @@ mw.page = {}; $( function () { + var $diff; mw.util.init(); /** @@ -23,7 +24,7 @@ */ mw.hook( 'wikipage.content' ).fire( $( '#mw-content-text' ) ); - var $diff = $( 'table.diff[data-mw="interface"]' ); + $diff = $( 'table.diff[data-mw="interface"]' ); if ( $diff.length ) { /** * Fired when the diff is added to a page containing a diff diff --git a/resources/src/mediawiki/page/watch.js b/resources/src/mediawiki/page/watch.js index f81882b225..5dda7e0d90 100644 --- a/resources/src/mediawiki/page/watch.js +++ b/resources/src/mediawiki/page/watch.js @@ -132,9 +132,16 @@ api[ action ]( title ) .done( function ( watchResponse ) { - var otherAction = action === 'watch' ? 'unwatch' : 'watch'; + var mwTitle, message, otherAction = action === 'watch' ? 'unwatch' : 'watch'; - mw.notify( $.parseHTML( watchResponse.message ), { + mwTitle = mw.Title.newFromText( title ); + if ( mwTitle && mwTitle.getNamespaceId() > 0 && mwTitle.getNamespaceId() % 2 === 1 ) { + message = action === 'watch' ? 'addedwatchtext-talk' : 'removedwatchtext-talk'; + } else { + message = action === 'watch' ? 'addedwatchtext' : 'removedwatchtext'; + } + + mw.notify( mw.message( message, title ).parseDom(), { tag: 'watch-self' } ); diff --git a/resources/src/moment-dmy.js b/resources/src/moment-dmy.js index c67b93e976..0abb9574bf 100644 --- a/resources/src/moment-dmy.js +++ b/resources/src/moment-dmy.js @@ -1,7 +1,7 @@ // Use DMY date format for Moment.js, in accordance with MediaWiki's date formatting routines. // This affects English only (and languages without localisations, that fall back to English). // http://momentjs.com/docs/#/customization/long-date-formats/ -/*global moment */ +/* global moment */ moment.locale( 'en', { longDateFormat: { // Unchanged, but have to be repeated here: diff --git a/resources/src/moment-locale-overrides.js b/resources/src/moment-locale-overrides.js index dd33b007f6..13f26f07dc 100644 --- a/resources/src/moment-locale-overrides.js +++ b/resources/src/moment-locale-overrides.js @@ -1,4 +1,4 @@ -/*global moment, mw */ +/* global moment, mw */ // HACK: Overwrite moment's i18n with MediaWiki's for the current language so that // wgTranslateNumerals is respected. diff --git a/resources/src/oojs-ui-local.js b/resources/src/oojs-ui-local.js index 84ec92d0b0..99d97849f9 100644 --- a/resources/src/oojs-ui-local.js +++ b/resources/src/oojs-ui-local.js @@ -1,5 +1,10 @@ -// Connect OOjs UI to MediaWiki's localisation system ( function ( mw ) { + // Connect OOjs UI to MediaWiki's localisation system OO.ui.getUserLanguages = mw.language.getFallbackLanguageChain; OO.ui.msg = mw.msg; + // Connect OOjs UI's deprecation warnings to MediaWiki's logging system + OO.ui.warnDeprecation = function ( message ) { + mw.track( 'mw.deprecate', 'oojs-ui' ); + mw.log.warn( message ); + }; }( mediaWiki ) ); diff --git a/resources/src/polyfill-nodeTypes.js b/resources/src/polyfill-nodeTypes.js index 556b51b4fd..c8acc86df4 100644 --- a/resources/src/polyfill-nodeTypes.js +++ b/resources/src/polyfill-nodeTypes.js @@ -1,19 +1,19 @@ /** * Adds window.Node with node types according to: - * http://www.w3.org/TR/DOM-Level-2-Core/core.html#ID-1950641247 + * https://www.w3.org/TR/DOM-Level-2-Core/core.html#ID-1950641247 */ window.Node = window.Node || { - ELEMENT_NODE: 1, - ATTRIBUTE_NODE: 2, - TEXT_NODE: 3, - CDATA_SECTION_NODE: 4, - ENTITY_REFERENCE_NODE: 5, - ENTITY_NODE: 6, + ELEMENT_NODE: 1, + ATTRIBUTE_NODE: 2, + TEXT_NODE: 3, + CDATA_SECTION_NODE: 4, + ENTITY_REFERENCE_NODE: 5, + ENTITY_NODE: 6, PROCESSING_INSTRUCTION_NODE: 7, - COMMENT_NODE: 8, - DOCUMENT_NODE: 9, - DOCUMENT_TYPE_NODE: 10, - DOCUMENT_FRAGMENT_NODE: 11, - NOTATION_NODE: 12 + COMMENT_NODE: 8, + DOCUMENT_NODE: 9, + DOCUMENT_TYPE_NODE: 10, + DOCUMENT_FRAGMENT_NODE: 11, + NOTATION_NODE: 12 }; diff --git a/resources/src/startup.js b/resources/src/startup.js index d026cb01ab..20818d2656 100644 --- a/resources/src/startup.js +++ b/resources/src/startup.js @@ -3,11 +3,11 @@ * * This file is where we decide whether to initialise the modern run-time. */ -/*jshint unused: false */ -/*globals mw, RLQ: true, NORLQ: true, $VARS, $CODE, performance */ -var mediaWikiLoadStart = ( new Date() ).getTime(), +/* global mw, $VARS, $CODE */ +// eslint-disable-next-line no-unused-vars +var mediaWikiLoadStart = ( new Date() ).getTime(), mwPerformance = ( window.performance && performance.mark ) ? performance : { mark: function () {} }; @@ -21,17 +21,19 @@ mwPerformance.mark( 'mwLoadStart' ); * - DOM Level 4 & Selectors API Level 1 * - HTML5 & Web Storage * - DOM Level 2 Events + * - JSON * * Browsers we support in our modern run-time (Grade A): - * - Chrome + * - Chrome 4+ * - IE 9+ * - Firefox 3.5+ - * - Safari 4+ + * - Safari 5+ * - Opera 10.5+ - * - Mobile Safari (iOS 1+) + * - Mobile Safari (iOS 4+) * - Android 2.0+ * * Browsers we support in our no-javascript run-time (Grade C): + * - Chrome 1+ * - IE 6+ * - Firefox 3+ * - Safari 3+ @@ -44,30 +46,37 @@ mwPerformance.mark( 'mwLoadStart' ); * - Nokia's Ovi Browser * - MeeGo's browser * - Google Glass + * - UC Mini (speed mode on) * * Other browsers that pass the check are considered Grade X. + * + * @param {string} [str] User agent, defaults to navigator.userAgent + * @return {boolean} User agent is compatible with MediaWiki JS */ function isCompatible( str ) { var ua = str || navigator.userAgent; return !!( // http://caniuse.com/#feat=queryselector - 'querySelector' in document + 'querySelector' in document && // http://caniuse.com/#feat=namevalue-storage // https://developer.blackberry.com/html5/apis/v1_0/localstorage.html // https://blog.whatwg.org/this-week-in-html-5-episode-30 - && 'localStorage' in window + 'localStorage' in window && // http://caniuse.com/#feat=addeventlistener - && 'addEventListener' in window + 'addEventListener' in window && + + // http://caniuse.com/#feat=json + // https://phabricator.wikimedia.org/T141344#2784065 + ( window.JSON && JSON.stringify && JSON.parse ) && // Hardcoded exceptions for browsers that pass the requirement but we don't want to // support in the modern run-time. - && !( - ua.match( /webOS\/1\.[0-4]/ ) || - ua.match( /PlayStation/i ) || - ua.match( /SymbianOS|Series60|NetFront|Opera Mini|S40OviBrowser|MeeGo/ ) || - ( ua.match( /Glass/ ) && ua.match( /Android/ ) ) + // Note: Please extend the regex instead of adding new ones + !( + ua.match( /webOS\/1\.[0-4]|SymbianOS|Series60|NetFront|Opera Mini|S40OviBrowser|MeeGo|Android.+Glass|^Mozilla\/5\.0 .+ Gecko\/$|googleweblight/ ) || + ua.match( /PlayStation/i ) ) ); } @@ -112,6 +121,7 @@ function isCompatible( str ) { // Must be after mw.config.set because these callbacks may use mw.loader which // needs to have values 'skin', 'debug' etc. from mw.config. + // eslint-disable-next-line vars-on-top var RLQ = window.RLQ || []; while ( RLQ.length ) { RLQ.shift()(); diff --git a/tests/common/TestSetup.php b/tests/common/TestSetup.php index 6c3ad0761e..53e724bbed 100644 --- a/tests/common/TestSetup.php +++ b/tests/common/TestSetup.php @@ -15,6 +15,7 @@ class TestSetup { global $wgMainStash; global $wgLanguageConverterCacheType, $wgUseDatabaseMessages; global $wgLocaltimezone, $wgLocalisationCacheConf; + global $wgSearchType; global $wgDevelopmentWarnings; global $wgSessionProviders, $wgSessionPbkdf2Iterations; global $wgJobTypeConf; @@ -50,6 +51,9 @@ class TestSetup { $wgLocalisationCacheConf['storeClass'] = 'LCStoreNull'; + // Do not bother updating search tables + $wgSearchType = 'SearchEngineDummy'; + // Generic MediaWiki\Session\SessionManager configuration for tests // We use CookieSessionProvider because things might be expecting // cookies to show up in a FauxRequest somewhere. diff --git a/tests/common/TestsAutoLoader.php b/tests/common/TestsAutoLoader.php index 0bfa318081..b67c9abfee 100644 --- a/tests/common/TestsAutoLoader.php +++ b/tests/common/TestsAutoLoader.php @@ -29,12 +29,15 @@ $wgAutoloadClasses += [ # tests/common 'TestSetup' => "$testDir/common/TestSetup.php", + # tests/integration + 'MWHttpRequestTestCase' => "$testDir/integration/includes/http/MWHttpRequestTestCase.php", + # tests/parser 'DbTestPreviewer' => "$testDir/parser/DbTestPreviewer.php", 'DbTestRecorder' => "$testDir/parser/DbTestRecorder.php", 'DjVuSupport' => "$testDir/parser/DjVuSupport.php", - 'TestRecorder' => "$testDir/parser/TestRecorder.php", 'MultiTestRecorder' => "$testDir/parser/MultiTestRecorder.php", + 'ParserTestMockParser' => "$testDir/parser/ParserTestMockParser.php", 'ParserTestRunner' => "$testDir/parser/ParserTestRunner.php", 'ParserTestParserHook' => "$testDir/parser/ParserTestParserHook.php", 'ParserTestPrinter' => "$testDir/parser/ParserTestPrinter.php", diff --git a/tests/integration/includes/http/CurlHttpRequestTest.php b/tests/integration/includes/http/CurlHttpRequestTest.php new file mode 100644 index 0000000000..04f80f434f --- /dev/null +++ b/tests/integration/includes/http/CurlHttpRequestTest.php @@ -0,0 +1,5 @@ +oldHttpEngine = Http::$httpEngine; + Http::$httpEngine = static::$httpEngine; + + try { + $request = MWHttpRequest::factory( 'null:' ); + } catch ( DomainException $e ) { + $this->markTestSkipped( static::$httpEngine . ' engine not supported' ); + } + + if ( static::$httpEngine === 'php' ) { + $this->assertInstanceOf( PhpHttpRequest::class, $request ); + } else { + $this->assertInstanceOf( CurlHttpRequest::class, $request ); + } + } + + public function tearDown() { + parent::tearDown(); + Http::$httpEngine = $this->oldHttpEngine; + } + + // -------------------- + + public function testIsRedirect() { + $request = MWHttpRequest::factory( 'http://httpbin.org/get' ); + $status = $request->execute(); + $this->assertTrue( $status->isGood() ); + $this->assertFalse( $request->isRedirect() ); + + $request = MWHttpRequest::factory( 'http://httpbin.org/redirect/1' ); + $status = $request->execute(); + $this->assertTrue( $status->isGood() ); + $this->assertTrue( $request->isRedirect() ); + } + + public function testgetFinalUrl() { + $request = MWHttpRequest::factory( 'http://httpbin.org/redirect/3' ); + if ( !$request->canFollowRedirects() ) { + $this->markTestSkipped( 'cannot follow redirects' ); + } + $status = $request->execute(); + $this->assertTrue( $status->isGood() ); + $this->assertNotSame( 'http://httpbin.org/get', $request->getFinalUrl() ); + + $request = MWHttpRequest::factory( 'http://httpbin.org/redirect/3', [ 'followRedirects' + => true ] ); + $status = $request->execute(); + $this->assertTrue( $status->isGood() ); + $this->assertSame( 'http://httpbin.org/get', $request->getFinalUrl() ); + $this->assertResponseFieldValue( 'url', 'http://httpbin.org/get', $request ); + + $request = MWHttpRequest::factory( 'http://httpbin.org/redirect/3', [ 'followRedirects' + => true ] ); + $status = $request->execute(); + $this->assertTrue( $status->isGood() ); + $this->assertSame( 'http://httpbin.org/get', $request->getFinalUrl() ); + $this->assertResponseFieldValue( 'url', 'http://httpbin.org/get', $request ); + + if ( static::$httpEngine === 'curl' ) { + $this->markTestIncomplete( 'maxRedirects seems to be ignored by CurlHttpRequest' ); + return; + } + + $request = MWHttpRequest::factory( 'http://httpbin.org/redirect/3', [ 'followRedirects' + => true, 'maxRedirects' => 1 ] ); + $status = $request->execute(); + $this->assertTrue( $status->isGood() ); + $this->assertNotSame( 'http://httpbin.org/get', $request->getFinalUrl() ); + } + + public function testSetCookie() { + $request = MWHttpRequest::factory( 'http://httpbin.org/cookies' ); + $request->setCookie( 'foo', 'bar' ); + $request->setCookie( 'foo2', 'bar2', [ 'domain' => 'example.com' ] ); + $status = $request->execute(); + $this->assertTrue( $status->isGood() ); + $this->assertResponseFieldValue( 'cookies', [ 'foo' => 'bar' ], $request ); + } + + public function testSetCookieJar() { + $request = MWHttpRequest::factory( 'http://httpbin.org/cookies' ); + $cookieJar = new CookieJar(); + $cookieJar->setCookie( 'foo', 'bar', [ 'domain' => 'httpbin.org' ] ); + $cookieJar->setCookie( 'foo2', 'bar2', [ 'domain' => 'example.com' ] ); + $request->setCookieJar( $cookieJar ); + $status = $request->execute(); + $this->assertTrue( $status->isGood() ); + $this->assertResponseFieldValue( 'cookies', [ 'foo' => 'bar' ], $request ); + + $request = MWHttpRequest::factory( 'http://httpbin.org/cookies/set?foo=bar' ); + $cookieJar = new CookieJar(); + $request->setCookieJar( $cookieJar ); + $status = $request->execute(); + $this->assertTrue( $status->isGood() ); + $this->assertHasCookie( 'foo', 'bar', $request->getCookieJar() ); + + $this->markTestIncomplete( 'CookieJar does not handle deletion' ); + return; + + $request = MWHttpRequest::factory( 'http://httpbin.org/cookies/delete?foo' ); + $cookieJar = new CookieJar(); + $cookieJar->setCookie( 'foo', 'bar', [ 'domain' => 'httpbin.org' ] ); + $cookieJar->setCookie( 'foo2', 'bar2', [ 'domain' => 'httpbin.org' ] ); + $request->setCookieJar( $cookieJar ); + $status = $request->execute(); + $this->assertTrue( $status->isGood() ); + $this->assertNotHasCookie( 'foo', $request->getCookieJar() ); + $this->assertHasCookie( 'foo2', 'bar2', $request->getCookieJar() ); + } + + public function testGetResponseHeaders() { + $request = MWHttpRequest::factory( 'http://httpbin.org/response-headers?Foo=bar' ); + $status = $request->execute(); + $this->assertTrue( $status->isGood() ); + $headers = array_change_key_case( $request->getResponseHeaders(), CASE_LOWER ); + $this->assertArrayHasKey( 'foo', $headers ); + $this->assertSame( $request->getResponseHeader( 'Foo' ), 'bar' ); + } + + public function testSetHeader() { + $request = MWHttpRequest::factory( 'http://httpbin.org/headers' ); + $request->setHeader( 'Foo', 'bar' ); + $status = $request->execute(); + $this->assertTrue( $status->isGood() ); + $this->assertResponseFieldValue( [ 'headers', 'Foo' ], 'bar', $request ); + } + + public function testGetStatus() { + $request = MWHttpRequest::factory( 'http://httpbin.org/status/418' ); + $status = $request->execute(); + $this->assertFalse( $status->isOK() ); + $this->assertSame( $request->getStatus(), 418 ); + } + + public function testSetUserAgent() { + $request = MWHttpRequest::factory( 'http://httpbin.org/user-agent' ); + $request->setUserAgent( 'foo' ); + $status = $request->execute(); + $this->assertTrue( $status->isGood() ); + $this->assertResponseFieldValue( 'user-agent', 'foo', $request ); + } + + public function testSetData() { + $request = MWHttpRequest::factory( 'http://httpbin.org/post', [ 'method' => 'POST' ] ); + $request->setData( [ 'foo' => 'bar', 'foo2' => 'bar2' ] ); + $status = $request->execute(); + $this->assertTrue( $status->isGood() ); + $this->assertResponseFieldValue( 'form', [ 'foo' => 'bar', 'foo2' => 'bar2' ], $request ); + } + + public function testSetCallback() { + if ( static::$httpEngine === 'php' ) { + $this->markTestIncomplete( 'PhpHttpRequest does not use setCallback()' ); + return; + } + + $request = MWHttpRequest::factory( 'http://httpbin.org/ip' ); + $data = ''; + $request->setCallback( function ( $fh, $content ) use ( &$data ) { + $data .= $content; + return strlen( $content ); + } ); + $status = $request->execute(); + $this->assertTrue( $status->isGood() ); + $data = json_decode( $data, true ); + $this->assertInternalType( 'array', $data ); + $this->assertArrayHasKey( 'origin', $data ); + } + + public function testBasicAuthentication() { + $request = MWHttpRequest::factory( 'http://httpbin.org/basic-auth/user/pass', [ + 'username' => 'user', + 'password' => 'pass', + ] ); + $status = $request->execute(); + $this->assertTrue( $status->isGood() ); + $this->assertResponseFieldValue( 'authenticated', true, $request ); + + $request = MWHttpRequest::factory( 'http://httpbin.org/basic-auth/user/pass', [ + 'username' => 'user', + 'password' => 'wrongpass', + ] ); + $status = $request->execute(); + $this->assertFalse( $status->isOK() ); + $this->assertSame( 401, $request->getStatus() ); + } + + // -------------------- + + /** + * Verifies that the request was successful, returned valid JSON and the given field of that + * JSON data is as expected. + * @param string|string[] $key Path to the data in the response object + * @param mixed $expectedValue + * @param MWHttpRequest $response + */ + protected function assertResponseFieldValue( $key, $expectedValue, MWHttpRequest $response ) { + $this->assertSame( 200, $response->getStatus(), 'response status is not 200' ); + $data = json_decode( $response->getContent(), true ); + $this->assertInternalType( 'array', $data, 'response is not JSON' ); + $keyPath = ''; + foreach ( (array)$key as $keySegment ) { + $keyPath .= ( $keyPath ? '.' : '' ) . $keySegment; + $this->assertArrayHasKey( $keySegment, $data, $keyPath . ' not found' ); + $data = $data[$keySegment]; + } + $this->assertSame( $expectedValue, $data ); + } + + /** + * Asserts that the cookie jar has the given cookie with the given value. + * @param string $expectedName Cookie name + * @param string $expectedValue Cookie value + * @param CookieJar $cookieJar + */ + protected function assertHasCookie( $expectedName, $expectedValue, CookieJar $cookieJar ) { + $cookieJar = TestingAccessWrapper::newFromObject( $cookieJar ); + $cookies = array_change_key_case( $cookieJar->cookie, CASE_LOWER ); + $this->assertArrayHasKey( strtolower( $expectedName ), $cookies ); + $cookie = TestingAccessWrapper::newFromObject( + $cookies[strtolower( $expectedName )] ); + $this->assertSame( $expectedValue, $cookie->value ); + } + + /** + * Asserts that the cookie jar does not have the given cookie. + * @param string $expectedName Cookie name + * @param CookieJar $cookieJar + */ + protected function assertNotHasCookie( $name, CookieJar $cookieJar ) { + $cookieJar = TestingAccessWrapper::newFromObject( $cookieJar ); + $this->assertArrayNotHasKey( strtolower( $name ), + array_change_key_case( $cookieJar->cookie, CASE_LOWER ) ); + } +} + diff --git a/tests/integration/includes/http/PhpHttpRequestTest.php b/tests/integration/includes/http/PhpHttpRequestTest.php new file mode 100644 index 0000000000..d0222a5e76 --- /dev/null +++ b/tests/integration/includes/http/PhpHttpRequestTest.php @@ -0,0 +1,5 @@ +doEditContent( ContentHandler::makeContent( $text, $title ), '', EDIT_NEW ); + // Use mock parser, to make debugging of actual parser tests simpler. + // But initialise the MessageCache clone first, don't let MessageCache + // get a reference to the mock object. + MessageCache::singleton()->getParser(); + $restore = $this->executeSetupSnippets( [ 'wgParser' => new ParserTestMockParser ] ); + $status = $page->doEditContent( + ContentHandler::makeContent( $text, $title ), + '', + EDIT_NEW | EDIT_INTERNAL + ); + $restore(); + if ( !$status->isOK() ) { throw new MWException( $status->getWikiText( false, false, 'en' ) ); } diff --git a/tests/parser/TestFileReader.php b/tests/parser/TestFileReader.php index 59f88c9325..b6e811b1b8 100644 --- a/tests/parser/TestFileReader.php +++ b/tests/parser/TestFileReader.php @@ -264,7 +264,6 @@ class TestFileReader { $this->sectionLineNum = []; $this->sectionData = []; $this->section = null; - } /** diff --git a/tests/parser/parserTests.txt b/tests/parser/parserTests.txt index 103acc609e..b18f1e7a34 100644 --- a/tests/parser/parserTests.txt +++ b/tests/parser/parserTests.txt @@ -1,5 +1,5 @@ # MediaWiki Parser test cases -# Some taken from http://meta.wikimedia.org/wiki/Parser_testing +# Some taken from https://meta.wikimedia.org/wiki/Parser_testing # All (C) their respective authors and released under the GPL # # The syntax should be fairly self-explanatory. @@ -271,6 +271,12 @@ Template:EmptyTRWithHTMLAttrTest !!endarticle +!! article +Template:CircularRef +!! text +{{CircularRef}} +!! endarticle + ### ### Basic tests ### @@ -280,6 +286,15 @@ Blank input !! html !! end +!! test +CircularRef +!! wikitext +{{CircularRef}} + +!! html/parsoid +

[1]

â Error: Expansion loop detected at Template:CircularRef

+!! end !! test Simple paragraph @@ -524,7 +539,7 @@ http://fr.wikipedia.org/wiki/ðº !! end # Note that the html+tidy output removes the spaces after the

, -# which is a bug (http://sourceforge.net/p/tidy/bugs/945/, etc). +# which is a bug (https://sourceforge.net/p/tidy/bugs/945/, etc). # This is an issue for all tests with lists. We intentionally do # *not* add html+tidy clauses for these, as we don't want to # document/test the broken behavior. (Parsoid matches the non-tidy @@ -1230,7 +1245,7 @@ Text-level semantic html elements in wikitext !! end # test cases taken from -# http://www.w3.org/TR/html5/text-level-semantics.html#the-ruby-element +# https://www.w3.org/TR/html5/text-level-semantics.html#the-ruby-element !! test Ruby markup (W3C-style) !! wikitext @@ -1293,7 +1308,7 @@ Non-word characters don't terminate tag names (bug 17663, 40670, 52022)

!! end -# There is a tidy bug here: http://sourceforge.net/p/tidy/bugs/946/ +# There is a tidy bug here: https://sourceforge.net/p/tidy/bugs/946/ # If the non-word-character tag made it through the sanitizer, tidy # would munge it up. !! test @@ -2712,10 +2727,12 @@ Templates: Handle empty comment-and-ws-only lines correctly bar}} -!! html +!! html/php

foo bar

+!! html/parsoid +

foo bar

!! end !! test @@ -2725,15 +2742,28 @@ Templates: Handle comments in the target |foo}} +{{echo + + |foo}} + {{echo |foo}} {{echo|foo}} {{echo|foo}} -!!html/parsoid +!! html/php +

foo +

+!! html/parsoid

foo

@@ -2755,7 +2785,13 @@ Templates: Handle comments in parameter names (bug 67657) {{echo|1=foo}} {{echo|1=foo}} -!!html/parsoid +!! html/php +

foo +

+!! html/parsoid

foo

@@ -2769,11 +2805,11 @@ Templates: Handle comments in parameter names (bug 67657) Templates: Other wikitext in parameter names (bug 67657) !! wikitext {{echo|''1''=foo}} -!!html/parsoid -

{{{1}}}

-!!html/php +!! html/php

{{{1}}}

+!! html/parsoid +

{{{1}}}

!!end #-------------------------------------------------------------------- @@ -3672,7 +3708,6 @@ Definition and unordered list using wiki syntax nested in unordered list using h !! end !! test - Definition list with empty definition and following paragraph !! wikitext ; term: @@ -3849,7 +3884,7 @@ Definition Lists: Hacky use to indent tables (WS-insensitive) ## All Parsoid only definition list tests have this difference. ## ## See also: https://phabricator.wikimedia.org/T8569 -## and http://lists.wikimedia.org/pipermail/wikitext-l/2011-November/000483.html +## and https://lists.wikimedia.org/pipermail/wikitext-l/2011-November/000483.html !! test Table / list interaction: indented table with lists in table contents @@ -5203,7 +5238,7 @@ http://www.example.com/?title=AT%26T

http://www.example.com/?title=AT%26T

!! end -# According to http://www.w3.org/TR/2011/WD-html5-20110525/Overview.html#parsing-urls a plain +# According to https://www.w3.org/TR/2011/WD-html5-20110525/Overview.html#parsing-urls a plain # % is actually legal in HTML5. Any change in output would need testing though. !! test Bug 4781, 5267: %25 in URL @@ -5790,7 +5825,7 @@ Plain ''italic'''s plain # This should not produce

# is the bare minimum required by the spec, see: -# http://www.w3.org/TR/xhtml-modularization/dtd_module_defs.html#a_module_Basic_Tables +# https://www.w3.org/TR/xhtml-modularization/dtd_module_defs.html#a_module_Basic_Tables # Parsoid team replies: empty table tags are legal in HTML5 !! test A table with no data. @@ -7426,6 +7461,23 @@ Piped link with no link text

[[Thomas Bek (bishop of St David's)|]]

!! end +!! test +Piped link with empty link text +!! wikitext +[[Main Page|]] - empty nowiki +[[Main Page| ]] - empty space +[[Main Page| ]] - empty non breaking space +!! html/php +

- empty nowiki + - empty space + - empty non breaking space +

+!! html/parsoid +

- empty nowiki + - empty space +Â - empty non breaking space

+!! end + !! test Broken link !! wikitext @@ -7565,8 +7617,6 @@ Link with multiple pipes

!! end -# Note that parsoid does not munge anchor text; all non-space -# characters are valid in HTML5 ids. !! test Anchor containing a #. (bug 63430) !! wikitext @@ -7575,7 +7625,7 @@ Anchor containing a #. (bug 63430)

Main Page#And#Link

!! html/parsoid -

Main Page#And#Link

!! end !! test @@ -7690,18 +7740,16 @@ Link containing % as a double hex sequence interpreted to hex sequence

!!end -# note that parsoid does not munge anchor text; all non-space -# characters are valid in HTML5 anchors. +## Example for such a section: == < == !! test Link containing "#<" and "#>" % as a hex sequences- these are valid section anchors -Example for such a section: == < == !! wikitext [[%23%3c]][[%23%3e]] !! html/php

#<#>

!! html/parsoid -

#<#>

!! end !! test @@ -8221,7 +8269,7 @@ Link with angle bracket after anchor

Foo#<bar>

!! html/parsoid -

Foo#<bar>

!! end ### @@ -8279,6 +8327,23 @@ Interwiki link with fragment (bug 2130)

!! end +!! test +Link scenarios with escaped fragments +!! wikitext +[[#Is this great?]] +[[Foo#Is this great?]] +[[meatball:Foo#Is this great?]] +!! html/php +

#Is this great? +Foo#Is this great? +meatball:Foo#Is this great? +

+!! html/parsoid +

#Is this great? +Foo#Is this great? +meatball:Foo#Is this great?

+!! end + # Ideally the wikipedia: prefix here should be proto-relative too # [CSA]: this is kind of a bogus test, as the PHP parser test doesn't # define the 'en' prefix, and originally the test used 'wikipedia', @@ -10343,7 +10408,6 @@ language=de

!! end - !! test Urlencode !! wikitext @@ -10351,7 +10415,7 @@ Urlencode {{urlencode:hi world?!|WIKI}} {{urlencode:hi world?!|PATH}} {{urlencode:hi world?!|QUERY}} -!! html +!! html/php

hi+world%3F%21 hi_world%3F! hi%20world%3F%21 @@ -15898,7 +15962,7 @@ parsoid=wt2html,html2html

HTML rocks

!! html/parsoid -

HTML rocks

!! end !! test @@ -17076,9 +17140,11 @@ Table not started Sanitizer: Escaping of spaces, multibyte characters, colons & other stuff in id="" !! wikitext byte[[#Ã¦: v|backlink]] -!! html +!! html/php

bytebacklink

+!! html/parsoid +

bytebacklink

!! end # In HTML5, the restrictions are that id must contain at least one character, @@ -18827,8 +18893,14 @@ title=[[Parser test]] !! end ### Note: Above tests excludes the "{{NUMBEROFADMINS}}" magic word because it generates a MySQL error when included. +## Parsoid thinks the "centre" here is a property, not a caption. !! test Gallery +!! options +parsoid={ + "modes": ["wt2html"], + "nativeGallery": true +} !! wikitext image1.png | @@ -18840,7 +18912,7 @@ image4 |300px| centre [[x|xx]]]] * image6 -!! html +!! html/php

Image1.png
@@ -18878,19 +18950,33 @@ image4 |300px| centre

+!! html/parsoid +

image1.png
image2.gif
image3
image4
image5.svg
http://///////
* image6

!! end !! test -Gallery (with options) +Gallery (with options, html) +!! options +parsoid={ + "modes": ["wt2html", "html2html"], + "nativeGallery": true +} !! wikitext - + File:Nonexistent.jpg|caption File:Nonexistent.jpg image:foobar.jpg|some '''caption''' [[Main Page]] image:foobar.jpg image:foobar.jpg|Blabla|alt=This is a foo-bar.|blabla. -!! html +!! html/php

Foo Main Page
@@ -18926,17 +19012,92 @@ image:foobar.jpg|Blabla|alt=This is a foo-bar.|blabla.

+!! html/parsoid +

Foo Main Page
File:Nonexistent.jpg
caption
File:Nonexistent.jpg
some caption Main Page
blabla.

+!! end + +!! test +Gallery (with options, extsrc) +!! options +parsoid={ + "nativeGallery": false +} +!! wikitext + +File:Nonexistent.jpg|caption +File:Nonexistent.jpg +image:foobar.jpg|some '''caption''' [[Main Page]] +image:foobar.jpg +image:foobar.jpg|Blabla|alt=This is a foo-bar.|blabla. + +!! html/php +

Foo Main Page
+
Nonexistent.jpg
+
+
caption +
+
+
+
Nonexistent.jpg
+
+
+
+
+
+
some caption Main Page +
+
+
+
+
+
+
+
+
+
blabla. +
+
+

+ +!! html/parsoid +

Foo Main Page
File:Nonexistent.jpg
caption
File:Nonexistent.jpg
some caption Main Page
blabla.

!! end !! test Gallery with link that has fragment +!! options +parsoid={ + "modes": ["wt2html", "html2html"], + "nativeGallery": true +} !! wikitext image:foobar.jpg|link=Main_Page image:foobar.jpg|link=Main_Page#section image:foobar.jpg|link=Main Page#section|caption -!! html +!! html/php

@@ -18957,16 +19118,56 @@ image:foobar.jpg|link=Main Page#section|caption

+!! html/parsoid +

caption

+!! end + +## Whoops, Parsoid shouldn't be parsing templates in the attribute caption! +!! test +Gallery with template inside caption +!! options +parsoid={ + "nativeGallery": true +} +!! wikitext + +File:Foobar.jpg|{{echo|ho}} + +!! html/php +

{{echo|hi}}
+
+
+
ho +
+
+

+ +!! html/parsoid +

!! end !! test Gallery with wikitext inside caption +!! options +parsoid={ + "nativeGallery": true +} !! wikitext -File:foobar.jpg|[[File:foobar.jpg|20px|desc|alt=inneralt]]|alt=galleryalt -File:foobar.jpg|{{Test|unamedParam|alt=param}}|alt=galleryalt +File:Foobar.jpg|alt=galleryalt|[[File:Foobar.jpg|alt=inneralt|20x20px|desc]] +File:Foobar.jpg|alt=galleryalt|{{Test|unamedParam|alt=param}} -!! html +!! html/php

@@ -18984,18 +19185,27 @@ File:foobar.jpg|{{Test|unamedParam|alt=param}}|alt=galleryalt

+!! html/parsoid +

This is a test template

!! end !! test -gallery (with showfilename option) +Gallery (with showfilename option) +!! options +parsoid={ + "nativeGallery": true +} !! wikitext - + File:Nonexistent.jpg|caption File:Nonexistent.jpg -image:foobar.jpg|some '''caption''' [[Main Page]] +File:Foobar.jpg|some '''caption''' [[Main Page]] File:Foobar.jpg -!! html +!! html/php

Nonexistent.jpg
@@ -19029,10 +19239,23 @@ some caption Main Page

+!! html/parsoid +

File:Nonexistent.jpg
File:Nonexistent.jpgcaption
File:Nonexistent.jpg
File:Nonexistent.jpg
File:Foobar.jpgsome caption Main Page
File:Foobar.jpg

!! end +## Should Parsoid be preserving these variations? !! test Gallery (with namespace-less filenames) +!! options +parsoid={ + "modes": ["wt2html", "html2html"], + "nativeGallery": true +} !! wikitext File:Nonexistent.jpg @@ -19040,7 +19263,7 @@ Nonexistent.jpg image:foobar.jpg foobar.jpg -!! html +!! html/php

Nonexistent.jpg
@@ -19064,6 +19287,115 @@ foobar.jpg

+!! html/parsoid +

File:Nonexistent.jpg
Nonexistent.jpg

+!! end + +!! test +Gallery override link with WikiLink (T36852) +!! options +parsoid={ + "nativeGallery": true +} +!! wikitext + +File:Foobar.jpg|alt=galleryalt|link=InterWikiLink + +!! html/php +

+
+
+
+

+ +!! html/parsoid +

+!! end + +!! test +Gallery override link with absolute external link (T36852) +!! options +parsoid={ + "nativeGallery": true +} +!! wikitext + +File:Foobar.jpg|alt=galleryalt|link=http://www.example.org + +!! html/php +

+
+
+
+

+ +!! html/parsoid +

+!! end + +!! test +Gallery override link with malicious javascript (T36852) +!! options +parsoid={ + "modes": ["wt2html", "html2html"], + "nativeGallery": true +} +!! wikitext + +File:Foobar.jpg|alt=galleryalt|link=" onclick="alert('malicious javascript code!'); + +!! html/php +

+
+
+
+

+ +!! html/parsoid +

+!! end + +!! test +Gallery with invalid title as link (T45964) +!! options +parsoid={ + "modes": ["wt2html", "html2html"], + "nativeGallery": true +} +!! wikitext + +File:Foobar.jpg|link=< + +!! html/php +

+
+
+
+

+ +!! html/parsoid +

link=<

!! end !! test @@ -19107,7 +19439,7 @@ parsoid=wt2html,wt2wt,html2html

Ã®Ã®

!! end -# See: http://www.w3.org/TR/html5/syntax.html#character-references +# See: https://www.w3.org/TR/html5/syntax.html#character-references # Note that U+000C (form feed) is not a valid XML character, so # it is banned even though allowed in HTML5. !! test @@ -20263,6 +20595,17 @@ language=sr variant=sr-ec

!! end +!! test +T146304: Don't break template parsing if language converter markup is in the parameter. +!! options +language=sr variant=sr-ec +!! wikitext +{{echo|-{R|foo}-}} +!! html/php +

foo +

+!! end + # FIXME: This test is currently broken in the PHP parser (bug 52661) !! test Don't break image parsing if language converter markup is in the caption. @@ -20923,7 +21266,7 @@ Edit comment with link with more than one pipe (T99346) comment !! wikitext [[Main Page|Many|pipes]] -!! html +!! html/php Many|pipes !! end @@ -20933,7 +21276,7 @@ Complex edit comment with link with more than one pipe (T99346) comment !! wikitext Created page with "[[Category:Requests for permissions/Bot|{{subst:#titleparts:{{subst:PAGENAME}}|1|3}}]] === [[User:MineoBot|]] 8=== {{Request for permissions/links|Mineo..." -!! html +!! html/php Created page with "<noinclude>{{subst:#titleparts:{{subst:PAGENAME}}|1|3}}</noinclude> === User:MineoBot 8=== {{Request for permissions/links|Mineo..." !! end @@ -21734,7 +22077,7 @@ Strip marker in urlencode {{urlencode:xy|wiki}} {{urlencode:xy|path}} {{urlencode:x

two

y}} -!! html +!! html/php

xy xy xy @@ -21872,81 +22215,7 @@ Ignore pipe between table row attributes !! end -!!test -Gallery override link with WikiLink (bug 34852) -!! wikitext - -File:foobar.jpg|caption|alt=galleryalt|link=InterWikiLink - -!! html -

-
-
-
caption -
-
-

- -!! end - -!!test -Gallery override link with absolute external link (bug 34852) -!! wikitext - -File:foobar.jpg|caption|alt=galleryalt|link=http://www.example.org - -!! html -

-
-
-
caption -
-
-

- -!! end - -!!test -Gallery override link with malicious javascript (bug 34852) -!! wikitext - -File:foobar.jpg|caption|alt=galleryalt|link=" onclick="alert('malicious javascript code!'); - -!! html -

-
-
-
caption -
-
-

- -!! end - -!!test -Gallery with invalid title as link (bug 43964) -!! wikitext - -File:foobar.jpg|link=< - -!! html -

-
-
-
-

- -!! end - -!!test +!! test Language parser function !! wikitext {{#language:ar}} @@ -22363,19 +22632,20 @@ Ref: 13. ref-tags are not SOL-transparent and block indent-pres !!end -!!test +## Roundtripping fails because of nowiki'ing +!! test Ref: 14. A nested ref-tag should be emitted as plain text +!! options +parsoid=wt2html !! wikitext foo bar baz !! html/parsoid -

[1] -

â foo <ref>bar</ref> baz

-!!end +

[1] baz</ref>

+ +

â foo <ref>bar

+!! end !!test Ref: 15. ref-tags with identical names should get identical indexes @@ -22694,24 +22964,6 @@ foo foo

!! end -#### ---------------------------------------------------------------- -#### Parsoid-only testing of Parsoid's impl of LST -#### Not implemented yet, see -#### https://www.mediawiki.org/wiki/Parsoid/HTML_based_LST -#### ---------------------------------------------------------------- - -!! test -LST Sections: 1. Simple section start and end -!! options -parsoid={ "suppressErrors": true } -!! wikitext -

-!! html/parsoid -

-!! end - #--------- Test stripping of empty nodes in template content ---------- !!test Empty LI and TR nodes should be stripped from template content @@ -26364,6 +26616,93 @@ parsoid=html2wt,wt2wt !! end +!! test +T149209: WTS: Handle newlines in table cells properly +!! options +parsoid=html2wt +!! html/parsoid + + + + +

a +b +	c
x +	y

+ + + + +

a +b +	c
x +	y

+!! wikitext +{| +|a +b +|c +|- +|x +{{!}}y +|} +{| +!a +b +!c +|- +!x +!y +|} +!! end + +!! test +T149209: Selser: Handle newlines in table cells properly +!! options +parsoid={ + "modes": ["selser"], + "changes": [ + [ "#h1", "html", "a\nb\n" ], + [ "#h2", "html", "a\nb\n" ], + [ "#c1", "html", "a\nb\n" ], + [ "#c2", "html", "

" ], + [ "#c3", "html", "

" ] + ] +} +!! wikitext +{| +! id="h1" |edit-me!!1 +|- +! id="h2" |edit-me||2 +|- +| id="c1" |edit-me||3 +|- +| id="c2" |edit-me||4 +|- +| id="c3" |edit-me||p||q||r +|} +!! wikitext/edited +{| +! id="h1" |a +b +!1 +|- +! id="h2" |a +b +!2 +|- +| id="c1" |a +b +|3 +|- +| id="c2" |a +|4 +|- +| id="c3" |a +|p||q||r +|} +!! end + !! test HTML id attribute with Parsoid-like element ids should not be serialized to wikitext !! options diff --git a/tests/phan/bin/phan b/tests/phan/bin/phan new file mode 100755 index 0000000000..5d42cf5914 --- /dev/null +++ b/tests/phan/bin/phan @@ -0,0 +1,77 @@ +#!/bin/bash + +# mediawiki-vagrant installs dont have realpath by default +if ! which realpath > /dev/null; then + realpath() { + php -r "echo realpath('$*');" + } +fi + +# Note that this isn't loaded in via composer because then composer can +# only be run with php7.0 +if [ ! -f "$PHAN" ]; then + echo "The environment variable PHAN must point to the 'phan' file" + echo "in a checkout of https://github.com/etsy/phan.git" + exit 1 +fi + +if [ -z "$MW_INSTALL_PATH" ]; then + # Figure out where mediawiki is based on the location of this script + pushd "$(dirname "$0")" > /dev/null + export MW_INSTALL_PATH="$(git rev-parse --show-toplevel)" + popd >/dev/null +fi + +# If the first argument doesn't start with a -, then it's a path +# to another project (extension, skin, etc.) to analyze +if [[ "$1" != "-"* ]]; then + cd $1 + shift +else + cd "$(dirname "$0")" +fi + +# Root directory of project +export ROOT="$(git rev-parse --show-toplevel)" + +# Go to the root of this git repo +cd "$ROOT" + +export CONFIG_FILE="$ROOT/tests/phan/config.php" +if [ ! -f "$CONFIG_FILE" ]; then + echo "Could not find a phan config file to apply in" + echo "$CONFIG_FILE" + exit 1 +fi + +# Phan's issues directory +export ISSUES="${ROOT}/tests/phan/issues" +mkdir -p "$ISSUES" + +# Get the current hash of HEAD +export REV="$(git rev-parse HEAD)" + +# Destination for issues found +export RUN="${ISSUES}/issues-${REV}" + + +# Run the analysis, emitting output to the +# issues file. +php7.0 $PHAN \ + --project-root-directory "$ROOT" \ + --config-file "$CONFIG_FILE" \ + --output "php://stdout" \ + "${@}" \ + | php "$MW_INSTALL_PATH/tests/phan/bin/postprocess-phan.php" "${@}" \ + > $RUN + +EXIT_CODE="$?" + +# Re-link the latest file +rm -f "${ISSUES}/latest" +ln -s "${RUN}" "${ISSUES}/latest" + +# Output any issues that were found +cat "${RUN}" + +exit $EXIT_CODE diff --git a/tests/phan/bin/postprocess-phan.php b/tests/phan/bin/postprocess-phan.php new file mode 100644 index 0000000000..3e80598677 --- /dev/null +++ b/tests/phan/bin/postprocess-phan.php @@ -0,0 +1,146 @@ + 0 && preg_match( + "|/\*\* @suppress {$type} |", + $source[$lineno - 1] + ); + } +} + +class TextSuppressor extends Suppressor { + /** + * @param string $input + * @return bool do errors remain + */ + public function suppress( $input ) { + $hasErrors = false; + $errors = []; + foreach ( explode( "\n", $input ) as $error ) { + if ( empty( $error ) ) { + continue; + } + if ( !preg_match( '/^(.*):(\d+) (Phan\w+) (.*)$/', $error, $matches ) ) { + echo "Failed to parse line: $error\n"; + continue; + } + list( $source, $file, $lineno, $type, $message ) = $matches; + $errors[$file][] = [ + 'orig' => $error, + // convert from 1 indexed to 0 indexed + 'lineno' => $lineno - 1, + 'type' => $type, + ]; + } + foreach ( $errors as $file => $fileErrors ) { + $source = file( $file ); + foreach ( $fileErrors as $error ) { + if ( !$this->isSuppressed( $source, $error['type'], $error['lineno'] ) ) { + echo $error['orig'], "\n"; + $hasErrors = true; + } + } + } + + return $hasErrors; + } +} + +class CheckStyleSuppressor extends Suppressor { + /** + * @param string $input + * @return bool True do errors remain + */ + public function suppress( $input ) { + $dom = new DOMDocument(); + $dom->loadXML( $input ); + $hasErrors = false; + // DOMNodeList's are "live", convert to an array so it works as expected + $files = []; + foreach ( $dom->getElementsByTagName( 'file' ) as $file ) { + $files[] = $file; + } + foreach ( $files as $file ) { + $errors = []; + foreach ( $file->getElementsByTagName( 'error' ) as $error ) { + $errors[] = $error; + } + $source = file( $file->getAttribute( 'name' ) ); + $fileHasErrors = false; + foreach ( $errors as $error ) { + $lineno = $error->getAttribute( 'line' ) - 1; + $type = $error->getAttribute( 'source' ); + if ( $this->isSuppressed( $source, $type, $lineno ) ) { + $error->parentNode->removeChild( $error ); + } else { + $fileHasErrors = true; + $hasErrors = true; + } + } + if ( !$fileHasErrors ) { + $file->parentNode->removeChild( $file ); + } + } + echo $dom->saveXML(); + + return $hasErrors; + } +} + +class NoopSuppressor extends Suppressor { + private $mode; + + public function __construct( $mode ) { + $this->mode = $mode; + } + public function suppress( $input ) { + echo "Unsupported output mode: {$this->mode}\n$input"; + return true; + } +} + +$opt = getopt( "m:", [ "output-mode:" ] ); +// if provided multiple times getopt returns an array +if ( isset( $opt['m'] ) ) { + $mode = $opt['m']; +} elseif ( isset( $mode['output-mode'] ) ) { + $mode = $opt['output-mode']; +} else { + $mode = 'text'; +} +if ( is_array( $mode ) ) { + // If an option is passed multiple times getopt returns an + // array. Just take the last one. + $mode = end( $mode ); +} + +switch ( $mode ) { +case 'text': + $suppressor = new TextSuppressor(); + break; +case 'checkstyle': + $suppressor = new CheckStyleSuppressor(); + break; +default: + $suppressor = new NoopSuppressor( $mode ); +} + +$input = file_get_contents( 'php://stdin' ); +$hasErrors = $suppressor->suppress( $input ); + +if ( $hasErrors ) { + exit( 1 ); +} diff --git a/tests/phan/config.php b/tests/phan/config.php new file mode 100644 index 0000000000..0cf354c58e --- /dev/null +++ b/tests/phan/config.php @@ -0,0 +1,462 @@ + [ + 'maintenance/7zip.inc', + 'maintenance/backupPrefetch.inc', + 'maintenance/commandLine.inc', + 'maintenance/sqlite.inc', + 'maintenance/userOptions.inc', + 'maintenance/backup.inc', + 'maintenance/cleanupTable.inc', + 'maintenance/importImages.inc', + 'maintenance/userDupes.inc', + 'maintenance/language/checkLanguage.inc', + 'maintenance/language/languages.inc', + ], + + /** + * A list of directories that should be parsed for class and + * method information. After excluding the directories + * defined in exclude_analysis_directory_list, the remaining + * files will be statically analyzed for errors. + * + * Thus, both first-party and third-party code being used by + * your application should be included in this list. + */ + 'directory_list' => [ + 'includes/', + 'languages/', + 'maintenance/', + 'mw-config/', + 'resources/', + 'skins/', + 'vendor/', + 'tests/phan/stubs/', + ], + + /** + * A file list that defines files that will be excluded + * from parsing and analysis and will not be read at all. + * + * This is useful for excluding hopelessly unanalyzable + * files that can't be removed for whatever reason. + */ + 'exclude_file_list' => function_exists( 'xcache_get' ) ? [] : [ + // References xcache which probably isn't installed + 'includes/libs/objectcache/XCacheBagOStuff.php' + ], + + /** + * A list of directories holding code that we want + * to parse, but not analyze. Also works for individual + * files. + */ + "exclude_analysis_directory_list" => [ + 'vendor/', + 'tests/phan/stubs/', + // The referenced classes are not available in vendor, only when + // included from composer. + 'includes/composer/', + // Directly references classes that only exist in Translate extension + 'maintenance/language/', + // External class + 'includes/libs/jsminplus.php', + // separate repositories + 'skins/' + ], + + /** + * Backwards Compatibility Checking. This is slow + * and expensive, but you should consider running + * it before upgrading your version of PHP to a + * new version that has backward compatibility + * breaks. + */ + 'backward_compatibility_checks' => false, + + /** + * A set of fully qualified class-names for which + * a call to parent::__construct() is required + */ + 'parent_constructor_required' => [ + ], + + /** + * Run a quick version of checks that takes less + * time at the cost of not running as thorough + * an analysis. You should consider setting this + * to true only when you wish you had more issues + * to fix in your code base. + * + * In quick-mode the scanner doesn't rescan a function + * or a method's code block every time a call is seen. + * This means that the problem here won't be detected: + * + * ```php + * false, + + /** + * By default, Phan will not analyze all node types + * in order to save time. If this config is set to true, + * Phan will dig deeper into the AST tree and do an + * analysis on all nodes, possibly finding more issues. + * + * See \Phan\Analysis::shouldVisit for the set of skipped + * nodes. + */ + 'should_visit_all_nodes' => true, + + /** + * If enabled, check all methods that override a + * parent method to make sure its signature is + * compatible with the parent's. This check + * can add quite a bit of time to the analysis. + */ + 'analyze_signature_compatibility' => true, + + // Emit all issues. They are then supressed via + // suppress_issue_types, rather than a minimum + // severity. + "minimum_severity" => 0, + + /** + * If true, missing properties will be created when + * they are first seen. If false, we'll report an + * error message if there is an attempt to write + * to a class property that wasn't explicitly + * defined. + */ + 'allow_missing_properties' => false, + + /** + * Allow null to be cast as any type and for any + * type to be cast to null. Setting this to false + * will cut down on false positives. + */ + 'null_casts_as_any_type' => true, + + /** + * If enabled, scalars (int, float, bool, string, null) + * are treated as if they can cast to each other. + * + * MediaWiki is pretty lax and uses many scalar + * types interchangably. + */ + 'scalar_implicit_cast' => true, + + /** + * If true, seemingly undeclared variables in the global + * scope will be ignored. This is useful for projects + * with complicated cross-file globals that you have no + * hope of fixing. + */ + 'ignore_undeclared_variables_in_global_scope' => false, + + /** + * Set to true in order to attempt to detect dead + * (unreferenced) code. Keep in mind that the + * results will only be a guess given that classes, + * properties, constants and methods can be referenced + * as variables (like `$class->$property` or + * `$class->$method()`) in ways that we're unable + * to make sense of. + */ + 'dead_code_detection' => false, + + /** + * If true, the dead code detection rig will + * prefer false negatives (not report dead code) to + * false positives (report dead code that is not + * actually dead) which is to say that the graph of + * references will create too many edges rather than + * too few edges when guesses have to be made about + * what references what. + */ + 'dead_code_detection_prefer_false_negative' => true, + + /** + * If disabled, Phan will not read docblock type + * annotation comments (such as for @return, @param, + * @var, @suppress, @deprecated) and only rely on + * types expressed in code. + */ + 'read_type_annotations' => true, + + /** + * If a file path is given, the code base will be + * read from and written to the given location in + * order to attempt to save some work from being + * done. Only changed files will get analyzed if + * the file is read + */ + 'stored_state_file_path' => null, + + /** + * Set to true in order to ignore issue suppression. + * This is useful for testing the state of your code, but + * unlikely to be useful outside of that. + */ + 'disable_suppression' => false, + + /** + * If set to true, we'll dump the AST instead of + * analyzing files + */ + 'dump_ast' => false, + + /** + * If set to a string, we'll dump the fully qualified lowercase + * function and method signatures instead of analyzing files. + */ + 'dump_signatures_file' => null, + + /** + * If true (and if stored_state_file_path is set) we'll + * look at the list of files passed in and expand the list + * to include files that depend on the given files + */ + 'expand_file_list' => false, + + // Include a progress bar in the output + 'progress_bar' => false, + + /** + * The probability of actually emitting any progress + * bar update. Setting this to something very low + * is good for reducing network IO and filling up + * your terminal's buffer when running phan on a + * remote host. + */ + 'progress_bar_sample_rate' => 0.005, + + /** + * The number of processes to fork off during the analysis + * phase. + */ + 'processes' => 1, + + /** + * Add any issue types (such as 'PhanUndeclaredMethod') + * to this black-list to inhibit them from being reported. + */ + 'suppress_issue_types' => [ + // approximate error count: 8 + "PhanDeprecatedClass", + // approximate error count: 441 + "PhanDeprecatedFunction", + // approximate error count: 24 + "PhanDeprecatedProperty", + // approximate error count: 12 + "PhanParamReqAfterOpt", + // approximate error count: 748 + "PhanParamSignatureMismatch", + // approximate error count: 7 + "PhanParamSignatureMismatchInternal", + // approximate error count: 308 + "PhanParamTooMany", + // approximate error count: 3 + "PhanParamTooManyInternal", + // approximate error count: 1 + "PhanRedefineFunction", + // approximate error count: 1 + "PhanRedefineFunctionInternal", + // approximate error count: 2 + "PhanTraitParentReference", + // approximate error count: 4 + "PhanTypeComparisonFromArray", + // approximate error count: 3 + "PhanTypeInvalidRightOperand", + // approximate error count: 563 + "PhanTypeMismatchArgument", + // approximate error count: 39 + "PhanTypeMismatchArgumentInternal", + // approximate error count: 16 + "PhanTypeMismatchForeach", + // approximate error count: 63 + "PhanTypeMismatchProperty", + // approximate error count: 95 + "PhanTypeMismatchReturn", + // approximate error count: 11 + "PhanTypeMissingReturn", + // approximate error count: 5 + "PhanTypeNonVarPassByRef", + // approximate error count: 27 + "PhanUndeclaredConstant", + // approximate error count: 185 + "PhanUndeclaredMethod", + // approximate error count: 1342 + "PhanUndeclaredProperty", + // approximate error count: 9 + "PhanUndeclaredStaticMethod", + // approximate error count: 79 + "PhanUndeclaredVariable", + ], + + /** + * If empty, no filter against issues types will be applied. + * If this white-list is non-empty, only issues within the list + * will be emitted by Phan. + */ + 'whitelist_issue_types' => [ + // 'PhanAccessMethodPrivate', + // 'PhanAccessMethodProtected', + // 'PhanAccessNonStaticToStatic', + // 'PhanAccessPropertyPrivate', + // 'PhanAccessPropertyProtected', + // 'PhanAccessSignatureMismatch', + // 'PhanAccessSignatureMismatchInternal', + // 'PhanAccessStaticToNonStatic', + // 'PhanCompatibleExpressionPHP7', + // 'PhanCompatiblePHP7', + // 'PhanContextNotObject', + // 'PhanDeprecatedClass', + // 'PhanDeprecatedFunction', + // 'PhanDeprecatedProperty', + // 'PhanEmptyFile', + // 'PhanNonClassMethodCall', + // 'PhanNoopArray', + // 'PhanNoopClosure', + // 'PhanNoopConstant', + // 'PhanNoopProperty', + // 'PhanNoopVariable', + // 'PhanParamRedefined', + // 'PhanParamReqAfterOpt', + // 'PhanParamSignatureMismatch', + // 'PhanParamSignatureMismatchInternal', + // 'PhanParamSpecial1', + // 'PhanParamSpecial2', + // 'PhanParamSpecial3', + // 'PhanParamSpecial4', + // 'PhanParamTooFew', + // 'PhanParamTooFewInternal', + // 'PhanParamTooMany', + // 'PhanParamTooManyInternal', + // 'PhanParamTypeMismatch', + // 'PhanParentlessClass', + // 'PhanRedefineClass', + // 'PhanRedefineClassInternal', + // 'PhanRedefineFunction', + // 'PhanRedefineFunctionInternal', + // 'PhanStaticCallToNonStatic', + // 'PhanSyntaxError', + // 'PhanTraitParentReference', + // 'PhanTypeArrayOperator', + // 'PhanTypeArraySuspicious', + // 'PhanTypeComparisonFromArray', + // 'PhanTypeComparisonToArray', + // 'PhanTypeConversionFromArray', + // 'PhanTypeInstantiateAbstract', + // 'PhanTypeInstantiateInterface', + // 'PhanTypeInvalidLeftOperand', + // 'PhanTypeInvalidRightOperand', + // 'PhanTypeMismatchArgument', + // 'PhanTypeMismatchArgumentInternal', + // 'PhanTypeMismatchDefault', + // 'PhanTypeMismatchForeach', + // 'PhanTypeMismatchProperty', + // 'PhanTypeMismatchReturn', + // 'PhanTypeMissingReturn', + // 'PhanTypeNonVarPassByRef', + // 'PhanTypeParentConstructorCalled', + // 'PhanTypeVoidAssignment', + // 'PhanUnanalyzable', + // 'PhanUndeclaredClass', + // 'PhanUndeclaredClassCatch', + // 'PhanUndeclaredClassConstant', + // 'PhanUndeclaredClassInstanceof', + // 'PhanUndeclaredClassMethod', + // 'PhanUndeclaredClassReference', + // 'PhanUndeclaredConstant', + // 'PhanUndeclaredExtendedClass', + // 'PhanUndeclaredFunction', + // 'PhanUndeclaredInterface', + // 'PhanUndeclaredMethod', + // 'PhanUndeclaredProperty', + // 'PhanUndeclaredStaticMethod', + // 'PhanUndeclaredStaticProperty', + // 'PhanUndeclaredTrait', + // 'PhanUndeclaredTypeParameter', + // 'PhanUndeclaredTypeProperty', + // 'PhanUndeclaredVariable', + // 'PhanUnreferencedClass', + // 'PhanUnreferencedConstant', + // 'PhanUnreferencedMethod', + // 'PhanUnreferencedProperty', + // 'PhanVariableUseClause', + ], + + /** + * Override to hardcode existence and types of (non-builtin) globals in the global scope. + * Class names must be prefixed with '\\'. + * (E.g. ['_FOO' => '\\FooClass', 'page' => '\\PageClass', 'userId' => 'int']) + */ + 'globals_type_map' => [ + 'IP' => 'string', + ], + + // Emit issue messages with markdown formatting + 'markdown_issue_messages' => false, + + /** + * Enable or disable support for generic templated + * class types. + */ + 'generic_types_enabled' => true, + + // A list of plugin files to execute + 'plugins' => [ + ], +]; diff --git a/tests/phan/issues/.gitkeep b/tests/phan/issues/.gitkeep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/tests/phan/stubs/README b/tests/phan/stubs/README new file mode 100644 index 0000000000..c458ab58fe --- /dev/null +++ b/tests/phan/stubs/README @@ -0,0 +1,3 @@ +These stubs describe how code that is not available at analysis time should be +used. No implementations are necessary, just define the classes and their +methods and use phpdoc to describe what arguments are allowed. diff --git a/tests/phan/stubs/hhvm.php b/tests/phan/stubs/hhvm.php new file mode 100644 index 0000000000..8ffcdfb53b --- /dev/null +++ b/tests/phan/stubs/hhvm.php @@ -0,0 +1,27 @@ +mwGlobals as $key => $value ) { $GLOBALS[$key] = $value; } + foreach ( $this->mwGlobalsToUnset as $value ) { + unset( $GLOBALS[$value] ); + } $this->mwGlobals = []; + $this->mwGlobalsToUnset = []; $this->restoreLoggers(); if ( self::$serviceLocator && MediaWikiServices::getInstance() !== self::$serviceLocator ) { @@ -571,6 +582,10 @@ abstract class MediaWikiTestCase extends PHPUnit_Framework_TestCase { /** * Make sure MediaWikiTestCase extending classes have called their * parent setUp method + * + * With strict coverage activated in PHP_CodeCoverage, this test would be + * marked as risky without the following annotation (T152923). + * @coversNothing */ final public function testMediaWikiTestCaseParentSetupCalled() { $this->assertArrayHasKey( 'setUp', $this->called, @@ -684,8 +699,6 @@ abstract class MediaWikiTestCase extends PHPUnit_Framework_TestCase { * * @param array|string $globalKeys Key to the global variable, or an array of keys. * - * @throws Exception When trying to stash an unset global - * * @note To allow changes to global variables to take effect on global service instances, * call overrideMwServices(). * @@ -700,9 +713,13 @@ abstract class MediaWikiTestCase extends PHPUnit_Framework_TestCase { // NOTE: make sure we only save the global once or a second call to // setMwGlobals() on the same global would override the original // value. - if ( !array_key_exists( $globalKey, $this->mwGlobals ) ) { + if ( + !array_key_exists( $globalKey, $this->mwGlobals ) && + !array_key_exists( $globalKey, $this->mwGlobalsToUnset ) + ) { if ( !array_key_exists( $globalKey, $GLOBALS ) ) { - throw new Exception( "Global with key {$globalKey} doesn't exist and cant be stashed" ); + $this->mwGlobalsToUnset[$globalKey] = $globalKey; + continue; } // NOTE: we serialize then unserialize the value in case it is an object // this stops any objects being passed by reference. We could use clone @@ -1074,11 +1091,11 @@ abstract class MediaWikiTestCase extends PHPUnit_Framework_TestCase { * Clones all tables in the given database (whatever database that connection has * open), to versions with the test prefix. * - * @param Database $db Database to use + * @param IMaintainableDatabase $db Database to use * @param string $prefix Prefix to use for test tables * @return bool True if tables were cloned, false if only the prefix was changed */ - protected static function setupDatabaseWithTestPrefix( Database $db, $prefix ) { + protected static function setupDatabaseWithTestPrefix( IMaintainableDatabase $db, $prefix ) { $tablesCloned = self::listTables( $db ); $dbClone = new CloneDatabase( $db, $tablesCloned, $prefix ); $dbClone->useTemporaryTables( self::$useTemporaryTables ); @@ -1197,9 +1214,7 @@ abstract class MediaWikiTestCase extends PHPUnit_Framework_TestCase { list( $proto, $cluster ) = explode( '://', $url, 2 ); // Avoid getMaster() because setupDatabaseWithTestPrefix() // requires Database instead of plain DBConnRef/IDatabase - $lb = $externalStoreDB->getLoadBalancer( $cluster ); - $dbw = $lb->getConnection( DB_MASTER ); - $dbws[] = $dbw; + $dbws[] = $externalStoreDB->getMaster( $cluster ); } } @@ -1313,11 +1328,11 @@ abstract class MediaWikiTestCase extends PHPUnit_Framework_TestCase { /** * @since 1.18 * - * @param Database $db + * @param IMaintainableDatabase $db * * @return array */ - public static function listTables( Database $db ) { + public static function listTables( IMaintainableDatabase $db ) { $prefix = $db->tablePrefix(); $tables = $db->listTables( $prefix, __METHOD__ ); @@ -1365,6 +1380,8 @@ abstract class MediaWikiTestCase extends PHPUnit_Framework_TestCase { if ( isset( PHPUnitMaintClass::$additionalOptions[$offset] ) ) { return PHPUnitMaintClass::$additionalOptions[$offset]; } + + return null; } /** diff --git a/tests/phpunit/ResourceLoaderTestCase.php b/tests/phpunit/ResourceLoaderTestCase.php index 8eb1fd509a..68b91bf3a4 100644 --- a/tests/phpunit/ResourceLoaderTestCase.php +++ b/tests/phpunit/ResourceLoaderTestCase.php @@ -1,5 +1,6 @@ $options ]; + } + $options += [ + 'lang' => 'en', + 'dir' => 'ltr', + 'modules' => 'startup', + 'only' => 'scripts', + ]; + $resourceLoader = $rl ?: new ResourceLoader(); $request = new FauxRequest( [ - 'lang' => $lang, - 'modules' => 'startup', - 'only' => 'scripts', + 'lang' => $options['lang'], + 'modules' => $options['modules'], + 'only' => $options['only'], 'skin' => 'vector', 'target' => 'phpunit', ] ); @@ -27,7 +42,7 @@ abstract class ResourceLoaderTestCase extends MediaWikiTestCase { ->setConstructorArgs( [ $resourceLoader, $request ] ) ->setMethods( [ 'getDirection' ] ) ->getMock(); - $ctx->method( 'getDirection' )->willReturn( $dir ); + $ctx->method( 'getDirection' )->willReturn( $options['dir'] ); return $ctx; } @@ -140,7 +155,13 @@ class EmptyResourceLoader extends ResourceLoader { // and default registrations are done from ServiceWiring instead. public function __construct( Config $config = null, LoggerInterface $logger = null ) { $this->setLogger( $logger ?: new NullLogger() ); - $this->config = $config ?: ConfigFactory::getDefaultInstance()->makeConfig( 'main' ); + $this->config = $config ?: MediaWikiServices::getInstance()->getMainConfig(); + // Source "local" is required by StartupModule + $this->addSource( 'local', $this->config->get( 'LoadScript' ) ); $this->setMessageBlobStore( new MessageBlobStore( $this, $this->getLogger() ) ); } + + public function getErrors() { + return $this->errors; + } } diff --git a/tests/phpunit/data/localisationcache/ba.json b/tests/phpunit/data/localisationcache/ba.json new file mode 100644 index 0000000000..59b8912128 --- /dev/null +++ b/tests/phpunit/data/localisationcache/ba.json @@ -0,0 +1,3 @@ +{ + "present-ba": "ba" +} diff --git a/tests/phpunit/data/localisationcache/en.json b/tests/phpunit/data/localisationcache/en.json index 27600cdb2c..39cce86bc8 100644 --- a/tests/phpunit/data/localisationcache/en.json +++ b/tests/phpunit/data/localisationcache/en.json @@ -1,5 +1,5 @@ { - "present-uk": "en", + "present-ba": "en", "present-ru": "en", "present-en": "en" } diff --git a/tests/phpunit/data/localisationcache/ru.json b/tests/phpunit/data/localisationcache/ru.json index 79e1444bca..c9f89d38d6 100644 --- a/tests/phpunit/data/localisationcache/ru.json +++ b/tests/phpunit/data/localisationcache/ru.json @@ -1,4 +1,4 @@ { - "present-uk": "ru", + "present-ba": "ru", "present-ru": "ru" } diff --git a/tests/phpunit/data/localisationcache/uk.json b/tests/phpunit/data/localisationcache/uk.json deleted file mode 100644 index f63ce5d3f5..0000000000 --- a/tests/phpunit/data/localisationcache/uk.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "present-uk": "uk" -} diff --git a/tests/phpunit/includes/BlockTest.php b/tests/phpunit/includes/BlockTest.php index 9f386599eb..12b277e94f 100644 --- a/tests/phpunit/includes/BlockTest.php +++ b/tests/phpunit/includes/BlockTest.php @@ -409,4 +409,33 @@ class BlockTest extends MediaWikiLangTestCase { "Account creation should not be blocked by default" ); } + + public function testSystemBlocks() { + $blockOptions = [ + 'address' => 'UTBlockee', + 'reason' => 'test system block', + 'timestamp' => wfTimestampNow(), + 'expiry' => $this->db->getInfinity(), + 'byText' => 'MetaWikiUser', + 'systemBlock' => 'test', + 'enableAutoblock' => true, + ]; + $block = new Block( $blockOptions ); + + $this->assertSame( 'test', $block->getSystemBlockType() ); + + try { + $block->insert(); + $this->fail( 'Expected exception not thrown' ); + } catch ( MWException $ex ) { + $this->assertSame( 'Cannot insert a system block into the database', $ex->getMessage() ); + } + + try { + $block->doAutoblock( '192.0.2.2' ); + $this->fail( 'Expected exception not thrown' ); + } catch ( MWException $ex ) { + $this->assertSame( 'Cannot autoblock from a system block', $ex->getMessage() ); + } + } } diff --git a/tests/phpunit/includes/FormOptionsInitializationTest.php b/tests/phpunit/includes/FormOptionsInitializationTest.php index dcaf1f7957..0c853e0833 100644 --- a/tests/phpunit/includes/FormOptionsInitializationTest.php +++ b/tests/phpunit/includes/FormOptionsInitializationTest.php @@ -23,8 +23,6 @@ class FormOptionsExposed extends FormOptions { * Test class for FormOptions initialization * Ensure the FormOptions::add() does what we want it to do. * - * Generated by PHPUnit on 2011-02-28 at 20:46:27. - * * Copyright Â© 2011, Antoine Musso * * @author Antoine Musso diff --git a/tests/phpunit/includes/FormOptionsTest.php b/tests/phpunit/includes/FormOptionsTest.php index e491d610c1..2ee8b9833b 100644 --- a/tests/phpunit/includes/FormOptionsTest.php +++ b/tests/phpunit/includes/FormOptionsTest.php @@ -10,7 +10,6 @@ /** * Test class for FormOptions methods. - * Generated by PHPUnit on 2011-02-28 at 20:46:27. * * Copyright Â© 2011, Antoine Musso * diff --git a/tests/phpunit/includes/GitInfoTest.php b/tests/phpunit/includes/GitInfoTest.php index 9f4a01c9d8..89416f2ff2 100644 --- a/tests/phpunit/includes/GitInfoTest.php +++ b/tests/phpunit/includes/GitInfoTest.php @@ -18,7 +18,6 @@ class GitInfoTest extends MediaWikiTestCase { $this->assertEquals( 'master', $gitInfo->getCurrentBranch() ); $this->assertContains( '0123456789abcdef0123456789abcdef01234567', $gitInfo->getHeadViewUrl() ); - } public function testValidJsonData() { diff --git a/tests/phpunit/includes/GlobalFunctions/wfUrlencodeTest.php b/tests/phpunit/includes/GlobalFunctions/wfUrlencodeTest.php index cbe2e2f533..09c1040b2f 100644 --- a/tests/phpunit/includes/GlobalFunctions/wfUrlencodeTest.php +++ b/tests/phpunit/includes/GlobalFunctions/wfUrlencodeTest.php @@ -28,7 +28,6 @@ class WfUrlencodeTest extends MediaWikiTestCase { /** * Internal helper that actually run the test. * Called by the public methods testEncodingUrlWith...() - * */ private function verifyEncodingFor( $server, $input, $expectations ) { $expected = $this->extractExpect( $server, $expectations ); diff --git a/tests/phpunit/includes/HtmlTest.php b/tests/phpunit/includes/HtmlTest.php index bc5096639b..e2ee193416 100644 --- a/tests/phpunit/includes/HtmlTest.php +++ b/tests/phpunit/includes/HtmlTest.php @@ -92,7 +92,6 @@ class HtmlTest extends MediaWikiTestCase { * @covers Html::expandAttributes */ public function testExpandAttributesSkipsNullAndFalse() { - # ## EMPTY ######## $this->assertEmpty( Html::expandAttributes( [ 'foo' => null ] ), @@ -190,7 +189,6 @@ class HtmlTest extends MediaWikiTestCase { Html::expandAttributes( [ 'zero' => 0 ] ), 'Number 0 value needs no quotes' ); - } /** @@ -447,7 +445,7 @@ class HtmlTest extends MediaWikiTestCase { /** * List of input element types values introduced by HTML5 - * Full list at http://www.w3.org/TR/html-markup/input.html + * Full list at https://www.w3.org/TR/html-markup/input.html */ public static function provideHtml5InputTypes() { $types = [ diff --git a/tests/phpunit/includes/HttpTest.php b/tests/phpunit/includes/HttpTest.php deleted file mode 100644 index ae0b4bee8b..0000000000 --- a/tests/phpunit/includes/HttpTest.php +++ /dev/null @@ -1,534 +0,0 @@ -assertEquals( $expected, $ok, $msg ); - } - - public static function cookieDomains() { - return [ - [ false, "org" ], - [ false, ".org" ], - [ true, "wikipedia.org" ], - [ true, ".wikipedia.org" ], - [ false, "co.uk" ], - [ false, ".co.uk" ], - [ false, "gov.uk" ], - [ false, ".gov.uk" ], - [ true, "supermarket.uk" ], - [ false, "uk" ], - [ false, ".uk" ], - [ false, "127.0.0." ], - [ false, "127." ], - [ false, "127.0.0.1." ], - [ true, "127.0.0.1" ], - [ false, "333.0.0.1" ], - [ true, "example.com" ], - [ false, "example.com." ], - [ true, ".example.com" ], - - [ true, ".example.com", "www.example.com" ], - [ false, "example.com", "www.example.com" ], - [ true, "127.0.0.1", "127.0.0.1" ], - [ false, "127.0.0.1", "localhost" ], - ]; - } - - /** - * Test Http::isValidURI() - * @bug 27854 : Http::isValidURI is too lax - * @dataProvider provideURI - * @covers Http::isValidURI - */ - public function testIsValidUri( $expect, $URI, $message = '' ) { - $this->assertEquals( - $expect, - (bool)Http::isValidURI( $URI ), - $message - ); - } - - /** - * @covers Http::getProxy - */ - public function testGetProxy() { - $this->setMwGlobals( 'wgHTTPProxy', 'proxy.domain.tld' ); - $this->assertEquals( - 'proxy.domain.tld', - Http::getProxy() - ); - } - - /** - * Feeds URI to test a long regular expression in Http::isValidURI - */ - public static function provideURI() { - /** Format: 'boolean expectation', 'URI to test', 'Optional message' */ - return [ - [ false, 'Â¿non sens before!! http://a', 'Allow anything before URI' ], - - # (http|https) - only two schemes allowed - [ true, 'http://www.example.org/' ], - [ true, 'https://www.example.org/' ], - [ true, 'http://www.example.org', 'URI without directory' ], - [ true, 'http://a', 'Short name' ], - [ true, 'http://Ã©toile', 'Allow UTF-8 in hostname' ], # 'Ã©toile' is french for 'star' - [ false, '\\host\directory', 'CIFS share' ], - [ false, 'gopher://host/dir', 'Reject gopher scheme' ], - [ false, 'telnet://host', 'Reject telnet scheme' ], - - # :\/\/ - double slashes - [ false, 'http//example.org', 'Reject missing colon in protocol' ], - [ false, 'http:/example.org', 'Reject missing slash in protocol' ], - [ false, 'http:example.org', 'Must have two slashes' ], - # Following fail since hostname can be made of anything - [ false, 'http:///example.org', 'Must have exactly two slashes, not three' ], - - # (\w+:{0,1}\w*@)? - optional user:pass - [ true, 'http://user@host', 'Username provided' ], - [ true, 'http://user:@host', 'Username provided, no password' ], - [ true, 'http://user:pass@host', 'Username and password provided' ], - - # (\S+) - host part is made of anything not whitespaces - // commented these out in order to remove @group Broken - // @todo are these valid tests? if so, fix Http::isValidURI so it can handle them - // [ false, 'http://!"Ã¨Ã¨Ã¨Â¿Â¿Â¿~~\'', 'hostname is made of any non whitespace' ], - // [ false, 'http://exam:ple.org/', 'hostname can not use colons!' ], - - # (:[0-9]+)? - port number - [ true, 'http://example.org:80/' ], - [ true, 'https://example.org:80/' ], - [ true, 'http://example.org:443/' ], - [ true, 'https://example.org:443/' ], - - # Part after the hostname is / or / with something else - [ true, 'http://example/#' ], - [ true, 'http://example/!' ], - [ true, 'http://example/:' ], - [ true, 'http://example/.' ], - [ true, 'http://example/?' ], - [ true, 'http://example/+' ], - [ true, 'http://example/=' ], - [ true, 'http://example/&' ], - [ true, 'http://example/%' ], - [ true, 'http://example/@' ], - [ true, 'http://example/-' ], - [ true, 'http://example//' ], - [ true, 'http://example/&' ], - - # Fragment - [ true, 'http://exam#ple.org', ], # This one is valid, really! - [ true, 'http://example.org:80#anchor' ], - [ true, 'http://example.org/?id#anchor' ], - [ true, 'http://example.org/?#anchor' ], - - [ false, 'http://a Â¿non !!sens after', 'Allow anything after URI' ], - ]; - } - - /** - * Warning: - * - * These tests are for code that makes use of an artifact of how CURL - * handles header reporting on redirect pages, and will need to be - * rewritten when bug 29232 is taken care of (high-level handling of - * HTTP redirects). - */ - public function testRelativeRedirections() { - $h = MWHttpRequestTester::factory( 'http://oldsite/file.ext', [], __METHOD__ ); - - # Forge a Location header - $h->setRespHeaders( 'location', [ - 'http://newsite/file.ext', - '/newfile.ext', - ] - ); - # Verify we correctly fix the Location - $this->assertEquals( - 'http://newsite/newfile.ext', - $h->getFinalUrl(), - "Relative file path Location: interpreted as full URL" - ); - - $h->setRespHeaders( 'location', [ - 'https://oldsite/file.ext' - ] - ); - $this->assertEquals( - 'https://oldsite/file.ext', - $h->getFinalUrl(), - "Location to the HTTPS version of the site" - ); - - $h->setRespHeaders( 'location', [ - '/anotherfile.ext', - 'http://anotherfile/hoster.ext', - 'https://anotherfile/hoster.ext' - ] - ); - $this->assertEquals( - 'https://anotherfile/hoster.ext', - $h->getFinalUrl( "Relative file path Location: should keep the latest host and scheme!" ) - ); - } - - /** - * Constant values are from PHP 5.3.28 using cURL 7.24.0 - * @see http://php.net/manual/en/curl.constants.php - * - * All constant values are present so that developers donât need to remember - * to add them if added at a later date. The commented out constants were - * not found anywhere in the MediaWiki core code. - * - * Commented out constants that were not available in: - * HipHop VM 3.3.0 (rel) - * Compiler: heads/master-0-g08810d920dfff59e0774cf2d651f92f13a637175 - * Repo schema: 3214fc2c684a4520485f715ee45f33f2182324b1 - * Extension API: 20140829 - * - * Commented out constants that were removed in PHP 5.6.0 - * - * @covers CurlHttpRequest::execute - */ - public function provideCurlConstants() { - return [ - [ 'CURLAUTH_ANY' ], - [ 'CURLAUTH_ANYSAFE' ], - [ 'CURLAUTH_BASIC' ], - [ 'CURLAUTH_DIGEST' ], - [ 'CURLAUTH_GSSNEGOTIATE' ], - [ 'CURLAUTH_NTLM' ], - // [ 'CURLCLOSEPOLICY_CALLBACK' ], // removed in PHP 5.6.0 - // [ 'CURLCLOSEPOLICY_LEAST_RECENTLY_USED' ], // removed in PHP 5.6.0 - // [ 'CURLCLOSEPOLICY_LEAST_TRAFFIC' ], // removed in PHP 5.6.0 - // [ 'CURLCLOSEPOLICY_OLDEST' ], // removed in PHP 5.6.0 - // [ 'CURLCLOSEPOLICY_SLOWEST' ], // removed in PHP 5.6.0 - [ 'CURLE_ABORTED_BY_CALLBACK' ], - [ 'CURLE_BAD_CALLING_ORDER' ], - [ 'CURLE_BAD_CONTENT_ENCODING' ], - [ 'CURLE_BAD_FUNCTION_ARGUMENT' ], - [ 'CURLE_BAD_PASSWORD_ENTERED' ], - [ 'CURLE_COULDNT_CONNECT' ], - [ 'CURLE_COULDNT_RESOLVE_HOST' ], - [ 'CURLE_COULDNT_RESOLVE_PROXY' ], - [ 'CURLE_FAILED_INIT' ], - [ 'CURLE_FILESIZE_EXCEEDED' ], - [ 'CURLE_FILE_COULDNT_READ_FILE' ], - [ 'CURLE_FTP_ACCESS_DENIED' ], - [ 'CURLE_FTP_BAD_DOWNLOAD_RESUME' ], - [ 'CURLE_FTP_CANT_GET_HOST' ], - [ 'CURLE_FTP_CANT_RECONNECT' ], - [ 'CURLE_FTP_COULDNT_GET_SIZE' ], - [ 'CURLE_FTP_COULDNT_RETR_FILE' ], - [ 'CURLE_FTP_COULDNT_SET_ASCII' ], - [ 'CURLE_FTP_COULDNT_SET_BINARY' ], - [ 'CURLE_FTP_COULDNT_STOR_FILE' ], - [ 'CURLE_FTP_COULDNT_USE_REST' ], - [ 'CURLE_FTP_PORT_FAILED' ], - [ 'CURLE_FTP_QUOTE_ERROR' ], - [ 'CURLE_FTP_SSL_FAILED' ], - [ 'CURLE_FTP_USER_PASSWORD_INCORRECT' ], - [ 'CURLE_FTP_WEIRD_227_FORMAT' ], - [ 'CURLE_FTP_WEIRD_PASS_REPLY' ], - [ 'CURLE_FTP_WEIRD_PASV_REPLY' ], - [ 'CURLE_FTP_WEIRD_SERVER_REPLY' ], - [ 'CURLE_FTP_WEIRD_USER_REPLY' ], - [ 'CURLE_FTP_WRITE_ERROR' ], - [ 'CURLE_FUNCTION_NOT_FOUND' ], - [ 'CURLE_GOT_NOTHING' ], - [ 'CURLE_HTTP_NOT_FOUND' ], - [ 'CURLE_HTTP_PORT_FAILED' ], - [ 'CURLE_HTTP_POST_ERROR' ], - [ 'CURLE_HTTP_RANGE_ERROR' ], - [ 'CURLE_LDAP_CANNOT_BIND' ], - [ 'CURLE_LDAP_INVALID_URL' ], - [ 'CURLE_LDAP_SEARCH_FAILED' ], - [ 'CURLE_LIBRARY_NOT_FOUND' ], - [ 'CURLE_MALFORMAT_USER' ], - [ 'CURLE_OBSOLETE' ], - [ 'CURLE_OK' ], - [ 'CURLE_OPERATION_TIMEOUTED' ], - [ 'CURLE_OUT_OF_MEMORY' ], - [ 'CURLE_PARTIAL_FILE' ], - [ 'CURLE_READ_ERROR' ], - [ 'CURLE_RECV_ERROR' ], - [ 'CURLE_SEND_ERROR' ], - [ 'CURLE_SHARE_IN_USE' ], - // [ 'CURLE_SSH' ], // not present in HHVM 3.3.0-dev - [ 'CURLE_SSL_CACERT' ], - [ 'CURLE_SSL_CERTPROBLEM' ], - [ 'CURLE_SSL_CIPHER' ], - [ 'CURLE_SSL_CONNECT_ERROR' ], - [ 'CURLE_SSL_ENGINE_NOTFOUND' ], - [ 'CURLE_SSL_ENGINE_SETFAILED' ], - [ 'CURLE_SSL_PEER_CERTIFICATE' ], - [ 'CURLE_TELNET_OPTION_SYNTAX' ], - [ 'CURLE_TOO_MANY_REDIRECTS' ], - [ 'CURLE_UNKNOWN_TELNET_OPTION' ], - [ 'CURLE_UNSUPPORTED_PROTOCOL' ], - [ 'CURLE_URL_MALFORMAT' ], - [ 'CURLE_URL_MALFORMAT_USER' ], - [ 'CURLE_WRITE_ERROR' ], - [ 'CURLFTPAUTH_DEFAULT' ], - [ 'CURLFTPAUTH_SSL' ], - [ 'CURLFTPAUTH_TLS' ], - // [ 'CURLFTPMETHOD_MULTICWD' ], // not present in HHVM 3.3.0-dev - // [ 'CURLFTPMETHOD_NOCWD' ], // not present in HHVM 3.3.0-dev - // [ 'CURLFTPMETHOD_SINGLECWD' ], // not present in HHVM 3.3.0-dev - [ 'CURLFTPSSL_ALL' ], - [ 'CURLFTPSSL_CONTROL' ], - [ 'CURLFTPSSL_NONE' ], - [ 'CURLFTPSSL_TRY' ], - // [ 'CURLINFO_CERTINFO' ], // not present in HHVM 3.3.0-dev - [ 'CURLINFO_CONNECT_TIME' ], - [ 'CURLINFO_CONTENT_LENGTH_DOWNLOAD' ], - [ 'CURLINFO_CONTENT_LENGTH_UPLOAD' ], - [ 'CURLINFO_CONTENT_TYPE' ], - [ 'CURLINFO_EFFECTIVE_URL' ], - [ 'CURLINFO_FILETIME' ], - [ 'CURLINFO_HEADER_OUT' ], - [ 'CURLINFO_HEADER_SIZE' ], - [ 'CURLINFO_HTTP_CODE' ], - [ 'CURLINFO_NAMELOOKUP_TIME' ], - [ 'CURLINFO_PRETRANSFER_TIME' ], - [ 'CURLINFO_PRIVATE' ], - [ 'CURLINFO_REDIRECT_COUNT' ], - [ 'CURLINFO_REDIRECT_TIME' ], - // [ 'CURLINFO_REDIRECT_URL' ], // not present in HHVM 3.3.0-dev - [ 'CURLINFO_REQUEST_SIZE' ], - [ 'CURLINFO_SIZE_DOWNLOAD' ], - [ 'CURLINFO_SIZE_UPLOAD' ], - [ 'CURLINFO_SPEED_DOWNLOAD' ], - [ 'CURLINFO_SPEED_UPLOAD' ], - [ 'CURLINFO_SSL_VERIFYRESULT' ], - [ 'CURLINFO_STARTTRANSFER_TIME' ], - [ 'CURLINFO_TOTAL_TIME' ], - [ 'CURLMSG_DONE' ], - [ 'CURLM_BAD_EASY_HANDLE' ], - [ 'CURLM_BAD_HANDLE' ], - [ 'CURLM_CALL_MULTI_PERFORM' ], - [ 'CURLM_INTERNAL_ERROR' ], - [ 'CURLM_OK' ], - [ 'CURLM_OUT_OF_MEMORY' ], - [ 'CURLOPT_AUTOREFERER' ], - [ 'CURLOPT_BINARYTRANSFER' ], - [ 'CURLOPT_BUFFERSIZE' ], - [ 'CURLOPT_CAINFO' ], - [ 'CURLOPT_CAPATH' ], - // [ 'CURLOPT_CERTINFO' ], // not present in HHVM 3.3.0-dev - // [ 'CURLOPT_CLOSEPOLICY' ], // removed in PHP 5.6.0 - [ 'CURLOPT_CONNECTTIMEOUT' ], - [ 'CURLOPT_CONNECTTIMEOUT_MS' ], - [ 'CURLOPT_COOKIE' ], - [ 'CURLOPT_COOKIEFILE' ], - [ 'CURLOPT_COOKIEJAR' ], - [ 'CURLOPT_COOKIESESSION' ], - [ 'CURLOPT_CRLF' ], - [ 'CURLOPT_CUSTOMREQUEST' ], - [ 'CURLOPT_DNS_CACHE_TIMEOUT' ], - [ 'CURLOPT_DNS_USE_GLOBAL_CACHE' ], - [ 'CURLOPT_EGDSOCKET' ], - [ 'CURLOPT_ENCODING' ], - [ 'CURLOPT_FAILONERROR' ], - [ 'CURLOPT_FILE' ], - [ 'CURLOPT_FILETIME' ], - [ 'CURLOPT_FOLLOWLOCATION' ], - [ 'CURLOPT_FORBID_REUSE' ], - [ 'CURLOPT_FRESH_CONNECT' ], - [ 'CURLOPT_FTPAPPEND' ], - [ 'CURLOPT_FTPLISTONLY' ], - [ 'CURLOPT_FTPPORT' ], - [ 'CURLOPT_FTPSSLAUTH' ], - [ 'CURLOPT_FTP_CREATE_MISSING_DIRS' ], - // [ 'CURLOPT_FTP_FILEMETHOD' ], // not present in HHVM 3.3.0-dev - // [ 'CURLOPT_FTP_SKIP_PASV_IP' ], // not present in HHVM 3.3.0-dev - [ 'CURLOPT_FTP_SSL' ], - [ 'CURLOPT_FTP_USE_EPRT' ], - [ 'CURLOPT_FTP_USE_EPSV' ], - [ 'CURLOPT_HEADER' ], - [ 'CURLOPT_HEADERFUNCTION' ], - [ 'CURLOPT_HTTP200ALIASES' ], - [ 'CURLOPT_HTTPAUTH' ], - [ 'CURLOPT_HTTPGET' ], - [ 'CURLOPT_HTTPHEADER' ], - [ 'CURLOPT_HTTPPROXYTUNNEL' ], - [ 'CURLOPT_HTTP_VERSION' ], - [ 'CURLOPT_INFILE' ], - [ 'CURLOPT_INFILESIZE' ], - [ 'CURLOPT_INTERFACE' ], - [ 'CURLOPT_IPRESOLVE' ], - // [ 'CURLOPT_KEYPASSWD' ], // not present in HHVM 3.3.0-dev - [ 'CURLOPT_KRB4LEVEL' ], - [ 'CURLOPT_LOW_SPEED_LIMIT' ], - [ 'CURLOPT_LOW_SPEED_TIME' ], - [ 'CURLOPT_MAXCONNECTS' ], - [ 'CURLOPT_MAXREDIRS' ], - // [ 'CURLOPT_MAX_RECV_SPEED_LARGE' ], // not present in HHVM 3.3.0-dev - // [ 'CURLOPT_MAX_SEND_SPEED_LARGE' ], // not present in HHVM 3.3.0-dev - [ 'CURLOPT_NETRC' ], - [ 'CURLOPT_NOBODY' ], - [ 'CURLOPT_NOPROGRESS' ], - [ 'CURLOPT_NOSIGNAL' ], - [ 'CURLOPT_PORT' ], - [ 'CURLOPT_POST' ], - [ 'CURLOPT_POSTFIELDS' ], - [ 'CURLOPT_POSTQUOTE' ], - [ 'CURLOPT_POSTREDIR' ], - [ 'CURLOPT_PRIVATE' ], - [ 'CURLOPT_PROGRESSFUNCTION' ], - // [ 'CURLOPT_PROTOCOLS' ], // not present in HHVM 3.3.0-dev - [ 'CURLOPT_PROXY' ], - [ 'CURLOPT_PROXYAUTH' ], - [ 'CURLOPT_PROXYPORT' ], - [ 'CURLOPT_PROXYTYPE' ], - [ 'CURLOPT_PROXYUSERPWD' ], - [ 'CURLOPT_PUT' ], - [ 'CURLOPT_QUOTE' ], - [ 'CURLOPT_RANDOM_FILE' ], - [ 'CURLOPT_RANGE' ], - [ 'CURLOPT_READDATA' ], - [ 'CURLOPT_READFUNCTION' ], - // [ 'CURLOPT_REDIR_PROTOCOLS' ], // not present in HHVM 3.3.0-dev - [ 'CURLOPT_REFERER' ], - [ 'CURLOPT_RESUME_FROM' ], - [ 'CURLOPT_RETURNTRANSFER' ], - // [ 'CURLOPT_SSH_AUTH_TYPES' ], // not present in HHVM 3.3.0-dev - // [ 'CURLOPT_SSH_HOST_PUBLIC_KEY_MD5' ], // not present in HHVM 3.3.0-dev - // [ 'CURLOPT_SSH_PRIVATE_KEYFILE' ], // not present in HHVM 3.3.0-dev - // [ 'CURLOPT_SSH_PUBLIC_KEYFILE' ], // not present in HHVM 3.3.0-dev - [ 'CURLOPT_SSLCERT' ], - [ 'CURLOPT_SSLCERTPASSWD' ], - [ 'CURLOPT_SSLCERTTYPE' ], - [ 'CURLOPT_SSLENGINE' ], - [ 'CURLOPT_SSLENGINE_DEFAULT' ], - [ 'CURLOPT_SSLKEY' ], - [ 'CURLOPT_SSLKEYPASSWD' ], - [ 'CURLOPT_SSLKEYTYPE' ], - [ 'CURLOPT_SSLVERSION' ], - [ 'CURLOPT_SSL_CIPHER_LIST' ], - [ 'CURLOPT_SSL_VERIFYHOST' ], - [ 'CURLOPT_SSL_VERIFYPEER' ], - [ 'CURLOPT_STDERR' ], - [ 'CURLOPT_TCP_NODELAY' ], - [ 'CURLOPT_TIMECONDITION' ], - [ 'CURLOPT_TIMEOUT' ], - [ 'CURLOPT_TIMEOUT_MS' ], - [ 'CURLOPT_TIMEVALUE' ], - [ 'CURLOPT_TRANSFERTEXT' ], - [ 'CURLOPT_UNRESTRICTED_AUTH' ], - [ 'CURLOPT_UPLOAD' ], - [ 'CURLOPT_URL' ], - [ 'CURLOPT_USERAGENT' ], - [ 'CURLOPT_USERPWD' ], - [ 'CURLOPT_VERBOSE' ], - [ 'CURLOPT_WRITEFUNCTION' ], - [ 'CURLOPT_WRITEHEADER' ], - // [ 'CURLPROTO_ALL' ], // not present in HHVM 3.3.0-dev - // [ 'CURLPROTO_DICT' ], // not present in HHVM 3.3.0-dev - // [ 'CURLPROTO_FILE' ], // not present in HHVM 3.3.0-dev - // [ 'CURLPROTO_FTP' ], // not present in HHVM 3.3.0-dev - // [ 'CURLPROTO_FTPS' ], // not present in HHVM 3.3.0-dev - // [ 'CURLPROTO_HTTP' ], // not present in HHVM 3.3.0-dev - // [ 'CURLPROTO_HTTPS' ], // not present in HHVM 3.3.0-dev - // [ 'CURLPROTO_LDAP' ], // not present in HHVM 3.3.0-dev - // [ 'CURLPROTO_LDAPS' ], // not present in HHVM 3.3.0-dev - // [ 'CURLPROTO_SCP' ], // not present in HHVM 3.3.0-dev - // [ 'CURLPROTO_SFTP' ], // not present in HHVM 3.3.0-dev - // [ 'CURLPROTO_TELNET' ], // not present in HHVM 3.3.0-dev - // [ 'CURLPROTO_TFTP' ], // not present in HHVM 3.3.0-dev - [ 'CURLPROXY_HTTP' ], - // [ 'CURLPROXY_SOCKS4' ], // not present in HHVM 3.3.0-dev - [ 'CURLPROXY_SOCKS5' ], - // [ 'CURLSSH_AUTH_DEFAULT' ], // not present in HHVM 3.3.0-dev - // [ 'CURLSSH_AUTH_HOST' ], // not present in HHVM 3.3.0-dev - // [ 'CURLSSH_AUTH_KEYBOARD' ], // not present in HHVM 3.3.0-dev - // [ 'CURLSSH_AUTH_NONE' ], // not present in HHVM 3.3.0-dev - // [ 'CURLSSH_AUTH_PASSWORD' ], // not present in HHVM 3.3.0-dev - // [ 'CURLSSH_AUTH_PUBLICKEY' ], // not present in HHVM 3.3.0-dev - [ 'CURLVERSION_NOW' ], - [ 'CURL_HTTP_VERSION_1_0' ], - [ 'CURL_HTTP_VERSION_1_1' ], - [ 'CURL_HTTP_VERSION_NONE' ], - [ 'CURL_IPRESOLVE_V4' ], - [ 'CURL_IPRESOLVE_V6' ], - [ 'CURL_IPRESOLVE_WHATEVER' ], - [ 'CURL_NETRC_IGNORED' ], - [ 'CURL_NETRC_OPTIONAL' ], - [ 'CURL_NETRC_REQUIRED' ], - [ 'CURL_TIMECOND_IFMODSINCE' ], - [ 'CURL_TIMECOND_IFUNMODSINCE' ], - [ 'CURL_TIMECOND_LASTMOD' ], - [ 'CURL_VERSION_IPV6' ], - [ 'CURL_VERSION_KERBEROS4' ], - [ 'CURL_VERSION_LIBZ' ], - [ 'CURL_VERSION_SSL' ], - ]; - } - - /** - * Added this test based on an issue experienced with HHVM 3.3.0-dev - * where it did not define a cURL constant. - * - * @bug 70570 - * @dataProvider provideCurlConstants - */ - public function testCurlConstants( $value ) { - $this->assertTrue( defined( $value ), $value . ' not defined' ); - } -} - -/** - * Class to let us overwrite MWHttpRequest respHeaders variable - */ -class MWHttpRequestTester extends MWHttpRequest { - // function derived from the MWHttpRequest factory function but - // returns appropriate tester class here - public static function factory( $url, $options = null, $caller = __METHOD__ ) { - if ( !Http::$httpEngine ) { - Http::$httpEngine = function_exists( 'curl_init' ) ? 'curl' : 'php'; - } elseif ( Http::$httpEngine == 'curl' && !function_exists( 'curl_init' ) ) { - throw new MWException( __METHOD__ . ': curl (http://php.net/curl) is not installed, but' . - 'Http::$httpEngine is set to "curl"' ); - } - - switch ( Http::$httpEngine ) { - case 'curl': - return new CurlHttpRequestTester( $url, $options, $caller ); - case 'php': - if ( !wfIniGetBool( 'allow_url_fopen' ) ) { - throw new MWException( __METHOD__ . - ': allow_url_fopen needs to be enabled for pure PHP HTTP requests to work. ' - . 'If possible, curl should be used instead. See http://php.net/curl.' ); - } - - return new PhpHttpRequestTester( $url, $options, $caller ); - default: - } - } -} - -class CurlHttpRequestTester extends CurlHttpRequest { - function setRespHeaders( $name, $value ) { - $this->respHeaders[$name] = $value; - } -} - -class PhpHttpRequestTester extends PhpHttpRequest { - function setRespHeaders( $name, $value ) { - $this->respHeaders[$name] = $value; - } -} diff --git a/tests/phpunit/includes/LinkFilterTest.php b/tests/phpunit/includes/LinkFilterTest.php index 61b165a4dc..428b0129a0 100644 --- a/tests/phpunit/includes/LinkFilterTest.php +++ b/tests/phpunit/includes/LinkFilterTest.php @@ -6,7 +6,6 @@ class LinkFilterTest extends MediaWikiLangTestCase { protected function setUp() { - parent::setUp(); $this->setMwGlobals( 'wgUrlProtocols', [ @@ -26,7 +25,6 @@ class LinkFilterTest extends MediaWikiLangTestCase { 'mms://', '//', ] ); - } /** @@ -38,11 +36,9 @@ class LinkFilterTest extends MediaWikiLangTestCase { * @return string Regex */ function createRegexFromLIKE( $like ) { - $regex = '!^'; foreach ( $like as $item ) { - if ( $item instanceof LikeMatch ) { if ( $item->toString() == '%' ) { $regex .= '.*'; @@ -58,7 +54,6 @@ class LinkFilterTest extends MediaWikiLangTestCase { $regex .= '$!'; return $regex; - } /** @@ -67,7 +62,6 @@ class LinkFilterTest extends MediaWikiLangTestCase { * @return array */ public static function provideValidPatterns() { - return [ // Protocol, Search pattern, URL which matches the pattern [ 'http://', '*.test.com', 'http://www.test.com' ], @@ -164,7 +158,6 @@ class LinkFilterTest extends MediaWikiLangTestCase { // [ '', 'https://*.wikimedia.org/r/#/q/status:open,n,z', // 'https://gerrit.wikimedia.org/XXX/r/#/q/status:open,n,z', false ], ]; - } /** @@ -181,7 +174,6 @@ class LinkFilterTest extends MediaWikiLangTestCase { * @param bool $shouldBeFound Should the URL be found? (defaults true) */ function testMakeLikeArrayWithValidPatterns( $protocol, $pattern, $url, $shouldBeFound = true ) { - $indexes = wfMakeUrlIndexes( $url ); $likeArray = LinkFilter::makeLikeArray( $pattern, $protocol ); @@ -211,7 +203,6 @@ class LinkFilterTest extends MediaWikiLangTestCase { "Search pattern '$protocol$pattern' should not find url '$url' \n$debugmsg" ); } - } /** @@ -220,7 +211,6 @@ class LinkFilterTest extends MediaWikiLangTestCase { * @return array */ public static function provideInvalidPatterns() { - return [ [ '' ], [ '*' ], @@ -240,7 +230,6 @@ class LinkFilterTest extends MediaWikiLangTestCase { [ 'test.com/*/index' ], [ 'test.com/dir/index?arg=*' ], ]; - } /** @@ -253,12 +242,10 @@ class LinkFilterTest extends MediaWikiLangTestCase { * @param string $pattern Invalid search pattern */ function testMakeLikeArrayWithInvalidPatterns( $pattern ) { - $this->assertFalse( LinkFilter::makeLikeArray( $pattern ), "'$pattern' is not a valid pattern and should be rejected" ); - } } diff --git a/tests/phpunit/includes/MWNamespaceTest.php b/tests/phpunit/includes/MWNamespaceTest.php index 24db44581e..092d57b3aa 100644 --- a/tests/phpunit/includes/MWNamespaceTest.php +++ b/tests/phpunit/includes/MWNamespaceTest.php @@ -7,10 +7,8 @@ /** * Test class for MWNamespace. - * Generated by PHPUnit on 2011-02-20 at 21:01:55. * @todo covers tags * @todo FIXME: this test file is a mess - * */ class MWNamespaceTest extends MediaWikiTestCase { protected function setUp() { diff --git a/tests/phpunit/includes/MediaWikiTest.php b/tests/phpunit/includes/MediaWikiTest.php index df92012e29..a8d1e33950 100644 --- a/tests/phpunit/includes/MediaWikiTest.php +++ b/tests/phpunit/includes/MediaWikiTest.php @@ -34,7 +34,7 @@ class MediaWikiTest extends MediaWikiTestCase { 'url' => 'http://example.org/w/index.php?title=Foo_Bar', 'query' => [ 'title' => 'Foo_Bar' ], 'title' => 'Foo_Bar', - 'redirect' => 'http://example.org/wiki/Foo_Bar', + 'redirect' => false, ], [ // View: Script path with implicit title from page id @@ -76,21 +76,21 @@ class MediaWikiTest extends MediaWikiTestCase { 'url' => 'http://example.org/w/?title=Foo_Bar', 'query' => [ 'title' => 'Foo_Bar' ], 'title' => 'Foo_Bar', - 'redirect' => 'http://example.org/wiki/Foo_Bar', + 'redirect' => false, ], [ // View: Root path with escaped title 'url' => 'http://example.org/?title=Foo_Bar', 'query' => [ 'title' => 'Foo_Bar' ], 'title' => 'Foo_Bar', - 'redirect' => 'http://example.org/wiki/Foo_Bar', + 'redirect' => false, ], [ // View: Canonical with redundant query 'url' => 'http://example.org/wiki/Foo_Bar?action=view', 'query' => [ 'action' => 'view' ], 'title' => 'Foo_Bar', - 'redirect' => 'http://example.org/wiki/Foo_Bar', + 'redirect' => false, ], [ // Edit: Canonical view url with action query @@ -104,7 +104,7 @@ class MediaWikiTest extends MediaWikiTestCase { 'url' => 'http://example.org/w/index.php?title=Foo_Bar&action=view', 'query' => [ 'title' => 'Foo_Bar', 'action' => 'view' ], 'title' => 'Foo_Bar', - 'redirect' => 'http://example.org/wiki/Foo_Bar', + 'redirect' => false, ], [ // Edit: Index with action query diff --git a/tests/phpunit/includes/MessageTest.php b/tests/phpunit/includes/MessageTest.php index 4c689abb04..2d45c2ebf5 100644 --- a/tests/phpunit/includes/MessageTest.php +++ b/tests/phpunit/includes/MessageTest.php @@ -18,8 +18,8 @@ class MessageTest extends MediaWikiLangTestCase { public function testConstructor( $expectedLang, $key, $params, $language ) { $message = new Message( $key, $params, $language ); - $this->assertEquals( $key, $message->getKey() ); - $this->assertEquals( $params, $message->getParams() ); + $this->assertSame( $key, $message->getKey() ); + $this->assertSame( $params, $message->getParams() ); $this->assertEquals( $expectedLang, $message->getLanguage() ); $messageSpecifier = $this->getMockForAbstractClass( 'MessageSpecifier' ); @@ -29,8 +29,8 @@ class MessageTest extends MediaWikiLangTestCase { ->method( 'getParams' )->will( $this->returnValue( $params ) ); $message = new Message( $messageSpecifier, [], $language ); - $this->assertEquals( $key, $message->getKey() ); - $this->assertEquals( $params, $message->getParams() ); + $this->assertSame( $key, $message->getKey() ); + $this->assertSame( $params, $message->getParams() ); $this->assertEquals( $expectedLang, $message->getLanguage() ); } @@ -51,6 +51,10 @@ class MessageTest extends MediaWikiLangTestCase { [], [], ], + [ + [], + [ [] ], + ], [ [ 'foo' ], [ 'foo' ], @@ -68,19 +72,37 @@ class MessageTest extends MediaWikiLangTestCase { [ [ 'baz', 'foo' ] ], ], [ - [ 'baz', 'foo' ], + [ Message::rawParam( 'baz' ) ], + [ Message::rawParam( 'baz' ) ], + ], + [ + [ Message::rawParam( 'baz' ), 'foo' ], + [ Message::rawParam( 'baz' ), 'foo' ], + ], + [ + [ Message::rawParam( 'baz' ) ], + [ [ Message::rawParam( 'baz' ) ] ], + ], + [ + [ Message::rawParam( 'baz' ), 'foo' ], + [ [ Message::rawParam( 'baz' ), 'foo' ] ], + ], + + // Test handling of erroneous input, to detect if it changes + [ + [ [ 'baz', 'foo' ], 'hhh' ], [ [ 'baz', 'foo' ], 'hhh' ], ], [ - [ 'baz', 'foo' ], + [ [ 'baz', 'foo' ], 'hhh', [ 'ahahahahha' ] ], [ [ 'baz', 'foo' ], 'hhh', [ 'ahahahahha' ] ], ], [ - [ 'baz', 'foo' ], + [ [ 'baz', 'foo' ], [ 'ahahahahha' ] ], [ [ 'baz', 'foo' ], [ 'ahahahahha' ] ], ], [ - [ 'baz' ], + [ [ 'baz' ], [ 'ahahahahha' ] ], [ [ 'baz' ], [ 'ahahahahha' ] ], ], ]; @@ -97,7 +119,7 @@ class MessageTest extends MediaWikiLangTestCase { $returned = call_user_func_array( [ $msg, 'params' ], $args ); $this->assertSame( $msg, $returned ); - $this->assertEquals( $expected, $msg->getParams() ); + $this->assertSame( $expected, $msg->getParams() ); } public static function provideConstructorLanguage() { @@ -165,8 +187,8 @@ class MessageTest extends MediaWikiLangTestCase { $msg = new Message( $key ); $this->assertContains( $msg->getKey(), $expected ); - $this->assertEquals( $expected, $msg->getKeysToTry() ); - $this->assertEquals( count( $expected ) > 1, $msg->isMultiKey() ); + $this->assertSame( $expected, $msg->getKeysToTry() ); + $this->assertSame( count( $expected ) > 1, $msg->isMultiKey() ); } /** @@ -190,13 +212,13 @@ class MessageTest extends MediaWikiLangTestCase { * @covers Message::__construct */ public function testWfMessageParams() { - $this->assertEquals( 'Return to $1.', wfMessage( 'returnto' )->text() ); - $this->assertEquals( 'Return to $1.', wfMessage( 'returnto', [] )->text() ); - $this->assertEquals( + $this->assertSame( 'Return to $1.', wfMessage( 'returnto' )->text() ); + $this->assertSame( 'Return to $1.', wfMessage( 'returnto', [] )->text() ); + $this->assertSame( 'You have foo (bar).', wfMessage( 'youhavenewmessages', 'foo', 'bar' )->text() ); - $this->assertEquals( + $this->assertSame( 'You have foo (bar).', wfMessage( 'youhavenewmessages', [ 'foo', 'bar' ] )->text() ); @@ -222,13 +244,13 @@ class MessageTest extends MediaWikiLangTestCase { * @covers Message::toString */ public function testToStringKey() { - $this->assertEquals( 'Main Page', wfMessage( 'mainpage' )->text() ); - $this->assertEquals( 'â§¼i-dont-exist-evarâ§½', wfMessage( 'i-dont-exist-evar' )->text() ); - $this->assertEquals( 'â§¼i<dont>exist-evarâ§½', wfMessage( 'iexist-evar' )->text() ); - $this->assertEquals( 'â§¼i-dont-exist-evarâ§½', wfMessage( 'i-dont-exist-evar' )->plain() ); - $this->assertEquals( 'â§¼i<dont>exist-evarâ§½', wfMessage( 'iexist-evar' )->plain() ); - $this->assertEquals( 'â§¼i-dont-exist-evarâ§½', wfMessage( 'i-dont-exist-evar' )->escaped() ); - $this->assertEquals( + $this->assertSame( 'Main Page', wfMessage( 'mainpage' )->text() ); + $this->assertSame( 'â§¼i-dont-exist-evarâ§½', wfMessage( 'i-dont-exist-evar' )->text() ); + $this->assertSame( 'â§¼i<dont>exist-evarâ§½', wfMessage( 'iexist-evar' )->text() ); + $this->assertSame( 'â§¼i-dont-exist-evarâ§½', wfMessage( 'i-dont-exist-evar' )->plain() ); + $this->assertSame( 'â§¼i<dont>exist-evarâ§½', wfMessage( 'iexist-evar' )->plain() ); + $this->assertSame( 'â§¼i-dont-exist-evarâ§½', wfMessage( 'i-dont-exist-evar' )->escaped() ); + $this->assertSame( 'â§¼i<dont>exist-evarâ§½', wfMessage( 'iexist-evar' )->escaped() ); @@ -236,11 +258,14 @@ class MessageTest extends MediaWikiLangTestCase { public static function provideToString() { return [ - [ 'mainpage', 'Main Page' ], - [ 'i-dont-exist-evar', 'â§¼i-dont-exist-evarâ§½' ], - [ 'i-dont-exist-evar', 'â§¼i-dont-exist-evarâ§½', 'escaped' ], - [ 'script>alert(1)alert(1)alert(1)alert(1)$format(); - $this->assertEquals( $expect, $msg->toString() ); - $this->assertEquals( $expect, $msg->__toString() ); + $this->assertSame( $expect, $msg->$format() ); + $this->assertSame( $expect, $msg->toString(), 'toString is unaffected by previous call' ); + $this->assertSame( $expectImplicit, $msg->__toString() ); + $this->assertSame( $expect, $msg->toString(), 'toString is unaffected by __toString' ); + } + + public static function provideToString_raw() { + return [ + [ 'foo', 'parse', 'foo', 'foo' ], + [ 'foo', 'escaped', '<span>foo</span>', + 'foo' ], + [ 'foo', 'plain', 'foo', 'foo' ], + [ '', 'parse', '<script>alert(1)</script>', + '<script>alert(1)</script>' ], + [ '', 'escaped', '<script>alert(1)</script>', + '<script>alert(1)</script>' ], + [ '', 'plain', '', + '<script>alert(1)</script>' ], + ]; + } + + /** + * @covers Message::toString + * @covers Message::__toString + * @dataProvider provideToString_raw + */ + public function testToString_raw( $message, $format, $expect, $expectImplicit ) { + // make the message behave like RawMessage and use the key as-is + $msg = $this->getMockBuilder( Message::class )->setMethods( [ 'fetchMessage' ] ) + ->disableOriginalConstructor() + ->getMock(); + $msg->expects( $this->any() )->method( 'fetchMessage' )->willReturn( $message ); + /** @var Message $msg */ + $this->assertSame( $expect, $msg->$format() ); + $this->assertSame( $expect, $msg->toString(), 'toString is unaffected by previous call' ); + $this->assertSame( $expectImplicit, $msg->__toString() ); + $this->assertSame( $expect, $msg->toString(), 'toString is unaffected by __toString' ); } /** * @covers Message::inLanguage */ public function testInLanguage() { - $this->assertEquals( 'Main Page', wfMessage( 'mainpage' )->inLanguage( 'en' )->text() ); - $this->assertEquals( 'ÐÐ°Ð³Ð»Ð°Ð²Ð½Ð°Ñ ÑÑÑÐ°Ð½Ð¸ÑÐ°', + $this->assertSame( 'Main Page', wfMessage( 'mainpage' )->inLanguage( 'en' )->text() ); + $this->assertSame( 'ÐÐ°Ð³Ð»Ð°Ð²Ð½Ð°Ñ ÑÑÑÐ°Ð½Ð¸ÑÐ°', wfMessage( 'mainpage' )->inLanguage( 'ru' )->text() ); // NOTE: make sure internal caching of the message text is reset appropriately $msg = wfMessage( 'mainpage' ); - $this->assertEquals( 'Main Page', $msg->inLanguage( Language::factory( 'en' ) )->text() ); - $this->assertEquals( + $this->assertSame( 'Main Page', $msg->inLanguage( Language::factory( 'en' ) )->text() ); + $this->assertSame( 'ÐÐ°Ð³Ð»Ð°Ð²Ð½Ð°Ñ ÑÑÑÐ°Ð½Ð¸ÑÐ°', $msg->inLanguage( Language::factory( 'ru' ) )->text() ); @@ -278,19 +337,19 @@ class MessageTest extends MediaWikiLangTestCase { * @covers Message::rawParams */ public function testRawParams() { - $this->assertEquals( + $this->assertSame( '(ÐÐ°Ð³Ð»Ð°Ð²Ð½Ð°Ñ ÑÑÑÐ°Ð½Ð¸ÑÐ°)', wfMessage( 'parentheses', 'ÐÐ°Ð³Ð»Ð°Ð²Ð½Ð°Ñ ÑÑÑÐ°Ð½Ð¸ÑÐ°' )->plain() ); - $this->assertEquals( + $this->assertSame( '(ÐÐ°Ð³Ð»Ð°Ð²Ð½Ð°Ñ ÑÑÑÐ°Ð½Ð¸ÑÐ° $1)', wfMessage( 'parentheses', 'ÐÐ°Ð³Ð»Ð°Ð²Ð½Ð°Ñ ÑÑÑÐ°Ð½Ð¸ÑÐ° $1' )->plain() ); - $this->assertEquals( + $this->assertSame( '(ÐÐ°Ð³Ð»Ð°Ð²Ð½Ð°Ñ ÑÑÑÐ°Ð½Ð¸ÑÐ°)', wfMessage( 'parentheses' )->rawParams( 'ÐÐ°Ð³Ð»Ð°Ð²Ð½Ð°Ñ ÑÑÑÐ°Ð½Ð¸ÑÐ°' )->plain() ); - $this->assertEquals( + $this->assertSame( '(ÐÐ°Ð³Ð»Ð°Ð²Ð½Ð°Ñ ÑÑÑÐ°Ð½Ð¸ÑÐ° $1)', wfMessage( 'parentheses' )->rawParams( 'ÐÐ°Ð³Ð»Ð°Ð²Ð½Ð°Ñ ÑÑÑÐ°Ð½Ð¸ÑÐ° $1' )->plain() ); @@ -302,8 +361,8 @@ class MessageTest extends MediaWikiLangTestCase { */ public function testRawMessage() { $msg = new RawMessage( 'example &' ); - $this->assertEquals( 'example &', $msg->plain() ); - $this->assertEquals( 'example &', $msg->escaped() ); + $this->assertSame( 'example &', $msg->plain() ); + $this->assertSame( 'example &', $msg->escaped() ); } /** @@ -315,7 +374,7 @@ class MessageTest extends MediaWikiLangTestCase { $msg = new RawMessage( '$1$2$3$4$5$6$7$8$9$10$11$12' ); // One less than above has placeholders $params = [ 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k' ]; - $this->assertEquals( + $this->assertSame( 'abcdefghijka2', $msg->params( $params )->plain(), 'Params > 9 are replaced correctly' @@ -323,7 +382,7 @@ class MessageTest extends MediaWikiLangTestCase { $msg = new RawMessage( 'Params$*' ); $params = [ 'ab', 'bc', 'cd' ]; - $this->assertEquals( + $this->assertSame( 'Params: ab, bc, cd', $msg->params( $params )->text() ); @@ -337,7 +396,7 @@ class MessageTest extends MediaWikiLangTestCase { $lang = Language::factory( 'en' ); $msg = new RawMessage( '$1' ); - $this->assertEquals( + $this->assertSame( $lang->formatNum( 123456.789 ), $msg->inLanguage( $lang )->numParams( 123456.789 )->plain(), 'numParams is handled correctly' @@ -352,7 +411,7 @@ class MessageTest extends MediaWikiLangTestCase { $lang = Language::factory( 'en' ); $msg = new RawMessage( '$1' ); - $this->assertEquals( + $this->assertSame( $lang->formatDuration( 1234 ), $msg->inLanguage( $lang )->durationParams( 1234 )->plain(), 'durationParams is handled correctly' @@ -369,7 +428,7 @@ class MessageTest extends MediaWikiLangTestCase { $lang = Language::factory( 'en' ); $msg = new RawMessage( '$1' ); - $this->assertEquals( + $this->assertSame( $lang->formatExpiry( wfTimestampNow() ), $msg->inLanguage( $lang )->expiryParams( wfTimestampNow() )->plain(), 'expiryParams is handled correctly' @@ -384,7 +443,7 @@ class MessageTest extends MediaWikiLangTestCase { $lang = Language::factory( 'en' ); $msg = new RawMessage( '$1' ); - $this->assertEquals( + $this->assertSame( $lang->formatTimePeriod( 1234 ), $msg->inLanguage( $lang )->timeperiodParams( 1234 )->plain(), 'timeperiodParams is handled correctly' @@ -399,7 +458,7 @@ class MessageTest extends MediaWikiLangTestCase { $lang = Language::factory( 'en' ); $msg = new RawMessage( '$1' ); - $this->assertEquals( + $this->assertSame( $lang->formatSize( 123456 ), $msg->inLanguage( $lang )->sizeParams( 123456 )->plain(), 'sizeParams is handled correctly' @@ -414,7 +473,7 @@ class MessageTest extends MediaWikiLangTestCase { $lang = Language::factory( 'en' ); $msg = new RawMessage( '$1' ); - $this->assertEquals( + $this->assertSame( $lang->formatBitrate( 123456 ), $msg->inLanguage( $lang )->bitrateParams( 123456 )->plain(), 'bitrateParams is handled correctly' @@ -468,13 +527,143 @@ class MessageTest extends MediaWikiLangTestCase { 'one $2', '

foo

[[Bar]] {{Baz}} <', ]; - $this->assertEquals( + $this->assertSame( $expect, $msg->inLanguage( $lang )->plaintextParams( $params )->$format(), "Fail formatting for $format" ); } + public static function provideListParam() { + $lang = Language::factory( 'de' ); + $msg1 = new Message( 'mainpage', [], $lang ); + $msg2 = new RawMessage( "''link''", [], $lang ); + + return [ + 'Simple comma list' => [ + [ 'a', 'b', 'c' ], + 'comma', + 'text', + 'a, b, c' + ], + + 'Simple semicolon list' => [ + [ 'a', 'b', 'c' ], + 'semicolon', + 'text', + 'a; b; c' + ], + + 'Simple pipe list' => [ + [ 'a', 'b', 'c' ], + 'pipe', + 'text', + 'a | b | c' + ], + + 'Simple text list' => [ + [ 'a', 'b', 'c' ], + 'text', + 'text', + 'a, b and c' + ], + + 'Empty list' => [ + [], + 'comma', + 'text', + '' + ], + + 'List with all "before" params, ->text()' => [ + [ "''link''", Message::numParam( 12345678 ) ], + 'semicolon', + 'text', + '\'\'link\'\'; 12,345,678' + ], + + 'List with all "before" params, ->parse()' => [ + [ "''link''", Message::numParam( 12345678 ) ], + 'semicolon', + 'parse', + 'link; 12,345,678' + ], + + 'List with all "after" params, ->text()' => [ + [ $msg1, $msg2, Message::rawParam( '[[foo]]' ) ], + 'semicolon', + 'text', + 'Main Page; \'\'link\'\'; [[foo]]' + ], + + 'List with all "after" params, ->parse()' => [ + [ $msg1, $msg2, Message::rawParam( '[[foo]]' ) ], + 'semicolon', + 'parse', + 'Main Page; link; [[foo]]' + ], + + 'List with both "before" and "after" params, ->text()' => [ + [ $msg1, $msg2, Message::rawParam( '[[foo]]' ), "''link''", Message::numParam( 12345678 ) ], + 'semicolon', + 'text', + 'Main Page; \'\'link\'\'; [[foo]]; \'\'link\'\'; 12,345,678' + ], + + 'List with both "before" and "after" params, ->parse()' => [ + [ $msg1, $msg2, Message::rawParam( '[[foo]]' ), "''link''", Message::numParam( 12345678 ) ], + 'semicolon', + 'parse', + 'Main Page; link; [[foo]]; link; 12,345,678' + ], + ]; + } + + /** + * @covers Message::listParam + * @covers Message::extractParam + * @covers Message::formatListParam + * @dataProvider provideListParam + */ + public function testListParam( $list, $type, $format, $expect ) { + $lang = Language::factory( 'en' ); + + $msg = new RawMessage( '$1' ); + $msg->params( [ Message::listParam( $list, $type ) ] ); + $this->assertEquals( + $expect, + $msg->inLanguage( $lang )->$format() + ); + } + + /** + * @covers Message::extractParam + */ + public function testMessageAsParam() { + $this->setMwGlobals( [ + 'wgScript' => '/wiki/index.php', + 'wgArticlePath' => '/wiki/$1', + ] ); + + $msg = new Message( 'returnto', [ + new Message( 'apihelp-link', [ + 'foo', new Message( 'mainpage', [], Language::factory( 'en' ) ) + ], Language::factory( 'de' ) ) + ], Language::factory( 'es' ) ); + + $this->assertEquals( + 'Volver a [[Special:ApiHelp/foo|PÃ¡gina principal]].', + $msg->text(), + 'Process with ->text()' + ); + $this->assertEquals( + '

Volver a PÃ¡gina ' + . "principal.\n

", + $msg->parseAsBlock(), + 'Process with ->parseAsBlock()' + ); + } + public static function provideParser() { return [ [ @@ -509,7 +698,7 @@ class MessageTest extends MediaWikiLangTestCase { */ public function testParser( $expect, $format ) { $msg = new RawMessage( "''&'' " ); - $this->assertEquals( + $this->assertSame( $expect, $msg->inLanguage( 'en' )->$format() ); @@ -523,9 +712,9 @@ class MessageTest extends MediaWikiLangTestCase { // NOTE: make sure internal caching of the message text is reset appropriately $msg = wfMessage( 'mainpage' ); - $this->assertEquals( 'Hauptseite', $msg->inLanguage( 'de' )->plain(), "inLanguage( 'de' )" ); - $this->assertEquals( 'Main Page', $msg->inContentLanguage()->plain(), "inContentLanguage()" ); - $this->assertEquals( 'Accueil', $msg->inLanguage( 'fr' )->plain(), "inLanguage( 'fr' )" ); + $this->assertSame( 'Hauptseite', $msg->inLanguage( 'de' )->plain(), "inLanguage( 'de' )" ); + $this->assertSame( 'Main Page', $msg->inContentLanguage()->plain(), "inContentLanguage()" ); + $this->assertSame( 'Accueil', $msg->inLanguage( 'fr' )->plain(), "inLanguage( 'fr' )" ); } /** @@ -540,18 +729,18 @@ class MessageTest extends MediaWikiLangTestCase { // NOTE: make sure internal caching of the message text is reset appropriately. // NOTE: wgForceUIMsgAsContentMsg forces the messages *current* language to be used. $msg = wfMessage( 'mainpage' ); - $this->assertEquals( + $this->assertSame( 'Accueil', $msg->inContentLanguage()->plain(), 'inContentLanguage() with ForceUIMsg override enabled' ); - $this->assertEquals( 'Main Page', $msg->inLanguage( 'en' )->plain(), "inLanguage( 'en' )" ); - $this->assertEquals( + $this->assertSame( 'Main Page', $msg->inLanguage( 'en' )->plain(), "inLanguage( 'en' )" ); + $this->assertSame( 'Main Page', $msg->inContentLanguage()->plain(), 'inContentLanguage() with ForceUIMsg override enabled' ); - $this->assertEquals( 'Hauptseite', $msg->inLanguage( 'de' )->plain(), "inLanguage( 'de' )" ); + $this->assertSame( 'Hauptseite', $msg->inLanguage( 'de' )->plain(), "inLanguage( 'de' )" ); } /** @@ -570,18 +759,18 @@ class MessageTest extends MediaWikiLangTestCase { $msg = new Message( 'parentheses' ); $msg->rawParams( 'foo' ); $msg->title( Title::newFromText( 'Testing' ) ); - $this->assertEquals( '(foo)', $msg->parse(), 'Sanity check' ); + $this->assertSame( '(foo)', $msg->parse(), 'Sanity check' ); $msg = unserialize( serialize( $msg ) ); - $this->assertEquals( '(foo)', $msg->parse() ); + $this->assertSame( '(foo)', $msg->parse() ); $title = TestingAccessWrapper::newFromObject( $msg )->title; $this->assertInstanceOf( 'Title', $title ); - $this->assertEquals( 'Testing', $title->getFullText() ); + $this->assertSame( 'Testing', $title->getFullText() ); $msg = new Message( 'mainpage' ); $msg->inLanguage( 'de' ); - $this->assertEquals( 'Hauptseite', $msg->plain(), 'Sanity check' ); + $this->assertSame( 'Hauptseite', $msg->plain(), 'Sanity check' ); $msg = unserialize( serialize( $msg ) ); - $this->assertEquals( 'Hauptseite', $msg->plain() ); + $this->assertSame( 'Hauptseite', $msg->plain() ); } /** @@ -614,4 +803,3 @@ class MessageTest extends MediaWikiLangTestCase { ]; } } - diff --git a/tests/phpunit/includes/OutputPageTest.php b/tests/phpunit/includes/OutputPageTest.php index c637d34a5a..c3faf0d0ba 100644 --- a/tests/phpunit/includes/OutputPageTest.php +++ b/tests/phpunit/includes/OutputPageTest.php @@ -7,7 +7,6 @@ * @group Output * * @todo factor tests in this class into providers and test methods - * */ class OutputPageTest extends MediaWikiTestCase { const SCREEN_MEDIA_QUERY = 'screen and (min-width: 982px)'; @@ -305,6 +304,37 @@ class OutputPageTest extends MediaWikiTestCase { $request->setCookie( 'Token', '123' ); $this->assertTrue( $outputPage->haveCacheVaryCookies() ); } + + /* + * @covers OutputPage::addCategoryLinks + * @covers OutputPage::getCategories + */ + function testGetCategories() { + $fakeResultWrapper = new FakeResultWrapper( [ + (object) [ + 'pp_value' => 1, + 'page_title' => 'Test' + ], + (object) [ + 'page_title' => 'Test2' + ] + ] ); + $outputPage = $this->getMockBuilder( 'OutputPage' ) + ->setConstructorArgs( [ new RequestContext() ] ) + ->setMethods( [ 'addCategoryLinksToLBAndGetResult' ] ) + ->getMock(); + $outputPage->expects( $this->any() ) + ->method( 'addCategoryLinksToLBAndGetResult' ) + ->will( $this->returnValue( $fakeResultWrapper ) ); + + $outputPage->addCategoryLinks( [ + 'Test' => 'Test', + 'Test2' => 'Test2', + ] ); + $this->assertEquals( [ 0 => 'Test', '1' => 'Test2' ], $outputPage->getCategories() ); + $this->assertEquals( [ 0 => 'Test2' ], $outputPage->getCategories( 'normal' ) ); + $this->assertEquals( [ 0 => 'Test' ], $outputPage->getCategories( 'hidden' ) ); + } } /** diff --git a/tests/phpunit/includes/PagePropsTest.php b/tests/phpunit/includes/PagePropsTest.php index cc1708a2b4..29c9e228f2 100644 --- a/tests/phpunit/includes/PagePropsTest.php +++ b/tests/phpunit/includes/PagePropsTest.php @@ -266,11 +266,9 @@ class TestPageProps extends MediaWikiLangTestCase { } protected function setProperties( $pageID, $properties ) { - $rows = []; foreach ( $properties as $propertyName => $propertyValue ) { - $row = [ 'pp_page' => $pageID, 'pp_propname' => $propertyName, @@ -295,11 +293,9 @@ class TestPageProps extends MediaWikiLangTestCase { } protected function setProperty( $pageID, $propertyName, $propertyValue ) { - $properties = []; $properties[$propertyName] = $propertyValue; $this->setProperties( $pageID, $properties ); - } } diff --git a/tests/phpunit/includes/PrefixSearchTest.php b/tests/phpunit/includes/PrefixSearchTest.php index bc43709fde..c5a7e04e30 100644 --- a/tests/phpunit/includes/PrefixSearchTest.php +++ b/tests/phpunit/includes/PrefixSearchTest.php @@ -129,11 +129,11 @@ class PrefixSearchTest extends MediaWikiLangTestCase { 'results' => [ 'Special:ActiveUsers', 'Special:AllMessages', - 'Special:AllMyFiles', + 'Special:AllMyUploads', ], // Third result when testing offset 'offsetresult' => [ - 'Special:AllMyUploads', + 'Special:AllPages', ], ] ], [ [ @@ -146,7 +146,7 @@ class PrefixSearchTest extends MediaWikiLangTestCase { ], // Third result when testing offset 'offsetresult' => [ - 'Special:UncategorizedImages', + 'Special:UncategorizedPages', ], ] ], [ [ diff --git a/tests/phpunit/includes/SampleTest.php b/tests/phpunit/includes/SampleTest.php index 7c313845f9..02935a5369 100644 --- a/tests/phpunit/includes/SampleTest.php +++ b/tests/phpunit/includes/SampleTest.php @@ -32,7 +32,7 @@ class TestSample extends MediaWikiLangTestCase { * they run. While MediaWiki isn't strictly an Agile Programming * project, you are encouraged to use the naming described under * "Agile Documentation" at - * http://www.phpunit.de/manual/3.4/en/other-uses-for-tests.html + * https://www.phpunit.de/manual/3.4/en/other-uses-for-tests.html */ public function testTitleObjectStringConversion() { $title = Title::newFromText( "text" ); @@ -45,7 +45,7 @@ class TestSample extends MediaWikiLangTestCase { /** * If you want to run a the same test with a variety of data, use a data provider. - * see: http://www.phpunit.de/manual/3.4/en/writing-tests-for-phpunit.html + * see: https://www.phpunit.de/manual/3.4/en/writing-tests-for-phpunit.html */ public static function provideTitles() { return [ @@ -60,7 +60,7 @@ class TestSample extends MediaWikiLangTestCase { // @codingStandardsIgnoreStart Generic.Files.LineLength /** * @dataProvider provideTitles - * See http://phpunit.de/manual/3.7/en/appendixes.annotations.html#appendixes.annotations.dataProvider + * See https://phpunit.de/manual/3.7/en/appendixes.annotations.html#appendixes.annotations.dataProvider */ // @codingStandardsIgnoreEnd public function testCreateBasicListOfTitles( $titleName, $ns, $text ) { @@ -89,7 +89,7 @@ class TestSample extends MediaWikiLangTestCase { /** * @depends testSetUpMainPageTitleForNextTest - * See http://phpunit.de/manual/3.7/en/appendixes.annotations.html#appendixes.annotations.depends + * See https://phpunit.de/manual/3.7/en/appendixes.annotations.html#appendixes.annotations.depends */ public function testCheckMainPageTitleIsConsideredLocal( $title ) { $this->assertTrue( $title->isLocal() ); @@ -98,7 +98,7 @@ class TestSample extends MediaWikiLangTestCase { // @codingStandardsIgnoreStart Generic.Files.LineLength /** * @expectedException InvalidArgumentException - * See http://phpunit.de/manual/3.7/en/appendixes.annotations.html#appendixes.annotations.expectedException + * See https://phpunit.de/manual/3.7/en/appendixes.annotations.html#appendixes.annotations.expectedException */ // @codingStandardsIgnoreEnd public function testTitleObjectFromObject() { diff --git a/tests/phpunit/includes/SanitizerTest.php b/tests/phpunit/includes/SanitizerTest.php index c915b70e1d..12db1a198f 100644 --- a/tests/phpunit/includes/SanitizerTest.php +++ b/tests/phpunit/includes/SanitizerTest.php @@ -134,19 +134,19 @@ class SanitizerTest extends MediaWikiTestCase { 'Self-closing closing div' ], // Make sure special nested HTML5 semantics are not broken - // http://www.whatwg.org/html/text-level-semantics.html#the-kbd-element + // https://html.spec.whatwg.org/multipage/semantics.html#the-kbd-element [ 'Shift+F3', 'Shift+F3', 'Nested .' ], - // http://www.whatwg.org/html/text-level-semantics.html#the-sub-and-sup-elements + // https://html.spec.whatwg.org/multipage/semantics.html#the-sub-and-sup-elements [ 'x_i, y_i', 'x_i, y_i', 'Nested .' ], - // http://www.whatwg.org/html/text-level-semantics.html#the-dfn-element + // https://html.spec.whatwg.org/multipage/semantics.html#the-dfn-element [ 'GDO', 'GDO', diff --git a/tests/phpunit/includes/TemplateCategoriesTest.php b/tests/phpunit/includes/TemplateCategoriesTest.php index 9359568375..152602ac5e 100644 --- a/tests/phpunit/includes/TemplateCategoriesTest.php +++ b/tests/phpunit/includes/TemplateCategoriesTest.php @@ -91,6 +91,5 @@ class TemplateCategoriesTest extends MediaWikiLangTestCase { $title->getParentCategories(), 'Verify that the page is no longer in the category after template deletion' ); - } } diff --git a/tests/phpunit/includes/TitlePermissionTest.php b/tests/phpunit/includes/TitlePermissionTest.php index 5ecdf56134..9121178a46 100644 --- a/tests/phpunit/includes/TitlePermissionTest.php +++ b/tests/phpunit/includes/TitlePermissionTest.php @@ -787,5 +787,21 @@ class TitlePermissionTest extends MediaWikiLangTestCase { # $action != 'read' && $action != 'createaccount' && $user->isBlockedFrom( $this ) # $user->blockedFor() == '' # $user->mBlock->mExpiry == 'infinity' + + $this->user->mBlockedby = $this->user->getName(); + $this->user->mBlock = new Block( [ + 'address' => '127.0.8.1', + 'by' => $this->user->getId(), + 'reason' => 'no reason given', + 'timestamp' => $now, + 'auto' => false, + 'expiry' => 10, + 'systemBlock' => 'test', + ] ); + $this->assertEquals( [ [ 'systemblockedtext', + '[[User:Useruser|Useruser]]', 'no reason given', '127.0.0.1', + 'Useruser', 'test', '23:00, 31 December 1969', '127.0.8.1', + $wgLang->timeanddate( wfTimestamp( TS_MW, $now ), true ) ] ], + $this->title->getUserPermissionsErrors( 'move-target', $this->user ) ); } } diff --git a/tests/phpunit/includes/WatchedItemQueryServiceUnitTest.php b/tests/phpunit/includes/WatchedItemQueryServiceUnitTest.php index 92446ed950..bdec0a50d9 100644 --- a/tests/phpunit/includes/WatchedItemQueryServiceUnitTest.php +++ b/tests/phpunit/includes/WatchedItemQueryServiceUnitTest.php @@ -180,7 +180,9 @@ class WatchedItemQueryServiceUnitTest extends PHPUnit_Framework_TestCase { '(rc_this_oldid=page_latest) OR (rc_type=3)', ], $this->isType( 'string' ), - [], + [ + 'LIMIT' => 3, + ], [ 'watchlist' => [ 'INNER JOIN', @@ -214,12 +216,184 @@ class WatchedItemQueryServiceUnitTest extends PHPUnit_Framework_TestCase { 'rc_deleted' => 0, 'wl_notificationtimestamp' => null, ] ), + $this->getFakeRow( [ + 'rc_id' => 3, + 'rc_namespace' => 1, + 'rc_title' => 'Foo3', + 'rc_timestamp' => '20151212010103', + 'rc_type' => RC_NEW, + 'rc_deleted' => 0, + 'wl_notificationtimestamp' => null, + ] ), ] ) ); $queryService = new WatchedItemQueryService( $this->getMockLoadBalancer( $mockDb ) ); $user = $this->getMockUnrestrictedNonAnonUserWithId( 1 ); - $items = $queryService->getWatchedItemsWithRecentChangeInfo( $user ); + $startFrom = null; + $items = $queryService->getWatchedItemsWithRecentChangeInfo( + $user, [ 'limit' => 2 ], $startFrom + ); + + $this->assertInternalType( 'array', $items ); + $this->assertCount( 2, $items ); + + foreach ( $items as list( $watchedItem, $recentChangeInfo ) ) { + $this->assertInstanceOf( WatchedItem::class, $watchedItem ); + $this->assertInternalType( 'array', $recentChangeInfo ); + } + + $this->assertEquals( + new WatchedItem( $user, new TitleValue( 0, 'Foo1' ), '20151212010101' ), + $items[0][0] + ); + $this->assertEquals( + [ + 'rc_id' => 1, + 'rc_namespace' => 0, + 'rc_title' => 'Foo1', + 'rc_timestamp' => '20151212010101', + 'rc_type' => RC_NEW, + 'rc_deleted' => 0, + ], + $items[0][1] + ); + + $this->assertEquals( + new WatchedItem( $user, new TitleValue( 1, 'Foo2' ), null ), + $items[1][0] + ); + $this->assertEquals( + [ + 'rc_id' => 2, + 'rc_namespace' => 1, + 'rc_title' => 'Foo2', + 'rc_timestamp' => '20151212010102', + 'rc_type' => RC_NEW, + 'rc_deleted' => 0, + ], + $items[1][1] + ); + + $this->assertEquals( [ '20151212010103', 3 ], $startFrom ); + } + + public function testGetWatchedItemsWithRecentChangeInfo_extension() { + $mockDb = $this->getMockDb(); + $mockDb->expects( $this->once() ) + ->method( 'select' ) + ->with( + [ 'recentchanges', 'watchlist', 'page', 'extension_dummy_table' ], + [ + 'rc_id', + 'rc_namespace', + 'rc_title', + 'rc_timestamp', + 'rc_type', + 'rc_deleted', + 'wl_notificationtimestamp', + 'rc_cur_id', + 'rc_this_oldid', + 'rc_last_oldid', + 'extension_dummy_field', + ], + [ + 'wl_user' => 1, + '(rc_this_oldid=page_latest) OR (rc_type=3)', + 'extension_dummy_cond', + ], + $this->isType( 'string' ), + [ + 'extension_dummy_option', + ], + [ + 'watchlist' => [ + 'INNER JOIN', + [ + 'wl_namespace=rc_namespace', + 'wl_title=rc_title' + ] + ], + 'page' => [ + 'LEFT JOIN', + 'rc_cur_id=page_id', + ], + 'extension_dummy_join_cond' => [], + ] + ) + ->will( $this->returnValue( [ + $this->getFakeRow( [ + 'rc_id' => 1, + 'rc_namespace' => 0, + 'rc_title' => 'Foo1', + 'rc_timestamp' => '20151212010101', + 'rc_type' => RC_NEW, + 'rc_deleted' => 0, + 'wl_notificationtimestamp' => '20151212010101', + ] ), + $this->getFakeRow( [ + 'rc_id' => 2, + 'rc_namespace' => 1, + 'rc_title' => 'Foo2', + 'rc_timestamp' => '20151212010102', + 'rc_type' => RC_NEW, + 'rc_deleted' => 0, + 'wl_notificationtimestamp' => null, + ] ), + ] ) ); + + $user = $this->getMockUnrestrictedNonAnonUserWithId( 1 ); + + $mockExtension = $this->getMockBuilder( WatchedItemQueryServiceExtension::class ) + ->getMock(); + $mockExtension->expects( $this->once() ) + ->method( 'modifyWatchedItemsWithRCInfoQuery' ) + ->with( + $this->identicalTo( $user ), + $this->isType( 'array' ), + $this->isInstanceOf( IDatabase::class ), + $this->isType( 'array' ), + $this->isType( 'array' ), + $this->isType( 'array' ), + $this->isType( 'array' ), + $this->isType( 'array' ) + ) + ->will( $this->returnCallback( function ( + $user, $options, $db, &$tables, &$fields, &$conds, &$dbOptions, &$joinConds + ) { + $tables[] = 'extension_dummy_table'; + $fields[] = 'extension_dummy_field'; + $conds[] = 'extension_dummy_cond'; + $dbOptions[] = 'extension_dummy_option'; + $joinConds['extension_dummy_join_cond'] = []; + } ) ); + $mockExtension->expects( $this->once() ) + ->method( 'modifyWatchedItemsWithRCInfo' ) + ->with( + $this->identicalTo( $user ), + $this->isType( 'array' ), + $this->isInstanceOf( IDatabase::class ), + $this->isType( 'array' ), + $this->anything(), + $this->anything() // Can't test for null here, PHPUnit applies this after the callback + ) + ->will( $this->returnCallback( function ( $user, $options, $db, &$items, $res, &$startFrom ) { + foreach ( $items as $i => &$item ) { + $item[1]['extension_dummy_field'] = $i; + } + unset( $item ); + + $this->assertNull( $startFrom ); + $startFrom = [ '20160203123456', 42 ]; + } ) ); + + $queryService = new WatchedItemQueryService( $this->getMockLoadBalancer( $mockDb ) ); + TestingAccessWrapper::newFromObject( $queryService )->extensions = [ $mockExtension ]; + + $startFrom = null; + $items = $queryService->getWatchedItemsWithRecentChangeInfo( + $user, [], $startFrom + ); $this->assertInternalType( 'array', $items ); $this->assertCount( 2, $items ); @@ -241,6 +415,7 @@ class WatchedItemQueryServiceUnitTest extends PHPUnit_Framework_TestCase { 'rc_timestamp' => '20151212010101', 'rc_type' => RC_NEW, 'rc_deleted' => 0, + 'extension_dummy_field' => 0, ], $items[0][1] ); @@ -257,93 +432,110 @@ class WatchedItemQueryServiceUnitTest extends PHPUnit_Framework_TestCase { 'rc_timestamp' => '20151212010102', 'rc_type' => RC_NEW, 'rc_deleted' => 0, + 'extension_dummy_field' => 1, ], $items[1][1] ); + + $this->assertEquals( [ '20160203123456', 42 ], $startFrom ); } public function getWatchedItemsWithRecentChangeInfoOptionsProvider() { return [ [ [ 'includeFields' => [ WatchedItemQueryService::INCLUDE_FLAGS ] ], + null, [ 'rc_type', 'rc_minor', 'rc_bot' ], [], [], ], [ [ 'includeFields' => [ WatchedItemQueryService::INCLUDE_USER ] ], + null, [ 'rc_user_text' ], [], [], ], [ [ 'includeFields' => [ WatchedItemQueryService::INCLUDE_USER_ID ] ], + null, [ 'rc_user' ], [], [], ], [ [ 'includeFields' => [ WatchedItemQueryService::INCLUDE_COMMENT ] ], + null, [ 'rc_comment' ], [], [], ], [ [ 'includeFields' => [ WatchedItemQueryService::INCLUDE_PATROL_INFO ] ], + null, [ 'rc_patrolled', 'rc_log_type' ], [], [], ], [ [ 'includeFields' => [ WatchedItemQueryService::INCLUDE_SIZES ] ], + null, [ 'rc_old_len', 'rc_new_len' ], [], [], ], [ [ 'includeFields' => [ WatchedItemQueryService::INCLUDE_LOG_INFO ] ], + null, [ 'rc_logid', 'rc_log_type', 'rc_log_action', 'rc_params' ], [], [], ], [ [ 'namespaceIds' => [ 0, 1 ] ], + null, [], [ 'wl_namespace' => [ 0, 1 ] ], [], ], [ [ 'namespaceIds' => [ 0, "1; DROP TABLE watchlist;\n--" ] ], + null, [], [ 'wl_namespace' => [ 0, 1 ] ], [], ], [ [ 'rcTypes' => [ RC_EDIT, RC_NEW ] ], + null, [], [ 'rc_type' => [ RC_EDIT, RC_NEW ] ], [], ], [ [ 'dir' => WatchedItemQueryService::DIR_OLDER ], + null, [], [], [ 'ORDER BY' => [ 'rc_timestamp DESC', 'rc_id DESC' ] ] ], [ [ 'dir' => WatchedItemQueryService::DIR_NEWER ], + null, [], [], [ 'ORDER BY' => [ 'rc_timestamp', 'rc_id' ] ] ], [ [ 'dir' => WatchedItemQueryService::DIR_OLDER, 'start' => '20151212010101' ], + null, [], [ "rc_timestamp <= '20151212010101'" ], [ 'ORDER BY' => [ 'rc_timestamp DESC', 'rc_id DESC' ] ] ], [ [ 'dir' => WatchedItemQueryService::DIR_OLDER, 'end' => '20151212010101' ], + null, [], [ "rc_timestamp >= '20151212010101'" ], [ 'ORDER BY' => [ 'rc_timestamp DESC', 'rc_id DESC' ] ] @@ -354,18 +546,21 @@ class WatchedItemQueryServiceUnitTest extends PHPUnit_Framework_TestCase { 'start' => '20151212020101', 'end' => '20151212010101' ], + null, [], [ "rc_timestamp <= '20151212020101'", "rc_timestamp >= '20151212010101'" ], [ 'ORDER BY' => [ 'rc_timestamp DESC', 'rc_id DESC' ] ] ], [ [ 'dir' => WatchedItemQueryService::DIR_NEWER, 'start' => '20151212010101' ], + null, [], [ "rc_timestamp >= '20151212010101'" ], [ 'ORDER BY' => [ 'rc_timestamp', 'rc_id' ] ] ], [ [ 'dir' => WatchedItemQueryService::DIR_NEWER, 'end' => '20151212010101' ], + null, [], [ "rc_timestamp <= '20151212010101'" ], [ 'ORDER BY' => [ 'rc_timestamp', 'rc_id' ] ] @@ -376,96 +571,112 @@ class WatchedItemQueryServiceUnitTest extends PHPUnit_Framework_TestCase { 'start' => '20151212010101', 'end' => '20151212020101' ], + null, [], [ "rc_timestamp >= '20151212010101'", "rc_timestamp <= '20151212020101'" ], [ 'ORDER BY' => [ 'rc_timestamp', 'rc_id' ] ] ], [ [ 'limit' => 10 ], + null, [], [], - [ 'LIMIT' => 10 ], + [ 'LIMIT' => 11 ], ], [ [ 'limit' => "10; DROP TABLE watchlist;\n--" ], + null, [], [], - [ 'LIMIT' => 10 ], + [ 'LIMIT' => 11 ], ], [ [ 'filters' => [ WatchedItemQueryService::FILTER_MINOR ] ], + null, [], [ 'rc_minor != 0' ], [], ], [ [ 'filters' => [ WatchedItemQueryService::FILTER_NOT_MINOR ] ], + null, [], [ 'rc_minor = 0' ], [], ], [ [ 'filters' => [ WatchedItemQueryService::FILTER_BOT ] ], + null, [], [ 'rc_bot != 0' ], [], ], [ [ 'filters' => [ WatchedItemQueryService::FILTER_NOT_BOT ] ], + null, [], [ 'rc_bot = 0' ], [], ], [ [ 'filters' => [ WatchedItemQueryService::FILTER_ANON ] ], + null, [], [ 'rc_user = 0' ], [], ], [ [ 'filters' => [ WatchedItemQueryService::FILTER_NOT_ANON ] ], + null, [], [ 'rc_user != 0' ], [], ], [ [ 'filters' => [ WatchedItemQueryService::FILTER_PATROLLED ] ], + null, [], [ 'rc_patrolled != 0' ], [], ], [ [ 'filters' => [ WatchedItemQueryService::FILTER_NOT_PATROLLED ] ], + null, [], [ 'rc_patrolled = 0' ], [], ], [ [ 'filters' => [ WatchedItemQueryService::FILTER_UNREAD ] ], + null, [], [ 'rc_timestamp >= wl_notificationtimestamp' ], [], ], [ [ 'filters' => [ WatchedItemQueryService::FILTER_NOT_UNREAD ] ], + null, [], [ 'wl_notificationtimestamp IS NULL OR rc_timestamp < wl_notificationtimestamp' ], [], ], [ [ 'onlyByUser' => 'SomeOtherUser' ], + null, [], [ 'rc_user_text' => 'SomeOtherUser' ], [], ], [ [ 'notByUser' => 'SomeOtherUser' ], + null, [], [ "rc_user_text != 'SomeOtherUser'" ], [], ], [ - [ 'startFrom' => [ '20151212010101', 123 ], 'dir' => WatchedItemQueryService::DIR_OLDER ], + [ 'dir' => WatchedItemQueryService::DIR_OLDER ], + [ '20151212010101', 123 ], [], [ "(rc_timestamp < '20151212010101') OR ((rc_timestamp = '20151212010101') AND (rc_id <= 123))" @@ -473,7 +684,8 @@ class WatchedItemQueryServiceUnitTest extends PHPUnit_Framework_TestCase { [ 'ORDER BY' => [ 'rc_timestamp DESC', 'rc_id DESC' ] ], ], [ - [ 'startFrom' => [ '20151212010101', 123 ], 'dir' => WatchedItemQueryService::DIR_NEWER ], + [ 'dir' => WatchedItemQueryService::DIR_NEWER ], + [ '20151212010101', 123 ], [], [ "(rc_timestamp > '20151212010101') OR ((rc_timestamp = '20151212010101') AND (rc_id >= 123))" @@ -481,10 +693,8 @@ class WatchedItemQueryServiceUnitTest extends PHPUnit_Framework_TestCase { [ 'ORDER BY' => [ 'rc_timestamp', 'rc_id' ] ], ], [ - [ - 'startFrom' => [ '20151212010101', "123; DROP TABLE watchlist;\n--" ], - 'dir' => WatchedItemQueryService::DIR_OLDER - ], + [ 'dir' => WatchedItemQueryService::DIR_OLDER ], + [ '20151212010101', "123; DROP TABLE watchlist;\n--" ], [], [ "(rc_timestamp < '20151212010101') OR ((rc_timestamp = '20151212010101') AND (rc_id <= 123))" @@ -499,6 +709,7 @@ class WatchedItemQueryServiceUnitTest extends PHPUnit_Framework_TestCase { */ public function testGetWatchedItemsWithRecentChangeInfo_optionsAndEmptyResult( array $options, + $startFrom, array $expectedExtraFields, array $expectedExtraConds, array $expectedDbOptions @@ -552,9 +763,10 @@ class WatchedItemQueryServiceUnitTest extends PHPUnit_Framework_TestCase { $queryService = new WatchedItemQueryService( $this->getMockLoadBalancer( $mockDb ) ); $user = $this->getMockUnrestrictedNonAnonUserWithId( 1 ); - $items = $queryService->getWatchedItemsWithRecentChangeInfo( $user, $options ); + $items = $queryService->getWatchedItemsWithRecentChangeInfo( $user, $options, $startFrom ); $this->assertEmpty( $items ); + $this->assertNull( $startFrom ); } public function filterPatrolledOptionProvider() { @@ -797,53 +1009,62 @@ class WatchedItemQueryServiceUnitTest extends PHPUnit_Framework_TestCase { return [ [ [ 'rcTypes' => [ 1337 ] ], + null, 'Bad value for parameter $options[\'rcTypes\']', ], [ [ 'rcTypes' => [ 'edit' ] ], + null, 'Bad value for parameter $options[\'rcTypes\']', ], [ [ 'rcTypes' => [ RC_EDIT, 1337 ] ], + null, 'Bad value for parameter $options[\'rcTypes\']', ], [ [ 'dir' => 'foo' ], + null, 'Bad value for parameter $options[\'dir\']', ], [ [ 'start' => '20151212010101' ], + null, 'Bad value for parameter $options[\'dir\']: must be provided', ], [ [ 'end' => '20151212010101' ], + null, 'Bad value for parameter $options[\'dir\']: must be provided', ], [ - [ 'startFrom' => [ '20151212010101', 123 ] ], + [], + [ '20151212010101', 123 ], 'Bad value for parameter $options[\'dir\']: must be provided', ], [ - [ 'dir' => WatchedItemQueryService::DIR_OLDER, 'startFrom' => '20151212010101' ], - 'Bad value for parameter $options[\'startFrom\']: must be a two-element array', + [ 'dir' => WatchedItemQueryService::DIR_OLDER ], + '20151212010101', + 'Bad value for parameter $startFrom: must be a two-element array', ], [ - [ 'dir' => WatchedItemQueryService::DIR_OLDER, 'startFrom' => [ '20151212010101' ] ], - 'Bad value for parameter $options[\'startFrom\']: must be a two-element array', + [ 'dir' => WatchedItemQueryService::DIR_OLDER ], + [ '20151212010101' ], + 'Bad value for parameter $startFrom: must be a two-element array', ], [ - [ - 'dir' => WatchedItemQueryService::DIR_OLDER, - 'startFrom' => [ '20151212010101', 123, 'foo' ] - ], - 'Bad value for parameter $options[\'startFrom\']: must be a two-element array', + [ 'dir' => WatchedItemQueryService::DIR_OLDER ], + [ '20151212010101', 123, 'foo' ], + 'Bad value for parameter $startFrom: must be a two-element array', ], [ [ 'watchlistOwner' => $this->getMockUnrestrictedNonAnonUserWithId( 2 ) ], + null, 'Bad value for parameter $options[\'watchlistOwnerToken\']', ], [ [ 'watchlistOwner' => 'Other User', 'watchlistOwnerToken' => 'some-token' ], + null, 'Bad value for parameter $options[\'watchlistOwner\']', ], ]; @@ -854,6 +1075,7 @@ class WatchedItemQueryServiceUnitTest extends PHPUnit_Framework_TestCase { */ public function testGetWatchedItemsWithRecentChangeInfo_invalidOptions( array $options, + $startFrom, $expectedInExceptionMessage ) { $mockDb = $this->getMockDb(); @@ -864,7 +1086,7 @@ class WatchedItemQueryServiceUnitTest extends PHPUnit_Framework_TestCase { $user = $this->getMockUnrestrictedNonAnonUserWithId( 1 ); $this->setExpectedException( InvalidArgumentException::class, $expectedInExceptionMessage ); - $queryService->getWatchedItemsWithRecentChangeInfo( $user, $options ); + $queryService->getWatchedItemsWithRecentChangeInfo( $user, $options, $startFrom ); } public function testGetWatchedItemsWithRecentChangeInfo_usedInGeneratorOptionAndEmptyResult() { @@ -1011,7 +1233,7 @@ class WatchedItemQueryServiceUnitTest extends PHPUnit_Framework_TestCase { ->with( 'watchlisttoken' ) ->willReturn( '0123456789abcdef' ); - $this->setExpectedException( UsageException::class, 'Incorrect watchlist token provided' ); + $this->setExpectedException( ApiUsageException::class, 'Incorrect watchlist token provided' ); $queryService->getWatchedItemsWithRecentChangeInfo( $user, [ 'watchlistOwner' => $otherUser, 'watchlistOwnerToken' => $token ] diff --git a/tests/phpunit/includes/WatchedItemStoreUnitTest.php b/tests/phpunit/includes/WatchedItemStoreUnitTest.php index ba4705970c..0bd0bccbf4 100644 --- a/tests/phpunit/includes/WatchedItemStoreUnitTest.php +++ b/tests/phpunit/includes/WatchedItemStoreUnitTest.php @@ -2404,6 +2404,35 @@ class WatchedItemStoreUnitTest extends MediaWikiTestCase { ); } + public function testSetNotificationTimestampsForUser_nullTimestamp() { + $user = $this->getMockNonAnonUserWithId( 1 ); + $timestamp = null; + + $mockDb = $this->getMockDb(); + $mockDb->expects( $this->once() ) + ->method( 'update' ) + ->with( + 'watchlist', + [ 'wl_notificationtimestamp' => null ], + [ 'wl_user' => 1 ] + ) + ->will( $this->returnValue( true ) ); + $mockDb->expects( $this->exactly( 0 ) ) + ->method( 'timestamp' ) + ->will( $this->returnCallback( function( $value ) { + return 'TS' . $value . 'TS'; + } ) ); + + $store = $this->newWatchedItemStore( + $this->getMockLoadBalancer( $mockDb ), + $this->getMockCache() + ); + + $this->assertTrue( + $store->setNotificationTimestampsForUser( $user, $timestamp ) + ); + } + public function testSetNotificationTimestampsForUser_specificTargets() { $user = $this->getMockNonAnonUserWithId( 1 ); $timestamp = '20100101010101'; diff --git a/tests/phpunit/includes/XmlTest.php b/tests/phpunit/includes/XmlTest.php index dbd1299ebd..18ff1f4b11 100644 --- a/tests/phpunit/includes/XmlTest.php +++ b/tests/phpunit/includes/XmlTest.php @@ -305,17 +305,6 @@ class XmlTest extends MediaWikiTestCase { ); } - /** - * @covers Xml::escapeJsString - */ - public function testEscapeJsStringSpecialChars() { - $this->assertEquals( - '\\\\\r\n', - Xml::escapeJsString( "\\\r\n" ), - 'escapeJsString() with special characters' - ); - } - /** * @covers Xml::encodeJsVar */ diff --git a/tests/phpunit/includes/api/ApiBaseTest.php b/tests/phpunit/includes/api/ApiBaseTest.php index 8b75d56281..7327e85471 100644 --- a/tests/phpunit/includes/api/ApiBaseTest.php +++ b/tests/phpunit/includes/api/ApiBaseTest.php @@ -20,7 +20,7 @@ class ApiBaseTest extends ApiTestCase { } /** - * @expectedException UsageException + * @expectedException ApiUsageException * @covers ApiBase::requireOnlyOneParameter */ public function testRequireOnlyOneParameterZero() { @@ -32,7 +32,7 @@ class ApiBaseTest extends ApiTestCase { } /** - * @expectedException UsageException + * @expectedException ApiUsageException * @covers ApiBase::requireOnlyOneParameter */ public function testRequireOnlyOneParameterTrue() { @@ -58,10 +58,10 @@ class ApiBaseTest extends ApiTestCase { $context->setRequest( new FauxRequest( $input !== null ? [ 'foo' => $input ] : [] ) ); $wrapper->mMainModule = new ApiMain( $context ); - if ( $expected instanceof UsageException ) { + if ( $expected instanceof ApiUsageException ) { try { $wrapper->getParameterFromSettings( 'foo', $paramSettings, true ); - } catch ( UsageException $ex ) { + } catch ( ApiUsageException $ex ) { $this->assertEquals( $expected, $ex ); } } else { @@ -73,9 +73,7 @@ class ApiBaseTest extends ApiTestCase { public static function provideGetParameterFromSettings() { $warnings = [ - 'The value passed for \'foo\' contains invalid or non-normalized data. Textual data should ' . - 'be valid, NFC-normalized Unicode without C0 control characters other than ' . - 'HT (\\t), LF (\\n), and CR (\\r).' + [ 'apiwarn-badutf8', 'foo' ], ]; $c0 = ''; @@ -96,7 +94,7 @@ class ApiBaseTest extends ApiTestCase { 'String param, required, empty' => [ '', [ ApiBase::PARAM_DFLT => 'default', ApiBase::PARAM_REQUIRED => true ], - new UsageException( 'The foo parameter must be set', 'nofoo' ), + ApiUsageException::newWithMessage( null, [ 'apierror-missingparam', 'foo' ] ), [] ], 'Multi-valued parameter' => [ @@ -126,4 +124,52 @@ class ApiBaseTest extends ApiTestCase { ]; } + public function testErrorArrayToStatus() { + $mock = new MockApi(); + + // Sanity check empty array + $expect = Status::newGood(); + $this->assertEquals( $expect, $mock->errorArrayToStatus( [] ) ); + + // No blocked $user, so no special block handling + $expect = Status::newGood(); + $expect->fatal( 'blockedtext' ); + $expect->fatal( 'autoblockedtext' ); + $expect->fatal( 'systemblockedtext' ); + $expect->fatal( 'mainpage' ); + $expect->fatal( 'parentheses', 'foobar' ); + $this->assertEquals( $expect, $mock->errorArrayToStatus( [ + [ 'blockedtext' ], + [ 'autoblockedtext' ], + [ 'systemblockedtext' ], + 'mainpage', + [ 'parentheses', 'foobar' ], + ] ) ); + + // Has a blocked $user, so special block handling + $user = $this->getMutableTestUser()->getUser(); + $block = new \Block( [ + 'address' => $user->getName(), + 'user' => $user->getID(), + 'reason' => __METHOD__, + 'expiry' => time() + 100500, + ] ); + $block->insert(); + $blockinfo = [ 'blockinfo' => ApiQueryUserInfo::getBlockInfo( $block ) ]; + + $expect = Status::newGood(); + $expect->fatal( ApiMessage::create( 'apierror-blocked', 'blocked', $blockinfo ) ); + $expect->fatal( ApiMessage::create( 'apierror-autoblocked', 'autoblocked', $blockinfo ) ); + $expect->fatal( ApiMessage::create( 'apierror-systemblocked', 'blocked', $blockinfo ) ); + $expect->fatal( 'mainpage' ); + $expect->fatal( 'parentheses', 'foobar' ); + $this->assertEquals( $expect, $mock->errorArrayToStatus( [ + [ 'blockedtext' ], + [ 'autoblockedtext' ], + [ 'systemblockedtext' ], + 'mainpage', + [ 'parentheses', 'foobar' ], + ], $user ) ); + } + } diff --git a/tests/phpunit/includes/api/ApiBlockTest.php b/tests/phpunit/includes/api/ApiBlockTest.php index d2dccf997d..832a113f0e 100644 --- a/tests/phpunit/includes/api/ApiBlockTest.php +++ b/tests/phpunit/includes/api/ApiBlockTest.php @@ -13,6 +13,14 @@ class ApiBlockTest extends ApiTestCase { $this->doLogin(); } + protected function tearDown() { + $block = Block::newFromTarget( 'UTApiBlockee' ); + if ( !is_null( $block ) ) { + $block->delete(); + } + parent::tearDown(); + } + protected function getTokens() { return $this->getTokenList( self::$users['sysop'] ); } @@ -65,8 +73,37 @@ class ApiBlockTest extends ApiTestCase { } /** - * @expectedException UsageException - * @expectedExceptionMessage The token parameter must be set + * Block by user ID + */ + public function testMakeNormalBlockId() { + $tokens = $this->getTokens(); + $user = User::newFromName( 'UTApiBlockee' ); + + if ( !$user->getId() ) { + $this->markTestIncomplete( "The user UTApiBlockee does not exist." ); + } + + if ( !array_key_exists( 'blocktoken', $tokens ) ) { + $this->markTestIncomplete( "No block token found" ); + } + + $data = $this->doApiRequest( [ + 'action' => 'block', + 'userid' => $user->getId(), + 'reason' => 'Some reason', + 'token' => $tokens['blocktoken'] ], null, false, self::$users['sysop']->getUser() ); + + $block = Block::newFromTarget( 'UTApiBlockee' ); + + $this->assertTrue( !is_null( $block ), 'Block is valid.' ); + $this->assertEquals( 'UTApiBlockee', (string)$block->getTarget() ); + $this->assertEquals( 'Some reason', $block->mReason ); + $this->assertEquals( 'infinity', $block->mExpiry ); + } + + /** + * @expectedException ApiUsageException + * @expectedExceptionMessage The "token" parameter must be set */ public function testBlockingActionWithNoToken() { $this->doApiRequest( diff --git a/tests/phpunit/includes/api/ApiContinuationManagerTest.php b/tests/phpunit/includes/api/ApiContinuationManagerTest.php index 6da16a0931..bb4ea75893 100644 --- a/tests/phpunit/includes/api/ApiContinuationManagerTest.php +++ b/tests/phpunit/includes/api/ApiContinuationManagerTest.php @@ -160,10 +160,8 @@ class ApiContinuationManagerTest extends MediaWikiTestCase { try { self::getManager( 'foo', $allModules, [ 'mock1', 'mock2' ] ); $this->fail( 'Expected exception not thrown' ); - } catch ( UsageException $ex ) { - $this->assertSame( - 'Invalid continue param. You should pass the original value returned by the previous query', - $ex->getMessage(), + } catch ( ApiUsageException $ex ) { + $this->assertTrue( ApiTestCase::apiExceptionHasCode( $ex, 'badcontinue' ), 'Expected exception' ); } @@ -195,7 +193,6 @@ class ApiContinuationManagerTest extends MediaWikiTestCase { 'Expected exception' ); } - } } diff --git a/tests/phpunit/includes/api/ApiEditPageTest.php b/tests/phpunit/includes/api/ApiEditPageTest.php index 02d0a0dc57..0ffcbca762 100644 --- a/tests/phpunit/includes/api/ApiEditPageTest.php +++ b/tests/phpunit/includes/api/ApiEditPageTest.php @@ -195,9 +195,9 @@ class ApiEditPageTest extends ApiTestCase { 'section' => '9999', 'text' => 'text', ] ); - $this->fail( "Should have raised a UsageException" ); - } catch ( UsageException $e ) { - $this->assertEquals( 'nosuchsection', $e->getCodeString() ); + $this->fail( "Should have raised an ApiUsageException" ); + } catch ( ApiUsageException $e ) { + $this->assertTrue( self::apiExceptionHasCode( $e, 'nosuchsection' ) ); } } @@ -333,8 +333,8 @@ class ApiEditPageTest extends ApiTestCase { ], null, self::$users['sysop']->getUser() ); $this->fail( 'redirect-appendonly error expected' ); - } catch ( UsageException $ex ) { - $this->assertEquals( 'redirect-appendonly', $ex->getCodeString() ); + } catch ( ApiUsageException $ex ) { + $this->assertTrue( self::apiExceptionHasCode( $ex, 'redirect-appendonly' ) ); } } @@ -369,8 +369,8 @@ class ApiEditPageTest extends ApiTestCase { ], null, self::$users['sysop']->getUser() ); $this->fail( 'edit conflict expected' ); - } catch ( UsageException $ex ) { - $this->assertEquals( 'editconflict', $ex->getCodeString() ); + } catch ( ApiUsageException $ex ) { + $this->assertTrue( self::apiExceptionHasCode( $ex, 'editconflict' ) ); } } @@ -474,7 +474,7 @@ class ApiEditPageTest extends ApiTestCase { public function testCheckDirectApiEditingDisallowed_forNonTextContent() { $this->setExpectedException( - 'UsageException', + 'ApiUsageException', 'Direct editing via API is not supported for content model ' . 'testing used by Dummy:ApiEditPageTest_nonTextPageEdit' ); diff --git a/tests/phpunit/includes/api/ApiErrorFormatterTest.php b/tests/phpunit/includes/api/ApiErrorFormatterTest.php index d13b00be2e..1b7f6bff57 100644 --- a/tests/phpunit/includes/api/ApiErrorFormatterTest.php +++ b/tests/phpunit/includes/api/ApiErrorFormatterTest.php @@ -5,6 +5,30 @@ */ class ApiErrorFormatterTest extends MediaWikiLangTestCase { + /** + * @covers ApiErrorFormatter + */ + public function testErrorFormatterBasics() { + $result = new ApiResult( 8388608 ); + $formatter = new ApiErrorFormatter( $result, Language::factory( 'de' ), 'wikitext', false ); + $this->assertSame( 'de', $formatter->getLanguage()->getCode() ); + + $formatter->addMessagesFromStatus( null, Status::newGood() ); + $this->assertSame( + [ ApiResult::META_TYPE => 'assoc' ], + $result->getResultData() + ); + + $this->assertSame( [], $formatter->arrayFromStatus( Status::newGood() ) ); + + $wrappedFormatter = TestingAccessWrapper::newFromObject( $formatter ); + $this->assertSame( + 'Blah "kbd" ð', + $wrappedFormatter->stripMarkup( 'Blah kbd <X> 😊' ), + 'stripMarkup' + ); + } + /** * @covers ApiErrorFormatter * @dataProvider provideErrorFormatter @@ -22,7 +46,7 @@ class ApiErrorFormatterTest extends MediaWikiLangTestCase { $formatter->addWarning( 'string', 'mainpage' ); $formatter->addError( 'err', 'mainpage' ); - $this->assertSame( $expect1, $result->getResultData(), 'Simple test' ); + $this->assertEquals( $expect1, $result->getResultData(), 'Simple test' ); $result->reset(); $formatter->addWarning( 'foo', 'mainpage' ); @@ -35,6 +59,17 @@ class ApiErrorFormatterTest extends MediaWikiLangTestCase { $formatter->addError( 'errWithData', $msg2 ); $this->assertSame( $expect2, $result->getResultData(), 'Complex test' ); + $this->assertEquals( + $this->removeModuleTag( $expect2['warnings'][2] ), + $formatter->formatMessage( $msg1 ), + 'formatMessage test 1' + ); + $this->assertEquals( + $this->removeModuleTag( $expect2['warnings'][3] ), + $formatter->formatMessage( $msg2 ), + 'formatMessage test 2' + ); + $result->reset(); $status = Status::newGood(); $status->warning( 'mainpage' ); @@ -47,245 +82,256 @@ class ApiErrorFormatterTest extends MediaWikiLangTestCase { $this->assertSame( $expect3, $result->getResultData(), 'Status test' ); $this->assertSame( - $expect3['errors']['status'], + array_map( [ $this, 'removeModuleTag' ], $expect3['errors'] ), $formatter->arrayFromStatus( $status, 'error' ), 'arrayFromStatus test for error' ); $this->assertSame( - $expect3['warnings']['status'], + array_map( [ $this, 'removeModuleTag' ], $expect3['warnings'] ), $formatter->arrayFromStatus( $status, 'warning' ), 'arrayFromStatus test for warning' ); } + private function removeModuleTag( $s ) { + if ( is_array( $s ) ) { + unset( $s['module'] ); + } + return $s; + } + public static function provideErrorFormatter() { - $mainpagePlain = wfMessage( 'mainpage' )->useDatabase( false )->plain(); - $parensPlain = wfMessage( 'parentheses', 'foobar' )->useDatabase( false )->plain(); - $mainpageText = wfMessage( 'mainpage' )->inLanguage( 'de' )->text(); - $parensText = wfMessage( 'parentheses', 'foobar' )->inLanguage( 'de' )->text(); + $mainpageText = wfMessage( 'mainpage' )->inLanguage( 'de' )->useDatabase( false )->text(); + $parensText = wfMessage( 'parentheses', 'foobar' )->inLanguage( 'de' ) + ->useDatabase( false )->text(); + $mainpageHTML = wfMessage( 'mainpage' )->inLanguage( 'en' )->parse(); + $parensHTML = wfMessage( 'parentheses', 'foobar' )->inLanguage( 'en' )->parse(); $C = ApiResult::META_CONTENT; $I = ApiResult::META_INDEXED_TAG_NAME; + $overriddenData = [ 'overriddenData' => true, ApiResult::META_TYPE => 'assoc' ]; return [ - [ 'wikitext', 'de', true, + $tmp = [ 'wikitext', 'de', false, [ 'errors' => [ - 'err' => [ - [ 'code' => 'mainpage', 'text' => $mainpageText, $C => 'text' ], - $I => 'error', - ], + [ 'code' => 'mainpage', 'text' => $mainpageText, 'module' => 'err', $C => 'text' ], + $I => 'error', ], 'warnings' => [ - 'string' => [ - [ 'code' => 'mainpage', 'text' => $mainpageText, $C => 'text' ], - $I => 'warning', - ], + [ 'code' => 'mainpage', 'text' => $mainpageText, 'module' => 'string', $C => 'text' ], + $I => 'warning', ], ], [ 'errors' => [ - 'errWithData' => [ - [ 'code' => 'overriddenCode', 'text' => $mainpageText, - 'overriddenData' => true, $C => 'text' ], - $I => 'error', - ], + [ 'code' => 'overriddenCode', 'text' => $mainpageText, + 'data' => $overriddenData, 'module' => 'errWithData', $C => 'text' ], + $I => 'error', ], 'warnings' => [ - 'messageWithData' => [ - [ 'code' => 'overriddenCode', 'text' => $mainpageText, - 'overriddenData' => true, $C => 'text' ], - $I => 'warning', - ], - 'message' => [ - [ 'code' => 'mainpage', 'text' => $mainpageText, $C => 'text' ], - $I => 'warning', - ], - 'foo' => [ - [ 'code' => 'mainpage', 'text' => $mainpageText, $C => 'text' ], - [ 'code' => 'parentheses', 'text' => $parensText, $C => 'text' ], - $I => 'warning', - ], + [ 'code' => 'mainpage', 'text' => $mainpageText, 'module' => 'foo', $C => 'text' ], + [ 'code' => 'parentheses', 'text' => $parensText, 'module' => 'foo', $C => 'text' ], + [ 'code' => 'mainpage', 'text' => $mainpageText, 'module' => 'message', $C => 'text' ], + [ 'code' => 'overriddenCode', 'text' => $mainpageText, + 'data' => $overriddenData, 'module' => 'messageWithData', $C => 'text' ], + $I => 'warning', ], ], [ 'errors' => [ - 'status' => [ - [ 'code' => 'mainpage', 'text' => $mainpageText, $C => 'text' ], - [ 'code' => 'parentheses', 'text' => $parensText, $C => 'text' ], - $I => 'error', - ], + [ 'code' => 'mainpage', 'text' => $mainpageText, 'module' => 'status', $C => 'text' ], + [ 'code' => 'parentheses', 'text' => $parensText, 'module' => 'status', $C => 'text' ], + $I => 'error', ], 'warnings' => [ - 'status' => [ - [ 'code' => 'mainpage', 'text' => $mainpageText, $C => 'text' ], - [ 'code' => 'parentheses', 'text' => $parensText, $C => 'text' ], - [ 'code' => 'overriddenCode', 'text' => $mainpageText, - 'overriddenData' => true, $C => 'text' ], - $I => 'warning', - ], + [ 'code' => 'mainpage', 'text' => $mainpageText, 'module' => 'status', $C => 'text' ], + [ 'code' => 'parentheses', 'text' => $parensText, 'module' => 'status', $C => 'text' ], + [ 'code' => 'overriddenCode', 'text' => $mainpageText, + 'data' => $overriddenData, 'module' => 'status', $C => 'text' ], + $I => 'warning', + ], + ], + ], + [ 'plaintext' ] + $tmp, // For these messages, plaintext and wikitext are the same + [ 'html', 'en', true, + [ + 'errors' => [ + [ 'code' => 'mainpage', 'html' => $mainpageHTML, 'module' => 'err', $C => 'html' ], + $I => 'error', + ], + 'warnings' => [ + [ 'code' => 'mainpage', 'html' => $mainpageHTML, 'module' => 'string', $C => 'html' ], + $I => 'warning', + ], + ], + [ + 'errors' => [ + [ 'code' => 'overriddenCode', 'html' => $mainpageHTML, + 'data' => $overriddenData, 'module' => 'errWithData', $C => 'html' ], + $I => 'error', + ], + 'warnings' => [ + [ 'code' => 'mainpage', 'html' => $mainpageHTML, 'module' => 'foo', $C => 'html' ], + [ 'code' => 'parentheses', 'html' => $parensHTML, 'module' => 'foo', $C => 'html' ], + [ 'code' => 'mainpage', 'html' => $mainpageHTML, 'module' => 'message', $C => 'html' ], + [ 'code' => 'overriddenCode', 'html' => $mainpageHTML, + 'data' => $overriddenData, 'module' => 'messageWithData', $C => 'html' ], + $I => 'warning', + ], + ], + [ + 'errors' => [ + [ 'code' => 'mainpage', 'html' => $mainpageHTML, 'module' => 'status', $C => 'html' ], + [ 'code' => 'parentheses', 'html' => $parensHTML, 'module' => 'status', $C => 'html' ], + $I => 'error', + ], + 'warnings' => [ + [ 'code' => 'mainpage', 'html' => $mainpageHTML, 'module' => 'status', $C => 'html' ], + [ 'code' => 'parentheses', 'html' => $parensHTML, 'module' => 'status', $C => 'html' ], + [ 'code' => 'overriddenCode', 'html' => $mainpageHTML, + 'data' => $overriddenData, 'module' => 'status', $C => 'html' ], + $I => 'warning', ], ], ], [ 'raw', 'fr', true, [ 'errors' => [ - 'err' => [ - [ - 'code' => 'mainpage', - 'key' => 'mainpage', - 'params' => [ $I => 'param' ] - ], - $I => 'error', + [ + 'code' => 'mainpage', + 'key' => 'mainpage', + 'params' => [ $I => 'param' ], + 'module' => 'err', ], + $I => 'error', ], 'warnings' => [ - 'string' => [ - [ - 'code' => 'mainpage', - 'key' => 'mainpage', - 'params' => [ $I => 'param' ] - ], - $I => 'warning', + [ + 'code' => 'mainpage', + 'key' => 'mainpage', + 'params' => [ $I => 'param' ], + 'module' => 'string', ], + $I => 'warning', ], ], [ 'errors' => [ - 'errWithData' => [ - [ - 'code' => 'overriddenCode', - 'key' => 'mainpage', - 'params' => [ $I => 'param' ], - 'overriddenData' => true - ], - $I => 'error', + [ + 'code' => 'overriddenCode', + 'key' => 'mainpage', + 'params' => [ $I => 'param' ], + 'data' => $overriddenData, + 'module' => 'errWithData', ], + $I => 'error', ], 'warnings' => [ - 'messageWithData' => [ - [ - 'code' => 'overriddenCode', - 'key' => 'mainpage', - 'params' => [ $I => 'param' ], - 'overriddenData' => true - ], - $I => 'warning', + [ + 'code' => 'mainpage', + 'key' => 'mainpage', + 'params' => [ $I => 'param' ], + 'module' => 'foo', + ], + [ + 'code' => 'parentheses', + 'key' => 'parentheses', + 'params' => [ 'foobar', $I => 'param' ], + 'module' => 'foo', ], - 'message' => [ - [ - 'code' => 'mainpage', - 'key' => 'mainpage', - 'params' => [ $I => 'param' ] - ], - $I => 'warning', + [ + 'code' => 'mainpage', + 'key' => 'mainpage', + 'params' => [ $I => 'param' ], + 'module' => 'message', ], - 'foo' => [ - [ - 'code' => 'mainpage', - 'key' => 'mainpage', - 'params' => [ $I => 'param' ] - ], - [ - 'code' => 'parentheses', - 'key' => 'parentheses', - 'params' => [ 'foobar', $I => 'param' ] - ], - $I => 'warning', + [ + 'code' => 'overriddenCode', + 'key' => 'mainpage', + 'params' => [ $I => 'param' ], + 'data' => $overriddenData, + 'module' => 'messageWithData', ], + $I => 'warning', ], ], [ 'errors' => [ - 'status' => [ - [ - 'code' => 'mainpage', - 'key' => 'mainpage', - 'params' => [ $I => 'param' ] - ], - [ - 'code' => 'parentheses', - 'key' => 'parentheses', - 'params' => [ 'foobar', $I => 'param' ] - ], - $I => 'error', + [ + 'code' => 'mainpage', + 'key' => 'mainpage', + 'params' => [ $I => 'param' ], + 'module' => 'status', + ], + [ + 'code' => 'parentheses', + 'key' => 'parentheses', + 'params' => [ 'foobar', $I => 'param' ], + 'module' => 'status', ], + $I => 'error', ], 'warnings' => [ - 'status' => [ - [ - 'code' => 'mainpage', - 'key' => 'mainpage', - 'params' => [ $I => 'param' ] - ], - [ - 'code' => 'parentheses', - 'key' => 'parentheses', - 'params' => [ 'foobar', $I => 'param' ] - ], - [ - 'code' => 'overriddenCode', - 'key' => 'mainpage', - 'params' => [ $I => 'param' ], - 'overriddenData' => true - ], - $I => 'warning', + [ + 'code' => 'mainpage', + 'key' => 'mainpage', + 'params' => [ $I => 'param' ], + 'module' => 'status', ], + [ + 'code' => 'parentheses', + 'key' => 'parentheses', + 'params' => [ 'foobar', $I => 'param' ], + 'module' => 'status', + ], + [ + 'code' => 'overriddenCode', + 'key' => 'mainpage', + 'params' => [ $I => 'param' ], + 'data' => $overriddenData, + 'module' => 'status', + ], + $I => 'warning', ], ], ], [ 'none', 'fr', true, [ 'errors' => [ - 'err' => [ - [ 'code' => 'mainpage' ], - $I => 'error', - ], + [ 'code' => 'mainpage', 'module' => 'err' ], + $I => 'error', ], 'warnings' => [ - 'string' => [ - [ 'code' => 'mainpage' ], - $I => 'warning', - ], + [ 'code' => 'mainpage', 'module' => 'string' ], + $I => 'warning', ], ], [ 'errors' => [ - 'errWithData' => [ - [ 'code' => 'overriddenCode', 'overriddenData' => true ], - $I => 'error', - ], + [ 'code' => 'overriddenCode', 'data' => $overriddenData, + 'module' => 'errWithData' ], + $I => 'error', ], 'warnings' => [ - 'messageWithData' => [ - [ 'code' => 'overriddenCode', 'overriddenData' => true ], - $I => 'warning', - ], - 'message' => [ - [ 'code' => 'mainpage' ], - $I => 'warning', - ], - 'foo' => [ - [ 'code' => 'mainpage' ], - [ 'code' => 'parentheses' ], - $I => 'warning', - ], + [ 'code' => 'mainpage', 'module' => 'foo' ], + [ 'code' => 'parentheses', 'module' => 'foo' ], + [ 'code' => 'mainpage', 'module' => 'message' ], + [ 'code' => 'overriddenCode', 'data' => $overriddenData, + 'module' => 'messageWithData' ], + $I => 'warning', ], ], [ 'errors' => [ - 'status' => [ - [ 'code' => 'mainpage' ], - [ 'code' => 'parentheses' ], - $I => 'error', - ], + [ 'code' => 'mainpage', 'module' => 'status' ], + [ 'code' => 'parentheses', 'module' => 'status' ], + $I => 'error', ], 'warnings' => [ - 'status' => [ - [ 'code' => 'mainpage' ], - [ 'code' => 'parentheses' ], - [ 'code' => 'overriddenCode', 'overriddenData' => true ], - $I => 'warning', - ], + [ 'code' => 'mainpage', 'module' => 'status' ], + [ 'code' => 'parentheses', 'module' => 'status' ], + [ 'code' => 'overriddenCode', 'data' => $overriddenData, 'module' => 'status' ], + $I => 'warning', ], ], ], @@ -302,7 +348,14 @@ class ApiErrorFormatterTest extends MediaWikiLangTestCase { $result = new ApiResult( 8388608 ); $formatter = new ApiErrorFormatter_BackCompat( $result ); + $this->assertSame( 'en', $formatter->getLanguage()->getCode() ); + + $this->assertSame( [], $formatter->arrayFromStatus( Status::newGood() ) ); + $formatter->addWarning( 'string', 'mainpage' ); + $formatter->addWarning( 'raw', + new RawMessage( 'Blah kbd <X> 😞' ) + ); $formatter->addError( 'err', 'mainpage' ); $this->assertSame( [ 'error' => [ @@ -310,6 +363,10 @@ class ApiErrorFormatterTest extends MediaWikiLangTestCase { 'info' => $mainpagePlain, ], 'warnings' => [ + 'raw' => [ + 'warnings' => 'Blah "kbd" ð', + ApiResult::META_CONTENT => 'warnings', + ], 'string' => [ 'warnings' => $mainpagePlain, ApiResult::META_CONTENT => 'warnings', @@ -321,12 +378,13 @@ class ApiErrorFormatterTest extends MediaWikiLangTestCase { $result->reset(); $formatter->addWarning( 'foo', 'mainpage' ); $formatter->addWarning( 'foo', 'mainpage' ); - $formatter->addWarning( 'foo', [ 'parentheses', 'foobar' ] ); + $formatter->addWarning( 'xxx+foo', [ 'parentheses', 'foobar' ] ); $msg1 = wfMessage( 'mainpage' ); $formatter->addWarning( 'message', $msg1 ); $msg2 = new ApiMessage( 'mainpage', 'overriddenCode', [ 'overriddenData' => true ] ); $formatter->addWarning( 'messageWithData', $msg2 ); $formatter->addError( 'errWithData', $msg2 ); + $formatter->addWarning( null, 'mainpage' ); $this->assertSame( [ 'error' => [ 'code' => 'overriddenCode', @@ -334,6 +392,10 @@ class ApiErrorFormatterTest extends MediaWikiLangTestCase { 'overriddenData' => true, ], 'warnings' => [ + 'unknown' => [ + 'warnings' => $mainpagePlain, + ApiResult::META_CONTENT => 'warnings', + ], 'messageWithData' => [ 'warnings' => $mainpagePlain, ApiResult::META_CONTENT => 'warnings', @@ -350,6 +412,22 @@ class ApiErrorFormatterTest extends MediaWikiLangTestCase { ApiResult::META_TYPE => 'assoc', ], $result->getResultData(), 'Complex test' ); + $this->assertSame( + [ + 'code' => 'mainpage', + 'info' => 'Main Page', + ], + $formatter->formatMessage( $msg1 ) + ); + $this->assertSame( + [ + 'code' => 'overriddenCode', + 'info' => 'Main Page', + 'overriddenData' => true, + ], + $formatter->formatMessage( $msg2 ) + ); + $result->reset(); $status = Status::newGood(); $status->warning( 'mainpage' ); @@ -377,14 +455,16 @@ class ApiErrorFormatterTest extends MediaWikiLangTestCase { $this->assertSame( [ [ - 'type' => 'error', 'message' => 'mainpage', - 'params' => [ $I => 'param' ] + 'params' => [ $I => 'param' ], + 'code' => 'mainpage', + 'type' => 'error', ], [ - 'type' => 'error', 'message' => 'parentheses', - 'params' => [ 'foobar', $I => 'param' ] + 'params' => [ 'foobar', $I => 'param' ], + 'code' => 'parentheses', + 'type' => 'error', ], $I => 'error', ], @@ -394,24 +474,28 @@ class ApiErrorFormatterTest extends MediaWikiLangTestCase { $this->assertSame( [ [ - 'type' => 'warning', 'message' => 'mainpage', - 'params' => [ $I => 'param' ] + 'params' => [ $I => 'param' ], + 'code' => 'mainpage', + 'type' => 'warning', ], [ - 'type' => 'warning', 'message' => 'parentheses', - 'params' => [ 'foobar', $I => 'param' ] + 'params' => [ 'foobar', $I => 'param' ], + 'code' => 'parentheses', + 'type' => 'warning', ], [ 'message' => 'mainpage', 'params' => [ $I => 'param' ], - 'type' => 'warning' + 'code' => 'mainpage', + 'type' => 'warning', ], [ 'message' => 'mainpage', 'params' => [ $I => 'param' ], - 'type' => 'warning' + 'code' => 'overriddenCode', + 'type' => 'warning', ], $I => 'warning', ], diff --git a/tests/phpunit/includes/api/ApiMainTest.php b/tests/phpunit/includes/api/ApiMainTest.php index c111949d2f..c9a3428da1 100644 --- a/tests/phpunit/includes/api/ApiMainTest.php +++ b/tests/phpunit/includes/api/ApiMainTest.php @@ -53,8 +53,8 @@ class ApiMainTest extends ApiTestCase { 'assert' => $assert, ], null, null, $user ); $this->assertFalse( $error ); // That no error was expected - } catch ( UsageException $e ) { - $this->assertEquals( $e->getCodeString(), $error ); + } catch ( ApiUsageException $e ) { + $this->assertTrue( self::apiExceptionHasCode( $e, $error ) ); } } @@ -76,8 +76,8 @@ class ApiMainTest extends ApiTestCase { 'assertuser' => $user->getName() . 'X', ], null, null, $user ); $this->fail( 'Expected exception not thrown' ); - } catch ( UsageException $e ) { - $this->assertEquals( $e->getCodeString(), 'assertnameduserfailed' ); + } catch ( ApiUsageException $e ) { + $this->assertTrue( self::apiExceptionHasCode( $e, 'assertnameduserfailed' ) ); } } @@ -305,4 +305,274 @@ class ApiMainTest extends ApiTestCase { $main = new ApiMain( new FauxRequest( [ 'action' => 'query', 'meta' => 'siteinfo' ] ) ); $this->assertTrue( $main->lacksSameOriginSecurity(), 'Hook, should lack security' ); } + + /** + * Test proper creation of the ApiErrorFormatter + * @covers ApiMain::__construct + * @dataProvider provideApiErrorFormatterCreation + * @param array $request Request parameters + * @param array $expect Expected data + * - uselang: ApiMain language + * - class: ApiErrorFormatter class + * - lang: ApiErrorFormatter language + * - format: ApiErrorFormatter format + * - usedb: ApiErrorFormatter use-database flag + */ + public function testApiErrorFormatterCreation( array $request, array $expect ) { + $context = new RequestContext(); + $context->setRequest( new FauxRequest( $request ) ); + $context->setLanguage( 'ru' ); + + $main = new ApiMain( $context ); + $formatter = $main->getErrorFormatter(); + $wrappedFormatter = TestingAccessWrapper::newFromObject( $formatter ); + + $this->assertSame( $expect['uselang'], $main->getLanguage()->getCode() ); + $this->assertInstanceOf( $expect['class'], $formatter ); + $this->assertSame( $expect['lang'], $formatter->getLanguage()->getCode() ); + $this->assertSame( $expect['format'], $wrappedFormatter->format ); + $this->assertSame( $expect['usedb'], $wrappedFormatter->useDB ); + } + + public static function provideApiErrorFormatterCreation() { + global $wgContLang; + + return [ + 'Default (BC)' => [ [], [ + 'uselang' => 'ru', + 'class' => ApiErrorFormatter_BackCompat::class, + 'lang' => 'en', + 'format' => 'none', + 'usedb' => false, + ] ], + 'BC ignores fields' => [ [ 'errorlang' => 'de', 'errorsuselocal' => 1 ], [ + 'uselang' => 'ru', + 'class' => ApiErrorFormatter_BackCompat::class, + 'lang' => 'en', + 'format' => 'none', + 'usedb' => false, + ] ], + 'Explicit BC' => [ [ 'errorformat' => 'bc' ], [ + 'uselang' => 'ru', + 'class' => ApiErrorFormatter_BackCompat::class, + 'lang' => 'en', + 'format' => 'none', + 'usedb' => false, + ] ], + 'Basic' => [ [ 'errorformat' => 'wikitext' ], [ + 'uselang' => 'ru', + 'class' => ApiErrorFormatter::class, + 'lang' => 'ru', + 'format' => 'wikitext', + 'usedb' => false, + ] ], + 'Follows uselang' => [ [ 'uselang' => 'fr', 'errorformat' => 'plaintext' ], [ + 'uselang' => 'fr', + 'class' => ApiErrorFormatter::class, + 'lang' => 'fr', + 'format' => 'plaintext', + 'usedb' => false, + ] ], + 'Explicitly follows uselang' => [ + [ 'uselang' => 'fr', 'errorlang' => 'uselang', 'errorformat' => 'plaintext' ], + [ + 'uselang' => 'fr', + 'class' => ApiErrorFormatter::class, + 'lang' => 'fr', + 'format' => 'plaintext', + 'usedb' => false, + ] + ], + 'uselang=content' => [ + [ 'uselang' => 'content', 'errorformat' => 'plaintext' ], + [ + 'uselang' => $wgContLang->getCode(), + 'class' => ApiErrorFormatter::class, + 'lang' => $wgContLang->getCode(), + 'format' => 'plaintext', + 'usedb' => false, + ] + ], + 'errorlang=content' => [ + [ 'errorlang' => 'content', 'errorformat' => 'plaintext' ], + [ + 'uselang' => 'ru', + 'class' => ApiErrorFormatter::class, + 'lang' => $wgContLang->getCode(), + 'format' => 'plaintext', + 'usedb' => false, + ] + ], + 'Explicit parameters' => [ + [ 'errorlang' => 'de', 'errorformat' => 'html', 'errorsuselocal' => 1 ], + [ + 'uselang' => 'ru', + 'class' => ApiErrorFormatter::class, + 'lang' => 'de', + 'format' => 'html', + 'usedb' => true, + ] + ], + 'Explicit parameters override uselang' => [ + [ 'errorlang' => 'de', 'uselang' => 'fr', 'errorformat' => 'raw' ], + [ + 'uselang' => 'fr', + 'class' => ApiErrorFormatter::class, + 'lang' => 'de', + 'format' => 'raw', + 'usedb' => false, + ] + ], + 'Bogus language doesn\'t explode' => [ + [ 'errorlang' => '', 'uselang' => '', 'errorformat' => 'none' ], + [ + 'uselang' => 'en', + 'class' => ApiErrorFormatter::class, + 'lang' => 'en', + 'format' => 'none', + 'usedb' => false, + ] + ], + 'Bogus format doesn\'t explode' => [ [ 'errorformat' => 'bogus' ], [ + 'uselang' => 'ru', + 'class' => ApiErrorFormatter_BackCompat::class, + 'lang' => 'en', + 'format' => 'none', + 'usedb' => false, + ] ], + ]; + } + + /** + * @covers ApiMain::errorMessagesFromException + * @covers ApiMain::substituteResultWithError + * @dataProvider provideExceptionErrors + * @param Exception $exception + * @param array $expectReturn + * @param array $expectResult + */ + public function testExceptionErrors( $error, $expectReturn, $expectResult ) { + $context = new RequestContext(); + $context->setRequest( new FauxRequest( [ 'errorformat' => 'plaintext' ] ) ); + $context->setLanguage( 'en' ); + $context->setConfig( new MultiConfig( [ + new HashConfig( [ 'ShowHostnames' => true, 'ShowSQLErrors' => false ] ), + $context->getConfig() + ] ) ); + + $main = new ApiMain( $context ); + $main->addWarning( new RawMessage( 'existing warning' ), 'existing-warning' ); + $main->addError( new RawMessage( 'existing error' ), 'existing-error' ); + + $ret = TestingAccessWrapper::newFromObject( $main )->substituteResultWithError( $error ); + $this->assertSame( $expectReturn, $ret ); + + // PHPUnit sometimes adds some SplObjectStorage garbage to the arrays, + // so let's try ->assertEquals(). + $this->assertEquals( + $expectResult, + $main->getResult()->getResultData( [], [ 'Strip' => 'all' ] ) + ); + } + + // Not static so $this->getMock() can be used + public function provideExceptionErrors() { + $reqId = WebRequest::getRequestId(); + $doclink = wfExpandUrl( wfScript( 'api' ) ); + + $ex = new InvalidArgumentException( 'Random exception' ); + $trace = wfMessage( 'api-exception-trace', + get_class( $ex ), + $ex->getFile(), + $ex->getLine(), + MWExceptionHandler::getRedactedTraceAsString( $ex ) + )->inLanguage( 'en' )->useDatabase( false )->text(); + + $dbex = new DBQueryError( $this->getMock( 'IDatabase' ), 'error', 1234, 'SELECT 1', __METHOD__ ); + $dbtrace = wfMessage( 'api-exception-trace', + get_class( $dbex ), + $dbex->getFile(), + $dbex->getLine(), + MWExceptionHandler::getRedactedTraceAsString( $dbex ) + )->inLanguage( 'en' )->useDatabase( false )->text(); + + $apiEx1 = new ApiUsageException( null, + StatusValue::newFatal( new ApiRawMessage( 'An error', 'sv-error1' ) ) ); + TestingAccessWrapper::newFromObject( $apiEx1 )->modulePath = 'foo+bar'; + $apiEx1->getStatusValue()->warning( new ApiRawMessage( 'A warning', 'sv-warn1' ) ); + $apiEx1->getStatusValue()->warning( new ApiRawMessage( 'Another warning', 'sv-warn2' ) ); + $apiEx1->getStatusValue()->fatal( new ApiRawMessage( 'Another error', 'sv-error2' ) ); + + return [ + [ + $ex, + [ 'existing-error', 'internal_api_error_InvalidArgumentException' ], + [ + 'warnings' => [ + [ 'code' => 'existing-warning', 'text' => 'existing warning', 'module' => 'main' ], + ], + 'errors' => [ + [ 'code' => 'existing-error', 'text' => 'existing error', 'module' => 'main' ], + [ + 'code' => 'internal_api_error_InvalidArgumentException', + 'text' => "[$reqId] Exception caught: Random exception", + ] + ], + 'trace' => $trace, + 'servedby' => wfHostname(), + ] + ], + [ + $dbex, + [ 'existing-error', 'internal_api_error_DBQueryError' ], + [ + 'warnings' => [ + [ 'code' => 'existing-warning', 'text' => 'existing warning', 'module' => 'main' ], + ], + 'errors' => [ + [ 'code' => 'existing-error', 'text' => 'existing error', 'module' => 'main' ], + [ + 'code' => 'internal_api_error_DBQueryError', + 'text' => "[$reqId] Database query error.", + ] + ], + 'trace' => $dbtrace, + 'servedby' => wfHostname(), + ] + ], + [ + new UsageException( 'Usage exception!', 'ue', 0, [ 'foo' => 'bar' ] ), + [ 'existing-error', 'ue' ], + [ + 'warnings' => [ + [ 'code' => 'existing-warning', 'text' => 'existing warning', 'module' => 'main' ], + ], + 'errors' => [ + [ 'code' => 'existing-error', 'text' => 'existing error', 'module' => 'main' ], + [ 'code' => 'ue', 'text' => "Usage exception!", 'data' => [ 'foo' => 'bar' ] ] + ], + 'docref' => "See $doclink for API usage.", + 'servedby' => wfHostname(), + ] + ], + [ + $apiEx1, + [ 'existing-error', 'sv-error1', 'sv-error2' ], + [ + 'warnings' => [ + [ 'code' => 'existing-warning', 'text' => 'existing warning', 'module' => 'main' ], + [ 'code' => 'sv-warn1', 'text' => 'A warning', 'module' => 'foo+bar' ], + [ 'code' => 'sv-warn2', 'text' => 'Another warning', 'module' => 'foo+bar' ], + ], + 'errors' => [ + [ 'code' => 'existing-error', 'text' => 'existing error', 'module' => 'main' ], + [ 'code' => 'sv-error1', 'text' => 'An error', 'module' => 'foo+bar' ], + [ 'code' => 'sv-error2', 'text' => 'Another error', 'module' => 'foo+bar' ], + ], + 'docref' => "See $doclink for API usage.", + 'servedby' => wfHostname(), + ] + ], + ]; + } } diff --git a/tests/phpunit/includes/api/ApiMessageTest.php b/tests/phpunit/includes/api/ApiMessageTest.php index a45015a7b3..e405b3b895 100644 --- a/tests/phpunit/includes/api/ApiMessageTest.php +++ b/tests/phpunit/includes/api/ApiMessageTest.php @@ -5,17 +5,17 @@ */ class ApiMessageTest extends MediaWikiTestCase { - private function compareMessages( $msg, $msg2 ) { + private function compareMessages( Message $msg, Message $msg2 ) { $this->assertSame( $msg->getKey(), $msg2->getKey(), 'getKey' ); $this->assertSame( $msg->getKeysToTry(), $msg2->getKeysToTry(), 'getKeysToTry' ); $this->assertSame( $msg->getParams(), $msg2->getParams(), 'getParams' ); - $this->assertSame( $msg->getFormat(), $msg2->getFormat(), 'getFormat' ); $this->assertSame( $msg->getLanguage(), $msg2->getLanguage(), 'getLanguage' ); $msg = TestingAccessWrapper::newFromObject( $msg ); $msg2 = TestingAccessWrapper::newFromObject( $msg2 ); $this->assertSame( $msg->interface, $msg2->interface, 'interface' ); $this->assertSame( $msg->useDatabase, $msg2->useDatabase, 'useDatabase' ); + $this->assertSame( $msg->format, $msg2->format, 'format' ); $this->assertSame( $msg->title ? $msg->title->getFullText() : null, $msg2->title ? $msg2->title->getFullText() : null, @@ -23,6 +23,56 @@ class ApiMessageTest extends MediaWikiTestCase { ); } + /** + * @covers ApiMessageTrait + */ + public function testCodeDefaults() { + $msg = new ApiMessage( 'foo' ); + $this->assertSame( 'foo', $msg->getApiCode() ); + + $msg = new ApiMessage( 'apierror-bar' ); + $this->assertSame( 'bar', $msg->getApiCode() ); + + $msg = new ApiMessage( 'apiwarn-baz' ); + $this->assertSame( 'baz', $msg->getApiCode() ); + + // BC case + $msg = new ApiMessage( 'actionthrottledtext' ); + $this->assertSame( 'ratelimited', $msg->getApiCode() ); + + $msg = new ApiMessage( [ 'apierror-missingparam', 'param' ] ); + $this->assertSame( 'noparam', $msg->getApiCode() ); + } + + /** + * @covers ApiMessageTrait + * @dataProvider provideInvalidCode + * @param mixed $code + */ + public function testInvalidCode( $code ) { + $msg = new ApiMessage( 'foo' ); + try { + $msg->setApiCode( $code ); + $this->fail( 'Expected exception not thrown' ); + } catch ( InvalidArgumentException $ex ) { + $this->assertTrue( true ); + } + + try { + new ApiMessage( 'foo', $code ); + $this->fail( 'Expected exception not thrown' ); + } catch ( InvalidArgumentException $ex ) { + $this->assertTrue( true ); + } + } + + public static function provideInvalidCode() { + return [ + [ '' ], + [ 42 ], + ]; + } + /** * @covers ApiMessage * @covers ApiMessageTrait @@ -105,14 +155,32 @@ class ApiMessageTest extends MediaWikiTestCase { * @covers ApiMessage::create */ public function testApiMessageCreate() { - $this->assertInstanceOf( 'ApiMessage', ApiMessage::create( new Message( 'mainpage' ) ) ); - $this->assertInstanceOf( 'ApiRawMessage', ApiMessage::create( new RawMessage( 'mainpage' ) ) ); - $this->assertInstanceOf( 'ApiMessage', ApiMessage::create( 'mainpage' ) ); + $this->assertInstanceOf( ApiMessage::class, ApiMessage::create( new Message( 'mainpage' ) ) ); + $this->assertInstanceOf( + ApiRawMessage::class, ApiMessage::create( new RawMessage( 'mainpage' ) ) + ); + $this->assertInstanceOf( ApiMessage::class, ApiMessage::create( 'mainpage' ) ); + + $msg = new ApiMessage( [ 'parentheses', 'foobar' ] ); + $msg2 = new Message( 'parentheses', [ 'foobar' ] ); - $msg = new ApiMessage( 'mainpage' ); $this->assertSame( $msg, ApiMessage::create( $msg ) ); + $this->assertEquals( $msg, ApiMessage::create( $msg2 ) ); + $this->assertEquals( $msg, ApiMessage::create( [ 'parentheses', 'foobar' ] ) ); + $this->assertEquals( $msg, + ApiMessage::create( [ 'message' => 'parentheses', 'params' => [ 'foobar' ] ] ) + ); + $this->assertSame( $msg, + ApiMessage::create( [ 'message' => $msg, 'params' => [ 'xxx' ] ] ) + ); + $this->assertEquals( $msg, + ApiMessage::create( [ 'message' => $msg2, 'params' => [ 'xxx' ] ] ) + ); + $this->assertSame( $msg, + ApiMessage::create( [ 'message' => $msg ] ) + ); - $msg = new ApiRawMessage( 'mainpage' ); + $msg = new ApiRawMessage( [ 'parentheses', 'foobar' ] ); $this->assertSame( $msg, ApiMessage::create( $msg ) ); } diff --git a/tests/phpunit/includes/api/ApiOptionsTest.php b/tests/phpunit/includes/api/ApiOptionsTest.php index 0a577c1cb6..ef70626120 100644 --- a/tests/phpunit/includes/api/ApiOptionsTest.php +++ b/tests/phpunit/includes/api/ApiOptionsTest.php @@ -30,7 +30,7 @@ class ApiOptionsTest extends MediaWikiLangTestCase { $this->mUserMock->expects( $this->any() ) ->method( 'getEffectiveGroups' )->will( $this->returnValue( [ '*', 'user' ] ) ); $this->mUserMock->expects( $this->any() ) - ->method( 'isAllowed' )->will( $this->returnValue( true ) ); + ->method( 'isAllowedAny' )->will( $this->returnValue( true ) ); // Set up callback for User::getOptionKinds $this->mUserMock->expects( $this->any() ) @@ -146,7 +146,7 @@ class ApiOptionsTest extends MediaWikiLangTestCase { } /** - * @expectedException UsageException + * @expectedException ApiUsageException */ public function testNoToken() { $request = $this->getSampleRequest( [ 'token' => null ] ); @@ -163,13 +163,11 @@ class ApiOptionsTest extends MediaWikiLangTestCase { $request = $this->getSampleRequest(); $this->executeQuery( $request ); - } catch ( UsageException $e ) { - $this->assertEquals( 'notloggedin', $e->getCodeString() ); - $this->assertEquals( 'Anonymous users cannot change preferences', $e->getMessage() ); - + } catch ( ApiUsageException $e ) { + $this->assertTrue( ApiTestCase::apiExceptionHasCode( $e, 'notloggedin' ) ); return; } - $this->fail( "UsageException was not thrown" ); + $this->fail( "ApiUsageException was not thrown" ); } public function testNoOptionname() { @@ -177,13 +175,11 @@ class ApiOptionsTest extends MediaWikiLangTestCase { $request = $this->getSampleRequest( [ 'optionvalue' => '1' ] ); $this->executeQuery( $request ); - } catch ( UsageException $e ) { - $this->assertEquals( 'nooptionname', $e->getCodeString() ); - $this->assertEquals( 'The optionname parameter must be set', $e->getMessage() ); - + } catch ( ApiUsageException $e ) { + $this->assertTrue( ApiTestCase::apiExceptionHasCode( $e, 'nooptionname' ) ); return; } - $this->fail( "UsageException was not thrown" ); + $this->fail( "ApiUsageException was not thrown" ); } public function testNoChanges() { @@ -200,13 +196,11 @@ class ApiOptionsTest extends MediaWikiLangTestCase { $request = $this->getSampleRequest(); $this->executeQuery( $request ); - } catch ( UsageException $e ) { - $this->assertEquals( 'nochanges', $e->getCodeString() ); - $this->assertEquals( 'No changes were requested', $e->getMessage() ); - + } catch ( ApiUsageException $e ) { + $this->assertTrue( ApiTestCase::apiExceptionHasCode( $e, 'nochanges' ) ); return; } - $this->fail( "UsageException was not thrown" ); + $this->fail( "ApiUsageException was not thrown" ); } public function testReset() { @@ -400,7 +394,7 @@ class ApiOptionsTest extends MediaWikiLangTestCase { 'options' => 'success', 'warnings' => [ 'options' => [ - 'warnings' => "Validation error for 'special': cannot be set by this module" + 'warnings' => "Validation error for \"special\": cannot be set by this module." ] ] ], $response ); @@ -423,7 +417,7 @@ class ApiOptionsTest extends MediaWikiLangTestCase { 'options' => 'success', 'warnings' => [ 'options' => [ - 'warnings' => "Validation error for 'unknownOption': not a valid preference" + 'warnings' => "Validation error for \"unknownOption\": not a valid preference." ] ] ], $response ); diff --git a/tests/phpunit/includes/api/ApiParseTest.php b/tests/phpunit/includes/api/ApiParseTest.php index b72a4f8a8b..f01a670b71 100644 --- a/tests/phpunit/includes/api/ApiParseTest.php +++ b/tests/phpunit/includes/api/ApiParseTest.php @@ -23,12 +23,10 @@ class ApiParseTest extends ApiTestCase { 'page' => $somePage ] ); $this->fail( "API did not return an error when parsing a nonexistent page" ); - } catch ( UsageException $ex ) { - $this->assertEquals( - 'missingtitle', - $ex->getCodeString(), + } catch ( ApiUsageException $ex ) { + $this->assertTrue( ApiTestCase::apiExceptionHasCode( $ex, 'missingtitle' ), "Parse request for nonexistent page must give 'missingtitle' error: " - . var_export( $ex->getMessageArray(), true ) + . var_export( self::getErrorFormatter()->arrayFromStatus( $ex->getStatusValue() ), true ) ); } } diff --git a/tests/phpunit/includes/api/ApiQueryWatchlistIntegrationTest.php b/tests/phpunit/includes/api/ApiQueryWatchlistIntegrationTest.php index eaeb3ae925..0a2cd83dd7 100644 --- a/tests/phpunit/includes/api/ApiQueryWatchlistIntegrationTest.php +++ b/tests/phpunit/includes/api/ApiQueryWatchlistIntegrationTest.php @@ -1498,7 +1498,7 @@ class ApiQueryWatchlistIntegrationTest extends ApiTestCase { $otherUser->setOption( 'watchlisttoken', '1234567890' ); $otherUser->saveSettings(); - $this->setExpectedException( UsageException::class, 'Incorrect watchlist token provided' ); + $this->setExpectedException( ApiUsageException::class, 'Incorrect watchlist token provided' ); $this->doListWatchlistRequest( [ 'wlowner' => $otherUser->getName(), @@ -1507,7 +1507,7 @@ class ApiQueryWatchlistIntegrationTest extends ApiTestCase { } public function testOwnerAndTokenParams_noWatchlistTokenSet() { - $this->setExpectedException( UsageException::class, 'Incorrect watchlist token provided' ); + $this->setExpectedException( ApiUsageException::class, 'Incorrect watchlist token provided' ); $this->doListWatchlistRequest( [ 'wlowner' => $this->getNonLoggedInTestUser()->getName(), diff --git a/tests/phpunit/includes/api/ApiQueryWatchlistRawIntegrationTest.php b/tests/phpunit/includes/api/ApiQueryWatchlistRawIntegrationTest.php index d6f315d5b3..0f01664e72 100644 --- a/tests/phpunit/includes/api/ApiQueryWatchlistRawIntegrationTest.php +++ b/tests/phpunit/includes/api/ApiQueryWatchlistRawIntegrationTest.php @@ -503,7 +503,7 @@ class ApiQueryWatchlistRawIntegrationTest extends ApiTestCase { $otherUser->setOption( 'watchlisttoken', '1234567890' ); $otherUser->saveSettings(); - $this->setExpectedException( UsageException::class, 'Incorrect watchlist token provided' ); + $this->setExpectedException( ApiUsageException::class, 'Incorrect watchlist token provided' ); $this->doListWatchlistRawRequest( [ 'wrowner' => $otherUser->getName(), @@ -512,7 +512,7 @@ class ApiQueryWatchlistRawIntegrationTest extends ApiTestCase { } public function testOwnerAndTokenParams_userHasNoWatchlistToken() { - $this->setExpectedException( UsageException::class, 'Incorrect watchlist token provided' ); + $this->setExpectedException( ApiUsageException::class, 'Incorrect watchlist token provided' ); $this->doListWatchlistRawRequest( [ 'wrowner' => $this->getNotLoggedInTestUser()->getName(), diff --git a/tests/phpunit/includes/api/ApiResultTest.php b/tests/phpunit/includes/api/ApiResultTest.php index 48472cff91..98e24fb666 100644 --- a/tests/phpunit/includes/api/ApiResultTest.php +++ b/tests/phpunit/includes/api/ApiResultTest.php @@ -1230,7 +1230,6 @@ class ApiResultTest extends MediaWikiTestCase { ], ], ]; - } /** @@ -1380,7 +1379,6 @@ class ApiResultTest extends MediaWikiTestCase { 'two' => 2, ], $arr['foo'] ); } - } class ApiResultTestStringifiableObject { diff --git a/tests/phpunit/includes/api/ApiRevisionDeleteTest.php b/tests/phpunit/includes/api/ApiRevisionDeleteTest.php index 6359983d6e..d8282be159 100644 --- a/tests/phpunit/includes/api/ApiRevisionDeleteTest.php +++ b/tests/phpunit/includes/api/ApiRevisionDeleteTest.php @@ -25,7 +25,6 @@ class ApiRevisionDeleteTest extends ApiTestCase { $this->revs[] = Title::newFromText( self::$page ) ->getLatestRevID( Title::GAID_FOR_UPDATE ); } - } public function testHidingRevisions() { diff --git a/tests/phpunit/includes/api/ApiTestCase.php b/tests/phpunit/includes/api/ApiTestCase.php index 7e1f9d8775..6b299c98c8 100644 --- a/tests/phpunit/includes/api/ApiTestCase.php +++ b/tests/phpunit/includes/api/ApiTestCase.php @@ -3,6 +3,8 @@ abstract class ApiTestCase extends MediaWikiLangTestCase { protected static $apiUrl; + protected static $errorFormatter = null; + /** * @var ApiTestContext */ @@ -196,6 +198,26 @@ abstract class ApiTestCase extends MediaWikiLangTestCase { return $data[0]['tokens']; } + protected static function getErrorFormatter() { + if ( self::$errorFormatter === null ) { + self::$errorFormatter = new ApiErrorFormatter( + new ApiResult( false ), + Language::factory( 'en' ), + 'none' + ); + } + return self::$errorFormatter; + } + + public static function apiExceptionHasCode( ApiUsageException $ex, $code ) { + return (bool)array_filter( + self::getErrorFormatter()->arrayFromStatus( $ex->getStatusValue() ), + function ( $e ) use ( $code ) { + return is_array( $e ) && $e['code'] === $code; + } + ); + } + public function testApiTestGroup() { $groups = PHPUnit_Util_Test::getGroups( get_class( $this ) ); $constraint = PHPUnit_Framework_Assert::logicalOr( diff --git a/tests/phpunit/includes/api/ApiUnblockTest.php b/tests/phpunit/includes/api/ApiUnblockTest.php index b63bf2ea31..971b63c3d4 100644 --- a/tests/phpunit/includes/api/ApiUnblockTest.php +++ b/tests/phpunit/includes/api/ApiUnblockTest.php @@ -14,7 +14,7 @@ class ApiUnblockTest extends ApiTestCase { } /** - * @expectedException UsageException + * @expectedException ApiUsageException */ public function testWithNoToken() { $this->doApiRequest( diff --git a/tests/phpunit/includes/api/ApiUploadTest.php b/tests/phpunit/includes/api/ApiUploadTest.php index de2b56bde3..9b79e6c538 100644 --- a/tests/phpunit/includes/api/ApiUploadTest.php +++ b/tests/phpunit/includes/api/ApiUploadTest.php @@ -67,9 +67,9 @@ class ApiUploadTest extends ApiTestCaseUpload { $this->doApiRequest( [ 'action' => 'upload' ] ); - } catch ( UsageException $e ) { + } catch ( ApiUsageException $e ) { $exception = true; - $this->assertEquals( "The token parameter must be set", $e->getMessage() ); + $this->assertEquals( 'The "token" parameter must be set', $e->getMessage() ); } $this->assertTrue( $exception, "Got exception" ); } @@ -83,7 +83,7 @@ class ApiUploadTest extends ApiTestCaseUpload { $this->doApiRequestWithToken( [ 'action' => 'upload', ], $session, self::$users['uploader']->getUser() ); - } catch ( UsageException $e ) { + } catch ( ApiUsageException $e ) { $exception = true; $this->assertEquals( "One of the parameters filekey, file, url is required", $e->getMessage() ); @@ -129,7 +129,7 @@ class ApiUploadTest extends ApiTestCaseUpload { try { list( $result, , ) = $this->doApiRequestWithToken( $params, $session, self::$users['uploader']->getUser() ); - } catch ( UsageException $e ) { + } catch ( ApiUsageException $e ) { $exception = true; } $this->assertTrue( isset( $result['upload'] ) ); @@ -168,7 +168,7 @@ class ApiUploadTest extends ApiTestCaseUpload { $exception = false; try { $this->doApiRequestWithToken( $params, $session, self::$users['uploader']->getUser() ); - } catch ( UsageException $e ) { + } catch ( ApiUsageException $e ) { $this->assertContains( 'The file you submitted was empty', $e->getMessage() ); $exception = true; } @@ -218,7 +218,7 @@ class ApiUploadTest extends ApiTestCaseUpload { try { list( $result, , $session ) = $this->doApiRequestWithToken( $params, $session, self::$users['uploader']->getUser() ); - } catch ( UsageException $e ) { + } catch ( ApiUsageException $e ) { $exception = true; } $this->assertTrue( isset( $result['upload'] ) ); @@ -235,7 +235,7 @@ class ApiUploadTest extends ApiTestCaseUpload { try { list( $result, , ) = $this->doApiRequestWithToken( $params, $session, self::$users['uploader']->getUser() ); // FIXME: leaks a temporary file - } catch ( UsageException $e ) { + } catch ( ApiUsageException $e ) { $exception = true; } $this->assertTrue( isset( $result['upload'] ) ); @@ -289,7 +289,7 @@ class ApiUploadTest extends ApiTestCaseUpload { try { list( $result, , $session ) = $this->doApiRequestWithToken( $params, $session, self::$users['uploader']->getUser() ); - } catch ( UsageException $e ) { + } catch ( ApiUsageException $e ) { $exception = true; } $this->assertTrue( isset( $result['upload'] ) ); @@ -314,7 +314,7 @@ class ApiUploadTest extends ApiTestCaseUpload { try { list( $result ) = $this->doApiRequestWithToken( $params, $session, self::$users['uploader']->getUser() ); // FIXME: leaks a temporary file - } catch ( UsageException $e ) { + } catch ( ApiUsageException $e ) { $exception = true; } $this->assertTrue( isset( $result['upload'] ) ); @@ -371,7 +371,7 @@ class ApiUploadTest extends ApiTestCaseUpload { try { list( $result, , $session ) = $this->doApiRequestWithToken( $params, $session, self::$users['uploader']->getUser() ); // FIXME: leaks a temporary file - } catch ( UsageException $e ) { + } catch ( ApiUsageException $e ) { $exception = true; } $this->assertFalse( $exception ); @@ -400,12 +400,12 @@ class ApiUploadTest extends ApiTestCaseUpload { try { list( $result ) = $this->doApiRequestWithToken( $params, $session, self::$users['uploader']->getUser() ); - } catch ( UsageException $e ) { + } catch ( ApiUsageException $e ) { $exception = true; } $this->assertTrue( isset( $result['upload'] ) ); $this->assertEquals( 'Success', $result['upload']['result'] ); - $this->assertFalse( $exception, "No UsageException exception." ); + $this->assertFalse( $exception, "No ApiUsageException exception." ); // clean up $this->deleteFileByFileName( $fileName ); @@ -476,7 +476,7 @@ class ApiUploadTest extends ApiTestCaseUpload { try { list( $result, , $session ) = $this->doApiRequestWithToken( $params, $session, self::$users['uploader']->getUser() ); - } catch ( UsageException $e ) { + } catch ( ApiUsageException $e ) { $this->markTestIncomplete( $e->getMessage() ); } // Make sure we got a valid chunk continue: @@ -504,7 +504,7 @@ class ApiUploadTest extends ApiTestCaseUpload { try { list( $result, , $session ) = $this->doApiRequestWithToken( $params, $session, self::$users['uploader']->getUser() ); - } catch ( UsageException $e ) { + } catch ( ApiUsageException $e ) { $this->markTestIncomplete( $e->getMessage() ); } // Make sure we got a valid chunk continue: @@ -544,7 +544,7 @@ class ApiUploadTest extends ApiTestCaseUpload { try { list( $result ) = $this->doApiRequestWithToken( $params, $session, self::$users['uploader']->getUser() ); - } catch ( UsageException $e ) { + } catch ( ApiUsageException $e ) { $exception = true; } $this->assertTrue( isset( $result['upload'] ) ); diff --git a/tests/phpunit/includes/api/ApiWatchTest.php b/tests/phpunit/includes/api/ApiWatchTest.php index 19afc148b7..7b91094b6c 100644 --- a/tests/phpunit/includes/api/ApiWatchTest.php +++ b/tests/phpunit/includes/api/ApiWatchTest.php @@ -16,8 +16,6 @@ class ApiWatchTest extends ApiTestCase { return $this->getTokenList( self::$users['sysop'] ); } - /** - */ public function testWatchEdit() { $tokens = $this->getTokens(); @@ -74,8 +72,6 @@ class ApiWatchTest extends ApiTestCase { return $data; } - /** - */ public function testWatchProtect() { $tokens = $this->getTokens(); @@ -92,8 +88,6 @@ class ApiWatchTest extends ApiTestCase { $this->assertArrayHasKey( 'edit', $data[0]['protect']['protections'][0] ); } - /** - */ public function testGetRollbackToken() { $this->getTokens(); @@ -146,11 +140,11 @@ class ApiWatchTest extends ApiTestCase { $this->assertArrayHasKey( 'rollback', $data[0] ); $this->assertArrayHasKey( 'title', $data[0]['rollback'] ); - } catch ( UsageException $ue ) { - if ( $ue->getCodeString() == 'onlyauthor' ) { + } catch ( ApiUsageException $ue ) { + if ( self::apiExceptionHasCode( $ue, 'onlyauthor' ) ) { $this->markTestIncomplete( "Only one author to 'Help:UTPage', cannot test rollback" ); } else { - $this->fail( "Received error '" . $ue->getCodeString() . "'" ); + $this->fail( "Received error '" . $ue->getMessage() . "'" ); } } } diff --git a/tests/phpunit/includes/api/MockApi.php b/tests/phpunit/includes/api/MockApi.php index d7db538273..1407c10d93 100644 --- a/tests/phpunit/includes/api/MockApi.php +++ b/tests/phpunit/includes/api/MockApi.php @@ -9,7 +9,11 @@ class MockApi extends ApiBase { public function __construct() { } - public function setWarning( $warning ) { + public function getModulePath() { + return $this->getModuleName(); + } + + public function addWarning( $warning, $code = null, $data = null ) { $this->warnings[] = $warning; } diff --git a/tests/phpunit/includes/api/MockApiQueryBase.php b/tests/phpunit/includes/api/MockApiQueryBase.php index f5b50e5a59..9915a38d0a 100644 --- a/tests/phpunit/includes/api/MockApiQueryBase.php +++ b/tests/phpunit/includes/api/MockApiQueryBase.php @@ -12,4 +12,8 @@ class MockApiQueryBase extends ApiQueryBase { public function getModuleName() { return $this->name; } + + public function getModulePath() { + return 'query+' . $this->getModuleName(); + } } diff --git a/tests/phpunit/includes/api/format/ApiFormatPhpTest.php b/tests/phpunit/includes/api/format/ApiFormatPhpTest.php index 0028bbb0ac..3aa1db3010 100644 --- a/tests/phpunit/includes/api/format/ApiFormatPhpTest.php +++ b/tests/phpunit/includes/api/format/ApiFormatPhpTest.php @@ -133,12 +133,10 @@ class ApiFormatPhpTest extends ApiFormatTestBase { $printer->closePrinter(); ob_end_clean(); $this->fail( 'Expected exception not thrown' ); - } catch ( UsageException $ex ) { + } catch ( ApiUsageException $ex ) { ob_end_clean(); - $this->assertSame( - 'This response cannot be represented using format=php. ' . - 'See https://phabricator.wikimedia.org/T68776', - $ex->getMessage(), + $this->assertTrue( + $ex->getStatusValue()->hasMessage( 'apierror-formatphp' ), 'Expected exception' ); } diff --git a/tests/phpunit/includes/api/format/ApiFormatXmlTest.php b/tests/phpunit/includes/api/format/ApiFormatXmlTest.php index 3fef0b0027..0f8c8ee6c1 100644 --- a/tests/phpunit/includes/api/format/ApiFormatXmlTest.php +++ b/tests/phpunit/includes/api/format/ApiFormatXmlTest.php @@ -105,11 +105,11 @@ class ApiFormatXmlTest extends ApiFormatTestBase { [ 'includexmlnamespace' => 1 ] ], // xslt param - [ [], 'Invalid or non-existent stylesheet specified', + [ [], 'Invalid or non-existent stylesheet specified.', [ 'xslt' => 'DoesNotExist' ] ], [ [], 'Stylesheet should be in the MediaWiki namespace.', [ 'xslt' => 'ApiFormatXmlTest' ] ], - [ [], 'Stylesheet should have .xsl extension.', + [ [], 'Stylesheet should have ".xsl" extension.', [ 'xslt' => 'MediaWiki:ApiFormatXmlTest' ] ], [ [], 'assertEquals( $expected, $api->titlePartToKey( $titlePart, $namespace ) ); - } catch ( UsageException $e ) { + } catch ( ApiUsageException $e ) { $exceptionCaught = true; } $this->assertEquals( $expectException, $exceptionCaught, - 'UsageException thrown by titlePartToKey' ); + 'ApiUsageException thrown by titlePartToKey' ); } function provideTestTitlePartToKey() { diff --git a/tests/phpunit/includes/auth/AbstractPasswordPrimaryAuthenticationProviderTest.php b/tests/phpunit/includes/auth/AbstractPasswordPrimaryAuthenticationProviderTest.php index a1cdf7e7cc..a57682b66e 100644 --- a/tests/phpunit/includes/auth/AbstractPasswordPrimaryAuthenticationProviderTest.php +++ b/tests/phpunit/includes/auth/AbstractPasswordPrimaryAuthenticationProviderTest.php @@ -2,6 +2,8 @@ namespace MediaWiki\Auth; +use MediaWiki\MediaWikiServices; + /** * @group AuthManager * @covers MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider @@ -26,7 +28,7 @@ class AbstractPasswordPrimaryAuthenticationProviderTest extends \MediaWikiTestCa $provider = $this->getMockForAbstractClass( AbstractPasswordPrimaryAuthenticationProvider::class ); - $provider->setConfig( \ConfigFactory::getDefaultInstance()->makeConfig( 'main' ) ); + $provider->setConfig( MediaWikiServices::getInstance()->getMainConfig() ); $providerPriv = \TestingAccessWrapper::newFromObject( $provider ); $obj = $providerPriv->getPasswordFactory(); @@ -38,7 +40,7 @@ class AbstractPasswordPrimaryAuthenticationProviderTest extends \MediaWikiTestCa $provider = $this->getMockForAbstractClass( AbstractPasswordPrimaryAuthenticationProvider::class ); - $provider->setConfig( \ConfigFactory::getDefaultInstance()->makeConfig( 'main' ) ); + $provider->setConfig( MediaWikiServices::getInstance()->getMainConfig() ); $provider->setLogger( new \Psr\Log\NullLogger() ); $providerPriv = \TestingAccessWrapper::newFromObject( $provider ); @@ -56,7 +58,7 @@ class AbstractPasswordPrimaryAuthenticationProviderTest extends \MediaWikiTestCa ); $provider->setConfig( new \MultiConfig( [ $config, - \ConfigFactory::getDefaultInstance()->makeConfig( 'main' ) + MediaWikiServices::getInstance()->getMainConfig() ] ) ); $provider->setLogger( new \Psr\Log\NullLogger() ); $providerPriv = \TestingAccessWrapper::newFromObject( $provider ); @@ -105,7 +107,7 @@ class AbstractPasswordPrimaryAuthenticationProviderTest extends \MediaWikiTestCa $provider = $this->getMockForAbstractClass( AbstractPasswordPrimaryAuthenticationProvider::class ); - $provider->setConfig( \ConfigFactory::getDefaultInstance()->makeConfig( 'main' ) ); + $provider->setConfig( MediaWikiServices::getInstance()->getMainConfig() ); $provider->setLogger( new \Psr\Log\NullLogger() ); $providerPriv = \TestingAccessWrapper::newFromObject( $provider ); @@ -121,7 +123,8 @@ class AbstractPasswordPrimaryAuthenticationProviderTest extends \MediaWikiTestCa ] ); $manager = new AuthManager( - new \FauxRequest(), \ConfigFactory::getDefaultInstance()->makeConfig( 'main' ) + new \FauxRequest(), + MediaWikiServices::getInstance()->getMainConfig() ); $provider = $this->getMockForAbstractClass( diff --git a/tests/phpunit/includes/auth/AuthManagerTest.php b/tests/phpunit/includes/auth/AuthManagerTest.php index 13486e2c43..f57db11b23 100644 --- a/tests/phpunit/includes/auth/AuthManagerTest.php +++ b/tests/phpunit/includes/auth/AuthManagerTest.php @@ -695,7 +695,6 @@ class AuthManagerTest extends \MediaWikiTestCase { $ex->getMessage() ); } - } public function testBeginAuthentication() { @@ -3265,7 +3264,6 @@ class AuthManagerTest extends \MediaWikiTestCase { $this->manager->removeAuthenticationSessionData( null ); $this->assertNull( $this->manager->getAuthenticationSessionData( 'foo' ) ); $this->assertNull( $this->manager->getAuthenticationSessionData( 'bar' ) ); - } public function testCanLinkAccounts() { diff --git a/tests/phpunit/includes/auth/EmailNotificationSecondaryAuthenticationProviderTest.php b/tests/phpunit/includes/auth/EmailNotificationSecondaryAuthenticationProviderTest.php index c52c3e9f54..ec4bea11a1 100644 --- a/tests/phpunit/includes/auth/EmailNotificationSecondaryAuthenticationProviderTest.php +++ b/tests/phpunit/includes/auth/EmailNotificationSecondaryAuthenticationProviderTest.php @@ -104,6 +104,5 @@ class EmailNotificationSecondaryAuthenticationProviderTest extends \PHPUnit_Fram $authManager->setAuthenticationSessionData( 'no-email', true ); $provider->setManager( $authManager ); $provider->beginSecondaryAccountCreation( $userNotExpectsConfirmation, $creator, [] ); - } } diff --git a/tests/phpunit/includes/auth/LegacyHookPreAuthenticationProviderTest.php b/tests/phpunit/includes/auth/LegacyHookPreAuthenticationProviderTest.php index d482453152..b96455e091 100644 --- a/tests/phpunit/includes/auth/LegacyHookPreAuthenticationProviderTest.php +++ b/tests/phpunit/includes/auth/LegacyHookPreAuthenticationProviderTest.php @@ -2,6 +2,8 @@ namespace MediaWiki\Auth; +use MediaWiki\MediaWikiServices; + /** * @group AuthManager * @group Database @@ -17,7 +19,8 @@ class LegacyHookPreAuthenticationProviderTest extends \MediaWikiTestCase { $request->expects( $this->any() )->method( 'getIP' )->will( $this->returnValue( '127.0.0.42' ) ); $manager = new AuthManager( - $request, \ConfigFactory::getDefaultInstance()->makeConfig( 'main' ) + $request, + MediaWikiServices::getInstance()->getMainConfig() ); $provider = new LegacyHookPreAuthenticationProvider(); diff --git a/tests/phpunit/includes/auth/LocalPasswordPrimaryAuthenticationProviderTest.php b/tests/phpunit/includes/auth/LocalPasswordPrimaryAuthenticationProviderTest.php index 088dd00fe8..72a03c311a 100644 --- a/tests/phpunit/includes/auth/LocalPasswordPrimaryAuthenticationProviderTest.php +++ b/tests/phpunit/includes/auth/LocalPasswordPrimaryAuthenticationProviderTest.php @@ -2,6 +2,8 @@ namespace MediaWiki\Auth; +use MediaWiki\MediaWikiServices; + /** * @group AuthManager * @group Database @@ -28,7 +30,7 @@ class LocalPasswordPrimaryAuthenticationProviderTest extends \MediaWikiTestCase } $config = new \MultiConfig( [ $this->config, - \ConfigFactory::getDefaultInstance()->makeConfig( 'main' ) + MediaWikiServices::getInstance()->getMainConfig() ] ); if ( !$this->manager ) { @@ -328,7 +330,6 @@ class LocalPasswordPrimaryAuthenticationProviderTest extends \MediaWikiTestCase AuthenticationResponse::newPass( $userName ), $provider->beginPrimaryAuthentication( $reqs ) ); - } /** @@ -450,7 +451,7 @@ class LocalPasswordPrimaryAuthenticationProviderTest extends \MediaWikiTestCase $changeReq->password = $newpass; $provider->providerChangeAuthenticationData( $changeReq ); - if ( $loginOnly ) { + if ( $loginOnly && $changed ) { $old = 'fail'; $new = 'fail'; $expectExpiry = null; @@ -645,7 +646,6 @@ class LocalPasswordPrimaryAuthenticationProviderTest extends \MediaWikiTestCase $this->assertNull( $provider->finishAccountCreation( $user, $user, $res2 ) ); $ret = $provider->beginPrimaryAuthentication( $reqs ); $this->assertEquals( AuthenticationResponse::PASS, $ret->status, 'new password is set' ); - } } diff --git a/tests/phpunit/includes/auth/TemporaryPasswordPrimaryAuthenticationProviderTest.php b/tests/phpunit/includes/auth/TemporaryPasswordPrimaryAuthenticationProviderTest.php index bc78c08f2c..bc7d65e81d 100644 --- a/tests/phpunit/includes/auth/TemporaryPasswordPrimaryAuthenticationProviderTest.php +++ b/tests/phpunit/includes/auth/TemporaryPasswordPrimaryAuthenticationProviderTest.php @@ -2,6 +2,7 @@ namespace MediaWiki\Auth; +use MediaWiki\MediaWikiServices; use Wikimedia\ScopedCallback; /** @@ -32,7 +33,7 @@ class TemporaryPasswordPrimaryAuthenticationProviderTest extends \MediaWikiTestC } $config = new \MultiConfig( [ $this->config, - \ConfigFactory::getDefaultInstance()->makeConfig( 'main' ) + MediaWikiServices::getInstance()->getMainConfig() ] ); if ( !$this->manager ) { @@ -347,7 +348,6 @@ class TemporaryPasswordPrimaryAuthenticationProviderTest extends \MediaWikiTestC 'wrongpassword', $ret->message->getKey() ); - } /** @@ -521,10 +521,6 @@ class TemporaryPasswordPrimaryAuthenticationProviderTest extends \MediaWikiTestC $provider = $this->getProvider( [ 'emailEnabled' => false ] ); $status = $provider->providerAllowsAuthenticationDataChange( $req, true ); $this->assertEquals( \StatusValue::newFatal( 'passwordreset-emaildisabled' ), $status ); - $req->hasBackchannel = true; - $status = $provider->providerAllowsAuthenticationDataChange( $req, true ); - $this->assertFalse( $status->hasMessage( 'passwordreset-emaildisabled' ) ); - $req->hasBackchannel = false; $provider = $this->getProvider( [ 'passwordReminderResendTime' => 10 ] ); $status = $provider->providerAllowsAuthenticationDataChange( $req, true ); @@ -687,18 +683,10 @@ class TemporaryPasswordPrimaryAuthenticationProviderTest extends \MediaWikiTestC $provider = $this->getProvider( [ 'emailEnabled' => false ] ); $status = $provider->testForAccountCreation( $user, $creator, [ $req ] ); $this->assertEquals( \StatusValue::newFatal( 'emaildisabled' ), $status ); - $req->hasBackchannel = true; - $status = $provider->testForAccountCreation( $user, $creator, [ $req ] ); - $this->assertFalse( $status->hasMessage( 'emaildisabled' ) ); - $req->hasBackchannel = false; $provider = $this->getProvider( [ 'emailEnabled' => true ] ); $status = $provider->testForAccountCreation( $user, $creator, [ $req ] ); $this->assertEquals( \StatusValue::newFatal( 'noemailcreate' ), $status ); - $req->hasBackchannel = true; - $status = $provider->testForAccountCreation( $user, $creator, [ $req ] ); - $this->assertFalse( $status->hasMessage( 'noemailcreate' ) ); - $req->hasBackchannel = false; $user->setEmail( 'test@localhost.localdomain' ); $status = $provider->testForAccountCreation( $user, $creator, [ $req ] ); diff --git a/tests/phpunit/includes/auth/ThrottlerTest.php b/tests/phpunit/includes/auth/ThrottlerTest.php index 5806003f64..c945885c76 100644 --- a/tests/phpunit/includes/auth/ThrottlerTest.php +++ b/tests/phpunit/includes/auth/ThrottlerTest.php @@ -196,7 +196,7 @@ class ThrottlerTest extends \MediaWikiTestCase { ->setMethods( [ 'log' ] ) ->getMockForAbstractClass(); $logger->expects( $this->once() )->method( 'log' )->with( $this->anything(), $this->anything(), [ - 'type' => 'custom', + 'throttle' => 'custom', 'index' => 0, 'ip' => '1.2.3.4', 'username' => 'SomeUser', diff --git a/tests/phpunit/includes/auth/UserDataAuthenticationRequestTest.php b/tests/phpunit/includes/auth/UserDataAuthenticationRequestTest.php index 7fe335117c..7dea123c12 100644 --- a/tests/phpunit/includes/auth/UserDataAuthenticationRequestTest.php +++ b/tests/phpunit/includes/auth/UserDataAuthenticationRequestTest.php @@ -36,7 +36,6 @@ class UserDataAuthenticationRequestTest extends AuthenticationRequestTestCase { $this->assertSame( $email ?: 'default@example.com', $user->getEmail() ); $this->assertSame( $realname ?: 'Fake Name', $user->getRealName() ); } - } public static function providePopulateUser() { diff --git a/tests/phpunit/includes/cache/GenderCacheTest.php b/tests/phpunit/includes/cache/GenderCacheTest.php index 9c723c028d..e5bb2379ef 100644 --- a/tests/phpunit/includes/cache/GenderCacheTest.php +++ b/tests/phpunit/includes/cache/GenderCacheTest.php @@ -1,4 +1,5 @@ getGenderCache(); $username = isset( self::$nameMap[$userKey] ) ? self::$nameMap[$userKey] : $userKey; $gender = $genderCache->getGenderOf( $username ); $this->assertEquals( $gender, $expectedGender, "GenderCache normal" ); @@ -53,7 +54,7 @@ class GenderCacheTest extends MediaWikiLangTestCase { */ public function testUserObjects( $userKey, $expectedGender ) { $username = isset( self::$nameMap[$userKey] ) ? self::$nameMap[$userKey] : $userKey; - $genderCache = GenderCache::singleton(); + $genderCache = MediaWikiServices::getInstance()->getGenderCache(); $gender = $genderCache->getGenderOf( $username ); $this->assertEquals( $gender, $expectedGender, "GenderCache normal" ); } @@ -79,7 +80,7 @@ class GenderCacheTest extends MediaWikiLangTestCase { */ public function testStripSubpages( $userKey, $expectedGender ) { $username = isset( self::$nameMap[$userKey] ) ? self::$nameMap[$userKey] : $userKey; - $genderCache = GenderCache::singleton(); + $genderCache = MediaWikiServices::getInstance()->getGenderCache(); $gender = $genderCache->getGenderOf( "$username/subpage" ); $this->assertEquals( $gender, $expectedGender, "GenderCache must strip of subpages" ); } diff --git a/tests/phpunit/includes/cache/LocalisationCacheTest.php b/tests/phpunit/includes/cache/LocalisationCacheTest.php index 697eb2dc81..ed821530a2 100644 --- a/tests/phpunit/includes/cache/LocalisationCacheTest.php +++ b/tests/phpunit/includes/cache/LocalisationCacheTest.php @@ -61,14 +61,14 @@ class LocalisationCacheTest extends MediaWikiTestCase { public function testRecacheFallbacks() { $lc = $this->getMockLocalisationCache(); - $lc->recache( 'uk' ); + $lc->recache( 'ba' ); $this->assertEquals( [ - 'present-uk' => 'uk', + 'present-ba' => 'ba', 'present-ru' => 'ru', 'present-en' => 'en', ], - $lc->getItem( 'uk', 'messages' ), + $lc->getItem( 'ba', 'messages' ), 'Fallbacks are only used to fill missing data' ); } @@ -84,7 +84,7 @@ class LocalisationCacheTest extends MediaWikiTestCase { array &$cache ) { if ( $code === 'ru' ) { - $cache['messages']['present-uk'] = 'ru-override'; + $cache['messages']['present-ba'] = 'ru-override'; $cache['messages']['present-ru'] = 'ru-override'; $cache['messages']['present-en'] = 'ru-override'; } @@ -93,14 +93,14 @@ class LocalisationCacheTest extends MediaWikiTestCase { ] ); $lc = $this->getMockLocalisationCache(); - $lc->recache( 'uk' ); + $lc->recache( 'ba' ); $this->assertEquals( [ - 'present-uk' => 'uk', + 'present-ba' => 'ba', 'present-ru' => 'ru-override', 'present-en' => 'ru-override', ], - $lc->getItem( 'uk', 'messages' ), + $lc->getItem( 'ba', 'messages' ), 'Updates provided by hooks follow the normal fallback order.' ); } diff --git a/tests/phpunit/includes/config/ConfigFactoryTest.php b/tests/phpunit/includes/config/ConfigFactoryTest.php index f42cb95921..8a766187c8 100644 --- a/tests/phpunit/includes/config/ConfigFactoryTest.php +++ b/tests/phpunit/includes/config/ConfigFactoryTest.php @@ -1,5 +1,7 @@ getConfigFactory(); $this->assertInstanceOf( 'Config', $factory->makeConfig( 'main' ) ); } diff --git a/tests/phpunit/includes/debug/logger/monolog/LogstashFormatterTest.php b/tests/phpunit/includes/debug/logger/monolog/LogstashFormatterTest.php new file mode 100644 index 0000000000..8086b4bf23 --- /dev/null +++ b/tests/phpunit/includes/debug/logger/monolog/LogstashFormatterTest.php @@ -0,0 +1,55 @@ +format( $record ), true ); + foreach ( $expected as $key => $value ) { + $this->assertArrayHasKey( $key, $formatted ); + $this->assertSame( $value, $formatted[$key] ); + } + foreach ( $notExpected as $key ) { + $this->assertArrayNotHasKey( $key, $formatted ); + } + } + + public function provideV1() { + return [ + [ + [ 'extra' => [ 'foo' => 1 ], 'context' => [ 'bar' => 2 ] ], + [ 'foo' => 1, 'bar' => 2 ], + [ 'logstash_formatter_key_conflict' ], + ], + [ + [ 'extra' => [ 'url' => 1 ], 'context' => [ 'url' => 2 ] ], + [ 'url' => 1, 'c_url' => 2, 'logstash_formatter_key_conflict' => [ 'url' ] ], + [], + ], + [ + [ 'channel' => 'x', 'context' => [ 'channel' => 'y' ] ], + [ 'channel' => 'x', 'c_channel' => 'y', + 'logstash_formatter_key_conflict' => [ 'channel' ] ], + [], + ], + ]; + } + + public function testV1WithPrefix() { + $formatter = new LogstashFormatter( 'app', 'system', null, 'ctx_', LogstashFormatter::V1 ); + $record = [ 'extra' => [ 'url' => 1 ], 'context' => [ 'url' => 2 ] ]; + $formatted = json_decode( $formatter->format( $record ), true ); + $this->assertArrayHasKey( 'url', $formatted ); + $this->assertSame( 1, $formatted['url'] ); + $this->assertArrayHasKey( 'ctx_url', $formatted ); + $this->assertSame( 2, $formatted['ctx_url'] ); + $this->assertArrayNotHasKey( 'c_url', $formatted ); + } +} diff --git a/tests/phpunit/includes/exception/MWExceptionTest.php b/tests/phpunit/includes/exception/MWExceptionTest.php index 0e87ffa42f..7c36f7d13d 100644 --- a/tests/phpunit/includes/exception/MWExceptionTest.php +++ b/tests/phpunit/includes/exception/MWExceptionTest.php @@ -173,7 +173,6 @@ class MWExceptionTest extends MediaWikiTestCase { * @dataProvider provideJsonSerializedKeys */ public function testJsonserializeexceptionKeys( $expectedKeyType, $exClass, $key ) { - # Make sure we log a backtrace: $this->setMwGlobals( [ 'wgLogExceptionBacktrace' => true ] ); @@ -235,7 +234,6 @@ class MWExceptionTest extends MediaWikiTestCase { MWExceptionHandler::jsonSerializeException( new Exception() ) ); $this->assertObjectNotHasAttribute( 'backtrace', $json ); - } } diff --git a/tests/phpunit/includes/htmlform/HTMLAutoCompleteSelectFieldTest.php b/tests/phpunit/includes/htmlform/HTMLAutoCompleteSelectFieldTest.php index fbabf7ffad..33e3a257d2 100644 --- a/tests/phpunit/includes/htmlform/HTMLAutoCompleteSelectFieldTest.php +++ b/tests/phpunit/includes/htmlform/HTMLAutoCompleteSelectFieldTest.php @@ -49,9 +49,9 @@ class HtmlAutoCompleteSelectFieldTest extends MediaWikiTestCase { */ function testOptionalSelectElement() { $params = [ - 'fieldname' => 'Test', - 'autocomplete' => $this->options, - 'options' => $this->options, + 'fieldname' => 'Test', + 'autocomplete-data' => $this->options, + 'options' => $this->options, ]; $field = new HTMLAutoCompleteSelectField( $params ); diff --git a/tests/phpunit/includes/htmlform/HTMLCheckMatrixTest.php b/tests/phpunit/includes/htmlform/HTMLCheckMatrixTest.php index dd5b58bd5e..f97716b9e5 100644 --- a/tests/phpunit/includes/htmlform/HTMLCheckMatrixTest.php +++ b/tests/phpunit/includes/htmlform/HTMLCheckMatrixTest.php @@ -51,7 +51,7 @@ class HtmlCheckMatrixTest extends MediaWikiTestCase { public function testValidateAllowsOnlyKnownTags() { $field = new HTMLCheckMatrix( self::$defaultOptions ); - $this->assertInternalType( 'string', $this->validate( $field, [ 'foo' ] ) ); + $this->assertInstanceOf( Message::class, $this->validate( $field, [ 'foo' ] ) ); } public function testValidateAcceptsPartialTagList() { diff --git a/tests/phpunit/includes/http/HttpTest.php b/tests/phpunit/includes/http/HttpTest.php new file mode 100644 index 0000000000..7e98d1c069 --- /dev/null +++ b/tests/phpunit/includes/http/HttpTest.php @@ -0,0 +1,534 @@ +assertEquals( $expected, $ok, $msg ); + } + + public static function cookieDomains() { + return [ + [ false, "org" ], + [ false, ".org" ], + [ true, "wikipedia.org" ], + [ true, ".wikipedia.org" ], + [ false, "co.uk" ], + [ false, ".co.uk" ], + [ false, "gov.uk" ], + [ false, ".gov.uk" ], + [ true, "supermarket.uk" ], + [ false, "uk" ], + [ false, ".uk" ], + [ false, "127.0.0." ], + [ false, "127." ], + [ false, "127.0.0.1." ], + [ true, "127.0.0.1" ], + [ false, "333.0.0.1" ], + [ true, "example.com" ], + [ false, "example.com." ], + [ true, ".example.com" ], + + [ true, ".example.com", "www.example.com" ], + [ false, "example.com", "www.example.com" ], + [ true, "127.0.0.1", "127.0.0.1" ], + [ false, "127.0.0.1", "localhost" ], + ]; + } + + /** + * Test Http::isValidURI() + * @bug 27854 : Http::isValidURI is too lax + * @dataProvider provideURI + * @covers Http::isValidURI + */ + public function testIsValidUri( $expect, $URI, $message = '' ) { + $this->assertEquals( + $expect, + (bool)Http::isValidURI( $URI ), + $message + ); + } + + /** + * @covers Http::getProxy + */ + public function testGetProxy() { + $this->setMwGlobals( 'wgHTTPProxy', 'proxy.domain.tld' ); + $this->assertEquals( + 'proxy.domain.tld', + Http::getProxy() + ); + } + + /** + * Feeds URI to test a long regular expression in Http::isValidURI + */ + public static function provideURI() { + /** Format: 'boolean expectation', 'URI to test', 'Optional message' */ + return [ + [ false, 'Â¿non sens before!! http://a', 'Allow anything before URI' ], + + # (http|https) - only two schemes allowed + [ true, 'http://www.example.org/' ], + [ true, 'https://www.example.org/' ], + [ true, 'http://www.example.org', 'URI without directory' ], + [ true, 'http://a', 'Short name' ], + [ true, 'http://Ã©toile', 'Allow UTF-8 in hostname' ], # 'Ã©toile' is french for 'star' + [ false, '\\host\directory', 'CIFS share' ], + [ false, 'gopher://host/dir', 'Reject gopher scheme' ], + [ false, 'telnet://host', 'Reject telnet scheme' ], + + # :\/\/ - double slashes + [ false, 'http//example.org', 'Reject missing colon in protocol' ], + [ false, 'http:/example.org', 'Reject missing slash in protocol' ], + [ false, 'http:example.org', 'Must have two slashes' ], + # Following fail since hostname can be made of anything + [ false, 'http:///example.org', 'Must have exactly two slashes, not three' ], + + # (\w+:{0,1}\w*@)? - optional user:pass + [ true, 'http://user@host', 'Username provided' ], + [ true, 'http://user:@host', 'Username provided, no password' ], + [ true, 'http://user:pass@host', 'Username and password provided' ], + + # (\S+) - host part is made of anything not whitespaces + // commented these out in order to remove @group Broken + // @todo are these valid tests? if so, fix Http::isValidURI so it can handle them + // [ false, 'http://!"Ã¨Ã¨Ã¨Â¿Â¿Â¿~~\'', 'hostname is made of any non whitespace' ], + // [ false, 'http://exam:ple.org/', 'hostname can not use colons!' ], + + # (:[0-9]+)? - port number + [ true, 'http://example.org:80/' ], + [ true, 'https://example.org:80/' ], + [ true, 'http://example.org:443/' ], + [ true, 'https://example.org:443/' ], + + # Part after the hostname is / or / with something else + [ true, 'http://example/#' ], + [ true, 'http://example/!' ], + [ true, 'http://example/:' ], + [ true, 'http://example/.' ], + [ true, 'http://example/?' ], + [ true, 'http://example/+' ], + [ true, 'http://example/=' ], + [ true, 'http://example/&' ], + [ true, 'http://example/%' ], + [ true, 'http://example/@' ], + [ true, 'http://example/-' ], + [ true, 'http://example//' ], + [ true, 'http://example/&' ], + + # Fragment + [ true, 'http://exam#ple.org', ], # This one is valid, really! + [ true, 'http://example.org:80#anchor' ], + [ true, 'http://example.org/?id#anchor' ], + [ true, 'http://example.org/?#anchor' ], + + [ false, 'http://a Â¿non !!sens after', 'Allow anything after URI' ], + ]; + } + + /** + * Warning: + * + * These tests are for code that makes use of an artifact of how CURL + * handles header reporting on redirect pages, and will need to be + * rewritten when bug 29232 is taken care of (high-level handling of + * HTTP redirects). + */ + public function testRelativeRedirections() { + $h = MWHttpRequestTester::factory( 'http://oldsite/file.ext', [], __METHOD__ ); + + # Forge a Location header + $h->setRespHeaders( 'location', [ + 'http://newsite/file.ext', + '/newfile.ext', + ] + ); + # Verify we correctly fix the Location + $this->assertEquals( + 'http://newsite/newfile.ext', + $h->getFinalUrl(), + "Relative file path Location: interpreted as full URL" + ); + + $h->setRespHeaders( 'location', [ + 'https://oldsite/file.ext' + ] + ); + $this->assertEquals( + 'https://oldsite/file.ext', + $h->getFinalUrl(), + "Location to the HTTPS version of the site" + ); + + $h->setRespHeaders( 'location', [ + '/anotherfile.ext', + 'http://anotherfile/hoster.ext', + 'https://anotherfile/hoster.ext' + ] + ); + $this->assertEquals( + 'https://anotherfile/hoster.ext', + $h->getFinalUrl( "Relative file path Location: should keep the latest host and scheme!" ) + ); + } + + /** + * Constant values are from PHP 5.3.28 using cURL 7.24.0 + * @see https://secure.php.net/manual/en/curl.constants.php + * + * All constant values are present so that developers donât need to remember + * to add them if added at a later date. The commented out constants were + * not found anywhere in the MediaWiki core code. + * + * Commented out constants that were not available in: + * HipHop VM 3.3.0 (rel) + * Compiler: heads/master-0-g08810d920dfff59e0774cf2d651f92f13a637175 + * Repo schema: 3214fc2c684a4520485f715ee45f33f2182324b1 + * Extension API: 20140829 + * + * Commented out constants that were removed in PHP 5.6.0 + * + * @covers CurlHttpRequest::execute + */ + public function provideCurlConstants() { + return [ + [ 'CURLAUTH_ANY' ], + [ 'CURLAUTH_ANYSAFE' ], + [ 'CURLAUTH_BASIC' ], + [ 'CURLAUTH_DIGEST' ], + [ 'CURLAUTH_GSSNEGOTIATE' ], + [ 'CURLAUTH_NTLM' ], + // [ 'CURLCLOSEPOLICY_CALLBACK' ], // removed in PHP 5.6.0 + // [ 'CURLCLOSEPOLICY_LEAST_RECENTLY_USED' ], // removed in PHP 5.6.0 + // [ 'CURLCLOSEPOLICY_LEAST_TRAFFIC' ], // removed in PHP 5.6.0 + // [ 'CURLCLOSEPOLICY_OLDEST' ], // removed in PHP 5.6.0 + // [ 'CURLCLOSEPOLICY_SLOWEST' ], // removed in PHP 5.6.0 + [ 'CURLE_ABORTED_BY_CALLBACK' ], + [ 'CURLE_BAD_CALLING_ORDER' ], + [ 'CURLE_BAD_CONTENT_ENCODING' ], + [ 'CURLE_BAD_FUNCTION_ARGUMENT' ], + [ 'CURLE_BAD_PASSWORD_ENTERED' ], + [ 'CURLE_COULDNT_CONNECT' ], + [ 'CURLE_COULDNT_RESOLVE_HOST' ], + [ 'CURLE_COULDNT_RESOLVE_PROXY' ], + [ 'CURLE_FAILED_INIT' ], + [ 'CURLE_FILESIZE_EXCEEDED' ], + [ 'CURLE_FILE_COULDNT_READ_FILE' ], + [ 'CURLE_FTP_ACCESS_DENIED' ], + [ 'CURLE_FTP_BAD_DOWNLOAD_RESUME' ], + [ 'CURLE_FTP_CANT_GET_HOST' ], + [ 'CURLE_FTP_CANT_RECONNECT' ], + [ 'CURLE_FTP_COULDNT_GET_SIZE' ], + [ 'CURLE_FTP_COULDNT_RETR_FILE' ], + [ 'CURLE_FTP_COULDNT_SET_ASCII' ], + [ 'CURLE_FTP_COULDNT_SET_BINARY' ], + [ 'CURLE_FTP_COULDNT_STOR_FILE' ], + [ 'CURLE_FTP_COULDNT_USE_REST' ], + [ 'CURLE_FTP_PORT_FAILED' ], + [ 'CURLE_FTP_QUOTE_ERROR' ], + [ 'CURLE_FTP_SSL_FAILED' ], + [ 'CURLE_FTP_USER_PASSWORD_INCORRECT' ], + [ 'CURLE_FTP_WEIRD_227_FORMAT' ], + [ 'CURLE_FTP_WEIRD_PASS_REPLY' ], + [ 'CURLE_FTP_WEIRD_PASV_REPLY' ], + [ 'CURLE_FTP_WEIRD_SERVER_REPLY' ], + [ 'CURLE_FTP_WEIRD_USER_REPLY' ], + [ 'CURLE_FTP_WRITE_ERROR' ], + [ 'CURLE_FUNCTION_NOT_FOUND' ], + [ 'CURLE_GOT_NOTHING' ], + [ 'CURLE_HTTP_NOT_FOUND' ], + [ 'CURLE_HTTP_PORT_FAILED' ], + [ 'CURLE_HTTP_POST_ERROR' ], + [ 'CURLE_HTTP_RANGE_ERROR' ], + [ 'CURLE_LDAP_CANNOT_BIND' ], + [ 'CURLE_LDAP_INVALID_URL' ], + [ 'CURLE_LDAP_SEARCH_FAILED' ], + [ 'CURLE_LIBRARY_NOT_FOUND' ], + [ 'CURLE_MALFORMAT_USER' ], + [ 'CURLE_OBSOLETE' ], + [ 'CURLE_OK' ], + [ 'CURLE_OPERATION_TIMEOUTED' ], + [ 'CURLE_OUT_OF_MEMORY' ], + [ 'CURLE_PARTIAL_FILE' ], + [ 'CURLE_READ_ERROR' ], + [ 'CURLE_RECV_ERROR' ], + [ 'CURLE_SEND_ERROR' ], + [ 'CURLE_SHARE_IN_USE' ], + // [ 'CURLE_SSH' ], // not present in HHVM 3.3.0-dev + [ 'CURLE_SSL_CACERT' ], + [ 'CURLE_SSL_CERTPROBLEM' ], + [ 'CURLE_SSL_CIPHER' ], + [ 'CURLE_SSL_CONNECT_ERROR' ], + [ 'CURLE_SSL_ENGINE_NOTFOUND' ], + [ 'CURLE_SSL_ENGINE_SETFAILED' ], + [ 'CURLE_SSL_PEER_CERTIFICATE' ], + [ 'CURLE_TELNET_OPTION_SYNTAX' ], + [ 'CURLE_TOO_MANY_REDIRECTS' ], + [ 'CURLE_UNKNOWN_TELNET_OPTION' ], + [ 'CURLE_UNSUPPORTED_PROTOCOL' ], + [ 'CURLE_URL_MALFORMAT' ], + [ 'CURLE_URL_MALFORMAT_USER' ], + [ 'CURLE_WRITE_ERROR' ], + [ 'CURLFTPAUTH_DEFAULT' ], + [ 'CURLFTPAUTH_SSL' ], + [ 'CURLFTPAUTH_TLS' ], + // [ 'CURLFTPMETHOD_MULTICWD' ], // not present in HHVM 3.3.0-dev + // [ 'CURLFTPMETHOD_NOCWD' ], // not present in HHVM 3.3.0-dev + // [ 'CURLFTPMETHOD_SINGLECWD' ], // not present in HHVM 3.3.0-dev + [ 'CURLFTPSSL_ALL' ], + [ 'CURLFTPSSL_CONTROL' ], + [ 'CURLFTPSSL_NONE' ], + [ 'CURLFTPSSL_TRY' ], + // [ 'CURLINFO_CERTINFO' ], // not present in HHVM 3.3.0-dev + [ 'CURLINFO_CONNECT_TIME' ], + [ 'CURLINFO_CONTENT_LENGTH_DOWNLOAD' ], + [ 'CURLINFO_CONTENT_LENGTH_UPLOAD' ], + [ 'CURLINFO_CONTENT_TYPE' ], + [ 'CURLINFO_EFFECTIVE_URL' ], + [ 'CURLINFO_FILETIME' ], + [ 'CURLINFO_HEADER_OUT' ], + [ 'CURLINFO_HEADER_SIZE' ], + [ 'CURLINFO_HTTP_CODE' ], + [ 'CURLINFO_NAMELOOKUP_TIME' ], + [ 'CURLINFO_PRETRANSFER_TIME' ], + [ 'CURLINFO_PRIVATE' ], + [ 'CURLINFO_REDIRECT_COUNT' ], + [ 'CURLINFO_REDIRECT_TIME' ], + // [ 'CURLINFO_REDIRECT_URL' ], // not present in HHVM 3.3.0-dev + [ 'CURLINFO_REQUEST_SIZE' ], + [ 'CURLINFO_SIZE_DOWNLOAD' ], + [ 'CURLINFO_SIZE_UPLOAD' ], + [ 'CURLINFO_SPEED_DOWNLOAD' ], + [ 'CURLINFO_SPEED_UPLOAD' ], + [ 'CURLINFO_SSL_VERIFYRESULT' ], + [ 'CURLINFO_STARTTRANSFER_TIME' ], + [ 'CURLINFO_TOTAL_TIME' ], + [ 'CURLMSG_DONE' ], + [ 'CURLM_BAD_EASY_HANDLE' ], + [ 'CURLM_BAD_HANDLE' ], + [ 'CURLM_CALL_MULTI_PERFORM' ], + [ 'CURLM_INTERNAL_ERROR' ], + [ 'CURLM_OK' ], + [ 'CURLM_OUT_OF_MEMORY' ], + [ 'CURLOPT_AUTOREFERER' ], + [ 'CURLOPT_BINARYTRANSFER' ], + [ 'CURLOPT_BUFFERSIZE' ], + [ 'CURLOPT_CAINFO' ], + [ 'CURLOPT_CAPATH' ], + // [ 'CURLOPT_CERTINFO' ], // not present in HHVM 3.3.0-dev + // [ 'CURLOPT_CLOSEPOLICY' ], // removed in PHP 5.6.0 + [ 'CURLOPT_CONNECTTIMEOUT' ], + [ 'CURLOPT_CONNECTTIMEOUT_MS' ], + [ 'CURLOPT_COOKIE' ], + [ 'CURLOPT_COOKIEFILE' ], + [ 'CURLOPT_COOKIEJAR' ], + [ 'CURLOPT_COOKIESESSION' ], + [ 'CURLOPT_CRLF' ], + [ 'CURLOPT_CUSTOMREQUEST' ], + [ 'CURLOPT_DNS_CACHE_TIMEOUT' ], + [ 'CURLOPT_DNS_USE_GLOBAL_CACHE' ], + [ 'CURLOPT_EGDSOCKET' ], + [ 'CURLOPT_ENCODING' ], + [ 'CURLOPT_FAILONERROR' ], + [ 'CURLOPT_FILE' ], + [ 'CURLOPT_FILETIME' ], + [ 'CURLOPT_FOLLOWLOCATION' ], + [ 'CURLOPT_FORBID_REUSE' ], + [ 'CURLOPT_FRESH_CONNECT' ], + [ 'CURLOPT_FTPAPPEND' ], + [ 'CURLOPT_FTPLISTONLY' ], + [ 'CURLOPT_FTPPORT' ], + [ 'CURLOPT_FTPSSLAUTH' ], + [ 'CURLOPT_FTP_CREATE_MISSING_DIRS' ], + // [ 'CURLOPT_FTP_FILEMETHOD' ], // not present in HHVM 3.3.0-dev + // [ 'CURLOPT_FTP_SKIP_PASV_IP' ], // not present in HHVM 3.3.0-dev + [ 'CURLOPT_FTP_SSL' ], + [ 'CURLOPT_FTP_USE_EPRT' ], + [ 'CURLOPT_FTP_USE_EPSV' ], + [ 'CURLOPT_HEADER' ], + [ 'CURLOPT_HEADERFUNCTION' ], + [ 'CURLOPT_HTTP200ALIASES' ], + [ 'CURLOPT_HTTPAUTH' ], + [ 'CURLOPT_HTTPGET' ], + [ 'CURLOPT_HTTPHEADER' ], + [ 'CURLOPT_HTTPPROXYTUNNEL' ], + [ 'CURLOPT_HTTP_VERSION' ], + [ 'CURLOPT_INFILE' ], + [ 'CURLOPT_INFILESIZE' ], + [ 'CURLOPT_INTERFACE' ], + [ 'CURLOPT_IPRESOLVE' ], + // [ 'CURLOPT_KEYPASSWD' ], // not present in HHVM 3.3.0-dev + [ 'CURLOPT_KRB4LEVEL' ], + [ 'CURLOPT_LOW_SPEED_LIMIT' ], + [ 'CURLOPT_LOW_SPEED_TIME' ], + [ 'CURLOPT_MAXCONNECTS' ], + [ 'CURLOPT_MAXREDIRS' ], + // [ 'CURLOPT_MAX_RECV_SPEED_LARGE' ], // not present in HHVM 3.3.0-dev + // [ 'CURLOPT_MAX_SEND_SPEED_LARGE' ], // not present in HHVM 3.3.0-dev + [ 'CURLOPT_NETRC' ], + [ 'CURLOPT_NOBODY' ], + [ 'CURLOPT_NOPROGRESS' ], + [ 'CURLOPT_NOSIGNAL' ], + [ 'CURLOPT_PORT' ], + [ 'CURLOPT_POST' ], + [ 'CURLOPT_POSTFIELDS' ], + [ 'CURLOPT_POSTQUOTE' ], + [ 'CURLOPT_POSTREDIR' ], + [ 'CURLOPT_PRIVATE' ], + [ 'CURLOPT_PROGRESSFUNCTION' ], + // [ 'CURLOPT_PROTOCOLS' ], // not present in HHVM 3.3.0-dev + [ 'CURLOPT_PROXY' ], + [ 'CURLOPT_PROXYAUTH' ], + [ 'CURLOPT_PROXYPORT' ], + [ 'CURLOPT_PROXYTYPE' ], + [ 'CURLOPT_PROXYUSERPWD' ], + [ 'CURLOPT_PUT' ], + [ 'CURLOPT_QUOTE' ], + [ 'CURLOPT_RANDOM_FILE' ], + [ 'CURLOPT_RANGE' ], + [ 'CURLOPT_READDATA' ], + [ 'CURLOPT_READFUNCTION' ], + // [ 'CURLOPT_REDIR_PROTOCOLS' ], // not present in HHVM 3.3.0-dev + [ 'CURLOPT_REFERER' ], + [ 'CURLOPT_RESUME_FROM' ], + [ 'CURLOPT_RETURNTRANSFER' ], + // [ 'CURLOPT_SSH_AUTH_TYPES' ], // not present in HHVM 3.3.0-dev + // [ 'CURLOPT_SSH_HOST_PUBLIC_KEY_MD5' ], // not present in HHVM 3.3.0-dev + // [ 'CURLOPT_SSH_PRIVATE_KEYFILE' ], // not present in HHVM 3.3.0-dev + // [ 'CURLOPT_SSH_PUBLIC_KEYFILE' ], // not present in HHVM 3.3.0-dev + [ 'CURLOPT_SSLCERT' ], + [ 'CURLOPT_SSLCERTPASSWD' ], + [ 'CURLOPT_SSLCERTTYPE' ], + [ 'CURLOPT_SSLENGINE' ], + [ 'CURLOPT_SSLENGINE_DEFAULT' ], + [ 'CURLOPT_SSLKEY' ], + [ 'CURLOPT_SSLKEYPASSWD' ], + [ 'CURLOPT_SSLKEYTYPE' ], + [ 'CURLOPT_SSLVERSION' ], + [ 'CURLOPT_SSL_CIPHER_LIST' ], + [ 'CURLOPT_SSL_VERIFYHOST' ], + [ 'CURLOPT_SSL_VERIFYPEER' ], + [ 'CURLOPT_STDERR' ], + [ 'CURLOPT_TCP_NODELAY' ], + [ 'CURLOPT_TIMECONDITION' ], + [ 'CURLOPT_TIMEOUT' ], + [ 'CURLOPT_TIMEOUT_MS' ], + [ 'CURLOPT_TIMEVALUE' ], + [ 'CURLOPT_TRANSFERTEXT' ], + [ 'CURLOPT_UNRESTRICTED_AUTH' ], + [ 'CURLOPT_UPLOAD' ], + [ 'CURLOPT_URL' ], + [ 'CURLOPT_USERAGENT' ], + [ 'CURLOPT_USERPWD' ], + [ 'CURLOPT_VERBOSE' ], + [ 'CURLOPT_WRITEFUNCTION' ], + [ 'CURLOPT_WRITEHEADER' ], + // [ 'CURLPROTO_ALL' ], // not present in HHVM 3.3.0-dev + // [ 'CURLPROTO_DICT' ], // not present in HHVM 3.3.0-dev + // [ 'CURLPROTO_FILE' ], // not present in HHVM 3.3.0-dev + // [ 'CURLPROTO_FTP' ], // not present in HHVM 3.3.0-dev + // [ 'CURLPROTO_FTPS' ], // not present in HHVM 3.3.0-dev + // [ 'CURLPROTO_HTTP' ], // not present in HHVM 3.3.0-dev + // [ 'CURLPROTO_HTTPS' ], // not present in HHVM 3.3.0-dev + // [ 'CURLPROTO_LDAP' ], // not present in HHVM 3.3.0-dev + // [ 'CURLPROTO_LDAPS' ], // not present in HHVM 3.3.0-dev + // [ 'CURLPROTO_SCP' ], // not present in HHVM 3.3.0-dev + // [ 'CURLPROTO_SFTP' ], // not present in HHVM 3.3.0-dev + // [ 'CURLPROTO_TELNET' ], // not present in HHVM 3.3.0-dev + // [ 'CURLPROTO_TFTP' ], // not present in HHVM 3.3.0-dev + [ 'CURLPROXY_HTTP' ], + // [ 'CURLPROXY_SOCKS4' ], // not present in HHVM 3.3.0-dev + [ 'CURLPROXY_SOCKS5' ], + // [ 'CURLSSH_AUTH_DEFAULT' ], // not present in HHVM 3.3.0-dev + // [ 'CURLSSH_AUTH_HOST' ], // not present in HHVM 3.3.0-dev + // [ 'CURLSSH_AUTH_KEYBOARD' ], // not present in HHVM 3.3.0-dev + // [ 'CURLSSH_AUTH_NONE' ], // not present in HHVM 3.3.0-dev + // [ 'CURLSSH_AUTH_PASSWORD' ], // not present in HHVM 3.3.0-dev + // [ 'CURLSSH_AUTH_PUBLICKEY' ], // not present in HHVM 3.3.0-dev + [ 'CURLVERSION_NOW' ], + [ 'CURL_HTTP_VERSION_1_0' ], + [ 'CURL_HTTP_VERSION_1_1' ], + [ 'CURL_HTTP_VERSION_NONE' ], + [ 'CURL_IPRESOLVE_V4' ], + [ 'CURL_IPRESOLVE_V6' ], + [ 'CURL_IPRESOLVE_WHATEVER' ], + [ 'CURL_NETRC_IGNORED' ], + [ 'CURL_NETRC_OPTIONAL' ], + [ 'CURL_NETRC_REQUIRED' ], + [ 'CURL_TIMECOND_IFMODSINCE' ], + [ 'CURL_TIMECOND_IFUNMODSINCE' ], + [ 'CURL_TIMECOND_LASTMOD' ], + [ 'CURL_VERSION_IPV6' ], + [ 'CURL_VERSION_KERBEROS4' ], + [ 'CURL_VERSION_LIBZ' ], + [ 'CURL_VERSION_SSL' ], + ]; + } + + /** + * Added this test based on an issue experienced with HHVM 3.3.0-dev + * where it did not define a cURL constant. + * + * @bug 70570 + * @dataProvider provideCurlConstants + */ + public function testCurlConstants( $value ) { + $this->assertTrue( defined( $value ), $value . ' not defined' ); + } +} + +/** + * Class to let us overwrite MWHttpRequest respHeaders variable + */ +class MWHttpRequestTester extends MWHttpRequest { + // function derived from the MWHttpRequest factory function but + // returns appropriate tester class here + public static function factory( $url, $options = null, $caller = __METHOD__ ) { + if ( !Http::$httpEngine ) { + Http::$httpEngine = function_exists( 'curl_init' ) ? 'curl' : 'php'; + } elseif ( Http::$httpEngine == 'curl' && !function_exists( 'curl_init' ) ) { + throw new DomainException( __METHOD__ . ': curl (http://php.net/curl) is not installed, but' . + 'Http::$httpEngine is set to "curl"' ); + } + + switch ( Http::$httpEngine ) { + case 'curl': + return new CurlHttpRequestTester( $url, $options, $caller ); + case 'php': + if ( !wfIniGetBool( 'allow_url_fopen' ) ) { + throw new DomainException( __METHOD__ . + ': allow_url_fopen needs to be enabled for pure PHP HTTP requests to work. ' + . 'If possible, curl should be used instead. See http://php.net/curl.' ); + } + + return new PhpHttpRequestTester( $url, $options, $caller ); + default: + } + } +} + +class CurlHttpRequestTester extends CurlHttpRequest { + function setRespHeaders( $name, $value ) { + $this->respHeaders[$name] = $value; + } +} + +class PhpHttpRequestTester extends PhpHttpRequest { + function setRespHeaders( $name, $value ) { + $this->respHeaders[$name] = $value; + } +} diff --git a/tests/phpunit/includes/import/ImportLinkCacheIntegrationTest.php b/tests/phpunit/includes/import/ImportLinkCacheIntegrationTest.php index 5e3c6268aa..8e06f9e968 100644 --- a/tests/phpunit/includes/import/ImportLinkCacheIntegrationTest.php +++ b/tests/phpunit/includes/import/ImportLinkCacheIntegrationTest.php @@ -1,4 +1,6 @@ value, - ConfigFactory::getDefaultInstance()->makeConfig( 'main' ) + MediaWikiServices::getInstance()->getMainConfig() ); $importer->setDebug( true ); diff --git a/tests/phpunit/includes/import/ImportTest.php b/tests/phpunit/includes/import/ImportTest.php index 9d05d15256..53d91c6593 100644 --- a/tests/phpunit/includes/import/ImportTest.php +++ b/tests/phpunit/includes/import/ImportTest.php @@ -1,4 +1,5 @@ makeConfig( 'main' ) + MediaWikiServices::getInstance()->getMainConfig() ); $importer->doImport(); @@ -92,7 +93,7 @@ EOF $importer = new WikiImporter( $source, - ConfigFactory::getDefaultInstance()->makeConfig( 'main' ) + MediaWikiServices::getInstance()->getMainConfig() ); $importer->setPageOutCallback( $callback ); $importer->doImport(); @@ -175,7 +176,7 @@ EOF $importer = new WikiImporter( $source, - ConfigFactory::getDefaultInstance()->makeConfig( 'main' ) + MediaWikiServices::getInstance()->getMainConfig() ); $importer->setSiteInfoCallback( $callback ); $importer->doImport(); diff --git a/tests/phpunit/includes/installer/DatabaseUpdaterTest.php b/tests/phpunit/includes/installer/DatabaseUpdaterTest.php deleted file mode 100644 index 22d52f0744..0000000000 --- a/tests/phpunit/includes/installer/DatabaseUpdaterTest.php +++ /dev/null @@ -1,286 +0,0 @@ -setAppliedUpdates( "test", [] ); - $expected = "updatelist-test-" . time() . "0"; - $actual = $db->lastInsertData['ul_key']; - $this->assertEquals( $expected, $actual, var_export( $db->lastInsertData, true ) ); - $dbu->setAppliedUpdates( "test", [] ); - $expected = "updatelist-test-" . time() . "1"; - $actual = $db->lastInsertData['ul_key']; - $this->assertEquals( $expected, $actual, var_export( $db->lastInsertData, true ) ); - } -} - -class FakeDatabase extends Database { - public $lastInsertTable; - public $lastInsertData; - - function __construct() { - $this->cliMode = true; - $this->connLogger = new \Psr\Log\NullLogger(); - $this->queryLogger = new \Psr\Log\NullLogger(); - $this->errorLogger = function ( Exception $e ) { - wfWarn( get_class( $e ) . ": {$e->getMessage()}" ); - }; - $this->currentDomain = DatabaseDomain::newUnspecified(); - } - - function clearFlag( $arg, $remember = self::REMEMBER_NOTHING ) { - } - - function setFlag( $arg, $remember = self::REMEMBER_NOTHING ) { - } - - public function insert( $table, $a, $fname = __METHOD__, $options = [] ) { - $this->lastInsertTable = $table; - $this->lastInsertData = $a; - } - - /** - * Get the type of the DBMS, as it appears in $wgDBtype. - * - * @return string - */ - function getType() { - // TODO: Implement getType() method. - } - - /** - * Open a connection to the database. Usually aborts on failure - * - * @param string $server Database server host - * @param string $user Database user name - * @param string $password Database user password - * @param string $dbName Database name - * @return bool - * @throws DBConnectionError - */ - function open( $server, $user, $password, $dbName ) { - // TODO: Implement open() method. - } - - /** - * Fetch the next row from the given result object, in object form. - * Fields can be retrieved with $row->fieldname, with fields acting like - * member variables. - * If no more rows are available, false is returned. - * - * @param ResultWrapper|stdClass $res Object as returned from Database::query(), etc. - * @return stdClass|bool - * @throws DBUnexpectedError Thrown if the database returns an error - */ - function fetchObject( $res ) { - // TODO: Implement fetchObject() method. - } - - /** - * Fetch the next row from the given result object, in associative array - * form. Fields are retrieved with $row['fieldname']. - * If no more rows are available, false is returned. - * - * @param ResultWrapper $res Result object as returned from Database::query(), etc. - * @return array|bool - * @throws DBUnexpectedError Thrown if the database returns an error - */ - function fetchRow( $res ) { - // TODO: Implement fetchRow() method. - } - - /** - * Get the number of rows in a result object - * - * @param mixed $res A SQL result - * @return int - */ - function numRows( $res ) { - // TODO: Implement numRows() method. - } - - /** - * Get the number of fields in a result object - * @see http://www.php.net/mysql_num_fields - * - * @param mixed $res A SQL result - * @return int - */ - function numFields( $res ) { - // TODO: Implement numFields() method. - } - - /** - * Get a field name in a result object - * @see http://www.php.net/mysql_field_name - * - * @param mixed $res A SQL result - * @param int $n - * @return string - */ - function fieldName( $res, $n ) { - // TODO: Implement fieldName() method. - } - - /** - * Get the inserted value of an auto-increment row - * - * The value inserted should be fetched from nextSequenceValue() - * - * Example: - * $id = $dbw->nextSequenceValue( 'page_page_id_seq' ); - * $dbw->insert( 'page', [ 'page_id' => $id ] ); - * $id = $dbw->insertId(); - * - * @return int - */ - function insertId() { - // TODO: Implement insertId() method. - } - - /** - * Change the position of the cursor in a result object - * @see http://www.php.net/mysql_data_seek - * - * @param mixed $res A SQL result - * @param int $row - */ - function dataSeek( $res, $row ) { - // TODO: Implement dataSeek() method. - } - - /** - * Get the last error number - * @see http://www.php.net/mysql_errno - * - * @return int - */ - function lastErrno() { - // TODO: Implement lastErrno() method. - } - - /** - * Get a description of the last error - * @see http://www.php.net/mysql_error - * - * @return string - */ - function lastError() { - // TODO: Implement lastError() method. - } - - /** - * mysql_fetch_field() wrapper - * Returns false if the field doesn't exist - * - * @param string $table Table name - * @param string $field Field name - * - * @return Field - */ - function fieldInfo( $table, $field ) { - // TODO: Implement fieldInfo() method. - } - - /** - * Get information about an index into an object - * @param string $table Table name - * @param string $index Index name - * @param string $fname Calling function name - * @return mixed Database-specific index description class or false if the index does not exist - */ - function indexInfo( $table, $index, $fname = __METHOD__ ) { - // TODO: Implement indexInfo() method. - } - - /** - * Get the number of rows affected by the last write query - * @see http://www.php.net/mysql_affected_rows - * - * @return int - */ - function affectedRows() { - // TODO: Implement affectedRows() method. - } - - /** - * Wrapper for addslashes() - * - * @param string $s String to be slashed. - * @return string Slashed string. - */ - function strencode( $s ) { - // TODO: Implement strencode() method. - } - - /** - * Returns a wikitext link to the DB's website, e.g., - * return "[http://www.mysql.com/ MySQL]"; - * Should at least contain plain text, if for some reason - * your database has no website. - * - * @return string Wikitext of a link to the server software's web site - */ - function getSoftwareLink() { - // TODO: Implement getSoftwareLink() method. - } - - /** - * A string describing the current software version, like from - * mysql_get_server_info(). - * - * @return string Version information from the database server. - */ - function getServerVersion() { - // TODO: Implement getServerVersion() method. - } - - /** - * Closes underlying database connection - * @since 1.20 - * @return bool Whether connection was closed successfully - */ - protected function closeConnection() { - // TODO: Implement closeConnection() method. - } - - /** - * The DBMS-dependent part of query() - * - * @param string $sql SQL query. - * @return ResultWrapper|bool Result object to feed to fetchObject, - * fetchRow, ...; or false on failure - */ - protected function doQuery( $sql ) { - // TODO: Implement doQuery() method. - } -} - -class FakeDatabaseUpdater extends DatabaseUpdater { - function __construct( $db ) { - $this->db = $db; - self::$updateCounter = 0; - } - - /** - * Get an array of updates to perform on the database. Should return a - * multi-dimensional array. The main key is the MediaWiki version (1.12, - * 1.13...) with the values being arrays of updates, identical to how - * updaters.inc did it (for now) - * - * @return array - */ - protected function getCoreUpdateList() { - return []; - } - - public function canUseNewUpdatelog() { - return true; - } - - public function setAppliedUpdates( $version, $updates = [] ) { - parent::setAppliedUpdates( $version, $updates ); - } -} diff --git a/tests/phpunit/includes/libs/CSSMinTest.php b/tests/phpunit/includes/libs/CSSMinTest.php index 5f5a1e8f01..366714b193 100644 --- a/tests/phpunit/includes/libs/CSSMinTest.php +++ b/tests/phpunit/includes/libs/CSSMinTest.php @@ -129,8 +129,8 @@ class CSSMinTest extends MediaWikiTestCase { * @covers CSSMin::remap */ public function testRemapRemapping( $message, $input, $expectedOutput ) { - $localPath = __DIR__ . '/../../data/cssmin/'; - $remotePath = 'http://localhost/w/'; + $localPath = __DIR__ . '/../../data/cssmin'; + $remotePath = 'http://localhost/w'; $realOutput = CSSMin::remap( $input, $localPath, $remotePath ); $this->assertEquals( $expectedOutput, $realOutput, "CSSMin::remap: $message" ); diff --git a/tests/phpunit/includes/libs/rdbms/connectionmanager/ConnectionManagerTest.php b/tests/phpunit/includes/libs/rdbms/connectionmanager/ConnectionManagerTest.php new file mode 100644 index 0000000000..1677851736 --- /dev/null +++ b/tests/phpunit/includes/libs/rdbms/connectionmanager/ConnectionManagerTest.php @@ -0,0 +1,139 @@ +getMock( IDatabase::class ); + } + + /** + * @return LoadBalancer|PHPUnit_Framework_MockObject_MockObject + */ + private function getLoadBalancerMock() { + $lb = $this->getMockBuilder( LoadBalancer::class ) + ->disableOriginalConstructor() + ->getMock(); + + return $lb; + } + + public function testGetReadConnection_nullGroups() { + $database = $this->getIDatabaseMock(); + $lb = $this->getLoadBalancerMock(); + + $lb->expects( $this->once() ) + ->method( 'getConnection' ) + ->with( DB_REPLICA, [ 'group1' ], 'someDbName' ) + ->will( $this->returnValue( $database ) ); + + $manager = new ConnectionManager( $lb, 'someDbName', [ 'group1' ] ); + $actual = $manager->getReadConnection(); + + $this->assertSame( $database, $actual ); + } + + public function testGetReadConnection_withGroups() { + $database = $this->getIDatabaseMock(); + $lb = $this->getLoadBalancerMock(); + + $lb->expects( $this->once() ) + ->method( 'getConnection' ) + ->with( DB_REPLICA, [ 'group2' ], 'someDbName' ) + ->will( $this->returnValue( $database ) ); + + $manager = new ConnectionManager( $lb, 'someDbName', [ 'group1' ] ); + $actual = $manager->getReadConnection( [ 'group2' ] ); + + $this->assertSame( $database, $actual ); + } + + public function testGetWriteConnection() { + $database = $this->getIDatabaseMock(); + $lb = $this->getLoadBalancerMock(); + + $lb->expects( $this->once() ) + ->method( 'getConnection' ) + ->with( DB_MASTER, [ 'group1' ], 'someDbName' ) + ->will( $this->returnValue( $database ) ); + + $manager = new ConnectionManager( $lb, 'someDbName', [ 'group1' ] ); + $actual = $manager->getWriteConnection(); + + $this->assertSame( $database, $actual ); + } + + public function testReleaseConnection() { + $database = $this->getIDatabaseMock(); + $lb = $this->getLoadBalancerMock(); + + $lb->expects( $this->once() ) + ->method( 'reuseConnection' ) + ->with( $database ) + ->will( $this->returnValue( null ) ); + + $manager = new ConnectionManager( $lb ); + $manager->releaseConnection( $database ); + } + + public function testGetReadConnectionRef_nullGroups() { + $database = $this->getIDatabaseMock(); + $lb = $this->getLoadBalancerMock(); + + $lb->expects( $this->once() ) + ->method( 'getConnectionRef' ) + ->with( DB_REPLICA, [ 'group1' ], 'someDbName' ) + ->will( $this->returnValue( $database ) ); + + $manager = new ConnectionManager( $lb, 'someDbName', [ 'group1' ] ); + $actual = $manager->getReadConnectionRef(); + + $this->assertSame( $database, $actual ); + } + + public function testGetReadConnectionRef_withGroups() { + $database = $this->getIDatabaseMock(); + $lb = $this->getLoadBalancerMock(); + + $lb->expects( $this->once() ) + ->method( 'getConnectionRef' ) + ->with( DB_REPLICA, [ 'group2' ], 'someDbName' ) + ->will( $this->returnValue( $database ) ); + + $manager = new ConnectionManager( $lb, 'someDbName', [ 'group1' ] ); + $actual = $manager->getReadConnectionRef( [ 'group2' ] ); + + $this->assertSame( $database, $actual ); + } + + public function testGetWriteConnectionRef() { + $database = $this->getIDatabaseMock(); + $lb = $this->getLoadBalancerMock(); + + $lb->expects( $this->once() ) + ->method( 'getConnectionRef' ) + ->with( DB_MASTER, [ 'group1' ], 'someDbName' ) + ->will( $this->returnValue( $database ) ); + + $manager = new ConnectionManager( $lb, 'someDbName', [ 'group1' ] ); + $actual = $manager->getWriteConnectionRef(); + + $this->assertSame( $database, $actual ); + } + +} diff --git a/tests/phpunit/includes/libs/rdbms/connectionmanager/SessionConsistentConnectionManagerTest.php b/tests/phpunit/includes/libs/rdbms/connectionmanager/SessionConsistentConnectionManagerTest.php new file mode 100644 index 0000000000..0d54659b5e --- /dev/null +++ b/tests/phpunit/includes/libs/rdbms/connectionmanager/SessionConsistentConnectionManagerTest.php @@ -0,0 +1,108 @@ +getMock( IDatabase::class ); + } + + /** + * @return LoadBalancer|PHPUnit_Framework_MockObject_MockObject + */ + private function getLoadBalancerMock() { + $lb = $this->getMockBuilder( LoadBalancer::class ) + ->disableOriginalConstructor() + ->getMock(); + + return $lb; + } + + public function testGetReadConnection() { + $database = $this->getIDatabaseMock(); + $lb = $this->getLoadBalancerMock(); + + $lb->expects( $this->once() ) + ->method( 'getConnection' ) + ->with( DB_REPLICA ) + ->will( $this->returnValue( $database ) ); + + $manager = new SessionConsistentConnectionManager( $lb ); + $actual = $manager->getReadConnection(); + + $this->assertSame( $database, $actual ); + } + + public function testGetReadConnectionReturnsWriteDbOnForceMatser() { + $database = $this->getIDatabaseMock(); + $lb = $this->getLoadBalancerMock(); + + $lb->expects( $this->once() ) + ->method( 'getConnection' ) + ->with( DB_MASTER ) + ->will( $this->returnValue( $database ) ); + + $manager = new SessionConsistentConnectionManager( $lb ); + $manager->prepareForUpdates(); + $actual = $manager->getReadConnection(); + + $this->assertSame( $database, $actual ); + } + + public function testGetWriteConnection() { + $database = $this->getIDatabaseMock(); + $lb = $this->getLoadBalancerMock(); + + $lb->expects( $this->once() ) + ->method( 'getConnection' ) + ->with( DB_MASTER ) + ->will( $this->returnValue( $database ) ); + + $manager = new SessionConsistentConnectionManager( $lb ); + $actual = $manager->getWriteConnection(); + + $this->assertSame( $database, $actual ); + } + + public function testForceMaster() { + $database = $this->getIDatabaseMock(); + $lb = $this->getLoadBalancerMock(); + + $lb->expects( $this->once() ) + ->method( 'getConnection' ) + ->with( DB_MASTER ) + ->will( $this->returnValue( $database ) ); + + $manager = new SessionConsistentConnectionManager( $lb ); + $manager->prepareForUpdates(); + $manager->getReadConnection(); + } + + public function testReleaseConnection() { + $database = $this->getIDatabaseMock(); + $lb = $this->getLoadBalancerMock(); + + $lb->expects( $this->once() ) + ->method( 'reuseConnection' ) + ->with( $database ) + ->will( $this->returnValue( null ) ); + + $manager = new SessionConsistentConnectionManager( $lb ); + $manager->releaseConnection( $database ); + } +} diff --git a/tests/phpunit/includes/linker/LinkRendererTest.php b/tests/phpunit/includes/linker/LinkRendererTest.php index 70c0ece215..6d096c208b 100644 --- a/tests/phpunit/includes/linker/LinkRendererTest.php +++ b/tests/phpunit/includes/linker/LinkRendererTest.php @@ -24,7 +24,6 @@ class LinkRendererTest extends MediaWikiLangTestCase { 'wgScript' => '/w/index.php', ] ); $this->factory = MediaWikiServices::getInstance()->getLinkRendererFactory(); - } public function testMergeAttribs() { diff --git a/tests/phpunit/includes/media/ExifBitmapTest.php b/tests/phpunit/includes/media/ExifBitmapTest.php index f70b42de42..47ed67bdb1 100644 --- a/tests/phpunit/includes/media/ExifBitmapTest.php +++ b/tests/phpunit/includes/media/ExifBitmapTest.php @@ -17,7 +17,6 @@ class ExifBitmapTest extends MediaWikiMediaTestCase { $this->setMwGlobals( 'wgShowEXIF', true ); $this->handler = new ExifBitmapHandler; - } /** diff --git a/tests/phpunit/includes/page/ArticleTest.php b/tests/phpunit/includes/page/ArticleTest.php index a96a2960fb..7d0813d141 100644 --- a/tests/phpunit/includes/page/ArticleTest.php +++ b/tests/phpunit/includes/page/ArticleTest.php @@ -63,13 +63,9 @@ class ArticleTest extends MediaWikiTestCase { * @covers Article::onArticleCreate * @covers Article::onArticleDelete * @covers Article::onArticleEdit - * @covers Article::getAutosummary */ public function testStaticFunctions() { $this->hideDeprecated( 'Article::selectFields' ); - $this->hideDeprecated( 'Article::getAutosummary' ); - $this->hideDeprecated( 'WikiPage::getAutosummary' ); - $this->hideDeprecated( 'CategoryPage::getAutosummary' ); // Inherited from Article $this->assertEquals( WikiPage::selectFields(), Article::selectFields(), "Article static functions" ); @@ -79,7 +75,5 @@ class ArticleTest extends MediaWikiTestCase { "Article static functions" ); $this->assertEquals( true, is_callable( "ImagePage::onArticleEdit" ), "Article static functions" ); - $this->assertTrue( is_string( CategoryPage::getAutosummary( '', '', 0 ) ), - "Article static functions" ); } } diff --git a/tests/phpunit/includes/page/WikiPageTest.php b/tests/phpunit/includes/page/WikiPageTest.php index 4b7ebd3ab3..6885ca36c8 100644 --- a/tests/phpunit/includes/page/WikiPageTest.php +++ b/tests/phpunit/includes/page/WikiPageTest.php @@ -5,7 +5,7 @@ * @group Database * ^--- important, causes temporary tables to be used instead of the real database * @group medium - **/ + */ class WikiPageTest extends MediaWikiLangTestCase { protected $pages_to_delete; @@ -161,7 +161,6 @@ class WikiPageTest extends MediaWikiLangTestCase { */ public function testDoEdit() { $this->hideDeprecated( "WikiPage::doEdit" ); - $this->hideDeprecated( "WikiPage::getText" ); $this->hideDeprecated( "Revision::getText" ); // NOTE: assume help namespace will default to wikitext @@ -189,12 +188,6 @@ class WikiPageTest extends MediaWikiLangTestCase { $this->assertEquals( 1, $n, 'pagelinks should contain one link from the page' ); - # ------------------------ - $page = new WikiPage( $title ); - - $retrieved = $page->getText(); - $this->assertEquals( $text, $retrieved, 'retrieved text doesn\'t equal original' ); - # ------------------------ $text = "At vero eos et accusam et justo duo [[dolores]] et ea rebum. " . "Stet clita kasd [[gubergren]], no sea takimata sanctus est."; @@ -204,7 +197,7 @@ class WikiPageTest extends MediaWikiLangTestCase { # ------------------------ $page = new WikiPage( $title ); - $retrieved = $page->getText(); + $retrieved = $page->getContent()->getNativeData(); $this->assertEquals( $text, $retrieved, 'retrieved text doesn\'t equal original' ); # ------------------------ @@ -242,10 +235,6 @@ class WikiPageTest extends MediaWikiLangTestCase { $page->getContent(), "WikiPage::getContent should return null after page was deleted" ); - $this->assertFalse( - $page->getText(), - "WikiPage::getText should return false after page was deleted" - ); $t = Title::newFromText( $page->getTitle()->getPrefixedText() ); $this->assertFalse( @@ -332,24 +321,6 @@ class WikiPageTest extends MediaWikiLangTestCase { $this->assertEquals( "some text", $content->getNativeData() ); } - /** - * @covers WikiPage::getText - */ - public function testGetText() { - $this->hideDeprecated( "WikiPage::getText" ); - - $page = $this->newPage( "WikiPageTest_testGetText" ); - - $text = $page->getText(); - $this->assertFalse( $text ); - - # ----------------- - $this->createPage( $page, "some text", CONTENT_MODEL_WIKITEXT ); - - $text = $page->getText(); - $this->assertEquals( "some text", $text ); - } - /** * @covers WikiPage::getContentModel */ @@ -1034,63 +1005,6 @@ more stuff $this->assertEquals( "one", $page->getContent()->getNativeData() ); } - public static function provideGetAutosummary() { - return [ - [ - 'Hello there, world!', - '#REDIRECT [[Foo]]', - 0, - '/^Redirected page .*Foo/' - ], - - [ - null, - 'Hello world!', - EDIT_NEW, - '/^Created page .*Hello/' - ], - - [ - 'Hello there, world!', - '', - 0, - '/^Blanked/' - ], - - [ - 'Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy - eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam - voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet - clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.', - 'Hello world!', - 0, - '/^Replaced .*Hello/' - ], - - [ - 'foo', - 'bar', - 0, - '/^$/' - ], - ]; - } - - /** - * @dataProvider provideGetAutoSummary - * @covers WikiPage::getAutosummary - */ - public function testGetAutosummary( $old, $new, $flags, $expected ) { - $this->hideDeprecated( "WikiPage::getAutosummary" ); - - $page = $this->newPage( "WikiPageTest_testGetAutosummary" ); - - $summary = $page->getAutosummary( $old, $new, $flags ); - - $this->assertTrue( (bool)preg_match( $expected, $summary ), - "Autosummary didn't match expected pattern $expected: $summary" ); - } - public static function provideGetAutoDeleteReason() { return [ [ diff --git a/tests/phpunit/includes/registration/CoreVersionCheckerTest.php b/tests/phpunit/includes/registration/CoreVersionCheckerTest.php deleted file mode 100644 index 1dfcd82226..0000000000 --- a/tests/phpunit/includes/registration/CoreVersionCheckerTest.php +++ /dev/null @@ -1,38 +0,0 @@ -assertEquals( $expected, $checker->check( $constraint ) ); - } - - public static function provideCheck() { - return [ - // [ $wgVersion, constraint, expected ] - [ '1.25alpha', '>= 1.26', false ], - [ '1.25.0', '>= 1.26', false ], - [ '1.26alpha', '>= 1.26', true ], - [ '1.26alpha', '>= 1.26.0', true ], - [ '1.26alpha', '>= 1.26.0-stable', false ], - [ '1.26.0', '>= 1.26.0-stable', true ], - [ '1.26.1', '>= 1.26.0-stable', true ], - [ '1.27.1', '>= 1.26.0-stable', true ], - [ '1.26alpha', '>= 1.26.1', false ], - [ '1.26alpha', '>= 1.26alpha', true ], - [ '1.26alpha', '>= 1.25', true ], - [ '1.26.0-alpha.14', '>= 1.26.0-alpha.15', false ], - [ '1.26.0-alpha.14', '>= 1.26.0-alpha.10', true ], - [ '1.26.1', '>= 1.26.2, <=1.26.0', false ], - [ '1.26.1', '^1.26.2', false ], - // Accept anything for un-parsable version strings - [ '1.26mwf14', '== 1.25alpha', true ], - [ 'totallyinvalid', '== 1.0', true ], - ]; - } -} diff --git a/tests/phpunit/includes/registration/ExtensionProcessorTest.php b/tests/phpunit/includes/registration/ExtensionProcessorTest.php index 11995de944..71f760dced 100644 --- a/tests/phpunit/includes/registration/ExtensionProcessorTest.php +++ b/tests/phpunit/includes/registration/ExtensionProcessorTest.php @@ -450,8 +450,9 @@ class ExtensionProcessorTest extends MediaWikiTestCase { $globalSettings = TestingAccessWrapper::newFromClass( ExtensionProcessor::class )->globalSettings; + $version = ExtensionRegistry::MANIFEST_VERSION; $schema = FormatJson::decode( - file_get_contents( "$IP/docs/extension.schema.json" ), + file_get_contents( "$IP/docs/extension.schema.v$version.json" ), true ); $missing = []; diff --git a/tests/phpunit/includes/registration/ExtensionRegistryTest.php b/tests/phpunit/includes/registration/ExtensionRegistryTest.php index 1de42650fd..9b57e1c3d1 100644 --- a/tests/phpunit/includes/registration/ExtensionRegistryTest.php +++ b/tests/phpunit/includes/registration/ExtensionRegistryTest.php @@ -259,7 +259,7 @@ class ExtensionRegistryTest extends MediaWikiTestCase { 'JsonZeroConfig' => [ 'namespace' => 480, 'nsName' => 'Zero', - 'isLocal' => false, + 'isLocal' => true, ], ], ], diff --git a/tests/phpunit/includes/registration/VersionCheckerTest.php b/tests/phpunit/includes/registration/VersionCheckerTest.php new file mode 100644 index 0000000000..9ee58816df --- /dev/null +++ b/tests/phpunit/includes/registration/VersionCheckerTest.php @@ -0,0 +1,118 @@ +assertEquals( $expected, !(bool)$checker->checkArray( [ + 'FakeExtension' => [ + 'MediaWiki' => $constraint, + ], + ] ) + ); + } + + public static function provideCheck() { + return [ + // [ $wgVersion, constraint, expected ] + [ '1.25alpha', '>= 1.26', false ], + [ '1.25.0', '>= 1.26', false ], + [ '1.26alpha', '>= 1.26', true ], + [ '1.26alpha', '>= 1.26.0', true ], + [ '1.26alpha', '>= 1.26.0-stable', false ], + [ '1.26.0', '>= 1.26.0-stable', true ], + [ '1.26.1', '>= 1.26.0-stable', true ], + [ '1.27.1', '>= 1.26.0-stable', true ], + [ '1.26alpha', '>= 1.26.1', false ], + [ '1.26alpha', '>= 1.26alpha', true ], + [ '1.26alpha', '>= 1.25', true ], + [ '1.26.0-alpha.14', '>= 1.26.0-alpha.15', false ], + [ '1.26.0-alpha.14', '>= 1.26.0-alpha.10', true ], + [ '1.26.1', '>= 1.26.2, <=1.26.0', false ], + [ '1.26.1', '^1.26.2', false ], + // Accept anything for un-parsable version strings + [ '1.26mwf14', '== 1.25alpha', true ], + [ 'totallyinvalid', '== 1.0', true ], + ]; + } + + /** + * @dataProvider provideType + */ + public function testType( $given, $expected ) { + $checker = new VersionChecker( '1.0.0' ); + $checker + ->setLoadedExtensionsAndSkins( [ + 'FakeDependency' => [ + 'version' => '1.0.0', + ], + ] ); + $this->assertEquals( $expected, $checker->checkArray( [ + 'FakeExtension' => $given, + ] ) + ); + } + + public static function provideType() { + return [ + // valid type + [ + [ + 'extensions' => [ + 'FakeDependency' => '1.0.0' + ] + ], + [] + ], + [ + [ + 'MediaWiki' => '1.0.0' + ], + [] + ], + ]; + } + + /** + * Check, if a non-parsable version constraint does not throw an exception or + * returns any error message. + */ + public function testInvalidConstraint() { + $checker = new VersionChecker( '1.0.0' ); + $checker + ->setLoadedExtensionsAndSkins( [ + 'FakeDependency' => [ + 'version' => 'not really valid', + ], + ] ); + $this->assertEquals( [ "FakeDependency does not have a valid version string." ], + $checker->checkArray( [ + 'FakeExtension' => [ + 'extensions' => [ + 'FakeDependency' => '1.24.3', + ], + ], + ] ) + ); + + $checker = new VersionChecker( '1.0.0' ); + $checker + ->setLoadedExtensionsAndSkins( [ + 'FakeDependency' => [ + 'version' => '1.24.3', + ], + ] ); + + $this->setExpectedException( 'UnexpectedValueException' ); + $checker->checkArray( [ + 'FakeExtension' => [ + 'FakeDependency' => 'not really valid', + ] + ] ); + } +} diff --git a/tests/phpunit/includes/resourceloader/ResourceLoaderClientHtmlTest.php b/tests/phpunit/includes/resourceloader/ResourceLoaderClientHtmlTest.php index d2a0724ccf..528c3220e8 100644 --- a/tests/phpunit/includes/resourceloader/ResourceLoaderClientHtmlTest.php +++ b/tests/phpunit/includes/resourceloader/ResourceLoaderClientHtmlTest.php @@ -114,22 +114,22 @@ class ResourceLoaderClientHtmlTest extends PHPUnit_Framework_TestCase { 'test.scripts.mixed.user.empty' => 'ready', ], 'general' => [ - 'top' => [ 'test.top' ], - 'bottom' => [ 'test' ], + 'test', + 'test.top', ], 'styles' => [ 'test.styles.mixed', 'test.styles.pure', ], 'scripts' => [ - 'top' => [ 'test.scripts.top' ], - 'bottom' => [ 'test.scripts' ], + 'test.scripts', + 'test.scripts.top', ], 'embed' => [ 'styles' => [ 'test.styles.private' ], 'general' => [ - 'top' => [ 'test.private.top' ], - 'bottom' => [ 'test.private.bottom' ], + 'test.private.bottom', + 'test.private.top', ], ], ]; @@ -202,13 +202,7 @@ class ResourceLoaderClientHtmlTest extends PHPUnit_Framework_TestCase { 'test.scripts', ] ); - // @codingStandardsIgnoreStart Generic.Files.LineLength - $expected = ''; - // @codingStandardsIgnoreEnd + $expected = ''; $expected = self::expandVariables( $expected ); $this->assertEquals( $expected, $client->getBodyHtml() ); diff --git a/tests/phpunit/includes/resourceloader/ResourceLoaderContextTest.php b/tests/phpunit/includes/resourceloader/ResourceLoaderContextTest.php index 1093039f88..b658efba96 100644 --- a/tests/phpunit/includes/resourceloader/ResourceLoaderContextTest.php +++ b/tests/phpunit/includes/resourceloader/ResourceLoaderContextTest.php @@ -14,6 +14,7 @@ class ResourceLoaderContextTest extends PHPUnit_Framework_TestCase { 'ResourceLoaderDebug' => false, 'DefaultSkin' => 'fallback', 'LanguageCode' => 'nl', + 'LoadScript' => '/w/load.php', ] ) ); } @@ -104,4 +105,13 @@ class ResourceLoaderContextTest extends PHPUnit_Framework_TestCase { $this->assertSame( 'Example', $ctx->getUser() ); $this->assertEquals( 'Example', $ctx->getUserObj()->getName() ); } + + public function testMsg() { + $ctx = new ResourceLoaderContext( $this->getResourceLoader(), new FauxRequest( [ + 'lang' => 'en' + ] ) ); + $msg = $ctx->msg( 'mainpage' ); + $this->assertInstanceOf( Message::class, $msg ); + $this->assertSame( 'Main Page', $msg->useDatabase( false )->plain() ); + } } diff --git a/tests/phpunit/includes/resourceloader/ResourceLoaderFileModuleTest.php b/tests/phpunit/includes/resourceloader/ResourceLoaderFileModuleTest.php index 8b29983e70..4a3b90a294 100644 --- a/tests/phpunit/includes/resourceloader/ResourceLoaderFileModuleTest.php +++ b/tests/phpunit/includes/resourceloader/ResourceLoaderFileModuleTest.php @@ -130,7 +130,7 @@ class ResourceLoaderFileModuleTest extends ResourceLoaderTestCase { $modules = self::getModules(); $rl = new ResourceLoaderFileModule( $modules[$name] ); $rl->setName( $name ); - $ctx = $this->getResourceLoaderContext( 'en', 'ltr' ); + $ctx = $this->getResourceLoaderContext(); $this->assertEquals( $rl->getScript( $ctx ), $expected ); } @@ -210,8 +210,14 @@ class ResourceLoaderFileModuleTest extends ResourceLoaderTestCase { ] ); $expectedModule->setName( 'testing' ); - $contextLtr = $this->getResourceLoaderContext( 'en', 'ltr' ); - $contextRtl = $this->getResourceLoaderContext( 'he', 'rtl' ); + $contextLtr = $this->getResourceLoaderContext( [ + 'lang' => 'en', + 'dir' => 'ltr', + ] ); + $contextRtl = $this->getResourceLoaderContext( [ + 'lang' => 'he', + 'dir' => 'rtl', + ] ); // Since we want to compare the effect of @noflip+@embed against the effect of just @embed, and // the @noflip annotations are always preserved, we need to strip them first. @@ -282,9 +288,9 @@ class ResourceLoaderFileModuleTest extends ResourceLoaderTestCase { 'File has leading BOM' ); - $contextLtr = $this->getResourceLoaderContext( 'en', 'ltr' ); + $context = $this->getResourceLoaderContext(); $this->assertEquals( - $testModule->getStyles( $contextLtr ), + $testModule->getStyles( $context ), [ 'all' => ".efbbbf_bom_char_at_start_of_file {}\n" ], 'Leading BOM removed when concatenating files' ); diff --git a/tests/phpunit/includes/resourceloader/ResourceLoaderImageTest.php b/tests/phpunit/includes/resourceloader/ResourceLoaderImageTest.php index 179a8ed98f..84b56d4f11 100644 --- a/tests/phpunit/includes/resourceloader/ResourceLoaderImageTest.php +++ b/tests/phpunit/includes/resourceloader/ResourceLoaderImageTest.php @@ -61,7 +61,10 @@ class ResourceLoaderImageTest extends ResourceLoaderTestCase { static $contexts = []; $image = $this->getTestImage( $imageName ); - $context = $this->getResourceLoaderContext( $languageCode, $dirMap[$languageCode] ); + $context = $this->getResourceLoaderContext( [ + 'lang' => $languageCode, + 'dir' => $dirMap[$languageCode], + ] ); $this->assertEquals( $image->getPath( $context ), $this->imagesPath . '/' . $path ); } @@ -87,7 +90,7 @@ class ResourceLoaderImageTest extends ResourceLoaderTestCase { * @covers ResourceLoaderImage::massageSvgPathdata */ public function testGetImageData() { - $context = $this->getResourceLoaderContext( 'en', 'ltr' ); + $context = $this->getResourceLoaderContext(); $image = $this->getTestImage( 'remove' ); $data = file_get_contents( $this->imagesPath . '/remove.svg' ); diff --git a/tests/phpunit/includes/resourceloader/ResourceLoaderTest.php b/tests/phpunit/includes/resourceloader/ResourceLoaderTest.php index c24a3211e7..cde1e5abb3 100644 --- a/tests/phpunit/includes/resourceloader/ResourceLoaderTest.php +++ b/tests/phpunit/includes/resourceloader/ResourceLoaderTest.php @@ -14,6 +14,10 @@ class ResourceLoaderTest extends ResourceLoaderTestCase { 'Foo' => '#eeeeee', 'bar' => 5, ], + // Clear ResourceLoaderGetConfigVars hooks (called by StartupModule) + // to avoid notices during testMakeModuleResponse for missing + // wgResourceLoaderLESSVars keys in extension hooks. + 'wgHooks' => [], ] ); } @@ -51,6 +55,16 @@ class ResourceLoaderTest extends ResourceLoaderTestCase { $this->assertEquals( $module, $resourceLoader->getModule( 'test' ) ); } + /** + * @covers ResourceLoader::register + */ + public function testRegisterEmptyString() { + $module = new ResourceLoaderTestModule(); + $resourceLoader = new EmptyResourceLoader(); + $resourceLoader->register( '', $module ); + $this->assertEquals( $module, $resourceLoader->getModule( '' ) ); + } + /** * @covers ResourceLoader::register */ @@ -431,4 +445,135 @@ mw.example(); $this->assertTrue( true ); } } + + protected function getFailFerryMock() { + $mock = $this->getMockBuilder( ResourceLoaderTestModule::class ) + ->setMethods( [ 'getScript' ] ) + ->getMock(); + $mock->method( 'getScript' )->will( $this->throwException( + new Exception( 'Ferry not found' ) + ) ); + return $mock; + } + + protected function getSimpleModuleMock( $script = '' ) { + $mock = $this->getMockBuilder( ResourceLoaderTestModule::class ) + ->setMethods( [ 'getScript' ] ) + ->getMock(); + $mock->method( 'getScript' )->willReturn( $script ); + return $mock; + } + + /** + * @covers ResourceLoader::getCombinedVersion + */ + public function testGetCombinedVersion() { + $rl = new EmptyResourceLoader(); + $rl->register( [ + 'foo' => self::getSimpleModuleMock(), + 'ferry' => self::getFailFerryMock(), + 'bar' => self::getSimpleModuleMock(), + ] ); + $context = $this->getResourceLoaderContext( [], $rl ); + + $this->assertEquals( + ResourceLoader::makeHash( self::BLANK_VERSION ), + $rl->getCombinedVersion( $context, [ 'foo' ] ), + 'compute foo' + ); + + // Verify that getCombinedVersion() does not throw when ferry fails. + // Instead it gracefully continues to combine the remaining modules. + $this->assertEquals( + ResourceLoader::makeHash( self::BLANK_VERSION . self::BLANK_VERSION ), + $rl->getCombinedVersion( $context, [ 'foo', 'ferry', 'bar' ] ), + 'compute foo+ferry+bar (T152266)' + ); + } + + /** + * Verify that when building module content in a load.php response, + * an exception from one module will not break script output from + * other modules. + */ + public function testMakeModuleResponseError() { + $modules = [ + 'foo' => self::getSimpleModuleMock( 'foo();' ), + 'ferry' => self::getFailFerryMock(), + 'bar' => self::getSimpleModuleMock( 'bar();' ), + ]; + $rl = new EmptyResourceLoader(); + $rl->register( $modules ); + $context = $this->getResourceLoaderContext( + [ + 'modules' => 'foo|ferry|bar', + 'only' => 'scripts', + ], + $rl + ); + + $response = $rl->makeModuleResponse( $context, $modules ); + $errors = $rl->getErrors(); + + $this->assertCount( 1, $errors ); + $this->assertRegExp( '/Ferry not found/', $errors[0] ); + $this->assertEquals( + 'foo();bar();mw.loader.state( { + "ferry": "error", + "foo": "ready", + "bar": "ready" +} );', + $response + ); + } + + /** + * Verify that when building the startup module response, + * an exception from one module class will not break the entire + * startup module response. See T152266. + */ + public function testMakeModuleResponseStartupError() { + $rl = new EmptyResourceLoader(); + $rl->register( [ + 'foo' => self::getSimpleModuleMock( 'foo();' ), + 'ferry' => self::getFailFerryMock(), + 'bar' => self::getSimpleModuleMock( 'bar();' ), + 'startup' => [ 'class' => 'ResourceLoaderStartUpModule' ], + ] ); + $context = $this->getResourceLoaderContext( + [ + 'modules' => 'startup', + 'only' => 'scripts', + ], + $rl + ); + + $this->assertEquals( + [ 'foo', 'ferry', 'bar', 'startup' ], + $rl->getModuleNames(), + 'getModuleNames' + ); + + $modules = [ 'startup' => $rl->getModule( 'startup' ) ]; + $response = $rl->makeModuleResponse( $context, $modules ); + $errors = $rl->getErrors(); + + $this->assertRegExp( '/Ferry not found/', $errors[0] ); + $this->assertCount( 1, $errors ); + $this->assertRegExp( + '/isCompatible.*function startUp/s', + $response, + 'startup response undisrupted (T152266)' + ); + $this->assertRegExp( + '/register\([^)]+"ferry",\s*""/s', + $response, + 'startup response registers broken module' + ); + $this->assertRegExp( + '/state\([^)]+"ferry":\s*"error"/s', + $response, + 'startup response sets state to error' + ); + } } diff --git a/tests/phpunit/includes/search/SearchEnginePrefixTest.php b/tests/phpunit/includes/search/SearchEnginePrefixTest.php index e0de58866f..a88264bb78 100644 --- a/tests/phpunit/includes/search/SearchEnginePrefixTest.php +++ b/tests/phpunit/includes/search/SearchEnginePrefixTest.php @@ -126,11 +126,11 @@ class SearchEnginePrefixTest extends MediaWikiLangTestCase { 'results' => [ 'Special:ActiveUsers', 'Special:AllMessages', - 'Special:AllMyFiles', + 'Special:AllMyUploads', ], // Third result when testing offset 'offsetresult' => [ - 'Special:AllMyUploads', + 'Special:AllPages', ], ] ], [ [ @@ -143,7 +143,7 @@ class SearchEnginePrefixTest extends MediaWikiLangTestCase { ], // Third result when testing offset 'offsetresult' => [ - 'Special:UncategorizedImages', + 'Special:UncategorizedPages', ], ] ], [ [ diff --git a/tests/phpunit/includes/session/SessionProviderTest.php b/tests/phpunit/includes/session/SessionProviderTest.php index 4cbeeb954c..8284d05e97 100644 --- a/tests/phpunit/includes/session/SessionProviderTest.php +++ b/tests/phpunit/includes/session/SessionProviderTest.php @@ -138,7 +138,6 @@ class SessionProviderTest extends MediaWikiTestCase { $ex->getMessage() ); } - } public function testHashToSessionId() { diff --git a/tests/phpunit/includes/session/SessionTest.php b/tests/phpunit/includes/session/SessionTest.php index 3815416c31..e6a6ad351f 100644 --- a/tests/phpunit/includes/session/SessionTest.php +++ b/tests/phpunit/includes/session/SessionTest.php @@ -299,7 +299,6 @@ class SessionTest extends MediaWikiTestCase { $session->resetAllTokens(); $this->assertArrayNotHasKey( 'wsTokenSecrets', $backend->data ); - } /** diff --git a/tests/phpunit/includes/specialpage/SpecialPageFactoryTest.php b/tests/phpunit/includes/specialpage/SpecialPageFactoryTest.php index 145ffb3547..f79f6e48c5 100644 --- a/tests/phpunit/includes/specialpage/SpecialPageFactoryTest.php +++ b/tests/phpunit/includes/specialpage/SpecialPageFactoryTest.php @@ -57,17 +57,19 @@ class SpecialPageFactoryTest extends MediaWikiTestCase { $specialPageTestHelper = new SpecialPageTestHelper(); return [ - 'class name' => [ 'SpecialAllPages' ], + 'class name' => [ 'SpecialAllPages', false ], 'closure' => [ function () { return new SpecialAllPages(); - } ], - 'function' => [ [ $this, 'newSpecialAllPages' ] ], - 'callback string' => [ 'SpecialPageTestHelper::newSpecialAllPages' ], + }, false ], + 'function' => [ [ $this, 'newSpecialAllPages' ], false ], + 'callback string' => [ 'SpecialPageTestHelper::newSpecialAllPages', false ], 'callback with object' => [ - [ $specialPageTestHelper, 'newSpecialAllPages' ] + [ $specialPageTestHelper, 'newSpecialAllPages' ], + false ], 'callback array' => [ - [ 'SpecialPageTestHelper', 'newSpecialAllPages' ] + [ 'SpecialPageTestHelper', 'newSpecialAllPages' ], + false ] ]; } @@ -76,7 +78,7 @@ class SpecialPageFactoryTest extends MediaWikiTestCase { * @covers SpecialPageFactory::getPage * @dataProvider specialPageProvider */ - public function testGetPage( $spec ) { + public function testGetPage( $spec, $shouldReuseInstance ) { $this->mergeMwGlobalArrayValue( 'wgSpecialPages', [ 'testdummy' => $spec ] ); SpecialPageFactory::resetList(); @@ -84,7 +86,7 @@ class SpecialPageFactoryTest extends MediaWikiTestCase { $this->assertInstanceOf( 'SpecialPage', $page ); $page2 = SpecialPageFactory::getPage( 'testdummy' ); - $this->assertEquals( true, $page2 === $page, "Should re-use instance:" ); + $this->assertEquals( $shouldReuseInstance, $page2 === $page, "Should re-use instance:" ); } /** diff --git a/tests/phpunit/includes/specials/QueryAllSpecialPagesTest.php b/tests/phpunit/includes/specials/QueryAllSpecialPagesTest.php index 061e59823a..c1083afdbc 100644 --- a/tests/phpunit/includes/specials/QueryAllSpecialPagesTest.php +++ b/tests/phpunit/includes/specials/QueryAllSpecialPagesTest.php @@ -22,7 +22,7 @@ class QueryAllSpecialPagesTest extends MediaWikiTestCase { * Pages whose query use the same DB table more than once. * This is used to skip testing those pages when run against a MySQL backend * which does not support reopening a temporary table. See upstream bug: - * http://bugs.mysql.com/bug.php?id=10327 + * https://bugs.mysql.com/bug.php?id=10327 */ protected $reopensTempTable = [ 'BrokenRedirects', @@ -51,7 +51,7 @@ class QueryAllSpecialPagesTest extends MediaWikiTestCase { foreach ( $this->queryPages as $page ) { // With MySQL, skips special pages reopening a temporary table - // See http://bugs.mysql.com/bug.php?id=10327 + // See https://bugs.mysql.com/bug.php?id=10327 if ( $wgDBtype === 'mysql' && in_array( $page->getName(), $this->reopensTempTable ) diff --git a/tests/phpunit/includes/specials/SpecialRecentchangesTest.php b/tests/phpunit/includes/specials/SpecialRecentchangesTest.php index cc16e5f7bd..c11e6a3927 100644 --- a/tests/phpunit/includes/specials/SpecialRecentchangesTest.php +++ b/tests/phpunit/includes/specials/SpecialRecentchangesTest.php @@ -22,9 +22,17 @@ class SpecialRecentchangesTest extends MediaWikiTestCase { protected $rc; /** helper to test SpecialRecentchanges::buildMainQueryConds() */ - private function assertConditions( $expected, $requestOptions = null, $message = '' ) { + private function assertConditions( + $expected, + $requestOptions = null, + $message = '', + $user = null + ) { $context = new RequestContext; $context->setRequest( new FauxRequest( $requestOptions ) ); + if ( $user ) { + $context->setUser( $user ); + } # setup the rc object $this->rc = new SpecialRecentChanges(); @@ -40,12 +48,24 @@ class SpecialRecentchangesTest extends MediaWikiTestCase { ); $this->assertEquals( - $expected, - $queryConditions, + self::normalizeCondition( $expected ), + self::normalizeCondition( $queryConditions ), $message ); } + private static function normalizeCondition( $conds ) { + $normalized = array_map( + function ( $k, $v ) { + return is_numeric( $k ) ? $v : "$k = $v"; + }, + array_keys( $conds ), + $conds + ); + sort( $normalized ); + return $normalized; + } + /** return false if condition begin with 'rc_timestamp ' */ private static function filterOutRcTimestampCondition( $var ) { return ( false === strpos( $var, 'rc_timestamp ' ) ); @@ -55,8 +75,8 @@ class SpecialRecentchangesTest extends MediaWikiTestCase { $this->assertConditions( [ # expected 'rc_bot' => 0, - 0 => "rc_type != '6'", - 1 => "rc_namespace = '0'", + "rc_type != '6'", + "rc_namespace = '0'", ], [ 'namespace' => NS_MAIN, @@ -69,8 +89,8 @@ class SpecialRecentchangesTest extends MediaWikiTestCase { $this->assertConditions( [ # expected 'rc_bot' => 0, - 0 => "rc_type != '6'", - 1 => sprintf( "rc_namespace != '%s'", NS_MAIN ), + "rc_type != '6'", + "rc_namespace != '0'", ], [ 'namespace' => NS_MAIN, @@ -88,8 +108,8 @@ class SpecialRecentchangesTest extends MediaWikiTestCase { $this->assertConditions( [ # expected 'rc_bot' => 0, - 0 => "rc_type != '6'", - 1 => sprintf( "(rc_namespace = '%s' OR rc_namespace = '%s')", $ns1, $ns2 ), + "rc_type != '6'", + "(rc_namespace = '$ns1' OR rc_namespace = '$ns2')", ], [ 'namespace' => $ns1, @@ -107,8 +127,8 @@ class SpecialRecentchangesTest extends MediaWikiTestCase { $this->assertConditions( [ # expected 'rc_bot' => 0, - 0 => "rc_type != '6'", - 1 => sprintf( "(rc_namespace != '%s' AND rc_namespace != '%s')", $ns1, $ns2 ), + "rc_type != '6'", + "(rc_namespace != '$ns1' AND rc_namespace != '$ns2')", ], [ 'namespace' => $ns1, @@ -129,4 +149,248 @@ class SpecialRecentchangesTest extends MediaWikiTestCase { [ NS_TALK, NS_MAIN ], ]; } + + public function testRcHidemyselfFilter() { + $user = $this->getTestUser()->getUser(); + $this->assertConditions( + [ # expected + 'rc_bot' => 0, + "rc_user != '{$user->getId()}'", + "rc_type != '6'", + ], + [ + 'hidemyself' => 1, + ], + "rc conditions: hidemyself=1 (logged in)", + $user + ); + + $user = User::newFromName( '10.11.12.13', false ); + $this->assertConditions( + [ # expected + 'rc_bot' => 0, + "rc_user_text != '10.11.12.13'", + "rc_type != '6'", + ], + [ + 'hidemyself' => 1, + ], + "rc conditions: hidemyself=1 (anon)", + $user + ); + } + + public function testRcHidebyothersFilter() { + $user = $this->getTestUser()->getUser(); + $this->assertConditions( + [ # expected + 'rc_bot' => 0, + "rc_user = '{$user->getId()}'", + "rc_type != '6'", + ], + [ + 'hidebyothers' => 1, + ], + "rc conditions: hidebyothers=1 (logged in)", + $user + ); + + $user = User::newFromName( '10.11.12.13', false ); + $this->assertConditions( + [ # expected + 'rc_bot' => 0, + "rc_user_text = '10.11.12.13'", + "rc_type != '6'", + ], + [ + 'hidebyothers' => 1, + ], + "rc conditions: hidebyothers=1 (anon)", + $user + ); + } + + public function testRcHidemyselfHidebyothersFilter() { + $user = $this->getTestUser()->getUser(); + $this->assertConditions( + [ # expected + 'rc_bot' => 0, + "rc_user != '{$user->getId()}'", + "rc_user = '{$user->getId()}'", + "rc_type != '6'", + ], + [ + 'hidemyself' => 1, + 'hidebyothers' => 1, + ], + "rc conditions: hidemyself=1 hidebyothers=1 (logged in)", + $user + ); + } + + public function testRcHidepageedits() { + $this->assertConditions( + [ # expected + 'rc_bot' => 0, + "rc_type != '6'", + "rc_type != '0'", + ], + [ + 'hidepageedits' => 1, + ], + "rc conditions: hidepageedits=1" + ); + } + + public function testRcHidenewpages() { + $this->assertConditions( + [ # expected + 'rc_bot' => 0, + "rc_type != '6'", + "rc_type != '1'", + ], + [ + 'hidenewpages' => 1, + ], + "rc conditions: hidenewpages=1" + ); + } + + public function testRcHidelog() { + $this->assertConditions( + [ # expected + 'rc_bot' => 0, + "rc_type != '6'", + "rc_type != '3'", + ], + [ + 'hidelog' => 1, + ], + "rc conditions: hidelog=1" + ); + } + + public function testRcHidehumans() { + $this->assertConditions( + [ # expected + 'rc_bot' => 1, + "rc_type != '6'", + ], + [ + 'hidebots' => 0, + 'hidehumans' => 1, + ], + "rc conditions: hidebots=0 hidehumans=1" + ); + } + + public function testRcHidepatrolledDisabledFilter() { + $user = $this->getTestUser()->getUser(); + $this->assertConditions( + [ # expected + 'rc_bot' => 0, + "rc_type != '6'", + ], + [ + 'hidepatrolled' => 1, + ], + "rc conditions: hidepatrolled=1 (user not allowed)", + $user + ); + } + + public function testRcHideunpatrolledDisabledFilter() { + $user = $this->getTestUser()->getUser(); + $this->assertConditions( + [ # expected + 'rc_bot' => 0, + "rc_type != '6'", + ], + [ + 'hideunpatrolled' => 1, + ], + "rc conditions: hideunpatrolled=1 (user not allowed)", + $user + ); + } + public function testRcHidepatrolledFilter() { + $user = $this->getTestSysop()->getUser(); + $this->assertConditions( + [ # expected + 'rc_bot' => 0, + "rc_patrolled = 0", + "rc_type != '6'", + ], + [ + 'hidepatrolled' => 1, + ], + "rc conditions: hidepatrolled=1", + $user + ); + } + + public function testRcHideunpatrolledFilter() { + $user = $this->getTestSysop()->getUser(); + $this->assertConditions( + [ # expected + 'rc_bot' => 0, + "rc_patrolled = 1", + "rc_type != '6'", + ], + [ + 'hideunpatrolled' => 1, + ], + "rc conditions: hideunpatrolled=1", + $user + ); + } + + public function testRcHideminorFilter() { + $this->assertConditions( + [ # expected + 'rc_bot' => 0, + "rc_minor = 0", + "rc_type != '6'", + ], + [ + 'hideminor' => 1, + ], + "rc conditions: hideminor=1" + ); + } + + public function testRcHidemajorFilter() { + $this->assertConditions( + [ # expected + 'rc_bot' => 0, + "rc_minor = 1", + "rc_type != '6'", + ], + [ + 'hidemajor' => 1, + ], + "rc conditions: hidemajor=1" + ); + } + + // This is probably going to change when we do auto-fix of + // filters combinations that don't make sense but for now + // it's the behavior therefore it's the test. + public function testRcHidepatrolledHideunpatrolledFilter() { + $user = $this->getTestSysop()->getUser(); + $this->assertConditions( + [ # expected + 'rc_bot' => 0, + "rc_patrolled = 0", + "rc_patrolled = 1", + "rc_type != '6'", + ], + [ + 'hidepatrolled' => 1, + 'hideunpatrolled' => 1, + ], + "rc conditions: hidepatrolled=1 hideunpatrolled=1", + $user + ); + } } diff --git a/tests/phpunit/includes/upload/UploadBaseTest.php b/tests/phpunit/includes/upload/UploadBaseTest.php index a44926b208..6be272fb61 100644 --- a/tests/phpunit/includes/upload/UploadBaseTest.php +++ b/tests/phpunit/includes/upload/UploadBaseTest.php @@ -349,7 +349,7 @@ class UploadBaseTest extends MediaWikiTestCase { ], [ // This currently doesn't seem to work in any browsers, but in case - // http://www.w3.org/TR/css3-images/ is implemented for SVG files + // https://www.w3.org/TR/css3-images/ is implemented for SVG files '', true, true, diff --git a/tests/phpunit/includes/upload/UploadFromUrlTest.php b/tests/phpunit/includes/upload/UploadFromUrlTest.php index 6d17a68c7d..62081aa35d 100644 --- a/tests/phpunit/includes/upload/UploadFromUrlTest.php +++ b/tests/phpunit/includes/upload/UploadFromUrlTest.php @@ -58,7 +58,7 @@ class UploadFromUrlTest extends ApiTestCase { $this->doApiRequest( [ 'action' => 'upload', ] ); - } catch ( UsageException $e ) { + } catch ( ApiUsageException $e ) { $exception = true; $this->assertEquals( "The token parameter must be set", $e->getMessage() ); } @@ -70,7 +70,7 @@ class UploadFromUrlTest extends ApiTestCase { 'action' => 'upload', 'token' => $token, ], $data ); - } catch ( UsageException $e ) { + } catch ( ApiUsageException $e ) { $exception = true; $this->assertEquals( "One of the parameters sessionkey, file, url is required", $e->getMessage() ); @@ -84,7 +84,7 @@ class UploadFromUrlTest extends ApiTestCase { 'url' => 'http://www.example.com/test.png', 'token' => $token, ], $data ); - } catch ( UsageException $e ) { + } catch ( ApiUsageException $e ) { $exception = true; $this->assertEquals( "The filename parameter must be set", $e->getMessage() ); } @@ -99,7 +99,7 @@ class UploadFromUrlTest extends ApiTestCase { 'filename' => 'UploadFromUrlTest.png', 'token' => $token, ], $data ); - } catch ( UsageException $e ) { + } catch ( ApiUsageException $e ) { $exception = true; $this->assertEquals( "Permission denied", $e->getMessage() ); } diff --git a/tests/phpunit/includes/user/PasswordResetTest.php b/tests/phpunit/includes/user/PasswordResetTest.php index 4db636b126..7ff882a5ad 100644 --- a/tests/phpunit/includes/user/PasswordResetTest.php +++ b/tests/phpunit/includes/user/PasswordResetTest.php @@ -11,7 +11,7 @@ class PasswordResetTest extends PHPUnit_Framework_TestCase { */ public function testIsAllowed( $passwordResetRoutes, $enableEmail, $allowsAuthenticationDataChange, $canEditPrivate, $canSeePassword, - $userIsBlocked, $isAllowed, $isAllowedToDisplayPassword + $userIsBlocked, $isAllowed ) { $config = new HashConfig( [ 'PasswordResetRoutes' => $passwordResetRoutes, @@ -40,8 +40,6 @@ class PasswordResetTest extends PHPUnit_Framework_TestCase { $passwordReset = new PasswordReset( $config, $authManager ); $this->assertSame( $isAllowed, $passwordReset->isAllowed( $user )->isGood() ); - $this->assertSame( $isAllowedToDisplayPassword, - $passwordReset->isAllowed( $user, true )->isGood() ); } public function provideIsAllowed() { @@ -54,7 +52,6 @@ class PasswordResetTest extends PHPUnit_Framework_TestCase { 'canSeePassword' => true, 'userIsBlocked' => false, 'isAllowed' => false, - 'isAllowedToDisplayPassword' => false, ], [ 'passwordResetRoutes' => [ 'username' => true ], @@ -64,7 +61,6 @@ class PasswordResetTest extends PHPUnit_Framework_TestCase { 'canSeePassword' => true, 'userIsBlocked' => false, 'isAllowed' => false, - 'isAllowedToDisplayPassword' => false, ], [ 'passwordResetRoutes' => [ 'username' => true ], @@ -74,7 +70,6 @@ class PasswordResetTest extends PHPUnit_Framework_TestCase { 'canSeePassword' => true, 'userIsBlocked' => false, 'isAllowed' => false, - 'isAllowedToDisplayPassword' => false, ], [ 'passwordResetRoutes' => [ 'username' => true ], @@ -84,7 +79,6 @@ class PasswordResetTest extends PHPUnit_Framework_TestCase { 'canSeePassword' => true, 'userIsBlocked' => false, 'isAllowed' => false, - 'isAllowedToDisplayPassword' => false, ], [ 'passwordResetRoutes' => [ 'username' => true ], @@ -94,7 +88,6 @@ class PasswordResetTest extends PHPUnit_Framework_TestCase { 'canSeePassword' => true, 'userIsBlocked' => true, 'isAllowed' => false, - 'isAllowedToDisplayPassword' => false, ], [ 'passwordResetRoutes' => [ 'username' => true ], @@ -104,7 +97,6 @@ class PasswordResetTest extends PHPUnit_Framework_TestCase { 'canSeePassword' => false, 'userIsBlocked' => false, 'isAllowed' => true, - 'isAllowedToDisplayPassword' => false, ], [ 'passwordResetRoutes' => [ 'username' => true ], @@ -114,7 +106,6 @@ class PasswordResetTest extends PHPUnit_Framework_TestCase { 'canSeePassword' => true, 'userIsBlocked' => false, 'isAllowed' => true, - 'isAllowedToDisplayPassword' => true, ], ]; } diff --git a/tests/phpunit/includes/user/UserTest.php b/tests/phpunit/includes/user/UserTest.php index 34548c0481..0819bf255c 100644 --- a/tests/phpunit/includes/user/UserTest.php +++ b/tests/phpunit/includes/user/UserTest.php @@ -3,6 +3,8 @@ define( 'NS_UNITTEST', 5600 ); define( 'NS_UNITTEST_TALK', 5601 ); +use MediaWiki\MediaWikiServices; + /** * @group Database */ @@ -269,7 +271,6 @@ class UserTest extends MediaWikiTestCase { // let the user have a few (3) edits $page = WikiPage::factory( Title::newFromText( 'Help:UserTest_EditCount' ) ); for ( $i = 0; $i < 3; $i++ ) { - $page->doEditContent( ContentHandler::makeContent( (string)$i, $page->getTitle() ), 'test', @@ -348,6 +349,12 @@ class UserTest extends MediaWikiTestCase { $user->saveSettings(); $user = User::newFromName( $user->getName() ); + $user->load( User::READ_LATEST ); + $this->assertEquals( 'test', $user->getOption( 'userjs-someoption' ) ); + $this->assertEquals( 200, $user->getOption( 'cols' ) ); + + $user = User::newFromName( $user->getName() ); + MediaWikiServices::getInstance()->getMainWANObjectCache()->clearProcessCache(); $this->assertEquals( 'test', $user->getOption( 'userjs-someoption' ) ); $this->assertEquals( 200, $user->getOption( 'cols' ) ); } @@ -505,7 +512,6 @@ class UserTest extends MediaWikiTestCase { public function testGetId() { $user = static::getTestUser()->getUser(); $this->assertTrue( $user->getId() > 0 ); - } /** @@ -580,4 +586,162 @@ class UserTest extends MediaWikiTestCase { $users->rewind(); $this->assertTrue( $user->equals( $users->current() ) ); } + + /** + * When a user is autoblocked a cookie is set with which to track them + * in case they log out and change IP addresses. + * @link https://phabricator.wikimedia.org/T5233 + */ + public function testAutoblockCookies() { + // Set up the bits of global configuration that we use. + $this->setMwGlobals( [ + 'wgCookieSetOnAutoblock' => true, + 'wgCookiePrefix' => 'wmsitetitle', + ] ); + + // 1. Log in a test user, and block them. + $user1tmp = $this->getTestUser()->getUser(); + $request1 = new FauxRequest(); + $request1->getSession()->setUser( $user1tmp ); + $expiryFiveDays = time() + ( 5 * 24 * 60 * 60 ); + $block = new Block( [ + 'enableAutoblock' => true, + 'expiry' => wfTimestamp( TS_MW, $expiryFiveDays ), + ] ); + $block->setTarget( $user1tmp ); + $block->insert(); + $user1 = User::newFromSession( $request1 ); + $user1->mBlock = $block; + $user1->load(); + + // Confirm that the block has been applied as required. + $this->assertTrue( $user1->isLoggedIn() ); + $this->assertTrue( $user1->isBlocked() ); + $this->assertEquals( Block::TYPE_USER, $block->getType() ); + $this->assertTrue( $block->isAutoblocking() ); + $this->assertGreaterThanOrEqual( 1, $block->getId() ); + + // Test for the desired cookie name, value, and expiry. + $cookies = $request1->response()->getCookies(); + $this->assertArrayHasKey( 'wmsitetitleBlockID', $cookies ); + $this->assertEquals( $block->getId(), $cookies['wmsitetitleBlockID']['value'] ); + $this->assertEquals( $expiryFiveDays, $cookies['wmsitetitleBlockID']['expire'] ); + + // 2. Create a new request, set the cookies, and see if the (anon) user is blocked. + $request2 = new FauxRequest(); + $request2->setCookie( 'BlockID', $block->getId() ); + $user2 = User::newFromSession( $request2 ); + $user2->load(); + $this->assertNotEquals( $user1->getId(), $user2->getId() ); + $this->assertNotEquals( $user1->getToken(), $user2->getToken() ); + $this->assertTrue( $user2->isAnon() ); + $this->assertFalse( $user2->isLoggedIn() ); + $this->assertTrue( $user2->isBlocked() ); + $this->assertEquals( true, $user2->getBlock()->isAutoblocking() ); // Non-strict type-check. + // Can't directly compare the objects becuase of member type differences. + // One day this will work: $this->assertEquals( $block, $user2->getBlock() ); + $this->assertEquals( $block->getId(), $user2->getBlock()->getId() ); + $this->assertEquals( $block->getExpiry(), $user2->getBlock()->getExpiry() ); + + // 3. Finally, set up a request as a new user, and the block should still be applied. + $user3tmp = $this->getTestUser()->getUser(); + $request3 = new FauxRequest(); + $request3->getSession()->setUser( $user3tmp ); + $request3->setCookie( 'BlockID', $block->getId() ); + $user3 = User::newFromSession( $request3 ); + $user3->load(); + $this->assertTrue( $user3->isLoggedIn() ); + $this->assertTrue( $user3->isBlocked() ); + $this->assertEquals( true, $user3->getBlock()->isAutoblocking() ); // Non-strict type-check. + + // Clean up. + $block->delete(); + } + + /** + * Make sure that no cookie is set to track autoblocked users + * when $wgCookieSetOnAutoblock is false. + */ + public function testAutoblockCookiesDisabled() { + // Set up the bits of global configuration that we use. + $this->setMwGlobals( [ + 'wgCookieSetOnAutoblock' => false, + 'wgCookiePrefix' => 'wm_no_cookies', + ] ); + + // 1. Log in a test user, and block them. + $testUser = $this->getTestUser()->getUser(); + $request1 = new FauxRequest(); + $request1->getSession()->setUser( $testUser ); + $block = new Block( [ 'enableAutoblock' => true ] ); + $block->setTarget( $testUser ); + $block->insert(); + $user = User::newFromSession( $request1 ); + $user->mBlock = $block; + $user->load(); + + // 2. Test that the cookie IS NOT present. + $this->assertTrue( $user->isLoggedIn() ); + $this->assertTrue( $user->isBlocked() ); + $this->assertEquals( Block::TYPE_USER, $block->getType() ); + $this->assertTrue( $block->isAutoblocking() ); + $this->assertGreaterThanOrEqual( 1, $user->getBlockId() ); + $this->assertGreaterThanOrEqual( $block->getId(), $user->getBlockId() ); + $cookies = $request1->response()->getCookies(); + $this->assertArrayNotHasKey( 'wm_no_cookiesBlockID', $cookies ); + + // Clean up. + $block->delete(); + } + + /** + * When a user is autoblocked and a cookie is set to track them, the expiry time of the cookie + * should match the block's expiry. If the block is infinite, the cookie expiry time should + * match $wgCookieExpiration. If the expiry time is changed, the cookie's should change with it. + */ + public function testAutoblockCookieInfiniteExpiry() { + $cookieExpiration = 20 * 24 * 60 * 60; // 20 days + $this->setMwGlobals( [ + 'wgCookieSetOnAutoblock' => true, + 'wgCookieExpiration' => $cookieExpiration, + 'wgCookiePrefix' => 'wm_infinite_block', + ] ); + // 1. Log in a test user, and block them indefinitely. + $user1Tmp = $this->getTestUser()->getUser(); + $request1 = new FauxRequest(); + $request1->getSession()->setUser( $user1Tmp ); + $block = new Block( [ 'enableAutoblock' => true, 'expiry' => 'infinity' ] ); + $block->setTarget( $user1Tmp ); + $block->insert(); + $user1 = User::newFromSession( $request1 ); + $user1->mBlock = $block; + $user1->load(); + + // 2. Test the cookie's expiry timestamp. + $this->assertTrue( $user1->isLoggedIn() ); + $this->assertTrue( $user1->isBlocked() ); + $this->assertEquals( Block::TYPE_USER, $block->getType() ); + $this->assertTrue( $block->isAutoblocking() ); + $this->assertGreaterThanOrEqual( 1, $user1->getBlockId() ); + $cookies = $request1->response()->getCookies(); + // Calculate the expected cookie expiry date. + $this->assertArrayHasKey( 'wm_infinite_blockBlockID', $cookies ); + $this->assertEquals( time() + $cookieExpiration, $cookies['wm_infinite_blockBlockID']['expire'] ); + + // 3. Change the block's expiry (to 2 days), and the cookie's should be changed also. + $newExpiry = time() + 2 * 24 * 60 * 60; + $block->mExpiry = wfTimestamp( TS_MW, $newExpiry ); + $block->update(); + $user2tmp = $this->getTestUser()->getUser(); + $request2 = new FauxRequest(); + $request2->getSession()->setUser( $user2tmp ); + $user2 = User::newFromSession( $request2 ); + $user2->mBlock = $block; + $user2->load(); + $cookies = $request2->response()->getCookies(); + $this->assertEquals( $newExpiry, $cookies['wm_infinite_blockBlockID']['expire'] ); + + // Clean up. + $block->delete(); + } } diff --git a/tests/phpunit/maintenance/MaintenanceTest.php b/tests/phpunit/maintenance/MaintenanceTest.php index bd10856943..cb3d227203 100644 --- a/tests/phpunit/maintenance/MaintenanceTest.php +++ b/tests/phpunit/maintenance/MaintenanceTest.php @@ -5,6 +5,7 @@ // without changing the visibility and without working around hacks in // Maintenance.php // For the same reason, we cannot just use FakeMaintenance. +use MediaWiki\MediaWikiServices; /** * makes parts of the API of Maintenance that is hidden by protected visibily @@ -23,7 +24,6 @@ * Due to a hack in Maintenance.php using register_shutdown_function, be sure to * finally call simulateShutdown on MaintenanceFixup instance before a test * ends. - * */ class MaintenanceFixup extends Maintenance { @@ -826,7 +826,7 @@ class MaintenanceTest extends MediaWikiTestCase { public function testGetConfig() { $this->assertInstanceOf( 'Config', $this->m->getConfig() ); $this->assertSame( - ConfigFactory::getDefaultInstance()->makeConfig( 'main' ), + MediaWikiServices::getInstance()->getMainConfig(), $this->m->getConfig() ); } diff --git a/tests/phpunit/mocks/content/DummyContentHandlerForTesting.php b/tests/phpunit/mocks/content/DummyContentHandlerForTesting.php index 6ed4495dc2..d712254c22 100644 --- a/tests/phpunit/mocks/content/DummyContentHandlerForTesting.php +++ b/tests/phpunit/mocks/content/DummyContentHandlerForTesting.php @@ -34,7 +34,6 @@ class DummyContentHandlerForTesting extends ContentHandler { /** * Creates an empty Content object of the type supported by this ContentHandler. - * */ public function makeEmptyContent() { return new DummyContentForTesting( '' ); diff --git a/tests/phpunit/structure/ApiDocumentationTest.php b/tests/phpunit/structure/ApiDocumentationTest.php index 2049e38ba0..bc5a6bd6c7 100644 --- a/tests/phpunit/structure/ApiDocumentationTest.php +++ b/tests/phpunit/structure/ApiDocumentationTest.php @@ -137,6 +137,8 @@ class ApiDocumentationTest extends MediaWikiTestCase { // Messages for examples. foreach ( $module->getExamplesMessages() as $qs => $msg ) { + $this->assertStringStartsNotWith( 'api.php?', $qs, + "Query string must not begin with 'api.php?'" ); $this->checkMessage( $msg, "Example $qs" ); } } diff --git a/tests/phpunit/structure/ExtensionJsonValidationTest.php b/tests/phpunit/structure/ExtensionJsonValidationTest.php index e11fd8a548..8ba2aeb241 100644 --- a/tests/phpunit/structure/ExtensionJsonValidationTest.php +++ b/tests/phpunit/structure/ExtensionJsonValidationTest.php @@ -25,14 +25,16 @@ use JsonSchema\Validator; */ class ExtensionJsonValidationTest extends PHPUnit_Framework_TestCase { + /** + * @var ExtensionJsonValidator + */ + protected $validator; + public function setUp() { parent::setUp(); - if ( !class_exists( Validator::class ) ) { - $this->markTestSkipped( - 'The JsonSchema library cannot be found,' . - ' please install it through composer to run extension.json validation tests.' - ); - } + + $this->validator = new ExtensionJsonValidator( [ $this, 'markTestSkipped' ] ); + $this->validator->checkDependencies(); if ( !ExtensionRegistry::getInstance()->getAllThings() ) { $this->markTestSkipped( @@ -55,56 +57,12 @@ class ExtensionJsonValidationTest extends PHPUnit_Framework_TestCase { * @param string $path Path to thing's json file */ public function testPassesValidation( $path ) { - $data = json_decode( file_get_contents( $path ) ); - $this->assertInstanceOf( 'stdClass', $data, "$path is not valid JSON" ); - - $this->assertObjectHasAttribute( 'manifest_version', $data, - "$path does not have manifest_version set." ); - $version = $data->manifest_version; - if ( $version !== ExtensionRegistry::MANIFEST_VERSION ) { - $schemaPath = __DIR__ . "/../../../docs/extension.schema.v$version.json"; - } else { - $schemaPath = __DIR__ . '/../../../docs/extension.schema.json'; - } - - // Not too old - $this->assertTrue( - $version >= ExtensionRegistry::OLDEST_MANIFEST_VERSION, - "$path is using a non-supported schema version" - ); - // Not too new - $this->assertTrue( - $version <= ExtensionRegistry::MANIFEST_VERSION, - "$path is using a non-supported schema version" - ); - - $licenseError = false; - if ( class_exists( SpdxLicenses::class ) && isset( $data->{'license-name'} ) - // Check if it's a string, if not, schema validation will display an error - && is_string( $data->{'license-name'} ) - ) { - $licenses = new SpdxLicenses(); - $valid = $licenses->validate( $data->{'license-name'} ); - if ( !$valid ) { - $licenseError = '[license-name] Invalid SPDX license identifier, ' - . 'see '; - } - } - - $validator = new Validator; - $validator->check( $data, (object)[ '$ref' => 'file://' . $schemaPath ] ); - if ( $validator->isValid() && !$licenseError ) { - // All good. + try { + $this->validator->validate( $path ); + // All good $this->assertTrue( true ); - } else { - $out = "$path did pass validation.\n"; - foreach ( $validator->getErrors() as $error ) { - $out .= "[{$error['property']}] {$error['message']}\n"; - } - if ( $licenseError ) { - $out .= "$licenseError\n"; - } - $this->assertTrue( false, $out ); + } catch ( ExtensionJsonValidationError $e ) { + $this->assertEquals( false, $e->getMessage() ); } } } diff --git a/tests/phpunit/structure/ResourcesTest.php b/tests/phpunit/structure/ResourcesTest.php index 86ce53f339..2fba76b688 100644 --- a/tests/phpunit/structure/ResourcesTest.php +++ b/tests/phpunit/structure/ResourcesTest.php @@ -11,7 +11,6 @@ * @copyright Â© 2012, Niklas LaxstrÃ¶m * @copyright Â© 2012, Santhosh Thottingal * @copyright Â© 2012, Timo Tijhof - * */ class ResourcesTest extends MediaWikiTestCase { @@ -91,7 +90,6 @@ class ResourcesTest extends MediaWikiTestCase { */ public function testMissingMessages() { $data = self::getAllModules(); - $validDeps = array_keys( $data['modules'] ); $lang = Language::factory( 'en' ); /** @var ResourceLoaderModule $module */ @@ -114,7 +112,6 @@ class ResourcesTest extends MediaWikiTestCase { */ public function testUnsatisfiableDependencies() { $data = self::getAllModules(); - $validDeps = array_keys( $data['modules'] ); /** @var ResourceLoaderModule $module */ foreach ( $data['modules'] as $moduleName => $module ) { diff --git a/tests/phpunit/suite.xml b/tests/phpunit/suite.xml index 16299aa7f6..11a25c4105 100644 --- a/tests/phpunit/suite.xml +++ b/tests/phpunit/suite.xml @@ -43,6 +43,9 @@ structure + + tests + suites/UploadFromUrlTestSuite.php diff --git a/tests/phpunit/suites/ParserTestTopLevelSuite.php b/tests/phpunit/suites/ParserTestTopLevelSuite.php index 5a7fc4804f..5d5d693571 100644 --- a/tests/phpunit/suites/ParserTestTopLevelSuite.php +++ b/tests/phpunit/suites/ParserTestTopLevelSuite.php @@ -108,7 +108,7 @@ class ParserTestTopLevelSuite extends PHPUnit_Framework_TestSuite { $testsName = $extensionName . '__' . basename( $fileName, '.txt' ); $parserTestClassName = ucfirst( $testsName ); - // Official spec for class names: http://php.net/manual/en/language.oop5.basic.php + // Official spec for class names: https://secure.php.net/manual/en/language.oop5.basic.php // Prepend 'ParserTest_' to be paranoid about it not starting with a number $parserTestClassName = 'ParserTest_' . preg_replace( '/[^a-zA-Z0-9_\x7f-\xff]/', '_', $parserTestClassName ); diff --git a/tests/phpunit/tests/MediaWikiTestCaseTest.php b/tests/phpunit/tests/MediaWikiTestCaseTest.php index 5d2f37e6a6..edc81ff925 100644 --- a/tests/phpunit/tests/MediaWikiTestCaseTest.php +++ b/tests/phpunit/tests/MediaWikiTestCaseTest.php @@ -9,8 +9,6 @@ use Psr\Log\LoggerInterface; */ class MediaWikiTestCaseTest extends MediaWikiTestCase { - const GLOBAL_KEY_NONEXISTING = 'MediaWikiTestCaseTestGLOBAL-NONExisting'; - private static $startGlobals = [ 'MediaWikiTestCaseTestGLOBAL-ExistingString' => 'foo', 'MediaWikiTestCaseTestGLOBAL-ExistingStringEmpty' => '', @@ -90,14 +88,22 @@ class MediaWikiTestCaseTest extends MediaWikiTestCase { /** * @covers MediaWikiTestCase::stashMwGlobals + * @covers MediaWikiTestCase::tearDown */ - public function testExceptionThrownWhenStashingNonExistentGlobals() { - $this->setExpectedException( - 'Exception', - 'Global with key ' . self::GLOBAL_KEY_NONEXISTING . ' doesn\'t exist and cant be stashed' + public function testSetNonExistentGlobalsAreUnsetOnTearDown() { + $globalKey = 'abcdefg1234567'; + $this->setMwGlobals( $globalKey, true ); + $this->assertTrue( + $GLOBALS[$globalKey], + 'Global failed to correctly set' ); - $this->stashMwGlobals( self::GLOBAL_KEY_NONEXISTING ); + $this->tearDown(); + + $this->assertFalse( + isset( $GLOBALS[$globalKey] ), + 'Global failed to be correctly unset' + ); } public function testOverrideMwServices() { @@ -132,10 +138,9 @@ class MediaWikiTestCaseTest extends MediaWikiTestCase { /** * @covers MediaWikiTestCase::setLogger - * @covers MediaWikiTestCase::restoreLogger + * @covers MediaWikiTestCase::restoreLoggers */ - public function testLoggersAreRestoredOnTearDown() { - // replacing an existing logger + public function testLoggersAreRestoredOnTearDown_replacingExistingLogger() { $logger1 = LoggerFactory::getInstance( 'foo' ); $this->setLogger( 'foo', $this->getMock( LoggerInterface::class ) ); $logger2 = LoggerFactory::getInstance( 'foo' ); @@ -144,17 +149,27 @@ class MediaWikiTestCaseTest extends MediaWikiTestCase { $this->assertSame( $logger1, $logger3 ); $this->assertNotSame( $logger1, $logger2 ); + } - // replacing a non-existing logger + /** + * @covers MediaWikiTestCase::setLogger + * @covers MediaWikiTestCase::restoreLoggers + */ + public function testLoggersAreRestoredOnTearDown_replacingNonExistingLogger() { $this->setLogger( 'foo', $this->getMock( LoggerInterface::class ) ); - $logger1 = LoggerFactory::getInstance( 'bar' ); + $logger1 = LoggerFactory::getInstance( 'foo' ); $this->tearDown(); - $logger2 = LoggerFactory::getInstance( 'bar' ); + $logger2 = LoggerFactory::getInstance( 'foo' ); $this->assertNotSame( $logger1, $logger2 ); $this->assertInstanceOf( '\Psr\Log\LoggerInterface', $logger2 ); + } - // replacing same logger twice + /** + * @covers MediaWikiTestCase::setLogger + * @covers MediaWikiTestCase::restoreLoggers + */ + public function testLoggersAreRestoredOnTearDown_replacingSameLoggerTwice() { $logger1 = LoggerFactory::getInstance( 'baz' ); $this->setLogger( 'foo', $this->getMock( LoggerInterface::class ) ); $this->setLogger( 'foo', $this->getMock( LoggerInterface::class ) ); diff --git a/tests/qunit/data/testrunner.js b/tests/qunit/data/testrunner.js index b79c1927f3..0b28684a59 100644 --- a/tests/qunit/data/testrunner.js +++ b/tests/qunit/data/testrunner.js @@ -25,6 +25,9 @@ // killing the test and assuming timeout failure. QUnit.config.testTimeout = 60 * 1000; + // Reduce default animation duration from 400ms to 0ms for unit tests + $.fx.speeds._default = 0; + // Add a checkbox to QUnit header to toggle MediaWiki ResourceLoader debug mode. QUnit.config.urlConfig.push( { id: 'debug', diff --git a/tests/qunit/suites/resources/jquery/jquery.color.test.js b/tests/qunit/suites/resources/jquery/jquery.color.test.js index 9afd793e5b..ca6a512fc5 100644 --- a/tests/qunit/suites/resources/jquery/jquery.color.test.js +++ b/tests/qunit/suites/resources/jquery/jquery.color.test.js @@ -1,18 +1,15 @@ ( function ( $ ) { - QUnit.module( 'jquery.color', QUnit.newMwEnvironment( { - setup: function () { - this.clock = this.sandbox.useFakeTimers(); - } - } ) ); + QUnit.module( 'jquery.color', QUnit.newMwEnvironment() ); - QUnit.test( 'animate', 1, function ( assert ) { - var $canvas = $( '' ).css( 'background-color', '#fff' ); + QUnit.test( 'animate', function ( assert ) { + var done = assert.async(), + $canvas = $( '' ).css( 'background-color', '#fff' ).appendTo( '#qunit-fixture' ); - $canvas.animate( { backgroundColor: '#000' }, 10 ).promise().then( function () { - var endColors = $.colorUtil.getRGB( $canvas.css( 'background-color' ) ); - assert.deepEqual( endColors, [ 0, 0, 0 ], 'end state' ); - } ); - - this.clock.tick( 20 ); + $canvas.animate( { 'background-color': '#000' }, 3 ).promise() + .done( function () { + var endColors = $.colorUtil.getRGB( $canvas.css( 'background-color' ) ); + assert.deepEqual( endColors, [ 0, 0, 0 ], 'end state' ); + } ) + .always( done ); } ); }( jQuery ) ); diff --git a/tests/qunit/suites/resources/jquery/jquery.makeCollapsible.test.js b/tests/qunit/suites/resources/jquery/jquery.makeCollapsible.test.js index c51e40931c..9c7660fe8d 100644 --- a/tests/qunit/suites/resources/jquery/jquery.makeCollapsible.test.js +++ b/tests/qunit/suites/resources/jquery/jquery.makeCollapsible.test.js @@ -1,11 +1,7 @@ ( function ( mw, $ ) { var loremIpsum = 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit.'; - QUnit.module( 'jquery.makeCollapsible', QUnit.newMwEnvironment( { - setup: function () { - this.clock = this.sandbox.useFakeTimers(); - } - } ) ); + QUnit.module( 'jquery.makeCollapsible', QUnit.newMwEnvironment() ); function prepareCollapsible( html, options ) { return $( $.parseHTML( html ) ) @@ -42,12 +38,10 @@ // ...expanding happens here $toggle.trigger( 'click' ); - test.clock.tick( 500 ); } ); // ...collapsing happens here $toggle.trigger( 'click' ); - test.clock.tick( 500 ); } ); QUnit.test( 'basic operation ()', 5, function ( assert ) { @@ -71,11 +65,9 @@ } ); $toggle.trigger( 'click' ); - test.clock.tick( 500 ); } ); $toggle.trigger( 'click' ); - test.clock.tick( 500 ); } ); QUnit.test( 'basic operation ()', 7, function ( assert ) { @@ -106,11 +98,9 @@ } ); $toggle.trigger( 'click' ); - test.clock.tick( 500 ); } ); $toggle.trigger( 'click' ); - test.clock.tick( 500 ); } ); function tableWithCaptionTest( $collapsible, test, assert ) { @@ -137,11 +127,9 @@ } ); $toggle.trigger( 'click' ); - test.clock.tick( 500 ); } ); $toggle.trigger( 'click' ); - test.clock.tick( 500 ); } QUnit.test( 'basic operation ( with caption)', 10, function ( assert ) { @@ -192,11 +180,9 @@ } ); $toggle.trigger( 'click' ); - test.clock.tick( 500 ); } ); $toggle.trigger( 'click' ); - test.clock.tick( 500 ); } QUnit.test( 'basic operation ()', 7, function ( assert ) { @@ -260,7 +246,6 @@ } ); $collapsible.find( '.mw-collapsible-toggle' ).trigger( 'click' ); - this.clock.tick( 500 ); } ); QUnit.test( 'initial collapse (options.collapsed)', 2, function ( assert ) { @@ -278,7 +263,6 @@ } ); $collapsible.find( '.mw-collapsible-toggle' ).trigger( 'click' ); - this.clock.tick( 500 ); } ); QUnit.test( 'clicks on links inside toggler pass through (options.linksPassthru)', 2, function ( assert ) { @@ -316,7 +300,6 @@ } ); $collapsible.find( '.mw-collapsible-toggle' ).trigger( 'click' ); - this.clock.tick( 500 ); } ); QUnit.test( 'collapse/expand text (options.collapseText, options.expandText)', 2, function ( assert ) { @@ -333,7 +316,6 @@ } ); $collapsible.find( '.mw-collapsible-toggle' ).trigger( 'click' ); - this.clock.tick( 500 ); } ); QUnit.test( 'cloned collapsibles can be made collapsible again', 2, function ( assert ) { @@ -352,6 +334,5 @@ } ); $clone.find( '.mw-collapsible-toggle a' ).trigger( 'click' ); - test.clock.tick( 500 ); } ); }( mediaWiki, jQuery ) ); diff --git a/tests/qunit/suites/resources/mediawiki.api/mediawiki.ForeignApi.test.js b/tests/qunit/suites/resources/mediawiki.api/mediawiki.ForeignApi.test.js index 9d0fdf54b0..1676130e98 100644 --- a/tests/qunit/suites/resources/mediawiki.api/mediawiki.ForeignApi.test.js +++ b/tests/qunit/suites/resources/mediawiki.api/mediawiki.ForeignApi.test.js @@ -3,16 +3,10 @@ setup: function () { this.server = this.sandbox.useFakeServer(); this.server.respondImmediately = true; - this.clock = this.sandbox.useFakeTimers(); - }, - teardown: function () { - // https://github.com/jquery/jquery/issues/2453 - this.clock.tick(); } } ) ); - QUnit.test( 'origin is included in GET requests', function ( assert ) { - QUnit.expect( 1 ); + QUnit.test( 'origin is included in GET requests', 1, function ( assert ) { var api = new mw.ForeignApi( '//localhost:4242/w/api.php' ); this.server.respond( function ( request ) { @@ -20,11 +14,10 @@ request.respond( 200, { 'Content-Type': 'application/json' }, '[]' ); } ); - api.get( {} ); + return api.get( {} ); } ); - QUnit.test( 'origin is included in POST requests', function ( assert ) { - QUnit.expect( 2 ); + QUnit.test( 'origin is included in POST requests', 2, function ( assert ) { var api = new mw.ForeignApi( '//localhost:4242/w/api.php' ); this.server.respond( function ( request ) { @@ -33,7 +26,7 @@ request.respond( 200, { 'Content-Type': 'application/json' }, '[]' ); } ); - api.post( {} ); + return api.post( {} ); } ); }( mediaWiki ) ); diff --git a/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.category.test.js b/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.category.test.js index a0c7daf1a0..a79bff698b 100644 --- a/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.category.test.js +++ b/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.category.test.js @@ -2,29 +2,24 @@ QUnit.module( 'mediawiki.api.category', QUnit.newMwEnvironment( { setup: function () { this.server = this.sandbox.useFakeServer(); + this.server.respondImmediately = true; } } ) ); - QUnit.test( '.getCategoriesByPrefix()', function ( assert ) { - QUnit.expect( 1 ); + QUnit.test( '.getCategoriesByPrefix()', 1, function ( assert ) { + this.server.respondWith( [ 200, { 'Content-Type': 'application/json' }, + '{ "query": { "allpages": [ ' + + '{ "title": "Category:Food" },' + + '{ "title": "Category:Fool Supermarine S.6" },' + + '{ "title": "Category:Fools" }' + + '] } }' + ] ); - var api = new mw.Api(); - - api.getCategoriesByPrefix( 'Foo' ).done( function ( matches ) { + return new mw.Api().getCategoriesByPrefix( 'Foo' ).then( function ( matches ) { assert.deepEqual( matches, [ 'Food', 'Fool Supermarine S.6', 'Fools' ] ); } ); - - this.server.respond( function ( req ) { - req.respond( 200, { 'Content-Type': 'application/json' }, - '{ "query": { "allpages": [ ' + - '{ "title": "Category:Food" },' + - '{ "title": "Category:Fool Supermarine S.6" },' + - '{ "title": "Category:Fools" }' + - '] } }' - ); - } ); } ); }( mediaWiki ) ); diff --git a/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.messages.test.js b/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.messages.test.js index 5880962a74..d8b5db88a3 100644 --- a/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.messages.test.js +++ b/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.messages.test.js @@ -2,14 +2,21 @@ QUnit.module( 'mediawiki.api.messages', QUnit.newMwEnvironment( { setup: function () { this.server = this.sandbox.useFakeServer(); + this.server.respondImmediately = true; } } ) ); - QUnit.test( '.getMessages()', function ( assert ) { - QUnit.expect( 1 ); + QUnit.test( '.getMessages()', 1, function ( assert ) { + this.server.respondWith( /ammessages=foo%7Cbaz/, [ + 200, + { 'Content-Type': 'application/json' }, + '{ "query": { "allmessages": [' + + '{ "name": "foo", "content": "Foo bar" },' + + '{ "name": "baz", "content": "Baz Quux" }' + + '] } }' + ] ); - var api = new mw.Api(); - api.getMessages( [ 'foo', 'baz' ] ).then( function ( messages ) { + return new mw.Api().getMessages( [ 'foo', 'baz' ] ).then( function ( messages ) { assert.deepEqual( messages, { @@ -18,14 +25,5 @@ } ); } ); - - this.server.respond( /ammessages=foo%7Cbaz/, [ - 200, - { 'Content-Type': 'application/json' }, - '{ "query": { "allmessages": [' + - '{ "name": "foo", "content": "Foo bar" },' + - '{ "name": "baz", "content": "Baz Quux" }' + - '] } }' - ] ); } ); }( mediaWiki ) ); diff --git a/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.options.test.js b/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.options.test.js index 0797f32dfb..7ed1875036 100644 --- a/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.options.test.js +++ b/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.options.test.js @@ -2,14 +2,12 @@ QUnit.module( 'mediawiki.api.options', QUnit.newMwEnvironment( { setup: function () { this.server = this.sandbox.useFakeServer(); + this.server.respondImmediately = true; } } ) ); - QUnit.test( 'saveOption', function ( assert ) { - QUnit.expect( 2 ); - - var - api = new mw.Api(), + QUnit.test( 'saveOption', 2, function ( assert ) { + var api = new mw.Api(), stub = this.sandbox.stub( mw.Api.prototype, 'saveOptions' ); api.saveOption( 'foo', 'bar' ); @@ -18,9 +16,7 @@ assert.deepEqual( stub.getCall( 0 ).args, [ { foo: 'bar' } ], '#saveOptions called correctly' ); } ); - QUnit.test( 'saveOptions without Unit Separator', function ( assert ) { - QUnit.expect( 13 ); - + QUnit.test( 'saveOptions without Unit Separator', 13, function ( assert ) { var api = new mw.Api( { useUS: false } ); // We need to respond to the request for token first, otherwise the other requests won't be sent @@ -32,25 +28,6 @@ '{ "query": { "tokens": { "csrftoken": "+\\\\" } } }' ] ); - api.saveOptions( {} ).done( function () { - assert.ok( true, 'Request completed: empty case' ); - } ); - api.saveOptions( { foo: 'bar' } ).done( function () { - assert.ok( true, 'Request completed: simple' ); - } ); - api.saveOptions( { foo: 'bar', baz: 'quux' } ).done( function () { - assert.ok( true, 'Request completed: two options' ); - } ); - api.saveOptions( { foo: 'bar|quux', bar: 'a|b|c', baz: 'quux' } ).done( function () { - assert.ok( true, 'Request completed: not bundleable' ); - } ); - api.saveOptions( { foo: null } ).done( function () { - assert.ok( true, 'Request completed: reset an option' ); - } ); - api.saveOptions( { 'foo|bar=quux': null } ).done( function () { - assert.ok( true, 'Request completed: reset an option, not bundleable' ); - } ); - // Requests are POST, match requestBody instead of url this.server.respond( function ( request ) { switch ( request.requestBody ) { @@ -74,11 +51,30 @@ assert.ok( false, 'Unexpected request: ' + request.requestBody ); } } ); - } ); - QUnit.test( 'saveOptions with Unit Separator', function ( assert ) { - QUnit.expect( 14 ); + return QUnit.whenPromisesComplete( + api.saveOptions( {} ).then( function () { + assert.ok( true, 'Request completed: empty case' ); + } ), + api.saveOptions( { foo: 'bar' } ).then( function () { + assert.ok( true, 'Request completed: simple' ); + } ), + api.saveOptions( { foo: 'bar', baz: 'quux' } ).then( function () { + assert.ok( true, 'Request completed: two options' ); + } ), + api.saveOptions( { foo: 'bar|quux', bar: 'a|b|c', baz: 'quux' } ).then( function () { + assert.ok( true, 'Request completed: not bundleable' ); + } ), + api.saveOptions( { foo: null } ).then( function () { + assert.ok( true, 'Request completed: reset an option' ); + } ), + api.saveOptions( { 'foo|bar=quux': null } ).then( function () { + assert.ok( true, 'Request completed: reset an option, not bundleable' ); + } ) + ); + } ); + QUnit.test( 'saveOptions with Unit Separator', 14, function ( assert ) { var api = new mw.Api( { useUS: true } ); // We need to respond to the request for token first, otherwise the other requests won't be sent @@ -90,28 +86,6 @@ '{ "query": { "tokens": { "csrftoken": "+\\\\" } } }' ] ); - api.saveOptions( {} ).done( function () { - assert.ok( true, 'Request completed: empty case' ); - } ); - api.saveOptions( { foo: 'bar' } ).done( function () { - assert.ok( true, 'Request completed: simple' ); - } ); - api.saveOptions( { foo: 'bar', baz: 'quux' } ).done( function () { - assert.ok( true, 'Request completed: two options' ); - } ); - api.saveOptions( { foo: 'bar|quux', bar: 'a|b|c', baz: 'quux' } ).done( function () { - assert.ok( true, 'Request completed: bundleable with unit separator' ); - } ); - api.saveOptions( { foo: 'bar|quux', bar: 'a|b|c', 'baz=baz': 'quux' } ).done( function () { - assert.ok( true, 'Request completed: not bundleable with unit separator' ); - } ); - api.saveOptions( { foo: null } ).done( function () { - assert.ok( true, 'Request completed: reset an option' ); - } ); - api.saveOptions( { 'foo|bar=quux': null } ).done( function () { - assert.ok( true, 'Request completed: reset an option, not bundleable' ); - } ); - // Requests are POST, match requestBody instead of url this.server.respond( function ( request ) { switch ( request.requestBody ) { @@ -136,5 +110,29 @@ assert.ok( false, 'Unexpected request: ' + request.requestBody ); } } ); + + return QUnit.whenPromisesComplete( + api.saveOptions( {} ).done( function () { + assert.ok( true, 'Request completed: empty case' ); + } ), + api.saveOptions( { foo: 'bar' } ).done( function () { + assert.ok( true, 'Request completed: simple' ); + } ), + api.saveOptions( { foo: 'bar', baz: 'quux' } ).done( function () { + assert.ok( true, 'Request completed: two options' ); + } ), + api.saveOptions( { foo: 'bar|quux', bar: 'a|b|c', baz: 'quux' } ).done( function () { + assert.ok( true, 'Request completed: bundleable with unit separator' ); + } ), + api.saveOptions( { foo: 'bar|quux', bar: 'a|b|c', 'baz=baz': 'quux' } ).done( function () { + assert.ok( true, 'Request completed: not bundleable with unit separator' ); + } ), + api.saveOptions( { foo: null } ).done( function () { + assert.ok( true, 'Request completed: reset an option' ); + } ), + api.saveOptions( { 'foo|bar=quux': null } ).done( function () { + assert.ok( true, 'Request completed: reset an option, not bundleable' ); + } ) + ); } ); }( mediaWiki ) ); diff --git a/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.parse.test.js b/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.parse.test.js index dc0cff40e6..7d27352200 100644 --- a/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.parse.test.js +++ b/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.parse.test.js @@ -2,42 +2,44 @@ QUnit.module( 'mediawiki.api.parse', QUnit.newMwEnvironment( { setup: function () { this.server = this.sandbox.useFakeServer(); + this.server.respondImmediately = true; } } ) ); - QUnit.test( 'Hello world', function ( assert ) { - QUnit.expect( 3 ); + QUnit.test( '.parse( string )', function ( assert ) { + this.server.respondWith( /action=parse.*&text='''Hello(\+|%20)world'''/, [ 200, + { 'Content-Type': 'application/json' }, + '{ "parse": { "text": "Hello world" } }' + ] ); - var api = new mw.Api(); - - api.parse( '\'\'\'Hello world\'\'\'' ).done( function ( html ) { + return new mw.Api().parse( '\'\'\'Hello world\'\'\'' ).done( function ( html ) { assert.equal( html, 'Hello world', 'Parse wikitext by string' ); } ); + } ); - api.parse( { + QUnit.test( '.parse( Object.toString )', function ( assert ) { + this.server.respondWith( /action=parse.*&text='''Hello(\+|%20)world'''/, [ 200, + { 'Content-Type': 'application/json' }, + '{ "parse": { "text": "Hello world" } }' + ] ); + + return new mw.Api().parse( { toString: function () { return '\'\'\'Hello world\'\'\''; } } ).done( function ( html ) { assert.equal( html, 'Hello world', 'Parse wikitext by toString object' ); } ); + } ); - this.server.respondWith( /action=parse.*&text='''Hello\+world'''/, function ( request ) { - request.respond( 200, { 'Content-Type': 'application/json' }, - '{ "parse": { "text": "Hello world" } }' - ); - } ); + QUnit.test( '.parse( mw.Title )', function ( assert ) { + this.server.respondWith( /action=parse.*&page=Earth/, [ 200, + { 'Content-Type': 'application/json' }, + '{ "parse": { "text": "Earth is a planet." } }' + ] ); - api.parse( new mw.Title( 'Earth' ) ).done( function ( html ) { + return new mw.Api().parse( new mw.Title( 'Earth' ) ).done( function ( html ) { assert.equal( html, 'Earth is a planet.', 'Parse page by Title object' ); } ); - - this.server.respondWith( /action=parse.*&page=Earth/, function ( request ) { - request.respond( 200, { 'Content-Type': 'application/json' }, - '{ "parse": { "text": "Earth is a planet." } }' - ); - } ); - - this.server.respond(); } ); }( mediaWiki ) ); diff --git a/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.test.js b/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.test.js index 3a959a35e8..6a00ac9b17 100644 --- a/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.test.js +++ b/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.test.js @@ -44,7 +44,7 @@ } ); } ); - QUnit.test( 'API error', function ( assert ) { + QUnit.test( 'API error errorformat=bc', function ( assert ) { var api = new mw.Api(); this.server.respond( [ 200, { 'Content-Type': 'application/json' }, @@ -58,6 +58,20 @@ .always( assert.async() ); } ); + QUnit.test( 'API error errorformat!=bc', function ( assert ) { + var api = new mw.Api(); + + this.server.respond( [ 200, { 'Content-Type': 'application/json' }, + '{ "errors": [ { "code": "unknown_action", "key": "unknown-error", "params": [] } ] }' + ] ); + + api.get( { action: 'doesntexist' } ) + .fail( function ( errorCode ) { + assert.equal( errorCode, 'unknown_action', 'API error should reject the deferred' ); + } ) + .always( assert.async() ); + } ); + QUnit.test( 'FormData support', function ( assert ) { var api = new mw.Api(); diff --git a/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.upload.test.js b/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.upload.test.js index 10fcd5da68..b1bd12ba17 100644 --- a/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.upload.test.js +++ b/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.upload.test.js @@ -1,8 +1,7 @@ ( function ( mw, $ ) { QUnit.module( 'mediawiki.api.upload', QUnit.newMwEnvironment( {} ) ); - QUnit.test( 'Basic functionality', function ( assert ) { - QUnit.expect( 2 ); + QUnit.test( 'Basic functionality', 2, function ( assert ) { var api = new mw.Api(); assert.ok( api.upload ); assert.throws( function () { @@ -10,8 +9,7 @@ } ); } ); - QUnit.test( 'Set up iframe upload', function ( assert ) { - QUnit.expect( 5 ); + QUnit.test( 'Set up iframe upload', 5, function ( assert ) { var $iframe, $form, $input, api = new mw.Api(); diff --git a/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.watch.test.js b/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.watch.test.js index 64a5184711..86414691d8 100644 --- a/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.watch.test.js +++ b/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.watch.test.js @@ -2,37 +2,45 @@ QUnit.module( 'mediawiki.api.watch', QUnit.newMwEnvironment( { setup: function () { this.server = this.sandbox.useFakeServer(); + this.server.respondImmediately = true; } } ) ); - QUnit.test( '.watch()', function ( assert ) { - QUnit.expect( 4 ); - - var api = new mw.Api(); - - // Ensure we don't mistake a single item array for a single item and vice versa. - // The query parameter in request is the same either way (separated by pipe). - api.watch( 'Foo' ).done( function ( item ) { - assert.equal( item.title, 'Foo' ); - } ); - - api.watch( [ 'Foo' ] ).done( function ( items ) { - assert.equal( items[ 0 ].title, 'Foo' ); + QUnit.test( '.watch( string )', function ( assert ) { + this.server.respond( function ( req ) { + // Match POST requestBody + if ( /action=watch.*&titles=Foo(&|$)/.test( req.requestBody ) ) { + req.respond( 200, { 'Content-Type': 'application/json' }, + '{ "watch": [ { "title": "Foo", "watched": true, "message": "Added" } ] }' + ); + } } ); - api.watch( [ 'Foo', 'Bar' ] ).done( function ( items ) { - assert.equal( items[ 0 ].title, 'Foo' ); - assert.equal( items[ 1 ].title, 'Bar' ); + return new mw.Api().watch( 'Foo' ).done( function ( item ) { + assert.equal( item.title, 'Foo' ); } ); + } ); - // Requests are POST, match requestBody instead of url + // Ensure we don't mistake a single item array for a single item and vice versa. + // The query parameter in request is the same either way (separated by pipe). + QUnit.test( '.watch( Array ) - single', function ( assert ) { this.server.respond( function ( req ) { + // Match POST requestBody if ( /action=watch.*&titles=Foo(&|$)/.test( req.requestBody ) ) { req.respond( 200, { 'Content-Type': 'application/json' }, '{ "watch": [ { "title": "Foo", "watched": true, "message": "Added" } ] }' ); } + } ); + + return new mw.Api().watch( [ 'Foo' ] ).done( function ( items ) { + assert.equal( items[ 0 ].title, 'Foo' ); + } ); + } ); + QUnit.test( '.watch( Array ) - multi', function ( assert ) { + this.server.respond( function ( req ) { + // Match POST requestBody if ( /action=watch.*&titles=Foo%7CBar/.test( req.requestBody ) ) { req.respond( 200, { 'Content-Type': 'application/json' }, '{ "watch": [ ' + @@ -42,5 +50,11 @@ ); } } ); + + return new mw.Api().watch( [ 'Foo', 'Bar' ] ).done( function ( items ) { + assert.equal( items[ 0 ].title, 'Foo' ); + assert.equal( items[ 1 ].title, 'Bar' ); + } ); } ); + }( mediaWiki ) ); diff --git a/tests/qunit/suites/resources/mediawiki/mediawiki.Title.test.js b/tests/qunit/suites/resources/mediawiki/mediawiki.Title.test.js index 886e2b6f04..124c49f5b8 100644 --- a/tests/qunit/suites/resources/mediawiki/mediawiki.Title.test.js +++ b/tests/qunit/suites/resources/mediawiki/mediawiki.Title.test.js @@ -1,4 +1,3 @@ -/*jshint -W024 */ ( function ( mw, $ ) { var repeat = function ( input, multiplier ) { return new Array( multiplier + 1 ).join( input ); @@ -299,7 +298,7 @@ }, 'Throw error on empty string' ); } ); - QUnit.test( 'Case-sensivity', 3, function ( assert ) { + QUnit.test( 'Case-sensivity', 5, function ( assert ) { var title; // Default config @@ -308,6 +307,12 @@ title = new mw.Title( 'article' ); assert.equal( title.toString(), 'Article', 'Default config: No sensitive namespaces by default. First-letter becomes uppercase' ); + title = new mw.Title( 'Ã' ); + assert.equal( title.toString(), 'Ã', 'Uppercasing matches PHP behaviour (Ã -> Ã, not SS)' ); + + title = new mw.Title( 'Ç (digraph)' ); + assert.equal( title.toString(), 'Ç_(digraph)', 'Uppercasing matches PHP behaviour (Ç -> Ç, not Ç)' ); + // $wgCapitalLinks = false; mw.config.set( 'wgCaseSensitiveNamespaces', [ 0, -2, 1, 4, 5, 6, 7, 10, 11, 12, 13, 14, 15 ] ); diff --git a/tests/qunit/suites/resources/mediawiki/mediawiki.Uri.test.js b/tests/qunit/suites/resources/mediawiki/mediawiki.Uri.test.js index b12803d6c7..97185fca73 100644 --- a/tests/qunit/suites/resources/mediawiki/mediawiki.Uri.test.js +++ b/tests/qunit/suites/resources/mediawiki/mediawiki.Uri.test.js @@ -1,4 +1,3 @@ -/*jshint -W024 */ ( function ( mw, $ ) { QUnit.module( 'mediawiki.Uri', QUnit.newMwEnvironment( { setup: function () { diff --git a/tests/qunit/suites/resources/mediawiki/mediawiki.jqueryMsg.test.js b/tests/qunit/suites/resources/mediawiki/mediawiki.jqueryMsg.test.js index caaef83c1b..f848f3edc8 100644 --- a/tests/qunit/suites/resources/mediawiki/mediawiki.jqueryMsg.test.js +++ b/tests/qunit/suites/resources/mediawiki/mediawiki.jqueryMsg.test.js @@ -367,8 +367,8 @@ QUnit.test( 'Match PHP parser', mw.libs.phpParserData.tests.length, function ( assert ) { mw.messages.set( mw.libs.phpParserData.messages ); var tasks = $.map( mw.libs.phpParserData.tests, function ( test ) { + var done = assert.async(); return function ( next, abort ) { - var done = assert.async(); getMwLanguage( test.lang ) .then( function ( langClass ) { mw.config.set( 'wgUserLanguage', test.lang ); @@ -706,7 +706,7 @@ assert.equal( formatParse( 'uses-missing-int' ), - '[doesnt-exist]', + 'â§¼doesnt-existâ§½', 'int: where nested message does not exist' ); } ); @@ -884,7 +884,7 @@ }, { lang: 'hi', - number: 'à¥§à¥¨à¥©à¥ªà¥«à¥¬,à¥à¥®à¥¯', + number: 'à¥§,à¥¨à¥©,à¥ªà¥«à¥¬', result: '123456', integer: true, description: 'formatnum test for Hindi, Devanagari digits passed to get integer value' @@ -895,8 +895,8 @@ mw.messages.set( 'formatnum-msg', '{{formatnum:$1}}' ); mw.messages.set( 'formatnum-msg-int', '{{formatnum:$1|R}}' ); var queue = $.map( formatnumTests, function ( test ) { + var done = assert.async(); return function ( next, abort ) { - var done = assert.async(); getMwLanguage( test.lang ) .then( function ( langClass ) { mw.config.set( 'wgUserLanguage', test.lang ); diff --git a/tests/qunit/suites/resources/mediawiki/mediawiki.language.test.js b/tests/qunit/suites/resources/mediawiki/mediawiki.language.test.js index e4c3851593..2171f34b40 100644 --- a/tests/qunit/suites/resources/mediawiki/mediawiki.language.test.js +++ b/tests/qunit/suites/resources/mediawiki/mediawiki.language.test.js @@ -3,11 +3,11 @@ QUnit.module( 'mediawiki.language', QUnit.newMwEnvironment( { setup: function () { - this.liveLangData = mw.language.data.values; - mw.language.data.values = $.extend( true, {}, this.liveLangData ); + this.liveLangData = mw.language.data; + mw.language.data = {}; }, teardown: function () { - mw.language.data.values = this.liveLangData; + mw.language.data = this.liveLangData; }, messages: { // mw.language.listToText test @@ -43,6 +43,16 @@ assert.equal( mw.language.commafy( 123456789.567, '###,###,#0.00' ), '1,234,567,89.56', 'Decimal part as group of 3 and last one 2' ); } ); + QUnit.test( 'mw.language.convertNumber', 2, function ( assert ) { + mw.language.setData( 'en', 'digitGroupingPattern', null ); + mw.language.setData( 'en', 'digitTransformTable', null ); + mw.language.setData( 'en', 'separatorTransformTable', { ',': '.', '.': ',' } ); + mw.config.set( 'wgUserLanguage', 'en' ); + + assert.equal( mw.language.convertNumber( 1800 ), '1.800', 'formatting' ); + assert.equal( mw.language.convertNumber( '1.800', true ), '1800', 'unformatting' ); + } ); + function grammarTest( langCode, test ) { // The test works only if the content language is opt.language // because it requires [lang].js to be loaded. diff --git a/tests/qunit/suites/resources/mediawiki/mediawiki.loader.test.js b/tests/qunit/suites/resources/mediawiki/mediawiki.loader.test.js index 7233a2ed7d..92ee7dd360 100644 --- a/tests/qunit/suites/resources/mediawiki/mediawiki.loader.test.js +++ b/tests/qunit/suites/resources/mediawiki/mediawiki.loader.test.js @@ -127,13 +127,59 @@ .done( function () { assert.strictEqual( isAwesomeDone, true, 'test.promise module should\'ve caused isAwesomeDone to be true' ); delete mw.loader.testCallback; - } ) .fail( function () { assert.ok( false, 'Error callback fired while loader.using "test.promise" module' ); } ); } ); + QUnit.test( '.using() Error: Circular dependency', function ( assert ) { + var done = assert.async(); + + mw.loader.register( [ + [ 'test.circle1', '0', [ 'test.circle2' ] ], + [ 'test.circle2', '0', [ 'test.circle3' ] ], + [ 'test.circle3', '0', [ 'test.circle1' ] ] + ] ); + mw.loader.using( 'test.circle3' ).then( + function done() { + assert.ok( false, 'Unexpected resolution, expected error.' ); + }, + function fail( e ) { + assert.ok( /Circular/.test( String( e ) ), 'Detect circular dependency' ); + } + ) + .always( done ); + } ); + + QUnit.test( '.load() - Error: Circular dependency', function ( assert ) { + mw.loader.register( [ + [ 'test.circleA', '0', [ 'test.circleB' ] ], + [ 'test.circleB', '0', [ 'test.circleC' ] ], + [ 'test.circleC', '0', [ 'test.circleA' ] ] + ] ); + assert.throws( function () { + mw.loader.load( 'test.circleC' ); + }, /Circular/, 'Detect circular dependency' ); + } ); + + QUnit.test( '.using() - Error: Unregistered', function ( assert ) { + var done = assert.async(); + + mw.loader.using( 'test.using.unreg' ).then( + function done() { + assert.ok( false, 'Unexpected resolution, expected error.' ); + }, + function fail( e ) { + assert.ok( /Unknown/.test( String( e ) ), 'Detect unknown dependency' ); + } + ).always( done ); + } ); + + QUnit.test( '.load() - Error: Unregistered (ignored)', 0, function ( assert ) { + mw.loader.load( 'test.using.unreg2' ); + } ); + QUnit.test( '.implement( styles={ "css": [text, ..] } )', 2, function ( assert ) { var $element = $( '' ).appendTo( '#qunit-fixture' ); @@ -420,17 +466,6 @@ assert.strictEqual( mw.track.callCount, 1 ); } ); - QUnit.test( 'Circular dependency', 1, function ( assert ) { - mw.loader.register( [ - [ 'test.circle1', '0', [ 'test.circle2' ] ], - [ 'test.circle2', '0', [ 'test.circle3' ] ], - [ 'test.circle3', '0', [ 'test.circle1' ] ] - ] ); - assert.throws( function () { - mw.loader.using( 'test.circle3' ); - }, /Circular/, 'Detect circular dependency' ); - } ); - QUnit.test( 'Out-of-order implementation', 9, function ( assert ) { mw.loader.register( [ [ 'test.module4', '0' ], @@ -601,6 +636,25 @@ mw.loader.load( target ); } ); + QUnit.test( 'Empty string module name - T28804', function ( assert ) { + var done = false; + + assert.strictEqual( mw.loader.getState( '' ), null, 'State (unregistered)' ); + + mw.loader.register( '', 'v1' ); + assert.strictEqual( mw.loader.getState( '' ), 'registered', 'State (registered)' ); + assert.strictEqual( mw.loader.getVersion( '' ), 'v1', 'Version' ); + + mw.loader.implement( '', function () { + done = true; + } ); + + return mw.loader.using( '', function () { + assert.strictEqual( done, true, 'script ran' ); + assert.strictEqual( mw.loader.getState( '' ), 'ready', 'State (ready)' ); + } ); + } ); + QUnit.test( 'Executing race - T112232', 2, function ( assert ) { var done = false; diff --git a/tests/qunit/suites/resources/mediawiki/mediawiki.storage.test.js b/tests/qunit/suites/resources/mediawiki/mediawiki.storage.test.js index 6cef4a7c81..436cb2ed75 100644 --- a/tests/qunit/suites/resources/mediawiki/mediawiki.storage.test.js +++ b/tests/qunit/suites/resources/mediawiki/mediawiki.storage.test.js @@ -1,36 +1,56 @@ ( function ( mw ) { QUnit.module( 'mediawiki.storage' ); - QUnit.test( 'set/get with localStorage', 3, function ( assert ) { - this.sandbox.stub( mw.storage, 'localStorage', { + QUnit.test( 'set/get with storage support', function ( assert ) { + var stub = { setItem: this.sandbox.spy(), getItem: this.sandbox.stub() - } ); + }; + stub.getItem.withArgs( 'foo' ).returns( 'test' ); + stub.getItem.returns( null ); + this.sandbox.stub( mw.storage, 'store', stub ); mw.storage.set( 'foo', 'test' ); - assert.ok( mw.storage.localStorage.setItem.calledOnce ); + assert.ok( stub.setItem.calledOnce ); - mw.storage.localStorage.getItem.withArgs( 'foo' ).returns( 'test' ); - mw.storage.localStorage.getItem.returns( null ); assert.strictEqual( mw.storage.get( 'foo' ), 'test', 'Check value gets stored.' ); assert.strictEqual( mw.storage.get( 'bar' ), null, 'Unset values are null.' ); } ); - QUnit.test( 'set/get without localStorage', 3, function ( assert ) { - this.sandbox.stub( mw.storage, 'localStorage', { + QUnit.test( 'set/get with storage methods disabled', function ( assert ) { + // This covers browsers where storage is disabled + // (quota full, or security/privacy settings). + // On most browsers, these interface will be accessible with + // their methods throwing. + var stub = { getItem: this.sandbox.stub(), removeItem: this.sandbox.stub(), setItem: this.sandbox.stub() - } ); + }; + stub.getItem.throws(); + stub.setItem.throws(); + stub.removeItem.throws(); + this.sandbox.stub( mw.storage, 'store', stub ); - mw.storage.localStorage.getItem.throws(); assert.strictEqual( mw.storage.get( 'foo' ), false ); - - mw.storage.localStorage.setItem.throws(); assert.strictEqual( mw.storage.set( 'foo', 'test' ), false ); + assert.strictEqual( mw.storage.remove( 'foo', 'test' ), false ); + } ); + + QUnit.test( 'set/get with storage object disabled', function ( assert ) { + // On other browsers, these entire object is disabled. + // `'localStorage' in window` would be true (and pass feature test) + // but trying to read the object as window.localStorage would throw + // an exception. Such case would instantiate SafeStorage with + // undefined after the internal try/catch. + var old = mw.storage.store; + mw.storage.store = undefined; - mw.storage.localStorage.removeItem.throws(); + assert.strictEqual( mw.storage.get( 'foo' ), false ); + assert.strictEqual( mw.storage.set( 'foo', 'test' ), false ); assert.strictEqual( mw.storage.remove( 'foo', 'test' ), false ); + + mw.storage.store = old; } ); }( mediaWiki ) ); diff --git a/tests/qunit/suites/resources/mediawiki/mediawiki.test.js b/tests/qunit/suites/resources/mediawiki/mediawiki.test.js index 1518a80cad..bac8274fef 100644 --- a/tests/qunit/suites/resources/mediawiki/mediawiki.test.js +++ b/tests/qunit/suites/resources/mediawiki/mediawiki.test.js @@ -1,4 +1,3 @@ -/*jshint -W024 */ ( function ( mw ) { var specialCharactersPageName, // Can't mock SITENAME since jqueryMsg caches it at load @@ -239,9 +238,7 @@ goodbye = mw.message( 'goodbye' ); assert.strictEqual( goodbye.exists(), false, 'Message.exists returns false for nonexistent messages' ); - assertMultipleFormats( [ 'goodbye' ], [ 'plain', 'text' ], '', 'Message.toString returns if key does not exist' ); - // bug 30684 - assertMultipleFormats( [ 'goodbye' ], [ 'parse', 'escaped' ], '<goodbye>', 'Message.toString returns properly escaped <key> if key does not exist' ); + assertMultipleFormats( [ 'good<>bye' ], [ 'plain', 'text', 'parse', 'escaped' ], 'â§¼good<>byeâ§½', 'Message.toString returns â§¼keyâ§½ if key does not exist' ); assert.ok( mw.messages.set( 'plural-test-msg', 'There {{PLURAL:$1|is|are}} $1 {{PLURAL:$1|result|results}}' ), 'mw.messages.set: Register' ); assertMultipleFormats( [ 'plural-test-msg', 6 ], [ 'text', 'parse', 'escaped' ], 'There are 6 results', 'plural get resolved' ); @@ -320,7 +317,7 @@ QUnit.test( 'mw.msg', 14, function ( assert ) { assert.ok( mw.messages.set( 'hello', 'Hello awesome world' ), 'mw.messages.set: Register' ); assert.equal( mw.msg( 'hello' ), 'Hello awesome world', 'Gets message with default options (existing message)' ); - assert.equal( mw.msg( 'goodbye' ), '', 'Gets message with default options (nonexistent message)' ); + assert.equal( mw.msg( 'goodbye' ), 'â§¼goodbyeâ§½', 'Gets message with default options (nonexistent message)' ); assert.ok( mw.messages.set( 'plural-item', 'Found $1 {{PLURAL:$1|item|items}}' ), 'mw.messages.set: Register' ); assert.equal( mw.msg( 'plural-item', 5 ), 'Found 5 items', 'Apply plural for count 5' ); diff --git a/tests/qunit/suites/resources/startup.test.js b/tests/qunit/suites/resources/startup.test.js index 2934b39f3c..e6e798b8ed 100644 --- a/tests/qunit/suites/resources/startup.test.js +++ b/tests/qunit/suites/resources/startup.test.js @@ -10,6 +10,7 @@ 'Mozilla/5.0 (Windows NT 6.1.1; rv:5.0) Gecko/20100101 Firefox/5.0', 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.6; rv:9.0) Gecko/20100101 Firefox/9.0', 'Mozilla/5.0 (Macintosh; I; Intel Mac OS X 11_7_9; de-LI; rv:1.9b4) Gecko/2012010317 Firefox/10.0a4', + 'Mozilla/5.0 (X11; Linux i686; rv:10.0) Gecko/20100101 Firefox/10.0', 'Mozilla/5.0 (Windows NT 6.1; rv:12.0) Gecko/20120403211507 Firefox/12.0', 'Mozilla/5.0 (Windows NT 6.2; Win64; x64; rv:16.0.1) Gecko/20121011 Firefox/16.0.1', // Kindle Fire @@ -46,6 +47,8 @@ 'Mozilla/5.0 (iPhone; U; CPU like Mac OS X; en) AppleWebKit/420.1 (KHTML, like Gecko) Version/3.0 Mobile/3B48b Safari/419.3', // Android 'Mozilla/5.0 (Linux; U; Android 2.1; en-us; Nexus One Build/ERD62) AppleWebKit/530.17 (KHTML, like Gecko) Version/4.0 Mobile Safari/530.17', + // UC Mini (speed mode off) + 'Mozilla/5.0 (Linux; U; Android 6.0.1; en-US; Nexus_5 Build/MMB29S) AppleWebKit/528.5+ (KHTML, like Gecko) Version/3.1.2 Mobile Safari/525.20.1 UCBrowser/10.7.6.805 Mobile', /* Grade C */ @@ -99,12 +102,18 @@ 'Wget/1.10.1 (Red Hat modified)', // Unknown 'I\'m an unknown browser', + 'I\'m an unknown Glass browser', // Empty '' ], blacklisted: [ /* Grade C */ + // PlayStation + 'Mozilla/5.0 (PLAYSTATION 3; 1.10)', + 'Mozilla/5.0 (PLAYSTATION 3; 3.55)', + 'Mozilla/5.0 (PLAYSTATION 3 4.21) AppleWebKit/531.22.8 (KHTML, like Gecko)', + 'Mozilla/5.0 (PlayStation 4 1.70) AppleWebKit/536.26 (KHTML, like Gecko)', // Open WebOS < 1.5 (Palm Pre, Palm Pixi) 'Mozilla/5.0 (webOS/1.0; U; en-US) AppleWebKit/525.27.1 (KHTML, like Gecko) Version/1.0 Safari/525.27.1 Pre/1.0', 'Mozilla/5.0 (webOS/1.4.0; U; en-US) AppleWebKit/532.2 (KHTML, like Gecko) Version/1.0 Safari/532.2 Pixi/1.1 ', @@ -128,7 +137,11 @@ // Google Glass 'Mozilla/5.0 (Linux; U; Android 4.0.4; en-us; Glass 1 Build/IMM76L; XE11) AppleWebKit/534.30 (KHTML, like Gecko) Version/4.0 Mobile Safari/534.30', // MeeGo - 'Mozilla/5.0 (MeeGo; NokiaN9) AppleWebKit/534.13 (KHTML, like Gecko) NokiaBrowser/8.5.0 Mobile Safari/534.13' + 'Mozilla/5.0 (MeeGo; NokiaN9) AppleWebKit/534.13 (KHTML, like Gecko) NokiaBrowser/8.5.0 Mobile Safari/534.13', + // UC Mini (speed mode on) + 'Mozilla/5.0 (X11; U; Linux i686; zh-CN; r:1.2.3.4) Gecko/', + // Google Web Light proxy + 'Mozilla/5.0 (Linux; Android 4.2.1; en-us; Nexus 5 Build/JOP40D) AppleWebKit/535.19 (KHTML, like Gecko; googleweblight) Chrome/38.0.1025.166 Mobile Safari/535.19' ] }; diff --git a/thumb.php b/thumb.php index fca25c55d2..c38b89c251 100644 --- a/thumb.php +++ b/thumb.php @@ -341,6 +341,7 @@ function wfStreamThumb( array $params ) { // Check for thumbnail generation errors... $msg = wfMessage( 'thumbnail_error' ); $errorCode = 500; + if ( !$thumb ) { $errorMsg = $errorMsg ?: $msg->rawParams( 'File::transform() returned false' )->escaped(); if ( $errorMsg instanceof MessageSpecifier && @@ -350,6 +351,7 @@ function wfStreamThumb( array $params ) { } } elseif ( $thumb->isError() ) { $errorMsg = $thumb->getHtmlMsg(); + $errorCode = $thumb->getHttpStatusCode(); } elseif ( !$thumb->hasFile() ) { $errorMsg = $msg->rawParams( 'No path supplied in thumbnail object' )->escaped(); } elseif ( $thumb->fileIsSource() ) {

" + escapeText( document.title ) + "

" + escapeText( document.title ) + "

" + escapeText( document.title ) + "