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 - 2016 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 SMALLOC_DEBUG_ARGS , char const *mdbg_file, int mdbg_line
53 # define SMALLOC_DEBUG_ARGSCALL , mdbg_file, mdbg_line
54 # define SALLOC_DEBUG_ARGS , char const *mdbg_file, int mdbg_line
55 # define SALLOC_DEBUG_ARGSCALL , mdbg_file, mdbg_line
57 # define SMALLOC_DEBUG_ARGS
58 # define SMALLOC_DEBUG_ARGSCALL
59 # define SALLOC_DEBUG_ARGS
60 # define SALLOC_DEBUG_ARGSCALL
64 * Macro-based generics
67 /* ASCII char classification */
68 #define __ischarof(C, FLAGS) \
69 (asciichar(C) && (class_char[(ui8_t)(C)] & (FLAGS)) != 0)
71 #define n_uasciichar(U) ((size_t)(U) <= 0x7F)
72 #define asciichar(c) ((uc_i)(c) <= 0x7F)
73 #define alnumchar(c) __ischarof(c, C_DIGIT | C_OCTAL | C_UPPER | C_LOWER)
74 #define alphachar(c) __ischarof(c, C_UPPER | C_LOWER)
75 #define blankchar(c) __ischarof(c, C_BLANK)
76 #define blankspacechar(c) __ischarof(c, C_BLANK | C_SPACE)
77 #define cntrlchar(c) __ischarof(c, C_CNTRL)
78 #define digitchar(c) __ischarof(c, C_DIGIT | C_OCTAL)
79 #define lowerchar(c) __ischarof(c, C_LOWER)
80 #define punctchar(c) __ischarof(c, C_PUNCT)
81 #define spacechar(c) __ischarof(c, C_BLANK | C_SPACE | C_WHITE)
82 #define upperchar(c) __ischarof(c, C_UPPER)
83 #define whitechar(c) __ischarof(c, C_BLANK | C_WHITE)
84 #define octalchar(c) __ischarof(c, C_OCTAL)
85 #define hexchar(c) /* TODO extend bits, add C_HEX */\
86 (__ischarof(c, C_DIGIT | C_OCTAL) || ((c) >= 'A' && (c) <= 'F') ||\
87 ((c) >= 'a' && (c) <= 'f'))
89 #define upperconv(c) \
90 (lowerchar(c) ? (char)((uc_i)(c) - 'a' + 'A') : (char)(c))
91 #define lowerconv(c) \
92 (upperchar(c) ? (char)((uc_i)(c) - 'A' + 'a') : (char)(c))
94 #define fieldnamechar(c) \
95 (asciichar(c) && (c) > 040 && (c) != 0177 && (c) != ':')
97 /* Could the string contain a regular expression? */
99 # define is_maybe_regex(S) anyof("^.[]*+?()|$", S)
101 # define is_maybe_regex(S) anyof("^[]*+?|$", S)
104 /* Single-threaded, use unlocked I/O */
105 #ifdef HAVE_PUTC_UNLOCKED
107 # define getc(c) getc_unlocked(c)
109 # define putc(c, f) putc_unlocked(c, f)
111 # define putchar(c) putc_unlocked((c), stdout)
114 /* There are problems with dup()ing of file-descriptors for child processes.
115 * We have to somehow accomplish that the FILE* fp makes itself comfortable
116 * with the *real* offset of the underlaying file descriptor.
117 * POSIX Issue 7 overloaded fflush(3): if used on a readable stream, then
119 * if the file is not already at EOF, and the file is one capable of
120 * seeking, the file offset of the underlying open file description shall
121 * be set to the file position of the stream */
122 #if defined _POSIX_VERSION && _POSIX_VERSION + 0 >= 200809L
123 # define n_real_seek(FP,OFF,WH) (fseek(FP, OFF, WH) != -1 && fflush(FP) != EOF)
124 # define really_rewind(stream) \
131 # define n_real_seek(FP,OFF,WH) \
132 (fseek(FP, OFF, WH) != -1 && fflush(FP) != EOF &&\
133 lseek(fileno(FP), OFF, WH) != -1)
134 # define really_rewind(stream) \
138 lseek(fileno(stream), 0, SEEK_SET);\
142 /* fflush() and rewind() */
143 #define fflush_rewind(stream) \
149 /* Truncate a file to the last character written. This is useful just before
150 * closing an old file that was opened for read/write */
151 #define ftrunc(stream) \
155 off = ftell(stream);\
157 ftruncate(fileno(stream), off);\
164 /* Macros: `define', `undefine', `call' / `~' */
165 FL
int c_define(void *v
);
166 FL
int c_undefine(void *v
);
167 FL
int c_call(void *v
);
169 /* TODO Check whether a *folder-hook* exists for the currently active mailbox */
170 FL bool_t
check_folder_hook(bool_t nmail
);
172 /* TODO v15 drop Invoke compose hook macname */
173 FL
void call_compose_mode_hook(char const *macname
,
174 void (*hook_pre
)(void *), void *hook_arg
);
176 /* Accounts: `account', `unaccount' */
177 FL
int c_account(void *v
);
178 FL
int c_unaccount(void *v
);
181 FL
int c_localopts(void *v
);
183 FL
void temporary_localopts_free(void); /* XXX intermediate hack */
184 FL
void temporary_localopts_folder_hook_unroll(void); /* XXX im. hack */
186 /* Don't use n_var_* unless you *really* have to! */
188 /* Constant option key look/(un)set/clear */
189 FL
char * n_var_oklook(enum okeys okey
);
190 #define ok_blook(C) (n_var_oklook(CONCAT(ok_b_, C)) != NULL)
191 #define ok_vlook(C) n_var_oklook(CONCAT(ok_v_, C))
193 FL bool_t
n_var_okset(enum okeys okey
, uintptr_t val
);
194 #define ok_bset(C,B) n_var_okset(CONCAT(ok_b_, C), (uintptr_t)(B))
195 #define ok_vset(C,V) n_var_okset(CONCAT(ok_v_, C), (uintptr_t)(V))
197 FL bool_t
n_var_okclear(enum okeys okey
);
198 #define ok_bclear(C) n_var_okclear(CONCAT(ok_b_, C))
199 #define ok_vclear(C) n_var_okclear(CONCAT(ok_v_, C))
201 /* Variable option key look/(un)set/clear */
202 FL
char * n_var_voklook(char const *vokey
);
203 #define vok_blook(S) (n_var_voklook(S) != NULL)
204 #define vok_vlook(S) n_var_voklook(S)
206 FL bool_t
n_var_vokset(char const *vokey
, uintptr_t val
);
207 #define vok_bset(S,B) n_var_vokset(S, (uintptr_t)(B))
208 #define vok_vset(S,V) n_var_vokset(S, (uintptr_t)(V))
210 FL bool_t
n_var_vokclear(char const *vokey
);
211 #define vok_bclear(S) n_var_vokclear(S)
212 #define vok_vclear(S) n_var_vokclear(S)
214 /* Special case to handle the typical [xy-USER@HOST,] xy-HOST and plain xy
215 * variable chains; oxm is a bitmix which tells which combinations to test */
217 FL
char * n_var_xoklook(enum okeys okey
, struct url
const *urlp
,
218 enum okey_xlook_mode oxm
);
219 # define xok_BLOOK(C,URL,M) (n_var_xoklook(C, URL, M) != NULL)
220 # define xok_VLOOK(C,URL,M) n_var_xoklook(C, URL, M)
221 # define xok_blook(C,URL,M) xok_BLOOK(CONCAT(ok_b_, C), URL, M)
222 # define xok_vlook(C,URL,M) xok_VLOOK(CONCAT(ok_v_, C), URL, M)
225 /* User variable access: `set' and `unset' */
226 FL
int c_set(void *v
);
227 FL
int c_unset(void *v
);
230 FL
int c_varshow(void *v
);
232 /* Ditto: `varedit' */
233 FL
int c_varedit(void *v
);
236 FL
int c_environ(void *v
);
242 /* Try to add an attachment for file, file_expand()ed.
243 * Return the new head of list aphead, or NULL.
244 * The newly created attachment will be stored in *newap, if given */
245 FL
struct attachment
* add_attachment(enum n_lexinput_flags lif
,
246 struct attachment
*aphead
, char *file
,
247 struct attachment
**newap
);
249 /* Append comma-separated list of file names to the end of attachment list */
250 FL
void append_attachments(enum n_lexinput_flags lif
,
251 struct attachment
**aphead
, char *names
);
253 /* Interactively edit the attachment list */
254 FL
void edit_attachments(enum n_lexinput_flags lif
,
255 struct attachment
**aphead
);
261 /* Compute screen size */
262 FL
int screensize(void);
264 /* Get our $PAGER; if env_addon is not NULL it is checked whether we know about
265 * some environment variable that supports colour+ and set *env_addon to that,
266 * e.g., "LESS=FRSXi" */
267 FL
char const *n_pager_get(char const **env_addon
);
269 /* Use a pager or STDOUT to print *fp*; if *lines* is 0, they'll be counted */
270 FL
void page_or_print(FILE *fp
, size_t lines
);
272 /* Parse name and guess at the required protocol */
273 FL
enum protocol
which_protocol(char const *name
);
275 /* Hexadecimal itoa (NUL terminates) / atoi (-1 on error) */
276 FL
char * n_c_to_hex_base16(char store
[3], char c
);
277 FL si32_t
n_c_from_hex_base16(char const hex
[2]);
279 /* Hash the passed string -- uses Chris Torek's hash algorithm.
280 * i*() hashes case-insensitively (ASCII), and *n() uses maximally len bytes;
281 * if len is UIZ_MAX, we go .), since we anyway stop for NUL */
282 FL ui32_t
torek_hash(char const *name
);
283 FL ui32_t
torek_ihashn(char const *dat
, size_t len
);
285 /* Find a prime greater than n */
286 FL ui32_t
nextprime(ui32_t n
);
288 /* Get *prompt*, or '& ' if *bsdcompat*, of '? ' otherwise */
289 FL
char * getprompt(void);
291 /* Return the name of the dead.letter file */
292 FL
char const * n_getdeadletter(void);
294 /* Detect and query the hostname to use */
295 FL
char * nodename(int mayoverride
);
297 /* Get a (pseudo) random string of *length* bytes; returns salloc()ed buffer */
298 FL
char * getrandstring(size_t length
);
300 /* Check whether the argument string is a true (1) or false (0) boolean, or an
301 * invalid string, in which case -1 is returned; if emptyrv is not -1 then it,
302 * treated as a boolean, is used as the return value shall inbuf be empty.
303 * inlen may be UIZ_MAX to force strlen() detection */
304 FL si8_t
boolify(char const *inbuf
, uiz_t inlen
, si8_t emptyrv
);
306 /* Dig a "quadoption" in inbuf (possibly going through getapproval() in
307 * interactive mode). Returns a boolean or -1 if inbuf content is invalid;
308 * if emptyrv is not -1 then it, treated as a boolean, is used as the return
309 * value shall inbuf be empty. If prompt is set it is printed first if intera.
310 * inlen may be UIZ_MAX to force strlen() detection */
311 FL si8_t
quadify(char const *inbuf
, uiz_t inlen
, char const *prompt
,
314 /* Is the argument "all" (case-insensitive) or "*" */
315 FL bool_t
n_is_all_or_aster(char const *name
);
317 /* Get seconds since epoch */
318 FL
time_t n_time_epoch(void);
320 /* Update *tc* to now; only .tc_time updated unless *full_update* is true */
321 FL
void time_current_update(struct time_current
*tc
,
324 /* Returns 0 if fully slept, number of millis left if ignint is true and we
325 * were interrupted. Actual resolution may be second or less.
326 * Note in case of HAVE_SLEEP this may be SIGALARM based. */
327 FL uiz_t
n_msleep(uiz_t millis
, bool_t ignint
);
329 /* Our error print series.. Note: these reverse scan format in order to know
330 * whether a newline was included or not -- this affects the output! */
331 FL
void n_err(char const *format
, ...);
332 FL
void n_verr(char const *format
, va_list ap
);
334 /* ..(for use in a signal handler; to be obsoleted..).. */
335 FL
void n_err_sighdl(char const *format
, ...);
337 /* Our perror(3); if errval is 0 errno(3) is used; newline appended */
338 FL
void n_perr(char const *msg
, int errval
);
340 /* Announce a fatal error (and die); newline appended */
341 FL
void n_alert(char const *format
, ...);
342 FL
void n_panic(char const *format
, ...);
346 FL
int c_errors(void *vp
);
348 # define c_errors c_cmdnotsupp
355 FL
int c_cmdnotsupp(void *v
);
357 /* `headers' (show header group, possibly after setting dot) */
358 FL
int c_headers(void *v
);
360 /* Like c_headers(), but pre-prepared message vector */
361 FL
int print_header_group(int *vector
);
363 /* Scroll to the next/previous screen */
364 FL
int c_scroll(void *v
);
365 FL
int c_Scroll(void *v
);
367 /* Print out the headlines for each message in the passed message list */
368 FL
int c_from(void *v
);
370 /* Print all message in between and including bottom and topx if they are
371 * visible and either only_marked is false or they are MMARKed */
372 FL
void print_headers(size_t bottom
, size_t topx
, bool_t only_marked
);
374 /* Print out the value of dot */
375 FL
int c_pdot(void *v
);
377 /* Paginate messages, honor/don't honour ignored fields, respectively */
378 FL
int c_more(void *v
);
379 FL
int c_More(void *v
);
381 /* Type out messages, honor/don't honour ignored fields, respectively */
382 FL
int c_type(void *v
);
383 FL
int c_Type(void *v
);
385 /* Show MIME-encoded message text, including all fields */
386 FL
int c_show(void *v
);
388 /* Pipe messages, honor/don't honour ignored fields, respectively */
389 FL
int c_pipe(void *v
);
390 FL
int c_Pipe(void *v
);
392 /* Print the first *toplines* of each desired message */
393 FL
int c_top(void *v
);
394 FL
int c_Top(void *v
);
396 /* List the folders the user currently has */
397 FL
int c_folders(void *v
);
403 /* If any arguments were given, go to the next applicable argument following
404 * dot, otherwise, go to the next applicable message. If given as first
405 * command with no arguments, print first message */
406 FL
int c_next(void *v
);
408 /* Move the dot up or down by one message */
409 FL
int c_dotmove(void *v
);
411 /* Save a message in a file. Mark the message as saved so we can discard when
413 FL
int c_save(void *v
);
414 FL
int c_Save(void *v
);
416 /* Copy a message to a file without affected its saved-ness */
417 FL
int c_copy(void *v
);
418 FL
int c_Copy(void *v
);
420 /* Move a message to a file */
421 FL
int c_move(void *v
);
422 FL
int c_Move(void *v
);
424 /* Decrypt and copy a message to a file */
425 FL
int c_decrypt(void *v
);
426 FL
int c_Decrypt(void *v
);
428 /* Write the indicated messages at the end of the passed file name, minus
429 * header and trailing blank line. This is the MIME save function */
430 FL
int c_write(void *v
);
432 /* Delete messages */
433 FL
int c_delete(void *v
);
435 /* Delete messages, then type the new dot */
436 FL
int c_deltype(void *v
);
438 /* Undelete the indicated messages */
439 FL
int c_undelete(void *v
);
441 /* Touch all the given messages so that they will get mboxed */
442 FL
int c_stouch(void *v
);
444 /* Make sure all passed messages get mboxed */
445 FL
int c_mboxit(void *v
);
447 /* Preserve messages, so that they will be sent back to the system mailbox */
448 FL
int c_preserve(void *v
);
450 /* Mark all given messages as unread */
451 FL
int c_unread(void *v
);
453 /* Mark all given messages as read */
454 FL
int c_seen(void *v
);
456 /* Message flag manipulation */
457 FL
int c_flag(void *v
);
458 FL
int c_unflag(void *v
);
459 FL
int c_answered(void *v
);
460 FL
int c_unanswered(void *v
);
461 FL
int c_draft(void *v
);
462 FL
int c_undraft(void *v
);
468 /* Process a shell escape by saving signals, ignoring signals and a sh -c */
469 FL
int c_shell(void *v
);
471 /* Fork an interactive shell */
472 FL
int c_dosh(void *v
);
474 /* Show the help screen */
475 FL
int c_help(void *v
);
477 /* Print user's working directory */
478 FL
int c_cwd(void *v
);
480 /* Change user's working directory */
481 FL
int c_chdir(void *v
);
483 /* All thinkable sorts of `reply' / `respond' and `followup'.. */
484 FL
int c_reply(void *v
);
485 FL
int c_replyall(void *v
);
486 FL
int c_replysender(void *v
);
487 FL
int c_Reply(void *v
);
488 FL
int c_followup(void *v
);
489 FL
int c_followupall(void *v
);
490 FL
int c_followupsender(void *v
);
491 FL
int c_Followup(void *v
);
493 /* ..and a mailing-list reply */
494 FL
int c_Lreply(void *v
);
496 /* The 'forward' command */
497 FL
int c_forward(void *v
);
499 /* Similar to forward, saving the message in a file named after the first
501 FL
int c_Forward(void *v
);
503 /* Resend a message list to a third person */
504 FL
int c_resend(void *v
);
506 /* Resend a message list to a third person without adding headers */
507 FL
int c_Resend(void *v
);
509 /* Print the size of each message */
510 FL
int c_messize(void *v
);
512 /* `file' (`folder') and `File' (`Folder') */
513 FL
int c_file(void *v
);
514 FL
int c_File(void *v
);
516 /* Expand file names like echo */
517 FL
int c_echo(void *v
);
519 /* 'newmail' command: Check for new mail without writing old mail back */
520 FL
int c_newmail(void *v
);
523 FL
int c_noop(void *v
);
526 FL
int c_remove(void *v
);
529 FL
int c_rename(void *v
);
531 /* `urlencode' and `urldecode' */
532 FL
int c_urlencode(void *v
);
533 FL
int c_urldecode(void *v
);
539 /* Scan out the list of string arguments according to rm, return -1 on error;
540 * res_dat is NULL terminated unless res_size is 0 or error occurred */
541 FL
int getrawlist(bool_t wysh
, char **res_dat
, size_t res_size
,
542 char const *line
, size_t linesize
);
544 /* Scan an entire command argument line, return whether result can be used,
545 * otherwise no resources are allocated (in ->cac_arg).
546 * For _WYSH arguments the flags _TRIMSPACE and _LOG are implicit */
547 FL bool_t
n_cmd_arg_parse(struct n_cmd_arg_ctx
*cacp
);
549 /* Join all the _GREEDY arguments that were seen into a single string.
550 * Asserted they are string-based. The data (if any) is appended to store */
551 FL
struct n_string
*n_cmd_arg_join_greedy(struct n_cmd_arg_ctx
const *cacp
,
552 struct n_string
*store
);
558 /* if.elif.else.endif conditional execution.
559 * condstack_isskip() returns whether the current condition state doesn't allow
560 * execution of commands.
561 * condstack_release() and condstack_take() rotate the current condition stack;
562 * condstack_take() returns a false boolean if the current condition stack has
563 * unclosed conditionals */
564 FL
int c_if(void *v
);
565 FL
int c_elif(void *v
);
566 FL
int c_else(void *v
);
567 FL
int c_endif(void *v
);
568 FL bool_t
condstack_isskip(void);
569 FL
void * condstack_release(void);
570 FL bool_t
condstack_take(void *self
);
577 * If quotefile is (char*)-1, stdin will be used, caller has to verify that
578 * we're not running in interactive mode */
579 FL
FILE * collect(struct header
*hp
, int printheaders
, struct message
*mp
,
580 char *quotefile
, int doprefix
, si8_t
*checkaddr_err
);
588 FL
int c_colour(void *v
);
589 FL
int c_uncolour(void *v
);
591 /* We want coloured output (in this salloc() cycle). pager_used is used to
592 * test whether *colour-pager* is to be inspected.
593 * The push/pop functions deal with recursive execute()ions, for now. TODO
594 * env_gut() will reset() as necessary */
595 FL
void n_colour_env_create(enum n_colour_ctx cctx
, bool_t pager_used
);
596 FL
void n_colour_env_push(void);
597 FL
void n_colour_env_pop(bool_t any_env_till_root
);
598 FL
void n_colour_env_gut(FILE *fp
);
600 /* Putting anything (for pens: including NULL) resets current state first */
601 FL
void n_colour_put(FILE *fp
, enum n_colour_id cid
, char const *ctag
);
602 FL
void n_colour_reset(FILE *fp
);
604 /* Of course temporary only and may return NULL. Doesn't affect state! */
605 FL
struct str
const *n_colour_reset_to_str(void);
607 /* A pen is bound to its environment and automatically reclaimed; it may be
608 * NULL but that can be used anyway for simplicity.
609 * This includes pen_to_str() -- which doesn't affect state! */
610 FL
struct n_colour_pen
*n_colour_pen_create(enum n_colour_id cid
,
612 FL
void n_colour_pen_put(struct n_colour_pen
*self
, FILE *fp
);
614 FL
struct str
const *n_colour_pen_to_str(struct n_colour_pen
*self
);
616 #else /* HAVE_COLOUR */
617 # define c_colour c_cmdnotsupp
618 # define c_uncolour c_cmdnotsupp
619 # define c_mono c_cmdnotsupp
620 # define c_unmono c_cmdnotsupp
627 /* Aquire a flt lock and create a dotlock file; upon success a registered
628 * control-pipe FILE* is returned that keeps the link in between us and the
629 * lock-holding fork(2)ed subprocess (which conditionally replaced itself via
630 * execv(2) with the privilege-separated dotlock helper program): the lock file
631 * will be removed once the control pipe is closed via Pclose().
632 * Will try FILE_LOCK_TRIES times if pollmsecs > 0 (once otherwise).
633 * If pollmsecs is UIZ_MAX, FILE_LOCK_MILLIS is used.
634 * If *dotlock_ignore_error* is set (FILE*)-1 will be returned if at least the
635 * normal file lock could be established, otherwise errno is usable on error */
636 FL
FILE * n_dotlock(char const *fname
, int fd
, enum n_file_lock_type flt
,
637 off_t off
, off_t len
, size_t pollmsecs
);
643 /* Edit a message list */
644 FL
int c_editor(void *v
);
646 /* Invoke the visual editor on a message list */
647 FL
int c_visual(void *v
);
649 /* Run an editor on either size bytes of the file fp (or until EOF if size is
650 * negative) or on the message mp, and return a new file or NULL on error of if
651 * the user didn't perform any edits.
652 * For now we assert that mp==NULL if hp!=NULL, treating this as a special call
653 * from within compose mode, and giving TRUM1 to puthead().
654 * Signals must be handled by the caller. viored is 'e' for ed, 'v' for vi */
655 FL
FILE * run_editor(FILE *fp
, off_t size
, int viored
, int readonly
,
656 struct header
*hp
, struct message
*mp
,
657 enum sendaction action
, sighandler_type oldint
);
664 FL
struct quoteflt
* quoteflt_dummy(void); /* TODO LEGACY */
665 FL
void quoteflt_init(struct quoteflt
*self
, char const *prefix
);
666 FL
void quoteflt_destroy(struct quoteflt
*self
);
667 FL
void quoteflt_reset(struct quoteflt
*self
, FILE *f
);
668 FL ssize_t
quoteflt_push(struct quoteflt
*self
, char const *dat
,
670 FL ssize_t
quoteflt_flush(struct quoteflt
*self
);
672 /* (Primitive) HTML tagsoup filter */
673 #ifdef HAVE_FILTER_HTML_TAGSOUP
674 /* TODO Because we don't support filter chains yet this filter will be run
675 * TODO in a dedicated subprocess, driven via a special Popen() mode */
676 FL
int htmlflt_process_main(void);
678 FL
void htmlflt_init(struct htmlflt
*self
);
679 FL
void htmlflt_destroy(struct htmlflt
*self
);
680 FL
void htmlflt_reset(struct htmlflt
*self
, FILE *f
);
681 FL ssize_t
htmlflt_push(struct htmlflt
*self
, char const *dat
, size_t len
);
682 FL ssize_t
htmlflt_flush(struct htmlflt
*self
);
689 /* fgets() replacement to handle lines of arbitrary size and with embedded \0
691 * line - line buffer. *line may be NULL.
692 * linesize - allocated size of line buffer.
693 * count - maximum characters to read. May be NULL.
694 * llen - length_of_line(*line).
696 * appendnl - always terminate line with \n, append if necessary.
697 * Manages the PS_READLINE_NL hack */
698 FL
char * fgetline(char **line
, size_t *linesize
, size_t *count
,
699 size_t *llen
, FILE *fp
, int appendnl SMALLOC_DEBUG_ARGS
);
700 #ifdef HAVE_MEMORY_DEBUG
701 # define fgetline(A,B,C,D,E,F) \
702 fgetline(A, B, C, D, E, F, __FILE__, __LINE__)
705 /* Read up a line from the specified input into the linebuffer.
706 * Return the number of characters read. Do not include the newline at EOL.
707 * n is the number of characters already read and present in *linebuf; it'll be
708 * treated as _the_ line if no more (successful) reads are possible.
709 * Manages the PS_READLINE_NL hack */
710 FL
int readline_restart(FILE *ibuf
, char **linebuf
, size_t *linesize
,
711 size_t n SMALLOC_DEBUG_ARGS
);
712 #ifdef HAVE_MEMORY_DEBUG
713 # define readline_restart(A,B,C,D) \
714 readline_restart(A, B, C, D, __FILE__, __LINE__)
717 /* Set up the input pointers while copying the mail file into /tmp */
718 FL
void setptr(FILE *ibuf
, off_t offset
);
720 /* Determine the size of the file possessed by the passed buffer */
721 FL off_t
fsize(FILE *iob
);
723 /* Will retry FILE_LOCK_RETRIES times if pollmsecs > 0.
724 * If pollmsecs is UIZ_MAX, FILE_LOCK_MILLIS is used */
725 FL bool_t
n_file_lock(int fd
, enum n_file_lock_type flt
,
726 off_t off
, off_t len
, size_t pollmsecs
);
732 /* Set up editing on the given file name.
733 * If the first character of name is %, we are considered to be editing the
734 * file, otherwise we are reading our mail which has signficance for mbox and
736 FL
int setfile(char const *name
, enum fedit_mode fm
);
738 FL
int newmailinfo(int omsgCount
);
740 /* Set the size of the message vector used to construct argument lists to
741 * message list functions */
742 FL
void setmsize(int sz
);
744 /* Logic behind -H / -L invocations */
745 FL
void print_header_summary(char const *Larg
);
747 /* Announce the presence of the current Mail version, give the message count,
748 * and print a header listing */
749 FL
void announce(int printheaders
);
751 /* Announce information about the file we are editing. Return a likely place
753 FL
int newfileinfo(void);
755 FL
int getmdot(int nmail
);
757 FL
void initbox(char const *name
);
759 /* Determine and expand the current *folder* name, return it or the empty
760 * string also in case of errors: since POSIX mandates a default of CWD if not
761 * set etc., that seems to be a valid fallback, then */
762 FL
char const *folder_query(void);
768 /* Return the user's From: address(es) */
769 FL
char const * myaddrs(struct header
*hp
);
771 /* Boil the user's From: addresses down to a single one, or use *sender* */
772 FL
char const * myorigin(struct header
*hp
);
774 /* See if the passed line buffer, which may include trailing newline (sequence)
775 * is a mail From_ header line according to RFC 4155.
776 * If compat is true laxe POSIX syntax is instead sufficient to match From_ */
777 FL
int is_head(char const *linebuf
, size_t linelen
, bool_t compat
);
779 /* Savage extract date field from From_ line. linelen is convenience as line
780 * must be terminated (but it may end in a newline [sequence]).
781 * Return whether the From_ line was parsed successfully */
782 FL
int extract_date_from_from_(char const *line
, size_t linelen
,
783 char datebuf
[FROM_DATEBUF
]);
785 /* Extract some header fields (see e.g. -t documentation) from a message.
786 * If options&OPT_t_FLAG *and* pstate&PS_t_FLAG are both set a number of
787 * additional header fields are understood and address joining is performed as
788 * necessary, and the subject is treated with additional care, too.
789 * If pstate&PS_t_FLAG is set but OPT_t_FLAG is no more, From: will not be
791 * This calls expandaddr() on some headers and sets checkaddr_err if that is
792 * not NULL -- note it explicitly allows EAF_NAME because aliases are not
793 * expanded when this is called! */
794 FL
void extract_header(FILE *fp
, struct header
*hp
,
795 si8_t
*checkaddr_err
);
797 /* Return the desired header line from the passed message
798 * pointer (or NULL if the desired header field is not available).
799 * If mult is zero, return the content of the first matching header
800 * field only, the content of all matching header fields else */
801 FL
char * hfield_mult(char const *field
, struct message
*mp
, int mult
);
802 #define hfieldX(a, b) hfield_mult(a, b, 1)
803 #define hfield1(a, b) hfield_mult(a, b, 0)
805 /* Check whether the passed line is a header line of the desired breed.
806 * Return the field body, or 0 */
807 FL
char const * thisfield(char const *linebuf
, char const *field
);
809 /* Get sender's name from this message. If the message has a bunch of arpanet
810 * stuff in it, we may have to skin the name before returning it */
811 FL
char * nameof(struct message
*mp
, int reptype
);
813 /* Start of a "comment". Ignore it */
814 FL
char const * skip_comment(char const *cp
);
816 /* Return the start of a route-addr (address in angle brackets), if present */
817 FL
char const * routeaddr(char const *name
);
819 /* Query *expandaddr*, parse it and return flags.
820 * The flags are already adjusted for OPT_INTERACTIVE / OPT_TILDE_FLAG etc. */
821 FL
enum expand_addr_flags
expandaddr_to_eaf(void);
823 /* Check if an address is invalid, either because it is malformed or, if not,
824 * according to eacm. Return FAL0 when it looks good, TRU1 if it is invalid
825 * but the error condition wasn't covered by a 'hard "fail"ure', -1 otherwise */
826 FL si8_t
is_addr_invalid(struct name
*np
,
827 enum expand_addr_check_mode eacm
);
829 /* Does *NP* point to a file or pipe addressee? */
830 #define is_fileorpipe_addr(NP) \
831 (((NP)->n_flags & NAME_ADDRSPEC_ISFILEORPIPE) != 0)
833 /* Return skinned version of *NP*s name */
834 #define skinned_name(NP) \
835 (assert((NP)->n_flags & NAME_SKINNED), \
836 ((struct name const*)NP)->n_name)
838 /* Skin an address according to the RFC 822 interpretation of "host-phrase" */
839 FL
char * skin(char const *name
);
841 /* Skin *name* and extract the *addr-spec* according to RFC 5322.
842 * Store the result in .ag_skinned and also fill in those .ag_ fields that have
843 * actually been seen.
844 * Return 0 if something good has been parsed, 1 if fun didn't exactly know how
845 * to deal with the input, or if that was plain invalid */
846 FL
int addrspec_with_guts(int doskin
, char const *name
,
847 struct addrguts
*agp
);
849 /* Fetch the real name from an internet mail address field */
850 FL
char * realname(char const *name
);
852 /* Fetch the sender's name from the passed message. reptype can be
853 * 0 -- get sender's name for display purposes
854 * 1 -- get sender's name for reply
855 * 2 -- get sender's name for Reply */
856 FL
char * name1(struct message
*mp
, int reptype
);
858 /* Trim away all leading Re: etc., return pointer to plain subject.
859 * Note it doesn't perform any MIME decoding by itself */
860 FL
char * subject_re_trim(char *cp
);
862 FL
int msgidcmp(char const *s1
, char const *s2
);
864 /* Fake Sender for From_ lines if missing, e. g. with POP3 */
865 FL
char const * fakefrom(struct message
*mp
);
867 FL
char const * fakedate(time_t t
);
869 /* From username Fri Jan 2 20:13:51 2004
872 #ifdef HAVE_IMAP_SEARCH
873 FL
time_t unixtime(char const *from
);
876 FL
time_t rfctime(char const *date
);
878 FL
time_t combinetime(int year
, int month
, int day
,
879 int hour
, int minute
, int second
);
881 FL
void substdate(struct message
*m
);
883 /* TODO Weird thing that tries to fill in From: and Sender: */
884 FL
void setup_from_and_sender(struct header
*hp
);
886 /* Note: returns 0x1 if both args were NULL */
887 FL
struct name
const * check_from_and_sender(struct name
const *fromfield
,
888 struct name
const *senderfield
);
891 FL
char * getsender(struct message
*m
);
894 /* Fill in / reedit the desired header fields */
895 FL
int grab_headers(enum n_lexinput_flags lif
, struct header
*hp
,
896 enum gfield gflags
, int subjfirst
);
898 /* Check whether sep->ss_sexpr (or ->ss_regex) matches any header of mp */
899 FL bool_t
header_match(struct message
*mp
, struct search_expr
const *sep
);
905 /* Add the given header fields to the retained list. If no arguments, print
906 * the current list of retained fields */
907 FL
int c_retfield(void *v
);
909 /* Add the given header fields to the ignored list. If no arguments, print the
910 * current list of ignored fields */
911 FL
int c_igfield(void *v
);
913 FL
int c_saveretfield(void *v
);
914 FL
int c_saveigfield(void *v
);
915 FL
int c_fwdretfield(void *v
);
916 FL
int c_fwdigfield(void *v
);
917 FL
int c_unignore(void *v
);
918 FL
int c_unretain(void *v
);
919 FL
int c_unsaveignore(void *v
);
920 FL
int c_unsaveretain(void *v
);
921 FL
int c_unfwdignore(void *v
);
922 FL
int c_unfwdretain(void *v
);
924 /* See if the given header field (not NUL terminated) is to be ignored.
925 * For igta: [0] is ignore, [1] is retain -- TODO magic, enwrap in outer obj! */
926 FL
int is_ign(char const *field
, size_t fieldlen
,
927 struct ignoretab igta
[2]);
929 /* Future object stuff */
931 /* Ignore hashtable lifecycle.
932 * isauto: whether auto-reclaimed storage is to be used for allocating childs;
933 * if so, _gut() needn't be called */
934 FL
struct ignoretab
*n_ignoretab_creat(struct ignoretab
*self
, bool_t isauto
);
935 FL
void n_ignoretab_gut(struct ignoretab
*self
);
937 /* Set an entry in an ignore hashtable.
938 * Returns FAL0 if cp is not a valid header field name, TRU1 if insertion took
939 * place and TRUM1 if cp is already part of self */
940 FL bool_t
n_ignoretab_insert(struct ignoretab
*self
, char const *dat
,
942 #define n_ignoretab_insert_cp(SELF,CP) n_ignoretab_insert(SELF, CP, UIZ_MAX)
945 FL bool_t
n_ignoretab_lookup(struct ignoretab
*self
, char const *dat
,
947 #define n_ignoretab_lookup_cp(SELF,CP) n_ignoretab_lookup(SELF, CP, UIZ_MAX)
953 #ifdef HAVE_IMAP_SEARCH
954 FL
enum okay
imap_search(char const *spec
, int f
);
961 /* Print the docstring of `comm', which may be an abbreviation.
962 * Return FAL0 if there is no such command */
963 #ifdef HAVE_DOCSTRINGS
964 FL bool_t
n_print_comm_docstr(char const *comm
);
967 /* Interpret user commands. If stdin is not a tty, print no prompt; return
968 * whether last processed command returned error; this is *only* for main()! */
969 FL bool_t
n_commands(void);
971 /* Actual cmd input */
973 /* Read a complete line of input, with editing if interactive and possible.
974 * If prompt is NULL we'll call getprompt() first, if necessary.
975 * If string is set it is used as the initial line content if in interactive
976 * mode, otherwise this argument is ignored for reproducibility.
977 * Return number of octets or a value <0 on error.
978 * Note: may use the currently `source'd file stream instead of stdin!
979 * Manages the PS_READLINE_NL hack */
980 FL
int n_lex_input(enum n_lexinput_flags lif
, char const *prompt
,
981 char **linebuf
, size_t *linesize
, char const *string
983 #ifdef HAVE_MEMORY_DEBUG
984 # define n_lex_input(A,B,C,D,E) n_lex_input(A,B,C,D,E,__FILE__,__LINE__)
987 /* Read a line of input, with editing if interactive and possible, return it
988 * savestr()d or NULL in case of errors or if an empty line would be returned.
989 * This may only be called from toplevel (not during PS_ROBOT).
990 * If prompt is NULL we'll call getprompt() if necessary.
991 * If string is set it is used as the initial line content if in interactive
992 * mode, otherwise this argument is ignored for reproducibility */
993 FL
char * n_lex_input_cp(enum n_lexinput_flags lif
,
994 char const *prompt
, char const *string
);
996 /* Deal with loading of resource files and dealing with a stack of files for
997 * the source command */
999 /* Load a file of user definitions -- this is *only* for main()! */
1000 FL
void n_load(char const *name
);
1002 /* "Load" all the -X command line definitions in order -- *only* for main() */
1003 FL
void n_load_Xargs(char const **lines
);
1005 /* Pushdown current input file and switch to a new one. Set the global flag
1006 * PS_SOURCING so that others will realize that they are no longer reading from
1007 * a tty (in all probability).
1008 * The latter won't return failure (TODO should be replaced by "-f FILE") */
1009 FL
int c_source(void *v
);
1010 FL
int c_source_if(void *v
);
1012 /* Evaluate a complete macro / a single command. For the former lines will
1013 * always be free()d, for the latter cmd will always be duplicated internally */
1014 FL bool_t
n_source_macro(enum n_lexinput_flags lif
, char const *name
,
1016 FL bool_t
n_source_command(enum n_lexinput_flags lif
, char const *cmd
);
1018 /* XXX Hack: may we release our (interactive) (terminal) control to a different
1019 * XXX program, e.g., a $PAGER? */
1020 FL bool_t
n_source_may_yield_control(void);
1026 /* Return a file buffer all ready to read up the passed message pointer */
1027 FL
FILE * setinput(struct mailbox
*mp
, struct message
*m
,
1028 enum needspec need
);
1031 FL
enum okay
get_body(struct message
*mp
);
1033 /* Reset (free) the global message array */
1034 FL
void message_reset(void);
1036 /* Append the passed message descriptor onto the message array; if mp is NULL,
1037 * NULLify the entry at &[msgCount-1] */
1038 FL
void message_append(struct message
*mp
);
1040 /* Append a NULL message */
1041 FL
void message_append_null(void);
1043 /* Check whether sep->ss_sexpr (or ->ss_regex) matches mp. If with_headers is
1044 * true then the headers will also be searched (as plain text) */
1045 FL bool_t
message_match(struct message
*mp
, struct search_expr
const *sep
,
1046 bool_t with_headers
);
1049 FL
struct message
* setdot(struct message
*mp
);
1051 /* Touch the named message by setting its MTOUCH flag. Touched messages have
1052 * the effect of not being sent back to the system mailbox on exit */
1053 FL
void touch(struct message
*mp
);
1055 /* Convert user string of message numbers and store the numbers into vector.
1056 * Returns the count of messages picked up or -1 on error */
1057 FL
int getmsglist(char *buf
, int *vector
, int flags
);
1059 /* Find the first message whose flags&m==f and return its message number */
1060 FL
int first(int f
, int m
);
1062 /* Mark the named message by setting its mark bit */
1063 FL
void mark(int mesg
, int f
);
1069 FL
int maildir_setfile(char const *name
, enum fedit_mode fm
);
1071 FL bool_t
maildir_quit(void);
1073 FL
enum okay
maildir_append(char const *name
, FILE *fp
, long offset
);
1075 FL
enum okay
maildir_remove(char const *name
);
1081 /* Quit quickly. In recursed state, return error to just pop the input level */
1082 FL
int c_exit(void *v
);
1088 /* Try to use alloca() for some function-local buffers and data, fall back to
1089 * smalloc()/free() if not available */
1092 # define ac_alloc(n) HAVE_ALLOCA(n)
1093 # define ac_free(n) do {UNUSED(n);} while (0)
1095 # define ac_alloc(n) smalloc(n)
1096 # define ac_free(n) free(n)
1099 /* Generic heap memory */
1101 FL
void * smalloc(size_t s SMALLOC_DEBUG_ARGS
);
1102 FL
void * srealloc(void *v
, size_t s SMALLOC_DEBUG_ARGS
);
1103 FL
void * scalloc(size_t nmemb
, size_t size SMALLOC_DEBUG_ARGS
);
1105 #ifdef HAVE_MEMORY_DEBUG
1106 FL
void sfree(void *v SMALLOC_DEBUG_ARGS
);
1108 /* Called by sreset(), then */
1109 FL
void n_memreset(void);
1111 FL
int c_memtrace(void *v
);
1113 /* For immediate debugging purposes, it is possible to check on request */
1114 FL bool_t
n__memcheck(char const *file
, int line
);
1116 # define smalloc(SZ) smalloc(SZ, __FILE__, __LINE__)
1117 # define srealloc(P,SZ) srealloc(P, SZ, __FILE__, __LINE__)
1118 # define scalloc(N,SZ) scalloc(N, SZ, __FILE__, __LINE__)
1119 # define free(P) sfree(P, __FILE__, __LINE__)
1120 # define c_memtrace c_memtrace
1121 # define n_memcheck() n__memcheck(__FILE__, __LINE__)
1123 # define n_memreset() do{}while(0)
1126 /* String storage, auto-reclaimed after execution level is left */
1128 /* Allocate size more bytes of space and return the address of the first byte
1129 * to the caller. An even number of bytes are always allocated so that the
1130 * space will always be on a word boundary */
1131 FL
void * salloc(size_t size SALLOC_DEBUG_ARGS
);
1132 FL
void * csalloc(size_t nmemb
, size_t size SALLOC_DEBUG_ARGS
);
1133 #ifdef HAVE_MEMORY_DEBUG
1134 # define salloc(SZ) salloc(SZ, __FILE__, __LINE__)
1135 # define csalloc(NM,SZ) csalloc(NM, SZ, __FILE__, __LINE__)
1138 /* Auto-reclaim string storage; if only_if_relaxed is true then only perform
1139 * the reset when a srelax_hold() is currently active */
1140 FL
void sreset(bool_t only_if_relaxed
);
1142 /* The "problem" with sreset() is that it releases all string storage except
1143 * what was present once spreserve() had been called; it therefore cannot be
1144 * called from all that code which yet exists and walks about all the messages
1145 * in order, e.g. quit(), searches, etc., because, unfortunately, these code
1146 * paths are reached with new intermediate string dope already in use.
1147 * Thus such code should take a srelax_hold(), successively call srelax() after
1148 * a single message has been handled, and finally srelax_rele() (unless it is
1149 * clear that sreset() occurs anyway) */
1150 FL
void srelax_hold(void);
1151 FL
void srelax_rele(void);
1152 FL
void srelax(void);
1154 /* Make current string storage permanent: new allocs will be auto-reclaimed by
1155 * sreset(). This is called once only, from within main() */
1156 FL
void spreserve(void);
1158 /* 'sstats' command */
1159 #ifdef HAVE_MEMORY_DEBUG
1160 FL
int c_sstats(void *v
);
1161 # define c_sstats c_sstats
1168 /* *charset-7bit*, else CHARSET_7BIT */
1169 FL
char const * charset_get_7bit(void);
1171 /* *charset-8bit*, else CHARSET_8BIT */
1173 FL
char const * charset_get_8bit(void);
1176 /* LC_CTYPE:CODESET / *ttycharset*, else *charset-8bit*, else CHARSET_8BIT */
1177 FL
char const * charset_get_lc(void);
1179 /* *sendcharsets* .. *charset-8bit* iterator; *a_charset_to_try_first* may be
1180 * used to prepend a charset to this list (e.g., for *reply-in-same-charset*).
1181 * The returned boolean indicates charset_iter_is_valid().
1182 * Without HAVE_ICONV, this "iterates" over charset_get_lc() only */
1183 FL bool_t
charset_iter_reset(char const *a_charset_to_try_first
);
1184 FL bool_t
charset_iter_next(void);
1185 FL bool_t
charset_iter_is_valid(void);
1186 FL
char const * charset_iter(void);
1188 /* And this is (xxx temporary?) which returns the iterator if that is valid and
1189 * otherwise either charset_get_8bit() or charset_get_lc() dep. on HAVE_ICONV */
1190 FL
char const * charset_iter_or_fallback(void);
1192 FL
void charset_iter_recurse(char *outer_storage
[2]); /* TODO LEGACY */
1193 FL
void charset_iter_restore(char *outer_storage
[2]); /* TODO LEGACY */
1195 /* Check whether our headers will need MIME conversion */
1197 FL
char const * need_hdrconv(struct header
*hp
);
1200 /* Convert header fields from RFC 1522 format */
1201 FL
void mime_fromhdr(struct str
const *in
, struct str
*out
,
1202 enum tdflags flags
);
1204 /* Interpret MIME strings in parts of an address field */
1205 FL
char * mime_fromaddr(char const *name
);
1207 /* fwrite(3) performing the given MIME conversion */
1208 FL ssize_t
mime_write(char const *ptr
, size_t size
, FILE *f
,
1209 enum conversion convert
, enum tdflags dflags
,
1210 struct quoteflt
*qf
, struct str
*rest
);
1211 FL ssize_t
xmime_write(char const *ptr
, size_t size
, /* TODO LEGACY */
1212 FILE *f
, enum conversion convert
, enum tdflags dflags
);
1216 * Content-Transfer-Encodings as defined in RFC 2045 (and RFC 2047):
1217 * - Quoted-Printable, section 6.7
1218 * - Base64, section 6.8
1219 * TODO for now this is pretty mixed up regarding this external interface.
1220 * TODO in v15.0 CTE will be filter based, and explicit conversion will
1221 * TODO gain clear error codes
1224 /* Default MIME Content-Transfer-Encoding: as via *encoding* */
1225 FL
enum mime_enc
mime_enc_target(void);
1227 /* Map from a Content-Transfer-Encoding: header body (which may be NULL) */
1228 FL
enum mime_enc
mime_enc_from_ctehead(char const *hbody
);
1230 /* XXX Try to get rid of that */
1231 FL
char const * mime_enc_from_conversion(enum conversion
const convert
);
1233 /* How many characters of (the complete body) ln need to be quoted.
1234 * Only MIMEEF_ISHEAD and MIMEEF_ISENCWORD are understood */
1235 FL
size_t mime_enc_mustquote(char const *ln
, size_t lnlen
,
1236 enum mime_enc_flags flags
);
1238 /* How much space is necessary to encode len bytes in QP, worst case.
1239 * Includes room for terminator */
1240 FL
size_t qp_encode_calc_size(size_t len
);
1242 /* If flags includes QP_ISHEAD these assume "word" input and use special
1243 * quoting rules in addition; soft line breaks are not generated.
1244 * Otherwise complete input lines are assumed and soft line breaks are
1245 * generated as necessary */
1246 FL
struct str
* qp_encode(struct str
*out
, struct str
const *in
,
1247 enum qpflags flags
);
1249 FL
struct str
* qp_encode_cp(struct str
*out
, char const *cp
,
1250 enum qpflags flags
);
1251 FL
struct str
* qp_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
1252 enum qpflags flags
);
1255 /* If rest is set then decoding will assume body text input (assumes input
1256 * represents lines, only create output when input didn't end with soft line
1257 * break [except it finalizes an encoded CRLF pair]), otherwise it is assumed
1258 * to decode a header strings and (1) uses special decoding rules and (b)
1259 * directly produces output.
1260 * The buffers of out and possibly rest will be managed via srealloc().
1261 * Returns OKAY. XXX or STOP on error (in which case out is set to an error
1262 * XXX message); caller is responsible to free buffers */
1263 FL
int qp_decode(struct str
*out
, struct str
const *in
,
1266 /* How much space is necessary to encode len bytes in Base64, worst case.
1267 * Includes room for (CR/LF/CRLF and) terminator */
1268 FL
size_t b64_encode_calc_size(size_t len
);
1270 /* Note these simply convert all the input (if possible), including the
1271 * insertion of NL sequences if B64_CRLF or B64_LF is set (and multiple thereof
1272 * if B64_MULTILINE is set).
1273 * Thus, in the B64_BUF case, better call b64_encode_calc_size() first */
1274 FL
struct str
* b64_encode(struct str
*out
, struct str
const *in
,
1275 enum b64flags flags
);
1276 FL
struct str
* b64_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
1277 enum b64flags flags
);
1279 FL
struct str
* b64_encode_cp(struct str
*out
, char const *cp
,
1280 enum b64flags flags
);
1283 /* If rest is set then decoding will assume text input.
1284 * The buffers of out and possibly rest will be managed via srealloc().
1285 * Returns OKAY or STOP on error (in which case out is set to an error
1286 * message); caller is responsible to free buffers.
1287 * XXX STOP is effectively not returned for text input (rest!=NULL), instead
1288 * XXX replacement characters are produced for invalid data */
1289 FL
int b64_decode(struct str
*out
, struct str
const *in
,
1296 /* Get a mime style parameter from a header body */
1297 FL
char * mime_param_get(char const *param
, char const *headerbody
);
1299 /* Format parameter name to have value, salloc() it or NULL (error) in result.
1300 * 0 on error, 1 or -1 on success: the latter if result contains \n newlines,
1301 * which it will if the created param requires more than MIME_LINELEN bytes;
1302 * there is never a trailing newline character */
1303 /* TODO mime_param_create() should return a StrList<> or something.
1304 * TODO in fact it should take a HeaderField* and append a HeaderFieldParam*! */
1305 FL si8_t
mime_param_create(struct str
*result
, char const *name
,
1308 /* Get the boundary out of a Content-Type: multipart/xyz header field, return
1309 * salloc()ed copy of it; store strlen() in *len if set */
1310 FL
char * mime_param_boundary_get(char const *headerbody
, size_t *len
);
1312 /* Create a salloc()ed MIME boundary */
1313 FL
char * mime_param_boundary_create(void);
1319 /* Create MIME part object tree for and of mp */
1320 FL
struct mimepart
* mime_parse_msg(struct message
*mp
,
1321 enum mime_parse_flags mpf
);
1327 /* `(un)?mimetype' commands */
1328 FL
int c_mimetype(void *v
);
1329 FL
int c_unmimetype(void *v
);
1331 /* Check whether the Content-Type name is internally known */
1332 FL bool_t
mime_type_check_mtname(char const *name
);
1334 /* Return a Content-Type matching the name, or NULL if none could be found */
1335 FL
char * mime_type_classify_filename(char const *name
);
1337 /* Classify content of *fp* as necessary and fill in arguments; **charset* is
1338 * left alone unless it's non-NULL */
1339 FL
enum conversion
mime_type_classify_file(FILE *fp
, char const **contenttype
,
1340 char const **charset
, int *do_iconv
);
1342 /* Dependend on *mime-counter-evidence* mpp->m_ct_type_usr_ovwr will be set,
1343 * but otherwise mpp is const */
1344 FL
enum mimecontent
mime_type_classify_part(struct mimepart
*mpp
);
1346 /* Query handler for a part, return the plain type (& MIME_HDL_TYPE_MASK).
1347 * mhp is anyway initialized (mh_flags, mh_msg) */
1348 FL
enum mime_handler_flags
mime_type_handler(struct mime_handler
*mhp
,
1349 struct mimepart
const *mpp
,
1350 enum sendaction action
);
1356 /* Allocate a single element of a name list, initialize its name field to the
1357 * passed name and return it */
1358 FL
struct name
* nalloc(char *str
, enum gfield ntype
);
1360 /* Like nalloc(), but initialize from content of np */
1361 FL
struct name
* ndup(struct name
*np
, enum gfield ntype
);
1363 /* Concatenate the two passed name lists, return the result */
1364 FL
struct name
* cat(struct name
*n1
, struct name
*n2
);
1367 FL
struct name
* namelist_dup(struct name
const *np
, enum gfield ntype
);
1369 /* Determine the number of undeleted elements in a name list and return it;
1370 * the latter also doesn't count file and pipe addressees in addition */
1371 FL ui32_t
count(struct name
const *np
);
1372 FL ui32_t
count_nonlocal(struct name
const *np
);
1374 /* Extract a list of names from a line, and make a list of names from it.
1375 * Return the list or NULL if none found */
1376 FL
struct name
* extract(char const *line
, enum gfield ntype
);
1378 /* Like extract() unless line contains anyof ",\"\\(<|", in which case
1379 * comma-separated list extraction is used instead */
1380 FL
struct name
* lextract(char const *line
, enum gfield ntype
);
1382 /* Turn a list of names into a string of the same names */
1383 FL
char * detract(struct name
*np
, enum gfield ntype
);
1385 /* Get a lextract() list via n_lex_input_cp_addhist(), reassigning to *np* */
1386 FL
struct name
* grab_names(enum n_lexinput_flags lif
, char const *field
,
1387 struct name
*np
, int comma
, enum gfield gflags
);
1389 /* Check whether n1 n2 share the domain name */
1390 FL bool_t
name_is_same_domain(struct name
const *n1
,
1391 struct name
const *n2
);
1393 /* Check all addresses in np and delete invalid ones; if set_on_error is not
1394 * NULL it'll be set to TRU1 for error or -1 for "hard fail" error */
1395 FL
struct name
* checkaddrs(struct name
*np
, enum expand_addr_check_mode eacm
,
1396 si8_t
*set_on_error
);
1398 /* Vaporise all duplicate addresses in hp (.h_(to|cc|bcc)) so that an address
1399 * that "first" occurs in To: is solely in there, ditto Cc:, after expanding
1400 * aliases etc. eacm and set_on_error are passed to checkaddrs(), metoo is
1401 * passed to usermap(). After updating hp to the new state this returns
1402 * a flat list of all addressees, which may be NULL */
1403 FL
struct name
* namelist_vaporise_head(struct header
*hp
,
1404 enum expand_addr_check_mode eacm
, bool_t metoo
,
1405 si8_t
*set_on_error
);
1407 /* Map all of the aliased users in the invoker's mailrc file and insert them
1409 FL
struct name
* usermap(struct name
*names
, bool_t force_metoo
);
1411 /* Remove all of the duplicates from the passed name list by insertion sorting
1412 * them, then checking for dups. Return the head of the new list */
1413 FL
struct name
* elide(struct name
*names
);
1415 /* `alternates' deal with the list of alternate names */
1416 FL
int c_alternates(void *v
);
1418 FL
struct name
* delete_alternates(struct name
*np
);
1420 FL
int is_myname(char const *name
);
1423 FL
int c_alias(void *v
);
1424 FL
int c_unalias(void *v
);
1426 /* `(un)?ml(ist|subscribe)', and a check whether a name is a (wanted) list */
1427 FL
int c_mlist(void *v
);
1428 FL
int c_unmlist(void *v
);
1429 FL
int c_mlsubscribe(void *v
);
1430 FL
int c_unmlsubscribe(void *v
);
1432 FL
enum mlist_state
is_mlist(char const *name
, bool_t subscribed_only
);
1434 /* `(un)?shortcut', and check if str is one, return expansion or NULL */
1435 FL
int c_shortcut(void *v
);
1436 FL
int c_unshortcut(void *v
);
1438 FL
char const * shortcut_expand(char const *str
);
1440 /* `(un)?customhdr'.
1441 * Query a list of all currently defined custom headers (salloc()ed) */
1442 FL
int c_customhdr(void *v
);
1443 FL
int c_uncustomhdr(void *v
);
1445 FL
struct n_header_field
* n_customhdr_query(void);
1453 FL
enum okay
ssl_open(struct url
const *urlp
, struct sock
*sp
);
1456 FL
void ssl_gen_err(char const *fmt
, ...);
1459 FL
int c_verify(void *vp
);
1462 FL
FILE * smime_sign(FILE *ip
, char const *addr
);
1465 FL
FILE * smime_encrypt(FILE *ip
, char const *certfile
, char const *to
);
1467 FL
struct message
* smime_decrypt(struct message
*m
, char const *to
,
1468 char const *cc
, int signcall
);
1471 FL
enum okay
smime_certsave(struct message
*m
, int n
, FILE *op
);
1473 #else /* HAVE_OPENSSL */
1474 # define c_verify c_cmdnotsupp
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(void);
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 tempdir, 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 OPT_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 EXIT_SUCCESS 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 FL bool_t
quit(void);
1617 /* Adjust the message flags in each message */
1618 FL
int holdbits(void);
1620 /* Create another temporary file and copy user's mbox file darin. If there is
1621 * no mbox, copy nothing. If he has specified "append" don't copy his mailbox,
1622 * just copy saveable entries at the end */
1623 FL
enum okay
makembox(void);
1625 FL
void save_mbox_for_possible_quitstuff(void); /* TODO DROP IF U CAN */
1627 FL
int savequitflags(void);
1629 FL
void restorequitflags(int);
1635 /* Send message described by the passed pointer to the passed output buffer.
1636 * Return -1 on error. Adjust the status: field if need be. If doign is
1637 * given, suppress ignored header fields. prefix is a string to prepend to
1638 * each output line. action = data destination
1639 * (SEND_MBOX,_TOFILE,_TODISP,_QUOTE,_DECRYPT). stats[0] is line count,
1640 * stats[1] is character count. stats may be NULL. Note that stats[0] is
1641 * valid for SEND_MBOX only */
1642 FL
int sendmp(struct message
*mp
, FILE *obuf
, struct ignoretab
*doign
,
1643 char const *prefix
, enum sendaction action
, ui64_t
*stats
);
1649 /* Interface between the argument list and the mail1 routine which does all the
1651 FL
int mail(struct name
*to
, struct name
*cc
, struct name
*bcc
,
1652 char *subject
, struct attachment
*attach
, char *quotefile
,
1653 int recipient_record
);
1655 /* `mail' and `Mail' commands, respectively */
1656 FL
int c_sendmail(void *v
);
1657 FL
int c_Sendmail(void *v
);
1659 /* Mail a message on standard input to the people indicated in the passed
1660 * header. (Internal interface) */
1661 FL
enum okay
mail1(struct header
*hp
, int printheaders
,
1662 struct message
*quote
, char *quotefile
, int recipient_record
,
1665 /* Create a Date: header field.
1666 * We compare the localtime() and gmtime() results to get the timezone, because
1667 * numeric timezones are easier to read and because $TZ isn't always set */
1668 FL
int mkdate(FILE *fo
, char const *field
);
1670 /* Dump the to, subject, cc header on the passed file buffer.
1671 * nosend_msg tells us not to dig to deep but to instead go for compose mode or
1672 * editing a message (yet we're stupid and cannot do it any better) - if it is
1673 * TRUM1 then we're really in compose mode and will produce some fields for
1674 * easier filling in */
1675 FL
int puthead(bool_t nosend_msg
, struct header
*hp
, FILE *fo
,
1676 enum gfield w
, enum sendaction action
,
1677 enum conversion convert
, char const *contenttype
,
1678 char const *charset
);
1681 FL
enum okay
resend_msg(struct message
*mp
, struct name
*to
, int add_resent
);
1684 FL
void savedeadletter(FILE *fp
, bool_t fflush_rewind_first
);
1690 /* Evaluate the string given as a new mailbox name. Supported meta characters:
1691 * . % for my system mail box
1692 * . %user for user's system mail box
1693 * . # for previous file
1694 * . & invoker's mbox file
1695 * . +file file in folder directory
1696 * . any shell meta character (except for FEXP_NSHELL).
1697 * a poor man's vis(3), on name before calling this (and showing the user).
1698 * If FEXP_MULTIOK is set we return an array of terminated strings, the (last)
1699 * result string is terminated via \0\0 and PS_EXPAND_MULTIRESULT is set.
1700 * Returns the file name as an auto-reclaimed string */
1701 FL
char * fexpand(char const *name
, enum fexp_mode fexpm
);
1703 #define expand(N) fexpand(N, FEXP_FULL) /* XXX obsolete */
1704 #define file_expand(N) fexpand(N, FEXP_LOCAL) /* XXX obsolete */
1706 /* Check whether *s is an escape sequence, expand it as necessary.
1707 * Returns the expanded sequence or 0 if **s is NUL or PROMPT_STOP if it is \c.
1708 * *s is advanced to after the expanded sequence (as possible).
1709 * If use_prompt_extensions is set, an enum prompt_exp may be returned */
1710 FL
int n_shell_expand_escape(char const **s
,
1711 bool_t use_prompt_extensions
);
1713 /* Parse the next shell token from input (->s and ->l are adjusted to the
1714 * remains, data is constant beside that; ->s may be NULL if ->l is 0, if ->l
1715 * EQ UIZ_MAX strlen(->s) is used) and append the resulting output to store */
1716 FL
enum n_shexp_state
n_shell_parse_token(struct n_string
*store
,
1717 struct str
*input
, enum n_shexp_parse_flags flags
);
1719 /* Likewise, but strips n_SHEXP_STATE_STOP if input remains after parsing,
1720 * otherwise forcefully sets it. Returns autoreclaimed storage */
1721 FL
enum n_shexp_state
n_shell_parse_token_buf(char **store
,
1722 char const *indat
, size_t inlen
,
1723 enum n_shexp_parse_flags flags
);
1725 /* Quote input in a way that can, in theory, be fed into parse_token() again.
1726 * ->s may be NULL if ->l is 0, if ->l EQ UIZ_MAX strlen(->s) is used.
1727 * If rndtrip is true we try to make the resulting string "portable" (by
1728 * converting Unicode to \u etc.), otherwise we produce something to be
1729 * consumed "now", i.e., to display for the user.
1730 * Resulting output is _appended_ to store.
1731 * TODO Note: last resort, since \u and $ expansions etc. are necessarily
1732 * TODO already expanded and can thus not be reverted, but ALL we have */
1733 FL
struct n_string
*n_shell_quote(struct n_string
*store
,
1734 struct str
const *input
, bool_t rndtrip
);
1735 FL
char * n_shell_quote_cp(char const *cp
, bool_t rndtrip
);
1741 FL
void n_raise(int signo
);
1743 /* Provide BSD-like signal() on all systems TODO v15 -> SysV -> n_signal() */
1744 FL sighandler_type
safe_signal(int signum
, sighandler_type handler
);
1746 /* Provide reproducable non-restartable signal handler installation */
1747 FL n_sighdl_t
n_signal(int signo
, n_sighdl_t hdl
);
1749 /* Hold *all* signals but SIGCHLD, and release that total block again */
1750 FL
void hold_all_sigs(void);
1751 FL
void rele_all_sigs(void);
1753 /* Hold HUP/QUIT/INT */
1754 FL
void hold_sigs(void);
1755 FL
void rele_sigs(void);
1757 /* Call _ENTER_SWITCH() with the according flags, it'll take care for the rest
1758 * and also set the jump buffer - it returns 0 if anything went fine and
1759 * a signal number if a jump occurred, in which case all handlers requested in
1760 * flags are temporarily SIG_IGN.
1761 * _cleanup_ping() informs the condome that no jumps etc. shall be performed
1762 * until _leave() is called in the following -- to be (optionally) called right
1763 * before the local jump label is reached which is jumped to after a long jump
1764 * occurred, straight code flow provided, e.g., to avoid destructors to be
1765 * called twice. _leave() must always be called last, reraise_flags will be
1766 * used to decide how signal handling has to continue
1768 #define n_SIGMAN_ENTER_SWITCH(S,F) do{\
1771 if(sigsetjmp((S)->sm_jump, 1))\
1775 n__sigman_enter(S, __x__);\
1776 }while(0); switch((S)->sm_signo)
1777 FL
int n__sigman_enter(struct n_sigman
*self
, int flags
);
1778 FL
void n_sigman_cleanup_ping(struct n_sigman
*self
);
1779 FL
void n_sigman_leave(struct n_sigman
*self
, enum n_sigman_flags flags
);
1781 /* Pending signal or 0? */
1782 FL
int n_sigman_peek(void);
1783 FL
void n_sigman_consume(void);
1785 /* Not-Yet-Dead debug information (handler installation in main.c) */
1786 #if defined HAVE_DEBUG || defined HAVE_DEVEL
1787 FL
void _nyd_chirp(ui8_t act
, char const *file
, ui32_t line
,
1789 FL
void _nyd_oncrash(int signo
);
1792 # define NYD_ENTER _nyd_chirp(1, __FILE__, __LINE__, __FUN__)
1793 # define NYD_LEAVE _nyd_chirp(2, __FILE__, __LINE__, __FUN__)
1794 # define NYD _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
1795 # define NYD_X _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
1797 # define NYD2_ENTER _nyd_chirp(1, __FILE__, __LINE__, __FUN__)
1798 # define NYD2_LEAVE _nyd_chirp(2, __FILE__, __LINE__, __FUN__)
1799 # define NYD2 _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
1805 # define NYD_ENTER do {} while (0)
1806 # define NYD_LEAVE do {} while (0)
1807 # define NYD do {} while (0)
1808 # define NYD_X do {} while (0) /* XXX LEGACY */
1811 # define NYD2_ENTER do {} while (0)
1812 # define NYD2_LEAVE do {} while (0)
1813 # define NYD2 do {} while (0)
1821 /* Send a message via SMTP */
1822 FL bool_t
smtp_mta(struct sendbundle
*sbp
);
1830 FL bool_t
sopen(struct sock
*sp
, struct url
*urlp
);
1831 FL
int sclose(struct sock
*sp
);
1832 FL
enum okay
swrite(struct sock
*sp
, char const *data
);
1833 FL
enum okay
swrite1(struct sock
*sp
, char const *data
, int sz
,
1837 FL
int sgetline(char **line
, size_t *linesize
, size_t *linelen
,
1838 struct sock
*sp SMALLOC_DEBUG_ARGS
);
1839 # ifdef HAVE_MEMORY_DEBUG
1840 # define sgetline(A,B,C,D) sgetline(A, B, C, D, __FILE__, __LINE__)
1849 /* Direct mappings of the various spam* commands */
1850 FL
int c_spam_clear(void *v
);
1851 FL
int c_spam_set(void *v
);
1852 FL
int c_spam_forget(void *v
);
1853 FL
int c_spam_ham(void *v
);
1854 FL
int c_spam_rate(void *v
);
1855 FL
int c_spam_spam(void *v
);
1857 # define c_spam_clear c_cmdnotsupp
1858 # define c_spam_set c_cmdnotsupp
1859 # define c_spam_forget c_cmdnotsupp
1860 # define c_spam_ham c_cmdnotsupp
1861 # define c_spam_rate c_cmdnotsupp
1862 # define c_spam_spam c_cmdnotsupp
1871 FL
void ssl_set_verify_level(struct url
const *urlp
);
1874 FL
enum okay
ssl_verify_decide(void);
1877 FL
enum okay
smime_split(FILE *ip
, FILE **hp
, FILE **bp
, long xcount
,
1881 FL
FILE * smime_sign_assemble(FILE *hp
, FILE *bp
, FILE *sp
,
1882 char const *message_digest
);
1885 FL
FILE * smime_encrypt_assemble(FILE *hp
, FILE *yp
);
1888 FL
struct message
* smime_decrypt_assemble(struct message
*m
, FILE *hp
,
1892 FL
int c_certsave(void *v
);
1895 FL
enum okay
rfc2595_hostname_match(char const *host
, char const *pattern
);
1896 #else /* HAVE_SSL */
1897 # define c_certsave c_cmdnotsupp
1904 /* Return a pointer to a dynamic copy of the argument */
1905 FL
char * savestr(char const *str SALLOC_DEBUG_ARGS
);
1906 FL
char * savestrbuf(char const *sbuf
, size_t sbuf_len SALLOC_DEBUG_ARGS
);
1907 #ifdef HAVE_MEMORY_DEBUG
1908 # define savestr(CP) savestr(CP, __FILE__, __LINE__)
1909 # define savestrbuf(CBP,CBL) savestrbuf(CBP, CBL, __FILE__, __LINE__)
1912 /* Concatenate cp2 onto cp1 (if not NULL), separated by sep (if not '\0') */
1913 FL
char * savecatsep(char const *cp1
, char sep
, char const *cp2
1915 #ifdef HAVE_MEMORY_DEBUG
1916 # define savecatsep(S1,SEP,S2) savecatsep(S1, SEP, S2, __FILE__, __LINE__)
1919 /* Make copy of argument incorporating old one, if set, separated by space */
1920 #define save2str(S,O) savecatsep(O, ' ', S)
1923 #define savecat(S1,S2) savecatsep(S1, '\0', S2)
1925 /* Create duplicate, lowercasing all characters along the way */
1926 FL
char * i_strdup(char const *src SALLOC_DEBUG_ARGS
);
1927 #ifdef HAVE_MEMORY_DEBUG
1928 # define i_strdup(CP) i_strdup(CP, __FILE__, __LINE__)
1932 FL
struct str
* str_concat_csvl(struct str
*self
, ...);
1935 FL
struct str
* str_concat_cpa(struct str
*self
, char const * const *cpa
,
1936 char const *sep_o_null SALLOC_DEBUG_ARGS
);
1937 #ifdef HAVE_MEMORY_DEBUG
1938 # define str_concat_cpa(S,A,N) str_concat_cpa(S, A, N, __FILE__, __LINE__)
1941 /* Plain char* support, not auto-reclaimed (unless noted) */
1943 /* Are any of the characters in the two strings the same? */
1944 FL
int anyof(char const *s1
, char const *s2
);
1946 /* Treat *iolist as a sep separated list of strings; find and return the
1947 * next entry, trimming surrounding whitespace, and point *iolist to the next
1948 * entry or to NULL if no more entries are contained. If ignore_empty is
1949 * set empty entries are started over.
1950 * See n_shell_parse_token() for the new way that supports sh(1) quoting.
1951 * Return NULL or an entry */
1952 FL
char * n_strsep(char **iolist
, char sep
, bool_t ignore_empty
);
1954 /* Copy a string, lowercasing it as we go; *size* is buffer size of *dest*;
1955 * *dest* will always be terminated unless *size* is 0 */
1956 FL
void i_strcpy(char *dest
, char const *src
, size_t size
);
1958 /* Is *as1* a valid prefix of *as2*? */
1959 FL
int is_prefix(char const *as1
, char const *as2
);
1961 /* Backslash quote (" and \) v'alue, and return salloc()ed result */
1962 FL
char * string_quote(char const *v
);
1964 /* Get (and isolate) the last, possibly quoted part of linebuf, set *needs_list
1965 * to indicate whether getmsglist() et al need to be called to collect
1966 * additional args that remain in linebuf. If strip is true possibly
1967 * surrounding quote characters are removed. Return NULL on "error" */
1968 FL
char * laststring(char *linebuf
, bool_t
*needs_list
, bool_t strip
);
1970 /* Convert a string to lowercase, in-place and with multibyte-aware */
1971 FL
void makelow(char *cp
);
1973 /* Is *sub* a substring of *str*, case-insensitive and multibyte-aware? */
1974 FL bool_t
substr(char const *str
, char const *sub
);
1977 FL
char * sstpcpy(char *dst
, char const *src
);
1978 FL
char * sstrdup(char const *cp SMALLOC_DEBUG_ARGS
);
1979 FL
char * sbufdup(char const *cp
, size_t len SMALLOC_DEBUG_ARGS
);
1980 #ifdef HAVE_MEMORY_DEBUG
1981 # define sstrdup(CP) sstrdup(CP, __FILE__, __LINE__)
1982 # define sbufdup(CP,L) sbufdup(CP, L, __FILE__, __LINE__)
1985 /* Copy at most dstsize bytes of src to dst and return string length.
1986 * Returns -E2BIG if dst is not large enough; dst will always be terminated
1987 * unless dstsize was 0 on entry */
1988 FL ssize_t
n_strscpy(char *dst
, char const *src
, size_t dstsize
);
1990 /* Case-independent ASCII comparisons */
1991 FL
int asccasecmp(char const *s1
, char const *s2
);
1992 FL
int ascncasecmp(char const *s1
, char const *s2
, size_t sz
);
1994 /* Case-independent ASCII string find s2 in s1, return it or NULL */
1995 FL
char const *asccasestr(char const *s1
, char const *s2
);
1997 /* Case-independent ASCII check wjether as2 is the initial substring of as1 */
1998 FL bool_t
is_asccaseprefix(char const *as1
, char const *as2
);
2000 /* struct str related support funs TODO _cp->_cs! */
2002 /* *self->s* is srealloc()ed */
2003 #define n_str_dup(S, T) n_str_assign_buf((S), (T)->s, (T)->l)
2005 /* *self->s* is srealloc()ed; if buflen==UIZ_MAX strlen() is called unless buf
2006 * is NULL; buf may be NULL if buflen is 0 */
2007 FL
struct str
* n_str_assign_buf(struct str
*self
,
2008 char const *buf
, uiz_t buflen SMALLOC_DEBUG_ARGS
);
2009 #define n_str_assign(S, T) n_str_assign_buf(S, (T)->s, (T)->l)
2010 #define n_str_assign_cp(S, CP) n_str_assign_buf(S, CP, UIZ_MAX)
2012 /* *self->s* is srealloc()ed, *self->l* incremented; if buflen==UIZ_MAX
2013 * strlen() is called unless buf is NULL; buf may be NULL if buflen is 0 */
2014 FL
struct str
* n_str_add_buf(struct str
*self
, char const *buf
, uiz_t buflen
2015 SMALLOC_DEBUG_ARGS
);
2016 #define n_str_add(S, T) n_str_add_buf(S, (T)->s, (T)->l)
2017 #define n_str_add_cp(S, CP) n_str_add_buf(S, CP, UIZ_MAX)
2019 #ifdef HAVE_MEMORY_DEBUG
2020 # define n_str_assign_buf(S,B,BL) n_str_assign_buf(S, B, BL, __FILE__, __LINE__)
2021 # define n_str_add_buf(S,B,BL) n_str_add_buf(S, B, BL, __FILE__, __LINE__)
2025 * May have NULL buffer, may contain embedded NULs */
2028 #define n_string_creat(S) \
2029 ((S)->s_dat = NULL, (S)->s_len = (S)->s_auto = (S)->s_size = 0, (S))
2030 #define n_string_creat_auto(S) \
2031 ((S)->s_dat = NULL, (S)->s_len = (S)->s_size = 0, (S)->s_auto = TRU1, (S))
2032 #define n_string_gut(S) ((S)->s_size != 0 ? (void)n_string_clear(S) : (void)0)
2034 /* Truncate to size, which must be LE current length */
2035 #define n_string_trunc(S,L) \
2036 (assert(UICMP(z, L, <=, (S)->s_len)), (S)->s_len = (ui32_t)(L), (S))
2038 /* Release buffer ownership */
2039 #define n_string_drop_ownership(S) \
2040 ((S)->s_dat = NULL, (S)->s_len = (S)->s_size = 0, (S))
2042 /* Release all memory */
2043 FL
struct n_string
*n_string_clear(struct n_string
*self SMALLOC_DEBUG_ARGS
);
2045 #ifdef HAVE_MEMORY_DEBUG
2046 # define n_string_clear(S) \
2047 ((S)->s_size != 0 ? (n_string_clear)(S, __FILE__, __LINE__) : (S))
2049 # define n_string_clear(S) ((S)->s_size != 0 ? (n_string_clear)(S) : (S))
2052 /* Reserve room for noof additional bytes. The latter also adjusts the length
2053 * accordingly, but the (possible) additional storage isn't initialized */
2054 FL
struct n_string
*n_string_reserve(struct n_string
*self
, size_t noof
2055 SMALLOC_DEBUG_ARGS
);
2056 FL
struct n_string
*n_string_resize(struct n_string
*self
, size_t nlen
2057 SMALLOC_DEBUG_ARGS
);
2059 #ifdef HAVE_MEMORY_DEBUG
2060 # define n_string_reserve(S,N) (n_string_reserve)(S, N, __FILE__, __LINE__)
2061 # define n_string_resize(S,N) (n_string_resize)(S, N, __FILE__, __LINE__)
2065 FL
struct n_string
*n_string_push_buf(struct n_string
*self
, char const *buf
,
2066 size_t buflen SMALLOC_DEBUG_ARGS
);
2067 #define n_string_push(S, T) n_string_push_buf(S, (T)->s_len, (T)->s_dat)
2068 #define n_string_push_cp(S,CP) n_string_push_buf(S, CP, UIZ_MAX)
2069 FL
struct n_string
*n_string_push_c(struct n_string
*self
, char c
2070 SMALLOC_DEBUG_ARGS
);
2072 #define n_string_assign(S,T) ((S)->s_len = 0, n_string_push(S, T))
2073 #define n_string_assign_cp(S,CP) ((S)->s_len = 0, n_string_push_cp(S, CP))
2074 #define n_string_assign_buf(S,B,BL) \
2075 ((S)->s_len = 0, n_string_push_buf(S, B, BL))
2077 #ifdef HAVE_MEMORY_DEBUG
2078 # define n_string_push_buf(S,B,BL) \
2079 n_string_push_buf(S, B, BL, __FILE__, __LINE__)
2080 # define n_string_push_c(S,C) n_string_push_c(S, C, __FILE__, __LINE__)
2084 FL
struct n_string
*n_string_unshift_buf(struct n_string
*self
, char const *buf
,
2085 size_t buflen SMALLOC_DEBUG_ARGS
);
2086 #define n_string_unshift(S, T) \
2087 n_string_unshift_buf(S, (T)->s_len, (T)->s_dat)
2088 #define n_string_unshift_cp(S,CP) \
2089 n_string_unshift_buf(S, CP, UIZ_MAX)
2090 FL
struct n_string
*n_string_unshift_c(struct n_string
*self
, char c
2091 SMALLOC_DEBUG_ARGS
);
2093 #ifdef HAVE_MEMORY_DEBUG
2094 # define n_string_unshift_buf(S,B,BL) \
2095 n_string_unshift_buf(S, B, BL, __FILE__, __LINE__)
2096 # define n_string_unshift_c(S,C) n_string_unshift_c(S, C, __FILE__, __LINE__)
2099 /* Ensure self has a - NUL terminated - buffer, and return that.
2100 * The latter may return the pointer to an internal empty RODATA instead */
2101 FL
char * n_string_cp(struct n_string
*self SMALLOC_DEBUG_ARGS
);
2102 FL
char const *n_string_cp_const(struct n_string
const *self
);
2104 #ifdef HAVE_MEMORY_DEBUG
2105 # define n_string_cp(S) n_string_cp(S, __FILE__, __LINE__)
2109 n_INLINE
struct n_string
*
2110 (n_string_creat
)(struct n_string
*self
){
2111 return n_string_creat(self
);
2113 # undef n_string_creat
2115 n_INLINE
struct n_string
*
2116 (n_string_creat_auto
)(struct n_string
*self
){
2117 return n_string_creat_auto(self
);
2119 # undef n_string_creat_auto
2122 (n_string_gut
)(struct n_string
*self
){
2125 # undef n_string_gut
2127 n_INLINE
struct n_string
*
2128 (n_string_trunc
)(struct n_string
*self
, size_t l
){
2129 return n_string_trunc(self
, l
);
2131 # undef n_string_trunc
2133 n_INLINE
struct n_string
*
2134 (n_string_drop_ownership
)(struct n_string
*self
){
2135 return n_string_drop_ownership(self
);
2137 # undef n_string_drop_ownership
2138 #endif /* HAVE_INLINE */
2142 #if defined HAVE_NATCH_CHAR || defined HAVE_ICONV
2143 /* ..and update arguments to point after range; returns UI32_MAX on error, in
2144 * which case the arguments will have been stepped one byte */
2145 FL ui32_t
n_utf8_to_utf32(char const **bdat
, size_t *blen
);
2147 /* buf must be large enough also for NUL, it's new length will be returned */
2148 FL
size_t n_utf32_to_utf8(ui32_t c
, char *buf
);
2151 /* Our iconv(3) wrappers */
2154 FL iconv_t
n_iconv_open(char const *tocode
, char const *fromcode
);
2155 /* If *cd* == *iconvd*, assigns -1 to the latter */
2156 FL
void n_iconv_close(iconv_t cd
);
2158 /* Reset encoding state */
2159 FL
void n_iconv_reset(iconv_t cd
);
2161 /* iconv(3), but return *errno* or 0; *skipilseq* forces step over invalid byte
2162 * sequences; likewise iconv_str(), but which auto-grows on E2BIG errors; *in*
2163 * and *in_rest_or_null* may be the same object.
2164 * Note: EINVAL (incomplete sequence at end of input) is NOT handled, so the
2165 * replacement character must be added manually if that happens at EOF! */
2166 FL
int n_iconv_buf(iconv_t cd
, char const **inb
, size_t *inbleft
,
2167 char **outb
, size_t *outbleft
, bool_t skipilseq
);
2168 FL
int n_iconv_str(iconv_t icp
, struct str
*out
, struct str
const *in
,
2169 struct str
*in_rest_or_null
, bool_t skipilseq
);
2171 /* If tocode==NULL, uses charset_get_lc(). If fromcode==NULL, uses UTF-8.
2172 * Returns a salloc()ed buffer or NULL */
2173 FL
char * n_iconv_onetime_cp(char const *tocode
, char const *fromcode
,
2174 char const *input
, bool_t skipilseq
);
2179 * This is a little bit hairy since it provides some stuff even if HAVE_TERMCAP
2180 * is false due to encapsulation desire
2184 /* termcap(3) / xy lifetime handling -- only called if we're OPT_INTERACTIVE
2185 * but not doing something in OPT_QUICKRUN_MASK */
2186 FL
void n_termcap_init(void);
2187 FL
void n_termcap_destroy(void);
2189 /* enter_ca_mode / enable keypad (both if possible).
2190 * TODO When complete is not set we won't enter_ca_mode, for example: we don't
2191 * TODO want a complete screen clearance after $PAGER returned after displaying
2192 * TODO a mail, because otherwise the screen would look differently for normal
2193 * TODO stdout display messages. Etc. */
2194 # ifdef HAVE_TERMCAP
2195 FL
void n_termcap_resume(bool_t complete
);
2196 FL
void n_termcap_suspend(bool_t complete
);
2198 # define n_TERMCAP_RESUME(CPL) n_termcap_resume(CPL)
2199 # define n_TERMCAP_SUSPEND(CPL) n_termcap_suspend(CPL)
2201 # define n_TERMCAP_RESUME(CPL)
2202 # define n_TERMCAP_SUSPEND(CPL)
2205 /* Command multiplexer, returns FAL0 on I/O error, TRU1 on success and TRUM1
2206 * for commands which are not available and have no builtin fallback.
2207 * For query options the return represents a true value and -1 error.
2208 * Will return FAL0 directly unless we've been initialized.
2209 * By convention unused argument slots are given as -1 */
2210 FL ssize_t
n_termcap_cmd(enum n_termcap_cmd cmd
, ssize_t a1
, ssize_t a2
);
2211 # define n_termcap_cmdx(CMD) n_termcap_cmd(CMD, -1, -1)
2213 /* Query multiplexer. If query is n__TERMCAP_QUERY_MAX then
2214 * tvp->tv_data.tvd_string must contain the name of the query to look up; this
2215 * is used to lookup just about *any* (string) capability.
2216 * Returns TRU1 on success and TRUM1 for queries for which a builtin default
2217 * is returned; FAL0 is returned on non-availability */
2218 FL bool_t
n_termcap_query(enum n_termcap_query query
,
2219 struct n_termcap_value
*tvp
);
2221 /* Get a n_termcap_query for name or -1 if it is not known, and -2 if
2222 * type wasn't _NONE and the type doesn't match. */
2223 # ifdef HAVE_KEY_BINDINGS
2224 FL si32_t
n_termcap_query_for_name(char const *name
,
2225 enum n_termcap_captype type
);
2226 FL
char const *n_termcap_name_of_query(enum n_termcap_query query
);
2228 #endif /* n_HAVE_TCAP */
2235 FL
int c_thread(void *vp
);
2238 FL
int c_unthread(void *vp
);
2241 FL
struct message
* next_in_thread(struct message
*mp
);
2242 FL
struct message
* prev_in_thread(struct message
*mp
);
2243 FL
struct message
* this_in_thread(struct message
*mp
, long n
);
2245 /* Sorted mode is internally just a variant of threaded mode with all m_parent
2246 * and m_child links being NULL */
2247 FL
int c_sort(void *vp
);
2250 FL
int c_collapse(void *v
);
2251 FL
int c_uncollapse(void *v
);
2254 FL
void uncollapse1(struct message
*mp
, int always
);
2260 /* Return whether user says yes, on STDIN if interactive.
2261 * Uses noninteract_default, the return value for non-interactive use cases,
2262 * as a hint for boolify() and chooses the yes/no string to append to prompt
2263 * accordingly. If prompt is NULL "Continue" is used instead.
2264 * Handles+reraises SIGINT */
2265 FL bool_t
getapproval(char const *prompt
, bool_t noninteract_default
);
2268 /* Get a password the expected way, return termios_state.ts_linebuf on
2269 * success or NULL on error */
2270 FL
char * getuser(char const *query
);
2272 /* Get a password the expected way, return termios_state.ts_linebuf on
2273 * success or NULL on error. SIGINT is temporarily blocked, *not* reraised.
2274 * termios_state_reset() (def.h) must be called anyway */
2275 FL
char * getpassword(char const *query
);
2278 /* At least readline(3) (formerly supported) desires to handle SIGWINCH and
2279 * install its own handler */
2281 # define TTY_WANTS_SIGWINCH
2284 /* Overall interactive terminal life cycle for command line editor library */
2285 FL
void n_tty_init(void);
2286 FL
void n_tty_destroy(void);
2288 /* Rather for main.c / SIGWINCH interaction only */
2289 FL
void n_tty_signal(int sig
);
2291 /* Read a line after printing prompt (if set and non-empty).
2292 * If n>0 assumes that *linebuf has n bytes of default content.
2293 * Only the _CTX_ bits in lif are used */
2294 FL
int n_tty_readline(enum n_lexinput_flags lif
, char const *prompt
,
2295 char **linebuf
, size_t *linesize
, size_t n
2296 SMALLOC_DEBUG_ARGS
);
2297 #ifdef HAVE_MEMORY_DEBUG
2298 # define n_tty_readline(A,B,C,D,E) (n_tty_readline)(A,B,C,D,E,__FILE__,__LINE__)
2301 /* Add a line (most likely as returned by n_tty_readline()) to the history.
2302 * Whether an entry added for real depends on the isgabby / *history-gabby*
2303 * relation, and / or whether s is non-empty and doesn't begin with spacechar() */
2304 FL
void n_tty_addhist(char const *s
, bool_t isgabby
);
2307 FL
int c_history(void *v
);
2309 # define c_history c_cmdnotsupp
2312 /* `bind' and `unbind' */
2313 #ifdef HAVE_KEY_BINDINGS
2314 FL
int c_bind(void *v
);
2315 FL
int c_unbind(void *v
);
2317 # define c_bind c_cmdnotsupp
2318 # define c_unbind c_cmdnotsupp
2325 /* Parse (onechar of) a given buffer, and generate infos along the way.
2326 * If _WOUT_CREATE is set in vif, .vic_woudat will be NUL terminated!
2327 * vicp must be zeroed before first use */
2328 FL bool_t
n_visual_info(struct n_visual_info_ctx
*vicp
,
2329 enum n_visual_info_flags vif
);
2331 /* Check (multibyte-safe) how many bytes of buf (which is blen byts) can be
2332 * safely placed in a buffer (field width) of maxlen bytes */
2333 FL
size_t field_detect_clip(size_t maxlen
, char const *buf
, size_t blen
);
2335 /* Put maximally maxlen bytes of buf, a buffer of blen bytes, into store,
2336 * taking into account multibyte code point boundaries and possibly
2337 * encapsulating in bidi_info toggles as necessary */
2338 FL
size_t field_put_bidi_clip(char *store
, size_t maxlen
, char const *buf
,
2341 /* Place cp in a salloc()ed buffer, column-aligned; for header display only */
2342 FL
char * colalign(char const *cp
, int col
, int fill
,
2343 int *cols_decr_used_or_null
);
2345 /* Convert a string to a displayable one;
2346 * prstr() returns the result savestr()d, prout() writes it */
2347 FL
void makeprint(struct str
const *in
, struct str
*out
);
2348 FL
size_t delctrl(char *cp
, size_t len
);
2349 FL
char * prstr(char const *s
);
2350 FL
int prout(char const *s
, size_t sz
, FILE *fp
);
2352 /* Print out a Unicode character or a substitute for it, return 0 on error or
2353 * wcwidth() (or 1) on success */
2354 FL
size_t putuc(int u
, int c
, FILE *fp
);
2356 /* Check whether bidirectional info maybe needed for blen bytes of bdat */
2357 FL bool_t
bidi_info_needed(char const *bdat
, size_t blen
);
2359 /* Create bidirectional text encapsulation information; without HAVE_NATCH_CHAR
2360 * the strings are always empty */
2361 FL
void bidi_info_create(struct bidi_info
*bip
);
2367 /* URL en- and decoding according to (enough of) RFC 3986 (RFC 1738).
2368 * These return a newly salloc()ated result */
2369 FL
char * urlxenc(char const *cp
, bool_t ispath SALLOC_DEBUG_ARGS
);
2370 FL
char * urlxdec(char const *cp SALLOC_DEBUG_ARGS
);
2371 #ifdef HAVE_MEMORY_DEBUG
2372 # define urlxenc(CP,P) urlxenc(CP, P, __FILE__, __LINE__)
2373 # define urlxdec(CP) urlxdec(CP, __FILE__, __LINE__)
2376 /* Return port for proto (and set irv_or_null), or NULL if unknown.
2377 * For file:// this returns an empty string */
2378 FL
char const *n_servbyname(char const *proto
, ui16_t
*irv_or_null
);
2381 /* Parse data, which must meet the criteria of the protocol cproto, and fill
2382 * in the URL structure urlp (URL rather according to RFC 3986) */
2383 FL bool_t
url_parse(struct url
*urlp
, enum cproto cproto
,
2386 /* Zero ccp and lookup credentials for communicating with urlp.
2387 * Return whether credentials are available and valid (for chosen auth) */
2388 FL bool_t
ccred_lookup(struct ccred
*ccp
, struct url
*urlp
);
2389 FL bool_t
ccred_lookup_old(struct ccred
*ccp
, enum cproto cproto
,
2391 #endif /* HAVE_SOCKETS */
2395 FL
int c_netrc(void *v
);
2397 # define c_netrc c_cmdnotsupp
2400 /* MD5 (RFC 1321) related facilities */
2402 # ifdef HAVE_OPENSSL_MD5
2403 # define md5_ctx MD5_CTX
2404 # define md5_init MD5_Init
2405 # define md5_update MD5_Update
2406 # define md5_final MD5_Final
2408 /* The function definitions are instantiated in main.c */
2409 # include "rfc1321.h"
2412 /* Store the MD5 checksum as a hexadecimal string in *hex*, *not* terminated,
2413 * using lowercase ASCII letters as defined in RFC 2195 */
2414 # define MD5TOHEX_SIZE 32
2415 FL
char * md5tohex(char hex
[MD5TOHEX_SIZE
], void const *vp
);
2417 /* CRAM-MD5 encode the *user* / *pass* / *b64* combo */
2418 FL
char * cram_md5_string(struct str
const *user
, struct str
const *pass
,
2421 /* RFC 2104: HMAC: Keyed-Hashing for Message Authentication.
2422 * unsigned char *text: pointer to data stream
2423 * int text_len : length of data stream
2424 * unsigned char *key : pointer to authentication key
2425 * int key_len : length of authentication key
2426 * caddr_t digest : caller digest to be filled in */
2427 FL
void hmac_md5(unsigned char *text
, int text_len
, unsigned char *key
,
2428 int key_len
, void *digest
);
2429 #endif /* HAVE_MD5 */
2431 #ifndef HAVE_AMALGAMATION