basefs.go 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689
  1. package basefs
  2. import (
  3. "fmt"
  4. "io"
  5. "os"
  6. "strings"
  7. "sync"
  8. "syscall"
  9. "time"
  10. "dev.hexasoftware.com/hxs/cloudmount/internal/core"
  11. "dev.hexasoftware.com/hxs/prettylog"
  12. "golang.org/x/net/context"
  13. drive "google.golang.org/api/drive/v3"
  14. "google.golang.org/api/googleapi"
  15. "github.com/jacobsa/fuse"
  16. "github.com/jacobsa/fuse/fuseops"
  17. "github.com/jacobsa/fuse/fuseutil"
  18. )
  19. var (
  20. log = prettylog.New("commonfs")
  21. )
  22. // BaseFS struct
  23. type BaseFS struct {
  24. fuseutil.NotImplementedFileSystem // Defaults
  25. Config *core.Config //core *core.Core // Core Config instead?
  26. //serviceConfig *Config
  27. Client *drive.Service
  28. fileHandles map[fuseops.HandleID]*Handle
  29. fileEntries map[fuseops.InodeID]*FileEntry
  30. //nextRefresh time.Time
  31. handleMU *sync.Mutex
  32. inodeMU *sync.Mutex
  33. //fileMap map[string]
  34. // Map IDS with FileEntries
  35. }
  36. func New(core *core.Core) *BaseFS {
  37. fs := &BaseFS{
  38. Config: &core.Config,
  39. //serviceConfig: &Config{}, // This is on service Driver
  40. fileHandles: map[fuseops.HandleID]*Handle{},
  41. handleMU: &sync.Mutex{},
  42. }
  43. // Temporary entry
  44. entry := fs.fileEntry("Loading...", nil, 9999)
  45. entry.Attr.Mode = os.FileMode(0)
  46. return fs
  47. }
  48. // Async
  49. func (fs *BaseFS) Start() {
  50. go func() {
  51. //fs.Refresh() // First load
  52. // Change reader loop
  53. /*startPageTokenRes, err := fs.root.client.Changes.GetStartPageToken().Do()
  54. if err != nil {
  55. log.Println("GDrive err", err)
  56. }
  57. savedStartPageToken := startPageTokenRes.StartPageToken
  58. for {
  59. pageToken := savedStartPageToken
  60. for pageToken != "" {
  61. changesRes, err := fs.root.client.Changes.List(pageToken).Fields(googleapi.Field("newStartPageToken,nextPageToken,changes(removed,fileId,file(" + fileFields + "))")).Do()
  62. if err != nil {
  63. log.Println("Err fetching changes", err)
  64. break
  65. }
  66. //log.Println("Changes:", len(changesRes.Changes))
  67. for _, c := range changesRes.Changes {
  68. entry := fs.root.FindByGID(c.FileId)
  69. if c.Removed {
  70. if entry == nil {
  71. continue
  72. } else {
  73. fs.root.RemoveEntry(entry)
  74. }
  75. continue
  76. }
  77. if entry != nil {
  78. entry.SetGFile(c.File)
  79. } else {
  80. //Create new one
  81. fs.root.FileEntry(c.File) // Creating new one
  82. }
  83. }
  84. if changesRes.NewStartPageToken != "" {
  85. savedStartPageToken = changesRes.NewStartPageToken
  86. }
  87. pageToken = changesRes.NextPageToken
  88. }
  89. time.Sleep(fs.config.RefreshTime)
  90. }*/
  91. }()
  92. }
  93. ////////////////////////////////////////////////////////
  94. // TOOLS & HELPERS
  95. ////////////////////////////////////////////////////////
  96. // COMMON
  97. func (fs *BaseFS) createHandle() *Handle {
  98. // Lock here instead
  99. fs.handleMU.Lock()
  100. defer fs.handleMU.Unlock()
  101. var handleID fuseops.HandleID
  102. for handleID = 1; handleID < 99999; handleID++ {
  103. _, ok := fs.fileHandles[handleID]
  104. if !ok {
  105. break
  106. }
  107. }
  108. handle := &Handle{ID: handleID}
  109. fs.fileHandles[handleID] = handle
  110. return handle
  111. }
  112. const fileFields = googleapi.Field("id, name, size,mimeType, parents,createdTime,modifiedTime")
  113. const gdFields = googleapi.Field("files(" + fileFields + ")")
  114. // FULL Refresh service files
  115. ///////////////////////////////
  116. // Fuse operations
  117. ////////////
  118. // OpenDir return nil error allows open dir
  119. // COMMON for drivers
  120. func (fs *BaseFS) OpenDir(ctx context.Context, op *fuseops.OpenDirOp) (err error) {
  121. entry := fs.findByInode(op.Inode)
  122. if entry == nil {
  123. return fuse.ENOENT
  124. }
  125. handle := fs.createHandle()
  126. handle.entry = entry
  127. op.Handle = handle.ID
  128. return // No error allow, dir open
  129. }
  130. // ReadDir lists files into readdirop
  131. // Common for drivers
  132. func (fs *BaseFS) ReadDir(ctx context.Context, op *fuseops.ReadDirOp) (err error) {
  133. fh, ok := fs.fileHandles[op.Handle]
  134. if !ok {
  135. log.Fatal("Handle does not exists")
  136. }
  137. if op.Offset == 0 { // Rebuild/rewind dir list
  138. fh.entries = []fuseutil.Dirent{}
  139. children := fs.listByParent(fh.entry)
  140. for i, v := range children {
  141. fusetype := fuseutil.DT_File
  142. if v.IsDir() {
  143. fusetype = fuseutil.DT_Directory
  144. }
  145. dirEnt := fuseutil.Dirent{
  146. Inode: v.Inode,
  147. Name: v.Name,
  148. Type: fusetype,
  149. Offset: fuseops.DirOffset(i) + 1,
  150. }
  151. // written += fuseutil.WriteDirent(fh.buf[written:], dirEnt)
  152. fh.entries = append(fh.entries, dirEnt)
  153. }
  154. }
  155. index := int(op.Offset)
  156. if index > len(fh.entries) {
  157. return fuse.EINVAL
  158. }
  159. if index > 0 {
  160. index++
  161. }
  162. for i := index; i < len(fh.entries); i++ {
  163. n := fuseutil.WriteDirent(op.Dst[op.BytesRead:], fh.entries[i])
  164. if n == 0 {
  165. break
  166. }
  167. op.BytesRead += n
  168. }
  169. return
  170. }
  171. // SPECIFIC code
  172. func (fs *BaseFS) SetInodeAttributes(ctx context.Context, op *fuseops.SetInodeAttributesOp) (err error) {
  173. // Hack to truncate file?
  174. if op.Size != nil {
  175. entry := fs.Root.FindByInode(op.Inode)
  176. if *op.Size != 0 { // We only allow truncate to 0
  177. return fuse.ENOSYS
  178. }
  179. err = entry.Truncate()
  180. }
  181. return
  182. }
  183. //GetInodeAttributes return attributes
  184. // COMMON
  185. func (fs *BaseFS) GetInodeAttributes(ctx context.Context, op *fuseops.GetInodeAttributesOp) (err error) {
  186. f := fs.findByInode(op.Inode)
  187. if f == nil {
  188. return fuse.ENOENT
  189. }
  190. op.Attributes = f.Attr
  191. op.AttributesExpiration = time.Now().Add(time.Minute)
  192. return
  193. }
  194. // ReleaseDirHandle deletes file handle entry
  195. // COMMON
  196. func (fs *BaseFS) ReleaseDirHandle(ctx context.Context, op *fuseops.ReleaseDirHandleOp) (err error) {
  197. delete(fs.fileHandles, op.Handle)
  198. return
  199. }
  200. // LookUpInode based on Parent and Name we return a self cached inode
  201. // Cloud be COMMON but has specific ID
  202. func (fs *BaseFS) LookUpInode(ctx context.Context, op *fuseops.LookUpInodeOp) (err error) {
  203. parentFile := fs.findByInode(op.Parent) // true means transverse all
  204. if parentFile == nil {
  205. return fuse.ENOENT
  206. }
  207. entry := fs.lookupByParent(parentFile, op.Name)
  208. if entry == nil {
  209. return fuse.ENOENT
  210. }
  211. // Transverse only local
  212. now := time.Now()
  213. op.Entry = fuseops.ChildInodeEntry{
  214. Attributes: entry.Attr,
  215. Child: entry.Inode,
  216. AttributesExpiration: now.Add(time.Second),
  217. EntryExpiration: now.Add(time.Second),
  218. }
  219. return
  220. }
  221. // ForgetInode allows to forgetInode
  222. // COMMON
  223. func (fs *BaseFS) ForgetInode(ctx context.Context, op *fuseops.ForgetInodeOp) (err error) {
  224. return
  225. }
  226. // GetXAttr special attributes
  227. // COMMON
  228. func (fs *BaseFS) GetXAttr(ctx context.Context, op *fuseops.GetXattrOp) (err error) {
  229. return
  230. }
  231. //////////////////////////////////////////////////////////////////////////
  232. // File OPS
  233. //////////////////////////////////////////////////////////////////////////
  234. // OpenFile creates a temporary handle to be handled on read or write
  235. // COMMON
  236. func (fs *BaseFS) OpenFile(ctx context.Context, op *fuseops.OpenFileOp) (err error) {
  237. f := fs.findByInode(op.Inode) // might not exists
  238. // Generate new handle
  239. handle := fs.createHandle()
  240. handle.entry = f
  241. op.Handle = handle.ID
  242. op.UseDirectIO = true
  243. return
  244. }
  245. // COMMON but specific in cache
  246. func (fs *BaseFS) ReadFile(ctx context.Context, op *fuseops.ReadFileOp) (err error) {
  247. handle := fs.fileHandles[op.Handle]
  248. localFile := handle.entry.Cache()
  249. op.BytesRead, err = localFile.ReadAt(op.Dst, op.Offset)
  250. if err == io.EOF { // fuse does not expect a EOF
  251. err = nil
  252. }
  253. return
  254. }
  255. // CreateFile creates empty file in google Drive and returns its ID and attributes, only allows file creation on 'My Drive'
  256. // Cloud SPECIFIC
  257. func (fs *BaseFS) CreateFile(ctx context.Context, op *fuseops.CreateFileOp) (err error) {
  258. parentFile := fs.findByInode(op.Parent)
  259. if parentFile == nil {
  260. return fuse.ENOENT
  261. }
  262. // Only write on child folders
  263. if parentFile.Inode == fuseops.RootInodeID {
  264. return syscall.EPERM
  265. }
  266. existsFile := fs.lookupByParent(parentFile, op.Name)
  267. //existsFile := parentFile.FindByName(op.Name, false)
  268. if existsFile != nil {
  269. return fuse.EEXIST
  270. }
  271. // Parent entry/Name
  272. entry, err := fs.createFile(parentFile, op.Name, false)
  273. if err != nil {
  274. return err
  275. }
  276. // Associate a temp file to a new handle
  277. // Local copy
  278. // Lock
  279. handle := fs.createHandle()
  280. handle.entry = entry
  281. handle.uploadOnDone = true
  282. //
  283. op.Handle = handle.ID
  284. op.Entry = fuseops.ChildInodeEntry{
  285. Attributes: entry.Attr,
  286. Child: entry.Inode,
  287. AttributesExpiration: time.Now().Add(time.Minute),
  288. EntryExpiration: time.Now().Add(time.Minute),
  289. }
  290. op.Mode = entry.Attr.Mode
  291. return
  292. }
  293. // WriteFile as ReadFile it creates a temporary file on first read
  294. // Maybe the ReadFile should be called here aswell to cache current contents since we are using writeAt
  295. // CLOUD SPECIFIC
  296. func (fs *BaseFS) WriteFile(ctx context.Context, op *fuseops.WriteFileOp) (err error) {
  297. handle, ok := fs.fileHandles[op.Handle]
  298. if !ok {
  299. return fuse.EIO
  300. }
  301. localFile := handle.entry.Cache()
  302. if localFile == nil {
  303. return fuse.EINVAL
  304. }
  305. _, err = localFile.WriteAt(op.Data, op.Offset)
  306. if err != nil {
  307. err = fuse.EIO
  308. return
  309. }
  310. handle.uploadOnDone = true
  311. return
  312. }
  313. // FlushFile just returns no error, maybe upload should be handled here
  314. // COMMON
  315. func (fs *BaseFS) FlushFile(ctx context.Context, op *fuseops.FlushFileOp) (err error) {
  316. handle, ok := fs.fileHandles[op.Handle]
  317. if !ok {
  318. return fuse.EIO
  319. }
  320. if handle.entry.tempFile == nil {
  321. return
  322. }
  323. if handle.uploadOnDone { // or if content changed basically
  324. err = handle.entry.Sync()
  325. if err != nil {
  326. return fuse.EINVAL
  327. }
  328. }
  329. return
  330. }
  331. // ReleaseFileHandle closes and deletes any temporary files, upload in case if changed locally
  332. // COMMON
  333. func (fs *BaseFS) ReleaseFileHandle(ctx context.Context, op *fuseops.ReleaseFileHandleOp) (err error) {
  334. handle := fs.fileHandles[op.Handle]
  335. handle.entry.ClearCache()
  336. delete(fs.fileHandles, op.Handle)
  337. return
  338. }
  339. // Unlink remove file and remove from local cache entry
  340. // SPECIFIC
  341. func (fs *BaseFS) Unlink(ctx context.Context, op *fuseops.UnlinkOp) (err error) {
  342. parentEntry := fs.findByInode(op.Parent)
  343. if parentEntry == nil {
  344. return fuse.ENOENT
  345. }
  346. if parentEntry.Inode == fuseops.RootInodeID {
  347. return syscall.EPERM
  348. }
  349. fileEntry := fs.lookupByParent(parentEntry, op.Name)
  350. //fileEntry := parentEntry.FindByName(op.Name, false)
  351. if fileEntry == nil {
  352. return fuse.ENOATTR
  353. }
  354. return fs.deleteFile(fileEntry)
  355. }
  356. // MkDir creates a directory on a parent dir
  357. func (fs *BaseFS) MkDir(ctx context.Context, op *fuseops.MkDirOp) (err error) {
  358. parentFile := fs.findByInode(op.Parent)
  359. if parentFile == nil {
  360. return fuse.ENOENT
  361. }
  362. if parentFile.Inode == fuseops.RootInodeID {
  363. return syscall.EPERM
  364. }
  365. entry, err := fs.createFile(parentFile, op.Name, true)
  366. if err != nil {
  367. return err
  368. }
  369. //entry = parentFile.AppendGFile(fi, entry.Inode)
  370. //if entry == nil {
  371. // return fuse.EINVAL
  372. // }
  373. op.Entry = fuseops.ChildInodeEntry{
  374. Attributes: entry.Attr,
  375. Child: entry.Inode,
  376. AttributesExpiration: time.Now().Add(time.Minute),
  377. EntryExpiration: time.Now().Add(time.Microsecond),
  378. }
  379. return
  380. }
  381. // RmDir fuse implementation
  382. func (fs *BaseFS) RmDir(ctx context.Context, op *fuseops.RmDirOp) (err error) {
  383. parentFile := fs.findByInode(op.Parent)
  384. if parentFile == nil {
  385. return fuse.ENOENT
  386. }
  387. if parentFile.Inode == fuseops.RootInodeID {
  388. return syscall.EPERM
  389. }
  390. theFile := fs.lookupByParent(parentFile, op.Name)
  391. //theFile := parentFile.FindByName(op.Name, false)
  392. err = fs.deleteFile(theFile)
  393. //err = fs.Client.Files.Delete(theFile.GFile.Id).Do()
  394. if err != nil {
  395. return fuse.ENOTEMPTY
  396. }
  397. //parentFile.RemoveChild(theFile)
  398. // Remove from entry somehow
  399. return
  400. }
  401. // Rename fuse implementation
  402. func (fs *BaseFS) Rename(ctx context.Context, op *fuseops.RenameOp) (err error) {
  403. oldParentFile := fs.findByInode(op.OldParent)
  404. if oldParentFile == nil {
  405. return fuse.ENOENT
  406. }
  407. newParentFile := fs.findByInode(op.NewParent)
  408. if newParentFile == nil {
  409. return fuse.ENOENT
  410. }
  411. if oldParentFile.Inode == fuseops.RootInodeID || newParentFile.Inode == fuseops.RootInodeID {
  412. return syscall.EPERM
  413. }
  414. //oldFile := oldParentFile.FindByName(op.OldName, false)
  415. oldEntry := fs.lookupByParent(oldParentFile, op.OldName)
  416. // Although GDrive allows duplicate names, there is some issue with inode caching
  417. // So we prevent a rename to a file with same name
  418. //existsFile := newParentFile.FindByName(op.NewName, false)
  419. existsEntry := fs.lookupByGID(newParentFile.GID, op.NewName)
  420. if existsEntry != nil {
  421. return fuse.EEXIST
  422. }
  423. // Rename somehow
  424. ngFile := &drive.File{
  425. Name: op.NewName,
  426. }
  427. updateCall := fs.Client.Files.Update(oldEntry.GID, ngFile).Fields(fileFields)
  428. if oldParentFile != newParentFile {
  429. updateCall.RemoveParents(oldParentFile.GID)
  430. updateCall.AddParents(newParentFile.GID)
  431. }
  432. updatedFile, err := updateCall.Do()
  433. oldEntry.SetGFile(updatedFile)
  434. //oldParentFile.RemoveChild(oldFile)
  435. //newParentFile.AppendGFile(updatedFile, oldFile.Inode)
  436. return
  437. }
  438. func (fs *BaseFS) findByInode(inode fuseops.InodeID) *FileEntry {
  439. return fs.fileEntries[inode]
  440. }
  441. // GID specific functions
  442. func (fs *BaseFS) findByGID(gid string) *FileEntry {
  443. for _, v := range fs.fileEntries {
  444. if v.GFile != nil && v.GFile.Id == gid {
  445. return v
  446. }
  447. }
  448. return nil
  449. }
  450. func (fs *BaseFS) lookupByGID(parentGID string, name string) *FileEntry {
  451. for _, entry := range fs.fileEntries {
  452. if entry.HasParentGID(parentGID) && entry.Name == name {
  453. return entry
  454. }
  455. }
  456. return nil
  457. }
  458. func (fs *BaseFS) listByParent(parent *FileEntry) []*FileEntry {
  459. ret := []*FileEntry{}
  460. for _, entry := range fs.fileEntries {
  461. if entry.HasParentGID(parent.GID) {
  462. ret = append(ret, entry)
  463. }
  464. }
  465. return ret
  466. }
  467. func (fs *BaseFS) lookupByParent(parent *FileEntry, name string) *FileEntry {
  468. for _, entry := range fs.fileEntries {
  469. if entry.HasParentGID(parent.GID) && entry.Name == name {
  470. return entry
  471. }
  472. }
  473. return nil
  474. }
  475. func (fs *BaseFS) createFile(parentFile *FileEntry, name string, isDir bool) (*FileEntry, error) {
  476. newGFile := &drive.File{
  477. Parents: []string{parentFile.GFile.Id},
  478. Name: name,
  479. }
  480. if isDir {
  481. newGFile.MimeType = "application/vnd.google-apps.folder"
  482. }
  483. // Could be transformed to CreateFile in continer
  484. // InDriver
  485. createdGFile, err := fs.Client.Files.Create(newGFile).Fields(fileFields).Do()
  486. if err != nil {
  487. return nil, fuse.EINVAL
  488. }
  489. entry := fs.fileEntry(createdGFile.Name, createdGFile) // New Entry added // Or Return same?
  490. return entry, nil
  491. }
  492. func (fs *BaseFS) deleteFile(entry *FileEntry) error {
  493. err := fs.Client.Files.Delete(entry.GFile.Id).Do()
  494. if err != nil {
  495. return fuse.EIO
  496. }
  497. fs.removeEntry(entry)
  498. return nil
  499. }
  500. //////////////
  501. //Return or create inode // Pass name maybe?
  502. func (fs *BaseFS) fileEntry(aname string, gfile *drive.File, inodeOps ...fuseops.InodeID) *FileEntry {
  503. fs.inodeMU.Lock()
  504. defer fs.inodeMU.Unlock()
  505. var inode fuseops.InodeID
  506. if len(inodeOps) > 0 {
  507. inode = inodeOps[0]
  508. if fe, ok := fs.fileEntries[inode]; ok {
  509. return fe
  510. }
  511. } else { // generate new inode
  512. // Max Inode Number
  513. for inode = 2; inode < 99999; inode++ {
  514. _, ok := fs.fileEntries[inode]
  515. if !ok {
  516. break
  517. }
  518. }
  519. }
  520. name := ""
  521. if gfile != nil {
  522. name = aname
  523. count := 1
  524. nameParts := strings.Split(name, ".")
  525. for {
  526. // We find if we have a GFile in same parent with same name
  527. var entry *FileEntry
  528. for _, p := range gfile.Parents {
  529. entry = fs.lookupByGID(p, name)
  530. if entry != nil {
  531. break
  532. }
  533. }
  534. if entry == nil { // Not found return
  535. break
  536. }
  537. count++
  538. if len(nameParts) > 1 {
  539. name = fmt.Sprintf("%s(%d).%s", nameParts[0], count, strings.Join(nameParts[1:], "."))
  540. } else {
  541. name = fmt.Sprintf("%s(%d)", nameParts[0], count)
  542. }
  543. log.Printf("Conflicting name generated new '%s' as '%s'", gfile.Name, name)
  544. }
  545. }
  546. fe := &FileEntry{
  547. GFile: gfile,
  548. Inode: inode,
  549. fs: fs,
  550. Name: name,
  551. //children: []*FileEntry{},
  552. Attr: fuseops.InodeAttributes{
  553. Uid: fs.Config.UID,
  554. Gid: fs.Config.GID,
  555. },
  556. }
  557. fe.SetGFile(gfile)
  558. fs.fileEntries[inode] = fe
  559. return fe
  560. }
  561. /*func (fs *BaseFS) addEntry(entry *FileEntry) {
  562. fc.fileEntries[entry.Inode] = entry
  563. }*/
  564. // RemoveEntry remove file entry
  565. func (fs *BaseFS) removeEntry(entry *FileEntry) {
  566. var inode fuseops.InodeID
  567. for k, e := range fs.fileEntries {
  568. if e == entry {
  569. inode = k
  570. }
  571. }
  572. delete(fs.fileEntries, inode)
  573. }