StoreBroker/PackageTool.ps1
|
# Copyright (C) Microsoft Corporation. All rights reserved. # Default file name of the AppConfig in the module folder $script:defaultConfigFileName = "AppConfigTemplate.json" $script:defaultIapConfigFileName = "IapConfigTemplate.json" # Images will be placed in the .zip folder under the $packageImageFolderName subfolder $script:packageImageFolderName = "Assets" # New-SubmissionPackage supports these extensions. $script:supportedExtensions = ".appx", ".appxbundle", ".appxupload" # String constants for New-SubmissionPackage parameters $script:s_ConfigPath = "ConfigPath" $script:s_PDPRootPath = "PDPRootPath" $script:s_Release = "Release" $script:s_PDPInclude = "PDPInclude" $script:s_PDPExclude = "PDPExclude" $script:s_LanguageExclude = "LanguageExclude" $script:s_ImagesRootPath = "ImagesRootPath" $script:s_AppxPath = "AppxPath" $script:s_OutPath = "OutPath" $script:s_OutName = "OutName" $script:s_DisableAutoPackageNameFormatting = "DisableAutoPackageNameFormatting" $script:s_MediaFallbackLanguage = "MediaFallbackLanguage" # String constants for application metadata $script:applicationMetadataProperties = @( "version", "architecture", "targetPlatform", "languages", "capabilities", "targetDeviceFamilies", "targetDeviceFamiliesEx", "innerPackages" ) # The API formats version numbers as "[device family] min version [min version]" $script:minVersionFormatString = "{0} min version {1}" # The current version of the StoreBroker schema that PackageTool is authoring for app and IAP submissions. # The StoreBroker schema may include metadata that isn't a core part of the official Submission API # JSON schema (like the appId or iapId, package metadata, etc...). These values should be updated any time # we alter what additional metadata is added to the schema for that submission type. $script:appSchemaVersion = 2 $script:iapSchemaVersion = 2 $script:schemaPropertyName = 'sbSchema' function Get-StoreBrokerConfigFileContentForIapId { <# .SYNOPSIS Updates the default IAP configuration file template with the values from the indicated IAP's most recent submission. .DESCRIPTION Updates the default IAP configuration file template with the values from the indicated IAP's most recent submission. The Git repo for this module can be found here: https://aka.ms/StoreBroker .PARAMETER ConfigContent The content of the config file template as a simple string. .PARAMETER IapId The IapId whose most recent submission should be retrieved and used to fill in the default values of the template content. .EXAMPLE Get-StoreBrokerConfigFileContentForIapId -ConfigContent $template -IapId 0ABCDEF12345 Assuming that $template has the content of the template file read in from disk and merged into a single string, this then gets the most recent IAP submission for IapId 0ABCDEF12345 and replaces the default values in the template with those from that submission. .OUTPUTS System.String - The template content modified with the values from the most recent IAP submission. .NOTES We use regular expression matching within the implementation rather than operating on the content as a JSON object, because we want to retain all of the comments that are part of the template content. #> [CmdletBinding()] param( [Parameter(Mandatory)] [string] $ConfigContent, [Parameter(Mandatory)] [string] $IapId ) $updated = $ConfigContent try { $iap = Get-InAppProduct -IapId $IapId $submissionId = $iap.lastPublishedInAppProductSubmission.id if ([String]::IsNullOrEmpty($submissionId)) { $submissionId = $iap.pendingInAppProductSubmission.id Write-Log "No published submission exists for this In-App Product. Using the current pending submission." -Level Warning } $sub = Get-InAppProductSubmission -IapId $IapId -SubmissionId $submissionId $updated = $updated -replace '"iapId": "",', "`"iapId`": `"$IapId`"," # PUBLISH MODE AND VISIBILITY $updated = $updated -replace '"targetPublishMode": ".*",', "`"targetPublishMode`": `"$($sub.targetPublishMode)`"," $updated = $updated -replace '"targetPublishDate": .*,', "`"targetPublishDate`": `"$($sub.targetPublishDate)`"," $updated = $updated -replace '"visibility": ".*",', "`"visibility`": `"$($sub.visibility)`"," # PRICING AND AVAILABILITY $updated = $updated -replace '"priceId": ".*",', "`"priceId`": `"$($sub.pricing.priceId)`"," $marketSpecificPricings = $sub.pricing.marketSpecificPricings | ConvertTo-Json -Depth $script:jsonConversionDepth $updated = $updated -replace '(\s+)"marketSpecificPricings": {.*(\r|\n)+\s*}', "`$1`"marketSpecificPricings`": $marketSpecificPricings" # PROPERTIES $updated = $updated -replace '"lifetime": ".*",', "`"lifetime`": `"$($sub.lifetime)`"," $updated = $updated -replace '"contentType": ".*",', "`"contentType`": `"$($sub.contentType)`"," $tag = Get-EscapedJsonValue -Value $sub.tag $updated = $updated -replace '"tag": ""', "`"tag`": `"$tag`"" $keywords = $sub.keywords | ConvertTo-Json -Depth $script:jsonConversionDepth if ($null -eq $keywords) { $keywords = "[ ]" } $updated = $updated -replace '(\s+)"keywords": \[.*(\r|\n)+\s*\]', "`$1`"keywords`": $keywords" # NOTES FOR CERTIFICATION $notesForCertification = Get-EscapedJsonValue -Value $sub.notesForCertification $updated = $updated -replace '"notesForCertification": ""', "`"notesForCertification`": `"$notesForCertification`"" return $updated } catch { Write-Log "Encountered problems getting current In-App Product submission values: $($_.Exception.Message)" -Level Error throw } } function New-StoreBrokerInAppProductConfigFile { <# .SYNOPSIS Creates a new configuration file as a template for an In-App Product submission. .DESCRIPTION Creates a new configuration file as a template for an In-App Product submission. The full path to the new file can be provided by the -Path parameter. The Git repo for this module can be found here: https://aka.ms/StoreBroker .PARAMETER Path A full path specifying where the new config file will go and what it will be named. It is recommended to use the .json file extension. .PARAMETER IapId If specified, this will pre-populate the Iap config portion of the configuration file with the values from the most recent submission for this IapId. .EXAMPLE New-StoreBrokerConfigFile -Path "C:\users\alias\NewIapConfig.json" Creates the config file template "NewIapConfig.json" under "C:\users\alias" .EXAMPLE New-StoreBrokerInAppProductConfigFile -Path "C:\users\alias\NewIapConfig.json" -WhatIf This example is the same as Example 1 except no config file will be created. The function will report on the actions it would have taken, instead. .EXAMPLE New-StoreBrokerInAppProductConfigFile -Path "C:\users\alias\NewIapConfig.json" -AppId 0ABCDEF12345 Creates the config file template "NewIapConfig.json" under "C:\users\alias", but sets the values for the app config portion to be those from the most recent submission for IapId 0ABCDEF12345. #> [CmdletBinding(SupportsShouldProcess)] [Alias('New-StoreBrokerIapConfigFile')] [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")] param( [Parameter(Mandatory)] [ValidateScript({ if ((Split-Path -Leaf $_) -like "*.*") { $true } else { throw "Path must include filename." } })] [string] $Path, [string] $IapId = "" ) $dir = Split-Path -Parent -Path $Path if (-not (Test-Path -PathType Container -Path $dir)) { Write-Log "Creating directory: $dir" -Level Verbose New-Item -Force -ItemType Directory -Path $dir | Out-Null Write-Log "Created directory." -Level Verbose } $sourcePath = Join-Path -Path $PSScriptRoot -ChildPath $script:defaultIapConfigFileName # Get-Content returns an array of lines.... using Out-String gives us back the linefeeds. $template = (Get-Content -Path $sourcePath -Encoding UTF8) | Out-String if (-not ([String]::IsNullOrEmpty($IapId))) { $template = Get-StoreBrokerConfigFileContentForIapId -ConfigContent $template -IapId $IapId } Write-Log "Copying (Item: $sourcePath) to (Target: $Path)." -Level Verbose Set-Content -Path $Path -Value $template -Encoding UTF8 -Force Write-Log "Copy complete." -Level Verbose $telemetryProperties = @{ [StoreBrokerTelemetryProperty]::IapId = $IapId } Set-TelemetryEvent -EventName New-StoreBrokerIapConfigFile -Properties $telemetryProperties } function Get-StoreBrokerConfigFileContentForAppId { <# .SYNOPSIS Updates the default configuration file template with the values from the indicated App's most recent published submission. .DESCRIPTION Updates the default configuration file template with the values from the indicated App's most recent published submission. The Git repo for this module can be found here: https://aka.ms/StoreBroker .PARAMETER ConfigContent The content of the config file template as a simple string. .PARAMETER AppId The AppId whose most recent submission should be retrieved and used to fill in the default values of the template content. .EXAMPLE Get-StoreBrokerConfigFileContentForAppId -ConfigContent $template -AppId 0ABCDEF12345 Assuming that $template has the content of the template file read in from disk and merged into a single string, this then gets the most recent app submission for AppId 0ABCDEF12345 and replaces the default values in the template with those from that submission. .OUTPUTS System.String - The template content modified with the values from the most recent app submission. .NOTES We use regular expression matching within the implementation rather than operating on the content as a JSON object, because we want to retain all of the comments that are part of the template content. #> [CmdletBinding()] param( [Parameter(Mandatory)] [string] $ConfigContent, [Parameter(Mandatory)] [string] $AppId ) $updated = $ConfigContent try { $app = Get-Application -AppId $AppId if ([String]::IsNullOrEmpty($app.lastPublishedApplicationSubmission.id)) { throw "Specified AppId has no published submission to copy settings from." } $sub = Get-ApplicationSubmission -AppId $AppId -SubmissionId $($app.lastPublishedApplicationSubmission.id) $updated = $updated -replace '"appId": ".*",', "`"appId`": `"$AppId`"," # PUBLISH MODE AND VISIBILITY $updated = $updated -replace '"targetPublishMode": ".*",', "`"targetPublishMode`": `"$($sub.targetPublishMode)`"," $updated = $updated -replace '"targetPublishDate": .*,', "`"targetPublishDate`": `"$($sub.targetPublishDate)`"," $updated = $updated -replace '"visibility": ".*",', "`"visibility`": `"$($sub.visibility)`"," # PRICING AND AVAILABILITY $updated = $updated -replace '"priceId": ".*",', "`"priceId`": `"$($sub.pricing.priceId)`"," $updated = $updated -replace '"trialPeriod": ".*",', "`"trialPeriod`": `"$($sub.pricing.trialPeriod)`"," $marketSpecificPricings = $sub.pricing.marketSpecificPricings | ConvertTo-Json -Depth $script:jsonConversionDepth $updated = $updated -replace '(\s+)"marketSpecificPricings": {.*(\r|\n)+\s*}', "`$1`"marketSpecificPricings`": $marketSpecificPricings" $sales = $sub.pricing.sales | ConvertTo-Json -Depth $script:jsonConversionDepth if ($null -eq $sales) { $sales = "[ ]" } $updated = $updated -replace '(\s+)"sales": \[.*(\r|\n)+\s*\]', "`$1`"sales`": $sales" $families = $sub.allowTargetFutureDeviceFamilies foreach ($family in ("Xbox", "Team", "Holographic", "Desktop", "Mobile")) { if ($families -match $family) { $updated = $updated -replace "`"$family`": [^,\r\n]*(,)?", "`"$family`": $($families.$family.ToString().ToLower())`$1" } else { $updated = $updated -replace "`"$family`": [^,\r\n]*(,)?", "// `"$family`": false`$1" } } $updated = $updated -replace '"allowMicrosoftDecideAppAvailabilityToFutureDeviceFamilies": .*,', "`"allowMicrosoftDecideAppAvailabilityToFutureDeviceFamilies`": $($sub.allowMicrosoftDecideAppAvailabilityToFutureDeviceFamilies.ToString().ToLower())," $updated = $updated -replace '"enterpriseLicensing": ".*",', "`"enterpriseLicensing`": `"$($sub.enterpriseLicensing)`"," # APP PROPERTIES $updated = $updated -replace '"applicationCategory": ".*",', "`"applicationCategory`": `"$($sub.applicationCategory)`"," $hardwarePreferences = $sub.hardwarePreferences | ConvertTo-Json -Depth $script:jsonConversionDepth if ($null -eq $hardwarePreferences) { $hardwarePreferences = "[ ]" } $updated = $updated -replace '(\s+)"hardwarePreferences": \[.*(\r|\n)+\s*\]', "`$1`"hardwarePreferences`": $hardwarePreferences" $updated = $updated -replace '"hasExternalInAppProducts": .*,', "`"hasExternalInAppProducts`": $($sub.hasExternalInAppProducts.ToString().ToLower())," $updated = $updated -replace '"meetAccessibilityGuidelines": .*,', "`"meetAccessibilityGuidelines`": $($sub.meetAccessibilityGuidelines.ToString().ToLower())," $updated = $updated -replace '"canInstallOnRemovableMedia": .*,', "`"canInstallOnRemovableMedia`": $($sub.canInstallOnRemovableMedia.ToString().ToLower())," $updated = $updated -replace '"automaticBackupEnabled": .*,', "`"automaticBackupEnabled`": $($sub.automaticBackupEnabled.ToString().ToLower())," $updated = $updated -replace '"isGameDvrEnabled": .*,', "`"isGameDvrEnabled`": $($sub.isGameDvrEnabled.ToString().ToLower())," # NOTES FOR CERTIFICATION $notesForCertification = Get-EscapedJsonValue -Value $sub.notesForCertification $updated = $updated -replace '"notesForCertification": ""', "`"notesForCertification`": `"$notesForCertification`"" return $updated } catch { Write-Log "Encountered problems getting current application submission values: $($_.Exception.Message)" -Level Error throw } } function New-StoreBrokerConfigFile { <# .SYNOPSIS Creates a new configuration file as a template for an app submission. .DESCRIPTION Creates a new configuration file as a template for an app submission. The full path to the new file can be provided by the -Path parameter. The Git repo for this module can be found here: https://aka.ms/StoreBroker .PARAMETER Path A full path specifying where the new config file will go and what it will be named. It is recommended to use the .json file extension. .PARAMETER AppId If specified, this will pre-populate the app config portion of the configuration file with the values from the most recent submission for this AppId. .EXAMPLE New-StoreBrokerConfigFile -Path "C:\users\alias\NewAppConfig.json" Creates the config file template "NewAppConfig.json" under "C:\users\alias" .EXAMPLE New-StoreBrokerConfigFile -Path "C:\users\alias\NewAppConfig.json" -WhatIf This example is the same as Example 1 except no config file will be created. The function will report on the actions it would have taken, instead. .EXAMPLE New-StoreBrokerConfigFile -Path "C:\users\alias\NewAppConfig.json" -AppId 0ABCDEF12345 Creates the config file template "NewAppConfig.json" under "C:\users\alias", but sets the values for the app config portion to be those from the most recent submission for AppId 0ABCDEF12345. #> [CmdletBinding(SupportsShouldProcess)] [Alias('New-PackageToolConfigFile')] [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")] param( [Parameter(Mandatory)] [ValidateScript({ if ((Split-Path -Leaf $_) -like "*.*") { $true } else { throw "Path must include filename." } })] [string] $Path, [string] $AppId = "" ) $dir = Split-Path -Parent -Path $Path if (-not (Test-Path -PathType Container -Path $dir)) { Write-Log "Creating directory: $dir" -Level Verbose New-Item -Force -ItemType Directory -Path $dir | Out-Null Write-Log "Created directory." -Level Verbose } $sourcePath = Join-Path -Path $PSScriptRoot -ChildPath $script:defaultConfigFileName # Get-Content returns an array of lines.... using Out-String gives us back the linefeeds. $template = (Get-Content -Path $sourcePath -Encoding UTF8) | Out-String if (-not ([String]::IsNullOrEmpty($AppId))) { $template = Get-StoreBrokerConfigFileContentForAppId -ConfigContent $template -AppId $AppId } Write-Log "Copying (Item: $sourcePath) to (Target: $Path)." -Level Verbose Set-Content -Path $Path -Value $template -Encoding UTF8 -Force Write-Log "Copy complete." -Level Verbose $telemetryProperties = @{ [StoreBrokerTelemetryProperty]::AppId = $AppId } Set-TelemetryEvent -EventName New-StoreBrokerConfigFile -Properties $telemetryProperties } function Out-DirectoryToZip { <# .SYNOPSIS Compresses a directory to a zip file, with logging. .DESCRIPTION Compresses a directory to a zip file, with logging. For performance reasons, we will always zip locally, then copy the zip to the final destination. This gives better performance when the final destination is not on the local machine. The function uses no compression during the zip process, as we didn't see a noticeable difference in file size. This is because the contents we are compressing (appx/appxbundles/png) have already been compressed so there is not much room for improvement. .PARAMETER Path The directory to be compressed. The path given must exist. .PARAMETER Destination The path to place the compressed contents of the Path. This path does not need to exist, but it must end in a .zip extension. #> [CmdletBinding(SupportsShouldProcess)] param( [Parameter(Mandatory)] [ValidateScript({ if (Test-Path -PathType Container -Path $_) { $true } else { throw "Could not find directory to compress: [$_]." } })] [string] $Path, [Parameter(Mandatory)] [ValidateScript({ if (($_ -like "*.zip") -and (Test-Path -IsValid -Path $_)) { $true } else { throw "Destination path is not a zip file: [$_]." } })] [string] $Destination ) try { if ($PSCmdlet.ShouldProcess($Destination, "Output to File")) { $tempLocalZipDir = New-TemporaryDirectory $tempLocalZipPath = Join-Path -Path $tempLocalZipDir -ChildPath "SBTempLocalPayload.zip" # Delete output paths if they already exist. foreach ($zipPath in ($tempLocalZipPath, $Destination)) { if (Test-Path -PathType Leaf -Include "*.zip" -Path $zipPath) { Write-Log "Removing zip path: [$zipPath]." -Level Verbose Remove-Item -Force -Recurse -Path $zipPath Write-Log "Removal complete." -Level Verbose } } # Need to add this type in-order to access the ZipFile class. Add-Type -AssemblyName System.IO.Compression.FileSystem # The contents we are compressing have already been compressed so there's not much # of a disadvantage to using NoCompression. $compressionLevel = [System.IO.Compression.CompressionLevel]::NoCompression $includeBaseDir = $false Write-Log "Compressing [$Path] to [$tempLocalZipPath]." -Level Verbose [System.IO.Compression.ZipFile]::CreateFromDirectory($Path, $tempLocalZipPath, $compressionLevel, $includeBaseDir) Write-Log "Compression complete." -Level Verbose Write-Log "Moving [$tempLocalZipPath] to [$Destination]." -Level Verbose Move-Item -Force -Path $tempLocalZipPath -Destination $Destination Write-Log "Move complete." -Level Verbose } } finally { if ($null -ne $tempLocalZipDir) { Write-Log "Removing temporary directory: [$tempLocalZipDir]." -Level Verbose Remove-Item -Force -Recurse -Path $tempLocalZipDir -ErrorAction Ignore Write-Log "Removal complete." -Level Verbose } } } function Write-SubmissionRequestBody { <# .SYNOPSIS Converts an object into JSON and writes to the specified file. .PARAMETER JsonObject A PSCustomObj to be converted into JSON. .PARAMETER OutFilePath Full path to the file to be written to. #> [CmdletBinding(SupportsShouldProcess)] param( [Parameter(Mandatory)] [PSCustomObject] $JsonObject, [Parameter(Mandatory)] [string] $OutFilePath ) if ($PSCmdlet.ShouldProcess($OutFilePath, "Output to File")) { Ensure-Directory -Path (Split-Path -Parent -Path $OutFilePath) Write-Log "Writing submission request JSON file: [$OutFilePath]." -Level Verbose $JsonObject | ConvertTo-Json -Depth $script:jsonConversionDepth -Compress | Out-File -Encoding utf8 -FilePath $OutFilePath Write-Log "Writing complete." -Level Verbose } } function Get-XsdPath { <# .SYNOPSIS Resolves a namespace schema URI to a local XSD file. .PARAMETER NamespaceUri The XML namespace URI. .OUTPUTS System.String - Full path to the XSD file. Exception if not found. #> param( [Parameter(Mandatory)] [string] $NamespaceUri ) $namespaces = @{ 'http://schemas.microsoft.com/appx/2012/ProductDescription' = (Join-Path -Path $PSScriptRoot -ChildPath '..\PDP\ProductDescription.xsd') 'http://schemas.microsoft.com/appx/2012/InAppProductDescription' = (Join-Path -Path $PSScriptRoot -ChildPath '..\PDP\InAppProductDescription.xsd') } $xsdPath = $namespaces[$NamespaceUri] if ([String]::IsNullOrEmpty($xsdPath)) { throw "Namespace not found ($NamespaceUri)" } return $xsdPath } function Test-Xml { <# .SYNOPSIS Validates a specified XML file against the input schema. If any validation errors are detected, the program will print a list of all errors and halt execution. .PARAMETER XsdFile Full path to the XML Schema Definition file to use. .PARAMETER XmlFile Full path to the XML file to be validated. #> param( [Parameter(Mandatory)] [string] $XsdFile, [Parameter(Mandatory)] [string] $XmlFile ) # Relative paths such as '.\File.txt' can resolve as 'C:\windows\System32\File.txt' when # interacting with .NET libraries. Run [string] path parameters through 'Resolve-UnverifiedPath' to # get a full-path before using the path with any .NET libraries. $XsdFile = Resolve-UnverifiedPath -Path $XsdFile $XmlFile = Resolve-UnverifiedPath -Path $XmlFile # The ValidationEventHandler runs in its own scope and does not have access to variables from # Test-Xml. Make $validationErrors a script variable so capture exceptions in the # ValidationEventHandler and report them in Test-Xml. $script:validationErrors = @() $handler = [scriptblock] { $script:validationErrors += $args[1].Message } $reader = New-Object System.Xml.XmlTextReader $XsdFile try { $schema = [System.Xml.Schema.XmlSchema]::Read($reader, $handler) $xml = New-Object System.Xml.XmlDocument $xml.Schemas.Add($schema) | Out-Null $xml.Load($XmlFile) $xml.Validate($handler) } finally { $reader.Close() } if ($script:validationErrors -gt 0) { $msg = @() $msg += "Provided XML file:`n`t$($XmlFile)`nis not valid under its referenced schema:`n`t$($XsdFile)" # Note: PSScriptAnalyzer falsely flags this next line as PSUseDeclaredVarsMoreThanAssignment due to: # https://github.com/PowerShell/PSScriptAnalyzer/issues/699 $script:validationErrors | ForEach-Object { $msg += $_ } $msg = $msg -join [Environment]::NewLine Write-Log $msg -Level Error throw $msg } } function Convert-ListingToObject { <# .SYNOPSIS Consumes a single localized .xml file into a listing object. .DESCRIPTION Consumes a single localized .xml file into a listing object. If a node has only content, then that content is assigned. If a node has children, it's children are pooled into an array and assigned. The ScreenshotCaptions node is special. For each caption, the function checks if there is an associated Desktop/Mobile/Xbox image, and adds new information for each type found. .PARAMETER PDPRootPath The root path of all the PDPs. 'XmlFilePath' should begin with 'PDPRootPath', so this function splits 'XmlFilePath' using 'PDPRootPath'. The result should begin with the lang-code of the file being processed. .PARAMETER LanguageExclude Array of lang-code strings that SHOULD NOT be processed. .PARAMETER ImagesRootPath A path to the root path containing the new submission's images. A screenshot caption has the potential for relative paths to Desktop, Mobile, and Xbox images. Each relative path is appended to ImagesRootPath to create a full path to the image. .PARAMETER XmlFilePath A full path to the localized .xml file to be parsed. .PARAMETER MediaFallbackLanguage Some apps may not localize all of their metadata media (images, trailers, etc..) across all languages. By default, StoreBroker will look in the PDP langcode's subfolder within ImagesRootPath for that language's media content. If the requested filename is not found, StoreBroker packaging will fail. If you specify a fallback language here (e.g. 'en-us'), then if the requested file isn't found in the PDP language's media subfolder, StoreBroker will then look into the fallback language's media subfolder for the exactly same-named image, and only fail then if it still cannot be found. #> [CmdletBinding(SupportsShouldProcess)] param( [Parameter(Mandatory)] [string] $PDPRootPath, [Parameter(Mandatory)] [AllowNull()] [AllowEmptyString()] [string[]] $LanguageExclude, [Parameter(Mandatory)] [Alias('MediaRootPath')] [string] $ImagesRootPath, [Parameter( Mandatory, ValueFromPipeline)] [string[]] $XmlFilePaths, [string] $MediaFallbackLanguage ) PROCESS { foreach ($xmlFilePath in $XmlFilePaths) { if ($PSCmdlet.ShouldProcess($xmlFilePath, "Convert-ListingToObject")) { try { # Identify lang-code of the file to process. # $array[-1] == $array[$array.Count-1] if ($PDPRootPath[-1] -ne '\') { $PDPRootPath = "$PDPRootPath\" } $split = $xmlFilePath -split $PDPRootPath, 0, "SimpleMatch" | Where-Object { -not [String]::IsNullOrWhiteSpace($_) } | Select-Object -First 1 $language = $split -split "\", 0, "SimpleMatch" | Where-Object { -not [String]::IsNullOrWhiteSpace($_) } | Select-Object -First 1 # Skip processing if language is marked for exclusion if ($language -in $LanguageExclude) { $out = "Skipping file '$xmlFilePath' because its lang-code '$language' is in the language exclusion list." Write-Log $out -Level Verbose return } $xml = [xml] (Get-Content -Path $xmlFilePath -Encoding UTF8) # ProductDescription node contains the metadata $ProductDescriptionNode = $xml.ProductDescription # Verify xml conforms to schema Test-Xml -XsdFile (Get-XsdPath -NamespaceUri $ProductDescriptionNode.xmlns) -XmlFile $xmlFilePath # Assemble the BaseListing object # Nodes with one item can be immediately assigned $baseListing = @{ "copyrightAndTrademarkInfo" = $ProductDescriptionNode.CopyrightAndTrademark; "licenseTerms" = $ProductDescriptionNode.AdditionalLicenseTerms; "privacyPolicy" = $ProductDescriptionNode.PrivacyPolicyURL; "supportContact" = $ProductDescriptionNode.SupportContactInfo; "websiteUrl" = $ProductDescriptionNode.WebsiteURL; "title" = $ProductDescriptionNode.AppStoreName; "description" = $ProductDescriptionNode.Description; "releaseNotes" = $ProductDescriptionNode.ReleaseNotes; } # Identify the keys whose values are non-null and trim the values. # Must be done in two steps because $baseListings can't be modified # while enumerating its keys. $trimKeys = $baseListing.Keys | Where-Object { ($null -ne $baseListing[$_].InnerText) -or ($baseListing[$_] -is [String]) } $trimKeys | ForEach-Object { if ($null -ne $baseListing[$_].InnerText) { $baseListing[$_] = $baseListing[$_].InnerText } $baseListing[$_] = $baseListing[$_].Trim() } # For title specifically, we need to ensure that it's set to $null if there's # no value. An empty string value is not the same as $null. if ([String]::IsNullOrWhiteSpace($baseListing['title'])) { $baseListing['title'] = $null } # Nodes with children need to have each value extracted into an array. # When using -Confirm, PS will ask user to confirm selecting 'InnerText'. # Explicitly set -Confirm:$false to prevent this dialog from reaching the user. @{ "features" = $ProductDescriptionNode.AppFeatures; "keywords" = $ProductDescriptionNode.Keywords; "recommendedHardware" = $ProductDescriptionNode.RecommendedHardware; }.GetEnumerator() | ForEach-Object { $baseListing[$_.Name] = @($_.Value.ChildNodes | Where-Object NodeType -eq Element | ForEach-Object -WhatIf:$false -Confirm:$false InnerText | Where-Object { $_ -ne $null } | ForEach-Object { $_.Trim() }) } # Handle screenshots and their captions. $imageListings = @() $captions = $ProductDescriptionNode.ScreenshotCaptions.ChildNodes | Where-Object NodeType -eq Element foreach ($caption in $captions) { $imageTypeMap = @{ "DesktopImage" = "Screenshot"; "MobileImage" = "MobileScreenshot"; "XboxImage" = "XboxScreenshot"; "HoloLensImage" = "HoloLensScreenshot"; "SurfaceHubImage" = "SurfaceHubScreenshot"; } foreach ($member in $imageTypeMap.Keys) { $imageFileName = $caption.$member if (-not [System.String]::IsNullOrWhiteSpace($imageFileName)) { # We start with the fallback language specified on an individual caption. # If one is not specified, then we'll look to see if there is one specified # for all captions on the ScreenshotCaptions element. If one is not specified # there, then we'll try using the one specified at the commandline/config file. $requestedFallbackLanguage = $caption.FallbackLanguage if ([String]::IsNullOrWhiteSpace($requestedFallbackLanguage)) { $requestedFallbackLanguage = $ProductDescriptionNode.ScreenshotCaptions.FallbackLanguage if ([String]::IsNullOrWhiteSpace($requestedFallbackLanguage)) { $requestedFallbackLanguage = $MediaFallbackLanguage } } $params = @{ 'Filename' = $imageFileName 'ImagesRootPath' = $ImagesRootPath 'Language' = $language 'Release' = $ProductDescriptionNode.Release 'MediaFallbackLanguage' = $requestedFallbackLanguage } $fileRelativePackagePath = Get-LocalizedMediaFile @params $imageType = $imageTypeMap[$member] $imageListings += @{ "fileName" = $fileRelativePackagePath; "fileStatus" = "PendingUpload"; "description" = $caption.InnerText.Trim(); "imageType" = $imageType; } } } } $baseListing["images"] = $imageListings # BaseListing done # Platform Overrides $platformOverrides = @{} # Package and return the results $listing = @{ "baseListing" = $baseListing; "platformOverrides" = $platformOverrides; } Write-Output @{ "lang" = $language.ToLowerInvariant(); "listing" = $listing } } catch [System.InvalidCastException] { $output = "Provided .xml file is not a valid .xml document: $xmlFilePath" Write-Log $output -Level Error throw $output } } } } } function Get-LocalizedMediaFile { <# .SYNOPSIS Finds the appropriately localized media file, given the filename, requested language, and an optional fallback language if the requested language does not contain that media file. The file will be copied to the temporary package path where the package is being prepared, and the relative path within that folder will be returned. .PARAMETER Filename The name of the media file that is being looked for. .PARAMETER ImagesRootPath The root path to the directory where this submission's images are located. .PARAMETER Language The language of the PDP file that is requesting the localized media file. .PARAMETER Release The Release value from within an individual PDP file, indicating the sub-folder within ImagesRootPath that the lang-code subfolders for media files can be found. .PARAMETER MediaFallbackLanguage Some apps may not localize all of their metadata media (images, trailers, etc..) across all languages. By default, StoreBroker will look in the PDP langcode's subfolder within ImagesRootPath for that language's media content. If the requested filename is not found, StoreBroker packaging will fail. If you specify a fallback language here (e.g. 'en-us'), then if the requested file isn't found in the PDP language's media subfolder, StoreBroker will then look into the fallback language's media subfolder for the exactly same-named image, and only fail then if it still cannot be found. .OUTPUTS System.String. Relative path to the media file as it will be found within the final StoreBroker package. .EXAMPLE Get-LocalizedMediaFile -Filename 'foo.png' -ImagesRootPath 'c:\screenshots\' -Language 'fr-fr' -Release '1712' Checks to see if c:\screenshots\1712\fr-fr\foo.png exists. If it does, copies it to $script:tempFolderPath\Assets\fr-fr\foo.png and returns 'Assets\fr-fr\foo.png'. If it doesn't exist, throws an exception. .EXAMPLE Get-LocalizedMediaFile -Filename 'foo.png' -ImagesRootPath 'c:\screenshots\' -Language 'fr-fr' -Release '1712' -MediaFallbackLanguage 'en-us' Checks to see if c:\screenshots\1712\fr-fr\foo.png exists. If it does, copies it to $script:tempFolderPath\Assets\fr-fr\foo.png and returns 'Assets\fr-fr\foo.png'. If it doesn't exist, checks to see if c:\screenshots\1712\en-us\foo.png exists. If it does, copies it to $script:tempFolderPath\Assets\en-us\foo.png and returns 'Assets\en-us\foo.png'. If it doesn't, throws an exception. #> [CmdletBinding(SupportsShouldProcess)] param( [Parameter(Mandatory)] [string] $Filename, [Parameter(Mandatory)] [Alias('MediaRootPath')] [string] $ImagesRootPath, [Parameter(Mandatory)] [string] $Language, [string] $Release, [string] $MediaFallbackLanguage ) # This is the partial path where the media file will be located witin the context of the zip file. $fileRelativePackagePath = $null # The folder where we think the media file should be found. $mediaLanguageSourcePath = [System.IO.Path]::Combine($ImagesRootPath, $Release, $Language) # The folder where we think the media file should be found if using the fallback language. $mediaFallbackLanguageSourcePath = $null if (-not [string]::IsNullOrEmpty($MediaFallbackLanguage) -and ($MediaFallbackLanguage -ne $Language)) { $mediaFallbackLanguageSourcePath = [System.IO.Path]::Combine($ImagesRootPath, $Release, $MediaFallbackLanguage) if (-not (Test-Path -Path $mediaFallbackLanguageSourcePath -PathType Container)) { Write-Log "A fallback language was specified [$MediaFallbackLanguage], but a folder for that language does not exist [$mediaFallbackLanguageSourcePath], so media fallback support has been disabled." -Level Warning $mediaFallbackLanguageSourcePath = $null } } if (Test-Path -Path $mediaLanguageSourcePath -PathType Container) { $image = Get-ChildItem -Recurse -File -Path $mediaLanguageSourcePath -Include $Filename $fileRelativePackagePath = [System.IO.Path]::Combine($script:packageImageFolderName, $Language, $Filename) } if (($null -eq $image) -and ($null -ne $mediaFallbackLanguageSourcePath)) { Write-Log "[$Language] version of $Filename not found. Using fallback language [$MediaFallbackLanguage] version." -Level Verbose $image = Get-ChildItem -Recurse -File -Path $mediaFallbackLanguageSourcePath -Include $Filename $fileRelativePackagePath = [System.IO.Path]::Combine($script:packageImageFolderName, $MediaFallbackLanguage, $Filename) } if ($null -eq $image) { $output = "Could not find image [$Filename] in any subdirectory of [$mediaLanguageSourcePath]." if ($null -ne $mediaFallbackLanguageSourcePath) { $output += " Image also not found in fallback language location [$mediaFallbackLanguageSourcePath]"; } Write-Log $output -Level Error throw $output } if ($image.Count -gt 1) { $output = "More then one version of [$Filename] has been found for this language. Please ensure only one copy of this image exists within the language's sub-folders: [$($image.FullName -join ', ')]" Write-Log $output -Level Warning #throw $output } $fileFullPackagePath = Join-Path -Path $script:tempFolderPath -ChildPath $fileRelativePackagePath if (-not (Test-Path -PathType Leaf $fileFullPackagePath)) { $packageMediaFullPath = Split-Path -Path $fileFullPackagePath -Parent if (-not (Test-Path -PathType Container -Path $packageMediaFullPath)) { New-Item -ItemType directory -Path $packageMediaFullPath | Out-Null } Copy-Item -Path $image.FullName -Destination $fileFullPackagePath } return $fileRelativePackagePath } function Convert-ListingsMetadata { <# .SYNOPSIS Top-level function for consuming localized metadata about the application submission. Each language's .xml file, in a subfolder under XmlListingsRootPath, is parsed and added to the listings object with the language as the key. .PARAMETER PDPRootPath The root path to the directory containing language-specific subfolders holding the localized metadata. .PARAMETER PDPInclude The name of the XML file to be parsed (same for every language). Wildcards are allowed. It is okay to specify both 'PDPInclude' and 'PDPExclude'. .PARAMETER PDPExclude XML filenames to be excluded from parsing. Wildcards are allowed. It is okay to specify both 'PDPInclude' and 'PDPExclude'. .PARAMETER LanguageExclude Array of lang-code strings that SHOULD NOT be processed. .PARAMETER ImagesRootPath The root path to the directory where this submission's images are located. .PARAMETER MediaFallbackLanguage Some apps may not localize all of their metadata media (images, trailers, etc..) across all languages. By default, StoreBroker will look in the PDP langcode's subfolder within ImagesRootPath for that language's media content. If the requested filename is not found, StoreBroker packaging will fail. If you specify a fallback language here (e.g. 'en-us'), then if the requested file isn't found in the PDP language's media subfolder, StoreBroker will then look into the fallback language's media subfolder for the exactly same-named image, and only fail then if it still cannot be found. .OUTPUTS Hashtable A hastable with each key being a language and the corresponding value, an object containing localized data for the app (Description, Notes, Screenshot captions, etc.) .EXAMPLE Convert-ListingsMetadata -PDPRootPath 'C:\PDP\' -PDPInclude 'ProductDescription.xml' -ImagesRootPath 'C:\AppImages' Assumes the folder structure: C:\PDP\language1\...\ProductDescription.xml C:\PDP\language2\...\ProductDescription.xml #> [CmdletBinding()] [OutputType([Hashtable])] param( [Parameter(Mandatory)] [ValidateScript({ if (Test-Path -PathType Container -Path $_) { $true } else { throw "'$_' is not a directory or cannot be found." } })] [string] $PDPRootPath, [Parameter(Mandatory)] [AllowNull()] [AllowEmptyString()] [string[]] $PDPInclude, [Parameter(Mandatory)] [AllowNull()] [AllowEmptyString()] [string[]] $PDPExclude, [Parameter(Mandatory)] [AllowNull()] [AllowEmptyString()] [string[]] $LanguageExclude, [Parameter(Mandatory)] [ValidateScript( { if (Test-Path -PathType Container -Path $_) { $true } else { throw "'$_' is not a directory or cannot be found." } })] [Alias('MediaRootPath')] [string] $ImagesRootPath, [string] $MediaFallbackLanguage ) $listings = @{} Write-Log "Converting application listings metadata." -Level Verbose (Get-ChildItem -File $PDPRootPath -Recurse -Include $PDPInclude -Exclude $PDPExclude).FullName | Convert-ListingToObject -PDPRootPath $PDPRootPath -LanguageExclude $LanguageExclude -ImagesRootPath $ImagesRootPath -MediaFallbackLanguage $MediaFallbackLanguage | ForEach-Object { $listings[$_."lang"] = $_."listing" } Write-Log "Conversion complete." -Level Verbose return $listings } function Convert-InAppProductListingToObject { <# .SYNOPSIS Consumes a single localized .xml file into an In-App Product listing object. .DESCRIPTION Consumes a single localized .xml file into an In-App Product listing object. If a node has only content, then that content is assigned. If a node has children, it's children are pooled into an array and assigned. .PARAMETER PDPRootPath The root path of all the PDPs. 'XmlFilePath' should begin with 'PDPRootPath', so this function splits 'XmlFilePath' using 'PDPRootPath'. The result should begin with the lang-code of the file being processed. .PARAMETER LanguageExclude Array of lang-code strings that SHOULD NOT be processed. .PARAMETER ImagesRootPath A path to the root path containing the new submission's images. Currently, an IAP can have an optional icon associated with it. Each relative path is appended to ImagesRootPath to create a full path to the image. .PARAMETER XmlFilePath A full path to the localized .xml file to be parsed. .PARAMETER MediaFallbackLanguage Some apps may not localize all of their metadata media (images, trailers, etc..) across all languages. By default, StoreBroker will look in the PDP langcode's subfolder within ImagesRootPath for that language's media content. If the requested filename is not found, StoreBroker packaging will fail. If you specify a fallback language here (e.g. 'en-us'), then if the requested file isn't found in the PDP language's media subfolder, StoreBroker will then look into the fallback language's media subfolder for the exactly same-named image, and only fail then if it still cannot be found. #> [CmdletBinding(SupportsShouldProcess)] param( [Parameter(Mandatory)] [string] $PDPRootPath, [Parameter(Mandatory)] [AllowNull()] [AllowEmptyString()] [string[]] $LanguageExclude, [Parameter(Mandatory)] [Alias('MediaRootPath')] [string] $ImagesRootPath, [Parameter( Mandatory, ValueFromPipeline)] [string[]] $XmlFilePaths, [string] $MediaFallbackLanguage ) PROCESS { foreach ($xmlFilePath in $XmlFilePaths) { if ($PSCmdlet.ShouldProcess($xmlFilePath, "Convert-InAppProductListingToObject")) { try { # Identify lang-code of the file to process. # $array[-1] == $array[$array.Count-1] if ($PDPRootPath[-1] -ne '\') { $PDPRootPath = "$PDPRootPath\" } $split = $xmlFilePath -split $PDPRootPath, 0, "SimpleMatch" | Where-Object { -not [String]::IsNullOrWhiteSpace($_) } | Select-Object -First 1 $language = $split -split "\", 0, "SimpleMatch" | Where-Object { -not [String]::IsNullOrWhiteSpace($_) } | Select-Object -First 1 # Skip processing if language is marked for exclusion if ($language -in $LanguageExclude) { $out = "Skipping file '$xmlFilePath' because its lang-code '$language' is in the language exclusion list." Write-Log $out -Level Verbose return } $xml = [xml] (Get-Content -Path $xmlFilePath -Encoding UTF8) # InAppProductDescription node contains the metadata $InAppProductDescriptionNode = $xml.InAppProductDescription # Verify xml conforms to schema Test-Xml -XsdFile (Get-XsdPath -NamespaceUri $InAppProductDescriptionNode.xmlns) -XmlFile $xmlFilePath # Assemble the Listing object # Nodes with one item can be immediately assigned $listing = @{ "title" = $InAppProductDescriptionNode.Title; "description" = $InAppProductDescriptionNode.Description; } # Identify the keys whose values are non-null and trim the values. # Must be done in two steps because $listings can't be modified # while enumerating its keys. $trimKeys = $listing.Keys | Where-Object { ($null -ne $listing[$_].InnerText) -or ($listing[$_] -is [String]) } $trimKeys | ForEach-Object { if ($null -ne $listing[$_].InnerText) { $listing[$_] = $listing[$_].InnerText } $listing[$_] = $listing[$_].Trim() } # For title specifically, we need to ensure that it's set to $null if there's # no value. An empty string value is not the same as $null. if ([String]::IsNullOrWhiteSpace($listing['title'])) { $listing['title'] = $null } # Handle the icon for the IAP. $imageFileName = $InAppProductDescriptionNode.icon.fileName if (-not [System.String]::IsNullOrWhiteSpace($imageFileName)) { $requestedFallbackLanguage = $InAppProductDescriptionNode.icon.FallbackLanguage if ([String]::IsNullOrWhiteSpace($requestedFallbackLanguage)) { $requestedFallbackLanguage = $MediaFallbackLanguage } $params = @{ 'Filename' = $imageFileName 'ImagesRootPath' = $ImagesRootPath 'Language' = $language 'Release' = $InAppProductDescriptionNode.Release 'MediaFallbackLanguage' = $requestedFallbackLanguage } $fileRelativePackagePath = Get-LocalizedMediaFile @params $iconListing += @{ "fileName" = $fileRelativePackagePath; "fileStatus" = "PendingUpload"; } $listing['icon'] = $iconListing } Write-Output @{ "lang" = $language.ToLowerInvariant(); "listing" = $listing } } catch [System.InvalidCastException] { $output = "Provided .xml file is not a valid .xml document: $xmlFilePath" Write-Log $output -Level Error throw $output } } } } } function Convert-InAppProductListingsMetadata { <# .SYNOPSIS Top-level function for consuming localized metadata about the In-App Product submission. Each language's .xml file, in a subfolder under XmlListingsRootPath, is parsed and added to the listings object with the language as the key. .PARAMETER PDPRootPath The root path to the directory containing language-specific subfolders holding the localized metadata. .PARAMETER PDPInclude The name of the XML file to be parsed (same for every language). Wildcards are allowed. It is okay to specify both 'PDPInclude' and 'PDPExclude'. .PARAMETER PDPExclude XML filenames to be excluded from parsing. Wildcards are allowed. It is okay to specify both 'PDPInclude' and 'PDPExclude'. .PARAMETER LanguageExclude Array of lang-code strings that SHOULD NOT be processed. .PARAMETER ImagesRootPath The root path to the directory where this submission's images are located. .PARAMETER MediaFallbackLanguage Some apps may not localize all of their metadata media (images, trailers, etc..) across all languages. By default, StoreBroker will look in the PDP langcode's subfolder within ImagesRootPath for that language's media content. If the requested filename is not found, StoreBroker packaging will fail. If you specify a fallback language here (e.g. 'en-us'), then if the requested file isn't found in the PDP language's media subfolder, StoreBroker will then look into the fallback language's media subfolder for the exactly same-named image, and only fail then if it still cannot be found. .OUTPUTS Hashtable A hastable with each key being a language and the corresponding value, an object containing localized data for the app (Title, Description, Icon, etc.) .EXAMPLE Convert-InAppProductListingsMetadata -PDPRootPath 'C:\PDP\' -PDPInclude 'InAppProductDescription.xml' -ImagesRootPath 'C:\IapIcons' Assumes the folder structure: C:\PDP\language1\...\InAppProductDescription.xml C:\PDP\language2\...\InAppProductDescription.xml #> [CmdletBinding()] [OutputType([Hashtable])] param( [Parameter(Mandatory)] [ValidateScript({ if (Test-Path -PathType Container -Path $_) { $true } else { throw "'$_' is not a directory or cannot be found." } })] [string] $PDPRootPath, [Parameter(Mandatory)] [AllowNull()] [AllowEmptyString()] [string[]] $PDPInclude, [Parameter(Mandatory)] [AllowNull()] [AllowEmptyString()] [string[]] $PDPExclude, [Parameter(Mandatory)] [AllowNull()] [AllowEmptyString()] [string[]] $LanguageExclude, [Parameter(Mandatory)] [ValidateScript({ if (Test-Path -PathType Container -Path $_) { $true } else { throw "'$_' is not a directory or cannot be found." } })] [Alias('MediaRootPath')] [string] $ImagesRootPath, [string] $MediaFallbackLanguage ) $listings = @{} Write-Log "Converting IAP listings metadata." -Level Verbose (Get-ChildItem -File $PDPRootPath -Recurse -Include $PDPInclude -Exclude $PDPExclude).FullName | Convert-InAppProductListingToObject -PDPRootPath $PDPRootPath -LanguageExclude $LanguageExclude -ImagesRootPath $ImagesRootPath -MediaFallbackLanguage $MediaFallbackLanguage | ForEach-Object { $listings[$_."lang"] = $_."listing" } Write-Log "Conversion complete." -Level Verbose return $listings } function Open-AppxContainer { <# .SYNOPSIS Given a path to a .appxbundle, .appxupload, or .appx file, unzips that file to a directory and returns that directory path. .PARAMETER AppxContainerPath Full path to the .appxbundle, .appxupload, or .appx file. .OUTPUTS System.String. Full path to the unzipped directory. .EXAMPLE Open-AppxContainer "C:\path\App.appxbundle" Unzips contents of App.appxbundle to <env:Temp>\<guid>\App\ and returns that path. .EXAMPLE Open-AppxContainer "C:\path\App.appxupload" Same as Example 1 only with a .appxupload file. .NOTES It is up to the client function to clean the path created by this function. If it is not cleaned, it will be included in the final .zip created by New-SubmissionPackage. #> param( [Parameter(Mandatory)] [string] $AppxContainerPath ) try { Add-Type -AssemblyName System.IO.Compression.FileSystem # .appxcontainer can be either .appxbundle, .appxupload, or .appx # Copy CONTAINER.appxcontainer to tempFolderPath\GUID.zip $containerZipPathFormat = Join-Path $env:TEMP '{0}.zip' do { $containerZipPath = $containerZipPathFormat -f [System.Guid]::NewGuid() } while (Test-Path -PathType Leaf -Path $containerZipPath) Write-Log "Copying (Item: $AppxContainerPath) to (Target: $containerZipPath)." -Level Verbose Copy-Item -Force -Path $AppxContainerPath -Destination $containerZipPath Write-Log "Copy complete." -Level Verbose # Expand CONTAINER.appxcontainer.zip to CONTAINER folder $expandedContainerPath = New-TemporaryDirectory Write-Log "Unzipping archive (Item: $containerZipPath) to (Target: $expandedContainerPath)." -Level Verbose [System.IO.Compression.ZipFile]::ExtractToDirectory($containerZipPath, $expandedContainerPath) Write-Log "Unzip complete." -Level Verbose return $expandedContainerPath } catch { if ((-not [System.String]::IsNullOrEmpty($expandedContainerPath)) -and (Test-Path $expandedContainerPath)) { Write-Log "Deleting item: $expandedContainerPath" -Level Verbose Remove-Item -Force -Recurse -Path $expandedContainerPath -ErrorAction SilentlyContinue Write-Log "Deletion complete." -Level Verbose } throw } finally { if ((-not [System.String]::IsNullOrEmpty($containerZipPath)) -and (Test-Path $containerZipPath)) { Write-Log "Deleting item: $containerZipPath" -Level Verbose Remove-Item -Force -Recurse -Path $containerZipPath -ErrorAction SilentlyContinue Write-Log "Deletion complete." -Level Verbose } } } function Report-UnsupportedFile { <# .SYNOPSIS When we discover an invalid file, raise a new telemetry event. .PARAMETER Path Filepath of the file that could not be identified. #> [CmdletBinding(SupportsShouldProcess)] [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseApprovedVerbs", "", Justification="Internal-only helper method. Best description for purpose.")] param( [Parameter(Mandatory)] [string] $Path ) if ($PSCmdlet.ShouldProcess($Path)) { $telemetryProperties = @{ [StoreBrokerTelemetryProperty]::SourceFilePath = (Get-PiiSafeString -PlainText $Path) } Set-TelemetryEvent -EventName New-SubmissionPackage-UnsupportedFile -Properties $telemetryProperties } } function New-ApplicationMetadataTable { <# .SYNOPSIS A simple utility function for creating a consistent metadata hastable. .DESCRIPTION A simple utility function for creating a consistent metadata hastable. The hashtable has keys for "version", "architecture", "targetPlatform", "languages", "capabilities", "targetDeviceFamilies", "targetDeviceFamiliesEx" and "innerPackages" .OUTPUTS Hashtable A hashtable with $null values and keys for the properties mentioned in the description. #> [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "", Justification="This doesn't change any system state...just creates a new object.")] param() $table = @{} foreach ($property in $script:applicationMetadataProperties) { $table[$property] = $null; } return $table } function Get-TargetPlatform { <# .SYNOPSIS Determines the target platform for a given AppxManifest.xml. .DESCRIPTION Determines the target platform for a given AppxManifest.xml. Returns one of "Windows10", "Windows81", "Windows80", "WindowsPhone81", or $null .PARAMETER AppxManifestPath A path to the AppxManifest.xml file to be processed. .OUTPUTS String A string identifying the target platform, or $null if it could not be identified. .EXAMPLE Get-TargetPlatform -AppxManifestPath "C:\package\AppxManifest.xml" Indentifies the target platform for the given AppxManifest.xml #> param( [Parameter(Mandatory)] [ValidateScript({ if (Test-Path -PathType Leaf -Include "AppxManifest.xml" -Path $_) { $true } else { throw "$_ cannot be found or is not an AppxManifest.xml." } })] [string] $AppxManifestPath ) $manifest = [xml] (Get-Content -Path $AppxManifestPath -Encoding UTF8) $root = $manifest.DocumentElement if ($root.xmlns -match "^http://schemas.microsoft.com/appx/manifest/(.*/)?windows10(/.*)?$") { return "Windows10" } $minOSVersion = $root.Prerequisites.OSMinVersion if ([String]::IsNullOrEmpty($minOSVersion)) { Write-Log "Could not find OSMinVersion in [$AppxManifestPath]" -Level Warning return $null } $targetPlatform = "Windows" if ($null -ne $root.PhoneIdentity) { $targetPlatform += "Phone" } # The Store also supports WindowsPhone70/71/80 but those apps # are .xap files which we do not support. switch -wildcard ($minOSVersion) { "6.3.*" { $targetPlatform += "81" } "6.2.*" { $targetPlatform += "80" } default { return $null } } return $targetPlatform } function Read-AppxMetadata { <# .SYNOPSIS Reads various metadata properties about the input .appx file. .DESCRIPTION Reads various metadata properties about the input .appx file. The metadata read is "version", "architecture", "targetPlatform", "languages", "capabilities", "targetDeviceFamilies", "targetDeviceFamiliesEx" and "innerPackages". Not all of the metadata read is actually passed as part of the Store submission; some metadata is used as part of an app flighting workflow. .PARAMETER AppxPath A path to the .appx file to be processed. .PARAMETER AppxInfo If provided, will be updated to maintain information about the app being packaged (like AppName and Version) if the information can be determined. .OUTPUTS Hasthable A hashtable containing the various metadata values. .EXAMPLE Read-AppxMetadata -AppxPath ".\my.appx" -AppxInfo ([ref] @()) Returns a hashtable containing metadata about the .appx file. #> [CmdletBinding(SupportsShouldProcess)] param( [Parameter(Mandatory)] [ValidateScript({ if (Test-Path -PathType Leaf -Include "*.appx" -Path $_) { $true } else { throw "$_ cannot be found or is not an .appx." } })] [string] $AppxPath, [ref] $AppxInfo ) $metadata = New-ApplicationMetadataTable try { $expandedAppxPath = Open-AppxContainer -AppxContainerPath $AppxPath # Get AppxManifest.xml $appxManifest = (Get-ChildItem -Recurse -Path $expandedAppxPath -Include 'AppxManifest.xml').FullName if ($null -eq $appxManifest) { Report-UnsupportedFile -Path $AppxPath throw "`"$AppxPath`" is not a proper .appx. Could not find an AppxManifest.xml." } Write-Log "Opening `"$appxManifest`"." -Level Verbose $manifest = [xml] (Get-Content -Path $appxManifest -Encoding UTF8) # Processing $metadata.version = $manifest.Package.Identity.Version $metadata.architecture = $manifest.Package.Identity.ProcessorArchitecture $metadata.targetPlatform = Get-TargetPlatform -AppxManifestPath $appxManifest $metadata.name = $manifest.Package.Identity.Name -creplace '^Microsoft\.', '' $metadata.languages = @() $metadata.languages += $manifest.Package.Resources.Resource.Language | Where-Object { $null -ne $_ } | ForEach-Object { $_.ToLower() } | Sort-Object -Unique $metadata.capabilities = @() $metadata.capabilities += $manifest.Package.Capabilities.Capability.Name | Where-Object { $null -ne $_ } | Sort-Object -Unique $metadata.targetDeviceFamiliesEx = @() $metadata.targetDeviceFamiliesEx += $manifest.Package.Dependencies.TargetDeviceFamily | Where-Object { $null -ne $_.Name } | Sort-Object -Property Name -Unique | ForEach-Object { [PSCustomObject]@{ 'name' = $_.Name; 'minOSVersion' = $_.MinVersion } } $metadata.targetDeviceFamilies = @() foreach ($family in $metadata.targetDeviceFamiliesEx) { $metadata.targetDeviceFamilies += ($script:minVersionFormatString -f $family.Name, $family.minOSVersion) } # A single .appx will never have an inner package, but we will still set this property to # an empty hashtable so that the value is never $null when translated to JSON $metadata.innerPackages = @{} # Track the info about this package for later processing. $singleAppxInfo = @{} $singleAppxInfo[[StoreBrokerTelemetryProperty]::AppxVersion] = $metadata.version $singleAppxInfo[[StoreBrokerTelemetryProperty]::AppName] = $metadata.name $AppxInfo.Value += $singleAppxInfo } finally { if (-not [String]::IsNullOrWhiteSpace($expandedAppxPath)) { Write-Log "Deleting item: $expandedAppxPath" -Level Verbose Remove-Item -Force -Recurse -Path $expandedAppxPath -ErrorAction SilentlyContinue | Out-Null Write-Log "Deletion complete." -Level Verbose } } return $metadata } function Read-AppxUploadMetadata { <# .SYNOPSIS Reads various metadata properties about the input .appxupload. .DESCRIPTION Reads various metadata properties about the input .appxupload. The metadata read is "version", "architecture", "targetPlatform", "languages", "capabilities", "targetDeviceFamilies", "targetDeviceFamiliesEx" and "innerPackages". Not all of the metadata read is actually passed as part of the Store submission; some metadata is used as part of an app flighting workflow. As part of processing the .appxupload, the file is opened to read metadata from the inner .appx or .appxbundle file. There must be exactly one inner .appx or .appxbundle. .PARAMETER AppxuploadPath A path to the .appxupload to be processed. .PARAMETER AppxInfo If provided, will be updated to maintain information about the app being packaged (like AppName and Version) if the information can be determined. .OUTPUTS Hasthable A hashtable containing the various metadata values. .EXAMPLE Read-AppxUploadMetadata -AppxbundlePath ".\my.appxupload" -AppxInfo ([ref] @()) Returns a hashtable containing metadata about the inner .appx file. .NOTES An .appxupload file is just a .zip containing an .appxsym file and a single .appx or .appxbundle. We only care about the inner .appx or .appxbundle. #> [CmdletBinding(SupportsShouldProcess)] param( [Parameter(Mandatory)] [ValidateScript({ if (Test-Path -PathType Leaf -Include "*.appxupload" -Path $_) { $true } else { throw "$_ cannot be found or is not an .appxupload." } })] [string] $AppxuploadPath, [ref] $AppxInfo ) try { $throwFormat = "`"$AppxuploadPath`" is not a proper .appxupload. There must be exactly one {0} inside the file." Write-Log "Opening `"$AppxuploadPath`"." -Level Verbose $expandedContainerPath = Open-AppxContainer -AppxContainerPath $AppxPath $appxFilePath = (Get-ChildItem -Recurse -Path $expandedContainerPath -Include "*.appx").FullName if ($null -ne $appxFilePath) { if ($appxFilePath.Count -ne 1) { Report-UnsupportedFile -Path $AppxuploadPath $error = $throwFormat -f ".appx" Write-Log $error -Level Error throw $error } else { return Read-AppxMetadata -AppxPath $appxFilePath -AppxInfo $AppxInfo } } # Could not find an .appx inside. Maybe there is an .appxbundle. $appxbundleFilePath = (Get-ChildItem -Recurse -Path $expandedContainerPath -Include "*.appxbundle").FullName if (($null -eq $appxbundleFilePath) -or ($appxbundleFilePath.Count -ne 1)) { Report-UnsupportedFile -Path $AppxuploadPath $error = $throwFormat -f ".appx or .appxbundle" Write-Log $error -Level Error throw $error } else { return Read-AppxBundleMetadata -AppxbundlePath $appxbundleFilePath -AppxInfo $AppxInfo } } finally { if (-not [String]::IsNullOrWhiteSpace($expandedContainerPath)) { Write-Log "Deleting item: $expandedContainerPath" -Level Verbose Remove-Item -Force -Recurse -Path $expandedContainerPath -ErrorAction SilentlyContinue | Out-Null Write-Log "Deletion complete." -Level Verbose } } } function Read-AppxBundleMetadata { <# .SYNOPSIS Reads various metadata properties about the input .appxbundle. .DESCRIPTION Reads various metadata properties about the input .appxbundle. The metadata read is "version", "architecture", "targetPlatform", "languages", "capabilities", "targetDeviceFamilies", "targetDeviceFamiliesEx" and "innerPackages". Not all of the metadata read is actually passed as part of the Store submission; some metadata is used as part of an app flighting workflow. As part of processing the .appxbundle, the file is opened to read metadata from the inner .appx files. .PARAMETER AppxbundlePath A path to the .appxbundle to be processed. .PARAMETER AppxInfo If provided, will be updated to maintain information about the app being packaged (like AppName and Version) if the information can be determined. .OUTPUTS Hasthable A hashtable containing the various metadata values. .EXAMPLE Read-AppxBundleMetadata -AppxbundlePath ".\my.appxbundle" -AppxInfo ([ref] @()) Returns a hashtable containing metadata about the .appxbundle and .appx files inside that bundle. #> [CmdletBinding(SupportsShouldProcess)] param( [Parameter(Mandatory)] [ValidateScript({ if (Test-Path -PathType Leaf -Include "*.appxbundle" -Path $_) { $true } else { throw "$_ cannot be found or is not an .appxbundle." } })] [string] $AppxbundlePath, [ref] $AppxInfo ) $metadata = New-ApplicationMetadataTable try { $expandedContainerPath = Open-AppxContainer -AppxContainerPath $AppxbundlePath # Get AppxBundleManifest.xml $bundleManifestPath = (Get-ChildItem -Recurse -Path $expandedContainerPath -Include 'AppxBundleManifest.xml').FullName if ($null -eq $bundleManifestPath) { Report-UnsupportedFile -Path $AppxbundlePath throw "`"$AppxbundlePath`" is not a proper .appxbundle. Could not find an AppxBundleManifest.xml." } Write-Log "Opening `"$bundleManifestPath`"." -Level Verbose $manifest = [xml] (Get-Content -Path $bundleManifestPath -Encoding UTF8) # Processing $metadata.version = $manifest.Bundle.Identity.Version $metadata.architecture = "Neutral" # always 'Neutral' for .appxbundle $metadata.name = $manifest.Bundle.Identity.Name -creplace '^Microsoft\.', '' $languages = ($manifest.Bundle.Packages.Package | Where-Object Type -like "resource").Resources.Resource.Language | Where-Object { $null -ne $_ } | ForEach-Object { $_.ToLower() } | Sort-Object -Unique $metadata.languages = if ($null -eq $languages) { @() } else { $languages } # These properties will be aggregated from the individual .appx files $metadata.innerPackages = @{} $metadata.capabilities = @() $metadata.targetDeviceFamilies = @() $metadata.targetDeviceFamiliesEx = @() $capabilities = @() $targetDeviceFamilies = @() $targetDeviceFamiliesEx = @() $applications = ($manifest.Bundle.Packages.ChildNodes | Where-Object Type -like "application").FileName foreach ($application in $applications) { $appxFilePath = (Get-ChildItem -Recurse -Path $expandedContainerPath -Include $application).FullName $appxMetadata = Read-AppxMetadata -AppxPath $appxFilePath -AppxInfo $AppxInfo # targetPlatform will always be the values of the last .appx processed. $metadata.targetPlatform = $appxMetadata.targetPlatform $capabilities += $appxMetadata.capabilities $targetDeviceFamilies += $appxMetadata.targetDeviceFamilies $targetDeviceFamiliesEx += $appxMetadata.targetDeviceFamiliesEx $metadata.innerPackages.$($appxMetadata.architecture) = @{ version = $appxMetadata.version; targetDeviceFamiliesEx = $appxMetadata.targetDeviceFamiliesEx targetDeviceFamilies = $appxMetadata.targetDeviceFamiliesEx | ForEach-Object { $script:minVersionFormatString -f $_.name, $_.minOSVersion } languages = $appxMetadata.languages; capabilities = $appxMetadata.capabilities; targetPlatform = $appxMetadata.targetPlatform; } } # Guarantee uniqueness # We use += instead of assignment, in order to guarantee these properties remain Array type. # $m.capabilities = @("foo") | Sort-Object -Unique # results in $m.capabilities being a String type instead of Array type. $metadata.capabilities += $capabilities | Sort-Object -Unique $metadata.targetDeviceFamilies += $targetDeviceFamilies | Sort-Object -Unique # https://stackoverflow.com/questions/31343752/how-can-you-select-unique-objects-based-on-two-properties-of-an-object-in-powers $metadata.targetDeviceFamiliesEx += $targetDeviceFamiliesEx | Group-Object -Property name, minOSVersion | ForEach-Object { $_.Group | Select-Object -Property name, minOSVersion -First 1 } } finally { if (-not [String]::IsNullOrWhiteSpace($expandedContainerPath)) { Write-Log "Deleting item: $expandedContainerPath" -Level Verbose Remove-Item -Force -Recurse -Path $expandedContainerPath -ErrorAction SilentlyContinue | Out-Null Write-Log "Deletion complete." -Level Verbose } } return $metadata } function Get-FormattedFilename { <# .SYNOPSIS Gets the ManifestType_AppName_Version_Architecture formatted filename for the specified .appxbundle, .appxupload, or .appx. .DESCRIPTION Gets the ManifestType_AppName_Version_Architecture formatted filename for the specified .appxbundle, .appxupload, or .appx. ManifestType is specified by each .appx and includes "Desktop", "Mobile", "Universal", "Team". AppName is specified in the Identity element of the AppxManifest.xml file. Version is specified in the Identity element of the AppxManifest.xml file. Architecture is specified in the Identity element of the AppxManifest.xml file. .PARAMETER Metadata A hashtable with "targetDeviceFamiliesEx", "name", "version", and "architecture". If the metadata table corresponds to an .appxbundle, there will likely be an "innerPackages" value with metadata from the inner .appx files. .OUTPUTS System.String. The ManifestType_AppName_Version_Architecture string. .EXAMPLE Get-FormattedFilename @{ name="Maps"; version="2.13.22002.0"; architecture="x86"; targetDeviceFamiliesEx=@(@{ name = "Windows.Desktop"); minOSVersion="1.2.3.0" } } Would return something like "Desktop_Maps_2.13.22002.0_x86.appxupload" #> [CmdletBinding(SupportsShouldProcess)] param( [Parameter(Mandatory)] [ValidateScript( { $throwFormat = "Invalid metadata table. {0}." if ([String]::IsNullOrEmpty($_.name)) { throw ($throwFormat -f "No name") } if ([String]::IsNullOrEmpty($_.version)) { throw ($throwFormat -f "No version") } if ([String]::IsNullOrEmpty($_.architecture)) { throw ($throwFormat -f "No architecture") } return $true } )] [hashtable] $Metadata ) # Categories with several items are joined with a '.' separator $architectureTag = $Metadata.architecture $version = $Metadata.version if ($Metadata.innerPackages.Count -gt 0) { # For .appxbundle packages, we will use the architectures from the individual .appx files. # The Keys of the innerPackages object are the supported architectures. $architectureTag = ($Metadata.innerPackages.Keys | Sort-Object) -join '.' # Grab an arbitrary one and use that version. $arch = $Metadata.innerPackages.Keys | Sort-Object | Select-Object -First 1 $version = $Metadata.innerPackages.$arch.version } # Simplify 'Windows.Universal' to 'Universal' $deviceFamilyCollection = $Metadata.targetDeviceFamiliesEx.Name | ForEach-Object { $_ -replace '^Windows\.', '' } $formattedBundleTags = @($Metadata.name, $version, $architectureTag) if ($deviceFamilyCollection.Count -gt 0) { $formattedBundleTags = @(($deviceFamilyCollection | Sort-Object) -join '.') + $formattedBundleTags } # Categories are joined with a '_' separator return $formattedBundleTags -join '_' } function Read-ApplicationMetadata { <# .SYNOPSIS Reads metadata used for submission of an .appx, .appxbundle, or appxupload. .DESCRIPTION Reads metadata used for submission of an .appx, .appxbundle, or appxupload. The metadata read is "version", "architecture", "targetPlatform", "languages", "capabilities", "targetDeviceFamilies", "targetDeviceFamiliesEx", "innerPackages", and "name". Not all of the metadata read is actually passed as part of the Store submission; some metadata is used as part of an app flighting workflow. After reading the metadata for the input package, this function also creates a formatted name for the input package when it is stored in the StoreBroker .zip output. .PARAMETER AppxPath The path to the .appx, .appxbundle, or .appxupload to process. .PARAMETER AppxInfo If provided, will be updated to maintain information about the app being packaged (like AppName and Version) if the information can be determined. .EXAMPLE Read-ApplicationMetadata -AppxPath ".\my.appxbundle" -AppxInfo ([ref] @()) Returns a hashtable containing metadata about the .appxbundle and .appx files inside that bundle. .OUTPUTS Hashtable A hashtable containing the various metadata that was read. #> [CmdletBinding(SupportsShouldProcess)] param( [Parameter(Mandatory)] [ValidateScript({ if (Test-Path -PathType Leaf -Include ($script:supportedExtensions | ForEach-Object { "*" + $_ }) $_) { $true } else { throw "$_ cannot be found or is not a supported extension: $($script:supportedExtensions -join ", ")." } })] [string] $AppxPath, [ref] $AppxInfo ) if ($PSCmdlet.ShouldProcess($AppxPath)) { $metadata = $null switch ([System.IO.Path]::GetExtension($AppxPath)) { ".appxbundle" { $metadata = Read-AppxBundleMetadata -AppxbundlePath $AppxPath -AppxInfo $AppxInfo } ".appxupload" { $metadata = Read-AppxUploadMetadata -AppxuploadPath $AppxPath -AppxInfo $AppxInfo } ".appx" { $metadata = Read-AppxMetadata -AppxPath $AppxPath -AppxInfo $AppxInfo } } $metadata.formattedFileName = Get-FormattedFilename -Metadata $metadata return $metadata } } function Add-AppPackagesMetadata { <# .SYNOPSIS Adds a property to the SubmissionObject with metadata about the various .appxbundle, .appxupload, or .appx files being submitted. .PARAMETER AppxPath Array of full paths to the .appxbundle, .appxupload, or .appx files that will be uploaded as the new submission. .PARAMETER SubmissionObject A PSCustomObj representing the application submission request body. This function will add a property to this object with metadata about the .appx files being uploaded. .PARAMETER AppxInfo If provided, will be updated to maintain information about the app being packaged (like AppName and Version) if the information can be determined. .PARAMETER EnableAutoPackageNameFormatting If specified, the packages will be renamed using a consistent naming scheme, which embeds the application name, version, as well as targeted platform and architecture. .EXAMPLE Add-AppPackagesMetadata -AppxPath "C:\App.appxbundle" -SubmissionObject $object Adds metadata about "C:\App.appxbundle" to the $object object. .EXAMPLE $object | Add-AppPackagesMetadata -AppxPath "C:\x86\App_x86.appxbundle" Same as Example 1 except the $object object is piped in to the function and the appxbundle used is for x86 architecture. #> [CmdletBinding(SupportsShouldProcess)] param( [Parameter(Mandatory)] [ValidateScript({ foreach ($path in $_) { if (-not (Test-Path -PathType Leaf -Include ($script:supportedExtensions | ForEach-Object { "*" + $_ }) -Path $path)) { throw "$_ is not a file or cannot be found." } } return $true })] [string[]] $AppxPath, [Parameter( Mandatory, ValueFromPipeline)] [PSCustomObject] $SubmissionObject, [ref] $AppxInfo, [switch] $EnableAutoPackageNameFormatting ) $SubmissionObject | Add-Member -MemberType NoteProperty -Name "applicationPackages" -Value ([System.Array]::CreateInstance([Object], 0)) foreach ($path in $AppxPath) { if ($PSCmdlet.ShouldProcess($path)) { Write-Log "Processing [$path]" -Level Verbose $appxName = Split-Path -Leaf -Path $path # We always calculate the formatted name, even if we won't use it, in order to # populate $AppxInfo with the additional metadata. $appMetadata = Read-ApplicationMetadata -AppxPath $path -AppxInfo $AppxInfo if ($EnableAutoPackageNameFormatting) { $appxName = ($appMetadata.formattedFileName + [System.IO.Path]::GetExtension($appxName)) } # Finalize the properties to be submitted $submissionProperties = @{} foreach ($property in $script:applicationMetadataProperties) { $submissionProperties.$property = $appMetadata.$property } $submissionProperties.fileName = $appxName $submissionProperties.fileStatus = "PendingUpload" $submissionProperties.minimumDirectXVersion = "None" $submissionProperties.minimumSystemRam = "None" $appPackageObject = New-Object System.Object | Add-Member -PassThru -NotePropertyMembers $submissionProperties if ($script:tempFolderExists) { $destinationPath = Join-Path $script:tempFolderPath $appxName Write-Log "Copying (Item: $path) to (Target: $destinationPath)" -Level Verbose Copy-Item -Path $path -Destination $destinationPath Write-Log "Copy complete." -Level Verbose } $SubmissionObject.applicationPackages += $appPackageObject } } } function Remove-DeprecatedProperties { <# .SYNOPSIS Returns back a modified version of the submission request body that has removed any properties that have been deprecated by the Store team. .PARAMETER SubmissionRequestBody A PSCustomObject representing the submission request body that may contain properties that have been deprecated. .OUTPUTS PSCustomObject An object representing the full application submission request, with deprecated properties removed. .EXAMPLE $updated = Remove-DeprecatedProperties $submissionRequestBody Scans the provided request body, and returns back a modified version that has any deprecated properties removed. #> [CmdletBinding()] [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseSingularNouns", "", Justification="This is intended to be where all deprecated properties are removed. It's an accurate name.")] [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "", Justification="Does not cause any change to system state. No value gained from ShouldProcess in this specific instance.")] param( [Parameter(Mandatory)] [PSCustomObject] $SubmissionRequestBody ) # No side-effects. We'll work off of a copy of the passed-in object $requestBody = DeepCopy-Object $SubmissionRequestBody # hardwareRequirements was deprecated on 5/13/2016 # Deprecated due to business reasons. This field is not exposed from the UI. $requestBody.PSObject.Properties.Remove('hardwareRequirements') return $requestBody } function Get-SubmissionRequestBody { <# .SYNOPSIS Creates a PSCustomObject representing the JSON that will be sent with an application submission request. Some property values are taken from the config file, some are given static values, some depend on the arch-specific .appx files being submitted, and some are retrieved from localized metadata. .PARAMETER ConfigObj A PSCustomObject representing this tool's configuration file. Some values of the submission are populated in the config file and retrieved here. .PARAMETER PDPRootPath Root path to the directory containing lang-code subfolders of PDPs to be processed. .PARAMETER Release Optional. When specified, it is used to indicate the correct subfolder within 'PDPRootPath' to find the PDP files to use. .PARAMETER PDPInclude PDP filenames that SHOULD be processed. Wildcards are allowed, eg "ProductDescription*.xml". It is fine to specify both "PDPInclude" and "PDPExclude". .PARAMETER PDPExclude PDP filenames that SHOULD NOT be processed. Wildcards are allowed, eg "ProductDescription*.xml". It is fine to specify both "PDPInclude" and "PDPExclude". .PARAMETER LanguageExclude Array of lang-code strings that SHOULD NOT be processed. .PARAMETER ImagesRootPath Root path to the directory containing release subfolders of images to be packaged. .PARAMETER AppxPath A list of file paths to be included in the package. .PARAMETER AppxInfo If provided, will be updated to maintain information about the app being packaged (like AppName and Version) if the information can be determined. .PARAMETER DisableAutoPackageNameFormatting By default, the packages will be renamed using a consistent naming scheme, which embeds the application name, version, as well as targeted platform and architecture. To retain the existing package filenames, specify this switch. .PARAMETER MediaFallbackLanguage Some apps may not localize all of their metadata media (images, trailers, etc..) across all languages. By default, StoreBroker will look in the PDP langcode's subfolder within ImagesRootPath for that language's media content. If the requested filename is not found, StoreBroker packaging will fail. If you specify a fallback language here (e.g. 'en-us'), then if the requested file isn't found in the PDP language's media subfolder, StoreBroker will then look into the fallback language's media subfolder for the exactly same-named image, and only fail then if it still cannot be found. .OUTPUTS PSCustomObject An object representing the full application submission request. .NOTES It is expected that at least one path is missing from the map as 'AppxPath' is mutually exclusive with the remaining three path types. .EXAMPLE Get-SubmissionRequestBody "C:\App\Appx.appxupload" (Get-Content $ConfigPath -Encoding UTF8 | ConvertFrom-Json) Retrieves the submission request generated using the config file at $ConfigPath and the appxupload located at "C:\App\Appx.appxupload". .EXAMPLE (Get-Content $ConfigPath -Encoding UTF8 | ConvertFrom-Json) | Get-SubmissionRequestBody -AppxPath "C:\Appx_x86.appxbundle", "C:\Appx_arm.appxbundle" -Release MarchRelease Retrieves the submission request generated using the config file at $ConfigPath and the appxbundle files located at "C:\Appx_x86.appxbundle" and "C:\Appx_arm.appxbundle". The Release used for finding PDPs under 'PDPRootPath' is MarchRelease. #> [CmdletBinding(SupportsShouldProcess)] [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")] param( [Parameter(Mandatory)] [PSCustomObject] $ConfigObject, [string] $PDPRootPath, [string] $Release, [string[]] $PDPInclude, [string[]] $PDPExclude, [string[]] $LanguageExclude, [Alias('MediaRootPath')] [string] $ImagesRootPath, [string[]] $AppxPath, [ref] $AppxInfo, [switch] $DisableAutoPackageNameFormatting, [string] $MediaFallbackLanguage ) # Add static properties and metadata about packaged binaries. $submissionRequestBody = $ConfigObject.appSubmission if ($AppxPath.Count -gt 0) { $submissionRequestBody | Add-AppPackagesMetadata -AppxPath $AppxPath -AppxInfo $AppxInfo -EnableAutoPackageNameFormatting:(-not $DisableAutoPackageNameFormatting) } if (-not [String]::IsNullOrWhiteSpace($PDPRootPath)) { $submissionRequestBody | Add-Member -MemberType NoteProperty -Name "listings" -Value (New-Object System.Object) # Add listings information $listingsPath = $PDPRootPath # If 'Release' is present, no need to look within a sub-folder.. if (-not [System.String]::IsNullOrWhiteSpace($Release)) { $pathWithRelease = Join-Path -Path $PDPRootPath -ChildPath $Release if (Test-Path -PathType Container -Path $pathWithRelease) { $listingsPath = $pathWithRelease } else { $out = @() $out += "'$pathWithRelease' is not a valid directory or cannot be found." $out += "Check the values of '$script:s_PDPRootPath' and '$script:s_Release' and try again." $newLineOutput = ($out -join [Environment]::NewLine) Write-Log $newLineOutput -Level Error throw $newLineOutput } } $listingsResources = @{ $script:s_PDPRootPath = $listingsPath; $script:s_PDPInclude = $PDPInclude; $script:s_PDPExclude = $PDPExclude; $script:s_LanguageExclude = $LanguageExclude; $script:s_ImagesRootPath = $ImagesRootPath; $script:s_MediaFallbackLanguage = $MediaFallbackLanguage; } $submissionRequestBody.listings = Convert-ListingsMetadata @listingsResources } $submissionRequestBody = Remove-DeprecatedProperties -SubmissionRequestBody $submissionRequestBody $submissionRequestBody | Add-Member -Name $script:schemaPropertyName -Value $script:appSchemaVersion -MemberType NoteProperty return $submissionRequestBody } function Get-InAppProductSubmissionRequestBody { <# .SYNOPSIS Creates a PSCustomObject representing the JSON that will be sent with an In-App Product submission request. Some property values are taken from the config file, some are given static values, and some are retrieved from localized metadata. .PARAMETER ConfigObj A PSCustomObject representing this tool's configuration file. Some values of the submission are populated in the config file and retrieved here. .PARAMETER PDPRootPath Root path to the directory containing lang-code subfolders of PDPs to be processed. .PARAMETER Release Optional. When specified, it is used to indicate the correct subfolder within 'PDPRootPath' to find the PDP files to use. .PARAMETER PDPInclude PDP filenames that SHOULD be processed. Wildcards are allowed, eg "InAppProductDescription*.xml". It is fine to specify both "PDPInclude" and "PDPExclude". .PARAMETER PDPExclude PDP filenames that SHOULD NOT be processed. Wildcards are allowed, eg "InAppProductDescription*.xml". It is fine to specify both "PDPInclude" and "PDPExclude". .PARAMETER LanguageExclude Array of lang-code strings that SHOULD NOT be processed. .PARAMETER ImagesRootPath Root path to the directory containing release subfolders of images to be packaged. .PARAMETER MediaFallbackLanguage Some apps may not localize all of their metadata media (images, trailers, etc..) across all languages. By default, StoreBroker will look in the PDP langcode's subfolder within ImagesRootPath for that language's media content. If the requested filename is not found, StoreBroker packaging will fail. If you specify a fallback language here (e.g. 'en-us'), then if the requested file isn't found in the PDP language's media subfolder, StoreBroker will then look into the fallback language's media subfolder for the exactly same-named image, and only fail then if it still cannot be found. .OUTPUTS PSCustomObject An object representing the full In-App Product submission request. .EXAMPLE Get-InAppProductSubmissionRequestBody (Get-Content $ConfigPath -Encoding UTF8 | ConvertFrom-Json) Retrieves the submission request generated using the config file at $ConfigPath. .EXAMPLE (Get-Content $ConfigPath -Encoding UTF8 | ConvertFrom-Json) | Get-InAppProductSubmissionRequestBody -Release MarchRelease Retrieves the submission request generated using the config file at $ConfigPath. The Release used for finding PDPs under 'PDPRootPath' is MarchRelease. #> [CmdletBinding(SupportsShouldProcess)] [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")] param( [Parameter(Mandatory)] [PSCustomObject] $ConfigObject, [string] $PDPRootPath, [string] $Release, [string[]] $PDPInclude, [string[]] $PDPExclude, [string[]] $LanguageExclude, [Alias('MediaRootPath')] [string] $ImagesRootPath, [string] $MediaFallbackLanguage ) # Add static properties and metadata about packaged binaries. $submissionRequestBody = $ConfigObject.iapSubmission if (-not [String]::IsNullOrWhiteSpace($PDPRootPath)) { $submissionRequestBody | Add-Member -MemberType NoteProperty -Name "listings" -Value (New-Object System.Object) # Add listings information $listingsPath = $PDPRootPath # If 'Release' is present, no need to look within a sub-folder.. if (-not [System.String]::IsNullOrWhiteSpace($Release)) { $pathWithRelease = Join-Path -Path $PDPRootPath -ChildPath $Release if (Test-Path -PathType Container -Path $pathWithRelease) { $listingsPath = $pathWithRelease } else { $out = @() $out += "'$pathWithRelease' is not a valid directory or cannot be found." $out += "Check the values of '$script:s_PDPRootPath' and '$script:s_Release' and try again." $newLineOutput = ($out -join [Environment]::NewLine) Write-Log $newLineOutput -Level Error throw $newLineOutput } } $listingsResources = @{ $script:s_PDPRootPath = $listingsPath; $script:s_PDPInclude = $PDPInclude; $script:s_PDPExclude = $PDPExclude; $script:s_LanguageExclude = $LanguageExclude; $script:s_ImagesRootPath = $ImagesRootPath; $script:s_MediaFallbackLanguage = $MediaFallbackLanguage; } $submissionRequestBody.listings = Convert-InAppProductListingsMetadata @listingsResources } $submissionRequestBody | Add-Member -Name $script:schemaPropertyName -Value $script:iapSchemaVersion -MemberType NoteProperty return $submissionRequestBody } function Resolve-PackageParameters { <# .SYNOPSIS Ensures all required values for New-SubmissionPackage exist. .DESCRIPTION Ensures all required values for New-SubmissionPackage exist. If a parameter is not provided at runtime, this function will check the config for a value. If there is no valid value in the config, then it will throw an exception. .PARAMETER ConfigObject Object representation of the config file passed to New-SubmissionPackage .PARAMETER ParamMap Hashtable mapping the parameters of New-SubmissionPackage (except for ConfigPath) to their provided values. .PARAMETER SkipValidation An array of parameters that this method should not attempt to validate. .OUTPUTS Hashtable with keys "PDPRootPath", "Release", "PDPInclude", "PDPExclude", "ImagesRootPath", "MediaFallbackLanguage", "AppxPath", "OutPath", and "OutName", each with validated values. .EXAMPLE Resolve-PackagePaths -ConfigObject (Convert-AppConfig $ConfigPath) -ParamMap @{"AppxPath"=$null;"OutPath"=$null;"OutPath"=$null;"Release"=$null} Attempts to validate the "AppxPath", "OutPath", "OutName", and "Release" parameters by checking the config file for values. #> [CmdletBinding()] [OutputType([Hashtable])] [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseSingularNouns", "", Justification="This is resolving multiple parameters at once. There is no option for resolving a single parameter.")] param( [Parameter(Mandatory)] [PSCustomObject] $ConfigObject, [Parameter(Mandatory)] [Hashtable] $ParamMap, [String[]] $SkipValidation = @() ) # Generic fail message. Format with parameter name. $out = @() $out += "No value found for parameter '{0}'" $out += "Provide a value at runtime or in the config file." $out = $out -join [Environment]::NewLine # Generic value from config message. Format with parameter name and value $fromConfig = "`tUsing config value: {0} = `"{1}`"" # 'PDPRootPath' and 'ImagesRootPath' are optional. # Check if there is a runtime or config value. foreach ($param in $script:s_PDPRootPath, $script:s_ImagesRootPath) { if ([String]::IsNullOrWhiteSpace($ParamMap[$param])) { $configVal = $ConfigObject.packageParameters.$param if (-not [String]::IsNullOrWhiteSpace($configVal)) { $ParamMap[$param] = $configVal Write-Log ($fromConfig -f $param, $configVal) -Level Verbose } } # Check if user specified a path but the directory does not exist $ParamMap[$param] = $ParamMap[$param] | Where-Object { -not [String]::IsNullOrWhiteSpace($_) } if (-not [String]::IsNullOrWhiteSpace($ParamMap[$param])) { # Resolve path parameters to full paths. Necessary in case a path contains '.' or '..' $ParamMap[$param] = Resolve-UnverifiedPath -Path $ParamMap[$param] if (-not (Test-Path -PathType Container -Path $ParamMap[$param])) { $out = "$($param): `"$($ParamMap[$param])`" is not a directory or cannot be found." Write-Log $out -Level Error throw $out } } } if (($SkipValidation -inotcontains $script:s_PDPRootPath) -and ($SkipValidation -inotcontains $script:s_ImagesRootPath)) { # If either 'PDPRootPath' or 'ImagesRootPath' is present, both must be present if ((-not [String]::IsNullOrWhiteSpace($ParamMap[$script:s_PDPRootPath])) -xor (-not [String]::IsNullOrWhiteSpace($ParamMap[$script:s_ImagesRootPath]))) { $out = @() $out += "Only one of '$script:s_PDPRootPath' and '$script:s_ImagesRootPath' was specified." $out += "If one of these parameters is specified, then both must be specified." $newLineOutput = ($out -join [Environment]::NewLine) Write-Log $newLineOutput -Level Error throw $newLineOutput } } if ($SkipValidation -inotcontains $script:s_OutPath) { # 'OutPath' is mandatory. if ([System.String]::IsNullOrWhiteSpace($ParamMap[$script:s_OutPath])) { $configVal = $ConfigObject.packageParameters.OutPath if ([System.String]::IsNullOrWhiteSpace($configVal)) { $output = ($out -f $script:s_OutPath) Write-Log $output -Level Error throw $output } else { $ParamMap[$script:s_OutPath] = $configVal Write-Log ($fromConfig -f $script:s_OutPath, $configVal) -Level Verbose } } # Resolve path parameters to full paths. Necessary in case a path contains '.' or '..' $ParamMap[$script:s_OutPath] = Resolve-UnverifiedPath -Path $ParamMap[$script:s_OutPath] } if ($SkipValidation -inotcontains $script:s_OutName) { # 'OutName' is mandatory. if ([System.String]::IsNullOrWhiteSpace($ParamMap[$script:s_OutName])) { $configVal = $ConfigObject.packageParameters.OutName if ([System.String]::IsNullOrWhiteSpace($configVal)) { $output = ($out -f $script:s_OutName) Write-Log $output -Level Error throw $output } else { $ParamMap[$script:s_OutName] = $configVal Write-Log ($fromConfig -f $script:s_OutName, $configVal) -Level Verbose } } } # 'Release' is optional. # Look for a value but do not fail if none is found. if ([String]::IsNullOrWhiteSpace($ParamMap[$script:s_Release])) { $configVal = $ConfigObject.packageParameters.Release if (-not [String]::IsNullOrWhiteSpace($configVal)) { $ParamMap[$script:s_Release] = $configVal Write-Log ($fromConfig -f $script:s_Release, $configVal) -Level Verbose } } # 'LanguageExclude', 'PDPInclude', and 'PDPExclude' are optional. # They are arrays and so need to be handled differently foreach ($param in $script:s_PDPInclude, $script:s_PDPExclude, $script:s_LanguageExclude) { if ($ParamMap[$param].Count -eq 0) { $configVal = $ConfigObject.packageParameters.$param if ($configVal.Count -gt 0) { $ParamMap[$param] = $configVal Write-Log ($fromConfig -f $param, ($configVal -join ', ')) -Level Verbose } } # Make sure we don't have null/empty strings $ParamMap[$param] = $ParamMap[$param] | Where-Object { -not [String]::IsNullOrWhiteSpace($_) } } # Set 'PDPInclude' default if empty if ($ParamMap[$script:s_PDPInclude].Count -eq 0) { $ParamMap[$script:s_PDPInclude] = @("*.xml") Write-Log "`tUsing default value: $script:s_PDPInclude = `"*.xml`"" -Level Verbose } if ($SkipValidation -inotcontains $script:s_AppxPath) { # 'AppxPath' is mandatory. if ($ParamMap[$script:s_AppxPath].Count -eq 0) { $packagePaths = @() $validExtensions = $script:supportedExtensions | ForEach-Object { "*" + $_ } foreach ($path in $ConfigObject.packageParameters.AppxPath) { if ((Test-Path -PathType Leaf -Include $validExtensions -Path $path) -and ($path -notin $packagePaths)) { $packagePaths += $path } elseif ([System.String]::IsNullOrWhiteSpace($env:TFS_DropLocation)) { $out = @() $out += "`"$path`" is not a file or cannot be found." $out += "See the `"$script:s_AppxPath`" object in the config file." $newLineOutput = ($out -join [Environment]::NewLine) Write-Log $newLineOutput -Level Error throw $newLineOutput } else { $path = Join-Path $env:TFS_DropLocation $path if ((Test-Path -PathType Leaf -Include $validExtensions -Path $path) -and ($path -notin $packagePaths)) { $packagePaths += $path } elseif (Test-Path -PathType Container -Path $path) { $fullPaths = (Get-ChildItem -File -Include $validExtensions -Path (Join-Path $path "*.*")).FullName foreach ($fullPath in $fullPaths) { if ($fullPath -notin $packagePaths) { $packagePaths += $fullPath } } } else { $out = @() $out += "Could not find a file with a supported extension ($($script:supportedExtensions -join ", ")) using the relative path: '$path'." $out += "See the `"$script:s_AppxPath`" object in the config file." $newLineOutput = ($out -join [Environment]::NewLine) Write-Log $newLineOutput -Level Error throw $newLineOutput } } } $ParamMap[$script:s_AppxPath] = $packagePaths $quotedVals = $packagePaths | ForEach-Object { "`"$_`"" } Write-Log ($fromConfig -f $script:s_AppxPath, ($quotedVals -join ', ')) -Level Verbose } # Resolve AppxPath to a list of full paths. $ParamMap[$script:s_AppxPath] = $ParamMap[$script:s_AppxPath] | ForEach-Object { Resolve-UnverifiedPath -Path $_ } } if ($SkipValidation -inotcontains $script:s_DisableAutoPackageNameFormatting) { # Switches always have a concrete value ($true or $false). Therefore, we'll only consider a # switch to have been passed-in from the command-line (thus, overriding the config's value) # if its value is $true. if (-not $ParamMap[$script:s_DisableAutoPackageNameFormatting]) { $configVal = $ConfigObject.packageParameters.DisableAutoPackageNameFormatting if ([System.String]::IsNullOrWhiteSpace($configVal)) { $configVal = $false } $ParamMap[$script:s_DisableAutoPackageNameFormatting] = $configVal Write-Log ($fromConfig -f $script:s_DisableAutoPackageNameFormatting, $configVal) -Level Verbose } } # 'MediaFallbackLanguage' is optional. # Look for a value but do not fail if none is found. if ([String]::IsNullOrWhiteSpace($ParamMap[$script:s_MediaFallbackLanguage])) { $configVal = $ConfigObject.packageParameters.MediaFallbackLanguage if (-not [String]::IsNullOrWhiteSpace($configVal)) { $ParamMap[$script:s_MediaFallbackLanguage] = $configVal Write-Log ($fromConfig -f $script:s_MediaFallbackLanguage, $configVal) -Level Verbose } } return $ParamMap } filter Remove-Comment { <# .SYNOPSIS Removes in-line comments starting with the comment delimiter (default is two forward-slashes "//"). Also removes any lines with only white-space. .PARAMETER CommentDelimiter String specifying the comment delimiter to use. Default is two forward-slashes, i.e. "//" .PARAMETER Line The lines to be filtered. Normally this filter receives the lines as input from the pipeline. .OUTPUTS System.Object[] The filtered collection of lines .EXAMPLE "example", "test // input", "// remove this" | Remove-Comment "example", "test " #> [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "", Justification="Does not cause any change to system state. No value gained from ShouldProcess in this specific instance.")] param( [string] $CommentDelimiter = "//", [Parameter( Mandatory, ValueFromPipeline)] [AllowEmptyString()] # Mandatory parameters usually do not allow empty string, causing an error. Allow them but filter them out. [string[]] $Line ) # Filter text following the comment delimiter, empty lines, and lines that are only whitespace. $Line | ForEach-Object { ($_ -split $CommentDelimiter)[0] } | Where-Object { $_ -notmatch '^\s*$' } } function Convert-AppConfig { <# .SYNOPSIS Opens the specified config file, removes comments, and returns the contents as a PSCustomObject .PARAMETER ConfigPath Full path to a .json file which will be interpreted as the Packaging Tool's config file .OUTPUTS PSCustomObject .EXAMPLE Convert-AppConfig -ConfigPath 'C:\Some\Path\MapsConfig.json' Returns MapsConfig.json represented as a PSCustomObject #> param( [Parameter(Mandatory)] [ValidateScript({ if (Test-Path -PathType Leaf $_) { $true } else { throw "$_ cannot be found." } })] [string] $ConfigPath ) $lines = (Get-Content -Path $ConfigPath -Encoding UTF8 | Remove-Comment) -join '' return ($lines | ConvertFrom-Json) } function Join-SubmissionPackage { <# .SYNOPSIS Merges the specified content from an ancillary StoreBroker payload into the master payload. .DESCRIPTION Merges the specified content from an ancillary StoreBroker payload into the master payload. This is most useful in the scenario where you have packages that are coming from different builds that should all be part of the same Store submission update. Users will only specify the .json files for the two payloads, with the expectation that the .zip will be at the same location and same name as its complementary .json file. The Git repo for this module can be found here: https://aka.ms/StoreBroker .PARAMETER MasterJsonPath The path to the .json file for the StoreBroker payload that will receive the additional specified content from AdditionalJsonPath. The .zip for this payload should be located in the same folder with the same root name. .PARAMETER AdditionalJsonPath The path to the .json file for the StoreBroker payload whose specified content will be merged into MasterJsonPath. The .zip for this payload should be located in the same folder with the same root name. .PARAMETER OutJsonPath The path to the .json file that should contain the merged content. A .zip file with the same root name will be placed here as well. .PARAMETER AddPackages If specified, the packages from AdditionalJsonPath will be merged with those in MasterJsonPath .EXAMPLE Join-SubmissionPackage c:\SBCallingRS1.json c:\SBCallingTH2.json c:\SBCallingMerged.json -AddPackages Creates a new json called c:\SBCallingMerged.json that is a direct copy of c:\SBCallingRS1.json. The application package entries from c:\SBCallingTH2.json will be copied into there, and the actual packages from c:\SBCallingTH2.zip will be copied into c:\SBCallingMerged.zip #> [CmdletBinding(SupportsShouldProcess=$True)] param( [Parameter(Mandatory=$true)] [ValidateScript({if (Test-Path -Path $_ -PathType Leaf) { $true } else { throw "$_ cannot be found." }})] [string] $MasterJsonPath, [Parameter(Mandatory=$true)] [ValidateScript({if (Test-Path -Path $_ -PathType Leaf) { $true } else { throw "$_ cannot be found." }})] [string] $AdditionalJsonPath, [Parameter(Mandatory=$true)] [ValidateScript({if (Test-Path -Path $_ -PathType Leaf) { throw "$_ already exists. Choose a different name." } else { $true }})] [string] $OutJsonPath, [switch] $AddPackages ) Add-Type -AssemblyName System.IO.Compression.FileSystem # Fix the paths $MasterJsonPath = Resolve-UnverifiedPath -Path $MasterJsonPath $AdditionalJsonPath = Resolve-UnverifiedPath -Path $AdditionalJsonPath # Determine the paths to the zip files for these json files $masterZipPath = Join-Path (Split-Path $MasterJsonPath -Parent) "$([System.IO.Path]::GetFileNameWithoutExtension($MasterJsonPath)).zip" $additionalZipPath = Join-Path (Split-Path $AdditionalJsonPath -Parent) "$([System.IO.Path]::GetFileNameWithoutExtension($AdditionalJsonPath)).zip" $outZipPath = Join-Path (Split-Path $OutJsonPath -Parent) "$([System.IO.Path]::GetFileNameWithoutExtension($OutJsonPath)).zip" # Make sure that these zip files actually exist. foreach ($zipFile in ($masterZipPath, $additionalZipPath)) { if (-not (Test-Path -Path $zipFile -PathType Leaf)) { throw "Could not find [$zipFile]. We expect the .json and .zip to have the same base name." } } # Make sure that the output one *doesn't* exist if (Test-Path -Path $outZipPath -PathType Leaf) { throw "[$outZipPath] already exists. Please choose a different name." } # Warn the user if they didn't specify anything to actually get merged in. # At the moment, the only switch supported is AddPackages, but this may change over time. if (-not $AddPackages) { $output = @() $output += "You have not specified any `"modification`" switch for joining the packages." $output += "This means that the new package payload will be identical to the Master [$MasterJsonPath]." $output += "If this was not your intention, please read-up on the documentation for this command:" $output += " Get-Help Join-PackagePayload -ShowWindow" Write-Log $($output -join [Environment]::NewLine) -Level Warning } # Unpack the zips # out zip content will be based off of master, so we can just consider master's zip as "out" $outUnpackedZipPath = New-TemporaryDirectory if ($PSCmdlet.ShouldProcess($masterZipPath, "Unzip")) { Write-Log "Unzipping archive [$masterZipPath] to [$outUnpackedZipPath]" -Level Verbose [System.IO.Compression.ZipFile]::ExtractToDirectory($masterZipPath, $outUnpackedZipPath) Write-Log "Unzip complete." -Level Verbose } $additionalUnpackedZipPath = New-TemporaryDirectory if ($PSCmdlet.ShouldProcess($additionalZipPath, "Unzip")) { Write-Log "Unzipping archive [$additionalZipPath] to [$additionalUnpackedZipPath]" -Level Verbose [System.IO.Compression.ZipFile]::ExtractToDirectory($additionalZipPath, $additionalUnpackedZipPath) Write-Log "Unzip complete." -Level Verbose } # out json content will be based off of master, so we can just consider master's json as "out" $outJsonContent = (Get-Content -Path $MasterJsonPath -Encoding UTF8) | ConvertFrom-Json $additionalJsonContent = (Get-Content -Path $AdditionalJsonPath -Encoding UTF8) | ConvertFrom-Json if ($AddPackages) { # We copy over all package changes from the "AdditionalJson", including package removals, # package uploads and specified retention of existing packages. Write-Log "Adding applicationPackages from [$AdditionalJsonPath] to [$OutJsonPath]" -Level Verbose $outJsonContent.applicationPackages += $additionalJsonContent.applicationPackages # Copy packages from Additional over to Master foreach ($package in $additionalJsonContent.applicationPackages) { # Error if the same filename already exists. # We'll only try to copy over files that are marked as PendingUpload since those are # the only new ones that the API will attempt to process. if ($package.fileStatus -eq "PendingUpload") { $destPath = Join-Path $outUnpackedZipPath $package.fileName if (Test-Path $destPath -PathType Leaf) { $output = "A package called [$($package.fileName)] already exists in the Master zip file." Write-Log $output -Level Error throw $output } $sourcePath = Join-Path $additionalUnpackedZipPath $package.fileName Write-Log "Copying [$sourcePath] to [$destPath]" -Level Verbose Copy-Item -Path $sourcePath -Destination $destPath Write-Log "Copy complete." -Level Verbose } } } # Zip up out directory to $outZipPath Out-DirectoryToZip -Path $outUnpackedZipPath -Destination $outZipPath # Output the merged json if ($PSCmdlet.ShouldProcess($OutJsonPath, "Create json")) { Write-Log "Writing merged JSON file: [$OutJsonPath]." -Level Verbose $outJsonContent | ConvertTo-Json -Depth $script:jsonConversionDepth -Compress | Out-File -Encoding utf8 -FilePath $OutJsonPath Write-Log "Write complete." -Level Verbose } # Clean up the temp directories Write-Log "Cleaning up temp directories..." -Level Verbose Remove-Item -Path $outUnpackedZipPath -Recurse -Force -ErrorAction SilentlyContinue Remove-Item -Path $additionalUnpackedZipPath -Recurse -Force -ErrorAction SilentlyContinue Write-Log "Cleaning up temp directories complete." -Level Verbose } function New-SubmissionPackage { <# .SYNOPSIS Top-level function for creating an application submission's JSON body and .zip package for upload. .DESCRIPTION Creates the JSON body for a submission request. Localized listing metadata is taken from the path specified in the config file. The .appxbundle, .appxupload, and .appx files are given via the [-AppxPath] parameter. In the process of creating the JSON, the packaging tool also copies any specified images and .appx files to a .zip file. The .json and .zip files generated by this tool are given the common name specified by the [-OutName] parameter. The Git repo for this module can be found here: https://aka.ms/StoreBroker .PARAMETER ConfigPath Full path to the JSON file the Packaging Tool will use as the configuration file. .PARAMETER PDPRootPath There are two supported layouts for your PDP files: 1. <PDPRootPath>\<lang-code>\...\PDP.xml 2. <PDPRootPath>\<Release>\<lang-code>\...\PDP.xml The only difference between these two is that there is a <Release> directory after the <PDPRootPath> and before the <lang-code> sub-directories. The first layout is generally used when your localization system will be downloading the localized PDP files during your build. In that situation, it's always retrieving the latest version. Alternatively, if the latest localized versions of your PDP files are always stored in the same location, this layout is also for you. On the other hand, if you will be archiving the localized PDP's based on each release to the Store, then the second layout is the one that you should use. In this scenario, you will specify the value of "<Release>" immediately below, or at the commandline. .PARAMETER Release Optional. When specified, it is used to indicate the correct subfolder within 'PDPRootPath' to find the PDP files to use. .PARAMETER PDPInclude PDP filenames that SHOULD be processed. If not specified, the default is to process any XML files found in sub-directories of [-PDPRootPath]. Wildcards are allowed, eg "ProductDescription*.xml". It is fine to specify both "PDPInclude" and "PDPExclude". .PARAMETER PDPExclude PDP filenames that SHOULD NOT be processed. Wildcards are allowed, eg "ProductDescription*.xml". It is fine to specify both "PDPInclude" and "PDPExclude". .PARAMETER LanguageExclude Array of lang-code strings that SHOULD NOT be processed. .PARAMETER ImagesRootPath Your store screenshots must be placed with this structure: <ImagesRootPath>\<Release>\<lang-code>\...\img.png The 'Release' that will be used is NOT the value specified to StoreBroker, it is the 'Release' value found in the corresponding PDP file. .PARAMETER AppxPath Array of full paths to the architecture-neutral .appxbundle, .appxupload, or .appx files that will be uploaded as the new submission. .PARAMETER OutPath Full path to a directory where the Packaging Tool can write the .json submission request body and .zip package to upload. .PARAMETER OutName Common name to give to the .json and .zip files outputted by the Packaging Tool. .PARAMETER DisableAutoPackageNameFormatting By default, the packages will be renamed using a consistent naming scheme, which embeds the application name, version, as well as targeted platform and architecture. To retain the existing package filenames, specify this switch. .PARAMETER MediaFallbackLanguage Some apps may not localize all of their metadata media (images, trailers, etc..) across all languages. By default, StoreBroker will look in the PDP langcode's subfolder within ImagesRootPath for that language's media content. If the requested filename is not found, StoreBroker packaging will fail. If you specify a fallback language here (e.g. 'en-us'), then if the requested file isn't found in the PDP language's media subfolder, StoreBroker will then look into the fallback language's media subfolder for the exactly same-named image, and only fail then if it still cannot be found. .EXAMPLE New-SubmissionPackage -ConfigPath 'C:\Config\StoreBrokerConfig.json' -OutPath 'C:\Out\Path\' -OutName 'Upload' -Release MarchRelease -AppxPath 'C:\bin\App.appxbundle' This example creates the submission request body and .zip file for the architecture-neutral '.appxbundle' located at 'C:\bin\App.appxbundle'. Two files will be placed under 'C:\Out\Path\', 'Upload.json' and 'Upload.zip' .EXAMPLE New-SubmissionPackage -ConfigPath 'C:\Config\StoreBrokerConfig.json' -OutPath 'C:\Out\Path\' -OutName 'Upload' -Release MarchRelease -AppxPath 'C:\bin\App.appxbundle' -Verbose This example is the same except it specifies Verbose logging and the function will output a detailed report of its actions. .EXAMPLE New-SubmissionPackage -ConfigPath 'C:\Config\StoreBrokerConfig.json' -OutPath 'C:\Out\Path\' -OutName 'Upload' -Release MarchRelease -AppxPath 'C:\bin\x86\App_x86.appxupload', 'C:\Other\Path\Arm\App_arm.appxupload' This example is the same except it specifies an x86 and Arm build. Multiple files to include can be passed to 'AppxPath' by separating with a comma. #> [CmdletBinding(SupportsShouldProcess)] param( [Parameter(Mandatory)] [ValidateScript({ if (Test-Path -PathType Leaf $_) { $true } else { throw "$_ cannot be found." } })] [string] $ConfigPath, [ValidateScript({ if (Test-Path -PathType Container $_) { $true } else { throw "$_ cannot be found." } })] [string] $PDPRootPath, [string] $Release, [string[]] $PDPInclude, [string[]] $PDPExclude, [string[]] $LanguageExclude, [ValidateScript({ if (Test-Path -PathType Container $_) { $true } else { throw "$_ cannot be found." } })] [Alias('MediaRootPath')] [string] $ImagesRootPath, [ValidateScript({ foreach ($path in $_) { if (-not (Test-Path -PathType Leaf -Include ($script:supportedExtensions | ForEach-Object { "*" + $_ }) -Path $path)) { throw "$_ cannot be found or is not a supported extension: $($script:supportedExtensions -join ", ")." } } return $true })] [string[]] $AppxPath, [string] $OutPath, [string] $OutName, [switch] $DisableAutoPackageNameFormatting, [string] $MediaFallbackLanguage ) $stopwatch = [System.Diagnostics.Stopwatch]::StartNew() try { Add-Type -AssemblyName System.IO.Compression.FileSystem # Preamble before printing invocation parameters Write-Log "New-SubmissionPackage invoked with parameters:" -Level Verbose Write-Log "`t$script:s_ConfigPath = `"$ConfigPath`"" -Level Verbose # Check the value of each parameter and add to parameter hashtable if not null. # Resolve-PackageParameters will take care of validating the values, we only need # to avoid splatting null values as this will generate a runtime exception. # Log the value of each parameter. $validationSet = $script:s_PDPRootPath, $script:s_Release, $script:s_PDPInclude, $script:s_PDPExclude, $script:s_LanguageExclude, $script:s_ImagesRootPath, $script:s_AppxPath, $script:s_OutPath, $script:s_OutName, $script:s_DisableAutoPackageNameFormatting, $script:s_MediaFallbackLanguage $packageParams = @{} foreach ($param in $validationSet) { $val = Get-Variable -Name $param -ValueOnly -ErrorAction SilentlyContinue | Where-Object { -not [String]::IsNullOrWhiteSpace($_) } # ([string] $null) -ne $null, is true. # Explicitly check the type of the value to avoid printing [string] params that are $null. if ((($val -isnot [System.String]) -and ($null -ne $val)) -or (($val -is [System.String]) -and (-not [String]::IsNullOrWhiteSpace($val)))) { $packageParams[$param] = $val # Treat the value as if it is an array. # If it's not, it will still pretty print fine. $quotedVals = $val | ForEach-Object { "`"$_`"" } Write-Log "`t$param = $($quotedVals -join ', ')" -Level Verbose } } # Convert the Config.json $config = Convert-AppConfig -ConfigPath $ConfigPath # Check that all parameters are provided or specified in the config $validatedParams = Resolve-PackageParameters -ConfigObject $config -ParamMap $packageParams # Assign final, validated params $validationSet | Where-Object { $null -ne $validatedParams[$_] } | ForEach-Object { Set-Variable -Name $_ -Value $validatedParams[$_] -ErrorAction SilentlyContinue } # Create a temp directory to work in $script:tempFolderPath = New-TemporaryDirectory # It may not actually exist due to What-If support. $script:tempFolderExists = (-not [System.String]::IsNullOrEmpty($script:tempFolderPath)) -and (Test-Path -PathType Container $script:tempFolderPath) # Get the submission request object $resourceParams = $script:s_PDPRootPath, $script:s_Release, $script:s_PDPInclude, $script:s_PDPExclude, $script:s_LanguageExclude, $script:s_ImagesRootPath, $script:s_AppxPath, $script:s_DisableAutoPackageNameFormatting, $script:s_MediaFallbackLanguage # Note: PSScriptAnalyzer falsely flags this next line as PSUseDeclaredVarsMoreThanAssignment due to: # https://github.com/PowerShell/PSScriptAnalyzer/issues/699 $params = Get-Variable -Name $resourceParams -ErrorAction SilentlyContinue | ForEach-Object { $m = @{} } { $m[$_.Name] = $_.Value } { $m } # foreach begin{} process{} end{} $AppxInfo = @() $submissionBody = Get-SubmissionRequestBody -ConfigObject $config -AppxInfo ([ref]$AppxInfo) @params Write-SubmissionRequestBody -JsonObject $submissionBody -OutFilePath (Join-Path $OutPath ($OutName + '.json')) # Zip the contents of the temporary directory. Then delete the temporary directory. if ($script:tempFolderExists) { $zipPath = Join-Path -Path $OutPath -ChildPath ($OutName + '.zip') Out-DirectoryToZip -Path $script:tempFolderPath -Destination $zipPath } # Record the telemetry for this event. $stopwatch.Stop() $telemetryMetrics = @{ [StoreBrokerTelemetryMetric]::Duration = $stopwatch.Elapsed.TotalSeconds } # We may have app info for multiple packages. Let's normalize it. # By the very nature of how the Store works, all the packages have to be for the same app. # There can be multiple versions being submitted in a single submission. For our purposes, # we'll just use the last processed appx for this submission...that should be good enough. $telemetryProperties = @{} if ($AppxInfo.Count -gt 0) { $telemetryProperties = $AppxInfo[$AppxInfo.Count - 1] } Set-TelemetryEvent -EventName New-SubmissionPackage -Properties $telemetryProperties -Metrics $telemetryMetrics } catch { # We may have app info for multiple packages. Let's normalize it. # By the very nature of how the Store works, all the packages have to be for the same app. # There can be multiple versions being submitted in a single submission. For our purposes, # we'll just use the last processed appx for this submission...that should be good enough. $telemetryProperties = @{} if ($AppxInfo.Count -gt 0) { $telemetryProperties = $AppxInfo[$AppxInfo.Count - 1] } Set-TelemetryException -Exception $_.Exception -ErrorBucket "New-SubmissionPackage" -Properties $telemetryProperties Write-Log $($_.Exception.Message) -Level Error throw } finally { if ($script:tempFolderExists) { Write-Log "Deleting temporary directory: $script:tempFolderPath" -Level Verbose Remove-Item -Force -Recurse $script:tempFolderPath -ErrorAction SilentlyContinue Write-Log "Deleting temporary directory complete." -Level Verbose } } } function New-InAppProductSubmissionPackage { <# .SYNOPSIS Top-level function for creating an in-app product submission's JSON body and .zip package for upload. .DESCRIPTION Creates the JSON body for a submission request. Localized listing metadata is taken from the path specified in the config file. In the process of creating the JSON, the packaging tool also copies any specified images to a .zip file. The .json and .zip files generated by this tool are given the common name specified by the [-OutName] parameter. The Git repo for this module can be found here: https://aka.ms/StoreBroker .PARAMETER ConfigPath Full path to the JSON file the Packaging Tool will use as the configuration file. .PARAMETER PDPRootPath There are two supported layouts for your PDP files: 1. <PDPRootPath>\<lang-code>\...\PDP.xml 2. <PDPRootPath>\<Release>\<lang-code>\...\PDP.xml The only difference between these two is that there is a <Release> directory after the <PDPRootPath> and before the <lang-code> sub-directories. The first layout is generally used when your localization system will be downloading the localized PDP files during your build. In that situation, it's always retrieving the latest version. Alternatively, if the latest localized versions of your PDP files are always stored in the same location, this layout is also for you. On the other hand, if you will be archiving the localized PDP's based on each release to the Store, then the second layout is the one that you should use. In this scenario, you will specify the value of "<Release>" immediately below, or at the commandline. .PARAMETER Release Optional. When specified, it is used to indicate the correct subfolder within 'PDPRootPath' to find the PDP files to use. .PARAMETER PDPInclude PDP filenames that SHOULD be processed. If not specified, the default is to process any XML files found in sub-directories of [-PDPRootPath]. Wildcards are allowed, eg "InAppProductDescription*.xml". It is fine to specify both "PDPInclude" and "PDPExclude". .PARAMETER PDPExclude PDP filenames that SHOULD NOT be processed. Wildcards are allowed, eg "InAppProductDescription*.xml". It is fine to specify both "PDPInclude" and "PDPExclude". .PARAMETER LanguageExclude Array of lang-code strings that SHOULD NOT be processed. .PARAMETER ImagesRootPath Your icons must be placed with this structure: <ImagesRootPath>\<Release>\<lang-code>\...\icon.png The 'Release' that will be used is NOT the value specified to StoreBroker, it is the 'Release' value found in the corresponding PDP file. .PARAMETER OutPath Full path to a directory where the Packaging Tool can write the .json submission request body and .zip package to upload. .PARAMETER OutName Common name to give to the .json and .zip files outputted by the Packaging Tool. .PARAMETER MediaFallbackLanguage Some apps may not localize all of their metadata media (images, trailers, etc..) across all languages. By default, StoreBroker will look in the PDP langcode's subfolder within ImagesRootPath for that language's media content. If the requested filename is not found, StoreBroker packaging will fail. If you specify a fallback language here (e.g. 'en-us'), then if the requested file isn't found in the PDP language's media subfolder, StoreBroker will then look into the fallback language's media subfolder for the exactly same-named image, and only fail then if it still cannot be found. .EXAMPLE New-InAppProductSubmissionPackage -ConfigPath 'C:\Config\StoreBrokerIAPConfig.json' -OutPath 'C:\Out\Path\' -OutName 'Upload' -Release MarchRelease This example creates the submission request body and .zip file for the IAP.Two files will be placed under 'C:\Out\Path\', 'Upload.json' and 'Upload.zip' .EXAMPLE New-InAppProductSubmissionPackage -ConfigPath 'C:\Config\StoreBrokerIAPConfig.json' -OutPath 'C:\Out\Path\' -OutName 'Upload' -Release MarchRelease -Verbose This example is the same except it specifies Verbose logging and the function will output a detailed report of its actions. #> [CmdletBinding(SupportsShouldProcess)] [Alias('New-IapSubmissionPackage')] param( [Parameter(Mandatory)] [ValidateScript({ if (Test-Path -PathType Leaf $_) { $true } else { throw "$_ cannot be found." } })] [string] $ConfigPath, [ValidateScript({ if (Test-Path -PathType Container $_) { $true } else { throw "$_ cannot be found." } })] [string] $PDPRootPath, [string] $Release, [string[]] $PDPInclude, [string[]] $PDPExclude, [string[]] $LanguageExclude, [ValidateScript({ if (Test-Path -PathType Container $_) { $true } else { throw "$_ cannot be found." } })] [Alias('MediaRootPath')] [string] $ImagesRootPath, [string] $OutPath, [string] $OutName, [string] $MediaFallbackLanguage ) $stopwatch = [System.Diagnostics.Stopwatch]::StartNew() try { Add-Type -AssemblyName System.IO.Compression.FileSystem # Preamble before printing invocation parameters Write-Log "New-InAppProductSubmissionPackage invoked with parameters:" -Level Verbose Write-Log "`t$script:s_ConfigPath = `"$ConfigPath`"" -Level Verbose # Check the value of each parameter and add to parameter hashtable if not null. # Resolve-PackageParameters will take care of validating the values, we only need # to avoid splatting null values as this will generate a runtime exception. # Log the value of each parameter. $validationSet = $script:s_PDPRootPath, $script:s_Release, $script:s_PDPInclude, $script:s_PDPExclude, $script:s_LanguageExclude, $script:s_ImagesRootPath, $script:s_OutPath, $script:s_OutName, $script:s_MediaFallbackLanguage $packageParams = @{} foreach ($param in $validationSet) { $val = Get-Variable -Name $param -ValueOnly -ErrorAction SilentlyContinue | Where-Object { -not [String]::IsNullOrWhiteSpace($_) } # ([string] $null) -ne $null, is true. # Explicitly check the type of the value to avoid printing [string] params that are $null. if ((($val -isnot [System.String]) -and ($null -ne $val)) -or (($val -is [System.String]) -and (-not [String]::IsNullOrWhiteSpace($val)))) { $packageParams[$param] = $val # Treat the value as if it is an array. # If it's not, it will still pretty print fine. $quotedVals = $val | ForEach-Object { "`"$_`"" } Write-Log "`t$param = $($quotedVals -join ', ')" -Level Verbose } } # Convert the Config.json $config = Convert-AppConfig -ConfigPath $ConfigPath # Check that all parameters are provided or specified in the config $validatedParams = Resolve-PackageParameters -ConfigObject $config -ParamMap $packageParams -SkipValidation @($script:s_DisableAutoPackageNameFormatting, $script:s_AppxPath) # Assign final, validated params $validationSet | Where-Object { $null -ne $validatedParams[$_] } | ForEach-Object { Set-Variable -Name $_ -Value $validatedParams[$_] -ErrorAction SilentlyContinue } # Create a temp directory to work in $script:tempFolderPath = New-TemporaryDirectory # It may not actually exist due to What-If support. $script:tempFolderExists = (-not [System.String]::IsNullOrEmpty($script:tempFolderPath)) -and (Test-Path -PathType Container $script:tempFolderPath) # Get the submission request object $resourceParams = $script:s_PDPRootPath, $script:s_Release, $script:s_PDPInclude, $script:s_PDPExclude, $script:s_LanguageExclude, $script:s_ImagesRootPath, $script:s_MediaFallbackLanguage # Note: PSScriptAnalyzer falsely flags this next line as PSUseDeclaredVarsMoreThanAssignment due to: # https://github.com/PowerShell/PSScriptAnalyzer/issues/699 $params = Get-Variable -Name $resourceParams -ErrorAction SilentlyContinue | ForEach-Object { $m = @{} } { $m[$_.Name] = $_.Value } { $m } # foreach begin{} process{} end{} $submissionBody = Get-InAppProductSubmissionRequestBody -ConfigObject $config @params Write-SubmissionRequestBody -JsonObject $submissionBody -OutFilePath (Join-Path -Path $OutPath -ChildPath ($OutName + '.json')) # Zip the contents of the temporary directory. Then delete the temporary directory. if ($script:tempFolderExists) { $zipPath = Join-Path -Path $OutPath -ChildPath ($OutName + '.zip') Out-DirectoryToZip -Path $script:tempFolderPath -Destination $zipPath } # Record the telemetry for this event. $stopwatch.Stop() $telemetryMetrics = @{ [StoreBrokerTelemetryMetric]::Duration = $stopwatch.Elapsed.TotalSeconds } Set-TelemetryEvent -EventName New-InAppProductSubmissionPackage -Metrics $telemetryMetrics } catch { Set-TelemetryException -Exception $_.Exception -ErrorBucket "New-InAppProductSubmissionPackage" Write-Log $($_.Exception.Message) -Level Error throw } finally { if ($script:tempFolderExists) { Write-Log "Deleting temporary directory: $script:tempFolderPath" -Level Verbose Remove-Item -Force -Recurse $script:tempFolderPath -ErrorAction SilentlyContinue Write-Log "Deleting temporary directory complete." -Level Verbose } } } # SIG # Begin signature block # MIIdrwYJKoZIhvcNAQcCoIIdoDCCHZwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB # gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR # AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUCCLLLh8/Fv8P0l54HL30WJ7c # LNugghhTMIIEwjCCA6qgAwIBAgITMwAAAMM7uBDWq3WchAAAAAAAwzANBgkqhkiG # 9w0BAQUFADB3MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4G # A1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSEw # HwYDVQQDExhNaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EwHhcNMTYwOTA3MTc1ODUx # WhcNMTgwOTA3MTc1ODUxWjCBsjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hp # bmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jw # b3JhdGlvbjEMMAoGA1UECxMDQU9DMScwJQYDVQQLEx5uQ2lwaGVyIERTRSBFU046 # RDIzNi0zN0RBLTk3NjExJTAjBgNVBAMTHE1pY3Jvc29mdCBUaW1lLVN0YW1wIFNl # cnZpY2UwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCiOG2wDGVZj5ZH # gCl0ZaExy6HZQZ9T2uupPuxqtiWqXH2oIj762GqMc1JPYHkpEo5alygWdvB3D6FS # qpA8al+mGJTMktlA+ydstLPRr6CBoEF+hm6RBzwVlsN9z6BVppwIZWt2lEVG6r1Y # W1y1rb0d4FsA8qwRSI0sB8sAw9IHXi/J4Jd6klQvw2m6oLXl9C73/1DldPPZYGOT # DQ98RxIaYewvksnNqblmvFpOx8Kuedkxl4jtAKl0F/2+QqRfU32OAiCiYFgZIgOP # B4A8UbHmLIyn7pNqtom4NqMiZz9G4Bm5bwILhElYcZPMq/P1Hr38/WoAD99WAm3W # FpXSFZejAgMBAAGjggEJMIIBBTAdBgNVHQ4EFgQUc3cXeGMQ8QV4IbaO4PEw84WH # F6gwHwYDVR0jBBgwFoAUIzT42VJGcArtQPt2+7MrsMM1sw8wVAYDVR0fBE0wSzBJ # oEegRYZDaHR0cDovL2NybC5taWNyb3NvZnQuY29tL3BraS9jcmwvcHJvZHVjdHMv # TWljcm9zb2Z0VGltZVN0YW1wUENBLmNybDBYBggrBgEFBQcBAQRMMEowSAYIKwYB # BQUHMAKGPGh0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2kvY2VydHMvTWljcm9z # b2Z0VGltZVN0YW1wUENBLmNydDATBgNVHSUEDDAKBggrBgEFBQcDCDANBgkqhkiG # 9w0BAQUFAAOCAQEASOPK1ntqWwaIWnNINY+LlmHQ4Q88h6TON0aE+6cZ2RrjBUU4 # 9STkyQ2lgvKpmIkQYWJbuNRh65IJ1HInwhD8XWd0f0JXAIrzTlL0zw3SdbrtyZ9s # P4NxqyjQ23xBiI/d13CrtfTAVlGYIY1Ahl80+0KGyuUzJLTi9350/gHaI0Jz3irw # rJ+htxF1UW/NT0AYJyRYe2el9JhgeudeKOKav3fQBlzALQmk4Ekoyq3muJHGoqfe # No4zsP/M+WQ6oBMlUq8/49sg/ryuP0EeVtNiePuxPmX5i6Knzpd3rPgKPS+9Tq1d # KLts1K4rjpASoKSs8Ubv3rwQSw0O/zTd1bc8EjCCBgAwggPooAMCAQICEzMAAADD # Dpun2LLc9ywAAAAAAMMwDQYJKoZIhvcNAQELBQAwfjELMAkGA1UEBhMCVVMxEzAR # BgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1p # Y3Jvc29mdCBDb3Jwb3JhdGlvbjEoMCYGA1UEAxMfTWljcm9zb2Z0IENvZGUgU2ln # bmluZyBQQ0EgMjAxMTAeFw0xNzA4MTEyMDIwMjRaFw0xODA4MTEyMDIwMjRaMHQx # CzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRt # b25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xHjAcBgNVBAMTFU1p # Y3Jvc29mdCBDb3Jwb3JhdGlvbjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC # ggEBALtX1zjRsQZ/SS2pbbNjn3q6tjohW7SYro3UpIGgxXXFLO+CQCq3gVN382MB # CrzON4QDQENXgkvO7R+2/YBtycKRXQXH3FZZAOEM61fe/fG4kCe/dUr8dbJyWLbF # SJszYgXRlZSlvzkirY0STUZi2jIZzqoiXFZIsW9FyWd2Yl0wiKMvKMUfUCrZhtsa # ESWBwvT1Zy7neR314hx19E7Mx/znvwuARyn/z81psQwLYOtn5oQbm039bUc6x9nB # YWHylRKhDQeuYyHY9Jkc/3hVge6leegggl8K2rVTGVQBVw2HkY3CfPFUhoDhYtuC # cz4mXvBAEtI51SYDDYWIMV8KC4sCAwEAAaOCAX8wggF7MB8GA1UdJQQYMBYGCisG # AQQBgjdMCAEGCCsGAQUFBwMDMB0GA1UdDgQWBBSnE10fIYlV6APunhc26vJUiDUZ # rzBRBgNVHREESjBIpEYwRDEMMAoGA1UECxMDQU9DMTQwMgYDVQQFEysyMzAwMTIr # YzgwNGI1ZWEtNDliNC00MjM4LTgzNjItZDg1MWZhMjI1NGZjMB8GA1UdIwQYMBaA # FEhuZOVQBdOCqhc3NyK1bajKdQKVMFQGA1UdHwRNMEswSaBHoEWGQ2h0dHA6Ly93 # d3cubWljcm9zb2Z0LmNvbS9wa2lvcHMvY3JsL01pY0NvZFNpZ1BDQTIwMTFfMjAx # MS0wNy0wOC5jcmwwYQYIKwYBBQUHAQEEVTBTMFEGCCsGAQUFBzAChkVodHRwOi8v # d3d3Lm1pY3Jvc29mdC5jb20vcGtpb3BzL2NlcnRzL01pY0NvZFNpZ1BDQTIwMTFf # MjAxMS0wNy0wOC5jcnQwDAYDVR0TAQH/BAIwADANBgkqhkiG9w0BAQsFAAOCAgEA # TZdPNH7xcJOc49UaS5wRfmsmxKUk9N9E1CS6s2oIiZmayzHncJv/FB2wBzl/5DA7 # EyLeDsiVZ7tufvh8laSQgjeTpoPTSQLBrK1Z75G3p2YADqJMJdTc510HAsooNGU7 # OYOtlSqOyqDoCDoc/j57QEmUTY5UJQrlsccK7nE3xpteNvWnQkT7vIewDcA12SaH # X/9n7yh094owBBGKZ8xLNWBqIefDjQeDXpurnXEfKSYJEdT1gtPSNgcpruiSbZB/ # AMmoW+7QBGX7oQ5XU8zymInznxWTyAbEY1JhAk9XSBz1+3USyrX59MJpX7uhnQ1p # gyfrgz4dazHD7g7xxIRDh+4xnAYAMny3IIq5CCPqVrAY1LK9Few37WTTaxUCI8aK # M4c60Zu2wJZZLKABU4QBX/J7wXqw7NTYUvZfdYFEWRY4J1O7UPNecd/311HcMdUa # YzUql36fZjdfz1Uz77LKvCwjqkQe7vtnSLToQsMPilFYokYCYSZaGb9clOmoQHDn # WzBMfIDUUGeipe4O6z218eV5HuH1WBlvu4lteOIgWCX/5Eiz5q/xskAEF0ZQ1Axs # kRR97sri9ibeGzsEZ1EuD6QX90L/P5GJMfinvLPlOlLcKjN/SmSRZdhlEbbbare0 # bFL8v4txFsQsznOaoOldCMFFRaUphuwBMW1edMZWMQswggYHMIID76ADAgECAgph # Fmg0AAAAAAAcMA0GCSqGSIb3DQEBBQUAMF8xEzARBgoJkiaJk/IsZAEZFgNjb20x # GTAXBgoJkiaJk/IsZAEZFgltaWNyb3NvZnQxLTArBgNVBAMTJE1pY3Jvc29mdCBS # b290IENlcnRpZmljYXRlIEF1dGhvcml0eTAeFw0wNzA0MDMxMjUzMDlaFw0yMTA0 # MDMxMzAzMDlaMHcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAw # DgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24x # ITAfBgNVBAMTGE1pY3Jvc29mdCBUaW1lLVN0YW1wIFBDQTCCASIwDQYJKoZIhvcN # AQEBBQADggEPADCCAQoCggEBAJ+hbLHf20iSKnxrLhnhveLjxZlRI1Ctzt0YTiQP # 7tGn0UytdDAgEesH1VSVFUmUG0KSrphcMCbaAGvoe73siQcP9w4EmPCJzB/LMySH # nfL0Zxws/HvniB3q506jocEjU8qN+kXPCdBer9CwQgSi+aZsk2fXKNxGU7CG0OUo # Ri4nrIZPVVIM5AMs+2qQkDBuh/NZMJ36ftaXs+ghl3740hPzCLdTbVK0RZCfSABK # R2YRJylmqJfk0waBSqL5hKcRRxQJgp+E7VV4/gGaHVAIhQAQMEbtt94jRrvELVSf # rx54QTF3zJvfO4OToWECtR0Nsfz3m7IBziJLVP/5BcPCIAsCAwEAAaOCAaswggGn # MA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFCM0+NlSRnAK7UD7dvuzK7DDNbMP # MAsGA1UdDwQEAwIBhjAQBgkrBgEEAYI3FQEEAwIBADCBmAYDVR0jBIGQMIGNgBQO # rIJgQFYnl+UlE/wq4QpTlVnkpKFjpGEwXzETMBEGCgmSJomT8ixkARkWA2NvbTEZ # MBcGCgmSJomT8ixkARkWCW1pY3Jvc29mdDEtMCsGA1UEAxMkTWljcm9zb2Z0IFJv # b3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5ghB5rRahSqClrUxzWPQHEy5lMFAGA1Ud # HwRJMEcwRaBDoEGGP2h0dHA6Ly9jcmwubWljcm9zb2Z0LmNvbS9wa2kvY3JsL3By # b2R1Y3RzL21pY3Jvc29mdHJvb3RjZXJ0LmNybDBUBggrBgEFBQcBAQRIMEYwRAYI # KwYBBQUHMAKGOGh0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2kvY2VydHMvTWlj # cm9zb2Z0Um9vdENlcnQuY3J0MBMGA1UdJQQMMAoGCCsGAQUFBwMIMA0GCSqGSIb3 # DQEBBQUAA4ICAQAQl4rDXANENt3ptK132855UU0BsS50cVttDBOrzr57j7gu1BKi # jG1iuFcCy04gE1CZ3XpA4le7r1iaHOEdAYasu3jyi9DsOwHu4r6PCgXIjUji8FMV # 3U+rkuTnjWrVgMHmlPIGL4UD6ZEqJCJw+/b85HiZLg33B+JwvBhOnY5rCnKVuKE5 # nGctxVEO6mJcPxaYiyA/4gcaMvnMMUp2MT0rcgvI6nA9/4UKE9/CCmGO8Ne4F+tO # i3/FNSteo7/rvH0LQnvUU3Ih7jDKu3hlXFsBFwoUDtLaFJj1PLlmWLMtL+f5hYbM # UVbonXCUbKw5TNT2eb+qGHpiKe+imyk0BncaYsk9Hm0fgvALxyy7z0Oz5fnsfbXj # pKh0NbhOxXEjEiZ2CzxSjHFaRkMUvLOzsE1nyJ9C/4B5IYCeFTBm6EISXhrIniIh # 0EPpK+m79EjMLNTYMoBMJipIJF9a6lbvpt6Znco6b72BJ3QGEe52Ib+bgsEnVLax # aj2JoXZhtG6hE6a/qkfwEm/9ijJssv7fUciMI8lmvZ0dhxJkAj0tr1mPuOQh5bWw # ymO0eFQF1EEuUKyUsKV4q7OglnUa2ZKHE3UiLzKoCG6gW4wlv6DvhMoh1useT8ma # 7kng9wFlb4kLfchpyOZu6qeXzjEp/w7FW1zYTRuh2Povnj8uVRZryROj/TCCB3ow # ggVioAMCAQICCmEOkNIAAAAAAAMwDQYJKoZIhvcNAQELBQAwgYgxCzAJBgNVBAYT # AlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYD # VQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xMjAwBgNVBAMTKU1pY3Jvc29mdCBS # b290IENlcnRpZmljYXRlIEF1dGhvcml0eSAyMDExMB4XDTExMDcwODIwNTkwOVoX # DTI2MDcwODIxMDkwOVowfjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0 # b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3Jh # dGlvbjEoMCYGA1UEAxMfTWljcm9zb2Z0IENvZGUgU2lnbmluZyBQQ0EgMjAxMTCC # AiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAKvw+nIQHC6t2G6qghBNNLry # tlghn0IbKmvpWlCquAY4GgRJun/DDB7dN2vGEtgL8DjCmQawyDnVARQxQtOJDXlk # h36UYCRsr55JnOloXtLfm1OyCizDr9mpK656Ca/XllnKYBoF6WZ26DJSJhIv56sI # UM+zRLdd2MQuA3WraPPLbfM6XKEW9Ea64DhkrG5kNXimoGMPLdNAk/jj3gcN1Vx5 # pUkp5w2+oBN3vpQ97/vjK1oQH01WKKJ6cuASOrdJXtjt7UORg9l7snuGG9k+sYxd # 6IlPhBryoS9Z5JA7La4zWMW3Pv4y07MDPbGyr5I4ftKdgCz1TlaRITUlwzluZH9T # upwPrRkjhMv0ugOGjfdf8NBSv4yUh7zAIXQlXxgotswnKDglmDlKNs98sZKuHCOn # qWbsYR9q4ShJnV+I4iVd0yFLPlLEtVc/JAPw0XpbL9Uj43BdD1FGd7P4AOG8rAKC # X9vAFbO9G9RVS+c5oQ/pI0m8GLhEfEXkwcNyeuBy5yTfv0aZxe/CHFfbg43sTUkw # p6uO3+xbn6/83bBm4sGXgXvt1u1L50kppxMopqd9Z4DmimJ4X7IvhNdXnFy/dygo # 8e1twyiPLI9AN0/B4YVEicQJTMXUpUMvdJX3bvh4IFgsE11glZo+TzOE2rCIF96e # TvSWsLxGoGyY0uDWiIwLAgMBAAGjggHtMIIB6TAQBgkrBgEEAYI3FQEEAwIBADAd # BgNVHQ4EFgQUSG5k5VAF04KqFzc3IrVtqMp1ApUwGQYJKwYBBAGCNxQCBAweCgBT # AHUAYgBDAEEwCwYDVR0PBAQDAgGGMA8GA1UdEwEB/wQFMAMBAf8wHwYDVR0jBBgw # FoAUci06AjGQQ7kUBU7h6qfHMdEjiTQwWgYDVR0fBFMwUTBPoE2gS4ZJaHR0cDov # L2NybC5taWNyb3NvZnQuY29tL3BraS9jcmwvcHJvZHVjdHMvTWljUm9vQ2VyQXV0 # MjAxMV8yMDExXzAzXzIyLmNybDBeBggrBgEFBQcBAQRSMFAwTgYIKwYBBQUHMAKG # Qmh0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2kvY2VydHMvTWljUm9vQ2VyQXV0 # MjAxMV8yMDExXzAzXzIyLmNydDCBnwYDVR0gBIGXMIGUMIGRBgkrBgEEAYI3LgMw # gYMwPwYIKwYBBQUHAgEWM2h0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2lvcHMv # ZG9jcy9wcmltYXJ5Y3BzLmh0bTBABggrBgEFBQcCAjA0HjIgHQBMAGUAZwBhAGwA # XwBwAG8AbABpAGMAeQBfAHMAdABhAHQAZQBtAGUAbgB0AC4gHTANBgkqhkiG9w0B # AQsFAAOCAgEAZ/KGpZjgVHkaLtPYdGcimwuWEeFjkplCln3SeQyQwWVfLiw++MNy # 0W2D/r4/6ArKO79HqaPzadtjvyI1pZddZYSQfYtGUFXYDJJ80hpLHPM8QotS0LD9 # a+M+By4pm+Y9G6XUtR13lDni6WTJRD14eiPzE32mkHSDjfTLJgJGKsKKELukqQUM # m+1o+mgulaAqPyprWEljHwlpblqYluSD9MCP80Yr3vw70L01724lruWvJ+3Q3fMO # r5kol5hNDj0L8giJ1h/DMhji8MUtzluetEk5CsYKwsatruWy2dsViFFFWDgycSca # f7H0J/jeLDogaZiyWYlobm+nt3TDQAUGpgEqKD6CPxNNZgvAs0314Y9/HG8VfUWn # duVAKmWjw11SYobDHWM2l4bf2vP48hahmifhzaWX0O5dY0HjWwechz4GdwbRBrF1 # HxS+YWG18NzGGwS+30HHDiju3mUv7Jf2oVyW2ADWoUa9WfOXpQlLSBCZgB/QACnF # sZulP0V3HjXG0qKin3p6IvpIlR+r+0cjgPWe+L9rt0uX4ut1eBrs6jeZeRhL/9az # I2h15q/6/IvrC4DqaTuv/DDtBEyO3991bWORPdGdVk5Pv4BXIqF4ETIheu9BCrE/ # +6jMpF3BoYibV3FWTkhFwELJm3ZbCoBIa/15n8G9bW1qyVJzEw16UM0xggTGMIIE # wgIBATCBlTB+MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4G # A1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSgw # JgYDVQQDEx9NaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQSAyMDExAhMzAAAAww6b # p9iy3PcsAAAAAADDMAkGBSsOAwIaBQCggdowGQYJKoZIhvcNAQkDMQwGCisGAQQB # gjcCAQQwHAYKKwYBBAGCNwIBCzEOMAwGCisGAQQBgjcCARUwIwYJKoZIhvcNAQkE # MRYEFCxAdv+GZCpZfbrlpy1Xa3ovvOzPMHoGCisGAQQBgjcCAQwxbDBqoCiAJgBT # AHQAbwByAGUAQgByAG8AawBlAHIAIABTAGkAZwBuAGkAbgBnoT6APGh0dHA6Ly9l # ZHdlYi9zaXRlcy9JU1NFbmdpbmVlcmluZy9FbmdGdW4vU2l0ZVBhZ2VzL0hvbWUu # YXNweDANBgkqhkiG9w0BAQEFAASCAQAHJgMWx+pf3TAPIRMT9t6djE8WgnV7mM8I # pFePEr5asEWLSU+DQZtANoShttiEg3Qx7dgdJxxVcDXcPXG4rv1Jzra0N1dLk/CQ # Hc1Ep8l5s1Ng3tAyJr8UQsdZV6yBxmUPgwKNobSqG4nSkD6STWY31gfEeL3jfPTw # 6Hm/KXHtGcFnpEpsJOYOckzZxTXg17WeWJGWko88fSGToPHYCO4dq1O75aswScoE # WnP/qrctp90sWUr4EFbrs2kqR0zeJmpHkDUmwALonuMKky95LHAmGd8ZcOc6U+Vr # 1WSfCCdinWgDie/L/lnn9PrtXxReWIQWHsatyZ/MevwB5NkLKPNkoYICKDCCAiQG # CSqGSIb3DQEJBjGCAhUwggIRAgEBMIGOMHcxCzAJBgNVBAYTAlVTMRMwEQYDVQQI # EwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3Nv # ZnQgQ29ycG9yYXRpb24xITAfBgNVBAMTGE1pY3Jvc29mdCBUaW1lLVN0YW1wIFBD # QQITMwAAAMM7uBDWq3WchAAAAAAAwzAJBgUrDgMCGgUAoF0wGAYJKoZIhvcNAQkD # MQsGCSqGSIb3DQEHATAcBgkqhkiG9w0BCQUxDxcNMTcxMjE0MjMxMzA0WjAjBgkq # hkiG9w0BCQQxFgQUsgbnyO8wOg3YtSloSHN8bMnr+l8wDQYJKoZIhvcNAQEFBQAE # ggEAnPmqOw/MMjpHQyjnxVXQ8kY0aM0Xr3eAVz+tCaMOF6JTcAmRm/VQY1GUNTYY # 6IANWPuF7rqnjy9YFKkpwGYK9mxFFCKWWfF9KqVlV34k4BhcF5KGJQtvez0Hfv8t # Fn2/eFEj7QmxpxXw9k88XFE7rVsvfuSXbIgGInLGiOfDRhPKm3wX5ikHEE3o0xpp # 91hEbI/JcgmA2N07sseGfmBk2X7rz766xUiWdAb/Cu6Fqc3Kub7sIwTaPgklgzFQ # zVj6p+h+/jI+3bjGB7RUxEVq8w5PN8qZSoJvIpXVESxxPink9wtbrWuyBC+pPvyO # AhRS+nMYZZ1EpawC8jVASjtV7A== # SIG # End signature block |