package hotline
import (
+ "bufio"
+ "crypto/rand"
"encoding/binary"
+ "errors"
"fmt"
+ "io"
+ "io/fs"
+ "log/slog"
+ "math"
+ "os"
+ "path/filepath"
"strings"
+ "sync"
)
// File transfer types
const (
- FileDownload = 0
- FileUpload = 1
- FolderDownload = 2
- FolderUpload = 3
+ FileDownload = iota
+ FileUpload
+ FolderDownload
+ FolderUpload
+ bannerDownload
)
type FileTransfer struct {
- FileName []byte
- FilePath []byte
- ReferenceNumber []byte
- Type int
- TransferSize []byte // total size of all items in the folder. Only used in FolderUpload action
- FolderItemCount []byte
- BytesSent int
- clientID uint16
+ FileName []byte
+ FilePath []byte
+ refNum [4]byte
+ Type int
+ TransferSize []byte
+ FolderItemCount []byte
+ fileResumeData *FileResumeData
+ options []byte
+ bytesSentCounter *WriteCounter
+ ClientConn *ClientConn
}
-func (ft *FileTransfer) String() string {
- percentComplete := 10
- out := fmt.Sprintf("%s\t %v", ft.FileName, percentComplete)
-
- return out
+// WriteCounter counts the number of bytes written to it.
+type WriteCounter struct {
+ mux sync.Mutex
+ Total int64 // Total # of bytes written
}
-// 00 28 // DataSize
-// 00 00 // IsFolder
-// 00 02 // PathItemCount
-//
-// 00 00
-// 09
-// 73 75 62 66 6f 6c 64 65 72 // "subfolder"
+// Write implements the io.Writer interface.
//
-// 00 00
-// 15
-// 73 75 62 66 6f 6c 64 65 72 2d 74 65 73 74 66 69 6c 65 2d 35 6b // "subfolder-testfile-5k"
-func readFolderUpload(buf []byte) folderUpload {
- dataLen := binary.BigEndian.Uint16(buf[0:2])
+// Always completes and never returns an error.
+func (wc *WriteCounter) Write(p []byte) (int, error) {
+ wc.mux.Lock()
+ defer wc.mux.Unlock()
+ n := len(p)
+ wc.Total += int64(n)
+ return n, nil
+}
- fu := folderUpload{
- DataSize: [2]byte{buf[0], buf[1]}, // Size of this structure (not including data size element itself)
- IsFolder: [2]byte{buf[2], buf[3]},
- PathItemCount: [2]byte{buf[4], buf[5]},
- FileNamePath: buf[6 : dataLen+2],
+func (cc *ClientConn) newFileTransfer(transferType int, fileName, filePath, size []byte) *FileTransfer {
+ ft := &FileTransfer{
+ FileName: fileName,
+ FilePath: filePath,
+ Type: transferType,
+ TransferSize: size,
+ ClientConn: cc,
+ bytesSentCounter: &WriteCounter{},
}
- return fu
+ _, _ = rand.Read(ft.refNum[:])
+
+ cc.transfersMU.Lock()
+ defer cc.transfersMU.Unlock()
+ cc.transfers[transferType][ft.refNum] = ft
+
+ cc.Server.mux.Lock()
+ defer cc.Server.mux.Unlock()
+ cc.Server.fileTransfers[ft.refNum] = ft
+
+ return ft
}
+// String returns a string representation of a file transfer and its progress for display in the GetInfo window
+// Example:
+// MasterOfOrionII1.4.0. 0% 197.9M
+func (ft *FileTransfer) String() string {
+ trunc := fmt.Sprintf("%.21s", ft.FileName)
+ return fmt.Sprintf("%-21s %.3s%% %6s\n", trunc, ft.percentComplete(), ft.formattedTransferSize())
+}
-func (fu *folderUpload) UnmarshalBinary(b []byte) error {
- fu.DataSize = [2]byte{b[0], b[1]}
- fu.IsFolder = [2]byte{b[2], b[3]}
- fu.PathItemCount = [2]byte{b[4], b[5]}
+func (ft *FileTransfer) percentComplete() string {
+ ft.bytesSentCounter.mux.Lock()
+ defer ft.bytesSentCounter.mux.Unlock()
+ return fmt.Sprintf(
+ "%v",
+ math.RoundToEven(float64(ft.bytesSentCounter.Total)/float64(binary.BigEndian.Uint32(ft.TransferSize))*100),
+ )
+}
- return nil
+func (ft *FileTransfer) formattedTransferSize() string {
+ sizeInKB := float32(binary.BigEndian.Uint32(ft.TransferSize)) / 1024
+ if sizeInKB >= 1024 {
+ return fmt.Sprintf("%.1fM", sizeInKB/1024)
+ } else {
+ return fmt.Sprintf("%.0fK", sizeInKB)
+ }
+}
+
+func (ft *FileTransfer) ItemCount() int {
+ return int(binary.BigEndian.Uint16(ft.FolderItemCount))
}
type folderUpload struct {
FileNamePath []byte
}
+//func (fu *folderUpload) Write(p []byte) (int, error) {
+// if len(p) < 7 {
+// return 0, errors.New("buflen too short")
+// }
+// copy(fu.DataSize[:], p[0:2])
+// copy(fu.IsFolder[:], p[2:4])
+// copy(fu.PathItemCount[:], p[4:6])
+//
+// fu.FileNamePath = make([]byte, binary.BigEndian.Uint16(fu.DataSize[:])-4) // -4 to subtract the path separator bytes TODO: wat
+// n, err := io.ReadFull(rwc, fu.FileNamePath)
+// if err != nil {
+// return 0, err
+// }
+//
+// return n + 6, nil
+//}
+
func (fu *folderUpload) FormattedPath() string {
pathItemLen := binary.BigEndian.Uint16(fu.PathItemCount[:])
var pathSegments []string
pathData := fu.FileNamePath
+ // TODO: implement scanner interface instead?
for i := uint16(0); i < pathItemLen; i++ {
segLen := pathData[2]
pathSegments = append(pathSegments, string(pathData[3:3+segLen]))
pathData = pathData[3+segLen:]
}
- return strings.Join(pathSegments, pathSeparator)
+ return filepath.Join(pathSegments...)
+}
+
+func DownloadHandler(rwc io.ReadWriter, fullPath string, fileTransfer *FileTransfer, fs FileStore, rLogger *slog.Logger, preserveForks bool) error {
+ //s.Stats.DownloadCounter += 1
+ //s.Stats.DownloadsInProgress += 1
+ //defer func() {
+ // s.Stats.DownloadsInProgress -= 1
+ //}()
+
+ var dataOffset int64
+ if fileTransfer.fileResumeData != nil {
+ dataOffset = int64(binary.BigEndian.Uint32(fileTransfer.fileResumeData.ForkInfoList[0].DataSize[:]))
+ }
+
+ fw, err := newFileWrapper(fs, fullPath, 0)
+ if err != nil {
+ //return err
+ }
+
+ rLogger.Info("File download started", "filePath", fullPath)
+
+ // if file transfer options are included, that means this is a "quick preview" request from a 1.5+ client
+ if fileTransfer.options == nil {
+ _, err = io.Copy(rwc, fw.ffo)
+ if err != nil {
+ //return err
+ }
+ }
+
+ file, err := fw.dataForkReader()
+ if err != nil {
+ //return err
+ }
+
+ br := bufio.NewReader(file)
+ if _, err := br.Discard(int(dataOffset)); err != nil {
+ //return err
+ }
+
+ if _, err = io.Copy(rwc, io.TeeReader(br, fileTransfer.bytesSentCounter)); err != nil {
+ return err
+ }
+
+ // if the client requested to resume transfer, do not send the resource fork header, or it will be appended into the fileWrapper data
+ if fileTransfer.fileResumeData == nil {
+ err = binary.Write(rwc, binary.BigEndian, fw.rsrcForkHeader())
+ if err != nil {
+ return err
+ }
+ }
+
+ rFile, err := fw.rsrcForkFile()
+ if err != nil {
+ return nil
+ }
+
+ if _, err = io.Copy(rwc, io.TeeReader(rFile, fileTransfer.bytesSentCounter)); err != nil {
+ return err
+ }
+
+ return nil
+}
+
+func UploadHandler(rwc io.ReadWriter, fullPath string, fileTransfer *FileTransfer, fileStore FileStore, rLogger *slog.Logger, preserveForks bool) error {
+ var file *os.File
+
+ // A file upload has two possible cases:
+ // 1) Upload a new file
+ // 2) Resume a partially transferred file
+ // We have to infer which case applies by inspecting what is already on the filesystem
+
+ // Check for existing file. If found, do not proceed. This is an invalid scenario, as the file upload transaction
+ // handler should have returned an error to the client indicating there was an existing file present.
+ _, err := os.Stat(fullPath)
+ if err == nil {
+ return fmt.Errorf("existing file found: %s", fullPath)
+ }
+ if errors.Is(err, fs.ErrNotExist) {
+ // If not found, open or create a new .incomplete file
+ file, err = os.OpenFile(fullPath+incompleteFileSuffix, os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0644)
+ if err != nil {
+ return err
+ }
+ }
+
+ f, err := newFileWrapper(fileStore, fullPath, 0)
+ if err != nil {
+ return err
+ }
+
+ rLogger.Info("File upload started", "dstFile", fullPath)
+
+ rForkWriter := io.Discard
+ iForkWriter := io.Discard
+ if preserveForks {
+ rForkWriter, err = f.rsrcForkWriter()
+ if err != nil {
+ return err
+ }
+
+ iForkWriter, err = f.infoForkWriter()
+ if err != nil {
+ return err
+ }
+ }
+
+ if err := receiveFile(rwc, file, rForkWriter, iForkWriter, fileTransfer.bytesSentCounter); err != nil {
+ rLogger.Error(err.Error())
+ }
+
+ if err := file.Close(); err != nil {
+ return err
+ }
+
+ if err := fileStore.Rename(fullPath+".incomplete", fullPath); err != nil {
+ return err
+ }
+
+ rLogger.Info("File upload complete", "dstFile", fullPath)
+
+ return nil
+}
+
+func DownloadFolderHandler(rwc io.ReadWriter, fullPath string, fileTransfer *FileTransfer, fileStore FileStore, rLogger *slog.Logger, preserveForks bool) error {
+ // Folder Download flow:
+ // 1. Get filePath from the transfer
+ // 2. Iterate over files
+ // 3. For each fileWrapper:
+ // Send fileWrapper header to client
+ // The client can reply in 3 ways:
+ //
+ // 1. If type is an odd number (unknown type?), or fileWrapper download for the current fileWrapper is completed:
+ // client sends []byte{0x00, 0x03} to tell the server to continue to the next fileWrapper
+ //
+ // 2. If download of a fileWrapper is to be resumed:
+ // client sends:
+ // []byte{0x00, 0x02} // download folder action
+ // [2]byte // Resume data size
+ // []byte fileWrapper resume data (see myField_FileResumeData)
+ //
+ // 3. Otherwise, download of the fileWrapper is requested and client sends []byte{0x00, 0x01}
+ //
+ // When download is requested (case 2 or 3), server replies with:
+ // [4]byte - fileWrapper size
+ // []byte - Flattened File Object
+ //
+ // After every fileWrapper download, client could request next fileWrapper with:
+ // []byte{0x00, 0x03}
+ //
+ // This notifies the server to send the next item header
+
+ basePathLen := len(fullPath)
+
+ rLogger.Info("Start folder download", "path", fullPath)
+
+ nextAction := make([]byte, 2)
+ if _, err := io.ReadFull(rwc, nextAction); err != nil {
+ return err
+ }
+
+ i := 0
+ err := filepath.Walk(fullPath+"/", func(path string, info os.FileInfo, err error) error {
+ //s.Stats.DownloadCounter += 1
+ i += 1
+
+ if err != nil {
+ return err
+ }
+
+ // skip dot files
+ if strings.HasPrefix(info.Name(), ".") {
+ return nil
+ }
+
+ hlFile, err := newFileWrapper(fileStore, path, 0)
+ if err != nil {
+ return err
+ }
+
+ subPath := path[basePathLen+1:]
+ rLogger.Debug("Sending fileheader", "i", i, "path", path, "fullFilePath", fullPath, "subPath", subPath, "IsDir", info.IsDir())
+
+ if i == 1 {
+ return nil
+ }
+
+ fileHeader := NewFileHeader(subPath, info.IsDir())
+ if _, err := io.Copy(rwc, &fileHeader); err != nil {
+ return fmt.Errorf("error sending file header: %w", err)
+ }
+
+ // Read the client's Next Action request
+ if _, err := io.ReadFull(rwc, nextAction); err != nil {
+ return err
+ }
+
+ rLogger.Debug("Client folder download action", "action", fmt.Sprintf("%X", nextAction[0:2]))
+
+ var dataOffset int64
+
+ switch nextAction[1] {
+ case dlFldrActionResumeFile:
+ // get size of resumeData
+ resumeDataByteLen := make([]byte, 2)
+ if _, err := io.ReadFull(rwc, resumeDataByteLen); err != nil {
+ return err
+ }
+
+ resumeDataLen := binary.BigEndian.Uint16(resumeDataByteLen)
+ resumeDataBytes := make([]byte, resumeDataLen)
+ if _, err := io.ReadFull(rwc, resumeDataBytes); err != nil {
+ return err
+ }
+
+ var frd FileResumeData
+ if err := frd.UnmarshalBinary(resumeDataBytes); err != nil {
+ return err
+ }
+ dataOffset = int64(binary.BigEndian.Uint32(frd.ForkInfoList[0].DataSize[:]))
+ case dlFldrActionNextFile:
+ // client asked to skip this file
+ return nil
+ }
+
+ if info.IsDir() {
+ return nil
+ }
+
+ rLogger.Info("File download started",
+ "fileName", info.Name(),
+ "TransferSize", fmt.Sprintf("%x", hlFile.ffo.TransferSize(dataOffset)),
+ )
+
+ // Send file size to client
+ if _, err := rwc.Write(hlFile.ffo.TransferSize(dataOffset)); err != nil {
+ rLogger.Error(err.Error())
+ return fmt.Errorf("error sending file size: %w", err)
+ }
+
+ // Send ffo bytes to client
+ _, err = io.Copy(rwc, hlFile.ffo)
+ if err != nil {
+ return fmt.Errorf("error sending flat file object: %w", err)
+ }
+
+ file, err := fileStore.Open(path)
+ if err != nil {
+ return fmt.Errorf("error opening file: %w", err)
+ }
+
+ // wr := bufio.NewWriterSize(rwc, 1460)
+ if _, err = io.Copy(rwc, io.TeeReader(file, fileTransfer.bytesSentCounter)); err != nil {
+ return fmt.Errorf("error sending file: %w", err)
+ }
+
+ if nextAction[1] != 2 && hlFile.ffo.FlatFileHeader.ForkCount[1] == 3 {
+ err = binary.Write(rwc, binary.BigEndian, hlFile.rsrcForkHeader())
+ if err != nil {
+ return fmt.Errorf("error sending resource fork header: %w", err)
+ }
+
+ rFile, err := hlFile.rsrcForkFile()
+ if err != nil {
+ return fmt.Errorf("error opening resource fork: %w", err)
+ }
+
+ if _, err = io.Copy(rwc, io.TeeReader(rFile, fileTransfer.bytesSentCounter)); err != nil {
+ return fmt.Errorf("error sending resource fork: %w", err)
+ }
+ }
+
+ // Read the client's Next Action request. This is always 3, I think?
+ if _, err := io.ReadFull(rwc, nextAction); err != nil && err != io.EOF {
+ return fmt.Errorf("error reading client next action: %w", err)
+ }
+
+ return nil
+ })
+
+ if err != nil {
+ return err
+ }
+
+ return nil
+}
+
+func UploadFolderHandler(rwc io.ReadWriter, fullPath string, fileTransfer *FileTransfer, fileStore FileStore, rLogger *slog.Logger, preserveForks bool) error {
+
+ // Check if the target folder exists. If not, create it.
+ if _, err := fileStore.Stat(fullPath); os.IsNotExist(err) {
+ if err := fileStore.Mkdir(fullPath, 0777); err != nil {
+ return err
+ }
+ }
+
+ // Begin the folder upload flow by sending the "next file action" to client
+ if _, err := rwc.Write([]byte{0, dlFldrActionNextFile}); err != nil {
+ return err
+ }
+
+ fileSize := make([]byte, 4)
+
+ for i := 0; i < fileTransfer.ItemCount(); i++ {
+ //s.Stats.UploadCounter += 1
+
+ var fu folderUpload
+ // TODO: implement io.Writer on folderUpload and replace this
+ if _, err := io.ReadFull(rwc, fu.DataSize[:]); err != nil {
+ return err
+ }
+ if _, err := io.ReadFull(rwc, fu.IsFolder[:]); err != nil {
+ return err
+ }
+ if _, err := io.ReadFull(rwc, fu.PathItemCount[:]); err != nil {
+ return err
+ }
+ fu.FileNamePath = make([]byte, binary.BigEndian.Uint16(fu.DataSize[:])-4) // -4 to subtract the path separator bytes TODO: wat
+ if _, err := io.ReadFull(rwc, fu.FileNamePath); err != nil {
+ return err
+ }
+
+ if fu.IsFolder == [2]byte{0, 1} {
+ if _, err := os.Stat(filepath.Join(fullPath, fu.FormattedPath())); os.IsNotExist(err) {
+ if err := os.Mkdir(filepath.Join(fullPath, fu.FormattedPath()), 0777); err != nil {
+ return err
+ }
+ }
+
+ // Tell client to send next file
+ if _, err := rwc.Write([]byte{0, dlFldrActionNextFile}); err != nil {
+ return err
+ }
+ } else {
+ nextAction := dlFldrActionSendFile
+
+ // Check if we have the full file already. If so, send dlFldrAction_NextFile to client to skip.
+ _, err := os.Stat(filepath.Join(fullPath, fu.FormattedPath()))
+ if err != nil && !errors.Is(err, fs.ErrNotExist) {
+ return err
+ }
+ if err == nil {
+ nextAction = dlFldrActionNextFile
+ }
+
+ // Check if we have a partial file already. If so, send dlFldrAction_ResumeFile to client to resume upload.
+ incompleteFile, err := os.Stat(filepath.Join(fullPath, fu.FormattedPath()+incompleteFileSuffix))
+ if err != nil && !errors.Is(err, fs.ErrNotExist) {
+ return err
+ }
+ if err == nil {
+ nextAction = dlFldrActionResumeFile
+ }
+
+ if _, err := rwc.Write([]byte{0, uint8(nextAction)}); err != nil {
+ return err
+ }
+
+ switch nextAction {
+ case dlFldrActionNextFile:
+ continue
+ case dlFldrActionResumeFile:
+ offset := make([]byte, 4)
+ binary.BigEndian.PutUint32(offset, uint32(incompleteFile.Size()))
+
+ file, err := os.OpenFile(fullPath+"/"+fu.FormattedPath()+incompleteFileSuffix, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
+ if err != nil {
+ return err
+ }
+
+ fileResumeData := NewFileResumeData([]ForkInfoList{*NewForkInfoList(offset)})
+
+ b, _ := fileResumeData.BinaryMarshal()
+
+ bs := make([]byte, 2)
+ binary.BigEndian.PutUint16(bs, uint16(len(b)))
+
+ if _, err := rwc.Write(append(bs, b...)); err != nil {
+ return err
+ }
+
+ if _, err := io.ReadFull(rwc, fileSize); err != nil {
+ return err
+ }
+
+ if err := receiveFile(rwc, file, io.Discard, io.Discard, fileTransfer.bytesSentCounter); err != nil {
+ rLogger.Error(err.Error())
+ }
+
+ err = os.Rename(fullPath+"/"+fu.FormattedPath()+".incomplete", fullPath+"/"+fu.FormattedPath())
+ if err != nil {
+ return err
+ }
+
+ case dlFldrActionSendFile:
+ if _, err := io.ReadFull(rwc, fileSize); err != nil {
+ return err
+ }
+
+ filePath := filepath.Join(fullPath, fu.FormattedPath())
+
+ hlFile, err := newFileWrapper(fileStore, filePath, 0)
+ if err != nil {
+ return err
+ }
+
+ rLogger.Info("Starting file transfer", "path", filePath, "fileNum", i+1, "fileSize", binary.BigEndian.Uint32(fileSize))
+
+ incWriter, err := hlFile.incFileWriter()
+ if err != nil {
+ return err
+ }
+
+ rForkWriter := io.Discard
+ iForkWriter := io.Discard
+ if preserveForks {
+ iForkWriter, err = hlFile.infoForkWriter()
+ if err != nil {
+ return err
+ }
+
+ rForkWriter, err = hlFile.rsrcForkWriter()
+ if err != nil {
+ return err
+ }
+ }
+ if err := receiveFile(rwc, incWriter, rForkWriter, iForkWriter, fileTransfer.bytesSentCounter); err != nil {
+ return err
+ }
+
+ if err := os.Rename(filePath+".incomplete", filePath); err != nil {
+ return err
+ }
+ }
+
+ // Tell client to send next fileWrapper
+ if _, err := rwc.Write([]byte{0, dlFldrActionNextFile}); err != nil {
+ return err
+ }
+ }
+ }
+ rLogger.Info("Folder upload complete")
+ return nil
}
git.r.bdr.sh / rbdr / mobius / blobdiff