Refactor storage interface to return io.Reader and Writer instances

Doing so will enable encrypting/decrypting files in a 'pipeline' without
having to write the intermediate results to a file or store them in
their entirety in memory.

This commit also updates the existing storage classes (local and FTP) to
meet the new interface definition.
This commit is contained in:
Aaron Lindsay 2013-09-09 22:59:18 -04:00
parent 1254a7fb45
commit e2ae508382
5 changed files with 104 additions and 69 deletions

View File

@ -11,6 +11,7 @@ import (
"errors" "errors"
"flag" "flag"
"fmt" "fmt"
"io"
"io/ioutil" "io/ioutil"
"os" "os"
"os/user" "os/user"
@ -204,7 +205,19 @@ func ProcessLocalEvent(globals AsinkGlobals, event *asink.Event) {
//upload file to remote storage //upload file to remote storage
StatStartUpload() StatStartUpload()
err = globals.storage.Put(cachedFilename, event.Hash) uploadWriteCloser, err := globals.storage.Put(event.Hash)
if err != nil {
panic(err)
}
defer uploadWriteCloser.Close()
uploadFile, err := os.Open(cachedFilename)
if err != nil {
panic(err)
}
defer uploadFile.Close()
_, err = io.Copy(uploadWriteCloser, uploadFile)
StatStopUpload() StatStopUpload()
if err != nil { if err != nil {
panic(err) panic(err)
@ -270,9 +283,15 @@ func ProcessRemoteEvent(globals AsinkGlobals, event *asink.Event) {
panic(err) //TODO handle sensibly panic(err) //TODO handle sensibly
} }
tmpfilename := outfile.Name() tmpfilename := outfile.Name()
outfile.Close()
StatStartDownload() StatStartDownload()
err = globals.storage.Get(tmpfilename, event.Hash) downloadReadCloser, err := globals.storage.Get(event.Hash)
if err != nil {
panic(err)
}
defer downloadReadCloser.Close()
_, err = io.Copy(outfile, downloadReadCloser)
outfile.Close()
StatStopDownload() StatStopDownload()
if err != nil { if err != nil {
panic(err) //TODO handle sensibly panic(err) //TODO handle sensibly

View File

@ -7,11 +7,14 @@ package main
import ( import (
"code.google.com/p/goconf/conf" "code.google.com/p/goconf/conf"
"errors" "errors"
"io"
) )
type Storage interface { type Storage interface {
Put(filename string, hash string) error // Close() MUST be called on the returned io.WriteCloser
Get(filename string, hash string) error Put(hash string) (io.WriteCloser, error)
// Close() MUST be called on the returned io.ReadCloser
Get(hash string) (io.ReadCloser, error)
} }
func GetStorage(config *conf.ConfigFile) (Storage, error) { func GetStorage(config *conf.ConfigFile) (Storage, error) {

View File

@ -9,7 +9,6 @@ import (
"errors" "errors"
"github.com/jlaffaye/goftp" "github.com/jlaffaye/goftp"
"io" "io"
"os"
"strconv" "strconv"
) )
@ -58,68 +57,70 @@ func NewFTPStorage(config *conf.ConfigFile) (*FTPStorage, error) {
return fs, nil return fs, nil
} }
func (fs *FTPStorage) Put(filename string, hash string) (e error) { func (fs *FTPStorage) Put(hash string) (w io.WriteCloser, e error) {
returningNormally := false
//make sure we don't flood the FTP server //make sure we don't flood the FTP server
fs.connectionsChan <- 0 fs.connectionsChan <- 0
defer func() { <-fs.connectionsChan }() defer func() {
if !returningNormally {
infile, err := os.Open(filename) <-fs.connectionsChan
if err != nil { }
return err }()
}
defer infile.Close()
connection, err := ftp.Connect(fs.server + ":" + strconv.Itoa(fs.port)) connection, err := ftp.Connect(fs.server + ":" + strconv.Itoa(fs.port))
if err != nil { if err != nil {
return err return nil, err
} }
defer connection.Quit() defer func() {
if !returningNormally {
connection.Quit()
}
}()
err = connection.Login(fs.username, fs.password) err = connection.Login(fs.username, fs.password)
if err != nil { if err != nil {
return err return nil, err
} }
err = connection.ChangeDir(fs.directory) err = connection.ChangeDir(fs.directory)
if err != nil { if err != nil {
return err return nil, err
} }
return connection.Stor(hash, infile) reader, writer := io.Pipe()
go func() {
err := connection.Stor(hash, reader)
if err != nil {
reader.CloseWithError(err)
}
<-fs.connectionsChan
connection.Quit()
}()
returningNormally = true
return writer, nil
} }
func (fs *FTPStorage) Get(filename string, hash string) error { func (fs *FTPStorage) Get(hash string) (io.ReadCloser, error) {
fs.connectionsChan <- 0 fs.connectionsChan <- 0
defer func() { <-fs.connectionsChan }() defer func() { <-fs.connectionsChan }()
connection, err := ftp.Connect(fs.server + ":" + strconv.Itoa(fs.port)) connection, err := ftp.Connect(fs.server + ":" + strconv.Itoa(fs.port))
if err != nil { if err != nil {
return err return nil, err
} }
defer connection.Quit() defer connection.Quit()
err = connection.Login(fs.username, fs.password) err = connection.Login(fs.username, fs.password)
if err != nil { if err != nil {
return err return nil, err
} }
err = connection.ChangeDir(fs.directory) err = connection.ChangeDir(fs.directory)
if err != nil { if err != nil {
return err return nil, err
} }
downloadedFile, err := connection.Retr(hash) return connection.Retr(hash)
if err != nil {
return err
}
defer downloadedFile.Close()
outfile, err := os.Create(filename)
if err != nil {
return err
}
defer outfile.Close()
_, err = io.Copy(outfile, downloadedFile)
return err
} }

View File

@ -9,6 +9,7 @@ import (
"code.google.com/p/goconf/conf" "code.google.com/p/goconf/conf"
"errors" "errors"
"io" "io"
"io/ioutil"
"os" "os"
"path" "path"
) )
@ -41,37 +42,44 @@ func NewLocalStorage(config *conf.ConfigFile) (*LocalStorage, error) {
return ls, nil return ls, nil
} }
func (ls *LocalStorage) Put(filename string, hash string) (e error) { type putWriteCloser struct {
tmpfile, err := util.CopyToTmp(filename, ls.tmpSubdir) outfile *os.File
if err != nil { filename string
return err }
}
err = os.Rename(tmpfile, path.Join(ls.storageDir, hash)) func (wc putWriteCloser) Write(p []byte) (n int, err error) {
return wc.outfile.Write(p)
}
func (wc putWriteCloser) Close() error {
tmpfilename := wc.outfile.Name()
wc.outfile.Close()
err := os.Rename(tmpfilename, wc.filename)
if err != nil { if err != nil {
err := os.Remove(tmpfile) err := os.Remove(tmpfilename)
if err != nil { if err != nil {
return err return err
} }
} }
return nil return nil
} }
func (ls *LocalStorage) Get(filename string, hash string) error { func (ls *LocalStorage) Put(hash string) (w io.WriteCloser, e error) {
infile, err := os.Open(path.Join(ls.storageDir, hash)) outfile, err := ioutil.TempFile(ls.tmpSubdir, "asink")
if err != nil { if err != nil {
return err return nil, err
} }
defer infile.Close()
outfile, err := os.Create(filename) w = putWriteCloser{outfile, path.Join(ls.storageDir, hash)}
if err != nil {
return err
}
defer outfile.Close()
_, err = io.Copy(outfile, infile) return
}
return err
func (ls *LocalStorage) Get(hash string) (r io.ReadCloser, e error) {
r, err := os.Open(path.Join(ls.storageDir, hash))
if err != nil {
return nil, err
}
return
} }

View File

@ -46,6 +46,21 @@ func RecursiveRemoveEmptyDirs(dir string) {
} }
} }
func CopyReaderToTmp(src io.Reader, tmpdir string) (string, error) {
outfile, err := ioutil.TempFile(tmpdir, "asink")
if err != nil {
return "", err
}
defer outfile.Close()
_, err = io.Copy(outfile, src)
if err != nil {
return "", err
}
return outfile.Name(), nil
}
func CopyToTmp(src string, tmpdir string) (string, error) { func CopyToTmp(src string, tmpdir string) (string, error) {
infile, err := os.Open(src) infile, err := os.Open(src)
if err != nil { if err != nil {
@ -53,18 +68,7 @@ func CopyToTmp(src string, tmpdir string) (string, error) {
} }
defer infile.Close() defer infile.Close()
outfile, err := ioutil.TempFile(tmpdir, "asink") return CopyReaderToTmp(infile, tmpdir)
if err != nil {
return "", err
}
defer outfile.Close()
_, err = io.Copy(outfile, infile)
if err != nil {
return "", err
}
return outfile.Name(), nil
} }
func ErrorFileNotFound(err error) bool { func ErrorFileNotFound(err error) bool {