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 http://www.gnu.org/licenses/ .
18 * Author: Ali Polatel <alip@exherbo.org>
24 notmuch_rb_database_alloc (VALUE klass)
26 return Data_Wrap_Struct (klass, NULL, NULL, 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)
47 rb_scan_args (argc, argv, "11", &pathv, &hashv);
49 SafeStringValue (pathv);
50 path = RSTRING_PTR (pathv);
53 Check_Type (hashv, T_HASH);
54 create = RTEST (rb_hash_aref (hashv, ID2SYM (ID_db_create)));
55 modev = rb_hash_aref (hashv, ID2SYM (ID_db_mode));
57 mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
58 else if (!FIXNUM_P (modev))
59 rb_raise (rb_eTypeError, ":mode isn't a Fixnum");
61 mode = FIX2INT (modev);
63 case NOTMUCH_DATABASE_MODE_READ_ONLY:
64 case NOTMUCH_DATABASE_MODE_READ_WRITE:
67 rb_raise ( rb_eTypeError, "Invalid mode");
72 mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
75 Check_Type (self, T_DATA);
76 DATA_PTR (self) = create ? notmuch_database_create (path) : notmuch_database_open (path, mode);
78 rb_raise (notmuch_rb_eDatabaseError, "Failed to open database");
84 * call-seq: Notmuch::Database.open(path [, ahash]) {|db| ...}
86 * Identical to new, except that when it is called with a block, it yields with
87 * the new instance and closes it, and returns the result which is returned from
91 notmuch_rb_database_open (int argc, VALUE *argv, VALUE klass)
95 obj = rb_class_new_instance (argc, argv, klass);
96 if (!rb_block_given_p ())
99 return rb_ensure (rb_yield, obj, notmuch_rb_database_close, obj);
103 * call-seq: DB.close => nil
105 * Close the notmuch database.
108 notmuch_rb_database_close (VALUE self)
110 notmuch_database_t *db;
112 Data_Get_Notmuch_Database (self, db);
113 notmuch_database_close (db);
114 DATA_PTR (self) = NULL;
120 * call-seq: DB.path => String
122 * Return the path of the database
125 notmuch_rb_database_path (VALUE self)
127 notmuch_database_t *db;
129 Data_Get_Notmuch_Database (self, db);
131 return rb_str_new2 (notmuch_database_get_path (db));
135 * call-seq: DB.version => Fixnum
137 * Return the version of the database
140 notmuch_rb_database_version (VALUE self)
142 notmuch_database_t *db;
144 Data_Get_Notmuch_Database (self, db);
146 return INT2FIX (notmuch_database_get_version (db));
150 * call-seq: DB.needs_upgrade? => true or false
152 * Return the +true+ if the database needs upgrading, +false+ otherwise
155 notmuch_rb_database_needs_upgrade (VALUE self)
157 notmuch_database_t *db;
159 Data_Get_Notmuch_Database (self, db);
161 return notmuch_database_needs_upgrade (db) ? Qtrue : Qfalse;
165 notmuch_rb_upgrade_notify (void *closure, double progress)
167 VALUE *block = (VALUE *) closure;
168 rb_funcall (*block, ID_call, 1, rb_float_new (progress));
172 * call-seq: DB.upgrade! [{|progress| block }] => nil
174 * Upgrade the database.
176 * If a block is given the block is called with a progress indicator as a
177 * floating point value in the range of [0.0..1.0].
180 notmuch_rb_database_upgrade (VALUE self)
182 notmuch_status_t ret;
183 void (*pnotify) (void *closure, double progress);
184 notmuch_database_t *db;
187 Data_Get_Notmuch_Database (self, db);
189 if (rb_block_given_p ()) {
190 pnotify = notmuch_rb_upgrade_notify;
191 block = rb_block_proc ();
196 ret = notmuch_database_upgrade (db, pnotify, pnotify ? &block : NULL);
197 notmuch_rb_status_raise (ret);
203 * call-seq: DB.begin_atomic => nil
205 * Begin an atomic database operation.
208 notmuch_rb_database_begin_atomic (VALUE self)
210 notmuch_status_t ret;
211 notmuch_database_t *db;
213 Data_Get_Notmuch_Database (self, db);
215 ret = notmuch_database_begin_atomic (db);
216 notmuch_rb_status_raise (ret);
222 * call-seq: DB.end_atomic => nil
224 * Indicate the end of an atomic database operation.
227 notmuch_rb_database_end_atomic (VALUE self)
229 notmuch_status_t ret;
230 notmuch_database_t *db;
232 Data_Get_Notmuch_Database (self, db);
234 ret = notmuch_database_end_atomic (db);
235 notmuch_rb_status_raise (ret);
241 * call-seq: DB.get_directory(path) => DIR
243 * Retrieve a directory object from the database for 'path'
246 notmuch_rb_database_get_directory (VALUE self, VALUE pathv)
249 notmuch_directory_t *dir;
250 notmuch_database_t *db;
252 Data_Get_Notmuch_Database (self, db);
254 SafeStringValue (pathv);
255 path = RSTRING_PTR (pathv);
257 dir = notmuch_database_get_directory (db, path);
259 rb_raise (notmuch_rb_eXapianError, "Xapian exception");
261 return Data_Wrap_Struct (notmuch_rb_cDirectory, NULL, NULL, dir);
265 * call-seq: DB.add_message(path) => MESSAGE, isdup
267 * Add a message to the database and return it.
269 * +isdup+ is a boolean that specifies whether the added message was a
273 notmuch_rb_database_add_message (VALUE self, VALUE pathv)
276 notmuch_status_t ret;
277 notmuch_message_t *message;
278 notmuch_database_t *db;
280 Data_Get_Notmuch_Database (self, db);
282 SafeStringValue (pathv);
283 path = RSTRING_PTR (pathv);
285 ret = notmuch_database_add_message (db, path, &message);
286 notmuch_rb_status_raise (ret);
287 return rb_assoc_new (Data_Wrap_Struct (notmuch_rb_cMessage, NULL, NULL, message),
288 (ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) ? Qtrue : Qfalse);
292 * call-seq: DB.remove_message (path) => isdup
294 * Remove a message from the database.
296 * +isdup+ is a boolean that specifies whether the removed message was a
300 notmuch_rb_database_remove_message (VALUE self, VALUE pathv)
303 notmuch_status_t ret;
304 notmuch_database_t *db;
306 Data_Get_Notmuch_Database (self, db);
308 SafeStringValue (pathv);
309 path = RSTRING_PTR (pathv);
311 ret = notmuch_database_remove_message (db, path);
312 notmuch_rb_status_raise (ret);
313 return (ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) ? Qtrue : Qfalse;
317 * call-seq: DB.find_message(id) => MESSAGE or nil
319 * Find a message by message id.
322 notmuch_rb_database_find_message (VALUE self, VALUE idv)
325 notmuch_status_t ret;
326 notmuch_database_t *db;
327 notmuch_message_t *message;
329 Data_Get_Notmuch_Database (self, db);
331 SafeStringValue (idv);
332 id = RSTRING_PTR (idv);
334 ret = notmuch_database_find_message (db, id, &message);
335 notmuch_rb_status_raise (ret);
338 return Data_Wrap_Struct (notmuch_rb_cMessage, NULL, NULL, message);
343 * call-seq: DB.find_message_by_filename(path) => MESSAGE or nil
345 * Find a message by filename.
348 notmuch_rb_database_find_message_by_filename (VALUE self, VALUE pathv)
351 notmuch_status_t ret;
352 notmuch_database_t *db;
353 notmuch_message_t *message;
355 Data_Get_Notmuch_Database (self, db);
357 SafeStringValue (pathv);
358 path = RSTRING_PTR (pathv);
360 ret = notmuch_database_find_message_by_filename (db, path, &message);
361 notmuch_rb_status_raise (ret);
364 return Data_Wrap_Struct (notmuch_rb_cMessage, NULL, NULL, message);
369 * call-seq: DB.query(query) => QUERY
371 * Retrieve a query object for the query string 'query'
374 notmuch_rb_database_query_create (VALUE self, VALUE qstrv)
377 notmuch_query_t *query;
378 notmuch_database_t *db;
380 Data_Get_Notmuch_Database (self, db);
382 SafeStringValue (qstrv);
383 qstr = RSTRING_PTR (qstrv);
385 query = notmuch_query_create (db, qstr);
387 rb_raise (notmuch_rb_eMemoryError, "Out of memory");
389 return Data_Wrap_Struct (notmuch_rb_cQuery, NULL, NULL, query);