# JSDoc: Source: becca/entities/abstract_becca_entity.js

# Source: becca/entities/abstract_becca_entity.js

    "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");
    const protectedSessionService = require("../../services/protected_session");
    const blobService = require("../../services/blob");

    let becca = null;

    /**
     * Base class for all backend entities.
     */
    class AbstractBeccaEntity {
        /** @protected */
        beforeSaving() {
            if (!this[this.constructor.primaryKeyName]) {
                this[this.constructor.primaryKeyName] = utils.newEntityId();
            }
        }

        /** @protected */
        getUtcDateChanged() {
            return this.utcDateModified || this.utcDateCreated;
        }

        /**
         * @protected
         * @returns {Becca}
         */
        get becca() {
            if (!becca) {
                becca = require('../becca');
            }

            return becca;
        }

        /** @protected */
        putEntityChange(isDeleted) {
            entityChangesService.putEntityChange({
                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
            });
        }

        /**
         * @protected
         * @returns {string}
         */
        generateHash(isDeleted) {
            let contentToHash = "";

            for (const propertyName of this.constructor.hashedProperties) {
                contentToHash += `|${this[propertyName]}`;
            }

            if (isDeleted) {
                contentToHash += "|deleted";
            }

            return utils.hash(contentToHash).substr(0, 10);
        }

        /** @protected */
        getPojoToSave() {
            return this.getPojo();
        }

        /**
         * @protected
         * @abstract
         */
        getPojo() {
            throw new Error(`Unimplemented getPojo() for entity '${this.constructor.name}'`)
        }

        /**
         * Saves entity - executes SQL, but doesn't commit the transaction on its own
         *
         * @returns {this}
         */
        save(opts = {}) {
            const entityName = this.constructor.entityName;
            const primaryKeyName = this.constructor.primaryKeyName;

            const isNewEntity = !this[primaryKeyName];

            this.beforeSaving(opts);

            const pojo = this.getPojoToSave();

            sql.transactional(() => {
                sql.upsert(entityName, primaryKeyName, pojo);

                if (entityName === 'recent_notes') {
                    return;
                }

                this.putEntityChange(!!this.isDeleted);

                if (!cls.isEntityEventsDisabled()) {
                    const eventPayload = {
                        entityName,
                        entity: this
                    };

                    if (isNewEntity) {
                        eventService.emit(eventService.ENTITY_CREATED, eventPayload);
                    }

                    eventService.emit(eventService.ENTITY_CHANGED, eventPayload);
                }
            });

            return this;
        }

        /** @protected */
        _setContent(content, opts = {}) {
            // client code asks to save entity even if blobId didn't change (something else was changed)
            opts.forceSave = !!opts.forceSave;
            opts.forceFrontendReload = !!opts.forceFrontendReload;

            if (content === null || content === undefined) {
                throw new Error(`Cannot set null content to ${this.constructor.primaryKeyName} '${this[this.constructor.primaryKeyName]}'`);
            }

            if (this.hasStringContent()) {
                content = content.toString();
            } else {
                content = Buffer.isBuffer(content) ? content : Buffer.from(content);
            }

            const unencryptedContentForHashCalculation = this.#getUnencryptedContentForHashCalculation(content);

            if (this.isProtected) {
                if (protectedSessionService.isProtectedSessionAvailable()) {
                    content = protectedSessionService.encrypt(content);
                } else {
                    throw new Error(`Cannot update content of blob since protected session is not available.`);
                }
            }

            sql.transactional(() => {
                const newBlobId = this.#saveBlob(content, unencryptedContentForHashCalculation, opts);
                const oldBlobId = this.blobId;

                if (newBlobId !== oldBlobId || opts.forceSave) {
                    this.blobId = newBlobId;
                    this.save();

                    if (newBlobId !== oldBlobId) {
                        this.#deleteBlobIfNotUsed(oldBlobId);
                    }
                }
            });
        }

        #deleteBlobIfNotUsed(oldBlobId) {
            if (sql.getValue("SELECT 1 FROM notes WHERE blobId = ? LIMIT 1", [oldBlobId])) {
                return;
            }

            if (sql.getValue("SELECT 1 FROM attachments WHERE blobId = ? LIMIT 1", [oldBlobId])) {
                return;
            }

            if (sql.getValue("SELECT 1 FROM revisions WHERE blobId = ? LIMIT 1", [oldBlobId])) {
                return;
            }

            sql.execute("DELETE FROM blobs WHERE blobId = ?", [oldBlobId]);
            // blobs are not marked as erased in entity_changes, they are just purged completely
            // this is because technically every keystroke can create a new blob, and there would be just too many
            sql.execute("DELETE FROM entity_changes WHERE entityName = 'blobs' AND entityId = ?", [oldBlobId]);
        }

        #getUnencryptedContentForHashCalculation(unencryptedContent) {
            if (this.isProtected) {
                // a "random" prefix makes sure that the calculated hash/blobId is different for a decrypted/encrypted content
                const encryptedPrefixSuffix = "t$[nvQg7q)&_ENCRYPTED_?M:Bf&j3jr_";
                return Buffer.isBuffer(unencryptedContent)
                    ? Buffer.concat([Buffer.from(encryptedPrefixSuffix), unencryptedContent])
                    : `${encryptedPrefixSuffix}${unencryptedContent}`;
            } else {
                return unencryptedContent;
            }
        }

        #saveBlob(content, unencryptedContentForHashCalculation, opts = {}) {
            /*
             * We're using the unencrypted blob for the hash calculation, because otherwise the random IV would
             * cause every content blob to be unique which would balloon the database size (esp. with revisioning).
             * This has minor security implications (it's easy to infer that given content is shared between different
             * notes/attachments), but the trade-off comes out clearly positive.
             */
            const newBlobId = utils.hashedBlobId(unencryptedContentForHashCalculation);
            const blobNeedsInsert = !sql.getValue('SELECT 1 FROM blobs WHERE blobId = ?', [newBlobId]);

            if (!blobNeedsInsert) {
                return newBlobId;
            }

            const pojo = {
                blobId: newBlobId,
                content: content,
                dateModified: dateUtils.localNowDateTime(),
                utcDateModified: dateUtils.utcNowDateTime()
            };

            sql.upsert("blobs", "blobId", pojo);

            // we can't reuse blobId as an entity_changes hash, because this one has to be calculatable without having
            // access to the decrypted content
            const hash = blobService.calculateContentHash(pojo);

            entityChangesService.putEntityChange({
                entityName: 'blobs',
                entityId: newBlobId,
                hash: hash,
                isErased: false,
                utcDateChanged: pojo.utcDateModified,
                isSynced: true,
                // overriding componentId will cause the frontend to think the change is coming from a different component
                // and thus reload
                componentId: opts.forceFrontendReload ? utils.randomString(10) : null
            });

            eventService.emit(eventService.ENTITY_CHANGED, {
                entityName: 'blobs',
                entity: this
            });

            return newBlobId;
        }

        /**
         * @protected
         * @returns {string|Buffer}
         */
        _getContent() {
            const row = sql.getRow(`SELECT content FROM blobs WHERE blobId = ?`, [this.blobId]);

            if (!row) {
                throw new Error(`Cannot find content for ${this.constructor.primaryKeyName} '${this[this.constructor.primaryKeyName]}', blobId '${this.blobId}'`);
            }

            return blobService.processContent(row.content, this.isProtected, this.hasStringContent());
        }

        /**
         * Mark the entity as (soft) deleted. It will be completely erased later.
         *
         * This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
         *
         * @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.putEntityChange(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.putEntityChange(true);

            eventService.emit(eventService.ENTITY_DELETED, { entityName, entityId, entity: this });
        }
    }

    module.exports = AbstractBeccaEntity;