nextcloud/core/js/eventsource.js

165 lines
4.1 KiB
JavaScript
Raw Normal View History

/**
* ownCloud
*
* @author Robin Appelman
* @copyright 2012 Robin Appelman icewind1991@gmail.com
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
*
* You should have received a copy of the GNU Affero General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
/**
2014-03-01 05:46:27 +04:00
* Wrapper for server side events
* (http://en.wikipedia.org/wiki/Server-sent_events)
* includes a fallback for older browsers and IE
*
2014-06-03 00:06:50 +04:00
* use server side events with caution, too many open requests can hang the
2014-03-01 05:46:27 +04:00
* server
*/
2014-07-02 23:32:55 +04:00
/* global EventSource */
/**
2014-04-21 16:42:50 +04:00
* Create a new event source
* @param {string} src
* @param {object} [data] to be send as GET
*
* @constructs OC.EventSource
*/
OC.EventSource=function(src,data){
var dataStr='';
2014-07-02 23:32:55 +04:00
var name;
var joinChar;
this.typelessListeners=[];
2014-07-02 23:32:55 +04:00
this.closed = false;
this.listeners={};
if(data){
for(name in data){
dataStr+=name+'='+encodeURIComponent(data[name])+'&';
}
}
dataStr+='requesttoken='+oc_requesttoken;
2014-07-02 23:32:55 +04:00
if(!this.useFallBack && typeof EventSource !== 'undefined'){
joinChar = '&';
2014-03-01 05:46:27 +04:00
if(src.indexOf('?') === -1) {
2012-11-16 23:28:03 +04:00
joinChar = '?';
}
2014-07-02 23:32:55 +04:00
this.source= new EventSource(src+joinChar+dataStr);
this.source.onmessage=function(e){
for(var i=0;i<this.typelessListeners.length;i++){
this.typelessListeners[i](JSON.parse(e.data));
}
}.bind(this);
}else{
2014-07-02 23:32:55 +04:00
var iframeId='oc_eventsource_iframe_'+OC.EventSource.iframeCount;
OC.EventSource.fallBackSources[OC.EventSource.iframeCount]=this;
this.iframe=$('<iframe/>');
this.iframe.attr('id',iframeId);
this.iframe.hide();
2012-11-16 23:28:03 +04:00
2014-07-02 23:32:55 +04:00
joinChar = '&';
2014-03-01 05:46:27 +04:00
if(src.indexOf('?') === -1) {
2012-11-16 23:28:03 +04:00
joinChar = '?';
}
2012-11-16 23:28:58 +04:00
this.iframe.attr('src',src+joinChar+'fallback=true&fallback_id='+OC.EventSource.iframeCount+'&'+dataStr);
$('body').append(this.iframe);
this.useFallBack=true;
2014-03-01 05:46:27 +04:00
OC.EventSource.iframeCount++;
}
//add close listener
this.listen('__internal__',function(data){
2014-07-02 23:32:55 +04:00
if(data === 'close'){
this.close();
}
}.bind(this));
2014-04-21 16:42:50 +04:00
};
OC.EventSource.fallBackSources=[];
OC.EventSource.iframeCount=0;//number of fallback iframes
OC.EventSource.fallBackCallBack=function(id,type,data){
2012-03-31 18:40:42 +04:00
OC.EventSource.fallBackSources[id].fallBackCallBack(type,data);
2014-04-21 16:42:50 +04:00
};
OC.EventSource.prototype={
typelessListeners:[],
iframe:null,
listeners:{},//only for fallback
useFallBack:false,
/**
* Fallback callback for browsers that don't have the
* native EventSource object.
*
* Calls the registered listeners.
*
* @private
* @param {String} type event type
* @param {Object} data received data
*/
fallBackCallBack:function(type,data){
2014-07-02 23:32:55 +04:00
var i;
// ignore messages that might appear after closing
if (this.closed) {
return;
}
if(type){
2014-07-02 23:32:55 +04:00
if (typeof this.listeners.done !== 'undefined') {
for(i=0;i<this.listeners[type].length;i++){
2013-02-14 15:17:14 +04:00
this.listeners[type][i](data);
}
}
}else{
2014-07-02 23:32:55 +04:00
for(i=0;i<this.typelessListeners.length;i++){
this.typelessListeners[i](data);
}
}
},
lastLength:0,//for fallback
/**
* Listen to a given type of events.
*
* @param {String} type event type
* @param {Function} callback event callback
*/
listen:function(type,callback){
if(callback && callback.call){
if(type){
if(this.useFallBack){
if(!this.listeners[type]){
this.listeners[type]=[];
}
this.listeners[type].push(callback);
}else{
this.source.addEventListener(type,function(e){
2014-07-02 23:32:55 +04:00
if (typeof e.data !== 'undefined') {
callback(JSON.parse(e.data));
} else {
callback('');
}
},false);
}
}else{
2014-07-02 23:32:55 +04:00
this.typelessListeners.push(callback);
}
}
},
/**
* Closes this event source.
*/
close:function(){
this.closed = true;
2014-07-02 23:32:55 +04:00
if (typeof this.source !== 'undefined') {
2013-02-14 15:17:14 +04:00
this.source.close();
}
}
2014-04-21 16:42:50 +04:00
};