EZP-29634: ezxmltext -> richtext conversion : <custom> inside <sectio…

…n> (#76)

lib/FieldType/XmlText/Converter/RichText.php

@@ -529,6 +529,38 @@ protected function writeWarningOnNonSupportedLiterals(DOMDocument $document, $co
         }
     }
 
+    /**
+     * @param DOMDocument $document
+     * @param null|int $contentFieldId
+     */
+    protected function writeWarningOnNonSupportedCustomTags(DOMDocument $document, $contentFieldId)
+    {
+        $xpath = new DOMXPath($document);
+
+        $xpathExpression = '//custom';
+
+        $elements = $xpath->query($xpathExpression);
+
+        foreach ($elements as $element) {
+            $customTagName = $element->getAttribute('name');
+            $parent = $element->parentNode;
+            $blockCustomTag = ($parent->localName === 'paragraph' && $parent->hasAttribute('ez-temporary')) || $parent->localName === 'section';
+
+            // These legacy custom tags are not custom tags in richtext
+            if (in_array($customTagName, ['quote', 'underline', 'strike', 'sub', 'sup'])) {
+                continue;
+            }
+
+            if (!$blockCustomTag) {
+                $this->log(LogLevel::WARNING, "Inline custom tag '$customTagName' not supported by editor at the moment. You'll not be able to edit content correctly in editor where contentobject_attribute.id=$contentFieldId");
+            }
+
+            if ($parent->localName === 'section') {
+                $this->log(LogLevel::WARNING, "Custom tag '$customTagName' converted to block custom tag. It might have been inline custom tag in legacy DB where contentobject_attribute.id=$contentFieldId");
+            }
+        }
+    }
+
     /**
      * Before calling this function, make sure you are logged in as admin, or at least have access to all the objects
      * being embedded and linked to in the $inputDocument.
@@ -560,6 +592,7 @@ public function convert(DOMDocument $inputDocument, $checkDuplicateIds = false,
             );
             throw $e;
         }
+        $this->writeWarningOnNonSupportedCustomTags($inputDocument, $contentFieldId);
         if ($checkDuplicateIds) {
             $this->reportNonUniqueIds($convertedDocument, $contentFieldId);
         }

lib/FieldType/XmlText/Input/Resources/stylesheets/eZXml2Docbook_core.xsl

@@ -50,31 +50,7 @@
     </xsl:element>
   </xsl:template>
 
-  <xsl:template match="literal">
-    <xsl:choose>
-      <xsl:when test="@class = 'html'">
-        <xsl:element name="eztemplate">
-          <xsl:attribute name="name">
-            <xsl:value-of select="'rawhtml'"/>
-          </xsl:attribute>
-          <xsl:element name="ezcontent">
-            <xsl:value-of select="./text()"/>
-          </xsl:element>
-          <xsl:if test="@*[namespace-uri() = 'http://ez.no/namespaces/ezpublish3/custom/' and not( local-name() = 'class' )]">
-            <xsl:element name="ezconfig">
-              <xsl:for-each select="@*[namespace-uri() = 'http://ez.no/namespaces/ezpublish3/custom/' and not( local-name() = 'class' )]">
-                <xsl:call-template name="addHashValue">
-                  <xsl:with-param name="attribute" select="current()"/>
-                </xsl:call-template>
-              </xsl:for-each>
-            </xsl:element>
-          </xsl:if>
-        </xsl:element>
-      </xsl:when>
-    </xsl:choose>
-  </xsl:template>
-
-  <xsl:template match="paragraph[@ez-temporary]/custom">
+  <xsl:template match="paragraph[@ez-temporary]/custom|section/custom">
     <xsl:element name="eztemplate" namespace="http://docbook.org/ns/docbook">
       <xsl:attribute name="name">
         <xsl:value-of select="@name"/>
@@ -106,6 +82,30 @@
     </xsl:element>
   </xsl:template>
 
+  <xsl:template match="literal">
+    <xsl:choose>
+      <xsl:when test="@class = 'html'">
+        <xsl:element name="eztemplate">
+          <xsl:attribute name="name">
+            <xsl:value-of select="'rawhtml'"/>
+          </xsl:attribute>
+          <xsl:element name="ezcontent">
+            <xsl:value-of select="./text()"/>
+          </xsl:element>
+          <xsl:if test="@*[namespace-uri() = 'http://ez.no/namespaces/ezpublish3/custom/' and not( local-name() = 'class' )]">
+            <xsl:element name="ezconfig">
+              <xsl:for-each select="@*[namespace-uri() = 'http://ez.no/namespaces/ezpublish3/custom/' and not( local-name() = 'class' )]">
+                <xsl:call-template name="addHashValue">
+                  <xsl:with-param name="attribute" select="current()"/>
+                </xsl:call-template>
+              </xsl:for-each>
+            </xsl:element>
+          </xsl:if>
+        </xsl:element>
+      </xsl:when>
+    </xsl:choose>
+  </xsl:template>
+
   <xsl:template match="section">
     <xsl:choose>
       <xsl:when test="count(ancestor-or-self::section) &gt; 1">

tests/lib/FieldType/Converter/_fixtures/richtext/input/160-eztemplate.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8"?>
+<section
+        xmlns:custom="http://ez.no/namespaces/ezpublish3/custom/"
+        xmlns:image="http://ez.no/namespaces/ezpublish3/image/"
+        xmlns:xhtml="http://ez.no/namespaces/ezpublish3/xhtml/">
+    <section>
+        <custom name="linebreak"/>
+    </section>
+    <!-- xmlns:tmp="http://ez.no/namespaces/ezpublish3/temporary/"-->
+    <paragraph xmlns:tmp="http://ez.no/namespaces/ezpublish3/temporary/">
+        <custom name="mycustomtag" custom:class="templateClass" custom:align="left" custom:title="foobar">
+            custom tag content
+        </custom>
+    </paragraph>
+</section>

tests/lib/FieldType/Converter/_fixtures/richtext/input/170-eztemplateinline.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<section
+        xmlns:custom="http://ez.no/namespaces/ezpublish3/custom/"
+        xmlns:image="http://ez.no/namespaces/ezpublish3/image/"
+        xmlns:xhtml="http://ez.no/namespaces/ezpublish3/xhtml/">
+    <header>Advisers:
+        <custom name="linebreak"/>Foobar Corp.</header>
+</section>

tests/lib/FieldType/Converter/_fixtures/richtext/log/160-eztemplate.log

@@ -0,0 +1 @@
+warning:Custom tag 'linebreak' converted to block custom tag. It might have been inline custom tag in legacy DB where contentobject_attribute.id=

tests/lib/FieldType/Converter/_fixtures/richtext/log/170-eztemplateinline.log

@@ -0,0 +1 @@
+warning:Inline custom tag 'linebreak' not supported by editor at the moment. You'll not be able to edit content correctly in editor where contentobject_attribute.id=

tests/lib/FieldType/Converter/_fixtures/richtext/output/160-eztemplate.xml

@@ -0,0 +1,16 @@
+<section
+        xmlns="http://docbook.org/ns/docbook"
+        xmlns:ezcustom="http://ez.no/xmlns/ezpublish/docbook/custom"
+        xmlns:ezxhtml="http://ez.no/xmlns/ezpublish/docbook/xhtml"
+        xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0">
+  <eztemplate name="linebreak"/>
+  <eztemplate name="mycustomtag" ezxhtml:align="left" ezxhtml:class="templateClass">
+    <ezcontent>
+            custom tag content
+        </ezcontent>
+    <ezconfig>
+      <ezvalue key="title">foobar</ezvalue>
+    </ezconfig>
+  </eztemplate>
+</section>
+

tests/lib/FieldType/Converter/_fixtures/richtext/output/170-eztemplateinline.xml

@@ -0,0 +1,9 @@
+<section
+        xmlns="http://docbook.org/ns/docbook"
+        xmlns:ezcustom="http://ez.no/xmlns/ezpublish/docbook/custom"
+        xmlns:ezxhtml="http://ez.no/xmlns/ezpublish/docbook/xhtml"
+        xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0">
+  <title ezxhtml:level="2">Advisers:
+        <eztemplateinline name="linebreak"/>Foobar Corp.</title>
+</section>
+