-
Notifications
You must be signed in to change notification settings - Fork 3.6k
/
linkediting.ts
371 lines (307 loc) · 11.6 KB
/
linkediting.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
/**
* @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 link/linkediting
*/
import {
Plugin,
type Editor
} from 'ckeditor5/src/core.js';
import type {
Schema,
Writer,
ViewElement,
ViewDocumentKeyDownEvent,
ViewDocumentClickEvent,
DocumentSelectionChangeAttributeEvent
} from 'ckeditor5/src/engine.js';
import {
Input,
TwoStepCaretMovement,
inlineHighlight
} from 'ckeditor5/src/typing.js';
import {
ClipboardPipeline,
type ClipboardContentInsertionEvent
} from 'ckeditor5/src/clipboard.js';
import { keyCodes, env } from 'ckeditor5/src/utils.js';
import LinkCommand from './linkcommand.js';
import UnlinkCommand from './unlinkcommand.js';
import ManualDecorator from './utils/manualdecorator.js';
import {
createLinkElement,
ensureSafeUrl,
getLocalizedDecorators,
normalizeDecorators,
openLink,
addLinkProtocolIfApplicable,
type NormalizedLinkDecoratorAutomaticDefinition,
type NormalizedLinkDecoratorManualDefinition
} from './utils.js';
import '../theme/link.css';
const HIGHLIGHT_CLASS = 'ck-link_selected';
const DECORATOR_AUTOMATIC = 'automatic';
const DECORATOR_MANUAL = 'manual';
const EXTERNAL_LINKS_REGEXP = /^(https?:)?\/\//;
/**
* The link engine feature.
*
* It introduces the `linkHref="url"` attribute in the model which renders to the view as a `<a href="url">` element
* as well as `'link'` and `'unlink'` commands.
*/
export default class LinkEditing extends Plugin {
/**
* @inheritDoc
*/
public static get pluginName() {
return 'LinkEditing' as const;
}
/**
* @inheritDoc
*/
public static get requires() {
// Clipboard is required for handling cut and paste events while typing over the link.
return [ TwoStepCaretMovement, Input, ClipboardPipeline ] as const;
}
/**
* @inheritDoc
*/
constructor( editor: Editor ) {
super( editor );
editor.config.define( 'link', {
allowCreatingEmptyLinks: false,
addTargetToExternalLinks: false
} );
}
/**
* @inheritDoc
*/
public init(): void {
const editor = this.editor;
const allowedProtocols = this.editor.config.get( 'link.allowedProtocols' );
// Allow link attribute on all inline nodes.
editor.model.schema.extend( '$text', { allowAttributes: 'linkHref' } );
editor.conversion.for( 'dataDowncast' )
.attributeToElement( { model: 'linkHref', view: createLinkElement } );
editor.conversion.for( 'editingDowncast' )
.attributeToElement( { model: 'linkHref', view: ( href, conversionApi ) => {
return createLinkElement( ensureSafeUrl( href, allowedProtocols ), conversionApi );
} } );
editor.conversion.for( 'upcast' )
.elementToAttribute( {
view: {
name: 'a',
attributes: {
href: true
}
},
model: {
key: 'linkHref',
value: ( viewElement: ViewElement ) => viewElement.getAttribute( 'href' )
}
} );
// Create linking commands.
editor.commands.add( 'link', new LinkCommand( editor ) );
editor.commands.add( 'unlink', new UnlinkCommand( editor ) );
const linkDecorators = getLocalizedDecorators( editor.t, normalizeDecorators( editor.config.get( 'link.decorators' ) ) );
this._enableAutomaticDecorators( linkDecorators
.filter( ( item ): item is NormalizedLinkDecoratorAutomaticDefinition => item.mode === DECORATOR_AUTOMATIC ) );
this._enableManualDecorators( linkDecorators
.filter( ( item ): item is NormalizedLinkDecoratorManualDefinition => item.mode === DECORATOR_MANUAL ) );
// Enable two-step caret movement for `linkHref` attribute.
const twoStepCaretMovementPlugin = editor.plugins.get( TwoStepCaretMovement );
twoStepCaretMovementPlugin.registerAttribute( 'linkHref' );
// Setup highlight over selected link.
inlineHighlight( editor, 'linkHref', 'a', HIGHLIGHT_CLASS );
// Handle link following by CTRL+click or ALT+ENTER
this._enableLinkOpen();
// Clears the DocumentSelection decorator attributes if the selection is no longer in a link (for example while using 2-SCM).
this._enableSelectionAttributesFixer();
// Handle adding default protocol to pasted links.
this._enableClipboardIntegration();
}
/**
* Processes an array of configured {@link module:link/linkconfig~LinkDecoratorAutomaticDefinition automatic decorators}
* and registers a {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher downcast dispatcher}
* for each one of them. Downcast dispatchers are obtained using the
* {@link module:link/utils/automaticdecorators~AutomaticDecorators#getDispatcher} method.
*
* **Note**: This method also activates the automatic external link decorator if enabled with
* {@link module:link/linkconfig~LinkConfig#addTargetToExternalLinks `config.link.addTargetToExternalLinks`}.
*/
private _enableAutomaticDecorators( automaticDecoratorDefinitions: Array<NormalizedLinkDecoratorAutomaticDefinition> ): void {
const editor = this.editor;
// Store automatic decorators in the command instance as we do the same with manual decorators.
// Thanks to that, `LinkImageEditing` plugin can re-use the same definitions.
const command: LinkCommand = editor.commands.get( 'link' )!;
const automaticDecorators = command.automaticDecorators;
// Adds a default decorator for external links.
if ( editor.config.get( 'link.addTargetToExternalLinks' ) ) {
automaticDecorators.add( {
id: 'linkIsExternal',
mode: DECORATOR_AUTOMATIC,
callback: url => !!url && EXTERNAL_LINKS_REGEXP.test( url ),
attributes: {
target: '_blank',
rel: 'noopener noreferrer'
}
} );
}
automaticDecorators.add( automaticDecoratorDefinitions );
if ( automaticDecorators.length ) {
editor.conversion.for( 'downcast' ).add( automaticDecorators.getDispatcher() );
}
}
/**
* Processes an array of configured {@link module:link/linkconfig~LinkDecoratorManualDefinition manual decorators},
* transforms them into {@link module:link/utils/manualdecorator~ManualDecorator} instances and stores them in the
* {@link module:link/linkcommand~LinkCommand#manualDecorators} collection (a model for manual decorators state).
*
* Also registers an {@link module:engine/conversion/downcasthelpers~DowncastHelpers#attributeToElement attribute-to-element}
* converter for each manual decorator and extends the {@link module:engine/model/schema~Schema model's schema}
* with adequate model attributes.
*/
private _enableManualDecorators( manualDecoratorDefinitions: Array<NormalizedLinkDecoratorManualDefinition> ): void {
if ( !manualDecoratorDefinitions.length ) {
return;
}
const editor = this.editor;
const command: LinkCommand = editor.commands.get( 'link' )!;
const manualDecorators = command.manualDecorators;
manualDecoratorDefinitions.forEach( decoratorDefinition => {
editor.model.schema.extend( '$text', { allowAttributes: decoratorDefinition.id } );
// Keeps reference to manual decorator to decode its name to attributes during downcast.
const decorator = new ManualDecorator( decoratorDefinition );
manualDecorators.add( decorator );
editor.conversion.for( 'downcast' ).attributeToElement( {
model: decorator.id,
view: ( manualDecoratorValue, { writer, schema }, { item } ) => {
// Manual decorators for block links are handled e.g. in LinkImageEditing.
if ( !( item.is( 'selection' ) || schema.isInline( item ) ) ) {
return;
}
if ( manualDecoratorValue ) {
const element = writer.createAttributeElement( 'a', decorator.attributes, { priority: 5 } );
if ( decorator.classes ) {
writer.addClass( decorator.classes, element );
}
for ( const key in decorator.styles ) {
writer.setStyle( key, decorator.styles[ key ], element );
}
writer.setCustomProperty( 'link', true, element );
return element;
}
}
} );
editor.conversion.for( 'upcast' ).elementToAttribute( {
view: {
name: 'a',
...decorator._createPattern()
},
model: {
key: decorator.id
}
} );
} );
}
/**
* Attaches handlers for {@link module:engine/view/document~Document#event:enter} and
* {@link module:engine/view/document~Document#event:click} to enable link following.
*/
private _enableLinkOpen(): void {
const editor = this.editor;
const view = editor.editing.view;
const viewDocument = view.document;
this.listenTo<ViewDocumentClickEvent>( viewDocument, 'click', ( evt, data ) => {
const shouldOpen = env.isMac ? data.domEvent.metaKey : data.domEvent.ctrlKey;
if ( !shouldOpen ) {
return;
}
let clickedElement: Element | null = data.domTarget;
if ( clickedElement.tagName.toLowerCase() != 'a' ) {
clickedElement = clickedElement.closest( 'a' );
}
if ( !clickedElement ) {
return;
}
const url = clickedElement.getAttribute( 'href' );
if ( !url ) {
return;
}
evt.stop();
data.preventDefault();
openLink( url );
}, { context: '$capture' } );
// Open link on Alt+Enter.
this.listenTo<ViewDocumentKeyDownEvent>( viewDocument, 'keydown', ( evt, data ) => {
const linkCommand: LinkCommand = editor.commands.get( 'link' )!;
const url = linkCommand!.value;
const shouldOpen = !!url && data.keyCode === keyCodes.enter && data.altKey;
if ( !shouldOpen ) {
return;
}
evt.stop();
openLink( url );
} );
}
/**
* Watches the DocumentSelection attribute changes and removes link decorator attributes when the linkHref attribute is removed.
*
* This is to ensure that there is no left-over link decorator attributes on the document selection that is no longer in a link.
*/
private _enableSelectionAttributesFixer(): void {
const editor = this.editor;
const model = editor.model;
const selection = model.document.selection;
this.listenTo<DocumentSelectionChangeAttributeEvent>( selection, 'change:attribute', ( evt, { attributeKeys } ) => {
if ( !attributeKeys.includes( 'linkHref' ) || selection.hasAttribute( 'linkHref' ) ) {
return;
}
model.change( writer => {
removeLinkAttributesFromSelection( writer, getLinkAttributesAllowedOnText( model.schema ) );
} );
} );
}
/**
* Enables URL fixing on pasting.
*/
private _enableClipboardIntegration(): void {
const editor = this.editor;
const model = editor.model;
const defaultProtocol = this.editor.config.get( 'link.defaultProtocol' );
if ( !defaultProtocol ) {
return;
}
this.listenTo<ClipboardContentInsertionEvent>( editor.plugins.get( 'ClipboardPipeline' ), 'contentInsertion', ( evt, data ) => {
model.change( writer => {
const range = writer.createRangeIn( data.content );
for ( const item of range.getItems() ) {
if ( item.hasAttribute( 'linkHref' ) ) {
const newLink = addLinkProtocolIfApplicable( item.getAttribute( 'linkHref' ) as string, defaultProtocol );
writer.setAttribute( 'linkHref', newLink, item );
}
}
} );
} );
}
}
/**
* Make the selection free of link-related model attributes.
* All link-related model attributes start with "link". That includes not only "linkHref"
* but also all decorator attributes (they have dynamic names), or even custom plugins.
*/
function removeLinkAttributesFromSelection( writer: Writer, linkAttributes: Array<string> ): void {
writer.removeSelectionAttribute( 'linkHref' );
for ( const attribute of linkAttributes ) {
writer.removeSelectionAttribute( attribute );
}
}
/**
* Returns an array containing names of the attributes allowed on `$text` that describes the link item.
*/
function getLinkAttributesAllowedOnText( schema: Schema ): Array<string> {
const textAttributes = schema.getDefinition( '$text' )!.allowAttributes;
return textAttributes.filter( attribute => attribute.startsWith( 'link' ) );
}