using System; using System.Collections.Generic; using System.Globalization; using System.Linq; using Kavita.Common.Extensions; using Kavita.Models.Entities; using Kavita.Models.Entities.Enums; namespace Kavita.Models.Metadata; #nullable enable /// /// A representation of a ComicInfo.xml file /// /// See reference of the loose spec here: https://anansi-project.github.io/docs/comicinfo/documentation public class ComicInfo { public string Summary { get; set; } = string.Empty; public string Title { get; set; } = string.Empty; public string Series { get; set; } = string.Empty; /// /// Localized Series name. Not standard. /// public string LocalizedSeries { get; set; } = string.Empty; public string SeriesSort { get; set; } = string.Empty; public string Number { get; set; } = string.Empty; /// /// The total number of items in the series. /// [System.ComponentModel.DefaultValueAttribute(0)] public int Count { get; set; } = 0; public string Volume { get; set; } = string.Empty; public string Notes { get; set; } = string.Empty; public string Genre { get; set; } = string.Empty; public int PageCount { get; set; } // ReSharper disable once InconsistentNaming /// /// IETF BCP 47 Code to represent the language of the content /// public string LanguageISO { get; set; } = string.Empty; // ReSharper disable once InconsistentNaming /// /// ISBN for the underlying document /// /// ComicInfo.xml will actually output a GTIN (Global Trade Item Number) and it is the responsibility of the Parser to extract the ISBN. EPub will return ISBN. public string Isbn { get; set; } = string.Empty; /// /// This is only for deserialization and used within . Use for the actual value. /// public string GTIN { get; set; } = string.Empty; /// /// This is the link to where the data was scraped from /// /// This can be comma-separated public string Web { get; set; } = string.Empty; [System.ComponentModel.DefaultValueAttribute(0)] public int Day { get; set; } = 0; [System.ComponentModel.DefaultValueAttribute(0)] public int Month { get; set; } = 0; [System.ComponentModel.DefaultValueAttribute(0)] public int Year { get; set; } = 0; /// /// Rating based on the content. Think PG-13, R for movies. See for valid types /// public string AgeRating { get; set; } = string.Empty; /// /// User's rating of the content /// public float UserRating { get; set; } /// /// Can contain multiple comma separated strings, each create a /// public string SeriesGroup { get; set; } = string.Empty; /// /// Can contain multiple comma separated numbers that match with StoryArcNumber /// public string StoryArc { get; set; } = string.Empty; /// /// Can contain multiple comma separated numbers that match with StoryArc /// public string StoryArcNumber { get; set; } = string.Empty; public string AlternateNumber { get; set; } = string.Empty; public string AlternateSeries { get; set; } = string.Empty; /// /// Not used /// [System.ComponentModel.DefaultValueAttribute(0)] public int AlternateCount { get; set; } = 0; /// /// This is Epub only: calibre:title_sort /// Represents the sort order for the title /// public string TitleSort { get; set; } = string.Empty; /// /// This comes from ComicInfo and is free form text. We use this to validate against a set of tags and mark a file as /// special. /// public string Format { get; set; } = string.Empty; /// /// The translator, can be comma separated. This is part of ComicInfo.xml draft v2.1 /// /// See https://github.com/anansi-project/comicinfo/issues/2 for information about this tag public string Translator { get; set; } = string.Empty; /// /// Misc tags. This is part of ComicInfo.xml draft v2.1 /// /// See https://github.com/anansi-project/comicinfo/issues/1 for information about this tag public string Tags { get; set; } = string.Empty; /// /// This is the Author. For Books, we map creator tag in OPF to this field. Comma separated if multiple. /// public string Writer { get; set; } = string.Empty; public string Penciller { get; set; } = string.Empty; public string Inker { get; set; } = string.Empty; public string Colorist { get; set; } = string.Empty; public string Letterer { get; set; } = string.Empty; public string CoverArtist { get; set; } = string.Empty; public string Editor { get; set; } = string.Empty; public string Publisher { get; set; } = string.Empty; public string Imprint { get; set; } = string.Empty; public string Characters { get; set; } = string.Empty; public string Teams { get; set; } = string.Empty; public string Locations { get; set; } = string.Empty; public IList GetPeopleForRole(PersonRole role) => role switch { PersonRole.Writer => SplitNames(Writer), PersonRole.Penciller => SplitNames(Penciller), PersonRole.Inker => SplitNames(Inker), PersonRole.Colorist => SplitNames(Colorist), PersonRole.Letterer => SplitNames(Letterer), PersonRole.CoverArtist => SplitNames(CoverArtist), PersonRole.Editor => SplitNames(Editor), PersonRole.Publisher => SplitNames(Publisher), PersonRole.Translator => SplitNames(Translator), PersonRole.Imprint => SplitNames(Imprint), PersonRole.Character => SplitNames(Characters), PersonRole.Team => SplitNames(Teams), PersonRole.Location => SplitNames(Locations), PersonRole.Other => [], _ => throw new ArgumentOutOfRangeException(nameof(role), role, null) }; private static string[] SplitNames(string value) => value.Split(',', StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries); public static AgeRating ConvertAgeRatingToEnum(string value) { if (string.IsNullOrEmpty(value)) return Entities.Enums.AgeRating.Unknown; return Enum.GetValues() .SingleOrDefault(t => t.ToDescription().ToUpperInvariant().Equals(value.ToUpperInvariant()), Entities.Enums.AgeRating.Unknown); } /// /// Uses both Volume and Number to make an educated guess as to what count refers to and it's highest number. /// /// public int CalculatedCount() { try { if (float.TryParse(Number, CultureInfo.InvariantCulture, out var chpCount) && chpCount > 0) { return (int) Math.Floor(chpCount); } if (float.TryParse(Volume, CultureInfo.InvariantCulture, out var volCount) && volCount > 0) { return (int) Math.Floor(volCount); } } catch (Exception) { return 0; } return 0; } }