legalize

Description:

legalize

This package provides a set of functions to validate and sanitize filenames for different operating systems.
Please read the documentation for more information.

Note: This package is still in development and may not be stable. Please use with caution.

Features #

✅ Validate/Sanitize filenames for Windows
✅ Validate/Sanitize filenames for macOS/iOS (HFS/HFS+)
✅ Validate/Sanitize filenames for Android (FAT32)
✅ Validate/Sanitize filenames for Linux, and other POSIX systems


Note: While this package strives to provide a comprehensive solution for validating filenames, it may not cover all types of file system or edge cases. Please report any issues you encounter.

Installing #
Add this to your package's pubspec.yaml file:
dependencies:
legalize: ^1.2.2
copied to clipboard
Usage #
You can sanitize filenames by using the legalizeFilename function:
import 'package:legalize/legalize.dart';

void main() {
const someFilename = 'my?/?/?File.txt';

final sanitizedFilename = legalizeFilename(someFilename);

print(sanitizedFilename); // myFile.txt
}
copied to clipboard
You can also specify the operating system to sanitize the filename for:
import 'dart:io' show Platform;

import 'package:legalize/legalize.dart';

void main() {
const someFilename = 'my?/?/?File.txt';

final sanitizedFilename = legalizeFilename(someFilename, os: Platform.operatingSystem);

print(sanitizedFilename); // On Windows: my//File.txt, On other systems: my???File.txt
}
copied to clipboard
You can use specififc function for Windows:
import 'package:legalize/legalize.dart';

void main() {
const someFilename = 'my?<|File.txt';

final sanitizedFilename = legalizeWindowsFilename(someFilename);
print(sanitizedFilename); // myFile.txt
}
copied to clipboard
Or for macOS/iOS:
import 'package:legalize/legalize.dart';

void main() {
const someFilename = 'my/:/:File.txt';

final sanitizedFilename = legalizeHFSFilename(someFilename);
print(sanitizedFilename); // myFile.txt
}
copied to clipboard
Or for other systems:
import 'package:legalize/legalize.dart';

void main() {
const someFilename = 'my///File.txt';

final sanitizedFilename = legalizePosixFilename(someFilename);
print(sanitizedFilename); // myFile.txt
}
copied to clipboard
You can also validate filenames:
import 'dart:io' show Platform;

import 'package:legalize/legalize.dart';

void main() {
const someFilename = 'some???Filename.txt';

if (!isValidFilename(someFilename, os: Platform.operatingSystem)) {
print('Filename is invalid for this system');
} else {
print('Filename is valid for this system');
}

}
copied to clipboard
Specifics #
For ease of use and development, this library makes the following assumptions:

The NUL character (0) is not allowed in filenames on any system. (Even though it is allowed on some systems)
The ASCII control characters (0-31 and 127) are not allowed in filenames on any system by default. These can be preserved for HFS (MacOS/iOS) and Posix (Linux) systems using the shouldReplaceControlCharacters parameter.
The slash (/) character is not allowed in filenames on any system.
A filename cannot be empty.
A filename cannot be . or ...
A filename's length cannot exceed 255 characters.

These assumptions are based on the most common restrictions across different operating systems.
The legalizeFilename and isValidFilename functions assume the most "restrictive" set of restrictions by default for a given operating system:

On Android, the FAT32 restrictions are applied even though Android also supports EXT filesystems (Which is less restrictive).
On MacOS/iOS, the HFS restrictions are applied even though MacOS/iOS also supports APFS (Which is less restrictive).
On Fuchsia, the universal restrictions are applied because I couldn't find any information on the filesystem used by Fuchsia.

Contributing #
If you encounter any issues or have any suggestions, please open an issue. If you would like to contribute, please open a pull request. All contributions are welcome.
Additional information #
This package was inspired by the sanitize_filename package. I created this package because I needed a more flexible solution for my use case.