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 - 2018 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 * NOTE: on change: manual contains several occurrences of this string! */
94 #define n_is_maybe_regex(S) n_is_maybe_regex_buf(S, UIZ_MAX)
95 #define n_is_maybe_regex_buf(D,L) n_anyof_buf("^[]*+?|$", D, L)
97 /* Single-threaded, use unlocked I/O */
98 #ifdef HAVE_PUTC_UNLOCKED
100 # define getc(c) getc_unlocked(c)
102 # define putc(c, f) putc_unlocked(c, f)
105 /* There are problems with dup()ing of file-descriptors for child processes.
106 * We have to somehow accomplish that the FILE* fp makes itself comfortable
107 * with the *real* offset of the underlaying file descriptor.
108 * POSIX Issue 7 overloaded fflush(3): if used on a readable stream, then
110 * if the file is not already at EOF, and the file is one capable of
111 * seeking, the file offset of the underlying open file description shall
112 * be set to the file position of the stream */
113 #if defined _POSIX_VERSION && _POSIX_VERSION + 0 >= 200809L
114 # define n_real_seek(FP,OFF,WH) (fseek(FP, OFF, WH) != -1 && fflush(FP) != EOF)
115 # define really_rewind(stream) \
122 # define n_real_seek(FP,OFF,WH) \
123 (fseek(FP, OFF, WH) != -1 && fflush(FP) != EOF &&\
124 lseek(fileno(FP), OFF, WH) != -1)
125 # define really_rewind(stream) \
129 lseek(fileno(stream), 0, SEEK_SET);\
133 /* fflush() and rewind() */
134 #define fflush_rewind(stream) \
140 /* Truncate a file to the last character written. This is useful just before
141 * closing an old file that was opened for read/write */
142 #define ftrunc(stream) \
146 off = ftell(stream);\
148 ftruncate(fileno(stream), off);\
151 # define n_fd_cloexec_set(FD) \
153 int a__fd = (FD)/*, a__fl*/;\
154 /*if((a__fl = fcntl(a__fd, F_GETFD)) != -1 && !(a__fl & FD_CLOEXEC))*/\
155 (void)fcntl(a__fd, F_SETFD, FD_CLOEXEC);\
162 /* Macros: `define', `undefine', `call', `call_if' */
163 FL
int c_define(void *v
);
164 FL
int c_undefine(void *v
);
165 FL
int c_call(void *v
);
166 FL
int c_call_if(void *v
);
168 /* Accounts: `account', `unaccount' */
169 FL
int c_account(void *v
);
170 FL
int c_unaccount(void *v
);
172 /* `localopts', `shift', `return' */
173 FL
int c_localopts(void *vp
);
174 FL
int c_shift(void *vp
);
175 FL
int c_return(void *vp
);
177 /* TODO Check whether a *folder-hook* exists for the currently active mailbox */
178 FL bool_t
temporary_folder_hook_check(bool_t nmail
);
179 FL
void temporary_folder_hook_unroll(void); /* XXX im. hack */
181 /* TODO v15 drop Invoke compose hook macname */
182 FL
void temporary_compose_mode_hook_call(char const *macname
,
183 void (*hook_pre
)(void *), void *hook_arg
);
184 FL
void temporary_compose_mode_hook_unroll(void);
186 /* Can name freely be used as a variable by users? */
187 FL bool_t
n_var_is_user_writable(char const *name
);
189 /* Don't use n_var_* unless you *really* have to! */
191 /* Constant option key look/(un)set/clear */
192 FL
char *n_var_oklook(enum okeys okey
);
193 #define ok_blook(C) (n_var_oklook(n_CONCAT(ok_b_, C)) != NULL)
194 #define ok_vlook(C) n_var_oklook(n_CONCAT(ok_v_, C))
196 FL bool_t
n_var_okset(enum okeys okey
, uintptr_t val
);
198 n_var_okset(n_CONCAT(ok_b_, C), (uintptr_t)TRU1)
199 #define ok_vset(C,V) \
200 n_var_okset(n_CONCAT(ok_v_, C), (uintptr_t)(V))
202 FL bool_t
n_var_okclear(enum okeys okey
);
203 #define ok_bclear(C) n_var_okclear(n_CONCAT(ok_b_, C))
204 #define ok_vclear(C) n_var_okclear(n_CONCAT(ok_v_, C))
206 /* Variable option key lookup/(un)set/clear.
207 * If try_getenv is true we'll getenv(3) _if_ vokey is not a known enum okey.
208 * _vexplode() is to be used by the shell expansion stuff when encountering
209 * ${@} in double-quotes, in order to provide sh(1)ell compatible behaviour;
210 * it returns whether there are any elements in argv (*cookie) */
211 FL
char const *n_var_vlook(char const *vokey
, bool_t try_getenv
);
212 FL bool_t
n_var_vexplode(void const **cookie
);
213 FL bool_t
n_var_vset(char const *vokey
, uintptr_t val
);
214 FL bool_t
n_var_vclear(char const *vokey
);
216 /* Special case to handle the typical [xy-USER@HOST,] xy-HOST and plain xy
217 * variable chains; oxm is a bitmix which tells which combinations to test */
219 FL
char *n_var_xoklook(enum okeys okey
, struct url
const *urlp
,
220 enum okey_xlook_mode oxm
);
221 # define xok_BLOOK(C,URL,M) (n_var_xoklook(C, URL, M) != NULL)
222 # define xok_VLOOK(C,URL,M) n_var_xoklook(C, URL, M)
223 # define xok_blook(C,URL,M) xok_BLOOK(n_CONCAT(ok_b_, C), URL, M)
224 # define xok_vlook(C,URL,M) xok_VLOOK(n_CONCAT(ok_v_, C), URL, M)
227 /* User variable access: `set', `local' and `unset' */
228 FL
int c_set(void *vp
);
229 FL
int c_unset(void *vp
);
232 FL
int c_varshow(void *v
);
234 /* Ditto: `varedit' */
235 FL
int c_varedit(void *v
);
238 FL
int c_environ(void *v
);
241 FL
int c_vexpr(void *v
);
244 FL
int c_vpospar(void *v
);
248 * xxx Interface quite sick
251 /* Try to add an attachment for file, fexpand(_LOCAL|_NOPROTO)ed.
252 * Return the new aplist aphead.
253 * The newly created attachment may be stored in *newap, or NULL on error */
254 FL
struct attachment
*n_attachment_append(struct attachment
*aplist
,
255 char const *file
, enum n_attach_error
*aerr_or_null
,
256 struct attachment
**newap_or_null
);
258 /* Shell-token parse names, and append resulting file names to aplist, return
259 * (new) aplist head */
260 FL
struct attachment
*n_attachment_append_list(struct attachment
*aplist
,
263 /* Remove ap from aplist, and return the new aplist head */
264 FL
struct attachment
*n_attachment_remove(struct attachment
*aplist
,
265 struct attachment
*ap
);
267 /* Find by file-name. If any path component exists in name then an exact match
268 * of the creation-path is used directly; if instead the basename of that path
269 * matches all attachments are traversed to find an exact match first, the
270 * first of all basename matches is returned as a last resort;
271 * If no path component exists the filename= parameter is searched (and also
272 * returned) in preference over the basename, otherwise likewise.
273 * If name is in fact a message number the first match is taken.
274 * If stat_or_null is given: FAL0 on NULL return, TRU1 for exact/single match,
275 * TRUM1 for ambiguous matches */
276 FL
struct attachment
*n_attachment_find(struct attachment
*aplist
,
277 char const *name
, bool_t
*stat_or_null
);
279 /* Interactively edit the attachment list, return updated list */
280 FL
struct attachment
*n_attachment_list_edit(struct attachment
*aplist
,
281 enum n_go_input_flags gif
);
283 /* Print all attachments to fp, return number of lines written, -1 on error */
284 FL ssize_t
n_attachment_list_print(struct attachment
const *aplist
, FILE *fp
);
290 /* setlocale(3), *ttycharset* etc. */
291 FL
void n_locale_init(void);
293 /* Compute screen size */
294 FL
size_t n_screensize(void);
296 /* Get our $PAGER; if env_addon is not NULL it is checked whether we know about
297 * some environment variable that supports colour+ and set *env_addon to that,
298 * e.g., "LESS=FRSXi" */
299 FL
char const *n_pager_get(char const **env_addon
);
301 /* Use a pager or STDOUT to print *fp*; if *lines* is 0, they'll be counted */
302 FL
void page_or_print(FILE *fp
, size_t lines
);
304 /* Parse name and guess at the required protocol.
305 * If check_stat is true then stat(2) will be consulted - a TODO c..p hack
306 * TODO that together with *newfolders*=maildir adds Maildir support; sigh!
307 * If try_hooks is set check_stat is implied and if the stat(2) fails all
308 * file-hook will be tried in order to find a supported version of name.
309 * If adjusted_or_null is not NULL it will be set to the final version of name
310 * this function knew about: a %: FEDIT_SYSBOX prefix is forgotten, in case
311 * a hook is needed the "real" filename will be placed.
312 * TODO This c..p should be URL::from_string()->protocol() or something! */
313 FL
enum protocol
which_protocol(char const *name
, bool_t check_stat
,
314 bool_t try_hooks
, char const **adjusted_or_null
);
316 /* Hexadecimal itoa (NUL terminates) / atoi (-1 on error) */
317 FL
char * n_c_to_hex_base16(char store
[3], char c
);
318 FL si32_t
n_c_from_hex_base16(char const hex
[2]);
320 /* Decode clen (or strlen() if UIZ_MAX) bytes of cbuf into an integer
321 * according to idm, store a/the result in *resp (in _EINVAL case an overflow
322 * constant is assigned, for signed types it depends on parse state w. MIN/MAX),
323 * which must point to storage of the correct type, and return the result state.
324 * If endptr_or_null is set it will be set to the byte where parsing stopped */
325 FL
enum n_idec_state
n_idec_buf(void *resp
, char const *cbuf
, uiz_t clen
,
326 ui8_t base
, enum n_idec_mode idm
,
327 char const **endptr_or_null
);
328 #define n_idec_cp(RP,CBP,B,M,CLP) n_idec_buf(RP, CBP, UIZ_MAX, B, M, CLP)
330 #define n_idec_ui8_cp(RP,CBP,B,CLP) \
331 n_idec_buf(RP, CBP, UIZ_MAX, B, (n_IDEC_MODE_LIMIT_8BIT), CLP)
332 #define n_idec_si8_cp(RP,CBP,B,CLP) \
333 n_idec_buf(RP, CBP, UIZ_MAX, B,\
334 (n_IDEC_MODE_SIGNED_TYPE | n_IDEC_MODE_LIMIT_8BIT), CLP)
335 #define n_idec_ui16_cp(RP,CBP,B,CLP) \
336 n_idec_buf(RP, CBP, UIZ_MAX, B, (n_IDEC_MODE_LIMIT_16BIT), CLP)
337 #define n_idec_si16_cp(RP,CBP,B,CLP) \
338 n_idec_buf(RP, CBP, UIZ_MAX, B,\
339 (n_IDEC_MODE_SIGNED_TYPE | n_IDEC_MODE_LIMIT_16BIT), CLP)
340 #define n_idec_ui32_cp(RP,CBP,B,CLP) \
341 n_idec_buf(RP, CBP, UIZ_MAX, B, (n_IDEC_MODE_LIMIT_32BIT), CLP)
342 #define n_idec_si32_cp(RP,CBP,B,CLP) \
343 n_idec_buf(RP, CBP, UIZ_MAX, B,\
344 (n_IDEC_MODE_SIGNED_TYPE | n_IDEC_MODE_LIMIT_32BIT), CLP)
345 #define n_idec_ui64_cp(RP,CBP,B,CLP) \
346 n_idec_buf(RP, CBP, UIZ_MAX, B, 0, CLP)
347 #define n_idec_si64_cp(RP,CBP,B,CLP) \
348 n_idec_buf(RP, CBP, UIZ_MAX, B, (n_IDEC_MODE_SIGNED_TYPE), CLP)
349 #if UIZ_MAX == UI32_MAX
350 # define n_idec_uiz_cp(RP,CBP,B,CLP) \
351 n_idec_buf(RP, CBP, UIZ_MAX, B, (n_IDEC_MODE_LIMIT_32BIT), CLP)
352 # define n_idec_siz_cp(RP,CBP,B,CLP) \
353 n_idec_buf(RP, CBP, UIZ_MAX, B,\
354 (n_IDEC_MODE_SIGNED_TYPE | n_IDEC_MODE_LIMIT_32BIT), CLP)
356 # define n_idec_uiz_cp(RP,CBP,B,CLP) \
357 n_idec_buf(RP, CBP, UIZ_MAX, B, 0, CLP)
358 # define n_idec_siz_cp(RP,CBP,B,CLP) \
359 n_idec_buf(RP, CBP, UIZ_MAX, B, (n_IDEC_MODE_SIGNED_TYPE), CLP)
362 /* Encode an integer value according to base (2-36) and mode iem, return
363 * pointer to starting byte or NULL on error */
364 FL
char *n_ienc_buf(char cbuf
[n_IENC_BUFFER_SIZE
], ui64_t value
, ui8_t base
,
365 enum n_ienc_mode iem
);
367 /* Hash the passed string -- uses Chris Torek's hash algorithm.
368 * i*() hashes case-insensitively (ASCII), and *n() uses maximally len bytes;
369 * if len is UIZ_MAX, we go .), since we anyway stop for NUL */
370 FL ui32_t
n_torek_hash(char const *name
);
371 FL ui32_t
n_torek_ihashn(char const *dat
, size_t len
);
372 #define n_torek_ihash(CP) n_torek_ihashn(CP, UIZ_MAX)
374 /* Find a prime greater than n */
375 FL ui32_t
n_prime_next(ui32_t n
);
377 /* Return the name of the dead.letter file */
378 FL
char const * n_getdeadletter(void);
380 /* Detect and query the hostname to use */
381 FL
char *n_nodename(bool_t mayoverride
);
383 /* Convert from / to *ttycharset* */
385 FL bool_t
n_idna_to_ascii(struct n_string
*out
, char const *ibuf
, size_t ilen
);
386 /*TODO FL bool_t n_idna_from_ascii(struct n_string *out, char const *ibuf,
390 /* Get a (pseudo) random string of *len* bytes, _not_ counting the NUL
391 * terminator, the second returns an n_autorec_alloc()ed buffer.
392 * If n_PSO_REPRODUCIBLE and reprocnt_or_null not NULL then we produce
393 * a reproducable string by using and managing that counter instead */
394 FL
char *n_random_create_buf(char *dat
, size_t len
, ui32_t
*reprocnt_or_null
);
395 FL
char *n_random_create_cp(size_t len
, ui32_t
*reprocnt_or_null
);
397 /* Check whether the argument string is a TRU1 or FAL0 boolean, or an invalid
398 * string, in which case TRUM1 is returned.
399 * If the input buffer is empty emptyrv is used as the return: if it is GE
400 * FAL0 it will be made a binary boolean, otherwise TRU2 is returned.
401 * inlen may be UIZ_MAX to force strlen() detection */
402 FL bool_t
n_boolify(char const *inbuf
, uiz_t inlen
, bool_t emptyrv
);
404 /* Dig a "quadoption" in inbuf, possibly going through getapproval() in
405 * interactive mode, in which case prompt is printed first if set.
406 . Just like n_boolify() otherwise */
407 FL bool_t
n_quadify(char const *inbuf
, uiz_t inlen
, char const *prompt
,
410 /* Is the argument "all" (case-insensitive) or "*" */
411 FL bool_t
n_is_all_or_aster(char const *name
);
413 /* Get seconds since epoch, return pointer to static struct.
414 * Unless force_update is true we may use the event-loop tick time */
415 FL
struct n_timespec
const *n_time_now(bool_t force_update
);
416 #define n_time_epoch() ((time_t)n_time_now(FAL0)->ts_sec)
418 /* Update *tc* to now; only .tc_time updated unless *full_update* is true */
419 FL
void time_current_update(struct time_current
*tc
,
422 /* ctime(3), but do ensure 26 byte limit, do not crash XXX static buffer.
423 * NOTE: no trailing newline */
424 FL
char *n_time_ctime(si64_t secsepoch
, struct tm
const *localtime_or_nil
);
426 /* Returns 0 if fully slept, number of millis left if ignint is true and we
427 * were interrupted. Actual resolution may be second or less.
428 * Note in case of HAVE_SLEEP this may be SIGALARM based. */
429 FL uiz_t
n_msleep(uiz_t millis
, bool_t ignint
);
431 /* Our error print series.. Note: these reverse scan format in order to know
432 * whether a newline was included or not -- this affects the output! */
433 FL
void n_err(char const *format
, ...);
434 FL
void n_verr(char const *format
, va_list ap
);
436 /* ..(for use in a signal handler; to be obsoleted..).. */
437 FL
void n_err_sighdl(char const *format
, ...);
439 /* Our perror(3); if errval is 0 n_err_no is used; newline appended */
440 FL
void n_perr(char const *msg
, int errval
);
442 /* Announce a fatal error (and die); newline appended */
443 FL
void n_alert(char const *format
, ...);
444 FL
void n_panic(char const *format
, ...);
448 FL
int c_errors(void *vp
);
451 /* strerror(3), and enum n_err_number <-> error name conversions */
452 FL
char const *n_err_to_doc(si32_t eno
);
453 FL
char const *n_err_to_name(si32_t eno
);
454 FL si32_t
n_err_from_name(char const *name
);
458 FL
char const *n_regex_err_to_doc(const regex_t
*rep
, int e
);
465 /* if.elif.else.endif conditional execution.
466 * _isskip() tests whether current state doesn't allow execution of commands */
467 FL
int c_if(void *v
);
468 FL
int c_elif(void *v
);
469 FL
int c_else(void *v
);
470 FL
int c_endif(void *v
);
472 FL bool_t
n_cnd_if_isskip(void);
474 /* An execution context is teared down, and it finds to have an if stack */
475 FL
void n_cnd_if_stack_del(struct n_go_data_ctx
*gdcp
);
481 /* `file' (`folder') and `File' (`Folder') */
482 FL
int c_file(void *v
);
483 FL
int c_File(void *v
);
485 /* 'newmail' command: Check for new mail without writing old mail back */
486 FL
int c_newmail(void *v
);
489 FL
int c_noop(void *v
);
492 FL
int c_remove(void *v
);
495 FL
int c_rename(void *v
);
497 /* List the folders the user currently has */
498 FL
int c_folders(void *v
);
504 /* `headers' (show header group, possibly after setting dot) */
505 FL
int c_headers(void *v
);
507 /* Like c_headers(), but pre-prepared message vector */
508 FL
int print_header_group(int *vector
);
510 /* Scroll to the next/previous screen */
511 FL
int c_scroll(void *v
);
512 FL
int c_Scroll(void *v
);
514 /* Move the dot up or down by one message */
515 FL
int c_dotmove(void *v
);
517 /* Print out the headlines for each message in the passed message list */
518 FL
int c_from(void *v
);
520 /* Print all message in between and including bottom and topx if they are
521 * visible and either only_marked is false or they are MMARKed.
522 * TODO If subject_thread_compress is true then a subject will not be printed
523 * TODO if it equals the subject of the message "above"; as this only looks
524 * TODO in the thread neighbour and NOT in the "visible" neighbour, the caller
525 * TODO has to ensure the result will look sane; DROP + make it work (tm) */
526 FL
void print_headers(size_t bottom
, size_t topx
, bool_t only_marked
,
527 bool_t subject_thread_compress
);
533 /* Paginate messages, honour/don't honour ignored fields, respectively */
534 FL
int c_more(void *v
);
535 FL
int c_More(void *v
);
537 /* Type out messages, honour/don't honour ignored fields, respectively */
538 FL
int c_type(void *v
);
539 FL
int c_Type(void *v
);
541 /* Show raw message content */
542 FL
int c_show(void *v
);
545 FL
int c_mimeview(void *vp
);
547 /* Pipe messages, honour/don't honour ignored fields, respectively */
548 FL
int c_pipe(void *v
);
549 FL
int c_Pipe(void *v
);
551 /* Print the first *toplines* of each desired message */
552 FL
int c_top(void *v
);
553 FL
int c_Top(void *v
);
555 /* If any arguments were given, go to the next applicable argument following
556 * dot, otherwise, go to the next applicable message. If given as first
557 * command with no arguments, print first message */
558 FL
int c_next(void *v
);
560 /* Print out the value of dot */
561 FL
int c_pdot(void *v
);
563 /* Print the size of each message */
564 FL
int c_messize(void *v
);
566 /* Delete messages */
567 FL
int c_delete(void *v
);
569 /* Delete messages, then type the new dot */
570 FL
int c_deltype(void *v
);
572 /* Undelete the indicated messages */
573 FL
int c_undelete(void *v
);
575 /* Touch all the given messages so that they will get mboxed */
576 FL
int c_stouch(void *v
);
578 /* Make sure all passed messages get mboxed */
579 FL
int c_mboxit(void *v
);
581 /* Preserve messages, so that they will be sent back to the system mailbox */
582 FL
int c_preserve(void *v
);
584 /* Mark all given messages as unread */
585 FL
int c_unread(void *v
);
587 /* Mark all given messages as read */
588 FL
int c_seen(void *v
);
590 /* Message flag manipulation */
591 FL
int c_flag(void *v
);
592 FL
int c_unflag(void *v
);
593 FL
int c_answered(void *v
);
594 FL
int c_unanswered(void *v
);
595 FL
int c_draft(void *v
);
596 FL
int c_undraft(void *v
);
603 FL
int c_sleep(void *v
);
605 /* `!': process a shell escape by saving signals, ignoring signals and sh -c */
606 FL
int c_shell(void *v
);
608 /* `shell': fork an interactive shell */
609 FL
int c_dosh(void *v
);
611 /* `cwd': print user's working directory */
612 FL
int c_cwd(void *v
);
614 /* `chdir': change user's working directory */
615 FL
int c_chdir(void *v
);
617 /* `echo' series: expand file names like echo (to stdout/stderr, with/out
618 * trailing newline) */
619 FL
int c_echo(void *v
);
620 FL
int c_echoerr(void *v
);
621 FL
int c_echon(void *v
);
622 FL
int c_echoerrn(void *v
);
625 FL
int c_read(void *vp
);
628 FL
int c_readall(void *vp
);
631 FL
int c_version(void *vp
);
637 /* All thinkable sorts of `reply' / `respond' and `followup'.. */
638 FL
int c_reply(void *vp
);
639 FL
int c_replyall(void *vp
);
640 FL
int c_replysender(void *vp
);
641 FL
int c_Reply(void *vp
);
642 FL
int c_followup(void *vp
);
643 FL
int c_followupall(void *vp
);
644 FL
int c_followupsender(void *vp
);
645 FL
int c_Followup(void *vp
);
647 /* ..and a mailing-list reply */
648 FL
int c_Lreply(void *vp
);
650 /* The 'forward' command */
651 FL
int c_forward(void *vp
);
653 /* Similar to forward, saving the message in a file named after the first
655 FL
int c_Forward(void *vp
);
657 /* Resend a message list to a third person */
658 FL
int c_resend(void *vp
);
660 /* Resend a message list to a third person without adding headers */
661 FL
int c_Resend(void *vp
);
665 * Actual command table, `help', `list', etc., and the n_cmd_arg() parser.
668 /* Isolate the command from the arguments, return pointer to end of cmd name */
669 FL
char const *n_cmd_isolate(char const *cmd
);
671 /* First command which fits for cmd, or NULL */
672 FL
struct n_cmd_desc
const *n_cmd_firstfit(char const *cmd
);
674 /* Get the default command for the empty line */
675 FL
struct n_cmd_desc
const *n_cmd_default(void);
677 /* Scan an entire command argument line, return whether result can be used,
678 * otherwise no resources are allocated (in ->cac_arg).
679 * For _WYSH arguments the flags _TRIM_SPACE (v15 _not_ _TRIM_IFSSPACE) and
680 * _LOG are implicit, _META_SEMICOLON is starting with the last (non-optional)
681 * argument, and then a trailing empty argument is ignored, too */
682 FL bool_t
n_cmd_arg_parse(struct n_cmd_arg_ctx
*cacp
);
684 /* Save away the data from autorec memory, and restore it to that.
685 * The heap storage is a single pointer to be n_free() by users */
686 FL
void *n_cmd_arg_save_to_heap(struct n_cmd_arg_ctx
const *cacp
);
687 FL
struct n_cmd_arg_ctx
*n_cmd_arg_restore_from_heap(void *vp
);
689 /* Scan out the list of string arguments according to rm, return -1 on error;
690 * res_dat is NULL terminated unless res_size is 0 or error occurred */
691 FL
int /* TODO v15*/ getrawlist(bool_t wysh
, char **res_dat
, size_t res_size
,
692 char const *line
, size_t linesize
);
698 /* Save a message in a file. Mark the message as saved so we can discard when
700 FL
int c_save(void *v
);
701 FL
int c_Save(void *v
);
703 /* Copy a message to a file without affected its saved-ness */
704 FL
int c_copy(void *v
);
705 FL
int c_Copy(void *v
);
707 /* Move a message to a file */
708 FL
int c_move(void *v
);
709 FL
int c_Move(void *v
);
711 /* Decrypt and copy a message to a file. Like plain `copy' at times */
712 FL
int c_decrypt(void *v
);
713 FL
int c_Decrypt(void *v
);
715 /* Write the indicated messages at the end of the passed file name, minus
716 * header and trailing blank line. This is the MIME save function */
717 FL
int c_write(void *v
);
723 /* temporary_compose_mode_hook_call() etc. setter hook */
724 FL
void n_temporary_compose_hook_varset(void *arg
);
726 /* If quotefile is (char*)-1, stdin will be used, caller has to verify that
727 * we're not running in interactive mode */
728 FL
FILE *n_collect(struct header
*hp
, int printheaders
, struct message
*mp
,
729 char const *quotefile
, bool_t is_fwding
, si8_t
*checkaddr_err
);
737 FL
int c_colour(void *v
);
738 FL
int c_uncolour(void *v
);
740 /* An execution context is teared down, and it finds to have a colour stack.
741 * Signals are blocked */
742 FL
void n_colour_stack_del(struct n_go_data_ctx
*gdcp
);
744 /* We want coloured output (in this autorec memory() cycle), pager_used is used
745 * to test whether *colour-pager* is to be inspected, if fp is given, the reset
746 * sequence will be written as necessary by _stack_del()
747 * env_gut() will reset() as necessary if fp is not NULL */
748 FL
void n_colour_env_create(enum n_colour_ctx cctx
, FILE *fp
,
750 FL
void n_colour_env_gut(void);
752 /* Putting anything (for pens: including NULL) resets current state first */
753 FL
void n_colour_put(enum n_colour_id cid
, char const *ctag
);
754 FL
void n_colour_reset(void);
756 /* Of course temporary only and may return NULL. Doesn't affect state! */
757 FL
struct str
const *n_colour_reset_to_str(void);
759 /* A pen is bound to its environment and automatically reclaimed; it may be
760 * NULL but that can be used anyway for simplicity.
761 * This includes pen_to_str() -- which doesn't affect state! */
762 FL
struct n_colour_pen
*n_colour_pen_create(enum n_colour_id cid
,
764 FL
void n_colour_pen_put(struct n_colour_pen
*self
);
766 FL
struct str
const *n_colour_pen_to_str(struct n_colour_pen
*self
);
767 #endif /* HAVE_COLOUR */
773 /* Aquire a flt n_file_lock().
774 * Will try FILE_LOCK_TRIES times if pollmsecs > 0 (once otherwise).
775 * If pollmsecs is UIZ_MAX, FILE_LOCK_MILLIS is used.
776 * If *dotlock-disable* is set (FILE*)-1 is returned if flt could be aquired,
777 * NULL if not, with n_err_ being usable.
778 * Otherwise a dotlock file is created, and a registered control-pipe FILE* is
779 * returned upon success which keeps the link in between us and the
780 * lock-holding fork(2)ed subprocess (which conditionally replaced itself via
781 * execv(2) with the privilege-separated dotlock helper program): the lock file
782 * will be removed once the control pipe is closed via Pclose().
783 * If *dotlock_ignore_error* is set (FILE*)-1 will be returned if at least the
784 * normal file lock could be established, otherwise n_err_no is usable on err */
785 FL
FILE *n_dotlock(char const *fname
, int fd
, enum n_file_lock_type flt
,
786 off_t off
, off_t len
, size_t pollmsecs
);
792 /* Edit a message list */
793 FL
int c_editor(void *v
);
795 /* Invoke the visual editor on a message list */
796 FL
int c_visual(void *v
);
798 /* Run an editor on either size bytes of the file fp (or until EOF if size is
799 * negative) or on the message mp, and return a new file or NULL on error of if
800 * the user didn't perform any edits (not possible in pipe mode).
801 * For now we assert that mp==NULL if hp!=NULL, treating this as a special call
802 * from within compose mode, and giving TRUM1 to n_puthead().
803 * Signals must be handled by the caller.
804 * viored is 'e' for $EDITOR, 'v' for $VISUAL, or '|' for n_child_run(), in
805 * which case pipecmd must have been given */
806 FL
FILE *n_run_editor(FILE *fp
, off_t size
, int viored
, bool_t readonly
,
807 struct header
*hp
, struct message
*mp
,
808 enum sendaction action
, sighandler_type oldint
,
809 char const *pipecmd
);
816 FL
struct quoteflt
* quoteflt_dummy(void); /* TODO LEGACY */
817 FL
void quoteflt_init(struct quoteflt
*self
, char const *prefix
,
819 FL
void quoteflt_destroy(struct quoteflt
*self
);
820 FL
void quoteflt_reset(struct quoteflt
*self
, FILE *f
);
821 FL ssize_t
quoteflt_push(struct quoteflt
*self
, char const *dat
,
823 FL ssize_t
quoteflt_flush(struct quoteflt
*self
);
825 /* (Primitive) HTML tagsoup filter */
826 #ifdef HAVE_FILTER_HTML_TAGSOUP
827 /* TODO Because we don't support filter chains yet this filter will be run
828 * TODO in a dedicated subprocess, driven via a special Popen() mode */
829 FL
int htmlflt_process_main(void);
831 FL
void htmlflt_init(struct htmlflt
*self
);
832 FL
void htmlflt_destroy(struct htmlflt
*self
);
833 FL
void htmlflt_reset(struct htmlflt
*self
, FILE *f
);
834 FL ssize_t
htmlflt_push(struct htmlflt
*self
, char const *dat
, size_t len
);
835 FL ssize_t
htmlflt_flush(struct htmlflt
*self
);
842 /* fgets() replacement to handle lines of arbitrary size and with embedded \0
844 * line - line buffer. *line may be NULL.
845 * linesize - allocated size of line buffer.
846 * count - maximum characters to read. May be NULL.
847 * llen - length_of_line(*line).
849 * appendnl - always terminate line with \n, append if necessary.
850 * Manages the n_PS_READLINE_NL hack */
851 FL
char * fgetline(char **line
, size_t *linesize
, size_t *count
,
852 size_t *llen
, FILE *fp
, int appendnl n_MEMORY_DEBUG_ARGS
);
853 #ifdef HAVE_MEMORY_DEBUG
854 # define fgetline(A,B,C,D,E,F) \
855 fgetline(A, B, C, D, E, F, __FILE__, __LINE__)
858 /* Read up a line from the specified input into the linebuffer.
859 * Return the number of characters read. Do not include the newline at EOL.
860 * n is the number of characters already read and present in *linebuf; it'll be
861 * treated as _the_ line if no more (successful) reads are possible.
862 * Manages the n_PS_READLINE_NL hack */
863 FL
int readline_restart(FILE *ibuf
, char **linebuf
, size_t *linesize
,
864 size_t n n_MEMORY_DEBUG_ARGS
);
865 #ifdef HAVE_MEMORY_DEBUG
866 # define readline_restart(A,B,C,D) \
867 readline_restart(A, B, C, D, __FILE__, __LINE__)
870 /* Determine the size of the file possessed by the passed buffer */
871 FL off_t
fsize(FILE *iob
);
873 /* Will retry FILE_LOCK_RETRIES times if pollmsecs > 0.
874 * If pollmsecs is UIZ_MAX, FILE_LOCK_MILLIS is used */
875 FL bool_t
n_file_lock(int fd
, enum n_file_lock_type flt
,
876 off_t off
, off_t len
, size_t pollmsecs
);
882 /* Set up editing on the given file name.
883 * If the first character of name is %, we are considered to be editing the
884 * file, otherwise we are reading our mail which has signficance for mbox and
886 FL
int setfile(char const *name
, enum fedit_mode fm
);
888 FL
int newmailinfo(int omsgCount
);
890 /* Set the size of the message vector used to construct argument lists to
891 * message list functions */
892 FL
void setmsize(int sz
);
894 /* Logic behind -H / -L invocations */
895 FL
void print_header_summary(char const *Larg
);
897 /* Announces the current folder as indicated.
898 * Is responsible for updating "dot" (after a folder change). */
899 FL
void n_folder_announce(enum n_announce_flags af
);
901 FL
int getmdot(int nmail
);
903 FL
void initbox(char const *name
);
905 /* Determine and expand the current *folder* name, return it (with trailing
906 * solidus) or the empty string also in case of errors: since POSIX mandates
907 * a default of CWD if not set etc., that seems to be a valid fallback, then */
908 FL
char const *n_folder_query(void);
910 /* Prepare the seekable O_APPEND MBOX fout for appending of another message.
911 * If st_or_null is not NULL it is assumed to point to an up-to-date status of
912 * fout, otherwise an internal fstat(2) is performed as necessary.
913 * Returns n_err_no of error */
914 FL
int n_folder_mbox_prepare_append(FILE *fout
, struct stat
*st_or_null
);
918 * Program input of all sorts, input lexing, event loops, command evaluation.
919 * Also alias handling.
922 /* Setup the run environment; this i *only* for main() */
923 FL
void n_go_init(void);
925 /* Interpret user commands. If stdin is not a tty, print no prompt; return
926 * whether last processed command returned error; this is *only* for main()! */
927 FL bool_t
n_go_main_loop(void);
929 /* Actual cmd input */
932 FL
void n_go_input_clearerr(void);
934 /* Force n_go_input() to read EOF next */
935 FL
void n_go_input_force_eof(void);
937 /* Returns true if force_eof() has been set -- it is set automatically if
938 * an input context enters EOF state (rather than error, as in ferror(3)) */
939 FL bool_t
n_go_input_is_eof(void);
941 /* Force n_go_input() to read that buffer next -- for `history', and the MLE.
942 * If commit is not true then we'll reenter the line editor with buf as default
943 * line content. Only to be used in interactive and non-robot mode! */
944 FL
void n_go_input_inject(enum n_go_input_inject_flags giif
, char const *buf
,
947 /* Read a complete line of input, with editing if interactive and possible.
948 * If string is set it is used as the initial line content if in interactive
949 * mode, otherwise this argument is ignored for reproducibility.
950 * If histok_or_null is set it will be updated to FAL0 if input shall not be
952 * Return number of octets or a value <0 on error.
953 * Note: may use the currently `source'd file stream instead of stdin!
954 * Manages the n_PS_READLINE_NL hack
955 * TODO We need an OnReadLineCompletedEvent and drop this function */
956 FL
int n_go_input(enum n_go_input_flags gif
, char const *prompt
,
957 char **linebuf
, size_t *linesize
, char const *string
,
958 bool_t
*histok_or_null n_MEMORY_DEBUG_ARGS
);
959 #ifdef HAVE_MEMORY_DEBUG
960 # define n_go_input(A,B,C,D,E,F) n_go_input(A,B,C,D,E,F,__FILE__,__LINE__)
963 /* Read a line of input, with editing if interactive and possible, return it
964 * savestr()d or NULL in case of errors or if an empty line would be returned.
965 * This may only be called from toplevel (not during n_PS_ROBOT).
966 * If string is set it is used as the initial line content if in interactive
967 * mode, otherwise this argument is ignored for reproducibility */
968 FL
char *n_go_input_cp(enum n_go_input_flags gif
, char const *prompt
,
971 /* Deal with loading of resource files and dealing with a stack of files for
972 * the source command */
974 /* Load a file of user system startup resources.
975 * *Only* for main(), returns whether program shall continue */
976 FL bool_t
n_go_load(char const *name
);
978 /* "Load" all the -X command line definitions in order.
979 * *Only* for main(), returns whether program shall continue */
980 FL bool_t
n_go_Xargs(char const **lines
, size_t cnt
);
982 /* Pushdown current input file and switch to a new one. Set the global flag
983 * n_PS_SOURCING so that others will realize that they are no longer reading
984 * from a tty (in all probability) */
985 FL
int c_source(void *v
);
986 FL
int c_source_if(void *v
);
988 /* Evaluate a complete macro / a single command. For the former lines will
989 * always be free()d, for the latter cmd will always be duplicated internally */
990 FL bool_t
n_go_macro(enum n_go_input_flags gif
, char const *name
, char **lines
,
991 void (*on_finalize
)(void*), void *finalize_arg
);
992 FL bool_t
n_go_command(enum n_go_input_flags gif
, char const *cmd
);
994 /* XXX See a_GO_SPLICE in source */
995 FL
void n_go_splice_hack(char const *cmd
, FILE *new_stdin
, FILE *new_stdout
,
996 ui32_t new_psonce
, void (*on_finalize
)(void*), void *finalize_arg
);
997 FL
void n_go_splice_hack_remove_after_jump(void);
999 /* XXX Hack: may we release our (interactive) (terminal) control to a different
1000 * XXX program, e.g., a $PAGER? */
1001 FL bool_t
n_go_may_yield_control(void);
1004 FL
int c_eval(void *vp
);
1007 FL
int c_xcall(void *vp
);
1009 /* `exit' and `quit' commands */
1010 FL
int c_exit(void *vp
);
1011 FL
int c_quit(void *vp
);
1014 FL
int c_readctl(void *vp
);
1020 /* Return the user's From: address(es) */
1021 FL
char const * myaddrs(struct header
*hp
);
1023 /* Boil the user's From: addresses down to a single one, or use *sender* */
1024 FL
char const * myorigin(struct header
*hp
);
1026 /* See if the passed line buffer, which may include trailing newline (sequence)
1027 * is a mail From_ header line according to POSIX ("From ").
1028 * If check_rfc4155 is true we'll return TRUM1 instead if the From_ line
1029 * matches POSIX but is _not_ compatible to RFC 4155 */
1030 FL bool_t
is_head(char const *linebuf
, size_t linelen
,
1031 bool_t check_rfc4155
);
1033 /* Print hp "to user interface" fp for composing purposes xxx what a sigh */
1034 FL bool_t
n_header_put4compose(FILE *fp
, struct header
*hp
);
1036 /* Extract some header fields (see e.g. -t documentation) from a message.
1037 * If extended_list_of is set a number of additional header fields are
1038 * understood and address joining is performed as necessary, and the subject
1039 * is treated with additional care, too;
1040 * if it is set to TRUM1 then From: and Sender: will not be assigned no more,
1041 * if it is TRU1 then to,cc,bcc present in hp will be used to prefill the new
1042 * header; in any case a true boolean causes shell comments to be understood.
1043 * This calls expandaddr() on some headers and sets checkaddr_err if that is
1044 * not NULL -- note it explicitly allows EAF_NAME because aliases are not
1045 * expanded when this is called! */
1046 FL
void n_header_extract(FILE *fp
, struct header
*hp
, bool_t extended_list_of
,
1047 si8_t
*checkaddr_err
);
1049 /* Return the desired header line from the passed message
1050 * pointer (or NULL if the desired header field is not available).
1051 * If mult is zero, return the content of the first matching header
1052 * field only, the content of all matching header fields else */
1053 FL
char * hfield_mult(char const *field
, struct message
*mp
, int mult
);
1054 #define hfieldX(a, b) hfield_mult(a, b, 1)
1055 #define hfield1(a, b) hfield_mult(a, b, 0)
1057 /* Check whether the passed line is a header line of the desired breed.
1058 * Return the field body, or 0 */
1059 FL
char const * thisfield(char const *linebuf
, char const *field
);
1061 /* Start of a "comment". Ignore it */
1062 FL
char const * skip_comment(char const *cp
);
1064 /* Return the start of a route-addr (address in angle brackets), if present */
1065 FL
char const * routeaddr(char const *name
);
1067 /* Query *expandaddr*, parse it and return flags.
1068 * The flags are already adjusted for n_PSO_INTERACTIVE, n_PO_TILDE_FLAG etc. */
1069 FL
enum expand_addr_flags
expandaddr_to_eaf(void);
1071 /* Check if an address is invalid, either because it is malformed or, if not,
1072 * according to eacm. Return FAL0 when it looks good, TRU1 if it is invalid
1073 * but the error condition wasn't covered by a 'hard "fail"ure', -1 otherwise */
1074 FL si8_t
is_addr_invalid(struct name
*np
,
1075 enum expand_addr_check_mode eacm
);
1077 /* Does *NP* point to a file or pipe addressee? */
1078 #define is_fileorpipe_addr(NP) \
1079 (((NP)->n_flags & NAME_ADDRSPEC_ISFILEORPIPE) != 0)
1081 /* Return skinned version of *NP*s name */
1082 #define skinned_name(NP) \
1083 (assert((NP)->n_flags & NAME_SKINNED), \
1084 ((struct name const*)NP)->n_name)
1086 /* Skin an address according to the RFC 822 interpretation of "host-phrase" */
1087 FL
char * skin(char const *name
);
1089 /* Skin *name* and extract the *addr-spec* according to RFC 5322.
1090 * Store the result in .ag_skinned and also fill in those .ag_ fields that have
1091 * actually been seen.
1092 * Return NULL on error, or name again, but which may have been replaced by
1093 * a version with fixed quotation etc.!
1094 * issingle_hack is a HACK that allows usage for `addrcodec' */
1095 FL
char const *n_addrspec_with_guts(struct n_addrguts
*agp
, char const *name
,
1096 bool_t doskin
, bool_t issingle_hack
);
1098 /* Fetch the real name from an internet mail address field */
1099 FL
char * realname(char const *name
);
1101 /* Get the list of senders (From: or Sender: or From_ line) from this message.
1102 * The return value may be empty and needs lextract()ion */
1103 FL
char *n_header_senderfield_of(struct message
*mp
);
1105 /* Trim away all leading Re: etc., return pointer to plain subject.
1106 * Note it doesn't perform any MIME decoding by itself */
1107 FL
char const *subject_re_trim(char const *cp
);
1109 FL
int msgidcmp(char const *s1
, char const *s2
);
1111 /* Fake Sender for From_ lines if missing, e. g. with POP3 */
1112 FL
char const * fakefrom(struct message
*mp
);
1114 /* From username Fri Jan 2 20:13:51 2004
1117 #if defined HAVE_IMAP_SEARCH || defined HAVE_IMAP
1118 FL
time_t unixtime(char const *from
);
1121 FL
time_t rfctime(char const *date
);
1123 FL
time_t combinetime(int year
, int month
, int day
,
1124 int hour
, int minute
, int second
);
1126 /* Determine the date to print in faked 'From ' lines */
1127 FL
void substdate(struct message
*m
);
1129 /* Create ready-to-go environment taking into account *datefield* etc.,
1130 * and return a result in auto-reclaimed storage.
1131 * TODO hack *color_tag_or_null could be set to n_COLOUR_TAG_SUM_OLDER.
1132 * time_current is used for comparison and must thus be up-to-date */
1133 FL
char *n_header_textual_date_info(struct message
*mp
,
1134 char const **color_tag_or_null
);
1136 /* Create ready-to-go sender name of a message in *cumulation_or_null, the
1137 * addresses only in *addr_or_null, the real names only in *name_real_or_null,
1138 * and the full names in *name_full_or_null, taking acount for *showname*.
1139 * If *is_to_or_null is set, *showto* and n_is_myname() are taken into account
1140 * when choosing which names to use.
1141 * The list as such is returned, or NULL if there is really none (empty strings
1142 * will be stored, then).
1143 * All results are in auto-reclaimed storage, but may point to the same string.
1144 * TODO *is_to_or_null could be set to whether we actually used To:, or not.
1145 * TODO n_header_textual_sender_info(): should only create a list of matching
1146 * TODO name objects, which the user can iterate over and o->to_str().. */
1147 FL
struct name
*n_header_textual_sender_info(struct message
*mp
,
1148 char **cumulation_or_null
, char **addr_or_null
,
1149 char **name_real_or_null
, char **name_full_or_null
,
1150 bool_t
*is_to_or_null
);
1152 /* TODO Weird thing that tries to fill in From: and Sender: */
1153 FL
void setup_from_and_sender(struct header
*hp
);
1155 /* Note: returns 0x1 if both args were NULL */
1156 FL
struct name
const * check_from_and_sender(struct name
const *fromfield
,
1157 struct name
const *senderfield
);
1160 FL
char * getsender(struct message
*m
);
1163 /* This returns NULL if hp is NULL or when no information is available.
1164 * hp remains unchanged (->h_in_reply_to is not set!) */
1165 FL
struct name
*n_header_setup_in_reply_to(struct header
*hp
);
1167 /* Fill in / reedit the desired header fields */
1168 FL
int grab_headers(enum n_go_input_flags gif
, struct header
*hp
,
1169 enum gfield gflags
, int subjfirst
);
1171 /* Check whether sep->ss_sexpr (or ->ss_sregex) matches any header of mp.
1172 * If sep->s_where (or >s_where_wregex) is set, restrict to given headers */
1173 FL bool_t
n_header_match(struct message
*mp
, struct search_expr
const *sep
);
1175 /* Verify whether len (UIZ_MAX=strlen) bytes of name form a standard or
1176 * otherwise known header name (that must not be used as a custom header).
1177 * Return the (standard) header name, or NULL */
1178 FL
char const *n_header_is_known(char const *name
, size_t len
);
1180 /* Add a custom header to the given list, in auto-reclaimed or heap memory */
1181 FL bool_t
n_header_add_custom(struct n_header_field
**hflp
, char const *dat
,
1188 /* `(un)?headerpick' */
1189 FL
int c_headerpick(void *vp
);
1190 FL
int c_unheaderpick(void *vp
);
1192 /* TODO Compat variants of the c_(un)?h*() series,
1193 * except for `retain' and `ignore', which are standardized */
1194 FL
int c_retain(void *vp
);
1195 FL
int c_ignore(void *vp
);
1196 FL
int c_unretain(void *vp
);
1197 FL
int c_unignore(void *vp
);
1199 FL
int c_saveretain(void *v
);
1200 FL
int c_saveignore(void *v
);
1201 FL
int c_unsaveretain(void *v
);
1202 FL
int c_unsaveignore(void *v
);
1204 FL
int c_fwdretain(void *v
);
1205 FL
int c_fwdignore(void *v
);
1206 FL
int c_unfwdretain(void *v
);
1207 FL
int c_unfwdignore(void *v
);
1209 /* Ignore object lifecycle. (Most of the time this interface deals with
1210 * special n_IGNORE_* objects, e.g., n_IGNORE_TYPE, though.)
1211 * isauto: whether auto-reclaimed storage is to be used for allocations;
1212 * if so, _del() needn't be called */
1213 FL
struct n_ignore
*n_ignore_new(bool_t isauto
);
1214 FL
void n_ignore_del(struct n_ignore
*self
);
1216 /* Are there just _any_ user settings covered by self? */
1217 FL bool_t
n_ignore_is_any(struct n_ignore
const *self
);
1219 /* Set an entry to retain (or ignore).
1220 * Returns FAL0 if dat is not a valid header field name or an invalid regular
1221 * expression, TRU1 if insertion took place, and TRUM1 if already set */
1222 FL bool_t
n_ignore_insert(struct n_ignore
*self
, bool_t retain
,
1223 char const *dat
, size_t len
);
1224 #define n_ignore_insert_cp(SELF,RT,CP) n_ignore_insert(SELF, RT, CP, UIZ_MAX)
1226 /* Returns TRU1 if retained, TRUM1 if ignored, FAL0 if not covered */
1227 FL bool_t
n_ignore_lookup(struct n_ignore
const *self
, char const *dat
,
1229 #define n_ignore_lookup_cp(SELF,CP) n_ignore_lookup(SELF, CP, UIZ_MAX)
1230 #define n_ignore_is_ign(SELF,FDAT,FLEN) \
1231 (n_ignore_lookup(SELF, FDAT, FLEN) == TRUM1)
1237 /* Return -1 on invalid spec etc., the number of matches otherwise */
1238 #ifdef HAVE_IMAP_SEARCH
1239 FL ssize_t
imap_search(char const *spec
, int f
);
1246 /* Return a file buffer all ready to read up the passed message pointer */
1247 FL
FILE * setinput(struct mailbox
*mp
, struct message
*m
,
1248 enum needspec need
);
1251 FL
enum okay
get_body(struct message
*mp
);
1253 /* Reset (free) the global message array */
1254 FL
void message_reset(void);
1256 /* Append the passed message descriptor onto the message array; if mp is NULL,
1257 * NULLify the entry at &[msgCount-1] */
1258 FL
void message_append(struct message
*mp
);
1260 /* Append a NULL message */
1261 FL
void message_append_null(void);
1263 /* Check whether sep->ss_sexpr (or ->ss_sregex) matches mp. If with_headers is
1264 * true then the headers will also be searched (as plain text) */
1265 FL bool_t
message_match(struct message
*mp
, struct search_expr
const *sep
,
1266 bool_t with_headers
);
1269 FL
struct message
* setdot(struct message
*mp
);
1271 /* Touch the named message by setting its MTOUCH flag. Touched messages have
1272 * the effect of not being sent back to the system mailbox on exit */
1273 FL
void touch(struct message
*mp
);
1275 /* Convert user string of message numbers and store the numbers into vector.
1276 * Returns the count of messages picked up or -1 on error */
1277 FL
int getmsglist(char const *buf
, int *vector
, int flags
);
1279 /* Find the first message whose flags&m==f and return its message number */
1280 FL
int first(int f
, int m
);
1282 /* Mark the named message by setting its mark bit */
1283 FL
void mark(int mesg
, int f
);
1290 FL
int maildir_setfile(char const *who
, char const *name
, enum fedit_mode fm
);
1292 FL bool_t
maildir_quit(bool_t hold_sigs_on
);
1294 FL
enum okay
maildir_append(char const *name
, FILE *fp
, long offset
);
1296 FL
enum okay
maildir_remove(char const *name
);
1297 #endif /* HAVE_MAILDIR */
1301 * Heap memory and automatically reclaimed storage, plus pseudo "alloca"
1304 /* Called from the (main)loops upon tick and break-off time to perform debug
1305 * checking and memory cleanup, including stack-top of auto-reclaimed storage */
1306 FL
void n_memory_reset(void);
1308 /* Fixate the current snapshot of our global auto-reclaimed storage instance,
1309 * so that further allocations become auto-reclaimed.
1310 * This is only called from main.c for the global arena */
1311 FL
void n_memory_pool_fixate(void);
1313 /* Lifetime management of a per-execution level arena (to be found in
1314 * n_go_data_ctx.gdc_mempool, lazy initialized).
1315 * _push() can be used by anyone to create a new stack layer in the current
1316 * per-execution level arena, which is layered upon the normal one (usually
1317 * provided by .gdc__mempool_buf, initialized as necessary).
1318 * This can be pop()ped again: popping a stack will remove all stacks "above"
1319 * it, i.e., those which have been pushed thereafter.
1320 * If NULL is popped then this means that the current per-execution level is
1321 * left and n_go_data_ctx.gdc_mempool is not NULL; an event loop tick also
1322 * causes all _push()ed stacks to be dropped (via n_memory_reset()) */
1323 FL
void n_memory_pool_push(void *vp
);
1324 FL
void n_memory_pool_pop(void *vp
);
1326 /* Generic heap memory */
1328 FL
void *n_alloc(size_t s n_MEMORY_DEBUG_ARGS
);
1329 FL
void *n_realloc(void *v
, size_t s n_MEMORY_DEBUG_ARGS
);
1330 FL
void *n_calloc(size_t nmemb
, size_t size n_MEMORY_DEBUG_ARGS
);
1331 FL
void n_free(void *vp n_MEMORY_DEBUG_ARGS
);
1333 /* TODO obsolete c{m,re,c}salloc -> n_* */
1334 #ifdef HAVE_MEMORY_DEBUG
1335 # define n_alloc(S) (n_alloc)(S, __FILE__, __LINE__)
1336 # define n_realloc(P,S) (n_realloc)(P, S, __FILE__, __LINE__)
1337 # define n_calloc(N,S) (n_calloc)(N, S, __FILE__, __LINE__)
1338 # define n_free(P) (n_free)(P, __FILE__, __LINE__)
1340 # define n_free(P) free(P)
1343 /* Fluctuating heap memory (supposed to exist for one command loop tick) */
1345 #define n_flux_alloc(S) n_alloc(S)
1346 #define n_flux_realloc(P,S) n_realloc(P, S)
1347 #define n_flux_calloc(N,S) n_calloc(N, S)
1348 #define n_flux_free(P) n_free(P)
1350 /* Auto-reclaimed storage */
1352 /* Lower memory pressure on auto-reclaimed storage for code which has
1353 * a sinus-curve looking style of memory usage, i.e., peak followed by release,
1354 * like, e.g., doing a task on all messages of a box in order.
1355 * Such code should call _create(), successively call _unroll() after
1356 * a single message has been handled, and finally _gut() */
1357 FL
void n_autorec_relax_create(void);
1358 FL
void n_autorec_relax_gut(void);
1359 FL
void n_autorec_relax_unroll(void);
1361 /* TODO obsolete srelax -> n_autorec_relax_* */
1362 #define srelax_hold() n_autorec_relax_create()
1363 #define srelax_rele() n_autorec_relax_gut()
1364 #define srelax() n_autorec_relax_unroll()
1366 /* Allocate size more bytes of space and return the address of the first byte
1367 * to the caller. An even number of bytes are always allocated so that the
1368 * space will always be on a word boundary */
1369 FL
void *n_autorec_alloc_from_pool(void *vp
, size_t size n_MEMORY_DEBUG_ARGS
);
1370 FL
void *n_autorec_calloc_from_pool(void *vp
, size_t nmemb
, size_t size
1371 n_MEMORY_DEBUG_ARGS
);
1372 #ifdef HAVE_MEMORY_DEBUG
1373 # define n_autorec_alloc_from_pool(VP,SZ) \
1374 (n_autorec_alloc_from_pool)(VP, SZ, __FILE__, __LINE__)
1375 # define n_autorec_calloc_from_pool(VP,NM,SZ) \
1376 (n_autorec_calloc_from_pool)(VP, NM, SZ, __FILE__, __LINE__)
1378 #define n_autorec_alloc(SZ) n_autorec_alloc_from_pool(NULL, SZ)
1379 #define n_autorec_calloc(NM,SZ) n_autorec_calloc_from_pool(NULL, NM, SZ)
1381 /* Pseudo alloca (and also auto-reclaimed in _memory_reset()/_pool_pop()) */
1382 FL
void *n_lofi_alloc(size_t size n_MEMORY_DEBUG_ARGS
);
1383 FL
void n_lofi_free(void *vp n_MEMORY_DEBUG_ARGS
);
1385 #ifdef HAVE_MEMORY_DEBUG
1386 # define n_lofi_alloc(SZ) (n_lofi_alloc)(SZ, __FILE__, __LINE__)
1387 # define n_lofi_free(P) (n_lofi_free)(P, __FILE__, __LINE__)
1390 /* The snapshot can be used in a local context, in order to free many
1391 * allocations in one go */
1392 FL
void *n_lofi_snap_create(void);
1393 FL
void n_lofi_snap_unroll(void *cookie
);
1396 #ifdef HAVE_MEMORY_DEBUG
1397 FL
int c_memtrace(void *v
);
1399 /* For immediate debugging purposes, it is possible to check on request */
1400 FL bool_t
n__memory_check(char const *file
, int line
);
1401 # define n_memory_check() n__memory_check(__FILE__, __LINE__)
1403 # define n_memory_check() do{;}while(0)
1410 /* *sendcharsets* .. *charset-8bit* iterator; *a_charset_to_try_first* may be
1411 * used to prepend a charset to this list (e.g., for *reply-in-same-charset*).
1412 * The returned boolean indicates charset_iter_is_valid().
1413 * Without HAVE_ICONV, this "iterates" over *ttycharset* only */
1414 FL bool_t
charset_iter_reset(char const *a_charset_to_try_first
);
1415 FL bool_t
charset_iter_next(void);
1416 FL bool_t
charset_iter_is_valid(void);
1417 FL
char const * charset_iter(void);
1419 /* And this is (xxx temporary?) which returns the iterator if that is valid and
1420 * otherwise either *charset-8bit* or *ttycharset*, dep. on HAVE_ICONV */
1421 FL
char const * charset_iter_or_fallback(void);
1423 FL
void charset_iter_recurse(char *outer_storage
[2]); /* TODO LEGACY */
1424 FL
void charset_iter_restore(char *outer_storage
[2]); /* TODO LEGACY */
1426 /* Check whether our headers will need MIME conversion */
1428 FL
char const * need_hdrconv(struct header
*hp
);
1431 /* Convert header fields from RFC 1522 format */
1432 FL
void mime_fromhdr(struct str
const *in
, struct str
*out
,
1433 enum tdflags flags
);
1435 /* Interpret MIME strings in parts of an address field */
1436 FL
char * mime_fromaddr(char const *name
);
1438 /* fwrite(3) performing the given MIME conversion */
1439 FL ssize_t
mime_write(char const *ptr
, size_t size
, FILE *f
,
1440 enum conversion convert
, enum tdflags dflags
,
1441 struct quoteflt
*qf
, struct str
*outrest
,
1442 struct str
*inrest
);
1443 FL ssize_t
xmime_write(char const *ptr
, size_t size
, /* TODO LEGACY */
1444 FILE *f
, enum conversion convert
, enum tdflags dflags
,
1445 struct str
*outrest
, struct str
*inrest
);
1449 * Content-Transfer-Encodings as defined in RFC 2045 (and RFC 2047):
1450 * - Quoted-Printable, section 6.7
1451 * - Base64, section 6.8
1452 * TODO For now this is pretty mixed up regarding this external interface
1453 * TODO (and due to that the code is, too).
1454 * TODO In v15.0 CTE will be filter based, and explicit conversion will
1455 * TODO gain clear error codes
1458 /* Default MIME Content-Transfer-Encoding: as via *mime-encoding* */
1459 FL
enum mime_enc
mime_enc_target(void);
1461 /* Map from a Content-Transfer-Encoding: header body (which may be NULL) */
1462 FL
enum mime_enc
mime_enc_from_ctehead(char const *hbody
);
1464 /* XXX Try to get rid of that */
1465 FL
char const * mime_enc_from_conversion(enum conversion
const convert
);
1467 /* How many characters of (the complete body) ln need to be quoted.
1468 * Only MIMEEF_ISHEAD and MIMEEF_ISENCWORD are understood */
1469 FL
size_t mime_enc_mustquote(char const *ln
, size_t lnlen
,
1470 enum mime_enc_flags flags
);
1472 /* How much space is necessary to encode len bytes in QP, worst case.
1473 * Includes room for terminator, UIZ_MAX on overflow */
1474 FL
size_t qp_encode_calc_size(size_t len
);
1476 /* If flags includes QP_ISHEAD these assume "word" input and use special
1477 * quoting rules in addition; soft line breaks are not generated.
1478 * Otherwise complete input lines are assumed and soft line breaks are
1479 * generated as necessary. Return NULL on error (overflow) */
1480 FL
struct str
* qp_encode(struct str
*out
, struct str
const *in
,
1481 enum qpflags flags
);
1483 FL
struct str
* qp_encode_cp(struct str
*out
, char const *cp
,
1484 enum qpflags flags
);
1485 FL
struct str
* qp_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
1486 enum qpflags flags
);
1489 /* The buffers of out and *rest* will be managed via n_realloc().
1490 * If inrest_or_null is needed but NULL an error occurs, otherwise tolerant.
1491 * Return FAL0 on error; caller is responsible to free buffers */
1492 FL bool_t
qp_decode_header(struct str
*out
, struct str
const *in
);
1493 FL bool_t
qp_decode_part(struct str
*out
, struct str
const *in
,
1494 struct str
*outrest
, struct str
*inrest_or_null
);
1496 /* How much space is necessary to encode len bytes in Base64, worst case.
1497 * Includes room for (CR/LF/CRLF and) terminator, UIZ_MAX on overflow */
1498 FL
size_t b64_encode_calc_size(size_t len
);
1500 /* Note these simply convert all the input (if possible), including the
1501 * insertion of NL sequences if B64_CRLF or B64_LF is set (and multiple thereof
1502 * if B64_MULTILINE is set).
1503 * Thus, in the B64_BUF case, better call b64_encode_calc_size() first.
1504 * Return NULL on error (overflow; cannot happen for B64_BUF) */
1505 FL
struct str
* b64_encode(struct str
*out
, struct str
const *in
,
1506 enum b64flags flags
);
1507 FL
struct str
* b64_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
1508 enum b64flags flags
);
1510 FL
struct str
* b64_encode_cp(struct str
*out
, char const *cp
,
1511 enum b64flags flags
);
1514 /* The _{header,part}() variants are failure tolerant, the latter requires
1515 * outrest to be set; due to the odd 4:3 relation inrest_or_null should be
1516 * given, _then_, it is an error if it is needed but not set.
1517 * TODO pre v15 callers should ensure that no endless loop is entered because
1518 * TODO the inrest cannot be converted and ends up as inrest over and over:
1519 * TODO give NULL to stop such loops.
1520 * The buffers of out and possibly *rest* will be managed via n_realloc().
1521 * Returns FAL0 on error; caller is responsible to free buffers.
1522 * XXX FAL0 is effectively not returned for _part*() variants,
1523 * XXX (instead replacement characters are produced for invalid data.
1524 * XXX _Unless_ operation could EOVERFLOW.)
1525 * XXX I.e. this is bad and is tolerant for text and otherwise not */
1526 FL bool_t
b64_decode(struct str
*out
, struct str
const *in
);
1527 FL bool_t
b64_decode_header(struct str
*out
, struct str
const *in
);
1528 FL bool_t
b64_decode_part(struct str
*out
, struct str
const *in
,
1529 struct str
*outrest
, struct str
*inrest_or_null
);
1535 /* Get a mime style parameter from a header body */
1536 FL
char * mime_param_get(char const *param
, char const *headerbody
);
1538 /* Format parameter name to have value, autorec_alloc() it or NULL in result.
1539 * 0 on error, 1 or -1 on success: the latter if result contains \n newlines,
1540 * which it will if the created param requires more than MIME_LINELEN bytes;
1541 * there is never a trailing newline character */
1542 /* TODO mime_param_create() should return a StrList<> or something.
1543 * TODO in fact it should take a HeaderField* and append a HeaderFieldParam*! */
1544 FL si8_t
mime_param_create(struct str
*result
, char const *name
,
1547 /* Get the boundary out of a Content-Type: multipart/xyz header field, return
1548 * autorec_alloc()ed copy of it; store strlen() in *len if set */
1549 FL
char * mime_param_boundary_get(char const *headerbody
, size_t *len
);
1551 /* Create a autorec_alloc()ed MIME boundary */
1552 FL
char * mime_param_boundary_create(void);
1558 /* Create MIME part object tree for and of mp */
1559 FL
struct mimepart
* mime_parse_msg(struct message
*mp
,
1560 enum mime_parse_flags mpf
);
1566 /* `(un)?mimetype' commands */
1567 FL
int c_mimetype(void *v
);
1568 FL
int c_unmimetype(void *v
);
1570 /* Check whether the Content-Type name is internally known */
1571 FL bool_t
n_mimetype_check_mtname(char const *name
);
1573 /* Return a Content-Type matching the name, or NULL if none could be found */
1574 FL
char *n_mimetype_classify_filename(char const *name
);
1576 /* Classify content of *fp* as necessary and fill in arguments; **charset* is
1577 * set to *charset-7bit* or charset_iter_or_fallback() if NULL */
1578 FL
enum conversion
n_mimetype_classify_file(FILE *fp
, char const **contenttype
,
1579 char const **charset
, int *do_iconv
);
1581 /* Dependend on *mime-counter-evidence* mpp->m_ct_type_usr_ovwr will be set,
1582 * but otherwise mpp is const. for_user_context rather maps 1:1 to
1583 * MIME_PARSE_FOR_USER_CONTEXT */
1584 FL
enum mimecontent
n_mimetype_classify_part(struct mimepart
*mpp
,
1585 bool_t for_user_context
);
1587 /* Query handler for a part, return the plain type (& MIME_HDL_TYPE_MASK).
1588 * mhp is anyway initialized (mh_flags, mh_msg) */
1589 FL
enum mime_handler_flags
n_mimetype_handler(struct mime_handler
*mhp
,
1590 struct mimepart
const *mpp
,
1591 enum sendaction action
);
1597 /* Allocate a single element of a name list, initialize its name field to the
1598 * passed name and return it */
1599 FL
struct name
* nalloc(char const *str
, enum gfield ntype
);
1601 /* Alloc an Fcc: entry TODO temporary only i hope */
1602 FL
struct name
*nalloc_fcc(char const *file
);
1604 /* Like nalloc(), but initialize from content of np */
1605 FL
struct name
* ndup(struct name
*np
, enum gfield ntype
);
1607 /* Concatenate the two passed name lists, return the result */
1608 FL
struct name
* cat(struct name
*n1
, struct name
*n2
);
1611 FL
struct name
* namelist_dup(struct name
const *np
, enum gfield ntype
);
1613 /* Determine the number of undeleted elements in a name list and return it;
1614 * the latter also doesn't count file and pipe addressees in addition */
1615 FL ui32_t
count(struct name
const *np
);
1616 FL ui32_t
count_nonlocal(struct name
const *np
);
1618 /* Extract a list of names from a line, and make a list of names from it.
1619 * Return the list or NULL if none found */
1620 FL
struct name
* extract(char const *line
, enum gfield ntype
);
1622 /* Like extract() unless line contains anyof ",\"\\(<|", in which case
1623 * comma-separated list extraction is used instead */
1624 FL
struct name
* lextract(char const *line
, enum gfield ntype
);
1626 /* Turn a list of names into a string of the same names */
1627 FL
char * detract(struct name
*np
, enum gfield ntype
);
1629 /* Get a lextract() list via n_go_input_cp(), reassigning to *np* */
1630 FL
struct name
* grab_names(enum n_go_input_flags gif
, char const *field
,
1631 struct name
*np
, int comma
, enum gfield gflags
);
1633 /* Check whether n1 n2 share the domain name */
1634 FL bool_t
name_is_same_domain(struct name
const *n1
,
1635 struct name
const *n2
);
1637 /* Check all addresses in np and delete invalid ones; if set_on_error is not
1638 * NULL it'll be set to TRU1 for error or -1 for "hard fail" error */
1639 FL
struct name
* checkaddrs(struct name
*np
, enum expand_addr_check_mode eacm
,
1640 si8_t
*set_on_error
);
1642 /* Vaporise all duplicate addresses in hp (.h_(to|cc|bcc)) so that an address
1643 * that "first" occurs in To: is solely in there, ditto Cc:, after expanding
1644 * aliases etc. eacm and set_on_error are passed to checkaddrs(), metoo is
1645 * passed to usermap(). After updating hp to the new state this returns
1646 * a flat list of all addressees, which may be NULL */
1647 FL
struct name
* namelist_vaporise_head(struct header
*hp
,
1648 enum expand_addr_check_mode eacm
, bool_t metoo
,
1649 si8_t
*set_on_error
);
1651 /* Map all of the aliased users in the invoker's mailrc file and insert them
1653 FL
struct name
* usermap(struct name
*names
, bool_t force_metoo
);
1655 /* Remove all of the duplicates from the passed name list by insertion sorting
1656 * them, then checking for dups. Return the head of the new list */
1657 FL
struct name
* elide(struct name
*names
);
1659 /* `(un)?alternates' deal with the list of alternate names */
1660 FL
int c_alternates(void *v
);
1661 FL
int c_unalternates(void *v
);
1663 /* If keep_single is set one alternates member will be allowed in np */
1664 FL
struct name
*n_alternates_remove(struct name
*np
, bool_t keep_single
);
1666 /* Likewise, is name an alternate in broadest sense? */
1667 FL bool_t
n_is_myname(char const *name
);
1670 FL
int c_addrcodec(void *vp
);
1672 /* `(un)?commandalias'.
1673 * And whether a `commandalias' name exists, returning name or NULL, pointing
1674 * expansion_or_null to expansion if set: both point into internal storage */
1675 FL
int c_commandalias(void *vp
);
1676 FL
int c_uncommandalias(void *vp
);
1678 FL
char const *n_commandalias_exists(char const *name
,
1679 struct str
const **expansion_or_null
);
1681 /* Is name a valid alias */
1682 FL bool_t
n_alias_is_valid_name(char const *name
);
1685 FL
int c_alias(void *v
);
1686 FL
int c_unalias(void *v
);
1688 /* `(un)?ml(ist|subscribe)', and a check whether a name is a (wanted) list;
1689 * give MLIST_OTHER to the latter to search for any, in which case all
1690 * receivers are searched until EOL or MLIST_SUBSCRIBED is seen */
1691 FL
int c_mlist(void *v
);
1692 FL
int c_unmlist(void *v
);
1693 FL
int c_mlsubscribe(void *v
);
1694 FL
int c_unmlsubscribe(void *v
);
1696 FL
enum mlist_state
is_mlist(char const *name
, bool_t subscribed_only
);
1697 FL
enum mlist_state
is_mlist_mp(struct message
*mp
, enum mlist_state what
);
1699 /* `(un)?shortcut', and check if str is one, return expansion or NULL */
1700 FL
int c_shortcut(void *v
);
1701 FL
int c_unshortcut(void *v
);
1703 FL
char const * shortcut_expand(char const *str
);
1705 /* `(un)?charsetalias', and try to expand a charset, return mapping or itself.
1706 * The charset to expand must have gone through iconv_normalize_name() */
1707 FL
int c_charsetalias(void *vp
);
1708 FL
int c_uncharsetalias(void *vp
);
1710 FL
char const *n_charsetalias_expand(char const *cp
);
1712 /* `(un)?filetype', and check whether file has a known (stat(2)ed) "equivalent",
1713 * as well as check whether (extension of) file is known, respectively;
1714 * res_or_null can be NULL, otherwise on success result data must be copied */
1715 FL
int c_filetype(void *vp
);
1716 FL
int c_unfiletype(void *vp
);
1718 FL bool_t
n_filetype_trial(struct n_file_type
*res_or_null
, char const *file
);
1719 FL bool_t
n_filetype_exists(struct n_file_type
*res_or_null
, char const *file
);
1725 /* Test to see if the passed file name is a directory, return true if it is.
1726 * If check_access is set, we also access(2): if it is TRUM1 only X_OK|R_OK is
1727 * tested, otherwise X_OK|R_OK|W_OK. */
1728 FL bool_t
n_is_dir(char const *name
, bool_t check_access
);
1730 /* Recursively create a directory */
1731 FL bool_t
n_path_mkdir(char const *name
);
1733 /* Delete a file, but only if the file is a plain file; return FAL0 on system
1734 * error and TRUM1 if name is not a plain file, return TRU1 on success */
1735 FL bool_t
n_path_rm(char const *name
);
1737 /* A get-wd..restore-wd approach */
1738 FL
enum okay
cwget(struct cw
*cw
);
1739 FL
enum okay
cwret(struct cw
*cw
);
1740 FL
void cwrelse(struct cw
*cw
);
1748 FL
enum okay
pop3_noop(void);
1751 FL
int pop3_setfile(char const *who
, char const *server
, enum fedit_mode fm
);
1754 FL
enum okay
pop3_header(struct message
*m
);
1757 FL
enum okay
pop3_body(struct message
*m
);
1760 FL bool_t
pop3_quit(bool_t hold_sigs_on
);
1761 #endif /* HAVE_POP3 */
1765 * Subprocesses, popen, but also file handling with registering
1768 /* For program startup in main.c: initialize process manager */
1769 FL
void n_child_manager_start(void);
1771 /* xflags may be NULL. Implied: cloexec */
1772 FL
FILE * safe_fopen(char const *file
, char const *oflags
, int *xflags
);
1774 /* oflags implied: cloexec,OF_REGISTER.
1775 * Exception is Fdopen() if nocloexec is TRU1, but otherwise even for it the fd
1776 * creator has to take appropriate steps in order to ensure this is true! */
1777 FL
FILE * Fopen(char const *file
, char const *oflags
);
1778 FL
FILE * Fdopen(int fd
, char const *oflags
, bool_t nocloexec
);
1780 FL
int Fclose(FILE *fp
);
1782 /* TODO: Should be Mailbox::create_from_url(URL::from_string(DATA))!
1783 * Open file according to oflags (see popen.c). Handles compressed files,
1784 * maildir etc. If ft_or_null is given it will be filled accordingly */
1785 FL
FILE * n_fopen_any(char const *file
, char const *oflags
,
1786 enum n_fopen_state
*fs_or_null
);
1788 /* Create a temporary file in *TMPDIR*, use namehint for its name (prefix
1789 * unless OF_SUFFIX is set, in which case namehint is an extension that MUST be
1790 * part of the resulting filename, otherwise Ftmp() will fail), store the
1791 * unique name in fn if set (and unless OF_UNLINK is set in oflags), creating
1792 * n_alloc() storage or n_autorec_alloc() if OF_NAME_AUTOREC is set,
1793 * and return a stdio FILE pointer with access oflags.
1794 * One of OF_WRONLY and OF_RDWR must be set. Implied: 0600,cloexec */
1795 FL
FILE * Ftmp(char **fn
, char const *namehint
, enum oflags oflags
);
1797 /* If OF_HOLDSIGS was set when calling Ftmp(), then hold_all_sigs() had been
1798 * called: call this to unlink(2) and free *fn and to rele_all_sigs() */
1799 FL
void Ftmp_release(char **fn
);
1801 /* Free the resources associated with the given filename. To be called after
1803 FL
void Ftmp_free(char **fn
);
1805 /* Create a pipe and ensure CLOEXEC bit is set in both descriptors */
1806 FL bool_t
pipe_cloexec(int fd
[2]);
1809 * env_addon may be NULL, otherwise it is expected to be a NULL terminated
1810 * array of "K=V" strings to be placed into the childs environment.
1811 * If cmd==(char*)-1 then shell is indeed expected to be a PTF :P that will be
1812 * called from within the child process.
1813 * n_psignal() takes a FILE* returned by Popen, and returns <0 if no process
1814 * can be found, 0 on success, and an errno number on kill(2) failure */
1815 FL
FILE *Popen(char const *cmd
, char const *mode
, char const *shell
,
1816 char const **env_addon
, int newfd1
);
1817 FL bool_t
Pclose(FILE *fp
, bool_t dowait
);
1818 VL
int n_psignal(FILE *fp
, int sig
);
1820 /* In n_PSO_INTERACTIVE, we want to go over $PAGER.
1821 * These are specialized version of Popen()/Pclose() which also encapsulate
1822 * error message printing, terminal handling etc. additionally */
1823 FL
FILE * n_pager_open(void);
1824 FL bool_t
n_pager_close(FILE *fp
);
1827 FL
void close_all_files(void);
1829 /* Run a command without a shell, with optional arguments and splicing of stdin
1830 * and stdout. FDs may also be n_CHILD_FD_NULL and n_CHILD_FD_PASS, meaning
1831 * to redirect from/to /dev/null or pass through our own set of FDs; in the
1832 * latter case terminal capabilities are saved/restored if possible.
1833 * The command name can be a sequence of words.
1834 * Signals must be handled by the caller. "Mask" contains the signals to
1835 * ignore in the new process. SIGINT is enabled unless it's in the mask.
1836 * If env_addon_or_null is set, it is expected to be a NULL terminated
1837 * array of "K=V" strings to be placed into the childs environment.
1838 * wait_status_or_null is set to waitpid(2) status if given */
1839 FL
int n_child_run(char const *cmd
, sigset_t
*mask
, int infd
, int outfd
,
1840 char const *a0_or_null
, char const *a1_or_null
, char const *a2_or_null
,
1841 char const **env_addon_or_null
, int *wait_status_or_null
);
1843 /* Like n_child_run(), but don't wait for the command to finish (use
1844 * n_child_wait() for waiting on a successful return value).
1845 * Also it is usually an error to use n_CHILD_FD_PASS for this one */
1846 FL
int n_child_start(char const *cmd
, sigset_t
*mask
, int infd
, int outfd
,
1847 char const *a0_or_null
, char const *a1_or_null
, char const *a2_or_null
,
1848 char const **env_addon_or_null
);
1850 /* Fork a child process, enable the other three:
1851 * - in-child image preparation
1852 * - mark a child as don't care
1853 * - wait for child pid, return whether we've had a normal n_EXIT_OK exit.
1854 * If wait_status_or_null is set, it is set to the waitpid(2) status */
1855 FL
int n_child_fork(void);
1856 FL
void n_child_prepare(sigset_t
*nset
, int infd
, int outfd
);
1857 FL
void n_child_free(int pid
);
1858 FL bool_t
n_child_wait(int pid
, int *wait_status_or_null
);
1864 /* Save all of the undetermined messages at the top of "mbox". Save all
1865 * untouched messages back in the system mailbox. Remove the system mailbox,
1866 * if none saved there.
1867 * TODO v15 Note: assumes hold_sigs() has been called _and_ can be temporarily
1868 * TODO dropped via a single rele_sigs() if hold_sigs_on */
1869 FL bool_t
quit(bool_t hold_sigs_on
);
1871 /* Adjust the message flags in each message */
1872 FL
int holdbits(void);
1874 /* Create another temporary file and copy user's mbox file darin. If there is
1875 * no mbox, copy nothing. If he has specified "append" don't copy his mailbox,
1876 * just copy saveable entries at the end */
1877 FL
enum okay
makembox(void);
1879 FL
void save_mbox_for_possible_quitstuff(void); /* TODO DROP IF U CAN */
1881 FL
int savequitflags(void);
1883 FL
void restorequitflags(int);
1889 /* Send message described by the passed pointer to the passed output buffer.
1890 * Return -1 on error. Adjust the status: field if need be. If doitp is
1891 * given, suppress ignored header fields. prefix is a string to prepend to
1892 * each output line. action = data destination
1893 * (SEND_MBOX,_TOFILE,_TODISP,_QUOTE,_DECRYPT). stats[0] is line count,
1894 * stats[1] is character count. stats may be NULL. Note that stats[0] is
1895 * valid for SEND_MBOX only */
1896 FL
int sendmp(struct message
*mp
, FILE *obuf
,
1897 struct n_ignore
const *doitp
,
1898 char const *prefix
, enum sendaction action
, ui64_t
*stats
);
1904 /* Interface between the argument list and the mail1 routine which does all the
1906 FL
int mail(struct name
*to
, struct name
*cc
, struct name
*bcc
,
1907 char const *subject
, struct attachment
*attach
,
1908 char const *quotefile
, int recipient_record
);
1910 /* `mail' and `Mail' commands, respectively */
1911 FL
int c_sendmail(void *v
);
1912 FL
int c_Sendmail(void *v
);
1914 /* Mail a message on standard input to the people indicated in the passed
1915 * header. (Internal interface) */
1916 FL
enum okay
mail1(struct header
*hp
, int printheaders
,
1917 struct message
*quote
, char const *quotefile
,
1918 int recipient_record
, bool_t is_fwding
);
1920 /* Create a Date: header field.
1921 * We compare the localtime() and gmtime() results to get the timezone, because
1922 * numeric timezones are easier to read and because $TZ isn't always set */
1923 FL
int mkdate(FILE *fo
, char const *field
);
1925 /* Dump the to, subject, cc header on the passed file buffer.
1926 * nosend_msg tells us not to dig to deep but to instead go for compose mode or
1927 * editing a message (yet we're stupid and cannot do it any better) - if it is
1928 * TRUM1 then we're really in compose mode and will produce some fields for
1929 * easier filling in (see n_run_editor() proto for this hack) */
1930 FL bool_t
n_puthead(bool_t nosend_msg
, struct header
*hp
, FILE *fo
,
1931 enum gfield w
, enum sendaction action
,
1932 enum conversion convert
, char const *contenttype
,
1933 char const *charset
);
1936 FL
enum okay
resend_msg(struct message
*mp
, struct header
*hp
,
1940 FL
void savedeadletter(FILE *fp
, bool_t fflush_rewind_first
);
1946 /* Evaluate the string given as a new mailbox name. Supported meta characters:
1947 * . % for my system mail box
1948 * . %user for user's system mail box
1949 * . # for previous file
1950 * . & invoker's mbox file
1951 * . +file file in folder directory
1952 * . any shell meta character (except for FEXP_NSHELL).
1953 * a poor man's vis(3), on name before calling this (and showing the user).
1954 * If FEXP_MULTIOK is set we return an array of terminated strings, the (last)
1955 * result string is terminated via \0\0 and n_PS_EXPAND_MULTIRESULT is set.
1956 * Returns the file name as an auto-reclaimed string */
1957 FL
char *fexpand(char const *name
, enum fexp_mode fexpm
);
1959 /* Parse the next shell token from input (->s and ->l are adjusted to the
1960 * remains, data is constant beside that; ->s may be NULL if ->l is 0, if ->l
1961 * EQ UIZ_MAX strlen(->s) is used) and append the resulting output to store.
1962 * If cookie is not NULL and we're in double-quotes then ${@} will be exploded
1963 * just as known from the sh(1)ell in that case */
1964 FL
enum n_shexp_state
n_shexp_parse_token(enum n_shexp_parse_flags flags
,
1965 struct n_string
*store
, struct str
*input
,
1966 void const **cookie
);
1968 /* Quick+dirty simplified : if an error occurs, returns a copy of *cp and set
1969 * *cp to NULL, otherwise advances *cp to over the parsed token */
1970 FL
char *n_shexp_parse_token_cp(enum n_shexp_parse_flags flags
,
1973 /* Quote input in a way that can, in theory, be fed into parse_token() again.
1974 * ->s may be NULL if ->l is 0, if ->l EQ UIZ_MAX strlen(->s) is used.
1975 * If rndtrip is true we try to make the resulting string "portable" (by
1976 * converting Unicode to \u etc.), otherwise we produce something to be
1977 * consumed "now", i.e., to display for the user.
1978 * Resulting output is _appended_ to store.
1979 * TODO Note: last resort, since \u and $ expansions etc. are necessarily
1980 * TODO already expanded and can thus not be reverted, but ALL we have */
1981 FL
struct n_string
*n_shexp_quote(struct n_string
*store
,
1982 struct str
const *input
, bool_t rndtrip
);
1983 FL
char *n_shexp_quote_cp(char const *cp
, bool_t rndtrip
);
1985 /* Can name be used as a variable name? I.e., this returns false for special
1986 * parameter names like $# etc. */
1987 FL bool_t
n_shexp_is_valid_varname(char const *name
);
1990 FL
int c_shcodec(void *vp
);
1997 FL
int c_sigstate(void *);
2000 FL
void n_raise(int signo
);
2002 /* Provide BSD-like signal() on all systems TODO v15 -> SysV -> n_signal() */
2003 FL sighandler_type
safe_signal(int signum
, sighandler_type handler
);
2005 /* Provide reproducable non-restartable signal handler installation */
2006 FL n_sighdl_t
n_signal(int signo
, n_sighdl_t hdl
);
2008 /* Hold *all* signals but SIGCHLD, and release that total block again */
2009 FL
void hold_all_sigs(void);
2010 FL
void rele_all_sigs(void);
2012 /* Hold HUP/QUIT/INT */
2013 FL
void hold_sigs(void);
2014 FL
void rele_sigs(void);
2016 /* Call _ENTER_SWITCH() with the according flags, it'll take care for the rest
2017 * and also set the jump buffer - it returns 0 if anything went fine and
2018 * a signal number if a jump occurred, in which case all handlers requested in
2019 * flags are temporarily SIG_IGN.
2020 * _cleanup_ping() informs the condome that no jumps etc. shall be performed
2021 * until _leave() is called in the following -- to be (optionally) called right
2022 * before the local jump label is reached which is jumped to after a long jump
2023 * occurred, straight code flow provided, e.g., to avoid destructors to be
2024 * called twice. _leave() must always be called last, reraise_flags will be
2025 * used to decide how signal handling has to continue
2027 #define n_SIGMAN_ENTER_SWITCH(S,F) do{\
2030 if(sigsetjmp((S)->sm_jump, 1))\
2034 n__sigman_enter(S, __x__);\
2035 }while(0); switch((S)->sm_signo)
2036 FL
int n__sigman_enter(struct n_sigman
*self
, int flags
);
2037 FL
void n_sigman_cleanup_ping(struct n_sigman
*self
);
2038 FL
void n_sigman_leave(struct n_sigman
*self
, enum n_sigman_flags flags
);
2040 /* Pending signal or 0? */
2041 FL
int n_sigman_peek(void);
2042 FL
void n_sigman_consume(void);
2044 /* Not-Yet-Dead debug information (handler installation in main.c) */
2045 #if defined HAVE_DEBUG || defined HAVE_DEVEL
2046 FL
void _nyd_chirp(ui8_t act
, char const *file
, ui32_t line
,
2048 FL
void _nyd_oncrash(int signo
);
2051 # define NYD_ENTER _nyd_chirp(1, __FILE__, __LINE__, __FUN__)
2052 # define NYD_LEAVE _nyd_chirp(2, __FILE__, __LINE__, __FUN__)
2053 # define NYD _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
2054 # define NYD_X _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
2056 # define NYD2_ENTER _nyd_chirp(1, __FILE__, __LINE__, __FUN__)
2057 # define NYD2_LEAVE _nyd_chirp(2, __FILE__, __LINE__, __FUN__)
2058 # define NYD2 _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
2064 # define NYD_ENTER do {} while (0)
2065 # define NYD_LEAVE do {} while (0)
2066 # define NYD do {} while (0)
2067 # define NYD_X do {} while (0) /* XXX LEGACY */
2070 # define NYD2_ENTER do {} while (0)
2071 # define NYD2_LEAVE do {} while (0)
2072 # define NYD2 do {} while (0)
2080 /* Send a message via SMTP */
2081 FL bool_t
smtp_mta(struct sendbundle
*sbp
);
2089 /* Immediately closes the socket for CPROTO_CERTINFO */
2090 FL bool_t
sopen(struct sock
*sp
, struct url
*urlp
);
2091 FL
int sclose(struct sock
*sp
);
2092 FL
enum okay
swrite(struct sock
*sp
, char const *data
);
2093 FL
enum okay
swrite1(struct sock
*sp
, char const *data
, int sz
,
2097 FL
int sgetline(char **line
, size_t *linesize
, size_t *linelen
,
2098 struct sock
*sp n_MEMORY_DEBUG_ARGS
);
2099 # ifdef HAVE_MEMORY_DEBUG
2100 # define sgetline(A,B,C,D) sgetline(A, B, C, D, __FILE__, __LINE__)
2109 /* Direct mappings of the various spam* commands */
2110 FL
int c_spam_clear(void *v
);
2111 FL
int c_spam_set(void *v
);
2112 FL
int c_spam_forget(void *v
);
2113 FL
int c_spam_ham(void *v
);
2114 FL
int c_spam_rate(void *v
);
2115 FL
int c_spam_spam(void *v
);
2122 /* Return a pointer to a dynamic copy of the argument */
2123 FL
char * savestr(char const *str n_MEMORY_DEBUG_ARGS
);
2124 FL
char * savestrbuf(char const *sbuf
, size_t slen n_MEMORY_DEBUG_ARGS
);
2125 #ifdef HAVE_MEMORY_DEBUG
2126 # define savestr(CP) savestr(CP, __FILE__, __LINE__)
2127 # define savestrbuf(CBP,CBL) savestrbuf(CBP, CBL, __FILE__, __LINE__)
2130 /* Concatenate cp2 onto cp1 (if not NULL), separated by sep (if not '\0') */
2131 FL
char * savecatsep(char const *cp1
, char sep
, char const *cp2
2132 n_MEMORY_DEBUG_ARGS
);
2133 #ifdef HAVE_MEMORY_DEBUG
2134 # define savecatsep(S1,SEP,S2) savecatsep(S1, SEP, S2, __FILE__, __LINE__)
2137 /* Make copy of argument incorporating old one, if set, separated by space */
2138 #define save2str(S,O) savecatsep(O, ' ', S)
2141 #define savecat(S1,S2) savecatsep(S1, '\0', S2)
2144 FL
struct str
* str_concat_csvl(struct str
*self
, ...);
2147 FL
struct str
* str_concat_cpa(struct str
*self
, char const * const *cpa
,
2148 char const *sep_o_null n_MEMORY_DEBUG_ARGS
);
2149 #ifdef HAVE_MEMORY_DEBUG
2150 # define str_concat_cpa(S,A,N) str_concat_cpa(S, A, N, __FILE__, __LINE__)
2153 /* Plain char* support, not auto-reclaimed (unless noted) */
2155 /* Are any of the characters in template contained in dat? */
2156 FL bool_t
n_anyof_buf(char const *template, char const *dat
, size_t len
);
2157 #define n_anyof_cp(S1,S2) n_anyof_buf(S1, S2, UIZ_MAX)
2159 /* Treat *iolist as a sep separated list of strings; find and return the
2160 * next entry, trimming surrounding whitespace, and point *iolist to the next
2161 * entry or to NULL if no more entries are contained. If ignore_empty is
2162 * set empty entries are started over.
2163 * strsep_esc() is identical but allows reverse solidus escaping of sep, too.
2164 * Return NULL or an entry */
2165 FL
char *n_strsep(char **iolist
, char sep
, bool_t ignore_empty
);
2166 FL
char *n_strsep_esc(char **iolist
, char sep
, bool_t ignore_empty
);
2168 /* Is *as1* a valid prefix of *as2*? */
2169 FL bool_t
is_prefix(char const *as1
, char const *as2
);
2171 /* Reverse solidus quote (" and \) v'alue, and return autorec_alloc()ed */
2172 FL
char * string_quote(char const *v
);
2174 /* Get (and isolate) the last, possibly quoted part of linebuf, set *needs_list
2175 * to indicate whether getmsglist() et al need to be called to collect
2176 * additional args that remain in linebuf. If strip is true possibly
2177 * surrounding quote characters are removed. Return NULL on "error" */
2178 FL
char * laststring(char *linebuf
, bool_t
*needs_list
, bool_t strip
);
2180 /* Convert a string to lowercase, in-place and with multibyte-aware */
2181 FL
void makelow(char *cp
);
2183 /* Is *sub* a substring of *str*, case-insensitive and multibyte-aware? */
2184 FL bool_t
substr(char const *str
, char const *sub
);
2187 FL
char * sstpcpy(char *dst
, char const *src
);
2188 FL
char * sstrdup(char const *cp n_MEMORY_DEBUG_ARGS
);
2189 FL
char * sbufdup(char const *cp
, size_t len n_MEMORY_DEBUG_ARGS
);
2190 #ifdef HAVE_MEMORY_DEBUG
2191 # define sstrdup(CP) sstrdup(CP, __FILE__, __LINE__)
2192 # define sbufdup(CP,L) sbufdup(CP, L, __FILE__, __LINE__)
2195 /* Copy at most dstsize bytes of src to dst and return string length.
2196 * Returns -E2BIG if dst is not large enough; dst will always be terminated
2197 * unless dstsize was 0 on entry */
2198 FL ssize_t
n_strscpy(char *dst
, char const *src
, size_t dstsize
);
2200 /* Case-independent ASCII comparisons */
2201 FL
int asccasecmp(char const *s1
, char const *s2
);
2202 FL
int ascncasecmp(char const *s1
, char const *s2
, size_t sz
);
2204 /* Case-independent ASCII string find s2 in s1, return it or NULL */
2205 FL
char const *asccasestr(char const *s1
, char const *s2
);
2207 /* Case-independent ASCII check whether as1 is the initial substring of as2 */
2208 FL bool_t
is_asccaseprefix(char const *as1
, char const *as2
);
2209 FL bool_t
is_ascncaseprefix(char const *as1
, char const *as2
, size_t sz
);
2211 /* struct str related support funs TODO _cp->_cs! */
2213 /* *self->s* is n_realloc()ed */
2214 #define n_str_dup(S, T) n_str_assign_buf((S), (T)->s, (T)->l)
2216 /* *self->s* is n_realloc()ed; if buflen==UIZ_MAX strlen() is called unless
2217 * buf is NULL; buf may be NULL if buflen is 0 */
2218 FL
struct str
* n_str_assign_buf(struct str
*self
,
2219 char const *buf
, uiz_t buflen n_MEMORY_DEBUG_ARGS
);
2220 #define n_str_assign(S, T) n_str_assign_buf(S, (T)->s, (T)->l)
2221 #define n_str_assign_cp(S, CP) n_str_assign_buf(S, CP, UIZ_MAX)
2223 /* *self->s* is n_realloc()ed, *self->l* incremented; if buflen==UIZ_MAX
2224 * strlen() is called unless buf is NULL; buf may be NULL if buflen is 0 */
2225 FL
struct str
* n_str_add_buf(struct str
*self
, char const *buf
, uiz_t buflen
2226 n_MEMORY_DEBUG_ARGS
);
2227 #define n_str_add(S, T) n_str_add_buf(S, (T)->s, (T)->l)
2228 #define n_str_add_cp(S, CP) n_str_add_buf(S, CP, UIZ_MAX)
2230 #ifdef HAVE_MEMORY_DEBUG
2231 # define n_str_assign_buf(S,B,BL) n_str_assign_buf(S, B, BL, __FILE__, __LINE__)
2232 # define n_str_add_buf(S,B,BL) n_str_add_buf(S, B, BL, __FILE__, __LINE__)
2235 /* Remove leading and trailing spacechar()s and *ifs-ws*, respectively.
2236 * The ->s and ->l of the string will be adjusted, but no NUL termination will
2237 * be applied to a possibly adjusted buffer!
2238 * If dofaults is set, " \t\n" is always trimmed (in addition) */
2239 FL
struct str
*n_str_trim(struct str
*self
, enum n_str_trim_flags stf
);
2240 FL
struct str
*n_str_trim_ifs(struct str
*self
, bool_t dodefaults
);
2243 * May have NULL buffer, may contain embedded NULs */
2245 /* Lifetime. n_string_gut() is optional for _creat_auto() strings */
2246 #define n_string_creat(S) \
2247 ((S)->s_dat = NULL, (S)->s_len = (S)->s_auto = (S)->s_size = 0, (S))
2248 #define n_string_creat_auto(S) \
2249 ((S)->s_dat = NULL, (S)->s_len = (S)->s_size = 0, (S)->s_auto = TRU1, (S))
2250 #define n_string_gut(S) \
2251 ((S)->s_dat != NULL ? (void)n_string_clear(S) : (void)0)
2253 /* Truncate to size, which must be LE current length */
2254 #define n_string_trunc(S,L) \
2255 (assert(UICMP(z, L, <=, (S)->s_len)), (S)->s_len = (ui32_t)(L), (S))
2257 /* Take/Release buffer ownership */
2258 #define n_string_take_ownership(SP,B,S,L) \
2259 (assert((SP)->s_dat == NULL), assert((S) == 0 || (B) != NULL),\
2260 assert((L) < (S) || (L) == 0),\
2261 (SP)->s_dat = (B), (SP)->s_len = (L), (SP)->s_size = (S), (SP))
2262 #define n_string_drop_ownership(SP) \
2263 ((SP)->s_dat = NULL, (SP)->s_len = (SP)->s_size = 0, (SP))
2265 /* Release all memory */
2266 FL
struct n_string
*n_string_clear(struct n_string
*self n_MEMORY_DEBUG_ARGS
);
2268 #ifdef HAVE_MEMORY_DEBUG
2269 # define n_string_clear(S) \
2270 ((S)->s_size != 0 ? (n_string_clear)(S, __FILE__, __LINE__) : (S))
2272 # define n_string_clear(S) ((S)->s_size != 0 ? (n_string_clear)(S) : (S))
2275 /* Check whether a buffer of Len bytes can be inserted into S(elf) */
2276 #define n_string_get_can_book(L) ((uiz_t)SI32_MAX - n_ALIGN(1) > L)
2277 #define n_string_can_book(S,L) \
2278 (n_string_get_can_book(L) &&\
2279 (uiz_t)SI32_MAX - n_ALIGN(1) - (L) > (S)->s_len)
2281 /* Reserve room for noof additional bytes, but don't adjust length (yet) */
2282 FL
struct n_string
*n_string_reserve(struct n_string
*self
, size_t noof
2283 n_MEMORY_DEBUG_ARGS
);
2284 #define n_string_book n_string_reserve
2286 /* Resize to exactly nlen bytes; any new storage isn't initialized */
2287 FL
struct n_string
*n_string_resize(struct n_string
*self
, size_t nlen
2288 n_MEMORY_DEBUG_ARGS
);
2290 #ifdef HAVE_MEMORY_DEBUG
2291 # define n_string_reserve(S,N) (n_string_reserve)(S, N, __FILE__, __LINE__)
2292 # define n_string_resize(S,N) (n_string_resize)(S, N, __FILE__, __LINE__)
2296 FL
struct n_string
*n_string_push_buf(struct n_string
*self
, char const *buf
,
2297 size_t buflen n_MEMORY_DEBUG_ARGS
);
2298 #define n_string_push(S, T) n_string_push_buf(S, (T)->s_len, (T)->s_dat)
2299 #define n_string_push_cp(S,CP) n_string_push_buf(S, CP, UIZ_MAX)
2300 FL
struct n_string
*n_string_push_c(struct n_string
*self
, char c
2301 n_MEMORY_DEBUG_ARGS
);
2303 #define n_string_assign(S,T) ((S)->s_len = 0, n_string_push(S, T))
2304 #define n_string_assign_c(S,C) ((S)->s_len = 0, n_string_push_c(S, C))
2305 #define n_string_assign_cp(S,CP) ((S)->s_len = 0, n_string_push_cp(S, CP))
2306 #define n_string_assign_buf(S,B,BL) \
2307 ((S)->s_len = 0, n_string_push_buf(S, B, BL))
2309 #ifdef HAVE_MEMORY_DEBUG
2310 # define n_string_push_buf(S,B,BL) \
2311 n_string_push_buf(S, B, BL, __FILE__, __LINE__)
2312 # define n_string_push_c(S,C) n_string_push_c(S, C, __FILE__, __LINE__)
2316 FL
struct n_string
*n_string_unshift_buf(struct n_string
*self
, char const *buf
,
2317 size_t buflen n_MEMORY_DEBUG_ARGS
);
2318 #define n_string_unshift(S,T) \
2319 n_string_unshift_buf(S, (T)->s_len, (T)->s_dat)
2320 #define n_string_unshift_cp(S,CP) \
2321 n_string_unshift_buf(S, CP, UIZ_MAX)
2322 FL
struct n_string
*n_string_unshift_c(struct n_string
*self
, char c
2323 n_MEMORY_DEBUG_ARGS
);
2325 #ifdef HAVE_MEMORY_DEBUG
2326 # define n_string_unshift_buf(S,B,BL) \
2327 n_string_unshift_buf(S,B,BL, __FILE__, __LINE__)
2328 # define n_string_unshift_c(S,C) n_string_unshift_c(S, C, __FILE__, __LINE__)
2332 FL
struct n_string
*n_string_insert_buf(struct n_string
*self
, size_t idx
,
2333 char const *buf
, size_t buflen n_MEMORY_DEBUG_ARGS
);
2334 #define n_string_insert(S,I,T) \
2335 n_string_insert_buf(S, I, (T)->s_len, (T)->s_dat)
2336 #define n_string_insert_cp(S,I,CP) \
2337 n_string_insert_buf(S, I, CP, UIZ_MAX)
2338 FL
struct n_string
*n_string_insert_c(struct n_string
*self
, size_t idx
,
2339 char c n_MEMORY_DEBUG_ARGS
);
2341 #ifdef HAVE_MEMORY_DEBUG
2342 # define n_string_insert_buf(S,I,B,BL) \
2343 n_string_insert_buf(S, I, B, BL, __FILE__, __LINE__)
2344 # define n_string_insert_c(S,I,C) n_string_insert_c(S, I, C, __FILE__, __LINE__)
2348 FL
struct n_string
*n_string_cut(struct n_string
*self
, size_t idx
, size_t len
);
2350 /* Ensure self has a - NUL terminated - buffer, and return that.
2351 * The latter may return the pointer to an internal empty RODATA instead */
2352 FL
char * n_string_cp(struct n_string
*self n_MEMORY_DEBUG_ARGS
);
2353 FL
char const *n_string_cp_const(struct n_string
const *self
);
2355 #ifdef HAVE_MEMORY_DEBUG
2356 # define n_string_cp(S) n_string_cp(S, __FILE__, __LINE__)
2360 n_INLINE
struct n_string
*
2361 (n_string_creat
)(struct n_string
*self
){
2362 return n_string_creat(self
);
2364 # undef n_string_creat
2366 n_INLINE
struct n_string
*
2367 (n_string_creat_auto
)(struct n_string
*self
){
2368 return n_string_creat_auto(self
);
2370 # undef n_string_creat_auto
2373 (n_string_gut
)(struct n_string
*self
){
2376 # undef n_string_gut
2378 n_INLINE
struct n_string
*
2379 (n_string_trunc
)(struct n_string
*self
, size_t l
){
2380 return n_string_trunc(self
, l
);
2382 # undef n_string_trunc
2384 n_INLINE
struct n_string
*
2385 (n_string_drop_ownership
)(struct n_string
*self
){
2386 return n_string_drop_ownership(self
);
2388 # undef n_string_drop_ownership
2389 #endif /* HAVE_INLINE */
2391 /* UTF-8 / UTF-32 stuff */
2393 /* ..and update arguments to point after range; returns UI32_MAX on error, in
2394 * which case the arguments will have been stepped one byte */
2395 FL ui32_t
n_utf8_to_utf32(char const **bdat
, size_t *blen
);
2397 /* buf must be large enough also for NUL, it's new length will be returned */
2398 FL
size_t n_utf32_to_utf8(ui32_t c
, char *buf
);
2400 /* Our iconv(3) wrappers */
2402 /* Returns a newly n_autorec_alloc()ated thing if there were adjustments.
2403 * Return value is always smaller or of equal size.
2404 * NULL will be returned if cset is an invalid character set name */
2405 FL
char *n_iconv_normalize_name(char const *cset
);
2407 /* Is it ASCII indeed? */
2408 FL bool_t
n_iconv_name_is_ascii(char const *cset
);
2411 FL iconv_t
n_iconv_open(char const *tocode
, char const *fromcode
);
2412 /* If *cd* == *iconvd*, assigns -1 to the latter */
2413 FL
void n_iconv_close(iconv_t cd
);
2415 /* Reset encoding state */
2416 FL
void n_iconv_reset(iconv_t cd
);
2418 /* iconv(3), but return n_err_no or 0 upon success.
2419 * The err_no may be ERR_NOENT unless n_ICONV_IGN_NOREVERSE is set in icf.
2420 * iconv_str() auto-grows on ERR_2BIG errors; in and in_rest_or_null may be
2422 * Note: ERR_INVAL (incomplete sequence at end of input) is NOT handled, so the
2423 * replacement character must be added manually if that happens at EOF!
2424 * TODO These must be contexts. For now we duplicate n_err_no into
2425 * TODO n_iconv_err_no in order to be able to access it when stuff happens
2426 * TODO "in between"! */
2427 FL
int n_iconv_buf(iconv_t cd
, enum n_iconv_flags icf
,
2428 char const **inb
, size_t *inbleft
,
2429 char **outb
, size_t *outbleft
);
2430 FL
int n_iconv_str(iconv_t icp
, enum n_iconv_flags icf
,
2431 struct str
*out
, struct str
const *in
,
2432 struct str
*in_rest_or_null
);
2434 /* If tocode==NULL, uses *ttycharset*. If fromcode==NULL, uses UTF-8.
2435 * Returns a autorec_alloc()ed buffer or NULL */
2436 FL
char * n_iconv_onetime_cp(enum n_iconv_flags icf
,
2437 char const *tocode
, char const *fromcode
, char const *input
);
2442 * This is a little bit hairy since it provides some stuff even if HAVE_TERMCAP
2443 * is false due to encapsulation desire
2447 /* termcap(3) / xy lifetime handling -- only called if we're n_PSO_INTERACTIVE
2448 * but not doing something in n_PO_QUICKRUN_MASK */
2449 FL
void n_termcap_init(void);
2450 FL
void n_termcap_destroy(void);
2452 /* enter_ca_mode / enable keypad (both if possible).
2453 * TODO When complete is not set we won't enter_ca_mode, for example: we don't
2454 * TODO want a complete screen clearance after $PAGER returned after displaying
2455 * TODO a mail, because otherwise the screen would look differently for normal
2456 * TODO stdout display messages. Etc. */
2457 # ifdef HAVE_TERMCAP
2458 FL
void n_termcap_resume(bool_t complete
);
2459 FL
void n_termcap_suspend(bool_t complete
);
2461 # define n_TERMCAP_RESUME(CPL) do{ n_termcap_resume(CPL); }while(0)
2462 # define n_TERMCAP_SUSPEND(CPL) do{ n_termcap_suspend(CPL); }while(0)
2465 /* Command multiplexer, returns FAL0 on I/O error, TRU1 on success and TRUM1
2466 * for commands which are not available and have no built-in fallback.
2467 * For query options the return represents a true value and -1 error.
2468 * Will return FAL0 directly unless we've been initialized.
2469 * By convention unused argument slots are given as -1 */
2470 FL ssize_t
n_termcap_cmd(enum n_termcap_cmd cmd
, ssize_t a1
, ssize_t a2
);
2471 # define n_termcap_cmdx(CMD) n_termcap_cmd(CMD, -1, -1)
2473 /* Query multiplexer. If query is n__TERMCAP_QUERY_MAX1 then
2474 * tvp->tv_data.tvd_string must contain the name of the query to look up; this
2475 * is used to lookup just about *any* (string) capability.
2476 * Returns TRU1 on success and TRUM1 for queries for which a built-in default
2477 * is returned; FAL0 is returned on non-availability */
2478 FL bool_t
n_termcap_query(enum n_termcap_query query
,
2479 struct n_termcap_value
*tvp
);
2481 /* Get a n_termcap_query for name or -1 if it is not known, and -2 if
2482 * type wasn't _NONE and the type doesn't match. */
2483 # ifdef HAVE_KEY_BINDINGS
2484 FL si32_t
n_termcap_query_for_name(char const *name
,
2485 enum n_termcap_captype type
);
2486 FL
char const *n_termcap_name_of_query(enum n_termcap_query query
);
2488 #endif /* n_HAVE_TCAP */
2490 #ifndef n_TERMCAP_RESUME
2491 # define n_TERMCAP_RESUME(CPL) do{;}while(0)
2492 # define n_TERMCAP_SUSPEND(CPL) do{;}while(0);
2500 FL
int c_thread(void *vp
);
2503 FL
int c_unthread(void *vp
);
2506 FL
struct message
* next_in_thread(struct message
*mp
);
2507 FL
struct message
* prev_in_thread(struct message
*mp
);
2508 FL
struct message
* this_in_thread(struct message
*mp
, long n
);
2510 /* Sorted mode is internally just a variant of threaded mode with all m_parent
2511 * and m_child links being NULL */
2512 FL
int c_sort(void *vp
);
2515 FL
int c_collapse(void *v
);
2516 FL
int c_uncollapse(void *v
);
2519 FL
void uncollapse1(struct message
*mp
, int always
);
2527 FL
void n_tls_set_verify_level(struct url
const *urlp
);
2530 FL bool_t
n_tls_verify_decide(void);
2533 FL
enum okay
smime_split(FILE *ip
, FILE **hp
, FILE **bp
, long xcount
,
2537 FL
FILE * smime_sign_assemble(FILE *hp
, FILE *bp
, FILE *sp
,
2538 char const *message_digest
);
2541 FL
FILE * smime_encrypt_assemble(FILE *hp
, FILE *yp
);
2544 FL
struct message
* smime_decrypt_assemble(struct message
*m
, FILE *hp
,
2548 FL
int c_certsave(void *v
);
2551 FL bool_t
n_tls_rfc2595_hostname_match(char const *host
, char const *pattern
);
2554 FL
int c_tls(void *vp
);
2555 #endif /* HAVE_TLS */
2561 /* Return whether user says yes, on STDIN if interactive.
2562 * Uses noninteract_default, the return value for non-interactive use cases,
2563 * as a hint for n_boolify() and chooses the yes/no string to append to prompt
2564 * accordingly. If prompt is NULL "Continue" is used instead.
2565 * Handles+reraises SIGINT */
2566 FL bool_t
getapproval(char const *prompt
, bool_t noninteract_default
);
2569 /* Get a password the expected way, return termios_state.ts_linebuf on
2570 * success or NULL on error */
2571 FL
char *getuser(char const *query
);
2573 /* Get a password the expected way, return termios_state.ts_linebuf on
2574 * success or NULL on error. SIGINT is temporarily blocked, *not* reraised.
2575 * termios_state_reset() (def.h) must be called anyway */
2576 FL
char *getpassword(char const *query
);
2579 /* Create the prompt and return its visual width in columns, which may be 0
2580 * if evaluation is disabled etc. The data is placed in store.
2581 * xprompt is inspected only if prompt is enabled and no *prompt* evaluation
2583 FL ui32_t
n_tty_create_prompt(struct n_string
*store
, char const *xprompt
,
2584 enum n_go_input_flags gif
);
2586 /* Overall interactive terminal life cycle for command line editor library */
2588 FL
void n_tty_init(void);
2589 FL
void n_tty_destroy(bool_t xit_fastpath
);
2591 # define n_tty_init() do{;}while(0)
2592 # define n_tty_destroy(B) do{;}while(0)
2595 /* Read a line after printing prompt (if set and non-empty).
2596 * If n>0 assumes that *linebuf has n bytes of default content.
2597 * histok_or_null like for n_go_input().
2598 * Only the _CTX_ bits in lif are used */
2599 FL
int n_tty_readline(enum n_go_input_flags gif
, char const *prompt
,
2600 char **linebuf
, size_t *linesize
, size_t n
, bool_t
*histok_or_null
2601 n_MEMORY_DEBUG_ARGS
);
2602 #ifdef HAVE_MEMORY_DEBUG
2603 # define n_tty_readline(A,B,C,D,E,F) \
2604 (n_tty_readline)(A,B,C,D,E,F,__FILE__,__LINE__)
2607 /* Add a line (most likely as returned by n_tty_readline()) to the history.
2608 * Whether and how an entry is added for real depends on gif, e.g.,
2609 * n_GO_INPUT_HIST_GABBY / *history-gabby* relation.
2610 * Empty strings are never stored */
2611 FL
void n_tty_addhist(char const *s
, enum n_go_input_flags gif
);
2614 FL
int c_history(void *v
);
2617 /* `bind' and `unbind' */
2618 #ifdef HAVE_KEY_BINDINGS
2619 FL
int c_bind(void *v
);
2620 FL
int c_unbind(void *v
);
2627 /* Parse (onechar of) a given buffer, and generate infos along the way.
2628 * If _WOUT_CREATE is set in vif, .vic_woudat will be NUL terminated!
2629 * vicp must be zeroed before first use */
2630 FL bool_t
n_visual_info(struct n_visual_info_ctx
*vicp
,
2631 enum n_visual_info_flags vif
);
2633 /* Check (multibyte-safe) how many bytes of buf (which is blen byts) can be
2634 * safely placed in a buffer (field width) of maxlen bytes */
2635 FL
size_t field_detect_clip(size_t maxlen
, char const *buf
, size_t blen
);
2637 /* Place cp in a autorec_alloc()ed buffer, column-aligned.
2638 * For header display only */
2639 FL
char * colalign(char const *cp
, int col
, int fill
,
2640 int *cols_decr_used_or_null
);
2642 /* Convert a string to a displayable one;
2643 * prstr() returns the result savestr()d, prout() writes it */
2644 FL
void makeprint(struct str
const *in
, struct str
*out
);
2645 FL
size_t delctrl(char *cp
, size_t len
);
2646 FL
char * prstr(char const *s
);
2647 FL
int prout(char const *s
, size_t sz
, FILE *fp
);
2649 /* Check whether bidirectional info maybe needed for blen bytes of bdat */
2650 FL bool_t
bidi_info_needed(char const *bdat
, size_t blen
);
2652 /* Create bidirectional text encapsulation information; without HAVE_NATCH_CHAR
2653 * the strings are always empty */
2654 FL
void bidi_info_create(struct bidi_info
*bip
);
2660 /* URL en- and decoding according to (enough of) RFC 3986 (RFC 1738).
2661 * These return a newly autorec_alloc()ated result, or NULL on length excess */
2662 FL
char * urlxenc(char const *cp
, bool_t ispath n_MEMORY_DEBUG_ARGS
);
2663 FL
char * urlxdec(char const *cp n_MEMORY_DEBUG_ARGS
);
2664 #ifdef HAVE_MEMORY_DEBUG
2665 # define urlxenc(CP,P) urlxenc(CP, P, __FILE__, __LINE__)
2666 # define urlxdec(CP) urlxdec(CP, __FILE__, __LINE__)
2670 FL
int c_urlcodec(void *vp
);
2672 FL
int c_urlencode(void *v
); /* TODO obsolete*/
2673 FL
int c_urldecode(void *v
); /* TODO obsolete */
2675 /* Parse a RFC 6058 'mailto' URI to a single to: (TODO yes, for now hacky).
2676 * Return NULL or something that can be converted to a struct name */
2677 FL
char * url_mailto_to_address(char const *mailtop
);
2679 /* Return port for proto (and set irv_or_null), or NULL if unknown.
2680 * For file:// this returns an empty string */
2681 FL
char const *n_servbyname(char const *proto
, ui16_t
*irv_or_null
);
2684 /* Parse data, which must meet the criteria of the protocol cproto, and fill
2685 * in the URL structure urlp (URL rather according to RFC 3986) */
2686 FL bool_t
url_parse(struct url
*urlp
, enum cproto cproto
,
2689 /* Zero ccp and lookup credentials for communicating with urlp.
2690 * Return whether credentials are available and valid (for chosen auth) */
2691 FL bool_t
ccred_lookup(struct ccred
*ccp
, struct url
*urlp
);
2692 FL bool_t
ccred_lookup_old(struct ccred
*ccp
, enum cproto cproto
,
2694 #endif /* HAVE_SOCKETS */
2698 FL
int c_netrc(void *v
);
2701 /* MD5 (RFC 1321) related facilities */
2703 # ifdef HAVE_XTLS_MD5
2704 # define md5_ctx MD5_CTX
2705 # define md5_init MD5_Init
2706 # define md5_update MD5_Update
2707 # define md5_final MD5_Final
2709 /* The function definitions are instantiated in main.c */
2710 # include "rfc1321.h"
2713 /* Store the MD5 checksum as a hexadecimal string in *hex*, *not* terminated,
2714 * using lowercase ASCII letters as defined in RFC 2195 */
2715 # define MD5TOHEX_SIZE 32
2716 FL
char * md5tohex(char hex
[MD5TOHEX_SIZE
], void const *vp
);
2718 /* CRAM-MD5 encode the *user* / *pass* / *b64* combo; NULL on overflow error */
2719 FL
char * cram_md5_string(struct str
const *user
, struct str
const *pass
,
2722 /* RFC 2104: HMAC: Keyed-Hashing for Message Authentication.
2723 * unsigned char *text: pointer to data stream
2724 * int text_len : length of data stream
2725 * unsigned char *key : pointer to authentication key
2726 * int key_len : length of authentication key
2727 * caddr_t digest : caller digest to be filled in */
2728 FL
void hmac_md5(unsigned char *text
, int text_len
, unsigned char *key
,
2729 int key_len
, void *digest
);
2730 #endif /* HAVE_MD5 */
2737 /* Our wrapper for RAND_bytes(3) */
2738 # if HAVE_RANDOM == n_RANDOM_IMPL_TLS
2739 FL
void n_tls_rand_bytes(void *buf
, size_t blen
);
2742 /* Will fill in a non-NULL *urlp->url_cert_fprint with auto-reclaimed
2743 * buffer on success, otherwise urlp is constant */
2744 FL bool_t
n_tls_open(struct url
*urlp
, struct sock
*sp
);
2747 FL
void ssl_gen_err(char const *fmt
, ...);
2750 FL
int c_verify(void *vp
);
2753 FL
FILE * smime_sign(FILE *ip
, char const *addr
);
2756 FL
FILE * smime_encrypt(FILE *ip
, char const *certfile
, char const *to
);
2758 FL
struct message
* smime_decrypt(struct message
*m
, char const *to
,
2759 char const *cc
, bool_t is_a_verify_call
);
2762 FL
enum okay
smime_certsave(struct message
*m
, int n
, FILE *op
);
2764 #endif /* HAVE_XTLS */
2771 FL
void n_go_onintr_for_imap(void);
2773 /* The former returns the input again if no conversion is necessary */
2774 FL
char const *imap_path_encode(char const *path
, bool_t
*err_or_null
);
2775 FL
char *imap_path_decode(char const *path
, bool_t
*err_or_null
);
2777 FL
char const * imap_fileof(char const *xcp
);
2778 FL
enum okay
imap_noop(void);
2779 FL
enum okay
imap_select(struct mailbox
*mp
, off_t
*size
, int *count
,
2780 const char *mbx
, enum fedit_mode fm
);
2781 FL
int imap_setfile(char const *who
, const char *xserver
, enum fedit_mode fm
);
2782 FL
enum okay
imap_header(struct message
*m
);
2783 FL
enum okay
imap_body(struct message
*m
);
2784 FL
void imap_getheaders(int bot
, int top
);
2785 FL bool_t
imap_quit(bool_t hold_sigs_on
);
2786 FL
enum okay
imap_undelete(struct message
*m
, int n
);
2787 FL
enum okay
imap_unread(struct message
*m
, int n
);
2788 FL
int c_imapcodec(void *vp
);
2789 FL
int c_imap_imap(void *vp
);
2790 FL
int imap_newmail(int nmail
);
2791 FL
enum okay
imap_append(const char *xserver
, FILE *fp
, long offset
);
2792 FL
int imap_folders(const char *name
, int strip
);
2793 FL
enum okay
imap_copy(struct message
*m
, int n
, const char *name
);
2794 # ifdef HAVE_IMAP_SEARCH
2795 FL
enum okay
imap_search1(const char *spec
, int f
);
2797 FL
int imap_thisaccount(const char *cp
);
2798 FL
enum okay
imap_remove(const char *name
);
2799 FL
enum okay
imap_rename(const char *old
, const char *new);
2800 FL
enum okay
imap_dequeue(struct mailbox
*mp
, FILE *fp
);
2801 FL
int c_connect(void *vp
);
2802 FL
int c_disconnect(void *vp
);
2803 FL
int c_cache(void *vp
);
2804 FL
int disconnected(const char *file
);
2805 FL
void transflags(struct message
*omessage
, long omsgCount
,
2807 FL
time_t imap_read_date_time(const char *cp
);
2808 FL
const char * imap_make_date_time(time_t t
);
2810 /* Extract the protocol base and return a duplicate */
2811 FL
char * protbase(char const *cp n_MEMORY_DEBUG_ARGS
);
2812 # ifdef HAVE_MEMORY_DEBUG
2813 # define protbase(CP) protbase(CP, __FILE__, __LINE__)
2815 #endif /* HAVE_IMAP */
2822 FL
enum okay
getcache1(struct mailbox
*mp
, struct message
*m
,
2823 enum needspec need
, int setflags
);
2824 FL
enum okay
getcache(struct mailbox
*mp
, struct message
*m
,
2825 enum needspec need
);
2826 FL
void putcache(struct mailbox
*mp
, struct message
*m
);
2827 FL
void initcache(struct mailbox
*mp
);
2828 FL
void purgecache(struct mailbox
*mp
, struct message
*m
, long mc
);
2829 FL
void delcache(struct mailbox
*mp
, struct message
*m
);
2830 FL
enum okay
cache_setptr(enum fedit_mode fm
, int transparent
);
2831 FL
enum okay
cache_list(struct mailbox
*mp
, char const *base
, int strip
,
2833 FL
enum okay
cache_remove(char const *name
);
2834 FL
enum okay
cache_rename(char const *old
, char const *new);
2835 FL ui64_t
cached_uidvalidity(struct mailbox
*mp
);
2836 FL
FILE * cache_queue(struct mailbox
*mp
);
2837 FL
enum okay
cache_dequeue(struct mailbox
*mp
);
2838 #endif /* HAVE_IMAP */
2844 FL
int zwrite(void *cookie
, const char *wbp
, int num
);
2845 FL
int zfree(void *cookie
);
2846 FL
int zread(void *cookie
, char *rbp
, int num
);
2847 FL
void * zalloc(FILE *fp
);
2848 #endif /* HAVE_IMAP */
2850 #ifndef HAVE_AMALGAMATION