私が個人的に見つけたバッドノウハウばかりですので、これら以外にもっとスマートな方法がありましたら是非ご教示ください。

一般的な使い方

気をつけること

<div><img src="spacer画像のパス" width="X" height="Y" /></div>

<div style="height:Ypx"><img src="spacer画像のパス" width="X" height="Y" /></div>

デザインを統一するために

1. 3,4種類の行間スペースを決める
   私が良く使っているのは、2px, 3px, 5px, 10pxの4種類です
2. どの行間スペースをどんな時に使うのかを決める
   例)
   • 2px: デザイン上で必要な微妙なスペース
   • 3px; 文章と文章の間のスペース
   • 10px: フッター等で本当にいっぱい開けたい時
   • 5px: 上記以外で適当なスペースがほしい時
3. 自分を含めコーディングする人がピクセル単位で指定出来ないようにする
   人間は間違えるものです。自分で決めたルールでもあれ？どれだっけ？と忘れてしまうこともあります。厳密にはもちろん不可能ですが、たとえばHTMLヘルパー的なものでどの高さにするのかをピクセル単位ではなく種類を選ばせることによってミスは大分減り、より統一されたデザインのサイトに仕上がるかと思います。

height代わりに使う

<table width="100%" cellspacing="0" cellpadding="0" border="0">
  <tr>
    <td>
      何かの文章
    </td>
    <td width="1">
      <!-- 高さを100pxにしたい場合 -->
      <img src="spacer画像のパス" width="1" height="100" />
    </td>
  </tr>
</table>

何かの文章

ラインを表現するのに使う

<div style="background-color:red;height:1px">
  <img src="spacer画像のパス" width="1" height="1" />
</div>

何かと制限の多い携帯向けXHTMLですが、spacerのように頭をひねれば意外といろいろが解決可能だということに気づくかと思います。
全てがバッドノウハウですので、本当に役に立っているのか時たま分からなくなる時もありますが、みなさんもぜひspacerを愛でみてはいかがでしょうか？意外な使い方が見つかるかもしれません！

今日はテストや普段の開発に便利なツールのご紹介をしたいと思います。PHP限定のツールですので、ご了承下さい。

ZyngaJapanでは、昨日リニューアルオープンした「ファームビレッジ」でも、Jenkins(旧Hudson)によるCIを行って開発しており、TDDやJenkinsでのCIを利用する文化がだんだんと浸透してきています。Jenkinsのプラグインとして利用できるものも多くありますが、当然ながらコマンドラインからも利用出来ますので、コミット前に自分のコードをチェックすることもできます。

phpcpd

コードの中でコピー&ペーストで記述されている部分を検出してくれます。
どの程度の重複から検出するかを柔軟に設定できるので、まず大きな部分から修正するなど判断ができ便利です。

$ phpcpd /path/to/project
phpcpd @package_version@ by Sebastian Bergmann.

Found 13 exact clones with 339 duplicated lines in 17 files:

  - hoge/fuga/Foo.php:55-104
    hoge/fuga/Bar.php:85-134

0.50% duplicated lines out of 68425 total lines of code.

Time: 10 seconds, Memory: 33.00Mb

phpdcd

どこからもコールされていないメソッドなどを検出してくれます。リファクタリング対象として確認に役立ちます。

$ phpdcd /path/to/project
phpdcd 0.9.2 by Sebastian Bergmann.

  - Foo::execute()
    declared in Foo.php:42

  - Bar::getActionName()
    declared in Bar.php:27

  - Hoge::execute()
    declared in Hoge.php:34

phploc

以下のようにphpファイルの構成要素を算出してくれます。(数字は全てダミーです)

$ phploc /path/to/project
phploc @package_version@ by Sebastian Bergmann.

Directories:                                        999
Files:                                             9999

Lines of Code (LOC):                             999999
  Cyclomatic Complexity / Lines of Code:           0.01
Comment Lines of Code (CLOC):                     99999
Non-Comment Lines of Code (NCLOC):               999999

Namespaces:                                           9
Interfaces:                                          99
Classes:                                            999
  Abstract:                                          99 (9.99%)
  Concrete:                                         999 (99.99%)
  Average Class Length (NCLOC):                     999
Methods:                                           9999
  Scope:
    Non-Static:                                    9999 (99.99%)
    Static:                                           9 (9.99%)
  Visibility:
    Public:                                        9999 (99.99%)
    Non-Public:                                     999 (99.99%)
  Average Method Length (NCLOC):                     99
  Cyclomatic Complexity / Number of Methods:       9.99

Anonymous Functions:                                 99
Functions:                                            9

Constants:                                          999
  Global constants:                                   9
  Class constants:                                  999

phpmd

if文のネスト階層数などの複雑さ、短すぎる、または長すぎる変数名や、使われていない変数の検出など様々な条件に応じて検出を行ってくれます。

$ phpmd /path/to/project text codesize,unusedcode,naming

/path/to/project/hoge/huga/AAA.php:76   Avoid unused local variables such as '$foo'.
/path/to/project/hoge/huga/AAA.php:129  Avoid unused local variables such as '$bar'.
/path/to/project/hoge/huga/AAA.php:185  Avoid unused local variables such as '$foo'.
/path/to/project/hoge/huga/BBB.class.php:29    Too many fields
/path/to/project/hoge/huga/foo/CCC.php:20 Avoid variables with short names like $a
/path/to/project/hoge/huga/foo/CCC.php:20 Avoid variables with short names like $b
/path/to/project/hoge/huga/foo/EEE.php:5     The method create() has a Cyclomatic Complexity of 12.
/path/to/project/hoge/huga/foo/EEE.php:5     The method create() has an NPath complexity of 288.
/path/to/project/hoge/huga/foo/FFF.php:10     Avoid unused local variables such as '$type'.
/path/to/project/hoge/huga/foo/GGG.php:7    Avoid unused private fields such as '$object'.
/path/to/project/hoge/huga/bar/HHH.php:64  Avoid unused parameters such as '$status'.
/path/to/project/hoge/huga/bar/HHH.php:74  Avoid unused private methods such as 'setStatus'.
/path/to/project/hoge/huga/bar/JJJ.php:26    Avoid unused parameters such as '$status'.
/path/to/project/hoge/huga/bar/KKK.php:3    This class has too many methods, consider refactoring it.
/path/to/project/hoge/huga/bar/KKK.php:13   Avoid unused parameters such as '$status'.
/path/to/project/hoge/huga/bar/LLL.php:44    Avoid unused parameters such as '$status'.

上記はJenkinsのプラグインとして使えるものもありますので、是非検討してみてはいかがでしょうか。

■できること

■使用方法

 class hosts {
   file {
     "/etc/hosts":
       owner => 'root',
       group => 'root',
       mode  => 644,
   }
 }

■利用例

base(group)
   ├─ web(group)  
   │      ├──  httpd(class)
   │      └──  php(class)
   │
   ├── hosts(class)
   ├── ntp(class)
   └── ssh(class)

サンフランシスコで開かれたSymfony Liveで、Fabien Potencier氏によるHTTP Cacheという発表がありその中でESI(Edge Side Includes)の紹介がありました。

下の画像はちょっとみずらいですが、たとえばこのラボブログのレイアウトだと大枠の部分は常によりユーザに使いフロントの所（つまりCDNやキャッシュサーバ）側でキャッシュされていてAの部分とBの部分それぞれのコンテンツを別々にインクルードする形でキャッシュ制御することができます。

Symfony2のサイトsymfony-reloaded.orgでも、マニュアルがありますので、詳細はそちらを参考にしていただくとして、その中に、Varnishでもその機能が利用できることが紹介されていますので試してみたいと思います。

Varnishのインストールについては省略してとりあえず設定部分から。VarnishサイトにあるESIの説明あたりを参考にして下記のような環境を構築してみました。

Apache側(port: 10080でアクセス可能）

<html>
<head>
himote:
</head>
<body>
<esi:include src="/time.php" />
</body>
</html>

<?php
echo date('Y/m/d h:i:s');

varnish側(port: 6081でアクセス可能)

backend default {
  .host = "127.0.0.1";
  .port = "10080"; // Apache
}

sub vcl_fetch {
    if (req.url == "/himote.html") {
            esi; // enable ESI
    }
}

wget http://localhost:6081/himote.html -O -

<html>
<head>
himote:
</head>
<body>
2011/02/22 11:07:37
</body>
</html>

# 二回目
wget http://localhost:6081/himote.html -O -

<html>
<head>
himote:
</head>
<body>
2011/02/22 11:07:37
</body>
</html>

2回目も時間がかわってないことから、正常にキャッシュしているようです。
ただ、キャッシュの有効期限を設定していないので今度はExpireヘッダを出力してみます。

<?php
$expire = 10; //10秒後
header('Expires: '.gmdate('D, d M Y H:i:s \G\M\T', time() + $expire));
echo date('Y/m/d h:i:s');

wget http://localhost:6081/himote.html -O -

<html>
<head>
himote:
</head>
<body>
2011/02/22 11:13:47
</body>
</html>

wget http://localhost:6081/himote.html -O -
<html>
<head>
himote:
</head>
<body>
2011/02/22 11:13:57
</body>
</html>

何回かアクセスするとちょうど10秒目くらいに時間が変更されているので正常に動作しているようです。

本家のマニュアルを写経した程度になってしまいましたが、どのようなものかイメージをつかんでいただけたのではないでしょうか。実際にプロダクトレベルで利用するにはベンチマークやログなどの詳細な検証は必要になると思いますのでご注意ください。

本記事がご参考になれば幸いです。]]> tag:labs.unoh.net,2011://2.1933 2011-02-21T01:57:51Z 2011-02-21T11:03:22Z

$ rpm -ql facter | grep rb$ 
/usr/lib/ruby/site_ruby/1.8/facter.rb
(... snip ...)
$ grep -r Facter /usr/lib/ruby/site_ruby/1.8 | grep module
/usr/lib/ruby/site_ruby/1.8/facter.rb:module Facter

require 'facter' 
class BaseServer
  include Facter
  attr_accessor :name, :role, :ipaddress
  def initialize(*)
    @name = Facter.value(:fqdn)
    @role = self.class.name
    @ipaddress = Facter.value(:ipaddress)
  end
  def getKernel
    return Facter.value(:kernelrelease)
  end
  def getUptime
    return Facter.value(:uptime)
  end
end

require 'BaseServer'
class BaseServer::HttpdServer < BaseServer
  def getApacheStatus
    (... snip ...)
  end
end

require 'BaseServer'
require 'mysql'
class BaseServer::MysqldServer < BaseServer
  attr_accessor :host, :user, :pass, :database
  def initialize(host, user, pass, database)
    super
    @host = host
    @user = user
    @pass = pass
    @database = database
  end
  def countTable(table)
    my = Mysql::new(host, user, pass, database)
    res = my.query("select count(*) from #{table}")
    return res
  end
end

だいぶiPhoneやAndroidといったスマートフォン向けのwebページを作ることが増えてきたのではないでしょうか。ちょっとした気配りで使いやすくなるケースもあるかなと思うので、いくつか使えそうな工夫について書いてみたいと思います。

ただし、今回はiPhone向けです。

タップされた場所をハイライトする

iPhoneのSafariでは「-webkit-tap-highlight-color」という拡張された属性があり、タップされた箇所に色を付けることができます。CSS3ではRGBaによる色指定ができるので、半透明の色を指定すればタップされた箇所をわかりやすく示すことができます。例えば、

-webkit-tap-highlight-color:rgba(255,0,0,0.40);

数字を電話番号のリンクにしない

iPhoneのSafariはHTMLに含まれる数字を電話番号として検出、自動的に電話番号のリンクにしてしまいます。タップすると電話がかけられるので便利な場面もあるのですが、「123.45」のような小数点を含む数字や「100-0001」のような郵便番号、「2001-2011」のようなcopyrightの年号表記までリンクになってしまうのです。

この挙動を無効にするには

<meta name="format-detection" content="telephone=no">

文字のサイズをコントロールする

PC向けに作成されたサイトをiPhoneで見た場合、フォントの大きさがPCで表示した場合と違った比率で表示されることがあります。iPhoneのSafariは文字の大きさを自動で調整してくれるのですが、自分でコントロールしたい場合もあるのではないでしょうか。

自動調整を無効にしたい場合、CSSで

-webkit-text-size-adjust:none;

自動調整を無効にした場合でも、画面の向きが変わってローテートされた場合の表示の調整は行われます（iPhoneの場合）。

また、あえて自動調整にまかせるという選択肢もあると思うので、この属性を使用する場合はきちんとサイト全体の方針を決めてから使うのがいいのではないかと思います。

終わりに

iPhone向けの小さなtipsを3つ紹介しました。小さな画面で操作することが多い分、ちょっとした気配りで操作性が上がることも多いのではないでしょうか。少しでも気の届いたページを作っていけたらいいなと思います。

SafariのHTMLとCSSについてはAppleのリファレンスを見れば載っているので、参考にどうぞ。

• Safari HTML Reference: Introduction
• Safari CSS Reference: Introduction to Safari CSS Reference

Webエンジニアの方がルータを触る機会は、少ないと思います。
ということで、Yamahaルータを例にルータの設定方法を紹介します。

1. Yamahaルータへのログインについて

Yamahaルータへのログインは、通常以下の２つの方法いずれかでログインします。

- シリアルコンソールケーブルを使用したログイン

シリアルコンソールケーブルを直接Yamahaルータに接続します。
シリアルコンソールケーブルはクロスケーブルとDSUB9 or 25 と RJ45 変換コネクタでも自作できます。(ルータの購入時に付属している場合もあります。)

- telnetまたはsshを使用したログイン

これは、ご存知のようにtelnetコマンドやsshコマンドを使用したログインです。
いずれもログインした後の設定方法は同じです。
ログイン時パスワードを入れてログインしますが、設定を行うには
以下のコマンドを入力して管理者モードに移行してから行います。

 $ administrator

2. お勧めする初期設定

- コンソールの表示文字コードを設定する

 $ console character ascii

文字コードを設定します。euc, sjisなどにするとエラーなどが日本語になったりします。

- コンソールの表示行数のリミットを外す

 $ console columns infinity

show ** 等でページ送りをしないように設定します。
show configコマンドなどを一度に表示して保存する場合などに最適です。
ページ送りを行いたい場合は、show ** | less で行えます。

- プロンプトの設定

 # console prompt zynga

これは、プロンプトの先頭文字列を設定するコマンドです。(例： zynga$ )
bashなどの$PS1と同じようなものです。ただし、特殊変数などは使えません。

3. コマンド入力記法について

- showコマンドとクエスチョンマーク( ? )

自分の設定した内容を見るときは $ show configと入力します。また、設定内容と現在の動作状況を見るときは $show tech または $show techinfoと入力します。
その他、show コマンドを入力後 ? を入力することでヘルプが表示されます。

- noコマンド

 $ no console character ascii

今まで、入力したコマンドを無効にしたいときなどに使用します。
show configで表示されるコマンドの先頭に no をつけて実行することにより該当行のコマンドが無効化または、デフォルト状態に戻ります。

- 設定の一括投入

一度に行う設定が複数ある場合、設定の反映はコピペで一括で行うことができます
初期設定時やネットワークを遮断した際の設定は一括で行った方が効率がよいと思います。
今までの設定は以下で行えます。管理者モードで以下３行をコピペすることで反映されます。

console character ascii
console columns infinity
console prompt zynga

- 設定の保存

 # save

設定内容を不揮発性メモリに保存して、ルータの再起動後でも設定が残るようにしておきます。

最後に、オンラインでの設定変更は十分にマニュアルや設定例などを読んだ上行ってください。予期せぬ再起動。通信断を招く可能性があります。

私が所属しているチームではお菓子系男子が30%を超えているという素敵チームで 毎週チーム内の漢の子がお菓子を焼いてくるという状況でハッピハッピハッピーです。

今日は私が学んできたPHP Extension作成についてのノウハウの一部を 公開しようと思います。

PHPExtension作成についての資料はklabさんやyoyaさん rskyさんの記事が参考になりますが私のようにPHPは書けてもCが書けない人には具体的にhello world以降何をすればいいのかがサッパリよく分かりません。

そこで先人達が作ってくれた偉大なライブラリをPHPで扱えるようにする為にC/MigemoのPHPバインディングを作ってみましょう

読者の方の中にはC/Migemoをご存知でない方もいらっしゃるかと思いますので簡単に説明するとC/MigemoはKoRoNさんが作成されているローマ字のまま日本語を(インクリメンタルに)検索する」ための正規表現を生成するライブラリです。

http://www.kaoriya.net/#CMIGEMO

私は普段Ubuntuで開発をしているのでUbuntuでのC/Migemoの導入方法の説明を書きます。 OSXやWindowsの方はC/MigemoのREADMEを読みつつコンパイルしてください。

sudo aptitude install nkf

svn co http://cvs.kaoriya.net/svn/CMigemo/trunk migemo
cd migemo
./configure
make gcc

make gcc-dict
cd dict
make utf8
cd ..
sudo make gcc-install

これでC/Migemoのインストールが完了しました。C/Migemoには簡単な動作を確認する為の プログラムが付属しているのでそれを使って試してみましょう。

cmigemoを起動してchobiという文字列を入力してみます。

chobie@air:~/src/migemo$ cmigemo -d /usr/local/share/migemo/utf-8/migemo-dict
migemo_open("/usr/local/share/migemo/utf-8/migemo-dict")=0x820d008
clock()=0.210000
QUERY: chobi
PATTERN: (ﾁｮﾋﾞ|チョビ|ちょび|ｃｈｏｂｉ|chobi)

chobiに対応した正規表現が生成されましたね！

PHP Extensionの下準備

まずはPHP Extensionの設計を自分がよく理解できる言語でふわっと書いてみましょう。

<?php
/**
* これは実装するExtensionの目標で実際には使いません。
*/
class Migemo{
    public function __construct()
    {
      //migemoのロードを行う
    }

    public function query($query)
    {
      //migemoに問い合せて正規表現を返す
    }
}

せっかくなのでUnitTestも書いておきましょう。

PHPExtensionを作成する場合は別途テスト用のrun-test.phpというのが付属してるんですが、自分で使う分には慣れ親しんだツールを使ったほうが楽なので今回はPHPUnit3を使います。

sudo pear channel-discover pear.phpunit.de
sudo pear channel-discover components.ez.no
sudo pear channel-discover pear.symfony-project.com
sudo pear install phpunit/PHPUnit

テストを書きます。

<?php
class MigemoTest extends \PHPUnit_Framework_TestCase{


    /**
     * Migemoロードされているかしらべるよ
     */
    public function testMigemoIsLoaded()
    {
        $this->assertEquals(true,extension_loaded("migemo"));
    }

    /**
     * Migemoクラスがあるかしらべるよ
     * @depends testMigemoIsLoaded
     */
    public function testMigemoClassExists()
    {
        $this->assertEquals(true,class_exists("Migemo"));
    }

    /**
     * @depends testMigemoClassExists
     */
    public function testQueryMethodExists()
    {
        $reflection = new \ReflectionClass("Migemo");
        $this->assertEquals(true,$reflection->hasMethod("query"));
    }

    /**
     * @depends testQueryMethodExists
     */
    public function testQuery()
    {
        $migemo = new Migemo();
        $this->assertEquals("(ﾁｮﾋﾞ|チョビ|ちょび|ｃｈｏｂｉ|chobi)",$migemo->query("chobi"));
        unset($migemo);
    }

    /**
     * @depends testQuery
     */
    public function testQueryCycle()
    {
        $migemo = new Migemo();
        for($i = 0; $i < 30; $i++){
            $this->assertEquals("(ﾁｮﾋﾞ|チョビ|ちょび|ｃｈｏｂｉ|chobi)",$migemo->query("chobi"));
        }
        unset($migemo);

    }
}

さて、これでExtension作成までの準備が出来ましたのでサクサク書いていきます。

PHP Extensionを書く

私は容量悪い系の人間なのでコツコツ書いてきますよ！みなさんも写経についてきてくださいね

PHP_ARG_ENABLE(migemo,
  [  --enable-migemo      Enable "migemo" extension support])

if test $PHP_MIGEMO != "no"; then
  export CFLAGS="$CFLAGS -lmigemo"
  PHP_SUBST(MIGEMO_SHARED_LIBADD)
  PHP_NEW_EXTENSION(migemo, migemo.c, $ext_shared)
fi

phpizeというビルド環境をチェックしつつコンパイルに必要な設定を書いてくれるconfig.m4というマクロファイルを書きます。とりあえずこう書けばOK

本来はもうちょっとPHP Extensionらしい書き方が有るんですが長くなるので今回はこんな形でごまかしちゃいましょう。

続いてPHPにExtensionを登録するためのコードを書きます。

#ifndef PHP_MIGEMO_H
#define PHP_MIGEMO_H

#define PHP_MIGEMO_EXTNAME "migemo"
#define PHP_MIGEMO_EXTVER "0.1"


#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "php.h"
#include 

extern zend_module_entry migemo_module_entry;
#define phpext_migemo_ptr &migemo_module_entry;

PHPAPI zend_class_entry *migemo_class_entry;

#endif /* PHP_MIGEMO_H */

#include "php_migemo.h"

PHPAPI function_entry php_migemo_methods[] = {
    {NULL, NULL, NULL}
};

PHP_MINIT_FUNCTION(migemo) {
    return SUCCESS;
}

PHP_MINFO_FUNCTION(migemo)
{
    return SUCCESS;
}

zend_module_entry migemo_module_entry = {
#if ZEND_MODULE_API_NO >= 20010901
    STANDARD_MODULE_HEADER,
#endif
    PHP_MIGEMO_EXTNAME,
    NULL, 					/* Functions */
    PHP_MINIT(migemo),	    /* MINIT */
    NULL, 	                /* MSHUTDOWN */
    NULL, 	                /* RINIT */
    NULL,	                /* RSHUTDOWN */
    PHP_MINFO(migemo),	    /* MINFO */
#if ZEND_MODULE_API_NO >= 20010901
    PHP_MIGEMO_EXTVER,
#endif
    STANDARD_MODULE_PROPERTIES
};

#ifdef COMPILE_DL_MIGEMO
ZEND_GET_MODULE(migemo)
#endif

そいでは準備ができましたのでコンパイルしてみましょう。

phpize
./confiugre
make
sudo make install

# migemo本体の共有ライブラリいれてからldconfigしてなかったので初回だけ。
sudo ldconfig

php5のconfファイルにmigemo.soを追加します。

extension=migemo.so

これでPHPにMigemo Extensionを登録するだけのExtensionが作れました。

chobie@air:~/src/php-migemo$ php -m | grep migemo
migemo

確かにPHPExtensionがロードされているようですね。UnitTestも実行しておきましょう。

chobie@air:~/src/php-migemo$ phpunit MigemoTest.php 
PHPUnit 3.5.6 by Sebastian Bergmann.

.FSSS

Time: 0 seconds, Memory: 3.00Mb

There was 1 failure:

1) MigemoTest::testMigemoClassExists
Failed asserting that  matches expected .

/home/chobie/src/php-migemo/MigemoTest.php:19

FAILURES!
Tests: 2, Assertions: 2, Failures: 1, Skipped: 3.

きちんとモジュールが読み込まれるテストは成功していますね。

クラスだけを実装する

それではMigemoクラスをExtensionで実装してみましょう。まずは単純にクラスの定義だけを行ないます。PHPで言えばこんなコードになります。

<?php
class Migemo{}

新しいクラスを定義するにははPHP_MINIT_FUNCTION(migemo)に3行追加するだけで出来ます。

PHP_MINIT_FUNCTION(migemo) {
    zend_class_entry ce;
    INIT_CLASS_ENTRY(ce, "Migemo", php_migemo_methods);
    migemo_class_entry = zend_register_internal_class(&ce TSRMLS_CC);
    return SUCCESS;
}

コレだけです。zend_class_entry `migemo_class_entry`は前もってphp_migemo.h で宣言しておいたのでPHP_MINIT_FUNCTIONで使うことができます。

INIT_CLASS_ENTRYは一番目にzend_class_entry、2番目にクラス名、3番目にクラスに 対応したfunction_entryを渡せばOKです。

それでは再度コンパイルしてチェックしてみましょう。

sudo make install

chobie@air:~/src/php-migemo$ phpunit MigemoTest.php 
PHPUnit 3.5.6 by Sebastian Bergmann.

..FII

Time: 0 seconds, Memory: 3.00Mb

There was 1 failure:

1) MigemoTest::testQueryMethodExists
Failed asserting that  matches expected .

/home/chobie/src/php-migemo/MigemoTest.php:28

FAILURES!
Tests: 5, Assertions: 3, Failures: 1, Incomplete: 2.

2つテストが成功しました。クラスも定義できたのでどんどん進みましょう。

queryメソッドを実装してみる

ひとまずこれでMigemoクラスが扱えるようになったので地味な部分はとりあえずおいておいてqueryメソッドを実装してしまいましょう。

メソッドの追加は先程`INIT_CLASS_ENTRY`で指定した`php_migemo_methods`に どんなメソッドがあるかを追加しておけばOKです。

PHPAPI function_entry php_migemo_methods[] = {
    PHP_ME(migemo, query, arginfo_migemo_query, ZEND_ACC_PUBLIC)
    {NULL, NULL, NULL}
};

function_entry配列のお約束は最後は必ず{NULL,NULL,NULL}で締める、という事を守っておけばOK。PHP_MEなどのfunction_entry用マクロのあとは ,は必要ありません。大体一緒なので雰囲気で書いちゃいましょう。

これでMigemoクラスにはqueryというメソッドがあるよ！というのを定義出来ました。 肝心の実装はどう書くかというと。

ZEND_BEGIN_ARG_INFO_EX(arginfo_migemo_query, 0, 0, 1)
    ZEND_ARG_INFO(0, query)
ZEND_END_ARG_INFO()
PHP_METHOD(migemo, query)
{
    migemo *m;
    char *query;
    int ret = 0;
    int query_len = 0;
    unsigned char *result;
    if(zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC,
        "s", &query, &query_len) == FAILURE){
        return;
    }

    m =  migemo_open("/usr/local/share/migemo/utf-8/migemo-dict");
    result = migemo_query(m, query);

    RETVAL_STRING(result, 1);
    migemo_release(m, result);
    migemo_close(m);
}

こんな感じです。Zend Engine2周りの関数やマクロが入ってきて若干分かりづらいかもしれませんがこれはこういうもんだと思っておけば大丈夫です。

RETVAL_STRINGはZEND_APIで定義されているマクロの一つでメソッドや関数の返り値を 簡単に設定できるマクロです。RETVAL系のマクロを使うとCの型からPHPの型に簡単に 変換しつつ返り値の設定をしてくれるので便利ですね。

それではまたコンパイルして試してみましょう

sudo make install

chobie@air:~/src/php-migemo$ phpunit MigemoTest.php 
PHPUnit 3.5.6 by Sebastian Bergmann.

.....

Time: 7 seconds, Memory: 3.00Mb

OK (5 tests, 34 assertions)

おー、ちゃんと動いていますね！

しかし今のままだとqueryメソッドを呼ぶ際に毎回migemoの初期化と解放をしているのが気に入りません。

それではコンストラクタを実装してみましょう。

コンストラクタを実装

コンストラクタの実装と行きたいのですがよく考えてみると一つ困ったことがでてきました。 migemoポインタはどこに格納しておけばよいのでしょう？

クラスのインスタンス関連付けて何かしらの構造を持ち回したい場合は自前の 構造体を定義してクラス生成時のオブジェクトの生成をハンドリングする方法を使います。

オブジェクトの生成をハンドリングする為にはオブジェクトを作るための関数と、オブジェクトが作ったメモリを開放するための関数を定義してzend_class_entry->create_object にオブジェクトを作成する為の関数を設定してあげます。

typedef struct{
    zend_object zo;
    migemo *migemo;
} php_migemo;

構造体のキャストを行なっているので先頭はzend_objectでなければいけません。

続いてオブジェクトの生成と解放を行う関数を追加します。殆ど同じなのでこういうもんだと思ってコピペすればOKです。大事なところは緑でマーキングしておいたので自分で違うのを作る場合は参考にしてください。

static void php_migemo_free_storage(php_migemo *object TSRMLS_DC)
{
    zend_object_std_dtor(&object->zo TSRMLS_CC);
    
    if(!object->migemo){
      migemo_free(object->migemo);
    }
    object->migemo = NULL;
    efree(object);
}

zend_object_value php_migemo_new(zend_class_entry *ce TSRMLS_DC)
{
	zend_object_value retval;
	php_migemo *obj;
	zval *tmp;

	obj = ecalloc(1, sizeof(*obj));
	zend_object_std_init( &obj->zo, ce TSRMLS_CC );
	zend_hash_copy(obj->zo.properties, &ce->default_properties, (copy_ctor_func_t) zval_add_ref, (void *) &tmp, sizeof(zval *));

	retval.handle = zend_objects_store_put(obj, 
        (zend_objects_store_dtor_t)zend_objects_destroy_object,
        (zend_objects_free_object_storage_t)php_migemo_free_storage,
        NULL TSRMLS_CC);
	retval.handlers = zend_get_std_object_handlers();
	return retval;
}

コンストラクタを追加します。

PHP_METHOD(migemo, __construct){
    php_migemo *this = (php_migemo *) zend_object_store_get_object(getThis() TSRMLS_CC);

    this->migemo = migemo_open("/usr/local/share/migemo/utf-8/migemo-dict");
}

コンストラクタを追加したのでメソッド定義とクラスの初期化部分に少し手を入れます。

PHPAPI function_entry php_migemo_methods[] = {
    PHP_ME(migemo, __construct, NULL, ZEND_ACC_PUBLIC)
    PHP_ME(migemo, query, arginfo_migemo_query, ZEND_ACC_PUBLIC)
    {NULL, NULL, NULL}
};

PHP_MINIT_FUNCTION(migemo) {
    zend_class_entry ce;
    INIT_CLASS_ENTRY(ce, "Migemo", php_migemo_methods);
    migemo_class_entry = zend_register_internal_class(&ce TSRMLS_CC);
migemo_class_entry->create_object = php_migemo_new;

    return SUCCESS;
}

コンストラクタ側でmigemoの生成行うようにしたので、それに合わせて queryの実装を変更します。

PHP_METHOD(migemo, query)
{
    php_migemo *this = (php_migemo *) zend_object_store_get_object(getThis() TSRMLS_CC);
    char *query;
    int ret = 0;
    int query_len = 0;
    unsigned char *result;
    if(zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC,
        "s", &query, &query_len) == FAILURE){
        return;
    }

    result = migemo_query(this->migemo, query);

    RETVAL_STRING(result, 1);
    migemo_release(this->migemo, result);
}

これで実装が完了しましたね。もう一回コンパイルして試してみましょう。

chobie@air:~/src/php-migemo$ phpunit MigemoTest.php 
PHPUnit 3.5.6 by Sebastian Bergmann.

.....

Time: 0 seconds, Memory: 3.00Mb

OK (5 tests, 34 assertions)

ユニットテストの時間が短縮されていて効果が出ていますね。これで実装が終了しました！

あとがき

どうでしたか？思っていたより簡単に開発できたのではないでしょうか？

PHPバインディングから始めるExtension作成は割と身近で親しみやすく、 次に自分が何を調べるべきかという目標が明確に分かるのでとっかかりには オススメだと思います。

最後に参考になるリンクと宣伝を貼っておきます。

今回作成したExtensionのGitリポジトリです。

php-gitはlibgit2をPHPで扱えるようにする為のPHPバインディングです。最近作り始めたばかりなので まだまだalpha developmentで課題はたくさん有りますがPHPでgit repositoryを使った操作が行えます。

2011年2月か3月に東京でZendEngineについての勉強会を行ないます。私もLT予定ですので ご興味のある方はぜひぜひどうぞ！

それでは、みんなも作ってア・ラ・モード☆

弊社には(身内自慢になるかもしれませんが)手練のエンジニアが老若男女問わず揃っており、ギークでもスーパープログラマでもない私にとっては

でいられる、成長するためには理想的な環境です。

とは言え、そういう状況で安穏としているわけにもいかないので、少しでも早く周囲にキャッチアップできるよう努めました。

それらについて、これから述べます。

■周りの人の助力を仰ぐ

• symfony→使ったこと無し
• TDD(テスト駆動開発)→未経験
• memcached→使ったこと無し
• Git→使ったこと無し

■ペアプログラミングの提案

■意見することを恐れない

• 皆にとって良い意見であれば採り入れてもらえます
• 自分の考え方と異なる意見を聞く機会ができます
• 自分の発言がキッカケで新たな建設的な議論が始まる可能性もあります

■指摘を受けたら素直に受け入れる

■自動化できるところは自動化する

autocmd BufWritePost *.php :call PHPLint()

function PHPLint()  let result = system( &ft . ' -l ' . bufname(""))

  let headPart = strpart(result, 0, 16) 

  if headPart != "No syntax errors"

    echo result

  endif

endfunction

■できないことはできないと言う

みなさんモジュール開発ではどのようにデバッギングしていますか？モジュールになると普段使い慣れたデバッグツールが使えず、手動の動作確認だけで済まされている方もいらっしゃるのではないでしょうか。

今回はC/C++開発ではメジャーなメモリデバッガ『Valgrind』をPHP拡張モジュールの開発で活用することで、普段使い慣れたツールでのデバッグの例をご紹介します。

1.PHP拡張モジュールの作成

まず開発用にPHPをデバッグモードでビルド。

#cd ./php-5.x.x
#./configure --enable-debug
#make
#make install

PHP拡張モジュールを作成

#cd ./ext
#./ext_skel --extname=zynga_func
#cd zynga_func

16行目から18行目のコメントアウトを外す

#emacs config.m
- dnl PHP_ARG_ENABLE(zynga_func, whether to enable zynga_func support,
- dnl Make sure that the comment is aligned:
- dnl [  --enable-zynga_func           Enable zynga_func support])
+ PHP_ARG_ENABLE(zynga_func, whether to enable zynga_func support,
+ Make sure that the comment is aligned:
+ [  --enable-zynga_func           Enable zynga_func support])

拡張モジュールのビルド

#phpize
#./configure
#make
#make install

php.iniに以下を追加

extension=zynga_func.so

同一ディレクトリ内に生成されているテスト用PHPコードを実行

#php zynga_func.php

以下のように出力されたらモジュールの正常な読み込みに成功。

Functions available in the test extension:
confirm_zynga_func_compiled

Congratulations! You have successfully modified ext/zynga_func/config.m4.
Module zynga_func is now compiled into PHP.

これで正常にPHP拡張モジュールの生成と読み込みが確認できたので、Valgrindでデバッギングしてみましょう。

2.Valgrindによるデバッグ

Valgrindにはいくつかのツールが付属したツール群になっていますが、まず最も使用するであろうMemcheckによるメモリーリーク、初期化・開放などのメモリ周りのデバッグログを出力してみましょう。

#valgrind php zynga_func.php
==2107==
==2107== HEAP SUMMARY:
==2107==     in use at exit: 104,669 bytes in 9 blocks
==2107==   total heap usage: 10,973 allocs, 10,964 frees, 2,127,924 bytes  allocated
==2107==
==2107== LEAK SUMMARY:
==2107==    definitely lost: 0 bytes in 0 blocks
==2107==    indirectly lost: 0 bytes in 0 blocks
==2107==      possibly lost: 0 bytes in 0 blocks
==2107==    still reachable: 104,669 bytes in 9 blocks
==2107==         suppressed: 0 bytes in 0 blocks
==2107== Rerun with --leak-check=full to see details of leaked memory
==2107== 
==2107== For counts of detected and suppressed errors, rerun with: -v
==2107== ERROR SUMMARY: 0 errors from 0 contexts (suppressed: 0 from 0)

※ログの見方

• HEAP SUMMARY: どれだけのヒープ領域を使用し、解放したかの数値。
• LEAK SUMMARY: メモリーリークが起きているbyte数とblock数。
• ERROR SUMMARY: エラー数

ログから、メモリーリークは一切起きておらず、ヒープ領域も僅かに開放されていない箇所もあるが、正常に動作していると言えます。

次にわざとメモリーリークを起こすコードを関数内に埋め込んでみます。zynga_func.c内の、PHP_FUNCTION(confirm_zynga_func_compiled)関数が、先ほどzynga_func.phpで実行された関数になるので、その中の処理を書き換えます。

mallocで確保しているにも関わらずfreeで開放していないため、メモリーリークが起きるコード。

#emacs zynga_func.c
void f(void)
{
    int* x = malloc(10 * sizeof(int));
    x[10] = 0;        // problem 1: heap block overrun
}                    // problem 2: memory leak -- x not freed
PHP_FUNCTION(confirm_zynga_func_compiled)
{
    f();
    ....

ビルドして反映。

#make
#make install

valgrindで確認。

#valgrind php zynga_func.php
==4934== Invalid write of size 4
==4934==    at 0x101231C14: f (in /usr/local/lib/php/extensions/debug-non-zts-20060613/zynga_func.so)
==4934==    by 0x101231C3B: zif_confirm_zynga_func_compiled (in /usr/local/lib/php/extensions/debug-non-zts-20060613/zynga_func.so)
==4934==    by 0x100308AF3: zend_do_fcall_common_helper_SPEC (in /usr/local/bin/php)
==4934==    by 0x100309A06: ZEND_DO_FCALL_BY_NAME_SPEC_HANDLER (in /usr/local/bin/php)
==4934==    by 0x1003084FB: execute (in /usr/local/bin/php)
==4934==    by 0x1002DD728: zend_execute_scripts (in /usr/local/bin/php)
==4934==    by 0x100279F64: php_execute_script (in /usr/local/bin/php)
==4934==    by 0x10036A507: main (in /usr/local/bin/php)
==4934==  Address 0x1010b1298 is 0 bytes after a block of size 40 alloc'd
==4934==    at 0x10062D79F: malloc (vg_replace_malloc.c:236)
==4934==    by 0x101231C07: f (in /usr/local/lib/php/extensions/debug-non-zts-20060613/zynga_func.so)
==4934==    by 0x101231C3B: zif_confirm_zynga_func_compiled (in /usr/local/lib/php/extensions/debug-non-zts-20060613/zynga_func.so)
==4934==    by 0x100308AF3: zend_do_fcall_common_helper_SPEC (in /usr/local/bin/php)
==4934==    by 0x100309A06: ZEND_DO_FCALL_BY_NAME_SPEC_HANDLER (in /usr/local/bin/php)
==4934==    by 0x1003084FB: execute (in /usr/local/bin/php)
==4934==    by 0x1002DD728: zend_execute_scripts (in /usr/local/bin/php)
==4934==    by 0x100279F64: php_execute_script (in /usr/local/bin/php)
==4934==    by 0x10036A507: main (in /usr/local/bin/php)
==4934==    Congratulations! You have successfully modified ext/zynga_func/config.m4. Module zynga_func is now compiled into PHP.
==4934== 
==4934== HEAP SUMMARY:
==4934==     in use at exit: 104,709 bytes in 10 blocks
==4934==   total heap usage: 10,974 allocs, 10,964 frees, 2,127,964 bytes allocated
==4934== 
==4934== LEAK SUMMARY:
==4934==    definitely lost: 40 bytes in 1 blocks
==4934==    indirectly lost: 0 bytes in 0 blocks
==4934==      possibly lost: 0 bytes in 0 blocks
==4934==    still reachable: 104,669 bytes in 9 blocks
==4934==         suppressed: 0 bytes in 0 blocks
==4934== Rerun with --leak-check=full to see details of leaked memory

今度はリークしている箇所と、byte数・block数がログに出力されるのを確認できました。

Valgrindはメモリーリークの検出以外に、初期化されていないメモリ領域の使用、freeされたメモリ領域の使用、ヒーププロファイラ、キャッシュプロファイラなど多用の機能を備えています。

普段使い慣れたツールで、開発に負荷のかからないデバッグを行っていきましょう。