Ticket #3297: 5722-newforms-file-imagefield.diff

django/db/models/fields/__init__.py

@@ -734 +734 @@
             else:
                 func(new_data[upload_field_name]["filename"], new_data[upload_field_name]["content"], save)
 
+    def formfield_save_file(self, field_name, new_data, new_object, save=True):
+        if new_data[field_name]:
+            func = getattr(new_object, 'save_%s_file' % self.name)
+            func(new_data[field_name]["filename"], new_data[field_name]["content"], save)
+
     def get_directory_name(self):
         return os.path.normpath(force_unicode(datetime.datetime.now().strftime(smart_str(self.upload_to))))
 
@@ -742 +747 @@
         f = os.path.join(self.get_directory_name(), get_valid_filename(os.path.basename(filename)))
         return os.path.normpath(f)
 
+    def formfield(self, **kwargs):
+        defaults = {'form_class': forms.FileField}
+        defaults.update(kwargs)
+        return super(FileField, self).formfield(**defaults)
+
 class FilePathField(Field):
     def __init__(self, verbose_name=None, name=None, path='', match=None, recursive=False, **kwargs):
         self.path, self.match, self.recursive = path, match, recursive
@@ -790 +800 @@
                 setattr(new_object, self.height_field, getattr(original_object, self.height_field))
             new_object.save()
 
+    def formfield(self, **kwargs):
+        defaults = {'form_class': forms.ImageField}
+        defaults.update(kwargs)
+        return super(ImageField, self).formfield(**defaults)
+
 class IntegerField(Field):
     empty_strings_allowed = False
     def get_manipulator_field_objs(self):

django/newforms/models.py

@@ -32 +32 @@
     for f in opts.fields:
         if not f.editable or isinstance(f, models.AutoField) or not f.name in cleaned_data:
             continue
+        if isinstance(f, models.FileField):
+            continue
         if fields and f.name not in fields:
             continue
         setattr(instance, f.name, cleaned_data[f.name])
+
+    # FileField may need more info to save to specific paths
+    for f in opts.fields:
+        if isinstance(f, models.FileField) and cleaned_data.has_key(f.name):
+            f.formfield_save_file(f.name, cleaned_data, instance, save=False)
+
     if commit:
         instance.save()
         for f in opts.many_to_many:
@@ -95 +103 @@
     takes a database Field instance, plus **kwargs, and returns a form Field
     instance with the given kwargs (i.e. 'initial').
     """
+    from django.db import models
     model = instance.__class__
     opts = model._meta
     field_list = []
@@ -106 +115 @@
         current_value = f.value_from_object(instance)
         formfield = formfield_callback(f, initial=current_value)
         if formfield:
+            # FileFields are only required once, because we cannot print the
+            # existing data into the <form>
+            if isinstance(f, models.FileField) and current_value:
+                formfield.required = False
             field_list.append((f.name, formfield))
     base_fields = SortedDictFromList(field_list)
     return type(opts.object_name + 'InstanceForm', (form,),

django/newforms/fields.py

@@ -10 +10 @@
 from django.utils.encoding import smart_unicode
 
 from util import ErrorList, ValidationError
-from widgets import TextInput, PasswordInput, HiddenInput, MultipleHiddenInput, CheckboxInput, Select, NullBooleanSelect, SelectMultiple
+from widgets import TextInput, PasswordInput, HiddenInput, MultipleHiddenInput, CheckboxInput, Select, NullBooleanSelect, SelectMultiple, FileInput
 
 try:
     from decimal import Decimal, DecimalException
@@ -18 +18 @@
     from django.utils._decimal import Decimal, DecimalException
 
 __all__ = (
-    'Field', 'CharField', 'IntegerField',
+    'Field', 'CharField', 'FileField', 'ImageField', 'IntegerField',
     'DEFAULT_DATE_INPUT_FORMATS', 'DateField',
     'DEFAULT_TIME_INPUT_FORMATS', 'TimeField',
     'DEFAULT_DATETIME_INPUT_FORMATS', 'DateTimeField',
@@ -122 +122 @@
         if self.max_length is not None and isinstance(widget, (TextInput, PasswordInput)):
             return {'maxlength': str(self.max_length)}
 
+class FileField(Field):
+    widget = FileInput
+    
+    def clean(self, value):
+        super(FileField, self).clean(value)
+        if value in EMPTY_VALUES:
+            return None
+        else:
+            try:
+                content = value['content']
+            except TypeError:
+                raise ValidationError(gettext("No file was submitted. Check the encoding type on the form."))
+            if not content:
+                raise ValidationError(gettext(u'The submitted file is empty.'))
+            return value
+
+class ImageField(FileField):
+    def clean(self, value):
+        super(ImageField, self).clean(value)
+        if value in EMPTY_VALUES:
+            return None
+        else:
+            from PIL import Image
+            from cStringIO import StringIO
+            try:
+                Image.open(StringIO(value['content']))
+            except IOError: # Python Imaging Library doesn't recognize it as an image
+                raise ValidationError, gettext(u'Upload a valid image. The file you uploaded was either not an image or a corrupted image.')
+            return value
+
 class IntegerField(Field):
     def __init__(self, max_value=None, min_value=None, *args, **kwargs):
         self.max_value, self.min_value = max_value, min_value

tests/modeltests/model_forms/models.py

@@ -68 +68 @@
     def __unicode__(self):
         return self.phone
 
+class NotRequiredFile(models.Model):
+    description = models.CharField(maxlength=50)
+    file = models.FileField(upload_to='files', blank=True)
+
+    def __str__(self):
+        return self.description
+
+class RequiredFile(models.Model):
+    description = models.CharField(maxlength=50)
+    file = models.FileField(upload_to='files')
+
+    def __str__(self):
+        return self.description
+
 __test__ = {'API_TESTS': """
 >>> from django.newforms import form_for_model, form_for_instance, save_instance, BaseForm, Form, CharField
 >>> import datetime
@@ -442 +456 @@
 
 >>> f = ModelChoiceField(Category.objects.filter(pk=1), required=False)
 >>> print f.clean('')
+
+Test for filefield
+
+>>> form_data = {'description': 'FileField test', 'file': {'content': 'FileField test', 'filename': 'filetest.txt'} }
+>>> no_file_form_data = {'description': 'FileField test'}
+>>> bad_encoding_form_data = {'description': 'FileField test', 'file': 'wrong encoding'}
+>>> TestRequiredFileForm = form_for_model(RequiredFile)
+>>> empty_required_fileform = TestRequiredFileForm(auto_id=False)
+>>> print empty_required_fileform.as_ul()
+<li>Description: <input type="text" name="description" maxlength="50" /></li>
+<li>File: <input type="file" name="file" /></li>
+
+Test with data
+>>> filled_required_fileform= TestRequiredFileForm(form_data, auto_id=False)
+>>> filled_required_fileform.is_valid()
+True
+
+>>> required_file_instance = filled_required_fileform.save()
+>>> print required_file_instance.file
+files/filetest.txt
+>>> TestInstanceRequiredFileForm = form_for_instance(required_file_instance)
+>>> instance_required_fileform = TestInstanceRequiredFileForm(auto_id=False)
+>>> instance_required_fileform.as_ul()
+u'<li>Description: <input type="text" name="description" value="FileField test" maxlength="50" /></li>\\n<li>File: <input type="file" name="file" /></li>'
+>>> required_file_instance.delete()
+
+Bad data test
+>>> filled_required_fileform=TestRequiredFileForm(no_file_form_data)
+>>> filled_required_fileform.is_valid()
+False
+>>> print filled_required_fileform.errors
+<ul class="errorlist"><li>file<ul class="errorlist"><li>This field is required.</li></ul></li></ul>
+>>> TestNotRequiredFileForm = form_for_model(NotRequiredFile)
+>>> filled_not_required_fileform=TestNotRequiredFileForm(no_file_form_data)
+>>> filled_not_required_fileform.is_valid()
+True
+>>> filled_not_required_fileform=TestNotRequiredFileForm(bad_encoding_form_data)
+>>> print filled_not_required_fileform.errors
+<ul class="errorlist"><li>file<ul class="errorlist"><li>No file was submitted. Check the encoding type on the form.</li></ul></li></ul>
 None
 >>> f.clean('')
 >>> f.clean('1')