/// <inheritdoc />
public int UpgradeProject(string bstrFileName, uint fUpgradeFlag, string bstrCopyLocation,
out string pbstrUpgradedFullyQualifiedFileName, IVsUpgradeLogger pLogger, out int pUpgradeRequired,
out Guid pguidNewProjectFactory)
{
uint verdict, moreInfo, ignored;
string[] files = new string[1] {
bstrFileName
};
string projectName = Path.GetFileNameWithoutExtension(bstrFileName);
bool continueUpgrade = false;
pbstrUpgradedFullyQualifiedFileName = bstrFileName;
// Be sure we need an upgrade
this.UpgradeProject_CheckOnly(bstrFileName, pLogger, out pUpgradeRequired, out pguidNewProjectFactory, out ignored);
if (pUpgradeRequired == 0)
{
return(VSConstants.S_OK);
}
// See if the file is editable
IVsQueryEditQuerySave2 qes = Utility.GetServiceFromPackage <IVsQueryEditQuerySave2, SVsQueryEditQuerySave>(true);
ErrorHandler.ThrowOnFailure(qes.QueryEditFiles((uint)tagVSQueryEditFlags.QEF_ReportOnly |
(uint)__VSQueryEditFlags2.QEF_AllowUnopenedProjects, 1, files, null, null, out verdict,
out moreInfo));
if (verdict == (uint)tagVSQueryEditResult.QER_EditOK)
{
continueUpgrade = true;
}
if (verdict == (uint)tagVSQueryEditResult.QER_EditNotOK)
{
pLogger.LogMessage((uint)__VSUL_ERRORLEVEL.VSUL_INFORMATIONAL, projectName, bstrFileName,
"The project file is read-only. An attempt will be made to check it out if under source control.");
if ((moreInfo & (uint)tagVSQueryEditResultFlags.QER_ReadOnlyUnderScc) != 0)
{
ErrorHandler.ThrowOnFailure(qes.QueryEditFiles(
(uint)tagVSQueryEditFlags.QEF_DisallowInMemoryEdits |
(uint)__VSQueryEditFlags2.QEF_AllowUnopenedProjects |
(uint)tagVSQueryEditFlags.QEF_ForceEdit_NoPrompting, 1, files, null, null,
out verdict, out moreInfo));
if (verdict == (uint)tagVSQueryEditResult.QER_EditOK)
{
continueUpgrade = true;
}
}
if (continueUpgrade)
{
pLogger.LogMessage((uint)__VSUL_ERRORLEVEL.VSUL_INFORMATIONAL, projectName, bstrFileName,
"The project file was successfully checked out.");
}
else
{
pLogger.LogMessage((uint)__VSUL_ERRORLEVEL.VSUL_ERROR, projectName, bstrFileName,
"Unable to check project out of source control. Upgrade failed.");
throw new InvalidOperationException("Unable to check out project file for upgrade: " + bstrFileName);
}
}
// If file was modified during the checkout, confirm that it still needs upgrading
if ((moreInfo & (uint)tagVSQueryEditResultFlags.QER_MaybeChanged) != 0)
{
this.UpgradeProject_CheckOnly(bstrFileName, pLogger, out pUpgradeRequired, out pguidNewProjectFactory, out ignored);
if (pUpgradeRequired == 0)
{
if (pLogger != null)
{
pLogger.LogMessage((uint)__VSUL_ERRORLEVEL.VSUL_INFORMATIONAL, projectName, bstrFileName,
"The project file was checked out and is already up to date. No upgrade needed.");
}
return(VSConstants.S_OK);
}
}
if (continueUpgrade)
{
// Make a backup?
if (fUpgradeFlag == PUVFF_SXSBACKUP)
{
File.Copy(bstrFileName, bstrFileName + ".backup", true);
}
// The SancastleProject class contains all the code needed to update the project so all we need
// to do is load a copy and force it to save a new copy.
using (SandcastleProject p = new SandcastleProject(bstrFileName, true))
{
p.UpgradeProjectProperties();
p.SaveProject(bstrFileName);
}
pLogger.LogMessage((uint)__VSUL_ERRORLEVEL.VSUL_INFORMATIONAL, projectName, bstrFileName,
"The project file was upgraded successfully.");
}
return(VSConstants.S_OK);
}
