using System;
using System.Collections.Generic;
#if NET40_OR_GREATER || NETCOREAPP
using System.Collections.Concurrent;
#endif
using System.IO;
using System.Text.RegularExpressions;
#if NET40_OR_GREATER || NETCOREAPP
using System.Threading.Tasks;
#endif
using SabreTools.Core;
using SabreTools.Core.Filter;
using SabreTools.DatItems;
using SabreTools.DatItems.Formats;
namespace SabreTools.DatFiles
{
public partial class DatFile
{
#region Constants
///
/// Scene name Regex pattern
///
private const string SceneNamePattern = @"([0-9]{2}\.[0-9]{2}\.[0-9]{2}-)(.*?-.*?)";
#endregion
#region Filtering
///
/// Execute all filters in a filter runner on the items in the dictionary
///
/// Preconfigured filter runner to use
public void ExecuteFilters(FilterRunner filterRunner)
{
ExecuteFiltersImpl(filterRunner);
ExecuteFiltersImplDB(filterRunner);
}
///
/// Use game descriptions as names, updating cloneof/romof/sampleof
///
/// True if the error that is thrown should be thrown back to the caller, false otherwise
public void MachineDescriptionToName(bool throwOnError = false)
{
MachineDescriptionToNameImpl(throwOnError);
MachineDescriptionToNameImplDB(throwOnError);
}
///
/// Ensure that all roms are in their own game (or at least try to ensure)
///
public void SetOneRomPerGame()
{
SetOneRomPerGameImpl();
SetOneRomPerGameImplDB();
}
///
/// Filter a DAT using 1G1R logic given an ordered set of regions
///
/// List of regions in order of priority
///
/// In the most technical sense, the way that the region list is being used does not
/// confine its values to be just regions. Since it's essentially acting like a
/// specialized version of the machine name filter, anything that is usually encapsulated
/// in parenthesis would be matched on, including disc numbers, languages, editions,
/// and anything else commonly used. Please note that, unlike other existing 1G1R
/// solutions, this does not have the ability to contain custom mappings of parent
/// to clone sets based on name, nor does it have the ability to match on the
/// Release DatItem type.
///
public void SetOneGamePerRegion(List regionList)
{
SetOneGamePerRegionImpl(regionList);
SetOneGamePerRegionImplDB(regionList);
}
///
/// Strip the dates from the beginning of scene-style set names
///
public void StripSceneDatesFromItems()
{
StripSceneDatesFromItemsImpl();
StripSceneDatesFromItemsImplDB();
}
#endregion
#region Filtering Implementations
///
/// Create machine to description mapping dictionary
///
/// Applies to
private IDictionary CreateMachineToDescriptionMapping()
{
#if NET40_OR_GREATER || NETCOREAPP
ConcurrentDictionary mapping = new();
#else
Dictionary mapping = [];
#endif
#if NET452_OR_GREATER || NETCOREAPP
Parallel.ForEach(Items.SortedKeys, Globals.ParallelOptions, key =>
#elif NET40_OR_GREATER
Parallel.ForEach(Items.SortedKeys, key =>
#else
foreach (var key in Items.SortedKeys)
#endif
{
var items = GetItemsForBucket(key);
if (items == null)
#if NET40_OR_GREATER || NETCOREAPP
return;
#else
continue;
#endif
foreach (DatItem item in items)
{
// Get the current machine
var machine = item.GetMachine();
if (machine == null)
continue;
// Get the values to check against
string? machineName = machine.GetName();
string? machineDesc = machine.GetStringFieldValue(Models.Metadata.Machine.DescriptionKey);
if (machineName == null || machineDesc == null)
continue;
// Adjust the description
machineDesc = machineDesc.Replace('/', '_').Replace("\"", "''").Replace(":", " -");
if (machineName == machineDesc)
continue;
// If the key mapping doesn't exist, add it
#if NET40_OR_GREATER || NETCOREAPP
mapping.TryAdd(machineName, machineDesc);
#else
if (!mapping.ContainsKey(machineName))
mapping[machineName] = machineDesc;
#endif
}
#if NET40_OR_GREATER || NETCOREAPP
});
#else
}
#endif
return mapping;
}
///
/// Create machine to description mapping dictionary
///
/// Applies to
private Dictionary CreateMachineToDescriptionMappingDB()
{
Dictionary mapping = [];
foreach (var machine in GetMachinesDB())
{
// Get the current machine
if (machine.Value == null)
continue;
// Get the values to check against
string? machineName = machine.Value.GetName();
string? machineDesc = machine.Value.GetStringFieldValue(Models.Metadata.Machine.DescriptionKey);
if (machineName == null || machineDesc == null)
continue;
// Adjust the description
machineDesc = machineDesc.Replace('/', '_').Replace("\"", "''").Replace(":", " -");
if (machineName == machineDesc)
continue;
// If the key mapping doesn't exist, add it
if (!mapping.ContainsKey(machineName))
mapping[machineName] = machineDesc;
}
return mapping;
}
///
/// Execute all filters in a filter runner on the items in the dictionary
///
/// Preconfigured filter runner to use
/// Applies to
private void ExecuteFiltersImpl(FilterRunner filterRunner)
{
#if NET452_OR_GREATER || NETCOREAPP
Parallel.ForEach(Items.SortedKeys, Core.Globals.ParallelOptions, key =>
#elif NET40_OR_GREATER
Parallel.ForEach(Items.SortedKeys, key =>
#else
foreach (var key in Items.SortedKeys)
#endif
{
ExecuteFilterOnBucket(filterRunner, key);
#if NET40_OR_GREATER || NETCOREAPP
});
#else
}
#endif
}
///
/// Execute all filters in a filter runner on the items in the dictionary
///
/// Preconfigured filter runner to use
/// Applies to
private void ExecuteFiltersImplDB(FilterRunner filterRunner)
{
List keys = [.. ItemsDB.SortedKeys];
#if NET452_OR_GREATER || NETCOREAPP
Parallel.ForEach(keys, Globals.ParallelOptions, key =>
#elif NET40_OR_GREATER
Parallel.ForEach(keys, key =>
#else
foreach (var key in keys)
#endif
{
ExecuteFilterOnBucketDB(filterRunner, key);
#if NET40_OR_GREATER || NETCOREAPP
});
#else
}
#endif
}
///
/// Execute all filters in a filter runner on a single bucket
///
/// Preconfigured filter runner to use
/// Name of the bucket to filter on
/// Applies to
private void ExecuteFilterOnBucket(FilterRunner filterRunner, string bucketName)
{
List? items = GetItemsForBucket(bucketName);
if (items == null)
return;
// Filter all items in the current key
foreach (var item in items)
{
if (!item.PassesFilter(filterRunner))
item.SetFieldValue(DatItem.RemoveKey, true);
}
}
///
/// Execute all filters in a filter runner on a single bucket
///
/// Preconfigured filter runner to use
/// Name of the bucket to filter on
/// Applies to
private void ExecuteFilterOnBucketDB(FilterRunner filterRunner, string bucketName)
{
var items = GetItemsForBucketDB(bucketName);
if (items == null)
return;
// Filter all items in the current key
List newItems = [];
foreach (var item in items)
{
if (!item.Value.PassesFilterDB(filterRunner))
item.Value.SetFieldValue(DatItem.RemoveKey, true);
}
}
///
/// Use game descriptions as names, updating cloneof/romof/sampleof
///
/// True if the error that is thrown should be thrown back to the caller, false otherwise
/// Applies to
private void MachineDescriptionToNameImpl(bool throwOnError = false)
{
try
{
// First we want to get a mapping for all games to description
var mapping = CreateMachineToDescriptionMapping();
// Now we loop through every item and update accordingly
UpdateMachineNamesFromDescriptions(mapping);
}
catch (Exception ex) when (!throwOnError)
{
_logger.Warning(ex.ToString());
}
}
///
/// Use game descriptions as names, updating cloneof/romof/sampleof
///
/// True if the error that is thrown should be thrown back to the caller, false otherwise
/// Applies to
private void MachineDescriptionToNameImplDB(bool throwOnError = false)
{
try
{
// First we want to get a mapping for all games to description
var mapping = CreateMachineToDescriptionMappingDB();
// Now we loop through every item and update accordingly
UpdateMachineNamesFromDescriptionsDB(mapping);
}
catch (Exception ex) when (!throwOnError)
{
_logger.Warning(ex.ToString());
}
}
///
/// Filter a DAT using 1G1R logic given an ordered set of regions
///
/// List of regions in order of priority
/// Applies to
private void SetOneGamePerRegionImpl(List regionList)
{
// For sake of ease, the first thing we want to do is bucket by game
BucketBy(ItemKey.Machine, norename: true);
// Then we want to get a mapping of all machines to parents
Dictionary> parents = [];
foreach (string key in Items.SortedKeys)
{
DatItem item = GetItemsForBucket(key)[0];
// Get machine information
Machine? machine = item.GetMachine();
string? machineName = machine?.GetName()?.ToLowerInvariant();
if (machine == null || machineName == null)
continue;
// Get the string values
string? cloneOf = machine.GetStringFieldValue(Models.Metadata.Machine.CloneOfKey)?.ToLowerInvariant();
string? romOf = machine.GetStringFieldValue(Models.Metadata.Machine.RomOfKey)?.ToLowerInvariant();
// Match on CloneOf first
if (!string.IsNullOrEmpty(cloneOf))
{
if (!parents.ContainsKey(cloneOf!))
parents.Add(cloneOf!, []);
parents[cloneOf!].Add(machineName);
}
// Then by RomOf
else if (!string.IsNullOrEmpty(romOf))
{
if (!parents.ContainsKey(romOf!))
parents.Add(romOf!, []);
parents[romOf!].Add(machineName);
}
// Otherwise, treat it as a parent
else
{
if (!parents.ContainsKey(machineName))
parents.Add(machineName, []);
parents[machineName].Add(machineName);
}
}
// Once we have the full list of mappings, filter out games to keep
foreach (string key in parents.Keys)
{
// Find the first machine that matches the regions in order, if possible
string? machine = default;
foreach (string region in regionList)
{
machine = parents[key].Find(m => Regex.IsMatch(m, @"\(.*" + region + @".*\)", RegexOptions.IgnoreCase));
if (machine != default)
break;
}
// If we didn't get a match, use the parent
if (machine == default)
machine = key;
// Remove the key from the list
parents[key].Remove(machine);
// Remove the rest of the items from this key
parents[key].ForEach(k => RemoveBucket(k));
}
// Finally, strip out the parent tags
RemoveMachineRelationshipTagsImpl();
}
///
/// Filter a DAT using 1G1R logic given an ordered set of regions
///
/// List of regions in order of priority
/// Applies to
private void SetOneGamePerRegionImplDB(List regionList)
{
// Then we want to get a mapping of all machines to parents
Dictionary> parents = [];
foreach (var machine in GetMachinesDB())
{
if (machine.Value == null)
continue;
// Get machine information
Machine? machineObj = machine.Value;
string? machineName = machineObj?.GetName()?.ToLowerInvariant();
if (machineObj == null || machineName == null)
continue;
// Get the string values
string? cloneOf = machineObj.GetStringFieldValue(Models.Metadata.Machine.CloneOfKey)?.ToLowerInvariant();
string? romOf = machineObj.GetStringFieldValue(Models.Metadata.Machine.RomOfKey)?.ToLowerInvariant();
// Match on CloneOf first
if (!string.IsNullOrEmpty(cloneOf))
{
if (!parents.ContainsKey(cloneOf!))
parents.Add(cloneOf!, []);
parents[cloneOf!].Add(machineName);
}
// Then by RomOf
else if (!string.IsNullOrEmpty(romOf))
{
if (!parents.ContainsKey(romOf!))
parents.Add(romOf!, []);
parents[romOf!].Add(machineName);
}
// Otherwise, treat it as a parent
else
{
if (!parents.ContainsKey(machineName))
parents.Add(machineName, []);
parents[machineName].Add(machineName);
}
}
// Once we have the full list of mappings, filter out games to keep
foreach (string key in parents.Keys)
{
// Find the first machine that matches the regions in order, if possible
string? machine = default;
foreach (string region in regionList)
{
machine = parents[key].Find(m => Regex.IsMatch(m, @"\(.*" + region + @".*\)", RegexOptions.IgnoreCase));
if (machine != default)
break;
}
// If we didn't get a match, use the parent
if (machine == default)
machine = key;
// Remove the key from the list
parents[key].Remove(machine);
// Remove the rest of the items from this key
parents[key].ForEach(k => RemoveMachineDB(k));
}
// Finally, strip out the parent tags
RemoveMachineRelationshipTagsImplDB();
}
///
/// Ensure that all roms are in their own game (or at least try to ensure)
///
/// Applies to
private void SetOneRomPerGameImpl()
{
// For each rom, we want to update the game to be "/"
#if NET452_OR_GREATER || NETCOREAPP
Parallel.ForEach(Items.SortedKeys, Globals.ParallelOptions, key =>
#elif NET40_OR_GREATER
Parallel.ForEach(Items.SortedKeys, key =>
#else
foreach (var key in Items.SortedKeys)
#endif
{
var items = GetItemsForBucket(key);
if (items == null)
#if NET40_OR_GREATER || NETCOREAPP
return;
#else
continue;
#endif
for (int i = 0; i < items.Count; i++)
{
SetOneRomPerGameImpl(items[i]);
}
#if NET40_OR_GREATER || NETCOREAPP
});
#else
}
#endif
}
///
/// Set internal names to match One Rom Per Game (ORPG) logic
///
/// DatItem to run logic on
/// Applies to
private static void SetOneRomPerGameImpl(DatItem datItem)
{
// If the item name is null
string? itemName = datItem.GetName();
if (itemName == null)
return;
// Get the current machine
var machine = datItem.GetMachine();
if (machine == null)
return;
// Clone current machine to avoid conflict
machine = (Machine)machine.Clone();
// Reassign the item to the new machine
datItem.SetFieldValue(DatItem.MachineKey, machine);
// Remove extensions from File and Rom items
if (datItem is DatItems.Formats.File || datItem is Rom)
{
string[] splitname = itemName.Split('.');
itemName = machine.GetName()
+ $"/{string.Join(".", splitname, 0, splitname.Length > 1 ? splitname.Length - 1 : 1)}";
}
else
{
itemName = machine.GetName() + $"/{itemName}";
}
// Strip off "Default" prefix only for ORPG
if (itemName.StartsWith("Default"))
itemName = itemName.Substring("Default".Length + 1);
machine.SetName(itemName);
datItem.SetName(Path.GetFileName(datItem.GetName()));
}
///
/// Ensure that all roms are in their own game (or at least try to ensure)
///
/// Applies to
private void SetOneRomPerGameImplDB()
{
// For each rom, we want to update the game to be "/"
#if NET452_OR_GREATER || NETCOREAPP
Parallel.ForEach(ItemsDB.SortedKeys, Globals.ParallelOptions, key =>
#elif NET40_OR_GREATER
Parallel.ForEach(ItemsDB.SortedKeys, key =>
#else
foreach (var key in ItemsDB.SortedKeys)
#endif
{
var items = GetItemsForBucketDB(key);
if (items == null)
#if NET40_OR_GREATER || NETCOREAPP
return;
#else
continue;
#endif
foreach (var item in items)
{
SetOneRomPerGameImplDB(item);
}
#if NET40_OR_GREATER || NETCOREAPP
});
#else
}
#endif
}
///
/// Set internal names to match One Rom Per Game (ORPG) logic
///
/// DatItem to run logic on
/// Applies to
private void SetOneRomPerGameImplDB(KeyValuePair datItem)
{
// If the item name is null
string? itemName = datItem.Value.GetName();
if (datItem.Key < 0 || itemName == null)
return;
// Get the current machine
var machine = GetMachineForItemDB(datItem.Key);
if (machine.Value == null)
return;
// Clone current machine to avoid conflict
long newMachineIndex = AddMachineDB((Machine)machine.Value.Clone());
machine = new KeyValuePair(newMachineIndex, ItemsDB.GetMachine(newMachineIndex));
if (machine.Value == null)
return;
// Reassign the item to the new machine
ItemsDB.RemapDatItemToMachine(datItem.Key, newMachineIndex);
// Remove extensions from File and Rom items
if (datItem.Value is DatItems.Formats.File || datItem.Value is Rom)
{
string[] splitname = itemName.Split('.');
itemName = machine.Value.GetName()
+ $"/{string.Join(".", splitname, 0, splitname.Length > 1 ? splitname.Length - 1 : 1)}";
}
else
{
itemName = machine.Value.GetName() + $"/{itemName}";
}
// Strip off "Default" prefix only for ORPG
if (itemName.StartsWith("Default"))
itemName = itemName.Substring("Default".Length + 1);
machine.Value.SetName(itemName);
datItem.Value.SetName(Path.GetFileName(datItem.Value.GetName()));
}
///
/// Strip the dates from the beginning of scene-style set names
///
/// Applies to
private void StripSceneDatesFromItemsImpl()
{
// Now process all of the roms
#if NET452_OR_GREATER || NETCOREAPP
Parallel.ForEach(Items.SortedKeys, Globals.ParallelOptions, key =>
#elif NET40_OR_GREATER
Parallel.ForEach(Items.SortedKeys, key =>
#else
foreach (var key in Items.SortedKeys)
#endif
{
var items = GetItemsForBucket(key);
if (items == null)
#if NET40_OR_GREATER || NETCOREAPP
return;
#else
continue;
#endif
foreach (DatItem item in items)
{
// Get the current machine
var machine = item.GetMachine();
if (machine == null)
continue;
// Get the values to check against
string? machineName = machine.GetName();
string? machineDesc = machine.GetStringFieldValue(Models.Metadata.Machine.DescriptionKey);
if (machineName != null && Regex.IsMatch(machineName, SceneNamePattern))
item.GetMachine()!.SetName(Regex.Replace(machineName, SceneNamePattern, "$2"));
if (machineDesc != null && Regex.IsMatch(machineDesc, SceneNamePattern))
item.GetMachine()!.SetFieldValue(Models.Metadata.Machine.DescriptionKey, Regex.Replace(machineDesc, SceneNamePattern, "$2"));
}
#if NET40_OR_GREATER || NETCOREAPP
});
#else
}
#endif
}
///
/// Strip the dates from the beginning of scene-style set names
///
/// Applies to
private void StripSceneDatesFromItemsImplDB()
{
// Now process all of the machines
#if NET452_OR_GREATER || NETCOREAPP
Parallel.ForEach(GetMachinesDB(), Core.Globals.ParallelOptions, machine =>
#elif NET40_OR_GREATER
Parallel.ForEach(GetMachinesDB(), machine =>
#else
foreach (var machine in GetMachinesDB())
#endif
{
// Get the current machine
if (machine.Value == null)
#if NET40_OR_GREATER || NETCOREAPP
return;
#else
continue;
#endif
// Get the values to check against
string? machineName = machine.Value.GetName();
string? machineDesc = machine.Value.GetStringFieldValue(Models.Metadata.Machine.DescriptionKey);
if (machineName != null && Regex.IsMatch(machineName, SceneNamePattern))
machine.Value.SetName(Regex.Replace(machineName, SceneNamePattern, "$2"));
if (machineDesc != null && Regex.IsMatch(machineDesc, SceneNamePattern))
machine.Value.SetFieldValue(Models.Metadata.Machine.DescriptionKey, Regex.Replace(machineDesc, SceneNamePattern, "$2"));
#if NET40_OR_GREATER || NETCOREAPP
});
#else
}
#endif
}
///
/// Update machine names from descriptions according to mappings
///
/// Applies to
private void UpdateMachineNamesFromDescriptions(IDictionary mapping)
{
#if NET452_OR_GREATER || NETCOREAPP
Parallel.ForEach(Items.SortedKeys, Globals.ParallelOptions, key =>
#elif NET40_OR_GREATER
Parallel.ForEach(Items.SortedKeys, key =>
#else
foreach (var key in Items.SortedKeys)
#endif
{
var items = GetItemsForBucket(key);
if (items == null)
#if NET40_OR_GREATER || NETCOREAPP
return;
#else
continue;
#endif
foreach (DatItem item in items)
{
// Get the current machine
var machine = item.GetMachine();
if (machine == null)
continue;
// Get the values to check against
string? machineName = machine.GetName();
string? cloneOf = machine.GetStringFieldValue(Models.Metadata.Machine.CloneOfKey);
string? romOf = machine.GetStringFieldValue(Models.Metadata.Machine.RomOfKey);
string? sampleOf = machine.GetStringFieldValue(Models.Metadata.Machine.SampleOfKey);
// Update machine name
if (machineName != null && mapping.ContainsKey(machineName))
machine.SetName(mapping[machineName]);
// Update cloneof
if (cloneOf != null && mapping.ContainsKey(cloneOf))
machine.SetFieldValue(Models.Metadata.Machine.CloneOfKey, mapping[cloneOf]);
// Update romof
if (romOf != null && mapping.ContainsKey(romOf))
machine.SetFieldValue(Models.Metadata.Machine.RomOfKey, mapping[romOf]);
// Update sampleof
if (sampleOf != null && mapping.ContainsKey(sampleOf))
machine.SetFieldValue(Models.Metadata.Machine.SampleOfKey, mapping[sampleOf]);
}
#if NET40_OR_GREATER || NETCOREAPP
});
#else
}
#endif
}
///
/// Update machine names from descriptions according to mappings
///
/// Applies to
private void UpdateMachineNamesFromDescriptionsDB(Dictionary mapping)
{
foreach (var machine in GetMachinesDB())
{
// Get the current machine
if (machine.Value == null)
continue;
// Get the values to check against
string? machineName = machine.Value.GetName();
string? cloneOf = machine.Value.GetStringFieldValue(Models.Metadata.Machine.CloneOfKey);
string? romOf = machine.Value.GetStringFieldValue(Models.Metadata.Machine.RomOfKey);
string? sampleOf = machine.Value.GetStringFieldValue(Models.Metadata.Machine.SampleOfKey);
// Update machine name
if (machineName != null && mapping.ContainsKey(machineName))
machine.Value.SetName(mapping[machineName]);
// Update cloneof
if (cloneOf != null && mapping.ContainsKey(cloneOf))
machine.Value.SetFieldValue(Models.Metadata.Machine.CloneOfKey, mapping[cloneOf]);
// Update romof
if (romOf != null && mapping.ContainsKey(romOf))
machine.Value.SetFieldValue(Models.Metadata.Machine.RomOfKey, mapping[romOf]);
// Update sampleof
if (sampleOf != null && mapping.ContainsKey(sampleOf))
machine.Value.SetFieldValue(Models.Metadata.Machine.SampleOfKey, mapping[sampleOf]);
}
}
#endregion
}
}