has added upgrade step for fixing escaped seo properties

Author: vmaksymiv

quintagroup/seoptimizer/profiles.zcml

@@ -37,4 +37,11 @@
       sortkey="1"
       profile="quintagroup.seoptimizer:default" />
 
+  <genericsetup:upgradeStep
+      title="Upgrade quintagroup.seoptimizer"
+      description="Unescape quintagroup.seoptimizer title and comment properties"
+      destination="4.0.5"
+      handler=".upgrades.unescapeOldTitle"
+      profile="quintagroup.seoptimizer:default" />
+
 </configure>

quintagroup/seoptimizer/profiles/default/metadata.xml

@@ -1,4 +1,4 @@
 <?xml version="1.0"?>
 <metadata>
-  <version>4.0.3</version>
+  <version>4.0.5</version>
 </metadata>

quintagroup/seoptimizer/tests/testUtils.py

@@ -1,32 +1,41 @@
+# -*- coding: utf8 -*-
 from unittest import TestSuite, makeSuite, TestCase
 from quintagroup.seoptimizer.util import unescape
 
 
 class TestUtils(TestCase):
 
     def test_unicode_str_unescaping(self):
-        self.assertEqual(unescape(u"&&-/["), u"&&-/[")
+        self.assertEqual(unescape("&&-/["), "&&-/[")
 
     def test_str_unescaping(self):
-        self.assertEqual(unescape("&&-/["), u"&&-/[")
+        self.assertEqual(unescape("&&-/["), "&&-/[")
+
+    def test_entity_unicode_unescaping(self):
+        self.assertEqual(unescape(u"&&ї".encode('utf-8')),
+                                  u"&&ї".encode('utf-8'))
 
     def test_hex_unescaping(self):
-        self.assertEqual(unescape('['), u'[')
+        self.assertEqual(unescape('['), '[')
 
     def test_simple_text_unescaping(self):
-        self.assertEqual(unescape("Simple text."), u"Simple text.")
+        self.assertEqual(unescape("Simple text."), "Simple text.")
 
     def test_entity_hex_unescaping(self):
-        self.assertEqual(unescape('['), u'[')
+        self.assertEqual(unescape('['), '[')
 
     def test_intity_dec_unescaping(self):
-        self.assertEqual(unescape('['), u'[')
+        self.assertEqual(unescape('['), '[')
 
     def test_entity_dec_hex_unescaping(self):
-        self.assertEqual(unescape('['), u'[')
+        self.assertEqual(unescape('['), '[')
 
     def test_fake_entity_unescaping(self):
-        self.assertEqual(unescape("&asd;"), u"&asd;")
+        self.assertEqual(unescape("&asd;"), "&asd;")
+
+    def test_aentity_unescaping(self):
+        self.assertEqual(unescape("—").encode('utf-8'),
+                         u"—".encode('utf-8'))
 
 
 def test_suite():

quintagroup/seoptimizer/upgrades.py

@@ -1,6 +1,11 @@
 import logging
 from zope.component import queryMultiAdapter
 
+from Products.CMFCore.utils import getToolByName
+from Products.CMFPlone.utils import getSiteEncoding, safe_unicode
+
+from quintagroup.seoptimizer.browser.seo_configlet import ISEOConfigletSchema
+from quintagroup.seoptimizer.util import unescape
 from quintagroup.canonicalpath.interfaces  import ICanonicalLink
 from quintagroup.canonicalpath.adapters import PROPERTY_LINK
 
@@ -145,3 +150,28 @@ def upgrade_2_to_3(setuptool):
     removeNonUseSeoProperties(plone_tools)
     removeSkin(plone_tools)
     migrateCanonical(plone_tools)
+
+
+def unescapeOldTitle(setuptool):
+    """ Upgrade quintagroup.seoptimizer title and comments properties.
+    """
+    portal = getToolByName(setuptool, "portal_url").getPortalObject()
+    types = ISEOConfigletSchema(portal).types_seo_enabled
+
+    catalog = getToolByName(portal, "portal_catalog")
+    brains = catalog(portal_type=types)
+
+    for b in brains:
+        obj = b.getObject()
+        obj_enc = getSiteEncoding(obj)
+
+        if obj.hasProperty("qSEO_title"):
+            uni_qSEO_title = safe_unicode(obj.qSEO_title, encoding=obj_enc)
+            fixed_title = unescape(uni_qSEO_title).encode(obj_enc)
+            obj._updateProperty("qSEO_title", fixed_title)
+
+        if obj.hasProperty("qSEO_html_comment"):
+            uni_qSEO_html_comment = safe_unicode(obj.qSEO_html_comment,
+                                                 encoding=obj_enc)
+            fixed_comment = unescape(uni_qSEO_html_comment).encode(obj_enc)
+            obj._updateProperty("qSEO_html_comment", fixed_comment)

quintagroup/seoptimizer/util.py

@@ -51,7 +51,7 @@ def pop(self, k, *args, **kwargs):
 def _group_unescape(m):
     if m.group("ent"):
         try:
-            return entitydefs[m.group("ent")]
+            return unescape(entitydefs[m.group("ent")])
         except KeyError:
             return m.group(0)
     if m.group("dec"):
@@ -65,9 +65,4 @@ def _group_unescape(m):
 
 
 def unescape(s):
-    result = expr.sub(_group_unescape, s)
-
-    if isinstance(s, unicode):
-        return result
-    else:
-        return unicode(result)
+    return expr.sub(_group_unescape, s)