package org.tinymce.spellchecker;
/*
Copyright (c) 2008
Rich Irwin <rirwin@seacliffedu.com>, Andrey Chorniy <andrey.chorniy@gmail.com>
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
*/
import com.dotcms.repackage.org.dts.spell.SpellChecker;
import com.dotcms.repackage.org.dts.spell.dictionary.SpellDictionary;
import java.io.File;
import java.io.IOException;
import java.util.*;
import java.util.zip.ZipFile;
/**
* Implementation based on http://jmyspell.javahispano.net/
* Dictionaries could be downloaded from http://wiki.services.openoffice.org/wiki/Dictionaries
* @author Andrey Chorniy <andrey.chorniy@gmail.com>
* Date: 10.12.2009
*/
public class JMySpellCheckerServlet extends TinyMCESpellCheckerServlet {
private static final long serialVersionUID = 2L;
private Map<String, SpellChecker> spellcheckersCache = new Hashtable<String, SpellChecker>(2);
private static final String JMYSPELL_DICTIONARIES_WEBAPP_PATH = "/WEB-INF/dictionary/jmyspell";
protected void preloadLanguageChecker(String preloadedLanguage) throws SpellCheckException {
getChecker(preloadedLanguage);
}
protected List<String> findMisspelledWords(Iterator<String> checkedWordsIterator, String lang) throws SpellCheckException {
SpellChecker checker = (SpellChecker) getChecker(lang);
List<String> misspelledWordsList = new ArrayList<String>();
while (checkedWordsIterator.hasNext()) {
String word = checkedWordsIterator.next();
if (!word.equals("") && !checker.isCorrect(word) ) {
misspelledWordsList.add(word);
}
}
return misspelledWordsList;
}
protected List<String> findSuggestions(String word, String lang, int maxSuggestions) throws SpellCheckException {
SpellChecker checker = (SpellChecker) getChecker(lang);
return checker.getDictionary().getSuggestions(word, maxSuggestions);
}
/**
* This method look for the already created SpellChecker object in the cache, if it is not present in the cache then
* it try to load it and put newly created object in the cache. SpellChecker loading is quite expensive operation
* to do it for every spell-checking request, so in-memory-caching here is almost a "MUST to have"
*
* @param lang the language code like "en" or "en-us"
* @return instance of jazzy SpellChecker
* @throws SpellCheckException if method failed to load the SpellChecker for lang (it happens if there is no
* dictionaries for that language was found in the classpath
*/
protected Object getChecker(String lang) throws SpellCheckException {
SpellChecker cachedCheker = spellcheckersCache.get(lang);
/**
* Even if the SpellChecker is present we need to validate if the dictionary is available for use,
* and if not we should force a reloading of the SpellChecker for this language.
*
* On some scenarios the dictionary (WEB-INF/dictionary/jmyspell/en_US.zip, WEB-INF/dictionary/jmyspell/es_ES.zip, etc)
* is not longer available even with the SpellChecker object alive causing a java.lang.IllegalStateException, that's why
* a check on the dictionary and a reload is required.
*/
Boolean forceReloading = false;
if ( cachedCheker != null ) {
if ( cachedCheker.getDictionary() == null || !cachedCheker.getDictionary().isLoad() ) {
forceReloading = true;
}
}
if ( cachedCheker == null || forceReloading ) {
cachedCheker = loadSpellChecker( lang );
spellcheckersCache.put( lang, cachedCheker );
}
return cachedCheker;
}
/**
* Load the SpellChecker object from the file-system.
*
* @param lang
* @return loaded SpellChecker object
* @throws SpellCheckException
*/
private SpellChecker loadSpellChecker(final String lang) throws SpellCheckException {
String pathToDictionaries = getServletContext().getRealPath(JMYSPELL_DICTIONARIES_WEBAPP_PATH);
File dictionariesDir = new File(pathToDictionaries);
File dictionaryFile = new File(dictionariesDir, lang + ".zip");
SpellDictionary dict = null;
try {
dict = new com.dotcms.repackage.org.dts.spell.dictionary.openoffice.OpenOfficeSpellDictionary(new ZipFile(dictionaryFile));
} catch (IOException e) {
throw new SpellCheckException("Failed to load dictionary for language" + lang, e);
}
SpellChecker checker = new SpellChecker(dict);
configureSpellChecker(checker);
return checker;
}
private void configureSpellChecker(SpellChecker checker) {
checker.setSkipNumbers(true);
checker.setIgnoreUpperCaseWords(true);
//set checker.setCaseSensitive(false) to avoid checking the case of word (JMySpell require first word in the sentence to be upper-cased)
checker.setCaseSensitive(false);
}
protected void clearSpellcheckerCache() {
spellcheckersCache.clear();
spellcheckersCache = new Hashtable<String, SpellChecker>();
}
@Override
protected void preLoadLanguageChecker(String preloadedLanguage)
throws SpellCheckException {
getChecker(preloadedLanguage);
}
@Override
protected void releaseResources() {
// TODO Auto-generated method stub
}
}