services/keep-web/webdav.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 package main
   6
   7 import (
   8         "crypto/rand"
   9         "errors"
  10         "fmt"
  11         prand "math/rand"
  12         "os"
  13         "path"
  14         "strings"
  15         "sync/atomic"
  16         "time"
  17
  18         "git.curoverse.com/arvados.git/sdk/go/arvados"
  19
  20         "golang.org/x/net/context"
  21         "golang.org/x/net/webdav"
  22 )
  23
  24 var (
  25         lockPrefix     string = uuid()
  26         nextLockSuffix int64  = prand.Int63()
  27         errReadOnly           = errors.New("read-only filesystem")
  28 )
  29
  30 // webdavFS implements a webdav.FileSystem by wrapping an
  31 // arvados.CollectionFilesystem.
  32 //
  33 // Collections don't preserve empty directories, so Mkdir is
  34 // effectively a no-op, and we need to make parent dirs spring into
  35 // existence automatically so sequences like "mkcol foo; put foo/bar"
  36 // work as expected.
  37 type webdavFS struct {
  38         collfs arvados.CollectionFileSystem
  39         update func() error
  40 }
  41
  42 func (fs *webdavFS) makeparents(name string) {
  43         dir, name := path.Split(name)
  44         if dir == "" || dir == "/" {
  45                 return
  46         }
  47         dir = dir[:len(dir)-1]
  48         fs.makeparents(dir)
  49         fs.collfs.Mkdir(dir, 0755)
  50 }
  51
  52 func (fs *webdavFS) Mkdir(ctx context.Context, name string, perm os.FileMode) error {
  53         if fs.update == nil {
  54                 return errReadOnly
  55         }
  56         name = strings.TrimRight(name, "/")
  57         fs.makeparents(name)
  58         if err := fs.collfs.Mkdir(name, 0755); err != nil {
  59                 return err
  60         }
  61         return fs.update()
  62 }
  63
  64 func (fs *webdavFS) OpenFile(ctx context.Context, name string, flag int, perm os.FileMode) (f webdav.File, err error) {
  65         writing := flag&(os.O_WRONLY|os.O_RDWR) != 0
  66         if writing {
  67                 if fs.update == nil {
  68                         return nil, errReadOnly
  69                 }
  70                 fs.makeparents(name)
  71         }
  72         f, err = fs.collfs.OpenFile(name, flag, perm)
  73         if writing && err == nil {
  74                 f = writingFile{File: f, update: fs.update}
  75         }
  76         return
  77 }
  78
  79 func (fs *webdavFS) RemoveAll(ctx context.Context, name string) error {
  80         if err := fs.collfs.RemoveAll(name); err != nil {
  81                 return err
  82         }
  83         return fs.update()
  84 }
  85
  86 func (fs *webdavFS) Rename(ctx context.Context, oldName, newName string) error {
  87         if fs.update == nil {
  88                 return errReadOnly
  89         }
  90         fs.makeparents(newName)
  91         if err := fs.collfs.Rename(oldName, newName); err != nil {
  92                 return err
  93         }
  94         return fs.update()
  95 }
  96
  97 func (fs *webdavFS) Stat(ctx context.Context, name string) (os.FileInfo, error) {
  98         if fs.update != nil {
  99                 fs.makeparents(name)
 100         }
 101         return fs.collfs.Stat(name)
 102 }
 103
 104 type writingFile struct {
 105         webdav.File
 106         update func() error
 107 }
 108
 109 func (f writingFile) Close() error {
 110         if err := f.File.Close(); err != nil || f.update == nil {
 111                 return err
 112         }
 113         return f.update()
 114 }
 115
 116 // noLockSystem implements webdav.LockSystem by returning success for
 117 // every possible locking operation, even though it has no side
 118 // effects such as actually locking anything. This works for a
 119 // read-only webdav filesystem because webdav locks only apply to
 120 // writes.
 121 //
 122 // This is more suitable than webdav.NewMemLS() for two reasons:
 123 // First, it allows keep-web to use one locker for all collections
 124 // even though coll1.vhost/foo and coll2.vhost/foo have the same path
 125 // but represent different resources. Additionally, it returns valid
 126 // tokens (rfc2518 specifies that tokens are represented as URIs and
 127 // are unique across all resources for all time), which might improve
 128 // client compatibility.
 129 //
 130 // However, it does also permit impossible operations, like acquiring
 131 // conflicting locks and releasing non-existent locks.  This might
 132 // confuse some clients if they try to probe for correctness.
 133 //
 134 // Currently this is a moot point: the LOCK and UNLOCK methods are not
 135 // accepted by keep-web, so it suffices to implement the
 136 // webdav.LockSystem interface.
 137 type noLockSystem struct{}
 138
 139 func (*noLockSystem) Confirm(time.Time, string, string, ...webdav.Condition) (func(), error) {
 140         return noop, nil
 141 }
 142
 143 func (*noLockSystem) Create(now time.Time, details webdav.LockDetails) (token string, err error) {
 144         return fmt.Sprintf("opaquelocktoken:%s-%x", lockPrefix, atomic.AddInt64(&nextLockSuffix, 1)), nil
 145 }
 146
 147 func (*noLockSystem) Refresh(now time.Time, token string, duration time.Duration) (webdav.LockDetails, error) {
 148         return webdav.LockDetails{}, nil
 149 }
 150
 151 func (*noLockSystem) Unlock(now time.Time, token string) error {
 152         return nil
 153 }
 154
 155 func noop() {}
 156
 157 // Return a version 1 variant 4 UUID, meaning all bits are random
 158 // except the ones indicating the version and variant.
 159 func uuid() string {
 160         var data [16]byte
 161         if _, err := rand.Read(data[:]); err != nil {
 162                 panic(err)
 163         }
 164         // variant 1: N=10xx
 165         data[8] = data[8]&0x3f | 0x80
 166         // version 4: M=0100
 167         data[6] = data[6]&0x0f | 0x40
 168         return fmt.Sprintf("%x-%x-%x-%x-%x", data[0:4], data[4:6], data[6:8], data[8:10], data[10:])
 169 }