azure-storage-fuse/internal/attribute.go

/*
    _____           _____   _____   ____          ______  _____  ------
   |     |  |      |     | |     | |     |     | |       |            |
   |     |  |      |     | |     | |     |     | |       |            |
   | --- |  |      |     | |-----| |---- |     | |-----| |-----  ------
   |     |  |      |     | |     | |     |     |       | |       |
   | ____|  |_____ | ____| | ____| |     |_____|  _____| |_____  |_____


   Licensed under the MIT License <http://opensource.org/licenses/MIT>.

   Copyright © 2020-2023 Microsoft Corporation. All rights reserved.
   Author : <blobfusedev@microsoft.com>

   Permission is hereby granted, free of charge, to any person obtaining a copy
   of this software and associated documentation files (the "Software"), to deal
   in the Software without restriction, including without limitation the rights
   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   copies of the Software, and to permit persons to whom the Software is
   furnished to do so, subject to the following conditions:

   The above copyright notice and this permission notice shall be included in all
   copies or substantial portions of the Software.

   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
   SOFTWARE
*/

package internal

import (
	"os"
	"time"

	"github.com/Azure/azure-storage-fuse/v2/common"
)

func NewDirBitMap() common.BitMap16 {
	bm := common.BitMap16(0)
	bm.Set(PropFlagIsDir)
	return bm
}

func NewSymlinkBitMap() common.BitMap16 {
	bm := common.BitMap16(0)
	bm.Set(PropFlagSymlink)
	return bm
}

func NewFileBitMap() common.BitMap16 {
	bm := common.BitMap16(0)
	return bm
}

// Flags represented in common.BitMap16 for various properties of the object
const (
	PropFlagUnknown uint16 = iota
	PropFlagNotExists
	PropFlagIsDir
	PropFlagEmptyDir
	PropFlagSymlink
	PropFlagMetadataRetrieved
	PropFlagModeDefault // TODO: Does this sound better as ModeDefault or DefaultMode? The getter would be IsModeDefault or IsDefaultMode
)

// ObjAttr : Attributes of any file/directory
type ObjAttr struct {
	Mtime    time.Time       // modified time
	Atime    time.Time       // access time
	Ctime    time.Time       // change time
	Crtime   time.Time       // creation time
	Size     int64           // size of the file/directory
	Mode     os.FileMode     // permissions in 0xxx format
	Flags    common.BitMap16 // flags
	Path     string          // full path
	Name     string          // base name of the path
	MD5      []byte
	Metadata map[string]string // extra information to preserve
}

// IsDir : Test blob is a directory or not
func (attr *ObjAttr) IsDir() bool {
	return attr.Flags.IsSet(PropFlagIsDir)
}

// IsSymlink : Test blob is a symlink or not
func (attr *ObjAttr) IsSymlink() bool {
	return attr.Flags.IsSet(PropFlagSymlink)
}

// IsMetadataRetrieved : Whether or not metadata has been retrieved for this path.
// Datalake list paths does not support returning x-ms-properties (metadata), so we cannot be sure if the path is a symlink or not.
func (attr *ObjAttr) IsMetadataRetrieved() bool {
	return attr.Flags.IsSet(PropFlagMetadataRetrieved)
}

// IsModeDefault : Whether or not to use the default mode.
// This is set in any storage service that does not support chmod/chown.
func (attr *ObjAttr) IsModeDefault() bool {
	return attr.Flags.IsSet(PropFlagModeDefault)
}