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 - 2014 Steffen (Daode) Nurpmeso <sdaoden@users.sf.net>.
8 * Copyright (c) 1992, 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. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed by the University of
22 * California, Berkeley and its contributors.
23 * 4. Neither the name of the University nor the names of its contributors
24 * may be used to endorse or promote products derived from this software
25 * without specific prior written permission.
27 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
41 * TODO Convert optional utility+ functions to n_*(); ditto
42 * TODO else use generic module-specific prefixes: str_(), am[em]_, sm[em]_, ..
44 /* TODO s-it-mode: not really (docu, funnames, funargs, etc) */
47 #ifndef HAVE_AMALGAMATION
54 * Macro-based generics
57 /* Kludges to handle the change from setexit / reset to setjmp / longjmp */
58 #define setexit() (void)sigsetjmp(srbuf, 1)
59 #define reset(x) siglongjmp(srbuf, x)
61 /* ASCII char classification */
62 #define __ischarof(C, FLAGS) \
63 (asciichar(C) && (class_char[(uc_it)(C)] & (FLAGS)) != 0)
65 #define asciichar(c) ((uc_it)(c) <= 0177)
66 #define alnumchar(c) __ischarof(c, C_DIGIT | C_OCTAL | C_UPPER | C_LOWER)
67 #define alphachar(c) __ischarof(c, C_UPPER | C_LOWER)
68 #define blankchar(c) __ischarof(c, C_BLANK)
69 #define blankspacechar(c) __ischarof(c, C_BLANK | C_SPACE)
70 #define cntrlchar(c) __ischarof(c, C_CNTRL)
71 #define digitchar(c) __ischarof(c, C_DIGIT | C_OCTAL)
72 #define lowerchar(c) __ischarof(c, C_LOWER)
73 #define punctchar(c) __ischarof(c, C_PUNCT)
74 #define spacechar(c) __ischarof(c, C_BLANK | C_SPACE | C_WHITE)
75 #define upperchar(c) __ischarof(c, C_UPPER)
76 #define whitechar(c) __ischarof(c, C_BLANK | C_WHITE)
77 #define octalchar(c) __ischarof(c, C_OCTAL)
79 #define upperconv(c) (lowerchar(c) ? (char)((uc_it)(c) - 'a' + 'A') : (c))
80 #define lowerconv(c) (upperchar(c) ? (char)((uc_it)(c) - 'A' + 'a') : (c))
82 #define fieldnamechar(c) \
83 (asciichar(c) && (c) > 040 && (c) != 0177 && (c) != ':')
85 /* Try to use alloca() for some function-local buffers and data, fall back to
86 * smalloc()/free() if not available */
88 # define ac_alloc(n) HAVE_ALLOCA(n)
89 # define ac_free(n) do {UNUSED(n);} while (0)
91 # define ac_alloc(n) smalloc(n)
92 # define ac_free(n) free(n)
95 /* Single-threaded, use unlocked I/O */
96 #ifdef HAVE_PUTC_UNLOCKED
98 # define getc(c) getc_unlocked(c)
100 # define putc(c, f) putc_unlocked(c, f)
102 # define putchar(c) putc_unlocked((c), stdout)
105 /* Truncate a file to the last character written. This is useful just before
106 * closing an old file that was opened for read/write */
107 #define ftrunc(stream) \
111 off = ftell(stream);\
113 ftruncate(fileno(stream), off);\
116 /* fflush() and rewind() */
117 #define fflush_rewind(stream) \
123 /* There are problems with dup()ing of file-descriptors for child processes.
124 * As long as those are not fixed in equal spirit to (outof(): FIX and
125 * recode.., 2012-10-04), and to avoid reviving of bugs like (If *record* is
126 * set, avoid writing dead content twice.., 2012-09-14), we have to somehow
127 * accomplish that the FILE* fp makes itself comfortable with the *real* offset
128 * of the underlaying file descriptor. Unfortunately Standard I/O and POSIX
129 * don't describe a way for that -- fflush();rewind(); won't do it. This
130 * fseek(END),rewind() pair works around the problem on *BSD and Linux.
131 * Update as of 2014-03-03: with Issue 7 POSIX has overloaded fflush(3): if
132 * used on a readable stream, then
134 * if the file is not already at EOF, and the file is one capable of
135 * seeking, the file offset of the underlying open file description shall
136 * be set to the file position of the stream.
138 * We need our own, simplified and reliable I/O */
139 #if defined _POSIX_VERSION && _POSIX_VERSION + 0 >= 200809L
140 # define really_rewind(stream) \
146 # define really_rewind(stream) \
148 fseek(stream, 0, SEEK_END);\
157 /* Don't use _var_* unless you *really* have to! */
159 /* Constant option key look/(un)set/clear */
160 FL
char * _var_oklook(enum okeys okey
);
161 #define ok_blook(C) (_var_oklook(CONCAT(ok_b_, C)) != NULL)
162 #define ok_vlook(C) _var_oklook(CONCAT(ok_v_, C))
164 FL bool_t
_var_okset(enum okeys okey
, uintptr_t val
);
165 #define ok_bset(C,B) _var_okset(CONCAT(ok_b_, C), (uintptr_t)(B))
166 #define ok_vset(C,V) _var_okset(CONCAT(ok_v_, C), (uintptr_t)(V))
168 FL bool_t
_var_okclear(enum okeys okey
);
169 #define ok_bclear(C) _var_okclear(CONCAT(ok_b_, C))
170 #define ok_vclear(C) _var_okclear(CONCAT(ok_v_, C))
172 /* Variable option key look/(un)set/clear */
173 FL
char * _var_voklook(char const *vokey
);
174 #define vok_blook(S) (_var_voklook(S) != NULL)
175 #define vok_vlook(S) _var_voklook(S)
177 FL bool_t
_var_vokset(char const *vokey
, uintptr_t val
);
178 #define vok_bset(S,B) _var_vokset(S, (uintptr_t)(B))
179 #define vok_vset(S,V) _var_vokset(S, (uintptr_t)(V))
181 FL bool_t
_var_vokclear(char const *vokey
);
182 #define vok_bclear(S) _var_vokclear(S)
183 #define vok_vclear(S) _var_vokclear(S)
185 /* Special case to handle the typical [xy-USER@HOST,] xy-HOST and plain xy
186 * variable chains; oxm is a bitmix which tells which combinations to test */
187 FL
char * _var_xoklook(enum okeys okey
, struct url
const *urlp
,
188 enum okey_xlook_mode oxm
);
189 #define xok_blook(C,URL,M) (_var_xoklook(CONCAT(ok_b_, C),URL,M) != NULL)
190 #define xok_vlook(C,URL,M) _var_xoklook(CONCAT(ok_v_, C), URL, M)
192 /* List all variables */
193 FL
void var_list_all(void);
196 FL
int c_varshow(void *v
);
198 /* User variable access: `set', `setenv', `unset' and `unsetenv' */
199 FL
int c_set(void *v
);
200 FL
int c_setenv(void *v
);
201 FL
int c_unset(void *v
);
202 FL
int c_unsetenv(void *v
);
204 /* Macros: `define', `undefine', `call' / `~' */
205 FL
int c_define(void *v
);
206 FL
int c_undefine(void *v
);
207 FL
int c_call(void *v
);
209 FL
int callhook(char const *name
, int nmail
);
211 /* Accounts: `account', `unaccount' */
212 FL
int c_account(void *v
);
213 FL
int c_unaccount(void *v
);
216 FL
int c_localopts(void *v
);
218 FL
void temporary_localopts_free(void); /* XXX intermediate hack */
224 /* Try to add an attachment for *file*, file_expand()ed.
225 * Return the new head of list *aphead*, or NULL.
226 * The newly created attachment will be stored in **newap*, if given */
227 FL
struct attachment
* add_attachment(struct attachment
*aphead
, char *file
,
228 struct attachment
**newap
);
230 /* Append comma-separated list of file names to the end of attachment list */
231 FL
void append_attachments(struct attachment
**aphead
, char *names
);
233 /* Interactively edit the attachment list */
234 FL
void edit_attachments(struct attachment
**aphead
);
240 /* Announce a fatal error (and die) */
241 FL
void panic(char const *format
, ...);
242 FL
void alert(char const *format
, ...);
244 /* Provide BSD-like signal() on all (POSIX) systems */
245 FL sighandler_type
safe_signal(int signum
, sighandler_type handler
);
247 /* Hold *all* signals but SIGCHLD, and release that total block again */
248 FL
void hold_all_sigs(void);
249 FL
void rele_all_sigs(void);
251 /* Hold HUP/QUIT/INT */
252 FL
void hold_sigs(void);
253 FL
void rele_sigs(void);
255 /* Not-Yet-Dead debug information (handler installation in main.c) */
257 FL
void _nyd_chirp(ui8_t act
, char const *file
, ui32_t line
,
259 FL
void _nyd_oncrash(int signo
);
261 # define NYD_ENTER _nyd_chirp(1, __FILE__, __LINE__, __FUN__)
262 # define NYD_LEAVE _nyd_chirp(2, __FILE__, __LINE__, __FUN__)
263 # define NYD _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
264 # define NYD_X _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
266 # define NYD_ENTER do {} while (0)
267 # define NYD_LEAVE do {} while (0)
268 # define NYD do {} while (0)
269 # define NYD_X do {} while (0) /* XXX LEGACY */
272 /* Touch the named message by setting its MTOUCH flag. Touched messages have
273 * the effect of not being sent back to the system mailbox on exit */
274 FL
void touch(struct message
*mp
);
276 /* Test to see if the passed file name is a directory, return true if it is */
277 FL bool_t
is_dir(char const *name
);
279 /* Count the number of arguments in the given string raw list */
280 FL
int argcount(char **argv
);
282 /* Compute screen size */
283 FL
int screensize(void);
285 /* Get our $PAGER; if env_addon is not NULL it is check wether we know about
286 * some environment variable that supports colour+ */
287 FL
char const *get_pager(char const **env_addon
);
289 /* Check wether using a pager is possible/makes sense and is desired by user
290 * (*crt* set); return number of screen lines (or *crt*) if so, 0 otherwise */
291 FL
size_t paging_seems_sensible(void);
293 /* Use a pager or STDOUT to print *fp*; if *lines* is 0, they'll be counted */
294 FL
void page_or_print(FILE *fp
, size_t lines
);
296 /* Parse name and guess at the required protocol */
297 FL
enum protocol
which_protocol(char const *name
);
299 /* Hash the passed string -- uses Chris Torek's hash algorithm */
300 FL ui32_t
torek_hash(char const *name
);
301 #define hash(S) (torek_hash(S) % HSHSIZE) /* xxx COMPAT (?) */
304 FL ui32_t
pjw(char const *cp
); /* TODO obsolete -> torek_hash() */
306 /* Find a prime greater than n */
307 FL ui32_t
nextprime(ui32_t n
);
309 /* Check wether *s is an escape sequence, expand it as necessary.
310 * Returns the expanded sequence or 0 if **s is NUL or PROMPT_STOP if it is \c.
311 * *s is advanced to after the expanded sequence (as possible).
312 * If use_prompt_extensions is set, an enum prompt_exp may be returned */
313 FL
int expand_shell_escape(char const **s
,
314 bool_t use_prompt_extensions
);
316 /* Get *prompt*, or '& ' if *bsdcompat*, of '? ' otherwise */
317 FL
char * getprompt(void);
319 /* Detect and query the hostname to use */
320 FL
char * nodename(int mayoverride
);
322 /* Parse data, which must meet the criteria of the protocol cproto, and fill
323 * in the URL structure urlp (URL rather according to RFC 3986) */
324 FL bool_t
url_parse(struct url
*urlp
, enum cproto cproto
,
327 /* Zero ccp and lookup credentials for communicating with urlp.
328 * Return wether credentials are available and valid (for chosen auth) */
329 FL bool_t
ccred_lookup(struct ccred
*ccp
, struct url
*urlp
);
330 FL bool_t
ccred_lookup_old(struct ccred
*ccp
, enum cproto cproto
,
333 /* Get a (pseudo) random string of *length* bytes; returns salloc()ed buffer */
334 FL
char * getrandstring(size_t length
);
336 /* MD5 (RFC 1321) related facilities */
338 # ifdef HAVE_OPENSSL_MD5
339 # define md5_ctx MD5_CTX
340 # define md5_init MD5_Init
341 # define md5_update MD5_Update
342 # define md5_final MD5_Final
344 # include "rfc1321.h"
347 /* Store the MD5 checksum as a hexadecimal string in *hex*, *not* terminated,
348 * using lowercase ASCII letters as defined in RFC 2195 */
349 # define MD5TOHEX_SIZE 32
350 FL
char * md5tohex(char hex
[MD5TOHEX_SIZE
], void const *vp
);
352 /* CRAM-MD5 encode the *user* / *pass* / *b64* combo */
353 FL
char * cram_md5_string(struct str
const *user
, struct str
const *pass
,
356 /* RFC 2104: HMAC: Keyed-Hashing for Message Authentication.
357 * unsigned char *text: pointer to data stream
358 * int text_len : length of data stream
359 * unsigned char *key : pointer to authentication key
360 * int key_len : length of authentication key
361 * caddr_t digest : caller digest to be filled in */
362 FL
void hmac_md5(unsigned char *text
, int text_len
, unsigned char *key
,
363 int key_len
, void *digest
);
366 FL
enum okay
makedir(char const *name
);
368 /* A get-wd..restore-wd approach */
369 FL
enum okay
cwget(struct cw
*cw
);
370 FL
enum okay
cwret(struct cw
*cw
);
371 FL
void cwrelse(struct cw
*cw
);
373 /* Check (multibyte-safe) how many bytes of buf (which is blen byts) can be
374 * safely placed in a buffer (field width) of maxlen bytes */
375 FL
size_t field_detect_clip(size_t maxlen
, char const *buf
, size_t blen
);
377 /* Put maximally maxlen bytes of buf, a buffer of blen bytes, into store,
378 * taking into account multibyte code point boundaries and possibly
379 * encapsulating in bidi_info toggles as necessary */
380 FL
size_t field_put_bidi_clip(char *store
, size_t maxlen
, char const *buf
,
383 /* Place cp in a salloc()ed buffer, column-aligned; for header display only */
384 FL
char * colalign(char const *cp
, int col
, int fill
,
385 int *cols_decr_used_or_null
);
387 /* Convert a string to a displayable one;
388 * prstr() returns the result savestr()d, prout() writes it */
389 FL
void makeprint(struct str
const *in
, struct str
*out
);
390 FL
char * prstr(char const *s
);
391 FL
int prout(char const *s
, size_t sz
, FILE *fp
);
393 /* Print out a Unicode character or a substitute for it, return 0 on error or
394 * wcwidth() (or 1) on success */
395 FL
size_t putuc(int u
, int c
, FILE *fp
);
397 /* Check wether bidirectional info maybe needed for blen bytes of bdat */
398 FL bool_t
bidi_info_needed(char const *bdat
, size_t blen
);
400 /* Create bidirectional text encapsulation information; without HAVE_NATCH_CHAR
401 * the strings are always empty */
402 FL
void bidi_info_create(struct bidi_info
*bip
);
404 /* We want coloured output (in this salloc() cycle). pager_used is used to
405 * test wether *colour-pager* is to be inspected */
407 FL
void colour_table_create(bool_t pager_used
);
408 FL
void colour_put(FILE *fp
, enum colourspec cs
);
409 FL
void colour_put_header(FILE *fp
, char const *name
);
410 FL
void colour_reset(FILE *fp
);
411 FL
struct str
const * colour_get(enum colourspec cs
);
413 # define colour_put(FP,CS)
414 # define colour_put_header(FP,N)
415 # define colour_reset(FP)
418 /* Update *tc* to now; only .tc_time updated unless *full_update* is true */
419 FL
void time_current_update(struct time_current
*tc
,
422 /* Memory allocation routines */
424 # define SMALLOC_DEBUG_ARGS , char const *mdbg_file, int mdbg_line
425 # define SMALLOC_DEBUG_ARGSCALL , mdbg_file, mdbg_line
427 # define SMALLOC_DEBUG_ARGS
428 # define SMALLOC_DEBUG_ARGSCALL
431 FL
void * smalloc(size_t s SMALLOC_DEBUG_ARGS
);
432 FL
void * srealloc(void *v
, size_t s SMALLOC_DEBUG_ARGS
);
433 FL
void * scalloc(size_t nmemb
, size_t size SMALLOC_DEBUG_ARGS
);
436 FL
void sfree(void *v SMALLOC_DEBUG_ARGS
);
437 /* Called by sreset(), then */
438 FL
void smemreset(void);
440 FL
int c_smemtrace(void *v
);
441 /* For immediate debugging purposes, it is possible to check on request */
443 # define _HAVE_MEMCHECK
444 FL bool_t
_smemcheck(char const *file
, int line
);
447 # define smalloc(SZ) smalloc(SZ, __FILE__, __LINE__)
448 # define srealloc(P,SZ) srealloc(P, SZ, __FILE__, __LINE__)
449 # define scalloc(N,SZ) scalloc(N, SZ, __FILE__, __LINE__)
450 # define free(P) sfree(P, __FILE__, __LINE__)
451 # define smemcheck() _smemcheck(__FILE__, __LINE__)
458 FL
int c_cmdnotsupp(void *v
);
460 /* Show header group */
461 FL
int c_headers(void *v
);
463 /* Scroll to the next/previous screen */
464 FL
int c_scroll(void *v
);
465 FL
int c_Scroll(void *v
);
467 /* Print out the headlines for each message in the passed message list */
468 FL
int c_from(void *v
);
470 /* Print all message in between and including bottom and topx if they are
471 * visible and either only_marked is false or they are MMARKed */
472 FL
void print_headers(size_t bottom
, size_t topx
, bool_t only_marked
);
474 /* Print out the value of dot */
475 FL
int c_pdot(void *v
);
477 /* Paginate messages, honor/don't honour ignored fields, respectively */
478 FL
int c_more(void *v
);
479 FL
int c_More(void *v
);
481 /* Type out messages, honor/don't honour ignored fields, respectively */
482 FL
int c_type(void *v
);
483 FL
int c_Type(void *v
);
485 /* Show MIME-encoded message text, including all fields */
486 FL
int c_show(void *v
);
488 /* Pipe messages, honor/don't honour ignored fields, respectively */
489 FL
int c_pipe(void *v
);
490 FL
int c_Pipe(void *v
);
492 /* Print the top so many lines of each desired message.
493 * The number of lines is taken from *toplines* and defaults to 5 */
494 FL
int c_top(void *v
);
496 /* Touch all the given messages so that they will get mboxed */
497 FL
int c_stouch(void *v
);
499 /* Make sure all passed messages get mboxed */
500 FL
int c_mboxit(void *v
);
502 /* List the folders the user currently has */
503 FL
int c_folders(void *v
);
509 /* If any arguments were given, go to the next applicable argument following
510 * dot, otherwise, go to the next applicable message. If given as first
511 * command with no arguments, print first message */
512 FL
int c_next(void *v
);
514 /* Save a message in a file. Mark the message as saved so we can discard when
516 FL
int c_save(void *v
);
517 FL
int c_Save(void *v
);
519 /* Copy a message to a file without affected its saved-ness */
520 FL
int c_copy(void *v
);
521 FL
int c_Copy(void *v
);
523 /* Move a message to a file */
524 FL
int c_move(void *v
);
525 FL
int c_Move(void *v
);
527 /* Decrypt and copy a message to a file */
528 FL
int c_decrypt(void *v
);
529 FL
int c_Decrypt(void *v
);
531 /* Write the indicated messages at the end of the passed file name, minus
532 * header and trailing blank line. This is the MIME save function */
533 FL
int c_write(void *v
);
535 /* Delete messages */
536 FL
int c_delete(void *v
);
538 /* Delete messages, then type the new dot */
539 FL
int c_deltype(void *v
);
541 /* Undelete the indicated messages */
542 FL
int c_undelete(void *v
);
544 /* Add the given header fields to the retained list. If no arguments, print
545 * the current list of retained fields */
546 FL
int c_retfield(void *v
);
548 /* Add the given header fields to the ignored list. If no arguments, print the
549 * current list of ignored fields */
550 FL
int c_igfield(void *v
);
552 FL
int c_saveretfield(void *v
);
553 FL
int c_saveigfield(void *v
);
554 FL
int c_fwdretfield(void *v
);
555 FL
int c_fwdigfield(void *v
);
556 FL
int c_unignore(void *v
);
557 FL
int c_unretain(void *v
);
558 FL
int c_unsaveignore(void *v
);
559 FL
int c_unsaveretain(void *v
);
560 FL
int c_unfwdignore(void *v
);
561 FL
int c_unfwdretain(void *v
);
567 /* Process a shell escape by saving signals, ignoring signals and a sh -c */
568 FL
int c_shell(void *v
);
570 /* Fork an interactive shell */
571 FL
int c_dosh(void *v
);
573 /* Show the help screen */
574 FL
int c_help(void *v
);
576 /* Print user's working directory */
577 FL
int c_cwd(void *v
);
579 /* Change user's working directory */
580 FL
int c_chdir(void *v
);
582 FL
int c_respond(void *v
);
583 FL
int c_respondall(void *v
);
584 FL
int c_respondsender(void *v
);
585 FL
int c_Respond(void *v
);
586 FL
int c_followup(void *v
);
587 FL
int c_followupall(void *v
);
588 FL
int c_followupsender(void *v
);
589 FL
int c_Followup(void *v
);
591 /* The 'forward' command */
592 FL
int c_forward(void *v
);
594 /* Similar to forward, saving the message in a file named after the first
596 FL
int c_Forward(void *v
);
598 /* Resend a message list to a third person */
599 FL
int c_resend(void *v
);
601 /* Resend a message list to a third person without adding headers */
602 FL
int c_Resend(void *v
);
604 /* Preserve messages, so that they will be sent back to the system mailbox */
605 FL
int c_preserve(void *v
);
607 /* Mark all given messages as unread */
608 FL
int c_unread(void *v
);
610 /* Mark all given messages as read */
611 FL
int c_seen(void *v
);
613 /* Print the size of each message */
614 FL
int c_messize(void *v
);
616 /* Quit quickly. If sourcing, just pop the input level by returning error */
617 FL
int c_rexit(void *v
);
619 /* Without arguments print all groups, otherwise add users to a group */
620 FL
int c_group(void *v
);
622 /* Delete the passed groups */
623 FL
int c_ungroup(void *v
);
625 /* Change to another file. With no argument, print info about current file */
626 FL
int c_file(void *v
);
628 /* Expand file names like echo */
629 FL
int c_echo(void *v
);
631 /* if.elif.else.endif conditional execution.
632 * condstack_isskip() returns wether the current condition state doesn't allow
633 * execution of commands.
634 * condstack_release() and condstack_take() are used when sourcing files, they
635 * rotate the current condition stack; condstack_take() returns a false boolean
636 * if the current condition stack has unclosed conditionals */
637 FL
int c_if(void *v
);
638 FL
int c_elif(void *v
);
639 FL
int c_else(void *v
);
640 FL
int c_endif(void *v
);
641 FL bool_t
condstack_isskip(void);
642 FL
void * condstack_release(void);
643 FL bool_t
condstack_take(void *self
);
645 /* Set the list of alternate names */
646 FL
int c_alternates(void *v
);
648 /* 'newmail' command: Check for new mail without writing old mail back */
649 FL
int c_newmail(void *v
);
652 FL
int c_shortcut(void *v
);
653 FL
struct shortcut
*get_shortcut(char const *str
);
654 FL
int c_unshortcut(void *v
);
656 /* Message flag manipulation */
657 FL
int c_flag(void *v
);
658 FL
int c_unflag(void *v
);
659 FL
int c_answered(void *v
);
660 FL
int c_unanswered(void *v
);
661 FL
int c_draft(void *v
);
662 FL
int c_undraft(void *v
);
665 FL
int c_noop(void *v
);
668 FL
int c_remove(void *v
);
671 FL
int c_rename(void *v
);
673 /* `urlencode' and `urldecode' */
674 FL
int c_urlencode(void *v
);
675 FL
int c_urldecode(void *v
);
681 FL
FILE * collect(struct header
*hp
, int printheaders
, struct message
*mp
,
682 char *quotefile
, int doprefix
);
684 FL
void savedeadletter(FILE *fp
, int fflush_rewind_first
);
690 FL
int fcntl_lock(int fd
, enum flock_type ft
);
691 FL
int dot_lock(char const *fname
, int fd
, int pollinterval
, FILE *fp
,
693 FL
void dot_unlock(char const *fname
);
699 /* Edit a message list */
700 FL
int c_editor(void *v
);
702 /* Invoke the visual editor on a message list */
703 FL
int c_visual(void *v
);
705 /* Run an editor on the file at fp of size bytes, and return a new file.
706 * Signals must be handled by the caller. viored is 'e' for ed, 'v' for vi */
707 FL
FILE * run_editor(FILE *fp
, off_t size
, int viored
, int readonly
,
708 struct header
*hp
, struct message
*mp
,
709 enum sendaction action
, sighandler_type oldint
);
716 FL
struct quoteflt
* quoteflt_dummy(void); /* TODO LEGACY */
717 FL
void quoteflt_init(struct quoteflt
*self
, char const *prefix
);
718 FL
void quoteflt_destroy(struct quoteflt
*self
);
719 FL
void quoteflt_reset(struct quoteflt
*self
, FILE *f
);
720 FL ssize_t
quoteflt_push(struct quoteflt
*self
, char const *dat
,
722 FL ssize_t
quoteflt_flush(struct quoteflt
*self
);
728 /* fgets() replacement to handle lines of arbitrary size and with embedded \0
730 * line - line buffer. *line may be NULL.
731 * linesize - allocated size of line buffer.
732 * count - maximum characters to read. May be NULL.
733 * llen - length_of_line(*line).
735 * appendnl - always terminate line with \n, append if necessary.
737 FL
char * fgetline(char **line
, size_t *linesize
, size_t *count
,
738 size_t *llen
, FILE *fp
, int appendnl SMALLOC_DEBUG_ARGS
);
740 # define fgetline(A,B,C,D,E,F) \
741 fgetline(A, B, C, D, E, F, __FILE__, __LINE__)
744 /* Read up a line from the specified input into the linebuffer.
745 * Return the number of characters read. Do not include the newline at EOL.
746 * n is the number of characters already read */
747 FL
int readline_restart(FILE *ibuf
, char **linebuf
, size_t *linesize
,
748 size_t n SMALLOC_DEBUG_ARGS
);
750 # define readline_restart(A,B,C,D) \
751 readline_restart(A, B, C, D, __FILE__, __LINE__)
754 /* Read a complete line of input, with editing if interactive and possible.
755 * If prompt is NULL we'll call getprompt() first, if necessary.
756 * nl_escape defines wether user can escape newlines via backslash (POSIX).
757 * If string is set it is used as the initial line content if in interactive
758 * mode, otherwise this argument is ignored for reproducibility.
759 * Return number of octets or a value <0 on error */
760 FL
int readline_input(char const *prompt
, bool_t nl_escape
,
761 char **linebuf
, size_t *linesize
, char const *string
764 # define readline_input(A,B,C,D,E) readline_input(A,B,C,D,E,__FILE__,__LINE__)
767 /* Read a line of input, with editing if interactive and possible, return it
768 * savestr()d or NULL in case of errors or if an empty line would be returned.
769 * This may only be called from toplevel (not during sourcing).
770 * If prompt is NULL we'll call getprompt() if necessary.
771 * If string is set it is used as the initial line content if in interactive
772 * mode, otherwise this argument is ignored for reproducibility */
773 FL
char * readstr_input(char const *prompt
, char const *string
);
775 /* Set up the input pointers while copying the mail file into /tmp */
776 FL
void setptr(FILE *ibuf
, off_t offset
);
778 /* Drop the passed line onto the passed output buffer. If a write error occurs
779 * return -1, else the count of characters written, including the newline */
780 FL
int putline(FILE *obuf
, char *linebuf
, size_t count
);
782 /* Return a file buffer all ready to read up the passed message pointer */
783 FL
FILE * setinput(struct mailbox
*mp
, struct message
*m
,
786 /* Reset (free) the global message array */
787 FL
void message_reset(void);
789 /* Append the passed message descriptor onto the message array; if mp is NULL,
790 * NULLify the entry at &[msgCount-1] */
791 FL
void message_append(struct message
*mp
);
793 /* Check wether sep->ss_sexpr (or ->ss_reexpr) matches mp. If with_headers is
794 * true then the headers will also be searched (as plain text) */
795 FL bool_t
message_match(struct message
*mp
, struct search_expr
const *sep
,
796 bool_t with_headers
);
798 FL
struct message
* setdot(struct message
*mp
);
800 /* Delete a file, but only if the file is a plain file */
801 FL
int rm(char const *name
);
803 /* Determine the size of the file possessed by the passed buffer */
804 FL off_t
fsize(FILE *iob
);
806 /* Evaluate the string given as a new mailbox name. Supported meta characters:
807 * % for my system mail box
808 * %user for user's system mail box
809 * # for previous file
810 * & invoker's mbox file
811 * +file file in folder directory
812 * any shell meta character
813 * Returns the file name as an auto-reclaimed string */
814 FL
char * fexpand(char const *name
, enum fexp_mode fexpm
);
816 #define expand(N) fexpand(N, FEXP_FULL) /* XXX obsolete */
817 #define file_expand(N) fexpand(N, FEXP_LOCAL) /* XXX obsolete */
819 /* Get rid of queued mail */
820 FL
void demail(void);
822 /* acmava.c hook: *folder* variable has been updated; if folder shouldn't be
823 * replaced by something else leave store alone, otherwise smalloc() the
824 * desired value (ownership will be taken) */
825 FL bool_t
var_folder_updated(char const *folder
, char **store
);
827 /* Determine the current *folder* name, store it in *name* */
828 FL bool_t
getfold(char *name
, size_t size
);
830 /* Return the name of the dead.letter file */
831 FL
char const * getdeadletter(void);
833 FL
enum okay
get_body(struct message
*mp
);
837 FL bool_t
sopen(struct sock
*sp
, struct url
*urlp
);
838 FL
int sclose(struct sock
*sp
);
839 FL
enum okay
swrite(struct sock
*sp
, char const *data
);
840 FL
enum okay
swrite1(struct sock
*sp
, char const *data
, int sz
,
844 FL
int sgetline(char **line
, size_t *linesize
, size_t *linelen
,
845 struct sock
*sp SMALLOC_DEBUG_ARGS
);
847 # define sgetline(A,B,C,D) sgetline(A, B, C, D, __FILE__, __LINE__)
849 #endif /* HAVE_SOCKETS */
851 /* Deal with loading of resource files and dealing with a stack of files for
852 * the source command */
854 /* Load a file of user definitions */
855 FL
void load(char const *name
);
857 /* Pushdown current input file and switch to a new one. Set the global flag
858 * *sourcing* so that others will realize that they are no longer reading from
859 * a tty (in all probability) */
860 FL
int c_source(void *v
);
862 /* Pop the current input back to the previous level. Update the *sourcing*
863 * flag as appropriate */
864 FL
int unstack(void);
870 /* Return the user's From: address(es) */
871 FL
char const * myaddrs(struct header
*hp
);
873 /* Boil the user's From: addresses down to a single one, or use *sender* */
874 FL
char const * myorigin(struct header
*hp
);
876 /* See if the passed line buffer, which may include trailing newline (sequence)
877 * is a mail From_ header line according to RFC 4155 */
878 FL
int is_head(char const *linebuf
, size_t linelen
);
880 /* Savage extract date field from From_ line. linelen is convenience as line
881 * must be terminated (but it may end in a newline [sequence]).
882 * Return wether the From_ line was parsed successfully */
883 FL
int extract_date_from_from_(char const *line
, size_t linelen
,
884 char datebuf
[FROM_DATEBUF
]);
886 FL
void extract_header(FILE *fp
, struct header
*hp
);
888 /* Return the desired header line from the passed message
889 * pointer (or NULL if the desired header field is not available).
890 * If mult is zero, return the content of the first matching header
891 * field only, the content of all matching header fields else */
892 FL
char * hfield_mult(char const *field
, struct message
*mp
, int mult
);
893 #define hfieldX(a, b) hfield_mult(a, b, 1)
894 #define hfield1(a, b) hfield_mult(a, b, 0)
896 /* Check whether the passed line is a header line of the desired breed.
897 * Return the field body, or 0 */
898 FL
char const * thisfield(char const *linebuf
, char const *field
);
900 /* Get sender's name from this message. If the message has a bunch of arpanet
901 * stuff in it, we may have to skin the name before returning it */
902 FL
char * nameof(struct message
*mp
, int reptype
);
904 /* Start of a "comment". Ignore it */
905 FL
char const * skip_comment(char const *cp
);
907 /* Return the start of a route-addr (address in angle brackets), if present */
908 FL
char const * routeaddr(char const *name
);
910 /* Check if a name's address part contains invalid characters */
911 FL
int is_addr_invalid(struct name
*np
, int putmsg
);
913 /* Does *NP* point to a file or pipe addressee? */
914 #define is_fileorpipe_addr(NP) \
915 (((NP)->n_flags & NAME_ADDRSPEC_ISFILEORPIPE) != 0)
917 /* Return skinned version of *NP*s name */
918 #define skinned_name(NP) \
919 (assert((NP)->n_flags & NAME_SKINNED), \
920 ((struct name const*)NP)->n_name)
922 /* Skin an address according to the RFC 822 interpretation of "host-phrase" */
923 FL
char * skin(char const *name
);
925 /* Skin *name* and extract the *addr-spec* according to RFC 5322.
926 * Store the result in .ag_skinned and also fill in those .ag_ fields that have
927 * actually been seen.
928 * Return 0 if something good has been parsed, 1 if fun didn't exactly know how
929 * to deal with the input, or if that was plain invalid */
930 FL
int addrspec_with_guts(int doskin
, char const *name
,
931 struct addrguts
*agp
);
933 /* Fetch the real name from an internet mail address field */
934 FL
char * realname(char const *name
);
936 /* Fetch the sender's name from the passed message. reptype can be
937 * 0 -- get sender's name for display purposes
938 * 1 -- get sender's name for reply
939 * 2 -- get sender's name for Reply */
940 FL
char * name1(struct message
*mp
, int reptype
);
942 FL
int msgidcmp(char const *s1
, char const *s2
);
944 /* See if the given header field is supposed to be ignored */
945 FL
int is_ign(char const *field
, size_t fieldlen
,
946 struct ignoretab ignore
[2]);
948 FL
int member(char const *realfield
, struct ignoretab
*table
);
950 /* Fake Sender for From_ lines if missing, e. g. with POP3 */
951 FL
char const * fakefrom(struct message
*mp
);
953 FL
char const * fakedate(time_t t
);
955 /* From username Fri Jan 2 20:13:51 2004
958 #if defined HAVE_IMAP_SEARCH || defined HAVE_IMAP
959 FL
time_t unixtime(char const *from
);
962 FL
time_t rfctime(char const *date
);
964 FL
time_t combinetime(int year
, int month
, int day
,
965 int hour
, int minute
, int second
);
967 FL
void substdate(struct message
*m
);
969 FL
int check_from_and_sender(struct name
*fromfield
,
970 struct name
*senderfield
);
973 FL
char * getsender(struct message
*m
);
976 /* Fill in / reedit the desired header fields */
977 FL
int grab_headers(struct header
*hp
, enum gfield gflags
,
980 /* Check wether sep->ss_sexpr (or ->ss_reexpr) matches any header of mp */
981 FL bool_t
header_match(struct message
*mp
, struct search_expr
const *sep
);
988 FL
char const * imap_fileof(char const *xcp
);
989 FL
enum okay
imap_noop(void);
990 FL
enum okay
imap_select(struct mailbox
*mp
, off_t
*size
, int *count
,
992 FL
int imap_setfile(const char *xserver
, int nmail
, int isedit
);
993 FL
enum okay
imap_header(struct message
*m
);
994 FL
enum okay
imap_body(struct message
*m
);
995 FL
void imap_getheaders(int bot
, int top
);
996 FL
void imap_quit(void);
997 FL
enum okay
imap_undelete(struct message
*m
, int n
);
998 FL
enum okay
imap_unread(struct message
*m
, int n
);
999 FL
int c_imap_imap(void *vp
);
1000 FL
int imap_newmail(int nmail
);
1001 FL
enum okay
imap_append(const char *xserver
, FILE *fp
);
1002 FL
void imap_folders(const char *name
, int strip
);
1003 FL
enum okay
imap_copy(struct message
*m
, int n
, const char *name
);
1004 # ifdef HAVE_IMAP_SEARCH
1005 FL
enum okay
imap_search1(const char *spec
, int f
);
1007 FL
int imap_thisaccount(const char *cp
);
1008 FL
enum okay
imap_remove(const char *name
);
1009 FL
enum okay
imap_rename(const char *old
, const char *new);
1010 FL
enum okay
imap_dequeue(struct mailbox
*mp
, FILE *fp
);
1011 FL
int c_connect(void *vp
);
1012 FL
int c_disconnect(void *vp
);
1013 FL
int c_cache(void *vp
);
1014 FL
int disconnected(const char *file
);
1015 FL
void transflags(struct message
*omessage
, long omsgCount
,
1017 FL
time_t imap_read_date_time(const char *cp
);
1018 FL
const char * imap_make_date_time(time_t t
);
1020 # define c_imap_imap c_cmdnotsupp
1021 # define c_connect c_cmdnotsupp
1022 # define c_disconnect c_cmdnotsupp
1023 # define c_cache c_cmdnotsupp
1026 #if defined HAVE_IMAP || defined HAVE_IMAP_SEARCH
1027 FL
char * imap_quotestr(char const *s
);
1028 FL
char * imap_unquotestr(char const *s
);
1036 FL
enum okay
getcache1(struct mailbox
*mp
, struct message
*m
,
1037 enum needspec need
, int setflags
);
1038 FL
enum okay
getcache(struct mailbox
*mp
, struct message
*m
,
1039 enum needspec need
);
1040 FL
void putcache(struct mailbox
*mp
, struct message
*m
);
1041 FL
void initcache(struct mailbox
*mp
);
1042 FL
void purgecache(struct mailbox
*mp
, struct message
*m
, long mc
);
1043 FL
void delcache(struct mailbox
*mp
, struct message
*m
);
1044 FL
enum okay
cache_setptr(int transparent
);
1045 FL
enum okay
cache_list(struct mailbox
*mp
, char const *base
, int strip
,
1047 FL
enum okay
cache_remove(char const *name
);
1048 FL
enum okay
cache_rename(char const *old
, char const *new);
1049 FL
unsigned long cached_uidvalidity(struct mailbox
*mp
);
1050 FL
FILE * cache_queue(struct mailbox
*mp
);
1051 FL
enum okay
cache_dequeue(struct mailbox
*mp
);
1052 #endif /* HAVE_IMAP */
1058 #ifdef HAVE_IMAP_SEARCH
1059 FL
enum okay
imap_search(char const *spec
, int f
);
1066 /* Set up editing on the given file name.
1067 * If the first character of name is %, we are considered to be editing the
1068 * file, otherwise we are reading our mail which has signficance for mbox and
1069 * so forth. nmail: Check for new mail in the current folder only */
1070 FL
int setfile(char const *name
, int nmail
);
1072 FL
int newmailinfo(int omsgCount
);
1074 /* Interpret user commands. If standard input is not a tty, print no prompt */
1075 FL
void commands(void);
1077 /* Evaluate a single command.
1078 * .ev_add_history and .ev_new_content will be updated upon success.
1079 * Command functions return 0 for success, 1 for error, and -1 for abort.
1080 * 1 or -1 aborts a load or source, a -1 aborts the interactive command loop */
1081 FL
int evaluate(struct eval_ctx
*evp
);
1082 /* TODO drop execute() is the legacy version of evaluate().
1083 * Contxt is non-zero if called while composing mail */
1084 FL
int execute(char *linebuf
, int contxt
, size_t linesize
);
1086 /* Set the size of the message vector used to construct argument lists to
1087 * message list functions */
1088 FL
void setmsize(int sz
);
1090 /* Logic behind -H / -L invocations */
1091 FL
void print_header_summary(char const *Larg
);
1093 /* The following gets called on receipt of an interrupt. This is to abort
1094 * printout of a command, mainly. Dispatching here when command() is inactive
1095 * crashes rcv. Close all open files except 0, 1, 2, and the temporary. Also,
1096 * unstack all source files */
1097 FL
void onintr(int s
);
1099 /* Announce the presence of the current Mail version, give the message count,
1100 * and print a header listing */
1101 FL
void announce(int printheaders
);
1103 /* Announce information about the file we are editing. Return a likely place
1105 FL
int newfileinfo(void);
1107 FL
int getmdot(int nmail
);
1109 FL
void initbox(char const *name
);
1111 /* Print the docstring of `comm', which may be an abbreviation.
1112 * Return FAL0 if there is no such command */
1113 #ifdef HAVE_DOCSTRINGS
1114 FL bool_t
print_comm_docstr(char const *comm
);
1121 /* Convert user string of message numbers and store the numbers into vector.
1122 * Returns the count of messages picked up or -1 on error */
1123 FL
int getmsglist(char *buf
, int *vector
, int flags
);
1125 /* Scan out the list of string arguments, shell style for a RAWLIST */
1126 FL
int getrawlist(char const *line
, size_t linesize
,
1127 char **argv
, int argc
, int echolist
);
1129 /* Find the first message whose flags&m==f and return its message number */
1130 FL
int first(int f
, int m
);
1132 /* Mark the named message by setting its mark bit */
1133 FL
void mark(int mesg
, int f
);
1135 /* lzw.c TODO drop */
1137 FL
int zwrite(void *cookie
, const char *wbp
, int num
);
1138 FL
int zfree(void *cookie
);
1139 FL
int zread(void *cookie
, char *rbp
, int num
);
1140 FL
void * zalloc(FILE *fp
);
1141 #endif /* HAVE_IMAP */
1147 FL
int maildir_setfile(char const *name
, int nmail
, int isedit
);
1149 FL
void maildir_quit(void);
1151 FL
enum okay
maildir_append(char const *name
, FILE *fp
);
1153 FL
enum okay
maildir_remove(char const *name
);
1159 /* *charset-7bit*, else CHARSET_7BIT */
1160 FL
char const * charset_get_7bit(void);
1162 /* *charset-8bit*, else CHARSET_8BIT */
1164 FL
char const * charset_get_8bit(void);
1167 /* LC_CTYPE:CODESET / *ttycharset*, else *charset-8bit*, else CHARSET_8BIT */
1168 FL
char const * charset_get_lc(void);
1170 /* *sendcharsets* .. *charset-8bit* iterator; *a_charset_to_try_first* may be
1171 * used to prepend a charset to this list (e.g., for *reply-in-same-charset*).
1172 * The returned boolean indicates charset_iter_is_valid().
1173 * Without HAVE_ICONV, this "iterates" over charset_get_lc() only */
1174 FL bool_t
charset_iter_reset(char const *a_charset_to_try_first
);
1175 FL bool_t
charset_iter_next(void);
1176 FL bool_t
charset_iter_is_valid(void);
1177 FL
char const * charset_iter(void);
1179 FL
void charset_iter_recurse(char *outer_storage
[2]); /* TODO LEGACY */
1180 FL
void charset_iter_restore(char *outer_storage
[2]); /* TODO LEGACY */
1183 FL
char const * need_hdrconv(struct header
*hp
, enum gfield w
);
1186 /* Get the mime encoding from a Content-Transfer-Encoding header field */
1187 FL
enum mimeenc
mime_getenc(char *h
);
1189 /* Get a mime style parameter from a header line */
1190 FL
char * mime_getparam(char const *param
, char *h
);
1192 /* Get the boundary out of a Content-Type: multipart/xyz header field, return
1193 * salloc()ed copy of it; store strlen() in *len if set */
1194 FL
char * mime_get_boundary(char *h
, size_t *len
);
1196 /* Create a salloc()ed MIME boundary */
1197 FL
char * mime_create_boundary(void);
1199 /* Classify content of *fp* as necessary and fill in arguments; **charset* is
1200 * left alone unless it's non-NULL */
1201 FL
int mime_classify_file(FILE *fp
, char const **contenttype
,
1202 char const **charset
, int *do_iconv
);
1205 FL
enum mimecontent
mime_classify_content_of_part(struct mimepart
const *mip
);
1207 /* Return the Content-Type matching the extension of name */
1208 FL
char * mime_classify_content_type_by_fileext(char const *name
);
1210 /* "mimetypes" command */
1211 FL
int c_mimetypes(void *v
);
1213 /* Convert header fields from RFC 1522 format */
1214 FL
void mime_fromhdr(struct str
const *in
, struct str
*out
,
1215 enum tdflags flags
);
1217 /* Interpret MIME strings in parts of an address field */
1218 FL
char * mime_fromaddr(char const *name
);
1220 /* fwrite(3) performing the given MIME conversion */
1221 FL ssize_t
mime_write(char const *ptr
, size_t size
, FILE *f
,
1222 enum conversion convert
, enum tdflags dflags
,
1223 struct quoteflt
*qf
, struct str
*rest
);
1224 FL ssize_t
xmime_write(char const *ptr
, size_t size
, /* TODO LEGACY */
1225 FILE *f
, enum conversion convert
, enum tdflags dflags
,
1230 * Content-Transfer-Encodings as defined in RFC 2045:
1231 * - Quoted-Printable, section 6.7
1232 * - Base64, section 6.8
1235 /* How many characters of (the complete body) ln need to be quoted */
1236 FL
size_t mime_cte_mustquote(char const *ln
, size_t lnlen
, bool_t ishead
);
1238 /* How much space is necessary to encode len bytes in QP, worst case.
1239 * Includes room for terminator */
1240 FL
size_t qp_encode_calc_size(size_t len
);
1242 /* If flags includes QP_ISHEAD these assume "word" input and use special
1243 * quoting rules in addition; soft line breaks are not generated.
1244 * Otherwise complete input lines are assumed and soft line breaks are
1245 * generated as necessary */
1246 FL
struct str
* qp_encode(struct str
*out
, struct str
const *in
,
1247 enum qpflags flags
);
1249 FL
struct str
* qp_encode_cp(struct str
*out
, char const *cp
,
1250 enum qpflags flags
);
1251 FL
struct str
* qp_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
1252 enum qpflags flags
);
1255 /* If rest is set then decoding will assume body text input (assumes input
1256 * represents lines, only create output when input didn't end with soft line
1257 * break [except it finalizes an encoded CRLF pair]), otherwise it is assumed
1258 * to decode a header strings and (1) uses special decoding rules and (b)
1259 * directly produces output.
1260 * The buffers of out and possibly rest will be managed via srealloc().
1261 * Returns OKAY. XXX or STOP on error (in which case out is set to an error
1262 * XXX message); caller is responsible to free buffers */
1263 FL
int qp_decode(struct str
*out
, struct str
const *in
,
1266 /* How much space is necessary to encode len bytes in Base64, worst case.
1267 * Includes room for (CR/LF/CRLF and) terminator */
1268 FL
size_t b64_encode_calc_size(size_t len
);
1270 /* Note these simply convert all the input (if possible), including the
1271 * insertion of NL sequences if B64_CRLF or B64_LF is set (and multiple thereof
1272 * if B64_MULTILINE is set).
1273 * Thus, in the B64_BUF case, better call b64_encode_calc_size() first */
1274 FL
struct str
* b64_encode(struct str
*out
, struct str
const *in
,
1275 enum b64flags flags
);
1276 FL
struct str
* b64_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
1277 enum b64flags flags
);
1279 FL
struct str
* b64_encode_cp(struct str
*out
, char const *cp
,
1280 enum b64flags flags
);
1283 /* If rest is set then decoding will assume text input.
1284 * The buffers of out and possibly rest will be managed via srealloc().
1285 * Returns OKAY or STOP on error (in which case out is set to an error
1286 * message); caller is responsible to free buffers */
1287 FL
int b64_decode(struct str
*out
, struct str
const *in
,
1294 /* Allocate a single element of a name list, initialize its name field to the
1295 * passed name and return it */
1296 FL
struct name
* nalloc(char *str
, enum gfield ntype
);
1298 /* Like nalloc(), but initialize from content of np */
1299 FL
struct name
* ndup(struct name
*np
, enum gfield ntype
);
1301 /* Concatenate the two passed name lists, return the result */
1302 FL
struct name
* cat(struct name
*n1
, struct name
*n2
);
1304 /* Determine the number of undeleted elements in a name list and return it;
1305 * the latter also doesn't count file and pipe addressees in addition */
1306 FL ui32_t
count(struct name
const *np
);
1307 FL ui32_t
count_nonlocal(struct name
const *np
);
1309 /* Extract a list of names from a line, and make a list of names from it.
1310 * Return the list or NULL if none found */
1311 FL
struct name
* extract(char const *line
, enum gfield ntype
);
1313 /* Like extract() unless line contains anyof ",\"\\(<|", in which case
1314 * comma-separated list extraction is used instead */
1315 FL
struct name
* lextract(char const *line
, enum gfield ntype
);
1317 /* Turn a list of names into a string of the same names */
1318 FL
char * detract(struct name
*np
, enum gfield ntype
);
1320 /* Get a lextract() list via readstr_input(), reassigning to *np* */
1321 FL
struct name
* grab_names(char const *field
, struct name
*np
, int comma
,
1322 enum gfield gflags
);
1324 /* Check all addresses in np and delete invalid ones */
1325 FL
struct name
* checkaddrs(struct name
*np
);
1327 /* Map all of the aliased users in the invoker's mailrc file and insert them
1329 FL
struct name
* usermap(struct name
*names
, bool_t force_metoo
);
1331 /* Remove all of the duplicates from the passed name list by insertion sorting
1332 * them, then checking for dups. Return the head of the new list */
1333 FL
struct name
* elide(struct name
*names
);
1335 FL
struct name
* delete_alternates(struct name
*np
);
1337 FL
int is_myname(char const *name
);
1339 /* Dispatch a message to all pipe and file addresses TODO -> sendout.c */
1340 FL
struct name
* outof(struct name
*names
, FILE *fo
, bool_t
*senderror
);
1342 /* Handling of alias groups */
1344 /* Locate a group name and return it */
1345 FL
struct grouphead
* findgroup(char *name
);
1347 /* Print a group out on stdout */
1348 FL
void printgroup(char *name
);
1350 FL
void remove_group(char const *name
);
1358 FL
enum okay
ssl_open(char const *server
, struct sock
*sp
, char const *uhp
);
1361 FL
void ssl_gen_err(char const *fmt
, ...);
1364 FL
int c_verify(void *vp
);
1367 FL
FILE * smime_sign(FILE *ip
, char const *addr
);
1370 FL
FILE * smime_encrypt(FILE *ip
, char const *certfile
, char const *to
);
1372 FL
struct message
* smime_decrypt(struct message
*m
, char const *to
,
1373 char const *cc
, int signcall
);
1376 FL
enum okay
smime_certsave(struct message
*m
, int n
, FILE *op
);
1378 #else /* HAVE_OPENSSL */
1379 # define c_verify c_cmdnotsupp
1388 FL
enum okay
pop3_noop(void);
1391 FL
int pop3_setfile(char const *server
, int nmail
, int isedit
);
1394 FL
enum okay
pop3_header(struct message
*m
);
1397 FL
enum okay
pop3_body(struct message
*m
);
1400 FL
void pop3_quit(void);
1401 #endif /* HAVE_POP3 */
1405 * Subprocesses, popen, but also file handling with registering
1408 /* For program startup in main.c: initialize process manager */
1409 FL
void command_manager_start(void);
1411 /* Notes: OF_CLOEXEC is implied in oflags, xflags may be NULL */
1412 FL
FILE * safe_fopen(char const *file
, char const *oflags
, int *xflags
);
1414 /* Notes: OF_CLOEXEC|OF_REGISTER are implied in oflags */
1415 FL
FILE * Fopen(char const *file
, char const *oflags
);
1417 FL
FILE * Fdopen(int fd
, char const *oflags
);
1419 FL
int Fclose(FILE *fp
);
1421 FL
FILE * Zopen(char const *file
, char const *oflags
, int *compression
);
1423 /* Create a temporary file in tempdir, use prefix for its name, store the
1424 * unique name in fn (unless OF_UNLINK is set in oflags), and return a stdio
1425 * FILE pointer with access oflags. OF_CLOEXEC is implied in oflags.
1426 * mode specifies the access mode of the newly created temporary file */
1427 FL
FILE * Ftmp(char **fn
, char const *prefix
, enum oflags oflags
,
1430 /* If OF_HOLDSIGS was set when calling Ftmp(), then hold_all_sigs() had been
1431 * called: call this to unlink(2) and free *fn and to rele_all_sigs() */
1432 FL
void Ftmp_release(char **fn
);
1434 /* Free the resources associated with the given filename. To be called after
1436 FL
void Ftmp_free(char **fn
);
1438 /* Create a pipe and ensure CLOEXEC bit is set in both descriptors */
1439 FL bool_t
pipe_cloexec(int fd
[2]);
1441 FL
FILE * Popen(char const *cmd
, char const *mode
, char const *shell
,
1442 char const *env_addon
, int newfd1
);
1444 FL bool_t
Pclose(FILE *ptr
, bool_t dowait
);
1446 FL
void close_all_files(void);
1448 /* Run a command without a shell, with optional arguments and splicing of stdin
1449 * and stdout. The command name can be a sequence of words. Signals must be
1450 * handled by the caller. "Mask" contains the signals to ignore in the new
1451 * process. SIGINT is enabled unless it's in the mask */
1452 FL
int run_command(char const *cmd
, sigset_t
*mask
, int infd
,
1453 int outfd
, char const *a0
, char const *a1
, char const *a2
);
1455 FL
int start_command(char const *cmd
, sigset_t
*mask
, int infd
,
1456 int outfd
, char const *a0
, char const *a1
, char const *a2
,
1457 char const *env_addon
);
1459 FL
void prepare_child(sigset_t
*nset
, int infd
, int outfd
);
1461 /* Mark a child as don't care */
1462 FL
void free_child(int pid
);
1464 /* Wait for pid, return wether we've had a normal EXIT_SUCCESS exit.
1465 * If wait_status is set, set it to the reported waitpid(2) wait status */
1466 FL bool_t
wait_child(int pid
, int *wait_status
);
1472 /* The `quit' command */
1473 FL
int c_quit(void *v
);
1475 /* Save all of the undetermined messages at the top of "mbox". Save all
1476 * untouched messages back in the system mailbox. Remove the system mailbox,
1477 * if none saved there */
1480 /* Adjust the message flags in each message */
1481 FL
int holdbits(void);
1483 /* Create another temporary file and copy user's mbox file darin. If there is
1484 * no mbox, copy nothing. If he has specified "append" don't copy his mailbox,
1485 * just copy saveable entries at the end */
1486 FL
enum okay
makembox(void);
1488 FL
void save_mbox_for_possible_quitstuff(void); /* TODO DROP IF U CAN */
1490 FL
int savequitflags(void);
1492 FL
void restorequitflags(int);
1498 /* Send message described by the passed pointer to the passed output buffer.
1499 * Return -1 on error. Adjust the status: field if need be. If doign is
1500 * given, suppress ignored header fields. prefix is a string to prepend to
1501 * each output line. action = data destination
1502 * (SEND_MBOX,_TOFILE,_TODISP,_QUOTE,_DECRYPT). stats[0] is line count,
1503 * stats[1] is character count. stats may be NULL. Note that stats[0] is
1504 * valid for SEND_MBOX only */
1505 FL
int sendmp(struct message
*mp
, FILE *obuf
, struct ignoretab
*doign
,
1506 char const *prefix
, enum sendaction action
, off_t
*stats
);
1512 /* Interface between the argument list and the mail1 routine which does all the
1514 FL
int mail(struct name
*to
, struct name
*cc
, struct name
*bcc
,
1515 char *subject
, struct attachment
*attach
, char *quotefile
,
1516 int recipient_record
);
1518 /* `mail' and `Mail' commands, respectively */
1519 FL
int c_sendmail(void *v
);
1520 FL
int c_Sendmail(void *v
);
1522 /* Mail a message on standard input to the people indicated in the passed
1523 * header. (Internal interface) */
1524 FL
enum okay
mail1(struct header
*hp
, int printheaders
,
1525 struct message
*quote
, char *quotefile
, int recipient_record
,
1528 /* Create a Date: header field.
1529 * We compare the localtime() and gmtime() results to get the timezone, because
1530 * numeric timezones are easier to read and because $TZ isn't always set */
1531 FL
int mkdate(FILE *fo
, char const *field
);
1533 /* Dump the to, subject, cc header on the passed file buffer */
1534 FL
int puthead(struct header
*hp
, FILE *fo
, enum gfield w
,
1535 enum sendaction action
, enum conversion convert
,
1536 char const *contenttype
, char const *charset
);
1539 FL
enum okay
resend_msg(struct message
*mp
, struct name
*to
, int add_resent
);
1546 /* Send a message via SMTP */
1547 FL bool_t
smtp_mta(struct sendbundle
*sbp
);
1555 /* Direct mappings of the various spam* commands */
1556 FL
int c_spam_clear(void *v
);
1557 FL
int c_spam_set(void *v
);
1558 FL
int c_spam_forget(void *v
);
1559 FL
int c_spam_ham(void *v
);
1560 FL
int c_spam_rate(void *v
);
1561 FL
int c_spam_spam(void *v
);
1563 # define c_spam_clear c_cmdnotsupp
1564 # define c_spam_set c_cmdnotsupp
1565 # define c_spam_forget c_cmdnotsupp
1566 # define c_spam_ham c_cmdnotsupp
1567 # define c_spam_rate c_cmdnotsupp
1568 # define c_spam_spam c_cmdnotsupp
1577 FL
void ssl_set_verify_level(char const *uhp
);
1580 FL
enum okay
ssl_verify_decide(void);
1583 FL
char * ssl_method_string(char const *uhp
);
1586 FL
enum okay
smime_split(FILE *ip
, FILE **hp
, FILE **bp
, long xcount
,
1590 FL
FILE * smime_sign_assemble(FILE *hp
, FILE *bp
, FILE *sp
);
1593 FL
FILE * smime_encrypt_assemble(FILE *hp
, FILE *yp
);
1596 FL
struct message
* smime_decrypt_assemble(struct message
*m
, FILE *hp
,
1600 FL
int c_certsave(void *v
);
1603 FL
enum okay
rfc2595_hostname_match(char const *host
, char const *pattern
);
1604 #else /* HAVE_SSL */
1605 # define c_certsave c_cmdnotsupp
1610 * This bundles several different string related support facilities:
1611 * - auto-reclaimed string storage (memory goes away on command loop ticks)
1612 * - plain char* support functions which use unspecified or smalloc() memory
1613 * - struct str related support funs
1614 * - our iconv(3) wrapper
1617 /* Auto-reclaimed string storage */
1620 # define SALLOC_DEBUG_ARGS , char const *mdbg_file, int mdbg_line
1621 # define SALLOC_DEBUG_ARGSCALL , mdbg_file, mdbg_line
1623 # define SALLOC_DEBUG_ARGS
1624 # define SALLOC_DEBUG_ARGSCALL
1627 /* Allocate size more bytes of space and return the address of the first byte
1628 * to the caller. An even number of bytes are always allocated so that the
1629 * space will always be on a word boundary */
1630 FL
void * salloc(size_t size SALLOC_DEBUG_ARGS
);
1631 FL
void * csalloc(size_t nmemb
, size_t size SALLOC_DEBUG_ARGS
);
1633 # define salloc(SZ) salloc(SZ, __FILE__, __LINE__)
1634 # define csalloc(NM,SZ) csalloc(NM, SZ, __FILE__, __LINE__)
1637 /* Auto-reclaim string storage; if only_if_relaxed is true then only perform
1638 * the reset when a srelax_hold() is currently active */
1639 FL
void sreset(bool_t only_if_relaxed
);
1641 /* The "problem" with sreset() is that it releases all string storage except
1642 * what was present once spreserve() had been called; it therefore cannot be
1643 * called from all that code which yet exists and walks about all the messages
1644 * in order, e.g. quit(), searches, etc., because, unfortunately, these code
1645 * paths are reached with new intermediate string dope already in use.
1646 * Thus such code should take a srelax_hold(), successively call srelax() after
1647 * a single message has been handled, and finally srelax_rele() (unless it is
1648 * clear that sreset() occurs anyway) */
1649 FL
void srelax_hold(void);
1650 FL
void srelax_rele(void);
1651 FL
void srelax(void);
1653 /* Make current string storage permanent: new allocs will be auto-reclaimed by
1654 * sreset(). This is called once only, from within main() */
1655 FL
void spreserve(void);
1657 /* 'sstats' command */
1659 FL
int c_sstats(void *v
);
1662 /* Return a pointer to a dynamic copy of the argument */
1663 FL
char * savestr(char const *str SALLOC_DEBUG_ARGS
);
1664 FL
char * savestrbuf(char const *sbuf
, size_t sbuf_len SALLOC_DEBUG_ARGS
);
1666 # define savestr(CP) savestr(CP, __FILE__, __LINE__)
1667 # define savestrbuf(CBP,CBL) savestrbuf(CBP, CBL, __FILE__, __LINE__)
1670 /* Make copy of argument incorporating old one, if set, separated by space */
1671 FL
char * save2str(char const *str
, char const *old SALLOC_DEBUG_ARGS
);
1673 # define save2str(S,O) save2str(S, O, __FILE__, __LINE__)
1677 FL
char * savecat(char const *s1
, char const *s2 SALLOC_DEBUG_ARGS
);
1679 # define savecat(S1,S2) savecat(S1, S2, __FILE__, __LINE__)
1682 /* Create duplicate, lowercasing all characters along the way */
1683 FL
char * i_strdup(char const *src SALLOC_DEBUG_ARGS
);
1685 # define i_strdup(CP) i_strdup(CP, __FILE__, __LINE__)
1688 /* Extract the protocol base and return a duplicate */
1689 FL
char * protbase(char const *cp SALLOC_DEBUG_ARGS
);
1691 # define protbase(CP) protbase(CP, __FILE__, __LINE__)
1694 /* URL en- and decoding (RFC 1738, but not really) */
1695 FL
char * urlxenc(char const *cp
, bool_t ispath SALLOC_DEBUG_ARGS
);
1696 FL
char * urlxdec(char const *cp SALLOC_DEBUG_ARGS
);
1698 # define urlxenc(CP,P) urlxenc(CP, P, __FILE__, __LINE__)
1699 # define urlxdec(CP) urlxdec(CP, __FILE__, __LINE__)
1703 FL
struct str
* str_concat_csvl(struct str
*self
, ...);
1706 FL
struct str
* str_concat_cpa(struct str
*self
, char const * const *cpa
,
1707 char const *sep_o_null SALLOC_DEBUG_ARGS
);
1709 # define str_concat_cpa(S,A,N) str_concat_cpa(S, A, N, __FILE__, __LINE__)
1713 /* Plain char* support, not auto-reclaimed (unless noted) */
1715 /* Are any of the characters in the two strings the same? */
1716 FL
int anyof(char const *s1
, char const *s2
);
1718 /* Treat *iolist as a sep separated list of strings; find and return the
1719 * next entry, trimming surrounding whitespace, and point *iolist to the next
1720 * entry or to NULL if no more entries are contained. If ignore_empty is not
1721 * set empty entries are started over. Return NULL or an entry */
1722 FL
char * n_strsep(char **iolist
, char sep
, bool_t ignore_empty
);
1724 /* Copy a string, lowercasing it as we go; *size* is buffer size of *dest*;
1725 * *dest* will always be terminated unless *size* is 0 */
1726 FL
void i_strcpy(char *dest
, char const *src
, size_t size
);
1728 /* Is *as1* a valid prefix of *as2*? */
1729 FL
int is_prefix(char const *as1
, char const *as2
);
1731 /* Find the last AT @ before the first slash */
1732 FL
char const * last_at_before_slash(char const *sp
);
1734 /* Get (and isolate) the last, possibly quoted part of linebuf, set *needs_list
1735 * to indicate wether getmsglist() et al need to be called to collect
1736 * additional args that remain in linebuf. Return NULL on "error" */
1737 FL
char * laststring(char *linebuf
, bool_t
*needs_list
, bool_t strip
);
1739 /* Convert a string to lowercase, in-place and with multibyte-aware */
1740 FL
void makelow(char *cp
);
1742 /* Is *sub* a substring of *str*, case-insensitive and multibyte-aware? */
1743 FL bool_t
substr(char const *str
, char const *sub
);
1745 /* Lazy vsprintf wrapper */
1746 #ifndef HAVE_SNPRINTF
1747 FL
int snprintf(char *str
, size_t size
, char const *format
, ...);
1750 FL
char * sstpcpy(char *dst
, char const *src
);
1751 FL
char * sstrdup(char const *cp SMALLOC_DEBUG_ARGS
);
1752 FL
char * sbufdup(char const *cp
, size_t len SMALLOC_DEBUG_ARGS
);
1754 # define sstrdup(CP) sstrdup(CP, __FILE__, __LINE__)
1755 # define sbufdup(CP,L) sbufdup(CP, L, __FILE__, __LINE__)
1758 FL
char * n_strlcpy(char *dst
, char const *src
, size_t len
);
1760 /* Locale-independent character class functions */
1761 FL
int asccasecmp(char const *s1
, char const *s2
);
1762 FL
int ascncasecmp(char const *s1
, char const *s2
, size_t sz
);
1763 FL bool_t
is_asccaseprefix(char const *as1
, char const *as2
);
1765 FL
char const * asccasestr(char const *haystack
, char const *xneedle
);
1768 /* struct str related support funs */
1770 /* *self->s* is srealloc()ed */
1771 FL
struct str
* n_str_dup(struct str
*self
, struct str
const *t
1772 SMALLOC_DEBUG_ARGS
);
1774 /* *self->s* is srealloc()ed, *self->l* incremented */
1775 FL
struct str
* n_str_add_buf(struct str
*self
, char const *buf
, size_t buflen
1776 SMALLOC_DEBUG_ARGS
);
1777 #define n_str_add(S, T) n_str_add_buf(S, (T)->s, (T)->l)
1778 #define n_str_add_cp(S, CP) n_str_add_buf(S, CP, (CP) ? strlen(CP) : 0)
1781 # define n_str_dup(S,T) n_str_dup(S, T, __FILE__, __LINE__)
1782 # define n_str_add_buf(S,B,BL) n_str_add_buf(S, B, BL, __FILE__, __LINE__)
1785 /* Our iconv(3) wrappers */
1788 FL iconv_t
n_iconv_open(char const *tocode
, char const *fromcode
);
1789 /* If *cd* == *iconvd*, assigns -1 to the latter */
1790 FL
void n_iconv_close(iconv_t cd
);
1792 /* Reset encoding state */
1794 FL
void n_iconv_reset(iconv_t cd
);
1797 /* iconv(3), but return *errno* or 0; *skipilseq* forces step over invalid byte
1798 * sequences; likewise iconv_str(), but which auto-grows on E2BIG errors; *in*
1799 * and *in_rest_or_null* may be the same object.
1800 * Note: EINVAL (incomplete sequence at end of input) is NOT handled, so the
1801 * replacement character must be added manually if that happens at EOF! */
1802 FL
int n_iconv_buf(iconv_t cd
, char const **inb
, size_t *inbleft
,
1803 char **outb
, size_t *outbleft
, bool_t skipilseq
);
1804 FL
int n_iconv_str(iconv_t icp
, struct str
*out
, struct str
const *in
,
1805 struct str
*in_rest_or_null
, bool_t skipilseq
);
1813 FL
int c_thread(void *vp
);
1816 FL
int c_unthread(void *vp
);
1819 FL
struct message
* next_in_thread(struct message
*mp
);
1820 FL
struct message
* prev_in_thread(struct message
*mp
);
1821 FL
struct message
* this_in_thread(struct message
*mp
, long n
);
1823 /* Sorted mode is internally just a variant of threaded mode with all m_parent
1824 * and m_child links being NULL */
1825 FL
int c_sort(void *vp
);
1828 FL
int c_collapse(void *v
);
1829 FL
int c_uncollapse(void *v
);
1832 FL
void uncollapse1(struct message
*mp
, int always
);
1838 /* Return wether user says yes. If prompt is NULL, "Continue (y/n)? " is used
1839 * instead. If interactive, asks on STDIN, anything but [0]==[Nn] is true.
1840 * If noninteractive, returns noninteract_default. Handles+reraises SIGINT */
1841 FL bool_t
getapproval(char const *prompt
, bool_t noninteract_default
);
1843 /* Get a password the expected way, return termios_state.ts_linebuf on
1844 * success or NULL on error */
1845 FL
char * getuser(char const *query
);
1847 /* Get a password the expected way, return termios_state.ts_linebuf on
1848 * success or NULL on error. SIGINT is temporarily blocked, *not* reraised.
1849 * termios_state_reset() (def.h) must be called anyway */
1850 FL
char * getpassword(char const *query
);
1852 /* Overall interactive terminal life cycle for command line editor library */
1853 #if defined HAVE_EDITLINE || defined HAVE_READLINE
1854 # define TTY_WANTS_SIGWINCH
1856 FL
void tty_init(void);
1857 FL
void tty_destroy(void);
1859 /* Rather for main.c / SIGWINCH interaction only */
1860 FL
void tty_signal(int sig
);
1862 /* Read a line after printing prompt (if set and non-empty).
1863 * If n>0 assumes that *linebuf has n bytes of default content */
1864 FL
int tty_readline(char const *prompt
, char **linebuf
,
1865 size_t *linesize
, size_t n SMALLOC_DEBUG_ARGS
);
1867 # define tty_readline(A,B,C,D) tty_readline(A, B, C, D, __FILE__, __LINE__)
1870 /* Add a line (most likely as returned by tty_readline()) to the history.
1871 * Wether an entry added for real depends on the isgabby / *history-gabby*
1872 * relation, and / or wether s is non-empty and doesn't begin with U+0020 */
1873 FL
void tty_addhist(char const *s
, bool_t isgabby
);
1875 #if defined HAVE_HISTORY &&\
1876 (defined HAVE_READLINE || defined HAVE_EDITLINE || defined HAVE_NCL)
1877 FL
int c_history(void *v
);
1880 #ifndef HAVE_AMALGAMATION
1885 /* vim:set fenc=utf-8:s-it-mode */