diff options
Diffstat (limited to 'resources/src/mediawiki.special/mediawiki.special.upload.js')
| -rw-r--r-- | resources/src/mediawiki.special/mediawiki.special.upload.js | 565 |
1 files changed, 565 insertions, 0 deletions
diff --git a/resources/src/mediawiki.special/mediawiki.special.upload.js b/resources/src/mediawiki.special/mediawiki.special.upload.js new file mode 100644 index 00000000..286befcc --- /dev/null +++ b/resources/src/mediawiki.special/mediawiki.special.upload.js @@ -0,0 +1,565 @@ +/** + * JavaScript for Special:Upload + * + * @private + * @class mw.special.upload + * @singleton + */ +( function ( mw, $ ) { + var ajaxUploadDestCheck = mw.config.get( 'wgAjaxUploadDestCheck' ), + $license = $( '#wpLicense' ), uploadWarning, uploadLicense; + + window.wgUploadWarningObj = uploadWarning = { + responseCache: { '': ' ' }, + nameToCheck: '', + typing: false, + delay: 500, // ms + timeoutID: false, + + keypress: function () { + if ( !ajaxUploadDestCheck ) { + return; + } + + // Find file to upload + if ( !$( '#wpDestFile' ).length || !$( '#wpDestFile-warning' ).length ) { + return; + } + + this.nameToCheck = $( '#wpDestFile' ).val(); + + // Clear timer + if ( this.timeoutID ) { + clearTimeout( this.timeoutID ); + } + // Check response cache + if ( this.responseCache.hasOwnProperty( this.nameToCheck ) ) { + this.setWarning( this.responseCache[this.nameToCheck] ); + return; + } + + this.timeoutID = setTimeout( function () { + uploadWarning.timeout(); + }, this.delay ); + }, + + checkNow: function ( fname ) { + if ( !ajaxUploadDestCheck ) { + return; + } + if ( this.timeoutID ) { + clearTimeout( this.timeoutID ); + } + this.nameToCheck = fname; + this.timeout(); + }, + + timeout: function () { + var $spinnerDestCheck; + if ( !ajaxUploadDestCheck || this.nameToCheck === '' ) { + return; + } + $spinnerDestCheck = $.createSpinner().insertAfter( '#wpDestFile' ); + + ( new mw.Api() ).get( { + action: 'query', + titles: ( new mw.Title( this.nameToCheck, mw.config.get( 'wgNamespaceIds' ).file ) ).getPrefixedText(), + prop: 'imageinfo', + iiprop: 'uploadwarning', + indexpageids: '' + } ).done( function ( result ) { + var resultOut = ''; + if ( result.query ) { + resultOut = result.query.pages[result.query.pageids[0]].imageinfo[0]; + } + $spinnerDestCheck.remove(); + uploadWarning.processResult( resultOut, uploadWarning.nameToCheck ); + } ); + }, + + processResult: function ( result, fileName ) { + this.setWarning( result.html ); + this.responseCache[fileName] = result.html; + }, + + setWarning: function ( warning ) { + $( '#wpDestFile-warning' ).html( warning ); + + // Set a value in the form indicating that the warning is acknowledged and + // doesn't need to be redisplayed post-upload + if ( !warning ) { + $( '#wpDestFileWarningAck' ).val( '' ); + } else { + $( '#wpDestFileWarningAck' ).val( '1' ); + } + + } + }; + + uploadLicense = { + + responseCache: { '': '' }, + + fetchPreview: function ( license ) { + var $spinnerLicense; + if ( !mw.config.get( 'wgAjaxLicensePreview' ) ) { + return; + } + if ( this.responseCache.hasOwnProperty( license ) ) { + this.showPreview( this.responseCache[license] ); + return; + } + + $spinnerLicense = $.createSpinner().insertAfter( '#wpLicense' ); + + ( new mw.Api() ).get( { + action: 'parse', + text: '{{' + license + '}}', + title: $( '#wpDestFile' ).val() || 'File:Sample.jpg', + prop: 'text', + pst: '' + } ).done( function ( result ) { + $spinnerLicense.remove(); + uploadLicense.processResult( result, license ); + } ); + }, + + processResult: function ( result, license ) { + this.responseCache[license] = result.parse.text['*']; + this.showPreview( this.responseCache[license] ); + }, + + showPreview: function ( preview ) { + $( '#mw-license-preview' ).html( preview ); + } + + }; + + $( function () { + // Disable URL box if the URL copy upload source type is not selected + if ( !$( '#wpSourceTypeurl' ).prop( 'checked' ) ) { + $( '#wpUploadFileURL' ).prop( 'disabled', true ); + } + + // AJAX wpDestFile warnings + if ( ajaxUploadDestCheck ) { + // Insert an event handler that fetches upload warnings when wpDestFile + // has been changed + $( '#wpDestFile' ).change( function () { + uploadWarning.checkNow( $( this ).val() ); + } ); + // Insert a row where the warnings will be displayed just below the + // wpDestFile row + $( '#mw-htmlform-description tbody' ).append( + $( '<tr>' ).append( + $( '<td>' ) + .attr( 'id', 'wpDestFile-warning' ) + .attr( 'colspan', 2 ) + ) + ); + } + + if ( mw.config.get( 'wgAjaxLicensePreview' ) && $license.length ) { + // License selector check + $license.change( function () { + // We might show a preview + uploadLicense.fetchPreview( $license.val() ); + } ); + + // License selector table row + $license.closest( 'tr' ).after( + $( '<tr>' ).append( + $( '<td>' ), + $( '<td>' ).attr( 'id', 'mw-license-preview' ) + ) + ); + } + + // fillDestFile setup + $.each( mw.config.get( 'wgUploadSourceIds' ), function ( index, sourceId ) { + $( '#' + sourceId ).change( function () { + var path, slash, backslash, fname; + if ( !mw.config.get( 'wgUploadAutoFill' ) ) { + return; + } + // Remove any previously flagged errors + $( '#mw-upload-permitted' ).attr( 'class', '' ); + $( '#mw-upload-prohibited' ).attr( 'class', '' ); + + path = $( this ).val(); + // Find trailing part + slash = path.lastIndexOf( '/' ); + backslash = path.lastIndexOf( '\\' ); + if ( slash === -1 && backslash === -1 ) { + fname = path; + } else if ( slash > backslash ) { + fname = path.slice( slash + 1 ); + } else { + fname = path.slice( backslash + 1 ); + } + + // Clear the filename if it does not have a valid extension. + // URLs are less likely to have a useful extension, so don't include them in the + // extension check. + if ( + mw.config.get( 'wgStrictFileExtensions' ) && + mw.config.get( 'wgFileExtensions' ) && + $( this ).attr( 'id' ) !== 'wpUploadFileURL' + ) { + if ( + fname.lastIndexOf( '.' ) === -1 || + $.inArray( + fname.slice( fname.lastIndexOf( '.' ) + 1 ).toLowerCase(), + $.map( mw.config.get( 'wgFileExtensions' ), function ( element ) { + return element.toLowerCase(); + } ) + ) === -1 + ) { + // Not a valid extension + // Clear the upload and set mw-upload-permitted to error + $( this ).val( '' ); + $( '#mw-upload-permitted' ).attr( 'class', 'error' ); + $( '#mw-upload-prohibited' ).attr( 'class', 'error' ); + // Clear wpDestFile as well + $( '#wpDestFile' ).val( '' ); + + return false; + } + } + + // Replace spaces by underscores + fname = fname.replace( / /g, '_' ); + // Capitalise first letter if needed + if ( mw.config.get( 'wgCapitalizeUploads' ) ) { + fname = fname.charAt( 0 ).toUpperCase().concat( fname.slice( 1 ) ); + } + + // Output result + if ( $( '#wpDestFile' ).length ) { + // Call decodeURIComponent function to remove possible URL-encoded characters + // from the file name (bug 30390). Especially likely with upload-form-url. + // decodeURIComponent can throw an exception if input is invalid utf-8 + try { + $( '#wpDestFile' ).val( decodeURIComponent( fname ) ); + } catch ( err ) { + $( '#wpDestFile' ).val( fname ); + } + uploadWarning.checkNow( fname ); + } + } ); + } ); + } ); + + // Add a preview to the upload form + $( function () { + /** + * Is the FileAPI available with sufficient functionality? + */ + function hasFileAPI() { + return window.FileReader !== undefined; + } + + /** + * Check if this is a recognizable image type... + * Also excludes files over 10M to avoid going insane on memory usage. + * + * TODO: Is there a way we can ask the browser what's supported in `<img>`s? + * + * TODO: Put SVG back after working around Firefox 7 bug <https://bugzilla.wikimedia.org/show_bug.cgi?id=31643> + * + * @param {File} file + * @return boolean + */ + function fileIsPreviewable( file ) { + var known = ['image/png', 'image/gif', 'image/jpeg', 'image/svg+xml'], + tooHuge = 10 * 1024 * 1024; + return ( $.inArray( file.type, known ) !== -1 ) && file.size > 0 && file.size < tooHuge; + } + + /** + * Show a thumbnail preview of PNG, JPEG, GIF, and SVG files prior to upload + * in browsers supporting HTML5 FileAPI. + * + * As of this writing, known good: + * + * - Firefox 3.6+ + * - Chrome 7.something + * + * TODO: Check file size limits and warn of likely failures + * + * @param {File} file + */ + function showPreview( file ) { + var $canvas, + ctx, + meta, + previewSize = 180, + thumb = $( '<div id="mw-upload-thumbnail" class="thumb tright">' + + '<div class="thumbinner">' + + '<div class="mw-small-spinner" style="width: 180px; height: 180px"></div>' + + '<div class="thumbcaption"><div class="filename"></div><div class="fileinfo"></div></div>' + + '</div>' + + '</div>' ); + + thumb.find( '.filename' ).text( file.name ).end() + .find( '.fileinfo' ).text( prettySize( file.size ) ).end(); + + $canvas = $( '<canvas width="' + previewSize + '" height="' + previewSize + '" ></canvas>' ); + ctx = $canvas[0].getContext( '2d' ); + $( '#mw-htmlform-source' ).parent().prepend( thumb ); + + fetchPreview( file, function ( dataURL ) { + var img = new Image(), + rotation = 0; + + if ( meta && meta.tiff && meta.tiff.Orientation ) { + rotation = ( 360 - ( function () { + // See includes/media/Bitmap.php + switch ( meta.tiff.Orientation.value ) { + case 8: + return 90; + case 3: + return 180; + case 6: + return 270; + default: + return 0; + } + }() ) ) % 360; + } + + img.onload = function () { + var info, width, height, x, y, dx, dy, logicalWidth, logicalHeight; + + // Fit the image within the previewSizexpreviewSize box + if ( img.width > img.height ) { + width = previewSize; + height = img.height / img.width * previewSize; + } else { + height = previewSize; + width = img.width / img.height * previewSize; + } + // Determine the offset required to center the image + dx = ( 180 - width ) / 2; + dy = ( 180 - height ) / 2; + switch ( rotation ) { + // If a rotation is applied, the direction of the axis + // changes as well. You can derive the values below by + // drawing on paper an axis system, rotate it and see + // where the positive axis direction is + case 0: + x = dx; + y = dy; + logicalWidth = img.width; + logicalHeight = img.height; + break; + case 90: + + x = dx; + y = dy - previewSize; + logicalWidth = img.height; + logicalHeight = img.width; + break; + case 180: + x = dx - previewSize; + y = dy - previewSize; + logicalWidth = img.width; + logicalHeight = img.height; + break; + case 270: + x = dx - previewSize; + y = dy; + logicalWidth = img.height; + logicalHeight = img.width; + break; + } + + ctx.clearRect( 0, 0, 180, 180 ); + ctx.rotate( rotation / 180 * Math.PI ); + ctx.drawImage( img, x, y, width, height ); + thumb.find( '.mw-small-spinner' ).replaceWith( $canvas ); + + // Image size + info = mw.msg( 'widthheight', logicalWidth, logicalHeight ) + + ', ' + prettySize( file.size ); + + $( '#mw-upload-thumbnail .fileinfo' ).text( info ); + }; + img.src = dataURL; + }, mw.config.get( 'wgFileCanRotate' ) ? function ( data ) { + /*jshint camelcase:false, nomen:false */ + try { + meta = mw.libs.jpegmeta( data, file.fileName ); + meta._binary_data = null; + } catch ( e ) { + meta = null; + } + } : null ); + } + + /** + * Start loading a file into memory; when complete, pass it as a + * data URL to the callback function. If the callbackBinary is set it will + * first be read as binary and afterwards as data URL. Useful if you want + * to do preprocessing on the binary data first. + * + * @param {File} file + * @param {Function} callback + * @param {Function} callbackBinary + */ + function fetchPreview( file, callback, callbackBinary ) { + var reader = new FileReader(); + if ( callbackBinary && 'readAsBinaryString' in reader ) { + // To fetch JPEG metadata we need a binary string; start there. + // todo: + reader.onload = function () { + callbackBinary( reader.result ); + + // Now run back through the regular code path. + fetchPreview( file, callback ); + }; + reader.readAsBinaryString( file ); + } else if ( callbackBinary && 'readAsArrayBuffer' in reader ) { + // readAsArrayBuffer replaces readAsBinaryString + // However, our JPEG metadata library wants a string. + // So, this is going to be an ugly conversion. + reader.onload = function () { + var i, + buffer = new Uint8Array( reader.result ), + string = ''; + for ( i = 0; i < buffer.byteLength; i++ ) { + string += String.fromCharCode( buffer[i] ); + } + callbackBinary( string ); + + // Now run back through the regular code path. + fetchPreview( file, callback ); + }; + reader.readAsArrayBuffer( file ); + } else if ( 'URL' in window && 'createObjectURL' in window.URL ) { + // Supported in Firefox 4.0 and above <https://developer.mozilla.org/en/DOM/window.URL.createObjectURL> + // WebKit has it in a namespace for now but that's ok. ;) + // + // Lifetime of this URL is until document close, which is fine + // for Special:Upload -- if this code gets used on longer-running + // pages, add a revokeObjectURL() when it's no longer needed. + // + // Prefer this over readAsDataURL for Firefox 7 due to bug reading + // some SVG files from data URIs <https://bugzilla.mozilla.org/show_bug.cgi?id=694165> + callback( window.URL.createObjectURL( file ) ); + } else { + // This ends up decoding the file to base-64 and back again, which + // feels horribly inefficient. + reader.onload = function () { + callback( reader.result ); + }; + reader.readAsDataURL( file ); + } + } + + /** + * Format a file size attractively. + * + * TODO: Match numeric formatting + * + * @param {number} s + * @return {string} + */ + function prettySize( s ) { + var sizeMsgs = ['size-bytes', 'size-kilobytes', 'size-megabytes', 'size-gigabytes']; + while ( s >= 1024 && sizeMsgs.length > 1 ) { + s /= 1024; + sizeMsgs = sizeMsgs.slice( 1 ); + } + return mw.msg( sizeMsgs[0], Math.round( s ) ); + } + + /** + * Clear the file upload preview area. + */ + function clearPreview() { + $( '#mw-upload-thumbnail' ).remove(); + } + + /** + * Check if the file does not exceed the maximum size + */ + function checkMaxUploadSize( file ) { + var maxSize, $error; + + function getMaxUploadSize( type ) { + var sizes = mw.config.get( 'wgMaxUploadSize' ); + + if ( sizes[type] !== undefined ) { + return sizes[type]; + } + return sizes['*']; + } + + $( '.mw-upload-source-error' ).remove(); + + maxSize = getMaxUploadSize( 'file' ); + if ( file.size > maxSize ) { + $error = $( '<p class="error mw-upload-source-error" id="wpSourceTypeFile-error">' + + mw.message( 'largefileserver', file.size, maxSize ).escaped() + '</p>' ); + + $( '#wpUploadFile' ).after( $error ); + + return false; + } + + return true; + } + + /* Initialization */ + if ( hasFileAPI() ) { + // Update thumbnail when the file selection control is updated. + $( '#wpUploadFile' ).change( function () { + clearPreview(); + if ( this.files && this.files.length ) { + // Note: would need to be updated to handle multiple files. + var file = this.files[0]; + + if ( !checkMaxUploadSize( file ) ) { + return; + } + + if ( fileIsPreviewable( file ) ) { + showPreview( file ); + } + } + } ); + } + } ); + + // Disable all upload source fields except the selected one + $( function () { + var i, $row, + $rows = $( '.mw-htmlform-field-UploadSourceField' ); + + /** + * @param {jQuery} $currentRow + * @return {Function} Handler + * @return {jQuery.Event} return.e + */ + function createHandler( $currentRow ) { + return function () { + $( '.mw-upload-source-error' ).remove(); + if ( this.checked ) { + // Disable all inputs + $rows.find( 'input[name!="wpSourceType"]' ).prop( 'disabled', true ); + // Re-enable the current one + $currentRow.find( 'input' ).prop( 'disabled', false ); + } + }; + } + + for ( i = $rows.length; i; i-- ) { + $row = $rows.eq( i - 1 ); + $row + .find( 'input[name="wpSourceType"]' ) + .change( createHandler( $row ) ); + } + } ); + +}( mediaWiki, jQuery ) ); |