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
|
package zip
import (
"archive/zip"
"context"
"errors"
"fmt"
"io"
"os"
"path/filepath"
"strings"
"sync"
"time"
log "github.com/sirupsen/logrus"
"gitlab.com/gitlab-org/gitlab-pages/internal/httprange"
"gitlab.com/gitlab-org/gitlab-pages/internal/vfs"
"gitlab.com/gitlab-org/gitlab-pages/metrics"
)
const (
dirPrefix = "public/"
maxSymlinkSize = 256
// DefaultOpenTimeout to request an archive and read its contents the first time
DefaultOpenTimeout = 30 * time.Second
)
var (
errNotSymlink = errors.New("not a symlink")
errSymlinkSize = errors.New("symlink too long")
)
// zipArchive implements the vfs.Root interface.
// It represents a zip archive saving all its files in memory.
// It holds an httprange.Resource that can be read with httprange.RangedReader in chunks.
type zipArchive struct {
path string
once sync.Once
done chan struct{}
openTimeout time.Duration
resource *httprange.Resource
reader *httprange.RangedReader
archive *zip.Reader
err error
// TODO: add metrics https://gitlab.com/gitlab-org/gitlab-pages/-/issues/423
files map[string]*zip.File
}
func newArchive(path string, openTimeout time.Duration) *zipArchive {
return &zipArchive{
path: path,
done: make(chan struct{}),
files: make(map[string]*zip.File),
openTimeout: openTimeout,
}
}
func (a *zipArchive) openArchive(parentCtx context.Context) error {
// return early if openArchive was done already in a concurrent request
select {
case <-a.done:
return a.err
default:
}
ctx, cancel := context.WithTimeout(parentCtx, a.openTimeout)
defer cancel()
a.once.Do(func() {
// read archive once in its own routine with its own timeout
// if parentCtx is canceled, readArchive will continue regardless and will be cached in memory
go a.readArchive()
})
// wait for readArchive to be done or return if the parent context is canceled
select {
case <-a.done:
return a.err
case <-ctx.Done():
err := ctx.Err()
switch err {
case context.Canceled:
log.WithError(err).Traceln("open zip archive request canceled")
case context.DeadlineExceeded:
log.WithError(err).Traceln("open zip archive timed out")
}
return err
}
}
// readArchive creates an httprange.Resource that can read the archive's contents and stores a slice of *zip.Files
// that can be accessed later when calling any of th vfs.VFS operations
func (a *zipArchive) readArchive() {
defer close(a.done)
// readArchive with a timeout separate from openArchive's
ctx, cancel := context.WithTimeout(context.Background(), a.openTimeout)
defer cancel()
a.resource, a.err = httprange.NewResource(ctx, a.path)
if a.err != nil {
return
}
// load all archive files into memory using a cached ranged reader
a.reader = httprange.NewRangedReader(a.resource)
a.reader.WithCachedReader(ctx, func() {
a.archive, a.err = zip.NewReader(a.reader, a.resource.Size)
})
if a.archive == nil {
return
}
// TODO: Improve preprocessing of zip archives https://gitlab.com/gitlab-org/gitlab-pages/-/issues/432
for _, file := range a.archive.File {
if !strings.HasPrefix(file.Name, dirPrefix) {
continue
}
a.files[file.Name] = file
}
// recycle memory
a.archive.File = nil
metrics.ZipServingFilesPerArchiveCount.Observe(float64(len(a.files)))
metrics.ZipServingOpenArchivesTotal.Inc()
}
func (a *zipArchive) findFile(name string) *zip.File {
name = filepath.Join(dirPrefix, name)
if file := a.files[name]; file != nil {
return file
}
if dir := a.files[name+"/"]; dir != nil {
return dir
}
return nil
}
// Open finds the file by name inside the zipArchive and returns a reader that can be served by the VFS
func (a *zipArchive) Open(ctx context.Context, name string) (vfs.File, error) {
file := a.findFile(name)
if file == nil {
return nil, os.ErrNotExist
}
// TODO: cache dataOffsets of files https://gitlab.com/gitlab-org/gitlab-pages/-/issues/461
dataOffset, err := file.DataOffset()
if err != nil {
return nil, err
}
// only read from dataOffset up to the size of the compressed file
reader := a.reader.SectionReader(ctx, dataOffset, int64(file.CompressedSize64))
switch file.Method {
case zip.Deflate:
return newDeflateReader(reader), nil
case zip.Store:
return reader, nil
default:
return nil, fmt.Errorf("unsupported compression method: %x", file.Method)
}
}
// Lstat finds the file by name inside the zipArchive and returns its FileInfo
func (a *zipArchive) Lstat(ctx context.Context, name string) (os.FileInfo, error) {
file := a.findFile(name)
if file == nil {
return nil, os.ErrNotExist
}
return file.FileInfo(), nil
}
// ReadLink finds the file by name inside the zipArchive and returns the contents of the symlink
func (a *zipArchive) Readlink(ctx context.Context, name string) (string, error) {
file := a.findFile(name)
if file == nil {
return "", os.ErrNotExist
}
if file.FileInfo().Mode()&os.ModeSymlink != os.ModeSymlink {
return "", errNotSymlink
}
rc, err := file.Open()
if err != nil {
return "", err
}
defer rc.Close()
symlink := make([]byte, maxSymlinkSize+1)
// read up to len(symlink) bytes from the link file
n, err := io.ReadFull(rc, symlink)
if err != nil && err != io.ErrUnexpectedEOF {
// if err == io.ErrUnexpectedEOF the link is smaller than len(symlink) so it's OK to not return it
return "", err
}
// return errSymlinkSize if the number of bytes read from the link is too big
if n > maxSymlinkSize {
return "", errSymlinkSize
}
// only return the n bytes read from the link
return string(symlink[:n]), nil
}
|