oxjs/source/Ox.UI/js/Core/Ox.Request.js

220 lines
6.7 KiB
JavaScript
Raw Normal View History

2011-11-05 16:46:53 +00:00
'use strict';
2012-05-21 10:38:18 +00:00
2011-05-16 08:24:46 +00:00
/*@
Ox.Request <o> Basic request handler object
FIXME: options is not a property, just documenting defaults
options <o> Options object
timeout <n|60000> request timeout
type <s|"POST"> request type, possible values POST, GET, PUT, DELETE
url <s> request url
2011-05-16 08:24:46 +00:00
@*/
2011-04-22 22:03:10 +00:00
2011-11-30 14:49:11 +00:00
Ox.Request = (function() {
2011-04-22 22:03:10 +00:00
var cache = {},
//dfd = $.Deferred(),
$element,
2011-04-22 22:03:10 +00:00
pending = {},
requests = {},
self = {
2011-11-30 14:49:11 +00:00
options: {
2011-04-22 22:03:10 +00:00
timeout: 60000,
type: 'POST',
url: '/api/'
2011-11-30 14:49:11 +00:00
}
2011-04-22 22:03:10 +00:00
};
return {
2011-05-16 08:24:46 +00:00
/*@
cancel <f> cancel pending requests
() -> <u> cancel all requests
(fn) -> <u> cancel all requests where function returns true
(id) -> <u> cancel request by id
2011-05-16 08:24:46 +00:00
@*/
2011-04-22 22:03:10 +00:00
cancel: function() {
if (arguments.length == 0) {
// cancel all requests
requests = {};
} else if (Ox.isFunction(arguments[0])) {
// cancel with function
Ox.forEach(requests, function(req, id) {
if (arguments[0](req)) {
delete requests[id];
}
});
} else {
// cancel by id
delete requests[arguments[0]];
}
2012-01-27 14:29:11 +00:00
$element && $element.triggerEvent('request', {
requests: Ox.len(requests)
});
2011-04-22 22:03:10 +00:00
},
2011-05-16 08:24:46 +00:00
/*@
clearCache <f> clear cached results
() -> <u> ...
2011-05-16 08:24:46 +00:00
@*/
clearCache: function(query) {
if (!query) {
cache = {};
} else {
cache = Ox.filter(cache, function(val, key) {
return key.indexOf(query) == -1;
});
}
2011-04-22 22:03:10 +00:00
},
2012-01-27 14:29:11 +00:00
2012-01-14 10:48:26 +00:00
/*@
2012-01-27 14:29:11 +00:00
bindEvent <f> Unbind event
2012-01-14 10:48:26 +00:00
@*/
bindEvent: function() {
2012-01-27 14:29:11 +00:00
if (!$element) {
$element = Ox.Element();
}
$element.bindEvent.apply(this, arguments);
},
2011-04-22 22:03:10 +00:00
// fixme: remove
2011-08-06 17:41:01 +00:00
_leakCache: function() {
return cache;
},
2011-05-16 08:24:46 +00:00
/*@
options <f> get/set options
() -> <o> get options
(options) -> <o> set options
options <o> Options Object
@*/
2011-11-30 14:49:11 +00:00
options: function() {
return Ox.getset(self.options, arguments, function() {}, this);
2011-04-22 22:03:10 +00:00
},
2011-05-16 08:24:46 +00:00
/*@
requests <f> pending requests
() -> <n> returns number of requests
@*/
2011-04-22 22:03:10 +00:00
requests: function() {
return Ox.len(requests);
},
2011-05-16 08:24:46 +00:00
/*@
send <f> send request
(options) -> <n> returns request id
options <o> Options Object
age <n|-1> cache age
id <n|Ox.uid()> request id
timeout <n|self.options.timeout> overwrite default timeout
type <n|self.options.timeout> overwrite default type
url <n|self.options.timeout> overwrite default url
@*/
2011-04-22 22:03:10 +00:00
send: function(options) {
var options = Ox.extend({
2011-04-22 22:03:10 +00:00
age: -1,
callback: null,
id: Ox.uid(),
timeout: self.options.timeout,
type: self.options.type,
url: self.options.url
}, options),
req = JSON.stringify({
url: options.url,
data: options.data
});
if (pending[options.id]) {
setTimeout(function() {
Ox.Request.send(options);
}, 0);
} else {
requests[options.id] = {
url: options.url,
data: options.data
};
if (cache[req] && (
options.age == -1
|| options.age > +new Date() - cache[req].time
)) {
var data = cache[req].data;
2011-04-22 22:03:10 +00:00
setTimeout(function() {
callback && callback(data);
2011-04-22 22:03:10 +00:00
}, 0);
} else {
pending[options.id] = true;
$.ajax({
complete: complete,
2011-04-22 22:03:10 +00:00
data: options.data,
//dataType: 'json',
2011-04-22 22:03:10 +00:00
timeout: options.timeout,
type: options.type,
url: options.url
});
}
2012-01-27 14:29:11 +00:00
$element && $element.triggerEvent('request', {
requests: Ox.len(requests)
});
2011-04-22 22:03:10 +00:00
}
function callback(data) {
if (requests[options.id]) {
delete requests[options.id];
options.callback && options.callback(data);
2012-01-27 14:29:11 +00:00
$element && $element.triggerEvent('request', {
requests: Ox.len(requests)
});
}
2011-04-22 22:03:10 +00:00
}
function complete(request) {
2012-01-14 10:48:26 +00:00
var $dialog, data;
try {
data = JSON.parse(request.responseText);
2012-05-25 09:44:43 +00:00
} catch (error) {
2011-04-22 22:03:10 +00:00
try {
data = {
status: {
code: request.status,
text: request.statusText
}
};
2012-05-25 09:44:43 +00:00
} catch (error) {
data = {
status: {
code: '500',
text: 'Unknown Error'
}
};
2011-04-22 22:03:10 +00:00
}
}
2011-10-31 17:00:26 +00:00
if (data.status.code == 200 || data.status.code == 404 || data.status.code == 409) {
2011-10-31 16:02:00 +00:00
// we have to include not found and conflict
// so that handlers can handle these cases
cache[req] = {
data: data,
time: Ox.getTime()
};
2011-04-22 22:03:10 +00:00
callback(data);
} else {
2012-01-21 15:15:31 +00:00
$element && $element.triggerEvent('error', data);
2011-04-22 22:03:10 +00:00
}
pending[options.id] = false;
}
// return dfd.promise();
return options.id;
},
/*@
2012-01-27 14:29:11 +00:00
unbindEvent <f> Unbind event
@*/
2012-05-28 14:04:28 +00:00
// FIXME: Can this be removed?
unbindEvent: function() {
$element && $element.unbindEvent.apply(this, arguments);
2011-04-22 22:03:10 +00:00
}
};
2011-11-30 14:49:11 +00:00
}());