@ckeditor/ckeditor5-image 39.0.1 → 40.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (182) hide show
  1. package/CHANGELOG.md +1 -1
  2. package/LICENSE.md +1 -1
  3. package/README.md +3 -3
  4. package/build/image.js +1 -1
  5. package/build/image.js.map +1 -0
  6. package/build/translations/pt-br.js +1 -1
  7. package/ckeditor5-metadata.json +12 -0
  8. package/lang/translations/ar.po +1 -0
  9. package/lang/translations/ast.po +1 -0
  10. package/lang/translations/az.po +1 -0
  11. package/lang/translations/bg.po +1 -0
  12. package/lang/translations/bn.po +1 -0
  13. package/lang/translations/bs.po +1 -0
  14. package/lang/translations/ca.po +1 -0
  15. package/lang/translations/cs.po +1 -0
  16. package/lang/translations/da.po +1 -0
  17. package/lang/translations/de-ch.po +1 -0
  18. package/lang/translations/de.po +1 -0
  19. package/lang/translations/el.po +1 -0
  20. package/lang/translations/en-au.po +1 -0
  21. package/lang/translations/en-gb.po +1 -0
  22. package/lang/translations/en.po +1 -0
  23. package/lang/translations/eo.po +1 -0
  24. package/lang/translations/es.po +1 -0
  25. package/lang/translations/et.po +1 -0
  26. package/lang/translations/eu.po +1 -0
  27. package/lang/translations/fa.po +1 -0
  28. package/lang/translations/fi.po +1 -0
  29. package/lang/translations/fr.po +1 -0
  30. package/lang/translations/gl.po +1 -0
  31. package/lang/translations/he.po +1 -0
  32. package/lang/translations/hi.po +1 -0
  33. package/lang/translations/hr.po +1 -0
  34. package/lang/translations/hu.po +1 -0
  35. package/lang/translations/id.po +1 -0
  36. package/lang/translations/it.po +1 -0
  37. package/lang/translations/ja.po +1 -0
  38. package/lang/translations/jv.po +1 -0
  39. package/lang/translations/km.po +1 -0
  40. package/lang/translations/kn.po +1 -0
  41. package/lang/translations/ko.po +1 -0
  42. package/lang/translations/ku.po +1 -0
  43. package/lang/translations/lt.po +1 -0
  44. package/lang/translations/lv.po +1 -0
  45. package/lang/translations/ms.po +1 -0
  46. package/lang/translations/nb.po +1 -0
  47. package/lang/translations/ne.po +1 -0
  48. package/lang/translations/nl.po +1 -0
  49. package/lang/translations/no.po +1 -0
  50. package/lang/translations/pl.po +1 -0
  51. package/lang/translations/pt-br.po +2 -1
  52. package/lang/translations/pt.po +1 -0
  53. package/lang/translations/ro.po +1 -0
  54. package/lang/translations/ru.po +1 -0
  55. package/lang/translations/si.po +1 -0
  56. package/lang/translations/sk.po +1 -0
  57. package/lang/translations/sq.po +1 -0
  58. package/lang/translations/sr-latn.po +1 -0
  59. package/lang/translations/sr.po +1 -0
  60. package/lang/translations/sv.po +1 -0
  61. package/lang/translations/th.po +1 -0
  62. package/lang/translations/tk.po +1 -0
  63. package/lang/translations/tr.po +1 -0
  64. package/lang/translations/tt.po +1 -0
  65. package/lang/translations/ug.po +1 -0
  66. package/lang/translations/uk.po +1 -0
  67. package/lang/translations/ur.po +1 -0
  68. package/lang/translations/uz.po +1 -0
  69. package/lang/translations/vi.po +1 -0
  70. package/lang/translations/zh-cn.po +1 -0
  71. package/lang/translations/zh.po +1 -0
  72. package/package.json +3 -7
  73. package/src/augmentation.d.ts +56 -55
  74. package/src/augmentation.js +5 -5
  75. package/src/autoimage.d.ts +52 -52
  76. package/src/autoimage.js +132 -132
  77. package/src/image/converters.d.ts +66 -66
  78. package/src/image/converters.js +232 -242
  79. package/src/image/imageblockediting.d.ts +58 -55
  80. package/src/image/imageblockediting.js +152 -136
  81. package/src/image/imageediting.d.ts +30 -30
  82. package/src/image/imageediting.js +63 -74
  83. package/src/image/imageinlineediting.d.ts +59 -56
  84. package/src/image/imageinlineediting.js +176 -160
  85. package/src/image/imageloadobserver.d.ts +48 -48
  86. package/src/image/imageloadobserver.js +52 -52
  87. package/src/image/imagetypecommand.d.ts +44 -40
  88. package/src/image/imagetypecommand.js +80 -77
  89. package/src/image/insertimagecommand.d.ts +66 -66
  90. package/src/image/insertimagecommand.js +120 -120
  91. package/src/image/replaceimagesourcecommand.d.ts +34 -34
  92. package/src/image/replaceimagesourcecommand.js +44 -44
  93. package/src/image/ui/utils.d.ts +25 -25
  94. package/src/image/ui/utils.js +44 -44
  95. package/src/image/utils.d.ts +64 -52
  96. package/src/image/utils.js +121 -100
  97. package/src/image.d.ts +34 -34
  98. package/src/image.js +38 -38
  99. package/src/imageblock.d.ts +33 -33
  100. package/src/imageblock.js +37 -37
  101. package/src/imagecaption/imagecaptionediting.d.ts +89 -89
  102. package/src/imagecaption/imagecaptionediting.js +225 -225
  103. package/src/imagecaption/imagecaptionui.d.ts +26 -26
  104. package/src/imagecaption/imagecaptionui.js +61 -61
  105. package/src/imagecaption/imagecaptionutils.d.ts +38 -38
  106. package/src/imagecaption/imagecaptionutils.js +62 -62
  107. package/src/imagecaption/toggleimagecaptioncommand.d.ts +66 -66
  108. package/src/imagecaption/toggleimagecaptioncommand.js +138 -138
  109. package/src/imagecaption.d.ts +26 -26
  110. package/src/imagecaption.js +30 -30
  111. package/src/imageconfig.d.ts +713 -713
  112. package/src/imageconfig.js +5 -5
  113. package/src/imageinline.d.ts +33 -33
  114. package/src/imageinline.js +37 -37
  115. package/src/imageinsert/imageinsertui.d.ts +44 -44
  116. package/src/imageinsert/imageinsertui.js +141 -141
  117. package/src/imageinsert/ui/imageinsertformrowview.d.ts +61 -61
  118. package/src/imageinsert/ui/imageinsertformrowview.js +54 -54
  119. package/src/imageinsert/ui/imageinsertpanelview.d.ts +106 -106
  120. package/src/imageinsert/ui/imageinsertpanelview.js +161 -161
  121. package/src/imageinsert/utils.d.ts +25 -25
  122. package/src/imageinsert/utils.js +58 -58
  123. package/src/imageinsert.d.ts +33 -33
  124. package/src/imageinsert.js +37 -37
  125. package/src/imageinsertviaurl.d.ts +30 -30
  126. package/src/imageinsertviaurl.js +34 -34
  127. package/src/imageresize/imageresizebuttons.d.ts +67 -67
  128. package/src/imageresize/imageresizebuttons.js +217 -217
  129. package/src/imageresize/imageresizeediting.d.ts +37 -37
  130. package/src/imageresize/imageresizeediting.js +165 -114
  131. package/src/imageresize/imageresizehandles.d.ts +31 -30
  132. package/src/imageresize/imageresizehandles.js +114 -107
  133. package/src/imageresize/resizeimagecommand.d.ts +42 -42
  134. package/src/imageresize/resizeimagecommand.js +63 -61
  135. package/src/imageresize.d.ts +27 -27
  136. package/src/imageresize.js +31 -31
  137. package/src/imagesizeattributes.d.ts +34 -0
  138. package/src/imagesizeattributes.js +143 -0
  139. package/src/imagestyle/converters.d.ts +24 -24
  140. package/src/imagestyle/converters.js +79 -79
  141. package/src/imagestyle/imagestylecommand.d.ts +68 -65
  142. package/src/imagestyle/imagestylecommand.js +107 -101
  143. package/src/imagestyle/imagestyleediting.d.ts +50 -50
  144. package/src/imagestyle/imagestyleediting.js +108 -108
  145. package/src/imagestyle/imagestyleui.d.ts +56 -56
  146. package/src/imagestyle/imagestyleui.js +192 -192
  147. package/src/imagestyle/utils.d.ts +101 -101
  148. package/src/imagestyle/utils.js +329 -329
  149. package/src/imagestyle.d.ts +32 -32
  150. package/src/imagestyle.js +36 -36
  151. package/src/imagetextalternative/imagetextalternativecommand.d.ts +34 -34
  152. package/src/imagetextalternative/imagetextalternativecommand.js +44 -44
  153. package/src/imagetextalternative/imagetextalternativeediting.d.ts +28 -28
  154. package/src/imagetextalternative/imagetextalternativeediting.js +35 -35
  155. package/src/imagetextalternative/imagetextalternativeui.d.ts +68 -68
  156. package/src/imagetextalternative/imagetextalternativeui.js +173 -173
  157. package/src/imagetextalternative/ui/textalternativeformview.d.ts +72 -72
  158. package/src/imagetextalternative/ui/textalternativeformview.js +121 -121
  159. package/src/imagetextalternative.d.ts +29 -29
  160. package/src/imagetextalternative.js +33 -33
  161. package/src/imagetoolbar.d.ts +35 -35
  162. package/src/imagetoolbar.js +57 -57
  163. package/src/imageupload/imageuploadediting.d.ts +111 -111
  164. package/src/imageupload/imageuploadediting.js +337 -335
  165. package/src/imageupload/imageuploadprogress.d.ts +42 -42
  166. package/src/imageupload/imageuploadprogress.js +211 -211
  167. package/src/imageupload/imageuploadui.d.ts +23 -23
  168. package/src/imageupload/imageuploadui.js +57 -57
  169. package/src/imageupload/uploadimagecommand.d.ts +60 -60
  170. package/src/imageupload/uploadimagecommand.js +100 -100
  171. package/src/imageupload/utils.d.ts +33 -33
  172. package/src/imageupload/utils.js +112 -112
  173. package/src/imageupload.d.ts +32 -32
  174. package/src/imageupload.js +36 -36
  175. package/src/imageutils.d.ts +125 -102
  176. package/src/imageutils.js +306 -248
  177. package/src/index.d.ts +48 -47
  178. package/src/index.js +39 -38
  179. package/src/pictureediting.d.ts +88 -88
  180. package/src/pictureediting.js +130 -130
  181. package/theme/image.css +38 -11
  182. package/theme/imageresize.css +5 -0
@@ -1,335 +1,337 @@
1
- /**
2
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /**
6
- * @module image/imageupload/imageuploadediting
7
- */
8
- import { Plugin } from 'ckeditor5/src/core';
9
- import { UpcastWriter } from 'ckeditor5/src/engine';
10
- import { Notification } from 'ckeditor5/src/ui';
11
- import { ClipboardPipeline } from 'ckeditor5/src/clipboard';
12
- import { FileRepository } from 'ckeditor5/src/upload';
13
- import { env } from 'ckeditor5/src/utils';
14
- import ImageUtils from '../imageutils';
15
- import UploadImageCommand from './uploadimagecommand';
16
- import { fetchLocalImage, isLocalImage } from '../../src/imageupload/utils';
17
- import { createImageTypeRegExp } from './utils';
18
- /**
19
- * The editing part of the image upload feature. It registers the `'uploadImage'` command
20
- * and the `imageUpload` command as an aliased name.
21
- *
22
- * When an image is uploaded, it fires the {@link ~ImageUploadEditing#event:uploadComplete `uploadComplete`} event
23
- * that allows adding custom attributes to the {@link module:engine/model/element~Element image element}.
24
- */
25
- export default class ImageUploadEditing extends Plugin {
26
- /**
27
- * @inheritDoc
28
- */
29
- static get requires() {
30
- return [FileRepository, Notification, ClipboardPipeline, ImageUtils];
31
- }
32
- static get pluginName() {
33
- return 'ImageUploadEditing';
34
- }
35
- /**
36
- * @inheritDoc
37
- */
38
- constructor(editor) {
39
- super(editor);
40
- editor.config.define('image', {
41
- upload: {
42
- types: ['jpeg', 'png', 'gif', 'bmp', 'webp', 'tiff']
43
- }
44
- });
45
- this._uploadImageElements = new Map();
46
- }
47
- /**
48
- * @inheritDoc
49
- */
50
- init() {
51
- const editor = this.editor;
52
- const doc = editor.model.document;
53
- const conversion = editor.conversion;
54
- const fileRepository = editor.plugins.get(FileRepository);
55
- const imageUtils = editor.plugins.get('ImageUtils');
56
- const clipboardPipeline = editor.plugins.get('ClipboardPipeline');
57
- const imageTypes = createImageTypeRegExp(editor.config.get('image.upload.types'));
58
- const uploadImageCommand = new UploadImageCommand(editor);
59
- // Register `uploadImage` command and add `imageUpload` command as an alias for backward compatibility.
60
- editor.commands.add('uploadImage', uploadImageCommand);
61
- editor.commands.add('imageUpload', uploadImageCommand);
62
- // Register upcast converter for uploadId.
63
- conversion.for('upcast')
64
- .attributeToAttribute({
65
- view: {
66
- name: 'img',
67
- key: 'uploadId'
68
- },
69
- model: 'uploadId'
70
- });
71
- // Handle pasted images.
72
- // For every image file, a new file loader is created and a placeholder image is
73
- // inserted into the content. Then, those images are uploaded once they appear in the model
74
- // (see Document#change listener below).
75
- this.listenTo(editor.editing.view.document, 'clipboardInput', (evt, data) => {
76
- // Skip if non empty HTML data is included.
77
- // https://github.com/ckeditor/ckeditor5-upload/issues/68
78
- if (isHtmlIncluded(data.dataTransfer)) {
79
- return;
80
- }
81
- const images = Array.from(data.dataTransfer.files).filter(file => {
82
- // See https://github.com/ckeditor/ckeditor5-image/pull/254.
83
- if (!file) {
84
- return false;
85
- }
86
- return imageTypes.test(file.type);
87
- });
88
- if (!images.length) {
89
- return;
90
- }
91
- evt.stop();
92
- editor.model.change(writer => {
93
- // Set selection to paste target.
94
- if (data.targetRanges) {
95
- writer.setSelection(data.targetRanges.map(viewRange => editor.editing.mapper.toModelRange(viewRange)));
96
- }
97
- // Upload images after the selection has changed in order to ensure the command's state is refreshed.
98
- editor.model.enqueueChange(() => {
99
- editor.execute('uploadImage', { file: images });
100
- });
101
- });
102
- });
103
- // Handle HTML pasted with images with base64 or blob sources.
104
- // For every image file, a new file loader is created and a placeholder image is
105
- // inserted into the content. Then, those images are uploaded once they appear in the model
106
- // (see Document#change listener below).
107
- this.listenTo(clipboardPipeline, 'inputTransformation', (evt, data) => {
108
- const fetchableImages = Array.from(editor.editing.view.createRangeIn(data.content))
109
- .map(value => value.item)
110
- .filter(viewElement => isLocalImage(imageUtils, viewElement) &&
111
- !viewElement.getAttribute('uploadProcessed'))
112
- .map(viewElement => { return { promise: fetchLocalImage(viewElement), imageElement: viewElement }; });
113
- if (!fetchableImages.length) {
114
- return;
115
- }
116
- const writer = new UpcastWriter(editor.editing.view.document);
117
- for (const fetchableImage of fetchableImages) {
118
- // Set attribute marking that the image was processed already.
119
- writer.setAttribute('uploadProcessed', true, fetchableImage.imageElement);
120
- const loader = fileRepository.createLoader(fetchableImage.promise);
121
- if (loader) {
122
- writer.setAttribute('src', '', fetchableImage.imageElement);
123
- writer.setAttribute('uploadId', loader.id, fetchableImage.imageElement);
124
- }
125
- }
126
- });
127
- // Prevents from the browser redirecting to the dropped image.
128
- editor.editing.view.document.on('dragover', (evt, data) => {
129
- data.preventDefault();
130
- });
131
- // Upload placeholder images that appeared in the model.
132
- doc.on('change', () => {
133
- // Note: Reversing changes to start with insertions and only then handle removals. If it was the other way around,
134
- // loaders for **all** images that land in the $graveyard would abort while in fact only those that were **not** replaced
135
- // by other images should be aborted.
136
- const changes = doc.differ.getChanges({ includeChangesInGraveyard: true }).reverse();
137
- const insertedImagesIds = new Set();
138
- for (const entry of changes) {
139
- if (entry.type == 'insert' && entry.name != '$text') {
140
- const item = entry.position.nodeAfter;
141
- const isInsertedInGraveyard = entry.position.root.rootName == '$graveyard';
142
- for (const imageElement of getImagesFromChangeItem(editor, item)) {
143
- // Check if the image element still has upload id.
144
- const uploadId = imageElement.getAttribute('uploadId');
145
- if (!uploadId) {
146
- continue;
147
- }
148
- // Check if the image is loaded on this client.
149
- const loader = fileRepository.loaders.get(uploadId);
150
- if (!loader) {
151
- continue;
152
- }
153
- if (isInsertedInGraveyard) {
154
- // If the image was inserted to the graveyard for good (**not** replaced by another image),
155
- // only then abort the loading process.
156
- if (!insertedImagesIds.has(uploadId)) {
157
- loader.abort();
158
- }
159
- }
160
- else {
161
- // Remember the upload id of the inserted image. If it acted as a replacement for another
162
- // image (which landed in the $graveyard), the related loader will not be aborted because
163
- // this is still the same image upload.
164
- insertedImagesIds.add(uploadId);
165
- // Keep the mapping between the upload ID and the image model element so the upload
166
- // can later resolve in the context of the correct model element. The model element could
167
- // change for the same upload if one image was replaced by another (e.g. image type was changed),
168
- // so this may also replace an existing mapping.
169
- this._uploadImageElements.set(uploadId, imageElement);
170
- if (loader.status == 'idle') {
171
- // If the image was inserted into content and has not been loaded yet, start loading it.
172
- this._readAndUpload(loader);
173
- }
174
- }
175
- }
176
- }
177
- }
178
- });
179
- // Set the default handler for feeding the image element with `src` and `srcset` attributes.
180
- this.on('uploadComplete', (evt, { imageElement, data }) => {
181
- const urls = data.urls ? data.urls : data;
182
- this.editor.model.change(writer => {
183
- writer.setAttribute('src', urls.default, imageElement);
184
- this._parseAndSetSrcsetAttributeOnImage(urls, imageElement, writer);
185
- });
186
- }, { priority: 'low' });
187
- }
188
- /**
189
- * @inheritDoc
190
- */
191
- afterInit() {
192
- const schema = this.editor.model.schema;
193
- // Setup schema to allow uploadId and uploadStatus for images.
194
- // Wait for ImageBlockEditing or ImageInlineEditing to register their elements first,
195
- // that's why doing this in afterInit() instead of init().
196
- if (this.editor.plugins.has('ImageBlockEditing')) {
197
- schema.extend('imageBlock', {
198
- allowAttributes: ['uploadId', 'uploadStatus']
199
- });
200
- }
201
- if (this.editor.plugins.has('ImageInlineEditing')) {
202
- schema.extend('imageInline', {
203
- allowAttributes: ['uploadId', 'uploadStatus']
204
- });
205
- }
206
- }
207
- /**
208
- * Reads and uploads an image.
209
- *
210
- * The image is read from the disk and as a Base64-encoded string it is set temporarily to
211
- * `image[src]`. When the image is successfully uploaded, the temporary data is replaced with the target
212
- * image's URL (the URL to the uploaded image on the server).
213
- */
214
- _readAndUpload(loader) {
215
- const editor = this.editor;
216
- const model = editor.model;
217
- const t = editor.locale.t;
218
- const fileRepository = editor.plugins.get(FileRepository);
219
- const notification = editor.plugins.get(Notification);
220
- const imageUtils = editor.plugins.get('ImageUtils');
221
- const imageUploadElements = this._uploadImageElements;
222
- model.enqueueChange({ isUndoable: false }, writer => {
223
- writer.setAttribute('uploadStatus', 'reading', imageUploadElements.get(loader.id));
224
- });
225
- return loader.read()
226
- .then(() => {
227
- const promise = loader.upload();
228
- const imageElement = imageUploadElements.get(loader.id);
229
- // Force re–paint in Safari. Without it, the image will display with a wrong size.
230
- // https://github.com/ckeditor/ckeditor5/issues/1975
231
- /* istanbul ignore next -- @preserve */
232
- if (env.isSafari) {
233
- const viewFigure = editor.editing.mapper.toViewElement(imageElement);
234
- const viewImg = imageUtils.findViewImgElement(viewFigure);
235
- editor.editing.view.once('render', () => {
236
- // Early returns just to be safe. There might be some code ran
237
- // in between the outer scope and this callback.
238
- if (!viewImg.parent) {
239
- return;
240
- }
241
- const domFigure = editor.editing.view.domConverter.mapViewToDom(viewImg.parent);
242
- if (!domFigure) {
243
- return;
244
- }
245
- const originalDisplay = domFigure.style.display;
246
- domFigure.style.display = 'none';
247
- // Make sure this line will never be removed during minification for having "no effect".
248
- domFigure._ckHack = domFigure.offsetHeight;
249
- domFigure.style.display = originalDisplay;
250
- });
251
- }
252
- model.enqueueChange({ isUndoable: false }, writer => {
253
- writer.setAttribute('uploadStatus', 'uploading', imageElement);
254
- });
255
- return promise;
256
- })
257
- .then(data => {
258
- model.enqueueChange({ isUndoable: false }, writer => {
259
- const imageElement = imageUploadElements.get(loader.id);
260
- writer.setAttribute('uploadStatus', 'complete', imageElement);
261
- this.fire('uploadComplete', { data, imageElement });
262
- });
263
- clean();
264
- })
265
- .catch(error => {
266
- // If status is not 'error' nor 'aborted' - throw error because it means that something else went wrong,
267
- // it might be generic error and it would be real pain to find what is going on.
268
- if (loader.status !== 'error' && loader.status !== 'aborted') {
269
- throw error;
270
- }
271
- // Might be 'aborted'.
272
- if (loader.status == 'error' && error) {
273
- notification.showWarning(error, {
274
- title: t('Upload failed'),
275
- namespace: 'upload'
276
- });
277
- }
278
- // Permanently remove image from insertion batch.
279
- model.enqueueChange({ isUndoable: false }, writer => {
280
- writer.remove(imageUploadElements.get(loader.id));
281
- });
282
- clean();
283
- });
284
- function clean() {
285
- model.enqueueChange({ isUndoable: false }, writer => {
286
- const imageElement = imageUploadElements.get(loader.id);
287
- writer.removeAttribute('uploadId', imageElement);
288
- writer.removeAttribute('uploadStatus', imageElement);
289
- imageUploadElements.delete(loader.id);
290
- });
291
- fileRepository.destroyLoader(loader);
292
- }
293
- }
294
- /**
295
- * Creates the `srcset` attribute based on a given file upload response and sets it as an attribute to a specific image element.
296
- *
297
- * @param data Data object from which `srcset` will be created.
298
- * @param image The image element on which the `srcset` attribute will be set.
299
- */
300
- _parseAndSetSrcsetAttributeOnImage(data, image, writer) {
301
- // Srcset attribute for responsive images support.
302
- let maxWidth = 0;
303
- const srcsetAttribute = Object.keys(data)
304
- // Filter out keys that are not integers.
305
- .filter(key => {
306
- const width = parseInt(key, 10);
307
- if (!isNaN(width)) {
308
- maxWidth = Math.max(maxWidth, width);
309
- return true;
310
- }
311
- })
312
- // Convert each key to srcset entry.
313
- .map(key => `${data[key]} ${key}w`)
314
- // Join all entries.
315
- .join(', ');
316
- if (srcsetAttribute != '') {
317
- writer.setAttribute('srcset', {
318
- data: srcsetAttribute,
319
- width: maxWidth
320
- }, image);
321
- }
322
- }
323
- }
324
- /**
325
- * Returns `true` if non-empty `text/html` is included in the data transfer.
326
- */
327
- export function isHtmlIncluded(dataTransfer) {
328
- return Array.from(dataTransfer.types).includes('text/html') && dataTransfer.getData('text/html') !== '';
329
- }
330
- function getImagesFromChangeItem(editor, item) {
331
- const imageUtils = editor.plugins.get('ImageUtils');
332
- return Array.from(editor.model.createRangeOn(item))
333
- .filter(value => imageUtils.isImage(value.item))
334
- .map(value => value.item);
335
- }
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module image/imageupload/imageuploadediting
7
+ */
8
+ import { Plugin } from 'ckeditor5/src/core';
9
+ import { UpcastWriter } from 'ckeditor5/src/engine';
10
+ import { Notification } from 'ckeditor5/src/ui';
11
+ import { ClipboardPipeline } from 'ckeditor5/src/clipboard';
12
+ import { FileRepository } from 'ckeditor5/src/upload';
13
+ import { env } from 'ckeditor5/src/utils';
14
+ import ImageUtils from '../imageutils';
15
+ import UploadImageCommand from './uploadimagecommand';
16
+ import { fetchLocalImage, isLocalImage } from '../../src/imageupload/utils';
17
+ import { createImageTypeRegExp } from './utils';
18
+ /**
19
+ * The editing part of the image upload feature. It registers the `'uploadImage'` command
20
+ * and the `imageUpload` command as an aliased name.
21
+ *
22
+ * When an image is uploaded, it fires the {@link ~ImageUploadEditing#event:uploadComplete `uploadComplete`} event
23
+ * that allows adding custom attributes to the {@link module:engine/model/element~Element image element}.
24
+ */
25
+ export default class ImageUploadEditing extends Plugin {
26
+ /**
27
+ * @inheritDoc
28
+ */
29
+ static get requires() {
30
+ return [FileRepository, Notification, ClipboardPipeline, ImageUtils];
31
+ }
32
+ static get pluginName() {
33
+ return 'ImageUploadEditing';
34
+ }
35
+ /**
36
+ * @inheritDoc
37
+ */
38
+ constructor(editor) {
39
+ super(editor);
40
+ editor.config.define('image', {
41
+ upload: {
42
+ types: ['jpeg', 'png', 'gif', 'bmp', 'webp', 'tiff']
43
+ }
44
+ });
45
+ this._uploadImageElements = new Map();
46
+ }
47
+ /**
48
+ * @inheritDoc
49
+ */
50
+ init() {
51
+ const editor = this.editor;
52
+ const doc = editor.model.document;
53
+ const conversion = editor.conversion;
54
+ const fileRepository = editor.plugins.get(FileRepository);
55
+ const imageUtils = editor.plugins.get('ImageUtils');
56
+ const clipboardPipeline = editor.plugins.get('ClipboardPipeline');
57
+ const imageTypes = createImageTypeRegExp(editor.config.get('image.upload.types'));
58
+ const uploadImageCommand = new UploadImageCommand(editor);
59
+ // Register `uploadImage` command and add `imageUpload` command as an alias for backward compatibility.
60
+ editor.commands.add('uploadImage', uploadImageCommand);
61
+ editor.commands.add('imageUpload', uploadImageCommand);
62
+ // Register upcast converter for uploadId.
63
+ conversion.for('upcast')
64
+ .attributeToAttribute({
65
+ view: {
66
+ name: 'img',
67
+ key: 'uploadId'
68
+ },
69
+ model: 'uploadId'
70
+ });
71
+ // Handle pasted images.
72
+ // For every image file, a new file loader is created and a placeholder image is
73
+ // inserted into the content. Then, those images are uploaded once they appear in the model
74
+ // (see Document#change listener below).
75
+ this.listenTo(editor.editing.view.document, 'clipboardInput', (evt, data) => {
76
+ // Skip if non empty HTML data is included.
77
+ // https://github.com/ckeditor/ckeditor5-upload/issues/68
78
+ if (isHtmlIncluded(data.dataTransfer)) {
79
+ return;
80
+ }
81
+ const images = Array.from(data.dataTransfer.files).filter(file => {
82
+ // See https://github.com/ckeditor/ckeditor5-image/pull/254.
83
+ if (!file) {
84
+ return false;
85
+ }
86
+ return imageTypes.test(file.type);
87
+ });
88
+ if (!images.length) {
89
+ return;
90
+ }
91
+ evt.stop();
92
+ editor.model.change(writer => {
93
+ // Set selection to paste target.
94
+ if (data.targetRanges) {
95
+ writer.setSelection(data.targetRanges.map(viewRange => editor.editing.mapper.toModelRange(viewRange)));
96
+ }
97
+ editor.execute('uploadImage', { file: images });
98
+ });
99
+ });
100
+ // Handle HTML pasted with images with base64 or blob sources.
101
+ // For every image file, a new file loader is created and a placeholder image is
102
+ // inserted into the content. Then, those images are uploaded once they appear in the model
103
+ // (see Document#change listener below).
104
+ this.listenTo(clipboardPipeline, 'inputTransformation', (evt, data) => {
105
+ const fetchableImages = Array.from(editor.editing.view.createRangeIn(data.content))
106
+ .map(value => value.item)
107
+ .filter(viewElement => isLocalImage(imageUtils, viewElement) &&
108
+ !viewElement.getAttribute('uploadProcessed'))
109
+ .map(viewElement => { return { promise: fetchLocalImage(viewElement), imageElement: viewElement }; });
110
+ if (!fetchableImages.length) {
111
+ return;
112
+ }
113
+ const writer = new UpcastWriter(editor.editing.view.document);
114
+ for (const fetchableImage of fetchableImages) {
115
+ // Set attribute marking that the image was processed already.
116
+ writer.setAttribute('uploadProcessed', true, fetchableImage.imageElement);
117
+ const loader = fileRepository.createLoader(fetchableImage.promise);
118
+ if (loader) {
119
+ writer.setAttribute('src', '', fetchableImage.imageElement);
120
+ writer.setAttribute('uploadId', loader.id, fetchableImage.imageElement);
121
+ }
122
+ }
123
+ });
124
+ // Prevents from the browser redirecting to the dropped image.
125
+ editor.editing.view.document.on('dragover', (evt, data) => {
126
+ data.preventDefault();
127
+ });
128
+ // Upload placeholder images that appeared in the model.
129
+ doc.on('change', () => {
130
+ // Note: Reversing changes to start with insertions and only then handle removals. If it was the other way around,
131
+ // loaders for **all** images that land in the $graveyard would abort while in fact only those that were **not** replaced
132
+ // by other images should be aborted.
133
+ const changes = doc.differ.getChanges({ includeChangesInGraveyard: true }).reverse();
134
+ const insertedImagesIds = new Set();
135
+ for (const entry of changes) {
136
+ if (entry.type == 'insert' && entry.name != '$text') {
137
+ const item = entry.position.nodeAfter;
138
+ const isInsertedInGraveyard = entry.position.root.rootName == '$graveyard';
139
+ for (const imageElement of getImagesFromChangeItem(editor, item)) {
140
+ // Check if the image element still has upload id.
141
+ const uploadId = imageElement.getAttribute('uploadId');
142
+ if (!uploadId) {
143
+ continue;
144
+ }
145
+ // Check if the image is loaded on this client.
146
+ const loader = fileRepository.loaders.get(uploadId);
147
+ if (!loader) {
148
+ continue;
149
+ }
150
+ if (isInsertedInGraveyard) {
151
+ // If the image was inserted to the graveyard for good (**not** replaced by another image),
152
+ // only then abort the loading process.
153
+ if (!insertedImagesIds.has(uploadId)) {
154
+ loader.abort();
155
+ }
156
+ }
157
+ else {
158
+ // Remember the upload id of the inserted image. If it acted as a replacement for another
159
+ // image (which landed in the $graveyard), the related loader will not be aborted because
160
+ // this is still the same image upload.
161
+ insertedImagesIds.add(uploadId);
162
+ // Keep the mapping between the upload ID and the image model element so the upload
163
+ // can later resolve in the context of the correct model element. The model element could
164
+ // change for the same upload if one image was replaced by another (e.g. image type was changed),
165
+ // so this may also replace an existing mapping.
166
+ this._uploadImageElements.set(uploadId, imageElement);
167
+ if (loader.status == 'idle') {
168
+ // If the image was inserted into content and has not been loaded yet, start loading it.
169
+ this._readAndUpload(loader);
170
+ }
171
+ }
172
+ }
173
+ }
174
+ }
175
+ });
176
+ // Set the default handler for feeding the image element with `src` and `srcset` attributes.
177
+ // Also set the natural `width` and `height` attributes (if not already set).
178
+ this.on('uploadComplete', (evt, { imageElement, data }) => {
179
+ const urls = data.urls ? data.urls : data;
180
+ this.editor.model.change(writer => {
181
+ writer.setAttribute('src', urls.default, imageElement);
182
+ this._parseAndSetSrcsetAttributeOnImage(urls, imageElement, writer);
183
+ imageUtils.setImageNaturalSizeAttributes(imageElement);
184
+ });
185
+ }, { priority: 'low' });
186
+ }
187
+ /**
188
+ * @inheritDoc
189
+ */
190
+ afterInit() {
191
+ const schema = this.editor.model.schema;
192
+ // Setup schema to allow uploadId and uploadStatus for images.
193
+ // Wait for ImageBlockEditing or ImageInlineEditing to register their elements first,
194
+ // that's why doing this in afterInit() instead of init().
195
+ if (this.editor.plugins.has('ImageBlockEditing')) {
196
+ schema.extend('imageBlock', {
197
+ allowAttributes: ['uploadId', 'uploadStatus']
198
+ });
199
+ }
200
+ if (this.editor.plugins.has('ImageInlineEditing')) {
201
+ schema.extend('imageInline', {
202
+ allowAttributes: ['uploadId', 'uploadStatus']
203
+ });
204
+ }
205
+ }
206
+ /**
207
+ * Reads and uploads an image.
208
+ *
209
+ * The image is read from the disk and as a Base64-encoded string it is set temporarily to
210
+ * `image[src]`. When the image is successfully uploaded, the temporary data is replaced with the target
211
+ * image's URL (the URL to the uploaded image on the server).
212
+ */
213
+ _readAndUpload(loader) {
214
+ const editor = this.editor;
215
+ const model = editor.model;
216
+ const t = editor.locale.t;
217
+ const fileRepository = editor.plugins.get(FileRepository);
218
+ const notification = editor.plugins.get(Notification);
219
+ const imageUtils = editor.plugins.get('ImageUtils');
220
+ const imageUploadElements = this._uploadImageElements;
221
+ model.enqueueChange({ isUndoable: false }, writer => {
222
+ writer.setAttribute('uploadStatus', 'reading', imageUploadElements.get(loader.id));
223
+ });
224
+ return loader.read()
225
+ .then(() => {
226
+ const promise = loader.upload();
227
+ const imageElement = imageUploadElements.get(loader.id);
228
+ // Force re–paint in Safari. Without it, the image will display with a wrong size.
229
+ // https://github.com/ckeditor/ckeditor5/issues/1975
230
+ /* istanbul ignore next -- @preserve */
231
+ if (env.isSafari) {
232
+ const viewFigure = editor.editing.mapper.toViewElement(imageElement);
233
+ const viewImg = imageUtils.findViewImgElement(viewFigure);
234
+ editor.editing.view.once('render', () => {
235
+ // Early returns just to be safe. There might be some code ran
236
+ // in between the outer scope and this callback.
237
+ if (!viewImg.parent) {
238
+ return;
239
+ }
240
+ const domFigure = editor.editing.view.domConverter.mapViewToDom(viewImg.parent);
241
+ if (!domFigure) {
242
+ return;
243
+ }
244
+ const originalDisplay = domFigure.style.display;
245
+ domFigure.style.display = 'none';
246
+ // Make sure this line will never be removed during minification for having "no effect".
247
+ domFigure._ckHack = domFigure.offsetHeight;
248
+ domFigure.style.display = originalDisplay;
249
+ });
250
+ }
251
+ model.enqueueChange({ isUndoable: false }, writer => {
252
+ writer.setAttribute('uploadStatus', 'uploading', imageElement);
253
+ });
254
+ return promise;
255
+ })
256
+ .then(data => {
257
+ model.enqueueChange({ isUndoable: false }, writer => {
258
+ const imageElement = imageUploadElements.get(loader.id);
259
+ writer.setAttribute('uploadStatus', 'complete', imageElement);
260
+ this.fire('uploadComplete', { data, imageElement });
261
+ });
262
+ clean();
263
+ })
264
+ .catch(error => {
265
+ // If status is not 'error' nor 'aborted' - throw error because it means that something else went wrong,
266
+ // it might be generic error and it would be real pain to find what is going on.
267
+ if (loader.status !== 'error' && loader.status !== 'aborted') {
268
+ throw error;
269
+ }
270
+ // Might be 'aborted'.
271
+ if (loader.status == 'error' && error) {
272
+ notification.showWarning(error, {
273
+ title: t('Upload failed'),
274
+ namespace: 'upload'
275
+ });
276
+ }
277
+ // Permanently remove image from insertion batch.
278
+ model.enqueueChange({ isUndoable: false }, writer => {
279
+ writer.remove(imageUploadElements.get(loader.id));
280
+ });
281
+ clean();
282
+ });
283
+ function clean() {
284
+ model.enqueueChange({ isUndoable: false }, writer => {
285
+ const imageElement = imageUploadElements.get(loader.id);
286
+ writer.removeAttribute('uploadId', imageElement);
287
+ writer.removeAttribute('uploadStatus', imageElement);
288
+ imageUploadElements.delete(loader.id);
289
+ });
290
+ fileRepository.destroyLoader(loader);
291
+ }
292
+ }
293
+ /**
294
+ * Creates the `srcset` attribute based on a given file upload response and sets it as an attribute to a specific image element.
295
+ *
296
+ * @param data Data object from which `srcset` will be created.
297
+ * @param image The image element on which the `srcset` attribute will be set.
298
+ */
299
+ _parseAndSetSrcsetAttributeOnImage(data, image, writer) {
300
+ // Srcset attribute for responsive images support.
301
+ let maxWidth = 0;
302
+ const srcsetAttribute = Object.keys(data)
303
+ // Filter out keys that are not integers.
304
+ .filter(key => {
305
+ const width = parseInt(key, 10);
306
+ if (!isNaN(width)) {
307
+ maxWidth = Math.max(maxWidth, width);
308
+ return true;
309
+ }
310
+ })
311
+ // Convert each key to srcset entry.
312
+ .map(key => `${data[key]} ${key}w`)
313
+ // Join all entries.
314
+ .join(', ');
315
+ if (srcsetAttribute != '') {
316
+ const attributes = {
317
+ srcset: srcsetAttribute
318
+ };
319
+ if (!image.hasAttribute('width') && !image.hasAttribute('height')) {
320
+ attributes.width = maxWidth;
321
+ }
322
+ writer.setAttributes(attributes, image);
323
+ }
324
+ }
325
+ }
326
+ /**
327
+ * Returns `true` if non-empty `text/html` is included in the data transfer.
328
+ */
329
+ export function isHtmlIncluded(dataTransfer) {
330
+ return Array.from(dataTransfer.types).includes('text/html') && dataTransfer.getData('text/html') !== '';
331
+ }
332
+ function getImagesFromChangeItem(editor, item) {
333
+ const imageUtils = editor.plugins.get('ImageUtils');
334
+ return Array.from(editor.model.createRangeOn(item))
335
+ .filter(value => imageUtils.isImage(value.item))
336
+ .map(value => value.item);
337
+ }