imageuploadprogress.js 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276
  1. /**
  2. * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  4. */
  5. /**
  6. * @module image/imageupload/imageuploadprogress
  7. */
  8. /* globals setTimeout */
  9. import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
  10. import FileRepository from '@ckeditor/ckeditor5-upload/src/filerepository';
  11. import uploadingPlaceholder from '../../theme/icons/image_placeholder.svg';
  12. import { getViewImgFromWidget } from '../image/utils';
  13. import '../../theme/imageuploadprogress.css';
  14. import '../../theme/imageuploadicon.css';
  15. import '../../theme/imageuploadloader.css';
  16. /**
  17. * The image upload progress plugin.
  18. * It shows a placeholder when the image is read from the disk and a progress bar while the image is uploading.
  19. *
  20. * @extends module:core/plugin~Plugin
  21. */
  22. export default class ImageUploadProgress extends Plugin {
  23. /**
  24. * @inheritDoc
  25. */
  26. constructor( editor ) {
  27. super( editor );
  28. /**
  29. * The image placeholder that is displayed before real image data can be accessed.
  30. *
  31. * @protected
  32. * @member {String} #placeholder
  33. */
  34. this.placeholder = 'data:image/svg+xml;utf8,' + encodeURIComponent( uploadingPlaceholder );
  35. }
  36. /**
  37. * @inheritDoc
  38. */
  39. init() {
  40. const editor = this.editor;
  41. // Upload status change - update image's view according to that status.
  42. editor.editing.downcastDispatcher.on( 'attribute:uploadStatus:image', ( ...args ) => this.uploadStatusChange( ...args ) );
  43. }
  44. /**
  45. * This method is called each time the image `uploadStatus` attribute is changed.
  46. *
  47. * @param {module:utils/eventinfo~EventInfo} evt An object containing information about the fired event.
  48. * @param {Object} data Additional information about the change.
  49. * @param {module:engine/conversion/downcastdispatcher~DowncastConversionApi} conversionApi
  50. */
  51. uploadStatusChange( evt, data, conversionApi ) {
  52. const editor = this.editor;
  53. const modelImage = data.item;
  54. const uploadId = modelImage.getAttribute( 'uploadId' );
  55. if ( !conversionApi.consumable.consume( data.item, evt.name ) ) {
  56. return;
  57. }
  58. const fileRepository = editor.plugins.get( FileRepository );
  59. const status = uploadId ? data.attributeNewValue : null;
  60. const placeholder = this.placeholder;
  61. const viewFigure = editor.editing.mapper.toViewElement( modelImage );
  62. const viewWriter = conversionApi.writer;
  63. if ( status == 'reading' ) {
  64. // Start "appearing" effect and show placeholder with infinite progress bar on the top
  65. // while image is read from disk.
  66. _startAppearEffect( viewFigure, viewWriter );
  67. _showPlaceholder( placeholder, viewFigure, viewWriter );
  68. return;
  69. }
  70. // Show progress bar on the top of the image when image is uploading.
  71. if ( status == 'uploading' ) {
  72. const loader = fileRepository.loaders.get( uploadId );
  73. // Start appear effect if needed - see https://github.com/ckeditor/ckeditor5-image/issues/191.
  74. _startAppearEffect( viewFigure, viewWriter );
  75. if ( !loader ) {
  76. // There is no loader associated with uploadId - this means that image came from external changes.
  77. // In such cases we still want to show the placeholder until image is fully uploaded.
  78. // Show placeholder if needed - see https://github.com/ckeditor/ckeditor5-image/issues/191.
  79. _showPlaceholder( placeholder, viewFigure, viewWriter );
  80. } else {
  81. // Hide placeholder and initialize progress bar showing upload progress.
  82. _hidePlaceholder( viewFigure, viewWriter );
  83. _showProgressBar( viewFigure, viewWriter, loader, editor.editing.view );
  84. _displayLocalImage( viewFigure, viewWriter, loader );
  85. }
  86. return;
  87. }
  88. if ( status == 'complete' && fileRepository.loaders.get( uploadId ) ) {
  89. _showCompleteIcon( viewFigure, viewWriter, editor.editing.view );
  90. }
  91. // Clean up.
  92. _hideProgressBar( viewFigure, viewWriter );
  93. _hidePlaceholder( viewFigure, viewWriter );
  94. _stopAppearEffect( viewFigure, viewWriter );
  95. }
  96. }
  97. // Adds ck-appear class to the image figure if one is not already applied.
  98. //
  99. // @param {module:engine/view/containerelement~ContainerElement} viewFigure
  100. // @param {module:engine/view/downcastwriter~DowncastWriter} writer
  101. function _startAppearEffect( viewFigure, writer ) {
  102. if ( !viewFigure.hasClass( 'ck-appear' ) ) {
  103. writer.addClass( 'ck-appear', viewFigure );
  104. }
  105. }
  106. // Removes ck-appear class to the image figure if one is not already removed.
  107. //
  108. // @param {module:engine/view/containerelement~ContainerElement} viewFigure
  109. // @param {module:engine/view/downcastwriter~DowncastWriter} writer
  110. function _stopAppearEffect( viewFigure, writer ) {
  111. writer.removeClass( 'ck-appear', viewFigure );
  112. }
  113. // Shows placeholder together with infinite progress bar on given image figure.
  114. //
  115. // @param {String} Data-uri with a svg placeholder.
  116. // @param {module:engine/view/containerelement~ContainerElement} viewFigure
  117. // @param {module:engine/view/downcastwriter~DowncastWriter} writer
  118. function _showPlaceholder( placeholder, viewFigure, writer ) {
  119. if ( !viewFigure.hasClass( 'ck-image-upload-placeholder' ) ) {
  120. writer.addClass( 'ck-image-upload-placeholder', viewFigure );
  121. }
  122. const viewImg = getViewImgFromWidget( viewFigure );
  123. if ( viewImg.getAttribute( 'src' ) !== placeholder ) {
  124. writer.setAttribute( 'src', placeholder, viewImg );
  125. }
  126. if ( !_getUIElement( viewFigure, 'placeholder' ) ) {
  127. writer.insert( writer.createPositionAfter( viewImg ), _createPlaceholder( writer ) );
  128. }
  129. }
  130. // Removes placeholder together with infinite progress bar on given image figure.
  131. //
  132. // @param {module:engine/view/containerelement~ContainerElement} viewFigure
  133. // @param {module:engine/view/downcastwriter~DowncastWriter} writer
  134. function _hidePlaceholder( viewFigure, writer ) {
  135. if ( viewFigure.hasClass( 'ck-image-upload-placeholder' ) ) {
  136. writer.removeClass( 'ck-image-upload-placeholder', viewFigure );
  137. }
  138. _removeUIElement( viewFigure, writer, 'placeholder' );
  139. }
  140. // Shows progress bar displaying upload progress.
  141. // Attaches it to the file loader to update when upload percentace is changed.
  142. //
  143. // @param {module:engine/view/containerelement~ContainerElement} viewFigure
  144. // @param {module:engine/view/downcastwriter~DowncastWriter} writer
  145. // @param {module:upload/filerepository~FileLoader} loader
  146. // @param {module:engine/view/view~View} view
  147. function _showProgressBar( viewFigure, writer, loader, view ) {
  148. const progressBar = _createProgressBar( writer );
  149. writer.insert( writer.createPositionAt( viewFigure, 'end' ), progressBar );
  150. // Update progress bar width when uploadedPercent is changed.
  151. loader.on( 'change:uploadedPercent', ( evt, name, value ) => {
  152. view.change( writer => {
  153. writer.setStyle( 'width', value + '%', progressBar );
  154. } );
  155. } );
  156. }
  157. // Hides upload progress bar.
  158. //
  159. // @param {module:engine/view/containerelement~ContainerElement} viewFigure
  160. // @param {module:engine/view/downcastwriter~DowncastWriter} writer
  161. function _hideProgressBar( viewFigure, writer ) {
  162. _removeUIElement( viewFigure, writer, 'progressBar' );
  163. }
  164. // Shows complete icon and hides after a certain amount of time.
  165. //
  166. // @param {module:engine/view/containerelement~ContainerElement} viewFigure
  167. // @param {module:engine/view/downcastwriter~DowncastWriter} writer
  168. // @param {module:engine/view/view~View} view
  169. function _showCompleteIcon( viewFigure, writer, view ) {
  170. const completeIcon = writer.createUIElement( 'div', { class: 'ck-image-upload-complete-icon' } );
  171. writer.insert( writer.createPositionAt( viewFigure, 'end' ), completeIcon );
  172. setTimeout( () => {
  173. view.change( writer => writer.remove( writer.createRangeOn( completeIcon ) ) );
  174. }, 3000 );
  175. }
  176. // Create progress bar element using {@link module:engine/view/uielement~UIElement}.
  177. //
  178. // @private
  179. // @param {module:engine/view/downcastwriter~DowncastWriter} writer
  180. // @returns {module:engine/view/uielement~UIElement}
  181. function _createProgressBar( writer ) {
  182. const progressBar = writer.createUIElement( 'div', { class: 'ck-progress-bar' } );
  183. writer.setCustomProperty( 'progressBar', true, progressBar );
  184. return progressBar;
  185. }
  186. // Create placeholder element using {@link module:engine/view/uielement~UIElement}.
  187. //
  188. // @private
  189. // @param {module:engine/view/downcastwriter~DowncastWriter} writer
  190. // @returns {module:engine/view/uielement~UIElement}
  191. function _createPlaceholder( writer ) {
  192. const placeholder = writer.createUIElement( 'div', { class: 'ck-upload-placeholder-loader' } );
  193. writer.setCustomProperty( 'placeholder', true, placeholder );
  194. return placeholder;
  195. }
  196. // Returns {@link module:engine/view/uielement~UIElement} of given unique property from image figure element.
  197. // Returns `undefined` if element is not found.
  198. //
  199. // @private
  200. // @param {module:engine/view/element~Element} imageFigure
  201. // @param {String} uniqueProperty
  202. // @returns {module:engine/view/uielement~UIElement|undefined}
  203. function _getUIElement( imageFigure, uniqueProperty ) {
  204. for ( const child of imageFigure.getChildren() ) {
  205. if ( child.getCustomProperty( uniqueProperty ) ) {
  206. return child;
  207. }
  208. }
  209. }
  210. // Removes {@link module:engine/view/uielement~UIElement} of given unique property from image figure element.
  211. //
  212. // @private
  213. // @param {module:engine/view/element~Element} imageFigure
  214. // @param {module:engine/view/downcastwriter~DowncastWriter} writer
  215. // @param {String} uniqueProperty
  216. function _removeUIElement( viewFigure, writer, uniqueProperty ) {
  217. const element = _getUIElement( viewFigure, uniqueProperty );
  218. if ( element ) {
  219. writer.remove( writer.createRangeOn( element ) );
  220. }
  221. }
  222. // Displays local data from file loader.
  223. //
  224. // @param {module:engine/view/element~Element} imageFigure
  225. // @param {module:engine/view/downcastwriter~DowncastWriter} writer
  226. // @param {module:upload/filerepository~FileLoader} loader
  227. function _displayLocalImage( viewFigure, writer, loader ) {
  228. if ( loader.data ) {
  229. const viewImg = getViewImgFromWidget( viewFigure );
  230. writer.setAttribute( 'src', loader.data, viewImg );
  231. }
  232. }