zaru_crystal

Crystal shard for filename sanitization

Programming language: Crystal

License: MIT License

Tags: Misc    

Latest version: v1.0.0

README

zaru_crystal

Filename sanitization for Crystal. This is useful when you generate filenames for downloads from user input. Port of the Zaru gem for Ruby.

Installation

1. Add the dependency to your shard.yml:

 dependencies:
   zaru_crystal:
     github: szTheory/zaru_crystal

1. Run shards install

Usage

require "zaru_crystal"

Zaru.sanitize! "  what\ēver//wëird:user:înput:"
# => "whatēverwëirduserînput"

Zaru takes a given filename (a string) and normalizes, filters and truncates it.

It removes the bad stuff but leaves unicode characters in place, so users can use whatever alphabets they want to. Zaru also doesn't remove whitespace– instead, any sequence of whitespace that is 1 or more characters in length is collapsed to a single space. Filenames are truncated so that they are at maximum 255 characters long.

If extra breathing room is required (for example to add your own filename extension later), you can leave extra room with the :padding option:

Zaru.sanitize! "A"*400, padding: 100
# resulting filename is 145 characters long

If you need to customize the fallback filename you can add your own fallback with the :fallback option:

Zaru.sanitize! "<<<", fallback: "no_file"
# resulting filename is "no_file"

Bad things in filenames

Wikipedia has a good overview on filenames. Basically, on modern-ish operating systems, the following characters are considered no-no (Zaru filters these):

/ \ ? * : | " < >

Additionally the ASCII control characters (hexadecimal 00 to 1f) are filtered.

All Unicode whitespace at the beginning and end of the potential filename is removed, and any Unicode whitespace within the filename is collapse to a single space character.

Certain filenames are reserved in Windows and are filtered.

Wait, what, Zaru?

zaru_crystal is licensed under the terms of the MIT license.