git.notmuchmail.org Git - notmuch/blob - bindings/ruby/database.c

   1 /* The Ruby interface to the notmuch mail library
   2  *
   3  * Copyright © 2010, 2011 Ali Polatel
   4  *
   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.
   9  *
  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.
  14  *
  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/ .
  17  *
  18  * Author: Ali Polatel <alip@exherbo.org>
  19  */
  20
  21 #include "defs.h"
  22
  23 VALUE
  24 notmuch_rb_database_alloc (VALUE klass)
  25 {
  26     return Data_Wrap_Struct (klass, NULL, NULL, NULL);
  27 }
  28
  29 /*
  30  * call-seq: Notmuch::Database.new(path [, {:create => false, :mode => Notmuch::MODE_READ_ONLY}]) => DB
  31  *
  32  * Create or open a notmuch database using the given path.
  33  *
  34  * If :create is +true+, create the database instead of opening.
  35  *
  36  * The argument :mode specifies the open mode of the database.
  37  */
  38 VALUE
  39 notmuch_rb_database_initialize (int argc, VALUE *argv, VALUE self)
  40 {
  41     const char *path;
  42     int create, mode;
  43     VALUE pathv, hashv;
  44     VALUE modev;
  45     notmuch_database_t *database;
  46     notmuch_status_t ret;
  47
  48     /* Check arguments */
  49     rb_scan_args (argc, argv, "11", &pathv, &hashv);
  50
  51     SafeStringValue (pathv);
  52     path = RSTRING_PTR (pathv);
  53
  54     if (!NIL_P (hashv)) {
  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));
  58         if (NIL_P (modev))
  59             mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
  60         else if (!FIXNUM_P (modev))
  61             rb_raise (rb_eTypeError, ":mode isn't a Fixnum");
  62         else {
  63             mode = FIX2INT (modev);
  64             switch (mode) {
  65             case NOTMUCH_DATABASE_MODE_READ_ONLY:
  66             case NOTMUCH_DATABASE_MODE_READ_WRITE:
  67                 break;
  68             default:
  69                 rb_raise ( rb_eTypeError, "Invalid mode");
  70             }
  71         }
  72     } else {
  73         create = 0;
  74         mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
  75     }
  76
  77     Check_Type (self, T_DATA);
  78     if (create)
  79         ret = notmuch_database_create (path, &database);
  80     else
  81         ret = notmuch_database_open (path, mode, &database);
  82     notmuch_rb_status_raise (ret);
  83
  84     DATA_PTR (self) = database;
  85
  86     return self;
  87 }
  88
  89 /*
  90  * call-seq: Notmuch::Database.open(path [, ahash]) {|db| ...}
  91  *
  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
  94  * the block.
  95  */
  96 VALUE
  97 notmuch_rb_database_open (int argc, VALUE *argv, VALUE klass)
  98 {
  99     VALUE obj;
 100
 101     obj = rb_class_new_instance (argc, argv, klass);
 102     if (!rb_block_given_p ())
 103         return obj;
 104
 105     return rb_ensure (rb_yield, obj, notmuch_rb_database_close, obj);
 106 }
 107
 108 /*
 109  * call-seq: DB.close => nil
 110  *
 111  * Close the notmuch database.
 112  */
 113 VALUE
 114 notmuch_rb_database_close (VALUE self)
 115 {
 116     notmuch_database_t *db;
 117
 118     Data_Get_Notmuch_Database (self, db);
 119     notmuch_database_destroy (db);
 120     DATA_PTR (self) = NULL;
 121
 122     return Qnil;
 123 }
 124
 125 /*
 126  * call-seq: DB.path => String
 127  *
 128  * Return the path of the database
 129  */
 130 VALUE
 131 notmuch_rb_database_path (VALUE self)
 132 {
 133     notmuch_database_t *db;
 134
 135     Data_Get_Notmuch_Database (self, db);
 136
 137     return rb_str_new2 (notmuch_database_get_path (db));
 138 }
 139
 140 /*
 141  * call-seq: DB.version => Fixnum
 142  *
 143  * Return the version of the database
 144  */
 145 VALUE
 146 notmuch_rb_database_version (VALUE self)
 147 {
 148     notmuch_database_t *db;
 149
 150     Data_Get_Notmuch_Database (self, db);
 151
 152     return INT2FIX (notmuch_database_get_version (db));
 153 }
 154
 155 /*
 156  * call-seq: DB.needs_upgrade? => true or false
 157  *
 158  * Return the +true+ if the database needs upgrading, +false+ otherwise
 159  */
 160 VALUE
 161 notmuch_rb_database_needs_upgrade (VALUE self)
 162 {
 163     notmuch_database_t *db;
 164
 165     Data_Get_Notmuch_Database (self, db);
 166
 167     return notmuch_database_needs_upgrade (db) ? Qtrue : Qfalse;
 168 }
 169
 170 static void
 171 notmuch_rb_upgrade_notify (void *closure, double progress)
 172 {
 173     VALUE *block = (VALUE *) closure;
 174     rb_funcall (*block, ID_call, 1, rb_float_new (progress));
 175 }
 176
 177 /*
 178  * call-seq: DB.upgrade! [{|progress| block }] => nil
 179  *
 180  * Upgrade the database.
 181  *
 182  * If a block is given the block is called with a progress indicator as a
 183  * floating point value in the range of [0.0..1.0].
 184  */
 185 VALUE
 186 notmuch_rb_database_upgrade (VALUE self)
 187 {
 188     notmuch_status_t ret;
 189     void (*pnotify) (void *closure, double progress);
 190     notmuch_database_t *db;
 191     VALUE block;
 192
 193     Data_Get_Notmuch_Database (self, db);
 194
 195     if (rb_block_given_p ()) {
 196         pnotify = notmuch_rb_upgrade_notify;
 197         block = rb_block_proc ();
 198     }
 199     else
 200         pnotify = NULL;
 201
 202     ret = notmuch_database_upgrade (db, pnotify, pnotify ? &block : NULL);
 203     notmuch_rb_status_raise (ret);
 204
 205     return Qtrue;
 206 }
 207
 208 /*
 209  * call-seq: DB.begin_atomic => nil
 210  *
 211  * Begin an atomic database operation.
 212  */
 213 VALUE
 214 notmuch_rb_database_begin_atomic (VALUE self)
 215 {
 216     notmuch_status_t ret;
 217     notmuch_database_t *db;
 218
 219     Data_Get_Notmuch_Database (self, db);
 220
 221     ret = notmuch_database_begin_atomic (db);
 222     notmuch_rb_status_raise (ret);
 223
 224     return Qtrue;
 225 }
 226
 227 /*
 228  * call-seq: DB.end_atomic => nil
 229  *
 230  * Indicate the end of an atomic database operation.
 231  */
 232 VALUE
 233 notmuch_rb_database_end_atomic (VALUE self)
 234 {
 235     notmuch_status_t ret;
 236     notmuch_database_t *db;
 237
 238     Data_Get_Notmuch_Database (self, db);
 239
 240     ret = notmuch_database_end_atomic (db);
 241     notmuch_rb_status_raise (ret);
 242
 243     return Qtrue;
 244 }
 245
 246 /*
 247  * call-seq: DB.get_directory(path) => DIR
 248  *
 249  * Retrieve a directory object from the database for 'path'
 250  */
 251 VALUE
 252 notmuch_rb_database_get_directory (VALUE self, VALUE pathv)
 253 {
 254     const char *path;
 255     notmuch_directory_t *dir;
 256     notmuch_database_t *db;
 257
 258     Data_Get_Notmuch_Database (self, db);
 259
 260     SafeStringValue (pathv);
 261     path = RSTRING_PTR (pathv);
 262
 263     dir = notmuch_database_get_directory (db, path);
 264     if (!dir)
 265         rb_raise (notmuch_rb_eXapianError, "Xapian exception");
 266
 267     return Data_Wrap_Struct (notmuch_rb_cDirectory, NULL, NULL, dir);
 268 }
 269
 270 /*
 271  * call-seq: DB.add_message(path) => MESSAGE, isdup
 272  *
 273  * Add a message to the database and return it.
 274  *
 275  * +isdup+ is a boolean that specifies whether the added message was a
 276  * duplicate.
 277  */
 278 VALUE
 279 notmuch_rb_database_add_message (VALUE self, VALUE pathv)
 280 {
 281     const char *path;
 282     notmuch_status_t ret;
 283     notmuch_message_t *message;
 284     notmuch_database_t *db;
 285
 286     Data_Get_Notmuch_Database (self, db);
 287
 288     SafeStringValue (pathv);
 289     path = RSTRING_PTR (pathv);
 290
 291     ret = notmuch_database_add_message (db, path, &message);
 292     notmuch_rb_status_raise (ret);
 293     return rb_assoc_new (Data_Wrap_Struct (notmuch_rb_cMessage, NULL, NULL, message),
 294         (ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) ? Qtrue : Qfalse);
 295 }
 296
 297 /*
 298  * call-seq: DB.remove_message (path) => isdup
 299  *
 300  * Remove a message from the database.
 301  *
 302  * +isdup+ is a boolean that specifies whether the removed message was a
 303  * duplicate.
 304  */
 305 VALUE
 306 notmuch_rb_database_remove_message (VALUE self, VALUE pathv)
 307 {
 308     const char *path;
 309     notmuch_status_t ret;
 310     notmuch_database_t *db;
 311
 312     Data_Get_Notmuch_Database (self, db);
 313
 314     SafeStringValue (pathv);
 315     path = RSTRING_PTR (pathv);
 316
 317     ret = notmuch_database_remove_message (db, path);
 318     notmuch_rb_status_raise (ret);
 319     return (ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) ? Qtrue : Qfalse;
 320 }
 321
 322 /*
 323  * call-seq: DB.find_message(id) => MESSAGE or nil
 324  *
 325  * Find a message by message id.
 326  */
 327 VALUE
 328 notmuch_rb_database_find_message (VALUE self, VALUE idv)
 329 {
 330     const char *id;
 331     notmuch_status_t ret;
 332     notmuch_database_t *db;
 333     notmuch_message_t *message;
 334
 335     Data_Get_Notmuch_Database (self, db);
 336
 337     SafeStringValue (idv);
 338     id = RSTRING_PTR (idv);
 339
 340     ret = notmuch_database_find_message (db, id, &message);
 341     notmuch_rb_status_raise (ret);
 342
 343     if (message)
 344         return Data_Wrap_Struct (notmuch_rb_cMessage, NULL, NULL, message);
 345     return Qnil;
 346 }
 347
 348 /*
 349  * call-seq: DB.find_message_by_filename(path) => MESSAGE or nil
 350  *
 351  * Find a message by filename.
 352  */
 353 VALUE
 354 notmuch_rb_database_find_message_by_filename (VALUE self, VALUE pathv)
 355 {
 356     const char *path;
 357     notmuch_status_t ret;
 358     notmuch_database_t *db;
 359     notmuch_message_t *message;
 360
 361     Data_Get_Notmuch_Database (self, db);
 362
 363     SafeStringValue (pathv);
 364     path = RSTRING_PTR (pathv);
 365
 366     ret = notmuch_database_find_message_by_filename (db, path, &message);
 367     notmuch_rb_status_raise (ret);
 368
 369     if (message)
 370         return Data_Wrap_Struct (notmuch_rb_cMessage, NULL, NULL, message);
 371     return Qnil;
 372 }
 373
 374 /*
 375  * call-seq: DB.query(query) => QUERY
 376  *
 377  * Retrieve a query object for the query string 'query'
 378  */
 379 VALUE
 380 notmuch_rb_database_query_create (VALUE self, VALUE qstrv)
 381 {
 382     const char *qstr;
 383     notmuch_query_t *query;
 384     notmuch_database_t *db;
 385
 386     Data_Get_Notmuch_Database (self, db);
 387
 388     SafeStringValue (qstrv);
 389     qstr = RSTRING_PTR (qstrv);
 390
 391     query = notmuch_query_create (db, qstr);
 392     if (!query)
 393         rb_raise (notmuch_rb_eMemoryError, "Out of memory");
 394
 395     return Data_Wrap_Struct (notmuch_rb_cQuery, NULL, NULL, query);
 396 }