Uploaders.S3: Replace unsafe characters in object key
authorMartin Kühl <martin.kuehl@gmail.com>
Mon, 24 Sep 2018 13:38:32 +0000 (15:38 +0200)
committerMartin Kühl <martin.kuehl@gmail.com>
Mon, 24 Sep 2018 13:38:32 +0000 (15:38 +0200)
commitf77ec96707bbce99725c4cad2ef5aea70511c6f2
tree8f00b808538e7c41ff31a9b7f5c48dd2415d9bc8
parent72520550781bd9d3cf2ac18630d5e7f89546f84f
Uploaders.S3: Replace unsafe characters in object key

According to [the S3 docs][s3], the characters safe for use in object keys are:

* 0-9
* a-z
* A-Z
* !
* -
* _
* .
* *
* '
* (
* )

(The / character is not listed but mentioned being safe outside of the list.)

Several characters that are valid in filenames can cause problems, for example
spaces are not valid in URLs and need to be escaped,
sequences of spaces can become squeezed by S3,
some characters like \ are documented to require “significant special handling”.

To avoid these problems, this change encodes the filename
before using it as part of the S3 object name
by replacing all characters except those documented as “safe” with dashes.

[s3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html
lib/pleroma/uploaders/s3.ex