Documentation
¶
Overview ¶
Package aghos contains utilities for functions requiring system calls and other OS-specific APIs. OS-specific network handling should go to aghnet instead.
Index ¶
- Constants
- func Chmod(name string, perm fs.FileMode) (err error)
- func ConfigureSyslog(serviceName string) (err error)
- func HaveAdminRights() (bool, error)
- func IsOpenWrt() (ok bool)
- func Mkdir(name string, perm fs.FileMode) (err error)
- func MkdirAll(path string, perm fs.FileMode) (err error)
- func OpenFile(name string, flag int, perm fs.FileMode) (file *os.File, err error)
- func PIDByCommand(command string, except ...int) (pid int, err error)
- func PreCheckActionStart() (err error)
- func RunCommand(command string, arguments ...string) (code int, output []byte, err error)
- func SendShutdownSignal(c chan<- os.Signal)
- func SetGroup(groupName string) (err error)
- func SetRlimit(val uint64) (err error)
- func SetUser(userName string) (err error)
- func Stat(name string) (fi fs.FileInfo, err error)
- func Unsupported(op string) (err error)
- func WriteFile(filename string, data []byte, perm fs.FileMode) (err error)
- type EmptyFSWatcher
- type FSWatcher
- type FileWalker
Constants ¶
const ( DefaultPermDir fs.FileMode = 0o700 DefaultPermExe fs.FileMode = 0o700 DefaultPermFile fs.FileMode = 0o600 )
Default file, binary, and directory permissions.
const MaxCmdOutputSize = 64 * 1024
MaxCmdOutputSize is the maximum length of performed shell command output in bytes.
Variables ¶
This section is empty.
Functions ¶
func ConfigureSyslog ¶
ConfigureSyslog reroutes standard logger output to syslog.
func HaveAdminRights ¶
HaveAdminRights checks if the current user has root (administrator) rights.
func MkdirAll ¶
MkdirAll is an extension for os.MkdirAll that properly handles Windows access rights.
func OpenFile ¶
OpenFile is an extension for os.OpenFile that properly handles Windows access rights.
func PIDByCommand ¶
PIDByCommand searches for process named command and returns its PID ignoring the PIDs from except. If no processes found, the error returned.
func PreCheckActionStart ¶
func PreCheckActionStart() (err error)
PreCheckActionStart performs the service start action pre-check.
func RunCommand ¶
RunCommand runs shell command.
func SendShutdownSignal ¶
SendShutdownSignal sends the shutdown signal to the channel.
func SetRlimit ¶
SetRlimit sets user-specified limit of how many fd's we can use.
See https://github.com/andrzejlapinski/AdGuardHome/internal/issues/659.
func Stat ¶
Stat is an extension for os.Stat that properly handles Windows access rights.
Note that on Windows the "other" permission bits combines the access rights of any trustee that is neither the owner nor the owning group for the file.
TODO(e.burkov): Inspect the behavior for the World (everyone) well-known SID and, perhaps, use it.
func Unsupported ¶
Unsupported is a helper that returns a wrapped errors.ErrUnsupported.
Types ¶
type EmptyFSWatcher ¶
type EmptyFSWatcher struct{}
EmptyFSWatcher is a no-op implementation of the FSWatcher interface. It may be used on systems not supporting filesystem events.
func (EmptyFSWatcher) Add ¶
func (EmptyFSWatcher) Add(_ string) (err error)
Add implements the FSWatcher interface for EmptyFSWatcher. It always returns nil error.
func (EmptyFSWatcher) Close ¶
func (EmptyFSWatcher) Close() (err error)
Close implements the FSWatcher interface for EmptyFSWatcher. It always returns nil error.
func (EmptyFSWatcher) Events ¶
func (EmptyFSWatcher) Events() (e <-chan event)
Events implements the FSWatcher interface for EmptyFSWatcher. It always returns nil channel.
func (EmptyFSWatcher) Start ¶
func (EmptyFSWatcher) Start() (err error)
Start implements the FSWatcher interface for EmptyFSWatcher. It always returns nil error.
type FSWatcher ¶
type FSWatcher interface {
// Start starts watching the added files.
Start() (err error)
// Close stops watching the files and closes an update channel.
io.Closer
// Events returns the channel to notify about the file system events.
Events() (e <-chan event)
// Add starts tracking the file. It returns an error if the file can't be
// tracked. It must not be called after Start.
Add(name string) (err error)
}
FSWatcher tracks all the fyle system events and notifies about those.
TODO(e.burkov, a.garipov): Move into another package like aghfs.
TODO(e.burkov): Add tests.
func NewOSWritesWatcher ¶
NewOSWritesWatcher creates FSWatcher that tracks the real file system of the OS and notifies only about writing events.
type FileWalker ¶
FileWalker is the signature of a function called for files in the file tree. As opposed to filepath.Walk it only walk the files (not directories) matching the provided pattern and those returned by function itself. All patterns should be valid for fs.Glob. If FileWalker returns false for cont then walking terminates. Prefer using bufio.Scanner to read the r since the input is not limited.
TODO(e.burkov, a.garipov): Move into another package like aghfs.
TODO(e.burkov): Think about passing filename or any additional data.
Source Files