--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/web/lib/django/core/files/uploadedfile.py Wed Jan 20 00:34:04 2010 +0100
@@ -0,0 +1,128 @@
+"""
+Classes representing uploaded files.
+"""
+
+import os
+try:
+ from cStringIO import StringIO
+except ImportError:
+ from StringIO import StringIO
+
+from django.conf import settings
+from django.core.files.base import File
+from django.core.files import temp as tempfile
+from django.utils.encoding import smart_str
+
+__all__ = ('UploadedFile', 'TemporaryUploadedFile', 'InMemoryUploadedFile',
+ 'SimpleUploadedFile')
+
+class UploadedFile(File):
+ """
+ A abstract uploaded file (``TemporaryUploadedFile`` and
+ ``InMemoryUploadedFile`` are the built-in concrete subclasses).
+
+ An ``UploadedFile`` object behaves somewhat like a file object and
+ represents some file data that the user submitted with a form.
+ """
+ DEFAULT_CHUNK_SIZE = 64 * 2**10
+
+ def __init__(self, file=None, name=None, content_type=None, size=None, charset=None):
+ super(UploadedFile, self).__init__(file, name)
+ self.size = size
+ self.content_type = content_type
+ self.charset = charset
+
+ def __repr__(self):
+ return "<%s: %s (%s)>" % (
+ self.__class__.__name__, smart_str(self.name), self.content_type)
+
+ def _get_name(self):
+ return self._name
+
+ def _set_name(self, name):
+ # Sanitize the file name so that it can't be dangerous.
+ if name is not None:
+ # Just use the basename of the file -- anything else is dangerous.
+ name = os.path.basename(name)
+
+ # File names longer than 255 characters can cause problems on older OSes.
+ if len(name) > 255:
+ name, ext = os.path.splitext(name)
+ name = name[:255 - len(ext)] + ext
+
+ self._name = name
+
+ name = property(_get_name, _set_name)
+
+class TemporaryUploadedFile(UploadedFile):
+ """
+ A file uploaded to a temporary location (i.e. stream-to-disk).
+ """
+ def __init__(self, name, content_type, size, charset):
+ if settings.FILE_UPLOAD_TEMP_DIR:
+ file = tempfile.NamedTemporaryFile(suffix='.upload',
+ dir=settings.FILE_UPLOAD_TEMP_DIR)
+ else:
+ file = tempfile.NamedTemporaryFile(suffix='.upload')
+ super(TemporaryUploadedFile, self).__init__(file, name, content_type, size, charset)
+
+ def temporary_file_path(self):
+ """
+ Returns the full path of this file.
+ """
+ return self.file.name
+
+ def close(self):
+ try:
+ return self.file.close()
+ except OSError, e:
+ if e.errno != 2:
+ # Means the file was moved or deleted before the tempfile
+ # could unlink it. Still sets self.file.close_called and
+ # calls self.file.file.close() before the exception
+ raise
+
+class InMemoryUploadedFile(UploadedFile):
+ """
+ A file uploaded into memory (i.e. stream-to-memory).
+ """
+ def __init__(self, file, field_name, name, content_type, size, charset):
+ super(InMemoryUploadedFile, self).__init__(file, name, content_type, size, charset)
+ self.field_name = field_name
+
+ def open(self, mode=None):
+ self.file.seek(0)
+
+ def close(self):
+ pass
+
+ def chunks(self, chunk_size=None):
+ self.file.seek(0)
+ yield self.read()
+
+ def multiple_chunks(self, chunk_size=None):
+ # Since it's in memory, we'll never have multiple chunks.
+ return False
+
+
+class SimpleUploadedFile(InMemoryUploadedFile):
+ """
+ A simple representation of a file, which just has content, size, and a name.
+ """
+ def __init__(self, name, content, content_type='text/plain'):
+ content = content or ''
+ super(SimpleUploadedFile, self).__init__(StringIO(content), None, name,
+ content_type, len(content), None)
+
+ def from_dict(cls, file_dict):
+ """
+ Creates a SimpleUploadedFile object from
+ a dictionary object with the following keys:
+ - filename
+ - content-type
+ - content
+ """
+ return cls(file_dict['filename'],
+ file_dict['content'],
+ file_dict.get('content-type', 'text/plain'))
+ from_dict = classmethod(from_dict)