2014-11-16 21:13:20 +01:00
|
|
|
// Copyright (C) 2014 The Syncthing Authors.
|
2014-09-29 21:43:32 +02:00
|
|
|
//
|
|
|
|
// This program is free software: you can redistribute it and/or modify it
|
|
|
|
// under the terms of the GNU General Public License as published by the Free
|
|
|
|
// Software Foundation, either version 3 of the License, or (at your option)
|
|
|
|
// any later version.
|
|
|
|
//
|
|
|
|
// This program is distributed in the hope that it will be useful, but WITHOUT
|
|
|
|
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
|
|
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
|
|
|
// more details.
|
|
|
|
//
|
|
|
|
// You should have received a copy of the GNU General Public License along
|
|
|
|
// with this program. If not, see <http://www.gnu.org/licenses/>.
|
2014-06-01 22:50:14 +02:00
|
|
|
|
2014-02-20 17:40:15 +01:00
|
|
|
package protocol
|
|
|
|
|
2014-07-12 23:06:48 +02:00
|
|
|
import "fmt"
|
|
|
|
|
2014-02-20 17:40:15 +01:00
|
|
|
type IndexMessage struct {
|
2014-09-28 13:00:38 +02:00
|
|
|
Folder string // max:64
|
2014-09-28 13:05:25 +02:00
|
|
|
Files []FileInfo
|
2014-02-20 17:40:15 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
type FileInfo struct {
|
2014-08-25 08:47:59 +02:00
|
|
|
Name string // max:8192
|
2014-07-15 13:04:37 +02:00
|
|
|
Flags uint32
|
|
|
|
Modified int64
|
|
|
|
Version uint64
|
|
|
|
LocalVersion uint64
|
2014-07-25 09:01:54 +02:00
|
|
|
Blocks []BlockInfo
|
2014-02-20 17:40:15 +01:00
|
|
|
}
|
|
|
|
|
2014-07-12 23:06:48 +02:00
|
|
|
func (f FileInfo) String() string {
|
|
|
|
return fmt.Sprintf("File{Name:%q, Flags:0%o, Modified:%d, Version:%d, Size:%d, Blocks:%v}",
|
|
|
|
f.Name, f.Flags, f.Modified, f.Version, f.Size(), f.Blocks)
|
|
|
|
}
|
|
|
|
|
|
|
|
func (f FileInfo) Size() (bytes int64) {
|
2014-11-05 00:22:15 +01:00
|
|
|
if f.IsDeleted() || f.IsDirectory() {
|
2014-08-12 13:53:31 +02:00
|
|
|
return 128
|
|
|
|
}
|
2014-07-12 23:06:48 +02:00
|
|
|
for _, b := range f.Blocks {
|
|
|
|
bytes += int64(b.Size)
|
|
|
|
}
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
2014-08-12 13:53:31 +02:00
|
|
|
func (f FileInfo) IsDeleted() bool {
|
2014-11-05 00:22:15 +01:00
|
|
|
return f.Flags&FlagDeleted != 0
|
2014-08-12 13:53:31 +02:00
|
|
|
}
|
|
|
|
|
2014-09-01 09:07:51 +02:00
|
|
|
func (f FileInfo) IsInvalid() bool {
|
2014-11-05 00:22:15 +01:00
|
|
|
return f.Flags&FlagInvalid != 0
|
2014-10-06 22:57:33 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
func (f FileInfo) IsDirectory() bool {
|
2014-11-05 00:22:15 +01:00
|
|
|
return f.Flags&FlagDirectory != 0
|
|
|
|
}
|
|
|
|
|
2014-11-08 00:06:04 +01:00
|
|
|
func (f FileInfo) IsSymlink() bool {
|
|
|
|
return f.Flags&FlagSymlink != 0
|
|
|
|
}
|
|
|
|
|
2014-11-05 00:22:15 +01:00
|
|
|
func (f FileInfo) HasPermissionBits() bool {
|
|
|
|
return f.Flags&FlagNoPermBits == 0
|
2014-09-01 09:07:51 +02:00
|
|
|
}
|
|
|
|
|
2014-08-12 13:53:31 +02:00
|
|
|
// Used for unmarshalling a FileInfo structure but skipping the actual block list
|
|
|
|
type FileInfoTruncated struct {
|
2014-08-25 08:47:59 +02:00
|
|
|
Name string // max:8192
|
2014-08-12 13:53:31 +02:00
|
|
|
Flags uint32
|
|
|
|
Modified int64
|
|
|
|
Version uint64
|
|
|
|
LocalVersion uint64
|
|
|
|
NumBlocks uint32
|
|
|
|
}
|
|
|
|
|
2014-10-16 09:26:20 +02:00
|
|
|
func (f FileInfoTruncated) String() string {
|
|
|
|
return fmt.Sprintf("File{Name:%q, Flags:0%o, Modified:%d, Version:%d, Size:%d, NumBlocks:%d}",
|
|
|
|
f.Name, f.Flags, f.Modified, f.Version, f.Size(), f.NumBlocks)
|
|
|
|
}
|
|
|
|
|
2014-11-23 01:52:48 +01:00
|
|
|
func BlocksToSize(num uint32) int64 {
|
|
|
|
if num < 2 {
|
|
|
|
return BlockSize / 2
|
|
|
|
}
|
|
|
|
return int64(num-1)*BlockSize + BlockSize/2
|
|
|
|
}
|
|
|
|
|
2014-08-12 16:36:24 +02:00
|
|
|
// Returns a statistical guess on the size, not the exact figure
|
2014-08-12 13:53:31 +02:00
|
|
|
func (f FileInfoTruncated) Size() int64 {
|
2014-11-05 00:22:15 +01:00
|
|
|
if f.IsDeleted() || f.IsDirectory() {
|
2014-08-12 13:53:31 +02:00
|
|
|
return 128
|
|
|
|
}
|
2014-11-23 01:52:48 +01:00
|
|
|
return BlocksToSize(f.NumBlocks)
|
2014-08-12 13:53:31 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
func (f FileInfoTruncated) IsDeleted() bool {
|
2014-11-05 00:22:15 +01:00
|
|
|
return f.Flags&FlagDeleted != 0
|
2014-08-12 13:53:31 +02:00
|
|
|
}
|
|
|
|
|
2014-09-01 09:07:51 +02:00
|
|
|
func (f FileInfoTruncated) IsInvalid() bool {
|
2014-11-05 00:22:15 +01:00
|
|
|
return f.Flags&FlagInvalid != 0
|
|
|
|
}
|
|
|
|
|
|
|
|
func (f FileInfoTruncated) IsDirectory() bool {
|
|
|
|
return f.Flags&FlagDirectory != 0
|
|
|
|
}
|
|
|
|
|
2014-11-08 00:06:04 +01:00
|
|
|
func (f FileInfoTruncated) IsSymlink() bool {
|
|
|
|
return f.Flags&FlagSymlink != 0
|
|
|
|
}
|
|
|
|
|
2014-11-05 00:22:15 +01:00
|
|
|
func (f FileInfoTruncated) HasPermissionBits() bool {
|
|
|
|
return f.Flags&FlagNoPermBits == 0
|
2014-09-01 09:07:51 +02:00
|
|
|
}
|
|
|
|
|
2014-08-12 13:53:31 +02:00
|
|
|
type FileIntf interface {
|
|
|
|
Size() int64
|
|
|
|
IsDeleted() bool
|
2014-09-01 09:07:51 +02:00
|
|
|
IsInvalid() bool
|
2014-11-05 00:22:15 +01:00
|
|
|
IsDirectory() bool
|
2014-11-08 00:06:04 +01:00
|
|
|
IsSymlink() bool
|
2014-11-05 00:22:15 +01:00
|
|
|
HasPermissionBits() bool
|
2014-08-12 13:53:31 +02:00
|
|
|
}
|
|
|
|
|
2014-02-20 17:40:15 +01:00
|
|
|
type BlockInfo struct {
|
2014-07-12 23:06:48 +02:00
|
|
|
Offset int64 // noencode (cache only)
|
|
|
|
Size uint32
|
|
|
|
Hash []byte // max:64
|
|
|
|
}
|
|
|
|
|
|
|
|
func (b BlockInfo) String() string {
|
|
|
|
return fmt.Sprintf("Block{%d/%d/%x}", b.Offset, b.Size, b.Hash)
|
2014-02-20 17:40:15 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
type RequestMessage struct {
|
2014-09-28 13:00:38 +02:00
|
|
|
Folder string // max:64
|
2014-09-28 13:05:25 +02:00
|
|
|
Name string // max:8192
|
|
|
|
Offset uint64
|
|
|
|
Size uint32
|
2014-02-20 17:40:15 +01:00
|
|
|
}
|
|
|
|
|
2014-07-28 11:31:22 +02:00
|
|
|
type ResponseMessage struct {
|
|
|
|
Data []byte
|
|
|
|
}
|
|
|
|
|
2014-04-13 15:28:26 +02:00
|
|
|
type ClusterConfigMessage struct {
|
2014-09-28 13:05:25 +02:00
|
|
|
ClientName string // max:64
|
|
|
|
ClientVersion string // max:64
|
|
|
|
Folders []Folder // max:64
|
|
|
|
Options []Option // max:64
|
2014-04-13 15:28:26 +02:00
|
|
|
}
|
|
|
|
|
2014-08-15 00:15:26 +02:00
|
|
|
func (o *ClusterConfigMessage) GetOption(key string) string {
|
|
|
|
for _, option := range o.Options {
|
|
|
|
if option.Key == key {
|
|
|
|
return option.Value
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return ""
|
|
|
|
}
|
|
|
|
|
2014-09-28 13:00:38 +02:00
|
|
|
type Folder struct {
|
2014-10-20 22:45:26 +02:00
|
|
|
ID string // max:64
|
|
|
|
Devices []Device
|
2014-04-13 15:28:26 +02:00
|
|
|
}
|
|
|
|
|
2014-09-28 13:00:38 +02:00
|
|
|
type Device struct {
|
2014-07-15 13:04:37 +02:00
|
|
|
ID []byte // max:32
|
|
|
|
Flags uint32
|
|
|
|
MaxLocalVersion uint64
|
2014-02-20 17:40:15 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
type Option struct {
|
|
|
|
Key string // max:64
|
|
|
|
Value string // max:1024
|
|
|
|
}
|
2014-07-26 21:27:55 +02:00
|
|
|
|
|
|
|
type CloseMessage struct {
|
|
|
|
Reason string // max:1024
|
|
|
|
}
|
2014-07-28 11:31:22 +02:00
|
|
|
|
|
|
|
type EmptyMessage struct{}
|