【PowerShell】処理実行時のログファイルへの標準出力

MS-DOSの文字コード指定#

MS-DOS（Version 10.0.22631.4317）では、文字コードがデフォルトでANSIになります。Microsoft様が作った、Shift-JISに似たような文字コードですね。

ちなみに、MS-DOSのバージョンを確認するためには、コマンドプロンプトを起動して、verを実行して確認できます。

しかし今回は、UTF-8で統一していきたいと思います。こっちの方が化けにくいので。 そこで、DOSでリダイレクトする前にLANGという環境変数を設定していきます。こんな感じです。

1
setlocal
2

3
:: Set UTF-8
4
chcp 65001
5
set logtxt=log_%date:~,4%%date:~5,2%%date:~8,2%.txt
6

7
echo; >> %logtxt%
8
echo ---------------------------------------------------------- >> %logtxt%
9
echo "Started: Z0-00_ready_folders.bat" >> %logtxt%
10
echo; >> %logtxt%
11

12
mkdir 1-1_movie_escaping >> %logtxt% 2>&1
13
mkdir 1-2_create_date_setting >> %logtxt% 2>&1
14
mkdir 5_original_files >> %logtxt% 2>&1
15

16
copy /Y exiftool.exe .\1-1_movie_escaping >> %logtxt% 2>&1
17
copy /Y exiftool.exe .\1-2_create_date_setting >> %logtxt% 2>&1
18

19
echo; >> %logtxt%
20
echo "Finished: Z0-00_ready_folders.bat" >> %logtxt%
21
echo ---------------------------------------------------------- >> %logtxt%
22
echo; >> %logtxt%
23

24
endlocal

chcp 65001というコマンドで、UTF-8で出力できるようにしたので、以下のような感じにテキストファイルに出力されました。65001はUTF-8、932がANSIになります。 ちなみにecho;を実行すると改行文字のみの行が入力されます。

1
----------------------------------------------------------
2
"Started: Z0-00_ready_folders.bat"
3

4
A subdirectory or file 1-1_movie_escaping already exists.
5
A subdirectory or file 1-2_create_date_setting already exists.
6
A subdirectory or file 5_original_files already exists.
7
        1 file(s) copied.
8
        1 file(s) copied.
9

10
"Finished: Z0-00_ready_folders.bat"
11
----------------------------------------------------------

PowerShellの文字コード指定#

PowerShell（ver. 5.1.22621.4249）では、デフォルトでUTF-16 LEになります。

ちなみに、PowerShellのバージョンを確認するためには、PowerShellコンソールを起動して、$PSVersionTableを実行すると「PSVersion」というフィールドで確認できます。

PowerShellでも出力する文字コードをUTF-8に指定します。ここで、リダイレクト出力（>や>>）だと文字コードがデフォルトのものから変更できないので、以下のコマンドを使います。

• 手段1：Out-File系コマンドレット（Out-Fileで新規、Out-File -Appendで追記。）
• 手段2：Content系コマンドレット（Set-Contentで新規、Add-Contentで追記。）

これらのコマンドレットの挙動の違いについては以下の記事に詳しくまとめられていますので、興味があれば参照下さい。ざっと俯瞰した表を、その記事にあったものから拝借させていただきます。

どちらのコマンドレットでもUTF-8を指定してファイルに出力することが出来ます。今回はContent系コマンドレットで作っていこうと思います。

tech.guitarrapc.cóm

PowerShellの Out-File と Set-Content あるいは Out-File -Append と Add-Content の違い - tech.guitarrapc.cóm

ファイルの連結について、いい記事があります。 あるファイルを別のファイルに連結させる 私が書くコードではSet-Content/Add-Contentを使わないです。が、なぜなのかを振り返るのもいいでしょう。 今回は、 Set-Content/Add-ContentとOut-File/Out-File -Appendの違いについてです。 まとめ 上書きと追記 書き込み方法の違い と NoClobber による上書き防止 上書き 上書き防止 Out-File -NoClobber -Force の併用 追記 Out-File -NoClobber -Append の併用 Write/Read ロ…

tech.guitarrapc.com

MS-DOSにおける年月日取得#

MS-DOSでは、%date%で現在の年月日を取得できる環境変数を参照することが可能です。2024年10月29日であれば「2024/10/29」が取得できます。

そして、その数字だけが欲しいので、以下のようにDOS上でフォーマットして、ファイル名としてローカル変数に格納します。

1
set logtxt=log_%date:~,4%%date:~5,2%%date:~8,2%.txt

PowerShellにおける年月日取得#

PowerShellでは、Get-Dateコマンドレットで現在の日時を取得できる環境変数を参照することが可能です。2024年10月29日であれば「Tuesday, October 29, 2024 14:53:32」みたいに取得できます。

そして、その年月日の数字だけが欲しいので、以下のようにPowerShell上でフォーマットして、ファイル名としてローカル変数に格納します。

1
$logtxt = "log_{0}.txt" -f (Get-Date).ToString("yyyyMMdd");

MS-DOS#

MS-DOSは特に厄介なことは起こりません。標準出力および標準エラー出力をまとめて出力するコマンドは1行で事足ります。

1
mkdir 5_original_files >> %logtxt% 2>&1

mkdir 5_original_filesを実行した時に、既にディレクトリが存在しているとエラーというか警告文的なものがコンソールに表示されます。このように書くと、その内容も含めてファイルに出力してくれるようになります。

PowerShell（Sart-Processを使おうとしたが・・・）#

PowerShellの場合は厄介です。

結局のところは、この記事で紹介されている方法を拝受させていただきました。

Qiita

powershell で外部プロセスを起動して標準出力・標準エラー出力を得る - Qiita

概要 PowerShell で 外部コマンドを実行して、エラーになったりするので、標準出力・標準エラー出力を取得できるようにします。 前提 PowerShell: 5.1 補足) $PSVersionTable コマンドを PowerShellのターミナルで叩くとバージ...

qiita.com

当初は、Start-Processコマンドレットの-RedirectStandardOutputと-RedirectStandardErrorのオプションで標準出力と標準エラーを出力しようと思ったのですが、このコマンドレットではファイルへの追記を行うことが出来ないので、今回は使いませんでした。

一応、ファイルの新規作成は可能なので、一時ファイルを作ってその内容を別のコマンドレットに渡してファイル出力するという方法は可能なのですが、この方法だとIOが発生して微かながらディスクを削ることになります。

また、RedirectStandardOutputとRedirectStandardErrorオプションに対して同じ文字列を入力するとシステムエラーになります。なので一時ファイルは2種類作る必要があります。（今回作るツールを100回実行すれば200回余計に削ることになります・・・。）

そこで、もう少し良い方法があるので、このStart-Processコマンドレットはスルーで。

@MicrosoftLearn

Start-Process (Microsoft.PowerShell.Management) - PowerShell

Start-Process コマンドレットは、ローカル コンピューターで 1 つ以上のプロセスを開始します。 既定では、Start-Process は、現在のプロセスで定義されているすべての環境変数を継承する新しいプロセスを作成します。 プロセスで実行するプログラムを指定するには、実行可能ファイルまたはスクリプト ファイル、またはコンピューター上のプログラムを使用して開くことができるファイルを入力します。 実行可能でないファイルを指定 Start-Process 場合は、Invoke-Item コマンドレットと同様に、ファイルに関連付けられているプログラムを起動します。 Start-Process のパラメーターを使用して、ユーザー プロファイルの読み込み、新しいウィンドウでのプロセスの開始、代替資格情報の使用などのオプションを指定できます。

learn.microsoft.com

PowerShell（Register-ObjectEventを使う）#

その代わりに、先ほどの記事で別の方法が紹介されています。

Register-ObjectEventコマンドレットで行うプロセスに関する情報を持ったオブジェクトをエンキューして、変数に出力を格納して、Write-Hostコマンドレットで別のコマンドレットに渡せるようにして下さっています。これでドライブではなくメモリを使うようになりました。ドライブが削られなくなって、処理も速くなることでしょう。

ありがたく使わせていただきます。

1
function Invoke-ExternalCommand([string]$commandPath, [string]$arguments) {
2
  try {
3
    # Creating process object.
4
    $pinfo = New-Object System.Diagnostics.Process
5
    # Setting process invocation parameters.
6
    $pinfo.StartInfo.FileName = $commandPath
7
    $pinfo.StartInfo.Arguments = $arguments
8
    $pinfo.StartInfo.UseShellExecute = $false
9
    $pinfo.StartInfo.CreateNoWindow = $true
10
    $pinfo.StartInfo.UseShellExecute = $false
11
    $pinfo.StartInfo.RedirectStandardOutput = $true
12
    $pinfo.StartInfo.RedirectStandardError = $true
13

14
    # ↓↓↓ (3) 非同期書き込み
15
    # Creating string builders to store stdout and stderr.
16
    $oStdOutBuilder = New-Object -TypeName System.Text.StringBuilder
17
    $oStdErrBuilder = New-Object -TypeName System.Text.StringBuilder
18

19
    # Adding event handers for stdout and stderr.
20
    $sScripBlock = {
21
      if (! [String]::IsNullOrEmpty($EventArgs.Data)) {
22
        $Event.MessageData.AppendLine($EventArgs.Data)
23
      }
24
    }
25
    $oStdOutEvent = Register-ObjectEvent -InputObject $pinfo `
26
      -Action $sScripBlock -EventName 'OutputDataReceived' `
27
      -MessageData $oStdOutBuilder
28
    $oStdErrEvent = Register-ObjectEvent -InputObject $pinfo `
29
      -Action $sScripBlock -EventName 'ErrorDataReceived' `
30
      -MessageData $oStdErrBuilder
31

32
    # Starting process.
33
    [Void]$pinfo.Start()
34
    $pinfo.BeginOutputReadLine()
35
    $pinfo.BeginErrorReadLine()
36
    [Void]$pinfo.WaitForExit()
37
    # ↑↑↑
38

39
    # Unregistering events to retrieve process output.
40
    Unregister-Event -SourceIdentifier $oStdOutEvent.Name
41
    Unregister-Event -SourceIdentifier $oStdErrEvent.Name
42

43
    $oResult = New-Object -TypeName PSObject -Property ([Ordered]@{
44
        "ExitCode" = $pinfo.ExitCode;
45
        "stdout"   = $oStdOutBuilder.ToString().Trim();
46
        "stderr"   = $oStdErrBuilder.ToString().Trim();
47
      })
48
    return $oResult
49
  }
50
  finally {
51
    $pinfo.Dispose()
52
  }
53
}

しかし、ここで一つ解せなかったのが、System.Diagnostics.Process.Argumentsの部分です。

このオブジェクトのそのプロパティでは文字列を格納することが出来るのですが、同じく引数を格納することが出来るプロパティ「System.Diagnostics.Process.ArgumentList」があるのでそちらを使いたかったのですが、なぜか「このオブジェクトにプロパティ’ArgumentList’が存在しません」と表示されてエラーになります。

間違いなく存在するはずなのに・・・PowerShellの謎・・・。

@MicrosoftLearn

ProcessStartInfo.ArgumentList プロパティ (System.Diagnostics)

アプリケーションの起動時に使用するコマンド ライン引数のコレクションを取得します。 リストに追加された文字列は、以前にエスケープする必要はありません。

learn.microsoft.com

PowerShell（Write-HostではなくWrite-Outputを使う）#

Register-ObjectEventでジョブを登録して、実行が終わったジョブをUnregister-Eventで破棄する。 そんな処理をしている先程のInvoke-ExternalCommandを実行する部分をさらにまとめます。Edit-Exifという関数を作って、実行部分とログ出力部分の双方をまとめました。

1
function Edit-Exif([string]$workingPath, [array]$argumentArray) {
2
  cd $folderDir;
3
  $arguments = $argumentArray -join " ";
4
  $strCmd = "${folderDir}\exiftool";
5
  Write-Output("+ $strCmd $argumentArray") | Add-Content -Path "..\$logtxt" -Encoding utf8;
6
  $oResult = Invoke-ExternalCommand $strCmd $arguments;
7
  Write-Output $oResult.stdout | Add-Content -Path "..\$logtxt" -Encoding utf8;
8
  Write-Host $oResult.stdout;
9
  Write-Host $oResult.stderr -BackgroundColor DarkRed;
10
  Write-Output $oResult.stderr | Add-Content -Path "..\$logtxt" -Encoding utf8;
11
};

このInvoke-ExternalCommandを呼び出す部分で、紹介した記事ではWrite-Hostのみが使用されていましたが、そのコマンドレットですとファイルに出力することが出来ません。

そのため、Write-HostではなくWrite-Outputを使います。（ちなみに、久し振りにPowerShellを触った僕はここで沼りました・・・。）

例えば、このような出力がコンソールで流されている場合・・・、

このようにテキストファイルの中に出力されるようになります。

1
1-1_movie_escaping ++++++++++++++++++++++++++++++++
2

3

4
Edit-Exif Started ++++++++++++++++
5

6
+ .\1-1_movie_escaping\exiftool -CreateDate<FileModifyDate -d %Y:%m:%d:%H:%M:%S .\1-1_movie_escaping
7
1 directories scanned
8
    1 image files updated
9
Warning: [Minor] Extracted only 1000 xmpMM:Pantry items. Ignore minor errors to extract all - ./1-1_movie_escaping/ROG_Content_01_Face_MB.mp4
10
Warning: [minor] Excessive number of items for xmpMM:Pantry. Processing may be slow - ./1-1_movie_escaping/ROG_Content_01_Face_MB.mp4
11

12
Edit-Exif Ended ++++++++++++++++