NeoMutt  2023-05-17-16-g61469c
Teaching an old dog new tricks
DOXYGEN
config.c
Go to the documentation of this file.
1
29#include "config.h"
30#include <stddef.h>
31#include <config/lib.h>
32#include <stdbool.h>
33#include <stdint.h>
34#include "mutt/lib.h"
35#include "notmuch/private.h"
36#include "notmuch/query.h"
37
38#ifdef USE_NOTMUCH
45static bool is_valid_notmuch_url(const char *url)
46{
47 return mutt_istr_startswith(url, NmUrlProtocol) && (url[NmUrlProtocolLen] == '/');
48}
49#endif
50
54static int nm_default_url_validator(const struct ConfigSet *cs, const struct ConfigDef *cdef,
55 intptr_t value, struct Buffer *err)
56{
57#ifdef USE_NOTMUCH
58 const char *url = (const char *) value;
59 if (!is_valid_notmuch_url(url))
60 {
61 buf_printf(err, _("nm_default_url must be: notmuch://<absolute path> . Current: %s"), url);
62 return CSR_ERR_INVALID;
63 }
64#endif
65 return CSR_SUCCESS;
66}
67
81 const struct ConfigDef *cdef,
82 intptr_t value, struct Buffer *err)
83{
84#ifdef USE_NOTMUCH
85 const char *timebase = (const char *) value;
86 if (!nm_query_window_check_timebase(timebase))
87 {
89 // L10N: The values 'hour', 'day', 'week', 'month', 'year' are literal.
90 // They should not be translated.
91 err, _("Invalid nm_query_window_timebase value (valid values are: "
92 "hour, day, week, month, year)"));
93 return CSR_ERR_INVALID;
94 }
95#endif
96 return CSR_SUCCESS;
97}
98
102static struct ConfigDef NotmuchVars[] = {
103 // clang-format off
104 { "nm_config_file", DT_PATH|DT_PATH_FILE, IP "auto", 0, NULL,
105 "(notmuch) Configuration file for notmuch. Use 'auto' to detect configuration."
106 },
107 { "nm_config_profile", DT_STRING, 0, 0, NULL,
108 "(notmuch) Configuration profile for notmuch."
109 },
110 { "nm_db_limit", DT_NUMBER|DT_NOT_NEGATIVE, 0, 0, NULL,
111 "(notmuch) Default limit for Notmuch queries"
112 },
113 { "nm_default_url", DT_STRING, 0, 0, nm_default_url_validator,
114 "(notmuch) Path to the Notmuch database"
115 },
116 { "nm_exclude_tags", DT_STRING, 0, 0, NULL,
117 "(notmuch) Exclude messages with these tags"
118 },
119 { "nm_flagged_tag", DT_STRING, IP "flagged", 0, NULL,
120 "(notmuch) Tag to use for flagged messages"
121 },
122 { "nm_open_timeout", DT_NUMBER|DT_NOT_NEGATIVE, 5, 0, NULL,
123 "(notmuch) Database timeout"
124 },
125 { "nm_query_type", DT_STRING, IP "messages", 0, NULL,
126 "(notmuch) Default query type: 'threads' or 'messages'"
127 },
128 { "nm_query_window_current_position", DT_NUMBER, 0, 0, NULL,
129 "(notmuch) Position of current search window"
130 },
131 { "nm_query_window_current_search", DT_STRING, 0, 0, NULL,
132 "(notmuch) Current search parameters"
133 },
134 { "nm_query_window_duration", DT_NUMBER|DT_NOT_NEGATIVE, 0, 0, NULL,
135 "(notmuch) Time duration of the current search window"
136 },
137 { "nm_query_window_enable", DT_BOOL, false, 0, NULL,
138 "(notmuch) Enable query windows"
139 },
140 { "nm_query_window_or_terms", DT_STRING, 0, 0, NULL,
141 "(notmuch) Additional notmuch search terms for messages to be shown regardless of date"
142 },
143 { "nm_query_window_timebase", DT_STRING, IP "week", 0, nm_query_window_timebase_validator,
144 "(notmuch) Units for the time duration"
145 },
146 { "nm_record_tags", DT_STRING, 0, 0, NULL,
147 "(notmuch) Tags to apply to the 'record' mailbox (sent mail)"
148 },
149 { "nm_replied_tag", DT_STRING, IP "replied", 0, NULL,
150 "(notmuch) Tag to use for replied messages"
151 },
152 { "nm_unread_tag", DT_STRING, IP "unread", 0, NULL,
153 "(notmuch) Tag to use for unread messages"
154 },
155 { "virtual_spool_file", DT_BOOL, false, 0, NULL,
156 "(notmuch) Use the first virtual mailbox as a spool file"
157 },
158
159 { "vfolder_format", DT_DEPRECATED|DT_STRING, 0, IP "2018-11-01" },
160
161 { "nm_default_uri", DT_SYNONYM, IP "nm_default_url", IP "2021-02-11" },
162 { "virtual_spoolfile", DT_SYNONYM, IP "virtual_spool_file", IP "2021-02-11" },
163 { NULL },
164 // clang-format on
165};
166
171{
172 bool rc = false;
173
174#if defined(USE_NOTMUCH)
176#endif
177
178 return rc;
179}
int buf_printf(struct Buffer *buf, const char *fmt,...)
Format a string overwriting a Buffer.
Definition: buffer.c:171
Convenience wrapper for the config headers.
bool cs_register_variables(const struct ConfigSet *cs, struct ConfigDef vars[], uint32_t flags)
Register a set of config items.
Definition: set.c:279
#define CSR_ERR_INVALID
Value hasn't been set.
Definition: set.h:38
#define CSR_SUCCESS
Action completed successfully.
Definition: set.h:35
#define IP
Definition: set.h:54
static int nm_query_window_timebase_validator(const struct ConfigSet *cs, const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
Validate $nm_query_window_timebase - Implements ConfigDef::validator() -.
Definition: config.c:80
static int nm_default_url_validator(const struct ConfigSet *cs, const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
Ensure nm_default_url is of the form notmuch://[absolute path] - Implements ConfigDef::validator() -.
Definition: config.c:54
bool config_init_notmuch(struct ConfigSet *cs)
Register notmuch config variables - Implements module_init_config_t -.
Definition: config.c:170
Convenience wrapper for the library headers.
#define _(a)
Definition: message.h:28
size_t mutt_istr_startswith(const char *str, const char *prefix)
Check whether a string starts with a prefix, ignoring case.
Definition: string.c:240
static bool is_valid_notmuch_url(const char *url)
Checks that a URL is in required form.
Definition: config.c:45
static struct ConfigDef NotmuchVars[]
Config definitions for the Notmuch library.
Definition: config.c:102
Notmuch private types.
const int NmUrlProtocolLen
Length of NmUrlProtocol string.
Definition: notmuch.c:98
const char NmUrlProtocol[]
Protocol string for Notmuch URLs.
Definition: notmuch.c:96
bool nm_query_window_check_timebase(const char *timebase)
Checks if a given timebase string is valid.
Definition: query.c:148
Notmuch query functions.
String manipulation buffer.
Definition: buffer.h:34
Definition: set.h:64
Container for lots of config items.
Definition: set.h:252
#define DT_BOOL
boolean option
Definition: types.h:30
#define DT_DEPRECATED
Config item shouldn't be used any more.
Definition: types.h:77
#define DT_PATH_FILE
Path is a file.
Definition: types.h:57
#define DT_PATH
a path to a file/directory
Definition: types.h:36
#define DT_STRING
a string
Definition: types.h:41
#define DT_SYNONYM
synonym for another variable
Definition: types.h:42
#define DT_NO_FLAGS
No flags are set.
Definition: types.h:47
#define DT_NOT_NEGATIVE
Negative numbers are not allowed.
Definition: types.h:50
#define DT_NUMBER
a number
Definition: types.h:35