| | | 1 | | #nullable disable |
| | | 2 | | |
| | | 3 | | #pragma warning disable CS1591 |
| | | 4 | | |
| | | 5 | | using System; |
| | | 6 | | using System.Collections.Generic; |
| | | 7 | | using System.Globalization; |
| | | 8 | | using System.IO; |
| | | 9 | | using System.IO.Compression; |
| | | 10 | | using System.Linq; |
| | | 11 | | using System.Net.Http; |
| | | 12 | | using System.Threading; |
| | | 13 | | using System.Threading.Tasks; |
| | | 14 | | using Jellyfin.Extensions; |
| | | 15 | | using Jellyfin.XmlTv; |
| | | 16 | | using Jellyfin.XmlTv.Entities; |
| | | 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 | | { |
| | 0 | 30 | | private static readonly TimeSpan _maxCacheAge = TimeSpan.FromHours(1); |
| | | 31 | | |
| | | 32 | | private readonly IServerConfigurationManager _config; |
| | | 33 | | private readonly IHttpClientFactory _httpClientFactory; |
| | | 34 | | private readonly ILogger<XmlTvListingsProvider> _logger; |
| | | 35 | | |
| | | 36 | | public XmlTvListingsProvider( |
| | | 37 | | IServerConfigurationManager config, |
| | | 38 | | IHttpClientFactory httpClientFactory, |
| | | 39 | | ILogger<XmlTvListingsProvider> logger) |
| | | 40 | | { |
| | 25 | 41 | | _config = config; |
| | 25 | 42 | | _httpClientFactory = httpClientFactory; |
| | 25 | 43 | | _logger = logger; |
| | 25 | 44 | | } |
| | | 45 | | |
| | 0 | 46 | | public string Name => "XmlTV"; |
| | | 47 | | |
| | 0 | 48 | | public string Type => "xmltv"; |
| | | 49 | | |
| | | 50 | | private string GetLanguage(ListingsProviderInfo info) |
| | | 51 | | { |
| | 4 | 52 | | if (!string.IsNullOrWhiteSpace(info.PreferredLanguage)) |
| | | 53 | | { |
| | 0 | 54 | | return info.PreferredLanguage; |
| | | 55 | | } |
| | | 56 | | |
| | 4 | 57 | | return _config.Configuration.PreferredMetadataLanguage; |
| | | 58 | | } |
| | | 59 | | |
| | | 60 | | private async Task<string> GetXml(ListingsProviderInfo info, CancellationToken cancellationToken) |
| | | 61 | | { |
| | | 62 | | _logger.LogInformation("xmltv path: {Path}", info.Path); |
| | | 63 | | |
| | | 64 | | string cacheFilename = info.Id + ".xml"; |
| | | 65 | | string cacheFile = Path.Combine(_config.ApplicationPaths.CachePath, "xmltv", cacheFilename); |
| | | 66 | | |
| | | 67 | | if (File.Exists(cacheFile) && File.GetLastWriteTimeUtc(cacheFile) >= DateTime.UtcNow.Subtract(_maxCacheAge)) |
| | | 68 | | { |
| | | 69 | | return cacheFile; |
| | | 70 | | } |
| | | 71 | | |
| | | 72 | | // Must check if file exists as parent directory may not exist. |
| | | 73 | | if (File.Exists(cacheFile)) |
| | | 74 | | { |
| | | 75 | | File.Delete(cacheFile); |
| | | 76 | | } |
| | | 77 | | else |
| | | 78 | | { |
| | | 79 | | Directory.CreateDirectory(Path.GetDirectoryName(cacheFile)); |
| | | 80 | | } |
| | | 81 | | |
| | | 82 | | if (info.Path.StartsWith("http", StringComparison.OrdinalIgnoreCase)) |
| | | 83 | | { |
| | | 84 | | _logger.LogInformation("Downloading xmltv listings from {Path}", info.Path); |
| | | 85 | | |
| | | 86 | | using var response = await _httpClientFactory.CreateClient(NamedClient.Default).GetAsync(info.Path, canc |
| | | 87 | | var redirectedUrl = response.RequestMessage?.RequestUri?.ToString() ?? info.Path; |
| | | 88 | | var stream = await response.Content.ReadAsStreamAsync(cancellationToken).ConfigureAwait(false); |
| | | 89 | | await using (stream.ConfigureAwait(false)) |
| | | 90 | | { |
| | | 91 | | return await UnzipIfNeededAndCopy(redirectedUrl, stream, cacheFile, cancellationToken).ConfigureAwai |
| | | 92 | | } |
| | | 93 | | } |
| | | 94 | | else |
| | | 95 | | { |
| | | 96 | | var stream = AsyncFile.OpenRead(info.Path); |
| | | 97 | | await using (stream.ConfigureAwait(false)) |
| | | 98 | | { |
| | | 99 | | return await UnzipIfNeededAndCopy(info.Path, stream, cacheFile, cancellationToken).ConfigureAwait(fa |
| | | 100 | | } |
| | | 101 | | } |
| | | 102 | | } |
| | | 103 | | |
| | | 104 | | private async Task<string> UnzipIfNeededAndCopy(string originalUrl, Stream stream, string file, CancellationToke |
| | | 105 | | { |
| | | 106 | | var fileStream = new FileStream( |
| | | 107 | | file, |
| | | 108 | | FileMode.CreateNew, |
| | | 109 | | FileAccess.Write, |
| | | 110 | | FileShare.None, |
| | | 111 | | IODefaults.FileStreamBufferSize, |
| | | 112 | | FileOptions.Asynchronous); |
| | | 113 | | |
| | | 114 | | await using (fileStream.ConfigureAwait(false)) |
| | | 115 | | { |
| | | 116 | | if (Path.GetExtension(originalUrl.AsSpan().LeftPart('?')).Equals(".gz", StringComparison.OrdinalIgnoreCa |
| | | 117 | | Path.GetExtension(originalUrl.AsSpan().LeftPart('?')).Equals(".gzip", StringComparison.OrdinalIgnore |
| | | 118 | | { |
| | | 119 | | try |
| | | 120 | | { |
| | | 121 | | using var reader = new GZipStream(stream, CompressionMode.Decompress); |
| | | 122 | | await reader.CopyToAsync(fileStream, cancellationToken).ConfigureAwait(false); |
| | | 123 | | } |
| | | 124 | | catch (Exception ex) |
| | | 125 | | { |
| | | 126 | | _logger.LogError(ex, "Error extracting from gz file {File}", originalUrl); |
| | | 127 | | } |
| | | 128 | | } |
| | | 129 | | else |
| | | 130 | | { |
| | | 131 | | await stream.CopyToAsync(fileStream, cancellationToken).ConfigureAwait(false); |
| | | 132 | | } |
| | | 133 | | |
| | | 134 | | return file; |
| | | 135 | | } |
| | | 136 | | } |
| | | 137 | | |
| | | 138 | | public async Task<IEnumerable<ProgramInfo>> GetProgramsAsync(ListingsProviderInfo info, string channelId, DateTi |
| | | 139 | | { |
| | | 140 | | if (string.IsNullOrWhiteSpace(channelId)) |
| | | 141 | | { |
| | | 142 | | throw new ArgumentNullException(nameof(channelId)); |
| | | 143 | | } |
| | | 144 | | |
| | | 145 | | _logger.LogDebug("Getting xmltv programs for channel {Id}", channelId); |
| | | 146 | | |
| | | 147 | | string path = await GetXml(info, cancellationToken).ConfigureAwait(false); |
| | | 148 | | _logger.LogDebug("Opening XmlTvReader for {Path}", path); |
| | | 149 | | var reader = new XmlTvReader(path, GetLanguage(info)); |
| | | 150 | | |
| | | 151 | | return reader.GetProgrammes(channelId, startDateUtc, endDateUtc, cancellationToken) |
| | | 152 | | .Select(p => GetProgramInfo(p, info)); |
| | | 153 | | } |
| | | 154 | | |
| | | 155 | | private static ProgramInfo GetProgramInfo(XmlTvProgram program, ListingsProviderInfo info) |
| | | 156 | | { |
| | 4 | 157 | | string episodeTitle = program.Episode.Title; |
| | 4 | 158 | | var programCategories = program.Categories.Where(c => !string.IsNullOrWhiteSpace(c)).ToList(); |
| | | 159 | | |
| | 4 | 160 | | var programInfo = new ProgramInfo |
| | 4 | 161 | | { |
| | 4 | 162 | | ChannelId = program.ChannelId, |
| | 4 | 163 | | EndDate = program.EndDate.UtcDateTime, |
| | 4 | 164 | | EpisodeNumber = program.Episode.Episode, |
| | 4 | 165 | | EpisodeTitle = episodeTitle, |
| | 4 | 166 | | Genres = programCategories, |
| | 4 | 167 | | StartDate = program.StartDate.UtcDateTime, |
| | 4 | 168 | | Name = program.Title, |
| | 4 | 169 | | Overview = program.Description, |
| | 4 | 170 | | ProductionYear = program.CopyrightDate?.Year, |
| | 4 | 171 | | SeasonNumber = program.Episode.Series, |
| | 4 | 172 | | IsSeries = program.Episode.Episode is not null, |
| | 4 | 173 | | IsRepeat = program.IsPreviouslyShown && !program.IsNew, |
| | 4 | 174 | | IsPremiere = program.Premiere is not null, |
| | 4 | 175 | | IsKids = programCategories.Any(c => info.KidsCategories.Contains(c, StringComparison.OrdinalIgnoreCase)) |
| | 4 | 176 | | IsMovie = programCategories.Any(c => info.MovieCategories.Contains(c, StringComparison.OrdinalIgnoreCase |
| | 4 | 177 | | IsNews = programCategories.Any(c => info.NewsCategories.Contains(c, StringComparison.OrdinalIgnoreCase)) |
| | 4 | 178 | | IsSports = programCategories.Any(c => info.SportsCategories.Contains(c, StringComparison.OrdinalIgnoreCa |
| | 4 | 179 | | ImageUrl = string.IsNullOrEmpty(program.Icon?.Source) ? null : program.Icon.Source, |
| | 4 | 180 | | HasImage = !string.IsNullOrEmpty(program.Icon?.Source), |
| | 4 | 181 | | OfficialRating = string.IsNullOrEmpty(program.Rating?.Value) ? null : program.Rating.Value, |
| | 4 | 182 | | CommunityRating = program.StarRating, |
| | 4 | 183 | | SeriesId = program.Episode.Episode is null ? null : program.Title?.GetMD5().ToString("N", CultureInfo.In |
| | 4 | 184 | | }; |
| | | 185 | | |
| | 4 | 186 | | if (string.IsNullOrWhiteSpace(program.ProgramId)) |
| | | 187 | | { |
| | 4 | 188 | | string uniqueString = (program.Title ?? string.Empty) + (episodeTitle ?? string.Empty); |
| | | 189 | | |
| | 4 | 190 | | if (programInfo.SeasonNumber.HasValue) |
| | | 191 | | { |
| | 0 | 192 | | uniqueString = "-" + programInfo.SeasonNumber.Value.ToString(CultureInfo.InvariantCulture); |
| | | 193 | | } |
| | | 194 | | |
| | 4 | 195 | | if (programInfo.EpisodeNumber.HasValue) |
| | | 196 | | { |
| | 0 | 197 | | uniqueString = "-" + programInfo.EpisodeNumber.Value.ToString(CultureInfo.InvariantCulture); |
| | | 198 | | } |
| | | 199 | | |
| | 4 | 200 | | programInfo.ShowId = uniqueString.GetMD5().ToString("N", CultureInfo.InvariantCulture); |
| | | 201 | | |
| | | 202 | | // If we don't have valid episode info, assume it's a unique program, otherwise recordings might be skip |
| | 4 | 203 | | if (programInfo.IsSeries |
| | 4 | 204 | | && !programInfo.IsRepeat |
| | 4 | 205 | | && (programInfo.EpisodeNumber ?? 0) == 0) |
| | | 206 | | { |
| | 0 | 207 | | programInfo.ShowId += programInfo.StartDate.Ticks.ToString(CultureInfo.InvariantCulture); |
| | | 208 | | } |
| | | 209 | | } |
| | | 210 | | else |
| | | 211 | | { |
| | 0 | 212 | | programInfo.ShowId = program.ProgramId; |
| | | 213 | | } |
| | | 214 | | |
| | | 215 | | // Construct an id from the channel and start date |
| | 4 | 216 | | programInfo.Id = string.Format(CultureInfo.InvariantCulture, "{0}_{1:O}", program.ChannelId, program.StartDa |
| | | 217 | | |
| | 4 | 218 | | if (programInfo.IsMovie) |
| | | 219 | | { |
| | 0 | 220 | | programInfo.IsSeries = false; |
| | 0 | 221 | | programInfo.EpisodeNumber = null; |
| | 0 | 222 | | programInfo.EpisodeTitle = null; |
| | | 223 | | } |
| | | 224 | | |
| | 4 | 225 | | return programInfo; |
| | | 226 | | } |
| | | 227 | | |
| | | 228 | | public Task Validate(ListingsProviderInfo info, bool validateLogin, bool validateListings) |
| | | 229 | | { |
| | | 230 | | // Assume all urls are valid. check files for existence |
| | 0 | 231 | | if (!info.Path.StartsWith("http", StringComparison.OrdinalIgnoreCase) && !File.Exists(info.Path)) |
| | | 232 | | { |
| | 0 | 233 | | throw new FileNotFoundException("Could not find the XmlTv file specified:", info.Path); |
| | | 234 | | } |
| | | 235 | | |
| | 0 | 236 | | return Task.CompletedTask; |
| | | 237 | | } |
| | | 238 | | |
| | | 239 | | public async Task<List<NameIdPair>> GetLineups(ListingsProviderInfo info, string country, string location) |
| | | 240 | | { |
| | | 241 | | // In theory this should never be called because there is always only one lineup |
| | | 242 | | string path = await GetXml(info, CancellationToken.None).ConfigureAwait(false); |
| | | 243 | | _logger.LogDebug("Opening XmlTvReader for {Path}", path); |
| | | 244 | | var reader = new XmlTvReader(path, GetLanguage(info)); |
| | | 245 | | IEnumerable<XmlTvChannel> results = reader.GetChannels(); |
| | | 246 | | |
| | | 247 | | // Should this method be async? |
| | | 248 | | return results.Select(c => new NameIdPair() { Id = c.Id, Name = c.DisplayName }).ToList(); |
| | | 249 | | } |
| | | 250 | | |
| | | 251 | | public async Task<List<ChannelInfo>> GetChannels(ListingsProviderInfo info, CancellationToken cancellationToken) |
| | | 252 | | { |
| | | 253 | | // In theory this should never be called because there is always only one lineup |
| | | 254 | | string path = await GetXml(info, cancellationToken).ConfigureAwait(false); |
| | | 255 | | _logger.LogDebug("Opening XmlTvReader for {Path}", path); |
| | | 256 | | var reader = new XmlTvReader(path, GetLanguage(info)); |
| | | 257 | | var results = reader.GetChannels(); |
| | | 258 | | |
| | | 259 | | // Should this method be async? |
| | | 260 | | return results.Select(c => new ChannelInfo |
| | | 261 | | { |
| | | 262 | | Id = c.Id, |
| | | 263 | | Name = c.DisplayName, |
| | | 264 | | ImageUrl = string.IsNullOrEmpty(c.Icon?.Source) ? null : c.Icon.Source, |
| | | 265 | | Number = string.IsNullOrWhiteSpace(c.Number) ? c.Id : c.Number |
| | | 266 | | }).ToList(); |
| | | 267 | | } |
| | | 268 | | } |
| | | 269 | | } |