{"id":1315,"date":"2009-03-25T07:00:37","date_gmt":"2009-03-25T15:00:37","guid":{"rendered":"http:\/\/www.sapien.com\/blog\/2009\/03\/25\/powershell-tree\/"},"modified":"2009-04-06T05:58:57","modified_gmt":"2009-04-06T13:58:57","slug":"powershell-tree","status":"publish","type":"post","link":"https:\/\/dev.sapien.com\/blog\/2009\/03\/25\/powershell-tree\/","title":{"rendered":"PowerShell Tree"},"content":{"rendered":"

Of course since I’ve posted a VBScript version<\/a> of the Tree command, I had to do it in PowerShell. On one hand, this would have been pretty straightforward since PowerShell can use COM objects and I could have simply reused the FileSystemObject. But that didn’t feel right. So I came up with a version that uses cmdlets and PowerShell features like the -f formatting operator. So here is TREE.PS1.<\/p>\n

\n
\n
#Tree.ps1<\/span><\/pre>\n
Param ([string]$path=$env:temp,<\/pre>\n
       [switch<\/span>]$pipeline)<\/pre>\n
\u00a0<\/pre>\n
Function Get-SubFolder {<\/pre>\n
    Param([int]$TabLevel=0,[string]$path)<\/pre>\n
<\/pre>\n
    $TabLevel+=1<\/pre>\n
    $subdirs = dir $path | where {$_.GetType() -match<\/span> \"directoryInfo\"<\/span>}<\/pre>\n
    if<\/span> ($subdirs)<\/pre>\n
    {<\/pre>\n
        foreach<\/span> ($subdir in<\/span> $subdirs) {<\/pre>\n
            $subfiles=dir $subdir.fullname | where {$_.GetType() -match<\/span> \"FileInfo\"<\/span>}<\/pre>\n
            [int]$subcount=$subfiles.count<\/pre>\n
            [int]$subsize=($subfiles | Measure-Object -Sum Length).sum<\/pre>\n
<\/pre>\n
            $leaf=(\"{0}{1}{2}{3} ({4} files {5} KB)\"<\/span> -f `<\/pre>\n
            (\" \"<\/span>*$tabLevel),\"|\"<\/span>,(\"_\"<\/span>*$TabLevel),$subdir.name,$subcount,(\"{0:N2}\"<\/span> -f ($subsize\/1KB)))<\/pre>\n
            if<\/span> ($pipeline)<\/pre>\n
            {<\/pre>\n
                write $leaf<\/pre>\n
            }<\/pre>\n
            else<\/span><\/pre>\n
            {<\/pre>\n
                Write-Host  $leaf -foregroundcolor green<\/pre>\n
            }<\/pre>\n
<\/pre>\n
            Get-SubFolder $TabLevel $subdir.fullname<\/pre>\n
        }<\/pre>\n
    }<\/pre>\n
    $TabLevel-=1<\/pre>\n
}<\/pre>\n
#Turn off the error pipeline<\/span><\/pre>\n
$ErrorActionPreference=\"SilentlyContinue\"<\/span><\/pre>\n
\u00a0<\/pre>\n
if<\/span> ((Get-Item $path).exists)<\/pre>\n
{<\/pre>\n
    $data=dir $path<\/pre>\n
    $files=$data | where {$_.GetType() -match<\/span> \"FileInfo\"<\/span>}<\/pre>\n
    [int]$count=$files.count<\/pre>\n
    [int]$size=($files | Measure-Object -Sum Length).sum<\/pre>\n
<\/pre>\n
    #write the tree root<\/span><\/pre>\n
    $leaf=(\"{0} ({1} files {2} KB)\"<\/span> -f $path,$count,(\"{0:N2}\"<\/span> -f ($size\/1KB)))<\/pre>\n
    if<\/span> ($pipeline)<\/pre>\n
    {<\/pre>\n
        write $leaf<\/pre>\n
    }<\/pre>\n
    else<\/span><\/pre>\n
    {<\/pre>\n
        Write-Host  $leaf -foregroundcolor green<\/pre>\n
    }<\/pre>\n
<\/pre>\n
    $TabLevel=0<\/pre>\n
    #enumerate child folders<\/span><\/pre>\n
    Get-SubFolder -tablevel $tablevel -path $path<\/pre>\n
\u00a0<\/pre>\n
}<\/pre>\n
else<\/span><\/pre>\n
{<\/pre>\n
    Write-Warning \"Failed to find $path\"<\/span><\/pre>\n
}<\/pre>\n<\/div>\n<\/div>\n
Like my original version, it takes a path as a run time parameter and defaults to the %TEMP% directory. You’ll also see I turn off the error pipeline so that the script runs without interruption. I realize there are ways I could have developed the script to be more concise, but I decided to sacrifice conciseness for clarity. I wanted the script to be easier to follow. Once you understand how it works, by all means, revise away.<\/p>\n
The main part of the script, assuming the path exists, gets a directory listing and saves it to a variable. This makes it easier and faster to filter out files only, get a count of all the files and measure their total size.<\/p>\n
\n
\n
$data=dir $path<\/pre>\n
$files=$data | where {$_.GetType() -match<\/span> \"FileInfo\"<\/span>}<\/pre>\n
[int]$count=$files.count<\/pre>\n
[int]$size=($files | Measure-Object -Sum Length).sum<\/pre>\n<\/div>\n<\/div>\n
All of this information becomes part of a the “leaf” I want to display.<\/p>\n
\n
\n
#write the tree root<\/span><\/pre>\n
$leaf=(\"{0} ({1} files {2} KB)\"<\/span> -f $path,$count,(\"{0:N2}\"<\/span> -f ($size\/1KB)))<\/pre>\n<\/div>\n<\/div>\n
I decided to try something different in this script. I liked the idea of using Write-Host<\/strong> so I could display the tree in a color, like green. But what if you wanted to save the output? To accomplish that I need to write to the pipeline. So I give you a choice. If you use the -pipeline parameter, the information is written using Write-Object<\/strong>. Otherwise, the script uses the default Write-Host<\/strong>.<\/p>\n
\n
\n
if<\/span> ($pipeline)<\/pre>\n
{<\/pre>\n
        write $leaf<\/pre>\n
}<\/pre>\n
else<\/span><\/pre>\n
{<\/pre>\n
        Write-Host  $leaf -foregroundcolor green<\/pre>\n
}<\/pre>\n<\/div>\n<\/div>\n
Now to get the subfolders.<\/p>\n
\n
\n
$TabLevel=0<\/pre>\n
#enumerate child folders<\/span><\/pre>\n
Get-SubFolder -tablevel $tablevel -path $path<\/pre>\n<\/div>\n<\/div>\n
The Get-SubFolder function gets a collection of directories within the root of the specified path.<\/p>\n
\n
\n
Function Get-SubFolder {<\/pre>\n
    Param([int]$TabLevel=0,[string]$path)<\/pre>\n
<\/pre>\n
    $TabLevel+=1<\/pre>\n
    $subdirs = dir $path | where {$_.GetType() -match<\/span> \"directoryInfo\"<\/span>}<\/pre>\n
    if<\/span> ($subdirs)<\/pre>\n<\/div>\n<\/div>\n
Assuming subfolders were found, each subfolder is analyzed to get all files in it, and the total size of all files.<\/p>\n
\n
\n
foreach<\/span> ($subdir in<\/span> $subdirs) {<\/pre>\n
            $subfiles=dir $subdir.fullname | where {$_.GetType() -match<\/span> \"FileInfo\"<\/span>}<\/pre>\n
            [int]$subcount=$subfiles.count<\/pre>\n
            [int]$subsize=($subfiles | Measure-Object -Sum Length).sum<\/pre>\n<\/div>\n<\/div>\n
Again, this information is part of the “leaf” variable.<\/p>\n
\n
\n
$leaf=(\"{0}{1}{2}{3} ({4} files {5} KB)\"<\/span> -f `<\/pre>\n
(\" \"<\/span>*$tabLevel),\"|\"<\/span>,(\"_\"<\/span>*$TabLevel),$subdir.name,$subcount,(\"{0:N2}\"<\/span> -f ($subsize\/1KB)))<\/pre>\n<\/div>\n<\/div>\n
The -f operator makes it easy to create a string by replacing each placeholder like {0} with a corresponding value. I end up with something like this:<\/p>\n
|_foo2 (2 files 812.00 KB)<\/span><\/p>\n
As before, $leaf is written either to the pipeline or console. Then I call the function again to recurse through additional subfolders. The output is about the same as with my VBScript version. Personally, I think it looks best if you set your PowerShell window to use Lucida Console instead of the raster fonts.<\/p>\n
\n
Download the PowerShell script here.<\/a><\/p>\n
UPDATE 4\/6\/2009
\nI’ve updated the script file and download link.\u00a0 The new version now uses [int64] to handle larger folder sizes. I also fixed a problem where folders with a single file were displaying as having no file.<\/p><\/div>\n","protected":false},"excerpt":{"rendered":"
Of course since I’ve posted a VBScript version of the Tree command, I had to do it in PowerShell. On one hand, this would have been pretty straightforward since PowerShell can use COM objects and I could have simply reused the FileSystemObject. But that didn’t feel right. So I came up with a version that uses cmdlets and PowerShell features like the -f formatting operator. So here is TREE.PS1.<\/p>\n","protected":false},"author":3,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":""},"categories":[25],"tags":[198,468,28,57,483],"class_list":["post-1315","post","type-post","status-publish","format-standard","hentry","category-windows-powershell","tag-function","tag-pipeline","tag-powershell","tag-scripting","tag-tree"],"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/1315","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/comments?post=1315"}],"version-history":[{"count":2,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/1315\/revisions"}],"predecessor-version":[{"id":1341,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/1315\/revisions\/1341"}],"wp:attachment":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/media?parent=1315"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/categories?post=1315"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/tags?post=1315"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}