-
Notifications
You must be signed in to change notification settings - Fork 265
/
storagearchive.go
261 lines (249 loc) · 6.34 KB
/
storagearchive.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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
// Copyright 2020-2022 Buf Technologies, Inc.
//
// 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 storagearchive implements archive utilities.
package storagearchive
import (
"archive/tar"
"context"
"errors"
"fmt"
"io"
"math"
"github.com/bufbuild/buf/private/pkg/normalpath"
"github.com/bufbuild/buf/private/pkg/storage"
"github.com/bufbuild/buf/private/pkg/storage/storageutil"
"github.com/klauspost/compress/zip"
"go.uber.org/multierr"
)
var (
// ErrFileSizeLimit is returned when file read limit is reached.
//
// See [WithMaxFileSizeUntarOption]
ErrFileSizeLimit = errors.New("file size exceeded read limit")
)
// Tar tars the given bucket to the writer.
//
// Only regular files are added to the writer.
// All files are written as 0644.
func Tar(
ctx context.Context,
readBucket storage.ReadBucket,
writer io.Writer,
) (retErr error) {
tarWriter := tar.NewWriter(writer)
defer func() {
retErr = multierr.Append(retErr, tarWriter.Close())
}()
return storage.WalkReadObjects(
ctx,
readBucket,
"",
func(readObject storage.ReadObject) error {
data, err := io.ReadAll(readObject)
if err != nil {
return err
}
if err := tarWriter.WriteHeader(
&tar.Header{
Typeflag: tar.TypeReg,
Name: readObject.Path(),
Size: int64(len(data)),
// If we ever use this outside of testing, we will want to do something about this
Mode: 0644,
},
); err != nil {
return err
}
_, err = tarWriter.Write(data)
return err
},
)
}
// Untar untars the given tar archive from the reader into the bucket.
//
// Only regular files are added to the bucket.
//
// Paths from the tar archive will be mapped before adding to the bucket.
// Mapper can be nil.
// StripComponents happens before the mapper.
func Untar(
ctx context.Context,
reader io.Reader,
writeBucket storage.WriteBucket,
mapper storage.Mapper,
stripComponentCount uint32,
opts ...UntarOption,
) error {
options := &untarOptions{
maxFileSize: math.MaxInt64,
}
for _, opt := range opts {
opt.applyUntar(options)
}
tarReader := tar.NewReader(reader)
walkChecker := storageutil.NewWalkChecker()
for tarHeader, err := tarReader.Next(); err != io.EOF; tarHeader, err = tarReader.Next() {
if err != nil {
return err
}
if err := walkChecker.Check(ctx); err != nil {
return err
}
if tarHeader.Size < 0 {
return fmt.Errorf("invalid size for tar file %s: %d", tarHeader.Name, tarHeader.Size)
}
if tarHeader.Size > options.maxFileSize {
return fmt.Errorf("%w %s:%d", ErrFileSizeLimit, tarHeader.Name, tarHeader.Size)
}
path, ok, err := unmapArchivePath(tarHeader.Name, mapper, stripComponentCount)
if err != nil {
return err
}
if !ok || !tarHeader.FileInfo().Mode().IsRegular() {
continue
}
if err := storage.CopyReader(ctx, writeBucket, tarReader, path); err != nil {
return err
}
}
return nil
}
// UntarOption is an option for [Untar].
type UntarOption interface {
applyUntar(*untarOptions)
}
// WithMaxFileSizeUntarOption returns an option that limits the maximum size
func WithMaxFileSizeUntarOption(size int) UntarOption {
return &withMaxFileSizeUntarOption{maxFileSize: int64(size)}
}
// Zip zips the given bucket to the writer.
//
// Only regular files are added to the writer.
func Zip(
ctx context.Context,
readBucket storage.ReadBucket,
writer io.Writer,
compressed bool,
) (retErr error) {
zipWriter := zip.NewWriter(writer)
defer func() {
retErr = multierr.Append(retErr, zipWriter.Close())
}()
return storage.WalkReadObjects(
ctx,
readBucket,
"",
func(readObject storage.ReadObject) error {
method := zip.Store
if compressed {
method = zip.Deflate
}
header := &zip.FileHeader{
Name: readObject.Path(),
Method: method,
}
writer, err := zipWriter.CreateHeader(header)
if err != nil {
return err
}
_, err = io.Copy(writer, readObject)
return err
},
)
}
// Unzip unzips the given zip archive from the reader into the bucket.
//
// Only regular files are added to the bucket.
//
// Paths from the zip archive will be mapped before adding to the bucket.
// Mapper can be nil.
// StripComponents happens before the mapper.
func Unzip(
ctx context.Context,
readerAt io.ReaderAt,
size int64,
writeBucket storage.WriteBucket,
mapper storage.Mapper,
stripComponentCount uint32,
) error {
if size < 0 {
return fmt.Errorf("unknown size to unzip: %d", int(size))
}
if size == 0 {
return nil
}
zipReader, err := zip.NewReader(readerAt, size)
if err != nil {
return err
}
walkChecker := storageutil.NewWalkChecker()
// reads can be done concurrently in the future
for _, zipFile := range zipReader.File {
if err := walkChecker.Check(ctx); err != nil {
return err
}
path, ok, err := unmapArchivePath(zipFile.Name, mapper, stripComponentCount)
if err != nil {
return err
}
if !ok {
continue
}
if zipFile.FileInfo().Mode().IsRegular() {
if err := copyZipFile(ctx, writeBucket, zipFile, path); err != nil {
return err
}
}
}
return nil
}
func copyZipFile(
ctx context.Context,
writeBucket storage.WriteBucket,
zipFile *zip.File,
path string,
) (retErr error) {
readCloser, err := zipFile.Open()
if err != nil {
return err
}
defer func() {
retErr = multierr.Append(retErr, readCloser.Close())
}()
return storage.CopyReader(ctx, writeBucket, readCloser, path)
}
func unmapArchivePath(
archivePath string,
mapper storage.Mapper,
stripComponentCount uint32,
) (string, bool, error) {
if archivePath == "" {
return "", false, errors.New("empty archive file name")
}
fullPath, err := normalpath.NormalizeAndValidate(archivePath)
if err != nil {
return "", false, err
}
if fullPath == "." {
return "", false, nil
}
fullPath, ok := normalpath.StripComponents(fullPath, stripComponentCount)
if !ok {
return "", false, nil
}
if mapper != nil {
return mapper.UnmapFullPath(fullPath)
}
return fullPath, true, nil
}