/
packages.go
302 lines (284 loc) · 8.24 KB
/
packages.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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
// Copyright 2015 The Vanadium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Package packages provides functionality to install ZIP and TAR packages.
package packages
import (
"archive/tar"
"archive/zip"
"compress/bzip2"
"compress/gzip"
"encoding/json"
"io"
"io/ioutil"
"os"
"path/filepath"
"strings"
"v.io/v23/services/repository"
"v.io/v23/verror"
)
const (
defaultType = "application/octet-stream"
createDirMode = 0755
createFileMode = 0644
)
var typemap = map[string]repository.MediaInfo{
".zip": repository.MediaInfo{Type: "application/zip"},
".tar": repository.MediaInfo{Type: "application/x-tar"},
".tgz": repository.MediaInfo{Type: "application/x-tar", Encoding: "gzip"},
".tar.gz": repository.MediaInfo{Type: "application/x-tar", Encoding: "gzip"},
".tbz2": repository.MediaInfo{Type: "application/x-tar", Encoding: "bzip2"},
".tb2": repository.MediaInfo{Type: "application/x-tar", Encoding: "bzip2"},
".tbz": repository.MediaInfo{Type: "application/x-tar", Encoding: "bzip2"},
".tar.bz2": repository.MediaInfo{Type: "application/x-tar", Encoding: "bzip2"},
}
const pkgPath = "v.io/x/ref/services/internal/packages"
var (
errBadMediaType = verror.Register(pkgPath+".errBadMediaType", verror.NoRetry, "{1:}{2:} unsupported media type{:_}")
errMkDirFailed = verror.Register(pkgPath+".errMkDirFailed", verror.NoRetry, "{1:}{2:} os.Mkdir({3}) failed{:_}")
errFailedToExtract = verror.Register(pkgPath+".errFailedToExtract", verror.NoRetry, "{1:}{2:} failed to extract file {3} outside of install directory{:_}")
errBadFileSize = verror.Register(pkgPath+".errBadFileSize", verror.NoRetry, "{1:}{2:} file size doesn't match for {3}: {4} != {5}{:_}")
errBadEncoding = verror.Register(pkgPath+".errBadEncoding", verror.NoRetry, "{1:}{2:} unsupported encoding{:_}")
)
// MediaInfoFile returns the name of the file where the media info is stored for
// the given package file.
func MediaInfoFile(pkgFile string) string {
const mediaInfoFileSuffix = ".__info"
return pkgFile + mediaInfoFileSuffix
}
// MediaInfoForFileName returns the MediaInfo based on the file's extension.
func MediaInfoForFileName(fileName string) repository.MediaInfo {
fileName = strings.ToLower(fileName)
for k, v := range typemap {
if strings.HasSuffix(fileName, k) {
return v
}
}
return repository.MediaInfo{Type: defaultType}
}
func copyFile(src, dst string) error {
s, err := os.Open(src)
if err != nil {
return err
}
defer s.Close()
d, err := os.OpenFile(dst, os.O_CREATE|os.O_WRONLY, createFileMode)
if err != nil {
return err
}
defer d.Close()
if _, err = io.Copy(d, s); err != nil {
return err
}
return d.Sync()
}
// Install installs a package in the given destination. If the package is a TAR
// or ZIP archive, the destination becomes a directory where the archive content
// is extracted. Otherwise, the destination is hard-linked to the package (or
// copied if hard link is not possible).
func Install(pkgFile, destination string) error {
mediaInfo, err := LoadMediaInfo(pkgFile)
if err != nil {
return err
}
switch mediaInfo.Type {
case "application/x-tar":
return extractTar(pkgFile, mediaInfo.Encoding, destination)
case "application/zip":
return extractZip(pkgFile, destination)
case defaultType, "text/plain":
if err := os.Link(pkgFile, destination); err != nil {
// Can't create hard link (e.g., different filesystem).
return copyFile(pkgFile, destination)
}
return nil
default:
// TODO(caprita): Instead of throwing an error, why not just
// handle things with os.Link(pkgFile, destination) as the two
// cases above?
return verror.New(errBadMediaType, nil, mediaInfo.Type)
}
}
// LoadMediaInfo returns the MediaInfo for the given package file.
func LoadMediaInfo(pkgFile string) (repository.MediaInfo, error) {
jInfo, err := ioutil.ReadFile(MediaInfoFile(pkgFile))
if err != nil {
return repository.MediaInfo{}, err
}
var info repository.MediaInfo
if err := json.Unmarshal(jInfo, &info); err != nil {
return repository.MediaInfo{}, err
}
return info, nil
}
// SaveMediaInfo saves the media info for a package.
func SaveMediaInfo(pkgFile string, mediaInfo repository.MediaInfo) error {
jInfo, err := json.Marshal(mediaInfo)
if err != nil {
return err
}
infoFile := MediaInfoFile(pkgFile)
if err := ioutil.WriteFile(infoFile, jInfo, os.FileMode(0600)); err != nil {
return err
}
return nil
}
// CreateZip creates a package from the files in the source directory. The
// created package is a Zip file.
func CreateZip(zipFile, sourceDir string) error {
z, err := os.OpenFile(zipFile, os.O_CREATE|os.O_WRONLY, os.FileMode(0644))
if err != nil {
return err
}
defer z.Close()
w := zip.NewWriter(z)
if err := filepath.Walk(sourceDir, func(path string, info os.FileInfo, err error) error {
if err != nil {
return err
}
if sourceDir == path {
return nil
}
fh, err := zip.FileInfoHeader(info)
if err != nil {
return err
}
fh.Method = zip.Deflate
fh.Name, _ = filepath.Rel(sourceDir, path)
hdr, err := w.CreateHeader(fh)
if err != nil {
return err
}
if !info.IsDir() {
content, err := ioutil.ReadFile(path)
if err != nil {
return err
}
if _, err = hdr.Write(content); err != nil {
return err
}
}
return nil
}); err != nil {
return err
}
if err := w.Close(); err != nil {
return err
}
if err := SaveMediaInfo(zipFile, repository.MediaInfo{Type: "application/zip"}); err != nil {
return err
}
return nil
}
func extractZip(zipFile, installDir string) error {
if err := os.Mkdir(installDir, os.FileMode(createDirMode)); err != nil {
return verror.New(errMkDirFailed, nil, installDir, err)
}
zr, err := zip.OpenReader(zipFile)
if err != nil {
return err
}
for _, file := range zr.File {
fi := file.FileInfo()
name := filepath.Join(installDir, file.Name)
if !strings.HasPrefix(name, installDir) {
return verror.New(errFailedToExtract, nil, file.Name)
}
if fi.IsDir() {
if err := os.MkdirAll(name, os.FileMode(createDirMode)); err != nil && !os.IsExist(err) {
return err
}
continue
}
in, err := file.Open()
if err != nil {
return err
}
parentName := filepath.Dir(name)
if err := os.MkdirAll(parentName, os.FileMode(createDirMode)); err != nil {
return err
}
out, err := os.OpenFile(name, os.O_CREATE|os.O_WRONLY, os.FileMode(createFileMode))
if err != nil {
in.Close()
return err
}
nbytes, err := io.Copy(out, in)
in.Close()
out.Close()
if err != nil {
return err
}
if nbytes != fi.Size() {
return verror.New(errBadFileSize, nil, fi.Name(), nbytes, fi.Size())
}
}
return nil
}
func extractTar(pkgFile string, encoding string, installDir string) error {
if err := os.Mkdir(installDir, os.FileMode(createDirMode)); err != nil {
return verror.New(errMkDirFailed, nil, installDir, err)
}
f, err := os.Open(pkgFile)
if err != nil {
return err
}
defer f.Close()
var reader io.Reader
switch encoding {
case "":
reader = f
case "gzip":
var err error
if reader, err = gzip.NewReader(f); err != nil {
return err
}
case "bzip2":
reader = bzip2.NewReader(f)
default:
return verror.New(errBadEncoding, nil, encoding)
}
tr := tar.NewReader(reader)
for {
hdr, err := tr.Next()
if err == io.EOF {
return nil
}
if err != nil {
return err
}
name := filepath.Join(installDir, hdr.Name)
if !strings.HasPrefix(name, installDir) {
return verror.New(errFailedToExtract, nil, hdr.Name)
}
// Regular file
if hdr.Typeflag == tar.TypeReg {
parentName := filepath.Dir(name)
if err := os.MkdirAll(parentName, os.FileMode(createDirMode)); err != nil {
return err
}
out, err := os.OpenFile(name, os.O_CREATE|os.O_WRONLY, os.FileMode(createFileMode))
if err != nil {
return err
}
nbytes, err := io.Copy(out, tr)
out.Close()
if err != nil {
return err
}
if nbytes != hdr.Size {
return verror.New(errBadFileSize, nil, hdr.Name, nbytes, hdr.Size)
}
continue
}
// Directory
if hdr.Typeflag == tar.TypeDir {
if err := os.MkdirAll(name, os.FileMode(createDirMode)); err != nil && !os.IsExist(err) {
return err
}
continue
}
// Skip unsupported types
// TODO(rthellend): Consider adding support for Symlink.
}
}