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 - 2015 Steffen (Daode) Nurpmeso <sdaoden@users.sf.net>.
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[(uc_i)(C)] & (FLAGS)) != 0)
71 #define asciichar(c) ((uc_i)(c) <= 0177)
72 #define alnumchar(c) __ischarof(c, C_DIGIT | C_OCTAL | C_UPPER | C_LOWER)
73 #define alphachar(c) __ischarof(c, C_UPPER | C_LOWER)
74 #define blankchar(c) __ischarof(c, C_BLANK)
75 #define blankspacechar(c) __ischarof(c, C_BLANK | C_SPACE)
76 #define cntrlchar(c) (asciichar(c) && class_char[(ui8_t)(c)] == C_CNTRL)
77 #define digitchar(c) __ischarof(c, C_DIGIT | C_OCTAL)
78 #define lowerchar(c) __ischarof(c, C_LOWER)
79 #define punctchar(c) __ischarof(c, C_PUNCT)
80 #define spacechar(c) __ischarof(c, C_BLANK | C_SPACE | C_WHITE)
81 #define upperchar(c) __ischarof(c, C_UPPER)
82 #define whitechar(c) __ischarof(c, C_BLANK | C_WHITE)
83 #define octalchar(c) __ischarof(c, C_OCTAL)
84 #define hexchar(c) /* TODO extend bits, add C_HEX */\
85 (__ischarof(c, C_DIGIT | C_OCTAL) || ((c) >= 'A' && (c) <= 'F') ||\
86 ((c) >= 'a' && (c) <= 'f'))
88 #define upperconv(c) (lowerchar(c) ? (char)((uc_i)(c) - 'a' + 'A') : (c))
89 #define lowerconv(c) (upperchar(c) ? (char)((uc_i)(c) - 'A' + 'a') : (c))
91 #define fieldnamechar(c) \
92 (asciichar(c) && (c) > 040 && (c) != 0177 && (c) != ':')
94 /* Could the string contain a regular expression? */
96 # define is_maybe_regex(S) anyof("^.[]*+?()|$", S)
98 # define is_maybe_regex(S) anyof("^[]*+?|$", S)
101 /* Single-threaded, use unlocked I/O */
102 #ifdef HAVE_PUTC_UNLOCKED
104 # define getc(c) getc_unlocked(c)
106 # define putc(c, f) putc_unlocked(c, f)
108 # define putchar(c) putc_unlocked((c), stdout)
111 /* Truncate a file to the last character written. This is useful just before
112 * closing an old file that was opened for read/write */
113 #define ftrunc(stream) \
117 off = ftell(stream);\
119 ftruncate(fileno(stream), off);\
122 /* fflush() and rewind() */
123 #define fflush_rewind(stream) \
129 /* There are problems with dup()ing of file-descriptors for child processes.
130 * As long as those are not fixed in equal spirit to (outof(): FIX and
131 * recode.., 2012-10-04), and to avoid reviving of bugs like (If *record* is
132 * set, avoid writing dead content twice.., 2012-09-14), we have to somehow
133 * accomplish that the FILE* fp makes itself comfortable with the *real* offset
134 * of the underlaying file descriptor. Unfortunately Standard I/O and POSIX
135 * don't describe a way for that -- fflush();rewind(); won't do it. This
136 * fseek(END),rewind() pair works around the problem on *BSD and Linux.
137 * Update as of 2014-03-03: with Issue 7 POSIX has overloaded fflush(3): if
138 * used on a readable stream, then
140 * if the file is not already at EOF, and the file is one capable of
141 * seeking, the file offset of the underlying open file description shall
142 * be set to the file position of the stream.
144 * We need our own, simplified and reliable I/O */
145 #if defined _POSIX_VERSION && _POSIX_VERSION + 0 >= 200809L
146 # define really_rewind(stream) \
152 # define really_rewind(stream) \
156 lseek(fileno(stream), 0, SEEK_SET);\
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 wether 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
);
175 /* Accounts: `account', `unaccount' */
176 FL
int c_account(void *v
);
177 FL
int c_unaccount(void *v
);
180 FL
int c_localopts(void *v
);
182 FL
void temporary_localopts_free(void); /* XXX intermediate hack */
183 FL
void temporary_localopts_folder_hook_unroll(void); /* XXX im. hack */
185 /* Don't use n_var_* unless you *really* have to! */
187 /* Constant option key look/(un)set/clear */
188 FL
char * n_var_oklook(enum okeys okey
);
189 #define ok_blook(C) (n_var_oklook(CONCAT(ok_b_, C)) != NULL)
190 #define ok_vlook(C) n_var_oklook(CONCAT(ok_v_, C))
192 FL bool_t
n_var_okset(enum okeys okey
, uintptr_t val
);
193 #define ok_bset(C,B) n_var_okset(CONCAT(ok_b_, C), (uintptr_t)(B))
194 #define ok_vset(C,V) n_var_okset(CONCAT(ok_v_, C), (uintptr_t)(V))
196 FL bool_t
n_var_okclear(enum okeys okey
);
197 #define ok_bclear(C) n_var_okclear(CONCAT(ok_b_, C))
198 #define ok_vclear(C) n_var_okclear(CONCAT(ok_v_, C))
200 /* Variable option key look/(un)set/clear */
201 FL
char * n_var_voklook(char const *vokey
);
202 #define vok_blook(S) (n_var_voklook(S) != NULL)
203 #define vok_vlook(S) n_var_voklook(S)
205 FL bool_t
n_var_vokset(char const *vokey
, uintptr_t val
);
206 #define vok_bset(S,B) n_var_vokset(S, (uintptr_t)(B))
207 #define vok_vset(S,V) n_var_vokset(S, (uintptr_t)(V))
209 FL bool_t
n_var_vokclear(char const *vokey
);
210 #define vok_bclear(S) n_var_vokclear(S)
211 #define vok_vclear(S) n_var_vokclear(S)
213 /* Special case to handle the typical [xy-USER@HOST,] xy-HOST and plain xy
214 * variable chains; oxm is a bitmix which tells which combinations to test */
216 FL
char * n_var_xoklook(enum okeys okey
, struct url
const *urlp
,
217 enum okey_xlook_mode oxm
);
218 # define xok_BLOOK(C,URL,M) (n_var_xoklook(C, URL, M) != NULL)
219 # define xok_VLOOK(C,URL,M) n_var_xoklook(C, URL, M)
220 # define xok_blook(C,URL,M) xok_BLOOK(CONCAT(ok_b_, C), URL, M)
221 # define xok_vlook(C,URL,M) xok_VLOOK(CONCAT(ok_v_, C), URL, M)
224 /* User variable access: `set' and `unset' */
225 FL
int c_set(void *v
);
226 FL
int c_unset(void *v
);
229 FL
int c_varshow(void *v
);
231 /* Ditto: `varedit' */
232 FL
int c_varedit(void *v
);
235 FL
int c_environ(void *v
);
241 /* Try to add an attachment for file, file_expand()ed.
242 * Return the new head of list aphead, or NULL.
243 * The newly created attachment will be stored in *newap, if given */
244 FL
struct attachment
* add_attachment(struct attachment
*aphead
, char *file
,
245 struct attachment
**newap
);
247 /* Append comma-separated list of file names to the end of attachment list */
248 FL
void append_attachments(struct attachment
**aphead
, char *names
);
250 /* Interactively edit the attachment list */
251 FL
void edit_attachments(struct attachment
**aphead
);
257 /* Compute screen size */
258 FL
int screensize(void);
260 /* Get our $PAGER; if env_addon is not NULL it is checked wether we know about
261 * some environment variable that supports colour+ and set *env_addon to that,
262 * e.g., "LESS=FRSXi" */
263 FL
char const *n_pager_get(char const **env_addon
);
265 /* Use a pager or STDOUT to print *fp*; if *lines* is 0, they'll be counted */
266 FL
void page_or_print(FILE *fp
, size_t lines
);
268 /* Parse name and guess at the required protocol */
269 FL
enum protocol
which_protocol(char const *name
);
271 /* Hash the passed string -- uses Chris Torek's hash algorithm */
272 FL ui32_t
torek_hash(char const *name
);
273 #define hash(S) (torek_hash(S) % HSHSIZE) /* xxx COMPAT (?) */
276 FL ui32_t
pjw(char const *cp
); /* TODO obsolete -> torek_hash() */
278 /* Find a prime greater than n */
279 FL ui32_t
nextprime(ui32_t n
);
281 /* Get *prompt*, or '& ' if *bsdcompat*, of '? ' otherwise */
282 FL
char * getprompt(void);
284 /* Detect and query the hostname to use */
285 FL
char * nodename(int mayoverride
);
287 /* Get a (pseudo) random string of *length* bytes; returns salloc()ed buffer */
288 FL
char * getrandstring(size_t length
);
290 /* Check wether the argument string is a true (1) or false (0) boolean, or an
291 * invalid string, in which case -1 is returned; if emptyrv is not -1 then it,
292 * treated as a boolean, is used as the return value shall inbuf be empty.
293 * inlen may be UIZ_MAX to force strlen() detection */
294 FL si8_t
boolify(char const *inbuf
, uiz_t inlen
, si8_t emptyrv
);
296 /* Dig a "quadoption" in inbuf (possibly going through getapproval() in
297 * interactive mode). Returns a boolean or -1 if inbuf content is invalid;
298 * if emptyrv is not -1 then it, treated as a boolean, is used as the return
299 * value shall inbuf be empty. If prompt is set it is printed first if intera.
300 * inlen may be UIZ_MAX to force strlen() detection */
301 FL si8_t
quadify(char const *inbuf
, uiz_t inlen
, char const *prompt
,
304 /* Is the argument "all" (case-insensitive) or "*" */
305 FL bool_t
n_is_all_or_aster(char const *name
);
307 /* Get seconds since epoch */
308 FL
time_t n_time_epoch(void);
310 /* Update *tc* to now; only .tc_time updated unless *full_update* is true */
311 FL
void time_current_update(struct time_current
*tc
,
314 /* Returns 0 if fully slept, number of millis left if ignint is true and we
315 * were interrupted. Actual resolution may be second or less.
316 * Note in case of HAVE_SLEEP this may be SIGALARM based. */
317 FL uiz_t
n_msleep(uiz_t millis
, bool_t ignint
);
319 /* Our error print series.. Note: these reverse scan format in order to know
320 * wether a newline was included or not -- this affects the output! */
321 FL
void n_err(char const *format
, ...);
322 FL
void n_verr(char const *format
, va_list ap
);
324 /* ..(for use in a signal handler; to be obsoleted..).. */
325 FL
void n_err_sighdl(char const *format
, ...);
327 /* Our perror(3); if errval is 0 errno(3) is used; newline appended */
328 FL
void n_perr(char const *msg
, int errval
);
330 /* Announce a fatal error (and die); newline appended */
331 FL
void n_alert(char const *format
, ...);
332 FL
void n_panic(char const *format
, ...);
336 FL
int c_errors(void *vp
);
338 # define c_errors c_cmdnotsupp
345 FL
int c_cmdnotsupp(void *v
);
347 /* `headers' (show header group, possibly after setting dot) */
348 FL
int c_headers(void *v
);
350 /* Like c_headers(), but pre-prepared message vector */
351 FL
int print_header_group(int *vector
);
353 /* Scroll to the next/previous screen */
354 FL
int c_scroll(void *v
);
355 FL
int c_Scroll(void *v
);
357 /* Print out the headlines for each message in the passed message list */
358 FL
int c_from(void *v
);
360 /* Print all message in between and including bottom and topx if they are
361 * visible and either only_marked is false or they are MMARKed */
362 FL
void print_headers(size_t bottom
, size_t topx
, bool_t only_marked
);
364 /* Print out the value of dot */
365 FL
int c_pdot(void *v
);
367 /* Paginate messages, honor/don't honour ignored fields, respectively */
368 FL
int c_more(void *v
);
369 FL
int c_More(void *v
);
371 /* Type out messages, honor/don't honour ignored fields, respectively */
372 FL
int c_type(void *v
);
373 FL
int c_Type(void *v
);
375 /* Show MIME-encoded message text, including all fields */
376 FL
int c_show(void *v
);
378 /* Pipe messages, honor/don't honour ignored fields, respectively */
379 FL
int c_pipe(void *v
);
380 FL
int c_Pipe(void *v
);
382 /* Print the top so many lines of each desired message.
383 * The number of lines is taken from *toplines* and defaults to 5 */
384 FL
int c_top(void *v
);
386 /* Touch all the given messages so that they will get mboxed */
387 FL
int c_stouch(void *v
);
389 /* Make sure all passed messages get mboxed */
390 FL
int c_mboxit(void *v
);
392 /* List the folders the user currently has */
393 FL
int c_folders(void *v
);
399 /* If any arguments were given, go to the next applicable argument following
400 * dot, otherwise, go to the next applicable message. If given as first
401 * command with no arguments, print first message */
402 FL
int c_next(void *v
);
404 /* Move the dot up or down by one message */
405 FL
int c_dotmove(void *v
);
407 /* Save a message in a file. Mark the message as saved so we can discard when
409 FL
int c_save(void *v
);
410 FL
int c_Save(void *v
);
412 /* Copy a message to a file without affected its saved-ness */
413 FL
int c_copy(void *v
);
414 FL
int c_Copy(void *v
);
416 /* Move a message to a file */
417 FL
int c_move(void *v
);
418 FL
int c_Move(void *v
);
420 /* Decrypt and copy a message to a file */
421 FL
int c_decrypt(void *v
);
422 FL
int c_Decrypt(void *v
);
424 /* Write the indicated messages at the end of the passed file name, minus
425 * header and trailing blank line. This is the MIME save function */
426 FL
int c_write(void *v
);
428 /* Delete messages */
429 FL
int c_delete(void *v
);
431 /* Delete messages, then type the new dot */
432 FL
int c_deltype(void *v
);
434 /* Undelete the indicated messages */
435 FL
int c_undelete(void *v
);
437 /* Add the given header fields to the retained list. If no arguments, print
438 * the current list of retained fields */
439 FL
int c_retfield(void *v
);
441 /* Add the given header fields to the ignored list. If no arguments, print the
442 * current list of ignored fields */
443 FL
int c_igfield(void *v
);
445 FL
int c_saveretfield(void *v
);
446 FL
int c_saveigfield(void *v
);
447 FL
int c_fwdretfield(void *v
);
448 FL
int c_fwdigfield(void *v
);
449 FL
int c_unignore(void *v
);
450 FL
int c_unretain(void *v
);
451 FL
int c_unsaveignore(void *v
);
452 FL
int c_unsaveretain(void *v
);
453 FL
int c_unfwdignore(void *v
);
454 FL
int c_unfwdretain(void *v
);
460 /* Process a shell escape by saving signals, ignoring signals and a sh -c */
461 FL
int c_shell(void *v
);
463 /* Fork an interactive shell */
464 FL
int c_dosh(void *v
);
466 /* Show the help screen */
467 FL
int c_help(void *v
);
469 /* Print user's working directory */
470 FL
int c_cwd(void *v
);
472 /* Change user's working directory */
473 FL
int c_chdir(void *v
);
475 /* All thinkable sorts of `reply' / `respond' and `followup'.. */
476 FL
int c_reply(void *v
);
477 FL
int c_replyall(void *v
);
478 FL
int c_replysender(void *v
);
479 FL
int c_Reply(void *v
);
480 FL
int c_followup(void *v
);
481 FL
int c_followupall(void *v
);
482 FL
int c_followupsender(void *v
);
483 FL
int c_Followup(void *v
);
485 /* ..and a mailing-list reply */
486 FL
int c_Lreply(void *v
);
488 /* The 'forward' command */
489 FL
int c_forward(void *v
);
491 /* Similar to forward, saving the message in a file named after the first
493 FL
int c_Forward(void *v
);
495 /* Resend a message list to a third person */
496 FL
int c_resend(void *v
);
498 /* Resend a message list to a third person without adding headers */
499 FL
int c_Resend(void *v
);
501 /* Preserve messages, so that they will be sent back to the system mailbox */
502 FL
int c_preserve(void *v
);
504 /* Mark all given messages as unread */
505 FL
int c_unread(void *v
);
507 /* Mark all given messages as read */
508 FL
int c_seen(void *v
);
510 /* Print the size of each message */
511 FL
int c_messize(void *v
);
513 /* `file' (`folder') and `File' (`Folder') */
514 FL
int c_file(void *v
);
515 FL
int c_File(void *v
);
517 /* Expand file names like echo */
518 FL
int c_echo(void *v
);
520 /* 'newmail' command: Check for new mail without writing old mail back */
521 FL
int c_newmail(void *v
);
523 /* Message flag manipulation */
524 FL
int c_flag(void *v
);
525 FL
int c_unflag(void *v
);
526 FL
int c_answered(void *v
);
527 FL
int c_unanswered(void *v
);
528 FL
int c_draft(void *v
);
529 FL
int c_undraft(void *v
);
532 FL
int c_noop(void *v
);
535 FL
int c_remove(void *v
);
538 FL
int c_rename(void *v
);
540 /* `urlencode' and `urldecode' */
541 FL
int c_urlencode(void *v
);
542 FL
int c_urldecode(void *v
);
548 /* if.elif.else.endif conditional execution.
549 * condstack_isskip() returns wether the current condition state doesn't allow
550 * execution of commands.
551 * condstack_release() and condstack_take() rotate the current condition stack;
552 * condstack_take() returns a false boolean if the current condition stack has
553 * unclosed conditionals */
554 FL
int c_if(void *v
);
555 FL
int c_elif(void *v
);
556 FL
int c_else(void *v
);
557 FL
int c_endif(void *v
);
558 FL bool_t
condstack_isskip(void);
559 FL
void * condstack_release(void);
560 FL bool_t
condstack_take(void *self
);
567 * If quotefile is (char*)-1, stdin will be used, caller has to verify that
568 * we're not running in interactive mode */
569 FL
FILE * collect(struct header
*hp
, int printheaders
, struct message
*mp
,
570 char *quotefile
, int doprefix
, si8_t
*checkaddr_err
);
572 FL
void savedeadletter(FILE *fp
, int fflush_rewind_first
);
578 /* Edit a message list */
579 FL
int c_editor(void *v
);
581 /* Invoke the visual editor on a message list */
582 FL
int c_visual(void *v
);
584 /* Run an editor on either size bytes of the file fp (or until EOF if size is
585 * negative) or on the message mp, and return a new file or NULL on error of if
586 * the user didn't perform any edits.
587 * For now we assert that mp==NULL if hp!=NULL, treating this as a special call
588 * from within compose mode, and giving TRUM1 to puthead().
589 * Signals must be handled by the caller. viored is 'e' for ed, 'v' for vi */
590 FL
FILE * run_editor(FILE *fp
, off_t size
, int viored
, int readonly
,
591 struct header
*hp
, struct message
*mp
,
592 enum sendaction action
, sighandler_type oldint
);
600 FL
int c_colour(void *v
);
601 FL
int c_uncolour(void *v
);
603 /* We want coloured output (in this salloc() cycle). pager_used is used to
604 * test wether *colour-pager* is to be inspected.
605 * The push/pop functions deal with recursive execute()ions, for now. TODO
606 * env_gut() will reset() as necessary */
607 FL
void n_colour_env_create(enum n_colour_ctx cctx
, bool_t pager_used
);
608 FL
void n_colour_env_push(void);
609 FL
void n_colour_env_pop(bool_t any_env_till_root
);
610 FL
void n_colour_env_gut(FILE *fp
);
612 /* Putting anything (for pens: including NULL) resets current state first */
613 FL
void n_colour_put(FILE *fp
, enum n_colour_id cid
, char const *ctag
);
614 FL
void n_colour_reset(FILE *fp
);
616 /* Of course temporary only and may return NULL. Doesn't affect state! */
617 FL
struct str
const *n_colour_reset_to_str(void);
619 /* A pen is bound to its environment and automatically reclaimed; it may be
620 * NULL but that can be used anyway for simplicity.
621 * This includes pen_to_str() -- which doesn't affect state! */
622 FL
struct n_colour_pen
*n_colour_pen_create(enum n_colour_id cid
,
624 FL
void n_colour_pen_put(struct n_colour_pen
*self
, FILE *fp
);
626 FL
struct str
const *n_colour_pen_to_str(struct n_colour_pen
*self
);
628 #else /* HAVE_COLOUR */
629 # define c_colour c_cmdnotsupp
630 # define c_uncolour c_cmdnotsupp
631 # define c_mono c_cmdnotsupp
632 # define c_unmono c_cmdnotsupp
639 /* Aquire a flt lock and create a dotlock file; upon success a registered
640 * control-pipe FILE* is returned that keeps the link in between us and the
641 * lock-holding fork(2)ed subprocess (which conditionally replaced itself via
642 * execv(2) with the privilege-separated dotlock helper program): the lock file
643 * will be removed once the control pipe is closed via Pclose().
644 * Will try FILE_LOCK_TRIES times if pollmsecs > 0 (once otherwise).
645 * If *dotlock_ignore_error* is set (FILE*)-1 will be returned if at least the
646 * normal file lock could be established, otherwise errno is usable on error */
647 FL
FILE * n_dotlock(char const *fname
, int fd
, enum n_file_lock_type flt
,
648 off_t off
, off_t len
, size_t pollmsecs
);
655 FL
struct quoteflt
* quoteflt_dummy(void); /* TODO LEGACY */
656 FL
void quoteflt_init(struct quoteflt
*self
, char const *prefix
);
657 FL
void quoteflt_destroy(struct quoteflt
*self
);
658 FL
void quoteflt_reset(struct quoteflt
*self
, FILE *f
);
659 FL ssize_t
quoteflt_push(struct quoteflt
*self
, char const *dat
,
661 FL ssize_t
quoteflt_flush(struct quoteflt
*self
);
663 /* (Primitive) HTML tagsoup filter */
664 #ifdef HAVE_FILTER_HTML_TAGSOUP
665 /* TODO Because we don't support filter chains yet this filter will be run
666 * TODO in a dedicated subprocess, driven via a special Popen() mode */
667 FL
int htmlflt_process_main(void);
669 FL
void htmlflt_init(struct htmlflt
*self
);
670 FL
void htmlflt_destroy(struct htmlflt
*self
);
671 FL
void htmlflt_reset(struct htmlflt
*self
, FILE *f
);
672 FL ssize_t
htmlflt_push(struct htmlflt
*self
, char const *dat
, size_t len
);
673 FL ssize_t
htmlflt_flush(struct htmlflt
*self
);
680 /* fgets() replacement to handle lines of arbitrary size and with embedded \0
682 * line - line buffer. *line may be NULL.
683 * linesize - allocated size of line buffer.
684 * count - maximum characters to read. May be NULL.
685 * llen - length_of_line(*line).
687 * appendnl - always terminate line with \n, append if necessary.
689 FL
char * fgetline(char **line
, size_t *linesize
, size_t *count
,
690 size_t *llen
, FILE *fp
, int appendnl SMALLOC_DEBUG_ARGS
);
691 #ifdef HAVE_MEMORY_DEBUG
692 # define fgetline(A,B,C,D,E,F) \
693 fgetline(A, B, C, D, E, F, __FILE__, __LINE__)
696 /* Read up a line from the specified input into the linebuffer.
697 * Return the number of characters read. Do not include the newline at EOL.
698 * n is the number of characters already read */
699 FL
int readline_restart(FILE *ibuf
, char **linebuf
, size_t *linesize
,
700 size_t n SMALLOC_DEBUG_ARGS
);
701 #ifdef HAVE_MEMORY_DEBUG
702 # define readline_restart(A,B,C,D) \
703 readline_restart(A, B, C, D, __FILE__, __LINE__)
706 /* Set up the input pointers while copying the mail file into /tmp */
707 FL
void setptr(FILE *ibuf
, off_t offset
);
709 /* Drop the passed line onto the passed output buffer. If a write error occurs
710 * return -1, else the count of characters written, including the newline */
711 FL
int putline(FILE *obuf
, char *linebuf
, size_t count
);
713 /* Determine the size of the file possessed by the passed buffer */
714 FL off_t
fsize(FILE *iob
);
716 /* accmacvar.c hook: *folder* variable has been updated; if folder shouldn't
717 * be replaced by something else leave store alone, otherwise smalloc() the
718 * desired value (ownership will be taken) */
719 FL bool_t
var_folder_updated(char const *folder
, char **store
);
721 /* Return the name of the dead.letter file */
722 FL
char const * getdeadletter(void);
724 /* Will retry FILE_LOCK_RETRIES times if pollmsecs > 0 */
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 the current *folder* name, store it in *name* */
760 FL bool_t
getfold(char *name
, size_t size
);
766 /* Return the user's From: address(es) */
767 FL
char const * myaddrs(struct header
*hp
);
769 /* Boil the user's From: addresses down to a single one, or use *sender* */
770 FL
char const * myorigin(struct header
*hp
);
772 /* See if the passed line buffer, which may include trailing newline (sequence)
773 * is a mail From_ header line according to RFC 4155.
774 * If compat is true laxe POSIX syntax is instead sufficient to match From_ */
775 FL
int is_head(char const *linebuf
, size_t linelen
, bool_t compat
);
777 /* Savage extract date field from From_ line. linelen is convenience as line
778 * must be terminated (but it may end in a newline [sequence]).
779 * Return wether the From_ line was parsed successfully */
780 FL
int extract_date_from_from_(char const *line
, size_t linelen
,
781 char datebuf
[FROM_DATEBUF
]);
783 /* Extract some header fields (see e.g. -t documentation) from a message.
784 * If options&OPT_t_FLAG *and* pstate&PS_t_FLAG are both set a number of
785 * additional header fields are understood and address joining is performed as
786 * necessary, and the subject is treated with additional care, too.
787 * If pstate&PS_t_FLAG is set but OPT_t_FLAG is no more, From: will not be
789 * This calls expandaddr() on some headers and sets checkaddr_err if that is
790 * not NULL -- note it explicitly allows EAF_NAME because aliases are not
791 * expanded when this is called! */
792 FL
void extract_header(FILE *fp
, struct header
*hp
,
793 si8_t
*checkaddr_err
);
795 /* Return the desired header line from the passed message
796 * pointer (or NULL if the desired header field is not available).
797 * If mult is zero, return the content of the first matching header
798 * field only, the content of all matching header fields else */
799 FL
char * hfield_mult(char const *field
, struct message
*mp
, int mult
);
800 #define hfieldX(a, b) hfield_mult(a, b, 1)
801 #define hfield1(a, b) hfield_mult(a, b, 0)
803 /* Check whether the passed line is a header line of the desired breed.
804 * Return the field body, or 0 */
805 FL
char const * thisfield(char const *linebuf
, char const *field
);
807 /* Get sender's name from this message. If the message has a bunch of arpanet
808 * stuff in it, we may have to skin the name before returning it */
809 FL
char * nameof(struct message
*mp
, int reptype
);
811 /* Start of a "comment". Ignore it */
812 FL
char const * skip_comment(char const *cp
);
814 /* Return the start of a route-addr (address in angle brackets), if present */
815 FL
char const * routeaddr(char const *name
);
817 /* Query *expandaddr*, parse it and return flags.
818 * The flags are already adjusted for OPT_INTERACTIVE / OPT_TILDE_FLAG etc. */
819 FL
enum expand_addr_flags
expandaddr_to_eaf(void);
821 /* Check if an address is invalid, either because it is malformed or, if not,
822 * according to eacm. Return FAL0 when it looks good, TRU1 if it is invalid
823 * but the error condition wasn't covered by a 'hard "fail"ure', -1 otherwise */
824 FL si8_t
is_addr_invalid(struct name
*np
,
825 enum expand_addr_check_mode eacm
);
827 /* Does *NP* point to a file or pipe addressee? */
828 #define is_fileorpipe_addr(NP) \
829 (((NP)->n_flags & NAME_ADDRSPEC_ISFILEORPIPE) != 0)
831 /* Return skinned version of *NP*s name */
832 #define skinned_name(NP) \
833 (assert((NP)->n_flags & NAME_SKINNED), \
834 ((struct name const*)NP)->n_name)
836 /* Skin an address according to the RFC 822 interpretation of "host-phrase" */
837 FL
char * skin(char const *name
);
839 /* Skin *name* and extract the *addr-spec* according to RFC 5322.
840 * Store the result in .ag_skinned and also fill in those .ag_ fields that have
841 * actually been seen.
842 * Return 0 if something good has been parsed, 1 if fun didn't exactly know how
843 * to deal with the input, or if that was plain invalid */
844 FL
int addrspec_with_guts(int doskin
, char const *name
,
845 struct addrguts
*agp
);
847 /* Fetch the real name from an internet mail address field */
848 FL
char * realname(char const *name
);
850 /* Fetch the sender's name from the passed message. reptype can be
851 * 0 -- get sender's name for display purposes
852 * 1 -- get sender's name for reply
853 * 2 -- get sender's name for Reply */
854 FL
char * name1(struct message
*mp
, int reptype
);
856 /* Trim away all leading Re: etc., return pointer to plain subject.
857 * Note it doesn't perform any MIME decoding by itself */
858 FL
char * subject_re_trim(char *cp
);
860 FL
int msgidcmp(char const *s1
, char const *s2
);
862 /* See if the given header field is supposed to be ignored */
863 FL
int is_ign(char const *field
, size_t fieldlen
,
864 struct ignoretab igta
[2]);
866 FL
int member(char const *realfield
, struct ignoretab
*table
);
868 /* Fake Sender for From_ lines if missing, e. g. with POP3 */
869 FL
char const * fakefrom(struct message
*mp
);
871 FL
char const * fakedate(time_t t
);
873 /* From username Fri Jan 2 20:13:51 2004
876 #ifdef HAVE_IMAP_SEARCH
877 FL
time_t unixtime(char const *from
);
880 FL
time_t rfctime(char const *date
);
882 FL
time_t combinetime(int year
, int month
, int day
,
883 int hour
, int minute
, int second
);
885 FL
void substdate(struct message
*m
);
887 /* TODO Weird thing that tries to fill in From: and Sender: */
888 FL
void setup_from_and_sender(struct header
*hp
);
890 /* Note: returns 0x1 if both args were NULL */
891 FL
struct name
const * check_from_and_sender(struct name
const *fromfield
,
892 struct name
const *senderfield
);
895 FL
char * getsender(struct message
*m
);
898 /* Fill in / reedit the desired header fields */
899 FL
int grab_headers(struct header
*hp
, enum gfield gflags
,
902 /* Check wether sep->ss_sexpr (or ->ss_regex) matches any header of mp */
903 FL bool_t
header_match(struct message
*mp
, struct search_expr
const *sep
);
909 #ifdef HAVE_IMAP_SEARCH
910 FL
enum okay
imap_search(char const *spec
, int f
);
917 /* Print the docstring of `comm', which may be an abbreviation.
918 * Return FAL0 if there is no such command */
919 #ifdef HAVE_DOCSTRINGS
920 FL bool_t
n_print_comm_docstr(char const *comm
);
923 /* Interpret user commands. If stdin is not a tty, print no prompt; return
924 * wether last processed command returned error -- this is *only* for main()! */
925 FL bool_t
n_commands(void);
927 /* Actual cmd input */
929 /* Read a complete line of input, with editing if interactive and possible.
930 * If prompt is NULL we'll call getprompt() first, if necessary.
931 * nl_escape defines wether user can escape newlines via backslash (POSIX).
932 * If string is set it is used as the initial line content if in interactive
933 * mode, otherwise this argument is ignored for reproducibility.
934 * Return number of octets or a value <0 on error.
935 * Note: may use the currently `source'd file stream instead of stdin! */
936 FL
int n_lex_input(char const *prompt
, bool_t nl_escape
,
937 char **linebuf
, size_t *linesize
, char const *string
939 #ifdef HAVE_MEMORY_DEBUG
940 # define n_lex_input(A,B,C,D,E) n_lex_input(A,B,C,D,E,__FILE__,__LINE__)
943 /* Read a line of input, with editing if interactive and possible, return it
944 * savestr()d or NULL in case of errors or if an empty line would be returned.
945 * This may only be called from toplevel (not during PS_ROBOT).
946 * If prompt is NULL we'll call getprompt() if necessary.
947 * If string is set it is used as the initial line content if in interactive
948 * mode, otherwise this argument is ignored for reproducibility.
949 * If OPT_INTERACTIVE a non-empty return is saved in the history, isgabby */
950 FL
char * n_lex_input_cp_addhist(char const *prompt
, char const *string
,
953 /* Deal with loading of resource files and dealing with a stack of files for
954 * the source command */
956 /* Load a file of user definitions -- this is *only* for main()! */
957 FL
void n_load(char const *name
);
959 /* "Load" all the -X command line definitions in order -- *only* for main() */
960 FL
void n_load_Xargs(char const **lines
);
962 /* Pushdown current input file and switch to a new one. Set the global flag
963 * PS_SOURCING so that others will realize that they are no longer reading from
964 * a tty (in all probability).
965 * The latter won't return failure (TODO should be replaced by "-f FILE") */
966 FL
int c_source(void *v
);
967 FL
int c_source_if(void *v
);
969 /* Evaluate a complete macro / a single command. For the former lines will
970 * always be free()d, for the latter cmd will always be duplicated internally */
971 FL bool_t
n_source_macro(char const *name
, char **lines
);
972 FL bool_t
n_source_command(char const *cmd
);
974 /* XXX Hack: may we release our (interactive) (terminal) control to a different
975 * XXX program, e.g., a $PAGER? */
976 FL bool_t
n_source_may_yield_control(void);
982 /* Count the number of arguments in the given string raw list */
983 FL
int argcount(char **argv
);
985 /* Convert user string of message numbers and store the numbers into vector.
986 * Returns the count of messages picked up or -1 on error */
987 FL
int getmsglist(char *buf
, int *vector
, int flags
);
989 /* Scan out the list of string arguments, shell style for a RAWLIST */
990 FL
int getrawlist(char const *line
, size_t linesize
,
991 char **argv
, int argc
, int echolist
);
993 /* Find the first message whose flags&m==f and return its message number */
994 FL
int first(int f
, int m
);
996 /* Mark the named message by setting its mark bit */
997 FL
void mark(int mesg
, int f
);
1003 /* Return a file buffer all ready to read up the passed message pointer */
1004 FL
FILE * setinput(struct mailbox
*mp
, struct message
*m
,
1005 enum needspec need
);
1008 FL
enum okay
get_body(struct message
*mp
);
1010 /* Reset (free) the global message array */
1011 FL
void message_reset(void);
1013 /* Append the passed message descriptor onto the message array; if mp is NULL,
1014 * NULLify the entry at &[msgCount-1] */
1015 FL
void message_append(struct message
*mp
);
1017 /* Append a NULL message */
1018 FL
void message_append_null(void);
1020 /* Check wether sep->ss_sexpr (or ->ss_regex) matches mp. If with_headers is
1021 * true then the headers will also be searched (as plain text) */
1022 FL bool_t
message_match(struct message
*mp
, struct search_expr
const *sep
,
1023 bool_t with_headers
);
1026 FL
struct message
* setdot(struct message
*mp
);
1028 /* Touch the named message by setting its MTOUCH flag. Touched messages have
1029 * the effect of not being sent back to the system mailbox on exit */
1030 FL
void touch(struct message
*mp
);
1036 FL
int maildir_setfile(char const *name
, enum fedit_mode fm
);
1038 FL bool_t
maildir_quit(void);
1040 FL
enum okay
maildir_append(char const *name
, FILE *fp
, long offset
);
1042 FL
enum okay
maildir_remove(char const *name
);
1048 /* Quit quickly. In recursed state, return error to just pop the input level */
1049 FL
int c_exit(void *v
);
1055 /* Try to use alloca() for some function-local buffers and data, fall back to
1056 * smalloc()/free() if not available */
1059 # define ac_alloc(n) HAVE_ALLOCA(n)
1060 # define ac_free(n) do {UNUSED(n);} while (0)
1062 # define ac_alloc(n) smalloc(n)
1063 # define ac_free(n) free(n)
1066 /* Generic heap memory */
1068 FL
void * smalloc(size_t s SMALLOC_DEBUG_ARGS
);
1069 FL
void * srealloc(void *v
, size_t s SMALLOC_DEBUG_ARGS
);
1070 FL
void * scalloc(size_t nmemb
, size_t size SMALLOC_DEBUG_ARGS
);
1072 #ifdef HAVE_MEMORY_DEBUG
1073 FL
void sfree(void *v SMALLOC_DEBUG_ARGS
);
1075 /* Called by sreset(), then */
1076 FL
void n_memreset(void);
1078 FL
int c_memtrace(void *v
);
1080 /* For immediate debugging purposes, it is possible to check on request */
1081 FL bool_t
n__memcheck(char const *file
, int line
);
1083 # define smalloc(SZ) smalloc(SZ, __FILE__, __LINE__)
1084 # define srealloc(P,SZ) srealloc(P, SZ, __FILE__, __LINE__)
1085 # define scalloc(N,SZ) scalloc(N, SZ, __FILE__, __LINE__)
1086 # define free(P) sfree(P, __FILE__, __LINE__)
1087 # define c_memtrace c_memtrace
1088 # define n_memcheck() n__memcheck(__FILE__, __LINE__)
1090 # define n_memreset() do{}while(0)
1093 /* String storage, auto-reclaimed after execution level is left */
1095 /* Allocate size more bytes of space and return the address of the first byte
1096 * to the caller. An even number of bytes are always allocated so that the
1097 * space will always be on a word boundary */
1098 FL
void * salloc(size_t size SALLOC_DEBUG_ARGS
);
1099 FL
void * csalloc(size_t nmemb
, size_t size SALLOC_DEBUG_ARGS
);
1100 #ifdef HAVE_MEMORY_DEBUG
1101 # define salloc(SZ) salloc(SZ, __FILE__, __LINE__)
1102 # define csalloc(NM,SZ) csalloc(NM, SZ, __FILE__, __LINE__)
1105 /* Auto-reclaim string storage; if only_if_relaxed is true then only perform
1106 * the reset when a srelax_hold() is currently active */
1107 FL
void sreset(bool_t only_if_relaxed
);
1109 /* The "problem" with sreset() is that it releases all string storage except
1110 * what was present once spreserve() had been called; it therefore cannot be
1111 * called from all that code which yet exists and walks about all the messages
1112 * in order, e.g. quit(), searches, etc., because, unfortunately, these code
1113 * paths are reached with new intermediate string dope already in use.
1114 * Thus such code should take a srelax_hold(), successively call srelax() after
1115 * a single message has been handled, and finally srelax_rele() (unless it is
1116 * clear that sreset() occurs anyway) */
1117 FL
void srelax_hold(void);
1118 FL
void srelax_rele(void);
1119 FL
void srelax(void);
1121 /* Make current string storage permanent: new allocs will be auto-reclaimed by
1122 * sreset(). This is called once only, from within main() */
1123 FL
void spreserve(void);
1125 /* 'sstats' command */
1126 #ifdef HAVE_MEMORY_DEBUG
1127 FL
int c_sstats(void *v
);
1128 # define c_sstats c_sstats
1135 /* *charset-7bit*, else CHARSET_7BIT */
1136 FL
char const * charset_get_7bit(void);
1138 /* *charset-8bit*, else CHARSET_8BIT */
1140 FL
char const * charset_get_8bit(void);
1143 /* LC_CTYPE:CODESET / *ttycharset*, else *charset-8bit*, else CHARSET_8BIT */
1144 FL
char const * charset_get_lc(void);
1146 /* *sendcharsets* .. *charset-8bit* iterator; *a_charset_to_try_first* may be
1147 * used to prepend a charset to this list (e.g., for *reply-in-same-charset*).
1148 * The returned boolean indicates charset_iter_is_valid().
1149 * Without HAVE_ICONV, this "iterates" over charset_get_lc() only */
1150 FL bool_t
charset_iter_reset(char const *a_charset_to_try_first
);
1151 FL bool_t
charset_iter_next(void);
1152 FL bool_t
charset_iter_is_valid(void);
1153 FL
char const * charset_iter(void);
1155 /* And this is (xxx temporary?) which returns the iterator if that is valid and
1156 * otherwise either charset_get_8bit() or charset_get_lc() dep. on HAVE_ICONV */
1157 FL
char const * charset_iter_or_fallback(void);
1159 FL
void charset_iter_recurse(char *outer_storage
[2]); /* TODO LEGACY */
1160 FL
void charset_iter_restore(char *outer_storage
[2]); /* TODO LEGACY */
1162 /* Check wether our headers will need MIME conversion */
1164 FL
char const * need_hdrconv(struct header
*hp
);
1167 /* Convert header fields from RFC 1522 format */
1168 FL
void mime_fromhdr(struct str
const *in
, struct str
*out
,
1169 enum tdflags flags
);
1171 /* Interpret MIME strings in parts of an address field */
1172 FL
char * mime_fromaddr(char const *name
);
1174 /* fwrite(3) performing the given MIME conversion */
1175 FL ssize_t
mime_write(char const *ptr
, size_t size
, FILE *f
,
1176 enum conversion convert
, enum tdflags dflags
,
1177 struct quoteflt
*qf
, struct str
*rest
);
1178 FL ssize_t
xmime_write(char const *ptr
, size_t size
, /* TODO LEGACY */
1179 FILE *f
, enum conversion convert
, enum tdflags dflags
);
1183 * Content-Transfer-Encodings as defined in RFC 2045 (and RFC 2047):
1184 * - Quoted-Printable, section 6.7
1185 * - Base64, section 6.8
1186 * TODO for now this is pretty mixed up regarding this external interface.
1187 * TODO in v15.0 CTE will be filter based, and explicit conversion will
1188 * TODO gain clear error codes
1191 /* Utilities: the former converts the byte c into a (NUL terminated)
1192 * hexadecimal string as is used in URL percent- and quoted-printable encoding,
1193 * the latter performs the backward conversion and returns the character or -1
1194 * on error; both don't deal with the sequence-introducing percent "%" */
1195 FL
char * mime_char_to_hexseq(char store
[3], char c
);
1196 FL si32_t
mime_hexseq_to_char(char const *hex
);
1198 /* Default MIME Content-Transfer-Encoding: as via *encoding* */
1199 FL
enum mime_enc
mime_enc_target(void);
1201 /* Map from a Content-Transfer-Encoding: header body (which may be NULL) */
1202 FL
enum mime_enc
mime_enc_from_ctehead(char const *hbody
);
1204 /* XXX Try to get rid of that */
1205 FL
char const * mime_enc_from_conversion(enum conversion
const convert
);
1207 /* How many characters of (the complete body) ln need to be quoted.
1208 * Only MIMEEF_ISHEAD and MIMEEF_ISENCWORD are understood */
1209 FL
size_t mime_enc_mustquote(char const *ln
, size_t lnlen
,
1210 enum mime_enc_flags flags
);
1212 /* How much space is necessary to encode len bytes in QP, worst case.
1213 * Includes room for terminator */
1214 FL
size_t qp_encode_calc_size(size_t len
);
1216 /* If flags includes QP_ISHEAD these assume "word" input and use special
1217 * quoting rules in addition; soft line breaks are not generated.
1218 * Otherwise complete input lines are assumed and soft line breaks are
1219 * generated as necessary */
1220 FL
struct str
* qp_encode(struct str
*out
, struct str
const *in
,
1221 enum qpflags flags
);
1223 FL
struct str
* qp_encode_cp(struct str
*out
, char const *cp
,
1224 enum qpflags flags
);
1225 FL
struct str
* qp_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
1226 enum qpflags flags
);
1229 /* If rest is set then decoding will assume body text input (assumes input
1230 * represents lines, only create output when input didn't end with soft line
1231 * break [except it finalizes an encoded CRLF pair]), otherwise it is assumed
1232 * to decode a header strings and (1) uses special decoding rules and (b)
1233 * directly produces output.
1234 * The buffers of out and possibly rest will be managed via srealloc().
1235 * Returns OKAY. XXX or STOP on error (in which case out is set to an error
1236 * XXX message); caller is responsible to free buffers */
1237 FL
int qp_decode(struct str
*out
, struct str
const *in
,
1240 /* How much space is necessary to encode len bytes in Base64, worst case.
1241 * Includes room for (CR/LF/CRLF and) terminator */
1242 FL
size_t b64_encode_calc_size(size_t len
);
1244 /* Note these simply convert all the input (if possible), including the
1245 * insertion of NL sequences if B64_CRLF or B64_LF is set (and multiple thereof
1246 * if B64_MULTILINE is set).
1247 * Thus, in the B64_BUF case, better call b64_encode_calc_size() first */
1248 FL
struct str
* b64_encode(struct str
*out
, struct str
const *in
,
1249 enum b64flags flags
);
1250 FL
struct str
* b64_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
1251 enum b64flags flags
);
1253 FL
struct str
* b64_encode_cp(struct str
*out
, char const *cp
,
1254 enum b64flags flags
);
1257 /* If rest is set then decoding will assume text input.
1258 * The buffers of out and possibly rest will be managed via srealloc().
1259 * Returns OKAY or STOP on error (in which case out is set to an error
1260 * message); caller is responsible to free buffers.
1261 * XXX STOP is effectively not returned for text input (rest!=NULL), instead
1262 * XXX replacement characters are produced for invalid data */
1263 FL
int b64_decode(struct str
*out
, struct str
const *in
,
1270 /* Get a mime style parameter from a header body */
1271 FL
char * mime_param_get(char const *param
, char const *headerbody
);
1273 /* Format parameter name to have value, salloc() it or NULL (error) in result.
1274 * 0 on error, 1 or -1 on success: the latter if result contains \n newlines,
1275 * which it will if the created param requires more than MIME_LINELEN bytes;
1276 * there is never a trailing newline character */
1277 /* TODO mime_param_create() should return a StrList<> or something.
1278 * TODO in fact it should take a HeaderField* and append a HeaderFieldParam*! */
1279 FL si8_t
mime_param_create(struct str
*result
, char const *name
,
1282 /* Get the boundary out of a Content-Type: multipart/xyz header field, return
1283 * salloc()ed copy of it; store strlen() in *len if set */
1284 FL
char * mime_param_boundary_get(char const *headerbody
, size_t *len
);
1286 /* Create a salloc()ed MIME boundary */
1287 FL
char * mime_param_boundary_create(void);
1293 /* Create MIME part object tree for and of mp */
1294 FL
struct mimepart
* mime_parse_msg(struct message
*mp
,
1295 enum mime_parse_flags mpf
);
1301 /* `(un)?mimetype' commands */
1302 FL
int c_mimetype(void *v
);
1303 FL
int c_unmimetype(void *v
);
1305 /* Return a Content-Type matching the name, or NULL if none could be found */
1306 FL
char * mime_type_classify_filename(char const *name
);
1308 /* Classify content of *fp* as necessary and fill in arguments; **charset* is
1309 * left alone unless it's non-NULL */
1310 FL
enum conversion
mime_type_classify_file(FILE *fp
, char const **contenttype
,
1311 char const **charset
, int *do_iconv
);
1313 /* Dependend on *mime-counter-evidence* mpp->m_ct_type_usr_ovwr will be set,
1314 * but otherwise mpp is const */
1315 FL
enum mimecontent
mime_type_classify_part(struct mimepart
*mpp
);
1317 /* Query handler for a part, return the plain type (& MIME_HDL_TYPE_MASK).
1318 * mhp is anyway initialized (mh_flags, mh_msg) */
1319 FL
enum mime_handler_flags
mime_type_handler(struct mime_handler
*mhp
,
1320 struct mimepart
const *mpp
,
1321 enum sendaction action
);
1327 /* Allocate a single element of a name list, initialize its name field to the
1328 * passed name and return it */
1329 FL
struct name
* nalloc(char *str
, enum gfield ntype
);
1331 /* Like nalloc(), but initialize from content of np */
1332 FL
struct name
* ndup(struct name
*np
, enum gfield ntype
);
1334 /* Concatenate the two passed name lists, return the result */
1335 FL
struct name
* cat(struct name
*n1
, struct name
*n2
);
1338 FL
struct name
* namelist_dup(struct name
const *np
, enum gfield ntype
);
1340 /* Determine the number of undeleted elements in a name list and return it;
1341 * the latter also doesn't count file and pipe addressees in addition */
1342 FL ui32_t
count(struct name
const *np
);
1343 FL ui32_t
count_nonlocal(struct name
const *np
);
1345 /* Extract a list of names from a line, and make a list of names from it.
1346 * Return the list or NULL if none found */
1347 FL
struct name
* extract(char const *line
, enum gfield ntype
);
1349 /* Like extract() unless line contains anyof ",\"\\(<|", in which case
1350 * comma-separated list extraction is used instead */
1351 FL
struct name
* lextract(char const *line
, enum gfield ntype
);
1353 /* Turn a list of names into a string of the same names */
1354 FL
char * detract(struct name
*np
, enum gfield ntype
);
1356 /* Get a lextract() list via n_lex_input_cp_addhist(), reassigning to *np* */
1357 FL
struct name
* grab_names(char const *field
, struct name
*np
, int comma
,
1358 enum gfield gflags
);
1360 /* Check wether n1 n2 share the domain name */
1361 FL bool_t
name_is_same_domain(struct name
const *n1
,
1362 struct name
const *n2
);
1364 /* Check all addresses in np and delete invalid ones; if set_on_error is not
1365 * NULL it'll be set to TRU1 for error or -1 for "hard fail" error */
1366 FL
struct name
* checkaddrs(struct name
*np
, enum expand_addr_check_mode eacm
,
1367 si8_t
*set_on_error
);
1369 /* Vaporise all duplicate addresses in hp (.h_(to|cc|bcc)) so that an address
1370 * that "first" occurs in To: is solely in there, ditto Cc:, after expanding
1371 * aliases etc. eacm and set_on_error are passed to checkaddrs(), metoo is
1372 * passed to usermap(). After updating hp to the new state this returns
1373 * a flat list of all addressees, which may be NULL */
1374 FL
struct name
* namelist_vaporise_head(struct header
*hp
,
1375 enum expand_addr_check_mode eacm
, bool_t metoo
,
1376 si8_t
*set_on_error
);
1378 /* Map all of the aliased users in the invoker's mailrc file and insert them
1380 FL
struct name
* usermap(struct name
*names
, bool_t force_metoo
);
1382 /* Remove all of the duplicates from the passed name list by insertion sorting
1383 * them, then checking for dups. Return the head of the new list */
1384 FL
struct name
* elide(struct name
*names
);
1386 /* `alternates' deal with the list of alternate names */
1387 FL
int c_alternates(void *v
);
1389 FL
struct name
* delete_alternates(struct name
*np
);
1391 FL
int is_myname(char const *name
);
1394 FL
int c_alias(void *v
);
1395 FL
int c_unalias(void *v
);
1397 /* `(un)?ml(ist|subscribe)', and a check wether a name is a (wanted) list */
1398 FL
int c_mlist(void *v
);
1399 FL
int c_unmlist(void *v
);
1400 FL
int c_mlsubscribe(void *v
);
1401 FL
int c_unmlsubscribe(void *v
);
1403 FL
enum mlist_state
is_mlist(char const *name
, bool_t subscribed_only
);
1405 /* `(un)?shortcut', and check if str is one, return expansion or NULL */
1406 FL
int c_shortcut(void *v
);
1407 FL
int c_unshortcut(void *v
);
1409 FL
char const * shortcut_expand(char const *str
);
1411 /* `(un)?customhdr'.
1412 * Query a list of all currently defined custom headers (salloc()ed) */
1413 FL
int c_customhdr(void *v
);
1414 FL
int c_uncustomhdr(void *v
);
1416 FL
struct n_header_field
* n_customhdr_query(void);
1424 FL
enum okay
ssl_open(struct url
const *urlp
, struct sock
*sp
);
1427 FL
void ssl_gen_err(char const *fmt
, ...);
1430 FL
int c_verify(void *vp
);
1433 FL
FILE * smime_sign(FILE *ip
, char const *addr
);
1436 FL
FILE * smime_encrypt(FILE *ip
, char const *certfile
, char const *to
);
1438 FL
struct message
* smime_decrypt(struct message
*m
, char const *to
,
1439 char const *cc
, int signcall
);
1442 FL
enum okay
smime_certsave(struct message
*m
, int n
, FILE *op
);
1444 #else /* HAVE_OPENSSL */
1445 # define c_verify c_cmdnotsupp
1452 /* Test to see if the passed file name is a directory, return true if it is */
1453 FL bool_t
is_dir(char const *name
);
1456 FL bool_t
n_path_mkdir(char const *name
);
1458 /* Delete a file, but only if the file is a plain file; return FAL0 on system
1459 * error and TRUM1 if name is not a plain file, return TRU1 on success */
1460 FL bool_t
n_path_rm(char const *name
);
1462 /* A get-wd..restore-wd approach */
1463 FL
enum okay
cwget(struct cw
*cw
);
1464 FL
enum okay
cwret(struct cw
*cw
);
1465 FL
void cwrelse(struct cw
*cw
);
1473 FL
enum okay
pop3_noop(void);
1476 FL
int pop3_setfile(char const *server
, enum fedit_mode fm
);
1479 FL
enum okay
pop3_header(struct message
*m
);
1482 FL
enum okay
pop3_body(struct message
*m
);
1485 FL bool_t
pop3_quit(void);
1486 #endif /* HAVE_POP3 */
1490 * Subprocesses, popen, but also file handling with registering
1493 /* For program startup in main.c: initialize process manager */
1494 FL
void command_manager_start(void);
1496 /* Notes: OF_CLOEXEC is implied in oflags, xflags may be NULL */
1497 FL
FILE * safe_fopen(char const *file
, char const *oflags
, int *xflags
);
1499 /* Notes: OF_CLOEXEC|OF_REGISTER are implied in oflags!
1500 * Exception is Fdopen() if nocloexec is TRU1, but otherwise even for it the fd
1501 * creator has to take appropriate steps in order to ensure this is true! */
1502 FL
FILE * Fopen(char const *file
, char const *oflags
);
1503 FL
FILE * Fdopen(int fd
, char const *oflags
, bool_t nocloexec
);
1505 FL
int Fclose(FILE *fp
);
1507 /* Open file according to oflags (see popen.c). Handles compressed files */
1508 FL
FILE * Zopen(char const *file
, char const *oflags
);
1510 /* Create a temporary file in tempdir, use namehint for its name (prefix
1511 * unless OF_SUFFIX is set, in which case namehint is an extension that MUST be
1512 * part of the resulting filename, otherwise Ftmp() will fail), store the
1513 * unique name in fn (unless OF_UNLINK is set in oflags), and return a stdio
1514 * FILE pointer with access oflags. OF_CLOEXEC is implied in oflags.
1515 * One of OF_WRONLY and OF_RDWR must be set. Mode of 0600 is implied */
1516 FL
FILE * Ftmp(char **fn
, char const *namehint
, enum oflags oflags
);
1518 /* If OF_HOLDSIGS was set when calling Ftmp(), then hold_all_sigs() had been
1519 * called: call this to unlink(2) and free *fn and to rele_all_sigs() */
1520 FL
void Ftmp_release(char **fn
);
1522 /* Free the resources associated with the given filename. To be called after
1524 FL
void Ftmp_free(char **fn
);
1526 /* Create a pipe and ensure CLOEXEC bit is set in both descriptors */
1527 FL bool_t
pipe_cloexec(int fd
[2]);
1530 * env_addon may be NULL, otherwise it is expected to be a NULL terminated
1531 * array of "K=V" strings to be placed into the childs environment.
1532 * If cmd==(char*)-1 then shell is indeed expected to be a PTF :P that will be
1533 * called from within the child process */
1534 FL
FILE * Popen(char const *cmd
, char const *mode
, char const *shell
,
1535 char const **env_addon
, int newfd1
);
1536 FL bool_t
Pclose(FILE *fp
, bool_t dowait
);
1538 /* In OPT_INTERACTIVE, we want to go over $PAGER.
1539 * These are specialized version of Popen()/Pclose() which also encapsulate
1540 * error message printing, terminal handling etc. additionally */
1541 FL
FILE * n_pager_open(void);
1542 FL bool_t
n_pager_close(FILE *fp
);
1545 FL
void close_all_files(void);
1547 /* Fork a child process, enable use of the *child() series below */
1548 FL
int fork_child(void);
1550 /* Run a command without a shell, with optional arguments and splicing of stdin
1551 * and stdout. FDs may also be COMMAND_FD_NULL and COMMAND_FD_PASS, meaning to
1552 * redirect from/to /dev/null or pass through our own set of FDs; in the
1553 * latter case terminal capabilities are saved/restored if possible.
1554 * The command name can be a sequence of words.
1555 * Signals must be handled by the caller. "Mask" contains the signals to
1556 * ignore in the new process. SIGINT is enabled unless it's in the mask.
1557 * env_addon may be NULL, otherwise it is expected to be a NULL terminated
1558 * array of "K=V" strings to be placed into the childs environment */
1559 FL
int run_command(char const *cmd
, sigset_t
*mask
, int infd
,
1560 int outfd
, char const *a0
, char const *a1
, char const *a2
,
1561 char const **env_addon
);
1563 /* Like run_command, but don't wait for the command to finish.
1564 * Also it is usually an error to use COMMAND_FD_PASS for this one */
1565 FL
int start_command(char const *cmd
, sigset_t
*mask
, int infd
,
1566 int outfd
, char const *a0
, char const *a1
, char const *a2
,
1567 char const **env_addon
);
1569 /* In-child process */
1570 FL
void prepare_child(sigset_t
*nset
, int infd
, int outfd
);
1572 /* Mark a child as don't care - pid */
1573 FL
void free_child(int pid
);
1575 /* Wait for pid, return wether we've had a normal EXIT_SUCCESS exit.
1576 * If wait_status is set, set it to the reported waitpid(2) wait status */
1577 FL bool_t
wait_child(int pid
, int *wait_status
);
1583 /* Save all of the undetermined messages at the top of "mbox". Save all
1584 * untouched messages back in the system mailbox. Remove the system mailbox,
1585 * if none saved there */
1586 FL bool_t
quit(void);
1588 /* Adjust the message flags in each message */
1589 FL
int holdbits(void);
1591 /* Create another temporary file and copy user's mbox file darin. If there is
1592 * no mbox, copy nothing. If he has specified "append" don't copy his mailbox,
1593 * just copy saveable entries at the end */
1594 FL
enum okay
makembox(void);
1596 FL
void save_mbox_for_possible_quitstuff(void); /* TODO DROP IF U CAN */
1598 FL
int savequitflags(void);
1600 FL
void restorequitflags(int);
1606 /* Send message described by the passed pointer to the passed output buffer.
1607 * Return -1 on error. Adjust the status: field if need be. If doign is
1608 * given, suppress ignored header fields. prefix is a string to prepend to
1609 * each output line. action = data destination
1610 * (SEND_MBOX,_TOFILE,_TODISP,_QUOTE,_DECRYPT). stats[0] is line count,
1611 * stats[1] is character count. stats may be NULL. Note that stats[0] is
1612 * valid for SEND_MBOX only */
1613 FL
int sendmp(struct message
*mp
, FILE *obuf
, struct ignoretab
*doign
,
1614 char const *prefix
, enum sendaction action
, ui64_t
*stats
);
1620 /* Interface between the argument list and the mail1 routine which does all the
1622 FL
int mail(struct name
*to
, struct name
*cc
, struct name
*bcc
,
1623 char *subject
, struct attachment
*attach
, char *quotefile
,
1624 int recipient_record
);
1626 /* `mail' and `Mail' commands, respectively */
1627 FL
int c_sendmail(void *v
);
1628 FL
int c_Sendmail(void *v
);
1630 /* Mail a message on standard input to the people indicated in the passed
1631 * header. (Internal interface) */
1632 FL
enum okay
mail1(struct header
*hp
, int printheaders
,
1633 struct message
*quote
, char *quotefile
, int recipient_record
,
1636 /* Create a Date: header field.
1637 * We compare the localtime() and gmtime() results to get the timezone, because
1638 * numeric timezones are easier to read and because $TZ isn't always set */
1639 FL
int mkdate(FILE *fo
, char const *field
);
1641 /* Dump the to, subject, cc header on the passed file buffer.
1642 * nosend_msg tells us not to dig to deep but to instead go for compose mode or
1643 * editing a message (yet we're stupid and cannot do it any better) - if it is
1644 * TRUM1 then we're really in compose mode and will produce some fields for
1645 * easier filling in */
1646 FL
int puthead(bool_t nosend_msg
, struct header
*hp
, FILE *fo
,
1647 enum gfield w
, enum sendaction action
,
1648 enum conversion convert
, char const *contenttype
,
1649 char const *charset
);
1652 FL
enum okay
resend_msg(struct message
*mp
, struct name
*to
, int add_resent
);
1658 /* Evaluate the string given as a new mailbox name. Supported meta characters:
1659 * . % for my system mail box
1660 * . %user for user's system mail box
1661 * . # for previous file
1662 * . & invoker's mbox file
1663 * . +file file in folder directory
1664 * . any shell meta character (except for FEXP_NSHELL).
1665 * If FEXP_NSHELL is set you possibly want to call fexpand_nshell_quote(),
1666 * a poor man's vis(3), on name before calling this (and showing the user).
1667 * Returns the file name as an auto-reclaimed string */
1668 FL
char * fexpand(char const *name
, enum fexp_mode fexpm
);
1670 #define expand(N) fexpand(N, FEXP_FULL) /* XXX obsolete */
1671 #define file_expand(N) fexpand(N, FEXP_LOCAL) /* XXX obsolete */
1673 /* A poor man's vis(3) for only backslash escaping as for FEXP_NSHELL.
1674 * Returns the (possibly adjusted) buffer in auto-reclaimed storage */
1675 FL
char * fexpand_nshell_quote(char const *name
);
1677 /* (Try to) Expand ^~/? and ^~USER/? constructs.
1678 * Returns the completely resolved (maybe empty or identical to input)
1679 * salloc()ed string */
1680 FL
char * n_shell_expand_tilde(char const *s
, bool_t
*err_or_null
);
1682 /* (Try to) Expand any shell variable in s, allowing backslash escaping
1683 * (of any following character) with bsescape.
1684 * Returns the completely resolved (maybe empty) salloc()ed string.
1686 FL
char * n_shell_expand_var(char const *s
, bool_t bsescape
,
1687 bool_t
*err_or_null
);
1689 /* Check wether *s is an escape sequence, expand it as necessary.
1690 * Returns the expanded sequence or 0 if **s is NUL or PROMPT_STOP if it is \c.
1691 * *s is advanced to after the expanded sequence (as possible).
1692 * If use_prompt_extensions is set, an enum prompt_exp may be returned */
1693 FL
int n_shell_expand_escape(char const **s
,
1694 bool_t use_prompt_extensions
);
1700 FL
void n_raise(int signo
);
1702 /* Provide BSD-like signal() on all (POSIX) systems */
1703 FL sighandler_type
safe_signal(int signum
, sighandler_type handler
);
1705 /* Hold *all* signals but SIGCHLD, and release that total block again */
1706 FL
void hold_all_sigs(void);
1707 FL
void rele_all_sigs(void);
1709 /* Hold HUP/QUIT/INT */
1710 FL
void hold_sigs(void);
1711 FL
void rele_sigs(void);
1713 /* Call _ENTER_SWITCH() with the according flags, it'll take care for the rest
1714 * and also set the jump buffer - it returns 0 if anything went fine and
1715 * a signal number if a jump occurred, in which case all handlers requested in
1716 * flags are temporarily SIG_IGN.
1717 * _cleanup_ping() informs the condome that no jumps etc. shall be performed
1718 * until _leave() is called in the following -- to be (optionally) called right
1719 * before the local jump label is reached which is jumped to after a long jump
1720 * occurred, straight code flow provided, e.g., to avoid destructors to be
1721 * called twice. _leave() must always be called last, reraise_flags will be
1722 * used to decide how signal handling has to continue
1724 #define n_SIGMAN_ENTER_SWITCH(S,F) do{\
1727 if(sigsetjmp((S)->sm_jump, 1))\
1731 n__sigman_enter(S, __x__);\
1732 }while(0); switch((S)->sm_signo)
1733 FL
int n__sigman_enter(struct n_sigman
*self
, int flags
);
1734 FL
void n_sigman_cleanup_ping(struct n_sigman
*self
);
1735 FL
void n_sigman_leave(struct n_sigman
*self
, enum n_sigman_flags flags
);
1737 /* Pending signal or 0? */
1738 FL
int n_sigman_peek(void);
1739 FL
void n_sigman_consume(void);
1741 /* Not-Yet-Dead debug information (handler installation in main.c) */
1742 #if defined HAVE_DEBUG || defined HAVE_DEVEL
1743 FL
void _nyd_chirp(ui8_t act
, char const *file
, ui32_t line
,
1745 FL
void _nyd_oncrash(int signo
);
1748 # define NYD_ENTER _nyd_chirp(1, __FILE__, __LINE__, __FUN__)
1749 # define NYD_LEAVE _nyd_chirp(2, __FILE__, __LINE__, __FUN__)
1750 # define NYD _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
1751 # define NYD_X _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
1753 # define NYD2_ENTER _nyd_chirp(1, __FILE__, __LINE__, __FUN__)
1754 # define NYD2_LEAVE _nyd_chirp(2, __FILE__, __LINE__, __FUN__)
1755 # define NYD2 _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
1761 # define NYD_ENTER do {} while (0)
1762 # define NYD_LEAVE do {} while (0)
1763 # define NYD do {} while (0)
1764 # define NYD_X do {} while (0) /* XXX LEGACY */
1767 # define NYD2_ENTER do {} while (0)
1768 # define NYD2_LEAVE do {} while (0)
1769 # define NYD2 do {} while (0)
1777 /* Send a message via SMTP */
1778 FL bool_t
smtp_mta(struct sendbundle
*sbp
);
1786 FL bool_t
sopen(struct sock
*sp
, struct url
*urlp
);
1787 FL
int sclose(struct sock
*sp
);
1788 FL
enum okay
swrite(struct sock
*sp
, char const *data
);
1789 FL
enum okay
swrite1(struct sock
*sp
, char const *data
, int sz
,
1793 FL
int sgetline(char **line
, size_t *linesize
, size_t *linelen
,
1794 struct sock
*sp SMALLOC_DEBUG_ARGS
);
1795 # ifdef HAVE_MEMORY_DEBUG
1796 # define sgetline(A,B,C,D) sgetline(A, B, C, D, __FILE__, __LINE__)
1805 /* Direct mappings of the various spam* commands */
1806 FL
int c_spam_clear(void *v
);
1807 FL
int c_spam_set(void *v
);
1808 FL
int c_spam_forget(void *v
);
1809 FL
int c_spam_ham(void *v
);
1810 FL
int c_spam_rate(void *v
);
1811 FL
int c_spam_spam(void *v
);
1813 # define c_spam_clear c_cmdnotsupp
1814 # define c_spam_set c_cmdnotsupp
1815 # define c_spam_forget c_cmdnotsupp
1816 # define c_spam_ham c_cmdnotsupp
1817 # define c_spam_rate c_cmdnotsupp
1818 # define c_spam_spam c_cmdnotsupp
1827 FL
void ssl_set_verify_level(struct url
const *urlp
);
1830 FL
enum okay
ssl_verify_decide(void);
1833 FL
enum okay
smime_split(FILE *ip
, FILE **hp
, FILE **bp
, long xcount
,
1837 FL
FILE * smime_sign_assemble(FILE *hp
, FILE *bp
, FILE *sp
,
1838 char const *message_digest
);
1841 FL
FILE * smime_encrypt_assemble(FILE *hp
, FILE *yp
);
1844 FL
struct message
* smime_decrypt_assemble(struct message
*m
, FILE *hp
,
1848 FL
int c_certsave(void *v
);
1851 FL
enum okay
rfc2595_hostname_match(char const *host
, char const *pattern
);
1852 #else /* HAVE_SSL */
1853 # define c_certsave c_cmdnotsupp
1860 /* Return a pointer to a dynamic copy of the argument */
1861 FL
char * savestr(char const *str SALLOC_DEBUG_ARGS
);
1862 FL
char * savestrbuf(char const *sbuf
, size_t sbuf_len SALLOC_DEBUG_ARGS
);
1863 #ifdef HAVE_MEMORY_DEBUG
1864 # define savestr(CP) savestr(CP, __FILE__, __LINE__)
1865 # define savestrbuf(CBP,CBL) savestrbuf(CBP, CBL, __FILE__, __LINE__)
1868 /* Concatenate cp2 onto cp1 (if not NULL), separated by sep (if not '\0') */
1869 FL
char * savecatsep(char const *cp1
, char sep
, char const *cp2
1871 #ifdef HAVE_MEMORY_DEBUG
1872 # define savecatsep(S1,SEP,S2) savecatsep(S1, SEP, S2, __FILE__, __LINE__)
1875 /* Make copy of argument incorporating old one, if set, separated by space */
1876 #define save2str(S,O) savecatsep(O, ' ', S)
1879 #define savecat(S1,S2) savecatsep(S1, '\0', S2)
1881 /* Create duplicate, lowercasing all characters along the way */
1882 FL
char * i_strdup(char const *src SALLOC_DEBUG_ARGS
);
1883 #ifdef HAVE_MEMORY_DEBUG
1884 # define i_strdup(CP) i_strdup(CP, __FILE__, __LINE__)
1888 FL
struct str
* str_concat_csvl(struct str
*self
, ...);
1891 FL
struct str
* str_concat_cpa(struct str
*self
, char const * const *cpa
,
1892 char const *sep_o_null SALLOC_DEBUG_ARGS
);
1893 #ifdef HAVE_MEMORY_DEBUG
1894 # define str_concat_cpa(S,A,N) str_concat_cpa(S, A, N, __FILE__, __LINE__)
1897 /* Plain char* support, not auto-reclaimed (unless noted) */
1899 /* Are any of the characters in the two strings the same? */
1900 FL
int anyof(char const *s1
, char const *s2
);
1902 /* Treat *iolist as a sep separated list of strings; find and return the
1903 * next entry, trimming surrounding whitespace, and point *iolist to the next
1904 * entry or to NULL if no more entries are contained. If ignore_empty is not
1905 * set empty entries are started over.
1906 * strescsep will assert that sep is not NULL, and allows escaping of the
1907 * separator character with a backslash.
1908 * Return NULL or an entry */
1909 FL
char * n_strsep(char **iolist
, char sep
, bool_t ignore_empty
);
1910 FL
char * n_strescsep(char **iolist
, char sep
, bool_t ignore_empty
);
1912 /* Copy a string, lowercasing it as we go; *size* is buffer size of *dest*;
1913 * *dest* will always be terminated unless *size* is 0 */
1914 FL
void i_strcpy(char *dest
, char const *src
, size_t size
);
1916 /* Is *as1* a valid prefix of *as2*? */
1917 FL
int is_prefix(char const *as1
, char const *as2
);
1919 /* Backslash quote (" and \) v'alue, and return salloc()ed result */
1920 FL
char * string_quote(char const *v
);
1922 /* Get (and isolate) the last, possibly quoted part of linebuf, set *needs_list
1923 * to indicate wether getmsglist() et al need to be called to collect
1924 * additional args that remain in linebuf. If strip is true possibly
1925 * surrounding quote characters are removed. Return NULL on "error" */
1926 FL
char * laststring(char *linebuf
, bool_t
*needs_list
, bool_t strip
);
1928 /* Convert a string to lowercase, in-place and with multibyte-aware */
1929 FL
void makelow(char *cp
);
1931 /* Is *sub* a substring of *str*, case-insensitive and multibyte-aware? */
1932 FL bool_t
substr(char const *str
, char const *sub
);
1935 FL
char * sstpcpy(char *dst
, char const *src
);
1936 FL
char * sstrdup(char const *cp SMALLOC_DEBUG_ARGS
);
1937 FL
char * sbufdup(char const *cp
, size_t len SMALLOC_DEBUG_ARGS
);
1938 #ifdef HAVE_MEMORY_DEBUG
1939 # define sstrdup(CP) sstrdup(CP, __FILE__, __LINE__)
1940 # define sbufdup(CP,L) sbufdup(CP, L, __FILE__, __LINE__)
1943 /* Copy at most dstsize bytes of src to dst and return string length.
1944 * Returns -E2BIG if dst is not large enough; dst will always be terminated
1945 * unless dstsize was 0 on entry */
1946 FL ssize_t
n_strscpy(char *dst
, char const *src
, size_t dstsize
);
1948 /* Case-independent ASCII comparisons */
1949 FL
int asccasecmp(char const *s1
, char const *s2
);
1950 FL
int ascncasecmp(char const *s1
, char const *s2
, size_t sz
);
1952 /* Case-independent ASCII string find s2 in s1, return it or NULL */
1953 FL
char const *asccasestr(char const *s1
, char const *s2
);
1955 /* Case-independent ASCII check wether as2 is the initial substring of as1 */
1956 FL bool_t
is_asccaseprefix(char const *as1
, char const *as2
);
1958 /* struct str related support funs TODO _cp->_cs! */
1960 /* *self->s* is srealloc()ed */
1961 #define n_str_dup(S, T) n_str_assign_buf((S), (T)->s, (T)->l)
1963 /* *self->s* is srealloc()ed; if buflen==UIZ_MAX strlen() is called unless buf
1964 * is NULL; buf may be NULL if buflen is 0 */
1965 FL
struct str
* n_str_assign_buf(struct str
*self
,
1966 char const *buf
, uiz_t buflen SMALLOC_DEBUG_ARGS
);
1967 #define n_str_assign(S, T) n_str_assign_buf(S, (T)->s, (T)->l)
1968 #define n_str_assign_cp(S, CP) n_str_assign_buf(S, CP, UIZ_MAX)
1970 /* *self->s* is srealloc()ed, *self->l* incremented; if buflen==UIZ_MAX
1971 * strlen() is called unless buf is NULL; buf may be NULL if buflen is 0 */
1972 FL
struct str
* n_str_add_buf(struct str
*self
, char const *buf
, uiz_t buflen
1973 SMALLOC_DEBUG_ARGS
);
1974 #define n_str_add(S, T) n_str_add_buf(S, (T)->s, (T)->l)
1975 #define n_str_add_cp(S, CP) n_str_add_buf(S, CP, UIZ_MAX)
1977 #ifdef HAVE_MEMORY_DEBUG
1978 # define n_str_assign_buf(S,B,BL) n_str_assign_buf(S, B, BL, __FILE__, __LINE__)
1979 # define n_str_add_buf(S,B,BL) n_str_add_buf(S, B, BL, __FILE__, __LINE__)
1983 * May have NULL buffer, may contain embedded NULs */
1986 #define n_string_creat(S) \
1987 ((S)->s_dat = NULL, (S)->s_len = (S)->s_auto = (S)->s_size = 0, (S))
1988 #define n_string_creat_auto(S) \
1989 ((S)->s_dat = NULL, (S)->s_len = (S)->s_size = 0, (S)->s_auto = TRU1, (S))
1990 #define n_string_gut(S) ((S)->s_size != 0 ? (void)n_string_clear(S) : (void)0)
1992 /* Truncate to size, which must be LE current length */
1993 #define n_string_trunc(S,L) ((S)->s_len = (L), (S))
1995 /* Release buffer ownership */
1996 #define n_string_drop_ownership(S) \
1997 ((S)->s_dat = NULL, (S)->s_len = (S)->s_size = 0, (S))
1999 /* Release all memory */
2000 FL
struct n_string
*n_string_clear(struct n_string
*self SMALLOC_DEBUG_ARGS
);
2002 #ifdef HAVE_MEMORY_DEBUG
2003 # define n_string_clear(S) \
2004 ((S)->s_size != 0 ? (n_string_clear)(S, __FILE__, __LINE__) : (S))
2006 # define n_string_clear(S) ((S)->s_size != 0 ? (n_string_clear)(S) : (S))
2009 /* Reserve room for noof additional bytes */
2010 FL
struct n_string
*n_string_reserve(struct n_string
*self
, size_t noof
2011 SMALLOC_DEBUG_ARGS
);
2013 #ifdef HAVE_MEMORY_DEBUG
2014 # define n_string_reserve(S,N) (n_string_reserve)(S, N, __FILE__, __LINE__)
2018 FL
struct n_string
*n_string_push_buf(struct n_string
*self
, char const *buf
,
2019 size_t buflen SMALLOC_DEBUG_ARGS
);
2020 #define n_string_push(S, T) n_string_push_buf(S, (T)->s_len, (T)->s_dat)
2021 #define n_string_push_cp(S,CP) n_string_push_buf(S, CP, UIZ_MAX)
2022 FL
struct n_string
*n_string_push_c(struct n_string
*self
, char c
2023 SMALLOC_DEBUG_ARGS
);
2025 #define n_string_assign(S,T) ((S)->s_len = 0, n_string_push(S, T))
2026 #define n_string_assign_cp(S,CP) ((S)->s_len = 0, n_string_push_cp(S, CP))
2027 #define n_string_assign_buf(S,B,BL) \
2028 ((S)->s_len = 0, n_string_push_buf(S, B, BL))
2030 #ifdef HAVE_MEMORY_DEBUG
2031 # define n_string_push_buf(S,B,BL) \
2032 n_string_push_buf(S, B, BL, __FILE__, __LINE__)
2033 # define n_string_push_c(S,C) n_string_push_c(S, C, __FILE__, __LINE__)
2037 FL
struct n_string
*n_string_unshift_buf(struct n_string
*self
, char const *buf
,
2038 size_t buflen SMALLOC_DEBUG_ARGS
);
2039 #define n_string_unshift(S, T) \
2040 n_string_unshift_buf(S, (T)->s_len, (T)->s_dat)
2041 #define n_string_unshift_cp(S,CP) \
2042 n_string_unshift_buf(S, CP, UIZ_MAX)
2043 FL
struct n_string
*n_string_unshift_c(struct n_string
*self
, char c
2044 SMALLOC_DEBUG_ARGS
);
2046 #ifdef HAVE_MEMORY_DEBUG
2047 # define n_string_unshift_buf(S,B,BL) \
2048 n_string_unshift_buf(S, B, BL, __FILE__, __LINE__)
2049 # define n_string_unshift_c(S,C) n_string_unshift_c(S, C, __FILE__, __LINE__)
2052 /* Ensure self has a - NUL terminated - buffer, and return that.
2053 * The latter may return the pointer to an internal empty RODATA instead */
2054 FL
char * n_string_cp(struct n_string
*self SMALLOC_DEBUG_ARGS
);
2055 FL
char const *n_string_cp_const(struct n_string
const *self
);
2057 #ifdef HAVE_MEMORY_DEBUG
2058 # define n_string_cp(S) n_string_cp(S, __FILE__, __LINE__)
2062 n_INLINE
struct n_string
*
2063 (n_string_creat
)(struct n_string
*self
){
2064 return n_string_creat(self
);
2066 # undef n_string_creat
2068 n_INLINE
struct n_string
*
2069 (n_string_creat_auto
)(struct n_string
*self
){
2070 return n_string_creat_auto(self
);
2072 # undef n_string_creat_auto
2075 (n_string_gut
)(struct n_string
*self
){
2078 # undef n_string_gut
2080 n_INLINE
struct n_string
*
2081 (n_string_trunc
)(struct n_string
*self
, size_t l
){
2082 return n_string_trunc(self
, l
);
2084 # undef n_string_trunc
2086 n_INLINE
struct n_string
*
2087 (n_string_drop_ownership
)(struct n_string
*self
){
2088 return n_string_drop_ownership(self
);
2090 # undef n_string_drop_ownership
2091 #endif /* HAVE_INLINE */
2095 /* ..and update arguments to point after range; returns UI32_MAX on error, in
2096 * which case the arguments will have been stepped one byte */
2097 #ifdef HAVE_NATCH_CHAR
2098 FL ui32_t
n_utf8_to_utf32(char const **bdat
, size_t *blen
);
2101 /* buf must be large enough also for NUL, it's new length will be returned */
2102 #ifdef HAVE_FILTER_HTML_TAGSOUP
2103 FL
size_t n_utf32_to_utf8(ui32_t c
, char *buf
);
2106 /* Our iconv(3) wrappers */
2109 FL iconv_t
n_iconv_open(char const *tocode
, char const *fromcode
);
2110 /* If *cd* == *iconvd*, assigns -1 to the latter */
2111 FL
void n_iconv_close(iconv_t cd
);
2113 /* Reset encoding state */
2114 FL
void n_iconv_reset(iconv_t cd
);
2116 /* iconv(3), but return *errno* or 0; *skipilseq* forces step over invalid byte
2117 * sequences; likewise iconv_str(), but which auto-grows on E2BIG errors; *in*
2118 * and *in_rest_or_null* may be the same object.
2119 * Note: EINVAL (incomplete sequence at end of input) is NOT handled, so the
2120 * replacement character must be added manually if that happens at EOF! */
2121 FL
int n_iconv_buf(iconv_t cd
, char const **inb
, size_t *inbleft
,
2122 char **outb
, size_t *outbleft
, bool_t skipilseq
);
2123 FL
int n_iconv_str(iconv_t icp
, struct str
*out
, struct str
const *in
,
2124 struct str
*in_rest_or_null
, bool_t skipilseq
);
2129 * This is a little bit hairy since it provides some stuff even if HAVE_TERMCAP
2130 * is false due to encapsulation desire
2134 /* termcap(3) / xy lifetime handling -- only called if we're OPT_INTERACTIVE
2135 * but not doing something in OPT_QUICKRUN_MASK */
2136 FL
void n_termcap_init(void);
2137 FL
void n_termcap_destroy(void);
2139 /* enter_ca_mode / enable keypad (both if possible).
2140 * TODO When complete is not set we won't enter_ca_mode, for example: we don't
2141 * TODO want a complete screen clearance after $PAGER returned after displaying
2142 * TODO a mail, because otherwise the screen would look differently for normal
2143 * TODO stdout display messages. Etc. */
2144 # ifdef HAVE_TERMCAP
2145 FL
void n_termcap_resume(bool_t complete
);
2146 FL
void n_termcap_suspend(bool_t complete
);
2148 # define n_TERMCAP_RESUME(CPL) n_termcap_resume(CPL)
2149 # define n_TERMCAP_SUSPEND(CPL) n_termcap_suspend(CPL)
2151 # define n_TERMCAP_RESUME(CPL)
2152 # define n_TERMCAP_SUSPEND(CPL)
2155 /* Command multiplexer, returns FAL0 on I/O error, TRU1 on success and TRUM1
2156 * for commands which are not available and have no builtin fallback.
2157 * For query options the return represents a true value and -1 error.
2158 * Will return FAL0 directly unless we've been initialized.
2159 * By convention unused argument slots are given as -1 */
2160 FL ssize_t
n_termcap_cmd(enum n_termcap_cmd cmd
, ssize_t a1
, ssize_t a2
);
2161 # define n_termcap_cmdx(CMD) n_termcap_cmd(CMD, -1, -1)
2163 /* Query multiplexer. If query is n__TERMCAP_QUERY_MAX then
2164 * tvp->tv_data.tvd_string must contain the name of the query to look up; this
2165 * is used to lookup just about *any* (string) capability.
2166 * Returns TRU1 on success and TRUM1 for queries for which a builtin default
2167 * is returned; FAL0 is returned on non-availability */
2168 FL bool_t
n_termcap_query(enum n_termcap_query query
,
2169 struct n_termcap_value
*tvp
);
2171 /* Get a n_termcap_query for name or -1 if it is not known, and -2 if
2172 * type wasn't _NONE and the type doesn't match. */
2173 # ifdef HAVE_KEY_BINDINGS
2174 FL si32_t
n_termcap_query_for_name(char const *name
,
2175 enum n_termcap_captype type
);
2176 FL
char const *n_termcap_name_of_query(enum n_termcap_query query
);
2178 #endif /* n_HAVE_TCAP */
2185 FL
int c_thread(void *vp
);
2188 FL
int c_unthread(void *vp
);
2191 FL
struct message
* next_in_thread(struct message
*mp
);
2192 FL
struct message
* prev_in_thread(struct message
*mp
);
2193 FL
struct message
* this_in_thread(struct message
*mp
, long n
);
2195 /* Sorted mode is internally just a variant of threaded mode with all m_parent
2196 * and m_child links being NULL */
2197 FL
int c_sort(void *vp
);
2200 FL
int c_collapse(void *v
);
2201 FL
int c_uncollapse(void *v
);
2204 FL
void uncollapse1(struct message
*mp
, int always
);
2210 /* Return wether user says yes, on STDIN if interactive.
2211 * Uses noninteract_default, the return value for non-interactive use cases,
2212 * as a hint for boolify() and chooses the yes/no string to append to prompt
2213 * accordingly. If prompt is NULL "Continue" is used instead.
2214 * Handles+reraises SIGINT */
2215 FL bool_t
getapproval(char const *prompt
, bool_t noninteract_default
);
2218 /* Get a password the expected way, return termios_state.ts_linebuf on
2219 * success or NULL on error */
2220 FL
char * getuser(char const *query
);
2222 /* Get a password the expected way, return termios_state.ts_linebuf on
2223 * success or NULL on error. SIGINT is temporarily blocked, *not* reraised.
2224 * termios_state_reset() (def.h) must be called anyway */
2225 FL
char * getpassword(char const *query
);
2228 /* Overall interactive terminal life cycle for command line editor library */
2229 #if defined HAVE_READLINE
2230 # define TTY_WANTS_SIGWINCH
2232 FL
void n_tty_init(void);
2233 FL
void n_tty_destroy(void);
2235 /* Rather for main.c / SIGWINCH interaction only */
2236 FL
void n_tty_signal(int sig
);
2238 /* Read a line after printing prompt (if set and non-empty).
2239 * If n>0 assumes that *linebuf has n bytes of default content */
2240 FL
int n_tty_readline(char const *prompt
, char **linebuf
,
2241 size_t *linesize
, size_t n SMALLOC_DEBUG_ARGS
);
2242 #ifdef HAVE_MEMORY_DEBUG
2243 # define n_tty_readline(A,B,C,D) (n_tty_readline)(A, B, C, D, __FILE__,__LINE__)
2246 /* Add a line (most likely as returned by n_tty_readline()) to the history.
2247 * Wether an entry added for real depends on the isgabby / *history-gabby*
2248 * relation, and / or wether s is non-empty and doesn't begin with U+0020 */
2249 FL
void n_tty_addhist(char const *s
, bool_t isgabby
);
2252 FL
int c_history(void *v
);
2254 # define c_history c_cmdnotsupp
2261 /* Detect visual width of (blen bytes of) buf, return (size_t)-1 on error.
2262 * Give blen UIZ_MAX to strlen(). buf may be NULL if (final) blen is 0 */
2263 FL
size_t field_detect_width(char const *buf
, size_t blen
);
2265 /* Check (multibyte-safe) how many bytes of buf (which is blen byts) can be
2266 * safely placed in a buffer (field width) of maxlen bytes */
2267 FL
size_t field_detect_clip(size_t maxlen
, char const *buf
, size_t blen
);
2269 /* Put maximally maxlen bytes of buf, a buffer of blen bytes, into store,
2270 * taking into account multibyte code point boundaries and possibly
2271 * encapsulating in bidi_info toggles as necessary */
2272 FL
size_t field_put_bidi_clip(char *store
, size_t maxlen
, char const *buf
,
2275 /* Place cp in a salloc()ed buffer, column-aligned; for header display only */
2276 FL
char * colalign(char const *cp
, int col
, int fill
,
2277 int *cols_decr_used_or_null
);
2279 /* Convert a string to a displayable one;
2280 * prstr() returns the result savestr()d, prout() writes it */
2281 FL
void makeprint(struct str
const *in
, struct str
*out
);
2282 FL
size_t delctrl(char *cp
, size_t len
);
2283 FL
char * prstr(char const *s
);
2284 FL
int prout(char const *s
, size_t sz
, FILE *fp
);
2286 /* Print out a Unicode character or a substitute for it, return 0 on error or
2287 * wcwidth() (or 1) on success */
2288 FL
size_t putuc(int u
, int c
, FILE *fp
);
2290 /* Check wether bidirectional info maybe needed for blen bytes of bdat */
2291 FL bool_t
bidi_info_needed(char const *bdat
, size_t blen
);
2293 /* Create bidirectional text encapsulation information; without HAVE_NATCH_CHAR
2294 * the strings are always empty */
2295 FL
void bidi_info_create(struct bidi_info
*bip
);
2301 /* URL en- and decoding according to (enough of) RFC 3986 (RFC 1738).
2302 * These return a newly salloc()ated result */
2303 FL
char * urlxenc(char const *cp
, bool_t ispath SALLOC_DEBUG_ARGS
);
2304 FL
char * urlxdec(char const *cp SALLOC_DEBUG_ARGS
);
2305 #ifdef HAVE_MEMORY_DEBUG
2306 # define urlxenc(CP,P) urlxenc(CP, P, __FILE__, __LINE__)
2307 # define urlxdec(CP) urlxdec(CP, __FILE__, __LINE__)
2311 /* Return port of urlp->url_proto (and set irv_or_null), or NULL if unknown */
2312 FL
char const * url_servbyname(struct url
const *urlp
, ui16_t
*irv_or_null
);
2314 /* Parse data, which must meet the criteria of the protocol cproto, and fill
2315 * in the URL structure urlp (URL rather according to RFC 3986) */
2316 FL bool_t
url_parse(struct url
*urlp
, enum cproto cproto
,
2319 /* Zero ccp and lookup credentials for communicating with urlp.
2320 * Return wether credentials are available and valid (for chosen auth) */
2321 FL bool_t
ccred_lookup(struct ccred
*ccp
, struct url
*urlp
);
2322 FL bool_t
ccred_lookup_old(struct ccred
*ccp
, enum cproto cproto
,
2324 #endif /* HAVE_SOCKETS */
2328 FL
int c_netrc(void *v
);
2330 # define c_netrc c_cmdnotsupp
2333 /* MD5 (RFC 1321) related facilities */
2335 # ifdef HAVE_OPENSSL_MD5
2336 # define md5_ctx MD5_CTX
2337 # define md5_init MD5_Init
2338 # define md5_update MD5_Update
2339 # define md5_final MD5_Final
2341 /* The function definitions are instantiated in main.c */
2342 # include "rfc1321.h"
2345 /* Store the MD5 checksum as a hexadecimal string in *hex*, *not* terminated,
2346 * using lowercase ASCII letters as defined in RFC 2195 */
2347 # define MD5TOHEX_SIZE 32
2348 FL
char * md5tohex(char hex
[MD5TOHEX_SIZE
], void const *vp
);
2350 /* CRAM-MD5 encode the *user* / *pass* / *b64* combo */
2351 FL
char * cram_md5_string(struct str
const *user
, struct str
const *pass
,
2354 /* RFC 2104: HMAC: Keyed-Hashing for Message Authentication.
2355 * unsigned char *text: pointer to data stream
2356 * int text_len : length of data stream
2357 * unsigned char *key : pointer to authentication key
2358 * int key_len : length of authentication key
2359 * caddr_t digest : caller digest to be filled in */
2360 FL
void hmac_md5(unsigned char *text
, int text_len
, unsigned char *key
,
2361 int key_len
, void *digest
);
2362 #endif /* HAVE_MD5 */
2364 #ifndef HAVE_AMALGAMATION