mirror of
https://github.com/zadam/trilium.git
synced 2025-10-27 16:26:31 +01:00
994 lines
33 KiB
HTML
994 lines
33 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: entities/note.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: entities/note.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="prettyprint source linenums"><code>"use strict";
|
|
|
|
const Entity = require('./entity');
|
|
const Attribute = require('./attribute');
|
|
const protectedSessionService = require('../services/protected_session');
|
|
const sql = require('../services/sql');
|
|
const utils = require('../services/utils');
|
|
const dateUtils = require('../services/date_utils');
|
|
const entityChangesService = require('../services/entity_changes.js');
|
|
|
|
const LABEL = 'label';
|
|
const RELATION = 'relation';
|
|
|
|
/**
|
|
* This represents a Note which is a central object in the Trilium Notes project.
|
|
*
|
|
* @property {string} noteId - primary key
|
|
* @property {string} type - one of "text", "code", "file" or "render"
|
|
* @property {string} mime - MIME type, e.g. "text/html"
|
|
* @property {string} title - note title
|
|
* @property {boolean} isProtected - true if note is protected
|
|
* @property {boolean} isDeleted - true if note is deleted
|
|
* @property {string|null} deleteId - ID identifying delete transaction
|
|
* @property {string} dateCreated - local date time (with offset)
|
|
* @property {string} dateModified - local date time (with offset)
|
|
* @property {string} utcDateCreated
|
|
* @property {string} utcDateModified
|
|
*
|
|
* @extends Entity
|
|
*/
|
|
class Note extends Entity {
|
|
static get entityName() { return "notes"; }
|
|
static get primaryKeyName() { return "noteId"; }
|
|
static get hashedProperties() { return ["noteId", "title", "type", "mime", "isProtected", "isDeleted", "deleteId"]; }
|
|
|
|
/**
|
|
* @param row - object containing database row from "notes" table
|
|
*/
|
|
constructor(row) {
|
|
super(row);
|
|
|
|
this.isProtected = !!this.isProtected;
|
|
/* true if content is either not encrypted
|
|
* or encrypted, but with available protected session (so effectively decrypted) */
|
|
this.isContentAvailable = true;
|
|
|
|
// check if there's noteId, otherwise this is a new entity which wasn't encrypted yet
|
|
if (this.isProtected && this.noteId) {
|
|
this.isContentAvailable = protectedSessionService.isProtectedSessionAvailable();
|
|
|
|
if (this.isContentAvailable) {
|
|
try {
|
|
this.title = protectedSessionService.decryptString(this.title);
|
|
}
|
|
catch (e) {
|
|
throw new Error(`Could not decrypt title of note ${this.noteId}: ${e.message} ${e.stack}`)
|
|
}
|
|
}
|
|
else {
|
|
this.title = "[protected]";
|
|
}
|
|
}
|
|
}
|
|
|
|
/*
|
|
* Note content has quite special handling - it's not a separate entity, but a lazily loaded
|
|
* part of Note entity with it's own sync. Reasons behind this hybrid design has been:
|
|
*
|
|
* - content can be quite large and it's not necessary to load it / fill memory for any note access even if we don't need a content, especially for bulk operations like search
|
|
* - changes in the note metadata or title should not trigger note content sync (so we keep separate utcDateModified and entity changes records)
|
|
* - but to the user note content and title changes are one and the same - single dateModified (so all changes must go through Note and content is not a separate entity)
|
|
*/
|
|
|
|
/** @returns {*} */
|
|
getContent(silentNotFoundError = false) {
|
|
if (this.content === undefined) {
|
|
const row = sql.getRow(`SELECT content FROM note_contents WHERE noteId = ?`, [this.noteId]);
|
|
|
|
if (!row) {
|
|
if (silentNotFoundError) {
|
|
return undefined;
|
|
}
|
|
else {
|
|
throw new Error("Cannot find note content for noteId=" + this.noteId);
|
|
}
|
|
}
|
|
|
|
this.content = row.content;
|
|
|
|
if (this.isProtected) {
|
|
if (this.isContentAvailable) {
|
|
this.content = this.content === null ? null : protectedSessionService.decrypt(this.content);
|
|
}
|
|
else {
|
|
this.content = "";
|
|
}
|
|
}
|
|
}
|
|
|
|
if (this.isStringNote()) {
|
|
return this.content === null
|
|
? ""
|
|
: this.content.toString("UTF-8");
|
|
}
|
|
else {
|
|
return this.content;
|
|
}
|
|
}
|
|
|
|
/** @returns {{contentLength, dateModified, utcDateModified}} */
|
|
getContentMetadata() {
|
|
return sql.getRow(`
|
|
SELECT
|
|
LENGTH(content) AS contentLength,
|
|
dateModified,
|
|
utcDateModified
|
|
FROM note_contents
|
|
WHERE noteId = ?`, [this.noteId]);
|
|
}
|
|
|
|
/** @returns {*} */
|
|
getJsonContent() {
|
|
const content = this.getContent();
|
|
|
|
if (!content || !content.trim()) {
|
|
return null;
|
|
}
|
|
|
|
return JSON.parse(content);
|
|
}
|
|
|
|
setContent(content) {
|
|
if (content === null || content === undefined) {
|
|
throw new Error(`Cannot set null content to note ${this.noteId}`);
|
|
}
|
|
|
|
if (this.isStringNote()) {
|
|
content = content.toString();
|
|
}
|
|
else {
|
|
content = Buffer.isBuffer(content) ? content : Buffer.from(content);
|
|
}
|
|
|
|
this.content = content;
|
|
|
|
const pojo = {
|
|
noteId: this.noteId,
|
|
content: content,
|
|
dateModified: dateUtils.localNowDateTime(),
|
|
utcDateModified: dateUtils.utcNowDateTime()
|
|
};
|
|
|
|
if (this.isProtected) {
|
|
if (this.isContentAvailable) {
|
|
pojo.content = protectedSessionService.encrypt(pojo.content);
|
|
}
|
|
else {
|
|
throw new Error(`Cannot update content of noteId=${this.noteId} since we're out of protected session.`);
|
|
}
|
|
}
|
|
|
|
sql.upsert("note_contents", "noteId", pojo);
|
|
|
|
const hash = utils.hash(this.noteId + "|" + pojo.content.toString());
|
|
|
|
entityChangesService.addEntityChange({
|
|
entityName: 'note_contents',
|
|
entityId: this.noteId,
|
|
hash: hash,
|
|
isErased: false,
|
|
utcDateChanged: pojo.utcDateModified
|
|
}, null);
|
|
}
|
|
|
|
setJsonContent(content) {
|
|
this.setContent(JSON.stringify(content, null, '\t'));
|
|
}
|
|
|
|
/** @returns {boolean} true if this note is the root of the note tree. Root note has "root" noteId */
|
|
isRoot() {
|
|
return this.noteId === 'root';
|
|
}
|
|
|
|
/** @returns {boolean} true if this note is of application/json content type */
|
|
isJson() {
|
|
return this.mime === "application/json";
|
|
}
|
|
|
|
/** @returns {boolean} true if this note is JavaScript (code or attachment) */
|
|
isJavaScript() {
|
|
return (this.type === "code" || this.type === "file")
|
|
&& (this.mime.startsWith("application/javascript")
|
|
|| this.mime === "application/x-javascript"
|
|
|| this.mime === "text/javascript");
|
|
}
|
|
|
|
/** @returns {boolean} true if this note is HTML */
|
|
isHtml() {
|
|
return (this.type === "code" || this.type === "file" || this.type === "render") && this.mime === "text/html";
|
|
}
|
|
|
|
/** @returns {boolean} true if the note has string content (not binary) */
|
|
isStringNote() {
|
|
return utils.isStringNote(this.type, this.mime);
|
|
}
|
|
|
|
/** @returns {string} JS script environment - either "frontend" or "backend" */
|
|
getScriptEnv() {
|
|
if (this.isHtml() || (this.isJavaScript() && this.mime.endsWith('env=frontend'))) {
|
|
return "frontend";
|
|
}
|
|
|
|
if (this.type === 'render') {
|
|
return "frontend";
|
|
}
|
|
|
|
if (this.isJavaScript() && this.mime.endsWith('env=backend')) {
|
|
return "backend";
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
loadOwnedAttributesToCache() {
|
|
this.__ownedAttributeCache = this.repository.getEntities(`SELECT * FROM attributes WHERE isDeleted = 0 AND noteId = ?`, [this.noteId]);
|
|
return this.__ownedAttributeCache;
|
|
}
|
|
|
|
/**
|
|
* This method is a faster variant of getAttributes() which looks for only owned attributes.
|
|
* Use when inheritance is not needed and/or in batch/performance sensitive operations.
|
|
*
|
|
* @param {string} [type] - (optional) attribute type to filter
|
|
* @param {string} [name] - (optional) attribute name to filter
|
|
* @returns {Attribute[]} note's "owned" attributes - excluding inherited ones
|
|
*/
|
|
getOwnedAttributes(type, name) {
|
|
if (!this.__ownedAttributeCache) {
|
|
this.loadOwnedAttributesToCache();
|
|
}
|
|
|
|
if (type && name) {
|
|
return this.__ownedAttributeCache.filter(attr => attr.type === type && attr.name === name);
|
|
}
|
|
else if (type) {
|
|
return this.__ownedAttributeCache.filter(attr => attr.type === type);
|
|
}
|
|
else if (name) {
|
|
return this.__ownedAttributeCache.filter(attr => attr.name === name);
|
|
}
|
|
else {
|
|
return this.__ownedAttributeCache.slice();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @returns {Attribute} attribute belonging to this specific note (excludes inherited attributes)
|
|
*
|
|
* This method can be significantly faster than the getAttribute()
|
|
*/
|
|
getOwnedAttribute(type, name) {
|
|
const attrs = this.getOwnedAttributes(type, name);
|
|
|
|
return attrs.length > 0 ? attrs[0] : null;
|
|
}
|
|
|
|
/**
|
|
* @returns {Attribute[]} relations targetting this specific note
|
|
*/
|
|
getTargetRelations() {
|
|
return this.repository.getEntities("SELECT * FROM attributes WHERE type = 'relation' AND isDeleted = 0 AND value = ?", [this.noteId]);
|
|
}
|
|
|
|
/**
|
|
* @param {string} [type] - (optional) attribute type to filter
|
|
* @param {string} [name] - (optional) attribute name to filter
|
|
* @returns {Attribute[]} all note's attributes, including inherited ones
|
|
*/
|
|
getAttributes(type, name) {
|
|
if (!this.__attributeCache) {
|
|
this.loadAttributesToCache();
|
|
}
|
|
|
|
if (type && name) {
|
|
return this.__attributeCache.filter(attr => attr.type === type && attr.name === name);
|
|
}
|
|
else if (type) {
|
|
return this.__attributeCache.filter(attr => attr.type === type);
|
|
}
|
|
else if (name) {
|
|
return this.__attributeCache.filter(attr => attr.name === name);
|
|
}
|
|
else {
|
|
return this.__attributeCache.slice();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param {string} [name] - label name to filter
|
|
* @returns {Attribute[]} all note's labels (attributes with type label), including inherited ones
|
|
*/
|
|
getLabels(name) {
|
|
return this.getAttributes(LABEL, name);
|
|
}
|
|
|
|
/**
|
|
* @param {string} [name] - label name to filter
|
|
* @returns {Attribute[]} all note's labels (attributes with type label), excluding inherited ones
|
|
*/
|
|
getOwnedLabels(name) {
|
|
return this.getOwnedAttributes(LABEL, name);
|
|
}
|
|
|
|
/**
|
|
* @param {string} [name] - relation name to filter
|
|
* @returns {Attribute[]} all note's relations (attributes with type relation), including inherited ones
|
|
*/
|
|
getRelations(name) {
|
|
return this.getAttributes(RELATION, name);
|
|
}
|
|
|
|
/**
|
|
* @param {string} [name] - relation name to filter
|
|
* @returns {Attribute[]} all note's relations (attributes with type relation), excluding inherited ones
|
|
*/
|
|
getOwnedRelations(name) {
|
|
return this.getOwnedAttributes(RELATION, name);
|
|
}
|
|
|
|
/**
|
|
* @param {string} [name] - relation name to filter
|
|
* @returns {Note[]}
|
|
*/
|
|
getRelationTargets(name) {
|
|
const relations = this.getRelations(name);
|
|
const targets = [];
|
|
|
|
for (const relation of relations) {
|
|
targets.push(relation.getTargetNote());
|
|
}
|
|
|
|
return targets;
|
|
}
|
|
|
|
/**
|
|
* Clear note's attributes cache to force fresh reload for next attribute request.
|
|
* Cache is note instance scoped.
|
|
*/
|
|
invalidateAttributeCache() {
|
|
this.__attributeCache = null;
|
|
this.__ownedAttributeCache = null;
|
|
}
|
|
|
|
loadAttributesToCache() {
|
|
const attributes = this.repository.getEntities(`
|
|
WITH RECURSIVE
|
|
tree(noteId, level) AS (
|
|
SELECT ?, 0
|
|
UNION
|
|
SELECT branches.parentNoteId, tree.level + 1
|
|
FROM branches
|
|
JOIN tree ON branches.noteId = tree.noteId
|
|
WHERE branches.isDeleted = 0
|
|
),
|
|
treeWithAttrs(noteId, level) AS (
|
|
SELECT * FROM tree
|
|
UNION
|
|
SELECT attributes.value, treeWithAttrs.level FROM attributes
|
|
JOIN treeWithAttrs ON treeWithAttrs.noteId = attributes.noteId
|
|
WHERE attributes.isDeleted = 0
|
|
AND attributes.type = 'relation'
|
|
AND attributes.name = 'template'
|
|
)
|
|
SELECT attributes.* FROM attributes JOIN treeWithAttrs ON attributes.noteId = treeWithAttrs.noteId
|
|
WHERE attributes.isDeleted = 0 AND (attributes.isInheritable = 1 OR treeWithAttrs.level = 0)
|
|
ORDER BY level, noteId, position`, [this.noteId]);
|
|
// attributes are ordered so that "closest" attributes are first
|
|
// we order by noteId so that attributes from same note stay together. Actual noteId ordering doesn't matter.
|
|
|
|
const filteredAttributes = attributes.filter((attr, index) => {
|
|
// if this exact attribute already appears then don't include it (can happen via cloning)
|
|
if (attributes.findIndex(it => it.attributeId === attr.attributeId) !== index) {
|
|
return false;
|
|
}
|
|
|
|
// FIXME: this code is quite questionable, one problem is that other caches (Froca, Becca) have nothing like that
|
|
if (attr.isDefinition()) {
|
|
const firstDefinitionIndex = attributes.findIndex(el => el.type === attr.type && el.name === attr.name);
|
|
|
|
// keep only if this element is the first definition for this type & name
|
|
return firstDefinitionIndex === index;
|
|
}
|
|
else {
|
|
const definitionAttr = attributes.find(el => el.type === 'label' && el.name === attr.type + ':' + attr.name);
|
|
|
|
if (!definitionAttr) {
|
|
return true;
|
|
}
|
|
|
|
const definition = definitionAttr.getDefinition();
|
|
|
|
if (definition.multiplicity === 'multi') {
|
|
return true;
|
|
}
|
|
else {
|
|
const firstAttrIndex = attributes.findIndex(el => el.type === attr.type && el.name === attr.name);
|
|
|
|
// in case of single-valued attribute we'll keep it only if it's first (closest)
|
|
return firstAttrIndex === index;
|
|
}
|
|
}
|
|
});
|
|
|
|
this.__attributeCache = filteredAttributes;
|
|
}
|
|
|
|
/**
|
|
* @param {string} type - attribute type (label, relation, etc.)
|
|
* @param {string} name - attribute name
|
|
* @returns {boolean} true if note has an attribute with given type and name (including inherited)
|
|
*/
|
|
hasAttribute(type, name) {
|
|
return !!this.getAttribute(type, name);
|
|
}
|
|
|
|
/**
|
|
* @param {string} type - attribute type (label, relation, etc.)
|
|
* @param {string} name - attribute name
|
|
* @returns {boolean} true if note has an attribute with given type and name (excluding inherited)
|
|
*/
|
|
hasOwnedAttribute(type, name) {
|
|
return !!this.getOwnedAttribute(type, name);
|
|
}
|
|
|
|
/**
|
|
* @param {string} type - attribute type (label, relation, etc.)
|
|
* @param {string} name - attribute name
|
|
* @returns {Attribute} attribute of given type and name. If there's more such attributes, first is returned. Returns null if there's no such attribute belonging to this note.
|
|
*/
|
|
getAttribute(type, name) {
|
|
const attributes = this.getAttributes();
|
|
|
|
return attributes.find(attr => attr.type === type && attr.name === name);
|
|
}
|
|
|
|
/**
|
|
* @param {string} type - attribute type (label, relation, etc.)
|
|
* @param {string} name - attribute name
|
|
* @returns {string|null} attribute value of given type and name or null if no such attribute exists.
|
|
*/
|
|
getAttributeValue(type, name) {
|
|
const attr = this.getAttribute(type, name);
|
|
|
|
return attr ? attr.value : null;
|
|
}
|
|
|
|
/**
|
|
* @param {string} type - attribute type (label, relation, etc.)
|
|
* @param {string} name - attribute name
|
|
* @returns {string|null} attribute value of given type and name or null if no such attribute exists.
|
|
*/
|
|
getOwnedAttributeValue(type, name) {
|
|
const attr = this.getOwnedAttribute(type, name);
|
|
|
|
return attr ? attr.value : null;
|
|
}
|
|
|
|
/**
|
|
* Based on enabled, attribute is either set or removed.
|
|
*
|
|
* @param {string} type - attribute type ('relation', 'label' etc.)
|
|
* @param {boolean} enabled - toggle On or Off
|
|
* @param {string} name - attribute name
|
|
* @param {string} [value] - attribute value (optional)
|
|
*/
|
|
toggleAttribute(type, enabled, name, value) {
|
|
if (enabled) {
|
|
this.setAttribute(type, name, value);
|
|
}
|
|
else {
|
|
this.removeAttribute(type, name, value);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Update's given attribute's value or creates it if it doesn't exist
|
|
*
|
|
* @param {string} type - attribute type (label, relation, etc.)
|
|
* @param {string} name - attribute name
|
|
* @param {string} [value] - attribute value (optional)
|
|
*/
|
|
setAttribute(type, name, value) {
|
|
const attributes = this.loadOwnedAttributesToCache();
|
|
let attr = attributes.find(attr => attr.type === type && attr.name === name);
|
|
|
|
if (attr) {
|
|
if (attr.value !== value) {
|
|
attr.value = value;
|
|
attr.save();
|
|
|
|
this.invalidateAttributeCache();
|
|
}
|
|
}
|
|
else {
|
|
attr = new Attribute({
|
|
noteId: this.noteId,
|
|
type: type,
|
|
name: name,
|
|
value: value !== undefined ? value : ""
|
|
});
|
|
|
|
attr.save();
|
|
|
|
this.invalidateAttributeCache();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Removes given attribute name-value pair if it exists.
|
|
*
|
|
* @param {string} type - attribute type (label, relation, etc.)
|
|
* @param {string} name - attribute name
|
|
* @param {string} [value] - attribute value (optional)
|
|
*/
|
|
removeAttribute(type, name, value) {
|
|
const attributes = this.loadOwnedAttributesToCache();
|
|
|
|
for (const attribute of attributes) {
|
|
if (attribute.type === type && attribute.name === name && (value === undefined || value === attribute.value)) {
|
|
attribute.isDeleted = true;
|
|
attribute.save();
|
|
|
|
this.invalidateAttributeCache();
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return {Attribute}
|
|
*/
|
|
addAttribute(type, name, value = "", isInheritable = false, position = 1000) {
|
|
const attr = new Attribute({
|
|
noteId: this.noteId,
|
|
type: type,
|
|
name: name,
|
|
value: value,
|
|
isInheritable: isInheritable,
|
|
position: position
|
|
});
|
|
|
|
attr.save();
|
|
|
|
this.invalidateAttributeCache();
|
|
|
|
return attr;
|
|
}
|
|
|
|
addLabel(name, value = "", isInheritable = false) {
|
|
return this.addAttribute(LABEL, name, value, isInheritable);
|
|
}
|
|
|
|
addRelation(name, targetNoteId, isInheritable = false) {
|
|
return this.addAttribute(RELATION, name, targetNoteId, isInheritable);
|
|
}
|
|
|
|
/**
|
|
* @param {string} name - label name
|
|
* @returns {boolean} true if label exists (including inherited)
|
|
*/
|
|
hasLabel(name) { return this.hasAttribute(LABEL, name); }
|
|
|
|
/**
|
|
* @param {string} name - label name
|
|
* @returns {boolean} true if label exists (excluding inherited)
|
|
*/
|
|
hasOwnedLabel(name) { return this.hasOwnedAttribute(LABEL, name); }
|
|
|
|
/**
|
|
* @param {string} name - relation name
|
|
* @returns {boolean} true if relation exists (including inherited)
|
|
*/
|
|
hasRelation(name) { return this.hasAttribute(RELATION, name); }
|
|
|
|
/**
|
|
* @param {string} name - relation name
|
|
* @returns {boolean} true if relation exists (excluding inherited)
|
|
*/
|
|
hasOwnedRelation(name) { return this.hasOwnedAttribute(RELATION, name); }
|
|
|
|
/**
|
|
* @param {string} name - label name
|
|
* @returns {Attribute|null} label if it exists, null otherwise
|
|
*/
|
|
getLabel(name) { return this.getAttribute(LABEL, name); }
|
|
|
|
/**
|
|
* @param {string} name - label name
|
|
* @returns {Attribute|null} label if it exists, null otherwise
|
|
*/
|
|
getOwnedLabel(name) { return this.getOwnedAttribute(LABEL, name); }
|
|
|
|
/**
|
|
* @param {string} name - relation name
|
|
* @returns {Attribute|null} relation if it exists, null otherwise
|
|
*/
|
|
getRelation(name) { return this.getAttribute(RELATION, name); }
|
|
|
|
/**
|
|
* @param {string} name - relation name
|
|
* @returns {Attribute|null} relation if it exists, null otherwise
|
|
*/
|
|
getOwnedRelation(name) { return this.getOwnedAttribute(RELATION, name); }
|
|
|
|
/**
|
|
* @param {string} name - label name
|
|
* @returns {string|null} label value if label exists, null otherwise
|
|
*/
|
|
getLabelValue(name) { return this.getAttributeValue(LABEL, name); }
|
|
|
|
/**
|
|
* @param {string} name - label name
|
|
* @returns {string|null} label value if label exists, null otherwise
|
|
*/
|
|
getOwnedLabelValue(name) { return this.getOwnedAttributeValue(LABEL, name); }
|
|
|
|
/**
|
|
* @param {string} name - relation name
|
|
* @returns {string|null} relation value if relation exists, null otherwise
|
|
*/
|
|
getRelationValue(name) { return this.getAttributeValue(RELATION, name); }
|
|
|
|
/**
|
|
* @param {string} name - relation name
|
|
* @returns {string|null} relation value if relation exists, null otherwise
|
|
*/
|
|
getOwnedRelationValue(name) { return this.getOwnedAttributeValue(RELATION, name); }
|
|
|
|
/**
|
|
* @param {string} name
|
|
* @returns {Note|null} target note of the relation or null (if target is empty or note was not found)
|
|
*/
|
|
getRelationTarget(name) {
|
|
const relation = this.getRelation(name);
|
|
|
|
return relation ? this.repository.getNote(relation.value) : null;
|
|
}
|
|
|
|
/**
|
|
* @param {string} name
|
|
* @returns {Note|null} target note of the relation or null (if target is empty or note was not found)
|
|
*/
|
|
getOwnedRelationTarget(name) {
|
|
const relation = this.getOwnedRelation(name);
|
|
|
|
return relation ? this.repository.getNote(relation.value) : null;
|
|
}
|
|
|
|
/**
|
|
* Based on enabled, label is either set or removed.
|
|
*
|
|
* @param {boolean} enabled - toggle On or Off
|
|
* @param {string} name - label name
|
|
* @param {string} [value] - label value (optional)
|
|
*/
|
|
toggleLabel(enabled, name, value) { return this.toggleAttribute(LABEL, enabled, name, value); }
|
|
|
|
/**
|
|
* Based on enabled, relation is either set or removed.
|
|
*
|
|
* @param {boolean} enabled - toggle On or Off
|
|
* @param {string} name - relation name
|
|
* @param {string} [value] - relation value (noteId)
|
|
*/
|
|
toggleRelation(enabled, name, value) { return this.toggleAttribute(RELATION, enabled, name, value); }
|
|
|
|
/**
|
|
* Update's given label's value or creates it if it doesn't exist
|
|
*
|
|
* @param {string} name - label name
|
|
* @param {string} [value] - label value
|
|
*/
|
|
setLabel(name, value) { return this.setAttribute(LABEL, name, value); }
|
|
|
|
/**
|
|
* Update's given relation's value or creates it if it doesn't exist
|
|
*
|
|
* @param {string} name - relation name
|
|
* @param {string} value - relation value (noteId)
|
|
*/
|
|
setRelation(name, value) { return this.setAttribute(RELATION, name, value); }
|
|
|
|
/**
|
|
* Remove label name-value pair, if it exists.
|
|
*
|
|
* @param {string} name - label name
|
|
* @param {string} [value] - label value
|
|
*/
|
|
removeLabel(name, value) { return this.removeAttribute(LABEL, name, value); }
|
|
|
|
/**
|
|
* Remove relation name-value pair, if it exists.
|
|
*
|
|
* @param {string} name - relation name
|
|
* @param {string} [value] - relation value (noteId)
|
|
*/
|
|
removeRelation(name, value) { return this.removeAttribute(RELATION, name, value); }
|
|
|
|
/**
|
|
* @return {string[]} return list of all descendant noteIds of this note. Returning just noteIds because number of notes can be huge. Includes also this note's noteId
|
|
*/
|
|
getDescendantNoteIds() {
|
|
return sql.getColumn(`
|
|
WITH RECURSIVE
|
|
tree(noteId) AS (
|
|
SELECT ?
|
|
UNION
|
|
SELECT branches.noteId FROM branches
|
|
JOIN tree ON branches.parentNoteId = tree.noteId
|
|
JOIN notes ON notes.noteId = branches.noteId
|
|
WHERE notes.isDeleted = 0
|
|
AND branches.isDeleted = 0
|
|
)
|
|
SELECT noteId FROM tree`, [this.noteId]);
|
|
}
|
|
|
|
/**
|
|
* Finds descendant notes with given attribute name and value. Only own attributes are considered, not inherited ones
|
|
*
|
|
* @param {string} type - attribute type (label, relation, etc.)
|
|
* @param {string} name - attribute name
|
|
* @param {string} [value] - attribute value
|
|
* @returns {Note[]}
|
|
*/
|
|
getDescendantNotesWithAttribute(type, name, value) {
|
|
const params = [this.noteId, name];
|
|
let valueCondition = "";
|
|
|
|
if (value !== undefined) {
|
|
params.push(value);
|
|
valueCondition = " AND attributes.value = ?";
|
|
}
|
|
|
|
const notes = this.repository.getEntities(`
|
|
WITH RECURSIVE
|
|
tree(noteId) AS (
|
|
SELECT ?
|
|
UNION
|
|
SELECT branches.noteId FROM branches
|
|
JOIN tree ON branches.parentNoteId = tree.noteId
|
|
JOIN notes ON notes.noteId = branches.noteId
|
|
WHERE notes.isDeleted = 0
|
|
AND branches.isDeleted = 0
|
|
)
|
|
SELECT notes.* FROM notes
|
|
JOIN tree ON tree.noteId = notes.noteId
|
|
JOIN attributes ON attributes.noteId = notes.noteId
|
|
WHERE attributes.isDeleted = 0
|
|
AND attributes.name = ?
|
|
${valueCondition}
|
|
ORDER BY noteId, position`, params);
|
|
|
|
return notes;
|
|
}
|
|
|
|
/**
|
|
* Finds descendant notes with given label name and value. Only own labels are considered, not inherited ones
|
|
*
|
|
* @param {string} name - label name
|
|
* @param {string} [value] - label value
|
|
* @returns {Note[]}
|
|
*/
|
|
getDescendantNotesWithLabel(name, value) { return this.getDescendantNotesWithAttribute(LABEL, name, value); }
|
|
|
|
/**
|
|
* Finds descendant notes with given relation name and value. Only own relations are considered, not inherited ones
|
|
*
|
|
* @param {string} name - relation name
|
|
* @param {string} [value] - relation value
|
|
* @returns {Note[]}
|
|
*/
|
|
getDescendantNotesWithRelation(name, value) { return this.getDescendantNotesWithAttribute(RELATION, name, value); }
|
|
|
|
/**
|
|
* Returns note revisions of this note.
|
|
*
|
|
* @returns {NoteRevision[]}
|
|
*/
|
|
getRevisions() {
|
|
return this.repository.getEntities("SELECT * FROM note_revisions WHERE noteId = ?", [this.noteId]);
|
|
}
|
|
|
|
/**
|
|
* Get list of links coming out of this note.
|
|
*
|
|
* @deprecated - not intended for general use
|
|
* @returns {Attribute[]}
|
|
*/
|
|
getLinks() {
|
|
return this.repository.getEntities(`
|
|
SELECT *
|
|
FROM attributes
|
|
WHERE noteId = ? AND
|
|
isDeleted = 0 AND
|
|
type = 'relation' AND
|
|
name IN ('internalLink', 'imageLink', 'relationMapLink', 'includeNoteLink')`, [this.noteId]);
|
|
}
|
|
|
|
/**
|
|
* @returns {Branch[]}
|
|
*/
|
|
getBranches() {
|
|
return this.repository.getEntities("SELECT * FROM branches WHERE isDeleted = 0 AND noteId = ?", [this.noteId]);
|
|
}
|
|
|
|
/**
|
|
* @returns {boolean} - true if note has children
|
|
*/
|
|
hasChildren() {
|
|
return this.getChildNotes().length > 0;
|
|
}
|
|
|
|
/**
|
|
* @returns {Note[]} child notes of this note
|
|
*/
|
|
getChildNotes() {
|
|
return this.repository.getEntities(`
|
|
SELECT notes.*
|
|
FROM branches
|
|
JOIN notes USING(noteId)
|
|
WHERE notes.isDeleted = 0
|
|
AND branches.isDeleted = 0
|
|
AND branches.parentNoteId = ?
|
|
ORDER BY branches.notePosition`, [this.noteId]);
|
|
}
|
|
|
|
/**
|
|
* @returns {Branch[]} child branches of this note
|
|
*/
|
|
getChildBranches() {
|
|
return this.repository.getEntities(`
|
|
SELECT branches.*
|
|
FROM branches
|
|
WHERE branches.isDeleted = 0
|
|
AND branches.parentNoteId = ?
|
|
ORDER BY branches.notePosition`, [this.noteId]);
|
|
}
|
|
|
|
/**
|
|
* @returns {Note[]} parent notes of this note (note can have multiple parents because of cloning)
|
|
*/
|
|
getParentNotes() {
|
|
return this.repository.getEntities(`
|
|
SELECT parent_notes.*
|
|
FROM
|
|
branches AS child_tree
|
|
JOIN notes AS parent_notes ON parent_notes.noteId = child_tree.parentNoteId
|
|
WHERE child_tree.noteId = ?
|
|
AND child_tree.isDeleted = 0
|
|
AND parent_notes.isDeleted = 0`, [this.noteId]);
|
|
}
|
|
|
|
/**
|
|
* @return {string[][]} - array of notePaths (each represented by array of noteIds constituting the particular note path)
|
|
*/
|
|
getAllNotePaths() {
|
|
if (this.noteId === 'root') {
|
|
return [['root']];
|
|
}
|
|
|
|
const notePaths = [];
|
|
|
|
for (const parentNote of this.getParentNotes()) {
|
|
for (const parentPath of parentNote.getAllNotePaths()) {
|
|
parentPath.push(this.noteId);
|
|
notePaths.push(parentPath);
|
|
}
|
|
}
|
|
|
|
return notePaths;
|
|
}
|
|
|
|
getRelationDefinitions() {
|
|
return this.getLabels()
|
|
.filter(l => l.name.startsWith("relation:"));
|
|
}
|
|
|
|
getLabelDefinitions() {
|
|
return this.getLabels()
|
|
.filter(l => l.name.startsWith("relation:"));
|
|
}
|
|
|
|
/**
|
|
* @param ancestorNoteId
|
|
* @return {boolean} - true if ancestorNoteId occurs in at least one of the note's paths
|
|
*/
|
|
isDescendantOfNote(ancestorNoteId) {
|
|
const notePaths = this.getAllNotePaths();
|
|
|
|
return notePaths.some(path => path.includes(ancestorNoteId));
|
|
}
|
|
|
|
beforeSaving() {
|
|
if (!this.isDeleted) {
|
|
this.isDeleted = false;
|
|
}
|
|
|
|
if (!this.dateCreated) {
|
|
this.dateCreated = dateUtils.localNowDateTime();
|
|
}
|
|
|
|
if (!this.utcDateCreated) {
|
|
this.utcDateCreated = dateUtils.utcNowDateTime();
|
|
}
|
|
|
|
super.beforeSaving();
|
|
|
|
this.dateModified = dateUtils.localNowDateTime();
|
|
this.utcDateModified = dateUtils.utcNowDateTime();
|
|
}
|
|
|
|
// cannot be static!
|
|
updatePojo(pojo) {
|
|
if (pojo.isProtected) {
|
|
if (this.isContentAvailable) {
|
|
pojo.title = protectedSessionService.encrypt(pojo.title);
|
|
}
|
|
else {
|
|
// updating protected note outside of protected session means we will keep original ciphertexts
|
|
delete pojo.title;
|
|
}
|
|
}
|
|
|
|
delete pojo.isContentAvailable;
|
|
delete pojo.__attributeCache;
|
|
delete pojo.__ownedAttributeCache;
|
|
delete pojo.content;
|
|
/** zero references to contentHash, probably can be removed */
|
|
delete pojo.contentHash;
|
|
}
|
|
}
|
|
|
|
module.exports = Note;
|
|
</code></pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<nav>
|
|
<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="ApiToken.html">ApiToken</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="Entity.html">Entity</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>
|
|
</nav>
|
|
|
|
<br class="clear">
|
|
|
|
<footer>
|
|
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a>
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|