func doVerify(signaturePath string, dir string, woundsPath string, healPath string) error {
if woundsPath == "" {
if healPath == "" {
comm.Opf("Verifying %s", dir)
} else {
comm.Opf("Verifying %s, healing as we go", dir)
}
} else {
if healPath == "" {
comm.Opf("Verifying %s, writing wounds to %s", dir, woundsPath)
} else {
comm.Dief("Options --wounds and --heal cannot be used at the same time")
}
}
startTime := time.Now()
signatureReader, err := eos.Open(signaturePath)
if err != nil {
return errors.Wrap(err, 1)
}
defer signatureReader.Close()
signature, err := pwr.ReadSignature(signatureReader)
if err != nil {
return errors.Wrap(err, 1)
}
vc := &pwr.ValidatorContext{
Consumer: comm.NewStateConsumer(),
WoundsPath: woundsPath,
HealPath: healPath,
}
comm.StartProgressWithTotalBytes(signature.Container.Size)
err = vc.Validate(dir, signature)
if err != nil {
return errors.Wrap(err, 1)
}
comm.EndProgress()
prettySize := humanize.IBytes(uint64(signature.Container.Size))
perSecond := humanize.IBytes(uint64(float64(signature.Container.Size) / time.Since(startTime).Seconds()))
comm.Statf("%s (%s) @ %s/s\n", prettySize, signature.Container.Stats(), perSecond)
if vc.WoundsConsumer.HasWounds() {
if healer, ok := vc.WoundsConsumer.(pwr.Healer); ok {
comm.Statf("%s corrupted data found, %s healed", humanize.IBytes(uint64(vc.WoundsConsumer.TotalCorrupted())), humanize.IBytes(uint64(healer.TotalHealed())))
} else {
comm.Dief("%s corrupted data found", humanize.IBytes(uint64(vc.WoundsConsumer.TotalCorrupted())))
}
}
return nil
}
func doPush(buildPath string, specStr string, userVersion string, fixPerms bool) error {
// start walking source container while waiting on auth flow
sourceContainerChan := make(chan walkResult)
walkErrs := make(chan error)
go doWalk(buildPath, sourceContainerChan, walkErrs, fixPerms)
spec, err := itchio.ParseSpec(specStr)
if err != nil {
return errors.Wrap(err, 1)
}
err = spec.EnsureChannel()
if err != nil {
return errors.Wrap(err, 1)
}
client, err := authenticateViaOauth()
if err != nil {
return errors.Wrap(err, 1)
}
newBuildRes, err := client.CreateBuild(spec.Target, spec.Channel, userVersion)
if err != nil {
return errors.Wrap(err, 1)
}
buildID := newBuildRes.Build.ID
parentID := newBuildRes.Build.ParentBuild.ID
var targetSignature *pwr.SignatureInfo
if parentID == 0 {
comm.Opf("For channel `%s`: pushing first build", spec.Channel)
targetSignature = &pwr.SignatureInfo{
Container: &tlc.Container{},
Hashes: make([]wsync.BlockHash, 0),
}
} else {
comm.Opf("For channel `%s`: last build is %d, downloading its signature", spec.Channel, parentID)
var buildFiles itchio.ListBuildFilesResponse
buildFiles, err = client.ListBuildFiles(parentID)
if err != nil {
return errors.Wrap(err, 1)
}
signatureFile := itchio.FindBuildFile(itchio.BuildFileType_SIGNATURE, buildFiles.Files)
if signatureFile == nil {
comm.Dief("Could not find signature for parent build %d, aborting", parentID)
}
var signatureReader io.Reader
signatureReader, err = client.DownloadBuildFile(parentID, signatureFile.ID)
if err != nil {
return errors.Wrap(err, 1)
}
targetSignature, err = pwr.ReadSignature(signatureReader)
if err != nil {
return errors.Wrap(err, 1)
}
}
newPatchRes, newSignatureRes, err := createBothFiles(client, buildID)
if err != nil {
return errors.Wrap(err, 1)
}
uploadDone := make(chan bool)
uploadErrs := make(chan error)
patchWriter, err := uploader.NewResumableUpload(newPatchRes.File.UploadURL,
uploadDone, uploadErrs, uploader.ResumableUploadSettings{
Consumer: comm.NewStateConsumer(),
})
patchWriter.MaxChunkGroup = *appArgs.maxChunkGroup
if err != nil {
return errors.Wrap(err, 1)
}
signatureWriter, err := uploader.NewResumableUpload(newSignatureRes.File.UploadURL,
uploadDone, uploadErrs, uploader.ResumableUploadSettings{
Consumer: comm.NewStateConsumer(),
})
signatureWriter.MaxChunkGroup = *appArgs.maxChunkGroup
if err != nil {
return errors.Wrap(err, 1)
}
comm.Debugf("Launching patch & signature channels")
patchCounter := counter.NewWriter(patchWriter)
signatureCounter := counter.NewWriter(signatureWriter)
// we started walking the source container in the beginning,
// we actually need it now.
// note that we could actually start diffing before all the file
// creation & upload setup is done
var sourceContainer *tlc.Container
var sourcePool wsync.Pool
comm.Debugf("Waiting for source container")
select {
case walkErr := <-walkErrs:
return errors.Wrap(walkErr, 1)
case walkies := <-sourceContainerChan:
comm.Debugf("Got sourceContainer!")
sourceContainer = walkies.container
sourcePool = walkies.pool
break
}
comm.Opf("Pushing %s (%s)", humanize.IBytes(uint64(sourceContainer.Size)), sourceContainer.Stats())
comm.Debugf("Building diff context")
var readBytes int64
bytesPerSec := float64(0)
lastUploadedBytes := int64(0)
stopTicking := make(chan struct{})
updateProgress := func() {
uploadedBytes := int64(float64(patchWriter.UploadedBytes))
// input bytes that aren't in output, for example:
// - bytes that have been compressed away
// - bytes that were in old build and were simply reused
goneBytes := readBytes - patchWriter.TotalBytes
conservativeTotalBytes := sourceContainer.Size - goneBytes
leftBytes := conservativeTotalBytes - uploadedBytes
if leftBytes > AlmostThereThreshold {
netStatus := "- network idle"
if bytesPerSec > 1 {
netStatus = fmt.Sprintf("@ %s/s", humanize.IBytes(uint64(bytesPerSec)))
}
comm.ProgressLabel(fmt.Sprintf("%s, %s left", netStatus, humanize.IBytes(uint64(leftBytes))))
} else {
comm.ProgressLabel(fmt.Sprintf("- almost there"))
}
conservativeProgress := float64(uploadedBytes) / float64(conservativeTotalBytes)
conservativeProgress = min(1.0, conservativeProgress)
comm.Progress(conservativeProgress)
comm.ProgressScale(float64(readBytes) / float64(sourceContainer.Size))
}
go func() {
ticker := time.NewTicker(time.Second * time.Duration(2))
for {
select {
case <-ticker.C:
bytesPerSec = float64(patchWriter.UploadedBytes-lastUploadedBytes) / 2.0
lastUploadedBytes = patchWriter.UploadedBytes
updateProgress()
case <-stopTicking:
break
}
}
}()
patchWriter.OnProgress = updateProgress
stateConsumer := &state.Consumer{
OnProgress: func(progress float64) {
readBytes = int64(float64(sourceContainer.Size) * progress)
updateProgress()
},
}
dctx := &pwr.DiffContext{
Compression: &pwr.CompressionSettings{
Algorithm: pwr.CompressionAlgorithm_BROTLI,
Quality: 1,
},
SourceContainer: sourceContainer,
Pool: sourcePool,
TargetContainer: targetSignature.Container,
TargetSignature: targetSignature.Hashes,
Consumer: stateConsumer,
}
comm.StartProgress()
comm.ProgressScale(0.0)
err = dctx.WritePatch(patchCounter, signatureCounter)
if err != nil {
return errors.Wrap(err, 1)
}
// close in a goroutine to avoid deadlocking
doClose := func(c io.Closer, done chan bool, errs chan error) {
closeErr := c.Close()
if closeErr != nil {
errs <- errors.Wrap(closeErr, 1)
return
}
done <- true
}
go doClose(patchWriter, uploadDone, uploadErrs)
go doClose(signatureWriter, uploadDone, uploadErrs)
for c := 0; c < 4; c++ {
select {
case uploadErr := <-uploadErrs:
return errors.Wrap(uploadErr, 1)
case <-uploadDone:
comm.Debugf("upload done")
}
}
close(stopTicking)
comm.ProgressLabel("finalizing build")
finalDone := make(chan bool)
finalErrs := make(chan error)
doFinalize := func(fileID int64, fileSize int64, done chan bool, errs chan error) {
_, err = client.FinalizeBuildFile(buildID, fileID, fileSize)
if err != nil {
errs <- errors.Wrap(err, 1)
return
}
done <- true
}
go doFinalize(newPatchRes.File.ID, patchCounter.Count(), finalDone, finalErrs)
go doFinalize(newSignatureRes.File.ID, signatureCounter.Count(), finalDone, finalErrs)
for i := 0; i < 2; i++ {
select {
case err := <-finalErrs:
return errors.Wrap(err, 1)
case <-finalDone:
}
}
comm.EndProgress()
{
prettyPatchSize := humanize.IBytes(uint64(patchCounter.Count()))
percReused := 100.0 * float64(dctx.ReusedBytes) / float64(dctx.FreshBytes+dctx.ReusedBytes)
relToNew := 100.0 * float64(patchCounter.Count()) / float64(sourceContainer.Size)
prettyFreshSize := humanize.IBytes(uint64(dctx.FreshBytes))
savings := 100.0 - relToNew
if dctx.ReusedBytes > 0 {
comm.Statf("Re-used %.2f%% of old, added %s fresh data", percReused, prettyFreshSize)
} else {
comm.Statf("Added %s fresh data", prettyFreshSize)
}
if savings > 0 && !math.IsNaN(savings) {
comm.Statf("%s patch (%.2f%% savings)", prettyPatchSize, 100.0-relToNew)
} else {
comm.Statf("%s patch (no savings)", prettyPatchSize)
}
}
comm.Opf("Build is now processing, should be up in a bit (see `butler status`)")
comm.Logf("")
return nil
}
func doApply(patch string, target string, output string, inplace bool, signaturePath string, woundsPath string) error {
if output == "" {
output = target
}
target = path.Clean(target)
output = path.Clean(output)
if output == target {
if !inplace {
comm.Dief("Refusing to destructively patch %s without --inplace", output)
}
}
if signaturePath == "" {
comm.Opf("Patching %s", output)
} else {
comm.Opf("Patching %s with validation", output)
}
startTime := time.Now()
patchReader, err := eos.Open(patch)
if err != nil {
return errors.Wrap(err, 1)
}
var signature *pwr.SignatureInfo
if signaturePath != "" {
sigReader, sigErr := eos.Open(signaturePath)
if sigErr != nil {
return errors.Wrap(sigErr, 1)
}
defer sigReader.Close()
signature, sigErr = pwr.ReadSignature(sigReader)
if sigErr != nil {
return errors.Wrap(sigErr, 1)
}
}
actx := &pwr.ApplyContext{
TargetPath: target,
OutputPath: output,
InPlace: inplace,
Signature: signature,
WoundsPath: woundsPath,
Consumer: comm.NewStateConsumer(),
}
comm.StartProgress()
err = actx.ApplyPatch(patchReader)
if err != nil {
return errors.Wrap(err, 1)
}
comm.EndProgress()
container := actx.SourceContainer
prettySize := humanize.IBytes(uint64(container.Size))
perSecond := humanize.IBytes(uint64(float64(container.Size) / time.Since(startTime).Seconds()))
if actx.InPlace {
statStr := ""
if actx.Stats.TouchedFiles > 0 {
statStr += fmt.Sprintf("patched %d, ", actx.Stats.TouchedFiles)
}
if actx.Stats.MovedFiles > 0 {
statStr += fmt.Sprintf("renamed %d, ", actx.Stats.MovedFiles)
}
if actx.Stats.DeletedFiles > 0 {
statStr += fmt.Sprintf("deleted %d, ", actx.Stats.DeletedFiles)
}
comm.Statf("%s (%s stage)", statStr, humanize.IBytes(uint64(actx.Stats.StageSize)))
}
comm.Statf("%s (%s) @ %s/s\n", prettySize, container.Stats(), perSecond)
if actx.WoundsConsumer != nil && actx.WoundsConsumer.HasWounds() {
extra := ""
if actx.WoundsPath != "" {
extra = fmt.Sprintf(" (written to %s)", actx.WoundsPath)
}
totalCorrupted := actx.WoundsConsumer.TotalCorrupted()
comm.Logf("Result has wounds, %s corrupted data%s", humanize.IBytes(uint64(totalCorrupted)), extra)
}
return nil
}
func TestAllTheThings(t *testing.T) {
perm := os.FileMode(0777)
workingDir, err := ioutil.TempDir("", "butler-tests")
mist(t, err)
defer os.RemoveAll(workingDir)
sample := path.Join(workingDir, "sample")
mist(t, os.MkdirAll(sample, perm))
mist(t, ioutil.WriteFile(path.Join(sample, "hello.txt"), []byte("hello!"), perm))
sample2 := path.Join(workingDir, "sample2")
mist(t, os.MkdirAll(sample2, perm))
for i := 0; i < 5; i++ {
if i == 3 {
// e.g. .gitkeep
putfile(t, sample2, i, []byte{})
} else {
putfile(t, sample2, i, bytes.Repeat([]byte{0x42, 0x69}, i*200+1))
}
}
sample3 := path.Join(workingDir, "sample3")
mist(t, os.MkdirAll(sample3, perm))
for i := 0; i < 60; i++ {
putfile(t, sample3, i, bytes.Repeat([]byte{0x42, 0x69}, i*300+1))
}
sample4 := path.Join(workingDir, "sample4")
mist(t, os.MkdirAll(sample4, perm))
for i := 0; i < 120; i++ {
putfile(t, sample4, i, bytes.Repeat([]byte{0x42, 0x69}, i*150+1))
}
sample5 := path.Join(workingDir, "sample5")
mist(t, os.MkdirAll(sample5, perm))
rg := rand.New(rand.NewSource(0x239487))
for i := 0; i < 25; i++ {
l := 1024 * (i + 2)
// our own little twist on fizzbuzz to look out for 1-off errors
if i%5 == 0 {
l = int(pwr.BlockSize)
} else if i%3 == 0 {
l = 0
}
buf := make([]byte, l)
_, err := io.CopyN(bytes.NewBuffer(buf), rg, int64(l))
mist(t, err)
putfile(t, sample5, i, buf)
}
files := map[string]string{
"hello": sample,
"80-fixed": sample2,
"60-fixed": sample3,
"120-fixed": sample4,
"random": sample5,
"null": "/dev/null",
}
patch := path.Join(workingDir, "patch.pwr")
comm.Configure(true, true, false, false, false, false, false)
for _, q := range []int{1, 9} {
t.Logf("============ Quality %d ============", q)
compression := pwr.CompressionSettings{
Algorithm: pwr.CompressionAlgorithm_BROTLI,
Quality: int32(q),
}
for lhs := range files {
for rhs := range files {
mist(t, doDiff(files[lhs], files[rhs], patch, compression))
stat, err := os.Lstat(patch)
mist(t, err)
t.Logf("%10s -> %10s = %s", lhs, rhs, humanize.IBytes(uint64(stat.Size())))
}
}
}
compression := pwr.CompressionSettings{
Algorithm: pwr.CompressionAlgorithm_BROTLI,
Quality: 1,
}
for _, filepath := range files {
t.Logf("Signing %s\n", filepath)
sigPath := path.Join(workingDir, "signature.pwr.sig")
mist(t, doSign(filepath, sigPath, compression, false))
sigReader, err := eos.Open(sigPath)
mist(t, err)
signature, err := pwr.ReadSignature(sigReader)
mist(t, err)
mist(t, sigReader.Close())
validator := &pwr.ValidatorContext{
FailFast: true,
}
mist(t, validator.Validate(filepath, signature))
}
// K windows you just sit this one out we'll catch you on the flip side
if runtime.GOOS != "windows" {
// In-place preserve permissions tests
t.Logf("In-place patching should preserve permissions")
eperm := os.FileMode(0750)
samplePerm1 := path.Join(workingDir, "samplePerm1")
mist(t, os.MkdirAll(samplePerm1, perm))
putfileEx(t, samplePerm1, 1, bytes.Repeat([]byte{0x42, 0x69}, 8192), eperm)
assert.Equal(t, octal(eperm), octal(permFor(t, path.Join(samplePerm1, "dummy1.dat"))))
samplePerm2 := path.Join(workingDir, "samplePerm2")
mist(t, os.MkdirAll(samplePerm2, perm))
putfileEx(t, samplePerm2, 1, bytes.Repeat([]byte{0x69, 0x42}, 16384), eperm)
assert.Equal(t, octal(eperm), octal(permFor(t, path.Join(samplePerm2, "dummy1.dat"))))
mist(t, doDiff(samplePerm1, samplePerm2, patch, compression))
_, err := os.Lstat(patch)
mist(t, err)
cave := path.Join(workingDir, "cave")
ditto(samplePerm1, cave)
mist(t, doApply(patch, cave, cave, true, "", ""))
assert.Equal(t, octal(eperm|pwr.ModeMask), octal(permFor(t, path.Join(cave, "dummy1.dat"))))
}
}
func doDiff(target string, source string, patch string, compression pwr.CompressionSettings) error {
var err error
startTime := time.Now()
targetSignature := &pwr.SignatureInfo{}
targetSignature.Container, err = tlc.WalkAny(target, filterPaths)
if err != nil {
// Signature file perhaps?
var signatureReader io.ReadCloser
signatureReader, err = eos.Open(target)
if err != nil {
return errors.Wrap(err, 1)
}
targetSignature, err = pwr.ReadSignature(signatureReader)
if err != nil {
if errors.Is(err, wire.ErrFormat) {
return fmt.Errorf("unrecognized target %s (not a container, not a signature file)", target)
}
return errors.Wrap(err, 1)
}
comm.Opf("Read signature from %s", target)
err = signatureReader.Close()
if err != nil {
return errors.Wrap(err, 1)
}
} else {
// Container (dir, archive, etc.)
comm.Opf("Hashing %s", target)
comm.StartProgress()
var targetPool wsync.Pool
targetPool, err = pools.New(targetSignature.Container, target)
if err != nil {
return errors.Wrap(err, 1)
}
targetSignature.Hashes, err = pwr.ComputeSignature(targetSignature.Container, targetPool, comm.NewStateConsumer())
comm.EndProgress()
if err != nil {
return errors.Wrap(err, 1)
}
{
prettySize := humanize.IBytes(uint64(targetSignature.Container.Size))
perSecond := humanize.IBytes(uint64(float64(targetSignature.Container.Size) / time.Since(startTime).Seconds()))
comm.Statf("%s (%s) @ %s/s\n", prettySize, targetSignature.Container.Stats(), perSecond)
}
}
startTime = time.Now()
var sourceContainer *tlc.Container
sourceContainer, err = tlc.WalkAny(source, filterPaths)
if err != nil {
return errors.Wrap(err, 1)
}
var sourcePool wsync.Pool
sourcePool, err = pools.New(sourceContainer, source)
if err != nil {
return errors.Wrap(err, 1)
}
patchWriter, err := os.Create(patch)
if err != nil {
return errors.Wrap(err, 1)
}
defer patchWriter.Close()
signaturePath := patch + ".sig"
signatureWriter, err := os.Create(signaturePath)
if err != nil {
return errors.Wrap(err, 1)
}
defer signatureWriter.Close()
patchCounter := counter.NewWriter(patchWriter)
signatureCounter := counter.NewWriter(signatureWriter)
dctx := &pwr.DiffContext{
SourceContainer: sourceContainer,
Pool: sourcePool,
TargetContainer: targetSignature.Container,
TargetSignature: targetSignature.Hashes,
Consumer: comm.NewStateConsumer(),
Compression: &compression,
}
comm.Opf("Diffing %s", source)
comm.StartProgress()
err = dctx.WritePatch(patchCounter, signatureCounter)
if err != nil {
return errors.Wrap(err, 1)
}
comm.EndProgress()
totalDuration := time.Since(startTime)
{
prettySize := humanize.IBytes(uint64(sourceContainer.Size))
perSecond := humanize.IBytes(uint64(float64(sourceContainer.Size) / totalDuration.Seconds()))
comm.Statf("%s (%s) @ %s/s\n", prettySize, sourceContainer.Stats(), perSecond)
}
if *diffArgs.verify {
tmpDir, err := ioutil.TempDir("", "pwr")
if err != nil {
return errors.Wrap(err, 1)
}
defer os.RemoveAll(tmpDir)
apply(patch, target, tmpDir, false, signaturePath, "")
}
{
prettyPatchSize := humanize.IBytes(uint64(patchCounter.Count()))
percReused := 100.0 * float64(dctx.ReusedBytes) / float64(dctx.FreshBytes+dctx.ReusedBytes)
relToNew := 100.0 * float64(patchCounter.Count()) / float64(sourceContainer.Size)
prettyFreshSize := humanize.IBytes(uint64(dctx.FreshBytes))
comm.Statf("Re-used %.2f%% of old, added %s fresh data", percReused, prettyFreshSize)
comm.Statf("%s patch (%.2f%% of the full size) in %s", prettyPatchSize, relToNew, totalDuration)
}
return nil
}