lib: add NOTMUCH_STATUS_CLOSED_DATABASE, use in _n_d_ensure_writable

In order for a database to actually be writeable, it must be the case that it
is open, not just the correct type of Xapian object. By explicitely
checking, we are able to provide better error reporting, in particular
for the previously broken test in T566-lib-message.
This commit is contained in:
David Bremner 2022-05-25 07:51:16 -03:00
parent 7e654e2a45
commit 3f27cce71f
7 changed files with 26 additions and 34 deletions

View file

@ -55,6 +55,7 @@ ffibuilder.cdef(
NOTMUCH_STATUS_DATABASE_EXISTS,
NOTMUCH_STATUS_BAD_QUERY_SYNTAX,
NOTMUCH_STATUS_NO_MAIL_ROOT,
NOTMUCH_STATUS_CLOSED_DATABASE,
NOTMUCH_STATUS_LAST_STATUS
} notmuch_status_t;
typedef enum {

View file

@ -476,6 +476,11 @@ _notmuch_database_ensure_writable (notmuch_database_t *notmuch)
return NOTMUCH_STATUS_READ_ONLY_DATABASE;
}
if (! notmuch->open) {
_notmuch_database_log (notmuch, "Cannot write to a closed database.\n");
return NOTMUCH_STATUS_CLOSED_DATABASE;
}
return NOTMUCH_STATUS_SUCCESS;
}
@ -852,9 +857,8 @@ notmuch_database_upgrade (notmuch_database_t *notmuch,
notmuch_query_t *query = NULL;
unsigned int count = 0, total = 0;
status = _notmuch_database_ensure_writable (notmuch);
if (status)
return status;
if (_notmuch_database_mode (notmuch) != NOTMUCH_DATABASE_MODE_READ_WRITE)
return NOTMUCH_STATUS_READ_ONLY_DATABASE;
db = notmuch->writable_xapian_db;

View file

@ -146,6 +146,7 @@ typedef enum {
NOTMUCH_PRIVATE_STATUS_DATABASE_EXISTS = NOTMUCH_STATUS_DATABASE_EXISTS,
NOTMUCH_PRIVATE_STATUS_NO_MAIL_ROOT = NOTMUCH_STATUS_NO_MAIL_ROOT,
NOTMUCH_PRIVATE_STATUS_BAD_QUERY_SYNTAX = NOTMUCH_STATUS_BAD_QUERY_SYNTAX,
NOTMUCH_PRIVATE_STATUS_CLOSED_DATABASE = NOTMUCH_STATUS_CLOSED_DATABASE,
/* Then add our own private values. */
NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG = NOTMUCH_STATUS_LAST_STATUS,

View file

@ -228,6 +228,10 @@ typedef enum {
* No mail root could be deduced from parameters and environment
*/
NOTMUCH_STATUS_NO_MAIL_ROOT,
/**
* Database is not fully opened, or has been closed
*/
NOTMUCH_STATUS_CLOSED_DATABASE,
/**
* Not an actual status value. Just a way to find out how many
* valid status values there are.

View file

@ -243,14 +243,14 @@ cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
const char *path = talloc_asprintf(db, "%s/01:2,", argv[1]);
EXPECT0(notmuch_database_close (db));
stat = notmuch_database_index_file (db, path, NULL, &msg);
printf ("%d\n", stat == NOTMUCH_STATUS_XAPIAN_EXCEPTION);
printf ("%d\n", stat == NOTMUCH_STATUS_CLOSED_DATABASE);
}
EOF
cat <<EOF > EXPECTED
== stdout ==
1
== stderr ==
A Xapian exception occurred finding message: Database has been closed.
Cannot write to a closed database.
EOF
test_expect_equal_file EXPECTED OUTPUT
@ -358,14 +358,14 @@ cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
{
EXPECT0(notmuch_database_close (db));
stat = notmuch_database_set_config (db, "foo", "bar");
printf("%d\n", stat == NOTMUCH_STATUS_XAPIAN_EXCEPTION);
printf("%d\n", stat == NOTMUCH_STATUS_CLOSED_DATABASE);
}
EOF
cat <<EOF > EXPECTED
== stdout ==
1
== stderr ==
Error: A Xapian exception occurred setting metadata: Database has been closed
Cannot write to a closed database.
EOF
test_expect_equal_file EXPECTED OUTPUT

View file

@ -79,14 +79,14 @@ test_begin_subtest "delete directory document for a closed db"
cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
{
stat = notmuch_directory_delete (dir);
printf ("%d\n", stat == NOTMUCH_STATUS_XAPIAN_EXCEPTION);
printf ("%d\n", stat == NOTMUCH_STATUS_CLOSED_DATABASE);
}
EOF
cat <<EOF > EXPECTED
== stdout ==
1
== stderr ==
A Xapian exception occurred deleting directory entry: Database has been closed.
Cannot write to a closed database.
EOF
test_expect_equal_file EXPECTED OUTPUT
restore_database
@ -97,32 +97,14 @@ cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
{
time_t stamp = notmuch_directory_get_mtime (dir);
stat = notmuch_directory_set_mtime (dir, stamp);
printf ("%d\n", stat == NOTMUCH_STATUS_XAPIAN_EXCEPTION);
printf ("%d\n", stat == NOTMUCH_STATUS_CLOSED_DATABASE);
}
EOF
cat <<EOF > EXPECTED
== stdout ==
1
== stderr ==
A Xapian exception occurred setting directory mtime: Database has been closed.
EOF
test_expect_equal_file EXPECTED OUTPUT
restore_database
backup_database
test_begin_subtest "get/set mtime of directory for a closed db"
cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
{
time_t stamp = notmuch_directory_get_mtime (dir);
stat = notmuch_directory_set_mtime (dir, stamp);
printf ("%d\n", stat == NOTMUCH_STATUS_XAPIAN_EXCEPTION);
}
EOF
cat <<EOF > EXPECTED
== stdout ==
1
== stderr ==
A Xapian exception occurred setting directory mtime: Database has been closed.
Cannot write to a closed database.
EOF
test_expect_equal_file EXPECTED OUTPUT
restore_database

View file

@ -231,7 +231,7 @@ cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
{
notmuch_status_t status;
status = notmuch_message_add_tag (message, "boom");
printf("%d\n%d\n", message != NULL, status == NOTMUCH_STATUS_XAPIAN_EXCEPTION);
printf("%d\n%d\n", message != NULL, status == NOTMUCH_STATUS_CLOSED_DATABASE);
}
EOF
cat <<EOF > EXPECTED
@ -247,7 +247,7 @@ cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
{
notmuch_status_t status;
status = notmuch_message_remove_tag (message, "boom");
printf("%d\n%d\n", message != NULL, status == NOTMUCH_STATUS_XAPIAN_EXCEPTION);
printf("%d\n%d\n", message != NULL, status == NOTMUCH_STATUS_CLOSED_DATABASE);
}
EOF
cat <<EOF > EXPECTED
@ -427,7 +427,7 @@ cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
{
notmuch_status_t status;
status = notmuch_message_remove_all_tags (message);
printf("%d\n%d\n", message != NULL, status == NOTMUCH_STATUS_XAPIAN_EXCEPTION);
printf("%d\n%d\n", message != NULL, status == NOTMUCH_STATUS_CLOSED_DATABASE);
}
EOF
cat <<EOF > EXPECTED
@ -443,7 +443,7 @@ cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
{
notmuch_status_t status;
status = notmuch_message_freeze (message);
printf("%d\n%d\n", message != NULL, status == NOTMUCH_STATUS_SUCCESS);
printf("%d\n%d\n", message != NULL, status == NOTMUCH_STATUS_CLOSED_DATABASE);
}
EOF
cat <<EOF > EXPECTED
@ -459,7 +459,7 @@ cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
{
notmuch_status_t status;
status = notmuch_message_thaw (message);
printf("%d\n%d\n", message != NULL, status == NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW);
printf("%d\n%d\n", message != NULL, status == NOTMUCH_STATUS_CLOSED_DATABASE);
}
EOF
cat <<EOF > EXPECTED