1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19 package org.eclipse.jetty.util.resource;
20
21 import java.io.Closeable;
22 import java.io.File;
23 import java.io.FileOutputStream;
24 import java.io.IOException;
25 import java.io.InputStream;
26 import java.io.OutputStream;
27 import java.net.MalformedURLException;
28 import java.net.URI;
29 import java.net.URL;
30 import java.nio.channels.ReadableByteChannel;
31 import java.text.DateFormat;
32 import java.util.ArrayList;
33 import java.util.Arrays;
34 import java.util.Collection;
35 import java.util.Date;
36
37 import org.eclipse.jetty.util.B64Code;
38 import org.eclipse.jetty.util.IO;
39 import org.eclipse.jetty.util.Loader;
40 import org.eclipse.jetty.util.StringUtil;
41 import org.eclipse.jetty.util.URIUtil;
42 import org.eclipse.jetty.util.UrlEncoded;
43 import org.eclipse.jetty.util.log.Log;
44 import org.eclipse.jetty.util.log.Logger;
45
46
47
48
49
50
51
52
53
54
55 public abstract class Resource implements ResourceFactory, Closeable
56 {
57 private static final Logger LOG = Log.getLogger(Resource.class);
58 public static boolean __defaultUseCaches = true;
59 volatile Object _associate;
60
61
62
63
64
65
66
67 public static void setDefaultUseCaches (boolean useCaches)
68 {
69 __defaultUseCaches=useCaches;
70 }
71
72
73 public static boolean getDefaultUseCaches ()
74 {
75 return __defaultUseCaches;
76 }
77
78
79
80
81
82
83
84 public static Resource newResource(URI uri)
85 throws MalformedURLException
86 {
87 return newResource(uri.toURL());
88 }
89
90
91
92
93
94
95 public static Resource newResource(URL url)
96 {
97 return newResource(url, __defaultUseCaches);
98 }
99
100
101
102
103
104
105
106
107 static Resource newResource(URL url, boolean useCaches)
108 {
109 if (url==null)
110 return null;
111
112 String url_string=url.toExternalForm();
113 if( url_string.startsWith( "file:"))
114 {
115 try
116 {
117 return new PathResource(url);
118 }
119 catch(Exception e)
120 {
121 LOG.warn(e.toString());
122 LOG.debug(Log.EXCEPTION,e);
123 return new BadResource(url,e.toString());
124 }
125 }
126 else if( url_string.startsWith( "jar:file:"))
127 {
128 return new JarFileResource(url, useCaches);
129 }
130 else if( url_string.startsWith( "jar:"))
131 {
132 return new JarResource(url, useCaches);
133 }
134
135 return new URLResource(url,null,useCaches);
136 }
137
138
139
140
141
142
143
144
145
146 public static Resource newResource(String resource)
147 throws MalformedURLException
148 {
149 return newResource(resource, __defaultUseCaches);
150 }
151
152
153
154
155
156
157
158
159 public static Resource newResource(String resource, boolean useCaches)
160 throws MalformedURLException
161 {
162 URL url=null;
163 try
164 {
165
166 url = new URL(resource);
167 }
168 catch(MalformedURLException e)
169 {
170 if(!resource.startsWith("ftp:") &&
171 !resource.startsWith("file:") &&
172 !resource.startsWith("jar:"))
173 {
174 try
175 {
176
177 if (resource.startsWith("./"))
178 resource=resource.substring(2);
179
180 File file=new File(resource).getCanonicalFile();
181 return new PathResource(file.toPath());
182 }
183 catch(Exception e2)
184 {
185 LOG.debug(Log.EXCEPTION,e2);
186 throw e;
187 }
188 }
189 else
190 {
191 LOG.warn("Bad Resource: "+resource);
192 throw e;
193 }
194 }
195
196 return newResource(url, useCaches);
197 }
198
199
200 public static Resource newResource(File file)
201 {
202 return new PathResource(file.toPath());
203 }
204
205
206
207
208
209
210
211
212
213 public static Resource newSystemResource(String resource)
214 throws IOException
215 {
216 URL url=null;
217
218 ClassLoader loader=Thread.currentThread().getContextClassLoader();
219 if (loader!=null)
220 {
221 try
222 {
223 url = loader.getResource(resource);
224 if (url == null && resource.startsWith("/"))
225 url = loader.getResource(resource.substring(1));
226 }
227 catch (IllegalArgumentException e)
228 {
229
230
231
232 url = null;
233 }
234 }
235 if (url==null)
236 {
237 loader=Resource.class.getClassLoader();
238 if (loader!=null)
239 {
240 url=loader.getResource(resource);
241 if (url==null && resource.startsWith("/"))
242 url=loader.getResource(resource.substring(1));
243 }
244 }
245
246 if (url==null)
247 {
248 url=ClassLoader.getSystemResource(resource);
249 if (url==null && resource.startsWith("/"))
250 url=ClassLoader.getSystemResource(resource.substring(1));
251 }
252
253 if (url==null)
254 return null;
255
256 return newResource(url);
257 }
258
259
260
261
262
263
264 public static Resource newClassPathResource(String resource)
265 {
266 return newClassPathResource(resource,true,false);
267 }
268
269
270
271
272
273
274
275
276
277
278
279
280
281 public static Resource newClassPathResource(String name,boolean useCaches,boolean checkParents)
282 {
283 URL url=Resource.class.getResource(name);
284
285 if (url==null)
286 url=Loader.getResource(Resource.class,name);
287 if (url==null)
288 return null;
289 return newResource(url,useCaches);
290 }
291
292
293 public static boolean isContainedIn (Resource r, Resource containingResource) throws MalformedURLException
294 {
295 return r.isContainedIn(containingResource);
296 }
297
298
299 @Override
300 protected void finalize()
301 {
302 close();
303 }
304
305
306 public abstract boolean isContainedIn (Resource r) throws MalformedURLException;
307
308
309
310
311
312
313 public final void release()
314 {
315 close();
316 }
317
318
319
320
321 @Override
322 public abstract void close();
323
324
325
326
327
328 public abstract boolean exists();
329
330
331
332
333
334
335
336
337 public abstract boolean isDirectory();
338
339
340
341
342
343
344
345 public abstract long lastModified();
346
347
348
349
350
351
352
353
354 public abstract long length();
355
356
357
358
359
360
361
362
363
364 @Deprecated
365 public abstract URL getURL();
366
367
368
369
370
371
372
373 public URI getURI()
374 {
375 try
376 {
377 return getURL().toURI();
378 }
379 catch(Exception e)
380 {
381 throw new RuntimeException(e);
382 }
383 }
384
385
386
387
388
389
390
391
392
393
394 public abstract File getFile()
395 throws IOException;
396
397
398
399
400
401
402
403
404 public abstract String getName();
405
406
407
408
409
410
411
412
413
414 public abstract InputStream getInputStream()
415 throws IOException;
416
417
418
419
420
421
422
423
424 public abstract ReadableByteChannel getReadableByteChannel()
425 throws IOException;
426
427
428
429
430
431
432
433
434 public abstract boolean delete()
435 throws SecurityException;
436
437
438
439
440
441
442
443
444 public abstract boolean renameTo(Resource dest)
445 throws SecurityException;
446
447
448
449
450
451
452
453
454 public abstract String[] list();
455
456
457
458
459
460
461
462
463
464
465 public abstract Resource addPath(String path)
466 throws IOException,MalformedURLException;
467
468
469
470
471
472
473
474
475 @Override
476 public Resource getResource(String path)
477 {
478 try
479 {
480 return addPath(path);
481 }
482 catch(Exception e)
483 {
484 LOG.debug(e);
485 return null;
486 }
487 }
488
489
490
491
492
493
494
495 @Deprecated
496 public String encode(String uri)
497 {
498 return null;
499 }
500
501
502
503 @SuppressWarnings("javadoc")
504 public Object getAssociate()
505 {
506 return _associate;
507 }
508
509
510
511 @SuppressWarnings("javadoc")
512 public void setAssociate(Object o)
513 {
514 _associate=o;
515 }
516
517
518
519
520
521 public boolean isAlias()
522 {
523 return getAlias()!=null;
524 }
525
526
527
528
529
530 public URI getAlias()
531 {
532 return null;
533 }
534
535
536
537
538
539
540
541
542 public String getListHTML(String base,boolean parent)
543 throws IOException
544 {
545 base=URIUtil.canonicalPath(base);
546 if (base==null || !isDirectory())
547 return null;
548
549 String[] ls = list();
550 if (ls==null)
551 return null;
552 Arrays.sort(ls);
553
554 String decodedBase = URIUtil.decodePath(base);
555 String title = "Directory: "+deTag(decodedBase);
556
557 StringBuilder buf=new StringBuilder(4096);
558 buf.append("<HTML><HEAD>");
559 buf.append("<LINK HREF=\"").append("jetty-dir.css").append("\" REL=\"stylesheet\" TYPE=\"text/css\"/><TITLE>");
560 buf.append(title);
561 buf.append("</TITLE></HEAD><BODY>\n<H1>");
562 buf.append(title);
563 buf.append("</H1>\n<TABLE BORDER=0>\n");
564
565 if (parent)
566 {
567 buf.append("<TR><TD><A HREF=\"");
568 buf.append(URIUtil.addPaths(base,"../"));
569 buf.append("\">Parent Directory</A></TD><TD></TD><TD></TD></TR>\n");
570 }
571
572 String encodedBase = hrefEncodeURI(base);
573
574 DateFormat dfmt=DateFormat.getDateTimeInstance(DateFormat.MEDIUM,
575 DateFormat.MEDIUM);
576 for (int i=0 ; i< ls.length ; i++)
577 {
578 Resource item = addPath(ls[i]);
579
580 buf.append("\n<TR><TD><A HREF=\"");
581 String path=URIUtil.addPaths(encodedBase,URIUtil.encodePath(ls[i]));
582
583 buf.append(path);
584
585 if (item.isDirectory() && !path.endsWith("/"))
586 buf.append(URIUtil.SLASH);
587
588
589 buf.append("\">");
590 buf.append(deTag(ls[i]));
591 buf.append(" ");
592 buf.append("</A></TD><TD ALIGN=right>");
593 buf.append(item.length());
594 buf.append(" bytes </TD><TD>");
595 buf.append(dfmt.format(new Date(item.lastModified())));
596 buf.append("</TD></TR>");
597 }
598 buf.append("</TABLE>\n");
599 buf.append("</BODY></HTML>\n");
600
601 return buf.toString();
602 }
603
604
605
606
607
608
609
610
611
612
613
614 private static String hrefEncodeURI(String raw)
615 {
616 StringBuffer buf = null;
617
618 loop:
619 for (int i=0;i<raw.length();i++)
620 {
621 char c=raw.charAt(i);
622 switch(c)
623 {
624 case '\'':
625 case '"':
626 case '<':
627 case '>':
628 buf=new StringBuffer(raw.length()<<1);
629 break loop;
630 }
631 }
632 if (buf==null)
633 return raw;
634
635 for (int i=0;i<raw.length();i++)
636 {
637 char c=raw.charAt(i);
638 switch(c)
639 {
640 case '"':
641 buf.append("%22");
642 continue;
643 case '\'':
644 buf.append("%27");
645 continue;
646 case '<':
647 buf.append("%3C");
648 continue;
649 case '>':
650 buf.append("%3E");
651 continue;
652 default:
653 buf.append(c);
654 continue;
655 }
656 }
657
658 return buf.toString();
659 }
660
661 private static String deTag(String raw)
662 {
663 return StringUtil.sanitizeXmlString(raw);
664 }
665
666
667
668
669
670
671
672
673 public void writeTo(OutputStream out,long start,long count)
674 throws IOException
675 {
676 try (InputStream in = getInputStream())
677 {
678 in.skip(start);
679 if (count<0)
680 IO.copy(in,out);
681 else
682 IO.copy(in,out,count);
683 }
684 }
685
686
687
688
689
690
691
692
693
694
695 public void copyTo(File destination)
696 throws IOException
697 {
698 if (destination.exists())
699 throw new IllegalArgumentException(destination + " exists");
700
701 try (OutputStream out = new FileOutputStream(destination))
702 {
703 writeTo(out,0,-1);
704 }
705 }
706
707
708
709
710
711
712
713 public String getWeakETag()
714 {
715 return getWeakETag("");
716 }
717
718 public String getWeakETag(String suffix)
719 {
720 try
721 {
722 StringBuilder b = new StringBuilder(32);
723 b.append("W/\"");
724
725 String name=getName();
726 int length=name.length();
727 long lhash=0;
728 for (int i=0; i<length;i++)
729 lhash=31*lhash+name.charAt(i);
730
731 B64Code.encode(lastModified()^lhash,b);
732 B64Code.encode(length()^lhash,b);
733 b.append(suffix);
734 b.append('"');
735 return b.toString();
736 }
737 catch (IOException e)
738 {
739 throw new RuntimeException(e);
740 }
741 }
742
743
744 public Collection<Resource> getAllResources()
745 {
746 try
747 {
748 ArrayList<Resource> deep=new ArrayList<>();
749 {
750 String[] list=list();
751 if (list!=null)
752 {
753 for (String i:list)
754 {
755 Resource r=addPath(i);
756 if (r.isDirectory())
757 deep.addAll(r.getAllResources());
758 else
759 deep.add(r);
760 }
761 }
762 }
763 return deep;
764 }
765 catch(Exception e)
766 {
767 throw new IllegalStateException(e);
768 }
769 }
770
771
772
773
774
775
776
777 public static URL toURL(File file) throws MalformedURLException
778 {
779 return file.toURI().toURL();
780 }
781 }