mirror of
https://github.com/kiwix/libkiwix.git
synced 2026-02-24 10:18:07 -05:00
5c8aa240ad
The path parameter of the SpellingsDB constructor has been changed to denote the path of the cache directory where spellings databases for different ZIM archive should be stored. The filename of the spellings database is generated from the ZIM archive UUID and the current version of the spellings database implementation.
109 lines
3.0 KiB
C++
109 lines
3.0 KiB
C++
/*
|
|
* Copyright (C) 2025 Veloman Yunkan
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 3 of the License, or
|
|
* any later version.
|
|
*
|
|
* This program 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 General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
|
|
* MA 02110-1301, USA.
|
|
*/
|
|
|
|
#include "spelling_correction.h"
|
|
#include "zim/archive.h"
|
|
|
|
#include <sstream>
|
|
#include <stdexcept>
|
|
|
|
#include <xapian.h>
|
|
|
|
namespace kiwix
|
|
{
|
|
|
|
namespace
|
|
{
|
|
|
|
std::vector<std::string> getAllTitles(const zim::Archive& a)
|
|
{
|
|
std::vector<std::string> result;
|
|
for (const auto& entry : a.iterByPath() ) {
|
|
result.push_back(entry.getTitle());
|
|
}
|
|
return result;
|
|
}
|
|
|
|
void createXapianDB(std::string path, const zim::Archive& archive)
|
|
{
|
|
const int flags = Xapian::DB_BACKEND_GLASS|Xapian::DB_CREATE;
|
|
const auto tmpDbPath = path + ".tmp";
|
|
Xapian::WritableDatabase db(tmpDbPath, flags);
|
|
for (const auto& t : getAllTitles(archive)) {
|
|
db.add_spelling(t);
|
|
}
|
|
db.commit();
|
|
db.compact(path, Xapian::DBCOMPACT_SINGLE_FILE);
|
|
db.close();
|
|
std::filesystem::remove_all(tmpDbPath);
|
|
}
|
|
|
|
std::string spellingsDBPathForZIMArchive(std::filesystem::path cacheDirPath, const zim::Archive& a)
|
|
{
|
|
// The version of spellings DB must be updated each time an important change
|
|
// to the implementation is made that renders using the previous version
|
|
// impossible or undesirable.
|
|
const char SPELLINGS_DB_VERSION[] = "0.1";
|
|
|
|
std::ostringstream filename;
|
|
filename << a.getUuid() << ".spellingsdb.v" << SPELLINGS_DB_VERSION;
|
|
return (cacheDirPath / filename.str()).string();
|
|
}
|
|
|
|
std::unique_ptr<Xapian::Database> openOrCreateXapianDB(std::filesystem::path cacheDirPath, const zim::Archive& archive)
|
|
{
|
|
const auto path = spellingsDBPathForZIMArchive(cacheDirPath, archive);
|
|
try
|
|
{
|
|
return std::make_unique<Xapian::Database>(path);
|
|
}
|
|
catch (const Xapian::DatabaseOpeningError& )
|
|
{
|
|
createXapianDB(path, archive);
|
|
return std::make_unique<Xapian::Database>(path);
|
|
}
|
|
}
|
|
|
|
} // unnamed namespace
|
|
|
|
SpellingsDB::SpellingsDB(const zim::Archive& archive, std::filesystem::path cacheDirPath)
|
|
: impl_(openOrCreateXapianDB(cacheDirPath, archive))
|
|
{
|
|
}
|
|
|
|
SpellingsDB::~SpellingsDB()
|
|
{
|
|
}
|
|
|
|
std::vector<std::string> SpellingsDB::getSpellingCorrections(const std::string& word, uint32_t maxCount) const
|
|
{
|
|
if ( maxCount > 1 ) {
|
|
throw std::runtime_error("More than one spelling correction was requested");
|
|
}
|
|
|
|
std::vector<std::string> result;
|
|
const auto term = impl_->get_spelling_suggestion(word, 3);
|
|
if ( !term.empty() ) {
|
|
result.push_back(term);
|
|
}
|
|
return result;
|
|
}
|
|
|
|
} // namespace kiwix
|