Changeset 147:78f3eda1c1f0

Timestamp:

05/05/10 13:27:39 (21 months ago)

Author:

Menno Smits <menno@…>

Branch:

default

Message:

#21: High ascii bytes in folder names can break folder handling

Don't allow characters in str based folder names that can't be
converted to unicode without knowing the encoding. The idea is that
IMAPClient's user should convert to unicode themselves.

Files:

• imapclient/imap_utf7.py (modified) (1 diff)
• imapclient/test/test_imap_utf7.py (modified) (4 diffs)
• livetest.py (modified) (1 diff)

imapclient/imap_utf7.py

@@ -24 +24 @@
 
 
+class FolderNameError(ValueError):
+    pass
+
+
 def encode(s):
+    if isinstance(s, str) and sum(n for n in (ord(c) for c in s) if n > 127):
+        raise FolderNameError("%r contains characters not valid in a str folder name. "
+                              "Convert to unicode first?" % s)
+
     r = []
     _in = []

imapclient/test/test_imap_utf7.py

@@ -23 +23 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-from imapclient.imap_utf7 import decode, encode
+from imapclient.imap_utf7 import decode, encode, FolderNameError
 import unittest
 
@@ -38 +38 @@
         [u'~peter/mail/\u65e5\u672c\u8a9e/\u53f0\u5317',
          '~peter/mail/&ZeVnLIqe-/&U,BTFw-'], # example from RFC 2060
+        ['\x00foo', '&AAA-foo'],
     ]
 
@@ -48 +49 @@
         for (input, output) in self.tests:
             self.assertEquals(input, decode(output))
+
+
+    def test_illegal_chars(self):
+        not_valid_as_str = [
+            'blah' + chr(0x80) + 'sne',
+            chr(0xaa) + 'foo',
+            'blah' + chr(0xff) + 'sne']
+
+        for name in not_valid_as_str:
+            self.assertRaises(FolderNameError, encode, name)
+
+        unicode_names = [unicode(name, 'latin-1') for name in not_valid_as_str]
+        for name in unicode_names:
+            assert isinstance(encode(name), str)
 
 
@@ -62 +77 @@
         self.failUnlessEqual(decode('&-'), '&')
 
+
+    def test_FolderNameError_super(self):
+        self.assert_(issubclass(FolderNameError, ValueError))
+
+
 if __name__ == '__main__':
     unittest.main()

livetest.py

@@ -62 +62 @@
 def test_list_folders(client):
     clear_folders(client)
-    some_folders = ['simple', r'foo\bar', r'test"folder"']
+    some_folders = ['simple', r'foo\bar', r'test"folder"', u'L\xffR']
     for name in some_folders:
         client.create_folder(name)