1
0

puller.go 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850
  1. // Copyright (C) 2014 The Syncthing Authors.
  2. //
  3. // This program is free software: you can redistribute it and/or modify it
  4. // under the terms of the GNU General Public License as published by the Free
  5. // Software Foundation, either version 3 of the License, or (at your option)
  6. // any later version.
  7. //
  8. // This program is distributed in the hope that it will be useful, but WITHOUT
  9. // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10. // FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  11. // more details.
  12. //
  13. // You should have received a copy of the GNU General Public License along
  14. // with this program. If not, see <http://www.gnu.org/licenses/>.
  15. package model
  16. import (
  17. "bytes"
  18. "crypto/sha256"
  19. "errors"
  20. "fmt"
  21. "io/ioutil"
  22. "os"
  23. "path/filepath"
  24. "sync"
  25. "time"
  26. "github.com/syncthing/syncthing/internal/config"
  27. "github.com/syncthing/syncthing/internal/events"
  28. "github.com/syncthing/syncthing/internal/osutil"
  29. "github.com/syncthing/syncthing/internal/protocol"
  30. "github.com/syncthing/syncthing/internal/scanner"
  31. "github.com/syncthing/syncthing/internal/symlinks"
  32. "github.com/syncthing/syncthing/internal/versioner"
  33. )
  34. // TODO: Stop on errors
  35. const (
  36. pauseIntv = 60 * time.Second
  37. nextPullIntv = 10 * time.Second
  38. checkPullIntv = 1 * time.Second
  39. )
  40. // A pullBlockState is passed to the puller routine for each block that needs
  41. // to be fetched.
  42. type pullBlockState struct {
  43. *sharedPullerState
  44. block protocol.BlockInfo
  45. }
  46. // A copyBlocksState is passed to copy routine if the file has blocks to be
  47. // copied.
  48. type copyBlocksState struct {
  49. *sharedPullerState
  50. blocks []protocol.BlockInfo
  51. }
  52. var (
  53. activity = newDeviceActivity()
  54. errNoDevice = errors.New("no available source device")
  55. )
  56. type Puller struct {
  57. folder string
  58. dir string
  59. scanIntv time.Duration
  60. model *Model
  61. stop chan struct{}
  62. versioner versioner.Versioner
  63. ignorePerms bool
  64. lenientMtimes bool
  65. progressEmitter *ProgressEmitter
  66. copiers int
  67. pullers int
  68. finishers int
  69. }
  70. // Serve will run scans and pulls. It will return when Stop()ed or on a
  71. // critical error.
  72. func (p *Puller) Serve() {
  73. if debug {
  74. l.Debugln(p, "starting")
  75. defer l.Debugln(p, "exiting")
  76. }
  77. p.stop = make(chan struct{})
  78. pullTimer := time.NewTimer(checkPullIntv)
  79. scanTimer := time.NewTimer(time.Millisecond) // The first scan should be done immediately.
  80. cleanTimer := time.NewTicker(time.Hour)
  81. defer func() {
  82. pullTimer.Stop()
  83. scanTimer.Stop()
  84. cleanTimer.Stop()
  85. // TODO: Should there be an actual FolderStopped state?
  86. p.model.setState(p.folder, FolderIdle)
  87. }()
  88. var prevVer uint64
  89. // Clean out old temporaries before we start pulling
  90. p.clean()
  91. // We don't start pulling files until a scan has been completed.
  92. initialScanCompleted := false
  93. loop:
  94. for {
  95. select {
  96. case <-p.stop:
  97. return
  98. // TODO: We could easily add a channel here for notifications from
  99. // Index(), so that we immediately start a pull when new index
  100. // information is available. Before that though, I'd like to build a
  101. // repeatable benchmark of how long it takes to sync a change from
  102. // device A to device B, so we have something to work against.
  103. case <-pullTimer.C:
  104. if !initialScanCompleted {
  105. // How did we even get here?
  106. if debug {
  107. l.Debugln(p, "skip (initial)")
  108. }
  109. pullTimer.Reset(nextPullIntv)
  110. continue
  111. }
  112. // RemoteLocalVersion() is a fast call, doesn't touch the database.
  113. curVer := p.model.RemoteLocalVersion(p.folder)
  114. if curVer == prevVer {
  115. if debug {
  116. l.Debugln(p, "skip (curVer == prevVer)", prevVer)
  117. }
  118. pullTimer.Reset(checkPullIntv)
  119. continue
  120. }
  121. if debug {
  122. l.Debugln(p, "pulling", prevVer, curVer)
  123. }
  124. p.model.setState(p.folder, FolderSyncing)
  125. tries := 0
  126. checksum := false
  127. for {
  128. tries++
  129. // Last resort mode, to get around corrupt/invalid block maps.
  130. if tries == 10 {
  131. l.Infoln("Desperation mode ON")
  132. checksum = true
  133. }
  134. changed := p.pullerIteration(checksum)
  135. if debug {
  136. l.Debugln(p, "changed", changed)
  137. }
  138. if changed == 0 {
  139. // No files were changed by the puller, so we are in
  140. // sync. Remember the local version number and
  141. // schedule a resync a little bit into the future.
  142. if lv := p.model.RemoteLocalVersion(p.folder); lv < curVer {
  143. // There's a corner case where the device we needed
  144. // files from disconnected during the puller
  145. // iteration. The files will have been removed from
  146. // the index, so we've concluded that we don't need
  147. // them, but at the same time we have the local
  148. // version that includes those files in curVer. So we
  149. // catch the case that localVersion might have
  150. // decresed here.
  151. l.Debugln(p, "adjusting curVer", lv)
  152. curVer = lv
  153. }
  154. prevVer = curVer
  155. if debug {
  156. l.Debugln(p, "next pull in", nextPullIntv)
  157. }
  158. pullTimer.Reset(nextPullIntv)
  159. break
  160. }
  161. if tries > 10 {
  162. // We've tried a bunch of times to get in sync, but
  163. // we're not making it. Probably there are write
  164. // errors preventing us. Flag this with a warning and
  165. // wait a bit longer before retrying.
  166. l.Warnf("Folder %q isn't making progress - check logs for possible root cause. Pausing puller for %v.", p.folder, pauseIntv)
  167. if debug {
  168. l.Debugln(p, "next pull in", pauseIntv)
  169. }
  170. pullTimer.Reset(pauseIntv)
  171. break
  172. }
  173. }
  174. p.model.setState(p.folder, FolderIdle)
  175. // The reason for running the scanner from within the puller is that
  176. // this is the easiest way to make sure we are not doing both at the
  177. // same time.
  178. case <-scanTimer.C:
  179. if debug {
  180. l.Debugln(p, "rescan")
  181. }
  182. p.model.setState(p.folder, FolderScanning)
  183. if err := p.model.ScanFolder(p.folder); err != nil {
  184. p.model.cfg.InvalidateFolder(p.folder, err.Error())
  185. break loop
  186. }
  187. p.model.setState(p.folder, FolderIdle)
  188. if p.scanIntv > 0 {
  189. if debug {
  190. l.Debugln(p, "next rescan in", p.scanIntv)
  191. }
  192. scanTimer.Reset(p.scanIntv)
  193. }
  194. if !initialScanCompleted {
  195. l.Infoln("Completed initial scan (rw) of folder", p.folder)
  196. initialScanCompleted = true
  197. }
  198. // Clean out old temporaries
  199. case <-cleanTimer.C:
  200. p.clean()
  201. }
  202. }
  203. }
  204. func (p *Puller) Stop() {
  205. close(p.stop)
  206. }
  207. func (p *Puller) String() string {
  208. return fmt.Sprintf("puller/%s@%p", p.folder, p)
  209. }
  210. // pullerIteration runs a single puller iteration for the given folder and
  211. // returns the number items that should have been synced (even those that
  212. // might have failed). One puller iteration handles all files currently
  213. // flagged as needed in the folder.
  214. func (p *Puller) pullerIteration(checksum bool) int {
  215. pullChan := make(chan pullBlockState)
  216. copyChan := make(chan copyBlocksState)
  217. finisherChan := make(chan *sharedPullerState)
  218. var copyWg sync.WaitGroup
  219. var pullWg sync.WaitGroup
  220. var doneWg sync.WaitGroup
  221. if debug {
  222. l.Debugln(p, "c", p.copiers, "p", p.pullers, "f", p.finishers)
  223. }
  224. for i := 0; i < p.copiers; i++ {
  225. copyWg.Add(1)
  226. go func() {
  227. // copierRoutine finishes when copyChan is closed
  228. p.copierRoutine(copyChan, pullChan, finisherChan, checksum)
  229. copyWg.Done()
  230. }()
  231. }
  232. for i := 0; i < p.pullers; i++ {
  233. pullWg.Add(1)
  234. go func() {
  235. // pullerRoutine finishes when pullChan is closed
  236. p.pullerRoutine(pullChan, finisherChan)
  237. pullWg.Done()
  238. }()
  239. }
  240. for i := 0; i < p.finishers; i++ {
  241. doneWg.Add(1)
  242. // finisherRoutine finishes when finisherChan is closed
  243. go func() {
  244. p.finisherRoutine(finisherChan)
  245. doneWg.Done()
  246. }()
  247. }
  248. p.model.fmut.RLock()
  249. files := p.model.folderFiles[p.folder]
  250. p.model.fmut.RUnlock()
  251. // !!!
  252. // WithNeed takes a database snapshot (by necessity). By the time we've
  253. // handled a bunch of files it might have become out of date and we might
  254. // be attempting to sync with an old version of a file...
  255. // !!!
  256. changed := 0
  257. var deletions []protocol.FileInfo
  258. files.WithNeed(protocol.LocalDeviceID, func(intf protocol.FileIntf) bool {
  259. // Needed items are delivered sorted lexicographically. This isn't
  260. // really optimal from a performance point of view - it would be
  261. // better if files were handled in random order, to spread the load
  262. // over the cluster. But it means that we can be sure that we fully
  263. // handle directories before the files that go inside them, which is
  264. // nice.
  265. file := intf.(protocol.FileInfo)
  266. events.Default.Log(events.ItemStarted, map[string]string{
  267. "folder": p.folder,
  268. "item": file.Name,
  269. })
  270. if debug {
  271. l.Debugln(p, "handling", file.Name)
  272. }
  273. switch {
  274. case file.IsDeleted():
  275. // A deleted file, directory or symlink
  276. deletions = append(deletions, file)
  277. case file.IsDirectory() && !file.IsSymlink():
  278. // A new or changed directory
  279. p.handleDir(file)
  280. default:
  281. // A new or changed file or symlink. This is the only case where we
  282. // do stuff in the background; the other three are done
  283. // synchronously.
  284. p.handleFile(file, copyChan, finisherChan)
  285. }
  286. changed++
  287. return true
  288. })
  289. // Signal copy and puller routines that we are done with the in data for
  290. // this iteration. Wait for them to finish.
  291. close(copyChan)
  292. copyWg.Wait()
  293. close(pullChan)
  294. pullWg.Wait()
  295. // Signal the finisher chan that there will be no more input.
  296. close(finisherChan)
  297. // Wait for the finisherChan to finish.
  298. doneWg.Wait()
  299. for i := range deletions {
  300. deletion := deletions[len(deletions)-i-1]
  301. if deletion.IsDirectory() {
  302. p.deleteDir(deletion)
  303. } else {
  304. p.deleteFile(deletion)
  305. }
  306. }
  307. return changed
  308. }
  309. // handleDir creates or updates the given directory
  310. func (p *Puller) handleDir(file protocol.FileInfo) {
  311. realName := filepath.Join(p.dir, file.Name)
  312. mode := os.FileMode(file.Flags & 0777)
  313. if p.ignorePerms {
  314. mode = 0755
  315. }
  316. if debug {
  317. curFile := p.model.CurrentFolderFile(p.folder, file.Name)
  318. l.Debugf("need dir\n\t%v\n\t%v", file, curFile)
  319. }
  320. info, err := os.Lstat(realName)
  321. switch {
  322. // There is already something under that name, but it's a file/link.
  323. // Most likely a file/link is getting replaced with a directory.
  324. // Remove the file/link and fall through to directory creation.
  325. case err == nil && (!info.IsDir() || info.Mode()&os.ModeSymlink != 0):
  326. err = osutil.InWritableDir(os.Remove, realName)
  327. if err != nil {
  328. l.Infof("Puller (folder %q, dir %q): %v", p.folder, file.Name, err)
  329. return
  330. }
  331. fallthrough
  332. // The directory doesn't exist, so we create it with the right
  333. // mode bits from the start.
  334. case err != nil && os.IsNotExist(err):
  335. // We declare a function that acts on only the path name, so
  336. // we can pass it to InWritableDir. We use a regular Mkdir and
  337. // not MkdirAll because the parent should already exist.
  338. mkdir := func(path string) error {
  339. return os.Mkdir(path, mode)
  340. }
  341. if err = osutil.InWritableDir(mkdir, realName); err == nil {
  342. p.model.updateLocal(p.folder, file)
  343. } else {
  344. l.Infof("Puller (folder %q, dir %q): %v", p.folder, file.Name, err)
  345. }
  346. return
  347. // Weird error when stat()'ing the dir. Probably won't work to do
  348. // anything else with it if we can't even stat() it.
  349. case err != nil:
  350. l.Infof("Puller (folder %q, dir %q): %v", p.folder, file.Name, err)
  351. return
  352. }
  353. // The directory already exists, so we just correct the mode bits. (We
  354. // don't handle modification times on directories, because that sucks...)
  355. // It's OK to change mode bits on stuff within non-writable directories.
  356. if p.ignorePerms {
  357. p.model.updateLocal(p.folder, file)
  358. } else if err := os.Chmod(realName, mode); err == nil {
  359. p.model.updateLocal(p.folder, file)
  360. } else {
  361. l.Infof("Puller (folder %q, dir %q): %v", p.folder, file.Name, err)
  362. }
  363. }
  364. // deleteDir attempts to delete the given directory
  365. func (p *Puller) deleteDir(file protocol.FileInfo) {
  366. realName := filepath.Join(p.dir, file.Name)
  367. // Delete any temporary files lying around in the directory
  368. dir, _ := os.Open(realName)
  369. if dir != nil {
  370. files, _ := dir.Readdirnames(-1)
  371. for _, file := range files {
  372. if defTempNamer.IsTemporary(file) {
  373. osutil.InWritableDir(os.Remove, filepath.Join(realName, file))
  374. }
  375. }
  376. }
  377. err := osutil.InWritableDir(os.Remove, realName)
  378. if err == nil || os.IsNotExist(err) {
  379. p.model.updateLocal(p.folder, file)
  380. } else {
  381. l.Infof("Puller (folder %q, dir %q): delete: %v", p.folder, file.Name, err)
  382. }
  383. }
  384. // deleteFile attempts to delete the given file
  385. func (p *Puller) deleteFile(file protocol.FileInfo) {
  386. realName := filepath.Join(p.dir, file.Name)
  387. var err error
  388. if p.versioner != nil {
  389. err = osutil.InWritableDir(p.versioner.Archive, realName)
  390. } else {
  391. err = osutil.InWritableDir(os.Remove, realName)
  392. }
  393. if err != nil && !os.IsNotExist(err) {
  394. l.Infof("Puller (folder %q, file %q): delete: %v", p.folder, file.Name, err)
  395. } else {
  396. p.model.updateLocal(p.folder, file)
  397. }
  398. }
  399. // handleFile queues the copies and pulls as necessary for a single new or
  400. // changed file.
  401. func (p *Puller) handleFile(file protocol.FileInfo, copyChan chan<- copyBlocksState, finisherChan chan<- *sharedPullerState) {
  402. curFile := p.model.CurrentFolderFile(p.folder, file.Name)
  403. if len(curFile.Blocks) == len(file.Blocks) && scanner.BlocksEqual(curFile.Blocks, file.Blocks) {
  404. // We are supposed to copy the entire file, and then fetch nothing. We
  405. // are only updating metadata, so we don't actually *need* to make the
  406. // copy.
  407. if debug {
  408. l.Debugln(p, "taking shortcut on", file.Name)
  409. }
  410. if file.IsSymlink() {
  411. p.shortcutSymlink(curFile, file)
  412. } else {
  413. p.shortcutFile(file)
  414. }
  415. return
  416. }
  417. scanner.PopulateOffsets(file.Blocks)
  418. // Figure out the absolute filenames we need once and for all
  419. tempName := filepath.Join(p.dir, defTempNamer.TempName(file.Name))
  420. realName := filepath.Join(p.dir, file.Name)
  421. reused := 0
  422. var blocks []protocol.BlockInfo
  423. // Check for an old temporary file which might have some blocks we could
  424. // reuse.
  425. tempBlocks, err := scanner.HashFile(tempName, protocol.BlockSize)
  426. if err == nil {
  427. // Check for any reusable blocks in the temp file
  428. tempCopyBlocks, _ := scanner.BlockDiff(tempBlocks, file.Blocks)
  429. // block.String() returns a string unique to the block
  430. existingBlocks := make(map[string]bool, len(tempCopyBlocks))
  431. for _, block := range tempCopyBlocks {
  432. existingBlocks[block.String()] = true
  433. }
  434. // Since the blocks are already there, we don't need to get them.
  435. for _, block := range file.Blocks {
  436. _, ok := existingBlocks[block.String()]
  437. if !ok {
  438. blocks = append(blocks, block)
  439. }
  440. }
  441. // The sharedpullerstate will know which flags to use when opening the
  442. // temp file depending if we are reusing any blocks or not.
  443. reused = len(file.Blocks) - len(blocks)
  444. if reused == 0 {
  445. // Otherwise, discard the file ourselves in order for the
  446. // sharedpuller not to panic when it fails to exlusively create a
  447. // file which already exists
  448. os.Remove(tempName)
  449. }
  450. } else {
  451. blocks = file.Blocks
  452. }
  453. s := sharedPullerState{
  454. file: file,
  455. folder: p.folder,
  456. tempName: tempName,
  457. realName: realName,
  458. copyTotal: uint32(len(blocks)),
  459. copyNeeded: uint32(len(blocks)),
  460. reused: uint32(reused),
  461. }
  462. if debug {
  463. l.Debugf("%v need file %s; copy %d, reused %v", p, file.Name, len(blocks), reused)
  464. }
  465. cs := copyBlocksState{
  466. sharedPullerState: &s,
  467. blocks: blocks,
  468. }
  469. copyChan <- cs
  470. }
  471. // shortcutFile sets file mode and modification time, when that's the only
  472. // thing that has changed.
  473. func (p *Puller) shortcutFile(file protocol.FileInfo) {
  474. realName := filepath.Join(p.dir, file.Name)
  475. if !p.ignorePerms {
  476. err := os.Chmod(realName, os.FileMode(file.Flags&0777))
  477. if err != nil {
  478. l.Infof("Puller (folder %q, file %q): shortcut: %v", p.folder, file.Name, err)
  479. return
  480. }
  481. }
  482. t := time.Unix(file.Modified, 0)
  483. err := os.Chtimes(realName, t, t)
  484. if err != nil {
  485. if p.lenientMtimes {
  486. // We accept the failure with a warning here and allow the sync to
  487. // continue. We'll sync the new mtime back to the other devices later.
  488. // If they have the same problem & setting, we might never get in
  489. // sync.
  490. l.Infof("Puller (folder %q, file %q): shortcut: %v (continuing anyway as requested)", p.folder, file.Name, err)
  491. } else {
  492. l.Infof("Puller (folder %q, file %q): shortcut: %v", p.folder, file.Name, err)
  493. return
  494. }
  495. }
  496. p.model.updateLocal(p.folder, file)
  497. }
  498. // shortcutSymlink changes the symlinks type if necessery.
  499. func (p *Puller) shortcutSymlink(curFile, file protocol.FileInfo) {
  500. err := symlinks.ChangeType(filepath.Join(p.dir, file.Name), file.Flags)
  501. if err != nil {
  502. l.Infof("Puller (folder %q, file %q): symlink shortcut: %v", p.folder, file.Name, err)
  503. return
  504. }
  505. p.model.updateLocal(p.folder, file)
  506. }
  507. // copierRoutine reads copierStates until the in channel closes and performs
  508. // the relevant copies when possible, or passes it to the puller routine.
  509. func (p *Puller) copierRoutine(in <-chan copyBlocksState, pullChan chan<- pullBlockState, out chan<- *sharedPullerState, checksum bool) {
  510. buf := make([]byte, protocol.BlockSize)
  511. nextFile:
  512. for state := range in {
  513. dstFd, err := state.tempFile()
  514. if err != nil {
  515. // Nothing more to do for this failed file (the error was logged
  516. // when it happened)
  517. continue nextFile
  518. }
  519. if p.progressEmitter != nil {
  520. p.progressEmitter.Register(state.sharedPullerState)
  521. }
  522. folderRoots := make(map[string]string)
  523. p.model.fmut.RLock()
  524. for folder, cfg := range p.model.folderCfgs {
  525. folderRoots[folder] = cfg.Path
  526. }
  527. p.model.fmut.RUnlock()
  528. hasher := sha256.New()
  529. for _, block := range state.blocks {
  530. buf = buf[:int(block.Size)]
  531. found := p.model.finder.Iterate(block.Hash, func(folder, file string, index uint32) bool {
  532. path := filepath.Join(folderRoots[folder], file)
  533. fd, err := p.model.cache.Open(path)
  534. if err != nil {
  535. return false
  536. }
  537. defer fd.Close()
  538. _, err = fd.ReadAt(buf, protocol.BlockSize*int64(index))
  539. if err != nil {
  540. return false
  541. }
  542. // Only done on second to last puller attempt
  543. if checksum {
  544. hasher.Write(buf)
  545. hash := hasher.Sum(nil)
  546. hasher.Reset()
  547. if !bytes.Equal(hash, block.Hash) {
  548. if debug {
  549. l.Debugf("Finder block mismatch in %s:%s:%d expected %q got %q", folder, file, index, block.Hash, hash)
  550. }
  551. err = p.model.finder.Fix(folder, file, index, block.Hash, hash)
  552. if err != nil {
  553. l.Warnln("finder fix:", err)
  554. }
  555. return false
  556. }
  557. }
  558. _, err = dstFd.WriteAt(buf, block.Offset)
  559. if err != nil {
  560. state.earlyClose("dst write", err)
  561. }
  562. if file == state.file.Name {
  563. state.copiedFromOrigin()
  564. }
  565. return true
  566. })
  567. if state.failed() != nil {
  568. break
  569. }
  570. if !found {
  571. state.pullStarted()
  572. ps := pullBlockState{
  573. sharedPullerState: state.sharedPullerState,
  574. block: block,
  575. }
  576. pullChan <- ps
  577. } else {
  578. state.copyDone()
  579. }
  580. }
  581. out <- state.sharedPullerState
  582. }
  583. }
  584. func (p *Puller) pullerRoutine(in <-chan pullBlockState, out chan<- *sharedPullerState) {
  585. nextBlock:
  586. for state := range in {
  587. if state.failed() != nil {
  588. continue nextBlock
  589. }
  590. // Select the least busy device to pull the block from. If we found no
  591. // feasible device at all, fail the block (and in the long run, the
  592. // file).
  593. potentialDevices := p.model.availability(p.folder, state.file.Name)
  594. selected := activity.leastBusy(potentialDevices)
  595. if selected == (protocol.DeviceID{}) {
  596. state.earlyClose("pull", errNoDevice)
  597. continue nextBlock
  598. }
  599. // Get an fd to the temporary file. Tehcnically we don't need it until
  600. // after fetching the block, but if we run into an error here there is
  601. // no point in issuing the request to the network.
  602. fd, err := state.tempFile()
  603. if err != nil {
  604. continue nextBlock
  605. }
  606. // Fetch the block, while marking the selected device as in use so that
  607. // leastBusy can select another device when someone else asks.
  608. activity.using(selected)
  609. buf, err := p.model.requestGlobal(selected, p.folder, state.file.Name, state.block.Offset, int(state.block.Size), state.block.Hash)
  610. activity.done(selected)
  611. if err != nil {
  612. state.earlyClose("pull", err)
  613. continue nextBlock
  614. }
  615. // Save the block data we got from the cluster
  616. _, err = fd.WriteAt(buf, state.block.Offset)
  617. if err != nil {
  618. state.earlyClose("save", err)
  619. continue nextBlock
  620. }
  621. state.pullDone()
  622. out <- state.sharedPullerState
  623. }
  624. }
  625. func (p *Puller) performFinish(state *sharedPullerState) {
  626. // Verify the file against expected hashes
  627. fd, err := os.Open(state.tempName)
  628. if err != nil {
  629. l.Warnln("puller: final:", err)
  630. return
  631. }
  632. err = scanner.Verify(fd, protocol.BlockSize, state.file.Blocks)
  633. fd.Close()
  634. if err != nil {
  635. l.Infoln("puller:", state.file.Name, err, "(file changed during pull?)")
  636. return
  637. }
  638. // Set the correct permission bits on the new file
  639. if !p.ignorePerms {
  640. err = os.Chmod(state.tempName, os.FileMode(state.file.Flags&0777))
  641. if err != nil {
  642. l.Warnln("puller: final:", err)
  643. return
  644. }
  645. }
  646. // Set the correct timestamp on the new file
  647. t := time.Unix(state.file.Modified, 0)
  648. err = os.Chtimes(state.tempName, t, t)
  649. if err != nil {
  650. if p.lenientMtimes {
  651. // We accept the failure with a warning here and allow the sync to
  652. // continue. We'll sync the new mtime back to the other devices later.
  653. // If they have the same problem & setting, we might never get in
  654. // sync.
  655. l.Infof("Puller (folder %q, file %q): final: %v (continuing anyway as requested)", p.folder, state.file.Name, err)
  656. } else {
  657. l.Warnln("puller: final:", err)
  658. return
  659. }
  660. }
  661. // If we should use versioning, let the versioner archive the old
  662. // file before we replace it. Archiving a non-existent file is not
  663. // an error.
  664. if p.versioner != nil {
  665. err = p.versioner.Archive(state.realName)
  666. if err != nil {
  667. l.Warnln("puller: final:", err)
  668. return
  669. }
  670. }
  671. // If the target path is a symlink or a directory, we cannot copy
  672. // over it, hence remove it before proceeding.
  673. stat, err := os.Lstat(state.realName)
  674. if err == nil && (stat.IsDir() || stat.Mode()&os.ModeSymlink != 0) {
  675. osutil.InWritableDir(os.Remove, state.realName)
  676. }
  677. // Replace the original content with the new one
  678. err = osutil.Rename(state.tempName, state.realName)
  679. if err != nil {
  680. l.Warnln("puller: final:", err)
  681. return
  682. }
  683. // If it's a symlink, the target of the symlink is inside the file.
  684. if state.file.IsSymlink() {
  685. content, err := ioutil.ReadFile(state.realName)
  686. if err != nil {
  687. l.Warnln("puller: final: reading symlink:", err)
  688. return
  689. }
  690. // Remove the file, and replace it with a symlink.
  691. err = osutil.InWritableDir(func(path string) error {
  692. os.Remove(path)
  693. return symlinks.Create(path, string(content), state.file.Flags)
  694. }, state.realName)
  695. if err != nil {
  696. l.Warnln("puller: final: creating symlink:", err)
  697. return
  698. }
  699. }
  700. // Record the updated file in the index
  701. p.model.updateLocal(p.folder, state.file)
  702. }
  703. func (p *Puller) finisherRoutine(in <-chan *sharedPullerState) {
  704. for state := range in {
  705. if closed, err := state.finalClose(); closed {
  706. if debug {
  707. l.Debugln(p, "closing", state.file.Name)
  708. }
  709. if err != nil {
  710. l.Warnln("puller: final:", err)
  711. continue
  712. }
  713. p.performFinish(state)
  714. if p.progressEmitter != nil {
  715. p.progressEmitter.Deregister(state)
  716. }
  717. }
  718. }
  719. }
  720. // clean deletes orphaned temporary files
  721. func (p *Puller) clean() {
  722. keep := time.Duration(p.model.cfg.Options().KeepTemporariesH) * time.Hour
  723. now := time.Now()
  724. filepath.Walk(p.dir, func(path string, info os.FileInfo, err error) error {
  725. if err != nil {
  726. return err
  727. }
  728. if info.Mode().IsRegular() && defTempNamer.IsTemporary(path) && info.ModTime().Add(keep).Before(now) {
  729. os.Remove(path)
  730. }
  731. return nil
  732. })
  733. }
  734. func invalidateFolder(cfg *config.Configuration, folderID string, err error) {
  735. for i := range cfg.Folders {
  736. folder := &cfg.Folders[i]
  737. if folder.ID == folderID {
  738. folder.Invalid = err.Error()
  739. return
  740. }
  741. }
  742. }