From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp1 ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms11 with LMTPS id INitCV/aQGAobAAA0tVLHw (envelope-from ) for ; Thu, 04 Mar 2021 13:02:23 +0000 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp1 with LMTPS id eJ9WBV/aQGCWbAAAbx9fmQ (envelope-from ) for ; Thu, 04 Mar 2021 13:02:23 +0000 Received: from mail.notmuchmail.org (nmbug.tethera.net [IPv6:2607:5300:201:3100::1657]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 4461115F5F for ; Thu, 4 Mar 2021 14:02:22 +0100 (CET) Received: from nmbug.tethera.net (localhost [127.0.0.1]) by mail.notmuchmail.org (Postfix) with ESMTP id 1E71626C54; Thu, 4 Mar 2021 08:01:56 -0500 (EST) Received: from fethera.tethera.net (fethera.tethera.net [198.245.60.197]) by mail.notmuchmail.org (Postfix) with ESMTP id 75FF41FADE for ; Thu, 4 Mar 2021 08:01:49 -0500 (EST) Received: by fethera.tethera.net (Postfix, from userid 1001) id 702A75FA96; Thu, 4 Mar 2021 08:01:49 -0500 (EST) Received: (nullmailer pid 4047169 invoked by uid 1000); Thu, 04 Mar 2021 13:01:45 -0000 From: David Bremner To: notmuch@notmuchmail.org Cc: David Bremner Subject: [PATCH 04/27] lib: provide notmuch_database_load_config Date: Thu, 4 Mar 2021 09:01:16 -0400 Message-Id: <20210304130139.4046183-5-david@tethera.net> X-Mailer: git-send-email 2.30.1 In-Reply-To: <20210304130139.4046183-1-david@tethera.net> References: <20210304130139.4046183-1-david@tethera.net> MIME-Version: 1.0 Message-ID-Hash: QGCIIE46BVNE5AOUJG6DW242B6VCNK7J X-Message-ID-Hash: QGCIIE46BVNE5AOUJG6DW242B6VCNK7J X-MailFrom: bremner@tethera.net X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-notmuch.notmuchmail.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; suspicious-header X-Mailman-Version: 3.2.1 Precedence: list List-Id: "Use and development of the notmuch mail system." List-Help: List-Post: List-Subscribe: List-Unsubscribe: Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Migadu-Flow: FLOW_IN ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1614862942; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=jFRARYjARByzizRojU+MWKsnnrruUYRvGsN7JyDaCOQ=; b=A/PQGU6Pmva317DcNM1DJ84m/uOgQK+5TkWtBnVnx3K5ioBhBVnFS4BMIOwhSXDo3DSROq zN8Kx4Km4swFVni4JvPmSlFW/h+y8LAFD41ubbDpVu3m2X/2bbvIYxhDtrPkG3wm655swN M4BZZv7hp5rkk4LrwqpXO2CWNrW1I6Wb4SBlJru37zFFz4Db807hc7T3jdpQodEPPGwso2 2hiDVPBA2pstRsUDgQyEk0WkKVXu5iS/xBp2vlYMbDz6VK3eRMzdp7CE/Nu8IivRqneflA P5ToTq4W1ZHVPBAqLPholCtYsFYahlmSu5McAr9voTko5s1Dy1miK4Gxfvy4TA== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1614862942; a=rsa-sha256; cv=none; b=hHx3ULCDNkIZUmFi781B6qKD08afJT5GH/GF96tvSjoAJ95COIEMIIKOpLHEaS4KQ6OIZO 6xLn7MDSjgVGT5rL2N+8bpMtLNkGmM5uj7UgdWLlFWV4dLi6T90D9XnXDb7HIFYTo6Sf2r 6FhI12nUoDhRFEFS6vzonUbWNdR/zBbH3yec2dSZNULqJys1Zef3ogAUOWZ5UY0xRCbIRJ AwHs+Y9LpzIB9Hs2GlhJ4YT75uB3SKc/rUXVCqxgIsIl4rYWmV/Dwg2ucaNlPE98LeHj6r Nxk8knxfDejDO9RcAqn2QbHSTSrirmNQ9pdfePrHssXa+xowQLIGQXKYak1mKQ== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=none; dmarc=none; spf=pass (aspmx1.migadu.com: domain of notmuch-bounces@notmuchmail.org designates 2607:5300:201:3100::1657 as permitted sender) smtp.mailfrom=notmuch-bounces@notmuchmail.org X-Migadu-Spam-Score: -0.80 Authentication-Results: aspmx1.migadu.com; dkim=none; dmarc=none; spf=pass (aspmx1.migadu.com: domain of notmuch-bounces@notmuchmail.org designates 2607:5300:201:3100::1657 as permitted sender) smtp.mailfrom=notmuch-bounces@notmuchmail.org X-Migadu-Queue-Id: 4461115F5F X-Spam-Score: -0.80 X-Migadu-Scanner: scn0.migadu.com X-TUID: cP1lOXxzKSKp This is mainly targetted at notmuch-config.c, or similar applications that don't necessarily need both a configuration file and a database to exist. --- lib/notmuch.h | 27 ++++++ lib/open.cc | 96 ++++++++++++++++++++++ test/T590-libconfig.sh | 182 ++++++++++++++++++++++++++++++++++++++++- 3 files changed, 302 insertions(+), 3 deletions(-) diff --git a/lib/notmuch.h b/lib/notmuch.h index 5e4f1dac..8d4a4716 100644 --- a/lib/notmuch.h +++ b/lib/notmuch.h @@ -442,6 +442,33 @@ notmuch_database_open_with_config (const char *database_path, const char *profile, notmuch_database_t **database, char **error_message); + + +/** + * Loads configuration from config file, database, and/or defaults + * + * For description of arguments, @see notmuch_database_open_with_config + * + * @retval NOTMUCH_STATUS_SUCCESS: Successfully loaded (some) configuration. + * + * @retval NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory. + * + * @retval NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the + * database or config file (such as permission denied, or file not found, + * etc.) + * + * @retval NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred. + * + * @since libnotmuch 5.4 (notmuch 0.32) + */ + +notmuch_status_t +notmuch_database_load_config (const char *database_path, + const char *config_path, + const char *profile, + notmuch_database_t **database, + char **error_message); + /** * Create a new notmuch database located at 'database_path', using * configuration in 'config_path'. diff --git a/lib/open.cc b/lib/open.cc index e1ad957f..58385592 100644 --- a/lib/open.cc +++ b/lib/open.cc @@ -709,3 +709,99 @@ notmuch_database_reopen (notmuch_database_t *notmuch, notmuch->open = true; return NOTMUCH_STATUS_SUCCESS; } + +notmuch_status_t +_maybe_load_config_from_database (notmuch_database_t *notmuch, + GKeyFile *key_file, + const char *database_path, + const char *profile) +{ + char *message; /* ignored */ + + if (_db_dir_exists (database_path, &message)) + return NOTMUCH_STATUS_SUCCESS; + + _set_database_path (notmuch, database_path); + + if (_notmuch_choose_xapian_path (notmuch, database_path, ¬much->xapian_path, &message)) + return NOTMUCH_STATUS_SUCCESS; + + (void) _finish_open (notmuch, profile, NOTMUCH_DATABASE_MODE_READ_ONLY, key_file, &message); + + return NOTMUCH_STATUS_SUCCESS; +} + +notmuch_status_t +notmuch_database_load_config (const char *database_path, + const char *config_path, + const char *profile, + notmuch_database_t **database, + char **status_string) +{ + notmuch_status_t status = NOTMUCH_STATUS_SUCCESS, warning = NOTMUCH_STATUS_SUCCESS; + void *local = talloc_new (NULL); + notmuch_database_t *notmuch = NULL; + char *message = NULL; + GKeyFile *key_file = NULL; + bool split = false; + + _init_libs (); + + notmuch = _alloc_notmuch (); + if (!notmuch) { + status = NOTMUCH_STATUS_OUT_OF_MEMORY; + goto DONE; + } + + status =_load_key_file (config_path, profile, &key_file); + switch (status) { + case NOTMUCH_STATUS_SUCCESS: + case NOTMUCH_STATUS_NO_CONFIG: + warning = status; + break; + default: + message = strdup ("Error: cannot load config file.\n"); + goto DONE; + } + + status = _choose_database_path (local, profile, key_file, + &database_path, &split, &message); + switch (status) { + /* weirdly NULL_POINTER is what is returned if we fail to find + * a database */ + case NOTMUCH_STATUS_NULL_POINTER: + case NOTMUCH_STATUS_SUCCESS: + break; + default: + goto DONE; + } + + if (database_path) { + status = _maybe_load_config_from_database (notmuch, key_file, database_path, profile); + if (status) + goto DONE; + } + + if (key_file) { + status = _notmuch_config_load_from_file (notmuch, key_file); + if (status) + goto DONE; + } + status = _notmuch_config_load_defaults (notmuch); + if (status) + goto DONE; + + DONE: + talloc_free (local); + + if (status_string) + *status_string = message; + + if (database) + *database = notmuch; + + if (status) + return status; + else + return warning; +} diff --git a/test/T590-libconfig.sh b/test/T590-libconfig.sh index 310668a9..dc9964cf 100755 --- a/test/T590-libconfig.sh +++ b/test/T590-libconfig.sh @@ -538,7 +538,7 @@ cat c_head - c_tail <<'EOF' | test_C %NULL% '' %NULL% printf("test.key2 = %s\n", val); } EOF -NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG} +export NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG} unset NOTMUCH_DATABASE cat <<'EOF' >EXPECTED == stdout == @@ -549,7 +549,7 @@ EOF test_expect_equal_file EXPECTED OUTPUT test_begin_subtest "NOTMUCH_DATABASE overrides config" -old_path=$(notmuch config get database.path) +cp notmuch-config notmuch-config.bak notmuch config set database.path /nonexistent export NOTMUCH_DATABASE=${MAIL_DIR} cat c_head - c_tail <<'EOF' | test_C %NULL% '' %NULL% @@ -568,8 +568,184 @@ test.key1 = testvalue1 test.key2 = testvalue2 == stderr == EOF -notmuch config set database.path "${old_path}" +cp notmuch-config.bak notmuch-config +test_expect_equal_file EXPECTED OUTPUT + +cat < c_head2 +#include +#include +#include + +int main (int argc, char** argv) +{ + notmuch_database_t *db; + char *val; + notmuch_status_t stat; + char *msg = NULL; + + for (int i = 1; i < argc; i++) + if (strcmp (argv[i], "%NULL%") == 0) argv[i] = NULL; + + stat = notmuch_database_load_config (argv[1], + argv[2], + argv[3], + &db, + &msg); + if (stat != NOTMUCH_STATUS_SUCCESS && stat != NOTMUCH_STATUS_NO_CONFIG) { + fprintf (stderr, "error opening database\n%d: %s\n%s\n", stat, + notmuch_status_to_string (stat), msg ? msg : ""); + exit (1); + } +EOF + + +test_begin_subtest "notmuch_database_get_config (ndlc)" +echo NOTMUCH_CONFIG=$NOTMUCH_CONFIG +echo NOTMUCH_PROFILE=$NOTMUCH_PROFILE +echo HOME=$HOME +cat c_head2 - c_tail <<'EOF' | test_C ${MAIL_DIR} %NULL% %NULL% +{ + EXPECT0(notmuch_database_get_config (db, "test.key1", &val)); + printf("test.key1 = %s\n", val); + EXPECT0(notmuch_database_get_config (db, "test.key2", &val)); + printf("test.key2 = %s\n", val); +} +EOF +cat <<'EOF' >EXPECTED +== stdout == +test.key1 = testvalue1 +test.key2 = testvalue2 +== stderr == +EOF +test_expect_equal_file EXPECTED OUTPUT + + +test_begin_subtest "notmuch_database_get_config_list: all pairs (ndlc)" +cat c_head2 - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG} %NULL% +{ + notmuch_config_list_t *list; + EXPECT0(notmuch_database_get_config_list (db, "", &list)); + for (; notmuch_config_list_valid (list); notmuch_config_list_move_to_next (list)) { + printf("%s %s\n", notmuch_config_list_key (list), notmuch_config_list_value(list)); + } + notmuch_config_list_destroy (list); +} +EOF +cat <<'EOF' >EXPECTED +== stdout == +aaabefore beforeval +key with spaces value, with, spaces! +test.key1 testvalue1 +test.key2 testvalue2 +zzzafter afterval +== stderr == +EOF +test_expect_equal_file EXPECTED OUTPUT + +test_begin_subtest "notmuch_database_get_config_list: one prefix (ndlc)" +cat c_head2 - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG} %NULL% +{ + notmuch_config_list_t *list; + EXPECT0(notmuch_database_get_config_list (db, "test.key", &list)); + for (; notmuch_config_list_valid (list); notmuch_config_list_move_to_next (list)) { + printf("%s %s\n", notmuch_config_list_key (list), notmuch_config_list_value(list)); + } + notmuch_config_list_destroy (list); +} +EOF +cat <<'EOF' >EXPECTED +== stdout == +test.key1 testvalue1 +test.key2 testvalue2 +== stderr == +EOF test_expect_equal_file EXPECTED OUTPUT +test_begin_subtest "list by keys (ndlc)" +notmuch config set search.exclude_tags "foo;bar;fub" +notmuch config set new.ignore "sekrit_junk" +cat c_head2 - c_tail <<'EOF' | test_C ${MAIL_DIR} %NULL% %NULL% +{ + notmuch_config_key_t key; + for (key = NOTMUCH_CONFIG_FIRST; + key < NOTMUCH_CONFIG_LAST; + key = (notmuch_config_key_t)(key + 1)) { + const char *val = notmuch_config_get (db, key); + printf("%s\n", val ? val : "NULL" ); + } +} +EOF +cat <<'EOF' >EXPECTED +== stdout == +MAIL_DIR +MAIL_DIR +MAIL_DIR/.notmuch/hooks +MAIL_DIR/.notmuch/backups +foo;bar;fub +unread;inbox; +sekrit_junk +true +test_suite@notmuchmail.org +test_suite_other@notmuchmail.org;test_suite@otherdomain.org +Notmuch Test Suite +== stderr == +EOF +test_expect_equal_file EXPECTED OUTPUT + +test_begin_subtest "load default values (ndlc, nonexistent config)" +cat c_head2 - c_tail <<'EOF' | test_C ${MAIL_DIR} /nonexistent %NULL% +{ + notmuch_config_key_t key; + for (key = NOTMUCH_CONFIG_FIRST; + key < NOTMUCH_CONFIG_LAST; + key = (notmuch_config_key_t)(key + 1)) { + const char *val = notmuch_config_get (db, key); + printf("%s\n", val ? val : "NULL" ); + } +} +EOF +cat <<'EOF' >EXPECTED +== stdout == +MAIL_DIR +MAIL_DIR +MAIL_DIR/.notmuch/hooks +MAIL_DIR/.notmuch/backups + +inbox;unread +NULL +true +NULL +NULL +NULL +== stderr == +EOF +test_expect_equal_file EXPECTED OUTPUT + +backup_database +test_begin_subtest "override config from \${HOME}/.notmuch-config (ndlc)" +ovconfig=${HOME}/.notmuch-config +cp ${NOTMUCH_CONFIG} ${ovconfig} +old_NOTMUCH_CONFIG=${NOTMUCH_CONFIG} +unset NOTMUCH_CONFIG +notmuch --config=${ovconfig} config set test.key1 overridden-home +cat c_head2 - c_tail <<'EOF' | test_C ${MAIL_DIR} %NULL% %NULL% +{ + EXPECT0(notmuch_database_get_config (db, "test.key1", &val)); + printf("test.key1 = %s\n", val); + EXPECT0(notmuch_database_get_config (db, "test.key2", &val)); + printf("test.key2 = %s\n", val); +} +EOF +rm -f ${ovconfig} +NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG} +cat <<'EOF' >EXPECTED +== stdout == +test.key1 = overridden-home +test.key2 = testvalue2 +== stderr == +EOF +test_expect_equal_file EXPECTED OUTPUT +restore_database + test_done -- 2.30.1