Yuri Kuznetsov
586 lines
15 KiB
JavaScript
586 lines
15 KiB
JavaScript
/************************************************************************
|
|
* This file is part of EspoCRM.
|
|
*
|
|
* EspoCRM - Open Source CRM application.
|
|
* Copyright (C) 2014-2022 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
|
|
* Website: https://www.espocrm.com
|
|
*
|
|
* EspoCRM is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* EspoCRM is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with EspoCRM. If not, see http://www.gnu.org/licenses/.
|
|
*
|
|
* The interactive user interfaces in modified source and object code versions
|
|
* of this program must display Appropriate Legal Notices, as required under
|
|
* Section 5 of the GNU General Public License version 3.
|
|
*
|
|
* In accordance with Section 7(b) of the GNU General Public License version 3,
|
|
* these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
|
|
************************************************************************/
|
|
|
|
define('model', [], function () {
|
|
|
|
let Dep = Backbone.Model;
|
|
|
|
/**
|
|
* Save values to the backend.
|
|
*
|
|
* @function save
|
|
* @memberof Backbone.Model.prototype
|
|
* @param {Object} [attributes] Attribute values.
|
|
* @param {Object} [options] Options.
|
|
* @returns {Promise}
|
|
*
|
|
* @fires module:model.Class#sync
|
|
*/
|
|
|
|
/**
|
|
* Whether an attribute is changed. To be used only within a callback of a 'change' event listener.
|
|
*
|
|
* @function changed
|
|
* @memberof Backbone.Model.prototype
|
|
* @param {string} attribute An attribute name.
|
|
* @returns {boolean}
|
|
*/
|
|
|
|
/**
|
|
* Removes all attributes from the model, including the `id` attribute.
|
|
* Fires a `change` event unless `silent` is passed as an option.
|
|
*
|
|
* @function clear
|
|
* @memberof Backbone.Model.prototype
|
|
* @param {Object} [options] Options.
|
|
*/
|
|
|
|
/**
|
|
* When attributes have changed.
|
|
*
|
|
* @event module:model.Class#change
|
|
* @param {module:model.Class} model A model.
|
|
* @param {Object} o Options.
|
|
*/
|
|
|
|
/**
|
|
* On sync with backend.
|
|
*
|
|
* @event module:model.Class#sync
|
|
* @param {module:model.Class} model A model.
|
|
* @param {Object} response Response from backend.
|
|
* @param {Object} o Options.
|
|
*/
|
|
|
|
/**
|
|
* A model.
|
|
*
|
|
* @class
|
|
* @name Class
|
|
* @extends Backbone.Model
|
|
* @mixes Backbone.Events
|
|
* @memberOf module:model
|
|
*/
|
|
return Dep.extend(/** @lends module:model.Class.prototype */{
|
|
|
|
/**
|
|
* An entity type.
|
|
*
|
|
* @name entityType
|
|
* @property {string}
|
|
* @public
|
|
* @memberof module:model.Class.prototype
|
|
*/
|
|
|
|
/**
|
|
* A record ID.
|
|
*
|
|
* @name cid
|
|
* @type {string|null}
|
|
* @public
|
|
* @memberof module:model.Class.prototype
|
|
*/
|
|
|
|
/**
|
|
* An ID, unique among all models.
|
|
*
|
|
* @name cid
|
|
* @type {string}
|
|
* @public
|
|
* @memberof module:model.Class.prototype
|
|
*/
|
|
|
|
/**
|
|
* Attribute values.
|
|
*
|
|
* @name attributes
|
|
* @type {Object}
|
|
* @public
|
|
* @memberof module:model.Class.prototype
|
|
*/
|
|
|
|
/**
|
|
* A root URL.
|
|
*
|
|
* @type {string|null}
|
|
* @public
|
|
*/
|
|
urlRoot: null,
|
|
|
|
/**
|
|
* A name.
|
|
*
|
|
* @type {string}
|
|
* @public
|
|
*/
|
|
name: null,
|
|
|
|
/**
|
|
* @private
|
|
*/
|
|
dateTime: null,
|
|
|
|
/**
|
|
* @private
|
|
*/
|
|
_user: null,
|
|
|
|
/**
|
|
* Definitions.
|
|
*
|
|
* @type {Object|null}
|
|
*/
|
|
defs: null,
|
|
|
|
/**
|
|
* Initialize.
|
|
*
|
|
* @protected
|
|
*/
|
|
initialize: function () {
|
|
this.urlRoot = this.urlRoot || this.name;
|
|
|
|
this.defs = this.defs || {};
|
|
|
|
this.defs.fields = this.defs.fields || {};
|
|
this.defs.links = this.defs.links || {};
|
|
},
|
|
|
|
/**
|
|
* @param {string} [method] HTTP method.
|
|
* @param {module:model.Class} [model]
|
|
* @param {Object} [options]
|
|
* @returns {Promise}
|
|
*/
|
|
sync: function (method, model, options) {
|
|
if (method === 'patch') {
|
|
options.type = 'PUT';
|
|
}
|
|
|
|
return Dep.prototype.sync.call(this, method, model, options);
|
|
},
|
|
|
|
/**
|
|
* Set an attribute value or multiple values.
|
|
*
|
|
* @param {(string|Object)} key An attribute name or a {key => value} object.
|
|
* @param {*} [val] A value or options if the first argument is an object.
|
|
* @param {Object} [options] Options. `silent` won't trigger a `change` event.
|
|
* @returns {this}
|
|
*
|
|
* @fires module:model.Class#change Unless `{silent: true}`.
|
|
*/
|
|
set: function (key, val, options) {
|
|
if (typeof key === 'object') {
|
|
let o = key;
|
|
|
|
if (this.idAttribute in o) {
|
|
this.id = o[this.idAttribute];
|
|
}
|
|
}
|
|
else if (key === 'id') {
|
|
this.id = val;
|
|
}
|
|
|
|
return Dep.prototype.set.call(this, key, val, options);
|
|
},
|
|
|
|
/**
|
|
* Get an attribute value.
|
|
*
|
|
* @param {string} key An attribute name.
|
|
* @returns {*}
|
|
*/
|
|
get: function (key) {
|
|
if (key === 'id' && this.id) {
|
|
return this.id;
|
|
}
|
|
|
|
return Dep.prototype.get.call(this, key);
|
|
},
|
|
|
|
/**
|
|
* Whether attribute is set.
|
|
*
|
|
* @param {string} key An attribute name.
|
|
* @returns {boolean}
|
|
*/
|
|
has: function (key) {
|
|
let value = this.get(key);
|
|
|
|
return (typeof value !== 'undefined');
|
|
},
|
|
|
|
/**
|
|
* Whether is new.
|
|
*
|
|
* @returns {boolean}
|
|
*/
|
|
isNew: function () {
|
|
return !this.id;
|
|
},
|
|
|
|
/**
|
|
* Set defs.
|
|
*
|
|
* @param {Object} defs
|
|
*/
|
|
setDefs: function (defs) {
|
|
this.defs = defs || {};
|
|
|
|
this.defs.fields = this.defs.fields || {};
|
|
},
|
|
|
|
/**
|
|
* Get cloned attribute values.
|
|
*
|
|
* @returns {Object}
|
|
*/
|
|
getClonedAttributes: function () {
|
|
var attributes = {};
|
|
|
|
for (let name in this.attributes) {
|
|
attributes[name] = Espo.Utils.cloneDeep(this.attributes[name]);
|
|
}
|
|
|
|
return attributes;
|
|
},
|
|
|
|
/**
|
|
* Populate default values.
|
|
*/
|
|
populateDefaults: function () {
|
|
var defaultHash = {};
|
|
|
|
if ('fields' in this.defs) {
|
|
for (let field in this.defs.fields) {
|
|
let defaultValue = this.getFieldParam(field, 'default');
|
|
|
|
if (defaultValue !== null) {
|
|
try {
|
|
defaultValue = this.parseDefaultValue(defaultValue);
|
|
|
|
defaultHash[field] = defaultValue;
|
|
}
|
|
catch (e) {
|
|
console.error(e);
|
|
}
|
|
}
|
|
|
|
let defaultAttributes = this.getFieldParam(field, 'defaultAttributes');
|
|
|
|
if (defaultAttributes) {
|
|
for (let attribute in defaultAttributes) {
|
|
defaultHash[attribute] = defaultAttributes[attribute];
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
defaultHash = Espo.Utils.cloneDeep(defaultHash);
|
|
|
|
for (let attr in defaultHash) {
|
|
if (this.has(attr)) {
|
|
delete defaultHash[attr];
|
|
}
|
|
}
|
|
|
|
this.set(defaultHash, {silent: true});
|
|
},
|
|
|
|
/**
|
|
* @protected
|
|
*
|
|
* @param {*} defaultValue
|
|
* @returns {*}
|
|
* @deprecated
|
|
*/
|
|
parseDefaultValue: function (defaultValue) {
|
|
if (
|
|
typeof defaultValue === 'string' &&
|
|
defaultValue.indexOf('javascript:') === 0
|
|
) {
|
|
let code = defaultValue.substring(11);
|
|
|
|
defaultValue = (new Function( "with(this) { " + code + "}")).call(this);
|
|
}
|
|
|
|
return defaultValue;
|
|
},
|
|
|
|
/**
|
|
* Get a link multiple column value.
|
|
*
|
|
* @param {string} field
|
|
* @param {string} column
|
|
* @param {string} id
|
|
* @returns {*}
|
|
*/
|
|
getLinkMultipleColumn: function (field, column, id) {
|
|
return ((this.get(field + 'Columns') || {})[id] || {})[column];
|
|
},
|
|
|
|
/**
|
|
* @param {Object} data
|
|
*/
|
|
setRelate: function (data) {
|
|
let setRelate = options => {
|
|
var link = options.link;
|
|
var model = options.model;
|
|
|
|
if (!link || !model) {
|
|
throw new Error('Bad related options');
|
|
}
|
|
|
|
var type = this.defs.links[link].type;
|
|
|
|
switch (type) {
|
|
case 'belongsToParent':
|
|
this.set(link + 'Id', model.id);
|
|
this.set(link + 'Type', model.name);
|
|
this.set(link + 'Name', model.get('name'));
|
|
|
|
break;
|
|
|
|
case 'belongsTo':
|
|
this.set(link + 'Id', model.id);
|
|
this.set(link + 'Name', model.get('name'));
|
|
|
|
break;
|
|
|
|
case 'hasMany':
|
|
var ids = [];
|
|
ids.push(model.id);
|
|
|
|
let names = {};
|
|
|
|
names[model.id] = model.get('name');
|
|
|
|
this.set(link + 'Ids', ids);
|
|
this.set(link + 'Names', names);
|
|
|
|
break;
|
|
}
|
|
};
|
|
|
|
if (Object.prototype.toString.call(data) === '[object Array]') {
|
|
data.forEach(options => {
|
|
setRelate(options);
|
|
});
|
|
}
|
|
else {
|
|
setRelate(data);
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Get a field type.
|
|
*
|
|
* @param {string} field
|
|
* @returns {string|null}
|
|
*/
|
|
getFieldType: function (field) {
|
|
if (this.defs && this.defs.fields && (field in this.defs.fields)) {
|
|
return this.defs.fields[field].type || null;
|
|
}
|
|
|
|
return null;
|
|
},
|
|
|
|
/**
|
|
* Get a field param.
|
|
*
|
|
* @param {string} field
|
|
* @param {string} param
|
|
* @returns {*}
|
|
*/
|
|
getFieldParam: function (field, param) {
|
|
if (this.defs && this.defs.fields && (field in this.defs.fields)) {
|
|
if (param in this.defs.fields[field]) {
|
|
return this.defs.fields[field][param];
|
|
}
|
|
}
|
|
|
|
return null;
|
|
},
|
|
|
|
/**
|
|
* Get a link type.
|
|
*
|
|
* @param {string} link
|
|
* @returns {string|null}
|
|
*/
|
|
getLinkType: function (link) {
|
|
if (this.defs && this.defs.links && (link in this.defs.links)) {
|
|
return this.defs.links[link].type || null;
|
|
}
|
|
|
|
return null;
|
|
},
|
|
|
|
/**
|
|
* Get a link param.
|
|
*
|
|
* @param {string} link A link.
|
|
* @param {string} param A param.
|
|
* @returns {*}
|
|
*/
|
|
getLinkParam: function (link, param) {
|
|
if (this.defs && this.defs.links && (link in this.defs.links)) {
|
|
if (param in this.defs.links[link]) {
|
|
return this.defs.links[link][param];
|
|
}
|
|
}
|
|
|
|
return null;
|
|
},
|
|
|
|
/**
|
|
* Is a field read-only.
|
|
*
|
|
* @param {string} field A field.
|
|
* @returns {bool}
|
|
*/
|
|
isFieldReadOnly: function (field) {
|
|
return this.getFieldParam(field, 'readOnly') || false;
|
|
},
|
|
|
|
/**
|
|
* If a field required.
|
|
*
|
|
* @param {string} field A field.
|
|
* @returns {bool}
|
|
*/
|
|
isRequired: function (field) {
|
|
return this.getFieldParam(field, 'required') || false;
|
|
},
|
|
|
|
/**
|
|
* Get IDs of a link-multiple field.
|
|
*
|
|
* @param {type} field A link-multiple field name.
|
|
* @returns {string[]}
|
|
*/
|
|
getLinkMultipleIdList: function (field) {
|
|
return this.get(field + 'Ids') || [];
|
|
},
|
|
|
|
/**
|
|
* Get team IDs.
|
|
*
|
|
* @returns {string[]}
|
|
*/
|
|
getTeamIdList: function () {
|
|
return this.get('teamsIds') || [];
|
|
},
|
|
|
|
|
|
/**
|
|
* @protected
|
|
* @returns {Espo.DateTime}
|
|
*/
|
|
getDateTime: function () {
|
|
return this.dateTime;
|
|
},
|
|
|
|
/**
|
|
* @protected
|
|
* @returns {Espo.Models.User}
|
|
*/
|
|
getUser: function () {
|
|
return this._user;
|
|
},
|
|
|
|
/**
|
|
* Whether has a field.
|
|
*
|
|
* @param {string} field A field.
|
|
* @returns {boolean}
|
|
*/
|
|
hasField: function (field) {
|
|
return ('defs' in this) && ('fields' in this.defs) && (field in this.defs.fields);
|
|
},
|
|
|
|
/**
|
|
* Whether has a link.
|
|
*
|
|
* @param {string} link A link.
|
|
* @returns {boolean}
|
|
*/
|
|
hasLink: function (link) {
|
|
return ('defs' in this) && ('links' in this.defs) && (link in this.defs.links);
|
|
},
|
|
|
|
/**
|
|
* @returns {boolean}
|
|
*/
|
|
isEditable: function () {
|
|
return true;
|
|
},
|
|
|
|
/**
|
|
* @returns {boolean}
|
|
*/
|
|
isRemovable: function () {
|
|
return true;
|
|
},
|
|
|
|
/**
|
|
* Get an entity type.
|
|
*
|
|
* @returns {string}
|
|
*/
|
|
getEntityType: function () {
|
|
return this.name;
|
|
},
|
|
|
|
/**
|
|
* Fetch values from the backend.
|
|
*
|
|
* @param {Object} [options] Options.
|
|
* @returns {Promise<Object>}
|
|
*
|
|
* @fires module:model.Class#sync
|
|
*/
|
|
fetch: function (options) {
|
|
this.lastXhr = Dep.prototype.fetch.call(this, options);
|
|
|
|
return this.lastXhr;
|
|
},
|
|
|
|
/**
|
|
* Abort the last fetch.
|
|
*/
|
|
abortLastFetch: function () {
|
|
if (this.lastXhr && this.lastXhr.readyState < 4) {
|
|
this.lastXhr.abort();
|
|
}
|
|
},
|
|
});
|
|
});
|