1 /*@ S-nail - a mail user agent derived from Berkeley Mail.
2 *@ Exported function prototypes.
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
57 /* Don't use _var_* unless you *really* have to! */
59 /* Constant option key look/(un)set/clear */
60 FL
char * _var_oklook(enum okeys okey
);
61 #define ok_blook(C) (_var_oklook(CONCAT(ok_b_, C)) != NULL)
62 #define ok_vlook(C) _var_oklook(CONCAT(ok_v_, C))
64 FL bool_t
_var_okset(enum okeys okey
, uintptr_t val
);
65 #define ok_bset(C,B) _var_okset(CONCAT(ok_b_, C), (uintptr_t)(B))
66 #define ok_vset(C,V) _var_okset(CONCAT(ok_v_, C), (uintptr_t)(V))
68 FL bool_t
_var_okclear(enum okeys okey
);
69 #define ok_bclear(C) _var_okclear(CONCAT(ok_b_, C))
70 #define ok_vclear(C) _var_okclear(CONCAT(ok_v_, C))
72 /* Variable option key look/(un)set/clear */
73 FL
char * _var_voklook(char const *vokey
);
74 #define vok_blook(S) (_var_voklook(S) != NULL)
75 #define vok_vlook(S) _var_voklook(S)
77 FL bool_t
_var_vokset(char const *vokey
, uintptr_t val
);
78 #define vok_bset(S,B) _var_vokset(S, (uintptr_t)(B))
79 #define vok_vset(S,V) _var_vokset(S, (uintptr_t)(V))
81 FL bool_t
_var_vokclear(char const *vokey
);
82 #define vok_bclear(S) _var_vokclear(S)
83 #define vok_vclear(S) _var_vokclear(S)
85 /* List all variables */
86 FL
void var_list_all(void);
88 FL
int c_var_inspect(void *v
);
89 FL
int c_define(void *v
);
90 FL
int c_undef(void *v
);
91 FL
int c_call(void *v
);
93 FL
int callhook(char const *name
, int nmail
);
96 FL
int c_defines(void *v
);
99 FL
int c_account(void *v
);
102 FL
int c_localopts(void *v
);
104 FL
void temporary_localopts_free(void); /* XXX intermediate hack */
110 /* Try to add an attachment for *file*, file_expand()ed.
111 * Return the new head of list *aphead*, or NULL.
112 * The newly created attachment will be stored in **newap*, if given */
113 FL
struct attachment
* add_attachment(struct attachment
*aphead
, char *file
,
114 struct attachment
**newap
);
116 /* Append comma-separated list of file names to the end of attachment list */
117 FL
struct attachment
* append_attachments(struct attachment
*aphead
,
120 /* Interactively edit the attachment list, return the new list head */
121 FL
struct attachment
* edit_attachments(struct attachment
*aphead
);
127 /* Announce a fatal error (and die) */
128 FL
void panic(char const *format
, ...);
129 FL
void alert(char const *format
, ...);
131 /* Provide BSD-like signal() on all (POSIX) systems */
132 FL sighandler_type
safe_signal(int signum
, sighandler_type handler
);
134 /* Hold *all* signals but SIGCHLD, and release that total block again */
135 FL
void hold_all_sigs(void);
136 FL
void rele_all_sigs(void);
138 /* Hold HUP/QUIT/INT */
139 FL
void hold_sigs(void);
140 FL
void rele_sigs(void);
142 /* Not-Yet-Dead debug information (handler installation in main.c) */
144 FL
void _nyd_chirp(ui8_t act
, char const *file
, ui32_t line
,
146 FL
void _nyd_oncrash(int signo
);
148 # define NYD_ENTER _nyd_chirp(1, __FILE__, __LINE__, __FUN__)
149 # define NYD_LEAVE _nyd_chirp(2, __FILE__, __LINE__, __FUN__)
150 # define NYD _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
151 # define NYD_X _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
153 # define NYD_ENTER do {} while (0)
154 # define NYD_LEAVE do {} while (0)
155 # define NYD do {} while (0)
156 # define NYD_X do {} while (0) /* XXX LEGACY */
159 /* Touch the named message by setting its MTOUCH flag. Touched messages have
160 * the effect of not being sent back to the system mailbox on exit */
161 FL
void touch(struct message
*mp
);
163 /* Test to see if the passed file name is a directory, return true if it is */
164 FL bool_t
is_dir(char const *name
);
166 /* Count the number of arguments in the given string raw list */
167 FL
int argcount(char **argv
);
169 /* Compute screen size */
170 FL
int screensize(void);
173 FL
char const *get_pager(void);
175 /* Check wether using a pager is possible/makes sense and is desired by user
176 * (*crt* set); return number of screen lines (or *crt*) if so, 0 otherwise */
177 FL
size_t paging_seems_sensible(void);
179 /* Use a pager or STDOUT to print *fp*; if *lines* is 0, they'll be counted */
180 FL
void page_or_print(FILE *fp
, size_t lines
);
181 #define try_pager(FP) page_or_print(FP, 0) /* TODO obsolete */
183 /* Parse name and guess at the required protocol */
184 FL
enum protocol
which_protocol(char const *name
);
186 /* Hash the passed string -- uses Chris Torek's hash algorithm */
187 FL ui32_t
torek_hash(char const *name
);
188 #define hash(S) (torek_hash(S) % HSHSIZE) /* xxx COMPAT (?) */
191 FL ui32_t
pjw(char const *cp
); /* TODO obsolete -> torek_hash() */
193 /* Find a prime greater than n */
194 FL ui32_t
nextprime(ui32_t n
);
196 /* Check wether *s is an escape sequence, expand it as necessary.
197 * Returns the expanded sequence or 0 if **s is NUL or PROMPT_STOP if it is \c.
198 * *s is advanced to after the expanded sequence (as possible).
199 * If use_prompt_extensions is set, an enum prompt_exp may be returned */
200 FL
int expand_shell_escape(char const **s
,
201 bool_t use_prompt_extensions
);
203 /* Get *prompt*, or '& ' if *bsdcompat*, of '? ' otherwise */
204 FL
char * getprompt(void);
206 /* Detect and query the hostname to use */
207 FL
char * nodename(int mayoverride
);
209 /* Try to lookup a variable named "password-*token*".
210 * Return NULL or salloc()ed buffer */
211 FL
char * lookup_password_for_token(char const *token
);
213 /* Get a (pseudo) random string of *length* bytes; returns salloc()ed buffer */
214 FL
char * getrandstring(size_t length
);
216 #define Hexchar(n) ((n)>9 ? (n)-10+'A' : (n)+'0')
217 #define hexchar(n) ((n)>9 ? (n)-10+'a' : (n)+'0')
219 /* MD5 (RFC 1321) related facilities */
221 # ifdef HAVE_OPENSSL_MD5
222 # define md5_ctx MD5_CTX
223 # define md5_init MD5_Init
224 # define md5_update MD5_Update
225 # define md5_final MD5_Final
227 # include "rfc1321.h"
230 /* Store the MD5 checksum as a hexadecimal string in *hex*, *not* terminated */
231 # define MD5TOHEX_SIZE 32
232 FL
char * md5tohex(char hex
[MD5TOHEX_SIZE
], void const *vp
);
234 /* CRAM-MD5 encode the *user* / *pass* / *b64* combo */
235 FL
char * cram_md5_string(char const *user
, char const *pass
,
238 /* RFC 2104: HMAC: Keyed-Hashing for Message Authentication.
239 * unsigned char *text: pointer to data stream
240 * int text_len : length of data stream
241 * unsigned char *key : pointer to authentication key
242 * int key_len : length of authentication key
243 * caddr_t digest : caller digest to be filled in */
244 FL
void hmac_md5(unsigned char *text
, int text_len
, unsigned char *key
,
245 int key_len
, void *digest
);
248 FL
enum okay
makedir(char const *name
);
250 /* A get-wd..restore-wd approach */
251 FL
enum okay
cwget(struct cw
*cw
);
252 FL
enum okay
cwret(struct cw
*cw
);
253 FL
void cwrelse(struct cw
*cw
);
255 /* xxx Place cp in a salloc()ed buffer, column-aligned */
256 FL
char * colalign(char const *cp
, int col
, int fill
,
257 int *cols_decr_used_or_null
);
259 /* Convert a string to a displayable one;
260 * prstr() returns the result savestr()d, prout() writes it */
261 FL
void makeprint(struct str
const *in
, struct str
*out
);
262 FL
char * prstr(char const *s
);
263 FL
int prout(char const *s
, size_t sz
, FILE *fp
);
265 /* Print out a Unicode character or a substitute for it, return 0 on error or
266 * wcwidth() (or 1) on success */
267 FL
size_t putuc(int u
, int c
, FILE *fp
);
269 /* We want coloured output (in this salloc() cycle). If pager_used is not NULL
270 * we check against *colour-pagers* wether colour is really desirable */
272 FL
void colour_table_create(char const *pager_used
);
273 FL
void colour_put(FILE *fp
, enum colourspec cs
);
274 FL
void colour_put_header(FILE *fp
, char const *name
);
275 FL
void colour_reset(FILE *fp
);
276 FL
struct str
const * colour_get(enum colourspec cs
);
278 # define colour_put(FP,CS)
279 # define colour_put_header(FP,N)
280 # define colour_reset(FP)
283 /* Update *tc* to now; only .tc_time updated unless *full_update* is true */
284 FL
void time_current_update(struct time_current
*tc
,
287 /* Memory allocation routines */
289 # define SMALLOC_DEBUG_ARGS , char const *mdbg_file, int mdbg_line
290 # define SMALLOC_DEBUG_ARGSCALL , mdbg_file, mdbg_line
292 # define SMALLOC_DEBUG_ARGS
293 # define SMALLOC_DEBUG_ARGSCALL
296 FL
void * smalloc(size_t s SMALLOC_DEBUG_ARGS
);
297 FL
void * srealloc(void *v
, size_t s SMALLOC_DEBUG_ARGS
);
298 FL
void * scalloc(size_t nmemb
, size_t size SMALLOC_DEBUG_ARGS
);
301 FL
void sfree(void *v SMALLOC_DEBUG_ARGS
);
302 /* Called by sreset(), then */
303 FL
void smemreset(void);
305 FL
int c_smemtrace(void *v
);
308 FL bool_t
_smemcheck(char const *file
, int line
);
311 # define smalloc(SZ) smalloc(SZ, __FILE__, __LINE__)
312 # define srealloc(P,SZ) srealloc(P, SZ, __FILE__, __LINE__)
313 # define scalloc(N,SZ) scalloc(N, SZ, __FILE__, __LINE__)
314 # define free(P) sfree(P, __FILE__, __LINE__)
315 # define smemcheck() _smemcheck(__FILE__, __LINE__)
322 FL
int c_cmdnotsupp(void *v
);
324 /* Show header group */
325 FL
int c_headers(void *v
);
327 /* Scroll to the next/previous screen */
328 FL
int c_scroll(void *v
);
329 FL
int c_Scroll(void *v
);
331 /* Print out the headlines for each message in the passed message list */
332 FL
int c_from(void *v
);
334 /* Print all message in between and including bottom and topx if they are
335 * visible and either only_marked is false or they are MMARKed */
336 FL
void print_headers(size_t bottom
, size_t topx
, bool_t only_marked
);
338 /* Print out the value of dot */
339 FL
int c_pdot(void *v
);
341 /* Paginate messages, honor/don't honour ignored fields, respectively */
342 FL
int c_more(void *v
);
343 FL
int c_More(void *v
);
345 /* Type out messages, honor/don't honour ignored fields, respectively */
346 FL
int c_type(void *v
);
347 FL
int c_Type(void *v
);
349 /* Show MIME-encoded message text, including all fields */
350 FL
int c_show(void *v
);
352 /* Pipe messages, honor/don't honour ignored fields, respectively */
353 FL
int c_pipe(void *v
);
354 FL
int c_Pipe(void *v
);
356 /* Print the top so many lines of each desired message.
357 * The number of lines is taken from *toplines* and defaults to 5 */
358 FL
int c_top(void *v
);
360 /* Touch all the given messages so that they will get mboxed */
361 FL
int c_stouch(void *v
);
363 /* Make sure all passed messages get mboxed */
364 FL
int c_mboxit(void *v
);
366 /* List the folders the user currently has */
367 FL
int c_folders(void *v
);
373 /* If any arguments were given, go to the next applicable argument following
374 * dot, otherwise, go to the next applicable message. If given as first
375 * command with no arguments, print first message */
376 FL
int c_next(void *v
);
378 /* Save a message in a file. Mark the message as saved so we can discard when
380 FL
int c_save(void *v
);
381 FL
int c_Save(void *v
);
383 /* Copy a message to a file without affected its saved-ness */
384 FL
int c_copy(void *v
);
385 FL
int c_Copy(void *v
);
387 /* Move a message to a file */
388 FL
int c_move(void *v
);
389 FL
int c_Move(void *v
);
391 /* Decrypt and copy a message to a file */
392 FL
int c_decrypt(void *v
);
393 FL
int c_Decrypt(void *v
);
395 /* Write the indicated messages at the end of the passed file name, minus
396 * header and trailing blank line. This is the MIME save function */
397 FL
int c_write(void *v
);
399 /* Delete messages */
400 FL
int c_delete(void *v
);
402 /* Delete messages, then type the new dot */
403 FL
int c_deltype(void *v
);
405 /* Undelete the indicated messages */
406 FL
int c_undelete(void *v
);
408 /* Add the given header fields to the retained list. If no arguments, print
409 * the current list of retained fields */
410 FL
int c_retfield(void *v
);
412 /* Add the given header fields to the ignored list. If no arguments, print the
413 * current list of ignored fields */
414 FL
int c_igfield(void *v
);
416 FL
int c_saveretfield(void *v
);
417 FL
int c_saveigfield(void *v
);
418 FL
int c_fwdretfield(void *v
);
419 FL
int c_fwdigfield(void *v
);
420 FL
int c_unignore(void *v
);
421 FL
int c_unretain(void *v
);
422 FL
int c_unsaveignore(void *v
);
423 FL
int c_unsaveretain(void *v
);
424 FL
int c_unfwdignore(void *v
);
425 FL
int c_unfwdretain(void *v
);
431 /* Process a shell escape by saving signals, ignoring signals and a sh -c */
432 FL
int c_shell(void *v
);
434 /* Fork an interactive shell */
435 FL
int c_dosh(void *v
);
437 /* Show the help screen */
438 FL
int c_help(void *v
);
440 /* Print user's working directory */
441 FL
int c_cwd(void *v
);
443 /* Change user's working directory */
444 FL
int c_chdir(void *v
);
446 FL
int c_respond(void *v
);
447 FL
int c_respondall(void *v
);
448 FL
int c_respondsender(void *v
);
449 FL
int c_Respond(void *v
);
450 FL
int c_followup(void *v
);
451 FL
int c_followupall(void *v
);
452 FL
int c_followupsender(void *v
);
453 FL
int c_Followup(void *v
);
455 /* The 'forward' command */
456 FL
int c_forward(void *v
);
458 /* Similar to forward, saving the message in a file named after the first
460 FL
int c_Forward(void *v
);
462 /* Resend a message list to a third person */
463 FL
int c_resend(void *v
);
465 /* Resend a message list to a third person without adding headers */
466 FL
int c_Resend(void *v
);
468 /* Preserve messages, so that they will be sent back to the system mailbox */
469 FL
int c_preserve(void *v
);
471 /* Mark all given messages as unread */
472 FL
int c_unread(void *v
);
474 /* Mark all given messages as read */
475 FL
int c_seen(void *v
);
477 /* Print the size of each message */
478 FL
int c_messize(void *v
);
480 /* Quit quickly. If sourcing, just pop the input level by returning error */
481 FL
int c_rexit(void *v
);
483 /* Set or display a variable value. Syntax is similar to that of sh */
484 FL
int c_set(void *v
);
486 /* Unset a bunch of variable values */
487 FL
int c_unset(void *v
);
489 /* Put add users to a group */
490 FL
int c_group(void *v
);
492 /* Delete the passed groups */
493 FL
int c_ungroup(void *v
);
495 /* Change to another file. With no argument, print info about current file */
496 FL
int c_file(void *v
);
498 /* Expand file names like echo */
499 FL
int c_echo(void *v
);
501 /* if.else.endif conditional execution.
502 * condstack_isskip() returns wether the current condition state doesn't allow
503 * execution of commands.
504 * condstack_release() and condstack_take() are used when sourcing files, they
505 * rotate the current condition stack; condstack_take() returns a false boolean
506 * if the current condition stack has unclosed conditionals */
507 FL
int c_if(void *v
);
508 FL
int c_else(void *v
);
509 FL
int c_endif(void *v
);
510 FL bool_t
condstack_isskip(void);
511 FL
void * condstack_release(void);
512 FL bool_t
condstack_take(void *self
);
514 /* Set the list of alternate names */
515 FL
int c_alternates(void *v
);
517 /* 'newmail' command: Check for new mail without writing old mail back */
518 FL
int c_newmail(void *v
);
521 FL
int c_shortcut(void *v
);
522 FL
struct shortcut
*get_shortcut(char const *str
);
523 FL
int c_unshortcut(void *v
);
525 /* Message flag manipulation */
526 FL
int c_flag(void *v
);
527 FL
int c_unflag(void *v
);
528 FL
int c_answered(void *v
);
529 FL
int c_unanswered(void *v
);
530 FL
int c_draft(void *v
);
531 FL
int c_undraft(void *v
);
534 FL
int c_noop(void *v
);
537 FL
int c_remove(void *v
);
540 FL
int c_rename(void *v
);
546 FL
FILE * collect(struct header
*hp
, int printheaders
, struct message
*mp
,
547 char *quotefile
, int doprefix
);
549 FL
void savedeadletter(FILE *fp
, int fflush_rewind_first
);
555 FL
int fcntl_lock(int fd
, enum flock_type ft
);
556 FL
int dot_lock(char const *fname
, int fd
, int pollinterval
, FILE *fp
,
558 FL
void dot_unlock(char const *fname
);
564 /* Edit a message list */
565 FL
int c_editor(void *v
);
567 /* Invoke the visual editor on a message list */
568 FL
int c_visual(void *v
);
570 /* Run an editor on the file at fp of size bytes, and return a new file.
571 * Signals must be handled by the caller. viored is 'e' for ed, 'v' for vi */
572 FL
FILE * run_editor(FILE *fp
, off_t size
, int viored
, int readonly
,
573 struct header
*hp
, struct message
*mp
,
574 enum sendaction action
, sighandler_type oldint
);
581 FL
struct quoteflt
* quoteflt_dummy(void); /* TODO LEGACY */
582 FL
void quoteflt_init(struct quoteflt
*self
, char const *prefix
);
583 FL
void quoteflt_destroy(struct quoteflt
*self
);
584 FL
void quoteflt_reset(struct quoteflt
*self
, FILE *f
);
585 FL ssize_t
quoteflt_push(struct quoteflt
*self
, char const *dat
,
587 FL ssize_t
quoteflt_flush(struct quoteflt
*self
);
593 /* fgets() replacement to handle lines of arbitrary size and with embedded \0
595 * line - line buffer. *line may be NULL.
596 * linesize - allocated size of line buffer.
597 * count - maximum characters to read. May be NULL.
598 * llen - length_of_line(*line).
600 * appendnl - always terminate line with \n, append if necessary.
602 FL
char * fgetline(char **line
, size_t *linesize
, size_t *count
,
603 size_t *llen
, FILE *fp
, int appendnl SMALLOC_DEBUG_ARGS
);
605 # define fgetline(A,B,C,D,E,F) \
606 fgetline(A, B, C, D, E, F, __FILE__, __LINE__)
609 /* Read up a line from the specified input into the linebuffer.
610 * Return the number of characters read. Do not include the newline at EOL.
611 * n is the number of characters already read */
612 FL
int readline_restart(FILE *ibuf
, char **linebuf
, size_t *linesize
,
613 size_t n SMALLOC_DEBUG_ARGS
);
615 # define readline_restart(A,B,C,D) \
616 readline_restart(A, B, C, D, __FILE__, __LINE__)
619 /* Read a complete line of input, with editing if interactive and possible.
620 * If prompt is NULL we'll call getprompt() first, if necessary.
621 * nl_escape defines wether user can escape newlines via backslash (POSIX).
622 * If string is set it is used as the initial line content if in interactive
623 * mode, otherwise this argument is ignored for reproducibility.
624 * Return number of octets or a value <0 on error */
625 FL
int readline_input(char const *prompt
, bool_t nl_escape
,
626 char **linebuf
, size_t *linesize
, char const *string
629 # define readline_input(A,B,C,D,E) readline_input(A,B,C,D,E,__FILE__,__LINE__)
632 /* Read a line of input, with editing if interactive and possible, return it
633 * savestr()d or NULL in case of errors or if an empty line would be returned.
634 * This may only be called from toplevel (not during sourcing).
635 * If prompt is NULL we'll call getprompt() if necessary.
636 * If string is set it is used as the initial line content if in interactive
637 * mode, otherwise this argument is ignored for reproducibility */
638 FL
char * readstr_input(char const *prompt
, char const *string
);
640 /* Set up the input pointers while copying the mail file into /tmp */
641 FL
void setptr(FILE *ibuf
, off_t offset
);
643 /* Drop the passed line onto the passed output buffer. If a write error occurs
644 * return -1, else the count of characters written, including the newline */
645 FL
int putline(FILE *obuf
, char *linebuf
, size_t count
);
647 /* Return a file buffer all ready to read up the passed message pointer */
648 FL
FILE * setinput(struct mailbox
*mp
, struct message
*m
,
651 /* Reset (free) the global message array */
652 FL
void message_reset(void);
654 /* Append the passed message descriptor onto the message array; if mp is NULL,
655 * NULLify the entry at &[msgCount-1] */
656 FL
void message_append(struct message
*mp
);
658 /* Check wether sep->ss_sexpr (or ->ss_reexpr) matches mp. If with_headers is
659 * true then the headers will also be searched (as plain text) */
660 FL bool_t
message_match(struct message
*mp
, struct search_expr
const *sep
,
661 bool_t with_headers
);
663 FL
struct message
* setdot(struct message
*mp
);
665 /* Delete a file, but only if the file is a plain file */
666 FL
int rm(char const *name
);
668 /* Determine the size of the file possessed by the passed buffer */
669 FL off_t
fsize(FILE *iob
);
671 /* Evaluate the string given as a new mailbox name. Supported meta characters:
672 * % for my system mail box
673 * %user for user's system mail box
674 * # for previous file
675 * & invoker's mbox file
676 * +file file in folder directory
677 * any shell meta character
678 * Returns the file name as an auto-reclaimed string */
679 FL
char * fexpand(char const *name
, enum fexp_mode fexpm
);
681 #define expand(N) fexpand(N, FEXP_FULL) /* XXX obsolete */
682 #define file_expand(N) fexpand(N, FEXP_LOCAL) /* XXX obsolete */
684 /* Get rid of queued mail */
685 FL
void demail(void);
687 /* acmava.c hook: *folder* variable has been updated; if folder shouldn't be
688 * replaced by something else leave store alone, otherwise smalloc() the
689 * desired value (ownership will be taken) */
690 FL bool_t
var_folder_updated(char const *folder
, char **store
);
692 /* Determine the current *folder* name, store it in *name* */
693 FL bool_t
getfold(char *name
, size_t size
);
695 /* Return the name of the dead.letter file */
696 FL
char const * getdeadletter(void);
698 FL
enum okay
get_body(struct message
*mp
);
702 FL
int sclose(struct sock
*sp
);
703 FL
enum okay
swrite(struct sock
*sp
, char const *data
);
704 FL
enum okay
swrite1(struct sock
*sp
, char const *data
, int sz
,
706 FL
enum okay
sopen(char const *xserver
, struct sock
*sp
, int use_ssl
,
707 char const *uhp
, char const *portstr
);
710 FL
int sgetline(char **line
, size_t *linesize
, size_t *linelen
,
711 struct sock
*sp SMALLOC_DEBUG_ARGS
);
713 # define sgetline(A,B,C,D) sgetline(A, B, C, D, __FILE__, __LINE__)
715 #endif /* HAVE_SOCKETS */
717 /* Deal with loading of resource files and dealing with a stack of files for
718 * the source command */
720 /* Load a file of user definitions */
721 FL
void load(char const *name
);
723 /* Pushdown current input file and switch to a new one. Set the global flag
724 * *sourcing* so that others will realize that they are no longer reading from
725 * a tty (in all probability) */
726 FL
int c_source(void *v
);
728 /* Pop the current input back to the previous level. Update the *sourcing*
729 * flag as appropriate */
730 FL
int unstack(void);
736 /* Return the user's From: address(es) */
737 FL
char const * myaddrs(struct header
*hp
);
739 /* Boil the user's From: addresses down to a single one, or use *sender* */
740 FL
char const * myorigin(struct header
*hp
);
742 /* See if the passed line buffer, which may include trailing newline (sequence)
743 * is a mail From_ header line according to RFC 4155 */
744 FL
int is_head(char const *linebuf
, size_t linelen
);
746 /* Savage extract date field from From_ line. linelen is convenience as line
747 * must be terminated (but it may end in a newline [sequence]).
748 * Return wether the From_ line was parsed successfully */
749 FL
int extract_date_from_from_(char const *line
, size_t linelen
,
750 char datebuf
[FROM_DATEBUF
]);
752 /* Fill in / reedit the desired header fields */
753 FL
int grab_headers(struct header
*hp
, enum gfield gflags
,
756 FL
void extract_header(FILE *fp
, struct header
*hp
);
758 /* Return the desired header line from the passed message
759 * pointer (or NULL if the desired header field is not available).
760 * If mult is zero, return the content of the first matching header
761 * field only, the content of all matching header fields else */
762 FL
char * hfield_mult(char const *field
, struct message
*mp
, int mult
);
763 #define hfieldX(a, b) hfield_mult(a, b, 1)
764 #define hfield1(a, b) hfield_mult(a, b, 0)
766 /* Check whether the passed line is a header line of the desired breed.
767 * Return the field body, or 0 */
768 FL
char const * thisfield(char const *linebuf
, char const *field
);
770 /* Get sender's name from this message. If the message has a bunch of arpanet
771 * stuff in it, we may have to skin the name before returning it */
772 FL
char * nameof(struct message
*mp
, int reptype
);
774 /* Start of a "comment". Ignore it */
775 FL
char const * skip_comment(char const *cp
);
777 /* Return the start of a route-addr (address in angle brackets), if present */
778 FL
char const * routeaddr(char const *name
);
780 /* Check if a name's address part contains invalid characters */
781 FL
int is_addr_invalid(struct name
*np
, int putmsg
);
783 /* Does *NP* point to a file or pipe addressee? */
784 #define is_fileorpipe_addr(NP) \
785 (((NP)->n_flags & NAME_ADDRSPEC_ISFILEORPIPE) != 0)
787 /* Return skinned version of *NP*s name */
788 #define skinned_name(NP) \
789 (assert((NP)->n_flags & NAME_SKINNED), \
790 ((struct name const*)NP)->n_name)
792 /* Skin an address according to the RFC 822 interpretation of "host-phrase" */
793 FL
char * skin(char const *name
);
795 /* Skin *name* and extract the *addr-spec* according to RFC 5322.
796 * Store the result in .ag_skinned and also fill in those .ag_ fields that have
797 * actually been seen.
798 * Return 0 if something good has been parsed, 1 if fun didn't exactly know how
799 * to deal with the input, or if that was plain invalid */
800 FL
int addrspec_with_guts(int doskin
, char const *name
,
801 struct addrguts
*agp
);
803 /* Fetch the real name from an internet mail address field */
804 FL
char * realname(char const *name
);
806 /* Fetch the sender's name from the passed message. reptype can be
807 * 0 -- get sender's name for display purposes
808 * 1 -- get sender's name for reply
809 * 2 -- get sender's name for Reply */
810 FL
char * name1(struct message
*mp
, int reptype
);
812 FL
int msgidcmp(char const *s1
, char const *s2
);
814 /* See if the given header field is supposed to be ignored */
815 FL
int is_ign(char const *field
, size_t fieldlen
,
816 struct ignoretab ignore
[2]);
818 FL
int member(char const *realfield
, struct ignoretab
*table
);
820 /* Fake Sender for From_ lines if missing, e. g. with POP3 */
821 FL
char const * fakefrom(struct message
*mp
);
823 FL
char const * fakedate(time_t t
);
825 /* From username Fri Jan 2 20:13:51 2004
828 FL
time_t unixtime(char const *from
);
830 FL
time_t rfctime(char const *date
);
832 FL
time_t combinetime(int year
, int month
, int day
,
833 int hour
, int minute
, int second
);
835 FL
void substdate(struct message
*m
);
837 FL
int check_from_and_sender(struct name
*fromfield
,
838 struct name
*senderfield
);
840 FL
char * getsender(struct message
*m
);
847 FL
char const * imap_fileof(char const *xcp
);
848 FL
enum okay
imap_noop(void);
849 FL
enum okay
imap_select(struct mailbox
*mp
, off_t
*size
, int *count
,
851 FL
int imap_setfile(const char *xserver
, int nmail
, int isedit
);
852 FL
enum okay
imap_header(struct message
*m
);
853 FL
enum okay
imap_body(struct message
*m
);
854 FL
void imap_getheaders(int bot
, int top
);
855 FL
void imap_quit(void);
856 FL
enum okay
imap_undelete(struct message
*m
, int n
);
857 FL
enum okay
imap_unread(struct message
*m
, int n
);
858 FL
int c_imap_imap(void *vp
);
859 FL
int imap_newmail(int nmail
);
860 FL
enum okay
imap_append(const char *xserver
, FILE *fp
);
861 FL
void imap_folders(const char *name
, int strip
);
862 FL
enum okay
imap_copy(struct message
*m
, int n
, const char *name
);
863 # ifdef HAVE_IMAP_SEARCH
864 FL
enum okay
imap_search1(const char *spec
, int f
);
866 FL
int imap_thisaccount(const char *cp
);
867 FL
enum okay
imap_remove(const char *name
);
868 FL
enum okay
imap_rename(const char *old
, const char *new);
869 FL
enum okay
imap_dequeue(struct mailbox
*mp
, FILE *fp
);
870 FL
int c_connect(void *vp
);
871 FL
int c_disconnect(void *vp
);
872 FL
int c_cache(void *vp
);
873 FL
int disconnected(const char *file
);
874 FL
void transflags(struct message
*omessage
, long omsgCount
,
876 FL
time_t imap_read_date_time(const char *cp
);
877 FL
const char * imap_make_date_time(time_t t
);
879 # define c_imap_imap c_cmdnotsupp
880 # define c_connect c_cmdnotsupp
881 # define c_disconnect c_cmdnotsupp
882 # define c_cache c_cmdnotsupp
885 #if defined HAVE_IMAP || defined HAVE_IMAP_SEARCH
886 FL
char * imap_quotestr(char const *s
);
887 FL
char * imap_unquotestr(char const *s
);
895 FL
enum okay
getcache1(struct mailbox
*mp
, struct message
*m
,
896 enum needspec need
, int setflags
);
897 FL
enum okay
getcache(struct mailbox
*mp
, struct message
*m
,
899 FL
void putcache(struct mailbox
*mp
, struct message
*m
);
900 FL
void initcache(struct mailbox
*mp
);
901 FL
void purgecache(struct mailbox
*mp
, struct message
*m
, long mc
);
902 FL
void delcache(struct mailbox
*mp
, struct message
*m
);
903 FL
enum okay
cache_setptr(int transparent
);
904 FL
enum okay
cache_list(struct mailbox
*mp
, char const *base
, int strip
,
906 FL
enum okay
cache_remove(char const *name
);
907 FL
enum okay
cache_rename(char const *old
, char const *new);
908 FL
unsigned long cached_uidvalidity(struct mailbox
*mp
);
909 FL
FILE * cache_queue(struct mailbox
*mp
);
910 FL
enum okay
cache_dequeue(struct mailbox
*mp
);
911 #endif /* HAVE_IMAP */
917 #ifdef HAVE_IMAP_SEARCH
918 FL
enum okay
imap_search(char const *spec
, int f
);
925 /* Set up editing on the given file name.
926 * If the first character of name is %, we are considered to be editing the
927 * file, otherwise we are reading our mail which has signficance for mbox and
928 * so forth. nmail: Check for new mail in the current folder only */
929 FL
int setfile(char const *name
, int nmail
);
931 FL
int newmailinfo(int omsgCount
);
933 /* Interpret user commands. If standard input is not a tty, print no prompt */
934 FL
void commands(void);
936 /* Evaluate a single command.
937 * .ev_add_history and .ev_new_content will be updated upon success.
938 * Command functions return 0 for success, 1 for error, and -1 for abort.
939 * 1 or -1 aborts a load or source, a -1 aborts the interactive command loop */
940 FL
int evaluate(struct eval_ctx
*evp
);
941 /* TODO drop execute() is the legacy version of evaluate().
942 * Contxt is non-zero if called while composing mail */
943 FL
int execute(char *linebuf
, int contxt
, size_t linesize
);
945 /* Set the size of the message vector used to construct argument lists to
946 * message list functions */
947 FL
void setmsize(int sz
);
949 /* Logic behind -H / -L invocations */
950 FL
void print_header_summary(char const *Larg
);
952 /* The following gets called on receipt of an interrupt. This is to abort
953 * printout of a command, mainly. Dispatching here when command() is inactive
954 * crashes rcv. Close all open files except 0, 1, 2, and the temporary. Also,
955 * unstack all source files */
956 FL
void onintr(int s
);
958 /* Announce the presence of the current Mail version, give the message count,
959 * and print a header listing */
960 FL
void announce(int printheaders
);
962 /* Announce information about the file we are editing. Return a likely place
964 FL
int newfileinfo(void);
966 FL
int getmdot(int nmail
);
968 FL
void initbox(char const *name
);
970 /* Print the docstring of `comm', which may be an abbreviation.
971 * Return FAL0 if there is no such command */
972 #ifdef HAVE_DOCSTRINGS
973 FL bool_t
print_comm_docstr(char const *comm
);
980 /* Convert user string of message numbers and store the numbers into vector.
981 * Returns the count of messages picked up or -1 on error */
982 FL
int getmsglist(char *buf
, int *vector
, int flags
);
984 /* Scan out the list of string arguments, shell style for a RAWLIST */
985 FL
int getrawlist(char const *line
, size_t linesize
,
986 char **argv
, int argc
, int echolist
);
988 /* Find the first message whose flags&m==f and return its message number */
989 FL
int first(int f
, int m
);
991 /* Mark the named message by setting its mark bit */
992 FL
void mark(int mesg
, int f
);
994 /* lzw.c TODO drop */
996 FL
int zwrite(void *cookie
, const char *wbp
, int num
);
997 FL
int zfree(void *cookie
);
998 FL
int zread(void *cookie
, char *rbp
, int num
);
999 FL
void * zalloc(FILE *fp
);
1000 #endif /* HAVE_IMAP */
1006 FL
int maildir_setfile(char const *name
, int nmail
, int isedit
);
1008 FL
void maildir_quit(void);
1010 FL
enum okay
maildir_append(char const *name
, FILE *fp
);
1012 FL
enum okay
maildir_remove(char const *name
);
1018 /* *charset-7bit*, else CHARSET_7BIT */
1019 FL
char const * charset_get_7bit(void);
1021 /* *charset-8bit*, else CHARSET_8BIT */
1022 FL
char const * charset_get_8bit(void);
1024 /* LC_CTYPE:CODESET / *ttycharset*, else *charset-8bit*, else CHARSET_8BIT */
1025 FL
char const * charset_get_lc(void);
1027 /* *sendcharsets* / *charset-8bit* iterator.
1028 * *a_charset_to_try_first* may be used to prepend a charset (as for
1029 * *reply-in-same-charset*); works correct for !HAVE_ICONV */
1030 FL
void charset_iter_reset(char const *a_charset_to_try_first
);
1031 FL
char const * charset_iter_next(void);
1032 FL
char const * charset_iter_current(void);
1033 FL
void charset_iter_recurse(char *outer_storage
[2]); /* TODO LEGACY */
1034 FL
void charset_iter_restore(char *outer_storage
[2]); /* TODO LEGACY */
1037 FL
char const * need_hdrconv(struct header
*hp
, enum gfield w
);
1040 /* Get the mime encoding from a Content-Transfer-Encoding header field */
1041 FL
enum mimeenc
mime_getenc(char *h
);
1043 /* Get a mime style parameter from a header line */
1044 FL
char * mime_getparam(char const *param
, char *h
);
1046 /* Get the boundary out of a Content-Type: multipart/xyz header field, return
1047 * salloc()ed copy of it; store strlen() in *len if set */
1048 FL
char * mime_get_boundary(char *h
, size_t *len
);
1050 /* Create a salloc()ed MIME boundary */
1051 FL
char * mime_create_boundary(void);
1053 /* Classify content of *fp* as necessary and fill in arguments; **charset* is
1054 * left alone unless it's non-NULL */
1055 FL
int mime_classify_file(FILE *fp
, char const **contenttype
,
1056 char const **charset
, int *do_iconv
);
1059 FL
enum mimecontent
mime_classify_content_of_part(struct mimepart
const *mip
);
1061 /* Return the Content-Type matching the extension of name */
1062 FL
char * mime_classify_content_type_by_fileext(char const *name
);
1064 /* "mimetypes" command */
1065 FL
int c_mimetypes(void *v
);
1067 /* Convert header fields from RFC 1522 format */
1068 FL
void mime_fromhdr(struct str
const *in
, struct str
*out
,
1069 enum tdflags flags
);
1071 /* Interpret MIME strings in parts of an address field */
1072 FL
char * mime_fromaddr(char const *name
);
1074 /* fwrite(3) performing the given MIME conversion */
1075 FL ssize_t
mime_write(char const *ptr
, size_t size
, FILE *f
,
1076 enum conversion convert
, enum tdflags dflags
,
1077 struct quoteflt
*qf
, struct str
*rest
);
1078 FL ssize_t
xmime_write(char const *ptr
, size_t size
, /* TODO LEGACY */
1079 FILE *f
, enum conversion convert
, enum tdflags dflags
,
1084 * Content-Transfer-Encodings as defined in RFC 2045:
1085 * - Quoted-Printable, section 6.7
1086 * - Base64, section 6.8
1089 /* How many characters of (the complete body) ln need to be quoted */
1090 FL
size_t mime_cte_mustquote(char const *ln
, size_t lnlen
, bool_t ishead
);
1092 /* How much space is necessary to encode len bytes in QP, worst case.
1093 * Includes room for terminator */
1094 FL
size_t qp_encode_calc_size(size_t len
);
1096 /* If flags includes QP_ISHEAD these assume "word" input and use special
1097 * quoting rules in addition; soft line breaks are not generated.
1098 * Otherwise complete input lines are assumed and soft line breaks are
1099 * generated as necessary */
1100 FL
struct str
* qp_encode(struct str
*out
, struct str
const *in
,
1101 enum qpflags flags
);
1103 FL
struct str
* qp_encode_cp(struct str
*out
, char const *cp
,
1104 enum qpflags flags
);
1105 FL
struct str
* qp_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
1106 enum qpflags flags
);
1109 /* If rest is set then decoding will assume body text input (assumes input
1110 * represents lines, only create output when input didn't end with soft line
1111 * break [except it finalizes an encoded CRLF pair]), otherwise it is assumed
1112 * to decode a header strings and (1) uses special decoding rules and (b)
1113 * directly produces output.
1114 * The buffers of out and possibly rest will be managed via srealloc().
1115 * Returns OKAY. XXX or STOP on error (in which case out is set to an error
1116 * XXX message); caller is responsible to free buffers */
1117 FL
int qp_decode(struct str
*out
, struct str
const *in
,
1120 /* How much space is necessary to encode len bytes in Base64, worst case.
1121 * Includes room for (CR/LF/CRLF and) terminator */
1122 FL
size_t b64_encode_calc_size(size_t len
);
1124 /* Note these simply convert all the input (if possible), including the
1125 * insertion of NL sequences if B64_CRLF or B64_LF is set (and multiple thereof
1126 * if B64_MULTILINE is set).
1127 * Thus, in the B64_BUF case, better call b64_encode_calc_size() first */
1128 FL
struct str
* b64_encode(struct str
*out
, struct str
const *in
,
1129 enum b64flags flags
);
1130 FL
struct str
* b64_encode_cp(struct str
*out
, char const *cp
,
1131 enum b64flags flags
);
1132 FL
struct str
* b64_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
1133 enum b64flags flags
);
1135 /* If rest is set then decoding will assume text input.
1136 * The buffers of out and possibly rest will be managed via srealloc().
1137 * Returns OKAY or STOP on error (in which case out is set to an error
1138 * message); caller is responsible to free buffers */
1139 FL
int b64_decode(struct str
*out
, struct str
const *in
,
1146 /* Allocate a single element of a name list, initialize its name field to the
1147 * passed name and return it */
1148 FL
struct name
* nalloc(char *str
, enum gfield ntype
);
1150 /* Like nalloc(), but initialize from content of np */
1151 FL
struct name
* ndup(struct name
*np
, enum gfield ntype
);
1153 /* Concatenate the two passed name lists, return the result */
1154 FL
struct name
* cat(struct name
*n1
, struct name
*n2
);
1156 /* Determine the number of undeleted elements in a name list and return it */
1157 FL ui32_t
count(struct name
const *np
);
1159 /* Extract a list of names from a line, and make a list of names from it.
1160 * Return the list or NULL if none found */
1161 FL
struct name
* extract(char const *line
, enum gfield ntype
);
1163 /* Like extract() unless line contains anyof ",\"\\(<|", in which case
1164 * comma-separated list extraction is used instead */
1165 FL
struct name
* lextract(char const *line
, enum gfield ntype
);
1167 /* Turn a list of names into a string of the same names */
1168 FL
char * detract(struct name
*np
, enum gfield ntype
);
1170 /* Get a lextract() list via readstr_input(), reassigning to *np* */
1171 FL
struct name
* grab_names(char const *field
, struct name
*np
, int comma
,
1172 enum gfield gflags
);
1174 /* Check all addresses in np and delete invalid ones */
1175 FL
struct name
* checkaddrs(struct name
*np
);
1177 /* Map all of the aliased users in the invoker's mailrc file and insert them
1179 FL
struct name
* usermap(struct name
*names
, bool_t force_metoo
);
1181 /* Remove all of the duplicates from the passed name list by insertion sorting
1182 * them, then checking for dups. Return the head of the new list */
1183 FL
struct name
* elide(struct name
*names
);
1185 FL
struct name
* delete_alternates(struct name
*np
);
1187 FL
int is_myname(char const *name
);
1189 /* Dispatch a message to all pipe and file addresses TODO -> sendout.c */
1190 FL
struct name
* outof(struct name
*names
, FILE *fo
, struct header
*hp
,
1193 /* Handling of alias groups */
1195 /* Locate a group name and return it */
1196 FL
struct grouphead
* findgroup(char *name
);
1198 /* Print a group out on stdout */
1199 FL
void printgroup(char *name
);
1201 FL
void remove_group(char const *name
);
1209 FL
enum okay
ssl_open(char const *server
, struct sock
*sp
, char const *uhp
);
1212 FL
void ssl_gen_err(char const *fmt
, ...);
1215 FL
int c_verify(void *vp
);
1218 FL
FILE * smime_sign(FILE *ip
, struct header
*);
1221 FL
FILE * smime_encrypt(FILE *ip
, char const *certfile
, char const *to
);
1223 FL
struct message
* smime_decrypt(struct message
*m
, char const *to
,
1224 char const *cc
, int signcall
);
1227 FL
enum okay
smime_certsave(struct message
*m
, int n
, FILE *op
);
1229 #else /* HAVE_OPENSSL */
1230 # define c_verify c_cmdnotsupp
1239 FL
enum okay
pop3_noop(void);
1242 FL
int pop3_setfile(char const *server
, int nmail
, int isedit
);
1245 FL
enum okay
pop3_header(struct message
*m
);
1248 FL
enum okay
pop3_body(struct message
*m
);
1251 FL
void pop3_quit(void);
1252 #endif /* HAVE_POP3 */
1256 * Subprocesses, popen, but also file handling with registering
1259 /* Notes: OF_CLOEXEC is implied in oflags, xflags may be NULL */
1260 FL
FILE * safe_fopen(char const *file
, char const *oflags
, int *xflags
);
1262 /* Notes: OF_CLOEXEC|OF_REGISTER are implied in oflags */
1263 FL
FILE * Fopen(char const *file
, char const *oflags
);
1265 FL
FILE * Fdopen(int fd
, char const *oflags
);
1267 FL
int Fclose(FILE *fp
);
1269 FL
FILE * Zopen(char const *file
, char const *oflags
, int *compression
);
1271 /* Create a temporary file in tempdir, use prefix for its name, store the
1272 * unique name in fn (unless OF_UNLINK is set in oflags), and return a stdio
1273 * FILE pointer with access oflags. OF_CLOEXEC is implied in oflags.
1274 * mode specifies the access mode of the newly created temporary file */
1275 FL
FILE * Ftmp(char **fn
, char const *prefix
, enum oflags oflags
,
1278 /* If OF_HOLDSIGS was set when calling Ftmp(), then hold_all_sigs() had been
1279 * called: call this to unlink(2) and free *fn and to rele_all_sigs() */
1280 FL
void Ftmp_release(char **fn
);
1282 /* Free the resources associated with the given filename. To be called after
1284 FL
void Ftmp_free(char **fn
);
1286 /* Create a pipe and ensure CLOEXEC bit is set in both descriptors */
1287 FL bool_t
pipe_cloexec(int fd
[2]);
1289 FL
FILE * Popen(char const *cmd
, char const *mode
, char const *shell
,
1292 FL bool_t
Pclose(FILE *ptr
, bool_t dowait
);
1294 FL
void close_all_files(void);
1296 /* Run a command without a shell, with optional arguments and splicing of stdin
1297 * and stdout. The command name can be a sequence of words. Signals must be
1298 * handled by the caller. "Mask" contains the signals to ignore in the new
1299 * process. SIGINT is enabled unless it's in the mask */
1300 FL
int run_command(char const *cmd
, sigset_t
*mask
, int infd
,
1301 int outfd
, char const *a0
, char const *a1
, char const *a2
);
1303 FL
int start_command(char const *cmd
, sigset_t
*mask
, int infd
,
1304 int outfd
, char const *a0
, char const *a1
, char const *a2
);
1306 FL
void prepare_child(sigset_t
*nset
, int infd
, int outfd
);
1308 FL
void sigchild(int signo
);
1310 /* Mark a child as don't care */
1311 FL
void free_child(int pid
);
1313 /* Wait for pid, return wether we've had a normal EXIT_SUCCESS exit.
1314 * If wait_status is set, set it to the reported waitpid(2) wait status */
1315 FL bool_t
wait_child(int pid
, int *wait_status
);
1321 /* The `quit' command */
1322 FL
int c_quit(void *v
);
1324 /* Save all of the undetermined messages at the top of "mbox". Save all
1325 * untouched messages back in the system mailbox. Remove the system mailbox,
1326 * if none saved there */
1329 /* Adjust the message flags in each message */
1330 FL
int holdbits(void);
1332 /* Create another temporary file and copy user's mbox file darin. If there is
1333 * no mbox, copy nothing. If he has specified "append" don't copy his mailbox,
1334 * just copy saveable entries at the end */
1335 FL
enum okay
makembox(void);
1337 FL
void save_mbox_for_possible_quitstuff(void); /* TODO DROP IF U CAN */
1339 FL
int savequitflags(void);
1341 FL
void restorequitflags(int);
1347 /* Send message described by the passed pointer to the passed output buffer.
1348 * Return -1 on error. Adjust the status: field if need be. If doign is
1349 * given, suppress ignored header fields. prefix is a string to prepend to
1350 * each output line. action = data destination
1351 * (SEND_MBOX,_TOFILE,_TODISP,_QUOTE,_DECRYPT). stats[0] is line count,
1352 * stats[1] is character count. stats may be NULL. Note that stats[0] is
1353 * valid for SEND_MBOX only */
1354 FL
int sendmp(struct message
*mp
, FILE *obuf
, struct ignoretab
*doign
,
1355 char const *prefix
, enum sendaction action
, off_t
*stats
);
1361 /* Interface between the argument list and the mail1 routine which does all the
1363 FL
int mail(struct name
*to
, struct name
*cc
, struct name
*bcc
,
1364 char *subject
, struct attachment
*attach
, char *quotefile
,
1365 int recipient_record
);
1367 /* `mail' and `Mail' commands, respectively */
1368 FL
int c_sendmail(void *v
);
1369 FL
int c_Sendmail(void *v
);
1371 /* Mail a message on standard input to the people indicated in the passed
1372 * header. (Internal interface) */
1373 FL
enum okay
mail1(struct header
*hp
, int printheaders
,
1374 struct message
*quote
, char *quotefile
, int recipient_record
,
1377 /* Create a Date: header field.
1378 * We compare the localtime() and gmtime() results to get the timezone, because
1379 * numeric timezones are easier to read and because $TZ isn't always set */
1380 FL
int mkdate(FILE *fo
, char const *field
);
1382 /* Dump the to, subject, cc header on the passed file buffer */
1383 FL
int puthead(struct header
*hp
, FILE *fo
, enum gfield w
,
1384 enum sendaction action
, enum conversion convert
,
1385 char const *contenttype
, char const *charset
);
1388 FL
enum okay
resend_msg(struct message
*mp
, struct name
*to
, int add_resent
);
1395 /* smtp-authXY, where XY=type=-user|-password etc */
1396 FL
char * smtp_auth_var(char const *type
, char const *addr
);
1398 /* Connect to a SMTP server */
1399 FL
int smtp_mta(char *server
, struct name
*to
, FILE *fi
,
1400 struct header
*hp
, char const *user
, char const *password
,
1401 char const *skinned
);
1409 /* Direct mappings of the various spam* commands */
1410 FL
int c_spam_clear(void *v
);
1411 FL
int c_spam_set(void *v
);
1412 FL
int c_spam_forget(void *v
);
1413 FL
int c_spam_ham(void *v
);
1414 FL
int c_spam_rate(void *v
);
1415 FL
int c_spam_spam(void *v
);
1417 # define c_spam_clear c_cmdnotsupp
1418 # define c_spam_set c_cmdnotsupp
1419 # define c_spam_forget c_cmdnotsupp
1420 # define c_spam_ham c_cmdnotsupp
1421 # define c_spam_rate c_cmdnotsupp
1422 # define c_spam_spam c_cmdnotsupp
1431 FL
void ssl_set_verify_level(char const *uhp
);
1434 FL
enum okay
ssl_verify_decide(void);
1437 FL
char * ssl_method_string(char const *uhp
);
1440 FL
enum okay
smime_split(FILE *ip
, FILE **hp
, FILE **bp
, long xcount
,
1444 FL
FILE * smime_sign_assemble(FILE *hp
, FILE *bp
, FILE *sp
);
1447 FL
FILE * smime_encrypt_assemble(FILE *hp
, FILE *yp
);
1450 FL
struct message
* smime_decrypt_assemble(struct message
*m
, FILE *hp
,
1454 FL
int c_certsave(void *v
);
1457 FL
enum okay
rfc2595_hostname_match(char const *host
, char const *pattern
);
1458 #else /* HAVE_SSL */
1459 # define c_certsave c_cmdnotsupp
1464 * This bundles several different string related support facilities:
1465 * - auto-reclaimed string storage (memory goes away on command loop ticks)
1466 * - plain char* support functions which use unspecified or smalloc() memory
1467 * - struct str related support funs
1468 * - our iconv(3) wrapper
1471 /* Auto-reclaimed string storage */
1474 # define SALLOC_DEBUG_ARGS , char const *mdbg_file, int mdbg_line
1475 # define SALLOC_DEBUG_ARGSCALL , mdbg_file, mdbg_line
1477 # define SALLOC_DEBUG_ARGS
1478 # define SALLOC_DEBUG_ARGSCALL
1481 /* Allocate size more bytes of space and return the address of the first byte
1482 * to the caller. An even number of bytes are always allocated so that the
1483 * space will always be on a word boundary */
1484 FL
void * salloc(size_t size SALLOC_DEBUG_ARGS
);
1485 FL
void * csalloc(size_t nmemb
, size_t size SALLOC_DEBUG_ARGS
);
1487 # define salloc(SZ) salloc(SZ, __FILE__, __LINE__)
1488 # define csalloc(NM,SZ) csalloc(NM, SZ, __FILE__, __LINE__)
1491 /* Auto-reclaim string storage; if only_if_relaxed is true then only perform
1492 * the reset when a srelax_hold() is currently active */
1493 FL
void sreset(bool_t only_if_relaxed
);
1495 /* The "problem" with sreset() is that it releases all string storage except
1496 * what was present once spreserve() had been called; it therefore cannot be
1497 * called from all that code which yet exists and walks about all the messages
1498 * in order, e.g. quit(), searches, etc., because, unfortunately, these code
1499 * paths are reached with new intermediate string dope already in use.
1500 * Thus such code should take a srelax_hold(), successively call srelax() after
1501 * a single message has been handled, and finally srelax_rele() (unless it is
1502 * clear that sreset() occurs anyway) */
1503 FL
void srelax_hold(void);
1504 FL
void srelax_rele(void);
1505 FL
void srelax(void);
1507 /* Make current string storage permanent: new allocs will be auto-reclaimed by
1508 * sreset(). This is called once only, from within main() */
1509 FL
void spreserve(void);
1511 /* 'sstats' command */
1513 FL
int c_sstats(void *v
);
1516 /* Return a pointer to a dynamic copy of the argument */
1517 FL
char * savestr(char const *str SALLOC_DEBUG_ARGS
);
1518 FL
char * savestrbuf(char const *sbuf
, size_t sbuf_len SALLOC_DEBUG_ARGS
);
1520 # define savestr(CP) savestr(CP, __FILE__, __LINE__)
1521 # define savestrbuf(CBP,CBL) savestrbuf(CBP, CBL, __FILE__, __LINE__)
1524 /* Make copy of argument incorporating old one, if set, separated by space */
1525 FL
char * save2str(char const *str
, char const *old SALLOC_DEBUG_ARGS
);
1527 # define save2str(S,O) save2str(S, O, __FILE__, __LINE__)
1531 FL
char * savecat(char const *s1
, char const *s2 SALLOC_DEBUG_ARGS
);
1533 # define savecat(S1,S2) savecat(S1, S2, __FILE__, __LINE__)
1536 /* Create duplicate, lowercasing all characters along the way */
1537 FL
char * i_strdup(char const *src SALLOC_DEBUG_ARGS
);
1539 # define i_strdup(CP) i_strdup(CP, __FILE__, __LINE__)
1542 /* Extract the protocol base and return a duplicate */
1543 FL
char * protbase(char const *cp SALLOC_DEBUG_ARGS
);
1545 # define protbase(CP) protbase(CP, __FILE__, __LINE__)
1548 /* URL en- and decoding (RFC 1738, but not really) */
1549 FL
char * urlxenc(char const *cp SALLOC_DEBUG_ARGS
);
1550 FL
char * urlxdec(char const *cp SALLOC_DEBUG_ARGS
);
1552 # define urlxenc(CP) urlxenc(CP, __FILE__, __LINE__)
1553 # define urlxdec(CP) urlxdec(CP, __FILE__, __LINE__)
1557 FL
struct str
* str_concat_csvl(struct str
*self
, ...);
1558 FL
struct str
* str_concat_cpa(struct str
*self
, char const * const *cpa
,
1559 char const *sep_o_null SALLOC_DEBUG_ARGS
);
1561 # define str_concat_cpa(S,A,N) str_concat_cpa(S, A, N, __FILE__, __LINE__)
1564 /* Plain char* support, not auto-reclaimed (unless noted) */
1566 /* Are any of the characters in the two strings the same? */
1567 FL
int anyof(char const *s1
, char const *s2
);
1569 /* Treat *iolist as a sep separated list of strings; find and return the
1570 * next entry, trimming surrounding whitespace, and point *iolist to the next
1571 * entry or to NULL if no more entries are contained. If ignore_empty is not
1572 * set empty entries are started over. Return NULL or an entry */
1573 FL
char * n_strsep(char **iolist
, char sep
, bool_t ignore_empty
);
1575 /* Copy a string, lowercasing it as we go; *size* is buffer size of *dest*;
1576 * *dest* will always be terminated unless *size* is 0 */
1577 FL
void i_strcpy(char *dest
, char const *src
, size_t size
);
1579 /* Is *as1* a valid prefix of *as2*? */
1580 FL
int is_prefix(char const *as1
, char const *as2
);
1582 /* Find the last AT @ before the first slash */
1583 FL
char const * last_at_before_slash(char const *sp
);
1585 /* Get (and isolate) the last, possibly quoted part of linebuf, set *needs_list
1586 * to indicate wether getmsglist() et al need to be called to collect
1587 * additional args that remain in linebuf. Return NULL on "error" */
1588 FL
char * laststring(char *linebuf
, bool_t
*needs_list
, bool_t strip
);
1590 /* Convert a string to lowercase, in-place and with multibyte-aware */
1591 FL
void makelow(char *cp
);
1593 /* Is *sub* a substring of *str*, case-insensitive and multibyte-aware? */
1594 FL bool_t
substr(char const *str
, char const *sub
);
1596 /* Lazy vsprintf wrapper */
1597 #ifndef HAVE_SNPRINTF
1598 FL
int snprintf(char *str
, size_t size
, char const *format
, ...);
1601 FL
char * sstpcpy(char *dst
, char const *src
);
1602 FL
char * sstrdup(char const *cp SMALLOC_DEBUG_ARGS
);
1603 FL
char * sbufdup(char const *cp
, size_t len SMALLOC_DEBUG_ARGS
);
1605 # define sstrdup(CP) sstrdup(CP, __FILE__, __LINE__)
1606 # define sbufdup(CP,L) sbufdup(CP, L, __FILE__, __LINE__)
1609 FL
char * n_strlcpy(char *dst
, char const *src
, size_t len
);
1611 /* Locale-independent character class functions */
1612 FL
int asccasecmp(char const *s1
, char const *s2
);
1613 FL
int ascncasecmp(char const *s1
, char const *s2
, size_t sz
);
1614 FL
char const * asccasestr(char const *haystack
, char const *xneedle
);
1615 FL bool_t
is_asccaseprefix(char const *as1
, char const *as2
);
1617 /* struct str related support funs */
1619 /* *self->s* is srealloc()ed */
1620 FL
struct str
* n_str_dup(struct str
*self
, struct str
const *t
1621 SMALLOC_DEBUG_ARGS
);
1623 /* *self->s* is srealloc()ed, *self->l* incremented */
1624 FL
struct str
* n_str_add_buf(struct str
*self
, char const *buf
, size_t buflen
1625 SMALLOC_DEBUG_ARGS
);
1626 #define n_str_add(S, T) n_str_add_buf(S, (T)->s, (T)->l)
1627 #define n_str_add_cp(S, CP) n_str_add_buf(S, CP, (CP) ? strlen(CP) : 0)
1630 # define n_str_dup(S,T) n_str_dup(S, T, __FILE__, __LINE__)
1631 # define n_str_add_buf(S,B,BL) n_str_add_buf(S, B, BL, __FILE__, __LINE__)
1634 /* Our iconv(3) wrappers */
1637 FL iconv_t
n_iconv_open(char const *tocode
, char const *fromcode
);
1638 /* If *cd* == *iconvd*, assigns -1 to the latter */
1639 FL
void n_iconv_close(iconv_t cd
);
1641 /* Reset encoding state */
1643 FL
void n_iconv_reset(iconv_t cd
);
1646 /* iconv(3), but return *errno* or 0; *skipilseq* forces step over illegal byte
1647 * sequences; likewise iconv_str(), but which auto-grows on E2BIG errors; *in*
1648 * and *in_rest_or_null* may be the same object.
1649 * Note: EINVAL (incomplete sequence at end of input) is NOT handled, so the
1650 * replacement character must be added manually if that happens at EOF! */
1651 FL
int n_iconv_buf(iconv_t cd
, char const **inb
, size_t *inbleft
,
1652 char **outb
, size_t *outbleft
, bool_t skipilseq
);
1653 FL
int n_iconv_str(iconv_t icp
, struct str
*out
, struct str
const *in
,
1654 struct str
*in_rest_or_null
, bool_t skipilseq
);
1662 FL
int c_thread(void *vp
);
1665 FL
int c_unthread(void *vp
);
1668 FL
struct message
* next_in_thread(struct message
*mp
);
1669 FL
struct message
* prev_in_thread(struct message
*mp
);
1670 FL
struct message
* this_in_thread(struct message
*mp
, long n
);
1672 /* Sorted mode is internally just a variant of threaded mode with all m_parent
1673 * and m_child links being NULL */
1674 FL
int c_sort(void *vp
);
1677 FL
int c_collapse(void *v
);
1678 FL
int c_uncollapse(void *v
);
1681 FL
void uncollapse1(struct message
*mp
, int always
);
1687 /* Return wether user says yes. If prompt is NULL, "Continue (y/n)? " is used
1688 * instead. If interactive, asks on STDIN, anything but [0]==[yY] is false.
1689 * If noninteractive, returns noninteract_default */
1690 FL bool_t
getapproval(char const *prompt
, bool_t noninteract_default
);
1692 /* [Yy]es or [Nn]o. Always `yes' if not interactive, always `no' on error */
1693 FL bool_t
yorn(char const *msg
);
1695 /* Get a password the expected way, return termios_state.ts_linebuf on
1696 * success or NULL on error */
1697 FL
char * getuser(char const *query
);
1699 /* Get a password the expected way, return termios_state.ts_linebuf on
1700 * success or NULL on error.
1701 * termios_state_reset() (def.h) must be called anyway */
1702 FL
char * getpassword(char const *query
);
1704 /* Get both, user and password in the expected way; simply reuses a value that
1705 * is set, otherwise calls one of the above.
1706 * Returns true only if we have a user and a password.
1707 * *user* will be savestr()ed if neither it nor *pass* have a default value
1708 * (so that termios_state.ts_linebuf carries only one) */
1709 FL bool_t
getcredentials(char **user
, char **pass
);
1711 /* Overall interactive terminal life cycle for command line editor library */
1712 #if defined HAVE_EDITLINE || defined HAVE_READLINE
1713 # define TTY_WANTS_SIGWINCH
1715 FL
void tty_init(void);
1716 FL
void tty_destroy(void);
1718 /* Rather for main.c / SIGWINCH interaction only */
1719 FL
void tty_signal(int sig
);
1721 /* Read a line after printing prompt (if set and non-empty).
1722 * If n>0 assumes that *linebuf has n bytes of default content */
1723 FL
int tty_readline(char const *prompt
, char **linebuf
,
1724 size_t *linesize
, size_t n SMALLOC_DEBUG_ARGS
);
1726 # define tty_readline(A,B,C,D) tty_readline(A, B, C, D, __FILE__, __LINE__)
1729 /* Add a line (most likely as returned by tty_readline()) to the history
1730 * (only added for real if non-empty and doesn't begin with U+0020) */
1731 FL
void tty_addhist(char const *s
);
1733 #if defined HAVE_HISTORY &&\
1734 (defined HAVE_READLINE || defined HAVE_EDITLINE || defined HAVE_NCL)
1735 FL
int c_history(void *v
);
1738 #ifndef HAVE_AMALGAMATION
1743 /* vim:set fenc=utf-8:s-it-mode */