18947: Refactor keep-web as arvados-server command.
[arvados.git] / services / keep-web / webdav.go
index 57f3f53a99ef6a73944c6cb600c1672c67cb6696..501c355a7388a53fe3b40fc3f082c63768665620 100644 (file)
@@ -2,20 +2,21 @@
 //
 // SPDX-License-Identifier: AGPL-3.0
 
-package main
+package keepweb
 
 import (
        "crypto/rand"
        "errors"
        "fmt"
+       "io"
        prand "math/rand"
-       "net/http"
        "os"
-       "sync"
+       "path"
+       "strings"
        "sync/atomic"
        "time"
 
-       "git.curoverse.com/arvados.git/sdk/go/arvados"
+       "git.arvados.org/arvados.git/sdk/go/arvados"
 
        "golang.org/x/net/context"
        "golang.org/x/net/webdav"
@@ -27,103 +28,118 @@ var (
        errReadOnly           = errors.New("read-only filesystem")
 )
 
-// webdavFS implements a read-only webdav.FileSystem by wrapping an
+// webdavFS implements a webdav.FileSystem by wrapping an
 // arvados.CollectionFilesystem.
+//
+// Collections don't preserve empty directories, so Mkdir is
+// effectively a no-op, and we need to make parent dirs spring into
+// existence automatically so sequences like "mkcol foo; put foo/bar"
+// work as expected.
 type webdavFS struct {
-       collfs arvados.CollectionFileSystem
+       collfs  arvados.FileSystem
+       writing bool
+       // webdav PROPFIND reads the first few bytes of each file
+       // whose filename extension isn't recognized, which is
+       // prohibitively expensive: we end up fetching multiple 64MiB
+       // blocks. Avoid this by returning EOF on all reads when
+       // handling a PROPFIND.
+       alwaysReadEOF bool
+}
+
+func (fs *webdavFS) makeparents(name string) {
+       if !fs.writing {
+               return
+       }
+       dir, _ := path.Split(name)
+       if dir == "" || dir == "/" {
+               return
+       }
+       dir = dir[:len(dir)-1]
+       fs.makeparents(dir)
+       fs.collfs.Mkdir(dir, 0755)
 }
 
-var _ webdav.FileSystem = &webdavFS{}
-
 func (fs *webdavFS) Mkdir(ctx context.Context, name string, perm os.FileMode) error {
-       return errReadOnly
+       if !fs.writing {
+               return errReadOnly
+       }
+       name = strings.TrimRight(name, "/")
+       fs.makeparents(name)
+       return fs.collfs.Mkdir(name, 0755)
 }
 
-func (fs *webdavFS) OpenFile(ctx context.Context, name string, flag int, perm os.FileMode) (webdav.File, error) {
-       fi, err := fs.collfs.Stat(name)
-       if err != nil {
-               return nil, err
+func (fs *webdavFS) OpenFile(ctx context.Context, name string, flag int, perm os.FileMode) (f webdav.File, err error) {
+       writing := flag&(os.O_WRONLY|os.O_RDWR|os.O_TRUNC) != 0
+       if writing {
+               fs.makeparents(name)
        }
-       return &webdavFile{collfs: fs.collfs, fileInfo: fi, name: name}, nil
+       f, err = fs.collfs.OpenFile(name, flag, perm)
+       if !fs.writing {
+               // webdav module returns 404 on all OpenFile errors,
+               // but returns 405 Method Not Allowed if OpenFile()
+               // succeeds but Write() or Close() fails. We'd rather
+               // have 405. writeFailer ensures Close() fails if the
+               // file is opened for writing *or* Write() is called.
+               var err error
+               if writing {
+                       err = errReadOnly
+               }
+               f = writeFailer{File: f, err: err}
+       }
+       if fs.alwaysReadEOF {
+               f = readEOF{File: f}
+       }
+       return
 }
 
 func (fs *webdavFS) RemoveAll(ctx context.Context, name string) error {
-       return errReadOnly
+       return fs.collfs.RemoveAll(name)
 }
 
 func (fs *webdavFS) Rename(ctx context.Context, oldName, newName string) error {
-       return errReadOnly
+       if !fs.writing {
+               return errReadOnly
+       }
+       if strings.HasSuffix(oldName, "/") {
+               // WebDAV "MOVE foo/ bar/" means rename foo to bar.
+               oldName = oldName[:len(oldName)-1]
+               newName = strings.TrimSuffix(newName, "/")
+       }
+       fs.makeparents(newName)
+       return fs.collfs.Rename(oldName, newName)
 }
 
 func (fs *webdavFS) Stat(ctx context.Context, name string) (os.FileInfo, error) {
+       if fs.writing {
+               fs.makeparents(name)
+       }
        return fs.collfs.Stat(name)
 }
 
-// webdavFile implements a read-only webdav.File by wrapping
-// http.File.
-//
-// The http.File is opened from an arvados.CollectionFileSystem, but
-// not until Seek, Read, or Readdir is called. This deferred-open
-// strategy makes webdav's OpenFile-Stat-Close cycle fast even though
-// the collfs's Open method is slow. This is relevant because webdav
-// does OpenFile-Stat-Close on each file when preparing directory
-// listings.
-//
-// Writes to a webdavFile always fail.
-type webdavFile struct {
-       // fields populated by (*webdavFS).OpenFile()
-       collfs   http.FileSystem
-       fileInfo os.FileInfo
-       name     string
-
-       // internal fields
-       file     http.File
-       loadOnce sync.Once
-       err      error
-}
-
-func (f *webdavFile) load() {
-       f.file, f.err = f.collfs.Open(f.name)
-}
-
-func (f *webdavFile) Write([]byte) (int, error) {
-       return 0, errReadOnly
+type writeFailer struct {
+       webdav.File
+       err error
 }
 
-func (f *webdavFile) Seek(offset int64, whence int) (int64, error) {
-       f.loadOnce.Do(f.load)
-       if f.err != nil {
-               return 0, f.err
-       }
-       return f.file.Seek(offset, whence)
-}
-
-func (f *webdavFile) Read(buf []byte) (int, error) {
-       f.loadOnce.Do(f.load)
-       if f.err != nil {
-               return 0, f.err
-       }
-       return f.file.Read(buf)
+func (wf writeFailer) Write([]byte) (int, error) {
+       wf.err = errReadOnly
+       return 0, wf.err
 }
 
-func (f *webdavFile) Close() error {
-       if f.file == nil {
-               // We never called load(), or load() failed
-               return f.err
+func (wf writeFailer) Close() error {
+       err := wf.File.Close()
+       if err != nil {
+               wf.err = err
        }
-       return f.file.Close()
+       return wf.err
 }
 
-func (f *webdavFile) Readdir(n int) ([]os.FileInfo, error) {
-       f.loadOnce.Do(f.load)
-       if f.err != nil {
-               return nil, f.err
-       }
-       return f.file.Readdir(n)
+type readEOF struct {
+       webdav.File
 }
 
-func (f *webdavFile) Stat() (os.FileInfo, error) {
-       return f.fileInfo, nil
+func (readEOF) Read(p []byte) (int, error) {
+       return 0, io.EOF
 }
 
 // noLockSystem implements webdav.LockSystem by returning success for