Files
xlgo-core/utils/file.go
T
2026-07-08 15:40:01 +08:00

126 lines
3.7 KiB
Go

package utils
import (
"errors"
"io"
"os"
"path/filepath"
)
// 本文件提供通用本地文件操作工具(读/写/复制/追加/存在性/删除)。
//
// ⚠️ 安全说明(M3):这些函数直接操作调用方传入的路径,不做路径穿越校验。
// 若路径可能来自不可信输入(用户上传文件名、URL 参数等),调用方必须自行净化
// (如 filepath.Clean + 前缀锚定),否则存在任意文件读/写/删风险。
// 框架自身的不可信文件处理(storage 上传/下载)已在 storage 包内做穿越防护(C4)。
// FileExists 检查文件是否存在
func FileExists(path string) bool {
_, err := os.Stat(path)
return err == nil
}
// DirExists 检查目录是否存在
func DirExists(path string) bool {
info, err := os.Stat(path)
if err != nil {
return false
}
return info.IsDir()
}
// EnsureDir 确保目录存在,不存在则创建
func EnsureDir(path string) error {
// #nosec G301 -- generic filesystem helper intentionally uses conventional directory permissions; caller controls trusted path and policy.
return os.MkdirAll(path, 0755)
}
// ReadFile 读取文件内容。
//
// M-F 修复:去掉前置 FileExists 检查(TOCTOU 竞态——检查与读取之间文件可能被删除/替换),
// 直接 os.ReadFile 并返回其错误。文件不存在时返回 *os.PathError,调用方可经
// errors.Is(err, os.ErrNotExist) 精确判断。
//
// 注意:本函数无大小上限(os.ReadFile 语义),读取不可信/超大文件有 OOM 风险——
// 需限长读取请用 io.ReadAll(io.LimitReader(...));流式哈希大文件请用 HashFile(已流式)。
func ReadFile(path string) ([]byte, error) {
// #nosec G304 -- generic filesystem helper intentionally reads caller-provided trusted paths; package docs require callers to sanitize untrusted input.
return os.ReadFile(path)
}
// WriteFile 写入文件内容(覆盖)
func WriteFile(path string, data []byte) error {
dir := filepath.Dir(path)
if err := EnsureDir(dir); err != nil {
return err
}
// #nosec G306 -- generic filesystem helper intentionally uses conventional file permissions; caller controls trusted path and policy.
return os.WriteFile(path, data, 0644)
}
// AppendFile 追加内容到文件
func AppendFile(path string, data []byte) error {
dir := filepath.Dir(path)
if err := EnsureDir(dir); err != nil {
return err
}
// #nosec G302,G304 -- generic filesystem helper intentionally appends caller-provided trusted paths with conventional file permissions.
f, err := os.OpenFile(path, os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0644)
if err != nil {
return err
}
_, err = f.Write(data)
if cerr := f.Close(); cerr != nil {
return errors.Join(err, cerr)
}
return err
}
// CopyFile 复制文件
func CopyFile(dst, src string) error {
// #nosec G304 -- generic filesystem helper intentionally opens caller-provided trusted source paths.
srcFile, err := os.Open(src)
if err != nil {
return err
}
defer func() {
_ = srcFile.Close()
}()
// 确保目标目录存在
dir := filepath.Dir(dst)
if err := EnsureDir(dir); err != nil {
return err
}
// #nosec G304 -- generic filesystem helper intentionally creates caller-provided trusted destination paths.
dstFile, err := os.Create(dst)
if err != nil {
return err
}
_, err = io.Copy(dstFile, srcFile)
if cerr := dstFile.Close(); cerr != nil {
return errors.Join(err, cerr)
}
return err
}
// FileSize 获取文件大小
func FileSize(path string) (int64, error) {
info, err := os.Stat(path)
if err != nil {
return 0, err
}
return info.Size(), nil
}
// RemoveFile 删除文件(忽略不存在的错误)
func RemoveFile(path string) error {
err := os.Remove(path)
if os.IsNotExist(err) {
return nil
}
return err
}