1 /**
2 * This file Copyright (c) 2003-2014 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 import org.apache.commons.io.IOUtils;
38
39 import java.io.File;
40 import java.io.FileOutputStream;
41 import java.io.IOException;
42 import java.io.InputStream;
43 import java.io.OutputStream;
44
45 /**
46 * A simple FileExtractorOperation which just extracts a resource from the class path
47 * to the filesystem.
48 *
49 * @author gjoseph
50 * @version $Revision: $ ($Author: $)
51 */
52 public class BasicFileExtractorOperation implements FileExtractorOperation {
53 protected final String resourcePath;
54 protected final String absoluteTargetPath;
55
56 BasicFileExtractorOperation(String resourcePath, String absoluteTargetPath) {
57 this.resourcePath = resourcePath;
58 this.absoluteTargetPath = absoluteTargetPath;
59 }
60
61 @Override
62 public void extract() throws IOException {
63 final InputStream resourceStream = checkInput();
64 final File checkedTargetFile = checkOutput();
65 if (checkedTargetFile != null) {
66 final OutputStream out = openOutput(checkedTargetFile);
67
68 copyAndClose(resourceStream, out);
69 }
70 }
71
72 protected InputStream checkInput() throws IOException {
73 final InputStream resourceStream = ClasspathResourcesUtil.getStream(resourcePath, false);
74 if (resourceStream == null) {
75 throw new IOException("Can't open " + resourcePath);
76 }
77 return resourceStream;
78 }
79
80 /**
81 * @return a java.io.File corresponding to the absoluteTargetPath if the path is validated,
82 * or null if the file should not be extracted. TODO ugly.
83 */
84 protected File checkOutput() throws IOException {
85 final File targetFile = new File(absoluteTargetPath);
86 final File parent = targetFile.getParentFile();
87 if (!parent.exists() && !parent.mkdirs()) {
88 throw new IOException("Can't create directories for " + targetFile.getAbsolutePath());
89 } else if (!parent.canWrite()) {
90 throw new IOException("Can't write to " + targetFile.getAbsolutePath());
91 }
92 return targetFile;
93 }
94
95 protected OutputStream openOutput(File targetFile) throws IOException {
96 return new FileOutputStream(targetFile);
97 }
98
99 protected void copyAndClose(InputStream in, OutputStream out) throws IOException {
100 try {
101 IOUtils.copy(in, out);
102 } finally {
103 IOUtils.closeQuietly(in);
104 IOUtils.closeQuietly(out);
105 }
106 }
107 }