001: /**
002: * Copyright (c) 2003-2007, David A. Czarnecki
003: * All rights reserved.
004: *
005: * Redistribution and use in source and binary forms, with or without
006: * modification, are permitted provided that the following conditions are met:
007: *
008: * Redistributions of source code must retain the above copyright notice, this list of conditions and the
009: * following disclaimer.
010: * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
011: * following disclaimer in the documentation and/or other materials provided with the distribution.
012: * Neither the name of "David A. Czarnecki" and "blojsom" nor the names of its contributors may be used to
013: * endorse or promote products derived from this software without specific prior written permission.
014: * Products derived from this software may not be called "blojsom", nor may "blojsom" appear in their name,
015: * without prior written permission of David A. Czarnecki.
016: *
017: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
018: * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
019: * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
020: * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
021: * EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
022: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
023: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
024: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
025: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
026: * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
027: * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
028: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
029: * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
030: */package org.blojsom.plugin.notification;
031:
032: import org.apache.commons.mail.Email;
033: import org.apache.log4j.Logger;
034: import org.apache.velocity.VelocityContext;
035: import org.apache.velocity.app.VelocityEngine;
036: import org.springframework.web.context.ServletContextAware;
037:
038: import javax.mail.MessagingException;
039: import javax.servlet.ServletContext;
040: import java.io.InputStreamReader;
041: import java.io.Reader;
042: import java.io.StringWriter;
043: import java.net.URL;
044: import java.util.Iterator;
045: import java.util.Map;
046: import java.util.Properties;
047:
048: public abstract class AbstractVelocityEmailNotification extends
049: AbstractNotification implements ServletContextAware {
050:
051: private VelocityEngine engine;
052:
053: private VelocityContext context;
054:
055: private String velocityPropsPath;
056:
057: private static final Logger logger = Logger
058: .getLogger(AbstractVelocityEmailNotification.class);
059:
060: /**
061: * Construct a new abstract velocity e-mail notification
062: *
063: * @param email E-mail message
064: * @param emailTemplate E-mail template
065: * @throws MessagingException If there is an error constructing the e-mail notification
066: */
067: public AbstractVelocityEmailNotification(Email email,
068: URL emailTemplate) throws MessagingException {
069: super (emailTemplate, "UTF-8", email.getHostName(), "text/html");
070: engine = new VelocityEngine();
071: try {
072: engine.init();
073: } catch (Exception e) {
074: throw new MessagingException(
075: "Could not initialize the templating engine; cannot send the email.",
076: e);
077: }
078: context = new VelocityContext();
079: }
080:
081: /**
082: * Construct a new abstract velocity e-mail notification
083: *
084: * @param emailTemplate E-mail template
085: * @param charEncoding Character encoding
086: * @param mailServer Mail server
087: * @param contentType Content type
088: * @throws Exception If there is an error constructing the e-mail notification
089: */
090: public AbstractVelocityEmailNotification(URL emailTemplate,
091: String charEncoding, String mailServer, String contentType)
092: throws Exception {
093: super (emailTemplate, charEncoding, mailServer, contentType);
094: engine = new VelocityEngine();
095: engine.init();
096: context = new VelocityContext();
097: }
098:
099: /**
100: * Construct a new abstract velocity e-mail notification
101: *
102: * @param emailTemplate E-mail template
103: * @param charEncoding Character encoding
104: * @param mailServer Mail server
105: * @param contentType Content type
106: * @param velocityProps Velocity properties
107: * @throws Exception If there is an error constructing the e-mail notification
108: */
109: public AbstractVelocityEmailNotification(URL emailTemplate,
110: String charEncoding, String mailServer, String contentType,
111: Properties velocityProps) throws Exception {
112: super (emailTemplate, charEncoding, mailServer, contentType);
113: engine = new VelocityEngine();
114: engine.init(velocityProps);
115: context = new VelocityContext();
116: }
117:
118: /**
119: * Construct a new abstract velocity e-mail notification
120: *
121: * @param emailTemplate E-mail template
122: * @param charEncoding Character encoding
123: * @param mailServer Mail server
124: * @param contentType Content type
125: * @param velocityPropsPath Velocity properties path
126: * @throws Exception If there is an error constructing the e-mail notification
127: */
128: public AbstractVelocityEmailNotification(URL emailTemplate,
129: String charEncoding, String mailServer, String contentType,
130: String velocityPropsPath) throws Exception {
131: super (emailTemplate, charEncoding, mailServer, contentType);
132: engine = new VelocityEngine();
133: context = new VelocityContext();
134: this .velocityPropsPath = velocityPropsPath;
135: }
136:
137: /**
138: * Get the e-mail message content evaluated
139: *
140: * @return E-mail message content
141: * @throws Exception If there is an error evaluating the template
142: */
143: protected String getMessage() throws Exception {
144: StringWriter writer = new StringWriter();
145: Reader template = new InputStreamReader(getEmailTemplate()
146: .openStream());
147: try {
148: engine.evaluate(context, writer, "VelocityEmail", template);
149: return writer.toString();
150: } finally {
151: if (template != null) {
152: template.close();
153: }
154: }
155: }
156:
157: /**
158: * Put a name and value in the context
159: *
160: * @param name Name
161: * @param value Value
162: */
163: public void put(String name, Object value) {
164: context.put(name, value);
165: }
166:
167: /**
168: * Put a map of name/value pairs in the context
169: *
170: * @param values Map of name/value pairs
171: */
172: public void putAll(Map values) {
173: java.util.Map.Entry entry;
174: for (Iterator itr = values.entrySet().iterator(); itr.hasNext(); context
175: .put(entry.getKey().toString(), entry.getValue()))
176: entry = (java.util.Map.Entry) itr.next();
177:
178: }
179:
180: /**
181: * Get a value from the context
182: *
183: * @param key Key
184: * @return Value for the given key
185: */
186: public Object get(String key) {
187: return context.get(key);
188: }
189:
190: /**
191: * Set the servlet context
192: *
193: * @param servletContext {@link ServletContext}
194: */
195: public void setServletContext(ServletContext servletContext) {
196: if (velocityPropsPath != null) {
197: Properties velociProps = new Properties();
198: java.io.InputStream is = servletContext
199: .getResourceAsStream(velocityPropsPath);
200: try {
201: if (is == null)
202: throw new IllegalStateException(
203: (new StringBuffer()).append(
204: "The Velocity properties file ")
205: .append(velocityPropsPath).append(
206: " does not exist")
207: .toString());
208: velociProps.load(is);
209: engine.init(velociProps);
210: } catch (Exception e) {
211: IllegalStateException ise = new IllegalStateException(
212: (new StringBuffer()).append(
213: "Unable to initialize Velocity: ")
214: .append(e.getMessage()).toString());
215: ise.initCause(e);
216: throw ise;
217: }
218: }
219: }
220:
221: }
|