2007年10月10日

FirebugでPHPをデバッグするツールまとめ

asial

Pocket

こんにちは、亀本です。最近は体調がすこぶる絶不調です。季節の変わり目なので、皆さんも気をつけてください。

さて、ちょろちょろと話題に上ることの多いFirefoxを使ったPHPのデバッグ手法ですが、いくつか出てきたのでこの辺でサクッとまとめておこうかと思いました。
結果的に、だいぶ膨らみましたが。。。まとめ力ないなorz

1.Buggy クラス

AJAX magazine というサイトで公開されていたサンプルスクリプトで、クラス１つだけの小さなライブラリです。
以前、PHPプロ！ニュースでもご紹介した方法です。

この方法は、PHPのエラーをハンドリングし、その内容をscriptタグに出力し、console.info()を用いてFirebugのコンソールに渡す、という仕組みです。そのため、Firebugは必須です。

記事掲載当時は、buggy.class.phpがダウンロードできたのでしょうか。。。リンク先には今はダウンロードリンクがなく、サンプルコードが掲載されているだけなので、コピペするなりして保存してください。
一応、利便性のために現時点でのbuggy.class.phpのコードをこちらのブログにも掲載しておきます。


<?php
/**
 * Buggy inside Firebug - Advanced
 * 
 * @package GONX
 * @author hatem <hatem at php dot net>
 * @website http://phpmagazine.net
 * @copyright Copyright (c) 2005-2007
 * @version $Id: buggy.class.php,v 2.2 2007/02/10 04:10:12 hatem Exp $
 * @access public
 **/
class buggy {
function _init(){
$old_error_handler = set_error_handler(array("buggy","ErrorHandler"));
define ("FATAL",E_USER_ERROR);
define ("WARNING",E_USER_WARNING);
define ("NOTICE",E_USER_NOTICE);
// configure reporting level
error_reporting (FATAL | WARNING | NOTICE);
}
/**
 * Buggy::getmicrotime()
 * 
 * @return 
 **/
function getmicrotime(){
$mtime = microtime();
$mtime = explode(" ",$mtime);
$mtime = $mtime[1] + $mtime[0];
return ($mtime);
}
/**
 * Buggy::SetMicroTime()
 * 
 * @param $module
 * @return 
 **/
function SetMicroTime($module)
{
global $Buggy;
$Buggy[$module] = Buggy::getmicrotime();
return $Buggy[$module];
}
/**
 * Buggy::GetExecutionTime()
 * 
 * @param $module
 * @return 
 **/
function GetExecutionTime($module)
{
global $Buggy;
$end = Buggy::getmicrotime();
$res = $end - $Buggy[$module];
return $res;
}
/**
 * Buggy::Track()
 *
 * @param $module
 * @param $msg		additional message to display
 * @return 
 **/
function Track($module, $msg = '') {
global $Buggy;
if (!isset($Buggy[$module])) {
Buggy::SetMicroTime($module);
} else {
$duration = Buggy::GetExecutionTime($module);
Buggy::logMessage($module,'Notice',$msg,$duration);
}
}
/**
 * Buggy::logMessage()
 * 
 * @param string $module
 * @param string $type
 * @param string $message
 * @param string $duration
 * @return 
 **/
function logMessage($module = '', $type = '', $message = '', $duration = ''){
if ($module == 'PHPError') {
if ($type == 'WARNING') {
echo "<script>console.warn(\"[Buggy] - $module [$type] - $message\")</script>\n";
} elseif ($type == 'Fatal') {
echo "<script>console.error(\"[Buggy] - $module [$type] - $message\")</script>\n";
}else{
echo "<script>console.info(\"[Buggy] - $module [$type] - $message\")</script>\n";
}
} else {
echo "<script>console.info(\"[Buggy] - $module [$type] - $message - Execution Time: $duration \")</script>\n";
}
}
/**
 * Buggy errors manager
 * 
 * @param $errno
 * @param $errstr
 * @param $errfile
 * @param $errline
 * @return 
 **/
function ErrorHandler ($errno, $errstr, $errfile, $errline) {
  switch ($errno) {
  	case FATAL:
Buggy::logMessage('PHPError', 'Fatal', "{$errno} : $errstr - Fatal error in line ".$errline." of file ".$errfile);
exit(1);
break;
case WARNING:
Buggy::logMessage('PHPError', 'WARNING', "{$errno} : $errstr - WARNING error in line ".$errline." of file ".$errfile);
break;
default:
Buggy::logMessage('PHPError', 'Notice', "{$errno} : $errstr - Notice error in line ".$errline." of file ".$errfile);
break;
  }
}
}
?>

使い方は単純で、buggy.class.phpをインクルードしてInit()メソッドを実行したら、あとはエラーが発生した個所にscriptタグが挿入されます。


<?php
require_once "buggy.class.php";
Buggy::Init();
trigger_error("わーにんぐ", WARNING);
trigger_error("のーてぃす", NOTICE);
trigger_error("ふぇーたるえらー", FATAL);
?>

ハンドリングしているのは上記の３つのエラーログのみです。
このサンプルはtrigger_errorでエラーを発生させているので、当然ですがFATALで止まります（＾＾；

かなり偏った実装なので、このままだとデバッグを行うというよりは、エラーログを取得するのが主目的になります。
ですが、ソースは単純で拡張も容易なので、logMessageメソッドを拡張したり、独自のデバッグ情報取得メソッドを実装してもよいでしょう。

簡易なライブラリですが、ややこしいことはほとんど考える必要もないので、小さなプログラムの開発を行う時には、わりと気楽に使えそうです。

2.PEAR::Log

言わずとしれたPEARライブラリのLogクラスですが、実はFirebugにログを出力する機能を備えていました。
これは先日、こちらの記事によって有名になった機能です。
案としては結構前からあり、今年の5月にリリースされた1.9.11での実装だったんですが、あまり知られていない機能だったようです。

かくいう自分もこんな話は忘却の彼方でした(＾＾；
こういうものをパッと発掘して試せる人ってすごいですよね。

基本的な発想はBuggyクラスと同じで、PEAR::Logで発生させたエラーログを、console.info()等を使ってFirebugのコンソールに渡しています。

使い方は・・・上記のサイトを見てもらった方が早いかもしれませんが、せっかくなので載せておくと


<?php
require_once "Log.php";
$firebug =  &Log::singleton('firebug', 'test', 'PHP LOG',  array('buffering' => true), PEAR_LOG_DEBUG);
$firebug->log('わーにんぐ', PEAR_LOG_WARNING);
$firebug->debug('でばっぐー');
$firebug->info('いんふぉ');
$firebug->err('えらー！！');
$firebug->crit('くりてぃかる！！');
$firebug->warning('これもわーにんぐ');
$firebug->debug($_SERVER);
?>

これを実行すると、Firebugのコンソールに各種ログが出力されます。

最初にsingletonメソッドでインスタンスを生成しています。
singletonメソッドは、第１引数に出力ログの種類を指定し、第２引数にその名前、第３引数に識別子、第４引数に出力ログのオプション、第５引数に出力するログレベルの下限を指定します。

後はひたすらlogメソッドでログを出力させています。
debugなどの各メソッドは、logメソッドの第2引数を省略する際のショートカットになっています。

発生させることのできるログの種類は、PEAR::LogライブラリのユーザードキュメントにあるLog Levelsの項を参照してください。

最後のdebugメソッドのように変数を出力しておくことで、デバッグ情報をいちいちwindow上に表示させずにFirebugコンソールで確認する、といったデバッグ手法が利用できます。singletonメソッドの第５引数を変えるだけで出力されるエラーレベルが変更できるので、環境による使い分けも楽に出来ます。

なお、このPEAR::Logライブラリは、以前PHPプロ！Tips MLでも取り上げましたが、このFirebugでのログ取得以外にも多くのログ出力機構をもっています。
Tips MLの紹介内容は少々古く、現在ではPHPプロ！Tips MLの掲載内容に加えて、daemon/display/error_log/mdb2/win(window)/null/sqlite/firebug といった方式が追加されています。
さらに、compositeというハンドラを用いることで、複数の出力を組み合わせて使用することが可能になるなど、かなり多機能です。

Firebugで出せる事自体よりも、そういった高機能ロギングライブラリとして、PEAR::Logはお勧めです。
# Firebugで出す機能がしょぼい、ってことじゃないですよ(＾＾；

3.FirePHP

FirePHPは、PHPライブラリとFirefoxのエクステンションを併用することで、Firebugに便利なPHP専用コンソールを増設してくれるライブラリ群です。

上記2つがscriptタグを用いてログをJavaScriptで出力する方式だったのに対し、こちらはFirefoxエクステンションを用いることで、HTMLに一切の変更を加えることなくデバッグ情報をやり取りします。
また、そもそも中心となる目的も上記ふたつとは少し異なっており、ログを出力するよりもデバッグ情報をやり取りする事に重点を置いています。

方式としては、PHP側とFirefoxエクステンション側で共通に使用するヘッダとして、「X-PINF-org」接頭辞のついた独自ヘッダを利用してデータのやり取りを行います。
必要な情報は全てHTTPヘッダでやり取りしてしまうので、表示側には余計なデータが現れません。

エクステンションとPHPのPEARパッケージはこちらのページからインストールとダウンロードが可能です。

実行するサンプルは以下です。


<?php
require_once "FirePHP_Build/Init.inc.php";
FirePHP::Init();
$hoge1 = "ほげ1";
$hoge2 = "ほげ2";
$hoge3 = "ほげ3";
FirePHP::SetVariable(true, array('REQUEST','TEST1'), $hoge1);
FirePHP::SetVariable(true, array('SESSION','TEST2'), $hoge2);
FirePHP::SetVariable(true, array('APPLICATION','TEST3'), $hoge3); // これは動かない。。
?>

Init()メソッドを呼び出し、あとは適宜SetVariableメソッドでFireBugに渡すようにアサインするだけです

FirePHPエクステンションをインストールしたFirefoxのFirebug内に、FirePHPのタグが出来上がっており、上記のスクリプトにアクセスすると、デフォルトでアサインされているスーパーグローバル変数群とともに、SetVariableメソッドでアサインしたデータが表示されます。

なお、デバッグデータの受け渡しが行われるため、セキュリティを気にする必要がある場合にはCookieによるアクセスキー設定が可能です。Init()メソッドの前で
FirePHP::SetAccessKey('適当な文字列');
としてアクセスキーとなる文字列を設定し、これをFirePHP-AccessKeyというクッキーの値として持たせておくことで、クッキーの持ち主にのみデータを送信するようになります。

などなど、色々と面白い機能が搭載、と完璧にいってほしいところなのですが。。。現時点ではところどころ残念なバグもあります（＾＾;

まず、上記のスクリプトですが、私が試した環境では３つ目のAPPLICATION指定がうまく動きませんでした。
恐らくFirefoxエクステンション側にバグがあるのか、はたまた指定の仕方が違うのか。。。
区分けがわかりにくくなる、という程度の問題ですが、もったいない感じです。

また、実はこのPEARクラス、ところどころ実装が荒っぽかったりするもので、ちょくちょくNoticeを吐くことがあります。。。
この時に、display_errorsがOnだと、そのエラーが出力されることが原因でheaederの受け渡しがうまく行えなくなり、正常に動作しない場合があります。
# 検証の際、最初はデータのやり取り方式を理解していなかったので、これに結構はまりました（＾＾;
そのため、E_Noticeを表示しない、display_errorsをOffにする、など、何かしらの気遣いは必要になるかもしれません。

ただ、そういった部分を総合的に考えても、このFirePHPは十分に便利なライブラリだと思います。

おまけ：Xdebug Helper

Xdebug HelperはFirefoxからXdebugの操作をするFirefoxエクステンションです。
これも以前、PHPプロ！ニュースでご紹介したことがあります。
Firebugでデバッグをするわけでもないし、XdebugのON/OFFをFirefoxから行えるというだけなんですが（笑
ついでなので、おまけ的に紹介します。

このエクステンションは、インストールするとFirefoxのステータスバーにアイコンが追加されます。
このアイコンをクリックすることでXdebugのデバッグセッションのON/OFFを切り替え、ONにしておくとXDEBUG_SESSION=(設定値)というクッキーを送信してくれるようになります。
大した機能ではないですが、手動でやるといちいち面倒なので、気軽にXdebugによるデバッグが実行できるようになるのはわりと助かりものです。

結局、まとめの割に文章量が多くてまとまっていないというオチに。。。orz
まぁ、なんにせよ（＾＾；
こういったライブラリが快適なデバッグ環境構築の一助になれば幸いです。