1 /*@ S-nail - a mail user agent derived from Berkeley Mail.
2 *@ (Lexical processing of) Commands, and the (blocking) "event mainloop".
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
38 #ifndef HAVE_AMALGAMATION
43 char const *name
; /* Name of command */
44 int (*func
)(void*); /* Implementor of command */
45 enum argtype argtype
; /* Arglist type (see below) */
46 short msgflag
; /* Required flags of msgs */
47 short msgmask
; /* Relevant flags of msgs */
48 #ifdef HAVE_DOCSTRINGS
49 char const *doc
; /* One line doc for command */
52 /* Yechh, can't initialize unions */
53 #define minargs msgflag /* Minimum argcount for RAWLIST */
54 #define maxargs msgmask /* Max argcount for RAWLIST */
57 struct cmd_ghost
*next
;
58 struct str cmd
; /* Data follows after .name */
59 char name
[VFIELD_SIZE(0)];
63 static int _reset_on_stop
; /* do a reset() if stopped */
64 static sighandler_type _oldpipe
;
65 static struct cmd_ghost
*_cmd_ghosts
;
66 /* _cmd_tab[] after fun protos */
67 static int _lex_inithdr
; /* am printing startup headers */
69 /* Update mailname (if name != NULL) and displayname, return wether displayname
70 * was large enough to swallow mailname */
71 static bool_t
_update_mailname(char const *name
);
72 #ifdef HAVE_C90AMEND1 /* TODO unite __narrow_suffix() into one fun! */
73 SINLINE
size_t __narrow_suffix(char const *cp
, size_t cpl
, size_t maxl
);
76 /* Isolate the command from the arguments */
77 static char * _lex_isolate(char const *comm
);
79 /* Get first-fit, or NULL */
80 static struct cmd
const * _lex(char const *comm
);
82 /* Command ghost handling */
83 static int _c_ghost(void *v
);
84 static int _c_unghost(void *v
);
86 /* Print a list of all commands */
87 static int _c_pcmdlist(void *v
);
89 static int __pcmd_cmp(void const *s1
, void const *s2
);
92 static int _c_quit(void *v
);
94 /* Print the binaries compiled-in features */
95 static int _c_features(void *v
);
97 /* Print the binaries version number */
98 static int _c_version(void *v
);
100 /* When we wake up after ^Z, reprint the prompt */
101 static void stop(int s
);
103 /* Branch here on hangup signal and simulate "exit" */
104 static void hangup(int s
);
106 /* List of all commands */
107 static struct cmd
const _cmd_tab
[] = {
111 #ifdef HAVE_C90AMEND1
113 __narrow_suffix(char const *cp
, size_t cpl
, size_t maxl
)
119 for (err
= ok
= i
= 0; cpl
> maxl
|| err
;) {
120 int ml
= mblen(cp
, cpl
);
121 if (ml
< 0) { /* XXX _narrow_suffix(): mblen() error; action? */
122 (void)mblen(NULL
, 0);
139 #endif /* HAVE_C90AMEND1 */
142 _update_mailname(char const *name
)
144 char tbuf
[PATH_MAX
], *mailp
, *dispp
;
149 /* Don't realpath(3) if it's only an update request */
152 enum protocol p
= which_protocol(name
);
153 if (p
== PROTO_FILE
|| p
== PROTO_MAILDIR
) {
154 if (realpath(name
, mailname
) == NULL
) {
155 n_err(_("Can't canonicalize \"%s\"\n"), name
);
162 n_strlcpy(mailname
, name
, sizeof(mailname
));
168 /* Don't display an absolute path but "+FOLDER" if under *folder* */
169 if (getfold(tbuf
, sizeof tbuf
)) {
171 if (i
< sizeof(tbuf
) -1)
173 if (!strncmp(tbuf
, mailp
, i
)) {
179 /* We want to see the name of the folder .. on the screen */
181 if (i
< sizeof(displayname
) -1)
182 memcpy(dispp
, mailp
, i
+1);
185 /* Avoid disrupting multibyte sequences (if possible) */
186 #ifndef HAVE_C90AMEND1
187 j
= sizeof(displayname
) / 3 - 1;
188 i
-= sizeof(displayname
) - (1/* + */ + 3) - j
;
190 j
= field_detect_clip(sizeof(displayname
) / 3, mailp
, i
);
191 i
= j
+ __narrow_suffix(mailp
+ j
, i
- j
,
192 sizeof(displayname
) - (1/* + */ + 3 + 1) - j
);
194 snprintf(dispp
, sizeof(displayname
), "%.*s...%s",
195 (int)j
, mailp
, mailp
+ i
);
202 _lex_isolate(char const *comm
)
205 while (*comm
!= '\0' &&
206 strchr("~|? \t0123456789&%@$^.:/-+*'\",;(`", *comm
) == NULL
)
209 return UNCONST(comm
);
212 static struct cmd
const *
213 _lex(char const *comm
) /* TODO **command hashtable**! linear list search!!! */
215 struct cmd
const *cp
;
218 for (cp
= _cmd_tab
; cp
->name
!= NULL
; ++cp
)
219 if (*comm
== *cp
->name
&& is_prefix(comm
, cp
->name
))
230 char const **argv
= v
;
231 struct cmd_ghost
*lcg
, *cg
;
240 if ((fp
= Ftmp(NULL
, "ghost", OF_RDWR
| OF_UNLINK
| OF_REGISTER
, 0600)) ==
243 for (i
= 0, cg
= _cmd_ghosts
; cg
!= NULL
; cg
= cg
->next
)
244 fprintf(fp
, "ghost %s \"%s\"\n", cg
->name
, string_quote(cg
->cmd
.s
));
246 page_or_print(fp
, i
);
252 /* Verify the ghost name is a valid one */
253 if (*argv
[0] == '\0' || *_lex_isolate(argv
[0]) != '\0') {
254 n_err(_("`ghost': can't canonicalize \"%s\"\n"), argv
[0]);
259 /* Show command of single ghost? */
260 if (argv
[1] == NULL
) {
261 for (cg
= _cmd_ghosts
; cg
!= NULL
; cg
= cg
->next
)
262 if (!strcmp(argv
[0], cg
->name
)) {
263 printf("ghost %s \"%s\"\n", cg
->name
, string_quote(cg
->cmd
.s
));
266 n_err(_("`ghost': no such alias: \"%s\"\n"), argv
[0]);
271 /* Define command for ghost: verify command content */
272 for (cl
= 0, i
= 1; (cp
= UNCONST(argv
[i
])) != NULL
; ++i
)
274 cl
+= strlen(cp
) + 1; /* SP or NUL */
276 n_err(_("`ghost': empty command arguments after \"%s\"\n"), argv
[0]);
281 /* If the ghost already exists, recreate */
282 for (lcg
= NULL
, cg
= _cmd_ghosts
; cg
!= NULL
; lcg
= cg
, cg
= cg
->next
)
283 if (!strcmp(cg
->name
, argv
[0])) {
285 lcg
->next
= cg
->next
;
287 _cmd_ghosts
= cg
->next
;
292 nl
= strlen(argv
[0]) +1;
293 cg
= smalloc(sizeof(*cg
) - VFIELD_SIZEOF(struct cmd_ghost
, name
) + nl
+ cl
);
294 cg
->next
= _cmd_ghosts
;
296 memcpy(cg
->name
, argv
[0], nl
);
297 cp
= cg
->cmd
.s
= cg
->name
+ nl
;
299 while (*++argv
!= NULL
) {
302 memcpy(cp
, *argv
, i
);
317 char const **argv
= v
, *cp
;
318 struct cmd_ghost
*lcg
, *cg
;
321 while ((cp
= *argv
++) != NULL
) {
322 if (cp
[0] == '*' && cp
[1] == '\0') {
323 while ((cg
= _cmd_ghosts
) != NULL
) {
324 _cmd_ghosts
= cg
->next
;
328 for (lcg
= NULL
, cg
= _cmd_ghosts
; cg
!= NULL
; lcg
= cg
, cg
= cg
->next
)
329 if (!strcmp(cg
->name
, cp
)) {
331 lcg
->next
= cg
->next
;
333 _cmd_ghosts
= cg
->next
;
337 n_err(_("`unghost': no such alias: \"%s\"\n"), cp
);
348 __pcmd_cmp(void const *s1
, void const *s2
)
350 struct cmd
const * const *c1
= s1
, * const *c2
= s2
;
354 rv
= strcmp((*c1
)->name
, (*c2
)->name
);
362 struct cmd
const **cpa
, *cp
, **cursor
;
367 for (i
= 0; _cmd_tab
[i
].name
!= NULL
; ++i
)
370 cpa
= ac_alloc(sizeof(cp
) * i
);
372 for (i
= 0; (cp
= _cmd_tab
+ i
)->name
!= NULL
; ++i
)
376 qsort(cpa
, i
, sizeof(cp
), &__pcmd_cmp
);
378 printf(_("Commands are:\n"));
379 for (i
= 0, cursor
= cpa
; (cp
= *cursor
++) != NULL
;) {
381 if (cp
->func
== &c_cmdnotsupp
)
383 j
= strlen(cp
->name
) + 2;
388 printf((*cursor
!= NULL
? "%s, " : "%s\n"), cp
->name
);
403 /* If we are PS_SOURCING, then return 1 so evaluate() can handle it.
404 * Otherwise return -1 to abort command loop */
405 rv
= (pstate
& PS_SOURCING
) ? 1 : -1;
415 printf(_("Features: %s\n"), ok_vlook(features
));
425 printf(_("Version %s\n"), ok_vlook(version
));
433 sighandler_type old_action
;
435 NYD_X
; /* Signal handler */
437 old_action
= safe_signal(s
, SIG_DFL
);
441 sigprocmask(SIG_UNBLOCK
, &nset
, NULL
);
443 sigprocmask(SIG_BLOCK
, &nset
, NULL
);
444 safe_signal(s
, old_action
);
445 if (_reset_on_stop
) {
454 NYD_X
; /* Signal handler */
461 setfile(char const *name
, enum fedit_mode fm
) /* TODO oh my god */
468 int rv
, omsgCount
= 0;
469 FILE *ibuf
= NULL
, *lckfp
= NULL
;
470 bool_t isdevnull
= FAL0
;
473 /* Note we don't 'userid(myname) != getuid()', preliminary steps are usually
474 * necessary to make a mailbox accessible by a different user, and if that
475 * has happened, let's just let the usual file perms decide */
477 if (name
[0] == '%' || ((who
= shortcut_expand(name
)) != NULL
&& *who
== '%'))
478 fm
|= FEDIT_SYSBOX
; /* TODO fexpand() needs to tell is-valid-user! */
480 who
= (name
[1] != '\0') ? name
+ 1 : myname
;
482 if ((name
= expand(name
)) == NULL
)
485 switch (which_protocol(name
)) {
487 if (temporary_protocol_ext
!= NULL
)
488 name
= savecat(name
, temporary_protocol_ext
);
489 isdevnull
= ((options
& OPT_BATCH_FLAG
) && !strcmp(name
, "/dev/null"));
491 do { /* TODO we need objects, goes away then */
493 if (realpath(name
, ebuf
) != NULL
)
494 name
= savestr(ebuf
);
500 rv
= maildir_setfile(name
, fm
);
505 rv
= pop3_setfile(name
, fm
);
511 if ((fm
& FEDIT_NEWMAIL
) && mb
.mb_type
== MB_CACHE
)
514 rv
= imap_setfile(name
, fm
);
518 n_err(_("Cannot handle protocol: %s\n"), name
);
522 if ((ibuf
= Zopen(name
, "r")) == NULL
) {
523 if (((fm
& FEDIT_SYSBOX
) && errno
== ENOENT
) || (fm
& FEDIT_NEWMAIL
)) {
524 if (fm
& FEDIT_NEWMAIL
)
532 if (fstat(fileno(ibuf
), &stb
) == -1) {
533 if (fm
& FEDIT_NEWMAIL
)
535 n_perr(_("fstat"), 0);
539 if (S_ISREG(stb
.st_mode
) || isdevnull
) {
542 if (fm
& FEDIT_NEWMAIL
)
544 errno
= S_ISDIR(stb
.st_mode
) ? EISDIR
: EINVAL
;
549 /* Looks like all will be well. We must now relinquish our hold on the
550 * current set of stuff. Must hold signals while we are reading the new
551 * file, else we will ruin the message[] data structure */
553 hold_sigs(); /* TODO note on this one in quit.c:quit() */
554 if (shudclob
&& !(fm
& FEDIT_NEWMAIL
))
557 if (!(fm
& FEDIT_NEWMAIL
) && mb
.mb_sock
.s_fd
>= 0)
558 sclose(&mb
.mb_sock
); /* TODO sorry? VMAILFS->close(), thank you */
561 /* TODO There is no intermediate VOID box we've switched to: name may
562 * TODO point to the same box that we just have written, so any updates
563 * TODO we won't see! Reopen again in this case. RACY! Goes with VOID! */
564 /* TODO In addition: in case of compressed/hook boxes we lock a temporary! */
565 /* TODO We may uselessly open twice but quit() doesn't say wether we were
566 * TODO modified so we can't tell: Mailbox::is_modified() :-(( */
567 if (/*shudclob && !(fm & FEDIT_NEWMAIL) &&*/ !strcmp(name
, mailname
)) {
571 if ((ibuf
= Zopen(name
, "r")) == NULL
||
572 fstat(fileno(ibuf
), &stb
) == -1 ||
573 (!S_ISREG(stb
.st_mode
) && !isdevnull
)) {
580 /* Copy the messages into /tmp and set pointers */
581 if (!(fm
& FEDIT_NEWMAIL
)) {
582 mb
.mb_type
= MB_FILE
;
583 mb
.mb_perm
= (((options
& OPT_R_FLAG
) || (fm
& FEDIT_RDONLY
) ||
584 access(name
, W_OK
) < 0) ? 0 : MB_DELE
| MB_EDIT
);
596 if (fm
& FEDIT_SYSBOX
)
603 fseek(mb
.mb_otf
, 0L, SEEK_END
);
604 /* TODO Doing this without holding a lock is.. And not err checking.. */
605 fseek(ibuf
, mailsize
, SEEK_SET
);
607 omsgCount
= msgCount
;
612 else if (!(pstate
& PS_EDIT
))
613 lckfp
= dot_lock(name
, fileno(ibuf
), FLT_READ
, offset
,0,
614 (fm
& FEDIT_NEWMAIL
? 0 : 1));
615 else if (file_lock(fileno(ibuf
), FLT_READ
, offset
,0,
616 (fm
& FEDIT_NEWMAIL
? 0 : 1)))
620 if (!(fm
& FEDIT_NEWMAIL
)) {
621 char const *emsg
= (pstate
& PS_EDIT
)
622 ? N_("Unable to lock mailbox, aborting operation")
623 : N_("Unable to (dot) lock mailbox, aborting operation");
627 if (!(fm
& FEDIT_NEWMAIL
))
632 mailsize
= fsize(ibuf
);
634 /* TODO This is too simple minded? We should regenerate an index file
635 * TODO to be able to truly tell wether *anything* has changed! */
636 if ((fm
& FEDIT_NEWMAIL
) && UICMP(z
, mailsize
, <=, offset
)) {
640 setptr(ibuf
, offset
);
642 if ((fm
& FEDIT_NEWMAIL
) && mb
.mb_sorted
) {
649 if (lckfp
!= NULL
&& lckfp
!= (FILE*)-1) {
655 if (!(fm
& FEDIT_NEWMAIL
))
656 pstate
&= ~PS_SAW_COMMAND
;
658 if (options
& OPT_EXISTONLY
) {
659 rv
= (msgCount
== 0);
663 if ((!(pstate
& PS_EDIT
) || (fm
& FEDIT_NEWMAIL
)) && msgCount
== 0) {
664 if (!(fm
& FEDIT_NEWMAIL
)) {
666 if (!ok_blook(emptystart
))
667 n_err(_("No mail for %s\n"), who
);
673 if (fm
& FEDIT_NEWMAIL
)
674 newmailinfo(omsgCount
);
680 if (lckfp
!= NULL
&& lckfp
!= (FILE*)-1)
686 mb
.mb_type
= MB_VOID
;
693 newmailinfo(int omsgCount
)
698 for (i
= 0; i
< omsgCount
; ++i
)
699 message
[i
].m_flag
&= ~MNEWEST
;
701 if (msgCount
> omsgCount
) {
702 for (i
= omsgCount
; i
< msgCount
; ++i
)
703 message
[i
].m_flag
|= MNEWEST
;
704 printf(_("New mail has arrived.\n"));
705 if ((i
= msgCount
- omsgCount
) == 1)
706 printf(_("Loaded 1 new message.\n"));
708 printf(_("Loaded %d new messages.\n"), i
);
710 printf(_("Loaded %d messages.\n"), msgCount
);
712 check_folder_hook(TRU1
);
716 if (ok_blook(header
))
717 print_headers(omsgCount
+ 1, msgCount
, FAL0
);
727 bool_t
volatile rv
= TRU1
;
730 if (!(pstate
& PS_SOURCING
)) {
731 if (safe_signal(SIGINT
, SIG_IGN
) != SIG_IGN
)
732 safe_signal(SIGINT
, onintr
);
733 if (safe_signal(SIGHUP
, SIG_IGN
) != SIG_IGN
)
734 safe_signal(SIGHUP
, hangup
);
735 /* TODO We do a lot of redundant signal handling, especially
736 * TODO with the command line editor(s); try to merge this */
737 safe_signal(SIGTSTP
, stop
);
738 safe_signal(SIGTTOU
, stop
);
739 safe_signal(SIGTTIN
, stop
);
741 _oldpipe
= safe_signal(SIGPIPE
, SIG_IGN
);
742 safe_signal(SIGPIPE
, _oldpipe
);
744 memset(&ev
, 0, sizeof ev
);
748 char *temporary_orig_line
; /* XXX eval_ctx.ev_line not yet constant */
750 /* TODO Unless we have our signal manager (or however we do it) child
751 * TODO processes may have time slots where their execution isn't
752 * TODO protected by signal handlers (in between start and setup
753 * TODO completed). close_all_files() is only called from onintr()
754 * TODO so those may linger possibly forever */
755 if (!(pstate
& PS_SOURCING
))
759 handlerstacktop
= NULL
;
762 colour_table
= NULL
; /* XXX intermediate hack */
764 if (temporary_localopts_store
!= NULL
) /* XXX intermediate hack */
765 temporary_localopts_free(); /* XXX intermediate hack */
766 sreset((pstate
& PS_SOURCING
) != 0);
767 if (!(pstate
& PS_SOURCING
)) {
770 /* TODO Note: this buffer may contain a password. We should redefine
771 * TODO the code flow which has to do that */
772 if ((cp
= termios_state
.ts_linebuf
) != NULL
) {
773 termios_state
.ts_linebuf
= NULL
;
774 termios_state
.ts_linesize
= 0;
775 free(cp
); /* TODO pool give-back */
777 /* TODO Due to expand-on-tab of NCL the buffer may grow */
778 if (ev
.ev_line
.l
> LINESIZE
* 3) {
779 free(ev
.ev_line
.s
); /* TODO pool! but what? */
781 ev
.ev_line
.l
= ev
.ev_line_size
= 0;
785 if (!(pstate
& PS_SOURCING
) && (options
& OPT_INTERACTIVE
)) {
788 cp
= ok_vlook(newmail
);
789 if ((options
& OPT_TTYIN
) && (cp
!= NULL
|| mb
.mb_type
== MB_IMAP
)) {
792 n
= (cp
!= NULL
&& strcmp(cp
, "noimap") && strcmp(cp
, "nopoll"));
793 if ((mb
.mb_type
== MB_FILE
&& !stat(mailname
, &st
) &&
794 st
.st_size
> mailsize
) ||
796 (mb
.mb_type
== MB_IMAP
&& imap_newmail(n
) > (cp
== NULL
)) ||
798 (mb
.mb_type
== MB_MAILDIR
&& n
!= 0)) {
799 size_t odot
= PTR2SIZE(dot
- message
);
800 ui32_t odid
= (pstate
& PS_DID_PRINT_DOT
);
802 if (setfile(mailname
,
804 ((mb
.mb_perm
& MB_DELE
) ? 0 : FEDIT_RDONLY
)) < 0) {
805 exit_status
|= EXIT_ERR
;
809 if (mb
.mb_type
!= MB_IMAP
) {
810 dot
= message
+ odot
;
817 exit_status
= EXIT_OK
;
820 /* Read a line of commands and handle end of file specially */
822 ev
.ev_line
.l
= ev
.ev_line_size
;
823 n
= readline_input(NULL
, TRU1
, &ev
.ev_line
.s
, &ev
.ev_line
.l
,
825 ev
.ev_line_size
= (ui32_t
)ev
.ev_line
.l
;
826 ev
.ev_line
.l
= (ui32_t
)n
;
830 if (pstate
& PS_LOADING
)
832 if (pstate
& PS_SOURCING
) {
836 if ((options
& OPT_INTERACTIVE
) && ok_blook(ignoreeof
)) {
837 printf(_("*ignoreeof* set, use `quit' to quit.\n"));
843 temporary_orig_line
= ((pstate
& PS_SOURCING
) ||
844 !(options
& OPT_INTERACTIVE
)) ? NULL
845 : savestrbuf(ev
.ev_line
.s
, ev
.ev_line
.l
);
846 pstate
&= ~PS_HOOK_MASK
;
848 if (pstate
& PS_LOADING
) /* TODO mess; join PS_EVAL_ERROR.. */
852 if ((options
& OPT_BATCH_FLAG
) && ok_blook(batch_exit_on_error
)) {
853 if (exit_status
!= EXIT_OK
)
855 if ((pstate
& (PS_IN_LOAD
| PS_EVAL_ERROR
)) == PS_EVAL_ERROR
) {
856 exit_status
= EXIT_ERR
;
860 if (!(pstate
& PS_SOURCING
) && (options
& OPT_INTERACTIVE
)) {
861 if (ev
.ev_new_content
!= NULL
)
863 /* That *can* happen since evaluate() unstack()s on error! */
864 if (temporary_orig_line
!= NULL
)
865 tty_addhist(temporary_orig_line
, !ev
.ev_add_history
);
869 if (ev
.ev_line
.s
!= NULL
)
871 if (pstate
& PS_SOURCING
)
878 execute(char *linebuf
, size_t linesize
) /* XXX LEGACY */
882 struct colour_table
*ct_save
;
887 /* TODO Maybe recursion from within collect.c! As long as we don't have
888 * TODO a value carrier that transports the entire state of a recursion
889 * TODO we need to save away also the colour table */
891 ct_save
= colour_table
;
895 memset(&ev
, 0, sizeof ev
);
896 ev
.ev_line
.s
= linebuf
;
897 ev
.ev_line
.l
= linesize
;
898 ev
.ev_is_recursive
= TRU1
;
902 colour_table
= ct_save
;
909 evaluate(struct eval_ctx
*evp
)
912 char _wordbuf
[2], *arglist
[MAXARGC
], *cp
, *word
;
913 struct cmd_ghost
*cg
= NULL
;
914 struct cmd
const *com
= NULL
;
915 int muvec
[2], c
, e
= 1;
918 line
= evp
->ev_line
; /* XXX don't change original (buffer pointer) */
919 evp
->ev_add_history
= FAL0
;
920 evp
->ev_new_content
= NULL
;
922 /* Command ghosts that refer to shell commands or macro expansion restart */
925 /* Strip the white space away from the beginning of the command */
926 for (cp
= line
.s
; whitechar(*cp
); ++cp
)
928 line
.l
-= PTR2SIZE(cp
- line
.s
);
930 /* Ignore comments */
934 /* Handle ! differently to get the correct lexical conventions */
936 if (pstate
& PS_SOURCING
) {
937 n_err(_("Can't `!' while `source'ing\n"));
941 evp
->ev_add_history
= TRU1
;
945 /* Isolate the actual command; since it may not necessarily be
946 * separated from the arguments (as in `p1') we need to duplicate it to
947 * be able to create a NUL terminated version.
948 * We must be aware of several special one letter commands here */
950 if ((cp
= _lex_isolate(cp
)) == arglist
[0] &&
951 (*cp
== '|' || *cp
== '~' || *cp
== '?'))
953 c
= (int)PTR2SIZE(cp
- arglist
[0]);
955 word
= UICMP(z
, c
, <, sizeof _wordbuf
) ? _wordbuf
: salloc(c
+1);
956 memcpy(word
, arglist
[0], c
);
959 /* Look up the command; if not found, bitch.
960 * Normally, a blank command would map to the first command in the
961 * table; while PS_SOURCING, however, we ignore blank lines to eliminate
962 * confusion; act just the same for ghosts */
964 if ((pstate
& PS_SOURCING
) || cg
!= NULL
)
970 /* If this is the first evaluation, check command ghosts */
972 /* TODO relink list head, so it's sorted on usage over time?
973 * TODO in fact, there should be one hashmap over all commands and ghosts
974 * TODO so that the lookup could be made much more efficient than it is
975 * TODO now (two adjacent list searches! */
976 for (cg
= _cmd_ghosts
; cg
!= NULL
; cg
= cg
->next
)
977 if (!strcmp(word
, cg
->name
)) {
979 size_t i
= cg
->cmd
.l
;
980 line
.s
= salloc(i
+ line
.l
+1);
981 memcpy(line
.s
, cg
->cmd
.s
, i
);
982 memcpy(line
.s
+ i
, cp
, line
.l
);
983 line
.s
[i
+= line
.l
] = '\0';
993 if ((com
= _lex(word
)) == NULL
|| com
->func
== &c_cmdnotsupp
) {
994 bool_t s
= condstack_isskip();
995 if (!s
|| (options
& OPT_D_V
))
996 n_err(_("Unknown command%s: `%s'\n"),
997 (s
? _(" (conditionally ignored)") : ""), word
);
1007 /* See if we should execute the command -- if a conditional we always
1008 * execute it, otherwise, check the state of cond */
1010 if (!(com
->argtype
& ARG_F
) && condstack_isskip())
1013 /* Process the arguments to the command, depending on the type it expects,
1014 * default to error. If we're PS_SOURCING an interactive command: error */
1015 if ((options
& OPT_SENDMODE
) && !(com
->argtype
& ARG_M
)) {
1016 n_err(_("May not execute `%s' while sending\n"), com
->name
);
1019 if ((pstate
& PS_SOURCING
) && (com
->argtype
& ARG_I
)) {
1020 n_err(_("May not execute `%s' while `source'ing\n"), com
->name
);
1023 if (!(mb
.mb_perm
& MB_DELE
) && (com
->argtype
& ARG_W
)) {
1024 n_err(_("May not execute `%s' -- message file is read only\n"),
1028 if (evp
->ev_is_recursive
&& (com
->argtype
& ARG_R
)) {
1029 n_err(_("Cannot recursively invoke `%s'\n"), com
->name
);
1032 if (mb
.mb_type
== MB_VOID
&& (com
->argtype
& ARG_A
)) {
1033 n_err(_("Cannot execute `%s' without active mailbox\n"), com
->name
);
1036 if (com
->argtype
& ARG_O
)
1037 OBSOLETE2(_("this command will be removed"), com
->name
);
1039 if (com
->argtype
& ARG_V
)
1040 temporary_arg_v_store
= NULL
;
1042 switch (com
->argtype
& ARG_ARGMASK
) {
1044 /* Message list defaulting to nearest forward legal message */
1045 if (_msgvec
== NULL
)
1047 if ((c
= getmsglist(cp
, _msgvec
, com
->msgflag
)) < 0)
1050 *_msgvec
= first(com
->msgflag
, com
->msgmask
);
1054 if (*_msgvec
== 0) {
1055 if (!(pstate
& PS_HOOK_MASK
))
1056 printf(_("No applicable messages\n"));
1059 e
= (*com
->func
)(_msgvec
);
1063 /* Message list with no defaults, but no error if none exist */
1064 if (_msgvec
== NULL
) {
1066 n_err(_("Invalid use of \"message list\"\n"));
1069 if ((c
= getmsglist(cp
, _msgvec
, com
->msgflag
)) < 0)
1071 e
= (*com
->func
)(_msgvec
);
1075 /* Just the straight string, with leading blanks removed */
1076 while (whitechar(*cp
))
1078 e
= (*com
->func
)(cp
);
1083 /* A vector of strings, in shell style */
1084 if ((c
= getrawlist(cp
, line
.l
, arglist
, NELEM(arglist
),
1085 ((com
->argtype
& ARG_ARGMASK
) == ARG_ECHOLIST
))) < 0)
1087 if (c
< com
->minargs
) {
1088 n_err(_("`%s' requires at least %d arg(s)\n"),
1089 com
->name
, com
->minargs
);
1092 if (c
> com
->maxargs
) {
1093 n_err(_("`%s' takes no more than %d arg(s)\n"),
1094 com
->name
, com
->maxargs
);
1097 e
= (*com
->func
)(arglist
);
1101 /* Just the constant zero, for exiting, eg. */
1102 e
= (*com
->func
)(0);
1106 n_panic(_("Unknown argument type"));
1109 if (e
== 0 && (com
->argtype
& ARG_V
) &&
1110 (cp
= temporary_arg_v_store
) != NULL
) {
1111 temporary_arg_v_store
= NULL
;
1112 evp
->ev_new_content
= cp
;
1115 if (!(com
->argtype
& ARG_H
) && !(pstate
& PS_MSGLIST_SAW_NO
))
1116 evp
->ev_add_history
= TRU1
;
1119 /* Exit the current source file on error TODO what a mess! */
1121 pstate
&= ~PS_EVAL_ERROR
;
1123 pstate
|= PS_EVAL_ERROR
;
1124 if (e
< 0 || (pstate
& PS_LOADING
)) {
1128 if (pstate
& PS_SOURCING
)
1134 if ((com
->argtype
& ARG_P
) && ok_blook(autoprint
))
1136 muvec
[0] = (int)PTR2SIZE(dot
- message
+ 1);
1138 c_type(muvec
); /* TODO what if error? re-eval! */
1140 if (!(pstate
& (PS_SOURCING
| PS_HOOK_MASK
)) && !(com
->argtype
& ARG_T
))
1141 pstate
|= PS_SAW_COMMAND
;
1143 pstate
&= ~PS_EVAL_ERROR
;
1155 if (_msgvec
!= NULL
)
1157 _msgvec
= scalloc(sz
+ 1, sizeof *_msgvec
);
1162 print_header_summary(char const *Larg
)
1164 size_t bot
, top
, i
, j
;
1168 /* Avoid any messages XXX add a make_mua_silent() and use it? */
1169 if ((options
& (OPT_VERB
| OPT_HEADERSONLY
)) == OPT_HEADERSONLY
) {
1170 freopen("/dev/null", "w", stdout
);
1171 freopen("/dev/null", "w", stderr
);
1173 assert(_msgvec
!= NULL
);
1174 i
= (getmsglist(/*TODO make arg const */UNCONST(Larg
), _msgvec
, 0) <= 0);
1175 if (options
& OPT_HEADERSONLY
) {
1176 exit_status
= (int)i
;
1181 for (bot
= msgCount
, top
= 0, i
= 0; (j
= _msgvec
[i
]) != 0; ++i
) {
1188 bot
= 1, top
= msgCount
;
1189 print_headers(bot
, top
, (Larg
!= NULL
)); /* TODO should take iterator!! */
1197 NYD_X
; /* Signal handler */
1199 if (handlerstacktop
!= NULL
) {
1203 safe_signal(SIGINT
, onintr
);
1206 pstate
|= PS_SAW_COMMAND
;
1208 while (pstate
& PS_SOURCING
)
1211 termios_state_reset();
1218 if (interrupts
!= 1)
1219 n_err_sighdl(_("Interrupt\n"));
1220 safe_signal(SIGPIPE
, _oldpipe
);
1225 announce(int printheaders
)
1230 mdot
= newfileinfo();
1233 dot
= message
+ mdot
- 1;
1234 if (printheaders
&& msgCount
> 0 && ok_blook(header
)) {
1236 print_header_group(vec
); /* XXX errors? */
1246 int u
, n
, mdot
, d
, s
, hidden
, moved
;
1249 if (mb
.mb_type
== MB_VOID
) {
1255 s
= d
= hidden
= moved
=0;
1256 for (mp
= message
, n
= 0, u
= 0; PTRCMP(mp
, <, message
+ msgCount
); ++mp
) {
1257 if (mp
->m_flag
& MNEW
)
1259 if ((mp
->m_flag
& MREAD
) == 0)
1261 if ((mp
->m_flag
& (MDELETED
| MSAVED
)) == (MDELETED
| MSAVED
))
1263 if ((mp
->m_flag
& (MDELETED
| MSAVED
)) == MDELETED
)
1265 if ((mp
->m_flag
& (MDELETED
| MSAVED
)) == MSAVED
)
1267 if (mp
->m_flag
& MHIDDEN
)
1271 /* If displayname gets truncated the user effectively has no option to see
1272 * the full pathname of the mailbox, so print it at least for '? fi' */
1273 printf(_("\"%s\": "),
1274 (_update_mailname(NULL
) ? displayname
: mailname
));
1276 printf(_("1 message"));
1278 printf(_("%d messages"), msgCount
);
1280 printf(_(" %d new"), n
);
1282 printf(_(" %d unread"), u
);
1284 printf(_(" %d deleted"), d
);
1286 printf(_(" %d saved"), s
);
1288 printf(_(" %d moved"), moved
);
1290 printf(_(" %d hidden"), hidden
);
1291 if (mb
.mb_type
== MB_CACHE
)
1292 printf(" [Disconnected]");
1293 else if (mb
.mb_perm
== 0)
1294 printf(_(" [Read only]"));
1307 enum mflag avoid
= MHIDDEN
| MDELETED
;
1311 if (ok_blook(autothread
)) {
1312 OBSOLETE(_("please use *autosort=thread* instead of *autothread*"));
1314 } else if ((cp
= ok_vlook(autosort
)) != NULL
) {
1315 if (mb
.mb_sorted
!= NULL
)
1317 mb
.mb_sorted
= sstrdup(cp
);
1321 if (mb
.mb_type
== MB_VOID
) {
1327 for (mp
= message
; PTRCMP(mp
, <, message
+ msgCount
); ++mp
)
1328 if ((mp
->m_flag
& (MNEWEST
| avoid
)) == MNEWEST
)
1331 if (!nmail
|| PTRCMP(mp
, >=, message
+ msgCount
)) {
1332 if (mb
.mb_threaded
) {
1333 for (mp
= threadroot
; mp
!= NULL
; mp
= next_in_thread(mp
))
1334 if ((mp
->m_flag
& (MNEW
| avoid
)) == MNEW
)
1337 for (mp
= message
; PTRCMP(mp
, <, message
+ msgCount
); ++mp
)
1338 if ((mp
->m_flag
& (MNEW
| avoid
)) == MNEW
)
1343 if ((mb
.mb_threaded
? (mp
== NULL
) : PTRCMP(mp
, >=, message
+ msgCount
))) {
1344 if (mb
.mb_threaded
) {
1345 for (mp
= threadroot
; mp
!= NULL
; mp
= next_in_thread(mp
))
1346 if (mp
->m_flag
& MFLAGGED
)
1349 for (mp
= message
; PTRCMP(mp
, <, message
+ msgCount
); ++mp
)
1350 if (mp
->m_flag
& MFLAGGED
)
1355 if ((mb
.mb_threaded
? (mp
== NULL
) : PTRCMP(mp
, >=, message
+ msgCount
))) {
1356 if (mb
.mb_threaded
) {
1357 for (mp
= threadroot
; mp
!= NULL
; mp
= next_in_thread(mp
))
1358 if (!(mp
->m_flag
& (MREAD
| avoid
)))
1361 for (mp
= message
; PTRCMP(mp
, <, message
+ msgCount
); ++mp
)
1362 if (!(mp
->m_flag
& (MREAD
| avoid
)))
1368 (mb
.mb_threaded
? (mp
!= NULL
) : PTRCMP(mp
, <, message
+ msgCount
)))
1369 mdot
= (int)PTR2SIZE(mp
- message
+ 1);
1370 else if (ok_blook(showlast
)) {
1371 if (mb
.mb_threaded
) {
1372 for (mp
= this_in_thread(threadroot
, -1); mp
;
1373 mp
= prev_in_thread(mp
))
1374 if (!(mp
->m_flag
& avoid
))
1376 mdot
= (mp
!= NULL
) ? (int)PTR2SIZE(mp
- message
+ 1) : msgCount
;
1378 for (mp
= message
+ msgCount
- 1; mp
>= message
; --mp
)
1379 if (!(mp
->m_flag
& avoid
))
1381 mdot
= (mp
>= message
) ? (int)PTR2SIZE(mp
- message
+ 1) : msgCount
;
1383 } else if (!nmail
&&
1384 (mb
.mb_threaded
? (mp
!= NULL
) : PTRCMP(mp
, <, message
+ msgCount
)))
1385 mdot
= (int)PTR2SIZE(mp
- message
+ 1);
1386 else if (mb
.mb_threaded
) {
1387 for (mp
= threadroot
; mp
; mp
= next_in_thread(mp
))
1388 if (!(mp
->m_flag
& avoid
))
1390 mdot
= (mp
!= NULL
) ? (int)PTR2SIZE(mp
- message
+ 1) : 1;
1392 for (mp
= message
; PTRCMP(mp
, <, message
+ msgCount
); ++mp
)
1393 if (!(mp
->m_flag
& avoid
))
1395 mdot
= PTRCMP(mp
, <, message
+ msgCount
)
1396 ? (int)PTR2SIZE(mp
- message
+ 1) : 1;
1404 initbox(char const *name
)
1409 if (mb
.mb_type
!= MB_VOID
)
1410 n_strlcpy(prevfile
, mailname
, PATH_MAX
);
1412 /* TODO name always NE mailname (but goes away for objects anyway)
1413 * TODO Well, not true no more except that in parens */
1414 _update_mailname((name
!= mailname
) ? name
: NULL
);
1416 if ((mb
.mb_otf
= Ftmp(&tempMesg
, "tmpbox", OF_WRONLY
| OF_HOLDSIGS
, 0600)) ==
1418 n_perr(_("temporary mail message file"), 0);
1421 if ((mb
.mb_itf
= safe_fopen(tempMesg
, "r", NULL
)) == NULL
) {
1422 n_perr(_("temporary mail message file"), 0);
1425 Ftmp_release(&tempMesg
);
1429 if (mb
.mb_sorted
!= NULL
) {
1431 mb
.mb_sorted
= NULL
;
1434 mb
.mb_flags
= MB_NOFLAGS
;
1436 dot
= prevdot
= threadroot
= NULL
;
1437 pstate
&= ~PS_DID_PRINT_DOT
;
1441 #ifdef HAVE_DOCSTRINGS
1443 print_comm_docstr(char const *comm
)
1445 struct cmd_ghost
const *cg
;
1446 struct cmd
const *cp
;
1450 /* Ghosts take precedence */
1451 for (cg
= _cmd_ghosts
; cg
!= NULL
; cg
= cg
->next
)
1452 if (!strcmp(comm
, cg
->name
)) {
1453 printf("%s -> ", comm
);
1458 for (cp
= _cmd_tab
; cp
->name
!= NULL
; ++cp
) {
1459 if (cp
->func
== &c_cmdnotsupp
)
1461 if (!strcmp(comm
, cp
->name
))
1462 printf("%s: %s\n", comm
, V_(cp
->doc
));
1463 else if (is_prefix(comm
, cp
->name
))
1464 printf("%s (%s): %s\n", comm
, cp
->name
, V_(cp
->doc
));
1471 if (!rv
&& cg
!= NULL
) {
1472 printf("\"%s\"\n", comm
);