library/tinymce/jscripts/tiny_mce/plugins/spellchecker/editor_plugin_src.js

   1 /**\r
   2  * editor_plugin_src.js\r
   3  *\r
   4  * Copyright 2009, Moxiecode Systems AB\r
   5  * Released under LGPL License.\r
   6  *\r
   7  * License: http://tinymce.moxiecode.com/license\r
   8  * Contributing: http://tinymce.moxiecode.com/contributing\r
   9  */\r
  10 \r
  11 (function() {\r
  12         var JSONRequest = tinymce.util.JSONRequest, each = tinymce.each, DOM = tinymce.DOM;\r
  13 \r
  14         tinymce.create('tinymce.plugins.SpellcheckerPlugin', {\r
  15                 getInfo : function() {\r
  16                         return {\r
  17                                 longname : 'Spellchecker',\r
  18                                 author : 'Moxiecode Systems AB',\r
  19                                 authorurl : 'http://tinymce.moxiecode.com',\r
  20                                 infourl : 'http://wiki.moxiecode.com/index.php/TinyMCE:Plugins/spellchecker',\r
  21                                 version : tinymce.majorVersion + "." + tinymce.minorVersion\r
  22                         };\r
  23                 },\r
  24 \r
  25                 init : function(ed, url) {\r
  26                         var t = this, cm;\r
  27 \r
  28                         t.url = url;\r
  29                         t.editor = ed;\r
  30                         t.rpcUrl = ed.getParam("spellchecker_rpc_url", "{backend}");\r
  31 \r
  32                         if (t.rpcUrl == '{backend}') {\r
  33                                 // Sniff if the browser supports native spellchecking (Don't know of a better way)\r
  34                                 if (tinymce.isIE)\r
  35                                         return;\r
  36 \r
  37                                 t.hasSupport = true;\r
  38 \r
  39                                 // Disable the context menu when spellchecking is active\r
  40                                 ed.onContextMenu.addToTop(function(ed, e) {\r
  41                                         if (t.active)\r
  42                                                 return false;\r
  43                                 });\r
  44                         }\r
  45 \r
  46                         // Register commands\r
  47                         ed.addCommand('mceSpellCheck', function() {\r
  48                                 if (t.rpcUrl == '{backend}') {\r
  49                                         // Enable/disable native spellchecker\r
  50                                         t.editor.getBody().spellcheck = t.active = !t.active;\r
  51                                         return;\r
  52                                 }\r
  53 \r
  54                                 if (!t.active) {\r
  55                                         ed.setProgressState(1);\r
  56                                         t._sendRPC('checkWords', [t.selectedLang, t._getWords()], function(r) {\r
  57                                                 if (r.length > 0) {\r
  58                                                         t.active = 1;\r
  59                                                         t._markWords(r);\r
  60                                                         ed.setProgressState(0);\r
  61                                                         ed.nodeChanged();\r
  62                                                 } else {\r
  63                                                         ed.setProgressState(0);\r
  64 \r
  65                                                         if (ed.getParam('spellchecker_report_no_misspellings', true))\r
  66                                                                 ed.windowManager.alert('spellchecker.no_mpell');\r
  67                                                 }\r
  68                                         });\r
  69                                 } else\r
  70                                         t._done();\r
  71                         });\r
  72 \r
  73                         if (ed.settings.content_css !== false)\r
  74                                 ed.contentCSS.push(url + '/css/content.css');\r
  75 \r
  76                         ed.onClick.add(t._showMenu, t);\r
  77                         ed.onContextMenu.add(t._showMenu, t);\r
  78                         ed.onBeforeGetContent.add(function() {\r
  79                                 if (t.active)\r
  80                                         t._removeWords();\r
  81                         });\r
  82 \r
  83                         ed.onNodeChange.add(function(ed, cm) {\r
  84                                 cm.setActive('spellchecker', t.active);\r
  85                         });\r
  86 \r
  87                         ed.onSetContent.add(function() {\r
  88                                 t._done();\r
  89                         });\r
  90 \r
  91                         ed.onBeforeGetContent.add(function() {\r
  92                                 t._done();\r
  93                         });\r
  94 \r
  95                         ed.onBeforeExecCommand.add(function(ed, cmd) {\r
  96                                 if (cmd == 'mceFullScreen')\r
  97                                         t._done();\r
  98                         });\r
  99 \r
 100                         // Find selected language\r
 101                         t.languages = {};\r
 102                         each(ed.getParam('spellchecker_languages', '+English=en,Danish=da,Dutch=nl,Finnish=fi,French=fr,German=de,Italian=it,Polish=pl,Portuguese=pt,Spanish=es,Swedish=sv', 'hash'), function(v, k) {\r
 103                                 if (k.indexOf('+') === 0) {\r
 104                                         k = k.substring(1);\r
 105                                         t.selectedLang = v;\r
 106                                 }\r
 107 \r
 108                                 t.languages[k] = v;\r
 109                         });\r
 110                 },\r
 111 \r
 112                 createControl : function(n, cm) {\r
 113                         var t = this, c, ed = t.editor;\r
 114 \r
 115                         if (n == 'spellchecker') {\r
 116                                 // Use basic button if we use the native spellchecker\r
 117                                 if (t.rpcUrl == '{backend}') {\r
 118                                         // Create simple toggle button if we have native support\r
 119                                         if (t.hasSupport)\r
 120                                                 c = cm.createButton(n, {title : 'spellchecker.desc', cmd : 'mceSpellCheck', scope : t});\r
 121 \r
 122                                         return c;\r
 123                                 }\r
 124 \r
 125                                 c = cm.createSplitButton(n, {title : 'spellchecker.desc', cmd : 'mceSpellCheck', scope : t});\r
 126 \r
 127                                 c.onRenderMenu.add(function(c, m) {\r
 128                                         m.add({title : 'spellchecker.langs', 'class' : 'mceMenuItemTitle'}).setDisabled(1);\r
 129                                         t.menuItems = {};\r
 130                                         each(t.languages, function(v, k) {\r
 131                                                 var o = {icon : 1}, mi;\r
 132 \r
 133                                                 o.onclick = function() {\r
 134                                                         if (v == t.selectedLang) {\r
 135                                                                 return;\r
 136                                                         }\r
 137                                                         t._updateMenu(mi);\r
 138                                                         t.selectedLang = v;\r
 139                                                 };\r
 140 \r
 141                                                 o.title = k;\r
 142                                                 mi = m.add(o);\r
 143                                                 mi.setSelected(v == t.selectedLang);\r
 144                                                 t.menuItems[v] = mi;\r
 145                                                 if (v == t.selectedLang)\r
 146                                                         t.selectedItem = mi;\r
 147                                         });\r
 148                                 });\r
 149 \r
 150 \r
 151 \r
 152                                 return c;\r
 153                         }\r
 154                 },\r
 155 \r
 156                 setLanguage: function(lang) {\r
 157                         var t = this;\r
 158 \r
 159                         if (lang == t.selectedLang) {\r
 160                                 // allowed\r
 161                                 return;\r
 162                         }\r
 163 \r
 164                         if (tinymce.grep(t.languages, function(v) { return v === lang; }).length === 0) {\r
 165                                 throw "Unknown language: " + lang;\r
 166                         }\r
 167 \r
 168                         t.selectedLang = lang;\r
 169 \r
 170                         // if the menu has been shown, update it as well\r
 171                         if (t.menuItems) {\r
 172                                 t._updateMenu(t.menuItems[lang]);\r
 173                         }\r
 174 \r
 175                         if (t.active) {\r
 176                                 // clear error in the old language.\r
 177                                 t._done();\r
 178 \r
 179                                 // Don't immediately block the UI to check spelling in the new language, this is an API not a user action.\r
 180                         }\r
 181                 },\r
 182 \r
 183                 // Internal functions\r
 184 \r
 185                 _updateMenu: function(mi) {\r
 186                         mi.setSelected(1);\r
 187                         this.selectedItem.setSelected(0);\r
 188                         this.selectedItem = mi;\r
 189                 },\r
 190 \r
 191                 _walk : function(n, f) {\r
 192                         var d = this.editor.getDoc(), w;\r
 193 \r
 194                         if (d.createTreeWalker) {\r
 195                                 w = d.createTreeWalker(n, NodeFilter.SHOW_TEXT, null, false);\r
 196 \r
 197                                 while ((n = w.nextNode()) != null)\r
 198                                         f.call(this, n);\r
 199                         } else\r
 200                                 tinymce.walk(n, f, 'childNodes');\r
 201                 },\r
 202 \r
 203                 _getSeparators : function() {\r
 204                         var re = '', i, str = this.editor.getParam('spellchecker_word_separator_chars', '\\s!"#$%&()*+,-./:;<=>?@[\]^_{|}§©«®±¶·¸»¼½¾¿×÷¤\u201d\u201c');\r
 205 \r
 206                         // Build word separator regexp\r
 207                         for (i=0; i<str.length; i++)\r
 208                                 re += '\\' + str.charAt(i);\r
 209 \r
 210                         return re;\r
 211                 },\r
 212 \r
 213                 _getWords : function() {\r
 214                         var ed = this.editor, wl = [], tx = '', lo = {}, rawWords = [];\r
 215 \r
 216                         // Get area text\r
 217                         this._walk(ed.getBody(), function(n) {\r
 218                                 if (n.nodeType == 3)\r
 219                                         tx += n.nodeValue + ' ';\r
 220                         });\r
 221 \r
 222                         // split the text up into individual words\r
 223                         if (ed.getParam('spellchecker_word_pattern')) {\r
 224                                 // look for words that match the pattern\r
 225                                 rawWords = tx.match('(' + ed.getParam('spellchecker_word_pattern') + ')', 'gi');\r
 226                         } else {\r
 227                                 // Split words by separator\r
 228                                 tx = tx.replace(new RegExp('([0-9]|[' + this._getSeparators() + '])', 'g'), ' ');\r
 229                                 tx = tinymce.trim(tx.replace(/(\s+)/g, ' '));\r
 230                                 rawWords = tx.split(' ');\r
 231                         }\r
 232 \r
 233                         // Build word array and remove duplicates\r
 234                         each(rawWords, function(v) {\r
 235                                 if (!lo[v]) {\r
 236                                         wl.push(v);\r
 237                                         lo[v] = 1;\r
 238                                 }\r
 239                         });\r
 240 \r
 241                         return wl;\r
 242                 },\r
 243 \r
 244                 _removeWords : function(w) {\r
 245                         var ed = this.editor, dom = ed.dom, se = ed.selection, r = se.getRng(true);\r
 246 \r
 247                         each(dom.select('span').reverse(), function(n) {\r
 248                                 if (n && (dom.hasClass(n, 'mceItemHiddenSpellWord') || dom.hasClass(n, 'mceItemHidden'))) {\r
 249                                         if (!w || dom.decode(n.innerHTML) == w)\r
 250                                                 dom.remove(n, 1);\r
 251                                 }\r
 252                         });\r
 253 \r
 254                         se.setRng(r);\r
 255                 },\r
 256 \r
 257                 _markWords : function(wl) {\r
 258                         var ed = this.editor, dom = ed.dom, doc = ed.getDoc(), se = ed.selection, r = se.getRng(true), nl = [],\r
 259                                 w = wl.join('|'), re = this._getSeparators(), rx = new RegExp('(^|[' + re + '])(' + w + ')(?=[' + re + ']|$)', 'g');\r
 260 \r
 261                         // Collect all text nodes\r
 262                         this._walk(ed.getBody(), function(n) {\r
 263                                 if (n.nodeType == 3) {\r
 264                                         nl.push(n);\r
 265                                 }\r
 266                         });\r
 267 \r
 268                         // Wrap incorrect words in spans\r
 269                         each(nl, function(n) {\r
 270                                 var node, elem, txt, pos, v = n.nodeValue;\r
 271 \r
 272                                 rx.lastIndex = 0;\r
 273                                 if (rx.test(v)) {\r
 274                                         // Encode the content\r
 275                                         v = dom.encode(v);\r
 276                                         // Create container element\r
 277                                         elem = dom.create('span', {'class' : 'mceItemHidden'});\r
 278 \r
 279                                         // Following code fixes IE issues by creating text nodes\r
 280                                         // using DOM methods instead of innerHTML.\r
 281                                         // Bug #3124: <PRE> elements content is broken after spellchecking.\r
 282                                         // Bug #1408: Preceding whitespace characters are removed\r
 283                                         // @TODO: I'm not sure that both are still issues on IE9.\r
 284                                         if (tinymce.isIE) {\r
 285                                                 // Enclose mispelled words with temporal tag\r
 286                                                 v = v.replace(rx, '$1<mcespell>$2</mcespell>');\r
 287                                                 // Loop over the content finding mispelled words\r
 288                                                 while ((pos = v.indexOf('<mcespell>')) != -1) {\r
 289                                                         // Add text node for the content before the word\r
 290                                                         txt = v.substring(0, pos);\r
 291                                                         if (txt.length) {\r
 292                                                                 node = doc.createTextNode(dom.decode(txt));\r
 293                                                                 elem.appendChild(node);\r
 294                                                         }\r
 295                                                         v = v.substring(pos+10);\r
 296                                                         pos = v.indexOf('</mcespell>');\r
 297                                                         txt = v.substring(0, pos);\r
 298                                                         v = v.substring(pos+11);\r
 299                                                         // Add span element for the word\r
 300                                                         elem.appendChild(dom.create('span', {'class' : 'mceItemHiddenSpellWord'}, txt));\r
 301                                                 }\r
 302                                                 // Add text node for the rest of the content\r
 303                                                 if (v.length) {\r
 304                                                         node = doc.createTextNode(dom.decode(v));\r
 305                                                         elem.appendChild(node);\r
 306                                                 }\r
 307                                         } else {\r
 308                                                 // Other browsers preserve whitespace characters on innerHTML usage\r
 309                                                 elem.innerHTML = v.replace(rx, '$1<span class="mceItemHiddenSpellWord">$2</span>');\r
 310                                         }\r
 311 \r
 312                                         // Finally, replace the node with the container\r
 313                                         dom.replace(elem, n);\r
 314                                 }\r
 315                         });\r
 316 \r
 317                         se.setRng(r);\r
 318                 },\r
 319 \r
 320                 _showMenu : function(ed, e) {\r
 321                         var t = this, ed = t.editor, m = t._menu, p1, dom = ed.dom, vp = dom.getViewPort(ed.getWin()), wordSpan = e.target;\r
 322 \r
 323                         e = 0; // Fixes IE memory leak\r
 324 \r
 325                         if (!m) {\r
 326                                 m = ed.controlManager.createDropMenu('spellcheckermenu', {'class' : 'mceNoIcons'});\r
 327                                 t._menu = m;\r
 328                         }\r
 329 \r
 330                         if (dom.hasClass(wordSpan, 'mceItemHiddenSpellWord')) {\r
 331                                 m.removeAll();\r
 332                                 m.add({title : 'spellchecker.wait', 'class' : 'mceMenuItemTitle'}).setDisabled(1);\r
 333 \r
 334                                 t._sendRPC('getSuggestions', [t.selectedLang, dom.decode(wordSpan.innerHTML)], function(r) {\r
 335                                         var ignoreRpc;\r
 336 \r
 337                                         m.removeAll();\r
 338 \r
 339                                         if (r.length > 0) {\r
 340                                                 m.add({title : 'spellchecker.sug', 'class' : 'mceMenuItemTitle'}).setDisabled(1);\r
 341                                                 each(r, function(v) {\r
 342                                                         m.add({title : v, onclick : function() {\r
 343                                                                 dom.replace(ed.getDoc().createTextNode(v), wordSpan);\r
 344                                                                 t._checkDone();\r
 345                                                         }});\r
 346                                                 });\r
 347 \r
 348                                                 m.addSeparator();\r
 349                                         } else\r
 350                                                 m.add({title : 'spellchecker.no_sug', 'class' : 'mceMenuItemTitle'}).setDisabled(1);\r
 351 \r
 352                                         if (ed.getParam('show_ignore_words', true)) {\r
 353                                                 ignoreRpc = t.editor.getParam("spellchecker_enable_ignore_rpc", '');\r
 354                                                 m.add({\r
 355                                                         title : 'spellchecker.ignore_word',\r
 356                                                         onclick : function() {\r
 357                                                                 var word = wordSpan.innerHTML;\r
 358 \r
 359                                                                 dom.remove(wordSpan, 1);\r
 360                                                                 t._checkDone();\r
 361 \r
 362                                                                 // tell the server if we need to\r
 363                                                                 if (ignoreRpc) {\r
 364                                                                         ed.setProgressState(1);\r
 365                                                                         t._sendRPC('ignoreWord', [t.selectedLang, word], function(r) {\r
 366                                                                                 ed.setProgressState(0);\r
 367                                                                         });\r
 368                                                                 }\r
 369                                                         }\r
 370                                                 });\r
 371 \r
 372                                                 m.add({\r
 373                                                         title : 'spellchecker.ignore_words',\r
 374                                                         onclick : function() {\r
 375                                                                 var word = wordSpan.innerHTML;\r
 376 \r
 377                                                                 t._removeWords(dom.decode(word));\r
 378                                                                 t._checkDone();\r
 379 \r
 380                                                                 // tell the server if we need to\r
 381                                                                 if (ignoreRpc) {\r
 382                                                                         ed.setProgressState(1);\r
 383                                                                         t._sendRPC('ignoreWords', [t.selectedLang, word], function(r) {\r
 384                                                                                 ed.setProgressState(0);\r
 385                                                                         });\r
 386                                                                 }\r
 387                                                         }\r
 388                                                 });\r
 389                                         }\r
 390 \r
 391                                         if (t.editor.getParam("spellchecker_enable_learn_rpc")) {\r
 392                                                 m.add({\r
 393                                                         title : 'spellchecker.learn_word',\r
 394                                                         onclick : function() {\r
 395                                                                 var word = wordSpan.innerHTML;\r
 396 \r
 397                                                                 dom.remove(wordSpan, 1);\r
 398                                                                 t._checkDone();\r
 399 \r
 400                                                                 ed.setProgressState(1);\r
 401                                                                 t._sendRPC('learnWord', [t.selectedLang, word], function(r) {\r
 402                                                                         ed.setProgressState(0);\r
 403                                                                 });\r
 404                                                         }\r
 405                                                 });\r
 406                                         }\r
 407 \r
 408                                         m.update();\r
 409                                 });\r
 410 \r
 411                                 p1 = DOM.getPos(ed.getContentAreaContainer());\r
 412                                 m.settings.offset_x = p1.x;\r
 413                                 m.settings.offset_y = p1.y;\r
 414 \r
 415                                 ed.selection.select(wordSpan);\r
 416                                 p1 = dom.getPos(wordSpan);\r
 417                                 m.showMenu(p1.x, p1.y + wordSpan.offsetHeight - vp.y);\r
 418 \r
 419                                 return tinymce.dom.Event.cancel(e);\r
 420                         } else\r
 421                                 m.hideMenu();\r
 422                 },\r
 423 \r
 424                 _checkDone : function() {\r
 425                         var t = this, ed = t.editor, dom = ed.dom, o;\r
 426 \r
 427                         each(dom.select('span'), function(n) {\r
 428                                 if (n && dom.hasClass(n, 'mceItemHiddenSpellWord')) {\r
 429                                         o = true;\r
 430                                         return false;\r
 431                                 }\r
 432                         });\r
 433 \r
 434                         if (!o)\r
 435                                 t._done();\r
 436                 },\r
 437 \r
 438                 _done : function() {\r
 439                         var t = this, la = t.active;\r
 440 \r
 441                         if (t.active) {\r
 442                                 t.active = 0;\r
 443                                 t._removeWords();\r
 444 \r
 445                                 if (t._menu)\r
 446                                         t._menu.hideMenu();\r
 447 \r
 448                                 if (la)\r
 449                                         t.editor.nodeChanged();\r
 450                         }\r
 451                 },\r
 452 \r
 453                 _sendRPC : function(m, p, cb) {\r
 454                         var t = this;\r
 455 \r
 456                         JSONRequest.sendRPC({\r
 457                                 url : t.rpcUrl,\r
 458                                 method : m,\r
 459                                 params : p,\r
 460                                 success : cb,\r
 461                                 error : function(e, x) {\r
 462                                         t.editor.setProgressState(0);\r
 463                                         t.editor.windowManager.alert(e.errstr || ('Error response: ' + x.responseText));\r
 464                                 }\r
 465                         });\r
 466                 }\r
 467         });\r
 468 \r
 469         // Register plugin\r
 470         tinymce.PluginManager.add('spellchecker', tinymce.plugins.SpellcheckerPlugin);\r
 471 })();\r