webcit/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                                         each(t.languages, function(v, k) {\r
 130                                                 var o = {icon : 1}, mi;\r
 131 \r
 132                                                 o.onclick = function() {\r
 133                                                         if (v == t.selectedLang) {\r
 134                                                                 return;\r
 135                                                         }\r
 136                                                         mi.setSelected(1);\r
 137                                                         t.selectedItem.setSelected(0);\r
 138                                                         t.selectedItem = mi;\r
 139                                                         t.selectedLang = v;\r
 140                                                 };\r
 141 \r
 142                                                 o.title = k;\r
 143                                                 mi = m.add(o);\r
 144                                                 mi.setSelected(v == t.selectedLang);\r
 145 \r
 146                                                 if (v == t.selectedLang)\r
 147                                                         t.selectedItem = mi;\r
 148                                         })\r
 149                                 });\r
 150 \r
 151                                 return c;\r
 152                         }\r
 153                 },\r
 154 \r
 155                 // Internal functions\r
 156 \r
 157                 _walk : function(n, f) {\r
 158                         var d = this.editor.getDoc(), w;\r
 159 \r
 160                         if (d.createTreeWalker) {\r
 161                                 w = d.createTreeWalker(n, NodeFilter.SHOW_TEXT, null, false);\r
 162 \r
 163                                 while ((n = w.nextNode()) != null)\r
 164                                         f.call(this, n);\r
 165                         } else\r
 166                                 tinymce.walk(n, f, 'childNodes');\r
 167                 },\r
 168 \r
 169                 _getSeparators : function() {\r
 170                         var re = '', i, str = this.editor.getParam('spellchecker_word_separator_chars', '\\s!"#$%&()*+,-./:;<=>?@[\]^_{|}§©«®±¶·¸»¼½¾¿×÷¤\u201d\u201c');\r
 171 \r
 172                         // Build word separator regexp\r
 173                         for (i=0; i<str.length; i++)\r
 174                                 re += '\\' + str.charAt(i);\r
 175 \r
 176                         return re;\r
 177                 },\r
 178 \r
 179                 _getWords : function() {\r
 180                         var ed = this.editor, wl = [], tx = '', lo = {}, rawWords = [];\r
 181 \r
 182                         // Get area text\r
 183                         this._walk(ed.getBody(), function(n) {\r
 184                                 if (n.nodeType == 3)\r
 185                                         tx += n.nodeValue + ' ';\r
 186                         });\r
 187 \r
 188                         // split the text up into individual words\r
 189                         if (ed.getParam('spellchecker_word_pattern')) {\r
 190                                 // look for words that match the pattern\r
 191                                 rawWords = tx.match('(' + ed.getParam('spellchecker_word_pattern') + ')', 'gi');\r
 192                         } else {\r
 193                                 // Split words by separator\r
 194                                 tx = tx.replace(new RegExp('([0-9]|[' + this._getSeparators() + '])', 'g'), ' ');\r
 195                                 tx = tinymce.trim(tx.replace(/(\s+)/g, ' '));\r
 196                                 rawWords = tx.split(' ');\r
 197                         }\r
 198 \r
 199                         // Build word array and remove duplicates\r
 200                         each(rawWords, function(v) {\r
 201                                 if (!lo[v]) {\r
 202                                         wl.push(v);\r
 203                                         lo[v] = 1;\r
 204                                 }\r
 205                         });\r
 206 \r
 207                         return wl;\r
 208                 },\r
 209 \r
 210                 _removeWords : function(w) {\r
 211                         var ed = this.editor, dom = ed.dom, se = ed.selection, b = se.getBookmark();\r
 212 \r
 213                         each(dom.select('span').reverse(), function(n) {\r
 214                                 if (n && (dom.hasClass(n, 'mceItemHiddenSpellWord') || dom.hasClass(n, 'mceItemHidden'))) {\r
 215                                         if (!w || dom.decode(n.innerHTML) == w)\r
 216                                                 dom.remove(n, 1);\r
 217                                 }\r
 218                         });\r
 219 \r
 220                         se.moveToBookmark(b);\r
 221                 },\r
 222 \r
 223                 _markWords : function(wl) {\r
 224                         var ed = this.editor, dom = ed.dom, doc = ed.getDoc(), se = ed.selection, b = se.getBookmark(), nl = [],\r
 225                                 w = wl.join('|'), re = this._getSeparators(), rx = new RegExp('(^|[' + re + '])(' + w + ')(?=[' + re + ']|$)', 'g');\r
 226 \r
 227                         // Collect all text nodes\r
 228                         this._walk(ed.getBody(), function(n) {\r
 229                                 if (n.nodeType == 3) {\r
 230                                         nl.push(n);\r
 231                                 }\r
 232                         });\r
 233 \r
 234                         // Wrap incorrect words in spans\r
 235                         each(nl, function(n) {\r
 236                                 var node, elem, txt, pos, v = n.nodeValue;\r
 237 \r
 238                                 if (rx.test(v)) {\r
 239                                         // Encode the content\r
 240                                         v = dom.encode(v);\r
 241                                         // Create container element\r
 242                                         elem = dom.create('span', {'class' : 'mceItemHidden'});\r
 243 \r
 244                                         // Following code fixes IE issues by creating text nodes\r
 245                                         // using DOM methods instead of innerHTML.\r
 246                                         // Bug #3124: <PRE> elements content is broken after spellchecking.\r
 247                                         // Bug #1408: Preceding whitespace characters are removed\r
 248                                         // @TODO: I'm not sure that both are still issues on IE9.\r
 249                                         if (tinymce.isIE) {\r
 250                                                 // Enclose mispelled words with temporal tag\r
 251                                                 v = v.replace(rx, '$1<mcespell>$2</mcespell>');\r
 252                                                 // Loop over the content finding mispelled words\r
 253                                                 while ((pos = v.indexOf('<mcespell>')) != -1) {\r
 254                                                         // Add text node for the content before the word\r
 255                                                         txt = v.substring(0, pos);\r
 256                                                         if (txt.length) {\r
 257                                                                 node = doc.createTextNode(dom.decode(txt));\r
 258                                                                 elem.appendChild(node);\r
 259                                                         }\r
 260                                                         v = v.substring(pos+10);\r
 261                                                         pos = v.indexOf('</mcespell>');\r
 262                                                         txt = v.substring(0, pos);\r
 263                                                         v = v.substring(pos+11);\r
 264                                                         // Add span element for the word\r
 265                                                         elem.appendChild(dom.create('span', {'class' : 'mceItemHiddenSpellWord'}, txt));\r
 266                                                 }\r
 267                                                 // Add text node for the rest of the content\r
 268                                                 if (v.length) {\r
 269                                                         node = doc.createTextNode(dom.decode(v));\r
 270                                                         elem.appendChild(node);\r
 271                                                 }\r
 272                                         } else {\r
 273                                                 // Other browsers preserve whitespace characters on innerHTML usage\r
 274                                                 elem.innerHTML = v.replace(rx, '$1<span class="mceItemHiddenSpellWord">$2</span>');\r
 275                                         }\r
 276 \r
 277                                         // Finally, replace the node with the container\r
 278                                         dom.replace(elem, n);\r
 279                                 }\r
 280                         });\r
 281 \r
 282                         se.moveToBookmark(b);\r
 283                 },\r
 284 \r
 285                 _showMenu : function(ed, e) {\r
 286                         var t = this, ed = t.editor, m = t._menu, p1, dom = ed.dom, vp = dom.getViewPort(ed.getWin()), wordSpan = e.target;\r
 287 \r
 288                         e = 0; // Fixes IE memory leak\r
 289 \r
 290                         if (!m) {\r
 291                                 m = ed.controlManager.createDropMenu('spellcheckermenu', {'class' : 'mceNoIcons'});\r
 292                                 t._menu = m;\r
 293                         }\r
 294 \r
 295                         if (dom.hasClass(wordSpan, 'mceItemHiddenSpellWord')) {\r
 296                                 m.removeAll();\r
 297                                 m.add({title : 'spellchecker.wait', 'class' : 'mceMenuItemTitle'}).setDisabled(1);\r
 298 \r
 299                                 t._sendRPC('getSuggestions', [t.selectedLang, dom.decode(wordSpan.innerHTML)], function(r) {\r
 300                                         var ignoreRpc;\r
 301 \r
 302                                         m.removeAll();\r
 303 \r
 304                                         if (r.length > 0) {\r
 305                                                 m.add({title : 'spellchecker.sug', 'class' : 'mceMenuItemTitle'}).setDisabled(1);\r
 306                                                 each(r, function(v) {\r
 307                                                         m.add({title : v, onclick : function() {\r
 308                                                                 dom.replace(ed.getDoc().createTextNode(v), wordSpan);\r
 309                                                                 t._checkDone();\r
 310                                                         }});\r
 311                                                 });\r
 312 \r
 313                                                 m.addSeparator();\r
 314                                         } else\r
 315                                                 m.add({title : 'spellchecker.no_sug', 'class' : 'mceMenuItemTitle'}).setDisabled(1);\r
 316 \r
 317                                         ignoreRpc = t.editor.getParam("spellchecker_enable_ignore_rpc", '');\r
 318                                         m.add({\r
 319                                                 title : 'spellchecker.ignore_word',\r
 320                                                 onclick : function() {\r
 321                                                         var word = wordSpan.innerHTML;\r
 322 \r
 323                                                         dom.remove(wordSpan, 1);\r
 324                                                         t._checkDone();\r
 325 \r
 326                                                         // tell the server if we need to\r
 327                                                         if (ignoreRpc) {\r
 328                                                                 ed.setProgressState(1);\r
 329                                                                 t._sendRPC('ignoreWord', [t.selectedLang, word], function(r) {\r
 330                                                                         ed.setProgressState(0);\r
 331                                                                 });\r
 332                                                         }\r
 333                                                 }\r
 334                                         });\r
 335 \r
 336                                         m.add({\r
 337                                                 title : 'spellchecker.ignore_words',\r
 338                                                 onclick : function() {\r
 339                                                         var word = wordSpan.innerHTML;\r
 340 \r
 341                                                         t._removeWords(dom.decode(word));\r
 342                                                         t._checkDone();\r
 343 \r
 344                                                         // tell the server if we need to\r
 345                                                         if (ignoreRpc) {\r
 346                                                                 ed.setProgressState(1);\r
 347                                                                 t._sendRPC('ignoreWords', [t.selectedLang, word], function(r) {\r
 348                                                                         ed.setProgressState(0);\r
 349                                                                 });\r
 350                                                         }\r
 351                                                 }\r
 352                                         });\r
 353 \r
 354                                         if (t.editor.getParam("spellchecker_enable_learn_rpc")) {\r
 355                                                 m.add({\r
 356                                                         title : 'spellchecker.learn_word',\r
 357                                                         onclick : function() {\r
 358                                                                 var word = wordSpan.innerHTML;\r
 359 \r
 360                                                                 dom.remove(wordSpan, 1);\r
 361                                                                 t._checkDone();\r
 362 \r
 363                                                                 ed.setProgressState(1);\r
 364                                                                 t._sendRPC('learnWord', [t.selectedLang, word], function(r) {\r
 365                                                                         ed.setProgressState(0);\r
 366                                                                 });\r
 367                                                         }\r
 368                                                 });\r
 369                                         }\r
 370 \r
 371                                         m.update();\r
 372                                 });\r
 373 \r
 374                                 p1 = DOM.getPos(ed.getContentAreaContainer());\r
 375                                 m.settings.offset_x = p1.x;\r
 376                                 m.settings.offset_y = p1.y;\r
 377 \r
 378                                 ed.selection.select(wordSpan);\r
 379                                 p1 = dom.getPos(wordSpan);\r
 380                                 m.showMenu(p1.x, p1.y + wordSpan.offsetHeight - vp.y);\r
 381 \r
 382                                 return tinymce.dom.Event.cancel(e);\r
 383                         } else\r
 384                                 m.hideMenu();\r
 385                 },\r
 386 \r
 387                 _checkDone : function() {\r
 388                         var t = this, ed = t.editor, dom = ed.dom, o;\r
 389 \r
 390                         each(dom.select('span'), function(n) {\r
 391                                 if (n && dom.hasClass(n, 'mceItemHiddenSpellWord')) {\r
 392                                         o = true;\r
 393                                         return false;\r
 394                                 }\r
 395                         });\r
 396 \r
 397                         if (!o)\r
 398                                 t._done();\r
 399                 },\r
 400 \r
 401                 _done : function() {\r
 402                         var t = this, la = t.active;\r
 403 \r
 404                         if (t.active) {\r
 405                                 t.active = 0;\r
 406                                 t._removeWords();\r
 407 \r
 408                                 if (t._menu)\r
 409                                         t._menu.hideMenu();\r
 410 \r
 411                                 if (la)\r
 412                                         t.editor.nodeChanged();\r
 413                         }\r
 414                 },\r
 415 \r
 416                 _sendRPC : function(m, p, cb) {\r
 417                         var t = this;\r
 418 \r
 419                         JSONRequest.sendRPC({\r
 420                                 url : t.rpcUrl,\r
 421                                 method : m,\r
 422                                 params : p,\r
 423                                 success : cb,\r
 424                                 error : function(e, x) {\r
 425                                         t.editor.setProgressState(0);\r
 426                                         t.editor.windowManager.alert(e.errstr || ('Error response: ' + x.responseText));\r
 427                                 }\r
 428                         });\r
 429                 }\r
 430         });\r
 431 \r
 432         // Register plugin\r
 433         tinymce.PluginManager.add('spellchecker', tinymce.plugins.SpellcheckerPlugin);\r
 434 })();\r