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 - 2015 Steffen (Daode) Nurpmeso <sdaoden@users.sf.net>.
8 * Copyright (c) 1980, 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. Neither the name of the University nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 * TODO Convert optional utility+ functions to n_*(); ditto
38 * TODO else use generic module-specific prefixes: str_(), am[em]_, sm[em]_, ..
40 /* TODO s-it-mode: not really (docu, funnames, funargs, etc) */
43 #ifndef HAVE_AMALGAMATION
50 * Macro-based generics
53 /* Kludges to handle the change from setexit / reset to setjmp / longjmp */
54 #define setexit() (void)sigsetjmp(srbuf, 1)
55 #define reset(x) siglongjmp(srbuf, x)
57 /* ASCII char classification */
58 #define __ischarof(C, FLAGS) \
59 (asciichar(C) && (class_char[(uc_i)(C)] & (FLAGS)) != 0)
61 #define asciichar(c) ((uc_i)(c) <= 0177)
62 #define alnumchar(c) __ischarof(c, C_DIGIT | C_OCTAL | C_UPPER | C_LOWER)
63 #define alphachar(c) __ischarof(c, C_UPPER | C_LOWER)
64 #define blankchar(c) __ischarof(c, C_BLANK)
65 #define blankspacechar(c) __ischarof(c, C_BLANK | C_SPACE)
66 #define cntrlchar(c) (asciichar(c) && class_char[(ui8_t)(c)] == C_CNTRL)
67 #define digitchar(c) __ischarof(c, C_DIGIT | C_OCTAL)
68 #define lowerchar(c) __ischarof(c, C_LOWER)
69 #define punctchar(c) __ischarof(c, C_PUNCT)
70 #define spacechar(c) __ischarof(c, C_BLANK | C_SPACE | C_WHITE)
71 #define upperchar(c) __ischarof(c, C_UPPER)
72 #define whitechar(c) __ischarof(c, C_BLANK | C_WHITE)
73 #define octalchar(c) __ischarof(c, C_OCTAL)
75 #define upperconv(c) (lowerchar(c) ? (char)((uc_i)(c) - 'a' + 'A') : (c))
76 #define lowerconv(c) (upperchar(c) ? (char)((uc_i)(c) - 'A' + 'a') : (c))
78 #define fieldnamechar(c) \
79 (asciichar(c) && (c) > 040 && (c) != 0177 && (c) != ':')
81 /* Could the string contain a regular expression? */
83 # define is_maybe_regex(S) anyof("^.[]*+?()|$", S)
85 # define is_maybe_regex(S) anyof("^[]*+?|$", S)
88 /* Try to use alloca() for some function-local buffers and data, fall back to
89 * smalloc()/free() if not available */
91 # define ac_alloc(n) HAVE_ALLOCA(n)
92 # define ac_free(n) do {UNUSED(n);} while (0)
94 # define ac_alloc(n) smalloc(n)
95 # define ac_free(n) free(n)
98 /* Single-threaded, use unlocked I/O */
99 #ifdef HAVE_PUTC_UNLOCKED
101 # define getc(c) getc_unlocked(c)
103 # define putc(c, f) putc_unlocked(c, f)
105 # define putchar(c) putc_unlocked((c), stdout)
108 /* Truncate a file to the last character written. This is useful just before
109 * closing an old file that was opened for read/write */
110 #define ftrunc(stream) \
114 off = ftell(stream);\
116 ftruncate(fileno(stream), off);\
119 /* fflush() and rewind() */
120 #define fflush_rewind(stream) \
126 /* There are problems with dup()ing of file-descriptors for child processes.
127 * As long as those are not fixed in equal spirit to (outof(): FIX and
128 * recode.., 2012-10-04), and to avoid reviving of bugs like (If *record* is
129 * set, avoid writing dead content twice.., 2012-09-14), we have to somehow
130 * accomplish that the FILE* fp makes itself comfortable with the *real* offset
131 * of the underlaying file descriptor. Unfortunately Standard I/O and POSIX
132 * don't describe a way for that -- fflush();rewind(); won't do it. This
133 * fseek(END),rewind() pair works around the problem on *BSD and Linux.
134 * Update as of 2014-03-03: with Issue 7 POSIX has overloaded fflush(3): if
135 * used on a readable stream, then
137 * if the file is not already at EOF, and the file is one capable of
138 * seeking, the file offset of the underlying open file description shall
139 * be set to the file position of the stream.
141 * We need our own, simplified and reliable I/O */
142 #if defined _POSIX_VERSION && _POSIX_VERSION + 0 >= 200809L
143 # define really_rewind(stream) \
149 # define really_rewind(stream) \
153 lseek(fileno(stream), 0, SEEK_SET);\
161 /* Don't use _var_* unless you *really* have to! */
163 /* Constant option key look/(un)set/clear */
164 FL
char * _var_oklook(enum okeys okey
);
165 #define ok_blook(C) (_var_oklook(CONCAT(ok_b_, C)) != NULL)
166 #define ok_vlook(C) _var_oklook(CONCAT(ok_v_, C))
168 FL bool_t
_var_okset(enum okeys okey
, uintptr_t val
);
169 #define ok_bset(C,B) _var_okset(CONCAT(ok_b_, C), (uintptr_t)(B))
170 #define ok_vset(C,V) _var_okset(CONCAT(ok_v_, C), (uintptr_t)(V))
172 FL bool_t
_var_okclear(enum okeys okey
);
173 #define ok_bclear(C) _var_okclear(CONCAT(ok_b_, C))
174 #define ok_vclear(C) _var_okclear(CONCAT(ok_v_, C))
176 /* Variable option key look/(un)set/clear */
177 FL
char * _var_voklook(char const *vokey
);
178 #define vok_blook(S) (_var_voklook(S) != NULL)
179 #define vok_vlook(S) _var_voklook(S)
181 FL bool_t
_var_vokset(char const *vokey
, uintptr_t val
);
182 #define vok_bset(S,B) _var_vokset(S, (uintptr_t)(B))
183 #define vok_vset(S,V) _var_vokset(S, (uintptr_t)(V))
185 FL bool_t
_var_vokclear(char const *vokey
);
186 #define vok_bclear(S) _var_vokclear(S)
187 #define vok_vclear(S) _var_vokclear(S)
189 /* Environment lookup, if envonly is TRU1 then variable must come from the
190 * process environment (and if via `setenv') */
191 FL
char * _env_look(char const *envkey
, bool_t envonly
);
192 #define env_blook(S,EXCL) (_env_look(S, EXCL) != NULL)
193 #define env_vlook(S,EXCL) _env_look(S, EXCL)
195 /* Special case to handle the typical [xy-USER@HOST,] xy-HOST and plain xy
196 * variable chains; oxm is a bitmix which tells which combinations to test */
198 FL
char * _var_xoklook(enum okeys okey
, struct url
const *urlp
,
199 enum okey_xlook_mode oxm
);
200 # define xok_BLOOK(C,URL,M) (_var_xoklook(C, URL, M) != NULL)
201 # define xok_VLOOK(C,URL,M) _var_xoklook(C, URL, M)
202 # define xok_blook(C,URL,M) xok_BLOOK(CONCAT(ok_b_, C), URL, M)
203 # define xok_vlook(C,URL,M) xok_VLOOK(CONCAT(ok_v_, C), URL, M)
207 FL
int c_varshow(void *v
);
209 /* User variable access: `set', `setenv', `unset' and `unsetenv' */
210 FL
int c_set(void *v
);
211 FL
int c_setenv(void *v
);
212 FL
int c_unset(void *v
);
213 FL
int c_unsetenv(void *v
);
215 /* Ditto: `varedit' */
216 FL
int c_varedit(void *v
);
218 /* Macros: `define', `undefine', `call' / `~' */
219 FL
int c_define(void *v
);
220 FL
int c_undefine(void *v
);
221 FL
int c_call(void *v
);
223 /* Check wether a *folder-hook* exists for the currently active mailbox */
224 FL bool_t
check_folder_hook(bool_t nmail
);
226 /* Accounts: `account', `unaccount' */
227 FL
int c_account(void *v
);
228 FL
int c_unaccount(void *v
);
231 FL
int c_localopts(void *v
);
233 FL
void temporary_localopts_free(void); /* XXX intermediate hack */
234 FL
void temporary_localopts_folder_hook_unroll(void); /* XXX im. hack */
240 /* Try to add an attachment for file, file_expand()ed.
241 * Return the new head of list aphead, or NULL.
242 * The newly created attachment will be stored in *newap, if given */
243 FL
struct attachment
* add_attachment(struct attachment
*aphead
, char *file
,
244 struct attachment
**newap
);
246 /* Append comma-separated list of file names to the end of attachment list */
247 FL
void append_attachments(struct attachment
**aphead
, char *names
);
249 /* Interactively edit the attachment list */
250 FL
void edit_attachments(struct attachment
**aphead
);
256 FL
void n_raise(int signo
);
258 /* Provide BSD-like signal() on all (POSIX) systems */
259 FL sighandler_type
safe_signal(int signum
, sighandler_type handler
);
261 /* Hold *all* signals but SIGCHLD, and release that total block again */
262 FL
void hold_all_sigs(void);
263 FL
void rele_all_sigs(void);
265 /* Hold HUP/QUIT/INT */
266 FL
void hold_sigs(void);
267 FL
void rele_sigs(void);
269 /* Not-Yet-Dead debug information (handler installation in main.c) */
270 #if defined HAVE_DEBUG || defined HAVE_DEVEL
271 FL
void _nyd_chirp(ui8_t act
, char const *file
, ui32_t line
,
273 FL
void _nyd_oncrash(int signo
);
276 # define NYD_ENTER _nyd_chirp(1, __FILE__, __LINE__, __FUN__)
277 # define NYD_LEAVE _nyd_chirp(2, __FILE__, __LINE__, __FUN__)
278 # define NYD _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
279 # define NYD_X _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
281 # define NYD2_ENTER _nyd_chirp(1, __FILE__, __LINE__, __FUN__)
282 # define NYD2_LEAVE _nyd_chirp(2, __FILE__, __LINE__, __FUN__)
283 # define NYD2 _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
289 # define NYD_ENTER do {} while (0)
290 # define NYD_LEAVE do {} while (0)
291 # define NYD do {} while (0)
292 # define NYD_X do {} while (0) /* XXX LEGACY */
295 # define NYD2_ENTER do {} while (0)
296 # define NYD2_LEAVE do {} while (0)
297 # define NYD2 do {} while (0)
300 /* Touch the named message by setting its MTOUCH flag. Touched messages have
301 * the effect of not being sent back to the system mailbox on exit */
302 FL
void touch(struct message
*mp
);
304 /* Test to see if the passed file name is a directory, return true if it is */
305 FL bool_t
is_dir(char const *name
);
307 /* Count the number of arguments in the given string raw list */
308 FL
int argcount(char **argv
);
310 /* Compute screen size */
311 FL
int screensize(void);
313 /* Get our $PAGER; if env_addon is not NULL it is checked wether we know about
314 * some environment variable that supports colour+ and set *env_addon to that,
315 * e.g., "LESS=FRSXi" */
316 FL
char const *get_pager(char const **env_addon
);
318 /* Use a pager or STDOUT to print *fp*; if *lines* is 0, they'll be counted */
319 FL
void page_or_print(FILE *fp
, size_t lines
);
321 /* Parse name and guess at the required protocol */
322 FL
enum protocol
which_protocol(char const *name
);
324 /* Hash the passed string -- uses Chris Torek's hash algorithm */
325 FL ui32_t
torek_hash(char const *name
);
326 #define hash(S) (torek_hash(S) % HSHSIZE) /* xxx COMPAT (?) */
329 FL ui32_t
pjw(char const *cp
); /* TODO obsolete -> torek_hash() */
331 /* Find a prime greater than n */
332 FL ui32_t
nextprime(ui32_t n
);
334 /* (Try to) Expand ^~/? and ^~USER/? constructs.
335 * Returns the completely resolved (maybe empty or identical to input)
336 * salloc()ed string */
337 FL
char * n_shell_expand_tilde(char const *s
, bool_t
*err_or_null
);
339 /* (Try to) Expand any shell variable in s, allowing backslash escaping
340 * (of any following character) with bsescape.
341 * Returns the completely resolved (maybe empty) salloc()ed string.
343 FL
char * n_shell_expand_var(char const *s
, bool_t bsescape
,
344 bool_t
*err_or_null
);
346 /* Check wether *s is an escape sequence, expand it as necessary.
347 * Returns the expanded sequence or 0 if **s is NUL or PROMPT_STOP if it is \c.
348 * *s is advanced to after the expanded sequence (as possible).
349 * If use_prompt_extensions is set, an enum prompt_exp may be returned */
350 FL
int n_shell_expand_escape(char const **s
,
351 bool_t use_prompt_extensions
);
353 /* Get *prompt*, or '& ' if *bsdcompat*, of '? ' otherwise */
354 FL
char * getprompt(void);
356 /* Detect and query the hostname to use */
357 FL
char * nodename(int mayoverride
);
359 /* Get a (pseudo) random string of *length* bytes; returns salloc()ed buffer */
360 FL
char * getrandstring(size_t length
);
362 FL
enum okay
makedir(char const *name
);
364 /* A get-wd..restore-wd approach */
365 FL
enum okay
cwget(struct cw
*cw
);
366 FL
enum okay
cwret(struct cw
*cw
);
367 FL
void cwrelse(struct cw
*cw
);
369 /* Check (multibyte-safe) how many bytes of buf (which is blen byts) can be
370 * safely placed in a buffer (field width) of maxlen bytes */
371 FL
size_t field_detect_clip(size_t maxlen
, char const *buf
, size_t blen
);
373 /* Put maximally maxlen bytes of buf, a buffer of blen bytes, into store,
374 * taking into account multibyte code point boundaries and possibly
375 * encapsulating in bidi_info toggles as necessary */
376 FL
size_t field_put_bidi_clip(char *store
, size_t maxlen
, char const *buf
,
379 /* Place cp in a salloc()ed buffer, column-aligned; for header display only */
380 FL
char * colalign(char const *cp
, int col
, int fill
,
381 int *cols_decr_used_or_null
);
383 /* Convert a string to a displayable one;
384 * prstr() returns the result savestr()d, prout() writes it */
385 FL
void makeprint(struct str
const *in
, struct str
*out
);
386 FL
size_t delctrl(char *cp
, size_t len
);
387 FL
char * prstr(char const *s
);
388 FL
int prout(char const *s
, size_t sz
, FILE *fp
);
390 /* Print out a Unicode character or a substitute for it, return 0 on error or
391 * wcwidth() (or 1) on success */
392 FL
size_t putuc(int u
, int c
, FILE *fp
);
394 /* Check wether bidirectional info maybe needed for blen bytes of bdat */
395 FL bool_t
bidi_info_needed(char const *bdat
, size_t blen
);
397 /* Create bidirectional text encapsulation information; without HAVE_NATCH_CHAR
398 * the strings are always empty */
399 FL
void bidi_info_create(struct bidi_info
*bip
);
401 /* Check wether the argument string is a true (1) or false (0) boolean, or an
402 * invalid string, in which case -1 is returned; if emptyrv is not -1 then it,
403 * treated as a boolean, is used as the return value shall inbuf be empty.
404 * inlen may be UIZ_MAX to force strlen() detection */
405 FL si8_t
boolify(char const *inbuf
, uiz_t inlen
, si8_t emptyrv
);
407 /* Dig a "quadoption" in inbuf (possibly going through getapproval() in
408 * interactive mode). Returns a boolean or -1 if inbuf content is invalid;
409 * if emptyrv is not -1 then it, treated as a boolean, is used as the return
410 * value shall inbuf be empty. If prompt is set it is printed first if intera.
411 * inlen may be UIZ_MAX to force strlen() detection */
412 FL si8_t
quadify(char const *inbuf
, uiz_t inlen
, char const *prompt
,
415 /* Get seconds since epoch */
416 FL
time_t n_time_epoch(void);
418 /* Update *tc* to now; only .tc_time updated unless *full_update* is true */
419 FL
void time_current_update(struct time_current
*tc
,
422 /* Returns 0 if fully slept, number of millis left if ignint is true and we
423 * were interrupted. Actual resolution may be second or less.
424 * Note in case of HAVE_SLEEP this may be SIGALARM based. */
425 FL uiz_t
n_msleep(uiz_t millis
, bool_t ignint
);
427 /* Our error print series.. Note: these reverse scan format in order to know
428 * wether a newline was included or not -- this affects the output! */
429 FL
void n_err(char const *format
, ...);
430 FL
void n_verr(char const *format
, va_list ap
);
432 /* ..(for use in a signal handler; to be obsoleted..).. */
433 FL
void n_err_sighdl(char const *format
, ...);
435 /* Our perror(3); if errval is 0 errno(3) is used; newline appended */
436 FL
void n_perr(char const *msg
, int errval
);
438 /* Announce a fatal error (and die); newline appended */
439 FL
void n_alert(char const *format
, ...);
440 FL
void n_panic(char const *format
, ...);
444 FL
int c_errors(void *vp
);
446 # define c_errors c_cmdnotsupp
449 /* Memory allocation routines */
451 # define SMALLOC_DEBUG_ARGS , char const *mdbg_file, int mdbg_line
452 # define SMALLOC_DEBUG_ARGSCALL , mdbg_file, mdbg_line
454 # define SMALLOC_DEBUG_ARGS
455 # define SMALLOC_DEBUG_ARGSCALL
458 FL
void * smalloc(size_t s SMALLOC_DEBUG_ARGS
);
459 FL
void * srealloc(void *v
, size_t s SMALLOC_DEBUG_ARGS
);
460 FL
void * scalloc(size_t nmemb
, size_t size SMALLOC_DEBUG_ARGS
);
463 FL
void sfree(void *v SMALLOC_DEBUG_ARGS
);
464 /* Called by sreset(), then */
465 FL
void smemreset(void);
467 FL
int c_smemtrace(void *v
);
468 /* For immediate debugging purposes, it is possible to check on request */
469 FL bool_t
_smemcheck(char const *file
, int line
);
471 # define smalloc(SZ) smalloc(SZ, __FILE__, __LINE__)
472 # define srealloc(P,SZ) srealloc(P, SZ, __FILE__, __LINE__)
473 # define scalloc(N,SZ) scalloc(N, SZ, __FILE__, __LINE__)
474 # define free(P) sfree(P, __FILE__, __LINE__)
475 # define smemcheck() _smemcheck(__FILE__, __LINE__)
482 FL
int c_cmdnotsupp(void *v
);
484 /* `headers' (show header group, possibly after setting dot) */
485 FL
int c_headers(void *v
);
487 /* Like c_headers(), but pre-prepared message vector */
488 FL
int print_header_group(int *vector
);
490 /* Scroll to the next/previous screen */
491 FL
int c_scroll(void *v
);
492 FL
int c_Scroll(void *v
);
494 /* Print out the headlines for each message in the passed message list */
495 FL
int c_from(void *v
);
497 /* Print all message in between and including bottom and topx if they are
498 * visible and either only_marked is false or they are MMARKed */
499 FL
void print_headers(size_t bottom
, size_t topx
, bool_t only_marked
);
501 /* Print out the value of dot */
502 FL
int c_pdot(void *v
);
504 /* Paginate messages, honor/don't honour ignored fields, respectively */
505 FL
int c_more(void *v
);
506 FL
int c_More(void *v
);
508 /* Type out messages, honor/don't honour ignored fields, respectively */
509 FL
int c_type(void *v
);
510 FL
int c_Type(void *v
);
512 /* Show MIME-encoded message text, including all fields */
513 FL
int c_show(void *v
);
515 /* Pipe messages, honor/don't honour ignored fields, respectively */
516 FL
int c_pipe(void *v
);
517 FL
int c_Pipe(void *v
);
519 /* Print the top so many lines of each desired message.
520 * The number of lines is taken from *toplines* and defaults to 5 */
521 FL
int c_top(void *v
);
523 /* Touch all the given messages so that they will get mboxed */
524 FL
int c_stouch(void *v
);
526 /* Make sure all passed messages get mboxed */
527 FL
int c_mboxit(void *v
);
529 /* List the folders the user currently has */
530 FL
int c_folders(void *v
);
536 /* If any arguments were given, go to the next applicable argument following
537 * dot, otherwise, go to the next applicable message. If given as first
538 * command with no arguments, print first message */
539 FL
int c_next(void *v
);
541 /* Move the dot up or down by one message */
542 FL
int c_dotmove(void *v
);
544 /* Save a message in a file. Mark the message as saved so we can discard when
546 FL
int c_save(void *v
);
547 FL
int c_Save(void *v
);
549 /* Copy a message to a file without affected its saved-ness */
550 FL
int c_copy(void *v
);
551 FL
int c_Copy(void *v
);
553 /* Move a message to a file */
554 FL
int c_move(void *v
);
555 FL
int c_Move(void *v
);
557 /* Decrypt and copy a message to a file */
558 FL
int c_decrypt(void *v
);
559 FL
int c_Decrypt(void *v
);
561 /* Write the indicated messages at the end of the passed file name, minus
562 * header and trailing blank line. This is the MIME save function */
563 FL
int c_write(void *v
);
565 /* Delete messages */
566 FL
int c_delete(void *v
);
568 /* Delete messages, then type the new dot */
569 FL
int c_deltype(void *v
);
571 /* Undelete the indicated messages */
572 FL
int c_undelete(void *v
);
574 /* Add the given header fields to the retained list. If no arguments, print
575 * the current list of retained fields */
576 FL
int c_retfield(void *v
);
578 /* Add the given header fields to the ignored list. If no arguments, print the
579 * current list of ignored fields */
580 FL
int c_igfield(void *v
);
582 FL
int c_saveretfield(void *v
);
583 FL
int c_saveigfield(void *v
);
584 FL
int c_fwdretfield(void *v
);
585 FL
int c_fwdigfield(void *v
);
586 FL
int c_unignore(void *v
);
587 FL
int c_unretain(void *v
);
588 FL
int c_unsaveignore(void *v
);
589 FL
int c_unsaveretain(void *v
);
590 FL
int c_unfwdignore(void *v
);
591 FL
int c_unfwdretain(void *v
);
597 /* Process a shell escape by saving signals, ignoring signals and a sh -c */
598 FL
int c_shell(void *v
);
600 /* Fork an interactive shell */
601 FL
int c_dosh(void *v
);
603 /* Show the help screen */
604 FL
int c_help(void *v
);
606 /* Print user's working directory */
607 FL
int c_cwd(void *v
);
609 /* Change user's working directory */
610 FL
int c_chdir(void *v
);
612 /* All thinkable sorts of `reply' / `respond' and `followup'.. */
613 FL
int c_reply(void *v
);
614 FL
int c_replyall(void *v
);
615 FL
int c_replysender(void *v
);
616 FL
int c_Reply(void *v
);
617 FL
int c_followup(void *v
);
618 FL
int c_followupall(void *v
);
619 FL
int c_followupsender(void *v
);
620 FL
int c_Followup(void *v
);
622 /* ..and a mailing-list reply */
623 FL
int c_Lreply(void *v
);
625 /* The 'forward' command */
626 FL
int c_forward(void *v
);
628 /* Similar to forward, saving the message in a file named after the first
630 FL
int c_Forward(void *v
);
632 /* Resend a message list to a third person */
633 FL
int c_resend(void *v
);
635 /* Resend a message list to a third person without adding headers */
636 FL
int c_Resend(void *v
);
638 /* Preserve messages, so that they will be sent back to the system mailbox */
639 FL
int c_preserve(void *v
);
641 /* Mark all given messages as unread */
642 FL
int c_unread(void *v
);
644 /* Mark all given messages as read */
645 FL
int c_seen(void *v
);
647 /* Print the size of each message */
648 FL
int c_messize(void *v
);
650 /* `file' (`folder') and `File' (`Folder') */
651 FL
int c_file(void *v
);
652 FL
int c_File(void *v
);
654 /* Expand file names like echo */
655 FL
int c_echo(void *v
);
657 /* 'newmail' command: Check for new mail without writing old mail back */
658 FL
int c_newmail(void *v
);
660 /* Message flag manipulation */
661 FL
int c_flag(void *v
);
662 FL
int c_unflag(void *v
);
663 FL
int c_answered(void *v
);
664 FL
int c_unanswered(void *v
);
665 FL
int c_draft(void *v
);
666 FL
int c_undraft(void *v
);
669 FL
int c_noop(void *v
);
672 FL
int c_remove(void *v
);
675 FL
int c_rename(void *v
);
677 /* `urlencode' and `urldecode' */
678 FL
int c_urlencode(void *v
);
679 FL
int c_urldecode(void *v
);
685 /* if.elif.else.endif conditional execution.
686 * condstack_isskip() returns wether the current condition state doesn't allow
687 * execution of commands.
688 * condstack_release() and condstack_take() are used when PS_SOURCING files, they
689 * rotate the current condition stack; condstack_take() returns a false boolean
690 * if the current condition stack has unclosed conditionals */
691 FL
int c_if(void *v
);
692 FL
int c_elif(void *v
);
693 FL
int c_else(void *v
);
694 FL
int c_endif(void *v
);
695 FL bool_t
condstack_isskip(void);
696 FL
void * condstack_release(void);
697 FL bool_t
condstack_take(void *self
);
704 * If quotefile is (char*)-1, stdin will be used, caller has to verify that
705 * we're not running in interactive mode */
706 FL
FILE * collect(struct header
*hp
, int printheaders
, struct message
*mp
,
707 char *quotefile
, int doprefix
, si8_t
*checkaddr_err
);
709 FL
void savedeadletter(FILE *fp
, int fflush_rewind_first
);
715 /* Edit a message list */
716 FL
int c_editor(void *v
);
718 /* Invoke the visual editor on a message list */
719 FL
int c_visual(void *v
);
721 /* Run an editor on either size bytes of the file fp (or until EOF if size is
722 * negative) or on the message mp, and return a new file or NULL on error of if
723 * the user didn't perform any edits.
724 * For now we assert that mp==NULL if hp!=NULL, treating this as a special call
725 * from within compose mode, and giving TRUM1 to puthead().
726 * Signals must be handled by the caller. viored is 'e' for ed, 'v' for vi */
727 FL
FILE * run_editor(FILE *fp
, off_t size
, int viored
, int readonly
,
728 struct header
*hp
, struct message
*mp
,
729 enum sendaction action
, sighandler_type oldint
);
737 FL
int c_colour(void *v
);
738 FL
int c_uncolour(void *v
);
740 /* We want coloured output (in this salloc() cycle). pager_used is used to
741 * test wether *colour-pager* is to be inspected.
742 * The push/pop functions deal with recursive execute()ions, for now. TODO
743 * env_gut() will reset() as necessary */
744 FL
void n_colour_env_create(enum n_colour_group cgrp
, bool_t pager_used
);
745 FL
void n_colour_env_push(void);
746 FL
void n_colour_env_pop(bool_t any_env_till_root
);
747 FL
void n_colour_env_gut(FILE *fp
);
749 /* Putting anything (for pens: including NULL) resets current state first */
750 FL
void n_colour_put(FILE *fp
, enum n_colour_id cid
, char const *ctag
);
751 FL
void n_colour_reset(FILE *fp
);
753 /* Of course temporary only and may return NULL. Doesn't affect state! */
754 FL
struct str
const *n_colour_reset_to_str(void);
756 /* A pen is bound to its environment and automatically reclaimed; it may be
757 * NULL but that can be used anyway for simplicity.
758 * This includes pen_to_str() -- which doesn't affect state! */
759 FL
struct n_colour_pen
*n_colour_pen_create(enum n_colour_id cid
,
761 FL
void n_colour_pen_put(struct n_colour_pen
*self
, FILE *fp
);
763 FL
struct str
const *n_colour_pen_to_str(struct n_colour_pen
*self
);
765 #else /* HAVE_COLOUR */
766 # define c_colour c_cmdnotsupp
767 # define c_uncolour c_cmdnotsupp
768 # define c_mono c_cmdnotsupp
769 # define c_unmono c_cmdnotsupp
777 FL
struct quoteflt
* quoteflt_dummy(void); /* TODO LEGACY */
778 FL
void quoteflt_init(struct quoteflt
*self
, char const *prefix
);
779 FL
void quoteflt_destroy(struct quoteflt
*self
);
780 FL
void quoteflt_reset(struct quoteflt
*self
, FILE *f
);
781 FL ssize_t
quoteflt_push(struct quoteflt
*self
, char const *dat
,
783 FL ssize_t
quoteflt_flush(struct quoteflt
*self
);
785 /* (Primitive) HTML tagsoup filter */
786 #ifdef HAVE_FILTER_HTML_TAGSOUP
787 /* TODO Because we don't support filter chains yet this filter will be run
788 * TODO in a dedicated subprocess, driven via a special Popen() mode */
789 FL
int htmlflt_process_main(void);
791 FL
void htmlflt_init(struct htmlflt
*self
);
792 FL
void htmlflt_destroy(struct htmlflt
*self
);
793 FL
void htmlflt_reset(struct htmlflt
*self
, FILE *f
);
794 FL ssize_t
htmlflt_push(struct htmlflt
*self
, char const *dat
, size_t len
);
795 FL ssize_t
htmlflt_flush(struct htmlflt
*self
);
802 /* fgets() replacement to handle lines of arbitrary size and with embedded \0
804 * line - line buffer. *line may be NULL.
805 * linesize - allocated size of line buffer.
806 * count - maximum characters to read. May be NULL.
807 * llen - length_of_line(*line).
809 * appendnl - always terminate line with \n, append if necessary.
811 FL
char * fgetline(char **line
, size_t *linesize
, size_t *count
,
812 size_t *llen
, FILE *fp
, int appendnl SMALLOC_DEBUG_ARGS
);
814 # define fgetline(A,B,C,D,E,F) \
815 fgetline(A, B, C, D, E, F, __FILE__, __LINE__)
818 /* Read up a line from the specified input into the linebuffer.
819 * Return the number of characters read. Do not include the newline at EOL.
820 * n is the number of characters already read */
821 FL
int readline_restart(FILE *ibuf
, char **linebuf
, size_t *linesize
,
822 size_t n SMALLOC_DEBUG_ARGS
);
824 # define readline_restart(A,B,C,D) \
825 readline_restart(A, B, C, D, __FILE__, __LINE__)
828 /* Read a complete line of input, with editing if interactive and possible.
829 * If prompt is NULL we'll call getprompt() first, if necessary.
830 * nl_escape defines wether user can escape newlines via backslash (POSIX).
831 * If string is set it is used as the initial line content if in interactive
832 * mode, otherwise this argument is ignored for reproducibility.
833 * Return number of octets or a value <0 on error.
834 * Note: may use the currently `source'd file stream instead of stdin! */
835 FL
int readline_input(char const *prompt
, bool_t nl_escape
,
836 char **linebuf
, size_t *linesize
, char const *string
839 # define readline_input(A,B,C,D,E) readline_input(A,B,C,D,E,__FILE__,__LINE__)
842 /* Read a line of input, with editing if interactive and possible, return it
843 * savestr()d or NULL in case of errors or if an empty line would be returned.
844 * This may only be called from toplevel (not during PS_SOURCING).
845 * If prompt is NULL we'll call getprompt() if necessary.
846 * If string is set it is used as the initial line content if in interactive
847 * mode, otherwise this argument is ignored for reproducibility.
848 * If OPT_INTERACTIVE a non-empty return is saved in the history, isgabby */
849 FL
char * n_input_cp_addhist(char const *prompt
, char const *string
,
852 /* Set up the input pointers while copying the mail file into /tmp */
853 FL
void setptr(FILE *ibuf
, off_t offset
);
855 /* Drop the passed line onto the passed output buffer. If a write error occurs
856 * return -1, else the count of characters written, including the newline */
857 FL
int putline(FILE *obuf
, char *linebuf
, size_t count
);
859 /* Return a file buffer all ready to read up the passed message pointer */
860 FL
FILE * setinput(struct mailbox
*mp
, struct message
*m
,
863 /* Reset (free) the global message array */
864 FL
void message_reset(void);
866 /* Append the passed message descriptor onto the message array; if mp is NULL,
867 * NULLify the entry at &[msgCount-1] */
868 FL
void message_append(struct message
*mp
);
870 /* Check wether sep->ss_sexpr (or ->ss_regex) matches mp. If with_headers is
871 * true then the headers will also be searched (as plain text) */
872 FL bool_t
message_match(struct message
*mp
, struct search_expr
const *sep
,
873 bool_t with_headers
);
875 FL
struct message
* setdot(struct message
*mp
);
877 /* Delete a file, but only if the file is a plain file */
878 FL
int rm(char const *name
);
880 /* Determine the size of the file possessed by the passed buffer */
881 FL off_t
fsize(FILE *iob
);
883 /* Evaluate the string given as a new mailbox name. Supported meta characters:
884 * . % for my system mail box
885 * . %user for user's system mail box
886 * . # for previous file
887 * . & invoker's mbox file
888 * . +file file in folder directory
889 * . any shell meta character (except for FEXP_NSHELL).
890 * If FEXP_NSHELL is set you possibly want to call fexpand_nshell_quote(),
891 * a poor man's vis(3), on name before calling this (and showing the user).
892 * Returns the file name as an auto-reclaimed string */
893 FL
char * fexpand(char const *name
, enum fexp_mode fexpm
);
895 #define expand(N) fexpand(N, FEXP_FULL) /* XXX obsolete */
896 #define file_expand(N) fexpand(N, FEXP_LOCAL) /* XXX obsolete */
898 /* A poor man's vis(3) for only backslash escaping as for FEXP_NSHELL.
899 * Returns the (possibly adjusted) buffer in auto-reclaimed storage */
900 FL
char * fexpand_nshell_quote(char const *name
);
902 /* accmacvar.c hook: *folder* variable has been updated; if folder shouldn't
903 * be replaced by something else leave store alone, otherwise smalloc() the
904 * desired value (ownership will be taken) */
905 FL bool_t
var_folder_updated(char const *folder
, char **store
);
907 /* Determine the current *folder* name, store it in *name* */
908 FL bool_t
getfold(char *name
, size_t size
);
910 /* Return the name of the dead.letter file */
911 FL
char const * getdeadletter(void);
913 FL
enum okay
get_body(struct message
*mp
);
917 /* Will retry FILE_LOCK_RETRIES times if pollmsecs > 0 */
918 FL bool_t
file_lock(int fd
, enum file_lock_type flt
, off_t off
, off_t len
,
921 /* Aquire a flt lock and create a dotlock file; upon success a registered
922 * control-pipe FILE* is returned that keeps the link in between us and the
923 * lock-holding fork(2)ed subprocess (which conditionally replaced itself via
924 * execv(2) with the privilege-separated dotlock helper program): the lock file
925 * will be removed once the control pipe is closed via Pclose().
926 * Will try FILE_LOCK_TRIES times if pollmsecs > 0 (once otherwise).
927 * If *dotlock_ignore_error* is set (FILE*)-1 will be returned if at least the
928 * normal file lock could be established, otherwise errno is usable on error */
929 FL
FILE * dot_lock(char const *fname
, int fd
, enum file_lock_type flt
,
930 off_t off
, off_t len
, size_t pollmsecs
);
934 FL bool_t
sopen(struct sock
*sp
, struct url
*urlp
);
935 FL
int sclose(struct sock
*sp
);
936 FL
enum okay
swrite(struct sock
*sp
, char const *data
);
937 FL
enum okay
swrite1(struct sock
*sp
, char const *data
, int sz
,
941 FL
int sgetline(char **line
, size_t *linesize
, size_t *linelen
,
942 struct sock
*sp SMALLOC_DEBUG_ARGS
);
944 # define sgetline(A,B,C,D) sgetline(A, B, C, D, __FILE__, __LINE__)
946 #endif /* HAVE_SOCKETS */
948 /* Deal with loading of resource files and dealing with a stack of files for
949 * the source command */
951 /* Load a file of user definitions -- this is *only* for main()! */
952 FL
void load(char const *name
);
954 /* Pushdown current input file and switch to a new one. Set the global flag
955 * PS_SOURCING so that others will realize that they are no longer reading from
956 * a tty (in all probability).
957 * The latter won't return failure (TODO should be replaced by "-f FILE") */
958 FL
int c_source(void *v
);
959 FL
int c_source_if(void *v
);
961 /* Pop the current input back to the previous level. Update the PS_SOURCING
962 * flag as appropriate */
963 FL
int unstack(void);
969 /* Return the user's From: address(es) */
970 FL
char const * myaddrs(struct header
*hp
);
972 /* Boil the user's From: addresses down to a single one, or use *sender* */
973 FL
char const * myorigin(struct header
*hp
);
975 /* See if the passed line buffer, which may include trailing newline (sequence)
976 * is a mail From_ header line according to RFC 4155.
977 * If compat is true laxe POSIX syntax is instead sufficient to match From_ */
978 FL
int is_head(char const *linebuf
, size_t linelen
, bool_t compat
);
980 /* Savage extract date field from From_ line. linelen is convenience as line
981 * must be terminated (but it may end in a newline [sequence]).
982 * Return wether the From_ line was parsed successfully */
983 FL
int extract_date_from_from_(char const *line
, size_t linelen
,
984 char datebuf
[FROM_DATEBUF
]);
986 /* Extract some header fields (see e.g. -t documentation) from a message.
987 * If options&OPT_t_FLAG *and* pstate&PS_t_FLAG are both set a number of
988 * additional header fields are understood and address joining is performed as
989 * necessary, and the subject is treated with additional care, too.
990 * If pstate&PS_t_FLAG is set but OPT_t_FLAG is no more, From: will not be
992 * This calls expandaddr() on some headers and sets checkaddr_err if that is
993 * not NULL -- note it explicitly allows EAF_NAME because aliases are not
994 * expanded when this is called! */
995 FL
void extract_header(FILE *fp
, struct header
*hp
,
996 si8_t
*checkaddr_err
);
998 /* Return the desired header line from the passed message
999 * pointer (or NULL if the desired header field is not available).
1000 * If mult is zero, return the content of the first matching header
1001 * field only, the content of all matching header fields else */
1002 FL
char * hfield_mult(char const *field
, struct message
*mp
, int mult
);
1003 #define hfieldX(a, b) hfield_mult(a, b, 1)
1004 #define hfield1(a, b) hfield_mult(a, b, 0)
1006 /* Check whether the passed line is a header line of the desired breed.
1007 * Return the field body, or 0 */
1008 FL
char const * thisfield(char const *linebuf
, char const *field
);
1010 /* Get sender's name from this message. If the message has a bunch of arpanet
1011 * stuff in it, we may have to skin the name before returning it */
1012 FL
char * nameof(struct message
*mp
, int reptype
);
1014 /* Start of a "comment". Ignore it */
1015 FL
char const * skip_comment(char const *cp
);
1017 /* Return the start of a route-addr (address in angle brackets), if present */
1018 FL
char const * routeaddr(char const *name
);
1020 /* Query *expandaddr*, parse it and return flags.
1021 * The flags are already adjusted for OPT_INTERACTIVE / OPT_TILDE_FLAG etc. */
1022 FL
enum expand_addr_flags
expandaddr_to_eaf(void);
1024 /* Check if an address is invalid, either because it is malformed or, if not,
1025 * according to eacm. Return FAL0 when it looks good, TRU1 if it is invalid
1026 * but the error condition wasn't covered by a 'hard "fail"ure', -1 otherwise */
1027 FL si8_t
is_addr_invalid(struct name
*np
,
1028 enum expand_addr_check_mode eacm
);
1030 /* Does *NP* point to a file or pipe addressee? */
1031 #define is_fileorpipe_addr(NP) \
1032 (((NP)->n_flags & NAME_ADDRSPEC_ISFILEORPIPE) != 0)
1034 /* Return skinned version of *NP*s name */
1035 #define skinned_name(NP) \
1036 (assert((NP)->n_flags & NAME_SKINNED), \
1037 ((struct name const*)NP)->n_name)
1039 /* Skin an address according to the RFC 822 interpretation of "host-phrase" */
1040 FL
char * skin(char const *name
);
1042 /* Skin *name* and extract the *addr-spec* according to RFC 5322.
1043 * Store the result in .ag_skinned and also fill in those .ag_ fields that have
1044 * actually been seen.
1045 * Return 0 if something good has been parsed, 1 if fun didn't exactly know how
1046 * to deal with the input, or if that was plain invalid */
1047 FL
int addrspec_with_guts(int doskin
, char const *name
,
1048 struct addrguts
*agp
);
1050 /* Fetch the real name from an internet mail address field */
1051 FL
char * realname(char const *name
);
1053 /* Fetch the sender's name from the passed message. reptype can be
1054 * 0 -- get sender's name for display purposes
1055 * 1 -- get sender's name for reply
1056 * 2 -- get sender's name for Reply */
1057 FL
char * name1(struct message
*mp
, int reptype
);
1059 /* Trim away all leading Re: etc., return pointer to plain subject.
1060 * Note it doesn't perform any MIME decoding by itself */
1061 FL
char * subject_re_trim(char *cp
);
1063 FL
int msgidcmp(char const *s1
, char const *s2
);
1065 /* See if the given header field is supposed to be ignored */
1066 FL
int is_ign(char const *field
, size_t fieldlen
,
1067 struct ignoretab igta
[2]);
1069 FL
int member(char const *realfield
, struct ignoretab
*table
);
1071 /* Fake Sender for From_ lines if missing, e. g. with POP3 */
1072 FL
char const * fakefrom(struct message
*mp
);
1074 FL
char const * fakedate(time_t t
);
1076 /* From username Fri Jan 2 20:13:51 2004
1079 #ifdef HAVE_IMAP_SEARCH
1080 FL
time_t unixtime(char const *from
);
1083 FL
time_t rfctime(char const *date
);
1085 FL
time_t combinetime(int year
, int month
, int day
,
1086 int hour
, int minute
, int second
);
1088 FL
void substdate(struct message
*m
);
1090 /* Note: returns 0x1 if both args were NULL */
1091 FL
struct name
const * check_from_and_sender(struct name
const *fromfield
,
1092 struct name
const *senderfield
);
1095 FL
char * getsender(struct message
*m
);
1098 /* Fill in / reedit the desired header fields */
1099 FL
int grab_headers(struct header
*hp
, enum gfield gflags
,
1102 /* Check wether sep->ss_sexpr (or ->ss_regex) matches any header of mp */
1103 FL bool_t
header_match(struct message
*mp
, struct search_expr
const *sep
);
1109 #ifdef HAVE_IMAP_SEARCH
1110 FL
enum okay
imap_search(char const *spec
, int f
);
1117 /* Set up editing on the given file name.
1118 * If the first character of name is %, we are considered to be editing the
1119 * file, otherwise we are reading our mail which has signficance for mbox and
1121 nmail: Check for new mail in the current folder only */
1122 FL
int setfile(char const *name
, enum fedit_mode fm
);
1124 FL
int newmailinfo(int omsgCount
);
1126 /* Interpret user commands. If standard input is not a tty, print no prompt;
1127 * return wether the last processed command returned error */
1128 FL bool_t
commands(void);
1130 /* TODO drop execute() is the legacy version of evaluate().
1131 * It assumes we've been invoked recursively */
1132 FL
int execute(char *linebuf
, size_t linesize
);
1134 /* Evaluate a single command.
1135 * .ev_add_history and .ev_new_content will be updated upon success.
1136 * Command functions return 0 for success, 1 for error, and -1 for abort.
1137 * 1 or -1 aborts a load or source, a -1 aborts the interactive command loop */
1138 FL
int evaluate(struct eval_ctx
*evp
);
1140 /* Set the size of the message vector used to construct argument lists to
1141 * message list functions */
1142 FL
void setmsize(int sz
);
1144 /* Logic behind -H / -L invocations */
1145 FL
void print_header_summary(char const *Larg
);
1147 /* The following gets called on receipt of an interrupt. This is to abort
1148 * printout of a command, mainly. Dispatching here when command() is inactive
1149 * crashes rcv. Close all open files except 0, 1, 2, and the temporary. Also,
1150 * unstack all source files */
1151 FL
void onintr(int s
);
1153 /* Announce the presence of the current Mail version, give the message count,
1154 * and print a header listing */
1155 FL
void announce(int printheaders
);
1157 /* Announce information about the file we are editing. Return a likely place
1159 FL
int newfileinfo(void);
1161 FL
int getmdot(int nmail
);
1163 FL
void initbox(char const *name
);
1165 /* Print the docstring of `comm', which may be an abbreviation.
1166 * Return FAL0 if there is no such command */
1167 #ifdef HAVE_DOCSTRINGS
1168 FL bool_t
print_comm_docstr(char const *comm
);
1175 /* Convert user string of message numbers and store the numbers into vector.
1176 * Returns the count of messages picked up or -1 on error */
1177 FL
int getmsglist(char *buf
, int *vector
, int flags
);
1179 /* Scan out the list of string arguments, shell style for a RAWLIST */
1180 FL
int getrawlist(char const *line
, size_t linesize
,
1181 char **argv
, int argc
, int echolist
);
1183 /* Find the first message whose flags&m==f and return its message number */
1184 FL
int first(int f
, int m
);
1186 /* Mark the named message by setting its mark bit */
1187 FL
void mark(int mesg
, int f
);
1193 FL
int maildir_setfile(char const *name
, enum fedit_mode fm
);
1195 FL
void maildir_quit(void);
1197 FL
enum okay
maildir_append(char const *name
, FILE *fp
, long offset
);
1199 FL
enum okay
maildir_remove(char const *name
);
1205 /* Quit quickly. If PS_SOURCING, just pop the input level by returning error */
1206 FL
int c_rexit(void *v
);
1212 /* *charset-7bit*, else CHARSET_7BIT */
1213 FL
char const * charset_get_7bit(void);
1215 /* *charset-8bit*, else CHARSET_8BIT */
1217 FL
char const * charset_get_8bit(void);
1220 /* LC_CTYPE:CODESET / *ttycharset*, else *charset-8bit*, else CHARSET_8BIT */
1221 FL
char const * charset_get_lc(void);
1223 /* *sendcharsets* .. *charset-8bit* iterator; *a_charset_to_try_first* may be
1224 * used to prepend a charset to this list (e.g., for *reply-in-same-charset*).
1225 * The returned boolean indicates charset_iter_is_valid().
1226 * Without HAVE_ICONV, this "iterates" over charset_get_lc() only */
1227 FL bool_t
charset_iter_reset(char const *a_charset_to_try_first
);
1228 FL bool_t
charset_iter_next(void);
1229 FL bool_t
charset_iter_is_valid(void);
1230 FL
char const * charset_iter(void);
1232 /* And this is (xxx temporary?) which returns the iterator if that is valid and
1233 * otherwise either charset_get_8bit() or charset_get_lc() dep. on HAVE_ICONV */
1234 FL
char const * charset_iter_or_fallback(void);
1236 FL
void charset_iter_recurse(char *outer_storage
[2]); /* TODO LEGACY */
1237 FL
void charset_iter_restore(char *outer_storage
[2]); /* TODO LEGACY */
1239 /* Check wether our headers will need MIME conversion */
1241 FL
char const * need_hdrconv(struct header
*hp
);
1244 /* Convert header fields from RFC 1522 format */
1245 FL
void mime_fromhdr(struct str
const *in
, struct str
*out
,
1246 enum tdflags flags
);
1248 /* Interpret MIME strings in parts of an address field */
1249 FL
char * mime_fromaddr(char const *name
);
1251 /* fwrite(3) performing the given MIME conversion */
1252 FL ssize_t
mime_write(char const *ptr
, size_t size
, FILE *f
,
1253 enum conversion convert
, enum tdflags dflags
,
1254 struct quoteflt
*qf
, struct str
*rest
);
1255 FL ssize_t
xmime_write(char const *ptr
, size_t size
, /* TODO LEGACY */
1256 FILE *f
, enum conversion convert
, enum tdflags dflags
);
1260 * Content-Transfer-Encodings as defined in RFC 2045 (and RFC 2047):
1261 * - Quoted-Printable, section 6.7
1262 * - Base64, section 6.8
1263 * TODO for now this is pretty mixed up regarding this external interface.
1264 * TODO in v15.0 CTE will be filter based, and explicit conversion will
1265 * TODO gain clear error codes
1268 /* Utilities: the former converts the byte c into a (NUL terminated)
1269 * hexadecimal string as is used in URL percent- and quoted-printable encoding,
1270 * the latter performs the backward conversion and returns the character or -1
1271 * on error; both don't deal with the sequence-introducing percent "%" */
1272 FL
char * mime_char_to_hexseq(char store
[3], char c
);
1273 FL si32_t
mime_hexseq_to_char(char const *hex
);
1275 /* Default MIME Content-Transfer-Encoding: as via *encoding* */
1276 FL
enum mime_enc
mime_enc_target(void);
1278 /* Map from a Content-Transfer-Encoding: header body (which may be NULL) */
1279 FL
enum mime_enc
mime_enc_from_ctehead(char const *hbody
);
1281 /* XXX Try to get rid of that */
1282 FL
char const * mime_enc_from_conversion(enum conversion
const convert
);
1284 /* How many characters of (the complete body) ln need to be quoted.
1285 * Only MIMEEF_ISHEAD and MIMEEF_ISENCWORD are understood */
1286 FL
size_t mime_enc_mustquote(char const *ln
, size_t lnlen
,
1287 enum mime_enc_flags flags
);
1289 /* How much space is necessary to encode len bytes in QP, worst case.
1290 * Includes room for terminator */
1291 FL
size_t qp_encode_calc_size(size_t len
);
1293 /* If flags includes QP_ISHEAD these assume "word" input and use special
1294 * quoting rules in addition; soft line breaks are not generated.
1295 * Otherwise complete input lines are assumed and soft line breaks are
1296 * generated as necessary */
1297 FL
struct str
* qp_encode(struct str
*out
, struct str
const *in
,
1298 enum qpflags flags
);
1300 FL
struct str
* qp_encode_cp(struct str
*out
, char const *cp
,
1301 enum qpflags flags
);
1302 FL
struct str
* qp_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
1303 enum qpflags flags
);
1306 /* If rest is set then decoding will assume body text input (assumes input
1307 * represents lines, only create output when input didn't end with soft line
1308 * break [except it finalizes an encoded CRLF pair]), otherwise it is assumed
1309 * to decode a header strings and (1) uses special decoding rules and (b)
1310 * directly produces output.
1311 * The buffers of out and possibly rest will be managed via srealloc().
1312 * Returns OKAY. XXX or STOP on error (in which case out is set to an error
1313 * XXX message); caller is responsible to free buffers */
1314 FL
int qp_decode(struct str
*out
, struct str
const *in
,
1317 /* How much space is necessary to encode len bytes in Base64, worst case.
1318 * Includes room for (CR/LF/CRLF and) terminator */
1319 FL
size_t b64_encode_calc_size(size_t len
);
1321 /* Note these simply convert all the input (if possible), including the
1322 * insertion of NL sequences if B64_CRLF or B64_LF is set (and multiple thereof
1323 * if B64_MULTILINE is set).
1324 * Thus, in the B64_BUF case, better call b64_encode_calc_size() first */
1325 FL
struct str
* b64_encode(struct str
*out
, struct str
const *in
,
1326 enum b64flags flags
);
1327 FL
struct str
* b64_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
1328 enum b64flags flags
);
1330 FL
struct str
* b64_encode_cp(struct str
*out
, char const *cp
,
1331 enum b64flags flags
);
1334 /* If rest is set then decoding will assume text input.
1335 * The buffers of out and possibly rest will be managed via srealloc().
1336 * Returns OKAY or STOP on error (in which case out is set to an error
1337 * message); caller is responsible to free buffers.
1338 * XXX STOP is effectively not returned for text input (rest!=NULL), instead
1339 * XXX replacement characters are produced for invalid data */
1340 FL
int b64_decode(struct str
*out
, struct str
const *in
,
1347 /* Get a mime style parameter from a header body */
1348 FL
char * mime_param_get(char const *param
, char const *headerbody
);
1350 /* Format parameter name to have value, salloc() it or NULL (error) in result.
1351 * 0 on error, 1 or -1 on success: the latter if result contains \n newlines,
1352 * which it will if the created param requires more than MIME_LINELEN bytes;
1353 * there is never a trailing newline character */
1354 /* TODO mime_param_create() should return a StrList<> or something.
1355 * TODO in fact it should take a HeaderField* and append a HeaderFieldParam*! */
1356 FL si8_t
mime_param_create(struct str
*result
, char const *name
,
1359 /* Get the boundary out of a Content-Type: multipart/xyz header field, return
1360 * salloc()ed copy of it; store strlen() in *len if set */
1361 FL
char * mime_param_boundary_get(char const *headerbody
, size_t *len
);
1363 /* Create a salloc()ed MIME boundary */
1364 FL
char * mime_param_boundary_create(void);
1370 /* Create MIME part object tree for and of mp */
1371 FL
struct mimepart
* mime_parse_msg(struct message
*mp
,
1372 enum mime_parse_flags mpf
);
1378 /* `(un)?mimetype' commands */
1379 FL
int c_mimetype(void *v
);
1380 FL
int c_unmimetype(void *v
);
1382 /* Return a Content-Type matching the name, or NULL if none could be found */
1383 FL
char * mime_type_classify_filename(char const *name
);
1385 /* Classify content of *fp* as necessary and fill in arguments; **charset* is
1386 * left alone unless it's non-NULL */
1387 FL
enum conversion
mime_type_classify_file(FILE *fp
, char const **contenttype
,
1388 char const **charset
, int *do_iconv
);
1390 /* Dependend on *mime-counter-evidence* mpp->m_ct_type_usr_ovwr will be set,
1391 * but otherwise mpp is const */
1392 FL
enum mimecontent
mime_type_classify_part(struct mimepart
*mpp
);
1394 /* Query handler for a part, return the plain type (& MIME_HDL_TYPE_MASK).
1395 * mhp is anyway initialized (mh_flags, mh_msg) */
1396 FL
enum mime_handler_flags
mime_type_handler(struct mime_handler
*mhp
,
1397 struct mimepart
const *mpp
,
1398 enum sendaction action
);
1404 /* Allocate a single element of a name list, initialize its name field to the
1405 * passed name and return it */
1406 FL
struct name
* nalloc(char *str
, enum gfield ntype
);
1408 /* Like nalloc(), but initialize from content of np */
1409 FL
struct name
* ndup(struct name
*np
, enum gfield ntype
);
1411 /* Concatenate the two passed name lists, return the result */
1412 FL
struct name
* cat(struct name
*n1
, struct name
*n2
);
1415 FL
struct name
* namelist_dup(struct name
const *np
, enum gfield ntype
);
1417 /* Determine the number of undeleted elements in a name list and return it;
1418 * the latter also doesn't count file and pipe addressees in addition */
1419 FL ui32_t
count(struct name
const *np
);
1420 FL ui32_t
count_nonlocal(struct name
const *np
);
1422 /* Extract a list of names from a line, and make a list of names from it.
1423 * Return the list or NULL if none found */
1424 FL
struct name
* extract(char const *line
, enum gfield ntype
);
1426 /* Like extract() unless line contains anyof ",\"\\(<|", in which case
1427 * comma-separated list extraction is used instead */
1428 FL
struct name
* lextract(char const *line
, enum gfield ntype
);
1430 /* Turn a list of names into a string of the same names */
1431 FL
char * detract(struct name
*np
, enum gfield ntype
);
1433 /* Get a lextract() list via n_input_cp_addhist(), reassigning to *np* */
1434 FL
struct name
* grab_names(char const *field
, struct name
*np
, int comma
,
1435 enum gfield gflags
);
1437 /* Check wether n1 n2 share the domain name */
1438 FL bool_t
name_is_same_domain(struct name
const *n1
,
1439 struct name
const *n2
);
1441 /* Check all addresses in np and delete invalid ones; if set_on_error is not
1442 * NULL it'll be set to TRU1 for error or -1 for "hard fail" error */
1443 FL
struct name
* checkaddrs(struct name
*np
, enum expand_addr_check_mode eacm
,
1444 si8_t
*set_on_error
);
1446 /* Vaporise all duplicate addresses in hp (.h_(to|cc|bcc)) so that an address
1447 * that "first" occurs in To: is solely in there, ditto Cc:, after expanding
1448 * aliases etc. eacm and set_on_error are passed to checkaddrs(), metoo is
1449 * passed to usermap(). After updating hp to the new state this returns
1450 * a flat list of all addressees, which may be NULL */
1451 FL
struct name
* namelist_vaporise_head(struct header
*hp
,
1452 enum expand_addr_check_mode eacm
, bool_t metoo
,
1453 si8_t
*set_on_error
);
1455 /* Map all of the aliased users in the invoker's mailrc file and insert them
1457 FL
struct name
* usermap(struct name
*names
, bool_t force_metoo
);
1459 /* Remove all of the duplicates from the passed name list by insertion sorting
1460 * them, then checking for dups. Return the head of the new list */
1461 FL
struct name
* elide(struct name
*names
);
1463 /* `alternates' deal with the list of alternate names */
1464 FL
int c_alternates(void *v
);
1466 FL
struct name
* delete_alternates(struct name
*np
);
1468 FL
int is_myname(char const *name
);
1471 FL
int c_alias(void *v
);
1472 FL
int c_unalias(void *v
);
1474 /* `(un)?ml(ist|subscribe)', and a check wether a name is a (wanted) list */
1475 FL
int c_mlist(void *v
);
1476 FL
int c_unmlist(void *v
);
1477 FL
int c_mlsubscribe(void *v
);
1478 FL
int c_unmlsubscribe(void *v
);
1480 FL
enum mlist_state
is_mlist(char const *name
, bool_t subscribed_only
);
1482 /* `(un)?shortcut', and check if str is one, return expansion or NULL */
1483 FL
int c_shortcut(void *v
);
1484 FL
int c_unshortcut(void *v
);
1486 FL
char const * shortcut_expand(char const *str
);
1488 /* `(un)?customhdr'.
1489 * Query a list of all currently defined custom headers (salloc()ed) */
1490 FL
int c_customhdr(void *v
);
1491 FL
int c_uncustomhdr(void *v
);
1493 FL
struct n_header_field
* n_customhdr_query(void);
1501 FL
enum okay
ssl_open(struct url
const *urlp
, struct sock
*sp
);
1504 FL
void ssl_gen_err(char const *fmt
, ...);
1507 FL
int c_verify(void *vp
);
1510 FL
FILE * smime_sign(FILE *ip
, char const *addr
);
1513 FL
FILE * smime_encrypt(FILE *ip
, char const *certfile
, char const *to
);
1515 FL
struct message
* smime_decrypt(struct message
*m
, char const *to
,
1516 char const *cc
, int signcall
);
1519 FL
enum okay
smime_certsave(struct message
*m
, int n
, FILE *op
);
1521 #else /* HAVE_OPENSSL */
1522 # define c_verify c_cmdnotsupp
1531 FL
enum okay
pop3_noop(void);
1534 FL
int pop3_setfile(char const *server
, enum fedit_mode fm
);
1537 FL
enum okay
pop3_header(struct message
*m
);
1540 FL
enum okay
pop3_body(struct message
*m
);
1543 FL
void pop3_quit(void);
1544 #endif /* HAVE_POP3 */
1548 * Subprocesses, popen, but also file handling with registering
1551 /* For program startup in main.c: initialize process manager */
1552 FL
void command_manager_start(void);
1554 /* Notes: OF_CLOEXEC is implied in oflags, xflags may be NULL */
1555 FL
FILE * safe_fopen(char const *file
, char const *oflags
, int *xflags
);
1557 /* Notes: OF_CLOEXEC|OF_REGISTER are implied in oflags!
1558 * Exception is Fdopen() if nocloexec is TRU1, but otherwise even for it the fd
1559 * creator has to take appropriate steps in order to ensure this is true! */
1560 FL
FILE * Fopen(char const *file
, char const *oflags
);
1561 FL
FILE * Fdopen(int fd
, char const *oflags
, bool_t nocloexec
);
1563 FL
int Fclose(FILE *fp
);
1565 /* Open file according to oflags (see popen.c). Handles compressed files */
1566 FL
FILE * Zopen(char const *file
, char const *oflags
);
1568 /* Create a temporary file in tempdir, use namehint for its name (prefix
1569 * unless OF_SUFFIX is set, in which case namehint is an extension that MUST be
1570 * part of the resulting filename, otherwise Ftmp() will fail), store the
1571 * unique name in fn (unless OF_UNLINK is set in oflags), and return a stdio
1572 * FILE pointer with access oflags. OF_CLOEXEC is implied in oflags.
1573 * One of OF_WRONLY and OF_RDWR must be set. Mode of 0600 is implied */
1574 FL
FILE * Ftmp(char **fn
, char const *namehint
, enum oflags oflags
);
1576 /* If OF_HOLDSIGS was set when calling Ftmp(), then hold_all_sigs() had been
1577 * called: call this to unlink(2) and free *fn and to rele_all_sigs() */
1578 FL
void Ftmp_release(char **fn
);
1580 /* Free the resources associated with the given filename. To be called after
1582 FL
void Ftmp_free(char **fn
);
1584 /* Create a pipe and ensure CLOEXEC bit is set in both descriptors */
1585 FL bool_t
pipe_cloexec(int fd
[2]);
1588 * env_addon may be NULL, otherwise it is expected to be a NULL terminated
1589 * array of "K=V" strings to be placed into the childs environment.
1590 * If cmd==(char*)-1 then shell is indeed expected to be a PTF :P that will be
1591 * called from within the child process */
1592 FL
FILE * Popen(char const *cmd
, char const *mode
, char const *shell
,
1593 char const **env_addon
, int newfd1
);
1595 FL bool_t
Pclose(FILE *ptr
, bool_t dowait
);
1597 FL
void close_all_files(void);
1599 /* Fork a child process, enable use of the *child() series below */
1600 FL
int fork_child(void);
1602 /* Run a command without a shell, with optional arguments and splicing of stdin
1603 * and stdout. FDs may also be COMMAND_FD_NULL and COMMAND_FD_PASS, meaning to
1604 * redirect from/to /dev/null or pass through our own set of FDs; in the
1605 * latter case terminal capabilities are saved/restored if possible.
1606 * The command name can be a sequence of words.
1607 * Signals must be handled by the caller. "Mask" contains the signals to
1608 * ignore in the new process. SIGINT is enabled unless it's in the mask.
1609 * env_addon may be NULL, otherwise it is expected to be a NULL terminated
1610 * array of "K=V" strings to be placed into the childs environment */
1611 FL
int run_command(char const *cmd
, sigset_t
*mask
, int infd
,
1612 int outfd
, char const *a0
, char const *a1
, char const *a2
,
1613 char const **env_addon
);
1615 /* Like run_command, but don't wait for the command to finish.
1616 * Also it is usually an error to use COMMAND_FD_PASS for this one */
1617 FL
int start_command(char const *cmd
, sigset_t
*mask
, int infd
,
1618 int outfd
, char const *a0
, char const *a1
, char const *a2
,
1619 char const **env_addon
);
1621 /* In-child process */
1622 FL
void prepare_child(sigset_t
*nset
, int infd
, int outfd
);
1624 /* Mark a child as don't care - pid */
1625 FL
void free_child(int pid
);
1627 /* Wait for pid, return wether we've had a normal EXIT_SUCCESS exit.
1628 * If wait_status is set, set it to the reported waitpid(2) wait status */
1629 FL bool_t
wait_child(int pid
, int *wait_status
);
1635 /* Save all of the undetermined messages at the top of "mbox". Save all
1636 * untouched messages back in the system mailbox. Remove the system mailbox,
1637 * if none saved there */
1640 /* Adjust the message flags in each message */
1641 FL
int holdbits(void);
1643 /* Create another temporary file and copy user's mbox file darin. If there is
1644 * no mbox, copy nothing. If he has specified "append" don't copy his mailbox,
1645 * just copy saveable entries at the end */
1646 FL
enum okay
makembox(void);
1648 FL
void save_mbox_for_possible_quitstuff(void); /* TODO DROP IF U CAN */
1650 FL
int savequitflags(void);
1652 FL
void restorequitflags(int);
1658 /* Send message described by the passed pointer to the passed output buffer.
1659 * Return -1 on error. Adjust the status: field if need be. If doign is
1660 * given, suppress ignored header fields. prefix is a string to prepend to
1661 * each output line. action = data destination
1662 * (SEND_MBOX,_TOFILE,_TODISP,_QUOTE,_DECRYPT). stats[0] is line count,
1663 * stats[1] is character count. stats may be NULL. Note that stats[0] is
1664 * valid for SEND_MBOX only */
1665 FL
int sendmp(struct message
*mp
, FILE *obuf
, struct ignoretab
*doign
,
1666 char const *prefix
, enum sendaction action
, ui64_t
*stats
);
1672 /* Interface between the argument list and the mail1 routine which does all the
1674 FL
int mail(struct name
*to
, struct name
*cc
, struct name
*bcc
,
1675 char *subject
, struct attachment
*attach
, char *quotefile
,
1676 int recipient_record
);
1678 /* `mail' and `Mail' commands, respectively */
1679 FL
int c_sendmail(void *v
);
1680 FL
int c_Sendmail(void *v
);
1682 /* Mail a message on standard input to the people indicated in the passed
1683 * header. (Internal interface) */
1684 FL
enum okay
mail1(struct header
*hp
, int printheaders
,
1685 struct message
*quote
, char *quotefile
, int recipient_record
,
1688 /* Create a Date: header field.
1689 * We compare the localtime() and gmtime() results to get the timezone, because
1690 * numeric timezones are easier to read and because $TZ isn't always set */
1691 FL
int mkdate(FILE *fo
, char const *field
);
1693 /* Dump the to, subject, cc header on the passed file buffer.
1694 * nosend_msg tells us not to dig to deep but to instead go for compose mode or
1695 * editing a message (yet we're stupid and cannot do it any better) - if it is
1696 * TRUM1 then we're really in compose mode and will produce some fields for
1697 * easier filling in */
1698 FL
int puthead(bool_t nosend_msg
, struct header
*hp
, FILE *fo
,
1699 enum gfield w
, enum sendaction action
,
1700 enum conversion convert
, char const *contenttype
,
1701 char const *charset
);
1704 FL
enum okay
resend_msg(struct message
*mp
, struct name
*to
, int add_resent
);
1711 /* Send a message via SMTP */
1712 FL bool_t
smtp_mta(struct sendbundle
*sbp
);
1720 /* Direct mappings of the various spam* commands */
1721 FL
int c_spam_clear(void *v
);
1722 FL
int c_spam_set(void *v
);
1723 FL
int c_spam_forget(void *v
);
1724 FL
int c_spam_ham(void *v
);
1725 FL
int c_spam_rate(void *v
);
1726 FL
int c_spam_spam(void *v
);
1728 # define c_spam_clear c_cmdnotsupp
1729 # define c_spam_set c_cmdnotsupp
1730 # define c_spam_forget c_cmdnotsupp
1731 # define c_spam_ham c_cmdnotsupp
1732 # define c_spam_rate c_cmdnotsupp
1733 # define c_spam_spam c_cmdnotsupp
1742 FL
void ssl_set_verify_level(struct url
const *urlp
);
1745 FL
enum okay
ssl_verify_decide(void);
1748 FL
enum okay
smime_split(FILE *ip
, FILE **hp
, FILE **bp
, long xcount
,
1752 FL
FILE * smime_sign_assemble(FILE *hp
, FILE *bp
, FILE *sp
,
1753 char const *message_digest
);
1756 FL
FILE * smime_encrypt_assemble(FILE *hp
, FILE *yp
);
1759 FL
struct message
* smime_decrypt_assemble(struct message
*m
, FILE *hp
,
1763 FL
int c_certsave(void *v
);
1766 FL
enum okay
rfc2595_hostname_match(char const *host
, char const *pattern
);
1767 #else /* HAVE_SSL */
1768 # define c_certsave c_cmdnotsupp
1773 * This bundles several different string related support facilities:
1774 * - auto-reclaimed string storage (memory goes away on command loop ticks)
1775 * - plain char* support functions which use unspecified or smalloc() memory
1776 * - struct str related support funs
1777 * - our iconv(3) wrapper
1780 /* Auto-reclaimed string storage */
1783 # define SALLOC_DEBUG_ARGS , char const *mdbg_file, int mdbg_line
1784 # define SALLOC_DEBUG_ARGSCALL , mdbg_file, mdbg_line
1786 # define SALLOC_DEBUG_ARGS
1787 # define SALLOC_DEBUG_ARGSCALL
1790 /* Allocate size more bytes of space and return the address of the first byte
1791 * to the caller. An even number of bytes are always allocated so that the
1792 * space will always be on a word boundary */
1793 FL
void * salloc(size_t size SALLOC_DEBUG_ARGS
);
1794 FL
void * csalloc(size_t nmemb
, size_t size SALLOC_DEBUG_ARGS
);
1796 # define salloc(SZ) salloc(SZ, __FILE__, __LINE__)
1797 # define csalloc(NM,SZ) csalloc(NM, SZ, __FILE__, __LINE__)
1800 /* Auto-reclaim string storage; if only_if_relaxed is true then only perform
1801 * the reset when a srelax_hold() is currently active */
1802 FL
void sreset(bool_t only_if_relaxed
);
1804 /* The "problem" with sreset() is that it releases all string storage except
1805 * what was present once spreserve() had been called; it therefore cannot be
1806 * called from all that code which yet exists and walks about all the messages
1807 * in order, e.g. quit(), searches, etc., because, unfortunately, these code
1808 * paths are reached with new intermediate string dope already in use.
1809 * Thus such code should take a srelax_hold(), successively call srelax() after
1810 * a single message has been handled, and finally srelax_rele() (unless it is
1811 * clear that sreset() occurs anyway) */
1812 FL
void srelax_hold(void);
1813 FL
void srelax_rele(void);
1814 FL
void srelax(void);
1816 /* Make current string storage permanent: new allocs will be auto-reclaimed by
1817 * sreset(). This is called once only, from within main() */
1818 FL
void spreserve(void);
1820 /* 'sstats' command */
1822 FL
int c_sstats(void *v
);
1825 /* Return a pointer to a dynamic copy of the argument */
1826 FL
char * savestr(char const *str SALLOC_DEBUG_ARGS
);
1827 FL
char * savestrbuf(char const *sbuf
, size_t sbuf_len SALLOC_DEBUG_ARGS
);
1829 # define savestr(CP) savestr(CP, __FILE__, __LINE__)
1830 # define savestrbuf(CBP,CBL) savestrbuf(CBP, CBL, __FILE__, __LINE__)
1833 /* Concatenate cp2 onto cp1 (if not NULL), separated by sep (if not '\0') */
1834 FL
char * savecatsep(char const *cp1
, char sep
, char const *cp2
1837 # define savecatsep(S1,SEP,S2) savecatsep(S1, SEP, S2, __FILE__, __LINE__)
1840 /* Make copy of argument incorporating old one, if set, separated by space */
1841 #define save2str(S,O) savecatsep(O, ' ', S)
1844 #define savecat(S1,S2) savecatsep(S1, '\0', S2)
1846 /* Create duplicate, lowercasing all characters along the way */
1847 FL
char * i_strdup(char const *src SALLOC_DEBUG_ARGS
);
1849 # define i_strdup(CP) i_strdup(CP, __FILE__, __LINE__)
1853 FL
struct str
* str_concat_csvl(struct str
*self
, ...);
1856 FL
struct str
* str_concat_cpa(struct str
*self
, char const * const *cpa
,
1857 char const *sep_o_null SALLOC_DEBUG_ARGS
);
1859 # define str_concat_cpa(S,A,N) str_concat_cpa(S, A, N, __FILE__, __LINE__)
1862 /* Plain char* support, not auto-reclaimed (unless noted) */
1864 /* Are any of the characters in the two strings the same? */
1865 FL
int anyof(char const *s1
, char const *s2
);
1867 /* Treat *iolist as a sep separated list of strings; find and return the
1868 * next entry, trimming surrounding whitespace, and point *iolist to the next
1869 * entry or to NULL if no more entries are contained. If ignore_empty is not
1870 * set empty entries are started over.
1871 * strescsep will assert that sep is not NULL, and allows escaping of the
1872 * separator character with a backslash.
1873 * Return NULL or an entry */
1874 FL
char * n_strsep(char **iolist
, char sep
, bool_t ignore_empty
);
1875 FL
char * n_strescsep(char **iolist
, char sep
, bool_t ignore_empty
);
1877 /* Copy a string, lowercasing it as we go; *size* is buffer size of *dest*;
1878 * *dest* will always be terminated unless *size* is 0 */
1879 FL
void i_strcpy(char *dest
, char const *src
, size_t size
);
1881 /* Is *as1* a valid prefix of *as2*? */
1882 FL
int is_prefix(char const *as1
, char const *as2
);
1884 /* Backslash quote (" and \) v'alue, and return salloc()ed result */
1885 FL
char * string_quote(char const *v
);
1887 /* Get (and isolate) the last, possibly quoted part of linebuf, set *needs_list
1888 * to indicate wether getmsglist() et al need to be called to collect
1889 * additional args that remain in linebuf. If strip is true possibly
1890 * surrounding quote characters are removed. Return NULL on "error" */
1891 FL
char * laststring(char *linebuf
, bool_t
*needs_list
, bool_t strip
);
1893 /* Convert a string to lowercase, in-place and with multibyte-aware */
1894 FL
void makelow(char *cp
);
1896 /* Is *sub* a substring of *str*, case-insensitive and multibyte-aware? */
1897 FL bool_t
substr(char const *str
, char const *sub
);
1900 FL
char * sstpcpy(char *dst
, char const *src
);
1901 FL
char * sstrdup(char const *cp SMALLOC_DEBUG_ARGS
);
1902 FL
char * sbufdup(char const *cp
, size_t len SMALLOC_DEBUG_ARGS
);
1904 # define sstrdup(CP) sstrdup(CP, __FILE__, __LINE__)
1905 # define sbufdup(CP,L) sbufdup(CP, L, __FILE__, __LINE__)
1908 /* Copy at most dstsize bytes of src to dst and return string length.
1909 * Returns -E2BIG if dst is not large enough; dst will always be terminated
1910 * unless dstsize was 0 on entry */
1911 FL ssize_t
n_strscpy(char *dst
, char const *src
, size_t dstsize
);
1913 /* Case-independent ASCII comparisons */
1914 FL
int asccasecmp(char const *s1
, char const *s2
);
1915 FL
int ascncasecmp(char const *s1
, char const *s2
, size_t sz
);
1917 /* Case-independent ASCII string find s2 in s1, return it or NULL */
1918 FL
char const *asccasestr(char const *s1
, char const *s2
);
1920 /* Case-independent ASCII check wether as2 is the initial substring of as1 */
1921 FL bool_t
is_asccaseprefix(char const *as1
, char const *as2
);
1923 /* struct str related support funs */
1925 /* *self->s* is srealloc()ed */
1926 FL
struct str
* n_str_dup(struct str
*self
, struct str
const *t
1927 SMALLOC_DEBUG_ARGS
);
1929 /* *self->s* is srealloc()ed, *self->l* incremented */
1930 FL
struct str
* n_str_add_buf(struct str
*self
, char const *buf
, size_t buflen
1931 SMALLOC_DEBUG_ARGS
);
1932 #define n_str_add(S, T) n_str_add_buf(S, (T)->s, (T)->l)
1933 #define n_str_add_cp(S, CP) n_str_add_buf(S, CP, (CP) ? strlen(CP) : 0)
1936 # define n_str_dup(S,T) n_str_dup(S, T, __FILE__, __LINE__)
1937 # define n_str_add_buf(S,B,BL) n_str_add_buf(S, B, BL, __FILE__, __LINE__)
1942 /* ..and update arguments to point after range; returns UI32_MAX on error, in
1943 * which case the arguments will have been stepped one byte */
1944 #ifdef HAVE_NATCH_CHAR
1945 FL ui32_t
n_utf8_to_utf32(char const **bdat
, size_t *blen
);
1948 /* buf must be large enough also for NUL, it's new length will be returned */
1949 #ifdef HAVE_FILTER_HTML_TAGSOUP
1950 FL
size_t n_utf32_to_utf8(ui32_t c
, char *buf
);
1953 /* Our iconv(3) wrappers */
1956 FL iconv_t
n_iconv_open(char const *tocode
, char const *fromcode
);
1957 /* If *cd* == *iconvd*, assigns -1 to the latter */
1958 FL
void n_iconv_close(iconv_t cd
);
1960 /* Reset encoding state */
1961 FL
void n_iconv_reset(iconv_t cd
);
1963 /* iconv(3), but return *errno* or 0; *skipilseq* forces step over invalid byte
1964 * sequences; likewise iconv_str(), but which auto-grows on E2BIG errors; *in*
1965 * and *in_rest_or_null* may be the same object.
1966 * Note: EINVAL (incomplete sequence at end of input) is NOT handled, so the
1967 * replacement character must be added manually if that happens at EOF! */
1968 FL
int n_iconv_buf(iconv_t cd
, char const **inb
, size_t *inbleft
,
1969 char **outb
, size_t *outbleft
, bool_t skipilseq
);
1970 FL
int n_iconv_str(iconv_t icp
, struct str
*out
, struct str
const *in
,
1971 struct str
*in_rest_or_null
, bool_t skipilseq
);
1978 /* termcap(3) / xy lifetime handling -- only to be called if OPT_INTERACTIVE
1979 * is true, and may internally decline to initialize itself; note that
1980 * termcap_destroy() can always be called */
1981 /* TODO Maybe drop TTYOUT/etc. and only set INTERACTIVE when input and output
1982 * TODO are a terminal, or ensure via I/O stuff that we use the input+output
1983 * TODO terminal FD accordingly */
1985 FL
void termcap_init(void);
1986 FL
void termcap_destroy(void);
1994 FL
int c_thread(void *vp
);
1997 FL
int c_unthread(void *vp
);
2000 FL
struct message
* next_in_thread(struct message
*mp
);
2001 FL
struct message
* prev_in_thread(struct message
*mp
);
2002 FL
struct message
* this_in_thread(struct message
*mp
, long n
);
2004 /* Sorted mode is internally just a variant of threaded mode with all m_parent
2005 * and m_child links being NULL */
2006 FL
int c_sort(void *vp
);
2009 FL
int c_collapse(void *v
);
2010 FL
int c_uncollapse(void *v
);
2013 FL
void uncollapse1(struct message
*mp
, int always
);
2019 /* Return wether user says yes, on STDIN if interactive.
2020 * Uses noninteract_default, the return value for non-interactive use cases,
2021 * as a hint for boolify() and chooses the yes/no string to append to prompt
2022 * accordingly. If prompt is NULL "Continue" is used instead.
2023 * Handles+reraises SIGINT */
2024 FL bool_t
getapproval(char const *prompt
, bool_t noninteract_default
);
2027 /* Get a password the expected way, return termios_state.ts_linebuf on
2028 * success or NULL on error */
2029 FL
char * getuser(char const *query
);
2031 /* Get a password the expected way, return termios_state.ts_linebuf on
2032 * success or NULL on error. SIGINT is temporarily blocked, *not* reraised.
2033 * termios_state_reset() (def.h) must be called anyway */
2034 FL
char * getpassword(char const *query
);
2037 /* Overall interactive terminal life cycle for command line editor library */
2038 #if defined HAVE_EDITLINE || defined HAVE_READLINE
2039 # define TTY_WANTS_SIGWINCH
2041 FL
void n_tty_init(void);
2042 FL
void n_tty_destroy(void);
2044 /* Rather for main.c / SIGWINCH interaction only */
2045 FL
void n_tty_signal(int sig
);
2047 /* Read a line after printing prompt (if set and non-empty).
2048 * If n>0 assumes that *linebuf has n bytes of default content */
2049 FL
int n_tty_readline(char const *prompt
, char **linebuf
,
2050 size_t *linesize
, size_t n SMALLOC_DEBUG_ARGS
);
2052 # define n_tty_readline(A,B,C,D) n_tty_readline(A, B, C, D, __FILE__, __LINE__)
2055 /* Add a line (most likely as returned by n_tty_readline()) to the history.
2056 * Wether an entry added for real depends on the isgabby / *history-gabby*
2057 * relation, and / or wether s is non-empty and doesn't begin with U+0020 */
2058 FL
void n_tty_addhist(char const *s
, bool_t isgabby
);
2061 FL
int c_history(void *v
);
2063 # define c_history c_cmdnotsupp
2070 /* URL en- and decoding according to (enough of) RFC 3986 (RFC 1738).
2071 * These return a newly salloc()ated result */
2072 FL
char * urlxenc(char const *cp
, bool_t ispath SALLOC_DEBUG_ARGS
);
2073 FL
char * urlxdec(char const *cp SALLOC_DEBUG_ARGS
);
2075 # define urlxenc(CP,P) urlxenc(CP, P, __FILE__, __LINE__)
2076 # define urlxdec(CP) urlxdec(CP, __FILE__, __LINE__)
2080 /* Return port of urlp->url_proto (and set irv_or_null), or NULL if unknown */
2081 FL
char const * url_servbyname(struct url
const *urlp
, ui16_t
*irv_or_null
);
2083 /* Parse data, which must meet the criteria of the protocol cproto, and fill
2084 * in the URL structure urlp (URL rather according to RFC 3986) */
2085 FL bool_t
url_parse(struct url
*urlp
, enum cproto cproto
,
2088 /* Zero ccp and lookup credentials for communicating with urlp.
2089 * Return wether credentials are available and valid (for chosen auth) */
2090 FL bool_t
ccred_lookup(struct ccred
*ccp
, struct url
*urlp
);
2091 FL bool_t
ccred_lookup_old(struct ccred
*ccp
, enum cproto cproto
,
2093 #endif /* HAVE_SOCKETS */
2097 FL
int c_netrc(void *v
);
2099 # define c_netrc c_cmdnotsupp
2102 /* MD5 (RFC 1321) related facilities */
2104 # ifdef HAVE_OPENSSL_MD5
2105 # define md5_ctx MD5_CTX
2106 # define md5_init MD5_Init
2107 # define md5_update MD5_Update
2108 # define md5_final MD5_Final
2110 /* The function definitions are instantiated in main.c */
2111 # include "rfc1321.h"
2114 /* Store the MD5 checksum as a hexadecimal string in *hex*, *not* terminated,
2115 * using lowercase ASCII letters as defined in RFC 2195 */
2116 # define MD5TOHEX_SIZE 32
2117 FL
char * md5tohex(char hex
[MD5TOHEX_SIZE
], void const *vp
);
2119 /* CRAM-MD5 encode the *user* / *pass* / *b64* combo */
2120 FL
char * cram_md5_string(struct str
const *user
, struct str
const *pass
,
2123 /* RFC 2104: HMAC: Keyed-Hashing for Message Authentication.
2124 * unsigned char *text: pointer to data stream
2125 * int text_len : length of data stream
2126 * unsigned char *key : pointer to authentication key
2127 * int key_len : length of authentication key
2128 * caddr_t digest : caller digest to be filled in */
2129 FL
void hmac_md5(unsigned char *text
, int text_len
, unsigned char *key
,
2130 int key_len
, void *digest
);
2131 #endif /* HAVE_MD5 */
2133 #ifndef HAVE_AMALGAMATION