VfsHotfolder.java

package de.uni_goettingen.sub.commons.ocr.abbyy.server.hotfolder;

/*

 © 2010, SUB Göttingen. All rights reserved.
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Affero General Public License as
 published by the Free Software Foundation, either version 3 of the
 License, or (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 GNU Affero General Public License for more details.

 You should have received a copy of the GNU Affero General Public License
 along with this program. If not, see <http://www.gnu.org/licenses/>.

 */

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.Serializable;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.ArrayList;
import java.util.List;

import org.apache.commons.io.IOUtils;
import org.apache.commons.vfs2.FileObject;
import org.apache.commons.vfs2.FileSystemException;
import org.apache.commons.vfs2.FileSystemManager;
import org.apache.commons.vfs2.FileType;
import org.apache.commons.vfs2.Selectors;
import org.apache.commons.vfs2.VFS;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;


/**
 * The Class ApacheVFSHotfolderImpl is used to control the hotfolders used by
 * the Abbyy Recognition Server.
 */
public final class VfsHotfolder extends ServerHotfolder implements Hotfolder, Serializable {
	private static final long serialVersionUID = 2628453844788155875L;

	// The Constant logger.
	final static Logger logger = LoggerFactory.getLogger(VfsHotfolder.class);


	private final String ticketTmpStore = "tmp://";
	
	// The fsmanager.
	transient protected FileSystemManager fsManager = null;

	// State variables
	// The total file count.
	protected static Long totalFileCount = 0l;

	// The total file size.
	protected static Long totalFileSize = 0l;
	
	private String serverUrl = null;

	/**
	 * Instantiates a new apacheVFSHotfolderImpl.
	 * 
	 * @throws FileSystemException
	 *             the file system exception
	 */
	public VfsHotfolder() {
		try {
			//VFS.setUriStyle(true);
			fsManager = VFS.getManager();
		} catch (FileSystemException e) {
			logger.error("Can't get file system manager", e);
			throw new IllegalStateException(e);
		}
	}

	VfsHotfolder(String serverUrl, String username, String password) {
		this();
		configureConnection(serverUrl, username, password);
	}

	/* (non-Javadoc)
	 * @see de.uni_goettingen.sub.commons.ocr.abbyy.server.Hotfolder#copyFile(java.net.URI, java.net.URI)
	 */
//	@Override
//	public void copyFile (URI from, URI to) throws IOException {
//		FileObject src = fsManager.resolveFile(from.toString());
//		FileObject dest = fsManager.resolveFile(to.toString());
//		if (dest.exists()) {
//			//TODO: There is an error in here.
//			throw new IOException("Remote file already exists!");
//		}
//		//localFile.copyFrom(remoteFile, new AllFileSelector());
//		dest.copyFrom(src, Selectors.SELECT_ALL);
//	}
	
	@Override
	public void upload(URI fromLocal, URI toRemote) throws IOException {
		
	}
	
	@Override
	public void download(URI fromRemote, URI toLocal) throws IOException {
		
	}


	/* (non-Javadoc)
	 * @see de.uni_goettingen.sub.commons.ocr.abbyy.server.Hotfolder#delete(java.net.URI)
	 */
	@Override
	public void delete (URI uri) throws FileSystemException {
		fsManager.resolveFile(uri.toString()).delete();
	}

	/* (non-Javadoc)
	 * @see de.uni_goettingen.sub.commons.ocr.abbyy.server.Hotfolder#exists(java.net.URI)
	 */
	@Override
	public boolean exists (URI uri) throws FileSystemException {
		FileObject fo = fsManager.resolveFile(uri.toString());
		return fo.exists();
	}

	private List<URI> listURIs (URI uri) throws IOException {
		List<URI> uriList = new ArrayList<URI>();
		if (isDirectory(uri)) {
			FileObject directory = fsManager.resolveFile(uri.toString());
			FileObject[] children = directory.getChildren();
			for (int i = 0; i < children.length; i++) {
				try {
					String path = children[i].getName().toString();
					if (path.startsWith("file")) {
						// file paths can have spaces, toURI() takes care of them
						uriList.add(new File(path).toURI());
					} else {
						uriList.add(new URI(path));
					}
				} catch (URISyntaxException e) {
					logger.error("Error while coverting URI.");
					throw new RuntimeException(e);
				}
			}
		}
		return uriList;
	}

	private Boolean isDirectory(URI uri) throws IOException {
		if (fsManager.resolveFile(uri.toString()).getType() == FileType.FOLDER) {
			return true;
		}
		return false;
	}

	private OutputStream getOutputStream (URI uri) throws FileSystemException {
		FileObject out = fsManager.resolveFile(uri.toString());
		return out.getContent().getOutputStream();
	}

	/* (non-Javadoc)
	 * @see de.uni_goettingen.sub.commons.ocr.abbyy.server.Hotfolder#createTmpFile(java.lang.String)
	 */
	@Override
	public OutputStream createTmpFile (String name) throws FileSystemException {
		String tmpTicket = ticketTmpStore + name;
		try {
			return getOutputStream(new URI(tmpTicket));
		} catch (URISyntaxException e) {
			logger.error("Error while coverting URI.");
			throw new RuntimeException(e);
		}
	}

	/* (non-Javadoc)
	 * @see de.uni_goettingen.sub.commons.ocr.abbyy.server.Hotfolder#copyTmpFile(java.lang.String, java.net.URI)
	 */
	@Override
	public void copyTmpFile (String tmpFile, URI to) throws IOException {
		if (!fsManager.resolveFile(ticketTmpStore + tmpFile).exists()) {
			logger.error(ticketTmpStore + tmpFile + "doesn't exist!");
		}
//		try {
//			copyFile(new URI(ticketTmpStore + tmpFile), to);
//		} catch (URISyntaxException e) {
//			logger.error("Couldn't create URI for temporary file", e);
//			return false;
//		}
	}

	
	public void configureConnection(String newServerUrl, String newUsername, String newPassword) {
		//Construct the login part.
		if (newUsername != null && newPassword != null && newServerUrl.startsWith("https")) {
			serverUrl = newServerUrl.replace("https://", "webdav://" + newUsername + ":" + newPassword + "@");
		} else if (newUsername != null && newPassword != null && newServerUrl.startsWith("http")) {
			serverUrl = newServerUrl.replace("http://", "webdav://" + newUsername + ":" + newPassword + "@");
		}
	}

	@Override
	public byte[] getResponse(URI uri) throws IOException {
		FileObject uriFile = fsManager.resolveFile(uri.toString());
		return IOUtils.toByteArray(uriFile.getContent().getInputStream());
	}

	@Override
	public long getUsedSpace(URI uri) throws IOException {
		if (!isDirectory(uri)) {
			return getFileSize(uri);
		}
		Long size = 0l;
		for (URI u : listURIs(uri)) {
			if (isDirectory(uri)) {
				size += getUsedSpace(u);
			} else {
				size += getFileSize(uri);
			}
		}
		return size;
	}

	private Long getFileSize (URI uri) throws IOException {
		FileObject uriFile = fsManager.resolveFile(uri.toString());
		if (uriFile.getType() != FileType.FOLDER) {
			return uriFile.getContent().getSize();
		}
		return 0l;
	}
	
}