commit/galaxy-central: 2 new changesets
2 new commits in galaxy-central: https://bitbucket.org/galaxy/galaxy-central/commits/33812bcdc523/ Changeset: 33812bcdc523 User: carlfeberhard Date: 2014-02-18 21:11:48 Summary: History panel: begin process of breaking up panel into more focused prototypes Affected #: 11 files diff -r 26e37f6af3a8a090d9d6e923fa3e90acb0e64572 -r 33812bcdc52393bf179dd501b4334be4ec4e97a7 lib/galaxy/webapps/galaxy/controllers/history.py --- a/lib/galaxy/webapps/galaxy/controllers/history.py +++ b/lib/galaxy/webapps/galaxy/controllers/history.py @@ -887,10 +887,13 @@ history_dictionary = {} hda_dictionaries = [] + user_is_owner = False try: history_to_view = self.get_history( trans, id, False ) if not history_to_view: return trans.show_error_message( "The specified history does not exist." ) + if history_to_view.user == trans.user: + user_is_owner = True # Admin users can view any history if( ( history_to_view.user != trans.user ) @@ -925,7 +928,7 @@ + 'Please contact a Galaxy administrator if the problem persists.' ) return trans.fill_template_mako( "history/view.mako", - history=history_dictionary, hdas=hda_dictionaries, + history=history_dictionary, hdas=hda_dictionaries, user_is_owner=user_is_owner, show_deleted=show_deleted, show_hidden=show_hidden, use_panels=use_panels ) @web.expose @@ -941,9 +944,8 @@ # Security check raises error if user cannot access history. self.security_check( trans, history, False, True) - # Get datasets. + # Get datasets and annotations datasets = self.get_history_datasets( trans, history ) - # Get annotations. history.annotation = self.get_item_annotation_str( trans.sa_session, history.user, history ) for dataset in datasets: dataset.annotation = self.get_item_annotation_str( trans.sa_session, history.user, dataset ) @@ -957,8 +959,9 @@ else: user_item_rating = 0 ave_item_rating, num_ratings = self.get_ave_item_rating_data( trans.sa_session, history ) - return trans.stream_template_mako( "history/display.mako", item = history, item_data = datasets, - user_item_rating = user_item_rating, ave_item_rating=ave_item_rating, num_ratings=num_ratings ) + + return trans.stream_template_mako( "history/display.mako", item=history, item_data=datasets, + user_item_rating = user_item_rating, ave_item_rating=ave_item_rating, num_ratings=num_ratings ) @web.expose @web.require_login( "share Galaxy histories" ) diff -r 26e37f6af3a8a090d9d6e923fa3e90acb0e64572 -r 33812bcdc52393bf179dd501b4334be4ec4e97a7 static/scripts/mvc/history/current-history-panel.js --- /dev/null +++ b/static/scripts/mvc/history/current-history-panel.js @@ -0,0 +1,285 @@ +define([ + "mvc/dataset/hda-edit", + "mvc/history/history-panel" +], function( hdaEdit, hpanel ){ +// ============================================================================ +/** session storage for history panel preferences (and to maintain state) + */ +var HistoryPanelPrefs = SessionStorageModel.extend({ + defaults : { + /** is the panel currently showing the search/filter controls? */ + searching : false, + /** should the tags editor be shown or hidden initially? */ + tagsEditorShown : false, + /** should the annotation editor be shown or hidden initially? */ + annotationEditorShown : false + }, + toString : function(){ + return 'HistoryPanelPrefs(' + JSON.stringify( this.toJSON() ) + ')'; + } +}); + +/** key string to store panel prefs (made accessible on class so you can access sessionStorage directly) */ +HistoryPanelPrefs.storageKey = function storageKey(){ + return ( 'history-panel' ); +}; + +/* ============================================================================= +TODO: + +============================================================================= */ +/** @class View/Controller for the user's current history model as used in the history + * panel (current right hand panel). + * @name HistoryPanel + * + * @augments Backbone.View + * @borrows LoggableMixin#logger as #logger + * @borrows LoggableMixin#log as #log + * @constructs + */ +var CurrentHistoryPanel = hpanel.HistoryPanel.extend( +/** @lends HistoryPanel.prototype */{ + + ///** logger used to record this.log messages, commonly set to console */ + //// comment this out to suppress log output + //logger : console, + + /** class to use for constructing the HDA views */ + HDAViewClass : hdaEdit.HDAEditView, + + emptyMsg : _l( "This history is empty. Click 'Get Data' on the left pane to start" ), + noneFoundMsg : _l( "No matching datasets found" ), + + // ......................................................................... SET UP + /** Set up the view, set up storage, bind listeners to HDACollection events + * @param {Object} attributes + * @config {Object} urlTemplates.hda nested object containing url templates for HDAViews + * @throws 'needs urlTemplates' if urlTemplates.history or urlTemplates.hda aren't present + * @see PersistentStorage + * @see Backbone.View#initialize + */ + initialize : function( attributes ){ + attributes = attributes || {}; + + // ---- persistent preferences + /** maintain state / preferences over page loads */ + this.preferences = new HistoryPanelPrefs( _.extend({ + id : HistoryPanelPrefs.storageKey() + }, _.pick( attributes, _.keys( HistoryPanelPrefs.prototype.defaults ) ))); + + hpanel.HistoryPanel.prototype.initialize.call( this, attributes ); + if( this.model ){ + console.debug( this.model ); + this.model.checkForUpdates(); + } + }, + + // ------------------------------------------------------------------------ loading history/hda models + /** (re-)loads the user's current history & hdas w/ details */ + loadCurrentHistory : function( attributes ){ + // implemented as a 'fresh start' or for when there is no model (intial panel render) + var panel = this; + return this.loadHistoryWithHDADetails( 'current', attributes ) + .then(function( historyData, hdaData ){ + panel.trigger( 'current-history', panel ); + }); + }, + + /** loads a history & hdas w/ details and makes them the current history */ + switchToHistory : function( historyId, attributes ){ + //console.info( 'switchToHistory:', historyId, attributes ); + var panel = this, + historyFn = function(){ + // make this current and get history data with one call + return jQuery.post( galaxy_config.root + 'api/histories/' + historyId + '/set_as_current' ); + }; + return this.loadHistoryWithHDADetails( historyId, attributes, historyFn ) + .then(function( historyData, hdaData ){ + panel.trigger( 'switched-history', panel ); + }); + }, + + /** creates a new history on the server and sets it as the user's current history */ + createNewHistory : function( attributes ){ + if( !Galaxy || !Galaxy.currUser || Galaxy.currUser.isAnonymous() ){ + this.displayMessage( 'error', _l( 'You must be logged in to create histories' ) ); + return $.when(); + } + var panel = this, + historyFn = function(){ + // get history data from posting a new history (and setting it to current) + return jQuery.post( galaxy_config.root + 'api/histories', { current: true }); + }; + // id undefined bc there is no historyId yet - the server will provide + // (no need for details - nothing expanded in new history) + return this.loadHistory( undefined, attributes, historyFn ) + .then(function( historyData, hdaData ){ + panel.trigger( 'new-history', panel ); + }); + }, + + /** release/free/shutdown old models and set up panel for new models */ + setModel : function( newHistoryJSON, newHdaJSON, attributes ){ + attributes = attributes || {}; + hpanel.HistoryPanel.prototype.setModel.call( this, newHistoryJSON, newHdaJSON, attributes ); + this.model.checkForUpdates(); + return this; + }, + + // ------------------------------------------------------------------------ history/hda event listening + /** listening for history and HDA events */ + _setUpModelEventHandlers : function(){ + hpanel.HistoryPanel.prototype._setUpModelEventHandlers.call( this ); + // ---- history + // update the quota meter when current history changes size + if( Galaxy && Galaxy.quotaMeter ){ + this.listenTo( this.model, 'change:nice_size', function(){ + //console.info( '!! model size changed:', this.model.get( 'nice_size' ) ) +//TODO: global + Galaxy.quotaMeter.update(); + }); + } + + // if an a hidden hda is created (gen. by a workflow), moves thru the updater to the ready state, + // then: remove it from the collection if the panel is set to NOT show hidden datasets + this.model.hdas.on( 'state:ready', function( hda, newState, oldState ){ + if( ( !hda.get( 'visible' ) ) + && ( !this.storage.get( 'show_hidden' ) ) ){ + this.removeHdaView( this.hdaViews[ hda.id ] ); + } + }, this ); + + }, + + // ------------------------------------------------------------------------ panel rendering + /** Render urls, historyPanel body, and hdas (if any are shown) + * @fires: rendered when the panel is attached and fully visible + * @see Backbone.View#render + */ + render : function( speed, callback ){ + // send a speed of 0 to have no fade in/out performed + speed = ( speed === undefined )?( this.fxSpeed ):( speed ); + var panel = this, + $newRender; + + // handle the possibility of no model (can occur if fetching the model returns an error) + if( this.model ){ + $newRender = this.renderModel(); + } else { + $newRender = this.renderWithoutModel(); + } + + // fade out existing, swap with the new, fade in, set up behaviours + $( panel ).queue( 'fx', [ + function( next ){ + //panel.$el.fadeTo( panel.fxSpeed, 0.0001, next ); + if( speed && panel.$el.is( ':visible' ) ){ + panel.$el.fadeOut( speed, next ); + } else { + next(); + } + }, + function( next ){ + // swap over from temp div newRender + panel.$el.empty(); + if( $newRender ){ + panel.$el.append( $newRender.children() ); + panel.renderBasedOnPrefs(); + } + next(); + }, + function( next ){ + if( speed && !panel.$el.is( ':visible' ) ){ + panel.$el.fadeIn( speed, next ); + } else { + next(); + } + }, + function( next ){ + //TODO: ideally, these would be set up before the fade in (can't because of async save text) + if( callback ){ callback.call( this ); } + panel.trigger( 'rendered', this ); + next(); + } + ]); + return this; + }, + + renderBasedOnPrefs : function(){ + if( this.preferences.get( 'searching' ) ){ + this.showSearchControls( 0 ); + } + }, + + // ........................................................................ external objects/MVC + //TODO: remove quota meter from panel and remove this + /** add listeners to an external quota meter (mvc/user/user-quotameter.js) */ + connectToQuotaMeter : function( quotaMeter ){ + if( !quotaMeter ){ + return this; + } + // show/hide the 'over quota message' in the history when the meter tells it to + this.listenTo( quotaMeter, 'quota:over', this.showQuotaMessage ); + this.listenTo( quotaMeter, 'quota:under', this.hideQuotaMessage ); + + // having to add this to handle re-render of hview while overquota (the above do not fire) + this.on( 'rendered rendered:initial', function(){ + if( quotaMeter && quotaMeter.isOverQuota() ){ + this.showQuotaMessage(); + } + }); + return this; + }, + +//TODO: this seems more like a per user message than a history message; IOW, this doesn't belong here + /** Show the over quota message (which happens to be in the history panel). + */ + showQuotaMessage : function(){ + var msg = this.$el.find( '.quota-message' ); + //this.log( this + ' showing quota message:', msg, userData ); + if( msg.is( ':hidden' ) ){ msg.slideDown( this.fxSpeed ); } + }, + +//TODO: this seems more like a per user message than a history message + /** Hide the over quota message (which happens to be in the history panel). + */ + hideQuotaMessage : function(){ + var msg = this.$el.find( '.quota-message' ); + //this.log( this + ' hiding quota message:', msg, userData ); + if( !msg.is( ':hidden' ) ){ msg.slideUp( this.fxSpeed ); } + }, + +//TODO: move show_deleted/hidden into panel from opt menu and remove this + /** add listeners to an external options menu (templates/webapps/galaxy/root/index.mako) */ + connectToOptionsMenu : function( optionsMenu ){ + if( !optionsMenu ){ + return this; + } + // set a visible indication in the popupmenu for show_hidden/deleted based on the currHistoryPanel's settings + this.on( 'new-storage', function( storage, panel ){ + if( optionsMenu && storage ){ + optionsMenu.findItemByHtml( _l( 'Include Deleted Datasets' ) ).checked = storage.get( 'show_deleted' ); + optionsMenu.findItemByHtml( _l( 'Include Hidden Datasets' ) ).checked = storage.get( 'show_hidden' ); + } + }); + return this; + }, + + /** Return a string rep of the history + */ + toString : function(){ + return 'CurrentHistoryPanel(' + (( this.model )?( this.model.get( 'name' )):( '' )) + ')'; + } +}); + +//------------------------------------------------------------------------------ TEMPLATES +CurrentHistoryPanel.templates = { + historyPanel : Handlebars.templates[ 'template-history-historyPanel' ], + anonHistoryPanel : Handlebars.templates[ 'template-history-historyPanel-anon' ] +}; + +//============================================================================== + return { + CurrentHistoryPanel : CurrentHistoryPanel + }; +}); diff -r 26e37f6af3a8a090d9d6e923fa3e90acb0e64572 -r 33812bcdc52393bf179dd501b4334be4ec4e97a7 static/scripts/mvc/history/history-model.js --- a/static/scripts/mvc/history/history-model.js +++ b/static/scripts/mvc/history/history-model.js @@ -75,7 +75,7 @@ /** cached timeout id for the HDA updater */ this.updateTimeoutId = null; // set up update timeout if needed - this.checkForUpdates(); + //this.checkForUpdates(); }, /** set up any event listeners for this history including those to the contained HDAs diff -r 26e37f6af3a8a090d9d6e923fa3e90acb0e64572 -r 33812bcdc52393bf179dd501b4334be4ec4e97a7 static/scripts/mvc/history/history-panel.js --- a/static/scripts/mvc/history/history-panel.js +++ b/static/scripts/mvc/history/history-panel.js @@ -1,157 +1,46 @@ define([ - "mvc/history/history-model", "mvc/dataset/hda-model", - "mvc/dataset/hda-base", - "mvc/dataset/hda-edit" -], function( historyModel, hdaModel, hdaBase, hdaEdit ){ + "mvc/dataset/hda-edit", + "mvc/history/readonly-history-panel" +], function( hdaModel, hdaEdit, readonlyPanel ){ +/* ============================================================================= +TODO: - -// ============================================================================ -/** session storage for history panel preferences (and to maintain state) - */ -var HistoryPanelPrefs = SessionStorageModel.extend({ - defaults : { - /** is the panel currently showing the search/filter controls? */ - searching : false, - /** should the tags editor be shown or hidden initially? */ - tagsEditorShown : false, - /** should the annotation editor be shown or hidden initially? */ - annotationEditorShown : false - }, - toString : function(){ - return 'HistoryPanelPrefs(' + JSON.stringify( this.toJSON() ) + ')'; - } -}); - -/** key string to store panel prefs (made accessible on class so you can access sessionStorage directly) */ -HistoryPanelPrefs.storageKey = function storageKey(){ - return ( 'history-panel' ); -}; - - -// ============================================================================ -/** session storage for individual history preferences - */ -var HistoryPrefs = SessionStorageModel.extend({ - defaults : { - //TODO:?? expandedHdas to array? - expandedHdas : {}, - //TODO:?? move to user? - show_deleted : false, - show_hidden : false - //TODO: add scroll position? - }, - /** add an hda id to the hash of expanded hdas */ - addExpandedHda : function( id ){ - this.save( 'expandedHdas', _.extend( this.get( 'expandedHdas' ), _.object([ id ], [ true ]) ) ); - }, - /** remove an hda id from the hash of expanded hdas */ - removeExpandedHda : function( id ){ - this.save( 'expandedHdas', _.omit( this.get( 'expandedHdas' ), id ) ); - }, - toString : function(){ - return 'HistoryPrefs(' + this.id + ')'; - } -}); - -/** key string to store each histories settings under */ -HistoryPrefs.historyStorageKey = function historyStorageKey( historyId ){ - // class lvl for access w/o instantiation - if( !historyId ){ - throw new Error( 'HistoryPrefs.historyStorageKey needs valid id: ' + historyId ); - } - // single point of change - return ( 'history:' + historyId ); -}; - - -/* ============================================================================= -Backbone.js implementation of history panel - -r.js optimizer cline: -r.js -o baseUrl=. name=./mvc/history/history-panel.js out=history-panel.min.js - -TODO: - tags & annotations -> out - use model.save instead of urls - - feature creep: - lineage - hide button - show permissions in info - show shared/sharing status on ds, history - selection, multi-select (and actions common to selected (ugh)) - searching - sorting, re-shuffling - ============================================================================= */ -/** @class View/Controller for the history model as used in the history - * panel (current right hand panel). +/** @class View/Controller for the history model. * @name HistoryPanel * + * Allows: + * (everything ReadOnlyHistoryPanel allows) + * changing the name + * displaying and editing tags and annotations + * multi-selection and operations on mulitple hdas + * Does not allow: + * changing the name + * * @augments Backbone.View * @borrows LoggableMixin#logger as #logger * @borrows LoggableMixin#log as #log * @constructs */ -var HistoryPanel = Backbone.View.extend( LoggableMixin ).extend( +var HistoryPanel = readonlyPanel.ReadOnlyHistoryPanel.extend( /** @lends HistoryPanel.prototype */{ - + ///** logger used to record this.log messages, commonly set to console */ //// comment this out to suppress log output //logger : console, - /** which class to use for constructing the HDA views */ - //defaultHDAViewClass : hdaBase.HDABaseView, - defaultHDAViewClass : hdaEdit.HDAEditView, + /** class to use for constructing the HDA views */ + HDAViewClass : hdaEdit.HDAEditView, - tagName : 'div', - className : 'history-panel', - - /** (in ms) that jquery effects will use */ - fxSpeed : 'fast', - - datasetsSelector : '.datasets-list', - emptyMsgSelector : '.empty-history-message', - msgsSelector : '.message-container', - // ......................................................................... SET UP /** Set up the view, set up storage, bind listeners to HDACollection events * @param {Object} attributes - * @config {Object} urlTemplates.hda nested object containing url templates for HDAViews - * @throws 'needs urlTemplates' if urlTemplates.history or urlTemplates.hda aren't present - * @see PersistentStorage - * @see Backbone.View#initialize */ initialize : function( attributes ){ attributes = attributes || {}; - // set the logger if requested - if( attributes.logger ){ - this.logger = attributes.logger; - } - this.log( this + '.initialize:', attributes ); // ---- set up instance vars - // control contents/behavior based on where (and in what context) the panel is being used - /** which backbone view class to use when displaying the hda list */ - this.HDAViewClass = attributes.HDAViewClass || this.defaultHDAViewClass; - /** where should pages from links be displayed? (default to new tab/window) */ - this.linkTarget = attributes.linkTarget || '_blank'; - - // ---- sub views and saved elements - /** map of hda model ids to hda views */ - this.hdaViews = {}; - /** loading indicator */ - this.indicator = new LoadingIndicator( this.$el ); - - // ---- persistent state and preferences - /** maintain state / preferences over page loads */ - this.preferences = new HistoryPanelPrefs( _.extend({ - id : HistoryPanelPrefs.storageKey() - }, _.pick( attributes, _.keys( HistoryPanelPrefs.prototype.defaults ) ))); - - /** filters for displaying hdas */ - this.filters = []; /** selected hda ids */ this.selectedHdaIds = []; @@ -161,443 +50,33 @@ this.annotationEditorShown = attributes.annotationEditorShown || false; this.tagsEditorShown = attributes.tagsEditorShown || false; - this._setUpListeners(); - - // ---- handle models passed on init - if( this.model ){ - this._setUpWebStorage( attributes.initiallyExpanded, attributes.show_deleted, attributes.show_hidden ); - this._setUpModelEventHandlers(); - } -//TODO: remove? - // ---- and any run functions - if( attributes.onready ){ - attributes.onready.call( this ); - } + readonlyPanel.ReadOnlyHistoryPanel.prototype.initialize.call( this, attributes ); }, - /** create any event listeners for the panel - * @fires: rendered:initial on the first render - * @fires: empty-history when switching to a history with no HDAs or creating a new history - */ - _setUpListeners : function(){ - // ---- event handlers for self - this.on( 'error', function( model, xhr, options, msg, details ){ - this.errorHandler( model, xhr, options, msg, details ); - }); - - this.on( 'loading-history', function(){ - // show the loading indicator when loading a new history starts... - this.showLoadingIndicator( 'loading history...', 40 ); - }); - this.on( 'loading-done', function(){ - // ...hiding it again when loading is done (or there's been an error) - this.hideLoadingIndicator( 40 ); - }); - - // throw the first render up as a diff namespace using once - // (for outside consumption) - this.once( 'rendered', function(){ - this.trigger( 'rendered:initial', this ); - return false; - }); - - // trigger an event when there are no visible hdas - // (for outside consumption) - this.on( 'switched-history current-history new-history', function(){ - if( _.isEmpty( this.hdaViews ) ){ - this.trigger( 'empty-history', this ); - } - }); - - // debugging - if( this.logger ){ - this.on( 'all', function( event ){ - this.log( this + '', arguments ); - }, this ); - } - }, - - //TODO: see base-mvc - //onFree : function(){ - // _.each( this.hdaViews, function( view, modelId ){ - // view.free(); - // }); - // this.hdaViews = null; - //}, - - // ........................................................................ error handling - /** Event listener to handle errors (from the panel, the history, or the history's HDAs) - * @param {Model or View} model the (Backbone) source of the error - * @param {XMLHTTPRequest} xhr any ajax obj. assoc. with the error - * @param {Object} options the options map commonly used with bbone ajax - * @param {String} msg optional message passed to ease error location - * @param {Object} msg optional object containing error details - */ - errorHandler : function( model, xhr, options, msg, details ){ - var parsed = this._parseErrorMessage( model, xhr, options, msg, details ); - - // interrupted ajax - if( xhr && xhr.status === 0 && xhr.readyState === 0 ){ - - // bad gateway - } else if( xhr && xhr.status === 502 ){ -//TODO: gmail style 'reconnecting in Ns' - - // otherwise, show an error message inside the panel - } else { - // it's possible to have a triggered error before the message container is rendered - wait for it to show - if( !this.$el.find( this.msgsSelector ).is( ':visible' ) ){ - this.once( 'rendered', function(){ - this.displayMessage( 'error', parsed.message, parsed.details ); - }); - } else { - this.displayMessage( 'error', parsed.message, parsed.details ); - } - } - }, - - /** Parse an error event into an Object usable by displayMessage based on the parameters - * note: see errorHandler for more info on params - */ - _parseErrorMessage : function( model, xhr, options, msg, details ){ - var user = Galaxy.currUser, - // add the args (w/ some extra info) into an obj - parsed = { - message : this._bePolite( msg ), - details : { - user : ( user instanceof User )?( user.toJSON() ):( user + '' ), - source : ( model instanceof Backbone.Model )?( model.toJSON() ):( model + '' ), - xhr : xhr, - options : ( xhr )?( _.omit( options, 'xhr' ) ):( options ) - } - }; - // add any extra details passed in - _.extend( parsed.details, details || {} ); - // fancy xhr.header parsing (--> obj) - if( xhr && _.isFunction( xhr.getAllResponseHeaders ) ){ - var responseHeaders = xhr.getAllResponseHeaders(); - responseHeaders = _.compact( responseHeaders.split( '\n' ) ); - responseHeaders = _.map( responseHeaders, function( header ){ - return header.split( ': ' ); - }); - parsed.details.xhr.responseHeaders = _.object( responseHeaders ); - } - return parsed; - }, - - /** Modify an error message to be fancy and wear a monocle. */ - _bePolite : function( msg ){ - msg = msg || _l( 'An error occurred while getting updates from the server' ); - return msg + '. ' + _l( 'Please contact a Galaxy administrator if the problem persists.' ); - }, - - // ------------------------------------------------------------------------ loading history/hda models - - //NOTE: all the following fns replace the existing history model with a new model - // (in the following 'details' refers to the full set of hda api data (urls, display_apps, misc_info, etc.) - // - hdas w/o details will have summary data only (name, hid, deleted, visible, state, etc.)) - - /** (re-)loads the user's current history & hdas w/ details */ - loadCurrentHistory : function( attributes ){ - // implemented as a 'fresh start' or for when there is no model (intial panel render) - var panel = this; - return this.loadHistoryWithHDADetails( 'current', attributes ) - .then(function( historyData, hdaData ){ - panel.trigger( 'current-history', panel ); - }); - }, - - /** loads a history & hdas w/ details and makes them the current history */ - switchToHistory : function( historyId, attributes ){ - //console.info( 'switchToHistory:', historyId, attributes ); - var panel = this, - historyFn = function(){ - // make this current and get history data with one call - return jQuery.post( galaxy_config.root + 'api/histories/' + historyId + '/set_as_current' ); - }; - return this.loadHistoryWithHDADetails( historyId, attributes, historyFn ) - .then(function( historyData, hdaData ){ - panel.trigger( 'switched-history', panel ); - }); - }, - - /** creates a new history on the server and sets it as the user's current history */ - createNewHistory : function( attributes ){ - if( !Galaxy || !Galaxy.currUser || Galaxy.currUser.isAnonymous() ){ - this.displayMessage( 'error', _l( 'You must be logged in to create histories' ) ); - return $.when(); - } - var panel = this, - historyFn = function(){ - // get history data from posting a new history (and setting it to current) - return jQuery.post( galaxy_config.root + 'api/histories', { current: true }); - }; - // id undefined bc there is no historyId yet - the server will provide - // (no need for details - nothing expanded in new history) - return this.loadHistory( undefined, attributes, historyFn ) - .then(function( historyData, hdaData ){ - panel.trigger( 'new-history', panel ); - }); - }, - - /** loads a history & hdas w/ details (but does not make them the current history) */ - loadHistoryWithHDADetails : function( historyId, attributes, historyFn, hdaFn ){ - //console.info( 'loadHistoryWithHDADetails:', historyId, attributes, historyFn, hdaFn ); - var panel = this, - // will be called to get hda ids that need details from the api - hdaDetailIds = function( historyData ){ -//TODO: non-visible HDAs are getting details loaded... either stop loading them at all or filter ids thru isVisible - return panel.getExpandedHdaIds( historyData.id ); - }; - return this.loadHistory( historyId, attributes, historyFn, hdaFn, hdaDetailIds ); - }, - - /** loads a history & hdas w/ NO details (but does not make them the current history) */ - loadHistory : function( historyId, attributes, historyFn, hdaFn, hdaDetailIds ){ - this.trigger( 'loading-history', this ); - attributes = attributes || {}; - var panel = this; - //console.info( 'loadHistory:', historyId, attributes, historyFn, hdaFn, hdaDetailIds ); - var xhr = historyModel.History.getHistoryData( historyId, { - historyFn : historyFn, - hdaFn : hdaFn, - hdaDetailIds : attributes.initiallyExpanded || hdaDetailIds - }); - return this._loadHistoryFromXHR( xhr, attributes ) - .fail( function( xhr, where, history ){ - // throw an error up for the error handler - panel.trigger( 'error', panel, xhr, attributes, _l( 'An error was encountered while ' + where ), - { historyId: historyId, history: history || {} }); - }) - .always( function(){ - // bc hideLoadingIndicator relies on this firing - panel.trigger( 'loading-done', panel ); - }); - }, - - /** given an xhr that will provide both history and hda data, pass data to set model or handle xhr errors */ - _loadHistoryFromXHR : function( xhr, attributes ){ - var panel = this; - xhr.then( function( historyJSON, hdaJSON ){ - panel.setModel( historyJSON, hdaJSON, attributes ); - }); - xhr.fail( function( xhr, where ){ - // always render - whether we get a model or not - panel.render(); - }); - return xhr; - }, - - /** release/free/shutdown old models and set up panel for new models */ - setModel : function( newHistoryJSON, newHdaJSON, attributes ){ - attributes = attributes || {}; - //console.info( 'setModel:', newHistoryJSON, newHdaJSON.length, attributes ); - - // stop/release the previous model, and clear cache to hda sub-views - if( this.model ){ - this.model.clearUpdateTimeout(); - this.stopListening( this.model ); - this.stopListening( this.model.hdas ); - //TODO: see base-mvc - //this.model.free(); - } - this.hdaViews = {}; - - // set up the new model and render - if( Galaxy && Galaxy.currUser ){ -//TODO: global - newHistoryJSON.user = Galaxy.currUser.toJSON(); - } - this.model = new historyModel.History( newHistoryJSON, newHdaJSON, attributes ); - this._setUpWebStorage( attributes.initiallyExpanded, attributes.show_deleted, attributes.show_hidden ); - this._setUpModelEventHandlers(); - this.selectedHdaIds = []; - this.trigger( 'new-model', this ); - this.render(); - return this; - }, - - // ------------------------------------------------------------------------ browser stored prefs - /** Set up client side storage. Currently PersistanStorage keyed under 'HistoryPanel.<id>' - * @param {Object} initiallyExpanded - * @param {Boolean} show_deleted whether to show deleted HDAs (overrides stored) - * @param {Boolean} show_hidden - * @see PersistentStorage - */ - _setUpWebStorage : function( initiallyExpanded, show_deleted, show_hidden ){ - //console.debug( '_setUpWebStorage', initiallyExpanded, show_deleted, show_hidden ); - this.storage = new HistoryPrefs({ - id: HistoryPrefs.historyStorageKey( this.model.get( 'id' ) ) - }); - - // expanded Hdas is a map of hda.ids -> a boolean repr'ing whether this hda's body is already expanded - // store any pre-expanded ids passed in - if( _.isObject( initiallyExpanded ) ){ - this.storage.set( 'exandedHdas', initiallyExpanded ); - } - - // get the show_deleted/hidden settings giving priority to values passed in, using web storage otherwise - // if the page has specifically requested show_deleted/hidden, these will be either true or false - // (as opposed to undefined, null) - and we give priority to that setting - if( _.isBoolean( show_deleted ) ){ - this.storage.set( 'show_deleted', show_deleted ); - } - if( _.isBoolean( show_hidden ) ){ - this.storage.set( 'show_hidden', show_hidden ); - } - - this.trigger( 'new-storage', this.storage, this ); - this.log( this + ' (init\'d) storage:', this.storage.get() ); - }, - - /** clear all stored history panel data */ - clearWebStorage : function(){ - for( var key in sessionStorage ){ - if( key.indexOf( 'history:' ) === 0 ){ - sessionStorage.removeItem( key ); - } - } - }, - - /** get all stored data as an Object for a history with the given id */ - getStoredOptions : function( historyId ){ - if( !historyId || historyId === 'current' ){ - return ( this.storage )?( this.storage.get() ):( {} ); - } - //TODO: make storage engine generic - var item = sessionStorage.getItem( HistoryPrefs.historyStorageKey( historyId ) ); - return ( item === null )?( {} ):( JSON.parse( item ) ); - }, - - /** get an array of expanded hda ids for the given history id */ - getExpandedHdaIds : function( historyId ){ - var expandedHdas = this.getStoredOptions( historyId ).expandedHdas; - return (( _.isEmpty( expandedHdas ) )?( [] ):( _.keys( expandedHdas ) )); - }, - - // ------------------------------------------------------------------------ history/hda event listening + // ------------------------------------------------------------------------ panel rendering /** listening for history and HDA events */ _setUpModelEventHandlers : function(){ - // ---- history - // on a model error - bounce it up to the panel and remove it from the model - this.model.on( 'error error:hdas', function( model, xhr, options, msg ){ - this.errorHandler( model, xhr, options, msg ); - }, this ); + readonlyPanel.ReadOnlyHistoryPanel.prototype._setUpModelEventHandlers.call( this ); - // don't need to re-render entire model on all changes, just render disk size when it changes this.model.on( 'change:nice_size', this.updateHistoryDiskSize, this ); - // update the quota meter when current history changes size - if( Galaxy && Galaxy.quotaMeter ){ - this.listenTo( this.model, 'change:nice_size', function(){ - //console.info( '!! model size changed:', this.model.get( 'nice_size' ) ) -//TODO: global - Galaxy.quotaMeter.update(); - }); - } - - // ---- hdas - // bind events from the model's hda collection - // note: don't listen to the hdas for errors, history will pass that to us - //this.model.hdas.on( 'reset', this.addAll, this ); - this.model.hdas.on( 'add', this.addHdaView, this ); - this.model.hdas.on( 'change:deleted', this.handleHdaDeletionChange, this ); this.model.hdas.on( 'change:visible', this.handleHdaVisibleChange, this ); - // when an hda is purged the disk size changes this.model.hdas.on( 'change:purged', function( hda ){ // hafta get the new nice-size w/o the purged hda this.model.fetch(); }, this ); - - // if an a hidden hda is created (gen. by a workflow), moves thru the updater to the ready state, - // then: remove it from the collection if the panel is set to NOT show hidden datasets - this.model.hdas.on( 'state:ready', function( hda, newState, oldState ){ - if( ( !hda.get( 'visible' ) ) - && ( !this.storage.get( 'show_hidden' ) ) ){ - this.removeHdaView( this.hdaViews[ hda.id ] ); - } - }, this ); - }, // ------------------------------------------------------------------------ panel rendering - /** Render urls, historyPanel body, and hdas (if any are shown) - * @fires: rendered when the panel is attached and fully visible - * @see Backbone.View#render - */ - render : function( speed, callback ){ - // send a speed of 0 to have no fade in/out performed - speed = ( speed === undefined )?( this.fxSpeed ):( speed ); - var panel = this, - $newRender; - - // handle the possibility of no model (can occur if fetching the model returns an error) - if( this.model ){ - $newRender = this.renderModel(); - } else { - $newRender = this.renderWithoutModel(); - } - - // fade out existing, swap with the new, fade in, set up behaviours - $( panel ).queue( 'fx', [ - function( next ){ - //panel.$el.fadeTo( panel.fxSpeed, 0.0001, next ); - if( speed && panel.$el.is( ':visible' ) ){ - panel.$el.fadeOut( speed, next ); - } else { - next(); - } - }, - function( next ){ - // swap over from temp div newRender - panel.$el.empty(); - if( $newRender ){ - panel.$el.append( $newRender.children() ); - panel.renderBasedOnPrefs(); - } - next(); - }, - function( next ){ - if( speed && !panel.$el.is( ':visible' ) ){ - panel.$el.fadeIn( speed, next ); - } else { - next(); - } - }, - function( next ){ - //TODO: ideally, these would be set up before the fade in (can't because of async save text) - if( callback ){ callback.call( this ); } - panel.trigger( 'rendered', this ); - next(); - } - ]); - return this; - }, - - /** render with no history data */ - renderWithoutModel : function( ){ - // we'll always need the message container - var $newRender = $( '<div/>' ), - $msgContainer = $( '<div/>' ).addClass( 'message-container' ) - .css({ 'margin-left': '4px', 'margin-right': '4px' }); - return $newRender.append( $msgContainer ); - }, - /** render with history data */ renderModel : function( ){ var $newRender = $( '<div/>' ); - // render based on anonymity, set up behaviors - if( !Galaxy || !Galaxy.currUser || Galaxy.currUser.isAnonymous() ){ - $newRender.append( HistoryPanel.templates.anonHistoryPanel( this.model.toJSON() ) ); - - } else { - $newRender.append( HistoryPanel.templates.historyPanel( this.model.toJSON() ) ); - if( Galaxy.currUser.id && Galaxy.currUser.id === this.model.get( 'user_id' ) ){ - this._renderTags( $newRender ); - this._renderAnnotation( $newRender ); - } + $newRender.append( HistoryPanel.templates.historyPanel( this.model.toJSON() ) ); + if( Galaxy.currUser.id && Galaxy.currUser.id === this.model.get( 'user_id' ) ){ + this._renderTags( $newRender ); + this._renderAnnotation( $newRender ); } // search and select available to both anon/logged-in users $newRender.find( '.history-secondary-actions' ).prepend( this._renderSelectButton() ); @@ -611,12 +90,6 @@ return $newRender; }, - renderBasedOnPrefs : function(){ - if( this.preferences.get( 'searching' ) ){ - this.showSearchControls( 0 ); - } - }, - _renderTags : function( $where ){ var panel = this; this.tagsEditor = new TagsEditor({ @@ -625,11 +98,9 @@ onshowFirstTime : function(){ this.render(); }, // show hide hda view tag editors when this is shown/hidden onshow : function(){ - panel.preferences.set( 'tagsEditorShown', true ); panel.toggleHDATagEditors( true, panel.fxSpeed ); }, onhide : function(){ - panel.preferences.set( 'tagsEditorShown', false ); panel.toggleHDATagEditors( false, panel.fxSpeed ); }, $activator : faIconButton({ @@ -638,9 +109,6 @@ faIcon : 'fa-tags' }).appendTo( $where.find( '.history-secondary-actions' ) ) }); - if( this.preferences.get( 'tagsEditorShown' ) ){ - this.tagsEditor.toggle( true ); - } }, _renderAnnotation : function( $where ){ var panel = this; @@ -650,11 +118,9 @@ onshowFirstTime : function(){ this.render(); }, // show hide hda view annotation editors when this is shown/hidden onshow : function(){ - panel.preferences.set( 'annotationEditorShown', true ); panel.toggleHDAAnnotationEditors( true, panel.fxSpeed ); }, onhide : function(){ - panel.preferences.set( 'annotationEditorShown', false ); panel.toggleHDAAnnotationEditors( false, panel.fxSpeed ); }, $activator : faIconButton({ @@ -663,18 +129,8 @@ faIcon : 'fa-comment' }).appendTo( $where.find( '.history-secondary-actions' ) ) }); - if( this.preferences.get( 'annotationEditorShown' ) ){ - this.annotationEditor.toggle( true ); - } }, - /** button for opening search */ - _renderSearchButton : function( $where ){ - return faIconButton({ - title : _l( 'Search datasets' ), - classes : 'history-search-btn', - faIcon : 'fa-search' - }); - }, + /** button for starting select mode */ _renderSelectButton : function( $where ){ return faIconButton({ @@ -762,45 +218,23 @@ }, // ------------------------------------------------------------------------ hda sub-views - /** alias to the model. Updates the hda list only (not the history) */ - refreshHdas : function( detailIds, options ){ - if( this.model ){ - return this.model.refresh( detailIds, options ); - } - // may have callbacks - so return an empty promise - return $.when(); + /** If this hda is deleted and we're not showing deleted hdas, remove the view + * @param {HistoryDataAssociation} the hda to check + */ + handleHdaDeletionChange : function( hda ){ + if( hda.get( 'deleted' ) && !this.storage.get( 'show_deleted' ) ){ + this.removeHdaView( this.hdaViews[ hda.id ] ); + } // otherwise, the hdaView rendering should handle it }, - /** Add an hda view to the panel for the given hda - * @param {HistoryDatasetAssociation} hda + + /** If this hda is hidden and we're not showing hidden hdas, remove the view + * @param {HistoryDataAssociation} the hda to check */ - addHdaView : function( hda ){ - this.log( 'add.' + this, hda ); - var panel = this; - - // don't add the view if it wouldn't be visible accrd. to current settings - if( !hda.isVisible( this.storage.get( 'show_deleted' ), this.storage.get( 'show_hidden' ) ) ){ - return; - } - - // create and prepend to current el, if it was empty fadeout the emptyMsg first - $({}).queue([ - function fadeOutEmptyMsg( next ){ - var $emptyMsg = panel.$el.find( panel.emptyMsgSelector ); - if( $emptyMsg.is( ':visible' ) ){ - $emptyMsg.fadeOut( panel.fxSpeed, next ); - } else { - next(); - } - }, - function createAndPrepend( next ){ - panel.scrollToTop(); - var $whereTo = panel.$el.find( panel.datasetsSelector ), - hdaView = panel.createHdaView( hda ); - panel.hdaViews[ hda.id ] = hdaView; - hdaView.render().$el.hide().prependTo( $whereTo ).slideDown( panel.fxSpeed ); - } - ]); + handleHdaVisibleChange : function( hda ){ + if( hda.hidden() && !this.storage.get( 'show_hidden' ) ){ + this.removeHdaView( this.hdaViews[ hda.id ] ); + } // otherwise, the hdaView rendering should handle it }, /** Create an HDA view for the given HDA (but leave attachment for addHdaView above) @@ -816,8 +250,8 @@ selectable : this.selecting, hasUser : this.model.ownedByCurrUser(), logger : this.logger, - tagsEditorShown : this.preferences.get( 'tagsEditorShown' ), - annotationEditorShown : this.preferences.get( 'annotationEditorShown' ) + tagsEditorShown : !this.tagsEditor.isHidden(), + annotationEditorShown : !this.annotationEditor.isHidden() }); this._setUpHdaListeners( hdaView ); return hdaView; @@ -829,13 +263,8 @@ */ _setUpHdaListeners : function( hdaView ){ var historyView = this; - // maintain a list of hdas whose bodies are expanded - hdaView.on( 'body-expanded', function( id ){ - historyView.storage.addExpandedHda( id ); - }); - hdaView.on( 'body-collapsed', function( id ){ - historyView.storage.removeExpandedHda( id ); - }); + readonlyPanel.ReadOnlyHistoryPanel.prototype._setUpHdaListeners.call( this, hdaView ); + // maintain a list of hdas that are selected hdaView.on( 'selected', function( hdaView ){ var id = hdaView.model.get( 'id' ); @@ -847,88 +276,6 @@ historyView.selectedHdaIds = _.without( historyView.selectedHdaIds, id ); //console.debug( 'de-selected', historyView.selectedHdaIds ); }); -//TODO: remove? - hdaView.on( 'error', function( model, xhr, options, msg ){ - historyView.errorHandler( model, xhr, options, msg ); - }); - }, - - /** If this hda is deleted and we're not showing deleted hdas, remove the view - * @param {HistoryDataAssociation} the hda to check - */ - handleHdaDeletionChange : function( hda ){ - if( hda.get( 'deleted' ) && !this.storage.get( 'show_deleted' ) ){ - this.removeHdaView( this.hdaViews[ hda.id ] ); - } // otherwise, the hdaView rendering should handle it - }, - - /** If this hda is hidden and we're not showing hidden hdas, remove the view - * @param {HistoryDataAssociation} the hda to check - */ - handleHdaVisibleChange : function( hda ){ - if( hda.hidden() && !this.storage.get( 'show_hidden' ) ){ - this.removeHdaView( this.hdaViews[ hda.id ] ); - } // otherwise, the hdaView rendering should handle it - }, - - /** Remove a view from the panel and if the panel is now empty, re-render - * @param {Int} the id of the hdaView to remove - */ - removeHdaView : function( hdaView ){ - if( !hdaView ){ return; } - - var panel = this; - hdaView.$el.fadeOut( panel.fxSpeed, function(){ - hdaView.off(); - hdaView.remove(); - delete panel.hdaViews[ hdaView.model.id ]; - if( _.isEmpty( panel.hdaViews ) ){ - panel.$el.find( panel.emptyMsgSelector ).fadeIn( panel.fxSpeed, function(){ - panel.trigger( 'empty-history', panel ); - }); - } - }); - }, - - /** Set up/render a view for each HDA to be shown, init with model and listeners. - * HDA views are cached to the map this.hdaViews (using the model.id as key). - * @param {jQuery} $whereTo what dom element to prepend the HDA views to - * @returns the number of visible hda views - */ - renderHdas : function( $whereTo ){ - $whereTo = $whereTo || this.$el; - var historyView = this, - newHdaViews = {}, - $datasetsList = $whereTo.find( this.datasetsSelector ), - // only render the shown hdas - //TODO: switch to more general filtered pattern - visibleHdas = this.model.hdas.getVisible( - this.storage.get( 'show_deleted' ), - this.storage.get( 'show_hidden' ), - this.filters - ); - //console.debug( 'renderHdas, visibleHdas:', visibleHdas, $whereTo ); - $datasetsList.empty(); - - if( visibleHdas.length ){ - visibleHdas.each( function( hda ){ - // render it (NOTE: reverse order, newest on top (prepend)) - var hdaId = hda.get( 'id' ), - hdaView = historyView.createHdaView( hda ); - newHdaViews[ hdaId ] = hdaView; - if( _.contains( historyView.selectedHdaIds, hdaId ) ){ - hdaView.selected = true; - } - $datasetsList.prepend( hdaView.render().$el ); - }); - $whereTo.find( this.emptyMsgSelector ).hide(); - - } else { - //console.debug( 'emptyMsg:', $whereTo.find( this.emptyMsgSelector ) ) - $whereTo.find( this.emptyMsgSelector ).show(); - } - this.hdaViews = newHdaViews; - return this.hdaViews; }, /** toggle the visibility of each hdaView's tagsEditor applying all the args sent to this function */ @@ -951,149 +298,41 @@ }); }, + /** Remove a view from the panel and if the panel is now empty, re-render + * @param {Int} the id of the hdaView to remove + */ + removeHdaView : function( hdaView ){ + if( !hdaView ){ return; } + + var panel = this; + hdaView.$el.fadeOut( panel.fxSpeed, function(){ + hdaView.off(); + hdaView.remove(); + delete panel.hdaViews[ hdaView.model.id ]; + if( _.isEmpty( panel.hdaViews ) ){ + panel.$el.find( panel.emptyMsgSelector ).fadeIn( panel.fxSpeed, function(){ + panel.trigger( 'empty-history', panel ); + }); + } + }); + }, + // ------------------------------------------------------------------------ panel events /** event map */ - events : { - // allow (error) messages to be clicked away - //TODO: switch to common close (X) idiom - 'click .message-container' : 'clearMessages', - - 'click .history-search-btn' : 'toggleSearchControls', + events : _.extend( _.clone( readonlyPanel.ReadOnlyHistoryPanel.prototype.events ), { 'click .history-select-btn' : function( e ){ this.toggleSelectors( this.fxSpeed ); }, - 'click .history-select-all-datasets-btn' : 'selectAllDatasets', 'click .history-deselect-all-datasets-btn' : 'deselectAllDatasets' - }, + }), /** Update the history size display (curr. upper right of panel). */ updateHistoryDiskSize : function(){ this.$el.find( '.history-size' ).text( this.model.get( 'nice_size' ) ); }, - - /** Collapse all hda bodies and clear expandedHdas in the storage - */ - collapseAllHdaBodies : function(){ - _.each( this.hdaViews, function( item ){ - item.toggleBodyVisibility( null, false ); - }); - this.storage.set( 'expandedHdas', {} ); - }, - - /** Handle the user toggling the deleted visibility by: - * (1) storing the new value in the persistent storage - * (2) re-rendering the history - * @returns {Boolean} new show_deleted setting - */ - toggleShowDeleted : function(){ - this.storage.set( 'show_deleted', !this.storage.get( 'show_deleted' ) ); - this.renderHdas(); - return this.storage.get( 'show_deleted' ); - }, - - /** Handle the user toggling the deleted visibility by: - * (1) storing the new value in the persistent storage - * (2) re-rendering the history - * @returns {Boolean} new show_hidden setting - */ - toggleShowHidden : function(){ - this.storage.set( 'show_hidden', !this.storage.get( 'show_hidden' ) ); - this.renderHdas(); - return this.storage.get( 'show_hidden' ); - }, - - // ........................................................................ filters - /** render a search input for filtering datasets shown - * (see the search section in the HDA model for implementation of the actual searching) - * return will start the search - * esc will clear the search - * clicking the clear button will clear the search - * uses searchInput in ui.js - */ - setUpSearchInput : function( $where ){ - var panel = this, - inputSelector = '.history-search-input'; - - function onSearch( searchFor ){ - //console.debug( 'onSearch', searchFor, panel ); - panel.searchFor = searchFor; - panel.filters = [ function( hda ){ return hda.matchesAll( panel.searchFor ); } ]; - panel.trigger( 'search:searching', searchFor, panel ); - panel.renderHdas(); - } - function onFirstSearch( searchFor ){ - //console.debug( 'onSearch', searchFor, panel ); - if( panel.model.hdas.haveDetails() ){ - onSearch( searchFor ); - return; - } - panel.$el.find( inputSelector ).searchInput( 'toggle-loading' ); - panel.model.hdas.fetchAllDetails({ silent: true }) - .always( function(){ - panel.$el.find( inputSelector ).searchInput( 'toggle-loading' ); - }) - .done( function(){ - onSearch( searchFor ); - }); - } - function onSearchClear(){ - //console.debug( 'onSearchClear', panel ); - panel.searchFor = ''; - panel.filters = []; - panel.trigger( 'search:clear', panel ); - panel.renderHdas(); - } - $where.searchInput({ - initialVal : panel.searchFor, - name : 'history-search', - placeholder : 'search datasets', - classes : 'history-search', - onfirstsearch : onFirstSearch, - onsearch : onSearch, - onclear : onSearchClear - }); - return $where; - }, -//TODO: to hidden/shown plugin - showSearchControls : function( speed ){ - speed = ( speed === undefined )?( this.fxSpeed ):( speed ); - var panel = this, - $searchControls = this.$el.find( '.history-search-controls' ), - $input = $searchControls.find( '.history-search-input' ); - // if it hasn't been rendered - do it now - if( !$input.children().size() ){ - this.setUpSearchInput( $input ); - //$searchControls.append( faIconButton({ - // title : _l( 'More search options' ), - // classes : 'history-search-advanced', - // faIcon : 'fa-ellipsis-horizontal' - //}) ); - } - // then slide open, focusing on the input, and persisting the setting when it's done - $searchControls.slideDown( speed, function(){ - $( this ).find( 'input' ).focus(); - panel.preferences.set( 'searching', true ); - }); - }, - hideSearchControls : function(){ - speed = ( speed === undefined )?( this.fxSpeed ):( speed ); - var panel = this; - this.$el.find( '.history-search-controls' ).slideUp( speed, function(){ - panel.preferences.set( 'searching', false ); - }); - }, - - /** toggle showing/hiding the search controls (rendering first on the initial show) */ - toggleSearchControls : function( eventOrSpeed ){ - speed = ( jQuery.type( eventOrSpeed ) === 'number' )?( eventOrSpeed ):( this.fxSpeed ); - if( this.$el.find( '.history-search-controls' ).is( ':visible' ) ){ - this.hideSearchControls( speed ); - } else { - this.showSearchControls( speed ); - } - }, // ........................................................................ multi-select of hdas + /** show selectors on all visible hdas and associated controls */ showSelectors : function( speed ){ this.selecting = true; this.$el.find( '.history-dataset-actions' ).slideDown( speed ); @@ -1103,6 +342,7 @@ this.selectedHdaIds = []; }, + /** hide selectors on all visible hdas and associated controls */ hideSelectors : function( speed ){ this.selecting = false; this.$el.find( '.history-dataset-actions' ).slideUp( speed ); @@ -1112,6 +352,7 @@ this.selectedHdaIds = []; }, + /** show or hide selectors on all visible hdas and associated controls */ toggleSelectors : function( speed ){ if( !this.selecting ){ this.showSelectors( speed ); @@ -1120,245 +361,36 @@ } }, + /** select all visible hdas */ selectAllDatasets : function( event ){ _.each( this.hdaViews, function( view ){ view.select( event ); }); }, + /** deselect all visible hdas */ deselectAllDatasets : function( event ){ _.each( this.hdaViews, function( view ){ view.deselect( event ); }); }, + /** return an array of all currently selected hdas */ getSelectedHdaViews : function(){ return _.filter( this.hdaViews, function( v ){ return v.selected; }); }, + /** return an HdaCollection of the models of all currenly selected hdas */ getSelectedHdaCollection : function(){ return new hdaModel.HDACollection( _.map( this.getSelectedHdaViews(), function( hdaView ){ return hdaView.model; }), { historyId: this.model.id }); }, - // ........................................................................ loading indicator - /** hide the panel and display a loading indicator (in the panel's parent) when history model's are switched */ - showLoadingIndicator : function( msg, speed, callback ){ - speed = ( speed !== undefined )?( speed ):( this.fxSpeed ); - if( !this.indicator ){ - this.indicator = new LoadingIndicator( this.$el, this.$el.parent() ); - } - if( !this.$el.is( ':visible' ) ){ - this.indicator.show( 0, callback ); - } else { - this.$el.fadeOut( speed ); - this.indicator.show( msg, speed, callback ); - } - }, - - /** hide the loading indicator */ - hideLoadingIndicator : function( speed, callback ){ - speed = ( speed !== undefined )?( speed ):( this.fxSpeed ); - if( this.indicator ){ - this.indicator.hide( speed, callback ); - } - }, - - // ........................................................................ (error) messages - /** Display a message in the top of the panel. - * @param {String} type type of message ('done', 'error', 'warning') - * @param {String} msg the message to display - */ - displayMessage : function( type, msg, details ){ - //precondition: msgContainer must have been rendered even if there's no model - var panel = this; - //console.debug( 'displayMessage', type, msg, details ); - - this.scrollToTop(); - var $msgContainer = this.$el.find( this.msgsSelector ), - $msg = $( '<div/>' ).addClass( type + 'message' ).html( msg ); - //console.debug( ' ', $msgContainer ); - - if( !_.isEmpty( details ) ){ - var $detailsLink = $( '<a href="javascript:void(0)">Details</a>' ) - .click( function(){ - Galaxy.modal.show( panel.messageToModalOptions( type, msg, details ) ); - return false; - }); - $msg.append( ' ', $detailsLink ); - } - return $msgContainer.html( $msg ); - }, - - /** convert msg and details into modal options usable by Galaxy.modal */ - messageToModalOptions : function( type, msg, details ){ - // only error is fleshed out here - var panel = this, - $modalBody = $( '<div/>' ), - options = { title: 'Details' }; - - //TODO: to some util library - function objToTable( obj ){ - obj = _.omit( obj, _.functions( obj ) ); - return [ - '<table>', - _.map( obj, function( val, key ){ - val = ( _.isObject( val ) )?( objToTable( val ) ):( val ); - return '<tr><td style="vertical-align: top; color: grey">' + key + '</td>' - + '<td style="padding-left: 8px">' + val + '</td></tr>'; - }).join( '' ), - '</table>' - ].join( '' ); - } - - if( _.isObject( details ) ){ - options.body = $modalBody.append( objToTable( details ) ); - - } else { - options.body = $modalBody.html( details ); - } - options.buttons = { - 'Ok': function(){ - Galaxy.modal.hide(); - panel.clearMessages(); - } - //TODO: if( type === 'error' ){ options.buttons[ 'Report this error' ] = function(){} } - }; - return options; - }, - - /** Remove all messages from the panel. - */ - clearMessages : function(){ - var $msgContainer = this.$el.find( this.msgsSelector ); - $msgContainer.empty(); - }, - - // ........................................................................ scrolling - /** get the current scroll position of the panel in its parent */ - scrollPosition : function(){ - return this.$el.parent().scrollTop(); - }, - - /** set the current scroll position of the panel in its parent */ - scrollTo : function( pos ){ - this.$el.parent().scrollTop( pos ); - }, - - /** Scrolls the panel to the top. - * @returns {HistoryPanel} the panel - */ - scrollToTop : function(){ - this.$el.parent().scrollTop( 0 ); - return this; - }, - - /** Scrolls the panel (the enclosing container - in gen., the page) so that some object - * is displayed in the vertical middle. - * NOTE: if no size is given the panel will scroll to objTop (putting it at the top). - * @param {Number} objTop the top offset of the object to view - * @param {Number} objSize the size of the object to view - * @returns {HistoryPanel} the panel - */ - scrollIntoView : function( where, size ){ - if( !size ){ - this.$el.parent().parent().scrollTop( where ); - return this; - } - // otherwise, place the object in the vertical middle - var viewport = window, - panelContainer = this.$el.parent().parent(), - containerHeight = $( viewport ).innerHeight(), - middleOffset = ( containerHeight / 2 ) - ( size / 2 ); - - $( panelContainer ).scrollTop( where - middleOffset ); - return this; - }, - - /** Scrolls the panel to show the HDA with the given id. - * @param {String} id the id of HDA to scroll into view - * @returns {HistoryPanel} the panel - */ - scrollToId : function( id ){ - // do nothing if id not found - if( ( !id ) || ( !this.hdaViews[ id ] ) ){ - return this; - } - var $viewEl = this.hdaViews[ id ].$el; - this.scrollIntoView( $viewEl.offset().top, $viewEl.outerHeight() ); - return this; - }, - - /** Scrolls the panel to show the HDA with the given hid. - * @param {Integer} hid the hid of HDA to scroll into view - * @returns {HistoryPanel} the panel - */ - scrollToHid : function( hid ){ - var hda = this.model.hdas.getByHid( hid ); - // do nothing if hid not found - if( !hda ){ return this; } - return this.scrollToId( hda.id ); - }, - - // ........................................................................ external objects/MVC - //TODO: remove quota meter from panel and remove this - /** add listeners to an external quota meter (mvc/user/user-quotameter.js) */ - connectToQuotaMeter : function( quotaMeter ){ - if( !quotaMeter ){ - return this; - } - // show/hide the 'over quota message' in the history when the meter tells it to - this.listenTo( quotaMeter, 'quota:over', this.showQuotaMessage ); - this.listenTo( quotaMeter, 'quota:under', this.hideQuotaMessage ); - - // having to add this to handle re-render of hview while overquota (the above do not fire) - this.on( 'rendered rendered:initial', function(){ - if( quotaMeter && quotaMeter.isOverQuota() ){ - this.showQuotaMessage(); - } - }); - return this; - }, - -//TODO: this seems more like a per user message than a history message; IOW, this doesn't belong here - /** Show the over quota message (which happens to be in the history panel). - */ - showQuotaMessage : function(){ - var msg = this.$el.find( '.quota-message' ); - //this.log( this + ' showing quota message:', msg, userData ); - if( msg.is( ':hidden' ) ){ msg.slideDown( this.fxSpeed ); } - }, - -//TODO: this seems more like a per user message than a history message - /** Hide the over quota message (which happens to be in the history panel). - */ - hideQuotaMessage : function(){ - var msg = this.$el.find( '.quota-message' ); - //this.log( this + ' hiding quota message:', msg, userData ); - if( !msg.is( ':hidden' ) ){ msg.slideUp( this.fxSpeed ); } - }, - -//TODO: move show_deleted/hidden into panel from opt menu and remove this - /** add listeners to an external options menu (templates/webapps/galaxy/root/index.mako) */ - connectToOptionsMenu : function( optionsMenu ){ - if( !optionsMenu ){ - return this; - } - // set a visible indication in the popupmenu for show_hidden/deleted based on the currHistoryPanel's settings - this.on( 'new-storage', function( storage, panel ){ - if( optionsMenu && storage ){ - optionsMenu.findItemByHtml( _l( 'Include Deleted Datasets' ) ).checked = storage.get( 'show_deleted' ); - optionsMenu.findItemByHtml( _l( 'Include Hidden Datasets' ) ).checked = storage.get( 'show_hidden' ); - } - }); - return this; - }, - - /** Return a string rep of the history - */ + // ........................................................................ misc + /** Return a string rep of the history */ toString : function(){ return 'HistoryPanel(' + (( this.model )?( this.model.get( 'name' )):( '' )) + ')'; } @@ -1372,6 +404,6 @@ //============================================================================== return { - HistoryPanel : HistoryPanel + HistoryPanel : HistoryPanel }; }); This diff is so big that we needed to truncate the remainder. https://bitbucket.org/galaxy/galaxy-central/commits/82d6ee82d5d4/ Changeset: 82d6ee82d5d4 User: carlfeberhard Date: 2014-02-18 21:12:31 Summary: merge Affected #: 1 file diff -r 33812bcdc52393bf179dd501b4334be4ec4e97a7 -r 82d6ee82d5d4714eefdbce041f6c983a806a58d7 templates/webapps/galaxy/mobile/history/detail.mako --- a/templates/webapps/galaxy/mobile/history/detail.mako +++ b/templates/webapps/galaxy/mobile/history/detail.mako @@ -12,7 +12,7 @@ if data.state in ['no state','',None]: data_state = "queued" else: - data_state = data.state + data_state = str( data.state ) %><li id="historyItemContainer-${data.id}"> Repository URL: https://bitbucket.org/galaxy/galaxy-central/ -- This is a commit notification from bitbucket.org. You are receiving this because you have the service enabled, addressing the recipient of this email.
participants (1)
-
commits-noreply＠bitbucket.org