07. シェルスクリプト

Photo by Javardh on Unsplash

シェルスクリプトとは

スクリプトファイルのコマンド化 を利用して，シェルの操作を一つのコマンドに変えるものである． Unix で何回も似たような作業をするときなどには，非常に威力を発揮する．

  繰り返す操作はシェルスクリプトにしておこう

コマンドにしておけば再利用も簡単．

シェルの文法に関しては，Bsh 系シェルと Csh 系シェル(, さらに他のシェル, fish など)でかなり異なる． おおよそ、

• Csh 系の方が人間にとって直感的.
• Bsh 系の方が文法が硬い(= きちんとしている) ("有害な csh プログラミング" という言葉で web を検索してみよう)

という傾向がある． 今回は基本ということで Bsh 系で学習しておこう．

シェルスクリプトを分析してくれるサイト, ソフト

先に紹介しておこう． シェススクリプトについて学んだり，自分でスクリプトを書いたりしているといろいろ疑問が生ずると思う． その際，スクリプトを入力すると分析して解説をしてくれるサイト ShellCheck や、ソフト(Emacs で動作する flycheck のパッケージ flycheck-checkbashisms など¹)は大変役に立つだろう． シェルスクリプトを書いたけれども動作しない、というような時はぜひ有効活用してもらいたい．

上図は ShellCheck を使ってみた様子だ．非アルファベットのファイル名を持つファイルを探すなら ls よりも find の方が良いよ，という親切なアドバイスが出ているのが見て取れるだろう．

上図は Windows 上の Emacs で flycheck-checkbashisms を使ってみた様子だ(スクリプトは本授業の中の一つ)．最後の行にスペルミスを入れてあるのだが，見事に「そこにエラーが有るよ」と指摘しているのが見て取れるだろう．

  プログラムの文法チェッカーは積極的に使おう

上でも紹介した flycheck はシェルスクリプトのみならず，40以上の言語の文法をチェックできる． 少し大きめのプログラムを組むんだ，という場合はこうした文法チェッカーの利用を検討しよう．

準備, 一連の流れ

準備

1．まず、スクリプトファイルがどこにあるのかが統一されていないと環境変数 PATH の設定で困るので、用意していない人はそれらを貯蔵しておくディレクトリを一つに決めて用意しておこう． 多くの場合は、ユーザディレクトリの直下に bin というディレクトリを作ってそれとすることが多いので、ここでもそうしよう．実際には

1cd ~ ; mkdir bin

とすれば良いだろう．

2．用意したディレクトリを環境変数 PATH に追加しよう．

bash を使っているならば通常は ~/.profile ファイル(ログインシェル起動時に読み込まれる) か ~/.bashrc ファイル(対話用に起動するときに読み込まれる)の中でそう設定するのが良いだろう． この二つのファイルの使い分けが効いてくるようなヤバイ設定はしないし、使い分けが面倒だという人は、~/.profile ファイルの中に

1source ~/.bashrc

と書き込んでおいて、設定自体は ~/.bashrc に書き込めば良いだろう． さて、PATH 追加のために書き込む内容だが、具体的には，これらのファイルのどちらかの中の適当なところに

1if [ -d $HOME/bin ]
2        then
3        PATH=$PATH:$HOME/bin
4        export PATH
5fi

などと書き込んでおけば，次回ログイン時よりこれが有効になる．
注: [ や ] の前後に入っているスペースを除去しないこと！ [ は一文字だが，コマンドなのだ．

fish の場合は²，~/.config/fish/config.fish という感じの設定ファイルがあるだろうから，その中に

1set PATH $HOME/bin $PATH

という一行を書き込んでおけばよいだろう．

3．この変更を有効にしよう．いったんログアウトしてから再ログインしても有効になるが、前にも記したように失敗していると危険なので、シェルからそのまま

  bash の場合:

1source ~/.profile

  fish の場合:

1source ~/.config/fish/config.fish

などと source コマンドで読みこめば設定がその場で有効になるのでそうしよう． 設定ファイル中にエラーがあればこの場でわかるので安心だ．

  実習

上の準備 1, 2, 3 を行っておこう．

シェルスクリプト利用の一連の流れ

awk スクリプトの時に解説したことから分かるだろうが、 シェルスクリプトを作って使うには、いつも、次の二段階の作業をしておけば良い． スクリプトを作ったら毎回忘れずに以下のようにしよう．

1. シェルスクリプトを作り，上で用意したディレクトリ ~/bin にいれておく．
2. スクリプトファイルに実行許可を与える．
   例えば，スクリプトファイルが dummy という名前ならば

1chmod u+x ~/bin/dummy

とすれば良い．

シェルスクリプトの基本構造(bash)

スクリプトファイルのコマンド化 を用いてシェルスクリプトは作成される．
スクリプトの先頭行(シバン shbang)にどう書くかであるが，通常は

1#!/bin/sh

と書けば良いだろう．
スクリプトの内容を実行しないで，文法チェックだけ行いたい場合は，

1#!/bin/sh -n

と先頭行に書けばよい． ファイルの削除など，やや危険な作業を行うスクリプトはこれでチェックすると良いだろう．
実行時にスクリプトの内容も表示したい場合は，

1#!/bin/sh -v

と先頭行に書けばよい． スクリプトの動作が望みのものと違う時はこれでチェックするのも良いだろう．

  実習

1．まず、Hello というファイル名で，次のような中身のスクリプトを作る.

1#!/bin/sh
2echo "Hello, world!"

2．そして、上の シェルスクリプト利用の一連の流れ の 1,2 相当を行おう．

3．そして、どのディレクトリからでもよいので，

1Hello

と打ち込んで，作成したシェルスクリプトが動作することを確認しよう．

コマンドの連続実行

コマンドの連続実行等について 連続実行，grouping の部分で学習したが，ここで情報を再度書いておこう．

グループ化の例:
例えば，

1 (cd /tmp; ls -a) 

とすると，サブシェルは /tmp ディレクトリに移動して作業を行うが，作業が終わってサブシェルが終わり、戻ってきた元のシェルでのカレントディレクトリはもとのまま、である． こうしておけば、一時的な作業に伴う副作用が少なく、勘違いが減って間違いも経るだろう．

グループ化の例 2:
グループ化したコマンドの標準出力等は 合わさって出てくる ので、これが便利なことも多い． 例えば，

1 (\ls /tmp; \ls /var) | less 

とすると，/tmp と /var の2つのディレクトリにあるファイルのリストを一度に閲覧できる．

シェルスクリプトの文法

コメントアウト

シェルスクリプト中で ''#'' という文字があると， そこから行末までがコメントとして取り扱われる(ただし，文字列中は除く)．

変数

変数の設定: シェル変数 で学んだように、シェルは変数を持つことが出来る． そしてもちろん、シェルスクリプトの中でもこうした変数が使える．

注1: 変数設定のとき，変数名と「=」の間にスペースを入れると失敗するぞ．
注2: 変数を参照するときは ${変数名} ({ と } で囲む)とした方が，より安全だぞ．

文字列

文字列は quotation で表す． この時， ' (シングルクォート) で囲むのと， " (ダブルクォート) で囲むのでは以下のように性質が異なるので注意が必要だ．

  実習

先の Hello スクリプトを次のように改造しよう.

1#!/bin/sh
2# Greeting Script
3g='Hello, world!'
4d="today is `date +%m/%d`"
5echo $g, $d.

そして，何がどうなっているのか理解しよう．
注: こうしたときに気を使わないといけないということもあり、(以前書いたように)コマンド置換は ` で囲む代わりに $( ) で囲んだ方が気が楽だ．

引数

引数とは，プログラムを起動するときに一緒に与える情報である． 例えば ls -a /tmp とプログラムを実行したら，通常は引数は /tmp の一つである( -a はオプション)． ただし、広い意味で引数は -a , /tmp の二つととらえることもある．

この引数は以下のように扱われる．

引数を処理する shift コマンド

shift というコマンドを実行すると，一つ目の引数の内容が消去され，二つ目以降が前にずれる． 言い換えると， $1 に $2 の内容が入り， $2 に $3 の内容が入り… と いった動作になる． また，この結果としてオプションの数 $# は 1 減る．

  実習

Welcome というファイル名でスクリプトを次のように作ろう．

1#!/bin/sh
2# Welcome Script
3name=`whoami`
4g="($1 says) Thank you, $name"
5echo $g.

そして，このスクリプトを次のように実行してみよう.

1Welcome Smith

そして、なにがおきるか把握して、スクリプトの内容を読んで理解せよ.

入出力

シェルスクリプトが実行中に入出力を行うには，主に次のコマンドを用いる．

実行例:
入力と出力を使っているサンプルとして、下記のようなスクリプトを考えてみよう．

1#!/bin/sh 
2echo -n 'Please input something: '
3read a
4echo 'You input is ' $a

  実習

先の Hello スクリプトをさらに改造して次のようにしよう.

1#!/bin/sh
2# Greeting Script
3g='Hello'
4i='Please tell me your name: '
5o="Oh, nice to meet you"
6echo $g.
7echo -n $i
8read ans
9echo $o, $ans.

そして，このスクリプトを実行してみるとともに，何がどうなっているのか理解しよう．

計算

bash はともかく, オリジナルの sh は計算機能をほとんど持っていない． そこで，互換性を鑑みたシェルスクリプト中で計算を行いたいときは、コマンド置換機能を利用して計算能力をもつ外部コマンドを呼び出す方法などが採られる．

具体的には，簡単な整数計算だけでよければ expr コマンドか bash の算術式展開 $(()) を, やや複雑な実数計算を行いたければ bc コマンドやfish のコマンド math³ などを使って次の例のようにする．

  expr を使った例:

1#!/bin/sh  
2a=5
3b=`expr $a + 10` ; echo $b
4c=`expr $b \* 2` ; echo $c 

上のスクリプト中の最後の行で，文字 * はシェルで展開機能を呼び出してしまうのでそれを防止するために \* として * をエスケープしている．

  bash の機能である算術式展開 $(()) を使った例:

bash には算術式展開と呼ばれる、整数計算機能が付いている． 使い方は簡単で、整数の計算式を $(( と )) で囲むだけでその式が bash によって計算され、結果に置き換えられる．

1#!/usr/bin/bash  
2a=5
3b=$((a+10)) ; echo $b
4c=$((b*2))  ; echo $c 

簡単だし、外部コマンドを呼ばないので計算は速い． bash しか使わないし整数計算しかしないよ，という場合であれば積極的に使っても良いだろう．

  (おまけ) fish の機能である算術式展開 math を使った例:

シェル fish には math という高度な計算機能が組み込まれている． fish はコマンド置換を単なる ( ) で行うので、例は次のようになるだろう．ただし，小数計算も可能なので最後の行はそうした例になっている．

1#!/usr/bin/fish  
2set a 5
3set b (math $a+10) ; echo $b
4set c (math $b\*2) ; echo $c 
5set d (math $c/7); echo $d  # 小数計算も可能．三角関数や対数なんかも計算できるよ．

上のスクリプト中の4行目の行だが，文字 * はシェルで展開機能を呼び出してしまうのでそれを防止するために \* として * をエスケープしている．

  実習

上のスクリプト 3つを試してみよう．ただし、fish がインストールされていない環境の場合は最初の 2つで良い．

  bc -l (bc に ハイフン エル オプションをつけたもの)を使った例

bc は標準入力から計算式をもらって結果を標準出力に出せるので，例えば echo コマンドで式そのものを渡せば済む． なお、bc で小数計算を行うには -l (ハイフン エル) というオプションが必要なので忘れないようにしよう．

1#!/bin/sh  
2a=`echo "4*a(1.0)" | bc -l` ; echo $a
3b=`echo "c($a)" | bc -l` ; echo $b

ちなみに，2行目では円周率 π を，3行目では cos(π) を計算している．

  実習

上のスクリプトを試してみよう.

シェルの関数

Bsh 系シェルでは，「複数のコマンドをまとめて名前をつけたもの」を関数として自分で作ることができ、使える(ただし，Ubuntu の /bin/sh は dash と呼ばれるシェルで，この機能を持たない．Ubuntu の場合は /usr/bin/bash などを指名しよう)．

関数を作るには，

1function 関数名(){
2  コマンド…
3}

という構文を利用する(実は function という文字列は省略できるが…)．

ちなみに，{ から } までの間で, 関数に対する n 番目の引数(スペース区切りで渡す)を $n として参照できる. また，この関数内部だけで「閉じた」変数を使いたければ、関数の内部で local を頭部につけて変数宣言をすればよい． 以下の例を見てみよう．

例:

 1#!/usr/bin/bash
 2
 3function countdown(){
 4  local i=$1
 5  while [ $i -ge 1 ]
 6    do
 7    echo $i
 8    i=`expr $i - 1`
 9    done
10}
11
12countdown 100

というシェルスクリプトはどういう動作をするか，考え，そして動かしてみよう． なお，while コマンドの意味と文法はこのすぐ後で学ぶ．気になる人はそこを読んでから戻ってこよう．

  実習

Hello スクリプトをさらに改造して次のようにしよう.

 1#!/usr/bin/bash
 2# Greeting Script
 3g='Hello'
 4d=`date +%d`
 5dm=`expr $d - 1`
 6t=`date +%H`
 7m=`date +%M`
 8
 9function d2min(){
10  min=`echo "(($1 * 24) + $2) * 60 + $3" | bc -l`
11}
12
13d2min $dm $t $m
14
15echo $g, "about $min minutes have passed this month."

そして，このスクリプトを実行してみるとともに，何がどうなっているのか理解しよう．

シェルの制御構造

ある程度複雑な動作をさせるには、「もし…ならば」とか，「…を繰り返して…」という制御が必要になるだろう． それには次のようにすれば良い．

''if'' … (単純)条件分岐

条件に応じて(二つに)分岐していく． 具体的な構文は以下の通り．

 1if 条件1
 2    then コマンド1 …
 3
 4    elif 条件2
 5        then コマンド2 …
 6    elif 条件3
 7        then コマンド3 …
 8    (以下, elif … then … を好きなだけ繰り返し)
 9
10    else コマンドN …
11fi

条件 の書き方については，このすぐ後学ぶ． なお、elif 以下と else 以下は存在しなくても良い．

そして、上の構文での流れは以下の通りになる．

1. 最初に 条件1 が実行 & チェックされ，
2. 条件1 が成り立つ(= 実行が成功する) → コマンド1… が実行されて if 文は終了する．
3. 条件1 が成り立たない → 次の elif へ．
   そこで条件2 がチェックされ，
   i. 条件2 が成り立つ → コマンド2… が実行されて if 文は終了する．
   ii. 条件2 が成り立たない → 次の elif へ．
   (… 以下，繰り返し …)
4. else に来た場合．無条件で コマンドN が実行されて if 文は終了する．

  実習

次のような内容のスクリプトを作り，実行し，その動作を推測、理解しよう． ただし，if のすぐ後の [ -e $fn ] という部分については後述するので理解は後回しでよい.

 1#!/bin/sh
 2
 3fn=~/.bashrc
 4
 5if [ -e $fn ]
 6  then
 7    cat $fn
 8  else
 9    echo "You has no $fn."
10fi

''case'' … (パターンマッチ)条件分岐

ある「文字列」が用意したパターンとマッチするかどうかで分岐する． 単純な列挙の場合分けに便利． パターンは ¦ で区切って並列表記(or を意味する)することもできる．

具体的な構は文以下の通り．

1case 文字列 in
2  パターン1) コマンド1… ;;
3  パターン2) コマンド2… ;;
4
5  ( 以下, パターンk) コマンドk…;;  を好きなだけ繰り返し )
6
7  *) コマンドN…
8esac

注: *) は「なににでもマッチする」．なお、この指定はしなくても良い．

流れは以下の通り．

1. 最初に 文字列 を評価して，
2. 文字列がパターン1 とマッチする → コマンド1… が実行されて case 文は終了する．
3. マッチしない → 次のパターンとマッチするか (以下繰り返し)
4. *) に来た場合．無条件で コマンドN が実行されて case 文は終了する．

  実習

次のような内容のスクリプトを作り，実行し，理解しよう．

 1#!/bin/sh
 2
 3echo -n "Please input file name: "
 4read fn
 5
 6case $fn in
 7  *.txt )
 8    echo "$fn is text file.";;
 9  *.c )
10    echo "$fn is C program file.";;
11  * )
12    echo "Hey, what is $fn ? You know it?";;
13esac

''for'' … あてはまる変数の繰り返し

パターンやリストの中のものを列挙してなにかしたいとか、単純に繰り返すというときは for を使うと良い． ただし，Ubuntu などの dash (= /bin/sh)ではこの機能は使えない．この機能を使う場合は /usr/bin/bash などを指名しよう．

具体的な構文は

1for 変数 in パターンorリスト
2do
3  コマンド…
4done

という感じで、動作としては以下のようになる．

1. まず，in に続くパターンorリストを展開して，リストを生成する．
2. そのリストの要素を順番に in の前の 変数 に代入して，そのたびに do と done の間のコマンド… を実行する．

  実習

次のような内容のスクリプトを作り，実行し，理解せよ.

1#!/usr/bin/bash
2
3for x in {0..10}
4do
5  v=`echo "$x * 0.31415" | bc -l`
6  echo "sin($v) = " `echo "s($v)" | bc -l`.
7done

''while, until'' … 条件チェックつきでの繰り返し．

繰り返すたびに、ループをぬけ出す条件をチェックするならばこれだ． 具体的な構文と動作の流れは以下の通り．

1while 条件
2do
3  コマンド…
4done

なお、until の構文も同じ． 動作は以下の様な感じだ．

1. 条件が成り立つかチェックする．
2. [ while の場合] 成り立つならば，
   [ until の場合] 成り立たないならば，
   コマンド… を実行してから 1. へ戻る．以下，繰り返し．

  実習

次のような内容のスクリプトを作り，実行し，理解しよう. ただし，while のすぐ後の [ $x -le 10 ] という部分については後述するので理解は後回しでよい.

 1#!/bin/sh
 2
 3x=0
 4
 5while [ $x -le 10 ]
 6do
 7  v=`echo "$x * 0.31416" | bc -l`
 8  echo "sin($v) = " `echo "s($v)" | bc -l`.
 9  x=`expr $x + 1`
10done

''break'' …ループ脱出．

時々必要なコマンド．このコマンドが実行されると，for，while, until のループの中から脱出する．

''exit'' … 終了．

シェルスクリプトを終了するコマンド．

条件式および条件式のチェック

これまで何回か出てきた条件式について述べよう． Bsh 系シェルでは，条件は基本的に

1[ 条件式 ]

という形式で書かれる．

  条件式の文字 [ の周囲にはスペースが必要

この文字 [ は条件式をチェックする機能を持つ、たった1文字の「コマンド」なので、スペース無しで前後になにかくっつけるとおかしなことになる．

そして、中身の条件式であるが，これは基本的に「単項演算子」か「二項演算子」と項目の組み合わせである．以下、みてみよう．

ファイルに関する条件式

  実習

制御構造 if のところの実習例などを参考にして，上の条件をなるべく全部試すスクリプトを作成してみよ.

文字列に関する条件式

  実習

制御構造 if のところの実習例などを参考にして，上の条件をなるべく全部試すスクリプトを作成してみよ.

数値に関する条件式

ちなみに、条件式の判定には整数しか使えないぞ！ 気をつけよう．

  実習

制御構造 if のところの実習例などを参考にして，上の条件をなるべく全部試すスクリプトを作成してみよ.

その他 条件式

  実習

制御構造 if のところの実習例などを参考にして，上の条件をなるべく全部試すスクリプトを作成してみよ.

レポート

以下の課題について能う限り賢明な調査と考察を行い，
2023-AppliedMath7-Report-07
という題名をつけて e-mail にて教官宛にレポートとして提出せよ. なお，レポートを e-mail の代わりに TeX で作成した書面にて提出してもよい.

  注意
　　近年はセキュリティ上の懸念から，実行形式のプログラムなどをメールに添付するとそのメールそのものの受信を受信側サーバが拒絶したりする． そういうことを避けるため，レポートをメールで提出するときは添付ファイルにそういった懸念のあるファイルが無いようにしよう．

まあ要するに，レポートは pdf ファイルにして，それをメールに添付して送るのが良い ということだと思っておこう．

課題

1. 引数1 に「金額」を，引数2 に「日数」を入れると， その金額でその日数だけお金を借りたら最終的にいくらになるかを計算するシェルスクリプトを作成してみよう．
   ただし，金利は 10日で 1割の複利としておこう．
   ちなみに，read コマンドを使わずにシェルスクリプトの引数をきちんと処理する方法が望ましい．
   
   
2. ファイルを消去するシェルスクリプトを作成してみよう．
   ただし，次のように「バックアップを用意する」ような動作をするようにせよ．
   
   
   1. 実行時にはまず、ファイルのバックアップファイルがあるかどうか調べ，
      • 無い場合は作成する．
      • 有るが、その数が3つ以下の場合は新たにバックアップファイルを作成する．
      • 有り、かつ、その数が3つより多い場合は、一番古いバックアップファイルを消去し、新たにバックアップファイルを作成する．
   2. 以上のバックアップ作業を行った後，ファイルを消去する．
      
      
3. これまでインストールしていない人は自前の環境などにシェル fish をインストールするなどして、今回の授業課題を fish のシェルスクリプトとして書くならばどうなるか(一部で良いので)試してみよう．文法等がより素直なことがわかるだろう．
   
   
4. 自分の使っているエディタ(emacs や vi などでなくても良い)に flycheck のようなプログラミング言語の文法をチェックしてくれる機能を利用できないか調べてみよう． こうした機能が豊富だろう，近代的で有名どころのエディタには Visual Studio Code などがあるので，そうしたものを調べ見てみるのもよいだろう．
   
   
5. これまでの授業課題でシェルスクリプトを利用して解決できる課題がないか考えよう．もしもあるならば実際にやってみよう．