1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.velocity;
24  
25  import com.liferay.portal.kernel.log.Log;
26  import com.liferay.portal.kernel.log.LogFactoryUtil;
27  import com.liferay.portal.kernel.util.Validator;
28  import com.liferay.portal.util.PortalUtil;
29  
30  import java.io.ByteArrayInputStream;
31  import java.io.InputStream;
32  
33  import javax.servlet.ServletContext;
34  
35  import org.apache.velocity.exception.ResourceNotFoundException;
36  
37  /**
38   * <a href="ServletVelocityResourceListener.java.html"><b><i>View Source</i></b>
39   * </a>
40   *
41   * @author Alexander Chow
42   *
43   */
44  public class ServletVelocityResourceListener extends VelocityResourceListener {
45  
46      public InputStream getResourceStream(String source)
47          throws ResourceNotFoundException {
48  
49          InputStream is = null;
50  
51          int pos = source.indexOf(SERVLET_SEPARATOR);
52  
53          if (pos != -1) {
54              String servletContextName = source.substring(0, pos);
55  
56              if (Validator.isNull(servletContextName)) {
57                  servletContextName = PortalUtil.getPathContext();
58              }
59  
60              ServletContext servletContext = VelocityContextPool.get(
61                  servletContextName);
62  
63              if (servletContext != null) {
64                  String name =
65                      source.substring(pos + SERVLET_SEPARATOR.length());
66  
67                  if (_log.isDebugEnabled()) {
68                      _log.debug(
69                          name + " is associated with the servlet context " +
70                              servletContextName + " " + servletContext);
71                  }
72  
73                  is = servletContext.getResourceAsStream(name);
74  
75                  if ((is == null) && (name.endsWith("/init_custom.vm"))) {
76                      if (_log.isWarnEnabled()) {
77                          _log.warn(
78                              "The template " + name + " should be created");
79                      }
80  
81                      is = new ByteArrayInputStream(new byte[0]);
82                  }
83              }
84              else {
85                  _log.error(
86                      source + " is not valid because " + servletContextName +
87                          " does not map to a servlet context");
88              }
89          }
90  
91          return is;
92      }
93  
94      private static Log _log =
95          LogFactoryUtil.getLog(ServletVelocityResourceListener.class);
96  
97  }