Skip to content

Don't write an error if file already unblocked #5362

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
iSazonov merged 5 commits into from
Nov 10, 2017
Merged

Don't write an error if file already unblocked #5362

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
282b600
Don't write an error if file already unblocked
iSazonov Nov 7, 2017
668028b
Fix test
iSazonov Nov 7, 2017
bf61faa
Add verbose message
iSazonov Nov 8, 2017
19fa0ed
Add a resource string
iSazonov Nov 9, 2017
81fbd1a
Change a resource string
iSazonov Nov 10, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions src/Microsoft.PowerShell.Commands.Utility/commands/utility/UnblockFile.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,9 +121,17 @@ protected override void ProcessRecord()
}
catch (Win32Exception accessException)
{
WriteError(new ErrorRecord(accessException, "RemoveItemUnauthorizedAccessError", ErrorCategory.PermissionDenied, path));
// NativeErrorCode=2 - File not found.
// If the block stream not found the 'path' was not blocked and we successfully return.
if (accessException.NativeErrorCode != 2)
Copy link
Member

@SteveL-MSFT SteveL-MSFT Nov 7, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jpsnover suggests adding a verbose message here if the block stream is not found

Copy link
Collaborator Author

@iSazonov iSazonov Nov 8, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. I tried to avoid adding a resource string

Copy link
Member

@SteveL-MSFT SteveL-MSFT Nov 8, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be better to add a resource string saying:

File '{0}' did not contain a 'Zone.Identifier' file stream and was already not blocked.

Copy link
Collaborator Author

@iSazonov iSazonov Nov 9, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a resouce string with {0} at last position - we should take into account long paths.

{
WriteError(new ErrorRecord(accessException, "RemoveItemUnauthorizedAccessError", ErrorCategory.PermissionDenied, path));
}
else
{
WriteVerbose(StringUtil.Format(UtilityCommonStrings.NoZoneIdentifierFileStream, path));
}
}

}
}
}
Expand Down
3 changes: 3 additions & 0 deletions src/Microsoft.PowerShell.Commands.Utility/resources/UtilityCommonStrings.resx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,4 +174,7 @@
<data name="TypeNotSupported" xml:space="preserve">
<value>'{0}' is not supported in this system.</value>
</data>
<data name="NoZoneIdentifierFileStream" xml:space="preserve">
<value>The file is not blocked: {0}</value>
</data>
</root>
6 changes: 4 additions & 2 deletions test/powershell/Modules/Microsoft.PowerShell.Utility/Unblock-File.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ Describe "Unblock-File" -Tags "CI" {
It "With '-Path': file exist" {
Unblock-File -Path $testfilepath
Test-UnblockFile | Should Be $true

# If a file is not blocked we silently return without an error.
{ Unblock-File -Path $testfilepath -ErrorAction Stop } | Should Not Throw
}

It "With '-LiteralPath': file exist" {
Expand All @@ -67,7 +70,6 @@ Describe "Unblock-File" -Tags "CI" {
$TestFileCreated = Get-ChildItem $TestFile
$TestFileCreated.IsReadOnly | Should Be $true

{ Unblock-File -LiteralPath $TestFile -ErrorAction SilentlyContinue } | Should Not Throw
$error[0].FullyQualifiedErrorId | Should Be "RemoveItemUnauthorizedAccessError,Microsoft.PowerShell.Commands.UnblockFileCommand"
{ Unblock-File -LiteralPath $TestFile -ErrorAction Stop } | ShouldBeErrorId "RemoveItemUnauthorizedAccessError,Microsoft.PowerShell.Commands.UnblockFileCommand"
}
}