Как закодировать параметр имени файла заголовка Content-Disposition в HTTP?

Я обычно URL-кодирую (с% xx) имена файлов, и, похоже, это работает во всех браузерах. В любом случае вы можете захотеть провести несколько тестов.

Это обсуждается, включая ссылки на тестирование браузера и обратную совместимость, в предложенном RFC 5987, «Набор символов и языковая кодировка для параметров поля заголовка протокола передачи гипертекста (HTTP)».

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

Следующий документ, связанный с проект RFC, упомянутый Джим в его ответе, дополнительно рассматривает вопрос и определенно заслуживает прямого упоминания здесь:

Тестовые примеры для заголовка HTTP Content-Disposition и кодирования RFC 2231/2047

• В Content-Disposition нет совместимого способа кодирования имен, отличных от ASCII. Совместимость браузера - беспорядок.

• теоретически правильный синтаксис для использования UTF-8 в Content-Disposition очень странный: filename*=UTF-8''foo%c3%a4 (да, это звездочка, и никаких кавычек, кроме пустой одинарной кавычки посередине)

• Этот заголовок не совсем стандартный (Спецификация HTTP / 1.1 подтверждает его существование, но не требует, чтобы клиенты его поддерживали).

Есть простая и очень надежная альтернатива: используйте URL-адрес, содержащий желаемое имя файла.

Когда имя после последней косой черты - то, что вам нужно, вам не нужны дополнительные заголовки!

Этот трюк работает:

/real_script.php/fake_filename.doc

И если ваш сервер поддерживает перезапись URL (например, mod_rewrite в Apache), вы можете полностью скрыть часть скрипта.

Символы в URL-адресах должны быть в кодировке UTF-8 побайтно:

/mot%C3%B6rhead   # motörhead

в asp.net mvc2 я использую что-то вроде этого:

return File(
    tempFile
    , "application/octet-stream"
    , HttpUtility.UrlPathEncode(fileName)
    );

Я думаю, если вы не используете mvc (2), вы можете просто закодировать имя файла, используя

HttpUtility.UrlPathEncode(fileName)

Я знаю, что это старый пост, но он все еще очень актуален. Я обнаружил, что современные браузеры поддерживают rfc5987, который позволяет кодировать utf-8 с процентной кодировкой (с кодировкой url). Тогда Naïve file.txt станет:

Content-Disposition: attachment; filename*=UTF-8''Na%C3%AFve%20file.txt

Safari (5) не поддерживает это. Вместо этого вы должны использовать стандарт Safari для записи имени файла непосредственно в заголовок в кодировке utf-8:

Content-Disposition: attachment; filename=Naïve file.txt

IE8 и более ранние версии также не поддерживают его, и вам нужно использовать стандарт IE для кодировки utf-8 с процентной кодировкой:

Content-Disposition: attachment; filename=Na%C3%AFve%20file.txt

В ASP.Net я использую следующий код:

string contentDisposition;
if (Request.Browser.Browser == "IE" && (Request.Browser.Version == "7.0" || Request.Browser.Version == "8.0"))
    contentDisposition = "attachment; filename = " + Uri.EscapeDataString(fileName);
else if (Request.Browser.Browser == "Safari")
    contentDisposition = "attachment; filename = " + fileName;
else
    contentDisposition = "attachment; filename*=UTF-8''" + Uri.EscapeDataString(fileName);
Response.AddHeader("Content-Disposition", contentDisposition);

Я тестировал вышеуказанное, используя IE7, IE8, IE9, Chrome 13, Opera 11, FF5, Safari 5.

Обновлять ноябрь 2013 г .:

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

string contentDisposition;
if (Request.Browser.Browser == "IE" && (Request.Browser.Version == "7.0" || Request.Browser.Version == "8.0"))
    contentDisposition = "attachment; filename = " + Uri.EscapeDataString(fileName);
else if (Request.UserAgent != null && Request.UserAgent.ToLowerInvariant().Contains("android")) // android built-in download manager (all browsers on android)
    contentDisposition = "attachment; filename=\"" + MakeAndroidSafeFileName(fileName) + "\"";
else
    contentDisposition = "attachment; filename=\"" + fileName + "\"; filename*=UTF-8''" + Uri.EscapeDataString(fileName);
Response.AddHeader("Content-Disposition", contentDisposition);

Вышеупомянутое теперь протестировано в IE7-11, Chrome 32, Opera 12, FF25, Safari 6 с использованием этого файла для загрузки: 你好 abcABCæøåÆØÅäöüïëêîâéíáóúýñ½§! # ¤% & () = `@ £ $ € {[]} + ´¨ ^ ~ '-_,;. txt

В IE7 это работает для некоторых символов, но не для всех. Но кого сейчас волнует IE7?

Это функция, которую я использую для создания безопасных имен файлов для Android. Обратите внимание, что я не знаю, какие символы поддерживаются на Android, но я проверил, что они работают точно:

private static readonly Dictionary<char, char> AndroidAllowedChars = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ._-+,@£$€!½§~'=()[]{}0123456789".ToDictionary(c => c);
private string MakeAndroidSafeFileName(string fileName)
{
    char[] newFileName = fileName.ToCharArray();
    for (int i = 0; i < newFileName.Length; i++)
    {
        if (!AndroidAllowedChars.ContainsKey(newFileName[i]))
            newFileName[i] = '_';
    }
    return new string(newFileName);
}

@TomZ: Я тестировал IE7 и IE8, и оказалось, что мне не нужно избегать апострофа ('). У вас есть пример, когда это не удается?

@Dave Van den Eynde: объединение двух имен файлов в одной строке, как в соответствии с RFC6266, работает за исключением Android и IE7 + 8, и я обновил код, чтобы отразить это. Спасибо за предложение.

@Thilo: Не знаю ни о GoodReader, ни о каком-либо другом небраузере. Возможно, вам повезет с использованием подхода Android.

@ Алексей Жуковский: Я не знаю почему, но, как обсуждалось на Соединять, похоже, что это работает не очень хорошо.

Я протестировал следующий код во всех основных браузерах, включая старые проводники (в режиме совместимости), и он везде хорошо работает:

$filename = $_GET['file']; //this string from $_GET is already decoded
if (strstr($_SERVER['HTTP_USER_AGENT'],"MSIE"))
  $filename = rawurlencode($filename);
header('Content-Disposition: attachment; filename = "'.$filename.'"');

Я использую следующие фрагменты кода для кодирования (предполагая, что имя файла содержит имя файла и расширение файла, например: test.txt):

PHP:

if ( strpos ( $_SERVER [ 'HTTP_USER_AGENT' ], "MSIE" ) > 0 )
{
     header ( 'Content-Disposition: attachment; filename = "' . rawurlencode ( $fileName ) . '"' );
}
else
{
     header( 'Content-Disposition: attachment; filename*=UTF-8\'\'' . rawurlencode ( $fileName ) );
}

Ява:

fileName = request.getHeader ( "user-agent" ).contains ( "MSIE" ) ? URLEncoder.encode ( fileName, "utf-8") : MimeUtility.encodeWord ( fileName );
response.setHeader ( "Content-disposition", "attachment; filename=\"" + fileName + "\"");

RFC 6266 описывает «Использование поля заголовка Content-Disposition в протоколе передачи гипертекста (HTTP)». Цитата из этого:

6. Internationalization Considerations

The “filename*” parameter (Section 4.3), using the encoding defined in [RFC5987], allows the server to transmit characters outside the ISO-8859-1 character set, and also to optionally specify the language in use.

И в их раздел примеров:

This example is the same as the one above, but adding the "filename" parameter for compatibility with user agents not implementing RFC 5987:

Content-Disposition: attachment;
                     filename = "EURO rates";
                     filename*=utf-8''%e2%82%ac%20rates

Note: Those user agents that do not support the RFC 5987 encoding ignore “filename*” when it occurs after “filename”.

В Приложение D. также есть длинный список предложений по увеличению интероперабельности. Он также указывает на сайт, который сравнивает реализации. Текущие универсальные тесты, подходящие для общих имен файлов, включают:

• attwithisofnplain: простое имя файла ISO-8859-1 с двойными кавычками и без кодировки. Для этого требуется имя файла, которое соответствует стандарту ISO-8859-1 и не содержит знаков процента, по крайней мере, не перед шестнадцатеричными цифрами.
• attfnboth: два параметра в порядке, описанном выше. Должен работать для большинства имен файлов в большинстве браузеров, хотя IE8 будет использовать параметр «filename».

Этот RFC 5987, в свою очередь, ссылается на RFC 2231, который описывает фактический формат. 2231 в первую очередь предназначен для почты, а 5987 сообщает нам, какие части также могут использоваться для заголовков HTTP. Не путайте это с заголовками MIME, используемыми внутри multipart/form-data HTTP тело, который регулируется RFC 2388 (в частности, Раздел 4.4) и HTML 5 черновик.

У нас была аналогичная проблема в веб-приложении, и в итоге мы прочитали имя файла из HTML <input type = "file"> и установили его в форме с кодировкой URL в новом HTML <input type = "hidden">. Конечно, нам пришлось удалить путь типа «C: \ fakepath \», который возвращают некоторые браузеры.

Конечно, это не дает прямого ответа на вопрос ОП, но может быть решением для других.

Я получил следующий код в моем скрипте "download.php" (на основе этот пост в блоге и эти тестовые примеры).

$il1_filename = utf8_decode($filename);
$to_underscore = "\"\#*;:|<>/?";
$safe_filename = strtr($il1_filename, $to_underscore, str_repeat("_", strlen($to_underscore)));

header("Content-Disposition: attachment; filename=\"$safe_filename\""
.( $safe_filename === $filename ? "" : "; filename*=UTF-8''".rawurlencode($filename) ));

Используется стандартный способ filename = "..." до тех пор, пока используются только iso-latin1 и "безопасные" символы; в противном случае он добавляет имя файла * = UTF-8 '' в URL-кодировке. Согласно этот конкретный тестовый пример, он должен работать с MSIE9 и выше, а также с последними версиями FF, Chrome, Safari; в более ранней версии MSIE он должен предлагать имя файла, содержащее версию имени файла ISO8859-1, с подчеркиванием на символах не в этой кодировке.

Заключительное примечание: макс. размер каждого поля заголовка составляет 8190 байт на apache. UTF-8 может содержать до четырех байтов на символ; после rawurlencode это x3 = 12 байт на один символ. Довольно неэффективно, но теоретически возможно иметь более 600 «улыбок»% F0% 9F% 98% 81 в имени файла.

В веб-API ASP.NET я кодирую URL-адрес имени файла:

public static class HttpRequestMessageExtensions
{
    public static HttpResponseMessage CreateFileResponse(this HttpRequestMessage request, byte[] data, string filename, string mediaType)
    {
        HttpResponseMessage response = new HttpResponseMessage(HttpStatusCode.OK);
        var stream = new MemoryStream(data);
        stream.Position = 0;

        response.Content = new StreamContent(stream);

        response.Content.Headers.ContentType = 
            new MediaTypeHeaderValue(mediaType);

        // URL-Encode filename
        // Fixes behavior in IE, that filenames with non US-ASCII characters
        // stay correct (not "_utf-8_.......=_ = ").
        var encodedFilename = HttpUtility.UrlEncode(filename, Encoding.UTF8);

        response.Content.Headers.ContentDisposition =
            new ContentDispositionHeaderValue("attachment") { FileName = encodedFilename };
        return response;
    }
}

Поместите имя файла в двойные кавычки. Решил проблему за меня. Так:

Content-Disposition: attachment; filename = "My Report.doc"

http://kb.mozillazine.org/Filenames_with_spaces_are_truncated_upon_download

Я проверил несколько вариантов. Браузеры не поддерживают спецификации и действуют иначе, я считаю, что двойные кавычки - лучший вариант.

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

var fileName = 'my file(2).txt';
var header = "Content-Disposition: attachment; filename*=UTF-8''" 
             + encodeRFC5987ValueChars(fileName);

function encodeRFC5987ValueChars (str) {
    return encodeURIComponent(str).
        // Note that although RFC3986 reserves "!", RFC5987 does not,
        // so we do not need to escape it
        replace(/['()]/g, escape). // i.e., %27 %28 %29
        replace(/\*/g, '%2A').
            // The following are not required for percent-encoding per RFC5987, 
            // so we can allow for a little better readability over the wire: |`^
            replace(/%(?:7C|60|5E)/g, unescape);
}

В PHP это сделало это за меня (при условии, что имя файла закодировано в UTF8):

header('Content-Disposition: attachment;'
    . 'filename = "' . addslashes(utf8_decode($filename)) . '";'
    . 'filename*=utf-8\'\'' . rawurlencode($filename));

Протестировано против IE8-11, Firefox и Chrome.
Если браузер может интерпретировать имя файла * = utf-8, он будет использовать версию имени файла UTF8, иначе он будет использовать декодированное имя файла. Если ваше имя файла содержит символы, которые не могут быть представлены в ISO-8859-1, вы можете вместо этого рассмотреть возможность использования iconv.

Классическое решение ASP

Большинство современных браузеров теперь поддерживают передачу Filename как UTF-8, но, как и в случае с решением для загрузки файлов, которое я использую, которое было основано на FreeASPUpload.Net(сайт больше не существует, ссылка указывает на archive.org), оно не сработало, поскольку синтаксический анализ двоичного файла основывался на чтении однобайтовых строк в кодировке ASCII, что сработало. нормально, если вы передали данные в кодировке UTF-8, пока не дойдете до символов, которые ASCII не поддерживает.

Однако мне удалось найти решение, позволяющее заставить код читать и анализировать двоичный файл как UTF-8.

Public Function BytesToString(bytes)    'UTF-8..
  Dim bslen
  Dim i, k , N 
  Dim b , count 
  Dim str

  bslen = LenB(bytes)
  str = ""

  i = 0
  Do While i < bslen
    b = AscB(MidB(bytes,i+1,1))

    If (b And &HFC) = &HFC Then
      count = 6
      N = b And &H1
    ElseIf (b And &HF8) = &HF8 Then
      count = 5
      N = b And &H3
    ElseIf (b And &HF0) = &HF0 Then
      count = 4
      N = b And &H7
    ElseIf (b And &HE0) = &HE0 Then
      count = 3
      N = b And &HF
    ElseIf (b And &HC0) = &HC0 Then
      count = 2
      N = b And &H1F
    Else
      count = 1
      str = str & Chr(b)
    End If

    If i + count - 1 > bslen Then
      str = str&"?"
      Exit Do
    End If

    If count>1 then
      For k = 1 To count - 1
        b = AscB(MidB(bytes,i+k+1,1))
        N = N * &H40 + (b And &H3F)
      Next
      str = str & ChrW(N)
    End If
    i = i + count
  Loop

  BytesToString = str
End Function

Благодарим Загрузка файла в чистом формате ASP, реализовав функцию BytesToString() из include_aspuploader.asp в моем собственном коде, и мне удалось заставить работать имена файлов UTF-8.

Полезные ссылки

• Multipart / form-data и UTF-8 в приложении ASP Classic

• Различия в форматах Unicode, UTF, ASCII, ANSI

Просто обновление, так как я пробовал все это сегодня в ответ на проблему клиента

• За исключением Safari, настроенного для японского языка, все браузеры, протестированные нашим клиентом, лучше всего работали с filename = text.pdf, где текст - это значение клиента, сериализованное ASP.Net/IIS в utf-8 без кодировки URL. По какой-то причине Safari, настроенный для английского языка, примет и правильно сохранит файл с японским именем utf-8, но тот же браузер, настроенный для японского языка, сохранит файл с неинтерпретированными символами utf-8. Все остальные протестированные браузеры работали лучше всего / нормально (независимо от языковой конфигурации) с именем файла utf-8, закодированным без кодировки URL.
• Я не смог найти ни одного браузера, реализующего Rfc5987 / 8187 вообще. Я тестировал последние версии Chrome, Firefox, а также IE 11 и Edge. Я попытался установить заголовок только с именем filename * = utf-8''texturlencoded.pdf, задав его как filename = text.pdf; имя файла * = utf-8''texturlencoded.pdf. Ни одна функция Rfc5987 / 8187 не обрабатывалась правильно ни в одном из вышеперечисленных.

PHP-фреймворк Symfony 4 имеет $filenameFallback в HeaderUtils::makeDisposition. Вы можете изучить эту функцию для получения подробной информации - она ​​похожа на ответы выше.

Пример использования:

$filenameFallback = preg_replace('#^.*\.#', md5($filename) . '.', $filename);
$disposition = $response->headers->makeDisposition(ResponseHeaderBag::DISPOSITION_ATTACHMENT, $filename, $filenameFallback);
$response->headers->set('Content-Disposition', $disposition);