resources/mediawiki.special/mediawiki.special.upload.js

   1 /*
   2  * JavaScript for Special:Upload
   3  * Note that additional code still lives in skins/common/upload.js
   4  */
   5
   6 /**
   7  * Add a preview to the upload form
   8  */
   9 jQuery( function( $ ) {
  10         /**
  11          * Is the FileAPI available with sufficient functionality?
  12          */
  13         function hasFileAPI(){
  14                 return typeof window.FileReader !== 'undefined';
  15         }
  16
  17         /**
  18          * Check if this is a recognizable image type...
  19          * Also excludes files over 10M to avoid going insane on memory usage.
  20          *
  21          * @todo is there a way we can ask the browser what's supported in <img>s?
  22          *
  23          * @param {File} file
  24          * @return boolean
  25          */
  26         function fileIsPreviewable( file ) {
  27                 var     known = ['image/png', 'image/gif', 'image/jpeg', 'image/svg+xml'],
  28                         tooHuge = 10 * 1024 * 1024;
  29                 return ( $.inArray( file.type, known ) !== -1 ) && file.size > 0 && file.size < tooHuge;
  30         }
  31
  32         /**
  33          * Show a thumbnail preview of PNG, JPEG, GIF, and SVG files prior to upload
  34          * in browsers supporting HTML5 FileAPI.
  35          *
  36          * As of this writing, known good:
  37          * - Firefox 3.6+
  38          * - Chrome 7.something
  39          *
  40          * @todo check file size limits and warn of likely failures
  41          *
  42          * @param {File} file
  43          */
  44         function showPreview( file ) {
  45                 var     previewSize = 180,
  46                         thumb = $( '<div id="mw-upload-thumbnail" class="thumb tright">' +
  47                                                 '<div class="thumbinner">' +
  48                                                         '<canvas width="' + previewSize + '" height="' + previewSize + '" ></canvas>' +
  49                                                         '<div class="thumbcaption"><div class="filename"></div><div class="fileinfo"></div></div>' +
  50                                                 '</div>' +
  51                                         '</div>' );
  52                 thumb.find( '.filename' ).text( file.name ).end()
  53                         .find( '.fileinfo' ).text( prettySize( file.size ) ).end();
  54
  55                 var     ctx = thumb.find( 'canvas' )[0].getContext( '2d' ),
  56                         spinner = new Image();
  57                 spinner.onload = function() {
  58                         ctx.drawImage( spinner, (previewSize - spinner.width) / 2,
  59                                         (previewSize - spinner.height) / 2 );
  60                 };
  61                 spinner.src = mw.config.get( 'wgScriptPath' ) + '/skins/common/images/spinner.gif';
  62                 $( '#mw-htmlform-source' ).parent().prepend( thumb );
  63
  64                 var meta;
  65                 fetchPreview( file, function( dataURL ) {
  66                         var     img = new Image(),
  67                                 rotation = 0;
  68
  69                         if ( meta && meta.tiff && meta.tiff.Orientation ) {
  70                                 rotation = (360 - function () {
  71                                         // See includes/media/Bitmap.php
  72                                         switch ( meta.tiff.Orientation.value ) {
  73                                                 case 8:
  74                                                         return 90;
  75                                                 case 3:
  76                                                         return 180;
  77                                                 case 6:
  78                                                         return 270;
  79                                                 default:
  80                                                         return 0;
  81                                         }
  82                                 }() ) % 360;
  83                         }
  84
  85                         img.onload = function() {
  86                                 var width, height, x, y, dx, dy, logicalWidth, logicalHeight;
  87                                 // Fit the image within the previewSizexpreviewSize box
  88                                 if ( img.width > img.height ) {
  89                                         width = previewSize;
  90                                         height = img.height / img.width * previewSize;
  91                                 } else {
  92                                         height = previewSize;
  93                                         width = img.width / img.height * previewSize;
  94                                 }
  95                                 // Determine the offset required to center the image
  96                                 dx = (180 - width) / 2;
  97                                 dy = (180 - height) / 2;
  98                                 switch ( rotation ) {
  99                                         // If a rotation is applied, the direction of the axis
 100                                         // changes as well. You can derive the values below by
 101                                         // drawing on paper an axis system, rotate it and see
 102                                         // where the positive axis direction is
 103                                         case 0:
 104                                                 x = dx;
 105                                                 y = dy;
 106                                                 logicalWidth = img.width;
 107                                                 logicalHeight = img.height;
 108                                                 break;
 109                                         case 90:
 110
 111                                                 x = dx;
 112                                                 y = dy - previewSize;
 113                                                 logicalWidth = img.height;
 114                                                 logicalHeight = img.width;
 115                                                 break;
 116                                         case 180:
 117                                                 x = dx - previewSize;
 118                                                 y = dy - previewSize;
 119                                                 logicalWidth = img.width;
 120                                                 logicalHeight = img.height;
 121                                                 break;
 122                                         case 270:
 123                                                 x = dx - previewSize;
 124                                                 y = dy;
 125                                                 logicalWidth = img.height;
 126                                                 logicalHeight = img.width;
 127                                                 break;
 128                                 }
 129
 130                                 ctx.clearRect( 0, 0, 180, 180 );
 131                                 ctx.rotate( rotation / 180 * Math.PI );
 132                                 ctx.drawImage( img, x, y, width, height );
 133
 134                                 // Image size
 135                                 var info = mw.msg( 'widthheight', logicalWidth, logicalHeight ) +
 136                                         ', ' + prettySize( file.size );
 137                                 $( '#mw-upload-thumbnail .fileinfo' ).text( info );
 138                         };
 139                         img.src = dataURL;
 140                 }, mw.config.get( 'wgFileCanRotate' ) ? function ( data ) {
 141                         try {
 142                                 meta = mw.libs.jpegmeta( data, file.fileName );
 143                                 meta._binary_data = null;
 144                         } catch ( e ) {
 145                                 meta = null;
 146                         }
 147                 } : null );
 148         }
 149
 150         /**
 151          * Start loading a file into memory; when complete, pass it as a
 152          * data URL to the callback function. If the callbackBinary is set it will
 153          * first be read as binary and afterwards as data URL. Useful if you want
 154          * to do preprocessing on the binary data first.
 155          *
 156          * @param {File} file
 157          * @param {function} callback
 158          * @param {function} callbackBinary
 159          */
 160         function fetchPreview( file, callback, callbackBinary ) {
 161                 var reader = new FileReader();
 162                 reader.onload = function() {
 163                         if ( callbackBinary ) {
 164                                 callbackBinary( reader.result );
 165                                 reader.onload = function() {
 166                                         callback( reader.result );
 167                                 };
 168                                 reader.readAsDataURL( file );
 169                         } else {
 170                                 callback( reader.result );
 171                         }
 172                 };
 173                 if ( callbackBinary ) {
 174                         reader.readAsBinaryString( file );
 175                 } else {
 176                         reader.readAsDataURL( file );
 177                 }
 178         }
 179
 180         /**
 181          * Format a file size attractively.
 182          * @todo match numeric formatting
 183          *
 184          * @param {number} s
 185          * @return string
 186          */
 187         function prettySize( s ) {
 188                 var sizes = ['size-bytes', 'size-kilobytes', 'size-megabytes', 'size-gigabytes'];
 189                 while ( s >= 1024 && sizes.length > 1 ) {
 190                         s /= 1024;
 191                         sizes = sizes.slice( 1 );
 192                 }
 193                 return mw.msg( sizes[0], Math.round( s ) );
 194         }
 195
 196         /**
 197          * Clear the file upload preview area.
 198          */
 199         function clearPreview() {
 200                 $( '#mw-upload-thumbnail' ).remove();
 201         }
 202
 203         /**
 204          * Check if the file does not exceed the maximum size
 205          */
 206         function checkMaxUploadSize( file ) {
 207                 function getMaxUploadSize( type ) {
 208                         var sizes = mw.config.get( 'wgMaxUploadSize' );
 209                         if ( sizes[type] !== undefined ) {
 210                                 return sizes[type];
 211                         }
 212                         return sizes['*'];
 213                 }
 214                 $( '.mw-upload-source-error' ).remove();
 215
 216                 var maxSize = getMaxUploadSize( 'file' );
 217                 if ( file.size > maxSize ) {
 218                         var error = $( '<p class="error mw-upload-source-error" id="wpSourceTypeFile-error">' +
 219                                         mw.message( 'largefileserver', file.size, maxSize ).escaped() + '</p>' );
 220                         $( '#wpUploadFile' ).after( error );
 221                         return false;
 222                 }
 223                 return true;
 224         }
 225
 226
 227         /**
 228          * Initialization
 229          */
 230         if ( hasFileAPI() ) {
 231                 // Update thumbnail when the file selection control is updated.
 232                 $( '#wpUploadFile' ).change( function() {
 233                         clearPreview();
 234                         if ( this.files && this.files.length ) {
 235                                 // Note: would need to be updated to handle multiple files.
 236                                 var file = this.files[0];
 237
 238                                 if ( !checkMaxUploadSize( file ) ) {
 239                                         return;
 240                                 }
 241
 242                                 if ( fileIsPreviewable( file ) ) {
 243                                         showPreview( file );
 244                                 }
 245                         }
 246                 } );
 247         }
 248 } );
 249
 250 /**
 251  * Disable all upload source fields except the selected one
 252  */
 253 jQuery( function ( $ ) {
 254         var rows = $( '.mw-htmlform-field-UploadSourceField' );
 255         for ( var i = rows.length; i; i-- ) {
 256                 var row = rows[i - 1];
 257                 $( 'input[name="wpSourceType"]', row ).change( function () {
 258                         var currentRow = row; // Store current row in our own scope
 259                         return function () {
 260                                 $( '.mw-upload-source-error' ).remove();
 261                                 if ( this.checked ) {
 262                                         // Disable all inputs
 263                                         $( 'input[name!="wpSourceType"]', rows ).prop( 'disabled', 'disabled' );
 264                                         // Re-enable the current one
 265                                         $( 'input', currentRow ).prop( 'disabled', false );
 266                                 }
 267                         };
 268                 }() );
 269         }
 270 } );
 271