using MediaBrowser.Common.Extensions; using MediaBrowser.Controller.Channels; using MediaBrowser.Controller.Configuration; using MediaBrowser.Controller.Drawing; using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Entities.Movies; using MediaBrowser.Controller.Entities.TV; using MediaBrowser.Controller.Library; using MediaBrowser.Controller.Localization; using MediaBrowser.Dlna.Didl; using MediaBrowser.Dlna.Server; using MediaBrowser.Dlna.Service; using MediaBrowser.Model.Channels; using MediaBrowser.Model.Dlna; using MediaBrowser.Model.Entities; using MediaBrowser.Model.Logging; using MediaBrowser.Model.Querying; using System; using System.Collections.Generic; using System.Globalization; using System.Linq; using System.Text; using System.Threading; using System.Threading.Tasks; using System.Xml; namespace MediaBrowser.Dlna.ContentDirectory { public class ControlHandler : BaseControlHandler { private readonly ILibraryManager _libraryManager; private readonly IChannelManager _channelManager; private readonly IUserDataManager _userDataManager; private readonly User _user; private const string NS_DC = "http://purl.org/dc/elements/1.1/"; private const string NS_DIDL = "urn:schemas-upnp-org:metadata-1-0/DIDL-Lite/"; private const string NS_DLNA = "urn:schemas-dlna-org:metadata-1-0/"; private const string NS_UPNP = "urn:schemas-upnp-org:metadata-1-0/upnp/"; private readonly int _systemUpdateId; private readonly CultureInfo _usCulture = new CultureInfo("en-US"); private readonly DidlBuilder _didlBuilder; private readonly DeviceProfile _profile; public ControlHandler(ILogger logger, ILibraryManager libraryManager, DeviceProfile profile, string serverAddress, IImageProcessor imageProcessor, IUserDataManager userDataManager, User user, int systemUpdateId, IServerConfigurationManager config, ILocalizationManager localization, IChannelManager channelManager) : base(config, logger) { _libraryManager = libraryManager; _userDataManager = userDataManager; _user = user; _systemUpdateId = systemUpdateId; _channelManager = channelManager; _profile = profile; _didlBuilder = new DidlBuilder(profile, user, imageProcessor, serverAddress, userDataManager, localization); } protected override IEnumerable> GetResult(string methodName, Headers methodParams) { var deviceId = "test"; var user = _user; if (string.Equals(methodName, "GetSearchCapabilities", StringComparison.OrdinalIgnoreCase)) return HandleGetSearchCapabilities(); if (string.Equals(methodName, "GetSortCapabilities", StringComparison.OrdinalIgnoreCase)) return HandleGetSortCapabilities(); if (string.Equals(methodName, "GetSortExtensionCapabilities", StringComparison.OrdinalIgnoreCase)) return HandleGetSortExtensionCapabilities(); if (string.Equals(methodName, "GetSystemUpdateID", StringComparison.OrdinalIgnoreCase)) return HandleGetSystemUpdateID(); if (string.Equals(methodName, "Browse", StringComparison.OrdinalIgnoreCase)) return HandleBrowse(methodParams, user, deviceId).Result; if (string.Equals(methodName, "X_GetFeatureList", StringComparison.OrdinalIgnoreCase)) return HandleXGetFeatureList(); if (string.Equals(methodName, "GetFeatureList", StringComparison.OrdinalIgnoreCase)) return HandleGetFeatureList(); if (string.Equals(methodName, "X_SetBookmark", StringComparison.OrdinalIgnoreCase)) return HandleXSetBookmark(methodParams, user); if (string.Equals(methodName, "Search", StringComparison.OrdinalIgnoreCase)) return HandleSearch(methodParams, user, deviceId).Result; throw new ResourceNotFoundException("Unexpected control request name: " + methodName); } private IEnumerable> HandleXSetBookmark(IDictionary sparams, User user) { var id = sparams["ObjectID"]; var serverItem = GetItemFromObjectId(id, user); var item = serverItem.Item; var newbookmark = int.Parse(sparams["PosSecond"], _usCulture); var userdata = _userDataManager.GetUserData(user.Id, item.GetUserDataKey()); userdata.PlaybackPositionTicks = TimeSpan.FromSeconds(newbookmark).Ticks; _userDataManager.SaveUserData(user.Id, item, userdata, UserDataSaveReason.TogglePlayed, CancellationToken.None); return new Headers(); } private IEnumerable> HandleGetSearchCapabilities() { return new Headers(true) { { "SearchCaps", "res@resolution,res@size,res@duration,dc:title,dc:creator,upnp:actor,upnp:artist,upnp:genre,upnp:album,dc:date,upnp:class,@id,@refID,@protocolInfo,upnp:author,dc:description,pv:avKeywords" } }; } private IEnumerable> HandleGetSortCapabilities() { return new Headers(true) { { "SortCaps", "res@duration,res@size,res@bitrate,dc:date,dc:title,dc:size,upnp:album,upnp:artist,upnp:albumArtist,upnp:episodeNumber,upnp:genre,upnp:originalTrackNumber,upnp:rating" } }; } private IEnumerable> HandleGetSortExtensionCapabilities() { return new Headers(true) { { "SortExtensionCaps", "res@duration,res@size,res@bitrate,dc:date,dc:title,dc:size,upnp:album,upnp:artist,upnp:albumArtist,upnp:episodeNumber,upnp:genre,upnp:originalTrackNumber,upnp:rating" } }; } private IEnumerable> HandleGetSystemUpdateID() { var headers = new Headers(true); headers.Add("Id", _systemUpdateId.ToString(_usCulture)); return headers; } private IEnumerable> HandleGetFeatureList() { return new Headers(true) { { "FeatureList", GetFeatureListXml() } }; } private IEnumerable> HandleXGetFeatureList() { return new Headers(true) { { "FeatureList", GetFeatureListXml() } }; } private string GetFeatureListXml() { var builder = new StringBuilder(); builder.Append(""); builder.Append(""); builder.Append(""); builder.Append(""); builder.Append(""); builder.Append(""); builder.Append(""); builder.Append(""); return builder.ToString(); } private async Task>> HandleBrowse(Headers sparams, User user, string deviceId) { var id = sparams["ObjectID"]; var flag = sparams["BrowseFlag"]; var filter = new Filter(sparams.GetValueOrDefault("Filter", "*")); var sortCriteria = new SortCriteria(sparams.GetValueOrDefault("SortCriteria", "")); var provided = 0; // Default to null instead of 0 // Upnp inspector sends 0 as requestedCount when it wants everything int? requestedCount = null; int? start = 0; int requestedVal; if (sparams.ContainsKey("RequestedCount") && int.TryParse(sparams["RequestedCount"], out requestedVal) && requestedVal > 0) { requestedCount = requestedVal; } int startVal; if (sparams.ContainsKey("StartingIndex") && int.TryParse(sparams["StartingIndex"], out startVal) && startVal > 0) { start = startVal; } //var root = GetItem(id) as IMediaFolder; var result = new XmlDocument(); var didl = result.CreateElement(string.Empty, "DIDL-Lite", NS_DIDL); didl.SetAttribute("xmlns:dc", NS_DC); didl.SetAttribute("xmlns:dlna", NS_DLNA); didl.SetAttribute("xmlns:upnp", NS_UPNP); //didl.SetAttribute("xmlns:sec", NS_SEC); result.AppendChild(didl); var serverItem = GetItemFromObjectId(id, user); var item = serverItem.Item; int totalCount; if (string.Equals(flag, "BrowseMetadata")) { totalCount = 1; if (item.IsFolder || serverItem.StubType.HasValue) { var childrenResult = (await GetUserItems(item, serverItem.StubType, user, sortCriteria, start, requestedCount).ConfigureAwait(false)); result.DocumentElement.AppendChild(_didlBuilder.GetFolderElement(result, item, serverItem.StubType, null, childrenResult.TotalRecordCount, filter, id)); } else { result.DocumentElement.AppendChild(_didlBuilder.GetItemElement(result, item, null, null, deviceId, filter)); } provided++; } else { var childrenResult = (await GetUserItems(item, serverItem.StubType, user, sortCriteria, start, requestedCount).ConfigureAwait(false)); totalCount = childrenResult.TotalRecordCount; provided = childrenResult.Items.Length; foreach (var i in childrenResult.Items) { var childItem = i.Item; var displayStubType = i.StubType; if (childItem.IsFolder || displayStubType.HasValue) { var childCount = (await GetUserItems(childItem, displayStubType, user, sortCriteria, null, 0).ConfigureAwait(false)) .TotalRecordCount; result.DocumentElement.AppendChild(_didlBuilder.GetFolderElement(result, childItem, displayStubType, item, childCount, filter)); } else { result.DocumentElement.AppendChild(_didlBuilder.GetItemElement(result, childItem, item, serverItem.StubType, deviceId, filter)); } } } var resXML = result.OuterXml; return new List> { new KeyValuePair("Result", resXML), new KeyValuePair("NumberReturned", provided.ToString(_usCulture)), new KeyValuePair("TotalMatches", totalCount.ToString(_usCulture)), new KeyValuePair("UpdateID", _systemUpdateId.ToString(_usCulture)) }; } private async Task>> HandleSearch(Headers sparams, User user, string deviceId) { var searchCriteria = new SearchCriteria(sparams.GetValueOrDefault("SearchCriteria", "")); var sortCriteria = new SortCriteria(sparams.GetValueOrDefault("SortCriteria", "")); var filter = new Filter(sparams.GetValueOrDefault("Filter", "*")); // sort example: dc:title, dc:date // Default to null instead of 0 // Upnp inspector sends 0 as requestedCount when it wants everything int? requestedCount = null; int? start = 0; int requestedVal; if (sparams.ContainsKey("RequestedCount") && int.TryParse(sparams["RequestedCount"], out requestedVal) && requestedVal > 0) { requestedCount = requestedVal; } int startVal; if (sparams.ContainsKey("StartingIndex") && int.TryParse(sparams["StartingIndex"], out startVal) && startVal > 0) { start = startVal; } //var root = GetItem(id) as IMediaFolder; var result = new XmlDocument(); var didl = result.CreateElement(string.Empty, "DIDL-Lite", NS_DIDL); didl.SetAttribute("xmlns:dc", NS_DC); didl.SetAttribute("xmlns:dlna", NS_DLNA); didl.SetAttribute("xmlns:upnp", NS_UPNP); foreach (var att in _profile.XmlRootAttributes) { didl.SetAttribute(att.Name, att.Value); } result.AppendChild(didl); var serverItem = GetItemFromObjectId(sparams["ContainerID"], user); var item = serverItem.Item; var childrenResult = (await GetChildrenSorted(item, user, searchCriteria, sortCriteria, start, requestedCount).ConfigureAwait(false)); var totalCount = childrenResult.TotalRecordCount; var provided = childrenResult.Items.Length; foreach (var i in childrenResult.Items) { if (i.IsFolder) { var childCount = (await GetChildrenSorted(i, user, searchCriteria, sortCriteria, null, 0).ConfigureAwait(false)) .TotalRecordCount; result.DocumentElement.AppendChild(_didlBuilder.GetFolderElement(result, i, null, item, childCount, filter)); } else { result.DocumentElement.AppendChild(_didlBuilder.GetItemElement(result, i, item, serverItem.StubType, deviceId, filter)); } } var resXML = result.OuterXml; return new List> { new KeyValuePair("Result", resXML), new KeyValuePair("NumberReturned", provided.ToString(_usCulture)), new KeyValuePair("TotalMatches", totalCount.ToString(_usCulture)), new KeyValuePair("UpdateID", _systemUpdateId.ToString(_usCulture)) }; } private async Task> GetChildrenSorted(BaseItem item, User user, SearchCriteria search, SortCriteria sort, int? startIndex, int? limit) { var folder = (Folder)item; var sortOrders = new List(); if (!folder.IsPreSorted) { sortOrders.Add(ItemSortBy.SortName); } var mediaTypes = new List(); bool? isFolder = null; if (search.SearchType == SearchType.Audio) { mediaTypes.Add(MediaType.Audio); isFolder = false; } else if (search.SearchType == SearchType.Video) { mediaTypes.Add(MediaType.Video); isFolder = false; } else if (search.SearchType == SearchType.Image) { mediaTypes.Add(MediaType.Photo); isFolder = false; } else if (search.SearchType == SearchType.Playlist) { //items = items.OfType(); isFolder = true; } else if (search.SearchType == SearchType.MusicAlbum) { //items = items.OfType(); isFolder = true; } return await folder.GetItems(new InternalItemsQuery { Limit = limit, StartIndex = startIndex, SortBy = sortOrders.ToArray(), SortOrder = sort.SortOrder, User = user, Recursive = true, Filter = FilterUnsupportedContent, IsFolder = isFolder, MediaTypes = mediaTypes.ToArray() }).ConfigureAwait(false); } private async Task> GetUserItems(BaseItem item, StubType? stubType, User user, SortCriteria sort, int? startIndex, int? limit) { if (stubType.HasValue) { if (stubType.Value == StubType.People) { var items = item.People.Select(i => { try { return _libraryManager.GetPerson(i.Name); } catch { return null; } }).Where(i => i != null).ToArray(); var result = new QueryResult { Items = items.Select(i => new ServerItem { Item = i, StubType = StubType.Folder }).ToArray(), TotalRecordCount = items.Length }; return ApplyPaging(result, startIndex, limit); } if (stubType.Value == StubType.Folder) { var movie = item as Movie; if (movie != null) { return ApplyPaging(await GetMovieItems(movie).ConfigureAwait(false), startIndex, limit); } } var person = item as Person; if (person != null) { return await GetItemsFromPerson(person, user, startIndex, limit).ConfigureAwait(false); } return ApplyPaging(new QueryResult(), startIndex, limit); } var folder = (Folder)item; var sortOrders = new List(); if (!folder.IsPreSorted) { sortOrders.Add(ItemSortBy.SortName); } var queryResult = await folder.GetItems(new InternalItemsQuery { Limit = limit, StartIndex = startIndex, SortBy = sortOrders.ToArray(), SortOrder = sort.SortOrder, User = user, Filter = FilterUnsupportedContent }).ConfigureAwait(false); var serverItems = queryResult .Items .Select(i => new ServerItem { Item = i, StubType = GetDisplayStubType(i, item) }) .ToArray(); return new QueryResult { TotalRecordCount = queryResult.TotalRecordCount, Items = serverItems }; } private async Task> GetItemsFromPerson(Person person, User user, int? startIndex, int? limit) { var items = user.RootFolder.GetRecursiveChildren(user, i => i is Movie || i is Series && i.ContainsPerson(person.Name)) .ToList(); var trailerResult = await _channelManager.GetAllMediaInternal(new AllChannelMediaQuery { ContentTypes = new[] { ChannelMediaContentType.MovieExtra }, ExtraTypes = new[] { ExtraType.Trailer }, UserId = user.Id.ToString("N") }, CancellationToken.None).ConfigureAwait(false); var currentIds = items.Select(i => i.GetProviderId(MetadataProviders.Imdb)) .ToList(); var trailersToAdd = trailerResult.Items .Where(i => i.ContainsPerson(person.Name)) .Where(i => { // Try to filter out dupes using imdb id var imdb = i.GetProviderId(MetadataProviders.Imdb); if (!string.IsNullOrWhiteSpace(imdb) && currentIds.Contains(imdb, StringComparer.OrdinalIgnoreCase)) { return false; } return true; }); items.AddRange(trailersToAdd); items = _libraryManager.Sort(items, user, new[] { ItemSortBy.SortName }, SortOrder.Ascending) .Skip(startIndex ?? 0) .Take(limit ?? int.MaxValue) .ToList(); var serverItems = items.Select(i => new ServerItem { Item = i, StubType = null }) .ToArray(); return new QueryResult { TotalRecordCount = serverItems.Length, Items = serverItems }; } private QueryResult ApplyPaging(QueryResult result, int? startIndex, int? limit) { result.Items = result.Items.Skip(startIndex ?? 0).Take(limit ?? int.MaxValue).ToArray(); return result; } private StubType? GetDisplayStubType(BaseItem item, BaseItem context) { if (context == null || context.IsFolder) { var movie = item as Movie; if (movie != null) { if (movie.GetTrailerIds().Count > 0 || movie.SpecialFeatureIds.Count > 0) { return StubType.Folder; } } if (EnablePeopleDisplay(item)) { return StubType.Folder; } } return null; } private bool EnablePeopleDisplay(BaseItem item) { if (item.People.Count > 0) { return item is Movie; } return false; } private Task> GetMovieItems(Movie item) { var list = new List(); list.Add(item); list.AddRange(item.GetTrailerIds().Select(i => _libraryManager.GetItemById(i)).Where(i => i != null)); list.AddRange(item.SpecialFeatureIds.Select(i => _libraryManager.GetItemById(i)).Where(i => i != null)); var serverItems = list.Select(i => new ServerItem { Item = i, StubType = null }) .ToList(); serverItems.Add(new ServerItem { Item = item, StubType = StubType.People }); return Task.FromResult(new QueryResult { Items = serverItems.ToArray(), TotalRecordCount = serverItems.Count }); } private bool FilterUnsupportedContent(BaseItem i) { // Unplayable if (i.LocationType == LocationType.Virtual && !i.IsFolder) { return false; } // Unplayable var supportsPlaceHolder = i as ISupportsPlaceHolders; if (supportsPlaceHolder != null && supportsPlaceHolder.IsPlaceHolder) { return false; } if (i is Game || i is Book) { //return false; } return true; } private ServerItem GetItemFromObjectId(string id, User user) { return DidlBuilder.IsIdRoot(id) ? new ServerItem { Item = user.RootFolder } : ParseItemId(id, user); } private ServerItem ParseItemId(string id, User user) { Guid itemId; StubType? stubType = null; if (id.StartsWith("folder_", StringComparison.OrdinalIgnoreCase)) { stubType = StubType.Folder; id = id.Split(new[] { '_' }, 2)[1]; } else if (id.StartsWith("people_", StringComparison.OrdinalIgnoreCase)) { stubType = StubType.People; id = id.Split(new[] { '_' }, 2)[1]; } if (Guid.TryParse(id, out itemId)) { var item = _libraryManager.GetItemById(itemId); return new ServerItem { Item = item, StubType = stubType }; } Logger.Error("Error parsing item Id: {0}. Returning user root folder.", id); return new ServerItem { Item = user.RootFolder }; } } internal class ServerItem { public BaseItem Item { get; set; } public StubType? StubType { get; set; } } public enum StubType { Folder = 0, People = 1 } }