web-dev-qa-db-ja.com

C＃サニタイズファイル名

私は最近、多くのMP3をさまざまな場所からリポジトリに移動しています。 ID3タグを使用して新しいファイル名を作成していたので（TagLib-Sharp！）、_System.NotSupportedException_を取得していることに気付きました。

"指定されたパスの形式はサポートされていません。"

これは、File.Copy()またはDirectory.CreateDirectory()によって生成されました。

私のファイル名をサニタイズする必要があることに気付くのにそれほど時間はかかりませんでした。だから私は明らかなことをした：

_public static string SanitizePath_(string path, char replaceChar)
{
    string dir = Path.GetDirectoryName(path);
    foreach (char c in Path.GetInvalidPathChars())
        dir = dir.Replace(c, replaceChar);

    string name = Path.GetFileName(path);
    foreach (char c in Path.GetInvalidFileNameChars())
        name = name.Replace(c, replaceChar);

    return dir + name;
}
_

驚いたことに、私は例外を受け取り続けました。 '：'はPath.GetInvalidPathChars()のセットにはないことがわかりました。これは、パスルートで有効だからです。それは理にかなっていると思いますが、これはかなり一般的な問題でなければなりません。誰かがパスを消毒する短いコードを持っていますか？私がこれを思いついた最も徹底的な、しかしそれはおそらくやり過ぎのように感じます。

_    // replaces invalid characters with replaceChar
    public static string SanitizePath(string path, char replaceChar)
    {
        // construct a list of characters that can't show up in filenames.
        // need to do this because ":" is not in InvalidPathChars
        if (_BadChars == null)
        {
            _BadChars = new List<char>(Path.GetInvalidFileNameChars());
            _BadChars.AddRange(Path.GetInvalidPathChars());
            _BadChars = Utility.GetUnique<char>(_BadChars);
        }

        // remove root
        string root = Path.GetPathRoot(path);
        path = path.Remove(0, root.Length);

        // split on the directory separator character. Need to do this
        // because the separator is not valid in a filename.
        List<string> parts = new List<string>(path.Split(new char[]{Path.DirectorySeparatorChar}));

        // check each part to make sure it is valid.
        for (int i = 0; i < parts.Count; i++)
        {
            string part = parts[i];
            foreach (char c in _BadChars)
            {
                part = part.Replace(c, replaceChar);
            }
            parts[i] = part;
        }

        return root + Utility.Join(parts, Path.DirectorySeparatorChar.ToString());
    }
_

この機能をより速くし、バロックを少なくするための改善は大歓迎です。

c#validationpathsanitizeinvalid-characters
154
Jason Sundram

ファイル名をクリーンアップするには、これを行うことができます

private static string MakeValidFileName( string name )
{
   string invalidChars = System.Text.RegularExpressions.Regex.Escape( new string( System.IO.Path.GetInvalidFileNameChars() ) );
   string invalidRegStr = string.Format( @"([{0}]*\.+$)|([{0}]+)", invalidChars );

   return System.Text.RegularExpressions.Regex.Replace( name, invalidRegStr, "_" );
}
289
Andre

より短い解決策：

var invalids = System.IO.Path.GetInvalidFileNameChars();
var newName = String.Join("_", origFileName.Split(invalids, StringSplitOptions.RemoveEmptyEntries) ).TrimEnd('.');
100
DenNukem

Andreの優れた回答に基づいていますが、予約語に関するSpudのコメントを考慮して、このバージョンを作成しました。

/// <summary>
/// Strip illegal chars and reserved words from a candidate filename (should not include the directory path)
/// </summary>
/// <remarks>
/// http://stackoverflow.com/questions/309485/c-sharp-sanitize-file-name
/// </remarks>
public static string CoerceValidFileName(string filename)
{
    var invalidChars = Regex.Escape(new string(Path.GetInvalidFileNameChars()));
    var invalidReStr = string.Format(@"[{0}]+", invalidChars);

    var reservedWords = new []
    {
        "CON", "PRN", "AUX", "CLOCK$", "NUL", "COM0", "COM1", "COM2", "COM3", "COM4",
        "COM5", "COM6", "COM7", "COM8", "COM9", "LPT0", "LPT1", "LPT2", "LPT3", "LPT4",
        "LPT5", "LPT6", "LPT7", "LPT8", "LPT9"
    };

    var sanitisedNamePart = Regex.Replace(filename, invalidReStr, "_");
    foreach (var reservedWord in reservedWords)
    {
        var reservedWordPattern = string.Format("^{0}\\.", reservedWord);
        sanitisedNamePart = Regex.Replace(sanitisedNamePart, reservedWordPattern, "_reservedWord_.", RegexOptions.IgnoreCase);
    }

    return sanitisedNamePart;
}

そして、これらは私のユニットテストです

[Test]
public void CoerceValidFileName_SimpleValid()
{
    var filename = @"thisIsValid.txt";
    var result = PathHelper.CoerceValidFileName(filename);
    Assert.AreEqual(filename, result);
}

[Test]
public void CoerceValidFileName_SimpleInvalid()
{
    var filename = @"thisIsNotValid\3\\_3.txt";
    var result = PathHelper.CoerceValidFileName(filename);
    Assert.AreEqual("thisIsNotValid_3__3.txt", result);
}

[Test]
public void CoerceValidFileName_InvalidExtension()
{
    var filename = @"thisIsNotValid.t\xt";
    var result = PathHelper.CoerceValidFileName(filename);
    Assert.AreEqual("thisIsNotValid.t_xt", result);
}

[Test]
public void CoerceValidFileName_KeywordInvalid()
{
    var filename = "aUx.txt";
    var result = PathHelper.CoerceValidFileName(filename);
    Assert.AreEqual("_reservedWord_.txt", result);
}

[Test]
public void CoerceValidFileName_KeywordValid()
{
    var filename = "auxillary.txt";
    var result = PathHelper.CoerceValidFileName(filename);
    Assert.AreEqual("auxillary.txt", result);
}
68
fiat
string clean = String.Concat(dirty.Split(Path.GetInvalidFileNameChars()));
29
data

私はSystem.IO.Path.GetInvalidFileNameChars()メソッドを使用して無効な文字をチェックしていますが、問題はありません。

私は次のコードを使用しています：

foreach( char invalidchar in System.IO.Path.GetInvalidFileNameChars())
{
    filename = filename.Replace(invalidchar, '_');
}
4
André Leal

文字を単にアンダースコアに置き換えるだけでなく、何らかの方法で文字を保持したかったのです。

私が考えた方法の1つは、（私の状況では）通常のキャラクターとして使用される可能性が低い類似したキャラクターにキャラクターを置き換えることでした。だから私は無効な文字のリストを取り、似ているように見えました。

以下は、類似にエンコードおよびデコードする関数です。

このコードには、すべてのSystem.IO.Path.GetInvalidFileNameChars（）文字の完全なリストは含まれていません。したがって、残りのアンダースコア置換を拡張または利用するのはユーザー次第です文字

private static Dictionary<string, string> EncodeMapping()
{
    //-- Following characters are invalid for windows file and folder names.
    //-- \/:*?"<>|
    Dictionary<string, string> dic = new Dictionary<string, string>();
    dic.Add(@"\", "Ì"); // U+OOCC
    dic.Add("/", "Í"); // U+OOCD
    dic.Add(":", "¦"); // U+00A6
    dic.Add("*", "¤"); // U+00A4
    dic.Add("?", "¿"); // U+00BF
    dic.Add(@"""", "ˮ"); // U+02EE
    dic.Add("<", "«"); // U+00AB
    dic.Add(">", "»"); // U+00BB
    dic.Add("|", "│"); // U+2502
    return dic;
}

public static string Escape(string name)
{
    foreach (KeyValuePair<string, string> replace in EncodeMapping())
    {
        name = name.Replace(replace.Key, replace.Value);
    }

    //-- handle dot at the end
    if (name.EndsWith(".")) name = name.CropRight(1) + "°";

    return name;
}

public static string UnEscape(string name)
{
    foreach (KeyValuePair<string, string> replace in EncodeMapping())
    {
        name = name.Replace(replace.Value, replace.Key);
    }

    //-- handle dot at the end
    if (name.EndsWith("°")) name = name.CropRight(1) + ".";

    return name;
}

独自の外観を選択できます。 WindowsでCharacter Mapアプリを使用して、私のものを選択しました%windir%\system32\charmap.exe

発見を通じて調整を行っているため、このコードを更新します。

3
Valamas

問題は、最初にPath.GetDirectoryName悪い文字列。これにファイル名以外の文字が含まれている場合、.Netは文字列のどの部分がディレクトリであり、スローされるかを判断できません。文字列の比較を行う必要があります。

パス全体ではなく、ファイル名のみが悪いと仮定して、これを試してください：

public static string SanitizePath(string path, char replaceChar)
{
    int filenamePos = path.LastIndexOf(Path.DirectorySeparatorChar) + 1;
    var sb = new System.Text.StringBuilder();
    sb.Append(path.Substring(0, filenamePos));
    for (int i = filenamePos; i < path.Length; i++)
    {
        char filenameChar = path[i];
        foreach (char c in Path.GetInvalidFileNameChars())
            if (filenameChar.Equals(c))
            {
                filenameChar = replaceChar;
                break;
            }

        sb.Append(filenameChar);
    }

    return sb.ToString();
}
2
Dour High Arch

過去にこれで成功しました。

素晴らしく、短く、静的です:-)

    public static string returnSafeString(string s)
    {
        foreach (char character in Path.GetInvalidFileNameChars())
        {
            s = s.Replace(character.ToString(),string.Empty);
        }

        foreach (char character in Path.GetInvalidPathChars())
        {
            s = s.Replace(character.ToString(), string.Empty);
        }

        return (s);
    }
2
Helix 88

Andreのコードに基づく効率的な遅延読み込み拡張メソッドは次のとおりです。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace LT
{
    public static class Utility
    {
        static string invalidRegStr;

        public static string MakeValidFileName(this string name)
        {
            if (invalidRegStr == null)
            {
                var invalidChars = System.Text.RegularExpressions.Regex.Escape(new string(System.IO.Path.GetInvalidFileNameChars()));
                invalidRegStr = string.Format(@"([{0}]*\.+$)|([{0}]+)", invalidChars);
            }

            return System.Text.RegularExpressions.Regex.Replace(name, invalidRegStr, "_");
        }
    }
}
1
Bryan Legend

ここには多くの実用的なソリューションがあります。完全を期すために、正規表現を使用せず、LINQを使用するアプローチを次に示します。

var invalids = Path.GetInvalidFileNameChars();
filename = invalids.Aggregate(filename, (current, c) => current.Replace(c, '_'));

また、それは非常に短い解決策です;）

1
kappadoky

ディレクトリとファイル名を一緒に追加し、それらを個別にサニタイズするのではなく、サニタイズすると、コードがよりきれいになります。 ：をサニタイズ解除するには、文字列の2番目の文字を使用します。 「replacechar」と等しい場合は、コロンに置き換えます。このアプリは自分で使用するため、このようなソリューションで十分です。

0
Brian