|
| 1 | +//go:build !js |
1 | 2 | // +build !js |
2 | 3 |
|
3 | 4 | // Package osfs provides a billy filesystem for the OS. |
4 | | -package osfs // import "github.com/go-git/go-billy/v5/osfs" |
| 5 | +package osfs |
5 | 6 |
|
6 | 7 | import ( |
7 | | - "io/ioutil" |
| 8 | + "fmt" |
| 9 | + "io/fs" |
8 | 10 | "os" |
9 | | - "path/filepath" |
10 | 11 | "sync" |
11 | 12 |
|
12 | 13 | "github.com/go-git/go-billy/v5" |
13 | | - "github.com/go-git/go-billy/v5/helper/chroot" |
14 | 14 | ) |
15 | 15 |
|
16 | 16 | const ( |
17 | | - defaultDirectoryMode = 0755 |
18 | | - defaultCreateMode = 0666 |
| 17 | + defaultDirectoryMode = 0o755 |
| 18 | + defaultCreateMode = 0o666 |
19 | 19 | ) |
20 | 20 |
|
21 | | -// Default Filesystem representing the root of the os filesystem. |
22 | | -var Default = &OS{} |
23 | | - |
24 | | -// OS is a filesystem based on the os filesystem. |
25 | | -type OS struct{} |
26 | | - |
27 | 21 | // New returns a new OS filesystem. |
28 | | -func New(baseDir string) billy.Filesystem { |
29 | | - return chroot.New(Default, baseDir) |
30 | | -} |
31 | | - |
32 | | -func (fs *OS) Create(filename string) (billy.File, error) { |
33 | | - return fs.OpenFile(filename, os.O_RDWR|os.O_CREATE|os.O_TRUNC, defaultCreateMode) |
34 | | -} |
35 | | - |
36 | | -func (fs *OS) OpenFile(filename string, flag int, perm os.FileMode) (billy.File, error) { |
37 | | - if flag&os.O_CREATE != 0 { |
38 | | - if err := fs.createDir(filename); err != nil { |
39 | | - return nil, err |
40 | | - } |
41 | | - } |
42 | | - |
43 | | - f, err := os.OpenFile(filename, flag, perm) |
44 | | - if err != nil { |
45 | | - return nil, err |
| 22 | +func New(baseDir string, opts ...Option) billy.Filesystem { |
| 23 | + o := &options{} |
| 24 | + for _, opt := range opts { |
| 25 | + opt(o) |
46 | 26 | } |
47 | | - return &file{File: f}, err |
48 | | -} |
49 | 27 |
|
50 | | -func (fs *OS) createDir(fullpath string) error { |
51 | | - dir := filepath.Dir(fullpath) |
52 | | - if dir != "." { |
53 | | - if err := os.MkdirAll(dir, defaultDirectoryMode); err != nil { |
54 | | - return err |
55 | | - } |
| 28 | + if o.Type == BoundOSFS { |
| 29 | + return newBoundOS(baseDir) |
56 | 30 | } |
57 | 31 |
|
58 | | - return nil |
| 32 | + return newChrootOS(baseDir) |
59 | 33 | } |
60 | 34 |
|
61 | | -func (fs *OS) ReadDir(path string) ([]os.FileInfo, error) { |
62 | | - l, err := ioutil.ReadDir(path) |
63 | | - if err != nil { |
64 | | - return nil, err |
65 | | - } |
66 | | - |
67 | | - var s = make([]os.FileInfo, len(l)) |
68 | | - for i, f := range l { |
69 | | - s[i] = f |
| 35 | +// WithBoundOS returns the option of using a Bound filesystem OS. |
| 36 | +func WithBoundOS() Option { |
| 37 | + return func(o *options) { |
| 38 | + o.Type = BoundOSFS |
70 | 39 | } |
71 | | - |
72 | | - return s, nil |
73 | 40 | } |
74 | 41 |
|
75 | | -func (fs *OS) Rename(from, to string) error { |
76 | | - if err := fs.createDir(to); err != nil { |
77 | | - return err |
| 42 | +// WithChrootOS returns the option of using a Chroot filesystem OS. |
| 43 | +func WithChrootOS() Option { |
| 44 | + return func(o *options) { |
| 45 | + o.Type = ChrootOSFS |
78 | 46 | } |
79 | | - |
80 | | - return rename(from, to) |
81 | | -} |
82 | | - |
83 | | -func (fs *OS) MkdirAll(path string, perm os.FileMode) error { |
84 | | - return os.MkdirAll(path, defaultDirectoryMode) |
85 | 47 | } |
86 | 48 |
|
87 | | -func (fs *OS) Open(filename string) (billy.File, error) { |
88 | | - return fs.OpenFile(filename, os.O_RDONLY, 0) |
| 49 | +type options struct { |
| 50 | + Type |
89 | 51 | } |
90 | 52 |
|
91 | | -func (fs *OS) Stat(filename string) (os.FileInfo, error) { |
92 | | - return os.Stat(filename) |
93 | | -} |
| 53 | +type Type int |
94 | 54 |
|
95 | | -func (fs *OS) Remove(filename string) error { |
96 | | - return os.Remove(filename) |
97 | | -} |
| 55 | +const ( |
| 56 | + ChrootOSFS Type = iota |
| 57 | + BoundOSFS |
| 58 | +) |
98 | 59 |
|
99 | | -func (fs *OS) TempFile(dir, prefix string) (billy.File, error) { |
100 | | - if err := fs.createDir(dir + string(os.PathSeparator)); err != nil { |
| 60 | +func readDir(dir string) ([]os.FileInfo, error) { |
| 61 | + entries, err := os.ReadDir(dir) |
| 62 | + if err != nil { |
101 | 63 | return nil, err |
102 | 64 | } |
| 65 | + infos := make([]fs.FileInfo, 0, len(entries)) |
| 66 | + for _, entry := range entries { |
| 67 | + fi, err := entry.Info() |
| 68 | + if err != nil { |
| 69 | + return nil, err |
| 70 | + } |
| 71 | + infos = append(infos, fi) |
| 72 | + } |
| 73 | + return infos, nil |
| 74 | +} |
103 | 75 |
|
104 | | - f, err := ioutil.TempFile(dir, prefix) |
| 76 | +func tempFile(dir, prefix string) (billy.File, error) { |
| 77 | + f, err := os.CreateTemp(dir, prefix) |
105 | 78 | if err != nil { |
106 | 79 | return nil, err |
107 | 80 | } |
108 | 81 | return &file{File: f}, nil |
109 | 82 | } |
110 | 83 |
|
111 | | -func (fs *OS) Join(elem ...string) string { |
112 | | - return filepath.Join(elem...) |
113 | | -} |
114 | | - |
115 | | -func (fs *OS) RemoveAll(path string) error { |
116 | | - return os.RemoveAll(filepath.Clean(path)) |
117 | | -} |
118 | | - |
119 | | -func (fs *OS) Lstat(filename string) (os.FileInfo, error) { |
120 | | - return os.Lstat(filepath.Clean(filename)) |
121 | | -} |
122 | | - |
123 | | -func (fs *OS) Symlink(target, link string) error { |
124 | | - if err := fs.createDir(link); err != nil { |
125 | | - return err |
| 84 | +func openFile(fn string, flag int, perm os.FileMode, createDir func(string) error) (billy.File, error) { |
| 85 | + if flag&os.O_CREATE != 0 { |
| 86 | + if createDir == nil { |
| 87 | + return nil, fmt.Errorf("createDir func cannot be nil if file needs to be opened in create mode") |
| 88 | + } |
| 89 | + if err := createDir(fn); err != nil { |
| 90 | + return nil, err |
| 91 | + } |
126 | 92 | } |
127 | 93 |
|
128 | | - return os.Symlink(target, link) |
129 | | -} |
130 | | - |
131 | | -func (fs *OS) Readlink(link string) (string, error) { |
132 | | - return os.Readlink(link) |
133 | | -} |
134 | | - |
135 | | -// Capabilities implements the Capable interface. |
136 | | -func (fs *OS) Capabilities() billy.Capability { |
137 | | - return billy.DefaultCapabilities |
| 94 | + f, err := os.OpenFile(fn, flag, perm) |
| 95 | + if err != nil { |
| 96 | + return nil, err |
| 97 | + } |
| 98 | + return &file{File: f}, err |
138 | 99 | } |
139 | 100 |
|
140 | 101 | // file is a wrapper for an os.File which adds support for file locking. |
|
0 commit comments