com.alogic.vfs.service.Download Maven / Gradle / Ivy

Go to download
package com.alogic.vfs.service;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;

import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.exception.ExceptionUtils;

import com.alogic.vfs.context.FileSystemSource;
import com.alogic.vfs.core.VirtualFileSystem;
import com.anysoft.util.IOTools;
import com.anysoft.util.Properties;
import com.anysoft.util.PropertiesConstants;
import com.anysoft.util.Settings;
import com.logicbus.backend.Context;
import com.logicbus.backend.Servant;
import com.logicbus.backend.ServantException;
import com.logicbus.backend.message.Message;
import com.logicbus.backend.server.http.HttpCacheTool;
import com.logicbus.models.servant.ServiceDescription;

/**
 * vfs的文件下载
 * @author duanyy
 * @version 1.6.8.6
 * - 客户端可指定下载文件名，如果没有指定，则取路径之中的文件名 

 * 
 * @version 1.6.4.37 [duanyy 20151218] 

 * - 输出文件可缓存 

 * 
 * @version 1.6.11.48 [20180807 duanyy] 

 * - 优化缓存相关的http控制头的输出 

 * 
 * @version 1.6.11.53 [20180817 duanyy] 

 * - 支持前端输入filename和contentType参数，并写出到Response中 

 * 
 * @version 1.6.11.59 [20180911 duanyy] 

 * - 将filename参数改成可选参数;
 */
public class Download extends Servant {
	protected byte [] buffer = null;
	protected boolean cacheEnable = true;	
	protected HttpCacheTool cacheTool = null;
	protected String encoding = "utf-8";
	
	@Override
	public void create(ServiceDescription sd){
		super.create(sd);
		Properties p = sd.getProperties();
		cacheEnable = PropertiesConstants.getBoolean(p, "cacheEnable", true);
		int bufferSize = PropertiesConstants.getInt(p, "bufferSize", 10240,true);
		encoding = PropertiesConstants.getString(p, "http.encoding", encoding);
		buffer = new byte [bufferSize];
		cacheTool = Settings.getToolkit(HttpCacheTool.class);
	}
	
	@Override
	public int actionProcess(Context ctx) {
		ctx.asMessage(FileMessage.class);
		ctx.enableClientCache(cacheEnable);
		
		String path = getArgument("path","/",ctx);
		String fsId = getArgument("domain","default",ctx);
		String filename = getArgument("filename","",ctx);
		String contentType = getArgument("contentType","",ctx);
		
		VirtualFileSystem fs = FileSystemSource.get().get(fsId);
		
		if (fs == null){
			throw new ServantException("clnt.e2007","Can not find a vfs named " +  fsId);
		}

		InputStream in = null;

		try {
			if (cacheEnable){
				cacheTool.cacheEnable(ctx);
			}else{
				cacheTool.cacheDisable(ctx);
			}			
			OutputStream out = ctx.getOutputStream();
			in = fs.readFile(path);
			if (in == null){
				throw new ServantException("core.data_not_found","Can not find the file: " +  path);
			}
			
			if (StringUtils.isNotEmpty(filename)){
				try {
					filename = URLEncoder.encode(filename, encoding);
				} catch (UnsupportedEncodingException e) {
				}
				ctx.setResponseHeader("Content-Disposition", 
					String.format("attachment; filename=%s;filename*=%s''%s",filename,encoding,filename));
			}
			
			if (StringUtils.isNotEmpty(contentType)){
				ctx.setResponseContentType(contentType);
			}			
			
	        int size=0;  
	        while((size=in.read(buffer))!=-1)  
	        {  
	        	out.write(buffer, 0, size);
	        }  
		}catch (IOException ex){
			logger.error(ExceptionUtils.getStackTrace(ex));
			throw new ServantException("core.e1004",ex.getMessage());
		}finally{
			fs.finishRead(path, in);
		}
		
		return 0;
	}
	
	/**
	 * blob文件下载定制Message,不做啥事
	 * 
	 * @author duanyy
	 *
	 */
	public static class FileMessage implements Message {
		@Override
		public void finish(Context ctx, boolean closeStream) {
			if (!"core.ok".equals(ctx.getReturnCode())){
				throw new ServantException(ctx.getReturnCode(),ctx.getReason());
			}
			OutputStream out = null;
			try {
				out = ctx.getOutputStream();
			} catch (IOException e) {
				logger.error("IO Exception",e);
			}finally{
				if (closeStream){
					IOTools.close(out);
				}
			}
		}
		@Override
		public void init(Context ctx) {
			// Nothing to do
		}
		@Override
		public String getContentType() {
			return "unknown";
		}
		@Override
		public long getContentLength() {
			return 0;
		}
	}
}