开发和下载开源软件

查看 comment-replace.php

类别(标签)树

文件信息

类别(标签)
文件名
comment-replace
最后更新
2011-09-05 02:20
类型
Plain Text
编辑器
Mizuki Yamanaka
描述
ソースコードの特定のアノテーションの文言を修正するPHPスクリプトです。
语言
日语
翻译
<?php
/**
 * ソースコードのドキュメントコメントで、指定したアノテーションの
 * 文言を変更するPHPスクリプトです。
 * 引数なしで実行すると、使い方を表示します。
 *
 * @copyright   Copyright (c) 2010 SetucoCMS Project.
 * @author charlesvineyard
 */

// 置換対象のファイルの拡張子
$targetFileExts = array('.php', '.phtml', '.js', '.css');

$minArgc = 4;    // 引数の最低個数(1の場合は実行ファイル名のみ)
if ($argc < $minArgc) {
    printUsage();
    exit;
}

$pathBeginPos = 3;    // 実行時引数のうち、ファイル名もしくはディレクトリ名の位置
$filenames = array();
for ($i = $pathBeginPos; $i < $argc; $i++) {
    $path = $argv[$i];
    getList($path, &$filenames, $targetFileExts);
}

$annotation = $argv[$annotationPos = 1];
$word = $argv[$wordPos = 2];

echo implode("\n", $filenames);
echo "\n以上のファイルの " . $annotation . ' の内容を ' . $word . " に変換します。\n";

echo "\nよろしいですか?(y/n)";

$input = trim(fgets(STDIN, 10));
if (stripos($input, 'y') !== 0) {
    exit;
}

foreach ($filenames as $filename) {
    $fileContents = file_get_contents($filename);

    $ptn = "/(@${annotation}[\s]+)[^\s].*/";
    $replacedContents = preg_replace($ptn, '${1}' . $word, $fileContents);

    $fp = fopen($filename, 'w');
    flock($fp, LOCK_EX);
    fputs($fp, $replacedContents);
    flock($fp, LOCK_UN);
    fclose($fp);
    echo "{$filename} ... 完了\n";
}

exit;

/**
 * ディレクトリパス内のファイルのリストを取得します。
 * . もしくは .. は除外します。
 *
 * @param string $dirPath ディレクトリパス
 */
function getList($dirPath, $filenames, $targetFileExts) {
    if (is_file($dirPath)) {
        if (!isInvisibleFile($dirPath) && isTargetFile($dirPath, $targetFileExts)) {
            $filenames[] = $dirPath;
        }
        return $filenames;
    }

    // 最後に区切り文字があれば削除
    if (strrpos($dirPath, DIRECTORY_SEPARATOR) === (strlen($dirPath) - 1)) {
        $dirPath = substr_replace($dirPath, '', -1, 1);
    }

    $dir = dir($dirPath);
    while ($path = $dir->read()) {
        if ($path === "." || $path === "..") {
            continue;
        }
        $longPath = $dirPath . DIRECTORY_SEPARATOR . $path;
        getList($longPath, &$filenames, $targetFileExts);
    }
    return $filenames;
}

/**
 * 隠しファイルかを判断します。
 *
 * @param  string $path ファイルパス
 * @return 隠しファイルなら true
 */
function isInvisibleFile($path) {
    $filename = $path;
    if (strpos($filename, DIRECTORY_SEPARATOR) !== false) {
        $filename = substr($filename,
                strrpos($filename, DIRECTORY_SEPARATOR) + 1);
    }
    return (strpos($filename, '.') === 0);
}

/**
 * 置換対象のファイル拡張子かを判断します。
 *
 * @param string $path           ファイルパス
 * @param array  $targetFileExts 置換対象の拡張子の配列
 */
function isTargetFile($path, $targetFileExts) {
    foreach ($targetFileExts as $ext) {
        if (strrpos($path, $ext) === strlen($path) - strlen($ext)) {
            return true;
        }
    }
    return false;
}

/**
 * 当スクリプトの使い方を表示します。
 *
 * @return void
 */
function printUsage() {
    // $argv[0] means this script file.
    // $argv[1] --args is passing after arguments to script.
    echo "usage:\n"
    . "\tphp " . basename(__FILE__) . " {annotation} {words} {file or directory list}\n"
    . "example:\n"
    . "\tindex.php ファイルの @license の内容を\"新しい内容文\"に置換するときの例\n"
    . "\tphp " . basename(__FILE__) . " license 新しい内容文 index.php\n"
    . "{annotation}\n"
    . "\t置換対象の、@無しのアノテーションを指定します。\n"
    . "{words}\n"
    . "\t置換する内容文を指定します。スペースを含む場合は\"\"で囲ってください。\n"
    . "{file or directory list}\n"
    . "\t置換するファイル名またはディレクトリ名を指定します。\n"
    . "\tファイルはスペース区切りで複数指定可能です。\n"
    . "\tディレクトリを指定すると再帰的に置換します。\n"
    . "\t隠しファイルは含まれません。\n";
}