jellyfin/MediaBrowser.Server.Implementations/Library/SearchEngine.cs

308 lines
9.9 KiB
C#
Raw Normal View History

2015-01-09 03:34:09 +00:00
using MediaBrowser.Common.Extensions;
using MediaBrowser.Controller.Entities;
2014-01-07 20:12:39 +00:00
using MediaBrowser.Controller.Entities.Audio;
using MediaBrowser.Controller.Entities.TV;
2014-01-07 20:12:39 +00:00
using MediaBrowser.Controller.Library;
using MediaBrowser.Model.Logging;
using MediaBrowser.Model.Querying;
using MediaBrowser.Model.Search;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
namespace MediaBrowser.Server.Implementations.Library
{
/// <summary>
/// Class LuceneSearchEngine
/// http://www.codeproject.com/Articles/320219/Lucene-Net-ultra-fast-search-for-MVC-or-WebForms
/// </summary>
public class SearchEngine : ISearchEngine
{
private readonly ILibraryManager _libraryManager;
private readonly IUserManager _userManager;
private readonly ILogger _logger;
public SearchEngine(ILogManager logManager, ILibraryManager libraryManager, IUserManager userManager)
{
_libraryManager = libraryManager;
_userManager = userManager;
_logger = logManager.GetLogger("Lucene");
}
public async Task<QueryResult<SearchHintInfo>> GetSearchHints(SearchQuery query)
{
2015-07-18 19:32:59 +00:00
User user = null;
2014-10-03 03:48:59 +00:00
if (string.IsNullOrWhiteSpace(query.UserId))
2014-04-10 15:06:54 +00:00
{
}
else
{
2015-07-18 19:32:59 +00:00
user = _userManager.GetUserById(query.UserId);
2014-04-10 15:06:54 +00:00
}
2015-08-22 02:59:10 +00:00
var results = await GetSearchHints(query, user).ConfigureAwait(false);
2014-01-07 20:12:39 +00:00
var searchResultArray = results.ToArray();
results = searchResultArray;
var count = searchResultArray.Length;
if (query.StartIndex.HasValue)
{
results = results.Skip(query.StartIndex.Value);
}
if (query.Limit.HasValue)
{
results = results.Take(query.Limit.Value);
}
return new QueryResult<SearchHintInfo>
{
TotalRecordCount = count,
Items = results.ToArray()
};
}
2015-08-22 02:59:10 +00:00
private void AddIfMissing(List<string> list, string value)
{
if (!list.Contains(value, StringComparer.OrdinalIgnoreCase))
{
list.Add(value);
}
}
2014-01-07 20:12:39 +00:00
/// <summary>
/// Gets the search hints.
/// </summary>
/// <param name="query">The query.</param>
2015-07-18 19:32:59 +00:00
/// <param name="user">The user.</param>
2014-01-07 20:12:39 +00:00
/// <returns>IEnumerable{SearchHintResult}.</returns>
/// <exception cref="System.ArgumentNullException">searchTerm</exception>
2015-08-22 02:59:10 +00:00
private Task<IEnumerable<SearchHintInfo>> GetSearchHints(SearchQuery query, User user)
2014-01-07 20:12:39 +00:00
{
var searchTerm = query.SearchTerm;
2014-10-03 03:48:59 +00:00
if (string.IsNullOrWhiteSpace(searchTerm))
2014-01-07 20:12:39 +00:00
{
throw new ArgumentNullException("searchTerm");
}
2015-01-09 03:34:09 +00:00
searchTerm = searchTerm.RemoveDiacritics();
2015-07-18 19:32:59 +00:00
2014-01-07 20:12:39 +00:00
var terms = GetWords(searchTerm);
var hints = new List<Tuple<BaseItem, string, int>>();
2015-08-22 02:59:10 +00:00
var excludeItemTypes = new List<string>();
var includeItemTypes = (query.IncludeItemTypes ?? new string[] { }).ToList();
2014-01-07 20:12:39 +00:00
2015-08-22 02:59:10 +00:00
excludeItemTypes.Add(typeof(Year).Name);
2014-01-07 20:12:39 +00:00
2015-08-22 02:59:10 +00:00
if (query.IncludeGenres && (includeItemTypes.Count == 0 || includeItemTypes.Contains("Genre", StringComparer.OrdinalIgnoreCase)))
2014-01-07 20:12:39 +00:00
{
2015-08-22 02:59:10 +00:00
if (!query.IncludeMedia)
2014-01-07 20:12:39 +00:00
{
2015-08-22 02:59:10 +00:00
AddIfMissing(includeItemTypes, typeof(Genre).Name);
AddIfMissing(includeItemTypes, typeof(GameGenre).Name);
AddIfMissing(includeItemTypes, typeof(MusicGenre).Name);
2014-01-07 20:12:39 +00:00
}
}
2015-08-22 02:59:10 +00:00
else
{
AddIfMissing(excludeItemTypes, typeof(Genre).Name);
AddIfMissing(excludeItemTypes, typeof(GameGenre).Name);
AddIfMissing(excludeItemTypes, typeof(MusicGenre).Name);
}
2014-01-07 20:12:39 +00:00
2015-08-22 02:59:10 +00:00
if (query.IncludePeople && (includeItemTypes.Count == 0 || includeItemTypes.Contains("People", StringComparer.OrdinalIgnoreCase)))
2014-01-07 20:12:39 +00:00
{
2015-08-22 02:59:10 +00:00
if (!query.IncludeMedia)
2014-01-07 20:12:39 +00:00
{
2015-08-22 02:59:10 +00:00
AddIfMissing(includeItemTypes, typeof(Person).Name);
2014-01-07 20:12:39 +00:00
}
2015-08-22 02:59:10 +00:00
}
else
{
AddIfMissing(excludeItemTypes, typeof(Person).Name);
}
2014-01-07 20:12:39 +00:00
2015-08-22 02:59:10 +00:00
if (query.IncludeStudios && (includeItemTypes.Count == 0 || includeItemTypes.Contains("Studio", StringComparer.OrdinalIgnoreCase)))
{
if (!query.IncludeMedia)
2014-01-07 20:12:39 +00:00
{
2015-08-22 02:59:10 +00:00
AddIfMissing(includeItemTypes, typeof(Studio).Name);
2014-01-07 20:12:39 +00:00
}
2015-08-22 02:59:10 +00:00
}
else
{
AddIfMissing(excludeItemTypes, typeof(Studio).Name);
}
2014-01-07 20:12:39 +00:00
2015-08-22 02:59:10 +00:00
if (query.IncludeArtists && (includeItemTypes.Count == 0 || includeItemTypes.Contains("MusicArtist", StringComparer.OrdinalIgnoreCase)))
{
if (!query.IncludeMedia)
2014-01-07 20:12:39 +00:00
{
2015-08-22 02:59:10 +00:00
AddIfMissing(includeItemTypes, typeof(MusicArtist).Name);
2014-01-07 20:12:39 +00:00
}
}
2015-08-22 02:59:10 +00:00
else
{
AddIfMissing(excludeItemTypes, typeof(MusicArtist).Name);
}
2014-01-07 20:12:39 +00:00
2015-10-08 01:49:40 +00:00
AddIfMissing(excludeItemTypes, typeof(CollectionFolder).Name);
2015-08-22 02:59:10 +00:00
var mediaItems = _libraryManager.GetItems(new InternalItemsQuery
2014-01-07 20:12:39 +00:00
{
2015-08-22 02:59:10 +00:00
NameContains = searchTerm,
ExcludeItemTypes = excludeItemTypes.ToArray(),
IncludeItemTypes = includeItemTypes.ToArray(),
MaxParentalRating = user == null ? null : user.Policy.MaxParentalRating,
2015-10-08 01:49:40 +00:00
Limit = (query.Limit.HasValue ? (int?)(query.Limit.Value * 3) : null),
2014-01-07 20:12:39 +00:00
2015-08-22 02:59:10 +00:00
}).Items;
2014-01-07 20:12:39 +00:00
2015-08-22 02:59:10 +00:00
// Add search hints based on item name
2015-10-08 01:49:40 +00:00
hints.AddRange(mediaItems.Where(i => IncludeInSearch(i) && IsVisible(i, user)).Select(item =>
2014-01-07 20:12:39 +00:00
{
2015-08-22 02:59:10 +00:00
var index = GetIndex(item.Name, searchTerm, terms);
2015-07-10 03:00:03 +00:00
2015-08-22 02:59:10 +00:00
return new Tuple<BaseItem, string, int>(item, index.Item1, index.Item2);
}));
2014-01-07 20:12:39 +00:00
var returnValue = hints.Where(i => i.Item3 >= 0).OrderBy(i => i.Item3).Select(i => new SearchHintInfo
{
Item = i.Item1,
MatchedTerm = i.Item2
});
return Task.FromResult(returnValue);
}
2015-08-22 02:59:10 +00:00
private bool IsVisible(BaseItem item, User user)
{
if (user == null)
{
return true;
}
if (item is IItemByName)
{
var dual = item as IHasDualAccess;
if (dual == null || dual.IsAccessedByName)
{
return true;
}
}
return item.IsVisibleStandalone(user);
}
private bool IncludeInSearch(BaseItem item)
{
var episode = item as Episode;
if (episode != null)
{
2015-08-22 02:59:10 +00:00
if (episode.IsMissingEpisode)
{
return false;
}
}
return true;
}
2014-01-07 20:12:39 +00:00
/// <summary>
/// Gets the index.
/// </summary>
/// <param name="input">The input.</param>
/// <param name="searchInput">The search input.</param>
/// <param name="searchWords">The search input.</param>
/// <returns>System.Int32.</returns>
private Tuple<string, int> GetIndex(string input, string searchInput, List<string> searchWords)
{
2014-10-03 03:48:59 +00:00
if (string.IsNullOrWhiteSpace(input))
2014-01-07 20:12:39 +00:00
{
throw new ArgumentNullException("input");
}
2015-01-09 03:34:09 +00:00
input = input.RemoveDiacritics();
2014-01-07 20:12:39 +00:00
if (string.Equals(input, searchInput, StringComparison.OrdinalIgnoreCase))
{
return new Tuple<string, int>(searchInput, 0);
}
var index = input.IndexOf(searchInput, StringComparison.OrdinalIgnoreCase);
if (index == 0)
{
return new Tuple<string, int>(searchInput, 1);
}
if (index > 0)
{
return new Tuple<string, int>(searchInput, 2);
}
var items = GetWords(input);
for (var i = 0; i < searchWords.Count; i++)
{
var searchTerm = searchWords[i];
for (var j = 0; j < items.Count; j++)
{
var item = items[j];
if (string.Equals(item, searchTerm, StringComparison.OrdinalIgnoreCase))
{
return new Tuple<string, int>(searchTerm, 3 + (i + 1) * (j + 1));
}
index = item.IndexOf(searchTerm, StringComparison.OrdinalIgnoreCase);
if (index == 0)
{
return new Tuple<string, int>(searchTerm, 4 + (i + 1) * (j + 1));
}
if (index > 0)
{
return new Tuple<string, int>(searchTerm, 5 + (i + 1) * (j + 1));
}
}
}
return new Tuple<string, int>(null, -1);
}
/// <summary>
/// Gets the words.
/// </summary>
/// <param name="term">The term.</param>
/// <returns>System.String[][].</returns>
private List<string> GetWords(string term)
{
2014-09-24 01:44:05 +00:00
var stoplist = GetStopList().ToList();
return term.Split()
.Where(i => !string.IsNullOrWhiteSpace(i) && !stoplist.Contains(i, StringComparer.OrdinalIgnoreCase))
.ToList();
}
private IEnumerable<string> GetStopList()
{
return new[]
{
"the",
"a",
"of",
"an"
};
2014-01-07 20:12:39 +00:00
}
}
}