mirror of
https://github.com/zadam/trilium.git
synced 2025-10-31 19:49:01 +01:00
276 lines
8.1 KiB
TypeScript
276 lines
8.1 KiB
TypeScript
/**
|
||
* @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
|
||
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
|
||
*/
|
||
|
||
/**
|
||
* @module admonition/admonitioncommand
|
||
*/
|
||
|
||
import { Command, first } from 'ckeditor5';
|
||
import type { DocumentFragment, Element, Position, Range, Schema, Writer } from 'ckeditor5';
|
||
|
||
/**
|
||
* The block quote command plugin.
|
||
*
|
||
* @extends module:core/command~Command
|
||
*/
|
||
|
||
export const ADMONITION_TYPES = [ "note", "tip", "important", "caution", "warning" ] as const;
|
||
export const ADMONITION_TYPE_ATTRIBUTE = "admonitionType";
|
||
export const DEFAULT_ADMONITION_TYPE = ADMONITION_TYPES[0];
|
||
export type AdmonitionType = typeof ADMONITION_TYPES[number];
|
||
|
||
interface ExecuteOpts {
|
||
/**
|
||
* If set, it will force the command behavior. If `true`, the command will apply a block quote,
|
||
* otherwise the command will remove the block quote. If not set, the command will act basing on its current value.
|
||
*/
|
||
forceValue?: AdmonitionType;
|
||
/**
|
||
* If set to true and `forceValue` is not specified, the command will apply the previous admonition type (if the command was already executed).
|
||
*/
|
||
usePreviousChoice?: boolean
|
||
}
|
||
|
||
export default class AdmonitionCommand extends Command {
|
||
/**
|
||
* Whether the selection starts in a block quote.
|
||
*
|
||
* @observable
|
||
* @readonly
|
||
*/
|
||
declare public value: AdmonitionType | false;
|
||
|
||
private _lastType?: AdmonitionType;
|
||
|
||
/**
|
||
* @inheritDoc
|
||
*/
|
||
public override refresh(): void {
|
||
this.value = this._getValue();
|
||
this.isEnabled = this._checkEnabled();
|
||
}
|
||
|
||
/**
|
||
* Executes the command. When the command {@link #value is on}, all top-most block quotes within
|
||
* the selection will be removed. If it is off, all selected blocks will be wrapped with
|
||
* a block quote.
|
||
*
|
||
* @fires execute
|
||
* @param options Command options.
|
||
*/
|
||
public override execute( options: ExecuteOpts = {} ): void {
|
||
const model = this.editor.model;
|
||
const schema = model.schema;
|
||
const selection = model.document.selection;
|
||
|
||
const blocks = Array.from( selection.getSelectedBlocks() );
|
||
|
||
const value = this._getType(options);
|
||
|
||
model.change( writer => {
|
||
if ( !value ) {
|
||
this._removeQuote( writer, blocks.filter( findQuote ) );
|
||
} else {
|
||
const blocksToQuote = blocks.filter( block => {
|
||
// Already quoted blocks needs to be considered while quoting too
|
||
// in order to reuse their <bQ> elements.
|
||
return findQuote( block ) || checkCanBeQuoted( schema, block );
|
||
} );
|
||
|
||
this._applyQuote( writer, blocksToQuote, value);
|
||
}
|
||
} );
|
||
}
|
||
|
||
private _getType(options: ExecuteOpts): AdmonitionType | false {
|
||
const value = (options.forceValue === undefined) ? !this.value : options.forceValue;
|
||
|
||
// Allow removing the admonition.
|
||
if (!value) {
|
||
return false;
|
||
}
|
||
|
||
// Prefer the type from the command, if any.
|
||
if (typeof value === "string") {
|
||
return value;
|
||
}
|
||
|
||
// See if we can restore the previous language.
|
||
if (options.usePreviousChoice && this._lastType) {
|
||
return this._lastType;
|
||
}
|
||
|
||
// Otherwise return a default.
|
||
return "note";
|
||
}
|
||
|
||
/**
|
||
* Checks the command's {@link #value}.
|
||
*/
|
||
private _getValue(): AdmonitionType | false {
|
||
const selection = this.editor.model.document.selection;
|
||
const firstBlock = first( selection.getSelectedBlocks() );
|
||
if (!firstBlock) {
|
||
return false;
|
||
}
|
||
|
||
// In the current implementation, the admonition must be an immediate parent of a block element.
|
||
const firstQuote = findQuote( firstBlock );
|
||
if (firstQuote?.is("element")) {
|
||
return firstQuote.getAttribute(ADMONITION_TYPE_ATTRIBUTE) as AdmonitionType;
|
||
}
|
||
|
||
return false;
|
||
}
|
||
|
||
/**
|
||
* Checks whether the command can be enabled in the current context.
|
||
*
|
||
* @returns Whether the command should be enabled.
|
||
*/
|
||
private _checkEnabled(): boolean {
|
||
if ( this.value ) {
|
||
return true;
|
||
}
|
||
|
||
const selection = this.editor.model.document.selection;
|
||
const schema = this.editor.model.schema;
|
||
|
||
const firstBlock = first( selection.getSelectedBlocks() );
|
||
|
||
if ( !firstBlock ) {
|
||
return false;
|
||
}
|
||
|
||
return checkCanBeQuoted( schema, firstBlock );
|
||
}
|
||
|
||
/**
|
||
* Removes the quote from given blocks.
|
||
*
|
||
* If blocks which are supposed to be "unquoted" are in the middle of a quote,
|
||
* start it or end it, then the quote will be split (if needed) and the blocks
|
||
* will be moved out of it, so other quoted blocks remained quoted.
|
||
*/
|
||
private _removeQuote( writer: Writer, blocks: Array<Element> ): void {
|
||
// Unquote all groups of block. Iterate in the reverse order to not break following ranges.
|
||
getRangesOfBlockGroups( writer, blocks ).reverse().forEach( groupRange => {
|
||
if ( groupRange.start.isAtStart && groupRange.end.isAtEnd ) {
|
||
writer.unwrap( groupRange.start.parent as Element );
|
||
|
||
return;
|
||
}
|
||
|
||
// The group of blocks are at the beginning of an <bQ> so let's move them left (out of the <bQ>).
|
||
if ( groupRange.start.isAtStart ) {
|
||
const positionBefore = writer.createPositionBefore( groupRange.start.parent as Element );
|
||
|
||
writer.move( groupRange, positionBefore );
|
||
|
||
return;
|
||
}
|
||
|
||
// The blocks are in the middle of an <bQ> so we need to split the <bQ> after the last block
|
||
// so we move the items there.
|
||
if ( !groupRange.end.isAtEnd ) {
|
||
writer.split( groupRange.end );
|
||
}
|
||
|
||
// Now we are sure that groupRange.end.isAtEnd is true, so let's move the blocks right.
|
||
|
||
const positionAfter = writer.createPositionAfter( groupRange.end.parent as Element );
|
||
|
||
writer.move( groupRange, positionAfter );
|
||
} );
|
||
}
|
||
|
||
/**
|
||
* Applies the quote to given blocks.
|
||
*/
|
||
private _applyQuote( writer: Writer, blocks: Array<Element>, type?: AdmonitionType): void {
|
||
this._lastType = type;
|
||
const quotesToMerge: Array<Element | DocumentFragment> = [];
|
||
|
||
// Quote all groups of block. Iterate in the reverse order to not break following ranges.
|
||
getRangesOfBlockGroups( writer, blocks ).reverse().forEach( groupRange => {
|
||
let quote = findQuote( groupRange.start );
|
||
|
||
if ( !quote ) {
|
||
const attributes: Record<string, unknown> = {};
|
||
attributes[ADMONITION_TYPE_ATTRIBUTE] = type;
|
||
quote = writer.createElement( 'aside', attributes);
|
||
|
||
writer.wrap( groupRange, quote );
|
||
} else if (quote.is("element")) {
|
||
this.editor.model.change((writer) => {
|
||
writer.setAttribute(ADMONITION_TYPE_ATTRIBUTE, type, quote as Element);
|
||
});
|
||
}
|
||
|
||
quotesToMerge.push( quote );
|
||
} );
|
||
|
||
// Merge subsequent <bQ> elements. Reverse the order again because this time we want to go through
|
||
// the <bQ> elements in the source order (due to how merge works – it moves the right element's content
|
||
// to the first element and removes the right one. Since we may need to merge a couple of subsequent `<bQ>` elements
|
||
// we want to keep the reference to the first (furthest left) one.
|
||
quotesToMerge.reverse().reduce( ( currentQuote, nextQuote ) => {
|
||
if ( currentQuote.nextSibling == nextQuote ) {
|
||
writer.merge( writer.createPositionAfter( currentQuote ) );
|
||
|
||
return currentQuote;
|
||
}
|
||
|
||
return nextQuote;
|
||
} );
|
||
}
|
||
}
|
||
|
||
function findQuote( elementOrPosition: Element | Position ): Element | DocumentFragment | null {
|
||
return elementOrPosition.parent!.name == 'aside' ? elementOrPosition.parent : null;
|
||
}
|
||
|
||
/**
|
||
* Returns a minimal array of ranges containing groups of subsequent blocks.
|
||
*
|
||
* content: abcdefgh
|
||
* blocks: [ a, b, d, f, g, h ]
|
||
* output ranges: [ab]c[d]e[fgh]
|
||
*/
|
||
function getRangesOfBlockGroups( writer: Writer, blocks: Array<Element> ): Array<Range> {
|
||
let startPosition;
|
||
let i = 0;
|
||
const ranges = [];
|
||
|
||
while ( i < blocks.length ) {
|
||
const block = blocks[ i ];
|
||
const nextBlock = blocks[ i + 1 ];
|
||
|
||
if ( !startPosition ) {
|
||
startPosition = writer.createPositionBefore( block );
|
||
}
|
||
|
||
if ( !nextBlock || block.nextSibling != nextBlock ) {
|
||
ranges.push( writer.createRange( startPosition, writer.createPositionAfter( block ) ) );
|
||
startPosition = null;
|
||
}
|
||
|
||
i++;
|
||
}
|
||
|
||
return ranges;
|
||
}
|
||
|
||
/**
|
||
* Checks whether <bQ> can wrap the block.
|
||
*/
|
||
function checkCanBeQuoted( schema: Schema, block: Element ): boolean {
|
||
// TMP will be replaced with schema.checkWrap().
|
||
const isBQAllowed = schema.checkChild( block.parent as Element, 'aside' );
|
||
const isBlockAllowedInBQ = schema.checkChild( [ '$root', 'aside' ], block );
|
||
|
||
return isBQAllowed && isBlockAllowedInBQ;
|
||
}
|