jenkins-bot has submitted this change and it was merged.
Change subject: Replace Firefogg callbacks with OOJS events
......................................................................
Replace Firefogg callbacks with OOJS events
Cleaner, yay!
Bug: T77124
Change-Id: I7f8bf7f628862f7462e2599bf9e70d78bd97441e
---
M UploadWizardHooks.php
M resources/mw.FirefoggHandler.js
M resources/mw.FirefoggTransport.js
3 files changed, 189 insertions(+), 184 deletions(-)
Approvals:
Gilles: Looks good to me, approved
jenkins-bot: Verified
diff --git a/UploadWizardHooks.php b/UploadWizardHooks.php
index 1663fc3..3d7154d 100644
--- a/UploadWizardHooks.php
+++ b/UploadWizardHooks.php
@@ -56,6 +56,8 @@
'uw.controller.Tutorial',
'uw.controller.Upload',
'uw.model.Description',
+
+ 'oojs',
),
'scripts' => array(
// jquery interface helpers
diff --git a/resources/mw.FirefoggHandler.js b/resources/mw.FirefoggHandler.js
index b03a202..550f6d7 100644
--- a/resources/mw.FirefoggHandler.js
+++ b/resources/mw.FirefoggHandler.js
@@ -26,19 +26,16 @@
if ( !this.transport ) {
this.transport = new mw.FirefoggTransport(
- this.upload,
- this.api,
- this.getFogg(),
- function ( data ) {
-
upload.setTransportProgress( data.progress );
- // also update preview
video, url is in data.preview
- },
-
- function ( result ) {
- mw.log(
'FirefoggTransport::getTransport> Transport done ' + JSON.stringify( result ) );
- upload.setTransported(
result );
- }
- );
+ this.upload,
+ this.api,
+ this.getFogg()
+ ).on( 'progress', function ( data ) {
+ upload.setTransportProgress(
data.progress );
+ // also update preview video, url is in
data.preview
+ } ).on( 'transported', function ( result ) {
+ mw.log(
'FirefoggTransport::getTransport> Transport done ' + JSON.stringify( result ) );
+ upload.setTransported( result );
+ } );
}
return this.transport;
},
diff --git a/resources/mw.FirefoggTransport.js
b/resources/mw.FirefoggTransport.js
index fa39aa4..ee17265 100644
--- a/resources/mw.FirefoggTransport.js
+++ b/resources/mw.FirefoggTransport.js
@@ -1,186 +1,192 @@
-( function ( mw, $ ) {
+( function ( mw, $, oo ) {
+ var FTP;
+
/**
- * Represents a "transport" for files to upload; in this case an
firefogg.
- *
- * @param upload UploadInterface
- * @param api
- * @param fogg Firefogg instance
- * @param progressCb callback to execute as the upload progresses
- * @param transportedCb callback to execute when we've finished the
upload
+ * Represents a "transport" for files to upload; in this case using
Firefogg.
+ * @class mw.FirefoggTransport
+ * @mixins OO.EventEmitter
+ * @constructor
+ * @param {mw.UploadWizardUpload} upload
+ * @param {mw.Api} api
+ * @param {Firefogg} fogg Firefogg instance
*/
- mw.FirefoggTransport = function ( upload, api, fogg, progressCb,
transportedCb ) {
+ mw.FirefoggTransport = function ( upload, api, fogg ) {
+ oo.EventEmitter.call( this );
+
this.upload = upload;
this.api = api;
this.fogg = fogg;
- this.progressCb = progressCb;
- this.transportedCb = transportedCb;
};
- mw.FirefoggTransport.prototype = {
+ oo.mixinClass( mw.FirefoggTransport, oo.EventEmitter );
- /**
- * Do an upload
- */
- doUpload: function () {
- var fileToUpload, transport = this;
+ FTP = mw.FirefoggTransport.prototype;
- //Encode or passthrough Firefogg before upload
- if ( this.isUploadFormat() ) {
- if ( this.upload.ui.$fileInputCtrl[0].files &&
this.upload.ui.$fileInputCtrl[0].files.length ) {
- fileToUpload =
this.upload.ui.$fileInputCtrl[0].files[0];
- } else if ( this.upload.file ) {
- fileToUpload = this.upload.file;
- } else if ( this.upload.providedFile ) {
- fileToUpload = this.upload.providedFile;
- } else {
- mw.log.warn( 'Firefogg tried to upload
a file but was unable to find one.' );
- return false;
- }
+ /**
+ * Do an upload
+ */
+ FTP.doUpload = function () {
+ var fileToUpload, transport = this;
- this.doFormDataUpload( fileToUpload );
+ //Encode or passthrough Firefogg before upload
+ if ( this.isUploadFormat() ) {
+ if ( this.upload.ui.$fileInputCtrl[0].files &&
this.upload.ui.$fileInputCtrl[0].files.length ) {
+ fileToUpload =
this.upload.ui.$fileInputCtrl[0].files[0];
+ } else if ( this.upload.file ) {
+ fileToUpload = this.upload.file;
+ } else if ( this.upload.providedFile ) {
+ fileToUpload = this.upload.providedFile;
} else {
- this.upload.ui.setStatus( 'mwe-upwiz-encoding'
);
- this.fogg.encode( JSON.stringify(
this.getEncodeSettings() ),
- function (result, file) {
- result = JSON.parse(result);
- if ( result.progress === 1 ) {
- //encoding done
-
transport.doFormDataUpload(file);
- } else {
- //encoding failed
- var response = {
- error: {
- code:
500,
- info:
'Encoding failed'
- }
- };
-
transport.transportedCb( response );
- }
- }, function (progress) { //progress
- if ( transport.upload.state ===
'aborted' ) {
- transport.fogg.cancel();
- } else {
- progress =
JSON.parse(progress);
- transport.progressCb(
progress );
-
transport.upload.ui.setStatus( 'mwe-upwiz-encoding' );
- }
+ mw.log.warn( 'Firefogg tried to upload a file
but was unable to find one.' );
+ return false;
+ }
+
+ this.doFormDataUpload( fileToUpload );
+ } else {
+ this.upload.ui.setStatus( 'mwe-upwiz-encoding' );
+ this.fogg.encode( JSON.stringify(
this.getEncodeSettings() ),
+ function (result, file) {
+ result = JSON.parse(result);
+ if ( result.progress === 1 ) {
+ //encoding done
+
transport.doFormDataUpload(file);
+ } else {
+ //encoding failed
+ var response = {
+ error: {
+ code: 500,
+ info: 'Encoding
failed'
+ }
+ };
+
+ transport.emit( 'transported',
response );
}
- );
- }
- },
-
- doFormDataUpload: function (file) {
- this.upload.ui.setStatus( 'mwe-upwiz-uploading' );
- this.upload.file = file;
- this.uploadHandler = new mw.ApiUploadFormDataHandler(
this.upload, this.api );
- this.uploadHandler.start();
- },
- /**
- * Check if the asset is in a format that can be upload without
encoding.
- */
- isUploadFormat: function () {
- // Check if the server supports webm uploads:
- var wembExt = ( $.inArray( 'webm',
mw.UploadWizard.config.fileExtensions ) !== -1 );
- // Determine passthrough mode
- if ( this.isOggFormat() || ( wembExt &&
this.isWebMFormat() ) ) {
- // Already Ogg, no need to encode
- return true;
- } else if ( this.isSourceAudio() ||
this.isSourceVideo() ) {
- // OK to encode
- return false;
- } else {
- // Not audio or video, can't encode
- return true;
- }
- },
-
- // TODO these boolean functions could be compressed and/or
simplified, it looks like
- isSourceAudio: function () {
- var info = this.getSourceFileInfo();
- // never transcode images
- if ( info.contentType.indexOf( 'image/' ) !== -1 ) {
- return false;
- }
- return ( ( !info.video || info.video.length === 0 ) &&
info.audio.length > 0 ) ||
- info.contentType.indexOf( 'audio/' )
!== -1;
- },
-
- isSourceVideo: function () {
- var info = this.getSourceFileInfo();
- // never transcode images
- if ( info.contentType.indexOf( 'image/' ) !== -1 ) {
- return false;
- }
- return ( info.video && info.video.length > 0 &&
info.video[0].duration > 0.04 ) ||
- info.contentType.indexOf( 'video/' ) !== -1;
- },
-
- isOggFormat: function () {
- var contentType = this.getSourceFileInfo().contentType;
- return contentType.indexOf( 'video/ogg' ) !== -1 ||
- contentType.indexOf( 'application/ogg' ) !== -1
||
- contentType.indexOf( 'audio/ogg') !== -1;
- },
-
- isWebMFormat: function () {
- return (
this.getSourceFileInfo().contentType.indexOf('webm') !== -1 );
- },
-
- /**
- * Get the source file info for the current file selected into
this.fogg
- */
- getSourceFileInfo: function () {
- if ( !this.fogg.sourceInfo ) {
- mw.log.warn( 'No firefogg source info is
available' );
- return false;
- }
- try {
- this.sourceFileInfo = JSON.parse(
this.fogg.sourceInfo );
- } catch ( e ) {
- mw.log.warn( 'Could not parse fogg sourceInfo'
);
- return false;
- }
- return this.sourceFileInfo;
- },
-
- // Get the filename
- getFileName: function () {
- // If file is in a supported format don't change
extension
- if ( this.isUploadFormat() ) {
- return this.fogg.sourceFilename;
- } else {
- if ( this.isSourceAudio() ) {
- return
this.fogg.sourceFilename.split('.').slice(0, -1).join('.') + '.oga';
+ }, function ( progress ) { //progress
+ if ( transport.upload.state ===
'aborted' ) {
+ transport.fogg.cancel();
+ } else {
+ progress = JSON.parse(progress);
+ transport.emit( 'progress',
progress );
+ transport.upload.ui.setStatus(
'mwe-upwiz-encoding' );
+ }
}
- if ( this.isSourceVideo() ) {
- var ext = this.getEncodeExt();
- return
this.fogg.sourceFilename.split('.').slice(0, -1).join('.') + '.' + ext;
- }
- }
- },
- getEncodeExt: function () {
- var encodeSettings =
mw.UploadWizard.config.firefoggEncodeSettings;
- if ( encodeSettings.videoCodec &&
encodeSettings.videoCodec === 'vp8' ) {
- return 'webm';
- } else {
- return 'ogv';
- }
- },
-
- /**
- * Get the encode settings from configuration and the current
selected video type
- */
- getEncodeSettings: function () {
- if ( this.isUploadFormat() ) {
- return { passthrough:true };
- }
- // Get the default encode settings:
- var encodeSettings =
mw.UploadWizard.config.firefoggEncodeSettings;
- // Update the format:
- this.fogg.setFormat( ( this.getEncodeExt() === 'webm' )
? 'webm' : 'ogg' );
-
- mw.log( 'FirefoggTransport::getEncodeSettings> ' +
JSON.stringify( encodeSettings ) );
- return encodeSettings;
+ );
}
};
-}( mediaWiki, jQuery ) );
+
+ FTP.doFormDataUpload = function ( file ) {
+ this.upload.ui.setStatus( 'mwe-upwiz-uploading' );
+ this.upload.file = file;
+ this.uploadHandler = new mw.ApiUploadFormDataHandler(
this.upload, this.api );
+ this.uploadHandler.start();
+ };
+
+ /**
+ * Check if the asset is in a format that can be upload without
encoding.
+ */
+ FTP.isUploadFormat = function () {
+ // Check if the server supports webm uploads:
+ var wembExt = ( $.inArray( 'webm',
mw.UploadWizard.config.fileExtensions ) !== -1 );
+ // Determine passthrough mode
+ if ( this.isOggFormat() || ( wembExt && this.isWebMFormat() ) )
{
+ // Already Ogg, no need to encode
+ return true;
+ } else if ( this.isSourceAudio() || this.isSourceVideo() ) {
+ // OK to encode
+ return false;
+ } else {
+ // Not audio or video, can't encode
+ return true;
+ }
+ };
+
+ // TODO these boolean functions could be compressed and/or simplified,
it looks like
+ FTP.isSourceAudio = function () {
+ var info = this.getSourceFileInfo();
+ // never transcode images
+ if ( info.contentType.indexOf( 'image/' ) !== -1 ) {
+ return false;
+ }
+ return ( ( !info.video || info.video.length === 0 ) &&
info.audio.length > 0 ) ||
+ info.contentType.indexOf( 'audio/' ) !== -1;
+ };
+
+ FTP.isSourceVideo = function () {
+ var info = this.getSourceFileInfo();
+ // never transcode images
+ if ( info.contentType.indexOf( 'image/' ) !== -1 ) {
+ return false;
+ }
+ return ( info.video && info.video.length > 0 &&
info.video[0].duration > 0.04 ) ||
+ info.contentType.indexOf( 'video/' ) !== -1;
+ };
+
+ FTP.isOggFormat = function () {
+ var contentType = this.getSourceFileInfo().contentType;
+ return contentType.indexOf( 'video/ogg' ) !== -1 ||
+ contentType.indexOf( 'application/ogg' ) !== -1 ||
+ contentType.indexOf( 'audio/ogg') !== -1;
+ };
+
+ FTP.isWebMFormat = function () {
+ return ( this.getSourceFileInfo().contentType.indexOf('webm')
!== -1 );
+ };
+
+ /**
+ * Get the source file info for the current file selected into this.fogg
+ */
+ FTP.getSourceFileInfo = function () {
+ if ( !this.fogg.sourceInfo ) {
+ mw.log.warn( 'No firefogg source info is available' );
+ return false;
+ }
+ try {
+ this.sourceFileInfo = JSON.parse( this.fogg.sourceInfo
);
+ } catch ( e ) {
+ mw.log.warn( 'Could not parse fogg sourceInfo' );
+ return false;
+ }
+ return this.sourceFileInfo;
+ };
+
+ // Get the filename
+ FTP.getFileName = function () {
+ // If file is in a supported format don't change extension
+ if ( this.isUploadFormat() ) {
+ return this.fogg.sourceFilename;
+ } else {
+ if ( this.isSourceAudio() ) {
+ return
this.fogg.sourceFilename.split('.').slice(0, -1).join('.') + '.oga';
+ }
+ if ( this.isSourceVideo() ) {
+ var ext = this.getEncodeExt();
+ return
this.fogg.sourceFilename.split('.').slice(0, -1).join('.') + '.' + ext;
+ }
+ }
+ };
+
+ FTP.getEncodeExt = function () {
+ var encodeSettings =
mw.UploadWizard.config.firefoggEncodeSettings;
+ if ( encodeSettings.videoCodec && encodeSettings.videoCodec ===
'vp8' ) {
+ return 'webm';
+ } else {
+ return 'ogv';
+ }
+ };
+
+ /**
+ * Get the encode settings from configuration and the current selected
video type
+ */
+ FTP.getEncodeSettings = function () {
+ if ( this.isUploadFormat() ) {
+ return { passthrough:true };
+ }
+ // Get the default encode settings:
+ var encodeSettings =
mw.UploadWizard.config.firefoggEncodeSettings;
+ // Update the format:
+ this.fogg.setFormat( ( this.getEncodeExt() === 'webm' ) ?
'webm' : 'ogg' );
+
+ mw.log( 'FirefoggTransport::getEncodeSettings> ' +
JSON.stringify( encodeSettings ) );
+ return encodeSettings;
+ };
+}( mediaWiki, jQuery, OO ) );
--
To view, visit https://gerrit.wikimedia.org/r/178210
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I7f8bf7f628862f7462e2599bf9e70d78bd97441e
Gerrit-PatchSet: 6
Gerrit-Project: mediawiki/extensions/UploadWizard
Gerrit-Branch: master
Gerrit-Owner: MarkTraceur <[email protected]>
Gerrit-Reviewer: Gilles <[email protected]>
Gerrit-Reviewer: Krinkle <[email protected]>
Gerrit-Reviewer: MarkTraceur <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
