NeoMutt  2024-03-23-147-g885fbc
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
accountcmd.c
Go to the documentation of this file.
1
30#include "config.h"
31#include <assert.h>
32#include <stdio.h>
33#include <sys/types.h>
34#include "mutt/lib.h"
35#include "config/lib.h"
36#include "core/lib.h"
37#include "accountcmd.h"
38#include "connaccount.h"
39#include "globals.h"
40#include "mutt_account.h"
41
48static void make_cmd(struct Buffer *buf, const struct ConnAccount *cac, const char *cmd)
49{
50 assert(buf && cac);
51
52 buf_addstr(buf, cmd);
53 buf_add_printf(buf, " --hostname %s", cac->host);
54 if (cac->flags & MUTT_ACCT_USER)
55 {
56 buf_add_printf(buf, " --username %s", cac->user);
57 }
58
59 static const char *types[] = { "", "imap", "pop", "smtp", "nntp" };
60 assert(sizeof(types) / sizeof(*types) == MUTT_ACCT_TYPE_MAX);
61 if (cac->type != MUTT_ACCT_TYPE_NONE)
62 {
63 buf_add_printf(buf, " --type %s%c", types[cac->type],
64 (cac->flags & MUTT_ACCT_SSL) ? 's' : '\0');
65 }
66}
67
75static MuttAccountFlags parse_one(struct ConnAccount *cac, char *line)
76{
77 assert(cac && line);
78
79 const regmatch_t *match = mutt_prex_capture(PREX_ACCOUNT_CMD, line);
80 if (!match)
81 {
82 mutt_perror(_("Line is malformed: expected <key: val>, got <%s>"), line);
83 return MUTT_ACCT_NO_FLAGS;
84 }
85
86 const regmatch_t *keymatch = &match[PREX_ACCOUNT_CMD_MATCH_KEY];
87 const regmatch_t *valmatch = &match[PREX_ACCOUNT_CMD_MATCH_VALUE];
88 line[mutt_regmatch_start(keymatch) + mutt_regmatch_len(keymatch)] = '\0';
89 const char *key = line + mutt_regmatch_start(keymatch);
90 const char *val = line + mutt_regmatch_start(valmatch);
91
92 switch (key[0])
93 {
94 case 'l':
95 if (mutt_str_equal(key + 1, "ogin"))
96 {
97 mutt_str_copy(cac->login, val, sizeof(cac->login));
98 return MUTT_ACCT_LOGIN;
99 }
100 break;
101
102 case 'p':
103 if (mutt_str_equal(key + 1, "assword"))
104 {
105 mutt_str_copy(cac->pass, val, sizeof(cac->pass));
106 return MUTT_ACCT_PASS;
107 }
108 break;
109
110 case 'u':
111 if (mutt_str_equal(key + 1, "sername"))
112 {
113 mutt_str_copy(cac->user, val, sizeof(cac->user));
114 return MUTT_ACCT_USER;
115 }
116 break;
117
118 default:
119 break;
120 }
121
122 mutt_warning(_("Unhandled key in line <%s: %s>"), key, val);
123 return MUTT_ACCT_NO_FLAGS;
124}
125
133static MuttAccountFlags call_cmd(struct ConnAccount *cac, const struct Buffer *cmd)
134{
135 assert(cac && cmd);
136
138
139 FILE *fp = NULL;
140 pid_t pid = filter_create(buf_string(cmd), NULL, &fp, NULL, EnvList);
141 if (pid < 0)
142 {
143 mutt_perror(_("Unable to run account command"));
144 return rc;
145 }
146
147 size_t len = 0;
148 char *line = NULL;
149 while ((line = mutt_file_read_line(NULL, &len, fp, NULL, MUTT_RL_NO_FLAGS)))
150 {
151 rc |= parse_one(cac, line);
152 FREE(&line);
153 }
154
155 mutt_file_fclose(&fp);
156 filter_wait(pid);
157 return rc;
158}
159
167{
168 if (!cac || (cac->host[0] == '\0') || (cac->type == MUTT_ACCT_TYPE_NONE))
169 {
170 return MUTT_ACCT_NO_FLAGS;
171 }
172
173 const char *c_account_command = cs_subset_string(NeoMutt->sub, "account_command");
174 if (!c_account_command)
175 {
176 return MUTT_ACCT_NO_FLAGS;
177 }
178
180 struct Buffer *cmd_buf = buf_pool_get();
181
182 make_cmd(cmd_buf, cac, c_account_command);
183 rc = call_cmd(cac, cmd_buf);
184 cac->flags |= rc;
185
186 buf_pool_release(&cmd_buf);
187 return rc;
188}
static MuttAccountFlags call_cmd(struct ConnAccount *cac, const struct Buffer *cmd)
Call the account command.
Definition: accountcmd.c:133
static MuttAccountFlags parse_one(struct ConnAccount *cac, char *line)
Parse a single line of the response.
Definition: accountcmd.c:75
static void make_cmd(struct Buffer *buf, const struct ConnAccount *cac, const char *cmd)
Build the command line for the external account command.
Definition: accountcmd.c:48
MuttAccountFlags mutt_account_call_external_cmd(struct ConnAccount *cac)
Retrieve account credentials via an external command.
Definition: accountcmd.c:166
Connection Credentials External Command.
int buf_add_printf(struct Buffer *buf, const char *fmt,...)
Format a string appending a Buffer.
Definition: buffer.c:203
size_t buf_addstr(struct Buffer *buf, const char *s)
Add a string to a Buffer.
Definition: buffer.c:225
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:96
const char * cs_subset_string(const struct ConfigSubset *sub, const char *name)
Get a string config item by name.
Definition: helpers.c:292
Convenience wrapper for the config headers.
Connection Credentials.
uint8_t MuttAccountFlags
Flags, Which ConnAccount fields are initialised, e.g. MUTT_ACCT_PORT.
Definition: connaccount.h:41
#define MUTT_ACCT_NO_FLAGS
No flags are set.
Definition: connaccount.h:42
#define MUTT_ACCT_SSL
Account uses SSL/TLS.
Definition: connaccount.h:47
#define MUTT_ACCT_PASS
Password field has been set.
Definition: connaccount.h:46
#define MUTT_ACCT_USER
User field has been set.
Definition: connaccount.h:44
#define MUTT_ACCT_LOGIN
Login field has been set.
Definition: connaccount.h:45
Convenience wrapper for the core headers.
char * mutt_file_read_line(char *line, size_t *size, FILE *fp, int *line_num, ReadLineFlags flags)
Read a line from a file.
Definition: file.c:805
#define mutt_file_fclose(FP)
Definition: file.h:147
#define MUTT_RL_NO_FLAGS
No flags are set.
Definition: file.h:40
int filter_wait(pid_t pid)
Wait for the exit of a process and return its status.
Definition: filter.c:220
pid_t filter_create(const char *cmd, FILE **fp_in, FILE **fp_out, FILE **fp_err, char **envlist)
Set up filter program.
Definition: filter.c:209
char ** EnvList
Private copy of the environment variables.
Definition: globals.c:78
#define mutt_warning(...)
Definition: logging2.h:90
#define mutt_perror(...)
Definition: logging2.h:93
#define FREE(x)
Definition: memory.h:45
Convenience wrapper for the library headers.
#define _(a)
Definition: message.h:28
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:709
size_t mutt_str_copy(char *dest, const char *src, size_t dsize)
Copy a string into a buffer (guaranteeing NUL-termination)
Definition: string.c:630
ConnAccount object used by POP and IMAP.
@ MUTT_ACCT_TYPE_NONE
Account type is unknown.
Definition: mutt_account.h:37
@ MUTT_ACCT_TYPE_MAX
Definition: mutt_account.h:42
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:81
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition: pool.c:94
regmatch_t * mutt_prex_capture(enum Prex which, const char *str)
Match a precompiled regex against a string.
Definition: prex.c:295
@ PREX_ACCOUNT_CMD_MATCH_KEY
[key]: value
Definition: prex.h:225
@ PREX_ACCOUNT_CMD_MATCH_VALUE
key: [value]
Definition: prex.h:226
@ PREX_ACCOUNT_CMD
key: value
Definition: prex.h:42
static size_t mutt_regmatch_len(const regmatch_t *match)
Return the length of a match.
Definition: regex3.h:76
static regoff_t mutt_regmatch_start(const regmatch_t *match)
Return the start of a match.
Definition: regex3.h:56
String manipulation buffer.
Definition: buffer.h:36
Login details for a remote server.
Definition: connaccount.h:53
char login[128]
Login name.
Definition: connaccount.h:55
char user[128]
Username.
Definition: connaccount.h:56
char pass[256]
Password.
Definition: connaccount.h:57
char host[128]
Server to login to.
Definition: connaccount.h:54
unsigned char type
Connection type, e.g. MUTT_ACCT_TYPE_IMAP.
Definition: connaccount.h:59
MuttAccountFlags flags
Which fields are initialised, e.g. MUTT_ACCT_USER.
Definition: connaccount.h:60
Container for Accounts, Notifications.
Definition: neomutt.h:41
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:45