| blob | c6ee1a7793bcd205acd84be35c8c0df103270a8c |
1 /**
2 * JavaScript for Special:Upload
3 *
4 * @private
5 * @class mw.special.upload
6 * @singleton
7 */
8 ( function ( mw, $ ) {
9 var ajaxUploadDestCheck = mw.config.get( 'wgAjaxUploadDestCheck' ),
10 $license = $( '#wpLicense' ), uploadWarning, uploadLicense;
12 window.wgUploadWarningObj = uploadWarning = {
13 responseCache: { '': ' ' },
14 nameToCheck: '',
15 typing: false,
16 delay: 500, // ms
17 timeoutID: false,
19 keypress: function () {
20 if ( !ajaxUploadDestCheck ) {
21 return;
22 }
24 // Find file to upload
25 if ( !$( '#wpDestFile' ).length || !$( '#wpDestFile-warning' ).length ) {
26 return;
27 }
29 this.nameToCheck = $( '#wpDestFile' ).val();
31 // Clear timer
32 if ( this.timeoutID ) {
33 clearTimeout( this.timeoutID );
34 }
35 // Check response cache
36 if ( this.responseCache.hasOwnProperty( this.nameToCheck ) ) {
37 this.setWarning( this.responseCache[this.nameToCheck] );
38 return;
39 }
41 this.timeoutID = setTimeout( function () {
42 uploadWarning.timeout();
43 }, this.delay );
44 },
46 checkNow: function ( fname ) {
47 if ( !ajaxUploadDestCheck ) {
48 return;
49 }
50 if ( this.timeoutID ) {
51 clearTimeout( this.timeoutID );
52 }
53 this.nameToCheck = fname;
54 this.timeout();
55 },
57 timeout: function () {
58 var $spinnerDestCheck;
59 if ( !ajaxUploadDestCheck || this.nameToCheck === '' ) {
60 return;
61 }
62 $spinnerDestCheck = $.createSpinner().insertAfter( '#wpDestFile' );
64 ( new mw.Api() ).get( {
65 action: 'query',
66 titles: ( new mw.Title( this.nameToCheck, mw.config.get( 'wgNamespaceIds' ).file ) ).getPrefixedText(),
67 prop: 'imageinfo',
68 iiprop: 'uploadwarning',
69 indexpageids: ''
70 } ).done( function ( result ) {
71 var resultOut = '';
72 if ( result.query ) {
73 resultOut = result.query.pages[result.query.pageids[0]].imageinfo[0];
74 }
75 $spinnerDestCheck.remove();
76 uploadWarning.processResult( resultOut, uploadWarning.nameToCheck );
77 } );
78 },
80 processResult: function ( result, fileName ) {
81 this.setWarning( result.html );
82 this.responseCache[fileName] = result.html;
83 },
85 setWarning: function ( warning ) {
86 $( '#wpDestFile-warning' ).html( warning );
88 // Set a value in the form indicating that the warning is acknowledged and
89 // doesn't need to be redisplayed post-upload
90 if ( !warning ) {
91 $( '#wpDestFileWarningAck' ).val( '' );
92 } else {
93 $( '#wpDestFileWarningAck' ).val( '1' );
94 }
96 }
97 };
99 uploadLicense = {
101 responseCache: { '': '' },
103 fetchPreview: function ( license ) {
104 var $spinnerLicense;
105 if ( !mw.config.get( 'wgAjaxLicensePreview' ) ) {
106 return;
107 }
108 if ( this.responseCache.hasOwnProperty( license ) ) {
109 this.showPreview( this.responseCache[license] );
110 return;
111 }
113 $spinnerLicense = $.createSpinner().insertAfter( '#wpLicense' );
115 ( new mw.Api() ).get( {
116 action: 'parse',
117 text: '{{' + license + '}}',
118 title: $( '#wpDestFile' ).val() || 'File:Sample.jpg',
119 prop: 'text',
120 pst: ''
121 } ).done( function ( result ) {
122 $spinnerLicense.remove();
123 uploadLicense.processResult( result, license );
124 } );
125 },
127 processResult: function ( result, license ) {
128 this.responseCache[license] = result.parse.text['*'];
129 this.showPreview( this.responseCache[license] );
130 },
132 showPreview: function ( preview ) {
133 $( '#mw-license-preview' ).html( preview );
134 }
136 };
138 $( function () {
139 // Disable URL box if the URL copy upload source type is not selected
140 if ( !$( '#wpSourceTypeurl' ).prop( 'checked' ) ) {
141 $( '#wpUploadFileURL' ).prop( 'disabled', true );
142 }
144 // AJAX wpDestFile warnings
145 if ( ajaxUploadDestCheck ) {
146 // Insert an event handler that fetches upload warnings when wpDestFile
147 // has been changed
148 $( '#wpDestFile' ).change( function () {
149 uploadWarning.checkNow( $( this ).val() );
150 } );
151 // Insert a row where the warnings will be displayed just below the
152 // wpDestFile row
153 $( '#mw-htmlform-description tbody' ).append(
154 $( '<tr>' ).append(
155 $( '<td>' )
156 .attr( 'id', 'wpDestFile-warning' )
157 .attr( 'colspan', 2 )
158 )
159 );
160 }
162 if ( mw.config.get( 'wgAjaxLicensePreview' ) && $license.length ) {
163 // License selector check
164 $license.change( function () {
165 // We might show a preview
166 uploadLicense.fetchPreview( $license.val() );
167 } );
169 // License selector table row
170 $license.closest( 'tr' ).after(
171 $( '<tr>' ).append(
172 $( '<td>' ),
173 $( '<td>' ).attr( 'id', 'mw-license-preview' )
174 )
175 );
176 }
178 // fillDestFile setup
179 $.each( mw.config.get( 'wgUploadSourceIds' ), function ( index, sourceId ) {
180 $( '#' + sourceId ).change( function () {
181 var path, slash, backslash, fname;
182 if ( !mw.config.get( 'wgUploadAutoFill' ) ) {
183 return;
184 }
185 // Remove any previously flagged errors
186 $( '#mw-upload-permitted' ).attr( 'class', '' );
187 $( '#mw-upload-prohibited' ).attr( 'class', '' );
189 path = $( this ).val();
190 // Find trailing part
191 slash = path.lastIndexOf( '/' );
192 backslash = path.lastIndexOf( '\\' );
193 if ( slash === -1 && backslash === -1 ) {
194 fname = path;
195 } else if ( slash > backslash ) {
196 fname = path.slice( slash + 1 );
197 } else {
198 fname = path.slice( backslash + 1 );
199 }
201 // Clear the filename if it does not have a valid extension.
202 // URLs are less likely to have a useful extension, so don't include them in the
203 // extension check.
204 if (
205 mw.config.get( 'wgStrictFileExtensions' ) &&
206 mw.config.get( 'wgFileExtensions' ) &&
207 $( this ).attr( 'id' ) !== 'wpUploadFileURL'
208 ) {
209 if (
210 fname.lastIndexOf( '.' ) === -1 ||
211 $.inArray(
212 fname.slice( fname.lastIndexOf( '.' ) + 1 ).toLowerCase(),
213 $.map( mw.config.get( 'wgFileExtensions' ), function ( element ) {
214 return element.toLowerCase();
215 } )
216 ) === -1
217 ) {
218 // Not a valid extension
219 // Clear the upload and set mw-upload-permitted to error
220 $( this ).val( '' );
221 $( '#mw-upload-permitted' ).attr( 'class', 'error' );
222 $( '#mw-upload-prohibited' ).attr( 'class', 'error' );
223 // Clear wpDestFile as well
224 $( '#wpDestFile' ).val( '' );
226 return false;
227 }
228 }
230 // Replace spaces by underscores
231 fname = fname.replace( / /g, '_' );
232 // Capitalise first letter if needed
233 if ( mw.config.get( 'wgCapitalizeUploads' ) ) {
234 fname = fname.charAt( 0 ).toUpperCase().concat( fname.slice( 1 ) );
235 }
237 // Output result
238 if ( $( '#wpDestFile' ).length ) {
239 // Call decodeURIComponent function to remove possible URL-encoded characters
240 // from the file name (bug 30390). Especially likely with upload-form-url.
241 // decodeURIComponent can throw an exception if input is invalid utf-8
242 try {
243 $( '#wpDestFile' ).val( decodeURIComponent( fname ) );
244 } catch ( err ) {
245 $( '#wpDestFile' ).val( fname );
246 }
247 uploadWarning.checkNow( fname );
248 }
249 } );
250 } );
251 } );
253 // Add a preview to the upload form
254 $( function () {
255 /**
256 * Is the FileAPI available with sufficient functionality?
257 */
258 function hasFileAPI() {
259 return window.FileReader !== undefined;
260 }
262 /**
263 * Check if this is a recognizable image type...
264 * Also excludes files over 10M to avoid going insane on memory usage.
265 *
266 * TODO: Is there a way we can ask the browser what's supported in `<img>`s?
267 *
268 * TODO: Put SVG back after working around Firefox 7 bug <https://bugzilla.wikimedia.org/show_bug.cgi?id=31643>
269 *
270 * @param {File} file
271 * @return boolean
272 */
273 function fileIsPreviewable( file ) {
274 var known = ['image/png', 'image/gif', 'image/jpeg', 'image/svg+xml'],
275 tooHuge = 10 * 1024 * 1024;
276 return ( $.inArray( file.type, known ) !== -1 ) && file.size > 0 && file.size < tooHuge;
277 }
279 /**
280 * Show a thumbnail preview of PNG, JPEG, GIF, and SVG files prior to upload
281 * in browsers supporting HTML5 FileAPI.
282 *
283 * As of this writing, known good:
284 *
285 * - Firefox 3.6+
286 * - Chrome 7.something
287 *
288 * TODO: Check file size limits and warn of likely failures
289 *
290 * @param {File} file
291 */
292 function showPreview( file ) {
293 var $canvas,
294 ctx,
295 meta,
296 previewSize = 180,
297 thumb = mw.template.get( 'mediawiki.special.upload', 'thumbnail.html' ).render();
299 thumb.find( '.filename' ).text( file.name ).end()
300 .find( '.fileinfo' ).text( prettySize( file.size ) ).end();
302 $canvas = $( '<canvas width="' + previewSize + '" height="' + previewSize + '" ></canvas>' );
303 ctx = $canvas[0].getContext( '2d' );
304 $( '#mw-htmlform-source' ).parent().prepend( thumb );
306 fetchPreview( file, function ( dataURL ) {
307 var img = new Image(),
308 rotation = 0;
310 if ( meta && meta.tiff && meta.tiff.Orientation ) {
311 rotation = ( 360 - ( function () {
312 // See includes/media/Bitmap.php
313 switch ( meta.tiff.Orientation.value ) {
314 case 8:
315 return 90;
316 case 3:
317 return 180;
318 case 6:
319 return 270;
320 default:
321 return 0;
322 }
323 }() ) ) % 360;
324 }
326 img.onload = function () {
327 var info, width, height, x, y, dx, dy, logicalWidth, logicalHeight;
329 // Fit the image within the previewSizexpreviewSize box
330 if ( img.width > img.height ) {
331 width = previewSize;
332 height = img.height / img.width * previewSize;
333 } else {
334 height = previewSize;
335 width = img.width / img.height * previewSize;
336 }
337 // Determine the offset required to center the image
338 dx = ( 180 - width ) / 2;
339 dy = ( 180 - height ) / 2;
340 switch ( rotation ) {
341 // If a rotation is applied, the direction of the axis
342 // changes as well. You can derive the values below by
343 // drawing on paper an axis system, rotate it and see
344 // where the positive axis direction is
345 case 0:
346 x = dx;
347 y = dy;
348 logicalWidth = img.width;
349 logicalHeight = img.height;
350 break;
351 case 90:
353 x = dx;
354 y = dy - previewSize;
355 logicalWidth = img.height;
356 logicalHeight = img.width;
357 break;
358 case 180:
359 x = dx - previewSize;
360 y = dy - previewSize;
361 logicalWidth = img.width;
362 logicalHeight = img.height;
363 break;
364 case 270:
365 x = dx - previewSize;
366 y = dy;
367 logicalWidth = img.height;
368 logicalHeight = img.width;
369 break;
370 }
372 ctx.clearRect( 0, 0, 180, 180 );
373 ctx.rotate( rotation / 180 * Math.PI );
374 ctx.drawImage( img, x, y, width, height );
375 thumb.find( '.mw-small-spinner' ).replaceWith( $canvas );
377 // Image size
378 info = mw.msg( 'widthheight', logicalWidth, logicalHeight ) +
379 ', ' + prettySize( file.size );
381 $( '#mw-upload-thumbnail .fileinfo' ).text( info );
382 };
383 img.src = dataURL;
384 }, mw.config.get( 'wgFileCanRotate' ) ? function ( data ) {
385 try {
386 meta = mw.libs.jpegmeta( data, file.fileName );
387 // jscs:disable requireCamelCaseOrUpperCaseIdentifiers, disallowDanglingUnderscores
388 meta._binary_data = null;
389 // jscs:enable
390 } catch ( e ) {
391 meta = null;
392 }
393 } : null );
394 }
396 /**
397 * Start loading a file into memory; when complete, pass it as a
398 * data URL to the callback function. If the callbackBinary is set it will
399 * first be read as binary and afterwards as data URL. Useful if you want
400 * to do preprocessing on the binary data first.
401 *
402 * @param {File} file
403 * @param {Function} callback
404 * @param {Function} callbackBinary
405 */
406 function fetchPreview( file, callback, callbackBinary ) {
407 var reader = new FileReader();
408 if ( callbackBinary && 'readAsBinaryString' in reader ) {
409 // To fetch JPEG metadata we need a binary string; start there.
410 // todo:
411 reader.onload = function () {
412 callbackBinary( reader.result );
414 // Now run back through the regular code path.
415 fetchPreview( file, callback );
416 };
417 reader.readAsBinaryString( file );
418 } else if ( callbackBinary && 'readAsArrayBuffer' in reader ) {
419 // readAsArrayBuffer replaces readAsBinaryString
420 // However, our JPEG metadata library wants a string.
421 // So, this is going to be an ugly conversion.
422 reader.onload = function () {
423 var i,
424 buffer = new Uint8Array( reader.result ),
425 string = '';
426 for ( i = 0; i < buffer.byteLength; i++ ) {
427 string += String.fromCharCode( buffer[i] );
428 }
429 callbackBinary( string );
431 // Now run back through the regular code path.
432 fetchPreview( file, callback );
433 };
434 reader.readAsArrayBuffer( file );
435 } else if ( 'URL' in window && 'createObjectURL' in window.URL ) {
436 // Supported in Firefox 4.0 and above <https://developer.mozilla.org/en/DOM/window.URL.createObjectURL>
437 // WebKit has it in a namespace for now but that's ok. ;)
438 //
439 // Lifetime of this URL is until document close, which is fine
440 // for Special:Upload -- if this code gets used on longer-running
441 // pages, add a revokeObjectURL() when it's no longer needed.
442 //
443 // Prefer this over readAsDataURL for Firefox 7 due to bug reading
444 // some SVG files from data URIs <https://bugzilla.mozilla.org/show_bug.cgi?id=694165>
445 callback( window.URL.createObjectURL( file ) );
446 } else {
447 // This ends up decoding the file to base-64 and back again, which
448 // feels horribly inefficient.
449 reader.onload = function () {
450 callback( reader.result );
451 };
452 reader.readAsDataURL( file );
453 }
454 }
456 /**
457 * Format a file size attractively.
458 *
459 * TODO: Match numeric formatting
460 *
461 * @param {number} s
462 * @return {string}
463 */
464 function prettySize( s ) {
465 var sizeMsgs = ['size-bytes', 'size-kilobytes', 'size-megabytes', 'size-gigabytes'];
466 while ( s >= 1024 && sizeMsgs.length > 1 ) {
467 s /= 1024;
468 sizeMsgs = sizeMsgs.slice( 1 );
469 }
470 return mw.msg( sizeMsgs[0], Math.round( s ) );
471 }
473 /**
474 * Clear the file upload preview area.
475 */
476 function clearPreview() {
477 $( '#mw-upload-thumbnail' ).remove();
478 }
480 /**
481 * Check if the file does not exceed the maximum size
482 */
483 function checkMaxUploadSize( file ) {
484 var maxSize, $error;
486 function getMaxUploadSize( type ) {
487 var sizes = mw.config.get( 'wgMaxUploadSize' );
489 if ( sizes[type] !== undefined ) {
490 return sizes[type];
491 }
492 return sizes['*'];
493 }
495 $( '.mw-upload-source-error' ).remove();
497 maxSize = getMaxUploadSize( 'file' );
498 if ( file.size > maxSize ) {
499 $error = $( '<p class="error mw-upload-source-error" id="wpSourceTypeFile-error">' +
500 mw.message( 'largefileserver', file.size, maxSize ).escaped() + '</p>' );
502 $( '#wpUploadFile' ).after( $error );
504 return false;
505 }
507 return true;
508 }
510 /* Initialization */
511 if ( hasFileAPI() ) {
512 // Update thumbnail when the file selection control is updated.
513 $( '#wpUploadFile' ).change( function () {
514 clearPreview();
515 if ( this.files && this.files.length ) {
516 // Note: would need to be updated to handle multiple files.
517 var file = this.files[0];
519 if ( !checkMaxUploadSize( file ) ) {
520 return;
521 }
523 if ( fileIsPreviewable( file ) ) {
524 showPreview( file );
525 }
526 }
527 } );
528 }
529 } );
531 // Disable all upload source fields except the selected one
532 $( function () {
533 var i, $row,
534 $rows = $( '.mw-htmlform-field-UploadSourceField' );
536 /**
537 * @param {jQuery} $currentRow
538 * @return {Function} Handler
539 * @return {jQuery.Event} return.e
540 */
541 function createHandler( $currentRow ) {
542 return function () {
543 $( '.mw-upload-source-error' ).remove();
544 if ( this.checked ) {
545 // Disable all inputs
546 $rows.find( 'input[name!="wpSourceType"]' ).prop( 'disabled', true );
547 // Re-enable the current one
548 $currentRow.find( 'input' ).prop( 'disabled', false );
549 }
550 };
551 }
553 for ( i = $rows.length; i; i-- ) {
554 $row = $rows.eq( i - 1 );
555 $row
556 .find( 'input[name="wpSourceType"]' )
557 .change( createHandler( $row ) );
558 }
559 } );
561 $( function () {
562 // Prevent losing work
563 var allowCloseWindow,
564 $uploadForm = $( '#mw-upload-form' );
566 if ( !mw.user.options.get( 'useeditwarning' ) ) {
567 // If the user doesn't want edit warnings, don't set things up.
568 return;
569 }
571 $uploadForm.data( 'origtext', $uploadForm.serialize() );
573 allowCloseWindow = mw.confirmCloseWindow( {
574 test: function () {
575 return $( '#wpUploadFile' ).get( 0 ).files.length !== 0 ||
576 $uploadForm.data( 'origtext' ) !== $uploadForm.serialize();
577 },
579 message: mw.msg( 'editwarning-warning' ),
580 namespace: 'uploadwarning'
581 } );
583 $uploadForm.submit( function () {
584 allowCloseWindow();
585 } );
586 } );
587 }( mediaWiki, jQuery ) );