using System.Collections.Generic; using System.IO; using System.Linq; using SabreTools.Library.Filtering; using SabreTools.Library.Tools; using Newtonsoft.Json; using Newtonsoft.Json.Converters; namespace SabreTools.Library.DatItems { /// /// Represents which SoftwareList(s) is associated with a set /// [JsonObject("softwarelist")] public class SoftwareList : DatItem { #region Fields /// /// Name of the item /// [JsonProperty("name")] public string Name { get; set; } /// /// Status of the softare list according to the machine /// [JsonProperty("status", DefaultValueHandling = DefaultValueHandling.Ignore)] [JsonConverter(typeof(StringEnumConverter))] public SoftwareListStatus Status { get; set; } /// /// Filter to apply to the software list /// [JsonProperty("filter", DefaultValueHandling = DefaultValueHandling.Ignore)] 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; } /// /// Set fields with given values /// /// Mappings dictionary public override void SetFields(Dictionary mappings) { // Set base fields base.SetFields(mappings); // Handle SoftwareList-specific fields if (mappings.Keys.Contains(Field.DatItem_Name)) Name = mappings[Field.DatItem_Name]; if (mappings.Keys.Contains(Field.DatItem_SoftwareListStatus)) Status = mappings[Field.DatItem_Default].AsSoftwareListStatus(); if (mappings.Keys.Contains(Field.DatItem_Filter)) Filter = mappings[Field.DatItem_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 = Sanitizer.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; } } } /// /// Check to see if a DatItem passes the filter /// /// Filter to check against /// True if the item passed the filter, false otherwise public override bool PassesFilter(Filter filter) { // Check common fields first if (!base.PassesFilter(filter)) return false; // Filter on item name if (filter.DatItem_Name.MatchesPositiveSet(Name) == false) return false; if (filter.DatItem_Name.MatchesNegativeSet(Name) == true) return false; // Filter on status if (filter.DatItem_SoftwareListStatus.MatchesPositive(SoftwareListStatus.NULL, Status) == false) return false; if (filter.DatItem_SoftwareListStatus.MatchesNegative(SoftwareListStatus.NULL, Status) == true) return false; // Filter on filter if (filter.DatItem_Filter.MatchesPositiveSet(Filter) == false) return false; if (filter.DatItem_Filter.MatchesNegativeSet(Filter) == true) return false; return true; } /// /// Remove fields from the DatItem /// /// List of Fields to remove public override void RemoveFields(List fields) { // Remove common fields first base.RemoveFields(fields); // Remove the fields if (fields.Contains(Field.DatItem_Name)) Name = null; if (fields.Contains(Field.DatItem_SoftwareListStatus)) Status = SoftwareListStatus.NULL; if (fields.Contains(Field.DatItem_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 /// /// Replace fields from another item /// /// DatItem to pull new information from /// List of Fields representing what should be updated public override void ReplaceFields(DatItem item, List fields) { // Replace common fields first base.ReplaceFields(item, fields); // 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 (fields.Contains(Field.DatItem_Name)) Name = newItem.Name; if (fields.Contains(Field.DatItem_SoftwareListStatus)) Status = newItem.Status; if (fields.Contains(Field.DatItem_Filter)) Filter = newItem.Filter; } #endregion } }