Як зробити дійсне ім’я файлу Windows із довільного рядка?

У мене є рядок на зразок "Foo: Bar", який я хочу використовувати як ім'я файлу, але у Windows символ ":" не дозволений в імені файлу.

Чи існує метод, який перетворить "Foo: Bar" на щось на зразок "Foo-Bar"?

Спробуйте щось подібне:

string fileName = "something";
foreach (char c in System.IO.Path.GetInvalidFileNameChars())
{
   fileName = fileName.Replace(c, '_');
}

Редагувати:

Оскільки GetInvalidFileNameChars()поверне 10 або 15 символів, краще використовувати StringBuilderзамість простого рядка; оригінальна версія займе більше часу і займе більше пам'яті.

fileName = fileName.Replace(":", "-") 

Однак ":" - не єдиний незаконний символ для Windows. Вам також доведеться обробити:

/, \, :, *, ?, ", <, > and |

Вони містяться в System.IO.Path.GetInvalidFileNameChars ();

Також (у Windows), "." не може бути єдиним символом в назві файлу (обидва ".", "..", "..." тощо) недійсні). Будьте обережні, називаючи файли ".", Наприклад:

echo "test" > .test.

Згенерує файл із назвою ".test"

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

CON, PRN, AUX, CLOCK$, NUL
COM0, COM1, COM2, COM3, COM4, COM5, COM6, COM7, COM8, COM9
LPT0, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8, and LPT9.

Це не ефективніше, але веселіше :)

var fileName = "foo:bar";
var invalidChars = System.IO.Path.GetInvalidFileNameChars();
var cleanFileName = new string(fileName.Where(m => !invalidChars.Contains(m)).ToArray<char>());

Якщо хтось хоче оптимізовану версію на основі StringBuilder, використовуйте це. Включає трюк rkagerer як варіант.

static char[] _invalids;

/// <summary>Replaces characters in <c>text</c> that are not allowed in 
/// file names with the specified replacement character.</summary>
/// <param name="text">Text to make into a valid filename. The same string is returned if it is valid already.</param>
/// <param name="replacement">Replacement character, or null to simply remove bad characters.</param>
/// <param name="fancy">Whether to replace quotes and slashes with the non-ASCII characters ” and ⁄.</param>
/// <returns>A string that can be used as a filename. If the output string would otherwise be empty, returns "_".</returns>
public static string MakeValidFileName(string text, char? replacement = '_', bool fancy = true)
{
    StringBuilder sb = new StringBuilder(text.Length);
    var invalids = _invalids ?? (_invalids = Path.GetInvalidFileNameChars());
    bool changed = false;
    for (int i = 0; i < text.Length; i++) {
        char c = text[i];
        if (invalids.Contains(c)) {
            changed = true;
            var repl = replacement ?? '\0';
            if (fancy) {
                if (c == '"')       repl = '”'; // U+201D right double quotation mark
                else if (c == '\'') repl = '’'; // U+2019 right single quotation mark
                else if (c == '/')  repl = '⁄'; // U+2044 fraction slash
            }
            if (repl != '\0')
                sb.Append(repl);
        } else
            sb.Append(c);
    }
    if (sb.Length == 0)
        return "_";
    return changed ? sb.ToString() : text;
}

Ось версія прийнятої відповіді, в Linqякій використовуються Enumerable.Aggregate:

string fileName = "something";

Path.GetInvalidFileNameChars()
    .Aggregate(fileName, (current, c) => current.Replace(c, '_'));

Дієго має правильне рішення, але тут є одна дуже маленька помилка. Версія рядка. Замінник, який використовується, повинен бути рядком. Замінити (char, char), рядок не існує. Замінити (char, string)

Я не можу редагувати відповідь, інакше я б просто вніс незначну зміну.

Так повинно бути:

string fileName = "something";
foreach (char c in System.IO.Path.GetInvalidFileNameChars())
{
   fileName = fileName.Replace(c, '_');
}

Ось невеликий поворот у відповіді Дієго.

Якщо ви не боїтеся Unicode, ви можете зберегти трохи більше вірності, замінивши недійсні символи дійсними символами Unicode, що нагадують їх. Ось код, який я використав у недавньому проекті, що включає списки пиломатеріалів:

static string MakeValidFilename(string text) {
  text = text.Replace('\'', '’'); // U+2019 right single quotation mark
  text = text.Replace('"',  '”'); // U+201D right double quotation mark
  text = text.Replace('/', '⁄');  // U+2044 fraction slash
  foreach (char c in System.IO.Path.GetInvalidFileNameChars()) {
    text = text.Replace(c, '_');
  }
  return text;
}

Це створює імена файлів, як 1⁄2” spruce.txtзамість1_2_ spruce.txt

Так, це справді працює:

Caveat Emptor

Я знав, що цей трюк спрацює на NTFS, але з подивом виявив, що він також працює на розділах FAT та FAT32. Це тому довгі імена файлів які зберігаються в Unicode , навіть ще в Windows 95 / NT. Я тестував на Win7, XP і навіть маршрутизаторі на базі Linux, і вони виявилися нормальними. Не можу сказати те саме для DOSBox.

Тим не менш, перед тим, як з'їхати з цього питання, подумайте, чи справді вам потрібна додаткова вірність. Подібні схожі на Unicode можуть заплутати людей або старі програми, наприклад, старша ОС покладається на кодові сторінки .

Ось версія, яка використовує StringBuilderіIndexOfAny додає оптом для повного використання. Він також повертає початковий рядок, а не створює повторюваний рядок.

І останнє, але не менш важливе: він має оператор switch, який повертає схожі символи, які ви можете налаштувати будь-яким способом. Ознайомтеся з пошуковим запитом Unicode.org, щоб побачити, які варіанти ви можете мати, залежно від шрифту.

public static string GetSafeFilename(string arbitraryString)
{
    var invalidChars = System.IO.Path.GetInvalidFileNameChars();
    var replaceIndex = arbitraryString.IndexOfAny(invalidChars, 0);
    if (replaceIndex == -1) return arbitraryString;

    var r = new StringBuilder();
    var i = 0;

    do
    {
        r.Append(arbitraryString, i, replaceIndex - i);

        switch (arbitraryString[replaceIndex])
        {
            case '"':
                r.Append("''");
                break;
            case '<':
                r.Append('\u02c2'); // '˂' (modifier letter left arrowhead)
                break;
            case '>':
                r.Append('\u02c3'); // '˃' (modifier letter right arrowhead)
                break;
            case '|':
                r.Append('\u2223'); // '∣' (divides)
                break;
            case ':':
                r.Append('-');
                break;
            case '*':
                r.Append('\u2217'); // '∗' (asterisk operator)
                break;
            case '\\':
            case '/':
                r.Append('\u2044'); // '⁄' (fraction slash)
                break;
            case '\0':
            case '\f':
            case '?':
                break;
            case '\t':
            case '\n':
            case '\r':
            case '\v':
                r.Append(' ');
                break;
            default:
                r.Append('_');
                break;
        }

        i = replaceIndex + 1;
        replaceIndex = arbitraryString.IndexOfAny(invalidChars, i);
    } while (replaceIndex != -1);

    r.Append(arbitraryString, i, arbitraryString.Length - i);

    return r.ToString();
}

Він не перевіряє ., ..чи зарезервовані імена , як , CONтому що не ясно , що заміна повинна бути.

Трохи очистивши свій код і зробивши невелику рефакторинг ... Я створив розширення для типу рядка:

public static string ToValidFileName(this string s, char replaceChar = '_', char[] includeChars = null)
{
  var invalid = Path.GetInvalidFileNameChars();
  if (includeChars != null) invalid = invalid.Union(includeChars).ToArray();
  return string.Join(string.Empty, s.ToCharArray().Select(o => o.In(invalid) ? replaceChar : o));
}

Тепер простіше використовувати:

var name = "Any string you want using ? / \ or even +.zip";
var validFileName = name.ToValidFileName();

Якщо ви хочете замінити іншим символом, ніж "_", ви можете використовувати:

var validFileName = name.ToValidFileName(replaceChar:'#');

І ви можете додати символи для заміни .. наприклад, вам не потрібні пробіли або коми:

var validFileName = name.ToValidFileName(includeChars: new [] { ' ', ',' });

Сподіваюся, це допомагає ...

Ура

Ще одне просте рішення:

private string MakeValidFileName(string original, char replacementChar = '_')
{
  var invalidChars = new HashSet<char>(Path.GetInvalidFileNameChars());
  return new string(original.Select(c => invalidChars.Contains(c) ? replacementChar : c).ToArray());
}

Простий однорядковий код:

var validFileName = Path.GetInvalidFileNameChars().Aggregate(fileName, (f, c) => f.Replace(c, '_'));

Ви можете обернути його методом розширення, якщо хочете використовувати його повторно.

public static string ToValidFileName(this string fileName) => Path.GetInvalidFileNameChars().Aggregate(fileName, (f, c) => f.Replace(c, '_'));

Мені потрібна була система, яка не могла створювати зіткнення, тому я не міг зіставити кілька символів з одним. Я закінчив з:

public static class Extension
{
    /// <summary>
    /// Characters allowed in a file name. Note that curly braces don't show up here
    /// becausee they are used for escaping invalid characters.
    /// </summary>
    private static readonly HashSet<char> CleanFileNameChars = new HashSet<char>
    {
        ' ', '!', '#', '$', '%', '&', '\'', '(', ')', '+', ',', '-', '.',
        '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '=', '@',
        'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M',
        'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z',
        '[', ']', '^', '_', '`',
        'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm',
        'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z',
    };

    /// <summary>
    /// Creates a clean file name from one that may contain invalid characters in 
    /// a way that will not collide.
    /// </summary>
    /// <param name="dirtyFileName">
    /// The file name that may contain invalid filename characters.
    /// </param>
    /// <returns>
    /// A file name that does not contain invalid filename characters.
    /// </returns>
    /// <remarks>
    /// <para>
    /// Escapes invalid characters by converting their ASCII values to hexadecimal
    /// and wrapping that value in curly braces. Curly braces are escaped by doubling
    /// them, for example '{' => "{{".
    /// </para>
    /// <para>
    /// Note that although NTFS allows unicode characters in file names, this
    /// method does not.
    /// </para>
    /// </remarks>
    public static string CleanFileName(this string dirtyFileName)
    {
        string EscapeHexString(char c) =>
            "{" + (c > 255 ? $"{(uint)c:X4}" : $"{(uint)c:X2}") + "}";

        return string.Join(string.Empty,
                           dirtyFileName.Select(
                               c =>
                                   c == '{' ? "{{" :
                                   c == '}' ? "}}" :
                                   CleanFileNameChars.Contains(c) ? $"{c}" :
                                   EscapeHexString(c)));
    }
}

Мені потрібно було зробити це сьогодні ... у моєму випадку мені потрібно було об’єднати ім’я клієнта з датою та часом остаточного файлу .kmz. Моє остаточне рішення було таким:

 string name = "Whatever name with valid/invalid chars";
 char[] invalid = System.IO.Path.GetInvalidFileNameChars();
 string validFileName = string.Join(string.Empty,
                            string.Format("{0}.{1:G}.kmz", name, DateTime.Now)
                            .ToCharArray().Select(o => o.In(invalid) ? '_' : o));

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

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

Ура!

Ви можете зробити це за допомогою sedкоманди:

 sed -e "
 s/[?()\[\]=+<>:;©®”,*|]/_/g
 s/"$'\t'"/ /g
 s/–/-/g
 s/\"/_/g
 s/[[:cntrl:]]/_/g"