/// <summary>
/// This does the moving of files and log alteration.
/// </summary>
/// <returns>
/// <lang langref="true" /> if the script work was completed successfully and needs to
/// be committed; <lang langref="false" /> otherwise.
/// </returns>
/// <exception cref="InvalidOperationException">
/// Thrown if m_strFile or m_lstOrderedMods are
/// <lang langref="null" />.
/// </exception>
/// <seealso cref="ModInstallScript.DoScript" />
protected override bool DoScript()
{
if ((m_strFile == null) || (m_lstOrderedMods == null))
{
throw new InvalidOperationException(
"The File and OrderedMods properties must be set before calling Run(); or Run(string, IList<string>) can be used instead.");
}
TransactionalFileManager.Snapshot(InstallLog.Current.InstallLogPath);
var strOldOwner = InstallLog.Current.GetCurrentFileOwnerKey(m_strFile);
InstallLog.Current.SetInstallingModsOrder(m_strFile, m_lstOrderedMods);
var strNewOwner = InstallLog.Current.GetCurrentFileOwnerKey(m_strFile);
if (!strNewOwner.Equals(strOldOwner))
{
var strDataPath = Path.Combine(Program.GameMode.PluginsPath, m_strFile);
strDataPath = Directory.GetFiles(Path.GetDirectoryName(strDataPath), Path.GetFileName(strDataPath))[0];
var strDirectory = Path.GetDirectoryName(m_strFile);
var strBackupPath = Path.Combine(Program.GameMode.OverwriteDirectory, strDirectory);
//the old backup file is becoming the new file
var strOldBackupFile = strNewOwner + "_" + Path.GetFileName(strDataPath);
//the old owner is becoming the new backup file
var strNewBackupFile = strOldOwner + "_" + Path.GetFileName(strDataPath);
var strNewBackupPath = Path.Combine(strBackupPath, strNewBackupFile);
var strOldBackupPath = Path.Combine(strBackupPath, strOldBackupFile);
if (!TransactionalFileManager.FileExists(strOldBackupPath))
{
m_strFailMessage = "The version of the file for " + InstallLog.Current.GetModName(strNewOwner) +
" does not exist. This is likely because files in the data folder have been altered manually.";
return(false);
}
TransactionalFileManager.Copy(strDataPath, strNewBackupPath, true);
var strOldBackupFileName = Path.GetFileName(Directory.GetFiles(strBackupPath, strOldBackupFile)[0]);
var strCasedFileName = strOldBackupFileName.Substring(strOldBackupFileName.IndexOf('_') + 1);
var strNewDataPath = Path.Combine(Path.GetDirectoryName(strDataPath), strCasedFileName);
TransactionalFileManager.Delete(strNewDataPath);
TransactionalFileManager.Move(strOldBackupPath, strNewDataPath);
}
return(true);
}
/// <summary>
/// Writes the file represented by the given byte array to the given path.
/// </summary>
/// <remarks>
/// This method writes the given data as a file at the given path. If the file
/// already exists the user is prompted to overwrite the file.
/// </remarks>
/// <param name="p_strPath">The path where the file is to be created.</param>
/// <param name="p_bteData">The data that is to make up the file.</param>
/// <returns><c>true</c> if the file was written; <c>false</c> if the user chose
/// not to overwrite an existing file.</returns>
/// <exception cref="IllegalFilePathException">Thrown if <paramref name="p_strPath"/> is
/// not safe.</exception>
public virtual bool GenerateDataFile(string p_strPath, byte[] p_bteData)
{
DataFileUtility.AssertFilePathIsSafe(p_strPath);
string[] components = p_strPath.Split(Path.DirectorySeparatorChar);
p_strPath = string.Join("" + Path.DirectorySeparatorChar, components.Skip(1).Take(components.Length - 1).ToArray());
string strInstallFilePath = installPath(p_strPath);
//string strInstallFilePath = null;
//strInstallFilePath = Path.Combine(GameModeInfo.InstallationPath, p_strPath);
string installDirPath = Path.GetDirectoryName(strInstallFilePath);
FileInfo Info = new FileInfo(strInstallFilePath);
if (!Directory.Exists(installDirPath))
{
CreateDirectory(installDirPath);
}
else
{
if (!TestDoOverwrite(p_strPath))
{
return(false);
}
if (File.Exists(strInstallFilePath))
{
if (Info.IsReadOnly == true)
{
File.SetAttributes(strInstallFilePath, File.GetAttributes(strInstallFilePath) & ~FileAttributes.ReadOnly);
}
string strInstallDirectory = Path.GetDirectoryName(p_strPath);
string strBackupDirectory = Path.Combine(GameModeInfo.OverwriteDirectory, strInstallDirectory);
string strOldModKey = InstallLog.GetCurrentFileOwnerKey(p_strPath);
if (strOldModKey == null)
{
InstallLog.LogOriginalDataFile(p_strPath);
strOldModKey = InstallLog.OriginalValuesKey;
}
string strInstallingModKey = InstallLog.GetModKey(Mod);
//if this mod has installed this file already we just replace it and don't
// need to back it up.
if (!strOldModKey.Equals(strInstallingModKey))
{
//back up the current version of the file if the current mod
// didn't install it
if (!Directory.Exists(strBackupDirectory))
{
CreateDirectory(strBackupDirectory);
}
//we get the file name this way in order to preserve the file name's case
string strFile = Path.GetFileName(Directory.GetFiles(installDirPath, Path.GetFileName(strInstallFilePath))[0]);
strFile = strOldModKey + "_" + strFile;
string strBackupFilePath = Path.Combine(strBackupDirectory, strFile);
Info = new FileInfo(strBackupFilePath);
if ((Info.IsReadOnly == true) && (File.Exists(strBackupFilePath)))
{
File.SetAttributes(strBackupFilePath, File.GetAttributes(strBackupFilePath) & ~FileAttributes.ReadOnly);
}
TransactionalFileManager.Copy(strInstallFilePath, strBackupFilePath, true);
}
TransactionalFileManager.Delete(strInstallFilePath);
}
}
TransactionalFileManager.WriteAllBytes(strInstallFilePath, p_bteData);
// Checks whether the file is a gamebryo plugin
if (IsPlugin)
{
if (PluginManager.IsActivatiblePluginFile(strInstallFilePath))
{
PluginManager.AddPlugin(strInstallFilePath);
}
}
InstallLog.AddDataFile(Mod, p_strPath);
return(IsPlugin);
}
/// <summary>
/// Uninstalls the specified file.
/// </summary>
/// <remarks>
/// If the mod we are uninstalling doesn't own the file, then its version is removed
/// from the overwrites directory. If the mod we are uninstalling overwrote a file when it
/// installed the specified file, then the overwritten file is restored. Otherwise
/// the file is deleted.
/// </remarks>
/// <param name="p_strPath">The path to the file that is to be uninstalled.</param>
/// <param name="p_booSecondaryInstallPath">Whether to use the secondary install path.</param>
public void UninstallDataFile(string p_strPath, bool p_booSecondaryInstallPath)
{
string strInstallFilePath = String.Empty;
DataFileUtility.AssertFilePathIsSafe(p_strPath);
string strUninstallingModKey = InstallLog.GetModKey(Mod);
if (p_booSecondaryInstallPath && !(String.IsNullOrEmpty(GameModeInfo.SecondaryInstallationPath)))
{
strInstallFilePath = Path.Combine(GameModeInfo.SecondaryInstallationPath, p_strPath);
}
else
{
strInstallFilePath = Path.Combine(GameModeInfo.InstallationPath ?? "", p_strPath);
}
string strBackupDirectory = Path.Combine(GameModeInfo.OverwriteDirectory, Path.GetDirectoryName(p_strPath));
string strFile;
string strRestoreFromPath = string.Empty;
bool booRestoreFile = false;
FileInfo fiInfo = null;
if (File.Exists(strInstallFilePath))
{
string strCurrentOwnerKey = InstallLog.GetCurrentFileOwnerKey(p_strPath);
//if we didn't install the file, then leave it alone
if (strUninstallingModKey.Equals(strCurrentOwnerKey))
{
//if we did install the file, replace it with the file we overwrote
// when we installed the file
// if we didn't overwrite a file, then just delete the current file
fiInfo = new FileInfo(strInstallFilePath);
if (fiInfo.IsReadOnly)
{
m_lstErrorMods.Add(strInstallFilePath);
}
else
{
TransactionalFileManager.Delete(strInstallFilePath);
}
string strPreviousOwnerKey = InstallLog.GetPreviousFileOwnerKey(p_strPath);
if (strPreviousOwnerKey != null)
{
strFile = strPreviousOwnerKey + "_" + Path.GetFileName(p_strPath);
strRestoreFromPath = Path.Combine(strBackupDirectory, strFile);
if (File.Exists(strRestoreFromPath))
{
booRestoreFile = true;
}
}
if (IsPlugin)
{
if ((PluginManager.IsActivatiblePluginFile(strInstallFilePath)) && !booRestoreFile)
{
PluginManager.RemovePlugin(strInstallFilePath);
}
}
if (booRestoreFile)
{
//we get the file name this way in order to preserve the file name's case
string strBackupFileName = Path.GetFileName(Directory.GetFiles(Path.GetDirectoryName(strRestoreFromPath), Path.GetFileName(strRestoreFromPath))[0]);
strBackupFileName = strBackupFileName.Substring(strBackupFileName.IndexOf('_') + 1);
string strNewDataPath = Path.Combine(Path.GetDirectoryName(strInstallFilePath), strBackupFileName);
fiInfo = new FileInfo(strRestoreFromPath);
try
{
TransactionalFileManager.Copy(strRestoreFromPath, strNewDataPath, true);
}
catch { }
if (fiInfo.IsReadOnly)
{
m_lstErrorMods.Add(strInstallFilePath);
}
else
{
TransactionalFileManager.Delete(strRestoreFromPath);
}
}
//remove any empty directories from the data folder we may have created
TrimEmptyDirectories(Path.GetDirectoryName(strInstallFilePath), GameModeInfo.InstallationPath);
}
}
//remove our version of the file from the backup directory
string strOverwritePath = Path.Combine(strBackupDirectory, strUninstallingModKey + "_" + Path.GetFileName(p_strPath));
if (File.Exists(strOverwritePath))
{
fiInfo = new FileInfo(strOverwritePath);
if (((fiInfo.Attributes | FileAttributes.Hidden) == fiInfo.Attributes) || (fiInfo.IsReadOnly))
{
m_lstErrorMods.Add(strInstallFilePath);
}
else
{
TransactionalFileManager.Delete(strOverwritePath);
}
}
//remove any empty directories from the overwrite folder we may have created
string strStopDirectory = GameModeInfo.OverwriteDirectory;
string strFileName = Path.GetFileName(strOverwritePath);
TrimEmptyDirectories(strOverwritePath.Replace(strFileName, ""), strStopDirectory);
InstallLog.RemoveDataFile(Mod, p_strPath);
}
/// <summary>
/// Writes the file represented by the given byte array to the given path.
/// </summary>
/// <remarks>
/// This method writes the given data as a file at the given path. If the file
/// already exists the user is prompted to overwrite the file.
/// </remarks>
/// <param name="p_strPath">The path where the file is to be created.</param>
/// <param name="p_bteData">The data that is to make up the file.</param>
/// <param name="p_booSecondaryInstallPath">Whether to use the secondary install path.</param>
/// <returns><c>true</c> if the file was written; <c>false</c> if the user chose
/// not to overwrite an existing file.</returns>
/// <exception cref="IllegalFilePathException">Thrown if <paramref name="p_strPath"/> is
/// not safe.</exception>
public virtual bool GenerateDataFile(string p_strPath, byte[] p_bteData, bool p_booSecondaryInstallPath)
{
DataFileUtility.AssertFilePathIsSafe(p_strPath);
string strInstallFilePath = String.Empty;
if (p_booSecondaryInstallPath && !(String.IsNullOrEmpty(GameModeInfo.SecondaryInstallationPath)))
{
strInstallFilePath = Path.Combine(GameModeInfo.SecondaryInstallationPath, p_strPath);
}
else
{
strInstallFilePath = Path.Combine(GameModeInfo.InstallationPath, p_strPath);
}
FileInfo Info = new FileInfo(strInstallFilePath);
if (!Directory.Exists(Path.GetDirectoryName(strInstallFilePath)))
{
TransactionalFileManager.CreateDirectory(Path.GetDirectoryName(strInstallFilePath));
}
else
{
if (!TestDoOverwrite(p_strPath))
{
return(false);
}
if (File.Exists(strInstallFilePath))
{
if (Info.IsReadOnly == true)
{
File.SetAttributes(strInstallFilePath, File.GetAttributes(strInstallFilePath) & ~FileAttributes.ReadOnly);
}
string strInstallDirectory = Path.GetDirectoryName(p_strPath);
string strBackupDirectory = Path.Combine(GameModeInfo.OverwriteDirectory, strInstallDirectory);
string strOldModKey = InstallLog.GetCurrentFileOwnerKey(p_strPath);
if (strOldModKey == null)
{
InstallLog.LogOriginalDataFile(p_strPath);
strOldModKey = InstallLog.OriginalValuesKey;
}
string strInstallingModKey = InstallLog.GetModKey(Mod);
//if this mod has installed this file already we just replace it and don't
// need to back it up.
if (!strOldModKey.Equals(strInstallingModKey))
{
//back up the current version of the file if the current mod
// didn't install it
if (!Directory.Exists(strBackupDirectory))
{
TransactionalFileManager.CreateDirectory(strBackupDirectory);
}
//we get the file name this way in order to preserve the file name's case
string strFile = Path.GetFileName(Directory.GetFiles(Path.GetDirectoryName(strInstallFilePath), Path.GetFileName(strInstallFilePath))[0]);
strFile = strOldModKey + "_" + strFile;
string strBackupFilePath = Path.Combine(strBackupDirectory, strFile);
Info = new FileInfo(strBackupFilePath);
if ((Info.IsReadOnly == true) && (File.Exists(strBackupFilePath)))
{
File.SetAttributes(strBackupFilePath, File.GetAttributes(strBackupFilePath) & ~FileAttributes.ReadOnly);
}
TransactionalFileManager.Copy(strInstallFilePath, strBackupFilePath, true);
}
TransactionalFileManager.Delete(strInstallFilePath);
}
}
TransactionalFileManager.WriteAllBytes(strInstallFilePath, p_bteData);
// Checks whether the file is a gamebryo plugin
if (IsPlugin)
{
if (PluginManager.IsActivatiblePluginFile(strInstallFilePath))
{
if (!PluginManager.CanActivatePlugins())
{
string strTooManyPlugins = String.Format("The requested change to the active plugins list would result in over {0} plugins being active.", PluginManager.MaxAllowedActivePluginsCount);
strTooManyPlugins += Environment.NewLine + String.Format("The current game doesn't support more than {0} active plugins, you need to disable at least one plugin to continue.", PluginManager.MaxAllowedActivePluginsCount);
strTooManyPlugins += Environment.NewLine + Environment.NewLine + String.Format("NOTE: This is a game engine limitation.") + Environment.NewLine;
throw new Exception(strTooManyPlugins);
}
PluginManager.AddPlugin(strInstallFilePath);
}
}
InstallLog.AddDataFile(Mod, p_strPath);
return(IsPlugin);
}
/// <summary>
/// Installs the specified file from the Mod to the file system.
/// </summary>
/// <param name="p_strModFilePath">The path of the file in the Mod to install.</param>
/// <param name="p_strInstallPath">The path on the file system where the file is to be installed.</param>
/// <returns><c>true</c> if the file was written; <c>false</c> if the user chose
/// not to overwrite an existing file.</returns>
public bool InstallFileFromMod(string p_strModFilePath, string p_strInstallPath, bool p_booSecondaryInstallPath)
{
Console.WriteLine("install " + p_strModFilePath + " to " + p_strInstallPath);
string destinationPath = installPath(p_strInstallPath, p_booSecondaryInstallPath);
if (!Directory.Exists(Path.GetDirectoryName(destinationPath)))
{
TransactionalFileManager.CreateDirectory(Path.GetDirectoryName(destinationPath));
}
else
{
if (!TestDoOverwrite(p_strInstallPath))
{
return(false);
}
if (File.Exists(destinationPath))
{
FileInfo Info = new FileInfo(destinationPath);
if (Info.IsReadOnly == true)
{
File.SetAttributes(destinationPath, File.GetAttributes(destinationPath) & ~FileAttributes.ReadOnly);
}
string strInstallDirectory = Path.GetDirectoryName(p_strInstallPath);
string strBackupDirectory = Path.Combine(GameModeInfo.OverwriteDirectory, strInstallDirectory);
string strOldModKey = InstallLog.GetCurrentFileOwnerKey(p_strInstallPath);
if (strOldModKey == null)
{
InstallLog.LogOriginalDataFile(p_strInstallPath);
strOldModKey = InstallLog.OriginalValuesKey;
}
string strInstallingModKey = InstallLog.GetModKey(Mod);
//if this mod has installed this file already we just replace it and don't
// need to back it up.
if (!strOldModKey.Equals(strInstallingModKey))
{
//back up the current version of the file if the current mod
// didn't install it
if (!Directory.Exists(strBackupDirectory))
{
TransactionalFileManager.CreateDirectory(strBackupDirectory);
}
//we get the file name this way in order to preserve the file name's case
string strFile = Path.GetFileName(Directory.GetFiles(Path.GetDirectoryName(destinationPath), Path.GetFileName(destinationPath))[0]);
strFile = strOldModKey + "_" + strFile;
string strBackupFilePath = Path.Combine(strBackupDirectory, strFile);
Info = new FileInfo(strBackupFilePath);
if ((Info.IsReadOnly == true) && (File.Exists(strBackupFilePath)))
{
File.SetAttributes(strBackupFilePath, File.GetAttributes(strBackupFilePath) & ~FileAttributes.ReadOnly);
}
TransactionalFileManager.Copy(destinationPath, strBackupFilePath, true);
}
TransactionalFileManager.Delete(destinationPath);
}
}
try {
using (FileStream stream = File.Create(destinationPath))
{
Mod.ExtractFileTo(p_strModFilePath, stream);
}
}
catch (FileNotFoundException e)
{
MessageBox.Show("File " + p_strModFilePath + " couldn't be extracted.\n" +
"This probably means the mod is broken though you may still get partial functionality.\n" +
"Please inform the mod author.\n" +
"Detailed Error: " + e.Message, "File not found in FOMod", MessageBoxButtons.OK, MessageBoxIcon.Error);
File.Delete(destinationPath);
throw;
}
catch (Exception ex)
{
MessageBox.Show("Exception: " + ex.ToString());
throw;
}
// Checks whether the file is a gamebryo plugin
if (IsPlugin)
{
if (PluginManager.IsActivatiblePluginFile(destinationPath))
{
PluginManager.AddPlugin(destinationPath);
}
}
InstallLog.AddDataFile(Mod, p_strInstallPath);
return(IsPlugin);
}