11 "github.com/mjl-/mox/mlog"
16 char = charRange('\x01', '\x7f')
17 ctl = charRange('\x01', '\x19')
20 atomChar = charRemove(char, "(){ "+ctl+listWildcards+quotedSpecials+respSpecials)
21 astringChar = atomChar + respSpecials
24func charRange(first, last rune) string {
35func charRemove(s, remove string) string {
39 for _, x := range remove {
50 // Orig is the line in original casing, and upper in upper casing. We often match
51 // against upper for easy case insensitive handling as IMAP requires, but sometimes
52 // return from orig to keep the original case.
55 o int // Current offset in parsing.
56 contexts []string // What we're parsing, for error messages.
60// toUpper upper cases bytes that are a-z. strings.ToUpper does too much. and
61// would replace invalid bytes with unicode replacement characters, which would
62// break our requirement that offsets into the original and upper case strings
63// point to the same character.
64func toUpper(s string) string {
67 if c >= 'a' && c <= 'z' {
74func newParser(s string, conn *conn) *parser {
75 return &parser{s, toUpper(s), 0, nil, conn}
78func (p *parser) xerrorf(format string, args ...any) {
80 errmsg := fmt.Sprintf(format, args...)
81 remaining := fmt.Sprintf("remaining %q", p.orig[p.o:])
82 if len(p.contexts) > 0 {
83 remaining += ", context " + strings.Join(p.contexts, ",")
85 remaining = " (" + remaining + ")"
86 if p.conn.account != nil {
88 err = errors.New(errmsg)
90 err = errors.New(errmsg + remaining)
92 panic(syntaxError{"", "", errmsg, err})
95func (p *parser) context(s string) func() {
96 p.contexts = append(p.contexts, s)
98 p.contexts = p.contexts[:len(p.contexts)-1]
102func (p *parser) empty() bool {
103 return p.o == len(p.upper)
106func (p *parser) xempty() {
108 p.xerrorf("leftover data")
112func (p *parser) hasPrefix(s string) bool {
113 return strings.HasPrefix(p.upper[p.o:], s)
116func (p *parser) take(s string) bool {
124func (p *parser) xtake(s string) {
126 p.xerrorf("expected %s", s)
130func (p *parser) xnonempty() {
132 p.xerrorf("unexpected end")
136func (p *parser) xtakeall() string {
142func (p *parser) xtake1n(n int, what string) string {
144 p.xerrorf("expected chars from %s", what)
149func (p *parser) xtakechars(s string, what string) string {
151 for i, c := range p.orig[p.o:] {
153 return p.xtake1n(i, what)
159func (p *parser) xtaken(n int) string {
160 if p.o+n > len(p.orig) {
161 p.xerrorf("not enough data")
163 r := p.orig[p.o : p.o+n]
168func (p *parser) space() bool {
172func (p *parser) xspace() {
174 p.xerrorf("expected space")
178func (p *parser) digits() string {
180 for _, c := range p.upper[p.o:] {
181 if c < '0' || c > '9' {
189 s := p.upper[p.o : p.o+n]
194func (p *parser) nznumber() (uint32, bool) {
196 for o < len(p.upper) && p.upper[o] >= '0' && p.upper[o] <= '9' {
202 if n, err := strconv.ParseUint(p.upper[p.o:o], 10, 32); err != nil {
208 return uint32(n), true
212func (p *parser) xnznumber() uint32 {
213 n, ok := p.nznumber()
215 p.xerrorf("expected non-zero number")
220func (p *parser) number() (uint32, bool) {
222 for o < len(p.upper) && p.upper[o] >= '0' && p.upper[o] <= '9' {
228 n, err := strconv.ParseUint(p.upper[p.o:o], 10, 32)
233 return uint32(n), true
236func (p *parser) xnumber() uint32 {
239 p.xerrorf("expected number")
244func (p *parser) xnumber64() int64 {
247 p.xerrorf("expected number64")
251 p.xerrorf("parsing number64 %q: %v", s, err)
256func (p *parser) xnznumber64() int64 {
259 p.xerrorf("expected non-zero number64")
264// l should be a list of uppercase words, the first match is returned
265func (p *parser) takelist(l ...string) (string, bool) {
266 for _, w := range l {
274func (p *parser) xtakelist(l ...string) string {
275 w, ok := p.takelist(l...)
277 p.xerrorf("expected one of %s", strings.Join(l, ","))
282func (p *parser) xstring() (r string) {
286 for i, c := range p.orig[p.o:] {
289 } else if c == '\x00' || c == '\r' || c == '\n' {
290 p.xerrorf("invalid nul, cr or lf in string")
292 if c == '\\' || c == '"' {
296 p.xerrorf("invalid escape char %c", c)
305 p.xerrorf("missing closing dquote in string")
307 size, sync := p.xliteralSize(100*1024, false)
308 s := p.conn.xreadliteral(size, sync)
309 line := p.conn.readline(false)
310 p.orig, p.upper, p.o = line, toUpper(line), 0
314func (p *parser) xnil() {
318// Returns NIL as empty string.
319func (p *parser) xnilString() string {
326func (p *parser) xastring() string {
327 if p.hasPrefix(`"`) || p.hasPrefix("{") || p.hasPrefix("~{") {
330 return p.xtakechars(astringChar, "astring")
333func contains(s string, c rune) bool {
334 for _, x := range s {
342func (p *parser) xtag() string {
344 for i, c := range p.orig[p.o:] {
345 if c == '+' || !contains(astringChar, c) {
346 return p.xtake1n(i, "tag")
352func (p *parser) xcommand() string {
353 for i, c := range p.upper[p.o:] {
354 if !(c >= 'A' && c <= 'Z' || c == ' ' && p.upper[p.o:p.o+i] == "UID") {
355 return p.xtake1n(i, "command")
361func (p *parser) remainder() string {
366func (p *parser) xflag() string {
367 w, _ := p.takelist(`\`, "$")
370 switch strings.ToLower(s) {
371 case `\answered`, `\flagged`, `\deleted`, `\seen`, `\draft`:
373 p.xerrorf("unknown system flag %s", s)
379func (p *parser) xflagList() (l []string) {
381 if !p.hasPrefix(")") {
382 l = append(l, p.xflag())
386 l = append(l, p.xflag())
391func (p *parser) xatom() string {
392 return p.xtakechars(atomChar, "atom")
395func (p *parser) xmailbox() string {
397 // UTF-7 is deprecated in IMAP4rev2. IMAP4rev1 does not fully forbid
398 // UTF-8 returned in mailbox names. We'll do our best by attempting to
399 // decode utf-7. But if that doesn't work, we'll just use the original
402 if !p.conn.enabled[capIMAP4rev2] {
403 ns, err := utf7decode(s)
405 p.conn.log.Infox("decoding utf7 or mailbox name", err, mlog.Field("name", s))
414func (p *parser) xlistMailbox() string {
415 if p.hasPrefix(`"`) || p.hasPrefix("{") {
418 return p.xtakechars(atomChar+listWildcards+respSpecials, "list-char")
422func (p *parser) xmboxOrPat() ([]string, bool) {
424 return []string{p.xlistMailbox()}, false
426 l := []string{p.xlistMailbox()}
429 l = append(l, p.xlistMailbox())
435func (p *parser) xstatusAtt() string {
436 w := p.xtakelist("MESSAGES", "UIDNEXT", "UIDVALIDITY", "UNSEEN", "DELETED", "SIZE", "RECENT", "APPENDLIMIT", "HIGHESTMODSEQ")
437 if w == "HIGHESTMODSEQ" {
439 p.conn.enabled[capCondstore] = true
445func (p *parser) xnumSet0(allowStar, allowSearch bool) (r numSet) {
446 defer p.context("numSet")()
447 if allowSearch && p.take("$") {
448 return numSet{searchResult: true}
450 r.ranges = append(r.ranges, p.xnumRange0(allowStar))
452 r.ranges = append(r.ranges, p.xnumRange0(allowStar))
457func (p *parser) xnumSet() (r numSet) {
458 return p.xnumSet0(true, true)
461// parse numRange, which can be just a setNumber.
462func (p *parser) xnumRange0(allowStar bool) (r numRange) {
463 if allowStar && p.take("*") {
466 r.first.number = p.xnznumber()
469 r.last = &setNumber{}
470 if allowStar && p.take("*") {
473 r.last.number = p.xnznumber()
480func (p *parser) xsectionMsgtext() (r *sectionMsgtext) {
481 defer p.context("sectionMsgtext")()
482 msgtextWords := []string{"HEADER.FIELDS.NOT", "HEADER.FIELDS", "HEADER", "TEXT"}
483 w := p.xtakelist(msgtextWords...)
484 r = §ionMsgtext{s: w}
485 if strings.HasPrefix(w, "HEADER.FIELDS") {
488 r.headers = append(r.headers, textproto.CanonicalMIMEHeaderKey(p.xastring()))
494 r.headers = append(r.headers, textproto.CanonicalMIMEHeaderKey(p.xastring()))
501func (p *parser) xsectionSpec() (r *sectionSpec) {
502 defer p.context("parseSectionSpec")()
504 n, ok := p.nznumber()
506 return §ionSpec{msgtext: p.xsectionMsgtext()}
508 defer p.context("part...")()
510 pt.part = append(pt.part, n)
515 if n, ok := p.nznumber(); ok {
516 pt.part = append(pt.part, n)
520 pt.text = §ionText{mime: true}
523 pt.text = §ionText{msgtext: p.xsectionMsgtext()}
526 return §ionSpec{part: pt}
530func (p *parser) xsection() *sectionSpec {
531 defer p.context("parseSection")()
534 return §ionSpec{}
536 r := p.xsectionSpec()
542func (p *parser) xpartial() *partial {
544 offset := p.xnumber()
546 count := p.xnznumber()
548 return &partial{offset, count}
552func (p *parser) xsectionBinary() (r []uint32) {
557 r = append(r, p.xnznumber())
562 r = append(r, p.xnznumber())
568var fetchAttWords = []string{
569 "ENVELOPE", "FLAGS", "INTERNALDATE", "RFC822.SIZE", "BODYSTRUCTURE", "UID", "BODY.PEEK", "BODY", "BINARY.PEEK", "BINARY.SIZE", "BINARY",
570 "RFC822.HEADER", "RFC822.TEXT", "RFC822", // older IMAP
571 "MODSEQ", // CONDSTORE extension.
575func (p *parser) xfetchAtt(isUID bool) (r fetchAtt) {
576 defer p.context("fetchAtt")()
577 f := p.xtakelist(fetchAttWords...)
578 r.peek = strings.HasSuffix(f, ".PEEK")
579 r.field = strings.TrimSuffix(f, ".PEEK")
583 if p.hasPrefix("[") {
584 r.section = p.xsection()
585 if p.hasPrefix("<") {
586 r.partial = p.xpartial()
590 r.sectionBinary = p.xsectionBinary()
591 if p.hasPrefix("<") {
592 r.partial = p.xpartial()
595 r.sectionBinary = p.xsectionBinary()
597 // The RFC text mentions MODSEQ is only for FETCH, not UID FETCH, but the ABNF adds
598 // the attribute to the shared syntax, so UID FETCH also implements it.
602 p.conn.xensureCondstore(nil)
608func (p *parser) xfetchAtts(isUID bool) []fetchAtt {
609 defer p.context("fetchAtts")()
611 fields := func(l ...string) []fetchAtt {
612 r := make([]fetchAtt, len(l))
613 for i, s := range l {
614 r[i] = fetchAtt{field: s}
619 if w, ok := p.takelist("ALL", "FAST", "FULL"); ok {
622 return fields("FLAGS", "INTERNALDATE", "RFC822.SIZE", "ENVELOPE")
624 return fields("FLAGS", "INTERNALDATE", "RFC822.SIZE")
626 return fields("FLAGS", "INTERNALDATE", "RFC822.SIZE", "ENVELOPE", "BODY")
628 panic("missing case")
631 if !p.hasPrefix("(") {
632 return []fetchAtt{p.xfetchAtt(isUID)}
638 l = append(l, p.xfetchAtt(isUID))
647func xint(p *parser, s string) int {
648 v, err := strconv.ParseInt(s, 10, 32)
650 p.xerrorf("bad int %q: %v", s, err)
655func (p *parser) digit() (string, bool) {
660 if c < '0' || c > '9' {
663 s := p.orig[p.o : p.o+1]
668func (p *parser) xdigit() string {
671 p.xerrorf("expected digit")
677func (p *parser) xdateDayFixed() int {
679 return xint(p, p.xdigit())
681 return xint(p, p.xdigit()+p.xdigit())
684var months = []string{"jan", "feb", "mar", "apr", "may", "jun", "jul", "aug", "sep", "oct", "nov", "dec"}
687func (p *parser) xdateMonth() time.Month {
688 s := strings.ToLower(p.xtaken(3))
689 for i, m := range months {
691 return time.Month(1 + i)
694 p.xerrorf("unknown month %q", s)
699func (p *parser) xtime() (int, int, int) {
700 h := xint(p, p.xtaken(2))
702 m := xint(p, p.xtaken(2))
704 s := xint(p, p.xtaken(2))
709func (p *parser) xzone() (string, int) {
710 sign := p.xtakelist("+", "-")
713 seconds := (v/100)*3600 + (v%100)*60
717 return sign + s, seconds
721func (p *parser) xdateTime() time.Time {
722 // DQUOTE date-day-fixed "-" date-month "-" date-year SP time SP zone DQUOTE
724 day := p.xdateDayFixed()
726 month := p.xdateMonth()
728 year := xint(p, p.xtaken(4))
730 hours, minutes, seconds := p.xtime()
732 name, zoneSeconds := p.xzone()
734 loc := time.FixedZone(name, zoneSeconds)
735 return time.Date(year, month, day, hours, minutes, seconds, 0, loc)
739func (p *parser) xliteralSize(maxSize int64, lit8 bool) (size int64, sync bool) {
740 // todo: enforce that we get non-binary when ~ isn't present?
746 if maxSize > 0 && size > maxSize {
748 line := fmt.Sprintf("* BYE [ALERT] Max literal size %d is larger than allowed %d in this context", size, maxSize)
749 err := errors.New("literal too big")
750 panic(syntaxError{line, "TOOBIG", err.Error(), err})
759var searchKeyWords = []string{
760 "ALL", "ANSWERED", "BCC",
762 "CC", "DELETED", "FLAGGED",
764 "NEW", "OLD", "ON", "RECENT", "SEEN",
767 "UNANSWERED", "UNDELETED", "UNFLAGGED",
768 "UNKEYWORD", "UNSEEN",
772 "SENTBEFORE", "SENTON",
773 "SENTSINCE", "SMALLER",
775 "MODSEQ", // CONDSTORE extension.
779// differences: rfc 9051 removes NEW, OLD, RECENT and makes SMALLER and LARGER number64 instead of number.
780func (p *parser) xsearchKey() *searchKey {
783 l := []searchKey{*sk}
786 l = append(l, *p.xsearchKey())
788 return &searchKey{searchKeys: l}
791 w, ok := p.takelist(searchKeyWords...)
794 return &searchKey{seqSet: &seqs}
797 sk := &searchKey{op: w}
803 sk.astring = p.xastring()
809 sk.astring = p.xastring()
812 sk.astring = p.xastring()
817 sk.astring = p.xastring()
833 sk.astring = p.xastring()
836 sk.astring = p.xastring()
839 sk.astring = p.xastring()
850 sk.headerField = p.xastring()
852 sk.astring = p.xastring()
855 sk.number = p.xnumber64()
858 sk.searchKey = p.xsearchKey()
861 sk.searchKey = p.xsearchKey()
863 sk.searchKey2 = p.xsearchKey()
875 sk.number = p.xnumber64()
878 sk.uidSet = p.xnumSet()
884 // We don't do anything with this field, so parse and ignore.
892 p.xtakelist("PRIV", "SHARED", "ALL")
898 p.conn.enabled[capCondstore] = true
900 p.xerrorf("missing case for op %q", sk.op)
905// hasModseq returns whether there is a modseq filter anywhere in the searchkey.
906func (sk searchKey) hasModseq() bool {
907 if sk.clientModseq != nil {
910 for _, e := range sk.searchKeys {
915 if sk.searchKey != nil && sk.searchKey.hasModseq() {
918 if sk.searchKey2 != nil && sk.searchKey2.hasModseq() {
925func (p *parser) xdateDay() int {
927 if s, ok := p.digit(); ok {
934func (p *parser) xdate() time.Time {
935 dquote := p.take(`"`)
938 mon := p.xdateMonth()
940 year := xint(p, p.xtaken(4))
944 return time.Date(year, mon, day, 0, 0, 0, 0, time.UTC)