558 lines
18 KiB
Java
558 lines
18 KiB
Java
|
|
package net.sourceforge.filebot.media;
|
|
|
|
|
|
import static java.util.Collections.*;
|
|
import static java.util.regex.Pattern.*;
|
|
import static net.sourceforge.filebot.similarity.CommonSequenceMatcher.*;
|
|
import static net.sourceforge.filebot.similarity.Normalization.*;
|
|
import static net.sourceforge.tuned.FileUtilities.*;
|
|
|
|
import java.io.File;
|
|
import java.io.FileFilter;
|
|
import java.io.IOException;
|
|
import java.net.MalformedURLException;
|
|
import java.net.URL;
|
|
import java.text.CollationKey;
|
|
import java.text.Collator;
|
|
import java.util.ArrayList;
|
|
import java.util.Collection;
|
|
import java.util.Comparator;
|
|
import java.util.HashMap;
|
|
import java.util.HashSet;
|
|
import java.util.LinkedHashMap;
|
|
import java.util.LinkedHashSet;
|
|
import java.util.List;
|
|
import java.util.Locale;
|
|
import java.util.Map;
|
|
import java.util.Map.Entry;
|
|
import java.util.NoSuchElementException;
|
|
import java.util.Set;
|
|
import java.util.TreeSet;
|
|
import java.util.WeakHashMap;
|
|
import java.util.logging.Level;
|
|
import java.util.logging.Logger;
|
|
import java.util.regex.Matcher;
|
|
import java.util.regex.Pattern;
|
|
|
|
import net.sourceforge.filebot.MediaTypes;
|
|
import net.sourceforge.filebot.WebServices;
|
|
import net.sourceforge.filebot.similarity.CommonSequenceMatcher;
|
|
import net.sourceforge.filebot.similarity.DateMatcher;
|
|
import net.sourceforge.filebot.similarity.NameSimilarityMetric;
|
|
import net.sourceforge.filebot.similarity.SeasonEpisodeMatcher;
|
|
import net.sourceforge.filebot.similarity.SeriesNameMatcher;
|
|
import net.sourceforge.filebot.similarity.SimilarityComparator;
|
|
import net.sourceforge.filebot.similarity.SimilarityMetric;
|
|
import net.sourceforge.filebot.web.Movie;
|
|
import net.sourceforge.filebot.web.MovieIdentificationService;
|
|
import net.sourceforge.filebot.web.SearchResult;
|
|
import net.sourceforge.filebot.web.TheTVDBClient.SeriesInfo;
|
|
import net.sourceforge.filebot.web.TheTVDBClient.TheTVDBSearchResult;
|
|
|
|
|
|
public class MediaDetection {
|
|
|
|
private static final ReleaseInfo releaseInfo = new ReleaseInfo();
|
|
|
|
public static final FileFilter DISK_FOLDERS = releaseInfo.getDiskFolderFilter();
|
|
public static final FileFilter NON_CLUTTER_FILES = not(releaseInfo.getClutterFileFilter());
|
|
|
|
|
|
public static boolean isDiskFolder(File folder) {
|
|
return DISK_FOLDERS.accept(folder);
|
|
}
|
|
|
|
|
|
public static boolean isNonClutter(File file) {
|
|
return NON_CLUTTER_FILES.accept(file);
|
|
}
|
|
|
|
|
|
public static Map<Set<File>, Set<String>> mapSeriesNamesByFiles(Collection<File> files, Locale locale) throws Exception {
|
|
// map series names by folder
|
|
Map<File, Set<String>> seriesNamesByFolder = new HashMap<File, Set<String>>();
|
|
Map<File, List<File>> filesByFolder = mapByFolder(files);
|
|
|
|
for (Entry<File, List<File>> it : filesByFolder.entrySet()) {
|
|
Set<String> namesForFolder = new TreeSet<String>(getLenientCollator(locale));
|
|
namesForFolder.addAll(detectSeriesNames(it.getValue(), locale));
|
|
|
|
seriesNamesByFolder.put(it.getKey(), namesForFolder);
|
|
}
|
|
|
|
// reverse map folders by series name
|
|
Map<String, Set<File>> foldersBySeriesName = new HashMap<String, Set<File>>();
|
|
|
|
for (Set<String> nameSet : seriesNamesByFolder.values()) {
|
|
for (String name : nameSet) {
|
|
Set<File> foldersForSeries = new HashSet<File>();
|
|
for (Entry<File, Set<String>> it : seriesNamesByFolder.entrySet()) {
|
|
if (it.getValue().contains(name)) {
|
|
foldersForSeries.add(it.getKey());
|
|
}
|
|
}
|
|
foldersBySeriesName.put(name, foldersForSeries);
|
|
}
|
|
}
|
|
|
|
// join both sets
|
|
Map<Set<File>, Set<String>> batchSets = new HashMap<Set<File>, Set<String>>();
|
|
|
|
while (seriesNamesByFolder.size() > 0) {
|
|
Set<String> combinedNameSet = new TreeSet<String>(getLenientCollator(locale));
|
|
Set<File> combinedFolderSet = new HashSet<File>();
|
|
|
|
// build combined match set
|
|
combinedFolderSet.add(seriesNamesByFolder.keySet().iterator().next());
|
|
|
|
boolean resolveFurther = true;
|
|
while (resolveFurther) {
|
|
boolean modified = false;
|
|
for (File folder : combinedFolderSet) {
|
|
modified |= combinedNameSet.addAll(seriesNamesByFolder.get(folder));
|
|
}
|
|
for (String name : combinedNameSet) {
|
|
modified |= combinedFolderSet.addAll(foldersBySeriesName.get(name));
|
|
}
|
|
resolveFurther &= modified;
|
|
}
|
|
|
|
// build result entry
|
|
Set<File> combinedFileSet = new TreeSet<File>();
|
|
for (File folder : combinedFolderSet) {
|
|
combinedFileSet.addAll(filesByFolder.get(folder));
|
|
}
|
|
|
|
if (combinedFileSet.size() > 0) {
|
|
// divide file set per complete series set
|
|
Map<Object, List<File>> filesByEpisode = new LinkedHashMap<Object, List<File>>();
|
|
for (File file : combinedFileSet) {
|
|
Object eid = getEpisodeIdentifier(file.getName(), true);
|
|
if (eid != null) {
|
|
List<File> episodeFiles = filesByEpisode.get(eid);
|
|
if (episodeFiles == null) {
|
|
episodeFiles = new ArrayList<File>();
|
|
filesByEpisode.put(eid, episodeFiles);
|
|
}
|
|
episodeFiles.add(file);
|
|
}
|
|
}
|
|
|
|
for (int i = 0; true; i++) {
|
|
Set<File> series = new LinkedHashSet<File>();
|
|
for (List<File> episode : filesByEpisode.values()) {
|
|
if (i < episode.size()) {
|
|
series.add(episode.get(i));
|
|
}
|
|
}
|
|
|
|
if (series.isEmpty()) {
|
|
break;
|
|
}
|
|
|
|
combinedFileSet.removeAll(series);
|
|
batchSets.put(series, combinedNameSet);
|
|
}
|
|
|
|
if (combinedFileSet.size() > 0) {
|
|
batchSets.put(combinedFileSet, combinedNameSet);
|
|
}
|
|
}
|
|
|
|
// set folders as accounted for
|
|
seriesNamesByFolder.keySet().removeAll(combinedFolderSet);
|
|
}
|
|
|
|
// handle files that have not been matched to a batch set yet
|
|
Set<File> remainingFiles = new HashSet<File>(files);
|
|
for (Set<File> batch : batchSets.keySet()) {
|
|
remainingFiles.removeAll(batch);
|
|
}
|
|
if (remainingFiles.size() > 0) {
|
|
batchSets.put(remainingFiles, null);
|
|
}
|
|
|
|
return batchSets;
|
|
}
|
|
|
|
|
|
private static Object getEpisodeIdentifier(CharSequence name, boolean strict) {
|
|
// check SxE first
|
|
Object match = new SeasonEpisodeMatcher(SeasonEpisodeMatcher.DEFAULT_SANITY, strict).match(name);
|
|
|
|
// then Date pattern
|
|
if (match == null)
|
|
match = new DateMatcher().match(name);
|
|
|
|
return match;
|
|
}
|
|
|
|
|
|
public static List<String> detectSeriesNames(Collection<File> files, Locale locale) throws Exception {
|
|
List<String> names = new ArrayList<String>();
|
|
|
|
try {
|
|
for (SearchResult it : lookupSeriesNameByInfoFile(files, locale)) {
|
|
names.add(it.getName());
|
|
}
|
|
} catch (Exception e) {
|
|
Logger.getLogger(MediaDetection.class.getClass().getName()).log(Level.WARNING, "Failed to lookup info by id: " + e.getMessage(), e);
|
|
}
|
|
|
|
// cross-reference known series names against file structure
|
|
try {
|
|
Set<String> folders = new LinkedHashSet<String>();
|
|
Set<String> filenames = new LinkedHashSet<String>();
|
|
for (File f : files) {
|
|
for (int i = 0; i < 3 && f != null; i++, f = f.getParentFile()) {
|
|
(i == 0 ? filenames : folders).add(normalizeBrackets(f.getName()));
|
|
}
|
|
}
|
|
|
|
// check foldernames first
|
|
List<String> matches = matchSeriesByName(folders);
|
|
|
|
// check all filenames if necessary
|
|
if (matches.isEmpty()) {
|
|
matches = matchSeriesByName(filenames);
|
|
}
|
|
|
|
names.addAll(matches);
|
|
} catch (Exception e) {
|
|
Logger.getLogger(MediaDetection.class.getClass().getName()).log(Level.WARNING, "Failed to match folder structure: " + e.getMessage(), e);
|
|
}
|
|
|
|
// match common word sequence and clean detected word sequence from unwanted elements
|
|
Collection<String> matches = new SeriesNameMatcher(locale).matchAll(files.toArray(new File[files.size()]));
|
|
try {
|
|
matches = stripReleaseInfo(matches, true);
|
|
} catch (Exception e) {
|
|
Logger.getLogger(MediaDetection.class.getClass().getName()).log(Level.WARNING, "Failed to clean matches: " + e.getMessage(), e);
|
|
}
|
|
names.addAll(matches);
|
|
|
|
// don't allow duplicates
|
|
Map<String, String> unique = new LinkedHashMap<String, String>();
|
|
for (String it : names) {
|
|
unique.put(it.toLowerCase(), it);
|
|
}
|
|
return new ArrayList<String>(unique.values());
|
|
}
|
|
|
|
|
|
public static List<String> matchSeriesByName(Collection<String> names) throws Exception {
|
|
HighPerformanceMatcher nameMatcher = new HighPerformanceMatcher(0);
|
|
List<String> matches = new ArrayList<String>();
|
|
|
|
String[] seriesIndex = releaseInfo.getSeriesList();
|
|
for (String name : names) {
|
|
String bestMatch = "";
|
|
for (String identifier : seriesIndex) {
|
|
String commonName = nameMatcher.matchFirstCommonSequence(name, identifier);
|
|
if (commonName != null && commonName.length() >= identifier.length() && commonName.length() > bestMatch.length()) {
|
|
bestMatch = commonName;
|
|
}
|
|
}
|
|
if (bestMatch.length() > 0) {
|
|
matches.add(bestMatch);
|
|
}
|
|
}
|
|
|
|
// sort by length of name match (descending)
|
|
sort(matches, new Comparator<String>() {
|
|
|
|
@Override
|
|
public int compare(String a, String b) {
|
|
return Integer.valueOf(b.length()).compareTo(Integer.valueOf(a.length()));
|
|
}
|
|
});
|
|
|
|
return matches;
|
|
}
|
|
|
|
|
|
public static Collection<Movie> detectMovie(File movieFile, MovieIdentificationService hashLookupService, MovieIdentificationService queryLookupService, Locale locale, boolean strict) throws Exception {
|
|
Set<Movie> options = new LinkedHashSet<Movie>();
|
|
|
|
// lookup by file hash
|
|
if (hashLookupService != null && movieFile.isFile()) {
|
|
try {
|
|
for (Movie movie : hashLookupService.getMovieDescriptors(singleton(movieFile), locale).values()) {
|
|
if (movie != null) {
|
|
options.add(movie);
|
|
}
|
|
}
|
|
} catch (Exception e) {
|
|
Logger.getLogger(MediaDetection.class.getName()).log(Level.WARNING, e.getMessage());
|
|
}
|
|
}
|
|
|
|
// lookup by id from nfo file
|
|
if (queryLookupService != null) {
|
|
// try to grep imdb id from nfo files
|
|
for (int imdbid : grepImdbIdFor(movieFile)) {
|
|
Movie movie = queryLookupService.getMovieDescriptor(imdbid, locale);
|
|
if (movie != null) {
|
|
options.add(movie);
|
|
}
|
|
}
|
|
}
|
|
|
|
// search by file name or folder name
|
|
List<String> terms = new ArrayList<String>();
|
|
|
|
// 1. term: try to match movie pattern 'name (year)' or use filename as is
|
|
Matcher nameMatcher = compile("^(.+?)[(]((?:19|20)\\d{2})[)]").matcher(movieFile.getName());
|
|
if (nameMatcher.find()) {
|
|
terms.add(String.format("%s (%s)", nameMatcher.group(1).trim(), nameMatcher.group(2)));
|
|
} else {
|
|
terms.add(getName(movieFile));
|
|
}
|
|
|
|
// 2. term: first meaningful parent folder
|
|
File movieFolder = guessMovieFolder(movieFile);
|
|
if (movieFolder != null) {
|
|
terms.add(getName(movieFolder));
|
|
}
|
|
|
|
List<Movie> movieNameMatches = matchMovieName(terms, locale, strict);
|
|
|
|
// skip further queries if collected matches are already sufficient
|
|
if (options.size() > 0 && movieNameMatches.size() > 0) {
|
|
options.addAll(movieNameMatches);
|
|
return options;
|
|
}
|
|
|
|
// if matching name+year failed, try matching only by name
|
|
if (movieNameMatches.isEmpty() && strict) {
|
|
movieNameMatches = matchMovieName(terms, locale, false);
|
|
}
|
|
|
|
// query by file / folder name
|
|
if (queryLookupService != null) {
|
|
options.addAll(queryMovieByFileName(terms, queryLookupService, locale));
|
|
}
|
|
|
|
// add local matching after online search
|
|
options.addAll(movieNameMatches);
|
|
|
|
// sort by relevance
|
|
List<Movie> optionsByRelevance = new ArrayList<Movie>(options);
|
|
sort(optionsByRelevance, new SimilarityComparator(new NameSimilarityMetric(), stripReleaseInfo(terms, true).toArray()));
|
|
return optionsByRelevance;
|
|
}
|
|
|
|
|
|
public static File guessMovieFolder(File movieFile) throws IOException {
|
|
// first meaningful parent folder (max 2 levels deep)
|
|
File f = movieFile.getParentFile();
|
|
for (int i = 0; f != null && i < 2; f = f.getParentFile(), i++) {
|
|
String term = stripReleaseInfo(f.getName());
|
|
if (term.length() > 0) {
|
|
return f;
|
|
}
|
|
}
|
|
return null;
|
|
}
|
|
|
|
|
|
private static List<Movie> matchMovieName(final List<String> files, final Locale locale, final boolean strict) throws Exception {
|
|
// cross-reference file / folder name with movie list
|
|
final HighPerformanceMatcher nameMatcher = new HighPerformanceMatcher(3);
|
|
final Map<Movie, String> matchMap = new HashMap<Movie, String>();
|
|
|
|
for (final Movie movie : releaseInfo.getMovieList()) {
|
|
for (String name : files) {
|
|
String movieIdentifier = movie.getName();
|
|
String commonName = nameMatcher.matchFirstCommonSequence(name, movieIdentifier);
|
|
if (commonName != null && commonName.length() >= movieIdentifier.length()) {
|
|
String strictMovieIdentifier = movie.getName() + " " + movie.getYear();
|
|
String strictCommonName = nameMatcher.matchFirstCommonSequence(name, strictMovieIdentifier);
|
|
if (strictCommonName != null && strictCommonName.length() >= strictMovieIdentifier.length()) {
|
|
// prefer strict match
|
|
matchMap.put(movie, strictCommonName);
|
|
} else if (!strict) {
|
|
// make sure the common identifier is not just the year
|
|
matchMap.put(movie, commonName);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// sort by length of name match (descending)
|
|
List<Movie> results = new ArrayList<Movie>(matchMap.keySet());
|
|
sort(results, new Comparator<Movie>() {
|
|
|
|
@Override
|
|
public int compare(Movie a, Movie b) {
|
|
return Integer.valueOf(matchMap.get(b).length()).compareTo(Integer.valueOf(matchMap.get(a).length()));
|
|
}
|
|
});
|
|
|
|
return results;
|
|
}
|
|
|
|
|
|
private static Collection<Movie> queryMovieByFileName(List<String> files, MovieIdentificationService queryLookupService, Locale locale) throws Exception {
|
|
// remove blacklisted terms
|
|
Set<String> querySet = new LinkedHashSet<String>();
|
|
querySet.addAll(stripReleaseInfo(files, true));
|
|
querySet.addAll(stripReleaseInfo(files, false));
|
|
|
|
final SimilarityMetric metric = new NameSimilarityMetric();
|
|
final Map<Movie, Float> probabilityMap = new LinkedHashMap<Movie, Float>();
|
|
for (String query : querySet) {
|
|
for (Movie movie : queryLookupService.searchMovie(query, locale)) {
|
|
probabilityMap.put(movie, metric.getSimilarity(query, movie));
|
|
}
|
|
}
|
|
|
|
// sort by similarity to original query (descending)
|
|
List<Movie> results = new ArrayList<Movie>(probabilityMap.keySet());
|
|
sort(results, new Comparator<Movie>() {
|
|
|
|
@Override
|
|
public int compare(Movie a, Movie b) {
|
|
return probabilityMap.get(b).compareTo(probabilityMap.get(a));
|
|
}
|
|
});
|
|
|
|
return results;
|
|
}
|
|
|
|
|
|
public static String stripReleaseInfo(String name) throws IOException {
|
|
try {
|
|
return releaseInfo.cleanRelease(singleton(name), true).iterator().next();
|
|
} catch (NoSuchElementException e) {
|
|
return ""; // default value in case all tokens are stripped away
|
|
}
|
|
}
|
|
|
|
|
|
public static List<String> stripReleaseInfo(Collection<String> names, boolean strict) throws IOException {
|
|
return releaseInfo.cleanRelease(names, strict);
|
|
}
|
|
|
|
|
|
public static Set<Integer> grepImdbIdFor(File file) throws Exception {
|
|
Set<Integer> collection = new LinkedHashSet<Integer>();
|
|
if (file.exists()) {
|
|
for (File nfo : file.getParentFile().listFiles(MediaTypes.getDefaultFilter("application/nfo"))) {
|
|
String text = new String(readFile(nfo), "UTF-8");
|
|
collection.addAll(grepImdbId(text));
|
|
}
|
|
}
|
|
return collection;
|
|
}
|
|
|
|
|
|
public static Set<SearchResult> lookupSeriesNameByInfoFile(Collection<File> files, Locale language) throws Exception {
|
|
Set<SearchResult> names = new LinkedHashSet<SearchResult>();
|
|
|
|
// search for id in sibling nfo files
|
|
for (File folder : mapByFolder(files).keySet()) {
|
|
if (!folder.exists())
|
|
continue;
|
|
|
|
for (File nfo : folder.listFiles(MediaTypes.getDefaultFilter("application/nfo"))) {
|
|
String text = new String(readFile(nfo), "UTF-8");
|
|
|
|
for (int imdbid : grepImdbId(text)) {
|
|
TheTVDBSearchResult series = WebServices.TheTVDB.lookupByIMDbID(imdbid, language);
|
|
if (series != null) {
|
|
names.add(series);
|
|
}
|
|
}
|
|
|
|
for (int tvdbid : grepTheTvdbId(text)) {
|
|
TheTVDBSearchResult series = WebServices.TheTVDB.lookupByID(tvdbid, language);
|
|
if (series != null) {
|
|
names.add(series);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return names;
|
|
}
|
|
|
|
|
|
public static Set<Integer> grepImdbId(CharSequence text) {
|
|
// scan for imdb id patterns like tt1234567
|
|
Matcher imdbMatch = Pattern.compile("(?<=tt)\\d{7}").matcher(text);
|
|
Set<Integer> collection = new LinkedHashSet<Integer>();
|
|
|
|
while (imdbMatch.find()) {
|
|
collection.add(Integer.parseInt(imdbMatch.group()));
|
|
}
|
|
|
|
return collection;
|
|
}
|
|
|
|
|
|
public static Set<Integer> grepTheTvdbId(CharSequence text) {
|
|
// scan for thetvdb id patterns like http://www.thetvdb.com/?tab=series&id=78874&lid=14
|
|
Set<Integer> collection = new LinkedHashSet<Integer>();
|
|
for (String token : Pattern.compile("[\\s\"<>|]+").split(text)) {
|
|
try {
|
|
URL url = new URL(token);
|
|
if (url.getHost().contains("thetvdb") && url.getQuery() != null) {
|
|
Matcher idMatch = Pattern.compile("(?<=(^|\\W)id=)\\d+").matcher(url.getQuery());
|
|
while (idMatch.find()) {
|
|
collection.add(Integer.parseInt(idMatch.group()));
|
|
}
|
|
}
|
|
} catch (MalformedURLException e) {
|
|
// parse for thetvdb urls, ignore everything else
|
|
}
|
|
}
|
|
|
|
return collection;
|
|
}
|
|
|
|
|
|
public static Movie grepMovie(File nfo, MovieIdentificationService resolver, Locale locale) throws Exception {
|
|
return resolver.getMovieDescriptor(grepImdbId(new String(readFile(nfo), "UTF-8")).iterator().next(), locale);
|
|
}
|
|
|
|
|
|
public static SeriesInfo grepSeries(File nfo, Locale locale) throws Exception {
|
|
return WebServices.TheTVDB.getSeriesInfoByID(grepTheTvdbId(new String(readFile(nfo), "UTF-8")).iterator().next(), locale);
|
|
}
|
|
|
|
|
|
/*
|
|
* Heavy-duty name matcher used for matching a file to or more movies (out of a list of ~50k)
|
|
*/
|
|
private static class HighPerformanceMatcher extends CommonSequenceMatcher {
|
|
|
|
private static final Collator collator = getLenientCollator(Locale.ENGLISH);
|
|
|
|
private static final Map<String, CollationKey[]> transformCache = synchronizedMap(new WeakHashMap<String, CollationKey[]>(65536));
|
|
|
|
|
|
public HighPerformanceMatcher(int commonWordSequenceMaxStartIndex) {
|
|
super(collator, commonWordSequenceMaxStartIndex);
|
|
}
|
|
|
|
|
|
@Override
|
|
protected CollationKey[] split(String sequence) {
|
|
CollationKey[] value = transformCache.get(sequence);
|
|
if (value == null) {
|
|
value = super.split(normalize(sequence));
|
|
transformCache.put(sequence, value);
|
|
}
|
|
return value;
|
|
}
|
|
|
|
|
|
public String normalize(String sequence) {
|
|
return normalizePunctuation(sequence); // only normalize punctuation, make sure we keep the year (important for movie matching)
|
|
}
|
|
}
|
|
|
|
}
|