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
|
/**
* \cond LICENSE
* Arara -- the cool TeX automation tool
* Copyright (c) 2012, Paulo Roberto Massa Cereda
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* 3. Neither the name of the project's author nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
* WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
* \endcond
*
* AraraConfiguration: This class holds the model for the arara configuration
* file.
*/
// package definition
package com.github.arara.model;
// needed imports
import com.github.arara.exception.AraraException;
import com.github.arara.utils.AraraUtils;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import org.apache.commons.lang3.SystemUtils;
import org.mvel2.templates.TemplateRuntime;
/**
* Holds the model for the arara configuration file.
*
* @author Paulo Roberto Massa Cereda
* @version 3.0a
* @since 3.0
*/
public class AraraConfiguration {
// the application language
private String language;
// the list of search paths
private List<String> paths;
// the list of filetypes
private List<AraraFilePattern> filetypes;
// the path runtime exception
private RuntimeException pathRuntimeException;
// the path IO exception
private IOException pathIOException;
/**
* Getter for the search paths.
*
* @return The search paths.
*/
public List<String> getPaths() {
return paths;
}
/**
* Getter for the language.
*
* @return The language.
*/
public String getLanguage() {
return language;
}
/**
* Setter for the language.
*
* @param language The language.
*/
public void setLanguage(String language) {
this.language = language;
}
/**
* Setter for the search paths.
*
* @param rules The search paths.
*/
public void setPaths(List<String> rules) throws AraraException, Exception {
this.paths = rules;
// refresh paths
refreshPaths();
}
/**
* Getter for the filetypes.
*
* @return The filetypes.
*/
public List<AraraFilePattern> getFiletypes() {
return filetypes;
}
/**
* Setter for the filetypes.
*
* @param filetypes The filetypes.
*/
public void setFiletypes(List<AraraFilePattern> filetypes) {
this.filetypes = filetypes;
}
/**
* Constructor.
*/
public AraraConfiguration() {
// creates both lists
paths = new ArrayList<String>();
filetypes = new ArrayList<AraraFilePattern>();
pathRuntimeException = null;
}
/**
* Refreshes all paths, replacing possible variables in the template
*/
private void refreshPaths() throws AraraException, Exception {
// create a map
HashMap map = new HashMap();
// add the variables
map.put("userhome", SystemUtils.USER_HOME);
// for every path in the list
for (int i = 0; i < paths.size(); i++) {
try {
// remove the keyword
String fullPath = AraraUtils.removeKeyword(paths.get(i));
// apply the template
fullPath = (String) TemplateRuntime.eval(fullPath, map);
try {
// attempt to create a file reference and
// get the canonical path, if the operation
// succeeds, it's a valid path
File validFile = new File(fullPath);
validFile.getCanonicalPath();
// sanitize the path in order to be displayed correctly
fullPath = new File(new File(fullPath).toURI()).getPath();
// set the path in the list
paths.set(i, fullPath);
} catch (IOException ioException) {
// the path is terribly invalid, get the exception,
// if null
if (pathIOException == null) {
// set the path IO exception
pathIOException = ioException;
}
}
} catch (RuntimeException runtimeException) {
// an error has occurred, register the exception for
// later access
// if there isn't an exception yet
if (pathRuntimeException == null) {
// set the exception
pathRuntimeException = runtimeException;
}
}
}
}
/**
* Getter for the path runtime exception.
*
* @return The path runtime exception.
*/
public RuntimeException getPathRuntimeException() {
return pathRuntimeException;
}
/**
* Getter for the path IO exception.
*
* @return The path IO exception.
*/
public IOException getPathIOException() {
return pathIOException;
}
}
|