Subscribe to my RSS feed
Entry: PHPデバッグ手法2
PHPデバッグ手法2
Initial post:
2008.04.20
|
Last modified:
2008.04.20
先日、HTMLをプレーンテキストに変換する方法を探してるということを書きましたが、w3mというテキストブラウザを同僚に教えてもらったので解決しました。定番のテキストブラウザのようですが、「テキストブラウザ」というジャンル自体を始めて知ったのです。勉強不足。そして、w3mは僕のdebianには入ってませんでしたのでapt-getしましたが、会社の、ここでは絶対使わないだろうっていうサーバーでも何故か必ず入ってるようなので、入ってることを前提にしてもいい世の中かも知れません。ちなみに、僕のサーバーにはlessコマンドが入ってないってことを同僚に呆れられました。
で、w3m。ブラウザなんですが、-dumpオプションをつけることで出力を文字列で受け取ることもできました。また、通常はURLをオプションで渡すようですが、標準入力があればそれをソースとすることもできました。なので、PHPからは、
$html = print_a($var, 'return:1'); $text = `echo "$html" | w3m -dump -I EUC-JP -O EUC-JP -T text/html`;
とすると、変数の構造を表組みのまま、プレーンテキストで得られます。これをログに書き出せば、tailコマンドで監視できます。ちなみに、文字コードをEUCにしているのは、UTF-8だと「East Asian Ambiguous」が原因でレイアウトが崩れるためです。
そんな訳で、全体的には下記のような感じでデバッグ環境が整いました。PHP歴2週間なんで、突っ込みどころは満載です。
ErrorHandle.php
デバッグ用のログを書き出すクラス。エラーエントリをスタックしておいて、後でまとめてログ出力。また、エラーエントリを配列で取り出せるので、ユーザー向けのエラー管理にも使えます。
<?php
class ErrorHandle {
var $filename;
var $logid;
var $entry;
// -----------------------------------------
// Constractor
// -----------------------------------------
function ErrorHandle($args) {
$this->filename = $args['filename'];
$this->logid = $args['logid'];
}
// -----------------------------------------
// Stack entry
// -----------------------------------------
function stack($args) {
// default postion
$caller = debug_backtrace();
if (isset($caller[1]['class']) and isset($caller[1]['function'])) {
$method = sprintf('%s::%s()', $caller[1]['class'], $caller[1]['function']);
$at = sprintf('%s line %d, during %s process',
$caller[0]['file'], $caller[0]['line'], $method);
}
else {
$at = sprintf('%s line %d', $caller[0]['file'], $caller[0]['line']);
}
$args = array_merge(
array('str' => NULL, 'level' => 0, 'at' => $at, 'multiline' => 0), $args);
if ($args['str']) {
// at strings
$at_str = ($args['at']) ? ' at '. $args['at'] : '';
$num = $this->count();
$outstr = $args['str'];
if (! $args['multiline']) {
$outstr = preg_replace('/[¥n¥s]+/', ' ', $args['str']);
}
$this->entry[$num]['str'] = $outstr. $at_str;
$this->entry[$num]['level'] = $args['level'];
}
}
// -----------------------------------------
// Number of error entry
// -----------------------------------------
function count($args = array('level' => NULL)) {
$args = array_merge(array('level' => NULL), $args);
$count = 0;
if (count($this->entry) > 0) {
foreach ($this->entry as $hash) {
if ($args['level'] and $hash['level'] != $args['level']) {
continue;
}
$count++;
}
}
return $count;
}
// -----------------------------------------
// Output the logs and exit
// -----------------------------------------
function end($args = array()) {
// default postion
$caller = debug_backtrace();
if (isset($caller[1]['class']) and isset($caller[1]['function'])) {
$method = sprintf('%s->%s', $caller[1]['class'], $caller[1]['function']);
$at = sprintf('%s line %d, during %s process',
$caller[0]['file'], $caller[0]['line'], $method);
}
else {
$at = sprintf('%s line %d', $caller[0]['file'], $caller[0]['line']);
}
$args = array_merge(
array('str' => NULL, 'level' => 0, 'at' => $at), $args);
$this->stack($args);
$this->log();
exit;
}
// -----------------------------------------
// Returns error array
// -----------------------------------------
function getArray($args = array('level' => NULL)) {
$str_array = array();
foreach ($this->entry as $hash) {
if ($args['level'] and $hash['level'] != $args['level']) {
continue;
}
array_push($str_array, $hash['str']);
}
return $str_array;
}
// -----------------------------------------
// Output to log file
// -----------------------------------------
function log($args = array('level' => NULL)) {
$total_count = $this->count($args);
if ($total_count < 1) {
return $this;
}
$num = 0;
if (! $fhandle = fopen($this->filename, 'a')) {
die("Log File ". $this->filename. " open failed");
}
foreach ($this->entry as $hash) {
if ($args['level'] and $hash['level'] != $args['level']) {
continue;
}
$level = " LV". $hash['level'];
if (preg_match('/¥n/', $hash['str'])) {
$hash['str'] = "¥n". $hash['str'];
}
$result = sprintf("[%s%s] %s", $this->logid, $level, $hash['str']);
if ($total_count > 1) {
$result = " -> $result";
}
$status = '';
if ($num == 0) {
$date = date('D M d H:i:s Y', time());
$status = sprintf("[%s] [client %s]", $date, $_SERVER['REMOTE_ADDR']);
if ($total_count > 1) {
$status .= "¥n";
}
}
$outstr = implode(' ', array($status, $result));
fputs($fhandle, $outstr. "¥n");
$num++;
}
fclose($fhandle);
return true;
}
}
?>
debugPrint.php
debuglib.phpのprint_aメソッドの結果をテキストで取り出す。print_a($var)と書く代わりにdebugPrint::structure($var)と書く。ここでw3mが登場。w3mが見つからない場合はprint_rの結果を出力。この辺のunixコマンドの使い方も突っ込みどころです。クラスにした意味は特にない。
<?php require_once 'debuglib.php'; class debugPrint { function structure($var, $locale = 'UTF-8') { $html = print_a($var, 'return:1'); $html = preg_replace('/¥n|¥t/', '', $html); $html = preg_replace('/<table /', '<table border="1" ', $html); $html = preg_replace('/<style .*<¥/style>/', '', $html); if ($text = debugPrint::_html2text($html, $locale)) { return $text; } return print_r($var, TRUE); } function _html2text($html, $locale) { exec("which w3m", $command, $status); // w3m command not found if ($status != 0) { return; } $html = mb_convert_encoding($html, "EUC-JP", $locale); $return = `echo "$html" | $command[0] -dump -I EUC-JP -O EUC-JP -T text/html`; $return = mb_convert_encoding($return, $locale, "EUC-JP"); return $return; } } ?>
で、使い方。
<? set_include_path(get_include_path() . PATH_SEPARATOR . './lib'); require_once 'ErrorHandle.php'; require_once 'debugPrint.php'; $Errhandle = new ErrorHandle(array('filename' => './log/error.log', 'logid' => 'hoge')); $test_data = array( "company" => "自由民主党", "name" => "小泉純一郎", "birth_month" => 1, "birth_day" => 8, "hobby" => array("opera","X JAPAN","Elvis Aaron Presley") ); $Errhandle->stack(array('str' => debugPrint::structure($test_data), 'multiline' => 1)); $Errhandle->log(); ?>
結果。
ブックマーク
ファイルリスト
ちゃんねるスタイル
ページビューランキング
RSS
Contact