lib/syncthing/st.go

   1 package st
   2
   3 import (
   4         "encoding/json"
   5         "io"
   6         "io/ioutil"
   7         "os"
   8         "path"
   9         "path/filepath"
  10         "regexp"
  11         "strings"
  12         "syscall"
  13         "time"
  14
  15         "fmt"
  16
  17         "os/exec"
  18
  19         "github.com/Sirupsen/logrus"
  20         "github.com/iotbzh/xds-agent/lib/xdsconfig"
  21         common "github.com/iotbzh/xds-common/golib"
  22         "github.com/syncthing/syncthing/lib/config"
  23 )
  24
  25 // SyncThing .
  26 type SyncThing struct {
  27         BaseURL string
  28         APIKey  string
  29         Home    string
  30         STCmd   *exec.Cmd
  31         STICmd  *exec.Cmd
  32
  33         // Private fields
  34         binDir      string
  35         logsDir     string
  36         exitSTChan  chan ExitChan
  37         exitSTIChan chan ExitChan
  38         client      *common.HTTPClient
  39         log         *logrus.Logger
  40 }
  41
  42 // ExitChan Channel used for process exit
  43 type ExitChan struct {
  44         status int
  45         err    error
  46 }
  47
  48 // NewSyncThing creates a new instance of Syncthing
  49 func NewSyncThing(conf *xdsconfig.Config, log *logrus.Logger) *SyncThing {
  50         var url, apiKey, home, binDir string
  51         var err error
  52
  53         stCfg := conf.FileConf.SThgConf
  54         if stCfg != nil {
  55                 url = stCfg.GuiAddress
  56                 apiKey = stCfg.GuiAPIKey
  57                 home = stCfg.Home
  58                 binDir = stCfg.BinDir
  59         }
  60
  61         if url == "" {
  62                 url = "http://localhost:8384"
  63         }
  64         if url[0:7] != "http://" {
  65                 url = "http://" + url
  66         }
  67
  68         if home == "" {
  69                 home = "/mnt/share"
  70         }
  71
  72         if binDir == "" {
  73                 if binDir, err = filepath.Abs(filepath.Dir(os.Args[0])); err != nil {
  74                         binDir = "/usr/local/bin"
  75                 }
  76         }
  77
  78         s := SyncThing{
  79                 BaseURL: url,
  80                 APIKey:  apiKey,
  81                 Home:    home,
  82                 binDir:  binDir,
  83                 logsDir: conf.FileConf.LogsDir,
  84                 log:     log,
  85         }
  86
  87         return &s
  88 }
  89
  90 // Start Starts syncthing process
  91 func (s *SyncThing) startProc(exeName string, args []string, env []string, eChan *chan ExitChan) (*exec.Cmd, error) {
  92
  93         // Kill existing process (useful for debug ;-) )
  94         if os.Getenv("DEBUG_MODE") != "" {
  95                 exec.Command("bash", "-c", "pkill -9 "+exeName).Output()
  96         }
  97
  98         path, err := exec.LookPath(path.Join(s.binDir, exeName))
  99         if err != nil {
 100                 return nil, fmt.Errorf("Cannot find %s executable in %s", exeName, s.binDir)
 101         }
 102         cmd := exec.Command(path, args...)
 103         cmd.Env = os.Environ()
 104         for _, ev := range env {
 105                 cmd.Env = append(cmd.Env, ev)
 106         }
 107
 108         // open log file
 109         var outfile *os.File
 110         logFilename := filepath.Join(s.logsDir, exeName+".log")
 111         if s.logsDir != "" {
 112                 outfile, err := os.Create(logFilename)
 113                 if err != nil {
 114                         return nil, fmt.Errorf("Cannot create log file %s", logFilename)
 115                 }
 116
 117                 cmdOut, err := cmd.StdoutPipe()
 118                 if err != nil {
 119                         return nil, fmt.Errorf("Pipe stdout error for : %s", err)
 120                 }
 121
 122                 go io.Copy(outfile, cmdOut)
 123         }
 124
 125         err = cmd.Start()
 126         if err != nil {
 127                 return nil, err
 128         }
 129
 130         *eChan = make(chan ExitChan, 1)
 131         go func(c *exec.Cmd, oF *os.File) {
 132                 status := 0
 133                 sts, err := c.Process.Wait()
 134                 if !sts.Success() {
 135                         s := sts.Sys().(syscall.WaitStatus)
 136                         status = s.ExitStatus()
 137                 }
 138                 if oF != nil {
 139                         oF.Close()
 140                 }
 141                 s.log.Debugf("%s exited with status %d, err %v", exeName, status, err)
 142
 143                 *eChan <- ExitChan{status, err}
 144         }(cmd, outfile)
 145
 146         return cmd, nil
 147 }
 148
 149 // Start Starts syncthing process
 150 func (s *SyncThing) Start() (*exec.Cmd, error) {
 151         var err error
 152
 153         s.log.Infof(" ST home=%s", s.Home)
 154         s.log.Infof(" ST  url=%s", s.BaseURL)
 155
 156         args := []string{
 157                 "--home=" + s.Home,
 158                 "-no-browser",
 159                 "--gui-address=" + s.BaseURL,
 160         }
 161
 162         if s.APIKey != "" {
 163                 args = append(args, "-gui-apikey=\""+s.APIKey+"\"")
 164                 s.log.Infof(" ST apikey=%s", s.APIKey)
 165         }
 166         if s.log.Level == logrus.DebugLevel {
 167                 args = append(args, "-verbose")
 168         }
 169
 170         env := []string{
 171                 "STNODEFAULTFOLDER=1",
 172                 "STNOUPGRADE=1",
 173         }
 174
 175         // XXX - temporary hack because -gui-apikey seems to correctly handle by
 176         // syncthing the early first time
 177         stConfigFile := filepath.Join(s.Home, "config.xml")
 178         if s.APIKey != "" && !common.Exists(stConfigFile) {
 179                 s.log.Infof("Stop and restart Syncthing (hack for apikey setting)")
 180                 s.STCmd, err = s.startProc("syncthing", args, env, &s.exitSTChan)
 181                 tmo := 20
 182                 for ; tmo > 0; tmo-- {
 183                         s.log.Debugf("Waiting Syncthing config.xml creation (%v)\n", tmo)
 184                         time.Sleep(500 * time.Millisecond)
 185                         if common.Exists(stConfigFile) {
 186                                 break
 187                         }
 188                 }
 189                 if tmo <= 0 {
 190                         return nil, fmt.Errorf("Cannot start Syncthing for config file creation")
 191                 }
 192                 s.Stop()
 193                 read, err := ioutil.ReadFile(stConfigFile)
 194                 if err != nil {
 195                         return nil, fmt.Errorf("Cannot read Syncthing config file for apikey setting")
 196                 }
 197                 re := regexp.MustCompile(`<apikey>.*</apikey>`)
 198                 newContents := re.ReplaceAllString(string(read), "<apikey>"+s.APIKey+"</apikey>")
 199                 err = ioutil.WriteFile(stConfigFile, []byte(newContents), 0)
 200                 if err != nil {
 201                         return nil, fmt.Errorf("Cannot write Syncthing config file to set apikey")
 202                 }
 203         }
 204
 205         s.STCmd, err = s.startProc("syncthing", args, env, &s.exitSTChan)
 206
 207         // Use autogenerated apikey if not set by config.json
 208         if s.APIKey == "" {
 209                 if fd, err := os.Open(stConfigFile); err == nil {
 210                         defer fd.Close()
 211                         if b, err := ioutil.ReadAll(fd); err == nil {
 212                                 re := regexp.MustCompile("<apikey>(.*)</apikey>")
 213                                 key := re.FindStringSubmatch(string(b))
 214                                 if len(key) >= 1 {
 215                                         s.APIKey = key[1]
 216                                 }
 217                         }
 218                 }
 219         }
 220
 221         return s.STCmd, err
 222 }
 223
 224 // StartInotify Starts syncthing-inotify process
 225 func (s *SyncThing) StartInotify() (*exec.Cmd, error) {
 226         var err error
 227         exeName := "syncthing-inotify"
 228
 229         s.log.Infof(" STI  url=%s", s.BaseURL)
 230
 231         args := []string{
 232                 "-target=" + s.BaseURL,
 233         }
 234         if s.APIKey != "" {
 235                 args = append(args, "-api="+s.APIKey)
 236                 s.log.Infof("%s uses apikey=%s", exeName, s.APIKey)
 237         }
 238         if s.log.Level == logrus.DebugLevel {
 239                 args = append(args, "-verbosity=4")
 240         }
 241
 242         env := []string{}
 243
 244         s.STICmd, err = s.startProc(exeName, args, env, &s.exitSTIChan)
 245
 246         return s.STICmd, err
 247 }
 248
 249 func (s *SyncThing) stopProc(pname string, proc *os.Process, exit chan ExitChan) {
 250         if err := proc.Signal(os.Interrupt); err != nil {
 251                 s.log.Infof("Proc interrupt %s error: %s", pname, err.Error())
 252
 253                 select {
 254                 case <-exit:
 255                 case <-time.After(time.Second):
 256                         // A bigger bonk on the head.
 257                         if err := proc.Signal(os.Kill); err != nil {
 258                                 s.log.Infof("Proc term %s error: %s", pname, err.Error())
 259                         }
 260                         <-exit
 261                 }
 262         }
 263         s.log.Infof("%s stopped (PID %d)", pname, proc.Pid)
 264 }
 265
 266 // Stop Stops syncthing process
 267 func (s *SyncThing) Stop() {
 268         if s.STCmd == nil {
 269                 return
 270         }
 271         s.stopProc("syncthing", s.STCmd.Process, s.exitSTChan)
 272         s.STCmd = nil
 273 }
 274
 275 // StopInotify Stops syncthing process
 276 func (s *SyncThing) StopInotify() {
 277         if s.STICmd == nil {
 278                 return
 279         }
 280         s.stopProc("syncthing-inotify", s.STICmd.Process, s.exitSTIChan)
 281         s.STICmd = nil
 282 }
 283
 284 // Connect Establish HTTP connection with Syncthing
 285 func (s *SyncThing) Connect() error {
 286         var err error
 287         s.client, err = common.HTTPNewClient(s.BaseURL,
 288                 common.HTTPClientConfig{
 289                         URLPrefix:           "/rest",
 290                         HeaderClientKeyName: "X-Syncthing-ID",
 291                 })
 292         if err != nil {
 293                 msg := ": " + err.Error()
 294                 if strings.Contains(err.Error(), "connection refused") {
 295                         msg = fmt.Sprintf("(url: %s)", s.BaseURL)
 296                 }
 297                 return fmt.Errorf("ERROR: cannot connect to Syncthing %s", msg)
 298         }
 299         if s.client == nil {
 300                 return fmt.Errorf("ERROR: cannot connect to Syncthing (null client)")
 301         }
 302
 303         s.client.SetLogger(s.log)
 304
 305         return nil
 306 }
 307
 308 // IDGet returns the Syncthing ID of Syncthing instance running locally
 309 func (s *SyncThing) IDGet() (string, error) {
 310         var data []byte
 311         if err := s.client.HTTPGet("system/status", &data); err != nil {
 312                 return "", err
 313         }
 314         status := make(map[string]interface{})
 315         json.Unmarshal(data, &status)
 316         return status["myID"].(string), nil
 317 }
 318
 319 // ConfigGet returns the current Syncthing configuration
 320 func (s *SyncThing) ConfigGet() (config.Configuration, error) {
 321         var data []byte
 322         config := config.Configuration{}
 323         if err := s.client.HTTPGet("system/config", &data); err != nil {
 324                 return config, err
 325         }
 326         err := json.Unmarshal(data, &config)
 327         return config, err
 328 }
 329
 330 // ConfigSet set Syncthing configuration
 331 func (s *SyncThing) ConfigSet(cfg config.Configuration) error {
 332         body, err := json.Marshal(cfg)
 333         if err != nil {
 334                 return err
 335         }
 336         return s.client.HTTPPost("system/config", string(body))
 337 }