-
Notifications
You must be signed in to change notification settings - Fork 787
/
files.go
567 lines (505 loc) · 13.2 KB
/
files.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
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
package util
import (
"crypto/rand"
"fmt"
"io"
"io/ioutil"
"mime"
"os"
"path/filepath"
"strconv"
"strings"
"time"
"github.com/jenkins-x/jx/v2/pkg/log"
"gopkg.in/AlecAivazis/survey.v1/terminal"
"github.com/pkg/errors"
)
const (
DefaultWritePermissions = 0760
// DefaultFileWritePermissions default permissions when creating a file
DefaultFileWritePermissions = 0644
MaximumNewDirectoryAttempts = 1000
)
// IOFileHandles is a struct for holding CommonOptions' In, Out, and Err I/O handles, to simplify function calls.
type IOFileHandles struct {
Err io.Writer
In terminal.FileReader
Out terminal.FileWriter
}
// FileExists checks if path exists and is a file
func FileExists(path string) (bool, error) {
fileInfo, err := os.Stat(path)
if err == nil {
return !fileInfo.IsDir(), nil
}
if os.IsNotExist(err) {
return false, nil
}
return false, errors.Wrapf(err, "failed to check if file exists %s", path)
}
// DirExists checks if path exists and is a directory
func DirExists(path string) (bool, error) {
info, err := os.Stat(path)
if err == nil {
return info.IsDir(), nil
} else if os.IsNotExist(err) {
return false, nil
}
return false, err
}
// FirstFileExists returns the first file which exists or an error if we can't detect if a file that exists
func FirstFileExists(paths ...string) (string, error) {
for _, path := range paths {
exists, err := FileExists(path)
if err != nil {
return "", err
}
if exists {
return path, nil
}
}
return "", nil
}
// FileIsEmpty checks if a file is empty
func FileIsEmpty(path string) (bool, error) {
fi, err := os.Stat(path)
if err != nil {
return true, errors.Wrapf(err, "getting details of file '%s'", path)
}
return (fi.Size() == 0), nil
}
func IsEmpty(name string) (bool, error) {
f, err := os.Open(name)
if err != nil {
return false, err
}
defer f.Close()
_, err = f.Readdirnames(1) // Or f.Readdir(1)
if err == io.EOF {
return true, nil
}
return false, err // Either not empty or error, suits both cases
}
// CreateUniqueDirectory creates a new directory but if the combination of dir and name exists
// then append a number until a unique name is found
func CreateUniqueDirectory(dir string, name string, maximumAttempts int) (string, error) {
for i := 0; i < maximumAttempts; i++ {
n := name
if i > 0 {
n += strconv.Itoa(i)
}
p := filepath.Join(dir, n)
exists, err := FileExists(p)
if err != nil {
return p, err
}
if !exists {
err := os.MkdirAll(p, DefaultWritePermissions)
if err != nil {
return "", fmt.Errorf("Failed to create directory %s due to %s", p, err)
}
return p, nil
}
}
return "", fmt.Errorf("Could not create a unique file in %s starting with %s after %d attempts", dir, name, maximumAttempts)
}
func RenameDir(src string, dst string, force bool) (err error) {
err = CopyDir(src, dst, force)
if err != nil {
return fmt.Errorf("failed to copy source dir %s to %s: %s", src, dst, err)
}
err = os.RemoveAll(src)
if err != nil {
return fmt.Errorf("failed to cleanup source dir %s: %s", src, err)
}
return nil
}
func RenameFile(src string, dst string) (err error) {
if src == dst {
return nil
}
err = CopyFile(src, dst)
if err != nil {
return fmt.Errorf("failed to copy source file %s to %s: %s", src, dst, err)
}
err = os.RemoveAll(src)
if err != nil {
return fmt.Errorf("failed to cleanup source file %s: %s", src, err)
}
return nil
}
// CopyFileOrDir copies the source file or directory to the given destination
func CopyFileOrDir(src string, dst string, force bool) (err error) {
fi, err := os.Stat(src)
if err != nil {
return errors.Wrapf(err, "getting details of file '%s'", src)
}
if fi.IsDir() {
return CopyDir(src, dst, force)
}
return CopyFile(src, dst)
}
// credit https://gist.github.com/r0l1/92462b38df26839a3ca324697c8cba04
func CopyDir(src string, dst string, force bool) (err error) {
src = filepath.Clean(src)
dst = filepath.Clean(dst)
si, err := os.Stat(src)
if err != nil {
return err
}
if !si.IsDir() {
return fmt.Errorf("source is not a directory")
}
_, err = os.Stat(dst)
if err != nil && !os.IsNotExist(err) {
return
}
if err == nil {
if force {
os.RemoveAll(dst)
} else {
return fmt.Errorf("destination already exists")
}
}
err = os.MkdirAll(dst, si.Mode())
if err != nil {
return
}
entries, err := ioutil.ReadDir(src)
if err != nil {
return
}
for _, entry := range entries {
srcPath := filepath.Join(src, entry.Name())
dstPath := filepath.Join(dst, entry.Name())
if entry.IsDir() {
err = CopyDir(srcPath, dstPath, force)
if err != nil {
return
}
} else {
// Skip symlinks.
if entry.Mode()&os.ModeSymlink != 0 {
continue
}
err = CopyFile(srcPath, dstPath)
if err != nil {
return
}
}
}
return
}
// credit https://gist.github.com/r0l1/92462b38df26839a3ca324697c8cba04
func CopyFile(src, dst string) (err error) {
in, err := os.Open(src)
if err != nil {
return
}
defer in.Close()
out, err := os.Create(dst)
if err != nil {
return
}
defer func() {
if e := out.Close(); e != nil {
err = e
}
}()
_, err = io.Copy(out, in)
if err != nil {
return
}
err = out.Sync()
if err != nil {
return
}
si, err := os.Stat(src)
if err != nil {
return
}
err = os.Chmod(dst, si.Mode())
if err != nil {
return
}
return
}
// CopyDirPreserve copies from the src dir to the dst dir if the file does NOT already exist in dst
func CopyDirPreserve(src string, dst string) error {
src = filepath.Clean(src)
dst = filepath.Clean(dst)
si, err := os.Stat(src)
if err != nil {
return errors.Wrapf(err, "checking %s exists", src)
}
if !si.IsDir() {
return fmt.Errorf("source is not a directory")
}
_, err = os.Stat(dst)
if err != nil && !os.IsNotExist(err) {
return errors.Wrapf(err, "checking %s exists", dst)
}
err = os.MkdirAll(dst, si.Mode())
if err != nil {
return errors.Wrapf(err, "creating %s", dst)
}
entries, err := ioutil.ReadDir(src)
if err != nil {
return errors.Wrapf(err, "reading files in %s", src)
}
for _, entry := range entries {
srcPath := filepath.Join(src, entry.Name())
dstPath := filepath.Join(dst, entry.Name())
if entry.IsDir() {
err = CopyDirPreserve(srcPath, dstPath)
if err != nil {
return errors.Wrapf(err, "recursively copying %s", entry.Name())
}
} else {
// Skip symlinks.
if entry.Mode()&os.ModeSymlink != 0 {
continue
}
if _, err := os.Stat(dstPath); os.IsNotExist(err) {
err = CopyFile(srcPath, dstPath)
if err != nil {
return errors.Wrapf(err, "copying %s to %s", srcPath, dstPath)
}
} else if err != nil {
return errors.Wrapf(err, "checking if %s exists", dstPath)
}
}
}
return nil
}
// CopyDirOverwrite copies from the source dir to the destination dir overwriting files along the way
func CopyDirOverwrite(src string, dst string) (err error) {
src = filepath.Clean(src)
dst = filepath.Clean(dst)
si, err := os.Stat(src)
if err != nil {
return err
}
if !si.IsDir() {
return fmt.Errorf("source is not a directory")
}
_, err = os.Stat(dst)
if err != nil && !os.IsNotExist(err) {
return
}
err = os.MkdirAll(dst, si.Mode())
if err != nil {
return
}
entries, err := ioutil.ReadDir(src)
if err != nil {
return
}
for _, entry := range entries {
srcPath := filepath.Join(src, entry.Name())
dstPath := filepath.Join(dst, entry.Name())
if entry.IsDir() {
err = CopyDirOverwrite(srcPath, dstPath)
if err != nil {
return
}
} else {
// Skip symlinks.
if entry.Mode()&os.ModeSymlink != 0 {
continue
}
err = CopyFile(srcPath, dstPath)
if err != nil {
return
}
}
}
return
}
// loads a file
func LoadBytes(dir, name string) ([]byte, error) {
path := filepath.Join(dir, name) // relative path
bytes, err := ioutil.ReadFile(path)
if err != nil {
return nil, fmt.Errorf("error loading file %s in directory %s, %v", name, dir, err)
}
return bytes, nil
}
// DeleteFile deletes a file from the operating system. This should NOT be used to delete any sensitive information
// because it can easily be recovered. Use DestroyFile to delete sensitive information
func DeleteFile(fileName string) (err error) {
if fileName != "" {
exists, err := FileExists(fileName)
if err != nil {
return fmt.Errorf("Could not check if file exists %s due to %s", fileName, err)
}
if exists {
err = os.Remove(fileName)
if err != nil {
return errors.Wrapf(err, "Could not remove file due to %s", fileName)
}
}
} else {
return fmt.Errorf("Filename is not valid")
}
return nil
}
// DestroyFile will securely delete a file by first overwriting it with random bytes, then deleting it. This should
// always be used for deleting sensitive information
func DestroyFile(filename string) error {
fileInfo, err := os.Stat(filename)
if err != nil {
return errors.Wrapf(err, "Could not Destroy %s", filename)
}
size := fileInfo.Size()
// Overwrite the file with random data. Doing this multiple times is probably more secure
randomBytes := make([]byte, size)
// Avoid false positive G404 of gosec module - https://github.com/securego/gosec/issues/291
/* #nosec */
_, _ = rand.Read(randomBytes)
err = ioutil.WriteFile(filename, randomBytes, DefaultWritePermissions)
if err != nil {
return errors.Wrapf(err, "Unable to overwrite %s with random data", filename)
}
return DeleteFile(filename)
}
// DeleteDirContents removes all the contents of the given directory
func DeleteDirContents(dir string) error {
files, err := filepath.Glob(filepath.Join(dir, "*"))
if err != nil {
return err
}
for _, file := range files {
// lets ignore the top level dir
if dir != file {
err = os.RemoveAll(file)
if err != nil {
return err
}
}
}
return nil
}
func DeleteDirContentsExcept(dir string, exceptDir string) error {
files, err := filepath.Glob(filepath.Join(dir, "*"))
if err != nil {
return err
}
for _, file := range files {
// lets ignore the top level dir
if dir != file && !strings.HasSuffix(file, exceptDir) {
err = os.RemoveAll(file)
if err != nil {
return err
}
}
}
return nil
}
// DeleteDirContents removes all the contents of the given directory
func RecreateDirs(dirs ...string) error {
for _, dir := range dirs {
err := os.RemoveAll(dir)
if err != nil {
return err
}
err = os.MkdirAll(dir, DefaultWritePermissions)
if err != nil {
return err
}
}
return nil
}
// FilterFileExists filters out files which do not exist
func FilterFileExists(paths []string) []string {
answer := []string{}
for _, path := range paths {
exists, err := FileExists(path)
if exists && err == nil {
answer = append(answer, path)
}
}
return answer
}
// ContentTypeForFileName returns the MIME type for the given file name
func ContentTypeForFileName(name string) string {
ext := filepath.Ext(name)
answer := mime.TypeByExtension(ext)
if answer == "" {
if ext == ".log" || ext == ".txt" {
return "text/plain; charset=utf-8"
}
}
return answer
}
// IgnoreFile returns true if the path matches any of the ignores. The match is the same as filepath.Match.
func IgnoreFile(path string, ignores []string) (bool, error) {
for _, ignore := range ignores {
if matched, err := filepath.Match(ignore, path); err != nil {
return false, errors.Wrapf(err, "error when matching ignore %s against path %s", ignore, path)
} else if matched {
return true, nil
}
}
return false, nil
}
// ListDirectory logs the directory at path
func ListDirectory(root string, recurse bool) error {
if info, err := os.Stat(root); err != nil {
if os.IsNotExist(err) {
return errors.Wrapf(err, "unable to list %s as does not exist", root)
}
if !info.IsDir() {
return errors.Errorf("%s is not a directory", root)
}
return errors.Wrapf(err, "stat %s", root)
}
return filepath.Walk(root, func(path string, info os.FileInfo, err error) error {
dir, _ := filepath.Split(path)
if !recurse && dir != root {
// No recursion and we aren't in the root dir
return nil
}
info, err = os.Stat(path)
if err != nil {
return errors.Wrapf(err, "stat %s", path)
}
log.Logger().Infof("%v %d %s %s", info.Mode().String(), info.Size(), info.ModTime().Format(time.RFC822), info.Name())
return nil
})
}
// GlobAllFiles performs a glob on the pattern and then processes all the files found.
// if a folder matches the glob its treated as another glob to recurse into the directory
func GlobAllFiles(basedir string, pattern string, fn func(string) error) error {
names, err := filepath.Glob(pattern)
if err != nil {
return errors.Wrapf(err, "failed to evaluate glob pattern '%s'", pattern)
}
for _, name := range names {
fullPath := name
if basedir != "" {
fullPath = filepath.Join(basedir, name)
}
fi, err := os.Stat(fullPath)
if err != nil {
return errors.Wrapf(err, "getting details of file '%s'", fullPath)
}
if fi.IsDir() {
err = GlobAllFiles("", filepath.Join(fullPath, "*"), fn)
if err != nil {
return err
}
} else {
err = fn(fullPath)
if err != nil {
return errors.Wrapf(err, "failed processing file '%s'", fullPath)
}
}
}
return nil
}
// ToValidFileSystemName converts the name to one that can safely be used on the filesystem
func ToValidFileSystemName(name string) string {
replacer := strings.NewReplacer(".", "_", "/", "_")
return replacer.Replace(name)
}