1 /*
   2  * Copyright (c) 2003, 2015, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  */
  23 package javax.xml.transform.ptests;
  24 
  25 import java.io.File;
  26 import java.io.FileInputStream;
  27 import javax.xml.parsers.DocumentBuilder;
  28 import javax.xml.parsers.DocumentBuilderFactory;
  29 import javax.xml.transform.Source;
  30 import javax.xml.transform.Transformer;
  31 import javax.xml.transform.TransformerFactory;
  32 import javax.xml.transform.URIResolver;
  33 import javax.xml.transform.dom.DOMSource;
  34 import static javax.xml.transform.ptests.TransformerTestConst.XML_DIR;
  35 import javax.xml.transform.sax.SAXSource;
  36 import javax.xml.transform.stream.StreamResult;
  37 import javax.xml.transform.stream.StreamSource;
  38 import jaxp.library.JAXPFileBaseTest;
  39 import static org.testng.Assert.assertEquals;
  40 import static org.testng.Assert.assertNotNull;
  41 import org.testng.annotations.Test;
  42 import org.w3c.dom.Document;
  43 import org.xml.sax.InputSource;
  44 
  45 /**
  46  * URIResolver should be invoked when transform happens.
  47  */
  48 public class URIResolverTest extends JAXPFileBaseTest implements URIResolver {
  49     /**
  50      * System ID constant.
  51      */
  52     private final static String SYSTEM_ID = "file:///" + XML_DIR;
  53 
  54     /**
  55      * XML file include link file.
  56      */
  57     private final static String XSL_INCLUDE_FILE = XML_DIR + "citiesinclude.xsl";
  58 
  59     /**
  60      * XML file import link file.
  61      */
  62     private final static String XSL_IMPORT_FILE = XML_DIR + "citiesimport.xsl";
  63 
  64     /**
  65      * TEMP XML file.
  66      */
  67     private final static String XSL_TEMP_FILE = "temp/cities.xsl";
  68 
  69     /**
  70      * expected HREF.
  71      */
  72     private final String validateHref;
  73 
  74     /**
  75      * expected Base URI.
  76      */
  77     private final String validateBase;
  78 
  79     /**
  80      * Default constructor for testng invocation.
  81      */
  82     public URIResolverTest(){
  83         validateHref = null;
  84         validateBase = null;
  85     }
  86 
  87     /**
  88      * Constructor for setting expected Href and expected Base URI.
  89      * @param validateHref expected Href
  90      * @param validateBase expected Base URI
  91      */
  92     public URIResolverTest(String validateHref, String validateBase){
  93         this.validateHref = validateHref;
  94         this.validateBase = validateBase;
  95     }
  96 
  97     /**
  98      * Called by the processor when it encounters an xsl:include, xsl:import,
  99      * or document() function.
 100      * @param href An href attribute, which may be relative or absolute.
 101      * @param base The base URI against which the first argument will be made
 102      * absolute if the absolute URI is required.
 103      * @return null always.
 104      */
 105     @Override
 106     public Source resolve(String href, String base) {
 107         assertEquals(href, validateHref);
 108         assertEquals(base, validateBase);
 109         return null;
 110     }
 111 
 112     /**
 113      * This is to test the URIResolver.resolve() method when a transformer is
 114      * created using StreamSource. style-sheet file has xsl:include in it.
 115      *
 116      * @throws Exception If any errors occur.
 117      */
 118     @Test (groups = {"readLocalFiles"})
 119     public static void resolver01() throws Exception {
 120         try (FileInputStream fis = new FileInputStream(XSL_INCLUDE_FILE)) {
 121             TransformerFactory tfactory = TransformerFactory.newInstance();
 122             URIResolverTest resolver = new URIResolverTest(XSL_TEMP_FILE, SYSTEM_ID);
 123             tfactory.setURIResolver(resolver);
 124 
 125             StreamSource streamSource = new StreamSource(fis);
 126             streamSource.setSystemId(SYSTEM_ID);
 127             assertNotNull(tfactory.newTransformer(streamSource));
 128         }
 129     }
 130 
 131     /**
 132      * This is to test the URIResolver.resolve() method when a transformer is
 133      * created using DOMSource. style-sheet file has xsl:include in it.
 134      *
 135      * @throws Exception If any errors occur.
 136      */
 137     @Test (groups = {"readLocalFiles"})
 138     public static void resolver02() throws Exception {
 139         TransformerFactory tfactory = TransformerFactory.newInstance();
 140         URIResolverTest resolver = new URIResolverTest(XSL_TEMP_FILE, SYSTEM_ID);
 141         tfactory.setURIResolver(resolver);
 142 
 143         DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
 144         dbf.setNamespaceAware(true);
 145         DocumentBuilder db = dbf.newDocumentBuilder();
 146         Document document = db.parse(XSL_INCLUDE_FILE);
 147         DOMSource domSource = new DOMSource(document, SYSTEM_ID);
 148 
 149         assertNotNull(tfactory.newTransformer(domSource));
 150     }
 151 
 152     /**
 153      * This is to test the URIResolver.resolve() method when a transformer is
 154      * created using SAXSource. style-sheet file has xsl:include in it.
 155      *
 156      * @throws Exception If any errors occur.
 157      */
 158     @Test (groups = {"readLocalFiles"})
 159     public static void resolver03() throws Exception {
 160         try (FileInputStream fis = new FileInputStream(XSL_INCLUDE_FILE)){
 161             URIResolverTest resolver = new URIResolverTest(XSL_TEMP_FILE, SYSTEM_ID);
 162             TransformerFactory tfactory = TransformerFactory.newInstance();
 163             tfactory.setURIResolver(resolver);
 164             InputSource is = new InputSource(fis);
 165             is.setSystemId(SYSTEM_ID);
 166             SAXSource saxSource = new SAXSource(is);
 167             assertNotNull(tfactory.newTransformer(saxSource));
 168         }
 169     }
 170 
 171     /**
 172      * This is to test the URIResolver.resolve() method when a transformer is
 173      * created using StreamSource. style-sheet file has xsl:import in it.
 174      *
 175      * @throws Exception If any errors occur.
 176      */
 177     @Test (groups = {"readLocalFiles"})
 178     public static void resolver04() throws Exception {
 179         try (FileInputStream fis = new FileInputStream(XSL_IMPORT_FILE)) {
 180             URIResolverTest resolver = new URIResolverTest(XSL_TEMP_FILE, SYSTEM_ID);
 181             TransformerFactory tfactory = TransformerFactory.newInstance();
 182             tfactory.setURIResolver(resolver);
 183             StreamSource streamSource = new StreamSource(fis);
 184             streamSource.setSystemId(SYSTEM_ID);
 185             assertNotNull(tfactory.newTransformer(streamSource));
 186         }
 187     }
 188 
 189     /**
 190      * This is to test the URIResolver.resolve() method when a transformer is
 191      * created using DOMSource. style-sheet file has xsl:import in it.
 192      *
 193      * @throws Exception If any errors occur.
 194      */
 195     @Test (groups = {"readLocalFiles"})
 196     public static void resolver05() throws Exception {
 197         URIResolverTest resolver = new URIResolverTest(XSL_TEMP_FILE, SYSTEM_ID);
 198         TransformerFactory tfactory = TransformerFactory.newInstance();
 199         tfactory.setURIResolver(resolver);
 200         DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
 201         dbf.setNamespaceAware(true);
 202         DocumentBuilder db = dbf.newDocumentBuilder();
 203         Document document = db.parse(new File(XSL_IMPORT_FILE));
 204         DOMSource domSource = new DOMSource(document, SYSTEM_ID);
 205         assertNotNull(tfactory.newTransformer(domSource));
 206     }
 207 
 208     /**
 209      * This is to test the URIResolver.resolve() method when a transformer is
 210      * created using SAXSource. style-sheet file has xsl:import in it.
 211      *
 212      * @throws Exception If any errors occur.
 213      */
 214     @Test (groups = {"readLocalFiles"})
 215     public static void resolver06() throws Exception {
 216         try (FileInputStream fis = new FileInputStream(XSL_IMPORT_FILE)){
 217             URIResolverTest resolver = new URIResolverTest(XSL_TEMP_FILE, SYSTEM_ID);
 218             TransformerFactory tfactory = TransformerFactory.newInstance();
 219             tfactory.setURIResolver(resolver);
 220             InputSource is = new InputSource(fis);
 221             is.setSystemId(SYSTEM_ID);
 222             SAXSource saxSource = new SAXSource(is);
 223             assertNotNull(tfactory.newTransformer(saxSource));
 224         }
 225     }
 226 
 227     /**
 228      * This is to test the URIResolver.resolve() method when there is an error
 229      * in the file.
 230      *
 231      * @throws Exception If any errors occur.
 232      */
 233     @Test (groups = {"readLocalFiles"})
 234     public static void docResolver01() throws Exception {
 235         try (FileInputStream fis = new FileInputStream(XML_DIR + "doctest.xsl")) {
 236             URIResolverTest resolver = new URIResolverTest("temp/colors.xml", SYSTEM_ID);
 237             StreamSource streamSource = new StreamSource(fis);
 238             streamSource.setSystemId(SYSTEM_ID);
 239 
 240             Transformer transformer = TransformerFactory.newInstance().newTransformer(streamSource);
 241             transformer.setURIResolver(resolver);
 242 
 243             File f = new File(XML_DIR + "myFake.xml");
 244             Document document = DocumentBuilderFactory.newInstance().
 245                     newDocumentBuilder().parse(f);
 246 
 247             // Use a Transformer for output
 248             DOMSource source = new DOMSource(document);
 249             StreamResult result = new StreamResult(System.err);
 250             // No exception is expected because resolver resolve wrong URI.
 251             transformer.transform(source, result);
 252         }
 253     }
 254 }