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 /* Don't use n_var_* unless you *really* have to! */
181 /* Constant option key look/(un)set/clear */
182 FL
char *n_var_oklook(enum okeys okey
);
183 #define ok_blook(C) (n_var_oklook(n_CONCAT(ok_b_, C)) != NULL)
184 #define ok_vlook(C) n_var_oklook(n_CONCAT(ok_v_, C))
186 FL bool_t
n_var_okset(enum okeys okey
, uintptr_t val
);
188 n_var_okset(n_CONCAT(ok_b_, C), (uintptr_t)TRU1)
189 #define ok_vset(C,V) \
190 n_var_okset(n_CONCAT(ok_v_, C), (uintptr_t)(V))
192 FL bool_t
n_var_okclear(enum okeys okey
);
193 #define ok_bclear(C) n_var_okclear(n_CONCAT(ok_b_, C))
194 #define ok_vclear(C) n_var_okclear(n_CONCAT(ok_v_, C))
196 /* Variable option key lookup/(un)set/clear.
197 * If try_getenv is true we'll getenv(3) _if_ vokey is not a known enum okey */
198 FL
char const *n_var_vlook(char const *vokey
, bool_t try_getenv
);
199 FL bool_t
n_var_vset(char const *vokey
, uintptr_t val
);
200 FL bool_t
n_var_vclear(char const *vokey
);
202 /* Special case to handle the typical [xy-USER@HOST,] xy-HOST and plain xy
203 * variable chains; oxm is a bitmix which tells which combinations to test */
205 FL
char *n_var_xoklook(enum okeys okey
, struct url
const *urlp
,
206 enum okey_xlook_mode oxm
);
207 # define xok_BLOOK(C,URL,M) (n_var_xoklook(C, URL, M) != NULL)
208 # define xok_VLOOK(C,URL,M) n_var_xoklook(C, URL, M)
209 # define xok_blook(C,URL,M) xok_BLOOK(n_CONCAT(ok_b_, C), URL, M)
210 # define xok_vlook(C,URL,M) xok_VLOOK(n_CONCAT(ok_v_, C), URL, M)
213 /* User variable access: `set' and `unset' */
214 FL
int c_set(void *v
);
215 FL
int c_unset(void *v
);
218 FL
int c_varshow(void *v
);
220 /* Ditto: `varedit' */
221 FL
int c_varedit(void *v
);
224 FL
int c_environ(void *v
);
228 * xxx Interface quite sick
231 /* Try to add an attachment for file, fexpand(_LOCAL|_NOPROTO)ed.
232 * Return the new aplist aphead.
233 * The newly created attachment may be stored in *newap, or NULL on error */
234 FL
struct attachment
*n_attachment_append(struct attachment
*aplist
,
235 char const *file
, enum n_attach_error
*aerr_or_null
,
236 struct attachment
**newap_or_null
);
238 /* Shell-token parse names, and append resulting file names to aplist, return
239 * (new) aplist head */
240 FL
struct attachment
*n_attachment_append_list(struct attachment
*aplist
,
243 /* Remove ap from aplist, and return the new aplist head */
244 FL
struct attachment
*n_attachment_remove(struct attachment
*aplist
,
245 struct attachment
*ap
);
247 /* Find by file-name. If any path component exists in name then an exact match
248 * of the creation-path is used directly; if instead the basename of that path
249 * matches all attachments are traversed to find an exact match first, the
250 * first of all basename matches is returned as a last resort;
251 * If no path component exists the filename= parameter is searched (and also
252 * returned) in preference over the basename, otherwise likewise.
253 * If name is in fact a message number the first match is taken.
254 * If stat_or_null is given: FAL0 on NULL return, TRU1 for exact/single match,
255 * TRUM1 for ambiguous matches */
256 FL
struct attachment
*n_attachment_find(struct attachment
*aplist
,
257 char const *name
, bool_t
*stat_or_null
);
259 /* Interactively edit the attachment list, return updated list */
260 FL
struct attachment
*n_attachment_list_edit(struct attachment
*aplist
,
261 enum n_lexinput_flags lif
);
263 /* Print all attachments to fp, return number of lines written, -1 on error */
264 FL ssize_t
n_attachment_list_print(struct attachment
const *aplist
, FILE *fp
);
270 /* Compute screen size */
271 FL
int screensize(void);
273 /* Get our $PAGER; if env_addon is not NULL it is checked whether we know about
274 * some environment variable that supports colour+ and set *env_addon to that,
275 * e.g., "LESS=FRSXi" */
276 FL
char const *n_pager_get(char const **env_addon
);
278 /* Use a pager or STDOUT to print *fp*; if *lines* is 0, they'll be counted */
279 FL
void page_or_print(FILE *fp
, size_t lines
);
281 /* Parse name and guess at the required protocol */
282 FL
enum protocol
which_protocol(char const *name
);
284 /* Hexadecimal itoa (NUL terminates) / atoi (-1 on error) */
285 FL
char * n_c_to_hex_base16(char store
[3], char c
);
286 FL si32_t
n_c_from_hex_base16(char const hex
[2]);
288 /* Hash the passed string -- uses Chris Torek's hash algorithm.
289 * i*() hashes case-insensitively (ASCII), and *n() uses maximally len bytes;
290 * if len is UIZ_MAX, we go .), since we anyway stop for NUL */
291 FL ui32_t
torek_hash(char const *name
);
292 FL ui32_t
torek_ihashn(char const *dat
, size_t len
);
294 /* Find a prime greater than n */
295 FL ui32_t
nextprime(ui32_t n
);
297 /* Return the name of the dead.letter file */
298 FL
char const * n_getdeadletter(void);
300 /* Detect and query the hostname to use */
301 FL
char * nodename(int mayoverride
);
303 /* Get a (pseudo) random string of *length* bytes; returns salloc()ed buffer */
304 FL
char * getrandstring(size_t length
);
306 /* Check whether the argument string is a true (1) or false (0) boolean, or an
307 * invalid string, in which case -1 is returned; if emptyrv is not -1 then it,
308 * treated as a boolean, is used as the return value shall inbuf be empty.
309 * inlen may be UIZ_MAX to force strlen() detection */
310 FL si8_t
boolify(char const *inbuf
, uiz_t inlen
, si8_t emptyrv
);
312 /* Dig a "quadoption" in inbuf (possibly going through getapproval() in
313 * interactive mode). Returns a boolean or -1 if inbuf content is invalid;
314 * if emptyrv is not -1 then it, treated as a boolean, is used as the return
315 * value shall inbuf be empty. If prompt is set it is printed first if intera.
316 * inlen may be UIZ_MAX to force strlen() detection */
317 FL si8_t
quadify(char const *inbuf
, uiz_t inlen
, char const *prompt
,
320 /* Is the argument "all" (case-insensitive) or "*" */
321 FL bool_t
n_is_all_or_aster(char const *name
);
323 /* Get seconds since epoch */
324 FL
time_t n_time_epoch(void);
326 /* Update *tc* to now; only .tc_time updated unless *full_update* is true */
327 FL
void time_current_update(struct time_current
*tc
,
330 /* Returns 0 if fully slept, number of millis left if ignint is true and we
331 * were interrupted. Actual resolution may be second or less.
332 * Note in case of HAVE_SLEEP this may be SIGALARM based. */
333 FL uiz_t
n_msleep(uiz_t millis
, bool_t ignint
);
335 /* Our error print series.. Note: these reverse scan format in order to know
336 * whether a newline was included or not -- this affects the output! */
337 FL
void n_err(char const *format
, ...);
338 FL
void n_verr(char const *format
, va_list ap
);
340 /* ..(for use in a signal handler; to be obsoleted..).. */
341 FL
void n_err_sighdl(char const *format
, ...);
343 /* Our perror(3); if errval is 0 errno(3) is used; newline appended */
344 FL
void n_perr(char const *msg
, int errval
);
346 /* Announce a fatal error (and die); newline appended */
347 FL
void n_alert(char const *format
, ...);
348 FL
void n_panic(char const *format
, ...);
352 FL
int c_errors(void *vp
);
354 # define c_errors c_cmdnotsupp
359 FL
char const *n_regex_err_to_str(const regex_t
*rep
, int e
);
366 /* Scan out the list of string arguments according to rm, return -1 on error;
367 * res_dat is NULL terminated unless res_size is 0 or error occurred */
368 FL
int getrawlist(bool_t wysh
, char **res_dat
, size_t res_size
,
369 char const *line
, size_t linesize
);
371 /* Scan an entire command argument line, return whether result can be used,
372 * otherwise no resources are allocated (in ->cac_arg).
373 * For _WYSH arguments the flags _TRIMSPACE and _LOG are implicit */
374 FL bool_t
n_cmd_arg_parse(struct n_cmd_arg_ctx
*cacp
);
376 /* Join all the _GREEDY arguments that were seen into a single string.
377 * Asserted they are string-based. The data (if any) is appended to store */
378 FL
struct n_string
*n_cmd_arg_join_greedy(struct n_cmd_arg_ctx
const *cacp
,
379 struct n_string
*store
);
385 /* if.elif.else.endif conditional execution.
386 * condstack_isskip() returns whether the current condition state doesn't allow
387 * execution of commands.
388 * condstack_release() and condstack_take() rotate the current condition stack;
389 * condstack_take() returns a false boolean if the current condition stack has
390 * unclosed conditionals */
391 FL
int c_if(void *v
);
392 FL
int c_elif(void *v
);
393 FL
int c_else(void *v
);
394 FL
int c_endif(void *v
);
395 FL bool_t
condstack_isskip(void);
396 FL
void *condstack_release(void);
397 FL bool_t
condstack_take(void *self
);
403 /* `file' (`folder') and `File' (`Folder') */
404 FL
int c_file(void *v
);
405 FL
int c_File(void *v
);
407 /* 'newmail' command: Check for new mail without writing old mail back */
408 FL
int c_newmail(void *v
);
411 FL
int c_noop(void *v
);
414 FL
int c_remove(void *v
);
417 FL
int c_rename(void *v
);
419 /* List the folders the user currently has */
420 FL
int c_folders(void *v
);
426 /* `headers' (show header group, possibly after setting dot) */
427 FL
int c_headers(void *v
);
429 /* Like c_headers(), but pre-prepared message vector */
430 FL
int print_header_group(int *vector
);
432 /* Scroll to the next/previous screen */
433 FL
int c_scroll(void *v
);
434 FL
int c_Scroll(void *v
);
436 /* Move the dot up or down by one message */
437 FL
int c_dotmove(void *v
);
439 /* Print out the headlines for each message in the passed message list */
440 FL
int c_from(void *v
);
442 /* Print all message in between and including bottom and topx if they are
443 * visible and either only_marked is false or they are MMARKed */
444 FL
void print_headers(size_t bottom
, size_t topx
, bool_t only_marked
);
450 /* Paginate messages, honour/don't honour ignored fields, respectively */
451 FL
int c_more(void *v
);
452 FL
int c_More(void *v
);
454 /* Type out messages, honour/don't honour ignored fields, respectively */
455 FL
int c_type(void *v
);
456 FL
int c_Type(void *v
);
458 /* Show raw message content */
459 FL
int c_show(void *v
);
461 /* Pipe messages, honour/don't honour ignored fields, respectively */
462 FL
int c_pipe(void *v
);
463 FL
int c_Pipe(void *v
);
465 /* Print the first *toplines* of each desired message */
466 FL
int c_top(void *v
);
467 FL
int c_Top(void *v
);
469 /* If any arguments were given, go to the next applicable argument following
470 * dot, otherwise, go to the next applicable message. If given as first
471 * command with no arguments, print first message */
472 FL
int c_next(void *v
);
474 /* Print out the value of dot */
475 FL
int c_pdot(void *v
);
477 /* Print the size of each message */
478 FL
int c_messize(void *v
);
480 /* Delete messages */
481 FL
int c_delete(void *v
);
483 /* Delete messages, then type the new dot */
484 FL
int c_deltype(void *v
);
486 /* Undelete the indicated messages */
487 FL
int c_undelete(void *v
);
489 /* Touch all the given messages so that they will get mboxed */
490 FL
int c_stouch(void *v
);
492 /* Make sure all passed messages get mboxed */
493 FL
int c_mboxit(void *v
);
495 /* Preserve messages, so that they will be sent back to the system mailbox */
496 FL
int c_preserve(void *v
);
498 /* Mark all given messages as unread */
499 FL
int c_unread(void *v
);
501 /* Mark all given messages as read */
502 FL
int c_seen(void *v
);
504 /* Message flag manipulation */
505 FL
int c_flag(void *v
);
506 FL
int c_unflag(void *v
);
507 FL
int c_answered(void *v
);
508 FL
int c_unanswered(void *v
);
509 FL
int c_draft(void *v
);
510 FL
int c_undraft(void *v
);
516 /* Process a shell escape by saving signals, ignoring signals and a sh -c */
517 FL
int c_shell(void *v
);
519 /* Fork an interactive shell */
520 FL
int c_dosh(void *v
);
522 /* Print user's working directory */
523 FL
int c_cwd(void *v
);
525 /* Change user's working directory */
526 FL
int c_chdir(void *v
);
528 /* Expand file names like echo (to stdout/stderr) */
529 FL
int c_echo(void *v
);
530 FL
int c_echoerr(void *v
);
536 /* All thinkable sorts of `reply' / `respond' and `followup'.. */
537 FL
int c_reply(void *v
);
538 FL
int c_replyall(void *v
);
539 FL
int c_replysender(void *v
);
540 FL
int c_Reply(void *v
);
541 FL
int c_followup(void *v
);
542 FL
int c_followupall(void *v
);
543 FL
int c_followupsender(void *v
);
544 FL
int c_Followup(void *v
);
546 /* ..and a mailing-list reply */
547 FL
int c_Lreply(void *v
);
549 /* The 'forward' command */
550 FL
int c_forward(void *v
);
552 /* Similar to forward, saving the message in a file named after the first
554 FL
int c_Forward(void *v
);
556 /* Resend a message list to a third person */
557 FL
int c_resend(void *v
);
559 /* Resend a message list to a third person without adding headers */
560 FL
int c_Resend(void *v
);
566 /* Save a message in a file. Mark the message as saved so we can discard when
568 FL
int c_save(void *v
);
569 FL
int c_Save(void *v
);
571 /* Copy a message to a file without affected its saved-ness */
572 FL
int c_copy(void *v
);
573 FL
int c_Copy(void *v
);
575 /* Move a message to a file */
576 FL
int c_move(void *v
);
577 FL
int c_Move(void *v
);
579 /* Decrypt and copy a message to a file */
580 FL
int c_decrypt(void *v
);
581 FL
int c_Decrypt(void *v
);
583 /* Write the indicated messages at the end of the passed file name, minus
584 * header and trailing blank line. This is the MIME save function */
585 FL
int c_write(void *v
);
592 * If quotefile is (char*)-1, stdin will be used, caller has to verify that
593 * we're not running in interactive mode */
594 FL
FILE * collect(struct header
*hp
, int printheaders
, struct message
*mp
,
595 char const *quotefile
, int doprefix
, si8_t
*checkaddr_err
);
603 FL
int c_colour(void *v
);
604 FL
int c_uncolour(void *v
);
606 /* We want coloured output (in this salloc() cycle). pager_used is used to
607 * test whether *colour-pager* is to be inspected.
608 * The push/pop functions deal with recursive execute()ions, for now. TODO
609 * env_gut() will reset() as necessary */
610 FL
void n_colour_env_create(enum n_colour_ctx cctx
, bool_t pager_used
);
611 FL
void n_colour_env_push(void);
612 FL
void n_colour_env_pop(bool_t any_env_till_root
);
613 FL
void n_colour_env_gut(FILE *fp
);
615 /* Putting anything (for pens: including NULL) resets current state first */
616 FL
void n_colour_put(FILE *fp
, enum n_colour_id cid
, char const *ctag
);
617 FL
void n_colour_reset(FILE *fp
);
619 /* Of course temporary only and may return NULL. Doesn't affect state! */
620 FL
struct str
const *n_colour_reset_to_str(void);
622 /* A pen is bound to its environment and automatically reclaimed; it may be
623 * NULL but that can be used anyway for simplicity.
624 * This includes pen_to_str() -- which doesn't affect state! */
625 FL
struct n_colour_pen
*n_colour_pen_create(enum n_colour_id cid
,
627 FL
void n_colour_pen_put(struct n_colour_pen
*self
, FILE *fp
);
629 FL
struct str
const *n_colour_pen_to_str(struct n_colour_pen
*self
);
631 #else /* HAVE_COLOUR */
632 # define c_colour c_cmdnotsupp
633 # define c_uncolour c_cmdnotsupp
634 # define c_mono c_cmdnotsupp
635 # define c_unmono c_cmdnotsupp
642 /* Aquire a flt lock and create a dotlock file; upon success a registered
643 * control-pipe FILE* is returned that keeps the link in between us and the
644 * lock-holding fork(2)ed subprocess (which conditionally replaced itself via
645 * execv(2) with the privilege-separated dotlock helper program): the lock file
646 * will be removed once the control pipe is closed via Pclose().
647 * Will try FILE_LOCK_TRIES times if pollmsecs > 0 (once otherwise).
648 * If pollmsecs is UIZ_MAX, FILE_LOCK_MILLIS is used.
649 * If *dotlock_ignore_error* is set (FILE*)-1 will be returned if at least the
650 * normal file lock could be established, otherwise errno is usable on error */
651 FL
FILE * n_dotlock(char const *fname
, int fd
, enum n_file_lock_type flt
,
652 off_t off
, off_t len
, size_t pollmsecs
);
658 /* Edit a message list */
659 FL
int c_editor(void *v
);
661 /* Invoke the visual editor on a message list */
662 FL
int c_visual(void *v
);
664 /* Run an editor on either size bytes of the file fp (or until EOF if size is
665 * negative) or on the message mp, and return a new file or NULL on error of if
666 * the user didn't perform any edits.
667 * For now we assert that mp==NULL if hp!=NULL, treating this as a special call
668 * from within compose mode, and giving TRUM1 to puthead().
669 * Signals must be handled by the caller. viored is 'e' for ed, 'v' for vi */
670 FL
FILE * run_editor(FILE *fp
, off_t size
, int viored
, int readonly
,
671 struct header
*hp
, struct message
*mp
,
672 enum sendaction action
, sighandler_type oldint
);
679 FL
struct quoteflt
* quoteflt_dummy(void); /* TODO LEGACY */
680 FL
void quoteflt_init(struct quoteflt
*self
, char const *prefix
);
681 FL
void quoteflt_destroy(struct quoteflt
*self
);
682 FL
void quoteflt_reset(struct quoteflt
*self
, FILE *f
);
683 FL ssize_t
quoteflt_push(struct quoteflt
*self
, char const *dat
,
685 FL ssize_t
quoteflt_flush(struct quoteflt
*self
);
687 /* (Primitive) HTML tagsoup filter */
688 #ifdef HAVE_FILTER_HTML_TAGSOUP
689 /* TODO Because we don't support filter chains yet this filter will be run
690 * TODO in a dedicated subprocess, driven via a special Popen() mode */
691 FL
int htmlflt_process_main(void);
693 FL
void htmlflt_init(struct htmlflt
*self
);
694 FL
void htmlflt_destroy(struct htmlflt
*self
);
695 FL
void htmlflt_reset(struct htmlflt
*self
, FILE *f
);
696 FL ssize_t
htmlflt_push(struct htmlflt
*self
, char const *dat
, size_t len
);
697 FL ssize_t
htmlflt_flush(struct htmlflt
*self
);
704 /* fgets() replacement to handle lines of arbitrary size and with embedded \0
706 * line - line buffer. *line may be NULL.
707 * linesize - allocated size of line buffer.
708 * count - maximum characters to read. May be NULL.
709 * llen - length_of_line(*line).
711 * appendnl - always terminate line with \n, append if necessary.
712 * Manages the n_PS_READLINE_NL hack */
713 FL
char * fgetline(char **line
, size_t *linesize
, size_t *count
,
714 size_t *llen
, FILE *fp
, int appendnl n_MEMORY_DEBUG_ARGS
);
715 #ifdef HAVE_MEMORY_DEBUG
716 # define fgetline(A,B,C,D,E,F) \
717 fgetline(A, B, C, D, E, F, __FILE__, __LINE__)
720 /* Read up a line from the specified input into the linebuffer.
721 * Return the number of characters read. Do not include the newline at EOL.
722 * n is the number of characters already read and present in *linebuf; it'll be
723 * treated as _the_ line if no more (successful) reads are possible.
724 * Manages the n_PS_READLINE_NL hack */
725 FL
int readline_restart(FILE *ibuf
, char **linebuf
, size_t *linesize
,
726 size_t n n_MEMORY_DEBUG_ARGS
);
727 #ifdef HAVE_MEMORY_DEBUG
728 # define readline_restart(A,B,C,D) \
729 readline_restart(A, B, C, D, __FILE__, __LINE__)
732 /* Set up the input pointers while copying the mail file into /tmp */
733 FL
void setptr(FILE *ibuf
, off_t offset
);
735 /* Determine the size of the file possessed by the passed buffer */
736 FL off_t
fsize(FILE *iob
);
738 /* Will retry FILE_LOCK_RETRIES times if pollmsecs > 0.
739 * If pollmsecs is UIZ_MAX, FILE_LOCK_MILLIS is used */
740 FL bool_t
n_file_lock(int fd
, enum n_file_lock_type flt
,
741 off_t off
, off_t len
, size_t pollmsecs
);
747 /* Set up editing on the given file name.
748 * If the first character of name is %, we are considered to be editing the
749 * file, otherwise we are reading our mail which has signficance for mbox and
751 FL
int setfile(char const *name
, enum fedit_mode fm
);
753 FL
int newmailinfo(int omsgCount
);
755 /* Set the size of the message vector used to construct argument lists to
756 * message list functions */
757 FL
void setmsize(int sz
);
759 /* Logic behind -H / -L invocations */
760 FL
void print_header_summary(char const *Larg
);
762 /* Announce the presence of the current Mail version, give the message count,
763 * and print a header listing */
764 FL
void announce(int printheaders
);
766 /* Announce information about the file we are editing. Return a likely place
768 FL
int newfileinfo(void);
770 FL
int getmdot(int nmail
);
772 FL
void initbox(char const *name
);
774 /* Determine and expand the current *folder* name, return it (with trailing
775 * solidus) or the empty string also in case of errors: since POSIX mandates
776 * a default of CWD if not set etc., that seems to be a valid fallback, then */
777 FL
char const *folder_query(void);
783 /* Return the user's From: address(es) */
784 FL
char const * myaddrs(struct header
*hp
);
786 /* Boil the user's From: addresses down to a single one, or use *sender* */
787 FL
char const * myorigin(struct header
*hp
);
789 /* See if the passed line buffer, which may include trailing newline (sequence)
790 * is a mail From_ header line according to POSIX ("From ").
791 * If check_rfc4155 is true we'll return TRUM1 instead if the From_ line
792 * matches POSIX but is _not_ compatible to RFC 4155 */
793 FL bool_t
is_head(char const *linebuf
, size_t linelen
,
794 bool_t check_rfc4155
);
796 /* Savage extract date field from From_ line. linelen is convenience as line
797 * must be terminated (but it may end in a newline [sequence]).
798 * Return whether the From_ line was parsed successfully (-1 if the From_ line
799 * wasn't really RFC 4155 compliant) */
800 FL
int extract_date_from_from_(char const *line
, size_t linelen
,
801 char datebuf
[FROM_DATEBUF
]);
803 /* Extract some header fields (see e.g. -t documentation) from a message.
804 * If n_poption&n_PO_t_FLAG *and* n_psonce&n_PSO_t_FLAG are both set a number
805 * of additional header fields are understood and address joining is performed
806 * as necessary, and the subject is treated with additional care, too.
807 * If n_psonce&n_PSO_t_FLAG is set but n_PO_t_FLAG is no more, From: will not
808 * be assigned no more.
809 * This calls expandaddr() on some headers and sets checkaddr_err if that is
810 * not NULL -- note it explicitly allows EAF_NAME because aliases are not
811 * expanded when this is called! */
812 FL
void extract_header(FILE *fp
, struct header
*hp
,
813 si8_t
*checkaddr_err
);
815 /* Return the desired header line from the passed message
816 * pointer (or NULL if the desired header field is not available).
817 * If mult is zero, return the content of the first matching header
818 * field only, the content of all matching header fields else */
819 FL
char * hfield_mult(char const *field
, struct message
*mp
, int mult
);
820 #define hfieldX(a, b) hfield_mult(a, b, 1)
821 #define hfield1(a, b) hfield_mult(a, b, 0)
823 /* Check whether the passed line is a header line of the desired breed.
824 * Return the field body, or 0 */
825 FL
char const * thisfield(char const *linebuf
, char const *field
);
827 /* Get sender's name from this message. If the message has a bunch of arpanet
828 * stuff in it, we may have to skin the name before returning it */
829 FL
char * nameof(struct message
*mp
, int reptype
);
831 /* Start of a "comment". Ignore it */
832 FL
char const * skip_comment(char const *cp
);
834 /* Return the start of a route-addr (address in angle brackets), if present */
835 FL
char const * routeaddr(char const *name
);
837 /* Query *expandaddr*, parse it and return flags.
838 * The flags are already adjusted for n_PSO_INTERACTIVE, n_PO_TILDE_FLAG etc. */
839 FL
enum expand_addr_flags
expandaddr_to_eaf(void);
841 /* Check if an address is invalid, either because it is malformed or, if not,
842 * according to eacm. Return FAL0 when it looks good, TRU1 if it is invalid
843 * but the error condition wasn't covered by a 'hard "fail"ure', -1 otherwise */
844 FL si8_t
is_addr_invalid(struct name
*np
,
845 enum expand_addr_check_mode eacm
);
847 /* Does *NP* point to a file or pipe addressee? */
848 #define is_fileorpipe_addr(NP) \
849 (((NP)->n_flags & NAME_ADDRSPEC_ISFILEORPIPE) != 0)
851 /* Return skinned version of *NP*s name */
852 #define skinned_name(NP) \
853 (assert((NP)->n_flags & NAME_SKINNED), \
854 ((struct name const*)NP)->n_name)
856 /* Skin an address according to the RFC 822 interpretation of "host-phrase" */
857 FL
char * skin(char const *name
);
859 /* Skin *name* and extract the *addr-spec* according to RFC 5322.
860 * Store the result in .ag_skinned and also fill in those .ag_ fields that have
861 * actually been seen.
862 * Return NULL on error, or name again, but which may have been replaced by
863 * a version with fixed quotation etc.! */
864 FL
char const *n_addrspec_with_guts(struct n_addrguts
*agp
, char const *name
,
867 /* Fetch the real name from an internet mail address field */
868 FL
char * realname(char const *name
);
870 /* Fetch the sender's name from the passed message. reptype can be
871 * 0 -- get sender's name for display purposes
872 * 1 -- get sender's name for reply
873 * 2 -- get sender's name for Reply */
874 FL
char * name1(struct message
*mp
, int reptype
);
876 /* Trim away all leading Re: etc., return pointer to plain subject.
877 * Note it doesn't perform any MIME decoding by itself */
878 FL
char * subject_re_trim(char *cp
);
880 FL
int msgidcmp(char const *s1
, char const *s2
);
882 /* Fake Sender for From_ lines if missing, e. g. with POP3 */
883 FL
char const * fakefrom(struct message
*mp
);
885 FL
char const * fakedate(time_t t
);
887 /* From username Fri Jan 2 20:13:51 2004
890 #ifdef HAVE_IMAP_SEARCH
891 FL
time_t unixtime(char const *from
);
894 FL
time_t rfctime(char const *date
);
896 FL
time_t combinetime(int year
, int month
, int day
,
897 int hour
, int minute
, int second
);
899 FL
void substdate(struct message
*m
);
901 /* TODO Weird thing that tries to fill in From: and Sender: */
902 FL
void setup_from_and_sender(struct header
*hp
);
904 /* Note: returns 0x1 if both args were NULL */
905 FL
struct name
const * check_from_and_sender(struct name
const *fromfield
,
906 struct name
const *senderfield
);
909 FL
char * getsender(struct message
*m
);
912 /* Fill in / reedit the desired header fields */
913 FL
int grab_headers(enum n_lexinput_flags lif
, struct header
*hp
,
914 enum gfield gflags
, int subjfirst
);
916 /* Check whether sep->ss_sexpr (or ->ss_regex) matches any header of mp */
917 FL bool_t
header_match(struct message
*mp
, struct search_expr
const *sep
);
919 /* Query *customhdr* */
920 FL
struct n_header_field
*n_customhdr_query(void);
927 FL
int c_headerpick(void *v
);
929 /* TODO Compat variants of the c_(un)?h*() series,
930 * except for `retain' and `ignore', which are standardized */
931 FL
int c_retain(void *v
);
932 FL
int c_ignore(void *v
);
933 FL
int c_unretain(void *v
);
934 FL
int c_unignore(void *v
);
936 FL
int c_saveretain(void *v
);
937 FL
int c_saveignore(void *v
);
938 FL
int c_unsaveretain(void *v
);
939 FL
int c_unsaveignore(void *v
);
941 FL
int c_fwdretain(void *v
);
942 FL
int c_fwdignore(void *v
);
943 FL
int c_unfwdretain(void *v
);
944 FL
int c_unfwdignore(void *v
);
946 /* Ignore object lifecycle. (Most of the time this interface deals with
947 * special n_IGNORE_* objects, e.g., n_IGNORE_TYPE, though.)
948 * isauto: whether auto-reclaimed storage is to be used for allocations;
949 * if so, _del() needn't be called */
950 FL
struct n_ignore
*n_ignore_new(bool_t isauto
);
951 FL
void n_ignore_del(struct n_ignore
*self
);
953 /* Are there just _any_ user settings covered by self? */
954 FL bool_t
n_ignore_is_any(struct n_ignore
const *self
);
956 /* Set an entry to retain (or ignore).
957 * Returns FAL0 if dat is not a valid header field name or an invalid regular
958 * expression, TRU1 if insertion took place, and TRUM1 if already set */
959 FL bool_t
n_ignore_insert(struct n_ignore
*self
, bool_t retain
,
960 char const *dat
, size_t len
);
961 #define n_ignore_insert_cp(SELF,RT,CP) n_ignore_insert(SELF, RT, CP, UIZ_MAX)
963 /* Returns TRU1 if retained, TRUM1 if ignored, FAL0 if not covered */
964 FL bool_t
n_ignore_lookup(struct n_ignore
const *self
,
965 char const *dat
, size_t len
);
966 #define n_ignore_lookup_cp(SELF,CP) n_ignore_lookup(SELF, CP, UIZ_MAX)
967 #define n_ignore_is_ign(SELF,FDAT,FLEN) \
968 (n_ignore_lookup(SELF, FDAT, FLEN) == TRUM1)
974 /* Return -1 on invalid spec etc., the number of matches otherwise */
975 #ifdef HAVE_IMAP_SEARCH
976 FL ssize_t
imap_search(char const *spec
, int f
);
983 /* Fallback implementation for commands which are unavailable in this config */
984 FL
int c_cmdnotsupp(void *v
);
986 /* Interpret user commands. If stdin is not a tty, print no prompt; return
987 * whether last processed command returned error; this is *only* for main()! */
988 FL bool_t
n_commands(void);
990 /* Actual cmd input */
992 /* Read a complete line of input, with editing if interactive and possible.
993 * If string is set it is used as the initial line content if in interactive
994 * mode, otherwise this argument is ignored for reproducibility.
995 * Return number of octets or a value <0 on error.
996 * Note: may use the currently `source'd file stream instead of stdin!
997 * Manages the n_PS_READLINE_NL hack */
998 FL
int n_lex_input(enum n_lexinput_flags lif
, char const *prompt
,
999 char **linebuf
, size_t *linesize
, char const *string
1000 n_MEMORY_DEBUG_ARGS
);
1001 #ifdef HAVE_MEMORY_DEBUG
1002 # define n_lex_input(A,B,C,D,E) n_lex_input(A,B,C,D,E,__FILE__,__LINE__)
1005 /* Read a line of input, with editing if interactive and possible, return it
1006 * savestr()d or NULL in case of errors or if an empty line would be returned.
1007 * This may only be called from toplevel (not during n_PS_ROBOT).
1008 * If string is set it is used as the initial line content if in interactive
1009 * mode, otherwise this argument is ignored for reproducibility */
1010 FL
char *n_lex_input_cp(enum n_lexinput_flags lif
, char const *prompt
,
1011 char const *string
);
1014 FL
int c_read(void *v
);
1016 /* Deal with loading of resource files and dealing with a stack of files for
1017 * the source command */
1019 /* Load a file of user definitions -- this is *only* for main()! */
1020 FL
void n_load(char const *name
);
1022 /* "Load" all the -X command line definitions in order -- *only* for main() */
1023 FL
void n_load_Xargs(char const **lines
, size_t cnt
);
1025 /* Pushdown current input file and switch to a new one. Set the global flag
1026 * n_PS_SOURCING so that others will realize that they are no longer reading
1027 * from a tty (in all probability) */
1028 FL
int c_source(void *v
);
1029 FL
int c_source_if(void *v
);
1031 /* Evaluate a complete macro / a single command. For the former lines will
1032 * always be free()d, for the latter cmd will always be duplicated internally */
1033 FL bool_t
n_source_macro(enum n_lexinput_flags lif
, char const *name
,
1034 char **lines
, void (*on_finalize
)(void*), void *finalize_arg
);
1035 FL bool_t
n_source_command(enum n_lexinput_flags lif
, char const *cmd
);
1037 /* XXX See a_LEX_SLICE in source */
1038 FL
void n_source_slice_hack(char const *cmd
, FILE *new_stdin
, FILE *new_stdout
,
1039 ui32_t new_psonce
, void (*on_finalize
)(void*), void *finalize_arg
);
1040 FL
void n_source_slice_hack_remove_after_jump(void);
1042 /* XXX Hack: may we release our (interactive) (terminal) control to a different
1043 * XXX program, e.g., a $PAGER? */
1044 FL bool_t
n_source_may_yield_control(void);
1046 /* Force n_lex_input() to read EOF next */
1047 FL
void n_source_force_eof(void);
1053 /* Return a file buffer all ready to read up the passed message pointer */
1054 FL
FILE * setinput(struct mailbox
*mp
, struct message
*m
,
1055 enum needspec need
);
1058 FL
enum okay
get_body(struct message
*mp
);
1060 /* Reset (free) the global message array */
1061 FL
void message_reset(void);
1063 /* Append the passed message descriptor onto the message array; if mp is NULL,
1064 * NULLify the entry at &[msgCount-1] */
1065 FL
void message_append(struct message
*mp
);
1067 /* Append a NULL message */
1068 FL
void message_append_null(void);
1070 /* Check whether sep->ss_sexpr (or ->ss_regex) matches mp. If with_headers is
1071 * true then the headers will also be searched (as plain text) */
1072 FL bool_t
message_match(struct message
*mp
, struct search_expr
const *sep
,
1073 bool_t with_headers
);
1076 FL
struct message
* setdot(struct message
*mp
);
1078 /* Touch the named message by setting its MTOUCH flag. Touched messages have
1079 * the effect of not being sent back to the system mailbox on exit */
1080 FL
void touch(struct message
*mp
);
1082 /* Convert user string of message numbers and store the numbers into vector.
1083 * Returns the count of messages picked up or -1 on error */
1084 FL
int getmsglist(char *buf
, int *vector
, int flags
);
1086 /* Find the first message whose flags&m==f and return its message number */
1087 FL
int first(int f
, int m
);
1089 /* Mark the named message by setting its mark bit */
1090 FL
void mark(int mesg
, int f
);
1096 FL
int maildir_setfile(char const *name
, enum fedit_mode fm
);
1098 FL bool_t
maildir_quit(bool_t hold_sigs_on
);
1100 FL
enum okay
maildir_append(char const *name
, FILE *fp
, long offset
);
1102 FL
enum okay
maildir_remove(char const *name
);
1106 * Heap memory and automatically reclaimed storage, plus pseudo "alloca"
1109 /* Called from the (main)loops upon tick and break-off time to perform debug
1110 * checking and memory cleanup, including stack-top of auto-reclaimed storage */
1111 FL
void n_memory_reset(void);
1113 /* Generic heap memory */
1115 FL
void * n_alloc(size_t s n_MEMORY_DEBUG_ARGS
);
1116 FL
void * n_realloc(void *v
, size_t s n_MEMORY_DEBUG_ARGS
);
1117 FL
void * n_calloc(size_t nmemb
, size_t size n_MEMORY_DEBUG_ARGS
);
1118 FL
void n_free(void *vp n_MEMORY_DEBUG_ARGS
);
1120 /* TODO obsolete c{m,re,c}salloc -> n_* */
1121 #ifdef HAVE_MEMORY_DEBUG
1122 # define n_alloc(S) (n_alloc)(S, __FILE__, __LINE__)
1123 # define n_realloc(P,S) (n_realloc)(P, S, __FILE__, __LINE__)
1124 # define n_calloc(N,S) (n_calloc)(N, S, __FILE__, __LINE__)
1125 # define n_free(P) (n_free)(P, __FILE__, __LINE__)
1126 # define free(P) (n_free)(P, __FILE__, __LINE__)
1128 # define n_free(P) free(P)
1130 #define smalloc(SZ) n_alloc(SZ)
1131 #define srealloc(P,SZ) n_realloc(P, SZ)
1132 #define scalloc(N,SZ) n_calloc(N, SZ)
1134 /* Fluctuating heap memory (supposed to exist for one command loop tick) */
1136 #define n_flux_alloc(S) n_alloc(S)
1137 #define n_flux_realloc(P,S) n_realloc(P, S)
1138 #define n_flux_calloc(N,S) n_calloc(N, S)
1139 #define n_flux_free(P) n_free(P)
1141 /* Auto-reclaimed storage */
1143 /* Fixate the current snapshot of our global auto-reclaimed storage instance,
1144 * so that further allocations become auto-reclaimed.
1145 * This is only called from main.c for the global anon arena */
1146 FL
void n_memory_autorec_fixate(void);
1148 /* Lifetime management of a per-execution level arena. vp provides
1149 * n_MEMORY_AUTOREC_TYPE_SIZEOF bytes of storage to allocate that.
1150 * Note that anyone can anywhere _push() a storage level, and _pop() will drop
1151 * all possible levels "above" vp, too! */
1152 FL
void n_memory_autorec_push(void *vp
);
1153 FL
void n_memory_autorec_pop(void *vp
);
1154 FL
void * n_memory_autorec_current(void);
1156 /* Lower memory pressure on auto-reclaimed storage for code which has
1157 * a sinus-curve looking style of memory usage, i.e., peak followed by release,
1158 * like, e.g., doing a task on all messages of a box in order.
1159 * Such code should call srelax_hold(), successively call srelax() after
1160 * a single message has been handled, and finally srelax_rele() */
1161 FL
void srelax_hold(void);
1162 FL
void srelax_rele(void);
1163 FL
void srelax(void);
1165 /* Allocate size more bytes of space and return the address of the first byte
1166 * to the caller. An even number of bytes are always allocated so that the
1167 * space will always be on a word boundary */
1168 FL
void * n_autorec_alloc(void *vp
, size_t size n_MEMORY_DEBUG_ARGS
);
1169 FL
void * n_autorec_calloc(void *vp
, size_t nmemb
, size_t size
1170 n_MEMORY_DEBUG_ARGS
);
1171 #ifdef HAVE_MEMORY_DEBUG
1172 # define n_autorec_alloc(VP,SZ) (n_autorec_alloc)(VP, SZ, __FILE__, __LINE__)
1173 # define n_autorec_calloc(VP,NM,SZ) \
1174 (n_autorec_calloc)(VP, NM, SZ, __FILE__, __LINE__)
1177 /* TODO obsolete c?salloc -> n_autorec_* */
1178 #define salloc(SZ) n_autorec_alloc(NULL, SZ)
1179 #define csalloc(NM,SZ) n_autorec_calloc(NULL, NM, SZ)
1181 /* Pseudo alloca (and also auto-reclaimed in autorec_pop()) */
1182 FL
void * n_lofi_alloc(size_t size n_MEMORY_DEBUG_ARGS
);
1183 FL
void n_lofi_free(void *vp n_MEMORY_DEBUG_ARGS
);
1185 #ifdef HAVE_MEMORY_DEBUG
1186 # define n_lofi_alloc(SZ) (n_lofi_alloc)(SZ, __FILE__, __LINE__)
1187 # define n_lofi_free(P) (n_lofi_free)(P, __FILE__, __LINE__)
1190 /* TODO obsolete ac_alloc / ac_free -> n_lofi_* */
1191 #define ac_alloc(SZ) n_lofi_alloc(SZ)
1192 #define ac_free(P) n_lofi_free(P)
1195 #ifdef HAVE_MEMORY_DEBUG
1196 FL
int c_memtrace(void *v
);
1198 /* For immediate debugging purposes, it is possible to check on request */
1199 FL bool_t
n__memory_check(char const *file
, int line
);
1200 # define n_memory_check() n__memory_check(__FILE__, __LINE__)
1202 # define n_memory_check() do{;}while(0)
1209 /* *sendcharsets* .. *charset-8bit* iterator; *a_charset_to_try_first* may be
1210 * used to prepend a charset to this list (e.g., for *reply-in-same-charset*).
1211 * The returned boolean indicates charset_iter_is_valid().
1212 * Without HAVE_ICONV, this "iterates" over *ttycharset* only */
1213 FL bool_t
charset_iter_reset(char const *a_charset_to_try_first
);
1214 FL bool_t
charset_iter_next(void);
1215 FL bool_t
charset_iter_is_valid(void);
1216 FL
char const * charset_iter(void);
1218 /* And this is (xxx temporary?) which returns the iterator if that is valid and
1219 * otherwise either *charset-8bit* or *ttycharset*, dep. on HAVE_ICONV */
1220 FL
char const * charset_iter_or_fallback(void);
1222 FL
void charset_iter_recurse(char *outer_storage
[2]); /* TODO LEGACY */
1223 FL
void charset_iter_restore(char *outer_storage
[2]); /* TODO LEGACY */
1225 /* Check whether our headers will need MIME conversion */
1227 FL
char const * need_hdrconv(struct header
*hp
);
1230 /* Convert header fields from RFC 1522 format */
1231 FL
void mime_fromhdr(struct str
const *in
, struct str
*out
,
1232 enum tdflags flags
);
1234 /* Interpret MIME strings in parts of an address field */
1235 FL
char * mime_fromaddr(char const *name
);
1237 /* fwrite(3) performing the given MIME conversion */
1238 FL ssize_t
mime_write(char const *ptr
, size_t size
, FILE *f
,
1239 enum conversion convert
, enum tdflags dflags
,
1240 struct quoteflt
*qf
, struct str
*outrest
,
1241 struct str
*inrest
);
1242 FL ssize_t
xmime_write(char const *ptr
, size_t size
, /* TODO LEGACY */
1243 FILE *f
, enum conversion convert
, enum tdflags dflags
);
1247 * Content-Transfer-Encodings as defined in RFC 2045 (and RFC 2047):
1248 * - Quoted-Printable, section 6.7
1249 * - Base64, section 6.8
1250 * TODO For now this is pretty mixed up regarding this external interface
1251 * TODO (and due to that the code is, too).
1252 * TODO In v15.0 CTE will be filter based, and explicit conversion will
1253 * TODO gain clear error codes
1256 /* Default MIME Content-Transfer-Encoding: as via *encoding* */
1257 FL
enum mime_enc
mime_enc_target(void);
1259 /* Map from a Content-Transfer-Encoding: header body (which may be NULL) */
1260 FL
enum mime_enc
mime_enc_from_ctehead(char const *hbody
);
1262 /* XXX Try to get rid of that */
1263 FL
char const * mime_enc_from_conversion(enum conversion
const convert
);
1265 /* How many characters of (the complete body) ln need to be quoted.
1266 * Only MIMEEF_ISHEAD and MIMEEF_ISENCWORD are understood */
1267 FL
size_t mime_enc_mustquote(char const *ln
, size_t lnlen
,
1268 enum mime_enc_flags flags
);
1270 /* How much space is necessary to encode len bytes in QP, worst case.
1271 * Includes room for terminator, UIZ_MAX on overflow */
1272 FL
size_t qp_encode_calc_size(size_t len
);
1274 /* If flags includes QP_ISHEAD these assume "word" input and use special
1275 * quoting rules in addition; soft line breaks are not generated.
1276 * Otherwise complete input lines are assumed and soft line breaks are
1277 * generated as necessary. Return NULL on error (overflow) */
1278 FL
struct str
* qp_encode(struct str
*out
, struct str
const *in
,
1279 enum qpflags flags
);
1281 FL
struct str
* qp_encode_cp(struct str
*out
, char const *cp
,
1282 enum qpflags flags
);
1283 FL
struct str
* qp_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
1284 enum qpflags flags
);
1287 /* The buffers of out and *rest* will be managed via srealloc().
1288 * If inrest_or_null is needed but NULL an error occurs, otherwise tolerant.
1289 * Return FAL0 on error; caller is responsible to free buffers */
1290 FL bool_t
qp_decode_header(struct str
*out
, struct str
const *in
);
1291 FL bool_t
qp_decode_part(struct str
*out
, struct str
const *in
,
1292 struct str
*outrest
, struct str
*inrest_or_null
);
1294 /* How much space is necessary to encode len bytes in Base64, worst case.
1295 * Includes room for (CR/LF/CRLF and) terminator, UIZ_MAX on overflow */
1296 FL
size_t b64_encode_calc_size(size_t len
);
1298 /* Note these simply convert all the input (if possible), including the
1299 * insertion of NL sequences if B64_CRLF or B64_LF is set (and multiple thereof
1300 * if B64_MULTILINE is set).
1301 * Thus, in the B64_BUF case, better call b64_encode_calc_size() first.
1302 * Return NULL on error (overflow; cannot happen for B64_BUF) */
1303 FL
struct str
* b64_encode(struct str
*out
, struct str
const *in
,
1304 enum b64flags flags
);
1305 FL
struct str
* b64_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
1306 enum b64flags flags
);
1308 FL
struct str
* b64_encode_cp(struct str
*out
, char const *cp
,
1309 enum b64flags flags
);
1312 /* The _{header,part}() variants are failure tolerant, the latter requires
1313 * outrest to be set; due to the odd 4:3 relation inrest_or_null should be
1314 * given, _then_, it is an error if it is needed but not set.
1315 * TODO pre v15 callers should ensure that no endless loop is entered because
1316 * TODO the inrest cannot be converted and ends up as inrest over and over:
1317 * TODO give NULL to stop such loops.
1318 * The buffers of out and possibly *rest* will be managed via srealloc().
1319 * Returns FAL0 on error; caller is responsible to free buffers.
1320 * XXX FAL0 is effectively not returned for _part*() variants,
1321 * XXX (instead replacement characters are produced for invalid data.
1322 * XXX _Unless_ operation could EOVERFLOW.)
1323 * XXX I.e. this is bad and is tolerant for text and otherwise not */
1324 FL bool_t
b64_decode(struct str
*out
, struct str
const *in
);
1325 FL bool_t
b64_decode_header(struct str
*out
, struct str
const *in
);
1326 FL bool_t
b64_decode_part(struct str
*out
, struct str
const *in
,
1327 struct str
*outrest
, struct str
*inrest_or_null
);
1333 /* Get a mime style parameter from a header body */
1334 FL
char * mime_param_get(char const *param
, char const *headerbody
);
1336 /* Format parameter name to have value, salloc() it or NULL (error) in result.
1337 * 0 on error, 1 or -1 on success: the latter if result contains \n newlines,
1338 * which it will if the created param requires more than MIME_LINELEN bytes;
1339 * there is never a trailing newline character */
1340 /* TODO mime_param_create() should return a StrList<> or something.
1341 * TODO in fact it should take a HeaderField* and append a HeaderFieldParam*! */
1342 FL si8_t
mime_param_create(struct str
*result
, char const *name
,
1345 /* Get the boundary out of a Content-Type: multipart/xyz header field, return
1346 * salloc()ed copy of it; store strlen() in *len if set */
1347 FL
char * mime_param_boundary_get(char const *headerbody
, size_t *len
);
1349 /* Create a salloc()ed MIME boundary */
1350 FL
char * mime_param_boundary_create(void);
1356 /* Create MIME part object tree for and of mp */
1357 FL
struct mimepart
* mime_parse_msg(struct message
*mp
,
1358 enum mime_parse_flags mpf
);
1364 /* `(un)?mimetype' commands */
1365 FL
int c_mimetype(void *v
);
1366 FL
int c_unmimetype(void *v
);
1368 /* Check whether the Content-Type name is internally known */
1369 FL bool_t
mime_type_check_mtname(char const *name
);
1371 /* Return a Content-Type matching the name, or NULL if none could be found */
1372 FL
char * mime_type_classify_filename(char const *name
);
1374 /* Classify content of *fp* as necessary and fill in arguments; **charset* is
1375 * set to *charset-7bit* or charset_iter_or_fallback() if NULL */
1376 FL
enum conversion
mime_type_classify_file(FILE *fp
, char const **contenttype
,
1377 char const **charset
, int *do_iconv
);
1379 /* Dependend on *mime-counter-evidence* mpp->m_ct_type_usr_ovwr will be set,
1380 * but otherwise mpp is const */
1381 FL
enum mimecontent
mime_type_classify_part(struct mimepart
*mpp
);
1383 /* Query handler for a part, return the plain type (& MIME_HDL_TYPE_MASK).
1384 * mhp is anyway initialized (mh_flags, mh_msg) */
1385 FL
enum mime_handler_flags
mime_type_handler(struct mime_handler
*mhp
,
1386 struct mimepart
const *mpp
,
1387 enum sendaction action
);
1393 /* Allocate a single element of a name list, initialize its name field to the
1394 * passed name and return it */
1395 FL
struct name
* nalloc(char const *str
, enum gfield ntype
);
1397 /* Like nalloc(), but initialize from content of np */
1398 FL
struct name
* ndup(struct name
*np
, enum gfield ntype
);
1400 /* Concatenate the two passed name lists, return the result */
1401 FL
struct name
* cat(struct name
*n1
, struct name
*n2
);
1404 FL
struct name
* namelist_dup(struct name
const *np
, enum gfield ntype
);
1406 /* Determine the number of undeleted elements in a name list and return it;
1407 * the latter also doesn't count file and pipe addressees in addition */
1408 FL ui32_t
count(struct name
const *np
);
1409 FL ui32_t
count_nonlocal(struct name
const *np
);
1411 /* Extract a list of names from a line, and make a list of names from it.
1412 * Return the list or NULL if none found */
1413 FL
struct name
* extract(char const *line
, enum gfield ntype
);
1415 /* Like extract() unless line contains anyof ",\"\\(<|", in which case
1416 * comma-separated list extraction is used instead */
1417 FL
struct name
* lextract(char const *line
, enum gfield ntype
);
1419 /* Turn a list of names into a string of the same names */
1420 FL
char * detract(struct name
*np
, enum gfield ntype
);
1422 /* Get a lextract() list via n_lex_input_cp_addhist(), reassigning to *np* */
1423 FL
struct name
* grab_names(enum n_lexinput_flags lif
, char const *field
,
1424 struct name
*np
, int comma
, enum gfield gflags
);
1426 /* Check whether n1 n2 share the domain name */
1427 FL bool_t
name_is_same_domain(struct name
const *n1
,
1428 struct name
const *n2
);
1430 /* Check all addresses in np and delete invalid ones; if set_on_error is not
1431 * NULL it'll be set to TRU1 for error or -1 for "hard fail" error */
1432 FL
struct name
* checkaddrs(struct name
*np
, enum expand_addr_check_mode eacm
,
1433 si8_t
*set_on_error
);
1435 /* Vaporise all duplicate addresses in hp (.h_(to|cc|bcc)) so that an address
1436 * that "first" occurs in To: is solely in there, ditto Cc:, after expanding
1437 * aliases etc. eacm and set_on_error are passed to checkaddrs(), metoo is
1438 * passed to usermap(). After updating hp to the new state this returns
1439 * a flat list of all addressees, which may be NULL */
1440 FL
struct name
* namelist_vaporise_head(struct header
*hp
,
1441 enum expand_addr_check_mode eacm
, bool_t metoo
,
1442 si8_t
*set_on_error
);
1444 /* Map all of the aliased users in the invoker's mailrc file and insert them
1446 FL
struct name
* usermap(struct name
*names
, bool_t force_metoo
);
1448 /* Remove all of the duplicates from the passed name list by insertion sorting
1449 * them, then checking for dups. Return the head of the new list */
1450 FL
struct name
* elide(struct name
*names
);
1452 /* `alternates' deal with the list of alternate names */
1453 FL
int c_alternates(void *v
);
1455 FL
struct name
* delete_alternates(struct name
*np
);
1457 FL
int is_myname(char const *name
);
1460 FL
int c_alias(void *v
);
1461 FL
int c_unalias(void *v
);
1463 /* `(un)?ml(ist|subscribe)', and a check whether a name is a (wanted) list */
1464 FL
int c_mlist(void *v
);
1465 FL
int c_unmlist(void *v
);
1466 FL
int c_mlsubscribe(void *v
);
1467 FL
int c_unmlsubscribe(void *v
);
1469 FL
enum mlist_state
is_mlist(char const *name
, bool_t subscribed_only
);
1471 /* `(un)?shortcut', and check if str is one, return expansion or NULL */
1472 FL
int c_shortcut(void *v
);
1473 FL
int c_unshortcut(void *v
);
1475 FL
char const * shortcut_expand(char const *str
);
1481 /* Test to see if the passed file name is a directory, return true if it is */
1482 FL bool_t
is_dir(char const *name
);
1484 /* Recursively create a directory */
1485 FL bool_t
n_path_mkdir(char const *name
);
1487 /* Delete a file, but only if the file is a plain file; return FAL0 on system
1488 * error and TRUM1 if name is not a plain file, return TRU1 on success */
1489 FL bool_t
n_path_rm(char const *name
);
1491 /* A get-wd..restore-wd approach */
1492 FL
enum okay
cwget(struct cw
*cw
);
1493 FL
enum okay
cwret(struct cw
*cw
);
1494 FL
void cwrelse(struct cw
*cw
);
1502 FL
enum okay
pop3_noop(void);
1505 FL
int pop3_setfile(char const *server
, enum fedit_mode fm
);
1508 FL
enum okay
pop3_header(struct message
*m
);
1511 FL
enum okay
pop3_body(struct message
*m
);
1514 FL bool_t
pop3_quit(bool_t hold_sigs_on
);
1515 #endif /* HAVE_POP3 */
1519 * Subprocesses, popen, but also file handling with registering
1522 /* For program startup in main.c: initialize process manager */
1523 FL
void command_manager_start(void);
1525 /* Notes: OF_CLOEXEC is implied in oflags, xflags may be NULL */
1526 FL
FILE * safe_fopen(char const *file
, char const *oflags
, int *xflags
);
1528 /* Notes: OF_CLOEXEC|OF_REGISTER are implied in oflags!
1529 * Exception is Fdopen() if nocloexec is TRU1, but otherwise even for it the fd
1530 * creator has to take appropriate steps in order to ensure this is true! */
1531 FL
FILE * Fopen(char const *file
, char const *oflags
);
1532 FL
FILE * Fdopen(int fd
, char const *oflags
, bool_t nocloexec
);
1534 FL
int Fclose(FILE *fp
);
1536 /* Open file according to oflags (see popen.c). Handles compressed files */
1537 FL
FILE * Zopen(char const *file
, char const *oflags
);
1539 /* Create a temporary file in *TMPDIR*, use namehint for its name (prefix
1540 * unless OF_SUFFIX is set, in which case namehint is an extension that MUST be
1541 * part of the resulting filename, otherwise Ftmp() will fail), store the
1542 * unique name in fn (unless OF_UNLINK is set in oflags), and return a stdio
1543 * FILE pointer with access oflags. OF_CLOEXEC is implied in oflags.
1544 * One of OF_WRONLY and OF_RDWR must be set. Mode of 0600 is implied */
1545 FL
FILE * Ftmp(char **fn
, char const *namehint
, enum oflags oflags
);
1547 /* If OF_HOLDSIGS was set when calling Ftmp(), then hold_all_sigs() had been
1548 * called: call this to unlink(2) and free *fn and to rele_all_sigs() */
1549 FL
void Ftmp_release(char **fn
);
1551 /* Free the resources associated with the given filename. To be called after
1553 FL
void Ftmp_free(char **fn
);
1555 /* Create a pipe and ensure CLOEXEC bit is set in both descriptors */
1556 FL bool_t
pipe_cloexec(int fd
[2]);
1559 * env_addon may be NULL, otherwise it is expected to be a NULL terminated
1560 * array of "K=V" strings to be placed into the childs environment.
1561 * If cmd==(char*)-1 then shell is indeed expected to be a PTF :P that will be
1562 * called from within the child process */
1563 FL
FILE * Popen(char const *cmd
, char const *mode
, char const *shell
,
1564 char const **env_addon
, int newfd1
);
1565 FL bool_t
Pclose(FILE *fp
, bool_t dowait
);
1567 /* In n_PSO_INTERACTIVE, we want to go over $PAGER.
1568 * These are specialized version of Popen()/Pclose() which also encapsulate
1569 * error message printing, terminal handling etc. additionally */
1570 FL
FILE * n_pager_open(void);
1571 FL bool_t
n_pager_close(FILE *fp
);
1574 FL
void close_all_files(void);
1576 /* Fork a child process, enable use of the *child() series below */
1577 FL
int fork_child(void);
1579 /* Run a command without a shell, with optional arguments and splicing of stdin
1580 * and stdout. FDs may also be COMMAND_FD_NULL and COMMAND_FD_PASS, meaning to
1581 * redirect from/to /dev/null or pass through our own set of FDs; in the
1582 * latter case terminal capabilities are saved/restored if possible.
1583 * The command name can be a sequence of words.
1584 * Signals must be handled by the caller. "Mask" contains the signals to
1585 * ignore in the new process. SIGINT is enabled unless it's in the mask.
1586 * env_addon may be NULL, otherwise it is expected to be a NULL terminated
1587 * array of "K=V" strings to be placed into the childs environment */
1588 FL
int run_command(char const *cmd
, sigset_t
*mask
, int infd
,
1589 int outfd
, char const *a0
, char const *a1
, char const *a2
,
1590 char const **env_addon
);
1592 /* Like run_command, but don't wait for the command to finish.
1593 * Also it is usually an error to use COMMAND_FD_PASS for this one */
1594 FL
int start_command(char const *cmd
, sigset_t
*mask
, int infd
,
1595 int outfd
, char const *a0
, char const *a1
, char const *a2
,
1596 char const **env_addon
);
1598 /* In-child process */
1599 FL
void prepare_child(sigset_t
*nset
, int infd
, int outfd
);
1601 /* Mark a child as don't care - pid */
1602 FL
void free_child(int pid
);
1604 /* Wait for pid, return whether we've had a normal n_EXIT_OK exit.
1605 * If wait_status is set, set it to the reported waitpid(2) wait status */
1606 FL bool_t
wait_child(int pid
, int *wait_status
);
1612 /* Save all of the undetermined messages at the top of "mbox". Save all
1613 * untouched messages back in the system mailbox. Remove the system mailbox,
1614 * if none saved there.
1615 * TODO v15 Note: assumes hold_sigs() has been called _and_ can be temporarily
1616 * TODO dropped via a single rele_sigs() if hold_sigs_on */
1617 FL bool_t
quit(bool_t hold_sigs_on
);
1619 /* Adjust the message flags in each message */
1620 FL
int holdbits(void);
1622 /* Create another temporary file and copy user's mbox file darin. If there is
1623 * no mbox, copy nothing. If he has specified "append" don't copy his mailbox,
1624 * just copy saveable entries at the end */
1625 FL
enum okay
makembox(void);
1627 FL
void save_mbox_for_possible_quitstuff(void); /* TODO DROP IF U CAN */
1629 FL
int savequitflags(void);
1631 FL
void restorequitflags(int);
1637 /* Send message described by the passed pointer to the passed output buffer.
1638 * Return -1 on error. Adjust the status: field if need be. If doitp is
1639 * given, suppress ignored header fields. prefix is a string to prepend to
1640 * each output line. action = data destination
1641 * (SEND_MBOX,_TOFILE,_TODISP,_QUOTE,_DECRYPT). stats[0] is line count,
1642 * stats[1] is character count. stats may be NULL. Note that stats[0] is
1643 * valid for SEND_MBOX only */
1644 FL
int sendmp(struct message
*mp
, FILE *obuf
,
1645 struct n_ignore
const *doitp
,
1646 char const *prefix
, enum sendaction action
, ui64_t
*stats
);
1652 /* Interface between the argument list and the mail1 routine which does all the
1654 FL
int mail(struct name
*to
, struct name
*cc
, struct name
*bcc
,
1655 char const *subject
, struct attachment
*attach
,
1656 char const *quotefile
, int recipient_record
);
1658 /* `mail' and `Mail' commands, respectively */
1659 FL
int c_sendmail(void *v
);
1660 FL
int c_Sendmail(void *v
);
1662 /* Mail a message on standard input to the people indicated in the passed
1663 * header. (Internal interface) */
1664 FL
enum okay
mail1(struct header
*hp
, int printheaders
,
1665 struct message
*quote
, char const *quotefile
,
1666 int recipient_record
, int doprefix
);
1668 /* Create a Date: header field.
1669 * We compare the localtime() and gmtime() results to get the timezone, because
1670 * numeric timezones are easier to read and because $TZ isn't always set */
1671 FL
int mkdate(FILE *fo
, char const *field
);
1673 /* Dump the to, subject, cc header on the passed file buffer.
1674 * nosend_msg tells us not to dig to deep but to instead go for compose mode or
1675 * editing a message (yet we're stupid and cannot do it any better) - if it is
1676 * TRUM1 then we're really in compose mode and will produce some fields for
1677 * easier filling in */
1678 FL
int puthead(bool_t nosend_msg
, struct header
*hp
, FILE *fo
,
1679 enum gfield w
, enum sendaction action
,
1680 enum conversion convert
, char const *contenttype
,
1681 char const *charset
);
1684 FL
enum okay
resend_msg(struct message
*mp
, struct name
*to
, int add_resent
);
1687 FL
void savedeadletter(FILE *fp
, bool_t fflush_rewind_first
);
1693 /* Evaluate the string given as a new mailbox name. Supported meta characters:
1694 * . % for my system mail box
1695 * . %user for user's system mail box
1696 * . # for previous file
1697 * . & invoker's mbox file
1698 * . +file file in folder directory
1699 * . any shell meta character (except for FEXP_NSHELL).
1700 * a poor man's vis(3), on name before calling this (and showing the user).
1701 * If FEXP_MULTIOK is set we return an array of terminated strings, the (last)
1702 * result string is terminated via \0\0 and n_PS_EXPAND_MULTIRESULT is set.
1703 * Returns the file name as an auto-reclaimed string */
1704 FL
char * fexpand(char const *name
, enum fexp_mode fexpm
);
1706 #define expand(N) fexpand(N, FEXP_FULL) /* XXX remove these */
1708 /* Parse the next shell token from input (->s and ->l are adjusted to the
1709 * remains, data is constant beside that; ->s may be NULL if ->l is 0, if ->l
1710 * EQ UIZ_MAX strlen(->s) is used) and append the resulting output to store */
1711 FL
enum n_shexp_state
n_shexp_parse_token(struct n_string
*store
,
1712 struct str
*input
, enum n_shexp_parse_flags flags
);
1714 /* Likewise, but strips n_SHEXP_STATE_STOP if input remains after parsing,
1715 * otherwise forcefully sets it. Returns autoreclaimed storage */
1716 FL
enum n_shexp_state
n_shexp_parse_token_buf(char **store
,
1717 char const *indat
, size_t inlen
,
1718 enum n_shexp_parse_flags flags
);
1720 /* Quote input in a way that can, in theory, be fed into parse_token() again.
1721 * ->s may be NULL if ->l is 0, if ->l EQ UIZ_MAX strlen(->s) is used.
1722 * If rndtrip is true we try to make the resulting string "portable" (by
1723 * converting Unicode to \u etc.), otherwise we produce something to be
1724 * consumed "now", i.e., to display for the user.
1725 * Resulting output is _appended_ to store.
1726 * TODO Note: last resort, since \u and $ expansions etc. are necessarily
1727 * TODO already expanded and can thus not be reverted, but ALL we have */
1728 FL
struct n_string
*n_shexp_quote(struct n_string
*store
,
1729 struct str
const *input
, bool_t rndtrip
);
1730 FL
char * n_shexp_quote_cp(char const *cp
, bool_t rndtrip
);
1732 /* Can name be used as a variable name? I.e., this returns false for special
1733 * parameter names like $# etc. */
1734 FL bool_t
n_shexp_is_valid_varname(char const *name
);
1741 FL
int c_sigstate(void *);
1744 FL
void n_raise(int signo
);
1746 /* Provide BSD-like signal() on all systems TODO v15 -> SysV -> n_signal() */
1747 FL sighandler_type
safe_signal(int signum
, sighandler_type handler
);
1749 /* Provide reproducable non-restartable signal handler installation */
1750 FL n_sighdl_t
n_signal(int signo
, n_sighdl_t hdl
);
1752 /* Hold *all* signals but SIGCHLD, and release that total block again */
1753 FL
void hold_all_sigs(void);
1754 FL
void rele_all_sigs(void);
1756 /* Hold HUP/QUIT/INT */
1757 FL
void hold_sigs(void);
1758 FL
void rele_sigs(void);
1760 /* Call _ENTER_SWITCH() with the according flags, it'll take care for the rest
1761 * and also set the jump buffer - it returns 0 if anything went fine and
1762 * a signal number if a jump occurred, in which case all handlers requested in
1763 * flags are temporarily SIG_IGN.
1764 * _cleanup_ping() informs the condome that no jumps etc. shall be performed
1765 * until _leave() is called in the following -- to be (optionally) called right
1766 * before the local jump label is reached which is jumped to after a long jump
1767 * occurred, straight code flow provided, e.g., to avoid destructors to be
1768 * called twice. _leave() must always be called last, reraise_flags will be
1769 * used to decide how signal handling has to continue
1771 #define n_SIGMAN_ENTER_SWITCH(S,F) do{\
1774 if(sigsetjmp((S)->sm_jump, 1))\
1778 n__sigman_enter(S, __x__);\
1779 }while(0); switch((S)->sm_signo)
1780 FL
int n__sigman_enter(struct n_sigman
*self
, int flags
);
1781 FL
void n_sigman_cleanup_ping(struct n_sigman
*self
);
1782 FL
void n_sigman_leave(struct n_sigman
*self
, enum n_sigman_flags flags
);
1784 /* Pending signal or 0? */
1785 FL
int n_sigman_peek(void);
1786 FL
void n_sigman_consume(void);
1788 /* Not-Yet-Dead debug information (handler installation in main.c) */
1789 #if defined HAVE_DEBUG || defined HAVE_DEVEL
1790 FL
void _nyd_chirp(ui8_t act
, char const *file
, ui32_t line
,
1792 FL
void _nyd_oncrash(int signo
);
1795 # define NYD_ENTER _nyd_chirp(1, __FILE__, __LINE__, __FUN__)
1796 # define NYD_LEAVE _nyd_chirp(2, __FILE__, __LINE__, __FUN__)
1797 # define NYD _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
1798 # define NYD_X _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
1800 # define NYD2_ENTER _nyd_chirp(1, __FILE__, __LINE__, __FUN__)
1801 # define NYD2_LEAVE _nyd_chirp(2, __FILE__, __LINE__, __FUN__)
1802 # define NYD2 _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
1808 # define NYD_ENTER do {} while (0)
1809 # define NYD_LEAVE do {} while (0)
1810 # define NYD do {} while (0)
1811 # define NYD_X do {} while (0) /* XXX LEGACY */
1814 # define NYD2_ENTER do {} while (0)
1815 # define NYD2_LEAVE do {} while (0)
1816 # define NYD2 do {} while (0)
1824 /* Send a message via SMTP */
1825 FL bool_t
smtp_mta(struct sendbundle
*sbp
);
1833 FL bool_t
sopen(struct sock
*sp
, struct url
*urlp
);
1834 FL
int sclose(struct sock
*sp
);
1835 FL
enum okay
swrite(struct sock
*sp
, char const *data
);
1836 FL
enum okay
swrite1(struct sock
*sp
, char const *data
, int sz
,
1840 FL
int sgetline(char **line
, size_t *linesize
, size_t *linelen
,
1841 struct sock
*sp n_MEMORY_DEBUG_ARGS
);
1842 # ifdef HAVE_MEMORY_DEBUG
1843 # define sgetline(A,B,C,D) sgetline(A, B, C, D, __FILE__, __LINE__)
1852 /* Direct mappings of the various spam* commands */
1853 FL
int c_spam_clear(void *v
);
1854 FL
int c_spam_set(void *v
);
1855 FL
int c_spam_forget(void *v
);
1856 FL
int c_spam_ham(void *v
);
1857 FL
int c_spam_rate(void *v
);
1858 FL
int c_spam_spam(void *v
);
1860 # define c_spam_clear c_cmdnotsupp
1861 # define c_spam_set c_cmdnotsupp
1862 # define c_spam_forget c_cmdnotsupp
1863 # define c_spam_ham c_cmdnotsupp
1864 # define c_spam_rate c_cmdnotsupp
1865 # define c_spam_spam c_cmdnotsupp
1874 FL
void ssl_set_verify_level(struct url
const *urlp
);
1877 FL
enum okay
ssl_verify_decide(void);
1880 FL
enum okay
smime_split(FILE *ip
, FILE **hp
, FILE **bp
, long xcount
,
1884 FL
FILE * smime_sign_assemble(FILE *hp
, FILE *bp
, FILE *sp
,
1885 char const *message_digest
);
1888 FL
FILE * smime_encrypt_assemble(FILE *hp
, FILE *yp
);
1891 FL
struct message
* smime_decrypt_assemble(struct message
*m
, FILE *hp
,
1895 FL
int c_certsave(void *v
);
1898 FL
enum okay
rfc2595_hostname_match(char const *host
, char const *pattern
);
1899 #else /* HAVE_SSL */
1900 # define c_certsave c_cmdnotsupp
1907 /* Return a pointer to a dynamic copy of the argument */
1908 FL
char * savestr(char const *str n_MEMORY_DEBUG_ARGS
);
1909 FL
char * savestrbuf(char const *sbuf
, size_t slen n_MEMORY_DEBUG_ARGS
);
1910 #ifdef HAVE_MEMORY_DEBUG
1911 # define savestr(CP) savestr(CP, __FILE__, __LINE__)
1912 # define savestrbuf(CBP,CBL) savestrbuf(CBP, CBL, __FILE__, __LINE__)
1915 /* Concatenate cp2 onto cp1 (if not NULL), separated by sep (if not '\0') */
1916 FL
char * savecatsep(char const *cp1
, char sep
, char const *cp2
1917 n_MEMORY_DEBUG_ARGS
);
1918 #ifdef HAVE_MEMORY_DEBUG
1919 # define savecatsep(S1,SEP,S2) savecatsep(S1, SEP, S2, __FILE__, __LINE__)
1922 /* Make copy of argument incorporating old one, if set, separated by space */
1923 #define save2str(S,O) savecatsep(O, ' ', S)
1926 #define savecat(S1,S2) savecatsep(S1, '\0', S2)
1928 /* Create duplicate, lowercasing all characters along the way */
1929 FL
char * i_strdup(char const *src n_MEMORY_DEBUG_ARGS
);
1930 #ifdef HAVE_MEMORY_DEBUG
1931 # define i_strdup(CP) i_strdup(CP, __FILE__, __LINE__)
1935 FL
struct str
* str_concat_csvl(struct str
*self
, ...);
1938 FL
struct str
* str_concat_cpa(struct str
*self
, char const * const *cpa
,
1939 char const *sep_o_null n_MEMORY_DEBUG_ARGS
);
1940 #ifdef HAVE_MEMORY_DEBUG
1941 # define str_concat_cpa(S,A,N) str_concat_cpa(S, A, N, __FILE__, __LINE__)
1944 /* Plain char* support, not auto-reclaimed (unless noted) */
1946 /* Are any of the characters in the two strings the same? */
1947 FL bool_t
n_anyof_buf(char const *template, char const *dat
, size_t len
);
1948 #define n_anyof_cp(S1,S2) n_anyof_buf(S1, S2, UIZ_MAX)
1949 #define anyof(S1,S2) n_anyof_buf(S1, S2, UIZ_MAX)
1951 /* Treat *iolist as a sep separated list of strings; find and return the
1952 * next entry, trimming surrounding whitespace, and point *iolist to the next
1953 * entry or to NULL if no more entries are contained. If ignore_empty is
1954 * set empty entries are started over.
1955 * See n_shexp_parse_token() for the new way that supports sh(1) quoting.
1956 * Return NULL or an entry */
1957 FL
char * n_strsep(char **iolist
, char sep
, bool_t ignore_empty
);
1959 /* Copy a string, lowercasing it as we go; *size* is buffer size of *dest*;
1960 * *dest* will always be terminated unless *size* is 0 */
1961 FL
void i_strcpy(char *dest
, char const *src
, size_t size
);
1963 /* Is *as1* a valid prefix of *as2*? */
1964 FL
int is_prefix(char const *as1
, char const *as2
);
1966 /* Backslash quote (" and \) v'alue, and return salloc()ed result */
1967 FL
char * string_quote(char const *v
);
1969 /* Get (and isolate) the last, possibly quoted part of linebuf, set *needs_list
1970 * to indicate whether getmsglist() et al need to be called to collect
1971 * additional args that remain in linebuf. If strip is true possibly
1972 * surrounding quote characters are removed. Return NULL on "error" */
1973 FL
char * laststring(char *linebuf
, bool_t
*needs_list
, bool_t strip
);
1975 /* Convert a string to lowercase, in-place and with multibyte-aware */
1976 FL
void makelow(char *cp
);
1978 /* Is *sub* a substring of *str*, case-insensitive and multibyte-aware? */
1979 FL bool_t
substr(char const *str
, char const *sub
);
1982 FL
char * sstpcpy(char *dst
, char const *src
);
1983 FL
char * sstrdup(char const *cp n_MEMORY_DEBUG_ARGS
);
1984 FL
char * sbufdup(char const *cp
, size_t len n_MEMORY_DEBUG_ARGS
);
1985 #ifdef HAVE_MEMORY_DEBUG
1986 # define sstrdup(CP) sstrdup(CP, __FILE__, __LINE__)
1987 # define sbufdup(CP,L) sbufdup(CP, L, __FILE__, __LINE__)
1990 /* Copy at most dstsize bytes of src to dst and return string length.
1991 * Returns -E2BIG if dst is not large enough; dst will always be terminated
1992 * unless dstsize was 0 on entry */
1993 FL ssize_t
n_strscpy(char *dst
, char const *src
, size_t dstsize
);
1995 /* Case-independent ASCII comparisons */
1996 FL
int asccasecmp(char const *s1
, char const *s2
);
1997 FL
int ascncasecmp(char const *s1
, char const *s2
, size_t sz
);
1999 /* Case-independent ASCII string find s2 in s1, return it or NULL */
2000 FL
char const *asccasestr(char const *s1
, char const *s2
);
2002 /* Case-independent ASCII check whether as1 is the initial substring of as2 */
2003 FL bool_t
is_asccaseprefix(char const *as1
, char const *as2
);
2005 /* struct str related support funs TODO _cp->_cs! */
2007 /* *self->s* is srealloc()ed */
2008 #define n_str_dup(S, T) n_str_assign_buf((S), (T)->s, (T)->l)
2010 /* *self->s* is srealloc()ed; if buflen==UIZ_MAX strlen() is called unless buf
2011 * is NULL; buf may be NULL if buflen is 0 */
2012 FL
struct str
* n_str_assign_buf(struct str
*self
,
2013 char const *buf
, uiz_t buflen n_MEMORY_DEBUG_ARGS
);
2014 #define n_str_assign(S, T) n_str_assign_buf(S, (T)->s, (T)->l)
2015 #define n_str_assign_cp(S, CP) n_str_assign_buf(S, CP, UIZ_MAX)
2017 /* *self->s* is srealloc()ed, *self->l* incremented; if buflen==UIZ_MAX
2018 * strlen() is called unless buf is NULL; buf may be NULL if buflen is 0 */
2019 FL
struct str
* n_str_add_buf(struct str
*self
, char const *buf
, uiz_t buflen
2020 n_MEMORY_DEBUG_ARGS
);
2021 #define n_str_add(S, T) n_str_add_buf(S, (T)->s, (T)->l)
2022 #define n_str_add_cp(S, CP) n_str_add_buf(S, CP, UIZ_MAX)
2024 #ifdef HAVE_MEMORY_DEBUG
2025 # define n_str_assign_buf(S,B,BL) n_str_assign_buf(S, B, BL, __FILE__, __LINE__)
2026 # define n_str_add_buf(S,B,BL) n_str_add_buf(S, B, BL, __FILE__, __LINE__)
2030 * May have NULL buffer, may contain embedded NULs */
2032 /* Lifetime. n_string_gut() is optional for _creat_auto() strings */
2033 #define n_string_creat(S) \
2034 ((S)->s_dat = NULL, (S)->s_len = (S)->s_auto = (S)->s_size = 0, (S))
2035 #define n_string_creat_auto(S) \
2036 ((S)->s_dat = NULL, (S)->s_len = (S)->s_size = 0, (S)->s_auto = TRU1, (S))
2037 #define n_string_gut(S) ((S)->s_size != 0 ? (void)n_string_clear(S) : (void)0)
2039 /* Truncate to size, which must be LE current length */
2040 #define n_string_trunc(S,L) \
2041 (assert(UICMP(z, L, <=, (S)->s_len)), (S)->s_len = (ui32_t)(L), (S))
2043 /* Take/Release buffer ownership */
2044 #define n_string_take_ownership(SP,B,S,L) \
2045 (assert((SP)->s_dat == NULL), assert((S) == 0 || (B) != NULL),\
2046 assert((L) < (S) || (L) == 0),\
2047 (SP)->s_dat = (B), (SP)->s_len = (L), (SP)->s_size = (S), (SP))
2048 #define n_string_drop_ownership(SP) \
2049 ((SP)->s_dat = NULL, (SP)->s_len = (SP)->s_size = 0, (SP))
2051 /* Release all memory */
2052 FL
struct n_string
*n_string_clear(struct n_string
*self n_MEMORY_DEBUG_ARGS
);
2054 #ifdef HAVE_MEMORY_DEBUG
2055 # define n_string_clear(S) \
2056 ((S)->s_size != 0 ? (n_string_clear)(S, __FILE__, __LINE__) : (S))
2058 # define n_string_clear(S) ((S)->s_size != 0 ? (n_string_clear)(S) : (S))
2061 /* Reserve room for noof additional bytes, but don't adjust length (yet) */
2062 FL
struct n_string
*n_string_reserve(struct n_string
*self
, size_t noof
2063 n_MEMORY_DEBUG_ARGS
);
2065 /* Resize to exactly nlen bytes; any new storage isn't initialized */
2066 FL
struct n_string
*n_string_resize(struct n_string
*self
, size_t nlen
2067 n_MEMORY_DEBUG_ARGS
);
2069 #ifdef HAVE_MEMORY_DEBUG
2070 # define n_string_reserve(S,N) (n_string_reserve)(S, N, __FILE__, __LINE__)
2071 # define n_string_resize(S,N) (n_string_resize)(S, N, __FILE__, __LINE__)
2075 FL
struct n_string
*n_string_push_buf(struct n_string
*self
, char const *buf
,
2076 size_t buflen n_MEMORY_DEBUG_ARGS
);
2077 #define n_string_push(S, T) n_string_push_buf(S, (T)->s_len, (T)->s_dat)
2078 #define n_string_push_cp(S,CP) n_string_push_buf(S, CP, UIZ_MAX)
2079 FL
struct n_string
*n_string_push_c(struct n_string
*self
, char c
2080 n_MEMORY_DEBUG_ARGS
);
2082 #define n_string_assign(S,T) ((S)->s_len = 0, n_string_push(S, T))
2083 #define n_string_assign_cp(S,CP) ((S)->s_len = 0, n_string_push_cp(S, CP))
2084 #define n_string_assign_buf(S,B,BL) \
2085 ((S)->s_len = 0, n_string_push_buf(S, B, BL))
2087 #ifdef HAVE_MEMORY_DEBUG
2088 # define n_string_push_buf(S,B,BL) \
2089 n_string_push_buf(S, B, BL, __FILE__, __LINE__)
2090 # define n_string_push_c(S,C) n_string_push_c(S, C, __FILE__, __LINE__)
2094 FL
struct n_string
*n_string_unshift_buf(struct n_string
*self
, char const *buf
,
2095 size_t buflen n_MEMORY_DEBUG_ARGS
);
2096 #define n_string_unshift(S,T) \
2097 n_string_unshift_buf(S, (T)->s_len, (T)->s_dat)
2098 #define n_string_unshift_cp(S,CP) \
2099 n_string_unshift_buf(S, CP, UIZ_MAX)
2100 FL
struct n_string
*n_string_unshift_c(struct n_string
*self
, char c
2101 n_MEMORY_DEBUG_ARGS
);
2103 #ifdef HAVE_MEMORY_DEBUG
2104 # define n_string_unshift_buf(S,B,BL) \
2105 n_string_unshift_buf(S,B,BL, __FILE__, __LINE__)
2106 # define n_string_unshift_c(S,C) n_string_unshift_c(S, C, __FILE__, __LINE__)
2110 FL
struct n_string
*n_string_insert_buf(struct n_string
*self
, size_t idx
,
2111 char const *buf
, size_t buflen n_MEMORY_DEBUG_ARGS
);
2112 #define n_string_insert(S,I,T) \
2113 n_string_insert_buf(S, I, (T)->s_len, (T)->s_dat)
2114 #define n_string_insert_cp(S,I,CP) \
2115 n_string_insert_buf(S, I, CP, UIZ_MAX)
2116 FL
struct n_string
*n_string_insert_c(struct n_string
*self
, size_t idx
,
2117 char c n_MEMORY_DEBUG_ARGS
);
2119 #ifdef HAVE_MEMORY_DEBUG
2120 # define n_string_insert_buf(S,I,B,BL) \
2121 n_string_insert_buf(S, I, B, BL, __FILE__, __LINE__)
2122 # define n_string_insert_c(S,I,C) n_string_insert_c(S, I, C, __FILE__, __LINE__)
2126 FL
struct n_string
*n_string_cut(struct n_string
*self
, size_t idx
, size_t len
);
2128 /* Ensure self has a - NUL terminated - buffer, and return that.
2129 * The latter may return the pointer to an internal empty RODATA instead */
2130 FL
char * n_string_cp(struct n_string
*self n_MEMORY_DEBUG_ARGS
);
2131 FL
char const *n_string_cp_const(struct n_string
const *self
);
2133 #ifdef HAVE_MEMORY_DEBUG
2134 # define n_string_cp(S) n_string_cp(S, __FILE__, __LINE__)
2138 n_INLINE
struct n_string
*
2139 (n_string_creat
)(struct n_string
*self
){
2140 return n_string_creat(self
);
2142 # undef n_string_creat
2144 n_INLINE
struct n_string
*
2145 (n_string_creat_auto
)(struct n_string
*self
){
2146 return n_string_creat_auto(self
);
2148 # undef n_string_creat_auto
2151 (n_string_gut
)(struct n_string
*self
){
2154 # undef n_string_gut
2156 n_INLINE
struct n_string
*
2157 (n_string_trunc
)(struct n_string
*self
, size_t l
){
2158 return n_string_trunc(self
, l
);
2160 # undef n_string_trunc
2162 n_INLINE
struct n_string
*
2163 (n_string_drop_ownership
)(struct n_string
*self
){
2164 return n_string_drop_ownership(self
);
2166 # undef n_string_drop_ownership
2167 #endif /* HAVE_INLINE */
2169 /* UTF-8 / UTF-32 stuff */
2171 /* ..and update arguments to point after range; returns UI32_MAX on error, in
2172 * which case the arguments will have been stepped one byte */
2173 FL ui32_t
n_utf8_to_utf32(char const **bdat
, size_t *blen
);
2175 /* buf must be large enough also for NUL, it's new length will be returned */
2176 FL
size_t n_utf32_to_utf8(ui32_t c
, char *buf
);
2178 /* Our iconv(3) wrappers */
2181 FL iconv_t
n_iconv_open(char const *tocode
, char const *fromcode
);
2182 /* If *cd* == *iconvd*, assigns -1 to the latter */
2183 FL
void n_iconv_close(iconv_t cd
);
2185 /* Reset encoding state */
2186 FL
void n_iconv_reset(iconv_t cd
);
2188 /* iconv(3), but return errno or 0 upon success.
2189 * The errno may be ENOENT unless n_ICONV_IGN_NOREVERSE is set in icf.
2190 * iconv_str() auto-grows on E2BIG errors; in and in_rest_or_null may be the
2192 * Note: EINVAL (incomplete sequence at end of input) is NOT handled, so the
2193 * replacement character must be added manually if that happens at EOF! */
2194 FL
int n_iconv_buf(iconv_t cd
, enum n_iconv_flags icf
,
2195 char const **inb
, size_t *inbleft
,
2196 char **outb
, size_t *outbleft
);
2197 FL
int n_iconv_str(iconv_t icp
, enum n_iconv_flags icf
,
2198 struct str
*out
, struct str
const *in
,
2199 struct str
*in_rest_or_null
);
2201 /* If tocode==NULL, uses *ttycharset*. If fromcode==NULL, uses UTF-8.
2202 * Returns a salloc()ed buffer or NULL */
2203 FL
char * n_iconv_onetime_cp(enum n_iconv_flags icf
,
2204 char const *tocode
, char const *fromcode
, char const *input
);
2209 * This is a little bit hairy since it provides some stuff even if HAVE_TERMCAP
2210 * is false due to encapsulation desire
2214 /* termcap(3) / xy lifetime handling -- only called if we're n_PSO_INTERACTIVE
2215 * but not doing something in n_PO_QUICKRUN_MASK */
2216 FL
void n_termcap_init(void);
2217 FL
void n_termcap_destroy(void);
2219 /* enter_ca_mode / enable keypad (both if possible).
2220 * TODO When complete is not set we won't enter_ca_mode, for example: we don't
2221 * TODO want a complete screen clearance after $PAGER returned after displaying
2222 * TODO a mail, because otherwise the screen would look differently for normal
2223 * TODO stdout display messages. Etc. */
2224 # ifdef HAVE_TERMCAP
2225 FL
void n_termcap_resume(bool_t complete
);
2226 FL
void n_termcap_suspend(bool_t complete
);
2228 # define n_TERMCAP_RESUME(CPL) n_termcap_resume(CPL)
2229 # define n_TERMCAP_SUSPEND(CPL) n_termcap_suspend(CPL)
2231 # define n_TERMCAP_RESUME(CPL)
2232 # define n_TERMCAP_SUSPEND(CPL)
2235 /* Command multiplexer, returns FAL0 on I/O error, TRU1 on success and TRUM1
2236 * for commands which are not available and have no builtin fallback.
2237 * For query options the return represents a true value and -1 error.
2238 * Will return FAL0 directly unless we've been initialized.
2239 * By convention unused argument slots are given as -1 */
2240 FL ssize_t
n_termcap_cmd(enum n_termcap_cmd cmd
, ssize_t a1
, ssize_t a2
);
2241 # define n_termcap_cmdx(CMD) n_termcap_cmd(CMD, -1, -1)
2243 /* Query multiplexer. If query is n__TERMCAP_QUERY_MAX1 then
2244 * tvp->tv_data.tvd_string must contain the name of the query to look up; this
2245 * is used to lookup just about *any* (string) capability.
2246 * Returns TRU1 on success and TRUM1 for queries for which a builtin default
2247 * is returned; FAL0 is returned on non-availability */
2248 FL bool_t
n_termcap_query(enum n_termcap_query query
,
2249 struct n_termcap_value
*tvp
);
2251 /* Get a n_termcap_query for name or -1 if it is not known, and -2 if
2252 * type wasn't _NONE and the type doesn't match. */
2253 # ifdef HAVE_KEY_BINDINGS
2254 FL si32_t
n_termcap_query_for_name(char const *name
,
2255 enum n_termcap_captype type
);
2256 FL
char const *n_termcap_name_of_query(enum n_termcap_query query
);
2258 #endif /* n_HAVE_TCAP */
2265 FL
int c_thread(void *vp
);
2268 FL
int c_unthread(void *vp
);
2271 FL
struct message
* next_in_thread(struct message
*mp
);
2272 FL
struct message
* prev_in_thread(struct message
*mp
);
2273 FL
struct message
* this_in_thread(struct message
*mp
, long n
);
2275 /* Sorted mode is internally just a variant of threaded mode with all m_parent
2276 * and m_child links being NULL */
2277 FL
int c_sort(void *vp
);
2280 FL
int c_collapse(void *v
);
2281 FL
int c_uncollapse(void *v
);
2284 FL
void uncollapse1(struct message
*mp
, int always
);
2290 /* Return whether user says yes, on STDIN if interactive.
2291 * Uses noninteract_default, the return value for non-interactive use cases,
2292 * as a hint for boolify() and chooses the yes/no string to append to prompt
2293 * accordingly. If prompt is NULL "Continue" is used instead.
2294 * Handles+reraises SIGINT */
2295 FL bool_t
getapproval(char const *prompt
, bool_t noninteract_default
);
2298 /* Get a password the expected way, return termios_state.ts_linebuf on
2299 * success or NULL on error */
2300 FL
char * getuser(char const *query
);
2302 /* Get a password the expected way, return termios_state.ts_linebuf on
2303 * success or NULL on error. SIGINT is temporarily blocked, *not* reraised.
2304 * termios_state_reset() (def.h) must be called anyway */
2305 FL
char * getpassword(char const *query
);
2308 /* Create the prompt and return its visual width in columns, which may be 0
2309 * if evaluation is disabled etc. The data is placed in store.
2310 * xprompt is inspected only if prompt is enabled and no *prompt* evaluation
2312 FL ui32_t
n_tty_create_prompt(struct n_string
*store
,
2313 char const *xprompt
, enum n_lexinput_flags lif
);
2315 /* At least readline(3) (formerly supported) desires to handle SIGWINCH and
2316 * install its own handler */
2318 # define TTY_WANTS_SIGWINCH
2321 /* Overall interactive terminal life cycle for command line editor library */
2322 FL
void n_tty_init(void);
2323 FL
void n_tty_destroy(void);
2325 /* Rather for main.c / SIGWINCH interaction only */
2326 FL
void n_tty_signal(int sig
);
2328 /* Read a line after printing prompt (if set and non-empty).
2329 * If n>0 assumes that *linebuf has n bytes of default content.
2330 * Only the _CTX_ bits in lif are used */
2331 FL
int n_tty_readline(enum n_lexinput_flags lif
, char const *prompt
,
2332 char **linebuf
, size_t *linesize
, size_t n
2333 n_MEMORY_DEBUG_ARGS
);
2334 #ifdef HAVE_MEMORY_DEBUG
2335 # define n_tty_readline(A,B,C,D,E) (n_tty_readline)(A,B,C,D,E,__FILE__,__LINE__)
2338 /* Add a line (most likely as returned by n_tty_readline()) to the history.
2339 * Whether an entry added for real depends on the isgabby / *history-gabby*
2340 * relation, and / or whether s is non-empty and doesn't begin with spacechar() */
2341 FL
void n_tty_addhist(char const *s
, bool_t isgabby
);
2344 FL
int c_history(void *v
);
2346 # define c_history c_cmdnotsupp
2349 /* `bind' and `unbind' */
2350 #ifdef HAVE_KEY_BINDINGS
2351 FL
int c_bind(void *v
);
2352 FL
int c_unbind(void *v
);
2354 # define c_bind c_cmdnotsupp
2355 # define c_unbind c_cmdnotsupp
2362 /* Parse (onechar of) a given buffer, and generate infos along the way.
2363 * If _WOUT_CREATE is set in vif, .vic_woudat will be NUL terminated!
2364 * vicp must be zeroed before first use */
2365 FL bool_t
n_visual_info(struct n_visual_info_ctx
*vicp
,
2366 enum n_visual_info_flags vif
);
2368 /* Check (multibyte-safe) how many bytes of buf (which is blen byts) can be
2369 * safely placed in a buffer (field width) of maxlen bytes */
2370 FL
size_t field_detect_clip(size_t maxlen
, char const *buf
, size_t blen
);
2372 /* Place cp in a salloc()ed buffer, column-aligned; for header display only */
2373 FL
char * colalign(char const *cp
, int col
, int fill
,
2374 int *cols_decr_used_or_null
);
2376 /* Convert a string to a displayable one;
2377 * prstr() returns the result savestr()d, prout() writes it */
2378 FL
void makeprint(struct str
const *in
, struct str
*out
);
2379 FL
size_t delctrl(char *cp
, size_t len
);
2380 FL
char * prstr(char const *s
);
2381 FL
int prout(char const *s
, size_t sz
, FILE *fp
);
2383 /* Print out a Unicode character or a substitute for it, return 0 on error or
2384 * wcwidth() (or 1) on success */
2385 FL
size_t putuc(int u
, int c
, FILE *fp
);
2387 /* Check whether bidirectional info maybe needed for blen bytes of bdat */
2388 FL bool_t
bidi_info_needed(char const *bdat
, size_t blen
);
2390 /* Create bidirectional text encapsulation information; without HAVE_NATCH_CHAR
2391 * the strings are always empty */
2392 FL
void bidi_info_create(struct bidi_info
*bip
);
2398 /* URL en- and decoding according to (enough of) RFC 3986 (RFC 1738).
2399 * These return a newly salloc()ated result, or NULL on length excess */
2400 FL
char * urlxenc(char const *cp
, bool_t ispath n_MEMORY_DEBUG_ARGS
);
2401 FL
char * urlxdec(char const *cp n_MEMORY_DEBUG_ARGS
);
2402 #ifdef HAVE_MEMORY_DEBUG
2403 # define urlxenc(CP,P) urlxenc(CP, P, __FILE__, __LINE__)
2404 # define urlxdec(CP) urlxdec(CP, __FILE__, __LINE__)
2408 FL
int c_urlcodec(void *v
);
2410 FL
int c_urlencode(void *v
); /* TODO obsolete*/
2411 FL
int c_urldecode(void *v
); /* TODO obsolete */
2413 /* Parse a RFC 6058 'mailto' URI to a single to: (TODO yes, for now hacky).
2414 * Return NULL or something that can be converted to a struct name */
2415 FL
char * url_mailto_to_address(char const *mailtop
);
2417 /* Return port for proto (and set irv_or_null), or NULL if unknown.
2418 * For file:// this returns an empty string */
2419 FL
char const *n_servbyname(char const *proto
, ui16_t
*irv_or_null
);
2422 /* Parse data, which must meet the criteria of the protocol cproto, and fill
2423 * in the URL structure urlp (URL rather according to RFC 3986) */
2424 FL bool_t
url_parse(struct url
*urlp
, enum cproto cproto
,
2427 /* Zero ccp and lookup credentials for communicating with urlp.
2428 * Return whether credentials are available and valid (for chosen auth) */
2429 FL bool_t
ccred_lookup(struct ccred
*ccp
, struct url
*urlp
);
2430 FL bool_t
ccred_lookup_old(struct ccred
*ccp
, enum cproto cproto
,
2432 #endif /* HAVE_SOCKETS */
2436 FL
int c_netrc(void *v
);
2438 # define c_netrc c_cmdnotsupp
2441 /* MD5 (RFC 1321) related facilities */
2443 # ifdef HAVE_XSSL_MD5
2444 # define md5_ctx MD5_CTX
2445 # define md5_init MD5_Init
2446 # define md5_update MD5_Update
2447 # define md5_final MD5_Final
2449 /* The function definitions are instantiated in main.c */
2450 # include "rfc1321.h"
2453 /* Store the MD5 checksum as a hexadecimal string in *hex*, *not* terminated,
2454 * using lowercase ASCII letters as defined in RFC 2195 */
2455 # define MD5TOHEX_SIZE 32
2456 FL
char * md5tohex(char hex
[MD5TOHEX_SIZE
], void const *vp
);
2458 /* CRAM-MD5 encode the *user* / *pass* / *b64* combo; NULL on overflow error */
2459 FL
char * cram_md5_string(struct str
const *user
, struct str
const *pass
,
2462 /* RFC 2104: HMAC: Keyed-Hashing for Message Authentication.
2463 * unsigned char *text: pointer to data stream
2464 * int text_len : length of data stream
2465 * unsigned char *key : pointer to authentication key
2466 * int key_len : length of authentication key
2467 * caddr_t digest : caller digest to be filled in */
2468 FL
void hmac_md5(unsigned char *text
, int text_len
, unsigned char *key
,
2469 int key_len
, void *digest
);
2470 #endif /* HAVE_MD5 */
2478 FL
enum okay
ssl_open(struct url
const *urlp
, struct sock
*sp
);
2481 FL
void ssl_gen_err(char const *fmt
, ...);
2484 FL
int c_verify(void *vp
);
2487 FL
FILE * smime_sign(FILE *ip
, char const *addr
);
2490 FL
FILE * smime_encrypt(FILE *ip
, char const *certfile
, char const *to
);
2492 FL
struct message
* smime_decrypt(struct message
*m
, char const *to
,
2493 char const *cc
, bool_t is_a_verify_call
);
2496 FL
enum okay
smime_certsave(struct message
*m
, int n
, FILE *op
);
2498 #else /* HAVE_XSSL */
2499 # define c_verify c_cmdnotsupp
2502 #ifndef HAVE_AMALGAMATION