/*
* Copyright (c) 2002-2012 Alibaba Group Holding Limited.
* All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.alibaba.antx.config.generator;
import java.io.BufferedInputStream;
import java.io.BufferedReader;
import java.io.BufferedWriter;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.io.Reader;
import java.io.StringWriter;
import java.io.Writer;
import java.util.Date;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import com.alibaba.antx.config.ConfigException;
import com.alibaba.antx.config.descriptor.ConfigDescriptor;
import com.alibaba.antx.config.descriptor.ConfigGenerate;
import com.alibaba.antx.config.props.PropertiesSet;
import com.alibaba.antx.util.StreamUtil;
import com.alibaba.antx.util.StringUtil;
import com.alibaba.antx.util.i18n.LocaleInfo;
import org.apache.velocity.app.event.EventCartridge;
import org.apache.velocity.context.AbstractContext;
import org.apache.velocity.context.Context;
/** 代表一组运行时状态。 */
public class ConfigGeneratorSession {
protected final ConfigGenerator generator;
protected final Map props;
private final Map<String, Object[]> descriptorLogs;
private final Set<String> processedDestfiles;
private final Map<String, LazyGenerateItem> lazyGenerateItems;
private ConfigGenerate currentGenerate;
private InputStream currentInputStream;
private OutputStream currentOutputStream;
protected ConfigGeneratorSession(ConfigGenerator generator, PropertiesSet propSet) {
this.generator = generator;
this.props = propSet.getMergedProperties();
this.descriptorLogs = new HashMap<String, Object[]>();
this.processedDestfiles = new HashSet<String>();
this.lazyGenerateItems = new HashMap<String, LazyGenerateItem>();
// 初始化日志，将被写入到和descriptor并列的目录中。
ConfigDescriptor[] descriptors = generator.getConfigDescriptors();
Date now = new Date();
for (ConfigDescriptor descriptor : descriptors) {
String descriptorName = descriptor.getName();
StringWriter logBuffer = new StringWriter();
PrintWriter log = new PrintWriter(logBuffer, true);
descriptorLogs.put(descriptorName, new Object[] { logBuffer, log, descriptor });
// 初始日志内容
log.println("Last Configured at: " + now);
log.println();
log.println("Base URL: " + descriptor.getBaseURL());
log.println("Descriptor: " + descriptorName);
log.println();
}
}
/** 设置当前输入流。 */
public void setInputStream(InputStream istream) {
this.currentInputStream = istream;
}
/** 设置当前输出流。 */
public void setOutputStream(OutputStream ostream) {
this.currentOutputStream = ostream;
}
/** 取得velocity context。 */
public Context getVelocityContext() {
if (currentGenerate == null) {
throw new IllegalStateException("Have not call nextEntry method yet");
}
final Map descriptorProps = new HashMap(currentGenerate.getConfigDescriptor().getContext());
EventCartridge eventCartridge = new EventCartridge();
eventCartridge.addEventHandler(new PropertiesReferenceInsertionHandler(currentGenerate.getConfigDescriptor(),
props));
Context context = new AbstractContext() {
@Override
public Object internalRemove(Object key) {
return descriptorProps.remove(key);
}
@Override
public Object internalPut(String key, Object value) {
return descriptorProps.put(key, value);
}
@Override
public Object[] internalGetKeys() {
Set<Object> keys = new LinkedHashSet<Object>(props.keySet());
keys.addAll(descriptorProps.keySet());
return keys.toArray(new Object[keys.size()]);
}
@Override
public Object internalGet(String key) {
if (descriptorProps.containsKey(key)) {
return descriptorProps.get(key);
} else {
return PropertiesLoader.evaluate(key, props);
}
}
@Override
public boolean internalContainsKey(Object key) {
return descriptorProps.containsKey(key) || props.containsKey(key);
}
};
eventCartridge.attachToContext(context); // 允许使用${a.b.c}
context.put("D", "$"); // 可以用${D}来生成$
return context;
}
/** 将所有template生成相应的文件，并生成日志。 */
public boolean generate(ConfigGeneratorCallback callback) {
boolean allSuccess = true;
for (String template : generator.generateTemplateFiles.keySet()) {
allSuccess &= generate(template, callback);
}
generateLog(callback);
return allSuccess;
}
/** 根据指定的template，生成相应的文件。 */
public boolean generate(String template, ConfigGeneratorCallback callback) {
List<ConfigGenerate> generates = generator.generateTemplateFilesIncludingMetaInfos.get(template);
if (generates == null || generates.isEmpty()) {
throw new ConfigException("No defined template " + template);
}
boolean allSuccess = true;
for (ConfigGenerate generate : generates) {
try {
currentGenerate = generate;
template = callback.nextEntry(template, currentGenerate);
if (currentInputStream == null || currentOutputStream == null) {
throw new IllegalStateException("InputStream/OutputStream has not been set");
}
allSuccess &= generate(template, currentGenerate, currentInputStream, currentOutputStream);
} finally {
try {
callback.closeEntry();
} finally {
currentGenerate = null;
currentInputStream = null;
currentOutputStream = null;
}
}
}
return allSuccess;
}
private boolean generate(String template, ConfigGenerate generate, InputStream istream, OutputStream ostream) {
// 记录处理过的destfiles
processedDestfiles.add(generate.getDestfile());
String charset = generate.getCharset();
String outputCharset = generate.getOutputCharset();
PrintWriter descriptorLog = (PrintWriter) descriptorLogs.get(generate.getConfigDescriptor().getName())[1];
if (StringUtil.isBlank(charset)) {
istream = new BufferedInputStream(istream);
charset = guessCharsetEncoding((BufferedInputStream) istream);
}
if (StringUtil.isBlank(charset)) {
charset = "ISO-8859-1";
}
if (StringUtil.isBlank(outputCharset)) {
outputCharset = charset;
}
Reader reader = null;
Writer writer = null;
try {
reader = new BufferedReader(new InputStreamReader(istream, charset)) {
@Override
public void close() throws IOException {
// 避免关闭
}
};
writer = new BufferedWriter(new OutputStreamWriter(ostream, outputCharset)) {
@Override
public void close() throws IOException {
// 避免关闭
}
};
descriptorLog.println("Generating " + template + " [" + charset + "] => " + generate.getDestfile() + " ["
+ outputCharset + "]");
generator.logger.info("<" + generate.getConfigDescriptor().getBaseURL() + ">\n Generating " + template
+ " [" + charset + "] => " + generate.getDestfile() + " [" + outputCharset + "]\n");
return VelocityTemplateEngine.getInstance().render(getVelocityContext(), reader, writer, template,
generate.getConfigDescriptor().getName(), generate.getConfigDescriptor().getBaseURL());
} catch (Exception e) {
if (e instanceof RuntimeException) {
throw (RuntimeException) e;
} else {
throw new ConfigException(e);
}
} finally {
if (writer != null) {
try {
writer.flush();
} catch (IOException e) {
}
}
}
}
private final static Pattern encodingPattern = Pattern.compile("encoding\\s*=\\s*[\\\"|']([^\\\"|']+)[\\\"|']");
/** 从输入流中猜测charset。 */
private String guessCharsetEncoding(BufferedInputStream istream) {
String str;
try {
byte[] buf = new byte[1024];
int count = 0;
try {
istream.mark(buf.length);
count = istream.read(buf);
} finally {
istream.reset();
}
str = new String(buf, 0, count, "ISO_8859_1");
} catch (Exception e) {
str = "";
}
Matcher m = encodingPattern.matcher(str);
String charset = null;
if (m.find()) {
charset = m.group(1).trim();
}
return charset;
}
public void generateLog(ConfigGeneratorCallback callback) {
for (Object[] logPair : descriptorLogs.values()) {
try {
StringWriter logBuffer = (StringWriter) logPair[0];
PrintWriter log = (PrintWriter) logPair[1];
ConfigDescriptor descriptor = (ConfigDescriptor) logPair[2];
String logfile = generator.getDescriptorLogFile(descriptor);
callback.logEntry(descriptor, logfile);
String logContent = logBuffer.toString();
Writer writer = null;
try {
writer = new BufferedWriter(new OutputStreamWriter(currentOutputStream, LocaleInfo.getDefault()
.getCharset())) {
@Override
public void close() throws IOException {
// 避免关闭
}
};
generator.logger.info("<" + descriptor.getBaseURL() + ">\n Generating log file: " + logfile
+ "\n");
writer.write(logContent);
} catch (IOException e) {
throw new ConfigException(e);
} finally {
if (writer != null) {
try {
writer.flush();
} catch (IOException e) {
}
}
}
} finally {
callback.closeEntry();
currentGenerate = null;
currentInputStream = null;
currentOutputStream = null;
}
}
}
public void addLazyGenerateItem(String name, byte[] bytes) {
lazyGenerateItems.put(name,
new LazyGenerateItem(name, generator.generateTemplateFilesIncludingMetaInfos.get(name), bytes));
}
public boolean generateLazyItems(ConfigGeneratorCallback callback) {
boolean allSuccess = true;
for (LazyGenerateItem item : lazyGenerateItems.values()) {
String name = item.getTemplateName();
for (ConfigGenerate generate : item.getGenerates()) {
String destname = generate.getDestfile();
if (!processedDestfiles.contains(destname)) {
// 将WEB-INF/web.xml复制到META-INF/autoconf/WEB-INF/web.xml
try {
currentGenerate = generate;
callback.nextEntry(generate.getConfigDescriptor(), item.getTemplateContentStream(),
generate.getTemplateBase() + name);
if (currentInputStream == null || currentOutputStream == null) {
throw new IllegalStateException("InputStream/OutputStream has not been set");
}
StreamUtil.io(currentInputStream, currentOutputStream, true, false);
} catch (IOException e) {
throw new RuntimeException(e);
} finally {
try {
callback.closeEntry();
} finally {
currentGenerate = null;
currentInputStream = null;
currentOutputStream = null;
}
}
// 将WEB-INF/web.xml模板生成WEB-INF/web.xml文件
try {
currentGenerate = generate;
callback.nextEntry(generate.getConfigDescriptor(), item.getTemplateContentStream(),
generate.getDestfile());
if (currentInputStream == null || currentOutputStream == null) {
throw new IllegalStateException("InputStream/OutputStream has not been set");
}
allSuccess &= generate(name, generate, currentInputStream, currentOutputStream);
} finally {
try {
callback.closeEntry();
} finally {
currentGenerate = null;
currentInputStream = null;
currentOutputStream = null;
}
}
}
}
}
return allSuccess;
}
/** 查看有没有遗漏没有生成的template。 */
public void checkNonprocessedTemplates() {
for (String destfile : generator.generateDestFiles.keySet()) {
if (!processedDestfiles.contains(destfile)) {
ConfigGenerate generate = generator.generateDestFiles.get(destfile);
String template = generate.getTemplate();
throw new ConfigException("Could not find template file: " + template + " for descriptor: "
+ generate.getConfigDescriptor().getURL());
}
}
}
/** 关闭session，善后工作。 */
public void close() {
}
}