ControlHandler.cs 67 KB

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