path: root/indra/llui/llspellcheck.cpp

/**
 * @file llspellcheck.cpp
 * @brief Spell checking functionality
 *
 * $LicenseInfo:firstyear=2001&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, Linden Research, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

#include "linden_common.h"

#include "lldir.h"
#include "llsdserialize.h"

#include "llspellcheck.h"
#if LL_WINDOWS
    #include <hunspell/hunspelldll.h>
    #pragma comment(lib, "libhunspell.lib")
#else
    #include <hunspell/hunspell.hxx>
#endif

static const std::string DICT_DIR = "dictionaries";
static const std::string DICT_FILE_CUSTOM = "user_custom.dic";
static const std::string DICT_FILE_IGNORE = "user_ignore.dic";

static const std::string DICT_FILE_MAIN = "dictionaries.xml";
static const std::string DICT_FILE_USER = "user_dictionaries.xml";

LLSpellChecker::settings_change_signal_t LLSpellChecker::sSettingsChangeSignal;

LLSpellChecker::LLSpellChecker()
    : mHunspell(NULL)
{
}

LLSpellChecker::~LLSpellChecker()
{
    delete mHunspell;
}

void LLSpellChecker::initSingleton()
{
    // Load initial dictionary information
    refreshDictionaryMap();
}

bool LLSpellChecker::checkSpelling(const std::string& word) const
{
    if ( (!mHunspell) || (word.length() < 3) || (0 != mHunspell->spell(word.c_str())) )
    {
        return true;
    }
    if (mIgnoreList.size() > 0)
    {
        std::string word_lower(word);
        LLStringUtil::toLower(word_lower);
        return (mIgnoreList.end() != std::find(mIgnoreList.begin(), mIgnoreList.end(), word_lower));
    }
    return false;
}

S32 LLSpellChecker::getSuggestions(const std::string& word, std::vector<std::string>& suggestions) const
{
    suggestions.clear();
    if ( (!mHunspell) || (word.length() < 3) )
    {
        return 0;
    }

    char** suggestion_list; int suggestion_cnt = 0;
    if ( (suggestion_cnt = mHunspell->suggest(&suggestion_list, word.c_str())) != 0 )
    {
        for (int suggestion_index = 0; suggestion_index < suggestion_cnt; suggestion_index++)
        {
            suggestions.push_back(suggestion_list[suggestion_index]);
        }
        mHunspell->free_list(&suggestion_list, suggestion_cnt);
    }
    return static_cast<S32>(suggestions.size());
}

const LLSD LLSpellChecker::getDictionaryData(const std::string& dict_language)
{
    for (LLSD::array_const_iterator it = mDictMap.beginArray(); it != mDictMap.endArray(); ++it)
    {
        const LLSD& dict_entry = *it;
        if (dict_language == dict_entry["language"].asString())
        {
            return dict_entry;
        }
    }
    return LLSD();
}

bool LLSpellChecker::hasDictionary(const std::string& dict_language, bool check_installed)
{
    const LLSD dict_info = getDictionaryData(dict_language);
    return dict_info.has("language") && ( (!check_installed) || (dict_info["installed"].asBoolean()) );
}

void LLSpellChecker::setDictionaryData(const LLSD& dict_info)
{
    const std::string dict_language = dict_info["language"].asString();
    if (dict_language.empty())
    {
        return;
    }

    for (LLSD::array_iterator it = mDictMap.beginArray(); it != mDictMap.endArray(); ++it)
    {
        LLSD& dict_entry = *it;
        if (dict_language == dict_entry["language"].asString())
        {
            dict_entry = dict_info;
            return;
        }
    }
    mDictMap.append(dict_info);
    return;
}

// static
void LLSpellChecker::refreshDictionaryMap()
{
    const std::string app_path = getDictionaryAppPath();
    const std::string user_path = getDictionaryUserPath();

    // Load dictionary information (file name, friendly name, ...)
    std::string user_filename(user_path + DICT_FILE_MAIN);
    llifstream user_file(user_filename.c_str(), std::ios::binary);
    if ( (!user_file.is_open())
        || (LLSDParser::PARSE_FAILURE == LLSDSerialize::fromXMLDocument(mDictMap, user_file))
        || (0 == mDictMap.size()) )
    {
        std::string app_filename(app_path + DICT_FILE_MAIN);
        llifstream app_file(app_filename.c_str(), std::ios::binary);
        if ( (!app_file.is_open())
            || (LLSDParser::PARSE_FAILURE == LLSDSerialize::fromXMLDocument(mDictMap, app_file))
            || (0 == mDictMap.size()) )
        {
            return;
        }
    }

    // Load user installed dictionary information
    user_filename = user_path + DICT_FILE_USER;
    llifstream custom_file(user_filename.c_str(), std::ios::binary);
    if (custom_file.is_open())
    {
        LLSD custom_dict_map;
        LLSDSerialize::fromXMLDocument(custom_dict_map, custom_file);
        for (LLSD::array_iterator it = custom_dict_map.beginArray(); it != custom_dict_map.endArray(); ++it)
        {
            LLSD& dict_info = *it;
            dict_info["user_installed"] = true;
            setDictionaryData(dict_info);
        }
        custom_file.close();
    }

    // Look for installed dictionaries
    std::string tmp_app_path, tmp_user_path;
    for (LLSD::array_iterator it = mDictMap.beginArray(); it != mDictMap.endArray(); ++it)
    {
        LLSD& sdDict = *it;
        tmp_app_path = (sdDict.has("name")) ? app_path + sdDict["name"].asString() : LLStringUtil::null;
        tmp_user_path = (sdDict.has("name")) ? user_path + sdDict["name"].asString() : LLStringUtil::null;
        sdDict["installed"] =
            (!tmp_app_path.empty()) && ((gDirUtilp->fileExists(tmp_user_path + ".dic")) || (gDirUtilp->fileExists(tmp_app_path + ".dic")));
    }

    sSettingsChangeSignal();
}

void LLSpellChecker::addToCustomDictionary(const std::string& word)
{
    if (mHunspell)
    {
        mHunspell->add(word.c_str());
    }
    addToDictFile(getDictionaryUserPath() + DICT_FILE_CUSTOM, word);
    sSettingsChangeSignal();
}

void LLSpellChecker::addToIgnoreList(const std::string& word)
{
    std::string word_lower(word);
    LLStringUtil::toLower(word_lower);
    if (mIgnoreList.end() == std::find(mIgnoreList.begin(), mIgnoreList.end(), word_lower))
    {
        mIgnoreList.push_back(word_lower);
        addToDictFile(getDictionaryUserPath() + DICT_FILE_IGNORE, word_lower);
        sSettingsChangeSignal();
    }
}

void LLSpellChecker::addToDictFile(const std::string& dict_path, const std::string& word)
{
    std::vector<std::string> word_list;

    if (gDirUtilp->fileExists(dict_path))
    {
        llifstream file_in(dict_path.c_str(), std::ios::in);
        if (file_in.is_open())
        {
            std::string word; int line_num = 0;
            while (getline(file_in, word))
            {
                // Skip over the first line since that's just a line count
                if (0 != line_num)
                {
                    word_list.push_back(word);
                }
                line_num++;
            }
        }
        else
        {
            // TODO: show error message?
            return;
        }
    }

    word_list.push_back(word);

    llofstream file_out(dict_path.c_str(), std::ios::out | std::ios::trunc);
    if (file_out.is_open())
    {
        file_out << word_list.size() << std::endl;
        for (std::vector<std::string>::const_iterator itWord = word_list.begin(); itWord != word_list.end(); ++itWord)
        {
            file_out << *itWord << std::endl;
        }
        file_out.close();
    }
}

bool LLSpellChecker::isActiveDictionary(const std::string& dict_language) const
{
    return
        (mDictLanguage == dict_language) ||
        (mDictSecondary.end() != std::find(mDictSecondary.begin(), mDictSecondary.end(), dict_language));
}

void LLSpellChecker::setSecondaryDictionaries(dict_list_t dict_list)
{
    if (!getUseSpellCheck())
    {
        return;
    }

    // Check if we're only adding secondary dictionaries, or removing them
    dict_list_t dict_add(llmax(dict_list.size(), mDictSecondary.size())), dict_rem(llmax(dict_list.size(), mDictSecondary.size()));
    dict_list.sort();
    mDictSecondary.sort();
    dict_list_t::iterator end_added = std::set_difference(dict_list.begin(), dict_list.end(), mDictSecondary.begin(), mDictSecondary.end(), dict_add.begin());
    dict_list_t::iterator end_removed = std::set_difference(mDictSecondary.begin(), mDictSecondary.end(), dict_list.begin(), dict_list.end(), dict_rem.begin());

    if (end_removed != dict_rem.begin())        // We can't remove secondary dictionaries so we need to recreate the Hunspell instance
    {
        mDictSecondary = dict_list;

        std::string dict_language = mDictLanguage;
        initHunspell(dict_language);
    }
    else if (end_added != dict_add.begin())     // Add the new secondary dictionaries one by one
    {
        const std::string app_path = getDictionaryAppPath();
        const std::string user_path = getDictionaryUserPath();
        for (dict_list_t::const_iterator it_added = dict_add.begin(); it_added != end_added; ++it_added)
        {
            const LLSD dict_entry = getDictionaryData(*it_added);
            if ( (!dict_entry.isDefined()) || (!dict_entry["installed"].asBoolean()) )
            {
                continue;
            }

            const std::string strFileDic = dict_entry["name"].asString() + ".dic";
            if (gDirUtilp->fileExists(user_path + strFileDic))
            {
                mHunspell->add_dic((user_path + strFileDic).c_str());
            }
            else if (gDirUtilp->fileExists(app_path + strFileDic))
            {
                mHunspell->add_dic((app_path + strFileDic).c_str());
            }
        }
        mDictSecondary = dict_list;
        sSettingsChangeSignal();
    }
}

void LLSpellChecker::initHunspell(const std::string& dict_language)
{
    if (mHunspell)
    {
        delete mHunspell;
        mHunspell = NULL;
        mDictLanguage.clear();
        mDictFile.clear();
        mIgnoreList.clear();
    }

    const LLSD dict_entry = (!dict_language.empty()) ? getDictionaryData(dict_language) : LLSD();
    if ( (!dict_entry.isDefined()) || (!dict_entry["installed"].asBoolean()) || (!dict_entry["is_primary"].asBoolean()))
    {
        sSettingsChangeSignal();
        return;
    }

    const std::string app_path = getDictionaryAppPath();
    const std::string user_path = getDictionaryUserPath();
    if (dict_entry.has("name"))
    {
        const std::string filename_aff = dict_entry["name"].asString() + ".aff";
        const std::string filename_dic = dict_entry["name"].asString() + ".dic";
        if ( (gDirUtilp->fileExists(user_path + filename_aff)) && (gDirUtilp->fileExists(user_path + filename_dic)) )
        {
            mHunspell = new Hunspell((user_path + filename_aff).c_str(), (user_path + filename_dic).c_str());
        }
        else if ( (gDirUtilp->fileExists(app_path + filename_aff)) && (gDirUtilp->fileExists(app_path + filename_dic)) )
        {
            mHunspell = new Hunspell((app_path + filename_aff).c_str(), (app_path + filename_dic).c_str());
        }
        if (!mHunspell)
        {
            return;
        }

        mDictLanguage = dict_language;
        mDictFile = dict_entry["name"].asString();

        if (gDirUtilp->fileExists(user_path + DICT_FILE_CUSTOM))
        {
            mHunspell->add_dic((user_path + DICT_FILE_CUSTOM).c_str());
        }

        if (gDirUtilp->fileExists(user_path + DICT_FILE_IGNORE))
        {
            llifstream file_in((user_path + DICT_FILE_IGNORE).c_str(), std::ios::in);
            if (file_in.is_open())
            {
                std::string word; int idxLine = 0;
                while (getline(file_in, word))
                {
                    // Skip over the first line since that's just a line count
                    if (0 != idxLine)
                    {
                        LLStringUtil::toLower(word);
                        mIgnoreList.push_back(word);
                    }
                    idxLine++;
                }
            }
        }

        for (dict_list_t::const_iterator it = mDictSecondary.begin(); it != mDictSecondary.end(); ++it)
        {
            const LLSD dict_entry = getDictionaryData(*it);
            if ( (!dict_entry.isDefined()) || (!dict_entry["installed"].asBoolean()) )
            {
                continue;
            }

            const std::string filename_dic = dict_entry["name"].asString() + ".dic";
            if (gDirUtilp->fileExists(user_path + filename_dic))
            {
                mHunspell->add_dic((user_path + filename_dic).c_str());
            }
            else if (gDirUtilp->fileExists(app_path + filename_dic))
            {
                mHunspell->add_dic((app_path + filename_dic).c_str());
            }
        }
    }

    sSettingsChangeSignal();
}

// static
const std::string LLSpellChecker::getDictionaryAppPath()
{
    std::string dict_path = gDirUtilp->getExpandedFilename(LL_PATH_APP_SETTINGS, DICT_DIR, "");
    return dict_path;
}

// static
const std::string LLSpellChecker::getDictionaryUserPath()
{
    std::string dict_path = gDirUtilp->getExpandedFilename(LL_PATH_USER_SETTINGS, DICT_DIR, "");
    LLFile::mkdir(dict_path);
    return dict_path;
}

// static
bool LLSpellChecker::getUseSpellCheck()
{
    return (LLSpellChecker::instanceExists()) && (LLSpellChecker::instance().mHunspell);
}

bool LLSpellChecker::canRemoveDictionary(const std::string& dict_language)
{
    // Only user-installed inactive dictionaries can be removed
    const LLSD dict_info = getDictionaryData(dict_language);
    return
        (dict_info["user_installed"].asBoolean()) &&
        ( (!getUseSpellCheck()) || (!LLSpellChecker::instance().isActiveDictionary(dict_language)) );
}

void LLSpellChecker::removeDictionary(const std::string& dict_language)
{
    if (!canRemoveDictionary(dict_language))
    {
        return;
    }

    LLSD dict_map = loadUserDictionaryMap();
    for (LLSD::array_const_iterator it = dict_map.beginArray(); it != dict_map.endArray(); ++it)
    {
        const LLSD& dict_info = *it;
        if (dict_info["language"].asString() == dict_language)
        {
            const std::string dict_dic = getDictionaryUserPath() + dict_info["name"].asString() + ".dic";
            if (gDirUtilp->fileExists(dict_dic))
            {
                LLFile::remove(dict_dic);
            }
            const std::string dict_aff = getDictionaryUserPath() + dict_info["name"].asString() + ".aff";
            if (gDirUtilp->fileExists(dict_aff))
            {
                LLFile::remove(dict_aff);
            }
            dict_map.erase((LLSD::Integer)(it - dict_map.beginArray()));
            break;
        }
    }
    saveUserDictionaryMap(dict_map);

    refreshDictionaryMap();
}

// static
LLSD LLSpellChecker::loadUserDictionaryMap()
{
    LLSD dict_map;
    std::string dict_filename(getDictionaryUserPath() + DICT_FILE_USER);
    llifstream dict_file(dict_filename.c_str(), std::ios::binary);
    if (dict_file.is_open())
    {
        LLSDSerialize::fromXMLDocument(dict_map, dict_file);
        dict_file.close();
    }
    return dict_map;
}

// static
void LLSpellChecker::saveUserDictionaryMap(const LLSD& dict_map)
{
    llofstream dict_file((getDictionaryUserPath() + DICT_FILE_USER).c_str(), std::ios::trunc);
    if (dict_file.is_open())
    {
        LLSDSerialize::toPrettyXML(dict_map, dict_file);
        dict_file.close();
    }
}

// static
boost::signals2::connection LLSpellChecker::setSettingsChangeCallback(const settings_change_signal_t::slot_type& cb)
{
    return sSettingsChangeSignal.connect(cb);
}

// static
void LLSpellChecker::setUseSpellCheck(const std::string& dict_language)
{
    if ( (((dict_language.empty()) && (getUseSpellCheck())) || (!dict_language.empty())) &&
         (LLSpellChecker::instance().mDictLanguage != dict_language) )
    {
        LLSpellChecker::instance().initHunspell(dict_language);
    }
}