Merge lp:~bac/launchpad/bug-490224-content-type into lp:launchpad

[Brad Crittenden]

Customize the mimetypes standard library to support bzip2 encoding, which is missing in python2.5.

[Brad Crittenden (bac)]

= Summary =

The mimetypes standard library in python2.5 does not know about the bzip2 encoding.
This branch provides a centralized place for extending the library so that the
encoding is recognized which will allow files to be served properly.

== Proposed fix ==

Provide a 'customizedMimetypes' method and call it from site.py.

== Pre-implementation notes ==

Long chat with Gary and talks with Curtis.

== Implementation details ==

As above.

== Tests ==

bin/test -vvt test_mime

== Demo and Q/A ==

Add a .tar.bz2 file to a download and ensure it has the proper content type when
downloading using 'wget -S'

= Launchpad lint =

Checking for conflicts. and issues in doctests and templates.
Running jslint, xmllint, pyflakes, and pylint.
Using normal rules.

Linting changed files:
  lib/lp/services/tests/test_mime.py
  lib/lp/services/mime.py
  lib/site.py
  lib/lp/bugs/model/bug.py

== Pylint notices ==

lib/lp/bugs/model/bug.py
    24: [F0401] Unable to import 'email.Utils' (No module named Utils)
    37: [F0401] Unable to import 'lazr.lifecycle.event' (No module named lifecycle)
    39: [F0401] Unable to import 'lazr.lifecycle.snapshot' (No module named lifecycle)

[Brad Crittenden (bac)]

Note bug 494458 has been filed to correct existing data.

[Gary Poster (gary)]

Looks good, Brad. Thank you for the fix, and for the help in guiding how we'll do this kind of initialization in the future.

Gary

review: Approve (code)

[Curtis Hovey (sinzui)]

This looks good to land.

review: Approve (code)

=== modified file 'lib/lp/bugs/model/bug.py'
--- lib/lp/bugs/model/bug.py	2009-12-09 20:29:17 +0000
+++ lib/lp/bugs/model/bug.py	2009-12-10 22:07:17 +0000
@@ -18,7 +18,6 @@
     ]
 
 
-import mimetypes
 import operator
 import re
 from cStringIO import StringIO
@@ -102,15 +101,6 @@
 from lp.registry.model.pillar import pillar_sort_key
 
 
-# XXX: GavinPanella 2008-07-04 bug=229040: A fix has been requested
-# for Intrepid, to add .debdiff to /etc/mime.types, so we may be able
-# to remove this setting once a new /etc/mime.types has been installed
-# on the app servers. Additionally, Firefox does not display content
-# of type text/x-diff inline, so making this text/plain because
-# viewing .debdiff inline is the most common use-case.
-mimetypes.add_type('text/plain', '.debdiff')
-
-
 _bug_tag_query_template = """
         SELECT %(columns)s FROM %(tables)s WHERE
             %(condition)s GROUP BY BugTag.tag ORDER BY BugTag.tag"""

=== added file 'lib/lp/services/mime.py'
--- lib/lp/services/mime.py	1970-01-01 00:00:00 +0000
+++ lib/lp/services/mime.py	2009-12-10 22:07:17 +0000
@@ -0,0 +1,33 @@
+# Copyright 2009 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Methods required to customize the mimetypes library."""
+
+__metaclass__ = type
+__all__ = [
+    'customizeMimetypes',
+    ]
+
+import mimetypes
+
+
+def customizeMimetypes():
+    """Initialize and extend the standard mimetypes library for our needs.
+
+    This method is to be called before any requests are processed to ensure
+    any call site that imports the standard mimetypes module will take
+    advantage of these customizations.
+    """
+    mimetypes.init()
+
+    # Add support for bz2 encodings, which is not present in python2.5.
+    mimetypes.encodings_map.setdefault('.bz2', 'bzip2')
+    mimetypes.suffix_map.setdefault('.tbz2', '.tar.bz2')
+
+    # XXX: GavinPanella 2008-07-04 bug=229040: A fix has been requested
+    # for Intrepid, to add .debdiff to /etc/mime.types, so we may be able
+    # to remove this setting once a new /etc/mime.types has been installed
+    # on the app servers. Additionally, Firefox does not display content
+    # of type text/x-diff inline, so making this text/plain because
+    # viewing .debdiff inline is the most common use-case.
+    mimetypes.add_type('text/plain', '.debdiff')

=== added file 'lib/lp/services/tests/test_mime.py'
--- lib/lp/services/tests/test_mime.py	1970-01-01 00:00:00 +0000
+++ lib/lp/services/tests/test_mime.py	2009-12-10 22:07:17 +0000
@@ -0,0 +1,34 @@
+# Copyright 2009 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Tests for mime module."""
+
+__metaclass__ = type
+
+import unittest
+
+import mimetypes
+from lp.testing import TestCase
+
+
+class TestBzip(TestCase):
+    """Tests for iter_split."""
+
+    def test_bzip2(self):
+        # Test for '.tar.bzip2' support.
+        filename = "foo.tar.bz2"
+        (application, encoding) = mimetypes.guess_type(filename)
+        self.assertEqual('application/x-tar', application)
+        self.assertEqual('bzip2', encoding)
+
+    def test_tbz2(self):
+        # Test for '.tar.bzip2' support.
+        filename = "foo.tbz2"
+        (application, encoding) = mimetypes.guess_type(filename)
+        self.assertEqual('application/x-tar', application)
+        self.assertEqual('bzip2', encoding)
+
+
+
+def test_suite():
+    return unittest.TestLoader().loadTestsFromName(__name__)

=== modified file 'lib/site.py'
--- lib/site.py	2009-10-21 15:18:28 +0000
+++ lib/site.py	2009-12-10 22:07:17 +0000
@@ -28,3 +28,7 @@
 import sys
 execfile(
     os.path.join(sys.prefix, 'lib', 'python' + sys.version[:3], 'site.py'))
+
+# Perform other start-up initialization.
+from lp.services.mime import customizeMimetypes
+customizeMimetypes()