/// <summary>
/// Builds the installation queues for the mod. Item 1 is the unpacked job mappings (per modjob) along with the list of custom dlc folders being installed. Item 2 is the list of modjobs, their sfar paths, and the list of source files to install for SFAR jobs.
/// </summary>
/// <param name="gameTarget"></param>
/// <returns></returns>
public (Dictionary <ModJob, (Dictionary <string, InstallSourceFile> unpackedJobMapping, List <string> dlcFoldersBeingInstalled)>, List <(ModJob job, string sfarPath, Dictionary <string, InstallSourceFile>)>) GetInstallationQueues(GameTarget gameTarget)
{
if (IsInArchive)
{
#if DEBUG
if (Archive.IsDisposed())
{
Debug.WriteLine(@">>> ARCHIVE IS DISPOSED");
}
#endif
if (File.Exists(ArchivePath) && (Archive == null || Archive.IsDisposed()))
{
Archive = new SevenZipExtractor(ArchivePath); //load archive file for inspection
}
else if (Archive != null && Archive.GetBackingStream() is SevenZip.ArchiveEmulationStreamProxy aesp && aesp.Source is MemoryStream ms)
{
var isExe = ArchivePath.EndsWith(@".exe", StringComparison.InvariantCultureIgnoreCase);
Archive = isExe ? new SevenZipExtractor(ms, InArchiveFormat.Nsis) : new SevenZipExtractor(ms);
MemoryAnalyzer.AddTrackedMemoryItem($@"Re-opened SVE archive for {ModName}", new WeakReference(Archive));
}
}
var gameDLCPath = M3Directories.GetDLCPath(gameTarget);
var customDLCMapping = Enumerable.FirstOrDefault <ModJob>(InstallationJobs, x => x.Header == ModJob.JobHeader.CUSTOMDLC)?.CustomDLCFolderMapping;
if (customDLCMapping != null)
{
//Make clone so original value is not modified
customDLCMapping = new Dictionary <string, string>(customDLCMapping); //prevent altering the source object
}
var unpackedJobInstallationMapping = new Dictionary <ModJob, (Dictionary <string, InstallSourceFile> mapping, List <string> dlcFoldersBeingInstalled)>();
var sfarInstallationJobs = new List <(ModJob job, string sfarPath, Dictionary <string, InstallSourceFile> installationMapping)>();
foreach (var job in InstallationJobs)
{
Log.Information($@"Preprocessing installation job: {job.Header}");
var alternateFiles = Enumerable.Where <AlternateFile>(job.AlternateFiles, x => x.IsSelected && x.Operation != AlternateFile.AltFileOperation.OP_NOTHING &&
x.Operation != AlternateFile.AltFileOperation.OP_NOINSTALL_MULTILISTFILES).ToList();
var alternateDLC = Enumerable.Where <AlternateDLC>(job.AlternateDLCs, x => x.IsSelected).ToList();
if (job.Header == ModJob.JobHeader.CUSTOMDLC)
{
#region Installation: CustomDLC
//Key = destination file, value = source file to install
var installationMapping = new Dictionary <string, InstallSourceFile>();
unpackedJobInstallationMapping[job] = (installationMapping, new List <string>());
foreach (var altdlc in alternateDLC)
{
if (altdlc.Operation == AlternateDLC.AltDLCOperation.OP_ADD_CUSTOMDLC)
{
customDLCMapping[altdlc.AlternateDLCFolder] = altdlc.DestinationDLCFolder;
}
}
foreach (var mapping in customDLCMapping)
{
//Mapping is done as DESTINATIONFILE = SOURCEFILE so you can override keys
var source = FilesystemInterposer.PathCombine(IsInArchive, ModPath, mapping.Key);
var target = Path.Combine(gameDLCPath, mapping.Value);
//get list of all normal files we will install
var allSourceDirFiles = FilesystemInterposer.DirectoryGetFiles(source, "*", SearchOption.AllDirectories, Archive).Select(x => x.Substring(ModPath.Length).TrimStart('\\')).ToList();
unpackedJobInstallationMapping[job].dlcFoldersBeingInstalled.Add(target);
//loop over every file
foreach (var sourceFile in allSourceDirFiles)
{
//Check against alt files
bool altApplied = false;
foreach (var altFile in alternateFiles)
{
if (altFile.ModFile.Equals(sourceFile, StringComparison.InvariantCultureIgnoreCase))
{
//Alt applies to this file
switch (altFile.Operation)
{
case AlternateFile.AltFileOperation.OP_NOINSTALL:
CLog.Information($@"Not installing {sourceFile} for Alternate File {altFile.FriendlyName} due to operation OP_NOINSTALL", Settings.LogModInstallation);
//we simply don't map as we just do a continue below.
altApplied = true;
break;
case AlternateFile.AltFileOperation.OP_SUBSTITUTE:
CLog.Information($@"Repointing {sourceFile} to {altFile.AltFile} for Alternate File {altFile.FriendlyName} due to operation OP_SUBSTITUTE", Settings.LogModInstallation);
if (job.JobDirectory != null && altFile.AltFile.StartsWith((string)job.JobDirectory))
{
installationMapping[sourceFile] = new InstallSourceFile(altFile.AltFile.Substring(job.JobDirectory.Length).TrimStart('/', '\\'))
{
AltApplied = true,
IsFullRelativeFilePath = true
}; //use alternate file as key instead
}
else
{
installationMapping[sourceFile] = new InstallSourceFile(altFile.AltFile)
{
AltApplied = true, IsFullRelativeFilePath = true
}; //use alternate file as key instead
}
altApplied = true;
break;
case AlternateFile.AltFileOperation.OP_INSTALL:
//same logic as substitute, just different logging.
CLog.Information($@"Adding {sourceFile} to install (from {altFile.AltFile}) as part of Alternate File {altFile.FriendlyName} due to operation OP_INSTALL", Settings.LogModInstallation);
if (job.JobDirectory != null && altFile.AltFile.StartsWith((string)job.JobDirectory))
{
installationMapping[sourceFile] = new InstallSourceFile(altFile.AltFile.Substring(job.JobDirectory.Length).TrimStart('/', '\\'))
{
AltApplied = true,
IsFullRelativeFilePath = true
}; //use alternate file as key instead
}
else
{
installationMapping[sourceFile] = new InstallSourceFile(altFile.AltFile)
{
AltApplied = true, IsFullRelativeFilePath = true
}; //use alternate file as key instead
}
altApplied = true;
break;
}
break;
}
}
if (altApplied)
{
continue; //no further processing for file
}
var relativeDestStartIndex = sourceFile.IndexOf(mapping.Value);
string destPath = sourceFile.Substring(relativeDestStartIndex);
installationMapping[destPath] = new InstallSourceFile(sourceFile); //destination is mapped to source file that will replace it.
}
foreach (var altdlc in alternateDLC)
{
if (altdlc.Operation == AlternateDLC.AltDLCOperation.OP_ADD_FOLDERFILES_TO_CUSTOMDLC)
{
string alternatePathRoot = FilesystemInterposer.PathCombine(IsInArchive, ModPath, altdlc.AlternateDLCFolder);
var filesToAdd = FilesystemInterposer.DirectoryGetFiles(alternatePathRoot, "*", SearchOption.AllDirectories, Archive).Select(x => x.Substring(ModPath.Length).TrimStart('\\')).ToList();
foreach (var fileToAdd in filesToAdd)
{
var destFile = Path.Combine(altdlc.DestinationDLCFolder, fileToAdd.Substring(altdlc.AlternateDLCFolder.Length).TrimStart('\\', '/'));
CLog.Information($@"Adding extra CustomDLC file ({fileToAdd} => {destFile}) due to Alternate DLC {altdlc.FriendlyName}'s {altdlc.Operation}", Settings.LogModInstallation);
installationMapping[destFile] = new InstallSourceFile(fileToAdd)
{
AltApplied = true
};
}
}
else if (altdlc.Operation == AlternateDLC.AltDLCOperation.OP_ADD_MULTILISTFILES_TO_CUSTOMDLC)
{
string alternatePathRoot = FilesystemInterposer.PathCombine(IsInArchive, ModPath, altdlc.MultiListRootPath);
foreach (var fileToAdd in altdlc.MultiListSourceFiles)
{
var sourceFile = FilesystemInterposer.PathCombine(IsInArchive, alternatePathRoot, fileToAdd).Substring(ModPath.Length).TrimStart('\\');
var destFile = Path.Combine(altdlc.DestinationDLCFolder, fileToAdd.TrimStart('\\', '/'));
CLog.Information($@"Adding extra CustomDLC file (MultiList) ({sourceFile} => {destFile}) due to Alternate DLC {altdlc.FriendlyName}'s {altdlc.Operation}", Settings.LogModInstallation);
installationMapping[destFile] = new InstallSourceFile(sourceFile)
{
AltApplied = true
};
}
}
}
// Process altfile removal of multilist, since it should be done last
var fileRemoveAltFiles = Enumerable.Where <AlternateFile>(job.AlternateFiles, x => x.IsSelected && x.Operation == AlternateFile.AltFileOperation.OP_NOINSTALL_MULTILISTFILES);
foreach (var altFile in fileRemoveAltFiles)
{
foreach (var multifile in altFile.MultiListSourceFiles)
{
CLog.Information($@"Attempting to remove multilist file {multifile} from install (from {altFile.MultiListTargetPath}) as part of Alternate File {altFile.FriendlyName} due to operation OP_NOINSTALL_MULTILISTFILES", Settings.LogModInstallation);
string relativeSourcePath = altFile.MultiListRootPath + '\\' + multifile;
var targetPath = altFile.MultiListTargetPath + '\\' + multifile;
if (installationMapping.Remove(targetPath))
{
CLog.Information($@" > Removed multilist file {targetPath} from installation",
Settings.LogModInstallation);
}
}
}
}
#endregion
}
else if (job.Header == ModJob.JobHeader.LOCALIZATION)
{
#region Installation: LOCALIZATION
var installationMapping = new CaseInsensitiveDictionary <InstallSourceFile>();
unpackedJobInstallationMapping[job] = (installationMapping, new List <string>());
buildInstallationQueue(job, installationMapping, false);
#endregion
}
else if (job.Header == ModJob.JobHeader.BASEGAME || job.Header == ModJob.JobHeader.BALANCE_CHANGES || job.Header == ModJob.JobHeader.ME1_CONFIG)
{
#region Installation: BASEGAME, BALANCE CHANGES, ME1 CONFIG
var installationMapping = new CaseInsensitiveDictionary <InstallSourceFile>();
unpackedJobInstallationMapping[job] = (installationMapping, new List <string>());
buildInstallationQueue(job, installationMapping, false);
#endregion
}
else if (Game == MEGame.ME3 && ModJob.ME3SupportedNonCustomDLCJobHeaders.Contains(job.Header)) //previous else if will catch BASEGAME
{
#region Installation: DLC Unpacked and SFAR (ME3 ONLY)
if (M3Directories.IsOfficialDLCInstalled(job.Header, gameTarget))
{
string sfarPath = job.Header == ModJob.JobHeader.TESTPATCH ? M3Directories.GetTestPatchSFARPath(gameTarget) : Path.Combine(gameDLCPath, ModJob.GetHeadersToDLCNamesMap(MEGame.ME3)[job.Header], @"CookedPCConsole", @"Default.sfar");
if (File.Exists(sfarPath))
{
var installationMapping = new CaseInsensitiveDictionary <InstallSourceFile>();
if (new FileInfo(sfarPath).Length == 32)
{
//Unpacked
unpackedJobInstallationMapping[job] = (installationMapping, new List <string>());
buildInstallationQueue(job, installationMapping, false);
}
else
{
//Packed
//unpackedJobInstallationMapping[job] = installationMapping;
buildInstallationQueue(job, installationMapping, true);
sfarInstallationJobs.Add((job, sfarPath, installationMapping));
}
}
}
else
{
Log.Warning($@"DLC not installed, skipping: {job.Header}");
}
#endregion
}
else if (Game == MEGame.ME2 || Game == MEGame.ME1)
{
#region Installation: DLC Unpacked (ME1/ME2 ONLY)
//Unpacked
if (M3Directories.IsOfficialDLCInstalled(job.Header, gameTarget))
{
var installationMapping = new CaseInsensitiveDictionary <InstallSourceFile>();
unpackedJobInstallationMapping[job] = (installationMapping, new List <string>());
buildInstallationQueue(job, installationMapping, false);
}
else
{
Log.Warning($@"DLC not installed, skipping: {job.Header}");
}
#endregion
}
else
{
//?? Header
throw new Exception(@"Unsupported installation job header! " + job.Header);
}
}
return(unpackedJobInstallationMapping, sfarInstallationJobs);
}
/// <summary>
/// Gets all files referenced by this mod. This does not include moddessc.ini by default
/// </summary>
/// <param name="includeModdesc">Include moddesc.ini in the results</param>
/// <param name="archive">Archive, if this mod is in an archive.</param>
/// <returns></returns>
public List<string> GetAllRelativeReferences(bool includeModdesc = false, SevenZipExtractor archive = null)
{
var references = new List<string>();
//references.Add("moddesc.ini"); //Moddesc is implicitly referenced by the mod.
//Replace or Add references
foreach (var job in InstallationJobs)
{
foreach (var jobFile in job.FilesToInstall.Values)
{
if (job.JobDirectory == @"." || job.JobDirectory == null)
{
references.Add(jobFile);
}
else
{
references.Add(job.JobDirectory + @"\" + jobFile);
}
}
foreach (var dlc in job.AlternateDLCs)
{
if (dlc.HasRelativeFiles())
{
if (dlc.AlternateDLCFolder != null)
{
var files = FilesystemInterposer.DirectoryGetFiles(FilesystemInterposer.PathCombine(IsInArchive, ModPath, dlc.AlternateDLCFolder), "*", SearchOption.AllDirectories, archive).Select(x => (IsInArchive && ModPath.Length == 0) ? x : x.Substring(ModPath.Length + 1)).ToList();
references.AddRange(files);
}
else if (dlc.MultiListSourceFiles != null)
{
foreach (var mf in dlc.MultiListSourceFiles)
{
var relpath = Path.Combine(ModPath, dlc.MultiListRootPath, mf).Substring(ModPath.Length > 0 ? ModPath.Length + 1 : 0);
references.Add(relpath);
}
}
}
// Add the referenced image asset
if (dlc.ImageAssetName != null)
{
references.Add(FilesystemInterposer.PathCombine(IsInArchive, ModImageAssetsPath, dlc.ImageAssetName).Substring(ModPath.Length + (ModPath.Length > 1 ? 1 : 0)));
}
}
foreach (var file in job.AlternateFiles)
{
if (file.HasRelativeFile())
{
if (file.AltFile != null)
{
//Commented out: AltFile should be direct path to file from mod root, we should only put in relative path
//if (IsInArchive)
//{
// references.Add(FilesystemInterposer.PathCombine(true, ModPath, file.AltFile));
//}
//else
//{
references.Add(file.AltFile);
//}
}
else if (file.MultiListSourceFiles != null)
{
foreach (var mf in file.MultiListSourceFiles)
{
var relPath = FilesystemInterposer.PathCombine(IsInArchive, ModPath, file.MultiListRootPath, mf);
//Should this be different from above AltFile?
if (IsInArchive)
{
references.Add(relPath.Substring(ModPath.Length + (ModPath.Length > 1 ? 1 : 0))); //substring so its relative to the path of the mod in the archive
}
else
{
references.Add(relPath.Substring(ModPath.Length + 1)); //chop off the root path of the moddesc.ini
}
}
}
}
// Add the referenced image asset
if (file.ImageAssetName != null)
{
references.Add(FilesystemInterposer.PathCombine(IsInArchive, ModImageAssetsPath, file.ImageAssetName).Substring(ModPath.Length + (ModPath.Length > 1 ? 1 : 0)));
}
}
foreach (var customDLCmapping in job.CustomDLCFolderMapping)
{
references.AddRange(FilesystemInterposer.DirectoryGetFiles(FilesystemInterposer.PathCombine(IsInArchive, ModPath, customDLCmapping.Key), "*", SearchOption.AllDirectories, archive).Select(x => (IsInArchive && ModPath.Length == 0) ? x : x.Substring(ModPath.Length + 1)).ToList());
}
}
references.AddRange(AdditionalDeploymentFiles);
foreach (var additionalDeploymentDir in AdditionalDeploymentFolders)
{
references.AddRange(FilesystemInterposer.DirectoryGetFiles(FilesystemInterposer.PathCombine(IsInArchive, ModPath, additionalDeploymentDir), "*", SearchOption.AllDirectories, archive).Select(x => (IsInArchive && ModPath.Length == 0) ? x : x.Substring(ModPath.Length + 1)).ToList());
}
// Banner Image
if (!string.IsNullOrWhiteSpace(BannerImageName))
{
references.Add(FilesystemInterposer.PathCombine(IsInArchive, Mod.ModImageAssetFolderName, BannerImageName));
}
if (includeModdesc && GetJob(ModJob.JobHeader.ME2_RCWMOD) == null)
{
references.Add(ModDescPath.Substring(ModPath.Length).TrimStart('/', '\\'));
//references.Add(ModDescPath.TrimStart('/', '\\'));
}
return references.Distinct(StringComparer.InvariantCultureIgnoreCase).ToList();
}