< Summary - Jellyfin

Information
Class: MediaBrowser.Controller.Playlists.Playlist
Assembly: MediaBrowser.Controller
File(s): /srv/git/jellyfin/MediaBrowser.Controller/Playlists/Playlist.cs
Line coverage
12%
Covered lines: 12
Uncovered lines: 82
Coverable lines: 94
Total lines: 274
Line coverage: 12.7%
Branch coverage
0%
Covered branches: 0
Total branches: 30
Branch coverage: 0%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Coverage history

Coverage history 0 25 50 75 100

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
.cctor()100%11100%
.ctor()100%11100%
get_IsFile()100%210%
get_ContainingFolderPath()0%620%
get_FilterLinkedChildrenPerUser()100%210%
get_SupportsInheritedParentImages()100%210%
get_SupportsPlayedStatus()100%210%
get_AlwaysScanInternalMetadataPath()100%210%
get_SupportsCumulativeRunTimeTicks()100%210%
get_IsPreSorted()100%210%
get_MediaType()100%210%
get_IsSharedItem()0%620%
IsPlaylistFile(...)0%620%
SetMediaType(...)100%210%
GetDefaultPrimaryImageAspectRatio()100%210%
IsAuthorizedToDelete(...)100%210%
IsSaveLocalMetadataEnabled()100%210%
LoadChildren()100%210%
ValidateChildrenInternal(...)100%210%
GetChildren(...)100%210%
GetNonCachedChildren(...)100%210%
GetRecursiveChildren(...)100%210%
GetManageableItems()100%210%
GetPlayableItems(...)0%620%
GetPlaylistItems(...)0%2040%
GetPlaylistItems(...)0%4260%
IsVisible(...)0%7280%
CanDelete(...)0%620%
IsVisibleStandalone(...)0%620%

File(s)

/srv/git/jellyfin/MediaBrowser.Controller/Playlists/Playlist.cs

#LineLine coverage
 1#nullable disable
 2
 3#pragma warning disable CS1591
 4
 5using System;
 6using System.Collections.Generic;
 7using System.IO;
 8using System.Linq;
 9using System.Text.Json.Serialization;
 10using System.Threading;
 11using System.Threading.Tasks;
 12using Jellyfin.Data;
 13using Jellyfin.Data.Enums;
 14using Jellyfin.Database.Implementations.Entities;
 15using Jellyfin.Database.Implementations.Enums;
 16using MediaBrowser.Controller.Dto;
 17using MediaBrowser.Controller.Entities;
 18using MediaBrowser.Controller.Entities.Audio;
 19using MediaBrowser.Controller.Providers;
 20using MediaBrowser.Model.Entities;
 21
 22namespace MediaBrowser.Controller.Playlists
 23{
 24    public class Playlist : Folder, IHasShares
 25    {
 126        public static readonly IReadOnlyList<string> SupportedExtensions =
 127        [
 128            ".m3u",
 129            ".m3u8",
 130            ".pls",
 131            ".wpl",
 132            ".zpl"
 133        ];
 34
 135        public Playlist()
 36        {
 137            Shares = [];
 138            OpenAccess = false;
 139        }
 40
 41        public Guid OwnerUserId { get; set; }
 42
 43        public bool OpenAccess { get; set; }
 44
 45        public IReadOnlyList<PlaylistUserPermissions> Shares { get; set; }
 46
 47        [JsonIgnore]
 048        public bool IsFile => IsPlaylistFile(Path);
 49
 50        [JsonIgnore]
 51        public override string ContainingFolderPath
 52        {
 53            get
 54            {
 055                var path = Path;
 56
 057                if (IsPlaylistFile(path))
 58                {
 059                    return System.IO.Path.GetDirectoryName(path);
 60                }
 61
 062                return path;
 63            }
 64        }
 65
 66        [JsonIgnore]
 067        protected override bool FilterLinkedChildrenPerUser => true;
 68
 69        [JsonIgnore]
 070        public override bool SupportsInheritedParentImages => false;
 71
 72        [JsonIgnore]
 073        public override bool SupportsPlayedStatus => MediaType == Jellyfin.Data.Enums.MediaType.Video;
 74
 75        [JsonIgnore]
 076        public override bool AlwaysScanInternalMetadataPath => true;
 77
 78        [JsonIgnore]
 079        public override bool SupportsCumulativeRunTimeTicks => true;
 80
 81        [JsonIgnore]
 082        public override bool IsPreSorted => true;
 83
 84        public MediaType PlaylistMediaType { get; set; }
 85
 86        [JsonIgnore]
 087        public override MediaType MediaType => PlaylistMediaType;
 88
 89        [JsonIgnore]
 90        private bool IsSharedItem
 91        {
 92            get
 93            {
 094                var path = Path;
 95
 096                if (string.IsNullOrEmpty(path))
 97                {
 098                    return false;
 99                }
 100
 0101                return FileSystem.ContainsSubPath(ConfigurationManager.ApplicationPaths.DataPath, path);
 102            }
 103        }
 104
 105        public static bool IsPlaylistFile(string path)
 106        {
 107            // The path will sometimes be a directory and "Path.HasExtension" returns true if the name contains a '.' (d
 0108            return System.IO.Path.HasExtension(path) && !Directory.Exists(path);
 109        }
 110
 111        public void SetMediaType(MediaType? value)
 112        {
 0113            PlaylistMediaType = value ?? MediaType.Unknown;
 0114        }
 115
 116        public override double GetDefaultPrimaryImageAspectRatio()
 117        {
 0118            return 1;
 119        }
 120
 121        public override bool IsAuthorizedToDelete(User user, List<Folder> allCollectionFolders)
 122        {
 0123            return true;
 124        }
 125
 126        public override bool IsSaveLocalMetadataEnabled()
 127        {
 0128            return true;
 129        }
 130
 131        protected override List<BaseItem> LoadChildren()
 132        {
 133            // Save a trip to the database
 0134            return [];
 135        }
 136
 137        protected override Task ValidateChildrenInternal(IProgress<double> progress, bool recursive, bool refreshChildMe
 138        {
 0139            return Task.CompletedTask;
 140        }
 141
 142        public override IReadOnlyList<BaseItem> GetChildren(User user, bool includeLinkedChildren, InternalItemsQuery qu
 143        {
 0144            return GetPlayableItems(user, query);
 145        }
 146
 147        protected override IReadOnlyList<BaseItem> GetNonCachedChildren(IDirectoryService directoryService)
 148        {
 0149            return [];
 150        }
 151
 152        public override IReadOnlyList<BaseItem> GetRecursiveChildren(User user, InternalItemsQuery query)
 153        {
 0154            return GetPlayableItems(user, query);
 155        }
 156
 157        public IReadOnlyList<Tuple<LinkedChild, BaseItem>> GetManageableItems()
 158        {
 0159            return GetLinkedChildrenInfos();
 160        }
 161
 162        private IReadOnlyList<BaseItem> GetPlayableItems(User user, InternalItemsQuery query)
 163        {
 0164            query ??= new InternalItemsQuery(user);
 165
 0166            query.IsFolder = false;
 167
 0168            return base.GetChildren(user, true, query);
 169        }
 170
 171        public static IReadOnlyList<BaseItem> GetPlaylistItems(IEnumerable<BaseItem> inputItems, User user, DtoOptions o
 172        {
 0173            if (user is not null)
 174            {
 0175                inputItems = inputItems.Where(i => i.IsVisible(user));
 176            }
 177
 0178            var list = new List<BaseItem>();
 179
 0180            foreach (var item in inputItems)
 181            {
 0182                var playlistItems = GetPlaylistItems(item, user, options);
 0183                list.AddRange(playlistItems);
 184            }
 185
 0186            return list;
 187        }
 188
 189        private static IEnumerable<BaseItem> GetPlaylistItems(BaseItem item, User user, DtoOptions options)
 190        {
 0191            if (item is MusicGenre musicGenre)
 192            {
 0193                return LibraryManager.GetItemList(new InternalItemsQuery(user)
 0194                {
 0195                    Recursive = true,
 0196                    IncludeItemTypes = [BaseItemKind.Audio],
 0197                    GenreIds = [musicGenre.Id],
 0198                    OrderBy = [(ItemSortBy.AlbumArtist, SortOrder.Ascending), (ItemSortBy.Album, SortOrder.Ascending), (
 0199                    DtoOptions = options
 0200                });
 201            }
 202
 0203            if (item is MusicArtist musicArtist)
 204            {
 0205                return LibraryManager.GetItemList(new InternalItemsQuery(user)
 0206                {
 0207                    Recursive = true,
 0208                    IncludeItemTypes = [BaseItemKind.Audio],
 0209                    ArtistIds = [musicArtist.Id],
 0210                    OrderBy = [(ItemSortBy.AlbumArtist, SortOrder.Ascending), (ItemSortBy.Album, SortOrder.Ascending), (
 0211                    DtoOptions = options
 0212                });
 213            }
 214
 0215            if (item is Folder folder)
 216            {
 0217                var query = new InternalItemsQuery(user)
 0218                {
 0219                    Recursive = true,
 0220                    IsFolder = false,
 0221                    MediaTypes = [MediaType.Audio, MediaType.Video],
 0222                    EnableTotalRecordCount = false,
 0223                    DtoOptions = options
 0224                };
 225
 0226                return folder.GetItemList(query);
 227            }
 228
 0229            return [item];
 230        }
 231
 232        public override bool IsVisible(User user, bool skipAllowedTagsCheck = false)
 233        {
 0234            if (!IsSharedItem)
 235            {
 0236                return base.IsVisible(user, skipAllowedTagsCheck);
 237            }
 238
 0239            if (OpenAccess)
 240            {
 0241                return true;
 242            }
 243
 0244            var userId = user.Id;
 0245            if (userId.Equals(OwnerUserId))
 246            {
 0247                return true;
 248            }
 249
 0250            var shares = Shares;
 0251            if (shares.Count == 0)
 252            {
 0253                return false;
 254            }
 255
 0256            return shares.Any(s => s.UserId.Equals(userId));
 257        }
 258
 259        public override bool CanDelete(User user)
 260        {
 0261            return user.HasPermission(PermissionKind.IsAdministrator) || user.Id.Equals(OwnerUserId);
 262        }
 263
 264        public override bool IsVisibleStandalone(User user)
 265        {
 0266            if (!IsSharedItem)
 267            {
 0268                return base.IsVisibleStandalone(user);
 269            }
 270
 0271            return IsVisible(user);
 272        }
 273    }
 274}
Generated by: ReportGenerator 5.4.5.0
4/3/2025 - 12:11:22 AM
GitHub | reportgenerator.io

Methods/Properties

.cctor()
.ctor()
get_IsFile()
get_ContainingFolderPath()
get_FilterLinkedChildrenPerUser()
get_SupportsInheritedParentImages()
get_SupportsPlayedStatus()
get_AlwaysScanInternalMetadataPath()
get_SupportsCumulativeRunTimeTicks()
get_IsPreSorted()
get_MediaType()
get_IsSharedItem()
IsPlaylistFile(System.String)
SetMediaType(System.Nullable`1<Jellyfin.Data.Enums.MediaType>)
GetDefaultPrimaryImageAspectRatio()
IsAuthorizedToDelete(Jellyfin.Database.Implementations.Entities.User,System.Collections.Generic.List`1<MediaBrowser.Controller.Entities.Folder>)
IsSaveLocalMetadataEnabled()
LoadChildren()
ValidateChildrenInternal(System.IProgress`1<System.Double>,System.Boolean,System.Boolean,System.Boolean,MediaBrowser.Controller.Providers.MetadataRefreshOptions,MediaBrowser.Controller.Providers.IDirectoryService,System.Threading.CancellationToken)
GetChildren(Jellyfin.Database.Implementations.Entities.User,System.Boolean,MediaBrowser.Controller.Entities.InternalItemsQuery)
GetNonCachedChildren(MediaBrowser.Controller.Providers.IDirectoryService)
GetRecursiveChildren(Jellyfin.Database.Implementations.Entities.User,MediaBrowser.Controller.Entities.InternalItemsQuery)
GetManageableItems()
GetPlayableItems(Jellyfin.Database.Implementations.Entities.User,MediaBrowser.Controller.Entities.InternalItemsQuery)
GetPlaylistItems(System.Collections.Generic.IEnumerable`1<MediaBrowser.Controller.Entities.BaseItem>,Jellyfin.Database.Implementations.Entities.User,MediaBrowser.Controller.Dto.DtoOptions)
GetPlaylistItems(MediaBrowser.Controller.Entities.BaseItem,Jellyfin.Database.Implementations.Entities.User,MediaBrowser.Controller.Dto.DtoOptions)
IsVisible(Jellyfin.Database.Implementations.Entities.User,System.Boolean)
CanDelete(Jellyfin.Database.Implementations.Entities.User)
IsVisibleStandalone(Jellyfin.Database.Implementations.Entities.User)