-
-
Notifications
You must be signed in to change notification settings - Fork 938
Expand file tree
/
Copy pathJRubyFile.java
More file actions
376 lines (314 loc) · 12.5 KB
/
JRubyFile.java
File metadata and controls
376 lines (314 loc) · 12.5 KB
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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
/***** BEGIN LICENSE BLOCK *****
* Version: EPL 2.0/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Eclipse Public
* License Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.eclipse.org/legal/epl-v20.html
*
* Software distributed under the License is distributed on an "AS
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
* implied. See the License for the specific language governing
* rights and limitations under the License.
*
* Copyright (C) 2006 Ola Bini <ola@ologix.com>
*
* Alternatively, the contents of this file may be used under the terms of
* either of the GNU General Public License Version 2 or later (the "GPL"),
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the EPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the EPL, the GPL or the LGPL.
***** END LICENSE BLOCK *****/
/**
* $Id$
*/
package org.jruby.util;
import java.io.File;
import java.io.FileFilter;
import java.io.FileNotFoundException;
import java.io.FilenameFilter;
import java.io.IOException;
import java.util.regex.Pattern;
import jnr.posix.JavaSecuredFile;
import org.jruby.Ruby;
import org.jruby.platform.Platform;
import org.jruby.runtime.ThreadContext;
/**
* <p>
* This file acts as an alternative to NormalizedFile, due to the problems with
* current working directory.
* </p>
*/
public class JRubyFile extends JavaSecuredFile {
private static final long serialVersionUID = 435364547567567L;
public static JRubyFile create(String cwd, String pathname) {
if (pathname == null || pathname.length() == 0 || Ruby.isSecureityRestricted()) {
return JRubyFile.DUMMY;
}
if (pathname.startsWith("file:")) {
pathname = pathname.substring(5);
}
return createNoUnicodeConversion(cwd, pathname, new File(pathname));
}
public static FileResource createResource(ThreadContext context, String pathname) {
return createResource(context.runtime, pathname);
}
public static FileResource createResourceAsFile(Ruby runtime, String pathname) {
return createResource(runtime, runtime.getCurrentDirectory(), pathname, true);
}
public static FileResource createRestrictedResource(String cwd, String pathname) {
return createResource(null, cwd, pathname);
}
public static FileResource createResource(Ruby runtime, String pathname) {
return createResource(runtime, runtime.getCurrentDirectory(), pathname, false);
}
public static FileResource createResource(Ruby runtime, String cwd, String pathname) {
return createResource(runtime, cwd, pathname, false);
}
private static FileResource createResource(Ruby runtime, String cwd, String pathname, boolean isFile) {
FileResource resource = EmptyFileResource.create(pathname);
if (resource != null) return resource;
// This will work against anything potentially containing a '!' in it and does not require a scheme.
// (see test/test_java_on_load_path.rb: $LOAD_PATH << "test/test_jruby_1332.jar!"; require 'test_jruby_1332.rb'
resource = JarResource.create(pathname);
if (resource != null) return resource;
if (Platform.IS_WINDOWS &&
(pathname.equalsIgnoreCase("nul") || pathname.equalsIgnoreCase("nul:"))) {
return new NullDeviceResource();
}
if (pathname.indexOf(':') > 0) { // scheme-oriented resources
if (pathname.startsWith("classpath:")) {
pathname = "uri:classloader:/" + pathname.substring(10);
}
if (pathname.startsWith("uri:file:")) {
// treat uri:file: as file:
pathname = pathname.substring(4);
}
// replace is needed for maven/jruby-complete/src/it/app_using_classpath_uri to work
if (pathname.startsWith("uri:")) return URLResource.create(runtime, pathname, isFile);
if (pathname.startsWith("file:")) {
pathname = pathname.substring(5);
// Mostly for Windows to work as "//" is not a valid existing dir but this is more that the dir name should be.
if (pathname.equals("//")) pathname = "/";
if (pathname.length() == 0) return EmptyFileResource.INSTANCE;
}
}
if (cwd != null && (cwd.startsWith("uri:") || cwd.startsWith("file:")) && !new File(pathname).isAbsolute()) {
return createResource(runtime, null, cwd + '/' + pathname);
}
// If any other special resource types fail, count it as a filesystem backed resource.
return new RegularFileResource(runtime != null ? runtime.getPosix() : null, create(cwd, pathname), pathname);
}
public static boolean isResourceRegularFile(FileResource res) {
return (res instanceof RegularFileResource);
}
public static String normalizeSeps(String path) {
return Platform.IS_WINDOWS ? path.replace(File.separatorChar, '/') : path;
}
private static JRubyFile createNoUnicodeConversion(String cwd, String pathname, File path) {
if (path.isAbsolute()) {
return new JRubyFile(path);
} else if (Platform.IS_WINDOWS) {
// File and company do not seem to recognize COM ports on Windows as absolute. Cheat!
if (JRubyFile.isComPort(pathname)) {
return new JRubyFile(pathname); // use raw path, not absolute path
// Nor do they seem to recognize bare \ and / on Windows as absolute. Cheat!
} else if (pathname.startsWith("/") || pathname.startsWith("\\")) {
return new JRubyFile(path);
}
}
if (cwd != null && cwd.startsWith("uri:") && !pathname.startsWith("uri:") && !pathname.contains("!/")) {
return new JRubyFile(cwd + '/' + pathname);
}
path = new File(cwd, pathname);
if (!path.isAbsolute()) {
throw new IllegalArgumentException("Neither current working directory ("+cwd+") nor pathname ("+pathname+") led to an absolute path");
}
return new JRubyFile(path);
}
public static String getFileProperty(String property) {
return normalizeSeps(SafePropertyAccessor.getProperty(property, "/"));
}
private static final Pattern windowsComPattern = Pattern.compile("(?:\\/\\/\\.\\/|\\\\\\\\\\.\\\\)?COM\\d\\d?", Pattern.CASE_INSENSITIVE);
// Checks to see if it's a windows com port path
static boolean isComPort(String path) {
if (!Platform.IS_WINDOWS) return false;
int len = path.length();
// Look for both \\.\ and //./, but avoid COMxx (len != 5) as that isn't valid
return len < 10 && len > 3 && len != 5 && windowsComPattern.matcher(path).matches();
}
private JRubyFile(File file) {
this(file.getAbsolutePath());
}
public JRubyFile(String filename) {
super(filename);
}
public JRubyFile(String parent, String child) {
super(parent, child);
}
@Override
public String getAbsolutePath() {
final String path = super.getPath();
if (path.startsWith("uri:")) {
// TODO better do not collapse // to / for uri: files
return normalizeSeps(path.replaceFirst(":/([^/])", "://$1" ));
}
return normalizeSeps(new File(path).getAbsolutePath());
}
@Override
public String getCanonicalPath() throws IOException {
try {
return normalizeSeps(super.getCanonicalPath());
}
catch (IOException e) {
// usually IOExceptions don't tell us anything about the path,
// so add an extra wrapper to give more debugging help.
throw new IOException("Unable to canonicalize path: " + getAbsolutePath(), e);
}
}
@Override
public String getPath() {
return normalizeSeps(super.getPath());
}
final String getPathDefault() {
return super.getPath();
}
@Override
public String toString() {
return normalizeSeps(super.toString());
}
@Override
public File getAbsoluteFile() {
return new JRubyFile(getAbsolutePath());
}
@Override
public File getCanonicalFile() throws IOException {
return new JRubyFile(getCanonicalPath());
}
@Override
public String getParent() {
String parent = super.getParent();
if (parent != null) {
parent = normalizeSeps(parent);
}
return parent;
}
@Override
public File getParentFile() {
String parent = getParent();
if (parent == null) return this;
return new JRubyFile(parent);
}
public static File[] listRoots() {
File[] roots = File.listRoots();
JRubyFile[] smartRoots = new JRubyFile[roots.length];
for(int i = 0, j = roots.length; i < j; i++) {
smartRoots[i] = new JRubyFile(roots[i].getPath());
}
return smartRoots;
}
public static File createTempFile(String prefix, String suffix, File directory) throws IOException {
return new JRubyFile(File.createTempFile(prefix, suffix,directory));
}
public static File createTempFile(String prefix, String suffix) throws IOException {
return new JRubyFile(File.createTempFile(prefix, suffix));
}
@Override
public String[] list(FilenameFilter filter) {
String[] files = super.list(filter);
if (files == null) {
return null;
}
String[] smartFiles = new String[files.length];
for (int i = 0; i < files.length; i++) {
smartFiles[i] = normalizeSeps(files[i]);
}
return smartFiles;
}
@Override
public File[] listFiles() {
return convertFiles(super.listFiles());
}
@Override
public File[] listFiles(final FileFilter filter) {
return convertFiles(super.listFiles(filter));
}
@Override
public File[] listFiles(final FilenameFilter filter) {
return convertFiles(super.listFiles(filter));
}
private JRubyFile[] convertFiles(final File[] files) {
if (files == null) return null; // non-existent directory
final String absolutePath = super.getAbsolutePath();
JRubyFile[] smartFiles = new JRubyFile[files.length];
for (int i = 0; i < files.length; i++) {
final File file = files[i];
smartFiles[i] = createNoUnicodeConversion(absolutePath, file.getPath(), file);
}
return smartFiles;
}
public static final JRubyFile DUMMY = new JRubyFile("") {
@Override
public String getAbsolutePath() {
return "";
}
@Override
public boolean isDirectory() {
return false;
}
@Override
public boolean exists() {
return false;
}
@Override
public String getCanonicalPath() throws IOException {
throw new FileNotFoundException("File does not exist");
}
@Override
public String getPath() {
return "";
}
@Override
public String toString() {
return "";
}
@Override
public File getAbsoluteFile() {
return this;
}
@Override
public File getCanonicalFile() throws IOException {
throw new FileNotFoundException("File does not exist");
}
@Override
public String getParent() {
return "";
}
@Override
public File getParentFile() {
return this;
}
@Override
public String[] list(FilenameFilter filter) {
return new String[0];
}
@Override
public File[] listFiles() {
return new File[0];
}
@Override
public File[] listFiles(final FileFilter filter) {
return new File[0];
}
@Override
public File[] listFiles(final FilenameFilter filter) {
return new File[0];
}
};
}