using System; using System.Collections.Generic; using System.Collections.Specialized; using System.Linq; using FluentValidation.Results; using NLog; using NzbDrone.Common.Disk; using NzbDrone.Common.Extensions; using NzbDrone.Common.Processes; using NzbDrone.Common.Serializer; using NzbDrone.Core.Configuration; using NzbDrone.Core.HealthCheck; using NzbDrone.Core.MediaFiles; using NzbDrone.Core.Music; using NzbDrone.Core.Tags; using NzbDrone.Core.ThingiProvider; using NzbDrone.Core.Validation; namespace NzbDrone.Core.Notifications.CustomScript { public class CustomScript : NotificationBase { private readonly IConfigFileProvider _configFileProvider; private readonly IConfigService _configService; private readonly IDiskProvider _diskProvider; private readonly IProcessProvider _processProvider; private readonly ITagRepository _tagRepository; private readonly Logger _logger; public CustomScript(IConfigFileProvider configFileProvider, IConfigService configService, IDiskProvider diskProvider, IProcessProvider processProvider, ITagRepository tagRepository, Logger logger) { _configFileProvider = configFileProvider; _configService = configService; _diskProvider = diskProvider; _processProvider = processProvider; _tagRepository = tagRepository; _logger = logger; } public override string Name => "Custom Script"; public override string Link => "https://wiki.servarr.com/lidarr/custom-scripts"; public override ProviderMessage Message => new ProviderMessage("Testing will execute the script with the EventType set to Test, ensure your script handles this correctly", ProviderMessageType.Warning); public override void OnGrab(GrabMessage message) { var artist = message.Artist; var remoteAlbum = message.RemoteAlbum; var releaseGroup = remoteAlbum.ParsedAlbumInfo.ReleaseGroup; var environmentVariables = new StringDictionary(); environmentVariables.Add("Lidarr_EventType", "Grab"); environmentVariables.Add("Lidarr_InstanceName", _configFileProvider.InstanceName); environmentVariables.Add("Lidarr_ApplicationUrl", _configService.ApplicationUrl); environmentVariables.Add("Lidarr_Artist_Id", artist.Id.ToString()); environmentVariables.Add("Lidarr_Artist_Name", artist.Metadata.Value.Name); environmentVariables.Add("Lidarr_Artist_MBId", artist.Metadata.Value.ForeignArtistId); environmentVariables.Add("Lidarr_Artist_Type", artist.Metadata.Value.Type); environmentVariables.Add("Lidarr_Artist_Genres", string.Join("|", artist.Metadata.Value.Genres)); environmentVariables.Add("Lidarr_Artist_Tags", string.Join("|", artist.Tags.Select(t => _tagRepository.Get(t).Label))); environmentVariables.Add("Lidarr_Release_AlbumCount", remoteAlbum.Albums.Count.ToString()); environmentVariables.Add("Lidarr_Release_AlbumReleaseDates", string.Join(",", remoteAlbum.Albums.Select(e => e.ReleaseDate))); environmentVariables.Add("Lidarr_Release_AlbumTitles", string.Join("|", remoteAlbum.Albums.Select(e => e.Title))); environmentVariables.Add("Lidarr_Release_AlbumOverviews", string.Join("|", remoteAlbum.Albums.Select(e => e.Overview))); environmentVariables.Add("Lidarr_Release_AlbumMBIds", string.Join("|", remoteAlbum.Albums.Select(e => e.ForeignAlbumId))); environmentVariables.Add("Lidarr_Release_Title", remoteAlbum.Release.Title); environmentVariables.Add("Lidarr_Release_Indexer", remoteAlbum.Release.Indexer ?? string.Empty); environmentVariables.Add("Lidarr_Release_Size", remoteAlbum.Release.Size.ToString()); environmentVariables.Add("Lidarr_Release_Quality", remoteAlbum.ParsedAlbumInfo.Quality.Quality.Name); environmentVariables.Add("Lidarr_Release_QualityVersion", remoteAlbum.ParsedAlbumInfo.Quality.Revision.Version.ToString()); environmentVariables.Add("Lidarr_Release_ReleaseGroup", releaseGroup ?? string.Empty); environmentVariables.Add("Lidarr_Release_IndexerFlags", remoteAlbum.Release.IndexerFlags.ToString()); environmentVariables.Add("Lidarr_Download_Client", message.DownloadClientName ?? string.Empty); environmentVariables.Add("Lidarr_Download_Client_Type", message.DownloadClientType ?? string.Empty); environmentVariables.Add("Lidarr_Download_Id", message.DownloadId ?? string.Empty); environmentVariables.Add("Lidarr_Release_CustomFormat", string.Join("|", remoteAlbum.CustomFormats)); environmentVariables.Add("Lidarr_Release_CustomFormatScore", remoteAlbum.CustomFormatScore.ToString()); ExecuteScript(environmentVariables); } public override void OnReleaseImport(AlbumDownloadMessage message) { var artist = message.Artist; var album = message.Album; var release = message.Release; var environmentVariables = new StringDictionary(); environmentVariables.Add("Lidarr_EventType", "AlbumDownload"); environmentVariables.Add("Lidarr_InstanceName", _configFileProvider.InstanceName); environmentVariables.Add("Lidarr_ApplicationUrl", _configService.ApplicationUrl); environmentVariables.Add("Lidarr_Artist_Id", artist.Id.ToString()); environmentVariables.Add("Lidarr_Artist_Name", artist.Metadata.Value.Name); environmentVariables.Add("Lidarr_Artist_Path", artist.Path); environmentVariables.Add("Lidarr_Artist_MBId", artist.Metadata.Value.ForeignArtistId); environmentVariables.Add("Lidarr_Artist_Type", artist.Metadata.Value.Type); environmentVariables.Add("Lidarr_Artist_Genres", string.Join("|", artist.Metadata.Value.Genres)); environmentVariables.Add("Lidarr_Artist_Tags", string.Join("|", artist.Tags.Select(t => _tagRepository.Get(t).Label))); environmentVariables.Add("Lidarr_Album_Id", album.Id.ToString()); environmentVariables.Add("Lidarr_Album_Title", album.Title); environmentVariables.Add("Lidarr_Album_Overview", album.Overview); environmentVariables.Add("Lidarr_Album_MBId", album.ForeignAlbumId); environmentVariables.Add("Lidarr_AlbumRelease_MBId", release.ForeignReleaseId); environmentVariables.Add("Lidarr_Album_ReleaseDate", album.ReleaseDate.ToString()); environmentVariables.Add("Lidarr_Download_Client", message.DownloadClientInfo?.Name ?? string.Empty); environmentVariables.Add("Lidarr_Download_Client_Type", message.DownloadClientInfo?.Type ?? string.Empty); environmentVariables.Add("Lidarr_Download_Id", message.DownloadId ?? string.Empty); if (message.TrackFiles.Any()) { environmentVariables.Add("Lidarr_AddedTrackPaths", string.Join("|", message.TrackFiles.Select(e => e.Path))); } if (message.OldFiles.Any()) { environmentVariables.Add("Lidarr_DeletedPaths", string.Join("|", message.OldFiles.Select(e => e.Path))); environmentVariables.Add("Lidarr_DeletedDateAdded", string.Join("|", message.OldFiles.Select(e => e.DateAdded))); } ExecuteScript(environmentVariables); } public override void OnRename(Artist artist, List renamedFiles) { var environmentVariables = new StringDictionary(); environmentVariables.Add("Lidarr_EventType", "Rename"); environmentVariables.Add("Lidarr_InstanceName", _configFileProvider.InstanceName); environmentVariables.Add("Lidarr_ApplicationUrl", _configService.ApplicationUrl); environmentVariables.Add("Lidarr_Artist_Id", artist.Id.ToString()); environmentVariables.Add("Lidarr_Artist_Name", artist.Metadata.Value.Name); environmentVariables.Add("Lidarr_Artist_Path", artist.Path); environmentVariables.Add("Lidarr_Artist_MBId", artist.Metadata.Value.ForeignArtistId); environmentVariables.Add("Lidarr_Artist_Type", artist.Metadata.Value.Type); environmentVariables.Add("Lidarr_Artist_Genres", string.Join("|", artist.Metadata.Value.Genres)); environmentVariables.Add("Lidarr_Artist_Tags", string.Join("|", artist.Tags.Select(t => _tagRepository.Get(t).Label))); environmentVariables.Add("Lidarr_TrackFile_Ids", string.Join(",", renamedFiles.Select(e => e.TrackFile.Id))); environmentVariables.Add("Lidarr_TrackFile_Paths", string.Join("|", renamedFiles.Select(e => e.TrackFile.Path))); environmentVariables.Add("Lidarr_TrackFile_PreviousPaths", string.Join("|", renamedFiles.Select(e => e.PreviousPath))); ExecuteScript(environmentVariables); } public override void OnTrackRetag(TrackRetagMessage message) { var artist = message.Artist; var album = message.Album; var release = message.Release; var trackFile = message.TrackFile; var environmentVariables = new StringDictionary(); environmentVariables.Add("Lidarr_EventType", "TrackRetag"); environmentVariables.Add("Lidarr_InstanceName", _configFileProvider.InstanceName); environmentVariables.Add("Lidarr_ApplicationUrl", _configService.ApplicationUrl); environmentVariables.Add("Lidarr_Artist_Id", artist.Id.ToString()); environmentVariables.Add("Lidarr_Artist_Name", artist.Metadata.Value.Name); environmentVariables.Add("Lidarr_Artist_Path", artist.Path); environmentVariables.Add("Lidarr_Artist_MBId", artist.Metadata.Value.ForeignArtistId); environmentVariables.Add("Lidarr_Artist_Type", artist.Metadata.Value.Type); environmentVariables.Add("Lidarr_Artist_Genres", string.Join("|", artist.Metadata.Value.Genres)); environmentVariables.Add("Lidarr_Artist_Tags", string.Join("|", artist.Tags.Select(t => _tagRepository.Get(t).Label))); environmentVariables.Add("Lidarr_Album_Id", album.Id.ToString()); environmentVariables.Add("Lidarr_Album_Title", album.Title); environmentVariables.Add("Lidarr_Album_Overview", album.Overview); environmentVariables.Add("Lidarr_Album_MBId", album.ForeignAlbumId); environmentVariables.Add("Lidarr_AlbumRelease_MBId", release.ForeignReleaseId); environmentVariables.Add("Lidarr_Album_ReleaseDate", album.ReleaseDate.ToString()); environmentVariables.Add("Lidarr_TrackFile_Id", trackFile.Id.ToString()); environmentVariables.Add("Lidarr_TrackFile_TrackCount", trackFile.Tracks.Value.Count.ToString()); environmentVariables.Add("Lidarr_TrackFile_Path", trackFile.Path); environmentVariables.Add("Lidarr_TrackFile_TrackIds", string.Join(",", trackFile.Tracks.Value.Select(e => e.Id))); environmentVariables.Add("Lidarr_TrackFile_TrackNumbers", string.Join(",", trackFile.Tracks.Value.Select(e => e.TrackNumber))); environmentVariables.Add("Lidarr_TrackFile_TrackTitles", string.Join("|", trackFile.Tracks.Value.Select(e => e.Title))); environmentVariables.Add("Lidarr_TrackFile_Quality", trackFile.Quality.Quality.Name); environmentVariables.Add("Lidarr_TrackFile_QualityVersion", trackFile.Quality.Revision.Version.ToString()); environmentVariables.Add("Lidarr_TrackFile_ReleaseGroup", trackFile.ReleaseGroup ?? string.Empty); environmentVariables.Add("Lidarr_TrackFile_SceneName", trackFile.SceneName ?? string.Empty); environmentVariables.Add("Lidarr_Tags_Diff", message.Diff.ToJson()); environmentVariables.Add("Lidarr_Tags_Scrubbed", message.Scrubbed.ToString()); ExecuteScript(environmentVariables); } public override void OnArtistAdd(ArtistAddMessage message) { var artist = message.Artist; var environmentVariables = new StringDictionary(); environmentVariables.Add("Lidarr_EventType", "ArtistAdd"); environmentVariables.Add("Lidarr_InstanceName", _configFileProvider.InstanceName); environmentVariables.Add("Lidarr_ApplicationUrl", _configService.ApplicationUrl); environmentVariables.Add("Lidarr_Artist_Id", artist.Id.ToString()); environmentVariables.Add("Lidarr_Artist_Title", artist.Metadata.Value.Name); environmentVariables.Add("Lidarr_Artist_Path", artist.Path); environmentVariables.Add("Lidarr_Artist_MBId", artist.Metadata.Value.ForeignArtistId.ToString()); environmentVariables.Add("Lidarr_Artist_Type", artist.Metadata.Value.Type); environmentVariables.Add("Lidarr_Artist_Genres", string.Join("|", artist.Metadata.Value.Genres)); environmentVariables.Add("Lidarr_Artist_Tags", string.Join("|", artist.Tags.Select(t => _tagRepository.Get(t).Label))); ExecuteScript(environmentVariables); } public override void OnArtistDelete(ArtistDeleteMessage deleteMessage) { var artist = deleteMessage.Artist; var environmentVariables = new StringDictionary(); environmentVariables.Add("Lidarr_EventType", "ArtistDeleted"); environmentVariables.Add("Lidarr_InstanceName", _configFileProvider.InstanceName); environmentVariables.Add("Lidarr_ApplicationUrl", _configService.ApplicationUrl); environmentVariables.Add("Lidarr_Artist_Id", artist.Id.ToString()); environmentVariables.Add("Lidarr_Artist_Title", artist.Metadata.Value.Name); environmentVariables.Add("Lidarr_Artist_Path", artist.Path); environmentVariables.Add("Lidarr_Artist_MBId", artist.Metadata.Value.ForeignArtistId.ToString()); environmentVariables.Add("Lidarr_Artist_Type", artist.Metadata.Value.Type); environmentVariables.Add("Lidarr_Artist_Genres", string.Join("|", artist.Metadata.Value.Genres)); environmentVariables.Add("Lidarr_Artist_Tags", string.Join("|", artist.Tags.Select(t => _tagRepository.Get(t).Label))); environmentVariables.Add("Lidarr_Artist_DeletedFiles", deleteMessage.DeletedFiles.ToString()); ExecuteScript(environmentVariables); } public override void OnAlbumDelete(AlbumDeleteMessage deleteMessage) { var artist = deleteMessage.Album.Artist.Value; var album = deleteMessage.Album; var environmentVariables = new StringDictionary(); environmentVariables.Add("Lidarr_EventType", "AlbumDeleted"); environmentVariables.Add("Lidarr_InstanceName", _configFileProvider.InstanceName); environmentVariables.Add("Lidarr_ApplicationUrl", _configService.ApplicationUrl); environmentVariables.Add("Lidarr_Artist_Id", artist.Id.ToString()); environmentVariables.Add("Lidarr_Artist_Name", artist.Metadata.Value.Name); environmentVariables.Add("Lidarr_Artist_Path", artist.Path); environmentVariables.Add("Lidarr_Artist_MBId", artist.Metadata.Value.ForeignArtistId); environmentVariables.Add("Lidarr_Artist_Type", artist.Metadata.Value.Type); environmentVariables.Add("Lidarr_Artist_Genres", string.Join("|", artist.Metadata.Value.Genres)); environmentVariables.Add("Lidarr_Artist_Tags", string.Join("|", artist.Tags.Select(t => _tagRepository.Get(t).Label))); environmentVariables.Add("Lidarr_Album_Id", album.Id.ToString()); environmentVariables.Add("Lidarr_Album_Title", album.Title); environmentVariables.Add("Lidarr_Album_Overview", album.Overview); environmentVariables.Add("Lidarr_Album_MBId", album.ForeignAlbumId); environmentVariables.Add("Lidarr_Album_ReleaseDate", album.ReleaseDate.ToString()); environmentVariables.Add("Lidarr_Artist_DeletedFiles", deleteMessage.DeletedFiles.ToString()); ExecuteScript(environmentVariables); } public override void OnHealthIssue(HealthCheck.HealthCheck healthCheck) { var environmentVariables = new StringDictionary(); environmentVariables.Add("Lidarr_EventType", "HealthIssue"); environmentVariables.Add("Lidarr_InstanceName", _configFileProvider.InstanceName); environmentVariables.Add("Lidarr_ApplicationUrl", _configService.ApplicationUrl); environmentVariables.Add("Lidarr_Health_Issue_Level", Enum.GetName(typeof(HealthCheckResult), healthCheck.Type)); environmentVariables.Add("Lidarr_Health_Issue_Message", healthCheck.Message); environmentVariables.Add("Lidarr_Health_Issue_Type", healthCheck.Source.Name); environmentVariables.Add("Lidarr_Health_Issue_Wiki", healthCheck.WikiUrl.ToString() ?? string.Empty); ExecuteScript(environmentVariables); } public override void OnHealthRestored(HealthCheck.HealthCheck previousCheck) { var environmentVariables = new StringDictionary(); environmentVariables.Add("Lidarr_EventType", "HealthRestored"); environmentVariables.Add("Lidarr_InstanceName", _configFileProvider.InstanceName); environmentVariables.Add("Lidarr_ApplicationUrl", _configService.ApplicationUrl); environmentVariables.Add("Lidarr_Health_Restored_Level", Enum.GetName(typeof(HealthCheckResult), previousCheck.Type)); environmentVariables.Add("Lidarr_Health_Restored_Message", previousCheck.Message); environmentVariables.Add("Lidarr_Health_Restored_Type", previousCheck.Source.Name); environmentVariables.Add("Lidarr_Health_Restored_Wiki", previousCheck.WikiUrl.ToString() ?? string.Empty); ExecuteScript(environmentVariables); } public override void OnApplicationUpdate(ApplicationUpdateMessage updateMessage) { var environmentVariables = new StringDictionary(); environmentVariables.Add("Lidarr_EventType", "ApplicationUpdate"); environmentVariables.Add("Lidarr_InstanceName", _configFileProvider.InstanceName); environmentVariables.Add("Lidarr_ApplicationUrl", _configService.ApplicationUrl); environmentVariables.Add("Lidarr_Update_Message", updateMessage.Message); environmentVariables.Add("Lidarr_Update_NewVersion", updateMessage.NewVersion.ToString()); environmentVariables.Add("Lidarr_Update_PreviousVersion", updateMessage.PreviousVersion.ToString()); ExecuteScript(environmentVariables); } public override ValidationResult Test() { var failures = new List(); if (!_diskProvider.FileExists(Settings.Path)) { failures.Add(new NzbDroneValidationFailure("Path", "File does not exist")); } if (failures.Empty()) { try { var environmentVariables = new StringDictionary(); environmentVariables.Add("Lidarr_EventType", "Test"); environmentVariables.Add("Lidarr_InstanceName", _configFileProvider.InstanceName); environmentVariables.Add("Lidarr_ApplicationUrl", _configService.ApplicationUrl); var processOutput = ExecuteScript(environmentVariables); if (processOutput.ExitCode != 0) { failures.Add(new NzbDroneValidationFailure(string.Empty, $"Script exited with code: {processOutput.ExitCode}")); } } catch (Exception ex) { _logger.Error(ex); failures.Add(new NzbDroneValidationFailure(string.Empty, ex.Message)); } } return new ValidationResult(failures); } private ProcessOutput ExecuteScript(StringDictionary environmentVariables) { _logger.Debug("Executing external script: {0}", Settings.Path); var processOutput = _processProvider.StartAndCapture(Settings.Path, Settings.Arguments, environmentVariables); _logger.Debug("Executed external script: {0} - Status: {1}", Settings.Path, processOutput.ExitCode); _logger.Debug($"Script Output: {System.Environment.NewLine}{string.Join(System.Environment.NewLine, processOutput.Lines)}"); return processOutput; } } }