V8-archive: File Naming Options

[benhaynes]

Our options should be:

uuid (replaces the old hash)
original (appends *-n as needed)
id (padded with 0)

Do ya'll agree with using uuid as a file naming default? We _could_ use original, but I think id is the default right now... and we definitely shouldn't use that one.

[wellingguzman]

@benhaynes should the id appends the number suffix (*-n) to avoid duplication in case of storage not being empty. Replace the file or appends the suffix?

[benhaynes]

For id I would say it should overwrite it if it already exists.

[wellingguzman]

I belive original should be the default one.

[wellingguzman]

In fact, original it is the default option. When there's not option set, the original is the one used by default.

[benhaynes]

Original works for me, but on demo and my install it's using I'd... so I assumed that's the default

[benhaynes]

@rijkvanzanten can we update those demos?

[rijkvanzanten]

Are you sure it's the default? The demo SQL doesn't have that option set at all in directus_settings or elsewhere so it uses the API defaults (? 🤔

[wellingguzman]

@rijkvanzanten I am, _although you make me doubt a bit_, the only way to use id or uuid it is to set the setting file_naming to either id or uuid otherwise it will use the "original" filename, and appends number if there's a existing file.

[wellingguzman]

@rijkvanzanten I tested on the demo server, and it actually works as expected, original is the default unless id or uuid is defined as file_naming

[benhaynes]

Yeah, it looks like it's in the database as file_id.

@rijkvanzanten can we re-install the demos so the schema/seeder is up to date?

[rijkvanzanten]

You want to make the demo up to date based on the values in the seeder, or the other way around?

[benhaynes]

I guess it will be a little bit of each. We need to update the seeder with the defaults we set up in the demo... but we also need to look at the current seeder API defaults and make sure those are honored in the demo.

So Users/Files needs to be updated to show as Cards, but File naming should update to original (not file_id).

[computerwizjared]

Hey all, was this option removed at some point? In Directus 6 we had the option under "Global Settings" to set the ID used when uploading files. If I need to open a feature request, I can do that too.

EDIT: Found it, nevermind. If I had read through your comments, I would've seen it's now a database-exclusive setting. Added the row to directus_settings and works a charm.

[benhaynes]

We currently only have file uploads saving as "the original" file name, but this used to be an option that could be changed in the Settings (I no longer see it). Users should be able to choose between different ways to save files:

• uuid or hash (default) — This is a unique hash that ensures file names can not be guessed or incremented.
• original — This is filenames are saved now. It sanitizes the original file name and adds -n (an incremented int)
• pk — we don't need to include this, but it would be another option that would use the primary key of directus_files as the file name.

Another option that may be cleaner is to convert directus_files to use a UUID PK... then we only have two options: UUID and Original. Thoughts?

Also, this should be:

• In the docs so people know how to use it
• In directus_settings by default so the value can be seen
• In Global Settings (app) so that users can change it

[computerwizjared]

We are currently using this feature in v7 by manually adding a row to directus_settings with the setting. Just FYI.

[rijkvanzanten]

Adding a row to directus_fields for this field will make it show up in the settings pane as well

[benhaynes]

Cool. So we need to:

• Update the migrations, installer, and default schema to include this by default
• Update the Docs to describe the options
• Change the default to uuid
• Optional: Update the collection's default PK to UUID

[benhaynes]

I was hoping that this would give us a clear default for naming... but as of now it's exactly 50/50!

https://twitter.com/directus/status/1139618994879696897

UUID seems like a "safer" default, but we need to still support "Original" as a Global Setting. BUT, let's wait the last 4 days of the poll and see what we get!

[shealavington]

UUID seems like a "safer" default

I would agree, also thinking about server admins, many people will just install and get started, it might be best for Directus to obscure by default.
The toggle option is also a great idea to allow admins to keep the original names if wanted. We could also store the original filename as the 'Title' of the file in the database.

[benhaynes]

We already store the original file name as in directus_files.name... so we could always add a helper endpoint later that downloads the file with the original name.

[bjgajjar]

Fixed in #1059