こんにちは、高木です。
ここのところ、PHPでC言語やC++の前処理を行う話題が続いています。最近ちょっとややこしい話題が増えすぎた反省から、今回はやや簡単な内容にしたいと思います。ソースコードにライセンス表示を埋め込むことは多いと思いますが、手作業でやっていると何かと面倒ですし、間違いも起きやすくなります。こういうのこそ自動化してしまいましょう。
何か具体的なライセンス文言があった方が話がしやすいので、今回は下記の修正BSDライセンスを埋め込むことを考えます。
|
0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
Copyright (c) <YEAR>, <OWNER> All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the <organization> nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
これをソースコードに埋め込むことになるのですが、2点ほど加工が必要になります。ひとつはソースコードには埋め込むにはコメントの形式にしないといけないこと、もうひとつは先頭行の<YEAR>と<OWNER>を適切な内容に変更してあげる必要があることです。
コメントにするには、最初と最後に「/*」と「*/」を出力するだけでもいいのですが、今回は1行ずつ行頭に「//」を追加することを考えます。<YEAR>は発表年なのでファイルのタイムスタンプから読み取るのは不適切で、基本的には明示的に指定すべきものです。<OWNER>は著作権者なので、これも明示的に指定すべきものです。ただし、利便性を考慮して、明示的な指定がなければ、<YEAR>には現在の年を、<OWNER>にはGitのユーザー名を埋め込むことにしましょう。
この方針で書いたPHPのコードは次のようになります。
|
0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
<?php function make_license(string $path, ?int $year = null, string $owner = null): string { // 公表年 if (is_null($year)) $year = date('Y'); // 著作権者 if (is_null($owner)) $owner = trim(`git config user.name`); $contents = trim(file_get_contents($path)); $contents = str_replace([ '<YEAR>', '<OWNER>' ], [ $year, $owner ], $contents); $contents = str_replace([ "\r\n", "\r" ], "\n", $contents); $array = explode("\n", $contents); return '// ' . implode("\n// ", $array); } ?> |
str_replece関数を2回呼んでいて若干冗長なのですが、わかりやすいようにあえてこのようにしました。最初のstr_replace関数の呼び出しで<YEAR>と<OWNER>を置換し、2回目のstr_replace関数の呼び出しで改行文字を揃えています。その後、いったん行ごとに分解してから「// 」を行頭に付加して再結合しています。
こういう処理はPHPのようなスクリプト言語は得意ですので、どんどん活用していきたいものです。
