Skip to content
  • Martin's avatar
    Uploaders.S3: Replace unsafe characters in object key · f77ec967
    Martin authored
    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
    f77ec967