1 /*@ S-nail - a mail user agent derived from Berkeley Mail.
2 *@ Exported function prototypes.
4 * Copyright (c) 2000-2004 Gunnar Ritter, Freiburg i. Br., Germany.
5 * Copyright (c) 2012 - 2014 Steffen "Daode" Nurpmeso <sdaoden@users.sf.net>.
8 * Copyright (c) 1992, 1993
9 * The Regents of the University of California. All rights reserved.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed by the University of
22 * California, Berkeley and its contributors.
23 * 4. Neither the name of the University nor the names of its contributors
24 * may be used to endorse or promote products derived from this software
25 * without specific prior written permission.
27 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
41 * TODO Convert optional utility+ functions to n_*(); ditto
42 * TODO else use generic module-specific prefixes: str_(), am[em]_, sm[em]_, ..
44 /* TODO s-it-mode: not really (docu, funnames, funargs, etc) */
47 #ifndef HAVE_AMALGAMATION
57 /* Don't use _var_* unless you *really* have to! */
59 /* Constant option key look/(un)set/clear */
60 FL
char * _var_oklook(enum okeys okey
);
61 #define ok_blook(C) (_var_oklook(CONCAT(ok_b_, C)) != NULL)
62 #define ok_vlook(C) _var_oklook(CONCAT(ok_v_, C))
64 FL bool_t
_var_okset(enum okeys okey
, uintptr_t val
);
65 #define ok_bset(C,B) _var_okset(CONCAT(ok_b_, C), (uintptr_t)(B))
66 #define ok_vset(C,V) _var_okset(CONCAT(ok_v_, C), (uintptr_t)(V))
68 FL bool_t
_var_okclear(enum okeys okey
);
69 #define ok_bclear(C) _var_okclear(CONCAT(ok_b_, C))
70 #define ok_vclear(C) _var_okclear(CONCAT(ok_v_, C))
72 /* Variable option key look/(un)set/clear */
73 FL
char * _var_voklook(char const *vokey
);
74 #define vok_blook(S) (_var_voklook(S) != NULL)
75 #define vok_vlook(S) _var_voklook(S)
77 FL bool_t
_var_vokset(char const *vokey
, uintptr_t val
);
78 #define vok_bset(S,B) _var_vokset(S, (uintptr_t)(B))
79 #define vok_vset(S,V) _var_vokset(S, (uintptr_t)(V))
81 FL bool_t
_var_vokclear(char const *vokey
);
82 #define vok_bclear(S) _var_vokclear(S)
83 #define vok_vclear(S) _var_vokclear(S)
85 /* List all variables */
86 FL
void var_list_all(void);
88 FL
int c_var_inspect(void *v
);
89 FL
int c_define(void *v
);
90 FL
int c_undef(void *v
);
91 FL
int c_call(void *v
);
93 FL
int callhook(char const *name
, int nmail
);
96 FL
int c_defines(void *v
);
99 FL
int c_account(void *v
);
102 FL
int c_localopts(void *v
);
108 /* Try to add an attachment for *file*, file_expand()ed.
109 * Return the new head of list *aphead*, or NULL.
110 * The newly created attachment will be stored in **newap*, if given */
111 FL
struct attachment
* add_attachment(struct attachment
*aphead
, char *file
,
112 struct attachment
**newap
);
114 /* Append comma-separated list of file names to the end of attachment list */
115 FL
struct attachment
* append_attachments(struct attachment
*aphead
,
118 /* Interactively edit the attachment list, return the new list head */
119 FL
struct attachment
* 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
);
179 #define try_pager(FP) page_or_print(FP, 0) /* TODO obsolete */
181 /* Parse name and guess at the required protocol */
182 FL
enum protocol
which_protocol(char const *name
);
184 /* Hash the passed string -- uses Chris Torek's hash algorithm */
185 FL ui32_t
torek_hash(char const *name
);
186 #define hash(S) (torek_hash(S) % HSHSIZE) /* xxx COMPAT (?) */
189 FL ui32_t
pjw(char const *cp
); /* TODO obsolete -> torek_hash() */
191 /* Find a prime greater than n */
192 FL ui32_t
nextprime(ui32_t n
);
194 /* Check wether *s is an escape sequence, expand it as necessary.
195 * Returns the expanded sequence or 0 if **s is NUL or PROMPT_STOP if it is \c.
196 * *s is advanced to after the expanded sequence (as possible).
197 * If use_prompt_extensions is set, an enum prompt_exp may be returned */
198 FL
int expand_shell_escape(char const **s
,
199 bool_t use_prompt_extensions
);
201 /* Get *prompt*, or '& ' if *bsdcompat*, of '? ' otherwise */
202 FL
char * getprompt(void);
204 /* Detect and query the hostname to use */
205 FL
char * nodename(int mayoverride
);
207 /* Try to lookup a variable named "password-*token*".
208 * Return NULL or salloc()ed buffer */
209 FL
char * lookup_password_for_token(char const *token
);
211 /* Get a (pseudo) random string of *length* bytes; returns salloc()ed buffer */
212 FL
char * getrandstring(size_t length
);
214 #define Hexchar(n) ((n)>9 ? (n)-10+'A' : (n)+'0')
215 #define hexchar(n) ((n)>9 ? (n)-10+'a' : (n)+'0')
217 /* MD5 (RFC 1321) related facilities */
219 # ifdef HAVE_OPENSSL_MD5
220 # define md5_ctx MD5_CTX
221 # define md5_init MD5_Init
222 # define md5_update MD5_Update
223 # define md5_final MD5_Final
225 # include "rfc1321.h"
228 /* Store the MD5 checksum as a hexadecimal string in *hex*, *not* terminated */
229 # define MD5TOHEX_SIZE 32
230 FL
char * md5tohex(char hex
[MD5TOHEX_SIZE
], void const *vp
);
232 /* CRAM-MD5 encode the *user* / *pass* / *b64* combo */
233 FL
char * cram_md5_string(char const *user
, char const *pass
,
236 /* RFC 2104: HMAC: Keyed-Hashing for Message Authentication.
237 * unsigned char *text: pointer to data stream
238 * int text_len : length of data stream
239 * unsigned char *key : pointer to authentication key
240 * int key_len : length of authentication key
241 * caddr_t digest : caller digest to be filled in */
242 FL
void hmac_md5(unsigned char *text
, int text_len
, unsigned char *key
,
243 int key_len
, void *digest
);
246 FL
enum okay
makedir(char const *name
);
248 /* A get-wd..restore-wd approach */
249 FL
enum okay
cwget(struct cw
*cw
);
250 FL
enum okay
cwret(struct cw
*cw
);
251 FL
void cwrelse(struct cw
*cw
);
253 /* xxx Place cp in a salloc()ed buffer, column-aligned */
254 FL
char * colalign(char const *cp
, int col
, int fill
,
255 int *cols_decr_used_or_null
);
257 /* Convert a string to a displayable one;
258 * prstr() returns the result savestr()d, prout() writes it */
259 FL
void makeprint(struct str
const *in
, struct str
*out
);
260 FL
char * prstr(char const *s
);
261 FL
int prout(char const *s
, size_t sz
, FILE *fp
);
263 /* Print out a Unicode character or a substitute for it, return 0 on error or
264 * wcwidth() (or 1) on success */
265 FL
size_t putuc(int u
, int c
, FILE *fp
);
267 /* We want coloured output (in this salloc() cycle). If pager_used is not NULL
268 * we check against *colour-pagers* wether colour is really desirable */
270 FL
void colour_table_create(char const *pager_used
);
271 FL
void colour_put(FILE *fp
, enum colourspec cs
);
272 FL
void colour_put_header(FILE *fp
, char const *name
);
273 FL
void colour_reset(FILE *fp
);
274 FL
struct str
const * colour_get(enum colourspec cs
);
276 # define colour_put(FP,CS)
277 # define colour_put_header(FP,N)
278 # define colour_reset(FP)
281 /* Update *tc* to now; only .tc_time updated unless *full_update* is true */
282 FL
void time_current_update(struct time_current
*tc
,
285 /* Memory allocation routines */
287 # define SMALLOC_DEBUG_ARGS , char const *mdbg_file, int mdbg_line
288 # define SMALLOC_DEBUG_ARGSCALL , mdbg_file, mdbg_line
290 # define SMALLOC_DEBUG_ARGS
291 # define SMALLOC_DEBUG_ARGSCALL
294 FL
void * smalloc(size_t s SMALLOC_DEBUG_ARGS
);
295 FL
void * srealloc(void *v
, size_t s SMALLOC_DEBUG_ARGS
);
296 FL
void * scalloc(size_t nmemb
, size_t size SMALLOC_DEBUG_ARGS
);
299 FL
void sfree(void *v SMALLOC_DEBUG_ARGS
);
300 /* Called by sreset(), then */
301 FL
void smemreset(void);
303 FL
int c_smemtrace(void *v
);
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 ccmdnotsupp(void *v
);
322 /* Show header group */
323 FL
int headers(void *v
);
325 /* Scroll to the next/previous screen */
326 FL
int scroll(void *v
);
327 FL
int Scroll(void *v
);
329 /* Print out the headlines for each message in the passed message list */
330 FL
int from(void *v
);
332 /* Print all message in between bottom and topx (including bottom) */
333 FL
void print_headers(size_t bottom
, size_t topx
);
335 /* Print out the value of dot */
336 FL
int pdot(void *v
);
338 /* Paginate messages, honor/don't honour ignored fields, respectively */
339 FL
int more(void *v
);
340 FL
int More(void *v
);
342 /* Type out messages, honor/don't honour ignored fields, respectively */
343 FL
int type(void *v
);
344 FL
int Type(void *v
);
346 /* Show MIME-encoded message text, including all fields */
347 FL
int show(void *v
);
349 /* Pipe messages, honor/don't honour ignored fields, respectively */
350 FL
int pipecmd(void *v
);
351 FL
int Pipecmd(void *v
);
353 /* Print the top so many lines of each desired message.
354 * The number of lines is taken from *toplines* and defaults to 5 */
357 /* Touch all the given messages so that they will get mboxed */
358 FL
int stouch(void *v
);
360 /* Make sure all passed messages get mboxed */
361 FL
int mboxit(void *v
);
363 /* List the folders the user currently has */
364 FL
int folders(void *v
);
370 /* If any arguments were given, go to the next applicable argument following
371 * dot, otherwise, go to the next applicable message. If given as first
372 * command with no arguments, print first message */
373 FL
int next(void *v
);
375 /* Save a message in a file. Mark the message as saved so we can discard when
377 FL
int save(void *v
);
378 FL
int Save(void *v
);
380 /* Copy a message to a file without affected its saved-ness */
381 FL
int copycmd(void *v
);
382 FL
int Copycmd(void *v
);
384 /* Move a message to a file */
385 FL
int cmove(void *v
);
386 FL
int cMove(void *v
);
388 /* Decrypt and copy a message to a file */
389 FL
int cdecrypt(void *v
);
390 FL
int cDecrypt(void *v
);
392 /* Write the indicated messages at the end of the passed file name, minus
393 * header and trailing blank line. This is the MIME save function */
394 FL
int cwrite(void *v
);
396 /* Delete messages */
397 FL
int delete(void *v
);
399 /* Delete messages, then type the new dot */
400 FL
int deltype(void *v
);
402 /* Undelete the indicated messages */
403 FL
int undeletecmd(void *v
);
405 /* Add the given header fields to the retained list. If no arguments, print
406 * the current list of retained fields */
407 FL
int retfield(void *v
);
409 /* Add the given header fields to the ignored list. If no arguments, print the
410 * current list of ignored fields */
411 FL
int igfield(void *v
);
413 FL
int saveretfield(void *v
);
414 FL
int saveigfield(void *v
);
415 FL
int fwdretfield(void *v
);
416 FL
int fwdigfield(void *v
);
417 FL
int unignore(void *v
);
418 FL
int unretain(void *v
);
419 FL
int unsaveignore(void *v
);
420 FL
int unsaveretain(void *v
);
421 FL
int unfwdignore(void *v
);
422 FL
int unfwdretain(void *v
);
428 /* Process a shell escape by saving signals, ignoring signals and a sh -c */
429 FL
int shell(void *v
);
431 /* Fork an interactive shell */
432 FL
int dosh(void *v
);
434 /* Show the help screen */
435 FL
int help(void *v
);
437 /* Print user's working directory */
438 FL
int c_cwd(void *v
);
440 /* Change user's working directory */
441 FL
int c_chdir(void *v
);
443 FL
int respond(void *v
);
444 FL
int respondall(void *v
);
445 FL
int respondsender(void *v
);
446 FL
int Respond(void *v
);
447 FL
int followup(void *v
);
448 FL
int followupall(void *v
);
449 FL
int followupsender(void *v
);
450 FL
int Followup(void *v
);
452 /* The 'forward' command */
453 FL
int forwardcmd(void *v
);
455 /* Similar to forward, saving the message in a file named after the first
457 FL
int Forwardcmd(void *v
);
459 /* Resend a message list to a third person */
460 FL
int resendcmd(void *v
);
462 /* Resend a message list to a third person without adding headers */
463 FL
int Resendcmd(void *v
);
465 /* Preserve messages, so that they will be sent back to the system mailbox */
466 FL
int preserve(void *v
);
468 /* Mark all given messages as unread */
469 FL
int unread(void *v
);
471 /* Mark all given messages as read */
472 FL
int seen(void *v
);
474 /* Print the size of each message */
475 FL
int messize(void *v
);
477 /* Quit quickly. If sourcing, just pop the input level by returning error */
478 FL
int rexit(void *v
);
480 /* Set or display a variable value. Syntax is similar to that of sh */
483 /* Unset a bunch of variable values */
484 FL
int unset(void *v
);
486 /* Put add users to a group */
487 FL
int group(void *v
);
489 /* Delete the passed groups */
490 FL
int ungroup(void *v
);
492 /* Change to another file. With no argument, print info about current file */
493 FL
int cfile(void *v
);
495 /* Expand file names like echo */
496 FL
int echo(void *v
);
498 /* if.else.endif conditional execution */
499 FL
int c_if(void *v
);
500 FL
int c_else(void *v
);
501 FL
int c_endif(void *v
);
503 /* Set the list of alternate names */
504 FL
int alternates(void *v
);
506 /* 'newmail'/'inc' command: Check for new mail without writing old mail back */
507 FL
int newmail(void *v
);
510 FL
int shortcut(void *v
);
511 FL
struct shortcut
*get_shortcut(char const *str
);
512 FL
int unshortcut(void *v
);
514 /* Message flag manipulation */
515 FL
int cflag(void *v
);
516 FL
int cunflag(void *v
);
517 FL
int canswered(void *v
);
518 FL
int cunanswered(void *v
);
519 FL
int cdraft(void *v
);
520 FL
int cundraft(void *v
);
523 FL
int cnoop(void *v
);
526 FL
int cremove(void *v
);
529 FL
int crename(void *v
);
535 FL
FILE * collect(struct header
*hp
, int printheaders
, struct message
*mp
,
536 char *quotefile
, int doprefix
);
538 FL
void savedeadletter(FILE *fp
, int fflush_rewind_first
);
544 FL
int fcntl_lock(int fd
, int type
);
545 FL
int dot_lock(char const *fname
, int fd
, int pollinterval
, FILE *fp
,
547 FL
void dot_unlock(char const *fname
);
553 /* Edit a message list */
554 FL
int editor(void *v
);
556 /* Invoke the visual editor on a message list */
557 FL
int visual(void *v
);
559 /* Run an editor on the file at fp of size bytes, and return a new file.
560 * Signals must be handled by the caller. viored is 'e' for ed, 'v' for vi */
561 FL
FILE * run_editor(FILE *fp
, off_t size
, int viored
, int readonly
,
562 struct header
*hp
, struct message
*mp
,
563 enum sendaction action
, sighandler_type oldint
);
570 FL
struct quoteflt
* quoteflt_dummy(void); /* TODO LEGACY */
571 FL
void quoteflt_init(struct quoteflt
*self
, char const *prefix
);
572 FL
void quoteflt_destroy(struct quoteflt
*self
);
573 FL
void quoteflt_reset(struct quoteflt
*self
, FILE *f
);
574 FL ssize_t
quoteflt_push(struct quoteflt
*self
, char const *dat
,
576 FL ssize_t
quoteflt_flush(struct quoteflt
*self
);
582 /* fgets() replacement to handle lines of arbitrary size and with embedded \0
584 * line - line buffer. *line may be NULL.
585 * linesize - allocated size of line buffer.
586 * count - maximum characters to read. May be NULL.
587 * llen - length_of_line(*line).
589 * appendnl - always terminate line with \n, append if necessary.
591 FL
char * fgetline(char **line
, size_t *linesize
, size_t *count
,
592 size_t *llen
, FILE *fp
, int appendnl SMALLOC_DEBUG_ARGS
);
594 # define fgetline(A,B,C,D,E,F) \
595 fgetline(A, B, C, D, E, F, __FILE__, __LINE__)
598 /* Read up a line from the specified input into the linebuffer.
599 * Return the number of characters read. Do not include the newline at EOL.
600 * n is the number of characters already read */
601 FL
int readline_restart(FILE *ibuf
, char **linebuf
, size_t *linesize
,
602 size_t n SMALLOC_DEBUG_ARGS
);
604 # define readline_restart(A,B,C,D) \
605 readline_restart(A, B, C, D, __FILE__, __LINE__)
608 /* Read a complete line of input, with editing if interactive and possible.
609 * If prompt is NULL we'll call getprompt() first, if necessary.
610 * nl_escape defines wether user can escape newlines via backslash (POSIX).
611 * If string is set it is used as the initial line content if in interactive
612 * mode, otherwise this argument is ignored for reproducibility.
613 * Return number of octets or a value <0 on error */
614 FL
int readline_input(char const *prompt
, bool_t nl_escape
,
615 char **linebuf
, size_t *linesize
, char const *string
618 # define readline_input(A,B,C,D,E) readline_input(A,B,C,D,E,__FILE__,__LINE__)
621 /* Read a line of input, with editing if interactive and possible, return it
622 * savestr()d or NULL in case of errors or if an empty line would be returned.
623 * This may only be called from toplevel (not during sourcing).
624 * If prompt is NULL we'll call getprompt() if necessary.
625 * If string is set it is used as the initial line content if in interactive
626 * mode, otherwise this argument is ignored for reproducibility */
627 FL
char * readstr_input(char const *prompt
, char const *string
);
629 /* Set up the input pointers while copying the mail file into /tmp */
630 FL
void setptr(FILE *ibuf
, off_t offset
);
632 /* Drop the passed line onto the passed output buffer. If a write error occurs
633 * return -1, else the count of characters written, including the newline */
634 FL
int putline(FILE *obuf
, char *linebuf
, size_t count
);
636 /* Return a file buffer all ready to read up the passed message pointer */
637 FL
FILE * setinput(struct mailbox
*mp
, struct message
*m
,
640 FL
struct message
* setdot(struct message
*mp
);
642 /* Delete a file, but only if the file is a plain file */
643 FL
int rm(char const *name
);
645 /* Determine the size of the file possessed by the passed buffer */
646 FL off_t
fsize(FILE *iob
);
648 /* Evaluate the string given as a new mailbox name. Supported meta characters:
649 * % for my system mail box
650 * %user for user's system mail box
651 * # for previous file
652 * & invoker's mbox file
653 * +file file in folder directory
654 * any shell meta character
655 * Returns the file name as an auto-reclaimed string */
656 FL
char * fexpand(char const *name
, enum fexp_mode fexpm
);
658 #define expand(N) fexpand(N, FEXP_FULL) /* XXX obsolete */
659 #define file_expand(N) fexpand(N, FEXP_LOCAL) /* XXX obsolete */
661 /* Get rid of queued mail */
662 FL
void demail(void);
664 /* acmava.c hook: *folder* variable has been updated; if folder shouldn't be
665 * replaced by something else leave store alone, otherwise smalloc() the
666 * desired value (ownership will be taken) */
667 FL bool_t
var_folder_updated(char const *folder
, char **store
);
669 /* Determine the current *folder* name, store it in *name* */
670 FL bool_t
getfold(char *name
, size_t size
);
672 /* Return the name of the dead.letter file */
673 FL
char const * getdeadletter(void);
675 FL
enum okay
get_body(struct message
*mp
);
679 FL
int sclose(struct sock
*sp
);
680 FL
enum okay
swrite(struct sock
*sp
, char const *data
);
681 FL
enum okay
swrite1(struct sock
*sp
, char const *data
, int sz
,
683 FL
enum okay
sopen(char const *xserver
, struct sock
*sp
, int use_ssl
,
684 char const *uhp
, char const *portstr
);
687 FL
int sgetline(char **line
, size_t *linesize
, size_t *linelen
,
688 struct sock
*sp SMALLOC_DEBUG_ARGS
);
690 # define sgetline(A,B,C,D) sgetline(A, B, C, D, __FILE__, __LINE__)
692 #endif /* HAVE_SOCKETS */
694 /* Deal with loading of resource files and dealing with a stack of files for
695 * the source command */
697 /* Load a file of user definitions */
698 FL
void load(char const *name
);
700 /* Pushdown current input file and switch to a new one. Set the global flag
701 * *sourcing* so that others will realize that they are no longer reading from
702 * a tty (in all probability) */
703 FL
int csource(void *v
);
705 /* Pop the current input back to the previous level. Update the *sourcing*
706 * flag as appropriate */
707 FL
int unstack(void);
713 /* Return the user's From: address(es) */
714 FL
char const * myaddrs(struct header
*hp
);
716 /* Boil the user's From: addresses down to a single one, or use *sender* */
717 FL
char const * myorigin(struct header
*hp
);
719 /* See if the passed line buffer, which may include trailing newline (sequence)
720 * is a mail From_ header line according to RFC 4155 */
721 FL
int is_head(char const *linebuf
, size_t linelen
);
723 /* Savage extract date field from From_ line. linelen is convenience as line
724 * must be terminated (but it may end in a newline [sequence]).
725 * Return wether the From_ line was parsed successfully */
726 FL
int extract_date_from_from_(char const *line
, size_t linelen
,
727 char datebuf
[FROM_DATEBUF
]);
729 /* Fill in / reedit the desired header fields */
730 FL
int grab_headers(struct header
*hp
, enum gfield gflags
,
733 FL
void extract_header(FILE *fp
, struct header
*hp
);
735 /* Return the desired header line from the passed message
736 * pointer (or NULL if the desired header field is not available).
737 * If mult is zero, return the content of the first matching header
738 * field only, the content of all matching header fields else */
739 FL
char * hfield_mult(char const *field
, struct message
*mp
, int mult
);
740 #define hfieldX(a, b) hfield_mult(a, b, 1)
741 #define hfield1(a, b) hfield_mult(a, b, 0)
743 /* Check whether the passed line is a header line of the desired breed.
744 * Return the field body, or 0 */
745 FL
char const * thisfield(char const *linebuf
, char const *field
);
747 /* Get sender's name from this message. If the message has a bunch of arpanet
748 * stuff in it, we may have to skin the name before returning it */
749 FL
char * nameof(struct message
*mp
, int reptype
);
751 /* Start of a "comment". Ignore it */
752 FL
char const * skip_comment(char const *cp
);
754 /* Return the start of a route-addr (address in angle brackets), if present */
755 FL
char const * routeaddr(char const *name
);
757 /* Check if a name's address part contains invalid characters */
758 FL
int is_addr_invalid(struct name
*np
, int putmsg
);
760 /* Does *NP* point to a file or pipe addressee? */
761 #define is_fileorpipe_addr(NP) \
762 (((NP)->n_flags & NAME_ADDRSPEC_ISFILEORPIPE) != 0)
764 /* Return skinned version of *NP*s name */
765 #define skinned_name(NP) \
766 (assert((NP)->n_flags & NAME_SKINNED), \
767 ((struct name const*)NP)->n_name)
769 /* Skin an address according to the RFC 822 interpretation of "host-phrase" */
770 FL
char * skin(char const *name
);
772 /* Skin *name* and extract the *addr-spec* according to RFC 5322.
773 * Store the result in .ag_skinned and also fill in those .ag_ fields that have
774 * actually been seen.
775 * Return 0 if something good has been parsed, 1 if fun didn't exactly know how
776 * to deal with the input, or if that was plain invalid */
777 FL
int addrspec_with_guts(int doskin
, char const *name
,
778 struct addrguts
*agp
);
780 /* Fetch the real name from an internet mail address field */
781 FL
char * realname(char const *name
);
783 /* Fetch the sender's name from the passed message. reptype can be
784 * 0 -- get sender's name for display purposes
785 * 1 -- get sender's name for reply
786 * 2 -- get sender's name for Reply */
787 FL
char * name1(struct message
*mp
, int reptype
);
789 FL
int msgidcmp(char const *s1
, char const *s2
);
791 /* See if the given header field is supposed to be ignored */
792 FL
int is_ign(char const *field
, size_t fieldlen
,
793 struct ignoretab ignore
[2]);
795 FL
int member(char const *realfield
, struct ignoretab
*table
);
797 /* Fake Sender for From_ lines if missing, e. g. with POP3 */
798 FL
char const * fakefrom(struct message
*mp
);
800 FL
char const * fakedate(time_t t
);
802 /* From username Fri Jan 2 20:13:51 2004
805 FL
time_t unixtime(char const *from
);
807 FL
time_t rfctime(char const *date
);
809 FL
time_t combinetime(int year
, int month
, int day
,
810 int hour
, int minute
, int second
);
812 FL
void substdate(struct message
*m
);
814 FL
int check_from_and_sender(struct name
*fromfield
,
815 struct name
*senderfield
);
817 FL
char * getsender(struct message
*m
);
824 FL
char const * imap_fileof(char const *xcp
);
825 FL
enum okay
imap_noop(void);
826 FL
enum okay
imap_select(struct mailbox
*mp
, off_t
*size
, int *count
,
828 FL
int imap_setfile(const char *xserver
, int nmail
, int isedit
);
829 FL
enum okay
imap_header(struct message
*m
);
830 FL
enum okay
imap_body(struct message
*m
);
831 FL
void imap_getheaders(int bot
, int top
);
832 FL
void imap_quit(void);
833 FL
enum okay
imap_undelete(struct message
*m
, int n
);
834 FL
enum okay
imap_unread(struct message
*m
, int n
);
835 FL
int imap_imap(void *vp
);
836 FL
int imap_newmail(int nmail
);
837 FL
enum okay
imap_append(const char *xserver
, FILE *fp
);
838 FL
void imap_folders(const char *name
, int strip
);
839 FL
enum okay
imap_copy(struct message
*m
, int n
, const char *name
);
840 FL
enum okay
imap_search1(const char *spec
, int f
);
841 FL
int imap_thisaccount(const char *cp
);
842 FL
enum okay
imap_remove(const char *name
);
843 FL
enum okay
imap_rename(const char *old
, const char *new);
844 FL
enum okay
imap_dequeue(struct mailbox
*mp
, FILE *fp
);
845 FL
int cconnect(void *vp
);
846 FL
int cdisconnect(void *vp
);
847 FL
int ccache(void *vp
);
848 FL
int disconnected(const char *file
);
849 FL
void transflags(struct message
*omessage
, long omsgCount
,
851 FL
time_t imap_read_date_time(const char *cp
);
852 FL
const char * imap_make_date_time(time_t t
);
854 # define imap_imap ccmdnotsupp
855 # define cconnect ccmdnotsupp
856 # define cdisconnect ccmdnotsupp
857 # define ccache ccmdnotsupp
860 FL
time_t imap_read_date(char const *cp
);
861 FL
char * imap_quotestr(char const *s
);
862 FL
char * imap_unquotestr(char const *s
);
869 FL
enum okay
getcache1(struct mailbox
*mp
, struct message
*m
,
870 enum needspec need
, int setflags
);
871 FL
enum okay
getcache(struct mailbox
*mp
, struct message
*m
,
873 FL
void putcache(struct mailbox
*mp
, struct message
*m
);
874 FL
void initcache(struct mailbox
*mp
);
875 FL
void purgecache(struct mailbox
*mp
, struct message
*m
, long mc
);
876 FL
void delcache(struct mailbox
*mp
, struct message
*m
);
877 FL
enum okay
cache_setptr(int transparent
);
878 FL
enum okay
cache_list(struct mailbox
*mp
, char const *base
, int strip
,
880 FL
enum okay
cache_remove(char const *name
);
881 FL
enum okay
cache_rename(char const *old
, char const *new);
882 FL
unsigned long cached_uidvalidity(struct mailbox
*mp
);
883 FL
FILE * cache_queue(struct mailbox
*mp
);
884 FL
enum okay
cache_dequeue(struct mailbox
*mp
);
885 #endif /* HAVE_IMAP */
891 FL
enum okay
imap_search(char const *spec
, int f
);
897 /* Set up editing on the given file name.
898 * If the first character of name is %, we are considered to be editing the
899 * file, otherwise we are reading our mail which has signficance for mbox and
900 * so forth. nmail: Check for new mail in the current folder only */
901 FL
int setfile(char const *name
, int nmail
);
903 FL
int newmailinfo(int omsgCount
);
905 /* Interpret user commands. If standard input is not a tty, print no prompt */
906 FL
void commands(void);
908 /* Evaluate a single command.
909 * .ev_add_history and .ev_new_content will be updated upon success.
910 * Command functions return 0 for success, 1 for error, and -1 for abort.
911 * 1 or -1 aborts a load or source, a -1 aborts the interactive command loop */
912 FL
int evaluate(struct eval_ctx
*evp
);
913 /* TODO drop execute() is the legacy version of evaluate().
914 * Contxt is non-zero if called while composing mail */
915 FL
int execute(char *linebuf
, int contxt
, size_t linesize
);
917 /* Set the size of the message vector used to construct argument lists to
918 * message list functions */
919 FL
void setmsize(int sz
);
921 /* The following gets called on receipt of an interrupt. This is to abort
922 * printout of a command, mainly. Dispatching here when command() is inactive
923 * crashes rcv. Close all open files except 0, 1, 2, and the temporary. Also,
924 * unstack all source files */
925 FL
void onintr(int s
);
927 /* Announce the presence of the current Mail version, give the message count,
928 * and print a header listing */
929 FL
void announce(int printheaders
);
931 /* Announce information about the file we are editing. Return a likely place
933 FL
int newfileinfo(void);
935 FL
int getmdot(int nmail
);
937 FL
void initbox(char const *name
);
939 /* Print the docstring of `comm', which may be an abbreviation.
940 * Return FAL0 if there is no such command */
941 #ifdef HAVE_DOCSTRINGS
942 FL bool_t
print_comm_docstr(char const *comm
);
949 /* Convert user string of message numbers and store the numbers into vector.
950 * Returns the count of messages picked up or -1 on error */
951 FL
int getmsglist(char *buf
, int *vector
, int flags
);
953 /* Scan out the list of string arguments, shell style for a RAWLIST */
954 FL
int getrawlist(char const *line
, size_t linesize
,
955 char **argv
, int argc
, int echolist
);
957 /* Find the first message whose flags&m==f and return its message number */
958 FL
int first(int f
, int m
);
960 /* Mark the named message by setting its mark bit */
961 FL
void mark(int mesg
, int f
);
965 FL
int zwrite(void *cookie
, const char *wbp
, int num
);
966 FL
int zfree(void *cookie
);
967 FL
int zread(void *cookie
, char *rbp
, int num
);
968 FL
void * zalloc(FILE *fp
);
969 #endif /* HAVE_IMAP */
975 FL
int maildir_setfile(char const *name
, int nmail
, int isedit
);
977 FL
void maildir_quit(void);
979 FL
enum okay
maildir_append(char const *name
, FILE *fp
);
981 FL
enum okay
maildir_remove(char const *name
);
987 /* *charset-7bit*, else CHARSET_7BIT */
988 FL
char const * charset_get_7bit(void);
990 /* *charset-8bit*, else CHARSET_8BIT */
991 FL
char const * charset_get_8bit(void);
993 /* LC_CTYPE:CODESET / *ttycharset*, else *charset-8bit*, else CHARSET_8BIT */
994 FL
char const * charset_get_lc(void);
996 /* *sendcharsets* / *charset-8bit* iterator.
997 * *a_charset_to_try_first* may be used to prepend a charset (as for
998 * *reply-in-same-charset*); works correct for !HAVE_ICONV */
999 FL
void charset_iter_reset(char const *a_charset_to_try_first
);
1000 FL
char const * charset_iter_next(void);
1001 FL
char const * charset_iter_current(void);
1002 FL
void charset_iter_recurse(char *outer_storage
[2]); /* TODO LEGACY */
1003 FL
void charset_iter_restore(char *outer_storage
[2]); /* TODO LEGACY */
1005 FL
char const * need_hdrconv(struct header
*hp
, enum gfield w
);
1007 /* Get the mime encoding from a Content-Transfer-Encoding header field */
1008 FL
enum mimeenc
mime_getenc(char *h
);
1010 /* Get a mime style parameter from a header line */
1011 FL
char * mime_getparam(char const *param
, char *h
);
1013 /* Get the boundary out of a Content-Type: multipart/xyz header field, return
1014 * salloc()ed copy of it; store strlen() in *len if set */
1015 FL
char * mime_get_boundary(char *h
, size_t *len
);
1017 /* Create a salloc()ed MIME boundary */
1018 FL
char * mime_create_boundary(void);
1020 /* Classify content of *fp* as necessary and fill in arguments; **charset* is
1021 * left alone unless it's non-NULL */
1022 FL
int mime_classify_file(FILE *fp
, char const **contenttype
,
1023 char const **charset
, int *do_iconv
);
1026 FL
enum mimecontent
mime_classify_content_of_part(struct mimepart
const *mip
);
1028 /* Return the Content-Type matching the extension of name */
1029 FL
char * mime_classify_content_type_by_fileext(char const *name
);
1031 /* "mimetypes" command */
1032 FL
int c_mimetypes(void *v
);
1034 /* Convert header fields from RFC 1522 format */
1035 FL
void mime_fromhdr(struct str
const *in
, struct str
*out
,
1036 enum tdflags flags
);
1038 /* Interpret MIME strings in parts of an address field */
1039 FL
char * mime_fromaddr(char const *name
);
1041 /* fwrite(3) performing the given MIME conversion */
1042 FL ssize_t
mime_write(char const *ptr
, size_t size
, FILE *f
,
1043 enum conversion convert
, enum tdflags dflags
,
1044 struct quoteflt
*qf
, struct str
*rest
);
1045 FL ssize_t
xmime_write(char const *ptr
, size_t size
, /* TODO LEGACY */
1046 FILE *f
, enum conversion convert
, enum tdflags dflags
,
1051 * Content-Transfer-Encodings as defined in RFC 2045:
1052 * - Quoted-Printable, section 6.7
1053 * - Base64, section 6.8
1056 /* How many characters of (the complete body) *ln* need to be quoted */
1057 FL
size_t mime_cte_mustquote(char const *ln
, size_t lnlen
, bool_t ishead
);
1059 /* How much space is necessary to encode *len* bytes in QP, worst case.
1060 * Includes room for terminator */
1061 FL
size_t qp_encode_calc_size(size_t len
);
1063 /* If *flags* includes QP_ISHEAD these assume "word" input and use special
1064 * quoting rules in addition; soft line breaks are not generated.
1065 * Otherwise complete input lines are assumed and soft line breaks are
1066 * generated as necessary */
1067 FL
struct str
* qp_encode(struct str
*out
, struct str
const *in
,
1068 enum qpflags flags
);
1070 FL
struct str
* qp_encode_cp(struct str
*out
, char const *cp
,
1071 enum qpflags flags
);
1072 FL
struct str
* qp_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
1073 enum qpflags flags
);
1076 /* If *rest* is set then decoding will assume body text input (assumes input
1077 * represents lines, only create output when input didn't end with soft line
1078 * break [except it finalizes an encoded CRLF pair]), otherwise it is assumed
1079 * to decode a header strings and (1) uses special decoding rules and (b)
1080 * directly produces output.
1081 * The buffers of *out* and possibly *rest* will be managed via srealloc().
1082 * Returns OKAY. XXX or STOP on error (in which case *out* is set to an error
1083 * XXX message); caller is responsible to free buffers */
1084 FL
int qp_decode(struct str
*out
, struct str
const *in
,
1087 /* How much space is necessary to encode *len* bytes in Base64, worst case.
1088 * Includes room for (CR/LF/CRLF and) terminator */
1089 FL
size_t b64_encode_calc_size(size_t len
);
1091 /* Note these simply convert all the input (if possible), including the
1092 * insertion of NL sequences if B64_CRLF or B64_LF is set (and multiple thereof
1093 * if B64_MULTILINE is set).
1094 * Thus, in the B64_BUF case, better call b64_encode_calc_size() first */
1095 FL
struct str
* b64_encode(struct str
*out
, struct str
const *in
,
1096 enum b64flags flags
);
1097 FL
struct str
* b64_encode_cp(struct str
*out
, char const *cp
,
1098 enum b64flags flags
);
1099 FL
struct str
* b64_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
1100 enum b64flags flags
);
1102 /* If *rest* is set then decoding will assume text input.
1103 * The buffers of *out* and possibly *rest* will be managed via srealloc().
1104 * Returns OKAY or STOP on error (in which case *out* is set to an error
1105 * message); caller is responsible to free buffers */
1106 FL
int b64_decode(struct str
*out
, struct str
const *in
,
1113 FL
struct name
* nalloc(char *str
, enum gfield ntype
);
1114 FL
struct name
* ndup(struct name
*np
, enum gfield ntype
);
1115 FL
struct name
* cat(struct name
*n1
, struct name
*n2
);
1116 FL
int count(struct name
const *np
);
1118 FL
struct name
* extract(char const *line
, enum gfield ntype
);
1119 FL
struct name
* lextract(char const *line
, enum gfield ntype
);
1120 FL
char * detract(struct name
*np
, enum gfield ntype
);
1122 /* Get a lextract() list via readstr_input(), reassigning to *np* */
1123 FL
struct name
* grab_names(const char *field
, struct name
*np
, int comma
,
1124 enum gfield gflags
);
1126 FL
struct name
* checkaddrs(struct name
*np
);
1127 FL
struct name
* usermap(struct name
*names
, bool_t force_metoo
);
1128 FL
struct name
* elide(struct name
*names
);
1129 FL
struct name
* delete_alternates(struct name
*np
);
1130 FL
int is_myname(char const *name
);
1132 /* Dispatch a message to all pipe and file addresses TODO -> sendout.c */
1133 FL
struct name
* outof(struct name
*names
, FILE *fo
, struct header
*hp
,
1136 /* Handling of alias groups */
1138 /* Locate a group name and return it */
1139 FL
struct grouphead
* findgroup(char *name
);
1141 /* Print a group out on stdout */
1142 FL
void printgroup(char *name
);
1144 FL
void remove_group(char const *name
);
1148 FL
enum okay
ssl_open(const char *server
, struct sock
*sp
, const char *uhp
);
1149 FL
void ssl_gen_err(const char *fmt
, ...);
1150 FL
int cverify(void *vp
);
1151 FL
FILE * smime_sign(FILE *ip
, struct header
*);
1152 FL
FILE * smime_encrypt(FILE *ip
, const char *certfile
, const char *to
);
1153 FL
struct message
* smime_decrypt(struct message
*m
, const char *to
,
1154 const char *cc
, int signcall
);
1155 FL
enum okay
smime_certsave(struct message
*m
, int n
, FILE *op
);
1157 # define cverify ccmdnotsupp
1162 FL
enum okay
pop3_noop(void);
1163 FL
int pop3_setfile(const char *server
, int nmail
, int isedit
);
1164 FL
enum okay
pop3_header(struct message
*m
);
1165 FL
enum okay
pop3_body(struct message
*m
);
1166 FL
void pop3_quit(void);
1171 * Subprocesses, popen, but also file handling with registering
1174 FL
FILE * safe_fopen(const char *file
, const char *mode
, int *omode
);
1175 FL
FILE * Fopen(const char *file
, const char *mode
);
1176 FL
FILE * Fdopen(int fd
, const char *mode
);
1177 FL
int Fclose(FILE *fp
);
1178 FL
FILE * Zopen(const char *file
, const char *mode
, int *compression
);
1180 /* Create a temporary file in tempdir, use prefix for its name, store the
1181 * unique name in fn, and return a stdio FILE pointer with access mode.
1182 * *bits* specifies the access mode of the newly created temporary file */
1183 FL
FILE * Ftemp(char **fn
, char const *prefix
, char const *mode
,
1184 int bits
, int register_file
);
1186 /* Free the resources associated with the given filename. To be called after
1187 * unlink(). Since this function can be called after receiving a signal, the
1188 * variable must be made NULL first and then free()d, to avoid more than one
1189 * free() call in all circumstances */
1190 FL
void Ftfree(char **fn
);
1192 /* Create a pipe and ensure CLOEXEC bit is set in both descriptors */
1193 FL bool_t
pipe_cloexec(int fd
[2]);
1195 FL
FILE * Popen(const char *cmd
, const char *mode
, const char *shell
,
1198 FL bool_t
Pclose(FILE *ptr
, bool_t dowait
);
1200 FL
void close_all_files(void);
1201 FL
int run_command(char const *cmd
, sigset_t
*mask
, int infd
,
1202 int outfd
, char const *a0
, char const *a1
, char const *a2
);
1203 FL
int start_command(const char *cmd
, sigset_t
*mask
, int infd
,
1204 int outfd
, const char *a0
, const char *a1
, const char *a2
);
1205 FL
void prepare_child(sigset_t
*nset
, int infd
, int outfd
);
1206 FL
void sigchild(int signo
);
1207 FL
void free_child(int pid
);
1209 /* Wait for pid, return wether we've had a normal EXIT_SUCCESS exit.
1210 * If wait_status is set, set it to the reported waitpid(2) wait status */
1211 FL bool_t
wait_child(int pid
, int *wait_status
);
1214 FL
int quitcmd(void *v
);
1216 FL
int holdbits(void);
1217 FL
void save_mbox_for_possible_quitstuff(void); /* TODO DROP IF U CAN */
1218 FL
enum okay
makembox(void);
1219 FL
int savequitflags(void);
1220 FL
void restorequitflags(int);
1223 FL
int sendmp(struct message
*mp
, FILE *obuf
, struct ignoretab
*doign
,
1224 char const *prefix
, enum sendaction action
, off_t
*stats
);
1227 FL
int mail(struct name
*to
, struct name
*cc
, struct name
*bcc
,
1228 char *subject
, struct attachment
*attach
,
1229 char *quotefile
, int recipient_record
);
1230 FL
int csendmail(void *v
);
1231 FL
int cSendmail(void *v
);
1232 FL
enum okay
mail1(struct header
*hp
, int printheaders
,
1233 struct message
*quote
, char *quotefile
, int recipient_record
,
1235 FL
int mkdate(FILE *fo
, const char *field
);
1236 FL
int puthead(struct header
*hp
, FILE *fo
, enum gfield w
,
1237 enum sendaction action
, enum conversion convert
,
1238 char const *contenttype
, char const *charset
);
1239 FL
enum okay
resend_msg(struct message
*mp
, struct name
*to
, int add_resent
);
1246 FL
char * smtp_auth_var(const char *type
, const char *addr
);
1247 FL
int smtp_mta(char *server
, struct name
*to
, FILE *fi
,
1248 struct header
*hp
, const char *user
, const char *password
,
1249 const char *skinned
);
1257 FL
int cspam_clear(void *v
);
1258 FL
int cspam_set(void *v
);
1259 FL
int cspam_forget(void *v
);
1260 FL
int cspam_ham(void *v
);
1261 FL
int cspam_rate(void *v
);
1262 FL
int cspam_spam(void *v
);
1264 # define cspam_clear ccmdnotsupp
1265 # define cspam_set ccmdnotsupp
1266 # define cspam_forget ccmdnotsupp
1267 # define cspam_ham ccmdnotsupp
1268 # define cspam_rate ccmdnotsupp
1269 # define cspam_spam ccmdnotsupp
1274 FL
void ssl_set_vrfy_level(const char *uhp
);
1275 FL
enum okay
ssl_vrfy_decide(void);
1276 FL
char * ssl_method_string(const char *uhp
);
1277 FL
enum okay
smime_split(FILE *ip
, FILE **hp
, FILE **bp
, long xcount
,
1279 FL
FILE * smime_sign_assemble(FILE *hp
, FILE *bp
, FILE *sp
);
1280 FL
FILE * smime_encrypt_assemble(FILE *hp
, FILE *yp
);
1281 FL
struct message
* smime_decrypt_assemble(struct message
*m
, FILE *hp
,
1283 FL
int ccertsave(void *v
);
1284 FL
enum okay
rfc2595_hostname_match(const char *host
, const char *pattern
);
1286 # define ccertsave ccmdnotsupp
1291 * This bundles several different string related support facilities:
1292 * - auto-reclaimed string storage (memory goes away on command loop ticks)
1293 * - plain char* support functions which use unspecified or smalloc() memory
1294 * - struct str related support funs
1295 * - our iconv(3) wrapper
1298 /* Auto-reclaimed string storage */
1301 # define SALLOC_DEBUG_ARGS , char const *mdbg_file, int mdbg_line
1302 # define SALLOC_DEBUG_ARGSCALL , mdbg_file, mdbg_line
1304 # define SALLOC_DEBUG_ARGS
1305 # define SALLOC_DEBUG_ARGSCALL
1308 /* Allocate size more bytes of space and return the address of the first byte
1309 * to the caller. An even number of bytes are always allocated so that the
1310 * space will always be on a word boundary */
1311 FL
void * salloc(size_t size SALLOC_DEBUG_ARGS
);
1312 FL
void * csalloc(size_t nmemb
, size_t size SALLOC_DEBUG_ARGS
);
1314 # define salloc(SZ) salloc(SZ, __FILE__, __LINE__)
1315 # define csalloc(NM,SZ) csalloc(NM, SZ, __FILE__, __LINE__)
1318 /* Auto-reclaim string storage; if only_if_relaxed is true then only perform
1319 * the reset when a srelax_hold() is currently active */
1320 FL
void sreset(bool_t only_if_relaxed
);
1322 /* The "problem" with sreset() is that it releases all string storage except
1323 * what was present once spreserve() had been called; it therefore cannot be
1324 * called from all that code which yet exists and walks about all the messages
1325 * in order, e.g. quit(), searches, etc., because, unfortunately, these code
1326 * paths are reached with new intermediate string dope already in use.
1327 * Thus such code should take a srelax_hold(), successively call srelax() after
1328 * a single message has been handled, and finally srelax_rele() (unless it is
1329 * clear that sreset() occurs anyway) */
1330 FL
void srelax_hold(void);
1331 FL
void srelax_rele(void);
1332 FL
void srelax(void);
1334 /* Make current string storage permanent: new allocs will be auto-reclaimed by
1335 * sreset(). This is called once only, from within main() */
1336 FL
void spreserve(void);
1338 /* 'sstats' command */
1340 FL
int c_sstats(void *v
);
1343 /* Return a pointer to a dynamic copy of the argument */
1344 FL
char * savestr(char const *str SALLOC_DEBUG_ARGS
);
1345 FL
char * savestrbuf(char const *sbuf
, size_t sbuf_len SALLOC_DEBUG_ARGS
);
1347 # define savestr(CP) savestr(CP, __FILE__, __LINE__)
1348 # define savestrbuf(CBP,CBL) savestrbuf(CBP, CBL, __FILE__, __LINE__)
1351 /* Make copy of argument incorporating old one, if set, separated by space */
1352 FL
char * save2str(char const *str
, char const *old SALLOC_DEBUG_ARGS
);
1354 # define save2str(S,O) save2str(S, O, __FILE__, __LINE__)
1358 FL
char * savecat(char const *s1
, char const *s2 SALLOC_DEBUG_ARGS
);
1360 # define savecat(S1,S2) savecat(S1, S2, __FILE__, __LINE__)
1363 /* Create duplicate, lowercasing all characters along the way */
1364 FL
char * i_strdup(char const *src SALLOC_DEBUG_ARGS
);
1366 # define i_strdup(CP) i_strdup(CP, __FILE__, __LINE__)
1369 /* Extract the protocol base and return a duplicate */
1370 FL
char * protbase(char const *cp SALLOC_DEBUG_ARGS
);
1372 # define protbase(CP) protbase(CP, __FILE__, __LINE__)
1375 /* URL en- and decoding (RFC 1738, but not really) */
1376 FL
char * urlxenc(char const *cp SALLOC_DEBUG_ARGS
);
1377 FL
char * urlxdec(char const *cp SALLOC_DEBUG_ARGS
);
1379 # define urlxenc(CP) urlxenc(CP, __FILE__, __LINE__)
1380 # define urlxdec(CP) urlxdec(CP, __FILE__, __LINE__)
1384 FL
struct str
* str_concat_csvl(struct str
*self
, ...);
1385 FL
struct str
* str_concat_cpa(struct str
*self
, char const * const *cpa
,
1386 char const *sep_o_null SALLOC_DEBUG_ARGS
);
1388 # define str_concat_cpa(S,A,N) str_concat_cpa(S, A, N, __FILE__, __LINE__)
1391 /* Plain char* support, not auto-reclaimed (unless noted) */
1393 /* Are any of the characters in the two strings the same? */
1394 FL
int anyof(char const *s1
, char const *s2
);
1396 /* Treat *iolist as a sep separated list of strings; find and return the
1397 * next entry, trimming surrounding whitespace, and point *iolist to the next
1398 * entry or to NULL if no more entries are contained. If ignore_empty is not
1399 * set empty entries are started over. Return NULL or an entry */
1400 FL
char * n_strsep(char **iolist
, char sep
, bool_t ignore_empty
);
1401 #define strcomma(IOL,IGN) n_strsep(IOL, ',', IGN)
1403 /* Copy a string, lowercasing it as we go; *size* is buffer size of *dest*;
1404 * *dest* will always be terminated unless *size* is 0 */
1405 FL
void i_strcpy(char *dest
, char const *src
, size_t size
);
1407 /* Is *as1* a valid prefix of *as2*? */
1408 FL
int is_prefix(char const *as1
, char const *as2
);
1410 /* Find the last AT @ before the first slash */
1411 FL
char const * last_at_before_slash(char const *sp
);
1413 /* Get (and isolate) the last, possibly quoted part of linebuf, set *needs_list
1414 * to indicate wether getmsglist() et al need to be called to collect
1415 * additional args that remain in linebuf. Return NULL on "error" */
1416 FL
char * laststring(char *linebuf
, bool_t
*needs_list
, bool_t strip
);
1418 /* Convert a string to lowercase, in-place and with multibyte-aware */
1419 FL
void makelow(char *cp
);
1421 /* Is *sub* a substring of *str*, case-insensitive and multibyte-aware? */
1422 FL
int substr(const char *str
, const char *sub
);
1424 /* Lazy vsprintf wrapper */
1425 #ifndef HAVE_SNPRINTF
1426 FL
int snprintf(char *str
, size_t size
, const char *format
, ...);
1429 FL
char * sstpcpy(char *dst
, const char *src
);
1430 FL
char * sstrdup(char const *cp SMALLOC_DEBUG_ARGS
);
1431 FL
char * sbufdup(char const *cp
, size_t len SMALLOC_DEBUG_ARGS
);
1433 # define sstrdup(CP) sstrdup(CP, __FILE__, __LINE__)
1434 # define sbufdup(CP,L) sbufdup(CP, L, __FILE__, __LINE__)
1437 FL
char * n_strlcpy(char *dst
, const char *src
, size_t len
);
1439 /* Locale-independent character class functions */
1440 FL
int asccasecmp(char const *s1
, char const *s2
);
1441 FL
int ascncasecmp(char const *s1
, char const *s2
, size_t sz
);
1442 FL
char const * asccasestr(char const *haystack
, char const *xneedle
);
1443 FL bool_t
is_asccaseprefix(char const *as1
, char const *as2
);
1445 /* struct str related support funs */
1447 /* *self->s* is srealloc()ed */
1448 FL
struct str
* n_str_dup(struct str
*self
, struct str
const *t
1449 SMALLOC_DEBUG_ARGS
);
1451 /* *self->s* is srealloc()ed, *self->l* incremented */
1452 FL
struct str
* n_str_add_buf(struct str
*self
, char const *buf
, size_t buflen
1453 SMALLOC_DEBUG_ARGS
);
1454 #define n_str_add(S, T) n_str_add_buf(S, (T)->s, (T)->l)
1455 #define n_str_add_cp(S, CP) n_str_add_buf(S, CP, (CP) ? strlen(CP) : 0)
1458 # define n_str_dup(S,T) n_str_dup(S, T, __FILE__, __LINE__)
1459 # define n_str_add_buf(S,B,BL) n_str_add_buf(S, B, BL, __FILE__, __LINE__)
1462 /* Our iconv(3) wrappers */
1465 FL iconv_t
n_iconv_open(char const *tocode
, char const *fromcode
);
1466 /* If *cd* == *iconvd*, assigns -1 to the latter */
1467 FL
void n_iconv_close(iconv_t cd
);
1469 /* Reset encoding state */
1471 FL
void n_iconv_reset(iconv_t cd
);
1474 /* iconv(3), but return *errno* or 0; *skipilseq* forces step over illegal byte
1475 * sequences; likewise iconv_str(), but which auto-grows on E2BIG errors; *in*
1476 * and *in_rest_or_null* may be the same object.
1477 * Note: EINVAL (incomplete sequence at end of input) is NOT handled, so the
1478 * replacement character must be added manually if that happens at EOF! */
1479 FL
int n_iconv_buf(iconv_t cd
, char const **inb
, size_t *inbleft
,
1480 char **outb
, size_t *outbleft
, bool_t skipilseq
);
1481 FL
int n_iconv_str(iconv_t icp
, struct str
*out
, struct str
const *in
,
1482 struct str
*in_rest_or_null
, bool_t skipilseq
);
1486 FL
int thread(void *vp
);
1487 FL
int unthread(void *vp
);
1488 FL
struct message
* next_in_thread(struct message
*mp
);
1489 FL
struct message
* prev_in_thread(struct message
*mp
);
1490 FL
struct message
* this_in_thread(struct message
*mp
, long n
);
1491 FL
int sort(void *vp
);
1492 FL
int ccollapse(void *v
);
1493 FL
int cuncollapse(void *v
);
1494 FL
void uncollapse1(struct message
*m
, int always
);
1500 /* Return wether user says yes. If prompt is NULL, "Continue (y/n)? " is used
1501 * instead. If interactive, asks on STDIN, anything but [0]==[yY] is false.
1502 * If noninteractive, returns noninteract_default */
1503 FL bool_t
getapproval(char const *prompt
, bool_t noninteract_default
);
1505 /* [Yy]es or [Nn]o. Always `yes' if not interactive, always `no' on error */
1506 FL bool_t
yorn(char const *msg
);
1508 /* Get a password the expected way, return termios_state.ts_linebuf on
1509 * success or NULL on error */
1510 FL
char * getuser(char const *query
);
1512 /* Get a password the expected way, return termios_state.ts_linebuf on
1513 * success or NULL on error.
1514 * termios_state_reset() (def.h) must be called anyway */
1515 FL
char * getpassword(char const *query
);
1517 /* Get both, user and password in the expected way; simply reuses a value that
1518 * is set, otherwise calls one of the above.
1519 * Returns true only if we have a user and a password.
1520 * *user* will be savestr()ed if neither it nor *pass* have a default value
1521 * (so that termios_state.ts_linebuf carries only one) */
1522 FL bool_t
getcredentials(char **user
, char **pass
);
1524 /* Overall interactive terminal life cycle for command line editor library */
1525 #if defined HAVE_EDITLINE || defined HAVE_READLINE
1526 # define TTY_WANTS_SIGWINCH
1528 FL
void tty_init(void);
1529 FL
void tty_destroy(void);
1531 /* Rather for main.c / SIGWINCH interaction only */
1532 FL
void tty_signal(int sig
);
1534 /* Read a line after printing prompt (if set and non-empty).
1535 * If n>0 assumes that *linebuf has n bytes of default content */
1536 FL
int tty_readline(char const *prompt
, char **linebuf
,
1537 size_t *linesize
, size_t n SMALLOC_DEBUG_ARGS
);
1539 # define tty_readline(A,B,C,D) tty_readline(A, B, C, D, __FILE__, __LINE__)
1542 /* Add a line (most likely as returned by tty_readline()) to the history
1543 * (only added for real if non-empty and doesn't begin with U+0020) */
1544 FL
void tty_addhist(char const *s
);
1546 #if defined HAVE_HISTORY &&\
1547 (defined HAVE_READLINE || defined HAVE_EDITLINE || defined HAVE_NCL)
1548 FL
int c_history(void *v
);
1551 #ifndef HAVE_AMALGAMATION
1556 /* vim:set fenc=utf-8:s-it-mode */