1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    *
5    *
6    *
7    * The contents of this file are subject to the terms of the Liferay Enterprise
8    * Subscription License ("License"). You may not use this file except in
9    * compliance with the License. You can obtain a copy of the License by
10   * contacting Liferay, Inc. See the License for the specific language governing
11   * permissions and limitations under the License, including but not limited to
12   * distribution rights 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  public class ServletVelocityResourceListener extends VelocityResourceListener {
44  
45      public InputStream getResourceStream(String source)
46          throws ResourceNotFoundException {
47  
48          InputStream is = null;
49  
50          int pos = source.indexOf(SERVLET_SEPARATOR);
51  
52          if (pos != -1) {
53              String servletContextName = source.substring(0, pos);
54  
55              if (Validator.isNull(servletContextName)) {
56                  servletContextName = PortalUtil.getPathContext();
57              }
58  
59              ServletContext servletContext = VelocityContextPool.get(
60                  servletContextName);
61  
62              if (servletContext != null) {
63                  String name =
64                      source.substring(pos + SERVLET_SEPARATOR.length());
65  
66                  if (_log.isDebugEnabled()) {
67                      _log.debug(
68                          name + " is associated with the servlet context " +
69                              servletContextName + " " + servletContext);
70                  }
71  
72                  is = servletContext.getResourceAsStream(name);
73  
74                  if ((is == null) && (name.endsWith("/init_custom.vm"))) {
75                      if (_log.isWarnEnabled()) {
76                          _log.warn(
77                              "The template " + name + " should be created");
78                      }
79  
80                      is = new ByteArrayInputStream(new byte[0]);
81                  }
82              }
83              else {
84                  _log.error(
85                      source + " is not valid because " + servletContextName +
86                          " does not map to a servlet context");
87              }
88          }
89  
90          return is;
91      }
92  
93      private static Log _log =
94          LogFactoryUtil.getLog(ServletVelocityResourceListener.class);
95  
96  }