Add folder update support and ClientData field.

[src/xds/xds-server.git] / lib / folder / folder-interface.go

diff --git a/lib/folder/folder-interface.go b/lib/folder/folder-interface.go
index b76b3f3..3208869 100644 (file)
--- a/lib/folder/folder-interface.go
+++ b/lib/folder/folder-interface.go
@@ -1,12 +1,12 @@
 package folder
 
 // FolderType definition
-type FolderType int
+type FolderType string
 
 const (
-       TypePathMap   = 1
-       TypeCloudSync = 2
-       TypeCifsSmb   = 3
+       TypePathMap   = "PathMap"
+       TypeCloudSync = "CloudSync"
+       TypeCifsSmb   = "CIFS"
 )
 
 // Folder Status definition
@@ -14,16 +14,27 @@ const (
        StatusErrorConfig = "ErrorConfig"
        StatusDisable     = "Disable"
        StatusEnable      = "Enable"
+       StatusPause       = "Pause"
+       StatusSyncing     = "Syncing"
 )
 
+type EventCBData map[string]interface{}
+type EventCB func(cfg *FolderConfig, data *EventCBData)
+
 // IFOLDER Folder interface
 type IFOLDER interface {
-       Add(cfg FolderConfig) (*FolderConfig, error) // Add a new folder
-       GetConfig() FolderConfig                     // Get folder public configuration
-       GetFullPath(dir string) string               // Get folder full path
-       Remove() error                               // Remove a folder
-       Sync() error                                 // Force folder files synchronization
-       IsInSync() (bool, error)                     // Check if folder files are in-sync
+       NewUID(suffix string) string                              // Get a new folder UUID
+       Add(cfg FolderConfig) (*FolderConfig, error)              // Add a new folder
+       GetConfig() FolderConfig                                  // Get folder public configuration
+       GetFullPath(dir string) string                            // Get folder full path
+       ConvPathCli2Svr(s string) string                          // Convert path from Client to Server
+       ConvPathSvr2Cli(s string) string                          // Convert path from Server to Client
+       Remove() error                                            // Remove a folder
+       Update(cfg FolderConfig) (*FolderConfig, error)           // Update a new folder
+       RegisterEventChange(cb *EventCB, data *EventCBData) error // Request events registration (sent through WS)
+       UnRegisterEventChange() error                             // Un-register events
+       Sync() error                                              // Force folder files synchronization
+       IsInSync() (bool, error)                                  // Check if folder files are in-sync
 }
 
 // FolderConfig is the config for one folder
@@ -33,7 +44,9 @@ type FolderConfig struct {
        ClientPath string     `json:"path"`
        Type       FolderType `json:"type"`
        Status     string     `json:"status"`
+       IsInSync   bool       `json:"isInSync"`
        DefaultSdk string     `json:"defaultSdk"`
+       ClientData string     `json:"clientData"` // free form field that can used by client
 
        // Not exported fields from REST API point of view
        RootPath string `json:"-"`
@@ -47,13 +60,21 @@ type FolderConfig struct {
        DataCloudSync CloudSyncConfig `json:"dataCloudSync,omitempty"`
 }
 
+// FolderConfigUpdatableFields List fields that can be updated using Update function
+var FolderConfigUpdatableFields = []string{
+       "Label", "DefaultSdk", "ClientData",
+}
+
 // PathMapConfig Path mapping specific data
 type PathMapConfig struct {
        ServerPath string `json:"serverPath"`
+
+       // Don't keep temporary file name (IOW we don't want to save it and reuse it)
+       CheckFile    string `json:"checkFile" xml:"-"`
+       CheckContent string `json:"checkContent" xml:"-"`
 }
 
 // CloudSyncConfig CloudSync (AKA Syncthing) specific data
 type CloudSyncConfig struct {
-       SyncThingID   string `json:"syncThingID"`
-       BuilderSThgID string `json:"builderSThgID"`
+       SyncThingID string `json:"syncThingID"`
 }