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
50 * Macro-based generics
53 /* Kludges to handle the change from setexit / reset to setjmp / longjmp */
54 #define setexit() (void)sigsetjmp(srbuf, 1)
55 #define reset(x) siglongjmp(srbuf, x)
57 /* ASCII char classification */
58 #define __ischarof(C, FLAGS) \
59 (asciichar(C) && (class_char[(uc_i)(C)] & (FLAGS)) != 0)
61 #define asciichar(c) ((uc_i)(c) <= 0177)
62 #define alnumchar(c) __ischarof(c, C_DIGIT | C_OCTAL | C_UPPER | C_LOWER)
63 #define alphachar(c) __ischarof(c, C_UPPER | C_LOWER)
64 #define blankchar(c) __ischarof(c, C_BLANK)
65 #define blankspacechar(c) __ischarof(c, C_BLANK | C_SPACE)
66 #define cntrlchar(c) __ischarof(c, C_CNTRL)
67 #define digitchar(c) __ischarof(c, C_DIGIT | C_OCTAL)
68 #define lowerchar(c) __ischarof(c, C_LOWER)
69 #define punctchar(c) __ischarof(c, C_PUNCT)
70 #define spacechar(c) __ischarof(c, C_BLANK | C_SPACE | C_WHITE)
71 #define upperchar(c) __ischarof(c, C_UPPER)
72 #define whitechar(c) __ischarof(c, C_BLANK | C_WHITE)
73 #define octalchar(c) __ischarof(c, C_OCTAL)
75 #define upperconv(c) (lowerchar(c) ? (char)((uc_i)(c) - 'a' + 'A') : (c))
76 #define lowerconv(c) (upperchar(c) ? (char)((uc_i)(c) - 'A' + 'a') : (c))
78 #define fieldnamechar(c) \
79 (asciichar(c) && (c) > 040 && (c) != 0177 && (c) != ':')
81 /* Could the string contain a regular expression? */
83 # define is_maybe_regex(S) anyof("^.[]*+?()|$", S)
85 # define is_maybe_regex(S) anyof("^[]*+?|$", S)
88 /* Try to use alloca() for some function-local buffers and data, fall back to
89 * smalloc()/free() if not available */
91 # define ac_alloc(n) HAVE_ALLOCA(n)
92 # define ac_free(n) do {UNUSED(n);} while (0)
94 # define ac_alloc(n) smalloc(n)
95 # define ac_free(n) free(n)
98 /* Single-threaded, use unlocked I/O */
99 #ifdef HAVE_PUTC_UNLOCKED
101 # define getc(c) getc_unlocked(c)
103 # define putc(c, f) putc_unlocked(c, f)
105 # define putchar(c) putc_unlocked((c), stdout)
108 /* Truncate a file to the last character written. This is useful just before
109 * closing an old file that was opened for read/write */
110 #define ftrunc(stream) \
114 off = ftell(stream);\
116 ftruncate(fileno(stream), off);\
119 /* fflush() and rewind() */
120 #define fflush_rewind(stream) \
126 /* There are problems with dup()ing of file-descriptors for child processes.
127 * As long as those are not fixed in equal spirit to (outof(): FIX and
128 * recode.., 2012-10-04), and to avoid reviving of bugs like (If *record* is
129 * set, avoid writing dead content twice.., 2012-09-14), we have to somehow
130 * accomplish that the FILE* fp makes itself comfortable with the *real* offset
131 * of the underlaying file descriptor. Unfortunately Standard I/O and POSIX
132 * don't describe a way for that -- fflush();rewind(); won't do it. This
133 * fseek(END),rewind() pair works around the problem on *BSD and Linux.
134 * Update as of 2014-03-03: with Issue 7 POSIX has overloaded fflush(3): if
135 * used on a readable stream, then
137 * if the file is not already at EOF, and the file is one capable of
138 * seeking, the file offset of the underlying open file description shall
139 * be set to the file position of the stream.
141 * We need our own, simplified and reliable I/O */
142 #if defined _POSIX_VERSION && _POSIX_VERSION + 0 >= 200809L
143 # define really_rewind(stream) \
149 # define really_rewind(stream) \
151 fseek(stream, 0, SEEK_END);\
160 /* Don't use _var_* unless you *really* have to! */
162 /* Constant option key look/(un)set/clear */
163 FL
char * _var_oklook(enum okeys okey
);
164 #define ok_blook(C) (_var_oklook(CONCAT(ok_b_, C)) != NULL)
165 #define ok_vlook(C) _var_oklook(CONCAT(ok_v_, C))
167 FL bool_t
_var_okset(enum okeys okey
, uintptr_t val
);
168 #define ok_bset(C,B) _var_okset(CONCAT(ok_b_, C), (uintptr_t)(B))
169 #define ok_vset(C,V) _var_okset(CONCAT(ok_v_, C), (uintptr_t)(V))
171 FL bool_t
_var_okclear(enum okeys okey
);
172 #define ok_bclear(C) _var_okclear(CONCAT(ok_b_, C))
173 #define ok_vclear(C) _var_okclear(CONCAT(ok_v_, C))
175 /* Variable option key look/(un)set/clear */
176 FL
char * _var_voklook(char const *vokey
);
177 #define vok_blook(S) (_var_voklook(S) != NULL)
178 #define vok_vlook(S) _var_voklook(S)
180 FL bool_t
_var_vokset(char const *vokey
, uintptr_t val
);
181 #define vok_bset(S,B) _var_vokset(S, (uintptr_t)(B))
182 #define vok_vset(S,V) _var_vokset(S, (uintptr_t)(V))
184 FL bool_t
_var_vokclear(char const *vokey
);
185 #define vok_bclear(S) _var_vokclear(S)
186 #define vok_vclear(S) _var_vokclear(S)
188 /* Environment lookup, if envonly is TRU1 then variable must come from the
189 * process environment (and if via `setenv') */
190 FL
char * _env_look(char const *envkey
, bool_t envonly
);
191 #define env_blook(S,EXCL) (_env_look(S, EXCL) != NULL)
192 #define env_vlook(S,EXCL) _env_look(S, EXCL)
194 /* Special case to handle the typical [xy-USER@HOST,] xy-HOST and plain xy
195 * variable chains; oxm is a bitmix which tells which combinations to test */
197 FL
char * _var_xoklook(enum okeys okey
, struct url
const *urlp
,
198 enum okey_xlook_mode oxm
);
199 # define xok_BLOOK(C,URL,M) (_var_xoklook(C, URL, M) != NULL)
200 # define xok_VLOOK(C,URL,M) _var_xoklook(C, URL, M)
201 # define xok_blook(C,URL,M) xok_BLOOK(CONCAT(ok_b_, C), URL, M)
202 # define xok_vlook(C,URL,M) xok_VLOOK(CONCAT(ok_v_, C), URL, M)
206 FL
int c_varshow(void *v
);
208 /* User variable access: `set', `setenv', `unset' and `unsetenv' */
209 FL
int c_set(void *v
);
210 FL
int c_setenv(void *v
);
211 FL
int c_unset(void *v
);
212 FL
int c_unsetenv(void *v
);
214 /* Ditto: `varedit' */
215 FL
int c_varedit(void *v
);
217 /* Macros: `define', `undefine', `call' / `~' */
218 FL
int c_define(void *v
);
219 FL
int c_undefine(void *v
);
220 FL
int c_call(void *v
);
222 /* Check wether a *folder-hook* exists for the currently active mailbox */
223 FL bool_t
check_folder_hook(bool_t nmail
);
225 /* Accounts: `account', `unaccount' */
226 FL
int c_account(void *v
);
227 FL
int c_unaccount(void *v
);
230 FL
int c_localopts(void *v
);
232 FL
void temporary_localopts_free(void); /* XXX intermediate hack */
233 FL
void temporary_localopts_folder_hook_unroll(void); /* XXX im. hack */
239 /* Try to add an attachment for file, file_expand()ed.
240 * Return the new head of list aphead, or NULL.
241 * The newly created attachment will be stored in *newap, if given */
242 FL
struct attachment
* add_attachment(struct attachment
*aphead
, char *file
,
243 struct attachment
**newap
);
245 /* Append comma-separated list of file names to the end of attachment list */
246 FL
void append_attachments(struct attachment
**aphead
, char *names
);
248 /* Interactively edit the attachment list */
249 FL
void edit_attachments(struct attachment
**aphead
);
255 FL
void n_raise(int signo
);
257 /* Provide BSD-like signal() on all (POSIX) systems */
258 FL sighandler_type
safe_signal(int signum
, sighandler_type handler
);
260 /* Hold *all* signals but SIGCHLD, and release that total block again */
261 FL
void hold_all_sigs(void);
262 FL
void rele_all_sigs(void);
264 /* Hold HUP/QUIT/INT */
265 FL
void hold_sigs(void);
266 FL
void rele_sigs(void);
268 /* Not-Yet-Dead debug information (handler installation in main.c) */
269 #if defined HAVE_DEBUG || defined HAVE_DEVEL
270 FL
void _nyd_chirp(ui8_t act
, char const *file
, ui32_t line
,
272 FL
void _nyd_oncrash(int signo
);
275 # define NYD_ENTER _nyd_chirp(1, __FILE__, __LINE__, __FUN__)
276 # define NYD_LEAVE _nyd_chirp(2, __FILE__, __LINE__, __FUN__)
277 # define NYD _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
278 # define NYD_X _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
280 # define NYD2_ENTER _nyd_chirp(1, __FILE__, __LINE__, __FUN__)
281 # define NYD2_LEAVE _nyd_chirp(2, __FILE__, __LINE__, __FUN__)
282 # define NYD2 _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
288 # define NYD_ENTER do {} while (0)
289 # define NYD_LEAVE do {} while (0)
290 # define NYD do {} while (0)
291 # define NYD_X do {} while (0) /* XXX LEGACY */
294 # define NYD2_ENTER do {} while (0)
295 # define NYD2_LEAVE do {} while (0)
296 # define NYD2 do {} while (0)
299 /* Touch the named message by setting its MTOUCH flag. Touched messages have
300 * the effect of not being sent back to the system mailbox on exit */
301 FL
void touch(struct message
*mp
);
303 /* Test to see if the passed file name is a directory, return true if it is */
304 FL bool_t
is_dir(char const *name
);
306 /* Count the number of arguments in the given string raw list */
307 FL
int argcount(char **argv
);
309 /* Compute screen size */
310 FL
int screensize(void);
312 /* Get our $PAGER; if env_addon is not NULL it is checked wether we know about
313 * some environment variable that supports colour+ and set *env_addon to that,
314 * e.g., "LESS=FRSXi" */
315 FL
char const *get_pager(char const **env_addon
);
317 /* Use a pager or STDOUT to print *fp*; if *lines* is 0, they'll be counted */
318 FL
void page_or_print(FILE *fp
, size_t lines
);
320 /* Parse name and guess at the required protocol */
321 FL
enum protocol
which_protocol(char const *name
);
323 /* Hash the passed string -- uses Chris Torek's hash algorithm */
324 FL ui32_t
torek_hash(char const *name
);
325 #define hash(S) (torek_hash(S) % HSHSIZE) /* xxx COMPAT (?) */
328 FL ui32_t
pjw(char const *cp
); /* TODO obsolete -> torek_hash() */
330 /* Find a prime greater than n */
331 FL ui32_t
nextprime(ui32_t n
);
333 /* Check wether *s is an escape sequence, expand it as necessary.
334 * Returns the expanded sequence or 0 if **s is NUL or PROMPT_STOP if it is \c.
335 * *s is advanced to after the expanded sequence (as possible).
336 * If use_prompt_extensions is set, an enum prompt_exp may be returned */
337 FL
int expand_shell_escape(char const **s
,
338 bool_t use_prompt_extensions
);
340 /* Get *prompt*, or '& ' if *bsdcompat*, of '? ' otherwise */
341 FL
char * getprompt(void);
343 /* Detect and query the hostname to use */
344 FL
char * nodename(int mayoverride
);
346 /* Get a (pseudo) random string of *length* bytes; returns salloc()ed buffer */
347 FL
char * getrandstring(size_t length
);
349 FL
enum okay
makedir(char const *name
);
351 /* A get-wd..restore-wd approach */
352 FL
enum okay
cwget(struct cw
*cw
);
353 FL
enum okay
cwret(struct cw
*cw
);
354 FL
void cwrelse(struct cw
*cw
);
356 /* Check (multibyte-safe) how many bytes of buf (which is blen byts) can be
357 * safely placed in a buffer (field width) of maxlen bytes */
358 FL
size_t field_detect_clip(size_t maxlen
, char const *buf
, size_t blen
);
360 /* Put maximally maxlen bytes of buf, a buffer of blen bytes, into store,
361 * taking into account multibyte code point boundaries and possibly
362 * encapsulating in bidi_info toggles as necessary */
363 FL
size_t field_put_bidi_clip(char *store
, size_t maxlen
, char const *buf
,
366 /* Place cp in a salloc()ed buffer, column-aligned; for header display only */
367 FL
char * colalign(char const *cp
, int col
, int fill
,
368 int *cols_decr_used_or_null
);
370 /* Convert a string to a displayable one;
371 * prstr() returns the result savestr()d, prout() writes it */
372 FL
void makeprint(struct str
const *in
, struct str
*out
);
373 FL
size_t delctrl(char *cp
, size_t len
);
374 FL
char * prstr(char const *s
);
375 FL
int prout(char const *s
, size_t sz
, FILE *fp
);
377 /* Print out a Unicode character or a substitute for it, return 0 on error or
378 * wcwidth() (or 1) on success */
379 FL
size_t putuc(int u
, int c
, FILE *fp
);
381 /* Check wether bidirectional info maybe needed for blen bytes of bdat */
382 FL bool_t
bidi_info_needed(char const *bdat
, size_t blen
);
384 /* Create bidirectional text encapsulation information; without HAVE_NATCH_CHAR
385 * the strings are always empty */
386 FL
void bidi_info_create(struct bidi_info
*bip
);
388 /* We want coloured output (in this salloc() cycle). pager_used is used to
389 * test wether *colour-pager* is to be inspected */
391 FL
void colour_table_create(bool_t pager_used
);
392 FL
void colour_put(FILE *fp
, enum colourspec cs
);
393 FL
void colour_put_header(FILE *fp
, char const *name
);
394 FL
void colour_reset(FILE *fp
);
395 FL
struct str
const * colour_get(enum colourspec cs
);
397 # define colour_put(FP,CS)
398 # define colour_put_header(FP,N)
399 # define colour_reset(FP)
402 /* Check wether the argument string is a true (1) or false (0) boolean, or an
403 * invalid string, in which case -1 is returned; if emptyrv is not -1 then it,
404 * treated as a boolean, is used as the return value shall inbuf be empty.
405 * inlen may be UIZ_MAX to force strlen() detection */
406 FL si8_t
boolify(char const *inbuf
, uiz_t inlen
, si8_t emptyrv
);
408 /* Dig a "quadoption" in inbuf (possibly going through getapproval() in
409 * interactive mode). Returns a boolean or -1 if inbuf content is invalid;
410 * if emptyrv is not -1 then it, treated as a boolean, is used as the return
411 * value shall inbuf be empty. If prompt is set it is printed first if intera.
412 * inlen may be UIZ_MAX to force strlen() detection */
413 FL si8_t
quadify(char const *inbuf
, uiz_t inlen
, char const *prompt
,
416 /* Get seconds since epoch */
417 FL
time_t n_time_epoch(void);
419 /* Update *tc* to now; only .tc_time updated unless *full_update* is true */
420 FL
void time_current_update(struct time_current
*tc
,
423 /* Our error print series.. */
424 FL
void n_err(char const *format
, ...);
425 FL
void n_verr(char const *format
, va_list ap
);
427 /* ..(for use in a signal handler; to be obsoleted..).. */
428 FL
void n_err_sighdl(char const *format
, ...);
430 /* ..including replacement for perror(3); if errval is 0 errno(3) is used */
431 FL
void n_perr(char const *msg
, int errval
);
433 /* Announce a fatal error (and die) */
434 FL
void n_alert(char const *format
, ...);
435 FL
void n_panic(char const *format
, ...);
439 FL
int c_errors(void *vp
);
441 # define c_errors c_cmdnotsupp
444 /* Memory allocation routines */
446 # define SMALLOC_DEBUG_ARGS , char const *mdbg_file, int mdbg_line
447 # define SMALLOC_DEBUG_ARGSCALL , mdbg_file, mdbg_line
449 # define SMALLOC_DEBUG_ARGS
450 # define SMALLOC_DEBUG_ARGSCALL
453 FL
void * smalloc(size_t s SMALLOC_DEBUG_ARGS
);
454 FL
void * srealloc(void *v
, size_t s SMALLOC_DEBUG_ARGS
);
455 FL
void * scalloc(size_t nmemb
, size_t size SMALLOC_DEBUG_ARGS
);
458 FL
void sfree(void *v SMALLOC_DEBUG_ARGS
);
459 /* Called by sreset(), then */
460 FL
void smemreset(void);
462 FL
int c_smemtrace(void *v
);
463 /* For immediate debugging purposes, it is possible to check on request */
464 FL bool_t
_smemcheck(char const *file
, int line
);
466 # define smalloc(SZ) smalloc(SZ, __FILE__, __LINE__)
467 # define srealloc(P,SZ) srealloc(P, SZ, __FILE__, __LINE__)
468 # define scalloc(N,SZ) scalloc(N, SZ, __FILE__, __LINE__)
469 # define free(P) sfree(P, __FILE__, __LINE__)
470 # define smemcheck() _smemcheck(__FILE__, __LINE__)
477 FL
int c_cmdnotsupp(void *v
);
479 /* `headers' (show header group, possibly after setting dot) */
480 FL
int c_headers(void *v
);
482 /* Like c_headers(), but pre-prepared message vector */
483 FL
int print_header_group(int *vector
);
485 /* Scroll to the next/previous screen */
486 FL
int c_scroll(void *v
);
487 FL
int c_Scroll(void *v
);
489 /* Print out the headlines for each message in the passed message list */
490 FL
int c_from(void *v
);
492 /* Print all message in between and including bottom and topx if they are
493 * visible and either only_marked is false or they are MMARKed */
494 FL
void print_headers(size_t bottom
, size_t topx
, bool_t only_marked
);
496 /* Print out the value of dot */
497 FL
int c_pdot(void *v
);
499 /* Paginate messages, honor/don't honour ignored fields, respectively */
500 FL
int c_more(void *v
);
501 FL
int c_More(void *v
);
503 /* Type out messages, honor/don't honour ignored fields, respectively */
504 FL
int c_type(void *v
);
505 FL
int c_Type(void *v
);
507 /* Show MIME-encoded message text, including all fields */
508 FL
int c_show(void *v
);
510 /* Pipe messages, honor/don't honour ignored fields, respectively */
511 FL
int c_pipe(void *v
);
512 FL
int c_Pipe(void *v
);
514 /* Print the top so many lines of each desired message.
515 * The number of lines is taken from *toplines* and defaults to 5 */
516 FL
int c_top(void *v
);
518 /* Touch all the given messages so that they will get mboxed */
519 FL
int c_stouch(void *v
);
521 /* Make sure all passed messages get mboxed */
522 FL
int c_mboxit(void *v
);
524 /* List the folders the user currently has */
525 FL
int c_folders(void *v
);
531 /* If any arguments were given, go to the next applicable argument following
532 * dot, otherwise, go to the next applicable message. If given as first
533 * command with no arguments, print first message */
534 FL
int c_next(void *v
);
536 /* Save a message in a file. Mark the message as saved so we can discard when
538 FL
int c_save(void *v
);
539 FL
int c_Save(void *v
);
541 /* Copy a message to a file without affected its saved-ness */
542 FL
int c_copy(void *v
);
543 FL
int c_Copy(void *v
);
545 /* Move a message to a file */
546 FL
int c_move(void *v
);
547 FL
int c_Move(void *v
);
549 /* Decrypt and copy a message to a file */
550 FL
int c_decrypt(void *v
);
551 FL
int c_Decrypt(void *v
);
553 /* Write the indicated messages at the end of the passed file name, minus
554 * header and trailing blank line. This is the MIME save function */
555 FL
int c_write(void *v
);
557 /* Delete messages */
558 FL
int c_delete(void *v
);
560 /* Delete messages, then type the new dot */
561 FL
int c_deltype(void *v
);
563 /* Undelete the indicated messages */
564 FL
int c_undelete(void *v
);
566 /* Add the given header fields to the retained list. If no arguments, print
567 * the current list of retained fields */
568 FL
int c_retfield(void *v
);
570 /* Add the given header fields to the ignored list. If no arguments, print the
571 * current list of ignored fields */
572 FL
int c_igfield(void *v
);
574 FL
int c_saveretfield(void *v
);
575 FL
int c_saveigfield(void *v
);
576 FL
int c_fwdretfield(void *v
);
577 FL
int c_fwdigfield(void *v
);
578 FL
int c_unignore(void *v
);
579 FL
int c_unretain(void *v
);
580 FL
int c_unsaveignore(void *v
);
581 FL
int c_unsaveretain(void *v
);
582 FL
int c_unfwdignore(void *v
);
583 FL
int c_unfwdretain(void *v
);
589 /* Process a shell escape by saving signals, ignoring signals and a sh -c */
590 FL
int c_shell(void *v
);
592 /* Fork an interactive shell */
593 FL
int c_dosh(void *v
);
595 /* Show the help screen */
596 FL
int c_help(void *v
);
598 /* Print user's working directory */
599 FL
int c_cwd(void *v
);
601 /* Change user's working directory */
602 FL
int c_chdir(void *v
);
604 /* All thinkable sorts of `reply' / `respond' and `followup'.. */
605 FL
int c_reply(void *v
);
606 FL
int c_replyall(void *v
);
607 FL
int c_replysender(void *v
);
608 FL
int c_Reply(void *v
);
609 FL
int c_followup(void *v
);
610 FL
int c_followupall(void *v
);
611 FL
int c_followupsender(void *v
);
612 FL
int c_Followup(void *v
);
614 /* ..and a mailing-list reply */
615 FL
int c_Lreply(void *v
);
617 /* The 'forward' command */
618 FL
int c_forward(void *v
);
620 /* Similar to forward, saving the message in a file named after the first
622 FL
int c_Forward(void *v
);
624 /* Resend a message list to a third person */
625 FL
int c_resend(void *v
);
627 /* Resend a message list to a third person without adding headers */
628 FL
int c_Resend(void *v
);
630 /* Preserve messages, so that they will be sent back to the system mailbox */
631 FL
int c_preserve(void *v
);
633 /* Mark all given messages as unread */
634 FL
int c_unread(void *v
);
636 /* Mark all given messages as read */
637 FL
int c_seen(void *v
);
639 /* Print the size of each message */
640 FL
int c_messize(void *v
);
642 /* `file' (`folder') and `File' (`Folder') */
643 FL
int c_file(void *v
);
644 FL
int c_File(void *v
);
646 /* Expand file names like echo */
647 FL
int c_echo(void *v
);
649 /* 'newmail' command: Check for new mail without writing old mail back */
650 FL
int c_newmail(void *v
);
652 /* Message flag manipulation */
653 FL
int c_flag(void *v
);
654 FL
int c_unflag(void *v
);
655 FL
int c_answered(void *v
);
656 FL
int c_unanswered(void *v
);
657 FL
int c_draft(void *v
);
658 FL
int c_undraft(void *v
);
661 FL
int c_noop(void *v
);
664 FL
int c_remove(void *v
);
667 FL
int c_rename(void *v
);
669 /* `urlencode' and `urldecode' */
670 FL
int c_urlencode(void *v
);
671 FL
int c_urldecode(void *v
);
677 /* if.elif.else.endif conditional execution.
678 * condstack_isskip() returns wether the current condition state doesn't allow
679 * execution of commands.
680 * condstack_release() and condstack_take() are used when PS_SOURCING files, they
681 * rotate the current condition stack; condstack_take() returns a false boolean
682 * if the current condition stack has unclosed conditionals */
683 FL
int c_if(void *v
);
684 FL
int c_elif(void *v
);
685 FL
int c_else(void *v
);
686 FL
int c_endif(void *v
);
687 FL bool_t
condstack_isskip(void);
688 FL
void * condstack_release(void);
689 FL bool_t
condstack_take(void *self
);
695 FL
FILE * collect(struct header
*hp
, int printheaders
, struct message
*mp
,
696 char *quotefile
, int doprefix
, si8_t
*checkaddr_err
);
698 FL
void savedeadletter(FILE *fp
, int fflush_rewind_first
);
704 /* Edit a message list */
705 FL
int c_editor(void *v
);
707 /* Invoke the visual editor on a message list */
708 FL
int c_visual(void *v
);
710 /* Run an editor on either size bytes of the file fp (or until EOF if size is
711 * negative) or on the message mp, and return a new file or NULL on error of if
712 * the user didn't perform any edits.
713 * Signals must be handled by the caller. viored is 'e' for ed, 'v' for vi */
714 FL
FILE * run_editor(FILE *fp
, off_t size
, int viored
, int readonly
,
715 struct header
*hp
, struct message
*mp
,
716 enum sendaction action
, sighandler_type oldint
);
723 FL
struct quoteflt
* quoteflt_dummy(void); /* TODO LEGACY */
724 FL
void quoteflt_init(struct quoteflt
*self
, char const *prefix
);
725 FL
void quoteflt_destroy(struct quoteflt
*self
);
726 FL
void quoteflt_reset(struct quoteflt
*self
, FILE *f
);
727 FL ssize_t
quoteflt_push(struct quoteflt
*self
, char const *dat
,
729 FL ssize_t
quoteflt_flush(struct quoteflt
*self
);
731 /* (Primitive) HTML tagsoup filter */
732 #ifdef HAVE_FILTER_HTML_TAGSOUP
733 /* TODO Because we don't support filter chains yet this filter will be run
734 * TODO in a dedicated subprocess, driven via a special Popen() mode */
735 FL
int htmlflt_process_main(void);
737 FL
void htmlflt_init(struct htmlflt
*self
);
738 FL
void htmlflt_destroy(struct htmlflt
*self
);
739 FL
void htmlflt_reset(struct htmlflt
*self
, FILE *f
);
740 FL ssize_t
htmlflt_push(struct htmlflt
*self
, char const *dat
, size_t len
);
741 FL ssize_t
htmlflt_flush(struct htmlflt
*self
);
748 /* fgets() replacement to handle lines of arbitrary size and with embedded \0
750 * line - line buffer. *line may be NULL.
751 * linesize - allocated size of line buffer.
752 * count - maximum characters to read. May be NULL.
753 * llen - length_of_line(*line).
755 * appendnl - always terminate line with \n, append if necessary.
757 FL
char * fgetline(char **line
, size_t *linesize
, size_t *count
,
758 size_t *llen
, FILE *fp
, int appendnl SMALLOC_DEBUG_ARGS
);
760 # define fgetline(A,B,C,D,E,F) \
761 fgetline(A, B, C, D, E, F, __FILE__, __LINE__)
764 /* Read up a line from the specified input into the linebuffer.
765 * Return the number of characters read. Do not include the newline at EOL.
766 * n is the number of characters already read */
767 FL
int readline_restart(FILE *ibuf
, char **linebuf
, size_t *linesize
,
768 size_t n SMALLOC_DEBUG_ARGS
);
770 # define readline_restart(A,B,C,D) \
771 readline_restart(A, B, C, D, __FILE__, __LINE__)
774 /* Read a complete line of input, with editing if interactive and possible.
775 * If prompt is NULL we'll call getprompt() first, if necessary.
776 * nl_escape defines wether user can escape newlines via backslash (POSIX).
777 * If string is set it is used as the initial line content if in interactive
778 * mode, otherwise this argument is ignored for reproducibility.
779 * Return number of octets or a value <0 on error.
780 * Note: may use the currently `source'd file stream instead of stdin! */
781 FL
int readline_input(char const *prompt
, bool_t nl_escape
,
782 char **linebuf
, size_t *linesize
, char const *string
785 # define readline_input(A,B,C,D,E) readline_input(A,B,C,D,E,__FILE__,__LINE__)
788 /* Read a line of input, with editing if interactive and possible, return it
789 * savestr()d or NULL in case of errors or if an empty line would be returned.
790 * This may only be called from toplevel (not during PS_SOURCING).
791 * If prompt is NULL we'll call getprompt() if necessary.
792 * If string is set it is used as the initial line content if in interactive
793 * mode, otherwise this argument is ignored for reproducibility.
794 * If OPT_INTERACTIVE a non-empty return is saved in the history, isgabby */
795 FL
char * n_input_cp_addhist(char const *prompt
, char const *string
,
798 /* Set up the input pointers while copying the mail file into /tmp */
799 FL
void setptr(FILE *ibuf
, off_t offset
);
801 /* Drop the passed line onto the passed output buffer. If a write error occurs
802 * return -1, else the count of characters written, including the newline */
803 FL
int putline(FILE *obuf
, char *linebuf
, size_t count
);
805 /* Return a file buffer all ready to read up the passed message pointer */
806 FL
FILE * setinput(struct mailbox
*mp
, struct message
*m
,
809 /* Reset (free) the global message array */
810 FL
void message_reset(void);
812 /* Append the passed message descriptor onto the message array; if mp is NULL,
813 * NULLify the entry at &[msgCount-1] */
814 FL
void message_append(struct message
*mp
);
816 /* Check wether sep->ss_sexpr (or ->ss_regex) matches mp. If with_headers is
817 * true then the headers will also be searched (as plain text) */
818 FL bool_t
message_match(struct message
*mp
, struct search_expr
const *sep
,
819 bool_t with_headers
);
821 FL
struct message
* setdot(struct message
*mp
);
823 /* Delete a file, but only if the file is a plain file */
824 FL
int rm(char const *name
);
826 /* Determine the size of the file possessed by the passed buffer */
827 FL off_t
fsize(FILE *iob
);
829 /* Evaluate the string given as a new mailbox name. Supported meta characters:
830 * . % for my system mail box
831 * . %user for user's system mail box
832 * . # for previous file
833 * . & invoker's mbox file
834 * . +file file in folder directory
835 * . any shell meta character (except for FEXP_NSHELL).
836 * If FEXP_NSHELL is set you possibly want to call fexpand_nshell_quote(),
837 * a poor man's vis(3), on name before calling this (and showing the user).
838 * Returns the file name as an auto-reclaimed string */
839 FL
char * fexpand(char const *name
, enum fexp_mode fexpm
);
841 #define expand(N) fexpand(N, FEXP_FULL) /* XXX obsolete */
842 #define file_expand(N) fexpand(N, FEXP_LOCAL) /* XXX obsolete */
844 /* A poor man's vis(3) for only backslash escaping as for FEXP_NSHELL.
845 * Returns the (possibly adjusted) buffer in auto-reclaimed storage */
846 FL
char * fexpand_nshell_quote(char const *name
);
848 /* accmacvar.c hook: *folder* variable has been updated; if folder shouldn't
849 * be replaced by something else leave store alone, otherwise smalloc() the
850 * desired value (ownership will be taken) */
851 FL bool_t
var_folder_updated(char const *folder
, char **store
);
853 /* Determine the current *folder* name, store it in *name* */
854 FL bool_t
getfold(char *name
, size_t size
);
856 /* Return the name of the dead.letter file */
857 FL
char const * getdeadletter(void);
859 FL
enum okay
get_body(struct message
*mp
);
863 /* Will retry FILE_LOCK_RETRIES times if pollmsecs > 0 */
864 FL bool_t
file_lock(int fd
, enum file_lock_type flt
, off_t off
, off_t len
,
867 /* Aquire a flt lock and create a dotlock file; upon success a registered
868 * control-pipe FILE* is returned that keeps the link in between us and the
869 * lock-holding fork(2)ed subprocess (which conditionally replaced itself via
870 * execv(2) with the privilege-separated dotlock helper program): the lock file
871 * will be removed once the control pipe is closed via Pclose().
872 * Will try FILE_LOCK_TRIES times if pollmsecs > 0 (once otherwise).
873 * If *dotlock_ignore_error* is set (FILE*)-1 will be returned if at least the
874 * normal file lock could be established, otherwise errno is usable on error */
875 FL
FILE * dot_lock(char const *fname
, int fd
, enum file_lock_type flt
,
876 off_t off
, off_t len
, size_t pollmsecs
);
880 FL bool_t
sopen(struct sock
*sp
, struct url
*urlp
);
881 FL
int sclose(struct sock
*sp
);
882 FL
enum okay
swrite(struct sock
*sp
, char const *data
);
883 FL
enum okay
swrite1(struct sock
*sp
, char const *data
, int sz
,
887 FL
int sgetline(char **line
, size_t *linesize
, size_t *linelen
,
888 struct sock
*sp SMALLOC_DEBUG_ARGS
);
890 # define sgetline(A,B,C,D) sgetline(A, B, C, D, __FILE__, __LINE__)
892 #endif /* HAVE_SOCKETS */
894 /* Deal with loading of resource files and dealing with a stack of files for
895 * the source command */
897 /* Load a file of user definitions -- this is *only* for main()! */
898 FL
void load(char const *name
);
900 /* Pushdown current input file and switch to a new one. Set the global flag
901 * PS_SOURCING so that others will realize that they are no longer reading from
902 * a tty (in all probability).
903 * The latter won't return failure (TODO should be replaced by "-f FILE") */
904 FL
int c_source(void *v
);
905 FL
int c_source_if(void *v
);
907 /* Pop the current input back to the previous level. Update the PS_SOURCING
908 * flag as appropriate */
909 FL
int unstack(void);
915 /* Return the user's From: address(es) */
916 FL
char const * myaddrs(struct header
*hp
);
918 /* Boil the user's From: addresses down to a single one, or use *sender* */
919 FL
char const * myorigin(struct header
*hp
);
921 /* See if the passed line buffer, which may include trailing newline (sequence)
922 * is a mail From_ header line according to RFC 4155.
923 * If compat is true laxe POSIX syntax is instead sufficient to match From_ */
924 FL
int is_head(char const *linebuf
, size_t linelen
, bool_t compat
);
926 /* Savage extract date field from From_ line. linelen is convenience as line
927 * must be terminated (but it may end in a newline [sequence]).
928 * Return wether the From_ line was parsed successfully */
929 FL
int extract_date_from_from_(char const *line
, size_t linelen
,
930 char datebuf
[FROM_DATEBUF
]);
932 /* Extract some header fields (see e.g. -t documentation) from a message.
933 * If options&OPT_t_FLAG *and* pstate&PS_t_FLAG are both set a number of
934 * additional header fields are understood and address joining is performed as
935 * necessary, and the subject is treated with additional care, too.
936 * If pstate&PS_t_FLAG is set but OPT_t_FLAG is no more, From: will not be
938 * This calls expandaddr() on some headers and sets checkaddr_err if that is
939 * not NULL -- note it explicitly allows EAF_NAME because aliases are not
940 * expanded when this is called! */
941 FL
void extract_header(FILE *fp
, struct header
*hp
,
942 si8_t
*checkaddr_err
);
944 /* Return the desired header line from the passed message
945 * pointer (or NULL if the desired header field is not available).
946 * If mult is zero, return the content of the first matching header
947 * field only, the content of all matching header fields else */
948 FL
char * hfield_mult(char const *field
, struct message
*mp
, int mult
);
949 #define hfieldX(a, b) hfield_mult(a, b, 1)
950 #define hfield1(a, b) hfield_mult(a, b, 0)
952 /* Check whether the passed line is a header line of the desired breed.
953 * Return the field body, or 0 */
954 FL
char const * thisfield(char const *linebuf
, char const *field
);
956 /* Get sender's name from this message. If the message has a bunch of arpanet
957 * stuff in it, we may have to skin the name before returning it */
958 FL
char * nameof(struct message
*mp
, int reptype
);
960 /* Start of a "comment". Ignore it */
961 FL
char const * skip_comment(char const *cp
);
963 /* Return the start of a route-addr (address in angle brackets), if present */
964 FL
char const * routeaddr(char const *name
);
966 /* Query *expandaddr*, parse it and return flags.
967 * The flags are already adjusted for OPT_INTERACTIVE / OPT_TILDE_FLAG etc. */
968 FL
enum expand_addr_flags
expandaddr_to_eaf(void);
970 /* Check if an address is invalid, either because it is malformed or, if not,
971 * according to eacm. Return FAL0 when it looks good, TRU1 if it is invalid
972 * but the error condition wasn't covered by a 'hard "fail"ure', -1 otherwise */
973 FL si8_t
is_addr_invalid(struct name
*np
,
974 enum expand_addr_check_mode eacm
);
976 /* Does *NP* point to a file or pipe addressee? */
977 #define is_fileorpipe_addr(NP) \
978 (((NP)->n_flags & NAME_ADDRSPEC_ISFILEORPIPE) != 0)
980 /* Return skinned version of *NP*s name */
981 #define skinned_name(NP) \
982 (assert((NP)->n_flags & NAME_SKINNED), \
983 ((struct name const*)NP)->n_name)
985 /* Skin an address according to the RFC 822 interpretation of "host-phrase" */
986 FL
char * skin(char const *name
);
988 /* Skin *name* and extract the *addr-spec* according to RFC 5322.
989 * Store the result in .ag_skinned and also fill in those .ag_ fields that have
990 * actually been seen.
991 * Return 0 if something good has been parsed, 1 if fun didn't exactly know how
992 * to deal with the input, or if that was plain invalid */
993 FL
int addrspec_with_guts(int doskin
, char const *name
,
994 struct addrguts
*agp
);
996 /* Fetch the real name from an internet mail address field */
997 FL
char * realname(char const *name
);
999 /* Fetch the sender's name from the passed message. reptype can be
1000 * 0 -- get sender's name for display purposes
1001 * 1 -- get sender's name for reply
1002 * 2 -- get sender's name for Reply */
1003 FL
char * name1(struct message
*mp
, int reptype
);
1005 /* Trim away all leading Re: etc., return pointer to plain subject.
1006 * Note it doesn't perform any MIME decoding by itself */
1007 FL
char * subject_re_trim(char *cp
);
1009 FL
int msgidcmp(char const *s1
, char const *s2
);
1011 /* See if the given header field is supposed to be ignored */
1012 FL
int is_ign(char const *field
, size_t fieldlen
,
1013 struct ignoretab igta
[2]);
1015 FL
int member(char const *realfield
, struct ignoretab
*table
);
1017 /* Fake Sender for From_ lines if missing, e. g. with POP3 */
1018 FL
char const * fakefrom(struct message
*mp
);
1020 FL
char const * fakedate(time_t t
);
1022 /* From username Fri Jan 2 20:13:51 2004
1025 #if defined HAVE_IMAP_SEARCH || defined HAVE_IMAP
1026 FL
time_t unixtime(char const *from
);
1029 FL
time_t rfctime(char const *date
);
1031 FL
time_t combinetime(int year
, int month
, int day
,
1032 int hour
, int minute
, int second
);
1034 FL
void substdate(struct message
*m
);
1036 /* Note: returns 0x1 if both args were NULL */
1037 FL
struct name
const * check_from_and_sender(struct name
const *fromfield
,
1038 struct name
const *senderfield
);
1041 FL
char * getsender(struct message
*m
);
1044 /* Fill in / reedit the desired header fields */
1045 FL
int grab_headers(struct header
*hp
, enum gfield gflags
,
1048 /* Check wether sep->ss_sexpr (or ->ss_regex) matches any header of mp */
1049 FL bool_t
header_match(struct message
*mp
, struct search_expr
const *sep
);
1056 FL
char const * imap_fileof(char const *xcp
);
1057 FL
enum okay
imap_noop(void);
1058 FL
enum okay
imap_select(struct mailbox
*mp
, off_t
*size
, int *count
,
1059 const char *mbx
, enum fedit_mode fm
);
1060 FL
int imap_setfile(const char *xserver
, enum fedit_mode fm
);
1061 FL
enum okay
imap_header(struct message
*m
);
1062 FL
enum okay
imap_body(struct message
*m
);
1063 FL
void imap_getheaders(int bot
, int top
);
1064 FL
void imap_quit(void);
1065 FL
enum okay
imap_undelete(struct message
*m
, int n
);
1066 FL
enum okay
imap_unread(struct message
*m
, int n
);
1067 FL
int c_imap_imap(void *vp
);
1068 FL
int imap_newmail(int nmail
);
1069 FL
enum okay
imap_append(const char *xserver
, FILE *fp
);
1070 FL
void imap_folders(const char *name
, int strip
);
1071 FL
enum okay
imap_copy(struct message
*m
, int n
, const char *name
);
1072 # ifdef HAVE_IMAP_SEARCH
1073 FL
enum okay
imap_search1(const char *spec
, int f
);
1075 FL
int imap_thisaccount(const char *cp
);
1076 FL
enum okay
imap_remove(const char *name
);
1077 FL
enum okay
imap_rename(const char *old
, const char *new);
1078 FL
enum okay
imap_dequeue(struct mailbox
*mp
, FILE *fp
);
1079 FL
int c_connect(void *vp
);
1080 FL
int c_disconnect(void *vp
);
1081 FL
int c_cache(void *vp
);
1082 FL
int disconnected(const char *file
);
1083 FL
void transflags(struct message
*omessage
, long omsgCount
,
1085 FL
time_t imap_read_date_time(const char *cp
);
1086 FL
const char * imap_make_date_time(time_t t
);
1088 # define c_imap_imap c_cmdnotsupp
1089 # define c_connect c_cmdnotsupp
1090 # define c_disconnect c_cmdnotsupp
1091 # define c_cache c_cmdnotsupp
1094 #if defined HAVE_IMAP || defined HAVE_IMAP_SEARCH
1095 FL
char * imap_quotestr(char const *s
);
1096 FL
char * imap_unquotestr(char const *s
);
1104 FL
enum okay
getcache1(struct mailbox
*mp
, struct message
*m
,
1105 enum needspec need
, int setflags
);
1106 FL
enum okay
getcache(struct mailbox
*mp
, struct message
*m
,
1107 enum needspec need
);
1108 FL
void putcache(struct mailbox
*mp
, struct message
*m
);
1109 FL
void initcache(struct mailbox
*mp
);
1110 FL
void purgecache(struct mailbox
*mp
, struct message
*m
, long mc
);
1111 FL
void delcache(struct mailbox
*mp
, struct message
*m
);
1112 FL
enum okay
cache_setptr(enum fedit_mode fm
, int transparent
);
1113 FL
enum okay
cache_list(struct mailbox
*mp
, char const *base
, int strip
,
1115 FL
enum okay
cache_remove(char const *name
);
1116 FL
enum okay
cache_rename(char const *old
, char const *new);
1117 FL
unsigned long cached_uidvalidity(struct mailbox
*mp
);
1118 FL
FILE * cache_queue(struct mailbox
*mp
);
1119 FL
enum okay
cache_dequeue(struct mailbox
*mp
);
1120 #endif /* HAVE_IMAP */
1126 #ifdef HAVE_IMAP_SEARCH
1127 FL
enum okay
imap_search(char const *spec
, int f
);
1134 /* Set up editing on the given file name.
1135 * If the first character of name is %, we are considered to be editing the
1136 * file, otherwise we are reading our mail which has signficance for mbox and
1138 nmail: Check for new mail in the current folder only */
1139 FL
int setfile(char const *name
, enum fedit_mode fm
);
1141 FL
int newmailinfo(int omsgCount
);
1143 /* Interpret user commands. If standard input is not a tty, print no prompt;
1144 * return wether the last processed command returned error */
1145 FL bool_t
commands(void);
1147 /* TODO drop execute() is the legacy version of evaluate().
1148 * It assumes we've been invoked recursively */
1149 FL
int execute(char *linebuf
, size_t linesize
);
1151 /* Evaluate a single command.
1152 * .ev_add_history and .ev_new_content will be updated upon success.
1153 * Command functions return 0 for success, 1 for error, and -1 for abort.
1154 * 1 or -1 aborts a load or source, a -1 aborts the interactive command loop */
1155 FL
int evaluate(struct eval_ctx
*evp
);
1157 /* Set the size of the message vector used to construct argument lists to
1158 * message list functions */
1159 FL
void setmsize(int sz
);
1161 /* Logic behind -H / -L invocations */
1162 FL
void print_header_summary(char const *Larg
);
1164 /* The following gets called on receipt of an interrupt. This is to abort
1165 * printout of a command, mainly. Dispatching here when command() is inactive
1166 * crashes rcv. Close all open files except 0, 1, 2, and the temporary. Also,
1167 * unstack all source files */
1168 FL
void onintr(int s
);
1170 /* Announce the presence of the current Mail version, give the message count,
1171 * and print a header listing */
1172 FL
void announce(int printheaders
);
1174 /* Announce information about the file we are editing. Return a likely place
1176 FL
int newfileinfo(void);
1178 FL
int getmdot(int nmail
);
1180 FL
void initbox(char const *name
);
1182 /* Print the docstring of `comm', which may be an abbreviation.
1183 * Return FAL0 if there is no such command */
1184 #ifdef HAVE_DOCSTRINGS
1185 FL bool_t
print_comm_docstr(char const *comm
);
1192 /* Convert user string of message numbers and store the numbers into vector.
1193 * Returns the count of messages picked up or -1 on error */
1194 FL
int getmsglist(char *buf
, int *vector
, int flags
);
1196 /* Scan out the list of string arguments, shell style for a RAWLIST */
1197 FL
int getrawlist(char const *line
, size_t linesize
,
1198 char **argv
, int argc
, int echolist
);
1200 /* Find the first message whose flags&m==f and return its message number */
1201 FL
int first(int f
, int m
);
1203 /* Mark the named message by setting its mark bit */
1204 FL
void mark(int mesg
, int f
);
1206 /* lzw.c TODO drop */
1208 FL
int zwrite(void *cookie
, const char *wbp
, int num
);
1209 FL
int zfree(void *cookie
);
1210 FL
int zread(void *cookie
, char *rbp
, int num
);
1211 FL
void * zalloc(FILE *fp
);
1212 #endif /* HAVE_IMAP */
1218 FL
int maildir_setfile(char const *name
, enum fedit_mode fm
);
1220 FL
void maildir_quit(void);
1222 FL
enum okay
maildir_append(char const *name
, FILE *fp
);
1224 FL
enum okay
maildir_remove(char const *name
);
1230 /* Quit quickly. If PS_SOURCING, just pop the input level by returning error */
1231 FL
int c_rexit(void *v
);
1237 /* *charset-7bit*, else CHARSET_7BIT */
1238 FL
char const * charset_get_7bit(void);
1240 /* *charset-8bit*, else CHARSET_8BIT */
1242 FL
char const * charset_get_8bit(void);
1245 /* LC_CTYPE:CODESET / *ttycharset*, else *charset-8bit*, else CHARSET_8BIT */
1246 FL
char const * charset_get_lc(void);
1248 /* *sendcharsets* .. *charset-8bit* iterator; *a_charset_to_try_first* may be
1249 * used to prepend a charset to this list (e.g., for *reply-in-same-charset*).
1250 * The returned boolean indicates charset_iter_is_valid().
1251 * Without HAVE_ICONV, this "iterates" over charset_get_lc() only */
1252 FL bool_t
charset_iter_reset(char const *a_charset_to_try_first
);
1253 FL bool_t
charset_iter_next(void);
1254 FL bool_t
charset_iter_is_valid(void);
1255 FL
char const * charset_iter(void);
1257 /* And this is (xxx temporary?) which returns the iterator if that is valid and
1258 * otherwise either charset_get_8bit() or charset_get_lc() dep. on HAVE_ICONV */
1259 FL
char const * charset_iter_or_fallback(void);
1261 FL
void charset_iter_recurse(char *outer_storage
[2]); /* TODO LEGACY */
1262 FL
void charset_iter_restore(char *outer_storage
[2]); /* TODO LEGACY */
1265 FL
char const * need_hdrconv(struct header
*hp
, enum gfield w
);
1268 /* Convert header fields from RFC 1522 format */
1269 FL
void mime_fromhdr(struct str
const *in
, struct str
*out
,
1270 enum tdflags flags
);
1272 /* Interpret MIME strings in parts of an address field */
1273 FL
char * mime_fromaddr(char const *name
);
1275 /* fwrite(3) performing the given MIME conversion */
1276 FL ssize_t
mime_write(char const *ptr
, size_t size
, FILE *f
,
1277 enum conversion convert
, enum tdflags dflags
,
1278 struct quoteflt
*qf
, struct str
*rest
);
1279 FL ssize_t
xmime_write(char const *ptr
, size_t size
, /* TODO LEGACY */
1280 FILE *f
, enum conversion convert
, enum tdflags dflags
);
1284 * Content-Transfer-Encodings as defined in RFC 2045 (and RFC 2047):
1285 * - Quoted-Printable, section 6.7
1286 * - Base64, section 6.8
1287 * TODO for now this is pretty mixed up regarding this external interface.
1288 * TODO in v15.0 CTE will be filter based, and explicit conversion will
1289 * TODO gain clear error codes
1292 /* Utilities: the former converts the byte c into a (NUL terminated)
1293 * hexadecimal string as is used in URL percent- and quoted-printable encoding,
1294 * the latter performs the backward conversion and returns the character or -1
1295 * on error; both don't deal with the sequence-introducing percent "%" */
1296 FL
char * mime_char_to_hexseq(char store
[3], char c
);
1297 FL si32_t
mime_hexseq_to_char(char const *hex
);
1299 /* Default MIME Content-Transfer-Encoding: as via *encoding* */
1300 FL
enum mime_enc
mime_enc_target(void);
1302 /* Map from a Content-Transfer-Encoding: header body (which may be NULL) */
1303 FL
enum mime_enc
mime_enc_from_ctehead(char const *hbody
);
1305 /* XXX Try to get rid of that */
1306 FL
char const * mime_enc_from_conversion(enum conversion
const convert
);
1308 /* How many characters of (the complete body) ln need to be quoted.
1309 * Only MIMEEF_ISHEAD and MIMEEF_ISENCWORD are understood */
1310 FL
size_t mime_enc_mustquote(char const *ln
, size_t lnlen
,
1311 enum mime_enc_flags flags
);
1313 /* How much space is necessary to encode len bytes in QP, worst case.
1314 * Includes room for terminator */
1315 FL
size_t qp_encode_calc_size(size_t len
);
1317 /* If flags includes QP_ISHEAD these assume "word" input and use special
1318 * quoting rules in addition; soft line breaks are not generated.
1319 * Otherwise complete input lines are assumed and soft line breaks are
1320 * generated as necessary */
1321 FL
struct str
* qp_encode(struct str
*out
, struct str
const *in
,
1322 enum qpflags flags
);
1324 FL
struct str
* qp_encode_cp(struct str
*out
, char const *cp
,
1325 enum qpflags flags
);
1326 FL
struct str
* qp_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
1327 enum qpflags flags
);
1330 /* If rest is set then decoding will assume body text input (assumes input
1331 * represents lines, only create output when input didn't end with soft line
1332 * break [except it finalizes an encoded CRLF pair]), otherwise it is assumed
1333 * to decode a header strings and (1) uses special decoding rules and (b)
1334 * directly produces output.
1335 * The buffers of out and possibly rest will be managed via srealloc().
1336 * Returns OKAY. XXX or STOP on error (in which case out is set to an error
1337 * XXX message); caller is responsible to free buffers */
1338 FL
int qp_decode(struct str
*out
, struct str
const *in
,
1341 /* How much space is necessary to encode len bytes in Base64, worst case.
1342 * Includes room for (CR/LF/CRLF and) terminator */
1343 FL
size_t b64_encode_calc_size(size_t len
);
1345 /* Note these simply convert all the input (if possible), including the
1346 * insertion of NL sequences if B64_CRLF or B64_LF is set (and multiple thereof
1347 * if B64_MULTILINE is set).
1348 * Thus, in the B64_BUF case, better call b64_encode_calc_size() first */
1349 FL
struct str
* b64_encode(struct str
*out
, struct str
const *in
,
1350 enum b64flags flags
);
1351 FL
struct str
* b64_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
1352 enum b64flags flags
);
1354 FL
struct str
* b64_encode_cp(struct str
*out
, char const *cp
,
1355 enum b64flags flags
);
1358 /* If rest is set then decoding will assume text input.
1359 * The buffers of out and possibly rest will be managed via srealloc().
1360 * Returns OKAY or STOP on error (in which case out is set to an error
1361 * message); caller is responsible to free buffers.
1362 * XXX STOP is effectively not returned for text input (rest!=NULL), instead
1363 * XXX replacement characters are produced for invalid data */
1364 FL
int b64_decode(struct str
*out
, struct str
const *in
,
1371 /* Get a mime style parameter from a header body */
1372 FL
char * mime_param_get(char const *param
, char const *headerbody
);
1374 /* Format parameter name to have value, salloc() it or NULL (error) in result.
1375 * 0 on error, 1 or -1 on success: the latter if result contains \n newlines,
1376 * which it will if the created param requires more than MIME_LINELEN bytes;
1377 * there is never a trailing newline character */
1378 /* TODO mime_param_create() should return a StrList<> or something.
1379 * TODO in fact it should take a HeaderField* and append a HeaderFieldParam*! */
1380 FL si8_t
mime_param_create(struct str
*result
, char const *name
,
1383 /* Get the boundary out of a Content-Type: multipart/xyz header field, return
1384 * salloc()ed copy of it; store strlen() in *len if set */
1385 FL
char * mime_param_boundary_get(char const *headerbody
, size_t *len
);
1387 /* Create a salloc()ed MIME boundary */
1388 FL
char * mime_param_boundary_create(void);
1394 /* Create MIME part object tree for and of mp */
1395 FL
struct mimepart
* mime_parse_msg(struct message
*mp
,
1396 enum mime_parse_flags mpf
);
1402 /* `(un)?mimetype' commands */
1403 FL
int c_mimetype(void *v
);
1404 FL
int c_unmimetype(void *v
);
1406 /* Return a Content-Type matching the name, or NULL if none could be found */
1407 FL
char * mime_type_by_filename(char const *name
);
1409 /* Classify content of *fp* as necessary and fill in arguments; **charset* is
1410 * left alone unless it's non-NULL */
1411 FL
enum conversion
mime_type_file_classify(FILE *fp
, char const **contenttype
,
1412 char const **charset
, int *do_iconv
);
1414 /* Dependend on *mime-counter-evidence* mpp->m_ct_type_usr_ovwr will be set,
1415 * but otherwise mpp is const */
1416 FL
enum mimecontent
mime_type_mimepart_content(struct mimepart
*mpp
);
1418 /* Get the (pipe) handler for a part (may be MIME_TYPE_HANDLER_*),
1419 * or NULL if there is none known */
1420 FL
char const * mime_type_mimepart_handler(struct mimepart
const *mpp
);
1426 /* Allocate a single element of a name list, initialize its name field to the
1427 * passed name and return it */
1428 FL
struct name
* nalloc(char *str
, enum gfield ntype
);
1430 /* Like nalloc(), but initialize from content of np */
1431 FL
struct name
* ndup(struct name
*np
, enum gfield ntype
);
1433 /* Concatenate the two passed name lists, return the result */
1434 FL
struct name
* cat(struct name
*n1
, struct name
*n2
);
1437 FL
struct name
* namelist_dup(struct name
const *np
, enum gfield ntype
);
1439 /* Determine the number of undeleted elements in a name list and return it;
1440 * the latter also doesn't count file and pipe addressees in addition */
1441 FL ui32_t
count(struct name
const *np
);
1442 FL ui32_t
count_nonlocal(struct name
const *np
);
1444 /* Extract a list of names from a line, and make a list of names from it.
1445 * Return the list or NULL if none found */
1446 FL
struct name
* extract(char const *line
, enum gfield ntype
);
1448 /* Like extract() unless line contains anyof ",\"\\(<|", in which case
1449 * comma-separated list extraction is used instead */
1450 FL
struct name
* lextract(char const *line
, enum gfield ntype
);
1452 /* Turn a list of names into a string of the same names */
1453 FL
char * detract(struct name
*np
, enum gfield ntype
);
1455 /* Get a lextract() list via n_input_cp_addhist(), reassigning to *np* */
1456 FL
struct name
* grab_names(char const *field
, struct name
*np
, int comma
,
1457 enum gfield gflags
);
1459 /* Check wether n1 n2 share the domain name */
1460 FL bool_t
name_is_same_domain(struct name
const *n1
,
1461 struct name
const *n2
);
1463 /* Check all addresses in np and delete invalid ones; if set_on_error is not
1464 * NULL it'll be set to TRU1 for error or -1 for "hard fail" error */
1465 FL
struct name
* checkaddrs(struct name
*np
, enum expand_addr_check_mode eacm
,
1466 si8_t
*set_on_error
);
1468 /* Vaporise all duplicate addresses in hp (.h_(to|cc|bcc)) so that an address
1469 * that "first" occurs in To: is solely in there, ditto Cc:, after expanding
1470 * aliases etc. eacm and set_on_error are passed to checkaddrs(), metoo is
1471 * passed to usermap(). After updating hp to the new state this returns
1472 * a flat list of all addressees, which may be NULL */
1473 FL
struct name
* namelist_vaporise_head(struct header
*hp
,
1474 enum expand_addr_check_mode eacm
, bool_t metoo
,
1475 si8_t
*set_on_error
);
1477 /* Map all of the aliased users in the invoker's mailrc file and insert them
1479 FL
struct name
* usermap(struct name
*names
, bool_t force_metoo
);
1481 /* Remove all of the duplicates from the passed name list by insertion sorting
1482 * them, then checking for dups. Return the head of the new list */
1483 FL
struct name
* elide(struct name
*names
);
1485 /* `alternates' deal with the list of alternate names */
1486 FL
int c_alternates(void *v
);
1488 FL
struct name
* delete_alternates(struct name
*np
);
1490 FL
int is_myname(char const *name
);
1493 FL
int c_alias(void *v
);
1494 FL
int c_unalias(void *v
);
1496 /* `(un)?ml(ist|subscribe)', and a check wether a name is a (wanted) list */
1497 FL
int c_mlist(void *v
);
1498 FL
int c_unmlist(void *v
);
1499 FL
int c_mlsubscribe(void *v
);
1500 FL
int c_unmlsubscribe(void *v
);
1502 FL
enum mlist_state
is_mlist(char const *name
, bool_t subscribed_only
);
1504 /* `(un)?shortcut', and check if str is one, return expansion or NULL */
1505 FL
int c_shortcut(void *v
);
1506 FL
int c_unshortcut(void *v
);
1508 FL
char const * shortcut_expand(char const *str
);
1516 FL
enum okay
ssl_open(struct url
const *urlp
, struct sock
*sp
);
1519 FL
void ssl_gen_err(char const *fmt
, ...);
1522 FL
int c_verify(void *vp
);
1525 FL
FILE * smime_sign(FILE *ip
, char const *addr
);
1528 FL
FILE * smime_encrypt(FILE *ip
, char const *certfile
, char const *to
);
1530 FL
struct message
* smime_decrypt(struct message
*m
, char const *to
,
1531 char const *cc
, int signcall
);
1534 FL
enum okay
smime_certsave(struct message
*m
, int n
, FILE *op
);
1536 #else /* HAVE_OPENSSL */
1537 # define c_verify c_cmdnotsupp
1546 FL
enum okay
pop3_noop(void);
1549 FL
int pop3_setfile(char const *server
, enum fedit_mode fm
);
1552 FL
enum okay
pop3_header(struct message
*m
);
1555 FL
enum okay
pop3_body(struct message
*m
);
1558 FL
void pop3_quit(void);
1559 #endif /* HAVE_POP3 */
1563 * Subprocesses, popen, but also file handling with registering
1566 /* For program startup in main.c: initialize process manager */
1567 FL
void command_manager_start(void);
1569 /* Notes: OF_CLOEXEC is implied in oflags, xflags may be NULL */
1570 FL
FILE * safe_fopen(char const *file
, char const *oflags
, int *xflags
);
1572 /* Notes: OF_CLOEXEC|OF_REGISTER are implied in oflags!
1573 * Exception is Fdopen() if nocloexec is TRU1, but otherwise even for it the fd
1574 * creator has to take appropriate steps in order to ensure this is true! */
1575 FL
FILE * Fopen(char const *file
, char const *oflags
);
1576 FL
FILE * Fdopen(int fd
, char const *oflags
, bool_t nocloexec
);
1578 FL
int Fclose(FILE *fp
);
1580 /* Open file according to oflags (see popen.c). Handles compressed files */
1581 FL
FILE * Zopen(char const *file
, char const *oflags
);
1583 /* Create a temporary file in tempdir, use prefix for its name, store the
1584 * unique name in fn (unless OF_UNLINK is set in oflags), and return a stdio
1585 * FILE pointer with access oflags. OF_CLOEXEC is implied in oflags.
1586 * One of OF_WRONLY and OF_RDWR must be set.
1587 * mode specifies the access mode of the newly created temporary file */
1588 FL
FILE * Ftmp(char **fn
, char const *prefix
, enum oflags oflags
,
1591 /* If OF_HOLDSIGS was set when calling Ftmp(), then hold_all_sigs() had been
1592 * called: call this to unlink(2) and free *fn and to rele_all_sigs() */
1593 FL
void Ftmp_release(char **fn
);
1595 /* Free the resources associated with the given filename. To be called after
1597 FL
void Ftmp_free(char **fn
);
1599 /* Create a pipe and ensure CLOEXEC bit is set in both descriptors */
1600 FL bool_t
pipe_cloexec(int fd
[2]);
1603 * env_addon may be NULL, otherwise it is expected to be a NULL terminated
1604 * array of "K=V" strings to be placed into the childs environment.
1605 * If cmd==(char*)-1 then shell is indeed expected to be a PTF :P that will be
1606 * called from within the child process */
1607 FL
FILE * Popen(char const *cmd
, char const *mode
, char const *shell
,
1608 char const **env_addon
, int newfd1
);
1610 FL bool_t
Pclose(FILE *ptr
, bool_t dowait
);
1612 FL
void close_all_files(void);
1614 /* Fork a child process, enable use of the *child() series below */
1615 FL
int fork_child(void);
1617 /* Run a command without a shell, with optional arguments and splicing of stdin
1618 * and stdout. The command name can be a sequence of words. Signals must be
1619 * handled by the caller. "Mask" contains the signals to ignore in the new
1620 * process. SIGINT is enabled unless it's in the mask */
1621 FL
int run_command(char const *cmd
, sigset_t
*mask
, int infd
,
1622 int outfd
, char const *a0
, char const *a1
, char const *a2
);
1625 * env_addon may be NULL, otherwise it is expected to be a NULL terminated
1626 * array of "K=V" strings to be placed into the childs environment */
1627 FL
int start_command(char const *cmd
, sigset_t
*mask
, int infd
,
1628 int outfd
, char const *a0
, char const *a1
, char const *a2
,
1629 char const **env_addon
);
1631 /* In-child process */
1632 FL
void prepare_child(sigset_t
*nset
, int infd
, int outfd
);
1634 /* Mark a child as don't care - pid */
1635 FL
void free_child(int pid
);
1637 /* Wait for pid, return wether we've had a normal EXIT_SUCCESS exit.
1638 * If wait_status is set, set it to the reported waitpid(2) wait status */
1639 FL bool_t
wait_child(int pid
, int *wait_status
);
1645 /* Save all of the undetermined messages at the top of "mbox". Save all
1646 * untouched messages back in the system mailbox. Remove the system mailbox,
1647 * if none saved there */
1650 /* Adjust the message flags in each message */
1651 FL
int holdbits(void);
1653 /* Create another temporary file and copy user's mbox file darin. If there is
1654 * no mbox, copy nothing. If he has specified "append" don't copy his mailbox,
1655 * just copy saveable entries at the end */
1656 FL
enum okay
makembox(void);
1658 FL
void save_mbox_for_possible_quitstuff(void); /* TODO DROP IF U CAN */
1660 FL
int savequitflags(void);
1662 FL
void restorequitflags(int);
1668 /* Send message described by the passed pointer to the passed output buffer.
1669 * Return -1 on error. Adjust the status: field if need be. If doign is
1670 * given, suppress ignored header fields. prefix is a string to prepend to
1671 * each output line. action = data destination
1672 * (SEND_MBOX,_TOFILE,_TODISP,_QUOTE,_DECRYPT). stats[0] is line count,
1673 * stats[1] is character count. stats may be NULL. Note that stats[0] is
1674 * valid for SEND_MBOX only */
1675 FL
int sendmp(struct message
*mp
, FILE *obuf
, struct ignoretab
*doign
,
1676 char const *prefix
, enum sendaction action
, ui64_t
*stats
);
1682 /* Interface between the argument list and the mail1 routine which does all the
1684 FL
int mail(struct name
*to
, struct name
*cc
, struct name
*bcc
,
1685 char *subject
, struct attachment
*attach
, char *quotefile
,
1686 int recipient_record
);
1688 /* `mail' and `Mail' commands, respectively */
1689 FL
int c_sendmail(void *v
);
1690 FL
int c_Sendmail(void *v
);
1692 /* Mail a message on standard input to the people indicated in the passed
1693 * header. (Internal interface) */
1694 FL
enum okay
mail1(struct header
*hp
, int printheaders
,
1695 struct message
*quote
, char *quotefile
, int recipient_record
,
1698 /* Create a Date: header field.
1699 * We compare the localtime() and gmtime() results to get the timezone, because
1700 * numeric timezones are easier to read and because $TZ isn't always set */
1701 FL
int mkdate(FILE *fo
, char const *field
);
1703 /* Dump the to, subject, cc header on the passed file buffer */
1704 FL
int puthead(struct header
*hp
, FILE *fo
, enum gfield w
,
1705 enum sendaction action
, enum conversion convert
,
1706 char const *contenttype
, char const *charset
);
1709 FL
enum okay
resend_msg(struct message
*mp
, struct name
*to
, int add_resent
);
1716 /* Send a message via SMTP */
1717 FL bool_t
smtp_mta(struct sendbundle
*sbp
);
1725 /* Direct mappings of the various spam* commands */
1726 FL
int c_spam_clear(void *v
);
1727 FL
int c_spam_set(void *v
);
1728 FL
int c_spam_forget(void *v
);
1729 FL
int c_spam_ham(void *v
);
1730 FL
int c_spam_rate(void *v
);
1731 FL
int c_spam_spam(void *v
);
1733 # define c_spam_clear c_cmdnotsupp
1734 # define c_spam_set c_cmdnotsupp
1735 # define c_spam_forget c_cmdnotsupp
1736 # define c_spam_ham c_cmdnotsupp
1737 # define c_spam_rate c_cmdnotsupp
1738 # define c_spam_spam c_cmdnotsupp
1747 FL
void ssl_set_verify_level(struct url
const *urlp
);
1750 FL
enum okay
ssl_verify_decide(void);
1753 FL
enum okay
smime_split(FILE *ip
, FILE **hp
, FILE **bp
, long xcount
,
1757 FL
FILE * smime_sign_assemble(FILE *hp
, FILE *bp
, FILE *sp
,
1758 char const *message_digest
);
1761 FL
FILE * smime_encrypt_assemble(FILE *hp
, FILE *yp
);
1764 FL
struct message
* smime_decrypt_assemble(struct message
*m
, FILE *hp
,
1768 FL
int c_certsave(void *v
);
1771 FL
enum okay
rfc2595_hostname_match(char const *host
, char const *pattern
);
1772 #else /* HAVE_SSL */
1773 # define c_certsave c_cmdnotsupp
1778 * This bundles several different string related support facilities:
1779 * - auto-reclaimed string storage (memory goes away on command loop ticks)
1780 * - plain char* support functions which use unspecified or smalloc() memory
1781 * - struct str related support funs
1782 * - our iconv(3) wrapper
1785 /* Auto-reclaimed string storage */
1788 # define SALLOC_DEBUG_ARGS , char const *mdbg_file, int mdbg_line
1789 # define SALLOC_DEBUG_ARGSCALL , mdbg_file, mdbg_line
1791 # define SALLOC_DEBUG_ARGS
1792 # define SALLOC_DEBUG_ARGSCALL
1795 /* Allocate size more bytes of space and return the address of the first byte
1796 * to the caller. An even number of bytes are always allocated so that the
1797 * space will always be on a word boundary */
1798 FL
void * salloc(size_t size SALLOC_DEBUG_ARGS
);
1799 FL
void * csalloc(size_t nmemb
, size_t size SALLOC_DEBUG_ARGS
);
1801 # define salloc(SZ) salloc(SZ, __FILE__, __LINE__)
1802 # define csalloc(NM,SZ) csalloc(NM, SZ, __FILE__, __LINE__)
1805 /* Auto-reclaim string storage; if only_if_relaxed is true then only perform
1806 * the reset when a srelax_hold() is currently active */
1807 FL
void sreset(bool_t only_if_relaxed
);
1809 /* The "problem" with sreset() is that it releases all string storage except
1810 * what was present once spreserve() had been called; it therefore cannot be
1811 * called from all that code which yet exists and walks about all the messages
1812 * in order, e.g. quit(), searches, etc., because, unfortunately, these code
1813 * paths are reached with new intermediate string dope already in use.
1814 * Thus such code should take a srelax_hold(), successively call srelax() after
1815 * a single message has been handled, and finally srelax_rele() (unless it is
1816 * clear that sreset() occurs anyway) */
1817 FL
void srelax_hold(void);
1818 FL
void srelax_rele(void);
1819 FL
void srelax(void);
1821 /* Make current string storage permanent: new allocs will be auto-reclaimed by
1822 * sreset(). This is called once only, from within main() */
1823 FL
void spreserve(void);
1825 /* 'sstats' command */
1827 FL
int c_sstats(void *v
);
1830 /* Return a pointer to a dynamic copy of the argument */
1831 FL
char * savestr(char const *str SALLOC_DEBUG_ARGS
);
1832 FL
char * savestrbuf(char const *sbuf
, size_t sbuf_len SALLOC_DEBUG_ARGS
);
1834 # define savestr(CP) savestr(CP, __FILE__, __LINE__)
1835 # define savestrbuf(CBP,CBL) savestrbuf(CBP, CBL, __FILE__, __LINE__)
1838 /* Concatenate cp2 onto cp1 (if not NULL), separated by sep (if not '\0') */
1839 FL
char * savecatsep(char const *cp1
, char sep
, char const *cp2
1842 # define savecatsep(S1,SEP,S2) savecatsep(S1, SEP, S2, __FILE__, __LINE__)
1845 /* Make copy of argument incorporating old one, if set, separated by space */
1846 #define save2str(S,O) savecatsep(O, ' ', S)
1849 #define savecat(S1,S2) savecatsep(S1, '\0', S2)
1851 /* Create duplicate, lowercasing all characters along the way */
1852 FL
char * i_strdup(char const *src SALLOC_DEBUG_ARGS
);
1854 # define i_strdup(CP) i_strdup(CP, __FILE__, __LINE__)
1857 /* Extract the protocol base and return a duplicate */
1858 FL
char * protbase(char const *cp SALLOC_DEBUG_ARGS
);
1860 # define protbase(CP) protbase(CP, __FILE__, __LINE__)
1864 FL
struct str
* str_concat_csvl(struct str
*self
, ...);
1867 FL
struct str
* str_concat_cpa(struct str
*self
, char const * const *cpa
,
1868 char const *sep_o_null SALLOC_DEBUG_ARGS
);
1870 # define str_concat_cpa(S,A,N) str_concat_cpa(S, A, N, __FILE__, __LINE__)
1873 /* Plain char* support, not auto-reclaimed (unless noted) */
1875 /* Are any of the characters in the two strings the same? */
1876 FL
int anyof(char const *s1
, char const *s2
);
1878 /* Treat *iolist as a sep separated list of strings; find and return the
1879 * next entry, trimming surrounding whitespace, and point *iolist to the next
1880 * entry or to NULL if no more entries are contained. If ignore_empty is not
1881 * set empty entries are started over. Return NULL or an entry */
1882 FL
char * n_strsep(char **iolist
, char sep
, bool_t ignore_empty
);
1884 /* Copy a string, lowercasing it as we go; *size* is buffer size of *dest*;
1885 * *dest* will always be terminated unless *size* is 0 */
1886 FL
void i_strcpy(char *dest
, char const *src
, size_t size
);
1888 /* Is *as1* a valid prefix of *as2*? */
1889 FL
int is_prefix(char const *as1
, char const *as2
);
1891 /* Backslash quote (" and \) v'alue, and return salloc()ed result */
1892 FL
char * string_quote(char const *v
);
1894 /* Get (and isolate) the last, possibly quoted part of linebuf, set *needs_list
1895 * to indicate wether getmsglist() et al need to be called to collect
1896 * additional args that remain in linebuf. Return NULL on "error" */
1897 FL
char * laststring(char *linebuf
, bool_t
*needs_list
, bool_t strip
);
1899 /* Convert a string to lowercase, in-place and with multibyte-aware */
1900 FL
void makelow(char *cp
);
1902 /* Is *sub* a substring of *str*, case-insensitive and multibyte-aware? */
1903 FL bool_t
substr(char const *str
, char const *sub
);
1906 FL
char * sstpcpy(char *dst
, char const *src
);
1907 FL
char * sstrdup(char const *cp SMALLOC_DEBUG_ARGS
);
1908 FL
char * sbufdup(char const *cp
, size_t len SMALLOC_DEBUG_ARGS
);
1910 # define sstrdup(CP) sstrdup(CP, __FILE__, __LINE__)
1911 # define sbufdup(CP,L) sbufdup(CP, L, __FILE__, __LINE__)
1914 FL
char * n_strlcpy(char *dst
, char const *src
, size_t len
);
1916 /* Case-independent ASCII comparisons */
1917 FL
int asccasecmp(char const *s1
, char const *s2
);
1918 FL
int ascncasecmp(char const *s1
, char const *s2
, size_t sz
);
1920 /* Case-independent ASCII string find s2 in s1, return it or NULL */
1921 FL
char const *asccasestr(char const *s1
, char const *s2
);
1923 /* Case-independent ASCII check wether as2 is the initial substring of as1 */
1924 FL bool_t
is_asccaseprefix(char const *as1
, char const *as2
);
1926 /* struct str related support funs */
1928 /* *self->s* is srealloc()ed */
1929 FL
struct str
* n_str_dup(struct str
*self
, struct str
const *t
1930 SMALLOC_DEBUG_ARGS
);
1932 /* *self->s* is srealloc()ed, *self->l* incremented */
1933 FL
struct str
* n_str_add_buf(struct str
*self
, char const *buf
, size_t buflen
1934 SMALLOC_DEBUG_ARGS
);
1935 #define n_str_add(S, T) n_str_add_buf(S, (T)->s, (T)->l)
1936 #define n_str_add_cp(S, CP) n_str_add_buf(S, CP, (CP) ? strlen(CP) : 0)
1939 # define n_str_dup(S,T) n_str_dup(S, T, __FILE__, __LINE__)
1940 # define n_str_add_buf(S,B,BL) n_str_add_buf(S, B, BL, __FILE__, __LINE__)
1945 /* ..and update arguments to point after range; returns UI32_MAX on error, in
1946 * which case the arguments will have been stepped one byte */
1947 #ifdef HAVE_NATCH_CHAR
1948 FL ui32_t
n_utf8_to_utf32(char const **bdat
, size_t *blen
);
1951 /* buf must be large enough also for NUL, it's new length will be returned */
1952 #ifdef HAVE_FILTER_HTML_TAGSOUP
1953 FL
size_t n_utf32_to_utf8(ui32_t c
, char *buf
);
1956 /* Our iconv(3) wrappers */
1959 FL iconv_t
n_iconv_open(char const *tocode
, char const *fromcode
);
1960 /* If *cd* == *iconvd*, assigns -1 to the latter */
1961 FL
void n_iconv_close(iconv_t cd
);
1963 /* Reset encoding state */
1964 FL
void n_iconv_reset(iconv_t cd
);
1966 /* iconv(3), but return *errno* or 0; *skipilseq* forces step over invalid byte
1967 * sequences; likewise iconv_str(), but which auto-grows on E2BIG errors; *in*
1968 * and *in_rest_or_null* may be the same object.
1969 * Note: EINVAL (incomplete sequence at end of input) is NOT handled, so the
1970 * replacement character must be added manually if that happens at EOF! */
1971 FL
int n_iconv_buf(iconv_t cd
, char const **inb
, size_t *inbleft
,
1972 char **outb
, size_t *outbleft
, bool_t skipilseq
);
1973 FL
int n_iconv_str(iconv_t icp
, struct str
*out
, struct str
const *in
,
1974 struct str
*in_rest_or_null
, bool_t skipilseq
);
1981 /* termcap(3) / xy lifetime handling -- only to be called if OPT_INTERACTIVE
1982 * is true, and may internally decline to initialize itself; note that
1983 * termcap_destroy() can always be called */
1984 /* TODO Maybe drop TTYOUT/etc. and only set INTERACTIVE when input and output
1985 * TODO are a terminal, or ensure via I/O stuff that we use the input+output
1986 * TODO terminal FD accordingly */
1988 FL
void termcap_init(void);
1989 FL
void termcap_destroy(void);
1997 FL
int c_thread(void *vp
);
2000 FL
int c_unthread(void *vp
);
2003 FL
struct message
* next_in_thread(struct message
*mp
);
2004 FL
struct message
* prev_in_thread(struct message
*mp
);
2005 FL
struct message
* this_in_thread(struct message
*mp
, long n
);
2007 /* Sorted mode is internally just a variant of threaded mode with all m_parent
2008 * and m_child links being NULL */
2009 FL
int c_sort(void *vp
);
2012 FL
int c_collapse(void *v
);
2013 FL
int c_uncollapse(void *v
);
2016 FL
void uncollapse1(struct message
*mp
, int always
);
2022 /* Return wether user says yes, on STDIN if interactive.
2023 * Uses noninteract_default, the return value for non-interactive use cases,
2024 * also to choose a default prompt if that is NULL as well as a hint for
2025 * boolify(). Handles+reraises SIGINT */
2026 FL bool_t
getapproval(char const *prompt
, bool_t noninteract_default
);
2029 /* Get a password the expected way, return termios_state.ts_linebuf on
2030 * success or NULL on error */
2031 FL
char * getuser(char const *query
);
2033 /* Get a password the expected way, return termios_state.ts_linebuf on
2034 * success or NULL on error. SIGINT is temporarily blocked, *not* reraised.
2035 * termios_state_reset() (def.h) must be called anyway */
2036 FL
char * getpassword(char const *query
);
2039 /* Overall interactive terminal life cycle for command line editor library */
2040 #if defined HAVE_EDITLINE || defined HAVE_READLINE
2041 # define TTY_WANTS_SIGWINCH
2043 FL
void tty_init(void);
2044 FL
void tty_destroy(void);
2046 /* Rather for main.c / SIGWINCH interaction only */
2047 FL
void tty_signal(int sig
);
2049 /* Read a line after printing prompt (if set and non-empty).
2050 * If n>0 assumes that *linebuf has n bytes of default content */
2051 FL
int tty_readline(char const *prompt
, char **linebuf
,
2052 size_t *linesize
, size_t n SMALLOC_DEBUG_ARGS
);
2054 # define tty_readline(A,B,C,D) tty_readline(A, B, C, D, __FILE__, __LINE__)
2057 /* Add a line (most likely as returned by tty_readline()) to the history.
2058 * Wether an entry added for real depends on the isgabby / *history-gabby*
2059 * relation, and / or wether s is non-empty and doesn't begin with U+0020 */
2060 FL
void tty_addhist(char const *s
, bool_t isgabby
);
2062 #if defined HAVE_HISTORY &&\
2063 (defined HAVE_READLINE || defined HAVE_EDITLINE || defined HAVE_NCL)
2064 FL
int c_history(void *v
);
2071 /* URL en- and decoding according to (enough of) RFC 3986 (RFC 1738).
2072 * These return a newly salloc()ated result */
2073 FL
char * urlxenc(char const *cp
, bool_t ispath SALLOC_DEBUG_ARGS
);
2074 FL
char * urlxdec(char const *cp SALLOC_DEBUG_ARGS
);
2076 # define urlxenc(CP,P) urlxenc(CP, P, __FILE__, __LINE__)
2077 # define urlxdec(CP) urlxdec(CP, __FILE__, __LINE__)
2081 /* Return port of urlp->url_proto (and set irv_or_null), or NULL if unknown */
2082 FL
char const * url_servbyname(struct url
const *urlp
, ui16_t
*irv_or_null
);
2084 /* Parse data, which must meet the criteria of the protocol cproto, and fill
2085 * in the URL structure urlp (URL rather according to RFC 3986) */
2086 FL bool_t
url_parse(struct url
*urlp
, enum cproto cproto
,
2089 /* Zero ccp and lookup credentials for communicating with urlp.
2090 * Return wether credentials are available and valid (for chosen auth) */
2091 FL bool_t
ccred_lookup(struct ccred
*ccp
, struct url
*urlp
);
2092 FL bool_t
ccred_lookup_old(struct ccred
*ccp
, enum cproto cproto
,
2094 #endif /* HAVE_SOCKETS */
2098 FL
int c_netrc(void *v
);
2101 /* MD5 (RFC 1321) related facilities */
2103 # ifdef HAVE_OPENSSL_MD5
2104 # define md5_ctx MD5_CTX
2105 # define md5_init MD5_Init
2106 # define md5_update MD5_Update
2107 # define md5_final MD5_Final
2109 /* The function definitions are instantiated in main.c */
2110 # include "rfc1321.h"
2113 /* Store the MD5 checksum as a hexadecimal string in *hex*, *not* terminated,
2114 * using lowercase ASCII letters as defined in RFC 2195 */
2115 # define MD5TOHEX_SIZE 32
2116 FL
char * md5tohex(char hex
[MD5TOHEX_SIZE
], void const *vp
);
2118 /* CRAM-MD5 encode the *user* / *pass* / *b64* combo */
2119 FL
char * cram_md5_string(struct str
const *user
, struct str
const *pass
,
2122 /* RFC 2104: HMAC: Keyed-Hashing for Message Authentication.
2123 * unsigned char *text: pointer to data stream
2124 * int text_len : length of data stream
2125 * unsigned char *key : pointer to authentication key
2126 * int key_len : length of authentication key
2127 * caddr_t digest : caller digest to be filled in */
2128 FL
void hmac_md5(unsigned char *text
, int text_len
, unsigned char *key
,
2129 int key_len
, void *digest
);
2130 #endif /* HAVE_MD5 */
2132 #ifndef HAVE_AMALGAMATION