2
0
mirror of https://github.com/frappe/books.git synced 2024-09-20 19:29:02 +00:00
books/model/document.js

261 lines
6.9 KiB
JavaScript
Raw Normal View History

2018-01-16 06:09:17 +00:00
const frappe = require('frappejs');
2018-02-13 11:54:57 +00:00
const Observable = require('frappejs/utils/observable');
const model = require('./index');
2018-01-12 12:25:07 +00:00
2018-02-13 11:54:57 +00:00
module.exports = class BaseDocument extends Observable {
2018-01-12 12:25:07 +00:00
constructor(data) {
2018-02-13 11:54:57 +00:00
super();
2018-02-09 12:55:55 +00:00
this.fetchValues = {};
2018-01-12 12:25:07 +00:00
this.setup();
Object.assign(this, data);
}
setup() {
2018-02-13 11:54:57 +00:00
// add listeners
2018-01-12 12:25:07 +00:00
}
2018-02-12 12:01:31 +00:00
get meta() {
if (!this._meta) {
this._meta = frappe.getMeta(this.doctype);
}
return this._meta;
}
async getSettings() {
if (!this._settings) {
this._settings = await frappe.getSingle(this.meta.settings);
}
return this._settings;
}
get(fieldname) {
return this[fieldname];
2018-01-12 12:25:07 +00:00
}
// set value and trigger change
async set(fieldname, value) {
2018-02-08 11:45:32 +00:00
this[fieldname] = await this.validateField(fieldname, value);
await this.applyChange(fieldname);
}
async applyChange(fieldname) {
if (await this.applyFormula()) {
2018-02-08 11:45:32 +00:00
// multiple changes
await this.trigger('change', { doc: this });
} else {
// no other change, trigger control refresh
await this.trigger('change', { doc: this, fieldname: fieldname });
2018-02-08 11:45:32 +00:00
}
2018-01-12 12:25:07 +00:00
}
2018-02-12 12:01:31 +00:00
async setName() {
2018-02-12 12:24:53 +00:00
if (this.name) {
return;
}
2018-02-12 12:01:31 +00:00
// name === doctype for Single
if (this.meta.isSingle) {
this.name = this.meta.name;
return;
}
if (this.meta.settings) {
const numberSeries = (await this.getSettings()).numberSeries;
if(numberSeries) {
this.name = await model.getSeriesNext(numberSeries);
2018-02-12 12:01:31 +00:00
}
}
2018-01-12 12:25:07 +00:00
// assign a random name by default
// override this to set a name
if (!this.name) {
this.name = frappe.getRandomName();
2018-01-12 12:25:07 +00:00
}
}
2018-02-12 12:01:31 +00:00
setDefaults() {
for (let field of this.meta.fields) {
if (this[field.fieldname]===null || this[field.fieldname]===undefined) {
if (field.fieldtype === 'Date') {
this[field.fieldname] = (new Date()).toISOString().substr(0, 10);
} else if(field.default) {
2018-02-14 12:50:56 +00:00
this[field.fieldname] = field.default;
}
2018-02-12 12:01:31 +00:00
}
}
}
2018-02-08 11:45:32 +00:00
setKeywords() {
2018-01-12 12:25:07 +00:00
let keywords = [];
for (let fieldname of this.meta.getKeywordFields()) {
2018-01-12 12:25:07 +00:00
keywords.push(this[fieldname]);
}
this.keywords = keywords.join(', ');
}
append(key, document) {
if (!this[key]) {
this[key] = [];
}
2018-02-08 11:45:32 +00:00
this[key].push(this.initDoc(document));
2018-01-12 12:25:07 +00:00
}
2018-02-08 11:45:32 +00:00
initDoc(data) {
2018-01-12 12:25:07 +00:00
if (data.prototype instanceof Document) {
return data;
} else {
2018-02-01 09:29:25 +00:00
return new Document(data);
2018-01-12 12:25:07 +00:00
}
}
2018-02-08 11:45:32 +00:00
async validateField(key, value) {
let field = this.meta.getField(key);
2018-01-31 13:04:46 +00:00
if (field && field.fieldtype == 'Select') {
2018-02-13 11:54:57 +00:00
return this.meta.validateSelect(field, value);
2018-01-12 12:25:07 +00:00
}
return value;
2018-01-12 12:25:07 +00:00
}
2018-02-08 11:45:32 +00:00
getValidDict() {
2018-02-01 11:07:36 +00:00
let data = {};
for (let field of this.meta.getValidFields()) {
2018-02-01 11:07:36 +00:00
data[field.fieldname] = this[field.fieldname];
2018-01-12 12:25:07 +00:00
}
2018-02-01 11:07:36 +00:00
return data;
2018-01-12 12:25:07 +00:00
}
2018-02-08 11:45:32 +00:00
setStandardValues() {
2018-01-12 12:25:07 +00:00
let now = new Date();
if (this.docstatus === null || this.docstatus === undefined) {
this.docstatus = 0;
}
if (!this.owner) {
this.owner = frappe.session.user;
this.creation = now;
}
2018-02-20 09:53:38 +00:00
this.modifieldBy = frappe.session.user;
2018-01-12 12:25:07 +00:00
this.modified = now;
}
async load() {
let data = await frappe.db.get(this.doctype, this.name);
if (data.name) {
2018-02-08 11:45:32 +00:00
this.syncValues(data);
if (this.meta.isSingle) {
this.setDefaults();
}
} else {
throw new frappe.errors.NotFound(`Not Found: ${this.doctype} ${this.name}`);
}
2018-01-12 12:25:07 +00:00
}
2018-02-08 11:45:32 +00:00
syncValues(data) {
this.clearValues();
2018-02-01 11:07:36 +00:00
Object.assign(this, data);
}
2018-02-08 11:45:32 +00:00
clearValues() {
for (let field of this.meta.getValidFields()) {
2018-02-01 11:07:36 +00:00
if(this[field.fieldname]) {
delete this[field.fieldname];
}
}
}
2018-02-08 11:45:32 +00:00
setChildIdx() {
2018-02-07 13:23:52 +00:00
// renumber children
for (let field of this.meta.getValidFields()) {
2018-02-07 13:23:52 +00:00
if (field.fieldtype==='Table') {
for(let i=0; i < (this[field.fieldname] || []).length; i++) {
this[field.fieldname][i].idx = i;
}
}
}
}
async applyFormula() {
if (!this.meta.hasFormula()) {
2018-02-08 11:45:32 +00:00
return false;
}
2018-02-09 12:55:55 +00:00
let doc = this;
2018-02-08 11:45:32 +00:00
// children
for (let tablefield of this.meta.getTableFields()) {
let formulaFields = frappe.getMeta(tablefield.childtype).getFormulaFields();
if (formulaFields.length) {
// for each row
2018-02-09 12:55:55 +00:00
for (let row of this[tablefield.fieldname]) {
2018-02-08 11:45:32 +00:00
for (let field of formulaFields) {
row[field.fieldname] = await field.formula(row, doc);
2018-02-08 11:45:32 +00:00
}
}
}
}
// parent
for (let field of this.meta.getFormulaFields()) {
doc[field.fieldname] = await field.formula(doc);
2018-02-08 11:45:32 +00:00
}
return true;
}
2018-02-07 13:23:52 +00:00
async commit() {
// re-run triggers
2018-02-12 12:01:31 +00:00
await this.setName();
2018-02-08 11:45:32 +00:00
this.setStandardValues();
this.setKeywords();
this.setChildIdx();
await this.applyFormula();
await this.trigger('validate');
2018-02-07 13:23:52 +00:00
}
async insert() {
await this.commit();
await this.trigger('before_insert');
2018-02-08 11:45:32 +00:00
this.syncValues(await frappe.db.insert(this.doctype, this.getValidDict()));
await this.trigger('after_insert');
await this.trigger('after_save');
2018-02-01 11:07:36 +00:00
return this;
}
2018-02-07 13:23:52 +00:00
async update() {
await this.commit();
2018-02-01 11:07:36 +00:00
await this.trigger('before_update');
2018-02-08 11:45:32 +00:00
this.syncValues(await frappe.db.update(this.doctype, this.getValidDict()));
2018-02-01 11:07:36 +00:00
await this.trigger('after_update');
await this.trigger('after_save');
return this;
2018-01-12 12:25:07 +00:00
}
async delete() {
await this.trigger('before_delete');
await frappe.db.delete(this.doctype, this.name);
await this.trigger('after_delete');
}
2018-02-13 11:54:57 +00:00
async trigger(event, params) {
if (this[event]) {
await this[event](params);
2018-01-12 12:25:07 +00:00
}
2018-02-13 11:54:57 +00:00
await super.trigger(event, params);
2018-01-12 12:25:07 +00:00
}
2018-02-09 12:55:55 +00:00
// helper functions
getSum(tablefield, childfield) {
2018-02-21 09:43:21 +00:00
return this[tablefield].map(d => (d[childfield] || 0)).reduce((a, b) => a + b, 0);
2018-02-09 12:55:55 +00:00
}
async getFrom(doctype, name, fieldname) {
if (!name) return '';
let key = `${doctype}:${name}:${fieldname}`;
if (!this.fetchValues[key]) {
this.fetchValues[key] = await frappe.db.getValue(doctype, name, fieldname);
}
return this.fetchValues[key];
}
2018-01-24 11:52:05 +00:00
};