aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLukePulverenti <luke.pulverenti@gmail.com>2013-03-03 13:34:49 -0500
committerLukePulverenti <luke.pulverenti@gmail.com>2013-03-03 13:34:49 -0500
commit401b56c732f7b22bce844770f75fcddbcc803092 (patch)
treece3602e51ad0abe449e4de2ca0da5125aa3e9582
parent6b851b690ba3477211cb5fe86d8de7467cf5c5b7 (diff)
parent77c894d228f4be978ff09adba8b6f0b7db943f5b (diff)
Merge branch 'master' of https://github.com/MediaBrowser/MediaBrowser
-rw-r--r--MediaBrowser.Controller/MediaBrowser.Controller.csproj1
-rw-r--r--MediaBrowser.Controller/Providers/Music/LastfmBaseProvider.cs202
-rw-r--r--MediaBrowser.Model/Entities/MetadataProviders.cs6
3 files changed, 208 insertions, 1 deletions
diff --git a/MediaBrowser.Controller/MediaBrowser.Controller.csproj b/MediaBrowser.Controller/MediaBrowser.Controller.csproj
index 2b3af2784..319289f94 100644
--- a/MediaBrowser.Controller/MediaBrowser.Controller.csproj
+++ b/MediaBrowser.Controller/MediaBrowser.Controller.csproj
@@ -136,6 +136,7 @@
<Compile Include="Plugins\IPluginConfigurationPage.cs" />
<Compile Include="Plugins\IServerEntryPoint.cs" />
<Compile Include="Plugins\PluginSecurityManager.cs" />
+ <Compile Include="Providers\Music\LastfmBaseProvider.cs" />
<Compile Include="Providers\FanartBaseProvider.cs" />
<Compile Include="Providers\IImageEnhancer.cs" />
<Compile Include="Providers\ImagesByNameProvider.cs" />
diff --git a/MediaBrowser.Controller/Providers/Music/LastfmBaseProvider.cs b/MediaBrowser.Controller/Providers/Music/LastfmBaseProvider.cs
new file mode 100644
index 000000000..364986130
--- /dev/null
+++ b/MediaBrowser.Controller/Providers/Music/LastfmBaseProvider.cs
@@ -0,0 +1,202 @@
+using System.Net;
+using MediaBrowser.Common.Net;
+using MediaBrowser.Controller.Entities;
+using MediaBrowser.Model.Entities;
+using MediaBrowser.Model.Logging;
+using System;
+using System.Threading;
+using System.Threading.Tasks;
+using MediaBrowser.Model.Serialization;
+
+namespace MediaBrowser.Controller.Providers.Music
+{
+ class LastfmProviderException : ApplicationException
+ {
+ public LastfmProviderException(string msg)
+ : base(msg)
+ {
+ }
+
+ }
+ /// <summary>
+ /// Class MovieDbProvider
+ /// </summary>
+ public abstract class LastfmBaseProvider : BaseMetadataProvider
+ {
+ /// <summary>
+ /// Gets the json serializer.
+ /// </summary>
+ /// <value>The json serializer.</value>
+ protected IJsonSerializer JsonSerializer { get; private set; }
+
+ /// <summary>
+ /// Gets the HTTP client.
+ /// </summary>
+ /// <value>The HTTP client.</value>
+ protected IHttpClient HttpClient { get; private set; }
+
+ /// <summary>
+ /// The name of the local json meta file for this item type
+ /// </summary>
+ protected string LocalMetaFileName { get; set; }
+
+ /// <summary>
+ /// Initializes a new instance of the <see cref="LastfmBaseProvider" /> class.
+ /// </summary>
+ /// <param name="jsonSerializer">The json serializer.</param>
+ /// <param name="httpClient">The HTTP client.</param>
+ /// <param name="logManager">The Log manager</param>
+ /// <exception cref="System.ArgumentNullException">jsonSerializer</exception>
+ public LastfmBaseProvider(IJsonSerializer jsonSerializer, IHttpClient httpClient, ILogManager logManager)
+ : base(logManager)
+ {
+ if (jsonSerializer == null)
+ {
+ throw new ArgumentNullException("jsonSerializer");
+ }
+ if (httpClient == null)
+ {
+ throw new ArgumentNullException("httpClient");
+ }
+ JsonSerializer = jsonSerializer;
+ HttpClient = httpClient;
+ }
+
+ /// <summary>
+ /// Gets the priority.
+ /// </summary>
+ /// <value>The priority.</value>
+ public override MetadataProviderPriority Priority
+ {
+ get { return MetadataProviderPriority.Second; }
+ }
+
+ /// <summary>
+ /// Gets a value indicating whether [requires internet].
+ /// </summary>
+ /// <value><c>true</c> if [requires internet]; otherwise, <c>false</c>.</value>
+ public override bool RequiresInternet
+ {
+ get
+ {
+ return true;
+ }
+ }
+
+ /// <summary>
+ /// If we save locally, refresh if they delete something
+ /// </summary>
+ protected override bool RefreshOnFileSystemStampChange
+ {
+ get
+ {
+ return Kernel.Instance.Configuration.SaveLocalMeta;
+ }
+ }
+
+ protected const string RootUrl = @"http://ws.audioscrobbler.com/2.0/";
+ protected static string ApiKey = "7b76553c3eb1d341d642755aecc40a33";
+
+ protected override bool NeedsRefreshInternal(BaseItem item, BaseProviderInfo providerInfo)
+ {
+ if (item.DontFetchMeta) return false;
+
+ if (Kernel.Instance.Configuration.SaveLocalMeta && HasFileSystemStampChanged(item, providerInfo))
+ {
+ //If they deleted something from file system, chances are, this item was mis-identified the first time
+ item.SetProviderId(MetadataProviders.Musicbrainz, null);
+ Logger.Debug("LastfmProvider reports file system stamp change...");
+ return true;
+
+ }
+
+ if (providerInfo.LastRefreshStatus == ProviderRefreshStatus.CompletedWithErrors)
+ {
+ Logger.Debug("LastfmProvider for {0} - last attempt had errors. Will try again.", item.Path);
+ return true;
+ }
+
+ var downloadDate = providerInfo.LastRefreshed;
+
+ if (Kernel.Instance.Configuration.MetadataRefreshDays == -1 && downloadDate != DateTime.MinValue)
+ {
+ return false;
+ }
+
+ if (DateTime.Today.Subtract(item.DateCreated).TotalDays > 180 && downloadDate != DateTime.MinValue)
+ return false; // don't trigger a refresh data for item that are more than 6 months old and have been refreshed before
+
+ if (DateTime.Today.Subtract(downloadDate).TotalDays < Kernel.Instance.Configuration.MetadataRefreshDays) // only refresh every n days
+ return false;
+
+
+ Logger.Debug("LastfmProvider - " + item.Name + " needs refresh. Download date: " + downloadDate + " item created date: " + item.DateCreated + " Check for Update age: " + Kernel.Instance.Configuration.MetadataRefreshDays);
+ return true;
+ }
+
+ /// <summary>
+ /// Fetches metadata and returns true or false indicating if any work that requires persistence was done
+ /// </summary>
+ /// <param name="item">The item.</param>
+ /// <param name="force">if set to <c>true</c> [force].</param>
+ /// <param name="cancellationToken">The cancellation token</param>
+ /// <returns>Task{System.Boolean}.</returns>
+ protected override async Task<bool> FetchAsyncInternal(BaseItem item, bool force, CancellationToken cancellationToken)
+ {
+ if (item.DontFetchMeta)
+ {
+ Logger.Info("LastfmProvider - Not fetching because requested to ignore " + item.Name);
+ return false;
+ }
+
+ cancellationToken.ThrowIfCancellationRequested();
+
+ if (!Kernel.Instance.Configuration.SaveLocalMeta || !HasLocalMeta(item) || (force && !HasLocalMeta(item)))
+ {
+ try
+ {
+ await FetchData(item, cancellationToken).ConfigureAwait(false);
+ SetLastRefreshed(item, DateTime.UtcNow);
+ }
+ catch (LastfmProviderException)
+ {
+ SetLastRefreshed(item, DateTime.UtcNow, ProviderRefreshStatus.CompletedWithErrors);
+ }
+
+ return true;
+ }
+ Logger.Debug("LastfmProvider not fetching because local meta exists for " + item.Name);
+ SetLastRefreshed(item, DateTime.UtcNow);
+ return true;
+ }
+
+ /// <summary>
+ /// Determines whether [has local meta] [the specified item].
+ /// </summary>
+ /// <param name="item">The item.</param>
+ /// <returns><c>true</c> if [has local meta] [the specified item]; otherwise, <c>false</c>.</returns>
+ private bool HasLocalMeta(BaseItem item)
+ {
+ return item.ResolveArgs.ContainsMetaFileByName(LocalMetaFileName);
+ }
+
+ /// <summary>
+ /// Fetches the items data.
+ /// </summary>
+ /// <param name="item">The item.</param>
+ /// <param name="cancellationToken"></param>
+ /// <returns>Task.</returns>
+ protected abstract Task FetchData(BaseItem item, CancellationToken cancellationToken);
+
+ /// <summary>
+ /// Encodes an URL.
+ /// </summary>
+ /// <param name="name">The name.</param>
+ /// <returns>System.String.</returns>
+ protected static string UrlEncode(string name)
+ {
+ return WebUtility.UrlEncode(name);
+ }
+
+ }
+}
diff --git a/MediaBrowser.Model/Entities/MetadataProviders.cs b/MediaBrowser.Model/Entities/MetadataProviders.cs
index e5324e1e3..28e4b1646 100644
--- a/MediaBrowser.Model/Entities/MetadataProviders.cs
+++ b/MediaBrowser.Model/Entities/MetadataProviders.cs
@@ -21,6 +21,10 @@ namespace MediaBrowser.Model.Entities
/// <summary>
/// The tvcom
/// </summary>
- Tvcom
+ Tvcom,
+ /// <summary>
+ /// MusicBrainz
+ /// </summary>
+ Musicbrainz
}
}