Files
company_website/apps/core/signals.py
T
2026-08-10 22:46:21 +08:00

90 lines
3.4 KiB
Python
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
"""自动清理 Django 模型 ImageField/FileField 文件的信号。
当:
1. 模型实例被删除时(post_delete)
2. 字段值被更改、旧文件不再被引用时(post_save 对比 pre_save 缓存的旧值)
尝试删除磁盘上的旧文件(忽略失败、忽略不存在)。
"""
import os
from django.db import models
from django.db.models.signals import post_delete, pre_save, post_save
from django.dispatch import receiver
_MODEL_CACHE = {} # 防止多次注册同一模型
def _get_all_file_fields(model_cls):
"""返回模型中所有的 FileField/ImageField 字段名。"""
return [
f.attname for f in model_cls._meta.get_fields()
if isinstance(f, models.FileField) and f.attname
]
def _safe_delete_file(file_field_instance):
"""安全地删除 FileField 引用的磁盘文件,忽略失败。"""
try:
if file_field_instance and file_field_instance.name:
path = file_field_instance.path
if path and os.path.isfile(path):
os.remove(path)
except (OSError, ValueError):
pass
def _register_cleanup_signals():
"""注册所有已注册的 Django 应用中带 FileField/ImageField 的模型的清理信号。
幂等:同一模型多次调用只会注册一次。
"""
from django.apps import apps as django_apps
for model in django_apps.get_models():
if model in _MODEL_CACHE:
continue
file_fields = _get_all_file_fields(model)
if not file_fields:
_MODEL_CACHE[model] = None
continue
_MODEL_CACHE[model] = file_fields
# 1. post_delete: 实例删除后删除所有文件
def make_post_delete_handler(ffields):
@receiver(post_delete, sender=model, weak=False, dispatch_uid=f'cleanup_postdel_{model._meta.label}')
def handler(sender, instance, **kwargs):
for field_name in ffields:
_safe_delete_file(getattr(instance, field_name, None))
return handler
make_post_delete_handler(file_fields)
# 2. pre_save: 缓存旧值
@receiver(pre_save, sender=model, weak=False, dispatch_uid=f'cleanup_presave_{model._meta.label}')
def presave_cache(sender, instance, **kwargs):
# 不是新建的情况下,缓存数据库中该记录的旧 FileField 值
if not instance.pk:
instance.__old_filefield_values = None
return
try:
old = sender.objects.get(pk=instance.pk)
instance.__old_filefield_values = {
fn: getattr(old, fn, None) for fn in file_fields
}
except sender.DoesNotExist:
instance.__old_filefield_values = None
# 3. post_save: 对比新旧值并删除不再引用的旧文件
@receiver(post_save, sender=model, weak=False, dispatch_uid=f'cleanup_postsave_{model._meta.label}')
def postsave_cleanup(sender, instance, **kwargs):
old_vals = getattr(instance, '__old_filefield_values', None)
if not old_vals:
return
for field_name in file_fields:
old_file = old_vals.get(field_name)
new_file = getattr(instance, field_name, None)
if old_file and old_file.name:
if not new_file or new_file.name != old_file.name:
_safe_delete_file(old_file)