Notes/src/routes/api/notes.ts

"use strict";

import noteService from "../../services/notes.js";
import eraseService from "../../services/erase.js";
import treeService from "../../services/tree.js";
import sql from "../../services/sql.js";
import utils from "../../services/utils.js";
import log from "../../services/log.js";
import TaskContext from "../../services/task_context.js";
import becca from "../../becca/becca.js";
import ValidationError from "../../errors/validation_error.js";
import blobService from "../../services/blob.js";
import type { Request } from "express";
import type BBranch from "../../becca/entities/bbranch.js";
import type { AttributeRow } from "../../becca/entities/rows.js";

/**
 * @swagger
 * /api/notes/{noteId}:
 *   get:
 *     summary: Retrieve note metadata
 *     operationId: notes-get
 *     parameters:
 *       - name: noteId
 *         in: path
 *         required: true
 *         schema:
 *           $ref: "#/components/schemas/NoteId"
 *     responses:
 *       '200':
 *         description: Note metadata
 *         content:
 *           application/json:
 *             schema:
 *              allOf:
 *                - $ref: '#/components/schemas/Note'
 *                - $ref: "#/components/schemas/Timestamps"
 *     security:
 *       - session: []
 *     tags: ["data"]
 */
function getNote(req: Request) {
    return becca.getNoteOrThrow(req.params.noteId);
}

/**
 * @swagger
 * /api/notes/{noteId}/blob:
 *   get:
 *     summary: Retrieve note content
 *     operationId: notes-blob
 *     parameters:
 *       - name: noteId
 *         in: path
 *         required: true
 *         schema:
 *           $ref: "#/components/schemas/NoteId"
 *     responses:
 *       '304':
 *         description: Note content
 *         content:
 *           application/json:
 *             schema:
 *              $ref: '#/components/schemas/Blob'
 *     security:
 *       - session: []
 *     tags: ["data"]
 */
function getNoteBlob(req: Request) {
    return blobService.getBlobPojo("notes", req.params.noteId);
}

/**
 * @swagger
 * /api/notes/{noteId}/metadata:
 *   get:
 *     summary: Retrieve note metadata (limited to timestamps)
 *     operationId: notes-metadata
 *     parameters:
 *       - name: noteId
 *         in: path
 *         required: true
 *         schema:
 *           $ref: "#/components/schemas/NoteId"
 *     responses:
 *       '200':
 *         description: Note metadata
 *         content:
 *           application/json:
 *             schema:
 *              $ref: "#/components/schemas/Timestamps"
 *     security:
 *       - session: []
 *     tags: ["data"]
 */
function getNoteMetadata(req: Request) {
    const note = becca.getNoteOrThrow(req.params.noteId);

    return {
        dateCreated: note.dateCreated,
        utcDateCreated: note.utcDateCreated,
        dateModified: note.dateModified,
        utcDateModified: note.utcDateModified
    };
}

function createNote(req: Request) {
    const params = Object.assign({}, req.body); // clone
    params.parentNoteId = req.params.parentNoteId;

    const { target, targetBranchId } = req.query;

    if (target !== "into" && target !== "after") {
        throw new ValidationError("Invalid target type.");
    }

    if (targetBranchId && typeof targetBranchId !== "string") {
        throw new ValidationError("Missing or incorrect type for target branch ID.");
    }

    const { note, branch } = noteService.createNewNoteWithTarget(target, targetBranchId, params);

    return {
        note,
        branch
    };
}

function updateNoteData(req: Request) {
    const { content, attachments } = req.body;
    const { noteId } = req.params;

    return noteService.updateNoteData(noteId, content, attachments);
}

/**
 * @swagger
 * /api/notes/{noteId}:
 *   delete:
 *     summary: Delete note
 *     operationId: notes-delete
 *     parameters:
 *       - name: noteId
 *         in: path
 *         required: true
 *         schema:
 *           $ref: "#/components/schemas/NoteId"
 *       - name: taskId
 *         in: query
 *         required: true
 *         schema:
 *           type: string
 *         description: Task group identifier
 *       - name: eraseNotes
 *         in: query
 *         schema:
 *           type: boolean
 *         required: false
 *         description: Whether to erase the note immediately
 *       - name: last
 *         in: query
 *         schema:
 *           type: boolean
 *         required: true
 *         description: Whether this is the last request of this task group
 *     responses:
 *       '200':
 *         description: Note successfully deleted
 *     security:
 *       - session: []
 *     tags: ["data"]
 */
function deleteNote(req: Request) {
    const noteId = req.params.noteId;
    const taskId = req.query.taskId;
    const eraseNotes = req.query.eraseNotes === "true";
    const last = req.query.last === "true";

    // note how deleteId is separate from taskId - single taskId produces separate deleteId for each "top level" deleted note
    const deleteId = utils.randomString(10);

    const note = becca.getNoteOrThrow(noteId);

    if (typeof taskId !== "string") {
        throw new ValidationError("Missing or incorrect type for task ID.");
    }
    const taskContext = TaskContext.getInstance(taskId, "deleteNotes");

    note.deleteNote(deleteId, taskContext);

    if (eraseNotes) {
        eraseService.eraseNotesWithDeleteId(deleteId);
    }

    if (last) {
        taskContext.taskSucceeded();
    }
}

function undeleteNote(req: Request) {
    const taskContext = TaskContext.getInstance(utils.randomString(10), "undeleteNotes");

    noteService.undeleteNote(req.params.noteId, taskContext);

    taskContext.taskSucceeded();
}

function sortChildNotes(req: Request) {
    const noteId = req.params.noteId;
    const { sortBy, sortDirection, foldersFirst, sortNatural, sortLocale } = req.body;

    log.info(`Sorting '${noteId}' children with ${sortBy} ${sortDirection}, foldersFirst=${foldersFirst}, sortNatural=${sortNatural}, sortLocale=${sortLocale}`);

    const reverse = sortDirection === "desc";

    treeService.sortNotes(noteId, sortBy, reverse, foldersFirst, sortNatural, sortLocale);
}

function protectNote(req: Request) {
    const noteId = req.params.noteId;
    const note = becca.notes[noteId];
    const protect = !!parseInt(req.params.isProtected);
    const includingSubTree = !!parseInt(req.query?.subtree as string);

    const taskContext = new TaskContext(utils.randomString(10), "protectNotes", { protect });

    noteService.protectNoteRecursively(note, protect, includingSubTree, taskContext);

    taskContext.taskSucceeded();
}

function setNoteTypeMime(req: Request) {
    // can't use [] destructuring because req.params is not iterable
    const { noteId } = req.params;
    const { type, mime } = req.body;

    const note = becca.getNoteOrThrow(noteId);
    note.type = type;
    note.mime = mime;
    note.save();
}

function changeTitle(req: Request) {
    const noteId = req.params.noteId;
    const title = req.body.title;

    const note = becca.getNoteOrThrow(noteId);

    if (!note.isContentAvailable()) {
        throw new ValidationError(`Note '${noteId}' is not available for change`);
    }

    const noteTitleChanged = note.title !== title;

    if (noteTitleChanged) {
        noteService.saveRevisionIfNeeded(note);
    }

    note.title = title;

    note.save();

    if (noteTitleChanged) {
        noteService.triggerNoteTitleChanged(note);
    }

    return note;
}

function duplicateSubtree(req: Request) {
    const { noteId, parentNoteId } = req.params;

    return noteService.duplicateSubtree(noteId, parentNoteId);
}

function eraseDeletedNotesNow() {
    eraseService.eraseDeletedNotesNow();
}

function eraseUnusedAttachmentsNow() {
    eraseService.eraseUnusedAttachmentsNow();
}

function getDeleteNotesPreview(req: Request) {
    const { branchIdsToDelete, deleteAllClones } = req.body;

    const noteIdsToBeDeleted = new Set<string>();
    const strongBranchCountToDelete: Record<string, number> = {}; // noteId => count

    function branchPreviewDeletion(branch: BBranch) {
        if (branch.isWeak || !branch.branchId) {
            return;
        }

        strongBranchCountToDelete[branch.branchId] = strongBranchCountToDelete[branch.branchId] || 0;
        strongBranchCountToDelete[branch.branchId]++;

        const note = branch.getNote();

        if (deleteAllClones || note.getStrongParentBranches().length <= strongBranchCountToDelete[branch.branchId]) {
            noteIdsToBeDeleted.add(note.noteId);

            for (const childBranch of note.getChildBranches()) {
                branchPreviewDeletion(childBranch);
            }
        }
    }

    for (const branchId of branchIdsToDelete) {
        const branch = becca.getBranch(branchId);

        if (!branch) {
            log.error(`Branch ${branchId} was not found and delete preview can't be calculated for this note.`);

            continue;
        }

        branchPreviewDeletion(branch);
    }

    let brokenRelations: AttributeRow[] = [];

    if (noteIdsToBeDeleted.size > 0) {
        sql.fillParamList(noteIdsToBeDeleted);

        // FIXME: No need to do this in database, can be done with becca data
        brokenRelations = sql
            .getRows<AttributeRow>(
                `
            SELECT attr.noteId, attr.name, attr.value
            FROM attributes attr
                    JOIN param_list ON param_list.paramId = attr.value
            WHERE attr.isDeleted = 0
            AND attr.type = 'relation'`
            )
            .filter((attr) => attr.noteId && !noteIdsToBeDeleted.has(attr.noteId));
    }

    return {
        noteIdsToBeDeleted: Array.from(noteIdsToBeDeleted),
        brokenRelations
    };
}

function forceSaveRevision(req: Request) {
    const { noteId } = req.params;
    const note = becca.getNoteOrThrow(noteId);

    if (!note.isContentAvailable()) {
        throw new ValidationError(`Note revision of a protected note cannot be created outside of a protected session.`);
    }

    note.saveRevision();
}

function convertNoteToAttachment(req: Request) {
    const { noteId } = req.params;
    const note = becca.getNoteOrThrow(noteId);

    return {
        attachment: note.convertToParentAttachment()
    };
}

export default {
    getNote,
    getNoteBlob,
    getNoteMetadata,
    updateNoteData,
    deleteNote,
    undeleteNote,
    createNote,
    sortChildNotes,
    protectNote,
    setNoteTypeMime,
    changeTitle,
    duplicateSubtree,
    eraseDeletedNotesNow,
    eraseUnusedAttachmentsNow,
    getDeleteNotesPreview,
    forceSaveRevision,
    convertNoteToAttachment
};