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 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599
|
// Copyright 2016 Martin Hebnes Pedersen (LA5NTA). All rights reserved.
// Use of this source code is governed by the MIT-license that can be
// found in the LICENSE file.
package fbb
import (
"bufio"
"bytes"
"encoding/json"
"errors"
"fmt"
"io"
"mime"
"net/textproto"
"strconv"
"strings"
"time"
)
// ValidationError is the error type returned by functions validating a message.
type ValidationError struct {
Field string // The field/part of the message that is not valid
Err string // Description of the error
}
func (e ValidationError) Error() string { return e.Err }
// Representation of a receiver/sender address.
type Address struct {
Proto string
Addr string
}
// File represents an attachment.
type File struct {
data []byte
name string
err error
}
// Message represent the Winlink 2000 Message Structure as defined in http://winlink.org/B2F.
type Message struct {
// The header names are case-insensitive.
//
// Users should normally access common header fields
// using the appropriate Message methods.
Header Header
body []byte
files []*File
}
type MsgType string
const (
Private MsgType = "Private"
Service = "Service"
Inquiry = "Inquiry"
PositionReport = "Position Report"
Option = "Option"
System = "System"
)
// Slice of date layouts that should be tried when parsing the Date header.
var dateLayouts = []string{
DateLayout, // The correct layout according to Winlink (2006/01/02 15:04).
`2006.01.02 15:04`, // Undocumented layout seen when RMS Relay-3.0.27.1 was operating in store-and-forward mode.
`2006-01-02 15:04`, // Undocumented layout seen in a Radio Only message forwarded with RMS Relay-3.0.30.0.
`20060102150405`, // Older BPQ format
}
// From golang.org/src/net/mail/message.go
func init() {
// Generate layouts based on RFC 5322, section 3.3.
dows := [...]string{"", "Mon, "} // day-of-week
days := [...]string{"2", "02"} // day = 1*2DIGIT
years := [...]string{"2006", "06"} // year = 4*DIGIT / 2*DIGIT
seconds := [...]string{":05", ""} // second
// "-0700 (MST)" is not in RFC 5322, but is common.
zones := [...]string{"-0700", "MST", "-0700 (MST)"} // zone = (("+" / "-") 4DIGIT) / "GMT" / ...
for _, dow := range dows {
for _, day := range days {
for _, year := range years {
for _, second := range seconds {
for _, zone := range zones {
s := dow + day + " Jan " + year + " 15:04" + second + " " + zone
dateLayouts = append(dateLayouts, s)
}
}
}
}
}
}
// NewMessage initializes and returns a new message with Type, Mbo, From and Date set.
//
// If the message type t is empty, it defaults to Private.
func NewMessage(t MsgType, mycall string) *Message {
msg := &Message{
Header: make(Header),
}
msg.Header.Set(HEADER_MID, GenerateMid(mycall))
msg.SetDate(time.Now())
msg.SetFrom(mycall)
msg.Header.Set(HEADER_MBO, mycall)
if t == "" {
t = Private
}
msg.Header.Set(HEADER_TYPE, string(t))
return msg
}
// Validate returns an error if this message violates any Winlink Message Structure constraints
func (m *Message) Validate() error {
switch {
case m.MID() == "":
return ValidationError{"MID", "Empty MID"}
case len(m.MID()) > 12:
return ValidationError{"MID", "MID too long"}
case len(m.Receivers()) == 0:
// This is not documented, but the CMS refuses to accept such messages (with good reason)
return ValidationError{"To/Cc", "No recipient"}
case m.Header.Get(HEADER_FROM) == "":
return ValidationError{"From", "Empty From field"}
case m.BodySize() == 0:
return ValidationError{"Body", "Empty body"}
case len(m.Header.Get(HEADER_SUBJECT)) == 0:
// This is not documented, but the CMS writes the proposal title if this is empty
// (which I guess is a compatibility hack on their end).
return ValidationError{HEADER_SUBJECT, "Empty subject"}
case len(m.Header.Get(HEADER_SUBJECT)) > 128:
return ValidationError{HEADER_SUBJECT, "Subject too long"}
}
// The CMS seems to accept this, but according to the winlink.org/B2F document it is not allowed:
// "... and the file name (up to 50 characters) of the original file."
// WDT made an amendment to the B2F specification 2020-05-27: New limit is 255 characters.
for _, f := range m.Files() {
if len(f.Name()) > 255 {
return ValidationError{"Files", fmt.Sprintf("Attachment file name too long: %s", f.Name())}
}
}
return nil
}
// MID returns the unique identifier of this message across the winlink system.
func (m *Message) MID() string { return m.Header.Get(HEADER_MID) }
// SetSubject sets this message's subject field.
//
// The Winlink Message Format only allow ASCII characters. Words containing non-ASCII characters are Q-encoded with DefaultCharset (as defined by RFC 2047).
func (m *Message) SetSubject(str string) {
encoded, _ := toCharset(DefaultCharset, str)
encoded = mime.QEncoding.Encode(DefaultCharset, encoded)
m.Header.Set(HEADER_SUBJECT, encoded)
}
// Subject returns this message's subject header decoded using WordDecoder.
func (m *Message) Subject() string {
str, _ := new(WordDecoder).DecodeHeader(m.Header.Get(HEADER_SUBJECT))
return str
}
// Type returns the message type.
//
// See MsgType consts for details.
func (m *Message) Type() MsgType { return MsgType(m.Header.Get(HEADER_TYPE)) }
// Mbo returns the mailbox operator origin of this message.
func (m *Message) Mbo() string { return m.Header.Get(HEADER_MBO) }
// Body returns this message's body encoded as utf8.
func (m *Message) Body() (string, error) { return BodyFromBytes(m.body, m.Charset()) }
// Files returns the message attachments.
func (m *Message) Files() []*File { return m.files }
// SetFrom sets the From header field.
//
// SMTP: prefix is automatically added if needed, see AddressFromString.
func (m *Message) SetFrom(addr string) { m.Header.Set(HEADER_FROM, AddressFromString(addr).String()) }
// From returns the From header field as an Address.
func (m *Message) From() Address { return AddressFromString(m.Header.Get(HEADER_FROM)) }
// Set date sets the Date header field.
//
// The field is set in the format DateLayout, UTC.
func (m *Message) SetDate(t time.Time) { m.Header.Set(HEADER_DATE, t.UTC().Format(DateLayout)) }
// Date parses the Date header field according to the winlink format.
//
// Parse errors are omitted, but it's checked at serialization.
func (m *Message) Date() time.Time {
date, _ := ParseDate(m.Header.Get(HEADER_DATE))
return date
}
// SetBodyWithCharset translates and sets the body according to given charset.
//
// Header field Content-Transfer-Encoding is set to DefaultTransferEncoding.
// Header field Content-Type is set according to charset.
// All lines are modified to ensure CRLF.
//
// Use SetBody to use default character encoding.
func (m *Message) SetBodyWithCharset(charset, body string) error {
m.Header.Set(HEADER_CONTENT_TRANSFER_ENCODING, DefaultTransferEncoding)
m.Header.Set(HEADER_CONTENT_TYPE, mime.FormatMediaType(
"text/plain",
map[string]string{"charset": DefaultCharset},
))
bytes, err := StringToBody(body, DefaultCharset)
if err != nil {
return err
}
m.body = bytes
m.Header.Set(HEADER_BODY, fmt.Sprintf("%d", len(bytes)))
return nil
}
// SetBody sets the given string as message body using DefaultCharset.
//
// See SetBodyWithCharset for more info.
func (m *Message) SetBody(body string) error {
return m.SetBodyWithCharset(DefaultCharset, body)
}
// BodySize returns the expected size of the body (in bytes) as defined in the header.
func (m *Message) BodySize() int { size, _ := strconv.Atoi(m.Header.Get(HEADER_BODY)); return size }
// Charset returns the body character encoding as defined in the ContentType header field.
//
// If the header field is unset, DefaultCharset is returned.
func (m *Message) Charset() string {
_, params, err := mime.ParseMediaType(m.Header.Get(HEADER_CONTENT_TYPE))
if err != nil {
return DefaultCharset
}
if v, ok := params["charset"]; ok {
return v
}
return DefaultCharset
}
// AddTo adds a new receiver for this message.
//
// It adds a new To header field per given address.
// SMTP: prefix is automatically added if needed, see AddressFromString.
func (m *Message) AddTo(addr ...string) {
for _, a := range addr {
m.Header.Add(HEADER_TO, AddressFromString(a).String())
}
}
// AddCc adds a new carbon copy receiver to this message.
//
// It adds a new Cc header field per given address.
// SMTP: prefix is automatically added if needed, see AddressFromString.
func (m *Message) AddCc(addr ...string) {
for _, a := range addr {
m.Header.Add(HEADER_CC, AddressFromString(a).String())
}
}
// To returns primary receivers of this message.
func (m *Message) To() (to []Address) {
for _, str := range m.Header[HEADER_TO] {
to = append(to, AddressFromString(str))
}
return
}
// Cc returns the carbon copy receivers of this message.
func (m *Message) Cc() (cc []Address) {
for _, str := range m.Header[HEADER_CC] {
cc = append(cc, AddressFromString(str))
}
return
}
// copied from from stdlib's bytes/bytes.go
var asciiSpace = [256]uint8{'\t': 1, '\n': 1, '\v': 1, '\f': 1, '\r': 1, ' ': 1}
// trimLeft advances the reader until the first byte not
func trimLeftSpace(r *bufio.Reader) {
for {
b, err := r.Peek(1)
if err != nil || asciiSpace[b[0]] == 0 {
break
}
r.Discard(len(b))
}
}
// Implements ReaderFrom for Message.
//
// Reads the given io.Reader and fills in values fetched from the stream.
func (m *Message) ReadFrom(r io.Reader) error {
reader := bufio.NewReader(r)
// Trim leading whitespace before reading the header:
// Got a mysterious bug that traced back to the possibility of a
// received message with leading CRLFs. Trimming space characters
// before reading the header should be safe, as the worst case scenario
// is that we fail to parse the header as opposed to definitely
// failing.
trimLeftSpace(reader)
if h, err := textproto.NewReader(reader).ReadMIMEHeader(); err != nil {
return err
} else {
m.Header = Header(h)
}
// Read body
var err error
m.body, err = readSection(reader, m.BodySize())
if err != nil {
return err
}
// Read files
m.files = make([]*File, len(m.Header[HEADER_FILE]))
dec := new(WordDecoder)
for i, value := range m.Header[HEADER_FILE] {
file := new(File)
m.files[i] = file
slice := strings.SplitN(value, ` `, 2)
if len(slice) != 2 {
file.err = errors.New(`Failed to parse file header. Got: ` + value)
continue
}
size, _ := strconv.Atoi(slice[0])
// The name part of this header may be utf8 encoded by Winlink Express. Use WordDecoder to be safe.
file.name, _ = dec.DecodeHeader(slice[1])
file.data, err = readSection(reader, size)
if err != nil {
file.err = err
}
}
// Return error if date field is not parseable
if err == nil {
_, err = ParseDate(m.Header.Get(HEADER_DATE))
}
return err
}
func readSection(reader *bufio.Reader, readN int) ([]byte, error) {
buf := make([]byte, readN)
var err error
n := 0
for n < readN {
m, err := reader.Read(buf[n:])
if err != nil {
break
}
n += m
}
if err != nil {
return buf, err
}
end, err := reader.ReadString('\n')
switch {
case n != readN:
return buf, io.ErrUnexpectedEOF
case err == io.EOF:
// That's ok
case err != nil:
return buf, err
case end != "\r\n":
return buf, errors.New("Unexpected end of section")
}
return buf, nil
}
// Returns true if the given Address is the only receiver of this Message.
func (m *Message) IsOnlyReceiver(addr Address) bool {
receivers := m.Receivers()
if len(receivers) != 1 {
return false
}
return strings.EqualFold(receivers[0].String(), addr.String())
}
// Method for generating a proposal of the message.
//
// An error is returned if the Validate method fails.
func (m *Message) Proposal(code PropCode) (*Proposal, error) {
data, err := m.Bytes()
if err != nil {
return nil, err
}
return NewProposal(m.MID(), m.Subject(), code, data), m.Validate()
}
// Receivers returns a slice of all receivers of this message.
func (m *Message) Receivers() []Address {
to, cc := m.To(), m.Cc()
addrs := make([]Address, 0, len(to)+len(cc))
if len(to) > 0 {
addrs = append(addrs, to...)
}
if len(cc) > 0 {
addrs = append(addrs, cc...)
}
return addrs
}
// AddFile adds the given File as an attachment to m.
func (m *Message) AddFile(f *File) {
m.files = append(m.files, f)
// According to spec, only ASCII is allowed.
encodedName, _ := toCharset(DefaultCharset, f.Name())
encodedName = mime.QEncoding.Encode(DefaultCharset, encodedName)
// Add header
m.Header.Add(HEADER_FILE, fmt.Sprintf("%d %s", f.Size(), encodedName))
}
// Bytes returns the message in the Winlink Message format.
func (m *Message) Bytes() ([]byte, error) {
var buf bytes.Buffer
if err := m.Write(&buf); err != nil {
return nil, err
}
return buf.Bytes(), nil
}
// Writes Message to the given Writer in the Winlink Message format.
//
// If the Date header field is not formatted correctly, an error will be returned.
func (m *Message) Write(w io.Writer) (err error) {
// Ensure Date field is in correct format
if _, err = ParseDate(m.Header.Get(HEADER_DATE)); err != nil {
return
}
// We use a bufio.Writer to defer error handling until Flush
writer := bufio.NewWriter(w)
// Header
m.Header.Write(writer)
writer.WriteString("\r\n") // end of headers
// Body
writer.Write(m.body)
if len(m.Files()) > 0 {
writer.WriteString("\r\n") // end of body
}
// Files (the order must be the same as they appear in the header)
for _, f := range m.Files() {
writer.Write(f.data)
writer.WriteString("\r\n") // end of file
}
return writer.Flush()
}
// Message stringer.
func (m *Message) String() string {
buf := bytes.NewBufferString(``)
w := bufio.NewWriter(buf)
fmt.Fprintln(w, "MID: ", m.MID())
fmt.Fprintln(w, `Date:`, m.Date())
fmt.Fprintln(w, `From:`, m.From())
for _, to := range m.To() {
fmt.Fprintln(w, `To:`, to)
}
for _, cc := range m.Cc() {
fmt.Fprintln(w, `Cc:`, cc)
}
fmt.Fprintln(w, `Subject:`, m.Subject())
body, _ := m.Body()
fmt.Fprintf(w, "\n%s\n", body)
fmt.Fprintln(w, "Attachments:")
for _, f := range m.Files() {
fmt.Fprintf(w, "\t%s [%d bytes]\n", f.Name(), f.Size())
}
w.Flush()
return string(buf.Bytes())
}
// JSON marshaller for File.
func (f *File) MarshalJSON() ([]byte, error) {
b, err := json.Marshal(struct {
Name string
Size int
}{f.Name(), f.Size()})
return b, err
}
// Name returns the attachment's filename.
func (f *File) Name() string { return f.name }
// Size returns the attachments's size in bytes.
func (f *File) Size() int { return len(f.data) }
// Data returns a copy of the attachment content.
func (f *File) Data() []byte {
cpy := make([]byte, len(f.data))
copy(cpy, f.data)
return cpy
}
// Create a new file (attachment) with the given name and data.
//
// A B2F file must have an associated name. If the name is empty, NewFile will panic.
func NewFile(name string, data []byte) *File {
if name == "" {
panic("Empty filename is not allowed")
}
return &File{
data: data,
name: name,
}
}
// Textual representation of Address.
func (a Address) String() string {
if a.Proto == "" {
return a.Addr
} else {
return fmt.Sprintf("%s:%s", a.Proto, a.Addr)
}
}
// IsZero reports whether the Address is unset.
func (a Address) IsZero() bool { return len(a.Addr) == 0 }
// EqualString reports whether the given address string is equal to this address.
func (a Address) EqualString(b string) bool { return a == AddressFromString(b) }
// Function that constructs a proper Address from a string.
//
// Supported formats: foo@bar.baz (SMTP proto), N0CALL (short winlink address) or N0CALL@winlink.org (full winlink address).
func AddressFromString(addr string) Address {
var a Address
if parts := strings.Split(addr, ":"); len(parts) == 2 {
a = Address{Proto: parts[0], Addr: parts[1]}
} else if parts := strings.Split(addr, "@"); len(parts) == 1 {
a = Address{Addr: addr}
} else if strings.EqualFold(parts[1], "winlink.org") {
a = Address{Addr: parts[0]}
} else {
a = Address{Proto: "SMTP", Addr: addr}
}
if a.Proto == "" {
a.Addr = strings.ToUpper(a.Addr)
}
return a
}
func ParseDate(dateStr string) (time.Time, error) {
if dateStr == "" {
return time.Time{}, nil
}
var date time.Time
var err error
for _, layout := range dateLayouts {
date, err = time.Parse(layout, dateStr)
if err == nil {
break
}
}
return date.Local(), err
}
|