| | | 1 | | #pragma warning disable CS1591 |
| | | 2 | | |
| | | 3 | | using System; |
| | | 4 | | using System.Collections.Concurrent; |
| | | 5 | | using System.Collections.Generic; |
| | | 6 | | using System.Globalization; |
| | | 7 | | using System.IO; |
| | | 8 | | using System.IO.Compression; |
| | | 9 | | using System.Linq; |
| | | 10 | | using System.Net.Http; |
| | | 11 | | using System.Threading; |
| | | 12 | | using System.Threading.Tasks; |
| | | 13 | | using Jellyfin.Extensions; |
| | | 14 | | using Jellyfin.XmlTv; |
| | | 15 | | using Jellyfin.XmlTv.Entities; |
| | | 16 | | using Jellyfin.XmlTv.Enums; |
| | | 17 | | using MediaBrowser.Common.Extensions; |
| | | 18 | | using MediaBrowser.Common.Net; |
| | | 19 | | using MediaBrowser.Controller.Configuration; |
| | | 20 | | using MediaBrowser.Controller.LiveTv; |
| | | 21 | | using MediaBrowser.Model.Dto; |
| | | 22 | | using MediaBrowser.Model.IO; |
| | | 23 | | using MediaBrowser.Model.LiveTv; |
| | | 24 | | using Microsoft.Extensions.Logging; |
| | | 25 | | |
| | | 26 | | namespace Jellyfin.LiveTv.Listings |
| | | 27 | | { |
| | | 28 | | public class XmlTvListingsProvider : IListingsProvider |
| | | 29 | | { |
| | 1 | 30 | | private static readonly TimeSpan _maxCacheAge = TimeSpan.FromHours(1); |
| | 1 | 31 | | private static readonly TimeSpan _downloadTimeout = TimeSpan.FromMinutes(15); |
| | | 32 | | |
| | | 33 | | private readonly IServerConfigurationManager _config; |
| | | 34 | | private readonly IHttpClientFactory _httpClientFactory; |
| | | 35 | | private readonly ILogger<XmlTvListingsProvider> _logger; |
| | | 36 | | |
| | 46 | 37 | | private readonly ConcurrentDictionary<string, DateTime> _lastDownloadFailures = new(StringComparer.Ordinal); |
| | | 38 | | |
| | | 39 | | public XmlTvListingsProvider( |
| | | 40 | | IServerConfigurationManager config, |
| | | 41 | | IHttpClientFactory httpClientFactory, |
| | | 42 | | ILogger<XmlTvListingsProvider> logger) |
| | | 43 | | { |
| | 46 | 44 | | _config = config; |
| | 46 | 45 | | _httpClientFactory = httpClientFactory; |
| | 46 | 46 | | _logger = logger; |
| | 46 | 47 | | } |
| | | 48 | | |
| | 0 | 49 | | public string Name => "XmlTV"; |
| | | 50 | | |
| | 0 | 51 | | public string Type => "xmltv"; |
| | | 52 | | |
| | | 53 | | private string GetLanguage(ListingsProviderInfo info) |
| | | 54 | | { |
| | 27 | 55 | | if (!string.IsNullOrWhiteSpace(info.PreferredLanguage)) |
| | | 56 | | { |
| | 0 | 57 | | return info.PreferredLanguage; |
| | | 58 | | } |
| | | 59 | | |
| | 27 | 60 | | return _config.Configuration.PreferredMetadataLanguage; |
| | | 61 | | } |
| | | 62 | | |
| | | 63 | | private async Task<string> GetXml(ListingsProviderInfo info, CancellationToken cancellationToken) |
| | | 64 | | { |
| | 29 | 65 | | _logger.LogInformation("xmltv path: {Path}", info.Path); |
| | | 66 | | |
| | 29 | 67 | | string cacheFilename = info.Id + ".xml"; |
| | 29 | 68 | | string cacheDir = Path.Join(_config.ApplicationPaths.CachePath, "xmltv"); |
| | 29 | 69 | | string cacheFile = Path.Join(cacheDir, cacheFilename); |
| | | 70 | | |
| | 29 | 71 | | if (File.Exists(cacheFile) && File.GetLastWriteTimeUtc(cacheFile) >= DateTime.UtcNow.Subtract(_maxCacheAge)) |
| | | 72 | | { |
| | 1 | 73 | | return cacheFile; |
| | | 74 | | } |
| | | 75 | | |
| | 28 | 76 | | var isRemote = info.Path.StartsWith("http", StringComparison.OrdinalIgnoreCase); |
| | | 77 | | |
| | 28 | 78 | | if (isRemote |
| | 28 | 79 | | && _lastDownloadFailures.TryGetValue(info.Path, out var lastFailure) |
| | 28 | 80 | | && DateTime.UtcNow - lastFailure < _maxCacheAge) |
| | | 81 | | { |
| | 0 | 82 | | if (File.Exists(cacheFile)) |
| | | 83 | | { |
| | 0 | 84 | | return cacheFile; |
| | | 85 | | } |
| | | 86 | | |
| | 0 | 87 | | throw new InvalidOperationException("Skipping the XMLTV download after a recent failure: " + info.Path); |
| | | 88 | | } |
| | | 89 | | |
| | 28 | 90 | | Directory.CreateDirectory(cacheDir); |
| | | 91 | | |
| | 28 | 92 | | var tempFile = cacheFile + ".tmp"; |
| | | 93 | | |
| | | 94 | | try |
| | | 95 | | { |
| | 28 | 96 | | using var timeout = new CancellationTokenSource(_downloadTimeout); |
| | 28 | 97 | | using var linkedTokenSource = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken, timeout |
| | 28 | 98 | | var downloadCancellationToken = linkedTokenSource.Token; |
| | | 99 | | |
| | 28 | 100 | | if (isRemote) |
| | | 101 | | { |
| | 9 | 102 | | _logger.LogInformation("Downloading xmltv listings from {Path}", info.Path); |
| | | 103 | | |
| | 9 | 104 | | var httpClient = _httpClientFactory.CreateClient(NamedClient.Default); |
| | 9 | 105 | | httpClient.Timeout = _downloadTimeout; |
| | | 106 | | |
| | 9 | 107 | | using var response = await httpClient |
| | 9 | 108 | | .GetAsync(info.Path, HttpCompletionOption.ResponseHeadersRead, downloadCancellationToken) |
| | 9 | 109 | | .ConfigureAwait(false); |
| | 8 | 110 | | response.EnsureSuccessStatusCode(); |
| | 6 | 111 | | var redirectedUrl = response.RequestMessage?.RequestUri?.ToString() ?? info.Path; |
| | 6 | 112 | | var stream = await response.Content.ReadAsStreamAsync(downloadCancellationToken).ConfigureAwait(fals |
| | 6 | 113 | | await using (stream.ConfigureAwait(false)) |
| | | 114 | | { |
| | 6 | 115 | | await UnzipIfNeededAndCopy(redirectedUrl, stream, tempFile, downloadCancellationToken).Configure |
| | | 116 | | } |
| | 6 | 117 | | } |
| | | 118 | | else |
| | | 119 | | { |
| | 19 | 120 | | var stream = AsyncFile.OpenRead(info.Path); |
| | 19 | 121 | | await using (stream.ConfigureAwait(false)) |
| | | 122 | | { |
| | 19 | 123 | | await UnzipIfNeededAndCopy(info.Path, stream, tempFile, downloadCancellationToken).ConfigureAwai |
| | | 124 | | } |
| | | 125 | | } |
| | | 126 | | |
| | 25 | 127 | | File.Move(tempFile, cacheFile, true); |
| | 25 | 128 | | _lastDownloadFailures.TryRemove(info.Path, out _); |
| | | 129 | | |
| | 25 | 130 | | return cacheFile; |
| | | 131 | | } |
| | 1 | 132 | | catch (OperationCanceledException) when (cancellationToken.IsCancellationRequested) |
| | | 133 | | { |
| | 0 | 134 | | TryDeleteTempFile(tempFile); |
| | | 135 | | |
| | 0 | 136 | | throw; |
| | | 137 | | } |
| | 3 | 138 | | catch (Exception ex) |
| | | 139 | | { |
| | 3 | 140 | | TryDeleteTempFile(tempFile); |
| | 3 | 141 | | _lastDownloadFailures[info.Path] = DateTime.UtcNow; |
| | | 142 | | |
| | 3 | 143 | | _logger.LogError(ex, "Error downloading or processing XMLTV file from {Path}", info.Path); |
| | | 144 | | |
| | 3 | 145 | | if (File.Exists(cacheFile)) |
| | | 146 | | { |
| | 1 | 147 | | _logger.LogWarning("Falling back to the previously downloaded XMLTV file for {Path}", info.Path); |
| | | 148 | | |
| | 1 | 149 | | return cacheFile; |
| | | 150 | | } |
| | | 151 | | |
| | 2 | 152 | | if (ex is OperationCanceledException) |
| | | 153 | | { |
| | 1 | 154 | | throw new TimeoutException( |
| | 1 | 155 | | string.Format(CultureInfo.InvariantCulture, "Timed out downloading the XMLTV file from {0}", inf |
| | 1 | 156 | | ex); |
| | | 157 | | } |
| | | 158 | | |
| | 1 | 159 | | throw; |
| | | 160 | | } |
| | 27 | 161 | | } |
| | | 162 | | |
| | | 163 | | private void TryDeleteTempFile(string tempFile) |
| | | 164 | | { |
| | | 165 | | try |
| | | 166 | | { |
| | 3 | 167 | | File.Delete(tempFile); |
| | 3 | 168 | | } |
| | 0 | 169 | | catch (Exception ex) when (ex is IOException or UnauthorizedAccessException) |
| | | 170 | | { |
| | 0 | 171 | | _logger.LogWarning(ex, "Error deleting temporary XMLTV file {File}", tempFile); |
| | 0 | 172 | | } |
| | 3 | 173 | | } |
| | | 174 | | |
| | | 175 | | private async Task UnzipIfNeededAndCopy(string originalUrl, Stream stream, string file, CancellationToken cancel |
| | | 176 | | { |
| | 25 | 177 | | var fileStream = new FileStream( |
| | 25 | 178 | | file, |
| | 25 | 179 | | FileMode.Create, |
| | 25 | 180 | | FileAccess.Write, |
| | 25 | 181 | | FileShare.None, |
| | 25 | 182 | | IODefaults.FileStreamBufferSize, |
| | 25 | 183 | | FileOptions.Asynchronous); |
| | | 184 | | |
| | 25 | 185 | | await using (fileStream.ConfigureAwait(false)) |
| | | 186 | | { |
| | 25 | 187 | | if (Path.GetExtension(originalUrl.AsSpan().LeftPart('?')).Equals(".gz", StringComparison.OrdinalIgnoreCa |
| | 25 | 188 | | Path.GetExtension(originalUrl.AsSpan().LeftPart('?')).Equals(".gzip", StringComparison.OrdinalIgnore |
| | | 189 | | { |
| | | 190 | | try |
| | | 191 | | { |
| | 0 | 192 | | using var reader = new GZipStream(stream, CompressionMode.Decompress); |
| | 0 | 193 | | await reader.CopyToAsync(fileStream, cancellationToken).ConfigureAwait(false); |
| | 0 | 194 | | } |
| | 0 | 195 | | catch (Exception ex) |
| | | 196 | | { |
| | 0 | 197 | | _logger.LogError(ex, "Error extracting from gz file {File}", originalUrl); |
| | 0 | 198 | | } |
| | | 199 | | } |
| | | 200 | | else |
| | | 201 | | { |
| | 25 | 202 | | await stream.CopyToAsync(fileStream, cancellationToken).ConfigureAwait(false); |
| | | 203 | | } |
| | | 204 | | } |
| | | 205 | | |
| | 25 | 206 | | var fileInfo = new FileInfo(file); |
| | 25 | 207 | | if (!fileInfo.Exists || fileInfo.Length == 0) |
| | | 208 | | { |
| | 0 | 209 | | throw new InvalidOperationException("Downloaded XMLTV file is empty: " + originalUrl); |
| | | 210 | | } |
| | 25 | 211 | | } |
| | | 212 | | |
| | | 213 | | public async Task<IEnumerable<ProgramInfo>> GetProgramsAsync(ListingsProviderInfo info, string channelId, DateTi |
| | | 214 | | { |
| | 27 | 215 | | if (string.IsNullOrWhiteSpace(channelId)) |
| | | 216 | | { |
| | 0 | 217 | | throw new ArgumentNullException(nameof(channelId)); |
| | | 218 | | } |
| | | 219 | | |
| | 27 | 220 | | _logger.LogDebug("Getting xmltv programs for channel {Id}", channelId); |
| | | 221 | | |
| | 27 | 222 | | string path = await GetXml(info, cancellationToken).ConfigureAwait(false); |
| | 25 | 223 | | _logger.LogDebug("Opening XmlTvReader for {Path}", path); |
| | 25 | 224 | | var reader = new XmlTvReader(path, GetLanguage(info)); |
| | | 225 | | |
| | 25 | 226 | | return reader.GetProgrammes(channelId, startDateUtc, endDateUtc, cancellationToken) |
| | 25 | 227 | | .Select(p => GetProgramInfoWithEtag(p, info)); |
| | 25 | 228 | | } |
| | | 229 | | |
| | | 230 | | private ProgramInfo GetProgramInfoWithEtag(XmlTvProgram program, ListingsProviderInfo info) |
| | | 231 | | { |
| | 25 | 232 | | var programInfo = GetProgramInfo(program, info); |
| | | 233 | | |
| | 25 | 234 | | if (XmlTvProgramEtag.TryCreate(programInfo, out var etag, out var reason)) |
| | | 235 | | { |
| | 25 | 236 | | programInfo.Etag = etag; |
| | | 237 | | } |
| | | 238 | | else |
| | | 239 | | { |
| | 0 | 240 | | _logger.LogDebug( |
| | 0 | 241 | | "Unable to create XMLTV program ETag for program {ProgramId} on channel {ChannelId} from {StartDate} |
| | 0 | 242 | | programInfo.Id, |
| | 0 | 243 | | programInfo.ChannelId, |
| | 0 | 244 | | programInfo.StartDate, |
| | 0 | 245 | | programInfo.EndDate, |
| | 0 | 246 | | reason); |
| | | 247 | | } |
| | | 248 | | |
| | 25 | 249 | | return programInfo; |
| | | 250 | | } |
| | | 251 | | |
| | | 252 | | private static ProgramInfo GetProgramInfo(XmlTvProgram program, ListingsProviderInfo info) |
| | | 253 | | { |
| | 25 | 254 | | string? episodeTitle = program.Episode?.Title; |
| | 25 | 255 | | var programCategories = program.Categories.Where(c => !string.IsNullOrWhiteSpace(c)).ToList(); |
| | 25 | 256 | | var imageUrl = program.Icons.FirstOrDefault()?.Source; |
| | 25 | 257 | | var episodeImageUrl = program.Images?.FirstOrDefault(m => m.Type == ImageType.Still)?.Path; |
| | 25 | 258 | | var backgroundImageUrl = program.Images?.FirstOrDefault(m => m.Type == ImageType.Backdrop)?.Path; |
| | 25 | 259 | | var rating = program.Ratings.FirstOrDefault()?.Value; |
| | 25 | 260 | | var starRating = program.StarRatings?.FirstOrDefault()?.StarRating; |
| | | 261 | | |
| | 25 | 262 | | var programInfo = new ProgramInfo |
| | 25 | 263 | | { |
| | 25 | 264 | | ChannelId = program.ChannelId, |
| | 25 | 265 | | EndDate = program.EndDate.UtcDateTime, |
| | 25 | 266 | | EpisodeNumber = program.Episode?.Episode, |
| | 25 | 267 | | EpisodeTitle = episodeTitle, |
| | 25 | 268 | | Genres = programCategories, |
| | 25 | 269 | | StartDate = program.StartDate.UtcDateTime, |
| | 25 | 270 | | Name = program.Title, |
| | 25 | 271 | | Overview = program.Description, |
| | 25 | 272 | | ProductionYear = program.CopyrightDate?.Year, |
| | 25 | 273 | | SeasonNumber = program.Episode?.Series, |
| | 25 | 274 | | IsSeries = program.Episode?.Episode is not null, |
| | 25 | 275 | | IsRepeat = program.IsPreviouslyShown && !program.IsNew, |
| | 25 | 276 | | IsPremiere = program.Premiere is not null, |
| | 25 | 277 | | IsLive = program.IsLive, |
| | 25 | 278 | | IsKids = programCategories.Any(c => info.KidsCategories.Contains(c, StringComparison.OrdinalIgnoreCase)) |
| | 25 | 279 | | IsMovie = programCategories.Any(c => info.MovieCategories.Contains(c, StringComparison.OrdinalIgnoreCase |
| | 25 | 280 | | IsNews = programCategories.Any(c => info.NewsCategories.Contains(c, StringComparison.OrdinalIgnoreCase)) |
| | 25 | 281 | | IsSports = programCategories.Any(c => info.SportsCategories.Contains(c, StringComparison.OrdinalIgnoreCa |
| | 25 | 282 | | ImageUrl = string.IsNullOrEmpty(imageUrl) ? null : imageUrl, |
| | 25 | 283 | | HasImage = !string.IsNullOrEmpty(imageUrl), |
| | 25 | 284 | | BackdropImageUrl = string.IsNullOrEmpty(backgroundImageUrl) ? null : backgroundImageUrl, |
| | 25 | 285 | | ThumbImageUrl = string.IsNullOrEmpty(episodeImageUrl) ? null : episodeImageUrl, |
| | 25 | 286 | | OfficialRating = string.IsNullOrEmpty(rating) ? null : rating, |
| | 25 | 287 | | CommunityRating = starRating is null ? null : (float)starRating.Value, |
| | 25 | 288 | | SeriesId = program.Episode?.Episode is null ? null : program.Title?.GetMD5().ToString("N", CultureInfo.I |
| | 25 | 289 | | }; |
| | | 290 | | |
| | 25 | 291 | | if (string.IsNullOrWhiteSpace(program.ProgramId)) |
| | | 292 | | { |
| | 9 | 293 | | string uniqueString = (program.Title ?? string.Empty) + (episodeTitle ?? string.Empty); |
| | | 294 | | |
| | 9 | 295 | | if (programInfo.SeasonNumber.HasValue) |
| | | 296 | | { |
| | 0 | 297 | | uniqueString = "-" + programInfo.SeasonNumber.Value.ToString(CultureInfo.InvariantCulture); |
| | | 298 | | } |
| | | 299 | | |
| | 9 | 300 | | if (programInfo.EpisodeNumber.HasValue) |
| | | 301 | | { |
| | 0 | 302 | | uniqueString = "-" + programInfo.EpisodeNumber.Value.ToString(CultureInfo.InvariantCulture); |
| | | 303 | | } |
| | | 304 | | |
| | 9 | 305 | | programInfo.ShowId = uniqueString.GetMD5().ToString("N", CultureInfo.InvariantCulture); |
| | | 306 | | |
| | | 307 | | // If we don't have valid episode info, assume it's a unique program, otherwise recordings might be skip |
| | 9 | 308 | | if (programInfo.IsSeries |
| | 9 | 309 | | && !programInfo.IsRepeat |
| | 9 | 310 | | && (programInfo.EpisodeNumber ?? 0) == 0) |
| | | 311 | | { |
| | 0 | 312 | | programInfo.ShowId += programInfo.StartDate.Ticks.ToString(CultureInfo.InvariantCulture); |
| | | 313 | | } |
| | | 314 | | } |
| | | 315 | | else |
| | | 316 | | { |
| | 16 | 317 | | programInfo.ShowId = program.ProgramId; |
| | | 318 | | } |
| | | 319 | | |
| | | 320 | | // Construct an id from the channel and start date |
| | 25 | 321 | | programInfo.Id = string.Format(CultureInfo.InvariantCulture, "{0}_{1:O}", program.ChannelId, program.StartDa |
| | | 322 | | |
| | 25 | 323 | | if (programInfo.IsMovie) |
| | | 324 | | { |
| | 0 | 325 | | programInfo.IsSeries = false; |
| | 0 | 326 | | programInfo.EpisodeNumber = null; |
| | 0 | 327 | | programInfo.EpisodeTitle = null; |
| | | 328 | | } |
| | | 329 | | |
| | 25 | 330 | | return programInfo; |
| | | 331 | | } |
| | | 332 | | |
| | | 333 | | public Task Validate(ListingsProviderInfo info, bool validateLogin, bool validateListings) |
| | | 334 | | { |
| | | 335 | | // Saving the provider is an explicit retry, so the download backoff has to be dropped |
| | | 336 | | // together with the cached file the listings manager deletes. |
| | 1 | 337 | | if (!string.IsNullOrEmpty(info.Path)) |
| | | 338 | | { |
| | 1 | 339 | | _lastDownloadFailures.TryRemove(info.Path, out _); |
| | | 340 | | } |
| | | 341 | | |
| | | 342 | | // Assume all urls are valid. check files for existence |
| | 1 | 343 | | if (!info.Path.StartsWith("http", StringComparison.OrdinalIgnoreCase) && !File.Exists(info.Path)) |
| | | 344 | | { |
| | 0 | 345 | | throw new FileNotFoundException("Could not find the XmlTv file specified:", info.Path); |
| | | 346 | | } |
| | | 347 | | |
| | 1 | 348 | | return Task.CompletedTask; |
| | | 349 | | } |
| | | 350 | | |
| | | 351 | | public async Task<List<NameIdPair>> GetLineups(ListingsProviderInfo info, string country, string location) |
| | | 352 | | { |
| | | 353 | | // In theory this should never be called because there is always only one lineup |
| | 0 | 354 | | string path = await GetXml(info, CancellationToken.None).ConfigureAwait(false); |
| | 0 | 355 | | _logger.LogDebug("Opening XmlTvReader for {Path}", path); |
| | 0 | 356 | | var reader = new XmlTvReader(path, GetLanguage(info)); |
| | 0 | 357 | | IEnumerable<XmlTvChannel> results = reader.GetChannels(); |
| | | 358 | | |
| | | 359 | | // Should this method be async? |
| | 0 | 360 | | return results.Select(c => new NameIdPair() { Id = c.Id, Name = c.DisplayName }).ToList(); |
| | 0 | 361 | | } |
| | | 362 | | |
| | | 363 | | public async Task<List<ChannelInfo>> GetChannels(ListingsProviderInfo info, CancellationToken cancellationToken) |
| | | 364 | | { |
| | | 365 | | // In theory this should never be called because there is always only one lineup |
| | 2 | 366 | | string path = await GetXml(info, cancellationToken).ConfigureAwait(false); |
| | 2 | 367 | | _logger.LogDebug("Opening XmlTvReader for {Path}", path); |
| | 2 | 368 | | var reader = new XmlTvReader(path, GetLanguage(info)); |
| | 2 | 369 | | var results = reader.GetChannels(); |
| | | 370 | | |
| | | 371 | | // Should this method be async? |
| | 2 | 372 | | return results.Select(c => new ChannelInfo |
| | 2 | 373 | | { |
| | 2 | 374 | | Id = c.Id, |
| | 2 | 375 | | Name = c.DisplayName, |
| | 2 | 376 | | ImageUrl = string.IsNullOrEmpty(c.Icons.FirstOrDefault()?.Source) ? null : c.Icons.FirstOrDefault()!.Sou |
| | 2 | 377 | | Number = string.IsNullOrWhiteSpace(c.Number) ? c.Id : c.Number |
| | 2 | 378 | | }).ToList(); |
| | 2 | 379 | | } |
| | | 380 | | } |
| | | 381 | | } |