/* ** Copyright (C) 2008-2017 Dirk-Jan C. Binnema ** ** 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_STORE_H__ #define __MU_STORE_H__ #include #include #include #include /* for MuError, MuError */ #include G_BEGIN_DECLS struct _MuStore; typedef struct _MuStore MuStore; /* http://article.gmane.org/gmane.comp.search.xapian.general/3656 */ #define MU_STORE_MAX_TERM_LENGTH (240) /** * create a new writable Xapian store, a place to store documents * * @param path the path to the database * @param ccachepath path where to cache the contacts information, or NULL * @param err to receive error info or NULL. err->code is MuError value * * @return a new MuStore object with ref count == 1, or NULL in case * of error; free with mu_store_unref */ MuStore* mu_store_new_writable (const char *xpath, const char *ccachepath, gboolean rebuild, GError **err) G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT; /** * create a new read-only Xapian store, for querying documents * * @param path the path to the database * @param err to receive error info or NULL. err->code is MuError value * * @return a new MuStore object with ref count == 1, or NULL in case * of error; free with mu_store_unref */ MuStore* mu_store_new_read_only (const char* xpath, GError **err) G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT; /** * increase the reference count for this store with 1 * * @param store a valid store object * * @return the same store with increased ref count, or NULL in case of * error */ MuStore* mu_store_ref (MuStore *store); /** * decrease the reference count for this store with 1 * * @param store a valid store object * * @return NULL */ MuStore* mu_store_unref (MuStore *store); /** * we need this when using Xapian::WritableDatabase* from C */ typedef gpointer XapianWritableDatabase; /** * get the underlying writable database object for this store; not * that this pointer becomes in valid after mu_store_destroy * * @param store a valid store * * @return a Xapian::WritableDatabase (you'll need to cast in C++), or * NULL in case of error. */ XapianWritableDatabase* mu_store_get_writable_database (MuStore *store); /** * we need this when using Xapian::WritableDatabase* from C */ typedef gpointer XapianDatabase; /** * get the underlying read-only database object for this store; not that this * pointer becomes in valid after mu_store_destroy * * @param store a valid store * * @return a Xapian::Database (you'll need to cast in C++), or * NULL in case of error. */ XapianDatabase* mu_store_get_read_only_database (MuStore *store); /** * set the Xapian batch size for this store. Normally, there's no need * to use this function as the default is good enough; however, if you * use mu in a very memory-constrained environment, you can set the * batchsize to e.g. 1000 at the cost of significant slow-down. * * @param store a valid store object * @param batchsize the new batch size; or 0 to reset to * the default batch size */ void mu_store_set_batch_size (MuStore *store, guint batchsize); /** * register a char** of email addresses as 'my' addresses, ie. mark * message that have these addresses in one of the address fields as * 'personal' (e.g., in mu-contacts). calling this function overrides * any 'my addresses' that were set before, using this function or * through mu_store_new_writable * * @param store a valid store object * @param my_addresses a char** of email addresses */ void mu_store_set_my_addresses (MuStore *store, const char **my_addresses); /** * Get the a MuContacts* ptr for this store. * * @param store a store * * @return the contacts ptr */ MuContacts* mu_store_contacts (MuStore *store); /** * get the numbers of documents in the database * * @param index a valid MuStore instance * @param err to receive error info or NULL. err->code is MuError value * * @return the number of documents in the database; (unsigned)-1 in * case of error */ unsigned mu_store_count (const MuStore *store, GError **err); /** * get a version string for the database; it's a const string, which * is valid as long MuStore exists and mu_store_version is not called * again. * * @param store a valid MuStore * * @return the version string or NULL in case of error */ const char* mu_store_version (const MuStore *store); /** * try to flush/commit all outstanding work to the database and the contacts * cache. * * @param store a valid xapian store */ void mu_store_flush (MuStore *store); #define MU_STORE_INVALID_DOCID 0 /** * store an email message in the XapianStore * * @param store a valid store * @param msg a valid message * @param err receives error information, if any, or NULL * * @return the docid of the stored message, or 0 * (MU_STORE_INVALID_DOCID) in case of error */ unsigned mu_store_add_msg (MuStore *store, MuMsg *msg, GError **err); /** * update an email message in the XapianStore * * @param store a valid store * @param the docid for the message * @param msg a valid message * @param err receives error information, if any, or NULL * * @return the docid of the stored message, or 0 * (MU_STORE_INVALID_DOCID) in case of error */ unsigned mu_store_update_msg (MuStore *store, unsigned docid, MuMsg *msg, GError **err); /** * store an email message in the XapianStore; similar to * mu_store_store, but instead takes a path as parameter instead of a * MuMsg* * * @param store a valid store * @param path full filesystem path to a valid message * @param maildir set the maildir (e.g. "/drafts") for this message, or NULL * note that you cannot mu_msg_move_msg_to_maildir unless maildir is set. * @param err receives error information, if any, or NULL * * @return the docid of the stored message, or 0 * (MU_STORE_INVALID_DOCID) in case of error */ unsigned mu_store_add_path (MuStore *store, const char *path, const char* maildir, GError **err); /** * remove a message from the database based on its path * * @param store a valid store * @param msgpath path of the message (note, this is only used to * *identify* the message; a common use of this function is to remove * a message from the database, for which there is no message anymore * in the filesystem. * * @return TRUE if it succeeded, FALSE otherwise */ gboolean mu_store_remove_path (MuStore *store, const char* msgpath); /** * does a certain message exist in the database already? * * @param store a store * @param path the message path * @param err to receive error info or NULL. err->code is MuError value * * @return TRUE if the message exists, FALSE otherwise */ gboolean mu_store_contains_message (const MuStore *store, const char* path, GError **err); /** * get the docid for message at path * * @param store a store * @param path the message path * @param err to receive error info or NULL. err->code is MuError value * * @return the docid if the message was found, MU_STORE_INVALID_DOCID (0) otherwise * */ unsigned mu_store_get_docid_for_path (const MuStore *store, const char* path, GError **err); /** * store a timestamp for a directory * * @param store a valid store * @param msgpath path to a maildir * @param stamp a timestamp * @param err to receive error info or NULL. err->code is MuError value * * @return TRUE if setting the timestamp succeeded, FALSE otherwise */ gboolean mu_store_set_timestamp (MuStore *store, const char* msgpath, time_t stamp, GError **err); /** * get the timestamp for a directory * * @param store a valid store * @param msgpath path to a maildir * @param err to receive error info or NULL. err->code is MuError value * * @return the timestamp, or 0 in case of error */ time_t mu_store_get_timestamp (const MuStore *store, const char* msgpath, GError **err); /** * check whether this store is read-only * * @param store a store * * @return TRUE if the store is read-only, FALSE otherwise (and in * case of error) */ gboolean mu_store_is_read_only (const MuStore *store); /** * call a function for each document in the database * * @param self a valid store * @param func a callback function to to call for each document * @param user_data a user pointer passed to the callback function * @param err to receive error info or NULL. err->code is MuError value * * @return MU_OK if all went well, MU_STOP if the foreach was interrupted, * MU_ERROR in case of error */ typedef MuError (*MuStoreForeachFunc) (const char* path, gpointer user_data); MuError mu_store_foreach (MuStore *self, MuStoreForeachFunc func, void *user_data, GError **err); /** * set metadata for this MuStore * * @param store a store * @param key metadata key * @param val metadata value * @param err to receive error info or NULL. err->code is the MuError value * * @return TRUE if succeeded, FALSE otherwise */ gboolean mu_store_set_metadata (MuStore *store, const char *key, const char *val, GError **err); /** * get metadata for this MuStore * * @param store a store * @param key the metadata key * @param err to receive error info or NULL. err->code is MuError value * * @return the value of the metadata (gfree when done with it), or * NULL in case of error */ char* mu_store_get_metadata (const MuStore *store, const char *key, GError **err) G_GNUC_WARN_UNUSED_RESULT; /** " * get the version of the xapian database (ie., the version of the * 'schema' we are using). If this version != MU_STORE_SCHEMA_VERSION, * it's means we need to a full reindex. * * @param xpath path to the xapian database * * @return the version of the database as a newly allocated string * (free with g_free); if there is no version yet, it will return NULL */ gchar* mu_store_database_version (const gchar *xpath) G_GNUC_WARN_UNUSED_RESULT; /** * check whether the database schema's version is the same as the one * that the current mu uses. If they are not the same, we'll need a * database rebuild. * * @param store a MuStore instance * * @return TRUE if the versions are the same, FALSE otherwise. */ gboolean mu_store_versions_match (const MuStore *store); /** * clear the database, ie., remove all of the contents. This is a * destructive operation, but the database can be restored be doing a * full scan of the maildirs. Also, clear the contacts cache file * * @param store a MuStore object * @param err to receive error info or NULL. err->code is MuError value * * @return TRUE if the clearing succeeded, FALSE otherwise. */ gboolean mu_store_clear (MuStore *store, GError **err); /** * check if the database is locked for writing * * @param xpath path to a xapian database * * @return TRUE if it is locked, FALSE otherwise (or in case of error) */ gboolean mu_store_database_is_locked (const gchar *xpath); /** * get a specific message, based on its Xapian docid * * @param self a valid MuQuery instance * @param docid the Xapian docid for the wanted message * @param err receives error information, or NULL * * @return a MuMsg instance (use mu_msg_unref when done with it), or * NULL in case of error */ MuMsg* mu_store_get_msg (const MuStore *self, unsigned docid, GError **err) G_GNUC_WARN_UNUSED_RESULT; G_END_DECLS #endif /*__MU_STORE_H__*/