/
MultiFilesJob.java
225 lines (201 loc) · 7.25 KB
/
MultiFilesJob.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
/*
* R Service Bus
*
* Copyright (c) Copyright of OpenAnalytics BVBA, 2010-2014
*
* ===========================================================================
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package eu.openanalytics.rsb.message;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.FileWriter;
import java.io.IOException;
import java.io.InputStream;
import java.io.Serializable;
import java.util.GregorianCalendar;
import java.util.HashMap;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Properties;
import java.util.UUID;
import java.util.zip.ZipEntry;
import java.util.zip.ZipInputStream;
import org.apache.commons.io.FileUtils;
import org.apache.commons.io.FilenameUtils;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang3.StringUtils;
import org.springframework.context.MessageSource;
import org.springframework.util.FileCopyUtils;
import org.stringtemplate.v4.ST;
import eu.openanalytics.rsb.Constants;
import eu.openanalytics.rsb.Util;
/**
* Represents a RSB job that consists of multiple files.
*
* @author "OpenAnalytics <rsb.development@openanalytics.eu>"
*/
public class MultiFilesJob extends AbstractJob
{
private static final long serialVersionUID = 1L;
private final File temporaryDirectory;
private File rScriptFile;
public MultiFilesJob(final Source source,
final String applicationName,
final String userName,
final UUID jobId,
final GregorianCalendar submissionTime,
final Map<String, Serializable> meta) throws IOException
{
super(source, applicationName, userName, jobId, submissionTime, meta);
this.temporaryDirectory = Util.createTemporaryDirectory("job");
}
public void addFile(final String name, final InputStream is) throws IOException
{
if (Constants.MULTIPLE_FILES_JOB_CONFIGURATION.equals(name))
{
loadJobConfiguration(is);
}
else
{
addJobFile(name, is);
}
}
private void addJobFile(final String name, final InputStream is)
throws FileNotFoundException, IOException
{
final File jobFile = new File(temporaryDirectory, name);
if (StringUtils.equalsIgnoreCase(FilenameUtils.getExtension(name), Constants.R_SCRIPT_FILE_EXTENSION))
{
if (rScriptFile != null)
{
throw new IllegalArgumentException("Only one R script is allowed per job");
}
rScriptFile = jobFile;
}
final FileOutputStream fos = new FileOutputStream(jobFile);
IOUtils.copy(is, fos);
IOUtils.closeQuietly(fos);
}
private void loadJobConfiguration(final InputStream is) throws IOException
{
final Properties jobConfiguration = new Properties();
jobConfiguration.load(is);
final Map<String, Serializable> mergedMeta = new HashMap<String, Serializable>();
for (final Entry<?, ?> e : jobConfiguration.entrySet())
{
mergedMeta.put(e.getKey().toString(), e.getValue().toString());
}
// give priority to pre-existing metas by overriding the ones from the config
// file
mergedMeta.putAll(getMeta());
getMeta().clear();
getMeta().putAll(mergedMeta);
}
@Override
protected void releaseResources()
{
try
{
FileUtils.forceDelete(temporaryDirectory);
}
catch (final IOException ioe)
{
throw new RuntimeException("Can't release resources of: " + this, ioe);
}
}
public MultiFilesResult buildSuccessResult() throws IOException
{
return new MultiFilesResult(getSource(), getApplicationName(), getUserName(), getJobId(),
getSubmissionTime(), getMeta(), true);
}
@Override
public MultiFilesResult buildErrorResult(final Throwable t, final MessageSource messageSource)
throws IOException
{
final String message = messageSource.getMessage(getErrorMessageId(), null, null);
final ST template = Util.newStringTemplate(message);
template.add("job", this);
template.add("throwable", t);
final MultiFilesResult result = new MultiFilesResult(getSource(), getApplicationName(),
getUserName(), getJobId(), getSubmissionTime(), getMeta(), false);
final File resultFile = result.createNewResultFile(getJobId() + "."
+ Util.getResourceType(Constants.TEXT_MIME_TYPE));
FileCopyUtils.copy(template.render(), new FileWriter(resultFile));
return result;
}
public File getRScriptFile()
{
return rScriptFile;
}
public File[] getFiles()
{
return temporaryDirectory.listFiles();
}
/**
* Add a stream to a job, exploding it if it is a Zip input. Closes the provided
* data stream.
*
* @param contentType
* @param name
* @param data
* @param job
* @throws IOException
*/
public static void addDataToJob(final String contentType,
final String name,
final InputStream data,
final MultiFilesJob job) throws IOException
{
// some browsers send zip file as application/octet-stream, forcing a
// fallback to an
// extension check
if ((Constants.ZIP_CONTENT_TYPES.contains(contentType) || (StringUtils.endsWithIgnoreCase(
FilenameUtils.getExtension(name), Constants.ZIP_MIME_TYPE.getSubType()))))
{
addZipFilesToJob(data, job);
}
else
{
job.addFile(name, data);
}
}
/**
* Adds all the files contained in a Zip archive to a job. Rejects Zips that
* contain sub-directories.
*
* @param data
* @param job
* @throws IOException
*/
public static void addZipFilesToJob(final InputStream data, final MultiFilesJob job) throws IOException
{
final ZipInputStream zis = new ZipInputStream(data);
ZipEntry ze = null;
while ((ze = zis.getNextEntry()) != null)
{
if (ze.isDirectory())
{
job.destroy();
throw new IllegalArgumentException(
"Invalid zip archive: nested directories are not supported");
}
job.addFile(ze.getName(), zis);
zis.closeEntry();
}
IOUtils.closeQuietly(zis);
}
}