git.r.bdr.sh - rbdr/mobius/blob - hotline/server.go

   1 package hotline
   2
   3 import (
   4         "context"
   5         "encoding/binary"
   6         "errors"
   7         "fmt"
   8         "go.uber.org/zap"
   9         "io"
  10         "io/fs"
  11         "io/ioutil"
  12         "math/big"
  13         "math/rand"
  14         "net"
  15         "os"
  16         "path"
  17         "path/filepath"
  18         "runtime/debug"
  19         "sort"
  20         "strings"
  21         "sync"
  22         "time"
  23
  24         "gopkg.in/yaml.v3"
  25 )
  26
  27 const (
  28         userIdleSeconds        = 300 // time in seconds before an inactive user is marked idle
  29         idleCheckInterval      = 10  // time in seconds to check for idle users
  30         trackerUpdateFrequency = 300 // time in seconds between tracker re-registration
  31 )
  32
  33 type Server struct {
  34         Port          int
  35         Accounts      map[string]*Account
  36         Agreement     []byte
  37         Clients       map[uint16]*ClientConn
  38         FlatNews      []byte
  39         ThreadedNews  *ThreadedNews
  40         FileTransfers map[uint32]*FileTransfer
  41         Config        *Config
  42         ConfigDir     string
  43         Logger        *zap.SugaredLogger
  44         PrivateChats  map[uint32]*PrivateChat
  45         NextGuestID   *uint16
  46         TrackerPassID []byte
  47         Stats         *Stats
  48
  49         APIListener  net.Listener
  50         FileListener net.Listener
  51
  52         // newsReader io.Reader
  53         // newsWriter io.WriteCloser
  54
  55         outbox chan Transaction
  56
  57         mux         sync.Mutex
  58         flatNewsMux sync.Mutex
  59 }
  60
  61 type PrivateChat struct {
  62         Subject    string
  63         ClientConn map[uint16]*ClientConn
  64 }
  65
  66 func (s *Server) ListenAndServe(ctx context.Context, cancelRoot context.CancelFunc) error {
  67         s.Logger.Infow("Hotline server started", "version", VERSION)
  68         var wg sync.WaitGroup
  69
  70         wg.Add(1)
  71         go func() { s.Logger.Fatal(s.Serve(ctx, cancelRoot, s.APIListener)) }()
  72
  73         wg.Add(1)
  74         go func() { s.Logger.Fatal(s.ServeFileTransfers(s.FileListener)) }()
  75
  76         wg.Wait()
  77
  78         return nil
  79 }
  80
  81 func (s *Server) APIPort() int {
  82         return s.APIListener.Addr().(*net.TCPAddr).Port
  83 }
  84
  85 func (s *Server) ServeFileTransfers(ln net.Listener) error {
  86         s.Logger.Infow("Hotline file transfer server started", "Addr", fmt.Sprintf(":%v", s.Port+1))
  87
  88         for {
  89                 conn, err := ln.Accept()
  90                 if err != nil {
  91                         return err
  92                 }
  93
  94                 go func() {
  95                         if err := s.handleFileTransfer(conn); err != nil {
  96                                 s.Logger.Errorw("file transfer error", "reason", err)
  97                         }
  98                 }()
  99         }
 100 }
 101
 102 func (s *Server) sendTransaction(t Transaction) error {
 103         requestNum := binary.BigEndian.Uint16(t.Type)
 104         clientID, err := byteToInt(*t.clientID)
 105         if err != nil {
 106                 return err
 107         }
 108
 109         s.mux.Lock()
 110         client := s.Clients[uint16(clientID)]
 111         s.mux.Unlock()
 112         if client == nil {
 113                 return fmt.Errorf("invalid client id %v", *t.clientID)
 114         }
 115         userName := string(client.UserName)
 116         login := client.Account.Login
 117
 118         handler := TransactionHandlers[requestNum]
 119
 120         b, err := t.MarshalBinary()
 121         if err != nil {
 122                 return err
 123         }
 124         var n int
 125         if n, err = client.Connection.Write(b); err != nil {
 126                 return err
 127         }
 128         s.Logger.Debugw("Sent Transaction",
 129                 "name", userName,
 130                 "login", login,
 131                 "IsReply", t.IsReply,
 132                 "type", handler.Name,
 133                 "sentBytes", n,
 134                 "remoteAddr", client.Connection.RemoteAddr(),
 135         )
 136         return nil
 137 }
 138
 139 func (s *Server) Serve(ctx context.Context, cancelRoot context.CancelFunc, ln net.Listener) error {
 140         s.Logger.Infow("Hotline server started", "Addr", fmt.Sprintf(":%v", s.Port))
 141
 142         for {
 143                 conn, err := ln.Accept()
 144                 if err != nil {
 145                         s.Logger.Errorw("error accepting connection", "err", err)
 146                 }
 147
 148                 go func() {
 149                         for {
 150                                 t := <-s.outbox
 151                                 go func() {
 152                                         if err := s.sendTransaction(t); err != nil {
 153                                                 s.Logger.Errorw("error sending transaction", "err", err)
 154                                         }
 155                                 }()
 156                         }
 157                 }()
 158                 go func() {
 159                         if err := s.handleNewConnection(conn); err != nil {
 160                                 if err == io.EOF {
 161                                         s.Logger.Infow("Client disconnected", "RemoteAddr", conn.RemoteAddr())
 162                                 } else {
 163                                         s.Logger.Errorw("error serving request", "RemoteAddr", conn.RemoteAddr(), "err", err)
 164                                 }
 165                         }
 166                 }()
 167         }
 168 }
 169
 170 const (
 171         agreementFile = "Agreement.txt"
 172 )
 173
 174 // NewServer constructs a new Server from a config dir
 175 func NewServer(configDir, netInterface string, netPort int, logger *zap.SugaredLogger) (*Server, error) {
 176         server := Server{
 177                 Port:          netPort,
 178                 Accounts:      make(map[string]*Account),
 179                 Config:        new(Config),
 180                 Clients:       make(map[uint16]*ClientConn),
 181                 FileTransfers: make(map[uint32]*FileTransfer),
 182                 PrivateChats:  make(map[uint32]*PrivateChat),
 183                 ConfigDir:     configDir,
 184                 Logger:        logger,
 185                 NextGuestID:   new(uint16),
 186                 outbox:        make(chan Transaction),
 187                 Stats:         &Stats{StartTime: time.Now()},
 188                 ThreadedNews:  &ThreadedNews{},
 189                 TrackerPassID: make([]byte, 4),
 190         }
 191
 192         ln, err := net.Listen("tcp", fmt.Sprintf("%s:%v", netInterface, netPort))
 193         if err != nil {
 194                 return nil, err
 195         }
 196         server.APIListener = ln
 197
 198         if netPort != 0 {
 199                 netPort += 1
 200         }
 201
 202         ln2, err := net.Listen("tcp", fmt.Sprintf("%s:%v", netInterface, netPort))
 203         server.FileListener = ln2
 204         if err != nil {
 205                 return nil, err
 206         }
 207
 208         // generate a new random passID for tracker registration
 209         if _, err := rand.Read(server.TrackerPassID); err != nil {
 210                 return nil, err
 211         }
 212
 213         server.Logger.Debugw("Loading Agreement", "path", configDir+agreementFile)
 214         if server.Agreement, err = os.ReadFile(configDir + agreementFile); err != nil {
 215                 return nil, err
 216         }
 217
 218         if server.FlatNews, err = os.ReadFile(configDir + "MessageBoard.txt"); err != nil {
 219                 return nil, err
 220         }
 221
 222         if err := server.loadThreadedNews(configDir + "ThreadedNews.yaml"); err != nil {
 223                 return nil, err
 224         }
 225
 226         if err := server.loadConfig(configDir + "config.yaml"); err != nil {
 227                 return nil, err
 228         }
 229
 230         if err := server.loadAccounts(configDir + "Users/"); err != nil {
 231                 return nil, err
 232         }
 233
 234         server.Config.FileRoot = configDir + "Files/"
 235
 236         *server.NextGuestID = 1
 237
 238         if server.Config.EnableTrackerRegistration {
 239                 go func() {
 240                         for {
 241                                 tr := TrackerRegistration{
 242                                         Port:        []byte{0x15, 0x7c},
 243                                         UserCount:   server.userCount(),
 244                                         PassID:      server.TrackerPassID,
 245                                         Name:        server.Config.Name,
 246                                         Description: server.Config.Description,
 247                                 }
 248                                 for _, t := range server.Config.Trackers {
 249                                         server.Logger.Infof("Registering with tracker %v", t)
 250
 251                                         if err := register(t, tr); err != nil {
 252                                                 server.Logger.Errorw("unable to register with tracker %v", "error", err)
 253                                         }
 254                                 }
 255
 256                                 time.Sleep(trackerUpdateFrequency * time.Second)
 257                         }
 258                 }()
 259         }
 260
 261         // Start Client Keepalive go routine
 262         go server.keepaliveHandler()
 263
 264         return &server, nil
 265 }
 266
 267 func (s *Server) userCount() int {
 268         s.mux.Lock()
 269         defer s.mux.Unlock()
 270
 271         return len(s.Clients)
 272 }
 273
 274 func (s *Server) keepaliveHandler() {
 275         for {
 276                 time.Sleep(idleCheckInterval * time.Second)
 277                 s.mux.Lock()
 278
 279                 for _, c := range s.Clients {
 280                         c.IdleTime += idleCheckInterval
 281                         if c.IdleTime > userIdleSeconds && !c.Idle {
 282                                 c.Idle = true
 283
 284                                 flagBitmap := big.NewInt(int64(binary.BigEndian.Uint16(*c.Flags)))
 285                                 flagBitmap.SetBit(flagBitmap, userFlagAway, 1)
 286                                 binary.BigEndian.PutUint16(*c.Flags, uint16(flagBitmap.Int64()))
 287
 288                                 c.sendAll(
 289                                         tranNotifyChangeUser,
 290                                         NewField(fieldUserID, *c.ID),
 291                                         NewField(fieldUserFlags, *c.Flags),
 292                                         NewField(fieldUserName, c.UserName),
 293                                         NewField(fieldUserIconID, *c.Icon),
 294                                 )
 295                         }
 296                 }
 297                 s.mux.Unlock()
 298         }
 299 }
 300
 301 func (s *Server) writeThreadedNews() error {
 302         s.mux.Lock()
 303         defer s.mux.Unlock()
 304
 305         out, err := yaml.Marshal(s.ThreadedNews)
 306         if err != nil {
 307                 return err
 308         }
 309         err = ioutil.WriteFile(
 310                 s.ConfigDir+"ThreadedNews.yaml",
 311                 out,
 312                 0666,
 313         )
 314         return err
 315 }
 316
 317 func (s *Server) NewClientConn(conn net.Conn) *ClientConn {
 318         s.mux.Lock()
 319         defer s.mux.Unlock()
 320
 321         clientConn := &ClientConn{
 322                 ID:         &[]byte{0, 0},
 323                 Icon:       &[]byte{0, 0},
 324                 Flags:      &[]byte{0, 0},
 325                 UserName:   []byte{},
 326                 Connection: conn,
 327                 Server:     s,
 328                 Version:    &[]byte{},
 329                 AutoReply:  []byte{},
 330                 Transfers:  make(map[int][]*FileTransfer),
 331                 Agreed:     false,
 332         }
 333         *s.NextGuestID++
 334         ID := *s.NextGuestID
 335
 336         binary.BigEndian.PutUint16(*clientConn.ID, ID)
 337         s.Clients[ID] = clientConn
 338
 339         return clientConn
 340 }
 341
 342 // NewUser creates a new user account entry in the server map and config file
 343 func (s *Server) NewUser(login, name, password string, access []byte) error {
 344         s.mux.Lock()
 345         defer s.mux.Unlock()
 346
 347         account := Account{
 348                 Login:    login,
 349                 Name:     name,
 350                 Password: hashAndSalt([]byte(password)),
 351                 Access:   &access,
 352         }
 353         out, err := yaml.Marshal(&account)
 354         if err != nil {
 355                 return err
 356         }
 357         s.Accounts[login] = &account
 358
 359         return FS.WriteFile(s.ConfigDir+"Users/"+login+".yaml", out, 0666)
 360 }
 361
 362 func (s *Server) UpdateUser(login, newLogin, name, password string, access []byte) error {
 363         s.mux.Lock()
 364         defer s.mux.Unlock()
 365
 366         fmt.Printf("login: %v, newLogin: %v: ", login, newLogin)
 367
 368         // update renames the user login
 369         if login != newLogin {
 370                 err := os.Rename(s.ConfigDir+"Users/"+login+".yaml", s.ConfigDir+"Users/"+newLogin+".yaml")
 371                 if err != nil {
 372                         return err
 373                 }
 374                 s.Accounts[newLogin] = s.Accounts[login]
 375                 delete(s.Accounts, login)
 376         }
 377
 378         account := s.Accounts[newLogin]
 379         account.Access = &access
 380         account.Name = name
 381         account.Password = password
 382
 383         out, err := yaml.Marshal(&account)
 384         if err != nil {
 385                 return err
 386         }
 387         if err := os.WriteFile(s.ConfigDir+"Users/"+newLogin+".yaml", out, 0666); err != nil {
 388                 return err
 389         }
 390
 391         return nil
 392 }
 393
 394 // DeleteUser deletes the user account
 395 func (s *Server) DeleteUser(login string) error {
 396         s.mux.Lock()
 397         defer s.mux.Unlock()
 398
 399         delete(s.Accounts, login)
 400
 401         return FS.Remove(s.ConfigDir + "Users/" + login + ".yaml")
 402 }
 403
 404 func (s *Server) connectedUsers() []Field {
 405         s.mux.Lock()
 406         defer s.mux.Unlock()
 407
 408         var connectedUsers []Field
 409         for _, c := range sortedClients(s.Clients) {
 410                 if !c.Agreed {
 411                         continue
 412                 }
 413                 user := User{
 414                         ID:    *c.ID,
 415                         Icon:  *c.Icon,
 416                         Flags: *c.Flags,
 417                         Name:  string(c.UserName),
 418                 }
 419                 connectedUsers = append(connectedUsers, NewField(fieldUsernameWithInfo, user.Payload()))
 420         }
 421         return connectedUsers
 422 }
 423
 424 // loadThreadedNews loads the threaded news data from disk
 425 func (s *Server) loadThreadedNews(threadedNewsPath string) error {
 426         fh, err := os.Open(threadedNewsPath)
 427         if err != nil {
 428                 return err
 429         }
 430         decoder := yaml.NewDecoder(fh)
 431
 432         return decoder.Decode(s.ThreadedNews)
 433 }
 434
 435 // loadAccounts loads account data from disk
 436 func (s *Server) loadAccounts(userDir string) error {
 437         matches, err := filepath.Glob(path.Join(userDir, "*.yaml"))
 438         if err != nil {
 439                 return err
 440         }
 441
 442         if len(matches) == 0 {
 443                 return errors.New("no user accounts found in " + userDir)
 444         }
 445
 446         for _, file := range matches {
 447                 fh, err := FS.Open(file)
 448                 if err != nil {
 449                         return err
 450                 }
 451
 452                 account := Account{}
 453                 decoder := yaml.NewDecoder(fh)
 454                 if err := decoder.Decode(&account); err != nil {
 455                         return err
 456                 }
 457
 458                 s.Accounts[account.Login] = &account
 459         }
 460         return nil
 461 }
 462
 463 func (s *Server) loadConfig(path string) error {
 464         fh, err := FS.Open(path)
 465         if err != nil {
 466                 return err
 467         }
 468
 469         decoder := yaml.NewDecoder(fh)
 470         err = decoder.Decode(s.Config)
 471         if err != nil {
 472                 return err
 473         }
 474         return nil
 475 }
 476
 477 const (
 478         minTransactionLen = 22 // minimum length of any transaction
 479 )
 480
 481 // handleNewConnection takes a new net.Conn and performs the initial login sequence
 482 func (s *Server) handleNewConnection(conn net.Conn) error {
 483         handshakeBuf := make([]byte, 12) // handshakes are always 12 bytes in length
 484         if _, err := conn.Read(handshakeBuf); err != nil {
 485                 return err
 486         }
 487         if err := Handshake(conn, handshakeBuf[:12]); err != nil {
 488                 return err
 489         }
 490
 491         buf := make([]byte, 1024)
 492         readLen, err := conn.Read(buf)
 493         if readLen < minTransactionLen {
 494                 return err
 495         }
 496         if err != nil {
 497                 return err
 498         }
 499
 500         clientLogin, _, err := ReadTransaction(buf[:readLen])
 501         if err != nil {
 502                 return err
 503         }
 504
 505         c := s.NewClientConn(conn)
 506         defer c.Disconnect()
 507         defer func() {
 508                 if r := recover(); r != nil {
 509                         fmt.Println("stacktrace from panic: \n" + string(debug.Stack()))
 510                         c.Server.Logger.Errorw("PANIC", "err", r, "trace", string(debug.Stack()))
 511                         c.Disconnect()
 512                 }
 513         }()
 514
 515         encodedLogin := clientLogin.GetField(fieldUserLogin).Data
 516         encodedPassword := clientLogin.GetField(fieldUserPassword).Data
 517         *c.Version = clientLogin.GetField(fieldVersion).Data
 518
 519         var login string
 520         for _, char := range encodedLogin {
 521                 login += string(rune(255 - uint(char)))
 522         }
 523         if login == "" {
 524                 login = GuestAccount
 525         }
 526
 527         // If authentication fails, send error reply and close connection
 528         if !c.Authenticate(login, encodedPassword) {
 529                 t := c.NewErrReply(clientLogin, "Incorrect login.")
 530                 b, err := t.MarshalBinary()
 531                 if err != nil {
 532                         return err
 533                 }
 534                 if _, err := conn.Write(b); err != nil {
 535                         return err
 536                 }
 537                 return fmt.Errorf("incorrect login")
 538         }
 539
 540         if clientLogin.GetField(fieldUserName).Data != nil {
 541                 c.UserName = clientLogin.GetField(fieldUserName).Data
 542         }
 543
 544         if clientLogin.GetField(fieldUserIconID).Data != nil {
 545                 *c.Icon = clientLogin.GetField(fieldUserIconID).Data
 546         }
 547
 548         c.Account = c.Server.Accounts[login]
 549
 550         if c.Authorize(accessDisconUser) {
 551                 *c.Flags = []byte{0, 2}
 552         }
 553
 554         s.Logger.Infow("Client connection received", "login", login, "version", *c.Version, "RemoteAddr", conn.RemoteAddr().String())
 555
 556         s.outbox <- c.NewReply(clientLogin,
 557                 NewField(fieldVersion, []byte{0x00, 0xbe}),
 558                 NewField(fieldCommunityBannerID, []byte{0x00, 0x01}),
 559                 NewField(fieldServerName, []byte(s.Config.Name)),
 560         )
 561
 562         // Send user access privs so client UI knows how to behave
 563         c.Server.outbox <- *NewTransaction(tranUserAccess, c.ID, NewField(fieldUserAccess, *c.Account.Access))
 564
 565         // Show agreement to client
 566         c.Server.outbox <- *NewTransaction(tranShowAgreement, c.ID, NewField(fieldData, s.Agreement))
 567
 568         // assume simplified hotline v1.2.3 login flow that does not require agreement
 569         if *c.Version == nil {
 570                 c.Agreed = true
 571
 572                 c.notifyOthers(
 573                         *NewTransaction(
 574                                 tranNotifyChangeUser, nil,
 575                                 NewField(fieldUserName, c.UserName),
 576                                 NewField(fieldUserID, *c.ID),
 577                                 NewField(fieldUserIconID, *c.Icon),
 578                                 NewField(fieldUserFlags, *c.Flags),
 579                         ),
 580                 )
 581         }
 582
 583         c.Server.Stats.LoginCount += 1
 584
 585         const readBuffSize = 1024000 // 1KB - TODO: what should this be?
 586         tranBuff := make([]byte, 0)
 587         tReadlen := 0
 588         // Infinite loop where take action on incoming client requests until the connection is closed
 589         for {
 590                 buf = make([]byte, readBuffSize)
 591                 tranBuff = tranBuff[tReadlen:]
 592
 593                 readLen, err := c.Connection.Read(buf)
 594                 if err != nil {
 595                         return err
 596                 }
 597                 tranBuff = append(tranBuff, buf[:readLen]...)
 598
 599                 // We may have read multiple requests worth of bytes from Connection.Read.  readTransactions splits them
 600                 // into a slice of transactions
 601                 var transactions []Transaction
 602                 if transactions, tReadlen, err = readTransactions(tranBuff); err != nil {
 603                         c.Server.Logger.Errorw("Error handling transaction", "err", err)
 604                 }
 605
 606                 // iterate over all of the transactions that were parsed from the byte slice and handle them
 607                 for _, t := range transactions {
 608                         if err := c.handleTransaction(&t); err != nil {
 609                                 c.Server.Logger.Errorw("Error handling transaction", "err", err)
 610                         }
 611                 }
 612         }
 613 }
 614
 615 // NewTransactionRef generates a random ID for the file transfer.  The Hotline client includes this ID
 616 // in the file transfer request payload, and the file transfer server will use it to map the request
 617 // to a transfer
 618 func (s *Server) NewTransactionRef() []byte {
 619         transactionRef := make([]byte, 4)
 620         rand.Read(transactionRef)
 621
 622         return transactionRef
 623 }
 624
 625 func (s *Server) NewPrivateChat(cc *ClientConn) []byte {
 626         s.mux.Lock()
 627         defer s.mux.Unlock()
 628
 629         randID := make([]byte, 4)
 630         rand.Read(randID)
 631         data := binary.BigEndian.Uint32(randID[:])
 632
 633         s.PrivateChats[data] = &PrivateChat{
 634                 Subject:    "",
 635                 ClientConn: make(map[uint16]*ClientConn),
 636         }
 637         s.PrivateChats[data].ClientConn[cc.uint16ID()] = cc
 638
 639         return randID
 640 }
 641
 642 const dlFldrActionSendFile = 1
 643 const dlFldrActionResumeFile = 2
 644 const dlFldrActionNextFile = 3
 645
 646 // handleFileTransfer receives a client net.Conn from the file transfer server, performs the requested transfer type, then closes the connection
 647 func (s *Server) handleFileTransfer(conn io.ReadWriteCloser) error {
 648         defer func() {
 649                 if err := conn.Close(); err != nil {
 650                         s.Logger.Errorw("error closing connection", "error", err)
 651                 }
 652         }()
 653
 654         txBuf := make([]byte, 16)
 655         _, err := conn.Read(txBuf)
 656         if err != nil {
 657                 return err
 658         }
 659
 660         var t transfer
 661         _, err = t.Write(txBuf)
 662         if err != nil {
 663                 return err
 664         }
 665
 666         transferRefNum := binary.BigEndian.Uint32(t.ReferenceNumber[:])
 667         fileTransfer := s.FileTransfers[transferRefNum]
 668
 669         // delete single use transferRefNum
 670         delete(s.FileTransfers, transferRefNum)
 671
 672         switch fileTransfer.Type {
 673         case FileDownload:
 674                 fullFilePath, err := readPath(s.Config.FileRoot, fileTransfer.FilePath, fileTransfer.FileName)
 675                 if err != nil {
 676                         return err
 677                 }
 678
 679                 var dataOffset int64
 680                 if fileTransfer.fileResumeData != nil {
 681                         dataOffset = int64(binary.BigEndian.Uint32(fileTransfer.fileResumeData.ForkInfoList[0].DataSize[:]))
 682                 }
 683
 684                 ffo, err := NewFlattenedFileObject(s.Config.FileRoot, fileTransfer.FilePath, fileTransfer.FileName, dataOffset)
 685                 if err != nil {
 686                         return err
 687                 }
 688
 689                 s.Logger.Infow("File download started", "filePath", fullFilePath, "transactionRef", fileTransfer.ReferenceNumber)
 690
 691                 // Start by sending flat file object to client
 692                 if _, err := conn.Write(ffo.BinaryMarshal()); err != nil {
 693                         return err
 694                 }
 695
 696                 file, err := FS.Open(fullFilePath)
 697                 if err != nil {
 698                         return err
 699                 }
 700
 701                 sendBuffer := make([]byte, 1048576)
 702                 var totalSent int64
 703                 for {
 704                         var bytesRead int
 705                         if bytesRead, err = file.ReadAt(sendBuffer, dataOffset+totalSent); err == io.EOF {
 706                                 if _, err := conn.Write(sendBuffer[:bytesRead]); err != nil {
 707                                         return err
 708                                 }
 709                                 break
 710                         }
 711                         if err != nil {
 712                                 return err
 713                         }
 714                         totalSent += int64(bytesRead)
 715
 716                         fileTransfer.BytesSent += bytesRead
 717
 718                         if _, err := conn.Write(sendBuffer[:bytesRead]); err != nil {
 719                                 return err
 720                         }
 721                 }
 722         case FileUpload:
 723                 destinationFile := s.Config.FileRoot + ReadFilePath(fileTransfer.FilePath) + "/" + string(fileTransfer.FileName)
 724                 tmpFile := destinationFile + ".incomplete"
 725
 726                 file, err := effectiveFile(destinationFile)
 727                 if errors.Is(err, fs.ErrNotExist) {
 728                         file, err = FS.Create(tmpFile)
 729                         if err != nil {
 730                                 return err
 731                         }
 732                 }
 733
 734                 defer func() { _ = file.Close() }()
 735
 736                 s.Logger.Infow("File upload started", "transactionRef", fileTransfer.ReferenceNumber, "dstFile", destinationFile)
 737
 738                 // TODO: replace io.Discard with a real file when ready to implement storing of resource fork data
 739                 if err := receiveFile(conn, file, io.Discard); err != nil {
 740                         return err
 741                 }
 742
 743                 if err := os.Rename(destinationFile+".incomplete", destinationFile); err != nil {
 744                         return err
 745                 }
 746
 747                 s.Logger.Infow("File upload complete", "transactionRef", fileTransfer.ReferenceNumber, "dstFile", destinationFile)
 748         case FolderDownload:
 749                 // Folder Download flow:
 750                 // 1. Get filePath from the transfer
 751                 // 2. Iterate over files
 752                 // 3. For each file:
 753                 //       Send file header to client
 754                 // The client can reply in 3 ways:
 755                 //
 756                 // 1. If type is an odd number (unknown type?), or file download for the current file is completed:
 757                 //              client sends []byte{0x00, 0x03} to tell the server to continue to the next file
 758                 //
 759                 // 2. If download of a file is to be resumed:
 760                 //              client sends:
 761                 //                      []byte{0x00, 0x02} // download folder action
 762                 //                      [2]byte // Resume data size
 763                 //                      []byte file resume data (see myField_FileResumeData)
 764                 //
 765                 // 3. Otherwise, download of the file is requested and client sends []byte{0x00, 0x01}
 766                 //
 767                 // When download is requested (case 2 or 3), server replies with:
 768                 //                      [4]byte - file size
 769                 //                      []byte  - Flattened File Object
 770                 //
 771                 // After every file download, client could request next file with:
 772                 //                      []byte{0x00, 0x03}
 773                 //
 774                 // This notifies the server to send the next item header
 775
 776                 fullFilePath, err := readPath(s.Config.FileRoot, fileTransfer.FilePath, fileTransfer.FileName)
 777                 if err != nil {
 778                         return err
 779                 }
 780
 781                 basePathLen := len(fullFilePath)
 782
 783                 s.Logger.Infow("Start folder download", "path", fullFilePath, "ReferenceNumber", fileTransfer.ReferenceNumber)
 784
 785                 nextAction := make([]byte, 2)
 786                 if _, err := conn.Read(nextAction); err != nil {
 787                         return err
 788                 }
 789
 790                 i := 0
 791                 err = filepath.Walk(fullFilePath+"/", func(path string, info os.FileInfo, err error) error {
 792                         if err != nil {
 793                                 return err
 794                         }
 795                         i += 1
 796                         subPath := path[basePathLen+1:]
 797                         s.Logger.Infow("Sending fileheader", "i", i, "path", path, "fullFilePath", fullFilePath, "subPath", subPath, "IsDir", info.IsDir())
 798
 799                         if i == 1 {
 800                                 return nil
 801                         }
 802
 803                         fileHeader := NewFileHeader(subPath, info.IsDir())
 804
 805                         // Send the file header to client
 806                         if _, err := conn.Write(fileHeader.Payload()); err != nil {
 807                                 s.Logger.Errorf("error sending file header: %v", err)
 808                                 return err
 809                         }
 810
 811                         // Read the client's Next Action request
 812                         if _, err := conn.Read(nextAction); err != nil {
 813                                 return err
 814                         }
 815
 816                         s.Logger.Infow("Client folder download action", "action", fmt.Sprintf("%X", nextAction[0:2]))
 817
 818                         var dataOffset int64
 819
 820                         switch nextAction[1] {
 821                         case dlFldrActionResumeFile:
 822                                 // client asked to resume this file
 823                                 var frd FileResumeData
 824                                 // get size of resumeData
 825                                 if _, err := conn.Read(nextAction); err != nil {
 826                                         return err
 827                                 }
 828
 829                                 resumeDataLen := binary.BigEndian.Uint16(nextAction)
 830                                 resumeDataBytes := make([]byte, resumeDataLen)
 831                                 if _, err := conn.Read(resumeDataBytes); err != nil {
 832                                         return err
 833                                 }
 834
 835                                 if err := frd.UnmarshalBinary(resumeDataBytes); err != nil {
 836                                         return err
 837                                 }
 838                                 dataOffset = int64(binary.BigEndian.Uint32(frd.ForkInfoList[0].DataSize[:]))
 839                         case dlFldrActionNextFile:
 840                                 // client asked to skip this file
 841                                 return nil
 842                         }
 843
 844                         if info.IsDir() {
 845                                 return nil
 846                         }
 847
 848                         splitPath := strings.Split(path, "/")
 849
 850                         ffo, err := NewFlattenedFileObject(strings.Join(splitPath[:len(splitPath)-1], "/"), nil, []byte(info.Name()), dataOffset)
 851                         if err != nil {
 852                                 return err
 853                         }
 854                         s.Logger.Infow("File download started",
 855                                 "fileName", info.Name(),
 856                                 "transactionRef", fileTransfer.ReferenceNumber,
 857                                 "TransferSize", fmt.Sprintf("%x", ffo.TransferSize()),
 858                         )
 859
 860                         // Send file size to client
 861                         if _, err := conn.Write(ffo.TransferSize()); err != nil {
 862                                 s.Logger.Error(err)
 863                                 return err
 864                         }
 865
 866                         // Send ffo bytes to client
 867                         if _, err := conn.Write(ffo.BinaryMarshal()); err != nil {
 868                                 s.Logger.Error(err)
 869                                 return err
 870                         }
 871
 872                         file, err := FS.Open(path)
 873                         if err != nil {
 874                                 return err
 875                         }
 876
 877                         // // Copy N bytes from file to connection
 878                         // _, err = io.CopyN(conn, file, int64(binary.BigEndian.Uint32(ffo.FlatFileDataForkHeader.DataSize[:])))
 879                         // if err != nil {
 880                         //      return err
 881                         // }
 882                         // file.Close()
 883                         sendBuffer := make([]byte, 1048576)
 884                         var totalSent int64
 885                         for {
 886                                 var bytesRead int
 887                                 if bytesRead, err = file.ReadAt(sendBuffer, dataOffset+totalSent); err == io.EOF {
 888                                         if _, err := conn.Write(sendBuffer[:bytesRead]); err != nil {
 889                                                 return err
 890                                         }
 891                                         break
 892                                 }
 893                                 if err != nil {
 894                                         panic(err)
 895                                 }
 896                                 totalSent += int64(bytesRead)
 897
 898                                 fileTransfer.BytesSent += bytesRead
 899
 900                                 if _, err := conn.Write(sendBuffer[:bytesRead]); err != nil {
 901                                         return err
 902                                 }
 903                         }
 904
 905                         // TODO: optionally send resource fork header and resource fork data
 906
 907                         // Read the client's Next Action request.  This is always 3, I think?
 908                         if _, err := conn.Read(nextAction); err != nil {
 909                                 return err
 910                         }
 911
 912                         return nil
 913                 })
 914
 915         case FolderUpload:
 916                 dstPath, err := readPath(s.Config.FileRoot, fileTransfer.FilePath, fileTransfer.FileName)
 917                 if err != nil {
 918                         return err
 919                 }
 920                 s.Logger.Infow(
 921                         "Folder upload started",
 922                         "transactionRef", fileTransfer.ReferenceNumber,
 923                         "dstPath", dstPath,
 924                         "TransferSize", fmt.Sprintf("%x", fileTransfer.TransferSize),
 925                         "FolderItemCount", fileTransfer.FolderItemCount,
 926                 )
 927
 928                 // Check if the target folder exists.  If not, create it.
 929                 if _, err := FS.Stat(dstPath); os.IsNotExist(err) {
 930                         if err := FS.Mkdir(dstPath, 0777); err != nil {
 931                                 return err
 932                         }
 933                 }
 934
 935                 // Begin the folder upload flow by sending the "next file action" to client
 936                 if _, err := conn.Write([]byte{0, dlFldrActionNextFile}); err != nil {
 937                         return err
 938                 }
 939
 940                 fileSize := make([]byte, 4)
 941                 readBuffer := make([]byte, 1024)
 942
 943                 for i := 0; i < fileTransfer.ItemCount(); i++ {
 944
 945                         _, err := conn.Read(readBuffer)
 946                         if err != nil {
 947                                 return err
 948                         }
 949                         fu := readFolderUpload(readBuffer)
 950
 951                         s.Logger.Infow(
 952                                 "Folder upload continued",
 953                                 "transactionRef", fmt.Sprintf("%x", fileTransfer.ReferenceNumber),
 954                                 "FormattedPath", fu.FormattedPath(),
 955                                 "IsFolder", fmt.Sprintf("%x", fu.IsFolder),
 956                                 "PathItemCount", binary.BigEndian.Uint16(fu.PathItemCount[:]),
 957                         )
 958
 959                         if fu.IsFolder == [2]byte{0, 1} {
 960                                 if _, err := os.Stat(dstPath + "/" + fu.FormattedPath()); os.IsNotExist(err) {
 961                                         if err := os.Mkdir(dstPath+"/"+fu.FormattedPath(), 0777); err != nil {
 962                                                 return err
 963                                         }
 964                                 }
 965
 966                                 // Tell client to send next file
 967                                 if _, err := conn.Write([]byte{0, dlFldrActionNextFile}); err != nil {
 968                                         return err
 969                                 }
 970                         } else {
 971                                 nextAction := dlFldrActionSendFile
 972
 973                                 // Check if we have the full file already.  If so, send dlFldrAction_NextFile to client to skip.
 974                                 _, err := os.Stat(dstPath + "/" + fu.FormattedPath())
 975                                 if err != nil && !errors.Is(err, fs.ErrNotExist) {
 976                                         return err
 977                                 }
 978                                 if err == nil {
 979                                         nextAction = dlFldrActionNextFile
 980                                 }
 981
 982                                 //  Check if we have a partial file already.  If so, send dlFldrAction_ResumeFile to client to resume upload.
 983                                 inccompleteFile, err := os.Stat(dstPath + "/" + fu.FormattedPath() + incompleteFileSuffix)
 984                                 if err != nil && !errors.Is(err, fs.ErrNotExist) {
 985                                         return err
 986                                 }
 987                                 if err == nil {
 988                                         nextAction = dlFldrActionResumeFile
 989                                 }
 990
 991                                 fmt.Printf("Next Action: %v\n", nextAction)
 992
 993                                 if _, err := conn.Write([]byte{0, uint8(nextAction)}); err != nil {
 994                                         return err
 995                                 }
 996
 997                                 switch nextAction {
 998                                 case dlFldrActionNextFile:
 999                                         continue
1000                                 case dlFldrActionResumeFile:
1001                                         offset := make([]byte, 4)
1002                                         binary.BigEndian.PutUint32(offset, uint32(inccompleteFile.Size()))
1003
1004                                         file, err := os.OpenFile(dstPath+"/"+fu.FormattedPath()+incompleteFileSuffix, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
1005                                         if err != nil {
1006                                                 return err
1007                                         }
1008
1009                                         fileResumeData := NewFileResumeData([]ForkInfoList{
1010                                                 *NewForkInfoList(offset),
1011                                         })
1012
1013                                         b, _ := fileResumeData.BinaryMarshal()
1014
1015                                         bs := make([]byte, 2)
1016                                         binary.BigEndian.PutUint16(bs, uint16(len(b)))
1017
1018                                         if _, err := conn.Write(append(bs, b...)); err != nil {
1019                                                 return err
1020                                         }
1021
1022                                         if _, err := conn.Read(fileSize); err != nil {
1023                                                 return err
1024                                         }
1025
1026                                         if err := receiveFile(conn, file, ioutil.Discard); err != nil {
1027                                                 s.Logger.Error(err)
1028                                         }
1029
1030                                         err = os.Rename(dstPath+"/"+fu.FormattedPath()+".incomplete", dstPath+"/"+fu.FormattedPath())
1031                                         if err != nil {
1032                                                 return err
1033                                         }
1034
1035                                 case dlFldrActionSendFile:
1036                                         if _, err := conn.Read(fileSize); err != nil {
1037                                                 return err
1038                                         }
1039
1040                                         filePath := dstPath + "/" + fu.FormattedPath()
1041                                         s.Logger.Infow("Starting file transfer", "path", filePath, "fileNum", i+1, "totalFiles", "zz", "fileSize", binary.BigEndian.Uint32(fileSize))
1042
1043                                         newFile, err := FS.Create(filePath + ".incomplete")
1044                                         if err != nil {
1045                                                 return err
1046                                         }
1047
1048                                         if err := receiveFile(conn, newFile, ioutil.Discard); err != nil {
1049                                                 s.Logger.Error(err)
1050                                         }
1051                                         _ = newFile.Close()
1052                                         if err := os.Rename(filePath+".incomplete", filePath); err != nil {
1053                                                 return err
1054                                         }
1055                                 }
1056
1057                                 // Tell client to send next file
1058                                 if _, err := conn.Write([]byte{0, dlFldrActionNextFile}); err != nil {
1059                                         return err
1060                                 }
1061                         }
1062                 }
1063                 s.Logger.Infof("Folder upload complete")
1064         }
1065
1066         return nil
1067 }
1068
1069 // sortedClients is a utility function that takes a map of *ClientConn and returns a sorted slice of the values.
1070 // The purpose of this is to ensure that the ordering of client connections is deterministic so that test assertions work.
1071 func sortedClients(unsortedClients map[uint16]*ClientConn) (clients []*ClientConn) {
1072         for _, c := range unsortedClients {
1073                 clients = append(clients, c)
1074         }
1075         sort.Sort(byClientID(clients))
1076         return clients
1077 }