syncthing/lib/protocol/nativemodel_windows.go
Jakob Borg bda4016109
lib/protocol: Refactor interface (#9375)
This is a refactor of the protocol/model interface to take the actual
message as the parameter, instead of the broken-out fields:

```diff
type Model interface {
        // An index was received from the peer device
-       Index(conn Connection, folder string, files []FileInfo) error
+       Index(conn Connection, idx *Index) error
        // An index update was received from the peer device
-       IndexUpdate(conn Connection, folder string, files []FileInfo) error
+       IndexUpdate(conn Connection, idxUp *IndexUpdate) error
        // A request was made by the peer device
-       Request(conn Connection, folder, name string, blockNo, size int32, offset int64, hash []byte, weakHash uint32, fromTemporary bool) (RequestResponse, error)
+       Request(conn Connection, req *Request) (RequestResponse, error)
        // A cluster configuration message was received
-       ClusterConfig(conn Connection, config ClusterConfig) error
+       ClusterConfig(conn Connection, config *ClusterConfig) error
        // The peer device closed the connection or an error occurred
        Closed(conn Connection, err error)
        // The peer device sent progress updates for the files it is currently downloading
-       DownloadProgress(conn Connection, folder string, updates []FileDownloadProgressUpdate) error
+       DownloadProgress(conn Connection, p *DownloadProgress) error
 }
```

(and changing the `ClusterConfig` to `*ClusterConfig` for symmetry;
we'll be forced to use all pointers everywhere at some point anyway...)

The reason for this is that I have another thing cooking which is a
small troubleshooting change to check index consistency during transfer.
This required adding a field or two to the index/indexupdate messages,
and plumbing the extra parameters in umpteen changes is almost as big a
diff as this is. I figured let's do it once and avoid having to do that
in the future again...

The rest of the diff falls out of the change above, much of it being in
test code where we run these methods manually...
2024-01-31 08:18:27 +01:00

80 lines
1.7 KiB
Go

// Copyright (C) 2014 The Protocol Authors.
//go:build windows
// +build windows
package protocol
// Windows uses backslashes as file separator
import (
"fmt"
"path/filepath"
"strings"
)
func makeNative(m rawModel) rawModel { return nativeModel{m} }
type nativeModel struct {
rawModel
}
func (m nativeModel) Index(idx *Index) error {
idx.Files = fixupFiles(idx.Files)
return m.rawModel.Index(idx)
}
func (m nativeModel) IndexUpdate(idxUp *IndexUpdate) error {
idxUp.Files = fixupFiles(idxUp.Files)
return m.rawModel.IndexUpdate(idxUp)
}
func (m nativeModel) Request(req *Request) (RequestResponse, error) {
if strings.Contains(req.Name, `\`) {
l.Warnf("Dropping request for %s, contains invalid path separator", req.Name)
return nil, ErrNoSuchFile
}
req.Name = filepath.FromSlash(req.Name)
return m.rawModel.Request(req)
}
func fixupFiles(files []FileInfo) []FileInfo {
var out []FileInfo
for i := range files {
if strings.Contains(files[i].Name, `\`) {
msg := fmt.Sprintf("Dropping index entry for %s, contains invalid path separator", files[i].Name)
if files[i].Deleted {
// Dropping a deleted item doesn't have any consequences.
l.Debugln(msg)
} else {
l.Warnln(msg)
}
if out == nil {
// Most incoming updates won't contain anything invalid, so
// we delay the allocation and copy to output slice until we
// really need to do it, then copy all the so-far valid
// files to it.
out = make([]FileInfo, i, len(files)-1)
copy(out, files)
}
continue
}
// Fixup the path separators
files[i].Name = filepath.FromSlash(files[i].Name)
if out != nil {
out = append(out, files[i])
}
}
if out != nil {
// We did some filtering
return out
}
// Unchanged
return files
}