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 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
|
// Copyright 2015 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"
"errors"
"fmt"
"io"
"log"
"mime"
"strconv"
"strings"
"time"
"github.com/la5nta/wl2k-go/transport"
)
var ErrOffsetLimitExceeded error = errors.New("Protocol does not support offset larger than 6 digits")
const (
ProtocolOffsetSizeLimit = 999999
MaxBlockSize = 5
// Paclink-unix uses 250, protocol maximum is 255, but we use 125 to allow use of AX.25 links with a paclen of 128.
// TODO: Consider setting this dynamically.
MaxMsgLength = 125
)
const (
cmdPrefix = 'F'
cmdPrompt = '>'
cmdNoMoreMessages = 'F'
cmdQuit = 'Q'
cmdPropAnswer = 'S'
cmdPropA = 'A'
cmdPropB = 'B'
cmdPropC = 'C' // Wl2k extended B2 message
cmdPropD = 'D' // Gzip compressed B2 message (GZIP_EXPERIMENT)
)
const (
_CHRNUL byte = 0
_CHRSOH = 1
_CHRSTX = 2
_CHREOT = 4
)
func (s *Session) handleOutbound(rw io.ReadWriter) (quitSent bool, err error) {
var sent map[string]bool
// Send outbound messages
if len(s.outbound()) > 0 {
sent, err = s.sendOutbound(rw)
if err != nil {
return
}
}
// Report rejected now, they can safely be omitted even if an error occures
for mid, rej := range sent {
if rej {
s.h.SetSent(mid, rej)
delete(sent, mid)
}
}
// If all messages was deferred/rejected, we should propose new messages
if len(sent) == 0 && len(s.outbound()) > 0 {
return s.handleOutbound(rw)
}
// Handle session turnover
switch {
case len(sent) > 0:
// Turnover is implied
case s.remoteNoMsgs && len(sent) == 0:
s.pLog.Print(">FQ")
fmt.Fprint(rw, "FQ\r")
quitSent = true
return // No need to check for remote error since we did not send any messages
default:
s.pLog.Print(">FF")
fmt.Fprint(rw, "FF\r")
}
// Error reporting from remote is not defined by the protocol,
// but usually indicated by sending a line prefixed with '***'.
// The only valid bytes (according to protocol) after a session
// turnover is 'F' or ';', so we use those to confirm the block
// was successfully received.
var p []byte
if p, err = s.rd.Peek(1); err != nil {
return
} else if p[0] != 'F' && p[0] != ';' {
var line string
line, err = s.nextLine()
if err != nil {
return
}
err = fmt.Errorf("Unexpected response: '%s'", line)
return
}
// Report successfully sent messages
for mid, rej := range sent {
s.h.SetSent(mid, rej)
if !rej {
s.trafficStats.Sent = append(s.trafficStats.Sent, mid)
}
}
return
}
func (s *Session) sendOutbound(rw io.ReadWriter) (sent map[string]bool, err error) {
sent = make(map[string]bool) // Use this to keep track of sent (rejected or not) mids.
var checksum int64
outbound := s.outbound()
if len(outbound) > MaxBlockSize {
outbound = outbound[0:MaxBlockSize]
}
for _, prop := range outbound {
sp := fmt.Sprintf("F%c %s %s %d %d %d",
prop.code, // Proposal code
prop.msgType, // Message type (1 or 2 alphanumeric)
prop.mid, // Max 12 characters
prop.size, // Uncompressed size of message
prop.compressedSize, // Compressed size of message
0) // ?
s.pLog.Printf(">%s", sp)
fmt.Fprintf(rw, "%s\r", sp)
for _, c := range sp {
checksum += int64(c)
}
checksum += int64('\r')
}
checksum = (-checksum) & 0xff
s.log.Printf(`Sending checksum %02X`, checksum)
fmt.Fprintf(rw, "F> %02X\r", checksum)
var reply string
for reply == "" {
line, err := s.nextLine()
switch {
case err != nil:
return sent, err
case strings.HasPrefix(line, "FS "):
reply = line // The expected proposal answer
case strings.HasPrefix(line, ";"):
continue // Ignore comment
default:
return sent, fmt.Errorf("Expected proposal answer from remote. Got: '%s'", reply)
}
}
if err = parseProposalAnswer(reply, outbound, s.log); err != nil {
return sent, fmt.Errorf("Unable to parse proposal answer: %w", err)
}
if len(outbound) == 0 {
return
}
if r, ok := rw.(transport.Robust); ok && s.robustMode == RobustAuto {
r.SetRobust(false)
defer r.SetRobust(true)
}
for _, prop := range outbound {
switch prop.answer {
case Defer:
s.h.SetDeferred(prop.mid)
case Reject:
sent[prop.mid] = true
case Accept:
if err = s.writeCompressed(rw, prop); err != nil {
return
}
sent[prop.mid] = false
}
}
return
}
func (s *Session) handleInbound(rw io.ReadWriter) (quitReceived bool, err error) {
var ourChecksum int64
proposals := make([]*Proposal, 0)
var nAccepted int
Loop:
for {
var line string
line, err = s.nextLine()
if err != nil {
return
}
// Ignore comments and empty lines
if line == "" || line[0] == ';' {
continue
}
// The line should be prefixed F? (? is the command character)
if len(line) < 2 || line[0] != 'F' {
return false, fmt.Errorf("Got unexpected protocol line: '%s'", line)
}
switch line[:2] {
case "FA", "FB", "FC", "FD": // Proposals
for _, c := range line {
ourChecksum += int64(c)
}
ourChecksum += int64('\r')
prop := new(Proposal)
if err = parseProposal(line, prop); err != nil {
err = fmt.Errorf("Unable to parse proposal: %w", err)
return
}
proposals = append(proposals, prop)
case "FF": // No more messages
break Loop
case "FQ": // Quit
quitReceived = true
break Loop
case "F>": // Prompt (end of proposal block)
// Verify checksum
ourChecksum = (-ourChecksum) & 0xff
their, _ := strconv.ParseInt(line[3:], 16, 64)
if their != ourChecksum {
err = errors.New(fmt.Sprintf(`Checksum error (%d-%d)`, ourChecksum, their))
return
}
// If we didn't get any proposals, return
if len(proposals) == 0 {
return
}
// Answer proposal
s.log.Printf(`%d proposal(s) received`, len(proposals))
nAccepted, err = s.writeProposalsAnswer(rw, proposals)
if err != nil {
return quitReceived, err
}
if nAccepted > 0 {
break Loop // Session turn over is implied after receiving the messages
}
// Continue receiving proposals if all where rejected/deferred
return s.handleInbound(rw)
default: //TODO: Ignore?
return false, fmt.Errorf("Unknown protocol command %c", line[1])
}
}
if quitReceived && nAccepted > 0 {
return true, errors.New("Got quit command when inbound proposals were pending")
}
// Fetch and decompress accepted
s.remoteNoMsgs = true
for _, prop := range proposals {
if prop.answer != Accept {
continue
}
s.remoteNoMsgs = false
var msg *Message
if err = s.readCompressed(rw, prop); err != nil {
return
} else if msg, err = prop.Message(); err != nil {
return
}
if err = s.h.ProcessInbound(msg); err != nil {
return
}
s.trafficStats.Received = append(s.trafficStats.Received, prop.MID())
}
return
}
// The B2F protocol does not support offsets larger than 6 digits, the author of the protocol
// seems to have thrown away the idea of supporting transfer of fragmented messages.
//
// If we ever want to support requests of message with offset, we must guard against asking for
// offsets > 999999. RMS Express does not do this (in Winmor P2P anyway), we must avoid that pitfall.
func (s *Session) writeProposalsAnswer(rw io.ReadWriter, proposals []*Proposal) (nAccepted int, err error) {
answers := make([]byte, len(proposals))
seen := make(map[string]bool)
for i, prop := range proposals {
if seen[prop.MID()] {
// Radio Only gateways will sometimes send multiple proposals for the same MID in the same batch.
// Instead of rejecting them right away, let's defer the dups until we know we have sucessfully received at least one of the copies.
s.log.Printf("Defering duplicate message %s", prop.MID())
prop.answer = Defer
} else if prop.code != Wl2kProposal && prop.code != GzipProposal {
s.log.Printf("Defering %s (unsupported format)", prop.MID())
prop.answer = Defer
} else if s.h == nil {
s.log.Printf("Defering %s (missing handler)", prop.MID())
prop.answer = Defer
} else if prop.answer = s.h.GetInboundAnswer(*prop); prop.answer == Accept {
s.log.Printf("Accepting %s", prop.MID()) //TODO: Remove?
nAccepted++
}
seen[prop.MID()] = true
answers[i] = byte(prop.answer)
}
_, err = fmt.Fprintf(rw, "FS %s\r", answers)
return
}
// Parses the proposal answer (str) and updates the proposals given (in that order)
func parseProposalAnswer(str string, props []*Proposal, l *log.Logger) error {
str = strings.TrimPrefix(str, "FS ")
var c byte
for i := 0; len(str) > 0; i++ {
if i >= len(props) {
return errors.New("Got answer for more proposals than expected")
}
prop := props[i]
c, str = str[0], str[1:]
switch c {
case 'Y', 'y', '+':
if l != nil {
l.Printf("Remote accepted %s", prop.MID())
}
prop.answer = Accept
case 'N', 'n', 'R', 'r', '-':
if l != nil {
l.Printf("Remote already received %s", prop.MID())
}
prop.answer = Reject
case 'L', 'l', '=', 'H', 'h':
if l != nil {
l.Printf("Remote defered %s", prop.MID())
}
prop.answer = Defer
case 'A', 'a', '!':
idx := strings.LastIndexAny(str, "0123456789")
if idx < 0 {
return errors.New("Got offset request without offset index")
}
prop.answer = Accept // Offset is not implemented as a ProposalAnswer
prop.offset, _ = strconv.Atoi(str[:idx+1])
str = str[idx+1:]
if prop.offset > ProtocolOffsetSizeLimit { // RMS Express does this (in Winmor P2P for sure)
prop.offset = 0
if l != nil {
l.Printf(
"Remote requested %s at offset %d which exceeds the binary protocol offset limit. Ignoring offset.",
prop.MID(), prop.offset,
)
}
} else if l != nil {
l.Printf("Remote accepted %s at offset %d", prop.MID(), prop.offset)
}
default:
return fmt.Errorf("Invalid character (%c) in proposal answer line", c)
}
}
return nil
}
func (s *Session) writeCompressed(rw io.ReadWriter, p *Proposal) (err error) {
s.log.Printf("Transmitting [%s] [offset %d]", p.title, p.offset)
if p.code == GzipProposal {
s.log.Println("GZIP_EXPERIMENT:", "Transmitting gzip compressed message.")
}
writer := bufio.NewWriter(rw)
var (
title = mime.QEncoding.Encode("utf-8", p.title) // Word-encode the title since this field must be ASCII-only
offset = fmt.Sprintf("%d", p.offset)
length = len(title) + len(offset) + 2
checksum int64
)
writer.Write([]byte{_CHRSOH, byte(length)})
writer.WriteString(title) // Max 80 bytes, min 1 byte
writer.WriteByte(_CHRNUL)
writer.WriteString(offset) // Max 6 bytes, min 1 byte. Highest supported offset is 1MB-1B.
writer.WriteByte(_CHRNUL)
writer.Flush()
if p.compressedSize < 6 { // lzhuf's smallest valid length (empty)
return errors.New(`Invalid compressed data`)
}
buffer := bytes.NewBuffer(p.compressedData[p.offset:])
// Update Status of message transfer every 250ms
statusTicker := time.NewTicker(250 * time.Millisecond)
statusDone := make(chan struct{})
go func() {
for {
select {
case <-statusTicker.C:
if s.statusUpdater == nil || buffer == nil {
continue
}
// Take into account that the modem has an internal tx buffer (if possible).
var txBufLen int
if b, ok := rw.(transport.TxBuffer); ok {
txBufLen = b.TxBufferLen()
}
transferred := p.compressedSize - buffer.Len() - txBufLen
if transferred < 0 {
transferred = 0
}
if s.statusUpdater != nil {
s.statusUpdater.UpdateStatus(Status{
Sending: p,
BytesTransferred: transferred,
BytesTotal: p.compressedSize,
})
}
case <-statusDone:
if s.statusUpdater != nil {
s.statusUpdater.UpdateStatus(Status{
Sending: p,
BytesTransferred: p.compressedSize - buffer.Len(),
BytesTotal: p.compressedSize,
Done: true,
})
}
return
}
}
}()
defer func() { close(statusDone) }()
// Data (in chunks of max 250)
for buffer.Len() > 0 {
msgLen := MaxMsgLength
if buffer.Len() < MaxMsgLength {
msgLen = buffer.Len()
}
if _, err = writer.Write([]byte{_CHRSTX, byte(msgLen)}); err != nil {
return err
}
for i := 0; i < msgLen; i++ {
c, _ := buffer.ReadByte()
if err := writer.WriteByte(c); err != nil {
return err
}
checksum += int64(c)
}
if err = writer.Flush(); err != nil {
return err
}
}
// Checksum
checksum = -checksum & 0xff
_, err = writer.Write([]byte{_CHREOT, byte(checksum)})
err = writer.Flush()
// Flush connection buffers.
// This enables us to block until the whole message has been transmitted over the air.
if f, ok := rw.(transport.Flusher); ok {
err = f.Flush()
}
statusTicker.Stop()
return err
}
func (s *Session) readCompressed(rw io.ReadWriter, p *Proposal) (err error) {
var (
ourChecksum int
buf bytes.Buffer
)
var c byte
if c, err = s.rd.ReadByte(); err != nil {
return
}
switch c {
case _CHRSOH:
// what we expected...
case '*':
line, _ := s.nextLine()
return errors.New(fmt.Sprintf(`Got error from CMS: %s`, line))
default:
return errors.New(fmt.Sprintf(`First byte not as expected, got %d`, int(c)))
}
if c, err = s.rd.ReadByte(); err != nil {
return
}
headerLength := int(c)
// Read proposal title.
title, err := s.rd.ReadString(_CHRNUL)
if err != nil {
return fmt.Errorf("Unable to parse title: %w", err)
}
title = title[:len(title)-1] // Remove _CHRNUL
// The proposal title should be ASCII-only according to the protocol specification. Since RMS Express and CMS puts
// the raw subject header here, we need to handle this by decoding it the same way as the subject header.
p.title, _ = new(WordDecoder).DecodeHeader(title)
// Read offset part
var offsetStr string
if offsetStr, err = s.rd.ReadString(_CHRNUL); err != nil {
return fmt.Errorf("Unable to parse offset: %w", err)
} else {
offsetStr = offsetStr[:len(offsetStr)-1]
}
// Check overall length of header
actualHeaderLength := (len(title) + len(offsetStr)) + 2
if headerLength != actualHeaderLength {
return errors.New(fmt.Sprintf(`Header length mismatch: expected %d, got %d`, headerLength, actualHeaderLength))
}
// Parse offset as integer (and do some sanity checks)
offset, err := strconv.Atoi(offsetStr)
switch {
case err != nil:
return fmt.Errorf("Offset header not parseable as integer: %w", err)
case offset != p.offset:
return fmt.Errorf(`Expected offset %d, got %d`, p.offset, offset)
}
s.log.Printf("Receiving [%s] [offset %d]", p.title, p.offset)
if p.code == GzipProposal {
s.log.Println("GZIP_EXPERIMENT:", "Receiving gzip compressed message.")
}
statusUpdate := make(chan struct{})
go func() {
for {
_, ok := <-statusUpdate
if s.statusUpdater != nil {
s.statusUpdater.UpdateStatus(Status{
Receiving: p,
BytesTransferred: buf.Len(),
BytesTotal: p.compressedSize,
Done: !ok,
})
}
if !ok {
return
}
}
}()
defer func() { close(statusUpdate) }()
updateStatus := func() {
select {
case statusUpdate <- struct{}{}:
default:
}
}
for {
updateStatus()
c, err = s.rd.ReadByte()
if err != nil {
return err
}
switch c {
case _CHRSTX:
c, _ := s.rd.ReadByte()
length := int(c)
if length == 0 {
length = 256
}
for i := 0; i < length; i++ {
c, err = s.rd.ReadByte()
if err != nil {
return
}
buf.WriteByte(c)
ourChecksum = (ourChecksum + int(c)) % 256
if i%10 == 0 {
updateStatus()
}
}
case _CHREOT:
c, _ = s.rd.ReadByte()
ourChecksum = (ourChecksum + int(c)) % 256
if ourChecksum != 0 {
return errors.New(`Bad checksum`)
} else if p.compressedSize != buf.Len() {
return errors.New(`Length mismatch after EOT`)
} else {
p.compressedData = buf.Bytes()
}
return
default:
return errors.New(`Unexpected byte in compressed stream: ` + string(c))
}
}
}
|