Як я можу безпечно кодувати рядок у Java, щоб використовувати її як ім'я файлу?

Я отримую рядок із зовнішнього процесу. Я хочу використовувати цей рядок для створення імені файлу, а потім записати в цей файл. Ось мій фрагмент коду для цього:

    String s = ... // comes from external source
    File currentFile = new File(System.getProperty("user.home"), s);
    PrintWriter currentWriter = new PrintWriter(currentFile);

Якщо s містить недійсний символ, такий як '/' в ОС на базі Unix, тоді java.io.FileNotFoundException (правильно) кидається.

Як я можу безпечно кодувати String, щоб його можна було використовувати як ім'я файлу?

Редагувати: Я сподіваюся, що це дзвінок API, який робить це для мене.

Я можу це зробити:

    String s = ... // comes from external source
    File currentFile = new File(System.getProperty("user.home"), URLEncoder.encode(s, "UTF-8"));
    PrintWriter currentWriter = new PrintWriter(currentFile);

Але я не впевнений, чи URLEncoder надійний для цієї мети.

Якщо ви хочете, щоб результат нагадував оригінальний файл, SHA-1 або будь-яка інша схема хешування - це не відповідь. Якщо потрібно уникати зіткнень, то й проста заміна або усунення "поганих" символів - це не відповідь.

Замість цього ви хочете щось подібне. (Примітка. Це слід розглядати як наочний приклад, а не щось копіювати та вставляти.)

char fileSep = '/'; // ... or do this portably.
char escape = '%'; // ... or some other legal char.
String s = ...
int len = s.length();
StringBuilder sb = new StringBuilder(len);
for (int i = 0; i < len; i++) {
    char ch = s.charAt(i);
    if (ch < ' ' || ch >= 0x7F || ch == fileSep || ... // add other illegal chars
        || (ch == '.' && i == 0) // we don't want to collide with "." or ".."!
        || ch == escape) {
        sb.append(escape);
        if (ch < 0x10) {
            sb.append('0');
        }
        sb.append(Integer.toHexString(ch));
    } else {
        sb.append(ch);
    }
}
File currentFile = new File(System.getProperty("user.home"), sb.toString());
PrintWriter currentWriter = new PrintWriter(currentFile);

Це рішення дає зворотне кодування (без зіткнень), де кодовані рядки в більшості випадків нагадують початкові рядки. Я припускаю, що ви використовуєте 8-бітові символи.

URLEncoder працює, але він недоліком є ​​те, що він кодує безліч символів легальних імен файлів.

Якщо ви хочете не гарантовано бути реверсивним рішенням, просто видаліть «погані» символи, а не замінюючи їх послідовностями втечі.

Реверс вищевказаного кодування повинен бути однаково прямим для реалізації.

Моя пропозиція - скористатися підходом до "білого списку", тобто не намагайтеся відфільтрувати погані символи. Замість цього визначте, що добре. Ви можете або відхилити ім'я файлу, або відфільтрувати його. Якщо ви хочете відфільтрувати його:

String name = s.replaceAll("\\W+", "");

Це означає, що замінює будь-який символ, який не є цифрою, буквою чи підкресленням нічим. Можна також замінити їх іншим символом (наприклад, підкресленням).

Проблема полягає в тому, що якщо це спільний каталог, ви не хочете зіткнення імен файлів. Навіть якщо області зберігання користувачів розділені користувачем, ви можете зіткнути назву файлу, просто відфільтрувавши погані символи. Ім’я, яке вводить користувач, часто корисне, якщо вони коли-небудь хочуть також його завантажити.

З цієї причини я, як правило, дозволяю користувачеві вводити те, що він хоче, зберігати ім'я файлу на основі схеми, яку я вибрав (наприклад, userId_fileId), а потім зберігати ім'я файлу користувача в таблиці бази даних. Таким чином ви можете відобразити його назад користувачеві, зберігати речі, як ви хочете, і ви не порушуєте безпеку або видаляєте інші файли.

Ви також можете хеш-файл (наприклад, хеш MD5), але тоді ви не можете перелічити файли, які вводиться користувачем (все одно не зі значущим іменем).

EDIT: виправлений регулярний вираз для Java

Це залежить від того, чи має бути кодування реверсивним чи ні.

Оборотна

Використовуйте кодування URL-адрес ( java.net.URLEncoder) для заміни спеціальних символів %xx. Зверніть увагу, що ви піклуєтесь про особливі випадки, коли рядок дорівнює ., дорівнює ..або порожній! ¹ Багато програм використовують кодування URL для створення імен файлів, тому це стандартна методика, яку всі розуміють.

Незворотні

Використовуйте хеш (наприклад, SHA-1) даного рядка. Сучасні хеш-алгоритми ( не MD5) можна вважати без зіткнення. Насправді у вас буде прорив криптографії, якщо ви виявите зіткнення.

public static String encodeFilename(String s)
{
    try
    {
        return "myApp-" + java.net.URLEncoder.encode(s, "UTF-8");
    }
    catch (java.io.UnsupportedEncodingException e)
    {
        throw new RuntimeException("UTF-8 is an unknown encoding!?");
    }
}

Ось що я використовую:

public String sanitizeFilename(String inputName) {
    return inputName.replaceAll("[^a-zA-Z0-9-_\\.]", "_");
}

Для цього потрібно замінити кожен символ, який не є літерою, цифрою, підкресленням або крапкою, підкресленням, використовуючи регулярний вираз.

Це означає, що щось на кшталт "Як перетворити £ в $" стане "How_to_convert___to__". Правда, цей результат не дуже зручний у користуванні, але він безпечний, і отримані імена каталогів / файлів гарантовано працюють скрізь. У моєму випадку результат не відображається користувачеві, і, таким чином, це не є проблемою, але ви можете змінити регулярний вираз на більш дозвільний характер.

Варто зазначити, що з іншою проблемою, з якою я стикався, було те, що я інколи отримую ідентичні імена (оскільки це засновано на введенні користувача), тому вам слід знати про це, оскільки ви не можете мати декілька каталогів / файлів з однаковою назвою в одному каталозі . Я просто заздалегідь передбачив поточний час і дату, і короткий випадковий рядок, щоб уникнути цього. (фактична випадкова рядок, а не хеш імені файлу, оскільки однакові імена файлів призведуть до однакових хешів)

Крім того, вам може знадобитися урізати або іншим чином скоротити отриманий рядок, оскільки він може перевищувати обмеження в 255 символів, яке мають деякі системи.

Для тих, хто шукає загального рішення, це можуть бути звичайні критери:

• Ім'я файлу має нагадувати рядок.
• Кодування повинно бути зворотним, де це можливо.
• Імовірність зіткнень повинна бути зведена до мінімуму.

Щоб досягти цього, ми можемо використовувати регулярний вираз, щоб відповідати незаконним символам, відсотковим кодувати їх, а потім обмежувати довжину кодованого рядка.

private static final Pattern PATTERN = Pattern.compile("[^A-Za-z0-9_\\-]");

private static final int MAX_LENGTH = 127;

public static String escapeStringAsFilename(String in){

    StringBuffer sb = new StringBuffer();

    // Apply the regex.
    Matcher m = PATTERN.matcher(in);

    while (m.find()) {

        // Convert matched character to percent-encoded.
        String replacement = "%"+Integer.toHexString(m.group().charAt(0)).toUpperCase();

        m.appendReplacement(sb,replacement);
    }
    m.appendTail(sb);

    String encoded = sb.toString();

    // Truncate the string.
    int end = Math.min(encoded.length(),MAX_LENGTH);
    return encoded.substring(0,end);
}

Візерунки

Наведений вище шаблон заснований на консервативному наборі дозволених символів у специфікації POSIX .

Якщо ви хочете дозволити символ крапки, скористайтеся:

private static final Pattern PATTERN = Pattern.compile("[^A-Za-z0-9_\\-\\.]");

Просто будьте обережні до струн типу "". і ".."

Якщо ви хочете уникнути зіткнень у файлових системах, нечутливих до регістру, вам потрібно буде уникнути великих літер:

private static final Pattern PATTERN = Pattern.compile("[^a-z0-9_\\-]");

Або уникайте малих літер:

private static final Pattern PATTERN = Pattern.compile("[^A-Z0-9_\\-]");

Замість того, щоб використовувати білий список, ви можете вибрати чорний список зарезервованих символів для вашої конкретної файлової системи. EG Цей регекс підходить для файлових систем FAT32:

private static final Pattern PATTERN = Pattern.compile("[%\\.\"\\*/:<>\\?\\\\\\|\\+,\\.;=\\[\\]]");

Довжина

На Android 127 безпечних меж - 127 символів . У багатьох файлових системах розміщено 255 символів.

Якщо ви віддаєте перевагу утримувати хвіст, а не голову своєї струни, використовуйте:

// Truncate the string.
int start = Math.max(0,encoded.length()-MAX_LENGTH);
return encoded.substring(start,encoded.length());

Розшифровка

Щоб перетворити ім'я файлу в початковий рядок, використовуйте:

URLDecoder.decode(filename, "UTF-8");

Обмеження

Оскільки довші рядки усічені, існує можливість зіткнення імен при кодуванні або пошкодження при розшифровці.

Спробуйте скористатися наступним регулярним виразом, який замінює кожен недійсний символ імені файлу пробілом:

public static String toValidFileName(String input)
{
    return input.replaceAll("[:\\\\/*\"?|<>']", " ");
}

Виберіть свою отруту з варіантів, представлених commons-кодеком , наприклад:

String safeFileName = DigestUtils.sha1(filename);

Це, мабуть, не найефективніший спосіб, але показує, як це зробити за допомогою трубопроводів Java 8:

private static String sanitizeFileName(String name) {
    return name
            .chars()
            .mapToObj(i -> (char) i)
            .map(c -> Character.isWhitespace(c) ? '_' : c)
            .filter(c -> Character.isLetterOrDigit(c) || c == '-' || c == '_')
            .map(String::valueOf)
            .collect(Collectors.joining());
}

Рішення можна вдосконалити, створивши користувальницький колектор, який використовує StringBuilder, тому вам не доведеться привчати кожного символу легкої ваги до важкої ваги.

Ви можете видалити недійсні символи ('/', '\', '?', '*'), А потім використовувати його.