| | | 1 | | using System; |
| | | 2 | | using System.Globalization; |
| | | 3 | | using System.IO; |
| | | 4 | | using System.IO.Compression; |
| | | 5 | | using System.Linq; |
| | | 6 | | using System.Text.Json; |
| | | 7 | | using System.Threading; |
| | | 8 | | using System.Threading.Tasks; |
| | | 9 | | using Jellyfin.Data.Enums; |
| | | 10 | | using Jellyfin.Extensions.Json; |
| | | 11 | | using MediaBrowser.Controller.Entities; |
| | | 12 | | using MediaBrowser.Controller.Providers; |
| | | 13 | | using MediaBrowser.Model.IO; |
| | | 14 | | using MediaBrowser.Providers.Books.ComicBookInfo.Models; |
| | | 15 | | using Microsoft.Extensions.Logging; |
| | | 16 | | |
| | | 17 | | namespace MediaBrowser.Providers.Books.ComicBookInfo; |
| | | 18 | | |
| | | 19 | | /// <summary> |
| | | 20 | | /// ComicBookInfo provider. |
| | | 21 | | /// </summary> |
| | | 22 | | public class ComicBookInfoProvider : IComicProvider |
| | | 23 | | { |
| | | 24 | | private readonly ILogger<ComicBookInfoProvider> _logger; |
| | | 25 | | private readonly IFileSystem _fileSystem; |
| | | 26 | | |
| | | 27 | | /// <summary> |
| | | 28 | | /// Initializes a new instance of the <see cref="ComicBookInfoProvider"/> class. |
| | | 29 | | /// </summary> |
| | | 30 | | /// <param name="fileSystem">Instance of the <see cref="IFileSystem"/> interface.</param> |
| | | 31 | | /// <param name="logger">Instance of the <see cref="ILogger{ComicBookInfoProvider}"/> interface.</param> |
| | | 32 | | public ComicBookInfoProvider(IFileSystem fileSystem, ILogger<ComicBookInfoProvider> logger) |
| | | 33 | | { |
| | 32 | 34 | | _fileSystem = fileSystem; |
| | 32 | 35 | | _logger = logger; |
| | 32 | 36 | | } |
| | | 37 | | |
| | | 38 | | /// <inheritdoc /> |
| | | 39 | | public async ValueTask<MetadataResult<Book>> ReadMetadata(ItemInfo info, IDirectoryService directoryService, Cancell |
| | | 40 | | { |
| | 5 | 41 | | var path = GetComicBookFile(info.Path)?.FullName; |
| | | 42 | | |
| | 5 | 43 | | if (path is null) |
| | | 44 | | { |
| | 0 | 45 | | _logger.LogDebug("could not load comic: {Path}", info.Path); |
| | 0 | 46 | | return new MetadataResult<Book> { HasMetadata = false }; |
| | | 47 | | } |
| | | 48 | | |
| | | 49 | | try |
| | | 50 | | { |
| | 5 | 51 | | Stream stream = AsyncFile.OpenRead(path); |
| | 5 | 52 | | await using (stream.ConfigureAwait(false)) |
| | | 53 | | { |
| | 5 | 54 | | var archive = await ZipArchive.CreateAsync(stream, ZipArchiveMode.Read, false, null, cancellationToken). |
| | 5 | 55 | | await using (archive.ConfigureAwait(false)) |
| | | 56 | | { |
| | | 57 | | // ZipArchive.Comment is an empty string, not null, when the archive has no comment |
| | 5 | 58 | | if (string.IsNullOrWhiteSpace(archive.Comment)) |
| | | 59 | | { |
| | 3 | 60 | | _logger.LogDebug("missing ComicBookInfo in archive comment: {Path}", info.Path); |
| | 3 | 61 | | return new MetadataResult<Book> { HasMetadata = false }; |
| | | 62 | | } |
| | | 63 | | |
| | 2 | 64 | | var comicBookMetadata = JsonSerializer.Deserialize<ComicBookInfoFormat>(archive.Comment, JsonDefault |
| | 1 | 65 | | if (comicBookMetadata is null) |
| | | 66 | | { |
| | 0 | 67 | | _logger.LogError("ComicBookInfo deserialization failure: {Path}", info.Path); |
| | 0 | 68 | | return new MetadataResult<Book> { HasMetadata = false }; |
| | | 69 | | } |
| | | 70 | | |
| | 1 | 71 | | return SaveMetadata(comicBookMetadata); |
| | | 72 | | } |
| | | 73 | | } |
| | 0 | 74 | | } |
| | 1 | 75 | | catch (JsonException ex) |
| | | 76 | | { |
| | | 77 | | // the archive comment is not reserved for ComicBookInfo, so any other content is not an error |
| | 1 | 78 | | _logger.LogDebug("archive comment is not valid ComicBookInfo metadata: {Path}: {Message}", info.Path, ex.Mes |
| | 1 | 79 | | return new MetadataResult<Book> { HasMetadata = false }; |
| | | 80 | | } |
| | 0 | 81 | | catch (Exception ex) |
| | | 82 | | { |
| | 0 | 83 | | _logger.LogError(ex, "failed to load ComicBookInfo metadata: {Path}", info.Path); |
| | 0 | 84 | | return new MetadataResult<Book> { HasMetadata = false }; |
| | | 85 | | } |
| | 5 | 86 | | } |
| | | 87 | | |
| | | 88 | | /// <inheritdoc /> |
| | | 89 | | public bool HasItemChanged(BaseItem item) |
| | | 90 | | { |
| | 0 | 91 | | var file = GetComicBookFile(item.Path); |
| | | 92 | | |
| | 0 | 93 | | if (file is null) |
| | | 94 | | { |
| | 0 | 95 | | return false; |
| | | 96 | | } |
| | | 97 | | |
| | 0 | 98 | | return file.Exists && _fileSystem.GetLastWriteTimeUtc(file) > item.DateLastSaved; |
| | | 99 | | } |
| | | 100 | | |
| | | 101 | | private MetadataResult<Book> SaveMetadata(ComicBookInfoFormat comic) |
| | | 102 | | { |
| | 1 | 103 | | if (comic.Metadata is null) |
| | | 104 | | { |
| | 0 | 105 | | return new MetadataResult<Book> { HasMetadata = false }; |
| | | 106 | | } |
| | | 107 | | |
| | 1 | 108 | | var book = ReadComicBookMetadata(comic.Metadata); |
| | | 109 | | |
| | 1 | 110 | | if (book is null) |
| | | 111 | | { |
| | 0 | 112 | | return new MetadataResult<Book> { HasMetadata = false }; |
| | | 113 | | } |
| | | 114 | | |
| | 1 | 115 | | var metadataResult = new MetadataResult<Book> { Item = book, HasMetadata = true }; |
| | | 116 | | |
| | 1 | 117 | | if (comic.Metadata.Language is not null) |
| | | 118 | | { |
| | 0 | 119 | | metadataResult.ResultLanguage = ReadCultureInfoInto(comic.Metadata.Language); |
| | | 120 | | } |
| | | 121 | | |
| | 1 | 122 | | if (comic.Metadata.Credits.Count > 0) |
| | | 123 | | { |
| | 0 | 124 | | ReadPeopleMetadata(comic.Metadata, metadataResult); |
| | | 125 | | } |
| | | 126 | | |
| | 1 | 127 | | return metadataResult; |
| | | 128 | | } |
| | | 129 | | |
| | | 130 | | private FileSystemMetadata? GetComicBookFile(string path) |
| | | 131 | | { |
| | 5 | 132 | | var fileInfo = _fileSystem.GetFileSystemInfo(path); |
| | | 133 | | |
| | 5 | 134 | | if (fileInfo.IsDirectory) |
| | | 135 | | { |
| | 0 | 136 | | return null; |
| | | 137 | | } |
| | | 138 | | |
| | | 139 | | // only parse files that are known to have ComicBookInfo metadata |
| | 5 | 140 | | return fileInfo.Extension.Equals(".cbz", StringComparison.OrdinalIgnoreCase) ? fileInfo : null; |
| | | 141 | | } |
| | | 142 | | |
| | | 143 | | private static Book? ReadComicBookMetadata(ComicBookInfoMetadata comic) |
| | | 144 | | { |
| | 1 | 145 | | var book = new Book(); |
| | 1 | 146 | | var hasFoundMetadata = false; |
| | | 147 | | |
| | 1 | 148 | | hasFoundMetadata |= ReadStringInto(comic.Title, title => book.Name = title); |
| | 1 | 149 | | hasFoundMetadata |= ReadStringInto(comic.Series, series => book.SeriesName = series); |
| | 1 | 150 | | hasFoundMetadata |= ReadStringInto(comic.Genre, genre => book.AddGenre(genre)); |
| | 1 | 151 | | hasFoundMetadata |= ReadStringInto(comic.Comments, overview => book.Overview = overview); |
| | 1 | 152 | | hasFoundMetadata |= ReadStringInto(comic.Publisher, publisher => book.SetStudios([publisher])); |
| | | 153 | | |
| | 1 | 154 | | if (comic.PublicationYear is not null) |
| | | 155 | | { |
| | 0 | 156 | | book.ProductionYear = comic.PublicationYear; |
| | 0 | 157 | | hasFoundMetadata = true; |
| | | 158 | | } |
| | | 159 | | |
| | 1 | 160 | | if (comic.Issue is not null) |
| | | 161 | | { |
| | 1 | 162 | | book.IndexNumber = comic.Issue; |
| | 1 | 163 | | hasFoundMetadata = true; |
| | | 164 | | } |
| | | 165 | | |
| | 1 | 166 | | if (comic.Tags.Count > 0) |
| | | 167 | | { |
| | 0 | 168 | | book.Tags = comic.Tags.ToArray(); |
| | 0 | 169 | | hasFoundMetadata = true; |
| | | 170 | | } |
| | | 171 | | |
| | 1 | 172 | | if (comic.PublicationYear is not null && comic.PublicationMonth is not null) |
| | | 173 | | { |
| | 0 | 174 | | book.PremiereDate = ReadTwoPartDateInto(comic.PublicationYear.Value, comic.PublicationMonth.Value); |
| | 0 | 175 | | hasFoundMetadata = true; |
| | | 176 | | } |
| | | 177 | | |
| | 1 | 178 | | return hasFoundMetadata ? book : null; |
| | | 179 | | } |
| | | 180 | | |
| | | 181 | | private static void ReadPeopleMetadata(ComicBookInfoMetadata comic, MetadataResult<Book> metadataResult) |
| | | 182 | | { |
| | 0 | 183 | | foreach (var person in comic.Credits) |
| | | 184 | | { |
| | 0 | 185 | | if (person.Person is null || person.Role is null) |
| | | 186 | | { |
| | | 187 | | continue; |
| | | 188 | | } |
| | | 189 | | |
| | 0 | 190 | | if (person.Person.Contains(',', StringComparison.InvariantCultureIgnoreCase)) |
| | | 191 | | { |
| | 0 | 192 | | var name = person.Person.Split(','); |
| | 0 | 193 | | person.Person = name[1].Trim(' ') + " " + name[0].Trim(' '); |
| | | 194 | | } |
| | | 195 | | |
| | 0 | 196 | | if (!Enum.TryParse(person.Role, out PersonKind personKind)) |
| | | 197 | | { |
| | 0 | 198 | | personKind = PersonKind.Unknown; |
| | | 199 | | } |
| | | 200 | | |
| | 0 | 201 | | if (string.Equals("Colorer", person.Role, StringComparison.OrdinalIgnoreCase)) |
| | | 202 | | { |
| | 0 | 203 | | personKind = PersonKind.Colorist; |
| | | 204 | | } |
| | | 205 | | |
| | 0 | 206 | | metadataResult.AddPerson(new PersonInfo { Name = person.Person, Type = personKind }); |
| | | 207 | | } |
| | 0 | 208 | | } |
| | | 209 | | |
| | | 210 | | private static string? ReadCultureInfoInto(string language) |
| | | 211 | | { |
| | | 212 | | try |
| | | 213 | | { |
| | 0 | 214 | | return CultureInfo.GetCultureInfo(language).TwoLetterISOLanguageName; |
| | | 215 | | } |
| | 0 | 216 | | catch (CultureNotFoundException) |
| | | 217 | | { |
| | 0 | 218 | | return null; |
| | | 219 | | } |
| | 0 | 220 | | } |
| | | 221 | | |
| | | 222 | | private static bool ReadStringInto(string? data, Action<string> commitResult) |
| | | 223 | | { |
| | 5 | 224 | | if (!string.IsNullOrWhiteSpace(data)) |
| | | 225 | | { |
| | 2 | 226 | | commitResult(data); |
| | 2 | 227 | | return true; |
| | | 228 | | } |
| | | 229 | | |
| | 3 | 230 | | return false; |
| | | 231 | | } |
| | | 232 | | |
| | | 233 | | private static DateTime? ReadTwoPartDateInto(int year, int month) |
| | | 234 | | { |
| | | 235 | | try |
| | | 236 | | { |
| | | 237 | | // use first day of the month because this format doesn't include a day |
| | 0 | 238 | | return new DateTime(year, month, 1, 0, 0, 0, DateTimeKind.Unspecified); |
| | | 239 | | } |
| | 0 | 240 | | catch (ArgumentOutOfRangeException) |
| | | 241 | | { |
| | 0 | 242 | | return null; |
| | | 243 | | } |
| | 0 | 244 | | } |
| | | 245 | | } |