jQueryとPHPでLinuxのtailコマンドを実装する

EC studio EC studio 技術ブログ

EC studio
EC studio 技術ブログ
EC studio 技術ブログの記事一覧

2009年10月06日投稿者：山本正喜

jQueryとPHPでLinuxのtailコマンドを実装する

Linuxにはtailというファイルの末尾10行程度を表示する、
ログファイルのチェックなどに便利なコマンドがあります。

オプションで一定間隔で常に末尾10行の表示を
更新し続けることもでき、ログの監視などに使えます。

Linux tailコマンド

ただ、とっても便利でサーバー管理者御用達のこのコマンド、
当然ながらシェルでログインできなくては使えません。。

レンタルサーバーなどでシェル権限がない場合も多いですし、
何よりもっとカンタンにブラウザから見たい！と思いませんか？

業務上の都合もありとっても欲しくなってので、作っちゃいました。

jQueryとPHPを使えば、思った以上にサクッと作れてしまったので、
技術ブログでソースコードや解説も含めて公開します。
(jQuery、メチャクチャ便利！です)

jQuery + PHPでtailを作る！

まずは今回の完成品です。

phptail

シンプルですね。
「TAIL」ボタンを押すとtail実行、
「STOP」ボタンを押すと更新が止まります。

実際に実行するとこうなります。
※サンプルとしてこのプログラム自体をtailしました

phptail 実行

Ajaxで実装されており、2秒ごとに表示が更新されます。

では、ソースコードです。

テキスト表示

PHP:

<?php
header('Content-type:text/html; charset=UTF-8');
//対象のファイルパス
$logpath = 'logfile.log';
//表示する末尾の行数
$lines = 30;
//更新インターバル (ミリ秒)
$interval = 2000;
if (isset($_GET['load'])){
echo 'file:'.basename($logpath).' reload:'.date('H:i:s').'<hr size="1"/>';
if (!file_exists($logpath)){
die($logpath.'は存在しません');
}
foreach (read_tail($logpath,$lines) as $i => $line){
$line = rtrim($line,"\r\n");
echo strtr(htmlspecialchars($line,ENT_QUOTES),array("\t" => '    '));
if ($i <($lines - 1)){
echo '<br />';
}
}
exit;
}
/**
* ログをファイルから指定行数読み出す
*
* tail function by flash tekkie
* http://tekkie.flashbit.net/php/tail-functionality-in-php
*
* @param string $file ファイルパス
* @param int $lines 行数
* @return array 行ごとの配列
*/
function read_tail($file, $lines) {
//global $fsize;
$handle = fopen($file, "r");
$linecounter = $lines;
$pos = -2;
$beginning = false;
$text = array();
while ($linecounter> 0) {
$t = " ";
while ($t != "\n") {
if(fseek($handle, $pos, SEEK_END) == -1) {
$beginning = true;
break;
}
$t = fgetc($handle);
$pos --;
}
$linecounter --;
if ($beginning) {
rewind($handle);
}
$text[$lines-$linecounter-1] = fgets($handle);
if ($beginning) break;
}
fclose ($handle);
return array_reverse($text);
}
?>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="ja" lang="ja">
<head>
<meta name="robots" content="noindex,nofollow" />
<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.3.2/jquery.js"></script>
<script type="text/javascript">
var timer = null;
function start_tail(){
if (timer){
clearInterval(timer);
}
$('#status').html('running...');
timer = setInterval(run,<?php echo $interval ?>);
}
function run(){
$('#console').load('?load=1&m=' + new Date().getTime());
}
function stop(){
clearInterval(timer);
$('#status').empty();
}
</script>
<style type="text/css">
#console {
width:800px;
height:500px;
overflow:scroll;
border:1px solid #999999;
font-size:12px;
font-family:consolas;
}
</style>
</head>
<body>
<input type="button" onclick="start_tail()" value="TAIL"> <input type="button" onclick="stop()" value="STOP"> <span id="status"></span><br />
<pre id="console"></pre>
</body>
</html>

これだけ！です。
外部ファイルも不要なので、このコードを
phptail.phpなどで保存して、実行すればokです。(文字コードはUTF-8で)

たった100行ぐらいでAjaxを使ったtailを実装できちゃうところが、
jQueryとPHPの素晴らしいところですね。

では、ソースコードの解説をしてみます。

PHPの処理を作る

今回のキモはなんといってもtail部分。
ファイルを末尾から読み出すのは結構難しいです。

こういった処理を自分で作ってもいいですが、
海外サイトに良さそうなコードがあったのでお借りしましょう。

「php tail」でGoogle検索すればすぐ見つかりました。
flash tekkie » Blog Archive » tail functionality in PHP

今回はここのread_file関数を使うことにします。
read_fileだと少々わかりにくいのでread_tailに変更しました。

テキスト表示

PHP:

function read_tail($file, $lines) {
//global $fsize;
$handle = fopen($file, "r");
$linecounter = $lines;
$pos = -2;
$beginning = false;
$text = array();
while ($linecounter> 0) {
$t = " ";
while ($t != "\n") {
if(fseek($handle, $pos, SEEK_END) == -1) {
$beginning = true;
break;
}
$t = fgetc($handle);
$pos --;
}
$linecounter --;
if ($beginning) {
rewind($handle);
}
$text[$lines-$linecounter-1] = fgets($handle);
if ($beginning) break;
}
fclose ($handle);
return array_reverse($text);
}

この関数に読み出したいファイルパスを渡して、
それを一定秒数ごとに表示してやればokですね。

Ajaxで定期的に読み込む

Ajaxというと難しいイメージがありますが、
jQueryを使えばほんとにカンタンに実装できてしまいます。

今回は
「TAIL」ボタンにstart_tail()を、
「STOP」ボタンにstop()を、
onclick属性でそれぞれ割り当てました。

JavaScriptの関数コードは

テキスト表示

JAVASCRIPT:

<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.3.2/jquery.js"></script>
<script type="text/javascript">
var timer = null;
function start_tail(){
if (timer){
clearInterval(timer);
}
$('#status').html('running...');
timer = setInterval(run,<?php echo $interval ?>);
}
function run(){
$('#console').load('?load=1&m=' + new Date().getTime());
}
function stop(){
clearInterval(timer);
$('#status').empty();
}
</script>