filebot/source/net/sourceforge/filebot/web/OpenSubtitlesSubtitleDescriptor.java

package net.sourceforge.filebot.web;


import java.io.IOException;
import java.io.InputStream;
import java.io.Serializable;
import java.net.URL;
import java.nio.ByteBuffer;
import java.util.EnumMap;
import java.util.Map;
import java.util.Map.Entry;
import java.util.zip.GZIPInputStream;
import java.util.zip.ZipException;

import net.sourceforge.tuned.ByteBufferOutputStream;
import net.sourceforge.tuned.FileUtilities;


/**
 * Describes a subtitle on OpenSubtitles.
 * 
 * @see OpenSubtitlesXmlRpc
 */
public class OpenSubtitlesSubtitleDescriptor implements SubtitleDescriptor, Serializable {
	
	public static enum Property {
		IDSubtitle,
		IDSubtitleFile,
		IDSubMovieFile,
		IDMovie,
		IDMovieImdb,
		SubFileName,
		SubFormat,
		SubHash,
		SubSize,
		MovieHash,
		MovieByteSize,
		MovieName,
		MovieNameEng,
		MovieYear,
		MovieReleaseName,
		MovieTimeMS,
		MovieImdbRating,
		SubLanguageID,
		ISO639,
		LanguageName,
		UserID,
		UserNickName,
		SubAddDate,
		SubAuthorComment,
		SubComments,
		SubDownloadsCnt,
		SubRating,
		SubBad,
		SubActualCD,
		SubSumCD,
		MatchedBy,
		SubtitlesLink,
		SubDownloadLink,
		ZipDownloadLink;
		
		public static <V> EnumMap<Property, V> asEnumMap(Map<String, V> stringMap) {
			EnumMap<Property, V> enumMap = new EnumMap<Property, V>(Property.class);
			
			// copy entry set to enum map
			for (Entry<String, V> entry : stringMap.entrySet()) {
				try {
					enumMap.put(Property.valueOf(entry.getKey()), entry.getValue());
				} catch (IllegalArgumentException e) {
					// illegal enum constant, just ignore
				}
			}
			
			return enumMap;
		}
	}
	
	private final Map<Property, String> properties;
	
	
	public OpenSubtitlesSubtitleDescriptor(Map<Property, String> properties) {
		this.properties = properties;
	}
	
	
	public String getProperty(Property key) {
		return properties.get(key);
	}
	
	
	@Override
	public String getPath() {
		return getProperty(Property.SubFileName);
	}
	
	
	@Override
	public String getName() {
		return FileUtilities.getNameWithoutExtension(getProperty(Property.SubFileName));
	}
	
	
	@Override
	public String getLanguageName() {
		return getProperty(Property.LanguageName);
	}
	
	
	@Override
	public String getType() {
		return getProperty(Property.SubFormat);
	}
	
	
	@Override
	public long getLength() {
		return Long.parseLong(getProperty(Property.SubSize));
	}
	
	
	public String getMovieHash() {
		return getProperty(Property.MovieHash);
	}
	
	
	public long getMovieByteSize() {
		return Long.parseLong(getProperty(Property.MovieByteSize));
	}
	
	
	@Override
	public ByteBuffer fetch() throws Exception {
		URL resource = new URL(getProperty(Property.SubDownloadLink));
		InputStream stream = resource.openStream();
		
		try {
			ByteBufferOutputStream buffer = new ByteBufferOutputStream(getLength());
			
			// extract gzipped subtitle on-the-fly
			try {
				stream = new GZIPInputStream(stream);
			} catch (ZipException e) {
				throw new IOException(String.format("%s: anti-leech limit may have been reached", e.getMessage()));
			}
			
			// fully download
			buffer.transferFully(stream);
			
			return buffer.getByteBuffer();
		} finally {
			stream.close();
		}
	}
	
	
	@Override
	public int hashCode() {
		return getProperty(Property.IDSubtitle).hashCode();
	}
	
	
	@Override
	public boolean equals(Object object) {
		if (object instanceof OpenSubtitlesSubtitleDescriptor) {
			OpenSubtitlesSubtitleDescriptor other = (OpenSubtitlesSubtitleDescriptor) object;
			return getProperty(Property.IDSubtitle).equals(other.getProperty(Property.IDSubtitle));
		}
		
		return false;
	}
	
	
	@Override
	public String toString() {
		return String.format("%s [%s]", getName(), getLanguageName());
	}
	
}