lib/xdsserver/folder-st.go

   1 /*
   2  * Copyright (C) 2017 "IoT.bzh"
   3  * Author Sebastien Douheret <sebastien@iot.bzh>
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *   http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 package xdsserver
  19
  20 import (
  21         "fmt"
  22         "os"
  23         "path/filepath"
  24         "strings"
  25
  26         "github.com/iotbzh/xds-server/lib/xsapiv1"
  27         st "github.com/iotbzh/xds-server/lib/syncthing"
  28         uuid "github.com/satori/go.uuid"
  29         "github.com/syncthing/syncthing/lib/config"
  30 )
  31
  32 // IFOLDER interface implementation for syncthing
  33
  34 // STFolder .
  35 type STFolder struct {
  36         *Context
  37         st                *st.SyncThing
  38         fConfig           xsapiv1.FolderConfig
  39         stfConfig         config.FolderConfiguration
  40         eventIDs          []int
  41         eventChangeCB     *FolderEventCB
  42         eventChangeCBData *FolderEventCBData
  43 }
  44
  45 // NewFolderST Create a new instance of STFolder
  46 func NewFolderST(ctx *Context, sthg *st.SyncThing) *STFolder {
  47         return &STFolder{
  48                 Context: ctx,
  49                 st:      sthg,
  50         }
  51 }
  52
  53 // NewUID Get a UUID
  54 func (f *STFolder) NewUID(suffix string) string {
  55         i := len(f.st.MyID)
  56         if i > 15 {
  57                 i = 15
  58         }
  59         uuid := uuid.NewV1().String()[:14] + f.st.MyID[:i]
  60         if len(suffix) > 0 {
  61                 uuid += "_" + suffix
  62         }
  63         return uuid
  64 }
  65
  66 // Add a new folder
  67 func (f *STFolder) Add(cfg xsapiv1.FolderConfig) (*xsapiv1.FolderConfig, error) {
  68
  69         // Sanity check
  70         if cfg.DataCloudSync.SyncThingID == "" {
  71                 return nil, fmt.Errorf("device id not set (SyncThingID field)")
  72         }
  73
  74         // rootPath should not be empty
  75         if cfg.RootPath == "" {
  76                 cfg.RootPath = f.Config.FileConf.ShareRootDir
  77         }
  78
  79         f.fConfig = cfg
  80
  81         // Update Syncthing folder
  82         // (except if status is ErrorConfig)
  83         // TODO: add cache to avoid multiple requests on startup
  84         if f.fConfig.Status != xsapiv1.StatusErrorConfig {
  85                 id, err := f.st.FolderChange(f.fConfig)
  86                 if err != nil {
  87                         return nil, err
  88                 }
  89
  90                 f.stfConfig, err = f.st.FolderConfigGet(id)
  91                 if err != nil {
  92                         f.fConfig.Status = xsapiv1.StatusErrorConfig
  93                         return nil, err
  94                 }
  95
  96                 // Register to events to update folder status
  97                 for _, evName := range []string{st.EventStateChanged, st.EventFolderPaused} {
  98                         evID, err := f.st.Events.Register(evName, f.cbEventState, id, nil)
  99                         if err != nil {
 100                                 return nil, err
 101                         }
 102                         f.eventIDs = append(f.eventIDs, evID)
 103                 }
 104
 105                 f.fConfig.IsInSync = false // will be updated later by events
 106                 f.fConfig.Status = xsapiv1.StatusEnable
 107         }
 108
 109         return &f.fConfig, nil
 110 }
 111
 112 // GetConfig Get public part of folder config
 113 func (f *STFolder) GetConfig() xsapiv1.FolderConfig {
 114         return f.fConfig
 115 }
 116
 117 // GetFullPath returns the full path of a directory (from server POV)
 118 func (f *STFolder) GetFullPath(dir string) string {
 119         if &dir == nil {
 120                 dir = ""
 121         }
 122         if filepath.IsAbs(dir) {
 123                 return filepath.Join(f.fConfig.RootPath, dir)
 124         }
 125         return filepath.Join(f.fConfig.RootPath, f.fConfig.ClientPath, dir)
 126 }
 127
 128 // ConvPathCli2Svr Convert path from Client to Server
 129 func (f *STFolder) ConvPathCli2Svr(s string) string {
 130         if f.fConfig.ClientPath != "" && f.fConfig.RootPath != "" {
 131                 return strings.Replace(s,
 132                         f.fConfig.ClientPath,
 133                         f.fConfig.RootPath+"/"+f.fConfig.ClientPath,
 134                         -1)
 135         }
 136         return s
 137 }
 138
 139 // ConvPathSvr2Cli Convert path from Server to Client
 140 func (f *STFolder) ConvPathSvr2Cli(s string) string {
 141         if f.fConfig.ClientPath != "" && f.fConfig.RootPath != "" {
 142                 return strings.Replace(s,
 143                         f.fConfig.RootPath+"/"+f.fConfig.ClientPath,
 144                         f.fConfig.ClientPath,
 145                         -1)
 146         }
 147         return s
 148 }
 149
 150 // Remove a folder
 151 func (f *STFolder) Remove() error {
 152         err := f.st.FolderDelete(f.stfConfig.ID)
 153
 154         // Delete folder on server side
 155         err2 := os.RemoveAll(f.GetFullPath(""))
 156
 157         if err != nil {
 158                 return err
 159         }
 160         return err2
 161 }
 162
 163 // Update update some fields of a folder
 164 func (f *STFolder) Update(cfg xsapiv1.FolderConfig) (*xsapiv1.FolderConfig, error) {
 165         if f.fConfig.ID != cfg.ID {
 166                 return nil, fmt.Errorf("Invalid id")
 167         }
 168         f.fConfig = cfg
 169         return &f.fConfig, nil
 170 }
 171
 172 // RegisterEventChange requests registration for folder event change
 173 func (f *STFolder) RegisterEventChange(cb *FolderEventCB, data *FolderEventCBData) error {
 174         f.eventChangeCB = cb
 175         f.eventChangeCBData = data
 176         return nil
 177 }
 178
 179 // UnRegisterEventChange remove registered callback
 180 func (f *STFolder) UnRegisterEventChange() error {
 181         f.eventChangeCB = nil
 182         f.eventChangeCBData = nil
 183         return nil
 184 }
 185
 186 // Sync Force folder files synchronization
 187 func (f *STFolder) Sync() error {
 188         return f.st.FolderScan(f.stfConfig.ID, "")
 189 }
 190
 191 // IsInSync Check if folder files are in-sync
 192 func (f *STFolder) IsInSync() (bool, error) {
 193         sts, err := f.st.IsFolderInSync(f.stfConfig.ID)
 194         if err != nil {
 195                 return false, err
 196         }
 197         f.fConfig.IsInSync = sts
 198         return sts, nil
 199 }
 200
 201 // callback use to update IsInSync status
 202 func (f *STFolder) cbEventState(ev st.Event, data *st.EventsCBData) {
 203         prevSync := f.fConfig.IsInSync
 204         prevStatus := f.fConfig.Status
 205
 206         switch ev.Type {
 207
 208         case st.EventStateChanged:
 209                 to := ev.Data["to"]
 210                 switch to {
 211                 case "scanning", "syncing":
 212                         f.fConfig.Status = xsapiv1.StatusSyncing
 213                 case "idle":
 214                         f.fConfig.Status = xsapiv1.StatusEnable
 215                 }
 216                 f.fConfig.IsInSync = (to == "idle")
 217
 218         case st.EventFolderPaused:
 219                 if f.fConfig.Status == xsapiv1.StatusEnable {
 220                         f.fConfig.Status = xsapiv1.StatusPause
 221                 }
 222                 f.fConfig.IsInSync = false
 223         }
 224
 225         if f.eventChangeCB != nil &&
 226                 (prevSync != f.fConfig.IsInSync || prevStatus != f.fConfig.Status) {
 227                 cpConf := f.fConfig
 228                 (*f.eventChangeCB)(&cpConf, f.eventChangeCBData)
 229         }
 230 }