unionFile.go 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275
  1. package afero
  2. import (
  3. "io"
  4. "os"
  5. "path/filepath"
  6. "syscall"
  7. )
  8. // The UnionFile implements the afero.File interface and will be returned
  9. // when reading a directory present at least in the overlay or opening a file
  10. // for writing.
  11. //
  12. // The calls to
  13. // Readdir() and Readdirnames() merge the file os.FileInfo / names from the
  14. // base and the overlay - for files present in both layers, only those
  15. // from the overlay will be used.
  16. //
  17. // When opening files for writing (Create() / OpenFile() with the right flags)
  18. // the operations will be done in both layers, starting with the overlay. A
  19. // successful read in the overlay will move the cursor position in the base layer
  20. // by the number of bytes read.
  21. type UnionFile struct {
  22. base File
  23. layer File
  24. off int
  25. files []os.FileInfo
  26. }
  27. func (f *UnionFile) Close() error {
  28. // first close base, so we have a newer timestamp in the overlay. If we'd close
  29. // the overlay first, we'd get a cacheStale the next time we access this file
  30. // -> cache would be useless ;-)
  31. if f.base != nil {
  32. f.base.Close()
  33. }
  34. if f.layer != nil {
  35. return f.layer.Close()
  36. }
  37. return BADFD
  38. }
  39. func (f *UnionFile) Read(s []byte) (int, error) {
  40. if f.layer != nil {
  41. n, err := f.layer.Read(s)
  42. if (err == nil || err == io.EOF) && f.base != nil {
  43. // advance the file position also in the base file, the next
  44. // call may be a write at this position (or a seek with SEEK_CUR)
  45. if _, seekErr := f.base.Seek(int64(n), os.SEEK_CUR); seekErr != nil {
  46. // only overwrite err in case the seek fails: we need to
  47. // report an eventual io.EOF to the caller
  48. err = seekErr
  49. }
  50. }
  51. return n, err
  52. }
  53. if f.base != nil {
  54. return f.base.Read(s)
  55. }
  56. return 0, BADFD
  57. }
  58. func (f *UnionFile) ReadAt(s []byte, o int64) (int, error) {
  59. if f.layer != nil {
  60. n, err := f.layer.ReadAt(s, o)
  61. if (err == nil || err == io.EOF) && f.base != nil {
  62. _, err = f.base.Seek(o+int64(n), os.SEEK_SET)
  63. }
  64. return n, err
  65. }
  66. if f.base != nil {
  67. return f.base.ReadAt(s, o)
  68. }
  69. return 0, BADFD
  70. }
  71. func (f *UnionFile) Seek(o int64, w int) (pos int64, err error) {
  72. if f.layer != nil {
  73. pos, err = f.layer.Seek(o, w)
  74. if (err == nil || err == io.EOF) && f.base != nil {
  75. _, err = f.base.Seek(o, w)
  76. }
  77. return pos, err
  78. }
  79. if f.base != nil {
  80. return f.base.Seek(o, w)
  81. }
  82. return 0, BADFD
  83. }
  84. func (f *UnionFile) Write(s []byte) (n int, err error) {
  85. if f.layer != nil {
  86. n, err = f.layer.Write(s)
  87. if err == nil && f.base != nil { // hmm, do we have fixed size files where a write may hit the EOF mark?
  88. _, err = f.base.Write(s)
  89. }
  90. return n, err
  91. }
  92. if f.base != nil {
  93. return f.base.Write(s)
  94. }
  95. return 0, BADFD
  96. }
  97. func (f *UnionFile) WriteAt(s []byte, o int64) (n int, err error) {
  98. if f.layer != nil {
  99. n, err = f.layer.WriteAt(s, o)
  100. if err == nil && f.base != nil {
  101. _, err = f.base.WriteAt(s, o)
  102. }
  103. return n, err
  104. }
  105. if f.base != nil {
  106. return f.base.WriteAt(s, o)
  107. }
  108. return 0, BADFD
  109. }
  110. func (f *UnionFile) Name() string {
  111. if f.layer != nil {
  112. return f.layer.Name()
  113. }
  114. return f.base.Name()
  115. }
  116. // Readdir will weave the two directories together and
  117. // return a single view of the overlayed directories
  118. func (f *UnionFile) Readdir(c int) (ofi []os.FileInfo, err error) {
  119. if f.off == 0 {
  120. var files = make(map[string]os.FileInfo)
  121. var rfi []os.FileInfo
  122. if f.layer != nil {
  123. rfi, err = f.layer.Readdir(-1)
  124. if err != nil {
  125. return nil, err
  126. }
  127. for _, fi := range rfi {
  128. files[fi.Name()] = fi
  129. }
  130. }
  131. if f.base != nil {
  132. rfi, err = f.base.Readdir(-1)
  133. if err != nil {
  134. return nil, err
  135. }
  136. for _, fi := range rfi {
  137. if _, exists := files[fi.Name()]; !exists {
  138. files[fi.Name()] = fi
  139. }
  140. }
  141. }
  142. for _, fi := range files {
  143. f.files = append(f.files, fi)
  144. }
  145. }
  146. if c == -1 {
  147. return f.files[f.off:], nil
  148. }
  149. defer func() { f.off += c }()
  150. return f.files[f.off:c], nil
  151. }
  152. func (f *UnionFile) Readdirnames(c int) ([]string, error) {
  153. rfi, err := f.Readdir(c)
  154. if err != nil {
  155. return nil, err
  156. }
  157. var names []string
  158. for _, fi := range rfi {
  159. names = append(names, fi.Name())
  160. }
  161. return names, nil
  162. }
  163. func (f *UnionFile) Stat() (os.FileInfo, error) {
  164. if f.layer != nil {
  165. return f.layer.Stat()
  166. }
  167. if f.base != nil {
  168. return f.base.Stat()
  169. }
  170. return nil, BADFD
  171. }
  172. func (f *UnionFile) Sync() (err error) {
  173. if f.layer != nil {
  174. err = f.layer.Sync()
  175. if err == nil && f.base != nil {
  176. err = f.base.Sync()
  177. }
  178. return err
  179. }
  180. if f.base != nil {
  181. return f.base.Sync()
  182. }
  183. return BADFD
  184. }
  185. func (f *UnionFile) Truncate(s int64) (err error) {
  186. if f.layer != nil {
  187. err = f.layer.Truncate(s)
  188. if err == nil && f.base != nil {
  189. err = f.base.Truncate(s)
  190. }
  191. return err
  192. }
  193. if f.base != nil {
  194. return f.base.Truncate(s)
  195. }
  196. return BADFD
  197. }
  198. func (f *UnionFile) WriteString(s string) (n int, err error) {
  199. if f.layer != nil {
  200. n, err = f.layer.WriteString(s)
  201. if err == nil && f.base != nil {
  202. _, err = f.base.WriteString(s)
  203. }
  204. return n, err
  205. }
  206. if f.base != nil {
  207. return f.base.WriteString(s)
  208. }
  209. return 0, BADFD
  210. }
  211. func copyToLayer(base Fs, layer Fs, name string) error {
  212. bfh, err := base.Open(name)
  213. if err != nil {
  214. return err
  215. }
  216. defer bfh.Close()
  217. // First make sure the directory exists
  218. exists, err := Exists(layer, filepath.Dir(name))
  219. if err != nil {
  220. return err
  221. }
  222. if !exists {
  223. err = layer.MkdirAll(filepath.Dir(name), 0777) // FIXME?
  224. if err != nil {
  225. return err
  226. }
  227. }
  228. // Create the file on the overlay
  229. lfh, err := layer.Create(name)
  230. if err != nil {
  231. return err
  232. }
  233. n, err := io.Copy(lfh, bfh)
  234. if err != nil {
  235. // If anything fails, clean up the file
  236. layer.Remove(name)
  237. lfh.Close()
  238. return err
  239. }
  240. bfi, err := bfh.Stat()
  241. if err != nil || bfi.Size() != n {
  242. layer.Remove(name)
  243. lfh.Close()
  244. return syscall.EIO
  245. }
  246. err = lfh.Close()
  247. if err != nil {
  248. layer.Remove(name)
  249. lfh.Close()
  250. return err
  251. }
  252. return layer.Chtimes(name, bfi.ModTime(), bfi.ModTime())
  253. }