2008年08月06日

オブジェクト指向なコマンド環境「Powershell」を試してみた

Microsoft 製の最新のコマンドライン環境「Powershell」が面白かったので、楽しいところをまとめてみた。

PowerShell の本の中ではプログラマブルPowerShell ～プログラマのための活用バイブル～が非常に分かりやすかった。おすすめ。

プログラマブルPowerShell ~プログラマのための活用バイブル~ (.NET TECHNOLOGYシリーズ)

作者: 荒井省三
出版社/メーカー: 技術評論社
発売日: 2008-01-08
メディア: 単行本（ソフトカバー）
Amazon のレビューを見る

UNIX な人にも使いやすい親切設計

コマンドプロンプトでファイル列挙と言えば dir だけど、Powershell では ls も使える。

PS> ls

    Directory: Microsoft.PowerShell.Core\FileSystem::C:\
    Documents and Settings\nitoyon

Mode             LastWriteTime   Length Name
----             -------------   ------ ----
d---s     2006/02/19     22:35          Cookies
d-r--     2006/02/17     23:39          Favorites
d-r--     2006/02/19     18:56          My Documents
d-r--     2004/08/19      9:56          スタート メニュー
d----     2006/02/19     23:06          デスクトップ

alias の仕組みがあって、dir と ls はいずれも Get-ChildItem というコマンドの alias になってる。

PS> get-alias | where {$_.Definition -eq "Get-Childitem"}

CommandType     Name                     Definition
-----------     ----                     ----------
Alias           gci                      Get-ChildItem
Alias           ls                       Get-ChildItem
Alias           dir                      Get-ChildItem

同じ感じで、pwd、cp、mv、ps、pushd、popd、rm などの alias がデフォルトで登録されているし、追加で登録することもできる。ちなみに、このワンライナーの意味はこの記事を読み終わった頃には理解できるはず。

変数にオブジェクトを格納

Powershell は強力なスクリプト環境をそなえている。

まずは ls の結果を $files 変数に代入してみる。

PS> $files = ls

$files と入力して Enter を押すと、$files 変数の中身が評価される。

PS> $files

    Directory: Microsoft.PowerShell.Core\FileSystem::C:\
    Documents and Settings\nitoyon

Mode             LastWriteTime   Length Name
----             -------------   ------ ----
d---s     2006/02/19     22:35          Cookies
d-r--     2006/02/17     23:39          Favorites
d-r--     2006/02/19     18:56          My Documents
d-r--     2004/08/19      9:56          スタート メニュー
d----     2006/02/19     23:06          デスクトップ

で、ここで面白いのが、$files に入ってるのが実は文字列じゃないところ。なんと、$files にはファイルオブジェクトの配列が格納されている。

ということで、length プロパティで数が分かる。

PS> $files.length
5

[0] で最初のオブジェクトにアクセスできる。

PS> $files[0]
Mode                LastWriteTime     Length Name
----                -------------     ------ ----
d---s        2006/02/19     22:35            Cookies

[0 .. 2] で連番にしたり、[-1] で最後のオブジェクトを取得したりもできる。

PS> $files[0 .. 2]

Mode                LastWriteTime     Length Name
----                -------------     ------ ----
d---s        2006/02/19     22:35            Cookies
d-r--        2006/02/17     23:39            Favorites
d-r--        2006/02/19     18:56            My Documents


PS> $files[-1]

Mode                LastWriteTime     Length Name
----                -------------     ------ ----
d----        2006/02/19     23:06            デスクトップ

ファイルオブジェクトのプロパティを参照してもよい。

> $files[0].FullName
C:\Documents and Settings\nitoyon\Cookies

メソッド・プロパティの列挙

オブジェクトのメソッドやプロパティを知りたくなったら、get-member コマンドを実行するとよい。

PS> ls | get-member

   TypeName: System.IO.DirectoryInfo

Name                   MemberType    Definition
----                   ----------    ----------
Create                 Method        System.Void Create(), System.Void C...
CreateObjRef           Method        System.Runtime.Remoting.ObjRef Crea...
CreateSubdirectory     Method        System.IO.DirectoryInfo CreateSubdi...
Delete                 Method        System.Void Delete(), System.Void D...
Equals                 Method        System.Boolean Equals(Object obj)
  :                      :                   :
FullName               Property      System.String FullName {get;}
LastAccessTime         Property      System.DateTime LastAccessTime {get...
LastAccessTimeUtc      Property      System.DateTime LastAccessTimeUtc {...
  :                      :                   :

何気にパイプを使ってるけど、実は、Powershell ではパイプで渡されるのもオブジェクト。すごいですね。

おまけに、System.String などと書いてあるところからピンとくる人もいるかもしれないけど、オブジェクトは .NET Framework 的なオブジェクトになってる。.NET に親しい人ならすごく使いやすいはず。

ループも条件分岐も

それじゃあ、ループを使ってみよう。

次のプログラムは、C:\windows 以下の 1MB 以上のファイルを列挙したところ。

PS C:\WINDOWS> foreach($file in ls){
>>   if($file.length -gt 1MB){
>>     write $file.name
>>   }
>> }
>>
CTDVAUDY.CDF
GEXPlugin.ax
iis6.log
setupapi.del
WindowsUpdate.log

1MB より大きいものだけを if で調べて出力してる。コマンドラインなので、> の変わりに、-gt という演算子が用意されている。

ちなみに、1MB というのはあらかじめ定義されている定数。

PS C:\WINDOWS> 1MB
1048576

よりオブジェクト指向らしく

パイプを使って、よりオブジェクト指向らしいプログラミングを実践してみよう。

where でフィルタリング

さっきの foreach のサンプルは手続き型っぽかったけど、これをかっこよく書き直してみた。

PS C:\WINDOWS> ls | where {$_.length -gt 1mb}

    Directory: Microsoft.PowerShell.Core\FileSystem::C:\
    WINDOWS

Mode             LastWriteTime    Length Name
----             -------------    ------ ----
-a---     2003/02/27     15:29   4481358 CTDVAUDY.CDF
-a---     2006/09/07      1:23   1406464 GEXPlugin.ax
-a---     2008/07/10      3:01   1124405 iis6.log
-a---     2004/08/19     10:40   1080959 setupapi.del
-a---     2008/08/04      1:26   1907044 WindowsUpdate.log

where コマンドは、配列の中から条件にマッチするものだけを返す。絞り込みができるわけ。Perl の grep、Ruby の find_all(や select)、JavaScript 1.6 の filter みたいな感じ。

foreach で全ての要素に対して実行

今度は、パイプの受け口として foreach を使ってみる。

いままで、ファイルのサンプルばかりだったので、次はプロセス情報を使ってみよう。起動中のメモ帳をばっさり閉じる例。

PS C:\WINDOWS> ps -name notepad | foreach {$_.kill()}

notepad.exe のプロセスを列挙して、それぞれについてプロセスオブジェクトの kill() メソッドを実行して殺している。

とはいえ、kill コマンドもあって、プロセスの配列を処理できる。

同じ処理は次のように書ける。

PS C:\WINDOWS> ps -name notepad | kill

さらに、kill コマンドには -name フラグもあるので本当は１発で書けたりもする。

PS C:\WINDOWS> kill -name notepad

でも、複雑な処理をするときには、foreach が便利ですよね、ということで。

プロパティ名で sort

ソートも簡単。

メモリ使用量が多いプロセス top 5 を調べてみる。

PS C:\WINDOWS> ps | sort WS -Descending | select -first 5

Handles   NPM(K)   PM(K)   WS(K) VM(M)   CPU(s)     Id ProcessName
-------   ------   -----   ----- -----   ------     -- -----------
    804       21   30664   45712   189   109.97   1384 explorer
    271       11   32776   42440   161     5.33   2392 firefox
    404        9   42468   40712   175    26.67   3744 powershell
    827       31   27956   32696   226    33.14   2224 msnmsgr
   1761       66   21764   32348   169   107.77   1748 svchost

sort の後にプロパティ名を指定してるだけ。UNIX 系だとソートも文字ベースなんだけど、プロパティ名で色々実現できるのが愉快！

ちなみに、select コマンドは配列を置き換える map のような機能があったり、UNIX コマンドの uniq、head、tail に相当する機能があったり、色んな用途に使える。詳しくは、man select -detailed でヘルプが見れる。

関数を定義する

関数も作れるよ。

メモリ使用量が多いプロセス top N を求める関数を作ってみた。

PS C:> function psmemory([int]$n = 5){ps | sort WS -Descending | select -first $n}

呼び出したところ。

PS C:> psmemory 1

Handles  NPM(K)    PM(K)      WS(K) VM(M)   CPU(s)     Id ProcessName
-------  ------    -----      ----- -----   ------     -- -----------
   1121      22    31092      48496   181   227.88   1384 explorer

引数に 1 を渡しているので、１つだけ表示される。psmemory(1) のように、括弧つきで呼び出すこともできる。パラメータを省略すると5個列挙されるように作ってる。

ところで、勘のいい人なら既に気付いてるかもしれないけど、上で示したサンプル

PS C:\WINDOWS> ls | where {$_.length -gt 1mb}

の {$_.length -gt 1mb} の部分は関数なんです。Powershell では「スクリプトブロック」という名前がついてるんだけど、無名関数と言ったほうが分かりやすいかもしれない。Ruby に詳しい人は、ブロックと言い換えるとすっきりするはず。

というわけで、このサンプルは、ls した結果を where で回して、無名関数でフィルタリングしてる。うわー、オブジェクト指向っぽい！

ドライブ名

Powershell ではドライブ名が名前空間のように振舞ってる。

デフォルトで定義されているドライブ名一覧を見てみよう。

PS> Get-PSDrive

Name       Provider      Root
----       --------      ----
A          FileSystem    A:\
Alias      Alias
C          FileSystem    C:\ 
cert       Certificate   \
D          FileSystem    D:\
Env        Environment
Function   Function
HKCU       Registry      HKEY_CURRENT_USER
HKLM       Registry      HKEY_LOCAL_MACHINE
Variable   Variable

A: や C: はお馴染みなんだけど、それ以外にも色々定義されている。

例えば、Function: や Variable: には関数、変数の一覧が格納されてる。

PS> ls Variable:

Name          Value
----          -----
 :             :
PID           5324
files         {.ssh, Contacts, Cookies, Favorites...}
 :             :

あらかじめ定義されている PID などに加えて、自分で定義した $files も列挙されているのが分かる。

他にも、cert: は証明書ストア、HKCU: や HKLM: はレジストリ情報を表す。これらの情報をファイルシステムのように抽象化されていて、ls や cd で参照したり、検索したりできるようになってる。

この仕組みの肝が Privider。列挙したり参照したりする機能を提供している。Provider は C# で自前実装することもできて、例えば、id:coma2n さんによる PowerShellで2chビューワなんかが面白い。2ch ドライブで 2ch の掲示板情報を参照できるようだ。

Provider から新たなドライブを作成することも可能。例えば、FileSystem プロバイダを使って、ホームディレクトリを home: ドライブとして割り当るには次のようにする。

PS> New-PSDrive -Name home -PSProvider FileSystem -Root $home

Name       Provider      Root
----       --------      ----
home       FileSystem    C:\Documents and Settings\nitoyon

PS> ls home:
# ホームディレクトリのファイル一覧

まぁ、あくまで Powershell 内での擬似的なドライブなんだけど楽しい。