file_unix.go

// Copyright 2013 Canonical Ltd.
// Licensed under the LGPLv3, see LICENCE file for details.

//go:build !windows
// +build !windows

package utils

import (
	"fmt"
	"os"
	"os/user"
	"strconv"
	"strings"
	"syscall"

	"github.com/juju/errors"
)

func homeDir(userName string) (string, error) {
	u, err := user.Lookup(userName)
	if err != nil {
		return "", errors.NewUserNotFound(err, "no such user")
	}
	return u.HomeDir, nil
}

// MoveFile atomically moves the source file to the destination, returning
// whether the file was moved successfully. If the destination already exists,
// it returns an error rather than overwrite it.
//
// On unix systems, an error may occur with a successful move, if the source
// file location cannot be unlinked.
func MoveFile(source, destination string) (bool, error) {
	err := os.Link(source, destination)
	if err != nil {
		return false, err
	}
	err = os.Remove(source)
	if err != nil {
		return true, err
	}
	return true, nil
}

// ReplaceFile atomically replaces the destination file or directory
// with the source. The errors that are returned are identical to
// those returned by os.Rename.
func ReplaceFile(source, destination string) error {
	return os.Rename(source, destination)
}

// MakeFileURL returns a file URL if a directory is passed in else it does nothing
func MakeFileURL(in string) string {
	if strings.HasPrefix(in, "/") {
		return "file://" + in
	}
	return in
}

// ChownPath sets the uid and gid of path to match that of the user
// specified.
func ChownPath(path, username string) error {
	u, err := user.Lookup(username)
	if err != nil {
		return fmt.Errorf("cannot lookup %q user id: %v", username, err)
	}
	uid, err := strconv.Atoi(u.Uid)
	if err != nil {
		return fmt.Errorf("invalid user id %q: %v", u.Uid, err)
	}
	gid, err := strconv.Atoi(u.Gid)
	if err != nil {
		return fmt.Errorf("invalid group id %q: %v", u.Gid, err)
	}
	return os.Chown(path, uid, gid)
}

// IsFileOwner checks to see if the ownership of the file corresponds to
// the same username
func IsFileOwner(path, username string) (bool, error) {
	u, err := user.Lookup(username)
	if err != nil {
		return false, errors.Annotatef(err, "cannot lookup %q user id", username)
	}
	info, err := os.Stat(path)
	if err != nil {
		return false, errors.Trace(err)
	}
	stat, ok := info.Sys().(*syscall.Stat_t)
	if !ok {
		return false, fmt.Errorf("cannot lookup %q file", path)
	}
	return (strconv.Itoa(int(stat.Uid)) == u.Uid &&
		strconv.Itoa(int(stat.Gid)) == u.Gid), nil
}