New: Improved Plex Media Server authentication (Manually update settings)

Co-Authored-By: Mark McDowall <markus101@users.noreply.github.com>

src/NzbDrone.Core/Notifications/Plex/Server/PlexServerService.cs

@@ -0,0 +1,185 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text.RegularExpressions;
+using FluentValidation.Results;
+using NLog;
+using NzbDrone.Common.Cache;
+using NzbDrone.Common.Extensions;
+using NzbDrone.Core.Music;
+
+namespace NzbDrone.Core.Notifications.Plex.Server
+{
+    public interface IPlexServerService
+    {
+        void UpdateLibrary(Artist artist, PlexServerSettings settings);
+        ValidationFailure Test(PlexServerSettings settings);
+    }
+
+    public class PlexServerService : IPlexServerService
+    {
+        private readonly ICached<Version> _versionCache;
+        private readonly ICached<bool> _partialUpdateCache;
+        private readonly IPlexServerProxy _plexServerProxy;
+        private readonly Logger _logger;
+
+        public PlexServerService(ICacheManager cacheManager, IPlexServerProxy plexServerProxy, Logger logger)
+        {
+            _versionCache = cacheManager.GetCache<Version>(GetType(), "versionCache");
+            _partialUpdateCache = cacheManager.GetCache<bool>(GetType(), "partialUpdateCache");
+            _plexServerProxy = plexServerProxy;
+            _logger = logger;
+        }
+
+        public void UpdateLibrary(Artist artist, PlexServerSettings settings)
+        {
+            try
+            {
+                _logger.Debug("Sending Update Request to Plex Server");
+
+                var version = _versionCache.Get(settings.Host, () => GetVersion(settings), TimeSpan.FromHours(2));
+                ValidateVersion(version);
+
+                var sections = GetSections(settings);
+                var partialUpdates = _partialUpdateCache.Get(settings.Host, () => PartialUpdatesAllowed(settings, version), TimeSpan.FromHours(2));
+
+                if (partialUpdates)
+                {
+                    UpdatePartialSection(artist, sections, settings);
+                }
+
+                else
+                {
+                    sections.ForEach(s => UpdateSection(s.Id, settings));
+                }
+            }
+
+            catch(Exception ex)
+            {
+                _logger.Warn(ex, "Failed to Update Plex host: " + settings.Host);
+                throw;
+            }
+        }
+
+        private List<PlexSection> GetSections(PlexServerSettings settings)
+        {
+            _logger.Debug("Getting sections from Plex host: {0}", settings.Host);
+
+            return _plexServerProxy.GetArtistSections(settings).ToList();
+        }
+
+        private bool PartialUpdatesAllowed(PlexServerSettings settings, Version version)
+        {
+            try
+            {
+                if (version >= new Version(0, 9, 12, 0))
+                {
+                    var preferences = GetPreferences(settings);
+                    var partialScanPreference = preferences.SingleOrDefault(p => p.Id.Equals("FSEventLibraryPartialScanEnabled"));
+
+                    if (partialScanPreference == null)
+                    {
+                        return false;
+                    }
+
+                    return Convert.ToBoolean(partialScanPreference.Value);
+                }
+            }
+            catch (Exception ex)
+            {
+                _logger.Warn(ex, "Unable to check if partial updates are allowed");
+            }
+
+            return false;
+        }
+
+        private void ValidateVersion(Version version)
+        {
+            if (version >= new Version(1, 3, 0) && version < new Version(1, 3, 1))
+            {
+                throw new PlexVersionException("Found version {0}, upgrade to PMS 1.3.1 to fix library updating and then restart Lidarr", version);
+            }
+        }
+
+        private Version GetVersion(PlexServerSettings settings)
+        {
+            _logger.Debug("Getting version from Plex host: {0}", settings.Host);
+
+            var rawVersion = _plexServerProxy.Version(settings);
+            var version = new Version(Regex.Match(rawVersion, @"^(\d+[.-]){4}").Value.Trim('.', '-'));
+            
+            return version;
+        }
+
+        private List<PlexPreference> GetPreferences(PlexServerSettings settings)
+        {
+            _logger.Debug("Getting preferences from Plex host: {0}", settings.Host);
+
+            return _plexServerProxy.Preferences(settings);
+        }
+
+        private void UpdateSection(int sectionId, PlexServerSettings settings)
+        {
+            _logger.Debug("Updating Plex host: {0}, Section: {1}", settings.Host, sectionId);
+
+            _plexServerProxy.Update(sectionId, settings);
+        }
+
+        private void UpdatePartialSection(Artist artist, List<PlexSection> sections, PlexServerSettings settings)
+        {
+            var partiallyUpdated = false;
+
+            foreach (var section in sections)
+            {
+                var metadataId = GetMetadataId(section.Id, artist, section.Language, settings);
+
+                if (metadataId.HasValue)
+                {
+                    _logger.Debug("Updating Plex host: {0}, Section: {1}, Artist: {2}", settings.Host, section.Id, artist);
+                    _plexServerProxy.UpdateArtist(metadataId.Value, settings);
+
+                    partiallyUpdated = true;
+                }
+            }
+
+            // Only update complete sections if all partial updates failed
+            if (!partiallyUpdated)
+            {
+                _logger.Debug("Unable to update partial section, updating all Music sections");
+                sections.ForEach(s => UpdateSection(s.Id, settings));
+            }
+        }
+
+        private int? GetMetadataId(int sectionId, Artist artist, string language, PlexServerSettings settings)
+        {
+            _logger.Debug("Getting metadata from Plex host: {0} for series: {1}", settings.Host, artist);
+
+            return _plexServerProxy.GetMetadataId(sectionId, artist.ForeignArtistId, language, settings);
+        }
+
+        public ValidationFailure Test(PlexServerSettings settings)
+        {
+            try
+            {
+                var sections = GetSections(settings);
+
+                if (sections.Empty())
+                {
+                    return new ValidationFailure("Host", "At least one Music library is required");
+                }
+            }
+            catch(PlexAuthenticationException ex)
+            {
+                _logger.Error(ex, "Unable to connect to Plex Server");
+                return new ValidationFailure("AuthToken", "Invalid authentication token");
+            }
+            catch (Exception ex)
+            {
+                _logger.Error(ex, "Unable to connect to Plex Server");
+                return new ValidationFailure("Host", "Unable to connect to Plex Server");
+            }
+
+            return null;
+        }
+    }
+}