/// <summary>
/// Creates a new row in the table.
/// </summary>
/// <param name="sourceLineNumbers">Original source lines for this row.</param>
/// <param name="add">Specifies whether to only create the row or add it to the table automatically.</param>
/// <returns>Row created in table.</returns>
public Row CreateRow(SourceLineNumber sourceLineNumbers, bool add = true)
{
Row row;
switch (this.Name)
{
case "BBControl":
row = new BBControlRow(sourceLineNumbers, this);
break;
case "WixBundlePackage":
row = new WixBundlePackageRow(sourceLineNumbers, this);
break;
case "WixBundleExePackage":
row = new WixBundleExePackageRow(sourceLineNumbers, this);
break;
case "WixBundleMsiPackage":
row = new WixBundleMsiPackageRow(sourceLineNumbers, this);
break;
case "WixBundleMspPackage":
row = new WixBundleMspPackageRow(sourceLineNumbers, this);
break;
case "WixBundleMsuPackage":
row = new WixBundleMsuPackageRow(sourceLineNumbers, this);
break;
case "Component":
row = new ComponentRow(sourceLineNumbers, this);
break;
case "WixBundleContainer":
row = new WixBundleContainerRow(sourceLineNumbers, this);
break;
case "Control":
row = new ControlRow(sourceLineNumbers, this);
break;
case "File":
row = new FileRow(sourceLineNumbers, this);
break;
case "WixBundleMsiFeature":
row = new WixBundleMsiFeatureRow(sourceLineNumbers, this);
break;
case "WixBundleMsiProperty":
row = new WixBundleMsiPropertyRow(sourceLineNumbers, this);
break;
case "Media":
row = new MediaRow(sourceLineNumbers, this);
break;
case "WixBundlePayload":
row = new WixBundlePayloadRow(sourceLineNumbers, this);
break;
case "Property":
row = new PropertyRow(sourceLineNumbers, this);
break;
case "WixRelatedBundle":
row = new WixRelatedBundleRow(sourceLineNumbers, this);
break;
case "WixBundleRelatedPackage":
row = new WixBundleRelatedPackageRow(sourceLineNumbers, this);
break;
case "WixBundleRollbackBoundary":
row = new WixBundleRollbackBoundaryRow(sourceLineNumbers, this);
break;
case "Upgrade":
row = new UpgradeRow(sourceLineNumbers, this);
break;
case "WixBundleVariable":
row = new WixBundleVariableRow(sourceLineNumbers, this);
break;
case "WixAction":
row = new WixActionRow(sourceLineNumbers, this);
break;
case "WixApprovedExeForElevation":
row = new WixApprovedExeForElevationRow(sourceLineNumbers, this);
break;
case "WixBundle":
row = new WixBundleRow(sourceLineNumbers, this);
break;
case "WixBundlePackageExitCode":
row = new WixBundlePackageExitCodeRow(sourceLineNumbers, this);
break;
case "WixBundlePatchTargetCode":
row = new WixBundlePatchTargetCodeRow(sourceLineNumbers, this);
break;
case "WixBundleSlipstreamMsp":
row = new WixBundleSlipstreamMspRow(sourceLineNumbers, this);
break;
case "WixBundleUpdate":
row = new WixBundleUpdateRow(sourceLineNumbers, this);
break;
case "WixBundleCatalog":
row = new WixBundleCatalogRow(sourceLineNumbers, this);
break;
case "WixChain":
row = new WixChainRow(sourceLineNumbers, this);
break;
case "WixChainItem":
row = new WixChainItemRow(sourceLineNumbers, this);
break;
case "WixBundlePackageCommandLine":
row = new WixBundlePackageCommandLineRow(sourceLineNumbers, this);
break;
case "WixComplexReference":
row = new WixComplexReferenceRow(sourceLineNumbers, this);
break;
case "WixDeltaPatchFile":
row = new WixDeltaPatchFileRow(sourceLineNumbers, this);
break;
case "WixDeltaPatchSymbolPaths":
row = new WixDeltaPatchSymbolPathsRow(sourceLineNumbers, this);
break;
case "WixFile":
row = new WixFileRow(sourceLineNumbers, this);
break;
case "WixGroup":
row = new WixGroupRow(sourceLineNumbers, this);
break;
case "WixMedia":
row = new WixMediaRow(sourceLineNumbers, this);
break;
case "WixMediaTemplate":
row = new WixMediaTemplateRow(sourceLineNumbers, this);
break;
case "WixMerge":
row = new WixMergeRow(sourceLineNumbers, this);
break;
case "WixPayloadProperties":
row = new WixPayloadPropertiesRow(sourceLineNumbers, this);
break;
case "WixProperty":
row = new WixPropertyRow(sourceLineNumbers, this);
break;
case "WixSimpleReference":
row = new WixSimpleReferenceRow(sourceLineNumbers, this);
break;
case "WixUpdateRegistration":
row = new WixUpdateRegistrationRow(sourceLineNumbers, this);
break;
case "WixVariable":
row = new WixVariableRow(sourceLineNumbers, this);
break;
default:
row = new Row(sourceLineNumbers, this);
break;
}
if (add)
{
this.Rows.Add(row);
}
return(row);
}
public void Execute()
{
throw new NotImplementedException();
#if TODO
this.FileTransfers = Enumerable.Empty <FileTransfer>();
this.ContentFilePaths = Enumerable.Empty <string>();
// First look for data we expect to find... Chain, WixGroups, etc.
// We shouldn't really get past the linker phase if there are
// no group items... that means that there's no UX, no Chain,
// *and* no Containers!
Table chainPackageTable = this.GetRequiredTable("WixBundlePackage");
Table wixGroupTable = this.GetRequiredTable("WixGroup");
// Ensure there is one and only one row in the WixBundle table.
// The compiler and linker behavior should have colluded to get
// this behavior.
WixBundleRow bundleRow = (WixBundleRow)this.GetSingleRowTable("WixBundle");
bundleRow.PerMachine = true; // default to per-machine but the first-per user package wil flip the bundle per-user.
// Ensure there is one and only one row in the WixBootstrapperApplication table.
// The compiler and linker behavior should have colluded to get
// this behavior.
Row baRow = this.GetSingleRowTable("WixBootstrapperApplication");
// Ensure there is one and only one row in the WixChain table.
// The compiler and linker behavior should have colluded to get
// this behavior.
WixChainRow chainRow = (WixChainRow)this.GetSingleRowTable("WixChain");
if (Messaging.Instance.EncounteredError)
{
return;
}
// If there are any fields to resolve later, create the cache to populate during bind.
IDictionary <string, string> variableCache = null;
if (this.DelayedFields.Any())
{
variableCache = new Dictionary <string, string>(StringComparer.InvariantCultureIgnoreCase);
}
// TODO: Although the WixSearch tables are defined in the Util extension,
// the Bundle Binder has to know all about them. We hope to revisit all
// of this in the 4.0 timeframe.
IEnumerable <WixSearchInfo> orderedSearches = this.OrderSearches();
// Extract files that come from cabinet files (this does not extract files from merge modules).
{
var extractEmbeddedFilesCommand = new ExtractEmbeddedFilesCommand();
extractEmbeddedFilesCommand.FilesWithEmbeddedFiles = ExpectedEmbeddedFiles;
extractEmbeddedFilesCommand.Execute();
}
// Get the explicit payloads.
RowDictionary <WixBundlePayloadRow> payloads = new RowDictionary <WixBundlePayloadRow>(this.Output.Tables["WixBundlePayload"]);
// Update explicitly authored payloads with their parent package and container (as appropriate)
// to make it easier to gather the payloads later.
foreach (WixGroupRow row in wixGroupTable.RowsAs <WixGroupRow>())
{
if (ComplexReferenceChildType.Payload == row.ChildType)
{
WixBundlePayloadRow payload = payloads.Get(row.ChildId);
if (ComplexReferenceParentType.Package == row.ParentType)
{
Debug.Assert(String.IsNullOrEmpty(payload.Package));
payload.Package = row.ParentId;
}
else if (ComplexReferenceParentType.Container == row.ParentType)
{
Debug.Assert(String.IsNullOrEmpty(payload.Container));
payload.Container = row.ParentId;
}
else if (ComplexReferenceParentType.Layout == row.ParentType)
{
payload.LayoutOnly = true;
}
}
}
List <FileTransfer> fileTransfers = new List <FileTransfer>();
string layoutDirectory = Path.GetDirectoryName(this.OutputPath);
// Process the explicitly authored payloads.
ISet <string> processedPayloads;
{
ProcessPayloadsCommand command = new ProcessPayloadsCommand();
command.Payloads = payloads.Values;
command.DefaultPackaging = bundleRow.DefaultPackagingType;
command.LayoutDirectory = layoutDirectory;
command.Execute();
fileTransfers.AddRange(command.FileTransfers);
processedPayloads = new HashSet <string>(payloads.Keys);
}
IDictionary <string, PackageFacade> facades;
{
GetPackageFacadesCommand command = new GetPackageFacadesCommand();
command.PackageTable = chainPackageTable;
command.ExePackageTable = this.Output.Tables["WixBundleExePackage"];
command.MsiPackageTable = this.Output.Tables["WixBundleMsiPackage"];
command.MspPackageTable = this.Output.Tables["WixBundleMspPackage"];
command.MsuPackageTable = this.Output.Tables["WixBundleMsuPackage"];
command.Execute();
facades = command.PackageFacades;
}
// Process each package facade. Note this is likely to add payloads and other rows to tables so
// note that any indexes created above may be out of date now.
foreach (PackageFacade facade in facades.Values)
{
switch (facade.Package.Type)
{
case WixBundlePackageType.Exe:
{
ProcessExePackageCommand command = new ProcessExePackageCommand();
command.AuthoredPayloads = payloads;
command.Facade = facade;
command.Execute();
// ? variableCache.Add(String.Concat("packageManufacturer.", facade.Package.WixChainItemId), facade.ExePackage.Manufacturer);
}
break;
case WixBundlePackageType.Msi:
{
var command = new ProcessMsiPackageCommand();
command.AuthoredPayloads = payloads;
command.Facade = facade;
command.BackendExtensions = this.BackendExtensions;
command.MsiFeatureTable = this.Output.EnsureTable(this.TableDefinitions["WixBundleMsiFeature"]);
command.MsiPropertyTable = this.Output.EnsureTable(this.TableDefinitions["WixBundleMsiProperty"]);
command.PayloadTable = this.Output.Tables["WixBundlePayload"];
command.RelatedPackageTable = this.Output.EnsureTable(this.TableDefinitions["WixBundleRelatedPackage"]);
command.Execute();
if (null != variableCache)
{
variableCache.Add(String.Concat("packageLanguage.", facade.Package.WixChainItemId), facade.MsiPackage.ProductLanguage.ToString());
if (null != facade.MsiPackage.Manufacturer)
{
variableCache.Add(String.Concat("packageManufacturer.", facade.Package.WixChainItemId), facade.MsiPackage.Manufacturer);
}
}
}
break;
case WixBundlePackageType.Msp:
{
ProcessMspPackageCommand command = new ProcessMspPackageCommand();
command.AuthoredPayloads = payloads;
command.Facade = facade;
command.WixBundlePatchTargetCodeTable = this.Output.EnsureTable(this.TableDefinitions["WixBundlePatchTargetCode"]);
command.Execute();
}
break;
case WixBundlePackageType.Msu:
{
ProcessMsuPackageCommand command = new ProcessMsuPackageCommand();
command.Facade = facade;
command.Execute();
}
break;
}
if (null != variableCache)
{
BindBundleCommand.PopulatePackageVariableCache(facade.Package, variableCache);
}
}
// Reindex the payloads now that all the payloads (minus the manifest payloads that will be created later)
// are present.
payloads = new RowDictionary <WixBundlePayloadRow>(this.Output.Tables["WixBundlePayload"]);
// Process the payloads that were added by processing the packages.
{
ProcessPayloadsCommand command = new ProcessPayloadsCommand();
command.Payloads = payloads.Values.Where(r => !processedPayloads.Contains(r.Id)).ToList();
command.DefaultPackaging = bundleRow.DefaultPackagingType;
command.LayoutDirectory = layoutDirectory;
command.Execute();
fileTransfers.AddRange(command.FileTransfers);
processedPayloads = null;
}
// Set the package metadata from the payloads now that we have the complete payload information.
ILookup <string, WixBundlePayloadRow> payloadsByPackage = payloads.Values.ToLookup(p => p.Package);
{
foreach (PackageFacade facade in facades.Values)
{
facade.Package.Size = 0;
IEnumerable <WixBundlePayloadRow> packagePayloads = payloadsByPackage[facade.Package.WixChainItemId];
foreach (WixBundlePayloadRow payload in packagePayloads)
{
facade.Package.Size += payload.FileSize;
}
if (!facade.Package.InstallSize.HasValue)
{
facade.Package.InstallSize = facade.Package.Size;
}
WixBundlePayloadRow packagePayload = payloads[facade.Package.PackagePayload];
if (String.IsNullOrEmpty(facade.Package.Description))
{
facade.Package.Description = packagePayload.Description;
}
if (String.IsNullOrEmpty(facade.Package.DisplayName))
{
facade.Package.DisplayName = packagePayload.DisplayName;
}
}
}
// Give the UX payloads their embedded IDs...
int uxPayloadIndex = 0;
{
foreach (WixBundlePayloadRow payload in payloads.Values.Where(p => Compiler.BurnUXContainerId == p.Container))
{
// In theory, UX payloads could be embedded in the UX CAB, external to the bundle EXE, or even
// downloaded. The current engine requires the UX to be fully present before any downloading starts,
// so that rules out downloading. Also, the burn engine does not currently copy external UX payloads
// into the temporary UX directory correctly, so we don't allow external either.
if (PackagingType.Embedded != payload.Packaging)
{
Messaging.Instance.OnMessage(WixWarnings.UxPayloadsOnlySupportEmbedding(payload.SourceLineNumbers, payload.FullFileName));
payload.Packaging = PackagingType.Embedded;
}
payload.EmbeddedId = String.Format(CultureInfo.InvariantCulture, BurnCommon.BurnUXContainerEmbeddedIdFormat, uxPayloadIndex);
++uxPayloadIndex;
}
if (0 == uxPayloadIndex)
{
// If we didn't get any UX payloads, it's an error!
throw new WixException(WixErrors.MissingBundleInformation("BootstrapperApplication"));
}
// Give the embedded payloads without an embedded id yet an embedded id.
int payloadIndex = 0;
foreach (WixBundlePayloadRow payload in payloads.Values)
{
Debug.Assert(PackagingType.Unknown != payload.Packaging);
if (PackagingType.Embedded == payload.Packaging && String.IsNullOrEmpty(payload.EmbeddedId))
{
payload.EmbeddedId = String.Format(CultureInfo.InvariantCulture, BurnCommon.BurnAttachedContainerEmbeddedIdFormat, payloadIndex);
++payloadIndex;
}
}
}
// Determine patches to automatically slipstream.
{
AutomaticallySlipstreamPatchesCommand command = new AutomaticallySlipstreamPatchesCommand();
command.PackageFacades = facades.Values;
command.SlipstreamMspTable = this.Output.EnsureTable(this.TableDefinitions["WixBundleSlipstreamMsp"]);
command.WixBundlePatchTargetCodeTable = this.Output.EnsureTable(this.TableDefinitions["WixBundlePatchTargetCode"]);
command.Execute();
}
// If catalog files exist, non-embedded payloads should validate with the catalogs.
IEnumerable <WixBundleCatalogRow> catalogs = this.Output.Tables["WixBundleCatalog"].RowsAs <WixBundleCatalogRow>();
if (catalogs.Any())
{
VerifyPayloadsWithCatalogCommand command = new VerifyPayloadsWithCatalogCommand();
command.Catalogs = catalogs;
command.Payloads = payloads.Values;
command.Execute();
}
if (Messaging.Instance.EncounteredError)
{
return;
}
IEnumerable <PackageFacade> orderedFacades;
IEnumerable <WixBundleRollbackBoundaryRow> boundaries;
{
OrderPackagesAndRollbackBoundariesCommand command = new OrderPackagesAndRollbackBoundariesCommand();
command.Boundaries = new RowDictionary <WixBundleRollbackBoundaryRow>(this.Output.Tables["WixBundleRollbackBoundary"]);
command.PackageFacades = facades;
command.WixGroupTable = wixGroupTable;
command.Execute();
orderedFacades = command.OrderedPackageFacades;
boundaries = command.UsedRollbackBoundaries;
}
// Resolve any delayed fields before generating the manifest.
if (this.DelayedFields.Any())
{
var resolveDelayedFieldsCommand = new ResolveDelayedFieldsCommand();
resolveDelayedFieldsCommand.OutputType = this.Output.Type;
resolveDelayedFieldsCommand.DelayedFields = this.DelayedFields;
resolveDelayedFieldsCommand.ModularizationGuid = null;
resolveDelayedFieldsCommand.VariableCache = variableCache;
resolveDelayedFieldsCommand.Execute();
}
// Set the overridable bundle provider key.
this.SetBundleProviderKey(this.Output, bundleRow);
// Import or generate dependency providers for packages in the manifest.
this.ProcessDependencyProviders(this.Output, facades);
// Update the bundle per-machine/per-user scope based on the chained packages.
this.ResolveBundleInstallScope(bundleRow, orderedFacades);
// Generate the core-defined BA manifest tables...
{
CreateBootstrapperApplicationManifestCommand command = new CreateBootstrapperApplicationManifestCommand();
command.BundleRow = bundleRow;
command.ChainPackages = orderedFacades;
command.LastUXPayloadIndex = uxPayloadIndex;
command.MsiFeatures = this.Output.Tables["WixBundleMsiFeature"].RowsAs <WixBundleMsiFeatureRow>();
command.Output = this.Output;
command.Payloads = payloads;
command.TableDefinitions = this.TableDefinitions;
command.TempFilesLocation = this.IntermediateFolder;
command.Execute();
WixBundlePayloadRow baManifestPayload = command.BootstrapperApplicationManifestPayloadRow;
payloads.Add(baManifestPayload);
}
//foreach (BinderExtension extension in this.Extensions)
//{
// extension.PostBind(this.Context);
//}
// Create all the containers except the UX container first so the manifest (that goes in the UX container)
// can contain all size and hash information about the non-UX containers.
RowDictionary <WixBundleContainerRow> containers = new RowDictionary <WixBundleContainerRow>(this.Output.Tables["WixBundleContainer"]);
ILookup <string, WixBundlePayloadRow> payloadsByContainer = payloads.Values.ToLookup(p => p.Container);
int attachedContainerIndex = 1; // count starts at one because UX container is "0".
IEnumerable <WixBundlePayloadRow> uxContainerPayloads = Enumerable.Empty <WixBundlePayloadRow>();
foreach (WixBundleContainerRow container in containers.Values)
{
IEnumerable <WixBundlePayloadRow> containerPayloads = payloadsByContainer[container.Id];
if (!containerPayloads.Any())
{
if (container.Id != Compiler.BurnDefaultAttachedContainerId)
{
// TODO: display warning that we're ignoring container that ended up with no paylods in it.
}
}
else if (Compiler.BurnUXContainerId == container.Id)
{
container.WorkingPath = Path.Combine(this.IntermediateFolder, container.Name);
container.AttachedContainerIndex = 0;
// Gather the list of UX payloads but ensure the BootstrapperApplication Payload is the first
// in the list since that is the Payload that Burn attempts to load.
List <WixBundlePayloadRow> uxPayloads = new List <WixBundlePayloadRow>();
string baPayloadId = baRow.FieldAsString(0);
foreach (WixBundlePayloadRow uxPayload in containerPayloads)
{
if (uxPayload.Id == baPayloadId)
{
uxPayloads.Insert(0, uxPayload);
}
else
{
uxPayloads.Add(uxPayload);
}
}
uxContainerPayloads = uxPayloads;
}
else
{
container.WorkingPath = Path.Combine(this.IntermediateFolder, container.Name);
// Add detached containers to the list of file transfers.
if (ContainerType.Detached == container.Type)
{
FileTransfer transfer;
if (FileTransfer.TryCreate(container.WorkingPath, Path.Combine(layoutDirectory, container.Name), true, "Container", container.SourceLineNumbers, out transfer))
{
transfer.Built = true;
fileTransfers.Add(transfer);
}
}
else // update the attached container index.
{
Debug.Assert(ContainerType.Attached == container.Type);
container.AttachedContainerIndex = attachedContainerIndex;
++attachedContainerIndex;
}
this.CreateContainer(container, containerPayloads, null);
}
}
// Create the bundle manifest then UX container.
string manifestPath = Path.Combine(this.IntermediateFolder, "bundle-manifest.xml");
{
var command = new CreateBurnManifestCommand();
command.BackendExtensions = this.BackendExtensions;
command.Output = this.Output;
command.BundleInfo = bundleRow;
command.Chain = chainRow;
command.Containers = containers;
command.Catalogs = catalogs;
command.ExecutableName = Path.GetFileName(this.OutputPath);
command.OrderedPackages = orderedFacades;
command.OutputPath = manifestPath;
command.RollbackBoundaries = boundaries;
command.OrderedSearches = orderedSearches;
command.Payloads = payloads;
command.UXContainerPayloads = uxContainerPayloads;
command.Execute();
}
WixBundleContainerRow uxContainer = containers[Compiler.BurnUXContainerId];
this.CreateContainer(uxContainer, uxContainerPayloads, manifestPath);
// Copy the burn.exe to a writable location then mark it to be moved to its final build location. Note
// that today, the x64 Burn uses the x86 stub.
string stubPlatform = (Platform.X64 == bundleRow.Platform) ? "x86" : bundleRow.Platform.ToString();
string stubFile = Path.Combine(Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location), stubPlatform, "burn.exe");
string bundleTempPath = Path.Combine(this.IntermediateFolder, Path.GetFileName(this.OutputPath));
Messaging.Instance.OnMessage(WixVerboses.GeneratingBundle(bundleTempPath, stubFile));
string bundleFilename = Path.GetFileName(this.OutputPath);
if ("setup.exe".Equals(bundleFilename, StringComparison.OrdinalIgnoreCase))
{
Messaging.Instance.OnMessage(WixErrors.InsecureBundleFilename(bundleFilename));
}
FileTransfer bundleTransfer;
if (FileTransfer.TryCreate(bundleTempPath, this.OutputPath, true, "Bundle", bundleRow.SourceLineNumbers, out bundleTransfer))
{
bundleTransfer.Built = true;
fileTransfers.Add(bundleTransfer);
}
File.Copy(stubFile, bundleTempPath, true);
File.SetAttributes(bundleTempPath, FileAttributes.Normal);
this.UpdateBurnResources(bundleTempPath, this.OutputPath, bundleRow);
// Update the .wixburn section to point to at the UX and attached container(s) then attach the containers
// if they should be attached.
using (BurnWriter writer = BurnWriter.Open(bundleTempPath))
{
FileInfo burnStubFile = new FileInfo(bundleTempPath);
writer.InitializeBundleSectionData(burnStubFile.Length, bundleRow.BundleId);
// Always attach the UX container first
writer.AppendContainer(uxContainer.WorkingPath, BurnWriter.Container.UX);
// Now append all other attached containers
foreach (WixBundleContainerRow container in containers.Values)
{
if (ContainerType.Attached == container.Type)
{
// The container was only created if it had payloads.
if (!String.IsNullOrEmpty(container.WorkingPath) && Compiler.BurnUXContainerId != container.Id)
{
writer.AppendContainer(container.WorkingPath, BurnWriter.Container.Attached);
}
}
}
}
if (null != this.PdbFile)
{
Pdb pdb = new Pdb();
pdb.Output = Output;
pdb.Save(this.PdbFile);
}
this.FileTransfers = fileTransfers;
this.ContentFilePaths = payloads.Values.Where(p => p.ContentFile).Select(p => p.FullFileName).ToList();
}