PICARD-2199: Fix saving ratings to ID3 with non-latin1 characters in email

Author: phw

picard/formats/id3.py

@@ -259,7 +259,7 @@ def _load(self, filename):
         tags = file.tags or {}
         config = get_config()
         itunes_compatible = config.setting['itunes_compatible_grouping']
-        rating_user_email = config.setting['rating_user_email']
+        rating_user_email = id3text(config.setting['rating_user_email'], 0)
         rating_steps = config.setting['rating_steps']
         # upgrade custom 2.3 frames to 2.4
         for old, new in self.__upgrade.items():
@@ -458,17 +458,18 @@ def _save(self, filename, metadata):
             elif name == 'musicbrainz_recordingid':
                 tags.add(id3.UFID(owner='http://musicbrainz.org', data=bytes(values[0], 'ascii')))
             elif name == '~rating':
+                rating_email = id3text(config.setting['rating_user_email'], 0)
                 # Search for an existing POPM frame to get the current playcount
                 for frame in tags.values():
-                    if frame.FrameID == 'POPM' and frame.email == config.setting['rating_user_email']:
+                    if frame.FrameID == 'POPM' and frame.email == rating_email:
                         count = getattr(frame, 'count', 0)
                         break
                 else:
                     count = 0
 
                 # Convert rating to range between 0 and 255
                 rating = int(round(float(values[0]) * 255 / (config.setting['rating_steps'] - 1)))
-                tags.add(id3.POPM(email=config.setting['rating_user_email'], rating=rating, count=count))
+                tags.add(id3.POPM(email=rating_email, rating=rating, count=count))
             elif name == 'grouping':
                 if config.setting['itunes_compatible_grouping']:
                     tags.add(id3.GRP1(encoding=encoding, text=values))
@@ -581,7 +582,7 @@ def _remove_deleted_tags(self, metadata, tags):
                     tags.delall(real_name)
                     tags.delall('TXXX:' + self.__rtranslate_freetext[name])
                 elif real_name == 'POPM':
-                    user_email = config.setting['rating_user_email']
+                    user_email = id3text(config.setting['rating_user_email'], 0)
                     for key, frame in list(tags.items()):
                         if frame.FrameID == 'POPM' and frame.email == user_email:
                             del tags[key]

test/formats/test_id3.py

@@ -516,6 +516,15 @@ def test_woar_delete(self):
             loaded_metadata = save_and_load_metadata(self.filename, metadata)
             self.assertNotIn('website', loaded_metadata)
 
+        @skipUnlessTestfile
+        def test_rating_email_non_latin1(self):
+            for rating in range(6):
+                config.setting['rating_user_email'] = 'foo€'
+                rating = '3'
+                metadata = Metadata({'~rating': rating})
+                loaded_metadata = save_and_load_metadata(self.filename, metadata)
+                self.assertEqual(loaded_metadata['~rating'], rating, '~rating: %r != %r' % (loaded_metadata['~rating'], rating))
+
 
 class MP3Test(CommonId3Tests.Id3TestCase):
     testfile = 'test.mp3'