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 /* `varshow', `define', `undefine', `call' / `~' */
89 FL
int c_varshow(void *v
);
90 FL
int c_define(void *v
);
91 FL
int c_undefine(void *v
);
92 FL
int c_call(void *v
);
94 FL
int callhook(char const *name
, int nmail
);
96 /* `account', `unaccount' */
97 FL
int c_account(void *v
);
98 FL
int c_unaccount(void *v
);
101 FL
int c_localopts(void *v
);
103 FL
void temporary_localopts_free(void); /* XXX intermediate hack */
109 /* Try to add an attachment for *file*, file_expand()ed.
110 * Return the new head of list *aphead*, or NULL.
111 * The newly created attachment will be stored in **newap*, if given */
112 FL
struct attachment
* add_attachment(struct attachment
*aphead
, char *file
,
113 struct attachment
**newap
);
115 /* Append comma-separated list of file names to the end of attachment list */
116 FL
void append_attachments(struct attachment
**aphead
, char *names
);
118 /* Interactively edit the attachment list */
119 FL
void edit_attachments(struct attachment
**aphead
);
125 /* Announce a fatal error (and die) */
126 FL
void panic(char const *format
, ...);
127 FL
void alert(char const *format
, ...);
129 /* Provide BSD-like signal() on all (POSIX) systems */
130 FL sighandler_type
safe_signal(int signum
, sighandler_type handler
);
132 /* Hold *all* signals but SIGCHLD, and release that total block again */
133 FL
void hold_all_sigs(void);
134 FL
void rele_all_sigs(void);
136 /* Hold HUP/QUIT/INT */
137 FL
void hold_sigs(void);
138 FL
void rele_sigs(void);
140 /* Not-Yet-Dead debug information (handler installation in main.c) */
142 FL
void _nyd_chirp(ui8_t act
, char const *file
, ui32_t line
,
144 FL
void _nyd_oncrash(int signo
);
146 # define NYD_ENTER _nyd_chirp(1, __FILE__, __LINE__, __FUN__)
147 # define NYD_LEAVE _nyd_chirp(2, __FILE__, __LINE__, __FUN__)
148 # define NYD _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
149 # define NYD_X _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
151 # define NYD_ENTER do {} while (0)
152 # define NYD_LEAVE do {} while (0)
153 # define NYD do {} while (0)
154 # define NYD_X do {} while (0) /* XXX LEGACY */
157 /* Touch the named message by setting its MTOUCH flag. Touched messages have
158 * the effect of not being sent back to the system mailbox on exit */
159 FL
void touch(struct message
*mp
);
161 /* Test to see if the passed file name is a directory, return true if it is */
162 FL bool_t
is_dir(char const *name
);
164 /* Count the number of arguments in the given string raw list */
165 FL
int argcount(char **argv
);
167 /* Compute screen size */
168 FL
int screensize(void);
171 FL
char const *get_pager(void);
173 /* Check wether using a pager is possible/makes sense and is desired by user
174 * (*crt* set); return number of screen lines (or *crt*) if so, 0 otherwise */
175 FL
size_t paging_seems_sensible(void);
177 /* Use a pager or STDOUT to print *fp*; if *lines* is 0, they'll be counted */
178 FL
void page_or_print(FILE *fp
, size_t lines
);
180 /* Parse name and guess at the required protocol */
181 FL
enum protocol
which_protocol(char const *name
);
183 /* Hash the passed string -- uses Chris Torek's hash algorithm */
184 FL ui32_t
torek_hash(char const *name
);
185 #define hash(S) (torek_hash(S) % HSHSIZE) /* xxx COMPAT (?) */
188 FL ui32_t
pjw(char const *cp
); /* TODO obsolete -> torek_hash() */
190 /* Find a prime greater than n */
191 FL ui32_t
nextprime(ui32_t n
);
193 /* Check wether *s is an escape sequence, expand it as necessary.
194 * Returns the expanded sequence or 0 if **s is NUL or PROMPT_STOP if it is \c.
195 * *s is advanced to after the expanded sequence (as possible).
196 * If use_prompt_extensions is set, an enum prompt_exp may be returned */
197 FL
int expand_shell_escape(char const **s
,
198 bool_t use_prompt_extensions
);
200 /* Get *prompt*, or '& ' if *bsdcompat*, of '? ' otherwise */
201 FL
char * getprompt(void);
203 /* Detect and query the hostname to use */
204 FL
char * nodename(int mayoverride
);
206 /* Try to lookup a variable named "password-*token*".
207 * Return NULL or salloc()ed buffer */
208 FL
char * lookup_password_for_token(char const *token
);
210 /* Get a (pseudo) random string of *length* bytes; returns salloc()ed buffer */
211 FL
char * getrandstring(size_t length
);
213 #define Hexchar(n) ((n)>9 ? (n)-10+'A' : (n)+'0')
214 #define hexchar(n) ((n)>9 ? (n)-10+'a' : (n)+'0')
216 /* MD5 (RFC 1321) related facilities */
218 # ifdef HAVE_OPENSSL_MD5
219 # define md5_ctx MD5_CTX
220 # define md5_init MD5_Init
221 # define md5_update MD5_Update
222 # define md5_final MD5_Final
224 # include "rfc1321.h"
227 /* Store the MD5 checksum as a hexadecimal string in *hex*, *not* terminated */
228 # define MD5TOHEX_SIZE 32
229 FL
char * md5tohex(char hex
[MD5TOHEX_SIZE
], void const *vp
);
231 /* CRAM-MD5 encode the *user* / *pass* / *b64* combo */
232 FL
char * cram_md5_string(char const *user
, char const *pass
,
235 /* RFC 2104: HMAC: Keyed-Hashing for Message Authentication.
236 * unsigned char *text: pointer to data stream
237 * int text_len : length of data stream
238 * unsigned char *key : pointer to authentication key
239 * int key_len : length of authentication key
240 * caddr_t digest : caller digest to be filled in */
241 FL
void hmac_md5(unsigned char *text
, int text_len
, unsigned char *key
,
242 int key_len
, void *digest
);
245 FL
enum okay
makedir(char const *name
);
247 /* A get-wd..restore-wd approach */
248 FL
enum okay
cwget(struct cw
*cw
);
249 FL
enum okay
cwret(struct cw
*cw
);
250 FL
void cwrelse(struct cw
*cw
);
252 /* xxx Place cp in a salloc()ed buffer, column-aligned */
253 FL
char * colalign(char const *cp
, int col
, int fill
,
254 int *cols_decr_used_or_null
);
256 /* Convert a string to a displayable one;
257 * prstr() returns the result savestr()d, prout() writes it */
258 FL
void makeprint(struct str
const *in
, struct str
*out
);
259 FL
char * prstr(char const *s
);
260 FL
int prout(char const *s
, size_t sz
, FILE *fp
);
262 /* Print out a Unicode character or a substitute for it, return 0 on error or
263 * wcwidth() (or 1) on success */
264 FL
size_t putuc(int u
, int c
, FILE *fp
);
266 /* We want coloured output (in this salloc() cycle). If pager_used is not NULL
267 * we check against *colour-pagers* wether colour is really desirable */
269 FL
void colour_table_create(char const *pager_used
);
270 FL
void colour_put(FILE *fp
, enum colourspec cs
);
271 FL
void colour_put_header(FILE *fp
, char const *name
);
272 FL
void colour_reset(FILE *fp
);
273 FL
struct str
const * colour_get(enum colourspec cs
);
275 # define colour_put(FP,CS)
276 # define colour_put_header(FP,N)
277 # define colour_reset(FP)
280 /* Update *tc* to now; only .tc_time updated unless *full_update* is true */
281 FL
void time_current_update(struct time_current
*tc
,
284 /* Memory allocation routines */
286 # define SMALLOC_DEBUG_ARGS , char const *mdbg_file, int mdbg_line
287 # define SMALLOC_DEBUG_ARGSCALL , mdbg_file, mdbg_line
289 # define SMALLOC_DEBUG_ARGS
290 # define SMALLOC_DEBUG_ARGSCALL
293 FL
void * smalloc(size_t s SMALLOC_DEBUG_ARGS
);
294 FL
void * srealloc(void *v
, size_t s SMALLOC_DEBUG_ARGS
);
295 FL
void * scalloc(size_t nmemb
, size_t size SMALLOC_DEBUG_ARGS
);
298 FL
void sfree(void *v SMALLOC_DEBUG_ARGS
);
299 /* Called by sreset(), then */
300 FL
void smemreset(void);
302 FL
int c_smemtrace(void *v
);
303 /* For immediate debugging purposes, it is possible to check on request */
305 # define _HAVE_MEMCHECK
306 FL bool_t
_smemcheck(char const *file
, int line
);
309 # define smalloc(SZ) smalloc(SZ, __FILE__, __LINE__)
310 # define srealloc(P,SZ) srealloc(P, SZ, __FILE__, __LINE__)
311 # define scalloc(N,SZ) scalloc(N, SZ, __FILE__, __LINE__)
312 # define free(P) sfree(P, __FILE__, __LINE__)
313 # define smemcheck() _smemcheck(__FILE__, __LINE__)
320 FL
int c_cmdnotsupp(void *v
);
322 /* Show header group */
323 FL
int c_headers(void *v
);
325 /* Scroll to the next/previous screen */
326 FL
int c_scroll(void *v
);
327 FL
int c_Scroll(void *v
);
329 /* Print out the headlines for each message in the passed message list */
330 FL
int c_from(void *v
);
332 /* Print all message in between and including bottom and topx if they are
333 * visible and either only_marked is false or they are MMARKed */
334 FL
void print_headers(size_t bottom
, size_t topx
, bool_t only_marked
);
336 /* Print out the value of dot */
337 FL
int c_pdot(void *v
);
339 /* Paginate messages, honor/don't honour ignored fields, respectively */
340 FL
int c_more(void *v
);
341 FL
int c_More(void *v
);
343 /* Type out messages, honor/don't honour ignored fields, respectively */
344 FL
int c_type(void *v
);
345 FL
int c_Type(void *v
);
347 /* Show MIME-encoded message text, including all fields */
348 FL
int c_show(void *v
);
350 /* Pipe messages, honor/don't honour ignored fields, respectively */
351 FL
int c_pipe(void *v
);
352 FL
int c_Pipe(void *v
);
354 /* Print the top so many lines of each desired message.
355 * The number of lines is taken from *toplines* and defaults to 5 */
356 FL
int c_top(void *v
);
358 /* Touch all the given messages so that they will get mboxed */
359 FL
int c_stouch(void *v
);
361 /* Make sure all passed messages get mboxed */
362 FL
int c_mboxit(void *v
);
364 /* List the folders the user currently has */
365 FL
int c_folders(void *v
);
371 /* If any arguments were given, go to the next applicable argument following
372 * dot, otherwise, go to the next applicable message. If given as first
373 * command with no arguments, print first message */
374 FL
int c_next(void *v
);
376 /* Save a message in a file. Mark the message as saved so we can discard when
378 FL
int c_save(void *v
);
379 FL
int c_Save(void *v
);
381 /* Copy a message to a file without affected its saved-ness */
382 FL
int c_copy(void *v
);
383 FL
int c_Copy(void *v
);
385 /* Move a message to a file */
386 FL
int c_move(void *v
);
387 FL
int c_Move(void *v
);
389 /* Decrypt and copy a message to a file */
390 FL
int c_decrypt(void *v
);
391 FL
int c_Decrypt(void *v
);
393 /* Write the indicated messages at the end of the passed file name, minus
394 * header and trailing blank line. This is the MIME save function */
395 FL
int c_write(void *v
);
397 /* Delete messages */
398 FL
int c_delete(void *v
);
400 /* Delete messages, then type the new dot */
401 FL
int c_deltype(void *v
);
403 /* Undelete the indicated messages */
404 FL
int c_undelete(void *v
);
406 /* Add the given header fields to the retained list. If no arguments, print
407 * the current list of retained fields */
408 FL
int c_retfield(void *v
);
410 /* Add the given header fields to the ignored list. If no arguments, print the
411 * current list of ignored fields */
412 FL
int c_igfield(void *v
);
414 FL
int c_saveretfield(void *v
);
415 FL
int c_saveigfield(void *v
);
416 FL
int c_fwdretfield(void *v
);
417 FL
int c_fwdigfield(void *v
);
418 FL
int c_unignore(void *v
);
419 FL
int c_unretain(void *v
);
420 FL
int c_unsaveignore(void *v
);
421 FL
int c_unsaveretain(void *v
);
422 FL
int c_unfwdignore(void *v
);
423 FL
int c_unfwdretain(void *v
);
429 /* Process a shell escape by saving signals, ignoring signals and a sh -c */
430 FL
int c_shell(void *v
);
432 /* Fork an interactive shell */
433 FL
int c_dosh(void *v
);
435 /* Show the help screen */
436 FL
int c_help(void *v
);
438 /* Print user's working directory */
439 FL
int c_cwd(void *v
);
441 /* Change user's working directory */
442 FL
int c_chdir(void *v
);
444 FL
int c_respond(void *v
);
445 FL
int c_respondall(void *v
);
446 FL
int c_respondsender(void *v
);
447 FL
int c_Respond(void *v
);
448 FL
int c_followup(void *v
);
449 FL
int c_followupall(void *v
);
450 FL
int c_followupsender(void *v
);
451 FL
int c_Followup(void *v
);
453 /* The 'forward' command */
454 FL
int c_forward(void *v
);
456 /* Similar to forward, saving the message in a file named after the first
458 FL
int c_Forward(void *v
);
460 /* Resend a message list to a third person */
461 FL
int c_resend(void *v
);
463 /* Resend a message list to a third person without adding headers */
464 FL
int c_Resend(void *v
);
466 /* Preserve messages, so that they will be sent back to the system mailbox */
467 FL
int c_preserve(void *v
);
469 /* Mark all given messages as unread */
470 FL
int c_unread(void *v
);
472 /* Mark all given messages as read */
473 FL
int c_seen(void *v
);
475 /* Print the size of each message */
476 FL
int c_messize(void *v
);
478 /* Quit quickly. If sourcing, just pop the input level by returning error */
479 FL
int c_rexit(void *v
);
481 /* Set or display a variable value. Syntax is similar to that of sh */
482 FL
int c_set(void *v
);
484 /* Unset a bunch of variable values */
485 FL
int c_unset(void *v
);
487 /* Put add users to a group */
488 FL
int c_group(void *v
);
490 /* Delete the passed groups */
491 FL
int c_ungroup(void *v
);
493 /* Change to another file. With no argument, print info about current file */
494 FL
int c_file(void *v
);
496 /* Expand file names like echo */
497 FL
int c_echo(void *v
);
499 /* if.else.endif conditional execution.
500 * condstack_isskip() returns wether the current condition state doesn't allow
501 * execution of commands.
502 * condstack_release() and condstack_take() are used when sourcing files, they
503 * rotate the current condition stack; condstack_take() returns a false boolean
504 * if the current condition stack has unclosed conditionals */
505 FL
int c_if(void *v
);
506 FL
int c_else(void *v
);
507 FL
int c_endif(void *v
);
508 FL bool_t
condstack_isskip(void);
509 FL
void * condstack_release(void);
510 FL bool_t
condstack_take(void *self
);
512 /* Set the list of alternate names */
513 FL
int c_alternates(void *v
);
515 /* 'newmail' command: Check for new mail without writing old mail back */
516 FL
int c_newmail(void *v
);
519 FL
int c_shortcut(void *v
);
520 FL
struct shortcut
*get_shortcut(char const *str
);
521 FL
int c_unshortcut(void *v
);
523 /* Message flag manipulation */
524 FL
int c_flag(void *v
);
525 FL
int c_unflag(void *v
);
526 FL
int c_answered(void *v
);
527 FL
int c_unanswered(void *v
);
528 FL
int c_draft(void *v
);
529 FL
int c_undraft(void *v
);
532 FL
int c_noop(void *v
);
535 FL
int c_remove(void *v
);
538 FL
int c_rename(void *v
);
544 FL
FILE * collect(struct header
*hp
, int printheaders
, struct message
*mp
,
545 char *quotefile
, int doprefix
);
547 FL
void savedeadletter(FILE *fp
, int fflush_rewind_first
);
553 FL
int fcntl_lock(int fd
, enum flock_type ft
);
554 FL
int dot_lock(char const *fname
, int fd
, int pollinterval
, FILE *fp
,
556 FL
void dot_unlock(char const *fname
);
562 /* Edit a message list */
563 FL
int c_editor(void *v
);
565 /* Invoke the visual editor on a message list */
566 FL
int c_visual(void *v
);
568 /* Run an editor on the file at fp of size bytes, and return a new file.
569 * Signals must be handled by the caller. viored is 'e' for ed, 'v' for vi */
570 FL
FILE * run_editor(FILE *fp
, off_t size
, int viored
, int readonly
,
571 struct header
*hp
, struct message
*mp
,
572 enum sendaction action
, sighandler_type oldint
);
579 FL
struct quoteflt
* quoteflt_dummy(void); /* TODO LEGACY */
580 FL
void quoteflt_init(struct quoteflt
*self
, char const *prefix
);
581 FL
void quoteflt_destroy(struct quoteflt
*self
);
582 FL
void quoteflt_reset(struct quoteflt
*self
, FILE *f
);
583 FL ssize_t
quoteflt_push(struct quoteflt
*self
, char const *dat
,
585 FL ssize_t
quoteflt_flush(struct quoteflt
*self
);
591 /* fgets() replacement to handle lines of arbitrary size and with embedded \0
593 * line - line buffer. *line may be NULL.
594 * linesize - allocated size of line buffer.
595 * count - maximum characters to read. May be NULL.
596 * llen - length_of_line(*line).
598 * appendnl - always terminate line with \n, append if necessary.
600 FL
char * fgetline(char **line
, size_t *linesize
, size_t *count
,
601 size_t *llen
, FILE *fp
, int appendnl SMALLOC_DEBUG_ARGS
);
603 # define fgetline(A,B,C,D,E,F) \
604 fgetline(A, B, C, D, E, F, __FILE__, __LINE__)
607 /* Read up a line from the specified input into the linebuffer.
608 * Return the number of characters read. Do not include the newline at EOL.
609 * n is the number of characters already read */
610 FL
int readline_restart(FILE *ibuf
, char **linebuf
, size_t *linesize
,
611 size_t n SMALLOC_DEBUG_ARGS
);
613 # define readline_restart(A,B,C,D) \
614 readline_restart(A, B, C, D, __FILE__, __LINE__)
617 /* Read a complete line of input, with editing if interactive and possible.
618 * If prompt is NULL we'll call getprompt() first, if necessary.
619 * nl_escape defines wether user can escape newlines via backslash (POSIX).
620 * If string is set it is used as the initial line content if in interactive
621 * mode, otherwise this argument is ignored for reproducibility.
622 * Return number of octets or a value <0 on error */
623 FL
int readline_input(char const *prompt
, bool_t nl_escape
,
624 char **linebuf
, size_t *linesize
, char const *string
627 # define readline_input(A,B,C,D,E) readline_input(A,B,C,D,E,__FILE__,__LINE__)
630 /* Read a line of input, with editing if interactive and possible, return it
631 * savestr()d or NULL in case of errors or if an empty line would be returned.
632 * This may only be called from toplevel (not during sourcing).
633 * If prompt is NULL we'll call getprompt() if necessary.
634 * If string is set it is used as the initial line content if in interactive
635 * mode, otherwise this argument is ignored for reproducibility */
636 FL
char * readstr_input(char const *prompt
, char const *string
);
638 /* Set up the input pointers while copying the mail file into /tmp */
639 FL
void setptr(FILE *ibuf
, off_t offset
);
641 /* Drop the passed line onto the passed output buffer. If a write error occurs
642 * return -1, else the count of characters written, including the newline */
643 FL
int putline(FILE *obuf
, char *linebuf
, size_t count
);
645 /* Return a file buffer all ready to read up the passed message pointer */
646 FL
FILE * setinput(struct mailbox
*mp
, struct message
*m
,
649 /* Reset (free) the global message array */
650 FL
void message_reset(void);
652 /* Append the passed message descriptor onto the message array; if mp is NULL,
653 * NULLify the entry at &[msgCount-1] */
654 FL
void message_append(struct message
*mp
);
656 /* Check wether sep->ss_sexpr (or ->ss_reexpr) matches mp. If with_headers is
657 * true then the headers will also be searched (as plain text) */
658 FL bool_t
message_match(struct message
*mp
, struct search_expr
const *sep
,
659 bool_t with_headers
);
661 FL
struct message
* setdot(struct message
*mp
);
663 /* Delete a file, but only if the file is a plain file */
664 FL
int rm(char const *name
);
666 /* Determine the size of the file possessed by the passed buffer */
667 FL off_t
fsize(FILE *iob
);
669 /* Evaluate the string given as a new mailbox name. Supported meta characters:
670 * % for my system mail box
671 * %user for user's system mail box
672 * # for previous file
673 * & invoker's mbox file
674 * +file file in folder directory
675 * any shell meta character
676 * Returns the file name as an auto-reclaimed string */
677 FL
char * fexpand(char const *name
, enum fexp_mode fexpm
);
679 #define expand(N) fexpand(N, FEXP_FULL) /* XXX obsolete */
680 #define file_expand(N) fexpand(N, FEXP_LOCAL) /* XXX obsolete */
682 /* Get rid of queued mail */
683 FL
void demail(void);
685 /* acmava.c hook: *folder* variable has been updated; if folder shouldn't be
686 * replaced by something else leave store alone, otherwise smalloc() the
687 * desired value (ownership will be taken) */
688 FL bool_t
var_folder_updated(char const *folder
, char **store
);
690 /* Determine the current *folder* name, store it in *name* */
691 FL bool_t
getfold(char *name
, size_t size
);
693 /* Return the name of the dead.letter file */
694 FL
char const * getdeadletter(void);
696 FL
enum okay
get_body(struct message
*mp
);
700 FL
int sclose(struct sock
*sp
);
701 FL
enum okay
swrite(struct sock
*sp
, char const *data
);
702 FL
enum okay
swrite1(struct sock
*sp
, char const *data
, int sz
,
704 FL
enum okay
sopen(char const *xserver
, struct sock
*sp
, int use_ssl
,
705 char const *uhp
, char const *portstr
);
708 FL
int sgetline(char **line
, size_t *linesize
, size_t *linelen
,
709 struct sock
*sp SMALLOC_DEBUG_ARGS
);
711 # define sgetline(A,B,C,D) sgetline(A, B, C, D, __FILE__, __LINE__)
713 #endif /* HAVE_SOCKETS */
715 /* Deal with loading of resource files and dealing with a stack of files for
716 * the source command */
718 /* Load a file of user definitions */
719 FL
void load(char const *name
);
721 /* Pushdown current input file and switch to a new one. Set the global flag
722 * *sourcing* so that others will realize that they are no longer reading from
723 * a tty (in all probability) */
724 FL
int c_source(void *v
);
726 /* Pop the current input back to the previous level. Update the *sourcing*
727 * flag as appropriate */
728 FL
int unstack(void);
734 /* Return the user's From: address(es) */
735 FL
char const * myaddrs(struct header
*hp
);
737 /* Boil the user's From: addresses down to a single one, or use *sender* */
738 FL
char const * myorigin(struct header
*hp
);
740 /* See if the passed line buffer, which may include trailing newline (sequence)
741 * is a mail From_ header line according to RFC 4155 */
742 FL
int is_head(char const *linebuf
, size_t linelen
);
744 /* Savage extract date field from From_ line. linelen is convenience as line
745 * must be terminated (but it may end in a newline [sequence]).
746 * Return wether the From_ line was parsed successfully */
747 FL
int extract_date_from_from_(char const *line
, size_t linelen
,
748 char datebuf
[FROM_DATEBUF
]);
750 /* Fill in / reedit the desired header fields */
751 FL
int grab_headers(struct header
*hp
, enum gfield gflags
,
754 FL
void extract_header(FILE *fp
, struct header
*hp
);
756 /* Return the desired header line from the passed message
757 * pointer (or NULL if the desired header field is not available).
758 * If mult is zero, return the content of the first matching header
759 * field only, the content of all matching header fields else */
760 FL
char * hfield_mult(char const *field
, struct message
*mp
, int mult
);
761 #define hfieldX(a, b) hfield_mult(a, b, 1)
762 #define hfield1(a, b) hfield_mult(a, b, 0)
764 /* Check whether the passed line is a header line of the desired breed.
765 * Return the field body, or 0 */
766 FL
char const * thisfield(char const *linebuf
, char const *field
);
768 /* Get sender's name from this message. If the message has a bunch of arpanet
769 * stuff in it, we may have to skin the name before returning it */
770 FL
char * nameof(struct message
*mp
, int reptype
);
772 /* Start of a "comment". Ignore it */
773 FL
char const * skip_comment(char const *cp
);
775 /* Return the start of a route-addr (address in angle brackets), if present */
776 FL
char const * routeaddr(char const *name
);
778 /* Check if a name's address part contains invalid characters */
779 FL
int is_addr_invalid(struct name
*np
, int putmsg
);
781 /* Does *NP* point to a file or pipe addressee? */
782 #define is_fileorpipe_addr(NP) \
783 (((NP)->n_flags & NAME_ADDRSPEC_ISFILEORPIPE) != 0)
785 /* Return skinned version of *NP*s name */
786 #define skinned_name(NP) \
787 (assert((NP)->n_flags & NAME_SKINNED), \
788 ((struct name const*)NP)->n_name)
790 /* Skin an address according to the RFC 822 interpretation of "host-phrase" */
791 FL
char * skin(char const *name
);
793 /* Skin *name* and extract the *addr-spec* according to RFC 5322.
794 * Store the result in .ag_skinned and also fill in those .ag_ fields that have
795 * actually been seen.
796 * Return 0 if something good has been parsed, 1 if fun didn't exactly know how
797 * to deal with the input, or if that was plain invalid */
798 FL
int addrspec_with_guts(int doskin
, char const *name
,
799 struct addrguts
*agp
);
801 /* Fetch the real name from an internet mail address field */
802 FL
char * realname(char const *name
);
804 /* Fetch the sender's name from the passed message. reptype can be
805 * 0 -- get sender's name for display purposes
806 * 1 -- get sender's name for reply
807 * 2 -- get sender's name for Reply */
808 FL
char * name1(struct message
*mp
, int reptype
);
810 FL
int msgidcmp(char const *s1
, char const *s2
);
812 /* See if the given header field is supposed to be ignored */
813 FL
int is_ign(char const *field
, size_t fieldlen
,
814 struct ignoretab ignore
[2]);
816 FL
int member(char const *realfield
, struct ignoretab
*table
);
818 /* Fake Sender for From_ lines if missing, e. g. with POP3 */
819 FL
char const * fakefrom(struct message
*mp
);
821 FL
char const * fakedate(time_t t
);
823 /* From username Fri Jan 2 20:13:51 2004
826 FL
time_t unixtime(char const *from
);
828 FL
time_t rfctime(char const *date
);
830 FL
time_t combinetime(int year
, int month
, int day
,
831 int hour
, int minute
, int second
);
833 FL
void substdate(struct message
*m
);
835 FL
int check_from_and_sender(struct name
*fromfield
,
836 struct name
*senderfield
);
838 FL
char * getsender(struct message
*m
);
845 FL
char const * imap_fileof(char const *xcp
);
846 FL
enum okay
imap_noop(void);
847 FL
enum okay
imap_select(struct mailbox
*mp
, off_t
*size
, int *count
,
849 FL
int imap_setfile(const char *xserver
, int nmail
, int isedit
);
850 FL
enum okay
imap_header(struct message
*m
);
851 FL
enum okay
imap_body(struct message
*m
);
852 FL
void imap_getheaders(int bot
, int top
);
853 FL
void imap_quit(void);
854 FL
enum okay
imap_undelete(struct message
*m
, int n
);
855 FL
enum okay
imap_unread(struct message
*m
, int n
);
856 FL
int c_imap_imap(void *vp
);
857 FL
int imap_newmail(int nmail
);
858 FL
enum okay
imap_append(const char *xserver
, FILE *fp
);
859 FL
void imap_folders(const char *name
, int strip
);
860 FL
enum okay
imap_copy(struct message
*m
, int n
, const char *name
);
861 # ifdef HAVE_IMAP_SEARCH
862 FL
enum okay
imap_search1(const char *spec
, int f
);
864 FL
int imap_thisaccount(const char *cp
);
865 FL
enum okay
imap_remove(const char *name
);
866 FL
enum okay
imap_rename(const char *old
, const char *new);
867 FL
enum okay
imap_dequeue(struct mailbox
*mp
, FILE *fp
);
868 FL
int c_connect(void *vp
);
869 FL
int c_disconnect(void *vp
);
870 FL
int c_cache(void *vp
);
871 FL
int disconnected(const char *file
);
872 FL
void transflags(struct message
*omessage
, long omsgCount
,
874 FL
time_t imap_read_date_time(const char *cp
);
875 FL
const char * imap_make_date_time(time_t t
);
877 # define c_imap_imap c_cmdnotsupp
878 # define c_connect c_cmdnotsupp
879 # define c_disconnect c_cmdnotsupp
880 # define c_cache c_cmdnotsupp
883 #if defined HAVE_IMAP || defined HAVE_IMAP_SEARCH
884 FL
char * imap_quotestr(char const *s
);
885 FL
char * imap_unquotestr(char const *s
);
893 FL
enum okay
getcache1(struct mailbox
*mp
, struct message
*m
,
894 enum needspec need
, int setflags
);
895 FL
enum okay
getcache(struct mailbox
*mp
, struct message
*m
,
897 FL
void putcache(struct mailbox
*mp
, struct message
*m
);
898 FL
void initcache(struct mailbox
*mp
);
899 FL
void purgecache(struct mailbox
*mp
, struct message
*m
, long mc
);
900 FL
void delcache(struct mailbox
*mp
, struct message
*m
);
901 FL
enum okay
cache_setptr(int transparent
);
902 FL
enum okay
cache_list(struct mailbox
*mp
, char const *base
, int strip
,
904 FL
enum okay
cache_remove(char const *name
);
905 FL
enum okay
cache_rename(char const *old
, char const *new);
906 FL
unsigned long cached_uidvalidity(struct mailbox
*mp
);
907 FL
FILE * cache_queue(struct mailbox
*mp
);
908 FL
enum okay
cache_dequeue(struct mailbox
*mp
);
909 #endif /* HAVE_IMAP */
915 #ifdef HAVE_IMAP_SEARCH
916 FL
enum okay
imap_search(char const *spec
, int f
);
923 /* Set up editing on the given file name.
924 * If the first character of name is %, we are considered to be editing the
925 * file, otherwise we are reading our mail which has signficance for mbox and
926 * so forth. nmail: Check for new mail in the current folder only */
927 FL
int setfile(char const *name
, int nmail
);
929 FL
int newmailinfo(int omsgCount
);
931 /* Interpret user commands. If standard input is not a tty, print no prompt */
932 FL
void commands(void);
934 /* Evaluate a single command.
935 * .ev_add_history and .ev_new_content will be updated upon success.
936 * Command functions return 0 for success, 1 for error, and -1 for abort.
937 * 1 or -1 aborts a load or source, a -1 aborts the interactive command loop */
938 FL
int evaluate(struct eval_ctx
*evp
);
939 /* TODO drop execute() is the legacy version of evaluate().
940 * Contxt is non-zero if called while composing mail */
941 FL
int execute(char *linebuf
, int contxt
, size_t linesize
);
943 /* Set the size of the message vector used to construct argument lists to
944 * message list functions */
945 FL
void setmsize(int sz
);
947 /* Logic behind -H / -L invocations */
948 FL
void print_header_summary(char const *Larg
);
950 /* The following gets called on receipt of an interrupt. This is to abort
951 * printout of a command, mainly. Dispatching here when command() is inactive
952 * crashes rcv. Close all open files except 0, 1, 2, and the temporary. Also,
953 * unstack all source files */
954 FL
void onintr(int s
);
956 /* Announce the presence of the current Mail version, give the message count,
957 * and print a header listing */
958 FL
void announce(int printheaders
);
960 /* Announce information about the file we are editing. Return a likely place
962 FL
int newfileinfo(void);
964 FL
int getmdot(int nmail
);
966 FL
void initbox(char const *name
);
968 /* Print the docstring of `comm', which may be an abbreviation.
969 * Return FAL0 if there is no such command */
970 #ifdef HAVE_DOCSTRINGS
971 FL bool_t
print_comm_docstr(char const *comm
);
978 /* Convert user string of message numbers and store the numbers into vector.
979 * Returns the count of messages picked up or -1 on error */
980 FL
int getmsglist(char *buf
, int *vector
, int flags
);
982 /* Scan out the list of string arguments, shell style for a RAWLIST */
983 FL
int getrawlist(char const *line
, size_t linesize
,
984 char **argv
, int argc
, int echolist
);
986 /* Find the first message whose flags&m==f and return its message number */
987 FL
int first(int f
, int m
);
989 /* Mark the named message by setting its mark bit */
990 FL
void mark(int mesg
, int f
);
992 /* lzw.c TODO drop */
994 FL
int zwrite(void *cookie
, const char *wbp
, int num
);
995 FL
int zfree(void *cookie
);
996 FL
int zread(void *cookie
, char *rbp
, int num
);
997 FL
void * zalloc(FILE *fp
);
998 #endif /* HAVE_IMAP */
1004 FL
int maildir_setfile(char const *name
, int nmail
, int isedit
);
1006 FL
void maildir_quit(void);
1008 FL
enum okay
maildir_append(char const *name
, FILE *fp
);
1010 FL
enum okay
maildir_remove(char const *name
);
1016 /* *charset-7bit*, else CHARSET_7BIT */
1017 FL
char const * charset_get_7bit(void);
1019 /* *charset-8bit*, else CHARSET_8BIT */
1021 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; *a_charset_to_try_first* may be
1028 * used to prepend a charset to this list (e.g., for *reply-in-same-charset*).
1029 * The returned boolean indicates charset_iter_is_valid().
1030 * Without HAVE_ICONV, this "iterates" over charset_get_lc() only */
1031 FL bool_t
charset_iter_reset(char const *a_charset_to_try_first
);
1032 FL bool_t
charset_iter_next(void);
1033 FL bool_t
charset_iter_is_valid(void);
1034 FL
char const * charset_iter(void);
1036 FL
void charset_iter_recurse(char *outer_storage
[2]); /* TODO LEGACY */
1037 FL
void charset_iter_restore(char *outer_storage
[2]); /* TODO LEGACY */
1040 FL
char const * need_hdrconv(struct header
*hp
, enum gfield w
);
1043 /* Get the mime encoding from a Content-Transfer-Encoding header field */
1044 FL
enum mimeenc
mime_getenc(char *h
);
1046 /* Get a mime style parameter from a header line */
1047 FL
char * mime_getparam(char const *param
, char *h
);
1049 /* Get the boundary out of a Content-Type: multipart/xyz header field, return
1050 * salloc()ed copy of it; store strlen() in *len if set */
1051 FL
char * mime_get_boundary(char *h
, size_t *len
);
1053 /* Create a salloc()ed MIME boundary */
1054 FL
char * mime_create_boundary(void);
1056 /* Classify content of *fp* as necessary and fill in arguments; **charset* is
1057 * left alone unless it's non-NULL */
1058 FL
int mime_classify_file(FILE *fp
, char const **contenttype
,
1059 char const **charset
, int *do_iconv
);
1062 FL
enum mimecontent
mime_classify_content_of_part(struct mimepart
const *mip
);
1064 /* Return the Content-Type matching the extension of name */
1065 FL
char * mime_classify_content_type_by_fileext(char const *name
);
1067 /* "mimetypes" command */
1068 FL
int c_mimetypes(void *v
);
1070 /* Convert header fields from RFC 1522 format */
1071 FL
void mime_fromhdr(struct str
const *in
, struct str
*out
,
1072 enum tdflags flags
);
1074 /* Interpret MIME strings in parts of an address field */
1075 FL
char * mime_fromaddr(char const *name
);
1077 /* fwrite(3) performing the given MIME conversion */
1078 FL ssize_t
mime_write(char const *ptr
, size_t size
, FILE *f
,
1079 enum conversion convert
, enum tdflags dflags
,
1080 struct quoteflt
*qf
, struct str
*rest
);
1081 FL ssize_t
xmime_write(char const *ptr
, size_t size
, /* TODO LEGACY */
1082 FILE *f
, enum conversion convert
, enum tdflags dflags
,
1087 * Content-Transfer-Encodings as defined in RFC 2045:
1088 * - Quoted-Printable, section 6.7
1089 * - Base64, section 6.8
1092 /* How many characters of (the complete body) ln need to be quoted */
1093 FL
size_t mime_cte_mustquote(char const *ln
, size_t lnlen
, bool_t ishead
);
1095 /* How much space is necessary to encode len bytes in QP, worst case.
1096 * Includes room for terminator */
1097 FL
size_t qp_encode_calc_size(size_t len
);
1099 /* If flags includes QP_ISHEAD these assume "word" input and use special
1100 * quoting rules in addition; soft line breaks are not generated.
1101 * Otherwise complete input lines are assumed and soft line breaks are
1102 * generated as necessary */
1103 FL
struct str
* qp_encode(struct str
*out
, struct str
const *in
,
1104 enum qpflags flags
);
1106 FL
struct str
* qp_encode_cp(struct str
*out
, char const *cp
,
1107 enum qpflags flags
);
1108 FL
struct str
* qp_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
1109 enum qpflags flags
);
1112 /* If rest is set then decoding will assume body text input (assumes input
1113 * represents lines, only create output when input didn't end with soft line
1114 * break [except it finalizes an encoded CRLF pair]), otherwise it is assumed
1115 * to decode a header strings and (1) uses special decoding rules and (b)
1116 * directly produces output.
1117 * The buffers of out and possibly rest will be managed via srealloc().
1118 * Returns OKAY. XXX or STOP on error (in which case out is set to an error
1119 * XXX message); caller is responsible to free buffers */
1120 FL
int qp_decode(struct str
*out
, struct str
const *in
,
1123 /* How much space is necessary to encode len bytes in Base64, worst case.
1124 * Includes room for (CR/LF/CRLF and) terminator */
1125 FL
size_t b64_encode_calc_size(size_t len
);
1127 /* Note these simply convert all the input (if possible), including the
1128 * insertion of NL sequences if B64_CRLF or B64_LF is set (and multiple thereof
1129 * if B64_MULTILINE is set).
1130 * Thus, in the B64_BUF case, better call b64_encode_calc_size() first */
1131 FL
struct str
* b64_encode(struct str
*out
, struct str
const *in
,
1132 enum b64flags flags
);
1133 FL
struct str
* b64_encode_cp(struct str
*out
, char const *cp
,
1134 enum b64flags flags
);
1135 FL
struct str
* b64_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
1136 enum b64flags flags
);
1138 /* If rest is set then decoding will assume text input.
1139 * The buffers of out and possibly rest will be managed via srealloc().
1140 * Returns OKAY or STOP on error (in which case out is set to an error
1141 * message); caller is responsible to free buffers */
1142 FL
int b64_decode(struct str
*out
, struct str
const *in
,
1149 /* Allocate a single element of a name list, initialize its name field to the
1150 * passed name and return it */
1151 FL
struct name
* nalloc(char *str
, enum gfield ntype
);
1153 /* Like nalloc(), but initialize from content of np */
1154 FL
struct name
* ndup(struct name
*np
, enum gfield ntype
);
1156 /* Concatenate the two passed name lists, return the result */
1157 FL
struct name
* cat(struct name
*n1
, struct name
*n2
);
1159 /* Determine the number of undeleted elements in a name list and return it */
1160 FL ui32_t
count(struct name
const *np
);
1162 /* Extract a list of names from a line, and make a list of names from it.
1163 * Return the list or NULL if none found */
1164 FL
struct name
* extract(char const *line
, enum gfield ntype
);
1166 /* Like extract() unless line contains anyof ",\"\\(<|", in which case
1167 * comma-separated list extraction is used instead */
1168 FL
struct name
* lextract(char const *line
, enum gfield ntype
);
1170 /* Turn a list of names into a string of the same names */
1171 FL
char * detract(struct name
*np
, enum gfield ntype
);
1173 /* Get a lextract() list via readstr_input(), reassigning to *np* */
1174 FL
struct name
* grab_names(char const *field
, struct name
*np
, int comma
,
1175 enum gfield gflags
);
1177 /* Check all addresses in np and delete invalid ones */
1178 FL
struct name
* checkaddrs(struct name
*np
);
1180 /* Map all of the aliased users in the invoker's mailrc file and insert them
1182 FL
struct name
* usermap(struct name
*names
, bool_t force_metoo
);
1184 /* Remove all of the duplicates from the passed name list by insertion sorting
1185 * them, then checking for dups. Return the head of the new list */
1186 FL
struct name
* elide(struct name
*names
);
1188 FL
struct name
* delete_alternates(struct name
*np
);
1190 FL
int is_myname(char const *name
);
1192 /* Dispatch a message to all pipe and file addresses TODO -> sendout.c */
1193 FL
struct name
* outof(struct name
*names
, FILE *fo
, struct header
*hp
,
1196 /* Handling of alias groups */
1198 /* Locate a group name and return it */
1199 FL
struct grouphead
* findgroup(char *name
);
1201 /* Print a group out on stdout */
1202 FL
void printgroup(char *name
);
1204 FL
void remove_group(char const *name
);
1212 FL
enum okay
ssl_open(char const *server
, struct sock
*sp
, char const *uhp
);
1215 FL
void ssl_gen_err(char const *fmt
, ...);
1218 FL
int c_verify(void *vp
);
1221 FL
FILE * smime_sign(FILE *ip
, struct header
*);
1224 FL
FILE * smime_encrypt(FILE *ip
, char const *certfile
, char const *to
);
1226 FL
struct message
* smime_decrypt(struct message
*m
, char const *to
,
1227 char const *cc
, int signcall
);
1230 FL
enum okay
smime_certsave(struct message
*m
, int n
, FILE *op
);
1232 #else /* HAVE_OPENSSL */
1233 # define c_verify c_cmdnotsupp
1242 FL
enum okay
pop3_noop(void);
1245 FL
int pop3_setfile(char const *server
, int nmail
, int isedit
);
1248 FL
enum okay
pop3_header(struct message
*m
);
1251 FL
enum okay
pop3_body(struct message
*m
);
1254 FL
void pop3_quit(void);
1255 #endif /* HAVE_POP3 */
1259 * Subprocesses, popen, but also file handling with registering
1262 /* For program startup in main.c: initialize process manager */
1263 FL
void command_manager_start(void);
1265 /* Notes: OF_CLOEXEC is implied in oflags, xflags may be NULL */
1266 FL
FILE * safe_fopen(char const *file
, char const *oflags
, int *xflags
);
1268 /* Notes: OF_CLOEXEC|OF_REGISTER are implied in oflags */
1269 FL
FILE * Fopen(char const *file
, char const *oflags
);
1271 FL
FILE * Fdopen(int fd
, char const *oflags
);
1273 FL
int Fclose(FILE *fp
);
1275 FL
FILE * Zopen(char const *file
, char const *oflags
, int *compression
);
1277 /* Create a temporary file in tempdir, use prefix for its name, store the
1278 * unique name in fn (unless OF_UNLINK is set in oflags), and return a stdio
1279 * FILE pointer with access oflags. OF_CLOEXEC is implied in oflags.
1280 * mode specifies the access mode of the newly created temporary file */
1281 FL
FILE * Ftmp(char **fn
, char const *prefix
, enum oflags oflags
,
1284 /* If OF_HOLDSIGS was set when calling Ftmp(), then hold_all_sigs() had been
1285 * called: call this to unlink(2) and free *fn and to rele_all_sigs() */
1286 FL
void Ftmp_release(char **fn
);
1288 /* Free the resources associated with the given filename. To be called after
1290 FL
void Ftmp_free(char **fn
);
1292 /* Create a pipe and ensure CLOEXEC bit is set in both descriptors */
1293 FL bool_t
pipe_cloexec(int fd
[2]);
1295 FL
FILE * Popen(char const *cmd
, char const *mode
, char const *shell
,
1298 FL bool_t
Pclose(FILE *ptr
, bool_t dowait
);
1300 FL
void close_all_files(void);
1302 /* Run a command without a shell, with optional arguments and splicing of stdin
1303 * and stdout. The command name can be a sequence of words. Signals must be
1304 * handled by the caller. "Mask" contains the signals to ignore in the new
1305 * process. SIGINT is enabled unless it's in the mask */
1306 FL
int run_command(char const *cmd
, sigset_t
*mask
, int infd
,
1307 int outfd
, char const *a0
, char const *a1
, char const *a2
);
1309 FL
int start_command(char const *cmd
, sigset_t
*mask
, int infd
,
1310 int outfd
, char const *a0
, char const *a1
, char const *a2
);
1312 FL
void prepare_child(sigset_t
*nset
, int infd
, int outfd
);
1314 /* Mark a child as don't care */
1315 FL
void free_child(int pid
);
1317 /* Wait for pid, return wether we've had a normal EXIT_SUCCESS exit.
1318 * If wait_status is set, set it to the reported waitpid(2) wait status */
1319 FL bool_t
wait_child(int pid
, int *wait_status
);
1325 /* The `quit' command */
1326 FL
int c_quit(void *v
);
1328 /* Save all of the undetermined messages at the top of "mbox". Save all
1329 * untouched messages back in the system mailbox. Remove the system mailbox,
1330 * if none saved there */
1333 /* Adjust the message flags in each message */
1334 FL
int holdbits(void);
1336 /* Create another temporary file and copy user's mbox file darin. If there is
1337 * no mbox, copy nothing. If he has specified "append" don't copy his mailbox,
1338 * just copy saveable entries at the end */
1339 FL
enum okay
makembox(void);
1341 FL
void save_mbox_for_possible_quitstuff(void); /* TODO DROP IF U CAN */
1343 FL
int savequitflags(void);
1345 FL
void restorequitflags(int);
1351 /* Send message described by the passed pointer to the passed output buffer.
1352 * Return -1 on error. Adjust the status: field if need be. If doign is
1353 * given, suppress ignored header fields. prefix is a string to prepend to
1354 * each output line. action = data destination
1355 * (SEND_MBOX,_TOFILE,_TODISP,_QUOTE,_DECRYPT). stats[0] is line count,
1356 * stats[1] is character count. stats may be NULL. Note that stats[0] is
1357 * valid for SEND_MBOX only */
1358 FL
int sendmp(struct message
*mp
, FILE *obuf
, struct ignoretab
*doign
,
1359 char const *prefix
, enum sendaction action
, off_t
*stats
);
1365 /* Interface between the argument list and the mail1 routine which does all the
1367 FL
int mail(struct name
*to
, struct name
*cc
, struct name
*bcc
,
1368 char *subject
, struct attachment
*attach
, char *quotefile
,
1369 int recipient_record
);
1371 /* `mail' and `Mail' commands, respectively */
1372 FL
int c_sendmail(void *v
);
1373 FL
int c_Sendmail(void *v
);
1375 /* Mail a message on standard input to the people indicated in the passed
1376 * header. (Internal interface) */
1377 FL
enum okay
mail1(struct header
*hp
, int printheaders
,
1378 struct message
*quote
, char *quotefile
, int recipient_record
,
1381 /* Create a Date: header field.
1382 * We compare the localtime() and gmtime() results to get the timezone, because
1383 * numeric timezones are easier to read and because $TZ isn't always set */
1384 FL
int mkdate(FILE *fo
, char const *field
);
1386 /* Dump the to, subject, cc header on the passed file buffer */
1387 FL
int puthead(struct header
*hp
, FILE *fo
, enum gfield w
,
1388 enum sendaction action
, enum conversion convert
,
1389 char const *contenttype
, char const *charset
);
1392 FL
enum okay
resend_msg(struct message
*mp
, struct name
*to
, int add_resent
);
1399 /* smtp-authXY, where XY=type=-user|-password etc */
1400 FL
char * smtp_auth_var(char const *type
, char const *addr
);
1402 /* Connect to a SMTP server */
1403 FL
int smtp_mta(char *server
, struct name
*to
, FILE *fi
,
1404 struct header
*hp
, char const *user
, char const *password
,
1405 char const *skinned
);
1413 /* Direct mappings of the various spam* commands */
1414 FL
int c_spam_clear(void *v
);
1415 FL
int c_spam_set(void *v
);
1416 FL
int c_spam_forget(void *v
);
1417 FL
int c_spam_ham(void *v
);
1418 FL
int c_spam_rate(void *v
);
1419 FL
int c_spam_spam(void *v
);
1421 # define c_spam_clear c_cmdnotsupp
1422 # define c_spam_set c_cmdnotsupp
1423 # define c_spam_forget c_cmdnotsupp
1424 # define c_spam_ham c_cmdnotsupp
1425 # define c_spam_rate c_cmdnotsupp
1426 # define c_spam_spam c_cmdnotsupp
1435 FL
void ssl_set_verify_level(char const *uhp
);
1438 FL
enum okay
ssl_verify_decide(void);
1441 FL
char * ssl_method_string(char const *uhp
);
1444 FL
enum okay
smime_split(FILE *ip
, FILE **hp
, FILE **bp
, long xcount
,
1448 FL
FILE * smime_sign_assemble(FILE *hp
, FILE *bp
, FILE *sp
);
1451 FL
FILE * smime_encrypt_assemble(FILE *hp
, FILE *yp
);
1454 FL
struct message
* smime_decrypt_assemble(struct message
*m
, FILE *hp
,
1458 FL
int c_certsave(void *v
);
1461 FL
enum okay
rfc2595_hostname_match(char const *host
, char const *pattern
);
1462 #else /* HAVE_SSL */
1463 # define c_certsave c_cmdnotsupp
1468 * This bundles several different string related support facilities:
1469 * - auto-reclaimed string storage (memory goes away on command loop ticks)
1470 * - plain char* support functions which use unspecified or smalloc() memory
1471 * - struct str related support funs
1472 * - our iconv(3) wrapper
1475 /* Auto-reclaimed string storage */
1478 # define SALLOC_DEBUG_ARGS , char const *mdbg_file, int mdbg_line
1479 # define SALLOC_DEBUG_ARGSCALL , mdbg_file, mdbg_line
1481 # define SALLOC_DEBUG_ARGS
1482 # define SALLOC_DEBUG_ARGSCALL
1485 /* Allocate size more bytes of space and return the address of the first byte
1486 * to the caller. An even number of bytes are always allocated so that the
1487 * space will always be on a word boundary */
1488 FL
void * salloc(size_t size SALLOC_DEBUG_ARGS
);
1489 FL
void * csalloc(size_t nmemb
, size_t size SALLOC_DEBUG_ARGS
);
1491 # define salloc(SZ) salloc(SZ, __FILE__, __LINE__)
1492 # define csalloc(NM,SZ) csalloc(NM, SZ, __FILE__, __LINE__)
1495 /* Auto-reclaim string storage; if only_if_relaxed is true then only perform
1496 * the reset when a srelax_hold() is currently active */
1497 FL
void sreset(bool_t only_if_relaxed
);
1499 /* The "problem" with sreset() is that it releases all string storage except
1500 * what was present once spreserve() had been called; it therefore cannot be
1501 * called from all that code which yet exists and walks about all the messages
1502 * in order, e.g. quit(), searches, etc., because, unfortunately, these code
1503 * paths are reached with new intermediate string dope already in use.
1504 * Thus such code should take a srelax_hold(), successively call srelax() after
1505 * a single message has been handled, and finally srelax_rele() (unless it is
1506 * clear that sreset() occurs anyway) */
1507 FL
void srelax_hold(void);
1508 FL
void srelax_rele(void);
1509 FL
void srelax(void);
1511 /* Make current string storage permanent: new allocs will be auto-reclaimed by
1512 * sreset(). This is called once only, from within main() */
1513 FL
void spreserve(void);
1515 /* 'sstats' command */
1517 FL
int c_sstats(void *v
);
1520 /* Return a pointer to a dynamic copy of the argument */
1521 FL
char * savestr(char const *str SALLOC_DEBUG_ARGS
);
1522 FL
char * savestrbuf(char const *sbuf
, size_t sbuf_len SALLOC_DEBUG_ARGS
);
1524 # define savestr(CP) savestr(CP, __FILE__, __LINE__)
1525 # define savestrbuf(CBP,CBL) savestrbuf(CBP, CBL, __FILE__, __LINE__)
1528 /* Make copy of argument incorporating old one, if set, separated by space */
1529 FL
char * save2str(char const *str
, char const *old SALLOC_DEBUG_ARGS
);
1531 # define save2str(S,O) save2str(S, O, __FILE__, __LINE__)
1535 FL
char * savecat(char const *s1
, char const *s2 SALLOC_DEBUG_ARGS
);
1537 # define savecat(S1,S2) savecat(S1, S2, __FILE__, __LINE__)
1540 /* Create duplicate, lowercasing all characters along the way */
1541 FL
char * i_strdup(char const *src SALLOC_DEBUG_ARGS
);
1543 # define i_strdup(CP) i_strdup(CP, __FILE__, __LINE__)
1546 /* Extract the protocol base and return a duplicate */
1547 FL
char * protbase(char const *cp SALLOC_DEBUG_ARGS
);
1549 # define protbase(CP) protbase(CP, __FILE__, __LINE__)
1552 /* URL en- and decoding (RFC 1738, but not really) */
1553 FL
char * urlxenc(char const *cp SALLOC_DEBUG_ARGS
);
1554 FL
char * urlxdec(char const *cp SALLOC_DEBUG_ARGS
);
1556 # define urlxenc(CP) urlxenc(CP, __FILE__, __LINE__)
1557 # define urlxdec(CP) urlxdec(CP, __FILE__, __LINE__)
1561 FL
struct str
* str_concat_csvl(struct str
*self
, ...);
1562 FL
struct str
* str_concat_cpa(struct str
*self
, char const * const *cpa
,
1563 char const *sep_o_null SALLOC_DEBUG_ARGS
);
1565 # define str_concat_cpa(S,A,N) str_concat_cpa(S, A, N, __FILE__, __LINE__)
1568 /* Plain char* support, not auto-reclaimed (unless noted) */
1570 /* Are any of the characters in the two strings the same? */
1571 FL
int anyof(char const *s1
, char const *s2
);
1573 /* Treat *iolist as a sep separated list of strings; find and return the
1574 * next entry, trimming surrounding whitespace, and point *iolist to the next
1575 * entry or to NULL if no more entries are contained. If ignore_empty is not
1576 * set empty entries are started over. Return NULL or an entry */
1577 FL
char * n_strsep(char **iolist
, char sep
, bool_t ignore_empty
);
1579 /* Copy a string, lowercasing it as we go; *size* is buffer size of *dest*;
1580 * *dest* will always be terminated unless *size* is 0 */
1581 FL
void i_strcpy(char *dest
, char const *src
, size_t size
);
1583 /* Is *as1* a valid prefix of *as2*? */
1584 FL
int is_prefix(char const *as1
, char const *as2
);
1586 /* Find the last AT @ before the first slash */
1587 FL
char const * last_at_before_slash(char const *sp
);
1589 /* Get (and isolate) the last, possibly quoted part of linebuf, set *needs_list
1590 * to indicate wether getmsglist() et al need to be called to collect
1591 * additional args that remain in linebuf. Return NULL on "error" */
1592 FL
char * laststring(char *linebuf
, bool_t
*needs_list
, bool_t strip
);
1594 /* Convert a string to lowercase, in-place and with multibyte-aware */
1595 FL
void makelow(char *cp
);
1597 /* Is *sub* a substring of *str*, case-insensitive and multibyte-aware? */
1598 FL bool_t
substr(char const *str
, char const *sub
);
1600 /* Lazy vsprintf wrapper */
1601 #ifndef HAVE_SNPRINTF
1602 FL
int snprintf(char *str
, size_t size
, char const *format
, ...);
1605 FL
char * sstpcpy(char *dst
, char const *src
);
1606 FL
char * sstrdup(char const *cp SMALLOC_DEBUG_ARGS
);
1607 FL
char * sbufdup(char const *cp
, size_t len SMALLOC_DEBUG_ARGS
);
1609 # define sstrdup(CP) sstrdup(CP, __FILE__, __LINE__)
1610 # define sbufdup(CP,L) sbufdup(CP, L, __FILE__, __LINE__)
1613 FL
char * n_strlcpy(char *dst
, char const *src
, size_t len
);
1615 /* Locale-independent character class functions */
1616 FL
int asccasecmp(char const *s1
, char const *s2
);
1617 FL
int ascncasecmp(char const *s1
, char const *s2
, size_t sz
);
1618 FL
char const * asccasestr(char const *haystack
, char const *xneedle
);
1619 FL bool_t
is_asccaseprefix(char const *as1
, char const *as2
);
1621 /* struct str related support funs */
1623 /* *self->s* is srealloc()ed */
1624 FL
struct str
* n_str_dup(struct str
*self
, struct str
const *t
1625 SMALLOC_DEBUG_ARGS
);
1627 /* *self->s* is srealloc()ed, *self->l* incremented */
1628 FL
struct str
* n_str_add_buf(struct str
*self
, char const *buf
, size_t buflen
1629 SMALLOC_DEBUG_ARGS
);
1630 #define n_str_add(S, T) n_str_add_buf(S, (T)->s, (T)->l)
1631 #define n_str_add_cp(S, CP) n_str_add_buf(S, CP, (CP) ? strlen(CP) : 0)
1634 # define n_str_dup(S,T) n_str_dup(S, T, __FILE__, __LINE__)
1635 # define n_str_add_buf(S,B,BL) n_str_add_buf(S, B, BL, __FILE__, __LINE__)
1638 /* Our iconv(3) wrappers */
1641 FL iconv_t
n_iconv_open(char const *tocode
, char const *fromcode
);
1642 /* If *cd* == *iconvd*, assigns -1 to the latter */
1643 FL
void n_iconv_close(iconv_t cd
);
1645 /* Reset encoding state */
1647 FL
void n_iconv_reset(iconv_t cd
);
1650 /* iconv(3), but return *errno* or 0; *skipilseq* forces step over illegal byte
1651 * sequences; likewise iconv_str(), but which auto-grows on E2BIG errors; *in*
1652 * and *in_rest_or_null* may be the same object.
1653 * Note: EINVAL (incomplete sequence at end of input) is NOT handled, so the
1654 * replacement character must be added manually if that happens at EOF! */
1655 FL
int n_iconv_buf(iconv_t cd
, char const **inb
, size_t *inbleft
,
1656 char **outb
, size_t *outbleft
, bool_t skipilseq
);
1657 FL
int n_iconv_str(iconv_t icp
, struct str
*out
, struct str
const *in
,
1658 struct str
*in_rest_or_null
, bool_t skipilseq
);
1666 FL
int c_thread(void *vp
);
1669 FL
int c_unthread(void *vp
);
1672 FL
struct message
* next_in_thread(struct message
*mp
);
1673 FL
struct message
* prev_in_thread(struct message
*mp
);
1674 FL
struct message
* this_in_thread(struct message
*mp
, long n
);
1676 /* Sorted mode is internally just a variant of threaded mode with all m_parent
1677 * and m_child links being NULL */
1678 FL
int c_sort(void *vp
);
1681 FL
int c_collapse(void *v
);
1682 FL
int c_uncollapse(void *v
);
1685 FL
void uncollapse1(struct message
*mp
, int always
);
1691 /* Return wether user says yes. If prompt is NULL, "Continue (y/n)? " is used
1692 * instead. If interactive, asks on STDIN, anything but [0]==[Nn] is true.
1693 * If noninteractive, returns noninteract_default. Handles+reraises SIGINT */
1694 FL bool_t
getapproval(char const *prompt
, bool_t noninteract_default
);
1696 /* Get a password the expected way, return termios_state.ts_linebuf on
1697 * success or NULL on error */
1698 FL
char * getuser(char const *query
);
1700 /* Get a password the expected way, return termios_state.ts_linebuf on
1701 * success or NULL on error. SIGINT is temporarily blocked, *not* reraised.
1702 * termios_state_reset() (def.h) must be called anyway */
1703 FL
char * getpassword(char const *query
);
1705 /* Get both, user and password in the expected way; simply reuses a value that
1706 * is set, otherwise calls one of the above.
1707 * Returns true only if we have a user and a password.
1708 * *user* will be savestr()ed if neither it nor *pass* have a default value
1709 * (so that termios_state.ts_linebuf carries only one) */
1710 FL bool_t
getcredentials(char **user
, char **pass
);
1712 /* Overall interactive terminal life cycle for command line editor library */
1713 #if defined HAVE_EDITLINE || defined HAVE_READLINE
1714 # define TTY_WANTS_SIGWINCH
1716 FL
void tty_init(void);
1717 FL
void tty_destroy(void);
1719 /* Rather for main.c / SIGWINCH interaction only */
1720 FL
void tty_signal(int sig
);
1722 /* Read a line after printing prompt (if set and non-empty).
1723 * If n>0 assumes that *linebuf has n bytes of default content */
1724 FL
int tty_readline(char const *prompt
, char **linebuf
,
1725 size_t *linesize
, size_t n SMALLOC_DEBUG_ARGS
);
1727 # define tty_readline(A,B,C,D) tty_readline(A, B, C, D, __FILE__, __LINE__)
1730 /* Add a line (most likely as returned by tty_readline()) to the history
1731 * (only added for real if non-empty and doesn't begin with U+0020) */
1732 FL
void tty_addhist(char const *s
);
1734 #if defined HAVE_HISTORY &&\
1735 (defined HAVE_READLINE || defined HAVE_EDITLINE || defined HAVE_NCL)
1736 FL
int c_history(void *v
);
1739 #ifndef HAVE_AMALGAMATION
1744 /* vim:set fenc=utf-8:s-it-mode */