ckfindercommand.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408
  1. /**
  2. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  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 CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  10. import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
  11. import ImageEditing from '@ckeditor/ckeditor5-image/src/image/imageediting';
  12. import ImageUploadEditing from '@ckeditor/ckeditor5-image/src/imageupload/imageuploadediting';
  13. import LinkEditing from '@ckeditor/ckeditor5-link/src/linkediting';
  14. import Notification from '@ckeditor/ckeditor5-ui/src/notification/notification';
  15. import { downcastElementToElement } from '@ckeditor/ckeditor5-engine/src/conversion/downcast-converters';
  16. import CKFinderCommand from '../src/ckfindercommand';
  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 ]
  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' ).add( downcastElementToElement( { 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' ).add( downcastElementToElement( { 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' ).add( downcastElementToElement( { 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. expect( () => {
  115. command.execute();
  116. } ).to.throw( CKEditorError, /ckfinder-unknown-openerMethod/ );
  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 editor default language to the CKFinder instance', () => {
  149. const spy = sinon.spy( window.CKFinder, 'modal' );
  150. command.execute();
  151. const openerMethodOptions = spy.args[ 0 ][ 0 ];
  152. expect( openerMethodOptions ).to.have.property( 'language', 'en' );
  153. } );
  154. it( 'should pass editor language set by configuration to the CKFinder instance', () => {
  155. const finderMock = {
  156. on: ( eventName, callback ) => {
  157. finderMock[ eventName ] = callback;
  158. }
  159. };
  160. return VirtualTestEditor
  161. .create( {
  162. plugins: [ Paragraph, ImageEditing, ImageUploadEditing, LinkEditing, Notification ],
  163. language: 'pl'
  164. } )
  165. .then( newEditor => {
  166. editor = newEditor;
  167. window.CKFinder = {
  168. modal: config => {
  169. config.onInit( finderMock );
  170. }
  171. };
  172. command = new CKFinderCommand( editor );
  173. setModelData( editor.model, '<paragraph>f[o]o</paragraph>' );
  174. const spy = sinon.spy( window.CKFinder, 'modal' );
  175. command.execute();
  176. const openerMethodOptions = spy.args[ 0 ][ 0 ];
  177. expect( openerMethodOptions ).to.have.property( 'language', 'pl' );
  178. } );
  179. } );
  180. it( 'should not pass editor language if it is set in ckfinder.options', () => {
  181. const spy = sinon.spy( window.CKFinder, 'modal' );
  182. editor.config.set( 'ckfinder.options.language', 'pl' );
  183. command.execute();
  184. const openerMethodOptions = spy.args[ 0 ][ 0 ];
  185. expect( openerMethodOptions ).to.have.property( 'language', 'pl' );
  186. } );
  187. it( 'should insert multiple chosen images as image widget', () => {
  188. const url1 = 'foo/bar1.jpg';
  189. const url2 = 'foo/bar2.jpg';
  190. const url3 = 'foo/bar3.jpg';
  191. command.execute();
  192. mockFilesChooseEvent( [ mockFinderFile( url1 ), mockFinderFile( url2 ), mockFinderFile( url3 ) ] );
  193. expect( getModelData( model ) ).to.equal(
  194. `<image src="${ url1 }"></image><image src="${ url2 }"></image>[<image src="${ url3 }"></image>]<paragraph>foo</paragraph>`
  195. );
  196. } );
  197. it( 'should insert images and links to a files from chosen files', () => {
  198. const url1 = 'foo/bar1.jpg';
  199. const url2 = 'foo/bar2.pdf';
  200. const url3 = 'foo/bar3.jpg';
  201. command.execute();
  202. mockFilesChooseEvent( [ mockFinderFile( url1 ), mockFinderFile( url2, false ), mockFinderFile( url3 ) ] );
  203. expect( getModelData( model ) ).to.equal(
  204. `<image src="${ url1 }"></image>` +
  205. `[<image src="${ url3 }"></image>]` +
  206. `<paragraph>f<$text linkHref="${ url2 }">o</$text>o</paragraph>`
  207. );
  208. } );
  209. it( 'should use CKFinder Proxy for privately hosted files', () => {
  210. const proxyUrl = 'bar/foo.jpg';
  211. finderMock.request = () => proxyUrl;
  212. command.execute();
  213. mockFilesChooseEvent( [ mockFinderFile( false ) ] );
  214. expect( getModelData( model ) ).to.equal(
  215. `[<image src="${ proxyUrl }"></image>]<paragraph>foo</paragraph>`
  216. );
  217. } );
  218. it( 'should insert resized image as image widget', () => {
  219. const url = 'foo/bar.jpg';
  220. command.execute();
  221. mockFinderEvent( 'file:choose:resizedImage', { resizedUrl: url } );
  222. expect( getModelData( model ) )
  223. .to.equal( `[<image src="${ url }"></image>]<paragraph>foo</paragraph>` );
  224. } );
  225. it( 'should show warning notification if no resized image URL was returned', done => {
  226. const notification = editor.plugins.get( Notification );
  227. notification.on( 'show:warning', ( evt, data ) => {
  228. expect( data.message ).to.equal( 'Could not obtain resized image URL.' );
  229. expect( data.title ).to.equal( 'Selecting resized image failed' );
  230. evt.stop();
  231. done();
  232. }, { priority: 'high' } );
  233. command.execute();
  234. mockFinderEvent( 'file:choose:resizedImage', { resizedUrl: undefined } );
  235. expect( getModelData( model ) )
  236. .to.equal( '<paragraph>f[o]o</paragraph>' );
  237. } );
  238. it( 'should show warning notification if image cannot be inserted', done => {
  239. model.schema.register( 'block', { inheritAllFrom: '$block' } );
  240. model.schema.extend( 'paragraph', { allowIn: 'block' } );
  241. // Block image in block.
  242. model.schema.addChildCheck( ( context, childDefinition ) => {
  243. if ( childDefinition.name === 'image' && context.last.name === 'block' ) {
  244. return false;
  245. }
  246. } );
  247. editor.conversion.for( 'downcast' ).add( downcastElementToElement( { model: 'block', view: 'block' } ) );
  248. setModelData( model, '<block><paragraph>[]</paragraph></block>' );
  249. const notification = editor.plugins.get( Notification );
  250. notification.on( 'show:warning', ( evt, data ) => {
  251. expect( data.message ).to.equal( 'Could not insert image at the current position.' );
  252. expect( data.title ).to.equal( 'Inserting image failed' );
  253. evt.stop();
  254. done();
  255. }, { priority: 'high' } );
  256. command.execute();
  257. mockFinderEvent( 'file:choose:resizedImage', { resizedUrl: 'foo/bar.jpg' } );
  258. expect( getModelData( model ) )
  259. .to.equal( '<paragraph>f[o]o</paragraph>' );
  260. } );
  261. it( 'should not insert image nor crash when image could not be inserted', () => {
  262. model.schema.register( 'other', {
  263. allowIn: '$root',
  264. isLimit: true
  265. } );
  266. model.schema.extend( '$text', { allowIn: 'other' } );
  267. editor.conversion.for( 'downcast' ).add( downcastElementToElement( { model: 'other', view: 'p' } ) );
  268. setModelData( model, '<other>[]</other>' );
  269. command.execute();
  270. mockFilesChooseEvent( [ mockFinderFile( 'foo/bar.jpg' ) ] );
  271. expect( getModelData( model ) ).to.equal( '<other>[]</other>' );
  272. } );
  273. function mockFinderFile( url = 'foo/bar.jpg', isImage = true ) {
  274. return {
  275. isImage: () => isImage,
  276. getUrl: () => url
  277. };
  278. }
  279. function mockFinderEvent( eventName, data ) {
  280. finderMock[ eventName ]( { data } );
  281. }
  282. function mockFilesChooseEvent( files ) {
  283. const data = {
  284. files: {
  285. toArray: () => files
  286. }
  287. };
  288. mockFinderEvent( 'files:choose', data );
  289. }
  290. } );
  291. } );