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)
74 #define hexchar(c) /* TODO extend bits, add C_HEX */\
75 (__ischarof(c, C_DIGIT | C_OCTAL) || ((c) >= 'A' && (c) <= 'F') ||\
76 ((c) >= 'a' && (c) <= 'f'))
78 #define upperconv(c) (lowerchar(c) ? (char)((uc_i)(c) - 'a' + 'A') : (c))
79 #define lowerconv(c) (upperchar(c) ? (char)((uc_i)(c) - 'A' + 'a') : (c))
81 #define fieldnamechar(c) \
82 (asciichar(c) && (c) > 040 && (c) != 0177 && (c) != ':')
84 /* Could the string contain a regular expression? */
86 # define is_maybe_regex(S) anyof("^.[]*+?()|$", S)
88 # define is_maybe_regex(S) anyof("^[]*+?|$", S)
91 /* Try to use alloca() for some function-local buffers and data, fall back to
92 * smalloc()/free() if not available */
94 # define ac_alloc(n) HAVE_ALLOCA(n)
95 # define ac_free(n) do {UNUSED(n);} while (0)
97 # define ac_alloc(n) smalloc(n)
98 # define ac_free(n) free(n)
101 /* Single-threaded, use unlocked I/O */
102 #ifdef HAVE_PUTC_UNLOCKED
104 # define getc(c) getc_unlocked(c)
106 # define putc(c, f) putc_unlocked(c, f)
108 # define putchar(c) putc_unlocked((c), stdout)
111 /* Truncate a file to the last character written. This is useful just before
112 * closing an old file that was opened for read/write */
113 #define ftrunc(stream) \
117 off = ftell(stream);\
119 ftruncate(fileno(stream), off);\
122 /* fflush() and rewind() */
123 #define fflush_rewind(stream) \
129 /* There are problems with dup()ing of file-descriptors for child processes.
130 * As long as those are not fixed in equal spirit to (outof(): FIX and
131 * recode.., 2012-10-04), and to avoid reviving of bugs like (If *record* is
132 * set, avoid writing dead content twice.., 2012-09-14), we have to somehow
133 * accomplish that the FILE* fp makes itself comfortable with the *real* offset
134 * of the underlaying file descriptor. Unfortunately Standard I/O and POSIX
135 * don't describe a way for that -- fflush();rewind(); won't do it. This
136 * fseek(END),rewind() pair works around the problem on *BSD and Linux.
137 * Update as of 2014-03-03: with Issue 7 POSIX has overloaded fflush(3): if
138 * used on a readable stream, then
140 * if the file is not already at EOF, and the file is one capable of
141 * seeking, the file offset of the underlying open file description shall
142 * be set to the file position of the stream.
144 * We need our own, simplified and reliable I/O */
145 #if defined _POSIX_VERSION && _POSIX_VERSION + 0 >= 200809L
146 # define really_rewind(stream) \
152 # define really_rewind(stream) \
156 lseek(fileno(stream), 0, SEEK_SET);\
164 /* Don't use _var_* unless you *really* have to! */
166 /* Constant option key look/(un)set/clear */
167 FL
char * _var_oklook(enum okeys okey
);
168 #define ok_blook(C) (_var_oklook(CONCAT(ok_b_, C)) != NULL)
169 #define ok_vlook(C) _var_oklook(CONCAT(ok_v_, C))
171 FL bool_t
_var_okset(enum okeys okey
, uintptr_t val
);
172 #define ok_bset(C,B) _var_okset(CONCAT(ok_b_, C), (uintptr_t)(B))
173 #define ok_vset(C,V) _var_okset(CONCAT(ok_v_, C), (uintptr_t)(V))
175 FL bool_t
_var_okclear(enum okeys okey
);
176 #define ok_bclear(C) _var_okclear(CONCAT(ok_b_, C))
177 #define ok_vclear(C) _var_okclear(CONCAT(ok_v_, C))
179 /* Variable option key look/(un)set/clear */
180 FL
char * _var_voklook(char const *vokey
);
181 #define vok_blook(S) (_var_voklook(S) != NULL)
182 #define vok_vlook(S) _var_voklook(S)
184 FL bool_t
_var_vokset(char const *vokey
, uintptr_t val
);
185 #define vok_bset(S,B) _var_vokset(S, (uintptr_t)(B))
186 #define vok_vset(S,V) _var_vokset(S, (uintptr_t)(V))
188 FL bool_t
_var_vokclear(char const *vokey
);
189 #define vok_bclear(S) _var_vokclear(S)
190 #define vok_vclear(S) _var_vokclear(S)
192 /* Environment lookup, if envonly is TRU1 then variable must come from the
193 * process environment (and if via `setenv') */
194 FL
char * _env_look(char const *envkey
, bool_t envonly
);
195 #define env_blook(S,EXCL) (_env_look(S, EXCL) != NULL)
196 #define env_vlook(S,EXCL) _env_look(S, EXCL)
198 /* Special case to handle the typical [xy-USER@HOST,] xy-HOST and plain xy
199 * variable chains; oxm is a bitmix which tells which combinations to test */
201 FL
char * _var_xoklook(enum okeys okey
, struct url
const *urlp
,
202 enum okey_xlook_mode oxm
);
203 # define xok_BLOOK(C,URL,M) (_var_xoklook(C, URL, M) != NULL)
204 # define xok_VLOOK(C,URL,M) _var_xoklook(C, URL, M)
205 # define xok_blook(C,URL,M) xok_BLOOK(CONCAT(ok_b_, C), URL, M)
206 # define xok_vlook(C,URL,M) xok_VLOOK(CONCAT(ok_v_, C), URL, M)
210 FL
int c_varshow(void *v
);
212 /* User variable access: `set', `setenv', `unset' and `unsetenv' */
213 FL
int c_set(void *v
);
214 FL
int c_setenv(void *v
);
215 FL
int c_unset(void *v
);
216 FL
int c_unsetenv(void *v
);
218 /* Ditto: `varedit' */
219 FL
int c_varedit(void *v
);
221 /* Macros: `define', `undefine', `call' / `~' */
222 FL
int c_define(void *v
);
223 FL
int c_undefine(void *v
);
224 FL
int c_call(void *v
);
226 /* TODO Check wether a *folder-hook* exists for the currently active mailbox */
227 FL bool_t
check_folder_hook(bool_t nmail
);
229 /* TODO v15 drop Invoke compose hook macname */
230 FL
void call_compose_mode_hook(char const *macname
);
232 /* Accounts: `account', `unaccount' */
233 FL
int c_account(void *v
);
234 FL
int c_unaccount(void *v
);
237 FL
int c_localopts(void *v
);
239 FL
void temporary_localopts_free(void); /* XXX intermediate hack */
240 FL
void temporary_localopts_folder_hook_unroll(void); /* XXX im. hack */
246 /* Try to add an attachment for file, file_expand()ed.
247 * Return the new head of list aphead, or NULL.
248 * The newly created attachment will be stored in *newap, if given */
249 FL
struct attachment
* add_attachment(struct attachment
*aphead
, char *file
,
250 struct attachment
**newap
);
252 /* Append comma-separated list of file names to the end of attachment list */
253 FL
void append_attachments(struct attachment
**aphead
, char *names
);
255 /* Interactively edit the attachment list */
256 FL
void edit_attachments(struct attachment
**aphead
);
262 /* Touch the named message by setting its MTOUCH flag. Touched messages have
263 * the effect of not being sent back to the system mailbox on exit */
264 FL
void touch(struct message
*mp
);
266 /* Test to see if the passed file name is a directory, return true if it is */
267 FL bool_t
is_dir(char const *name
);
269 /* Count the number of arguments in the given string raw list */
270 FL
int argcount(char **argv
);
272 /* Compute screen size */
273 FL
int screensize(void);
275 /* Get our $PAGER; if env_addon is not NULL it is checked wether we know about
276 * some environment variable that supports colour+ and set *env_addon to that,
277 * e.g., "LESS=FRSXi" */
278 FL
char const *get_pager(char const **env_addon
);
280 /* Use a pager or STDOUT to print *fp*; if *lines* is 0, they'll be counted */
281 FL
void page_or_print(FILE *fp
, size_t lines
);
283 /* Parse name and guess at the required protocol */
284 FL
enum protocol
which_protocol(char const *name
);
286 /* Hash the passed string -- uses Chris Torek's hash algorithm */
287 FL ui32_t
torek_hash(char const *name
);
288 #define hash(S) (torek_hash(S) % HSHSIZE) /* xxx COMPAT (?) */
291 FL ui32_t
pjw(char const *cp
); /* TODO obsolete -> torek_hash() */
293 /* Find a prime greater than n */
294 FL ui32_t
nextprime(ui32_t n
);
296 /* (Try to) Expand ^~/? and ^~USER/? constructs.
297 * Returns the completely resolved (maybe empty or identical to input)
298 * salloc()ed string */
299 FL
char * n_shell_expand_tilde(char const *s
, bool_t
*err_or_null
);
301 /* (Try to) Expand any shell variable in s, allowing backslash escaping
302 * (of any following character) with bsescape.
303 * Returns the completely resolved (maybe empty) salloc()ed string.
305 FL
char * n_shell_expand_var(char const *s
, bool_t bsescape
,
306 bool_t
*err_or_null
);
308 /* Check wether *s is an escape sequence, expand it as necessary.
309 * Returns the expanded sequence or 0 if **s is NUL or PROMPT_STOP if it is \c.
310 * *s is advanced to after the expanded sequence (as possible).
311 * If use_prompt_extensions is set, an enum prompt_exp may be returned */
312 FL
int n_shell_expand_escape(char const **s
,
313 bool_t use_prompt_extensions
);
315 /* Get *prompt*, or '& ' if *bsdcompat*, of '? ' otherwise */
316 FL
char * getprompt(void);
318 /* Detect and query the hostname to use */
319 FL
char * nodename(int mayoverride
);
321 /* Get a (pseudo) random string of *length* bytes; returns salloc()ed buffer */
322 FL
char * getrandstring(size_t length
);
324 FL
enum okay
makedir(char const *name
);
326 /* A get-wd..restore-wd approach */
327 FL
enum okay
cwget(struct cw
*cw
);
328 FL
enum okay
cwret(struct cw
*cw
);
329 FL
void cwrelse(struct cw
*cw
);
331 /* Detect visual width of (blen bytes of) buf, return (size_t)-1 on error.
332 * Give blen UIZ_MAX to strlen(). buf may be NULL if (final) blen is 0 */
333 FL
size_t field_detect_width(char const *buf
, size_t blen
);
335 /* Check (multibyte-safe) how many bytes of buf (which is blen byts) can be
336 * safely placed in a buffer (field width) of maxlen bytes */
337 FL
size_t field_detect_clip(size_t maxlen
, char const *buf
, size_t blen
);
339 /* Put maximally maxlen bytes of buf, a buffer of blen bytes, into store,
340 * taking into account multibyte code point boundaries and possibly
341 * encapsulating in bidi_info toggles as necessary */
342 FL
size_t field_put_bidi_clip(char *store
, size_t maxlen
, char const *buf
,
345 /* Place cp in a salloc()ed buffer, column-aligned; for header display only */
346 FL
char * colalign(char const *cp
, int col
, int fill
,
347 int *cols_decr_used_or_null
);
349 /* Convert a string to a displayable one;
350 * prstr() returns the result savestr()d, prout() writes it */
351 FL
void makeprint(struct str
const *in
, struct str
*out
);
352 FL
size_t delctrl(char *cp
, size_t len
);
353 FL
char * prstr(char const *s
);
354 FL
int prout(char const *s
, size_t sz
, FILE *fp
);
356 /* Print out a Unicode character or a substitute for it, return 0 on error or
357 * wcwidth() (or 1) on success */
358 FL
size_t putuc(int u
, int c
, FILE *fp
);
360 /* Check wether bidirectional info maybe needed for blen bytes of bdat */
361 FL bool_t
bidi_info_needed(char const *bdat
, size_t blen
);
363 /* Create bidirectional text encapsulation information; without HAVE_NATCH_CHAR
364 * the strings are always empty */
365 FL
void bidi_info_create(struct bidi_info
*bip
);
367 /* Check wether the argument string is a true (1) or false (0) boolean, or an
368 * invalid string, in which case -1 is returned; if emptyrv is not -1 then it,
369 * treated as a boolean, is used as the return value shall inbuf be empty.
370 * inlen may be UIZ_MAX to force strlen() detection */
371 FL si8_t
boolify(char const *inbuf
, uiz_t inlen
, si8_t emptyrv
);
373 /* Dig a "quadoption" in inbuf (possibly going through getapproval() in
374 * interactive mode). Returns a boolean or -1 if inbuf content is invalid;
375 * if emptyrv is not -1 then it, treated as a boolean, is used as the return
376 * value shall inbuf be empty. If prompt is set it is printed first if intera.
377 * inlen may be UIZ_MAX to force strlen() detection */
378 FL si8_t
quadify(char const *inbuf
, uiz_t inlen
, char const *prompt
,
381 /* Is the argument "all" (case-insensitive) or "*" */
382 FL bool_t
n_is_all_or_aster(char const *name
);
384 /* Get seconds since epoch */
385 FL
time_t n_time_epoch(void);
387 /* Update *tc* to now; only .tc_time updated unless *full_update* is true */
388 FL
void time_current_update(struct time_current
*tc
,
391 /* Returns 0 if fully slept, number of millis left if ignint is true and we
392 * were interrupted. Actual resolution may be second or less.
393 * Note in case of HAVE_SLEEP this may be SIGALARM based. */
394 FL uiz_t
n_msleep(uiz_t millis
, bool_t ignint
);
396 /* Our error print series.. Note: these reverse scan format in order to know
397 * wether a newline was included or not -- this affects the output! */
398 FL
void n_err(char const *format
, ...);
399 FL
void n_verr(char const *format
, va_list ap
);
401 /* ..(for use in a signal handler; to be obsoleted..).. */
402 FL
void n_err_sighdl(char const *format
, ...);
404 /* Our perror(3); if errval is 0 errno(3) is used; newline appended */
405 FL
void n_perr(char const *msg
, int errval
);
407 /* Announce a fatal error (and die); newline appended */
408 FL
void n_alert(char const *format
, ...);
409 FL
void n_panic(char const *format
, ...);
413 FL
int c_errors(void *vp
);
415 # define c_errors c_cmdnotsupp
418 /* Memory allocation routines */
420 # define SMALLOC_DEBUG_ARGS , char const *mdbg_file, int mdbg_line
421 # define SMALLOC_DEBUG_ARGSCALL , mdbg_file, mdbg_line
423 # define SMALLOC_DEBUG_ARGS
424 # define SMALLOC_DEBUG_ARGSCALL
427 FL
void * smalloc(size_t s SMALLOC_DEBUG_ARGS
);
428 FL
void * srealloc(void *v
, size_t s SMALLOC_DEBUG_ARGS
);
429 FL
void * scalloc(size_t nmemb
, size_t size SMALLOC_DEBUG_ARGS
);
432 FL
void sfree(void *v SMALLOC_DEBUG_ARGS
);
433 /* Called by sreset(), then */
434 FL
void smemreset(void);
436 FL
int c_smemtrace(void *v
);
437 /* For immediate debugging purposes, it is possible to check on request */
438 FL bool_t
_smemcheck(char const *file
, int line
);
440 # define smalloc(SZ) smalloc(SZ, __FILE__, __LINE__)
441 # define srealloc(P,SZ) srealloc(P, SZ, __FILE__, __LINE__)
442 # define scalloc(N,SZ) scalloc(N, SZ, __FILE__, __LINE__)
443 # define free(P) sfree(P, __FILE__, __LINE__)
444 # define smemcheck() _smemcheck(__FILE__, __LINE__)
451 FL
int c_cmdnotsupp(void *v
);
453 /* `headers' (show header group, possibly after setting dot) */
454 FL
int c_headers(void *v
);
456 /* Like c_headers(), but pre-prepared message vector */
457 FL
int print_header_group(int *vector
);
459 /* Scroll to the next/previous screen */
460 FL
int c_scroll(void *v
);
461 FL
int c_Scroll(void *v
);
463 /* Print out the headlines for each message in the passed message list */
464 FL
int c_from(void *v
);
466 /* Print all message in between and including bottom and topx if they are
467 * visible and either only_marked is false or they are MMARKed */
468 FL
void print_headers(size_t bottom
, size_t topx
, bool_t only_marked
);
470 /* Print out the value of dot */
471 FL
int c_pdot(void *v
);
473 /* Paginate messages, honor/don't honour ignored fields, respectively */
474 FL
int c_more(void *v
);
475 FL
int c_More(void *v
);
477 /* Type out messages, honor/don't honour ignored fields, respectively */
478 FL
int c_type(void *v
);
479 FL
int c_Type(void *v
);
481 /* Show MIME-encoded message text, including all fields */
482 FL
int c_show(void *v
);
484 /* Pipe messages, honor/don't honour ignored fields, respectively */
485 FL
int c_pipe(void *v
);
486 FL
int c_Pipe(void *v
);
488 /* Print the top so many lines of each desired message.
489 * The number of lines is taken from *toplines* and defaults to 5 */
490 FL
int c_top(void *v
);
492 /* Touch all the given messages so that they will get mboxed */
493 FL
int c_stouch(void *v
);
495 /* Make sure all passed messages get mboxed */
496 FL
int c_mboxit(void *v
);
498 /* List the folders the user currently has */
499 FL
int c_folders(void *v
);
505 /* If any arguments were given, go to the next applicable argument following
506 * dot, otherwise, go to the next applicable message. If given as first
507 * command with no arguments, print first message */
508 FL
int c_next(void *v
);
510 /* Move the dot up or down by one message */
511 FL
int c_dotmove(void *v
);
513 /* Save a message in a file. Mark the message as saved so we can discard when
515 FL
int c_save(void *v
);
516 FL
int c_Save(void *v
);
518 /* Copy a message to a file without affected its saved-ness */
519 FL
int c_copy(void *v
);
520 FL
int c_Copy(void *v
);
522 /* Move a message to a file */
523 FL
int c_move(void *v
);
524 FL
int c_Move(void *v
);
526 /* Decrypt and copy a message to a file */
527 FL
int c_decrypt(void *v
);
528 FL
int c_Decrypt(void *v
);
530 /* Write the indicated messages at the end of the passed file name, minus
531 * header and trailing blank line. This is the MIME save function */
532 FL
int c_write(void *v
);
534 /* Delete messages */
535 FL
int c_delete(void *v
);
537 /* Delete messages, then type the new dot */
538 FL
int c_deltype(void *v
);
540 /* Undelete the indicated messages */
541 FL
int c_undelete(void *v
);
543 /* Add the given header fields to the retained list. If no arguments, print
544 * the current list of retained fields */
545 FL
int c_retfield(void *v
);
547 /* Add the given header fields to the ignored list. If no arguments, print the
548 * current list of ignored fields */
549 FL
int c_igfield(void *v
);
551 FL
int c_saveretfield(void *v
);
552 FL
int c_saveigfield(void *v
);
553 FL
int c_fwdretfield(void *v
);
554 FL
int c_fwdigfield(void *v
);
555 FL
int c_unignore(void *v
);
556 FL
int c_unretain(void *v
);
557 FL
int c_unsaveignore(void *v
);
558 FL
int c_unsaveretain(void *v
);
559 FL
int c_unfwdignore(void *v
);
560 FL
int c_unfwdretain(void *v
);
566 /* Process a shell escape by saving signals, ignoring signals and a sh -c */
567 FL
int c_shell(void *v
);
569 /* Fork an interactive shell */
570 FL
int c_dosh(void *v
);
572 /* Show the help screen */
573 FL
int c_help(void *v
);
575 /* Print user's working directory */
576 FL
int c_cwd(void *v
);
578 /* Change user's working directory */
579 FL
int c_chdir(void *v
);
581 /* All thinkable sorts of `reply' / `respond' and `followup'.. */
582 FL
int c_reply(void *v
);
583 FL
int c_replyall(void *v
);
584 FL
int c_replysender(void *v
);
585 FL
int c_Reply(void *v
);
586 FL
int c_followup(void *v
);
587 FL
int c_followupall(void *v
);
588 FL
int c_followupsender(void *v
);
589 FL
int c_Followup(void *v
);
591 /* ..and a mailing-list reply */
592 FL
int c_Lreply(void *v
);
594 /* The 'forward' command */
595 FL
int c_forward(void *v
);
597 /* Similar to forward, saving the message in a file named after the first
599 FL
int c_Forward(void *v
);
601 /* Resend a message list to a third person */
602 FL
int c_resend(void *v
);
604 /* Resend a message list to a third person without adding headers */
605 FL
int c_Resend(void *v
);
607 /* Preserve messages, so that they will be sent back to the system mailbox */
608 FL
int c_preserve(void *v
);
610 /* Mark all given messages as unread */
611 FL
int c_unread(void *v
);
613 /* Mark all given messages as read */
614 FL
int c_seen(void *v
);
616 /* Print the size of each message */
617 FL
int c_messize(void *v
);
619 /* `file' (`folder') and `File' (`Folder') */
620 FL
int c_file(void *v
);
621 FL
int c_File(void *v
);
623 /* Expand file names like echo */
624 FL
int c_echo(void *v
);
626 /* 'newmail' command: Check for new mail without writing old mail back */
627 FL
int c_newmail(void *v
);
629 /* Message flag manipulation */
630 FL
int c_flag(void *v
);
631 FL
int c_unflag(void *v
);
632 FL
int c_answered(void *v
);
633 FL
int c_unanswered(void *v
);
634 FL
int c_draft(void *v
);
635 FL
int c_undraft(void *v
);
638 FL
int c_noop(void *v
);
641 FL
int c_remove(void *v
);
644 FL
int c_rename(void *v
);
646 /* `urlencode' and `urldecode' */
647 FL
int c_urlencode(void *v
);
648 FL
int c_urldecode(void *v
);
654 /* if.elif.else.endif conditional execution.
655 * condstack_isskip() returns wether the current condition state doesn't allow
656 * execution of commands.
657 * condstack_release() and condstack_take() are used when PS_SOURCING files, they
658 * rotate the current condition stack; condstack_take() returns a false boolean
659 * if the current condition stack has unclosed conditionals */
660 FL
int c_if(void *v
);
661 FL
int c_elif(void *v
);
662 FL
int c_else(void *v
);
663 FL
int c_endif(void *v
);
664 FL bool_t
condstack_isskip(void);
665 FL
void * condstack_release(void);
666 FL bool_t
condstack_take(void *self
);
673 * If quotefile is (char*)-1, stdin will be used, caller has to verify that
674 * we're not running in interactive mode */
675 FL
FILE * collect(struct header
*hp
, int printheaders
, struct message
*mp
,
676 char *quotefile
, int doprefix
, si8_t
*checkaddr_err
);
678 FL
void savedeadletter(FILE *fp
, int fflush_rewind_first
);
684 /* Edit a message list */
685 FL
int c_editor(void *v
);
687 /* Invoke the visual editor on a message list */
688 FL
int c_visual(void *v
);
690 /* Run an editor on either size bytes of the file fp (or until EOF if size is
691 * negative) or on the message mp, and return a new file or NULL on error of if
692 * the user didn't perform any edits.
693 * For now we assert that mp==NULL if hp!=NULL, treating this as a special call
694 * from within compose mode, and giving TRUM1 to puthead().
695 * Signals must be handled by the caller. viored is 'e' for ed, 'v' for vi */
696 FL
FILE * run_editor(FILE *fp
, off_t size
, int viored
, int readonly
,
697 struct header
*hp
, struct message
*mp
,
698 enum sendaction action
, sighandler_type oldint
);
706 FL
int c_colour(void *v
);
707 FL
int c_uncolour(void *v
);
709 /* We want coloured output (in this salloc() cycle). pager_used is used to
710 * test wether *colour-pager* is to be inspected.
711 * The push/pop functions deal with recursive execute()ions, for now. TODO
712 * env_gut() will reset() as necessary */
713 FL
void n_colour_env_create(enum n_colour_ctx cctx
, bool_t pager_used
);
714 FL
void n_colour_env_push(void);
715 FL
void n_colour_env_pop(bool_t any_env_till_root
);
716 FL
void n_colour_env_gut(FILE *fp
);
718 /* Putting anything (for pens: including NULL) resets current state first */
719 FL
void n_colour_put(FILE *fp
, enum n_colour_id cid
, char const *ctag
);
720 FL
void n_colour_reset(FILE *fp
);
722 /* Of course temporary only and may return NULL. Doesn't affect state! */
723 FL
struct str
const *n_colour_reset_to_str(void);
725 /* A pen is bound to its environment and automatically reclaimed; it may be
726 * NULL but that can be used anyway for simplicity.
727 * This includes pen_to_str() -- which doesn't affect state! */
728 FL
struct n_colour_pen
*n_colour_pen_create(enum n_colour_id cid
,
730 FL
void n_colour_pen_put(struct n_colour_pen
*self
, FILE *fp
);
732 FL
struct str
const *n_colour_pen_to_str(struct n_colour_pen
*self
);
734 #else /* HAVE_COLOUR */
735 # define c_colour c_cmdnotsupp
736 # define c_uncolour c_cmdnotsupp
737 # define c_mono c_cmdnotsupp
738 # define c_unmono c_cmdnotsupp
746 FL
struct quoteflt
* quoteflt_dummy(void); /* TODO LEGACY */
747 FL
void quoteflt_init(struct quoteflt
*self
, char const *prefix
);
748 FL
void quoteflt_destroy(struct quoteflt
*self
);
749 FL
void quoteflt_reset(struct quoteflt
*self
, FILE *f
);
750 FL ssize_t
quoteflt_push(struct quoteflt
*self
, char const *dat
,
752 FL ssize_t
quoteflt_flush(struct quoteflt
*self
);
754 /* (Primitive) HTML tagsoup filter */
755 #ifdef HAVE_FILTER_HTML_TAGSOUP
756 /* TODO Because we don't support filter chains yet this filter will be run
757 * TODO in a dedicated subprocess, driven via a special Popen() mode */
758 FL
int htmlflt_process_main(void);
760 FL
void htmlflt_init(struct htmlflt
*self
);
761 FL
void htmlflt_destroy(struct htmlflt
*self
);
762 FL
void htmlflt_reset(struct htmlflt
*self
, FILE *f
);
763 FL ssize_t
htmlflt_push(struct htmlflt
*self
, char const *dat
, size_t len
);
764 FL ssize_t
htmlflt_flush(struct htmlflt
*self
);
771 /* fgets() replacement to handle lines of arbitrary size and with embedded \0
773 * line - line buffer. *line may be NULL.
774 * linesize - allocated size of line buffer.
775 * count - maximum characters to read. May be NULL.
776 * llen - length_of_line(*line).
778 * appendnl - always terminate line with \n, append if necessary.
780 FL
char * fgetline(char **line
, size_t *linesize
, size_t *count
,
781 size_t *llen
, FILE *fp
, int appendnl SMALLOC_DEBUG_ARGS
);
783 # define fgetline(A,B,C,D,E,F) \
784 fgetline(A, B, C, D, E, F, __FILE__, __LINE__)
787 /* Read up a line from the specified input into the linebuffer.
788 * Return the number of characters read. Do not include the newline at EOL.
789 * n is the number of characters already read */
790 FL
int readline_restart(FILE *ibuf
, char **linebuf
, size_t *linesize
,
791 size_t n SMALLOC_DEBUG_ARGS
);
793 # define readline_restart(A,B,C,D) \
794 readline_restart(A, B, C, D, __FILE__, __LINE__)
797 /* Read a complete line of input, with editing if interactive and possible.
798 * If prompt is NULL we'll call getprompt() first, if necessary.
799 * nl_escape defines wether user can escape newlines via backslash (POSIX).
800 * If string is set it is used as the initial line content if in interactive
801 * mode, otherwise this argument is ignored for reproducibility.
802 * Return number of octets or a value <0 on error.
803 * Note: may use the currently `source'd file stream instead of stdin! */
804 FL
int readline_input(char const *prompt
, bool_t nl_escape
,
805 char **linebuf
, size_t *linesize
, char const *string
808 # define readline_input(A,B,C,D,E) readline_input(A,B,C,D,E,__FILE__,__LINE__)
811 /* Read a line of input, with editing if interactive and possible, return it
812 * savestr()d or NULL in case of errors or if an empty line would be returned.
813 * This may only be called from toplevel (not during PS_SOURCING).
814 * If prompt is NULL we'll call getprompt() if necessary.
815 * If string is set it is used as the initial line content if in interactive
816 * mode, otherwise this argument is ignored for reproducibility.
817 * If OPT_INTERACTIVE a non-empty return is saved in the history, isgabby */
818 FL
char * n_input_cp_addhist(char const *prompt
, char const *string
,
821 /* Set up the input pointers while copying the mail file into /tmp */
822 FL
void setptr(FILE *ibuf
, off_t offset
);
824 /* Drop the passed line onto the passed output buffer. If a write error occurs
825 * return -1, else the count of characters written, including the newline */
826 FL
int putline(FILE *obuf
, char *linebuf
, size_t count
);
828 /* Return a file buffer all ready to read up the passed message pointer */
829 FL
FILE * setinput(struct mailbox
*mp
, struct message
*m
,
832 /* Reset (free) the global message array */
833 FL
void message_reset(void);
835 /* Append the passed message descriptor onto the message array; if mp is NULL,
836 * NULLify the entry at &[msgCount-1] */
837 FL
void message_append(struct message
*mp
);
839 /* Check wether sep->ss_sexpr (or ->ss_regex) matches mp. If with_headers is
840 * true then the headers will also be searched (as plain text) */
841 FL bool_t
message_match(struct message
*mp
, struct search_expr
const *sep
,
842 bool_t with_headers
);
844 FL
struct message
* setdot(struct message
*mp
);
846 /* Delete a file, but only if the file is a plain file */
847 FL
int rm(char const *name
);
849 /* Determine the size of the file possessed by the passed buffer */
850 FL off_t
fsize(FILE *iob
);
852 /* Evaluate the string given as a new mailbox name. Supported meta characters:
853 * . % for my system mail box
854 * . %user for user's system mail box
855 * . # for previous file
856 * . & invoker's mbox file
857 * . +file file in folder directory
858 * . any shell meta character (except for FEXP_NSHELL).
859 * If FEXP_NSHELL is set you possibly want to call fexpand_nshell_quote(),
860 * a poor man's vis(3), on name before calling this (and showing the user).
861 * Returns the file name as an auto-reclaimed string */
862 FL
char * fexpand(char const *name
, enum fexp_mode fexpm
);
864 #define expand(N) fexpand(N, FEXP_FULL) /* XXX obsolete */
865 #define file_expand(N) fexpand(N, FEXP_LOCAL) /* XXX obsolete */
867 /* A poor man's vis(3) for only backslash escaping as for FEXP_NSHELL.
868 * Returns the (possibly adjusted) buffer in auto-reclaimed storage */
869 FL
char * fexpand_nshell_quote(char const *name
);
871 /* accmacvar.c hook: *folder* variable has been updated; if folder shouldn't
872 * be replaced by something else leave store alone, otherwise smalloc() the
873 * desired value (ownership will be taken) */
874 FL bool_t
var_folder_updated(char const *folder
, char **store
);
876 /* Determine the current *folder* name, store it in *name* */
877 FL bool_t
getfold(char *name
, size_t size
);
879 /* Return the name of the dead.letter file */
880 FL
char const * getdeadletter(void);
882 FL
enum okay
get_body(struct message
*mp
);
886 /* Will retry FILE_LOCK_RETRIES times if pollmsecs > 0 */
887 FL bool_t
file_lock(int fd
, enum file_lock_type flt
, off_t off
, off_t len
,
890 /* Aquire a flt lock and create a dotlock file; upon success a registered
891 * control-pipe FILE* is returned that keeps the link in between us and the
892 * lock-holding fork(2)ed subprocess (which conditionally replaced itself via
893 * execv(2) with the privilege-separated dotlock helper program): the lock file
894 * will be removed once the control pipe is closed via Pclose().
895 * Will try FILE_LOCK_TRIES times if pollmsecs > 0 (once otherwise).
896 * If *dotlock_ignore_error* is set (FILE*)-1 will be returned if at least the
897 * normal file lock could be established, otherwise errno is usable on error */
898 FL
FILE * dot_lock(char const *fname
, int fd
, enum file_lock_type flt
,
899 off_t off
, off_t len
, size_t pollmsecs
);
903 FL bool_t
sopen(struct sock
*sp
, struct url
*urlp
);
904 FL
int sclose(struct sock
*sp
);
905 FL
enum okay
swrite(struct sock
*sp
, char const *data
);
906 FL
enum okay
swrite1(struct sock
*sp
, char const *data
, int sz
,
910 FL
int sgetline(char **line
, size_t *linesize
, size_t *linelen
,
911 struct sock
*sp SMALLOC_DEBUG_ARGS
);
913 # define sgetline(A,B,C,D) sgetline(A, B, C, D, __FILE__, __LINE__)
915 #endif /* HAVE_SOCKETS */
917 /* Deal with loading of resource files and dealing with a stack of files for
918 * the source command */
920 /* Load a file of user definitions -- this is *only* for main()! */
921 FL
void load(char const *name
);
923 /* Pushdown current input file and switch to a new one. Set the global flag
924 * PS_SOURCING so that others will realize that they are no longer reading from
925 * a tty (in all probability).
926 * The latter won't return failure (TODO should be replaced by "-f FILE") */
927 FL
int c_source(void *v
);
928 FL
int c_source_if(void *v
);
930 /* Pop the current input back to the previous level. Update the PS_SOURCING
931 * flag as appropriate */
932 FL
int unstack(void);
938 /* Return the user's From: address(es) */
939 FL
char const * myaddrs(struct header
*hp
);
941 /* Boil the user's From: addresses down to a single one, or use *sender* */
942 FL
char const * myorigin(struct header
*hp
);
944 /* See if the passed line buffer, which may include trailing newline (sequence)
945 * is a mail From_ header line according to RFC 4155.
946 * If compat is true laxe POSIX syntax is instead sufficient to match From_ */
947 FL
int is_head(char const *linebuf
, size_t linelen
, bool_t compat
);
949 /* Savage extract date field from From_ line. linelen is convenience as line
950 * must be terminated (but it may end in a newline [sequence]).
951 * Return wether the From_ line was parsed successfully */
952 FL
int extract_date_from_from_(char const *line
, size_t linelen
,
953 char datebuf
[FROM_DATEBUF
]);
955 /* Extract some header fields (see e.g. -t documentation) from a message.
956 * If options&OPT_t_FLAG *and* pstate&PS_t_FLAG are both set a number of
957 * additional header fields are understood and address joining is performed as
958 * necessary, and the subject is treated with additional care, too.
959 * If pstate&PS_t_FLAG is set but OPT_t_FLAG is no more, From: will not be
961 * This calls expandaddr() on some headers and sets checkaddr_err if that is
962 * not NULL -- note it explicitly allows EAF_NAME because aliases are not
963 * expanded when this is called! */
964 FL
void extract_header(FILE *fp
, struct header
*hp
,
965 si8_t
*checkaddr_err
);
967 /* Return the desired header line from the passed message
968 * pointer (or NULL if the desired header field is not available).
969 * If mult is zero, return the content of the first matching header
970 * field only, the content of all matching header fields else */
971 FL
char * hfield_mult(char const *field
, struct message
*mp
, int mult
);
972 #define hfieldX(a, b) hfield_mult(a, b, 1)
973 #define hfield1(a, b) hfield_mult(a, b, 0)
975 /* Check whether the passed line is a header line of the desired breed.
976 * Return the field body, or 0 */
977 FL
char const * thisfield(char const *linebuf
, char const *field
);
979 /* Get sender's name from this message. If the message has a bunch of arpanet
980 * stuff in it, we may have to skin the name before returning it */
981 FL
char * nameof(struct message
*mp
, int reptype
);
983 /* Start of a "comment". Ignore it */
984 FL
char const * skip_comment(char const *cp
);
986 /* Return the start of a route-addr (address in angle brackets), if present */
987 FL
char const * routeaddr(char const *name
);
989 /* Query *expandaddr*, parse it and return flags.
990 * The flags are already adjusted for OPT_INTERACTIVE / OPT_TILDE_FLAG etc. */
991 FL
enum expand_addr_flags
expandaddr_to_eaf(void);
993 /* Check if an address is invalid, either because it is malformed or, if not,
994 * according to eacm. Return FAL0 when it looks good, TRU1 if it is invalid
995 * but the error condition wasn't covered by a 'hard "fail"ure', -1 otherwise */
996 FL si8_t
is_addr_invalid(struct name
*np
,
997 enum expand_addr_check_mode eacm
);
999 /* Does *NP* point to a file or pipe addressee? */
1000 #define is_fileorpipe_addr(NP) \
1001 (((NP)->n_flags & NAME_ADDRSPEC_ISFILEORPIPE) != 0)
1003 /* Return skinned version of *NP*s name */
1004 #define skinned_name(NP) \
1005 (assert((NP)->n_flags & NAME_SKINNED), \
1006 ((struct name const*)NP)->n_name)
1008 /* Skin an address according to the RFC 822 interpretation of "host-phrase" */
1009 FL
char * skin(char const *name
);
1011 /* Skin *name* and extract the *addr-spec* according to RFC 5322.
1012 * Store the result in .ag_skinned and also fill in those .ag_ fields that have
1013 * actually been seen.
1014 * Return 0 if something good has been parsed, 1 if fun didn't exactly know how
1015 * to deal with the input, or if that was plain invalid */
1016 FL
int addrspec_with_guts(int doskin
, char const *name
,
1017 struct addrguts
*agp
);
1019 /* Fetch the real name from an internet mail address field */
1020 FL
char * realname(char const *name
);
1022 /* Fetch the sender's name from the passed message. reptype can be
1023 * 0 -- get sender's name for display purposes
1024 * 1 -- get sender's name for reply
1025 * 2 -- get sender's name for Reply */
1026 FL
char * name1(struct message
*mp
, int reptype
);
1028 /* Trim away all leading Re: etc., return pointer to plain subject.
1029 * Note it doesn't perform any MIME decoding by itself */
1030 FL
char * subject_re_trim(char *cp
);
1032 FL
int msgidcmp(char const *s1
, char const *s2
);
1034 /* See if the given header field is supposed to be ignored */
1035 FL
int is_ign(char const *field
, size_t fieldlen
,
1036 struct ignoretab igta
[2]);
1038 FL
int member(char const *realfield
, struct ignoretab
*table
);
1040 /* Fake Sender for From_ lines if missing, e. g. with POP3 */
1041 FL
char const * fakefrom(struct message
*mp
);
1043 FL
char const * fakedate(time_t t
);
1045 /* From username Fri Jan 2 20:13:51 2004
1048 #ifdef HAVE_IMAP_SEARCH
1049 FL
time_t unixtime(char const *from
);
1052 FL
time_t rfctime(char const *date
);
1054 FL
time_t combinetime(int year
, int month
, int day
,
1055 int hour
, int minute
, int second
);
1057 FL
void substdate(struct message
*m
);
1059 /* TODO Weird thing that tries to fill in From: and Sender: */
1060 FL
void setup_from_and_sender(struct header
*hp
);
1062 /* Note: returns 0x1 if both args were NULL */
1063 FL
struct name
const * check_from_and_sender(struct name
const *fromfield
,
1064 struct name
const *senderfield
);
1067 FL
char * getsender(struct message
*m
);
1070 /* Fill in / reedit the desired header fields */
1071 FL
int grab_headers(struct header
*hp
, enum gfield gflags
,
1074 /* Check wether sep->ss_sexpr (or ->ss_regex) matches any header of mp */
1075 FL bool_t
header_match(struct message
*mp
, struct search_expr
const *sep
);
1081 #ifdef HAVE_IMAP_SEARCH
1082 FL
enum okay
imap_search(char const *spec
, int f
);
1089 /* Set up editing on the given file name.
1090 * If the first character of name is %, we are considered to be editing the
1091 * file, otherwise we are reading our mail which has signficance for mbox and
1093 nmail: Check for new mail in the current folder only */
1094 FL
int setfile(char const *name
, enum fedit_mode fm
);
1096 FL
int newmailinfo(int omsgCount
);
1098 /* Interpret user commands. If standard input is not a tty, print no prompt;
1099 * return wether the last processed command returned error */
1100 FL bool_t
commands(void);
1102 /* TODO drop execute() is the legacy version of evaluate().
1103 * It assumes we've been invoked recursively */
1104 FL
int execute(char *linebuf
, size_t linesize
);
1106 /* Evaluate a single command.
1107 * .ev_add_history and .ev_new_content will be updated upon success.
1108 * Command functions return 0 for success, 1 for error, and -1 for abort.
1109 * 1 or -1 aborts a load or source, a -1 aborts the interactive command loop */
1110 FL
int evaluate(struct eval_ctx
*evp
);
1112 /* Set the size of the message vector used to construct argument lists to
1113 * message list functions */
1114 FL
void setmsize(int sz
);
1116 /* Logic behind -H / -L invocations */
1117 FL
void print_header_summary(char const *Larg
);
1119 /* The following gets called on receipt of an interrupt. This is to abort
1120 * printout of a command, mainly. Dispatching here when command() is inactive
1121 * crashes rcv. Close all open files except 0, 1, 2, and the temporary. Also,
1122 * unstack all source files */
1123 FL
void onintr(int s
);
1125 /* Announce the presence of the current Mail version, give the message count,
1126 * and print a header listing */
1127 FL
void announce(int printheaders
);
1129 /* Announce information about the file we are editing. Return a likely place
1131 FL
int newfileinfo(void);
1133 FL
int getmdot(int nmail
);
1135 FL
void initbox(char const *name
);
1137 /* Print the docstring of `comm', which may be an abbreviation.
1138 * Return FAL0 if there is no such command */
1139 #ifdef HAVE_DOCSTRINGS
1140 FL bool_t
print_comm_docstr(char const *comm
);
1147 /* Convert user string of message numbers and store the numbers into vector.
1148 * Returns the count of messages picked up or -1 on error */
1149 FL
int getmsglist(char *buf
, int *vector
, int flags
);
1151 /* Scan out the list of string arguments, shell style for a RAWLIST */
1152 FL
int getrawlist(char const *line
, size_t linesize
,
1153 char **argv
, int argc
, int echolist
);
1155 /* Find the first message whose flags&m==f and return its message number */
1156 FL
int first(int f
, int m
);
1158 /* Mark the named message by setting its mark bit */
1159 FL
void mark(int mesg
, int f
);
1165 FL
int maildir_setfile(char const *name
, enum fedit_mode fm
);
1167 FL
void maildir_quit(void);
1169 FL
enum okay
maildir_append(char const *name
, FILE *fp
, long offset
);
1171 FL
enum okay
maildir_remove(char const *name
);
1177 /* Quit quickly. If PS_SOURCING, just pop the input level by returning error */
1178 FL
int c_rexit(void *v
);
1184 /* *charset-7bit*, else CHARSET_7BIT */
1185 FL
char const * charset_get_7bit(void);
1187 /* *charset-8bit*, else CHARSET_8BIT */
1189 FL
char const * charset_get_8bit(void);
1192 /* LC_CTYPE:CODESET / *ttycharset*, else *charset-8bit*, else CHARSET_8BIT */
1193 FL
char const * charset_get_lc(void);
1195 /* *sendcharsets* .. *charset-8bit* iterator; *a_charset_to_try_first* may be
1196 * used to prepend a charset to this list (e.g., for *reply-in-same-charset*).
1197 * The returned boolean indicates charset_iter_is_valid().
1198 * Without HAVE_ICONV, this "iterates" over charset_get_lc() only */
1199 FL bool_t
charset_iter_reset(char const *a_charset_to_try_first
);
1200 FL bool_t
charset_iter_next(void);
1201 FL bool_t
charset_iter_is_valid(void);
1202 FL
char const * charset_iter(void);
1204 /* And this is (xxx temporary?) which returns the iterator if that is valid and
1205 * otherwise either charset_get_8bit() or charset_get_lc() dep. on HAVE_ICONV */
1206 FL
char const * charset_iter_or_fallback(void);
1208 FL
void charset_iter_recurse(char *outer_storage
[2]); /* TODO LEGACY */
1209 FL
void charset_iter_restore(char *outer_storage
[2]); /* TODO LEGACY */
1211 /* Check wether our headers will need MIME conversion */
1213 FL
char const * need_hdrconv(struct header
*hp
);
1216 /* Convert header fields from RFC 1522 format */
1217 FL
void mime_fromhdr(struct str
const *in
, struct str
*out
,
1218 enum tdflags flags
);
1220 /* Interpret MIME strings in parts of an address field */
1221 FL
char * mime_fromaddr(char const *name
);
1223 /* fwrite(3) performing the given MIME conversion */
1224 FL ssize_t
mime_write(char const *ptr
, size_t size
, FILE *f
,
1225 enum conversion convert
, enum tdflags dflags
,
1226 struct quoteflt
*qf
, struct str
*rest
);
1227 FL ssize_t
xmime_write(char const *ptr
, size_t size
, /* TODO LEGACY */
1228 FILE *f
, enum conversion convert
, enum tdflags dflags
);
1232 * Content-Transfer-Encodings as defined in RFC 2045 (and RFC 2047):
1233 * - Quoted-Printable, section 6.7
1234 * - Base64, section 6.8
1235 * TODO for now this is pretty mixed up regarding this external interface.
1236 * TODO in v15.0 CTE will be filter based, and explicit conversion will
1237 * TODO gain clear error codes
1240 /* Utilities: the former converts the byte c into a (NUL terminated)
1241 * hexadecimal string as is used in URL percent- and quoted-printable encoding,
1242 * the latter performs the backward conversion and returns the character or -1
1243 * on error; both don't deal with the sequence-introducing percent "%" */
1244 FL
char * mime_char_to_hexseq(char store
[3], char c
);
1245 FL si32_t
mime_hexseq_to_char(char const *hex
);
1247 /* Default MIME Content-Transfer-Encoding: as via *encoding* */
1248 FL
enum mime_enc
mime_enc_target(void);
1250 /* Map from a Content-Transfer-Encoding: header body (which may be NULL) */
1251 FL
enum mime_enc
mime_enc_from_ctehead(char const *hbody
);
1253 /* XXX Try to get rid of that */
1254 FL
char const * mime_enc_from_conversion(enum conversion
const convert
);
1256 /* How many characters of (the complete body) ln need to be quoted.
1257 * Only MIMEEF_ISHEAD and MIMEEF_ISENCWORD are understood */
1258 FL
size_t mime_enc_mustquote(char const *ln
, size_t lnlen
,
1259 enum mime_enc_flags flags
);
1261 /* How much space is necessary to encode len bytes in QP, worst case.
1262 * Includes room for terminator */
1263 FL
size_t qp_encode_calc_size(size_t len
);
1265 /* If flags includes QP_ISHEAD these assume "word" input and use special
1266 * quoting rules in addition; soft line breaks are not generated.
1267 * Otherwise complete input lines are assumed and soft line breaks are
1268 * generated as necessary */
1269 FL
struct str
* qp_encode(struct str
*out
, struct str
const *in
,
1270 enum qpflags flags
);
1272 FL
struct str
* qp_encode_cp(struct str
*out
, char const *cp
,
1273 enum qpflags flags
);
1274 FL
struct str
* qp_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
1275 enum qpflags flags
);
1278 /* If rest is set then decoding will assume body text input (assumes input
1279 * represents lines, only create output when input didn't end with soft line
1280 * break [except it finalizes an encoded CRLF pair]), otherwise it is assumed
1281 * to decode a header strings and (1) uses special decoding rules and (b)
1282 * directly produces output.
1283 * The buffers of out and possibly rest will be managed via srealloc().
1284 * Returns OKAY. XXX or STOP on error (in which case out is set to an error
1285 * XXX message); caller is responsible to free buffers */
1286 FL
int qp_decode(struct str
*out
, struct str
const *in
,
1289 /* How much space is necessary to encode len bytes in Base64, worst case.
1290 * Includes room for (CR/LF/CRLF and) terminator */
1291 FL
size_t b64_encode_calc_size(size_t len
);
1293 /* Note these simply convert all the input (if possible), including the
1294 * insertion of NL sequences if B64_CRLF or B64_LF is set (and multiple thereof
1295 * if B64_MULTILINE is set).
1296 * Thus, in the B64_BUF case, better call b64_encode_calc_size() first */
1297 FL
struct str
* b64_encode(struct str
*out
, struct str
const *in
,
1298 enum b64flags flags
);
1299 FL
struct str
* b64_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
1300 enum b64flags flags
);
1302 FL
struct str
* b64_encode_cp(struct str
*out
, char const *cp
,
1303 enum b64flags flags
);
1306 /* If rest is set then decoding will assume text input.
1307 * The buffers of out and possibly rest will be managed via srealloc().
1308 * Returns OKAY or STOP on error (in which case out is set to an error
1309 * message); caller is responsible to free buffers.
1310 * XXX STOP is effectively not returned for text input (rest!=NULL), instead
1311 * XXX replacement characters are produced for invalid data */
1312 FL
int b64_decode(struct str
*out
, struct str
const *in
,
1319 /* Get a mime style parameter from a header body */
1320 FL
char * mime_param_get(char const *param
, char const *headerbody
);
1322 /* Format parameter name to have value, salloc() it or NULL (error) in result.
1323 * 0 on error, 1 or -1 on success: the latter if result contains \n newlines,
1324 * which it will if the created param requires more than MIME_LINELEN bytes;
1325 * there is never a trailing newline character */
1326 /* TODO mime_param_create() should return a StrList<> or something.
1327 * TODO in fact it should take a HeaderField* and append a HeaderFieldParam*! */
1328 FL si8_t
mime_param_create(struct str
*result
, char const *name
,
1331 /* Get the boundary out of a Content-Type: multipart/xyz header field, return
1332 * salloc()ed copy of it; store strlen() in *len if set */
1333 FL
char * mime_param_boundary_get(char const *headerbody
, size_t *len
);
1335 /* Create a salloc()ed MIME boundary */
1336 FL
char * mime_param_boundary_create(void);
1342 /* Create MIME part object tree for and of mp */
1343 FL
struct mimepart
* mime_parse_msg(struct message
*mp
,
1344 enum mime_parse_flags mpf
);
1350 /* `(un)?mimetype' commands */
1351 FL
int c_mimetype(void *v
);
1352 FL
int c_unmimetype(void *v
);
1354 /* Return a Content-Type matching the name, or NULL if none could be found */
1355 FL
char * mime_type_classify_filename(char const *name
);
1357 /* Classify content of *fp* as necessary and fill in arguments; **charset* is
1358 * left alone unless it's non-NULL */
1359 FL
enum conversion
mime_type_classify_file(FILE *fp
, char const **contenttype
,
1360 char const **charset
, int *do_iconv
);
1362 /* Dependend on *mime-counter-evidence* mpp->m_ct_type_usr_ovwr will be set,
1363 * but otherwise mpp is const */
1364 FL
enum mimecontent
mime_type_classify_part(struct mimepart
*mpp
);
1366 /* Query handler for a part, return the plain type (& MIME_HDL_TYPE_MASK).
1367 * mhp is anyway initialized (mh_flags, mh_msg) */
1368 FL
enum mime_handler_flags
mime_type_handler(struct mime_handler
*mhp
,
1369 struct mimepart
const *mpp
,
1370 enum sendaction action
);
1376 /* Allocate a single element of a name list, initialize its name field to the
1377 * passed name and return it */
1378 FL
struct name
* nalloc(char *str
, enum gfield ntype
);
1380 /* Like nalloc(), but initialize from content of np */
1381 FL
struct name
* ndup(struct name
*np
, enum gfield ntype
);
1383 /* Concatenate the two passed name lists, return the result */
1384 FL
struct name
* cat(struct name
*n1
, struct name
*n2
);
1387 FL
struct name
* namelist_dup(struct name
const *np
, enum gfield ntype
);
1389 /* Determine the number of undeleted elements in a name list and return it;
1390 * the latter also doesn't count file and pipe addressees in addition */
1391 FL ui32_t
count(struct name
const *np
);
1392 FL ui32_t
count_nonlocal(struct name
const *np
);
1394 /* Extract a list of names from a line, and make a list of names from it.
1395 * Return the list or NULL if none found */
1396 FL
struct name
* extract(char const *line
, enum gfield ntype
);
1398 /* Like extract() unless line contains anyof ",\"\\(<|", in which case
1399 * comma-separated list extraction is used instead */
1400 FL
struct name
* lextract(char const *line
, enum gfield ntype
);
1402 /* Turn a list of names into a string of the same names */
1403 FL
char * detract(struct name
*np
, enum gfield ntype
);
1405 /* Get a lextract() list via n_input_cp_addhist(), reassigning to *np* */
1406 FL
struct name
* grab_names(char const *field
, struct name
*np
, int comma
,
1407 enum gfield gflags
);
1409 /* Check wether n1 n2 share the domain name */
1410 FL bool_t
name_is_same_domain(struct name
const *n1
,
1411 struct name
const *n2
);
1413 /* Check all addresses in np and delete invalid ones; if set_on_error is not
1414 * NULL it'll be set to TRU1 for error or -1 for "hard fail" error */
1415 FL
struct name
* checkaddrs(struct name
*np
, enum expand_addr_check_mode eacm
,
1416 si8_t
*set_on_error
);
1418 /* Vaporise all duplicate addresses in hp (.h_(to|cc|bcc)) so that an address
1419 * that "first" occurs in To: is solely in there, ditto Cc:, after expanding
1420 * aliases etc. eacm and set_on_error are passed to checkaddrs(), metoo is
1421 * passed to usermap(). After updating hp to the new state this returns
1422 * a flat list of all addressees, which may be NULL */
1423 FL
struct name
* namelist_vaporise_head(struct header
*hp
,
1424 enum expand_addr_check_mode eacm
, bool_t metoo
,
1425 si8_t
*set_on_error
);
1427 /* Map all of the aliased users in the invoker's mailrc file and insert them
1429 FL
struct name
* usermap(struct name
*names
, bool_t force_metoo
);
1431 /* Remove all of the duplicates from the passed name list by insertion sorting
1432 * them, then checking for dups. Return the head of the new list */
1433 FL
struct name
* elide(struct name
*names
);
1435 /* `alternates' deal with the list of alternate names */
1436 FL
int c_alternates(void *v
);
1438 FL
struct name
* delete_alternates(struct name
*np
);
1440 FL
int is_myname(char const *name
);
1443 FL
int c_alias(void *v
);
1444 FL
int c_unalias(void *v
);
1446 /* `(un)?ml(ist|subscribe)', and a check wether a name is a (wanted) list */
1447 FL
int c_mlist(void *v
);
1448 FL
int c_unmlist(void *v
);
1449 FL
int c_mlsubscribe(void *v
);
1450 FL
int c_unmlsubscribe(void *v
);
1452 FL
enum mlist_state
is_mlist(char const *name
, bool_t subscribed_only
);
1454 /* `(un)?shortcut', and check if str is one, return expansion or NULL */
1455 FL
int c_shortcut(void *v
);
1456 FL
int c_unshortcut(void *v
);
1458 FL
char const * shortcut_expand(char const *str
);
1460 /* `(un)?customhdr'.
1461 * Query a list of all currently defined custom headers (salloc()ed) */
1462 FL
int c_customhdr(void *v
);
1463 FL
int c_uncustomhdr(void *v
);
1465 FL
struct n_header_field
* n_customhdr_query(void);
1473 FL
enum okay
ssl_open(struct url
const *urlp
, struct sock
*sp
);
1476 FL
void ssl_gen_err(char const *fmt
, ...);
1479 FL
int c_verify(void *vp
);
1482 FL
FILE * smime_sign(FILE *ip
, char const *addr
);
1485 FL
FILE * smime_encrypt(FILE *ip
, char const *certfile
, char const *to
);
1487 FL
struct message
* smime_decrypt(struct message
*m
, char const *to
,
1488 char const *cc
, int signcall
);
1491 FL
enum okay
smime_certsave(struct message
*m
, int n
, FILE *op
);
1493 #else /* HAVE_OPENSSL */
1494 # define c_verify c_cmdnotsupp
1503 FL
enum okay
pop3_noop(void);
1506 FL
int pop3_setfile(char const *server
, enum fedit_mode fm
);
1509 FL
enum okay
pop3_header(struct message
*m
);
1512 FL
enum okay
pop3_body(struct message
*m
);
1515 FL
void pop3_quit(void);
1516 #endif /* HAVE_POP3 */
1520 * Subprocesses, popen, but also file handling with registering
1523 /* For program startup in main.c: initialize process manager */
1524 FL
void command_manager_start(void);
1526 /* Notes: OF_CLOEXEC is implied in oflags, xflags may be NULL */
1527 FL
FILE * safe_fopen(char const *file
, char const *oflags
, int *xflags
);
1529 /* Notes: OF_CLOEXEC|OF_REGISTER are implied in oflags!
1530 * Exception is Fdopen() if nocloexec is TRU1, but otherwise even for it the fd
1531 * creator has to take appropriate steps in order to ensure this is true! */
1532 FL
FILE * Fopen(char const *file
, char const *oflags
);
1533 FL
FILE * Fdopen(int fd
, char const *oflags
, bool_t nocloexec
);
1535 FL
int Fclose(FILE *fp
);
1537 /* Open file according to oflags (see popen.c). Handles compressed files */
1538 FL
FILE * Zopen(char const *file
, char const *oflags
);
1540 /* Create a temporary file in tempdir, use namehint for its name (prefix
1541 * unless OF_SUFFIX is set, in which case namehint is an extension that MUST be
1542 * part of the resulting filename, otherwise Ftmp() will fail), store the
1543 * unique name in fn (unless OF_UNLINK is set in oflags), and return a stdio
1544 * FILE pointer with access oflags. OF_CLOEXEC is implied in oflags.
1545 * One of OF_WRONLY and OF_RDWR must be set. Mode of 0600 is implied */
1546 FL
FILE * Ftmp(char **fn
, char const *namehint
, enum oflags oflags
);
1548 /* If OF_HOLDSIGS was set when calling Ftmp(), then hold_all_sigs() had been
1549 * called: call this to unlink(2) and free *fn and to rele_all_sigs() */
1550 FL
void Ftmp_release(char **fn
);
1552 /* Free the resources associated with the given filename. To be called after
1554 FL
void Ftmp_free(char **fn
);
1556 /* Create a pipe and ensure CLOEXEC bit is set in both descriptors */
1557 FL bool_t
pipe_cloexec(int fd
[2]);
1560 * env_addon may be NULL, otherwise it is expected to be a NULL terminated
1561 * array of "K=V" strings to be placed into the childs environment.
1562 * If cmd==(char*)-1 then shell is indeed expected to be a PTF :P that will be
1563 * called from within the child process */
1564 FL
FILE * Popen(char const *cmd
, char const *mode
, char const *shell
,
1565 char const **env_addon
, int newfd1
);
1567 FL bool_t
Pclose(FILE *ptr
, bool_t dowait
);
1569 FL
void close_all_files(void);
1571 /* Fork a child process, enable use of the *child() series below */
1572 FL
int fork_child(void);
1574 /* Run a command without a shell, with optional arguments and splicing of stdin
1575 * and stdout. FDs may also be COMMAND_FD_NULL and COMMAND_FD_PASS, meaning to
1576 * redirect from/to /dev/null or pass through our own set of FDs; in the
1577 * latter case terminal capabilities are saved/restored if possible.
1578 * The command name can be a sequence of words.
1579 * Signals must be handled by the caller. "Mask" contains the signals to
1580 * ignore in the new process. SIGINT is enabled unless it's in the mask.
1581 * env_addon may be NULL, otherwise it is expected to be a NULL terminated
1582 * array of "K=V" strings to be placed into the childs environment */
1583 FL
int run_command(char const *cmd
, sigset_t
*mask
, int infd
,
1584 int outfd
, char const *a0
, char const *a1
, char const *a2
,
1585 char const **env_addon
);
1587 /* Like run_command, but don't wait for the command to finish.
1588 * Also it is usually an error to use COMMAND_FD_PASS for this one */
1589 FL
int start_command(char const *cmd
, sigset_t
*mask
, int infd
,
1590 int outfd
, char const *a0
, char const *a1
, char const *a2
,
1591 char const **env_addon
);
1593 /* In-child process */
1594 FL
void prepare_child(sigset_t
*nset
, int infd
, int outfd
);
1596 /* Mark a child as don't care - pid */
1597 FL
void free_child(int pid
);
1599 /* Wait for pid, return wether we've had a normal EXIT_SUCCESS exit.
1600 * If wait_status is set, set it to the reported waitpid(2) wait status */
1601 FL bool_t
wait_child(int pid
, int *wait_status
);
1607 /* Save all of the undetermined messages at the top of "mbox". Save all
1608 * untouched messages back in the system mailbox. Remove the system mailbox,
1609 * if none saved there */
1612 /* Adjust the message flags in each message */
1613 FL
int holdbits(void);
1615 /* Create another temporary file and copy user's mbox file darin. If there is
1616 * no mbox, copy nothing. If he has specified "append" don't copy his mailbox,
1617 * just copy saveable entries at the end */
1618 FL
enum okay
makembox(void);
1620 FL
void save_mbox_for_possible_quitstuff(void); /* TODO DROP IF U CAN */
1622 FL
int savequitflags(void);
1624 FL
void restorequitflags(int);
1630 /* Send message described by the passed pointer to the passed output buffer.
1631 * Return -1 on error. Adjust the status: field if need be. If doign is
1632 * given, suppress ignored header fields. prefix is a string to prepend to
1633 * each output line. action = data destination
1634 * (SEND_MBOX,_TOFILE,_TODISP,_QUOTE,_DECRYPT). stats[0] is line count,
1635 * stats[1] is character count. stats may be NULL. Note that stats[0] is
1636 * valid for SEND_MBOX only */
1637 FL
int sendmp(struct message
*mp
, FILE *obuf
, struct ignoretab
*doign
,
1638 char const *prefix
, enum sendaction action
, ui64_t
*stats
);
1644 /* Interface between the argument list and the mail1 routine which does all the
1646 FL
int mail(struct name
*to
, struct name
*cc
, struct name
*bcc
,
1647 char *subject
, struct attachment
*attach
, char *quotefile
,
1648 int recipient_record
);
1650 /* `mail' and `Mail' commands, respectively */
1651 FL
int c_sendmail(void *v
);
1652 FL
int c_Sendmail(void *v
);
1654 /* Mail a message on standard input to the people indicated in the passed
1655 * header. (Internal interface) */
1656 FL
enum okay
mail1(struct header
*hp
, int printheaders
,
1657 struct message
*quote
, char *quotefile
, int recipient_record
,
1660 /* Create a Date: header field.
1661 * We compare the localtime() and gmtime() results to get the timezone, because
1662 * numeric timezones are easier to read and because $TZ isn't always set */
1663 FL
int mkdate(FILE *fo
, char const *field
);
1665 /* Dump the to, subject, cc header on the passed file buffer.
1666 * nosend_msg tells us not to dig to deep but to instead go for compose mode or
1667 * editing a message (yet we're stupid and cannot do it any better) - if it is
1668 * TRUM1 then we're really in compose mode and will produce some fields for
1669 * easier filling in */
1670 FL
int puthead(bool_t nosend_msg
, struct header
*hp
, FILE *fo
,
1671 enum gfield w
, enum sendaction action
,
1672 enum conversion convert
, char const *contenttype
,
1673 char const *charset
);
1676 FL
enum okay
resend_msg(struct message
*mp
, struct name
*to
, int add_resent
);
1682 FL
void n_raise(int signo
);
1684 /* Provide BSD-like signal() on all (POSIX) systems */
1685 FL sighandler_type
safe_signal(int signum
, sighandler_type handler
);
1687 /* Hold *all* signals but SIGCHLD, and release that total block again */
1688 FL
void hold_all_sigs(void);
1689 FL
void rele_all_sigs(void);
1691 /* Hold HUP/QUIT/INT */
1692 FL
void hold_sigs(void);
1693 FL
void rele_sigs(void);
1695 /* Call _ENTER_SWITCH() with the according flags, it'll take care for the rest
1696 * and also set the jump buffer - it returns 0 if anything went fine and
1697 * a signal number if a jump occurred, in which case all handlers requested in
1698 * flags are temporarily SIG_IGN.
1699 * _cleanup_ping() informs the condome that no jumps etc. shall be performed
1700 * until _leave() is called in the following -- to be (optionally) called right
1701 * before the local jump label is reached which is jumped to after a long jump
1702 * occurred, straight code flow provided, e.g., to avoid destructors to be
1703 * called twice. _leave() must always be called last, reraise_flags will be
1704 * used to decide how signal handling has to continue
1706 #define n_SIGMAN_ENTER_SWITCH(S,F) do{\
1709 if(sigsetjmp((S)->sm_jump, 1))\
1713 n__sigman_enter(S, __x__);\
1714 }while(0); switch((S)->sm_signo)
1715 FL
int n__sigman_enter(struct n_sigman
*self
, int flags
);
1716 FL
void n_sigman_cleanup_ping(struct n_sigman
*self
);
1717 FL
void n_sigman_leave(struct n_sigman
*self
, enum n_sigman_flags flags
);
1719 /* Pending signal or 0? */
1720 FL
int n_sigman_peek(void);
1721 FL
void n_sigman_consume(void);
1723 /* Not-Yet-Dead debug information (handler installation in main.c) */
1724 #if defined HAVE_DEBUG || defined HAVE_DEVEL
1725 FL
void _nyd_chirp(ui8_t act
, char const *file
, ui32_t line
,
1727 FL
void _nyd_oncrash(int signo
);
1730 # define NYD_ENTER _nyd_chirp(1, __FILE__, __LINE__, __FUN__)
1731 # define NYD_LEAVE _nyd_chirp(2, __FILE__, __LINE__, __FUN__)
1732 # define NYD _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
1733 # define NYD_X _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
1735 # define NYD2_ENTER _nyd_chirp(1, __FILE__, __LINE__, __FUN__)
1736 # define NYD2_LEAVE _nyd_chirp(2, __FILE__, __LINE__, __FUN__)
1737 # define NYD2 _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
1743 # define NYD_ENTER do {} while (0)
1744 # define NYD_LEAVE do {} while (0)
1745 # define NYD do {} while (0)
1746 # define NYD_X do {} while (0) /* XXX LEGACY */
1749 # define NYD2_ENTER do {} while (0)
1750 # define NYD2_LEAVE do {} while (0)
1751 # define NYD2 do {} while (0)
1759 /* Send a message via SMTP */
1760 FL bool_t
smtp_mta(struct sendbundle
*sbp
);
1768 /* Direct mappings of the various spam* commands */
1769 FL
int c_spam_clear(void *v
);
1770 FL
int c_spam_set(void *v
);
1771 FL
int c_spam_forget(void *v
);
1772 FL
int c_spam_ham(void *v
);
1773 FL
int c_spam_rate(void *v
);
1774 FL
int c_spam_spam(void *v
);
1776 # define c_spam_clear c_cmdnotsupp
1777 # define c_spam_set c_cmdnotsupp
1778 # define c_spam_forget c_cmdnotsupp
1779 # define c_spam_ham c_cmdnotsupp
1780 # define c_spam_rate c_cmdnotsupp
1781 # define c_spam_spam c_cmdnotsupp
1790 FL
void ssl_set_verify_level(struct url
const *urlp
);
1793 FL
enum okay
ssl_verify_decide(void);
1796 FL
enum okay
smime_split(FILE *ip
, FILE **hp
, FILE **bp
, long xcount
,
1800 FL
FILE * smime_sign_assemble(FILE *hp
, FILE *bp
, FILE *sp
,
1801 char const *message_digest
);
1804 FL
FILE * smime_encrypt_assemble(FILE *hp
, FILE *yp
);
1807 FL
struct message
* smime_decrypt_assemble(struct message
*m
, FILE *hp
,
1811 FL
int c_certsave(void *v
);
1814 FL
enum okay
rfc2595_hostname_match(char const *host
, char const *pattern
);
1815 #else /* HAVE_SSL */
1816 # define c_certsave c_cmdnotsupp
1821 * This bundles several different string related support facilities:
1822 * - auto-reclaimed string storage (memory goes away on command loop ticks)
1823 * - plain char* support functions which use unspecified or smalloc() memory
1824 * - struct str related support funs
1825 * - our iconv(3) wrapper
1828 /* Auto-reclaimed string storage */
1831 # define SALLOC_DEBUG_ARGS , char const *mdbg_file, int mdbg_line
1832 # define SALLOC_DEBUG_ARGSCALL , mdbg_file, mdbg_line
1834 # define SALLOC_DEBUG_ARGS
1835 # define SALLOC_DEBUG_ARGSCALL
1838 /* Allocate size more bytes of space and return the address of the first byte
1839 * to the caller. An even number of bytes are always allocated so that the
1840 * space will always be on a word boundary */
1841 FL
void * salloc(size_t size SALLOC_DEBUG_ARGS
);
1842 FL
void * csalloc(size_t nmemb
, size_t size SALLOC_DEBUG_ARGS
);
1844 # define salloc(SZ) salloc(SZ, __FILE__, __LINE__)
1845 # define csalloc(NM,SZ) csalloc(NM, SZ, __FILE__, __LINE__)
1848 /* Auto-reclaim string storage; if only_if_relaxed is true then only perform
1849 * the reset when a srelax_hold() is currently active */
1850 FL
void sreset(bool_t only_if_relaxed
);
1852 /* The "problem" with sreset() is that it releases all string storage except
1853 * what was present once spreserve() had been called; it therefore cannot be
1854 * called from all that code which yet exists and walks about all the messages
1855 * in order, e.g. quit(), searches, etc., because, unfortunately, these code
1856 * paths are reached with new intermediate string dope already in use.
1857 * Thus such code should take a srelax_hold(), successively call srelax() after
1858 * a single message has been handled, and finally srelax_rele() (unless it is
1859 * clear that sreset() occurs anyway) */
1860 FL
void srelax_hold(void);
1861 FL
void srelax_rele(void);
1862 FL
void srelax(void);
1864 /* Make current string storage permanent: new allocs will be auto-reclaimed by
1865 * sreset(). This is called once only, from within main() */
1866 FL
void spreserve(void);
1868 /* 'sstats' command */
1870 FL
int c_sstats(void *v
);
1873 /* Return a pointer to a dynamic copy of the argument */
1874 FL
char * savestr(char const *str SALLOC_DEBUG_ARGS
);
1875 FL
char * savestrbuf(char const *sbuf
, size_t sbuf_len SALLOC_DEBUG_ARGS
);
1877 # define savestr(CP) savestr(CP, __FILE__, __LINE__)
1878 # define savestrbuf(CBP,CBL) savestrbuf(CBP, CBL, __FILE__, __LINE__)
1881 /* Concatenate cp2 onto cp1 (if not NULL), separated by sep (if not '\0') */
1882 FL
char * savecatsep(char const *cp1
, char sep
, char const *cp2
1885 # define savecatsep(S1,SEP,S2) savecatsep(S1, SEP, S2, __FILE__, __LINE__)
1888 /* Make copy of argument incorporating old one, if set, separated by space */
1889 #define save2str(S,O) savecatsep(O, ' ', S)
1892 #define savecat(S1,S2) savecatsep(S1, '\0', S2)
1894 /* Create duplicate, lowercasing all characters along the way */
1895 FL
char * i_strdup(char const *src SALLOC_DEBUG_ARGS
);
1897 # define i_strdup(CP) i_strdup(CP, __FILE__, __LINE__)
1901 FL
struct str
* str_concat_csvl(struct str
*self
, ...);
1904 FL
struct str
* str_concat_cpa(struct str
*self
, char const * const *cpa
,
1905 char const *sep_o_null SALLOC_DEBUG_ARGS
);
1907 # define str_concat_cpa(S,A,N) str_concat_cpa(S, A, N, __FILE__, __LINE__)
1910 /* Plain char* support, not auto-reclaimed (unless noted) */
1912 /* Are any of the characters in the two strings the same? */
1913 FL
int anyof(char const *s1
, char const *s2
);
1915 /* Treat *iolist as a sep separated list of strings; find and return the
1916 * next entry, trimming surrounding whitespace, and point *iolist to the next
1917 * entry or to NULL if no more entries are contained. If ignore_empty is not
1918 * set empty entries are started over.
1919 * strescsep will assert that sep is not NULL, and allows escaping of the
1920 * separator character with a backslash.
1921 * Return NULL or an entry */
1922 FL
char * n_strsep(char **iolist
, char sep
, bool_t ignore_empty
);
1923 FL
char * n_strescsep(char **iolist
, char sep
, bool_t ignore_empty
);
1925 /* Copy a string, lowercasing it as we go; *size* is buffer size of *dest*;
1926 * *dest* will always be terminated unless *size* is 0 */
1927 FL
void i_strcpy(char *dest
, char const *src
, size_t size
);
1929 /* Is *as1* a valid prefix of *as2*? */
1930 FL
int is_prefix(char const *as1
, char const *as2
);
1932 /* Backslash quote (" and \) v'alue, and return salloc()ed result */
1933 FL
char * string_quote(char const *v
);
1935 /* Get (and isolate) the last, possibly quoted part of linebuf, set *needs_list
1936 * to indicate wether getmsglist() et al need to be called to collect
1937 * additional args that remain in linebuf. If strip is true possibly
1938 * surrounding quote characters are removed. Return NULL on "error" */
1939 FL
char * laststring(char *linebuf
, bool_t
*needs_list
, bool_t strip
);
1941 /* Convert a string to lowercase, in-place and with multibyte-aware */
1942 FL
void makelow(char *cp
);
1944 /* Is *sub* a substring of *str*, case-insensitive and multibyte-aware? */
1945 FL bool_t
substr(char const *str
, char const *sub
);
1948 FL
char * sstpcpy(char *dst
, char const *src
);
1949 FL
char * sstrdup(char const *cp SMALLOC_DEBUG_ARGS
);
1950 FL
char * sbufdup(char const *cp
, size_t len SMALLOC_DEBUG_ARGS
);
1952 # define sstrdup(CP) sstrdup(CP, __FILE__, __LINE__)
1953 # define sbufdup(CP,L) sbufdup(CP, L, __FILE__, __LINE__)
1956 /* Copy at most dstsize bytes of src to dst and return string length.
1957 * Returns -E2BIG if dst is not large enough; dst will always be terminated
1958 * unless dstsize was 0 on entry */
1959 FL ssize_t
n_strscpy(char *dst
, char const *src
, size_t dstsize
);
1961 /* Case-independent ASCII comparisons */
1962 FL
int asccasecmp(char const *s1
, char const *s2
);
1963 FL
int ascncasecmp(char const *s1
, char const *s2
, size_t sz
);
1965 /* Case-independent ASCII string find s2 in s1, return it or NULL */
1966 FL
char const *asccasestr(char const *s1
, char const *s2
);
1968 /* Case-independent ASCII check wether as2 is the initial substring of as1 */
1969 FL bool_t
is_asccaseprefix(char const *as1
, char const *as2
);
1971 /* struct str related support funs */
1973 /* *self->s* is srealloc()ed */
1974 FL
struct str
* n_str_dup(struct str
*self
, struct str
const *t
1975 SMALLOC_DEBUG_ARGS
);
1977 /* *self->s* is srealloc()ed, *self->l* incremented */
1978 FL
struct str
* n_str_add_buf(struct str
*self
, char const *buf
, size_t buflen
1979 SMALLOC_DEBUG_ARGS
);
1980 #define n_str_add(S, T) n_str_add_buf(S, (T)->s, (T)->l)
1981 #define n_str_add_cp(S, CP) n_str_add_buf(S, CP, (CP) ? strlen(CP) : 0)
1984 # define n_str_dup(S,T) n_str_dup(S, T, __FILE__, __LINE__)
1985 # define n_str_add_buf(S,B,BL) n_str_add_buf(S, B, BL, __FILE__, __LINE__)
1989 * May have NULL buffer, may contain embedded NULs */
1992 #define n_string_creat(S) \
1993 ((S)->s_dat = NULL, (S)->s_len = (S)->s_auto = (S)->s_size = 0, (S))
1994 #define n_string_creat_auto(S) \
1995 ((S)->s_dat = NULL, (S)->s_len = (S)->s_size = 0, (S)->s_auto = TRU1, (S))
1996 #define n_string_gut(S) ((S)->s_size != 0 ? (void)n_string_clear(S) : (void)0)
1998 /* Truncate to size, which must be LE current length */
1999 #define n_string_trunc(S,L) ((S)->s_len = (L), (S))
2001 /* Release buffer ownership */
2002 #define n_string_drop_ownership(S) \
2003 ((S)->s_dat = NULL, (S)->s_len = (S)->s_size = 0, (S))
2005 /* Release all memory */
2006 FL
struct n_string
*n_string_clear(struct n_string
*self SMALLOC_DEBUG_ARGS
);
2009 # define n_string_clear(S) \
2010 ((S)->s_size != 0 ? (n_string_clear)(S, __FILE__, __LINE__) : (S))
2012 # define n_string_clear(S) ((S)->s_size != 0 ? (n_string_clear)(S) : (S))
2015 /* Reserve room for noof additional bytes */
2016 FL
struct n_string
*n_string_reserve(struct n_string
*self
, size_t noof
2017 SMALLOC_DEBUG_ARGS
);
2020 # define n_string_reserve(S,N) (n_string_reserve)(S, N, __FILE__, __LINE__)
2024 FL
struct n_string
*n_string_push_buf(struct n_string
*self
, char const *buf
,
2025 size_t buflen SMALLOC_DEBUG_ARGS
);
2026 #define n_string_push(S, T) n_string_push_buf(S, (T)->s_len, (T)->s_dat)
2027 #define n_string_push_cp(S,CP) n_string_push_buf(S, CP, UIZ_MAX)
2028 FL
struct n_string
*n_string_push_c(struct n_string
*self
, char c
2029 SMALLOC_DEBUG_ARGS
);
2031 #define n_string_assign(S,T) ((S)->s_len = 0, n_string_push(S, T))
2032 #define n_string_assign_cp(S,CP) ((S)->s_len = 0, n_string_push_cp(S, CP))
2033 #define n_string_assign_buf(S,B,BL) \
2034 ((S)->s_len = 0, n_string_push_buf(S, B, BL))
2037 # define n_string_push_buf(S,B,BL) \
2038 n_string_push_buf(S, B, BL, __FILE__, __LINE__)
2039 # define n_string_push_c(S,C) n_string_push_c(S, C, __FILE__, __LINE__)
2043 FL
struct n_string
*n_string_unshift_buf(struct n_string
*self
, char const *buf
,
2044 size_t buflen SMALLOC_DEBUG_ARGS
);
2045 #define n_string_unshift(S, T) \
2046 n_string_unshift_buf(S, (T)->s_len, (T)->s_dat)
2047 #define n_string_unshift_cp(S,CP) \
2048 n_string_unshift_buf(S, CP, UIZ_MAX)
2049 FL
struct n_string
*n_string_unshift_c(struct n_string
*self
, char c
2050 SMALLOC_DEBUG_ARGS
);
2053 # define n_string_unshift_buf(S,B,BL) \
2054 n_string_unshift_buf(S, B, BL, __FILE__, __LINE__)
2055 # define n_string_unshift_c(S,C) n_string_unshift_c(S, C, __FILE__, __LINE__)
2058 /* Ensure self has a - NUL terminated - buffer, and return that.
2059 * The latter may return the pointer to an internal empty RODATA instead */
2060 FL
char * n_string_cp(struct n_string
*self SMALLOC_DEBUG_ARGS
);
2061 FL
char const *n_string_cp_const(struct n_string
const *self
);
2064 # define n_string_cp(S) n_string_cp(S, __FILE__, __LINE__)
2068 n_INLINE
struct n_string
*
2069 (n_string_creat
)(struct n_string
*self
){
2070 return n_string_creat(self
);
2072 # undef n_string_creat
2074 n_INLINE
struct n_string
*
2075 (n_string_creat_auto
)(struct n_string
*self
){
2076 return n_string_creat_auto(self
);
2078 # undef n_string_creat_auto
2081 (n_string_gut
)(struct n_string
*self
){
2084 # undef n_string_gut
2086 n_INLINE
struct n_string
*
2087 (n_string_trunc
)(struct n_string
*self
, size_t l
){
2088 return n_string_trunc(self
, l
);
2090 # undef n_string_trunc
2092 n_INLINE
struct n_string
*
2093 (n_string_drop_ownership
)(struct n_string
*self
){
2094 return n_string_drop_ownership(self
);
2096 # undef n_string_drop_ownership
2097 #endif /* HAVE_INLINE */
2101 /* ..and update arguments to point after range; returns UI32_MAX on error, in
2102 * which case the arguments will have been stepped one byte */
2103 #ifdef HAVE_NATCH_CHAR
2104 FL ui32_t
n_utf8_to_utf32(char const **bdat
, size_t *blen
);
2107 /* buf must be large enough also for NUL, it's new length will be returned */
2108 #ifdef HAVE_FILTER_HTML_TAGSOUP
2109 FL
size_t n_utf32_to_utf8(ui32_t c
, char *buf
);
2112 /* Our iconv(3) wrappers */
2115 FL iconv_t
n_iconv_open(char const *tocode
, char const *fromcode
);
2116 /* If *cd* == *iconvd*, assigns -1 to the latter */
2117 FL
void n_iconv_close(iconv_t cd
);
2119 /* Reset encoding state */
2120 FL
void n_iconv_reset(iconv_t cd
);
2122 /* iconv(3), but return *errno* or 0; *skipilseq* forces step over invalid byte
2123 * sequences; likewise iconv_str(), but which auto-grows on E2BIG errors; *in*
2124 * and *in_rest_or_null* may be the same object.
2125 * Note: EINVAL (incomplete sequence at end of input) is NOT handled, so the
2126 * replacement character must be added manually if that happens at EOF! */
2127 FL
int n_iconv_buf(iconv_t cd
, char const **inb
, size_t *inbleft
,
2128 char **outb
, size_t *outbleft
, bool_t skipilseq
);
2129 FL
int n_iconv_str(iconv_t icp
, struct str
*out
, struct str
const *in
,
2130 struct str
*in_rest_or_null
, bool_t skipilseq
);
2135 * This is a little bit hairy since it provides some stuff even if HAVE_TERMCAP
2136 * is false due to encapsulation desire
2140 /* termcap(3) / xy lifetime handling -- only called if we're OPT_INTERACTIVE
2141 * but not doing something in OPT_QUICKRUN_MASK */
2142 FL
void n_termcap_init(void);
2143 FL
void n_termcap_destroy(void);
2145 /* enter_ca_mode / enable keypad (both if possible).
2146 * TODO When complete is not set we won't enter_ca_mode, for example: we don't
2147 * TODO want a complete screen clearance after $PAGER returned after displaying
2148 * TODO a mail, because otherwise the screen would look differently for normal
2149 * TODO stdout display messages. Etc. */
2150 # ifdef HAVE_TERMCAP
2151 FL
void n_termcap_resume(bool_t complete
);
2152 FL
void n_termcap_suspend(bool_t complete
);
2154 # define n_TERMCAP_RESUME(CPL) n_termcap_resume(CPL)
2155 # define n_TERMCAP_SUSPEND(CPL) n_termcap_suspend(CPL)
2157 # define n_TERMCAP_RESUME(CPL)
2158 # define n_TERMCAP_SUSPEND(CPL)
2161 /* Command multiplexer, returns FAL0 on I/O error, TRU1 on success and TRUM1
2162 * for commands which are not available and have no builtin fallback.
2163 * For query options the return represents a true value and -1 error.
2164 * Will return FAL0 directly unless we've been initialized.
2165 * By convention unused argument slots are given as -1 */
2166 FL ssize_t
n_termcap_cmd(enum n_termcap_cmd cmd
, ssize_t a1
, ssize_t a2
);
2167 # define n_termcap_cmdx(CMD) n_termcap_cmd(CMD, -1, -1)
2169 /* Query multiplexer. If query is n__TERMCAP_QUERY_MAX then
2170 * tvp->tv_data.tvd_string must contain the name of the query to look up; this
2171 * is used to lookup just about *any* (string) capability.
2172 * Returns TRU1 on success and TRUM1 for queries for which a builtin default
2173 * is returned; FAL0 is returned on non-availability */
2174 FL bool_t
n_termcap_query(enum n_termcap_query query
,
2175 struct n_termcap_value
*tvp
);
2177 /* Get a n_termcap_query for name or -1 if it is not known, and -2 if
2178 * type wasn't _NONE and the type doesn't match. */
2179 # ifdef HAVE_KEY_BINDINGS
2180 FL si32_t
n_termcap_query_for_name(char const *name
,
2181 enum n_termcap_captype type
);
2182 FL
char const *n_termcap_name_of_query(enum n_termcap_query query
);
2184 #endif /* n_HAVE_TCAP */
2191 FL
int c_thread(void *vp
);
2194 FL
int c_unthread(void *vp
);
2197 FL
struct message
* next_in_thread(struct message
*mp
);
2198 FL
struct message
* prev_in_thread(struct message
*mp
);
2199 FL
struct message
* this_in_thread(struct message
*mp
, long n
);
2201 /* Sorted mode is internally just a variant of threaded mode with all m_parent
2202 * and m_child links being NULL */
2203 FL
int c_sort(void *vp
);
2206 FL
int c_collapse(void *v
);
2207 FL
int c_uncollapse(void *v
);
2210 FL
void uncollapse1(struct message
*mp
, int always
);
2216 /* Return wether user says yes, on STDIN if interactive.
2217 * Uses noninteract_default, the return value for non-interactive use cases,
2218 * as a hint for boolify() and chooses the yes/no string to append to prompt
2219 * accordingly. If prompt is NULL "Continue" is used instead.
2220 * Handles+reraises SIGINT */
2221 FL bool_t
getapproval(char const *prompt
, bool_t noninteract_default
);
2224 /* Get a password the expected way, return termios_state.ts_linebuf on
2225 * success or NULL on error */
2226 FL
char * getuser(char const *query
);
2228 /* Get a password the expected way, return termios_state.ts_linebuf on
2229 * success or NULL on error. SIGINT is temporarily blocked, *not* reraised.
2230 * termios_state_reset() (def.h) must be called anyway */
2231 FL
char * getpassword(char const *query
);
2234 /* Overall interactive terminal life cycle for command line editor library */
2235 #if defined HAVE_READLINE
2236 # define TTY_WANTS_SIGWINCH
2238 FL
void n_tty_init(void);
2239 FL
void n_tty_destroy(void);
2241 /* Rather for main.c / SIGWINCH interaction only */
2242 FL
void n_tty_signal(int sig
);
2244 /* Read a line after printing prompt (if set and non-empty).
2245 * If n>0 assumes that *linebuf has n bytes of default content */
2246 FL
int n_tty_readline(char const *prompt
, char **linebuf
,
2247 size_t *linesize
, size_t n SMALLOC_DEBUG_ARGS
);
2249 # define n_tty_readline(A,B,C,D) (n_tty_readline)(A, B, C, D, __FILE__,__LINE__)
2252 /* Add a line (most likely as returned by n_tty_readline()) to the history.
2253 * Wether an entry added for real depends on the isgabby / *history-gabby*
2254 * relation, and / or wether s is non-empty and doesn't begin with U+0020 */
2255 FL
void n_tty_addhist(char const *s
, bool_t isgabby
);
2258 FL
int c_history(void *v
);
2260 # define c_history c_cmdnotsupp
2267 /* URL en- and decoding according to (enough of) RFC 3986 (RFC 1738).
2268 * These return a newly salloc()ated result */
2269 FL
char * urlxenc(char const *cp
, bool_t ispath SALLOC_DEBUG_ARGS
);
2270 FL
char * urlxdec(char const *cp SALLOC_DEBUG_ARGS
);
2272 # define urlxenc(CP,P) urlxenc(CP, P, __FILE__, __LINE__)
2273 # define urlxdec(CP) urlxdec(CP, __FILE__, __LINE__)
2277 /* Return port of urlp->url_proto (and set irv_or_null), or NULL if unknown */
2278 FL
char const * url_servbyname(struct url
const *urlp
, ui16_t
*irv_or_null
);
2280 /* Parse data, which must meet the criteria of the protocol cproto, and fill
2281 * in the URL structure urlp (URL rather according to RFC 3986) */
2282 FL bool_t
url_parse(struct url
*urlp
, enum cproto cproto
,
2285 /* Zero ccp and lookup credentials for communicating with urlp.
2286 * Return wether credentials are available and valid (for chosen auth) */
2287 FL bool_t
ccred_lookup(struct ccred
*ccp
, struct url
*urlp
);
2288 FL bool_t
ccred_lookup_old(struct ccred
*ccp
, enum cproto cproto
,
2290 #endif /* HAVE_SOCKETS */
2294 FL
int c_netrc(void *v
);
2296 # define c_netrc c_cmdnotsupp
2299 /* MD5 (RFC 1321) related facilities */
2301 # ifdef HAVE_OPENSSL_MD5
2302 # define md5_ctx MD5_CTX
2303 # define md5_init MD5_Init
2304 # define md5_update MD5_Update
2305 # define md5_final MD5_Final
2307 /* The function definitions are instantiated in main.c */
2308 # include "rfc1321.h"
2311 /* Store the MD5 checksum as a hexadecimal string in *hex*, *not* terminated,
2312 * using lowercase ASCII letters as defined in RFC 2195 */
2313 # define MD5TOHEX_SIZE 32
2314 FL
char * md5tohex(char hex
[MD5TOHEX_SIZE
], void const *vp
);
2316 /* CRAM-MD5 encode the *user* / *pass* / *b64* combo */
2317 FL
char * cram_md5_string(struct str
const *user
, struct str
const *pass
,
2320 /* RFC 2104: HMAC: Keyed-Hashing for Message Authentication.
2321 * unsigned char *text: pointer to data stream
2322 * int text_len : length of data stream
2323 * unsigned char *key : pointer to authentication key
2324 * int key_len : length of authentication key
2325 * caddr_t digest : caller digest to be filled in */
2326 FL
void hmac_md5(unsigned char *text
, int text_len
, unsigned char *key
,
2327 int key_len
, void *digest
);
2328 #endif /* HAVE_MD5 */
2330 #ifndef HAVE_AMALGAMATION