How i can get name uploaded files during record creation

[pgswow]

Hello! How i can get name uploaded files during record creation? I need save original file name, if file name is not the Latin alphabet, but for example Chinese characters or Cyrillic, a new filename is generated.

I think I can update the collection after uploading, but I can't find out the original filename.

[ganigeorgiev]

Currently there is no easy way to change the uploaded file name without "hacky" workarounds.

You can get the original file name by reading the MultipartForm data after record creation, but you'll also have to rename the uploaded file and this currently can be done only if you use the local filesystem (the filesystem abstraction doesn't support renaming file keys; I'll consider updating it in the future). Here is a short example (I haven't tested it!):

app.OnRecordAfterCreateRequest().Add(func(e *core.RecordCreateEvent) error {
	_, fh, _ := e.HttpContext.Request().FormFile("yourFileField")

	customFileName := fh.Filename // eventually do some normalizations...

	oldFileName := e.Record.GetString("yourFileField")

	e.Record.Set("yourFileField", customFileName)
	if err := app.Dao().SaveRecord(e.Record); err != nil {
		return err
	}

	// Rename the uploaded file in the local storage dir
	//
	// NB! There are no security checks for path traversal!
	oldFilePath := filepath.Join(app.DataDir(), "storage", e.Record.BaseFilesPath(), oldFileName)
	newFilePath := filepath.Join(app.DataDir(), "storage", e.Record.BaseFilesPath(), customFileName)
	os.Rename(oldFilePath, newFilePath)

	return nil
})

It depends on your use case, but in general I'd recommend NOT allowing custom upload filenames, because you also will have to take care for sanitizing the user input and making sure that the final path format is supported on the targeted platform (eg. has less than 256 chars; for a list with all filesystem limitations you could check https://en.wikipedia.org/wiki/Comparison_of_file_systems#Limits).

If you want to just show a human readable uploaded filename to the end user, you can define a custom text field (eg. filename) to your collection and set it to the original name during upload client-side, or auto assign it server-side similar to the above but using the before hooks:

app.OnRecordBeforeCreateRequest().Add(func(e *core.RecordCreateEvent) error {
	_, fh, _ := e.HttpContext.Request().FormFile("yourFileField")

	// auto store the original uploaded filename (if not explicitly set)
	//
	// we don't need to explicitly call save because the finalizer
	// of the before event hook will do it for us
	if e.Record.GetString("filename") != "" {
		e.Record.Set("filename", fh.Filename)
	}

	return nil
})

[calumk]

Hi @ganigeorgiev , Any further thoughts on if this is on the roadmap?

[ganigeorgiev]

I still haven't got the time to think on it. It exists in the roadmap, but most likely it will not be part of the upcoming v0.17.0 release as other things got prioritized. There are no ETAs for this feature.

[mikekok]

Any updates on this?
I'm working on a project where custom file naming is a must and I really want to use pocketbase (like I do with most of my projects recently).

[ganigeorgiev]

@mikekok I'm not sure to what actually you are referring to but nothing has changed since my last comment and there are no plans for now to allow custom uploaded file names out of the box.
In the future there will be a route that will return the meta attributes of the file like size, mimetype and the original filename but this remains a low priority for now.

[mikekok]

@mikekok I'm not sure to what actually you are referring to but nothing has changed since my last comment and there are no plans for now to allow custom uploaded file names out of the box. In the future there will be a route that will return the meta attributes of the file like size, mimetype and the original filename but this remains a low priority for now.

I was referring to changing the filename. Ok, I understand. Thank you for letting me know.