_source/plugins/list/plugin.js

   1 /*\r
   2 Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved.\r
   3 For licensing, see LICENSE.html or http://ckeditor.com/license\r
   4 */\r
   5 \r
   6 /**\r
   7  * @file Insert and remove numbered and bulleted lists.\r
   8  */\r
   9 \r
  10 (function()\r
  11 {\r
  12         var listNodeNames = { ol : 1, ul : 1 },\r
  13                 emptyTextRegex = /^[\n\r\t ]*$/;\r
  14 \r
  15         var whitespaces = CKEDITOR.dom.walker.whitespaces(),\r
  16                 bookmarks = CKEDITOR.dom.walker.bookmark(),\r
  17                 nonEmpty = function( node ){ return !( whitespaces( node ) || bookmarks( node ) ); };\r
  18 \r
  19         function cleanUpDirection( element )\r
  20         {\r
  21                 var dir, parent, parentDir;\r
  22                 if ( ( dir = element.getDirection() ) )\r
  23                 {\r
  24                         parent = element.getParent();\r
  25                         while ( parent && !( parentDir = parent.getDirection() ) )\r
  26                                 parent = parent.getParent();\r
  27 \r
  28                         if ( dir == parentDir )\r
  29                                 element.removeAttribute( 'dir' );\r
  30                 }\r
  31         }\r
  32 \r
  33         CKEDITOR.plugins.list = {\r
  34                 /*\r
  35                  * Convert a DOM list tree into a data structure that is easier to\r
  36                  * manipulate. This operation should be non-intrusive in the sense that it\r
  37                  * does not change the DOM tree, with the exception that it may add some\r
  38                  * markers to the list item nodes when database is specified.\r
  39                  */\r
  40                 listToArray : function( listNode, database, baseArray, baseIndentLevel, grandparentNode )\r
  41                 {\r
  42                         if ( !listNodeNames[ listNode.getName() ] )\r
  43                                 return [];\r
  44 \r
  45                         if ( !baseIndentLevel )\r
  46                                 baseIndentLevel = 0;\r
  47                         if ( !baseArray )\r
  48                                 baseArray = [];\r
  49 \r
  50                         // Iterate over all list items to and look for inner lists.\r
  51                         for ( var i = 0, count = listNode.getChildCount() ; i < count ; i++ )\r
  52                         {\r
  53                                 var listItem = listNode.getChild( i );\r
  54 \r
  55                                 // Fixing malformed nested lists by moving it into a previous list item. (#6236)\r
  56                                 if( listItem.type == CKEDITOR.NODE_ELEMENT && listItem.getName() in CKEDITOR.dtd.$list )\r
  57                                         CKEDITOR.plugins.list.listToArray( listItem, database, baseArray, baseIndentLevel + 1 );\r
  58 \r
  59                                 // It may be a text node or some funny stuff.\r
  60                                 if ( listItem.$.nodeName.toLowerCase() != 'li' )\r
  61                                         continue;\r
  62 \r
  63                                 var itemObj = { 'parent' : listNode, indent : baseIndentLevel, element : listItem, contents : [] };\r
  64                                 if ( !grandparentNode )\r
  65                                 {\r
  66                                         itemObj.grandparent = listNode.getParent();\r
  67                                         if ( itemObj.grandparent && itemObj.grandparent.$.nodeName.toLowerCase() == 'li' )\r
  68                                                 itemObj.grandparent = itemObj.grandparent.getParent();\r
  69                                 }\r
  70                                 else\r
  71                                         itemObj.grandparent = grandparentNode;\r
  72 \r
  73                                 if ( database )\r
  74                                         CKEDITOR.dom.element.setMarker( database, listItem, 'listarray_index', baseArray.length );\r
  75                                 baseArray.push( itemObj );\r
  76 \r
  77                                 for ( var j = 0, itemChildCount = listItem.getChildCount(), child; j < itemChildCount ; j++ )\r
  78                                 {\r
  79                                         child = listItem.getChild( j );\r
  80                                         if ( child.type == CKEDITOR.NODE_ELEMENT && listNodeNames[ child.getName() ] )\r
  81                                                 // Note the recursion here, it pushes inner list items with\r
  82                                                 // +1 indentation in the correct order.\r
  83                                                 CKEDITOR.plugins.list.listToArray( child, database, baseArray, baseIndentLevel + 1, itemObj.grandparent );\r
  84                                         else\r
  85                                                 itemObj.contents.push( child );\r
  86                                 }\r
  87                         }\r
  88                         return baseArray;\r
  89                 },\r
  90 \r
  91                 // Convert our internal representation of a list back to a DOM forest.\r
  92                 arrayToList : function( listArray, database, baseIndex, paragraphMode, dir )\r
  93                 {\r
  94                         if ( !baseIndex )\r
  95                                 baseIndex = 0;\r
  96                         if ( !listArray || listArray.length < baseIndex + 1 )\r
  97                                 return null;\r
  98                         var doc = listArray[ baseIndex ].parent.getDocument(),\r
  99                                 retval = new CKEDITOR.dom.documentFragment( doc ),\r
 100                                 rootNode = null,\r
 101                                 currentIndex = baseIndex,\r
 102                                 indentLevel = Math.max( listArray[ baseIndex ].indent, 0 ),\r
 103                                 currentListItem = null,\r
 104                                 orgDir,\r
 105                                 paragraphName = ( paragraphMode == CKEDITOR.ENTER_P ? 'p' : 'div' );\r
 106                         while ( 1 )\r
 107                         {\r
 108                                 var item = listArray[ currentIndex ];\r
 109 \r
 110                                 orgDir = item.element.getDirection( 1 );\r
 111 \r
 112                                 if ( item.indent == indentLevel )\r
 113                                 {\r
 114                                         if ( !rootNode || listArray[ currentIndex ].parent.getName() != rootNode.getName() )\r
 115                                         {\r
 116                                                 rootNode = listArray[ currentIndex ].parent.clone( false, 1 );\r
 117                                                 dir && rootNode.setAttribute( 'dir', dir );\r
 118                                                 retval.append( rootNode );\r
 119                                         }\r
 120                                         currentListItem = rootNode.append( item.element.clone( 0, 1 ) );\r
 121 \r
 122                                         if ( orgDir != rootNode.getDirection( 1 ) )\r
 123                                                 currentListItem.setAttribute( 'dir', orgDir );\r
 124 \r
 125                                         for ( var i = 0 ; i < item.contents.length ; i++ )\r
 126                                                 currentListItem.append( item.contents[i].clone( 1, 1 ) );\r
 127                                         currentIndex++;\r
 128                                 }\r
 129                                 else if ( item.indent == Math.max( indentLevel, 0 ) + 1 )\r
 130                                 {\r
 131                                         // Maintain original direction (#6861).\r
 132                                         var currDir = listArray[ currentIndex - 1 ].element.getDirection( 1 ),\r
 133                                                 listData = CKEDITOR.plugins.list.arrayToList( listArray, null, currentIndex, paragraphMode,\r
 134                                                 currDir != orgDir ? orgDir: null );\r
 135 \r
 136                                         // If the next block is an <li> with another list tree as the first\r
 137                                         // child, we'll need to append a filler (<br>/NBSP) or the list item\r
 138                                         // wouldn't be editable. (#6724)\r
 139                                         if ( !currentListItem.getChildCount() && CKEDITOR.env.ie && !( doc.$.documentMode > 7 ))\r
 140                                                 currentListItem.append( doc.createText( '\xa0' ) );\r
 141                                         currentListItem.append( listData.listNode );\r
 142                                         currentIndex = listData.nextIndex;\r
 143                                 }\r
 144                                 else if ( item.indent == -1 && !baseIndex && item.grandparent )\r
 145                                 {\r
 146                                         if ( listNodeNames[ item.grandparent.getName() ] )\r
 147                                                 currentListItem = item.element.clone( false, true );\r
 148                                         else\r
 149                                         {\r
 150                                                 // Create completely new blocks here.\r
 151                                                 if ( dir || item.element.hasAttributes() || paragraphMode != CKEDITOR.ENTER_BR )\r
 152                                                 {\r
 153                                                         currentListItem = doc.createElement( paragraphName );\r
 154                                                         item.element.copyAttributes( currentListItem, { type:1, value:1 } );\r
 155 \r
 156                                                         // There might be a case where there are no attributes in the element after all\r
 157                                                         // (i.e. when "type" or "value" are the only attributes set). In this case, if enterMode = BR,\r
 158                                                         // the current item should be a fragment.\r
 159                                                         if ( !dir && paragraphMode == CKEDITOR.ENTER_BR && !currentListItem.hasAttributes() )\r
 160                                                                 currentListItem = new CKEDITOR.dom.documentFragment( doc );\r
 161                                                 }\r
 162                                                 else\r
 163                                                         currentListItem = new CKEDITOR.dom.documentFragment( doc );\r
 164                                         }\r
 165 \r
 166                                         if ( currentListItem.type == CKEDITOR.NODE_ELEMENT )\r
 167                                         {\r
 168                                                 if ( item.grandparent.getDirection( 1 ) != orgDir )\r
 169                                                         currentListItem.setAttribute( 'dir', orgDir );\r
 170                                         }\r
 171 \r
 172                                         for ( i = 0 ; i < item.contents.length ; i++ )\r
 173                                                 currentListItem.append( item.contents[i].clone( 1, 1 ) );\r
 174 \r
 175                                         if ( currentListItem.type == CKEDITOR.NODE_DOCUMENT_FRAGMENT\r
 176                                                  && currentIndex != listArray.length - 1 )\r
 177                                         {\r
 178                                                 var last = currentListItem.getLast();\r
 179                                                 if ( last && last.type == CKEDITOR.NODE_ELEMENT\r
 180                                                                 && last.getAttribute( 'type' ) == '_moz' )\r
 181                                                 {\r
 182                                                         last.remove();\r
 183                                                 }\r
 184 \r
 185                                                 if ( !( last = currentListItem.getLast( nonEmpty )\r
 186                                                         && last.type == CKEDITOR.NODE_ELEMENT\r
 187                                                         && last.getName() in CKEDITOR.dtd.$block ) )\r
 188                                                 {\r
 189                                                         currentListItem.append( doc.createElement( 'br' ) );\r
 190                                                 }\r
 191                                         }\r
 192 \r
 193                                         if ( currentListItem.type == CKEDITOR.NODE_ELEMENT &&\r
 194                                                         currentListItem.getName() == paragraphName &&\r
 195                                                         currentListItem.$.firstChild )\r
 196                                         {\r
 197                                                 currentListItem.trim();\r
 198                                                 var firstChild = currentListItem.getFirst();\r
 199                                                 if ( firstChild.type == CKEDITOR.NODE_ELEMENT && firstChild.isBlockBoundary() )\r
 200                                                 {\r
 201                                                         var tmp = new CKEDITOR.dom.documentFragment( doc );\r
 202                                                         currentListItem.moveChildren( tmp );\r
 203                                                         currentListItem = tmp;\r
 204                                                 }\r
 205                                         }\r
 206 \r
 207                                         var currentListItemName = currentListItem.$.nodeName.toLowerCase();\r
 208                                         if ( !CKEDITOR.env.ie && ( currentListItemName == 'div' || currentListItemName == 'p' ) )\r
 209                                                 currentListItem.appendBogus();\r
 210                                         retval.append( currentListItem );\r
 211                                         rootNode = null;\r
 212                                         currentIndex++;\r
 213                                 }\r
 214                                 else\r
 215                                         return null;\r
 216 \r
 217                                 if ( listArray.length <= currentIndex || Math.max( listArray[ currentIndex ].indent, 0 ) < indentLevel )\r
 218                                         break;\r
 219                         }\r
 220 \r
 221                         if ( database )\r
 222                         {\r
 223                                 var currentNode = retval.getFirst(),\r
 224                                         listRoot = listArray[ 0 ].parent;\r
 225 \r
 226                                 while ( currentNode )\r
 227                                 {\r
 228                                         if ( currentNode.type == CKEDITOR.NODE_ELEMENT )\r
 229                                         {\r
 230                                                 // Clear marker attributes for the new list tree made of cloned nodes, if any.\r
 231                                                 CKEDITOR.dom.element.clearMarkers( database, currentNode );\r
 232 \r
 233                                                 // Clear redundant direction attribute specified on list items.\r
 234                                                 if ( currentNode.getName() in CKEDITOR.dtd.$listItem )\r
 235                                                         cleanUpDirection( currentNode );\r
 236                                         }\r
 237 \r
 238                                         currentNode = currentNode.getNextSourceNode();\r
 239                                 }\r
 240                         }\r
 241 \r
 242                         return { listNode : retval, nextIndex : currentIndex };\r
 243                 }\r
 244         };\r
 245 \r
 246         function onSelectionChange( evt )\r
 247         {\r
 248                 if ( evt.editor.readOnly )\r
 249                         return null;\r
 250 \r
 251                 var path = evt.data.path,\r
 252                         blockLimit = path.blockLimit,\r
 253                         elements = path.elements,\r
 254                         element,\r
 255                         i;\r
 256 \r
 257                 // Grouping should only happen under blockLimit.(#3940).\r
 258                 for ( i = 0 ; i < elements.length && ( element = elements[ i ] )\r
 259                           && !element.equals( blockLimit ); i++ )\r
 260                 {\r
 261                         if ( listNodeNames[ elements[ i ].getName() ] )\r
 262                                 return this.setState( this.type == elements[ i ].getName() ? CKEDITOR.TRISTATE_ON : CKEDITOR.TRISTATE_OFF );\r
 263                 }\r
 264 \r
 265                 return this.setState( CKEDITOR.TRISTATE_OFF );\r
 266         }\r
 267 \r
 268         function changeListType( editor, groupObj, database, listsCreated )\r
 269         {\r
 270                 // This case is easy...\r
 271                 // 1. Convert the whole list into a one-dimensional array.\r
 272                 // 2. Change the list type by modifying the array.\r
 273                 // 3. Recreate the whole list by converting the array to a list.\r
 274                 // 4. Replace the original list with the recreated list.\r
 275                 var listArray = CKEDITOR.plugins.list.listToArray( groupObj.root, database ),\r
 276                         selectedListItems = [];\r
 277 \r
 278                 for ( var i = 0 ; i < groupObj.contents.length ; i++ )\r
 279                 {\r
 280                         var itemNode = groupObj.contents[i];\r
 281                         itemNode = itemNode.getAscendant( 'li', true );\r
 282                         if ( !itemNode || itemNode.getCustomData( 'list_item_processed' ) )\r
 283                                 continue;\r
 284                         selectedListItems.push( itemNode );\r
 285                         CKEDITOR.dom.element.setMarker( database, itemNode, 'list_item_processed', true );\r
 286                 }\r
 287 \r
 288                 var root = groupObj.root,\r
 289                         fakeParent = root.getDocument().createElement( this.type );\r
 290                 // Copy all attributes, except from 'start' and 'type'.\r
 291                 root.copyAttributes( fakeParent, { start : 1, type : 1 } );\r
 292                 // The list-style-type property should be ignored.\r
 293                 fakeParent.removeStyle( 'list-style-type' );\r
 294 \r
 295                 for ( i = 0 ; i < selectedListItems.length ; i++ )\r
 296                 {\r
 297                         var listIndex = selectedListItems[i].getCustomData( 'listarray_index' );\r
 298                         listArray[listIndex].parent = fakeParent;\r
 299                 }\r
 300                 var newList = CKEDITOR.plugins.list.arrayToList( listArray, database, null, editor.config.enterMode );\r
 301                 var child, length = newList.listNode.getChildCount();\r
 302                 for ( i = 0 ; i < length && ( child = newList.listNode.getChild( i ) ) ; i++ )\r
 303                 {\r
 304                         if ( child.getName() == this.type )\r
 305                                 listsCreated.push( child );\r
 306                 }\r
 307                 newList.listNode.replace( groupObj.root );\r
 308         }\r
 309 \r
 310         var headerTagRegex = /^h[1-6]$/;\r
 311 \r
 312         function createList( editor, groupObj, listsCreated )\r
 313         {\r
 314                 var contents = groupObj.contents,\r
 315                         doc = groupObj.root.getDocument(),\r
 316                         listContents = [];\r
 317 \r
 318                 // It is possible to have the contents returned by DomRangeIterator to be the same as the root.\r
 319                 // e.g. when we're running into table cells.\r
 320                 // In such a case, enclose the childNodes of contents[0] into a <div>.\r
 321                 if ( contents.length == 1 && contents[0].equals( groupObj.root ) )\r
 322                 {\r
 323                         var divBlock = doc.createElement( 'div' );\r
 324                         contents[0].moveChildren && contents[0].moveChildren( divBlock );\r
 325                         contents[0].append( divBlock );\r
 326                         contents[0] = divBlock;\r
 327                 }\r
 328 \r
 329                 // Calculate the common parent node of all content blocks.\r
 330                 var commonParent = groupObj.contents[0].getParent();\r
 331                 for ( var i = 0 ; i < contents.length ; i++ )\r
 332                         commonParent = commonParent.getCommonAncestor( contents[i].getParent() );\r
 333 \r
 334                 var useComputedState = editor.config.useComputedState,\r
 335                         listDir, explicitDirection;\r
 336 \r
 337                 useComputedState = useComputedState === undefined || useComputedState;\r
 338 \r
 339                 // We want to insert things that are in the same tree level only, so calculate the contents again\r
 340                 // by expanding the selected blocks to the same tree level.\r
 341                 for ( i = 0 ; i < contents.length ; i++ )\r
 342                 {\r
 343                         var contentNode = contents[i],\r
 344                                 parentNode;\r
 345                         while ( ( parentNode = contentNode.getParent() ) )\r
 346                         {\r
 347                                 if ( parentNode.equals( commonParent ) )\r
 348                                 {\r
 349                                         listContents.push( contentNode );\r
 350 \r
 351                                         // Determine the lists's direction.\r
 352                                         if ( !explicitDirection && contentNode.getDirection() )\r
 353                                                 explicitDirection = 1;\r
 354 \r
 355                                         var itemDir = contentNode.getDirection( useComputedState );\r
 356 \r
 357                                         if ( listDir !== null )\r
 358                                         {\r
 359                                                 // If at least one LI have a different direction than current listDir, we can't have listDir.\r
 360                                                 if ( listDir && listDir != itemDir )\r
 361                                                         listDir = null;\r
 362                                                 else\r
 363                                                         listDir = itemDir;\r
 364                                         }\r
 365 \r
 366                                         break;\r
 367                                 }\r
 368                                 contentNode = parentNode;\r
 369                         }\r
 370                 }\r
 371 \r
 372                 if ( listContents.length < 1 )\r
 373                         return;\r
 374 \r
 375                 // Insert the list to the DOM tree.\r
 376                 var insertAnchor = listContents[ listContents.length - 1 ].getNext(),\r
 377                         listNode = doc.createElement( this.type );\r
 378 \r
 379                 listsCreated.push( listNode );\r
 380 \r
 381                 var contentBlock, listItem;\r
 382 \r
 383                 while ( listContents.length )\r
 384                 {\r
 385                         contentBlock = listContents.shift();\r
 386                         listItem = doc.createElement( 'li' );\r
 387 \r
 388                         // Preserve preformat block and heading structure when converting to list item. (#5335) (#5271)\r
 389                         if ( contentBlock.is( 'pre' ) || headerTagRegex.test( contentBlock.getName() ) )\r
 390                                 contentBlock.appendTo( listItem );\r
 391                         else\r
 392                         {\r
 393                                 contentBlock.copyAttributes( listItem );\r
 394                                 // Remove direction attribute after it was merged into list root. (#7657)\r
 395                                 if ( listDir && contentBlock.getDirection() )\r
 396                                 {\r
 397                                         listItem.removeStyle( 'direction' );\r
 398                                         listItem.removeAttribute( 'dir' );\r
 399                                 }\r
 400                                 contentBlock.moveChildren( listItem );\r
 401                                 contentBlock.remove();\r
 402                         }\r
 403 \r
 404                         listItem.appendTo( listNode );\r
 405                 }\r
 406 \r
 407                 // Apply list root dir only if it has been explicitly declared.\r
 408                 if ( listDir && explicitDirection )\r
 409                         listNode.setAttribute( 'dir', listDir );\r
 410 \r
 411                 if ( insertAnchor )\r
 412                         listNode.insertBefore( insertAnchor );\r
 413                 else\r
 414                         listNode.appendTo( commonParent );\r
 415         }\r
 416 \r
 417         function removeList( editor, groupObj, database )\r
 418         {\r
 419                 // This is very much like the change list type operation.\r
 420                 // Except that we're changing the selected items' indent to -1 in the list array.\r
 421                 var listArray = CKEDITOR.plugins.list.listToArray( groupObj.root, database ),\r
 422                         selectedListItems = [];\r
 423 \r
 424                 for ( var i = 0 ; i < groupObj.contents.length ; i++ )\r
 425                 {\r
 426                         var itemNode = groupObj.contents[i];\r
 427                         itemNode = itemNode.getAscendant( 'li', true );\r
 428                         if ( !itemNode || itemNode.getCustomData( 'list_item_processed' ) )\r
 429                                 continue;\r
 430                         selectedListItems.push( itemNode );\r
 431                         CKEDITOR.dom.element.setMarker( database, itemNode, 'list_item_processed', true );\r
 432                 }\r
 433 \r
 434                 var lastListIndex = null;\r
 435                 for ( i = 0 ; i < selectedListItems.length ; i++ )\r
 436                 {\r
 437                         var listIndex = selectedListItems[i].getCustomData( 'listarray_index' );\r
 438                         listArray[listIndex].indent = -1;\r
 439                         lastListIndex = listIndex;\r
 440                 }\r
 441 \r
 442                 // After cutting parts of the list out with indent=-1, we still have to maintain the array list\r
 443                 // model's nextItem.indent <= currentItem.indent + 1 invariant. Otherwise the array model of the\r
 444                 // list cannot be converted back to a real DOM list.\r
 445                 for ( i = lastListIndex + 1 ; i < listArray.length ; i++ )\r
 446                 {\r
 447                         if ( listArray[i].indent > listArray[i-1].indent + 1 )\r
 448                         {\r
 449                                 var indentOffset = listArray[i-1].indent + 1 - listArray[i].indent;\r
 450                                 var oldIndent = listArray[i].indent;\r
 451                                 while ( listArray[i] && listArray[i].indent >= oldIndent )\r
 452                                 {\r
 453                                         listArray[i].indent += indentOffset;\r
 454                                         i++;\r
 455                                 }\r
 456                                 i--;\r
 457                         }\r
 458                 }\r
 459 \r
 460                 var newList = CKEDITOR.plugins.list.arrayToList( listArray, database, null, editor.config.enterMode,\r
 461                         groupObj.root.getAttribute( 'dir' ) );\r
 462 \r
 463                 // Compensate <br> before/after the list node if the surrounds are non-blocks.(#3836)\r
 464                 var docFragment = newList.listNode, boundaryNode, siblingNode;\r
 465                 function compensateBrs( isStart )\r
 466                 {\r
 467                         if ( ( boundaryNode = docFragment[ isStart ? 'getFirst' : 'getLast' ]() )\r
 468                                  && !( boundaryNode.is && boundaryNode.isBlockBoundary() )\r
 469                                  && ( siblingNode = groupObj.root[ isStart ? 'getPrevious' : 'getNext' ]\r
 470                                       ( CKEDITOR.dom.walker.whitespaces( true ) ) )\r
 471                                  && !( siblingNode.is && siblingNode.isBlockBoundary( { br : 1 } ) ) )\r
 472                                 editor.document.createElement( 'br' )[ isStart ? 'insertBefore' : 'insertAfter' ]( boundaryNode );\r
 473                 }\r
 474                 compensateBrs( true );\r
 475                 compensateBrs();\r
 476 \r
 477                 docFragment.replace( groupObj.root );\r
 478         }\r
 479 \r
 480         function listCommand( name, type )\r
 481         {\r
 482                 this.name = name;\r
 483                 this.type = type;\r
 484         }\r
 485 \r
 486         // Move direction attribute from root to list items.\r
 487         function dirToListItems( list )\r
 488         {\r
 489                 var dir = list.getDirection();\r
 490                 if ( dir )\r
 491                 {\r
 492                         for ( var i = 0, children = list.getChildren(), child; child = children.getItem( i ), i < children.count(); i++ )\r
 493                         {\r
 494                                 if ( child.type == CKEDITOR.NODE_ELEMENT && child.is( 'li' ) && !child.getDirection() )\r
 495                                         child.setAttribute( 'dir', dir );\r
 496                         }\r
 497 \r
 498                         list.removeAttribute( 'dir' );\r
 499                 }\r
 500         }\r
 501 \r
 502         listCommand.prototype = {\r
 503                 exec : function( editor )\r
 504                 {\r
 505                         var doc = editor.document,\r
 506                                 config = editor.config,\r
 507                                 selection = editor.getSelection(),\r
 508                                 ranges = selection && selection.getRanges( true );\r
 509 \r
 510                         // There should be at least one selected range.\r
 511                         if ( !ranges || ranges.length < 1 )\r
 512                                 return;\r
 513 \r
 514                         // Midas lists rule #1 says we can create a list even in an empty document.\r
 515                         // But DOM iterator wouldn't run if the document is really empty.\r
 516                         // So create a paragraph if the document is empty and we're going to create a list.\r
 517                         if ( this.state == CKEDITOR.TRISTATE_OFF )\r
 518                         {\r
 519                                 var body = doc.getBody();\r
 520                                 if ( !body.getFirst( nonEmpty ) )\r
 521                                 {\r
 522                                         config.enterMode == CKEDITOR.ENTER_BR ?\r
 523                                                 body.appendBogus() :\r
 524                                                 ranges[ 0 ].fixBlock( 1, config.enterMode == CKEDITOR.ENTER_P ? 'p' : 'div' );\r
 525 \r
 526                                         selection.selectRanges( ranges );\r
 527                                 }\r
 528                                 // Maybe a single range there enclosing the whole list,\r
 529                                 // turn on the list state manually(#4129).\r
 530                                 else\r
 531                                 {\r
 532                                         var range = ranges.length == 1 && ranges[ 0 ],\r
 533                                                 enclosedNode = range && range.getEnclosedNode();\r
 534                                         if ( enclosedNode && enclosedNode.is\r
 535                                                 && this.type == enclosedNode.getName() )\r
 536                                                         this.setState( CKEDITOR.TRISTATE_ON );\r
 537                                 }\r
 538                         }\r
 539 \r
 540                         var bookmarks = selection.createBookmarks( true );\r
 541 \r
 542                         // Group the blocks up because there are many cases where multiple lists have to be created,\r
 543                         // or multiple lists have to be cancelled.\r
 544                         var listGroups = [],\r
 545                                 database = {},\r
 546                                 rangeIterator = ranges.createIterator(),\r
 547                                 index = 0;\r
 548 \r
 549                         while ( ( range = rangeIterator.getNextRange() ) && ++index )\r
 550                         {\r
 551                                 var boundaryNodes = range.getBoundaryNodes(),\r
 552                                         startNode = boundaryNodes.startNode,\r
 553                                         endNode = boundaryNodes.endNode;\r
 554 \r
 555                                 if ( startNode.type == CKEDITOR.NODE_ELEMENT && startNode.getName() == 'td' )\r
 556                                         range.setStartAt( boundaryNodes.startNode, CKEDITOR.POSITION_AFTER_START );\r
 557 \r
 558                                 if ( endNode.type == CKEDITOR.NODE_ELEMENT && endNode.getName() == 'td' )\r
 559                                         range.setEndAt( boundaryNodes.endNode, CKEDITOR.POSITION_BEFORE_END );\r
 560 \r
 561                                 var iterator = range.createIterator(),\r
 562                                         block;\r
 563 \r
 564                                 iterator.forceBrBreak = ( this.state == CKEDITOR.TRISTATE_OFF );\r
 565 \r
 566                                 while ( ( block = iterator.getNextParagraph() ) )\r
 567                                 {\r
 568                                         // Avoid duplicate blocks get processed across ranges.\r
 569                                         if( block.getCustomData( 'list_block' ) )\r
 570                                                 continue;\r
 571                                         else\r
 572                                                 CKEDITOR.dom.element.setMarker( database, block, 'list_block', 1 );\r
 573 \r
 574                                         var path = new CKEDITOR.dom.elementPath( block ),\r
 575                                                 pathElements = path.elements,\r
 576                                                 pathElementsCount = pathElements.length,\r
 577                                                 listNode = null,\r
 578                                                 processedFlag = 0,\r
 579                                                 blockLimit = path.blockLimit,\r
 580                                                 element;\r
 581 \r
 582                                         // First, try to group by a list ancestor.\r
 583                                         for ( var i = pathElementsCount - 1; i >= 0 && ( element = pathElements[ i ] ); i-- )\r
 584                                         {\r
 585                                                 if ( listNodeNames[ element.getName() ]\r
 586                                                          && blockLimit.contains( element ) )     // Don't leak outside block limit (#3940).\r
 587                                                 {\r
 588                                                         // If we've encountered a list inside a block limit\r
 589                                                         // The last group object of the block limit element should\r
 590                                                         // no longer be valid. Since paragraphs after the list\r
 591                                                         // should belong to a different group of paragraphs before\r
 592                                                         // the list. (Bug #1309)\r
 593                                                         blockLimit.removeCustomData( 'list_group_object_' + index );\r
 594 \r
 595                                                         var groupObj = element.getCustomData( 'list_group_object' );\r
 596                                                         if ( groupObj )\r
 597                                                                 groupObj.contents.push( block );\r
 598                                                         else\r
 599                                                         {\r
 600                                                                 groupObj = { root : element, contents : [ block ] };\r
 601                                                                 listGroups.push( groupObj );\r
 602                                                                 CKEDITOR.dom.element.setMarker( database, element, 'list_group_object', groupObj );\r
 603                                                         }\r
 604                                                         processedFlag = 1;\r
 605                                                         break;\r
 606                                                 }\r
 607                                         }\r
 608 \r
 609                                         if ( processedFlag )\r
 610                                                 continue;\r
 611 \r
 612                                         // No list ancestor? Group by block limit, but don't mix contents from different ranges.\r
 613                                         var root = blockLimit;\r
 614                                         if ( root.getCustomData( 'list_group_object_' + index ) )\r
 615                                                 root.getCustomData( 'list_group_object_' + index ).contents.push( block );\r
 616                                         else\r
 617                                         {\r
 618                                                 groupObj = { root : root, contents : [ block ] };\r
 619                                                 CKEDITOR.dom.element.setMarker( database, root, 'list_group_object_' + index, groupObj );\r
 620                                                 listGroups.push( groupObj );\r
 621                                         }\r
 622                                 }\r
 623                         }\r
 624 \r
 625                         // Now we have two kinds of list groups, groups rooted at a list, and groups rooted at a block limit element.\r
 626                         // We either have to build lists or remove lists, for removing a list does not makes sense when we are looking\r
 627                         // at the group that's not rooted at lists. So we have three cases to handle.\r
 628                         var listsCreated = [];\r
 629                         while ( listGroups.length > 0 )\r
 630                         {\r
 631                                 groupObj = listGroups.shift();\r
 632                                 if ( this.state == CKEDITOR.TRISTATE_OFF )\r
 633                                 {\r
 634                                         if ( listNodeNames[ groupObj.root.getName() ] )\r
 635                                                 changeListType.call( this, editor, groupObj, database, listsCreated );\r
 636                                         else\r
 637                                                 createList.call( this, editor, groupObj, listsCreated );\r
 638                                 }\r
 639                                 else if ( this.state == CKEDITOR.TRISTATE_ON && listNodeNames[ groupObj.root.getName() ] )\r
 640                                         removeList.call( this, editor, groupObj, database );\r
 641                         }\r
 642 \r
 643                         // For all new lists created, merge adjacent, same type lists.\r
 644                         for ( i = 0 ; i < listsCreated.length ; i++ )\r
 645                         {\r
 646                                 listNode = listsCreated[i];\r
 647                                 var mergeSibling, listCommand = this;\r
 648                                 ( mergeSibling = function( rtl ){\r
 649 \r
 650                                         var sibling = listNode[ rtl ?\r
 651                                                 'getPrevious' : 'getNext' ]( CKEDITOR.dom.walker.whitespaces( true ) );\r
 652                                         if ( sibling && sibling.getName &&\r
 653                                                  sibling.getName() == listCommand.type )\r
 654                                         {\r
 655 \r
 656                                                 // In case to be merged lists have difference directions. (#7448)\r
 657                                                 if ( sibling.getDirection( 1 ) != listNode.getDirection( 1 ) )\r
 658                                                         dirToListItems( listNode.getDirection() ? listNode : sibling );\r
 659 \r
 660                                                 sibling.remove();\r
 661                                                 // Move children order by merge direction.(#3820)\r
 662                                                 sibling.moveChildren( listNode, rtl );\r
 663                                         }\r
 664                                 } )();\r
 665                                 mergeSibling( 1 );\r
 666                         }\r
 667 \r
 668                         // Clean up, restore selection and update toolbar button states.\r
 669                         CKEDITOR.dom.element.clearAllMarkers( database );\r
 670                         selection.selectBookmarks( bookmarks );\r
 671                         editor.focus();\r
 672                 }\r
 673         };\r
 674 \r
 675         var dtd = CKEDITOR.dtd;\r
 676         var tailNbspRegex = /[\t\r\n ]*(?:&nbsp;|\xa0)$/;\r
 677 \r
 678         function indexOfFirstChildElement( element, tagNameList )\r
 679         {\r
 680                 var child,\r
 681                         children = element.children,\r
 682                         length = children.length;\r
 683 \r
 684                 for ( var i = 0 ; i < length ; i++ )\r
 685                 {\r
 686                         child = children[ i ];\r
 687                         if ( child.name && ( child.name in tagNameList ) )\r
 688                                 return i;\r
 689                 }\r
 690 \r
 691                 return length;\r
 692         }\r
 693 \r
 694         function getExtendNestedListFilter( isHtmlFilter )\r
 695         {\r
 696                 // An element filter function that corrects nested list start in an empty\r
 697                 // list item for better displaying/outputting. (#3165)\r
 698                 return function( listItem )\r
 699                 {\r
 700                         var children = listItem.children,\r
 701                                 firstNestedListIndex = indexOfFirstChildElement( listItem, dtd.$list ),\r
 702                                 firstNestedList = children[ firstNestedListIndex ],\r
 703                                 nodeBefore = firstNestedList && firstNestedList.previous,\r
 704                                 tailNbspmatch;\r
 705 \r
 706                         if ( nodeBefore\r
 707                                 && ( nodeBefore.name && nodeBefore.name == 'br'\r
 708                                         || nodeBefore.value && ( tailNbspmatch = nodeBefore.value.match( tailNbspRegex ) ) ) )\r
 709                         {\r
 710                                 var fillerNode = nodeBefore;\r
 711 \r
 712                                 // Always use 'nbsp' as filler node if we found a nested list appear\r
 713                                 // in front of a list item.\r
 714                                 if ( !( tailNbspmatch && tailNbspmatch.index ) && fillerNode == children[ 0 ] )\r
 715                                         children[ 0 ] = ( isHtmlFilter || CKEDITOR.env.ie ) ?\r
 716                                                          new CKEDITOR.htmlParser.text( '\xa0' ) :\r
 717                                                                          new CKEDITOR.htmlParser.element( 'br', {} );\r
 718 \r
 719                                 // Otherwise the filler is not needed anymore.\r
 720                                 else if ( fillerNode.name == 'br' )\r
 721                                         children.splice( firstNestedListIndex - 1, 1 );\r
 722                                 else\r
 723                                         fillerNode.value = fillerNode.value.replace( tailNbspRegex, '' );\r
 724                         }\r
 725 \r
 726                 };\r
 727         }\r
 728 \r
 729         var defaultListDataFilterRules = { elements : {} };\r
 730         for ( var i in dtd.$listItem )\r
 731                 defaultListDataFilterRules.elements[ i ] = getExtendNestedListFilter();\r
 732 \r
 733         var defaultListHtmlFilterRules = { elements : {} };\r
 734         for ( i in dtd.$listItem )\r
 735                 defaultListHtmlFilterRules.elements[ i ] = getExtendNestedListFilter( true );\r
 736 \r
 737         CKEDITOR.plugins.add( 'list',\r
 738         {\r
 739                 init : function( editor )\r
 740                 {\r
 741                         // Register commands.\r
 742                         var numberedListCommand = editor.addCommand( 'numberedlist', new listCommand( 'numberedlist', 'ol' ) ),\r
 743                                 bulletedListCommand = editor.addCommand( 'bulletedlist', new listCommand( 'bulletedlist', 'ul' ) );\r
 744 \r
 745                         // Register the toolbar button.\r
 746                         editor.ui.addButton( 'NumberedList',\r
 747                                 {\r
 748                                         label : editor.lang.numberedlist,\r
 749                                         command : 'numberedlist'\r
 750                                 } );\r
 751                         editor.ui.addButton( 'BulletedList',\r
 752                                 {\r
 753                                         label : editor.lang.bulletedlist,\r
 754                                         command : 'bulletedlist'\r
 755                                 } );\r
 756 \r
 757                         // Register the state changing handlers.\r
 758                         editor.on( 'selectionChange', CKEDITOR.tools.bind( onSelectionChange, numberedListCommand ) );\r
 759                         editor.on( 'selectionChange', CKEDITOR.tools.bind( onSelectionChange, bulletedListCommand ) );\r
 760                 },\r
 761 \r
 762                 afterInit : function ( editor )\r
 763                 {\r
 764                         var dataProcessor = editor.dataProcessor;\r
 765                         if ( dataProcessor )\r
 766                         {\r
 767                                 dataProcessor.dataFilter.addRules( defaultListDataFilterRules );\r
 768                                 dataProcessor.htmlFilter.addRules( defaultListHtmlFilterRules );\r
 769                         }\r
 770                 },\r
 771 \r
 772                 requires : [ 'domiterator' ]\r
 773         } );\r
 774 })();\r