collective.collabora 1.0.0__py3-none-any.whl

collective/collabora/__init__.py

@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+"""Init and utils."""
+from __future__ import unicode_literals
+
+from future import standard_library
+
+
+standard_library.install_aliases()
+from zope.i18nmessageid import MessageFactory
+
+
+_ = MessageFactory("collective.collabora")

collective/collabora/adapters.py

@@ -0,0 +1,82 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+from future import standard_library
+
+
+standard_library.install_aliases()
+
+from collective.collabora import utils
+from collective.collabora.interfaces import IStoredFile
+from plone.app.contenttypes.interfaces import IFile
+from plone.namedfile.file import NamedBlobFile
+from zope.component import adapter
+from zope.interface import implementer
+
+
+try:
+    from Products.ATContentTypes.interfaces import IATFile
+    from StringIO import StringIO  # py27 only
+except ImportError:
+    from collective.collabora.interfaces import IDummy as IATFile
+
+    StringIO = utils.disallow
+
+
+@adapter(IFile)
+@implementer(IStoredFile)
+class DXStoredFile(object):
+    """Access the file storage on a Dexterity content object.
+
+    i.e. the file attribute on the content object.
+    """
+
+    def __init__(self, context):
+        self.context = context
+        self.filename = context.file.filename
+        self.contentType = context.file.contentType
+
+    @property
+    def data(self):
+        return self.context.file.data
+
+    @data.setter
+    def data(self, data):
+        self.context.file = NamedBlobFile(
+            data=data, filename=self.filename, contentType=self.contentType
+        )
+
+    def getSize(self):
+        return self.context.file.getSize()
+
+
+@adapter(IATFile)
+@implementer(IStoredFile)
+class ATStoredFile(object):
+    """Access the file storage on a Archetypes content object.
+
+    i.e. the File field on the content object.
+    """
+
+    def __init__(self, context):
+        self.context = context
+        self.file = context.getField("file")
+        # This weirdness is why we adopt the content type, rather than the blob
+        # field directly - these accessors on the field need the parent context
+        self.filename = self.file.getFilename(context)
+        self.contentType = self.file.getContentType(context)
+
+    @property
+    def data(self):
+        return self.context.data
+
+    @data.setter
+    def data(self, data):
+        # This follows the README.txt in
+        # https://github.com/plone/plone.app.blob/tree/master/src/plone/app/blob
+        data_wrapper = StringIO(data)
+        data_wrapper.filename = self.filename
+        self.context.setFile(data_wrapper)
+
+    def getSize(self):
+        return self.file.get_size(self.context)

collective/collabora/browser/configure.zcml

@@ -0,0 +1,49 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:browser="http://namespaces.zope.org/browser"
+    xmlns:zcml="http://namespaces.zope.org/zcml"
+    i18n_domain="collective.collabora"
+    >
+
+  <browser:resourceDirectory
+      name="collective.collabora"
+      directory="./static"
+      />
+
+  <browser:page
+      name="collabora-edit"
+      for="plone.app.contenttypes.interfaces.IFile"
+      class=".edit.CollaboraEditView"
+      template="templates/edit.pt"
+      permission="zope2.View"
+      layer="collective.collabora.interfaces.ICollectiveCollaboraLayer"
+      />
+
+  <browser:page
+      name="collabora-wopi"
+      for="plone.app.contenttypes.interfaces.IFile"
+      class=".wopi.CollaboraWOPIView"
+      permission="zope2.View"
+      layer="collective.collabora.interfaces.ICollectiveCollaboraLayer"
+      />
+
+  <configure zcml:condition="installed Products.ATContentTypes">
+    <browser:page
+        name="collabora-edit"
+        for="Products.ATContentTypes.interfaces.IATFile"
+        class=".edit.CollaboraEditView"
+        template="templates/edit.pt"
+        permission="zope2.View"
+        layer="collective.collabora.interfaces.ICollectiveCollaboraLayer"
+        />
+
+    <browser:page
+        name="collabora-wopi"
+        for="Products.ATContentTypes.interfaces.IATFile"
+        class=".wopi.CollaboraWOPIView"
+        permission="zope2.View"
+        layer="collective.collabora.interfaces.ICollectiveCollaboraLayer"
+        />
+  </configure>
+
+</configure>

collective/collabora/browser/edit.py

@@ -0,0 +1,257 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+from builtins import dict
+from builtins import filter
+from builtins import next
+from builtins import super
+from future import standard_library
+from future.utils import bytes_to_native_str as n
+
+
+standard_library.install_aliases()
+
+from collective.collabora import _
+from collective.collabora import utils
+from collective.collabora.adapters import IStoredFile
+from logging import getLogger
+from lxml import etree
+from plone import api
+from plone.app.contenttypes.browser.file import FileView
+from plone.memoize.view import memoize
+from plone.uuid.interfaces import IUUID
+from Products.PluggableAuthService.interfaces.plugins import IAuthenticationPlugin
+from urllib.parse import urlencode
+from urllib.parse import urlparse
+
+import requests
+
+
+logger = getLogger(__name__)
+
+error_server_discovery = _(
+    "error_server_discovery", default="Collabora server is not responding."
+)
+
+
+class CollaboraEditView(FileView):
+    """User interface for interacting with Collabora Online."""
+
+    def __init__(self, context, request):
+        # newsuper throws an infinite loop in py27
+        super(FileView, self).__init__(context, request)
+        self.error_msg = None
+        self.stored_file = IStoredFile(context)
+
+    def __call__(self):
+        if not all([self.plone_server_url, self.collabora_server_url, self.wopi_url]):
+            # accessing those detects errors and sets self.error_msg
+            pass
+        return super(FileView, self).__call__()
+
+    def human_readable_size(self):
+        """Use our own reimplementation, against our own adapter"""
+        return utils.human_readable_size(self.stored_file.getSize())
+
+    @property
+    @memoize
+    def plone_version(self):
+        """Get the major version we're running in."""
+        return "plone%i" % utils.PLONE_VERSION
+
+    @property
+    @memoize
+    def can_edit(self):
+        return api.user.has_permission(
+            "Modify portal content", user=api.user.get_current(), obj=self.context
+        )
+
+    @property
+    @memoize
+    def download_url(self):
+        return "/".join(
+            (
+                self.context.absolute_url(),
+                "@@download",
+                "file",
+                self.stored_file.filename,
+            )
+        )
+
+    @property
+    @memoize
+    def portal_url(self):
+        """The 'normal' Plone portal url, as used in the"""
+        return api.portal.get().absolute_url()
+
+    @property
+    @memoize
+    def plone_server_url(self):
+        """The base URL for Collabora to reach Plone on"""
+        plone_server_url = api.portal.get_registry_record(
+            n(b"collective.collabora.plone_server_url"), default=None
+        )
+        if not plone_server_url:
+            plone_server_url = self.portal_url
+        parts = urlparse(plone_server_url)
+        # This assumes you are running Collabora in a docker container,
+        # which means it will hit itself and not Plone when trying to contact localhost.
+        if parts.hostname in ("localhost", "127.0.0.1"):
+            self.error_msg = _(
+                "error_plone_server_url",
+                default=(
+                    "When Plone is supposed to be accessed on localhost, "
+                    "Collabora cannot call back. "
+                    "Use host.docker.internal or a public FQDN instead."
+                ),
+            )
+            logger.error("When Plone runs on localhost, Collabora cannot call back.")
+            return ""
+        return plone_server_url
+
+    @property
+    @memoize
+    def collabora_server_url(self):
+        collabora_server_url = api.portal.get_registry_record(
+            n(b"collective.collabora.collabora_server_url"), default=None
+        )
+        if not collabora_server_url:
+            self.error_msg = _(
+                "error_collabora_server_url_empty",
+                default="collective.collabora.collabora_server_url is not configured.",
+            )
+            logger.error("collective.collabora.collabora_server_url is not configured.")
+        if collabora_server_url and not collabora_server_url.startswith("http"):
+            self.error_msg = _(
+                "error_collabora_server_url_invalid",
+                default=(
+                    "collective.collabora.collabora_server_url "
+                    "needs to be a full URL."
+                ),
+            )
+            logger.error(
+                "collective.collabora.collabora_server_url %s needs to be a full URL",
+                collabora_server_url,
+            )
+            return ""  # Don't let server discovery error msg obscure this one
+        return collabora_server_url
+
+    @property
+    @memoize
+    def server_discovery_xml(self):
+        if not self.collabora_server_url:
+            return
+        try:
+            response = requests.get("%s/hosting/discovery" % self.collabora_server_url)
+        except requests.exceptions.RequestException as e:
+            self.error_msg = error_server_discovery
+            logger.error(e)
+            return
+        if response.status_code == 200:
+            return response.text
+        self.error_msg = error_server_discovery
+        logger.error(
+            "Server discovery error %i: %s. Verify your proxy configuration.",
+            response.status_code,
+            response.reason,
+        )
+
+    @property
+    @memoize
+    def editor_url(self):
+        """Return the URL of the LibreOffice / Collabora editor.
+
+        - Call wopi_discovery.
+        - Get the right URL depending on the file extension from the XML
+        """
+        if not self.server_discovery_xml:
+            return
+        parser = etree.XMLParser()
+        tree = etree.fromstring(self.server_discovery_xml, parser=parser)
+        mime_type = self.stored_file.contentType
+        action = tree.xpath("//app[@name='%s']/action" % mime_type)
+        action = action[0] if len(action) else None
+        if action is None:
+            self.error_msg = _(
+                "error_editor_mimetype",
+                default="Collabora does not support mimetype ${mimetype}.",
+                mapping={"mimetype": mime_type},
+            )
+            logger.error("Collabora does not support mimetype %r.", mime_type)
+            return
+        urlsrc = action.get("urlsrc")
+        if not urlsrc:
+            self.error_msg = _(
+                "error_editor_urlsrc", default="Cannot extract url source from action"
+            )
+            logger.error("Cannot extract urlsrc from action %r", action)
+        return urlsrc
+
+    @property
+    @memoize
+    def jwt_token(self):
+        """Return a JWT token from the plone.restapi JWT PAS plugin.
+
+        This token is used by the WOPI client (LibreOffice / Collabora)
+        to authenticate against the WOPI host (Quaive).
+        """
+        acl_users = api.portal.get_tool("acl_users")
+        plugins = acl_users.plugins.listPlugins(IAuthenticationPlugin)
+        plugins = filter(
+            lambda it: it[1].meta_type == "JWT Authentication Plugin", plugins
+        )
+        try:
+            jwt_plugin = next(plugins)[1]
+        except StopIteration:
+            self.error_msg = _(
+                "error_jwt_plugin",
+                default=(
+                    "JWT Authentication Plugin not found. "
+                    "Is plone.restapi installed?"
+                ),
+            )
+            logger.error("JWT Authentication Plugin not found.")
+            return
+        return jwt_plugin.create_token(api.user.get_current().getId())
+
+    @property
+    @memoize
+    def wopi_url(self):
+        """Return the URL to load the document in LibreOffice / Collabora."""
+        if not self.editor_url or not self.jwt_token:
+            return
+        document_url = self.context.absolute_url()
+
+        # optionally enable direct backend-to-backend connection
+        if self.plone_server_url != self.portal_url:
+            document_url = document_url.replace(self.portal_url, self.plone_server_url)
+
+        uuid = IUUID(self.context)
+        args = dict(
+            WOPISrc="%s/@@collabora-wopi/files/%s" % (document_url, uuid),
+            access_token=self.jwt_token,  # login credentials
+            # https://sdk.collaboraonline.com/docs/theming.html
+            ui_defaults=api.portal.get_registry_record(
+                n(b"collective.collabora.ui_defaults"),
+                default="UIMode=compact;TextSidebar=false;TextRuler=false;PresentationStatusbar=false;SpreadsheetSidebar=false;",  # noqa: E501
+            ),
+        )
+        quoted_args = urlencode(args)
+        return "%s%s" % (self.editor_url, quoted_args)
+
+    @property
+    @memoize
+    def iframe_is_cors(self):
+        """
+        Requesting fullscreen works only when CORS protection is not in play,
+        i.e. when running Collabora Online via a reverse proxy on the same
+        domain and port as Plone itself - that is the recommended way of running
+        in production.
+        """
+        return utils.collabora_is_cors()
+
+    @property
+    def css_import(self):
+        return (
+            "@import url(%s/++resource++collective.collabora/edit.css" % self.portal_url
+        )

collective/collabora/browser/static/edit.css

@@ -0,0 +1,32 @@
+.section-collabora-actions {
+    text-align: right;
+    background-color: #d6d6d6;
+    margin-bottom: 0;
+    padding: 0.5rem;
+}
+.section-collabora-actions.plone6 .btn {
+    font-size: 0.9rem;
+}
+.section-collabora-actions.plone4 {
+    display: flex;
+    justify-content: flex-end;
+}
+#content .section-collabora-actions.plone4 a.btn {
+    font-size: 0.9rem;
+    margin: 0 0.5rem;
+    padding: 0.25rem 0.5rem;
+    border-radius: 0.25rem;
+    background-color: #6c757d; color:white;
+}
+#content .section-collabora-actions.plone4 a.btn:hover {
+    background-color: #555;
+}
+#content .section-collabora-actions.plone4 a.btn.fullscreen {
+    margin-right: auto;
+}
+.section-collabora-actions .fullscreen {
+    float: left;
+}
+.section-collabora-main iframe {
+    border: 0
+}

collective/collabora/browser/static/edit.js

@@ -0,0 +1,92 @@
+//
+// --- host to collabora ---
+//
+
+
+function collabora_postMessage(message_id, values={}) {
+  var iframe = document.getElementById("cool-iframe");
+  var targetOrigin = iframe.getAttribute("collabora_server_url");
+  var msg = {
+    "MessageId": message_id,
+    "SendTime": Date.now(),
+    "Values": values
+  }
+  console.log(msg);
+  window.frames[0].postMessage(JSON.stringify(msg), targetOrigin);
+}
+
+
+function collabora_action_fullscreen() {
+  // Requesting fullscreen works only when CORS protection is not in play, i.e.
+  // when running Collabora via a reverse proxy on the same domain and port as
+  // Plone itself.
+  collabora_postMessage("Action_Fullscreen");
+}
+
+
+function collabora_action_save() {
+  collabora_postMessage("Action_Save", {"DontSaveIfUnmodified": "true"});
+}
+
+function collabora_action_close() {
+  collabora_postMessage("Action_Close");
+}
+
+function collabora_action_save_and_close() {
+  collabora_action_save();
+  collabora_action_close();
+}
+
+//
+// --- collabora to host ---
+//
+
+function isValidJSON(text) {
+  try {
+    JSON.parse(text);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+function resize_iframe() {
+  var iframe = document.getElementById("cool-iframe");
+  var plone_version = iframe.getAttribute("plone_version");
+
+  console.log("Resizing iframe on document loaded");
+  if (plone_version == "quaive") {
+    var offset = iframe.offsetTop + 80;
+  } else if (plone_version == "plone6") {
+    var offset = iframe.offsetTop + 5;
+  } else if (plone_version == "plone5") {
+    var offset = window.document.getElementById("main-container").offsetTop + 55;
+  } else {
+    var offset = window.document.getElementById("content").offsetTop + 210;
+  }
+  iframe.style.height = 'calc(100vh - ' + offset  + 'px)';
+  console.log("Resized cool-iframe");
+}
+
+// https://sdk.collaboraonline.com/docs/postmessage_api.html
+function handlePostMessage(e) {
+  // The actual message is contained in the data property of the event.
+  if (! isValidJSON(e.data)) {
+    return;
+  }
+  var msg = JSON.parse(e.data);
+  var msgId = msg.MessageId;
+  var msgData = msg.Values;
+  console.log('Received message: ' + msgId);
+  console.log(msgData);
+  if (msgData.Status == 'Frame_Ready') {
+    collabora_postMessage("Host_PostmessageReady");
+  }
+  if (msgData.Status == 'Document_Loaded') {
+    resize_iframe();
+  }
+}
+
+document.addEventListener("DOMContentLoaded", () => {
+  window.addEventListener('message', handlePostMessage, false);
+});

collective/collabora/browser/templates/edit.pt

@@ -0,0 +1,105 @@
+<html xmlns="http://www.w3.org/1999/xhtml"
+      xmlns:i18n="http://xml.zope.org/namespaces/i18n"
+      xmlns:metal="http://xml.zope.org/namespaces/metal"
+      xmlns:tal="http://xml.zope.org/namespaces/tal"
+      lang="en"
+      metal:use-macro="context/main_template/macros/master"
+      xml:lang="en"
+      i18n:domain="collective.collabora"
+>
+  <body>
+
+    <metal:css fill-slot="style_slot">
+      <style type="text/css"
+             tal:content="view/css_import"
+      >
+      </style>
+    </metal:css>
+    <metal:js fill-slot="javascript_head_slot">
+      <script tal:attributes="
+                src python: view.portal_url + '/++resource++collective.collabora/edit.js';
+              "></script>
+    </metal:js>
+
+    <metal:main fill-slot="main">
+      <metal:block define-macro="main"
+                   tal:define="
+                     error_msg view/error_msg;
+                   "
+      >
+        <div tal:condition="error_msg">
+          <h2 i18n:translate="label_error">Error</h2>
+          <p class="alert alert-warning"
+             tal:content="error_msg"
+          >error_msg</p>
+        </div>
+
+        <section tal:condition="not: view/error_msg"
+                 tal:attributes="
+                   class python:'section section-collabora-actions ' + view.plone_version;
+                 "
+        >
+          <a class="btn btn-secondary standalone fullscreen"
+             onclick="collabora_action_fullscreen(); return false;"
+             tal:condition="not: view/iframe_is_cors"
+             i18n:translate=""
+          >Fullscreen</a>
+          <a class="btn btn-secondary standalone download"
+             tal:attributes="
+               href view/download_url;
+             "
+          >
+            <span i18n:translate="">Download</span>
+            <span tal:content="python: view.human_readable_size()"
+                  i18n:ignore=""
+            >size</span>
+          </a>
+          <a class="btn btn-secondary standalone edit"
+             tal:condition="view/can_edit"
+             tal:attributes="
+               href python:context.absolute_url() + '/@@edit';
+             "
+             i18n:translate=""
+          >Edit metadata</a>
+          <a class="btn btn-primary context"
+             onclick="javascript:collabora_action_save_and_close(); return true;"
+             tal:condition="view/can_edit"
+             tal:attributes="
+               href python:context.absolute_url() + '/view';
+             "
+             i18n:translate=""
+          >Save & Close</a>
+          <a class="btn btn-primary context"
+             onclick="javascript:collabora_action_close(); return true;"
+             tal:condition="not:view/can_edit"
+             tal:attributes="
+               href python:context.absolute_url() + '/view';
+             "
+             i18n:translate=""
+          >Close</a>
+        </section>
+
+        <section tal:condition="not: view/error_msg"
+                 tal:attributes="
+                   class python:'section section-collabora-main ' + view.plone_version;
+                 "
+        >
+          <iframe id="cool-iframe"
+                  allowfullscreen="true"
+                  height="100%"
+                  name="cool-iframe"
+                  scrolling="no"
+                  width="100%"
+                  tal:attributes="
+                    collabora_server_url view/collabora_server_url;
+                    plone_version view/plone_version;
+                    src view/wopi_url;
+                  "
+          ></iframe>
+        </section>
+
+      </metal:block>
+    </metal:main>
+
+  </body>
+</html>