File: fetch.go

package info (click to toggle)
golang-github-protonmail-gluon 0.17.0-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 16,020 kB
  • sloc: sh: 55; makefile: 5
file content (472 lines) | stat: -rw-r--r-- 10,766 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
package command

import (
	"fmt"
	"strings"

	"github.com/ProtonMail/gluon/rfcparser"
)

type FetchAttribute interface {
	String() string
}

type Fetch struct {
	SeqSet     []SeqRange
	Attributes []FetchAttribute
}

func (f Fetch) String() string {
	return fmt.Sprintf("FETCH %v %v", f.SeqSet, f.Attributes)
}

func (f Fetch) SanitizedString() string {
	return f.String()
}

type FetchCommandParser struct{}

func (FetchCommandParser) FromParser(p *rfcparser.Parser) (Payload, error) {
	//fetch           = "FETCH" SP sequence-set SP ("ALL" / "FULL" / "FAST" /
	//                  fetch-att / "(" fetch-att *(SP fetch-att) ")")
	if err := p.Consume(rfcparser.TokenTypeSP, "expected space after command"); err != nil {
		return nil, err
	}

	seqSet, err := ParseSeqSet(p)
	if err != nil {
		return nil, err
	}

	if err := p.Consume(rfcparser.TokenTypeSP, "expected space after sequence set"); err != nil {
		return nil, err
	}

	var attributes []FetchAttribute

	if p.Check(rfcparser.TokenTypeLParen) {
		// Multiple list of attributes.
		attr, err := parseFetchAttributes(p)
		if err != nil {
			return nil, err
		}

		attributes = attr
	} else {
		// One single attribute.
		attribute, err := parseFetchAttributeName(p)
		if err != nil {
			return nil, err
		}

		switch attribute.Value {
		case "all":
			attributes = []FetchAttribute{&FetchAttributeAll{}}
		case "full":
			attributes = []FetchAttribute{&FetchAttributeFull{}}
		case "fast":
			attributes = []FetchAttribute{&FetchAttributeFast{}}
		default:
			attr, err := handleFetchAttribute(attribute, p)
			if err != nil {
				return nil, err
			}

			attributes = []FetchAttribute{attr}
		}
	}

	return &Fetch{SeqSet: seqSet, Attributes: attributes}, nil
}

func parseFetchAttributeName(p *rfcparser.Parser) (rfcparser.String, error) {
	att, err := p.CollectBytesWhileMatches(rfcparser.TokenTypeChar)
	if err != nil {
		return rfcparser.String{}, err
	}

	return att.IntoString().ToLower(), nil
}

func parseFetchAttributes(p *rfcparser.Parser) ([]FetchAttribute, error) {
	var attributes []FetchAttribute

	if err := p.Consume(rfcparser.TokenTypeLParen, "expected ( for fetch attribute list start"); err != nil {
		return nil, err
	}

	// First attribute.
	{
		attribute, err := parseFetchAttribute(p)
		if err != nil {
			return nil, err
		}

		attributes = append(attributes, attribute)
	}

	// Remaining.
	for {
		if ok, err := p.Matches(rfcparser.TokenTypeSP); err != nil {
			return nil, err
		} else if !ok {
			break
		}

		attribute, err := parseFetchAttribute(p)
		if err != nil {
			return nil, err
		}

		attributes = append(attributes, attribute)
	}

	if err := p.Consume(rfcparser.TokenTypeRParen, "expected ) for fetch attribute list end"); err != nil {
		return nil, err
	}

	return attributes, nil
}

func parseFetchAttribute(p *rfcparser.Parser) (FetchAttribute, error) {
	attribute, err := parseFetchAttributeName(p)
	if err != nil {
		return nil, err
	}

	attr, err := handleFetchAttribute(attribute, p)
	if err != nil {
		return nil, err
	}

	return attr, nil
}

func handleFetchAttribute(name rfcparser.String, p *rfcparser.Parser) (FetchAttribute, error) {
	/*
	 fetch-att       = "ENVELOPE" / "FLAGS" / "INTERNALDATE" /
	                    "RFC822" [".HEADER" / ".SIZE" / ".TEXT"] /
	                    "BODY" ["STRUCTURE"] / "UID" /
	                    "BODY" section ["<" number "." nz-number ">"] /
	                    "BODY.PEEK" section ["<" number "." nz-number ">"]
	*/
	switch name.Value {
	case "envelope":
		return &FetchAttributeEnvelope{}, nil
	case "flags":
		return &FetchAttributeFlags{}, nil
	case "internaldate":
		return &FetchAttributeInternalDate{}, nil
	case "bodystructure":
		return &FetchAttributeBodyStructure{}, nil
	case "uid":
		return &FetchAttributeUID{}, nil
	case "rfc":
		return handleRFC822FetchAttribute(p)
	case "body":
		return handleBodyFetchAttribute(p)
	default:
		return nil, p.MakeErrorAtOffset(fmt.Sprintf("unknown fetch attribute '%v'", name.Value), name.Offset)
	}
}

func handleRFC822FetchAttribute(p *rfcparser.Parser) (FetchAttribute, error) {
	if err := p.ConsumeBytesFold('8', '2', '2'); err != nil {
		return nil, err
	}

	if ok, err := p.Matches(rfcparser.TokenTypePeriod); err != nil {
		return nil, err
	} else if !ok {
		return &FetchAttributeRFC822{}, nil
	}

	attribute, err := parseFetchAttributeName(p)
	if err != nil {
		return nil, err
	}

	switch attribute.Value {
	case "header":
		return &FetchAttributeRFC822Header{}, nil
	case "size":
		return &FetchAttributeRFC822Size{}, nil
	case "text":
		return &FetchAttributeRFC822Text{}, nil
	default:
		return nil, p.MakeErrorAtOffset(fmt.Sprintf("unknown fetch attribute 'RFC822.%v", attribute.Value), attribute.Offset)
	}
}

func handleBodyFetchAttribute(p *rfcparser.Parser) (FetchAttribute, error) {
	// Check if we are dealing with BODY only
	if !p.Check(rfcparser.TokenTypeLBracket) && !p.Check(rfcparser.TokenTypePeriod) {
		return &FetchAttributeBody{}, nil
	}

	var readOnly = false

	if ok, err := p.Matches(rfcparser.TokenTypePeriod); err != nil {
		return nil, err
	} else if ok {
		if err := p.ConsumeBytesFold('P', 'E', 'E', 'K'); err != nil {
			return nil, err
		}

		readOnly = true
	}

	if err := p.Consume(rfcparser.TokenTypeLBracket, "expected [ for body section start"); err != nil {
		return nil, err
	}

	var section BodySection

	if !p.Check(rfcparser.TokenTypeRBracket) {
		s, err := parseSectionSpec(p)
		if err != nil {
			return nil, err
		}

		section = s
	}

	if err := p.Consume(rfcparser.TokenTypeRBracket, "expected ] for body section end"); err != nil {
		return nil, err
	}

	var partial *BodySectionPartial

	if ok, err := p.Matches(rfcparser.TokenTypeLess); err != nil {
		return nil, err
	} else if ok {
		offset, err := p.ParseNumber()
		if err != nil {
			return nil, err
		}

		if err := p.Consume(rfcparser.TokenTypePeriod, "expected '.' after partial start"); err != nil {
			return nil, err
		}

		count, err := ParseNZNumber(p)
		if err != nil {
			return nil, err
		}

		if err := p.Consume(rfcparser.TokenTypeGreater, "expected > for end of partial specification"); err != nil {
			return nil, err
		}

		partial = &BodySectionPartial{
			Offset: int64(offset),
			Count:  int64(count),
		}
	}

	return &FetchAttributeBodySection{Peek: readOnly, Section: section, Partial: partial}, nil
}

func parseSectionSpec(p *rfcparser.Parser) (BodySection, error) {
	// section-spec    = section-msgtext / (section-part ["." section-text])
	if p.Check(rfcparser.TokenTypeDigit) {
		part, err := parseSectionPart(p)
		if err != nil {
			return nil, err
		}

		var textSection BodySection

		if p.Check(rfcparser.TokenTypeChar) {
			// Note: trailing . is consumed by parserSectionPart().
			text, err := parseSectionText(p)
			if err != nil {
				return nil, err
			}

			textSection = text
		}

		return &BodySectionPart{Part: part, Section: textSection}, nil
	}

	return parseSectionMsgText(p)
}

func parseSectionPart(p *rfcparser.Parser) ([]int, error) {
	// section-part    = nz-number *("." nz-number)
	//                     ; body part nesting
	var result []int

	{
		num, err := ParseNZNumber(p)
		if err != nil {
			return nil, err
		}

		result = append(result, num)
	}

	for {
		if ok, err := p.Matches(rfcparser.TokenTypePeriod); err != nil {
			return nil, err
		} else if !ok {
			break
		}

		// If there is section-text after the section-part we can continue with number processing.
		if !p.Check(rfcparser.TokenTypeDigit) {
			break
		}

		num, err := ParseNZNumber(p)
		if err != nil {
			return nil, err
		}

		result = append(result, num)
	}

	return result, nil
}

func parseSectionText(p *rfcparser.Parser) (BodySection, error) {
	// section-text    = section-msgtext / "MIME"
	//                    ; text other than actual body part (headers, etc.)
	text, err := p.CollectBytesWhileMatches(rfcparser.TokenTypeChar)
	if err != nil {
		return nil, err
	}

	textStr := text.IntoString().ToLower()

	if textStr.Value == "mime" {
		return &BodySectionMIME{}, nil
	}

	return handleSectionMessageText(textStr, p)
}

func parseSectionMsgText(p *rfcparser.Parser) (BodySection, error) {
	text, err := p.CollectBytesWhileMatches(rfcparser.TokenTypeChar)
	if err != nil {
		return nil, err
	}

	textStr := text.IntoString().ToLower()

	return handleSectionMessageText(textStr, p)
}

func handleSectionMessageText(text rfcparser.String, p *rfcparser.Parser) (BodySection, error) {
	// section-msgtext = "HEADER" / "HEADER.FIELDS" [".NOT"] SP header-list /
	//                   "TEXT"
	//                    ; top-level or MESSAGE/RFC822 part
	switch text.Value {
	case "header":
		if ok, err := p.Matches(rfcparser.TokenTypePeriod); err != nil {
			return nil, err
		} else if !ok {
			return &BodySectionHeader{}, nil
		}

		return parseHeaderFieldsSectionMessageText(p)

	case "text":
		return &BodySectionText{}, nil
	default:
		return nil, p.MakeErrorAtOffset(fmt.Sprintf("unknown section msg text value '%v'", text.Value), text.Offset)
	}
}

func parseHeaderFieldsSectionMessageText(p *rfcparser.Parser) (BodySection, error) {
	// Read fields bit
	{
		text, err := collectBodySectionText(p)
		if err != nil {
			return nil, err
		}

		if text != "fields" {
			return nil, p.MakeError("expected 'FIELDS' after 'HEADER.'")
		}
	}

	var negate bool

	if ok, err := p.Matches(rfcparser.TokenTypePeriod); err != nil {
		return nil, err
	} else if ok {
		text, err := collectBodySectionText(p)
		if err != nil {
			return nil, err
		}

		if text != "not" {
			return nil, p.MakeError("expected 'NOT'")
		}

		negate = true
	}

	if err := p.Consume(rfcparser.TokenTypeSP, "expected space"); err != nil {
		return nil, err
	}

	headerList, err := parseHeaderList(p)
	if err != nil {
		return nil, err
	}

	return &BodySectionHeaderFields{
		Negate: negate,
		Fields: headerList,
	}, nil
}

func collectBodySectionText(p *rfcparser.Parser) (string, error) {
	text, err := p.CollectBytesWhileMatches(rfcparser.TokenTypeChar)
	if err != nil {
		return "", err
	}

	return strings.ToLower(string(text.Value)), nil
}

func parseHeaderList(p *rfcparser.Parser) ([]string, error) {
	var result []string

	if err := p.Consume(rfcparser.TokenTypeLParen, "expected ( for header list start"); err != nil {
		return nil, err
	}

	{
		header, err := p.ParseAString()
		if err != nil {
			return nil, err
		}

		result = append(result, header.Value)
	}

	for {
		if ok, err := p.Matches(rfcparser.TokenTypeSP); err != nil {
			return nil, err
		} else if !ok {
			break
		}

		header, err := p.ParseAString()
		if err != nil {
			return nil, err
		}

		result = append(result, header.Value)
	}

	if err := p.Consume(rfcparser.TokenTypeRParen, "expected ) for header list end"); err != nil {
		return nil, err
	}

	return result, nil
}