frappe/webnotes/public/js/wn/model/sync.js

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

$.extend(wn.model, {
	docinfo: {},
	sync: function(r) {
		/* docs:
			extract doclist, docinfo (attachments, comments, assignments)
			from incoming request and set in `locals` and `wn.model.docinfo`
		*/

		if(!r.docs && !r.docinfo) r = {docs:r};

		if(r.docs) {
			var doclist = r.docs;
			if(doclist._kl)
				doclist = wn.model.expand(doclist);

			if(doclist && doclist.length)
				wn.model.clear_doclist(doclist[0].doctype, doclist[0].name)

			var last_parent_name = null;
			var dirty = [];
			$.each(doclist, function(i, d) {
				if(!d.name && d.__islocal) { // get name (local if required)
					d.name = wn.model.get_new_name(d.doctype);
					wn.provide("wn.model.docinfo." + d.doctype + "." + d.name);	
					if(!d.parenttype)
						last_parent_name = d.name;
					
					if(dirty.indexOf(d.parenttype || d.doctype)===-1) dirty.push(d.parenttype || d.doctype);
				}

				// set parent for subsequent orphans
				if(d.parenttype && !d.parent && d.__islocal) {
					d.parent = last_parent_name;
				}

				if(!locals[d.doctype])
					locals[d.doctype] = {};

				locals[d.doctype][d.name] = d;
				d.__last_sync_on = new Date();

				if(cur_frm && cur_frm.doctype==d.doctype && cur_frm.docname==d.name) {
					cur_frm.doc = d;
				}

				if(d.doctype=='DocField') wn.meta.add_field(d);
				if(d.doctype=='DocType') wn.meta.sync_messages(d);

				if(d.localname) {
					wn.model.new_names[d.localname] = d.name;
					$(document).trigger('rename', [d.doctype, d.localname, d.name]);
					delete locals[d.doctype][d.localname];
				
					// update docinfo to new dict keys
					if(i===0) {
						wn.model.docinfo[d.doctype][d.name] = wn.model.docinfo[d.doctype][d.localname];
						wn.model.docinfo[d.doctype][d.localname] = undefined;
					}
				}
			});
			
			if(cur_frm && dirty.indexOf(cur_frm.doctype)!==-1) cur_frm.dirty();

		}
		
		// set docinfo
		if(r.docinfo) {
			if(doclist) {
				var doc = doclist[0];
			} else {
				var doc = cur_frm.doc;
			}
			if(!wn.model.docinfo[doc.doctype])
				wn.model.docinfo[doc.doctype] = {};
			wn.model.docinfo[doc.doctype][doc.name] = r.docinfo;
		}
		
		return doclist;
	},
	
	expand: function(data) {
		function zip(k,v) {
			var obj = {};
			for(var i=0;i<k.length;i++) {
				obj[k[i]] = v[i];
			}
			return obj;
		}

		var l = [];
		for(var i=0;i<data._vl.length;i++) {
			l.push(zip(data._kl[data._vl[i][0]], data._vl[i]));
		}
		return l;
	},
	
	compress: function(doclist) {
		var all_keys = {}; var values = [];
		
		function get_key_list(doctype) {
			// valid standard keys
			var key_list = ['doctype', 'name', 'docstatus', 'owner', 'parent', 
				'parentfield', 'parenttype', 'idx', 'creation', 'modified', 
				'modified_by', '__islocal', '__newname', '__modified', 
				'_user_tags', '__temp', '_comments'];

			for(key in wn.meta.docfield_map[doctype]) { // all other values
				if(!in_list(key_list, key) 
					&& !in_list(wn.model.no_value_type, wn.meta.docfield_map[doctype][key].fieldtype)
					&& !wn.meta.docfield_map[doctype][key].no_column) {
						key_list[key_list.length] = key
					}
			}
			return key_list;
		}
		
		for(var i=0; i<doclist.length;i++) {
			var doc = doclist[i];
			
			// make keys
			if(!all_keys[doc.doctype]) { 
				all_keys[doc.doctype] = get_key_list(doc.doctype);
				// doctype must be first
			}
			
			var row = []
			var key_list = all_keys[doc.doctype];
			
			// make data rows
			for(var j=0;j<key_list.length;j++) {
				row.push(doc[key_list[j]]);
			}
			
			values.push(row);
		}

		return JSON.stringify({'_vl':values, '_kl':all_keys});
	}	
});

// legacy
compress_doclist = wn.model.compress;