X-Git-Url: https://git.r.bdr.sh/rbdr/mobius/blobdiff_plain/2d52424e94e617627e4438fd207ee94949409328..f8e4cd540b87de3e308ec18a2b040b284a741522:/hotline/flattened_file_object.go diff --git a/hotline/flattened_file_object.go b/hotline/flattened_file_object.go index 6b8d3d9..b178c6c 100644 --- a/hotline/flattened_file_object.go +++ b/hotline/flattened_file_object.go @@ -1,16 +1,20 @@ package hotline import ( + "bytes" "encoding/binary" - "os" + "io" + "slices" ) type flattenedFileObject struct { FlatFileHeader FlatFileHeader - FlatFileInformationForkHeader FlatFileInformationForkHeader + FlatFileInformationForkHeader FlatFileForkHeader FlatFileInformationFork FlatFileInformationFork - FlatFileDataForkHeader FlatFileDataForkHeader - FileData []byte + FlatFileDataForkHeader FlatFileForkHeader + FlatFileResForkHeader FlatFileForkHeader + + readOffset int // Internal offset to track read progress } // FlatFileHeader is the first section of a "Flattened File Object". All fields have static values. @@ -18,25 +22,7 @@ type FlatFileHeader struct { Format [4]byte // Always "FILP" Version [2]byte // Always 1 RSVD [16]byte // Always empty zeros - ForkCount [2]byte // Number of forks -} - -// NewFlatFileHeader returns a FlatFileHeader struct -func NewFlatFileHeader() FlatFileHeader { - return FlatFileHeader{ - Format: [4]byte{0x46, 0x49, 0x4c, 0x50}, // FILP - Version: [2]byte{0, 1}, - RSVD: [16]byte{}, - ForkCount: [2]byte{0, 2}, - } -} - -// FlatFileInformationForkHeader is the second section of a "Flattened File Object" -type FlatFileInformationForkHeader struct { - ForkType [4]byte // Always "INFO" - CompressionType [4]byte // Always 0; Compression was never implemented in the Hotline protocol - RSVD [4]byte // Always zeros - DataSize [4]byte // Size of the flat file information fork + ForkCount [2]byte // Number of forks, either 2 or 3 if there is a resource fork } type FlatFileInformationFork struct { @@ -48,11 +34,13 @@ type FlatFileInformationFork struct { RSVD []byte CreateDate []byte ModifyDate []byte - NameScript []byte // TODO: what is this? + NameScript []byte NameSize []byte // Length of file name (Maximum 128 characters) Name []byte // File name - CommentSize []byte // Length of file comment + CommentSize []byte // Length of the comment Comment []byte // File comment + + readOffset int // Internal offset to track read progress } func NewFlatFileInformationFork(fileName string, modifyTime []byte, typeSignature string, creatorSignature string) FlatFileInformationFork { @@ -73,34 +61,65 @@ func NewFlatFileInformationFork(fileName string, modifyTime []byte, typeSignatur } func (ffif *FlatFileInformationFork) friendlyType() []byte { - if name, ok := friendlyCreatorNames[string(ffif.TypeSignature)]; ok { return []byte(name) } + return ffif.TypeSignature +} + +func (ffif *FlatFileInformationFork) friendlyCreator() []byte { + if name, ok := friendlyCreatorNames[string(ffif.CreatorSignature)]; ok { + return []byte(name) + } return ffif.CreatorSignature } +func (ffif *FlatFileInformationFork) setComment(comment []byte) error { + ffif.CommentSize = make([]byte, 2) + ffif.Comment = comment + binary.BigEndian.PutUint16(ffif.CommentSize, uint16(len(comment))) + + // TODO: return err if comment is too long + return nil +} + // DataSize calculates the size of the flat file information fork, which is // 72 bytes for the fixed length fields plus the length of the Name + Comment func (ffif *FlatFileInformationFork) DataSize() []byte { size := make([]byte, 4) - // TODO: Can I do math directly on two byte slices? - dataSize := len(ffif.Name) + len(ffif.Comment) + 74 + dataSize := len(ffif.Name) + len(ffif.Comment) + 74 // 74 = len of fixed size headers binary.BigEndian.PutUint32(size, uint32(dataSize)) return size } -func (ffo *flattenedFileObject) TransferSize() []byte { - payloadSize := len(ffo.BinaryMarshal()) +func (ffif *FlatFileInformationFork) Size() [4]byte { + size := [4]byte{} + + dataSize := len(ffif.Name) + len(ffif.Comment) + 74 // 74 = len of fixed size headers + + binary.BigEndian.PutUint32(size[:], uint32(dataSize)) + + return size +} + +func (ffo *flattenedFileObject) TransferSize(offset int64) []byte { + // get length of the flattenedFileObject, including the info fork + b, _ := io.ReadAll(ffo) + payloadSize := len(b) + + // length of data fork dataSize := binary.BigEndian.Uint32(ffo.FlatFileDataForkHeader.DataSize[:]) - transferSize := make([]byte, 4) - binary.BigEndian.PutUint32(transferSize, dataSize+uint32(payloadSize)) + // length of resource fork + resForkSize := binary.BigEndian.Uint32(ffo.FlatFileResForkHeader.DataSize[:]) - return transferSize + size := make([]byte, 4) + binary.BigEndian.PutUint32(size, dataSize+resForkSize+uint32(payloadSize)-uint32(offset)) + + return size } func (ffif *FlatFileInformationFork) ReadNameSize() []byte { @@ -110,13 +129,72 @@ func (ffif *FlatFileInformationFork) ReadNameSize() []byte { return size } -type FlatFileDataForkHeader struct { - ForkType [4]byte +type FlatFileForkHeader struct { + ForkType [4]byte // Either INFO, DATA or MACR CompressionType [4]byte RSVD [4]byte DataSize [4]byte } +func (ffif *FlatFileInformationFork) Read(p []byte) (int, error) { + buf := slices.Concat( + ffif.Platform, + ffif.TypeSignature, + ffif.CreatorSignature, + ffif.Flags, + ffif.PlatformFlags, + ffif.RSVD, + ffif.CreateDate, + ffif.ModifyDate, + ffif.NameScript, + ffif.ReadNameSize(), + ffif.Name, + ffif.CommentSize, + ffif.Comment, + ) + + if ffif.readOffset >= len(buf) { + return 0, io.EOF // All bytes have been read + } + + n := copy(p, buf[ffif.readOffset:]) + ffif.readOffset += n + + return n, nil +} + +// Write implements the io.Writer interface for FlatFileInformationFork +func (ffif *FlatFileInformationFork) Write(p []byte) (int, error) { + nameSize := p[70:72] + bs := binary.BigEndian.Uint16(nameSize) + total := 72 + bs + + ffif.Platform = p[0:4] + ffif.TypeSignature = p[4:8] + ffif.CreatorSignature = p[8:12] + ffif.Flags = p[12:16] + ffif.PlatformFlags = p[16:20] + ffif.RSVD = p[20:52] + ffif.CreateDate = p[52:60] + ffif.ModifyDate = p[60:68] + ffif.NameScript = p[68:70] + ffif.NameSize = p[70:72] + ffif.Name = p[72:total] + + if len(p) > int(total) { + ffif.CommentSize = p[total : total+2] + commentLen := binary.BigEndian.Uint16(ffif.CommentSize) + commentStartPos := int(total) + 2 + commentEndPos := int(total) + 2 + int(commentLen) + + ffif.Comment = p[commentStartPos:commentEndPos] + + //total = uint16(commentEndPos) + } + + return len(p), nil +} + func (ffif *FlatFileInformationFork) UnmarshalBinary(b []byte) error { nameSize := b[70:72] bs := binary.BigEndian.Uint16(nameSize) @@ -147,72 +225,79 @@ func (ffif *FlatFileInformationFork) UnmarshalBinary(b []byte) error { return nil } -func (f *flattenedFileObject) BinaryMarshal() []byte { - var out []byte - out = append(out, f.FlatFileHeader.Format[:]...) - out = append(out, f.FlatFileHeader.Version[:]...) - out = append(out, f.FlatFileHeader.RSVD[:]...) - out = append(out, f.FlatFileHeader.ForkCount[:]...) - - out = append(out, []byte("INFO")...) - out = append(out, []byte{0, 0, 0, 0}...) - out = append(out, make([]byte, 4)...) - out = append(out, f.FlatFileInformationFork.DataSize()...) - - out = append(out, f.FlatFileInformationFork.Platform...) - out = append(out, f.FlatFileInformationFork.TypeSignature...) - out = append(out, f.FlatFileInformationFork.CreatorSignature...) - out = append(out, f.FlatFileInformationFork.Flags...) - out = append(out, f.FlatFileInformationFork.PlatformFlags...) - out = append(out, f.FlatFileInformationFork.RSVD...) - out = append(out, f.FlatFileInformationFork.CreateDate...) - out = append(out, f.FlatFileInformationFork.ModifyDate...) - out = append(out, f.FlatFileInformationFork.NameScript...) - out = append(out, f.FlatFileInformationFork.ReadNameSize()...) - out = append(out, f.FlatFileInformationFork.Name...) - out = append(out, f.FlatFileInformationFork.CommentSize...) - out = append(out, f.FlatFileInformationFork.Comment...) - - out = append(out, f.FlatFileDataForkHeader.ForkType[:]...) - out = append(out, f.FlatFileDataForkHeader.CompressionType[:]...) - out = append(out, f.FlatFileDataForkHeader.RSVD[:]...) - out = append(out, f.FlatFileDataForkHeader.DataSize[:]...) - - return out -} - -func NewFlattenedFileObject(fileRoot string, filePath, fileName []byte, dataOffset int64) (*flattenedFileObject, error) { - fullFilePath, err := readPath(fileRoot, filePath, fileName) - if err != nil { - return nil, err +// Read implements the io.Reader interface for flattenedFileObject +func (ffo *flattenedFileObject) Read(p []byte) (int, error) { + buf := slices.Concat( + ffo.FlatFileHeader.Format[:], + ffo.FlatFileHeader.Version[:], + ffo.FlatFileHeader.RSVD[:], + ffo.FlatFileHeader.ForkCount[:], + []byte("INFO"), + []byte{0, 0, 0, 0}, + make([]byte, 4), + ffo.FlatFileInformationFork.DataSize(), + ffo.FlatFileInformationFork.Platform, + ffo.FlatFileInformationFork.TypeSignature, + ffo.FlatFileInformationFork.CreatorSignature, + ffo.FlatFileInformationFork.Flags, + ffo.FlatFileInformationFork.PlatformFlags, + ffo.FlatFileInformationFork.RSVD, + ffo.FlatFileInformationFork.CreateDate, + ffo.FlatFileInformationFork.ModifyDate, + ffo.FlatFileInformationFork.NameScript, + ffo.FlatFileInformationFork.ReadNameSize(), + ffo.FlatFileInformationFork.Name, + ffo.FlatFileInformationFork.CommentSize, + ffo.FlatFileInformationFork.Comment, + ffo.FlatFileDataForkHeader.ForkType[:], + ffo.FlatFileDataForkHeader.CompressionType[:], + ffo.FlatFileDataForkHeader.RSVD[:], + ffo.FlatFileDataForkHeader.DataSize[:], + ) + + if ffo.readOffset >= len(buf) { + return 0, io.EOF // All bytes have been read } - file, err := effectiveFile(fullFilePath) - if err != nil { - return nil, err + + n := copy(p, buf[ffo.readOffset:]) + ffo.readOffset += n + + return n, nil +} + +func (ffo *flattenedFileObject) ReadFrom(r io.Reader) (int64, error) { + var n int64 + + if err := binary.Read(r, binary.BigEndian, &ffo.FlatFileHeader); err != nil { + return n, err } - defer func(file *os.File) { _ = file.Close() }(file) + if err := binary.Read(r, binary.BigEndian, &ffo.FlatFileInformationForkHeader); err != nil { + return n, err + } + + dataLen := binary.BigEndian.Uint32(ffo.FlatFileInformationForkHeader.DataSize[:]) + ffifBuf := make([]byte, dataLen) + if _, err := io.ReadFull(r, ffifBuf); err != nil { + return n, err + } - fileInfo, err := file.Stat() + _, err := io.Copy(&ffo.FlatFileInformationFork, bytes.NewReader(ffifBuf)) if err != nil { - return nil, err + return n, err } - dataSize := make([]byte, 4) - binary.BigEndian.PutUint32(dataSize, uint32(fileInfo.Size()-dataOffset)) + if err := binary.Read(r, binary.BigEndian, &ffo.FlatFileDataForkHeader); err != nil { + return n, err + } - mTime := toHotlineTime(fileInfo.ModTime()) + return n, nil +} - ft, _ := fileTypeFromInfo(fileInfo) +func (ffo *flattenedFileObject) dataSize() int64 { + return int64(binary.BigEndian.Uint32(ffo.FlatFileDataForkHeader.DataSize[:])) +} - return &flattenedFileObject{ - FlatFileHeader: NewFlatFileHeader(), - FlatFileInformationFork: NewFlatFileInformationFork(string(fileName), mTime, ft.TypeCode, ft.CreatorCode), - FlatFileDataForkHeader: FlatFileDataForkHeader{ - ForkType: [4]byte{0x44, 0x41, 0x54, 0x41}, // "DATA" - CompressionType: [4]byte{}, - RSVD: [4]byte{}, - DataSize: [4]byte{dataSize[0], dataSize[1], dataSize[2], dataSize[3]}, - }, - }, nil +func (ffo *flattenedFileObject) rsrcSize() int64 { + return int64(binary.BigEndian.Uint32(ffo.FlatFileResForkHeader.DataSize[:])) }