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
|
// -*- Mode: Go; indent-tabs-mode: t -*-
/*
* Copyright (C) 2014-2025 Canonical Ltd
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 3 as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
package osutil
import (
"os"
"os/exec"
"path/filepath"
"syscall"
)
// FileExists return true if given path can be stat()ed by us. Note that
// it may return false on e.g. permission issues.
func FileExists(path string) bool {
_, err := os.Stat(path)
return err == nil
}
// IsDirectory return true if the given path can be stat()ed by us and
// is a directory. Note that it may return false on e.g. permission issues.
func IsDirectory(path string) bool {
fileInfo, err := os.Stat(path)
if err != nil {
return false
}
return fileInfo.IsDir()
}
// IsDevice checks if the given os.FileMode coresponds to a device (char/block)
func IsDevice(mode os.FileMode) bool {
return (mode & (os.ModeDevice | os.ModeCharDevice)) != 0
}
// IsSymlink returns true if the given file is a symlink
func IsSymlink(path string) bool {
fileInfo, err := os.Lstat(path)
if err != nil {
return false
}
return (fileInfo.Mode() & os.ModeSymlink) != 0
}
// IsExecutable returns true when given path points to an executable file
func IsExecutable(path string) bool {
stat, err := os.Stat(path)
if err != nil {
return false
}
return !stat.IsDir() && (stat.Mode().Perm()&0111 != 0)
}
// ExecutableExists returns whether there an exists an executable with the given name somewhere on $PATH.
func ExecutableExists(name string) bool {
_, err := exec.LookPath(name)
return err == nil
}
var lookPath func(name string) (string, error) = exec.LookPath
// LookPathDefault searches for a given command name in all directories
// listed in the environment variable PATH and returns the found path or the
// provided default path.
func LookPathDefault(name string, defaultPath string) string {
p, err := lookPath(name)
if err != nil {
return defaultPath
}
return p
}
// LookInPaths is a simplified version of exec.LookPath which looks for am
// executable in caller provided list of colon separated paths. Returns empty
// string if executable was not found.
func LookInPaths(name string, searchPath string) string {
for _, dir := range filepath.SplitList(searchPath) {
p := filepath.Join(dir, name)
if IsExecutable(p) {
return p
}
}
return ""
}
// IsWritable checks if the given file/directory can be written by
// the current user
func IsWritable(path string) bool {
// from "fcntl.h"
const W_OK = 2
err := syscall.Access(path, W_OK)
return err == nil
}
// IsDirNotExist tells you whether the given error is due to a directory not existing.
func IsDirNotExist(err error) bool {
switch pe := err.(type) {
case nil:
return false
case *os.PathError:
err = pe.Err
case *os.LinkError:
err = pe.Err
case *os.SyscallError:
err = pe.Err
}
return err == syscall.ENOTDIR || err == syscall.ENOENT || err == os.ErrNotExist
}
// DirExists checks whether a given path exists, and if so whether it is a directory.
func DirExists(fn string) (exists bool, isDir bool, err error) {
st, err := os.Stat(fn)
if err != nil {
if IsDirNotExist(err) {
return false, false, nil
}
return false, false, err
}
return true, st.IsDir(), nil
}
// RegularFileExists checks whether a given path exists, and if so whether it is a regular file.
func RegularFileExists(fn string) (exists, isReg bool, err error) {
fileStat, err := os.Lstat(fn)
if err != nil {
return false, false, err
}
return true, fileStat.Mode().IsRegular(), nil
}
// ComparePathsByDeviceInode compares the devices and inodes of the given paths, following symlinks.
func ComparePathsByDeviceInode(a, b string) (match bool, err error) {
fi1, err := os.Stat(a)
if err != nil {
return false, err
}
fi2, err := os.Stat(b)
if err != nil {
return false, err
}
return os.SameFile(fi1, fi2), nil
}
|
