jellyfin/MediaBrowser.Controller/Entities/Audio/MusicAlbum.cs

276 lines
7.7 KiB
C#
Raw Normal View History

2016-02-01 17:22:02 +00:00
using System;
using MediaBrowser.Controller.Providers;
2014-02-07 03:10:13 +00:00
using MediaBrowser.Model.Configuration;
2013-12-26 16:53:23 +00:00
using MediaBrowser.Model.Entities;
using MediaBrowser.Model.Users;
2013-09-11 17:54:59 +00:00
using System.Collections.Generic;
using System.Linq;
2016-10-25 19:02:04 +00:00
using MediaBrowser.Model.Serialization;
2016-02-01 17:22:02 +00:00
using System.Threading;
using System.Threading.Tasks;
2017-05-22 04:54:02 +00:00
using MediaBrowser.Controller.Dto;
2016-02-01 17:22:02 +00:00
using MediaBrowser.Controller.Library;
2013-02-21 01:33:05 +00:00
namespace MediaBrowser.Controller.Entities.Audio
{
/// <summary>
/// Class MusicAlbum
/// </summary>
2016-02-01 17:22:02 +00:00
public class MusicAlbum : Folder, IHasAlbumArtist, IHasArtist, IHasMusicGenres, IHasLookupInfo<AlbumInfo>, IMetadataContainer
2013-02-21 01:33:05 +00:00
{
2017-08-10 18:01:31 +00:00
public string[] AlbumArtists { get; set; }
2017-08-24 19:52:19 +00:00
public string[] Artists { get; set; }
2016-10-11 06:46:59 +00:00
public MusicAlbum()
{
2017-08-24 19:52:19 +00:00
Artists = EmptyStringArray;
2017-08-10 18:01:31 +00:00
AlbumArtists = EmptyStringArray;
}
2014-08-30 14:26:29 +00:00
[IgnoreDataMember]
public override bool SupportsAddingToPlaylist
{
get { return true; }
}
2016-12-17 08:27:41 +00:00
[IgnoreDataMember]
public override bool SupportsInheritedParentImages
{
get { return true; }
}
[IgnoreDataMember]
public MusicArtist MusicArtist
{
2017-05-22 04:54:02 +00:00
get { return GetMusicArtist(new DtoOptions(true)); }
}
2016-03-14 01:34:24 +00:00
2017-05-22 04:54:02 +00:00
public MusicArtist GetMusicArtist(DtoOptions options)
{
2017-08-24 19:52:19 +00:00
var parents = GetParents();
foreach (var parent in parents)
2017-05-22 04:54:02 +00:00
{
2017-08-24 19:52:19 +00:00
var artist = parent as MusicArtist;
if (artist != null)
2016-03-14 01:34:24 +00:00
{
2017-08-24 19:52:19 +00:00
return artist;
2016-03-14 01:34:24 +00:00
}
}
2017-08-24 19:52:19 +00:00
var name = AlbumArtist;
if (!string.IsNullOrWhiteSpace(name))
{
return LibraryManager.GetArtist(name, options);
}
return null;
}
2016-10-11 06:46:59 +00:00
[IgnoreDataMember]
public override bool SupportsPlayedStatus
{
get
{
return false;
}
}
2016-05-09 03:13:38 +00:00
[IgnoreDataMember]
public override bool SupportsCumulativeRunTimeTicks
{
get
{
return true;
}
}
[IgnoreDataMember]
2017-08-24 19:52:19 +00:00
public string[] AllArtists
2014-06-23 16:05:19 +00:00
{
get
{
2017-08-24 19:52:19 +00:00
var list = new string[AlbumArtists.Length + Artists.Length];
2014-06-23 16:05:19 +00:00
2017-08-24 19:52:19 +00:00
var index = 0;
foreach (var artist in AlbumArtists)
{
list[index] = artist;
index++;
}
2017-08-26 07:03:19 +00:00
foreach (var artist in Artists)
2017-08-24 19:52:19 +00:00
{
list[index] = artist;
index++;
}
2014-06-23 16:05:19 +00:00
return list;
}
}
2015-01-28 18:10:26 +00:00
[IgnoreDataMember]
public string AlbumArtist
{
2017-08-24 19:52:19 +00:00
get { return AlbumArtists.Length == 0 ? null : AlbumArtists[0]; }
2015-01-28 18:10:26 +00:00
}
2015-08-06 01:21:18 +00:00
[IgnoreDataMember]
public override bool SupportsPeople
{
get { return false; }
}
2014-06-29 17:58:04 +00:00
/// <summary>
/// Gets the tracks.
/// </summary>
/// <value>The tracks.</value>
2015-09-20 02:06:56 +00:00
[IgnoreDataMember]
2017-08-24 19:52:19 +00:00
public IEnumerable<BaseItem> Tracks
2014-06-29 17:58:04 +00:00
{
get
{
2017-08-24 19:52:19 +00:00
return GetRecursiveChildren(i => i is Audio);
2014-06-29 17:58:04 +00:00
}
}
protected override IEnumerable<BaseItem> GetEligibleChildrenForRecursiveChildren(User user)
{
return Tracks;
}
2017-02-10 20:06:52 +00:00
public override double? GetDefaultPrimaryImageAspectRatio()
{
return 1;
}
2016-04-30 23:05:21 +00:00
public override List<string> GetUserDataKeys()
{
2016-04-30 23:05:21 +00:00
var list = base.GetUserDataKeys();
2016-04-30 23:05:21 +00:00
if (ConfigurationManager.Configuration.EnableStandaloneMusicKeys)
{
2016-04-30 23:05:21 +00:00
var albumArtist = AlbumArtist;
if (!string.IsNullOrWhiteSpace(albumArtist))
{
list.Insert(0, albumArtist + "-" + Name);
}
}
2016-04-30 23:05:21 +00:00
var id = this.GetProviderId(MetadataProviders.MusicBrainzAlbum);
2014-11-12 04:51:40 +00:00
if (!string.IsNullOrWhiteSpace(id))
{
2016-04-30 23:05:21 +00:00
list.Insert(0, "MusicAlbum-Musicbrainz-" + id);
}
2016-04-30 23:05:21 +00:00
id = this.GetProviderId(MetadataProviders.MusicBrainzReleaseGroup);
if (!string.IsNullOrWhiteSpace(id))
2016-03-14 01:34:24 +00:00
{
2016-04-30 23:05:21 +00:00
list.Insert(0, "MusicAlbum-MusicBrainzReleaseGroup-" + id);
2016-03-14 01:34:24 +00:00
}
2016-04-30 23:05:21 +00:00
return list;
}
2013-12-26 16:53:23 +00:00
2014-12-20 06:06:27 +00:00
protected override bool GetBlockUnratedValue(UserPolicy config)
2013-12-26 16:53:23 +00:00
{
return config.BlockUnratedItems.Contains(UnratedItem.Music);
2013-12-26 16:53:23 +00:00
}
2014-02-07 03:10:13 +00:00
2015-11-06 15:02:22 +00:00
public override UnratedItem GetBlockUnratedType()
{
return UnratedItem.Music;
}
2014-02-07 03:10:13 +00:00
public AlbumInfo GetLookupInfo()
{
var id = GetItemLookupInfo<AlbumInfo>();
2014-06-23 16:05:19 +00:00
id.AlbumArtists = AlbumArtists;
2014-02-07 03:10:13 +00:00
2017-05-22 04:54:02 +00:00
var artist = GetMusicArtist(new DtoOptions(false));
2014-02-07 03:10:13 +00:00
if (artist != null)
{
id.ArtistProviderIds = artist.ProviderIds;
}
2015-01-25 06:34:50 +00:00
id.SongInfos = GetRecursiveChildren(i => i is Audio)
.Cast<Audio>()
2014-02-07 03:10:13 +00:00
.Select(i => i.GetLookupInfo())
.ToList();
2015-05-31 18:22:51 +00:00
var album = id.SongInfos
.Select(i => i.Album)
.FirstOrDefault(i => !string.IsNullOrWhiteSpace(i));
if (!string.IsNullOrWhiteSpace(album))
{
id.Name = album;
}
2014-02-07 03:10:13 +00:00
return id;
}
2016-02-01 17:22:02 +00:00
public async Task RefreshAllMetadata(MetadataRefreshOptions refreshOptions, IProgress<double> progress, CancellationToken cancellationToken)
{
2017-08-24 19:52:19 +00:00
var items = GetRecursiveChildren();
2016-02-01 17:22:02 +00:00
2016-05-29 20:20:32 +00:00
var totalItems = items.Count;
2016-02-01 17:22:02 +00:00
var numComplete = 0;
var childUpdateType = ItemUpdateType.None;
// Refresh songs
2016-05-29 20:20:32 +00:00
foreach (var item in items)
2016-02-01 17:22:02 +00:00
{
cancellationToken.ThrowIfCancellationRequested();
var updateType = await item.RefreshMetadata(refreshOptions, cancellationToken).ConfigureAwait(false);
childUpdateType = childUpdateType | updateType;
numComplete++;
double percent = numComplete;
percent /= totalItems;
2016-05-29 20:20:32 +00:00
progress.Report(percent * 95);
2016-02-01 17:22:02 +00:00
}
var parentRefreshOptions = refreshOptions;
if (childUpdateType > ItemUpdateType.None)
{
parentRefreshOptions = new MetadataRefreshOptions(refreshOptions);
parentRefreshOptions.MetadataRefreshMode = MetadataRefreshMode.FullRefresh;
}
// Refresh current item
await RefreshMetadata(parentRefreshOptions, cancellationToken).ConfigureAwait(false);
2017-04-15 19:45:33 +00:00
if (!refreshOptions.IsAutomated)
{
await RefreshArtists(refreshOptions, cancellationToken).ConfigureAwait(false);
}
2016-02-01 17:22:02 +00:00
}
2017-04-15 19:45:33 +00:00
private async Task RefreshArtists(MetadataRefreshOptions refreshOptions, CancellationToken cancellationToken)
{
2017-08-24 19:52:19 +00:00
var all = AllArtists;
foreach (var i in all)
2017-04-15 19:45:33 +00:00
{
// This should not be necessary but we're seeing some cases of it
if (string.IsNullOrWhiteSpace(i))
{
2017-08-24 19:52:19 +00:00
continue;
2017-04-15 19:45:33 +00:00
}
var artist = LibraryManager.GetArtist(i);
if (!artist.IsAccessedByName)
{
2017-08-24 19:52:19 +00:00
continue;
2017-04-15 19:45:33 +00:00
}
await artist.RefreshMetadata(refreshOptions, cancellationToken).ConfigureAwait(false);
}
}
2013-02-21 01:33:05 +00:00
}
2015-09-20 17:34:05 +00:00
}