123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716 |
- 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());
- }
- }
- }
|