trilium/src/services/sync_update.js

const sql = require('./sql');
const log = require('./log');
const entityChangesService = require('./entity_changes.js');
const eventService = require('./events');

function updateEntity(entityChange, entity, sourceId) {
    // can be undefined for options with isSynced=false
    if (!entity) {
        return false;
    }

    const {entityName, hash} = entityChange;
    let updated;

    if (entityName === 'notes') {
        updated = updateNote(entity, hash, sourceId);
    }
    else if (entityName === 'note_contents') {
        updated = updateNoteContent(entity, hash, sourceId);
    }
    else if (entityName === 'branches') {
        updated = updateBranch(entity, hash, sourceId);
    }
    else if (entityName === 'note_revisions') {
        updated = updateNoteRevision(entity, hash, sourceId);
    }
    else if (entityName === 'note_revision_contents') {
        updated = updateNoteRevisionContent(entity, hash, sourceId);
    }
    else if (entityName === 'note_reordering') {
        updated = updateNoteReordering(entityChange.entityId, entity, sourceId);
    }
    else if (entityName === 'options') {
        updated = updateOptions(entity, hash, sourceId);
    }
    else if (entityName === 'recent_notes') {
        updated = updateRecentNotes(entity, hash, sourceId);
    }
    else if (entityName === 'attributes') {
        updated = updateAttribute(entity, hash, sourceId);
    }
    else if (entityName === 'api_tokens') {
        updated = updateApiToken(entity, hash, sourceId);
    }
    else {
        throw new Error(`Unrecognized entity type ${entityName}`);
    }

    // currently making exception for protected notes and note revisions because here
    // the title and content are not available decrypted as listeners would expect
    if (updated &&
        (!['notes', 'note_contents', 'note_revisions', 'note_revision_contents'].includes(entityName) || !entity.isProtected)) {
        eventService.emit(eventService.ENTITY_SYNCED, {
            entityName,
            entity
        });
    }

    return updated;
}

function shouldWeUpdateEntity(localEntity, remoteEntity) {
    if (!localEntity) {
        return true;
    }

    const localDate = localEntity.utcDateModified || localEntity.utcDateCreated;
    const remoteDate = remoteEntity.utcDateModified || remoteEntity.utcDateCreated;

    if (localDate < remoteDate) {
        return true;
    }

    // this can happen in case of sync error when hashes are different but dates are the same - we should still update
    if (localEntity.hash !== remoteEntity.hash && localDate === remoteDate) {
        return true;
    }

    return false;
}

function updateNote(remoteEntity, hash, sourceId) {
    const localEntity = sql.getRow("SELECT * FROM notes WHERE noteId = ?", [remoteEntity.noteId]);

    if (shouldWeUpdateEntity(localEntity, remoteEntity)) {
        sql.transactional(() => {
            sql.replace("notes", remoteEntity);

            entityChangesService.addEntityChange('notes', remoteEntity.noteId, hash, sourceId);
        });

        return true;
    }

    return false;
}

function updateNoteContent(remoteEntity, hash, sourceId) {
    const localEntity = sql.getRow("SELECT * FROM note_contents WHERE noteId = ?", [remoteEntity.noteId]);

    if (shouldWeUpdateEntity(localEntity, remoteEntity)) {
        // we always use Buffer object which is different from normal saving - there we use simple string type for "string notes"
        // the problem is that in general it's not possible to whether a note_content is string note or note (syncs can arrive out of order)
        remoteEntity.content = remoteEntity.content === null ? null : Buffer.from(remoteEntity.content, 'base64');

        if (remoteEntity.content && remoteEntity.content.byteLength === 0) {
            // there seems to be a bug which causes empty buffer to be stored as NULL which is then picked up as inconsistency
            remoteEntity.content = "";
        }

        sql.transactional(() => {
            sql.replace("note_contents", remoteEntity);

            entityChangesService.addEntityChange("note_contents", remoteEntity.noteId, hash, sourceId);
        });

        return true;
    }

    return false;
}

function updateBranch(remoteEntity, hash, sourceId) {
    const localEntity = sql.getRowOrNull("SELECT * FROM branches WHERE branchId = ?", [remoteEntity.branchId]);

    if (shouldWeUpdateEntity(localEntity, remoteEntity)) {
        sql.transactional(() => {
            // isExpanded is not synced unless it's a new branch instance
            // otherwise in case of full new sync we'll get all branches (even root) collapsed.
            if (localEntity) {
                delete remoteEntity.isExpanded;
            }

            sql.replace('branches', remoteEntity);

            entityChangesService.addEntityChange('branches', remoteEntity.branchId, hash, sourceId);
        });

        return true;
    }

    return false;
}

function updateNoteRevision(remoteEntity, hash, sourceId) {
    const localEntity = sql.getRowOrNull("SELECT * FROM note_revisions WHERE noteRevisionId = ?", [remoteEntity.noteRevisionId]);

    sql.transactional(() => {
        if (shouldWeUpdateEntity(localEntity, remoteEntity)) {
            sql.replace('note_revisions', remoteEntity);

            entityChangesService.addEntityChange('note_revisions', remoteEntity.noteRevisionId, hash, sourceId);

            log.info("Update/sync note revision " + remoteEntity.noteRevisionId);
        }
    });
}

function updateNoteRevisionContent(remoteEntity, hash, sourceId) {
    const localEntity = sql.getRowOrNull("SELECT * FROM note_revision_contents WHERE noteRevisionId = ?", [remoteEntity.noteRevisionId]);

    if (shouldWeUpdateEntity(localEntity, remoteEntity)) {
        sql.transactional(() => {
            remoteEntity.content = remoteEntity.content === null ? null : Buffer.from(remoteEntity.content, 'base64');

            sql.replace('note_revision_contents', remoteEntity);

            entityChangesService.addEntityChange('note_revision_contents', remoteEntity.noteRevisionId, hash, sourceId);
        });

        return true;
    }

    return false;
}

function updateNoteReordering(entityId, remote, sourceId) {
    sql.transactional(() => {
        for (const key in remote) {
            sql.execute("UPDATE branches SET notePosition = ? WHERE branchId = ?", [remote[key], key]);
        }

        entityChangesService.addEntityChange('note_reordering', entityId, 'none', sourceId);
    });

    return true;
}

function updateOptions(remoteEntity, hash, sourceId) {
    const localEntity = sql.getRowOrNull("SELECT * FROM options WHERE name = ?", [remoteEntity.name]);

    if (localEntity && !localEntity.isSynced) {
        return;
    }

    if (shouldWeUpdateEntity(localEntity, remoteEntity)) {
        sql.transactional(() => {
            sql.replace('options', remoteEntity);

            entityChangesService.addEntityChange('options', remoteEntity.name, hash, sourceId, true);
        });

        return true;
    }

    return false;
}

function updateRecentNotes(remoteEntity, hash, sourceId) {
    const localEntity = sql.getRowOrNull("SELECT * FROM recent_notes WHERE noteId = ?", [remoteEntity.noteId]);

    if (shouldWeUpdateEntity(localEntity, remoteEntity)) {
        sql.transactional(() => {
            sql.replace('recent_notes', remoteEntity);

            entityChangesService.addEntityChange('recent_notes', remoteEntity.noteId, hash, sourceId);
        });

        return true;
    }

    return false;
}

function updateAttribute(remoteEntity, hash, sourceId) {
    const localEntity = sql.getRow("SELECT * FROM attributes WHERE attributeId = ?", [remoteEntity.attributeId]);

    if (shouldWeUpdateEntity(localEntity, remoteEntity)) {
        sql.transactional(() => {
            sql.replace("attributes", remoteEntity);

            entityChangesService.addEntityChange('attributes', remoteEntity.attributeId, hash, sourceId);
        });

        return true;
    }

    return false;
}

function updateApiToken(entity, hash, sourceId) {
    const apiTokenId = sql.getRow("SELECT * FROM api_tokens WHERE apiTokenId = ?", [entity.apiTokenId]);

    if (!apiTokenId) {
        sql.transactional(() => {
            sql.replace("api_tokens", entity);

            entityChangesService.addEntityChange('api_tokens',entity.apiTokenId, hash, sourceId);
        });

        return true;
    }

    return false;
}

module.exports = {
    updateEntity
};