model.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321
  1. /**
  2. * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import Mapper from '/ckeditor5/engine/conversion/mapper.js';
  6. import Document from '/ckeditor5/engine/model/document.js';
  7. import Range from '/ckeditor5/engine/model/range.js';
  8. import Position from '/ckeditor5/engine/model/position.js';
  9. import RootElement from '/ckeditor5/engine/model/rootelement.js';
  10. import ModelConversionDispatcher from '/ckeditor5/engine/conversion/modelconversiondispatcher.js';
  11. import ModelSelection from '/ckeditor5/engine/model/selection.js';
  12. import ModelDocumentFragment from '/ckeditor5/engine/model/documentfragment.js';
  13. import ModelElement from '/ckeditor5/engine/model/element.js';
  14. import ModelText from '/ckeditor5/engine/model/text.js';
  15. import ViewConversionDispatcher from '/ckeditor5/engine/conversion/viewconversiondispatcher.js';
  16. import ViewSelection from '/ckeditor5/engine/view/selection.js';
  17. import ViewDocumentFragment from '/ckeditor5/engine/view/documentfragment.js';
  18. import ViewElement from '/ckeditor5/engine/view/containerelement.js';
  19. import ViewText from '/ckeditor5/engine/view/text.js';
  20. import viewWriter from '/ckeditor5/engine/view/writer.js';
  21. import { parse as viewParse, stringify as viewStringify } from '/tests/engine/_utils/view.js';
  22. import { convertRangeSelection, convertCollapsedSelection } from '/ckeditor5/engine/conversion/model-selection-to-view-converters.js';
  23. import { convertText, convertToModelFragment } from '/ckeditor5/engine/conversion/view-to-model-converters.js';
  24. // Test utils uses `<$text foo="bar">Lorem ipsum</$text>` notation to create text with attributes, but `$text` is not
  25. // valid XML element name, so needs to be parsed before conversion to view.
  26. const VIEW_TEXT_WITH_ATTRIBUTES_ELEMENT = 'view-text-with-attributes';
  27. const DATA_STRING_TEXT_WITH_ATTRIBUTES_ELEMENT = '$text';
  28. /**
  29. * Writes the contents of the {@link engine.model.Document Document} to an HTML-like string.
  30. *
  31. * @param {engine.model.Document} document
  32. * @param {Object} [options]
  33. * @param {Boolean} [options.withoutSelection=false] Whether to write the selection. When set to `true` selection will
  34. * be not included in returned string.
  35. * @param {Boolean} [options.rootName='main'] Name of the root from which data should be stringified. If not provided
  36. * default `main` name will be used.
  37. * @returns {String} The stringified data.
  38. */
  39. export function getData( document, options = {} ) {
  40. if ( !( document instanceof Document ) ) {
  41. throw new TypeError( 'Document needs to be an instance of engine.model.Document.' );
  42. }
  43. const withoutSelection = !!options.withoutSelection;
  44. const rootName = options.rootName || 'main';
  45. const root = document.getRoot( rootName );
  46. return withoutSelection ? getData._stringify( root ) : getData._stringify( root, document.selection );
  47. }
  48. // Set stringify as getData private method - needed for testing/spying.
  49. getData._stringify = stringify;
  50. /**
  51. * Sets the contents of the {@link engine.model.Document Document} provided as HTML-like string.
  52. * It uses {@link engine.model.Document#enqueueChanges enqueueChanges} method.
  53. *
  54. * NOTE:
  55. * Remember to register elements in {@link engine.model.Document#schema document's schema} before inserting them.
  56. *
  57. * @param {engine.model.Document} document
  58. * @param {String} data HTML-like string to write into Document.
  59. * @param {Object} options
  60. * @param {String} [options.rootName='main'] Root name where parsed data will be stored. If not provided, default `main`
  61. * name will be used.
  62. * @param {Array<Object>} [options.selectionAttributes] List of attributes which will be passed to selection.
  63. * @param {String} [options.batchType='transparent'] Batch type used for inserting elements. See {@link engine.model.Batch#type}.
  64. */
  65. export function setData( document, data, options = {} ) {
  66. if ( !( document instanceof Document ) ) {
  67. throw new TypeError( 'Document needs to be an instance of engine.model.Document.' );
  68. }
  69. const mapper = new Mapper();
  70. let model, selection;
  71. const parseResult = setData._parse( data, document.schema, mapper );
  72. if ( parseResult.model ) {
  73. model = parseResult.model;
  74. selection = parseResult.selection;
  75. } else {
  76. model = parseResult;
  77. }
  78. // Save to model.
  79. const modelRoot = document.getRoot( options.rootName || 'main' );
  80. document.enqueueChanges( () => {
  81. document.batch( options.batchType || 'transparent' )
  82. .remove( Range.createIn( modelRoot ) )
  83. .insert( Position.createAt( modelRoot, 0 ), model );
  84. // Clear selection
  85. document.selection.clearAttributes();
  86. document.selection.removeAllRanges();
  87. if ( selection ) {
  88. const ranges = [];
  89. for ( let viewRange of selection.getRanges() ) {
  90. ranges.push( ( mapper.toModelRange( viewRange ) ) );
  91. }
  92. document.selection.setRanges( ranges, selection.isBackward );
  93. if ( options.selectionAttributes ) {
  94. // Something overwrites selection attributes ??!!
  95. document.selection.setAttributesTo( options.selectionAttributes );
  96. }
  97. }
  98. } );
  99. }
  100. // Set parse as setData private method - needed for testing/spying.
  101. setData._parse = parse;
  102. /**
  103. * Converts model nodes to HTML-like string representation.
  104. *
  105. * @param {engine.model.RootElement|engine.model.Element|engine.model.Text|
  106. * engine.model.DocumentFragment} node Node to stringify.
  107. * @param {engine.model.Selection|engine.model.Position|engine.model.Range} [selectionOrPositionOrRange=null]
  108. * Selection instance which ranges will be included in returned string data. If Range instance is provided - it will be
  109. * converted to selection containing this range. If Position instance is provided - it will be converted to selection
  110. * containing one range collapsed at this position.
  111. * @returns {String} HTML-like string representing the model.
  112. */
  113. export function stringify( node, selectionOrPositionOrRange = null ) {
  114. const mapper = new Mapper();
  115. let selection, range;
  116. // Create a range wrapping passed node.
  117. if ( node instanceof RootElement || node instanceof ModelDocumentFragment ) {
  118. range = Range.createFromElement( node );
  119. } else {
  120. // Node is detached - create new document fragment.
  121. if ( !node.parent ) {
  122. const fragment = new ModelDocumentFragment( node );
  123. range = Range.createFromElement( fragment );
  124. } else {
  125. range = new Range(
  126. Position.createBefore( node ),
  127. Position.createAfter( node )
  128. );
  129. }
  130. }
  131. if ( selectionOrPositionOrRange instanceof ModelSelection ) {
  132. selection = selectionOrPositionOrRange;
  133. } else if ( selectionOrPositionOrRange instanceof Range ) {
  134. selection = new ModelSelection();
  135. selection.addRange( selectionOrPositionOrRange );
  136. } else if ( selectionOrPositionOrRange instanceof Position ) {
  137. selection = new ModelSelection();
  138. selection.addRange( new Range( selectionOrPositionOrRange, selectionOrPositionOrRange ) );
  139. }
  140. // Setup model -> view converter.
  141. const viewDocumentFragment = new ViewDocumentFragment();
  142. const viewSelection = new ViewSelection();
  143. const modelToView = new ModelConversionDispatcher( { mapper, viewSelection } );
  144. modelToView.on( 'insert:$text', insertText() );
  145. modelToView.on( 'insert', insertElement() );
  146. modelToView.on( 'selection', convertRangeSelection() );
  147. modelToView.on( 'selection', convertCollapsedSelection() );
  148. mapper.bindElements( node, viewDocumentFragment );
  149. // Convert view to model.
  150. modelToView.convertInsert( range );
  151. modelToView.convertSelection( selection );
  152. mapper.clearBindings();
  153. // Return parsed to data model.
  154. let data = viewStringify( viewDocumentFragment, viewSelection );
  155. // Replace valid XML text element name to `$text`.
  156. return data.replace( new RegExp( VIEW_TEXT_WITH_ATTRIBUTES_ELEMENT, 'g' ), DATA_STRING_TEXT_WITH_ATTRIBUTES_ELEMENT );
  157. }
  158. /**
  159. * Parses HTML-like string and returns model {@link engine.model.RootElement rootElement}.
  160. *
  161. * @param {String} data HTML-like string to be parsed.
  162. * @param {engine.model.schema} schema Schema instance for element validation.
  163. * @param {engine.model.mapper} [mapper=new Mapper()] Mapper instance to keep relation with selection.
  164. * @returns {engine.model.Element|engine.model.Text|engine.model.DocumentFragment|Object} Returns parsed model node or
  165. * object with two fields `model` and `selection` when selection ranges were included in data to parse.
  166. */
  167. export function parse( data, schema, mapper = new Mapper() ) {
  168. // Replace not accepted by XML `$text` element by valid one.
  169. data = data.replace( new RegExp( '\\' + DATA_STRING_TEXT_WITH_ATTRIBUTES_ELEMENT, 'g' ), VIEW_TEXT_WITH_ATTRIBUTES_ELEMENT );
  170. // Parse data to view using view utils.
  171. const view = viewParse( data );
  172. // Retrieve DocumentFragment and Selection from parsed view.
  173. let viewDocumentFragment, selection;
  174. if ( view.view && view.selection ) {
  175. viewDocumentFragment = view.view;
  176. selection = view.selection;
  177. } else {
  178. viewDocumentFragment = view;
  179. }
  180. viewDocumentFragment = viewDocumentFragment.parent ? viewDocumentFragment.parent : viewDocumentFragment;
  181. // Setup view -> model converter.
  182. const viewToModel = new ViewConversionDispatcher( { mapper, schema } );
  183. viewToModel.on( 'text', convertText() );
  184. viewToModel.on( `element:${ VIEW_TEXT_WITH_ATTRIBUTES_ELEMENT }`, convertToModelTextWithAttributes(), null, 9999 );
  185. viewToModel.on( 'element', convertToModelElement(), null, 9999 );
  186. viewToModel.on( 'documentFragment', convertToModelFragment(), null, 9999 );
  187. // Convert view to model.
  188. let root = viewToModel.convert( viewDocumentFragment, { context: [ '$root' ] } );
  189. // If root DocumentFragment contains only one element - return that element.
  190. if ( root instanceof DocumentFragment && root.childCount == 1 ) {
  191. root = root.getChild( 0 );
  192. }
  193. // Return model end selection when selection was specified.
  194. if ( selection ) {
  195. return {
  196. model: root,
  197. selection: selection
  198. };
  199. }
  200. // Otherwise return model only.
  201. return root;
  202. }
  203. // -- converters view -> model -----------------------------------------------------
  204. function convertToModelElement() {
  205. return ( evt, data, consumable, conversionApi ) => {
  206. const schemaQuery = {
  207. name: data.input.name,
  208. inside: data.context
  209. };
  210. // `VIEW_TEXT_WITH_ATTRIBUTES_ELEMENT` can not be validate because it won't be registered in schema.
  211. if ( data.input.name !== VIEW_TEXT_WITH_ATTRIBUTES_ELEMENT && !conversionApi.schema.check( schemaQuery ) ) {
  212. throw new Error( `Conversion error - element ${ schemaQuery.name } not allowed in specified context.` );
  213. }
  214. if ( consumable.consume( data.input, { name: true } ) ) {
  215. data.output = new ModelElement( data.input.name, data.input.getAttributes() );
  216. conversionApi.mapper.bindElements( data.output, data.input );
  217. data.context.push( data.output );
  218. data.output.appendChildren( conversionApi.convertChildren( data.input, consumable, data ) );
  219. data.context.pop();
  220. }
  221. };
  222. }
  223. function convertToModelTextWithAttributes() {
  224. return ( evt, data, consumable, conversionApi ) => {
  225. const schemaQuery = {
  226. name: '$text',
  227. inside: data.context
  228. };
  229. if ( !conversionApi.schema.check( schemaQuery ) ) {
  230. throw new Error( `Conversion error - element ${ schemaQuery.name } not allowed in specified context.` );
  231. }
  232. if ( conversionApi.schema.check( schemaQuery ) ) {
  233. if ( consumable.consume( data.input, { name: true } ) ) {
  234. data.output = new ModelText( data.input.getChild( 0 ).data, data.input.getAttributes() );
  235. }
  236. }
  237. };
  238. }
  239. // -- converters model -> view -----------------------------------------------------
  240. function insertElement() {
  241. return ( evt, data, consumable, conversionApi ) => {
  242. consumable.consume( data.item, 'insert' );
  243. const viewPosition = conversionApi.mapper.toViewPosition( data.range.start );
  244. const viewElement = new ViewElement( data.item.name, data.item.getAttributes() );
  245. conversionApi.mapper.bindElements( data.item, viewElement );
  246. viewWriter.insert( viewPosition, viewElement );
  247. };
  248. }
  249. function insertText() {
  250. return ( evt, data, consumable, conversionApi ) => {
  251. consumable.consume( data.item, 'insert' );
  252. const viewPosition = conversionApi.mapper.toViewPosition( data.range.start );
  253. const textAttributes = data.item.getAttributes();
  254. let node;
  255. if ( textAttributes.length ) {
  256. node = new ViewElement( VIEW_TEXT_WITH_ATTRIBUTES_ELEMENT, textAttributes );
  257. } else {
  258. node = new ViewText( data.item.data );
  259. }
  260. viewWriter.insert( viewPosition, node );
  261. evt.stop();
  262. };
  263. }