Fix io.Reader implementations and wrap more errors

[rbdr/mobius] / hotline / files.go

diff --git a/hotline/files.go b/hotline/files.go
index 04334e951410cb06d62a9ee4c92349afa94dfbd1..901b98cbb01f981b0e1768ce9829f6dd884dca5e 100644 (file)
--- a/hotline/files.go
+++ b/hotline/files.go
@@ -3,31 +3,25 @@ package hotline
 import (
        "encoding/binary"
        "errors"
 import (
        "encoding/binary"
        "errors"

+       "fmt"
+       "io"

        "io/fs"
        "io/fs"

-       "io/ioutil"

        "os"
        "path/filepath"
        "os"
        "path/filepath"

+       "regexp"

        "strings"
 )
 
        "strings"
 )
 

-func downcaseFileExtension(filename string) string {
-       splitStr := strings.Split(filename, ".")
-       ext := strings.ToLower(
-               splitStr[len(splitStr)-1],
-       )
-
-       return ext
-}
-
-func fileTypeFromFilename(fn string) fileType {
-       ft, ok := fileTypes[downcaseFileExtension(fn)]
+func fileTypeFromFilename(filename string) fileType {
+       fileExt := strings.ToLower(filepath.Ext(filename))
+       ft, ok := fileTypes[fileExt]

        if ok {
                return ft
        }
        return defaultFileType
 }
 
        if ok {
                return ft
        }
        return defaultFileType
 }
 

-func fileTypeFromInfo(info os.FileInfo) (ft fileType, err error) {
+func fileTypeFromInfo(info fs.FileInfo) (ft fileType, err error) {

        if info.IsDir() {
                ft.CreatorCode = "n/a "
                ft.TypeCode = "fldr"
        if info.IsDir() {
                ft.CreatorCode = "n/a "
                ft.TypeCode = "fldr"


@@ -38,69 +32,114 @@ func fileTypeFromInfo(info os.FileInfo) (ft fileType, err error) {
        return ft, nil
 }
 
        return ft, nil
 }
 

-func getFileNameList(filePath string) (fields []Field, err error) {
-       files, err := ioutil.ReadDir(filePath)
+const maxFileSize = 4294967296
+
+func getFileNameList(path string, ignoreList []string) (fields []Field, err error) {
+       files, err := os.ReadDir(path)

        if err != nil {
        if err != nil {

-               return fields, nil
+               return fields, fmt.Errorf("error reading path: %s: %w", path, err)

        }
 
        }
 

-       for _, file := range files {
+       for i, _ := range files {
+               file := files[i]

                var fnwi FileNameWithInfo
 
                var fnwi FileNameWithInfo
 

+               if ignoreFile(file.Name(), ignoreList) {
+                       continue
+               }
+

                fileCreator := make([]byte, 4)
 
                fileCreator := make([]byte, 4)
 

-               if file.Mode()&os.ModeSymlink != 0 {
-                       resolvedPath, err := os.Readlink(filePath + "/" + file.Name())
+               fileInfo, err := file.Info()
+               if err != nil {
+                       return fields, fmt.Errorf("error getting file info: %s: %w", file.Name(), err)
+               }
+
+               // Check if path is a symlink.  If so, follow it.
+               if fileInfo.Mode()&os.ModeSymlink != 0 {
+                       resolvedPath, err := os.Readlink(filepath.Join(path, file.Name()))

                        if err != nil {
                        if err != nil {

-                               return fields, err
+                               return fields, fmt.Errorf("error following symlink: %s: %w", resolvedPath, err)

                        }
 
                        }
 

-                       rFile, err := os.Stat(filePath + "/" + resolvedPath)
+                       rFile, err := os.Stat(resolvedPath)
+                       if errors.Is(err, os.ErrNotExist) {
+                               continue
+                       }

                        if err != nil {
                                return fields, err
                        }
 
                        if rFile.IsDir() {
                        if err != nil {
                                return fields, err
                        }
 
                        if rFile.IsDir() {

-                               dir, err := ioutil.ReadDir(filePath + "/" + file.Name())
+                               dir, err := os.ReadDir(filepath.Join(path, file.Name()))

                                if err != nil {
                                        return fields, err
                                }
                                if err != nil {
                                        return fields, err
                                }

-                               binary.BigEndian.PutUint32(fnwi.FileSize[:], uint32(len(dir)))
-                               copy(fnwi.Type[:], []byte("fldr")[:])
-                               copy(fnwi.Creator[:], fileCreator[:])
+
+                               var c uint32
+                               for _, f := range dir {
+                                       if !ignoreFile(f.Name(), ignoreList) {
+                                               c += 1
+                                       }
+                               }
+
+                               binary.BigEndian.PutUint32(fnwi.FileSize[:], c)
+                               copy(fnwi.Type[:], "fldr")
+                               copy(fnwi.Creator[:], fileCreator)

                        } else {
                                binary.BigEndian.PutUint32(fnwi.FileSize[:], uint32(rFile.Size()))
                        } else {
                                binary.BigEndian.PutUint32(fnwi.FileSize[:], uint32(rFile.Size()))

-                               copy(fnwi.Type[:], []byte(fileTypeFromFilename(rFile.Name()).TypeCode)[:])
-                               copy(fnwi.Creator[:], []byte(fileTypeFromFilename(rFile.Name()).CreatorCode)[:])
+                               copy(fnwi.Type[:], fileTypeFromFilename(rFile.Name()).TypeCode)
+                               copy(fnwi.Creator[:], fileTypeFromFilename(rFile.Name()).CreatorCode)

                        }
                        }

-

                } else if file.IsDir() {
                } else if file.IsDir() {

-                       dir, err := ioutil.ReadDir(filePath + "/" + file.Name())
+                       dir, err := os.ReadDir(filepath.Join(path, file.Name()))

                        if err != nil {
                        if err != nil {

-                               return fields, err
+                               return fields, fmt.Errorf("readDir: %w", err)

                        }
                        }

-                       binary.BigEndian.PutUint32(fnwi.FileSize[:], uint32(len(dir)))
-                       copy(fnwi.Type[:], []byte("fldr")[:])
-                       copy(fnwi.Creator[:], fileCreator[:])
+
+                       var c uint32
+                       for _, f := range dir {
+                               if !ignoreFile(f.Name(), ignoreList) {
+                                       c += 1
+                               }
+                       }
+
+                       binary.BigEndian.PutUint32(fnwi.FileSize[:], c)
+                       copy(fnwi.Type[:], "fldr")
+                       copy(fnwi.Creator[:], fileCreator)

                } else {
                } else {

-                       binary.BigEndian.PutUint32(fnwi.FileSize[:], uint32(file.Size()))
-                       copy(fnwi.Type[:], []byte(fileTypeFromFilename(file.Name()).TypeCode)[:])
-                       copy(fnwi.Creator[:], []byte(fileTypeFromFilename(file.Name()).CreatorCode)[:])
+                       // the Hotline protocol does not support file sizes > 4GiB due to the 4 byte field size, so skip them
+                       if fileInfo.Size() > maxFileSize {
+                               continue
+                       }
+
+                       hlFile, err := newFileWrapper(&OSFileStore{}, path+"/"+file.Name(), 0)
+                       if err != nil {
+                               return nil, fmt.Errorf("newFileWrapper: %w", err)
+                       }
+
+                       copy(fnwi.FileSize[:], hlFile.totalSize())
+                       copy(fnwi.Type[:], hlFile.ffo.FlatFileInformationFork.TypeSignature)
+                       copy(fnwi.Creator[:], hlFile.ffo.FlatFileInformationFork.CreatorSignature)

                }
 
                }
 

-               strippedName := strings.Replace(file.Name(), ".incomplete", "", -1)
+               strippedName := strings.ReplaceAll(file.Name(), ".incomplete", "")
+               strippedName, err = txtEncoder.String(strippedName)
+               if err != nil {
+                       continue
+               }

 
                nameSize := make([]byte, 2)
                binary.BigEndian.PutUint16(nameSize, uint16(len(strippedName)))
 
                nameSize := make([]byte, 2)
                binary.BigEndian.PutUint16(nameSize, uint16(len(strippedName)))

-               copy(fnwi.NameSize[:], nameSize[:])
+               copy(fnwi.NameSize[:], nameSize)

 
 

-               fnwi.name = []byte(strippedName)
+               fnwi.Name = []byte(strippedName)

 
 

-               b, err := fnwi.MarshalBinary()
+               b, err := io.ReadAll(&fnwi)

                if err != nil {
                if err != nil {

-                       return nil, err
+                       return nil, fmt.Errorf("error io.ReadAll: %w", err)

                }
                }

-               fields = append(fields, NewField(fieldFileNameWithInfo, b))
+               fields = append(fields, NewField(FieldFileNameWithInfo, b))

        }
 
        return fields, nil
        }
 
        return fields, nil


@@ -134,12 +173,14 @@ func CalcTotalSize(filePath string) ([]byte, error) {
 func CalcItemCount(filePath string) ([]byte, error) {
        var itemcount uint16
        err := filepath.Walk(filePath, func(path string, info os.FileInfo, err error) error {
 func CalcItemCount(filePath string) ([]byte, error) {
        var itemcount uint16
        err := filepath.Walk(filePath, func(path string, info os.FileInfo, err error) error {

-               itemcount += 1
-

                if err != nil {
                        return err
                }
 
                if err != nil {
                        return err
                }
 

+               if !strings.HasPrefix(info.Name(), ".") {
+                       itemcount += 1
+               }
+

                return nil
        })
        if err != nil {
                return nil
        })
        if err != nil {


@@ -170,20 +211,13 @@ func EncodeFilePath(filePath string) []byte {
        return bytes
 }
 
        return bytes
 }
 

-const incompleteFileSuffix = ".incomplete"
-
-// effectiveFile wraps os.Open to check for the presence of a partial file transfer as a fallback
-func effectiveFile(filePath string) (*os.File, error) {
-       file, err := os.Open(filePath)
-       if err != nil && !errors.Is(err, fs.ErrNotExist) {
-               return nil, err
-       }
-
-       if errors.Is(err, fs.ErrNotExist) {
-               file, err = os.OpenFile(filePath+incompleteFileSuffix, os.O_APPEND|os.O_WRONLY, 0644)
-               if err != nil {
-                       return nil, err
+func ignoreFile(fileName string, ignoreList []string) bool {
+       // skip files that match any regular expression present in the IgnoreFiles list
+       matchIgnoreFilter := 0
+       for _, pattern := range ignoreList {
+               if match, _ := regexp.MatchString(pattern, fileName); match {
+                       matchIgnoreFilter += 1

                }
        }
                }
        }

-       return file, nil
+       return matchIgnoreFilter > 0

 }
 }