ckfindercommand.js 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450
  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. /* global window */
  6. import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
  7. import { getData as getModelData, setData as setModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  8. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  9. import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
  10. import ImageEditing from '@ckeditor/ckeditor5-image/src/image/imageediting';
  11. import ImageUploadEditing from '@ckeditor/ckeditor5-image/src/imageupload/imageuploadediting';
  12. import LinkEditing from '@ckeditor/ckeditor5-link/src/linkediting';
  13. import Notification from '@ckeditor/ckeditor5-ui/src/notification/notification';
  14. import Clipboard from '@ckeditor/ckeditor5-clipboard/src/clipboard';
  15. import CKFinderCommand from '../src/ckfindercommand';
  16. import { expectToThrowCKEditorError } from '@ckeditor/ckeditor5-utils/tests/_utils/utils';
  17. describe( 'CKFinderCommand', () => {
  18. let editor, command, model;
  19. testUtils.createSinonSandbox();
  20. beforeEach( () => {
  21. return VirtualTestEditor
  22. .create( {
  23. plugins: [ Paragraph, ImageEditing, ImageUploadEditing, LinkEditing, Notification, Clipboard ]
  24. } )
  25. .then( newEditor => {
  26. editor = newEditor;
  27. model = editor.model;
  28. command = new CKFinderCommand( editor );
  29. setModelData( model, '<paragraph>f[o]o</paragraph>' );
  30. } );
  31. } );
  32. afterEach( () => {
  33. return editor.destroy();
  34. } );
  35. describe( 'isEnabled', () => {
  36. it( 'should be true when the selection directly in the root', () => {
  37. model.enqueueChange( 'transparent', () => {
  38. setModelData( model, '[]' );
  39. command.refresh();
  40. expect( command.isEnabled ).to.be.true;
  41. } );
  42. } );
  43. it( 'should be true when the selection is in empty block', () => {
  44. setModelData( model, '<paragraph>[]</paragraph>' );
  45. expect( command.isEnabled ).to.be.true;
  46. } );
  47. it( 'should be true where only image is allowed', () => {
  48. model.schema.register( 'block', { inheritAllFrom: '$block' } );
  49. model.schema.extend( 'paragraph', { allowIn: 'block' } );
  50. model.schema.extend( 'image', { allowIn: 'block' } );
  51. // Block link attribute.
  52. model.schema.addAttributeCheck( ( ctx, attributeName ) => ( attributeName !== 'linkHref' ) );
  53. editor.conversion.for( 'downcast' ).elementToElement( { model: 'block', view: 'block' } );
  54. setModelData( model, '<block><paragraph>[]</paragraph></block>' );
  55. expect( command.isEnabled ).to.be.true;
  56. } );
  57. it( 'should be true where only link is allowed', () => {
  58. model.schema.register( 'block', { inheritAllFrom: '$block' } );
  59. model.schema.extend( 'paragraph', { allowIn: 'block' } );
  60. // Block image in block.
  61. model.schema.addChildCheck( ( context, childDefinition ) => {
  62. if ( childDefinition.name === 'image' && context.last.name === 'block' ) {
  63. return false;
  64. }
  65. } );
  66. editor.conversion.for( 'downcast' ).elementToElement( { model: 'block', view: 'block' } );
  67. setModelData( model, '<block><paragraph>[]</paragraph></block>' );
  68. expect( command.isEnabled ).to.be.true;
  69. } );
  70. it( 'should be false where link & image are not allowed', () => {
  71. model.schema.register( 'block', { inheritAllFrom: '$block' } );
  72. model.schema.extend( 'paragraph', { allowIn: 'block' } );
  73. // Block link attribute - image is not allowed in 'block'.
  74. model.schema.addAttributeCheck( ( ctx, attributeName ) => ( attributeName !== 'linkHref' ) );
  75. editor.conversion.for( 'downcast' ).elementToElement( { model: 'block', view: 'block' } );
  76. setModelData( model, '<block><paragraph>[]</paragraph></block>' );
  77. expect( command.isEnabled ).to.be.false;
  78. } );
  79. it( 'should be true when imageInsert or link command is enabled', () => {
  80. setModelData( model, '<paragraph>[]</paragraph>' );
  81. const insertImage = editor.commands.get( 'imageInsert' );
  82. const linkCommand = editor.commands.get( 'link' );
  83. insertImage.isEnabled = false;
  84. linkCommand.isEnabled = false;
  85. command.refresh();
  86. expect( command.isEnabled ).to.be.false;
  87. linkCommand.isEnabled = false;
  88. insertImage.isEnabled = true;
  89. command.refresh();
  90. expect( command.isEnabled ).to.be.true;
  91. linkCommand.isEnabled = true;
  92. insertImage.isEnabled = false;
  93. command.refresh();
  94. expect( command.isEnabled ).to.be.true;
  95. } );
  96. } );
  97. describe( 'execute()', () => {
  98. const finderMock = {
  99. on: ( eventName, callback ) => {
  100. finderMock[ eventName ] = callback;
  101. }
  102. };
  103. beforeEach( () => {
  104. window.CKFinder = {
  105. modal: config => {
  106. config.onInit( finderMock );
  107. },
  108. popup: config => {
  109. config.onInit( finderMock );
  110. }
  111. };
  112. } );
  113. it( 'should register proper listeners on CKFinder instance', () => {
  114. command.execute();
  115. expect( finderMock ).to.have.property( 'files:choose' );
  116. expect( finderMock ).to.have.property( 'file:choose:resizedImage' );
  117. } );
  118. it( 'should use CKFinder.modal() as default CKFinder opener method', () => {
  119. const spy = sinon.spy( window.CKFinder, 'modal' );
  120. command.execute();
  121. sinon.assert.calledOnce( spy );
  122. } );
  123. it( 'should use CKFinder.popup() when ckfinder.openerMethod is set to it', () => {
  124. const spy = sinon.spy( window.CKFinder, 'popup' );
  125. editor.config.set( 'ckfinder.openerMethod', 'popup' );
  126. command.execute();
  127. sinon.assert.calledOnce( spy );
  128. } );
  129. it( 'should throw if unsupported CKFinder opener method was set', () => {
  130. editor.config.set( 'ckfinder.openerMethod', 'foobar' );
  131. expectToThrowCKEditorError( () => {
  132. command.execute();
  133. }, /ckfinder-unknown-openerMethod/, editor );
  134. } );
  135. it( 'should insert single chosen image', () => {
  136. const url = 'foo/bar.jpg';
  137. command.execute();
  138. mockFilesChooseEvent( [ mockFinderFile( url ) ] );
  139. expect( getModelData( model ) )
  140. .to.equal( `[<image src="${ url }"></image>]<paragraph>foo</paragraph>` );
  141. } );
  142. it( 'should insert link if chosen file is not an image', () => {
  143. const url = 'foo/bar.pdf';
  144. command.execute();
  145. mockFilesChooseEvent( [ mockFinderFile( url, false ) ] );
  146. expect( getModelData( model ) )
  147. .to.equal( `<paragraph>f[<$text linkHref="${ url }">o</$text>]o</paragraph>` );
  148. } );
  149. it( 'should pass CKFinder configuration options', () => {
  150. const spy = sinon.spy( window.CKFinder, 'modal' );
  151. const connectorPath = 'foo/bar.php';
  152. editor.config.set( 'ckfinder.options', { connectorPath } );
  153. command.execute();
  154. const openerMethodOptions = spy.args[ 0 ][ 0 ];
  155. expect( openerMethodOptions ).to.have.property( 'chooseFiles', true );
  156. expect( openerMethodOptions ).to.have.property( 'onInit' );
  157. expect( openerMethodOptions ).to.have.property( 'connectorPath', connectorPath );
  158. } );
  159. it( 'should call user-defined config.onInit() function', () => {
  160. const spy = sinon.spy();
  161. editor.config.set( 'ckfinder.options.onInit', spy );
  162. command.execute();
  163. sinon.assert.calledOnce( spy );
  164. } );
  165. it( 'should pass CKFinder instance to a user-defined config.onInit() function', () => {
  166. const spy = sinon.spy();
  167. editor.config.set( 'ckfinder.options.onInit', spy );
  168. command.execute();
  169. sinon.assert.calledWithExactly( spy, finderMock );
  170. } );
  171. it( 'should pass editor default language to the CKFinder instance', () => {
  172. const spy = sinon.spy( window.CKFinder, 'modal' );
  173. command.execute();
  174. const openerMethodOptions = spy.args[ 0 ][ 0 ];
  175. expect( openerMethodOptions ).to.have.property( 'language', 'en' );
  176. } );
  177. it( 'should pass editor language set by configuration to the CKFinder instance', () => {
  178. const finderMock = {
  179. on: ( eventName, callback ) => {
  180. finderMock[ eventName ] = callback;
  181. }
  182. };
  183. return VirtualTestEditor
  184. .create( {
  185. plugins: [ Paragraph, ImageEditing, ImageUploadEditing, LinkEditing, Notification, Clipboard ],
  186. language: 'pl'
  187. } )
  188. .then( newEditor => {
  189. editor = newEditor;
  190. window.CKFinder = {
  191. modal: config => {
  192. config.onInit( finderMock );
  193. }
  194. };
  195. command = new CKFinderCommand( editor );
  196. setModelData( editor.model, '<paragraph>f[o]o</paragraph>' );
  197. const spy = sinon.spy( window.CKFinder, 'modal' );
  198. command.execute();
  199. const openerMethodOptions = spy.args[ 0 ][ 0 ];
  200. expect( openerMethodOptions ).to.have.property( 'language', 'pl' );
  201. } );
  202. } );
  203. it( 'should not pass editor language if it is set in ckfinder.options', () => {
  204. const spy = sinon.spy( window.CKFinder, 'modal' );
  205. editor.config.set( 'ckfinder.options.language', 'pl' );
  206. command.execute();
  207. const openerMethodOptions = spy.args[ 0 ][ 0 ];
  208. expect( openerMethodOptions ).to.have.property( 'language', 'pl' );
  209. } );
  210. it( 'should insert multiple chosen images as image widget', () => {
  211. const url1 = 'foo/bar1.jpg';
  212. const url2 = 'foo/bar2.jpg';
  213. const url3 = 'foo/bar3.jpg';
  214. command.execute();
  215. mockFilesChooseEvent( [ mockFinderFile( url1 ), mockFinderFile( url2 ), mockFinderFile( url3 ) ] );
  216. expect( getModelData( model ) ).to.equal(
  217. `<image src="${ url1 }"></image><image src="${ url2 }"></image>[<image src="${ url3 }"></image>]<paragraph>foo</paragraph>`
  218. );
  219. } );
  220. it( 'should insert images and links to a files from chosen files', () => {
  221. const url1 = 'foo/bar1.jpg';
  222. const url2 = 'foo/bar2.pdf';
  223. const url3 = 'foo/bar3.jpg';
  224. command.execute();
  225. mockFilesChooseEvent( [ mockFinderFile( url1 ), mockFinderFile( url2, false ), mockFinderFile( url3 ) ] );
  226. expect( getModelData( model ) ).to.equal(
  227. `<image src="${ url1 }"></image>` +
  228. `[<image src="${ url3 }"></image>]` +
  229. `<paragraph>f<$text linkHref="${ url2 }">o</$text>o</paragraph>`
  230. );
  231. } );
  232. it( 'should use CKFinder Proxy for privately hosted files', () => {
  233. const proxyUrl = 'bar/foo.jpg';
  234. finderMock.request = () => proxyUrl;
  235. command.execute();
  236. mockFilesChooseEvent( [ mockFinderFile( false ) ] );
  237. expect( getModelData( model ) ).to.equal(
  238. `[<image src="${ proxyUrl }"></image>]<paragraph>foo</paragraph>`
  239. );
  240. } );
  241. it( 'should insert resized image as image widget', () => {
  242. const url = 'foo/bar.jpg';
  243. command.execute();
  244. mockFinderEvent( 'file:choose:resizedImage', { resizedUrl: url } );
  245. expect( getModelData( model ) )
  246. .to.equal( `[<image src="${ url }"></image>]<paragraph>foo</paragraph>` );
  247. } );
  248. it( 'should show warning notification if no resized image URL was returned', done => {
  249. const notification = editor.plugins.get( Notification );
  250. notification.on( 'show:warning', ( evt, data ) => {
  251. expect( data.message ).to.equal( 'Could not obtain resized image URL.' );
  252. expect( data.title ).to.equal( 'Selecting resized image failed' );
  253. evt.stop();
  254. done();
  255. }, { priority: 'high' } );
  256. command.execute();
  257. mockFinderEvent( 'file:choose:resizedImage', { resizedUrl: undefined } );
  258. expect( getModelData( model ) )
  259. .to.equal( '<paragraph>f[o]o</paragraph>' );
  260. } );
  261. it( 'should show warning notification if image cannot be inserted', done => {
  262. model.schema.register( 'block', { inheritAllFrom: '$block' } );
  263. model.schema.extend( 'paragraph', { allowIn: 'block' } );
  264. // Block image in block.
  265. model.schema.addChildCheck( ( context, childDefinition ) => {
  266. if ( childDefinition.name === 'image' && context.last.name === 'block' ) {
  267. return false;
  268. }
  269. } );
  270. editor.conversion.for( 'downcast' ).elementToElement( { model: 'block', view: 'block' } );
  271. setModelData( model, '<block><paragraph>[]</paragraph></block>' );
  272. const notification = editor.plugins.get( Notification );
  273. notification.on( 'show:warning', ( evt, data ) => {
  274. expect( data.message ).to.equal( 'Could not insert image at the current position.' );
  275. expect( data.title ).to.equal( 'Inserting image failed' );
  276. evt.stop();
  277. done();
  278. }, { priority: 'high' } );
  279. command.execute();
  280. mockFinderEvent( 'file:choose:resizedImage', { resizedUrl: 'foo/bar.jpg' } );
  281. expect( getModelData( model ) )
  282. .to.equal( '<paragraph>f[o]o</paragraph>' );
  283. } );
  284. it( 'should not insert image nor crash when image could not be inserted', () => {
  285. model.schema.register( 'other', {
  286. allowIn: '$root',
  287. isLimit: true
  288. } );
  289. model.schema.extend( '$text', { allowIn: 'other' } );
  290. editor.conversion.for( 'downcast' ).elementToElement( { model: 'other', view: 'p' } );
  291. setModelData( model, '<other>[]</other>' );
  292. command.execute();
  293. mockFilesChooseEvent( [ mockFinderFile( 'foo/bar.jpg' ) ] );
  294. expect( getModelData( model ) ).to.equal( '<other>[]</other>' );
  295. } );
  296. it( 'does not alter the original config', () => {
  297. editor.config.set( 'ckfinder', { options: { foo: 'bar' } } );
  298. command.execute();
  299. expect( editor.config.get( 'ckfinder.options' ) ).to.deep.equal( { foo: 'bar' } );
  300. } );
  301. function mockFinderFile( url = 'foo/bar.jpg', isImage = true ) {
  302. return {
  303. isImage: () => isImage,
  304. getUrl: () => url
  305. };
  306. }
  307. function mockFinderEvent( eventName, data ) {
  308. finderMock[ eventName ]( { data } );
  309. }
  310. function mockFilesChooseEvent( files ) {
  311. const data = {
  312. files: {
  313. toArray: () => files
  314. }
  315. };
  316. mockFinderEvent( 'files:choose', data );
  317. }
  318. } );
  319. } );