1 /*@ S-nail - a mail user agent derived from Berkeley Mail.
2 *@ Function prototypes and function-alike macros.
4 * Copyright (c) 2000-2004 Gunnar Ritter, Freiburg i. Br., Germany.
5 * Copyright (c) 2012 - 2017 Steffen (Daode) Nurpmeso <steffen@sdaoden.eu>.
8 * Copyright (c) 1980, 1993
9 * The Regents of the University of California. All rights reserved.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. Neither the name of the University nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 * TODO Convert optional utility+ functions to n_*(); ditto
38 * TODO else use generic module-specific prefixes: str_(), am[em]_, sm[em]_, ..
40 /* TODO s-it-mode: not really (docu, funnames, funargs, etc) */
43 #ifndef HAVE_AMALGAMATION
49 /* Memory allocation routines from memory.c offer some debug support */
50 #ifdef HAVE_MEMORY_DEBUG
51 # define n_MEMORY_DEBUG_ARGS , char const *mdbg_file, int mdbg_line
52 # define n_MEMORY_DEBUG_ARGSCALL , mdbg_file, mdbg_line
54 # define n_MEMORY_DEBUG_ARGS
55 # define n_MEMORY_DEBUG_ARGSCALL
59 * Macro-based generics
62 /* ASCII char classification */
63 #define n__ischarof(C, FLAGS) \
64 (asciichar(C) && (n_class_char[(ui8_t)(C)] & (FLAGS)) != 0)
66 #define n_uasciichar(U) ((size_t)(U) <= 0x7F)
67 #define asciichar(c) ((uc_i)(c) <= 0x7F)
68 #define alnumchar(c) n__ischarof(c, C_DIGIT | C_OCTAL | C_UPPER | C_LOWER)
69 #define alphachar(c) n__ischarof(c, C_UPPER | C_LOWER)
70 #define blankchar(c) n__ischarof(c, C_BLANK)
71 #define blankspacechar(c) n__ischarof(c, C_BLANK | C_SPACE)
72 #define cntrlchar(c) n__ischarof(c, C_CNTRL)
73 #define digitchar(c) n__ischarof(c, C_DIGIT | C_OCTAL)
74 #define lowerchar(c) n__ischarof(c, C_LOWER)
75 #define punctchar(c) n__ischarof(c, C_PUNCT)
76 #define spacechar(c) n__ischarof(c, C_BLANK | C_SPACE | C_WHITE)
77 #define upperchar(c) n__ischarof(c, C_UPPER)
78 #define whitechar(c) n__ischarof(c, C_BLANK | C_WHITE)
79 #define octalchar(c) n__ischarof(c, C_OCTAL)
80 #define hexchar(c) /* TODO extend bits, add C_HEX */\
81 (n__ischarof(c, C_DIGIT | C_OCTAL) || ((c) >= 'A' && (c) <= 'F') ||\
82 ((c) >= 'a' && (c) <= 'f'))
84 #define upperconv(c) \
85 (lowerchar(c) ? (char)((uc_i)(c) - 'a' + 'A') : (char)(c))
86 #define lowerconv(c) \
87 (upperchar(c) ? (char)((uc_i)(c) - 'A' + 'a') : (char)(c))
89 #define fieldnamechar(c) \
90 (asciichar(c) && (c) > 040 && (c) != 0177 && (c) != ':')
92 /* Could the string contain a regular expression? */
93 #define n_is_maybe_regex(S) n_is_maybe_regex_buf(S, UIZ_MAX)
94 #define n_is_maybe_regex_buf(D,L) n_anyof_buf("^[]*+?|$", D, L)
96 /* Single-threaded, use unlocked I/O */
97 #ifdef HAVE_PUTC_UNLOCKED
99 # define getc(c) getc_unlocked(c)
101 # define putc(c, f) putc_unlocked(c, f)
104 /* There are problems with dup()ing of file-descriptors for child processes.
105 * We have to somehow accomplish that the FILE* fp makes itself comfortable
106 * with the *real* offset of the underlaying file descriptor.
107 * POSIX Issue 7 overloaded fflush(3): if used on a readable stream, then
109 * if the file is not already at EOF, and the file is one capable of
110 * seeking, the file offset of the underlying open file description shall
111 * be set to the file position of the stream */
112 #if defined _POSIX_VERSION && _POSIX_VERSION + 0 >= 200809L
113 # define n_real_seek(FP,OFF,WH) (fseek(FP, OFF, WH) != -1 && fflush(FP) != EOF)
114 # define really_rewind(stream) \
121 # define n_real_seek(FP,OFF,WH) \
122 (fseek(FP, OFF, WH) != -1 && fflush(FP) != EOF &&\
123 lseek(fileno(FP), OFF, WH) != -1)
124 # define really_rewind(stream) \
128 lseek(fileno(stream), 0, SEEK_SET);\
132 /* fflush() and rewind() */
133 #define fflush_rewind(stream) \
139 /* Truncate a file to the last character written. This is useful just before
140 * closing an old file that was opened for read/write */
141 #define ftrunc(stream) \
145 off = ftell(stream);\
147 ftruncate(fileno(stream), off);\
150 # define n_fd_cloexec_set(FD) \
152 int a__fd = (FD)/*, a__fl*/;\
153 /*if((a__fl = fcntl(a__fd, F_GETFD)) != -1 && !(a__fl & FD_CLOEXEC))*/\
154 (void)fcntl(a__fd, F_SETFD, FD_CLOEXEC);\
161 /* Macros: `define', `undefine', `call', `call_if' */
162 FL
int c_define(void *v
);
163 FL
int c_undefine(void *v
);
164 FL
int c_call(void *v
);
165 FL
int c_call_if(void *v
);
167 /* Accounts: `account', `unaccount' */
168 FL
int c_account(void *v
);
169 FL
int c_unaccount(void *v
);
171 /* `localopts', `shift', `return' */
172 FL
int c_localopts(void *vp
);
173 FL
int c_shift(void *vp
);
174 FL
int c_return(void *vp
);
176 /* TODO Check whether a *folder-hook* exists for the currently active mailbox */
177 FL bool_t
temporary_folder_hook_check(bool_t nmail
);
178 FL
void temporary_folder_hook_unroll(void); /* XXX im. hack */
180 /* TODO v15 drop Invoke compose hook macname */
181 FL
void temporary_compose_mode_hook_call(char const *macname
,
182 void (*hook_pre
)(void *), void *hook_arg
);
183 FL
void temporary_compose_mode_hook_unroll(void);
185 /* Can name freely be used as a variable by users? */
186 FL bool_t
n_var_is_user_writable(char const *name
);
188 /* Don't use n_var_* unless you *really* have to! */
190 /* Constant option key look/(un)set/clear */
191 FL
char *n_var_oklook(enum okeys okey
);
192 #define ok_blook(C) (n_var_oklook(n_CONCAT(ok_b_, C)) != NULL)
193 #define ok_vlook(C) n_var_oklook(n_CONCAT(ok_v_, C))
195 FL bool_t
n_var_okset(enum okeys okey
, uintptr_t val
);
197 n_var_okset(n_CONCAT(ok_b_, C), (uintptr_t)TRU1)
198 #define ok_vset(C,V) \
199 n_var_okset(n_CONCAT(ok_v_, C), (uintptr_t)(V))
201 FL bool_t
n_var_okclear(enum okeys okey
);
202 #define ok_bclear(C) n_var_okclear(n_CONCAT(ok_b_, C))
203 #define ok_vclear(C) n_var_okclear(n_CONCAT(ok_v_, C))
205 /* Variable option key lookup/(un)set/clear.
206 * If try_getenv is true we'll getenv(3) _if_ vokey is not a known enum okey.
207 * _vexplode() is to be used by the shell expansion stuff when encountering
208 * ${@} in double-quotes, in order to provide sh(1)ell compatible behaviour;
209 * it returns whether there are any elements in argv (*cookie) */
210 FL
char const *n_var_vlook(char const *vokey
, bool_t try_getenv
);
211 FL bool_t
n_var_vexplode(void const **cookie
);
212 FL bool_t
n_var_vset(char const *vokey
, uintptr_t val
);
213 FL bool_t
n_var_vclear(char const *vokey
);
215 /* Special case to handle the typical [xy-USER@HOST,] xy-HOST and plain xy
216 * variable chains; oxm is a bitmix which tells which combinations to test */
218 FL
char *n_var_xoklook(enum okeys okey
, struct url
const *urlp
,
219 enum okey_xlook_mode oxm
);
220 # define xok_BLOOK(C,URL,M) (n_var_xoklook(C, URL, M) != NULL)
221 # define xok_VLOOK(C,URL,M) n_var_xoklook(C, URL, M)
222 # define xok_blook(C,URL,M) xok_BLOOK(n_CONCAT(ok_b_, C), URL, M)
223 # define xok_vlook(C,URL,M) xok_VLOOK(n_CONCAT(ok_v_, C), URL, M)
226 /* User variable access: `set' and `unset' */
227 FL
int c_set(void *v
);
228 FL
int c_unset(void *v
);
231 FL
int c_varshow(void *v
);
233 /* Ditto: `varedit' */
234 FL
int c_varedit(void *v
);
237 FL
int c_environ(void *v
);
240 FL
int c_vexpr(void *v
);
243 FL
int c_vpospar(void *v
);
247 * xxx Interface quite sick
250 /* Try to add an attachment for file, fexpand(_LOCAL|_NOPROTO)ed.
251 * Return the new aplist aphead.
252 * The newly created attachment may be stored in *newap, or NULL on error */
253 FL
struct attachment
*n_attachment_append(struct attachment
*aplist
,
254 char const *file
, enum n_attach_error
*aerr_or_null
,
255 struct attachment
**newap_or_null
);
257 /* Shell-token parse names, and append resulting file names to aplist, return
258 * (new) aplist head */
259 FL
struct attachment
*n_attachment_append_list(struct attachment
*aplist
,
262 /* Remove ap from aplist, and return the new aplist head */
263 FL
struct attachment
*n_attachment_remove(struct attachment
*aplist
,
264 struct attachment
*ap
);
266 /* Find by file-name. If any path component exists in name then an exact match
267 * of the creation-path is used directly; if instead the basename of that path
268 * matches all attachments are traversed to find an exact match first, the
269 * first of all basename matches is returned as a last resort;
270 * If no path component exists the filename= parameter is searched (and also
271 * returned) in preference over the basename, otherwise likewise.
272 * If name is in fact a message number the first match is taken.
273 * If stat_or_null is given: FAL0 on NULL return, TRU1 for exact/single match,
274 * TRUM1 for ambiguous matches */
275 FL
struct attachment
*n_attachment_find(struct attachment
*aplist
,
276 char const *name
, bool_t
*stat_or_null
);
278 /* Interactively edit the attachment list, return updated list */
279 FL
struct attachment
*n_attachment_list_edit(struct attachment
*aplist
,
280 enum n_go_input_flags gif
);
282 /* Print all attachments to fp, return number of lines written, -1 on error */
283 FL ssize_t
n_attachment_list_print(struct attachment
const *aplist
, FILE *fp
);
289 /* setlocale(3), *ttycharset* etc. */
290 FL
void n_locale_init(void);
292 /* Compute screen size */
293 FL
size_t n_screensize(void);
295 /* Get our $PAGER; if env_addon is not NULL it is checked whether we know about
296 * some environment variable that supports colour+ and set *env_addon to that,
297 * e.g., "LESS=FRSXi" */
298 FL
char const *n_pager_get(char const **env_addon
);
300 /* Use a pager or STDOUT to print *fp*; if *lines* is 0, they'll be counted */
301 FL
void page_or_print(FILE *fp
, size_t lines
);
303 /* Parse name and guess at the required protocol.
304 * If check_stat is true then stat(2) will be consulted - a TODO c..p hack
305 * TODO that together with *newfolders*=maildir adds Maildir support; sigh!
306 * If try_hooks is set check_stat is implied and if the stat(2) fails all
307 * file-hook will be tried in order to find a supported version of name.
308 * If adjusted_or_null is not NULL it will be set to the final version of name
309 * this function knew about: a %: FEDIT_SYSBOX prefix is forgotten, in case
310 * a hook is needed the "real" filename will be placed.
311 * TODO This c..p should be URL::from_string()->protocol() or something! */
312 FL
enum protocol
which_protocol(char const *name
, bool_t check_stat
,
313 bool_t try_hooks
, char const **adjusted_or_null
);
315 /* Hexadecimal itoa (NUL terminates) / atoi (-1 on error) */
316 FL
char * n_c_to_hex_base16(char store
[3], char c
);
317 FL si32_t
n_c_from_hex_base16(char const hex
[2]);
319 /* Decode clen (or strlen() if UIZ_MAX) bytes of cbuf into an integer
320 * according to idm, store a/the result in *resp (in _EINVAL case an overflow
321 * constant is assigned, for signed types it depends on parse state w. MIN/MAX),
322 * which must point to storage of the correct type, and return the result state.
323 * If endptr_or_null is set it will be set to the byte where parsing stopped */
324 FL
enum n_idec_state
n_idec_buf(void *resp
, char const *cbuf
, uiz_t clen
,
325 ui8_t base
, enum n_idec_mode idm
,
326 char const **endptr_or_null
);
327 #define n_idec_cp(RP,CBP,B,M,CLP) n_idec_buf(RP, CBP, UIZ_MAX, B, M, CLP)
329 #define n_idec_ui8_cp(RP,CBP,B,CLP) \
330 n_idec_buf(RP, CBP, UIZ_MAX, B, (n_IDEC_MODE_LIMIT_8BIT), CLP)
331 #define n_idec_si8_cp(RP,CBP,B,CLP) \
332 n_idec_buf(RP, CBP, UIZ_MAX, B,\
333 (n_IDEC_MODE_SIGNED_TYPE | n_IDEC_MODE_LIMIT_8BIT), CLP)
334 #define n_idec_ui16_cp(RP,CBP,B,CLP) \
335 n_idec_buf(RP, CBP, UIZ_MAX, B, (n_IDEC_MODE_LIMIT_16BIT), CLP)
336 #define n_idec_si16_cp(RP,CBP,B,CLP) \
337 n_idec_buf(RP, CBP, UIZ_MAX, B,\
338 (n_IDEC_MODE_SIGNED_TYPE | n_IDEC_MODE_LIMIT_16BIT), CLP)
339 #define n_idec_ui32_cp(RP,CBP,B,CLP) \
340 n_idec_buf(RP, CBP, UIZ_MAX, B, (n_IDEC_MODE_LIMIT_32BIT), CLP)
341 #define n_idec_si32_cp(RP,CBP,B,CLP) \
342 n_idec_buf(RP, CBP, UIZ_MAX, B,\
343 (n_IDEC_MODE_SIGNED_TYPE | n_IDEC_MODE_LIMIT_32BIT), CLP)
344 #define n_idec_ui64_cp(RP,CBP,B,CLP) \
345 n_idec_buf(RP, CBP, UIZ_MAX, B, 0, CLP)
346 #define n_idec_si64_cp(RP,CBP,B,CLP) \
347 n_idec_buf(RP, CBP, UIZ_MAX, B, (n_IDEC_MODE_SIGNED_TYPE), CLP)
348 #if UIZ_MAX == UI32_MAX
349 # define n_idec_uiz_cp(RP,CBP,B,CLP) \
350 n_idec_buf(RP, CBP, UIZ_MAX, B, (n_IDEC_MODE_LIMIT_32BIT), CLP)
351 # define n_idec_siz_cp(RP,CBP,B,CLP) \
352 n_idec_buf(RP, CBP, UIZ_MAX, B,\
353 (n_IDEC_MODE_SIGNED_TYPE | n_IDEC_MODE_LIMIT_32BIT), CLP)
355 # define n_idec_uiz_cp(RP,CBP,B,CLP) \
356 n_idec_buf(RP, CBP, UIZ_MAX, B, 0, CLP)
357 # define n_idec_siz_cp(RP,CBP,B,CLP) \
358 n_idec_buf(RP, CBP, UIZ_MAX, B, (n_IDEC_MODE_SIGNED_TYPE), CLP)
361 /* Hash the passed string -- uses Chris Torek's hash algorithm.
362 * i*() hashes case-insensitively (ASCII), and *n() uses maximally len bytes;
363 * if len is UIZ_MAX, we go .), since we anyway stop for NUL */
364 FL ui32_t
n_torek_hash(char const *name
);
365 FL ui32_t
n_torek_ihashn(char const *dat
, size_t len
);
366 #define n_torek_ihash(CP) n_torek_ihashn(CP, UIZ_MAX)
368 /* Find a prime greater than n */
369 FL ui32_t
n_prime_next(ui32_t n
);
371 /* Return the name of the dead.letter file */
372 FL
char const * n_getdeadletter(void);
374 /* Detect and query the hostname to use */
375 FL
char *n_nodename(bool_t mayoverride
);
377 /* Convert from / to *ttycharset* */
379 FL bool_t
n_idna_to_ascii(struct n_string
*out
, char const *ibuf
, size_t ilen
);
380 /*TODO FL bool_t n_idna_from_ascii(struct n_string *out, char const *ibuf,
384 /* Get a (pseudo) random string of *length* bytes; returns salloc()ed buffer.
385 * If n_PSO_REPRODUCIBLE and reprocnt_or_null not NULL then we produce
386 * a reproducable string by using and managing that counter instead */
387 FL
char *n_random_create_cp(size_t length
, ui32_t
*reprocnt_or_null
);
389 /* Check whether the argument string is a true (1) or false (0) boolean, or an
390 * invalid string, in which case -1 is returned; if emptyrv is not -1 then it,
391 * treated as a boolean, is used as the return value shall inbuf be empty.
392 * inlen may be UIZ_MAX to force strlen() detection */
393 FL si8_t
boolify(char const *inbuf
, uiz_t inlen
, si8_t emptyrv
);
395 /* Dig a "quadoption" in inbuf (possibly going through getapproval() in
396 * interactive mode). Returns a boolean or -1 if inbuf content is invalid;
397 * if emptyrv is not -1 then it, treated as a boolean, is used as the return
398 * value shall inbuf be empty. If prompt is set it is printed first if intera.
399 * inlen may be UIZ_MAX to force strlen() detection */
400 FL si8_t
quadify(char const *inbuf
, uiz_t inlen
, char const *prompt
,
403 /* Is the argument "all" (case-insensitive) or "*" */
404 FL bool_t
n_is_all_or_aster(char const *name
);
406 /* Get seconds since epoch, return pointer to static struct.
407 * Unless force_update is true we may use the event-loop tick time */
408 FL
struct n_timespec
const *n_time_now(bool_t force_update
);
409 #define n_time_epoch() ((time_t)n_time_now(FAL0)->ts_sec)
411 /* Update *tc* to now; only .tc_time updated unless *full_update* is true */
412 FL
void time_current_update(struct time_current
*tc
,
415 /* Returns 0 if fully slept, number of millis left if ignint is true and we
416 * were interrupted. Actual resolution may be second or less.
417 * Note in case of HAVE_SLEEP this may be SIGALARM based. */
418 FL uiz_t
n_msleep(uiz_t millis
, bool_t ignint
);
420 /* Our error print series.. Note: these reverse scan format in order to know
421 * whether a newline was included or not -- this affects the output! */
422 FL
void n_err(char const *format
, ...);
423 FL
void n_verr(char const *format
, va_list ap
);
425 /* ..(for use in a signal handler; to be obsoleted..).. */
426 FL
void n_err_sighdl(char const *format
, ...);
428 /* Our perror(3); if errval is 0 n_err_no is used; newline appended */
429 FL
void n_perr(char const *msg
, int errval
);
431 /* Announce a fatal error (and die); newline appended */
432 FL
void n_alert(char const *format
, ...);
433 FL
void n_panic(char const *format
, ...);
437 FL
int c_errors(void *vp
);
440 /* strerror(3), and enum n_err_number <-> error name conversions */
441 FL
char const *n_err_to_doc(si32_t eno
);
442 FL
char const *n_err_to_name(si32_t eno
);
443 FL si32_t
n_err_from_name(char const *name
);
447 FL
char const *n_regex_err_to_doc(const regex_t
*rep
, int e
);
454 /* if.elif.else.endif conditional execution.
455 * _isskip() tests whether current state doesn't allow execution of commands */
456 FL
int c_if(void *v
);
457 FL
int c_elif(void *v
);
458 FL
int c_else(void *v
);
459 FL
int c_endif(void *v
);
461 FL bool_t
n_cnd_if_isskip(void);
463 /* An execution context is teared down, and it finds to have an if stack */
464 FL
void n_cnd_if_stack_del(struct n_go_data_ctx
*gdcp
);
470 /* `file' (`folder') and `File' (`Folder') */
471 FL
int c_file(void *v
);
472 FL
int c_File(void *v
);
474 /* 'newmail' command: Check for new mail without writing old mail back */
475 FL
int c_newmail(void *v
);
478 FL
int c_noop(void *v
);
481 FL
int c_remove(void *v
);
484 FL
int c_rename(void *v
);
486 /* List the folders the user currently has */
487 FL
int c_folders(void *v
);
493 /* `headers' (show header group, possibly after setting dot) */
494 FL
int c_headers(void *v
);
496 /* Like c_headers(), but pre-prepared message vector */
497 FL
int print_header_group(int *vector
);
499 /* Scroll to the next/previous screen */
500 FL
int c_scroll(void *v
);
501 FL
int c_Scroll(void *v
);
503 /* Move the dot up or down by one message */
504 FL
int c_dotmove(void *v
);
506 /* Print out the headlines for each message in the passed message list */
507 FL
int c_from(void *v
);
509 /* Print all message in between and including bottom and topx if they are
510 * visible and either only_marked is false or they are MMARKed */
511 FL
void print_headers(size_t bottom
, size_t topx
, bool_t only_marked
);
517 /* Paginate messages, honour/don't honour ignored fields, respectively */
518 FL
int c_more(void *v
);
519 FL
int c_More(void *v
);
521 /* Type out messages, honour/don't honour ignored fields, respectively */
522 FL
int c_type(void *v
);
523 FL
int c_Type(void *v
);
525 /* Show raw message content */
526 FL
int c_show(void *v
);
529 FL
int c_mimeview(void *vp
);
531 /* Pipe messages, honour/don't honour ignored fields, respectively */
532 FL
int c_pipe(void *v
);
533 FL
int c_Pipe(void *v
);
535 /* Print the first *toplines* of each desired message */
536 FL
int c_top(void *v
);
537 FL
int c_Top(void *v
);
539 /* If any arguments were given, go to the next applicable argument following
540 * dot, otherwise, go to the next applicable message. If given as first
541 * command with no arguments, print first message */
542 FL
int c_next(void *v
);
544 /* Print out the value of dot */
545 FL
int c_pdot(void *v
);
547 /* Print the size of each message */
548 FL
int c_messize(void *v
);
550 /* Delete messages */
551 FL
int c_delete(void *v
);
553 /* Delete messages, then type the new dot */
554 FL
int c_deltype(void *v
);
556 /* Undelete the indicated messages */
557 FL
int c_undelete(void *v
);
559 /* Touch all the given messages so that they will get mboxed */
560 FL
int c_stouch(void *v
);
562 /* Make sure all passed messages get mboxed */
563 FL
int c_mboxit(void *v
);
565 /* Preserve messages, so that they will be sent back to the system mailbox */
566 FL
int c_preserve(void *v
);
568 /* Mark all given messages as unread */
569 FL
int c_unread(void *v
);
571 /* Mark all given messages as read */
572 FL
int c_seen(void *v
);
574 /* Message flag manipulation */
575 FL
int c_flag(void *v
);
576 FL
int c_unflag(void *v
);
577 FL
int c_answered(void *v
);
578 FL
int c_unanswered(void *v
);
579 FL
int c_draft(void *v
);
580 FL
int c_undraft(void *v
);
587 FL
int c_sleep(void *v
);
589 /* `!': process a shell escape by saving signals, ignoring signals and sh -c */
590 FL
int c_shell(void *v
);
592 /* `shell': fork an interactive shell */
593 FL
int c_dosh(void *v
);
595 /* `cwd': print user's working directory */
596 FL
int c_cwd(void *v
);
598 /* `chdir': change user's working directory */
599 FL
int c_chdir(void *v
);
601 /* `echo' series: expand file names like echo (to stdout/stderr, with/out
602 * trailing newline) */
603 FL
int c_echo(void *v
);
604 FL
int c_echoerr(void *v
);
605 FL
int c_echon(void *v
);
606 FL
int c_echoerrn(void *v
);
609 FL
int c_read(void *vp
);
612 FL
int c_version(void *vp
);
618 /* All thinkable sorts of `reply' / `respond' and `followup'.. */
619 FL
int c_reply(void *vp
);
620 FL
int c_replyall(void *vp
);
621 FL
int c_replysender(void *vp
);
622 FL
int c_Reply(void *vp
);
623 FL
int c_followup(void *vp
);
624 FL
int c_followupall(void *vp
);
625 FL
int c_followupsender(void *vp
);
626 FL
int c_Followup(void *vp
);
628 /* ..and a mailing-list reply */
629 FL
int c_Lreply(void *vp
);
631 /* The 'forward' command */
632 FL
int c_forward(void *vp
);
634 /* Similar to forward, saving the message in a file named after the first
636 FL
int c_Forward(void *vp
);
638 /* Resend a message list to a third person */
639 FL
int c_resend(void *vp
);
641 /* Resend a message list to a third person without adding headers */
642 FL
int c_Resend(void *vp
);
646 * Actual command table, `help', `list', etc., and the n_cmd_arg() parser.
649 /* Isolate the command from the arguments, return pointer to end of cmd name */
650 FL
char const *n_cmd_isolate(char const *cmd
);
652 /* First command which fits for cmd, or NULL */
653 FL
struct n_cmd_desc
const *n_cmd_firstfit(char const *cmd
);
655 /* Get the default command for the empty line */
656 FL
struct n_cmd_desc
const *n_cmd_default(void);
658 /* Scan an entire command argument line, return whether result can be used,
659 * otherwise no resources are allocated (in ->cac_arg).
660 * For _WYSH arguments the flags _TRIM_SPACE (v15 _not_ _TRIM_IFSSPACE) and
661 * _LOG are implicit, _META_SEMICOLON is starting with the last (non-optional)
662 * argument, and then a trailing empty argument is ignored, too */
663 FL bool_t
n_cmd_arg_parse(struct n_cmd_arg_ctx
*cacp
);
665 /* Save away the data from autorec memory, and restore it to that.
666 * The heap storage is a single pointer to be n_free() by users */
667 FL
void *n_cmd_arg_save_to_heap(struct n_cmd_arg_ctx
const *cacp
);
668 FL
struct n_cmd_arg_ctx
*n_cmd_arg_restore_from_heap(void *vp
);
670 /* Scan out the list of string arguments according to rm, return -1 on error;
671 * res_dat is NULL terminated unless res_size is 0 or error occurred */
672 FL
int /* TODO v15*/ getrawlist(bool_t wysh
, char **res_dat
, size_t res_size
,
673 char const *line
, size_t linesize
);
679 /* Save a message in a file. Mark the message as saved so we can discard when
681 FL
int c_save(void *v
);
682 FL
int c_Save(void *v
);
684 /* Copy a message to a file without affected its saved-ness */
685 FL
int c_copy(void *v
);
686 FL
int c_Copy(void *v
);
688 /* Move a message to a file */
689 FL
int c_move(void *v
);
690 FL
int c_Move(void *v
);
692 /* Decrypt and copy a message to a file. Like plain `copy' at times */
693 FL
int c_decrypt(void *v
);
694 FL
int c_Decrypt(void *v
);
696 /* Write the indicated messages at the end of the passed file name, minus
697 * header and trailing blank line. This is the MIME save function */
698 FL
int c_write(void *v
);
704 /* temporary_compose_mode_hook_call() etc. setter hook */
705 FL
void n_temporary_compose_hook_varset(void *arg
);
707 /* If quotefile is (char*)-1, stdin will be used, caller has to verify that
708 * we're not running in interactive mode */
709 FL
FILE * collect(struct header
*hp
, int printheaders
, struct message
*mp
,
710 char const *quotefile
, int doprefix
, si8_t
*checkaddr_err
);
718 FL
int c_colour(void *v
);
719 FL
int c_uncolour(void *v
);
721 /* An execution context is teared down, and it finds to have a colour stack.
722 * Signals are blocked */
723 FL
void n_colour_stack_del(struct n_go_data_ctx
*gdcp
);
725 /* We want coloured output (in this salloc() cycle), pager_used is used to
726 * test whether *colour-pager* is to be inspected, if fp is given, the reset
727 * sequence will be written as necessary by _stack_del()
728 * env_gut() will reset() as necessary if fp is not NULL */
729 FL
void n_colour_env_create(enum n_colour_ctx cctx
, FILE *fp
,
731 FL
void n_colour_env_gut(void);
733 /* Putting anything (for pens: including NULL) resets current state first */
734 FL
void n_colour_put(enum n_colour_id cid
, char const *ctag
);
735 FL
void n_colour_reset(void);
737 /* Of course temporary only and may return NULL. Doesn't affect state! */
738 FL
struct str
const *n_colour_reset_to_str(void);
740 /* A pen is bound to its environment and automatically reclaimed; it may be
741 * NULL but that can be used anyway for simplicity.
742 * This includes pen_to_str() -- which doesn't affect state! */
743 FL
struct n_colour_pen
*n_colour_pen_create(enum n_colour_id cid
,
745 FL
void n_colour_pen_put(struct n_colour_pen
*self
);
747 FL
struct str
const *n_colour_pen_to_str(struct n_colour_pen
*self
);
748 #endif /* HAVE_COLOUR */
754 /* Aquire a flt lock and create a dotlock file; upon success a registered
755 * control-pipe FILE* is returned that keeps the link in between us and the
756 * lock-holding fork(2)ed subprocess (which conditionally replaced itself via
757 * execv(2) with the privilege-separated dotlock helper program): the lock file
758 * will be removed once the control pipe is closed via Pclose().
759 * Will try FILE_LOCK_TRIES times if pollmsecs > 0 (once otherwise).
760 * If pollmsecs is UIZ_MAX, FILE_LOCK_MILLIS is used.
761 * If *dotlock_ignore_error* is set (FILE*)-1 will be returned if at least the
762 * normal file lock could be established, otherwise n_err_no is usable on err */
763 FL
FILE * n_dotlock(char const *fname
, int fd
, enum n_file_lock_type flt
,
764 off_t off
, off_t len
, size_t pollmsecs
);
770 /* Edit a message list */
771 FL
int c_editor(void *v
);
773 /* Invoke the visual editor on a message list */
774 FL
int c_visual(void *v
);
776 /* Run an editor on either size bytes of the file fp (or until EOF if size is
777 * negative) or on the message mp, and return a new file or NULL on error of if
778 * the user didn't perform any edits.
779 * For now we assert that mp==NULL if hp!=NULL, treating this as a special call
780 * from within compose mode, and giving TRUM1 to puthead().
781 * Signals must be handled by the caller. viored is 'e' for ed, 'v' for vi */
782 FL
FILE * run_editor(FILE *fp
, off_t size
, int viored
, int readonly
,
783 struct header
*hp
, struct message
*mp
,
784 enum sendaction action
, sighandler_type oldint
);
791 FL
struct quoteflt
* quoteflt_dummy(void); /* TODO LEGACY */
792 FL
void quoteflt_init(struct quoteflt
*self
, char const *prefix
);
793 FL
void quoteflt_destroy(struct quoteflt
*self
);
794 FL
void quoteflt_reset(struct quoteflt
*self
, FILE *f
);
795 FL ssize_t
quoteflt_push(struct quoteflt
*self
, char const *dat
,
797 FL ssize_t
quoteflt_flush(struct quoteflt
*self
);
799 /* (Primitive) HTML tagsoup filter */
800 #ifdef HAVE_FILTER_HTML_TAGSOUP
801 /* TODO Because we don't support filter chains yet this filter will be run
802 * TODO in a dedicated subprocess, driven via a special Popen() mode */
803 FL
int htmlflt_process_main(void);
805 FL
void htmlflt_init(struct htmlflt
*self
);
806 FL
void htmlflt_destroy(struct htmlflt
*self
);
807 FL
void htmlflt_reset(struct htmlflt
*self
, FILE *f
);
808 FL ssize_t
htmlflt_push(struct htmlflt
*self
, char const *dat
, size_t len
);
809 FL ssize_t
htmlflt_flush(struct htmlflt
*self
);
816 /* fgets() replacement to handle lines of arbitrary size and with embedded \0
818 * line - line buffer. *line may be NULL.
819 * linesize - allocated size of line buffer.
820 * count - maximum characters to read. May be NULL.
821 * llen - length_of_line(*line).
823 * appendnl - always terminate line with \n, append if necessary.
824 * Manages the n_PS_READLINE_NL hack */
825 FL
char * fgetline(char **line
, size_t *linesize
, size_t *count
,
826 size_t *llen
, FILE *fp
, int appendnl n_MEMORY_DEBUG_ARGS
);
827 #ifdef HAVE_MEMORY_DEBUG
828 # define fgetline(A,B,C,D,E,F) \
829 fgetline(A, B, C, D, E, F, __FILE__, __LINE__)
832 /* Read up a line from the specified input into the linebuffer.
833 * Return the number of characters read. Do not include the newline at EOL.
834 * n is the number of characters already read and present in *linebuf; it'll be
835 * treated as _the_ line if no more (successful) reads are possible.
836 * Manages the n_PS_READLINE_NL hack */
837 FL
int readline_restart(FILE *ibuf
, char **linebuf
, size_t *linesize
,
838 size_t n n_MEMORY_DEBUG_ARGS
);
839 #ifdef HAVE_MEMORY_DEBUG
840 # define readline_restart(A,B,C,D) \
841 readline_restart(A, B, C, D, __FILE__, __LINE__)
844 /* Set up the input pointers while copying the mail file into /tmp */
845 FL
void setptr(FILE *ibuf
, off_t offset
);
847 /* Determine the size of the file possessed by the passed buffer */
848 FL off_t
fsize(FILE *iob
);
850 /* Will retry FILE_LOCK_RETRIES times if pollmsecs > 0.
851 * If pollmsecs is UIZ_MAX, FILE_LOCK_MILLIS is used */
852 FL bool_t
n_file_lock(int fd
, enum n_file_lock_type flt
,
853 off_t off
, off_t len
, size_t pollmsecs
);
859 /* Set up editing on the given file name.
860 * If the first character of name is %, we are considered to be editing the
861 * file, otherwise we are reading our mail which has signficance for mbox and
863 FL
int setfile(char const *name
, enum fedit_mode fm
);
865 FL
int newmailinfo(int omsgCount
);
867 /* Set the size of the message vector used to construct argument lists to
868 * message list functions */
869 FL
void setmsize(int sz
);
871 /* Logic behind -H / -L invocations */
872 FL
void print_header_summary(char const *Larg
);
874 /* Announces the current folder as indicated.
875 * Is responsible for updating "dot" (after a folder change). */
876 FL
void n_folder_announce(enum n_announce_flags af
);
878 FL
int getmdot(int nmail
);
880 FL
void initbox(char const *name
);
882 /* Determine and expand the current *folder* name, return it (with trailing
883 * solidus) or the empty string also in case of errors: since POSIX mandates
884 * a default of CWD if not set etc., that seems to be a valid fallback, then */
885 FL
char const *n_folder_query(void);
887 /* Prepare the seekable O_APPEND MBOX fout for appending of another message.
888 * If st_or_null is not NULL it is assumed to point to an up-to-date status of
889 * fout, otherwise an internal fstat(2) is performed as necessary.
890 * Returns n_err_no of error */
891 FL
int n_folder_mbox_prepare_append(FILE *fout
, struct stat
*st_or_null
);
895 * Program input of all sorts, input lexing, event loops, command evaluation.
896 * Also alias handling.
899 /* Setup the run environment; this i *only* for main() */
900 FL
void n_go_init(void);
902 /* Interpret user commands. If stdin is not a tty, print no prompt; return
903 * whether last processed command returned error; this is *only* for main()! */
904 FL bool_t
n_go_main_loop(void);
906 /* Actual cmd input */
909 FL
void n_go_input_clearerr(void);
911 /* Force n_go_input() to read EOF next */
912 FL
void n_go_input_force_eof(void);
914 /* Returns true if force_eof() has been set -- it is set automatically if
915 * an input context enters EOF state (rather than error, as in ferror(3)) */
916 FL bool_t
n_go_input_is_eof(void);
918 /* Force n_go_input() to read that buffer next -- for `history', and the MLE.
919 * If commit is not true then we'll reenter the line editor with buf as default
920 * line content. Only to be used in interactive and non-robot mode! */
921 FL
void n_go_input_inject(enum n_go_input_inject_flags giif
, char const *buf
,
924 /* Read a complete line of input, with editing if interactive and possible.
925 * If string is set it is used as the initial line content if in interactive
926 * mode, otherwise this argument is ignored for reproducibility.
927 * If histok_or_null is set it will be updated to FAL0 if input shall not be
929 * Return number of octets or a value <0 on error.
930 * Note: may use the currently `source'd file stream instead of stdin!
931 * Manages the n_PS_READLINE_NL hack
932 * TODO We need an OnReadLineCompletedEvent and drop this function */
933 FL
int n_go_input(enum n_go_input_flags gif
, char const *prompt
,
934 char **linebuf
, size_t *linesize
, char const *string
,
935 bool_t
*histok_or_null n_MEMORY_DEBUG_ARGS
);
936 #ifdef HAVE_MEMORY_DEBUG
937 # define n_go_input(A,B,C,D,E,F) n_go_input(A,B,C,D,E,F,__FILE__,__LINE__)
940 /* Read a line of input, with editing if interactive and possible, return it
941 * savestr()d or NULL in case of errors or if an empty line would be returned.
942 * This may only be called from toplevel (not during n_PS_ROBOT).
943 * If string is set it is used as the initial line content if in interactive
944 * mode, otherwise this argument is ignored for reproducibility */
945 FL
char *n_go_input_cp(enum n_go_input_flags gif
, char const *prompt
,
948 /* Deal with loading of resource files and dealing with a stack of files for
949 * the source command */
951 /* Load a file of user system startup resources.
952 * *Only* for main(), returns whether program shall continue */
953 FL bool_t
n_go_load(char const *name
);
955 /* "Load" all the -X command line definitions in order.
956 * *Only* for main(), returns whether program shall continue */
957 FL bool_t
n_go_Xargs(char const **lines
, size_t cnt
);
959 /* Pushdown current input file and switch to a new one. Set the global flag
960 * n_PS_SOURCING so that others will realize that they are no longer reading
961 * from a tty (in all probability) */
962 FL
int c_source(void *v
);
963 FL
int c_source_if(void *v
);
965 /* Evaluate a complete macro / a single command. For the former lines will
966 * always be free()d, for the latter cmd will always be duplicated internally */
967 FL bool_t
n_go_macro(enum n_go_input_flags gif
, char const *name
, char **lines
,
968 void (*on_finalize
)(void*), void *finalize_arg
);
969 FL bool_t
n_go_command(enum n_go_input_flags gif
, char const *cmd
);
971 /* XXX See a_GO_SPLICE in source */
972 FL
void n_go_splice_hack(char const *cmd
, FILE *new_stdin
, FILE *new_stdout
,
973 ui32_t new_psonce
, void (*on_finalize
)(void*), void *finalize_arg
);
974 FL
void n_go_splice_hack_remove_after_jump(void);
976 /* XXX Hack: may we release our (interactive) (terminal) control to a different
977 * XXX program, e.g., a $PAGER? */
978 FL bool_t
n_go_may_yield_control(void);
981 FL
int c_eval(void *vp
);
984 FL
int c_xcall(void *vp
);
986 /* `exit' and `quit' commands */
987 FL
int c_exit(void *vp
);
988 FL
int c_quit(void *vp
);
991 FL
int c_readctl(void *vp
);
997 /* Return the user's From: address(es) */
998 FL
char const * myaddrs(struct header
*hp
);
1000 /* Boil the user's From: addresses down to a single one, or use *sender* */
1001 FL
char const * myorigin(struct header
*hp
);
1003 /* See if the passed line buffer, which may include trailing newline (sequence)
1004 * is a mail From_ header line according to POSIX ("From ").
1005 * If check_rfc4155 is true we'll return TRUM1 instead if the From_ line
1006 * matches POSIX but is _not_ compatible to RFC 4155 */
1007 FL bool_t
is_head(char const *linebuf
, size_t linelen
,
1008 bool_t check_rfc4155
);
1010 /* Savage extract date field from From_ line. linelen is convenience as line
1011 * must be terminated (but it may end in a newline [sequence]).
1012 * Return whether the From_ line was parsed successfully (-1 if the From_ line
1013 * wasn't really RFC 4155 compliant) */
1014 FL
int extract_date_from_from_(char const *line
, size_t linelen
,
1015 char datebuf
[n_FROM_DATEBUF
]);
1017 /* Extract some header fields (see e.g. -t documentation) from a message.
1018 * If n_poption&n_PO_t_FLAG *and* n_psonce&n_PSO_t_FLAG are both set a number
1019 * of additional header fields are understood and address joining is performed
1020 * as necessary, and the subject is treated with additional care, too.
1021 * If n_psonce&n_PSO_t_FLAG is set but n_PO_t_FLAG is no more, From: will not
1022 * be assigned no more.
1023 * This calls expandaddr() on some headers and sets checkaddr_err if that is
1024 * not NULL -- note it explicitly allows EAF_NAME because aliases are not
1025 * expanded when this is called! */
1026 FL
void extract_header(FILE *fp
, struct header
*hp
,
1027 si8_t
*checkaddr_err
);
1029 /* Return the desired header line from the passed message
1030 * pointer (or NULL if the desired header field is not available).
1031 * If mult is zero, return the content of the first matching header
1032 * field only, the content of all matching header fields else */
1033 FL
char * hfield_mult(char const *field
, struct message
*mp
, int mult
);
1034 #define hfieldX(a, b) hfield_mult(a, b, 1)
1035 #define hfield1(a, b) hfield_mult(a, b, 0)
1037 /* Check whether the passed line is a header line of the desired breed.
1038 * Return the field body, or 0 */
1039 FL
char const * thisfield(char const *linebuf
, char const *field
);
1041 /* Get sender's name from this message. If the message has a bunch of arpanet
1042 * stuff in it, we may have to skin the name before returning it */
1043 FL
char * nameof(struct message
*mp
, int reptype
);
1045 /* Start of a "comment". Ignore it */
1046 FL
char const * skip_comment(char const *cp
);
1048 /* Return the start of a route-addr (address in angle brackets), if present */
1049 FL
char const * routeaddr(char const *name
);
1051 /* Query *expandaddr*, parse it and return flags.
1052 * The flags are already adjusted for n_PSO_INTERACTIVE, n_PO_TILDE_FLAG etc. */
1053 FL
enum expand_addr_flags
expandaddr_to_eaf(void);
1055 /* Check if an address is invalid, either because it is malformed or, if not,
1056 * according to eacm. Return FAL0 when it looks good, TRU1 if it is invalid
1057 * but the error condition wasn't covered by a 'hard "fail"ure', -1 otherwise */
1058 FL si8_t
is_addr_invalid(struct name
*np
,
1059 enum expand_addr_check_mode eacm
);
1061 /* Does *NP* point to a file or pipe addressee? */
1062 #define is_fileorpipe_addr(NP) \
1063 (((NP)->n_flags & NAME_ADDRSPEC_ISFILEORPIPE) != 0)
1065 /* Return skinned version of *NP*s name */
1066 #define skinned_name(NP) \
1067 (assert((NP)->n_flags & NAME_SKINNED), \
1068 ((struct name const*)NP)->n_name)
1070 /* Skin an address according to the RFC 822 interpretation of "host-phrase" */
1071 FL
char * skin(char const *name
);
1073 /* Skin *name* and extract the *addr-spec* according to RFC 5322.
1074 * Store the result in .ag_skinned and also fill in those .ag_ fields that have
1075 * actually been seen.
1076 * Return NULL on error, or name again, but which may have been replaced by
1077 * a version with fixed quotation etc.!
1078 * issingle_hack is a HACK that allows usage for `addrcodec' */
1079 FL
char const *n_addrspec_with_guts(struct n_addrguts
*agp
, char const *name
,
1080 bool_t doskin
, bool_t issingle_hack
);
1082 /* Fetch the real name from an internet mail address field */
1083 FL
char * realname(char const *name
);
1085 /* Fetch the sender's name from the passed message. reptype can be
1086 * 0 -- get sender's name for display purposes
1087 * 1 -- get sender's name for reply
1088 * 2 -- get sender's name for Reply */
1089 FL
char * name1(struct message
*mp
, int reptype
);
1091 /* Trim away all leading Re: etc., return pointer to plain subject.
1092 * Note it doesn't perform any MIME decoding by itself */
1093 FL
char const *subject_re_trim(char const *cp
);
1095 FL
int msgidcmp(char const *s1
, char const *s2
);
1097 /* Fake Sender for From_ lines if missing, e. g. with POP3 */
1098 FL
char const * fakefrom(struct message
*mp
);
1100 FL
char const * fakedate(time_t t
);
1102 /* From username Fri Jan 2 20:13:51 2004
1105 #if defined HAVE_IMAP_SEARCH || defined HAVE_IMAP
1106 FL
time_t unixtime(char const *from
);
1109 FL
time_t rfctime(char const *date
);
1111 FL
time_t combinetime(int year
, int month
, int day
,
1112 int hour
, int minute
, int second
);
1114 FL
void substdate(struct message
*m
);
1116 /* TODO Weird thing that tries to fill in From: and Sender: */
1117 FL
void setup_from_and_sender(struct header
*hp
);
1119 /* Note: returns 0x1 if both args were NULL */
1120 FL
struct name
const * check_from_and_sender(struct name
const *fromfield
,
1121 struct name
const *senderfield
);
1124 FL
char * getsender(struct message
*m
);
1127 /* Fill in / reedit the desired header fields */
1128 FL
int grab_headers(enum n_go_input_flags gif
, struct header
*hp
,
1129 enum gfield gflags
, int subjfirst
);
1131 /* Check whether sep->ss_sexpr (or ->ss_regex) matches any header of mp */
1132 FL bool_t
header_match(struct message
*mp
, struct search_expr
const *sep
);
1134 /* Query *customhdr* */
1135 FL
struct n_header_field
*n_customhdr_query(void);
1141 /* `(un)?headerpick' */
1142 FL
int c_headerpick(void *vp
);
1143 FL
int c_unheaderpick(void *vp
);
1145 /* TODO Compat variants of the c_(un)?h*() series,
1146 * except for `retain' and `ignore', which are standardized */
1147 FL
int c_retain(void *vp
);
1148 FL
int c_ignore(void *vp
);
1149 FL
int c_unretain(void *vp
);
1150 FL
int c_unignore(void *vp
);
1152 FL
int c_saveretain(void *v
);
1153 FL
int c_saveignore(void *v
);
1154 FL
int c_unsaveretain(void *v
);
1155 FL
int c_unsaveignore(void *v
);
1157 FL
int c_fwdretain(void *v
);
1158 FL
int c_fwdignore(void *v
);
1159 FL
int c_unfwdretain(void *v
);
1160 FL
int c_unfwdignore(void *v
);
1162 /* Ignore object lifecycle. (Most of the time this interface deals with
1163 * special n_IGNORE_* objects, e.g., n_IGNORE_TYPE, though.)
1164 * isauto: whether auto-reclaimed storage is to be used for allocations;
1165 * if so, _del() needn't be called */
1166 FL
struct n_ignore
*n_ignore_new(bool_t isauto
);
1167 FL
void n_ignore_del(struct n_ignore
*self
);
1169 /* Are there just _any_ user settings covered by self? */
1170 FL bool_t
n_ignore_is_any(struct n_ignore
const *self
);
1172 /* Set an entry to retain (or ignore).
1173 * Returns FAL0 if dat is not a valid header field name or an invalid regular
1174 * expression, TRU1 if insertion took place, and TRUM1 if already set */
1175 FL bool_t
n_ignore_insert(struct n_ignore
*self
, bool_t retain
,
1176 char const *dat
, size_t len
);
1177 #define n_ignore_insert_cp(SELF,RT,CP) n_ignore_insert(SELF, RT, CP, UIZ_MAX)
1179 /* Returns TRU1 if retained, TRUM1 if ignored, FAL0 if not covered */
1180 FL bool_t
n_ignore_lookup(struct n_ignore
const *self
, char const *dat
,
1182 #define n_ignore_lookup_cp(SELF,CP) n_ignore_lookup(SELF, CP, UIZ_MAX)
1183 #define n_ignore_is_ign(SELF,FDAT,FLEN) \
1184 (n_ignore_lookup(SELF, FDAT, FLEN) == TRUM1)
1190 /* Return -1 on invalid spec etc., the number of matches otherwise */
1191 #ifdef HAVE_IMAP_SEARCH
1192 FL ssize_t
imap_search(char const *spec
, int f
);
1199 /* Return a file buffer all ready to read up the passed message pointer */
1200 FL
FILE * setinput(struct mailbox
*mp
, struct message
*m
,
1201 enum needspec need
);
1204 FL
enum okay
get_body(struct message
*mp
);
1206 /* Reset (free) the global message array */
1207 FL
void message_reset(void);
1209 /* Append the passed message descriptor onto the message array; if mp is NULL,
1210 * NULLify the entry at &[msgCount-1] */
1211 FL
void message_append(struct message
*mp
);
1213 /* Append a NULL message */
1214 FL
void message_append_null(void);
1216 /* Check whether sep->ss_sexpr (or ->ss_regex) matches mp. If with_headers is
1217 * true then the headers will also be searched (as plain text) */
1218 FL bool_t
message_match(struct message
*mp
, struct search_expr
const *sep
,
1219 bool_t with_headers
);
1222 FL
struct message
* setdot(struct message
*mp
);
1224 /* Touch the named message by setting its MTOUCH flag. Touched messages have
1225 * the effect of not being sent back to the system mailbox on exit */
1226 FL
void touch(struct message
*mp
);
1228 /* Convert user string of message numbers and store the numbers into vector.
1229 * Returns the count of messages picked up or -1 on error */
1230 FL
int getmsglist(char const *buf
, int *vector
, int flags
);
1232 /* Find the first message whose flags&m==f and return its message number */
1233 FL
int first(int f
, int m
);
1235 /* Mark the named message by setting its mark bit */
1236 FL
void mark(int mesg
, int f
);
1242 FL
int maildir_setfile(char const *name
, enum fedit_mode fm
);
1244 FL bool_t
maildir_quit(bool_t hold_sigs_on
);
1246 FL
enum okay
maildir_append(char const *name
, FILE *fp
, long offset
);
1248 FL
enum okay
maildir_remove(char const *name
);
1252 * Heap memory and automatically reclaimed storage, plus pseudo "alloca"
1255 /* Called from the (main)loops upon tick and break-off time to perform debug
1256 * checking and memory cleanup, including stack-top of auto-reclaimed storage */
1257 FL
void n_memory_reset(void);
1259 /* Fixate the current snapshot of our global auto-reclaimed storage instance,
1260 * so that further allocations become auto-reclaimed.
1261 * This is only called from main.c for the global arena */
1262 FL
void n_memory_pool_fixate(void);
1264 /* Lifetime management of a per-execution level arena (to be found in
1265 * n_go_data_ctx.gdc_mempool, lazy initialized).
1266 * _push() can be used by anyone to create a new stack layer in the current
1267 * per-execution level arena, which is layered upon the normal one (usually
1268 * provided by .gdc__mempool_buf, initialized as necessary).
1269 * This can be pop()ped again: popping a stack will remove all stacks "above"
1270 * it, i.e., those which have been pushed thereafter.
1271 * If NULL is popped then this means that the current per-execution level is
1272 * left and n_go_data_ctx.gdc_mempool is not NULL; an event loop tick also
1273 * causes all _push()ed stacks to be dropped (via n_memory_reset()) */
1274 FL
void n_memory_pool_push(void *vp
);
1275 FL
void n_memory_pool_pop(void *vp
);
1277 /* Generic heap memory */
1279 FL
void *n_alloc(size_t s n_MEMORY_DEBUG_ARGS
);
1280 FL
void *n_realloc(void *v
, size_t s n_MEMORY_DEBUG_ARGS
);
1281 FL
void *n_calloc(size_t nmemb
, size_t size n_MEMORY_DEBUG_ARGS
);
1282 FL
void n_free(void *vp n_MEMORY_DEBUG_ARGS
);
1284 /* TODO obsolete c{m,re,c}salloc -> n_* */
1285 #ifdef HAVE_MEMORY_DEBUG
1286 # define n_alloc(S) (n_alloc)(S, __FILE__, __LINE__)
1287 # define n_realloc(P,S) (n_realloc)(P, S, __FILE__, __LINE__)
1288 # define n_calloc(N,S) (n_calloc)(N, S, __FILE__, __LINE__)
1289 # define n_free(P) (n_free)(P, __FILE__, __LINE__)
1290 # define free(P) (n_free)(P, __FILE__, __LINE__)
1292 # define n_free(P) free(P)
1294 #define smalloc(SZ) n_alloc(SZ)
1295 #define srealloc(P,SZ) n_realloc(P, SZ)
1296 #define scalloc(N,SZ) n_calloc(N, SZ)
1298 /* Fluctuating heap memory (supposed to exist for one command loop tick) */
1300 #define n_flux_alloc(S) n_alloc(S)
1301 #define n_flux_realloc(P,S) n_realloc(P, S)
1302 #define n_flux_calloc(N,S) n_calloc(N, S)
1303 #define n_flux_free(P) n_free(P)
1305 /* Auto-reclaimed storage */
1307 /* Lower memory pressure on auto-reclaimed storage for code which has
1308 * a sinus-curve looking style of memory usage, i.e., peak followed by release,
1309 * like, e.g., doing a task on all messages of a box in order.
1310 * Such code should call _create(), successively call _unroll() after
1311 * a single message has been handled, and finally _gut() */
1312 FL
void n_autorec_relax_create(void);
1313 FL
void n_autorec_relax_gut(void);
1314 FL
void n_autorec_relax_unroll(void);
1316 /* TODO obsolete srelax -> n_autorec_relax_* */
1317 #define srelax_hold() n_autorec_relax_create()
1318 #define srelax_rele() n_autorec_relax_gut()
1319 #define srelax() n_autorec_relax_unroll()
1321 /* Allocate size more bytes of space and return the address of the first byte
1322 * to the caller. An even number of bytes are always allocated so that the
1323 * space will always be on a word boundary */
1324 FL
void *n_autorec_alloc_from_pool(void *vp
, size_t size n_MEMORY_DEBUG_ARGS
);
1325 FL
void *n_autorec_calloc_from_pool(void *vp
, size_t nmemb
, size_t size
1326 n_MEMORY_DEBUG_ARGS
);
1327 #ifdef HAVE_MEMORY_DEBUG
1328 # define n_autorec_alloc_from_pool(VP,SZ) \
1329 (n_autorec_alloc_from_pool)(VP, SZ, __FILE__, __LINE__)
1330 # define n_autorec_calloc_from_pool(VP,NM,SZ) \
1331 (n_autorec_calloc_from_pool)(VP, NM, SZ, __FILE__, __LINE__)
1333 #define n_autorec_alloc(SZ) n_autorec_alloc_from_pool(NULL, SZ)
1334 #define n_autorec_calloc(NM,SZ) n_autorec_calloc_from_pool(NULL, NM, SZ)
1336 /* TODO obsolete c?salloc -> n_autorec_* */
1337 #define salloc(SZ) n_autorec_alloc_from_pool(NULL, SZ)
1338 #define csalloc(NM,SZ) n_autorec_calloc_from_pool(NULL, NM, SZ)
1340 /* Pseudo alloca (and also auto-reclaimed in _memory_reset()/_pool_pop()) */
1341 FL
void *n_lofi_alloc(size_t size n_MEMORY_DEBUG_ARGS
);
1342 FL
void n_lofi_free(void *vp n_MEMORY_DEBUG_ARGS
);
1344 #ifdef HAVE_MEMORY_DEBUG
1345 # define n_lofi_alloc(SZ) (n_lofi_alloc)(SZ, __FILE__, __LINE__)
1346 # define n_lofi_free(P) (n_lofi_free)(P, __FILE__, __LINE__)
1349 /* The snapshot can be used in a local context, in order to free many
1350 * allocations in one go */
1351 FL
void *n_lofi_snap_create(void);
1352 FL
void n_lofi_snap_unroll(void *cookie
);
1354 /* TODO obsolete ac_alloc / ac_free -> n_lofi_* */
1355 #define ac_alloc(SZ) n_lofi_alloc(SZ)
1356 #define ac_free(P) n_lofi_free(P)
1359 #ifdef HAVE_MEMORY_DEBUG
1360 FL
int c_memtrace(void *v
);
1362 /* For immediate debugging purposes, it is possible to check on request */
1363 FL bool_t
n__memory_check(char const *file
, int line
);
1364 # define n_memory_check() n__memory_check(__FILE__, __LINE__)
1366 # define n_memory_check() do{;}while(0)
1373 /* *sendcharsets* .. *charset-8bit* iterator; *a_charset_to_try_first* may be
1374 * used to prepend a charset to this list (e.g., for *reply-in-same-charset*).
1375 * The returned boolean indicates charset_iter_is_valid().
1376 * Without HAVE_ICONV, this "iterates" over *ttycharset* only */
1377 FL bool_t
charset_iter_reset(char const *a_charset_to_try_first
);
1378 FL bool_t
charset_iter_next(void);
1379 FL bool_t
charset_iter_is_valid(void);
1380 FL
char const * charset_iter(void);
1382 /* And this is (xxx temporary?) which returns the iterator if that is valid and
1383 * otherwise either *charset-8bit* or *ttycharset*, dep. on HAVE_ICONV */
1384 FL
char const * charset_iter_or_fallback(void);
1386 FL
void charset_iter_recurse(char *outer_storage
[2]); /* TODO LEGACY */
1387 FL
void charset_iter_restore(char *outer_storage
[2]); /* TODO LEGACY */
1389 /* Check whether our headers will need MIME conversion */
1391 FL
char const * need_hdrconv(struct header
*hp
);
1394 /* Convert header fields from RFC 1522 format */
1395 FL
void mime_fromhdr(struct str
const *in
, struct str
*out
,
1396 enum tdflags flags
);
1398 /* Interpret MIME strings in parts of an address field */
1399 FL
char * mime_fromaddr(char const *name
);
1401 /* fwrite(3) performing the given MIME conversion */
1402 FL ssize_t
mime_write(char const *ptr
, size_t size
, FILE *f
,
1403 enum conversion convert
, enum tdflags dflags
,
1404 struct quoteflt
*qf
, struct str
*outrest
,
1405 struct str
*inrest
);
1406 FL ssize_t
xmime_write(char const *ptr
, size_t size
, /* TODO LEGACY */
1407 FILE *f
, enum conversion convert
, enum tdflags dflags
);
1411 * Content-Transfer-Encodings as defined in RFC 2045 (and RFC 2047):
1412 * - Quoted-Printable, section 6.7
1413 * - Base64, section 6.8
1414 * TODO For now this is pretty mixed up regarding this external interface
1415 * TODO (and due to that the code is, too).
1416 * TODO In v15.0 CTE will be filter based, and explicit conversion will
1417 * TODO gain clear error codes
1420 /* Default MIME Content-Transfer-Encoding: as via *mime-encoding* */
1421 FL
enum mime_enc
mime_enc_target(void);
1423 /* Map from a Content-Transfer-Encoding: header body (which may be NULL) */
1424 FL
enum mime_enc
mime_enc_from_ctehead(char const *hbody
);
1426 /* XXX Try to get rid of that */
1427 FL
char const * mime_enc_from_conversion(enum conversion
const convert
);
1429 /* How many characters of (the complete body) ln need to be quoted.
1430 * Only MIMEEF_ISHEAD and MIMEEF_ISENCWORD are understood */
1431 FL
size_t mime_enc_mustquote(char const *ln
, size_t lnlen
,
1432 enum mime_enc_flags flags
);
1434 /* How much space is necessary to encode len bytes in QP, worst case.
1435 * Includes room for terminator, UIZ_MAX on overflow */
1436 FL
size_t qp_encode_calc_size(size_t len
);
1438 /* If flags includes QP_ISHEAD these assume "word" input and use special
1439 * quoting rules in addition; soft line breaks are not generated.
1440 * Otherwise complete input lines are assumed and soft line breaks are
1441 * generated as necessary. Return NULL on error (overflow) */
1442 FL
struct str
* qp_encode(struct str
*out
, struct str
const *in
,
1443 enum qpflags flags
);
1445 FL
struct str
* qp_encode_cp(struct str
*out
, char const *cp
,
1446 enum qpflags flags
);
1447 FL
struct str
* qp_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
1448 enum qpflags flags
);
1451 /* The buffers of out and *rest* will be managed via srealloc().
1452 * If inrest_or_null is needed but NULL an error occurs, otherwise tolerant.
1453 * Return FAL0 on error; caller is responsible to free buffers */
1454 FL bool_t
qp_decode_header(struct str
*out
, struct str
const *in
);
1455 FL bool_t
qp_decode_part(struct str
*out
, struct str
const *in
,
1456 struct str
*outrest
, struct str
*inrest_or_null
);
1458 /* How much space is necessary to encode len bytes in Base64, worst case.
1459 * Includes room for (CR/LF/CRLF and) terminator, UIZ_MAX on overflow */
1460 FL
size_t b64_encode_calc_size(size_t len
);
1462 /* Note these simply convert all the input (if possible), including the
1463 * insertion of NL sequences if B64_CRLF or B64_LF is set (and multiple thereof
1464 * if B64_MULTILINE is set).
1465 * Thus, in the B64_BUF case, better call b64_encode_calc_size() first.
1466 * Return NULL on error (overflow; cannot happen for B64_BUF) */
1467 FL
struct str
* b64_encode(struct str
*out
, struct str
const *in
,
1468 enum b64flags flags
);
1469 FL
struct str
* b64_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
1470 enum b64flags flags
);
1472 FL
struct str
* b64_encode_cp(struct str
*out
, char const *cp
,
1473 enum b64flags flags
);
1476 /* The _{header,part}() variants are failure tolerant, the latter requires
1477 * outrest to be set; due to the odd 4:3 relation inrest_or_null should be
1478 * given, _then_, it is an error if it is needed but not set.
1479 * TODO pre v15 callers should ensure that no endless loop is entered because
1480 * TODO the inrest cannot be converted and ends up as inrest over and over:
1481 * TODO give NULL to stop such loops.
1482 * The buffers of out and possibly *rest* will be managed via srealloc().
1483 * Returns FAL0 on error; caller is responsible to free buffers.
1484 * XXX FAL0 is effectively not returned for _part*() variants,
1485 * XXX (instead replacement characters are produced for invalid data.
1486 * XXX _Unless_ operation could EOVERFLOW.)
1487 * XXX I.e. this is bad and is tolerant for text and otherwise not */
1488 FL bool_t
b64_decode(struct str
*out
, struct str
const *in
);
1489 FL bool_t
b64_decode_header(struct str
*out
, struct str
const *in
);
1490 FL bool_t
b64_decode_part(struct str
*out
, struct str
const *in
,
1491 struct str
*outrest
, struct str
*inrest_or_null
);
1497 /* Get a mime style parameter from a header body */
1498 FL
char * mime_param_get(char const *param
, char const *headerbody
);
1500 /* Format parameter name to have value, salloc() it or NULL (error) in result.
1501 * 0 on error, 1 or -1 on success: the latter if result contains \n newlines,
1502 * which it will if the created param requires more than MIME_LINELEN bytes;
1503 * there is never a trailing newline character */
1504 /* TODO mime_param_create() should return a StrList<> or something.
1505 * TODO in fact it should take a HeaderField* and append a HeaderFieldParam*! */
1506 FL si8_t
mime_param_create(struct str
*result
, char const *name
,
1509 /* Get the boundary out of a Content-Type: multipart/xyz header field, return
1510 * salloc()ed copy of it; store strlen() in *len if set */
1511 FL
char * mime_param_boundary_get(char const *headerbody
, size_t *len
);
1513 /* Create a salloc()ed MIME boundary */
1514 FL
char * mime_param_boundary_create(void);
1520 /* Create MIME part object tree for and of mp */
1521 FL
struct mimepart
* mime_parse_msg(struct message
*mp
,
1522 enum mime_parse_flags mpf
);
1528 /* `(un)?mimetype' commands */
1529 FL
int c_mimetype(void *v
);
1530 FL
int c_unmimetype(void *v
);
1532 /* Check whether the Content-Type name is internally known */
1533 FL bool_t
n_mimetype_check_mtname(char const *name
);
1535 /* Return a Content-Type matching the name, or NULL if none could be found */
1536 FL
char *n_mimetype_classify_filename(char const *name
);
1538 /* Classify content of *fp* as necessary and fill in arguments; **charset* is
1539 * set to *charset-7bit* or charset_iter_or_fallback() if NULL */
1540 FL
enum conversion
n_mimetype_classify_file(FILE *fp
, char const **contenttype
,
1541 char const **charset
, int *do_iconv
);
1543 /* Dependend on *mime-counter-evidence* mpp->m_ct_type_usr_ovwr will be set,
1544 * but otherwise mpp is const */
1545 FL
enum mimecontent
n_mimetype_classify_part(struct mimepart
*mpp
);
1547 /* Query handler for a part, return the plain type (& MIME_HDL_TYPE_MASK).
1548 * mhp is anyway initialized (mh_flags, mh_msg) */
1549 FL
enum mime_handler_flags
n_mimetype_handler(struct mime_handler
*mhp
,
1550 struct mimepart
const *mpp
,
1551 enum sendaction action
);
1557 /* Allocate a single element of a name list, initialize its name field to the
1558 * passed name and return it */
1559 FL
struct name
* nalloc(char const *str
, enum gfield ntype
);
1561 /* Like nalloc(), but initialize from content of np */
1562 FL
struct name
* ndup(struct name
*np
, enum gfield ntype
);
1564 /* Concatenate the two passed name lists, return the result */
1565 FL
struct name
* cat(struct name
*n1
, struct name
*n2
);
1568 FL
struct name
* namelist_dup(struct name
const *np
, enum gfield ntype
);
1570 /* Determine the number of undeleted elements in a name list and return it;
1571 * the latter also doesn't count file and pipe addressees in addition */
1572 FL ui32_t
count(struct name
const *np
);
1573 FL ui32_t
count_nonlocal(struct name
const *np
);
1575 /* Extract a list of names from a line, and make a list of names from it.
1576 * Return the list or NULL if none found */
1577 FL
struct name
* extract(char const *line
, enum gfield ntype
);
1579 /* Like extract() unless line contains anyof ",\"\\(<|", in which case
1580 * comma-separated list extraction is used instead */
1581 FL
struct name
* lextract(char const *line
, enum gfield ntype
);
1583 /* Turn a list of names into a string of the same names */
1584 FL
char * detract(struct name
*np
, enum gfield ntype
);
1586 /* Get a lextract() list via n_go_input_cp(), reassigning to *np* */
1587 FL
struct name
* grab_names(enum n_go_input_flags gif
, char const *field
,
1588 struct name
*np
, int comma
, enum gfield gflags
);
1590 /* Check whether n1 n2 share the domain name */
1591 FL bool_t
name_is_same_domain(struct name
const *n1
,
1592 struct name
const *n2
);
1594 /* Check all addresses in np and delete invalid ones; if set_on_error is not
1595 * NULL it'll be set to TRU1 for error or -1 for "hard fail" error */
1596 FL
struct name
* checkaddrs(struct name
*np
, enum expand_addr_check_mode eacm
,
1597 si8_t
*set_on_error
);
1599 /* Vaporise all duplicate addresses in hp (.h_(to|cc|bcc)) so that an address
1600 * that "first" occurs in To: is solely in there, ditto Cc:, after expanding
1601 * aliases etc. eacm and set_on_error are passed to checkaddrs(), metoo is
1602 * passed to usermap(). After updating hp to the new state this returns
1603 * a flat list of all addressees, which may be NULL */
1604 FL
struct name
* namelist_vaporise_head(struct header
*hp
,
1605 enum expand_addr_check_mode eacm
, bool_t metoo
,
1606 si8_t
*set_on_error
);
1608 /* Map all of the aliased users in the invoker's mailrc file and insert them
1610 FL
struct name
* usermap(struct name
*names
, bool_t force_metoo
);
1612 /* Remove all of the duplicates from the passed name list by insertion sorting
1613 * them, then checking for dups. Return the head of the new list */
1614 FL
struct name
* elide(struct name
*names
);
1616 /* `(un)?alternates' deal with the list of alternate names */
1617 FL
int c_alternates(void *v
);
1618 FL
int c_unalternates(void *v
);
1620 /* If keep_single is set one alternates member will be allowed in np */
1621 FL
struct name
*n_alternates_remove(struct name
*np
, bool_t keep_single
);
1623 /* Likewise, is name an alternate in broadest sense? */
1624 FL bool_t
n_is_myname(char const *name
);
1627 FL
int c_addrcodec(void *vp
);
1629 /* `(un)?commandalias'.
1630 * And whether a `commandalias' name exists, returning name or NULL, pointing
1631 * expansion_or_null to expansion if set: both point into internal storage */
1632 FL
int c_commandalias(void *vp
);
1633 FL
int c_uncommandalias(void *vp
);
1635 FL
char const *n_commandalias_exists(char const *name
,
1636 struct str
const **expansion_or_null
);
1638 /* Is name a valid alias */
1639 FL bool_t
n_alias_is_valid_name(char const *name
);
1642 FL
int c_alias(void *v
);
1643 FL
int c_unalias(void *v
);
1645 /* `(un)?ml(ist|subscribe)', and a check whether a name is a (wanted) list */
1646 FL
int c_mlist(void *v
);
1647 FL
int c_unmlist(void *v
);
1648 FL
int c_mlsubscribe(void *v
);
1649 FL
int c_unmlsubscribe(void *v
);
1651 FL
enum mlist_state
is_mlist(char const *name
, bool_t subscribed_only
);
1653 /* `(un)?shortcut', and check if str is one, return expansion or NULL */
1654 FL
int c_shortcut(void *v
);
1655 FL
int c_unshortcut(void *v
);
1657 FL
char const * shortcut_expand(char const *str
);
1659 /* `(un)?charsetalias', and try to expand a charset, return mapping or itself */
1660 FL
int c_charsetalias(void *vp
);
1661 FL
int c_uncharsetalias(void *vp
);
1663 FL
char const *n_charsetalias_expand(char const *cp
);
1665 /* `(un)?filetype', and check whether file has a known (stat(2)ed) "equivalent",
1666 * as well as check whether (extension of) file is known, respectively;
1667 * res_or_null can be NULL, otherwise on success result data must be copied */
1668 FL
int c_filetype(void *vp
);
1669 FL
int c_unfiletype(void *vp
);
1671 FL bool_t
n_filetype_trial(struct n_file_type
*res_or_null
, char const *file
);
1672 FL bool_t
n_filetype_exists(struct n_file_type
*res_or_null
, char const *file
);
1678 /* Test to see if the passed file name is a directory, return true if it is.
1679 * If check_access is set, we also access(2): if it is TRUM1 only X_OK|R_OK is
1680 * tested, otherwise X_OK|R_OK|W_OK. */
1681 FL bool_t
n_is_dir(char const *name
, bool_t check_access
);
1683 /* Recursively create a directory */
1684 FL bool_t
n_path_mkdir(char const *name
);
1686 /* Delete a file, but only if the file is a plain file; return FAL0 on system
1687 * error and TRUM1 if name is not a plain file, return TRU1 on success */
1688 FL bool_t
n_path_rm(char const *name
);
1690 /* A get-wd..restore-wd approach */
1691 FL
enum okay
cwget(struct cw
*cw
);
1692 FL
enum okay
cwret(struct cw
*cw
);
1693 FL
void cwrelse(struct cw
*cw
);
1701 FL
enum okay
pop3_noop(void);
1704 FL
int pop3_setfile(char const *server
, enum fedit_mode fm
);
1707 FL
enum okay
pop3_header(struct message
*m
);
1710 FL
enum okay
pop3_body(struct message
*m
);
1713 FL bool_t
pop3_quit(bool_t hold_sigs_on
);
1714 #endif /* HAVE_POP3 */
1718 * Subprocesses, popen, but also file handling with registering
1721 /* For program startup in main.c: initialize process manager */
1722 FL
void n_child_manager_start(void);
1724 /* Notes: OF_CLOEXEC is implied in oflags, xflags may be NULL */
1725 FL
FILE * safe_fopen(char const *file
, char const *oflags
, int *xflags
);
1727 /* Notes: OF_CLOEXEC|OF_REGISTER are implied in oflags!
1728 * Exception is Fdopen() if nocloexec is TRU1, but otherwise even for it the fd
1729 * creator has to take appropriate steps in order to ensure this is true! */
1730 FL
FILE * Fopen(char const *file
, char const *oflags
);
1731 FL
FILE * Fdopen(int fd
, char const *oflags
, bool_t nocloexec
);
1733 FL
int Fclose(FILE *fp
);
1735 /* TODO: Should be Mailbox::create_from_url(URL::from_string(DATA))!
1736 * Open file according to oflags (see popen.c). Handles compressed files,
1737 * maildir etc. If ft_or_null is given it will be filled accordingly */
1738 FL
FILE * n_fopen_any(char const *file
, char const *oflags
,
1739 enum n_fopen_state
*fs_or_null
);
1741 /* Create a temporary file in *TMPDIR*, use namehint for its name (prefix
1742 * unless OF_SUFFIX is set, in which case namehint is an extension that MUST be
1743 * part of the resulting filename, otherwise Ftmp() will fail), store the
1744 * unique name in fn (unless OF_UNLINK is set in oflags), and return a stdio
1745 * FILE pointer with access oflags. OF_CLOEXEC is implied in oflags.
1746 * One of OF_WRONLY and OF_RDWR must be set. Mode of 0600 is implied */
1747 FL
FILE * Ftmp(char **fn
, char const *namehint
, enum oflags oflags
);
1749 /* If OF_HOLDSIGS was set when calling Ftmp(), then hold_all_sigs() had been
1750 * called: call this to unlink(2) and free *fn and to rele_all_sigs() */
1751 FL
void Ftmp_release(char **fn
);
1753 /* Free the resources associated with the given filename. To be called after
1755 FL
void Ftmp_free(char **fn
);
1757 /* Create a pipe and ensure CLOEXEC bit is set in both descriptors */
1758 FL bool_t
pipe_cloexec(int fd
[2]);
1761 * env_addon may be NULL, otherwise it is expected to be a NULL terminated
1762 * array of "K=V" strings to be placed into the childs environment.
1763 * If cmd==(char*)-1 then shell is indeed expected to be a PTF :P that will be
1764 * called from within the child process.
1765 * n_psignal() takes a FILE* returned by Popen, and returns <0 if no process
1766 * can be found, 0 on success, and an errno number on kill(2) failure */
1767 FL
FILE *Popen(char const *cmd
, char const *mode
, char const *shell
,
1768 char const **env_addon
, int newfd1
);
1769 FL bool_t
Pclose(FILE *fp
, bool_t dowait
);
1770 VL
int n_psignal(FILE *fp
, int sig
);
1772 /* In n_PSO_INTERACTIVE, we want to go over $PAGER.
1773 * These are specialized version of Popen()/Pclose() which also encapsulate
1774 * error message printing, terminal handling etc. additionally */
1775 FL
FILE * n_pager_open(void);
1776 FL bool_t
n_pager_close(FILE *fp
);
1779 FL
void close_all_files(void);
1781 /* Run a command without a shell, with optional arguments and splicing of stdin
1782 * and stdout. FDs may also be n_CHILD_FD_NULL and n_CHILD_FD_PASS, meaning
1783 * to redirect from/to /dev/null or pass through our own set of FDs; in the
1784 * latter case terminal capabilities are saved/restored if possible.
1785 * The command name can be a sequence of words.
1786 * Signals must be handled by the caller. "Mask" contains the signals to
1787 * ignore in the new process. SIGINT is enabled unless it's in the mask.
1788 * If env_addon_or_null is set, it is expected to be a NULL terminated
1789 * array of "K=V" strings to be placed into the childs environment.
1790 * wait_status_or_null is set to waitpid(2) status if given */
1791 FL
int n_child_run(char const *cmd
, sigset_t
*mask
, int infd
, int outfd
,
1792 char const *a0_or_null
, char const *a1_or_null
, char const *a2_or_null
,
1793 char const **env_addon_or_null
, int *wait_status_or_null
);
1795 /* Like n_child_run(), but don't wait for the command to finish (use
1796 * n_child_wait() for waiting on a successful return value).
1797 * Also it is usually an error to use n_CHILD_FD_PASS for this one */
1798 FL
int n_child_start(char const *cmd
, sigset_t
*mask
, int infd
, int outfd
,
1799 char const *a0_or_null
, char const *a1_or_null
, char const *a2_or_null
,
1800 char const **env_addon_or_null
);
1802 /* Fork a child process, enable the other three:
1803 * - in-child image preparation
1804 * - mark a child as don't care
1805 * - wait for child pid, return whether we've had a normal n_EXIT_OK exit.
1806 * If wait_status_or_null is set, it is set to the waitpid(2) status */
1807 FL
int n_child_fork(void);
1808 FL
void n_child_prepare(sigset_t
*nset
, int infd
, int outfd
);
1809 FL
void n_child_free(int pid
);
1810 FL bool_t
n_child_wait(int pid
, int *wait_status_or_null
);
1816 /* Save all of the undetermined messages at the top of "mbox". Save all
1817 * untouched messages back in the system mailbox. Remove the system mailbox,
1818 * if none saved there.
1819 * TODO v15 Note: assumes hold_sigs() has been called _and_ can be temporarily
1820 * TODO dropped via a single rele_sigs() if hold_sigs_on */
1821 FL bool_t
quit(bool_t hold_sigs_on
);
1823 /* Adjust the message flags in each message */
1824 FL
int holdbits(void);
1826 /* Create another temporary file and copy user's mbox file darin. If there is
1827 * no mbox, copy nothing. If he has specified "append" don't copy his mailbox,
1828 * just copy saveable entries at the end */
1829 FL
enum okay
makembox(void);
1831 FL
void save_mbox_for_possible_quitstuff(void); /* TODO DROP IF U CAN */
1833 FL
int savequitflags(void);
1835 FL
void restorequitflags(int);
1841 /* Send message described by the passed pointer to the passed output buffer.
1842 * Return -1 on error. Adjust the status: field if need be. If doitp is
1843 * given, suppress ignored header fields. prefix is a string to prepend to
1844 * each output line. action = data destination
1845 * (SEND_MBOX,_TOFILE,_TODISP,_QUOTE,_DECRYPT). stats[0] is line count,
1846 * stats[1] is character count. stats may be NULL. Note that stats[0] is
1847 * valid for SEND_MBOX only */
1848 FL
int sendmp(struct message
*mp
, FILE *obuf
,
1849 struct n_ignore
const *doitp
,
1850 char const *prefix
, enum sendaction action
, ui64_t
*stats
);
1856 /* Interface between the argument list and the mail1 routine which does all the
1858 FL
int mail(struct name
*to
, struct name
*cc
, struct name
*bcc
,
1859 char const *subject
, struct attachment
*attach
,
1860 char const *quotefile
, int recipient_record
);
1862 /* `mail' and `Mail' commands, respectively */
1863 FL
int c_sendmail(void *v
);
1864 FL
int c_Sendmail(void *v
);
1866 /* Mail a message on standard input to the people indicated in the passed
1867 * header. (Internal interface) */
1868 FL
enum okay
mail1(struct header
*hp
, int printheaders
,
1869 struct message
*quote
, char const *quotefile
,
1870 int recipient_record
, int doprefix
);
1872 /* Create a Date: header field.
1873 * We compare the localtime() and gmtime() results to get the timezone, because
1874 * numeric timezones are easier to read and because $TZ isn't always set */
1875 FL
int mkdate(FILE *fo
, char const *field
);
1877 /* Dump the to, subject, cc header on the passed file buffer.
1878 * nosend_msg tells us not to dig to deep but to instead go for compose mode or
1879 * editing a message (yet we're stupid and cannot do it any better) - if it is
1880 * TRUM1 then we're really in compose mode and will produce some fields for
1881 * easier filling in */
1882 FL
int puthead(bool_t nosend_msg
, struct header
*hp
, FILE *fo
,
1883 enum gfield w
, enum sendaction action
,
1884 enum conversion convert
, char const *contenttype
,
1885 char const *charset
);
1888 FL
enum okay
resend_msg(struct message
*mp
, struct header
*hp
,
1892 FL
void savedeadletter(FILE *fp
, bool_t fflush_rewind_first
);
1898 /* Evaluate the string given as a new mailbox name. Supported meta characters:
1899 * . % for my system mail box
1900 * . %user for user's system mail box
1901 * . # for previous file
1902 * . & invoker's mbox file
1903 * . +file file in folder directory
1904 * . any shell meta character (except for FEXP_NSHELL).
1905 * a poor man's vis(3), on name before calling this (and showing the user).
1906 * If FEXP_MULTIOK is set we return an array of terminated strings, the (last)
1907 * result string is terminated via \0\0 and n_PS_EXPAND_MULTIRESULT is set.
1908 * Returns the file name as an auto-reclaimed string */
1909 FL
char *fexpand(char const *name
, enum fexp_mode fexpm
);
1911 /* Parse the next shell token from input (->s and ->l are adjusted to the
1912 * remains, data is constant beside that; ->s may be NULL if ->l is 0, if ->l
1913 * EQ UIZ_MAX strlen(->s) is used) and append the resulting output to store.
1914 * If cookie is not NULL and we're in double-quotes then ${@} will be exploded
1915 * just as known from the sh(1)ell in that case */
1916 FL
enum n_shexp_state
n_shexp_parse_token(enum n_shexp_parse_flags flags
,
1917 struct n_string
*store
, struct str
*input
,
1918 void const **cookie
);
1920 /* Quick+dirty simplified : if an error occurs, returns a copy of *cp and set
1921 * *cp to NULL, otherwise advances *cp to over the parsed token */
1922 FL
char *n_shexp_parse_token_cp(enum n_shexp_parse_flags flags
,
1925 /* Quote input in a way that can, in theory, be fed into parse_token() again.
1926 * ->s may be NULL if ->l is 0, if ->l EQ UIZ_MAX strlen(->s) is used.
1927 * If rndtrip is true we try to make the resulting string "portable" (by
1928 * converting Unicode to \u etc.), otherwise we produce something to be
1929 * consumed "now", i.e., to display for the user.
1930 * Resulting output is _appended_ to store.
1931 * TODO Note: last resort, since \u and $ expansions etc. are necessarily
1932 * TODO already expanded and can thus not be reverted, but ALL we have */
1933 FL
struct n_string
*n_shexp_quote(struct n_string
*store
,
1934 struct str
const *input
, bool_t rndtrip
);
1935 FL
char *n_shexp_quote_cp(char const *cp
, bool_t rndtrip
);
1937 /* Can name be used as a variable name? I.e., this returns false for special
1938 * parameter names like $# etc. */
1939 FL bool_t
n_shexp_is_valid_varname(char const *name
);
1942 FL
int c_shcodec(void *vp
);
1949 FL
int c_sigstate(void *);
1952 FL
void n_raise(int signo
);
1954 /* Provide BSD-like signal() on all systems TODO v15 -> SysV -> n_signal() */
1955 FL sighandler_type
safe_signal(int signum
, sighandler_type handler
);
1957 /* Provide reproducable non-restartable signal handler installation */
1958 FL n_sighdl_t
n_signal(int signo
, n_sighdl_t hdl
);
1960 /* Hold *all* signals but SIGCHLD, and release that total block again */
1961 FL
void hold_all_sigs(void);
1962 FL
void rele_all_sigs(void);
1964 /* Hold HUP/QUIT/INT */
1965 FL
void hold_sigs(void);
1966 FL
void rele_sigs(void);
1968 /* Call _ENTER_SWITCH() with the according flags, it'll take care for the rest
1969 * and also set the jump buffer - it returns 0 if anything went fine and
1970 * a signal number if a jump occurred, in which case all handlers requested in
1971 * flags are temporarily SIG_IGN.
1972 * _cleanup_ping() informs the condome that no jumps etc. shall be performed
1973 * until _leave() is called in the following -- to be (optionally) called right
1974 * before the local jump label is reached which is jumped to after a long jump
1975 * occurred, straight code flow provided, e.g., to avoid destructors to be
1976 * called twice. _leave() must always be called last, reraise_flags will be
1977 * used to decide how signal handling has to continue
1979 #define n_SIGMAN_ENTER_SWITCH(S,F) do{\
1982 if(sigsetjmp((S)->sm_jump, 1))\
1986 n__sigman_enter(S, __x__);\
1987 }while(0); switch((S)->sm_signo)
1988 FL
int n__sigman_enter(struct n_sigman
*self
, int flags
);
1989 FL
void n_sigman_cleanup_ping(struct n_sigman
*self
);
1990 FL
void n_sigman_leave(struct n_sigman
*self
, enum n_sigman_flags flags
);
1992 /* Pending signal or 0? */
1993 FL
int n_sigman_peek(void);
1994 FL
void n_sigman_consume(void);
1996 /* Not-Yet-Dead debug information (handler installation in main.c) */
1997 #if defined HAVE_DEBUG || defined HAVE_DEVEL
1998 FL
void _nyd_chirp(ui8_t act
, char const *file
, ui32_t line
,
2000 FL
void _nyd_oncrash(int signo
);
2003 # define NYD_ENTER _nyd_chirp(1, __FILE__, __LINE__, __FUN__)
2004 # define NYD_LEAVE _nyd_chirp(2, __FILE__, __LINE__, __FUN__)
2005 # define NYD _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
2006 # define NYD_X _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
2008 # define NYD2_ENTER _nyd_chirp(1, __FILE__, __LINE__, __FUN__)
2009 # define NYD2_LEAVE _nyd_chirp(2, __FILE__, __LINE__, __FUN__)
2010 # define NYD2 _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
2016 # define NYD_ENTER do {} while (0)
2017 # define NYD_LEAVE do {} while (0)
2018 # define NYD do {} while (0)
2019 # define NYD_X do {} while (0) /* XXX LEGACY */
2022 # define NYD2_ENTER do {} while (0)
2023 # define NYD2_LEAVE do {} while (0)
2024 # define NYD2 do {} while (0)
2032 /* Send a message via SMTP */
2033 FL bool_t
smtp_mta(struct sendbundle
*sbp
);
2041 FL bool_t
sopen(struct sock
*sp
, struct url
*urlp
);
2042 FL
int sclose(struct sock
*sp
);
2043 FL
enum okay
swrite(struct sock
*sp
, char const *data
);
2044 FL
enum okay
swrite1(struct sock
*sp
, char const *data
, int sz
,
2048 FL
int sgetline(char **line
, size_t *linesize
, size_t *linelen
,
2049 struct sock
*sp n_MEMORY_DEBUG_ARGS
);
2050 # ifdef HAVE_MEMORY_DEBUG
2051 # define sgetline(A,B,C,D) sgetline(A, B, C, D, __FILE__, __LINE__)
2060 /* Direct mappings of the various spam* commands */
2061 FL
int c_spam_clear(void *v
);
2062 FL
int c_spam_set(void *v
);
2063 FL
int c_spam_forget(void *v
);
2064 FL
int c_spam_ham(void *v
);
2065 FL
int c_spam_rate(void *v
);
2066 FL
int c_spam_spam(void *v
);
2075 FL
void ssl_set_verify_level(struct url
const *urlp
);
2078 FL
enum okay
ssl_verify_decide(void);
2081 FL
enum okay
smime_split(FILE *ip
, FILE **hp
, FILE **bp
, long xcount
,
2085 FL
FILE * smime_sign_assemble(FILE *hp
, FILE *bp
, FILE *sp
,
2086 char const *message_digest
);
2089 FL
FILE * smime_encrypt_assemble(FILE *hp
, FILE *yp
);
2092 FL
struct message
* smime_decrypt_assemble(struct message
*m
, FILE *hp
,
2096 FL
int c_certsave(void *v
);
2099 FL
enum okay
rfc2595_hostname_match(char const *host
, char const *pattern
);
2106 /* Return a pointer to a dynamic copy of the argument */
2107 FL
char * savestr(char const *str n_MEMORY_DEBUG_ARGS
);
2108 FL
char * savestrbuf(char const *sbuf
, size_t slen n_MEMORY_DEBUG_ARGS
);
2109 #ifdef HAVE_MEMORY_DEBUG
2110 # define savestr(CP) savestr(CP, __FILE__, __LINE__)
2111 # define savestrbuf(CBP,CBL) savestrbuf(CBP, CBL, __FILE__, __LINE__)
2114 /* Concatenate cp2 onto cp1 (if not NULL), separated by sep (if not '\0') */
2115 FL
char * savecatsep(char const *cp1
, char sep
, char const *cp2
2116 n_MEMORY_DEBUG_ARGS
);
2117 #ifdef HAVE_MEMORY_DEBUG
2118 # define savecatsep(S1,SEP,S2) savecatsep(S1, SEP, S2, __FILE__, __LINE__)
2121 /* Make copy of argument incorporating old one, if set, separated by space */
2122 #define save2str(S,O) savecatsep(O, ' ', S)
2125 #define savecat(S1,S2) savecatsep(S1, '\0', S2)
2127 /* Create duplicate, lowercasing all characters along the way */
2128 FL
char * i_strdup(char const *src n_MEMORY_DEBUG_ARGS
);
2129 #ifdef HAVE_MEMORY_DEBUG
2130 # define i_strdup(CP) i_strdup(CP, __FILE__, __LINE__)
2134 FL
struct str
* str_concat_csvl(struct str
*self
, ...);
2137 FL
struct str
* str_concat_cpa(struct str
*self
, char const * const *cpa
,
2138 char const *sep_o_null n_MEMORY_DEBUG_ARGS
);
2139 #ifdef HAVE_MEMORY_DEBUG
2140 # define str_concat_cpa(S,A,N) str_concat_cpa(S, A, N, __FILE__, __LINE__)
2143 /* Plain char* support, not auto-reclaimed (unless noted) */
2145 /* Are any of the characters in the two strings the same? */
2146 FL bool_t
n_anyof_buf(char const *template, char const *dat
, size_t len
);
2147 #define n_anyof_cp(S1,S2) n_anyof_buf(S1, S2, UIZ_MAX)
2148 #define anyof(S1,S2) n_anyof_buf(S1, S2, UIZ_MAX)
2150 /* Treat *iolist as a sep separated list of strings; find and return the
2151 * next entry, trimming surrounding whitespace, and point *iolist to the next
2152 * entry or to NULL if no more entries are contained. If ignore_empty is
2153 * set empty entries are started over.
2154 * See n_shexp_parse_token() for the new way that supports sh(1) quoting.
2155 * Return NULL or an entry */
2156 FL
char * n_strsep(char **iolist
, char sep
, bool_t ignore_empty
);
2158 /* Copy a string, lowercasing it as we go; *size* is buffer size of *dest*;
2159 * *dest* will always be terminated unless *size* is 0 */
2160 FL
void i_strcpy(char *dest
, char const *src
, size_t size
);
2162 /* Is *as1* a valid prefix of *as2*? */
2163 FL bool_t
is_prefix(char const *as1
, char const *as2
);
2165 /* Reverse solidus quote (" and \) v'alue, and return salloc()ed result */
2166 FL
char * string_quote(char const *v
);
2168 /* Get (and isolate) the last, possibly quoted part of linebuf, set *needs_list
2169 * to indicate whether getmsglist() et al need to be called to collect
2170 * additional args that remain in linebuf. If strip is true possibly
2171 * surrounding quote characters are removed. Return NULL on "error" */
2172 FL
char * laststring(char *linebuf
, bool_t
*needs_list
, bool_t strip
);
2174 /* Convert a string to lowercase, in-place and with multibyte-aware */
2175 FL
void makelow(char *cp
);
2177 /* Is *sub* a substring of *str*, case-insensitive and multibyte-aware? */
2178 FL bool_t
substr(char const *str
, char const *sub
);
2181 FL
char * sstpcpy(char *dst
, char const *src
);
2182 FL
char * sstrdup(char const *cp n_MEMORY_DEBUG_ARGS
);
2183 FL
char * sbufdup(char const *cp
, size_t len n_MEMORY_DEBUG_ARGS
);
2184 #ifdef HAVE_MEMORY_DEBUG
2185 # define sstrdup(CP) sstrdup(CP, __FILE__, __LINE__)
2186 # define sbufdup(CP,L) sbufdup(CP, L, __FILE__, __LINE__)
2189 /* Copy at most dstsize bytes of src to dst and return string length.
2190 * Returns -E2BIG if dst is not large enough; dst will always be terminated
2191 * unless dstsize was 0 on entry */
2192 FL ssize_t
n_strscpy(char *dst
, char const *src
, size_t dstsize
);
2194 /* Case-independent ASCII comparisons */
2195 FL
int asccasecmp(char const *s1
, char const *s2
);
2196 FL
int ascncasecmp(char const *s1
, char const *s2
, size_t sz
);
2198 /* Case-independent ASCII string find s2 in s1, return it or NULL */
2199 FL
char const *asccasestr(char const *s1
, char const *s2
);
2201 /* Case-independent ASCII check whether as1 is the initial substring of as2 */
2202 FL bool_t
is_asccaseprefix(char const *as1
, char const *as2
);
2203 FL bool_t
is_ascncaseprefix(char const *as1
, char const *as2
, size_t sz
);
2205 /* struct str related support funs TODO _cp->_cs! */
2207 /* *self->s* is srealloc()ed */
2208 #define n_str_dup(S, T) n_str_assign_buf((S), (T)->s, (T)->l)
2210 /* *self->s* is srealloc()ed; if buflen==UIZ_MAX strlen() is called unless buf
2211 * is NULL; buf may be NULL if buflen is 0 */
2212 FL
struct str
* n_str_assign_buf(struct str
*self
,
2213 char const *buf
, uiz_t buflen n_MEMORY_DEBUG_ARGS
);
2214 #define n_str_assign(S, T) n_str_assign_buf(S, (T)->s, (T)->l)
2215 #define n_str_assign_cp(S, CP) n_str_assign_buf(S, CP, UIZ_MAX)
2217 /* *self->s* is srealloc()ed, *self->l* incremented; if buflen==UIZ_MAX
2218 * strlen() is called unless buf is NULL; buf may be NULL if buflen is 0 */
2219 FL
struct str
* n_str_add_buf(struct str
*self
, char const *buf
, uiz_t buflen
2220 n_MEMORY_DEBUG_ARGS
);
2221 #define n_str_add(S, T) n_str_add_buf(S, (T)->s, (T)->l)
2222 #define n_str_add_cp(S, CP) n_str_add_buf(S, CP, UIZ_MAX)
2224 #ifdef HAVE_MEMORY_DEBUG
2225 # define n_str_assign_buf(S,B,BL) n_str_assign_buf(S, B, BL, __FILE__, __LINE__)
2226 # define n_str_add_buf(S,B,BL) n_str_add_buf(S, B, BL, __FILE__, __LINE__)
2229 /* Remove leading and trailing spacechar()s and *ifs-ws*, respectively.
2230 * The ->s and ->l of the string will be adjusted, but no NUL termination will
2231 * be applied to a possibly adjusted buffer!
2232 * If dofaults is set, " \t\n" is always trimmed (in addition) */
2233 FL
struct str
*n_str_trim(struct str
*self
);
2234 FL
struct str
*n_str_trim_ifs(struct str
*self
, bool_t dodefaults
);
2237 * May have NULL buffer, may contain embedded NULs */
2239 /* Lifetime. n_string_gut() is optional for _creat_auto() strings */
2240 #define n_string_creat(S) \
2241 ((S)->s_dat = NULL, (S)->s_len = (S)->s_auto = (S)->s_size = 0, (S))
2242 #define n_string_creat_auto(S) \
2243 ((S)->s_dat = NULL, (S)->s_len = (S)->s_size = 0, (S)->s_auto = TRU1, (S))
2244 #define n_string_gut(S) ((S)->s_size != 0 ? (void)n_string_clear(S) : (void)0)
2246 /* Truncate to size, which must be LE current length */
2247 #define n_string_trunc(S,L) \
2248 (assert(UICMP(z, L, <=, (S)->s_len)), (S)->s_len = (ui32_t)(L), (S))
2250 /* Check whether a buffer of Len bytes can be inserted into Self */
2251 #define n_string_can_swallow(S,L) \
2252 (UICMP(z, SI32_MAX - n_ALIGN(1), >=, L) &&\
2253 UICMP(z, SI32_MAX - n_ALIGN(1) - (L), >, (S)->s_len))
2255 /* Take/Release buffer ownership */
2256 #define n_string_take_ownership(SP,B,S,L) \
2257 (assert((SP)->s_dat == NULL), assert((S) == 0 || (B) != NULL),\
2258 assert((L) < (S) || (L) == 0),\
2259 (SP)->s_dat = (B), (SP)->s_len = (L), (SP)->s_size = (S), (SP))
2260 #define n_string_drop_ownership(SP) \
2261 ((SP)->s_dat = NULL, (SP)->s_len = (SP)->s_size = 0, (SP))
2263 /* Release all memory */
2264 FL
struct n_string
*n_string_clear(struct n_string
*self n_MEMORY_DEBUG_ARGS
);
2266 #ifdef HAVE_MEMORY_DEBUG
2267 # define n_string_clear(S) \
2268 ((S)->s_size != 0 ? (n_string_clear)(S, __FILE__, __LINE__) : (S))
2270 # define n_string_clear(S) ((S)->s_size != 0 ? (n_string_clear)(S) : (S))
2273 /* Reserve room for noof additional bytes, but don't adjust length (yet) */
2274 FL
struct n_string
*n_string_reserve(struct n_string
*self
, size_t noof
2275 n_MEMORY_DEBUG_ARGS
);
2277 /* Resize to exactly nlen bytes; any new storage isn't initialized */
2278 FL
struct n_string
*n_string_resize(struct n_string
*self
, size_t nlen
2279 n_MEMORY_DEBUG_ARGS
);
2281 #ifdef HAVE_MEMORY_DEBUG
2282 # define n_string_reserve(S,N) (n_string_reserve)(S, N, __FILE__, __LINE__)
2283 # define n_string_resize(S,N) (n_string_resize)(S, N, __FILE__, __LINE__)
2287 FL
struct n_string
*n_string_push_buf(struct n_string
*self
, char const *buf
,
2288 size_t buflen n_MEMORY_DEBUG_ARGS
);
2289 #define n_string_push(S, T) n_string_push_buf(S, (T)->s_len, (T)->s_dat)
2290 #define n_string_push_cp(S,CP) n_string_push_buf(S, CP, UIZ_MAX)
2291 FL
struct n_string
*n_string_push_c(struct n_string
*self
, char c
2292 n_MEMORY_DEBUG_ARGS
);
2294 #define n_string_assign(S,T) ((S)->s_len = 0, n_string_push(S, T))
2295 #define n_string_assign_c(S,C) ((S)->s_len = 0, n_string_push_c(S, C))
2296 #define n_string_assign_cp(S,CP) ((S)->s_len = 0, n_string_push_cp(S, CP))
2297 #define n_string_assign_buf(S,B,BL) \
2298 ((S)->s_len = 0, n_string_push_buf(S, B, BL))
2300 #ifdef HAVE_MEMORY_DEBUG
2301 # define n_string_push_buf(S,B,BL) \
2302 n_string_push_buf(S, B, BL, __FILE__, __LINE__)
2303 # define n_string_push_c(S,C) n_string_push_c(S, C, __FILE__, __LINE__)
2307 FL
struct n_string
*n_string_unshift_buf(struct n_string
*self
, char const *buf
,
2308 size_t buflen n_MEMORY_DEBUG_ARGS
);
2309 #define n_string_unshift(S,T) \
2310 n_string_unshift_buf(S, (T)->s_len, (T)->s_dat)
2311 #define n_string_unshift_cp(S,CP) \
2312 n_string_unshift_buf(S, CP, UIZ_MAX)
2313 FL
struct n_string
*n_string_unshift_c(struct n_string
*self
, char c
2314 n_MEMORY_DEBUG_ARGS
);
2316 #ifdef HAVE_MEMORY_DEBUG
2317 # define n_string_unshift_buf(S,B,BL) \
2318 n_string_unshift_buf(S,B,BL, __FILE__, __LINE__)
2319 # define n_string_unshift_c(S,C) n_string_unshift_c(S, C, __FILE__, __LINE__)
2323 FL
struct n_string
*n_string_insert_buf(struct n_string
*self
, size_t idx
,
2324 char const *buf
, size_t buflen n_MEMORY_DEBUG_ARGS
);
2325 #define n_string_insert(S,I,T) \
2326 n_string_insert_buf(S, I, (T)->s_len, (T)->s_dat)
2327 #define n_string_insert_cp(S,I,CP) \
2328 n_string_insert_buf(S, I, CP, UIZ_MAX)
2329 FL
struct n_string
*n_string_insert_c(struct n_string
*self
, size_t idx
,
2330 char c n_MEMORY_DEBUG_ARGS
);
2332 #ifdef HAVE_MEMORY_DEBUG
2333 # define n_string_insert_buf(S,I,B,BL) \
2334 n_string_insert_buf(S, I, B, BL, __FILE__, __LINE__)
2335 # define n_string_insert_c(S,I,C) n_string_insert_c(S, I, C, __FILE__, __LINE__)
2339 FL
struct n_string
*n_string_cut(struct n_string
*self
, size_t idx
, size_t len
);
2341 /* Ensure self has a - NUL terminated - buffer, and return that.
2342 * The latter may return the pointer to an internal empty RODATA instead */
2343 FL
char * n_string_cp(struct n_string
*self n_MEMORY_DEBUG_ARGS
);
2344 FL
char const *n_string_cp_const(struct n_string
const *self
);
2346 #ifdef HAVE_MEMORY_DEBUG
2347 # define n_string_cp(S) n_string_cp(S, __FILE__, __LINE__)
2351 n_INLINE
struct n_string
*
2352 (n_string_creat
)(struct n_string
*self
){
2353 return n_string_creat(self
);
2355 # undef n_string_creat
2357 n_INLINE
struct n_string
*
2358 (n_string_creat_auto
)(struct n_string
*self
){
2359 return n_string_creat_auto(self
);
2361 # undef n_string_creat_auto
2364 (n_string_gut
)(struct n_string
*self
){
2367 # undef n_string_gut
2369 n_INLINE
struct n_string
*
2370 (n_string_trunc
)(struct n_string
*self
, size_t l
){
2371 return n_string_trunc(self
, l
);
2373 # undef n_string_trunc
2375 n_INLINE
struct n_string
*
2376 (n_string_drop_ownership
)(struct n_string
*self
){
2377 return n_string_drop_ownership(self
);
2379 # undef n_string_drop_ownership
2380 #endif /* HAVE_INLINE */
2382 /* UTF-8 / UTF-32 stuff */
2384 /* ..and update arguments to point after range; returns UI32_MAX on error, in
2385 * which case the arguments will have been stepped one byte */
2386 FL ui32_t
n_utf8_to_utf32(char const **bdat
, size_t *blen
);
2388 /* buf must be large enough also for NUL, it's new length will be returned */
2389 FL
size_t n_utf32_to_utf8(ui32_t c
, char *buf
);
2391 /* Our iconv(3) wrappers */
2394 FL iconv_t
n_iconv_open(char const *tocode
, char const *fromcode
);
2395 /* If *cd* == *iconvd*, assigns -1 to the latter */
2396 FL
void n_iconv_close(iconv_t cd
);
2398 /* Reset encoding state */
2399 FL
void n_iconv_reset(iconv_t cd
);
2401 /* iconv(3), but return n_err_no or 0 upon success.
2402 * The err_no may be ERR_NOENT unless n_ICONV_IGN_NOREVERSE is set in icf.
2403 * iconv_str() auto-grows on ERR_2BIG errors; in and in_rest_or_null may be
2405 * Note: ERR_INVAL (incomplete sequence at end of input) is NOT handled, so the
2406 * replacement character must be added manually if that happens at EOF! */
2407 FL
int n_iconv_buf(iconv_t cd
, enum n_iconv_flags icf
,
2408 char const **inb
, size_t *inbleft
,
2409 char **outb
, size_t *outbleft
);
2410 FL
int n_iconv_str(iconv_t icp
, enum n_iconv_flags icf
,
2411 struct str
*out
, struct str
const *in
,
2412 struct str
*in_rest_or_null
);
2414 /* If tocode==NULL, uses *ttycharset*. If fromcode==NULL, uses UTF-8.
2415 * Returns a salloc()ed buffer or NULL */
2416 FL
char * n_iconv_onetime_cp(enum n_iconv_flags icf
,
2417 char const *tocode
, char const *fromcode
, char const *input
);
2422 * This is a little bit hairy since it provides some stuff even if HAVE_TERMCAP
2423 * is false due to encapsulation desire
2427 /* termcap(3) / xy lifetime handling -- only called if we're n_PSO_INTERACTIVE
2428 * but not doing something in n_PO_QUICKRUN_MASK */
2429 FL
void n_termcap_init(void);
2430 FL
void n_termcap_destroy(void);
2432 /* enter_ca_mode / enable keypad (both if possible).
2433 * TODO When complete is not set we won't enter_ca_mode, for example: we don't
2434 * TODO want a complete screen clearance after $PAGER returned after displaying
2435 * TODO a mail, because otherwise the screen would look differently for normal
2436 * TODO stdout display messages. Etc. */
2437 # ifdef HAVE_TERMCAP
2438 FL
void n_termcap_resume(bool_t complete
);
2439 FL
void n_termcap_suspend(bool_t complete
);
2441 # define n_TERMCAP_RESUME(CPL) do{ n_termcap_resume(CPL); }while(0)
2442 # define n_TERMCAP_SUSPEND(CPL) do{ n_termcap_suspend(CPL); }while(0)
2445 /* Command multiplexer, returns FAL0 on I/O error, TRU1 on success and TRUM1
2446 * for commands which are not available and have no built-in fallback.
2447 * For query options the return represents a true value and -1 error.
2448 * Will return FAL0 directly unless we've been initialized.
2449 * By convention unused argument slots are given as -1 */
2450 FL ssize_t
n_termcap_cmd(enum n_termcap_cmd cmd
, ssize_t a1
, ssize_t a2
);
2451 # define n_termcap_cmdx(CMD) n_termcap_cmd(CMD, -1, -1)
2453 /* Query multiplexer. If query is n__TERMCAP_QUERY_MAX1 then
2454 * tvp->tv_data.tvd_string must contain the name of the query to look up; this
2455 * is used to lookup just about *any* (string) capability.
2456 * Returns TRU1 on success and TRUM1 for queries for which a built-in default
2457 * is returned; FAL0 is returned on non-availability */
2458 FL bool_t
n_termcap_query(enum n_termcap_query query
,
2459 struct n_termcap_value
*tvp
);
2461 /* Get a n_termcap_query for name or -1 if it is not known, and -2 if
2462 * type wasn't _NONE and the type doesn't match. */
2463 # ifdef HAVE_KEY_BINDINGS
2464 FL si32_t
n_termcap_query_for_name(char const *name
,
2465 enum n_termcap_captype type
);
2466 FL
char const *n_termcap_name_of_query(enum n_termcap_query query
);
2468 #endif /* n_HAVE_TCAP */
2470 #ifndef n_TERMCAP_RESUME
2471 # define n_TERMCAP_RESUME(CPL) do{;}while(0)
2472 # define n_TERMCAP_SUSPEND(CPL) do{;}while(0);
2480 FL
int c_thread(void *vp
);
2483 FL
int c_unthread(void *vp
);
2486 FL
struct message
* next_in_thread(struct message
*mp
);
2487 FL
struct message
* prev_in_thread(struct message
*mp
);
2488 FL
struct message
* this_in_thread(struct message
*mp
, long n
);
2490 /* Sorted mode is internally just a variant of threaded mode with all m_parent
2491 * and m_child links being NULL */
2492 FL
int c_sort(void *vp
);
2495 FL
int c_collapse(void *v
);
2496 FL
int c_uncollapse(void *v
);
2499 FL
void uncollapse1(struct message
*mp
, int always
);
2505 /* Return whether user says yes, on STDIN if interactive.
2506 * Uses noninteract_default, the return value for non-interactive use cases,
2507 * as a hint for boolify() and chooses the yes/no string to append to prompt
2508 * accordingly. If prompt is NULL "Continue" is used instead.
2509 * Handles+reraises SIGINT */
2510 FL bool_t
getapproval(char const *prompt
, bool_t noninteract_default
);
2513 /* Get a password the expected way, return termios_state.ts_linebuf on
2514 * success or NULL on error */
2515 FL
char *getuser(char const *query
);
2517 /* Get a password the expected way, return termios_state.ts_linebuf on
2518 * success or NULL on error. SIGINT is temporarily blocked, *not* reraised.
2519 * termios_state_reset() (def.h) must be called anyway */
2520 FL
char *getpassword(char const *query
);
2523 /* Create the prompt and return its visual width in columns, which may be 0
2524 * if evaluation is disabled etc. The data is placed in store.
2525 * xprompt is inspected only if prompt is enabled and no *prompt* evaluation
2527 FL ui32_t
n_tty_create_prompt(struct n_string
*store
, char const *xprompt
,
2528 enum n_go_input_flags gif
);
2530 /* At least readline(3) (formerly supported) desires to handle SIGWINCH and
2531 * install its own handler */
2533 # define TTY_WANTS_SIGWINCH
2536 /* Overall interactive terminal life cycle for command line editor library */
2538 FL
void n_tty_init(void);
2539 FL
void n_tty_destroy(bool_t xit_fastpath
);
2541 # define n_tty_init() do{;}while(0)
2542 # define n_tty_destroy(B) do{;}while(0)
2545 /* Rather for main.c / SIGWINCH interaction only */
2546 FL
void n_tty_signal(int sig
);
2548 /* Read a line after printing prompt (if set and non-empty).
2549 * If n>0 assumes that *linebuf has n bytes of default content.
2550 * histok_or_null like for n_go_input().
2551 * Only the _CTX_ bits in lif are used */
2552 FL
int n_tty_readline(enum n_go_input_flags gif
, char const *prompt
,
2553 char **linebuf
, size_t *linesize
, size_t n
, bool_t
*histok_or_null
2554 n_MEMORY_DEBUG_ARGS
);
2555 #ifdef HAVE_MEMORY_DEBUG
2556 # define n_tty_readline(A,B,C,D,E,F) \
2557 (n_tty_readline)(A,B,C,D,E,F,__FILE__,__LINE__)
2560 /* Add a line (most likely as returned by n_tty_readline()) to the history.
2561 * Whether an entry added for real depends on the isgabby / *history-gabby*
2562 * relation, and / or whether s is non-empty */
2563 FL
void n_tty_addhist(char const *s
, bool_t isgabby
);
2566 FL
int c_history(void *v
);
2569 /* `bind' and `unbind' */
2570 #ifdef HAVE_KEY_BINDINGS
2571 FL
int c_bind(void *v
);
2572 FL
int c_unbind(void *v
);
2579 /* Parse (onechar of) a given buffer, and generate infos along the way.
2580 * If _WOUT_CREATE is set in vif, .vic_woudat will be NUL terminated!
2581 * vicp must be zeroed before first use */
2582 FL bool_t
n_visual_info(struct n_visual_info_ctx
*vicp
,
2583 enum n_visual_info_flags vif
);
2585 /* Check (multibyte-safe) how many bytes of buf (which is blen byts) can be
2586 * safely placed in a buffer (field width) of maxlen bytes */
2587 FL
size_t field_detect_clip(size_t maxlen
, char const *buf
, size_t blen
);
2589 /* Place cp in a salloc()ed buffer, column-aligned; for header display only */
2590 FL
char * colalign(char const *cp
, int col
, int fill
,
2591 int *cols_decr_used_or_null
);
2593 /* Convert a string to a displayable one;
2594 * prstr() returns the result savestr()d, prout() writes it */
2595 FL
void makeprint(struct str
const *in
, struct str
*out
);
2596 FL
size_t delctrl(char *cp
, size_t len
);
2597 FL
char * prstr(char const *s
);
2598 FL
int prout(char const *s
, size_t sz
, FILE *fp
);
2600 /* Print out a Unicode character or a substitute for it, return 0 on error or
2601 * wcwidth() (or 1) on success */
2602 FL
size_t putuc(int u
, int c
, FILE *fp
);
2604 /* Check whether bidirectional info maybe needed for blen bytes of bdat */
2605 FL bool_t
bidi_info_needed(char const *bdat
, size_t blen
);
2607 /* Create bidirectional text encapsulation information; without HAVE_NATCH_CHAR
2608 * the strings are always empty */
2609 FL
void bidi_info_create(struct bidi_info
*bip
);
2615 /* URL en- and decoding according to (enough of) RFC 3986 (RFC 1738).
2616 * These return a newly salloc()ated result, or NULL on length excess */
2617 FL
char * urlxenc(char const *cp
, bool_t ispath n_MEMORY_DEBUG_ARGS
);
2618 FL
char * urlxdec(char const *cp n_MEMORY_DEBUG_ARGS
);
2619 #ifdef HAVE_MEMORY_DEBUG
2620 # define urlxenc(CP,P) urlxenc(CP, P, __FILE__, __LINE__)
2621 # define urlxdec(CP) urlxdec(CP, __FILE__, __LINE__)
2625 FL
int c_urlcodec(void *vp
);
2627 FL
int c_urlencode(void *v
); /* TODO obsolete*/
2628 FL
int c_urldecode(void *v
); /* TODO obsolete */
2630 /* Parse a RFC 6058 'mailto' URI to a single to: (TODO yes, for now hacky).
2631 * Return NULL or something that can be converted to a struct name */
2632 FL
char * url_mailto_to_address(char const *mailtop
);
2634 /* Return port for proto (and set irv_or_null), or NULL if unknown.
2635 * For file:// this returns an empty string */
2636 FL
char const *n_servbyname(char const *proto
, ui16_t
*irv_or_null
);
2639 /* Parse data, which must meet the criteria of the protocol cproto, and fill
2640 * in the URL structure urlp (URL rather according to RFC 3986) */
2641 FL bool_t
url_parse(struct url
*urlp
, enum cproto cproto
,
2644 /* Zero ccp and lookup credentials for communicating with urlp.
2645 * Return whether credentials are available and valid (for chosen auth) */
2646 FL bool_t
ccred_lookup(struct ccred
*ccp
, struct url
*urlp
);
2647 FL bool_t
ccred_lookup_old(struct ccred
*ccp
, enum cproto cproto
,
2649 #endif /* HAVE_SOCKETS */
2653 FL
int c_netrc(void *v
);
2656 /* MD5 (RFC 1321) related facilities */
2658 # ifdef HAVE_XSSL_MD5
2659 # define md5_ctx MD5_CTX
2660 # define md5_init MD5_Init
2661 # define md5_update MD5_Update
2662 # define md5_final MD5_Final
2664 /* The function definitions are instantiated in main.c */
2665 # include "rfc1321.h"
2668 /* Store the MD5 checksum as a hexadecimal string in *hex*, *not* terminated,
2669 * using lowercase ASCII letters as defined in RFC 2195 */
2670 # define MD5TOHEX_SIZE 32
2671 FL
char * md5tohex(char hex
[MD5TOHEX_SIZE
], void const *vp
);
2673 /* CRAM-MD5 encode the *user* / *pass* / *b64* combo; NULL on overflow error */
2674 FL
char * cram_md5_string(struct str
const *user
, struct str
const *pass
,
2677 /* RFC 2104: HMAC: Keyed-Hashing for Message Authentication.
2678 * unsigned char *text: pointer to data stream
2679 * int text_len : length of data stream
2680 * unsigned char *key : pointer to authentication key
2681 * int key_len : length of authentication key
2682 * caddr_t digest : caller digest to be filled in */
2683 FL
void hmac_md5(unsigned char *text
, int text_len
, unsigned char *key
,
2684 int key_len
, void *digest
);
2685 #endif /* HAVE_MD5 */
2693 FL
enum okay
ssl_open(struct url
const *urlp
, struct sock
*sp
);
2696 FL
void ssl_gen_err(char const *fmt
, ...);
2699 FL
int c_verify(void *vp
);
2702 FL
FILE * smime_sign(FILE *ip
, char const *addr
);
2705 FL
FILE * smime_encrypt(FILE *ip
, char const *certfile
, char const *to
);
2707 FL
struct message
* smime_decrypt(struct message
*m
, char const *to
,
2708 char const *cc
, bool_t is_a_verify_call
);
2711 FL
enum okay
smime_certsave(struct message
*m
, int n
, FILE *op
);
2713 #endif /* HAVE_XSSL */
2720 FL
void n_go_onintr_for_imap(void);
2722 /* The former returns the input again if no conversion is necessary */
2723 FL
char const *imap_path_encode(char const *path
, bool_t
*err_or_null
);
2724 FL
char *imap_path_decode(char const *path
, bool_t
*err_or_null
);
2726 FL
char const * imap_fileof(char const *xcp
);
2727 FL
enum okay
imap_noop(void);
2728 FL
enum okay
imap_select(struct mailbox
*mp
, off_t
*size
, int *count
,
2729 const char *mbx
, enum fedit_mode fm
);
2730 FL
int imap_setfile(const char *xserver
, enum fedit_mode fm
);
2731 FL
enum okay
imap_header(struct message
*m
);
2732 FL
enum okay
imap_body(struct message
*m
);
2733 FL
void imap_getheaders(int bot
, int top
);
2734 FL bool_t
imap_quit(bool_t hold_sigs_on
);
2735 FL
enum okay
imap_undelete(struct message
*m
, int n
);
2736 FL
enum okay
imap_unread(struct message
*m
, int n
);
2737 FL
int c_imapcodec(void *vp
);
2738 FL
int c_imap_imap(void *vp
);
2739 FL
int imap_newmail(int nmail
);
2740 FL
enum okay
imap_append(const char *xserver
, FILE *fp
, long offset
);
2741 FL
int imap_folders(const char *name
, int strip
);
2742 FL
enum okay
imap_copy(struct message
*m
, int n
, const char *name
);
2743 # ifdef HAVE_IMAP_SEARCH
2744 FL
enum okay
imap_search1(const char *spec
, int f
);
2746 FL
int imap_thisaccount(const char *cp
);
2747 FL
enum okay
imap_remove(const char *name
);
2748 FL
enum okay
imap_rename(const char *old
, const char *new);
2749 FL
enum okay
imap_dequeue(struct mailbox
*mp
, FILE *fp
);
2750 FL
int c_connect(void *vp
);
2751 FL
int c_disconnect(void *vp
);
2752 FL
int c_cache(void *vp
);
2753 FL
int disconnected(const char *file
);
2754 FL
void transflags(struct message
*omessage
, long omsgCount
,
2756 FL
time_t imap_read_date_time(const char *cp
);
2757 FL
const char * imap_make_date_time(time_t t
);
2759 /* Extract the protocol base and return a duplicate */
2760 FL
char * protbase(char const *cp n_MEMORY_DEBUG_ARGS
);
2761 # ifdef HAVE_MEMORY_DEBUG
2762 # define protbase(CP) protbase(CP, __FILE__, __LINE__)
2764 #endif /* HAVE_IMAP */
2771 FL
enum okay
getcache1(struct mailbox
*mp
, struct message
*m
,
2772 enum needspec need
, int setflags
);
2773 FL
enum okay
getcache(struct mailbox
*mp
, struct message
*m
,
2774 enum needspec need
);
2775 FL
void putcache(struct mailbox
*mp
, struct message
*m
);
2776 FL
void initcache(struct mailbox
*mp
);
2777 FL
void purgecache(struct mailbox
*mp
, struct message
*m
, long mc
);
2778 FL
void delcache(struct mailbox
*mp
, struct message
*m
);
2779 FL
enum okay
cache_setptr(enum fedit_mode fm
, int transparent
);
2780 FL
enum okay
cache_list(struct mailbox
*mp
, char const *base
, int strip
,
2782 FL
enum okay
cache_remove(char const *name
);
2783 FL
enum okay
cache_rename(char const *old
, char const *new);
2784 FL
unsigned long cached_uidvalidity(struct mailbox
*mp
);
2785 FL
FILE * cache_queue(struct mailbox
*mp
);
2786 FL
enum okay
cache_dequeue(struct mailbox
*mp
);
2787 #endif /* HAVE_IMAP */
2793 FL
int zwrite(void *cookie
, const char *wbp
, int num
);
2794 FL
int zfree(void *cookie
);
2795 FL
int zread(void *cookie
, char *rbp
, int num
);
2796 FL
void * zalloc(FILE *fp
);
2797 #endif /* HAVE_IMAP */
2799 #ifndef HAVE_AMALGAMATION