View Javadoc
1   /*
2    * Copyright (c) 2012-2022, jcabi.com
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met: 1) Redistributions of source code must retain the above
8    * copyright notice, this list of conditions and the following
9    * disclaimer. 2) Redistributions in binary form must reproduce the above
10   * copyright notice, this list of conditions and the following
11   * disclaimer in the documentation and/or other materials provided
12   * with the distribution. 3) Neither the name of the jcabi.com nor
13   * the names of its contributors may be used to endorse or promote
14   * products derived from this software without specific prior written
15   * permission.
16   *
17   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18   * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
19   * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
20   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21   * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
22   * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25   * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
28   * OF THE POSSIBILITY OF SUCH DAMAGE.
29   */
30  package com.jcabi.xml;
31  
32  import java.io.File;
33  import java.io.FileInputStream;
34  import java.io.FileNotFoundException;
35  import java.io.IOException;
36  import java.nio.file.Files;
37  import javax.xml.transform.Source;
38  import javax.xml.transform.TransformerException;
39  import javax.xml.transform.stream.StreamSource;
40  import lombok.EqualsAndHashCode;
41  
42  /**
43   * Sources in file system.
44   *
45   * If you have some resources in files, just configure your
46   * XSL with this "sources":
47   *
48   * <pre> XSL xsl = new XSLDocument(input).with(
49   *   new FileSources("/tmp/my-resources")
50   * );</pre>
51   *
52   * @since 0.18
53   */
54  @EqualsAndHashCode(of = "path")
55  public final class FileSources implements Sources {
56  
57      /**
58       * Directory.
59       */
60      private final transient File path;
61  
62      /**
63       * Public ctor.
64       */
65      public FileSources() {
66          this("");
67      }
68  
69      /**
70       * Public ctor.
71       * @param dir Directory
72       */
73      public FileSources(final String dir) {
74          this(new File(dir));
75      }
76  
77      /**
78       * Public ctor.
79       * @param dir Directory
80       */
81      public FileSources(final File dir) {
82          this.path = dir;
83      }
84  
85      @Override
86      public Source resolve(final String href, final String base)
87          throws TransformerException {
88          File file = new File(this.path, href);
89          if (!file.exists()) {
90              if (base == null) {
91                  file = new File(href);
92              } else {
93                  file = new File(new File(base), href);
94              }
95              if (!file.exists()) {
96                  throw new TransformerException(
97                      String.format(
98                          "File \"%s\" not found in \"%s\" and in base \"%s\"",
99                          href, this.path, base
100                     )
101                 );
102             }
103         }
104         try {
105             return new StreamSource(Files.newInputStream(file.toPath()));
106         } catch (final IOException ex) {
107             throw new TransformerException(
108                 String.format("Can't read from file '%s'", file),
109                 ex
110             );
111         }
112     }
113 }