2011年3月15日

symfony ＋ PHPスクリプト暗号化（ionCube）

こんにちは井川です。今回は、symfonyに組み込んだPHPスクリプトを暗号化した際に。アプリケーションを正常に動作させる簡単な方法をご紹介します。この方法を使うことで、実際にionCubeでPHPスクリプトを暗号化しても正常に動作します（その他のエンコーダでも同様だと思います）。

symfonyは、libディレクトリ、apps/アプリ/libディレクトリ、apps/アプリ/module/*/lib以下のPHPファイルとクラスの対応関係を自動的に生成し、cacheディレクトリ以下にキャッシュファイルとして保存します（cache/アプリ/環境/config_autoload.yml.php）。そして次回からは、そのキャッシュファイルを用いてautoloadを実行します。このキャッシュファイル生成方法はいたって簡単です。上記libディレクトリ内の全PHPスクリプト（lib/vendor/symfonyなどは除く）を文字列として読み込み、その文字列からクラス名を抽出します。デフォルトでは、sfAutoloadConfigHandlerクラスがこの役割を担っており、parse()メソッド内部で上記の処理を行います。

PHPスクリプトの暗号化を使うと、キャッシュファイル生成時に各PHPファイルを文字列として読み込んでも、クラス名を抽出できません。このため、symfony実行時にエラーが発生します。

そこで今回はアプリケーションが正常に動作するように、上記キャッシュファイルを生成するクラスを新たに作ります。そして、symfonyで使われるように設定します。方法はとても簡単です。

まず、PHPファイルへのクラス定義時に以下の２つの制約を設けます。

①１ファイルに１クラス
② PHPファイル名は「クラス名.class.php」

そして、新しいクラスでは、ファイル名からそのファイル内に記述されているクラス名を取得し、クラス名とPHPファイルの絶対パスの関係を取り出します（config_autoload.yml.phpに記述）。

実際に、デフォルトでクラス名とファイルパスの関係を抽出しているのは、sfAutoloadConfigHandlerクラスの113～115行目です。


<?php
  ...
  foreach ($finder->in($matches) as $file)
  {
    $mapping = array_merge($mapping, $this->parseFile($path, $file, isset($entry['prefix']) ? $entry['prefix'] : ''));
  }
  ...

そこで、sfAutoloadConfigHandlerクラスを継承したTestAutoloadConfigHandlerクラスを次のように実装します。


<?php
class TestAutoloadConfigHandler extends  sfAutoloadConfigHandler
{
  protected function parse(array $configFiles)
  {
    ...
      foreach ($finder->in($matches) as $file)
      {
        $file_name = basename($file);
        
        if (preg_match('/^(.+)\.class\.php$/i', $file_name, $m))
        {
          $mapping[strtolower($m[1])] = $file;
        }
      }
    ...
  }
}

このクラスを使用するために、configディレクトリにconfig_handlers.ymlを設置します。内容は以下の通りです。


config/autoload.yml:
  class:    TestAutoloadConfigHandler

さらに、config/ProjectConfiguration.class.phpの先頭部分で、先のハンドラクラスを読み込みます。


<?php
require_once dirname(__FILE__).'/../lib/vendor/symfony/lib/autoload/sfCoreAutoload.class.php';
sfCoreAutoload::register();
require_once dirname(__FILE__) . '/../lib/config/TestAutoloadConfigHandler.class.php';
....