1 /*@ S-nail - a mail user agent derived from Berkeley Mail.
2 *@ Function prototypes and function-alike macros.
4 * Copyright (c) 2000-2004 Gunnar Ritter, Freiburg i. Br., Germany.
5 * Copyright (c) 2012 - 2017 Steffen (Daode) Nurpmeso <steffen@sdaoden.eu>.
8 * Copyright (c) 1980, 1993
9 * The Regents of the University of California. All rights reserved.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. Neither the name of the University nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 * TODO Convert optional utility+ functions to n_*(); ditto
38 * TODO else use generic module-specific prefixes: str_(), am[em]_, sm[em]_, ..
40 /* TODO s-it-mode: not really (docu, funnames, funargs, etc) */
43 #ifndef HAVE_AMALGAMATION
49 /* Memory allocation routines from memory.c offer some debug support */
50 #if (defined HAVE_DEBUG || defined HAVE_DEVEL) && !defined HAVE_NOMEMDBG
51 # define HAVE_MEMORY_DEBUG
52 # define n_MEMORY_DEBUG_ARGS , char const *mdbg_file, int mdbg_line
53 # define n_MEMORY_DEBUG_ARGSCALL , mdbg_file, mdbg_line
55 # define n_MEMORY_DEBUG_ARGS
56 # define n_MEMORY_DEBUG_ARGSCALL
60 * Macro-based generics
63 /* ASCII char classification */
64 #define n__ischarof(C, FLAGS) \
65 (asciichar(C) && (n_class_char[(ui8_t)(C)] & (FLAGS)) != 0)
67 #define n_uasciichar(U) ((size_t)(U) <= 0x7F)
68 #define asciichar(c) ((uc_i)(c) <= 0x7F)
69 #define alnumchar(c) n__ischarof(c, C_DIGIT | C_OCTAL | C_UPPER | C_LOWER)
70 #define alphachar(c) n__ischarof(c, C_UPPER | C_LOWER)
71 #define blankchar(c) n__ischarof(c, C_BLANK)
72 #define blankspacechar(c) n__ischarof(c, C_BLANK | C_SPACE)
73 #define cntrlchar(c) n__ischarof(c, C_CNTRL)
74 #define digitchar(c) n__ischarof(c, C_DIGIT | C_OCTAL)
75 #define lowerchar(c) n__ischarof(c, C_LOWER)
76 #define punctchar(c) n__ischarof(c, C_PUNCT)
77 #define spacechar(c) n__ischarof(c, C_BLANK | C_SPACE | C_WHITE)
78 #define upperchar(c) n__ischarof(c, C_UPPER)
79 #define whitechar(c) n__ischarof(c, C_BLANK | C_WHITE)
80 #define octalchar(c) n__ischarof(c, C_OCTAL)
81 #define hexchar(c) /* TODO extend bits, add C_HEX */\
82 (n__ischarof(c, C_DIGIT | C_OCTAL) || ((c) >= 'A' && (c) <= 'F') ||\
83 ((c) >= 'a' && (c) <= 'f'))
85 #define upperconv(c) \
86 (lowerchar(c) ? (char)((uc_i)(c) - 'a' + 'A') : (char)(c))
87 #define lowerconv(c) \
88 (upperchar(c) ? (char)((uc_i)(c) - 'A' + 'a') : (char)(c))
90 #define fieldnamechar(c) \
91 (asciichar(c) && (c) > 040 && (c) != 0177 && (c) != ':')
93 /* Could the string contain a regular expression? */
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);\
155 /* Macros: `define', `undefine', `call', `call_if' */
156 FL
int c_define(void *v
);
157 FL
int c_undefine(void *v
);
158 FL
int c_call(void *v
);
159 FL
int c_call_if(void *v
);
161 /* Accounts: `account', `unaccount' */
162 FL
int c_account(void *v
);
163 FL
int c_unaccount(void *v
);
165 /* `localopts', `shift', `return' */
166 FL
int c_localopts(void *v
);
167 FL
int c_shift(void *v
);
168 FL
int c_return(void *v
);
170 /* TODO Check whether a *folder-hook* exists for the currently active mailbox */
171 FL bool_t
temporary_folder_hook_check(bool_t nmail
);
172 FL
void temporary_folder_hook_unroll(void); /* XXX im. hack */
174 /* TODO v15 drop Invoke compose hook macname */
175 FL
void temporary_compose_mode_hook_call(char const *macname
,
176 void (*hook_pre
)(void *), void *hook_arg
);
177 FL
void temporary_compose_mode_hook_unroll(void);
179 /* Can name freely be used as a variable by users? */
180 FL bool_t
n_var_is_user_writable(char const *name
);
182 /* Don't use n_var_* unless you *really* have to! */
184 /* Constant option key look/(un)set/clear */
185 FL
char *n_var_oklook(enum okeys okey
);
186 #define ok_blook(C) (n_var_oklook(n_CONCAT(ok_b_, C)) != NULL)
187 #define ok_vlook(C) n_var_oklook(n_CONCAT(ok_v_, C))
189 FL bool_t
n_var_okset(enum okeys okey
, uintptr_t val
);
191 n_var_okset(n_CONCAT(ok_b_, C), (uintptr_t)TRU1)
192 #define ok_vset(C,V) \
193 n_var_okset(n_CONCAT(ok_v_, C), (uintptr_t)(V))
195 FL bool_t
n_var_okclear(enum okeys okey
);
196 #define ok_bclear(C) n_var_okclear(n_CONCAT(ok_b_, C))
197 #define ok_vclear(C) n_var_okclear(n_CONCAT(ok_v_, C))
199 /* Variable option key lookup/(un)set/clear.
200 * If try_getenv is true we'll getenv(3) _if_ vokey is not a known enum okey.
201 * _vexplode() is to be used by the shell expansion stuff when encountering
202 * ${@} in double-quotes, in order to provide sh(1)ell compatible behaviour;
203 * it returns whether there are any elements in argv (*cookie) */
204 FL
char const *n_var_vlook(char const *vokey
, bool_t try_getenv
);
205 FL bool_t
n_var_vexplode(void const **cookie
);
206 FL bool_t
n_var_vset(char const *vokey
, uintptr_t val
);
207 FL bool_t
n_var_vclear(char const *vokey
);
209 /* Special case to handle the typical [xy-USER@HOST,] xy-HOST and plain xy
210 * variable chains; oxm is a bitmix which tells which combinations to test */
212 FL
char *n_var_xoklook(enum okeys okey
, struct url
const *urlp
,
213 enum okey_xlook_mode oxm
);
214 # define xok_BLOOK(C,URL,M) (n_var_xoklook(C, URL, M) != NULL)
215 # define xok_VLOOK(C,URL,M) n_var_xoklook(C, URL, M)
216 # define xok_blook(C,URL,M) xok_BLOOK(n_CONCAT(ok_b_, C), URL, M)
217 # define xok_vlook(C,URL,M) xok_VLOOK(n_CONCAT(ok_v_, C), URL, M)
220 /* User variable access: `set' and `unset' */
221 FL
int c_set(void *v
);
222 FL
int c_unset(void *v
);
225 FL
int c_varshow(void *v
);
227 /* Ditto: `varedit' */
228 FL
int c_varedit(void *v
);
231 FL
int c_environ(void *v
);
234 FL
int c_vexpr(void *v
);
237 FL
int c_vpospar(void *v
);
241 * xxx Interface quite sick
244 /* Try to add an attachment for file, fexpand(_LOCAL|_NOPROTO)ed.
245 * Return the new aplist aphead.
246 * The newly created attachment may be stored in *newap, or NULL on error */
247 FL
struct attachment
*n_attachment_append(struct attachment
*aplist
,
248 char const *file
, enum n_attach_error
*aerr_or_null
,
249 struct attachment
**newap_or_null
);
251 /* Shell-token parse names, and append resulting file names to aplist, return
252 * (new) aplist head */
253 FL
struct attachment
*n_attachment_append_list(struct attachment
*aplist
,
256 /* Remove ap from aplist, and return the new aplist head */
257 FL
struct attachment
*n_attachment_remove(struct attachment
*aplist
,
258 struct attachment
*ap
);
260 /* Find by file-name. If any path component exists in name then an exact match
261 * of the creation-path is used directly; if instead the basename of that path
262 * matches all attachments are traversed to find an exact match first, the
263 * first of all basename matches is returned as a last resort;
264 * If no path component exists the filename= parameter is searched (and also
265 * returned) in preference over the basename, otherwise likewise.
266 * If name is in fact a message number the first match is taken.
267 * If stat_or_null is given: FAL0 on NULL return, TRU1 for exact/single match,
268 * TRUM1 for ambiguous matches */
269 FL
struct attachment
*n_attachment_find(struct attachment
*aplist
,
270 char const *name
, bool_t
*stat_or_null
);
272 /* Interactively edit the attachment list, return updated list */
273 FL
struct attachment
*n_attachment_list_edit(struct attachment
*aplist
,
274 enum n_go_input_flags gif
);
276 /* Print all attachments to fp, return number of lines written, -1 on error */
277 FL ssize_t
n_attachment_list_print(struct attachment
const *aplist
, FILE *fp
);
283 /* Compute screen size */
284 FL
size_t n_screensize(void);
286 /* Get our $PAGER; if env_addon is not NULL it is checked whether we know about
287 * some environment variable that supports colour+ and set *env_addon to that,
288 * e.g., "LESS=FRSXi" */
289 FL
char const *n_pager_get(char const **env_addon
);
291 /* Use a pager or STDOUT to print *fp*; if *lines* is 0, they'll be counted */
292 FL
void page_or_print(FILE *fp
, size_t lines
);
294 /* Parse name and guess at the required protocol.
295 * If check_stat is true then stat(2) will be consulted - a TODO c..p hack
296 * TODO that together with *newfolders*=maildir adds Maildir support; sigh!
297 * If try_hooks is set check_stat is implied and if the stat(2) fails all
298 * file-hook will be tried in order to find a supported version of name.
299 * If adjusted_or_null is not NULL it will be set to the final version of name
300 * this function knew about: a %: FEDIT_SYSBOX prefix is forgotten, in case
301 * a hook is needed the "real" filename will be placed.
302 * TODO This c..p should be URL::from_string()->protocol() or something! */
303 FL
enum protocol
which_protocol(char const *name
, bool_t check_stat
,
304 bool_t try_hooks
, char const **adjusted_or_null
);
306 /* Hexadecimal itoa (NUL terminates) / atoi (-1 on error) */
307 FL
char * n_c_to_hex_base16(char store
[3], char c
);
308 FL si32_t
n_c_from_hex_base16(char const hex
[2]);
310 /* Decode clen (or strlen() if UIZ_MAX) bytes of cbuf into an integer
311 * according to idm, store a/the result in *resp (in _EINVAL case an overflow
312 * constant is assigned, for signed types it depends on parse state w. MIN/MAX),
313 * which must point to storage of the correct type, and return the result state.
314 * If endptr_or_null is set it will be set to the byte where parsing stopped */
315 FL
enum n_idec_state
n_idec_buf(void *resp
, char const *cbuf
, uiz_t clen
,
316 ui8_t base
, enum n_idec_mode idm
,
317 char const **endptr_or_null
);
318 #define n_idec_cp(RP,CBP,B,M,CLP) n_idec_buf(RP, CBP, UIZ_MAX, B, M, CLP)
320 #define n_idec_ui8_cp(RP,CBP,B,CLP) \
321 n_idec_buf(RP, CBP, UIZ_MAX, B, (n_IDEC_MODE_LIMIT_8BIT), CLP)
322 #define n_idec_si8_cp(RP,CBP,B,CLP) \
323 n_idec_buf(RP, CBP, UIZ_MAX, B,\
324 (n_IDEC_MODE_SIGNED_TYPE | n_IDEC_MODE_LIMIT_8BIT), CLP)
325 #define n_idec_ui16_cp(RP,CBP,B,CLP) \
326 n_idec_buf(RP, CBP, UIZ_MAX, B, (n_IDEC_MODE_LIMIT_16BIT), CLP)
327 #define n_idec_si16_cp(RP,CBP,B,CLP) \
328 n_idec_buf(RP, CBP, UIZ_MAX, B,\
329 (n_IDEC_MODE_SIGNED_TYPE | n_IDEC_MODE_LIMIT_16BIT), CLP)
330 #define n_idec_ui32_cp(RP,CBP,B,CLP) \
331 n_idec_buf(RP, CBP, UIZ_MAX, B, (n_IDEC_MODE_LIMIT_32BIT), CLP)
332 #define n_idec_si32_cp(RP,CBP,B,CLP) \
333 n_idec_buf(RP, CBP, UIZ_MAX, B,\
334 (n_IDEC_MODE_SIGNED_TYPE | n_IDEC_MODE_LIMIT_32BIT), CLP)
335 #define n_idec_ui64_cp(RP,CBP,B,CLP) \
336 n_idec_buf(RP, CBP, UIZ_MAX, B, 0, CLP)
337 #define n_idec_si64_cp(RP,CBP,B,CLP) \
338 n_idec_buf(RP, CBP, UIZ_MAX, B, (n_IDEC_MODE_SIGNED_TYPE), CLP)
339 #if UIZ_MAX == UI32_MAX
340 # define n_idec_uiz_cp(RP,CBP,B,CLP) \
341 n_idec_buf(RP, CBP, UIZ_MAX, B, (n_IDEC_MODE_LIMIT_32BIT), CLP)
342 # define n_idec_siz_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)
346 # define n_idec_uiz_cp(RP,CBP,B,CLP) \
347 n_idec_buf(RP, CBP, UIZ_MAX, B, 0, CLP)
348 # define n_idec_siz_cp(RP,CBP,B,CLP) \
349 n_idec_buf(RP, CBP, UIZ_MAX, B, (n_IDEC_MODE_SIGNED_TYPE), CLP)
352 /* Hash the passed string -- uses Chris Torek's hash algorithm.
353 * i*() hashes case-insensitively (ASCII), and *n() uses maximally len bytes;
354 * if len is UIZ_MAX, we go .), since we anyway stop for NUL */
355 FL ui32_t
n_torek_hash(char const *name
);
356 FL ui32_t
n_torek_ihashn(char const *dat
, size_t len
);
358 /* Find a prime greater than n */
359 FL ui32_t
n_prime_next(ui32_t n
);
361 /* Return the name of the dead.letter file */
362 FL
char const * n_getdeadletter(void);
364 /* Detect and query the hostname to use */
365 FL
char *n_nodename(bool_t mayoverride
);
367 /* Get a (pseudo) random string of *length* bytes; returns salloc()ed buffer.
368 * If n_PSO_REPRODUCIBLE and reprocnt_or_null not NULL then we produce
369 * a reproducable string by using and managing that counter instead */
370 FL
char *n_random_create_cp(size_t length
, ui32_t
*reprocnt_or_null
);
372 /* Check whether the argument string is a true (1) or false (0) boolean, or an
373 * invalid string, in which case -1 is returned; if emptyrv is not -1 then it,
374 * treated as a boolean, is used as the return value shall inbuf be empty.
375 * inlen may be UIZ_MAX to force strlen() detection */
376 FL si8_t
boolify(char const *inbuf
, uiz_t inlen
, si8_t emptyrv
);
378 /* Dig a "quadoption" in inbuf (possibly going through getapproval() in
379 * interactive mode). Returns a boolean or -1 if inbuf content is invalid;
380 * if emptyrv is not -1 then it, treated as a boolean, is used as the return
381 * value shall inbuf be empty. If prompt is set it is printed first if intera.
382 * inlen may be UIZ_MAX to force strlen() detection */
383 FL si8_t
quadify(char const *inbuf
, uiz_t inlen
, char const *prompt
,
386 /* Is the argument "all" (case-insensitive) or "*" */
387 FL bool_t
n_is_all_or_aster(char const *name
);
389 /* Get seconds since epoch, return pointer to static struct.
390 * Unless force_update is true we may use the event-loop tick time */
391 FL
struct n_timespec
const *n_time_now(bool_t force_update
);
392 #define n_time_epoch() ((time_t)n_time_now(FAL0)->ts_sec)
394 /* Update *tc* to now; only .tc_time updated unless *full_update* is true */
395 FL
void time_current_update(struct time_current
*tc
,
398 /* Returns 0 if fully slept, number of millis left if ignint is true and we
399 * were interrupted. Actual resolution may be second or less.
400 * Note in case of HAVE_SLEEP this may be SIGALARM based. */
401 FL uiz_t
n_msleep(uiz_t millis
, bool_t ignint
);
403 /* Our error print series.. Note: these reverse scan format in order to know
404 * whether a newline was included or not -- this affects the output! */
405 FL
void n_err(char const *format
, ...);
406 FL
void n_verr(char const *format
, va_list ap
);
408 /* ..(for use in a signal handler; to be obsoleted..).. */
409 FL
void n_err_sighdl(char const *format
, ...);
411 /* Our perror(3); if errval is 0 n_err_no is used; newline appended */
412 FL
void n_perr(char const *msg
, int errval
);
414 /* Announce a fatal error (and die); newline appended */
415 FL
void n_alert(char const *format
, ...);
416 FL
void n_panic(char const *format
, ...);
420 FL
int c_errors(void *vp
);
423 /* strerror(3), and enum n_err_number <-> error name conversions */
424 FL
char const *n_err_to_doc(si32_t eno
);
425 FL
char const *n_err_to_name(si32_t eno
);
426 FL si32_t
n_err_from_name(char const *name
);
430 FL
char const *n_regex_err_to_doc(const regex_t
*rep
, int e
);
437 /* if.elif.else.endif conditional execution.
438 * _isskip() tests whether current state doesn't allow execution of commands */
439 FL
int c_if(void *v
);
440 FL
int c_elif(void *v
);
441 FL
int c_else(void *v
);
442 FL
int c_endif(void *v
);
444 FL bool_t
n_cnd_if_isskip(void);
446 /* An execution context is teared down, and it finds to have an if stack */
447 FL
void n_cnd_if_stack_del(void *vp
);
453 /* `file' (`folder') and `File' (`Folder') */
454 FL
int c_file(void *v
);
455 FL
int c_File(void *v
);
457 /* 'newmail' command: Check for new mail without writing old mail back */
458 FL
int c_newmail(void *v
);
461 FL
int c_noop(void *v
);
464 FL
int c_remove(void *v
);
467 FL
int c_rename(void *v
);
469 /* List the folders the user currently has */
470 FL
int c_folders(void *v
);
476 /* `headers' (show header group, possibly after setting dot) */
477 FL
int c_headers(void *v
);
479 /* Like c_headers(), but pre-prepared message vector */
480 FL
int print_header_group(int *vector
);
482 /* Scroll to the next/previous screen */
483 FL
int c_scroll(void *v
);
484 FL
int c_Scroll(void *v
);
486 /* Move the dot up or down by one message */
487 FL
int c_dotmove(void *v
);
489 /* Print out the headlines for each message in the passed message list */
490 FL
int c_from(void *v
);
492 /* Print all message in between and including bottom and topx if they are
493 * visible and either only_marked is false or they are MMARKed */
494 FL
void print_headers(size_t bottom
, size_t topx
, bool_t only_marked
);
500 /* Paginate messages, honour/don't honour ignored fields, respectively */
501 FL
int c_more(void *v
);
502 FL
int c_More(void *v
);
504 /* Type out messages, honour/don't honour ignored fields, respectively */
505 FL
int c_type(void *v
);
506 FL
int c_Type(void *v
);
508 /* Show raw message content */
509 FL
int c_show(void *v
);
511 /* Pipe messages, honour/don't honour ignored fields, respectively */
512 FL
int c_pipe(void *v
);
513 FL
int c_Pipe(void *v
);
515 /* Print the first *toplines* of each desired message */
516 FL
int c_top(void *v
);
517 FL
int c_Top(void *v
);
519 /* If any arguments were given, go to the next applicable argument following
520 * dot, otherwise, go to the next applicable message. If given as first
521 * command with no arguments, print first message */
522 FL
int c_next(void *v
);
524 /* Print out the value of dot */
525 FL
int c_pdot(void *v
);
527 /* Print the size of each message */
528 FL
int c_messize(void *v
);
530 /* Delete messages */
531 FL
int c_delete(void *v
);
533 /* Delete messages, then type the new dot */
534 FL
int c_deltype(void *v
);
536 /* Undelete the indicated messages */
537 FL
int c_undelete(void *v
);
539 /* Touch all the given messages so that they will get mboxed */
540 FL
int c_stouch(void *v
);
542 /* Make sure all passed messages get mboxed */
543 FL
int c_mboxit(void *v
);
545 /* Preserve messages, so that they will be sent back to the system mailbox */
546 FL
int c_preserve(void *v
);
548 /* Mark all given messages as unread */
549 FL
int c_unread(void *v
);
551 /* Mark all given messages as read */
552 FL
int c_seen(void *v
);
554 /* Message flag manipulation */
555 FL
int c_flag(void *v
);
556 FL
int c_unflag(void *v
);
557 FL
int c_answered(void *v
);
558 FL
int c_unanswered(void *v
);
559 FL
int c_draft(void *v
);
560 FL
int c_undraft(void *v
);
567 FL
int c_sleep(void *v
);
569 /* `!': process a shell escape by saving signals, ignoring signals and sh -c */
570 FL
int c_shell(void *v
);
572 /* `shell': fork an interactive shell */
573 FL
int c_dosh(void *v
);
575 /* `cwd': print user's working directory */
576 FL
int c_cwd(void *v
);
578 /* `chdir': change user's working directory */
579 FL
int c_chdir(void *v
);
581 /* `echo' series: expand file names like echo (to stdout/stderr, with/out
582 * trailing newline) */
583 FL
int c_echo(void *v
);
584 FL
int c_echoerr(void *v
);
585 FL
int c_echon(void *v
);
586 FL
int c_echoerrn(void *v
);
589 FL
int c_read(void *vp
);
592 FL
int c_version(void *vp
);
598 /* All thinkable sorts of `reply' / `respond' and `followup'.. */
599 FL
int c_reply(void *v
);
600 FL
int c_replyall(void *v
);
601 FL
int c_replysender(void *v
);
602 FL
int c_Reply(void *v
);
603 FL
int c_followup(void *v
);
604 FL
int c_followupall(void *v
);
605 FL
int c_followupsender(void *v
);
606 FL
int c_Followup(void *v
);
608 /* ..and a mailing-list reply */
609 FL
int c_Lreply(void *v
);
611 /* The 'forward' command */
612 FL
int c_forward(void *v
);
614 /* Similar to forward, saving the message in a file named after the first
616 FL
int c_Forward(void *v
);
618 /* Resend a message list to a third person */
619 FL
int c_resend(void *v
);
621 /* Resend a message list to a third person without adding headers */
622 FL
int c_Resend(void *v
);
626 * Actual command table, `help', `list', etc., and the n_cmd_arg() parser.
629 /* Isolate the command from the arguments, return pointer to end of cmd name */
630 FL
char const *n_cmd_isolate(char const *cmd
);
632 /* First command which fits for cmd, or NULL */
633 FL
struct n_cmd_desc
const *n_cmd_firstfit(char const *cmd
);
635 /* Get the default command for the empty line */
636 FL
struct n_cmd_desc
const *n_cmd_default(void);
638 /* Scan an entire command argument line, return whether result can be used,
639 * otherwise no resources are allocated (in ->cac_arg).
640 * For _WYSH arguments the flags _TRIM_SPACE (v15 _not_ _TRIM_IFSSPACE) and
641 * _LOG are implicit, _META_SEMICOLON is starting with the last (non-optional)
642 * argument, and then a trailing empty argument is ignored, too */
643 FL bool_t
n_cmd_arg_parse(struct n_cmd_arg_ctx
*cacp
);
645 /* Join all the _GREEDY arguments that were seen into a single string.
646 * Asserted they are string-based. The data (if any) is appended to store */
647 FL
struct n_string
*n_cmd_arg_join_greedy(struct n_cmd_arg_ctx
const *cacp
,
648 struct n_string
*store
);
650 /* Save away the data from autorec memory, and restore it to that.
651 * The heap storage is a single pointer to be n_free() by users */
652 FL
void *n_cmd_arg_save_to_heap(struct n_cmd_arg_ctx
const *cacp
);
653 FL
struct n_cmd_arg_ctx
*n_cmd_arg_restore_from_heap(void *vp
);
655 /* Scan out the list of string arguments according to rm, return -1 on error;
656 * res_dat is NULL terminated unless res_size is 0 or error occurred */
657 FL
int /* TODO v15*/ getrawlist(bool_t wysh
, char **res_dat
, size_t res_size
,
658 char const *line
, size_t linesize
);
664 /* Save a message in a file. Mark the message as saved so we can discard when
666 FL
int c_save(void *v
);
667 FL
int c_Save(void *v
);
669 /* Copy a message to a file without affected its saved-ness */
670 FL
int c_copy(void *v
);
671 FL
int c_Copy(void *v
);
673 /* Move a message to a file */
674 FL
int c_move(void *v
);
675 FL
int c_Move(void *v
);
677 /* Decrypt and copy a message to a file. Like plain `copy' at times */
678 FL
int c_decrypt(void *v
);
679 FL
int c_Decrypt(void *v
);
681 /* Write the indicated messages at the end of the passed file name, minus
682 * header and trailing blank line. This is the MIME save function */
683 FL
int c_write(void *v
);
690 * If quotefile is (char*)-1, stdin will be used, caller has to verify that
691 * we're not running in interactive mode */
692 FL
FILE * collect(struct header
*hp
, int printheaders
, struct message
*mp
,
693 char const *quotefile
, int doprefix
, si8_t
*checkaddr_err
);
701 FL
int c_colour(void *v
);
702 FL
int c_uncolour(void *v
);
704 /* An execution context is teared down, and it finds to have a colour stack.
705 * If NULL is passed, go for n_go_data->gdc_colour stuff */
706 FL
void n_colour_stack_del(void *vp
);
708 /* We want coloured output (in this salloc() cycle), pager_used is used to
709 * test whether *colour-pager* is to be inspected, if fp is given, the reset
710 * sequence will be written as necessary by _stack_del()
711 * env_gut() will reset() as necessary if fp is not NULL */
712 FL
void n_colour_env_create(enum n_colour_ctx cctx
, FILE *fp
,
714 FL
void n_colour_env_gut(void);
716 /* Putting anything (for pens: including NULL) resets current state first */
717 FL
void n_colour_put(enum n_colour_id cid
, char const *ctag
);
718 FL
void n_colour_reset(void);
720 /* Of course temporary only and may return NULL. Doesn't affect state! */
721 FL
struct str
const *n_colour_reset_to_str(void);
723 /* A pen is bound to its environment and automatically reclaimed; it may be
724 * NULL but that can be used anyway for simplicity.
725 * This includes pen_to_str() -- which doesn't affect state! */
726 FL
struct n_colour_pen
*n_colour_pen_create(enum n_colour_id cid
,
728 FL
void n_colour_pen_put(struct n_colour_pen
*self
);
730 FL
struct str
const *n_colour_pen_to_str(struct n_colour_pen
*self
);
731 #endif /* HAVE_COLOUR */
737 /* Aquire a flt lock and create a dotlock file; upon success a registered
738 * control-pipe FILE* is returned that keeps the link in between us and the
739 * lock-holding fork(2)ed subprocess (which conditionally replaced itself via
740 * execv(2) with the privilege-separated dotlock helper program): the lock file
741 * will be removed once the control pipe is closed via Pclose().
742 * Will try FILE_LOCK_TRIES times if pollmsecs > 0 (once otherwise).
743 * If pollmsecs is UIZ_MAX, FILE_LOCK_MILLIS is used.
744 * If *dotlock_ignore_error* is set (FILE*)-1 will be returned if at least the
745 * normal file lock could be established, otherwise n_err_no is usable on err */
746 FL
FILE * n_dotlock(char const *fname
, int fd
, enum n_file_lock_type flt
,
747 off_t off
, off_t len
, size_t pollmsecs
);
753 /* Edit a message list */
754 FL
int c_editor(void *v
);
756 /* Invoke the visual editor on a message list */
757 FL
int c_visual(void *v
);
759 /* Run an editor on either size bytes of the file fp (or until EOF if size is
760 * negative) or on the message mp, and return a new file or NULL on error of if
761 * the user didn't perform any edits.
762 * For now we assert that mp==NULL if hp!=NULL, treating this as a special call
763 * from within compose mode, and giving TRUM1 to puthead().
764 * Signals must be handled by the caller. viored is 'e' for ed, 'v' for vi */
765 FL
FILE * run_editor(FILE *fp
, off_t size
, int viored
, int readonly
,
766 struct header
*hp
, struct message
*mp
,
767 enum sendaction action
, sighandler_type oldint
);
774 FL
struct quoteflt
* quoteflt_dummy(void); /* TODO LEGACY */
775 FL
void quoteflt_init(struct quoteflt
*self
, char const *prefix
);
776 FL
void quoteflt_destroy(struct quoteflt
*self
);
777 FL
void quoteflt_reset(struct quoteflt
*self
, FILE *f
);
778 FL ssize_t
quoteflt_push(struct quoteflt
*self
, char const *dat
,
780 FL ssize_t
quoteflt_flush(struct quoteflt
*self
);
782 /* (Primitive) HTML tagsoup filter */
783 #ifdef HAVE_FILTER_HTML_TAGSOUP
784 /* TODO Because we don't support filter chains yet this filter will be run
785 * TODO in a dedicated subprocess, driven via a special Popen() mode */
786 FL
int htmlflt_process_main(void);
788 FL
void htmlflt_init(struct htmlflt
*self
);
789 FL
void htmlflt_destroy(struct htmlflt
*self
);
790 FL
void htmlflt_reset(struct htmlflt
*self
, FILE *f
);
791 FL ssize_t
htmlflt_push(struct htmlflt
*self
, char const *dat
, size_t len
);
792 FL ssize_t
htmlflt_flush(struct htmlflt
*self
);
799 /* fgets() replacement to handle lines of arbitrary size and with embedded \0
801 * line - line buffer. *line may be NULL.
802 * linesize - allocated size of line buffer.
803 * count - maximum characters to read. May be NULL.
804 * llen - length_of_line(*line).
806 * appendnl - always terminate line with \n, append if necessary.
807 * Manages the n_PS_READLINE_NL hack */
808 FL
char * fgetline(char **line
, size_t *linesize
, size_t *count
,
809 size_t *llen
, FILE *fp
, int appendnl n_MEMORY_DEBUG_ARGS
);
810 #ifdef HAVE_MEMORY_DEBUG
811 # define fgetline(A,B,C,D,E,F) \
812 fgetline(A, B, C, D, E, F, __FILE__, __LINE__)
815 /* Read up a line from the specified input into the linebuffer.
816 * Return the number of characters read. Do not include the newline at EOL.
817 * n is the number of characters already read and present in *linebuf; it'll be
818 * treated as _the_ line if no more (successful) reads are possible.
819 * Manages the n_PS_READLINE_NL hack */
820 FL
int readline_restart(FILE *ibuf
, char **linebuf
, size_t *linesize
,
821 size_t n n_MEMORY_DEBUG_ARGS
);
822 #ifdef HAVE_MEMORY_DEBUG
823 # define readline_restart(A,B,C,D) \
824 readline_restart(A, B, C, D, __FILE__, __LINE__)
827 /* Set up the input pointers while copying the mail file into /tmp */
828 FL
void setptr(FILE *ibuf
, off_t offset
);
830 /* Determine the size of the file possessed by the passed buffer */
831 FL off_t
fsize(FILE *iob
);
833 /* Will retry FILE_LOCK_RETRIES times if pollmsecs > 0.
834 * If pollmsecs is UIZ_MAX, FILE_LOCK_MILLIS is used */
835 FL bool_t
n_file_lock(int fd
, enum n_file_lock_type flt
,
836 off_t off
, off_t len
, size_t pollmsecs
);
842 /* Set up editing on the given file name.
843 * If the first character of name is %, we are considered to be editing the
844 * file, otherwise we are reading our mail which has signficance for mbox and
846 FL
int setfile(char const *name
, enum fedit_mode fm
);
848 FL
int newmailinfo(int omsgCount
);
850 /* Set the size of the message vector used to construct argument lists to
851 * message list functions */
852 FL
void setmsize(int sz
);
854 /* Logic behind -H / -L invocations */
855 FL
void print_header_summary(char const *Larg
);
857 /* Announces the current folder as indicated.
858 * Is responsible for updating "dot" (after a folder change). */
859 FL
void n_folder_announce(enum n_announce_flags af
);
861 FL
int getmdot(int nmail
);
863 FL
void initbox(char const *name
);
865 /* Determine and expand the current *folder* name, return it (with trailing
866 * solidus) or the empty string also in case of errors: since POSIX mandates
867 * a default of CWD if not set etc., that seems to be a valid fallback, then */
868 FL
char const *n_folder_query(void);
870 /* Prepare the seekable O_APPEND MBOX fout for appending of another message.
871 * If st_or_null is not NULL it is assumed to point to an up-to-date status of
872 * fout, otherwise an internal fstat(2) is performed as necessary.
873 * Returns n_err_no of error */
874 FL
int n_folder_mbox_prepare_append(FILE *fout
, struct stat
*st_or_null
);
878 * Program input of all sorts, input lexing, event loops, command evaluation.
879 * Also alias handling.
882 /* Setup the run environment; this i *only* for main() */
883 FL
void n_go_init(void);
885 /* Interpret user commands. If stdin is not a tty, print no prompt; return
886 * whether last processed command returned error; this is *only* for main()! */
887 FL bool_t
n_go_main_loop(void);
889 /* Actual cmd input */
892 FL
void n_go_input_clearerr(void);
894 /* Force n_go_input() to read EOF next */
895 FL
void n_go_input_force_eof(void);
897 /* Returns true if force_eof() has been set -- it is set automatically if
898 * an input context enters EOF state (rather than error, as in ferror(3)) */
899 FL bool_t
n_go_input_is_eof(void);
901 /* Force n_go_input() to read that buffer next -- for `history', and the MLE.
902 * If commit is not true then we'll reenter the line editor with buf as default
903 * line content. Only to be used in interactive and non-robot mode! */
904 FL
void n_go_input_inject(enum n_go_input_inject_flags giif
, char const *buf
,
907 /* Read a complete line of input, with editing if interactive and possible.
908 * If string is set it is used as the initial line content if in interactive
909 * mode, otherwise this argument is ignored for reproducibility.
910 * If histok_or_null is set it will be updated to FAL0 if input shall not be
912 * Return number of octets or a value <0 on error.
913 * Note: may use the currently `source'd file stream instead of stdin!
914 * Manages the n_PS_READLINE_NL hack
915 * TODO We need an OnReadLineCompletedEvent and drop this function */
916 FL
int n_go_input(enum n_go_input_flags gif
, char const *prompt
,
917 char **linebuf
, size_t *linesize
, char const *string
,
918 bool_t
*histok_or_null n_MEMORY_DEBUG_ARGS
);
919 #ifdef HAVE_MEMORY_DEBUG
920 # define n_go_input(A,B,C,D,E,F) n_go_input(A,B,C,D,E,F,__FILE__,__LINE__)
923 /* Read a line of input, with editing if interactive and possible, return it
924 * savestr()d or NULL in case of errors or if an empty line would be returned.
925 * This may only be called from toplevel (not during n_PS_ROBOT).
926 * If string is set it is used as the initial line content if in interactive
927 * mode, otherwise this argument is ignored for reproducibility */
928 FL
char *n_go_input_cp(enum n_go_input_flags gif
, char const *prompt
,
931 /* Deal with loading of resource files and dealing with a stack of files for
932 * the source command */
934 /* Load a file of user system startup resources.
935 * *Only* for main(), returns whether program shall continue */
936 FL bool_t
n_go_load(char const *name
);
938 /* "Load" all the -X command line definitions in order.
939 * *Only* for main(), returns whether program shall continue */
940 FL bool_t
n_go_Xargs(char const **lines
, size_t cnt
);
942 /* Pushdown current input file and switch to a new one. Set the global flag
943 * n_PS_SOURCING so that others will realize that they are no longer reading
944 * from a tty (in all probability) */
945 FL
int c_source(void *v
);
946 FL
int c_source_if(void *v
);
948 /* Evaluate a complete macro / a single command. For the former lines will
949 * always be free()d, for the latter cmd will always be duplicated internally */
950 FL bool_t
n_go_macro(enum n_go_input_flags gif
, char const *name
, char **lines
,
951 void (*on_finalize
)(void*), void *finalize_arg
);
952 FL bool_t
n_go_command(enum n_go_input_flags gif
, char const *cmd
);
954 /* XXX See a_GO_SPLICE in source */
955 FL
void n_go_splice_hack(char const *cmd
, FILE *new_stdin
, FILE *new_stdout
,
956 ui32_t new_psonce
, void (*on_finalize
)(void*), void *finalize_arg
);
957 FL
void n_go_splice_hack_remove_after_jump(void);
959 /* XXX Hack: may we release our (interactive) (terminal) control to a different
960 * XXX program, e.g., a $PAGER? */
961 FL bool_t
n_go_may_yield_control(void);
964 FL
int c_eval(void *vp
);
967 FL
int c_xcall(void *vp
);
969 /* `exit' and `quit' commands */
970 FL
int c_exit(void *vp
);
971 FL
int c_quit(void *vp
);
977 /* Return the user's From: address(es) */
978 FL
char const * myaddrs(struct header
*hp
);
980 /* Boil the user's From: addresses down to a single one, or use *sender* */
981 FL
char const * myorigin(struct header
*hp
);
983 /* See if the passed line buffer, which may include trailing newline (sequence)
984 * is a mail From_ header line according to POSIX ("From ").
985 * If check_rfc4155 is true we'll return TRUM1 instead if the From_ line
986 * matches POSIX but is _not_ compatible to RFC 4155 */
987 FL bool_t
is_head(char const *linebuf
, size_t linelen
,
988 bool_t check_rfc4155
);
990 /* Savage extract date field from From_ line. linelen is convenience as line
991 * must be terminated (but it may end in a newline [sequence]).
992 * Return whether the From_ line was parsed successfully (-1 if the From_ line
993 * wasn't really RFC 4155 compliant) */
994 FL
int extract_date_from_from_(char const *line
, size_t linelen
,
995 char datebuf
[n_FROM_DATEBUF
]);
997 /* Extract some header fields (see e.g. -t documentation) from a message.
998 * If n_poption&n_PO_t_FLAG *and* n_psonce&n_PSO_t_FLAG are both set a number
999 * of additional header fields are understood and address joining is performed
1000 * as necessary, and the subject is treated with additional care, too.
1001 * If n_psonce&n_PSO_t_FLAG is set but n_PO_t_FLAG is no more, From: will not
1002 * be assigned no more.
1003 * This calls expandaddr() on some headers and sets checkaddr_err if that is
1004 * not NULL -- note it explicitly allows EAF_NAME because aliases are not
1005 * expanded when this is called! */
1006 FL
void extract_header(FILE *fp
, struct header
*hp
,
1007 si8_t
*checkaddr_err
);
1009 /* Return the desired header line from the passed message
1010 * pointer (or NULL if the desired header field is not available).
1011 * If mult is zero, return the content of the first matching header
1012 * field only, the content of all matching header fields else */
1013 FL
char * hfield_mult(char const *field
, struct message
*mp
, int mult
);
1014 #define hfieldX(a, b) hfield_mult(a, b, 1)
1015 #define hfield1(a, b) hfield_mult(a, b, 0)
1017 /* Check whether the passed line is a header line of the desired breed.
1018 * Return the field body, or 0 */
1019 FL
char const * thisfield(char const *linebuf
, char const *field
);
1021 /* Get sender's name from this message. If the message has a bunch of arpanet
1022 * stuff in it, we may have to skin the name before returning it */
1023 FL
char * nameof(struct message
*mp
, int reptype
);
1025 /* Start of a "comment". Ignore it */
1026 FL
char const * skip_comment(char const *cp
);
1028 /* Return the start of a route-addr (address in angle brackets), if present */
1029 FL
char const * routeaddr(char const *name
);
1031 /* Query *expandaddr*, parse it and return flags.
1032 * The flags are already adjusted for n_PSO_INTERACTIVE, n_PO_TILDE_FLAG etc. */
1033 FL
enum expand_addr_flags
expandaddr_to_eaf(void);
1035 /* Check if an address is invalid, either because it is malformed or, if not,
1036 * according to eacm. Return FAL0 when it looks good, TRU1 if it is invalid
1037 * but the error condition wasn't covered by a 'hard "fail"ure', -1 otherwise */
1038 FL si8_t
is_addr_invalid(struct name
*np
,
1039 enum expand_addr_check_mode eacm
);
1041 /* Does *NP* point to a file or pipe addressee? */
1042 #define is_fileorpipe_addr(NP) \
1043 (((NP)->n_flags & NAME_ADDRSPEC_ISFILEORPIPE) != 0)
1045 /* Return skinned version of *NP*s name */
1046 #define skinned_name(NP) \
1047 (assert((NP)->n_flags & NAME_SKINNED), \
1048 ((struct name const*)NP)->n_name)
1050 /* Skin an address according to the RFC 822 interpretation of "host-phrase" */
1051 FL
char * skin(char const *name
);
1053 /* Skin *name* and extract the *addr-spec* according to RFC 5322.
1054 * Store the result in .ag_skinned and also fill in those .ag_ fields that have
1055 * actually been seen.
1056 * Return NULL on error, or name again, but which may have been replaced by
1057 * a version with fixed quotation etc.!
1058 * issingle_hack is a HACK that allows usage for `addrcodec' */
1059 FL
char const *n_addrspec_with_guts(struct n_addrguts
*agp
, char const *name
,
1060 bool_t doskin
, bool_t issingle_hack
);
1062 /* Fetch the real name from an internet mail address field */
1063 FL
char * realname(char const *name
);
1065 /* Fetch the sender's name from the passed message. reptype can be
1066 * 0 -- get sender's name for display purposes
1067 * 1 -- get sender's name for reply
1068 * 2 -- get sender's name for Reply */
1069 FL
char * name1(struct message
*mp
, int reptype
);
1071 /* Trim away all leading Re: etc., return pointer to plain subject.
1072 * Note it doesn't perform any MIME decoding by itself */
1073 FL
char const *subject_re_trim(char const *cp
);
1075 FL
int msgidcmp(char const *s1
, char const *s2
);
1077 /* Fake Sender for From_ lines if missing, e. g. with POP3 */
1078 FL
char const * fakefrom(struct message
*mp
);
1080 FL
char const * fakedate(time_t t
);
1082 /* From username Fri Jan 2 20:13:51 2004
1085 #ifdef HAVE_IMAP_SEARCH
1086 FL
time_t unixtime(char const *from
);
1089 FL
time_t rfctime(char const *date
);
1091 FL
time_t combinetime(int year
, int month
, int day
,
1092 int hour
, int minute
, int second
);
1094 FL
void substdate(struct message
*m
);
1096 /* TODO Weird thing that tries to fill in From: and Sender: */
1097 FL
void setup_from_and_sender(struct header
*hp
);
1099 /* Note: returns 0x1 if both args were NULL */
1100 FL
struct name
const * check_from_and_sender(struct name
const *fromfield
,
1101 struct name
const *senderfield
);
1104 FL
char * getsender(struct message
*m
);
1107 /* Fill in / reedit the desired header fields */
1108 FL
int grab_headers(enum n_go_input_flags gif
, struct header
*hp
,
1109 enum gfield gflags
, int subjfirst
);
1111 /* Check whether sep->ss_sexpr (or ->ss_regex) matches any header of mp */
1112 FL bool_t
header_match(struct message
*mp
, struct search_expr
const *sep
);
1114 /* Query *customhdr* */
1115 FL
struct n_header_field
*n_customhdr_query(void);
1121 /* `(un)?headerpick' */
1122 FL
int c_headerpick(void *vp
);
1123 FL
int c_unheaderpick(void *vp
);
1125 /* TODO Compat variants of the c_(un)?h*() series,
1126 * except for `retain' and `ignore', which are standardized */
1127 FL
int c_retain(void *vp
);
1128 FL
int c_ignore(void *vp
);
1129 FL
int c_unretain(void *vp
);
1130 FL
int c_unignore(void *vp
);
1132 FL
int c_saveretain(void *v
);
1133 FL
int c_saveignore(void *v
);
1134 FL
int c_unsaveretain(void *v
);
1135 FL
int c_unsaveignore(void *v
);
1137 FL
int c_fwdretain(void *v
);
1138 FL
int c_fwdignore(void *v
);
1139 FL
int c_unfwdretain(void *v
);
1140 FL
int c_unfwdignore(void *v
);
1142 /* Ignore object lifecycle. (Most of the time this interface deals with
1143 * special n_IGNORE_* objects, e.g., n_IGNORE_TYPE, though.)
1144 * isauto: whether auto-reclaimed storage is to be used for allocations;
1145 * if so, _del() needn't be called */
1146 FL
struct n_ignore
*n_ignore_new(bool_t isauto
);
1147 FL
void n_ignore_del(struct n_ignore
*self
);
1149 /* Are there just _any_ user settings covered by self? */
1150 FL bool_t
n_ignore_is_any(struct n_ignore
const *self
);
1152 /* Set an entry to retain (or ignore).
1153 * Returns FAL0 if dat is not a valid header field name or an invalid regular
1154 * expression, TRU1 if insertion took place, and TRUM1 if already set */
1155 FL bool_t
n_ignore_insert(struct n_ignore
*self
, bool_t retain
,
1156 char const *dat
, size_t len
);
1157 #define n_ignore_insert_cp(SELF,RT,CP) n_ignore_insert(SELF, RT, CP, UIZ_MAX)
1159 /* Returns TRU1 if retained, TRUM1 if ignored, FAL0 if not covered */
1160 FL bool_t
n_ignore_lookup(struct n_ignore
const *self
, char const *dat
,
1162 #define n_ignore_lookup_cp(SELF,CP) n_ignore_lookup(SELF, CP, UIZ_MAX)
1163 #define n_ignore_is_ign(SELF,FDAT,FLEN) \
1164 (n_ignore_lookup(SELF, FDAT, FLEN) == TRUM1)
1170 /* Return -1 on invalid spec etc., the number of matches otherwise */
1171 #ifdef HAVE_IMAP_SEARCH
1172 FL ssize_t
imap_search(char const *spec
, int f
);
1179 /* Return a file buffer all ready to read up the passed message pointer */
1180 FL
FILE * setinput(struct mailbox
*mp
, struct message
*m
,
1181 enum needspec need
);
1184 FL
enum okay
get_body(struct message
*mp
);
1186 /* Reset (free) the global message array */
1187 FL
void message_reset(void);
1189 /* Append the passed message descriptor onto the message array; if mp is NULL,
1190 * NULLify the entry at &[msgCount-1] */
1191 FL
void message_append(struct message
*mp
);
1193 /* Append a NULL message */
1194 FL
void message_append_null(void);
1196 /* Check whether sep->ss_sexpr (or ->ss_regex) matches mp. If with_headers is
1197 * true then the headers will also be searched (as plain text) */
1198 FL bool_t
message_match(struct message
*mp
, struct search_expr
const *sep
,
1199 bool_t with_headers
);
1202 FL
struct message
* setdot(struct message
*mp
);
1204 /* Touch the named message by setting its MTOUCH flag. Touched messages have
1205 * the effect of not being sent back to the system mailbox on exit */
1206 FL
void touch(struct message
*mp
);
1208 /* Convert user string of message numbers and store the numbers into vector.
1209 * Returns the count of messages picked up or -1 on error */
1210 FL
int getmsglist(char const *buf
, int *vector
, int flags
);
1212 /* Find the first message whose flags&m==f and return its message number */
1213 FL
int first(int f
, int m
);
1215 /* Mark the named message by setting its mark bit */
1216 FL
void mark(int mesg
, int f
);
1222 FL
int maildir_setfile(char const *name
, enum fedit_mode fm
);
1224 FL bool_t
maildir_quit(bool_t hold_sigs_on
);
1226 FL
enum okay
maildir_append(char const *name
, FILE *fp
, long offset
);
1228 FL
enum okay
maildir_remove(char const *name
);
1232 * Heap memory and automatically reclaimed storage, plus pseudo "alloca"
1235 /* Called from the (main)loops upon tick and break-off time to perform debug
1236 * checking and memory cleanup, including stack-top of auto-reclaimed storage */
1237 FL
void n_memory_reset(void);
1239 /* Fixate the current snapshot of our global auto-reclaimed storage instance,
1240 * so that further allocations become auto-reclaimed.
1241 * This is only called from main.c for the global arena */
1242 FL
void n_memory_pool_fixate(void);
1244 /* Lifetime management of a per-execution level arena (to be found in
1245 * n_go_data_ctx.gdc_mempool, lazy initialized).
1246 * _push() can be used by anyone to create a new stack layer in the current
1247 * per-execution level arena, which is layered upon the normal one (usually
1248 * provided by .gdc__mempool_buf, initialized as necessary).
1249 * This can be pop()ped again: popping a stack will remove all stacks "above"
1250 * it, i.e., those which have been pushed thereafter.
1251 * If NULL is popped then this means that the current per-execution level is
1252 * left and n_go_data_ctx.gdc_mempool is not NULL; an event loop tick also
1253 * causes all _push()ed stacks to be dropped (via n_memory_reset()) */
1254 FL
void n_memory_pool_push(void *vp
);
1255 FL
void n_memory_pool_pop(void *vp
);
1257 /* Generic heap memory */
1259 FL
void *n_alloc(size_t s n_MEMORY_DEBUG_ARGS
);
1260 FL
void *n_realloc(void *v
, size_t s n_MEMORY_DEBUG_ARGS
);
1261 FL
void *n_calloc(size_t nmemb
, size_t size n_MEMORY_DEBUG_ARGS
);
1262 FL
void n_free(void *vp n_MEMORY_DEBUG_ARGS
);
1264 /* TODO obsolete c{m,re,c}salloc -> n_* */
1265 #ifdef HAVE_MEMORY_DEBUG
1266 # define n_alloc(S) (n_alloc)(S, __FILE__, __LINE__)
1267 # define n_realloc(P,S) (n_realloc)(P, S, __FILE__, __LINE__)
1268 # define n_calloc(N,S) (n_calloc)(N, S, __FILE__, __LINE__)
1269 # define n_free(P) (n_free)(P, __FILE__, __LINE__)
1270 # define free(P) (n_free)(P, __FILE__, __LINE__)
1272 # define n_free(P) free(P)
1274 #define smalloc(SZ) n_alloc(SZ)
1275 #define srealloc(P,SZ) n_realloc(P, SZ)
1276 #define scalloc(N,SZ) n_calloc(N, SZ)
1278 /* Fluctuating heap memory (supposed to exist for one command loop tick) */
1280 #define n_flux_alloc(S) n_alloc(S)
1281 #define n_flux_realloc(P,S) n_realloc(P, S)
1282 #define n_flux_calloc(N,S) n_calloc(N, S)
1283 #define n_flux_free(P) n_free(P)
1285 /* Auto-reclaimed storage */
1287 /* Lower memory pressure on auto-reclaimed storage for code which has
1288 * a sinus-curve looking style of memory usage, i.e., peak followed by release,
1289 * like, e.g., doing a task on all messages of a box in order.
1290 * Such code should call _create(), successively call _unroll() after
1291 * a single message has been handled, and finally _gut() */
1292 FL
void n_autorec_relax_create(void);
1293 FL
void n_autorec_relax_gut(void);
1294 FL
void n_autorec_relax_unroll(void);
1296 /* TODO obsolete srelax -> n_autorec_relax_* */
1297 #define srelax_hold() n_autorec_relax_create()
1298 #define srelax_rele() n_autorec_relax_gut()
1299 #define srelax() n_autorec_relax_unroll()
1301 /* Allocate size more bytes of space and return the address of the first byte
1302 * to the caller. An even number of bytes are always allocated so that the
1303 * space will always be on a word boundary */
1304 FL
void *n_autorec_alloc_from_pool(void *vp
, size_t size n_MEMORY_DEBUG_ARGS
);
1305 FL
void *n_autorec_calloc_from_pool(void *vp
, size_t nmemb
, size_t size
1306 n_MEMORY_DEBUG_ARGS
);
1307 #ifdef HAVE_MEMORY_DEBUG
1308 # define n_autorec_alloc_from_pool(VP,SZ) \
1309 (n_autorec_alloc_from_pool)(VP, SZ, __FILE__, __LINE__)
1310 # define n_autorec_calloc_from_pool(VP,NM,SZ) \
1311 (n_autorec_calloc_from_pool)(VP, NM, SZ, __FILE__, __LINE__)
1313 #define n_autorec_alloc(SZ) n_autorec_alloc_from_pool(NULL, SZ)
1314 #define n_autorec_calloc(NM,SZ) n_autorec_calloc_from_pool(NULL, NM, SZ)
1316 /* TODO obsolete c?salloc -> n_autorec_* */
1317 #define salloc(SZ) n_autorec_alloc_from_pool(NULL, SZ)
1318 #define csalloc(NM,SZ) n_autorec_calloc_from_pool(NULL, NM, SZ)
1320 /* Pseudo alloca (and also auto-reclaimed in _memory_reset()/_pool_pop()) */
1321 FL
void *n_lofi_alloc(size_t size n_MEMORY_DEBUG_ARGS
);
1322 FL
void n_lofi_free(void *vp n_MEMORY_DEBUG_ARGS
);
1324 #ifdef HAVE_MEMORY_DEBUG
1325 # define n_lofi_alloc(SZ) (n_lofi_alloc)(SZ, __FILE__, __LINE__)
1326 # define n_lofi_free(P) (n_lofi_free)(P, __FILE__, __LINE__)
1329 /* The snapshot can be used in a local context, in order to free many
1330 * allocations in one go */
1331 FL
void *n_lofi_snap_create(void);
1332 FL
void n_lofi_snap_unroll(void *cookie
);
1334 /* TODO obsolete ac_alloc / ac_free -> n_lofi_* */
1335 #define ac_alloc(SZ) n_lofi_alloc(SZ)
1336 #define ac_free(P) n_lofi_free(P)
1339 #ifdef HAVE_MEMORY_DEBUG
1340 FL
int c_memtrace(void *v
);
1342 /* For immediate debugging purposes, it is possible to check on request */
1343 FL bool_t
n__memory_check(char const *file
, int line
);
1344 # define n_memory_check() n__memory_check(__FILE__, __LINE__)
1346 # define n_memory_check() do{;}while(0)
1353 /* *sendcharsets* .. *charset-8bit* iterator; *a_charset_to_try_first* may be
1354 * used to prepend a charset to this list (e.g., for *reply-in-same-charset*).
1355 * The returned boolean indicates charset_iter_is_valid().
1356 * Without HAVE_ICONV, this "iterates" over *ttycharset* only */
1357 FL bool_t
charset_iter_reset(char const *a_charset_to_try_first
);
1358 FL bool_t
charset_iter_next(void);
1359 FL bool_t
charset_iter_is_valid(void);
1360 FL
char const * charset_iter(void);
1362 /* And this is (xxx temporary?) which returns the iterator if that is valid and
1363 * otherwise either *charset-8bit* or *ttycharset*, dep. on HAVE_ICONV */
1364 FL
char const * charset_iter_or_fallback(void);
1366 FL
void charset_iter_recurse(char *outer_storage
[2]); /* TODO LEGACY */
1367 FL
void charset_iter_restore(char *outer_storage
[2]); /* TODO LEGACY */
1369 /* Check whether our headers will need MIME conversion */
1371 FL
char const * need_hdrconv(struct header
*hp
);
1374 /* Convert header fields from RFC 1522 format */
1375 FL
void mime_fromhdr(struct str
const *in
, struct str
*out
,
1376 enum tdflags flags
);
1378 /* Interpret MIME strings in parts of an address field */
1379 FL
char * mime_fromaddr(char const *name
);
1381 /* fwrite(3) performing the given MIME conversion */
1382 FL ssize_t
mime_write(char const *ptr
, size_t size
, FILE *f
,
1383 enum conversion convert
, enum tdflags dflags
,
1384 struct quoteflt
*qf
, struct str
*outrest
,
1385 struct str
*inrest
);
1386 FL ssize_t
xmime_write(char const *ptr
, size_t size
, /* TODO LEGACY */
1387 FILE *f
, enum conversion convert
, enum tdflags dflags
);
1391 * Content-Transfer-Encodings as defined in RFC 2045 (and RFC 2047):
1392 * - Quoted-Printable, section 6.7
1393 * - Base64, section 6.8
1394 * TODO For now this is pretty mixed up regarding this external interface
1395 * TODO (and due to that the code is, too).
1396 * TODO In v15.0 CTE will be filter based, and explicit conversion will
1397 * TODO gain clear error codes
1400 /* Default MIME Content-Transfer-Encoding: as via *encoding* */
1401 FL
enum mime_enc
mime_enc_target(void);
1403 /* Map from a Content-Transfer-Encoding: header body (which may be NULL) */
1404 FL
enum mime_enc
mime_enc_from_ctehead(char const *hbody
);
1406 /* XXX Try to get rid of that */
1407 FL
char const * mime_enc_from_conversion(enum conversion
const convert
);
1409 /* How many characters of (the complete body) ln need to be quoted.
1410 * Only MIMEEF_ISHEAD and MIMEEF_ISENCWORD are understood */
1411 FL
size_t mime_enc_mustquote(char const *ln
, size_t lnlen
,
1412 enum mime_enc_flags flags
);
1414 /* How much space is necessary to encode len bytes in QP, worst case.
1415 * Includes room for terminator, UIZ_MAX on overflow */
1416 FL
size_t qp_encode_calc_size(size_t len
);
1418 /* If flags includes QP_ISHEAD these assume "word" input and use special
1419 * quoting rules in addition; soft line breaks are not generated.
1420 * Otherwise complete input lines are assumed and soft line breaks are
1421 * generated as necessary. Return NULL on error (overflow) */
1422 FL
struct str
* qp_encode(struct str
*out
, struct str
const *in
,
1423 enum qpflags flags
);
1425 FL
struct str
* qp_encode_cp(struct str
*out
, char const *cp
,
1426 enum qpflags flags
);
1427 FL
struct str
* qp_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
1428 enum qpflags flags
);
1431 /* The buffers of out and *rest* will be managed via srealloc().
1432 * If inrest_or_null is needed but NULL an error occurs, otherwise tolerant.
1433 * Return FAL0 on error; caller is responsible to free buffers */
1434 FL bool_t
qp_decode_header(struct str
*out
, struct str
const *in
);
1435 FL bool_t
qp_decode_part(struct str
*out
, struct str
const *in
,
1436 struct str
*outrest
, struct str
*inrest_or_null
);
1438 /* How much space is necessary to encode len bytes in Base64, worst case.
1439 * Includes room for (CR/LF/CRLF and) terminator, UIZ_MAX on overflow */
1440 FL
size_t b64_encode_calc_size(size_t len
);
1442 /* Note these simply convert all the input (if possible), including the
1443 * insertion of NL sequences if B64_CRLF or B64_LF is set (and multiple thereof
1444 * if B64_MULTILINE is set).
1445 * Thus, in the B64_BUF case, better call b64_encode_calc_size() first.
1446 * Return NULL on error (overflow; cannot happen for B64_BUF) */
1447 FL
struct str
* b64_encode(struct str
*out
, struct str
const *in
,
1448 enum b64flags flags
);
1449 FL
struct str
* b64_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
1450 enum b64flags flags
);
1452 FL
struct str
* b64_encode_cp(struct str
*out
, char const *cp
,
1453 enum b64flags flags
);
1456 /* The _{header,part}() variants are failure tolerant, the latter requires
1457 * outrest to be set; due to the odd 4:3 relation inrest_or_null should be
1458 * given, _then_, it is an error if it is needed but not set.
1459 * TODO pre v15 callers should ensure that no endless loop is entered because
1460 * TODO the inrest cannot be converted and ends up as inrest over and over:
1461 * TODO give NULL to stop such loops.
1462 * The buffers of out and possibly *rest* will be managed via srealloc().
1463 * Returns FAL0 on error; caller is responsible to free buffers.
1464 * XXX FAL0 is effectively not returned for _part*() variants,
1465 * XXX (instead replacement characters are produced for invalid data.
1466 * XXX _Unless_ operation could EOVERFLOW.)
1467 * XXX I.e. this is bad and is tolerant for text and otherwise not */
1468 FL bool_t
b64_decode(struct str
*out
, struct str
const *in
);
1469 FL bool_t
b64_decode_header(struct str
*out
, struct str
const *in
);
1470 FL bool_t
b64_decode_part(struct str
*out
, struct str
const *in
,
1471 struct str
*outrest
, struct str
*inrest_or_null
);
1477 /* Get a mime style parameter from a header body */
1478 FL
char * mime_param_get(char const *param
, char const *headerbody
);
1480 /* Format parameter name to have value, salloc() it or NULL (error) in result.
1481 * 0 on error, 1 or -1 on success: the latter if result contains \n newlines,
1482 * which it will if the created param requires more than MIME_LINELEN bytes;
1483 * there is never a trailing newline character */
1484 /* TODO mime_param_create() should return a StrList<> or something.
1485 * TODO in fact it should take a HeaderField* and append a HeaderFieldParam*! */
1486 FL si8_t
mime_param_create(struct str
*result
, char const *name
,
1489 /* Get the boundary out of a Content-Type: multipart/xyz header field, return
1490 * salloc()ed copy of it; store strlen() in *len if set */
1491 FL
char * mime_param_boundary_get(char const *headerbody
, size_t *len
);
1493 /* Create a salloc()ed MIME boundary */
1494 FL
char * mime_param_boundary_create(void);
1500 /* Create MIME part object tree for and of mp */
1501 FL
struct mimepart
* mime_parse_msg(struct message
*mp
,
1502 enum mime_parse_flags mpf
);
1508 /* `(un)?mimetype' commands */
1509 FL
int c_mimetype(void *v
);
1510 FL
int c_unmimetype(void *v
);
1512 /* Check whether the Content-Type name is internally known */
1513 FL bool_t
n_mimetype_check_mtname(char const *name
);
1515 /* Return a Content-Type matching the name, or NULL if none could be found */
1516 FL
char *n_mimetype_classify_filename(char const *name
);
1518 /* Classify content of *fp* as necessary and fill in arguments; **charset* is
1519 * set to *charset-7bit* or charset_iter_or_fallback() if NULL */
1520 FL
enum conversion
n_mimetype_classify_file(FILE *fp
, char const **contenttype
,
1521 char const **charset
, int *do_iconv
);
1523 /* Dependend on *mime-counter-evidence* mpp->m_ct_type_usr_ovwr will be set,
1524 * but otherwise mpp is const */
1525 FL
enum mimecontent
n_mimetype_classify_part(struct mimepart
*mpp
);
1527 /* Query handler for a part, return the plain type (& MIME_HDL_TYPE_MASK).
1528 * mhp is anyway initialized (mh_flags, mh_msg) */
1529 FL
enum mime_handler_flags
n_mimetype_handler(struct mime_handler
*mhp
,
1530 struct mimepart
const *mpp
,
1531 enum sendaction action
);
1537 /* Allocate a single element of a name list, initialize its name field to the
1538 * passed name and return it */
1539 FL
struct name
* nalloc(char const *str
, enum gfield ntype
);
1541 /* Like nalloc(), but initialize from content of np */
1542 FL
struct name
* ndup(struct name
*np
, enum gfield ntype
);
1544 /* Concatenate the two passed name lists, return the result */
1545 FL
struct name
* cat(struct name
*n1
, struct name
*n2
);
1548 FL
struct name
* namelist_dup(struct name
const *np
, enum gfield ntype
);
1550 /* Determine the number of undeleted elements in a name list and return it;
1551 * the latter also doesn't count file and pipe addressees in addition */
1552 FL ui32_t
count(struct name
const *np
);
1553 FL ui32_t
count_nonlocal(struct name
const *np
);
1555 /* Extract a list of names from a line, and make a list of names from it.
1556 * Return the list or NULL if none found */
1557 FL
struct name
* extract(char const *line
, enum gfield ntype
);
1559 /* Like extract() unless line contains anyof ",\"\\(<|", in which case
1560 * comma-separated list extraction is used instead */
1561 FL
struct name
* lextract(char const *line
, enum gfield ntype
);
1563 /* Turn a list of names into a string of the same names */
1564 FL
char * detract(struct name
*np
, enum gfield ntype
);
1566 /* Get a lextract() list via n_go_input_cp(), reassigning to *np* */
1567 FL
struct name
* grab_names(enum n_go_input_flags gif
, char const *field
,
1568 struct name
*np
, int comma
, enum gfield gflags
);
1570 /* Check whether n1 n2 share the domain name */
1571 FL bool_t
name_is_same_domain(struct name
const *n1
,
1572 struct name
const *n2
);
1574 /* Check all addresses in np and delete invalid ones; if set_on_error is not
1575 * NULL it'll be set to TRU1 for error or -1 for "hard fail" error */
1576 FL
struct name
* checkaddrs(struct name
*np
, enum expand_addr_check_mode eacm
,
1577 si8_t
*set_on_error
);
1579 /* Vaporise all duplicate addresses in hp (.h_(to|cc|bcc)) so that an address
1580 * that "first" occurs in To: is solely in there, ditto Cc:, after expanding
1581 * aliases etc. eacm and set_on_error are passed to checkaddrs(), metoo is
1582 * passed to usermap(). After updating hp to the new state this returns
1583 * a flat list of all addressees, which may be NULL */
1584 FL
struct name
* namelist_vaporise_head(struct header
*hp
,
1585 enum expand_addr_check_mode eacm
, bool_t metoo
,
1586 si8_t
*set_on_error
);
1588 /* Map all of the aliased users in the invoker's mailrc file and insert them
1590 FL
struct name
* usermap(struct name
*names
, bool_t force_metoo
);
1592 /* Remove all of the duplicates from the passed name list by insertion sorting
1593 * them, then checking for dups. Return the head of the new list */
1594 FL
struct name
* elide(struct name
*names
);
1596 /* `alternates' deal with the list of alternate names */
1597 FL
int c_alternates(void *v
);
1599 FL
struct name
* delete_alternates(struct name
*np
);
1601 FL
int is_myname(char const *name
);
1604 FL
int c_addrcodec(void *v
);
1606 /* `(un)?commandalias'.
1607 * And whether a `commandalias' name exists, returning name or NULL, pointing
1608 * expansion_or_null to expansion if set: both point into internal storage */
1609 FL
int c_commandalias(void *vp
);
1610 FL
int c_uncommandalias(void *vp
);
1612 FL
char const *n_commandalias_exists(char const *name
,
1613 struct str
const **expansion_or_null
);
1615 /* Is name a valid alias */
1616 FL bool_t
n_alias_is_valid_name(char const *name
);
1619 FL
int c_alias(void *v
);
1620 FL
int c_unalias(void *v
);
1622 /* `(un)?ml(ist|subscribe)', and a check whether a name is a (wanted) list */
1623 FL
int c_mlist(void *v
);
1624 FL
int c_unmlist(void *v
);
1625 FL
int c_mlsubscribe(void *v
);
1626 FL
int c_unmlsubscribe(void *v
);
1628 FL
enum mlist_state
is_mlist(char const *name
, bool_t subscribed_only
);
1630 /* `(un)?shortcut', and check if str is one, return expansion or NULL */
1631 FL
int c_shortcut(void *v
);
1632 FL
int c_unshortcut(void *v
);
1634 FL
char const * shortcut_expand(char const *str
);
1636 /* `(un)?charsetalias', and try to expand a charset, return mapping or itself */
1637 FL
int c_charsetalias(void *vp
);
1638 FL
int c_uncharsetalias(void *vp
);
1640 FL
char const *n_charsetalias_expand(char const *cp
);
1642 /* `(un)?filetype', and check whether file has a known (stat(2)ed) "equivalent",
1643 * as well as check whether (extension of) file is known, respectively;
1644 * res_or_null can be NULL, otherwise on success result data must be copied */
1645 FL
int c_filetype(void *vp
);
1646 FL
int c_unfiletype(void *vp
);
1648 FL bool_t
n_filetype_trial(struct n_file_type
*res_or_null
, char const *file
);
1649 FL bool_t
n_filetype_exists(struct n_file_type
*res_or_null
, char const *file
);
1655 /* Test to see if the passed file name is a directory, return true if it is.
1656 * If check_access is set, we also access(2) */
1657 FL bool_t
n_is_dir(char const *name
, bool_t check_access
);
1659 /* Recursively create a directory */
1660 FL bool_t
n_path_mkdir(char const *name
);
1662 /* Delete a file, but only if the file is a plain file; return FAL0 on system
1663 * error and TRUM1 if name is not a plain file, return TRU1 on success */
1664 FL bool_t
n_path_rm(char const *name
);
1666 /* A get-wd..restore-wd approach */
1667 FL
enum okay
cwget(struct cw
*cw
);
1668 FL
enum okay
cwret(struct cw
*cw
);
1669 FL
void cwrelse(struct cw
*cw
);
1677 FL
enum okay
pop3_noop(void);
1680 FL
int pop3_setfile(char const *server
, enum fedit_mode fm
);
1683 FL
enum okay
pop3_header(struct message
*m
);
1686 FL
enum okay
pop3_body(struct message
*m
);
1689 FL bool_t
pop3_quit(bool_t hold_sigs_on
);
1690 #endif /* HAVE_POP3 */
1694 * Subprocesses, popen, but also file handling with registering
1697 /* For program startup in main.c: initialize process manager */
1698 FL
void n_child_manager_start(void);
1700 /* Notes: OF_CLOEXEC is implied in oflags, xflags may be NULL */
1701 FL
FILE * safe_fopen(char const *file
, char const *oflags
, int *xflags
);
1703 /* Notes: OF_CLOEXEC|OF_REGISTER are implied in oflags!
1704 * Exception is Fdopen() if nocloexec is TRU1, but otherwise even for it the fd
1705 * creator has to take appropriate steps in order to ensure this is true! */
1706 FL
FILE * Fopen(char const *file
, char const *oflags
);
1707 FL
FILE * Fdopen(int fd
, char const *oflags
, bool_t nocloexec
);
1709 FL
int Fclose(FILE *fp
);
1711 /* TODO: Should be Mailbox::create_from_url(URL::from_string(DATA))!
1712 * Open file according to oflags (see popen.c). Handles compressed files,
1713 * maildir etc. If ft_or_null is given it will be filled accordingly */
1714 FL
FILE * n_fopen_any(char const *file
, char const *oflags
,
1715 enum n_fopen_state
*fs_or_null
);
1717 /* Create a temporary file in *TMPDIR*, use namehint for its name (prefix
1718 * unless OF_SUFFIX is set, in which case namehint is an extension that MUST be
1719 * part of the resulting filename, otherwise Ftmp() will fail), store the
1720 * unique name in fn (unless OF_UNLINK is set in oflags), and return a stdio
1721 * FILE pointer with access oflags. OF_CLOEXEC is implied in oflags.
1722 * One of OF_WRONLY and OF_RDWR must be set. Mode of 0600 is implied */
1723 FL
FILE * Ftmp(char **fn
, char const *namehint
, enum oflags oflags
);
1725 /* If OF_HOLDSIGS was set when calling Ftmp(), then hold_all_sigs() had been
1726 * called: call this to unlink(2) and free *fn and to rele_all_sigs() */
1727 FL
void Ftmp_release(char **fn
);
1729 /* Free the resources associated with the given filename. To be called after
1731 FL
void Ftmp_free(char **fn
);
1733 /* Create a pipe and ensure CLOEXEC bit is set in both descriptors */
1734 FL bool_t
pipe_cloexec(int fd
[2]);
1737 * env_addon may be NULL, otherwise it is expected to be a NULL terminated
1738 * array of "K=V" strings to be placed into the childs environment.
1739 * If cmd==(char*)-1 then shell is indeed expected to be a PTF :P that will be
1740 * called from within the child process */
1741 FL
FILE * Popen(char const *cmd
, char const *mode
, char const *shell
,
1742 char const **env_addon
, int newfd1
);
1743 FL bool_t
Pclose(FILE *fp
, bool_t dowait
);
1745 /* In n_PSO_INTERACTIVE, we want to go over $PAGER.
1746 * These are specialized version of Popen()/Pclose() which also encapsulate
1747 * error message printing, terminal handling etc. additionally */
1748 FL
FILE * n_pager_open(void);
1749 FL bool_t
n_pager_close(FILE *fp
);
1752 FL
void close_all_files(void);
1754 /* Run a command without a shell, with optional arguments and splicing of stdin
1755 * and stdout. FDs may also be n_CHILD_FD_NULL and n_CHILD_FD_PASS, meaning
1756 * to redirect from/to /dev/null or pass through our own set of FDs; in the
1757 * latter case terminal capabilities are saved/restored if possible.
1758 * The command name can be a sequence of words.
1759 * Signals must be handled by the caller. "Mask" contains the signals to
1760 * ignore in the new process. SIGINT is enabled unless it's in the mask.
1761 * env_addon may be NULL, otherwise it is expected to be a NULL terminated
1762 * array of "K=V" strings to be placed into the childs environment */
1763 FL
int n_child_run(char const *cmd
, sigset_t
*mask
, int infd
, int outfd
,
1764 char const *a0
, char const *a1
, char const *a2
,
1765 char const **env_addon
);
1767 /* Like n_child_run(), but don't wait for the command to finish.
1768 * Also it is usually an error to use n_CHILD_FD_PASS for this one */
1769 FL
int n_child_start(char const *cmd
, sigset_t
*mask
, int infd
, int outfd
,
1770 char const *a0
, char const *a1
, char const *a2
,
1771 char const **env_addon
);
1773 /* Fork a child process, enable the other three:
1774 * - in-child image preparation
1775 * - mark a child as don't care
1776 * - wait for child pid, return whether we've had a normal n_EXIT_OK exit.
1777 * If wait_status is set, set it to the reported waitpid(2) wait status */
1778 FL
int n_child_fork(void);
1779 FL
void n_child_prepare(sigset_t
*nset
, int infd
, int outfd
);
1780 FL
void n_child_free(int pid
);
1781 FL bool_t
n_child_wait(int pid
, int *wait_status
);
1787 /* Save all of the undetermined messages at the top of "mbox". Save all
1788 * untouched messages back in the system mailbox. Remove the system mailbox,
1789 * if none saved there.
1790 * TODO v15 Note: assumes hold_sigs() has been called _and_ can be temporarily
1791 * TODO dropped via a single rele_sigs() if hold_sigs_on */
1792 FL bool_t
quit(bool_t hold_sigs_on
);
1794 /* Adjust the message flags in each message */
1795 FL
int holdbits(void);
1797 /* Create another temporary file and copy user's mbox file darin. If there is
1798 * no mbox, copy nothing. If he has specified "append" don't copy his mailbox,
1799 * just copy saveable entries at the end */
1800 FL
enum okay
makembox(void);
1802 FL
void save_mbox_for_possible_quitstuff(void); /* TODO DROP IF U CAN */
1804 FL
int savequitflags(void);
1806 FL
void restorequitflags(int);
1812 /* Send message described by the passed pointer to the passed output buffer.
1813 * Return -1 on error. Adjust the status: field if need be. If doitp is
1814 * given, suppress ignored header fields. prefix is a string to prepend to
1815 * each output line. action = data destination
1816 * (SEND_MBOX,_TOFILE,_TODISP,_QUOTE,_DECRYPT). stats[0] is line count,
1817 * stats[1] is character count. stats may be NULL. Note that stats[0] is
1818 * valid for SEND_MBOX only */
1819 FL
int sendmp(struct message
*mp
, FILE *obuf
,
1820 struct n_ignore
const *doitp
,
1821 char const *prefix
, enum sendaction action
, ui64_t
*stats
);
1827 /* Interface between the argument list and the mail1 routine which does all the
1829 FL
int mail(struct name
*to
, struct name
*cc
, struct name
*bcc
,
1830 char const *subject
, struct attachment
*attach
,
1831 char const *quotefile
, int recipient_record
);
1833 /* `mail' and `Mail' commands, respectively */
1834 FL
int c_sendmail(void *v
);
1835 FL
int c_Sendmail(void *v
);
1837 /* Mail a message on standard input to the people indicated in the passed
1838 * header. (Internal interface) */
1839 FL
enum okay
mail1(struct header
*hp
, int printheaders
,
1840 struct message
*quote
, char const *quotefile
,
1841 int recipient_record
, int doprefix
);
1843 /* Create a Date: header field.
1844 * We compare the localtime() and gmtime() results to get the timezone, because
1845 * numeric timezones are easier to read and because $TZ isn't always set */
1846 FL
int mkdate(FILE *fo
, char const *field
);
1848 /* Dump the to, subject, cc header on the passed file buffer.
1849 * nosend_msg tells us not to dig to deep but to instead go for compose mode or
1850 * editing a message (yet we're stupid and cannot do it any better) - if it is
1851 * TRUM1 then we're really in compose mode and will produce some fields for
1852 * easier filling in */
1853 FL
int puthead(bool_t nosend_msg
, struct header
*hp
, FILE *fo
,
1854 enum gfield w
, enum sendaction action
,
1855 enum conversion convert
, char const *contenttype
,
1856 char const *charset
);
1859 FL
enum okay
resend_msg(struct message
*mp
, struct name
*to
, int add_resent
);
1862 FL
void savedeadletter(FILE *fp
, bool_t fflush_rewind_first
);
1868 /* Evaluate the string given as a new mailbox name. Supported meta characters:
1869 * . % for my system mail box
1870 * . %user for user's system mail box
1871 * . # for previous file
1872 * . & invoker's mbox file
1873 * . +file file in folder directory
1874 * . any shell meta character (except for FEXP_NSHELL).
1875 * a poor man's vis(3), on name before calling this (and showing the user).
1876 * If FEXP_MULTIOK is set we return an array of terminated strings, the (last)
1877 * result string is terminated via \0\0 and n_PS_EXPAND_MULTIRESULT is set.
1878 * Returns the file name as an auto-reclaimed string */
1879 FL
char *fexpand(char const *name
, enum fexp_mode fexpm
);
1881 /* Parse the next shell token from input (->s and ->l are adjusted to the
1882 * remains, data is constant beside that; ->s may be NULL if ->l is 0, if ->l
1883 * EQ UIZ_MAX strlen(->s) is used) and append the resulting output to store.
1884 * If cookie is not NULL and we're in double-quotes then ${@} will be exploded
1885 * just as known from the sh(1)ell in that case */
1886 FL
enum n_shexp_state
n_shexp_parse_token(enum n_shexp_parse_flags flags
,
1887 struct n_string
*store
, struct str
*input
,
1888 void const **cookie
);
1890 /* Quick+dirty simplified : if an error occurs, returns a copy of *cp and set
1891 * *cp to NULL, otherwise advances *cp to over the parsed token */
1892 FL
char *n_shexp_parse_token_cp(enum n_shexp_parse_flags flags
,
1895 /* Quote input in a way that can, in theory, be fed into parse_token() again.
1896 * ->s may be NULL if ->l is 0, if ->l EQ UIZ_MAX strlen(->s) is used.
1897 * If rndtrip is true we try to make the resulting string "portable" (by
1898 * converting Unicode to \u etc.), otherwise we produce something to be
1899 * consumed "now", i.e., to display for the user.
1900 * Resulting output is _appended_ to store.
1901 * TODO Note: last resort, since \u and $ expansions etc. are necessarily
1902 * TODO already expanded and can thus not be reverted, but ALL we have */
1903 FL
struct n_string
*n_shexp_quote(struct n_string
*store
,
1904 struct str
const *input
, bool_t rndtrip
);
1905 FL
char *n_shexp_quote_cp(char const *cp
, bool_t rndtrip
);
1907 /* Can name be used as a variable name? I.e., this returns false for special
1908 * parameter names like $# etc. */
1909 FL bool_t
n_shexp_is_valid_varname(char const *name
);
1912 FL
int c_shcodec(void *v
);
1919 FL
int c_sigstate(void *);
1922 FL
void n_raise(int signo
);
1924 /* Provide BSD-like signal() on all systems TODO v15 -> SysV -> n_signal() */
1925 FL sighandler_type
safe_signal(int signum
, sighandler_type handler
);
1927 /* Provide reproducable non-restartable signal handler installation */
1928 FL n_sighdl_t
n_signal(int signo
, n_sighdl_t hdl
);
1930 /* Hold *all* signals but SIGCHLD, and release that total block again */
1931 FL
void hold_all_sigs(void);
1932 FL
void rele_all_sigs(void);
1934 /* Hold HUP/QUIT/INT */
1935 FL
void hold_sigs(void);
1936 FL
void rele_sigs(void);
1938 /* Call _ENTER_SWITCH() with the according flags, it'll take care for the rest
1939 * and also set the jump buffer - it returns 0 if anything went fine and
1940 * a signal number if a jump occurred, in which case all handlers requested in
1941 * flags are temporarily SIG_IGN.
1942 * _cleanup_ping() informs the condome that no jumps etc. shall be performed
1943 * until _leave() is called in the following -- to be (optionally) called right
1944 * before the local jump label is reached which is jumped to after a long jump
1945 * occurred, straight code flow provided, e.g., to avoid destructors to be
1946 * called twice. _leave() must always be called last, reraise_flags will be
1947 * used to decide how signal handling has to continue
1949 #define n_SIGMAN_ENTER_SWITCH(S,F) do{\
1952 if(sigsetjmp((S)->sm_jump, 1))\
1956 n__sigman_enter(S, __x__);\
1957 }while(0); switch((S)->sm_signo)
1958 FL
int n__sigman_enter(struct n_sigman
*self
, int flags
);
1959 FL
void n_sigman_cleanup_ping(struct n_sigman
*self
);
1960 FL
void n_sigman_leave(struct n_sigman
*self
, enum n_sigman_flags flags
);
1962 /* Pending signal or 0? */
1963 FL
int n_sigman_peek(void);
1964 FL
void n_sigman_consume(void);
1966 /* Not-Yet-Dead debug information (handler installation in main.c) */
1967 #if defined HAVE_DEBUG || defined HAVE_DEVEL
1968 FL
void _nyd_chirp(ui8_t act
, char const *file
, ui32_t line
,
1970 FL
void _nyd_oncrash(int signo
);
1973 # define NYD_ENTER _nyd_chirp(1, __FILE__, __LINE__, __FUN__)
1974 # define NYD_LEAVE _nyd_chirp(2, __FILE__, __LINE__, __FUN__)
1975 # define NYD _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
1976 # define NYD_X _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
1978 # define NYD2_ENTER _nyd_chirp(1, __FILE__, __LINE__, __FUN__)
1979 # define NYD2_LEAVE _nyd_chirp(2, __FILE__, __LINE__, __FUN__)
1980 # define NYD2 _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
1986 # define NYD_ENTER do {} while (0)
1987 # define NYD_LEAVE do {} while (0)
1988 # define NYD do {} while (0)
1989 # define NYD_X do {} while (0) /* XXX LEGACY */
1992 # define NYD2_ENTER do {} while (0)
1993 # define NYD2_LEAVE do {} while (0)
1994 # define NYD2 do {} while (0)
2002 /* Send a message via SMTP */
2003 FL bool_t
smtp_mta(struct sendbundle
*sbp
);
2011 FL bool_t
sopen(struct sock
*sp
, struct url
*urlp
);
2012 FL
int sclose(struct sock
*sp
);
2013 FL
enum okay
swrite(struct sock
*sp
, char const *data
);
2014 FL
enum okay
swrite1(struct sock
*sp
, char const *data
, int sz
,
2018 FL
int sgetline(char **line
, size_t *linesize
, size_t *linelen
,
2019 struct sock
*sp n_MEMORY_DEBUG_ARGS
);
2020 # ifdef HAVE_MEMORY_DEBUG
2021 # define sgetline(A,B,C,D) sgetline(A, B, C, D, __FILE__, __LINE__)
2030 /* Direct mappings of the various spam* commands */
2031 FL
int c_spam_clear(void *v
);
2032 FL
int c_spam_set(void *v
);
2033 FL
int c_spam_forget(void *v
);
2034 FL
int c_spam_ham(void *v
);
2035 FL
int c_spam_rate(void *v
);
2036 FL
int c_spam_spam(void *v
);
2045 FL
void ssl_set_verify_level(struct url
const *urlp
);
2048 FL
enum okay
ssl_verify_decide(void);
2051 FL
enum okay
smime_split(FILE *ip
, FILE **hp
, FILE **bp
, long xcount
,
2055 FL
FILE * smime_sign_assemble(FILE *hp
, FILE *bp
, FILE *sp
,
2056 char const *message_digest
);
2059 FL
FILE * smime_encrypt_assemble(FILE *hp
, FILE *yp
);
2062 FL
struct message
* smime_decrypt_assemble(struct message
*m
, FILE *hp
,
2066 FL
int c_certsave(void *v
);
2069 FL
enum okay
rfc2595_hostname_match(char const *host
, char const *pattern
);
2076 /* Return a pointer to a dynamic copy of the argument */
2077 FL
char * savestr(char const *str n_MEMORY_DEBUG_ARGS
);
2078 FL
char * savestrbuf(char const *sbuf
, size_t slen n_MEMORY_DEBUG_ARGS
);
2079 #ifdef HAVE_MEMORY_DEBUG
2080 # define savestr(CP) savestr(CP, __FILE__, __LINE__)
2081 # define savestrbuf(CBP,CBL) savestrbuf(CBP, CBL, __FILE__, __LINE__)
2084 /* Concatenate cp2 onto cp1 (if not NULL), separated by sep (if not '\0') */
2085 FL
char * savecatsep(char const *cp1
, char sep
, char const *cp2
2086 n_MEMORY_DEBUG_ARGS
);
2087 #ifdef HAVE_MEMORY_DEBUG
2088 # define savecatsep(S1,SEP,S2) savecatsep(S1, SEP, S2, __FILE__, __LINE__)
2091 /* Make copy of argument incorporating old one, if set, separated by space */
2092 #define save2str(S,O) savecatsep(O, ' ', S)
2095 #define savecat(S1,S2) savecatsep(S1, '\0', S2)
2097 /* Create duplicate, lowercasing all characters along the way */
2098 FL
char * i_strdup(char const *src n_MEMORY_DEBUG_ARGS
);
2099 #ifdef HAVE_MEMORY_DEBUG
2100 # define i_strdup(CP) i_strdup(CP, __FILE__, __LINE__)
2104 FL
struct str
* str_concat_csvl(struct str
*self
, ...);
2107 FL
struct str
* str_concat_cpa(struct str
*self
, char const * const *cpa
,
2108 char const *sep_o_null n_MEMORY_DEBUG_ARGS
);
2109 #ifdef HAVE_MEMORY_DEBUG
2110 # define str_concat_cpa(S,A,N) str_concat_cpa(S, A, N, __FILE__, __LINE__)
2113 /* Plain char* support, not auto-reclaimed (unless noted) */
2115 /* Are any of the characters in the two strings the same? */
2116 FL bool_t
n_anyof_buf(char const *template, char const *dat
, size_t len
);
2117 #define n_anyof_cp(S1,S2) n_anyof_buf(S1, S2, UIZ_MAX)
2118 #define anyof(S1,S2) n_anyof_buf(S1, S2, UIZ_MAX)
2120 /* Treat *iolist as a sep separated list of strings; find and return the
2121 * next entry, trimming surrounding whitespace, and point *iolist to the next
2122 * entry or to NULL if no more entries are contained. If ignore_empty is
2123 * set empty entries are started over.
2124 * See n_shexp_parse_token() for the new way that supports sh(1) quoting.
2125 * Return NULL or an entry */
2126 FL
char * n_strsep(char **iolist
, char sep
, bool_t ignore_empty
);
2128 /* Copy a string, lowercasing it as we go; *size* is buffer size of *dest*;
2129 * *dest* will always be terminated unless *size* is 0 */
2130 FL
void i_strcpy(char *dest
, char const *src
, size_t size
);
2132 /* Is *as1* a valid prefix of *as2*? */
2133 FL
int is_prefix(char const *as1
, char const *as2
);
2135 /* Reverse solidus quote (" and \) v'alue, and return salloc()ed result */
2136 FL
char * string_quote(char const *v
);
2138 /* Get (and isolate) the last, possibly quoted part of linebuf, set *needs_list
2139 * to indicate whether getmsglist() et al need to be called to collect
2140 * additional args that remain in linebuf. If strip is true possibly
2141 * surrounding quote characters are removed. Return NULL on "error" */
2142 FL
char * laststring(char *linebuf
, bool_t
*needs_list
, bool_t strip
);
2144 /* Convert a string to lowercase, in-place and with multibyte-aware */
2145 FL
void makelow(char *cp
);
2147 /* Is *sub* a substring of *str*, case-insensitive and multibyte-aware? */
2148 FL bool_t
substr(char const *str
, char const *sub
);
2151 FL
char * sstpcpy(char *dst
, char const *src
);
2152 FL
char * sstrdup(char const *cp n_MEMORY_DEBUG_ARGS
);
2153 FL
char * sbufdup(char const *cp
, size_t len n_MEMORY_DEBUG_ARGS
);
2154 #ifdef HAVE_MEMORY_DEBUG
2155 # define sstrdup(CP) sstrdup(CP, __FILE__, __LINE__)
2156 # define sbufdup(CP,L) sbufdup(CP, L, __FILE__, __LINE__)
2159 /* Copy at most dstsize bytes of src to dst and return string length.
2160 * Returns -E2BIG if dst is not large enough; dst will always be terminated
2161 * unless dstsize was 0 on entry */
2162 FL ssize_t
n_strscpy(char *dst
, char const *src
, size_t dstsize
);
2164 /* Case-independent ASCII comparisons */
2165 FL
int asccasecmp(char const *s1
, char const *s2
);
2166 FL
int ascncasecmp(char const *s1
, char const *s2
, size_t sz
);
2168 /* Case-independent ASCII string find s2 in s1, return it or NULL */
2169 FL
char const *asccasestr(char const *s1
, char const *s2
);
2171 /* Case-independent ASCII check whether as1 is the initial substring of as2 */
2172 FL bool_t
is_asccaseprefix(char const *as1
, char const *as2
);
2173 FL bool_t
is_ascncaseprefix(char const *as1
, char const *as2
, size_t sz
);
2175 /* struct str related support funs TODO _cp->_cs! */
2177 /* *self->s* is srealloc()ed */
2178 #define n_str_dup(S, T) n_str_assign_buf((S), (T)->s, (T)->l)
2180 /* *self->s* is srealloc()ed; if buflen==UIZ_MAX strlen() is called unless buf
2181 * is NULL; buf may be NULL if buflen is 0 */
2182 FL
struct str
* n_str_assign_buf(struct str
*self
,
2183 char const *buf
, uiz_t buflen n_MEMORY_DEBUG_ARGS
);
2184 #define n_str_assign(S, T) n_str_assign_buf(S, (T)->s, (T)->l)
2185 #define n_str_assign_cp(S, CP) n_str_assign_buf(S, CP, UIZ_MAX)
2187 /* *self->s* is srealloc()ed, *self->l* incremented; if buflen==UIZ_MAX
2188 * strlen() is called unless buf is NULL; buf may be NULL if buflen is 0 */
2189 FL
struct str
* n_str_add_buf(struct str
*self
, char const *buf
, uiz_t buflen
2190 n_MEMORY_DEBUG_ARGS
);
2191 #define n_str_add(S, T) n_str_add_buf(S, (T)->s, (T)->l)
2192 #define n_str_add_cp(S, CP) n_str_add_buf(S, CP, UIZ_MAX)
2194 #ifdef HAVE_MEMORY_DEBUG
2195 # define n_str_assign_buf(S,B,BL) n_str_assign_buf(S, B, BL, __FILE__, __LINE__)
2196 # define n_str_add_buf(S,B,BL) n_str_add_buf(S, B, BL, __FILE__, __LINE__)
2199 /* Remove leading and trailing spacechar()s and *ifs-ws*, respectively.
2200 * The ->s and ->l of the string will be adjusted, but no NUL termination will
2201 * be applied to a possibly adjusted buffer!
2202 * If dofaults is set, " \t\n" is always trimmed (in addition) */
2203 FL
struct str
*n_str_trim(struct str
*self
);
2204 FL
struct str
*n_str_trim_ifs(struct str
*self
, bool_t dodefaults
);
2207 * May have NULL buffer, may contain embedded NULs */
2209 /* Lifetime. n_string_gut() is optional for _creat_auto() strings */
2210 #define n_string_creat(S) \
2211 ((S)->s_dat = NULL, (S)->s_len = (S)->s_auto = (S)->s_size = 0, (S))
2212 #define n_string_creat_auto(S) \
2213 ((S)->s_dat = NULL, (S)->s_len = (S)->s_size = 0, (S)->s_auto = TRU1, (S))
2214 #define n_string_gut(S) ((S)->s_size != 0 ? (void)n_string_clear(S) : (void)0)
2216 /* Truncate to size, which must be LE current length */
2217 #define n_string_trunc(S,L) \
2218 (assert(UICMP(z, L, <=, (S)->s_len)), (S)->s_len = (ui32_t)(L), (S))
2220 /* Check whether a buffer of Len bytes can be inserted into Self */
2221 #define n_string_can_swallow(S,L) \
2222 (UICMP(z, SI32_MAX - n_ALIGN(1), >=, L) &&\
2223 UICMP(z, SI32_MAX - n_ALIGN(1) - (L), >, (S)->s_len))
2225 /* Take/Release buffer ownership */
2226 #define n_string_take_ownership(SP,B,S,L) \
2227 (assert((SP)->s_dat == NULL), assert((S) == 0 || (B) != NULL),\
2228 assert((L) < (S) || (L) == 0),\
2229 (SP)->s_dat = (B), (SP)->s_len = (L), (SP)->s_size = (S), (SP))
2230 #define n_string_drop_ownership(SP) \
2231 ((SP)->s_dat = NULL, (SP)->s_len = (SP)->s_size = 0, (SP))
2233 /* Release all memory */
2234 FL
struct n_string
*n_string_clear(struct n_string
*self n_MEMORY_DEBUG_ARGS
);
2236 #ifdef HAVE_MEMORY_DEBUG
2237 # define n_string_clear(S) \
2238 ((S)->s_size != 0 ? (n_string_clear)(S, __FILE__, __LINE__) : (S))
2240 # define n_string_clear(S) ((S)->s_size != 0 ? (n_string_clear)(S) : (S))
2243 /* Reserve room for noof additional bytes, but don't adjust length (yet) */
2244 FL
struct n_string
*n_string_reserve(struct n_string
*self
, size_t noof
2245 n_MEMORY_DEBUG_ARGS
);
2247 /* Resize to exactly nlen bytes; any new storage isn't initialized */
2248 FL
struct n_string
*n_string_resize(struct n_string
*self
, size_t nlen
2249 n_MEMORY_DEBUG_ARGS
);
2251 #ifdef HAVE_MEMORY_DEBUG
2252 # define n_string_reserve(S,N) (n_string_reserve)(S, N, __FILE__, __LINE__)
2253 # define n_string_resize(S,N) (n_string_resize)(S, N, __FILE__, __LINE__)
2257 FL
struct n_string
*n_string_push_buf(struct n_string
*self
, char const *buf
,
2258 size_t buflen n_MEMORY_DEBUG_ARGS
);
2259 #define n_string_push(S, T) n_string_push_buf(S, (T)->s_len, (T)->s_dat)
2260 #define n_string_push_cp(S,CP) n_string_push_buf(S, CP, UIZ_MAX)
2261 FL
struct n_string
*n_string_push_c(struct n_string
*self
, char c
2262 n_MEMORY_DEBUG_ARGS
);
2264 #define n_string_assign(S,T) ((S)->s_len = 0, n_string_push(S, T))
2265 #define n_string_assign_c(S,C) ((S)->s_len = 0, n_string_push_c(S, C))
2266 #define n_string_assign_cp(S,CP) ((S)->s_len = 0, n_string_push_cp(S, CP))
2267 #define n_string_assign_buf(S,B,BL) \
2268 ((S)->s_len = 0, n_string_push_buf(S, B, BL))
2270 #ifdef HAVE_MEMORY_DEBUG
2271 # define n_string_push_buf(S,B,BL) \
2272 n_string_push_buf(S, B, BL, __FILE__, __LINE__)
2273 # define n_string_push_c(S,C) n_string_push_c(S, C, __FILE__, __LINE__)
2277 FL
struct n_string
*n_string_unshift_buf(struct n_string
*self
, char const *buf
,
2278 size_t buflen n_MEMORY_DEBUG_ARGS
);
2279 #define n_string_unshift(S,T) \
2280 n_string_unshift_buf(S, (T)->s_len, (T)->s_dat)
2281 #define n_string_unshift_cp(S,CP) \
2282 n_string_unshift_buf(S, CP, UIZ_MAX)
2283 FL
struct n_string
*n_string_unshift_c(struct n_string
*self
, char c
2284 n_MEMORY_DEBUG_ARGS
);
2286 #ifdef HAVE_MEMORY_DEBUG
2287 # define n_string_unshift_buf(S,B,BL) \
2288 n_string_unshift_buf(S,B,BL, __FILE__, __LINE__)
2289 # define n_string_unshift_c(S,C) n_string_unshift_c(S, C, __FILE__, __LINE__)
2293 FL
struct n_string
*n_string_insert_buf(struct n_string
*self
, size_t idx
,
2294 char const *buf
, size_t buflen n_MEMORY_DEBUG_ARGS
);
2295 #define n_string_insert(S,I,T) \
2296 n_string_insert_buf(S, I, (T)->s_len, (T)->s_dat)
2297 #define n_string_insert_cp(S,I,CP) \
2298 n_string_insert_buf(S, I, CP, UIZ_MAX)
2299 FL
struct n_string
*n_string_insert_c(struct n_string
*self
, size_t idx
,
2300 char c n_MEMORY_DEBUG_ARGS
);
2302 #ifdef HAVE_MEMORY_DEBUG
2303 # define n_string_insert_buf(S,I,B,BL) \
2304 n_string_insert_buf(S, I, B, BL, __FILE__, __LINE__)
2305 # define n_string_insert_c(S,I,C) n_string_insert_c(S, I, C, __FILE__, __LINE__)
2309 FL
struct n_string
*n_string_cut(struct n_string
*self
, size_t idx
, size_t len
);
2311 /* Ensure self has a - NUL terminated - buffer, and return that.
2312 * The latter may return the pointer to an internal empty RODATA instead */
2313 FL
char * n_string_cp(struct n_string
*self n_MEMORY_DEBUG_ARGS
);
2314 FL
char const *n_string_cp_const(struct n_string
const *self
);
2316 #ifdef HAVE_MEMORY_DEBUG
2317 # define n_string_cp(S) n_string_cp(S, __FILE__, __LINE__)
2321 n_INLINE
struct n_string
*
2322 (n_string_creat
)(struct n_string
*self
){
2323 return n_string_creat(self
);
2325 # undef n_string_creat
2327 n_INLINE
struct n_string
*
2328 (n_string_creat_auto
)(struct n_string
*self
){
2329 return n_string_creat_auto(self
);
2331 # undef n_string_creat_auto
2334 (n_string_gut
)(struct n_string
*self
){
2337 # undef n_string_gut
2339 n_INLINE
struct n_string
*
2340 (n_string_trunc
)(struct n_string
*self
, size_t l
){
2341 return n_string_trunc(self
, l
);
2343 # undef n_string_trunc
2345 n_INLINE
struct n_string
*
2346 (n_string_drop_ownership
)(struct n_string
*self
){
2347 return n_string_drop_ownership(self
);
2349 # undef n_string_drop_ownership
2350 #endif /* HAVE_INLINE */
2352 /* UTF-8 / UTF-32 stuff */
2354 /* ..and update arguments to point after range; returns UI32_MAX on error, in
2355 * which case the arguments will have been stepped one byte */
2356 FL ui32_t
n_utf8_to_utf32(char const **bdat
, size_t *blen
);
2358 /* buf must be large enough also for NUL, it's new length will be returned */
2359 FL
size_t n_utf32_to_utf8(ui32_t c
, char *buf
);
2361 /* Our iconv(3) wrappers */
2364 FL iconv_t
n_iconv_open(char const *tocode
, char const *fromcode
);
2365 /* If *cd* == *iconvd*, assigns -1 to the latter */
2366 FL
void n_iconv_close(iconv_t cd
);
2368 /* Reset encoding state */
2369 FL
void n_iconv_reset(iconv_t cd
);
2371 /* iconv(3), but return n_err_no or 0 upon success.
2372 * The err_no may be ERR_NOENT unless n_ICONV_IGN_NOREVERSE is set in icf.
2373 * iconv_str() auto-grows on ERR_2BIG errors; in and in_rest_or_null may be
2375 * Note: ERR_INVAL (incomplete sequence at end of input) is NOT handled, so the
2376 * replacement character must be added manually if that happens at EOF! */
2377 FL
int n_iconv_buf(iconv_t cd
, enum n_iconv_flags icf
,
2378 char const **inb
, size_t *inbleft
,
2379 char **outb
, size_t *outbleft
);
2380 FL
int n_iconv_str(iconv_t icp
, enum n_iconv_flags icf
,
2381 struct str
*out
, struct str
const *in
,
2382 struct str
*in_rest_or_null
);
2384 /* If tocode==NULL, uses *ttycharset*. If fromcode==NULL, uses UTF-8.
2385 * Returns a salloc()ed buffer or NULL */
2386 FL
char * n_iconv_onetime_cp(enum n_iconv_flags icf
,
2387 char const *tocode
, char const *fromcode
, char const *input
);
2392 * This is a little bit hairy since it provides some stuff even if HAVE_TERMCAP
2393 * is false due to encapsulation desire
2397 /* termcap(3) / xy lifetime handling -- only called if we're n_PSO_INTERACTIVE
2398 * but not doing something in n_PO_QUICKRUN_MASK */
2399 FL
void n_termcap_init(void);
2400 FL
void n_termcap_destroy(void);
2402 /* enter_ca_mode / enable keypad (both if possible).
2403 * TODO When complete is not set we won't enter_ca_mode, for example: we don't
2404 * TODO want a complete screen clearance after $PAGER returned after displaying
2405 * TODO a mail, because otherwise the screen would look differently for normal
2406 * TODO stdout display messages. Etc. */
2407 # ifdef HAVE_TERMCAP
2408 FL
void n_termcap_resume(bool_t complete
);
2409 FL
void n_termcap_suspend(bool_t complete
);
2411 # define n_TERMCAP_RESUME(CPL) do{ n_termcap_resume(CPL); }while(0)
2412 # define n_TERMCAP_SUSPEND(CPL) do{ n_termcap_suspend(CPL); }while(0)
2415 /* Command multiplexer, returns FAL0 on I/O error, TRU1 on success and TRUM1
2416 * for commands which are not available and have no builtin fallback.
2417 * For query options the return represents a true value and -1 error.
2418 * Will return FAL0 directly unless we've been initialized.
2419 * By convention unused argument slots are given as -1 */
2420 FL ssize_t
n_termcap_cmd(enum n_termcap_cmd cmd
, ssize_t a1
, ssize_t a2
);
2421 # define n_termcap_cmdx(CMD) n_termcap_cmd(CMD, -1, -1)
2423 /* Query multiplexer. If query is n__TERMCAP_QUERY_MAX1 then
2424 * tvp->tv_data.tvd_string must contain the name of the query to look up; this
2425 * is used to lookup just about *any* (string) capability.
2426 * Returns TRU1 on success and TRUM1 for queries for which a builtin default
2427 * is returned; FAL0 is returned on non-availability */
2428 FL bool_t
n_termcap_query(enum n_termcap_query query
,
2429 struct n_termcap_value
*tvp
);
2431 /* Get a n_termcap_query for name or -1 if it is not known, and -2 if
2432 * type wasn't _NONE and the type doesn't match. */
2433 # ifdef HAVE_KEY_BINDINGS
2434 FL si32_t
n_termcap_query_for_name(char const *name
,
2435 enum n_termcap_captype type
);
2436 FL
char const *n_termcap_name_of_query(enum n_termcap_query query
);
2438 #endif /* n_HAVE_TCAP */
2440 #ifndef n_TERMCAP_RESUME
2441 # define n_TERMCAP_RESUME(CPL) do{;}while(0)
2442 # define n_TERMCAP_SUSPEND(CPL) do{;}while(0);
2450 FL
int c_thread(void *vp
);
2453 FL
int c_unthread(void *vp
);
2456 FL
struct message
* next_in_thread(struct message
*mp
);
2457 FL
struct message
* prev_in_thread(struct message
*mp
);
2458 FL
struct message
* this_in_thread(struct message
*mp
, long n
);
2460 /* Sorted mode is internally just a variant of threaded mode with all m_parent
2461 * and m_child links being NULL */
2462 FL
int c_sort(void *vp
);
2465 FL
int c_collapse(void *v
);
2466 FL
int c_uncollapse(void *v
);
2469 FL
void uncollapse1(struct message
*mp
, int always
);
2475 /* Return whether user says yes, on STDIN if interactive.
2476 * Uses noninteract_default, the return value for non-interactive use cases,
2477 * as a hint for boolify() and chooses the yes/no string to append to prompt
2478 * accordingly. If prompt is NULL "Continue" is used instead.
2479 * Handles+reraises SIGINT */
2480 FL bool_t
getapproval(char const *prompt
, bool_t noninteract_default
);
2483 /* Get a password the expected way, return termios_state.ts_linebuf on
2484 * success or NULL on error */
2485 FL
char *getuser(char const *query
);
2487 /* Get a password the expected way, return termios_state.ts_linebuf on
2488 * success or NULL on error. SIGINT is temporarily blocked, *not* reraised.
2489 * termios_state_reset() (def.h) must be called anyway */
2490 FL
char *getpassword(char const *query
);
2493 /* Create the prompt and return its visual width in columns, which may be 0
2494 * if evaluation is disabled etc. The data is placed in store.
2495 * xprompt is inspected only if prompt is enabled and no *prompt* evaluation
2497 FL ui32_t
n_tty_create_prompt(struct n_string
*store
, char const *xprompt
,
2498 enum n_go_input_flags gif
);
2500 /* At least readline(3) (formerly supported) desires to handle SIGWINCH and
2501 * install its own handler */
2503 # define TTY_WANTS_SIGWINCH
2506 /* Overall interactive terminal life cycle for command line editor library */
2507 FL
void n_tty_init(void);
2508 FL
void n_tty_destroy(void);
2510 /* Rather for main.c / SIGWINCH interaction only */
2511 FL
void n_tty_signal(int sig
);
2513 /* Read a line after printing prompt (if set and non-empty).
2514 * If n>0 assumes that *linebuf has n bytes of default content.
2515 * histok_or_null like for n_go_input().
2516 * Only the _CTX_ bits in lif are used */
2517 FL
int n_tty_readline(enum n_go_input_flags gif
, char const *prompt
,
2518 char **linebuf
, size_t *linesize
, size_t n
, bool_t
*histok_or_null
2519 n_MEMORY_DEBUG_ARGS
);
2520 #ifdef HAVE_MEMORY_DEBUG
2521 # define n_tty_readline(A,B,C,D,E,F) \
2522 (n_tty_readline)(A,B,C,D,E,F,__FILE__,__LINE__)
2525 /* Add a line (most likely as returned by n_tty_readline()) to the history.
2526 * Whether an entry added for real depends on the isgabby / *history-gabby*
2527 * relation, and / or whether s is non-empty */
2528 FL
void n_tty_addhist(char const *s
, bool_t isgabby
);
2531 FL
int c_history(void *v
);
2534 /* `bind' and `unbind' */
2535 #ifdef HAVE_KEY_BINDINGS
2536 FL
int c_bind(void *v
);
2537 FL
int c_unbind(void *v
);
2544 /* Parse (onechar of) a given buffer, and generate infos along the way.
2545 * If _WOUT_CREATE is set in vif, .vic_woudat will be NUL terminated!
2546 * vicp must be zeroed before first use */
2547 FL bool_t
n_visual_info(struct n_visual_info_ctx
*vicp
,
2548 enum n_visual_info_flags vif
);
2550 /* Check (multibyte-safe) how many bytes of buf (which is blen byts) can be
2551 * safely placed in a buffer (field width) of maxlen bytes */
2552 FL
size_t field_detect_clip(size_t maxlen
, char const *buf
, size_t blen
);
2554 /* Place cp in a salloc()ed buffer, column-aligned; for header display only */
2555 FL
char * colalign(char const *cp
, int col
, int fill
,
2556 int *cols_decr_used_or_null
);
2558 /* Convert a string to a displayable one;
2559 * prstr() returns the result savestr()d, prout() writes it */
2560 FL
void makeprint(struct str
const *in
, struct str
*out
);
2561 FL
size_t delctrl(char *cp
, size_t len
);
2562 FL
char * prstr(char const *s
);
2563 FL
int prout(char const *s
, size_t sz
, FILE *fp
);
2565 /* Print out a Unicode character or a substitute for it, return 0 on error or
2566 * wcwidth() (or 1) on success */
2567 FL
size_t putuc(int u
, int c
, FILE *fp
);
2569 /* Check whether bidirectional info maybe needed for blen bytes of bdat */
2570 FL bool_t
bidi_info_needed(char const *bdat
, size_t blen
);
2572 /* Create bidirectional text encapsulation information; without HAVE_NATCH_CHAR
2573 * the strings are always empty */
2574 FL
void bidi_info_create(struct bidi_info
*bip
);
2580 /* URL en- and decoding according to (enough of) RFC 3986 (RFC 1738).
2581 * These return a newly salloc()ated result, or NULL on length excess */
2582 FL
char * urlxenc(char const *cp
, bool_t ispath n_MEMORY_DEBUG_ARGS
);
2583 FL
char * urlxdec(char const *cp n_MEMORY_DEBUG_ARGS
);
2584 #ifdef HAVE_MEMORY_DEBUG
2585 # define urlxenc(CP,P) urlxenc(CP, P, __FILE__, __LINE__)
2586 # define urlxdec(CP) urlxdec(CP, __FILE__, __LINE__)
2590 FL
int c_urlcodec(void *v
);
2592 FL
int c_urlencode(void *v
); /* TODO obsolete*/
2593 FL
int c_urldecode(void *v
); /* TODO obsolete */
2595 /* Parse a RFC 6058 'mailto' URI to a single to: (TODO yes, for now hacky).
2596 * Return NULL or something that can be converted to a struct name */
2597 FL
char * url_mailto_to_address(char const *mailtop
);
2599 /* Return port for proto (and set irv_or_null), or NULL if unknown.
2600 * For file:// this returns an empty string */
2601 FL
char const *n_servbyname(char const *proto
, ui16_t
*irv_or_null
);
2604 /* Parse data, which must meet the criteria of the protocol cproto, and fill
2605 * in the URL structure urlp (URL rather according to RFC 3986) */
2606 FL bool_t
url_parse(struct url
*urlp
, enum cproto cproto
,
2609 /* Zero ccp and lookup credentials for communicating with urlp.
2610 * Return whether credentials are available and valid (for chosen auth) */
2611 FL bool_t
ccred_lookup(struct ccred
*ccp
, struct url
*urlp
);
2612 FL bool_t
ccred_lookup_old(struct ccred
*ccp
, enum cproto cproto
,
2614 #endif /* HAVE_SOCKETS */
2618 FL
int c_netrc(void *v
);
2621 /* MD5 (RFC 1321) related facilities */
2623 # ifdef HAVE_XSSL_MD5
2624 # define md5_ctx MD5_CTX
2625 # define md5_init MD5_Init
2626 # define md5_update MD5_Update
2627 # define md5_final MD5_Final
2629 /* The function definitions are instantiated in main.c */
2630 # include "rfc1321.h"
2633 /* Store the MD5 checksum as a hexadecimal string in *hex*, *not* terminated,
2634 * using lowercase ASCII letters as defined in RFC 2195 */
2635 # define MD5TOHEX_SIZE 32
2636 FL
char * md5tohex(char hex
[MD5TOHEX_SIZE
], void const *vp
);
2638 /* CRAM-MD5 encode the *user* / *pass* / *b64* combo; NULL on overflow error */
2639 FL
char * cram_md5_string(struct str
const *user
, struct str
const *pass
,
2642 /* RFC 2104: HMAC: Keyed-Hashing for Message Authentication.
2643 * unsigned char *text: pointer to data stream
2644 * int text_len : length of data stream
2645 * unsigned char *key : pointer to authentication key
2646 * int key_len : length of authentication key
2647 * caddr_t digest : caller digest to be filled in */
2648 FL
void hmac_md5(unsigned char *text
, int text_len
, unsigned char *key
,
2649 int key_len
, void *digest
);
2650 #endif /* HAVE_MD5 */
2658 FL
enum okay
ssl_open(struct url
const *urlp
, struct sock
*sp
);
2661 FL
void ssl_gen_err(char const *fmt
, ...);
2664 FL
int c_verify(void *vp
);
2667 FL
FILE * smime_sign(FILE *ip
, char const *addr
);
2670 FL
FILE * smime_encrypt(FILE *ip
, char const *certfile
, char const *to
);
2672 FL
struct message
* smime_decrypt(struct message
*m
, char const *to
,
2673 char const *cc
, bool_t is_a_verify_call
);
2676 FL
enum okay
smime_certsave(struct message
*m
, int n
, FILE *op
);
2678 #endif /* HAVE_XSSL */
2680 #ifndef HAVE_AMALGAMATION