| | | 1 | | using System; |
| | | 2 | | using System.Collections.Generic; |
| | | 3 | | using System.Linq; |
| | | 4 | | using MediaBrowser.Model.Entities; |
| | | 5 | | using MediaBrowser.Model.Querying; |
| | | 6 | | |
| | | 7 | | namespace MediaBrowser.Controller.Dto |
| | | 8 | | { |
| | | 9 | | /// <summary> |
| | | 10 | | /// Options that control which fields and images are populated when building a <see cref="MediaBrowser.Model.Dto.Bas |
| | | 11 | | /// </summary> |
| | | 12 | | public class DtoOptions |
| | | 13 | | { |
| | 4 | 14 | | private static readonly ItemFields[] DefaultExcludedFields = |
| | 4 | 15 | | [ |
| | 4 | 16 | | ItemFields.SeasonUserData, |
| | 4 | 17 | | ItemFields.RefreshState |
| | 4 | 18 | | ]; |
| | | 19 | | |
| | 4 | 20 | | private static readonly ImageType[] AllImageTypes = Enum.GetValues<ImageType>(); |
| | | 21 | | |
| | 4 | 22 | | private static readonly ItemFields[] AllItemFields = Enum.GetValues<ItemFields>() |
| | 4 | 23 | | .Except(DefaultExcludedFields) |
| | 4 | 24 | | .ToArray(); |
| | | 25 | | |
| | | 26 | | /// <summary> |
| | | 27 | | /// Initializes a new instance of the <see cref="DtoOptions"/> class with all fields enabled. |
| | | 28 | | /// </summary> |
| | | 29 | | public DtoOptions() |
| | 1144 | 30 | | : this(true) |
| | | 31 | | { |
| | 1144 | 32 | | } |
| | | 33 | | |
| | | 34 | | /// <summary> |
| | | 35 | | /// Initializes a new instance of the <see cref="DtoOptions"/> class. |
| | | 36 | | /// </summary> |
| | | 37 | | /// <param name="allFields">Whether to populate all available fields.</param> |
| | | 38 | | public DtoOptions(bool allFields) |
| | | 39 | | { |
| | 1606 | 40 | | ImageTypeLimit = int.MaxValue; |
| | 1606 | 41 | | EnableImages = true; |
| | 1606 | 42 | | EnableUserData = true; |
| | 1606 | 43 | | AddCurrentProgram = true; |
| | | 44 | | |
| | 1606 | 45 | | Fields = allFields ? AllItemFields : []; |
| | 1606 | 46 | | ImageTypes = AllImageTypes; |
| | 1606 | 47 | | } |
| | | 48 | | |
| | | 49 | | /// <summary> |
| | | 50 | | /// Gets options that populate nothing beyond the item's own stored columns. |
| | | 51 | | /// </summary> |
| | | 52 | | /// <remarks> |
| | | 53 | | /// Each enabled field group is a collection the item query left-joins, so the rows returned are |
| | | 54 | | /// the product of the item's provider, image and user data counts. Never use this for items that |
| | | 55 | | /// get saved back: saving rewrites the owned rows from what the instance holds. |
| | | 56 | | /// </remarks> |
| | 1 | 57 | | public static DtoOptions StoredColumnsOnly => new(false) |
| | 1 | 58 | | { |
| | 1 | 59 | | EnableImages = false, |
| | 1 | 60 | | EnableUserData = false |
| | 1 | 61 | | }; |
| | | 62 | | |
| | | 63 | | /// <summary> |
| | | 64 | | /// Gets or sets the fields to populate on the DTO. |
| | | 65 | | /// </summary> |
| | | 66 | | public IReadOnlyList<ItemFields> Fields { get; set; } |
| | | 67 | | |
| | | 68 | | /// <summary> |
| | | 69 | | /// Gets or sets the image types to populate on the DTO. |
| | | 70 | | /// </summary> |
| | | 71 | | public IReadOnlyList<ImageType> ImageTypes { get; set; } |
| | | 72 | | |
| | | 73 | | /// <summary> |
| | | 74 | | /// Gets or sets the maximum number of images to return per image type. |
| | | 75 | | /// </summary> |
| | | 76 | | public int ImageTypeLimit { get; set; } |
| | | 77 | | |
| | | 78 | | /// <summary> |
| | | 79 | | /// Gets or sets a value indicating whether image information is populated. |
| | | 80 | | /// </summary> |
| | | 81 | | public bool EnableImages { get; set; } |
| | | 82 | | |
| | | 83 | | /// <summary> |
| | | 84 | | /// Gets or sets a value indicating whether program recording information is populated. |
| | | 85 | | /// </summary> |
| | | 86 | | public bool AddProgramRecordingInfo { get; set; } |
| | | 87 | | |
| | | 88 | | /// <summary> |
| | | 89 | | /// Gets or sets a value indicating whether user data is populated. |
| | | 90 | | /// </summary> |
| | | 91 | | public bool EnableUserData { get; set; } |
| | | 92 | | |
| | | 93 | | /// <summary> |
| | | 94 | | /// Gets or sets a value indicating whether the currently airing program is populated. |
| | | 95 | | /// </summary> |
| | | 96 | | public bool AddCurrentProgram { get; set; } |
| | | 97 | | |
| | | 98 | | /// <summary> |
| | | 99 | | /// Gets a value indicating whether the specified field is populated. |
| | | 100 | | /// </summary> |
| | | 101 | | /// <param name="field">The field to check.</param> |
| | | 102 | | /// <returns><c>true</c> if the field is populated; otherwise, <c>false</c>.</returns> |
| | | 103 | | public bool ContainsField(ItemFields field) |
| | 2323 | 104 | | => Fields.Contains(field); |
| | | 105 | | |
| | | 106 | | /// <summary> |
| | | 107 | | /// Gets the number of images to return for the specified image type. |
| | | 108 | | /// </summary> |
| | | 109 | | /// <param name="type">The image type.</param> |
| | | 110 | | /// <returns>The image limit for the type, or 0 if the type is not enabled.</returns> |
| | | 111 | | public int GetImageLimit(ImageType type) |
| | | 112 | | { |
| | 88 | 113 | | if (EnableImages && ImageTypes.Contains(type)) |
| | | 114 | | { |
| | 71 | 115 | | return ImageTypeLimit; |
| | | 116 | | } |
| | | 117 | | |
| | 17 | 118 | | return 0; |
| | | 119 | | } |
| | | 120 | | } |
| | | 121 | | } |