Enforce unique upload file names using django?

Question

What's the best way to rename photos with a unique filename on the server as they are uploaded, using django? I want to make sure each name is used only once. Are there any pinax apps that can do this, perhaps with GUID?

You need a python libary for renaming files, so they are unique? — Aurril, Apr 20 '10 at 08:42
See @mlissner's answer. Files using the default `Storage` class will automatically generate unique names now, no user code is needed anymore. See [`get_available_name`](https://docs.djangoproject.com/en/stable/ref/files/storage/#django.core.files.storage.Storage.get_available_name) — phoenix, Jan 03 '19 at 13:16
Django already does that by default. Just name all your image "image.jpg", and starting from the second one they will be automatically named with a pattern such as : `image_XpmEQxy.jpg`. — lapin, Sep 04 '19 at 03:29

score 166 · Accepted Answer · edited Jan 18 '14 at 05:09

166

Use uuid. To tie that into your model see Django documentation for FileField upload_to.

For example in your models.py define the following function:

import uuid
import os

def get_file_path(instance, filename):
    ext = filename.split('.')[-1]
    filename = "%s.%s" % (uuid.uuid4(), ext)
    return os.path.join('uploads/logos', filename)

Then, when defining your FileField/ImageField, specify get_file_path as the upload_to value.

file = models.FileField(upload_to=get_file_path,
                        null=True,
                        blank=True,
                        verbose_name=_(u'Contact list'))

edited Jan 18 '14 at 05:09

Jacob Valenta

6,659
8
31
42

answered Apr 20 '10 at 18:00

Nathan

2,955
1
19
17

11

@Creotiv This isn't changing the upload path, it is replacing the filename with a UUID. This should not cause any migration issues. – Hybrid Oct 02 '15 at 05:02
4

@Creotiv - no, migrations is only tracking *how* the filename is being generated. This means that migrations knows that there is a function called `get_file_path` being used. If `upload_to=uuid4()` was used, that would be the case where the problem you're stating comes into play. – orokusaki Dec 11 '15 at 19:21
getting `NameError: name 'get_file_path' is not defined` :( – NoobEditor Jun 07 '16 at 11:54
This is actually a great answer, works like a charm - even when you want to upload to different locations programatically based on the uniqueId of the model instance. The only thing you night want to update is: str(uuid.uuid4()) and replace instance with 'self' - working inside the model class – matshidis Jun 21 '21 at 10:55

score 20 · Answer 2 · answered Oct 24 '16 at 00:38

A better way could be using a common class in your helpers.py. This way you could reuse the random file generator across your apps.

In your helpers.py:

import os
import uuid
from django.utils.deconstruct import deconstructible


@deconstructible
class RandomFileName(object):
    def __init__(self, path):
        self.path = os.path.join(path, "%s%s")

    def __call__(self, _, filename):
        # @note It's up to the validators to check if it's the correct file type in name or if one even exist.
        extension = os.path.splitext(filename)[1]
        return self.path % (uuid.uuid4(), extension)

And then in your model just import the helper class:

from mymodule.helpers import RandomFileName

And then use it:

logo = models.ImageField(upload_to=RandomFileName('logos'))

Ref: https://coderwall.com/p/hfgoiw/give-imagefield-uploads-a-unique-name-to-avoid-file-overwrites

score 10 · Answer 3 · edited Jan 12 '21 at 18:50

10

As of the writing of this answer it seems like you no longer need to do anything special to make this happen. If you set up a FileField with a static upload_to property, the Django storage system will automatically manage naming so that if a duplicate filename is uploaded, Django will randomly generate a new unique filename for the duplicate.

Works on Django 1.10.

edited Jan 12 '21 at 18:50

phoenix

7,988
6
39
45

answered Apr 10 '17 at 17:50

M. Ryan

6,973
11
52
76

2

Confirmed that this still works in Django 2.1. This is done automatically in the default Storage class. See [get_available_name](https://docs.djangoproject.com/en/stable/ref/files/storage/#django.core.files.storage.Storage.get_available_name). – phoenix Jan 03 '19 at 13:13
1

Works with django 3.1 – lordvcs Jun 24 '21 at 12:43

score 9 · Answer 4 · edited Jan 03 '19 at 13:28

Prior to Django 1.6.6, 1.5.9, and 1.4.14, the get_avaialable_name function would automatically give files a unique name by adding an underscore. So, for example, if you save one file "test.jpg" and then another file, "test.jpg" to your server, the first will be called test.jpg, and the second will be called test_1.jpg.

Alas, that turns out to be a vector for DDOSing a machine, by sending it thousands of zero-byte files to store, each one checking thousands of previous files to see what its name should be.

As you'll see in the docs, the new system appends seven random digits after the underscore to fix this problem.

score 3 · Answer 5 · edited Jun 02 '22 at 08:52

3

You can write your own FileField and override generate_filename.

For example:

class UniqueNameFileField(FileField):
    def generate_filename(self, instance, filename):
        _, ext = os.path.splitext(filename) 
        name = f'{uuid.uuid4().hex}{ext}'
        return super().generate_filename(instance, name)

edited Jun 02 '22 at 08:52

djvg

11,722
5
72
103

answered Mar 21 '20 at 14:56

D.W

511
5
9

What I like about this one is that I can use it also with a timed based path to further make the entire path unique and not run into folder children size limitations when accessing the file system. With a lot of content files, this can be a real performance problem. Thanks so much for adding this! – Harlin Jul 03 '22 at 12:30

score 0 · Answer 6 · edited May 23 '17 at 12:10

0

How about concatenating the filename with the date / time the photo was uploaded and then using hashlib to create a message digest? That should give you unique filenames.

Alternatively you could re-use a neat little snippet which creates unique filenames and then use the full path to that file as the input to your hash call. That gives you unique constant length strings which you can map to your files.

edited May 23 '17 at 12:10

Community

1
1

answered Apr 20 '10 at 09:08

Jon Cage

36,366
38
137
215

but,how to do the same name when the same time ? – zjm1126 Apr 20 '10 at 09:14
1

You could add the amount of free disk space into the hash string - that should always change when you upload a new file. – Jon Cage Apr 20 '10 at 09:29
1

@zjm1126 @Jon Cage you could invent all sorts of ways of making it more likely to be unique and such but there will basically always be some sort of probability of collisions and the idea is just to reduce that probability to an acceptable amount and then handle when it does happen – Daniel DiPaolo Apr 20 '10 at 16:28
Indeed. The snippet I linked to really would be unique though; the filesystem would garauntee that only one file could be created with the same name. So creating a has on the full path of that should be pretty good. – Jon Cage Apr 20 '10 at 18:05

score 0 · Answer 7 · answered Aug 12 '19 at 16:39

0

django enforce unique filename automatically. if the file already exists, seven unique characters are appended to the filename

tested on django 2.2

answered Aug 12 '19 at 16:39

Aissam Jadli

75
11

Enforce unique upload file names using django?

7 Answers7

Linked