forked from bufbuild/buf
-
Notifications
You must be signed in to change notification settings - Fork 0
/
tmp.go
179 lines (158 loc) · 3.75 KB
/
tmp.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
// Copyright 2020-2023 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 tmp provides temporary files and directories.
//
// Usage of this package requires eng approval - ask before using.
package tmp
import (
"io"
"os"
"path/filepath"
"github.com/xiaoyawei/buf/private/pkg/interrupt"
"github.com/xiaoyawei/buf/private/pkg/uuidutil"
"go.uber.org/multierr"
)
// File is a temporary file
//
// It must be closed when done.
type File interface {
io.Closer
AbsPath() string
}
// NewFileWithData returns a new temporary file with the given data.
//
// It must be closed when done.
// This file will be deleted on interrupt signals.
//
// Usage of this function requires eng approval - ask before using.
func NewFileWithData(data []byte) (File, error) {
id, err := uuidutil.New()
if err != nil {
return nil, err
}
file, err := os.CreateTemp("", id.String())
if err != nil {
return nil, err
}
path := file.Name()
// just in case
absPath, err := filepath.Abs(filepath.Clean(path))
if err != nil {
return nil, err
}
signalC, closer := interrupt.NewSignalChannel()
go func() {
<-signalC
_ = os.Remove(absPath)
}()
_, err = file.Write(data)
err = multierr.Append(err, file.Close())
if err != nil {
err = multierr.Append(err, os.Remove(absPath))
closer()
return nil, err
}
return newFile(absPath, closer), nil
}
// Dir is a temporary directory.
//
// It must be closed when done.
type Dir interface {
io.Closer
AbsPath() string
}
// NewDir returns a new temporary directory.
//
// It must be closed when done.
// This file will be deleted on interrupt signals.
//
// Usage of this function requires eng approval - ask before using.
func NewDir(options ...DirOption) (Dir, error) {
dirOptions := newDirOptions()
for _, option := range options {
option(dirOptions)
}
id, err := uuidutil.New()
if err != nil {
return nil, err
}
path, err := os.MkdirTemp(dirOptions.basePath, id.String())
if err != nil {
return nil, err
}
// just in case
absPath, err := filepath.Abs(filepath.Clean(path))
if err != nil {
return nil, err
}
signalC, closer := interrupt.NewSignalChannel()
go func() {
<-signalC
_ = os.RemoveAll(absPath)
}()
return newDir(absPath, closer), nil
}
// DirOption is an option for NewDir.
type DirOption func(*dirOptions)
// DirWithBasePath returns a new DirOption that sets the base path to create
// the temporary directory in.
//
// The default is to use os.TempDir().
func DirWithBasePath(basePath string) DirOption {
return func(dirOptions *dirOptions) {
dirOptions.basePath = basePath
}
}
type file struct {
absPath string
closer func()
}
func newFile(absPath string, closer func()) *file {
return &file{
absPath: absPath,
closer: closer,
}
}
func (f *file) AbsPath() string {
return f.absPath
}
func (f *file) Close() error {
err := os.Remove(f.absPath)
f.closer()
return err
}
type dir struct {
absPath string
closer func()
}
func newDir(absPath string, closer func()) *dir {
return &dir{
absPath: absPath,
closer: closer,
}
}
func (d *dir) AbsPath() string {
return d.absPath
}
func (d *dir) Close() error {
err := os.RemoveAll(d.absPath)
d.closer()
return err
}
type dirOptions struct {
basePath string
}
func newDirOptions() *dirOptions {
return &dirOptions{}
}