1 /* The Ruby interface to the notmuch mail library
3 * Copyright © 2010, 2011 Ali Polatel
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see https://www.gnu.org/licenses/ .
18 * Author: Ali Polatel <alip@exherbo.org>
24 notmuch_rb_database_alloc (VALUE klass)
26 return Data_Wrap_Notmuch_Object (klass, ¬much_rb_database_type, NULL);
30 * call-seq: Notmuch::Database.new(path [, {:create => false, :mode => Notmuch::MODE_READ_ONLY}]) => DB
32 * Create or open a notmuch database using the given path.
34 * If :create is +true+, create the database instead of opening.
36 * The argument :mode specifies the open mode of the database.
39 notmuch_rb_database_initialize (int argc, VALUE *argv, VALUE self)
45 notmuch_database_t *database;
49 rb_scan_args (argc, argv, "11", &pathv, &hashv);
51 SafeStringValue (pathv);
52 path = RSTRING_PTR (pathv);
55 Check_Type (hashv, T_HASH);
56 create = RTEST (rb_hash_aref (hashv, ID2SYM (ID_db_create)));
57 modev = rb_hash_aref (hashv, ID2SYM (ID_db_mode));
59 mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
60 else if (!FIXNUM_P (modev))
61 rb_raise (rb_eTypeError, ":mode isn't a Fixnum");
63 mode = FIX2INT (modev);
65 case NOTMUCH_DATABASE_MODE_READ_ONLY:
66 case NOTMUCH_DATABASE_MODE_READ_WRITE:
69 rb_raise ( rb_eTypeError, "Invalid mode");
74 mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
77 rb_check_typeddata (self, ¬much_rb_database_type);
79 ret = notmuch_database_create (path, &database);
81 ret = notmuch_database_open (path, mode, &database);
82 notmuch_rb_status_raise (ret);
84 DATA_PTR (self) = database;
90 * call-seq: Notmuch::Database.open(path [, ahash]) {|db| ...}
92 * Identical to new, except that when it is called with a block, it yields with
93 * the new instance and closes it, and returns the result which is returned from
97 notmuch_rb_database_open (int argc, VALUE *argv, VALUE klass)
101 obj = rb_class_new_instance (argc, argv, klass);
102 if (!rb_block_given_p ())
105 return rb_ensure (rb_yield, obj, notmuch_rb_database_close, obj);
109 * call-seq: DB.close => nil
111 * Close the notmuch database.
114 notmuch_rb_database_close (VALUE self)
116 notmuch_status_t ret;
117 ret = notmuch_rb_object_destroy (self, ¬much_rb_database_type);
118 notmuch_rb_status_raise (ret);
124 * call-seq: DB.path => String
126 * Return the path of the database
129 notmuch_rb_database_path (VALUE self)
131 notmuch_database_t *db;
133 Data_Get_Notmuch_Database (self, db);
135 return rb_str_new2 (notmuch_database_get_path (db));
139 * call-seq: DB.version => Fixnum
141 * Return the version of the database
144 notmuch_rb_database_version (VALUE self)
146 notmuch_database_t *db;
148 Data_Get_Notmuch_Database (self, db);
150 return INT2FIX (notmuch_database_get_version (db));
154 * call-seq: DB.needs_upgrade? => true or false
156 * Return the +true+ if the database needs upgrading, +false+ otherwise
159 notmuch_rb_database_needs_upgrade (VALUE self)
161 notmuch_database_t *db;
163 Data_Get_Notmuch_Database (self, db);
165 return notmuch_database_needs_upgrade (db) ? Qtrue : Qfalse;
169 notmuch_rb_upgrade_notify (void *closure, double progress)
171 VALUE *block = (VALUE *) closure;
172 rb_funcall (*block, ID_call, 1, rb_float_new (progress));
176 * call-seq: DB.upgrade! [{|progress| block }] => nil
178 * Upgrade the database.
180 * If a block is given the block is called with a progress indicator as a
181 * floating point value in the range of [0.0..1.0].
184 notmuch_rb_database_upgrade (VALUE self)
186 notmuch_status_t ret;
187 void (*pnotify) (void *closure, double progress);
188 notmuch_database_t *db;
191 Data_Get_Notmuch_Database (self, db);
193 if (rb_block_given_p ()) {
194 pnotify = notmuch_rb_upgrade_notify;
195 block = rb_block_proc ();
200 ret = notmuch_database_upgrade (db, pnotify, pnotify ? &block : NULL);
201 notmuch_rb_status_raise (ret);
207 * call-seq: DB.begin_atomic => nil
209 * Begin an atomic database operation.
212 notmuch_rb_database_begin_atomic (VALUE self)
214 notmuch_status_t ret;
215 notmuch_database_t *db;
217 Data_Get_Notmuch_Database (self, db);
219 ret = notmuch_database_begin_atomic (db);
220 notmuch_rb_status_raise (ret);
226 * call-seq: DB.end_atomic => nil
228 * Indicate the end of an atomic database operation.
231 notmuch_rb_database_end_atomic (VALUE self)
233 notmuch_status_t ret;
234 notmuch_database_t *db;
236 Data_Get_Notmuch_Database (self, db);
238 ret = notmuch_database_end_atomic (db);
239 notmuch_rb_status_raise (ret);
245 * call-seq: DB.get_directory(path) => DIR
247 * Retrieve a directory object from the database for 'path'
250 notmuch_rb_database_get_directory (VALUE self, VALUE pathv)
253 notmuch_status_t ret;
254 notmuch_directory_t *dir;
255 notmuch_database_t *db;
257 Data_Get_Notmuch_Database (self, db);
259 SafeStringValue (pathv);
260 path = RSTRING_PTR (pathv);
262 ret = notmuch_database_get_directory (db, path, &dir);
263 notmuch_rb_status_raise (ret);
265 return Data_Wrap_Notmuch_Object (notmuch_rb_cDirectory, ¬much_rb_directory_type, dir);
270 * call-seq: DB.add_message(path) => MESSAGE, isdup
272 * Add a message to the database and return it.
274 * +isdup+ is a boolean that specifies whether the added message was a
278 notmuch_rb_database_add_message (VALUE self, VALUE pathv)
281 notmuch_status_t ret;
282 notmuch_message_t *message;
283 notmuch_database_t *db;
285 Data_Get_Notmuch_Database (self, db);
287 SafeStringValue (pathv);
288 path = RSTRING_PTR (pathv);
290 ret = notmuch_database_index_file (db, path, NULL, &message);
291 notmuch_rb_status_raise (ret);
292 return rb_assoc_new (Data_Wrap_Notmuch_Object (notmuch_rb_cMessage, ¬much_rb_message_type, message),
293 (ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) ? Qtrue : Qfalse);
297 * call-seq: DB.remove_message (path) => isdup
299 * Remove a message from the database.
301 * +isdup+ is a boolean that specifies whether the removed message was a
305 notmuch_rb_database_remove_message (VALUE self, VALUE pathv)
308 notmuch_status_t ret;
309 notmuch_database_t *db;
311 Data_Get_Notmuch_Database (self, db);
313 SafeStringValue (pathv);
314 path = RSTRING_PTR (pathv);
316 ret = notmuch_database_remove_message (db, path);
317 notmuch_rb_status_raise (ret);
318 return (ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) ? Qtrue : Qfalse;
322 * call-seq: DB.find_message(id) => MESSAGE or nil
324 * Find a message by message id.
327 notmuch_rb_database_find_message (VALUE self, VALUE idv)
330 notmuch_status_t ret;
331 notmuch_database_t *db;
332 notmuch_message_t *message;
334 Data_Get_Notmuch_Database (self, db);
336 SafeStringValue (idv);
337 id = RSTRING_PTR (idv);
339 ret = notmuch_database_find_message (db, id, &message);
340 notmuch_rb_status_raise (ret);
343 return Data_Wrap_Notmuch_Object (notmuch_rb_cMessage, ¬much_rb_message_type, message);
348 * call-seq: DB.find_message_by_filename(path) => MESSAGE or nil
350 * Find a message by filename.
353 notmuch_rb_database_find_message_by_filename (VALUE self, VALUE pathv)
356 notmuch_status_t ret;
357 notmuch_database_t *db;
358 notmuch_message_t *message;
360 Data_Get_Notmuch_Database (self, db);
362 SafeStringValue (pathv);
363 path = RSTRING_PTR (pathv);
365 ret = notmuch_database_find_message_by_filename (db, path, &message);
366 notmuch_rb_status_raise (ret);
369 return Data_Wrap_Notmuch_Object (notmuch_rb_cMessage, ¬much_rb_message_type, message);
374 * call-seq: DB.get_all_tags() => TAGS
376 * Returns a list of all tags found in the database.
379 notmuch_rb_database_get_all_tags (VALUE self)
381 notmuch_database_t *db;
382 notmuch_tags_t *tags;
384 Data_Get_Notmuch_Database (self, db);
386 tags = notmuch_database_get_all_tags (db);
388 const char *msg = notmuch_database_status_string (db);
390 msg = "Unknown notmuch error";
392 rb_raise (notmuch_rb_eBaseError, "%s", msg);
394 return Data_Wrap_Notmuch_Object (notmuch_rb_cTags, ¬much_rb_tags_type, tags);
398 * call-seq: DB.query(query) => QUERY
400 * Retrieve a query object for the query string 'query'
403 notmuch_rb_database_query_create (VALUE self, VALUE qstrv)
406 notmuch_query_t *query;
407 notmuch_database_t *db;
409 Data_Get_Notmuch_Database (self, db);
411 SafeStringValue (qstrv);
412 qstr = RSTRING_PTR (qstrv);
414 query = notmuch_query_create (db, qstr);
416 rb_raise (notmuch_rb_eMemoryError, "Out of memory");
418 return Data_Wrap_Notmuch_Object (notmuch_rb_cQuery, ¬much_rb_query_type, query);