1 /*@ S-nail - a mail user agent derived from Berkeley Mail.
2 *@ Function prototypes and function-alike macros.
4 * Copyright (c) 2000-2004 Gunnar Ritter, Freiburg i. Br., Germany.
5 * Copyright (c) 2012 - 2014 Steffen (Daode) Nurpmeso <sdaoden@users.sf.net>.
8 * Copyright (c) 1992, 1993
9 * The Regents of the University of California. All rights reserved.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed by the University of
22 * California, Berkeley and its contributors.
23 * 4. Neither the name of the University nor the names of its contributors
24 * may be used to endorse or promote products derived from this software
25 * without specific prior written permission.
27 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
41 * TODO Convert optional utility+ functions to n_*(); ditto
42 * TODO else use generic module-specific prefixes: str_(), am[em]_, sm[em]_, ..
44 /* TODO s-it-mode: not really (docu, funnames, funargs, etc) */
47 #ifndef HAVE_AMALGAMATION
54 * Macro-based generics
57 /* Kludges to handle the change from setexit / reset to setjmp / longjmp */
58 #define setexit() (void)sigsetjmp(srbuf, 1)
59 #define reset(x) siglongjmp(srbuf, x)
61 /* ASCII char classification */
62 #define __ischarof(C, FLAGS) \
63 (asciichar(C) && (class_char[(uc_it)(C)] & (FLAGS)) != 0)
65 #define asciichar(c) ((uc_it)(c) <= 0177)
66 #define alnumchar(c) __ischarof(c, C_DIGIT | C_OCTAL | C_UPPER | C_LOWER)
67 #define alphachar(c) __ischarof(c, C_UPPER | C_LOWER)
68 #define blankchar(c) __ischarof(c, C_BLANK)
69 #define blankspacechar(c) __ischarof(c, C_BLANK | C_SPACE)
70 #define cntrlchar(c) __ischarof(c, C_CNTRL)
71 #define digitchar(c) __ischarof(c, C_DIGIT | C_OCTAL)
72 #define lowerchar(c) __ischarof(c, C_LOWER)
73 #define punctchar(c) __ischarof(c, C_PUNCT)
74 #define spacechar(c) __ischarof(c, C_BLANK | C_SPACE | C_WHITE)
75 #define upperchar(c) __ischarof(c, C_UPPER)
76 #define whitechar(c) __ischarof(c, C_BLANK | C_WHITE)
77 #define octalchar(c) __ischarof(c, C_OCTAL)
79 #define upperconv(c) (lowerchar(c) ? (char)((uc_it)(c) - 'a' + 'A') : (c))
80 #define lowerconv(c) (upperchar(c) ? (char)((uc_it)(c) - 'A' + 'a') : (c))
82 #define fieldnamechar(c) \
83 (asciichar(c) && (c) > 040 && (c) != 0177 && (c) != ':')
85 /* Try to use alloca() for some function-local buffers and data, fall back to
86 * smalloc()/free() if not available */
88 # define ac_alloc(n) HAVE_ALLOCA(n)
89 # define ac_free(n) do {UNUSED(n);} while (0)
91 # define ac_alloc(n) smalloc(n)
92 # define ac_free(n) free(n)
95 /* Single-threaded, use unlocked I/O */
96 #ifdef HAVE_PUTC_UNLOCKED
98 # define getc(c) getc_unlocked(c)
100 # define putc(c, f) putc_unlocked(c, f)
102 # define putchar(c) putc_unlocked((c), stdout)
105 /* Truncate a file to the last character written. This is useful just before
106 * closing an old file that was opened for read/write */
107 #define ftrunc(stream) \
111 off = ftell(stream);\
113 ftruncate(fileno(stream), off);\
116 /* fflush() and rewind() */
117 #define fflush_rewind(stream) \
123 /* There are problems with dup()ing of file-descriptors for child processes.
124 * As long as those are not fixed in equal spirit to (outof(): FIX and
125 * recode.., 2012-10-04), and to avoid reviving of bugs like (If *record* is
126 * set, avoid writing dead content twice.., 2012-09-14), we have to somehow
127 * accomplish that the FILE* fp makes itself comfortable with the *real* offset
128 * of the underlaying file descriptor. Unfortunately Standard I/O and POSIX
129 * don't describe a way for that -- fflush();rewind(); won't do it. This
130 * fseek(END),rewind() pair works around the problem on *BSD and Linux.
131 * Update as of 2014-03-03: with Issue 7 POSIX has overloaded fflush(3): if
132 * used on a readable stream, then
134 * if the file is not already at EOF, and the file is one capable of
135 * seeking, the file offset of the underlying open file description shall
136 * be set to the file position of the stream.
138 * We need our own, simplified and reliable I/O */
139 #if defined _POSIX_VERSION && _POSIX_VERSION + 0 >= 200809L
140 # define really_rewind(stream) \
146 # define really_rewind(stream) \
148 fseek(stream, 0, SEEK_END);\
157 /* Don't use _var_* unless you *really* have to! */
159 /* Constant option key look/(un)set/clear */
160 FL
char * _var_oklook(enum okeys okey
);
161 #define ok_blook(C) (_var_oklook(CONCAT(ok_b_, C)) != NULL)
162 #define ok_vlook(C) _var_oklook(CONCAT(ok_v_, C))
164 FL bool_t
_var_okset(enum okeys okey
, uintptr_t val
);
165 #define ok_bset(C,B) _var_okset(CONCAT(ok_b_, C), (uintptr_t)(B))
166 #define ok_vset(C,V) _var_okset(CONCAT(ok_v_, C), (uintptr_t)(V))
168 FL bool_t
_var_okclear(enum okeys okey
);
169 #define ok_bclear(C) _var_okclear(CONCAT(ok_b_, C))
170 #define ok_vclear(C) _var_okclear(CONCAT(ok_v_, C))
172 /* Variable option key look/(un)set/clear */
173 FL
char * _var_voklook(char const *vokey
);
174 #define vok_blook(S) (_var_voklook(S) != NULL)
175 #define vok_vlook(S) _var_voklook(S)
177 FL bool_t
_var_vokset(char const *vokey
, uintptr_t val
);
178 #define vok_bset(S,B) _var_vokset(S, (uintptr_t)(B))
179 #define vok_vset(S,V) _var_vokset(S, (uintptr_t)(V))
181 FL bool_t
_var_vokclear(char const *vokey
);
182 #define vok_bclear(S) _var_vokclear(S)
183 #define vok_vclear(S) _var_vokclear(S)
185 /* List all variables */
186 FL
void var_list_all(void);
189 FL
int c_varshow(void *v
);
191 /* User variable access: `set', `setenv', `unset' and `unsetenv' */
192 FL
int c_set(void *v
);
193 FL
int c_setenv(void *v
);
194 FL
int c_unset(void *v
);
195 FL
int c_unsetenv(void *v
);
197 /* Macros: `define', `undefine', `call' / `~' */
198 FL
int c_define(void *v
);
199 FL
int c_undefine(void *v
);
200 FL
int c_call(void *v
);
202 FL
int callhook(char const *name
, int nmail
);
204 /* Accounts: `account', `unaccount' */
205 FL
int c_account(void *v
);
206 FL
int c_unaccount(void *v
);
209 FL
int c_localopts(void *v
);
211 FL
void temporary_localopts_free(void); /* XXX intermediate hack */
217 /* Try to add an attachment for *file*, file_expand()ed.
218 * Return the new head of list *aphead*, or NULL.
219 * The newly created attachment will be stored in **newap*, if given */
220 FL
struct attachment
* add_attachment(struct attachment
*aphead
, char *file
,
221 struct attachment
**newap
);
223 /* Append comma-separated list of file names to the end of attachment list */
224 FL
void append_attachments(struct attachment
**aphead
, char *names
);
226 /* Interactively edit the attachment list */
227 FL
void edit_attachments(struct attachment
**aphead
);
233 /* Announce a fatal error (and die) */
234 FL
void panic(char const *format
, ...);
235 FL
void alert(char const *format
, ...);
237 /* Provide BSD-like signal() on all (POSIX) systems */
238 FL sighandler_type
safe_signal(int signum
, sighandler_type handler
);
240 /* Hold *all* signals but SIGCHLD, and release that total block again */
241 FL
void hold_all_sigs(void);
242 FL
void rele_all_sigs(void);
244 /* Hold HUP/QUIT/INT */
245 FL
void hold_sigs(void);
246 FL
void rele_sigs(void);
248 /* Not-Yet-Dead debug information (handler installation in main.c) */
250 FL
void _nyd_chirp(ui8_t act
, char const *file
, ui32_t line
,
252 FL
void _nyd_oncrash(int signo
);
254 # define NYD_ENTER _nyd_chirp(1, __FILE__, __LINE__, __FUN__)
255 # define NYD_LEAVE _nyd_chirp(2, __FILE__, __LINE__, __FUN__)
256 # define NYD _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
257 # define NYD_X _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
259 # define NYD_ENTER do {} while (0)
260 # define NYD_LEAVE do {} while (0)
261 # define NYD do {} while (0)
262 # define NYD_X do {} while (0) /* XXX LEGACY */
265 /* Touch the named message by setting its MTOUCH flag. Touched messages have
266 * the effect of not being sent back to the system mailbox on exit */
267 FL
void touch(struct message
*mp
);
269 /* Test to see if the passed file name is a directory, return true if it is */
270 FL bool_t
is_dir(char const *name
);
272 /* Count the number of arguments in the given string raw list */
273 FL
int argcount(char **argv
);
275 /* Compute screen size */
276 FL
int screensize(void);
278 /* Get our $PAGER; if env_addon is not NULL it is check wether we know about
279 * some environment variable that supports colour+ */
280 FL
char const *get_pager(char const **env_addon
);
282 /* Check wether using a pager is possible/makes sense and is desired by user
283 * (*crt* set); return number of screen lines (or *crt*) if so, 0 otherwise */
284 FL
size_t paging_seems_sensible(void);
286 /* Use a pager or STDOUT to print *fp*; if *lines* is 0, they'll be counted */
287 FL
void page_or_print(FILE *fp
, size_t lines
);
289 /* Parse name and guess at the required protocol */
290 FL
enum protocol
which_protocol(char const *name
);
292 /* Hash the passed string -- uses Chris Torek's hash algorithm */
293 FL ui32_t
torek_hash(char const *name
);
294 #define hash(S) (torek_hash(S) % HSHSIZE) /* xxx COMPAT (?) */
297 FL ui32_t
pjw(char const *cp
); /* TODO obsolete -> torek_hash() */
299 /* Find a prime greater than n */
300 FL ui32_t
nextprime(ui32_t n
);
302 /* Check wether *s is an escape sequence, expand it as necessary.
303 * Returns the expanded sequence or 0 if **s is NUL or PROMPT_STOP if it is \c.
304 * *s is advanced to after the expanded sequence (as possible).
305 * If use_prompt_extensions is set, an enum prompt_exp may be returned */
306 FL
int expand_shell_escape(char const **s
,
307 bool_t use_prompt_extensions
);
309 /* Get *prompt*, or '& ' if *bsdcompat*, of '? ' otherwise */
310 FL
char * getprompt(void);
312 /* Detect and query the hostname to use */
313 FL
char * nodename(int mayoverride
);
315 /* Parse data, which must meet the criteria of the protocol cproto, and fill
316 * in the URL structure urlp (URL rather according to RFC 3986) */
317 FL bool_t
url_parse(struct url
*urlp
, enum cproto cproto
,
320 /* Zero ccp and lookup credentials for communicating with urlp.
321 * Return wether credentials are available and valid (for chosen auth) */
322 FL bool_t
ccred_lookup(struct ccred
*ccp
, struct url
*urlp
);
323 FL bool_t
ccred_lookup_old(struct ccred
*ccp
, enum cproto cproto
,
326 /* Get a (pseudo) random string of *length* bytes; returns salloc()ed buffer */
327 FL
char * getrandstring(size_t length
);
329 /* MD5 (RFC 1321) related facilities */
331 # ifdef HAVE_OPENSSL_MD5
332 # define md5_ctx MD5_CTX
333 # define md5_init MD5_Init
334 # define md5_update MD5_Update
335 # define md5_final MD5_Final
337 # include "rfc1321.h"
340 /* Store the MD5 checksum as a hexadecimal string in *hex*, *not* terminated,
341 * using lowercase ASCII letters as defined in RFC 2195 */
342 # define MD5TOHEX_SIZE 32
343 FL
char * md5tohex(char hex
[MD5TOHEX_SIZE
], void const *vp
);
345 /* CRAM-MD5 encode the *user* / *pass* / *b64* combo */
346 FL
char * cram_md5_string(struct str
const *user
, struct str
const *pass
,
349 /* RFC 2104: HMAC: Keyed-Hashing for Message Authentication.
350 * unsigned char *text: pointer to data stream
351 * int text_len : length of data stream
352 * unsigned char *key : pointer to authentication key
353 * int key_len : length of authentication key
354 * caddr_t digest : caller digest to be filled in */
355 FL
void hmac_md5(unsigned char *text
, int text_len
, unsigned char *key
,
356 int key_len
, void *digest
);
359 FL
enum okay
makedir(char const *name
);
361 /* A get-wd..restore-wd approach */
362 FL
enum okay
cwget(struct cw
*cw
);
363 FL
enum okay
cwret(struct cw
*cw
);
364 FL
void cwrelse(struct cw
*cw
);
366 /* Check (multibyte-safe) how many bytes of buf (which is blen byts) can be
367 * safely placed in a buffer (field width) of maxlen bytes */
368 FL
size_t field_detect_clip(size_t maxlen
, char const *buf
, size_t blen
);
370 /* Put maximally maxlen bytes of buf, a buffer of blen bytes, into store,
371 * taking into account multibyte code point boundaries and possibly
372 * encapsulating in bidi_info toggles as necessary */
373 FL
size_t field_put_bidi_clip(char *store
, size_t maxlen
, char const *buf
,
376 /* Place cp in a salloc()ed buffer, column-aligned; for header display only */
377 FL
char * colalign(char const *cp
, int col
, int fill
,
378 int *cols_decr_used_or_null
);
380 /* Convert a string to a displayable one;
381 * prstr() returns the result savestr()d, prout() writes it */
382 FL
void makeprint(struct str
const *in
, struct str
*out
);
383 FL
char * prstr(char const *s
);
384 FL
int prout(char const *s
, size_t sz
, FILE *fp
);
386 /* Print out a Unicode character or a substitute for it, return 0 on error or
387 * wcwidth() (or 1) on success */
388 FL
size_t putuc(int u
, int c
, FILE *fp
);
390 /* Check wether bidirectional info maybe needed for blen bytes of bdat */
391 FL bool_t
bidi_info_needed(char const *bdat
, size_t blen
);
393 /* Create bidirectional text encapsulation information; without HAVE_NATCH_CHAR
394 * the strings are always empty */
395 FL
void bidi_info_create(struct bidi_info
*bip
);
397 /* We want coloured output (in this salloc() cycle). pager_used is used to
398 * test wether *colour-pager* is to be inspected */
400 FL
void colour_table_create(bool_t pager_used
);
401 FL
void colour_put(FILE *fp
, enum colourspec cs
);
402 FL
void colour_put_header(FILE *fp
, char const *name
);
403 FL
void colour_reset(FILE *fp
);
404 FL
struct str
const * colour_get(enum colourspec cs
);
406 # define colour_put(FP,CS)
407 # define colour_put_header(FP,N)
408 # define colour_reset(FP)
411 /* Update *tc* to now; only .tc_time updated unless *full_update* is true */
412 FL
void time_current_update(struct time_current
*tc
,
415 /* Memory allocation routines */
417 # define SMALLOC_DEBUG_ARGS , char const *mdbg_file, int mdbg_line
418 # define SMALLOC_DEBUG_ARGSCALL , mdbg_file, mdbg_line
420 # define SMALLOC_DEBUG_ARGS
421 # define SMALLOC_DEBUG_ARGSCALL
424 FL
void * smalloc(size_t s SMALLOC_DEBUG_ARGS
);
425 FL
void * srealloc(void *v
, size_t s SMALLOC_DEBUG_ARGS
);
426 FL
void * scalloc(size_t nmemb
, size_t size SMALLOC_DEBUG_ARGS
);
429 FL
void sfree(void *v SMALLOC_DEBUG_ARGS
);
430 /* Called by sreset(), then */
431 FL
void smemreset(void);
433 FL
int c_smemtrace(void *v
);
434 /* For immediate debugging purposes, it is possible to check on request */
436 # define _HAVE_MEMCHECK
437 FL bool_t
_smemcheck(char const *file
, int line
);
440 # define smalloc(SZ) smalloc(SZ, __FILE__, __LINE__)
441 # define srealloc(P,SZ) srealloc(P, SZ, __FILE__, __LINE__)
442 # define scalloc(N,SZ) scalloc(N, SZ, __FILE__, __LINE__)
443 # define free(P) sfree(P, __FILE__, __LINE__)
444 # define smemcheck() _smemcheck(__FILE__, __LINE__)
451 FL
int c_cmdnotsupp(void *v
);
453 /* Show header group */
454 FL
int c_headers(void *v
);
456 /* Scroll to the next/previous screen */
457 FL
int c_scroll(void *v
);
458 FL
int c_Scroll(void *v
);
460 /* Print out the headlines for each message in the passed message list */
461 FL
int c_from(void *v
);
463 /* Print all message in between and including bottom and topx if they are
464 * visible and either only_marked is false or they are MMARKed */
465 FL
void print_headers(size_t bottom
, size_t topx
, bool_t only_marked
);
467 /* Print out the value of dot */
468 FL
int c_pdot(void *v
);
470 /* Paginate messages, honor/don't honour ignored fields, respectively */
471 FL
int c_more(void *v
);
472 FL
int c_More(void *v
);
474 /* Type out messages, honor/don't honour ignored fields, respectively */
475 FL
int c_type(void *v
);
476 FL
int c_Type(void *v
);
478 /* Show MIME-encoded message text, including all fields */
479 FL
int c_show(void *v
);
481 /* Pipe messages, honor/don't honour ignored fields, respectively */
482 FL
int c_pipe(void *v
);
483 FL
int c_Pipe(void *v
);
485 /* Print the top so many lines of each desired message.
486 * The number of lines is taken from *toplines* and defaults to 5 */
487 FL
int c_top(void *v
);
489 /* Touch all the given messages so that they will get mboxed */
490 FL
int c_stouch(void *v
);
492 /* Make sure all passed messages get mboxed */
493 FL
int c_mboxit(void *v
);
495 /* List the folders the user currently has */
496 FL
int c_folders(void *v
);
502 /* If any arguments were given, go to the next applicable argument following
503 * dot, otherwise, go to the next applicable message. If given as first
504 * command with no arguments, print first message */
505 FL
int c_next(void *v
);
507 /* Save a message in a file. Mark the message as saved so we can discard when
509 FL
int c_save(void *v
);
510 FL
int c_Save(void *v
);
512 /* Copy a message to a file without affected its saved-ness */
513 FL
int c_copy(void *v
);
514 FL
int c_Copy(void *v
);
516 /* Move a message to a file */
517 FL
int c_move(void *v
);
518 FL
int c_Move(void *v
);
520 /* Decrypt and copy a message to a file */
521 FL
int c_decrypt(void *v
);
522 FL
int c_Decrypt(void *v
);
524 /* Write the indicated messages at the end of the passed file name, minus
525 * header and trailing blank line. This is the MIME save function */
526 FL
int c_write(void *v
);
528 /* Delete messages */
529 FL
int c_delete(void *v
);
531 /* Delete messages, then type the new dot */
532 FL
int c_deltype(void *v
);
534 /* Undelete the indicated messages */
535 FL
int c_undelete(void *v
);
537 /* Add the given header fields to the retained list. If no arguments, print
538 * the current list of retained fields */
539 FL
int c_retfield(void *v
);
541 /* Add the given header fields to the ignored list. If no arguments, print the
542 * current list of ignored fields */
543 FL
int c_igfield(void *v
);
545 FL
int c_saveretfield(void *v
);
546 FL
int c_saveigfield(void *v
);
547 FL
int c_fwdretfield(void *v
);
548 FL
int c_fwdigfield(void *v
);
549 FL
int c_unignore(void *v
);
550 FL
int c_unretain(void *v
);
551 FL
int c_unsaveignore(void *v
);
552 FL
int c_unsaveretain(void *v
);
553 FL
int c_unfwdignore(void *v
);
554 FL
int c_unfwdretain(void *v
);
560 /* Process a shell escape by saving signals, ignoring signals and a sh -c */
561 FL
int c_shell(void *v
);
563 /* Fork an interactive shell */
564 FL
int c_dosh(void *v
);
566 /* Show the help screen */
567 FL
int c_help(void *v
);
569 /* Print user's working directory */
570 FL
int c_cwd(void *v
);
572 /* Change user's working directory */
573 FL
int c_chdir(void *v
);
575 FL
int c_respond(void *v
);
576 FL
int c_respondall(void *v
);
577 FL
int c_respondsender(void *v
);
578 FL
int c_Respond(void *v
);
579 FL
int c_followup(void *v
);
580 FL
int c_followupall(void *v
);
581 FL
int c_followupsender(void *v
);
582 FL
int c_Followup(void *v
);
584 /* The 'forward' command */
585 FL
int c_forward(void *v
);
587 /* Similar to forward, saving the message in a file named after the first
589 FL
int c_Forward(void *v
);
591 /* Resend a message list to a third person */
592 FL
int c_resend(void *v
);
594 /* Resend a message list to a third person without adding headers */
595 FL
int c_Resend(void *v
);
597 /* Preserve messages, so that they will be sent back to the system mailbox */
598 FL
int c_preserve(void *v
);
600 /* Mark all given messages as unread */
601 FL
int c_unread(void *v
);
603 /* Mark all given messages as read */
604 FL
int c_seen(void *v
);
606 /* Print the size of each message */
607 FL
int c_messize(void *v
);
609 /* Quit quickly. If sourcing, just pop the input level by returning error */
610 FL
int c_rexit(void *v
);
612 /* Without arguments print all groups, otherwise add users to a group */
613 FL
int c_group(void *v
);
615 /* Delete the passed groups */
616 FL
int c_ungroup(void *v
);
618 /* Change to another file. With no argument, print info about current file */
619 FL
int c_file(void *v
);
621 /* Expand file names like echo */
622 FL
int c_echo(void *v
);
624 /* if.elif.else.endif conditional execution.
625 * condstack_isskip() returns wether the current condition state doesn't allow
626 * execution of commands.
627 * condstack_release() and condstack_take() are used when sourcing files, they
628 * rotate the current condition stack; condstack_take() returns a false boolean
629 * if the current condition stack has unclosed conditionals */
630 FL
int c_if(void *v
);
631 FL
int c_elif(void *v
);
632 FL
int c_else(void *v
);
633 FL
int c_endif(void *v
);
634 FL bool_t
condstack_isskip(void);
635 FL
void * condstack_release(void);
636 FL bool_t
condstack_take(void *self
);
638 /* Set the list of alternate names */
639 FL
int c_alternates(void *v
);
641 /* 'newmail' command: Check for new mail without writing old mail back */
642 FL
int c_newmail(void *v
);
645 FL
int c_shortcut(void *v
);
646 FL
struct shortcut
*get_shortcut(char const *str
);
647 FL
int c_unshortcut(void *v
);
649 /* Message flag manipulation */
650 FL
int c_flag(void *v
);
651 FL
int c_unflag(void *v
);
652 FL
int c_answered(void *v
);
653 FL
int c_unanswered(void *v
);
654 FL
int c_draft(void *v
);
655 FL
int c_undraft(void *v
);
658 FL
int c_noop(void *v
);
661 FL
int c_remove(void *v
);
664 FL
int c_rename(void *v
);
666 /* `urlencode' and `urldecode' */
667 FL
int c_urlencode(void *v
);
668 FL
int c_urldecode(void *v
);
674 FL
FILE * collect(struct header
*hp
, int printheaders
, struct message
*mp
,
675 char *quotefile
, int doprefix
);
677 FL
void savedeadletter(FILE *fp
, int fflush_rewind_first
);
683 FL
int fcntl_lock(int fd
, enum flock_type ft
);
684 FL
int dot_lock(char const *fname
, int fd
, int pollinterval
, FILE *fp
,
686 FL
void dot_unlock(char const *fname
);
692 /* Edit a message list */
693 FL
int c_editor(void *v
);
695 /* Invoke the visual editor on a message list */
696 FL
int c_visual(void *v
);
698 /* Run an editor on the file at fp of size bytes, and return a new file.
699 * Signals must be handled by the caller. viored is 'e' for ed, 'v' for vi */
700 FL
FILE * run_editor(FILE *fp
, off_t size
, int viored
, int readonly
,
701 struct header
*hp
, struct message
*mp
,
702 enum sendaction action
, sighandler_type oldint
);
709 FL
struct quoteflt
* quoteflt_dummy(void); /* TODO LEGACY */
710 FL
void quoteflt_init(struct quoteflt
*self
, char const *prefix
);
711 FL
void quoteflt_destroy(struct quoteflt
*self
);
712 FL
void quoteflt_reset(struct quoteflt
*self
, FILE *f
);
713 FL ssize_t
quoteflt_push(struct quoteflt
*self
, char const *dat
,
715 FL ssize_t
quoteflt_flush(struct quoteflt
*self
);
721 /* fgets() replacement to handle lines of arbitrary size and with embedded \0
723 * line - line buffer. *line may be NULL.
724 * linesize - allocated size of line buffer.
725 * count - maximum characters to read. May be NULL.
726 * llen - length_of_line(*line).
728 * appendnl - always terminate line with \n, append if necessary.
730 FL
char * fgetline(char **line
, size_t *linesize
, size_t *count
,
731 size_t *llen
, FILE *fp
, int appendnl SMALLOC_DEBUG_ARGS
);
733 # define fgetline(A,B,C,D,E,F) \
734 fgetline(A, B, C, D, E, F, __FILE__, __LINE__)
737 /* Read up a line from the specified input into the linebuffer.
738 * Return the number of characters read. Do not include the newline at EOL.
739 * n is the number of characters already read */
740 FL
int readline_restart(FILE *ibuf
, char **linebuf
, size_t *linesize
,
741 size_t n SMALLOC_DEBUG_ARGS
);
743 # define readline_restart(A,B,C,D) \
744 readline_restart(A, B, C, D, __FILE__, __LINE__)
747 /* Read a complete line of input, with editing if interactive and possible.
748 * If prompt is NULL we'll call getprompt() first, if necessary.
749 * nl_escape defines wether user can escape newlines via backslash (POSIX).
750 * If string is set it is used as the initial line content if in interactive
751 * mode, otherwise this argument is ignored for reproducibility.
752 * Return number of octets or a value <0 on error */
753 FL
int readline_input(char const *prompt
, bool_t nl_escape
,
754 char **linebuf
, size_t *linesize
, char const *string
757 # define readline_input(A,B,C,D,E) readline_input(A,B,C,D,E,__FILE__,__LINE__)
760 /* Read a line of input, with editing if interactive and possible, return it
761 * savestr()d or NULL in case of errors or if an empty line would be returned.
762 * This may only be called from toplevel (not during sourcing).
763 * If prompt is NULL we'll call getprompt() if necessary.
764 * If string is set it is used as the initial line content if in interactive
765 * mode, otherwise this argument is ignored for reproducibility */
766 FL
char * readstr_input(char const *prompt
, char const *string
);
768 /* Set up the input pointers while copying the mail file into /tmp */
769 FL
void setptr(FILE *ibuf
, off_t offset
);
771 /* Drop the passed line onto the passed output buffer. If a write error occurs
772 * return -1, else the count of characters written, including the newline */
773 FL
int putline(FILE *obuf
, char *linebuf
, size_t count
);
775 /* Return a file buffer all ready to read up the passed message pointer */
776 FL
FILE * setinput(struct mailbox
*mp
, struct message
*m
,
779 /* Reset (free) the global message array */
780 FL
void message_reset(void);
782 /* Append the passed message descriptor onto the message array; if mp is NULL,
783 * NULLify the entry at &[msgCount-1] */
784 FL
void message_append(struct message
*mp
);
786 /* Check wether sep->ss_sexpr (or ->ss_reexpr) matches mp. If with_headers is
787 * true then the headers will also be searched (as plain text) */
788 FL bool_t
message_match(struct message
*mp
, struct search_expr
const *sep
,
789 bool_t with_headers
);
791 FL
struct message
* setdot(struct message
*mp
);
793 /* Delete a file, but only if the file is a plain file */
794 FL
int rm(char const *name
);
796 /* Determine the size of the file possessed by the passed buffer */
797 FL off_t
fsize(FILE *iob
);
799 /* Evaluate the string given as a new mailbox name. Supported meta characters:
800 * % for my system mail box
801 * %user for user's system mail box
802 * # for previous file
803 * & invoker's mbox file
804 * +file file in folder directory
805 * any shell meta character
806 * Returns the file name as an auto-reclaimed string */
807 FL
char * fexpand(char const *name
, enum fexp_mode fexpm
);
809 #define expand(N) fexpand(N, FEXP_FULL) /* XXX obsolete */
810 #define file_expand(N) fexpand(N, FEXP_LOCAL) /* XXX obsolete */
812 /* Get rid of queued mail */
813 FL
void demail(void);
815 /* acmava.c hook: *folder* variable has been updated; if folder shouldn't be
816 * replaced by something else leave store alone, otherwise smalloc() the
817 * desired value (ownership will be taken) */
818 FL bool_t
var_folder_updated(char const *folder
, char **store
);
820 /* Determine the current *folder* name, store it in *name* */
821 FL bool_t
getfold(char *name
, size_t size
);
823 /* Return the name of the dead.letter file */
824 FL
char const * getdeadletter(void);
826 FL
enum okay
get_body(struct message
*mp
);
830 FL bool_t
sopen(struct sock
*sp
, struct url
*urlp
);
831 FL
int sclose(struct sock
*sp
);
832 FL
enum okay
swrite(struct sock
*sp
, char const *data
);
833 FL
enum okay
swrite1(struct sock
*sp
, char const *data
, int sz
,
837 FL
int sgetline(char **line
, size_t *linesize
, size_t *linelen
,
838 struct sock
*sp SMALLOC_DEBUG_ARGS
);
840 # define sgetline(A,B,C,D) sgetline(A, B, C, D, __FILE__, __LINE__)
842 #endif /* HAVE_SOCKETS */
844 /* Deal with loading of resource files and dealing with a stack of files for
845 * the source command */
847 /* Load a file of user definitions */
848 FL
void load(char const *name
);
850 /* Pushdown current input file and switch to a new one. Set the global flag
851 * *sourcing* so that others will realize that they are no longer reading from
852 * a tty (in all probability) */
853 FL
int c_source(void *v
);
855 /* Pop the current input back to the previous level. Update the *sourcing*
856 * flag as appropriate */
857 FL
int unstack(void);
863 /* Return the user's From: address(es) */
864 FL
char const * myaddrs(struct header
*hp
);
866 /* Boil the user's From: addresses down to a single one, or use *sender* */
867 FL
char const * myorigin(struct header
*hp
);
869 /* See if the passed line buffer, which may include trailing newline (sequence)
870 * is a mail From_ header line according to RFC 4155 */
871 FL
int is_head(char const *linebuf
, size_t linelen
);
873 /* Savage extract date field from From_ line. linelen is convenience as line
874 * must be terminated (but it may end in a newline [sequence]).
875 * Return wether the From_ line was parsed successfully */
876 FL
int extract_date_from_from_(char const *line
, size_t linelen
,
877 char datebuf
[FROM_DATEBUF
]);
879 FL
void extract_header(FILE *fp
, struct header
*hp
);
881 /* Return the desired header line from the passed message
882 * pointer (or NULL if the desired header field is not available).
883 * If mult is zero, return the content of the first matching header
884 * field only, the content of all matching header fields else */
885 FL
char * hfield_mult(char const *field
, struct message
*mp
, int mult
);
886 #define hfieldX(a, b) hfield_mult(a, b, 1)
887 #define hfield1(a, b) hfield_mult(a, b, 0)
889 /* Check whether the passed line is a header line of the desired breed.
890 * Return the field body, or 0 */
891 FL
char const * thisfield(char const *linebuf
, char const *field
);
893 /* Get sender's name from this message. If the message has a bunch of arpanet
894 * stuff in it, we may have to skin the name before returning it */
895 FL
char * nameof(struct message
*mp
, int reptype
);
897 /* Start of a "comment". Ignore it */
898 FL
char const * skip_comment(char const *cp
);
900 /* Return the start of a route-addr (address in angle brackets), if present */
901 FL
char const * routeaddr(char const *name
);
903 /* Check if a name's address part contains invalid characters */
904 FL
int is_addr_invalid(struct name
*np
, int putmsg
);
906 /* Does *NP* point to a file or pipe addressee? */
907 #define is_fileorpipe_addr(NP) \
908 (((NP)->n_flags & NAME_ADDRSPEC_ISFILEORPIPE) != 0)
910 /* Return skinned version of *NP*s name */
911 #define skinned_name(NP) \
912 (assert((NP)->n_flags & NAME_SKINNED), \
913 ((struct name const*)NP)->n_name)
915 /* Skin an address according to the RFC 822 interpretation of "host-phrase" */
916 FL
char * skin(char const *name
);
918 /* Skin *name* and extract the *addr-spec* according to RFC 5322.
919 * Store the result in .ag_skinned and also fill in those .ag_ fields that have
920 * actually been seen.
921 * Return 0 if something good has been parsed, 1 if fun didn't exactly know how
922 * to deal with the input, or if that was plain invalid */
923 FL
int addrspec_with_guts(int doskin
, char const *name
,
924 struct addrguts
*agp
);
926 /* Fetch the real name from an internet mail address field */
927 FL
char * realname(char const *name
);
929 /* Fetch the sender's name from the passed message. reptype can be
930 * 0 -- get sender's name for display purposes
931 * 1 -- get sender's name for reply
932 * 2 -- get sender's name for Reply */
933 FL
char * name1(struct message
*mp
, int reptype
);
935 FL
int msgidcmp(char const *s1
, char const *s2
);
937 /* See if the given header field is supposed to be ignored */
938 FL
int is_ign(char const *field
, size_t fieldlen
,
939 struct ignoretab ignore
[2]);
941 FL
int member(char const *realfield
, struct ignoretab
*table
);
943 /* Fake Sender for From_ lines if missing, e. g. with POP3 */
944 FL
char const * fakefrom(struct message
*mp
);
946 FL
char const * fakedate(time_t t
);
948 /* From username Fri Jan 2 20:13:51 2004
951 #if defined HAVE_IMAP_SEARCH || defined HAVE_IMAP
952 FL
time_t unixtime(char const *from
);
955 FL
time_t rfctime(char const *date
);
957 FL
time_t combinetime(int year
, int month
, int day
,
958 int hour
, int minute
, int second
);
960 FL
void substdate(struct message
*m
);
962 FL
int check_from_and_sender(struct name
*fromfield
,
963 struct name
*senderfield
);
966 FL
char * getsender(struct message
*m
);
969 /* Fill in / reedit the desired header fields */
970 FL
int grab_headers(struct header
*hp
, enum gfield gflags
,
973 /* Check wether sep->ss_sexpr (or ->ss_reexpr) matches any header of mp */
974 FL bool_t
header_match(struct message
*mp
, struct search_expr
const *sep
);
981 FL
char const * imap_fileof(char const *xcp
);
982 FL
enum okay
imap_noop(void);
983 FL
enum okay
imap_select(struct mailbox
*mp
, off_t
*size
, int *count
,
985 FL
int imap_setfile(const char *xserver
, int nmail
, int isedit
);
986 FL
enum okay
imap_header(struct message
*m
);
987 FL
enum okay
imap_body(struct message
*m
);
988 FL
void imap_getheaders(int bot
, int top
);
989 FL
void imap_quit(void);
990 FL
enum okay
imap_undelete(struct message
*m
, int n
);
991 FL
enum okay
imap_unread(struct message
*m
, int n
);
992 FL
int c_imap_imap(void *vp
);
993 FL
int imap_newmail(int nmail
);
994 FL
enum okay
imap_append(const char *xserver
, FILE *fp
);
995 FL
void imap_folders(const char *name
, int strip
);
996 FL
enum okay
imap_copy(struct message
*m
, int n
, const char *name
);
997 # ifdef HAVE_IMAP_SEARCH
998 FL
enum okay
imap_search1(const char *spec
, int f
);
1000 FL
int imap_thisaccount(const char *cp
);
1001 FL
enum okay
imap_remove(const char *name
);
1002 FL
enum okay
imap_rename(const char *old
, const char *new);
1003 FL
enum okay
imap_dequeue(struct mailbox
*mp
, FILE *fp
);
1004 FL
int c_connect(void *vp
);
1005 FL
int c_disconnect(void *vp
);
1006 FL
int c_cache(void *vp
);
1007 FL
int disconnected(const char *file
);
1008 FL
void transflags(struct message
*omessage
, long omsgCount
,
1010 FL
time_t imap_read_date_time(const char *cp
);
1011 FL
const char * imap_make_date_time(time_t t
);
1013 # define c_imap_imap c_cmdnotsupp
1014 # define c_connect c_cmdnotsupp
1015 # define c_disconnect c_cmdnotsupp
1016 # define c_cache c_cmdnotsupp
1019 #if defined HAVE_IMAP || defined HAVE_IMAP_SEARCH
1020 FL
char * imap_quotestr(char const *s
);
1021 FL
char * imap_unquotestr(char const *s
);
1029 FL
enum okay
getcache1(struct mailbox
*mp
, struct message
*m
,
1030 enum needspec need
, int setflags
);
1031 FL
enum okay
getcache(struct mailbox
*mp
, struct message
*m
,
1032 enum needspec need
);
1033 FL
void putcache(struct mailbox
*mp
, struct message
*m
);
1034 FL
void initcache(struct mailbox
*mp
);
1035 FL
void purgecache(struct mailbox
*mp
, struct message
*m
, long mc
);
1036 FL
void delcache(struct mailbox
*mp
, struct message
*m
);
1037 FL
enum okay
cache_setptr(int transparent
);
1038 FL
enum okay
cache_list(struct mailbox
*mp
, char const *base
, int strip
,
1040 FL
enum okay
cache_remove(char const *name
);
1041 FL
enum okay
cache_rename(char const *old
, char const *new);
1042 FL
unsigned long cached_uidvalidity(struct mailbox
*mp
);
1043 FL
FILE * cache_queue(struct mailbox
*mp
);
1044 FL
enum okay
cache_dequeue(struct mailbox
*mp
);
1045 #endif /* HAVE_IMAP */
1051 #ifdef HAVE_IMAP_SEARCH
1052 FL
enum okay
imap_search(char const *spec
, int f
);
1059 /* Set up editing on the given file name.
1060 * If the first character of name is %, we are considered to be editing the
1061 * file, otherwise we are reading our mail which has signficance for mbox and
1062 * so forth. nmail: Check for new mail in the current folder only */
1063 FL
int setfile(char const *name
, int nmail
);
1065 FL
int newmailinfo(int omsgCount
);
1067 /* Interpret user commands. If standard input is not a tty, print no prompt */
1068 FL
void commands(void);
1070 /* Evaluate a single command.
1071 * .ev_add_history and .ev_new_content will be updated upon success.
1072 * Command functions return 0 for success, 1 for error, and -1 for abort.
1073 * 1 or -1 aborts a load or source, a -1 aborts the interactive command loop */
1074 FL
int evaluate(struct eval_ctx
*evp
);
1075 /* TODO drop execute() is the legacy version of evaluate().
1076 * Contxt is non-zero if called while composing mail */
1077 FL
int execute(char *linebuf
, int contxt
, size_t linesize
);
1079 /* Set the size of the message vector used to construct argument lists to
1080 * message list functions */
1081 FL
void setmsize(int sz
);
1083 /* Logic behind -H / -L invocations */
1084 FL
void print_header_summary(char const *Larg
);
1086 /* The following gets called on receipt of an interrupt. This is to abort
1087 * printout of a command, mainly. Dispatching here when command() is inactive
1088 * crashes rcv. Close all open files except 0, 1, 2, and the temporary. Also,
1089 * unstack all source files */
1090 FL
void onintr(int s
);
1092 /* Announce the presence of the current Mail version, give the message count,
1093 * and print a header listing */
1094 FL
void announce(int printheaders
);
1096 /* Announce information about the file we are editing. Return a likely place
1098 FL
int newfileinfo(void);
1100 FL
int getmdot(int nmail
);
1102 FL
void initbox(char const *name
);
1104 /* Print the docstring of `comm', which may be an abbreviation.
1105 * Return FAL0 if there is no such command */
1106 #ifdef HAVE_DOCSTRINGS
1107 FL bool_t
print_comm_docstr(char const *comm
);
1114 /* Convert user string of message numbers and store the numbers into vector.
1115 * Returns the count of messages picked up or -1 on error */
1116 FL
int getmsglist(char *buf
, int *vector
, int flags
);
1118 /* Scan out the list of string arguments, shell style for a RAWLIST */
1119 FL
int getrawlist(char const *line
, size_t linesize
,
1120 char **argv
, int argc
, int echolist
);
1122 /* Find the first message whose flags&m==f and return its message number */
1123 FL
int first(int f
, int m
);
1125 /* Mark the named message by setting its mark bit */
1126 FL
void mark(int mesg
, int f
);
1128 /* lzw.c TODO drop */
1130 FL
int zwrite(void *cookie
, const char *wbp
, int num
);
1131 FL
int zfree(void *cookie
);
1132 FL
int zread(void *cookie
, char *rbp
, int num
);
1133 FL
void * zalloc(FILE *fp
);
1134 #endif /* HAVE_IMAP */
1140 FL
int maildir_setfile(char const *name
, int nmail
, int isedit
);
1142 FL
void maildir_quit(void);
1144 FL
enum okay
maildir_append(char const *name
, FILE *fp
);
1146 FL
enum okay
maildir_remove(char const *name
);
1152 /* *charset-7bit*, else CHARSET_7BIT */
1153 FL
char const * charset_get_7bit(void);
1155 /* *charset-8bit*, else CHARSET_8BIT */
1157 FL
char const * charset_get_8bit(void);
1160 /* LC_CTYPE:CODESET / *ttycharset*, else *charset-8bit*, else CHARSET_8BIT */
1161 FL
char const * charset_get_lc(void);
1163 /* *sendcharsets* .. *charset-8bit* iterator; *a_charset_to_try_first* may be
1164 * used to prepend a charset to this list (e.g., for *reply-in-same-charset*).
1165 * The returned boolean indicates charset_iter_is_valid().
1166 * Without HAVE_ICONV, this "iterates" over charset_get_lc() only */
1167 FL bool_t
charset_iter_reset(char const *a_charset_to_try_first
);
1168 FL bool_t
charset_iter_next(void);
1169 FL bool_t
charset_iter_is_valid(void);
1170 FL
char const * charset_iter(void);
1172 FL
void charset_iter_recurse(char *outer_storage
[2]); /* TODO LEGACY */
1173 FL
void charset_iter_restore(char *outer_storage
[2]); /* TODO LEGACY */
1176 FL
char const * need_hdrconv(struct header
*hp
, enum gfield w
);
1179 /* Get the mime encoding from a Content-Transfer-Encoding header field */
1180 FL
enum mimeenc
mime_getenc(char *h
);
1182 /* Get a mime style parameter from a header line */
1183 FL
char * mime_getparam(char const *param
, char *h
);
1185 /* Get the boundary out of a Content-Type: multipart/xyz header field, return
1186 * salloc()ed copy of it; store strlen() in *len if set */
1187 FL
char * mime_get_boundary(char *h
, size_t *len
);
1189 /* Create a salloc()ed MIME boundary */
1190 FL
char * mime_create_boundary(void);
1192 /* Classify content of *fp* as necessary and fill in arguments; **charset* is
1193 * left alone unless it's non-NULL */
1194 FL
int mime_classify_file(FILE *fp
, char const **contenttype
,
1195 char const **charset
, int *do_iconv
);
1198 FL
enum mimecontent
mime_classify_content_of_part(struct mimepart
const *mip
);
1200 /* Return the Content-Type matching the extension of name */
1201 FL
char * mime_classify_content_type_by_fileext(char const *name
);
1203 /* "mimetypes" command */
1204 FL
int c_mimetypes(void *v
);
1206 /* Convert header fields from RFC 1522 format */
1207 FL
void mime_fromhdr(struct str
const *in
, struct str
*out
,
1208 enum tdflags flags
);
1210 /* Interpret MIME strings in parts of an address field */
1211 FL
char * mime_fromaddr(char const *name
);
1213 /* fwrite(3) performing the given MIME conversion */
1214 FL ssize_t
mime_write(char const *ptr
, size_t size
, FILE *f
,
1215 enum conversion convert
, enum tdflags dflags
,
1216 struct quoteflt
*qf
, struct str
*rest
);
1217 FL ssize_t
xmime_write(char const *ptr
, size_t size
, /* TODO LEGACY */
1218 FILE *f
, enum conversion convert
, enum tdflags dflags
,
1223 * Content-Transfer-Encodings as defined in RFC 2045:
1224 * - Quoted-Printable, section 6.7
1225 * - Base64, section 6.8
1228 /* How many characters of (the complete body) ln need to be quoted */
1229 FL
size_t mime_cte_mustquote(char const *ln
, size_t lnlen
, bool_t ishead
);
1231 /* How much space is necessary to encode len bytes in QP, worst case.
1232 * Includes room for terminator */
1233 FL
size_t qp_encode_calc_size(size_t len
);
1235 /* If flags includes QP_ISHEAD these assume "word" input and use special
1236 * quoting rules in addition; soft line breaks are not generated.
1237 * Otherwise complete input lines are assumed and soft line breaks are
1238 * generated as necessary */
1239 FL
struct str
* qp_encode(struct str
*out
, struct str
const *in
,
1240 enum qpflags flags
);
1242 FL
struct str
* qp_encode_cp(struct str
*out
, char const *cp
,
1243 enum qpflags flags
);
1244 FL
struct str
* qp_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
1245 enum qpflags flags
);
1248 /* If rest is set then decoding will assume body text input (assumes input
1249 * represents lines, only create output when input didn't end with soft line
1250 * break [except it finalizes an encoded CRLF pair]), otherwise it is assumed
1251 * to decode a header strings and (1) uses special decoding rules and (b)
1252 * directly produces output.
1253 * The buffers of out and possibly rest will be managed via srealloc().
1254 * Returns OKAY. XXX or STOP on error (in which case out is set to an error
1255 * XXX message); caller is responsible to free buffers */
1256 FL
int qp_decode(struct str
*out
, struct str
const *in
,
1259 /* How much space is necessary to encode len bytes in Base64, worst case.
1260 * Includes room for (CR/LF/CRLF and) terminator */
1261 FL
size_t b64_encode_calc_size(size_t len
);
1263 /* Note these simply convert all the input (if possible), including the
1264 * insertion of NL sequences if B64_CRLF or B64_LF is set (and multiple thereof
1265 * if B64_MULTILINE is set).
1266 * Thus, in the B64_BUF case, better call b64_encode_calc_size() first */
1267 FL
struct str
* b64_encode(struct str
*out
, struct str
const *in
,
1268 enum b64flags flags
);
1269 FL
struct str
* b64_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
1270 enum b64flags flags
);
1272 FL
struct str
* b64_encode_cp(struct str
*out
, char const *cp
,
1273 enum b64flags flags
);
1276 /* If rest is set then decoding will assume text input.
1277 * The buffers of out and possibly rest will be managed via srealloc().
1278 * Returns OKAY or STOP on error (in which case out is set to an error
1279 * message); caller is responsible to free buffers */
1280 FL
int b64_decode(struct str
*out
, struct str
const *in
,
1287 /* Allocate a single element of a name list, initialize its name field to the
1288 * passed name and return it */
1289 FL
struct name
* nalloc(char *str
, enum gfield ntype
);
1291 /* Like nalloc(), but initialize from content of np */
1292 FL
struct name
* ndup(struct name
*np
, enum gfield ntype
);
1294 /* Concatenate the two passed name lists, return the result */
1295 FL
struct name
* cat(struct name
*n1
, struct name
*n2
);
1297 /* Determine the number of undeleted elements in a name list and return it;
1298 * the latter also doesn't count file and pipe addressees in addition */
1299 FL ui32_t
count(struct name
const *np
);
1300 FL ui32_t
count_nonlocal(struct name
const *np
);
1302 /* Extract a list of names from a line, and make a list of names from it.
1303 * Return the list or NULL if none found */
1304 FL
struct name
* extract(char const *line
, enum gfield ntype
);
1306 /* Like extract() unless line contains anyof ",\"\\(<|", in which case
1307 * comma-separated list extraction is used instead */
1308 FL
struct name
* lextract(char const *line
, enum gfield ntype
);
1310 /* Turn a list of names into a string of the same names */
1311 FL
char * detract(struct name
*np
, enum gfield ntype
);
1313 /* Get a lextract() list via readstr_input(), reassigning to *np* */
1314 FL
struct name
* grab_names(char const *field
, struct name
*np
, int comma
,
1315 enum gfield gflags
);
1317 /* Check all addresses in np and delete invalid ones */
1318 FL
struct name
* checkaddrs(struct name
*np
);
1320 /* Map all of the aliased users in the invoker's mailrc file and insert them
1322 FL
struct name
* usermap(struct name
*names
, bool_t force_metoo
);
1324 /* Remove all of the duplicates from the passed name list by insertion sorting
1325 * them, then checking for dups. Return the head of the new list */
1326 FL
struct name
* elide(struct name
*names
);
1328 FL
struct name
* delete_alternates(struct name
*np
);
1330 FL
int is_myname(char const *name
);
1332 /* Dispatch a message to all pipe and file addresses TODO -> sendout.c */
1333 FL
struct name
* outof(struct name
*names
, FILE *fo
, bool_t
*senderror
);
1335 /* Handling of alias groups */
1337 /* Locate a group name and return it */
1338 FL
struct grouphead
* findgroup(char *name
);
1340 /* Print a group out on stdout */
1341 FL
void printgroup(char *name
);
1343 FL
void remove_group(char const *name
);
1351 FL
enum okay
ssl_open(char const *server
, struct sock
*sp
, char const *uhp
);
1354 FL
void ssl_gen_err(char const *fmt
, ...);
1357 FL
int c_verify(void *vp
);
1360 FL
FILE * smime_sign(FILE *ip
, char const *addr
);
1363 FL
FILE * smime_encrypt(FILE *ip
, char const *certfile
, char const *to
);
1365 FL
struct message
* smime_decrypt(struct message
*m
, char const *to
,
1366 char const *cc
, int signcall
);
1369 FL
enum okay
smime_certsave(struct message
*m
, int n
, FILE *op
);
1371 #else /* HAVE_OPENSSL */
1372 # define c_verify c_cmdnotsupp
1381 FL
enum okay
pop3_noop(void);
1384 FL
int pop3_setfile(char const *server
, int nmail
, int isedit
);
1387 FL
enum okay
pop3_header(struct message
*m
);
1390 FL
enum okay
pop3_body(struct message
*m
);
1393 FL
void pop3_quit(void);
1394 #endif /* HAVE_POP3 */
1398 * Subprocesses, popen, but also file handling with registering
1401 /* For program startup in main.c: initialize process manager */
1402 FL
void command_manager_start(void);
1404 /* Notes: OF_CLOEXEC is implied in oflags, xflags may be NULL */
1405 FL
FILE * safe_fopen(char const *file
, char const *oflags
, int *xflags
);
1407 /* Notes: OF_CLOEXEC|OF_REGISTER are implied in oflags */
1408 FL
FILE * Fopen(char const *file
, char const *oflags
);
1410 FL
FILE * Fdopen(int fd
, char const *oflags
);
1412 FL
int Fclose(FILE *fp
);
1414 FL
FILE * Zopen(char const *file
, char const *oflags
, int *compression
);
1416 /* Create a temporary file in tempdir, use prefix for its name, store the
1417 * unique name in fn (unless OF_UNLINK is set in oflags), and return a stdio
1418 * FILE pointer with access oflags. OF_CLOEXEC is implied in oflags.
1419 * mode specifies the access mode of the newly created temporary file */
1420 FL
FILE * Ftmp(char **fn
, char const *prefix
, enum oflags oflags
,
1423 /* If OF_HOLDSIGS was set when calling Ftmp(), then hold_all_sigs() had been
1424 * called: call this to unlink(2) and free *fn and to rele_all_sigs() */
1425 FL
void Ftmp_release(char **fn
);
1427 /* Free the resources associated with the given filename. To be called after
1429 FL
void Ftmp_free(char **fn
);
1431 /* Create a pipe and ensure CLOEXEC bit is set in both descriptors */
1432 FL bool_t
pipe_cloexec(int fd
[2]);
1434 FL
FILE * Popen(char const *cmd
, char const *mode
, char const *shell
,
1435 char const *env_addon
, int newfd1
);
1437 FL bool_t
Pclose(FILE *ptr
, bool_t dowait
);
1439 FL
void close_all_files(void);
1441 /* Run a command without a shell, with optional arguments and splicing of stdin
1442 * and stdout. The command name can be a sequence of words. Signals must be
1443 * handled by the caller. "Mask" contains the signals to ignore in the new
1444 * process. SIGINT is enabled unless it's in the mask */
1445 FL
int run_command(char const *cmd
, sigset_t
*mask
, int infd
,
1446 int outfd
, char const *a0
, char const *a1
, char const *a2
);
1448 FL
int start_command(char const *cmd
, sigset_t
*mask
, int infd
,
1449 int outfd
, char const *a0
, char const *a1
, char const *a2
,
1450 char const *env_addon
);
1452 FL
void prepare_child(sigset_t
*nset
, int infd
, int outfd
);
1454 /* Mark a child as don't care */
1455 FL
void free_child(int pid
);
1457 /* Wait for pid, return wether we've had a normal EXIT_SUCCESS exit.
1458 * If wait_status is set, set it to the reported waitpid(2) wait status */
1459 FL bool_t
wait_child(int pid
, int *wait_status
);
1465 /* The `quit' command */
1466 FL
int c_quit(void *v
);
1468 /* Save all of the undetermined messages at the top of "mbox". Save all
1469 * untouched messages back in the system mailbox. Remove the system mailbox,
1470 * if none saved there */
1473 /* Adjust the message flags in each message */
1474 FL
int holdbits(void);
1476 /* Create another temporary file and copy user's mbox file darin. If there is
1477 * no mbox, copy nothing. If he has specified "append" don't copy his mailbox,
1478 * just copy saveable entries at the end */
1479 FL
enum okay
makembox(void);
1481 FL
void save_mbox_for_possible_quitstuff(void); /* TODO DROP IF U CAN */
1483 FL
int savequitflags(void);
1485 FL
void restorequitflags(int);
1491 /* Send message described by the passed pointer to the passed output buffer.
1492 * Return -1 on error. Adjust the status: field if need be. If doign is
1493 * given, suppress ignored header fields. prefix is a string to prepend to
1494 * each output line. action = data destination
1495 * (SEND_MBOX,_TOFILE,_TODISP,_QUOTE,_DECRYPT). stats[0] is line count,
1496 * stats[1] is character count. stats may be NULL. Note that stats[0] is
1497 * valid for SEND_MBOX only */
1498 FL
int sendmp(struct message
*mp
, FILE *obuf
, struct ignoretab
*doign
,
1499 char const *prefix
, enum sendaction action
, off_t
*stats
);
1505 /* Interface between the argument list and the mail1 routine which does all the
1507 FL
int mail(struct name
*to
, struct name
*cc
, struct name
*bcc
,
1508 char *subject
, struct attachment
*attach
, char *quotefile
,
1509 int recipient_record
);
1511 /* `mail' and `Mail' commands, respectively */
1512 FL
int c_sendmail(void *v
);
1513 FL
int c_Sendmail(void *v
);
1515 /* Mail a message on standard input to the people indicated in the passed
1516 * header. (Internal interface) */
1517 FL
enum okay
mail1(struct header
*hp
, int printheaders
,
1518 struct message
*quote
, char *quotefile
, int recipient_record
,
1521 /* Create a Date: header field.
1522 * We compare the localtime() and gmtime() results to get the timezone, because
1523 * numeric timezones are easier to read and because $TZ isn't always set */
1524 FL
int mkdate(FILE *fo
, char const *field
);
1526 /* Dump the to, subject, cc header on the passed file buffer */
1527 FL
int puthead(struct header
*hp
, FILE *fo
, enum gfield w
,
1528 enum sendaction action
, enum conversion convert
,
1529 char const *contenttype
, char const *charset
);
1532 FL
enum okay
resend_msg(struct message
*mp
, struct name
*to
, int add_resent
);
1539 /* Send a message via SMTP */
1540 FL bool_t
smtp_mta(struct sendbundle
*sbp
);
1548 /* Direct mappings of the various spam* commands */
1549 FL
int c_spam_clear(void *v
);
1550 FL
int c_spam_set(void *v
);
1551 FL
int c_spam_forget(void *v
);
1552 FL
int c_spam_ham(void *v
);
1553 FL
int c_spam_rate(void *v
);
1554 FL
int c_spam_spam(void *v
);
1556 # define c_spam_clear c_cmdnotsupp
1557 # define c_spam_set c_cmdnotsupp
1558 # define c_spam_forget c_cmdnotsupp
1559 # define c_spam_ham c_cmdnotsupp
1560 # define c_spam_rate c_cmdnotsupp
1561 # define c_spam_spam c_cmdnotsupp
1570 FL
void ssl_set_verify_level(char const *uhp
);
1573 FL
enum okay
ssl_verify_decide(void);
1576 FL
char * ssl_method_string(char const *uhp
);
1579 FL
enum okay
smime_split(FILE *ip
, FILE **hp
, FILE **bp
, long xcount
,
1583 FL
FILE * smime_sign_assemble(FILE *hp
, FILE *bp
, FILE *sp
);
1586 FL
FILE * smime_encrypt_assemble(FILE *hp
, FILE *yp
);
1589 FL
struct message
* smime_decrypt_assemble(struct message
*m
, FILE *hp
,
1593 FL
int c_certsave(void *v
);
1596 FL
enum okay
rfc2595_hostname_match(char const *host
, char const *pattern
);
1597 #else /* HAVE_SSL */
1598 # define c_certsave c_cmdnotsupp
1603 * This bundles several different string related support facilities:
1604 * - auto-reclaimed string storage (memory goes away on command loop ticks)
1605 * - plain char* support functions which use unspecified or smalloc() memory
1606 * - struct str related support funs
1607 * - our iconv(3) wrapper
1610 /* Auto-reclaimed string storage */
1613 # define SALLOC_DEBUG_ARGS , char const *mdbg_file, int mdbg_line
1614 # define SALLOC_DEBUG_ARGSCALL , mdbg_file, mdbg_line
1616 # define SALLOC_DEBUG_ARGS
1617 # define SALLOC_DEBUG_ARGSCALL
1620 /* Allocate size more bytes of space and return the address of the first byte
1621 * to the caller. An even number of bytes are always allocated so that the
1622 * space will always be on a word boundary */
1623 FL
void * salloc(size_t size SALLOC_DEBUG_ARGS
);
1624 FL
void * csalloc(size_t nmemb
, size_t size SALLOC_DEBUG_ARGS
);
1626 # define salloc(SZ) salloc(SZ, __FILE__, __LINE__)
1627 # define csalloc(NM,SZ) csalloc(NM, SZ, __FILE__, __LINE__)
1630 /* Auto-reclaim string storage; if only_if_relaxed is true then only perform
1631 * the reset when a srelax_hold() is currently active */
1632 FL
void sreset(bool_t only_if_relaxed
);
1634 /* The "problem" with sreset() is that it releases all string storage except
1635 * what was present once spreserve() had been called; it therefore cannot be
1636 * called from all that code which yet exists and walks about all the messages
1637 * in order, e.g. quit(), searches, etc., because, unfortunately, these code
1638 * paths are reached with new intermediate string dope already in use.
1639 * Thus such code should take a srelax_hold(), successively call srelax() after
1640 * a single message has been handled, and finally srelax_rele() (unless it is
1641 * clear that sreset() occurs anyway) */
1642 FL
void srelax_hold(void);
1643 FL
void srelax_rele(void);
1644 FL
void srelax(void);
1646 /* Make current string storage permanent: new allocs will be auto-reclaimed by
1647 * sreset(). This is called once only, from within main() */
1648 FL
void spreserve(void);
1650 /* 'sstats' command */
1652 FL
int c_sstats(void *v
);
1655 /* Return a pointer to a dynamic copy of the argument */
1656 FL
char * savestr(char const *str SALLOC_DEBUG_ARGS
);
1657 FL
char * savestrbuf(char const *sbuf
, size_t sbuf_len SALLOC_DEBUG_ARGS
);
1659 # define savestr(CP) savestr(CP, __FILE__, __LINE__)
1660 # define savestrbuf(CBP,CBL) savestrbuf(CBP, CBL, __FILE__, __LINE__)
1663 /* Make copy of argument incorporating old one, if set, separated by space */
1664 FL
char * save2str(char const *str
, char const *old SALLOC_DEBUG_ARGS
);
1666 # define save2str(S,O) save2str(S, O, __FILE__, __LINE__)
1670 FL
char * savecat(char const *s1
, char const *s2 SALLOC_DEBUG_ARGS
);
1672 # define savecat(S1,S2) savecat(S1, S2, __FILE__, __LINE__)
1675 /* Create duplicate, lowercasing all characters along the way */
1676 FL
char * i_strdup(char const *src SALLOC_DEBUG_ARGS
);
1678 # define i_strdup(CP) i_strdup(CP, __FILE__, __LINE__)
1681 /* Extract the protocol base and return a duplicate */
1682 FL
char * protbase(char const *cp SALLOC_DEBUG_ARGS
);
1684 # define protbase(CP) protbase(CP, __FILE__, __LINE__)
1687 /* URL en- and decoding (RFC 1738, but not really) */
1688 FL
char * urlxenc(char const *cp
, bool_t ispath SALLOC_DEBUG_ARGS
);
1689 FL
char * urlxdec(char const *cp SALLOC_DEBUG_ARGS
);
1691 # define urlxenc(CP,P) urlxenc(CP, P, __FILE__, __LINE__)
1692 # define urlxdec(CP) urlxdec(CP, __FILE__, __LINE__)
1696 FL
struct str
* str_concat_csvl(struct str
*self
, ...);
1699 FL
struct str
* str_concat_cpa(struct str
*self
, char const * const *cpa
,
1700 char const *sep_o_null SALLOC_DEBUG_ARGS
);
1702 # define str_concat_cpa(S,A,N) str_concat_cpa(S, A, N, __FILE__, __LINE__)
1706 /* Plain char* support, not auto-reclaimed (unless noted) */
1708 /* Are any of the characters in the two strings the same? */
1709 FL
int anyof(char const *s1
, char const *s2
);
1711 /* Treat *iolist as a sep separated list of strings; find and return the
1712 * next entry, trimming surrounding whitespace, and point *iolist to the next
1713 * entry or to NULL if no more entries are contained. If ignore_empty is not
1714 * set empty entries are started over. Return NULL or an entry */
1715 FL
char * n_strsep(char **iolist
, char sep
, bool_t ignore_empty
);
1717 /* Copy a string, lowercasing it as we go; *size* is buffer size of *dest*;
1718 * *dest* will always be terminated unless *size* is 0 */
1719 FL
void i_strcpy(char *dest
, char const *src
, size_t size
);
1721 /* Is *as1* a valid prefix of *as2*? */
1722 FL
int is_prefix(char const *as1
, char const *as2
);
1724 /* Find the last AT @ before the first slash */
1725 FL
char const * last_at_before_slash(char const *sp
);
1727 /* Get (and isolate) the last, possibly quoted part of linebuf, set *needs_list
1728 * to indicate wether getmsglist() et al need to be called to collect
1729 * additional args that remain in linebuf. Return NULL on "error" */
1730 FL
char * laststring(char *linebuf
, bool_t
*needs_list
, bool_t strip
);
1732 /* Convert a string to lowercase, in-place and with multibyte-aware */
1733 FL
void makelow(char *cp
);
1735 /* Is *sub* a substring of *str*, case-insensitive and multibyte-aware? */
1736 FL bool_t
substr(char const *str
, char const *sub
);
1738 /* Lazy vsprintf wrapper */
1739 #ifndef HAVE_SNPRINTF
1740 FL
int snprintf(char *str
, size_t size
, char const *format
, ...);
1743 FL
char * sstpcpy(char *dst
, char const *src
);
1744 FL
char * sstrdup(char const *cp SMALLOC_DEBUG_ARGS
);
1745 FL
char * sbufdup(char const *cp
, size_t len SMALLOC_DEBUG_ARGS
);
1747 # define sstrdup(CP) sstrdup(CP, __FILE__, __LINE__)
1748 # define sbufdup(CP,L) sbufdup(CP, L, __FILE__, __LINE__)
1751 FL
char * n_strlcpy(char *dst
, char const *src
, size_t len
);
1753 /* Locale-independent character class functions */
1754 FL
int asccasecmp(char const *s1
, char const *s2
);
1755 FL
int ascncasecmp(char const *s1
, char const *s2
, size_t sz
);
1756 FL bool_t
is_asccaseprefix(char const *as1
, char const *as2
);
1758 FL
char const * asccasestr(char const *haystack
, char const *xneedle
);
1761 /* struct str related support funs */
1763 /* *self->s* is srealloc()ed */
1764 FL
struct str
* n_str_dup(struct str
*self
, struct str
const *t
1765 SMALLOC_DEBUG_ARGS
);
1767 /* *self->s* is srealloc()ed, *self->l* incremented */
1768 FL
struct str
* n_str_add_buf(struct str
*self
, char const *buf
, size_t buflen
1769 SMALLOC_DEBUG_ARGS
);
1770 #define n_str_add(S, T) n_str_add_buf(S, (T)->s, (T)->l)
1771 #define n_str_add_cp(S, CP) n_str_add_buf(S, CP, (CP) ? strlen(CP) : 0)
1774 # define n_str_dup(S,T) n_str_dup(S, T, __FILE__, __LINE__)
1775 # define n_str_add_buf(S,B,BL) n_str_add_buf(S, B, BL, __FILE__, __LINE__)
1778 /* Our iconv(3) wrappers */
1781 FL iconv_t
n_iconv_open(char const *tocode
, char const *fromcode
);
1782 /* If *cd* == *iconvd*, assigns -1 to the latter */
1783 FL
void n_iconv_close(iconv_t cd
);
1785 /* Reset encoding state */
1787 FL
void n_iconv_reset(iconv_t cd
);
1790 /* iconv(3), but return *errno* or 0; *skipilseq* forces step over invalid byte
1791 * sequences; likewise iconv_str(), but which auto-grows on E2BIG errors; *in*
1792 * and *in_rest_or_null* may be the same object.
1793 * Note: EINVAL (incomplete sequence at end of input) is NOT handled, so the
1794 * replacement character must be added manually if that happens at EOF! */
1795 FL
int n_iconv_buf(iconv_t cd
, char const **inb
, size_t *inbleft
,
1796 char **outb
, size_t *outbleft
, bool_t skipilseq
);
1797 FL
int n_iconv_str(iconv_t icp
, struct str
*out
, struct str
const *in
,
1798 struct str
*in_rest_or_null
, bool_t skipilseq
);
1806 FL
int c_thread(void *vp
);
1809 FL
int c_unthread(void *vp
);
1812 FL
struct message
* next_in_thread(struct message
*mp
);
1813 FL
struct message
* prev_in_thread(struct message
*mp
);
1814 FL
struct message
* this_in_thread(struct message
*mp
, long n
);
1816 /* Sorted mode is internally just a variant of threaded mode with all m_parent
1817 * and m_child links being NULL */
1818 FL
int c_sort(void *vp
);
1821 FL
int c_collapse(void *v
);
1822 FL
int c_uncollapse(void *v
);
1825 FL
void uncollapse1(struct message
*mp
, int always
);
1831 /* Return wether user says yes. If prompt is NULL, "Continue (y/n)? " is used
1832 * instead. If interactive, asks on STDIN, anything but [0]==[Nn] is true.
1833 * If noninteractive, returns noninteract_default. Handles+reraises SIGINT */
1834 FL bool_t
getapproval(char const *prompt
, bool_t noninteract_default
);
1836 /* Get a password the expected way, return termios_state.ts_linebuf on
1837 * success or NULL on error */
1838 FL
char * getuser(char const *query
);
1840 /* Get a password the expected way, return termios_state.ts_linebuf on
1841 * success or NULL on error. SIGINT is temporarily blocked, *not* reraised.
1842 * termios_state_reset() (def.h) must be called anyway */
1843 FL
char * getpassword(char const *query
);
1845 /* Overall interactive terminal life cycle for command line editor library */
1846 #if defined HAVE_EDITLINE || defined HAVE_READLINE
1847 # define TTY_WANTS_SIGWINCH
1849 FL
void tty_init(void);
1850 FL
void tty_destroy(void);
1852 /* Rather for main.c / SIGWINCH interaction only */
1853 FL
void tty_signal(int sig
);
1855 /* Read a line after printing prompt (if set and non-empty).
1856 * If n>0 assumes that *linebuf has n bytes of default content */
1857 FL
int tty_readline(char const *prompt
, char **linebuf
,
1858 size_t *linesize
, size_t n SMALLOC_DEBUG_ARGS
);
1860 # define tty_readline(A,B,C,D) tty_readline(A, B, C, D, __FILE__, __LINE__)
1863 /* Add a line (most likely as returned by tty_readline()) to the history.
1864 * Wether an entry added for real depends on the isgabby / *history-gabby*
1865 * relation, and / or wether s is non-empty and doesn't begin with U+0020 */
1866 FL
void tty_addhist(char const *s
, bool_t isgabby
);
1868 #if defined HAVE_HISTORY &&\
1869 (defined HAVE_READLINE || defined HAVE_EDITLINE || defined HAVE_NCL)
1870 FL
int c_history(void *v
);
1873 #ifndef HAVE_AMALGAMATION
1878 /* vim:set fenc=utf-8:s-it-mode */