12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718 |
- #nullable disable
- using System;
- using System.Collections.Generic;
- using System.Globalization;
- using System.IO;
- using System.Linq;
- using System.Text;
- using System.Threading;
- using System.Xml;
- using Emby.Dlna.Didl;
- using Emby.Dlna.Service;
- using Jellyfin.Data.Entities;
- using Jellyfin.Data.Enums;
- using MediaBrowser.Common.Extensions;
- using MediaBrowser.Controller.Configuration;
- using MediaBrowser.Controller.Drawing;
- using MediaBrowser.Controller.Dto;
- using MediaBrowser.Controller.Entities;
- using MediaBrowser.Controller.Entities.Audio;
- using MediaBrowser.Controller.Entities.Movies;
- using MediaBrowser.Controller.Library;
- using MediaBrowser.Controller.LiveTv;
- using MediaBrowser.Controller.MediaEncoding;
- using MediaBrowser.Controller.Playlists;
- using MediaBrowser.Controller.TV;
- using MediaBrowser.Model.Dlna;
- using MediaBrowser.Model.Entities;
- using MediaBrowser.Model.Globalization;
- using MediaBrowser.Model.Querying;
- using Microsoft.Extensions.Logging;
- using Book = MediaBrowser.Controller.Entities.Book;
- using Episode = MediaBrowser.Controller.Entities.TV.Episode;
- using Genre = MediaBrowser.Controller.Entities.Genre;
- using Movie = MediaBrowser.Controller.Entities.Movies.Movie;
- using MusicAlbum = MediaBrowser.Controller.Entities.Audio.MusicAlbum;
- using Series = MediaBrowser.Controller.Entities.TV.Series;
- namespace Emby.Dlna.ContentDirectory
- {
- /// <summary>
- /// Defines the <see cref="ControlHandler" />.
- /// </summary>
- public class ControlHandler : BaseControlHandler
- {
- private const string NsDc = "http://purl.org/dc/elements/1.1/";
- private const string NsDidl = "urn:schemas-upnp-org:metadata-1-0/DIDL-Lite/";
- private const string NsDlna = "urn:schemas-dlna-org:metadata-1-0/";
- private const string NsUpnp = "urn:schemas-upnp-org:metadata-1-0/upnp/";
- private readonly ILibraryManager _libraryManager;
- private readonly IUserDataManager _userDataManager;
- private readonly IServerConfigurationManager _config;
- private readonly User _user;
- private readonly IUserViewManager _userViewManager;
- private readonly ITVSeriesManager _tvSeriesManager;
- private readonly int _systemUpdateId;
- private readonly DidlBuilder _didlBuilder;
- private readonly DeviceProfile _profile;
- /// <summary>
- /// Initializes a new instance of the <see cref="ControlHandler"/> class.
- /// </summary>
- /// <param name="logger">The <see cref="ILogger"/> for use with the <see cref="ControlHandler"/> instance.</param>
- /// <param name="libraryManager">The <see cref="ILibraryManager"/> for use with the <see cref="ControlHandler"/> instance.</param>
- /// <param name="profile">The <see cref="DeviceProfile"/> for use with the <see cref="ControlHandler"/> instance.</param>
- /// <param name="serverAddress">The server address to use in this instance> for use with the <see cref="ControlHandler"/> instance.</param>
- /// <param name="accessToken">The <see cref="string"/> for use with the <see cref="ControlHandler"/> instance.</param>
- /// <param name="imageProcessor">The <see cref="IImageProcessor"/> for use with the <see cref="ControlHandler"/> instance.</param>
- /// <param name="userDataManager">The <see cref="IUserDataManager"/> for use with the <see cref="ControlHandler"/> instance.</param>
- /// <param name="user">The <see cref="User"/> for use with the <see cref="ControlHandler"/> instance.</param>
- /// <param name="systemUpdateId">The system id for use with the <see cref="ControlHandler"/> instance.</param>
- /// <param name="config">The <see cref="IServerConfigurationManager"/> for use with the <see cref="ControlHandler"/> instance.</param>
- /// <param name="localization">The <see cref="ILocalizationManager"/> for use with the <see cref="ControlHandler"/> instance.</param>
- /// <param name="mediaSourceManager">The <see cref="IMediaSourceManager"/> for use with the <see cref="ControlHandler"/> instance.</param>
- /// <param name="userViewManager">The <see cref="IUserViewManager"/> for use with the <see cref="ControlHandler"/> instance.</param>
- /// <param name="mediaEncoder">The <see cref="IMediaEncoder"/> for use with the <see cref="ControlHandler"/> instance.</param>
- /// <param name="tvSeriesManager">The <see cref="ITVSeriesManager"/> for use with the <see cref="ControlHandler"/> instance.</param>
- public ControlHandler(
- ILogger logger,
- ILibraryManager libraryManager,
- DeviceProfile profile,
- string serverAddress,
- string accessToken,
- IImageProcessor imageProcessor,
- IUserDataManager userDataManager,
- User user,
- int systemUpdateId,
- IServerConfigurationManager config,
- ILocalizationManager localization,
- IMediaSourceManager mediaSourceManager,
- IUserViewManager userViewManager,
- IMediaEncoder mediaEncoder,
- ITVSeriesManager tvSeriesManager)
- : base(config, logger)
- {
- _libraryManager = libraryManager;
- _userDataManager = userDataManager;
- _user = user;
- _systemUpdateId = systemUpdateId;
- _userViewManager = userViewManager;
- _tvSeriesManager = tvSeriesManager;
- _profile = profile;
- _config = config;
- _didlBuilder = new DidlBuilder(
- profile,
- user,
- imageProcessor,
- serverAddress,
- accessToken,
- userDataManager,
- localization,
- mediaSourceManager,
- Logger,
- mediaEncoder,
- libraryManager);
- }
- /// <inheritdoc />
- protected override void WriteResult(string methodName, IReadOnlyDictionary<string, string> methodParams, XmlWriter xmlWriter)
- {
- if (xmlWriter == null)
- {
- throw new ArgumentNullException(nameof(xmlWriter));
- }
- if (methodParams == null)
- {
- throw new ArgumentNullException(nameof(methodParams));
- }
- const string DeviceId = "test";
- if (string.Equals(methodName, "GetSearchCapabilities", StringComparison.OrdinalIgnoreCase))
- {
- HandleGetSearchCapabilities(xmlWriter);
- return;
- }
- if (string.Equals(methodName, "GetSortCapabilities", StringComparison.OrdinalIgnoreCase))
- {
- HandleGetSortCapabilities(xmlWriter);
- return;
- }
- if (string.Equals(methodName, "GetSortExtensionCapabilities", StringComparison.OrdinalIgnoreCase))
- {
- HandleGetSortExtensionCapabilities(xmlWriter);
- return;
- }
- if (string.Equals(methodName, "GetSystemUpdateID", StringComparison.OrdinalIgnoreCase))
- {
- HandleGetSystemUpdateID(xmlWriter);
- return;
- }
- if (string.Equals(methodName, "Browse", StringComparison.OrdinalIgnoreCase))
- {
- HandleBrowse(xmlWriter, methodParams, DeviceId);
- return;
- }
- if (string.Equals(methodName, "X_GetFeatureList", StringComparison.OrdinalIgnoreCase))
- {
- HandleXGetFeatureList(xmlWriter);
- return;
- }
- if (string.Equals(methodName, "GetFeatureList", StringComparison.OrdinalIgnoreCase))
- {
- HandleGetFeatureList(xmlWriter);
- return;
- }
- if (string.Equals(methodName, "X_SetBookmark", StringComparison.OrdinalIgnoreCase))
- {
- HandleXSetBookmark(methodParams);
- return;
- }
- if (string.Equals(methodName, "Search", StringComparison.OrdinalIgnoreCase))
- {
- HandleSearch(xmlWriter, methodParams, DeviceId);
- return;
- }
- if (string.Equals(methodName, "X_BrowseByLetter", StringComparison.OrdinalIgnoreCase))
- {
- HandleXBrowseByLetter(xmlWriter, methodParams, DeviceId);
- return;
- }
- throw new ResourceNotFoundException("Unexpected control request name: " + methodName);
- }
- /// <summary>
- /// Adds a "XSetBookmark" element to the xml document.
- /// </summary>
- /// <param name="sparams">The method parameters.</param>
- private void HandleXSetBookmark(IReadOnlyDictionary<string, string> sparams)
- {
- var id = sparams["ObjectID"];
- var serverItem = GetItemFromObjectId(id);
- var item = serverItem.Item;
- var newbookmark = int.Parse(sparams["PosSecond"], CultureInfo.InvariantCulture);
- var userdata = _userDataManager.GetUserData(_user, item);
- userdata.PlaybackPositionTicks = TimeSpan.FromSeconds(newbookmark).Ticks;
- _userDataManager.SaveUserData(
- _user,
- item,
- userdata,
- UserDataSaveReason.TogglePlayed,
- CancellationToken.None);
- }
- /// <summary>
- /// Adds the "SearchCaps" element to the xml document.
- /// </summary>
- /// <param name="xmlWriter">The <see cref="XmlWriter"/>.</param>
- private static void HandleGetSearchCapabilities(XmlWriter xmlWriter)
- {
- xmlWriter.WriteElementString(
- "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");
- }
- /// <summary>
- /// Adds the "SortCaps" element to the xml document.
- /// </summary>
- /// <param name="xmlWriter">The <see cref="XmlWriter"/>.</param>
- private static void HandleGetSortCapabilities(XmlWriter xmlWriter)
- {
- xmlWriter.WriteElementString(
- "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");
- }
- /// <summary>
- /// Adds the "SortExtensionCaps" element to the xml document.
- /// </summary>
- /// <param name="xmlWriter">The <see cref="XmlWriter"/>.</param>
- private static void HandleGetSortExtensionCapabilities(XmlWriter xmlWriter)
- {
- xmlWriter.WriteElementString(
- "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");
- }
- /// <summary>
- /// Adds the "Id" element to the xml document.
- /// </summary>
- /// <param name="xmlWriter">The <see cref="XmlWriter"/>.</param>
- private void HandleGetSystemUpdateID(XmlWriter xmlWriter)
- {
- xmlWriter.WriteElementString("Id", _systemUpdateId.ToString(CultureInfo.InvariantCulture));
- }
- /// <summary>
- /// Adds the "FeatureList" element to the xml document.
- /// </summary>
- /// <param name="xmlWriter">The <see cref="XmlWriter"/>.</param>
- private static void HandleGetFeatureList(XmlWriter xmlWriter)
- {
- xmlWriter.WriteElementString("FeatureList", WriteFeatureListXml());
- }
- /// <summary>
- /// Adds the "FeatureList" element to the xml document.
- /// </summary>
- /// <param name="xmlWriter">The <see cref="XmlWriter"/>.</param>
- private static void HandleXGetFeatureList(XmlWriter xmlWriter)
- => HandleGetFeatureList(xmlWriter);
- /// <summary>
- /// Builds a static feature list.
- /// </summary>
- /// <returns>The xml feature list.</returns>
- private static string WriteFeatureListXml()
- {
- // TODO: clean this up
- var builder = new StringBuilder();
- builder.Append("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
- builder.Append("<Features xmlns=\"urn:schemas-upnp-org:av:avs\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:schemaLocation=\"urn:schemas-upnp-org:av:avs http://www.upnp.org/schemas/av/avs.xsd\">");
- builder.Append("<Feature name=\"samsung.com_BASICVIEW\" version=\"1\">");
- builder.Append("<container id=\"I\" type=\"object.item.imageItem\"/>");
- builder.Append("<container id=\"A\" type=\"object.item.audioItem\"/>");
- builder.Append("<container id=\"V\" type=\"object.item.videoItem\"/>");
- builder.Append("</Feature>");
- builder.Append("</Features>");
- return builder.ToString();
- }
- /// <summary>
- /// Builds the "Browse" xml response.
- /// </summary>
- /// <param name="xmlWriter">The <see cref="XmlWriter"/>.</param>
- /// <param name="sparams">The method parameters.</param>
- /// <param name="deviceId">The device Id to use.</param>
- private void HandleBrowse(XmlWriter xmlWriter, IReadOnlyDictionary<string, string> sparams, string deviceId)
- {
- var id = sparams["ObjectID"];
- var flag = sparams["BrowseFlag"];
- var filter = new Filter(sparams.GetValueOrDefault("Filter", "*"));
- var sortCriteria = new SortCriteria(sparams.GetValueOrDefault("SortCriteria", string.Empty));
- 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;
- if (sparams.ContainsKey("RequestedCount") && int.TryParse(sparams["RequestedCount"], out var requestedVal) && requestedVal > 0)
- {
- requestedCount = requestedVal;
- }
- if (sparams.ContainsKey("StartingIndex") && int.TryParse(sparams["StartingIndex"], out var startVal) && startVal > 0)
- {
- start = startVal;
- }
- int totalCount;
- using (StringWriter builder = new StringWriterWithEncoding(Encoding.UTF8))
- {
- var settings = new XmlWriterSettings()
- {
- Encoding = Encoding.UTF8,
- CloseOutput = false,
- OmitXmlDeclaration = true,
- ConformanceLevel = ConformanceLevel.Fragment
- };
- using (var writer = XmlWriter.Create(builder, settings))
- {
- writer.WriteStartElement(string.Empty, "DIDL-Lite", NsDidl);
- writer.WriteAttributeString("xmlns", "dc", null, NsDc);
- writer.WriteAttributeString("xmlns", "dlna", null, NsDlna);
- writer.WriteAttributeString("xmlns", "upnp", null, NsUpnp);
- DidlBuilder.WriteXmlRootAttributes(_profile, writer);
- var serverItem = GetItemFromObjectId(id);
- var item = serverItem.Item;
- if (string.Equals(flag, "BrowseMetadata", StringComparison.Ordinal))
- {
- totalCount = 1;
- if (item.IsDisplayedAsFolder || serverItem.StubType.HasValue)
- {
- var childrenResult = GetUserItems(item, serverItem.StubType, _user, sortCriteria, start, requestedCount);
- _didlBuilder.WriteFolderElement(writer, item, serverItem.StubType, null, childrenResult.TotalRecordCount, filter, id);
- }
- else
- {
- _didlBuilder.WriteItemElement(writer, item, _user, null, null, deviceId, filter);
- }
- provided++;
- }
- else
- {
- var childrenResult = GetUserItems(item, serverItem.StubType, _user, sortCriteria, start, requestedCount);
- totalCount = childrenResult.TotalRecordCount;
- provided = childrenResult.Items.Count;
- foreach (var i in childrenResult.Items)
- {
- var childItem = i.Item;
- var displayStubType = i.StubType;
- if (childItem.IsDisplayedAsFolder || displayStubType.HasValue)
- {
- var childCount = GetUserItems(childItem, displayStubType, _user, sortCriteria, null, 0)
- .TotalRecordCount;
- _didlBuilder.WriteFolderElement(writer, childItem, displayStubType, item, childCount, filter);
- }
- else
- {
- _didlBuilder.WriteItemElement(writer, childItem, _user, item, serverItem.StubType, deviceId, filter);
- }
- }
- }
- writer.WriteFullEndElement();
- }
- xmlWriter.WriteElementString("Result", builder.ToString());
- }
- xmlWriter.WriteElementString("NumberReturned", provided.ToString(CultureInfo.InvariantCulture));
- xmlWriter.WriteElementString("TotalMatches", totalCount.ToString(CultureInfo.InvariantCulture));
- xmlWriter.WriteElementString("UpdateID", _systemUpdateId.ToString(CultureInfo.InvariantCulture));
- }
- /// <summary>
- /// Builds the response to the "X_BrowseByLetter request.
- /// </summary>
- /// <param name="xmlWriter">The <see cref="XmlWriter"/>.</param>
- /// <param name="sparams">The method parameters.</param>
- /// <param name="deviceId">The device id.</param>
- private void HandleXBrowseByLetter(XmlWriter xmlWriter, IReadOnlyDictionary<string, string> sparams, string deviceId)
- {
- // TODO: Implement this method
- HandleSearch(xmlWriter, sparams, deviceId);
- }
- /// <summary>
- /// Builds a response to the "Search" request.
- /// </summary>
- /// <param name="xmlWriter">The xmlWriter<see cref="XmlWriter"/>.</param>
- /// <param name="sparams">The method parameters.</param>
- /// <param name="deviceId">The deviceId<see cref="string"/>.</param>
- private void HandleSearch(XmlWriter xmlWriter, IReadOnlyDictionary<string, string> sparams, string deviceId)
- {
- var searchCriteria = new SearchCriteria(sparams.GetValueOrDefault("SearchCriteria", string.Empty));
- var sortCriteria = new SortCriteria(sparams.GetValueOrDefault("SortCriteria", string.Empty));
- 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;
- if (sparams.ContainsKey("RequestedCount") && int.TryParse(sparams["RequestedCount"], out var requestedVal) && requestedVal > 0)
- {
- requestedCount = requestedVal;
- }
- if (sparams.ContainsKey("StartingIndex") && int.TryParse(sparams["StartingIndex"], out var startVal) && startVal > 0)
- {
- start = startVal;
- }
- QueryResult<BaseItem> childrenResult;
- using (StringWriter builder = new StringWriterWithEncoding(Encoding.UTF8))
- {
- var settings = new XmlWriterSettings()
- {
- Encoding = Encoding.UTF8,
- CloseOutput = false,
- OmitXmlDeclaration = true,
- ConformanceLevel = ConformanceLevel.Fragment
- };
- using (var writer = XmlWriter.Create(builder, settings))
- {
- writer.WriteStartElement(string.Empty, "DIDL-Lite", NsDidl);
- writer.WriteAttributeString("xmlns", "dc", null, NsDc);
- writer.WriteAttributeString("xmlns", "dlna", null, NsDlna);
- writer.WriteAttributeString("xmlns", "upnp", null, NsUpnp);
- DidlBuilder.WriteXmlRootAttributes(_profile, writer);
- var serverItem = GetItemFromObjectId(sparams["ContainerID"]);
- var item = serverItem.Item;
- childrenResult = GetChildrenSorted(item, _user, searchCriteria, sortCriteria, start, requestedCount);
- var dlnaOptions = _config.GetDlnaConfiguration();
- foreach (var i in childrenResult.Items)
- {
- if (i.IsDisplayedAsFolder)
- {
- var childCount = GetChildrenSorted(i, _user, searchCriteria, sortCriteria, null, 0)
- .TotalRecordCount;
- _didlBuilder.WriteFolderElement(writer, i, null, item, childCount, filter);
- }
- else
- {
- _didlBuilder.WriteItemElement(writer, i, _user, item, serverItem.StubType, deviceId, filter);
- }
- }
- writer.WriteFullEndElement();
- }
- xmlWriter.WriteElementString("Result", builder.ToString());
- }
- xmlWriter.WriteElementString("NumberReturned", childrenResult.Items.Count.ToString(CultureInfo.InvariantCulture));
- xmlWriter.WriteElementString("TotalMatches", childrenResult.TotalRecordCount.ToString(CultureInfo.InvariantCulture));
- xmlWriter.WriteElementString("UpdateID", _systemUpdateId.ToString(CultureInfo.InvariantCulture));
- }
- /// <summary>
- /// Returns the child items meeting the criteria.
- /// </summary>
- /// <param name="item">The <see cref="BaseItem"/>.</param>
- /// <param name="user">The <see cref="User"/>.</param>
- /// <param name="search">The <see cref="SearchCriteria"/>.</param>
- /// <param name="sort">The <see cref="SortCriteria"/>.</param>
- /// <param name="startIndex">The start index.</param>
- /// <param name="limit">The maximum number to return.</param>
- /// <returns>The <see cref="QueryResult{BaseItem}"/>.</returns>
- private static QueryResult<BaseItem> GetChildrenSorted(BaseItem item, User user, SearchCriteria search, SortCriteria sort, int? startIndex, int? limit)
- {
- var folder = (Folder)item;
- var sortOrders = folder.IsPreSorted
- ? Array.Empty<(string, SortOrder)>()
- : new[] { (ItemSortBy.SortName, sort.SortOrder) };
- string[] mediaTypes = Array.Empty<string>();
- bool? isFolder = null;
- if (search.SearchType == SearchType.Audio)
- {
- mediaTypes = new[] { MediaType.Audio };
- isFolder = false;
- }
- else if (search.SearchType == SearchType.Video)
- {
- mediaTypes = new[] { MediaType.Video };
- isFolder = false;
- }
- else if (search.SearchType == SearchType.Image)
- {
- mediaTypes = new[] { MediaType.Photo };
- isFolder = false;
- }
- else if (search.SearchType == SearchType.Playlist)
- {
- // items = items.OfType<Playlist>();
- isFolder = true;
- }
- else if (search.SearchType == SearchType.MusicAlbum)
- {
- // items = items.OfType<MusicAlbum>();
- isFolder = true;
- }
- return folder.GetItems(new InternalItemsQuery
- {
- Limit = limit,
- StartIndex = startIndex,
- OrderBy = sortOrders,
- User = user,
- Recursive = true,
- IsMissing = false,
- ExcludeItemTypes = new[] { nameof(Book) },
- IsFolder = isFolder,
- MediaTypes = mediaTypes,
- DtoOptions = GetDtoOptions()
- });
- }
- /// <summary>
- /// Returns a new DtoOptions object.
- /// </summary>
- /// <returns>The <see cref="DtoOptions"/>.</returns>
- private static DtoOptions GetDtoOptions()
- {
- return new DtoOptions(true);
- }
- /// <summary>
- /// Returns the User items meeting the criteria.
- /// </summary>
- /// <param name="item">The <see cref="BaseItem"/>.</param>
- /// <param name="stubType">The <see cref="StubType"/>.</param>
- /// <param name="user">The <see cref="User"/>.</param>
- /// <param name="sort">The <see cref="SortCriteria"/>.</param>
- /// <param name="startIndex">The start index.</param>
- /// <param name="limit">The maximum number to return.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private QueryResult<ServerItem> GetUserItems(BaseItem item, StubType? stubType, User user, SortCriteria sort, int? startIndex, int? limit)
- {
- if (item is MusicGenre)
- {
- return GetMusicGenreItems(item, Guid.Empty, user, sort, startIndex, limit);
- }
- if (item is MusicArtist)
- {
- return GetMusicArtistItems(item, Guid.Empty, user, sort, startIndex, limit);
- }
- if (item is Genre)
- {
- return GetGenreItems(item, Guid.Empty, user, sort, startIndex, limit);
- }
- if ((!stubType.HasValue || stubType.Value != StubType.Folder)
- && item is IHasCollectionType collectionFolder)
- {
- if (string.Equals(CollectionType.Music, collectionFolder.CollectionType, StringComparison.OrdinalIgnoreCase))
- {
- return GetMusicFolders(item, user, stubType, sort, startIndex, limit);
- }
- else if (string.Equals(CollectionType.Movies, collectionFolder.CollectionType, StringComparison.OrdinalIgnoreCase))
- {
- return GetMovieFolders(item, user, stubType, sort, startIndex, limit);
- }
- else if (string.Equals(CollectionType.TvShows, collectionFolder.CollectionType, StringComparison.OrdinalIgnoreCase))
- {
- return GetTvFolders(item, user, stubType, sort, startIndex, limit);
- }
- else if (string.Equals(CollectionType.Folders, collectionFolder.CollectionType, StringComparison.OrdinalIgnoreCase))
- {
- return GetFolders(user, startIndex, limit);
- }
- else if (string.Equals(CollectionType.LiveTv, collectionFolder.CollectionType, StringComparison.OrdinalIgnoreCase))
- {
- return GetLiveTvChannels(user, sort, startIndex, limit);
- }
- }
- if (stubType.HasValue)
- {
- if (stubType.Value != StubType.Folder)
- {
- return ApplyPaging(new QueryResult<ServerItem>(), startIndex, limit);
- }
- }
- var folder = (Folder)item;
- var query = new InternalItemsQuery(user)
- {
- Limit = limit,
- StartIndex = startIndex,
- IsVirtualItem = false,
- ExcludeItemTypes = new[] { nameof(Book) },
- IsPlaceHolder = false,
- DtoOptions = GetDtoOptions()
- };
- SetSorting(query, sort, folder.IsPreSorted);
- var queryResult = folder.GetItems(query);
- return ToResult(queryResult);
- }
- /// <summary>
- /// Returns the Live Tv Channels meeting the criteria.
- /// </summary>
- /// <param name="user">The <see cref="User"/>.</param>
- /// <param name="sort">The <see cref="SortCriteria"/>.</param>
- /// <param name="startIndex">The start index.</param>
- /// <param name="limit">The maximum number to return.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private QueryResult<ServerItem> GetLiveTvChannels(User user, SortCriteria sort, int? startIndex, int? limit)
- {
- var query = new InternalItemsQuery(user)
- {
- StartIndex = startIndex,
- Limit = limit,
- };
- query.IncludeItemTypes = new[] { nameof(LiveTvChannel) };
- SetSorting(query, sort, false);
- var result = _libraryManager.GetItemsResult(query);
- return ToResult(result);
- }
- /// <summary>
- /// Returns the music folders meeting the criteria.
- /// </summary>
- /// <param name="item">The <see cref="BaseItem"/>.</param>
- /// <param name="user">The <see cref="User"/>.</param>
- /// <param name="stubType">The <see cref="StubType"/>.</param>
- /// <param name="sort">The <see cref="SortCriteria"/>.</param>
- /// <param name="startIndex">The start index.</param>
- /// <param name="limit">The maximum number to return.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private QueryResult<ServerItem> GetMusicFolders(BaseItem item, User user, StubType? stubType, SortCriteria sort, int? startIndex, int? limit)
- {
- var query = new InternalItemsQuery(user)
- {
- StartIndex = startIndex,
- Limit = limit
- };
- SetSorting(query, sort, false);
- if (stubType.HasValue && stubType.Value == StubType.Latest)
- {
- return GetMusicLatest(item, user, query);
- }
- if (stubType.HasValue && stubType.Value == StubType.Playlists)
- {
- return GetMusicPlaylists(user, query);
- }
- if (stubType.HasValue && stubType.Value == StubType.Albums)
- {
- return GetMusicAlbums(item, user, query);
- }
- if (stubType.HasValue && stubType.Value == StubType.Artists)
- {
- return GetMusicArtists(item, user, query);
- }
- if (stubType.HasValue && stubType.Value == StubType.AlbumArtists)
- {
- return GetMusicAlbumArtists(item, user, query);
- }
- if (stubType.HasValue && stubType.Value == StubType.FavoriteAlbums)
- {
- return GetFavoriteAlbums(item, user, query);
- }
- if (stubType.HasValue && stubType.Value == StubType.FavoriteArtists)
- {
- return GetFavoriteArtists(item, user, query);
- }
- if (stubType.HasValue && stubType.Value == StubType.FavoriteSongs)
- {
- return GetFavoriteSongs(item, user, query);
- }
- if (stubType.HasValue && stubType.Value == StubType.Songs)
- {
- return GetMusicSongs(item, user, query);
- }
- if (stubType.HasValue && stubType.Value == StubType.Genres)
- {
- return GetMusicGenres(item, user, query);
- }
- var list = new List<ServerItem>
- {
- new ServerItem(item)
- {
- StubType = StubType.Latest
- },
- new ServerItem(item)
- {
- StubType = StubType.Playlists
- },
- new ServerItem(item)
- {
- StubType = StubType.Albums
- },
- new ServerItem(item)
- {
- StubType = StubType.AlbumArtists
- },
- new ServerItem(item)
- {
- StubType = StubType.Artists
- },
- new ServerItem(item)
- {
- StubType = StubType.Songs
- },
- new ServerItem(item)
- {
- StubType = StubType.Genres
- },
- new ServerItem(item)
- {
- StubType = StubType.FavoriteArtists
- },
- new ServerItem(item)
- {
- StubType = StubType.FavoriteAlbums
- },
- new ServerItem(item)
- {
- StubType = StubType.FavoriteSongs
- }
- };
- return new QueryResult<ServerItem>
- {
- Items = list,
- TotalRecordCount = list.Count
- };
- }
- /// <summary>
- /// Returns the movie folders meeting the criteria.
- /// </summary>
- /// <param name="item">The <see cref="BaseItem"/>.</param>
- /// <param name="user">The <see cref="User"/>.</param>
- /// <param name="stubType">The <see cref="StubType"/>.</param>
- /// <param name="sort">The <see cref="SortCriteria"/>.</param>
- /// <param name="startIndex">The start index.</param>
- /// <param name="limit">The maximum number to return.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private QueryResult<ServerItem> GetMovieFolders(BaseItem item, User user, StubType? stubType, SortCriteria sort, int? startIndex, int? limit)
- {
- var query = new InternalItemsQuery(user)
- {
- StartIndex = startIndex,
- Limit = limit
- };
- SetSorting(query, sort, false);
- if (stubType.HasValue && stubType.Value == StubType.ContinueWatching)
- {
- return GetMovieContinueWatching(item, user, query);
- }
- if (stubType.HasValue && stubType.Value == StubType.Latest)
- {
- return GetMovieLatest(item, user, query);
- }
- if (stubType.HasValue && stubType.Value == StubType.Movies)
- {
- return GetMovieMovies(item, user, query);
- }
- if (stubType.HasValue && stubType.Value == StubType.Collections)
- {
- return GetMovieCollections(user, query);
- }
- if (stubType.HasValue && stubType.Value == StubType.Favorites)
- {
- return GetMovieFavorites(item, user, query);
- }
- if (stubType.HasValue && stubType.Value == StubType.Genres)
- {
- return GetGenres(item, user, query);
- }
- var array = new[]
- {
- new ServerItem(item)
- {
- StubType = StubType.ContinueWatching
- },
- new ServerItem(item)
- {
- StubType = StubType.Latest
- },
- new ServerItem(item)
- {
- StubType = StubType.Movies
- },
- new ServerItem(item)
- {
- StubType = StubType.Collections
- },
- new ServerItem(item)
- {
- StubType = StubType.Favorites
- },
- new ServerItem(item)
- {
- StubType = StubType.Genres
- }
- };
- return new QueryResult<ServerItem>
- {
- Items = array,
- TotalRecordCount = array.Length
- };
- }
- /// <summary>
- /// Returns the folders meeting the criteria.
- /// </summary>
- /// <param name="user">The <see cref="User"/>.</param>
- /// <param name="startIndex">The start index.</param>
- /// <param name="limit">The maximum number to return.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private QueryResult<ServerItem> GetFolders(User user, int? startIndex, int? limit)
- {
- var folders = _libraryManager.GetUserRootFolder().GetChildren(user, true)
- .OrderBy(i => i.SortName)
- .Select(i => new ServerItem(i)
- {
- StubType = StubType.Folder
- })
- .ToArray();
- return ApplyPaging(
- new QueryResult<ServerItem>
- {
- Items = folders,
- TotalRecordCount = folders.Length
- },
- startIndex,
- limit);
- }
- /// <summary>
- /// Returns the TV folders meeting the criteria.
- /// </summary>
- /// <param name="item">The <see cref="BaseItem"/>.</param>
- /// <param name="user">The <see cref="User"/>.</param>
- /// <param name="stubType">The <see cref="StubType"/>.</param>
- /// <param name="sort">The <see cref="SortCriteria"/>.</param>
- /// <param name="startIndex">The start index.</param>
- /// <param name="limit">The maximum number to return.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private QueryResult<ServerItem> GetTvFolders(BaseItem item, User user, StubType? stubType, SortCriteria sort, int? startIndex, int? limit)
- {
- var query = new InternalItemsQuery(user)
- {
- StartIndex = startIndex,
- Limit = limit
- };
- SetSorting(query, sort, false);
- if (stubType.HasValue && stubType.Value == StubType.ContinueWatching)
- {
- return GetMovieContinueWatching(item, user, query);
- }
- if (stubType.HasValue && stubType.Value == StubType.NextUp)
- {
- return GetNextUp(item, query);
- }
- if (stubType.HasValue && stubType.Value == StubType.Latest)
- {
- return GetTvLatest(item, user, query);
- }
- if (stubType.HasValue && stubType.Value == StubType.Series)
- {
- return GetSeries(item, user, query);
- }
- if (stubType.HasValue && stubType.Value == StubType.FavoriteSeries)
- {
- return GetFavoriteSeries(item, user, query);
- }
- if (stubType.HasValue && stubType.Value == StubType.FavoriteEpisodes)
- {
- return GetFavoriteEpisodes(item, user, query);
- }
- if (stubType.HasValue && stubType.Value == StubType.Genres)
- {
- return GetGenres(item, user, query);
- }
- var list = new List<ServerItem>
- {
- new ServerItem(item)
- {
- StubType = StubType.ContinueWatching
- },
- new ServerItem(item)
- {
- StubType = StubType.NextUp
- },
- new ServerItem(item)
- {
- StubType = StubType.Latest
- },
- new ServerItem(item)
- {
- StubType = StubType.Series
- },
- new ServerItem(item)
- {
- StubType = StubType.FavoriteSeries
- },
- new ServerItem(item)
- {
- StubType = StubType.FavoriteEpisodes
- },
- new ServerItem(item)
- {
- StubType = StubType.Genres
- }
- };
- return new QueryResult<ServerItem>
- {
- Items = list,
- TotalRecordCount = list.Count
- };
- }
- /// <summary>
- /// Returns the Movies that are part watched that meet the criteria.
- /// </summary>
- /// <param name="parent">The <see cref="BaseItem"/>.</param>
- /// <param name="user">The <see cref="User"/>.</param>
- /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private QueryResult<ServerItem> GetMovieContinueWatching(BaseItem parent, User user, InternalItemsQuery query)
- {
- query.Recursive = true;
- query.Parent = parent;
- query.SetUser(user);
- query.OrderBy = new[]
- {
- (ItemSortBy.DatePlayed, SortOrder.Descending),
- (ItemSortBy.SortName, SortOrder.Ascending)
- };
- query.IsResumable = true;
- query.Limit = 10;
- var result = _libraryManager.GetItemsResult(query);
- return ToResult(result);
- }
- /// <summary>
- /// Returns the series meeting the criteria.
- /// </summary>
- /// <param name="parent">The <see cref="BaseItem"/>.</param>
- /// <param name="user">The <see cref="User"/>.</param>
- /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private QueryResult<ServerItem> GetSeries(BaseItem parent, User user, InternalItemsQuery query)
- {
- query.Recursive = true;
- query.Parent = parent;
- query.SetUser(user);
- query.IncludeItemTypes = new[] { nameof(Series) };
- var result = _libraryManager.GetItemsResult(query);
- return ToResult(result);
- }
- /// <summary>
- /// Returns the Movie folders meeting the criteria.
- /// </summary>
- /// <param name="parent">The <see cref="BaseItem"/>.</param>
- /// <param name="user">The <see cref="User"/>.</param>
- /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private QueryResult<ServerItem> GetMovieMovies(BaseItem parent, User user, InternalItemsQuery query)
- {
- query.Recursive = true;
- query.Parent = parent;
- query.SetUser(user);
- query.IncludeItemTypes = new[] { nameof(Movie) };
- var result = _libraryManager.GetItemsResult(query);
- return ToResult(result);
- }
- /// <summary>
- /// Returns the Movie collections meeting the criteria.
- /// </summary>
- /// <param name="user">The see cref="User"/>.</param>
- /// <param name="query">The see cref="InternalItemsQuery"/>.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private QueryResult<ServerItem> GetMovieCollections(User user, InternalItemsQuery query)
- {
- query.Recursive = true;
- // query.Parent = parent;
- query.SetUser(user);
- query.IncludeItemTypes = new[] { nameof(BoxSet) };
- var result = _libraryManager.GetItemsResult(query);
- return ToResult(result);
- }
- /// <summary>
- /// Returns the Music albums meeting the criteria.
- /// </summary>
- /// <param name="parent">The <see cref="BaseItem"/>.</param>
- /// <param name="user">The <see cref="User"/>.</param>
- /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private QueryResult<ServerItem> GetMusicAlbums(BaseItem parent, User user, InternalItemsQuery query)
- {
- query.Recursive = true;
- query.Parent = parent;
- query.SetUser(user);
- query.IncludeItemTypes = new[] { nameof(MusicAlbum) };
- var result = _libraryManager.GetItemsResult(query);
- return ToResult(result);
- }
- /// <summary>
- /// Returns the Music songs meeting the criteria.
- /// </summary>
- /// <param name="parent">The <see cref="BaseItem"/>.</param>
- /// <param name="user">The <see cref="User"/>.</param>
- /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private QueryResult<ServerItem> GetMusicSongs(BaseItem parent, User user, InternalItemsQuery query)
- {
- query.Recursive = true;
- query.Parent = parent;
- query.SetUser(user);
- query.IncludeItemTypes = new[] { nameof(Audio) };
- var result = _libraryManager.GetItemsResult(query);
- return ToResult(result);
- }
- /// <summary>
- /// Returns the songs tagged as favourite that meet the criteria.
- /// </summary>
- /// <param name="parent">The <see cref="BaseItem"/>.</param>
- /// <param name="user">The <see cref="User"/>.</param>
- /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private QueryResult<ServerItem> GetFavoriteSongs(BaseItem parent, User user, InternalItemsQuery query)
- {
- query.Recursive = true;
- query.Parent = parent;
- query.SetUser(user);
- query.IsFavorite = true;
- query.IncludeItemTypes = new[] { nameof(Audio) };
- var result = _libraryManager.GetItemsResult(query);
- return ToResult(result);
- }
- /// <summary>
- /// Returns the series tagged as favourite that meet the criteria.
- /// </summary>
- /// <param name="parent">The <see cref="BaseItem"/>.</param>
- /// <param name="user">The <see cref="User"/>.</param>
- /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private QueryResult<ServerItem> GetFavoriteSeries(BaseItem parent, User user, InternalItemsQuery query)
- {
- query.Recursive = true;
- query.Parent = parent;
- query.SetUser(user);
- query.IsFavorite = true;
- query.IncludeItemTypes = new[] { nameof(Series) };
- var result = _libraryManager.GetItemsResult(query);
- return ToResult(result);
- }
- /// <summary>
- /// Returns the episodes tagged as favourite that meet the criteria.
- /// </summary>
- /// <param name="parent">The <see cref="BaseItem"/>.</param>
- /// <param name="user">The <see cref="User"/>.</param>
- /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private QueryResult<ServerItem> GetFavoriteEpisodes(BaseItem parent, User user, InternalItemsQuery query)
- {
- query.Recursive = true;
- query.Parent = parent;
- query.SetUser(user);
- query.IsFavorite = true;
- query.IncludeItemTypes = new[] { nameof(Episode) };
- var result = _libraryManager.GetItemsResult(query);
- return ToResult(result);
- }
- /// <summary>
- /// Returns the movies tagged as favourite that meet the criteria.
- /// </summary>
- /// <param name="parent">The <see cref="BaseItem"/>.</param>
- /// <param name="user">The <see cref="User"/>.</param>
- /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private QueryResult<ServerItem> GetMovieFavorites(BaseItem parent, User user, InternalItemsQuery query)
- {
- query.Recursive = true;
- query.Parent = parent;
- query.SetUser(user);
- query.IsFavorite = true;
- query.IncludeItemTypes = new[] { nameof(Movie) };
- var result = _libraryManager.GetItemsResult(query);
- return ToResult(result);
- }
- /// <summary>
- /// /// Returns the albums tagged as favourite that meet the criteria.
- /// </summary>
- /// <param name="parent">The <see cref="BaseItem"/>.</param>
- /// <param name="user">The <see cref="User"/>.</param>
- /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private QueryResult<ServerItem> GetFavoriteAlbums(BaseItem parent, User user, InternalItemsQuery query)
- {
- query.Recursive = true;
- query.Parent = parent;
- query.SetUser(user);
- query.IsFavorite = true;
- query.IncludeItemTypes = new[] { nameof(MusicAlbum) };
- var result = _libraryManager.GetItemsResult(query);
- return ToResult(result);
- }
- /// <summary>
- /// Returns the genres meeting the criteria.
- /// The GetGenres.
- /// </summary>
- /// <param name="parent">The <see cref="BaseItem"/>.</param>
- /// <param name="user">The <see cref="User"/>.</param>
- /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private QueryResult<ServerItem> GetGenres(BaseItem parent, User user, InternalItemsQuery query)
- {
- var genresResult = _libraryManager.GetGenres(new InternalItemsQuery(user)
- {
- AncestorIds = new[] { parent.Id },
- StartIndex = query.StartIndex,
- Limit = query.Limit
- });
- var result = new QueryResult<BaseItem>
- {
- TotalRecordCount = genresResult.TotalRecordCount,
- Items = genresResult.Items.Select(i => i.Item1).ToArray()
- };
- return ToResult(result);
- }
- /// <summary>
- /// Returns the music genres meeting the criteria.
- /// </summary>
- /// <param name="parent">The <see cref="BaseItem"/>.</param>
- /// <param name="user">The <see cref="User"/>.</param>
- /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private QueryResult<ServerItem> GetMusicGenres(BaseItem parent, User user, InternalItemsQuery query)
- {
- var genresResult = _libraryManager.GetMusicGenres(new InternalItemsQuery(user)
- {
- AncestorIds = new[] { parent.Id },
- StartIndex = query.StartIndex,
- Limit = query.Limit
- });
- var result = new QueryResult<BaseItem>
- {
- TotalRecordCount = genresResult.TotalRecordCount,
- Items = genresResult.Items.Select(i => i.Item1).ToArray()
- };
- return ToResult(result);
- }
- /// <summary>
- /// Returns the music albums by artist that meet the criteria.
- /// </summary>
- /// <param name="parent">The <see cref="BaseItem"/>.</param>
- /// <param name="user">The <see cref="User"/>.</param>
- /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private QueryResult<ServerItem> GetMusicAlbumArtists(BaseItem parent, User user, InternalItemsQuery query)
- {
- var artists = _libraryManager.GetAlbumArtists(new InternalItemsQuery(user)
- {
- AncestorIds = new[] { parent.Id },
- StartIndex = query.StartIndex,
- Limit = query.Limit
- });
- var result = new QueryResult<BaseItem>
- {
- TotalRecordCount = artists.TotalRecordCount,
- Items = artists.Items.Select(i => i.Item1).ToArray()
- };
- return ToResult(result);
- }
- /// <summary>
- /// Returns the music artists meeting the criteria.
- /// </summary>
- /// <param name="parent">The <see cref="BaseItem"/>.</param>
- /// <param name="user">The <see cref="User"/>.</param>
- /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private QueryResult<ServerItem> GetMusicArtists(BaseItem parent, User user, InternalItemsQuery query)
- {
- var artists = _libraryManager.GetArtists(new InternalItemsQuery(user)
- {
- AncestorIds = new[] { parent.Id },
- StartIndex = query.StartIndex,
- Limit = query.Limit
- });
- var result = new QueryResult<BaseItem>
- {
- TotalRecordCount = artists.TotalRecordCount,
- Items = artists.Items.Select(i => i.Item1).ToArray()
- };
- return ToResult(result);
- }
- /// <summary>
- /// Returns the artists tagged as favourite that meet the criteria.
- /// </summary>
- /// <param name="parent">The <see cref="BaseItem"/>.</param>
- /// <param name="user">The <see cref="User"/>.</param>
- /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private QueryResult<ServerItem> GetFavoriteArtists(BaseItem parent, User user, InternalItemsQuery query)
- {
- var artists = _libraryManager.GetArtists(new InternalItemsQuery(user)
- {
- AncestorIds = new[] { parent.Id },
- StartIndex = query.StartIndex,
- Limit = query.Limit,
- IsFavorite = true
- });
- var result = new QueryResult<BaseItem>
- {
- TotalRecordCount = artists.TotalRecordCount,
- Items = artists.Items.Select(i => i.Item1).ToArray()
- };
- return ToResult(result);
- }
- /// <summary>
- /// Returns the music playlists meeting the criteria.
- /// </summary>
- /// <param name="user">The user<see cref="User"/>.</param>
- /// <param name="query">The query<see cref="InternalItemsQuery"/>.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private QueryResult<ServerItem> GetMusicPlaylists(User user, InternalItemsQuery query)
- {
- query.Parent = null;
- query.IncludeItemTypes = new[] { nameof(Playlist) };
- query.SetUser(user);
- query.Recursive = true;
- var result = _libraryManager.GetItemsResult(query);
- return ToResult(result);
- }
- /// <summary>
- /// Returns the latest music meeting the criteria.
- /// </summary>
- /// <param name="parent">The <see cref="BaseItem"/>.</param>
- /// <param name="user">The <see cref="User"/>.</param>
- /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private QueryResult<ServerItem> GetMusicLatest(BaseItem parent, User user, InternalItemsQuery query)
- {
- query.OrderBy = Array.Empty<(string, SortOrder)>();
- var items = _userViewManager.GetLatestItems(
- new LatestItemsQuery
- {
- UserId = user.Id,
- Limit = 50,
- IncludeItemTypes = new[] { nameof(Audio) },
- ParentId = parent?.Id ?? Guid.Empty,
- GroupItems = true
- },
- query.DtoOptions).Select(i => i.Item1 ?? i.Item2.FirstOrDefault()).Where(i => i != null).ToArray();
- return ToResult(items);
- }
- /// <summary>
- /// Returns the next up item meeting the criteria.
- /// </summary>
- /// <param name="parent">The <see cref="BaseItem"/>.</param>
- /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private QueryResult<ServerItem> GetNextUp(BaseItem parent, InternalItemsQuery query)
- {
- query.OrderBy = Array.Empty<(string, SortOrder)>();
- var result = _tvSeriesManager.GetNextUp(
- new NextUpQuery
- {
- Limit = query.Limit,
- StartIndex = query.StartIndex,
- UserId = query.User.Id
- },
- new[] { parent },
- query.DtoOptions);
- return ToResult(result);
- }
- /// <summary>
- /// Returns the latest tv meeting the criteria.
- /// </summary>
- /// <param name="parent">The <see cref="BaseItem"/>.</param>
- /// <param name="user">The <see cref="User"/>.</param>
- /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private QueryResult<ServerItem> GetTvLatest(BaseItem parent, User user, InternalItemsQuery query)
- {
- query.OrderBy = Array.Empty<(string, SortOrder)>();
- var items = _userViewManager.GetLatestItems(
- new LatestItemsQuery
- {
- UserId = user.Id,
- Limit = 50,
- IncludeItemTypes = new[] { nameof(Episode) },
- ParentId = parent == null ? Guid.Empty : parent.Id,
- GroupItems = false
- },
- query.DtoOptions).Select(i => i.Item1 ?? i.Item2.FirstOrDefault()).Where(i => i != null).ToArray();
- return ToResult(items);
- }
- /// <summary>
- /// Returns the latest movies meeting the criteria.
- /// </summary>
- /// <param name="parent">The <see cref="BaseItem"/>.</param>
- /// <param name="user">The <see cref="User"/>.</param>
- /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private QueryResult<ServerItem> GetMovieLatest(BaseItem parent, User user, InternalItemsQuery query)
- {
- query.OrderBy = Array.Empty<(string, SortOrder)>();
- var items = _userViewManager.GetLatestItems(
- new LatestItemsQuery
- {
- UserId = user.Id,
- Limit = 50,
- IncludeItemTypes = new[] { nameof(Movie) },
- ParentId = parent?.Id ?? Guid.Empty,
- GroupItems = true
- },
- query.DtoOptions).Select(i => i.Item1 ?? i.Item2.FirstOrDefault()).Where(i => i != null).ToArray();
- return ToResult(items);
- }
- /// <summary>
- /// Returns music artist items that meet the criteria.
- /// </summary>
- /// <param name="item">The <see cref="BaseItem"/>.</param>
- /// <param name="parentId">The <see cref="Guid"/>.</param>
- /// <param name="user">The <see cref="User"/>.</param>
- /// <param name="sort">The <see cref="SortCriteria"/>.</param>
- /// <param name="startIndex">The start index.</param>
- /// <param name="limit">The maximum number to return.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private QueryResult<ServerItem> GetMusicArtistItems(BaseItem item, Guid parentId, User user, SortCriteria sort, int? startIndex, int? limit)
- {
- var query = new InternalItemsQuery(user)
- {
- Recursive = true,
- ParentId = parentId,
- ArtistIds = new[] { item.Id },
- IncludeItemTypes = new[] { nameof(MusicAlbum) },
- Limit = limit,
- StartIndex = startIndex,
- DtoOptions = GetDtoOptions()
- };
- SetSorting(query, sort, false);
- var result = _libraryManager.GetItemsResult(query);
- return ToResult(result);
- }
- /// <summary>
- /// Returns the genre items meeting the criteria.
- /// </summary>
- /// <param name="item">The <see cref="BaseItem"/>.</param>
- /// <param name="parentId">The <see cref="Guid"/>.</param>
- /// <param name="user">The <see cref="User"/>.</param>
- /// <param name="sort">The <see cref="SortCriteria"/>.</param>
- /// <param name="startIndex">The start index.</param>
- /// <param name="limit">The maximum number to return.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private QueryResult<ServerItem> GetGenreItems(BaseItem item, Guid parentId, User user, SortCriteria sort, int? startIndex, int? limit)
- {
- var query = new InternalItemsQuery(user)
- {
- Recursive = true,
- ParentId = parentId,
- GenreIds = new[] { item.Id },
- IncludeItemTypes = new[]
- {
- nameof(Movie),
- nameof(Series)
- },
- Limit = limit,
- StartIndex = startIndex,
- DtoOptions = GetDtoOptions()
- };
- SetSorting(query, sort, false);
- var result = _libraryManager.GetItemsResult(query);
- return ToResult(result);
- }
- /// <summary>
- /// Returns the music genre items meeting the criteria.
- /// </summary>
- /// <param name="item">The <see cref="BaseItem"/>.</param>
- /// <param name="parentId">The <see cref="Guid"/>.</param>
- /// <param name="user">The <see cref="User"/>.</param>
- /// <param name="sort">The <see cref="SortCriteria"/>.</param>
- /// <param name="startIndex">The start index.</param>
- /// <param name="limit">The maximum number to return.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private QueryResult<ServerItem> GetMusicGenreItems(BaseItem item, Guid parentId, User user, SortCriteria sort, int? startIndex, int? limit)
- {
- var query = new InternalItemsQuery(user)
- {
- Recursive = true,
- ParentId = parentId,
- GenreIds = new[] { item.Id },
- IncludeItemTypes = new[] { nameof(MusicAlbum) },
- Limit = limit,
- StartIndex = startIndex,
- DtoOptions = GetDtoOptions()
- };
- SetSorting(query, sort, false);
- var result = _libraryManager.GetItemsResult(query);
- return ToResult(result);
- }
- /// <summary>
- /// Converts a <see cref="BaseItem"/> array into a <see cref="QueryResult{ServerItem}"/>.
- /// </summary>
- /// <param name="result">An array of <see cref="BaseItem"/>.</param>
- /// <returns>A <see cref="QueryResult{ServerItem}"/>.</returns>
- private static QueryResult<ServerItem> ToResult(BaseItem[] result)
- {
- var serverItems = result
- .Select(i => new ServerItem(i))
- .ToArray();
- return new QueryResult<ServerItem>
- {
- TotalRecordCount = result.Length,
- Items = serverItems
- };
- }
- /// <summary>
- /// Converts a <see cref="QueryResult{BaseItem}"/> to a <see cref="QueryResult{ServerItem}"/>.
- /// </summary>
- /// <param name="result">A <see cref="QueryResult{BaseItem}"/>.</param>
- /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
- private static QueryResult<ServerItem> ToResult(QueryResult<BaseItem> result)
- {
- var serverItems = result
- .Items
- .Select(i => new ServerItem(i))
- .ToArray();
- return new QueryResult<ServerItem>
- {
- TotalRecordCount = result.TotalRecordCount,
- Items = serverItems
- };
- }
- /// <summary>
- /// Sets the sorting method on a query.
- /// </summary>
- /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
- /// <param name="sort">The <see cref="SortCriteria"/>.</param>
- /// <param name="isPreSorted">True if pre-sorted.</param>
- private static void SetSorting(InternalItemsQuery query, SortCriteria sort, bool isPreSorted)
- {
- if (isPreSorted)
- {
- query.OrderBy = Array.Empty<(string, SortOrder)>();
- }
- else
- {
- query.OrderBy = new[] { (ItemSortBy.SortName, sort.SortOrder) };
- }
- }
- /// <summary>
- /// Apply paging to a query.
- /// </summary>
- /// <param name="result">The <see cref="QueryResult{ServerItem}"/>.</param>
- /// <param name="startIndex">The start index.</param>
- /// <param name="limit">The maximum number to return.</param>
- /// <returns>A <see cref="QueryResult{ServerItem}"/>.</returns>
- private static QueryResult<ServerItem> ApplyPaging(QueryResult<ServerItem> result, int? startIndex, int? limit)
- {
- result.Items = result.Items.Skip(startIndex ?? 0).Take(limit ?? int.MaxValue).ToArray();
- return result;
- }
- /// <summary>
- /// Retrieves the ServerItem id.
- /// </summary>
- /// <param name="id">The id<see cref="string"/>.</param>
- /// <returns>The <see cref="ServerItem"/>.</returns>
- private ServerItem GetItemFromObjectId(string id)
- {
- return DidlBuilder.IsIdRoot(id)
- ? new ServerItem(_libraryManager.GetUserRootFolder())
- : ParseItemId(id);
- }
- /// <summary>
- /// Parses the item id into a <see cref="ServerItem"/>.
- /// </summary>
- /// <param name="id">The <see cref="string"/>.</param>
- /// <returns>The corresponding <see cref="ServerItem"/>.</returns>
- private ServerItem ParseItemId(string id)
- {
- StubType? stubType = null;
- // After using PlayTo, MediaMonkey sends a request to the server trying to get item info
- const string ParamsSrch = "Params=";
- var paramsIndex = id.IndexOf(ParamsSrch, StringComparison.OrdinalIgnoreCase);
- if (paramsIndex != -1)
- {
- id = id.Substring(paramsIndex + ParamsSrch.Length);
- var parts = id.Split(';');
- id = parts[23];
- }
- var enumNames = Enum.GetNames(typeof(StubType));
- foreach (var name in enumNames)
- {
- if (id.StartsWith(name + "_", StringComparison.OrdinalIgnoreCase))
- {
- stubType = Enum.Parse<StubType>(name, true);
- id = id.Split('_', 2)[1];
- break;
- }
- }
- if (Guid.TryParse(id, out var itemId))
- {
- var item = _libraryManager.GetItemById(itemId);
- return new ServerItem(item)
- {
- StubType = stubType
- };
- }
- Logger.LogError("Error parsing item Id: {Id}. Returning user root folder.", id);
- return new ServerItem(_libraryManager.GetUserRootFolder());
- }
- }
- }
|