ckfindercommand.js 13 KB

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