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

340 lines
9.8 KiB
C#
Raw Normal View History

using MediaBrowser.Controller.Library;
using MediaBrowser.Controller.Providers;
using MediaBrowser.Model.Configuration;
2013-11-21 20:48:26 +00:00
using MediaBrowser.Model.Entities;
2015-02-06 05:39:07 +00:00
using MediaBrowser.Model.Users;
2013-11-21 20:48:26 +00:00
using System;
using System.Collections.Generic;
2014-02-06 23:54:33 +00:00
using System.Linq;
2016-10-25 19:02:04 +00:00
using MediaBrowser.Model.Serialization;
2013-11-26 21:36:11 +00:00
using System.Threading;
using System.Threading.Tasks;
2016-06-17 13:06:13 +00:00
using MediaBrowser.Common.Extensions;
using MediaBrowser.Controller.Extensions;
2016-10-23 19:47:34 +00:00
using MediaBrowser.Model.Extensions;
2013-11-21 20:48:26 +00:00
2013-02-21 01:33:05 +00:00
namespace MediaBrowser.Controller.Entities.Audio
{
/// <summary>
/// Class MusicArtist
/// </summary>
2016-10-08 05:57:38 +00:00
public class MusicArtist : Folder, IMetadataContainer, IItemByName, IHasMusicGenres, IHasDualAccess, IHasLookupInfo<ArtistInfo>
2013-02-21 01:33:05 +00:00
{
2016-05-07 18:58:16 +00:00
[IgnoreDataMember]
public bool IsAccessedByName
{
get { return ParentId == Guid.Empty; }
}
2015-01-26 22:47:16 +00:00
[IgnoreDataMember]
2013-11-21 20:48:26 +00:00
public override bool IsFolder
{
get
{
return !IsAccessedByName;
}
}
2017-06-29 19:10:58 +00:00
[IgnoreDataMember]
public override bool SupportsInheritedParentImages
{
get
{
return false;
}
}
2016-05-09 03:13:38 +00:00
[IgnoreDataMember]
public override bool SupportsCumulativeRunTimeTicks
{
get
{
return true;
}
}
2017-01-06 04:38:03 +00:00
[IgnoreDataMember]
public override bool IsDisplayedAsFolder
{
get
{
return true;
}
}
2014-08-30 14:26:29 +00:00
[IgnoreDataMember]
public override bool SupportsAddingToPlaylist
{
get { return true; }
}
2016-10-11 06:46:59 +00:00
[IgnoreDataMember]
public override bool SupportsPlayedStatus
{
get
{
return false;
}
}
2017-02-10 20:06:52 +00:00
public override double? GetDefaultPrimaryImageAspectRatio()
{
return 1;
}
2015-02-06 05:39:07 +00:00
public override bool CanDelete()
{
return !IsAccessedByName;
}
2016-05-07 17:47:41 +00:00
public IEnumerable<BaseItem> GetTaggedItems(InternalItemsQuery query)
{
2016-05-18 05:34:10 +00:00
if (query.IncludeItemTypes.Length == 0)
{
query.IncludeItemTypes = new[] { typeof(Audio).Name, typeof(MusicVideo).Name, typeof(MusicAlbum).Name };
2016-12-20 19:59:25 +00:00
query.ArtistIds = new[] { Id.ToString("N") };
2016-05-18 05:34:10 +00:00
}
2016-05-07 17:47:41 +00:00
2016-05-18 05:34:10 +00:00
return LibraryManager.GetItemList(query);
2016-05-07 17:47:41 +00:00
}
2016-05-19 19:06:58 +00:00
[IgnoreDataMember]
2017-06-03 07:36:32 +00:00
public override IEnumerable<BaseItem> Children
2013-11-21 20:48:26 +00:00
{
get
{
if (IsAccessedByName)
{
2013-11-26 21:36:11 +00:00
return new List<BaseItem>();
2013-11-21 20:48:26 +00:00
}
2017-06-03 07:36:32 +00:00
return base.Children;
2013-11-21 20:48:26 +00:00
}
}
2016-06-16 18:18:38 +00:00
public override int GetChildCount(User user)
{
if (IsAccessedByName)
{
return 0;
}
return base.GetChildCount(user);
}
2015-02-19 04:37:44 +00:00
public override bool IsSaveLocalMetadataEnabled()
{
if (IsAccessedByName)
{
return true;
}
return base.IsSaveLocalMetadataEnabled();
}
2014-02-03 17:44:13 +00:00
private readonly Task _cachedTask = Task.FromResult(true);
2014-02-10 18:39:41 +00:00
protected override Task ValidateChildrenInternal(IProgress<double> progress, CancellationToken cancellationToken, bool recursive, bool refreshChildMetadata, MetadataRefreshOptions refreshOptions, IDirectoryService directoryService)
2013-11-26 21:36:11 +00:00
{
if (IsAccessedByName)
{
// Should never get in here anyway
2014-02-03 17:44:13 +00:00
return _cachedTask;
2013-11-26 21:36:11 +00:00
}
2014-02-08 22:38:02 +00:00
return base.ValidateChildrenInternal(progress, cancellationToken, recursive, refreshChildMetadata, refreshOptions, directoryService);
2013-11-21 20:48:26 +00:00
}
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();
list.InsertRange(0, GetUserDataKeys(this));
return list;
2013-11-21 20:48:26 +00:00
}
/// <summary>
/// Returns the folder containing the item.
/// If the item is a folder, it returns the folder itself
/// </summary>
/// <value>The containing folder path.</value>
2015-01-26 22:47:16 +00:00
[IgnoreDataMember]
public override string ContainingFolderPath
{
get
{
return Path;
}
}
/// <summary>
/// Gets a value indicating whether this instance is owned item.
/// </summary>
/// <value><c>true</c> if this instance is owned item; otherwise, <c>false</c>.</value>
2015-01-26 22:47:16 +00:00
[IgnoreDataMember]
public override bool IsOwnedItem
{
get
{
return false;
}
}
2013-11-21 20:48:26 +00:00
/// <summary>
/// Gets the user data key.
/// </summary>
/// <param name="item">The item.</param>
/// <returns>System.String.</returns>
2016-04-30 23:05:21 +00:00
private static List<string> GetUserDataKeys(MusicArtist item)
2013-11-21 20:48:26 +00:00
{
2016-04-30 23:05:21 +00:00
var list = new List<string>();
var id = item.GetProviderId(MetadataProviders.MusicBrainzArtist);
2013-11-21 20:48:26 +00:00
if (!string.IsNullOrEmpty(id))
{
2016-04-30 23:05:21 +00:00
list.Add("Artist-Musicbrainz-" + id);
2013-11-21 20:48:26 +00:00
}
2016-06-17 13:06:13 +00:00
list.Add("Artist-" + (item.Name ?? string.Empty).RemoveDiacritics());
2016-04-30 23:05:21 +00:00
return list;
}
public override string CreatePresentationUniqueKey()
2016-06-17 13:06:13 +00:00
{
return "Artist-" + (Name ?? string.Empty).RemoveDiacritics();
2016-06-17 13:06:13 +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-06 23:54:33 +00:00
2015-11-06 15:02:22 +00:00
public override UnratedItem GetBlockUnratedType()
{
return UnratedItem.Music;
}
2014-02-06 23:54:33 +00:00
public async Task RefreshAllMetadata(MetadataRefreshOptions refreshOptions, IProgress<double> progress, CancellationToken cancellationToken)
{
var items = GetRecursiveChildren();
2014-02-06 23:54:33 +00:00
var songs = items.OfType<Audio>().ToList();
var others = items.Except(songs).ToList();
var totalItems = songs.Count + others.Count;
var numComplete = 0;
2014-02-06 23:54:33 +00:00
var childUpdateType = ItemUpdateType.None;
2014-02-06 23:54:33 +00:00
// Refresh songs
foreach (var item in songs)
{
cancellationToken.ThrowIfCancellationRequested();
var updateType = await item.RefreshMetadata(refreshOptions, cancellationToken).ConfigureAwait(false);
childUpdateType = childUpdateType | updateType;
2014-02-06 23:54:33 +00:00
numComplete++;
double percent = numComplete;
percent /= totalItems;
progress.Report(percent * 100);
}
2014-02-06 23:54:33 +00:00
var parentRefreshOptions = refreshOptions;
if (childUpdateType > ItemUpdateType.None)
{
parentRefreshOptions = new MetadataRefreshOptions(refreshOptions);
parentRefreshOptions.MetadataRefreshMode = MetadataRefreshMode.FullRefresh;
}
2014-02-06 23:54:33 +00:00
// Refresh current item
await RefreshMetadata(parentRefreshOptions, cancellationToken).ConfigureAwait(false);
2015-01-25 06:34:50 +00:00
2014-02-06 23:54:33 +00:00
// Refresh all non-songs
foreach (var item in others)
{
cancellationToken.ThrowIfCancellationRequested();
var updateType = await item.RefreshMetadata(parentRefreshOptions, cancellationToken).ConfigureAwait(false);
2014-02-06 23:54:33 +00:00
numComplete++;
double percent = numComplete;
percent /= totalItems;
progress.Report(percent * 100);
2014-02-06 23:54:33 +00:00
}
}
2014-02-07 03:10:13 +00:00
public ArtistInfo GetLookupInfo()
{
var info = GetItemLookupInfo<ArtistInfo>();
2015-01-25 06:34:50 +00:00
info.SongInfos = GetRecursiveChildren(i => i is Audio)
.Cast<Audio>()
2014-02-07 03:10:13 +00:00
.Select(i => i.GetLookupInfo())
.ToList();
return info;
}
2015-06-29 01:10:45 +00:00
[IgnoreDataMember]
public override bool SupportsPeople
{
get
{
return false;
}
}
2016-08-18 05:56:10 +00:00
2017-03-13 04:08:23 +00:00
public static string GetPath(string name)
{
return GetPath(name, true);
}
public static string GetPath(string name, bool normalizeName)
2016-08-18 05:56:10 +00:00
{
// Trim the period at the end because windows will have a hard time with that
var validName = normalizeName ?
FileSystem.GetValidFilename(name).Trim().TrimEnd('.') :
name;
return System.IO.Path.Combine(ConfigurationManager.ApplicationPaths.ArtistsPath, validName);
}
private string GetRebasedPath()
{
return GetPath(System.IO.Path.GetFileName(Path), false);
}
public override bool RequiresRefresh()
{
if (IsAccessedByName)
{
var newPath = GetRebasedPath();
if (!string.Equals(Path, newPath, StringComparison.Ordinal))
{
Logger.Debug("{0} path has changed from {1} to {2}", GetType().Name, Path, newPath);
return true;
}
}
return base.RequiresRefresh();
}
/// <summary>
/// This is called before any metadata refresh and returns true or false indicating if changes were made
/// </summary>
public override bool BeforeMetadataRefresh()
{
var hasChanges = base.BeforeMetadataRefresh();
if (IsAccessedByName)
{
var newPath = GetRebasedPath();
if (!string.Equals(Path, newPath, StringComparison.Ordinal))
{
Path = newPath;
hasChanges = true;
}
}
return hasChanges;
}
2013-02-21 01:33:05 +00:00
}
}