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
49 /* Memory allocation routines from memory.c offer some debug support */
50 #if (defined HAVE_DEBUG || defined HAVE_DEVEL) && !defined HAVE_NOMEMDBG
51 # define HAVE_MEMORY_DEBUG
52 # define SMALLOC_DEBUG_ARGS , char const *mdbg_file, int mdbg_line
53 # define SMALLOC_DEBUG_ARGSCALL , mdbg_file, mdbg_line
54 # define SALLOC_DEBUG_ARGS , char const *mdbg_file, int mdbg_line
55 # define SALLOC_DEBUG_ARGSCALL , mdbg_file, mdbg_line
57 # define SMALLOC_DEBUG_ARGS
58 # define SMALLOC_DEBUG_ARGSCALL
59 # define SALLOC_DEBUG_ARGS
60 # define SALLOC_DEBUG_ARGSCALL
64 * Macro-based generics
67 /* ASCII char classification */
68 #define __ischarof(C, FLAGS) \
69 (asciichar(C) && (class_char[(ui8_t)(C)] & (FLAGS)) != 0)
71 #define n_uasciichar(U) ((size_t)(U) <= 0x7F)
72 #define asciichar(c) ((uc_i)(c) <= 0x7F)
73 #define alnumchar(c) __ischarof(c, C_DIGIT | C_OCTAL | C_UPPER | C_LOWER)
74 #define alphachar(c) __ischarof(c, C_UPPER | C_LOWER)
75 #define blankchar(c) __ischarof(c, C_BLANK)
76 #define blankspacechar(c) __ischarof(c, C_BLANK | C_SPACE)
77 #define cntrlchar(c) __ischarof(c, C_CNTRL)
78 #define digitchar(c) __ischarof(c, C_DIGIT | C_OCTAL)
79 #define lowerchar(c) __ischarof(c, C_LOWER)
80 #define punctchar(c) __ischarof(c, C_PUNCT)
81 #define spacechar(c) __ischarof(c, C_BLANK | C_SPACE | C_WHITE)
82 #define upperchar(c) __ischarof(c, C_UPPER)
83 #define whitechar(c) __ischarof(c, C_BLANK | C_WHITE)
84 #define octalchar(c) __ischarof(c, C_OCTAL)
85 #define hexchar(c) /* TODO extend bits, add C_HEX */\
86 (__ischarof(c, C_DIGIT | C_OCTAL) || ((c) >= 'A' && (c) <= 'F') ||\
87 ((c) >= 'a' && (c) <= 'f'))
89 #define upperconv(c) (lowerchar(c) ? (char)((uc_i)(c) - 'a' + 'A') : (c))
90 #define lowerconv(c) (upperchar(c) ? (char)((uc_i)(c) - 'A' + 'a') : (c))
92 #define fieldnamechar(c) \
93 (asciichar(c) && (c) > 040 && (c) != 0177 && (c) != ':')
95 /* Could the string contain a regular expression? */
97 # define is_maybe_regex(S) anyof("^.[]*+?()|$", S)
99 # define is_maybe_regex(S) anyof("^[]*+?|$", S)
102 /* Single-threaded, use unlocked I/O */
103 #ifdef HAVE_PUTC_UNLOCKED
105 # define getc(c) getc_unlocked(c)
107 # define putc(c, f) putc_unlocked(c, f)
109 # define putchar(c) putc_unlocked((c), stdout)
112 /* Truncate a file to the last character written. This is useful just before
113 * closing an old file that was opened for read/write */
114 #define ftrunc(stream) \
118 off = ftell(stream);\
120 ftruncate(fileno(stream), off);\
123 /* fflush() and rewind() */
124 #define fflush_rewind(stream) \
130 /* There are problems with dup()ing of file-descriptors for child processes.
131 * As long as those are not fixed in equal spirit to (outof(): FIX and
132 * recode.., 2012-10-04), and to avoid reviving of bugs like (If *record* is
133 * set, avoid writing dead content twice.., 2012-09-14), we have to somehow
134 * accomplish that the FILE* fp makes itself comfortable with the *real* offset
135 * of the underlaying file descriptor. Unfortunately Standard I/O and POSIX
136 * don't describe a way for that -- fflush();rewind(); won't do it. This
137 * fseek(END),rewind() pair works around the problem on *BSD and Linux.
138 * Update as of 2014-03-03: with Issue 7 POSIX has overloaded fflush(3): if
139 * used on a readable stream, then
141 * if the file is not already at EOF, and the file is one capable of
142 * seeking, the file offset of the underlying open file description shall
143 * be set to the file position of the stream.
145 * We need our own, simplified and reliable I/O */
146 #if defined _POSIX_VERSION && _POSIX_VERSION + 0 >= 200809L
147 # define really_rewind(stream) \
153 # define really_rewind(stream) \
157 lseek(fileno(stream), 0, SEEK_SET);\
165 /* Macros: `define', `undefine', `call' / `~' */
166 FL
int c_define(void *v
);
167 FL
int c_undefine(void *v
);
168 FL
int c_call(void *v
);
170 /* TODO Check wether a *folder-hook* exists for the currently active mailbox */
171 FL bool_t
check_folder_hook(bool_t nmail
);
173 /* TODO v15 drop Invoke compose hook macname */
174 FL
void call_compose_mode_hook(char const *macname
,
175 void (*hook_pre
)(void *), void *hook_arg
);
177 /* Accounts: `account', `unaccount' */
178 FL
int c_account(void *v
);
179 FL
int c_unaccount(void *v
);
182 FL
int c_localopts(void *v
);
184 FL
void temporary_localopts_free(void); /* XXX intermediate hack */
185 FL
void temporary_localopts_folder_hook_unroll(void); /* XXX im. hack */
187 /* Don't use n_var_* unless you *really* have to! */
189 /* Constant option key look/(un)set/clear */
190 FL
char * n_var_oklook(enum okeys okey
);
191 #define ok_blook(C) (n_var_oklook(CONCAT(ok_b_, C)) != NULL)
192 #define ok_vlook(C) n_var_oklook(CONCAT(ok_v_, C))
194 FL bool_t
n_var_okset(enum okeys okey
, uintptr_t val
);
195 #define ok_bset(C,B) n_var_okset(CONCAT(ok_b_, C), (uintptr_t)(B))
196 #define ok_vset(C,V) n_var_okset(CONCAT(ok_v_, C), (uintptr_t)(V))
198 FL bool_t
n_var_okclear(enum okeys okey
);
199 #define ok_bclear(C) n_var_okclear(CONCAT(ok_b_, C))
200 #define ok_vclear(C) n_var_okclear(CONCAT(ok_v_, C))
202 /* Variable option key look/(un)set/clear */
203 FL
char * n_var_voklook(char const *vokey
);
204 #define vok_blook(S) (n_var_voklook(S) != NULL)
205 #define vok_vlook(S) n_var_voklook(S)
207 FL bool_t
n_var_vokset(char const *vokey
, uintptr_t val
);
208 #define vok_bset(S,B) n_var_vokset(S, (uintptr_t)(B))
209 #define vok_vset(S,V) n_var_vokset(S, (uintptr_t)(V))
211 FL bool_t
n_var_vokclear(char const *vokey
);
212 #define vok_bclear(S) n_var_vokclear(S)
213 #define vok_vclear(S) n_var_vokclear(S)
215 /* Special case to handle the typical [xy-USER@HOST,] xy-HOST and plain xy
216 * variable chains; oxm is a bitmix which tells which combinations to test */
218 FL
char * n_var_xoklook(enum okeys okey
, struct url
const *urlp
,
219 enum okey_xlook_mode oxm
);
220 # define xok_BLOOK(C,URL,M) (n_var_xoklook(C, URL, M) != NULL)
221 # define xok_VLOOK(C,URL,M) n_var_xoklook(C, URL, M)
222 # define xok_blook(C,URL,M) xok_BLOOK(CONCAT(ok_b_, C), URL, M)
223 # define xok_vlook(C,URL,M) xok_VLOOK(CONCAT(ok_v_, C), URL, M)
226 /* User variable access: `set' and `unset' */
227 FL
int c_set(void *v
);
228 FL
int c_unset(void *v
);
231 FL
int c_varshow(void *v
);
233 /* Ditto: `varedit' */
234 FL
int c_varedit(void *v
);
237 FL
int c_environ(void *v
);
243 /* Try to add an attachment for file, file_expand()ed.
244 * Return the new head of list aphead, or NULL.
245 * The newly created attachment will be stored in *newap, if given */
246 FL
struct attachment
* add_attachment(struct attachment
*aphead
, char *file
,
247 struct attachment
**newap
);
249 /* Append comma-separated list of file names to the end of attachment list */
250 FL
void append_attachments(struct attachment
**aphead
, char *names
);
252 /* Interactively edit the attachment list */
253 FL
void edit_attachments(struct attachment
**aphead
);
259 /* Compute screen size */
260 FL
int screensize(void);
262 /* Get our $PAGER; if env_addon is not NULL it is checked wether we know about
263 * some environment variable that supports colour+ and set *env_addon to that,
264 * e.g., "LESS=FRSXi" */
265 FL
char const *n_pager_get(char const **env_addon
);
267 /* Use a pager or STDOUT to print *fp*; if *lines* is 0, they'll be counted */
268 FL
void page_or_print(FILE *fp
, size_t lines
);
270 /* Parse name and guess at the required protocol */
271 FL
enum protocol
which_protocol(char const *name
);
273 /* Hexadecimal itoa (NUL terminates) / atoi (-1 on error) */
274 FL
char * n_c_to_hex_base16(char store
[3], char c
);
275 FL si32_t
n_c_from_hex_base16(char const hex
[2]);
277 /* Hash the passed string -- uses Chris Torek's hash algorithm */
278 FL ui32_t
torek_hash(char const *name
);
279 #define hash(S) (torek_hash(S) % HSHSIZE) /* xxx COMPAT (?) */
282 FL ui32_t
pjw(char const *cp
); /* TODO obsolete -> torek_hash() */
284 /* Find a prime greater than n */
285 FL ui32_t
nextprime(ui32_t n
);
287 /* Get *prompt*, or '& ' if *bsdcompat*, of '? ' otherwise */
288 FL
char * getprompt(void);
290 /* Detect and query the hostname to use */
291 FL
char * nodename(int mayoverride
);
293 /* Get a (pseudo) random string of *length* bytes; returns salloc()ed buffer */
294 FL
char * getrandstring(size_t length
);
296 /* Check wether the argument string is a true (1) or false (0) boolean, or an
297 * invalid string, in which case -1 is returned; if emptyrv is not -1 then it,
298 * treated as a boolean, is used as the return value shall inbuf be empty.
299 * inlen may be UIZ_MAX to force strlen() detection */
300 FL si8_t
boolify(char const *inbuf
, uiz_t inlen
, si8_t emptyrv
);
302 /* Dig a "quadoption" in inbuf (possibly going through getapproval() in
303 * interactive mode). Returns a boolean or -1 if inbuf content is invalid;
304 * if emptyrv is not -1 then it, treated as a boolean, is used as the return
305 * value shall inbuf be empty. If prompt is set it is printed first if intera.
306 * inlen may be UIZ_MAX to force strlen() detection */
307 FL si8_t
quadify(char const *inbuf
, uiz_t inlen
, char const *prompt
,
310 /* Is the argument "all" (case-insensitive) or "*" */
311 FL bool_t
n_is_all_or_aster(char const *name
);
313 /* Get seconds since epoch */
314 FL
time_t n_time_epoch(void);
316 /* Update *tc* to now; only .tc_time updated unless *full_update* is true */
317 FL
void time_current_update(struct time_current
*tc
,
320 /* Returns 0 if fully slept, number of millis left if ignint is true and we
321 * were interrupted. Actual resolution may be second or less.
322 * Note in case of HAVE_SLEEP this may be SIGALARM based. */
323 FL uiz_t
n_msleep(uiz_t millis
, bool_t ignint
);
325 /* Our error print series.. Note: these reverse scan format in order to know
326 * wether a newline was included or not -- this affects the output! */
327 FL
void n_err(char const *format
, ...);
328 FL
void n_verr(char const *format
, va_list ap
);
330 /* ..(for use in a signal handler; to be obsoleted..).. */
331 FL
void n_err_sighdl(char const *format
, ...);
333 /* Our perror(3); if errval is 0 errno(3) is used; newline appended */
334 FL
void n_perr(char const *msg
, int errval
);
336 /* Announce a fatal error (and die); newline appended */
337 FL
void n_alert(char const *format
, ...);
338 FL
void n_panic(char const *format
, ...);
342 FL
int c_errors(void *vp
);
344 # define c_errors c_cmdnotsupp
351 FL
int c_cmdnotsupp(void *v
);
353 /* `headers' (show header group, possibly after setting dot) */
354 FL
int c_headers(void *v
);
356 /* Like c_headers(), but pre-prepared message vector */
357 FL
int print_header_group(int *vector
);
359 /* Scroll to the next/previous screen */
360 FL
int c_scroll(void *v
);
361 FL
int c_Scroll(void *v
);
363 /* Print out the headlines for each message in the passed message list */
364 FL
int c_from(void *v
);
366 /* Print all message in between and including bottom and topx if they are
367 * visible and either only_marked is false or they are MMARKed */
368 FL
void print_headers(size_t bottom
, size_t topx
, bool_t only_marked
);
370 /* Print out the value of dot */
371 FL
int c_pdot(void *v
);
373 /* Paginate messages, honor/don't honour ignored fields, respectively */
374 FL
int c_more(void *v
);
375 FL
int c_More(void *v
);
377 /* Type out messages, honor/don't honour ignored fields, respectively */
378 FL
int c_type(void *v
);
379 FL
int c_Type(void *v
);
381 /* Show MIME-encoded message text, including all fields */
382 FL
int c_show(void *v
);
384 /* Pipe messages, honor/don't honour ignored fields, respectively */
385 FL
int c_pipe(void *v
);
386 FL
int c_Pipe(void *v
);
388 /* Print the top so many lines of each desired message.
389 * The number of lines is taken from *toplines* and defaults to 5 */
390 FL
int c_top(void *v
);
392 /* Touch all the given messages so that they will get mboxed */
393 FL
int c_stouch(void *v
);
395 /* Make sure all passed messages get mboxed */
396 FL
int c_mboxit(void *v
);
398 /* List the folders the user currently has */
399 FL
int c_folders(void *v
);
405 /* If any arguments were given, go to the next applicable argument following
406 * dot, otherwise, go to the next applicable message. If given as first
407 * command with no arguments, print first message */
408 FL
int c_next(void *v
);
410 /* Move the dot up or down by one message */
411 FL
int c_dotmove(void *v
);
413 /* Save a message in a file. Mark the message as saved so we can discard when
415 FL
int c_save(void *v
);
416 FL
int c_Save(void *v
);
418 /* Copy a message to a file without affected its saved-ness */
419 FL
int c_copy(void *v
);
420 FL
int c_Copy(void *v
);
422 /* Move a message to a file */
423 FL
int c_move(void *v
);
424 FL
int c_Move(void *v
);
426 /* Decrypt and copy a message to a file */
427 FL
int c_decrypt(void *v
);
428 FL
int c_Decrypt(void *v
);
430 /* Write the indicated messages at the end of the passed file name, minus
431 * header and trailing blank line. This is the MIME save function */
432 FL
int c_write(void *v
);
434 /* Delete messages */
435 FL
int c_delete(void *v
);
437 /* Delete messages, then type the new dot */
438 FL
int c_deltype(void *v
);
440 /* Undelete the indicated messages */
441 FL
int c_undelete(void *v
);
443 /* Add the given header fields to the retained list. If no arguments, print
444 * the current list of retained fields */
445 FL
int c_retfield(void *v
);
447 /* Add the given header fields to the ignored list. If no arguments, print the
448 * current list of ignored fields */
449 FL
int c_igfield(void *v
);
451 FL
int c_saveretfield(void *v
);
452 FL
int c_saveigfield(void *v
);
453 FL
int c_fwdretfield(void *v
);
454 FL
int c_fwdigfield(void *v
);
455 FL
int c_unignore(void *v
);
456 FL
int c_unretain(void *v
);
457 FL
int c_unsaveignore(void *v
);
458 FL
int c_unsaveretain(void *v
);
459 FL
int c_unfwdignore(void *v
);
460 FL
int c_unfwdretain(void *v
);
466 /* Process a shell escape by saving signals, ignoring signals and a sh -c */
467 FL
int c_shell(void *v
);
469 /* Fork an interactive shell */
470 FL
int c_dosh(void *v
);
472 /* Show the help screen */
473 FL
int c_help(void *v
);
475 /* Print user's working directory */
476 FL
int c_cwd(void *v
);
478 /* Change user's working directory */
479 FL
int c_chdir(void *v
);
481 /* All thinkable sorts of `reply' / `respond' and `followup'.. */
482 FL
int c_reply(void *v
);
483 FL
int c_replyall(void *v
);
484 FL
int c_replysender(void *v
);
485 FL
int c_Reply(void *v
);
486 FL
int c_followup(void *v
);
487 FL
int c_followupall(void *v
);
488 FL
int c_followupsender(void *v
);
489 FL
int c_Followup(void *v
);
491 /* ..and a mailing-list reply */
492 FL
int c_Lreply(void *v
);
494 /* The 'forward' command */
495 FL
int c_forward(void *v
);
497 /* Similar to forward, saving the message in a file named after the first
499 FL
int c_Forward(void *v
);
501 /* Resend a message list to a third person */
502 FL
int c_resend(void *v
);
504 /* Resend a message list to a third person without adding headers */
505 FL
int c_Resend(void *v
);
507 /* Preserve messages, so that they will be sent back to the system mailbox */
508 FL
int c_preserve(void *v
);
510 /* Mark all given messages as unread */
511 FL
int c_unread(void *v
);
513 /* Mark all given messages as read */
514 FL
int c_seen(void *v
);
516 /* Print the size of each message */
517 FL
int c_messize(void *v
);
519 /* `file' (`folder') and `File' (`Folder') */
520 FL
int c_file(void *v
);
521 FL
int c_File(void *v
);
523 /* Expand file names like echo */
524 FL
int c_echo(void *v
);
526 /* 'newmail' command: Check for new mail without writing old mail back */
527 FL
int c_newmail(void *v
);
529 /* Message flag manipulation */
530 FL
int c_flag(void *v
);
531 FL
int c_unflag(void *v
);
532 FL
int c_answered(void *v
);
533 FL
int c_unanswered(void *v
);
534 FL
int c_draft(void *v
);
535 FL
int c_undraft(void *v
);
538 FL
int c_noop(void *v
);
541 FL
int c_remove(void *v
);
544 FL
int c_rename(void *v
);
546 /* `urlencode' and `urldecode' */
547 FL
int c_urlencode(void *v
);
548 FL
int c_urldecode(void *v
);
554 /* Scan out the list of string arguments according to rm, return -1 on error;
555 * res_dat is NULL terminated unless res_size is 0 or error occurred */
556 FL
int getrawlist(bool_t wysh
, char **res_dat
, size_t res_size
,
557 char const *line
, size_t linesize
);
559 /* Scan an entire command argument line, return wether result can be used,
560 * otherwise no resources are allocated (in ->cac_arg).
561 * For _WYSH arguments the flags _TRIMSPACE and _LOG are implicit */
562 FL bool_t
n_cmd_arg_parse(struct n_cmd_arg_ctx
*cacp
);
564 /* Join all the _GREEDY arguments that were seen into a single string.
565 * Asserted they are string-based. The data (if any) is appended to store */
566 FL
struct n_string
*n_cmd_arg_join_greedy(struct n_cmd_arg_ctx
const *cacp
,
567 struct n_string
*store
);
573 /* if.elif.else.endif conditional execution.
574 * condstack_isskip() returns wether the current condition state doesn't allow
575 * execution of commands.
576 * condstack_release() and condstack_take() rotate the current condition stack;
577 * condstack_take() returns a false boolean if the current condition stack has
578 * unclosed conditionals */
579 FL
int c_if(void *v
);
580 FL
int c_elif(void *v
);
581 FL
int c_else(void *v
);
582 FL
int c_endif(void *v
);
583 FL bool_t
condstack_isskip(void);
584 FL
void * condstack_release(void);
585 FL bool_t
condstack_take(void *self
);
592 * If quotefile is (char*)-1, stdin will be used, caller has to verify that
593 * we're not running in interactive mode */
594 FL
FILE * collect(struct header
*hp
, int printheaders
, struct message
*mp
,
595 char *quotefile
, int doprefix
, si8_t
*checkaddr_err
);
597 FL
void savedeadletter(FILE *fp
, int fflush_rewind_first
);
603 /* Edit a message list */
604 FL
int c_editor(void *v
);
606 /* Invoke the visual editor on a message list */
607 FL
int c_visual(void *v
);
609 /* Run an editor on either size bytes of the file fp (or until EOF if size is
610 * negative) or on the message mp, and return a new file or NULL on error of if
611 * the user didn't perform any edits.
612 * For now we assert that mp==NULL if hp!=NULL, treating this as a special call
613 * from within compose mode, and giving TRUM1 to puthead().
614 * Signals must be handled by the caller. viored is 'e' for ed, 'v' for vi */
615 FL
FILE * run_editor(FILE *fp
, off_t size
, int viored
, int readonly
,
616 struct header
*hp
, struct message
*mp
,
617 enum sendaction action
, sighandler_type oldint
);
625 FL
int c_colour(void *v
);
626 FL
int c_uncolour(void *v
);
628 /* We want coloured output (in this salloc() cycle). pager_used is used to
629 * test wether *colour-pager* is to be inspected.
630 * The push/pop functions deal with recursive execute()ions, for now. TODO
631 * env_gut() will reset() as necessary */
632 FL
void n_colour_env_create(enum n_colour_ctx cctx
, bool_t pager_used
);
633 FL
void n_colour_env_push(void);
634 FL
void n_colour_env_pop(bool_t any_env_till_root
);
635 FL
void n_colour_env_gut(FILE *fp
);
637 /* Putting anything (for pens: including NULL) resets current state first */
638 FL
void n_colour_put(FILE *fp
, enum n_colour_id cid
, char const *ctag
);
639 FL
void n_colour_reset(FILE *fp
);
641 /* Of course temporary only and may return NULL. Doesn't affect state! */
642 FL
struct str
const *n_colour_reset_to_str(void);
644 /* A pen is bound to its environment and automatically reclaimed; it may be
645 * NULL but that can be used anyway for simplicity.
646 * This includes pen_to_str() -- which doesn't affect state! */
647 FL
struct n_colour_pen
*n_colour_pen_create(enum n_colour_id cid
,
649 FL
void n_colour_pen_put(struct n_colour_pen
*self
, FILE *fp
);
651 FL
struct str
const *n_colour_pen_to_str(struct n_colour_pen
*self
);
653 #else /* HAVE_COLOUR */
654 # define c_colour c_cmdnotsupp
655 # define c_uncolour c_cmdnotsupp
656 # define c_mono c_cmdnotsupp
657 # define c_unmono c_cmdnotsupp
664 /* Aquire a flt lock and create a dotlock file; upon success a registered
665 * control-pipe FILE* is returned that keeps the link in between us and the
666 * lock-holding fork(2)ed subprocess (which conditionally replaced itself via
667 * execv(2) with the privilege-separated dotlock helper program): the lock file
668 * will be removed once the control pipe is closed via Pclose().
669 * Will try FILE_LOCK_TRIES times if pollmsecs > 0 (once otherwise).
670 * If pollmsecs is UIZ_MAX, FILE_LOCK_MILLIS is used.
671 * If *dotlock_ignore_error* is set (FILE*)-1 will be returned if at least the
672 * normal file lock could be established, otherwise errno is usable on error */
673 FL
FILE * n_dotlock(char const *fname
, int fd
, enum n_file_lock_type flt
,
674 off_t off
, off_t len
, size_t pollmsecs
);
681 FL
struct quoteflt
* quoteflt_dummy(void); /* TODO LEGACY */
682 FL
void quoteflt_init(struct quoteflt
*self
, char const *prefix
);
683 FL
void quoteflt_destroy(struct quoteflt
*self
);
684 FL
void quoteflt_reset(struct quoteflt
*self
, FILE *f
);
685 FL ssize_t
quoteflt_push(struct quoteflt
*self
, char const *dat
,
687 FL ssize_t
quoteflt_flush(struct quoteflt
*self
);
689 /* (Primitive) HTML tagsoup filter */
690 #ifdef HAVE_FILTER_HTML_TAGSOUP
691 /* TODO Because we don't support filter chains yet this filter will be run
692 * TODO in a dedicated subprocess, driven via a special Popen() mode */
693 FL
int htmlflt_process_main(void);
695 FL
void htmlflt_init(struct htmlflt
*self
);
696 FL
void htmlflt_destroy(struct htmlflt
*self
);
697 FL
void htmlflt_reset(struct htmlflt
*self
, FILE *f
);
698 FL ssize_t
htmlflt_push(struct htmlflt
*self
, char const *dat
, size_t len
);
699 FL ssize_t
htmlflt_flush(struct htmlflt
*self
);
706 /* fgets() replacement to handle lines of arbitrary size and with embedded \0
708 * line - line buffer. *line may be NULL.
709 * linesize - allocated size of line buffer.
710 * count - maximum characters to read. May be NULL.
711 * llen - length_of_line(*line).
713 * appendnl - always terminate line with \n, append if necessary.
715 FL
char * fgetline(char **line
, size_t *linesize
, size_t *count
,
716 size_t *llen
, FILE *fp
, int appendnl SMALLOC_DEBUG_ARGS
);
717 #ifdef HAVE_MEMORY_DEBUG
718 # define fgetline(A,B,C,D,E,F) \
719 fgetline(A, B, C, D, E, F, __FILE__, __LINE__)
722 /* Read up a line from the specified input into the linebuffer.
723 * Return the number of characters read. Do not include the newline at EOL.
724 * n is the number of characters already read */
725 FL
int readline_restart(FILE *ibuf
, char **linebuf
, size_t *linesize
,
726 size_t n SMALLOC_DEBUG_ARGS
);
727 #ifdef HAVE_MEMORY_DEBUG
728 # define readline_restart(A,B,C,D) \
729 readline_restart(A, B, C, D, __FILE__, __LINE__)
732 /* Set up the input pointers while copying the mail file into /tmp */
733 FL
void setptr(FILE *ibuf
, off_t offset
);
735 /* Drop the passed line onto the passed output buffer. If a write error occurs
736 * return -1, else the count of characters written, including the newline */
737 FL
int putline(FILE *obuf
, char *linebuf
, size_t count
);
739 /* Determine the size of the file possessed by the passed buffer */
740 FL off_t
fsize(FILE *iob
);
742 /* Return the name of the dead.letter file */
743 FL
char const * getdeadletter(void);
745 /* Will retry FILE_LOCK_RETRIES times if pollmsecs > 0.
746 * If pollmsecs is UIZ_MAX, FILE_LOCK_MILLIS is used */
747 FL bool_t
n_file_lock(int fd
, enum n_file_lock_type flt
,
748 off_t off
, off_t len
, size_t pollmsecs
);
754 /* Set up editing on the given file name.
755 * If the first character of name is %, we are considered to be editing the
756 * file, otherwise we are reading our mail which has signficance for mbox and
758 FL
int setfile(char const *name
, enum fedit_mode fm
);
760 FL
int newmailinfo(int omsgCount
);
762 /* Set the size of the message vector used to construct argument lists to
763 * message list functions */
764 FL
void setmsize(int sz
);
766 /* Logic behind -H / -L invocations */
767 FL
void print_header_summary(char const *Larg
);
769 /* Announce the presence of the current Mail version, give the message count,
770 * and print a header listing */
771 FL
void announce(int printheaders
);
773 /* Announce information about the file we are editing. Return a likely place
775 FL
int newfileinfo(void);
777 FL
int getmdot(int nmail
);
779 FL
void initbox(char const *name
);
781 /* Determine and expand the current *folder* name, return it or the empty
782 * string also in case of errors: since POSIX mandates a default of CWD if not
783 * set etc., that seems to be a valid fallback, then */
784 FL
char const *folder_query(void);
790 /* Return the user's From: address(es) */
791 FL
char const * myaddrs(struct header
*hp
);
793 /* Boil the user's From: addresses down to a single one, or use *sender* */
794 FL
char const * myorigin(struct header
*hp
);
796 /* See if the passed line buffer, which may include trailing newline (sequence)
797 * is a mail From_ header line according to RFC 4155.
798 * If compat is true laxe POSIX syntax is instead sufficient to match From_ */
799 FL
int is_head(char const *linebuf
, size_t linelen
, bool_t compat
);
801 /* Savage extract date field from From_ line. linelen is convenience as line
802 * must be terminated (but it may end in a newline [sequence]).
803 * Return wether the From_ line was parsed successfully */
804 FL
int extract_date_from_from_(char const *line
, size_t linelen
,
805 char datebuf
[FROM_DATEBUF
]);
807 /* Extract some header fields (see e.g. -t documentation) from a message.
808 * If options&OPT_t_FLAG *and* pstate&PS_t_FLAG are both set a number of
809 * additional header fields are understood and address joining is performed as
810 * necessary, and the subject is treated with additional care, too.
811 * If pstate&PS_t_FLAG is set but OPT_t_FLAG is no more, From: will not be
813 * This calls expandaddr() on some headers and sets checkaddr_err if that is
814 * not NULL -- note it explicitly allows EAF_NAME because aliases are not
815 * expanded when this is called! */
816 FL
void extract_header(FILE *fp
, struct header
*hp
,
817 si8_t
*checkaddr_err
);
819 /* Return the desired header line from the passed message
820 * pointer (or NULL if the desired header field is not available).
821 * If mult is zero, return the content of the first matching header
822 * field only, the content of all matching header fields else */
823 FL
char * hfield_mult(char const *field
, struct message
*mp
, int mult
);
824 #define hfieldX(a, b) hfield_mult(a, b, 1)
825 #define hfield1(a, b) hfield_mult(a, b, 0)
827 /* Check whether the passed line is a header line of the desired breed.
828 * Return the field body, or 0 */
829 FL
char const * thisfield(char const *linebuf
, char const *field
);
831 /* Get sender's name from this message. If the message has a bunch of arpanet
832 * stuff in it, we may have to skin the name before returning it */
833 FL
char * nameof(struct message
*mp
, int reptype
);
835 /* Start of a "comment". Ignore it */
836 FL
char const * skip_comment(char const *cp
);
838 /* Return the start of a route-addr (address in angle brackets), if present */
839 FL
char const * routeaddr(char const *name
);
841 /* Query *expandaddr*, parse it and return flags.
842 * The flags are already adjusted for OPT_INTERACTIVE / OPT_TILDE_FLAG etc. */
843 FL
enum expand_addr_flags
expandaddr_to_eaf(void);
845 /* Check if an address is invalid, either because it is malformed or, if not,
846 * according to eacm. Return FAL0 when it looks good, TRU1 if it is invalid
847 * but the error condition wasn't covered by a 'hard "fail"ure', -1 otherwise */
848 FL si8_t
is_addr_invalid(struct name
*np
,
849 enum expand_addr_check_mode eacm
);
851 /* Does *NP* point to a file or pipe addressee? */
852 #define is_fileorpipe_addr(NP) \
853 (((NP)->n_flags & NAME_ADDRSPEC_ISFILEORPIPE) != 0)
855 /* Return skinned version of *NP*s name */
856 #define skinned_name(NP) \
857 (assert((NP)->n_flags & NAME_SKINNED), \
858 ((struct name const*)NP)->n_name)
860 /* Skin an address according to the RFC 822 interpretation of "host-phrase" */
861 FL
char * skin(char const *name
);
863 /* Skin *name* and extract the *addr-spec* according to RFC 5322.
864 * Store the result in .ag_skinned and also fill in those .ag_ fields that have
865 * actually been seen.
866 * Return 0 if something good has been parsed, 1 if fun didn't exactly know how
867 * to deal with the input, or if that was plain invalid */
868 FL
int addrspec_with_guts(int doskin
, char const *name
,
869 struct addrguts
*agp
);
871 /* Fetch the real name from an internet mail address field */
872 FL
char * realname(char const *name
);
874 /* Fetch the sender's name from the passed message. reptype can be
875 * 0 -- get sender's name for display purposes
876 * 1 -- get sender's name for reply
877 * 2 -- get sender's name for Reply */
878 FL
char * name1(struct message
*mp
, int reptype
);
880 /* Trim away all leading Re: etc., return pointer to plain subject.
881 * Note it doesn't perform any MIME decoding by itself */
882 FL
char * subject_re_trim(char *cp
);
884 FL
int msgidcmp(char const *s1
, char const *s2
);
886 /* See if the given header field is supposed to be ignored */
887 FL
int is_ign(char const *field
, size_t fieldlen
,
888 struct ignoretab igta
[2]);
890 FL
int member(char const *realfield
, struct ignoretab
*table
);
892 /* Fake Sender for From_ lines if missing, e. g. with POP3 */
893 FL
char const * fakefrom(struct message
*mp
);
895 FL
char const * fakedate(time_t t
);
897 /* From username Fri Jan 2 20:13:51 2004
900 #ifdef HAVE_IMAP_SEARCH
901 FL
time_t unixtime(char const *from
);
904 FL
time_t rfctime(char const *date
);
906 FL
time_t combinetime(int year
, int month
, int day
,
907 int hour
, int minute
, int second
);
909 FL
void substdate(struct message
*m
);
911 /* TODO Weird thing that tries to fill in From: and Sender: */
912 FL
void setup_from_and_sender(struct header
*hp
);
914 /* Note: returns 0x1 if both args were NULL */
915 FL
struct name
const * check_from_and_sender(struct name
const *fromfield
,
916 struct name
const *senderfield
);
919 FL
char * getsender(struct message
*m
);
922 /* Fill in / reedit the desired header fields */
923 FL
int grab_headers(struct header
*hp
, enum gfield gflags
,
926 /* Check wether sep->ss_sexpr (or ->ss_regex) matches any header of mp */
927 FL bool_t
header_match(struct message
*mp
, struct search_expr
const *sep
);
933 #ifdef HAVE_IMAP_SEARCH
934 FL
enum okay
imap_search(char const *spec
, int f
);
941 /* Print the docstring of `comm', which may be an abbreviation.
942 * Return FAL0 if there is no such command */
943 #ifdef HAVE_DOCSTRINGS
944 FL bool_t
n_print_comm_docstr(char const *comm
);
947 /* Interpret user commands. If stdin is not a tty, print no prompt; return
948 * wether last processed command returned error -- this is *only* for main()! */
949 FL bool_t
n_commands(void);
951 /* Actual cmd input */
953 /* Read a complete line of input, with editing if interactive and possible.
954 * If prompt is NULL we'll call getprompt() first, if necessary.
955 * nl_escape defines wether user can escape newlines via backslash (POSIX).
956 * If string is set it is used as the initial line content if in interactive
957 * mode, otherwise this argument is ignored for reproducibility.
958 * Return number of octets or a value <0 on error.
959 * Note: may use the currently `source'd file stream instead of stdin! */
960 FL
int n_lex_input(char const *prompt
, bool_t nl_escape
,
961 char **linebuf
, size_t *linesize
, char const *string
963 #ifdef HAVE_MEMORY_DEBUG
964 # define n_lex_input(A,B,C,D,E) n_lex_input(A,B,C,D,E,__FILE__,__LINE__)
967 /* Read a line of input, with editing if interactive and possible, return it
968 * savestr()d or NULL in case of errors or if an empty line would be returned.
969 * This may only be called from toplevel (not during PS_ROBOT).
970 * If prompt is NULL we'll call getprompt() if necessary.
971 * If string is set it is used as the initial line content if in interactive
972 * mode, otherwise this argument is ignored for reproducibility.
973 * If OPT_INTERACTIVE a non-empty return is saved in the history, isgabby */
974 FL
char * n_lex_input_cp_addhist(char const *prompt
, char const *string
,
977 /* Deal with loading of resource files and dealing with a stack of files for
978 * the source command */
980 /* Load a file of user definitions -- this is *only* for main()! */
981 FL
void n_load(char const *name
);
983 /* "Load" all the -X command line definitions in order -- *only* for main() */
984 FL
void n_load_Xargs(char const **lines
);
986 /* Pushdown current input file and switch to a new one. Set the global flag
987 * PS_SOURCING so that others will realize that they are no longer reading from
988 * a tty (in all probability).
989 * The latter won't return failure (TODO should be replaced by "-f FILE") */
990 FL
int c_source(void *v
);
991 FL
int c_source_if(void *v
);
993 /* Evaluate a complete macro / a single command. For the former lines will
994 * always be free()d, for the latter cmd will always be duplicated internally */
995 FL bool_t
n_source_macro(char const *name
, char **lines
);
996 FL bool_t
n_source_command(char const *cmd
);
998 /* XXX Hack: may we release our (interactive) (terminal) control to a different
999 * XXX program, e.g., a $PAGER? */
1000 FL bool_t
n_source_may_yield_control(void);
1006 /* Return a file buffer all ready to read up the passed message pointer */
1007 FL
FILE * setinput(struct mailbox
*mp
, struct message
*m
,
1008 enum needspec need
);
1011 FL
enum okay
get_body(struct message
*mp
);
1013 /* Reset (free) the global message array */
1014 FL
void message_reset(void);
1016 /* Append the passed message descriptor onto the message array; if mp is NULL,
1017 * NULLify the entry at &[msgCount-1] */
1018 FL
void message_append(struct message
*mp
);
1020 /* Append a NULL message */
1021 FL
void message_append_null(void);
1023 /* Check wether sep->ss_sexpr (or ->ss_regex) matches mp. If with_headers is
1024 * true then the headers will also be searched (as plain text) */
1025 FL bool_t
message_match(struct message
*mp
, struct search_expr
const *sep
,
1026 bool_t with_headers
);
1029 FL
struct message
* setdot(struct message
*mp
);
1031 /* Touch the named message by setting its MTOUCH flag. Touched messages have
1032 * the effect of not being sent back to the system mailbox on exit */
1033 FL
void touch(struct message
*mp
);
1035 /* Convert user string of message numbers and store the numbers into vector.
1036 * Returns the count of messages picked up or -1 on error */
1037 FL
int getmsglist(char *buf
, int *vector
, int flags
);
1039 /* Find the first message whose flags&m==f and return its message number */
1040 FL
int first(int f
, int m
);
1042 /* Mark the named message by setting its mark bit */
1043 FL
void mark(int mesg
, int f
);
1049 FL
int maildir_setfile(char const *name
, enum fedit_mode fm
);
1051 FL bool_t
maildir_quit(void);
1053 FL
enum okay
maildir_append(char const *name
, FILE *fp
, long offset
);
1055 FL
enum okay
maildir_remove(char const *name
);
1061 /* Quit quickly. In recursed state, return error to just pop the input level */
1062 FL
int c_exit(void *v
);
1068 /* Try to use alloca() for some function-local buffers and data, fall back to
1069 * smalloc()/free() if not available */
1072 # define ac_alloc(n) HAVE_ALLOCA(n)
1073 # define ac_free(n) do {UNUSED(n);} while (0)
1075 # define ac_alloc(n) smalloc(n)
1076 # define ac_free(n) free(n)
1079 /* Generic heap memory */
1081 FL
void * smalloc(size_t s SMALLOC_DEBUG_ARGS
);
1082 FL
void * srealloc(void *v
, size_t s SMALLOC_DEBUG_ARGS
);
1083 FL
void * scalloc(size_t nmemb
, size_t size SMALLOC_DEBUG_ARGS
);
1085 #ifdef HAVE_MEMORY_DEBUG
1086 FL
void sfree(void *v SMALLOC_DEBUG_ARGS
);
1088 /* Called by sreset(), then */
1089 FL
void n_memreset(void);
1091 FL
int c_memtrace(void *v
);
1093 /* For immediate debugging purposes, it is possible to check on request */
1094 FL bool_t
n__memcheck(char const *file
, int line
);
1096 # define smalloc(SZ) smalloc(SZ, __FILE__, __LINE__)
1097 # define srealloc(P,SZ) srealloc(P, SZ, __FILE__, __LINE__)
1098 # define scalloc(N,SZ) scalloc(N, SZ, __FILE__, __LINE__)
1099 # define free(P) sfree(P, __FILE__, __LINE__)
1100 # define c_memtrace c_memtrace
1101 # define n_memcheck() n__memcheck(__FILE__, __LINE__)
1103 # define n_memreset() do{}while(0)
1106 /* String storage, auto-reclaimed after execution level is left */
1108 /* Allocate size more bytes of space and return the address of the first byte
1109 * to the caller. An even number of bytes are always allocated so that the
1110 * space will always be on a word boundary */
1111 FL
void * salloc(size_t size SALLOC_DEBUG_ARGS
);
1112 FL
void * csalloc(size_t nmemb
, size_t size SALLOC_DEBUG_ARGS
);
1113 #ifdef HAVE_MEMORY_DEBUG
1114 # define salloc(SZ) salloc(SZ, __FILE__, __LINE__)
1115 # define csalloc(NM,SZ) csalloc(NM, SZ, __FILE__, __LINE__)
1118 /* Auto-reclaim string storage; if only_if_relaxed is true then only perform
1119 * the reset when a srelax_hold() is currently active */
1120 FL
void sreset(bool_t only_if_relaxed
);
1122 /* The "problem" with sreset() is that it releases all string storage except
1123 * what was present once spreserve() had been called; it therefore cannot be
1124 * called from all that code which yet exists and walks about all the messages
1125 * in order, e.g. quit(), searches, etc., because, unfortunately, these code
1126 * paths are reached with new intermediate string dope already in use.
1127 * Thus such code should take a srelax_hold(), successively call srelax() after
1128 * a single message has been handled, and finally srelax_rele() (unless it is
1129 * clear that sreset() occurs anyway) */
1130 FL
void srelax_hold(void);
1131 FL
void srelax_rele(void);
1132 FL
void srelax(void);
1134 /* Make current string storage permanent: new allocs will be auto-reclaimed by
1135 * sreset(). This is called once only, from within main() */
1136 FL
void spreserve(void);
1138 /* 'sstats' command */
1139 #ifdef HAVE_MEMORY_DEBUG
1140 FL
int c_sstats(void *v
);
1141 # define c_sstats c_sstats
1148 /* *charset-7bit*, else CHARSET_7BIT */
1149 FL
char const * charset_get_7bit(void);
1151 /* *charset-8bit*, else CHARSET_8BIT */
1153 FL
char const * charset_get_8bit(void);
1156 /* LC_CTYPE:CODESET / *ttycharset*, else *charset-8bit*, else CHARSET_8BIT */
1157 FL
char const * charset_get_lc(void);
1159 /* *sendcharsets* .. *charset-8bit* iterator; *a_charset_to_try_first* may be
1160 * used to prepend a charset to this list (e.g., for *reply-in-same-charset*).
1161 * The returned boolean indicates charset_iter_is_valid().
1162 * Without HAVE_ICONV, this "iterates" over charset_get_lc() only */
1163 FL bool_t
charset_iter_reset(char const *a_charset_to_try_first
);
1164 FL bool_t
charset_iter_next(void);
1165 FL bool_t
charset_iter_is_valid(void);
1166 FL
char const * charset_iter(void);
1168 /* And this is (xxx temporary?) which returns the iterator if that is valid and
1169 * otherwise either charset_get_8bit() or charset_get_lc() dep. on HAVE_ICONV */
1170 FL
char const * charset_iter_or_fallback(void);
1172 FL
void charset_iter_recurse(char *outer_storage
[2]); /* TODO LEGACY */
1173 FL
void charset_iter_restore(char *outer_storage
[2]); /* TODO LEGACY */
1175 /* Check wether our headers will need MIME conversion */
1177 FL
char const * need_hdrconv(struct header
*hp
);
1180 /* Convert header fields from RFC 1522 format */
1181 FL
void mime_fromhdr(struct str
const *in
, struct str
*out
,
1182 enum tdflags flags
);
1184 /* Interpret MIME strings in parts of an address field */
1185 FL
char * mime_fromaddr(char const *name
);
1187 /* fwrite(3) performing the given MIME conversion */
1188 FL ssize_t
mime_write(char const *ptr
, size_t size
, FILE *f
,
1189 enum conversion convert
, enum tdflags dflags
,
1190 struct quoteflt
*qf
, struct str
*rest
);
1191 FL ssize_t
xmime_write(char const *ptr
, size_t size
, /* TODO LEGACY */
1192 FILE *f
, enum conversion convert
, enum tdflags dflags
);
1196 * Content-Transfer-Encodings as defined in RFC 2045 (and RFC 2047):
1197 * - Quoted-Printable, section 6.7
1198 * - Base64, section 6.8
1199 * TODO for now this is pretty mixed up regarding this external interface.
1200 * TODO in v15.0 CTE will be filter based, and explicit conversion will
1201 * TODO gain clear error codes
1204 /* Default MIME Content-Transfer-Encoding: as via *encoding* */
1205 FL
enum mime_enc
mime_enc_target(void);
1207 /* Map from a Content-Transfer-Encoding: header body (which may be NULL) */
1208 FL
enum mime_enc
mime_enc_from_ctehead(char const *hbody
);
1210 /* XXX Try to get rid of that */
1211 FL
char const * mime_enc_from_conversion(enum conversion
const convert
);
1213 /* How many characters of (the complete body) ln need to be quoted.
1214 * Only MIMEEF_ISHEAD and MIMEEF_ISENCWORD are understood */
1215 FL
size_t mime_enc_mustquote(char const *ln
, size_t lnlen
,
1216 enum mime_enc_flags flags
);
1218 /* How much space is necessary to encode len bytes in QP, worst case.
1219 * Includes room for terminator */
1220 FL
size_t qp_encode_calc_size(size_t len
);
1222 /* If flags includes QP_ISHEAD these assume "word" input and use special
1223 * quoting rules in addition; soft line breaks are not generated.
1224 * Otherwise complete input lines are assumed and soft line breaks are
1225 * generated as necessary */
1226 FL
struct str
* qp_encode(struct str
*out
, struct str
const *in
,
1227 enum qpflags flags
);
1229 FL
struct str
* qp_encode_cp(struct str
*out
, char const *cp
,
1230 enum qpflags flags
);
1231 FL
struct str
* qp_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
1232 enum qpflags flags
);
1235 /* If rest is set then decoding will assume body text input (assumes input
1236 * represents lines, only create output when input didn't end with soft line
1237 * break [except it finalizes an encoded CRLF pair]), otherwise it is assumed
1238 * to decode a header strings and (1) uses special decoding rules and (b)
1239 * directly produces output.
1240 * The buffers of out and possibly rest will be managed via srealloc().
1241 * Returns OKAY. XXX or STOP on error (in which case out is set to an error
1242 * XXX message); caller is responsible to free buffers */
1243 FL
int qp_decode(struct str
*out
, struct str
const *in
,
1246 /* How much space is necessary to encode len bytes in Base64, worst case.
1247 * Includes room for (CR/LF/CRLF and) terminator */
1248 FL
size_t b64_encode_calc_size(size_t len
);
1250 /* Note these simply convert all the input (if possible), including the
1251 * insertion of NL sequences if B64_CRLF or B64_LF is set (and multiple thereof
1252 * if B64_MULTILINE is set).
1253 * Thus, in the B64_BUF case, better call b64_encode_calc_size() first */
1254 FL
struct str
* b64_encode(struct str
*out
, struct str
const *in
,
1255 enum b64flags flags
);
1256 FL
struct str
* b64_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
1257 enum b64flags flags
);
1259 FL
struct str
* b64_encode_cp(struct str
*out
, char const *cp
,
1260 enum b64flags flags
);
1263 /* If rest is set then decoding will assume text input.
1264 * The buffers of out and possibly rest will be managed via srealloc().
1265 * Returns OKAY or STOP on error (in which case out is set to an error
1266 * message); caller is responsible to free buffers.
1267 * XXX STOP is effectively not returned for text input (rest!=NULL), instead
1268 * XXX replacement characters are produced for invalid data */
1269 FL
int b64_decode(struct str
*out
, struct str
const *in
,
1276 /* Get a mime style parameter from a header body */
1277 FL
char * mime_param_get(char const *param
, char const *headerbody
);
1279 /* Format parameter name to have value, salloc() it or NULL (error) in result.
1280 * 0 on error, 1 or -1 on success: the latter if result contains \n newlines,
1281 * which it will if the created param requires more than MIME_LINELEN bytes;
1282 * there is never a trailing newline character */
1283 /* TODO mime_param_create() should return a StrList<> or something.
1284 * TODO in fact it should take a HeaderField* and append a HeaderFieldParam*! */
1285 FL si8_t
mime_param_create(struct str
*result
, char const *name
,
1288 /* Get the boundary out of a Content-Type: multipart/xyz header field, return
1289 * salloc()ed copy of it; store strlen() in *len if set */
1290 FL
char * mime_param_boundary_get(char const *headerbody
, size_t *len
);
1292 /* Create a salloc()ed MIME boundary */
1293 FL
char * mime_param_boundary_create(void);
1299 /* Create MIME part object tree for and of mp */
1300 FL
struct mimepart
* mime_parse_msg(struct message
*mp
,
1301 enum mime_parse_flags mpf
);
1307 /* `(un)?mimetype' commands */
1308 FL
int c_mimetype(void *v
);
1309 FL
int c_unmimetype(void *v
);
1311 /* Check wether the Content-Type name is internally known */
1312 FL bool_t
mime_type_check_mtname(char const *name
);
1314 /* Return a Content-Type matching the name, or NULL if none could be found */
1315 FL
char * mime_type_classify_filename(char const *name
);
1317 /* Classify content of *fp* as necessary and fill in arguments; **charset* is
1318 * left alone unless it's non-NULL */
1319 FL
enum conversion
mime_type_classify_file(FILE *fp
, char const **contenttype
,
1320 char const **charset
, int *do_iconv
);
1322 /* Dependend on *mime-counter-evidence* mpp->m_ct_type_usr_ovwr will be set,
1323 * but otherwise mpp is const */
1324 FL
enum mimecontent
mime_type_classify_part(struct mimepart
*mpp
);
1326 /* Query handler for a part, return the plain type (& MIME_HDL_TYPE_MASK).
1327 * mhp is anyway initialized (mh_flags, mh_msg) */
1328 FL
enum mime_handler_flags
mime_type_handler(struct mime_handler
*mhp
,
1329 struct mimepart
const *mpp
,
1330 enum sendaction action
);
1336 /* Allocate a single element of a name list, initialize its name field to the
1337 * passed name and return it */
1338 FL
struct name
* nalloc(char *str
, enum gfield ntype
);
1340 /* Like nalloc(), but initialize from content of np */
1341 FL
struct name
* ndup(struct name
*np
, enum gfield ntype
);
1343 /* Concatenate the two passed name lists, return the result */
1344 FL
struct name
* cat(struct name
*n1
, struct name
*n2
);
1347 FL
struct name
* namelist_dup(struct name
const *np
, enum gfield ntype
);
1349 /* Determine the number of undeleted elements in a name list and return it;
1350 * the latter also doesn't count file and pipe addressees in addition */
1351 FL ui32_t
count(struct name
const *np
);
1352 FL ui32_t
count_nonlocal(struct name
const *np
);
1354 /* Extract a list of names from a line, and make a list of names from it.
1355 * Return the list or NULL if none found */
1356 FL
struct name
* extract(char const *line
, enum gfield ntype
);
1358 /* Like extract() unless line contains anyof ",\"\\(<|", in which case
1359 * comma-separated list extraction is used instead */
1360 FL
struct name
* lextract(char const *line
, enum gfield ntype
);
1362 /* Turn a list of names into a string of the same names */
1363 FL
char * detract(struct name
*np
, enum gfield ntype
);
1365 /* Get a lextract() list via n_lex_input_cp_addhist(), reassigning to *np* */
1366 FL
struct name
* grab_names(char const *field
, struct name
*np
, int comma
,
1367 enum gfield gflags
);
1369 /* Check wether n1 n2 share the domain name */
1370 FL bool_t
name_is_same_domain(struct name
const *n1
,
1371 struct name
const *n2
);
1373 /* Check all addresses in np and delete invalid ones; if set_on_error is not
1374 * NULL it'll be set to TRU1 for error or -1 for "hard fail" error */
1375 FL
struct name
* checkaddrs(struct name
*np
, enum expand_addr_check_mode eacm
,
1376 si8_t
*set_on_error
);
1378 /* Vaporise all duplicate addresses in hp (.h_(to|cc|bcc)) so that an address
1379 * that "first" occurs in To: is solely in there, ditto Cc:, after expanding
1380 * aliases etc. eacm and set_on_error are passed to checkaddrs(), metoo is
1381 * passed to usermap(). After updating hp to the new state this returns
1382 * a flat list of all addressees, which may be NULL */
1383 FL
struct name
* namelist_vaporise_head(struct header
*hp
,
1384 enum expand_addr_check_mode eacm
, bool_t metoo
,
1385 si8_t
*set_on_error
);
1387 /* Map all of the aliased users in the invoker's mailrc file and insert them
1389 FL
struct name
* usermap(struct name
*names
, bool_t force_metoo
);
1391 /* Remove all of the duplicates from the passed name list by insertion sorting
1392 * them, then checking for dups. Return the head of the new list */
1393 FL
struct name
* elide(struct name
*names
);
1395 /* `alternates' deal with the list of alternate names */
1396 FL
int c_alternates(void *v
);
1398 FL
struct name
* delete_alternates(struct name
*np
);
1400 FL
int is_myname(char const *name
);
1403 FL
int c_alias(void *v
);
1404 FL
int c_unalias(void *v
);
1406 /* `(un)?ml(ist|subscribe)', and a check wether a name is a (wanted) list */
1407 FL
int c_mlist(void *v
);
1408 FL
int c_unmlist(void *v
);
1409 FL
int c_mlsubscribe(void *v
);
1410 FL
int c_unmlsubscribe(void *v
);
1412 FL
enum mlist_state
is_mlist(char const *name
, bool_t subscribed_only
);
1414 /* `(un)?shortcut', and check if str is one, return expansion or NULL */
1415 FL
int c_shortcut(void *v
);
1416 FL
int c_unshortcut(void *v
);
1418 FL
char const * shortcut_expand(char const *str
);
1420 /* `(un)?customhdr'.
1421 * Query a list of all currently defined custom headers (salloc()ed) */
1422 FL
int c_customhdr(void *v
);
1423 FL
int c_uncustomhdr(void *v
);
1425 FL
struct n_header_field
* n_customhdr_query(void);
1433 FL
enum okay
ssl_open(struct url
const *urlp
, struct sock
*sp
);
1436 FL
void ssl_gen_err(char const *fmt
, ...);
1439 FL
int c_verify(void *vp
);
1442 FL
FILE * smime_sign(FILE *ip
, char const *addr
);
1445 FL
FILE * smime_encrypt(FILE *ip
, char const *certfile
, char const *to
);
1447 FL
struct message
* smime_decrypt(struct message
*m
, char const *to
,
1448 char const *cc
, int signcall
);
1451 FL
enum okay
smime_certsave(struct message
*m
, int n
, FILE *op
);
1453 #else /* HAVE_OPENSSL */
1454 # define c_verify c_cmdnotsupp
1461 /* Test to see if the passed file name is a directory, return true if it is */
1462 FL bool_t
is_dir(char const *name
);
1464 /* Recursively create a directory */
1465 FL bool_t
n_path_mkdir(char const *name
);
1467 /* Delete a file, but only if the file is a plain file; return FAL0 on system
1468 * error and TRUM1 if name is not a plain file, return TRU1 on success */
1469 FL bool_t
n_path_rm(char const *name
);
1471 /* A get-wd..restore-wd approach */
1472 FL
enum okay
cwget(struct cw
*cw
);
1473 FL
enum okay
cwret(struct cw
*cw
);
1474 FL
void cwrelse(struct cw
*cw
);
1482 FL
enum okay
pop3_noop(void);
1485 FL
int pop3_setfile(char const *server
, enum fedit_mode fm
);
1488 FL
enum okay
pop3_header(struct message
*m
);
1491 FL
enum okay
pop3_body(struct message
*m
);
1494 FL bool_t
pop3_quit(void);
1495 #endif /* HAVE_POP3 */
1499 * Subprocesses, popen, but also file handling with registering
1502 /* For program startup in main.c: initialize process manager */
1503 FL
void command_manager_start(void);
1505 /* Notes: OF_CLOEXEC is implied in oflags, xflags may be NULL */
1506 FL
FILE * safe_fopen(char const *file
, char const *oflags
, int *xflags
);
1508 /* Notes: OF_CLOEXEC|OF_REGISTER are implied in oflags!
1509 * Exception is Fdopen() if nocloexec is TRU1, but otherwise even for it the fd
1510 * creator has to take appropriate steps in order to ensure this is true! */
1511 FL
FILE * Fopen(char const *file
, char const *oflags
);
1512 FL
FILE * Fdopen(int fd
, char const *oflags
, bool_t nocloexec
);
1514 FL
int Fclose(FILE *fp
);
1516 /* Open file according to oflags (see popen.c). Handles compressed files */
1517 FL
FILE * Zopen(char const *file
, char const *oflags
);
1519 /* Create a temporary file in tempdir, use namehint for its name (prefix
1520 * unless OF_SUFFIX is set, in which case namehint is an extension that MUST be
1521 * part of the resulting filename, otherwise Ftmp() will fail), store the
1522 * unique name in fn (unless OF_UNLINK is set in oflags), and return a stdio
1523 * FILE pointer with access oflags. OF_CLOEXEC is implied in oflags.
1524 * One of OF_WRONLY and OF_RDWR must be set. Mode of 0600 is implied */
1525 FL
FILE * Ftmp(char **fn
, char const *namehint
, enum oflags oflags
);
1527 /* If OF_HOLDSIGS was set when calling Ftmp(), then hold_all_sigs() had been
1528 * called: call this to unlink(2) and free *fn and to rele_all_sigs() */
1529 FL
void Ftmp_release(char **fn
);
1531 /* Free the resources associated with the given filename. To be called after
1533 FL
void Ftmp_free(char **fn
);
1535 /* Create a pipe and ensure CLOEXEC bit is set in both descriptors */
1536 FL bool_t
pipe_cloexec(int fd
[2]);
1539 * env_addon may be NULL, otherwise it is expected to be a NULL terminated
1540 * array of "K=V" strings to be placed into the childs environment.
1541 * If cmd==(char*)-1 then shell is indeed expected to be a PTF :P that will be
1542 * called from within the child process */
1543 FL
FILE * Popen(char const *cmd
, char const *mode
, char const *shell
,
1544 char const **env_addon
, int newfd1
);
1545 FL bool_t
Pclose(FILE *fp
, bool_t dowait
);
1547 /* In OPT_INTERACTIVE, we want to go over $PAGER.
1548 * These are specialized version of Popen()/Pclose() which also encapsulate
1549 * error message printing, terminal handling etc. additionally */
1550 FL
FILE * n_pager_open(void);
1551 FL bool_t
n_pager_close(FILE *fp
);
1554 FL
void close_all_files(void);
1556 /* Fork a child process, enable use of the *child() series below */
1557 FL
int fork_child(void);
1559 /* Run a command without a shell, with optional arguments and splicing of stdin
1560 * and stdout. FDs may also be COMMAND_FD_NULL and COMMAND_FD_PASS, meaning to
1561 * redirect from/to /dev/null or pass through our own set of FDs; in the
1562 * latter case terminal capabilities are saved/restored if possible.
1563 * The command name can be a sequence of words.
1564 * Signals must be handled by the caller. "Mask" contains the signals to
1565 * ignore in the new process. SIGINT is enabled unless it's in the mask.
1566 * env_addon may be NULL, otherwise it is expected to be a NULL terminated
1567 * array of "K=V" strings to be placed into the childs environment */
1568 FL
int run_command(char const *cmd
, sigset_t
*mask
, int infd
,
1569 int outfd
, char const *a0
, char const *a1
, char const *a2
,
1570 char const **env_addon
);
1572 /* Like run_command, but don't wait for the command to finish.
1573 * Also it is usually an error to use COMMAND_FD_PASS for this one */
1574 FL
int start_command(char const *cmd
, sigset_t
*mask
, int infd
,
1575 int outfd
, char const *a0
, char const *a1
, char const *a2
,
1576 char const **env_addon
);
1578 /* In-child process */
1579 FL
void prepare_child(sigset_t
*nset
, int infd
, int outfd
);
1581 /* Mark a child as don't care - pid */
1582 FL
void free_child(int pid
);
1584 /* Wait for pid, return wether we've had a normal EXIT_SUCCESS exit.
1585 * If wait_status is set, set it to the reported waitpid(2) wait status */
1586 FL bool_t
wait_child(int pid
, int *wait_status
);
1592 /* Save all of the undetermined messages at the top of "mbox". Save all
1593 * untouched messages back in the system mailbox. Remove the system mailbox,
1594 * if none saved there */
1595 FL bool_t
quit(void);
1597 /* Adjust the message flags in each message */
1598 FL
int holdbits(void);
1600 /* Create another temporary file and copy user's mbox file darin. If there is
1601 * no mbox, copy nothing. If he has specified "append" don't copy his mailbox,
1602 * just copy saveable entries at the end */
1603 FL
enum okay
makembox(void);
1605 FL
void save_mbox_for_possible_quitstuff(void); /* TODO DROP IF U CAN */
1607 FL
int savequitflags(void);
1609 FL
void restorequitflags(int);
1615 /* Send message described by the passed pointer to the passed output buffer.
1616 * Return -1 on error. Adjust the status: field if need be. If doign is
1617 * given, suppress ignored header fields. prefix is a string to prepend to
1618 * each output line. action = data destination
1619 * (SEND_MBOX,_TOFILE,_TODISP,_QUOTE,_DECRYPT). stats[0] is line count,
1620 * stats[1] is character count. stats may be NULL. Note that stats[0] is
1621 * valid for SEND_MBOX only */
1622 FL
int sendmp(struct message
*mp
, FILE *obuf
, struct ignoretab
*doign
,
1623 char const *prefix
, enum sendaction action
, ui64_t
*stats
);
1629 /* Interface between the argument list and the mail1 routine which does all the
1631 FL
int mail(struct name
*to
, struct name
*cc
, struct name
*bcc
,
1632 char *subject
, struct attachment
*attach
, char *quotefile
,
1633 int recipient_record
);
1635 /* `mail' and `Mail' commands, respectively */
1636 FL
int c_sendmail(void *v
);
1637 FL
int c_Sendmail(void *v
);
1639 /* Mail a message on standard input to the people indicated in the passed
1640 * header. (Internal interface) */
1641 FL
enum okay
mail1(struct header
*hp
, int printheaders
,
1642 struct message
*quote
, char *quotefile
, int recipient_record
,
1645 /* Create a Date: header field.
1646 * We compare the localtime() and gmtime() results to get the timezone, because
1647 * numeric timezones are easier to read and because $TZ isn't always set */
1648 FL
int mkdate(FILE *fo
, char const *field
);
1650 /* Dump the to, subject, cc header on the passed file buffer.
1651 * nosend_msg tells us not to dig to deep but to instead go for compose mode or
1652 * editing a message (yet we're stupid and cannot do it any better) - if it is
1653 * TRUM1 then we're really in compose mode and will produce some fields for
1654 * easier filling in */
1655 FL
int puthead(bool_t nosend_msg
, struct header
*hp
, FILE *fo
,
1656 enum gfield w
, enum sendaction action
,
1657 enum conversion convert
, char const *contenttype
,
1658 char const *charset
);
1661 FL
enum okay
resend_msg(struct message
*mp
, struct name
*to
, int add_resent
);
1667 /* Evaluate the string given as a new mailbox name. Supported meta characters:
1668 * . % for my system mail box
1669 * . %user for user's system mail box
1670 * . # for previous file
1671 * . & invoker's mbox file
1672 * . +file file in folder directory
1673 * . any shell meta character (except for FEXP_NSHELL).
1674 * a poor man's vis(3), on name before calling this (and showing the user).
1675 * If FEXP_MULTIOK is set we return an array of terminated strings, the (last)
1676 * result string is terminated via \0\0 and PS_EXPAND_MULTIRESULT is set.
1677 * Returns the file name as an auto-reclaimed string */
1678 FL
char * fexpand(char const *name
, enum fexp_mode fexpm
);
1680 #define expand(N) fexpand(N, FEXP_FULL) /* XXX obsolete */
1681 #define file_expand(N) fexpand(N, FEXP_LOCAL) /* XXX obsolete */
1683 /* Check wether *s is an escape sequence, expand it as necessary.
1684 * Returns the expanded sequence or 0 if **s is NUL or PROMPT_STOP if it is \c.
1685 * *s is advanced to after the expanded sequence (as possible).
1686 * If use_prompt_extensions is set, an enum prompt_exp may be returned */
1687 FL
int n_shell_expand_escape(char const **s
,
1688 bool_t use_prompt_extensions
);
1690 /* Parse the next shell token from input (->s and ->l are adjusted to the
1691 * remains, data is constant beside that; ->s may be NULL if ->l is 0, if ->l
1692 * EQ UIZ_MAX strlen(->s) is used) and append the resulting output to store */
1693 FL
enum n_shexp_state
n_shell_parse_token(struct n_string
*store
,
1694 struct str
*input
, enum n_shexp_parse_flags flags
);
1696 /* Likewise, but strips n_SHEXP_STATE_STOP if input remains after parsing,
1697 * otherwise forcefully sets it. Returns autoreclaimed storage */
1698 FL
enum n_shexp_state
n_shell_parse_token_buf(char **store
,
1699 char const *indat
, size_t inlen
,
1700 enum n_shexp_parse_flags flags
);
1702 /* Quote input in a way that can, in theory, be fed into parse_token() again.
1703 * ->s may be NULL if ->l is 0, if ->l EQ UIZ_MAX strlen(->s) is used.
1704 * If rndtrip is true we try to make the resulting string "portable" (by
1705 * converting Unicode to \u etc.), otherwise we produce something to be
1706 * consumed "now", i.e., to display for the user.
1707 * Resulting output is _appended_ to store.
1708 * TODO Note: last resort, since \u and $ expansions etc. are necessarily
1709 * TODO already expanded and can thus not be reverted, but ALL we have */
1710 FL
struct n_string
*n_shell_quote(struct n_string
*store
,
1711 struct str
const *input
, bool_t rndtrip
);
1712 FL
char * n_shell_quote_cp(char const *cp
, bool_t rndtrip
);
1718 FL
void n_raise(int signo
);
1720 /* Provide BSD-like signal() on all systems TODO v15 -> SysV -> n_signal() */
1721 FL sighandler_type
safe_signal(int signum
, sighandler_type handler
);
1723 /* Provide reproducable non-restartable signal handler installation */
1724 FL n_sighdl_t
n_signal(int signo
, n_sighdl_t hdl
);
1726 /* Hold *all* signals but SIGCHLD, and release that total block again */
1727 FL
void hold_all_sigs(void);
1728 FL
void rele_all_sigs(void);
1730 /* Hold HUP/QUIT/INT */
1731 FL
void hold_sigs(void);
1732 FL
void rele_sigs(void);
1734 /* Call _ENTER_SWITCH() with the according flags, it'll take care for the rest
1735 * and also set the jump buffer - it returns 0 if anything went fine and
1736 * a signal number if a jump occurred, in which case all handlers requested in
1737 * flags are temporarily SIG_IGN.
1738 * _cleanup_ping() informs the condome that no jumps etc. shall be performed
1739 * until _leave() is called in the following -- to be (optionally) called right
1740 * before the local jump label is reached which is jumped to after a long jump
1741 * occurred, straight code flow provided, e.g., to avoid destructors to be
1742 * called twice. _leave() must always be called last, reraise_flags will be
1743 * used to decide how signal handling has to continue
1745 #define n_SIGMAN_ENTER_SWITCH(S,F) do{\
1748 if(sigsetjmp((S)->sm_jump, 1))\
1752 n__sigman_enter(S, __x__);\
1753 }while(0); switch((S)->sm_signo)
1754 FL
int n__sigman_enter(struct n_sigman
*self
, int flags
);
1755 FL
void n_sigman_cleanup_ping(struct n_sigman
*self
);
1756 FL
void n_sigman_leave(struct n_sigman
*self
, enum n_sigman_flags flags
);
1758 /* Pending signal or 0? */
1759 FL
int n_sigman_peek(void);
1760 FL
void n_sigman_consume(void);
1762 /* Not-Yet-Dead debug information (handler installation in main.c) */
1763 #if defined HAVE_DEBUG || defined HAVE_DEVEL
1764 FL
void _nyd_chirp(ui8_t act
, char const *file
, ui32_t line
,
1766 FL
void _nyd_oncrash(int signo
);
1769 # define NYD_ENTER _nyd_chirp(1, __FILE__, __LINE__, __FUN__)
1770 # define NYD_LEAVE _nyd_chirp(2, __FILE__, __LINE__, __FUN__)
1771 # define NYD _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
1772 # define NYD_X _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
1774 # define NYD2_ENTER _nyd_chirp(1, __FILE__, __LINE__, __FUN__)
1775 # define NYD2_LEAVE _nyd_chirp(2, __FILE__, __LINE__, __FUN__)
1776 # define NYD2 _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
1782 # define NYD_ENTER do {} while (0)
1783 # define NYD_LEAVE do {} while (0)
1784 # define NYD do {} while (0)
1785 # define NYD_X do {} while (0) /* XXX LEGACY */
1788 # define NYD2_ENTER do {} while (0)
1789 # define NYD2_LEAVE do {} while (0)
1790 # define NYD2 do {} while (0)
1798 /* Send a message via SMTP */
1799 FL bool_t
smtp_mta(struct sendbundle
*sbp
);
1807 FL bool_t
sopen(struct sock
*sp
, struct url
*urlp
);
1808 FL
int sclose(struct sock
*sp
);
1809 FL
enum okay
swrite(struct sock
*sp
, char const *data
);
1810 FL
enum okay
swrite1(struct sock
*sp
, char const *data
, int sz
,
1814 FL
int sgetline(char **line
, size_t *linesize
, size_t *linelen
,
1815 struct sock
*sp SMALLOC_DEBUG_ARGS
);
1816 # ifdef HAVE_MEMORY_DEBUG
1817 # define sgetline(A,B,C,D) sgetline(A, B, C, D, __FILE__, __LINE__)
1826 /* Direct mappings of the various spam* commands */
1827 FL
int c_spam_clear(void *v
);
1828 FL
int c_spam_set(void *v
);
1829 FL
int c_spam_forget(void *v
);
1830 FL
int c_spam_ham(void *v
);
1831 FL
int c_spam_rate(void *v
);
1832 FL
int c_spam_spam(void *v
);
1834 # define c_spam_clear c_cmdnotsupp
1835 # define c_spam_set c_cmdnotsupp
1836 # define c_spam_forget c_cmdnotsupp
1837 # define c_spam_ham c_cmdnotsupp
1838 # define c_spam_rate c_cmdnotsupp
1839 # define c_spam_spam c_cmdnotsupp
1848 FL
void ssl_set_verify_level(struct url
const *urlp
);
1851 FL
enum okay
ssl_verify_decide(void);
1854 FL
enum okay
smime_split(FILE *ip
, FILE **hp
, FILE **bp
, long xcount
,
1858 FL
FILE * smime_sign_assemble(FILE *hp
, FILE *bp
, FILE *sp
,
1859 char const *message_digest
);
1862 FL
FILE * smime_encrypt_assemble(FILE *hp
, FILE *yp
);
1865 FL
struct message
* smime_decrypt_assemble(struct message
*m
, FILE *hp
,
1869 FL
int c_certsave(void *v
);
1872 FL
enum okay
rfc2595_hostname_match(char const *host
, char const *pattern
);
1873 #else /* HAVE_SSL */
1874 # define c_certsave c_cmdnotsupp
1881 /* Return a pointer to a dynamic copy of the argument */
1882 FL
char * savestr(char const *str SALLOC_DEBUG_ARGS
);
1883 FL
char * savestrbuf(char const *sbuf
, size_t sbuf_len SALLOC_DEBUG_ARGS
);
1884 #ifdef HAVE_MEMORY_DEBUG
1885 # define savestr(CP) savestr(CP, __FILE__, __LINE__)
1886 # define savestrbuf(CBP,CBL) savestrbuf(CBP, CBL, __FILE__, __LINE__)
1889 /* Concatenate cp2 onto cp1 (if not NULL), separated by sep (if not '\0') */
1890 FL
char * savecatsep(char const *cp1
, char sep
, char const *cp2
1892 #ifdef HAVE_MEMORY_DEBUG
1893 # define savecatsep(S1,SEP,S2) savecatsep(S1, SEP, S2, __FILE__, __LINE__)
1896 /* Make copy of argument incorporating old one, if set, separated by space */
1897 #define save2str(S,O) savecatsep(O, ' ', S)
1900 #define savecat(S1,S2) savecatsep(S1, '\0', S2)
1902 /* Create duplicate, lowercasing all characters along the way */
1903 FL
char * i_strdup(char const *src SALLOC_DEBUG_ARGS
);
1904 #ifdef HAVE_MEMORY_DEBUG
1905 # define i_strdup(CP) i_strdup(CP, __FILE__, __LINE__)
1909 FL
struct str
* str_concat_csvl(struct str
*self
, ...);
1912 FL
struct str
* str_concat_cpa(struct str
*self
, char const * const *cpa
,
1913 char const *sep_o_null SALLOC_DEBUG_ARGS
);
1914 #ifdef HAVE_MEMORY_DEBUG
1915 # define str_concat_cpa(S,A,N) str_concat_cpa(S, A, N, __FILE__, __LINE__)
1918 /* Plain char* support, not auto-reclaimed (unless noted) */
1920 /* Are any of the characters in the two strings the same? */
1921 FL
int anyof(char const *s1
, char const *s2
);
1923 /* Treat *iolist as a sep separated list of strings; find and return the
1924 * next entry, trimming surrounding whitespace, and point *iolist to the next
1925 * entry or to NULL if no more entries are contained. If ignore_empty is
1926 * set empty entries are started over.
1927 * See n_shell_parse_token() for the new way that supports sh(1) quoting.
1928 * Return NULL or an entry */
1929 FL
char * n_strsep(char **iolist
, char sep
, bool_t ignore_empty
);
1931 /* Copy a string, lowercasing it as we go; *size* is buffer size of *dest*;
1932 * *dest* will always be terminated unless *size* is 0 */
1933 FL
void i_strcpy(char *dest
, char const *src
, size_t size
);
1935 /* Is *as1* a valid prefix of *as2*? */
1936 FL
int is_prefix(char const *as1
, char const *as2
);
1938 /* Backslash quote (" and \) v'alue, and return salloc()ed result */
1939 FL
char * string_quote(char const *v
);
1941 /* Get (and isolate) the last, possibly quoted part of linebuf, set *needs_list
1942 * to indicate wether getmsglist() et al need to be called to collect
1943 * additional args that remain in linebuf. If strip is true possibly
1944 * surrounding quote characters are removed. Return NULL on "error" */
1945 FL
char * laststring(char *linebuf
, bool_t
*needs_list
, bool_t strip
);
1947 /* Convert a string to lowercase, in-place and with multibyte-aware */
1948 FL
void makelow(char *cp
);
1950 /* Is *sub* a substring of *str*, case-insensitive and multibyte-aware? */
1951 FL bool_t
substr(char const *str
, char const *sub
);
1954 FL
char * sstpcpy(char *dst
, char const *src
);
1955 FL
char * sstrdup(char const *cp SMALLOC_DEBUG_ARGS
);
1956 FL
char * sbufdup(char const *cp
, size_t len SMALLOC_DEBUG_ARGS
);
1957 #ifdef HAVE_MEMORY_DEBUG
1958 # define sstrdup(CP) sstrdup(CP, __FILE__, __LINE__)
1959 # define sbufdup(CP,L) sbufdup(CP, L, __FILE__, __LINE__)
1962 /* Copy at most dstsize bytes of src to dst and return string length.
1963 * Returns -E2BIG if dst is not large enough; dst will always be terminated
1964 * unless dstsize was 0 on entry */
1965 FL ssize_t
n_strscpy(char *dst
, char const *src
, size_t dstsize
);
1967 /* Case-independent ASCII comparisons */
1968 FL
int asccasecmp(char const *s1
, char const *s2
);
1969 FL
int ascncasecmp(char const *s1
, char const *s2
, size_t sz
);
1971 /* Case-independent ASCII string find s2 in s1, return it or NULL */
1972 FL
char const *asccasestr(char const *s1
, char const *s2
);
1974 /* Case-independent ASCII check wether as2 is the initial substring of as1 */
1975 FL bool_t
is_asccaseprefix(char const *as1
, char const *as2
);
1977 /* struct str related support funs TODO _cp->_cs! */
1979 /* *self->s* is srealloc()ed */
1980 #define n_str_dup(S, T) n_str_assign_buf((S), (T)->s, (T)->l)
1982 /* *self->s* is srealloc()ed; if buflen==UIZ_MAX strlen() is called unless buf
1983 * is NULL; buf may be NULL if buflen is 0 */
1984 FL
struct str
* n_str_assign_buf(struct str
*self
,
1985 char const *buf
, uiz_t buflen SMALLOC_DEBUG_ARGS
);
1986 #define n_str_assign(S, T) n_str_assign_buf(S, (T)->s, (T)->l)
1987 #define n_str_assign_cp(S, CP) n_str_assign_buf(S, CP, UIZ_MAX)
1989 /* *self->s* is srealloc()ed, *self->l* incremented; if buflen==UIZ_MAX
1990 * strlen() is called unless buf is NULL; buf may be NULL if buflen is 0 */
1991 FL
struct str
* n_str_add_buf(struct str
*self
, char const *buf
, uiz_t buflen
1992 SMALLOC_DEBUG_ARGS
);
1993 #define n_str_add(S, T) n_str_add_buf(S, (T)->s, (T)->l)
1994 #define n_str_add_cp(S, CP) n_str_add_buf(S, CP, UIZ_MAX)
1996 #ifdef HAVE_MEMORY_DEBUG
1997 # define n_str_assign_buf(S,B,BL) n_str_assign_buf(S, B, BL, __FILE__, __LINE__)
1998 # define n_str_add_buf(S,B,BL) n_str_add_buf(S, B, BL, __FILE__, __LINE__)
2002 * May have NULL buffer, may contain embedded NULs */
2005 #define n_string_creat(S) \
2006 ((S)->s_dat = NULL, (S)->s_len = (S)->s_auto = (S)->s_size = 0, (S))
2007 #define n_string_creat_auto(S) \
2008 ((S)->s_dat = NULL, (S)->s_len = (S)->s_size = 0, (S)->s_auto = TRU1, (S))
2009 #define n_string_gut(S) ((S)->s_size != 0 ? (void)n_string_clear(S) : (void)0)
2011 /* Truncate to size, which must be LE current length */
2012 #define n_string_trunc(S,L) ((S)->s_len = (L), (S))
2014 /* Release buffer ownership */
2015 #define n_string_drop_ownership(S) \
2016 ((S)->s_dat = NULL, (S)->s_len = (S)->s_size = 0, (S))
2018 /* Release all memory */
2019 FL
struct n_string
*n_string_clear(struct n_string
*self SMALLOC_DEBUG_ARGS
);
2021 #ifdef HAVE_MEMORY_DEBUG
2022 # define n_string_clear(S) \
2023 ((S)->s_size != 0 ? (n_string_clear)(S, __FILE__, __LINE__) : (S))
2025 # define n_string_clear(S) ((S)->s_size != 0 ? (n_string_clear)(S) : (S))
2028 /* Reserve room for noof additional bytes. The latter also adjusts the length
2029 * accordingly, but the (possible) additional storage isn't initialized */
2030 FL
struct n_string
*n_string_reserve(struct n_string
*self
, size_t noof
2031 SMALLOC_DEBUG_ARGS
);
2032 FL
struct n_string
*n_string_resize(struct n_string
*self
, size_t nlen
2033 SMALLOC_DEBUG_ARGS
);
2035 #ifdef HAVE_MEMORY_DEBUG
2036 # define n_string_reserve(S,N) (n_string_reserve)(S, N, __FILE__, __LINE__)
2037 # define n_string_resize(S,N) (n_string_resize)(S, N, __FILE__, __LINE__)
2041 FL
struct n_string
*n_string_push_buf(struct n_string
*self
, char const *buf
,
2042 size_t buflen SMALLOC_DEBUG_ARGS
);
2043 #define n_string_push(S, T) n_string_push_buf(S, (T)->s_len, (T)->s_dat)
2044 #define n_string_push_cp(S,CP) n_string_push_buf(S, CP, UIZ_MAX)
2045 FL
struct n_string
*n_string_push_c(struct n_string
*self
, char c
2046 SMALLOC_DEBUG_ARGS
);
2048 #define n_string_assign(S,T) ((S)->s_len = 0, n_string_push(S, T))
2049 #define n_string_assign_cp(S,CP) ((S)->s_len = 0, n_string_push_cp(S, CP))
2050 #define n_string_assign_buf(S,B,BL) \
2051 ((S)->s_len = 0, n_string_push_buf(S, B, BL))
2053 #ifdef HAVE_MEMORY_DEBUG
2054 # define n_string_push_buf(S,B,BL) \
2055 n_string_push_buf(S, B, BL, __FILE__, __LINE__)
2056 # define n_string_push_c(S,C) n_string_push_c(S, C, __FILE__, __LINE__)
2060 FL
struct n_string
*n_string_unshift_buf(struct n_string
*self
, char const *buf
,
2061 size_t buflen SMALLOC_DEBUG_ARGS
);
2062 #define n_string_unshift(S, T) \
2063 n_string_unshift_buf(S, (T)->s_len, (T)->s_dat)
2064 #define n_string_unshift_cp(S,CP) \
2065 n_string_unshift_buf(S, CP, UIZ_MAX)
2066 FL
struct n_string
*n_string_unshift_c(struct n_string
*self
, char c
2067 SMALLOC_DEBUG_ARGS
);
2069 #ifdef HAVE_MEMORY_DEBUG
2070 # define n_string_unshift_buf(S,B,BL) \
2071 n_string_unshift_buf(S, B, BL, __FILE__, __LINE__)
2072 # define n_string_unshift_c(S,C) n_string_unshift_c(S, C, __FILE__, __LINE__)
2075 /* Ensure self has a - NUL terminated - buffer, and return that.
2076 * The latter may return the pointer to an internal empty RODATA instead */
2077 FL
char * n_string_cp(struct n_string
*self SMALLOC_DEBUG_ARGS
);
2078 FL
char const *n_string_cp_const(struct n_string
const *self
);
2080 #ifdef HAVE_MEMORY_DEBUG
2081 # define n_string_cp(S) n_string_cp(S, __FILE__, __LINE__)
2085 n_INLINE
struct n_string
*
2086 (n_string_creat
)(struct n_string
*self
){
2087 return n_string_creat(self
);
2089 # undef n_string_creat
2091 n_INLINE
struct n_string
*
2092 (n_string_creat_auto
)(struct n_string
*self
){
2093 return n_string_creat_auto(self
);
2095 # undef n_string_creat_auto
2098 (n_string_gut
)(struct n_string
*self
){
2101 # undef n_string_gut
2103 n_INLINE
struct n_string
*
2104 (n_string_trunc
)(struct n_string
*self
, size_t l
){
2105 return n_string_trunc(self
, l
);
2107 # undef n_string_trunc
2109 n_INLINE
struct n_string
*
2110 (n_string_drop_ownership
)(struct n_string
*self
){
2111 return n_string_drop_ownership(self
);
2113 # undef n_string_drop_ownership
2114 #endif /* HAVE_INLINE */
2118 #if defined HAVE_NATCH_CHAR || defined HAVE_ICONV
2119 /* ..and update arguments to point after range; returns UI32_MAX on error, in
2120 * which case the arguments will have been stepped one byte */
2121 FL ui32_t
n_utf8_to_utf32(char const **bdat
, size_t *blen
);
2123 /* buf must be large enough also for NUL, it's new length will be returned */
2124 FL
size_t n_utf32_to_utf8(ui32_t c
, char *buf
);
2127 /* Our iconv(3) wrappers */
2130 FL iconv_t
n_iconv_open(char const *tocode
, char const *fromcode
);
2131 /* If *cd* == *iconvd*, assigns -1 to the latter */
2132 FL
void n_iconv_close(iconv_t cd
);
2134 /* Reset encoding state */
2135 FL
void n_iconv_reset(iconv_t cd
);
2137 /* iconv(3), but return *errno* or 0; *skipilseq* forces step over invalid byte
2138 * sequences; likewise iconv_str(), but which auto-grows on E2BIG errors; *in*
2139 * and *in_rest_or_null* may be the same object.
2140 * Note: EINVAL (incomplete sequence at end of input) is NOT handled, so the
2141 * replacement character must be added manually if that happens at EOF! */
2142 FL
int n_iconv_buf(iconv_t cd
, char const **inb
, size_t *inbleft
,
2143 char **outb
, size_t *outbleft
, bool_t skipilseq
);
2144 FL
int n_iconv_str(iconv_t icp
, struct str
*out
, struct str
const *in
,
2145 struct str
*in_rest_or_null
, bool_t skipilseq
);
2147 /* If tocode==NULL, uses charset_get_lc(). If fromcode==NULL, uses UTF-8.
2148 * Returns a salloc()ed buffer or NULL */
2149 FL
char * n_iconv_onetime_cp(char const *tocode
, char const *fromcode
,
2150 char const *input
, bool_t skipilseq
);
2155 * This is a little bit hairy since it provides some stuff even if HAVE_TERMCAP
2156 * is false due to encapsulation desire
2160 /* termcap(3) / xy lifetime handling -- only called if we're OPT_INTERACTIVE
2161 * but not doing something in OPT_QUICKRUN_MASK */
2162 FL
void n_termcap_init(void);
2163 FL
void n_termcap_destroy(void);
2165 /* enter_ca_mode / enable keypad (both if possible).
2166 * TODO When complete is not set we won't enter_ca_mode, for example: we don't
2167 * TODO want a complete screen clearance after $PAGER returned after displaying
2168 * TODO a mail, because otherwise the screen would look differently for normal
2169 * TODO stdout display messages. Etc. */
2170 # ifdef HAVE_TERMCAP
2171 FL
void n_termcap_resume(bool_t complete
);
2172 FL
void n_termcap_suspend(bool_t complete
);
2174 # define n_TERMCAP_RESUME(CPL) n_termcap_resume(CPL)
2175 # define n_TERMCAP_SUSPEND(CPL) n_termcap_suspend(CPL)
2177 # define n_TERMCAP_RESUME(CPL)
2178 # define n_TERMCAP_SUSPEND(CPL)
2181 /* Command multiplexer, returns FAL0 on I/O error, TRU1 on success and TRUM1
2182 * for commands which are not available and have no builtin fallback.
2183 * For query options the return represents a true value and -1 error.
2184 * Will return FAL0 directly unless we've been initialized.
2185 * By convention unused argument slots are given as -1 */
2186 FL ssize_t
n_termcap_cmd(enum n_termcap_cmd cmd
, ssize_t a1
, ssize_t a2
);
2187 # define n_termcap_cmdx(CMD) n_termcap_cmd(CMD, -1, -1)
2189 /* Query multiplexer. If query is n__TERMCAP_QUERY_MAX then
2190 * tvp->tv_data.tvd_string must contain the name of the query to look up; this
2191 * is used to lookup just about *any* (string) capability.
2192 * Returns TRU1 on success and TRUM1 for queries for which a builtin default
2193 * is returned; FAL0 is returned on non-availability */
2194 FL bool_t
n_termcap_query(enum n_termcap_query query
,
2195 struct n_termcap_value
*tvp
);
2197 /* Get a n_termcap_query for name or -1 if it is not known, and -2 if
2198 * type wasn't _NONE and the type doesn't match. */
2199 # ifdef HAVE_KEY_BINDINGS
2200 FL si32_t
n_termcap_query_for_name(char const *name
,
2201 enum n_termcap_captype type
);
2202 FL
char const *n_termcap_name_of_query(enum n_termcap_query query
);
2204 #endif /* n_HAVE_TCAP */
2211 FL
int c_thread(void *vp
);
2214 FL
int c_unthread(void *vp
);
2217 FL
struct message
* next_in_thread(struct message
*mp
);
2218 FL
struct message
* prev_in_thread(struct message
*mp
);
2219 FL
struct message
* this_in_thread(struct message
*mp
, long n
);
2221 /* Sorted mode is internally just a variant of threaded mode with all m_parent
2222 * and m_child links being NULL */
2223 FL
int c_sort(void *vp
);
2226 FL
int c_collapse(void *v
);
2227 FL
int c_uncollapse(void *v
);
2230 FL
void uncollapse1(struct message
*mp
, int always
);
2236 /* Return wether user says yes, on STDIN if interactive.
2237 * Uses noninteract_default, the return value for non-interactive use cases,
2238 * as a hint for boolify() and chooses the yes/no string to append to prompt
2239 * accordingly. If prompt is NULL "Continue" is used instead.
2240 * Handles+reraises SIGINT */
2241 FL bool_t
getapproval(char const *prompt
, bool_t noninteract_default
);
2244 /* Get a password the expected way, return termios_state.ts_linebuf on
2245 * success or NULL on error */
2246 FL
char * getuser(char const *query
);
2248 /* Get a password the expected way, return termios_state.ts_linebuf on
2249 * success or NULL on error. SIGINT is temporarily blocked, *not* reraised.
2250 * termios_state_reset() (def.h) must be called anyway */
2251 FL
char * getpassword(char const *query
);
2254 /* Overall interactive terminal life cycle for command line editor library */
2255 #if defined HAVE_READLINE
2256 # define TTY_WANTS_SIGWINCH
2258 FL
void n_tty_init(void);
2259 FL
void n_tty_destroy(void);
2261 /* Rather for main.c / SIGWINCH interaction only */
2262 FL
void n_tty_signal(int sig
);
2264 /* Read a line after printing prompt (if set and non-empty).
2265 * If n>0 assumes that *linebuf has n bytes of default content */
2266 FL
int n_tty_readline(char const *prompt
, char **linebuf
,
2267 size_t *linesize
, size_t n SMALLOC_DEBUG_ARGS
);
2268 #ifdef HAVE_MEMORY_DEBUG
2269 # define n_tty_readline(A,B,C,D) (n_tty_readline)(A, B, C, D, __FILE__,__LINE__)
2272 /* Add a line (most likely as returned by n_tty_readline()) to the history.
2273 * Wether an entry added for real depends on the isgabby / *history-gabby*
2274 * relation, and / or wether s is non-empty and doesn't begin with U+0020 */
2275 FL
void n_tty_addhist(char const *s
, bool_t isgabby
);
2278 FL
int c_history(void *v
);
2280 # define c_history c_cmdnotsupp
2287 /* Parse (onechar of) a given buffer, and generate infos along the way.
2288 * If _WOUT_CREATE is set in vif, .vic_woudat will be NUL terminated!
2289 * vicp must be zeroed before first use */
2290 FL bool_t
n_visual_info(struct n_visual_info_ctx
*vicp
,
2291 enum n_visual_info_flags vif
);
2293 /* Check (multibyte-safe) how many bytes of buf (which is blen byts) can be
2294 * safely placed in a buffer (field width) of maxlen bytes */
2295 FL
size_t field_detect_clip(size_t maxlen
, char const *buf
, size_t blen
);
2297 /* Put maximally maxlen bytes of buf, a buffer of blen bytes, into store,
2298 * taking into account multibyte code point boundaries and possibly
2299 * encapsulating in bidi_info toggles as necessary */
2300 FL
size_t field_put_bidi_clip(char *store
, size_t maxlen
, char const *buf
,
2303 /* Place cp in a salloc()ed buffer, column-aligned; for header display only */
2304 FL
char * colalign(char const *cp
, int col
, int fill
,
2305 int *cols_decr_used_or_null
);
2307 /* Convert a string to a displayable one;
2308 * prstr() returns the result savestr()d, prout() writes it */
2309 FL
void makeprint(struct str
const *in
, struct str
*out
);
2310 FL
size_t delctrl(char *cp
, size_t len
);
2311 FL
char * prstr(char const *s
);
2312 FL
int prout(char const *s
, size_t sz
, FILE *fp
);
2314 /* Print out a Unicode character or a substitute for it, return 0 on error or
2315 * wcwidth() (or 1) on success */
2316 FL
size_t putuc(int u
, int c
, FILE *fp
);
2318 /* Check wether bidirectional info maybe needed for blen bytes of bdat */
2319 FL bool_t
bidi_info_needed(char const *bdat
, size_t blen
);
2321 /* Create bidirectional text encapsulation information; without HAVE_NATCH_CHAR
2322 * the strings are always empty */
2323 FL
void bidi_info_create(struct bidi_info
*bip
);
2329 /* URL en- and decoding according to (enough of) RFC 3986 (RFC 1738).
2330 * These return a newly salloc()ated result */
2331 FL
char * urlxenc(char const *cp
, bool_t ispath SALLOC_DEBUG_ARGS
);
2332 FL
char * urlxdec(char const *cp SALLOC_DEBUG_ARGS
);
2333 #ifdef HAVE_MEMORY_DEBUG
2334 # define urlxenc(CP,P) urlxenc(CP, P, __FILE__, __LINE__)
2335 # define urlxdec(CP) urlxdec(CP, __FILE__, __LINE__)
2339 /* Return port of urlp->url_proto (and set irv_or_null), or NULL if unknown */
2340 FL
char const * url_servbyname(struct url
const *urlp
, ui16_t
*irv_or_null
);
2342 /* Parse data, which must meet the criteria of the protocol cproto, and fill
2343 * in the URL structure urlp (URL rather according to RFC 3986) */
2344 FL bool_t
url_parse(struct url
*urlp
, enum cproto cproto
,
2347 /* Zero ccp and lookup credentials for communicating with urlp.
2348 * Return wether credentials are available and valid (for chosen auth) */
2349 FL bool_t
ccred_lookup(struct ccred
*ccp
, struct url
*urlp
);
2350 FL bool_t
ccred_lookup_old(struct ccred
*ccp
, enum cproto cproto
,
2352 #endif /* HAVE_SOCKETS */
2356 FL
int c_netrc(void *v
);
2358 # define c_netrc c_cmdnotsupp
2361 /* MD5 (RFC 1321) related facilities */
2363 # ifdef HAVE_OPENSSL_MD5
2364 # define md5_ctx MD5_CTX
2365 # define md5_init MD5_Init
2366 # define md5_update MD5_Update
2367 # define md5_final MD5_Final
2369 /* The function definitions are instantiated in main.c */
2370 # include "rfc1321.h"
2373 /* Store the MD5 checksum as a hexadecimal string in *hex*, *not* terminated,
2374 * using lowercase ASCII letters as defined in RFC 2195 */
2375 # define MD5TOHEX_SIZE 32
2376 FL
char * md5tohex(char hex
[MD5TOHEX_SIZE
], void const *vp
);
2378 /* CRAM-MD5 encode the *user* / *pass* / *b64* combo */
2379 FL
char * cram_md5_string(struct str
const *user
, struct str
const *pass
,
2382 /* RFC 2104: HMAC: Keyed-Hashing for Message Authentication.
2383 * unsigned char *text: pointer to data stream
2384 * int text_len : length of data stream
2385 * unsigned char *key : pointer to authentication key
2386 * int key_len : length of authentication key
2387 * caddr_t digest : caller digest to be filled in */
2388 FL
void hmac_md5(unsigned char *text
, int text_len
, unsigned char *key
,
2389 int key_len
, void *digest
);
2390 #endif /* HAVE_MD5 */
2392 #ifndef HAVE_AMALGAMATION