ControlHandler.cs 67 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716
  1. using System;
  2. using System.Collections.Generic;
  3. using System.Globalization;
  4. using System.IO;
  5. using System.Linq;
  6. using System.Text;
  7. using System.Threading;
  8. using System.Xml;
  9. using Emby.Dlna.Didl;
  10. using Emby.Dlna.Service;
  11. using Jellyfin.Data.Entities;
  12. using Jellyfin.Data.Enums;
  13. using MediaBrowser.Common.Extensions;
  14. using MediaBrowser.Controller.Configuration;
  15. using MediaBrowser.Controller.Drawing;
  16. using MediaBrowser.Controller.Dto;
  17. using MediaBrowser.Controller.Entities;
  18. using MediaBrowser.Controller.Entities.Audio;
  19. using MediaBrowser.Controller.Entities.Movies;
  20. using MediaBrowser.Controller.Library;
  21. using MediaBrowser.Controller.LiveTv;
  22. using MediaBrowser.Controller.MediaEncoding;
  23. using MediaBrowser.Controller.Playlists;
  24. using MediaBrowser.Controller.TV;
  25. using MediaBrowser.Model.Dlna;
  26. using MediaBrowser.Model.Entities;
  27. using MediaBrowser.Model.Globalization;
  28. using MediaBrowser.Model.Querying;
  29. using Microsoft.Extensions.Logging;
  30. using Book = MediaBrowser.Controller.Entities.Book;
  31. using Episode = MediaBrowser.Controller.Entities.TV.Episode;
  32. using Genre = MediaBrowser.Controller.Entities.Genre;
  33. using Movie = MediaBrowser.Controller.Entities.Movies.Movie;
  34. using MusicAlbum = MediaBrowser.Controller.Entities.Audio.MusicAlbum;
  35. using Series = MediaBrowser.Controller.Entities.TV.Series;
  36. namespace Emby.Dlna.ContentDirectory
  37. {
  38. /// <summary>
  39. /// Defines the <see cref="ControlHandler" />.
  40. /// </summary>
  41. public class ControlHandler : BaseControlHandler
  42. {
  43. private const string NsDc = "http://purl.org/dc/elements/1.1/";
  44. private const string NsDidl = "urn:schemas-upnp-org:metadata-1-0/DIDL-Lite/";
  45. private const string NsDlna = "urn:schemas-dlna-org:metadata-1-0/";
  46. private const string NsUpnp = "urn:schemas-upnp-org:metadata-1-0/upnp/";
  47. private readonly ILibraryManager _libraryManager;
  48. private readonly IUserDataManager _userDataManager;
  49. private readonly IServerConfigurationManager _config;
  50. private readonly User _user;
  51. private readonly IUserViewManager _userViewManager;
  52. private readonly ITVSeriesManager _tvSeriesManager;
  53. private readonly int _systemUpdateId;
  54. private readonly DidlBuilder _didlBuilder;
  55. private readonly DeviceProfile _profile;
  56. /// <summary>
  57. /// Initializes a new instance of the <see cref="ControlHandler"/> class.
  58. /// </summary>
  59. /// <param name="logger">The <see cref="ILogger"/> for use with the <see cref="ControlHandler"/> instance.</param>
  60. /// <param name="libraryManager">The <see cref="ILibraryManager"/> for use with the <see cref="ControlHandler"/> instance.</param>
  61. /// <param name="profile">The <see cref="DeviceProfile"/> for use with the <see cref="ControlHandler"/> instance.</param>
  62. /// <param name="serverAddress">The server address to use in this instance> for use with the <see cref="ControlHandler"/> instance.</param>
  63. /// <param name="accessToken">The <see cref="string"/> for use with the <see cref="ControlHandler"/> instance.</param>
  64. /// <param name="imageProcessor">The <see cref="IImageProcessor"/> for use with the <see cref="ControlHandler"/> instance.</param>
  65. /// <param name="userDataManager">The <see cref="IUserDataManager"/> for use with the <see cref="ControlHandler"/> instance.</param>
  66. /// <param name="user">The <see cref="User"/> for use with the <see cref="ControlHandler"/> instance.</param>
  67. /// <param name="systemUpdateId">The system id for use with the <see cref="ControlHandler"/> instance.</param>
  68. /// <param name="config">The <see cref="IServerConfigurationManager"/> for use with the <see cref="ControlHandler"/> instance.</param>
  69. /// <param name="localization">The <see cref="ILocalizationManager"/> for use with the <see cref="ControlHandler"/> instance.</param>
  70. /// <param name="mediaSourceManager">The <see cref="IMediaSourceManager"/> for use with the <see cref="ControlHandler"/> instance.</param>
  71. /// <param name="userViewManager">The <see cref="IUserViewManager"/> for use with the <see cref="ControlHandler"/> instance.</param>
  72. /// <param name="mediaEncoder">The <see cref="IMediaEncoder"/> for use with the <see cref="ControlHandler"/> instance.</param>
  73. /// <param name="tvSeriesManager">The <see cref="ITVSeriesManager"/> for use with the <see cref="ControlHandler"/> instance.</param>
  74. public ControlHandler(
  75. ILogger logger,
  76. ILibraryManager libraryManager,
  77. DeviceProfile profile,
  78. string serverAddress,
  79. string accessToken,
  80. IImageProcessor imageProcessor,
  81. IUserDataManager userDataManager,
  82. User user,
  83. int systemUpdateId,
  84. IServerConfigurationManager config,
  85. ILocalizationManager localization,
  86. IMediaSourceManager mediaSourceManager,
  87. IUserViewManager userViewManager,
  88. IMediaEncoder mediaEncoder,
  89. ITVSeriesManager tvSeriesManager)
  90. : base(config, logger)
  91. {
  92. _libraryManager = libraryManager;
  93. _userDataManager = userDataManager;
  94. _user = user;
  95. _systemUpdateId = systemUpdateId;
  96. _userViewManager = userViewManager;
  97. _tvSeriesManager = tvSeriesManager;
  98. _profile = profile;
  99. _config = config;
  100. _didlBuilder = new DidlBuilder(
  101. profile,
  102. user,
  103. imageProcessor,
  104. serverAddress,
  105. accessToken,
  106. userDataManager,
  107. localization,
  108. mediaSourceManager,
  109. Logger,
  110. mediaEncoder,
  111. libraryManager);
  112. }
  113. /// <inheritdoc />
  114. protected override void WriteResult(string methodName, IReadOnlyDictionary<string, string> methodParams, XmlWriter xmlWriter)
  115. {
  116. if (xmlWriter == null)
  117. {
  118. throw new ArgumentNullException(nameof(xmlWriter));
  119. }
  120. if (methodParams == null)
  121. {
  122. throw new ArgumentNullException(nameof(methodParams));
  123. }
  124. const string DeviceId = "test";
  125. if (string.Equals(methodName, "GetSearchCapabilities", StringComparison.OrdinalIgnoreCase))
  126. {
  127. HandleGetSearchCapabilities(xmlWriter);
  128. return;
  129. }
  130. if (string.Equals(methodName, "GetSortCapabilities", StringComparison.OrdinalIgnoreCase))
  131. {
  132. HandleGetSortCapabilities(xmlWriter);
  133. return;
  134. }
  135. if (string.Equals(methodName, "GetSortExtensionCapabilities", StringComparison.OrdinalIgnoreCase))
  136. {
  137. HandleGetSortExtensionCapabilities(xmlWriter);
  138. return;
  139. }
  140. if (string.Equals(methodName, "GetSystemUpdateID", StringComparison.OrdinalIgnoreCase))
  141. {
  142. HandleGetSystemUpdateID(xmlWriter);
  143. return;
  144. }
  145. if (string.Equals(methodName, "Browse", StringComparison.OrdinalIgnoreCase))
  146. {
  147. HandleBrowse(xmlWriter, methodParams, DeviceId);
  148. return;
  149. }
  150. if (string.Equals(methodName, "X_GetFeatureList", StringComparison.OrdinalIgnoreCase))
  151. {
  152. HandleXGetFeatureList(xmlWriter);
  153. return;
  154. }
  155. if (string.Equals(methodName, "GetFeatureList", StringComparison.OrdinalIgnoreCase))
  156. {
  157. HandleGetFeatureList(xmlWriter);
  158. return;
  159. }
  160. if (string.Equals(methodName, "X_SetBookmark", StringComparison.OrdinalIgnoreCase))
  161. {
  162. HandleXSetBookmark(methodParams);
  163. return;
  164. }
  165. if (string.Equals(methodName, "Search", StringComparison.OrdinalIgnoreCase))
  166. {
  167. HandleSearch(xmlWriter, methodParams, DeviceId);
  168. return;
  169. }
  170. if (string.Equals(methodName, "X_BrowseByLetter", StringComparison.OrdinalIgnoreCase))
  171. {
  172. HandleXBrowseByLetter(xmlWriter, methodParams, DeviceId);
  173. return;
  174. }
  175. throw new ResourceNotFoundException("Unexpected control request name: " + methodName);
  176. }
  177. /// <summary>
  178. /// Adds a "XSetBookmark" element to the xml document.
  179. /// </summary>
  180. /// <param name="sparams">The method parameters.</param>
  181. private void HandleXSetBookmark(IReadOnlyDictionary<string, string> sparams)
  182. {
  183. var id = sparams["ObjectID"];
  184. var serverItem = GetItemFromObjectId(id);
  185. var item = serverItem.Item;
  186. var newbookmark = int.Parse(sparams["PosSecond"], CultureInfo.InvariantCulture);
  187. var userdata = _userDataManager.GetUserData(_user, item);
  188. userdata.PlaybackPositionTicks = TimeSpan.FromSeconds(newbookmark).Ticks;
  189. _userDataManager.SaveUserData(
  190. _user,
  191. item,
  192. userdata,
  193. UserDataSaveReason.TogglePlayed,
  194. CancellationToken.None);
  195. }
  196. /// <summary>
  197. /// Adds the "SearchCaps" element to the xml document.
  198. /// </summary>
  199. /// <param name="xmlWriter">The <see cref="XmlWriter"/>.</param>
  200. private static void HandleGetSearchCapabilities(XmlWriter xmlWriter)
  201. {
  202. xmlWriter.WriteElementString(
  203. "SearchCaps",
  204. "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");
  205. }
  206. /// <summary>
  207. /// Adds the "SortCaps" element to the xml document.
  208. /// </summary>
  209. /// <param name="xmlWriter">The <see cref="XmlWriter"/>.</param>
  210. private static void HandleGetSortCapabilities(XmlWriter xmlWriter)
  211. {
  212. xmlWriter.WriteElementString(
  213. "SortCaps",
  214. "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");
  215. }
  216. /// <summary>
  217. /// Adds the "SortExtensionCaps" element to the xml document.
  218. /// </summary>
  219. /// <param name="xmlWriter">The <see cref="XmlWriter"/>.</param>
  220. private static void HandleGetSortExtensionCapabilities(XmlWriter xmlWriter)
  221. {
  222. xmlWriter.WriteElementString(
  223. "SortExtensionCaps",
  224. "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");
  225. }
  226. /// <summary>
  227. /// Adds the "Id" element to the xml document.
  228. /// </summary>
  229. /// <param name="xmlWriter">The <see cref="XmlWriter"/>.</param>
  230. private void HandleGetSystemUpdateID(XmlWriter xmlWriter)
  231. {
  232. xmlWriter.WriteElementString("Id", _systemUpdateId.ToString(CultureInfo.InvariantCulture));
  233. }
  234. /// <summary>
  235. /// Adds the "FeatureList" element to the xml document.
  236. /// </summary>
  237. /// <param name="xmlWriter">The <see cref="XmlWriter"/>.</param>
  238. private static void HandleGetFeatureList(XmlWriter xmlWriter)
  239. {
  240. xmlWriter.WriteElementString("FeatureList", WriteFeatureListXml());
  241. }
  242. /// <summary>
  243. /// Adds the "FeatureList" element to the xml document.
  244. /// </summary>
  245. /// <param name="xmlWriter">The <see cref="XmlWriter"/>.</param>
  246. private static void HandleXGetFeatureList(XmlWriter xmlWriter)
  247. => HandleGetFeatureList(xmlWriter);
  248. /// <summary>
  249. /// Builds a static feature list.
  250. /// </summary>
  251. /// <returns>The xml feature list.</returns>
  252. private static string WriteFeatureListXml()
  253. {
  254. // TODO: clean this up
  255. var builder = new StringBuilder();
  256. builder.Append("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
  257. 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\">");
  258. builder.Append("<Feature name=\"samsung.com_BASICVIEW\" version=\"1\">");
  259. builder.Append("<container id=\"I\" type=\"object.item.imageItem\"/>");
  260. builder.Append("<container id=\"A\" type=\"object.item.audioItem\"/>");
  261. builder.Append("<container id=\"V\" type=\"object.item.videoItem\"/>");
  262. builder.Append("</Feature>");
  263. builder.Append("</Features>");
  264. return builder.ToString();
  265. }
  266. /// <summary>
  267. /// Builds the "Browse" xml response.
  268. /// </summary>
  269. /// <param name="xmlWriter">The <see cref="XmlWriter"/>.</param>
  270. /// <param name="sparams">The method parameters.</param>
  271. /// <param name="deviceId">The device Id to use.</param>
  272. private void HandleBrowse(XmlWriter xmlWriter, IReadOnlyDictionary<string, string> sparams, string deviceId)
  273. {
  274. var id = sparams["ObjectID"];
  275. var flag = sparams["BrowseFlag"];
  276. var filter = new Filter(sparams.GetValueOrDefault("Filter", "*"));
  277. var sortCriteria = new SortCriteria(sparams.GetValueOrDefault("SortCriteria", string.Empty));
  278. var provided = 0;
  279. // Default to null instead of 0
  280. // Upnp inspector sends 0 as requestedCount when it wants everything
  281. int? requestedCount = null;
  282. int? start = 0;
  283. if (sparams.ContainsKey("RequestedCount") && int.TryParse(sparams["RequestedCount"], out var requestedVal) && requestedVal > 0)
  284. {
  285. requestedCount = requestedVal;
  286. }
  287. if (sparams.ContainsKey("StartingIndex") && int.TryParse(sparams["StartingIndex"], out var startVal) && startVal > 0)
  288. {
  289. start = startVal;
  290. }
  291. int totalCount;
  292. using (StringWriter builder = new StringWriterWithEncoding(Encoding.UTF8))
  293. {
  294. var settings = new XmlWriterSettings()
  295. {
  296. Encoding = Encoding.UTF8,
  297. CloseOutput = false,
  298. OmitXmlDeclaration = true,
  299. ConformanceLevel = ConformanceLevel.Fragment
  300. };
  301. using (var writer = XmlWriter.Create(builder, settings))
  302. {
  303. writer.WriteStartElement(string.Empty, "DIDL-Lite", NsDidl);
  304. writer.WriteAttributeString("xmlns", "dc", null, NsDc);
  305. writer.WriteAttributeString("xmlns", "dlna", null, NsDlna);
  306. writer.WriteAttributeString("xmlns", "upnp", null, NsUpnp);
  307. DidlBuilder.WriteXmlRootAttributes(_profile, writer);
  308. var serverItem = GetItemFromObjectId(id);
  309. var item = serverItem.Item;
  310. if (string.Equals(flag, "BrowseMetadata", StringComparison.Ordinal))
  311. {
  312. totalCount = 1;
  313. if (item.IsDisplayedAsFolder || serverItem.StubType.HasValue)
  314. {
  315. var childrenResult = GetUserItems(item, serverItem.StubType, _user, sortCriteria, start, requestedCount);
  316. _didlBuilder.WriteFolderElement(writer, item, serverItem.StubType, null, childrenResult.TotalRecordCount, filter, id);
  317. }
  318. else
  319. {
  320. _didlBuilder.WriteItemElement(writer, item, _user, null, null, deviceId, filter);
  321. }
  322. provided++;
  323. }
  324. else
  325. {
  326. var childrenResult = GetUserItems(item, serverItem.StubType, _user, sortCriteria, start, requestedCount);
  327. totalCount = childrenResult.TotalRecordCount;
  328. provided = childrenResult.Items.Count;
  329. foreach (var i in childrenResult.Items)
  330. {
  331. var childItem = i.Item;
  332. var displayStubType = i.StubType;
  333. if (childItem.IsDisplayedAsFolder || displayStubType.HasValue)
  334. {
  335. var childCount = GetUserItems(childItem, displayStubType, _user, sortCriteria, null, 0)
  336. .TotalRecordCount;
  337. _didlBuilder.WriteFolderElement(writer, childItem, displayStubType, item, childCount, filter);
  338. }
  339. else
  340. {
  341. _didlBuilder.WriteItemElement(writer, childItem, _user, item, serverItem.StubType, deviceId, filter);
  342. }
  343. }
  344. }
  345. writer.WriteFullEndElement();
  346. }
  347. xmlWriter.WriteElementString("Result", builder.ToString());
  348. }
  349. xmlWriter.WriteElementString("NumberReturned", provided.ToString(CultureInfo.InvariantCulture));
  350. xmlWriter.WriteElementString("TotalMatches", totalCount.ToString(CultureInfo.InvariantCulture));
  351. xmlWriter.WriteElementString("UpdateID", _systemUpdateId.ToString(CultureInfo.InvariantCulture));
  352. }
  353. /// <summary>
  354. /// Builds the response to the "X_BrowseByLetter request.
  355. /// </summary>
  356. /// <param name="xmlWriter">The <see cref="XmlWriter"/>.</param>
  357. /// <param name="sparams">The method parameters.</param>
  358. /// <param name="deviceId">The device id.</param>
  359. private void HandleXBrowseByLetter(XmlWriter xmlWriter, IReadOnlyDictionary<string, string> sparams, string deviceId)
  360. {
  361. // TODO: Implement this method
  362. HandleSearch(xmlWriter, sparams, deviceId);
  363. }
  364. /// <summary>
  365. /// Builds a response to the "Search" request.
  366. /// </summary>
  367. /// <param name="xmlWriter">The xmlWriter<see cref="XmlWriter"/>.</param>
  368. /// <param name="sparams">The method parameters.</param>
  369. /// <param name="deviceId">The deviceId<see cref="string"/>.</param>
  370. private void HandleSearch(XmlWriter xmlWriter, IReadOnlyDictionary<string, string> sparams, string deviceId)
  371. {
  372. var searchCriteria = new SearchCriteria(sparams.GetValueOrDefault("SearchCriteria", string.Empty));
  373. var sortCriteria = new SortCriteria(sparams.GetValueOrDefault("SortCriteria", string.Empty));
  374. var filter = new Filter(sparams.GetValueOrDefault("Filter", "*"));
  375. // sort example: dc:title, dc:date
  376. // Default to null instead of 0
  377. // Upnp inspector sends 0 as requestedCount when it wants everything
  378. int? requestedCount = null;
  379. int? start = 0;
  380. if (sparams.ContainsKey("RequestedCount") && int.TryParse(sparams["RequestedCount"], out var requestedVal) && requestedVal > 0)
  381. {
  382. requestedCount = requestedVal;
  383. }
  384. if (sparams.ContainsKey("StartingIndex") && int.TryParse(sparams["StartingIndex"], out var startVal) && startVal > 0)
  385. {
  386. start = startVal;
  387. }
  388. QueryResult<BaseItem> childrenResult;
  389. using (StringWriter builder = new StringWriterWithEncoding(Encoding.UTF8))
  390. {
  391. var settings = new XmlWriterSettings()
  392. {
  393. Encoding = Encoding.UTF8,
  394. CloseOutput = false,
  395. OmitXmlDeclaration = true,
  396. ConformanceLevel = ConformanceLevel.Fragment
  397. };
  398. using (var writer = XmlWriter.Create(builder, settings))
  399. {
  400. writer.WriteStartElement(string.Empty, "DIDL-Lite", NsDidl);
  401. writer.WriteAttributeString("xmlns", "dc", null, NsDc);
  402. writer.WriteAttributeString("xmlns", "dlna", null, NsDlna);
  403. writer.WriteAttributeString("xmlns", "upnp", null, NsUpnp);
  404. DidlBuilder.WriteXmlRootAttributes(_profile, writer);
  405. var serverItem = GetItemFromObjectId(sparams["ContainerID"]);
  406. var item = serverItem.Item;
  407. childrenResult = GetChildrenSorted(item, _user, searchCriteria, sortCriteria, start, requestedCount);
  408. var dlnaOptions = _config.GetDlnaConfiguration();
  409. foreach (var i in childrenResult.Items)
  410. {
  411. if (i.IsDisplayedAsFolder)
  412. {
  413. var childCount = GetChildrenSorted(i, _user, searchCriteria, sortCriteria, null, 0)
  414. .TotalRecordCount;
  415. _didlBuilder.WriteFolderElement(writer, i, null, item, childCount, filter);
  416. }
  417. else
  418. {
  419. _didlBuilder.WriteItemElement(writer, i, _user, item, serverItem.StubType, deviceId, filter);
  420. }
  421. }
  422. writer.WriteFullEndElement();
  423. }
  424. xmlWriter.WriteElementString("Result", builder.ToString());
  425. }
  426. xmlWriter.WriteElementString("NumberReturned", childrenResult.Items.Count.ToString(CultureInfo.InvariantCulture));
  427. xmlWriter.WriteElementString("TotalMatches", childrenResult.TotalRecordCount.ToString(CultureInfo.InvariantCulture));
  428. xmlWriter.WriteElementString("UpdateID", _systemUpdateId.ToString(CultureInfo.InvariantCulture));
  429. }
  430. /// <summary>
  431. /// Returns the child items meeting the criteria.
  432. /// </summary>
  433. /// <param name="item">The <see cref="BaseItem"/>.</param>
  434. /// <param name="user">The <see cref="User"/>.</param>
  435. /// <param name="search">The <see cref="SearchCriteria"/>.</param>
  436. /// <param name="sort">The <see cref="SortCriteria"/>.</param>
  437. /// <param name="startIndex">The start index.</param>
  438. /// <param name="limit">The maximum number to return.</param>
  439. /// <returns>The <see cref="QueryResult{BaseItem}"/>.</returns>
  440. private static QueryResult<BaseItem> GetChildrenSorted(BaseItem item, User user, SearchCriteria search, SortCriteria sort, int? startIndex, int? limit)
  441. {
  442. var folder = (Folder)item;
  443. var sortOrders = folder.IsPreSorted
  444. ? Array.Empty<(string, SortOrder)>()
  445. : new[] { (ItemSortBy.SortName, sort.SortOrder) };
  446. string[] mediaTypes = Array.Empty<string>();
  447. bool? isFolder = null;
  448. if (search.SearchType == SearchType.Audio)
  449. {
  450. mediaTypes = new[] { MediaType.Audio };
  451. isFolder = false;
  452. }
  453. else if (search.SearchType == SearchType.Video)
  454. {
  455. mediaTypes = new[] { MediaType.Video };
  456. isFolder = false;
  457. }
  458. else if (search.SearchType == SearchType.Image)
  459. {
  460. mediaTypes = new[] { MediaType.Photo };
  461. isFolder = false;
  462. }
  463. else if (search.SearchType == SearchType.Playlist)
  464. {
  465. // items = items.OfType<Playlist>();
  466. isFolder = true;
  467. }
  468. else if (search.SearchType == SearchType.MusicAlbum)
  469. {
  470. // items = items.OfType<MusicAlbum>();
  471. isFolder = true;
  472. }
  473. return folder.GetItems(new InternalItemsQuery
  474. {
  475. Limit = limit,
  476. StartIndex = startIndex,
  477. OrderBy = sortOrders,
  478. User = user,
  479. Recursive = true,
  480. IsMissing = false,
  481. ExcludeItemTypes = new[] { nameof(Book) },
  482. IsFolder = isFolder,
  483. MediaTypes = mediaTypes,
  484. DtoOptions = GetDtoOptions()
  485. });
  486. }
  487. /// <summary>
  488. /// Returns a new DtoOptions object.
  489. /// </summary>
  490. /// <returns>The <see cref="DtoOptions"/>.</returns>
  491. private static DtoOptions GetDtoOptions()
  492. {
  493. return new DtoOptions(true);
  494. }
  495. /// <summary>
  496. /// Returns the User items meeting the criteria.
  497. /// </summary>
  498. /// <param name="item">The <see cref="BaseItem"/>.</param>
  499. /// <param name="stubType">The <see cref="StubType"/>.</param>
  500. /// <param name="user">The <see cref="User"/>.</param>
  501. /// <param name="sort">The <see cref="SortCriteria"/>.</param>
  502. /// <param name="startIndex">The start index.</param>
  503. /// <param name="limit">The maximum number to return.</param>
  504. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  505. private QueryResult<ServerItem> GetUserItems(BaseItem item, StubType? stubType, User user, SortCriteria sort, int? startIndex, int? limit)
  506. {
  507. if (item is MusicGenre)
  508. {
  509. return GetMusicGenreItems(item, Guid.Empty, user, sort, startIndex, limit);
  510. }
  511. if (item is MusicArtist)
  512. {
  513. return GetMusicArtistItems(item, Guid.Empty, user, sort, startIndex, limit);
  514. }
  515. if (item is Genre)
  516. {
  517. return GetGenreItems(item, Guid.Empty, user, sort, startIndex, limit);
  518. }
  519. if ((!stubType.HasValue || stubType.Value != StubType.Folder)
  520. && item is IHasCollectionType collectionFolder)
  521. {
  522. if (string.Equals(CollectionType.Music, collectionFolder.CollectionType, StringComparison.OrdinalIgnoreCase))
  523. {
  524. return GetMusicFolders(item, user, stubType, sort, startIndex, limit);
  525. }
  526. else if (string.Equals(CollectionType.Movies, collectionFolder.CollectionType, StringComparison.OrdinalIgnoreCase))
  527. {
  528. return GetMovieFolders(item, user, stubType, sort, startIndex, limit);
  529. }
  530. else if (string.Equals(CollectionType.TvShows, collectionFolder.CollectionType, StringComparison.OrdinalIgnoreCase))
  531. {
  532. return GetTvFolders(item, user, stubType, sort, startIndex, limit);
  533. }
  534. else if (string.Equals(CollectionType.Folders, collectionFolder.CollectionType, StringComparison.OrdinalIgnoreCase))
  535. {
  536. return GetFolders(user, startIndex, limit);
  537. }
  538. else if (string.Equals(CollectionType.LiveTv, collectionFolder.CollectionType, StringComparison.OrdinalIgnoreCase))
  539. {
  540. return GetLiveTvChannels(user, sort, startIndex, limit);
  541. }
  542. }
  543. if (stubType.HasValue)
  544. {
  545. if (stubType.Value != StubType.Folder)
  546. {
  547. return ApplyPaging(new QueryResult<ServerItem>(), startIndex, limit);
  548. }
  549. }
  550. var folder = (Folder)item;
  551. var query = new InternalItemsQuery(user)
  552. {
  553. Limit = limit,
  554. StartIndex = startIndex,
  555. IsVirtualItem = false,
  556. ExcludeItemTypes = new[] { nameof(Book) },
  557. IsPlaceHolder = false,
  558. DtoOptions = GetDtoOptions()
  559. };
  560. SetSorting(query, sort, folder.IsPreSorted);
  561. var queryResult = folder.GetItems(query);
  562. return ToResult(queryResult);
  563. }
  564. /// <summary>
  565. /// Returns the Live Tv Channels meeting the criteria.
  566. /// </summary>
  567. /// <param name="user">The <see cref="User"/>.</param>
  568. /// <param name="sort">The <see cref="SortCriteria"/>.</param>
  569. /// <param name="startIndex">The start index.</param>
  570. /// <param name="limit">The maximum number to return.</param>
  571. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  572. private QueryResult<ServerItem> GetLiveTvChannels(User user, SortCriteria sort, int? startIndex, int? limit)
  573. {
  574. var query = new InternalItemsQuery(user)
  575. {
  576. StartIndex = startIndex,
  577. Limit = limit,
  578. };
  579. query.IncludeItemTypes = new[] { nameof(LiveTvChannel) };
  580. SetSorting(query, sort, false);
  581. var result = _libraryManager.GetItemsResult(query);
  582. return ToResult(result);
  583. }
  584. /// <summary>
  585. /// Returns the music folders meeting the criteria.
  586. /// </summary>
  587. /// <param name="item">The <see cref="BaseItem"/>.</param>
  588. /// <param name="user">The <see cref="User"/>.</param>
  589. /// <param name="stubType">The <see cref="StubType"/>.</param>
  590. /// <param name="sort">The <see cref="SortCriteria"/>.</param>
  591. /// <param name="startIndex">The start index.</param>
  592. /// <param name="limit">The maximum number to return.</param>
  593. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  594. private QueryResult<ServerItem> GetMusicFolders(BaseItem item, User user, StubType? stubType, SortCriteria sort, int? startIndex, int? limit)
  595. {
  596. var query = new InternalItemsQuery(user)
  597. {
  598. StartIndex = startIndex,
  599. Limit = limit
  600. };
  601. SetSorting(query, sort, false);
  602. if (stubType.HasValue && stubType.Value == StubType.Latest)
  603. {
  604. return GetMusicLatest(item, user, query);
  605. }
  606. if (stubType.HasValue && stubType.Value == StubType.Playlists)
  607. {
  608. return GetMusicPlaylists(user, query);
  609. }
  610. if (stubType.HasValue && stubType.Value == StubType.Albums)
  611. {
  612. return GetMusicAlbums(item, user, query);
  613. }
  614. if (stubType.HasValue && stubType.Value == StubType.Artists)
  615. {
  616. return GetMusicArtists(item, user, query);
  617. }
  618. if (stubType.HasValue && stubType.Value == StubType.AlbumArtists)
  619. {
  620. return GetMusicAlbumArtists(item, user, query);
  621. }
  622. if (stubType.HasValue && stubType.Value == StubType.FavoriteAlbums)
  623. {
  624. return GetFavoriteAlbums(item, user, query);
  625. }
  626. if (stubType.HasValue && stubType.Value == StubType.FavoriteArtists)
  627. {
  628. return GetFavoriteArtists(item, user, query);
  629. }
  630. if (stubType.HasValue && stubType.Value == StubType.FavoriteSongs)
  631. {
  632. return GetFavoriteSongs(item, user, query);
  633. }
  634. if (stubType.HasValue && stubType.Value == StubType.Songs)
  635. {
  636. return GetMusicSongs(item, user, query);
  637. }
  638. if (stubType.HasValue && stubType.Value == StubType.Genres)
  639. {
  640. return GetMusicGenres(item, user, query);
  641. }
  642. var list = new List<ServerItem>
  643. {
  644. new ServerItem(item)
  645. {
  646. StubType = StubType.Latest
  647. },
  648. new ServerItem(item)
  649. {
  650. StubType = StubType.Playlists
  651. },
  652. new ServerItem(item)
  653. {
  654. StubType = StubType.Albums
  655. },
  656. new ServerItem(item)
  657. {
  658. StubType = StubType.AlbumArtists
  659. },
  660. new ServerItem(item)
  661. {
  662. StubType = StubType.Artists
  663. },
  664. new ServerItem(item)
  665. {
  666. StubType = StubType.Songs
  667. },
  668. new ServerItem(item)
  669. {
  670. StubType = StubType.Genres
  671. },
  672. new ServerItem(item)
  673. {
  674. StubType = StubType.FavoriteArtists
  675. },
  676. new ServerItem(item)
  677. {
  678. StubType = StubType.FavoriteAlbums
  679. },
  680. new ServerItem(item)
  681. {
  682. StubType = StubType.FavoriteSongs
  683. }
  684. };
  685. return new QueryResult<ServerItem>
  686. {
  687. Items = list,
  688. TotalRecordCount = list.Count
  689. };
  690. }
  691. /// <summary>
  692. /// Returns the movie folders meeting the criteria.
  693. /// </summary>
  694. /// <param name="item">The <see cref="BaseItem"/>.</param>
  695. /// <param name="user">The <see cref="User"/>.</param>
  696. /// <param name="stubType">The <see cref="StubType"/>.</param>
  697. /// <param name="sort">The <see cref="SortCriteria"/>.</param>
  698. /// <param name="startIndex">The start index.</param>
  699. /// <param name="limit">The maximum number to return.</param>
  700. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  701. private QueryResult<ServerItem> GetMovieFolders(BaseItem item, User user, StubType? stubType, SortCriteria sort, int? startIndex, int? limit)
  702. {
  703. var query = new InternalItemsQuery(user)
  704. {
  705. StartIndex = startIndex,
  706. Limit = limit
  707. };
  708. SetSorting(query, sort, false);
  709. if (stubType.HasValue && stubType.Value == StubType.ContinueWatching)
  710. {
  711. return GetMovieContinueWatching(item, user, query);
  712. }
  713. if (stubType.HasValue && stubType.Value == StubType.Latest)
  714. {
  715. return GetMovieLatest(item, user, query);
  716. }
  717. if (stubType.HasValue && stubType.Value == StubType.Movies)
  718. {
  719. return GetMovieMovies(item, user, query);
  720. }
  721. if (stubType.HasValue && stubType.Value == StubType.Collections)
  722. {
  723. return GetMovieCollections(user, query);
  724. }
  725. if (stubType.HasValue && stubType.Value == StubType.Favorites)
  726. {
  727. return GetMovieFavorites(item, user, query);
  728. }
  729. if (stubType.HasValue && stubType.Value == StubType.Genres)
  730. {
  731. return GetGenres(item, user, query);
  732. }
  733. var array = new[]
  734. {
  735. new ServerItem(item)
  736. {
  737. StubType = StubType.ContinueWatching
  738. },
  739. new ServerItem(item)
  740. {
  741. StubType = StubType.Latest
  742. },
  743. new ServerItem(item)
  744. {
  745. StubType = StubType.Movies
  746. },
  747. new ServerItem(item)
  748. {
  749. StubType = StubType.Collections
  750. },
  751. new ServerItem(item)
  752. {
  753. StubType = StubType.Favorites
  754. },
  755. new ServerItem(item)
  756. {
  757. StubType = StubType.Genres
  758. }
  759. };
  760. return new QueryResult<ServerItem>
  761. {
  762. Items = array,
  763. TotalRecordCount = array.Length
  764. };
  765. }
  766. /// <summary>
  767. /// Returns the folders meeting the criteria.
  768. /// </summary>
  769. /// <param name="user">The <see cref="User"/>.</param>
  770. /// <param name="startIndex">The start index.</param>
  771. /// <param name="limit">The maximum number to return.</param>
  772. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  773. private QueryResult<ServerItem> GetFolders(User user, int? startIndex, int? limit)
  774. {
  775. var folders = _libraryManager.GetUserRootFolder().GetChildren(user, true)
  776. .OrderBy(i => i.SortName)
  777. .Select(i => new ServerItem(i)
  778. {
  779. StubType = StubType.Folder
  780. })
  781. .ToArray();
  782. return ApplyPaging(
  783. new QueryResult<ServerItem>
  784. {
  785. Items = folders,
  786. TotalRecordCount = folders.Length
  787. },
  788. startIndex,
  789. limit);
  790. }
  791. /// <summary>
  792. /// Returns the TV folders meeting the criteria.
  793. /// </summary>
  794. /// <param name="item">The <see cref="BaseItem"/>.</param>
  795. /// <param name="user">The <see cref="User"/>.</param>
  796. /// <param name="stubType">The <see cref="StubType"/>.</param>
  797. /// <param name="sort">The <see cref="SortCriteria"/>.</param>
  798. /// <param name="startIndex">The start index.</param>
  799. /// <param name="limit">The maximum number to return.</param>
  800. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  801. private QueryResult<ServerItem> GetTvFolders(BaseItem item, User user, StubType? stubType, SortCriteria sort, int? startIndex, int? limit)
  802. {
  803. var query = new InternalItemsQuery(user)
  804. {
  805. StartIndex = startIndex,
  806. Limit = limit
  807. };
  808. SetSorting(query, sort, false);
  809. if (stubType.HasValue && stubType.Value == StubType.ContinueWatching)
  810. {
  811. return GetMovieContinueWatching(item, user, query);
  812. }
  813. if (stubType.HasValue && stubType.Value == StubType.NextUp)
  814. {
  815. return GetNextUp(item, query);
  816. }
  817. if (stubType.HasValue && stubType.Value == StubType.Latest)
  818. {
  819. return GetTvLatest(item, user, query);
  820. }
  821. if (stubType.HasValue && stubType.Value == StubType.Series)
  822. {
  823. return GetSeries(item, user, query);
  824. }
  825. if (stubType.HasValue && stubType.Value == StubType.FavoriteSeries)
  826. {
  827. return GetFavoriteSeries(item, user, query);
  828. }
  829. if (stubType.HasValue && stubType.Value == StubType.FavoriteEpisodes)
  830. {
  831. return GetFavoriteEpisodes(item, user, query);
  832. }
  833. if (stubType.HasValue && stubType.Value == StubType.Genres)
  834. {
  835. return GetGenres(item, user, query);
  836. }
  837. var list = new List<ServerItem>
  838. {
  839. new ServerItem(item)
  840. {
  841. StubType = StubType.ContinueWatching
  842. },
  843. new ServerItem(item)
  844. {
  845. StubType = StubType.NextUp
  846. },
  847. new ServerItem(item)
  848. {
  849. StubType = StubType.Latest
  850. },
  851. new ServerItem(item)
  852. {
  853. StubType = StubType.Series
  854. },
  855. new ServerItem(item)
  856. {
  857. StubType = StubType.FavoriteSeries
  858. },
  859. new ServerItem(item)
  860. {
  861. StubType = StubType.FavoriteEpisodes
  862. },
  863. new ServerItem(item)
  864. {
  865. StubType = StubType.Genres
  866. }
  867. };
  868. return new QueryResult<ServerItem>
  869. {
  870. Items = list,
  871. TotalRecordCount = list.Count
  872. };
  873. }
  874. /// <summary>
  875. /// Returns the Movies that are part watched that meet the criteria.
  876. /// </summary>
  877. /// <param name="parent">The <see cref="BaseItem"/>.</param>
  878. /// <param name="user">The <see cref="User"/>.</param>
  879. /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
  880. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  881. private QueryResult<ServerItem> GetMovieContinueWatching(BaseItem parent, User user, InternalItemsQuery query)
  882. {
  883. query.Recursive = true;
  884. query.Parent = parent;
  885. query.SetUser(user);
  886. query.OrderBy = new[]
  887. {
  888. (ItemSortBy.DatePlayed, SortOrder.Descending),
  889. (ItemSortBy.SortName, SortOrder.Ascending)
  890. };
  891. query.IsResumable = true;
  892. query.Limit = 10;
  893. var result = _libraryManager.GetItemsResult(query);
  894. return ToResult(result);
  895. }
  896. /// <summary>
  897. /// Returns the series meeting the criteria.
  898. /// </summary>
  899. /// <param name="parent">The <see cref="BaseItem"/>.</param>
  900. /// <param name="user">The <see cref="User"/>.</param>
  901. /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
  902. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  903. private QueryResult<ServerItem> GetSeries(BaseItem parent, User user, InternalItemsQuery query)
  904. {
  905. query.Recursive = true;
  906. query.Parent = parent;
  907. query.SetUser(user);
  908. query.IncludeItemTypes = new[] { nameof(Series) };
  909. var result = _libraryManager.GetItemsResult(query);
  910. return ToResult(result);
  911. }
  912. /// <summary>
  913. /// Returns the Movie folders meeting the criteria.
  914. /// </summary>
  915. /// <param name="parent">The <see cref="BaseItem"/>.</param>
  916. /// <param name="user">The <see cref="User"/>.</param>
  917. /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
  918. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  919. private QueryResult<ServerItem> GetMovieMovies(BaseItem parent, User user, InternalItemsQuery query)
  920. {
  921. query.Recursive = true;
  922. query.Parent = parent;
  923. query.SetUser(user);
  924. query.IncludeItemTypes = new[] { nameof(Movie) };
  925. var result = _libraryManager.GetItemsResult(query);
  926. return ToResult(result);
  927. }
  928. /// <summary>
  929. /// Returns the Movie collections meeting the criteria.
  930. /// </summary>
  931. /// <param name="user">The see cref="User"/>.</param>
  932. /// <param name="query">The see cref="InternalItemsQuery"/>.</param>
  933. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  934. private QueryResult<ServerItem> GetMovieCollections(User user, InternalItemsQuery query)
  935. {
  936. query.Recursive = true;
  937. // query.Parent = parent;
  938. query.SetUser(user);
  939. query.IncludeItemTypes = new[] { nameof(BoxSet) };
  940. var result = _libraryManager.GetItemsResult(query);
  941. return ToResult(result);
  942. }
  943. /// <summary>
  944. /// Returns the Music albums meeting the criteria.
  945. /// </summary>
  946. /// <param name="parent">The <see cref="BaseItem"/>.</param>
  947. /// <param name="user">The <see cref="User"/>.</param>
  948. /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
  949. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  950. private QueryResult<ServerItem> GetMusicAlbums(BaseItem parent, User user, InternalItemsQuery query)
  951. {
  952. query.Recursive = true;
  953. query.Parent = parent;
  954. query.SetUser(user);
  955. query.IncludeItemTypes = new[] { nameof(MusicAlbum) };
  956. var result = _libraryManager.GetItemsResult(query);
  957. return ToResult(result);
  958. }
  959. /// <summary>
  960. /// Returns the Music songs meeting the criteria.
  961. /// </summary>
  962. /// <param name="parent">The <see cref="BaseItem"/>.</param>
  963. /// <param name="user">The <see cref="User"/>.</param>
  964. /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
  965. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  966. private QueryResult<ServerItem> GetMusicSongs(BaseItem parent, User user, InternalItemsQuery query)
  967. {
  968. query.Recursive = true;
  969. query.Parent = parent;
  970. query.SetUser(user);
  971. query.IncludeItemTypes = new[] { nameof(Audio) };
  972. var result = _libraryManager.GetItemsResult(query);
  973. return ToResult(result);
  974. }
  975. /// <summary>
  976. /// Returns the songs tagged as favourite that meet the criteria.
  977. /// </summary>
  978. /// <param name="parent">The <see cref="BaseItem"/>.</param>
  979. /// <param name="user">The <see cref="User"/>.</param>
  980. /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
  981. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  982. private QueryResult<ServerItem> GetFavoriteSongs(BaseItem parent, User user, InternalItemsQuery query)
  983. {
  984. query.Recursive = true;
  985. query.Parent = parent;
  986. query.SetUser(user);
  987. query.IsFavorite = true;
  988. query.IncludeItemTypes = new[] { nameof(Audio) };
  989. var result = _libraryManager.GetItemsResult(query);
  990. return ToResult(result);
  991. }
  992. /// <summary>
  993. /// Returns the series tagged as favourite that meet the criteria.
  994. /// </summary>
  995. /// <param name="parent">The <see cref="BaseItem"/>.</param>
  996. /// <param name="user">The <see cref="User"/>.</param>
  997. /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
  998. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  999. private QueryResult<ServerItem> GetFavoriteSeries(BaseItem parent, User user, InternalItemsQuery query)
  1000. {
  1001. query.Recursive = true;
  1002. query.Parent = parent;
  1003. query.SetUser(user);
  1004. query.IsFavorite = true;
  1005. query.IncludeItemTypes = new[] { nameof(Series) };
  1006. var result = _libraryManager.GetItemsResult(query);
  1007. return ToResult(result);
  1008. }
  1009. /// <summary>
  1010. /// Returns the episodes tagged as favourite that meet the criteria.
  1011. /// </summary>
  1012. /// <param name="parent">The <see cref="BaseItem"/>.</param>
  1013. /// <param name="user">The <see cref="User"/>.</param>
  1014. /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
  1015. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  1016. private QueryResult<ServerItem> GetFavoriteEpisodes(BaseItem parent, User user, InternalItemsQuery query)
  1017. {
  1018. query.Recursive = true;
  1019. query.Parent = parent;
  1020. query.SetUser(user);
  1021. query.IsFavorite = true;
  1022. query.IncludeItemTypes = new[] { nameof(Episode) };
  1023. var result = _libraryManager.GetItemsResult(query);
  1024. return ToResult(result);
  1025. }
  1026. /// <summary>
  1027. /// Returns the movies tagged as favourite that meet the criteria.
  1028. /// </summary>
  1029. /// <param name="parent">The <see cref="BaseItem"/>.</param>
  1030. /// <param name="user">The <see cref="User"/>.</param>
  1031. /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
  1032. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  1033. private QueryResult<ServerItem> GetMovieFavorites(BaseItem parent, User user, InternalItemsQuery query)
  1034. {
  1035. query.Recursive = true;
  1036. query.Parent = parent;
  1037. query.SetUser(user);
  1038. query.IsFavorite = true;
  1039. query.IncludeItemTypes = new[] { nameof(Movie) };
  1040. var result = _libraryManager.GetItemsResult(query);
  1041. return ToResult(result);
  1042. }
  1043. /// <summary>
  1044. /// /// Returns the albums tagged as favourite that meet the criteria.
  1045. /// </summary>
  1046. /// <param name="parent">The <see cref="BaseItem"/>.</param>
  1047. /// <param name="user">The <see cref="User"/>.</param>
  1048. /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
  1049. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  1050. private QueryResult<ServerItem> GetFavoriteAlbums(BaseItem parent, User user, InternalItemsQuery query)
  1051. {
  1052. query.Recursive = true;
  1053. query.Parent = parent;
  1054. query.SetUser(user);
  1055. query.IsFavorite = true;
  1056. query.IncludeItemTypes = new[] { nameof(MusicAlbum) };
  1057. var result = _libraryManager.GetItemsResult(query);
  1058. return ToResult(result);
  1059. }
  1060. /// <summary>
  1061. /// Returns the genres meeting the criteria.
  1062. /// The GetGenres.
  1063. /// </summary>
  1064. /// <param name="parent">The <see cref="BaseItem"/>.</param>
  1065. /// <param name="user">The <see cref="User"/>.</param>
  1066. /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
  1067. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  1068. private QueryResult<ServerItem> GetGenres(BaseItem parent, User user, InternalItemsQuery query)
  1069. {
  1070. var genresResult = _libraryManager.GetGenres(new InternalItemsQuery(user)
  1071. {
  1072. AncestorIds = new[] { parent.Id },
  1073. StartIndex = query.StartIndex,
  1074. Limit = query.Limit
  1075. });
  1076. var result = new QueryResult<BaseItem>
  1077. {
  1078. TotalRecordCount = genresResult.TotalRecordCount,
  1079. Items = genresResult.Items.Select(i => i.Item1).ToArray()
  1080. };
  1081. return ToResult(result);
  1082. }
  1083. /// <summary>
  1084. /// Returns the music genres meeting the criteria.
  1085. /// </summary>
  1086. /// <param name="parent">The <see cref="BaseItem"/>.</param>
  1087. /// <param name="user">The <see cref="User"/>.</param>
  1088. /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
  1089. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  1090. private QueryResult<ServerItem> GetMusicGenres(BaseItem parent, User user, InternalItemsQuery query)
  1091. {
  1092. var genresResult = _libraryManager.GetMusicGenres(new InternalItemsQuery(user)
  1093. {
  1094. AncestorIds = new[] { parent.Id },
  1095. StartIndex = query.StartIndex,
  1096. Limit = query.Limit
  1097. });
  1098. var result = new QueryResult<BaseItem>
  1099. {
  1100. TotalRecordCount = genresResult.TotalRecordCount,
  1101. Items = genresResult.Items.Select(i => i.Item1).ToArray()
  1102. };
  1103. return ToResult(result);
  1104. }
  1105. /// <summary>
  1106. /// Returns the music albums by artist that meet the criteria.
  1107. /// </summary>
  1108. /// <param name="parent">The <see cref="BaseItem"/>.</param>
  1109. /// <param name="user">The <see cref="User"/>.</param>
  1110. /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
  1111. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  1112. private QueryResult<ServerItem> GetMusicAlbumArtists(BaseItem parent, User user, InternalItemsQuery query)
  1113. {
  1114. var artists = _libraryManager.GetAlbumArtists(new InternalItemsQuery(user)
  1115. {
  1116. AncestorIds = new[] { parent.Id },
  1117. StartIndex = query.StartIndex,
  1118. Limit = query.Limit
  1119. });
  1120. var result = new QueryResult<BaseItem>
  1121. {
  1122. TotalRecordCount = artists.TotalRecordCount,
  1123. Items = artists.Items.Select(i => i.Item1).ToArray()
  1124. };
  1125. return ToResult(result);
  1126. }
  1127. /// <summary>
  1128. /// Returns the music artists meeting the criteria.
  1129. /// </summary>
  1130. /// <param name="parent">The <see cref="BaseItem"/>.</param>
  1131. /// <param name="user">The <see cref="User"/>.</param>
  1132. /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
  1133. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  1134. private QueryResult<ServerItem> GetMusicArtists(BaseItem parent, User user, InternalItemsQuery query)
  1135. {
  1136. var artists = _libraryManager.GetArtists(new InternalItemsQuery(user)
  1137. {
  1138. AncestorIds = new[] { parent.Id },
  1139. StartIndex = query.StartIndex,
  1140. Limit = query.Limit
  1141. });
  1142. var result = new QueryResult<BaseItem>
  1143. {
  1144. TotalRecordCount = artists.TotalRecordCount,
  1145. Items = artists.Items.Select(i => i.Item1).ToArray()
  1146. };
  1147. return ToResult(result);
  1148. }
  1149. /// <summary>
  1150. /// Returns the artists tagged as favourite that meet the criteria.
  1151. /// </summary>
  1152. /// <param name="parent">The <see cref="BaseItem"/>.</param>
  1153. /// <param name="user">The <see cref="User"/>.</param>
  1154. /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
  1155. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  1156. private QueryResult<ServerItem> GetFavoriteArtists(BaseItem parent, User user, InternalItemsQuery query)
  1157. {
  1158. var artists = _libraryManager.GetArtists(new InternalItemsQuery(user)
  1159. {
  1160. AncestorIds = new[] { parent.Id },
  1161. StartIndex = query.StartIndex,
  1162. Limit = query.Limit,
  1163. IsFavorite = true
  1164. });
  1165. var result = new QueryResult<BaseItem>
  1166. {
  1167. TotalRecordCount = artists.TotalRecordCount,
  1168. Items = artists.Items.Select(i => i.Item1).ToArray()
  1169. };
  1170. return ToResult(result);
  1171. }
  1172. /// <summary>
  1173. /// Returns the music playlists meeting the criteria.
  1174. /// </summary>
  1175. /// <param name="user">The user<see cref="User"/>.</param>
  1176. /// <param name="query">The query<see cref="InternalItemsQuery"/>.</param>
  1177. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  1178. private QueryResult<ServerItem> GetMusicPlaylists(User user, InternalItemsQuery query)
  1179. {
  1180. query.Parent = null;
  1181. query.IncludeItemTypes = new[] { nameof(Playlist) };
  1182. query.SetUser(user);
  1183. query.Recursive = true;
  1184. var result = _libraryManager.GetItemsResult(query);
  1185. return ToResult(result);
  1186. }
  1187. /// <summary>
  1188. /// Returns the latest music meeting the criteria.
  1189. /// </summary>
  1190. /// <param name="parent">The <see cref="BaseItem"/>.</param>
  1191. /// <param name="user">The <see cref="User"/>.</param>
  1192. /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
  1193. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  1194. private QueryResult<ServerItem> GetMusicLatest(BaseItem parent, User user, InternalItemsQuery query)
  1195. {
  1196. query.OrderBy = Array.Empty<(string, SortOrder)>();
  1197. var items = _userViewManager.GetLatestItems(
  1198. new LatestItemsQuery
  1199. {
  1200. UserId = user.Id,
  1201. Limit = 50,
  1202. IncludeItemTypes = new[] { nameof(Audio) },
  1203. ParentId = parent?.Id ?? Guid.Empty,
  1204. GroupItems = true
  1205. },
  1206. query.DtoOptions).Select(i => i.Item1 ?? i.Item2.FirstOrDefault()).Where(i => i != null).ToArray();
  1207. return ToResult(items);
  1208. }
  1209. /// <summary>
  1210. /// Returns the next up item meeting the criteria.
  1211. /// </summary>
  1212. /// <param name="parent">The <see cref="BaseItem"/>.</param>
  1213. /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
  1214. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  1215. private QueryResult<ServerItem> GetNextUp(BaseItem parent, InternalItemsQuery query)
  1216. {
  1217. query.OrderBy = Array.Empty<(string, SortOrder)>();
  1218. var result = _tvSeriesManager.GetNextUp(
  1219. new NextUpQuery
  1220. {
  1221. Limit = query.Limit,
  1222. StartIndex = query.StartIndex,
  1223. UserId = query.User.Id
  1224. },
  1225. new[] { parent },
  1226. query.DtoOptions);
  1227. return ToResult(result);
  1228. }
  1229. /// <summary>
  1230. /// Returns the latest tv meeting the criteria.
  1231. /// </summary>
  1232. /// <param name="parent">The <see cref="BaseItem"/>.</param>
  1233. /// <param name="user">The <see cref="User"/>.</param>
  1234. /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
  1235. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  1236. private QueryResult<ServerItem> GetTvLatest(BaseItem parent, User user, InternalItemsQuery query)
  1237. {
  1238. query.OrderBy = Array.Empty<(string, SortOrder)>();
  1239. var items = _userViewManager.GetLatestItems(
  1240. new LatestItemsQuery
  1241. {
  1242. UserId = user.Id,
  1243. Limit = 50,
  1244. IncludeItemTypes = new[] { nameof(Episode) },
  1245. ParentId = parent == null ? Guid.Empty : parent.Id,
  1246. GroupItems = false
  1247. },
  1248. query.DtoOptions).Select(i => i.Item1 ?? i.Item2.FirstOrDefault()).Where(i => i != null).ToArray();
  1249. return ToResult(items);
  1250. }
  1251. /// <summary>
  1252. /// Returns the latest movies meeting the criteria.
  1253. /// </summary>
  1254. /// <param name="parent">The <see cref="BaseItem"/>.</param>
  1255. /// <param name="user">The <see cref="User"/>.</param>
  1256. /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
  1257. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  1258. private QueryResult<ServerItem> GetMovieLatest(BaseItem parent, User user, InternalItemsQuery query)
  1259. {
  1260. query.OrderBy = Array.Empty<(string, SortOrder)>();
  1261. var items = _userViewManager.GetLatestItems(
  1262. new LatestItemsQuery
  1263. {
  1264. UserId = user.Id,
  1265. Limit = 50,
  1266. IncludeItemTypes = new[] { nameof(Movie) },
  1267. ParentId = parent?.Id ?? Guid.Empty,
  1268. GroupItems = true
  1269. },
  1270. query.DtoOptions).Select(i => i.Item1 ?? i.Item2.FirstOrDefault()).Where(i => i != null).ToArray();
  1271. return ToResult(items);
  1272. }
  1273. /// <summary>
  1274. /// Returns music artist items that meet the criteria.
  1275. /// </summary>
  1276. /// <param name="item">The <see cref="BaseItem"/>.</param>
  1277. /// <param name="parentId">The <see cref="Guid"/>.</param>
  1278. /// <param name="user">The <see cref="User"/>.</param>
  1279. /// <param name="sort">The <see cref="SortCriteria"/>.</param>
  1280. /// <param name="startIndex">The start index.</param>
  1281. /// <param name="limit">The maximum number to return.</param>
  1282. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  1283. private QueryResult<ServerItem> GetMusicArtistItems(BaseItem item, Guid parentId, User user, SortCriteria sort, int? startIndex, int? limit)
  1284. {
  1285. var query = new InternalItemsQuery(user)
  1286. {
  1287. Recursive = true,
  1288. ParentId = parentId,
  1289. ArtistIds = new[] { item.Id },
  1290. IncludeItemTypes = new[] { nameof(MusicAlbum) },
  1291. Limit = limit,
  1292. StartIndex = startIndex,
  1293. DtoOptions = GetDtoOptions()
  1294. };
  1295. SetSorting(query, sort, false);
  1296. var result = _libraryManager.GetItemsResult(query);
  1297. return ToResult(result);
  1298. }
  1299. /// <summary>
  1300. /// Returns the genre items meeting the criteria.
  1301. /// </summary>
  1302. /// <param name="item">The <see cref="BaseItem"/>.</param>
  1303. /// <param name="parentId">The <see cref="Guid"/>.</param>
  1304. /// <param name="user">The <see cref="User"/>.</param>
  1305. /// <param name="sort">The <see cref="SortCriteria"/>.</param>
  1306. /// <param name="startIndex">The start index.</param>
  1307. /// <param name="limit">The maximum number to return.</param>
  1308. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  1309. private QueryResult<ServerItem> GetGenreItems(BaseItem item, Guid parentId, User user, SortCriteria sort, int? startIndex, int? limit)
  1310. {
  1311. var query = new InternalItemsQuery(user)
  1312. {
  1313. Recursive = true,
  1314. ParentId = parentId,
  1315. GenreIds = new[] { item.Id },
  1316. IncludeItemTypes = new[]
  1317. {
  1318. nameof(Movie),
  1319. nameof(Series)
  1320. },
  1321. Limit = limit,
  1322. StartIndex = startIndex,
  1323. DtoOptions = GetDtoOptions()
  1324. };
  1325. SetSorting(query, sort, false);
  1326. var result = _libraryManager.GetItemsResult(query);
  1327. return ToResult(result);
  1328. }
  1329. /// <summary>
  1330. /// Returns the music genre items meeting the criteria.
  1331. /// </summary>
  1332. /// <param name="item">The <see cref="BaseItem"/>.</param>
  1333. /// <param name="parentId">The <see cref="Guid"/>.</param>
  1334. /// <param name="user">The <see cref="User"/>.</param>
  1335. /// <param name="sort">The <see cref="SortCriteria"/>.</param>
  1336. /// <param name="startIndex">The start index.</param>
  1337. /// <param name="limit">The maximum number to return.</param>
  1338. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  1339. private QueryResult<ServerItem> GetMusicGenreItems(BaseItem item, Guid parentId, User user, SortCriteria sort, int? startIndex, int? limit)
  1340. {
  1341. var query = new InternalItemsQuery(user)
  1342. {
  1343. Recursive = true,
  1344. ParentId = parentId,
  1345. GenreIds = new[] { item.Id },
  1346. IncludeItemTypes = new[] { nameof(MusicAlbum) },
  1347. Limit = limit,
  1348. StartIndex = startIndex,
  1349. DtoOptions = GetDtoOptions()
  1350. };
  1351. SetSorting(query, sort, false);
  1352. var result = _libraryManager.GetItemsResult(query);
  1353. return ToResult(result);
  1354. }
  1355. /// <summary>
  1356. /// Converts a <see cref="BaseItem"/> array into a <see cref="QueryResult{ServerItem}"/>.
  1357. /// </summary>
  1358. /// <param name="result">An array of <see cref="BaseItem"/>.</param>
  1359. /// <returns>A <see cref="QueryResult{ServerItem}"/>.</returns>
  1360. private static QueryResult<ServerItem> ToResult(BaseItem[] result)
  1361. {
  1362. var serverItems = result
  1363. .Select(i => new ServerItem(i))
  1364. .ToArray();
  1365. return new QueryResult<ServerItem>
  1366. {
  1367. TotalRecordCount = result.Length,
  1368. Items = serverItems
  1369. };
  1370. }
  1371. /// <summary>
  1372. /// Converts a <see cref="QueryResult{BaseItem}"/> to a <see cref="QueryResult{ServerItem}"/>.
  1373. /// </summary>
  1374. /// <param name="result">A <see cref="QueryResult{BaseItem}"/>.</param>
  1375. /// <returns>The <see cref="QueryResult{ServerItem}"/>.</returns>
  1376. private static QueryResult<ServerItem> ToResult(QueryResult<BaseItem> result)
  1377. {
  1378. var serverItems = result
  1379. .Items
  1380. .Select(i => new ServerItem(i))
  1381. .ToArray();
  1382. return new QueryResult<ServerItem>
  1383. {
  1384. TotalRecordCount = result.TotalRecordCount,
  1385. Items = serverItems
  1386. };
  1387. }
  1388. /// <summary>
  1389. /// Sets the sorting method on a query.
  1390. /// </summary>
  1391. /// <param name="query">The <see cref="InternalItemsQuery"/>.</param>
  1392. /// <param name="sort">The <see cref="SortCriteria"/>.</param>
  1393. /// <param name="isPreSorted">True if pre-sorted.</param>
  1394. private static void SetSorting(InternalItemsQuery query, SortCriteria sort, bool isPreSorted)
  1395. {
  1396. if (isPreSorted)
  1397. {
  1398. query.OrderBy = Array.Empty<(string, SortOrder)>();
  1399. }
  1400. else
  1401. {
  1402. query.OrderBy = new[] { (ItemSortBy.SortName, sort.SortOrder) };
  1403. }
  1404. }
  1405. /// <summary>
  1406. /// Apply paging to a query.
  1407. /// </summary>
  1408. /// <param name="result">The <see cref="QueryResult{ServerItem}"/>.</param>
  1409. /// <param name="startIndex">The start index.</param>
  1410. /// <param name="limit">The maximum number to return.</param>
  1411. /// <returns>A <see cref="QueryResult{ServerItem}"/>.</returns>
  1412. private static QueryResult<ServerItem> ApplyPaging(QueryResult<ServerItem> result, int? startIndex, int? limit)
  1413. {
  1414. result.Items = result.Items.Skip(startIndex ?? 0).Take(limit ?? int.MaxValue).ToArray();
  1415. return result;
  1416. }
  1417. /// <summary>
  1418. /// Retrieves the ServerItem id.
  1419. /// </summary>
  1420. /// <param name="id">The id<see cref="string"/>.</param>
  1421. /// <returns>The <see cref="ServerItem"/>.</returns>
  1422. private ServerItem GetItemFromObjectId(string id)
  1423. {
  1424. return DidlBuilder.IsIdRoot(id)
  1425. ? new ServerItem(_libraryManager.GetUserRootFolder())
  1426. : ParseItemId(id);
  1427. }
  1428. /// <summary>
  1429. /// Parses the item id into a <see cref="ServerItem"/>.
  1430. /// </summary>
  1431. /// <param name="id">The <see cref="string"/>.</param>
  1432. /// <returns>The corresponding <see cref="ServerItem"/>.</returns>
  1433. private ServerItem ParseItemId(string id)
  1434. {
  1435. StubType? stubType = null;
  1436. // After using PlayTo, MediaMonkey sends a request to the server trying to get item info
  1437. const string ParamsSrch = "Params=";
  1438. var paramsIndex = id.IndexOf(ParamsSrch, StringComparison.OrdinalIgnoreCase);
  1439. if (paramsIndex != -1)
  1440. {
  1441. id = id.Substring(paramsIndex + ParamsSrch.Length);
  1442. var parts = id.Split(';');
  1443. id = parts[23];
  1444. }
  1445. var enumNames = Enum.GetNames(typeof(StubType));
  1446. foreach (var name in enumNames)
  1447. {
  1448. if (id.StartsWith(name + "_", StringComparison.OrdinalIgnoreCase))
  1449. {
  1450. stubType = Enum.Parse<StubType>(name, true);
  1451. id = id.Split('_', 2)[1];
  1452. break;
  1453. }
  1454. }
  1455. if (Guid.TryParse(id, out var itemId))
  1456. {
  1457. var item = _libraryManager.GetItemById(itemId);
  1458. return new ServerItem(item)
  1459. {
  1460. StubType = stubType
  1461. };
  1462. }
  1463. Logger.LogError("Error parsing item Id: {Id}. Returning user root folder.", id);
  1464. return new ServerItem(_libraryManager.GetUserRootFolder());
  1465. }
  1466. }
  1467. }