API / XSL / Use XSL output configuration (formatter, editor). (geonetwork#7929)

* API / Formatter / Use XSL output configuration.

Formatter API was using an XMLOutputter formatter overriding all
configuration made in `xsl:output`. This was producing "invalid" HTML
and some workaround were used so far.

Now, return the output produced by saxon XMLIndenter or HTMLIndenter
directly.

* Editor / Fix formatting.

The editor is an HTML page so don't use an XML formatter for the output.
To format the XML in XML view, saxon is taking care of it using
serialize and default-indent-mode. Use an HTML `pre` element which is
not formatted by HTMLIndenter.

* Formatter / Fix conflicting output when citation is used in xsl-view.

* API / Formatter / iText for PDF expect xhtml document. If HTML, complains about not closed tags like links.

Author: fxprunayre

common/src/main/java/org/fao/geonet/utils/Xml.java

@@ -39,14 +39,7 @@
 import org.fao.geonet.utils.nio.NioPathAwareEntityResolver;
 import org.fao.geonet.utils.nio.NioPathHolder;
 import org.fao.geonet.utils.nio.PathStreamSource;
-import org.jdom.Attribute;
-import org.jdom.Content;
-import org.jdom.DocType;
-import org.jdom.Document;
-import org.jdom.Element;
-import org.jdom.JDOMException;
-import org.jdom.Namespace;
-import org.jdom.Text;
+import org.jdom.*;
 import org.jdom.filter.ElementFilter;
 import org.jdom.input.SAXBuilder;
 import org.jdom.output.Format;
@@ -64,27 +57,14 @@
 import javax.xml.XMLConstants;
 import javax.xml.bind.JAXBContext;
 import javax.xml.bind.Unmarshaller;
-import javax.xml.transform.Result;
-import javax.xml.transform.Source;
-import javax.xml.transform.Transformer;
-import javax.xml.transform.TransformerException;
-import javax.xml.transform.TransformerFactory;
-import javax.xml.transform.URIResolver;
+import javax.xml.transform.*;
 import javax.xml.transform.sax.SAXResult;
 import javax.xml.transform.stream.StreamResult;
 import javax.xml.transform.stream.StreamSource;
 import javax.xml.validation.Schema;
 import javax.xml.validation.SchemaFactory;
 import javax.xml.validation.ValidatorHandler;
-import java.io.BufferedOutputStream;
-import java.io.ByteArrayInputStream;
-import java.io.DataInputStream;
-import java.io.File;
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.OutputStream;
-import java.io.PrintStream;
-import java.io.StringReader;
+import java.io.*;
 import java.net.HttpURLConnection;
 import java.net.URI;
 import java.net.URISyntaxException;
@@ -99,14 +79,7 @@
 import java.nio.file.Files;
 import java.nio.file.NoSuchFileException;
 import java.nio.file.Path;
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.HashSet;
-import java.util.Iterator;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-import java.util.UUID;
+import java.util.*;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
@@ -403,22 +376,16 @@ public static Element transform(Element xml, Path styleSheetPath, Map<String, Ob
     /**
      * Transforms an xml tree putting the result to a stream (uses a stylesheet on disk).
      */
-    public static void transform(Element xml, Path styleSheetPath, OutputStream out) throws Exception {
+    public static void transform(Element xml, Path styleSheetPath, Map<String, Object> params, OutputStream out) throws Exception {
         StreamResult resStream = new StreamResult(out);
-        transform(xml, styleSheetPath, resStream, null);
+        transform(xml, styleSheetPath, resStream, params);
         out.flush();
     }
 
-
-    public static void transformXml(Element xml, Path styleSheetPath, OutputStream out) throws Exception {
-        StreamResult resStream = new StreamResult(out);
-        Map<String, Object> map = new HashMap<>();
-        map.put("geonet-force-xml", "xml");
-        transform(xml, styleSheetPath, resStream, map);
-        out.flush();
+    public static void transform(Element xml, Path styleSheetPath, OutputStream out) throws Exception {
+        transform(xml, styleSheetPath, new HashMap<>(), out);
     }
 
-    //--------------------------------------------------------------------------
 
     /**
      * Transforms an xml tree putting the result to a stream  - no parameters.
@@ -484,6 +451,9 @@ protected static Path resolvePath(Source s) throws URISyntaxException {
 
     /**
      * Transforms an xml tree putting the result to a stream with optional parameters.
+     * <p>
+     * Add a geonet-force-xml parameter to force the formatting to be xml.
+     * The preferred method is to define it using xsl:output.
      */
     public static void
     transform(Element xml, Path styleSheetPath, Result result, Map<String, Object> params) throws Exception {
@@ -515,13 +485,13 @@ protected static Path resolvePath(Source s) throws URISyntaxException {
                         t.setParameter(param.getKey(), param.getValue());
                     }
 
-                if (params.containsKey("geonet-force-xml")) {
-                    ((Controller) t).setOutputProperty("indent", "yes");
-                    ((Controller) t).setOutputProperty("method", "xml");
-                    ((Controller) t).setOutputProperty("{http://saxon.sf.net/}indent-spaces", "3");
+                    if (params.containsKey("geonet-force-xml")) {
+                        ((Controller) t).setOutputProperty("indent", "yes");
+                        ((Controller) t).setOutputProperty("method", "xml");
+                        ((Controller) t).setOutputProperty("{http://saxon.sf.net/}indent-spaces", "2");
+                    }
                 }
 
-                }
                 t.transform(srcXml, result);
             }
         }

schemas/iso19115-3.2018/src/main/plugin/iso19115-3.2018/formatter/citation/common.xsl

@@ -12,6 +12,7 @@
                 extension-element-prefixes="saxon"
                 exclude-result-prefixes="#all">
 
+
   <xsl:param name="format"
              select="'html'"/>
 
@@ -24,6 +25,7 @@
   <!-- What entity is responsible for producing and/or distributing the data set?  Also, is there a physical location associated with the publisher? -->
   <xsl:param name="publisherRoles"
                 select="'publisher'"/>
+
   <xsl:variable name="publisherRolesList"
                 select="tokenize($publisherRoles, ',')"/>
 
@@ -115,7 +117,7 @@
     <blockquote>
       <div class="row">
         <div class="col-md-3">
-          <i class="fa fa-quote-left pull-right"><xsl:comment select="'icon'"/></i>
+          <i class="fa fa-quote-left pull-right"><xsl:comment/></i>
         </div>
         <div class="col-md-9">
           <p>

schemas/iso19115-3.2018/src/main/plugin/iso19115-3.2018/formatter/citation/view.xsl

@@ -13,6 +13,12 @@
                 extension-element-prefixes="saxon"
                 exclude-result-prefixes="#all">
 
+  <xsl:output omit-xml-declaration="yes"
+              method="xml"
+              indent="yes"
+              saxon:indent-spaces="2"
+              encoding="UTF-8"/>
+
   <xsl:import href="base.xsl"/>
   <xsl:import href="common.xsl"/>
 

schemas/iso19115-3.2018/src/main/plugin/iso19115-3.2018/formatter/xsl-view/view.xsl

@@ -150,8 +150,8 @@
     <xsl:if test="count($tags/*) > 0">
       <section class="gn-md-side-social">
         <h2>
-          <i class="fa fa-fw fa-tag"><xsl:comment select="'image'"/></i>
-          <span><xsl:comment select="name()"/>
+          <i class="fa fa-fw fa-tag"></i>
+          <span>
             <xsl:value-of select="$schemaStrings/noThesaurusName"/>
           </span>
         </h2>
@@ -219,8 +219,8 @@
     <xsl:if test=".//mdb:identificationInfo/*/mri:extent">
       <section class="gn-md-side-extent">
         <h2>
-          <i class="fa fa-fw fa-map-marker"><xsl:comment select="'image'"/></i>
-          <span><xsl:comment select="name()"/>
+          <i class="fa fa-fw fa-map-marker"></i>
+          <span>
             <xsl:value-of select="$schemaStrings/spatialExtent"/>
           </span>
         </h2>
@@ -243,7 +243,7 @@
     <xsl:if test="mdb:identificationInfo/*/mri:graphicOverview">
       <section class="gn-md-side-overview">
         <h2>
-          <i class="fa fa-fw fa-image"><xsl:comment select="'.'"/></i><xsl:comment select="'.'"/>
+          <i class="fa fa-fw fa-image"></i>
           <span>
             <xsl:value-of select="$schemaStrings/overviews"/>
           </span>
@@ -295,7 +295,7 @@
     <xsl:if test="$withJsonLd = 'true'">
       <script type="application/ld+json">
         <xsl:apply-templates mode="getJsonLD"
-                             select="$metadata"/><xsl:comment select="'.'"/>
+                             select="$metadata"/>
       </script>
     </xsl:if>
   </xsl:template>
@@ -332,10 +332,10 @@
           <blockquote>
             <div class="row">
               <div class="col-md-1">
-                <i class="fa fa-quote-left"><xsl:comment>Cite</xsl:comment></i>
+                <i class="fa fa-quote-left"></i>
               </div>
               <div class="col-md-11">
-                <h2 title="{$schemaStrings/citationProposal-help}"><xsl:comment select="name()"/>
+                <h2 title="{$schemaStrings/citationProposal-help}">
                   <xsl:value-of select="$schemaStrings/citationProposal"/>
                 </h2>
 
@@ -370,7 +370,7 @@
           <div data-ng-if="showCitation"
                data-gn-metadata-citation=""
                data-text="{$citation}">
-            <xsl:comment>citation</xsl:comment>
+            
           </div>
         </xsl:when>
         <xsl:otherwise>
@@ -444,7 +444,7 @@
           <xsl:otherwise>
             <xsl:apply-templates mode="render-value" select="."/>
           </xsl:otherwise>
-        </xsl:choose><xsl:comment select="'.'"/>
+        </xsl:choose>
         <xsl:apply-templates mode="render-value" select="@*"/>
       </dd>
     </dl>
@@ -554,9 +554,9 @@
             <xsl:with-param name="languages" select="$allLanguages"/>
           </xsl:call-template>
           <xsl:apply-templates mode="render-value"
-                               select="@*"/><xsl:comment select="'.'"/>
+                               select="@*"/>
         </h2>
-        <div class="target"><xsl:comment select="'.'"/>
+        <div class="target">
           <xsl:apply-templates mode="render-field" select="*"/>
         </div>
       </div>
@@ -627,7 +627,7 @@
       <xsl:otherwise>
         <div class="gn-contact">
           <h4>
-            <i class="fa fa-envelope"><xsl:comment select="'.'"/></i>
+            <i class="fa fa-fw fa-envelope"></i>
             <xsl:apply-templates mode="render-value"
                                  select="*/cit:role/*/@codeListValue"/>
           </h4>
@@ -678,7 +678,7 @@
       <xsl:for-each select=".//cit:electronicMailAddress[not(gco:nilReason)]">
         <xsl:apply-templates mode="render-value-no-breaklines"
                              select="."/>
-        <xsl:if test="position() != last()">,<xsl:comment select="'.'"/></xsl:if>
+        <xsl:if test="position() != last()">,</xsl:if>
       </xsl:for-each>
     </xsl:variable>
 
@@ -699,7 +699,7 @@
 
         <xsl:if test="$email != ''">
           <a href="mailto:{normalize-space($email)}">
-            <sup class="fa fa-envelope">&#160;</sup>
+            <sup class="fa fa-fw fa-envelope">&#160;</sup>
           </a>
         </xsl:if>
       </xsl:when>
@@ -712,11 +712,11 @@
                 <xsl:choose>
                   <xsl:when test="normalize-space($email) != ''">
                     <a href="mailto:{normalize-space($email)}">
-                      <xsl:value-of select="$displayName"/><xsl:comment select="'.'"/>
+                      <xsl:value-of select="$displayName"/>
                     </a>
                   </xsl:when>
                   <xsl:otherwise>
-                    <xsl:value-of select="$displayName"/><xsl:comment select="'.'"/>
+                    <xsl:value-of select="$displayName"/>
                   </xsl:otherwise>
                 </xsl:choose>
               </strong><br/>
@@ -741,7 +741,7 @@
                     <xsl:variable name="phoneNumber">
                       <xsl:apply-templates mode="render-value-no-breaklines" select="."/>
                     </xsl:variable>
-                    <i class="fa fa-phone"><xsl:comment select="'.'"/></i>
+                    <i class="fa fa-fw fa-phone"></i>
                     <a href="tel:{$phoneNumber}">
                       <xsl:value-of select="$phoneNumber"/>
                     </a>
@@ -752,9 +752,9 @@
                     <xsl:variable name="phoneNumber">
                       <xsl:apply-templates mode="render-value-no-breaklines" select="."/>
                     </xsl:variable>
-                    <i class="fa fa-fax"><xsl:comment select="'.'"/></i>
+                    <i class="fa fa-fw fa-fax"></i>
                     <a href="tel:{normalize-space($phoneNumber)}">
-                      <xsl:value-of select="normalize-space($phoneNumber)"/><xsl:comment select="'.'"/>(<xsl:value-of select="../cit:numberType/*/@codeListValue"/>)
+                      <xsl:value-of select="normalize-space($phoneNumber)"/> (<xsl:value-of select="../cit:numberType/*/@codeListValue"/>)
                     </a>
                   </div>
                 </xsl:for-each>
@@ -770,7 +770,7 @@
                   <xsl:variable name="linkage">
                     <xsl:apply-templates mode="render-value-no-breaklines" select="."/>
                   </xsl:variable>
-                  <i class="fa fa-link"><xsl:comment select="'.'"/></i>
+                  <i class="fa fa-fw fa-link"></i>
                   <a href="{normalize-space($linkage)}" target="_blank">
                     <xsl:value-of select="if (normalize-space($linkName) != '')
                                           then $linkName
@@ -838,7 +838,7 @@
         <xsl:apply-templates mode="render-value" select="@*"/>
 
         <a class="btn btn-link" href="{$nodeUrl}api/records/{$metadataId}/formatters/xml" target="_blank">
-          <i class="fa fa-file-code-o fa-2x"><xsl:comment select="'.'"/></i>
+          <i class="fa fa-fw fa-file-code-o fa-2x"></i>
           <span><xsl:value-of select="$schemaStrings/metadataInXML"/></span>
         </a>
       </dd>
@@ -862,7 +862,7 @@
         </xsl:variable>
         <a href="{*/cit:linkage/*}" target="_blank">
           <xsl:apply-templates mode="render-value"
-                               select="if (*/cit:name != '') then */cit:name else */cit:linkage"/><xsl:comment select="'.'"/>
+                               select="if (*/cit:name != '') then */cit:name else */cit:linkage"/>
         </a>
         <p>
           <xsl:value-of select="normalize-space($linkDescription)"/>
@@ -1097,7 +1097,7 @@
             <xsl:for-each select="parent::node()/*[name() = $nodeName]">
               <li>
                 <a href="{$nodeUrl}api/records/{@uuidref}">
-                  <i class="fa fa-link"><xsl:comment select="'.'"/></i>
+                  <i class="fa fa-fw fa-link"></i>
                   <xsl:value-of select="gn-fn-render:getMetadataTitle(@uuidref, $language)"/>
                 </a>
               </li>
@@ -1181,7 +1181,7 @@
 
     <xsl:if test="@uom">
       <!-- Display the unit value only -->
-      <xsl:comment select="'.'"/>&#160; <xsl:value-of select="if (contains(@uom, '#'))
+      &#160; <xsl:value-of select="if (contains(@uom, '#'))
                                     then concat(., ' ', tokenize(@uom, '#')[2])
                                     else  concat(., ' ', @uom)"/>
     </xsl:if>
@@ -1348,7 +1348,7 @@
   <xsl:template mode="render-value"
                 match="@gco:nilReason[. = 'withheld']"
                 priority="100">
-    <i class="fa fa-lock text-warning" title="{{{{'withheld' | translate}}}}"><xsl:comment select="'.'"/></i>
+    <i class="fa fa-fw fa-lock text-warning" title="{{{{'withheld' | translate}}}}"></i>
   </xsl:template>
   <xsl:template mode="render-value"
                 match="@*"/>

schemas/iso19139/src/main/plugin/iso19139/formatter/citation/view.xsl

@@ -18,6 +18,12 @@
                 extension-element-prefixes="saxon"
                 exclude-result-prefixes="#all">
 
+  <xsl:output omit-xml-declaration="yes"
+              method="xml"
+              indent="yes"
+              saxon:indent-spaces="2"
+              encoding="UTF-8"/>
+
   <xsl:include href="base.xsl"/>
   <xsl:include href="../../../iso19115-3.2018/formatter/citation/common.xsl"/>