mirror of
https://github.com/octoleo/restic.git
synced 2024-12-29 13:22:43 +00:00
ac729db3ce
An attempt to replace an existing file with a hardlink previously ended with a missing file. Remove an existing file before trying to restore a special node. This generalizes the existing behavior for symlinks to all special node types.
840 lines
23 KiB
Go
840 lines
23 KiB
Go
package restic
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"os"
|
|
"os/user"
|
|
"reflect"
|
|
"strconv"
|
|
"strings"
|
|
"sync"
|
|
"syscall"
|
|
"time"
|
|
"unicode/utf8"
|
|
|
|
"github.com/restic/restic/internal/errors"
|
|
|
|
"bytes"
|
|
|
|
"github.com/restic/restic/internal/debug"
|
|
"github.com/restic/restic/internal/fs"
|
|
)
|
|
|
|
// ExtendedAttribute is a tuple storing the xattr name and value for various filesystems.
|
|
type ExtendedAttribute struct {
|
|
Name string `json:"name"`
|
|
Value []byte `json:"value"`
|
|
}
|
|
|
|
// GenericAttributeType can be used for OS specific functionalities by defining specific types
|
|
// in node.go to be used by the specific node_xx files.
|
|
// OS specific attribute types should follow the convention <OS>Attributes.
|
|
// GenericAttributeTypes should follow the convention <OS specific attribute type>.<attribute name>
|
|
// The attributes in OS specific attribute types must be pointers as we want to distinguish nil values
|
|
// and not create GenericAttributes for them.
|
|
type GenericAttributeType string
|
|
|
|
// OSType is the type created to represent each specific OS
|
|
type OSType string
|
|
|
|
const (
|
|
// When new GenericAttributeType are defined, they must be added in the init function as well.
|
|
|
|
// Below are windows specific attributes.
|
|
|
|
// TypeCreationTime is the GenericAttributeType used for storing creation time for windows files within the generic attributes map.
|
|
TypeCreationTime GenericAttributeType = "windows.creation_time"
|
|
// TypeFileAttributes is the GenericAttributeType used for storing file attributes for windows files within the generic attributes map.
|
|
TypeFileAttributes GenericAttributeType = "windows.file_attributes"
|
|
// TypeSecurityDescriptor is the GenericAttributeType used for storing security descriptors including owner, group, discretionary access control list (DACL), system access control list (SACL)) for windows files within the generic attributes map.
|
|
TypeSecurityDescriptor GenericAttributeType = "windows.security_descriptor"
|
|
|
|
// Generic Attributes for other OS types should be defined here.
|
|
)
|
|
|
|
// init is called when the package is initialized. Any new GenericAttributeTypes being created must be added here as well.
|
|
func init() {
|
|
storeGenericAttributeType(TypeCreationTime, TypeFileAttributes, TypeSecurityDescriptor)
|
|
}
|
|
|
|
// genericAttributesForOS maintains a map of known genericAttributesForOS to the OSType
|
|
var genericAttributesForOS = map[GenericAttributeType]OSType{}
|
|
|
|
// storeGenericAttributeType adds and entry in genericAttributesForOS map
|
|
func storeGenericAttributeType(attributeTypes ...GenericAttributeType) {
|
|
for _, attributeType := range attributeTypes {
|
|
// Get the OS attribute type from the GenericAttributeType
|
|
osAttributeName := strings.Split(string(attributeType), ".")[0]
|
|
genericAttributesForOS[attributeType] = OSType(osAttributeName)
|
|
}
|
|
}
|
|
|
|
// Node is a file, directory or other item in a backup.
|
|
type Node struct {
|
|
Name string `json:"name"`
|
|
Type string `json:"type"`
|
|
Mode os.FileMode `json:"mode,omitempty"`
|
|
ModTime time.Time `json:"mtime,omitempty"`
|
|
AccessTime time.Time `json:"atime,omitempty"`
|
|
ChangeTime time.Time `json:"ctime,omitempty"`
|
|
UID uint32 `json:"uid"`
|
|
GID uint32 `json:"gid"`
|
|
User string `json:"user,omitempty"`
|
|
Group string `json:"group,omitempty"`
|
|
Inode uint64 `json:"inode,omitempty"`
|
|
DeviceID uint64 `json:"device_id,omitempty"` // device id of the file, stat.st_dev, only stored for hardlinks
|
|
Size uint64 `json:"size,omitempty"`
|
|
Links uint64 `json:"links,omitempty"`
|
|
LinkTarget string `json:"linktarget,omitempty"`
|
|
// implicitly base64-encoded field. Only used while encoding, `linktarget_raw` will overwrite LinkTarget if present.
|
|
// This allows storing arbitrary byte-sequences, which are possible as symlink targets on unix systems,
|
|
// as LinkTarget without breaking backwards-compatibility.
|
|
// Must only be set of the linktarget cannot be encoded as valid utf8.
|
|
LinkTargetRaw []byte `json:"linktarget_raw,omitempty"`
|
|
ExtendedAttributes []ExtendedAttribute `json:"extended_attributes,omitempty"`
|
|
GenericAttributes map[GenericAttributeType]json.RawMessage `json:"generic_attributes,omitempty"`
|
|
Device uint64 `json:"device,omitempty"` // in case of Type == "dev", stat.st_rdev
|
|
Content IDs `json:"content"`
|
|
Subtree *ID `json:"subtree,omitempty"`
|
|
|
|
Error string `json:"error,omitempty"`
|
|
|
|
Path string `json:"-"`
|
|
}
|
|
|
|
// Nodes is a slice of nodes that can be sorted.
|
|
type Nodes []*Node
|
|
|
|
func (n Nodes) Len() int { return len(n) }
|
|
func (n Nodes) Less(i, j int) bool { return n[i].Name < n[j].Name }
|
|
func (n Nodes) Swap(i, j int) { n[i], n[j] = n[j], n[i] }
|
|
|
|
func (node Node) String() string {
|
|
var mode os.FileMode
|
|
switch node.Type {
|
|
case "file":
|
|
mode = 0
|
|
case "dir":
|
|
mode = os.ModeDir
|
|
case "symlink":
|
|
mode = os.ModeSymlink
|
|
case "dev":
|
|
mode = os.ModeDevice
|
|
case "chardev":
|
|
mode = os.ModeDevice | os.ModeCharDevice
|
|
case "fifo":
|
|
mode = os.ModeNamedPipe
|
|
case "socket":
|
|
mode = os.ModeSocket
|
|
}
|
|
|
|
return fmt.Sprintf("%s %5d %5d %6d %s %s",
|
|
mode|node.Mode, node.UID, node.GID, node.Size, node.ModTime, node.Name)
|
|
}
|
|
|
|
// NodeFromFileInfo returns a new node from the given path and FileInfo. It
|
|
// returns the first error that is encountered, together with a node.
|
|
func NodeFromFileInfo(path string, fi os.FileInfo, ignoreXattrListError bool) (*Node, error) {
|
|
mask := os.ModePerm | os.ModeType | os.ModeSetuid | os.ModeSetgid | os.ModeSticky
|
|
node := &Node{
|
|
Path: path,
|
|
Name: fi.Name(),
|
|
Mode: fi.Mode() & mask,
|
|
ModTime: fi.ModTime(),
|
|
}
|
|
|
|
node.Type = nodeTypeFromFileInfo(fi)
|
|
if node.Type == "file" {
|
|
node.Size = uint64(fi.Size())
|
|
}
|
|
|
|
err := node.fillExtra(path, fi, ignoreXattrListError)
|
|
return node, err
|
|
}
|
|
|
|
func nodeTypeFromFileInfo(fi os.FileInfo) string {
|
|
switch fi.Mode() & os.ModeType {
|
|
case 0:
|
|
return "file"
|
|
case os.ModeDir:
|
|
return "dir"
|
|
case os.ModeSymlink:
|
|
return "symlink"
|
|
case os.ModeDevice | os.ModeCharDevice:
|
|
return "chardev"
|
|
case os.ModeDevice:
|
|
return "dev"
|
|
case os.ModeNamedPipe:
|
|
return "fifo"
|
|
case os.ModeSocket:
|
|
return "socket"
|
|
case os.ModeIrregular:
|
|
return "irregular"
|
|
}
|
|
|
|
return ""
|
|
}
|
|
|
|
// GetExtendedAttribute gets the extended attribute.
|
|
func (node Node) GetExtendedAttribute(a string) []byte {
|
|
for _, attr := range node.ExtendedAttributes {
|
|
if attr.Name == a {
|
|
return attr.Value
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// CreateAt creates the node at the given path but does NOT restore node meta data.
|
|
func (node *Node) CreateAt(ctx context.Context, path string, repo BlobLoader) error {
|
|
debug.Log("create node %v at %v", node.Name, path)
|
|
|
|
switch node.Type {
|
|
case "dir":
|
|
if err := node.createDirAt(path); err != nil {
|
|
return err
|
|
}
|
|
case "file":
|
|
if err := node.createFileAt(ctx, path, repo); err != nil {
|
|
return err
|
|
}
|
|
case "symlink":
|
|
if err := node.createSymlinkAt(path); err != nil {
|
|
return err
|
|
}
|
|
case "dev":
|
|
if err := node.createDevAt(path); err != nil {
|
|
return err
|
|
}
|
|
case "chardev":
|
|
if err := node.createCharDevAt(path); err != nil {
|
|
return err
|
|
}
|
|
case "fifo":
|
|
if err := node.createFifoAt(path); err != nil {
|
|
return err
|
|
}
|
|
case "socket":
|
|
return nil
|
|
default:
|
|
return errors.Errorf("filetype %q not implemented", node.Type)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// RestoreMetadata restores node metadata
|
|
func (node Node) RestoreMetadata(path string, warn func(msg string)) error {
|
|
err := node.restoreMetadata(path, warn)
|
|
if err != nil {
|
|
debug.Log("restoreMetadata(%s) error %v", path, err)
|
|
}
|
|
|
|
return err
|
|
}
|
|
|
|
func (node Node) restoreMetadata(path string, warn func(msg string)) error {
|
|
var firsterr error
|
|
|
|
if err := lchown(path, int(node.UID), int(node.GID)); err != nil {
|
|
// Like "cp -a" and "rsync -a" do, we only report lchown permission errors
|
|
// if we run as root.
|
|
if os.Geteuid() > 0 && os.IsPermission(err) {
|
|
debug.Log("not running as root, ignoring lchown permission error for %v: %v",
|
|
path, err)
|
|
} else {
|
|
firsterr = errors.WithStack(err)
|
|
}
|
|
}
|
|
|
|
if err := node.RestoreTimestamps(path); err != nil {
|
|
debug.Log("error restoring timestamps for dir %v: %v", path, err)
|
|
if firsterr != nil {
|
|
firsterr = err
|
|
}
|
|
}
|
|
|
|
if err := node.restoreExtendedAttributes(path); err != nil {
|
|
debug.Log("error restoring extended attributes for %v: %v", path, err)
|
|
if firsterr != nil {
|
|
firsterr = err
|
|
}
|
|
}
|
|
|
|
if err := node.restoreGenericAttributes(path, warn); err != nil {
|
|
debug.Log("error restoring generic attributes for %v: %v", path, err)
|
|
if firsterr != nil {
|
|
firsterr = err
|
|
}
|
|
}
|
|
|
|
// Moving RestoreTimestamps and restoreExtendedAttributes calls above as for readonly files in windows
|
|
// calling Chmod below will no longer allow any modifications to be made on the file and the
|
|
// calls above would fail.
|
|
if node.Type != "symlink" {
|
|
if err := fs.Chmod(path, node.Mode); err != nil {
|
|
if firsterr != nil {
|
|
firsterr = errors.WithStack(err)
|
|
}
|
|
}
|
|
}
|
|
|
|
return firsterr
|
|
}
|
|
|
|
func (node Node) RestoreTimestamps(path string) error {
|
|
var utimes = [...]syscall.Timespec{
|
|
syscall.NsecToTimespec(node.AccessTime.UnixNano()),
|
|
syscall.NsecToTimespec(node.ModTime.UnixNano()),
|
|
}
|
|
|
|
if node.Type == "symlink" {
|
|
return node.restoreSymlinkTimestamps(path, utimes)
|
|
}
|
|
|
|
if err := syscall.UtimesNano(path, utimes[:]); err != nil {
|
|
return errors.Wrap(err, "UtimesNano")
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (node Node) createDirAt(path string) error {
|
|
err := fs.Mkdir(path, node.Mode)
|
|
if err != nil && !os.IsExist(err) {
|
|
return errors.WithStack(err)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (node Node) createFileAt(ctx context.Context, path string, repo BlobLoader) error {
|
|
f, err := fs.OpenFile(path, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, 0600)
|
|
if err != nil {
|
|
return errors.WithStack(err)
|
|
}
|
|
|
|
err = node.writeNodeContent(ctx, repo, f)
|
|
closeErr := f.Close()
|
|
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if closeErr != nil {
|
|
return errors.WithStack(closeErr)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (node Node) writeNodeContent(ctx context.Context, repo BlobLoader, f *os.File) error {
|
|
var buf []byte
|
|
for _, id := range node.Content {
|
|
buf, err := repo.LoadBlob(ctx, DataBlob, id, buf)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
_, err = f.Write(buf)
|
|
if err != nil {
|
|
return errors.WithStack(err)
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (node Node) createSymlinkAt(path string) error {
|
|
if err := fs.Symlink(node.LinkTarget, path); err != nil {
|
|
return errors.WithStack(err)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (node *Node) createDevAt(path string) error {
|
|
return mknod(path, syscall.S_IFBLK|0600, node.Device)
|
|
}
|
|
|
|
func (node *Node) createCharDevAt(path string) error {
|
|
return mknod(path, syscall.S_IFCHR|0600, node.Device)
|
|
}
|
|
|
|
func (node *Node) createFifoAt(path string) error {
|
|
return mkfifo(path, 0600)
|
|
}
|
|
|
|
// FixTime returns a time.Time which can safely be used to marshal as JSON. If
|
|
// the timestamp is earlier than year zero, the year is set to zero. In the same
|
|
// way, if the year is larger than 9999, the year is set to 9999. Other than
|
|
// the year nothing is changed.
|
|
func FixTime(t time.Time) time.Time {
|
|
switch {
|
|
case t.Year() < 0000:
|
|
return t.AddDate(-t.Year(), 0, 0)
|
|
case t.Year() > 9999:
|
|
return t.AddDate(-(t.Year() - 9999), 0, 0)
|
|
default:
|
|
return t
|
|
}
|
|
}
|
|
|
|
func (node Node) MarshalJSON() ([]byte, error) {
|
|
// make sure invalid timestamps for mtime and atime are converted to
|
|
// something we can actually save.
|
|
node.ModTime = FixTime(node.ModTime)
|
|
node.AccessTime = FixTime(node.AccessTime)
|
|
node.ChangeTime = FixTime(node.ChangeTime)
|
|
|
|
type nodeJSON Node
|
|
nj := nodeJSON(node)
|
|
name := strconv.Quote(node.Name)
|
|
nj.Name = name[1 : len(name)-1]
|
|
if nj.LinkTargetRaw != nil {
|
|
panic("LinkTargetRaw must not be set manually")
|
|
}
|
|
if !utf8.ValidString(node.LinkTarget) {
|
|
// store raw bytes if invalid utf8
|
|
nj.LinkTargetRaw = []byte(node.LinkTarget)
|
|
}
|
|
|
|
return json.Marshal(nj)
|
|
}
|
|
|
|
func (node *Node) UnmarshalJSON(data []byte) error {
|
|
type nodeJSON Node
|
|
nj := (*nodeJSON)(node)
|
|
|
|
err := json.Unmarshal(data, nj)
|
|
if err != nil {
|
|
return errors.Wrap(err, "Unmarshal")
|
|
}
|
|
|
|
nj.Name, err = strconv.Unquote(`"` + nj.Name + `"`)
|
|
if err != nil {
|
|
return errors.Wrap(err, "Unquote")
|
|
}
|
|
if nj.LinkTargetRaw != nil {
|
|
nj.LinkTarget = string(nj.LinkTargetRaw)
|
|
nj.LinkTargetRaw = nil
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (node Node) Equals(other Node) bool {
|
|
if node.Name != other.Name {
|
|
return false
|
|
}
|
|
if node.Type != other.Type {
|
|
return false
|
|
}
|
|
if node.Mode != other.Mode {
|
|
return false
|
|
}
|
|
if !node.ModTime.Equal(other.ModTime) {
|
|
return false
|
|
}
|
|
if !node.AccessTime.Equal(other.AccessTime) {
|
|
return false
|
|
}
|
|
if !node.ChangeTime.Equal(other.ChangeTime) {
|
|
return false
|
|
}
|
|
if node.UID != other.UID {
|
|
return false
|
|
}
|
|
if node.GID != other.GID {
|
|
return false
|
|
}
|
|
if node.User != other.User {
|
|
return false
|
|
}
|
|
if node.Group != other.Group {
|
|
return false
|
|
}
|
|
if node.Inode != other.Inode {
|
|
return false
|
|
}
|
|
if node.DeviceID != other.DeviceID {
|
|
return false
|
|
}
|
|
if node.Size != other.Size {
|
|
return false
|
|
}
|
|
if node.Links != other.Links {
|
|
return false
|
|
}
|
|
if node.LinkTarget != other.LinkTarget {
|
|
return false
|
|
}
|
|
if node.Device != other.Device {
|
|
return false
|
|
}
|
|
if !node.sameContent(other) {
|
|
return false
|
|
}
|
|
if !node.sameExtendedAttributes(other) {
|
|
return false
|
|
}
|
|
if !node.sameGenericAttributes(other) {
|
|
return false
|
|
}
|
|
if node.Subtree != nil {
|
|
if other.Subtree == nil {
|
|
return false
|
|
}
|
|
|
|
if !node.Subtree.Equal(*other.Subtree) {
|
|
return false
|
|
}
|
|
} else {
|
|
if other.Subtree != nil {
|
|
return false
|
|
}
|
|
}
|
|
if node.Error != other.Error {
|
|
return false
|
|
}
|
|
|
|
return true
|
|
}
|
|
|
|
func (node Node) sameContent(other Node) bool {
|
|
if node.Content == nil {
|
|
return other.Content == nil
|
|
}
|
|
|
|
if other.Content == nil {
|
|
return false
|
|
}
|
|
|
|
if len(node.Content) != len(other.Content) {
|
|
return false
|
|
}
|
|
|
|
for i := 0; i < len(node.Content); i++ {
|
|
if !node.Content[i].Equal(other.Content[i]) {
|
|
return false
|
|
}
|
|
}
|
|
return true
|
|
}
|
|
|
|
func (node Node) sameExtendedAttributes(other Node) bool {
|
|
ln := len(node.ExtendedAttributes)
|
|
lo := len(other.ExtendedAttributes)
|
|
if ln != lo {
|
|
return false
|
|
} else if ln == 0 {
|
|
// This means lo is also of length 0
|
|
return true
|
|
}
|
|
|
|
// build a set of all attributes that node has
|
|
type mapvalue struct {
|
|
value []byte
|
|
present bool
|
|
}
|
|
attributes := make(map[string]mapvalue)
|
|
for _, attr := range node.ExtendedAttributes {
|
|
attributes[attr.Name] = mapvalue{value: attr.Value}
|
|
}
|
|
|
|
for _, attr := range other.ExtendedAttributes {
|
|
v, ok := attributes[attr.Name]
|
|
if !ok {
|
|
// extended attribute is not set for node
|
|
debug.Log("other node has attribute %v, which is not present in node", attr.Name)
|
|
return false
|
|
|
|
}
|
|
|
|
if !bytes.Equal(v.value, attr.Value) {
|
|
// attribute has different value
|
|
debug.Log("attribute %v has different value", attr.Name)
|
|
return false
|
|
}
|
|
|
|
// remember that this attribute is present in other.
|
|
v.present = true
|
|
attributes[attr.Name] = v
|
|
}
|
|
|
|
// check for attributes that are not present in other
|
|
for name, v := range attributes {
|
|
if !v.present {
|
|
debug.Log("attribute %v not present in other node", name)
|
|
return false
|
|
}
|
|
}
|
|
|
|
return true
|
|
}
|
|
|
|
func (node Node) sameGenericAttributes(other Node) bool {
|
|
return deepEqual(node.GenericAttributes, other.GenericAttributes)
|
|
}
|
|
|
|
func deepEqual(map1, map2 map[GenericAttributeType]json.RawMessage) bool {
|
|
// Check if the maps have the same number of keys
|
|
if len(map1) != len(map2) {
|
|
return false
|
|
}
|
|
|
|
// Iterate over each key-value pair in map1
|
|
for key, value1 := range map1 {
|
|
// Check if the key exists in map2
|
|
value2, ok := map2[key]
|
|
if !ok {
|
|
return false
|
|
}
|
|
|
|
// Check if the JSON.RawMessage values are equal byte by byte
|
|
if !bytes.Equal(value1, value2) {
|
|
return false
|
|
}
|
|
}
|
|
|
|
return true
|
|
}
|
|
|
|
func (node *Node) fillUser(stat *statT) {
|
|
uid, gid := stat.uid(), stat.gid()
|
|
node.UID, node.GID = uid, gid
|
|
node.User = lookupUsername(uid)
|
|
node.Group = lookupGroup(gid)
|
|
}
|
|
|
|
var (
|
|
uidLookupCache = make(map[uint32]string)
|
|
uidLookupCacheMutex = sync.RWMutex{}
|
|
)
|
|
|
|
// Cached user name lookup by uid. Returns "" when no name can be found.
|
|
func lookupUsername(uid uint32) string {
|
|
uidLookupCacheMutex.RLock()
|
|
username, ok := uidLookupCache[uid]
|
|
uidLookupCacheMutex.RUnlock()
|
|
|
|
if ok {
|
|
return username
|
|
}
|
|
|
|
u, err := user.LookupId(strconv.Itoa(int(uid)))
|
|
if err == nil {
|
|
username = u.Username
|
|
}
|
|
|
|
uidLookupCacheMutex.Lock()
|
|
uidLookupCache[uid] = username
|
|
uidLookupCacheMutex.Unlock()
|
|
|
|
return username
|
|
}
|
|
|
|
var (
|
|
gidLookupCache = make(map[uint32]string)
|
|
gidLookupCacheMutex = sync.RWMutex{}
|
|
)
|
|
|
|
// Cached group name lookup by gid. Returns "" when no name can be found.
|
|
func lookupGroup(gid uint32) string {
|
|
gidLookupCacheMutex.RLock()
|
|
group, ok := gidLookupCache[gid]
|
|
gidLookupCacheMutex.RUnlock()
|
|
|
|
if ok {
|
|
return group
|
|
}
|
|
|
|
g, err := user.LookupGroupId(strconv.Itoa(int(gid)))
|
|
if err == nil {
|
|
group = g.Name
|
|
}
|
|
|
|
gidLookupCacheMutex.Lock()
|
|
gidLookupCache[gid] = group
|
|
gidLookupCacheMutex.Unlock()
|
|
|
|
return group
|
|
}
|
|
|
|
func (node *Node) fillExtra(path string, fi os.FileInfo, ignoreXattrListError bool) error {
|
|
stat, ok := toStatT(fi.Sys())
|
|
if !ok {
|
|
// fill minimal info with current values for uid, gid
|
|
node.UID = uint32(os.Getuid())
|
|
node.GID = uint32(os.Getgid())
|
|
node.ChangeTime = node.ModTime
|
|
return nil
|
|
}
|
|
|
|
node.Inode = uint64(stat.ino())
|
|
node.DeviceID = uint64(stat.dev())
|
|
|
|
node.fillTimes(stat)
|
|
|
|
node.fillUser(stat)
|
|
|
|
switch node.Type {
|
|
case "file":
|
|
node.Size = uint64(stat.size())
|
|
node.Links = uint64(stat.nlink())
|
|
case "dir":
|
|
case "symlink":
|
|
var err error
|
|
node.LinkTarget, err = fs.Readlink(path)
|
|
node.Links = uint64(stat.nlink())
|
|
if err != nil {
|
|
return errors.WithStack(err)
|
|
}
|
|
case "dev":
|
|
node.Device = uint64(stat.rdev())
|
|
node.Links = uint64(stat.nlink())
|
|
case "chardev":
|
|
node.Device = uint64(stat.rdev())
|
|
node.Links = uint64(stat.nlink())
|
|
case "fifo":
|
|
case "socket":
|
|
default:
|
|
return errors.Errorf("unsupported file type %q", node.Type)
|
|
}
|
|
|
|
allowExtended, err := node.fillGenericAttributes(path, fi, stat)
|
|
if allowExtended {
|
|
// Skip processing ExtendedAttributes if allowExtended is false.
|
|
err = errors.CombineErrors(err, node.fillExtendedAttributes(path, ignoreXattrListError))
|
|
}
|
|
return err
|
|
}
|
|
|
|
func mkfifo(path string, mode uint32) (err error) {
|
|
return mknod(path, mode|syscall.S_IFIFO, 0)
|
|
}
|
|
|
|
func (node *Node) fillTimes(stat *statT) {
|
|
ctim := stat.ctim()
|
|
atim := stat.atim()
|
|
node.ChangeTime = time.Unix(ctim.Unix())
|
|
node.AccessTime = time.Unix(atim.Unix())
|
|
}
|
|
|
|
// HandleUnknownGenericAttributesFound is used for handling and distinguing between scenarios related to future versions and cross-OS repositories
|
|
func HandleUnknownGenericAttributesFound(unknownAttribs []GenericAttributeType, warn func(msg string)) {
|
|
for _, unknownAttrib := range unknownAttribs {
|
|
handleUnknownGenericAttributeFound(unknownAttrib, warn)
|
|
}
|
|
}
|
|
|
|
// handleUnknownGenericAttributeFound is used for handling and distinguing between scenarios related to future versions and cross-OS repositories
|
|
func handleUnknownGenericAttributeFound(genericAttributeType GenericAttributeType, warn func(msg string)) {
|
|
if checkGenericAttributeNameNotHandledAndPut(genericAttributeType) {
|
|
// Print the unique error only once for a given execution
|
|
os, exists := genericAttributesForOS[genericAttributeType]
|
|
|
|
if exists {
|
|
// If genericAttributesForOS contains an entry but we still got here, it means the specific node_xx.go for the current OS did not handle it and the repository may have been originally created on a different OS.
|
|
// The fact that node.go knows about the attribute, means it is not a new attribute. This may be a common situation if a repo is used across OSs.
|
|
debug.Log("Ignoring a generic attribute found in the repository: %s which may not be compatible with your OS. Compatible OS: %s", genericAttributeType, os)
|
|
} else {
|
|
// If genericAttributesForOS in node.go does not know about this attribute, then the repository may have been created by a newer version which has a newer GenericAttributeType.
|
|
warn(fmt.Sprintf("Found an unrecognized generic attribute in the repository: %s. You may need to upgrade to latest version of restic.", genericAttributeType))
|
|
}
|
|
}
|
|
}
|
|
|
|
// handleAllUnknownGenericAttributesFound performs validations for all generic attributes in the node.
|
|
// This is not used on windows currently because windows has handling for generic attributes.
|
|
// nolint:unused
|
|
func (node Node) handleAllUnknownGenericAttributesFound(warn func(msg string)) error {
|
|
for name := range node.GenericAttributes {
|
|
handleUnknownGenericAttributeFound(name, warn)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
var unknownGenericAttributesHandlingHistory sync.Map
|
|
|
|
// checkGenericAttributeNameNotHandledAndPut checks if the GenericAttributeType name entry
|
|
// already exists and puts it in the map if not.
|
|
func checkGenericAttributeNameNotHandledAndPut(value GenericAttributeType) bool {
|
|
// If Key doesn't exist, put the value and return true because it is not already handled
|
|
_, exists := unknownGenericAttributesHandlingHistory.LoadOrStore(value, "")
|
|
// Key exists, then it is already handled so return false
|
|
return !exists
|
|
}
|
|
|
|
// The functions below are common helper functions which can be used for generic attributes support
|
|
// across different OS.
|
|
|
|
// genericAttributesToOSAttrs gets the os specific attribute from the generic attribute using reflection
|
|
// nolint:unused
|
|
func genericAttributesToOSAttrs(attrs map[GenericAttributeType]json.RawMessage, attributeType reflect.Type, attributeValuePtr *reflect.Value, keyPrefix string) (unknownAttribs []GenericAttributeType, err error) {
|
|
attributeValue := *attributeValuePtr
|
|
|
|
for key, rawMsg := range attrs {
|
|
found := false
|
|
for i := 0; i < attributeType.NumField(); i++ {
|
|
if getFQKeyByIndex(attributeType, i, keyPrefix) == key {
|
|
found = true
|
|
fieldValue := attributeValue.Field(i)
|
|
// For directly supported types, use json.Unmarshal directly
|
|
if err := json.Unmarshal(rawMsg, fieldValue.Addr().Interface()); err != nil {
|
|
return unknownAttribs, errors.Wrap(err, "Unmarshal")
|
|
}
|
|
break
|
|
}
|
|
}
|
|
if !found {
|
|
unknownAttribs = append(unknownAttribs, key)
|
|
}
|
|
}
|
|
return unknownAttribs, nil
|
|
}
|
|
|
|
// getFQKey gets the fully qualified key for the field
|
|
// nolint:unused
|
|
func getFQKey(field reflect.StructField, keyPrefix string) GenericAttributeType {
|
|
return GenericAttributeType(fmt.Sprintf("%s.%s", keyPrefix, field.Tag.Get("generic")))
|
|
}
|
|
|
|
// getFQKeyByIndex gets the fully qualified key for the field index
|
|
// nolint:unused
|
|
func getFQKeyByIndex(attributeType reflect.Type, index int, keyPrefix string) GenericAttributeType {
|
|
return getFQKey(attributeType.Field(index), keyPrefix)
|
|
}
|
|
|
|
// osAttrsToGenericAttributes gets the generic attribute from the os specific attribute using reflection
|
|
// nolint:unused
|
|
func osAttrsToGenericAttributes(attributeType reflect.Type, attributeValuePtr *reflect.Value, keyPrefix string) (attrs map[GenericAttributeType]json.RawMessage, err error) {
|
|
attributeValue := *attributeValuePtr
|
|
attrs = make(map[GenericAttributeType]json.RawMessage)
|
|
|
|
// Iterate over the fields of the struct
|
|
for i := 0; i < attributeType.NumField(); i++ {
|
|
field := attributeType.Field(i)
|
|
|
|
// Get the field value using reflection
|
|
fieldValue := attributeValue.FieldByName(field.Name)
|
|
|
|
// Check if the field is nil
|
|
if fieldValue.IsNil() {
|
|
// If it's nil, skip this field
|
|
continue
|
|
}
|
|
|
|
// Marshal the field value into a json.RawMessage
|
|
var fieldBytes []byte
|
|
if fieldBytes, err = json.Marshal(fieldValue.Interface()); err != nil {
|
|
return attrs, errors.Wrap(err, "Marshal")
|
|
}
|
|
|
|
// Insert the field into the map
|
|
attrs[getFQKey(field, keyPrefix)] = json.RawMessage(fieldBytes)
|
|
}
|
|
return attrs, nil
|
|
}
|