From f5f910336b84550cca7bd6b75fd619f13dd75a06 Mon Sep 17 00:00:00 2001 From: Reinhard Pointner Date: Mon, 25 Jul 2016 21:05:49 +0800 Subject: [PATCH] Keep old TheTVDBClient API v1 code working and maintained (in case we decide not to use v2 for the final release just yet) --- source/net/filebot/web/TheTVDBClientV1.java | 350 ++++++++++++++++++ test/net/filebot/web/TheTVDBClientV1Test.java | 144 +++++++ 2 files changed, 494 insertions(+) create mode 100644 source/net/filebot/web/TheTVDBClientV1.java create mode 100644 test/net/filebot/web/TheTVDBClientV1Test.java diff --git a/source/net/filebot/web/TheTVDBClientV1.java b/source/net/filebot/web/TheTVDBClientV1.java new file mode 100644 index 00000000..ca3b94d0 --- /dev/null +++ b/source/net/filebot/web/TheTVDBClientV1.java @@ -0,0 +1,350 @@ +package net.filebot.web; + +import static java.util.stream.Collectors.*; +import static net.filebot.Logging.*; +import static net.filebot.util.RegularExpressions.*; +import static net.filebot.util.StringUtilities.*; +import static net.filebot.util.XPathUtilities.*; +import static net.filebot.web.EpisodeUtilities.*; +import static net.filebot.web.WebRequest.*; + +import java.net.URI; +import java.net.URL; +import java.util.ArrayList; +import java.util.EnumMap; +import java.util.EnumSet; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Locale; +import java.util.Map; +import java.util.Objects; +import java.util.Map.Entry; +import java.util.Random; +import java.util.logging.Level; +import java.util.stream.Stream; + +import javax.swing.Icon; + +import org.w3c.dom.Document; +import org.w3c.dom.Node; + +import net.filebot.Cache; +import net.filebot.Cache.TypedCache; +import net.filebot.CacheType; +import net.filebot.ResourceManager; + +public class TheTVDBClientV1 extends AbstractEpisodeListProvider implements ArtworkProvider { + + private final Map mirrors = MirrorType.newMap(); + + private final String apikey; + + public TheTVDBClientV1(String apikey) { + if (apikey == null) + throw new NullPointerException("apikey must not be null"); + + this.apikey = apikey; + } + + @Override + public String getName() { + return "TheTVDB"; + } + + @Override + public Icon getIcon() { + return ResourceManager.getIcon("search.thetvdb"); + } + + @Override + public boolean hasSeasonSupport() { + return true; + } + + public String getLanguageCode(Locale locale) { + String code = locale.getLanguage(); + + // sanity check + if (code.length() != 2) { + // see http://thetvdb.com/api/BA864DEE427E384A/languages.xml + throw new IllegalArgumentException("Expecting 2-letter language code: " + code); + } + + // Java language code => TheTVDB language code + if (code.equals("iw")) // Hebrew + return "he"; + if (code.equals("hi")) // Hungarian + return "hu"; + if (code.equals("in")) // Indonesian + return "id"; + if (code.equals("ro")) // Russian + return "ru"; + + return code; + } + + @Override + public List fetchSearchResult(String query, Locale locale) throws Exception { + // perform online search + Document dom = getXmlResource(MirrorType.SEARCH, "GetSeries.php?seriesname=" + encode(query, true) + "&language=" + getLanguageCode(locale)); + + Map resultSet = new LinkedHashMap(); + + for (Node node : selectNodes("Data/Series", dom)) { + int sid = matchInteger(getTextContent("seriesid", node)); + String seriesName = getTextContent("SeriesName", node); + + if (seriesName.startsWith("**") && seriesName.endsWith("**")) { + debug.fine(format("Invalid series: %s [%d]", seriesName, sid)); + continue; + } + + // collect alias names + List aliasNames = streamNodes("AliasNames", node).flatMap(it -> { + return PIPE.splitAsStream(getTextContent(it)); + }).map(String::trim).filter(s -> s.length() > 0).collect(toList()); + + if (!resultSet.containsKey(sid)) { + resultSet.put(sid, new SearchResult(sid, seriesName, aliasNames)); + } + } + + return new ArrayList(resultSet.values()); + } + + @Override + protected SeriesData fetchSeriesData(SearchResult series, SortOrder sortOrder, Locale locale) throws Exception { + Document dom = getXmlResource(MirrorType.XML, "series/" + series.getId() + "/all/" + getLanguageCode(locale) + ".xml"); + + // parse series info + Node seriesNode = selectNode("Data/Series", dom); + TheTVDBSeriesInfo seriesInfo = new TheTVDBSeriesInfo(this, locale, series.getId()); + seriesInfo.setOrder(sortOrder.name()); + seriesInfo.setAliasNames(series.getAliasNames()); + + seriesInfo.setName(getTextContent("SeriesName", seriesNode)); + seriesInfo.setAirsDayOfWeek(getTextContent("Airs_DayOfWeek", seriesNode)); + seriesInfo.setCertification(getTextContent("ContentRating", seriesNode)); + seriesInfo.setImdbId(getTextContent("IMDB_ID", seriesNode)); + seriesInfo.setNetwork(getTextContent("Network", seriesNode)); + seriesInfo.setOverview(getTextContent("Overview", seriesNode)); + seriesInfo.setStatus(getTextContent("Status", seriesNode)); + + seriesInfo.setRating(getDecimal(getTextContent("Rating", seriesNode))); + seriesInfo.setRatingCount(matchInteger(getTextContent("RatingCount", seriesNode))); + seriesInfo.setRuntime(matchInteger(getTextContent("Runtime", seriesNode))); + seriesInfo.setGenres(getListContent("Genre", "\\|", seriesNode)); + seriesInfo.setStartDate(SimpleDate.parse(getTextContent("FirstAired", seriesNode))); + seriesInfo.setBannerUrl(getResource(MirrorType.BANNER, getTextContent("banner", seriesNode))); + + // parse episode data + List episodes = new ArrayList(50); + List specials = new ArrayList(5); + + for (Node node : selectNodes("Data/Episode", dom)) { + String episodeName = getTextContent("EpisodeName", node); + Integer absoluteNumber = matchInteger(getTextContent("absolute_number", node)); + SimpleDate airdate = SimpleDate.parse(getTextContent("FirstAired", node)); + + // default numbering + Integer episodeNumber = matchInteger(getTextContent("EpisodeNumber", node)); + Integer seasonNumber = matchInteger(getTextContent("SeasonNumber", node)); + + // adjust for DVD numbering if possible + if (sortOrder == SortOrder.DVD) { + Integer dvdSeasonNumber = matchInteger(getTextContent("DVD_season", node)); + Integer dvdEpisodeNumber = matchInteger(getTextContent("DVD_episodenumber", node)); + + // require both values to be valid integer numbers + if (dvdSeasonNumber != null && dvdEpisodeNumber != null) { + seasonNumber = dvdSeasonNumber; + episodeNumber = dvdEpisodeNumber; + } + } + + // adjust for special numbering if necessary + if (seasonNumber == null || seasonNumber == 0) { + // handle as special episode + for (String specialSeasonTag : new String[] { "airsafter_season", "airsbefore_season" }) { + Integer specialSeason = matchInteger(getTextContent(specialSeasonTag, node)); + if (specialSeason != null && specialSeason != 0) { + seasonNumber = specialSeason; + break; + } + } + + // use given episode number as special number or count specials by ourselves + Integer specialNumber = (episodeNumber != null) ? episodeNumber : filterBySeason(specials, seasonNumber).size() + 1; + specials.add(new Episode(seriesInfo.getName(), seasonNumber, null, episodeName, null, specialNumber, airdate, new SeriesInfo(seriesInfo))); + } else { + // adjust for absolute numbering if possible + if (sortOrder == SortOrder.Absolute) { + if (absoluteNumber != null && absoluteNumber > 0) { + episodeNumber = absoluteNumber; + seasonNumber = null; + } + } + + // handle as normal episode + episodes.add(new Episode(seriesInfo.getName(), seasonNumber, episodeNumber, episodeName, absoluteNumber, null, airdate, new SeriesInfo(seriesInfo))); + } + } + + // episodes my not be ordered by DVD episode number + episodes.sort(episodeComparator()); + + // add specials at the end + episodes.addAll(specials); + + return new SeriesData(seriesInfo, episodes); + } + + public SearchResult lookupByID(int id, Locale language) throws Exception { + if (id <= 0) { + throw new IllegalArgumentException("Illegal TheTVDB ID: " + id); + } + + return getLookupCache("id", language).computeIfAbsent(id, it -> { + Document dom = getXmlResource(MirrorType.XML, "series/" + id + "/all/" + getLanguageCode(language) + ".xml"); + String name = selectString("//SeriesName", dom); + + return new SearchResult(id, name); + }); + } + + public SearchResult lookupByIMDbID(int imdbid, Locale locale) throws Exception { + if (imdbid <= 0) { + throw new IllegalArgumentException("Illegal IMDbID ID: " + imdbid); + } + + return getLookupCache("imdbid", locale).computeIfAbsent(imdbid, it -> { + Document dom = getXmlResource(MirrorType.SEARCH, "GetSeriesByRemoteID.php?imdbid=" + imdbid + "&language=" + getLanguageCode(locale)); + + String id = selectString("//seriesid", dom); + String name = selectString("//SeriesName", dom); + + if (id.isEmpty() || name.isEmpty()) + return null; + + return new SearchResult(Integer.parseInt(id), name); + }); + } + + protected String getMirror(MirrorType mirrorType) throws Exception { + // use default server + if (mirrorType == MirrorType.NULL) { + return "http://thetvdb.com"; + } + + synchronized (mirrors) { + // initialize mirrors + if (mirrors.isEmpty()) { + Document dom = getXmlResource(MirrorType.NULL, "mirrors.xml"); + + // collect all mirror data + Map> mirrorLists = streamNodes("Mirrors/Mirror", dom).flatMap(node -> { + String mirror = getTextContent("mirrorpath", node); + int typeMask = Integer.parseInt(getTextContent("typemask", node)); + + return MirrorType.fromTypeMask(typeMask).stream().collect(toMap(m -> m, m -> mirror)).entrySet().stream(); + }).collect(groupingBy(Entry::getKey, MirrorType::newMap, mapping(Entry::getValue, toList()))); + + // select random mirror for each type + Random random = new Random(); + + mirrorLists.forEach((type, options) -> { + String selection = options.get(random.nextInt(options.size())); + mirrors.put(type, selection); + }); + } + + // return selected mirror + return mirrors.get(mirrorType); + } + } + + protected Document getXmlResource(MirrorType mirror, String resource) throws Exception { + Cache cache = Cache.getCache(getName(), CacheType.Monthly); + return cache.xml(resource, s -> getResource(mirror, s)).get(); + } + + protected URL getResource(MirrorType mirror, String path) throws Exception { + StringBuilder url = new StringBuilder(getMirror(mirror)).append('/').append(mirror.prefix()).append('/'); + if (mirror.keyRequired()) { + url.append(apikey).append('/'); + } + return new URL(url.append(path).toString()); + } + + protected static enum MirrorType { + + NULL(0), SEARCH(1), XML(1), BANNER(2); + + final int bitMask; + + private MirrorType(int bitMask) { + this.bitMask = bitMask; + } + + public String prefix() { + return this != BANNER ? "api" : "banners"; + } + + public boolean keyRequired() { + return this != BANNER && this != SEARCH; + } + + public static EnumSet fromTypeMask(int mask) { + // convert bit mask to enumset + return EnumSet.of(SEARCH, XML, BANNER).stream().filter(m -> { + return (mask & m.bitMask) != 0; + }).collect(toCollection(MirrorType::newSet)); + }; + + public static EnumSet newSet() { + return EnumSet.noneOf(MirrorType.class); + } + + public static EnumMap newMap() { + return new EnumMap(MirrorType.class); + } + + } + + public SeriesInfo getSeriesInfoByIMDbID(int imdbid, Locale locale) throws Exception { + return getSeriesInfo(lookupByIMDbID(imdbid, locale), locale); + } + + @Override + public URI getEpisodeListLink(SearchResult searchResult) { + return URI.create("http://www.thetvdb.com/?tab=seasonall&id=" + searchResult.getId()); + } + + @Override + public List getArtwork(int id, String category, Locale locale) throws Exception { + Document dom = getXmlResource(MirrorType.XML, "series/" + id + "/banners.xml"); + URL mirror = getResource(MirrorType.BANNER, ""); + + return streamNodes("//Banner", dom).map(node -> { + try { + String type = getTextContent("BannerType", node); + String subKey = getTextContent("BannerType2", node); + String fileName = getTextContent("BannerPath", node); + String season = getTextContent("Season", node); + String language = getTextContent("Language", node); + Double rating = getDecimal(getTextContent("Rating", node)); + + return new Artwork(Stream.of(type, subKey, season), new URL(mirror, fileName), language == null ? null : new Locale(language), rating); + } catch (Exception e) { + debug.log(Level.WARNING, e, e::getMessage); + return null; + } + }).filter(Objects::nonNull).filter(it -> it.getTags().contains(category)).collect(toList()); + } + + protected TypedCache getLookupCache(String type, Locale language) { + // lookup should always yield the same results so we can cache it for longer + return Cache.getCache(getName() + "_" + "lookup" + "_" + type + "_" + language, CacheType.Monthly).cast(SearchResult.class); + } + +} diff --git a/test/net/filebot/web/TheTVDBClientV1Test.java b/test/net/filebot/web/TheTVDBClientV1Test.java new file mode 100644 index 00000000..3297baf3 --- /dev/null +++ b/test/net/filebot/web/TheTVDBClientV1Test.java @@ -0,0 +1,144 @@ +package net.filebot.web; + +import static org.junit.Assert.*; + +import java.util.EnumSet; +import java.util.List; +import java.util.Locale; + +import org.junit.Test; + +import net.filebot.web.TheTVDBClientV1.MirrorType; + +public class TheTVDBClientV1Test { + + TheTVDBClientV1 thetvdb = new TheTVDBClientV1("BA864DEE427E384A"); + + SearchResult buffy = new SearchResult(70327, "Buffy the Vampire Slayer"); + SearchResult wonderfalls = new SearchResult(78845, "Wonderfalls"); + SearchResult firefly = new SearchResult(78874, "Firefly"); + + @Test + public void search() throws Exception { + // test default language and query escaping (blanks) + List results = thetvdb.search("babylon 5", Locale.ENGLISH); + + assertEquals(2, results.size()); + + SearchResult first = results.get(0); + + assertEquals("Babylon 5", first.getName()); + assertEquals(70726, first.getId()); + } + + @Test + public void searchGerman() throws Exception { + List results = thetvdb.search("Buffy the Vampire Slayer", Locale.GERMAN); + + assertEquals(2, results.size()); + + SearchResult first = results.get(0); + + assertEquals("Buffy the Vampire Slayer", first.getName()); + assertEquals(70327, first.getId()); + } + + @Test + public void getEpisodeListAll() throws Exception { + List list = thetvdb.getEpisodeList(buffy, SortOrder.Airdate, Locale.ENGLISH); + + assertTrue(list.size() >= 144); + + Episode first = list.get(0); + assertEquals("Buffy the Vampire Slayer", first.getSeriesName()); + assertEquals("1997-03-10", first.getSeriesInfo().getStartDate().toString()); + assertEquals("Welcome to the Hellmouth (1)", first.getTitle()); + assertEquals("1", first.getEpisode().toString()); + assertEquals("1", first.getSeason().toString()); + assertEquals("1", first.getAbsolute().toString()); + assertEquals("1997-03-10", first.getAirdate().toString()); + } + + @Test + public void getEpisodeListSingleSeason() throws Exception { + List list = thetvdb.getEpisodeList(wonderfalls, SortOrder.Airdate, Locale.ENGLISH); + + Episode first = list.get(0); + + assertEquals("Wonderfalls", first.getSeriesName()); + assertEquals("2004-03-12", first.getSeriesInfo().getStartDate().toString()); + assertEquals("Wax Lion", first.getTitle()); + assertEquals("1", first.getEpisode().toString()); + assertEquals("1", first.getSeason().toString()); + assertEquals(null, first.getAbsolute()); // should be "1" but data has not yet been entered + assertEquals("2004-03-12", first.getAirdate().toString()); + } + + @Test + public void getEpisodeListNumbering() throws Exception { + List list = thetvdb.getEpisodeList(firefly, SortOrder.DVD, Locale.ENGLISH); + + Episode first = list.get(0); + assertEquals("Firefly", first.getSeriesName()); + assertEquals("2002-09-20", first.getSeriesInfo().getStartDate().toString()); + assertEquals("Serenity", first.getTitle()); + assertEquals("1", first.getEpisode().toString()); + assertEquals("1", first.getSeason().toString()); + assertEquals("1", first.getAbsolute().toString()); + assertEquals("2002-12-20", first.getAirdate().toString()); + } + + public void getEpisodeListLink() { + assertEquals("http://www.thetvdb.com/?tab=seasonall&id=78874", thetvdb.getEpisodeListLink(firefly).toString()); + } + + @Test + public void resolveTypeMask() { + // no flags set + assertEquals(MirrorType.newSet(), MirrorType.fromTypeMask(0)); + + // all flags set + assertEquals(EnumSet.of(MirrorType.SEARCH, MirrorType.XML, MirrorType.BANNER), MirrorType.fromTypeMask(7)); + } + + @Test + public void lookupByID() throws Exception { + SearchResult series = thetvdb.lookupByID(78874, Locale.ENGLISH); + assertEquals("Firefly", series.getName()); + assertEquals(78874, series.getId()); + } + + @Test + public void lookupByIMDbID() throws Exception { + SearchResult series = thetvdb.lookupByIMDbID(303461, Locale.ENGLISH); + assertEquals("Firefly", series.getName()); + assertEquals(78874, series.getId()); + } + + @Test + public void getSeriesInfo() throws Exception { + TheTVDBSeriesInfo it = (TheTVDBSeriesInfo) thetvdb.getSeriesInfo(80348, Locale.ENGLISH); + + assertEquals(80348, it.getId(), 0); + assertEquals("TV-PG", it.getCertification()); + assertEquals("2007-09-24", it.getStartDate().toString()); + assertEquals("Action", it.getGenres().get(0)); + assertEquals("tt0934814", it.getImdbId()); + assertEquals("en", it.getLanguage()); + assertEquals("45", it.getRuntime().toString()); + assertEquals("Chuck", it.getName()); + } + + @Test + public void getBanner() throws Exception { + Artwork banner = thetvdb.getArtwork(buffy.getId(), "season", Locale.ROOT).stream().filter(it -> { + return it.matches("season", "seasonwide", "7", "en"); + }).findFirst().get(); + + assertEquals("season", banner.getTags().get(0)); + assertEquals("seasonwide", banner.getTags().get(1)); + assertEquals("http://thetvdb.com/banners/seasonswide/70327-7.jpg", banner.getUrl().toString()); + assertEquals(99712, WebRequest.fetch(banner.getUrl()).remaining(), 0); + } + +}