navidrome/plugins/host/storage.go

package host

import "context"

// StorageService provides access to a plugin-specific directory with read/write permissions
//
//nd:hostservice name=Storage permission=storage
type StorageService interface {
	// GetStoragePath retrieves the persistent storage path, if allowed
	//
	//nd:hostfunc
	GetStoragePath(ctx context.Context) string
}
feat(plugins): implement plugin specific storage (#5839) * implement storage api/hooks * fine. if the error messages are different, just match error * rename storageMount * add independent plugin test * round 2 * .-. * one more copypasta fail * docs(plugins): document the Storage host service The README is the plugin author reference and every other host service has a section there, but Storage had none, so the /storage guest path contract only existed in code. Documents the mount point and its backing directory, the manifest permission, the host function, and the two behaviours an author would otherwise discover the hard way: there is no size limit, and the directory outlives an uninstall. * docs(plugins): correct the library filesystem security notes The README stated in three places that library filesystem access is read-only, which stopped being true when AllowWriteAccess was added: an administrator can grant a plugin write access to libraries. Corrects those and gives the library and storage mounts the same wording for what the sandbox guarantees, since both now go through the same jail. * docs(plugins): describe symlink handling in mounts accurately The security notes claimed paths resolving outside a mount are rejected, which overstates the jail. Only lexical escapes are: '..' and absolute paths. Creating symlinks is denied, but symlinks already present are followed and do reach outside the mount, which is what lets music libraries link folders in from elsewhere. Both behaviours are pinned by tests in the plugins package. --------- Co-authored-by: Deluan Quintão <deluan@navidrome.org> 2026-08-03 11:23:42 -07:00			`package host`

			`import "context"`

			`// StorageService provides access to a plugin-specific directory with read/write permissions`
			`//`
			`//nd:hostservice name=Storage permission=storage`
			`type StorageService interface {`
			`// GetStoragePath retrieves the persistent storage path, if allowed`
			`//`
			`//nd:hostfunc`
			`GetStoragePath(ctx context.Context) string`
			`}`