xargs チェックシート

xargsについて気にしなければならないことがやたら多いので覚書を作成した。

[![alt](http://www.plantuml.com/plantuml/svg/lLHBJzj04BxxL-mHf5IbxqSEfSTUUkcfHpVP1Ak9ZMn7HJrbTmc41oA2XXI86X1l0ccaz24AbF_IoPhmBpgx8SL5XdBgoRkpkzzytpSp7lHyq_LpsOpXlRNiOTCrioIHCJtlkU-xrfkSJrya7FkLzPwIWT2Lh6CxYI7NoLBYkpaQEl66pAJpphBJ96LcF6eOEe5XM2dIbxBi94dI3FLfZD0HcW3s4rWDs6UrILeki2rWky3dWMq3czBhgNxY3r6RzBscNhz1o5FoQspkJjoWY4xwNZegfi1bOKDEBYCMY74Gko1gm4_QXnjoVK71yWCGIo2ES1730n0BiU33GMTr6lYSBDM1vp7XiqkvkiYt1e0ZNWNuTn1R85h06i0uKXintRGd6xNEMY7ozJdRkt6zKumLNXJ1UfU-B0XSemYv_r5MqOCAiAAoWOq62-DoloAB69dkPhykvRsBbDgayDdz-FdEyvtXxZKxQQMCtlUoeQSxFsxa4_0MY4_A7p6X91oLWt9Jaw_e2l1WT5OkjyxoIy0dvLIvVLm5jXWf9EHMsiuHxJCIQ1-V05i3jeb-_CE01r46NAzJrxS5l0cY7WEHnnx15N0ys56T8ueOBO4GEeJzX56X7stypoQAgEZ3-0ta1TMwREAyrV_qVR2t0cnMhdoHfMAlgo88w1IFuXV0vn-5VjfOFIsDTVA5O7ldRB64TKObY1vPs8XHBGDV1RwEFilIp9NcTRusWzfX5pFyvhOQ9Ru6OWyuWXLnh12rVOXrszIp_at9dP_1Jklncmwg4rrcLndzEChCaEI_1JOmOTgbmn7SDTgJUE-jdhP1tE3VzZS0)](http://www.plantuml.com/plantuml/uml/lLHBJzj04BxxL-mHf5IbxqSEfSTUUkcfHpVP1Ak9ZMn7HJrbTmc41oA2XXI86X1l0ccaz24AbF_IoPhmBpgx8SL5XdBgoRkpkzzytpSp7lHyq_LpsOpXlRNiOTCrioIHCJtlkU-xrfkSJrya7FkLzPwIWT2Lh6CxYI7NoLBYkpaQEl66pAJpphBJ96LcF6eOEe5XM2dIbxBi94dI3FLfZD0HcW3s4rWDs6UrILeki2rWky3dWMq3czBhgNxY3r6RzBscNhz1o5FoQspkJjoWY4xwNZegfi1bOKDEBYCMY74Gko1gm4_QXnjoVK71yWCGIo2ES1730n0BiU33GMTr6lYSBDM1vp7XiqkvkiYt1e0ZNWNuTn1R85h06i0uKXintRGd6xNEMY7ozJdRkt6zKumLNXJ1UfU-B0XSemYv_r5MqOCAiAAoWOq62-DoloAB69dkPhykvRsBbDgayDdz-FdEyvtXxZKxQQMCtlUoeQSxFsxa4_0MY4_A7p6X91oLWt9Jaw_e2l1WT5OkjyxoIy0dvLIvVLm5jXWf9EHMsiuHxJCIQ1-V05i3jeb-_CE01r46NAzJrxS5l0cY7WEHnnx15N0ys56T8ueOBO4GEeJzX56X7stypoQAgEZ3-0ta1TMwREAyrV_qVR2t0cnMhdoHfMAlgo88w1IFuXV0vn-5VjfOFIsDTVA5O7ldRB64TKObY1vPs8XHBGDV1RwEFilIp9NcTRusWzfX5pFyvhOQ9Ru6OWyuWXLnh12rVOXrszIp_at9dP_1Jklncmwg4rrcLndzEChCaEI_1JOmOTgbmn7SDTgJUE-jdhP1tE3VzZS0)


## 1. findで用がすむ場合
xargsの左側の大半はfindだと思われるが、
findで全部すむのならfindですました方がよい。

なおfindでもxargsのように複数の行を結合してforkを減らすことができる。
(exec command {} +等)

## 2. -0オプションについて
POSIXではないが-0オプションでnull文字を区切り文字として扱う。
こうすると空白文字やクォーテーション等の文字が含まれていても
分割やエスケープが行われない。
入力側がnull文字区切りに対応している必要がある。

## 3. 特定の文字列をデリミタ代わりにする回避策
改行がデリミタとして使えるのであればスペース,タブをエスケープすれば良い。

入力がファイルパスの場合、正規化された表現なら、
"//"は含まれないはずなので、find .// 等を入力元にすることで
デリミタである改行とファイル名である改行を判別し、
空白文字を適切にエスケープすることができる。([具体例](https://hycon.hatenadiary.org/entry/20100908/1283880457))

## 4. -Iオプションかwhile IFS= read -rを使うべき場合

この場合、複数の引数を渡すのは諦める。

## 5. -rオプションについて
-rオプションで空行に反応しないようにできる。
POSIXではないがgnu以外では不要な対処。
ポータビリティに拘るでのあれば[こちらの記事](https://rcmdnk.com/blog/2017/06/01/computer-linux-gnu-bsd/)を見て対処すると良い。

## 6. ',",\のエスケープ
xargsは上記の文字を特別扱いして空白や改行のエスケープを行うため、
不本意なエスケープが行われないように入力を変換する必要がある。
なお、実装によるエスケープの違いは[こちらの記事](https://qiita.com/richmikan@github/items/bd4b21cf1fe503ab2e5c#%E5%BC%95%E6%95%B0%E6%96%87%E5%AD%97%E5%88%97%E3%81%AE%E6%89%B1%E3%81%84)を参照すること。

## 7. 入力の末尾が改行でない場合
Linuxは問題ないが、ポータビリティを意識するなら、
grep ^を挟むなどの対策を講じる。([詳細](https://qiita.com/richmikan@github/items/bd4b21cf1fe503ab2e5c#%E6%94%B9%E8%A1%8C%E3%81%AA%E3%81%97%E7%B5%82%E7%AB%AF%E3%83%87%E3%83%BC%E3%82%BF%E3%81%AE%E6%89%B1%E3%81%84))

## 8. セキュリティに関する考慮
この場合、セキュリティにうるさいシステムではxargsを使うべきではない。([リスクの詳細](http://quruli.ivory.ne.jp/document/find_4.2.23/find-ja_8.html#Security-Considerations))
findのexecdirを使えば少しはマシになるかもしれない。

## 9. 引数の数で挙動の異なるコマンド
grepくらいしかこの手のコマンドを知らないが、
grepはファイル数が1個の場合はファイルパスを出力しないため、
/dev/nullを渡すのがパターンになっている。
(これにより空白行の対処も可能である。)