View Javadoc

1   //
2   //  ========================================================================
3   //  Copyright (c) 1995-2014 Mort Bay Consulting Pty. Ltd.
4   //  ------------------------------------------------------------------------
5   //  All rights reserved. This program and the accompanying materials
6   //  are made available under the terms of the Eclipse Public License v1.0
7   //  and Apache License v2.0 which accompanies this distribution.
8   //
9   //      The Eclipse Public License is available at
10  //      http://www.eclipse.org/legal/epl-v10.html
11  //
12  //      The Apache License v2.0 is available at
13  //      http://www.opensource.org/licenses/apache2.0.php
14  //
15  //  You may elect to redistribute this code under either of these licenses.
16  //  ========================================================================
17  //
18  
19  package org.eclipse.jetty.server.handler;
20  
21  import java.io.IOException;
22  import java.io.OutputStream;
23  import java.net.MalformedURLException;
24  import java.nio.ByteBuffer;
25  import java.nio.channels.ReadableByteChannel;
26  
27  import javax.servlet.AsyncContext;
28  import javax.servlet.RequestDispatcher;
29  import javax.servlet.ServletException;
30  import javax.servlet.http.HttpServletRequest;
31  import javax.servlet.http.HttpServletResponse;
32  
33  import org.eclipse.jetty.http.HttpFields;
34  import org.eclipse.jetty.http.HttpHeader;
35  import org.eclipse.jetty.http.HttpMethod;
36  import org.eclipse.jetty.http.HttpStatus;
37  import org.eclipse.jetty.http.MimeTypes;
38  import org.eclipse.jetty.io.WriterOutputStream;
39  import org.eclipse.jetty.server.HttpOutput;
40  import org.eclipse.jetty.server.Request;
41  import org.eclipse.jetty.server.Response;
42  import org.eclipse.jetty.server.handler.ContextHandler.Context;
43  import org.eclipse.jetty.util.BufferUtil;
44  import org.eclipse.jetty.util.Callback;
45  import org.eclipse.jetty.util.URIUtil;
46  import org.eclipse.jetty.util.log.Log;
47  import org.eclipse.jetty.util.log.Logger;
48  import org.eclipse.jetty.util.resource.FileResource;
49  import org.eclipse.jetty.util.resource.Resource;
50  
51  
52  /* ------------------------------------------------------------ */
53  /** Resource Handler.
54   *
55   * This handle will serve static content and handle If-Modified-Since headers.
56   * No caching is done.
57   * Requests for resources that do not exist are let pass (Eg no 404's).
58   *
59   *
60   * @org.apache.xbean.XBean
61   */
62  public class ResourceHandler extends HandlerWrapper
63  {
64      private static final Logger LOG = Log.getLogger(ResourceHandler.class);
65  
66      ContextHandler _context;
67      Resource _baseResource;
68      Resource _defaultStylesheet;
69      Resource _stylesheet;
70      String[] _welcomeFiles={"index.html"};
71      MimeTypes _mimeTypes = new MimeTypes();
72      String _cacheControl;
73      boolean _directory;
74      boolean _etags;
75      int _minMemoryMappedContentLength=-1;
76      int _minAsyncContentLength=0;
77  
78      /* ------------------------------------------------------------ */
79      public ResourceHandler()
80      {
81  
82      }
83  
84      /* ------------------------------------------------------------ */
85      public MimeTypes getMimeTypes()
86      {
87          return _mimeTypes;
88      }
89  
90      /* ------------------------------------------------------------ */
91      public void setMimeTypes(MimeTypes mimeTypes)
92      {
93          _mimeTypes = mimeTypes;
94      }
95  
96      /* ------------------------------------------------------------ */
97      /** Get the directory option.
98       * @return true if directories are listed.
99       */
100     public boolean isDirectoriesListed()
101     {
102         return _directory;
103     }
104 
105     /* ------------------------------------------------------------ */
106     /** Set the directory.
107      * @param directory true if directories are listed.
108      */
109     public void setDirectoriesListed(boolean directory)
110     {
111         _directory = directory;
112     }
113 
114     /* ------------------------------------------------------------ */
115     /** Get minimum memory mapped file content length.
116      * @return the minimum size in bytes of a file resource that will
117      * be served using a memory mapped buffer, or -1 (default) for no memory mapped
118      * buffers.
119      */
120     public int getMinMemoryMappedContentLength()
121     {
122         return _minMemoryMappedContentLength;
123     }
124 
125     /* ------------------------------------------------------------ */
126     /** Set minimum memory mapped file content length.
127      * @param minMemoryMappedFileSize the minimum size in bytes of a file resource that will
128      * be served using a memory mapped buffer, or -1 for no memory mapped
129      * buffers.
130      */
131     public void setMinMemoryMappedContentLength(int minMemoryMappedFileSize)
132     {
133         _minMemoryMappedContentLength = minMemoryMappedFileSize;
134     }
135 
136     /* ------------------------------------------------------------ */
137     /** Get the minimum content length for async handling.
138      * @return The minimum size in bytes of the content before asynchronous 
139      * handling is used, or -1 for no async handling or 0 (default) for using
140      * {@link HttpServletResponse#getBufferSize()} as the minimum length.
141      */
142     public int getMinAsyncContentLength()
143     {
144         return _minAsyncContentLength;
145     }
146 
147     /* ------------------------------------------------------------ */
148     /** Set the minimum content length for async handling.
149      * @param minAsyncContentLength The minimum size in bytes of the content before asynchronous 
150      * handling is used, or -1 for no async handling or 0 for using
151      * {@link HttpServletResponse#getBufferSize()} as the minimum length.
152      */
153     public void setMinAsyncContentLength(int minAsyncContentLength)
154     {
155         _minAsyncContentLength = minAsyncContentLength;
156     }
157 
158     /* ------------------------------------------------------------ */
159     /**
160      * @return True if ETag processing is done
161      */
162     public boolean isEtags()
163     {
164         return _etags;
165     }
166 
167     /* ------------------------------------------------------------ */
168     /**
169      * @param etags True if ETag processing is done
170      */
171     public void setEtags(boolean etags)
172     {
173         _etags = etags;
174     }
175 
176     /* ------------------------------------------------------------ */
177     @Override
178     public void doStart()
179     throws Exception
180     {
181         Context scontext = ContextHandler.getCurrentContext();
182         _context = (scontext==null?null:scontext.getContextHandler());
183 
184         super.doStart();
185     }
186 
187     /* ------------------------------------------------------------ */
188     /**
189      * @return Returns the resourceBase.
190      */
191     public Resource getBaseResource()
192     {
193         if (_baseResource==null)
194             return null;
195         return _baseResource;
196     }
197 
198     /* ------------------------------------------------------------ */
199     /**
200      * @return Returns the base resource as a string.
201      */
202     public String getResourceBase()
203     {
204         if (_baseResource==null)
205             return null;
206         return _baseResource.toString();
207     }
208 
209 
210     /* ------------------------------------------------------------ */
211     /**
212      * @param base The resourceBase to set.
213      */
214     public void setBaseResource(Resource base)
215     {
216         _baseResource=base;
217     }
218 
219     /* ------------------------------------------------------------ */
220     /**
221      * @param resourceBase The base resource as a string.
222      */
223     public void setResourceBase(String resourceBase)
224     {
225         try
226         {
227             setBaseResource(Resource.newResource(resourceBase));
228         }
229         catch (Exception e)
230         {
231             LOG.warn(e.toString());
232             LOG.debug(e);
233             throw new IllegalArgumentException(resourceBase);
234         }
235     }
236 
237     /* ------------------------------------------------------------ */
238     /**
239      * @return Returns the stylesheet as a Resource.
240      */
241     public Resource getStylesheet()
242     {
243         if(_stylesheet != null)
244         {
245             return _stylesheet;
246         }
247         else
248         {
249             if(_defaultStylesheet == null)
250             {
251                 _defaultStylesheet =  Resource.newResource(this.getClass().getResource("/jetty-dir.css"));
252             }
253             return _defaultStylesheet;
254         }
255     }
256 
257     /* ------------------------------------------------------------ */
258     /**
259      * @param stylesheet The location of the stylesheet to be used as a String.
260      */
261     public void setStylesheet(String stylesheet)
262     {
263         try
264         {
265             _stylesheet = Resource.newResource(stylesheet);
266             if(!_stylesheet.exists())
267             {
268                 LOG.warn("unable to find custom stylesheet: " + stylesheet);
269                 _stylesheet = null;
270             }
271         }
272         catch(Exception e)
273         {
274             LOG.warn(e.toString());
275             LOG.debug(e);
276             throw new IllegalArgumentException(stylesheet);
277         }
278     }
279 
280     /* ------------------------------------------------------------ */
281     /**
282      * @return the cacheControl header to set on all static content.
283      */
284     public String getCacheControl()
285     {
286         return _cacheControl;
287     }
288 
289     /* ------------------------------------------------------------ */
290     /**
291      * @param cacheControl the cacheControl header to set on all static content.
292      */
293     public void setCacheControl(String cacheControl)
294     {
295         _cacheControl=cacheControl;
296     }
297 
298     /* ------------------------------------------------------------ */
299     /*
300      */
301     public Resource getResource(String path) throws MalformedURLException
302     {
303         if (path==null || !path.startsWith("/"))
304             throw new MalformedURLException(path);
305 
306         Resource base = _baseResource;
307         if (base==null)
308         {
309             if (_context==null)
310                 return null;
311             return _context.getResource(path);
312         }
313 
314         try
315         {
316             path=URIUtil.canonicalPath(path);
317             Resource r = base.addPath(path);
318             if (r!=null && r.getAlias()!=null && !_context.checkAlias(path, r))
319                 return null;
320             return r;
321         }
322         catch(Exception e)
323         {
324             LOG.ignore(e);
325         }
326 
327         return null;
328     }
329 
330     /* ------------------------------------------------------------ */
331     protected Resource getResource(HttpServletRequest request) throws MalformedURLException
332     {
333         String servletPath;
334         String pathInfo;
335         Boolean included = request.getAttribute(RequestDispatcher.INCLUDE_REQUEST_URI) != null;
336         if (included != null && included.booleanValue())
337         {
338             servletPath = (String)request.getAttribute(RequestDispatcher.INCLUDE_SERVLET_PATH);
339             pathInfo = (String)request.getAttribute(RequestDispatcher.INCLUDE_PATH_INFO);
340 
341             if (servletPath == null && pathInfo == null)
342             {
343                 servletPath = request.getServletPath();
344                 pathInfo = request.getPathInfo();
345             }
346         }
347         else
348         {
349             servletPath = request.getServletPath();
350             pathInfo = request.getPathInfo();
351         }
352 
353         String pathInContext=URIUtil.addPaths(servletPath,pathInfo);
354         return getResource(pathInContext);
355     }
356 
357 
358     /* ------------------------------------------------------------ */
359     public String[] getWelcomeFiles()
360     {
361         return _welcomeFiles;
362     }
363 
364     /* ------------------------------------------------------------ */
365     public void setWelcomeFiles(String[] welcomeFiles)
366     {
367         _welcomeFiles=welcomeFiles;
368     }
369 
370     /* ------------------------------------------------------------ */
371     protected Resource getWelcome(Resource directory) throws MalformedURLException, IOException
372     {
373         for (int i=0;i<_welcomeFiles.length;i++)
374         {
375             Resource welcome=directory.addPath(_welcomeFiles[i]);
376             if (welcome.exists() && !welcome.isDirectory())
377                 return welcome;
378         }
379 
380         return null;
381     }
382 
383     /* ------------------------------------------------------------ */
384     /*
385      * @see org.eclipse.jetty.server.Handler#handle(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, int)
386      */
387     @Override
388     public void handle(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException
389     {
390         if (baseRequest.isHandled())
391             return;
392 
393         boolean skipContentBody = false;
394 
395         if(!HttpMethod.GET.is(request.getMethod()))
396         {
397             if(!HttpMethod.HEAD.is(request.getMethod()))
398             {
399                 //try another handler
400                 super.handle(target, baseRequest, request, response);
401                 return;
402             }
403             skipContentBody = true;
404         }
405 
406         Resource resource = getResource(request);
407         // If resource is not found
408         if (resource==null || !resource.exists())
409         {
410             // inject the jetty-dir.css file if it matches
411             if (target.endsWith("/jetty-dir.css"))
412             {
413                 resource = getStylesheet();
414                 if (resource==null)
415                     return;
416                 response.setContentType("text/css");
417             }
418             else
419             {
420                 //no resource - try other handlers
421                 super.handle(target, baseRequest, request, response);
422                 return;
423             }
424         }
425 
426         // We are going to serve something
427         baseRequest.setHandled(true);
428 
429         // handle directories
430         if (resource.isDirectory())
431         {
432             if (!request.getPathInfo().endsWith(URIUtil.SLASH))
433             {
434                 response.sendRedirect(response.encodeRedirectURL(URIUtil.addPaths(request.getRequestURI(),URIUtil.SLASH)));
435                 return;
436             }
437 
438             Resource welcome=getWelcome(resource);
439             if (welcome!=null && welcome.exists())
440                 resource=welcome;
441             else
442             {
443                 doDirectory(request,response,resource);
444                 baseRequest.setHandled(true);
445                 return;
446             }
447         }
448 
449         // Handle ETAGS
450         long last_modified=resource.lastModified();
451         String etag=null;
452         if (_etags)
453         {
454             // simple handling of only a single etag
455             String ifnm = request.getHeader(HttpHeader.IF_NONE_MATCH.asString());
456             etag=resource.getWeakETag();
457             if (ifnm!=null && resource!=null && ifnm.equals(etag))
458             {
459                 response.setStatus(HttpStatus.NOT_MODIFIED_304);
460                 baseRequest.getResponse().getHttpFields().put(HttpHeader.ETAG,etag);
461                 return;
462             }
463         }
464         
465         // Handle if modified since 
466         if (last_modified>0)
467         {
468             long if_modified=request.getDateHeader(HttpHeader.IF_MODIFIED_SINCE.asString());
469             if (if_modified>0 && last_modified/1000<=if_modified/1000)
470             {
471                 response.setStatus(HttpStatus.NOT_MODIFIED_304);
472                 return;
473             }
474         }
475 
476         // set the headers
477         String mime=_mimeTypes.getMimeByExtension(resource.toString());
478         if (mime==null)
479             mime=_mimeTypes.getMimeByExtension(request.getPathInfo());
480         doResponseHeaders(response,resource,mime);
481         if (_etags)
482             baseRequest.getResponse().getHttpFields().put(HttpHeader.ETAG,etag);
483         
484         if(skipContentBody)
485             return;
486         
487         
488         // Send the content
489         OutputStream out =null;
490         try {out = response.getOutputStream();}
491         catch(IllegalStateException e) {out = new WriterOutputStream(response.getWriter());}
492 
493         // Has the output been wrapped
494         if (!(out instanceof HttpOutput))
495             // Write content via wrapped output
496             resource.writeTo(out,0,resource.length());
497         else
498         {
499             // select async by size
500             int min_async_size=_minAsyncContentLength==0?response.getBufferSize():_minAsyncContentLength;
501             
502             if (request.isAsyncSupported() && 
503                 min_async_size>0 &&
504                 resource.length()>=min_async_size)
505             {
506                 final AsyncContext async = request.startAsync();
507                 Callback callback = new Callback()
508                 {
509                     @Override
510                     public void succeeded()
511                     {
512                         async.complete();
513                     }
514 
515                     @Override
516                     public void failed(Throwable x)
517                     {
518                         LOG.warn(x.toString());
519                         LOG.debug(x);
520                         async.complete();
521                     }   
522                 };
523 
524                 // Can we use a memory mapped file?
525                 if (_minMemoryMappedContentLength>0 && 
526                     resource.length()>_minMemoryMappedContentLength &&
527                     resource instanceof FileResource)
528                 {
529                     ByteBuffer buffer = BufferUtil.toMappedBuffer(resource.getFile());
530                     ((HttpOutput)out).sendContent(buffer,callback);
531                 }
532                 else  // Do a blocking write of a channel (if available) or input stream
533                 {
534                     // Close of the channel/inputstream is done by the async sendContent
535                     ReadableByteChannel channel= resource.getReadableByteChannel();
536                     if (channel!=null)
537                         ((HttpOutput)out).sendContent(channel,callback);
538                     else
539                         ((HttpOutput)out).sendContent(resource.getInputStream(),callback);
540                 }
541             }
542             else
543             {
544                 // Can we use a memory mapped file?
545                 if (_minMemoryMappedContentLength>0 && 
546                     resource.length()>_minMemoryMappedContentLength &&
547                     resource instanceof FileResource)
548                 {
549                     ByteBuffer buffer = BufferUtil.toMappedBuffer(resource.getFile());
550                     ((HttpOutput)out).sendContent(buffer);
551                 }
552                 else  // Do a blocking write of a channel (if available) or input stream
553                 {
554                     ReadableByteChannel channel= resource.getReadableByteChannel();
555                     if (channel!=null)
556                         ((HttpOutput)out).sendContent(channel);
557                     else
558                         ((HttpOutput)out).sendContent(resource.getInputStream());
559                 }
560             }
561         }
562     }
563 
564     /* ------------------------------------------------------------ */
565     protected void doDirectory(HttpServletRequest request,HttpServletResponse response, Resource resource)
566         throws IOException
567     {
568         if (_directory)
569         {
570             String listing = resource.getListHTML(request.getRequestURI(),request.getPathInfo().lastIndexOf("/") > 0);
571             response.setContentType("text/html; charset=UTF-8");
572             response.getWriter().println(listing);
573         }
574         else
575             response.sendError(HttpStatus.FORBIDDEN_403);
576     }
577 
578     /* ------------------------------------------------------------ */
579     /** Set the response headers.
580      * This method is called to set the response headers such as content type and content length.
581      * May be extended to add additional headers.
582      * @param response
583      * @param resource
584      * @param mimeType
585      */
586     protected void doResponseHeaders(HttpServletResponse response, Resource resource, String mimeType)
587     {
588         if (mimeType!=null)
589             response.setContentType(mimeType);
590 
591         long length=resource.length();
592 
593         if (response instanceof Response)
594         {
595             HttpFields fields = ((Response)response).getHttpFields();
596 
597             if (length>0)
598                 ((Response)response).setLongContentLength(length);
599 
600             if (_cacheControl!=null)
601                 fields.put(HttpHeader.CACHE_CONTROL,_cacheControl);
602         }
603         else
604         {
605             if (length>Integer.MAX_VALUE)
606                 response.setHeader(HttpHeader.CONTENT_LENGTH.asString(),Long.toString(length));
607             else if (length>0)
608                 response.setContentLength((int)length);
609 
610             if (_cacheControl!=null)
611                 response.setHeader(HttpHeader.CACHE_CONTROL.asString(),_cacheControl);
612         }
613     }
614 }