ckfindercommand.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426
  1. /**
  2. * @license Copyright (c) 2003-2019, 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. } );
  80. describe( 'execute()', () => {
  81. const finderMock = {
  82. on: ( eventName, callback ) => {
  83. finderMock[ eventName ] = callback;
  84. }
  85. };
  86. beforeEach( () => {
  87. window.CKFinder = {
  88. modal: config => {
  89. config.onInit( finderMock );
  90. },
  91. popup: config => {
  92. config.onInit( finderMock );
  93. }
  94. };
  95. } );
  96. it( 'should register proper listeners on CKFinder instance', () => {
  97. command.execute();
  98. expect( finderMock ).to.have.property( 'files:choose' );
  99. expect( finderMock ).to.have.property( 'file:choose:resizedImage' );
  100. } );
  101. it( 'should use CKFinder.modal() as default CKFinder opener method', () => {
  102. const spy = sinon.spy( window.CKFinder, 'modal' );
  103. command.execute();
  104. sinon.assert.calledOnce( spy );
  105. } );
  106. it( 'should use CKFinder.popup() when ckfinder.openerMethod is set to it', () => {
  107. const spy = sinon.spy( window.CKFinder, 'popup' );
  108. editor.config.set( 'ckfinder.openerMethod', 'popup' );
  109. command.execute();
  110. sinon.assert.calledOnce( spy );
  111. } );
  112. it( 'should throw if unsupported CKFinder opener method was set', () => {
  113. editor.config.set( 'ckfinder.openerMethod', 'foobar' );
  114. expectToThrowCKEditorError( () => {
  115. command.execute();
  116. }, /ckfinder-unknown-openerMethod/, editor );
  117. } );
  118. it( 'should insert single chosen image', () => {
  119. const url = 'foo/bar.jpg';
  120. command.execute();
  121. mockFilesChooseEvent( [ mockFinderFile( url ) ] );
  122. expect( getModelData( model ) )
  123. .to.equal( `[<image src="${ url }"></image>]<paragraph>foo</paragraph>` );
  124. } );
  125. it( 'should insert link if chosen file is not an image', () => {
  126. const url = 'foo/bar.pdf';
  127. command.execute();
  128. mockFilesChooseEvent( [ mockFinderFile( url, false ) ] );
  129. expect( getModelData( model ) )
  130. .to.equal( `<paragraph>f[<$text linkHref="${ url }">o</$text>]o</paragraph>` );
  131. } );
  132. it( 'should pass CKFinder configuration options', () => {
  133. const spy = sinon.spy( window.CKFinder, 'modal' );
  134. const connectorPath = 'foo/bar.php';
  135. editor.config.set( 'ckfinder.options', { connectorPath } );
  136. command.execute();
  137. const openerMethodOptions = spy.args[ 0 ][ 0 ];
  138. expect( openerMethodOptions ).to.have.property( 'chooseFiles', true );
  139. expect( openerMethodOptions ).to.have.property( 'onInit' );
  140. expect( openerMethodOptions ).to.have.property( 'connectorPath', connectorPath );
  141. } );
  142. it( 'should call user-defined config.onInit() function', () => {
  143. const spy = sinon.spy();
  144. editor.config.set( 'ckfinder.options.onInit', spy );
  145. command.execute();
  146. sinon.assert.calledOnce( spy );
  147. } );
  148. it( 'should pass CKFinder instance to a user-defined config.onInit() function', () => {
  149. const spy = sinon.spy();
  150. editor.config.set( 'ckfinder.options.onInit', spy );
  151. command.execute();
  152. sinon.assert.calledWithExactly( spy, finderMock );
  153. } );
  154. it( 'should pass editor default language to the CKFinder instance', () => {
  155. const spy = sinon.spy( window.CKFinder, 'modal' );
  156. command.execute();
  157. const openerMethodOptions = spy.args[ 0 ][ 0 ];
  158. expect( openerMethodOptions ).to.have.property( 'language', 'en' );
  159. } );
  160. it( 'should pass editor language set by configuration to the CKFinder instance', () => {
  161. const finderMock = {
  162. on: ( eventName, callback ) => {
  163. finderMock[ eventName ] = callback;
  164. }
  165. };
  166. return VirtualTestEditor
  167. .create( {
  168. plugins: [ Paragraph, ImageEditing, ImageUploadEditing, LinkEditing, Notification, Clipboard ],
  169. language: 'pl'
  170. } )
  171. .then( newEditor => {
  172. editor = newEditor;
  173. window.CKFinder = {
  174. modal: config => {
  175. config.onInit( finderMock );
  176. }
  177. };
  178. command = new CKFinderCommand( editor );
  179. setModelData( editor.model, '<paragraph>f[o]o</paragraph>' );
  180. const spy = sinon.spy( window.CKFinder, 'modal' );
  181. command.execute();
  182. const openerMethodOptions = spy.args[ 0 ][ 0 ];
  183. expect( openerMethodOptions ).to.have.property( 'language', 'pl' );
  184. } );
  185. } );
  186. it( 'should not pass editor language if it is set in ckfinder.options', () => {
  187. const spy = sinon.spy( window.CKFinder, 'modal' );
  188. editor.config.set( 'ckfinder.options.language', 'pl' );
  189. command.execute();
  190. const openerMethodOptions = spy.args[ 0 ][ 0 ];
  191. expect( openerMethodOptions ).to.have.property( 'language', 'pl' );
  192. } );
  193. it( 'should insert multiple chosen images as image widget', () => {
  194. const url1 = 'foo/bar1.jpg';
  195. const url2 = 'foo/bar2.jpg';
  196. const url3 = 'foo/bar3.jpg';
  197. command.execute();
  198. mockFilesChooseEvent( [ mockFinderFile( url1 ), mockFinderFile( url2 ), mockFinderFile( url3 ) ] );
  199. expect( getModelData( model ) ).to.equal(
  200. `<image src="${ url1 }"></image><image src="${ url2 }"></image>[<image src="${ url3 }"></image>]<paragraph>foo</paragraph>`
  201. );
  202. } );
  203. it( 'should insert images and links to a files from chosen files', () => {
  204. const url1 = 'foo/bar1.jpg';
  205. const url2 = 'foo/bar2.pdf';
  206. const url3 = 'foo/bar3.jpg';
  207. command.execute();
  208. mockFilesChooseEvent( [ mockFinderFile( url1 ), mockFinderFile( url2, false ), mockFinderFile( url3 ) ] );
  209. expect( getModelData( model ) ).to.equal(
  210. `<image src="${ url1 }"></image>` +
  211. `[<image src="${ url3 }"></image>]` +
  212. `<paragraph>f<$text linkHref="${ url2 }">o</$text>o</paragraph>`
  213. );
  214. } );
  215. it( 'should use CKFinder Proxy for privately hosted files', () => {
  216. const proxyUrl = 'bar/foo.jpg';
  217. finderMock.request = () => proxyUrl;
  218. command.execute();
  219. mockFilesChooseEvent( [ mockFinderFile( false ) ] );
  220. expect( getModelData( model ) ).to.equal(
  221. `[<image src="${ proxyUrl }"></image>]<paragraph>foo</paragraph>`
  222. );
  223. } );
  224. it( 'should insert resized image as image widget', () => {
  225. const url = 'foo/bar.jpg';
  226. command.execute();
  227. mockFinderEvent( 'file:choose:resizedImage', { resizedUrl: url } );
  228. expect( getModelData( model ) )
  229. .to.equal( `[<image src="${ url }"></image>]<paragraph>foo</paragraph>` );
  230. } );
  231. it( 'should show warning notification if no resized image URL was returned', done => {
  232. const notification = editor.plugins.get( Notification );
  233. notification.on( 'show:warning', ( evt, data ) => {
  234. expect( data.message ).to.equal( 'Could not obtain resized image URL.' );
  235. expect( data.title ).to.equal( 'Selecting resized image failed' );
  236. evt.stop();
  237. done();
  238. }, { priority: 'high' } );
  239. command.execute();
  240. mockFinderEvent( 'file:choose:resizedImage', { resizedUrl: undefined } );
  241. expect( getModelData( model ) )
  242. .to.equal( '<paragraph>f[o]o</paragraph>' );
  243. } );
  244. it( 'should show warning notification if image cannot be inserted', done => {
  245. model.schema.register( 'block', { inheritAllFrom: '$block' } );
  246. model.schema.extend( 'paragraph', { allowIn: 'block' } );
  247. // Block image in block.
  248. model.schema.addChildCheck( ( context, childDefinition ) => {
  249. if ( childDefinition.name === 'image' && context.last.name === 'block' ) {
  250. return false;
  251. }
  252. } );
  253. editor.conversion.for( 'downcast' ).elementToElement( { model: 'block', view: 'block' } );
  254. setModelData( model, '<block><paragraph>[]</paragraph></block>' );
  255. const notification = editor.plugins.get( Notification );
  256. notification.on( 'show:warning', ( evt, data ) => {
  257. expect( data.message ).to.equal( 'Could not insert image at the current position.' );
  258. expect( data.title ).to.equal( 'Inserting image failed' );
  259. evt.stop();
  260. done();
  261. }, { priority: 'high' } );
  262. command.execute();
  263. mockFinderEvent( 'file:choose:resizedImage', { resizedUrl: 'foo/bar.jpg' } );
  264. expect( getModelData( model ) )
  265. .to.equal( '<paragraph>f[o]o</paragraph>' );
  266. } );
  267. it( 'should not insert image nor crash when image could not be inserted', () => {
  268. model.schema.register( 'other', {
  269. allowIn: '$root',
  270. isLimit: true
  271. } );
  272. model.schema.extend( '$text', { allowIn: 'other' } );
  273. editor.conversion.for( 'downcast' ).elementToElement( { model: 'other', view: 'p' } );
  274. setModelData( model, '<other>[]</other>' );
  275. command.execute();
  276. mockFilesChooseEvent( [ mockFinderFile( 'foo/bar.jpg' ) ] );
  277. expect( getModelData( model ) ).to.equal( '<other>[]</other>' );
  278. } );
  279. it( 'does not alter the original config', () => {
  280. editor.config.set( 'ckfinder', { options: { foo: 'bar' } } );
  281. command.execute();
  282. expect( editor.config.get( 'ckfinder.options' ) ).to.deep.equal( { foo: 'bar' } );
  283. } );
  284. function mockFinderFile( url = 'foo/bar.jpg', isImage = true ) {
  285. return {
  286. isImage: () => isImage,
  287. getUrl: () => url
  288. };
  289. }
  290. function mockFinderEvent( eventName, data ) {
  291. finderMock[ eventName ]( { data } );
  292. }
  293. function mockFilesChooseEvent( files ) {
  294. const data = {
  295. files: {
  296. toArray: () => files
  297. }
  298. };
  299. mockFinderEvent( 'files:choose', data );
  300. }
  301. } );
  302. } );