refactor(encoder): Update log messages and helper functions for better readability and maintainability

This commit is contained in:
wood chen 2024-10-22 21:45:47 +08:00
parent 8ed631f361
commit be7aed64a9
5 changed files with 88 additions and 52 deletions

View File

@ -39,7 +39,7 @@ func ConvertFilter(rawPath, jxlPath, avifPath, webpPath string, extraParams conf
for { for {
if _, found := config.ConvertLock.Get(rawPath); found { if _, found := config.ConvertLock.Get(rawPath); found {
log.Debugf("file %s is locked under conversion, retrying in %s", rawPath, retryDelay) log.Debugf("文件 %s 在转换过程中被锁定,请在 %s 后重试", rawPath, retryDelay)
time.Sleep(retryDelay) time.Sleep(retryDelay)
} else { } else {
// The lock is released, indicating that the conversion is complete // The lock is released, indicating that the conversion is complete
@ -212,7 +212,7 @@ func avifEncoder(img *vips.ImageRef, rawPath string, optimizedPath string) error
} }
if err != nil { if err != nil {
log.Warnf("Can't encode source image: %v to AVIF", err) log.Warnf("无法将源图像:%v 编码为 AVIF", err)
return err return err
} }
@ -253,9 +253,9 @@ func webpEncoder(img *vips.ImageRef, rawPath string, optimizedPath string) error
ep.ReductionEffort = i ep.ReductionEffort = i
buf, _, err = img.ExportWebp(&ep) buf, _, err = img.ExportWebp(&ep)
if err != nil && strings.Contains(err.Error(), "unable to encode") { if err != nil && strings.Contains(err.Error(), "unable to encode") {
log.Warnf("Can't encode image to WebP with ReductionEffort %d, trying higher value...", i) log.Warnf("无法使用 ReductionEffort %d 将图像编码为 WebP请尝试更高的值...", i)
} else if err != nil { } else if err != nil {
log.Warnf("Can't encode source image to WebP:%v", err) log.Warnf("无法将源图像编码为 WebP%v", err)
} else { } else {
break break
} }
@ -264,7 +264,7 @@ func webpEncoder(img *vips.ImageRef, rawPath string, optimizedPath string) error
} }
if err != nil { if err != nil {
log.Warnf("Can't encode source image: %v to WebP", err) log.Warnf("无法将源图像:%v 编码为 WebP", err)
return err return err
} }

View File

@ -38,7 +38,7 @@ func PrefetchImages() {
log.Debugf("跳过目录: %s", picAbsPath) log.Debugf("跳过目录: %s", picAbsPath)
return nil return nil
} }
if !helper.CheckAllowedType(picAbsPath) { if !helper.IsAllowedImageFile(picAbsPath) {
log.Debugf("跳过不支持的文件类型: %s", picAbsPath) log.Debugf("跳过不支持的文件类型: %s", picAbsPath)
return nil return nil
} }

View File

@ -6,6 +6,11 @@ import (
"github.com/jeremytorres/rawparser" "github.com/jeremytorres/rawparser"
) )
// ConvertRawToJPG 将原始图像文件转换为JPEG格式并保存到优化路径。
// rawPath: 原始图像文件的路径。
// optimizedPath: 转换后的JPEG文件保存路径。
// 返回值: 成功时返回转换后的JPEG文件路径和true失败时返回原始路径和false。
func ConvertRawToJPG(rawPath, optimizedPath string) (string, bool) { func ConvertRawToJPG(rawPath, optimizedPath string) (string, bool) {
parser, _ := rawparser.NewNefParser(true) parser, _ := rawparser.NewNefParser(true)
info := &rawparser.RawFileInfo{ info := &rawparser.RawFileInfo{

View File

@ -1,7 +1,6 @@
package handler package handler
import ( import (
"net/http"
"net/url" "net/url"
"path" "path"
"strconv" "strconv"
@ -84,7 +83,7 @@ func Convert(c *fiber.Ctx) error {
metadata = helper.ReadMetadata(reqURIwithQuery, "", reqHostname) metadata = helper.ReadMetadata(reqURIwithQuery, "", reqHostname)
if metadata.Checksum != helper.HashFile(rawImageAbs) { if metadata.Checksum != helper.HashFile(rawImageAbs) {
log.Info("本地文件已更改,更新元数据...") log.Info("本地文件已更改,更新元数据...")
helper.WriteMetadata(reqURIwithQuery, "", reqHostname) metadata = helper.WriteMetadata(reqURIwithQuery, "", reqHostname)
} }
} else { } else {
// 处理远程URL // 处理远程URL
@ -100,9 +99,9 @@ func Convert(c *fiber.Ctx) error {
rawImageAbs = path.Join(config.Config.RemoteRawPath, targetHostName, metadata.Id) rawImageAbs = path.Join(config.Config.RemoteRawPath, targetHostName, metadata.Id)
} }
// 处理非图片文件 // 检查是否为允许的图片文件
if !helper.IsImageFile(filename) { if !helper.IsAllowedImageFile(filename) {
log.Infof("Non-image file requested: %s", reqURI) log.Infof("不允许的文件类型或非图片文件: %s", reqURI)
if isLocalPath { if isLocalPath {
return c.SendFile(rawImageAbs) return c.SendFile(rawImageAbs)
} else { } else {
@ -111,16 +110,6 @@ func Convert(c *fiber.Ctx) error {
} }
} }
// 检查允许的文件类型
if !helper.CheckAllowedType(filename) {
msg := "不允许的文件扩展名 " + filename
log.Warn(msg)
return c.Status(http.StatusBadRequest).SendString(msg)
}
// 后续的图像处理逻辑
supportedFormats := helper.GuessSupportedFormat(reqHeader)
// 检查原始图像是否存在 // 检查原始图像是否存在
if !helper.ImageExists(rawImageAbs) { if !helper.ImageExists(rawImageAbs) {
helper.DeleteMetadata(reqURIwithQuery, targetHostName) helper.DeleteMetadata(reqURIwithQuery, targetHostName)
@ -136,27 +125,36 @@ func Convert(c *fiber.Ctx) error {
return c.SendStatus(fiber.StatusInternalServerError) return c.SendStatus(fiber.StatusInternalServerError)
} }
var finalFilename string
if isSmall { if isSmall {
log.Infof("文件 %s 小于100KB跳过转换", rawImageAbs) log.Infof("文件 %s 小于100KB直接缓存到 EXHAUST_PATH", rawImageAbs)
return c.SendFile(rawImageAbs) finalFilename = path.Join(config.Config.ExhaustPath, targetHostName, metadata.Id)
if err := helper.CopyFile(rawImageAbs, finalFilename); err != nil {
log.Errorf("复制小文件到 EXHAUST_PATH 失败: %v", err)
return c.SendStatus(fiber.StatusInternalServerError)
}
} else {
avifAbs, webpAbs, jxlAbs := helper.GenOptimizedAbsPath(metadata, targetHostName)
// 确定支持的格式
supportedFormats := helper.GuessSupportedFormat(reqHeader)
// 根据支持的格式和配置进行转换
encoder.ConvertFilter(rawImageAbs, jxlAbs, avifAbs, webpAbs, extraParams, supportedFormats, nil)
var availableFiles = []string{rawImageAbs}
if supportedFormats["avif"] {
availableFiles = append(availableFiles, avifAbs)
}
if supportedFormats["webp"] {
availableFiles = append(availableFiles, webpAbs)
}
if supportedFormats["jxl"] {
availableFiles = append(availableFiles, jxlAbs)
}
finalFilename = helper.FindSmallestFiles(availableFiles)
} }
avifAbs, webpAbs, jxlAbs := helper.GenOptimizedAbsPath(metadata, targetHostName)
// 根据支持的格式和配置进行转换
encoder.ConvertFilter(rawImageAbs, jxlAbs, avifAbs, webpAbs, extraParams, supportedFormats, nil)
var availableFiles = []string{rawImageAbs}
if supportedFormats["avif"] {
availableFiles = append(availableFiles, avifAbs)
}
if supportedFormats["webp"] {
availableFiles = append(availableFiles, webpAbs)
}
if supportedFormats["jxl"] {
availableFiles = append(availableFiles, jxlAbs)
}
finalFilename := helper.FindSmallestFiles(availableFiles)
contentType := helper.GetFileContentType(finalFilename) contentType := helper.GetFileContentType(finalFilename)
c.Set("Content-Type", contentType) c.Set("Content-Type", contentType)

View File

@ -2,6 +2,7 @@ package helper
import ( import (
"fmt" "fmt"
"io"
"os" "os"
"path" "path"
"path/filepath" "path/filepath"
@ -84,14 +85,14 @@ func ImageExists(filename string) bool {
return !info.IsDir() return !info.IsDir()
} }
func CheckAllowedType(imgFilename string) bool { // func CheckAllowedType(imgFilename string) bool {
if config.Config.AllowedTypes[0] == "*" { // if config.Config.AllowedTypes[0] == "*" {
return true // return true
} // }
imgFilenameExtension := strings.ToLower(path.Ext(imgFilename)) // imgFilenameExtension := strings.ToLower(path.Ext(imgFilename))
imgFilenameExtension = strings.TrimPrefix(imgFilenameExtension, ".") // .jpg -> jpg // imgFilenameExtension = strings.TrimPrefix(imgFilenameExtension, ".") // .jpg -> jpg
return slices.Contains(config.Config.AllowedTypes, imgFilenameExtension) // return slices.Contains(config.Config.AllowedTypes, imgFilenameExtension)
} // }
func GenOptimizedAbsPath(metadata config.MetaFile, subdir string) (string, string, string) { func GenOptimizedAbsPath(metadata config.MetaFile, subdir string) (string, string, string) {
webpFilename := fmt.Sprintf("%s.webp", metadata.Id) webpFilename := fmt.Sprintf("%s.webp", metadata.Id)
@ -219,8 +220,10 @@ func IsFileSizeSmall(filepath string, sizeLimit int64) (bool, error) {
return fileInfo.Size() <= sizeLimit, nil return fileInfo.Size() <= sizeLimit, nil
} }
// 新增:检查文件是否为图片的辅助函数 // 新增:检查文件是否为允许的图片的辅助函数
func IsImageFile(filename string) bool { var defaultAllowedTypes = []string{"jpg", "png", "jpeg", "bmp", "gif", "svg", "nef", "heic", "webp"}
func IsAllowedImageFile(filename string) bool {
ext := strings.ToLower(path.Ext(filename)) ext := strings.ToLower(path.Ext(filename))
if ext == "" { if ext == "" {
return false return false
@ -228,10 +231,40 @@ func IsImageFile(filename string) bool {
ext = ext[1:] // 移除开头的点 ext = ext[1:] // 移除开头的点
allowedTypes := config.Config.AllowedTypes allowedTypes := config.Config.AllowedTypes
if len(allowedTypes) == 1 && allowedTypes[0] == "*" { if len(allowedTypes) == 0 {
// 如果允许所有类型,则使用默认的图片类型列表 // 如果配置中的 AllowedTypes 为空,使用默认列表
allowedTypes = config.NewWebPConfig().AllowedTypes allowedTypes = defaultAllowedTypes
} else if len(allowedTypes) == 1 && allowedTypes[0] == "*" {
// 如果允许所有类型,直接返回 true
return true
} }
return slices.Contains(allowedTypes, ext) return slices.Contains(allowedTypes, ext)
} }
// 小于100KB文件直接复制到EXHAUST_PATH
func CopyFile(src, dst string) error {
sourceFileStat, err := os.Stat(src)
if err != nil {
return err
}
if !sourceFileStat.Mode().IsRegular() {
return fmt.Errorf("%s 不是常规文件", src)
}
source, err := os.Open(src)
if err != nil {
return err
}
defer source.Close()
destination, err := os.Create(dst)
if err != nil {
return err
}
defer destination.Close()
_, err = io.Copy(destination, source)
return err
}