Reimplement usage of Google Translate API as a named utility to be able to provide different services

news/467.feature

@@ -0,0 +1,2 @@
+Reimplement usage of Google Translate API as utility, to be able to provide different translation services
+[erral]

setup.py

@@ -33,6 +33,7 @@
         "plone.memoize",
         "plone.protect",
         "plone.registry",
+        "plone.restapi",
         "plone.schemaeditor",
         "plone.supermodel",
         "plone.uuid",
@@ -63,6 +64,7 @@
             "plone.testing",
             "robotsuite",
             "Products.CMFPlacefulWorkflow",
+            "plone.restapi",
         ],
     },
     entry_points="""

src/plone/app/multilingual/browser/translate.py

@@ -1,53 +1,53 @@
 from Acquisition import aq_inner
 from plone.app.multilingual import _
-from plone.app.multilingual.interfaces import IMultiLanguageExtraOptionsSchema
+from plone.app.multilingual.interfaces import IExternalTranslationService
 from plone.app.multilingual.interfaces import ITranslationManager
 from plone.app.uuid.utils import uuidToObject
 from plone.base.interfaces import ILanguage
-from plone.registry.interfaces import IRegistry
 from plone.uuid.interfaces import IUUID
 from Products.Five import BrowserView
+from zope.component import getUtilitiesFor
 from zope.component import getUtility
 
 import json
-import urllib
-
-
-def google_translate(question, key, lang_target, lang_source):
-    length = len(question)
-    translated = ""
-    url = "https://www.googleapis.com/language/translate/v2"
-    temp_question = question
-    while length > 400:
-        temp_question = question[:399]
-        index = temp_question.rfind(" ")
-        temp_question = temp_question[:index]
-        question = question[index:]
-        length = len(question)
-        data = {
-            "key": key,
-            "target": lang_target,
-            "source": lang_source,
-            "q": temp_question,
-        }
-        params = urllib.parse.urlencode(data)
-
-        retorn = urllib.request.urlopen(url + "?" + params)
-        translated += json.loads(retorn.read())["data"]["translations"][0][
-            "translatedText"
+
+
+def translate_text(original_text, source_language, target_language, service=None):
+    """translate the text"""
+
+    if service is not None:
+        # if an specific adapter is requested, use it if available
+
+        adapter = getUtility(IExternalTranslationService, name=service)
+        if not adapter.is_available():
+            return None
+
+        adapters = [adapter]
+
+    else:
+
+        adapters = [
+            adapter
+            for _, adapter in getUtilitiesFor(IExternalTranslationService)
+            if adapter.is_available()
         ]
 
-    data = {
-        "key": key,
-        "target": lang_target,
-        "source": lang_source,
-        "q": temp_question,
-    }
-    params = urllib.parse.urlencode(data)
+    sorted_adapters = sorted(adapters, key=lambda x: x.order)
 
-    retorn = urllib.request.urlopen(url + "?" + params)
-    translated += json.loads(retorn.read())["data"]["translations"][0]["translatedText"]
-    return json.dumps({"data": translated})
+    for adapter in sorted_adapters:
+        available_languages = adapter.available_languages()
+        if (
+            not available_languages
+            or (source_language, target_language) in available_languages
+        ):
+            translation = adapter.translate_content(
+                original_text, source_language, target_language
+            )
+
+            if translation:
+                return translation
+
+    return None
 
 
 class gtranslation_service_dexterity(BrowserView):
@@ -69,10 +69,6 @@ def __call__(self):
                 else:
                     manager = ITranslationManager(self.context)
 
-            registry = getUtility(IRegistry)
-            settings = registry.forInterface(
-                IMultiLanguageExtraOptionsSchema, prefix="plone"
-            )
             lang_target = ILanguage(self.context).get_language()
             lang_source = self.request.form["lang_source"]
             orig_object = manager.get_translation(lang_source)
@@ -83,9 +79,12 @@ def __call__(self):
                     question = question.raw
             else:
                 return _("Invalid field")
-            return google_translate(
-                question, settings.google_translation_key, lang_target, lang_source
-            )
+
+            translation = translate_text(question, lang_source, lang_target)
+            if translation is None:
+                return json.dumps({"data": ""})
+
+            return json.dumps({"data": translation})
 
 
 class TranslationForm(BrowserView):

src/plone/app/multilingual/browser/utils.py

@@ -4,6 +4,7 @@
 from Acquisition import aq_parent
 from plone.app.i18n.locales.browser.selector import LanguageSelector
 from plone.app.multilingual.browser.selector import LanguageSelectorViewlet
+from plone.app.multilingual.interfaces import IExternalTranslationService
 from plone.app.multilingual.interfaces import ILanguageIndependentFolder
 from plone.app.multilingual.interfaces import IMultiLanguageExtraOptionsSchema
 from plone.app.multilingual.interfaces import ITranslationLocator
@@ -14,6 +15,7 @@
 from plone.registry.interfaces import IRegistry
 from Products.CMFCore.utils import getToolByName
 from Products.Five import BrowserView
+from zope.component import getAdapters
 from zope.component import getMultiAdapter
 from zope.component import getUtility
 from zope.component.hooks import getSite
@@ -52,12 +54,13 @@ def objToTranslate(self):
         return self.context
 
     def gtenabled(self):
-        registry = getUtility(IRegistry)
-        settings = registry.forInterface(
-            IMultiLanguageExtraOptionsSchema, prefix="plone"
-        )
-        key = settings.google_translation_key
-        return key is not None and len(key.strip()) > 0
+        adapters = [
+            adapter
+            for _, adapter in getAdapters((self.context,), IExternalTranslationService)
+            if adapter.is_available()
+        ]
+
+        return len(adapters) > 0
 
     def languages(self):
         """Deprecated"""

src/plone/app/multilingual/configure.zcml

@@ -27,6 +27,11 @@
   <include package=".browser" />
   <include package=".dx" />
 
+  <include
+      package=".restapi"
+      zcml:condition="installed plone.restapi"
+      />
+
   <!--<adapter factory=".content.lrf.LRFOrdering"/>-->
   <adapter factory=".shared_uuid.lrfUUID" />
   <adapter factory=".shared_uuid.lifUUID" />
@@ -192,4 +197,11 @@
       handler=".setuphandlers.step_uninstall_various"
       />
 
+
+  <utility
+      provides=".interfaces.IExternalTranslationService"
+      name="google_translate"
+      component=".google_translate.GoogleCloudTranslationAPI"
+      />
+
 </configure>

src/plone/app/multilingual/google_translate.py

@@ -0,0 +1,71 @@
+from plone.app.multilingual.interfaces import IMultiLanguageExtraOptionsSchema
+from plone.registry.interfaces import IRegistry
+from zope.component import getUtility
+
+import json
+import urllib
+
+
+class GoogleCloudTranslationAPIFactory:
+    """implement the external translation using Google Cloud Translation API"""
+
+    order = 999
+
+    def is_available(self):
+        registry = getUtility(IRegistry)
+        settings = registry.forInterface(
+            IMultiLanguageExtraOptionsSchema, prefix="plone"
+        )
+        key = settings.google_translation_key
+        return key is not None and len(key.strip()) > 0
+
+    def available_languages(self):
+        # All languages are supported
+        return []
+
+    def translate_content(self, content, source_language, target_language):
+        registry = getUtility(IRegistry)
+        settings = registry.forInterface(
+            IMultiLanguageExtraOptionsSchema, prefix="plone"
+        )
+
+        question = content
+        length = len(question)
+        translated = ""
+        url = "https://www.googleapis.com/language/translate/v2"
+        temp_question = question
+        while length > 400:
+            temp_question = question[:399]
+            index = temp_question.rfind(" ")
+            temp_question = temp_question[:index]
+            question = question[index:]
+            length = len(question)
+            data = {
+                "key": settings.google_translation_key,
+                "target": target_language,
+                "source": source_language,
+                "q": temp_question,
+            }
+            params = urllib.parse.urlencode(data)
+
+            retorn = urllib.request.urlopen(url + "?" + params)
+            translated += json.loads(retorn.read())["data"]["translations"][0][
+                "translatedText"
+            ]
+
+        data = {
+            "key": settings.google_translation_key,
+            "target": target_language,
+            "source": source_language,
+            "q": temp_question,
+        }
+        params = urllib.parse.urlencode(data)
+
+        retorn = urllib.request.urlopen(url + "?" + params)
+        translated += json.loads(retorn.read())["data"]["translations"][0][
+            "translatedText"
+        ]
+        return translated
+
+
+GoogleCloudTranslationAPI = GoogleCloudTranslationAPIFactory()

src/plone/app/multilingual/interfaces.py

@@ -278,3 +278,33 @@ class IMultiLanguageExtraOptionsSchema(ILanguageSchema):
         required=True,
         vocabulary=selector_policies,
     )
+
+
+class IExternalTranslationService(Interface):
+    """This interface is provided to allow external translation services
+    to be plugged-in in Plone to use them to translate content
+
+    Register a utility to install a new external translation service.
+
+    To control the order of the services, user the 'order' attribute. The lower
+    the sooner this service will be used.
+
+    The available_languages method can also be used to register the utility
+    just to some language pairs.
+
+    """
+
+    order = schema.Int(title="Order")
+
+    def is_available():
+        """return whether this service is available"""
+
+    def available_languages():
+        """return the list of tuples that represents language pairs this utility is enabled for.
+        An empty list means that all languages are supported
+        """
+
+    def translate_content(content, source_language, target_language):
+        """translate the given content from the source to the target language.
+        It should return the translated string
+        """

src/plone/app/multilingual/restapi/configure.zcml

@@ -0,0 +1,26 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:plone="http://namespaces.plone.org/plone"
+    i18n_domain="plone"
+    >
+
+  <include package="plone.restapi" />
+
+
+  <plone:service
+      method="GET"
+      factory=".translation_services.TranslationServices"
+      for="Products.CMFPlone.interfaces.IPloneSiteRoot"
+      permission="cmf.ModifyPortalContent"
+      name="@translation-services"
+      />
+
+  <plone:service
+      method="POST"
+      factory=".translate_text.TranslateTextService"
+      for="Products.CMFPlone.interfaces.IPloneSiteRoot"
+      permission="cmf.ModifyPortalContent"
+      name="@translate-text"
+      />
+
+</configure>

src/plone/app/multilingual/restapi/translate_text.py

@@ -0,0 +1,29 @@
+from plone.app.multilingual.browser.translate import translate_text
+from plone.restapi.deserializer import json_body
+from plone.restapi.services import Service
+
+
+class TranslateTextService(Service):
+    """this endpoints tries to translate the given text into the given language, using the previously registered ExternalTranslationServices"""
+
+    def reply(self):
+        body = json_body(self.request)
+        source_language = body.get("source_language")
+        target_language = body.get("target_language")
+        original_text = body.get("original_text")
+        service = body.get("service")
+
+        translation = translate_text(
+            original_text, source_language, target_language, service
+        )
+
+        if translation is None:
+            self.request.response.setStatus(400)
+            return dict(
+                error=dict(
+                    type="Translation service not available",
+                    message="The requested translation service is not available.",
+                )
+            )
+
+        return {"data": translation}

src/plone/app/multilingual/restapi/translation_services.py

@@ -0,0 +1,21 @@
+from plone.app.multilingual.interfaces import IExternalTranslationService
+from plone.restapi.services import Service
+from zope.component import getUtilitiesFor
+
+
+class TranslationServices(Service):
+    """an endpoint to return all translation services registered in a portal that provide the IExternalTranslationService interface"""
+
+    def reply(self):
+        result = []
+
+        for name, adapter in getUtilitiesFor(IExternalTranslationService):
+            item = {}
+            item["order"] = adapter.order
+            item["is_available"] = adapter.is_available()
+            item["available_languages"] = adapter.available_languages()
+            item["name"] = name
+
+            result.append(item)
+
+        return sorted(result, key=lambda x: x["order"], reverse=True)