/
tar_archiver.go
131 lines (117 loc) · 3.34 KB
/
tar_archiver.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
// Copyright 2016 The LUCI Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package archiver
import (
"archive/tar"
"crypto"
"io"
"os"
"sort"
"go.chromium.org/luci/common/iotools"
"go.chromium.org/luci/common/isolated"
)
// osOpen wraps os.Open to allow faking out during tests.
var osOpen = func(name string) (io.ReadCloser, error) {
return os.Open(name)
}
// itemBundle is a slice of *Item that will be archived together.
type itemBundle struct {
items []*Item
// itemSize is the total size (in bytes) of the constituent files. It will be
// smaller than the resultant tar.
itemSize int64
}
// shardItems shards the provided items into itemBundles, using the provided
// threshold as the maximum size the resultant tars should be.
//
// shardItems does not access the filesystem.
func shardItems(items []*Item, threshold int64) []*itemBundle {
// For deterministic isolated hashes, sort the items by path.
sort.Sort(itemByPath(items))
var out []*itemBundle
// Two trailing blank 512-byte records.
tarSize := int64(1024)
bundle := &itemBundle{}
for _, item := range items {
// The in-tar size of the file (512 header + rounded up to nearest 512).
n := (item.Size + 1023) & ^511
if tarSize+n > threshold {
// The tarfile bundle is large enough, cut it off and start a new one.
if len(bundle.items) != 0 {
out = append(out, bundle)
bundle = &itemBundle{}
tarSize = 1024
}
}
tarSize += n
bundle.items = append(bundle.items, item)
bundle.itemSize += item.Size
}
if len(bundle.items) != 0 {
out = append(out, bundle)
}
return out
}
// Digest returns the hash and total size of the tar constructed from the
// bundle's items.
func (b *itemBundle) Digest(h crypto.Hash) (isolated.HexDigest, int64, error) {
a := h.New()
cw := &iotools.CountingWriter{Writer: a}
if err := b.writeTar(cw); err != nil {
return "", 0, err
}
return isolated.Sum(a), cw.Count, nil
}
// Contents returns an io.ReadCloser containing the tar's contents.
func (b *itemBundle) Contents() (io.ReadCloser, error) {
pr, pw := io.Pipe()
go func() {
pw.CloseWithError(b.writeTar(pw))
}()
return pr, nil
}
func (b *itemBundle) writeTar(w io.Writer) error {
tw := tar.NewWriter(w)
for _, item := range b.items {
if err := tw.WriteHeader(&tar.Header{
Name: item.RelPath,
Mode: int64(item.Mode),
Typeflag: tar.TypeReg,
Size: item.Size,
}); err != nil {
return err
}
file, err := osOpen(item.Path)
if err != nil {
return err
}
_, err = io.Copy(tw, file)
file.Close()
if err != nil {
return err
}
}
return tw.Close()
}
// itemByPath implements sort.Interface through path-based comparison.
type itemByPath []*Item
func (s itemByPath) Len() int {
return len(s)
}
func (s itemByPath) Swap(i, j int) {
s[i], s[j] = s[j], s[i]
}
func (s itemByPath) Less(i, j int) bool {
return s[i].RelPath < s[j].RelPath
}