# HG changeset patch # User Pierre-Yves David # Date 1354012069 -3600 # Node ID d74addac92bbe2dd5ea6dd53ede482b6bded48a8 # Parent 4fabc81cd92464c985cbee13317030e54f9a21af [downloadable] fix filename in HTTP header (closes #2522325, #2522324) Before this changeset we use the `filename` header with utf8 encoded filename all the time. However RFC6266 says: The parameters "filename" and "filename*" differ only in that "filename*" uses the encoding defined in [RFC5987], allowing the use of characters not present in the ISO-8859-1 character set ([ISO-8859-1]). Therefore, we alter the code to: 1. Use `filename` and `ascii` encoding whenever possible, 2. use `filename*` with `utf8` encoding otherwise (with a filename fallback for old browser) We also switch the `content-disposition` value to attachement if filename is specified, this will result as a mandatory download according to RFC6266. This mandatory download is the expected behavior. We changes the filename encoding to RFC5987 which is simpler, supported by all and modern browser (including IE from version 6) and does not suffer from the continuation issue. (see ticket #2522324 for details) diff -r 4fabc81cd924 -r d74addac92bb web/request.py --- a/web/request.py Tue Nov 27 11:18:42 2012 +0100 +++ b/web/request.py Tue Nov 27 11:27:49 2012 +0100 @@ -22,6 +22,7 @@ import time import random import base64 +import urllib from hashlib import sha1 # pylint: disable=E0611 from Cookie import SimpleCookie from calendar import timegm @@ -38,7 +39,6 @@ from logilab.mtconverter import xml_escape from cubicweb.dbapi import DBAPIRequest -from cubicweb.mail import header from cubicweb.uilib import remove_html_tags, js from cubicweb.utils import SizeConstrainedList, HTMLHead, make_uid from cubicweb.view import STRICT_DOCTYPE, TRANSITIONAL_DOCTYPE_NOEXT @@ -618,10 +618,17 @@ content_type += ';charset=' + (encoding or self.encoding) self.set_header('content-type', content_type) if filename: - if isinstance(filename, unicode): - filename = header(filename).encode() - self.set_header('content-disposition', 'inline; filename=%s' - % filename) + header = ['attachment'] + try: + filename = filename.encode('ascii') + header.append('filename=' + filename) + except UnicodeEncodeError: + # fallback filename for very old browser + header.append('filename=' + filename.encode('ascii', 'ignore')) + # encoded filename according RFC5987 + filename = urllib.quote(filename.encode('utf-8'), '') + header.append("filename*=utf-8''" + filename) + self.set_header('content-disposition', ';'.join(header)) # high level methods for HTML headers management ########################## diff -r 4fabc81cd924 -r d74addac92bb web/test/unittest_idownloadable.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/web/test/unittest_idownloadable.py Tue Nov 27 11:27:49 2012 +0100 @@ -0,0 +1,95 @@ +# -*- coding: utf-8 -*- +# copyright 2012 LOGILAB S.A. (Paris, FRANCE), all rights reserved. +# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr +# +# This file is part of CubicWeb. +# +# CubicWeb is free software: you can redistribute it and/or modify it under the +# terms of the GNU Lesser General Public License as published by the Free +# Software Foundation, either version 2.1 of the License, or (at your option) +# any later version. +# +# CubicWeb is distributed in the hope that it will be useful, but WITHOUT +# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more +# details. +# +# You should have received a copy of the GNU Lesser General Public License along +# with CubicWeb. If not, see . +from __future__ import with_statement + +from functools import partial + +from logilab.common.testlib import unittest_main + +from cubicweb.devtools.testlib import CubicWebTC +from cubicweb import view +from cubicweb.predicates import is_instance + + +class IDownloadableTC(CubicWebTC): + + def setUp(self): + super(IDownloadableTC, self).setUp() + class IDownloadableUser(view.EntityAdapter): + __regid__ = 'IDownloadable' + __select__ = is_instance('CWUser') + + def download_content_type(self): + """return MIME type of the downloadable content""" + return 'text/plain' + + def download_encoding(self): + """return encoding of the downloadable content""" + return 'ascii' + + def download_file_name(self): + """return file name of the downloadable content""" + return self.entity.name() + '.txt' + + def download_data(self): + return 'Babar is not dead!' + self.vreg.register(IDownloadableUser) + self.addCleanup(partial(self.vreg.unregister, IDownloadableUser)) + + def test_header_simple_case(self): + req = self.request() + req.form['vid'] = 'download' + req.form['eid'] = str(req.user.eid) + data = self.ctrl_publish(req,'view') + get = req.headers_out.getRawHeaders + self.assertEqual(['attachment;filename=admin.txt'], + get('content-disposition')) + self.assertEqual(['text/plain;charset=ascii'], + get('content-type')) + self.assertEqual('Babar is not dead!', data) + + def test_header_unicode_filename(self): + req = self.request() + self.create_user(req, login=u'cécilia', password='babar') + self.commit() + with self.login(u'cécilia', password='babar'): + req = self.request() + req.form['vid'] = 'download' + req.form['eid'] = str(req.user.eid) + self.ctrl_publish(req,'view') + get = req.headers_out.getRawHeaders + self.assertEqual(["attachment;filename=ccilia.txt;filename*=utf-8''c%C3%A9cilia.txt"], + get('content-disposition')) + + def test_header_unicode_long_filename(self): + req = self.request() + name = u'Bèrte_hô_grand_nôm_ça_va_totallement_déborder_de_la_limite_là' + self.create_user(req, login=name, password='babar') + self.commit() + with self.login(name, password='babar'): + req = self.request() + req.form['vid'] = 'download' + req.form['eid'] = str(req.user.eid) + self.ctrl_publish(req,'view') + get = req.headers_out.getRawHeaders + self.assertEqual(["attachment;filename=Brte_h_grand_nm_a_va_totallement_dborder_de_la_limite_l.txt;filename*=utf-8''B%C3%A8rte_h%C3%B4_grand_n%C3%B4m_%C3%A7a_va_totallement_d%C3%A9border_de_la_limite_l%C3%A0.txt"], + get('content-disposition')) + +if __name__ == '__main__': + unittest_main()