| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <main role="main"> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span><a id="line.1">package org.apache.archiva.redback.integration.mail;</a> |
| <span class="sourceLineNo">002</span><a id="line.2"></a> |
| <span class="sourceLineNo">003</span><a id="line.3">/*</a> |
| <span class="sourceLineNo">004</span><a id="line.4"> * Licensed to the Apache Software Foundation (ASF) under one</a> |
| <span class="sourceLineNo">005</span><a id="line.5"> * or more contributor license agreements. See the NOTICE file</a> |
| <span class="sourceLineNo">006</span><a id="line.6"> * distributed with this work for additional information</a> |
| <span class="sourceLineNo">007</span><a id="line.7"> * regarding copyright ownership. The ASF licenses this file</a> |
| <span class="sourceLineNo">008</span><a id="line.8"> * to you under the Apache License, Version 2.0 (the</a> |
| <span class="sourceLineNo">009</span><a id="line.9"> * "License"); you may not use this file except in compliance</a> |
| <span class="sourceLineNo">010</span><a id="line.10"> * with the License. You may obtain a copy of the License at</a> |
| <span class="sourceLineNo">011</span><a id="line.11"> *</a> |
| <span class="sourceLineNo">012</span><a id="line.12"> * http://www.apache.org/licenses/LICENSE-2.0</a> |
| <span class="sourceLineNo">013</span><a id="line.13"> *</a> |
| <span class="sourceLineNo">014</span><a id="line.14"> * Unless required by applicable law or agreed to in writing,</a> |
| <span class="sourceLineNo">015</span><a id="line.15"> * software distributed under the License is distributed on an</a> |
| <span class="sourceLineNo">016</span><a id="line.16"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a> |
| <span class="sourceLineNo">017</span><a id="line.17"> * KIND, either express or implied. See the License for the</a> |
| <span class="sourceLineNo">018</span><a id="line.18"> * specific language governing permissions and limitations</a> |
| <span class="sourceLineNo">019</span><a id="line.19"> * under the License.</a> |
| <span class="sourceLineNo">020</span><a id="line.20"> */</a> |
| <span class="sourceLineNo">021</span><a id="line.21"></a> |
| <span class="sourceLineNo">022</span><a id="line.22">import freemarker.template.Configuration;</a> |
| <span class="sourceLineNo">023</span><a id="line.23">import org.apache.archiva.redback.configuration.UserConfiguration;</a> |
| <span class="sourceLineNo">024</span><a id="line.24">import org.apache.archiva.redback.configuration.UserConfigurationKeys;</a> |
| <span class="sourceLineNo">025</span><a id="line.25">import org.apache.archiva.redback.keys.AuthenticationKey;</a> |
| <span class="sourceLineNo">026</span><a id="line.26">import org.slf4j.Logger;</a> |
| <span class="sourceLineNo">027</span><a id="line.27">import org.slf4j.LoggerFactory;</a> |
| <span class="sourceLineNo">028</span><a id="line.28">import org.springframework.stereotype.Service;</a> |
| <span class="sourceLineNo">029</span><a id="line.29">import org.springframework.ui.freemarker.FreeMarkerTemplateUtils;</a> |
| <span class="sourceLineNo">030</span><a id="line.30"></a> |
| <span class="sourceLineNo">031</span><a id="line.31">import javax.inject.Inject;</a> |
| <span class="sourceLineNo">032</span><a id="line.32">import javax.inject.Named;</a> |
| <span class="sourceLineNo">033</span><a id="line.33">import java.text.SimpleDateFormat;</a> |
| <span class="sourceLineNo">034</span><a id="line.34">import java.util.HashMap;</a> |
| <span class="sourceLineNo">035</span><a id="line.35">import java.util.Locale;</a> |
| <span class="sourceLineNo">036</span><a id="line.36">import java.util.Map;</a> |
| <span class="sourceLineNo">037</span><a id="line.37"></a> |
| <span class="sourceLineNo">038</span><a id="line.38">/**</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> * Mail generator that uses freemarker templates.</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> *</a> |
| <span class="sourceLineNo">041</span><a id="line.41"> * This implementation sets the following model values that can be used in templates:</a> |
| <span class="sourceLineNo">042</span><a id="line.42"> * <ul></a> |
| <span class="sourceLineNo">043</span><a id="line.43"> * <li>applicationUrl</li></a> |
| <span class="sourceLineNo">044</span><a id="line.44"> * <li>urlPath</li></a> |
| <span class="sourceLineNo">045</span><a id="line.45"> * <li>authKey</li></a> |
| <span class="sourceLineNo">046</span><a id="line.46"> * <li>accountId</li></a> |
| <span class="sourceLineNo">047</span><a id="line.47"> * <li>requestedOn</li></a> |
| <span class="sourceLineNo">048</span><a id="line.48"> * <li>expiresOn</li></a> |
| <span class="sourceLineNo">049</span><a id="line.49"> * </ul></a> |
| <span class="sourceLineNo">050</span><a id="line.50"> *</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> * The additional template data is added for interpolation, if not <code>null</code>.</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> *</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> * This implementation is location enabled. That means, it will try to find templates in the following order:</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> * <ul></a> |
| <span class="sourceLineNo">055</span><a id="line.55"> * <li><i>templateName</i>_<i>language</i>_<i>country</i>.ftl</li></a> |
| <span class="sourceLineNo">056</span><a id="line.56"> * <li><i>templateName</i>_<i>language</i>.ftl</li></a> |
| <span class="sourceLineNo">057</span><a id="line.57"> * <li><i>templateName</i>.ftl</li></a> |
| <span class="sourceLineNo">058</span><a id="line.58"> * </ul></a> |
| <span class="sourceLineNo">059</span><a id="line.59"> *</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> * The default encoding used for reading the template is UTF-8</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> *</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> * @author Martin Stockhammer <martin_s@apache.org></a> |
| <span class="sourceLineNo">063</span><a id="line.63"> */</a> |
| <span class="sourceLineNo">064</span><a id="line.64">@Service( "mailGenerator#freemarker" )</a> |
| <span class="sourceLineNo">065</span><a id="line.65">public class FreemarkerMailGenerator implements MailGenerator</a> |
| <span class="sourceLineNo">066</span><a id="line.66">{</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> private Logger log = LoggerFactory.getLogger( FreemarkerMailGenerator.class );</a> |
| <span class="sourceLineNo">068</span><a id="line.68"></a> |
| <span class="sourceLineNo">069</span><a id="line.69"> public static final String DEFAULT_ENCODING = "UTF-8";</a> |
| <span class="sourceLineNo">070</span><a id="line.70"></a> |
| <span class="sourceLineNo">071</span><a id="line.71"> @Inject</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> @Named( value = "userConfiguration#default" )</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> private UserConfiguration config;</a> |
| <span class="sourceLineNo">074</span><a id="line.74"></a> |
| <span class="sourceLineNo">075</span><a id="line.75"> @Inject</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> Configuration freemarkerConfiguration;</a> |
| <span class="sourceLineNo">077</span><a id="line.77"></a> |
| <span class="sourceLineNo">078</span><a id="line.78"> private String encoding;</a> |
| <span class="sourceLineNo">079</span><a id="line.79"></a> |
| <span class="sourceLineNo">080</span><a id="line.80"> private String getEncoding( )</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> {</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> if ( this.encoding == null )</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> {</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> this.encoding = config.getString( UserConfigurationKeys.MAIL_TEMPLATE_ENCODING, DEFAULT_ENCODING );</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> }</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> return this.encoding;</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> }</a> |
| <span class="sourceLineNo">088</span><a id="line.88"></a> |
| <span class="sourceLineNo">089</span><a id="line.89"> private Locale getMailLocale() {</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> String localeString = config.getString( UserConfigurationKeys.MAIL_DEFAULT_LOCALE );</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> if (localeString == null || "".equals(localeString)) {</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> return Locale.getDefault( );</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> } else {</a> |
| <span class="sourceLineNo">094</span><a id="line.94"> return Locale.forLanguageTag( localeString );</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> }</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> }</a> |
| <span class="sourceLineNo">097</span><a id="line.97"></a> |
| <span class="sourceLineNo">098</span><a id="line.98"> /**</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> *</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> * @param templateName the template name without extension</a> |
| <span class="sourceLineNo">101</span><a id="line.101"> * @param locale the locale used to find the template file</a> |
| <span class="sourceLineNo">102</span><a id="line.102"> * @param authkey the authentication key</a> |
| <span class="sourceLineNo">103</span><a id="line.103"> * @param baseUrl the base url</a> |
| <span class="sourceLineNo">104</span><a id="line.104"> * @param templateData additional template data, may be <code>null</code></a> |
| <span class="sourceLineNo">105</span><a id="line.105"> * @return the string generated from the template</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> */</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> @Override</a> |
| <span class="sourceLineNo">108</span><a id="line.108"> public String generateMail( String templateName, Locale locale, AuthenticationKey authkey, String baseUrl,</a> |
| <span class="sourceLineNo">109</span><a id="line.109"> Map<String, Object> templateData )</a> |
| <span class="sourceLineNo">110</span><a id="line.110"> {</a> |
| <span class="sourceLineNo">111</span><a id="line.111"> Map<String, Object> context = createModel( authkey, baseUrl, templateData );</a> |
| <span class="sourceLineNo">112</span><a id="line.112"> StringBuffer content = new StringBuffer( );</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> try</a> |
| <span class="sourceLineNo">114</span><a id="line.114"> {</a> |
| <span class="sourceLineNo">115</span><a id="line.115"> content.append( FreeMarkerTemplateUtils.processTemplateIntoString(</a> |
| <span class="sourceLineNo">116</span><a id="line.116"> freemarkerConfiguration.getTemplate( templateName + ".ftl", locale, getEncoding( ) ), context ) );</a> |
| <span class="sourceLineNo">117</span><a id="line.117"> return content.toString( );</a> |
| <span class="sourceLineNo">118</span><a id="line.118"> }</a> |
| <span class="sourceLineNo">119</span><a id="line.119"> catch ( Exception e )</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> {</a> |
| <span class="sourceLineNo">121</span><a id="line.121"> log.error( "Could not parse the mail template {}: {}", templateName, e.getMessage( ), e );</a> |
| <span class="sourceLineNo">122</span><a id="line.122"> }</a> |
| <span class="sourceLineNo">123</span><a id="line.123"> return "";</a> |
| <span class="sourceLineNo">124</span><a id="line.124"> }</a> |
| <span class="sourceLineNo">125</span><a id="line.125"></a> |
| <span class="sourceLineNo">126</span><a id="line.126"> @Override</a> |
| <span class="sourceLineNo">127</span><a id="line.127"> public String generateMail( String templateName, AuthenticationKey authenticationKey, String baseUrl )</a> |
| <span class="sourceLineNo">128</span><a id="line.128"> {</a> |
| <span class="sourceLineNo">129</span><a id="line.129"> return generateMail( templateName, getMailLocale(), authenticationKey, baseUrl );</a> |
| <span class="sourceLineNo">130</span><a id="line.130"> }</a> |
| <span class="sourceLineNo">131</span><a id="line.131"></a> |
| <span class="sourceLineNo">132</span><a id="line.132"> @Override</a> |
| <span class="sourceLineNo">133</span><a id="line.133"> public String generateMail( String templateName, Locale locale, AuthenticationKey authenticationKey, String baseUrl )</a> |
| <span class="sourceLineNo">134</span><a id="line.134"> {</a> |
| <span class="sourceLineNo">135</span><a id="line.135"> return generateMail( templateName, locale, authenticationKey, baseUrl, null );</a> |
| <span class="sourceLineNo">136</span><a id="line.136"> }</a> |
| <span class="sourceLineNo">137</span><a id="line.137"></a> |
| <span class="sourceLineNo">138</span><a id="line.138"> private Map<String, Object> createModel( AuthenticationKey authkey, String appUrl, Map<String, Object> templateData )</a> |
| <span class="sourceLineNo">139</span><a id="line.139"> {</a> |
| <span class="sourceLineNo">140</span><a id="line.140"> Map<String, Object> context = new HashMap<>( );</a> |
| <span class="sourceLineNo">141</span><a id="line.141"> context.put( "applicationUrl", config.getString( UserConfigurationKeys.APPLICATION_URL, appUrl ) );</a> |
| <span class="sourceLineNo">142</span><a id="line.142"></a> |
| <span class="sourceLineNo">143</span><a id="line.143"> String feedback = config.getString( UserConfigurationKeys.EMAIL_FEEDBACK_PATH );</a> |
| <span class="sourceLineNo">144</span><a id="line.144"></a> |
| <span class="sourceLineNo">145</span><a id="line.145"> if ( feedback != null )</a> |
| <span class="sourceLineNo">146</span><a id="line.146"> {</a> |
| <span class="sourceLineNo">147</span><a id="line.147"> if ( feedback.startsWith( "/" ) )</a> |
| <span class="sourceLineNo">148</span><a id="line.148"> {</a> |
| <span class="sourceLineNo">149</span><a id="line.149"> feedback = appUrl + feedback;</a> |
| <span class="sourceLineNo">150</span><a id="line.150"> }</a> |
| <span class="sourceLineNo">151</span><a id="line.151"></a> |
| <span class="sourceLineNo">152</span><a id="line.152"> context.put( "feedback", feedback );</a> |
| <span class="sourceLineNo">153</span><a id="line.153"> }</a> |
| <span class="sourceLineNo">154</span><a id="line.154"></a> |
| <span class="sourceLineNo">155</span><a id="line.155"> context.put( "urlPath",</a> |
| <span class="sourceLineNo">156</span><a id="line.156"> config.getString( UserConfigurationKeys.EMAIL_URL_PATH, "security/login!login.action" ) );</a> |
| <span class="sourceLineNo">157</span><a id="line.157"></a> |
| <span class="sourceLineNo">158</span><a id="line.158"> context.put( "authkey", authkey.getKey( ) );</a> |
| <span class="sourceLineNo">159</span><a id="line.159"></a> |
| <span class="sourceLineNo">160</span><a id="line.160"> context.put( "accountId", authkey.getForPrincipal( ) );</a> |
| <span class="sourceLineNo">161</span><a id="line.161"></a> |
| <span class="sourceLineNo">162</span><a id="line.162"> SimpleDateFormat dateformatter =</a> |
| <span class="sourceLineNo">163</span><a id="line.163"> new SimpleDateFormat( config.getString( UserConfigurationKeys.APPLICATION_TIMESTAMP ), Locale.US );</a> |
| <span class="sourceLineNo">164</span><a id="line.164"></a> |
| <span class="sourceLineNo">165</span><a id="line.165"> context.put( "requestedOn", dateformatter.format( authkey.getDateCreated( ) ) );</a> |
| <span class="sourceLineNo">166</span><a id="line.166"></a> |
| <span class="sourceLineNo">167</span><a id="line.167"> if ( authkey.getDateExpires( ) != null )</a> |
| <span class="sourceLineNo">168</span><a id="line.168"> {</a> |
| <span class="sourceLineNo">169</span><a id="line.169"> context.put( "expiresOn", dateformatter.format( authkey.getDateExpires( ) ) );</a> |
| <span class="sourceLineNo">170</span><a id="line.170"> }</a> |
| <span class="sourceLineNo">171</span><a id="line.171"> else</a> |
| <span class="sourceLineNo">172</span><a id="line.172"> {</a> |
| <span class="sourceLineNo">173</span><a id="line.173"> context.put( "expiresOn", "(does not expire)" );</a> |
| <span class="sourceLineNo">174</span><a id="line.174"> }</a> |
| <span class="sourceLineNo">175</span><a id="line.175"></a> |
| <span class="sourceLineNo">176</span><a id="line.176"> if (templateData!=null)</a> |
| <span class="sourceLineNo">177</span><a id="line.177"> {</a> |
| <span class="sourceLineNo">178</span><a id="line.178"> for ( Map.Entry<String, Object> entry : templateData.entrySet( ) )</a> |
| <span class="sourceLineNo">179</span><a id="line.179"> {</a> |
| <span class="sourceLineNo">180</span><a id="line.180"> context.put( entry.getKey( ), entry.getValue( ) );</a> |
| <span class="sourceLineNo">181</span><a id="line.181"> }</a> |
| <span class="sourceLineNo">182</span><a id="line.182"> }</a> |
| <span class="sourceLineNo">183</span><a id="line.183"></a> |
| <span class="sourceLineNo">184</span><a id="line.184"> return context;</a> |
| <span class="sourceLineNo">185</span><a id="line.185"> }</a> |
| <span class="sourceLineNo">186</span><a id="line.186"></a> |
| <span class="sourceLineNo">187</span><a id="line.187"> public Configuration getFreemarkerConfiguration( )</a> |
| <span class="sourceLineNo">188</span><a id="line.188"> {</a> |
| <span class="sourceLineNo">189</span><a id="line.189"> return freemarkerConfiguration;</a> |
| <span class="sourceLineNo">190</span><a id="line.190"> }</a> |
| <span class="sourceLineNo">191</span><a id="line.191"></a> |
| <span class="sourceLineNo">192</span><a id="line.192"> public void setFreemarkerConfiguration( Configuration freemarkerConfiguration )</a> |
| <span class="sourceLineNo">193</span><a id="line.193"> {</a> |
| <span class="sourceLineNo">194</span><a id="line.194"> this.freemarkerConfiguration = freemarkerConfiguration;</a> |
| <span class="sourceLineNo">195</span><a id="line.195"> }</a> |
| <span class="sourceLineNo">196</span><a id="line.196"></a> |
| <span class="sourceLineNo">197</span><a id="line.197"> public UserConfiguration getConfig( )</a> |
| <span class="sourceLineNo">198</span><a id="line.198"> {</a> |
| <span class="sourceLineNo">199</span><a id="line.199"> return config;</a> |
| <span class="sourceLineNo">200</span><a id="line.200"> }</a> |
| <span class="sourceLineNo">201</span><a id="line.201"></a> |
| <span class="sourceLineNo">202</span><a id="line.202"> public void setConfig( UserConfiguration config )</a> |
| <span class="sourceLineNo">203</span><a id="line.203"> {</a> |
| <span class="sourceLineNo">204</span><a id="line.204"> this.config = config;</a> |
| <span class="sourceLineNo">205</span><a id="line.205"> }</a> |
| <span class="sourceLineNo">206</span><a id="line.206">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
