Move utility functions to utils package

Author: laozc

pkg/os/smb/api.go

@@ -3,11 +3,9 @@ package smb
 import (
 	"fmt"
 	"strings"
-	"syscall"
 
 	"github.com/kubernetes-csi/csi-proxy/pkg/cim"
 	"github.com/kubernetes-csi/csi-proxy/pkg/utils"
-	"golang.org/x/sys/windows"
 )
 
 type API interface {
@@ -29,29 +27,6 @@ func New(requirePrivacy bool) *SmbAPI {
 	}
 }
 
-func createSymlink(link, target string, isDir bool) error {
-	linkPtr, err := syscall.UTF16PtrFromString(link)
-	if err != nil {
-		return err
-	}
-	targetPtr, err := syscall.UTF16PtrFromString(target)
-	if err != nil {
-		return err
-	}
-
-	var flags uint32
-	if isDir {
-		flags = windows.SYMBOLIC_LINK_FLAG_DIRECTORY
-	}
-
-	err = windows.CreateSymbolicLink(
-		linkPtr,
-		targetPtr,
-		flags,
-	)
-	return err
-}
-
 func (*SmbAPI) IsSmbMapped(remotePath string) (bool, error) {
 	inst, err := cim.QuerySmbGlobalMappingByRemotePath(remotePath)
 	if err != nil {
@@ -78,7 +53,7 @@ func (*SmbAPI) NewSmbLink(remotePath, localPath string) error {
 	longRemotePath := utils.EnsureLongPath(remotePath)
 	longLocalPath := utils.EnsureLongPath(localPath)
 
-	err := createSymlink(longLocalPath, longRemotePath, true)
+	err := utils.CreateSymlink(longLocalPath, longRemotePath, true)
 	if err != nil {
 		return fmt.Errorf("error linking %s to %s. err: %v", remotePath, localPath, err)
 	}

pkg/os/volume/api.go

@@ -2,7 +2,6 @@ package volume
 
 import (
 	"fmt"
-	"os"
 	"path/filepath"
 	"regexp"
 	"strings"
@@ -291,7 +290,7 @@ func (VolumeAPI) GetVolumeIDFromTargetPath(mount string) (string, error) {
 }
 
 func getTarget(mount string) (string, error) {
-	mountedFolder, err := isMountedFolder(mount)
+	mountedFolder, err := utils.IsMountedFolder(mount)
 	if err != nil {
 		return "", err
 	}
@@ -347,15 +346,13 @@ func findClosestVolume(path string) (string, error) {
 	// The number of iterations is 256, which is similar to the number of iterations in filepath-securejoin
 	// https://github.com/cyphar/filepath-securejoin/blob/64536a8a66ae59588c981e2199f1dcf410508e07/join.go#L51
 	for i := 0; i < 256; i += 1 {
-		fi, err := os.Lstat(candidatePath)
+		isSymlink, err := utils.IsPathSymlink(candidatePath)
 		if err != nil {
 			return "", err
 		}
-		// for windows NTFS, check if the path is symlink instead of directory.
-		isSymlink := fi.Mode()&os.ModeSymlink != 0 || fi.Mode()&os.ModeIrregular != 0
 
 		// mounted folder created by SetVolumeMountPoint may still report ModeSymlink == 0
-		mountedFolder, err := isMountedFolder(candidatePath)
+		mountedFolder, err := utils.IsMountedFolder(candidatePath)
 		if err != nil {
 			return "", err
 		}
@@ -392,39 +389,6 @@ func findClosestVolume(path string) (string, error) {
 	return "", fmt.Errorf("failed to find the closest volume for path=%s", path)
 }
 
-// isMountedFolder checks whether the `path` is a mounted folder.
-func isMountedFolder(path string) (bool, error) {
-	// https://learn.microsoft.com/en-us/windows/win32/fileio/determining-whether-a-directory-is-a-volume-mount-point
-	utf16Path, _ := windows.UTF16PtrFromString(path)
-	attrs, err := windows.GetFileAttributes(utf16Path)
-	if err != nil {
-		return false, err
-	}
-
-	if (attrs & windows.FILE_ATTRIBUTE_REPARSE_POINT) == 0 {
-		return false, nil
-	}
-
-	var findData windows.Win32finddata
-	findHandle, err := windows.FindFirstFile(utf16Path, &findData)
-	if err != nil && !errors.Is(err, windows.ERROR_NO_MORE_FILES) {
-		return false, err
-	}
-
-	for err == nil {
-		if findData.Reserved0&windows.IO_REPARSE_TAG_MOUNT_POINT != 0 {
-			return true, nil
-		}
-
-		err = windows.FindNextFile(findHandle, &findData)
-		if err != nil && !errors.Is(err, windows.ERROR_NO_MORE_FILES) {
-			return false, err
-		}
-	}
-
-	return false, nil
-}
-
 // getVolumeForDriveLetter gets a volume from a drive letter (e.g. C:/).
 func getVolumeForDriveLetter(path string) (string, error) {
 	if len(path) != 1 {

pkg/utils/utils.go

@@ -52,3 +52,69 @@ func IsPathValid(path string) (bool, error) {
 	klog.V(6).Infof("Path %s attribute: %d", path, attrs)
 	return attrs != windows.INVALID_FILE_ATTRIBUTES, nil
 }
+
+// IsMountedFolder checks whether the `path` is a mounted folder.
+func IsMountedFolder(path string) (bool, error) {
+	// https://learn.microsoft.com/en-us/windows/win32/fileio/determining-whether-a-directory-is-a-volume-mount-point
+	utf16Path, _ := windows.UTF16PtrFromString(path)
+	attrs, err := windows.GetFileAttributes(utf16Path)
+	if err != nil {
+		return false, err
+	}
+
+	if (attrs & windows.FILE_ATTRIBUTE_REPARSE_POINT) == 0 {
+		return false, nil
+	}
+
+	var findData windows.Win32finddata
+	findHandle, err := windows.FindFirstFile(utf16Path, &findData)
+	if err != nil && !errors.Is(err, windows.ERROR_NO_MORE_FILES) {
+		return false, err
+	}
+
+	for err == nil {
+		if findData.Reserved0&windows.IO_REPARSE_TAG_MOUNT_POINT != 0 {
+			return true, nil
+		}
+
+		err = windows.FindNextFile(findHandle, &findData)
+		if err != nil && !errors.Is(err, windows.ERROR_NO_MORE_FILES) {
+			return false, err
+		}
+	}
+
+	return false, nil
+}
+
+func IsPathSymlink(path string) (bool, error) {
+	fi, err := os.Lstat(path)
+	if err != nil {
+		return false, err
+	}
+	// for windows NTFS, check if the path is symlink instead of directory.
+	isSymlink := fi.Mode()&os.ModeSymlink != 0 || fi.Mode()&os.ModeIrregular != 0
+	return isSymlink, nil
+}
+
+func CreateSymlink(link, target string, isDir bool) error {
+	linkPtr, err := windows.UTF16PtrFromString(link)
+	if err != nil {
+		return err
+	}
+	targetPtr, err := windows.UTF16PtrFromString(target)
+	if err != nil {
+		return err
+	}
+
+	var flags uint32
+	if isDir {
+		flags = windows.SYMBOLIC_LINK_FLAG_DIRECTORY
+	}
+
+	err = windows.CreateSymbolicLink(
+		linkPtr,
+		targetPtr,
+		flags,
+	)
+	return err
+}