web-dev-qa-db-ja.com

任意の文字列から有効なWindowsファイル名を作成する方法は?

ファイル名として使用したい「Foo:Bar」などの文字列がありますが、Windowsではファイル名に「:」文字を使用できません。

「Foo:Bar」を「Foo- Bar」のようなものに変える方法はありますか?

83
Ken

次のようなものを試してください:

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

編集:

GetInvalidFileNameChars()は10文字または15文字を返すため、単純な文字列の代わりにStringBuilderを使用することをお勧めします。元のバージョンは時間がかかり、より多くのメモリを消費します。

139
Diego Jancic
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.
31
Phil Price

これは効率的ではありませんが、もっと楽しいです:)

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

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;
}
11
Qwertie

ディエゴには正しい解決策がありますが、非常に小さな間違いが1つあります。使用されるstring.Replaceのバージョンはstring.Replace(char、char)である必要があり、string.Replace(char、string)はありません

答えを編集できないか、ささいな変更を加えただけです。

したがって、次のようになります。

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

ディエゴの答えにちょっとした工夫があります。

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のようなファイル名が生成されます

はい、それは本当に機能します:

Explorer sample

警告エンプター

このトリックがNTFSで機能することは知っていましたが、FATおよびFAT32パーティションでも機能することに驚きました。これは、 長いファイル名nicodeに格納されている であり、Windows 95/NTのように はるか昔 であるためです。 Win7、XP、さらにはLinuxベースのルーターでもテストしましたが、問題なく表示されました。 DOSBox内でも同じことは言えません。

とはいえ、これに夢中になる前に、実際に余分な忠実度が必要かどうかを検討してください。 Unicodeの類似物は、人々や古いプログラムを混乱させる可能性があります。古いOSは codepages に依存しています。

6
rkagerer

以下は、 Enumerable.Aggregate を使用するLinqを使用して受け入れられた回答のバージョンです。

string fileName = "something";

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

完全な効率のためにStringBuilderIndexOfAnyを一括追加で使用するバージョンがあります。また、重複する文字列を作成するのではなく、元の文字列を返します。

最後になりましたが、これには似たような文字を返すswitchステートメントがあり、任意の方法でカスタマイズできます。 nicode.orgのconfusablesルックアップ をチェックして、フォントに応じて、使用できるオプションを確認してください。

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のような予約名はチェックされません。置換が何であるかが明確ではないためです。

3
jnm2

別の簡単なソリューション:

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());
}
3
GDemartini

コードを少し掃除してリファクタリングを少し...文字列型の拡張を作成しました:

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 [] { ' ', ',' });

それが役に立てば幸い...

乾杯

2
Joan Vilariño

今日はこれを行う必要がありました...私の場合、最終的な.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));

無効な配列にスペース文字を追加すると、スペースを置き換えることもできます。

最速ではないかもしれませんが、パフォーマンスは問題ではなかったので、エレガントで理解しやすいことがわかりました。

乾杯!

0
Joan Vilariño

衝突を作成できないシステムが必要だったため、複数のキャラクターを1つにマッピングできませんでした。私は結局:

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)));
    }
}
0
mheyman