View Javadoc
1   /**
2    * This file Copyright (c) 2003-2018 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.module.files;
35  
36  import info.magnolia.cms.util.ClasspathResourcesUtil;
37  
38  import java.io.File;
39  import java.io.FileOutputStream;
40  import java.io.IOException;
41  import java.io.InputStream;
42  import java.io.OutputStream;
43  
44  import org.apache.commons.io.IOUtils;
45  
46  /**
47   * A simple FileExtractorOperation which just extracts a resource from the class path
48   * to the filesystem.
49   */
50  public class BasicFileExtractorOperation implements FileExtractorOperation {
51      protected final String resourcePath;
52      protected final String absoluteTargetPath;
53  
54      BasicFileExtractorOperation(String resourcePath, String absoluteTargetPath) {
55          this.resourcePath = resourcePath;
56          this.absoluteTargetPath = absoluteTargetPath;
57      }
58  
59      @Override
60      public void extract() throws IOException {
61          final InputStream resourceStream = checkInput();
62          final File checkedTargetFile = checkOutput();
63          if (checkedTargetFile != null) {
64              final OutputStream out = openOutput(checkedTargetFile);
65  
66              copyAndClose(resourceStream, out);
67          }
68      }
69  
70      protected InputStream checkInput() throws IOException {
71          final InputStream resourceStream = ClasspathResourcesUtil.getStream(resourcePath, false);
72          if (resourceStream == null) {
73              throw new IOException("Can't open " + resourcePath);
74          }
75          return resourceStream;
76      }
77  
78      /**
79       * @return a java.io.File corresponding to the absoluteTargetPath if the path is validated,
80       *         or null if the file should not be extracted. TODO ugly.
81       */
82      protected File checkOutput() throws IOException {
83          final File targetFile = new File(absoluteTargetPath);
84          final File parent = targetFile.getParentFile();
85          if (!parent.exists() && !parent.mkdirs()) {
86              throw new IOException("Can't create directories for " + targetFile.getAbsolutePath());
87          } else if (!parent.canWrite()) {
88              throw new IOException("Can't write to " + targetFile.getAbsolutePath());
89          }
90          return targetFile;
91      }
92  
93      protected OutputStream openOutput(File targetFile) throws IOException {
94          return new FileOutputStream(targetFile);
95      }
96  
97      protected void copyAndClose(InputStream in, OutputStream out) throws IOException {
98          try {
99              IOUtils.copy(in, out);
100         } finally {
101             IOUtils.closeQuietly(in);
102             IOUtils.closeQuietly(out);
103         }
104     }
105 }