{"id":52393,"date":"2009-09-24T03:01:00","date_gmt":"2009-09-24T03:01:00","guid":{"rendered":"https:\/\/blogs.technet.microsoft.com\/heyscriptingguy\/2009\/09\/24\/hey-scripting-guy-can-i-unlock-a-read-only-file-edit-it-and-make-it-read-only-again\/"},"modified":"2009-09-24T03:01:00","modified_gmt":"2009-09-24T03:01:00","slug":"hey-scripting-guy-can-i-unlock-a-read-only-file-edit-it-and-make-it-read-only-again","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/scripting\/hey-scripting-guy-can-i-unlock-a-read-only-file-edit-it-and-make-it-read-only-again\/","title":{"rendered":"Hey, Scripting Guy! Can I “Unlock” a Read-Only File, Edit it, and Make It Read-Only Again?"},"content":{"rendered":"

\"Bookmark<\/a>\"Hey,<\/span><\/span><\/span>Hey, Scripting Guy! We have a number of files that we need to access at work from time to time. To protect these files, we make them read-only. This works great from a file protection standpoint, but it is really annoying when I need to make updates to the file because about half the time I will open a file, make the edits, and forget to clear the read-only attribute. When I go to save my changes, that is when I am reminded that the file is read-only and it forces me to save the changes to a new file. Then I have to go back to the folder, rename the original file, and then rename the modified file to the original file name. All this ends up costing me an extra five minutes of frustration and annoyance. I wish I had a script I could use that would clear the read-only attribute from all files in a folder. I could use that script before I start to work. Then if I had another script that would set the read-only attribute back to the files it would be great. What do you think? Could you hook me up with a couple of scripts or what?<\/p>\n

<<\/p>\n

p style=”MARGIN: 0in 0in 8pt” class=”MsoNormal”>– LM<\/p>\n

\"Hey,<\/font><\/p>\n

Hello LM, Microsoft Scripting Guy Ed Wilson here. <\/p>\n

It is a cloudy overcast day in Charlotte, North Carolina<\/font><\/a>, in the United States today. You would, of course, already know this, if you had friended me on Facebook<\/font><\/a>. I am sipping a cup of Gunpowder Green Tea<\/font><\/a> with a real cinnamon<\/font><\/a> stick and lemon grass<\/font><\/a> in it. I am listening to the Beach Boys<\/font><\/a> on my newly upgraded Zune<\/font><\/a>, and watching the ScriptingGuys on Twitter<\/a> via my bDule<\/font><\/a> software. I am in a good mood, and things are going great. <\/p>\n

LM, I decided to write a single script that will display all read-only files in a folder, allow you to clear the read-only attribute, and then reset the read-only attribute. To use the script, you specify the path to the folder, and then use the appropriate switch to get, clear, or set the read-only attribute. The WorkWithReadOnlyFiles.ps1 script is pretty cool, and is seen here. <\/p>\n

WorkWithReadOnlyFiles.ps1<\/p>\n

<\/b><\/p>\n

Param ([string]$path=’c:fso’,
       <\/span>[switch]$get,
       <\/span>[switch]$clear,
       <\/span>[switch]$set,
       <\/span>[switch]$help
)#end param
      <\/span>
# *** Functions here ***<\/p>\n

Function Get-ReadOnlyFiles([string]$path)
{
 <\/span>“Getting readonly attribute on files in $path”
 <\/span>Get-ChildItem -Path $path |
 <\/span>Where-Object { $_.attributes -match ‘readonly’ }
} #end get-Readonlyfiles<\/p>\n

Function Clear-ReadOnlyFiles([string]$path)
{
  <\/span>“Clearing readonly attribute from files in $path”
 <\/span>New-Variable -Name read_only -Value 1 -Option readonly
 <\/span>Get-ChildItem -Path $path |
 <\/span>Where-Object { $_.attributes -match ‘readonly’ } |
 <\/span>ForEach-Object {
   <\/span>$_.attributes = $_.attributes -Bxor $read_only }
}#end Clear-ReadonlyFiles<\/p>\n

Function Set-ReadOnlyFiles([string]$path)
{
 <\/span>“Setting readonly attribute on files in $path”
 <\/span>New-Variable -Name read_only -Value 1 -Option readonly
 <\/span>Get-ChildItem -Path $path |
 <\/span>ForEach-Object {
   <\/span>$_.attributes = [int]$_.attributes + $read_only
 <\/span>}
}#end Set-ReadOnlyFiles<\/p>\n

Function Get-HelpText
{
 <\/span>$helpText = @”
  <\/span>WorkWithReadOnlyFiles.ps1 -path c:fso -get
  <\/span>Gets a list of all readonly files in c:fso folder
  <\/span>
  <\/span>WorkWithReadOnlyFiles.ps1 -path c:fso -set
  <\/span>Sets all files in the c:fso folder to readonly
  <\/span>
  <\/span>WorkWithReadOnlyFiles.ps1 -path c:fso -clear
  <\/span>Clears the readonly attribute from all files in c:fso folder
“@
 <\/span>$helpText
}#end Get-HelpText<\/p>\n

# *** Entry Point to Script ***
$clear = $true
if($help) { Get-HelpText ; exit }
if(!$path) { “A path is required.” ; Get-HelpText ; exit }
if($get) { Get-ReadOnlyFiles -path $path ; exit }
if($clear) { Clear-ReadOnlyFiles -path $path ; exit }
if($set) { Set-ReadonlyFiles -path $path ; exit }<\/p>\n

<\/font><\/font><\/span><\/p>\n

LM, the WorkWithReadOnlyFiles.ps1 script begins by creating some command-line parameters. The –path<\/b> parameter is a string and is used to specify the target folder. The remaining parameters are all switched parameters. The –get<\/b> parameter is used to tell the script to retrieve a list of all the read-only files in the folder. The –clear<\/b> parameter removes the read-only attribute from all files in the target folder. The –help<\/b> switch is used to display Help text on the Windows PowerShell console. The parameter section of the script is seen here. <\/p>\n

Param ([string]$path,
       <\/span>[switch]$get,
       <\/span>[switch]$clear,
       <\/span>[switch]$set,
       <\/span>[switch]$help
)#end param<\/p>\n

<\/font><\/span><\/p>\n

The Get-ReadOnlyFiles<\/b> function is used to list the read-only files in the directory that is stored in the $path<\/b> variable. This function will find files that have the read-only attribute set. An example of such a file is seen here:<\/p>\n

\"Image<\/p>\n

 <\/p>\n

The Get-ReadOnlyFiles<\/b> function is very useful, because by default the folder view for Windows Explorer does not list read-only files:<\/p>\n

\"Image<\/p>\n

 <\/p>\n

The first thing the function does is display a status message on the Windows PowerShell console that indicates that the read-only files in the path stored in the $path<\/b> variable are being identified. After the status message has been displayed, the Get-ChildItem<\/b> cmdlet (which performs a functionality similar to the old DOS Dir<\/b> command) is used to find all the files that are in the folder that is specified by the $path<\/b> variable. Because the Get-ChildItem<\/b> cmdlet’s –recurse<\/b> parameter is not used, the Get-ReadOnlyFiles<\/b> will only work with a single folder at a time. You could supply multiple folders via the -path<\/b> parameter because the Get-ChildItem<\/b> cmdlet’s –path<\/b> parameter will accept an array of strings; however, the $path<\/b> variable is identified as a [string]<\/b>, which is a singleton, and not as a [string[]]<\/b>, which is an array. If you want to modify the script to accept multiple paths, you will need to change all the [string$path<\/b> commands to [string[]]$path<\/b>. If you did that, you would be able to call the script as seen here: <\/p>\n

WorkWithReadOnlyFiles.ps1 -path “c:fso”,”c:fso1″ –get<\/p>\n

<\/font><\/span><\/p>\n

After the Get-ChildItem<\/b> cmdlet retrieves the files, it passes them along the pipeline to the Where-Object<\/b> cmdlet. The Where-Object<\/b> cmdlet is used to look for an attribute that matches ‘readonly’<\/b>; when this is found, the filename<\/b>, last write time<\/b>, and other information about the file will be displayed. The complete Get-ReadOnlyFIles<\/b> function is seen here: <\/p>\n

Function Get-ReadOnlyFiles([string]$path)
{
 <\/span>“Getting readonly attribute on files in $path”
 <\/span>Get-ChildItem -Path $path |
 <\/span>Where-Object { $_.attributes -match ‘readonly’ }
} #end get-Readonlyfiles<\/p>\n

<\/font><\/span><\/p>\n

The Clear-ReadOnlyFiles<\/b> function is used to remove the read-only attribute from all the files in the folder. A read-only variable is created that is named read_only<\/b>. This variable is set to a value of 1. It is read-only because you do not want to be able to change the value of the variable, not because it is used to hold the value of the file attribute readonly<\/b>. Once the read-only<\/b> variable is created, the Get-ChildItem<\/b> cmdlet is used to retrieve the files from the folder, and the Where-Object<\/b> cmdlet is used to filter out the readonly<\/b> files. The results of that are piped to the ForEach-Object<\/b> cmdlet where an XOR<\/b> is taken with the value of the attributes<\/b> property. The -Bxor<\/b> operator is used to perform the XOR<\/b> operation. <\/p>\n

For more information about performing an XOR with file attributes, refer to the Scripting Guide<\/font><\/a> or to the Microsoft Press book, Microsoft PowerShell Step By Step<\/font><\/a>.<\/p>\n

When the Clear-ReadOnlyFiles<\/b> function is run, the read-only attribute from all the files is removed. This is seen here:<\/p>\n

\"Image<\/p>\n

 <\/p>\n

The complete Clear-ReadOnlyFiles<\/b> function is seen here. <\/p>\n

Function Clear-ReadOnlyFiles([string]$path)
{
  <\/span>“Clearing readonly attribute from files in $path”
 <\/span>New-Variable -Name read_only -Value 1 -Option readonly
 <\/span>Get-ChildItem -Path $path |
 <\/span>Where-Object { $_.attributes -match ‘readonly’ } |
 <\/span>ForEach-Object {
   <\/span>$_.attributes = $_.attributes -Bxor $read_only }
}#end Clear-ReadonlyFiles<\/p>\n

<\/font><\/span><\/p>\n

The Set-ReadOnlyFiles<\/b> function is used to set the read-only attribute on each file in the folder specified by the value of the $path<\/b> variable. The first thing it does is display a status message on the Windows PowerShell console that states the read-only attribute will be set. Next, the Get-ChildItem<\/b> cmdlet is used to retrieve all of the files from the folder. There is no need to use the Where-Object<\/b> cmdlet to filter out files that are read-only because the read-only attribute will be applied to each file as it passes over the pipeline. The [int]<\/b> class is used to convert the value in the attributes<\/b> property into a number to allow us to add the number 1 (which represents a read-only file) to the value stored in the attributes<\/b> property. This is seen here: <\/p>\n

Function Set-ReadOnlyFiles([string]$path)
{
 <\/span>“Setting readonly attribute on files in $path”
 <\/span>New-Variable -Name read_only -Value 1 -Option readonly
 <\/span>Get-ChildItem -Path $path |
 <\/span>ForEach-Object {
   <\/span>$_.attributes = [int]$_.attributes + $read_only
 <\/span>}
}#end Set-ReadOnlyFiles<\/p>\n

<\/font><\/span><\/p>\n

The Get-HelpText<\/b> function uses a here-string<\/b> to store the Help text for the script. The use of a here-string<\/b> to create Help text was discussed in yesterday’s Hey, Scripting Guy! post<\/a>. The complete Get-HelpText<\/b> function is shown here: <\/p>\n

Function Get-HelpText
{
 <\/span>$helpText = @”
  <\/span>WorkWithReadOnlyFiles.ps1 -path c:fso -get
  <\/span>Gets a list of all readonly files in c:fso folder
  <\/span>
  <\/span>WorkWithReadOnlyFiles.ps1 -path c:fso -set
  <\/span>Sets all files in the c:fso folder to readonly
  <\/span>
  <\/span>WorkWithReadOnlyFiles.ps1 -path c:fso -clear
  <\/span>Clears the readonly attribute from all files in c:fso folder
“@
 <\/span>$helpText
}#end Get-HelpText<\/p>\n

<\/font><\/span><\/p>\n

The entry point to the script is used to parse the value of the command-line switches. If a switched parameter is used, the variable represented by the parameter will exist. If a switched parameter is not used, the variable will not exist. The if<\/b> statement can be used to check for the presence of the variables. When a variable is detected, the appropriate function is called. Because the script will not work if you do not supply a path to check for the existence of read-only files, if the value of the $path<\/b> variable is not detected, a string indicating that the path is required is displayed, and the Get-HelpText<\/b> function is called. After that has been done, the script is exited. This is seen here:<\/p>\n

if($help) { Get-HelpText ; exit }<\/p>\n

<\/font><\/span><\/p>\n

if(!$path) { “A path is required.” ; Get-HelpText ; exit }<\/p>\n

<\/font><\/span><\/p>\n

if($get) { Get-ReadOnlyFiles -path $path ; exit }<\/p>\n

<\/font><\/span><\/p>\n

if($clear) { Clear-ReadOnlyFiles -path $path ; exit }<\/p>\n

<\/font><\/span><\/p>\n

if($set) { Set-ReadonlyFiles -path $path ; exit }<\/p>\n

<\/font><\/span><\/p>\n

Well, LM, that is about all there is to working with read-only files. Hope you enjoyed this as much as I did.<\/p>\n

If you want to know exactly what we will be looking at tomorrow, follow us on Twitter<\/a> or Facebook<\/font><\/a>. If you have any questions, send e-mail to us at scripter@microsoft.com<\/a> or post them on the Official Scripting Guys Forum<\/a>. See you tomorrow. Until then, peace.<\/p>\n

 <\/p>\n

Ed Wilson and Craig Liebendorfer, Scripting Guys<\/p>\n

<\/span><\/b><\/p>\n

 qch9z2mu5s<\/span><\/p>\n","protected":false},"excerpt":{"rendered":"

Hey, Scripting Guy! We have a number of files that we need to access at work from time to time. To protect these files, we make them read-only. This works great from a file protection standpoint, but it is really annoying when I need to make updates to the file because about half the time […]<\/p>\n","protected":false},"author":595,"featured_media":87096,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[38,3,12,45],"class_list":["post-52393","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-scripting","tag-files","tag-scripting-guy","tag-storage","tag-windows-powershell"],"acf":[],"blog_post_summary":"

Hey, Scripting Guy! We have a number of files that we need to access at work from time to time. To protect these files, we make them read-only. This works great from a file protection standpoint, but it is really annoying when I need to make updates to the file because about half the time […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/52393","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/users\/595"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/comments?post=52393"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/52393\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/media\/87096"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/media?parent=52393"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/categories?post=52393"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/tags?post=52393"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}