frappe/frappe/public/js/frappe/request.js

// Copyright (c) 2013, Web Notes Technologies Pvt. Ltd. and Contributors
// MIT License. See license.txt

// My HTTP Request

frappe.provide('frappe.request');
frappe.request.url = '/';

// generic server call (call page, object)
frappe.call = function(opts) {
	var args = $.extend({}, opts.args);
	
	// cmd
	if(opts.module && opts.page) {
		args.cmd = opts.module+'.page.'+opts.page+'.'+opts.page+'.'+opts.method;
	} else if(opts.doc) {
		$.extend(args, {
			cmd: "runserverobj",
			docs: frappe.model.get_doc(opts.doc.doctype, opts.doc.name),
			method: opts.method,
			args: opts.args,
		});	
	} else if(opts.method) {
		args.cmd = opts.method;
	}
		
	// stringify args if required
	for(key in args) {
		if(args[key] && typeof args[key] != 'string') {
			args[key] = JSON.stringify(args[key]);
		}
	}

	return frappe.request.call({
		type: opts.type || "POST",
		args: args,
		success: opts.callback,
		error: opts.error,
		btn: opts.btn,
		freeze: opts.freeze,
		show_spinner: !opts.no_spinner,
		progress_bar: opts.progress_bar,
		async: opts.async
	});
}


frappe.request.call = function(opts) {
	frappe.request.prepare(opts);
	
	// all requests will be post, set _type as POST for commit
	opts.args._type = opts.type;
	
	var ajax_args = {
		url: opts.url || frappe.request.url,
		data: opts.args,
		type: 'POST',
		dataType: opts.dataType || 'json',
		statusCode: {
			404: function(xhr) {
				msgprint("Not Found");
			},
			403: function(xhr) {
				msgprint("Not Permitted");
			},
			200: function(data, xhr) {
				opts.success && opts.success(data, xhr.responseText);
			}
		},
		async: opts.async
	};
	
	frappe.last_request = ajax_args.data;
	
	if(opts.progress_bar) {
		var interval = null;
		$.extend(ajax_args, {
			xhr: function() {
				var xhr = jQuery.ajaxSettings.xhr();
				interval = setInterval(function() {
					if(xhr.readyState > 2) {
				    	var total = parseInt(xhr.getResponseHeader('Original-Length') || 0) || 
							parseInt(xhr.getResponseHeader('Content-Length'));
				    	var completed = parseInt(xhr.responseText.length);
						var percent = (100.0 / total * completed).toFixed(2);
						opts.progress_bar.css('width', (percent < 10 ? 10 : percent) + '%');
					}
				}, 50);
				frappe.last_xhr = xhr;
				return xhr;
			},
			complete: function() {
				opts.progress_bar.css('width', '100%');
				clearInterval(interval);
			}
		})
	}
	
	return $.ajax(ajax_args)
	.fail(function(xhr, textStatus) {
		opts.error && opts.error(xhr)
	})
	.always(function(data) {
		if(data.responseText) {
			data = JSON.parse(data.responseText);
		}
		frappe.request.cleanup(opts, data);
	});
}

// call execute serverside request
frappe.request.prepare = function(opts) {
	// btn indicator
	if(opts.btn) $(opts.btn).set_working();
	
	// navbar indicator
	if(opts.show_spinner) frappe.set_loading();
	
	// freeze page
	if(opts.freeze) frappe.dom.freeze();
	
	// no cmd?
	if(!opts.args.cmd) {
		console.log(opts)
		throw "Incomplete Request";
	}
}

frappe.request.cleanup = function(opts, r) {
	// stop button indicator
	if(opts.btn) $(opts.btn).done_working();
	
	// hide button indicator
	if(opts.show_spinner) frappe.done_loading();

	// un-freeze page
	if(opts.freeze) frappe.dom.unfreeze();

	// session expired? - Guest has no business here!
	if(r.session_expired || frappe.get_cookie("sid")==="Guest") { 
		if(!frappe.app.logged_out) {
			msgprint(frappe._('Session Expired. Logging you out'));
			frappe.app.logout();
		}
		return;
	}
	
	// show messages
	if(r._server_messages) {
		r._server_messages = JSON.parse(r._server_messages)
		msgprint(r._server_messages);
	}
	
	// show errors
	if(r.exc) { 
		r.exc = JSON.parse(r.exc);
		if(r.exc instanceof Array) {
			$.each(r.exc, function(i, v) {
				if(v)console.log(v);
			})
		} else {
			console.log(r.exc);
		}
	};
	
	// debug messages
	if(r._debug_messages) {
		console.log("-")
		console.log("-")
		console.log("-")
		if(opts.args) {
			console.log("<<<< arguments ");
			console.log(opts.args);
			console.log(">>>>")
		}
		$.each(JSON.parse(r._debug_messages), function(i, v) { console.log(v); });
		console.log("<<<< response");
		delete r._debug_messages;
		console.log(r);
		console.log(">>>>")
		console.log("-")
		console.log("-")
		console.log("-")
	}
	
	if(r.docs || r.docinfo) {
		r.docs = frappe.model.sync(r);
	}
	if(r.__messages) {
		$.extend(frappe._messages, r.__messages);
	}
	
	frappe.last_response = r;
}