FilesExpand file tree

1bf87bf8735f7e7eb1b2d207d3015a7301b558bf

/

CustomScript.cs

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

271 lines (231 loc) · 16.1 KB

1bf87bf

/

CustomScript.cs

Copy path

Top

File metadata and controls

• Code
• Blame

271 lines (231 loc) · 16.1 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

using System;

using System.Collections.Generic;

using System.Collections.Specialized;

using System.IO;

using System.Linq;

using FluentValidation.Results;

using NLog;

using NzbDrone.Common.Disk;

using NzbDrone.Common.Extensions;

using NzbDrone.Common.Processes;

using NzbDrone.Core.HealthCheck;

using NzbDrone.Core.MediaFiles;

using NzbDrone.Core.ThingiProvider;

using NzbDrone.Core.Tv;

using NzbDrone.Core.Validation;

namespace NzbDrone.Core.Notifications.CustomScript

{

public class CustomScript : NotificationBase<CustomScriptSettings>

{

private readonly IDiskProvider _diskProvider;

private readonly IProcessProvider _processProvider;

private readonly Logger _logger;

public CustomScript(IDiskProvider diskProvider, IProcessProvider processProvider, Logger logger)

{

_diskProvider = diskProvider;

_processProvider = processProvider;

_logger = logger;

}

public override string Name => "Custom Script";

public override string Link => "https://wiki.servarr.com/sonarr/settings#connections";

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 series = message.Series;

var remoteEpisode = message.Episode;

var releaseGroup = remoteEpisode.ParsedEpisodeInfo.ReleaseGroup;

var environmentVariables = new StringDictionary();

environmentVariables.Add("Sonarr_EventType", "Grab");

environmentVariables.Add("Sonarr_Series_Id", series.Id.ToString());

environmentVariables.Add("Sonarr_Series_Title", series.Title);

environmentVariables.Add("Sonarr_Series_TvdbId", series.TvdbId.ToString());

environmentVariables.Add("Sonarr_Series_TvMazeId", series.TvMazeId.ToString());

environmentVariables.Add("Sonarr_Series_ImdbId", series.ImdbId ?? string.Empty);

environmentVariables.Add("Sonarr_Series_Type", series.SeriesType.ToString());

environmentVariables.Add("Sonarr_Release_EpisodeCount", remoteEpisode.Episodes.Count.ToString());

environmentVariables.Add("Sonarr_Release_SeasonNumber", remoteEpisode.Episodes.First().SeasonNumber.ToString());

environmentVariables.Add("Sonarr_Release_EpisodeNumbers", string.Join(",", remoteEpisode.Episodes.Select(e => e.EpisodeNumber)));

environmentVariables.Add("Sonarr_Release_AbsoluteEpisodeNumbers", string.Join(",", remoteEpisode.Episodes.Select(e => e.AbsoluteEpisodeNumber)));

environmentVariables.Add("Sonarr_Release_EpisodeAirDates", string.Join(",", remoteEpisode.Episodes.Select(e => e.AirDate)));

environmentVariables.Add("Sonarr_Release_EpisodeAirDatesUtc", string.Join(",", remoteEpisode.Episodes.Select(e => e.AirDateUtc)));

environmentVariables.Add("Sonarr_Release_EpisodeTitles", string.Join("|", remoteEpisode.Episodes.Select(e => e.Title)));

environmentVariables.Add("Sonarr_Release_Title", remoteEpisode.Release.Title);

environmentVariables.Add("Sonarr_Release_Indexer", remoteEpisode.Release.Indexer ?? string.Empty);

environmentVariables.Add("Sonarr_Release_Size", remoteEpisode.Release.Size.ToString());

environmentVariables.Add("Sonarr_Release_Quality", remoteEpisode.ParsedEpisodeInfo.Quality.Quality.Name);

environmentVariables.Add("Sonarr_Release_QualityVersion", remoteEpisode.ParsedEpisodeInfo.Quality.Revision.Version.ToString());

environmentVariables.Add("Sonarr_Release_ReleaseGroup", releaseGroup ?? string.Empty);

environmentVariables.Add("Sonarr_Download_Client", message.DownloadClient ?? string.Empty);

environmentVariables.Add("Sonarr_Download_Id", message.DownloadId ?? string.Empty);

ExecuteScript(environmentVariables);

}

public override void OnDownload(DownloadMessage message)

{

var series = message.Series;

var episodeFile = message.EpisodeFile;

var sourcePath = message.SourcePath;

var environmentVariables = new StringDictionary();

environmentVariables.Add("Sonarr_EventType", "Download");

environmentVariables.Add("Sonarr_IsUpgrade", message.OldFiles.Any().ToString());

environmentVariables.Add("Sonarr_Series_Id", series.Id.ToString());

environmentVariables.Add("Sonarr_Series_Title", series.Title);

environmentVariables.Add("Sonarr_Series_Path", series.Path);

environmentVariables.Add("Sonarr_Series_TvdbId", series.TvdbId.ToString());

environmentVariables.Add("Sonarr_Series_TvMazeId", series.TvMazeId.ToString());

environmentVariables.Add("Sonarr_Series_ImdbId", series.ImdbId ?? string.Empty);

environmentVariables.Add("Sonarr_Series_Type", series.SeriesType.ToString());

environmentVariables.Add("Sonarr_EpisodeFile_Id", episodeFile.Id.ToString());

environmentVariables.Add("Sonarr_EpisodeFile_EpisodeCount", episodeFile.Episodes.Value.Count.ToString());

environmentVariables.Add("Sonarr_EpisodeFile_RelativePath", episodeFile.RelativePath);

environmentVariables.Add("Sonarr_EpisodeFile_Path", Path.Combine(series.Path, episodeFile.RelativePath));

environmentVariables.Add("Sonarr_EpisodeFile_EpisodeIds", string.Join(",", episodeFile.Episodes.Value.Select(e => e.Id)));

environmentVariables.Add("Sonarr_EpisodeFile_SeasonNumber", episodeFile.SeasonNumber.ToString());

environmentVariables.Add("Sonarr_EpisodeFile_EpisodeNumbers", string.Join(",", episodeFile.Episodes.Value.Select(e => e.EpisodeNumber)));

environmentVariables.Add("Sonarr_EpisodeFile_EpisodeAirDates", string.Join(",", episodeFile.Episodes.Value.Select(e => e.AirDate)));

environmentVariables.Add("Sonarr_EpisodeFile_EpisodeAirDatesUtc", string.Join(",", episodeFile.Episodes.Value.Select(e => e.AirDateUtc)));

environmentVariables.Add("Sonarr_EpisodeFile_EpisodeTitles", string.Join("|", episodeFile.Episodes.Value.Select(e => e.Title)));

environmentVariables.Add("Sonarr_EpisodeFile_Quality", episodeFile.Quality.Quality.Name);

environmentVariables.Add("Sonarr_EpisodeFile_QualityVersion", episodeFile.Quality.Revision.Version.ToString());

environmentVariables.Add("Sonarr_EpisodeFile_ReleaseGroup", episodeFile.ReleaseGroup ?? string.Empty);

environmentVariables.Add("Sonarr_EpisodeFile_SceneName", episodeFile.SceneName ?? string.Empty);

environmentVariables.Add("Sonarr_EpisodeFile_SourcePath", sourcePath);

environmentVariables.Add("Sonarr_EpisodeFile_SourceFolder", Path.GetDirectoryName(sourcePath));

environmentVariables.Add("Sonarr_Download_Client", message.DownloadClient ?? string.Empty);

environmentVariables.Add("Sonarr_Download_Id", message.DownloadId ?? string.Empty);

if (message.OldFiles.Any())

{

environmentVariables.Add("Sonarr_DeletedRelativePaths", string.Join("|", message.OldFiles.Select(e => e.RelativePath)));

environmentVariables.Add("Sonarr_DeletedPaths", string.Join("|", message.OldFiles.Select(e => Path.Combine(series.Path, e.RelativePath))));

}

ExecuteScript(environmentVariables);

}

public override void OnRename(Series series, List<RenamedEpisodeFile> renamedFiles)

{

var environmentVariables = new StringDictionary();

environmentVariables.Add("Sonarr_EventType", "Rename");

environmentVariables.Add("Sonarr_Series_Id", series.Id.ToString());

environmentVariables.Add("Sonarr_Series_Title", series.Title);

environmentVariables.Add("Sonarr_Series_Path", series.Path);

environmentVariables.Add("Sonarr_Series_TvdbId", series.TvdbId.ToString());

environmentVariables.Add("Sonarr_Series_TvMazeId", series.TvMazeId.ToString());

environmentVariables.Add("Sonarr_Series_ImdbId", series.ImdbId ?? string.Empty);

environmentVariables.Add("Sonarr_Series_Type", series.SeriesType.ToString());

environmentVariables.Add("Sonarr_EpisodeFile_Ids", string.Join(",", renamedFiles.Select(e => e.EpisodeFile.Id)));

environmentVariables.Add("Sonarr_EpisodeFile_RelativePaths", string.Join("|", renamedFiles.Select(e => e.EpisodeFile.RelativePath)));

environmentVariables.Add("Sonarr_EpisodeFile_Paths", string.Join("|", renamedFiles.Select(e => e.EpisodeFile.Path)));

environmentVariables.Add("Sonarr_EpisodeFile_PreviousRelativePaths", string.Join("|", renamedFiles.Select(e => e.PreviousRelativePath)));

environmentVariables.Add("Sonarr_EpisodeFile_PreviousPaths", string.Join("|", renamedFiles.Select(e => e.PreviousPath)));

ExecuteScript(environmentVariables);

}

public override void OnEpisodeFileDelete(EpisodeDeleteMessage deleteMessage)

{

var series = deleteMessage.Series;

var episodeFile = deleteMessage.EpisodeFile;

var environmentVariables = new StringDictionary();

environmentVariables.Add("Sonarr_EventType", "EpisodeFileDelete");

environmentVariables.Add("Sonarr_EpisodeFile_DeleteReason", deleteMessage.Reason.ToString());

environmentVariables.Add("Sonarr_Series_Id", series.Id.ToString());

environmentVariables.Add("Sonarr_Series_Title", series.Title);

environmentVariables.Add("Sonarr_Series_Path", series.Path);

environmentVariables.Add("Sonarr_Series_TvdbId", series.TvdbId.ToString());

environmentVariables.Add("Sonarr_Series_TvMazeId", series.TvMazeId.ToString());

environmentVariables.Add("Sonarr_Series_ImdbId", series.ImdbId ?? string.Empty);

environmentVariables.Add("Sonarr_Series_Type", series.SeriesType.ToString());

environmentVariables.Add("Sonarr_EpisodeFile_Id", episodeFile.Id.ToString());

environmentVariables.Add("Sonarr_EpisodeFile_EpisodeCount", episodeFile.Episodes.Value.Count.ToString());

environmentVariables.Add("Sonarr_EpisodeFile_RelativePath", episodeFile.RelativePath);

environmentVariables.Add("Sonarr_EpisodeFile_Path", Path.Combine(series.Path, episodeFile.RelativePath));

environmentVariables.Add("Sonarr_EpisodeFile_EpisodeIds", string.Join(",", episodeFile.Episodes.Value.Select(e => e.Id)));

environmentVariables.Add("Sonarr_EpisodeFile_SeasonNumber", episodeFile.SeasonNumber.ToString());

environmentVariables.Add("Sonarr_EpisodeFile_EpisodeNumbers", string.Join(",", episodeFile.Episodes.Value.Select(e => e.EpisodeNumber)));

environmentVariables.Add("Sonarr_EpisodeFile_EpisodeAirDates", string.Join(",", episodeFile.Episodes.Value.Select(e => e.AirDate)));

environmentVariables.Add("Sonarr_EpisodeFile_EpisodeAirDatesUtc", string.Join(",", episodeFile.Episodes.Value.Select(e => e.AirDateUtc)));

environmentVariables.Add("Sonarr_EpisodeFile_EpisodeTitles", string.Join("|", episodeFile.Episodes.Value.Select(e => e.Title)));

environmentVariables.Add("Sonarr_EpisodeFile_Quality", episodeFile.Quality.Quality.Name);

environmentVariables.Add("Sonarr_EpisodeFile_QualityVersion", episodeFile.Quality.Revision.Version.ToString());

environmentVariables.Add("Sonarr_EpisodeFile_ReleaseGroup", episodeFile.ReleaseGroup ?? string.Empty);

environmentVariables.Add("Sonarr_EpisodeFile_SceneName", episodeFile.SceneName ?? string.Empty);

ExecuteScript(environmentVariables);

}

public override void OnSeriesDelete(SeriesDeleteMessage deleteMessage)

{

var series = deleteMessage.Series;

var environmentVariables = new StringDictionary();

environmentVariables.Add("Sonarr_EventType", "SeriesDelete");

environmentVariables.Add("Sonarr_Series_Id", series.Id.ToString());

environmentVariables.Add("Sonarr_Series_Title", series.Title);

environmentVariables.Add("Sonarr_Series_Path", series.Path);

environmentVariables.Add("Sonarr_Series_TvdbId", series.TvdbId.ToString());

environmentVariables.Add("Sonarr_Series_TvMazeId", series.TvMazeId.ToString());

environmentVariables.Add("Sonarr_Series_ImdbId", series.ImdbId ?? string.Empty);

environmentVariables.Add("Sonarr_Series_Type", series.SeriesType.ToString());

environmentVariables.Add("Sonarr_Series_DeletedFiles", deleteMessage.DeletedFiles.ToString());

ExecuteScript(environmentVariables);

}

public override void OnHealthIssue(HealthCheck.HealthCheck healthCheck)

{

var environmentVariables = new StringDictionary();

environmentVariables.Add("Sonarr_EventType", "HealthIssue");

environmentVariables.Add("Sonarr_Health_Issue_Level", Enum.GetName(typeof(HealthCheckResult), healthCheck.Type));

environmentVariables.Add("Sonarr_Health_Issue_Message", healthCheck.Message);

environmentVariables.Add("Sonarr_Health_Issue_Type", healthCheck.Source.Name);

environmentVariables.Add("Sonarr_Health_Issue_Wiki", healthCheck.WikiUrl.ToString() ?? string.Empty);

ExecuteScript(environmentVariables);

}

public override void OnApplicationUpdate(ApplicationUpdateMessage updateMessage)

{

var environmentVariables = new StringDictionary();

environmentVariables.Add("Sonarr_EventType", "ApplicationUpdate");

environmentVariables.Add("Sonarr_Update_Message", updateMessage.Message);

environmentVariables.Add("Sonarr_Update_NewVersion", updateMessage.NewVersion.ToString());

environmentVariables.Add("Sonarr_Update_PreviousVersion", updateMessage.PreviousVersion.ToString());

ExecuteScript(environmentVariables);

}

public override ValidationResult Test()

{

var failures = new List<ValidationFailure>();

if (!_diskProvider.FileExists(Settings.Path))

{

failures.Add(new NzbDroneValidationFailure("Path", "File does not exist"));

}

foreach (var systemFolder in SystemFolders.GetSystemFolders())

{

if (systemFolder.IsParentPath(Settings.Path))

{

failures.Add(new NzbDroneValidationFailure("Path", $"Must not be a descendant of '{systemFolder}'"));

}

}

if (failures.Empty())

{

try

{

var environmentVariables = new StringDictionary();

environmentVariables.Add("Sonarr_EventType", "Test");

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: \r\n{0}", string.Join("\r\n", processOutput.Lines));

return processOutput;

}

private bool ValidatePathParent(string possibleParent, string path)

{

return possibleParent.IsParentPath(path);

}

}

}