mu/lib/mu-xapian-db.hh

/*
** Copyright (C) 2023 Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
**
** 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, or (at your option) 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.
**
*/

#ifndef MU_XAPIAN_DB_HH__
#define MU_XAPIAN_DB_HH__

#include <variant>
#include <memory>
#include <string>
#include <mutex>
#include <functional>

#include <glib.h>

#include <xapian.h>
#include <utils/mu-result.hh>

namespace Mu {

// LCOV_EXCL_START

// avoid exception-handling boilerplate.
template <typename Func> void
xapian_try(Func&& func) noexcept
try {
	func();
} catch (const Xapian::Error& xerr) {
	g_critical("%s: xapian error '%s'", __func__, xerr.get_msg().c_str());
} catch (const std::runtime_error& re) {
	g_critical("%s: runtime error: %s", __func__, re.what());
} catch (const std::exception& e) {
	g_critical("%s: caught std::exception: %s", __func__, e.what());
} catch (...) {
	g_critical("%s: caught exception", __func__);
}

template <typename Func, typename Default = std::invoke_result<Func>> auto
xapian_try(Func&& func, Default&& def) noexcept -> std::decay_t<decltype(func())>
try {
	return func();
} catch (const Xapian::DocNotFoundError& xerr) {
	return static_cast<Default>(def);
} catch (const Xapian::Error& xerr) {
	g_warning("%s: xapian error '%s'", __func__, xerr.get_msg().c_str());
	return static_cast<Default>(def);
} catch (const std::runtime_error& re) {
	g_critical("%s: runtime error: %s", __func__, re.what());
	return static_cast<Default>(def);
} catch (const std::exception& e) {
	g_critical("%s: caught std::exception: %s", __func__, e.what());
	return static_cast<Default>(def);
} catch (...) {
	g_critical("%s: caught exception", __func__);
	return static_cast<Default>(def);
}


template <typename Func> auto
xapian_try_result(Func&& func) noexcept -> std::decay_t<decltype(func())>
try {
	return func();
} catch (const Xapian::Error& xerr) {
	return Err(Error::Code::Xapian, "%s", xerr.get_error_string());
} catch (const std::runtime_error& re) {
	return Err(Error::Code::Internal, "runtime error: %s", re.what());
} catch (const std::exception& e) {
	return Err(Error::Code::Internal, "caught std::exception: %s", e.what());
} catch (...) {
	return Err(Error::Code::Internal, "caught exception");
}

// LCOV_EXCL_STOP

/// abstract base
struct MetadataIface {
	virtual ~MetadataIface(){}
	virtual void set_metadata(const std::string& name, const std::string& val) = 0;
	virtual std::string metadata(const std::string& name) const		   = 0;
	virtual bool read_only() const						   = 0;

	using each_func = std::function<void(const std::string&, const std::string&)>;
	virtual void for_each(each_func&& func) const =0;

	/*
	 * These are special: handled on the Xapian db level
	 * rather than Config
	 */
	static inline constexpr std::string_view	created_key	= "created";
	static inline constexpr std::string_view	last_change_key = "last-change";
};


/// In-memory db
struct MemDb: public MetadataIface {
	/**
	 * Set some metadata
	 *
	 * @param name key name
	 * @param val value
	 */
	void set_metadata(const std::string& name, const std::string& val) override {
		map_.erase(name);
		map_[name] = val;
	}

	/**
	 * Get metadata for given key, empty if not found
	 *
	 * @param name key name
	 *
	 * @return string
	 */
	std::string metadata(const std::string& name) const override {
		if (auto&& it = map_.find(name); it != map_.end())
			return it->second;
		else
			return {};
	}

	/**
	 * Is this db read-only?
	 *
	 * @return true or false
	 */
	bool read_only() const override { return false; }


	/**
	 * Invoke function for each key/value pair. Do not call
	 * @this from each_func().
	 *
	 * @param func a function
	 */
	void for_each(MetadataIface::each_func&& func) const override {
		for (const auto& [key, value] : map_)
			func(key, value);
	}

private:
	std::unordered_map<std::string, std::string> map_;
};

/**
 * Fairly thin wrapper around Xapian::Database and Xapian::WritableDatabase
 * with just the things we need + locking + exception handling
 */
class XapianDb: public MetadataIface {
#define DB_LOCKED std::unique_lock l{lock()}
public:
	/**
	 * Type of database to create.
	 *
	 */
	enum struct Flavor {
		ReadOnly,	/**< Read-only database */
		Open,		/**< Open existing read-write */
		CreateOverwrite, /**< Create new or overwrite existing */
	};

	/**
	 * Make a new Xapian Database wrapper object
	 *
	 * @param db_path path to the database
	 * @param flavor type of database to created
	 *
	 * @return a result; either a XapianDb or an Error.
	 */
	static Result<XapianDb> make(const std::string& db_path, Flavor flavor) noexcept;

	/**
	 * Is the database read-only?
	 *
	 * @return true or false
	 */
	bool read_only() const override;

	/**
	 * Path to the database; empty for in-memory database
	 *
	 * @return path to database
	 */
	const std::string& path() const;

	/**
	 * Get the number of documents (messages) in the database
	 *
	 * @return number
	 */
	size_t size() const noexcept {
		return xapian_try([this]{
			DB_LOCKED; return db().get_doccount(); }, 0);
	}

	/**
	 * Is the the base empty?
	 *
	 * @return true or false
	 */
	size_t empty() const noexcept { return size() == 0; }

	/**
	 * Get a database enquire object for queries.
	 *
	 * @return an enquire object
	 */
	Xapian::Enquire enquire() const {
		DB_LOCKED; return Xapian::Enquire(db());
	}

	/**
	 * Get a document from the database if there is one
	 *
	 * @param id id of the document
	 *
	 * @return the document or an error
	 */
	Result<Xapian::Document> document(Xapian::docid id) const {
		return xapian_try_result([&]{
			DB_LOCKED; return Ok(db().get_document(id)); });
	}

	/**
	 * Get metadata for the given key
	 *
	 * @param key key (non-empty)
	 *
	 * @return the value or empty
	 */
	std::string metadata(const std::string& key) const override {
		return xapian_try([&]{
			DB_LOCKED; return db().get_metadata(key);}, "");
	}

	/**
	 * Set metadata for the given key
	 *
	 * @param key key (non-empty)
	 * @param val new value for key
	 */
	void set_metadata(const std::string& key, const std::string& val) override {
		xapian_try([&] { DB_LOCKED; wdb().set_metadata(key, val); });
	}

	/**
	 * Invoke function for each key/value pair. This is called with the lock
	 * held, so do not call functions on @this is each_func().
	 *
	 * @param each_func a function
	 */
	//using each_func = MetadataIface::each_func;
	void for_each(MetadataIface::each_func&& func) const override {
		xapian_try([&]{
			DB_LOCKED;
			for (auto&& it = db().metadata_keys_begin();
			     it != db().metadata_keys_end(); ++it)
				func(*it, db().get_metadata(*it));
		});
	}


	/**
	 * Does the given term exist in the database?
	 *
	 * @param term some term
	 *
	 * @return true or false
	 */
	bool term_exists(const std::string& term) const {
		return xapian_try([&]{
			DB_LOCKED; return db().term_exists(term);}, false);
	}

	/**
	 * Replace document in database
	 *
	 * @param term unique term
	 * @param id docid
	 * @param doc replacement document
	 *
	 * @return new docid or nothing.
	 */
	Xapian::docid replace_document(const std::string& term, const Xapian::Document& doc) {
		return xapian_try([&]{
			DB_LOCKED;
			auto&& id= wdb().replace_document(term, doc);
			set_timestamp(MetadataIface::last_change_key);
			return id;
		}, 0);
	}
	void replace_document(const Xapian::docid id, const Xapian::Document& doc) {
		xapian_try([&]{
			DB_LOCKED;
			wdb().replace_document(id, doc);
			set_timestamp(MetadataIface::last_change_key);
		});
	}

	/**
	 * Delete document(s) for the given term or id
	 *
	 * @param term a term
	 */
	void delete_document(const std::string& term) {
		xapian_try([&]{
			DB_LOCKED;
			wdb().delete_document(term);
			set_timestamp(MetadataIface::last_change_key);
		});
	}

	void delete_document(Xapian::docid id) {
		xapian_try([&]{
			DB_LOCKED;
			wdb().delete_document(id);
			set_timestamp(MetadataIface::last_change_key);
		});
	}

	template<typename Func>
	size_t all_terms(const std::string& prefix, Func&& func) const {
		DB_LOCKED;
		size_t n{};
		for (auto it = db().allterms_begin(prefix); it != db().allterms_end(prefix); ++it) {
			if (!func(*it))
				break;
			++n;
		}
		return n;
	}

	/*
	 * transactions
	 */

	/**
	 * Start a transaction
	 *
	 * @param flushed
	 */
	void begin_transaction(bool flushed=true) {
		xapian_try([&]{ DB_LOCKED; return wdb().begin_transaction(flushed);});
	}
	/**
	 * Commit a transaction
	 */
	void commit_transaction() {
		xapian_try([&]{ DB_LOCKED; return wdb().commit_transaction();});
	}

	/**
	 * Get a reference to the underlying database
	 *
	 * @return db database reference
	 */
	const Xapian::Database& db() const;
	/**
	 * Get a reference to the underlying writable database. It is
	 * an error to call this on a read-only database.
	 *
	 * @return db writable database reference
	 */
	Xapian::WritableDatabase& wdb();

	/**
	 * DTOR
	 */
	~XapianDb();

	/**
	 * Move CTOR
	 *
	 * @param rhs
	 */
	XapianDb(XapianDb&& rhs);

private:
	XapianDb(Xapian::Database&& db, const std::string& path);
	XapianDb(Xapian::WritableDatabase&& wdb, const std::string& path);
	void set_timestamp(const std::string_view key);
	std::mutex& lock() const;

	struct Private;
	std::unique_ptr<Private> priv_;
};

} // namespace Mu

#endif /* MU_XAPIAN_DB_HH__ */