Attachment 248366 Details for Bug 449955 – File showing the problem

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

File showing the problem

status.js (text/javascript), 16.58 KB, created by Mark Macdonald

on 2014-11-04 09:38:07 EST

(hide)

Description:

Filename:

MIME Type:

Creator: Mark Macdonald

Created: 2014-11-04 09:38:07 EST

Size: 16.58 KB

patch

obsolete

>/*******************************************************************************
> * @license
> * Copyright (c) 2009, 2013 IBM Corporation and others.
> * All rights reserved. This program and the accompanying materials are made 
> * available under the terms of the Eclipse Public License v1.0 
> * (http://www.eclipse.org/legal/epl-v10.html), and the Eclipse Distribution 
> * License v1.0 (http://www.eclipse.org/org/documents/edl-v10.html). 
> *
> * Contributors: IBM Corporation - _initial API and implementation
> *******************************************************************************/
>/*eslint-env browser, amd*/
>define([
>	'i18n!orion/nls/messages',
>	'orion/webui/littlelib',
>	'orion/globalCommands',
>	'marked/marked',
>], function(messages, lib, mGlobalCommands, marked) {
>	var ProgressMonitor;
>	
>	/**
>	 * Service for reporting status
>	 * @class Service for reporting status
>	 * @name orion.status.StatusReportingService
>	 * @param {orion.serviceregistry.ServiceRegistry} serviceRegistry
>	 * @param {orion.operationclient.OperationsClient} operationsClient
>	 * @param {String} domId ID of the DOM node under which status will be displayed.
>	 * @param {String} progressDomId ID of the DOM node used to display progress messages.
>	 */
>	function StatusReportingService(serviceRegistry, operationsClient, domId, progressDomId, notificationContainerDomId) {
>		this._serviceRegistry = serviceRegistry;
>		this._serviceRegistration = serviceRegistry.registerService("orion.page.message", this); //$NON-NLS-0$
>		this._operationsClient = operationsClient;
>		this.notificationContainerDomId = notificationContainerDomId;
>		this.domId = domId;
>		this.progressDomId = progressDomId || domId;
>		this._hookedClose = false;
>		this._timer = null;
>		this._clickToDisMiss = true;
>		this._cancelMsg = null;
>	}
> 
>	StatusReportingService.prototype = /** @lends orion.status.StatusReportingService.prototype */ {
>	
>		_init: function() {
>			// this is a cheat, all dom ids should be passed in
>			var closeButton = lib.node("closeNotifications"); //$NON-NLS-0$
>			if (closeButton && !this._hookedClose) {
>				closeButton.style.cursor = "pointer"; //$NON-NLS-0$
>				this._hookedClose = true;
>				var container = lib.node(this.notificationContainerDomId);
>				lib.addAutoDismiss([container],  function(){
>					if(this._clickToDisMiss) {
>						this.close();
>					}
>				}.bind(this));
>				closeButton.addEventListener("click", function() { //$NON-NLS-0$
>					this.close();
>				}.bind(this));
>				container.addEventListener("click", function(evt) { //$NON-NLS-0$
>					if(evt && evt.target && evt.target.nodeName.toLowerCase() === "a") { //$NON-NLS-0$)
>						var anchors = lib.$$("a", container);//$NON-NLS-0$) //lib.container.getElementsByTagName("a");
>						if(anchors && anchors.length && anchors.length === 1) {// We should only auto dismiss the status bar if there is only one "a" element in the bar.
>							this.close();
>						}
>					}
>				}.bind(this));
>			}
>		},
>		
>		close: function(){
>			window.clearTimeout(this._timer);
>			var closeButton = lib.node("closeNotifications"); //$NON-NLS-0$
>			if(this._cancelMsg && this._cancelFunc && closeButton) {
>				closeButton.innerHTML = "";
>				closeButton.classList.remove("cancelButton"); //$NON-NLS-0$
>				closeButton.classList.add("dismissButton"); //$NON-NLS-0$
>				closeButton.classList.add("core-sprite-close"); //$NON-NLS-0$
>				closeButton.classList.add("imageSprite"); //$NON-NLS-0$
>				this._cancelFunc();
>				this._cancelMsg = null;
>			} else {
>				this.setProgressMessage(""); 
>			}
>		},
>		
>		_getNotifierElements: function() {
>			if (!this._notifierElements) {
>				this._notifierElements = mGlobalCommands.getToolbarElements(this.notificationContainerDomId);
>			}
>			return this._notifierElements;
>		},
>		/**
>		 * Displays a status message to the user.
>		 * @param {String} msg Message to display.
>		 * @param {Number} [timeout] Time to display the message before hiding it.
>		 * @param {Boolean} [isAccessible] If <code>true</code>, a screen reader will read this message.
>		 * Otherwise defaults to the domNode default.
>		 */
>		setMessage : function(msg, timeout, isAccessible) {
>			this._init();
>			this.currentMessage = msg;
>			var node = lib.node(this.domId);
>			if(typeof(isAccessible) === "boolean") { //$NON-NLS-0$
>				// this is kind of a hack; when there is good screen reader support for aria-busy,
>				// this should be done by toggling that instead
>				var readSetting = node.getAttribute("aria-live"); //$NON-NLS-0$
>				node.setAttribute("aria-live", isAccessible ? "polite" : "off"); //$NON-NLS-2$ //$NON-NLS-1$ //$NON-NLS-0$
>				window.setTimeout(function() {
>					if (msg === this.currentMessage) {
>						lib.empty(node);
>						node.appendChild(document.createTextNode(msg));
>						window.setTimeout(function() { node.setAttribute("aria-live", readSetting); }, 100); //$NON-NLS-0$
>					}
>				}.bind(this), 100);
>			}
>			else { 
>				lib.empty(node);
>				node.appendChild(document.createTextNode(msg));
>			}
>			if (typeof(timeout) === "number") { //$NON-NLS-0$
>				window.setTimeout(function() {
>					if (msg === this.currentMessage) {
>						lib.empty(node);
>						node.appendChild(document.createTextNode("")); //$NON-NLS-0$
>					}
>				}.bind(this), timeout);
>			}
>		},
>	
>		/**
>		 * Displays an error message to the user.
>		 *
>		 * @param {String|orionError} st The error to display. Can be a simple String,
>		 * or an error object from a  XHR error callback, or the body of an error response 
>		 * from the Orion server.
>		 */
>		setErrorMessage : function(st) {
>			this._clickToDisMiss = true;
>			this.currentMessage = st;
>			this._init();
>			//could be: responseText from xhrGet, deferred error object, or plain string
>			var status = st.responseText || st.message || st;
>			//accept either a string or a JSON representation of an IStatus
>			if (typeof status === "string") {
>				try {
>					status = JSON.parse(status);
>				} catch(error) {
>					//it is not JSON, just continue;
>				}
>			}
>			var message = status.Message || status;
>			var color = "red"; //$NON-NLS-0$
>			if (status.Severity) {
>				switch (status.Severity) {
>				case "Warning": //$NON-NLS-0$
>					color = "#FFCC00"; //$NON-NLS-0$
>					break;
>				case "Error": //$NON-NLS-0$
>					color = "red"; //$NON-NLS-0$
>					break;
>				case "Info": //$NON-NLS-0$
>				case "Ok": //$NON-NLS-0$
>					color = "green"; //$NON-NLS-0$
>					break;
>				}
>			}
>			var span = document.createElement("span");  //$NON-NLS-0$
>			span.style.color = color;
>			span.appendChild(document.createTextNode(message));
>			var node = lib.node(this.domId);
>			lib.empty(node);
>			node.appendChild(span);
>		},
>		
>		/**
>		 * Set a message that will be shown in the progress reporting area on the page.
>		 * @param {String} message The progress message to display. 
>		 */
>		setProgressMessage : function(message) {
>			this._clickToDisMiss = false;
>			this._init();
>			this.currentMessage = message;
>			var image = document.createElement("span"); //$NON-NLS-0$
>			image.classList.add("progressIcon"); //$NON-NLS-0$
>			var node = lib.node(this.progressDomId);
>			lib.empty(node);
>			node.appendChild(image);
>			node.appendChild(document.createTextNode(message));
>			var container = lib.node(this.notificationContainerDomId);
>			container.classList.remove("notificationHide"); //$NON-NLS-0$
>			if (message && message.length > 0) {
>				container.classList.add("progressNormal"); //$NON-NLS-0$
>				container.classList.add("notificationShow"); //$NON-NLS-0$
>			} else if(this._progressMonitors && this._progressMonitors.length > 0){
>				return this._renderOngoingMonitors();
>			}else{
>				container.classList.remove("notificationShow"); //$NON-NLS-0$
>				container.classList.add("notificationHide"); //$NON-NLS-0$
>			}
>		},
>		
>		/**
>		 * Set a callback function for a cancellation, which can be triggered by the close button
>		 * @param {Function} cancelFunc The callback back function for the cancellation. 
>		 */
>		setCancelFunction: function(cancelFunc) {
>			this._cancelFunc = cancelFunc;
>		},
>		
>		/**
>		 * Set a message that indicates that a long-running (progress) operation is complete.
>		 * @param {String|orionError} message The error to display. Can be a simple String,
>		 * or an error object from a XHR error callback, or the body of an error response 
>		 * from the Orion server.
>		 */
>		setProgressResult : function(message, cancelMsg) {
>			this._clickToDisMiss = false;
>			this._cancelMsg = cancelMsg;
>			this.currentMessage = message;
>			//could either be responseText from xhrGet or just a string
>			var status = message.responseText || message;
>			//accept either a string or a JSON representation of an IStatus
>			if (typeof status === "string") {
>				try {
>					status = JSON.parse(status);
>				} catch(error) {
>					//it is not JSON, just continue;
>				}
>			}
>			this._init();
>			var msg = status.Message || status.toString();
>			var fallbackMessage = messages.UnknownError;
>			var imageClass = "core-sprite-information"; //$NON-NLS-0$
>			var extraClass = "progressNormal"; //$NON-NLS-0$
>			var image = document.createElement("span"); //$NON-NLS-0$
>			image.classList.add("imageSprite"); //$NON-NLS-0$
>			image.classList.add("progressIcon"); //$NON-NLS-0$
>			var removedClasses = [];
>			if (status.Severity) {
>				switch (status.Severity) {
>				case "Warning": //$NON-NLS-0$
>					fallbackMessage = messages.UnknownWarning;
>					imageClass = "core-sprite-warning"; //$NON-NLS-0$
>					extraClass="progressWarning"; //$NON-NLS-0$
>					removedClasses.push("progressInfo");
>					removedClasses.push("progressError");
>					removedClasses.push("progressNormal"); //$NON-NLS-0$
>					this._clickToDisMiss = true;
>					break;
>				case "Error": //$NON-NLS-0$
>					imageClass = "core-sprite-error"; //$NON-NLS-0$
>					extraClass="progressError"; //$NON-NLS-0$
>					removedClasses.push("progressWarning");
>					removedClasses.push("progressInfo");
>					removedClasses.push("progressNormal"); //$NON-NLS-0$
>					this._clickToDisMiss = true;
>					break;
>				default:
>					extraClass="progressNormal"; //$NON-NLS-0$
>					removedClasses.push("progressWarning");
>					removedClasses.push("progressError");
>					removedClasses.push("progressNormal");
>				}
>			}
>			removedClasses.push("notificationHide");
>			image.classList.add(imageClass); //$NON-NLS-0$
>
>			var node = lib.node(this.progressDomId);
>			var container = lib.node(this.notificationContainerDomId);
>			lib.empty(node);
>			node.appendChild(image);
>
>			if (msg === Object.prototype.toString()) {
>				// Last ditch effort to prevent user from seeing meaningless "[object Object]" message
>				msg = fallbackMessage;
>			}
>			node.appendChild(this.createMessage(status, msg));
>
>			if (extraClass && this.progressDomId !== this.domId) {
>				container.classList.add(extraClass);
>				for (var i=0; i<removedClasses.length; i++) {
>					container.classList.remove(removedClasses[i]);
>				}
>			}
>			container.classList.add("notificationShow"); //$NON-NLS-0$
>			var closeButton = lib.node("closeNotifications"); //$NON-NLS-0$
>			if(closeButton){
>				if(this._cancelMsg) {
>					closeButton.classList.add("cancelButton"); //$NON-NLS-0$
>					closeButton.classList.remove("dismissButton"); //$NON-NLS-0$
>					closeButton.classList.remove("core-sprite-close"); //$NON-NLS-0$
>					closeButton.classList.remove("imageSprite"); //$NON-NLS-0$
>					closeButton.innerHTML = this._cancelMsg;
>				} else {
>					closeButton.innerHTML = "";
>					closeButton.classList.remove("cancelButton"); //$NON-NLS-0$
>					closeButton.classList.add("dismissButton"); //$NON-NLS-0$
>					closeButton.classList.add("core-sprite-close"); //$NON-NLS-0$
>					closeButton.classList.add("imageSprite"); //$NON-NLS-0$
>				}
>			}
>		},
>
>		/**
>		 * @param
>		 */
>		createMessage: function(status, msg) {
>			if (status.HTML) {
>				// msg is HTML to be inserted directly
>				var span = document.createElement("span"); //$NON-NLS-0$
>				span.innerHTML = msg;
>				return span;
>			}
>			// msg is text. Try parsing as Markdown
>			var markdownHtml;
>			try {
>				markdownHtml = marked(msg, {
>					sanitize: true,
>				});
>			} catch (e) {
>			}
>
>			var msgNode, links = [];
>			if (markdownHtml) {
>				msgNode = document.createElement("div"); //$NON-NLS-0$
>				msgNode.innerHTML = markdownHtml;
>				// All status links open in new window
>				links = lib.$$("a", msgNode); //$NON-NLS-0$
>				Array.prototype.forEach.call(links, function(link) { //$NON-NLS-0$
>					link.target = "_blank"; //$NON-NLS-0$
>				});
>			} else {
>				// Treat as plain text
>				msgNode = document.createTextNode(msg);
>			}
>			if (!links.length && status.Severity !== "Warning" && status.Severity !== "Error" && !this._cancelMsg) {
>				// Message has no links in it, and is not a Warning or Error severity. Therefore we consider
>				// it unimportant and will auto hide it in 5 seconds.
>				if(this._timer){
>					window.clearTimeout(this._timer);
>				}
>				this._timer = window.setTimeout(function(){
>					this.setProgressMessage("");
>					this._timer = null;
>				}.bind(this), 5000);
>			}
>			return msgNode;
>		},
>
>		/**
>		 * Shows a progress message until the given deferred is resolved.
>		 */
>		showWhile: function(deferred, message) {
>			var that = this;
>			if(message){
>				that.setProgressMessage(message);
>				var finish = function(){
>					if(message === that.currentMessage){
>						that.setProgressMessage("");		
>					}
>				};
>				deferred.then(finish, finish);
>			}
>			return deferred;
>		},
>		
>		_lastProgressId: 0,
>		_progressMonitors: {length: 0},
>		
>		/**
>		 * Creates a ProgressMonitor that will be displayed on the status area.
>		 * @param {Deferred} deferred [optional] that updates this monitor
>		 * @param {String} message [optional] messaged to be shown until deferred is not resolved
>		 * @returns {ProgressMonitor}
>		 */
>		createProgressMonitor: function(deferred, message){
>			return new ProgressMonitor(this, ++this._lastProgressId, deferred, message);
>		},
>		
>		_renderOngoingMonitors: function(){
>			if(this._progressMonitors.length > 0){
>				var msg = "";
>				var isFirst = true;
>				for(var progressMonitorId in this._progressMonitors){
>					if(this._progressMonitors[progressMonitorId].status){
>						if(!isFirst)
>							msg+=", "; //$NON-NLS-0$
>						msg+=this._progressMonitors[progressMonitorId].status;
>						isFirst = false;
>					}
>				}
>				this.setProgressMessage(msg);
>			} else {
>				this.setProgressMessage("");
>			}
>		},
>		
>		_beginProgressMonitor: function(monitor){
>			this._progressMonitors[monitor.progressId] = monitor;
>			this._progressMonitors.length++;
>			this._renderOngoingMonitors();
>		},
>		
>		_workedProgressMonitor: function(monitor){
>			this._progressMonitors[monitor.progressId] = monitor;
>			this._renderOngoingMonitors();
>		},
>		
>		_doneProgressMonitor: function(monitor){
>			delete this._progressMonitors[monitor.progressId];
>			this._progressMonitors.length--;
>			if(monitor.status){
>				this.setProgressResult(monitor.status);
>			}else{				
>				this._renderOngoingMonitors();
>			}
>		}
>		
>	};
>	StatusReportingService.prototype.constructor = StatusReportingService;
>	
>	ProgressMonitor = function(statusService, progressId, deferred, message){
>		this.statusService = statusService;
>		this.progressId = progressId;
>		if(deferred){
>			this.deferred = deferred;
>			this.begin(message);
>			var that = this;
>			deferred.then(
>					function(response, secondArg){
>						that.done.bind(that)();
>					},
>					function(error, secondArg){
>						that.done.bind(that)();
>					});
>		}
>	};
>	
>	/**
>	 * Starts the progress monitor. Message will be shown in the status area.
>	 * @param {String} message
>	 */
>	ProgressMonitor.prototype.begin = function(message){
>				this.status = message;
>				this.statusService._beginProgressMonitor(this);
>			};
>	/**
>	 * Sets the progress monitor as done. If no status is provided the message will be
>	 * removed from the status.
>	 * @param {String|orionError} status [optional] The error to display. Can be a simple String,
>	 * or an error object from a XHR error callback, or the body of an error response 
>	 * from the Orion server.
>	 */
>	ProgressMonitor.prototype.done = function(status){
>				this.status = status;
>				this.statusService._doneProgressMonitor(this);
>			};
>	/**
>	 * Changes the message in the monitor.
>	 * @param {String} message
>	 */
>	ProgressMonitor.prototype.worked = function(message){
>				this.status = message;
>				this.statusService._workedProgressMonitor(this);
>			};
>	
>	ProgressMonitor.prototype.constructor = ProgressMonitor;
>
>	//return module exports
>	return {StatusReportingService: StatusReportingService,
>			ProgressMonitor: ProgressMonitor};
>});

Actions: View

Attachments on bug 449955: 248366 | 248367