FS: Add /pkg/fs/duf to determine mount points and disk usage photoprism#4266

Signed-off-by: Michael Mayer <michael@photoprism.app>

Author: lastzero

go.mod

@@ -78,6 +78,7 @@ require github.com/dustinkirkland/golang-petname v0.0.0-20240428194347-eebcea082
 require golang.org/x/text v0.22.0
 
 require (
+	github.com/IGLOU-EU/go-wildcard v1.0.3
 	github.com/davidbyttow/govips/v2 v2.16.0
 	github.com/go-co-op/gocron/v2 v2.16.0
 	github.com/pquerna/otp v1.4.0
@@ -86,6 +87,7 @@ require (
 	github.com/swaggo/gin-swagger v1.6.0
 	github.com/urfave/cli/v2 v2.27.5
 	github.com/zitadel/oidc/v3 v3.35.0
+	golang.org/x/sys v0.30.0
 )
 
 require (
@@ -130,7 +132,7 @@ require (
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/prometheus/client_model v0.6.1 // indirect
 	github.com/prometheus/procfs v0.15.1 // indirect
-	github.com/rivo/uniseg v0.4.6 // indirect
+	github.com/rivo/uniseg v0.4.7 // indirect
 	github.com/russross/blackfriday/v2 v2.1.0 // indirect
 	github.com/swaggo/swag v1.16.3 // indirect
 	github.com/tidwall/match v1.1.1 // indirect
@@ -144,7 +146,6 @@ require (
 	go.opentelemetry.io/otel/trace v1.29.0 // indirect
 	golang.org/x/exp v0.0.0-20250106191152-7588d65b2ba8 // indirect
 	golang.org/x/oauth2 v0.26.0 // indirect
-	golang.org/x/sys v0.30.0 // indirect
 	golang.org/x/tools v0.30.0 // indirect
 	google.golang.org/protobuf v1.36.4 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
@@ -162,7 +163,7 @@ require (
 
 require (
 	github.com/emersion/go-webdav v0.6.0
-	github.com/mattn/go-runewidth v0.0.15 // indirect
+	github.com/mattn/go-runewidth v0.0.16 // indirect
 	github.com/tidwall/pretty v1.2.1 // indirect
 )
 

go.sum

@@ -19,6 +19,8 @@ github.com/Azure/go-ntlmssp v0.0.0-20221128193559-754e69321358 h1:mFRzDkZVAjdal+
 github.com/Azure/go-ntlmssp v0.0.0-20221128193559-754e69321358/go.mod h1:chxPXzSsl7ZWRAuOIE23GDNzjWuZquvFlgA8xmpunjU=
 github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
 github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo=
+github.com/IGLOU-EU/go-wildcard v1.0.3 h1:r8T46+8/9V1STciXJomTWRpPEv4nGJATDbJkdU0Nou0=
+github.com/IGLOU-EU/go-wildcard v1.0.3/go.mod h1:/qeV4QLmydCbwH0UMQJmXDryrFKJknWi/jjO8IiuQfY=
 github.com/KyleBanks/depth v1.2.1 h1:5h8fQADFrWtarTdtDudMmGsC7GPbOAu6RVB3ffsVFHc=
 github.com/KyleBanks/depth v1.2.1/go.mod h1:jzSb9d0L43HxTQfT+oSA1EEp2q+ne2uh6XgeJcm8brE=
 github.com/PuerkitoBio/goquery v1.5.1/go.mod h1:GsLWisAFVj4WgDibEWF4pvYnkVQBpKBKeU+7zCJoLcc=
@@ -304,8 +306,8 @@ github.com/manifoldco/promptui v0.9.0/go.mod h1:ka04sppxSGFAtxX0qhlYQjISsg9mR4GW
 github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
 github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
 github.com/mattn/go-runewidth v0.0.9/go.mod h1:H031xJmbD/WCDINGzjvQ9THkh0rPKHF+m2gUSrubnMI=
-github.com/mattn/go-runewidth v0.0.15 h1:UNAjwbU9l54TA3KzvqLGxwWjHmMgBUVhBiTjelZgg3U=
-github.com/mattn/go-runewidth v0.0.15/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w=
+github.com/mattn/go-runewidth v0.0.16 h1:E5ScNMtiwvlvB5paMFdw9p4kSQzbXFikJ5SQO6TULQc=
+github.com/mattn/go-runewidth v0.0.16/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w=
 github.com/mattn/go-sqlite3 v1.14.0/go.mod h1:JIl7NbARA7phWnGvh0LKTyg7S9BA+6gx71ShQilpsus=
 github.com/mattn/go-sqlite3 v1.14.22 h1:2gZY6PC6kBnID23Tichd1K+Z0oS6nE/XwU+Vz/5o4kU=
 github.com/mattn/go-sqlite3 v1.14.22/go.mod h1:Uh1q+B4BYcTPb+yiD3kU8Ct7aC0hY9fxUwlHK0RXw+Y=
@@ -349,8 +351,8 @@ github.com/prometheus/common v0.62.0/go.mod h1:vyBcEuLSvWos9B1+CyL7JZ2up+uFzXhkq
 github.com/prometheus/procfs v0.15.1 h1:YagwOFzUgYfKKHX6Dr+sHT7km/hxC76UB0learggepc=
 github.com/prometheus/procfs v0.15.1/go.mod h1:fB45yRUv8NstnjriLhBQLuOUt+WW4BsoGhij/e3PBqk=
 github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
-github.com/rivo/uniseg v0.4.6 h1:Sovz9sDSwbOz9tgUy8JpT+KgCkPYJEN/oYzlJiYTNLg=
-github.com/rivo/uniseg v0.4.6/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
+github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ=
+github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
 github.com/robfig/cron/v3 v3.0.1 h1:WdRxkvbJztn8LMz/QEvLN5sBU+xKpSqwwUO1Pjr4qDs=
 github.com/robfig/cron/v3 v3.0.1/go.mod h1:eQICP3HwyT7UooqI/z+Ov+PtYAWygg1TEWWzGIFLtro=
 github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4=

pkg/fs/bytes.go

@@ -1,8 +1,8 @@
 package fs
 
-// KiloByte, MegaByte, and GigaByte size constants.
+// Size constants for KByte, MByte, and GByte.
 const (
-	KiloByte = 1024
-	MegaByte = KiloByte * 1024
-	GigaByte = MegaByte * 1024
+	KB = 1024
+	MB = KB * 1024
+	GB = MB * 1024
 )

pkg/fs/duf/const.go

@@ -0,0 +1,18 @@
+package duf
+
+// Supported device types.
+const (
+	LocalDevice   = "local"
+	NetworkDevice = "network"
+	FuseDevice    = "fuse"
+	SpecialDevice = "special"
+	LoopsDevice   = "loops"
+	BindsMount    = "binds"
+)
+
+// Size constants for KByte, MByte, and GByte.
+const (
+	KB = 1024
+	MB = KB * 1024
+	GB = MB * 1024
+)

pkg/fs/duf/duf.go

@@ -0,0 +1,40 @@
+/*
+Package duf provides file system usage information.
+
+Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved.
+
+	This program is free software: you can redistribute it and/or modify
+	it under Version 3 of the GNU Affero General Public License (the "AGPL"):
+	<https://docs.photoprism.app/license/agpl>
+
+	This program is distributed in the hope that it will be useful,
+	but WITHOUT ANY WARRANTY; without even the implied warranty of
+	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+	GNU Affero General Public License for more details.
+
+	The AGPL is supplemented by our Trademark and Brand Guidelines,
+	which describe how our Brand Assets may be used:
+	<https://www.photoprism.app/trademark>
+
+This code is copied and modified in part from:
+
+  - https://github.com/muesli/duf
+    MIT License, Copyright (c) 2020 Christian Muehlhaeuser
+    see https://github.com/muesli/duf?tab=License-1-ov-file#readme
+
+  - https://github.com/shirou/gopsutil
+    BSD License, Copyright (c) 2014, WAKAYAMA Shirou
+    see https://github.com/shirou/gopsutil?tab=License-1-ov-file#readme
+
+Feel free to send an email to hello@photoprism.app if you have questions,
+want to support our work, or just want to say hello.
+
+Additional information can be found in our Developer Guide:
+<https://docs.photoprism.app/developer-guide/>
+*/
+package duf
+
+// Mounts returns the active file system mounts, along with any warnings or errors that have occurred.
+func Mounts() (m []Mount, warnings []string, err error) {
+	return mounts()
+}

pkg/fs/duf/duf_test.go

@@ -0,0 +1,40 @@
+package duf
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestMounts(t *testing.T) {
+	t.Run("Success", func(t *testing.T) {
+		// Get slice of mounted file systems.
+		results, warnings, err := Mounts()
+
+		// No warnings or errors are expected.
+		assert.NoError(t, err)
+		assert.Empty(t, warnings)
+
+		// At least one mount returned?
+		if len(results) < 1 {
+			t.Error("at least one result expected")
+		} else {
+			// If so, check the first mount for plausibility.
+			result := results[0]
+			assert.NotEmpty(t, result.Device)
+			assert.Equal(t, "local", result.DeviceType)
+			assert.Equal(t, "/", result.Mountpoint)
+			assert.NotEmpty(t, result.Fstype)
+			assert.NotEmpty(t, result.Opts)
+			assert.NotEmpty(t, result.Total)
+			assert.NotEmpty(t, result.Used)
+			assert.NotEmpty(t, result.Free)
+			assert.NotEmpty(t, result.Inodes)
+			assert.NotEmpty(t, result.InodesFree)
+			assert.NotEmpty(t, result.InodesUsed)
+			assert.NotEmpty(t, result.Blocks)
+			assert.NotEmpty(t, result.BlockSize)
+			assert.NotEmpty(t, result.Metadata)
+		}
+	})
+}

pkg/fs/duf/filesystems.go

@@ -0,0 +1,68 @@
+package duf
+
+import (
+	"os"
+	"path/filepath"
+	"strings"
+)
+
+func findMounts(mounts []Mount, path string) ([]Mount, error) {
+	var err error
+	path, err = filepath.Abs(path)
+	if err != nil {
+		return nil, err
+	}
+
+	path, err = filepath.EvalSymlinks(path)
+	if err != nil {
+		return nil, err
+	}
+
+	_, err = os.Stat(path)
+	if err != nil {
+		return nil, err
+	}
+
+	var m []Mount
+	for _, v := range mounts {
+		if path == v.Device {
+			return []Mount{v}, nil
+		}
+
+		if strings.HasPrefix(path, v.Mountpoint) {
+			var nm []Mount
+
+			// keep all entries that are as close or closer to the target
+			for _, mv := range m {
+				if len(mv.Mountpoint) >= len(v.Mountpoint) {
+					nm = append(nm, mv)
+				}
+			}
+			m = nm
+
+			// add entry only if we didn't already find something closer
+			if len(nm) == 0 || len(v.Mountpoint) >= len(nm[0].Mountpoint) {
+				m = append(m, v)
+			}
+		}
+	}
+
+	return m, nil
+}
+
+func deviceType(m Mount) string {
+	if isNetworkFs(m) {
+		return NetworkDevice
+	}
+	if isSpecialFs(m) {
+		return SpecialDevice
+	}
+	if isFuseFs(m) {
+		return FuseDevice
+	}
+
+	return LocalDevice
+}
+
+// remote: [ "nfs", "smbfs", "cifs", "ncpfs", "afs", "coda", "ftpfs", "mfs", "sshfs", "fuse.sshfs", "nfs4" ]
+// special: [ "tmpfs", "devpts", "devtmpfs", "proc", "sysfs", "usbfs", "devfs", "fdescfs", "linprocfs" ]

pkg/fs/duf/filesystems_darwin.go

@@ -0,0 +1,21 @@
+//go:build darwin
+
+package duf
+
+func isFuseFs(m Mount) bool {
+	//FIXME: implement
+	return false
+}
+
+func isNetworkFs(m Mount) bool {
+	//FIXME: implement
+	return false
+}
+
+func isSpecialFs(m Mount) bool {
+	return m.Fstype == "devfs"
+}
+
+func isHiddenFs(m Mount) bool {
+	return false
+}

pkg/fs/duf/filesystems_freebsd.go

@@ -0,0 +1,36 @@
+//go:build freebsd
+
+package duf
+
+func isFuseFs(m Mount) bool {
+	//FIXME: implement
+	return false
+}
+
+func isNetworkFs(m Mount) bool {
+	fs := []string{"nfs", "smbfs"}
+
+	for _, v := range fs {
+		if m.Fstype == v {
+			return true
+		}
+	}
+
+	return false
+}
+
+func isSpecialFs(m Mount) bool {
+	fs := []string{"devfs", "tmpfs", "linprocfs", "linsysfs", "fdescfs", "procfs"}
+
+	for _, v := range fs {
+		if m.Fstype == v {
+			return true
+		}
+	}
+
+	return false
+}
+
+func isHiddenFs(m Mount) bool {
+	return false
+}