docs/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 \r
  31                         // Register commands\r
  32                         ed.addCommand('mceSpellCheck', function() {\r
  33                                 if (!t.active) {\r
  34                                         ed.setProgressState(1);\r
  35                                         t._sendRPC('checkWords', [t.selectedLang, t._getWords()], function(r) {\r
  36                                                 if (r.length > 0) {\r
  37                                                         t.active = 1;\r
  38                                                         t._markWords(r);\r
  39                                                         ed.setProgressState(0);\r
  40                                                         ed.nodeChanged();\r
  41                                                 } else {\r
  42                                                         ed.setProgressState(0);\r
  43                                                         ed.windowManager.alert('spellchecker.no_mpell');\r
  44                                                 }\r
  45                                         });\r
  46                                 } else\r
  47                                         t._done();\r
  48                         });\r
  49 \r
  50                         ed.onInit.add(function() {\r
  51                                 if (ed.settings.content_css !== false)\r
  52                                         ed.dom.loadCSS(url + '/css/content.css');\r
  53                         });\r
  54 \r
  55                         ed.onClick.add(t._showMenu, t);\r
  56                         ed.onContextMenu.add(t._showMenu, t);\r
  57                         ed.onBeforeGetContent.add(function() {\r
  58                                 if (t.active)\r
  59                                         t._removeWords();\r
  60                         });\r
  61 \r
  62                         ed.onNodeChange.add(function(ed, cm) {\r
  63                                 cm.setActive('spellchecker', t.active);\r
  64                         });\r
  65 \r
  66                         ed.onSetContent.add(function() {\r
  67                                 t._done();\r
  68                         });\r
  69 \r
  70                         ed.onBeforeGetContent.add(function() {\r
  71                                 t._done();\r
  72                         });\r
  73 \r
  74                         ed.onBeforeExecCommand.add(function(ed, cmd) {\r
  75                                 if (cmd == 'mceFullScreen')\r
  76                                         t._done();\r
  77                         });\r
  78 \r
  79                         // Find selected language\r
  80                         t.languages = {};\r
  81                         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
  82                                 if (k.indexOf('+') === 0) {\r
  83                                         k = k.substring(1);\r
  84                                         t.selectedLang = v;\r
  85                                 }\r
  86 \r
  87                                 t.languages[k] = v;\r
  88                         });\r
  89                 },\r
  90 \r
  91                 createControl : function(n, cm) {\r
  92                         var t = this, c, ed = t.editor;\r
  93 \r
  94                         if (n == 'spellchecker') {\r
  95                                 c = cm.createSplitButton(n, {title : 'spellchecker.desc', cmd : 'mceSpellCheck', scope : t});\r
  96 \r
  97                                 c.onRenderMenu.add(function(c, m) {\r
  98                                         m.add({title : 'spellchecker.langs', 'class' : 'mceMenuItemTitle'}).setDisabled(1);\r
  99                                         each(t.languages, function(v, k) {\r
 100                                                 var o = {icon : 1}, mi;\r
 101 \r
 102                                                 o.onclick = function() {\r
 103                                                         mi.setSelected(1);\r
 104                                                         t.selectedItem.setSelected(0);\r
 105                                                         t.selectedItem = mi;\r
 106                                                         t.selectedLang = v;\r
 107                                                 };\r
 108 \r
 109                                                 o.title = k;\r
 110                                                 mi = m.add(o);\r
 111                                                 mi.setSelected(v == t.selectedLang);\r
 112 \r
 113                                                 if (v == t.selectedLang)\r
 114                                                         t.selectedItem = mi;\r
 115                                         })\r
 116                                 });\r
 117 \r
 118                                 return c;\r
 119                         }\r
 120                 },\r
 121 \r
 122                 // Internal functions\r
 123 \r
 124                 _walk : function(n, f) {\r
 125                         var d = this.editor.getDoc(), w;\r
 126 \r
 127                         if (d.createTreeWalker) {\r
 128                                 w = d.createTreeWalker(n, NodeFilter.SHOW_TEXT, null, false);\r
 129 \r
 130                                 while ((n = w.nextNode()) != null)\r
 131                                         f.call(this, n);\r
 132                         } else\r
 133                                 tinymce.walk(n, f, 'childNodes');\r
 134                 },\r
 135 \r
 136                 _getSeparators : function() {\r
 137                         var re = '', i, str = this.editor.getParam('spellchecker_word_separator_chars', '\\s!"#$%&()*+,-./:;<=>?@[\]^_{|}§©«®±¶·¸»¼½¾¿×÷¤\u201d\u201c');\r
 138 \r
 139                         // Build word separator regexp\r
 140                         for (i=0; i<str.length; i++)\r
 141                                 re += '\\' + str.charAt(i);\r
 142 \r
 143                         return re;\r
 144                 },\r
 145 \r
 146                 _getWords : function() {\r
 147                         var ed = this.editor, wl = [], tx = '', lo = {};\r
 148 \r
 149                         // Get area text\r
 150                         this._walk(ed.getBody(), function(n) {\r
 151                                 if (n.nodeType == 3)\r
 152                                         tx += n.nodeValue + ' ';\r
 153                         });\r
 154 \r
 155                         // Split words by separator\r
 156                         tx = tx.replace(new RegExp('([0-9]|[' + this._getSeparators() + '])', 'g'), ' ');\r
 157                         tx = tinymce.trim(tx.replace(/(\s+)/g, ' '));\r
 158 \r
 159                         // Build word array and remove duplicates\r
 160                         each(tx.split(' '), function(v) {\r
 161                                 if (!lo[v]) {\r
 162                                         wl.push(v);\r
 163                                         lo[v] = 1;\r
 164                                 }\r
 165                         });\r
 166 \r
 167                         return wl;\r
 168                 },\r
 169 \r
 170                 _removeWords : function(w) {\r
 171                         var ed = this.editor, dom = ed.dom, se = ed.selection, b = se.getBookmark();\r
 172 \r
 173                         each(dom.select('span').reverse(), function(n) {\r
 174                                 if (n && (dom.hasClass(n, 'mceItemHiddenSpellWord') || dom.hasClass(n, 'mceItemHidden'))) {\r
 175                                         if (!w || dom.decode(n.innerHTML) == w)\r
 176                                                 dom.remove(n, 1);\r
 177                                 }\r
 178                         });\r
 179 \r
 180                         se.moveToBookmark(b);\r
 181                 },\r
 182 \r
 183                 _markWords : function(wl) {\r
 184                         var r1, r2, r3, r4, r5, w = '', ed = this.editor, re = this._getSeparators(), dom = ed.dom, nl = [];\r
 185                         var se = ed.selection, b = se.getBookmark();\r
 186 \r
 187                         each(wl, function(v) {\r
 188                                 w += (w ? '|' : '') + v;\r
 189                         });\r
 190 \r
 191                         r1 = new RegExp('([' + re + '])(' + w + ')([' + re + '])', 'g');\r
 192                         r2 = new RegExp('^(' + w + ')', 'g');\r
 193                         r3 = new RegExp('(' + w + ')([' + re + ']?)$', 'g');\r
 194                         r4 = new RegExp('^(' + w + ')([' + re + ']?)$', 'g');\r
 195                         r5 = new RegExp('(' + w + ')([' + re + '])', 'g');\r
 196 \r
 197                         // Collect all text nodes\r
 198                         this._walk(this.editor.getBody(), function(n) {\r
 199                                 if (n.nodeType == 3) {\r
 200                                         nl.push(n);\r
 201                                 }\r
 202                         });\r
 203 \r
 204                         // Wrap incorrect words in spans\r
 205                         each(nl, function(n) {\r
 206                                 var v;\r
 207 \r
 208                                 if (n.nodeType == 3) {\r
 209                                         v = n.nodeValue;\r
 210 \r
 211                                         if (r1.test(v) || r2.test(v) || r3.test(v) || r4.test(v)) {\r
 212                                                 v = dom.encode(v);\r
 213                                                 v = v.replace(r5, '<span class="mceItemHiddenSpellWord">$1</span>$2');\r
 214                                                 v = v.replace(r3, '<span class="mceItemHiddenSpellWord">$1</span>$2');\r
 215 \r
 216                                                 dom.replace(dom.create('span', {'class' : 'mceItemHidden'}, v), n);\r
 217                                         }\r
 218                                 }\r
 219                         });\r
 220 \r
 221                         se.moveToBookmark(b);\r
 222                 },\r
 223 \r
 224                 _showMenu : function(ed, e) {\r
 225                         var t = this, ed = t.editor, m = t._menu, p1, dom = ed.dom, vp = dom.getViewPort(ed.getWin());\r
 226 \r
 227                         if (!m) {\r
 228                                 p1 = DOM.getPos(ed.getContentAreaContainer());\r
 229                                 //p2 = DOM.getPos(ed.getContainer());\r
 230 \r
 231                                 m = ed.controlManager.createDropMenu('spellcheckermenu', {\r
 232                                         offset_x : p1.x,\r
 233                                         offset_y : p1.y,\r
 234                                         'class' : 'mceNoIcons'\r
 235                                 });\r
 236 \r
 237                                 t._menu = m;\r
 238                         }\r
 239 \r
 240                         if (dom.hasClass(e.target, 'mceItemHiddenSpellWord')) {\r
 241                                 m.removeAll();\r
 242                                 m.add({title : 'spellchecker.wait', 'class' : 'mceMenuItemTitle'}).setDisabled(1);\r
 243 \r
 244                                 t._sendRPC('getSuggestions', [t.selectedLang, dom.decode(e.target.innerHTML)], function(r) {\r
 245                                         m.removeAll();\r
 246 \r
 247                                         if (r.length > 0) {\r
 248                                                 m.add({title : 'spellchecker.sug', 'class' : 'mceMenuItemTitle'}).setDisabled(1);\r
 249                                                 each(r, function(v) {\r
 250                                                         m.add({title : v, onclick : function() {\r
 251                                                                 dom.replace(ed.getDoc().createTextNode(v), e.target);\r
 252                                                                 t._checkDone();\r
 253                                                         }});\r
 254                                                 });\r
 255 \r
 256                                                 m.addSeparator();\r
 257                                         } else\r
 258                                                 m.add({title : 'spellchecker.no_sug', 'class' : 'mceMenuItemTitle'}).setDisabled(1);\r
 259 \r
 260                                         m.add({\r
 261                                                 title : 'spellchecker.ignore_word',\r
 262                                                 onclick : function() {\r
 263                                                         dom.remove(e.target, 1);\r
 264                                                         t._checkDone();\r
 265                                                 }\r
 266                                         });\r
 267 \r
 268                                         m.add({\r
 269                                                 title : 'spellchecker.ignore_words',\r
 270                                                 onclick : function() {\r
 271                                                         t._removeWords(dom.decode(e.target.innerHTML));\r
 272                                                         t._checkDone();\r
 273                                                 }\r
 274                                         });\r
 275 \r
 276                                         m.update();\r
 277                                 });\r
 278 \r
 279                                 ed.selection.select(e.target);\r
 280                                 p1 = dom.getPos(e.target);\r
 281                                 m.showMenu(p1.x, p1.y + e.target.offsetHeight - vp.y);\r
 282 \r
 283                                 return tinymce.dom.Event.cancel(e);\r
 284                         } else\r
 285                                 m.hideMenu();\r
 286                 },\r
 287 \r
 288                 _checkDone : function() {\r
 289                         var t = this, ed = t.editor, dom = ed.dom, o;\r
 290 \r
 291                         each(dom.select('span'), function(n) {\r
 292                                 if (n && dom.hasClass(n, 'mceItemHiddenSpellWord')) {\r
 293                                         o = true;\r
 294                                         return false;\r
 295                                 }\r
 296                         });\r
 297 \r
 298                         if (!o)\r
 299                                 t._done();\r
 300                 },\r
 301 \r
 302                 _done : function() {\r
 303                         var t = this, la = t.active;\r
 304 \r
 305                         if (t.active) {\r
 306                                 t.active = 0;\r
 307                                 t._removeWords();\r
 308 \r
 309                                 if (t._menu)\r
 310                                         t._menu.hideMenu();\r
 311 \r
 312                                 if (la)\r
 313                                         t.editor.nodeChanged();\r
 314                         }\r
 315                 },\r
 316 \r
 317                 _sendRPC : function(m, p, cb) {\r
 318                         var t = this, url = t.editor.getParam("spellchecker_rpc_url", "{backend}");\r
 319 \r
 320                         if (url == '{backend}') {\r
 321                                 t.editor.setProgressState(0);\r
 322                                 alert('Please specify: spellchecker_rpc_url');\r
 323                                 return;\r
 324                         }\r
 325 \r
 326                         JSONRequest.sendRPC({\r
 327                                 url : url,\r
 328                                 method : m,\r
 329                                 params : p,\r
 330                                 success : cb,\r
 331                                 error : function(e, x) {\r
 332                                         t.editor.setProgressState(0);\r
 333                                         t.editor.windowManager.alert(e.errstr || ('Error response: ' + x.responseText));\r
 334                                 }\r
 335                         });\r
 336                 }\r
 337         });\r
 338 \r
 339         // Register plugin\r
 340         tinymce.PluginManager.add('spellchecker', tinymce.plugins.SpellcheckerPlugin);\r
 341 })();