X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=bindings%2Fruby%2Fdatabase.c;h=416eb709f19d231bfdf6460c37a8e2262fad24af;hp=90c220a14b93a0c5bafaf5fd807645fd782bb2ec;hb=HEAD;hpb=898613116db746aa0f915ae43da8aba28545203d diff --git a/bindings/ruby/database.c b/bindings/ruby/database.c index 90c220a1..ed224ef7 100644 --- a/bindings/ruby/database.c +++ b/bindings/ruby/database.c @@ -13,7 +13,7 @@ * 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, see http://www.gnu.org/licenses/ . + * along with this program. If not, see https://www.gnu.org/licenses/ . * * Author: Ali Polatel */ @@ -21,9 +21,22 @@ #include "defs.h" VALUE -notmuch_rb_database_alloc(VALUE klass) +notmuch_rb_database_alloc (VALUE klass) { - return Data_Wrap_Struct(klass, NULL, NULL, NULL); + return Data_Wrap_Notmuch_Object (klass, ¬much_rb_database_type, NULL); +} + +/* + * call-seq: DB.destroy => nil + * + * Destroys the database, freeing all resources allocated for it. + */ +VALUE +notmuch_rb_database_destroy (VALUE self) +{ + notmuch_rb_object_destroy (self, ¬much_rb_database_type); + + return Qnil; } /* @@ -36,51 +49,68 @@ notmuch_rb_database_alloc(VALUE klass) * The argument :mode specifies the open mode of the database. */ VALUE -notmuch_rb_database_initialize(int argc, VALUE *argv, VALUE self) +notmuch_rb_database_initialize (int argc, VALUE *argv, VALUE self) { const char *path; int create, mode; VALUE pathv, hashv; VALUE modev; + notmuch_database_t *database; + notmuch_status_t ret; -#if !defined(RSTRING_PTR) -#define RSTRING_PTR(v) (RSTRING((v))->ptr) -#endif /* !defined(RSTRING_PTR) */ + path = NULL; + create = 0; + mode = NOTMUCH_DATABASE_MODE_READ_ONLY; /* Check arguments */ - rb_scan_args(argc, argv, "11", &pathv, &hashv); - - SafeStringValue(pathv); - path = RSTRING_PTR(pathv); - - if (!NIL_P(hashv)) { - Check_Type(hashv, T_HASH); - create = RTEST(rb_hash_aref(hashv, ID2SYM(ID_db_create))); - modev = rb_hash_aref(hashv, ID2SYM(ID_db_mode)); - if (NIL_P(modev)) - mode = NOTMUCH_DATABASE_MODE_READ_ONLY; - else if (!FIXNUM_P(modev)) - rb_raise(rb_eTypeError, ":mode isn't a Fixnum"); - else { - mode = FIX2INT(modev); - switch (mode) { - case NOTMUCH_DATABASE_MODE_READ_ONLY: - case NOTMUCH_DATABASE_MODE_READ_WRITE: - break; - default: - rb_raise(rb_eTypeError, "Invalid mode"); - } - } + rb_scan_args (argc, argv, "02", &pathv, &hashv); + + if (!NIL_P (pathv)) { + SafeStringValue (pathv); + path = RSTRING_PTR (pathv); } - else { - create = 0; - mode = NOTMUCH_DATABASE_MODE_READ_ONLY; + + if (!NIL_P (hashv)) { + VALUE rmode, rcreate; + VALUE kwargs[2]; + static ID keyword_ids[2]; + + if (!keyword_ids[0]) { + keyword_ids[0] = rb_intern_const ("mode"); + keyword_ids[1] = rb_intern_const ("create"); + } + + rb_get_kwargs (hashv, keyword_ids, 0, 2, kwargs); + + rmode = kwargs[0]; + rcreate = kwargs[1]; + + if (rmode != Qundef) { + if (!FIXNUM_P (rmode)) + rb_raise (rb_eTypeError, ":mode isn't a Fixnum"); + else { + mode = FIX2INT (rmode); + switch (mode) { + case NOTMUCH_DATABASE_MODE_READ_ONLY: + case NOTMUCH_DATABASE_MODE_READ_WRITE: + break; + default: + rb_raise ( rb_eTypeError, "Invalid mode"); + } + } + } + if (rcreate != Qundef) + create = RTEST (rcreate); } - Check_Type(self, T_DATA); - DATA_PTR(self) = create ? notmuch_database_create(path) : notmuch_database_open(path, mode); - if (!DATA_PTR(self)) - rb_raise(notmuch_rb_eDatabaseError, "Failed to open database"); + rb_check_typeddata (self, ¬much_rb_database_type); + if (create) + ret = notmuch_database_create (path, &database); + else + ret = notmuch_database_open_with_config (path, mode, NULL, NULL, &database, NULL); + notmuch_rb_status_raise (ret); + + DATA_PTR (self) = notmuch_rb_object_create (database, "notmuch_rb_database"); return self; } @@ -93,15 +123,15 @@ notmuch_rb_database_initialize(int argc, VALUE *argv, VALUE self) * the block. */ VALUE -notmuch_rb_database_open(int argc, VALUE *argv, VALUE klass) +notmuch_rb_database_open (int argc, VALUE *argv, VALUE klass) { VALUE obj; - obj = rb_class_new_instance(argc, argv, klass); - if (!rb_block_given_p()) - return obj; + obj = rb_class_new_instance (argc, argv, klass); + if (!rb_block_given_p ()) + return obj; - return rb_ensure(rb_yield, obj, notmuch_rb_database_close, obj); + return rb_ensure (rb_yield, obj, notmuch_rb_database_close, obj); } /* @@ -110,13 +140,15 @@ notmuch_rb_database_open(int argc, VALUE *argv, VALUE klass) * Close the notmuch database. */ VALUE -notmuch_rb_database_close(VALUE self) +notmuch_rb_database_close (VALUE self) { notmuch_database_t *db; + notmuch_status_t ret; - Data_Get_Notmuch_Database(self, db); - notmuch_database_close(db); - DATA_PTR(self) = NULL; + Data_Get_Notmuch_Database (self, db); + + ret = notmuch_database_close (db); + notmuch_rb_status_raise (ret); return Qnil; } @@ -127,13 +159,13 @@ notmuch_rb_database_close(VALUE self) * Return the path of the database */ VALUE -notmuch_rb_database_path(VALUE self) +notmuch_rb_database_path (VALUE self) { notmuch_database_t *db; - Data_Get_Notmuch_Database(self, db); + Data_Get_Notmuch_Database (self, db); - return rb_str_new2(notmuch_database_get_path(db)); + return rb_str_new2 (notmuch_database_get_path (db)); } /* @@ -142,13 +174,13 @@ notmuch_rb_database_path(VALUE self) * Return the version of the database */ VALUE -notmuch_rb_database_version(VALUE self) +notmuch_rb_database_version (VALUE self) { notmuch_database_t *db; - Data_Get_Notmuch_Database(self, db); + Data_Get_Notmuch_Database (self, db); - return INT2FIX(notmuch_database_get_version(db)); + return INT2FIX (notmuch_database_get_version (db)); } /* @@ -157,20 +189,20 @@ notmuch_rb_database_version(VALUE self) * Return the +true+ if the database needs upgrading, +false+ otherwise */ VALUE -notmuch_rb_database_needs_upgrade(VALUE self) +notmuch_rb_database_needs_upgrade (VALUE self) { notmuch_database_t *db; - Data_Get_Notmuch_Database(self, db); + Data_Get_Notmuch_Database (self, db); - return notmuch_database_needs_upgrade(db) ? Qtrue : Qfalse; + return notmuch_database_needs_upgrade (db) ? Qtrue : Qfalse; } static void -notmuch_rb_upgrade_notify(void *closure, double progress) +notmuch_rb_upgrade_notify (void *closure, double progress) { - VALUE *block = (VALUE *)closure; - rb_funcall(*block, ID_call, 1, rb_float_new(progress)); + VALUE *block = (VALUE *) closure; + rb_funcall (*block, ID_call, 1, rb_float_new (progress)); } /* @@ -182,24 +214,24 @@ notmuch_rb_upgrade_notify(void *closure, double progress) * floating point value in the range of [0.0..1.0]. */ VALUE -notmuch_rb_database_upgrade(VALUE self) +notmuch_rb_database_upgrade (VALUE self) { notmuch_status_t ret; void (*pnotify) (void *closure, double progress); notmuch_database_t *db; VALUE block; - Data_Get_Notmuch_Database(self, db); + Data_Get_Notmuch_Database (self, db); - if (rb_block_given_p()) { - pnotify = notmuch_rb_upgrade_notify; - block = rb_block_proc(); + if (rb_block_given_p ()) { + pnotify = notmuch_rb_upgrade_notify; + block = rb_block_proc (); } else - pnotify = NULL; + pnotify = NULL; - ret = notmuch_database_upgrade(db, pnotify, pnotify ? &block : NULL); - notmuch_rb_status_raise(ret); + ret = notmuch_database_upgrade (db, pnotify, pnotify ? &block : NULL); + notmuch_rb_status_raise (ret); return Qtrue; } @@ -210,15 +242,15 @@ notmuch_rb_database_upgrade(VALUE self) * Begin an atomic database operation. */ VALUE -notmuch_rb_database_begin_atomic(VALUE self) +notmuch_rb_database_begin_atomic (VALUE self) { notmuch_status_t ret; notmuch_database_t *db; - Data_Get_Notmuch_Database(self, db); + Data_Get_Notmuch_Database (self, db); - ret = notmuch_database_begin_atomic(db); - notmuch_rb_status_raise(ret); + ret = notmuch_database_begin_atomic (db); + notmuch_rb_status_raise (ret); return Qtrue; } @@ -229,15 +261,15 @@ notmuch_rb_database_begin_atomic(VALUE self) * Indicate the end of an atomic database operation. */ VALUE -notmuch_rb_database_end_atomic(VALUE self) +notmuch_rb_database_end_atomic (VALUE self) { notmuch_status_t ret; notmuch_database_t *db; - Data_Get_Notmuch_Database(self, db); + Data_Get_Notmuch_Database (self, db); - ret = notmuch_database_end_atomic(db); - notmuch_rb_status_raise(ret); + ret = notmuch_database_end_atomic (db); + notmuch_rb_status_raise (ret); return Qtrue; } @@ -248,26 +280,23 @@ notmuch_rb_database_end_atomic(VALUE self) * Retrieve a directory object from the database for 'path' */ VALUE -notmuch_rb_database_get_directory(VALUE self, VALUE pathv) +notmuch_rb_database_get_directory (VALUE self, VALUE pathv) { const char *path; + notmuch_status_t ret; notmuch_directory_t *dir; notmuch_database_t *db; - Data_Get_Notmuch_Database(self, db); - -#if !defined(RSTRING_PTR) -#define RSTRING_PTR(v) (RSTRING((v))->ptr) -#endif /* !defined(RSTRING_PTR) */ - - SafeStringValue(pathv); - path = RSTRING_PTR(pathv); + Data_Get_Notmuch_Database (self, db); - dir = notmuch_database_get_directory(db, path); - if (!dir) - rb_raise(notmuch_rb_eXapianError, "Xapian exception"); + SafeStringValue (pathv); + path = RSTRING_PTR (pathv); - return Data_Wrap_Struct(notmuch_rb_cDirectory, NULL, NULL, dir); + ret = notmuch_database_get_directory (db, path, &dir); + notmuch_rb_status_raise (ret); + if (dir) + return Data_Wrap_Notmuch_Object (notmuch_rb_cDirectory, ¬much_rb_directory_type, dir); + return Qnil; } /* @@ -279,30 +308,26 @@ notmuch_rb_database_get_directory(VALUE self, VALUE pathv) * duplicate. */ VALUE -notmuch_rb_database_add_message(VALUE self, VALUE pathv) +notmuch_rb_database_add_message (VALUE self, VALUE pathv) { const char *path; notmuch_status_t ret; notmuch_message_t *message; notmuch_database_t *db; - Data_Get_Notmuch_Database(self, db); - -#if !defined(RSTRING_PTR) -#define RSTRING_PTR(v) (RSTRING((v))->ptr) -#endif /* !defined(RSTRING_PTR) */ + Data_Get_Notmuch_Database (self, db); - SafeStringValue(pathv); - path = RSTRING_PTR(pathv); + SafeStringValue (pathv); + path = RSTRING_PTR (pathv); - ret = notmuch_database_add_message(db, path, &message); - notmuch_rb_status_raise(ret); - return rb_assoc_new(Data_Wrap_Struct(notmuch_rb_cMessage, NULL, NULL, message), + ret = notmuch_database_index_file (db, path, NULL, &message); + notmuch_rb_status_raise (ret); + return rb_assoc_new (Data_Wrap_Notmuch_Object (notmuch_rb_cMessage, ¬much_rb_message_type, message), (ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) ? Qtrue : Qfalse); } /* - * call-seq: DB.remove_message(path) => isdup + * call-seq: DB.remove_message (path) => isdup * * Remove a message from the database. * @@ -310,23 +335,19 @@ notmuch_rb_database_add_message(VALUE self, VALUE pathv) * duplicate. */ VALUE -notmuch_rb_database_remove_message(VALUE self, VALUE pathv) +notmuch_rb_database_remove_message (VALUE self, VALUE pathv) { const char *path; notmuch_status_t ret; notmuch_database_t *db; - Data_Get_Notmuch_Database(self, db); - -#if !defined(RSTRING_PTR) -#define RSTRING_PTR(v) (RSTRING((v))->ptr) -#endif /* !defined(RSTRING_PTR) */ + Data_Get_Notmuch_Database (self, db); - SafeStringValue(pathv); - path = RSTRING_PTR(pathv); + SafeStringValue (pathv); + path = RSTRING_PTR (pathv); - ret = notmuch_database_remove_message(db, path); - notmuch_rb_status_raise(ret); + ret = notmuch_database_remove_message (db, path); + notmuch_rb_status_raise (ret); return (ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) ? Qtrue : Qfalse; } @@ -336,27 +357,23 @@ notmuch_rb_database_remove_message(VALUE self, VALUE pathv) * Find a message by message id. */ VALUE -notmuch_rb_database_find_message(VALUE self, VALUE idv) +notmuch_rb_database_find_message (VALUE self, VALUE idv) { const char *id; notmuch_status_t ret; notmuch_database_t *db; notmuch_message_t *message; - Data_Get_Notmuch_Database(self, db); + Data_Get_Notmuch_Database (self, db); -#if !defined(RSTRING_PTR) -#define RSTRING_PTR(v) (RSTRING((v))->ptr) -#endif /* !defined(RSTRING_PTR) */ + SafeStringValue (idv); + id = RSTRING_PTR (idv); - SafeStringValue(idv); - id = RSTRING_PTR(idv); - - ret = notmuch_database_find_message(db, id, &message); - notmuch_rb_status_raise(ret); + ret = notmuch_database_find_message (db, id, &message); + notmuch_rb_status_raise (ret); if (message) - return Data_Wrap_Struct(notmuch_rb_cMessage, NULL, NULL, message); + return Data_Wrap_Notmuch_Object (notmuch_rb_cMessage, ¬much_rb_message_type, message); return Qnil; } @@ -366,54 +383,111 @@ notmuch_rb_database_find_message(VALUE self, VALUE idv) * Find a message by filename. */ VALUE -notmuch_rb_database_find_message_by_filename(VALUE self, VALUE pathv) +notmuch_rb_database_find_message_by_filename (VALUE self, VALUE pathv) { const char *path; notmuch_status_t ret; notmuch_database_t *db; notmuch_message_t *message; - Data_Get_Notmuch_Database(self, db); - -#if !defined(RSTRING_PTR) -#define RSTRING_PTR(v) (RSTRING((v))->ptr) -#endif /* !defined(RSTRING_PTR) */ + Data_Get_Notmuch_Database (self, db); - SafeStringValue(pathv); - path = RSTRING_PTR(pathv); + SafeStringValue (pathv); + path = RSTRING_PTR (pathv); - ret = notmuch_database_find_message_by_filename(db, path, &message); - notmuch_rb_status_raise(ret); + ret = notmuch_database_find_message_by_filename (db, path, &message); + notmuch_rb_status_raise (ret); if (message) - return Data_Wrap_Struct(notmuch_rb_cMessage, NULL, NULL, message); + return Data_Wrap_Notmuch_Object (notmuch_rb_cMessage, ¬much_rb_message_type, message); return Qnil; } /* - * call-seq: DB.query(query) => QUERY + * call-seq: DB.get_all_tags() => TAGS + * + * Returns a list of all tags found in the database. + */ +VALUE +notmuch_rb_database_get_all_tags (VALUE self) +{ + notmuch_database_t *db; + notmuch_tags_t *tags; + + Data_Get_Notmuch_Database (self, db); + + tags = notmuch_database_get_all_tags (db); + if (!tags) { + const char *msg = notmuch_database_status_string (db); + if (!msg) + msg = "Unknown notmuch error"; + + rb_raise (notmuch_rb_eBaseError, "%s", msg); + } + return notmuch_rb_tags_get (tags); +} + +/* + * call-seq: + * DB.query(query) => QUERY + * DB.query(query, sort:, excluded_tags:, omit_excluded:) => QUERY * - * Retrieve a query object for the query string 'query' + * Retrieve a query object for the query string 'query'. When using keyword + * arguments they are passwed to the query object. */ VALUE -notmuch_rb_database_query_create(VALUE self, VALUE qstrv) +notmuch_rb_database_query_create (int argc, VALUE *argv, VALUE self) { + VALUE qstrv; + VALUE opts; const char *qstr; notmuch_query_t *query; notmuch_database_t *db; - Data_Get_Notmuch_Database(self, db); + rb_scan_args (argc, argv, "1:", &qstrv, &opts); -#if !defined(RSTRING_PTR) -#define RSTRING_PTR(v) (RSTRING((v))->ptr) -#endif /* !defined(RSTRING_PTR) */ + Data_Get_Notmuch_Database (self, db); - SafeStringValue(qstrv); - qstr = RSTRING_PTR(qstrv); + SafeStringValue (qstrv); + qstr = RSTRING_PTR (qstrv); - query = notmuch_query_create(db, qstr); + query = notmuch_query_create (db, qstr); if (!query) - rb_raise(notmuch_rb_eMemoryError, "Out of memory"); + rb_raise (notmuch_rb_eMemoryError, "Out of memory"); + + if (!NIL_P (opts)) { + VALUE sort, exclude_tags, omit_excluded; + VALUE kwargs[3]; + static ID keyword_ids[3]; + + if (!keyword_ids[0]) { + keyword_ids[0] = rb_intern_const ("sort"); + keyword_ids[1] = rb_intern_const ("exclude_tags"); + keyword_ids[2] = rb_intern_const ("omit_excluded"); + } + + rb_get_kwargs (opts, keyword_ids, 0, 3, kwargs); + + sort = kwargs[0]; + exclude_tags = kwargs[1]; + omit_excluded = kwargs[2]; + + if (sort != Qundef) + notmuch_query_set_sort (query, FIX2UINT (sort)); + + if (exclude_tags != Qundef) { + for (int i = 0; i < RARRAY_LEN (exclude_tags); i++) { + VALUE e = RARRAY_AREF (exclude_tags, i); + notmuch_query_add_tag_exclude (query, RSTRING_PTR (e)); + } + } + + if (omit_excluded != Qundef) { + notmuch_exclude_t omit; + omit = FIXNUM_P (omit_excluded) ? FIX2UINT (omit_excluded) : RTEST(omit_excluded); + notmuch_query_set_omit_excluded (query, omit); + } + } - return Data_Wrap_Struct(notmuch_rb_cQuery, NULL, NULL, query); + return Data_Wrap_Notmuch_Object (notmuch_rb_cQuery, ¬much_rb_query_type, query); }