2022-04-16 00:18:01 +02:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html lang="en">
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
<title>JSDoc: Source: becca/entities/abstract_entity.js</title>
|
|
|
|
|
|
|
|
|
|
<script src="scripts/prettify/prettify.js"> </script>
|
|
|
|
|
<script src="scripts/prettify/lang-css.js"> </script>
|
|
|
|
|
<!--[if lt IE 9]>
|
|
|
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
|
|
|
<![endif]-->
|
|
|
|
|
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
|
|
|
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
|
|
|
|
|
<div id="main">
|
|
|
|
|
|
|
|
|
|
<h1 class="page-title">Source: becca/entities/abstract_entity.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
|
|
|
<article>
|
|
|
|
|
<pre class="prettyprint source linenums"><code>"use strict";
|
|
|
|
|
|
|
|
|
|
const utils = require('../../services/utils');
|
|
|
|
|
const sql = require('../../services/sql');
|
|
|
|
|
const entityChangesService = require('../../services/entity_changes');
|
|
|
|
|
const eventService = require("../../services/events");
|
|
|
|
|
const dateUtils = require("../../services/date_utils");
|
|
|
|
|
const cls = require("../../services/cls");
|
|
|
|
|
const log = require("../../services/log");
|
|
|
|
|
|
|
|
|
|
let becca = null;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Base class for all backend entities.
|
|
|
|
|
*/
|
|
|
|
|
class AbstractEntity {
|
2022-06-19 14:06:00 +02:00
|
|
|
/** @protected */
|
2022-04-16 00:18:01 +02:00
|
|
|
beforeSaving() {
|
|
|
|
|
this.generateIdIfNecessary();
|
|
|
|
|
}
|
|
|
|
|
|
2022-06-19 14:06:00 +02:00
|
|
|
/** @protected */
|
2022-04-16 00:18:01 +02:00
|
|
|
generateIdIfNecessary() {
|
|
|
|
|
if (!this[this.constructor.primaryKeyName]) {
|
|
|
|
|
this[this.constructor.primaryKeyName] = utils.newEntityId();
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2022-06-19 14:06:00 +02:00
|
|
|
/** @protected */
|
2022-04-16 00:18:01 +02:00
|
|
|
generateHash(isDeleted = false) {
|
|
|
|
|
let contentToHash = "";
|
|
|
|
|
|
|
|
|
|
for (const propertyName of this.constructor.hashedProperties) {
|
2022-12-22 14:57:00 +01:00
|
|
|
contentToHash += `|${this[propertyName]}`;
|
2022-04-16 00:18:01 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (isDeleted) {
|
|
|
|
|
contentToHash += "|deleted";
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return utils.hash(contentToHash).substr(0, 10);
|
|
|
|
|
}
|
|
|
|
|
|
2022-06-19 14:06:00 +02:00
|
|
|
/** @protected */
|
2022-04-16 00:18:01 +02:00
|
|
|
getUtcDateChanged() {
|
|
|
|
|
return this.utcDateModified || this.utcDateCreated;
|
|
|
|
|
}
|
|
|
|
|
|
2022-06-19 14:06:00 +02:00
|
|
|
/** @protected */
|
2022-04-16 00:18:01 +02:00
|
|
|
get becca() {
|
|
|
|
|
if (!becca) {
|
|
|
|
|
becca = require('../becca');
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return becca;
|
|
|
|
|
}
|
|
|
|
|
|
2022-06-19 14:06:00 +02:00
|
|
|
/** @protected */
|
2022-04-16 00:18:01 +02:00
|
|
|
addEntityChange(isDeleted = false) {
|
|
|
|
|
entityChangesService.addEntityChange({
|
|
|
|
|
entityName: this.constructor.entityName,
|
|
|
|
|
entityId: this[this.constructor.primaryKeyName],
|
|
|
|
|
hash: this.generateHash(isDeleted),
|
|
|
|
|
isErased: false,
|
|
|
|
|
utcDateChanged: this.getUtcDateChanged(),
|
|
|
|
|
isSynced: this.constructor.entityName !== 'options' || !!this.isSynced
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
|
2022-06-19 14:06:00 +02:00
|
|
|
/** @protected */
|
2022-04-16 00:18:01 +02:00
|
|
|
getPojoToSave() {
|
|
|
|
|
return this.getPojo();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Saves entity - executes SQL, but doesn't commit the transaction on its own
|
|
|
|
|
*
|
|
|
|
|
* @returns {AbstractEntity}
|
|
|
|
|
*/
|
|
|
|
|
save() {
|
|
|
|
|
const entityName = this.constructor.entityName;
|
|
|
|
|
const primaryKeyName = this.constructor.primaryKeyName;
|
|
|
|
|
|
|
|
|
|
const isNewEntity = !this[primaryKeyName];
|
|
|
|
|
|
|
|
|
|
if (this.beforeSaving) {
|
|
|
|
|
this.beforeSaving();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
const pojo = this.getPojoToSave();
|
|
|
|
|
|
|
|
|
|
sql.transactional(() => {
|
|
|
|
|
sql.upsert(entityName, primaryKeyName, pojo);
|
|
|
|
|
|
|
|
|
|
if (entityName === 'recent_notes') {
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
this.addEntityChange(false);
|
|
|
|
|
|
|
|
|
|
if (!cls.isEntityEventsDisabled()) {
|
|
|
|
|
const eventPayload = {
|
|
|
|
|
entityName,
|
|
|
|
|
entity: this
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
if (isNewEntity) {
|
|
|
|
|
eventService.emit(eventService.ENTITY_CREATED, eventPayload);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
eventService.emit(eventService.ENTITY_CHANGED, eventPayload);
|
|
|
|
|
}
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
return this;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Mark the entity as (soft) deleted. It will be completely erased later.
|
|
|
|
|
*
|
2022-04-19 23:06:46 +02:00
|
|
|
* This is a low level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
|
|
|
|
|
*
|
2022-04-16 00:18:01 +02:00
|
|
|
* @param [deleteId=null]
|
|
|
|
|
*/
|
|
|
|
|
markAsDeleted(deleteId = null) {
|
|
|
|
|
const entityId = this[this.constructor.primaryKeyName];
|
|
|
|
|
const entityName = this.constructor.entityName;
|
|
|
|
|
|
|
|
|
|
this.utcDateModified = dateUtils.utcNowDateTime();
|
|
|
|
|
|
|
|
|
|
sql.execute(`UPDATE ${entityName} SET isDeleted = 1, deleteId = ?, utcDateModified = ?
|
|
|
|
|
WHERE ${this.constructor.primaryKeyName} = ?`,
|
|
|
|
|
[deleteId, this.utcDateModified, entityId]);
|
|
|
|
|
|
|
|
|
|
if (this.dateModified) {
|
|
|
|
|
this.dateModified = dateUtils.localNowDateTime();
|
|
|
|
|
|
|
|
|
|
sql.execute(`UPDATE ${entityName} SET dateModified = ? WHERE ${this.constructor.primaryKeyName} = ?`,
|
|
|
|
|
[this.dateModified, entityId]);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
log.info(`Marking ${entityName} ${entityId} as deleted`);
|
|
|
|
|
|
|
|
|
|
this.addEntityChange(true);
|
|
|
|
|
|
|
|
|
|
eventService.emit(eventService.ENTITY_DELETED, { entityName, entityId, entity: this });
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
markAsDeletedSimple() {
|
|
|
|
|
const entityId = this[this.constructor.primaryKeyName];
|
|
|
|
|
const entityName = this.constructor.entityName;
|
|
|
|
|
|
|
|
|
|
this.utcDateModified = dateUtils.utcNowDateTime();
|
|
|
|
|
|
|
|
|
|
sql.execute(`UPDATE ${entityName} SET isDeleted = 1, utcDateModified = ?
|
|
|
|
|
WHERE ${this.constructor.primaryKeyName} = ?`,
|
|
|
|
|
[this.utcDateModified, entityId]);
|
|
|
|
|
|
|
|
|
|
log.info(`Marking ${entityName} ${entityId} as deleted`);
|
|
|
|
|
|
|
|
|
|
this.addEntityChange(true);
|
|
|
|
|
|
|
|
|
|
eventService.emit(eventService.ENTITY_DELETED, { entityName, entityId, entity: this });
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
module.exports = AbstractEntity;
|
|
|
|
|
</code></pre>
|
|
|
|
|
</article>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<nav>
|
2022-12-25 13:03:22 +01:00
|
|
|
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3>
|
2022-04-16 00:18:01 +02:00
|
|
|
</nav>
|
|
|
|
|
|
|
|
|
|
<br class="clear">
|
|
|
|
|
|
|
|
|
|
<footer>
|
2022-11-07 21:26:13 +01:00
|
|
|
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.0</a>
|
2022-04-16 00:18:01 +02:00
|
|
|
</footer>
|
|
|
|
|
|
|
|
|
|
<script> prettyPrint(); </script>
|
|
|
|
|
<script src="scripts/linenumber.js"> </script>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
