仅在服务器端的FileField中接受某种文件类型

时间:2010-09-06 00:31:41

标签: django file-upload

如何限制FileField仅以优雅的方式接受某种类型的文件(视频,音频,PDF格式等),服务器端?

10 个答案:

答案 0 :(得分:66)

一种非常简单的方法是使用自定义验证器。

在您应用的validators.py

def validate_file_extension(value):
    import os
    from django.core.exceptions import ValidationError
    ext = os.path.splitext(value.name)[1]  # [0] returns path+filename
    valid_extensions = ['.pdf', '.doc', '.docx', '.jpg', '.png', '.xlsx', '.xls']
    if not ext.lower() in valid_extensions:
        raise ValidationError(u'Unsupported file extension.')

然后在models.py

from .validators import validate_file_extension

...并在表单字段中使用验证器:

class Document(models.Model):
    file = models.FileField(upload_to="documents/%Y/%m/%d", validators=[validate_file_extension])

另请参阅:How to limit file types on file uploads for ModelForms with FileFields?

答案 1 :(得分:37)

版本1.11中的Django为模型字段添加了新FileExtensionValidator,文档位于:https://docs.djangoproject.com/en/dev/ref/validators/#fileextensionvalidator

如何验证文件扩展名的示例:

from django.core.validators import FileExtensionValidator
from django.db import models

class MyModel(models.Model):
    pdf_file = models.FileField(upload_to='foo/',
                                validators=[FileExtensionValidator(allowed_extensions=['pdf'])])

请注意,此方法不安全。来自Django docs的引文:

  

不要依赖文件扩展名的验证来确定文件   类型。无论使用什么数据,都可以重命名文件以具有任何扩展名   它们包含。

还有新的validate_image_file_extensionhttps://docs.djangoproject.com/en/dev/ref/validators/#validate-image-file-extension)用于验证图片扩展程序(使用Pillow)。

答案 2 :(得分:10)

有一个Django snippet可以做到这一点:

import os

from django import forms

class ExtFileField(forms.FileField):
    """
    Same as forms.FileField, but you can specify a file extension whitelist.

    >>> from django.core.files.uploadedfile import SimpleUploadedFile
    >>>
    >>> t = ExtFileField(ext_whitelist=(".pdf", ".txt"))
    >>>
    >>> t.clean(SimpleUploadedFile('filename.pdf', 'Some File Content'))
    >>> t.clean(SimpleUploadedFile('filename.txt', 'Some File Content'))
    >>>
    >>> t.clean(SimpleUploadedFile('filename.exe', 'Some File Content'))
    Traceback (most recent call last):
    ...
    ValidationError: [u'Not allowed filetype!']
    """
    def __init__(self, *args, **kwargs):
        ext_whitelist = kwargs.pop("ext_whitelist")
        self.ext_whitelist = [i.lower() for i in ext_whitelist]

        super(ExtFileField, self).__init__(*args, **kwargs)

    def clean(self, *args, **kwargs):
        data = super(ExtFileField, self).clean(*args, **kwargs)
        filename = data.name
        ext = os.path.splitext(filename)[1]
        ext = ext.lower()
        if ext not in self.ext_whitelist:
            raise forms.ValidationError("Not allowed filetype!")

#-------------------------------------------------------------------------

if __name__ == "__main__":
    import doctest, datetime
    doctest.testmod()

答案 3 :(得分:7)

首先。在应用程序内创建一个名为formatChecker.py的文件,其中包含具有要接受某种文件类型的FileField的模型。

这是您的formatChecker.py:

from django.db.models import FileField
from django.forms import forms
from django.template.defaultfilters import filesizeformat
from django.utils.translation import ugettext_lazy as _

class ContentTypeRestrictedFileField(FileField):
    """
    Same as FileField, but you can specify:
        * content_types - list containing allowed content_types. Example: ['application/pdf', 'image/jpeg']
        * max_upload_size - a number indicating the maximum file size allowed for upload.
            2.5MB - 2621440
            5MB - 5242880
            10MB - 10485760
            20MB - 20971520
            50MB - 5242880
            100MB 104857600
            250MB - 214958080
            500MB - 429916160
"""
def __init__(self, *args, **kwargs):
    self.content_types = kwargs.pop("content_types")
    self.max_upload_size = kwargs.pop("max_upload_size")

    super(ContentTypeRestrictedFileField, self).__init__(*args, **kwargs)

def clean(self, *args, **kwargs):        
    data = super(ContentTypeRestrictedFileField, self).clean(*args, **kwargs)

    file = data.file
    try:
        content_type = file.content_type
        if content_type in self.content_types:
            if file._size > self.max_upload_size:
                raise forms.ValidationError(_('Please keep filesize under %s. Current filesize %s') % (filesizeformat(self.max_upload_size), filesizeformat(file._size)))
        else:
            raise forms.ValidationError(_('Filetype not supported.'))
    except AttributeError:
        pass        

    return data

二。在models.py中,添加以下内容:

from formatChecker import ContentTypeRestrictedFileField

然后使用'ContentTypeRestrictedFileField'代替使用'FileField'。

示例:

class Stuff(models.Model):
    title = models.CharField(max_length=245)
    handout = ContentTypeRestrictedFileField(upload_to='uploads/', content_types=['video/x-msvideo', 'application/pdf', 'video/mp4', 'audio/mpeg', ],max_upload_size=5242880,blank=True, null=True)

当您只想接受FileField中的某种文件类型时,您需要做的事情。

答案 4 :(得分:3)

您可以使用以下内容限制表单中的文件类型

file = forms.FileField(widget=forms.FileInput(attrs={'accept':'application/pdf'}))

答案 5 :(得分:2)

我认为你最适合使用Dominic Rodger在他的回答中指出的ExtFileFieldpython-magic,Daniel Quinn提到的是最好的方法。如果某人足够聪明,至少可以更改扩展名,那么您将使用标题来捕获它们。

答案 6 :(得分:2)

有些人建议使用python-magic来验证文件实际上是您希望收到的类型。这可以纳入已接受答案中建议的select

<select [ngStyle]="{'background-color': color}" [(ngModel)]="color">
  <option value="red">Red</option>
  <option value="green">Green</option>
  <option value="yellow"> Yellow </option>
</select>

此示例仅验证pdf,但可以将任意数量的mime类型和文件扩展名添加到数组中。

假设您在validator中保存了上述内容,可以将其合并到您的模型中,如下所示:

import os
import magic
from django.core.exceptions import ValidationError

def validate_is_pdf(file):
    valid_mime_types = ['application/pdf']
    file_mime_type = magic.from_buffer(file.read(1024), mime=True)
    if file_mime_type not in valid_mime_types:
        raise ValidationError('Unsupported file type.')
    valid_file_extensions = ['.pdf']
    ext = os.path.splitext(file.name)[1]
    if ext.lower() not in valid_file_extensions:
        raise ValidationError('Unacceptable file extension.')

答案 7 :(得分:1)

另外,我会用一些额外的行为扩展这个类。

class ContentTypeRestrictedFileField(forms.FileField):
    ...
    widget = None
    ...
    def __init__(self, *args, **kwargs):
        ...
        self.widget = forms.ClearableFileInput(attrs={'accept':kwargs.pop('accept', None)})
        super(ContentTypeRestrictedFileField, self).__init__(*args, **kwargs)

当我们使用param accept =&#34; .pdf,.txt&#34;创建实例时,在弹出文件结构中作为默认文件,我们将看到传递了扩展名的文件。

答案 8 :(得分:1)

您可以在设置中定义已接受的mime类型列表,然后定义一个验证器,该验证器使用python-magic来检测mime类型,如果不接受mime类型则引发ValidationError。在文件表单字段中设置该验证器。

唯一的问题是有时mime类型是application / octet-stream,它可能对应于不同的文件格式。你有人克服了这个问题吗?

答案 9 :(得分:1)

在检查了可接受的答案之后,我决定分享一个基于Django文档的技巧。已经有一个用于验证文件扩展名的验证器。您无需重写自己的自定义函数即可验证是否允许文件扩展名。

https://docs.djangoproject.com/en/3.0/ref/validators/#fileextensionvalidator

警告

不要依靠文件扩展名的验证来确定文件的 类型。无论什么数据,文件都可以重命名为具有任何扩展名 它们包含。