using System.Collections.Generic; using System.IO; using System.Linq; using System.Xml.Serialization; using SabreTools.Core; using SabreTools.Core.Tools; using SabreTools.Filtering; using Newtonsoft.Json; using Newtonsoft.Json.Converters; namespace SabreTools.DatItems { /// /// Represents which SoftwareList(s) is associated with a set /// [JsonObject("softwarelist"), XmlRoot("softwarelist")] public class SoftwareList : DatItem { #region Fields /// /// Name of the item /// [JsonProperty("name")] [XmlElement("name")] public string Name { get; set; } /// /// Status of the softare list according to the machine /// [JsonProperty("status", DefaultValueHandling = DefaultValueHandling.Ignore)] [JsonConverter(typeof(StringEnumConverter))] [XmlElement("status")] public SoftwareListStatus Status { get; set; } [JsonIgnore] public bool StatusSpecified { get { return Status != SoftwareListStatus.NULL; } } /// /// Filter to apply to the software list /// [JsonProperty("filter", DefaultValueHandling = DefaultValueHandling.Ignore)] [XmlElement("filter")] public string Filter { get; set; } #endregion #region Accessors /// /// Gets the name to use for a DatItem /// /// Name if available, null otherwise public override string GetName() { return Name; } /// public override void SetFields( Dictionary datItemMappings, Dictionary machineMappings) { // Set base fields base.SetFields(datItemMappings, machineMappings); // Handle SoftwareList-specific fields if (datItemMappings.Keys.Contains(DatItemField.Name)) Name = datItemMappings[DatItemField.Name]; if (datItemMappings.Keys.Contains(DatItemField.SoftwareListStatus)) Status = datItemMappings[DatItemField.SoftwareListStatus].AsSoftwareListStatus(); if (datItemMappings.Keys.Contains(DatItemField.Filter)) Filter = datItemMappings[DatItemField.Filter]; } #endregion #region Constructors /// /// Create a default, empty SoftwareList object /// public SoftwareList() { Name = string.Empty; ItemType = ItemType.SoftwareList; } #endregion #region Cloning Methods public override object Clone() { return new SoftwareList() { ItemType = this.ItemType, DupeType = this.DupeType, Machine = this.Machine.Clone() as Machine, Source = this.Source.Clone() as Source, Remove = this.Remove, Name = this.Name, Status = this.Status, Filter = this.Filter, }; } #endregion #region Comparision Methods public override bool Equals(DatItem other) { // If we don't have a sample, return false if (ItemType != other.ItemType) return false; // Otherwise, treat it as a SoftwareList SoftwareList newOther = other as SoftwareList; // If the SoftwareList information matches return (Name == newOther.Name && Status == newOther.Status && Filter == newOther.Filter); } #endregion #region Filtering /// /// Clean a DatItem according to the cleaner /// /// Cleaner to implement public override void Clean(Cleaner cleaner) { // Clean common items first base.Clean(cleaner); // If we're stripping unicode characters, strip item name if (cleaner?.RemoveUnicode == true) Name = RemoveUnicodeCharacters(Name); // If we are in NTFS trim mode, trim the game name if (cleaner?.Trim == true) { // Windows max name length is 260 int usableLength = 260 - Machine.Name.Length - (cleaner.Root?.Length ?? 0); if (Name.Length > usableLength) { string ext = Path.GetExtension(Name); Name = Name.Substring(0, usableLength - ext.Length); Name += ext; } } } /// public override bool PassesFilter(Cleaner cleaner, bool sub = false) { // Check common fields first if (!base.PassesFilter(cleaner, sub)) return false; // Filter on item name if (!Filtering.Filter.PassStringFilter(cleaner.DatItemFilter.Name, Name)) return false; // Filter on status if (cleaner.DatItemFilter.SoftwareListStatus.MatchesPositive(SoftwareListStatus.NULL, Status) == false) return false; if (cleaner.DatItemFilter.SoftwareListStatus.MatchesNegative(SoftwareListStatus.NULL, Status) == true) return false; // Filter on filter if (!Filtering.Filter.PassStringFilter(cleaner.DatItemFilter.Filter, Filter)) return false; return true; } /// public override void RemoveFields( List datItemFields, List machineFields) { // Remove common fields first base.RemoveFields(datItemFields, machineFields); // Remove the fields if (datItemFields.Contains(DatItemField.Name)) Name = null; if (datItemFields.Contains(DatItemField.SoftwareListStatus)) Status = SoftwareListStatus.NULL; if (datItemFields.Contains(DatItemField.Filter)) Filter = null; } /// /// Set internal names to match One Rom Per Game (ORPG) logic /// public override void SetOneRomPerGame() { string[] splitname = Name.Split('.'); Machine.Name += $"/{string.Join(".", splitname.Take(splitname.Length > 1 ? splitname.Length - 1 : 1))}"; Name = Path.GetFileName(Name); } #endregion #region Sorting and Merging /// public override void ReplaceFields( DatItem item, List datItemFields, List machineFields) { // Replace common fields first base.ReplaceFields(item, datItemFields, machineFields); // If we don't have a SoftwareList to replace from, ignore specific fields if (item.ItemType != ItemType.SoftwareList) return; // Cast for easier access SoftwareList newItem = item as SoftwareList; // Replace the fields if (datItemFields.Contains(DatItemField.Name)) Name = newItem.Name; if (datItemFields.Contains(DatItemField.SoftwareListStatus)) Status = newItem.Status; if (datItemFields.Contains(DatItemField.Filter)) Filter = newItem.Filter; } #endregion } }