1. callback
2. tranfer rate control
3. max user statement
4. max thread statement.
5. Recursive directory scan
6. Multi folder support
7. Error handling
8. Logging
9. support partial download
10. Free source
And all this functionality in 2 classes, 1 interface and 1 property file
Main class is FileServer
package ru.freecode.servlet;
import org.apache.commons.beanutils.ConstructorUtils;
import org.apache.commons.io.FileUtils;
import org.apache.log4j.Logger;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.*;
import java.net.URLDecoder;
import java.text.MessageFormat;
import java.util.*;
/**
* Date: 07.05.2008
* Time: 18:47:52
*/
public class FileServer extends HttpServlet {
transient private Logger log = Logger.getLogger(FileServer.class.getName());
private final static int LOG_ERROR = 0;
private final static int LOG_WARN = 1;
private final static int LOG_DEBUG = 2;
private final static int LOG_INFO = 3;
private static ArrayList users = new ArrayList();
/**
* shared context for files
*/
private static HashMap files;
public FileServer() {
}
protected void doHead(HttpServletRequest request, HttpServletResponse response) throws IOException {
doGet(request, response);
}
@Override
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException {
try {
// reserve for future request.getLocale(); =)
String requestPath = URLDecoder.decode(request.getPathInfo(), "UTF-8");
String remouteAddress = request.getRemoteAddr();
String method = request.getMethod();
String sessionId = request.getSession().getId();
Callback callback = null;
log(LOG_INFO, "{2} request: {0} from : {1} sessionId: {3} params: {4}", requestPath, remouteAddress, method, sessionId, request.getParameterMap());
Properties appProp = loadProperties();
log(LOG_DEBUG, "File Server props: {0}", appProp);
if (appProp.containsKey("callback")) {
try {
callback = (Callback) ConstructorUtils.invokeConstructor(Class.forName(appProp.getProperty("callback")), null);
callback.setProperties(appProp);
} catch (Exception e) {
log(LOG_ERROR, "Callback class not created: {0}", appProp.getProperty("callback"), e);
throw new RuntimeException(e);
}
}
String filename = requestPath.substring(requestPath.lastIndexOf('/') + 1);
FileServerUser user = null;
try {
File file = getFile(appProp, filename);
long start = 0;
long end = 0;
Enumeration enu = request.getHeaderNames();
while (enu.hasMoreElements()) {
String obj = (String) enu.nextElement();
if (obj.equalsIgnoreCase("range")) {
response.setStatus(HttpServletResponse.SC_PARTIAL_CONTENT);
String rangeData = request.getHeader(obj);
rangeData = rangeData.substring(rangeData.indexOf('=') + 1).trim();
String positions[] = rangeData.split("-");
try {
start = Long.parseLong(positions[0].trim());
if (positions.length > 1 && positions[1].length() > 0) {
end = Long.parseLong(positions[1].trim());
}
} catch (Exception e) {
log(LOG_ERROR, "Range Error. range: {0} ",request.getHeader(obj), e);
}
log(LOG_DEBUG, "Partial request. start pos: {0}, end pos {1}", start, end);
}
}
user = new FileServerUser();
user.setSessionId(sessionId);
user.setFile(file.getName());
if (callback!=null) {
callback.requestIncoming(user,remouteAddress,sessionId,requestPath);
}
attachUser(user, appProp);
if (sendContent(file, response, start, end, appProp)&&callback!=null) {
callback.downloadDone(user,remouteAddress,sessionId,requestPath);
}
//todo invoke callback
} catch (FileNotFoundException e) {
log(LOG_ERROR, "File not found: {0} ", filename, e);
if (callback!=null ) {
callback.fileNotFound(user,appProp.getProperty("files.dir"),filename);
}
} catch (InterruptedException e) {
log(LOG_ERROR, "Thread Error", e);
if (callback!=null ) {
callback.errorHandle(user,e);
}
response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR,e.getMessage());
} catch (IOException e) {
log(LOG_ERROR, "IOException", e);
if (callback!=null ) {
callback.errorHandle(user,e);
}
response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR,e.getMessage());
} catch (MaxThreadException e) {
log(LOG_ERROR, "MaxThreadException", e);
if (callback!=null ) {
callback.errorHandle(user,e);
}
response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR,"you rich max thread count. Maximum value: "+appProp.getProperty("max.threads"));
} catch (CanDownloadException e) {
log(LOG_ERROR, "CanDownloadException", e);
if (callback!=null ) {
callback.errorHandle(user,e);
}
response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR,"Download not accept: "+e.getMessage());
} catch (MaxClientException e) {
log(LOG_ERROR, "MaxClientException", e);
if (callback!=null ) {
callback.errorHandle(user,e);
}
response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR,"max client count riched");
} finally {
deattachUser(user);
}
} catch (Exception e) {
log(LOG_ERROR, "General Exception", e);
response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR,"Please contact to site administrator");
}
}
private void deattachUser(FileServerUser user) {
if (user == null) {
return;
}
FileServerUser forRemove = null;
for (int i = 0; i < users.size(); i++) {
FileServerUser sUser = (FileServerUser) users.get(i);
//if user has id search by user id
if (user.getId() != null) {
if (sUser.getId().equals(user.getId())) {
sUser.decrementThreads();
if (sUser.getThreadsCount() == 0) {
users.remove(sUser);
}
return;
}
} else {
// else search by sessionid
if (sUser.getSessionId().equals(user.getSessionId())) {
sUser.decrementThreads();
if (sUser.getThreadsCount() == 0) {
users.remove(sUser);
}
return;
}
}
}
}
private void attachUser(FileServerUser user, Properties appProps) throws MaxThreadException, MaxClientException {
int maxThreads = Integer.parseInt(appProps.getProperty("max.threads", "0"));
int maxUsers = Integer.parseInt(appProps.getProperty("max.users", "0"));
for (int i = 0; i < users.size(); i++) {
FileServerUser sUser = (FileServerUser) users.get(i);
//if user has id search by user id
if (user.getId() != null) {
if (sUser.getId().equals(user.getId())) {
if (sUser.getThreadsCount() == maxThreads && maxThreads > 0) {
throw new MaxThreadException();
} else {
sUser.incrementThreads();
}
return;
}
} else {
// else search by sessionid
if (sUser.getSessionId().equals(user.getSessionId())) {
if (sUser.getThreadsCount() == maxThreads && maxThreads > 0) {
throw new MaxThreadException();
} else {
sUser.incrementThreads();
}
}
return;
}
}
if (users.size() == maxUsers && maxUsers > 0) {
throw new MaxClientException();
}
user.setThreadsCount(1);
users.add(user);
}
private boolean sendContent(File file, HttpServletResponse response, long start, long end, Properties appProps) throws IOException, InterruptedException {
int buffersize = 1024 * 16;
int sleep = 0;
boolean result = false;
if (appProps.containsKey("max.speed")) {
int speed = Integer.parseInt(appProps.getProperty("max.speed"));
sleep = (int) (((float) buffersize / speed) * 1000);
}
response.setContentType("application/octet-stream");
response.addHeader("Accept-Ranges", "bytes");
response.addHeader("Content-Disposition", "attachment; filename=" + file.getName());
if (end > 0) {
response.addHeader("Content-Range", "bytes " + start + "-" + end + "/" + (end + 1));
}
long size = file.length();
if (start > 0 && end > 0) {
size = end - start;
}
if (start > 0 && end == 0) {
size = file.length() - start;
}
response.addHeader("Content-Length", "" + size);
BufferedInputStream bis = new BufferedInputStream(new FileInputStream(file));
if (start > 0) {
bis.skip(start);
}
BufferedOutputStream bos = new BufferedOutputStream(response.getOutputStream());
byte buffer[] = new byte[buffersize];
int read = bis.read(buffer);
long dataSend = 0;
while (read > 0) {
if (end > 0 && start + dataSend + read > end) {
bos.write(buffer, 0, (int) (end - start - dataSend));
bos.flush();
break;
} else {
bos.write(buffer, 0, read);
bos.flush();
}
dataSend = dataSend + read;
read = bis.read(buffer);
if (read<=0) {
result = true;
} else {
// setup speed
if (sleep > 0) {
Thread.sleep(sleep);
}
}
}
bos.close();
bis.close();
return result;
}
private Properties loadProperties() throws IOException {
Properties props = new Properties();
props.load(this.getClass().getResourceAsStream("/fileserver.properties"));
return props;
}
protected void doPost(HttpServletRequest request, HttpServletResponse response) {
}
protected void doPut(HttpServletRequest request, HttpServletResponse response) {
}
protected void doDelete(HttpServletRequest request, HttpServletResponse response) {
}
private void log(int logtype, String message, Object... obj) {
StringBuffer sb = new StringBuffer();
MessageFormat format = new MessageFormat(message);
sb.append(format.format(message, obj));
switch (logtype) {
case LOG_DEBUG:
log.debug(sb);
break;
case LOG_ERROR:
log.debug(sb, (Throwable) obj[obj.length-1]);
break;
case LOG_INFO:
log.info(sb);
break;
case LOG_WARN:
log.warn(sb);
break;
}
}
public File getFile(Properties appProp, String filename) throws FileNotFoundException {
if (files == null || !files.containsKey(filename)) {
if (files == null) {
files = new HashMap();
} else {
files.clear();
}
String paths = appProp.getProperty("files.dir");
String[] path = paths.split(";");
for (int i = 0; i < path.length; i++) {
String ph = path[i].split(",")[0];
Collection coll = FileUtils.listFiles(new File(ph), null, true);
Iterator fileIterator = coll.iterator();
while (fileIterator.hasNext()) {
File o = (File) fileIterator.next();
files.put(o.getName(), o);
}
}
}
if (!files.containsKey(filename)) {
throw new FileNotFoundException("FILE NOT FOUND: " + filename);
}
return (File) files.get(filename);
}
}
Callback API defined in interface:
package ru.freecode.servlet;
import java.util.Properties;
/**
* Date: 07.05.2008
* Time: 18:59:43
*/
public interface Callback {
/**
* set properties for callback, it can be db props, url and etc
* @param props
*/
public void setProperties(Properties props);
/**
* this function invoked after request incoming
* @param user - user
* @param remouteAddress - user remoute address
* @param sessionId - http sessionId
* @param requestPath - full path in request except server name
* @throws CanDownloadException thrown if user can't download file
*/
public void requestIncoming(FileServerUser user, String remouteAddress, String sessionId, String requestPath) throws CanDownloadException;
/**
* function invoked after download complete
* @param user
* @param remouteAddress
* @param sessionId
* @param requestPath
*/
public void downloadDone(FileServerUser user, String remouteAddress, String sessionId, String requestPath);
/**
* function invoked if file not found
* @param user
* @param property
* @param filename
*/
public void fileNotFound(FileServerUser user, String property, String filename);
/**
* handle error
* @param user
* @param e
*/
public void errorHandle(FileServerUser user, Exception e);
}
also we need User for restrict:
package ru.freecode.servlet;
import java.util.Date;
public class FileServerUser {
private String id;
private int threadsCount;
private String sessionId;
private String file;
private Date access = new Date();
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
public int getThreadsCount() {
return threadsCount;
}
public void setThreadsCount(int threadsCount) {
this.threadsCount = threadsCount;
}
public String getSessionId() {
return sessionId;
}
public void setSessionId(String sessionId) {
this.sessionId = sessionId;
}
public String getFile() {
return file;
}
public void setFile(String file) {
this.file = file;
}
public String toString() {
return id + " " + sessionId + " count: " + threadsCount + " " + file;
}
public void incrementThreads() {
threadsCount++;
}
public void decrementThreads() {
threadsCount--;
}
public Date getAccess() {
return access;
}
}
and some useful Exceptions:
package ru.freecode.servlet;
/**
* Date: 08.05.2008
* Time: 2:16:25
*/
public class CanDownloadException extends Exception{
public CanDownloadException(String s) {
super(s);
}
}
package ru.freecode.servlet;
/**
* Date: 08.05.2008
* Time: 1:23:27
*/
public class MaxClientException extends Exception {
}
package ru.freecode.servlet;
/**
* Date: 08.05.2008
* Time: 1:23:48
*/
public class MaxThreadException extends Exception{
}
thats it.
Only what you needed for start its web configure and file server configure.
in web xml:
<servlet>>
<servlet-name>File Servler Servlet</servlet-name>
<servlet-class>ru.freecode.servlet.FileServer</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>File Servler Servlet</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>
file server properties
files.dir=/movies/m1;/movies/m2;/home/m3;/home/m4;
callback.server=http://dev.maryno.net/video/command
callback.user=someuser
callback.password=somepassword
callback=ru.freecode.video.VideoServerCallback
#threads count on client
max.threads=5
#speed in byte/s on 1 thread
max.speed=448576
#max.speed=2048576
# users not threads
max.users=20
parameter "files.dir" setup files directories. You can point on many directories separate they wich ";" character
parameters where name started callback it's properties for implementation callback class. This parameters depends on you logic.
"callback" write here you class what implement callback interface. If this parameter blank then server will be work as simple http file server.
"max.threads" parameter point on how many connections can do one user. If user id can't be set in callback or any where else users will be checking by session id.
parameter "max.speed" setup maximum download spead for one threads in byte per second.
and last "max.users" say file server how many users can be accepted in one time. So if you setup 5 threads and 5 users, you server will serve 25 threads maximum.
dependeces:
commons-beanutils-1.7.0.jar
commons-codec-1.3.jar
commons-collections-3.1.jar
commons-digester.jar
commons-io-1.3.2.jar
commons-lang-2.2.jar
commons-logging-1.1.jar
log4j-1.2.13.jar
Комментариев нет:
Отправить комментарий