Как проверить, является ли данная строка допустимым / допустимым именем файла в Windows?

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

Вот список недопустимых символов из MSDN:

Use almost any character in the current code page for a name, including Unicode characters and characters in the extended character set (128–255), except for the following:

• The following reserved characters are not allowed: < > : " / \ | ? *
• Characters whose integer representations are in the range from zero through 31 are not allowed.
• Any other character that the target file system does not allow.

Вы можете получить список недопустимых символов из Path.GetInvalidPathChars и GetInvalidFileNameChars.

UPD: См. Предложение Стива Купера о том, как использовать их в регулярном выражении.

UPD2: Обратите внимание, что согласно разделу «Примечания» в MSDN «Массив, возвращаемый этим методом, не гарантирует, что он будет содержать полный набор символов, которые недопустимы в именах файлов и каталогов». Ответ предоставлен sixlettervaliables входит в более подробную информацию.

Имена файлов Windows довольно неограниченны, так что на самом деле это может даже не быть проблемой который. В Windows запрещены следующие символы:

\ / : * ? " < > |

Вы можете легко написать выражение, чтобы проверить, присутствуют ли эти символы. Однако лучшим решением было бы попытаться называть файлы так, как хочет пользователь, и предупреждать их, когда имя файла не сохраняется.

Также CON, PRN, AUX, NUL, COM # и некоторые другие никогда не являются допустимыми именами файлов в любом каталоге с любым расширением.

Microsoft Windows: ядро ​​Windows запрещает использование символов в диапазоне 1-31 (т. Е. 0x01-0x1F) и символов "*: <>? \ |. Хотя NTFS позволяет каждому компоненту пути (каталог или имя файла) быть длиной 255 символов и пути длиной до 32767 символов, ядро ​​Windows поддерживает только пути длиной до 259. Кроме того, Windows запрещает использование имен устройств MS-DOS AUX, CLOCK $, COM1, COM2, COM3, COM4, ​​COM5, COM6, COM7, COM8, COM9, CON, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8, LPT9, NUL и PRN, а также эти имена с любым расширением (например, AUX.txt), кроме случаев использования Длинные пути UNC (например, \. \ C: \ nul.txt или \? \ D: \ aux \ con). (Фактически, CLOCK $ может использоваться, если предоставляется расширение.) Эти ограничения применяются только к Windows - Linux, например, позволяет использовать "*: <>?" \ | даже в NTFS.

Источник: http://en.wikipedia.org/wiki/Filename

Для .Net Frameworks до 3.5 это должно работать:

Сопоставление регулярных выражений должно помочь вам. Вот фрагмент с использованием константы System.IO.Path.InvalidPathChars;

bool IsValidFilename(string testName)
{
    Regex containsABadCharacter = new Regex("[" 
          + Regex.Escape(System.IO.Path.InvalidPathChars) + "]");
    if (containsABadCharacter.IsMatch(testName)) { return false; };

    // other checks for UNC, drive-path format, etc

    return true;
}

Для .Net Frameworks после 3.0 это должно работать:

http://msdn.microsoft.com/en-us/library/system.io.path.getinvalidpathchars(v=vs.90).aspx

Сопоставление регулярных выражений должно помочь вам. Вот фрагмент с использованием константы System.IO.Path.GetInvalidPathChars();

bool IsValidFilename(string testName)
{
    Regex containsABadCharacter = new Regex("["
          + Regex.Escape(new string(System.IO.Path.GetInvalidPathChars())) + "]");
    if (containsABadCharacter.IsMatch(testName)) { return false; };

    // other checks for UNC, drive-path format, etc

    return true;
}

Как только вы это узнаете, вам также следует проверить наличие различных форматов, например c:\my\drive и \server\share\dir\file.ext.

Вопрос в том, пытаетесь ли вы определить, является ли имя пути допустимым путем Windows или разрешено в системе, в которой выполняется код.? Я думаю, что последнее более важно, поэтому лично я бы, вероятно, разложил полный путь и попытался использовать _mkdir для создания каталога, в котором находится файл, а затем попытаться создать файл.

Таким образом, вы узнаете не только то, содержит ли путь только допустимые символы Windows, но и действительно ли он представляет путь, который может быть записан этим процессом.

Из MSDN "Присвоение имени файлу или каталогу" здесь приведены общие соглашения о том, что такое допустимое имя файла в Windows:

Вы можете использовать любой символ в текущей кодовой странице (Unicode / ANSI выше 127), за исключением:

• <>:"/\|?*
• Символы, целочисленные представления которых от 0 до 31 (меньше, чем пространство ASCII)
• Любой другой символ, запрещенный целевой файловой системой (например, конечные точки или пробелы).
• Любое из имен DOS: CON, PRN, AUX, NUL, COM0, COM1, COM2, COM3, COM4, ​​COM5, COM6, COM7, COM8, COM9, LPT0, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8, LPT9 (и избегайте AUX.txt и т. д.)
• Имя файла - все точки

Некоторые необязательные вещи для проверки:

• Пути к файлам (включая имя файла) не могут содержать более 260 символов (без префикса \?\).
• Пути к файлам Unicode (включая имя файла) с более чем 32000 символов при использовании \?\ (обратите внимание, что префикс может расширить компоненты каталога и привести к превышению лимита в 32000)

Попробуйте использовать это и ловите ошибку. Разрешенный набор может меняться в зависимости от файловой системы или разных версий Windows. Другими словами, если вы хотите знать, нравится ли Windows это имя, передайте ему имя и позвольте ему сказать вам.

Вот что я использую:

    public static bool IsValidFileName(this string expression, bool platformIndependent)
    {
        string sPattern = @"^(?!^(PRN|AUX|CLOCK$|NUL|CON|COM\d|LPT\d|\..*)(\..+)?$)[^\x00-\x1f\?*:\"";|/]+$";
        if (platformIndependent)
        {
           sPattern = @"^(([a-zA-Z]:|\)\)?(((\.)|(\.\.)|([^/:\*\?""\|<>\. ](([^/:\*\?""\|<>\. ])|([^/:\*\?""\|<>]*[^/:\*\?""\|<>\. ]))?))\)*[^/:\*\?""\|<>\. ](([^/:\*\?""\|<>\. ])|([^/:\*\?""\|<>]*[^/:\*\?""\|<>\. ]))?$";
        }
        return (Regex.IsMatch(expression, sPattern, RegexOptions.CultureInvariant));
    }

Первый шаблон создает регулярное выражение, содержащее недопустимые / недопустимые имена файлов и символы только для платформ Windows. Второй делает то же самое, но гарантирует, что имя допустимо для любой платформы.

Регулярные выражения в этой ситуации излишни. Вы можете использовать метод String.IndexOfAny() в сочетании с Path.GetInvalidPathChars() и Path.GetInvalidFileNameChars().

Также обратите внимание, что оба метода Path.GetInvalidXXX() клонируют внутренний массив и возвращают клон. Поэтому, если вы собираетесь делать это много (тысячи и тысячи раз), вы можете кэшировать копию недопустимого массива символов для повторного использования.

Следует иметь в виду один угловой случай, который удивил меня, когда я впервые об этом узнал: Windows позволяет использовать пробелы в именах файлов! Например, все нижеприведенные имена являются законными и разными именами файлов в Windows (без кавычек):

"file.txt"
" file.txt"
"  file.txt"

Один вывод из этого: будьте осторожны при написании кода, который удаляет начальные / конечные пробелы из строки имени файла.

Этот класс очищает имена файлов и пути; используйте это как

var myCleanPath = PathSanitizer.SanitizeFilename(myBadPath, ' ');

Вот код;

/// <summary>
/// Cleans paths of invalid characters.
/// </summary>
public static class PathSanitizer
{
    /// <summary>
    /// The set of invalid filename characters, kept sorted for fast binary search
    /// </summary>
    private readonly static char[] invalidFilenameChars;
    /// <summary>
    /// The set of invalid path characters, kept sorted for fast binary search
    /// </summary>
    private readonly static char[] invalidPathChars;

    static PathSanitizer()
    {
        // set up the two arrays -- sorted once for speed.
        invalidFilenameChars = System.IO.Path.GetInvalidFileNameChars();
        invalidPathChars = System.IO.Path.GetInvalidPathChars();
        Array.Sort(invalidFilenameChars);
        Array.Sort(invalidPathChars);

    }

    /// <summary>
    /// Cleans a filename of invalid characters
    /// </summary>
    /// <param name = "input">the string to clean</param>
    /// <param name = "errorChar">the character which replaces bad characters</param>
    /// <returns></returns>
    public static string SanitizeFilename(string input, char errorChar)
    {
        return Sanitize(input, invalidFilenameChars, errorChar);
    }

    /// <summary>
    /// Cleans a path of invalid characters
    /// </summary>
    /// <param name = "input">the string to clean</param>
    /// <param name = "errorChar">the character which replaces bad characters</param>
    /// <returns></returns>
    public static string SanitizePath(string input, char errorChar)
    {
        return Sanitize(input, invalidPathChars, errorChar);
    }

    /// <summary>
    /// Cleans a string of invalid characters.
    /// </summary>
    /// <param name = "input"></param>
    /// <param name = "invalidChars"></param>
    /// <param name = "errorChar"></param>
    /// <returns></returns>
    private static string Sanitize(string input, char[] invalidChars, char errorChar)
    {
        // null always sanitizes to null
        if (input == null) { return null; }
        StringBuilder result = new StringBuilder();
        foreach (var characterToTest in input)
        {
            // we binary search for the character in the invalid set. This should be lightning fast.
            if (Array.BinarySearch(invalidChars, characterToTest) >= 0)
            {
                // we found the character in the array of 
                result.Append(errorChar);
            }
            else
            {
                // the character was not found in invalid, so it is valid.
                result.Append(characterToTest);
            }
        }

        // we're done.
        return result.ToString();
    }

}

Также важна файловая система назначения.

В NTFS некоторые файлы не могут быть созданы в определенных каталогах. НАПРИМЕР. $ Boot в корне

Чтобы дополнить другие ответы, вот несколько дополнительных крайних случаев, которые вы, возможно, захотите рассмотреть.

• У Excel могут возникнуть проблемы, если вы сохраните книгу в файле, имя которого содержит символы '[' или ']'. Подробнее см. http://support.microsoft.com/kb/215205.

• У Sharepoint есть целый дополнительный набор ограничений. Подробнее см. http://support.microsoft.com/kb/905231.

На этот вопрос уже дан ответ, но просто ради «других вариантов» вот неидеальный вопрос:

(неидеально, потому что использование исключений в качестве управления потоком, как правило, является "плохой вещью")

public static bool IsLegalFilename(string name)
{
    try 
    {
        var fileInfo = new FileInfo(name);
        return true;
    }
    catch
    {
        return false;
    }
}

Я использую это, чтобы избавиться от недопустимых символов в именах файлов без исключения исключений:

private static readonly Regex InvalidFileRegex = new Regex(
    string.Format("[{0}]", Regex.Escape(@"<>:""/\|?*")));

public static string SanitizeFileName(string fileName)
{
    return InvalidFileRegex.Replace(fileName, string.Empty);
}

Я предлагаю просто использовать Path.GetFullPath ()

string tagetFileFullNameToBeChecked;
try
{
  Path.GetFullPath(tagetFileFullNameToBeChecked)
}
catch(AugumentException ex)
{
  // invalid chars found
}

Упрощая ответ Юджина Каца:

bool IsFileNameCorrect(string fileName){
    return !fileName.Any(f=>Path.GetInvalidFileNameChars().Contains(f))
}

Или же

bool IsFileNameCorrect(string fileName){
    return fileName.All(f=>!Path.GetInvalidFileNameChars().Contains(f))
}

многие из этих ответов не будут работать, если имя файла слишком длинное и работает в среде до Windows 10. Точно так же подумайте о том, что вы хотите делать с точками - разрешение начального или конечного числа технически допустимо, но может создать проблемы, если вы не хотите, чтобы файл был трудно увидеть или удалить соответственно.

Это атрибут проверки, который я создал для проверки правильности имени файла.

public class ValidFileNameAttribute : ValidationAttribute
{
    public ValidFileNameAttribute()
    {
        RequireExtension = true;
        ErrorMessage = "{0} is an Invalid Filename";
        MaxLength = 255; //superseeded in modern windows environments
    }
    public override bool IsValid(object value)
    {
        //http://stackoverflow.com/questions/422090/in-c-sharp-check-that-filename-is-possibly-valid-not-that-it-exists
        var fileName = (string)value;
        if (string.IsNullOrEmpty(fileName)) { return true;  }
        if (fileName.IndexOfAny(Path.GetInvalidFileNameChars()) > -1 ||
            (!AllowHidden && fileName[0] == '.') ||
            fileName[fileName.Length - 1]== '.' ||
            fileName.Length > MaxLength)
        {
            return false;
        }
        string extension = Path.GetExtension(fileName);
        return (!RequireExtension || extension != string.Empty)
            && (ExtensionList==null || ExtensionList.Contains(extension));
    }
    private const string _sepChar = ",";
    private IEnumerable<string> ExtensionList { get; set; }
    public bool AllowHidden { get; set; }
    public bool RequireExtension { get; set; }
    public int MaxLength { get; set; }
    public string AllowedExtensions {
        get { return string.Join(_sepChar, ExtensionList); } 
        set {
            if (string.IsNullOrEmpty(value))
            { ExtensionList = null; }
            else {
                ExtensionList = value.Split(new char[] { _sepChar[0] })
                    .Select(s => s[0] == '.' ? s : ('.' + s))
                    .ToList();
            }
    } }

    public override bool RequiresValidationContext => false;
}

и тесты

[TestMethod]
public void TestFilenameAttribute()
{
    var rxa = new ValidFileNameAttribute();
    Assert.IsFalse(rxa.IsValid("pptx."));
    Assert.IsFalse(rxa.IsValid("pp.tx."));
    Assert.IsFalse(rxa.IsValid("."));
    Assert.IsFalse(rxa.IsValid(".pp.tx"));
    Assert.IsFalse(rxa.IsValid(".pptx"));
    Assert.IsFalse(rxa.IsValid("pptx"));
    Assert.IsFalse(rxa.IsValid("a/abc.pptx"));
    Assert.IsFalse(rxa.IsValid("a\abc.pptx"));
    Assert.IsFalse(rxa.IsValid("c:abc.pptx"));
    Assert.IsFalse(rxa.IsValid("c<abc.pptx"));
    Assert.IsTrue(rxa.IsValid("abc.pptx"));
    rxa = new ValidFileNameAttribute { AllowedExtensions = ".pptx" };
    Assert.IsFalse(rxa.IsValid("abc.docx"));
    Assert.IsTrue(rxa.IsValid("abc.pptx"));
}

Если вы только пытаетесь проверить, содержит ли строка, содержащая ваше имя / путь к файлу, какие-либо недопустимые символы, самый быстрый метод, который я нашел, - это использовать Split(), чтобы разбить имя файла на массив частей, где есть недопустимый символ. Если результатом является только массив из 1, недопустимые символы отсутствуют. :-)

var nameToTest = "Best file name \"ever\".txt";
bool isInvalidName = nameToTest.Split(System.IO.Path.GetInvalidFileNameChars()).Length > 1;

var pathToTest = "C:\My Folder <secrets>\";
bool isInvalidPath = pathToTest.Split(System.IO.Path.GetInvalidPathChars()).Length > 1;

Я пробовал запустить этот и другие методы, упомянутые выше, для имени файла / пути 1000000 раз в LinqPad.

Использование Split() составляет всего ~ 850 мс.

Использование Regex("[" + Regex.Escape(new string(System.IO.Path.GetInvalidPathChars())) + "]") занимает около 6 секунд.

Более сложные регулярные выражения выглядят НАМНОГО хуже, как и некоторые другие варианты, такие как использование различных методов класса Path для получения имени файла и их внутренней проверки выполнения работы (скорее всего, из-за накладных расходов на обработку исключений).

Конечно, не очень часто вам нужно проверять 1 миллион имен файлов, поэтому для большинства этих методов достаточно одной итерации. Но он по-прежнему довольно эффективен и действенен, если вы ищете только недопустимые символы.

Моя попытка:

using System.IO;

static class PathUtils
{
  public static string IsValidFullPath([NotNull] string fullPath)
  {
    if (string.IsNullOrWhiteSpace(fullPath))
      return "Path is null, empty or white space.";

    bool pathContainsInvalidChars = fullPath.IndexOfAny(Path.GetInvalidPathChars()) != -1;
    if (pathContainsInvalidChars)
      return "Path contains invalid characters.";

    string fileName = Path.GetFileName(fullPath);
    if (fileName == "")
      return "Path must contain a file name.";

    bool fileNameContainsInvalidChars = fileName.IndexOfAny(Path.GetInvalidFileNameChars()) != -1;
    if (fileNameContainsInvalidChars)
      return "File name contains invalid characters.";

    if (!Path.IsPathRooted(fullPath))
      return "The path must be absolute.";

    return "";
  }
}

Это не идеально, потому что Path.GetInvalidPathChars не возвращает полный набор символов, которые недопустимы в именах файлов и каталогов, и, конечно, есть еще много тонкостей.

Поэтому я использую этот метод как дополнение:

public static bool TestIfFileCanBeCreated([NotNull] string fullPath)
{
  if (string.IsNullOrWhiteSpace(fullPath))
    throw new ArgumentException("Value cannot be null or whitespace.", "fullPath");

  string directoryName = Path.GetDirectoryName(fullPath);
  if (directoryName != null) Directory.CreateDirectory(directoryName);
  try
  {
    using (new FileStream(fullPath, FileMode.CreateNew)) { }
    File.Delete(fullPath);
    return true;
  }
  catch (IOException)
  {
    return false;
  }
}

Он пытается создать файл и вернуть false в случае исключения. Конечно, мне нужно создать файл, но я думаю, что это самый безопасный способ сделать это. Также обратите внимание, что я не удаляю созданные каталоги.

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

Я получил эту идею от кого-то. - не знаю кто. Пусть ОС сделает всю тяжелую работу.

public bool IsPathFileNameGood(string fname)
{
    bool rc = Constants.Fail;
    try
    {
        this._stream = new StreamWriter(fname, true);
        rc = Constants.Pass;
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message, "Problem opening file");
        rc = Constants.Fail;
    }
    return rc;
}

Эта проверка

static bool IsValidFileName(string name)
{
    return
        !string.IsNullOrWhiteSpace(name) &&
        name.IndexOfAny(Path.GetInvalidFileNameChars()) < 0 &&
        !Path.GetFullPath(name).StartsWith(@"\.\");
}

отфильтровывает имена с недопустимыми символами (<>:"/\|?* и ASCII 0-31), а также зарезервированные устройства DOS (CON, NUL, COMx). Он позволяет использовать начальные пробелы и имена, состоящие из точек, в соответствии с Path.GetFullPath. (Создание файла с ведущими пробелами в моей системе выполняется успешно).

Использовал .NET Framework 4.7.1, протестирован на Windows 7.

Один лайнер для проверки незаконных символов в строке:

public static bool IsValidFilename(string testName) => !Regex.IsMatch(testName, "[" + Regex.Escape(new string(System.IO.Path.InvalidPathChars)) + "]");

На мой взгляд, единственный правильный ответ на этот вопрос - попытаться использовать путь и позволить ОС и файловой системе проверить его. В противном случае вы просто повторно реализуете (и, вероятно, плохо) все правила проверки, которые уже используют ОС и файловая система, и если эти правила будут изменены в будущем, вам придется изменить свой код, чтобы он соответствовал им.