// Copyright (c) 2012 Web Notes Technologies Pvt Ltd (http://erpnext.com)
//
// MIT License (MIT)
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
// PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
// CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
// OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
/* Form page structure
+ this.parent (either FormContainer or Dialog)
+ this.wrapper
+ this.toolbar
+ this.form_wrapper
+ this.main
+ this.head
+ this.body
+ this.layout
+ this.sidebar
+ this.print_wrapper
+ this.head
+ this.footer
*/
wn.provide('_f');
wn.provide('wn.ui.form');
wn.ui.form.Controller = Class.extend({
init: function(opts) {
$.extend(this, opts);
this.setup && this.setup();
}
});
_f.frms = {};
_f.Frm = function(doctype, parent, in_form) {
this.docname = '';
this.doctype = doctype;
this.display = 0;
this.refresh_if_stale_for = 120;
var me = this;
this.last_view_is_edit = {};
this.opendocs = {};
this.sections = [];
this.grids = [];
this.cscript = new wn.ui.form.Controller({frm:this});
this.pformat = {};
this.fetch_dict = {};
this.parent = parent;
this.tinymce_id_list = [];
this.setup_meta(doctype);
// show in form instead of in dialog, when called using url (router.js)
this.in_form = in_form ? true : false;
// notify on rename
var me = this;
$(document).bind('rename', function(event, dt, old_name, new_name) {
if(dt==me.doctype)
me.rename_notify(dt, old_name, new_name)
});
}
_f.Frm.prototype.check_doctype_conflict = function(docname) {
var me = this;
if(this.doctype=='DocType' && docname=='DocType') {
msgprint('Allowing DocType, DocType. Be careful!')
} else if(this.doctype=='DocType') {
if (wn.views.formview[docname] || wn.pages['List/'+docname]) {
msgprint("Cannot open DocType when its instance is open")
throw 'doctype open conflict'
}
} else {
if (wn.views.formview.DocType && wn.views.formview.DocType.frm.opendocs[this.doctype]) {
msgprint("Cannot open instance when its DocType is open")
throw 'doctype open conflict'
}
}
}
_f.Frm.prototype.setup = function() {
var me = this;
this.fields = [];
this.fields_dict = {};
this.state_fieldname = wn.workflow.get_state_fieldname(this.doctype);
// wrapper
this.wrapper = this.parent;
wn.ui.make_app_page({
parent: this.wrapper,
single_column: true
});
this.appframe = this.wrapper.appframe;
this.layout_main = $(this.wrapper).find(".layout-main").get(0);
this.toolbar = new wn.ui.form.Toolbar({
frm: this,
appframe: this.appframe
});
this.frm_head = this.toolbar;
// create area for print fomrat
this.setup_print_layout();
// 2 column layout
this.setup_std_layout();
// client script must be called after "setup" - there are no fields_dict attached to the frm otherwise
this.script_manager = new wn.ui.form.ScriptManager({
frm: this
})
this.watch_model_updates();
this.footer = new wn.ui.form.Footer({
frm: this,
parent: this.layout_main
})
this.setup_done = true;
}
_f.Frm.prototype.watch_model_updates = function() {
// watch model updates
var me = this;
// on main doc
wn.model.on(me.doctype, "*", function(fieldname, value, doc) {
// set input
if(doc.name===me.docname) {
me.fields_dict[fieldname]
&& me.fields_dict[fieldname].set_input(value);
me.script_manager.trigger(fieldname, doc.doctype, doc.name);
}
})
// on table fields
$.each(wn.model.get("DocField", {fieldtype:"Table", parent: me.doctype}), function(i, df) {
wn.model.on(df.options, "*", function(fieldname, value, doc) {
if(doc.parent===me.docname) {
me.fields_dict[df.fieldname].grid.set_value(fieldname, value, doc);
me.script_manager.trigger(fieldname, doc.doctype, doc.name);
}
})
})
}
_f.Frm.prototype.setup_print_layout = function() {
var me = this;
this.print_wrapper = $('
').appendTo(this.layout_main).get(0);
//appframe.add_ripped_paper_effect(this.print_wrapper);
this.print_body = $(this.print_wrapper).find(".print-format-area").get(0);
}
_f.Frm.prototype.onhide = function() {
if(_f.cur_grid_cell) _f.cur_grid_cell.grid.cell_deselect();
}
_f.Frm.prototype.setup_std_layout = function() {
this.form_wrapper = $('').appendTo(this.layout_main).get(0);
$parent = $(this.form_wrapper);
this.head = $parent.find(".layout-appframe").get(0);
this.main = this.form_wrapper;
this.body_header = $a(this.main, 'div');
this.body = $a(this.main, 'div');
if(this.heading) {
this.page_head = new PageHeader(this.head, this);
}
// only tray
this.meta.section_style='Simple'; // always simple!
// layout
this.layout = new wn.ui.form.Layout({
parent: this.body,
doctype: this.doctype,
frm: this,
})
// state
this.states = new wn.ui.form.States({
frm: this
});
}
_f.Frm.prototype.setup_print = function() {
this.print_formats = wn.meta.get_print_formats(this.meta.name);
this.print_sel = $a(null, 'select', '', {width:'160px'});
add_sel_options(this.print_sel, this.print_formats);
this.print_sel.value = this.print_formats[0];
}
_f.Frm.prototype.print_doc = function() {
if(this.doc.docstatus==2) {
msgprint("Cannot Print Cancelled Documents.");
return;
}
_p.show_dialog(); // multiple options
}
// email the form
_f.Frm.prototype.email_doc = function(message) {
new wn.views.CommunicationComposer({
doc: this.doc,
subject: wn._(this.meta.name) + ': ' + this.docname,
recipients: this.doc.email || this.doc.email_id || this.doc.contact_email,
attach_document_print: true,
message: message,
real_name: this.doc.real_name || this.doc.contact_display || this.doc.contact_name
});
}
// email the form
_f.Frm.prototype.rename_doc = function() {
wn.model.rename_doc(this.doctype, this.docname);
}
// notify this form of renamed records
_f.Frm.prototype.rename_notify = function(dt, old, name) {
// from form
if(this.meta.istable)
return;
if(this.docname == old)
this.docname = name;
else
return;
// view_is_edit
this.last_view_is_edit[name] = this.last_view_is_edit[old];
delete this.last_view_is_edit[old];
// cleanup
if(this && this.opendocs[old]) {
// delete docfield copy
wn.meta.docfield_copy[dt][name] = wn.meta.docfield_copy[dt][old];
delete wn.meta.docfield_copy[dt][old];
}
delete this.opendocs[old];
this.opendocs[name] = true;
if(this.meta.in_dialog || !this.in_form) {
return;
}
wn.re_route[window.location.hash] = '#Form/' + encodeURIComponent(this.doctype) + '/' + encodeURIComponent(name);
wn.set_route('Form', this.doctype, name);
}
// SETUP
_f.Frm.prototype.setup_meta = function(doctype) {
this.meta = wn.model.get_doc('DocType',this.doctype);
this.perm = wn.perm.get_perm(this.doctype); // for create
if(this.meta.istable) { this.meta.in_dialog = 1 }
this.setup_print();
}
_f.Frm.prototype.set_intro = function(txt) {
wn.utils.set_intro(this, this.body, txt);
}
_f.Frm.prototype.set_footnote = function(txt) {
wn.utils.set_footnote(this, this.body, txt);
}
_f.Frm.prototype.add_custom_button = function(label, fn, icon) {
this.appframe.add_button(label, fn, icon || "icon-arrow-right", true);
}
_f.Frm.prototype.clear_custom_buttons = function() {
this.toolbar.refresh()
}
_f.Frm.prototype.add_fetch = function(link_field, src_field, tar_field) {
if(!this.fetch_dict[link_field]) {
this.fetch_dict[link_field] = {'columns':[], 'fields':[]}
}
this.fetch_dict[link_field].columns.push(src_field);
this.fetch_dict[link_field].fields.push(tar_field);
}
_f.Frm.prototype.refresh_print_layout = function() {
$ds(this.print_wrapper);
$dh(this.form_wrapper);
var me = this;
var print_callback = function(print_html) {
me.print_body.innerHTML = print_html;
}
// print head
if(cur_frm.doc.select_print_heading)
cur_frm.set_print_heading(cur_frm.doc.select_print_heading)
if(user!='Guest') {
$di(this.view_btn_wrapper);
// archive
if(cur_frm.doc.__archived) {
$dh(this.view_btn_wrapper);
}
} else {
$dh(this.view_btn_wrapper);
$dh(this.print_close_btn);
}
// create print format here
_p.build(this.$print_view_select.val(), print_callback, false, true, true);
}
_f.Frm.prototype.show_the_frm = function() {
// show the dialog
if(this.meta.in_dialog && !this.parent.dialog.display) {
if(!this.meta.istable)
this.parent.table_form = false;
this.parent.dialog.show();
}
}
_f.Frm.prototype.set_print_heading = function(txt) {
this.pformat[cur_frm.docname] = txt;
}
_f.Frm.prototype.defocus_rest = function() {
// deselect others
if(_f.cur_grid_cell) _f.cur_grid_cell.grid.cell_deselect();
}
_f.Frm.prototype.refresh_header = function() {
// set title
// main title
if(!this.meta.in_dialog || this.in_form) {
set_title(this.meta.issingle ? this.doctype : this.docname);
}
if(wn.ui.toolbar.recent)
wn.ui.toolbar.recent.add(this.doctype, this.docname, 1);
// show / hide buttons
if(this.frm_head) {
this.frm_head.refresh();
}
}
_f.Frm.prototype.check_doc_perm = function() {
// get perm
var dt = this.parent_doctype?this.parent_doctype : this.doctype;
var dn = this.parent_docname?this.parent_docname : this.docname;
this.perm = wn.perm.get_perm(dt, dn);
if(!this.perm[0][READ]) {
wn.set_route("403");
return 0;
}
return 1
}
_f.Frm.prototype.refresh = function(docname) {
// record switch
if(docname) {
if(this.docname != docname && (!this.meta.in_dialog || this.in_form) &&
!this.meta.istable)
scroll(0, 0);
this.docname = docname;
}
if(!this.meta.istable) {
cur_frm = this;
this.parent.cur_frm = this;
}
if(this.docname) { // document to show
// check permissions
if(!this.check_doc_perm()) return;
// read only (workflow)
this.read_only = wn.workflow.is_read_only(this.doctype, this.docname);
// set the doc
this.doc = wn.model.get_doc(this.doctype, this.docname);
// check if doctype is already open
if (!this.opendocs[this.docname]) {
this.check_doctype_conflict(this.docname);
} else {
if(this.doc && this.doc.__last_sync_on &&
(new Date() - this.doc.__last_sync_on) > (this.refresh_if_stale_for * 1000)) {
this.reload_doc();
return;
}
}
// do setup
if(!this.setup_done) this.setup();
// load the record for the first time, if not loaded (call 'onload')
cur_frm.cscript.is_onload = false;
if(!this.opendocs[this.docname]) {
cur_frm.cscript.is_onload = true;
this.setnewdoc(this.docname);
}
// view_is_edit
if(this.doc.__islocal)
this.last_view_is_edit[this.docname] = 1; // new is view_is_edit
this.view_is_edit = this.last_view_is_edit[this.docname];
if(this.view_is_edit || (!this.view_is_edit && this.meta.istable)) {
if(this.print_wrapper) {
$dh(this.print_wrapper);
$ds(this.form_wrapper);
}
// header
if(!this.meta.istable) {
this.refresh_header();
}
// call trigger
this.script_manager.trigger("refresh");
// trigger global trigger
// to use this
$(document).trigger('form_refresh');
// fields
this.refresh_fields();
// dependent fields
this.refresh_dependency();
// call onload post render for callbacks to be fired
if(this.cscript.is_onload) {
this.script_manager.trigger("onload_post_render");
}
// focus on first input
if(this.doc.docstatus==0) {
var first = $(this.form_wrapper).find('.form-layout-row :input:first');
if(!in_list(["Date", "Datetime"], first.attr("data-fieldtype"))) {
first.focus();
}
}
} else {
this.refresh_header();
if(this.print_wrapper) {
this.refresh_print_layout();
}
}
$(cur_frm.wrapper).trigger('render_complete');
}
}
_f.Frm.prototype.refresh_field = function(fname) {
cur_frm.fields_dict[fname] && cur_frm.fields_dict[fname].refresh
&& cur_frm.fields_dict[fname].refresh();
}
_f.Frm.prototype.refresh_fields = function() {
this.layout.refresh();
// cleanup activities after refresh
this.cleanup_refresh(this);
}
_f.Frm.prototype.cleanup_refresh = function() {
var me = this;
if(me.fields_dict['amended_from']) {
if (me.doc.amended_from) {
unhide_field('amended_from');
if (me.fields_dict['amendment_date']) unhide_field('amendment_date');
} else {
hide_field('amended_from');
if (me.fields_dict['amendment_date']) hide_field('amendment_date');
}
}
if(me.fields_dict['trash_reason']) {
if(me.doc.trash_reason && me.doc.docstatus == 2) {
unhide_field('trash_reason');
} else {
hide_field('trash_reason');
}
}
if(me.meta.autoname && me.meta.autoname.substr(0,6)=='field:' && !me.doc.__islocal) {
var fn = me.meta.autoname.substr(6);
cur_frm.toggle_display(fn, false);
}
if(me.meta.autoname=="naming_series:" && !me.doc.__islocal) {
cur_frm.toggle_display("naming_series", false);
}
}
// Resolve "depends_on" and show / hide accordingly
_f.Frm.prototype.refresh_dependency = function() {
var me = this;
var doc = locals[this.doctype][this.docname];
// build dependants' dictionary
var has_dep = false;
for(fkey in me.fields) {
var f = me.fields[fkey];
f.dependencies_clear = true;
if(f.df.depends_on) {
has_dep = true;
}
}
if(!has_dep)return;
// show / hide based on values
for(var i=me.fields.length-1;i>=0;i--) {
var f = me.fields[i];
f.guardian_has_value = true;
if(f.df.depends_on) {
// evaluate guardian
var v = doc[f.df.depends_on];
if(f.df.depends_on.substr(0,5)=='eval:') {
f.guardian_has_value = eval(f.df.depends_on.substr(5));
} else if(f.df.depends_on.substr(0,3)=='fn:') {
f.guardian_has_value = me.script_manager.trigger(f.df.depends_on.substr(3), me.doctype, me.docname);
} else {
if(!v) {
f.guardian_has_value = false;
}
}
// show / hide
if(f.guardian_has_value) {
f.df.hidden = 0;
f.refresh();
} else {
f.df.hidden = 1;
f.refresh();
}
}
}
}
// setnewdoc is called when a record is loaded for the first time
// ======================================================================================
_f.Frm.prototype.setnewdoc = function(docname) {
// moved this call to refresh function
// this.check_doctype_conflict(docname);
// if loaded
if(this.opendocs[docname]) { // already exists
this.docname=docname;
return;
}
// make a copy of the doctype for client script settings
// each record will have its own client script
wn.meta.make_docfield_copy_for(this.doctype,docname);
this.docname = docname;
var me = this;
var viewname = this.meta.issingle ? this.doctype : docname;
// Client Script
this.script_manager.trigger("onload");
this.last_view_is_edit[docname] = 1;
if(cint(this.meta.read_only_onload)) this.last_view_is_edit[docname] = 0;
this.opendocs[docname] = true;
}
_f.Frm.prototype.edit_doc = function() {
// set fields
this.last_view_is_edit[this.docname] = true;
this.refresh();
}
_f.Frm.prototype.show_doc = function(dn) {
this.refresh(dn);
}
_f.Frm.prototype.runscript = function(scriptname, callingfield, onrefresh) {
var me = this;
if(this.docname) {
// make doc list
var doclist = wn.model.compress(make_doclist(this.doctype, this.docname));
// send to run
if(callingfield)
$(callingfield.input).set_working();
$c('runserverobj', {'docs':doclist, 'method':scriptname },
function(r, rtxt) {
// run refresh
if(onrefresh)
onrefresh(r,rtxt);
// fields
me.refresh_fields();
// dependent fields
me.refresh_dependency();
// enable button
if(callingfield)
$(callingfield.input).done_working();
}
);
}
}
_f.Frm.prototype.copy_doc = function(onload, from_amend) {
if(!this.perm[0][CREATE]) {
msgprint('You are not allowed to create '+this.meta.name);
return;
}
var dn = this.docname;
// copy parent
var newdoc = wn.model.copy_doc(this.doctype, dn, from_amend);
// do not copy attachments
if(this.meta.allow_attach && newdoc.file_list && !from_amend)
newdoc.file_list = null;
// copy chidren
var dl = make_doclist(this.doctype, dn);
// table fields dict - for no_copy check
var tf_dict = {};
for(var d in dl) {
d1 = dl[d];
// get tabel field
if(d1.parentfield && !tf_dict[d1.parentfield]) {
tf_dict[d1.parentfield] = wn.meta.get_docfield(d1.parenttype, d1.parentfield);
}
if(d1.parent==dn && cint(tf_dict[d1.parentfield].no_copy)!=1) {
var ch = wn.model.copy_doc(d1.doctype, d1.name, from_amend);
ch.parent = newdoc.name;
ch.docstatus = 0;
ch.owner = user;
ch.creation = '';
ch.modified_by = user;
ch.modified = '';
}
}
newdoc.__islocal = 1;
newdoc.docstatus = 0;
newdoc.owner = user;
newdoc.creation = '';
newdoc.modified_by = user;
newdoc.modified = '';
if(onload)onload(newdoc);
loaddoc(newdoc.doctype, newdoc.name);
}
_f.Frm.prototype.reload_doc = function() {
this.check_doctype_conflict(this.docname);
var me = this;
var onsave = function(r, rtxt) {
me.refresh();
}
if(!me.doc.__islocal) {
wn.model.remove_from_locals(me.doctype, me.docname);
wn.model.with_doc(me.doctype, me.docname, function() {
me.refresh();
})
}
}
var validated;
_f.Frm.prototype.save = function(save_action, callback, btn, on_error) {
$(document.activeElement).blur();
var me = this;
if((!this.meta.in_dialog || this.in_form) && !this.meta.istable)
scroll(0, 0);
// validate
if(save_action!="Cancel") {
validated = true;
this.script_manager.trigger("validate");
if(!validated) {
if(on_error)
on_error();
return;
}
}
var doclist = new wn.model.DocList(this.doctype, this.docname);
doclist.save(save_action || "Save", function(r) {
if(!r.exc) {
me.refresh();
} else {
if(on_error)
on_error();
}
callback && callback(r);
}, btn);
}
_f.Frm.prototype.savesubmit = function(btn, on_error) {
var me = this;
wn.confirm("Permanently Submit "+this.docname+"?", function() {
me.save('Submit', function(r) {
if(!r.exc) {
me.script_manager.trigger("on_submit");
}
}, btn, on_error);
});
}
_f.Frm.prototype.savecancel = function(btn, on_error) {
var me = this;
wn.confirm("Permanently Cancel "+this.docname+"?", function() {
validated = true;
me.script_manager.trigger("before_cancel");
if(!validated) {
if(on_error)
on_error();
return;
}
var doclist = new wn.model.DocList(me.doctype, me.docname);
doclist.cancel(function(r) {
if(!r.exc) {
me.refresh();
me.script_manager.trigger("after_cancel");
}
}, btn, on_error);
});
}
// delete the record
_f.Frm.prototype.savetrash = function() {
wn.model.delete_doc(this.doctype, this.docname, function(r) {
window.history.back();
})
}
_f.Frm.prototype.amend_doc = function() {
if(!this.fields_dict['amended_from']) {
alert('"amended_from" field must be present to do an amendment.');
return;
}
var me = this;
var fn = function(newdoc) {
newdoc.amended_from = me.docname;
if(me.fields_dict && me.fields_dict['amendment_date'])
newdoc.amendment_date = dateutil.obj_to_str(new Date());
}
this.copy_doc(fn, 1);
}
_f.Frm.prototype.disable_save = function() {
// IMPORTANT: this function should be called in refresh event
cur_frm.save_disabled = true;
cur_frm.footer.hide_save();
cur_frm.appframe.buttons.Save.remove();
delete cur_frm.appframe.buttons.Save
}
_f.get_value = function(dt, dn, fn) {
if(locals[dt] && locals[dt][dn])
return locals[dt][dn][fn];
}
_f.Frm.prototype.set_value_in_locals = function(dt, dn, fn, v) {
var d = locals[dt][dn];
if (!d) return;
var changed = d[fn] != v;
if(changed && (d[fn]==null || v==null) && (cstr(d[fn])==cstr(v)))
changed = false;
if(changed) {
d[fn] = v;
this.dirty();
}
}
_f.Frm.prototype.dirty = function() {
this.doc.__unsaved = 1;
$(this.wrapper).trigger('dirty')
}