Source for file Controller.php

Documentation is available at Controller.php

  1. <?php
  2. // vim: foldmethod=marker
  3. /**
  4.  *  Controller.php
  5.  *
  6.  *  @author     Masaki Fujimoto <fujimoto@php.net>
  7.  *  @license    http://www.opensource.org/licenses/bsd-license.php The BSD License
  8.  *  @package    Ethna
  9.  *  @version    $Id: ed3adc07c3452a1f5c89f098bde0f73f0e6125cd $
  10.  */
  11.  
  12. // {{{ Ethna_Controller
  13. /**
  14.  *  コントローラクラス
  15.  *
  16.  *  @todo       gatewayでswitchしてるところがダサダサ
  17.  *
  18.  *  @author     Masaki Fujimoto <fujimoto@php.net>
  19.  *  @access     public
  20.  *  @package    Ethna
  21.  */
  22. class Ethna_Controller
  23. {
  24.     /**#@+
  25.      *  @access protected
  26.      */
  27.  
  28.     /** @var    string      アプリケーションID */
  29.     protected $appid = 'ETHNA';
  30.  
  31.     /** @var    string      アプリケーションベースディレクトリ */
  32.     protected $base = '';
  33.  
  34.     /** @protected    string      アプリケーションベースURL */
  35.     protected $url = '';
  36.  
  37.     /** @protected    string      アプリケーションDSN(Data Source Name) */
  38.     protected $dsn;
  39.  
  40.     /** @protected    array       アプリケーションディレクトリ */
  41.     protected $directory = array();
  42.  
  43.     /** @protected    array       アプリケーションディレクトリ(デフォルト) */
  44.     protected $directory_default = array(
  45.         'action'        => 'app/action',
  46.         'action_cli'    => 'app/action_cli',
  47.         'action_xmlrpc' => 'app/action_xmlrpc',
  48.         'app'           => 'app',
  49.         'plugin'        => 'app/plugin',
  50.         'bin'           => 'bin',
  51.         'etc'           => 'etc',
  52.         'filter'        => 'app/filter',
  53.         'locale'        => 'locale',
  54.         'log'           => 'log',
  55.         'plugins'       => array(),
  56.         'template'      => 'template',
  57.         'template_c'    => 'tmp',
  58.         'tmp'           => 'tmp',
  59.         'view'          => 'app/view',
  60.         'www'           => 'www',
  61.         'test'          => 'app/test',
  62.     );
  63.  
  64.     /** @protected    array       DBアクセス定義 */
  65.     protected $db = array(
  66.         ''              => DB_TYPE_RW,
  67.     );
  68.  
  69.     /** @protected    array       拡張子設定 */
  70.     protected $ext = array(
  71.         'php'           => 'php',
  72.         'tpl'           => 'tpl',
  73.     );
  74.  
  75.     /** @protected    array       クラス設定 */
  76.     public $class = array();
  77.  
  78.     /** @protected    array       クラス設定(デフォルト) */
  79.     public $class_default = array(
  80.         'class'         => 'Ethna_ClassFactory',
  81.         'backend'       => 'Ethna_Backend',
  82.         'config'        => 'Ethna_Config',
  83.         'db'            => 'Ethna_DB',
  84.         'error'         => 'Ethna_ActionError',
  85.         'form'          => 'Ethna_ActionForm',
  86.         'i18n'          => 'Ethna_I18N',
  87.         'logger'        => 'Ethna_Logger',
  88.         'plugin'        => 'Ethna_Plugin',
  89.         'renderer'      => 'Ethna_Renderer_Smarty',
  90.         'session'       => 'Ethna_Session',
  91.         'sql'           => 'Ethna_AppSQL',
  92.         'view'          => 'Ethna_ViewClass',
  93.         'url_handler'   => 'Ethna_UrlHandler',
  94.     );
  95.  
  96.     /** @protected    array       フィルタ設定 */
  97.     protected $filter = array(
  98.     );
  99.  
  100.     /** @protected    string      使用ロケール設定 */
  101.     protected $locale;
  102.  
  103.     /** @protected    string      システム側エンコーディング */
  104.     protected $system_encoding;
  105.  
  106.     /** @protected    string      クライアント側エンコーディング */
  107.     /**                     ブラウザからのエンコーディングを指す  */
  108.     protected $client_encoding;
  109.  
  110.     /** @protected    string  現在実行中のアクション名 */
  111.     protected $action_name;
  112.  
  113.     /** @protected    string  現在実行中のXMLRPCメソッド名 */
  114.     protected $xmlrpc_method_name;
  115.  
  116.     /** @protected    array   forward定義 */
  117.     protected $forward = array();
  118.  
  119.     /** @protected    array   デフォルトのforward定義 */
  120.     protected $forward_default = array(
  121.         '403' => array( 'view_name' => 'Ethna_View_403',),
  122.         '404' => array( 'view_name' => 'Ethna_View_404',),
  123.         '500' => array( 'view_name' => 'Ethna_View_500',),
  124.         'json' => array( 'view_name' => 'Ethna_View_Json',),
  125.         'redirect' => array( 'view_name' => 'Ethna_View_Redirect',),
  126.     );
  127.  
  128.     /** @protected    array   action定義 */
  129.     protected $action = array();
  130.  
  131.     /** @protected    array   action(CLI)定義 */
  132.     protected $action_cli = array();
  133.  
  134.     /** @protected    array   action(XMLRPC)定義 */
  135.     protected $action_xmlrpc = array();
  136.  
  137.     /** @protected    array   アプリケーションマネージャ定義 */
  138.     protected $manager = array();
  139.  
  140.     /** @protected    object  レンダラー */
  141.     protected $renderer = null;
  142.  
  143.     /** @protected    array   フィルターチェイン(Ethna_Filterオブジェクトの配列) */
  144.     protected $filter_chain = array();
  145.  
  146.     /** @protected    object  Ethna_ClassFactory  クラスファクトリオブジェクト */
  147.     protected $class_factory = null;
  148.  
  149.     /** @protected    object  Ethna_ActionForm    フォームオブジェクト */
  150.     protected $action_form = null;
  151.  
  152.     /** @protected    object  Ethna_View          ビューオブジェクト */
  153.     protected $view = null;
  154.  
  155.     /** @protected    object  Ethna_Config        設定オブジェクト */
  156.     protected $config = null;
  157.  
  158.     /** @protected    object  Ethna_Logger        ログオブジェクト */
  159.     protected $logger = null;
  160.  
  161.     /** @protected    object  Ethna_Plugin        プラグインオブジェクト */
  162.     protected $plugin = null;
  163.  
  164.     /** @protected    string  リクエストのゲートウェイ(www/cli/rest/xmlrpc/soap...) */
  165.     protected $gateway = GATEWAY_WWW;
  166.  
  167.     /**#@-*/
  168.  
  169.  
  170.     /**
  171.      *  Ethna_Controllerクラスのコンストラクタ
  172.      *
  173.      *  @access     public
  174.      */
  175.     public function __construct($gateway = GATEWAY_WWW)
  176.     {
  177.         $GLOBALS['_Ethna_controller'] = $this;
  178.         if ($this->base === "") {
  179.             // EthnaコマンドなどでBASEが定義されていない場合がある
  180.             if (defined('BASE')) {
  181.                 $this->base = BASE;
  182.             }
  183.         }
  184.  
  185.         $this->gateway = $gateway;
  186.  
  187.         // クラス設定の未定義値を補完
  188.         foreach ($this->class_default as $key => $val) {
  189.             if (isset($this->class[$key]) == false) {
  190.                 $this->class[$key] = $val;
  191.             }
  192.         }
  193.  
  194.         // ディレクトリ設定の未定義値を補完
  195.         foreach ($this->directory_default as $key => $val) {
  196.             if (isset($this->directory[$key]) == false) {
  197.                 $this->directory[$key] = $val;
  198.             }
  199.         }
  200.  
  201.         // クラスファクトリオブジェクトの生成
  202.         $class_factory = $this->class['class'];
  203.         $this->class_factory = new $class_factory($this, $this->class);
  204.  
  205.         // エラーハンドラの設定
  206.         Ethna::setErrorCallback(array($this, 'handleError'));
  207.  
  208.         // ディレクトリ名の設定(相対パス->絶対パス)
  209.         foreach ($this->directory as $key => $value) {
  210.             if ($key == 'plugins') {
  211.                 // Smartyプラグインディレクトリは配列で指定する
  212.                 $tmp = array();
  213.                 foreach (to_array($value) as $elt) {
  214.                     if (Ethna_Util::isAbsolute($elt) == false) {
  215.                         $tmp[] = $this->base . (empty($this->base) ? '' : '/') . $elt;
  216.                     }
  217.                 }
  218.                 $this->directory[$key] = $tmp;
  219.             } else {
  220.                 if (Ethna_Util::isAbsolute($value) == false) {
  221.                     $this->directory[$key] = $this->base . (empty($this->base) ? '' : '/') . $value;
  222.                 }
  223.             }
  224.         }
  225.  
  226.         // 遷移先設定をマージ
  227.         // 但し、キーは完全に維持する
  228.         $this->forward = $this->forward + $this->forward_default;
  229.  
  230.         // 初期設定
  231.         // フレームワークとしての内部エンコーディングはクライアント
  232.         // エンコーディング（=ブラウザからのエンコーディング)
  233.         //
  234.         // @see Ethna_Controller#_getDefaultLanguage
  235.         list($this->locale, $this->system_encoding, $this->client_encoding) = $this->_getDefaultLanguage();
  236.         if (mb_enabled()) {
  237.             mb_internal_encoding($this->client_encoding);
  238.             mb_regex_encoding($this->client_encoding);
  239.         }
  240.         $this->config = $this->getConfig();
  241.         $this->dsn = $this->_prepareDSN();
  242.         $this->url = $this->config->get('url');
  243.         if (empty($this->url) && PHP_SAPI != 'cli') {
  244.             $this->url = Ethna_Util::getUrlFromRequestUri();
  245.             $this->config->set('url', $this->url);
  246.         }
  247.  
  248.         // プラグインオブジェクトの用意
  249.         $this->plugin = $this->getPlugin();
  250.  
  251.         // include Ethna_Plugin_Abstract for all plugins
  252.         $this->plugin->includePlugin('Abstract');
  253.  
  254.         //// assert (experimental)
  255.         //if ($this->config->get('debug') === false) {
  256.         //    ini_set('assert.active', 0);
  257.         //}
  258.  
  259.         // ログ出力開始
  260.         $this->logger = $this->getLogger();
  261.         $this->plugin->setLogger($this->logger);
  262.         $this->logger->begin();
  263.  
  264.         // Ethnaマネージャ設定
  265.         $this->_activateEthnaManager();
  266.     }
  267.  
  268.     /**
  269.      *  アプリケーション実行後の後始末を行います。
  270.      *
  271.      *  @access protected
  272.      */
  273.     protected function end()
  274.     {
  275.         //  必要に応じてオーバライドして下さい。
  276.         $this->logger->end();
  277.     }
  278.  
  279.     /**
  280.      *  (現在アクティブな)コントローラのインスタンスを返す
  281.      *
  282.      *  @access public
  283.      *  @return object  Ethna_Controller    コントローラのインスタンス
  284.      *  @static
  285.      */
  286.     public static function getInstance()
  287.     {
  288.         if (isset($GLOBALS['_Ethna_controller'])) {
  289.             return $GLOBALS['_Ethna_controller'];
  290.         } else {
  291.             $_ret_object = null;
  292.             return $_ret_object;
  293.         }
  294.     }
  295.  
  296.     /**
  297.      *  アプリケーションIDを返す
  298.      *
  299.      *  @access public
  300.      *  @return string  アプリケーションID
  301.      */
  302.     public function getAppId()
  303.     {
  304.         return ucfirst(strtolower($this->appid));
  305.     }
  306.  
  307.     /**
  308.      *  アプリケーションIDをチェックする
  309.      *
  310.      *  @access public
  311.      *  @param  string  $id     アプリケーションID
  312.      *  @return mixed   true:OK Ethna_Error:NG
  313.      *  @static
  314.      */
  315.     public static function checkAppId($id)
  316.     {
  317.         $true = true;
  318.         if (strcasecmp($id, 'ethna') === 0
  319.             || strcasecmp($id, 'app') === 0) {
  320.             return Ethna::raiseError("Application Id [$id] is reserved\n");
  321.         }
  322.  
  323.         //    アプリケーションIDはクラス名のprefixともなるため、
  324.         //    数字で始まっていてはいけない
  325.         //    @see http://www.php.net/manual/en/language.variables.php
  326.         if (preg_match('/^[a-zA-Z][a-zA-Z0-9]*$/', $id) === 0) {
  327.             $msg = (preg_match('/^[0-9]$/', $id[0]))
  328.                  ? "Application ID must NOT start with Number.\n"
  329.                  : "Only Numeric(0-9) and Alphabetical(A-Z) is allowed for Application Id\n";
  330.             return Ethna::raiseError($msg);
  331.         }
  332.         return $true;
  333.     }
  334.  
  335.     /**
  336.      *  アクション名をチェックする
  337.      *
  338.      *  @access public
  339.      *  @param  string  $action_name    アクション名
  340.      *  @return mixed   true:OK Ethna_Error:NG
  341.      *  @static
  342.      */
  343.     public static function checkActionName($action_name)
  344.     {
  345.         $true = true;
  346.         if (preg_match('/^[a-zA-Z\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*/',
  347.                        $action_name) === 0) {
  348.             return Ethna::raiseError("invalid action name [$action_name]");
  349.         }
  350.         return $true;
  351.     }
  352.  
  353.     /**
  354.      *  ビュー名をチェックする
  355.      *
  356.      *  @access public
  357.      *  @param  string  $view_name    ビュー名
  358.      *  @return mixed   true:OK Ethna_Error:NG
  359.      *  @static
  360.      */
  361.     public static function checkViewName($view_name)
  362.     {
  363.         $true = true;
  364.         if (preg_match('/^[a-zA-Z\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*/',
  365.                        $view_name) === 0) {
  366.             return Ethna::raiseError("invalid view name [$view_name]");
  367.         }
  368.         return $true;
  369.     }
  370.  
  371.     /**
  372.      *  DSNを返す
  373.      *
  374.      *  @access public
  375.      *  @param  string  $db_key DBキー
  376.      *  @return string  DSN
  377.      */
  378.     public function getDSN($db_key = "")
  379.     {
  380.         if (isset($this->dsn[$db_key]) == false) {
  381.             return null;
  382.         }
  383.         return $this->dsn[$db_key];
  384.     }
  385.  
  386.     /**
  387.      *  DSNの持続接続設定を返す
  388.      *
  389.      *  @access public
  390.      *  @param  string  $db_key DBキー
  391.      *  @return bool    true:persistent false:non-persistent(あるいは設定無し)
  392.      */
  393.     public function getDSN_persistent($db_key = "")
  394.     {
  395.         $key = sprintf("dsn%s_persistent", $db_key == "" ? "" : "_$db_key");
  396.  
  397.         $dsn_persistent = $this->config->get($key);
  398.         if (is_null($dsn_persistent)) {
  399.             return false;
  400.         }
  401.         return $dsn_persistent;
  402.     }
  403.  
  404.     /**
  405.      *  DB設定を返す
  406.      *
  407.      *  @access public
  408.      *  @param  string  $db_key DBキー("", "r", "rw", "default", "blog_r"...)
  409.      *  @return string  $db_keyに対応するDB種別定義(設定が無い場合はnull)
  410.      */
  411.     public function getDBType($db_key = null)
  412.     {
  413.         if (is_null($db_key)) {
  414.             // 一覧を返す
  415.             return $this->db;
  416.         }
  417.  
  418.         if (isset($this->db[$db_key]) == false) {
  419.             return null;
  420.         }
  421.         return $this->db[$db_key];
  422.     }
  423.  
  424.     /**
  425.      *  アプリケーションベースURLを返す
  426.      *
  427.      *  @access public
  428.      *  @return string  アプリケーションベースURL
  429.      */
  430.     public function getURL()
  431.     {
  432.         return $this->url;
  433.     }
  434.  
  435.     /**
  436.      *  アプリケーションベースディレクトリを返す
  437.      *
  438.      *  @access public
  439.      *  @return string  アプリケーションベースディレクトリ
  440.      */
  441.     public function getBasedir()
  442.     {
  443.         return $this->base;
  444.     }
  445.  
  446.     /**
  447.      *  クライアントタイプ/言語からテンプレートディレクトリ名を決定する
  448.      *  デフォルトでは [appid]/template/ja_JP/ (ja_JPはロケール名)
  449.      *  ロケール名は _getDefaultLanguage で決定される。
  450.      *
  451.      *  @access public
  452.      *  @return string  テンプレートディレクトリ
  453.      *  @see    Ethna_Controller#_getDefaultLanguage
  454.      */
  455.     public function getTemplatedir()
  456.     {
  457.         $template = $this->getDirectory('template');
  458.  
  459.         // 言語別ディレクトリ
  460.         // _getDerfaultLanguageメソッドでロケールが指定されていた場合は、
  461.         // テンプレートディレクトリにも自動的にそれを付加する。
  462.         if (!empty($this->locale)) {
  463.             $template .= '/' . $this->locale;
  464.         }
  465.  
  466.         return $template;
  467.     }
  468.  
  469.     /**
  470.      *  アクションディレクトリ名を決定する
  471.      *
  472.      *  @access public
  473.      *  @return string  アクションディレクトリ
  474.      */
  475.     public function getActiondir($gateway = null)
  476.     {
  477.         $key = 'action';
  478.         $gateway = is_null($gateway) ? $this->getGateway() : $gateway;
  479.         switch ($gateway) {
  480.         case GATEWAY_WWW:
  481.             $key = 'action';
  482.             break;
  483.         case GATEWAY_CLI:
  484.             $key = 'action_cli';
  485.             break;
  486.         case GATEWAY_XMLRPC:
  487.             $key = 'action_xmlrpc';
  488.             break;
  489.         }
  490.  
  491.         return (empty($this->directory[$key]) ? ($this->base . (empty($this->base) ? '' : '/')) : ($this->directory[$key] . "/"));
  492.     }
  493.  
  494.     /**
  495.      *  ビューディレクトリ名を決定する
  496.      *
  497.      *  @access public
  498.      *  @return string  ビューディレクトリ
  499.      */
  500.     public function getViewdir()
  501.     {
  502.         return (empty($this->directory['view']) ? ($this->base . (empty($this->base) ? '' : '/')) : ($this->directory['view'] . "/"));
  503.     }
  504.  
  505.     /**
  506.      *  (action,view以外の)テストケースを置くディレクトリ名を決定する
  507.      *
  508.      *  @access public
  509.      *  @return string  テストケースを置くディレクトリ
  510.      */
  511.     public function getTestdir()
  512.     {
  513.         return (empty($this->directory['test']) ? ($this->base . (empty($this->base) ? '' : '/')) : ($this->directory['test'] . "/"));
  514.     }
  515.  
  516.     /**
  517.      *  アプリケーションディレクトリ設定を返す
  518.      *
  519.      *  @access public
  520.      *  @param  string  $key    ディレクトリタイプ("tmp", "template"...)
  521.      *  @return string  $keyに対応したアプリケーションディレクトリ(設定が無い場合はnull)
  522.      */
  523.     public function getDirectory($key)
  524.     {
  525.         if (isset($this->directory[$key]) == false) {
  526.             return null;
  527.         }
  528.         return $this->directory[$key];
  529.     }
  530.     /**
  531.      *  アプリケーションディレクトリ設定を返す
  532.      *
  533.      *  @access public
  534.      *  @param  string  $key    type
  535.      *  @return string  $key    directory
  536.      */
  537.     public function setDirectory($key, $value)
  538.     {
  539.         $this->directory[$key] = $value;
  540.     }
  541.  
  542.  
  543.     /**
  544.      *  アプリケーション拡張子設定を返す
  545.      *
  546.      *  @access public
  547.      *  @param  string  $key    拡張子タイプ("php", "tpl"...)
  548.      *  @return string  $keyに対応した拡張子(設定が無い場合はnull)
  549.      */
  550.     public function getExt($key)
  551.     {
  552.         if (isset($this->ext[$key]) == false) {
  553.             return null;
  554.         }
  555.         return $this->ext[$key];
  556.     }
  557.  
  558.     /**
  559.      *  クラスファクトリオブジェクトのアクセサ(R)
  560.      *
  561.      *  @access public
  562.      *  @return object  Ethna_ClassFactory  クラスファクトリオブジェクト
  563.      */
  564.     public function getClassFactory()
  565.     {
  566.         return $this->class_factory;
  567.     }
  568.  
  569.     /**
  570.      *  アクションエラーオブジェクトのアクセサ
  571.      *
  572.      *  @access public
  573.      *  @return object  Ethna_ActionError   アクションエラーオブジェクト
  574.      */
  575.     public function getActionError()
  576.     {
  577.         return $this->class_factory->getObject('error');
  578.     }
  579.  
  580.     /**
  581.      *  Accessor for ActionForm
  582.      *
  583.      *  @access public
  584.      *  @return object  Ethna_ActionForm    アクションフォームオブジェクト
  585.      */
  586.     public function getActionForm()
  587.     {
  588.         // 明示的にクラスファクトリを利用していない
  589.         return $this->action_form;
  590.     }
  591.  
  592.     /**
  593.      *  Setter for ActionForm
  594.      *  if the ::$action_form class is not null, then cannot set the view
  595.      *
  596.      *  @access public
  597.      *  @return object  Ethna_ActionForm    アクションフォームオブジェクト
  598.      */
  599.     public function setActionForm($af)
  600.     {
  601.         if ($this->action_form !== null) {
  602.             return false;
  603.         }
  604.         $this->action_form = $af;
  605.         return true;
  606.     }
  607.  
  608.  
  609.     /**
  610.      *  Accessor for ViewClass
  611.      *
  612.      *  @access public
  613.      *  @return object  Ethna_View          ビューオブジェクト
  614.      */
  615.     public function getView()
  616.     {
  617.         // 明示的にクラスファクトリを利用していない
  618.         return $this->view;
  619.     }
  620.  
  621.     /**
  622.      *  Setter for ViewClass
  623.      *  if the ::$view class is not null, then cannot set the view
  624.      *
  625.      *  @access public
  626.      *  @param  $view object  Ethna_ViewClass
  627.      *  @return boolean 
  628.      */
  629.     public function setView($view)
  630.     {
  631.         if ($this->view !== null) {
  632.             return false;
  633.         }
  634.         $this->view = $view;
  635.         return true;
  636.     }
  637.  
  638.     /**
  639.      *  backendオブジェクトのアクセサ
  640.      *
  641.      *  @access public
  642.      *  @return object  Ethna_Backend   backendオブジェクト
  643.      */
  644.     public function getBackend()
  645.     {
  646.         return $this->class_factory->getObject('backend');
  647.     }
  648.  
  649.     /**
  650.      *  設定オブジェクトのアクセサ
  651.      *
  652.      *  @access public
  653.      *  @return object  Ethna_Config    設定オブジェクト
  654.      */
  655.     public function getConfig()
  656.     {
  657.         return $this->class_factory->getObject('config');
  658.     }
  659.  
  660.     /**
  661.      *  i18nオブジェクトのアクセサ(R)
  662.      *
  663.      *  @access public
  664.      *  @return object  Ethna_I18N  i18nオブジェクト
  665.      */
  666.     public function getI18N()
  667.     {
  668.         return $this->class_factory->getObject('i18n');
  669.     }
  670.  
  671.     /**
  672.      *  ログオブジェクトのアクセサ
  673.      *
  674.      *  @access public
  675.      *  @return object  Ethna_Logger        ログオブジェクト
  676.      */
  677.     public function getLogger()
  678.     {
  679.         return $this->class_factory->getObject('logger');
  680.     }
  681.  
  682.     /**
  683.      *  セッションオブジェクトのアクセサ
  684.      *
  685.      *  @access public
  686.      *  @return object  Ethna_Session       セッションオブジェクト
  687.      */
  688.     public function getSession()
  689.     {
  690.         return $this->class_factory->getObject('session');
  691.     }
  692.  
  693.     /**
  694.      *  SQLオブジェクトのアクセサ
  695.      *
  696.      *  @access public
  697.      *  @return object  Ethna_AppSQL    SQLオブジェクト
  698.      */
  699.     public function getSQL()
  700.     {
  701.         return $this->class_factory->getObject('sql');
  702.     }
  703.  
  704.     /**
  705.      *  プラグインオブジェクトのアクセサ
  706.      *
  707.      *  @access public
  708.      *  @return object  Ethna_Plugin    プラグインオブジェクト
  709.      */
  710.     public function getPlugin()
  711.     {
  712.         return $this->class_factory->getObject('plugin');
  713.     }
  714.  
  715.     /**
  716.      *  URLハンドラオブジェクトのアクセサ
  717.      *
  718.      *  @access public
  719.      *  @return object  Ethna_UrlHandler    URLハンドラオブジェクト
  720.      */
  721.     public function getUrlHandler()
  722.     {
  723.         return $this->class_factory->getObject('url_handler');
  724.     }
  725.  
  726.     /**
  727.      *  マネージャ一覧を返す
  728.      *
  729.      *  @access public
  730.      *  @return array   マネージャ一覧
  731.      *  @obsolete
  732.      */
  733.     public  function getManagerList()
  734.     {
  735.         return $this->manager;
  736.     }
  737.  
  738.     /**
  739.      *  実行中のアクション名を返す
  740.      *
  741.      *  @access public
  742.      *  @return string  実行中のアクション名
  743.      */
  744.     public function getCurrentActionName()
  745.     {
  746.         return $this->action_name;
  747.     }
  748.  
  749.     /**
  750.      *  実行中のXMLRPCメソッド名を返す
  751.      *
  752.      *  @access public
  753.      *  @return string  実行中のXMLRPCメソッド名
  754.      */
  755.     public function getXmlrpcMethodName()
  756.     {
  757.         return $this->xmlrpc_method_name;
  758.     }
  759.  
  760.     /**
  761.      *  ロケール設定、使用言語を取得する
  762.      *
  763.      *  @access public
  764.      *  @return array   ロケール名(e.x ja_JP, en_US 等),
  765.      *                   システムエンコーディング名,
  766.      *                   クライアントエンコーディング名 の配列
  767.      *                   (ロケール名は、ll_cc の形式。ll = 言語コード cc = 国コード)
  768.      *  @see http://www.gnu.org/software/gettext/manual/html_node/Locale-Names.html
  769.      */
  770.     public function getLanguage()
  771.     {
  772.         return array($this->locale, $this->system_encoding, $this->client_encoding);
  773.     }
  774.  
  775.     /**
  776.      *  ロケール名へのアクセサ(R)
  777.      *
  778.      *  @access public
  779.      *  @return string  ロケール名(e.x ja_JP, en_US 等),
  780.      *                   (ロケール名は、ll_cc の形式。ll = 言語コード cc = 国コード)
  781.      */
  782.     public function getLocale()
  783.     {
  784.         return $this->locale;
  785.     }
  786.  
  787.     /**
  788.      *  ロケール名へのアクセサ(W)
  789.      *
  790.      *  @access public
  791.      *  @param $locale ロケール名(e.x ja_JP, en_US 等),
  792.      *                  (ロケール名は、ll_cc の形式。ll = 言語コード cc = 国コード)
  793.      */
  794.     public function setLocale($locale)
  795.     {
  796.         $this->locale = $locale;
  797.         $i18n = $this->getI18N();
  798.         $i18n->setLanguage($this->locale, $this->system_encoding, $this->client_encoding);
  799.     }
  800.  
  801.     /**
  802.      *  クライアントエンコーディング名へのアクセサ(R)
  803.      *
  804.      *  @access public
  805.      *  @return string  $client_encoding クライアントエンコーディング名
  806.      */
  807.     public function getClientEncoding()
  808.     {
  809.         return $this->client_encoding;
  810.     }
  811.  
  812.     /**
  813.      *  クライアントエンコーディング名へのアクセサ(W)
  814.      *
  815.      *  @access public
  816.      *  @param  string  $client_encoding クライアントエンコーディング名
  817.      */
  818.     public function setClientEncoding($client_encoding)
  819.     {
  820.         $this->client_encoding = $client_encoding;
  821.         $i18n = $this->getI18N();
  822.         $i18n->setLanguage($this->locale, $this->system_encoding, $this->client_encoding);
  823.     }
  824.  
  825.     /**
  826.      *  ゲートウェイを取得する
  827.      *
  828.      *  @access public
  829.      */
  830.     public function getGateway()
  831.     {
  832.         return $this->gateway;
  833.     }
  834.  
  835.     /**
  836.      *  ゲートウェイモードを設定する
  837.      *
  838.      *  @access public
  839.      */
  840.     public function setGateway($gateway)
  841.     {
  842.         $this->gateway = $gateway;
  843.     }
  844.  
  845.     /**
  846.      *  アプリケーションのエントリポイント
  847.      *
  848.      *  @access public
  849.      *  @param  string  $class_name     アプリケーションコントローラのクラス名
  850.      *  @param  mixed   $action_name    指定のアクション名(省略可)
  851.      *  @param  mixed   $fallback_action_name   アクションが決定できなかった場合に実行されるアクション名(省略可)
  852.      *  @static
  853.      */
  854.     public static function main($class_name, $action_name = "", $fallback_action_name = "")
  855.     {
  856.         $c = new $class_name;
  857.         $c->trigger($action_name, $fallback_action_name);
  858.         $c->end();
  859.     }
  860.  
  861.     /**
  862.      *  CLIアプリケーションのエントリポイント
  863.      *
  864.      *  @access public
  865.      *  @param  string  $class_name     アプリケーションコントローラのクラス名
  866.      *  @param  string  $action_name    実行するアクション名
  867.      *  @param  bool    $enable_filter  フィルタチェインを有効にするかどうか
  868.      *  @static
  869.      */
  870.     public static function main_CLI($class_name, $action_name, $enable_filter = true)
  871.     {
  872.         $c = new $class_name(GATEWAY_CLI);
  873.         $c->action_cli[$action_name] = array();
  874.         $c->trigger($action_name, "", $enable_filter);
  875.         $c->end();
  876.     }
  877.  
  878.     /**
  879.      *  XMLRPCアプリケーションのエントリポイント
  880.      *
  881.      *  @access public
  882.      *  @static
  883.      */
  884.     public static function main_XMLRPC($class_name)
  885.     {
  886.         if (extension_loaded('xmlrpc') == false) {
  887.             die("xmlrpc extension is required to enable this gateway");
  888.         }
  889.  
  890.         $c = new $class_name(GATEWAY_XMLRPC);
  891.         $c->trigger("", "", false);
  892.         $c->end();
  893.     }
  894.  
  895.     /**
  896.      *  SOAPアプリケーションのエントリポイント
  897.      *
  898.      *  @access public
  899.      *  @param  string  $class_name     アプリケーションコントローラのクラス名
  900.      *  @param  mixed   $action_name    指定のアクション名(省略可)
  901.      *  @param  mixed   $fallback_action_name   アクションが決定できなかった場合に実行されるアクション名(省略可)
  902.      *  @static
  903.      */
  904.     public static function main_SOAP($class_name, $action_name = "", $fallback_action_name = "")
  905.     {
  906.         $c = new $class_name(GATEWAY_SOAP);
  907.         $c->trigger($action_name, $fallback_action_name);
  908.         $c->end();
  909.     }
  910.  
  911.     /**
  912.      *  フレームワークの処理を開始する
  913.      *
  914.      *  @access public
  915.      *  @param  mixed   $default_action_name    指定のアクション名
  916.      *  @param  mixed   $fallback_action_name   アクション名が決定できなかった場合に実行されるアクション名
  917.      *  @param  bool    $enable_filter  フィルタチェインを有効にするかどうか
  918.      *  @return mixed   0:正常終了 Ethna_Error:エラー
  919.      */
  920.     public function trigger($default_action_name = "", $fallback_action_name = "", $enable_filter = true)
  921.     {
  922.         // フィルターの生成
  923.         if ($enable_filter) {
  924.             $this->_createFilterChain();
  925.         }
  926.  
  927.         // 実行前フィルタ
  928.         for ($i = 0; $i < count($this->filter_chain); $i++) {
  929.             $r = $this->filter_chain[$i]->preFilter();
  930.             if (Ethna::isError($r)) {
  931.                 return $r;
  932.             }
  933.         }
  934.  
  935.         // trigger
  936.         switch ($this->getGateway()) {
  937.         case GATEWAY_WWW:
  938.             $this->_trigger_WWW($default_action_name, $fallback_action_name);
  939.             break;
  940.         case GATEWAY_CLI:
  941.             $this->_trigger_CLI($default_action_name);
  942.             break;
  943.         case GATEWAY_XMLRPC:
  944.             $this->_trigger_XMLRPC();
  945.             break;
  946.         case GATEWAY_SOAP:
  947.             $this->_trigger_SOAP();
  948.             break;
  949.         }
  950.  
  951.         // 実行後フィルタ
  952.         for ($i = count($this->filter_chain) - 1; $i >= 0; $i--) {
  953.             $r = $this->filter_chain[$i]->postFilter();
  954.             if (Ethna::isError($r)) {
  955.                 return $r;
  956.             }
  957.         }
  958.     }
  959.  
  960.     /**
  961.      *  フレームワークの処理を実行する(WWW)
  962.      *
  963.      *  引数$default_action_nameに配列が指定された場合、その配列で指定された
  964.      *  アクション以外は受け付けない(指定されていないアクションが指定された
  965.      *  場合、配列の先頭で指定されたアクションが実行される)
  966.      *
  967.      *  @access private
  968.      *  @param  mixed   $default_action_name    指定のアクション名
  969.      *  @param  mixed   $fallback_action_name   アクション名が決定できなかった場合に実行されるアクション名
  970.      *  @return mixed   0:正常終了 Ethna_Error:エラー
  971.      */
  972.     private function _trigger_WWW($default_action_name = "", $fallback_action_name = "")
  973.     {
  974.         // アクション名の取得
  975.         $action_name = $this->_getActionName($default_action_name, $fallback_action_name);
  976.  
  977.         // マネージャ実行チェック
  978.         $this->_ethnaManagerEnabledCheck($action_name);
  979.  
  980.         // アクション定義の取得
  981.         $action_obj = $this->_getAction($action_name);
  982.         if (is_null($action_obj)) {
  983.             if ($fallback_action_name != "") {
  984.                 $this->logger->log(LOG_DEBUG, 'undefined action [%s] -> try fallback action [%s]', $action_name, $fallback_action_name);
  985.                 $action_obj = $this->_getAction($fallback_action_name);
  986.             }
  987.             if (is_null($action_obj)) {
  988.                 return Ethna::raiseError("undefined action [%s]", E_APP_UNDEFINED_ACTION, $action_name);
  989.             } else {
  990.                 $action_name = $fallback_action_name;
  991.             }
  992.         }
  993.  
  994.         // アクション実行前フィルタ
  995.         for ($i = 0; $i < count($this->filter_chain); $i++) {
  996.             $r = $this->filter_chain[$i]->preActionFilter($action_name);
  997.             if ($r != null) {
  998.                 $this->logger->log(LOG_DEBUG, 'action [%s] -> [%s] by %s', $action_name, $r, get_class($this->filter_chain[$i]));
  999.                 $action_name = $r;
  1000.             }
  1001.         }
  1002.         $this->action_name = $action_name;
  1003.  
  1004.         // オブジェクト生成
  1005.         $backend = $this->getBackend();
  1006.         $session = $this->getSession();
  1007.         $session->restore();
  1008.  
  1009.         // 言語切り替えフックを呼ぶ
  1010.         $this->_setLanguage($this->locale, $this->system_encoding, $this->client_encoding);
  1011.  
  1012.         // アクションフォーム初期化
  1013.         // フォーム定義、フォーム値設定
  1014.         $form_name = $this->getActionFormName($action_name);
  1015.         $this->action_form = new $form_name($this);
  1016.         $backend->setActionForm($this->action_form);
  1017.         $this->action_form->setFormDef_PreHelper();
  1018.         $this->action_form->setFormVars();
  1019.  
  1020.         // バックエンド処理実行
  1021.         $forward_name = $backend->perform($action_name);
  1022.  
  1023.         // アクション実行後フィルタ
  1024.         for ($i = count($this->filter_chain) - 1; $i >= 0; $i--) {
  1025.             $r = $this->filter_chain[$i]->postActionFilter($action_name, $forward_name);
  1026.             if ($r != null) {
  1027.                 $this->logger->log(LOG_DEBUG, 'forward [%s] -> [%s] by %s', $forward_name, $r, get_class($this->filter_chain[$i]));
  1028.                 $forward_name = $r;
  1029.             }
  1030.         }
  1031.  
  1032.         // コントローラで遷移先を決定する(オプション)
  1033.         $forward_name_params = $this->_sortForward($action_name, $forward_name);
  1034.  
  1035.         // Viewへの引数があれば取り出す
  1036.         $preforward_params = array();
  1037.         if (is_array($forward_name_params)) {
  1038.             $forward_name = array_shift($forward_name_params);
  1039.             $preforward_params = $forward_name_params;
  1040.         }
  1041.         else {
  1042.             $forward_name = $forward_name_params;
  1043.         }
  1044.  
  1045.         if ($forward_name != null) {
  1046.             $view_class_name = $this->getViewClassName($forward_name);
  1047.             $this->view = new $view_class_name($backend, $forward_name, $this->_getForwardPath($forward_name));
  1048.             call_user_func_array(array($this->view, 'preforward'), $preforward_params);
  1049.             $this->view->forward();
  1050.         }
  1051.  
  1052.         return 0;
  1053.     }
  1054.  
  1055.     /**
  1056.      *  フレームワークの処理を実行する(CLI)
  1057.      *
  1058.      *  @access private
  1059.      *  @param  mixed   $default_action_name    指定のアクション名
  1060.      *  @return mixed   0:正常終了 Ethna_Error:エラー
  1061.      */
  1062.     private function _trigger_CLI($default_action_name = "")
  1063.     {
  1064.         return $this->_trigger_WWW($default_action_name);
  1065.     }
  1066.  
  1067.     /**
  1068.      *  フレームワークの処理を実行する(XMLRPC)
  1069.      *
  1070.      *  @access private
  1071.      *  @param  mixed   $action_name    指定のアクション名
  1072.      *  @return mixed   0:正常終了 Ethna_Error:エラー
  1073.      */
  1074.     private function _trigger_XMLRPC($action_name = "")
  1075.     {
  1076.         // prepare xmlrpc server
  1077.         $xmlrpc_gateway_method_name = "_Ethna_XmlrpcGateway";
  1078.         $xmlrpc_server = xmlrpc_server_create();
  1079.  
  1080.         $method = null;
  1081.         $param = xmlrpc_decode_request(file_get_contents('php://input'), $method);
  1082.         $this->xmlrpc_method_name = $method;
  1083.  
  1084.         $request = xmlrpc_encode_request(
  1085.             $xmlrpc_gateway_method_name,
  1086.             $param,
  1087.             array(
  1088.                 'output_type'   => 'xml',
  1089.                 'verbosity'     => 'pretty',
  1090.                 'escaping'      => array('markup'),
  1091.                 'version'       => 'xmlrpc',
  1092.                 'encoding'      => 'utf-8'
  1093.             )
  1094.         );
  1095.  
  1096.         xmlrpc_server_register_method(
  1097.             $xmlrpc_server,
  1098.             $xmlrpc_gateway_method_name,
  1099.             $xmlrpc_gateway_method_name
  1100.         );
  1101.  
  1102.         // send request
  1103.         $r = xmlrpc_server_call_method(
  1104.             $xmlrpc_server,
  1105.             $request,
  1106.             null,
  1107.             array(
  1108.                 'output_type'   => 'xml',
  1109.                 'verbosity'     => 'pretty',
  1110.                 'escaping'      => array('markup'),
  1111.                 'version'       => 'xmlrpc',
  1112.                 'encoding'      => 'utf-8'
  1113.             )
  1114.         );
  1115.  
  1116.         header('Content-Length: ' . strlen($r));
  1117.         header('Content-Type: text/xml; charset=UTF-8');
  1118.         print $r;
  1119.     }
  1120.  
  1121.     /**
  1122.      *  _trigger_XMLRPCのコールバックメソッド
  1123.      *
  1124.      *  @access public
  1125.      */
  1126.     private function trigger_XMLRPC($method, $param)
  1127.     {
  1128.         // アクション定義の取得
  1129.         $action_obj = $this->_getAction($method);
  1130.         if (is_null($action_obj)) {
  1131.             return Ethna::raiseError("undefined xmlrpc method [%s]", E_APP_UNDEFINED_ACTION, $method);
  1132.         }
  1133.  
  1134.         // オブジェクト生成
  1135.         $backend = $this->getBackend();
  1136.  
  1137.         $form_name = $this->getActionFormName($method);
  1138.         $this->action_form = new $form_name($this);
  1139.         $def = $this->action_form->getDef();
  1140.         $n = 0;
  1141.         foreach ($def as $key => $value) {
  1142.             if (isset($param[$n]) == false) {
  1143.                 $this->action_form->set($key, null);
  1144.             } else {
  1145.                 $this->action_form->set($key, $param[$n]);
  1146.             }
  1147.             $n++;
  1148.         }
  1149.  
  1150.         // バックエンド処理実行
  1151.         $backend->setActionForm($this->action_form);
  1152.  
  1153.         $session = $this->getSession();
  1154.         $session->restore();
  1155.         $r = $backend->perform($method);
  1156.  
  1157.         return $r;
  1158.     }
  1159.  
  1160.     /**
  1161.      *  SOAPフレームワークの処理を実行する
  1162.      *
  1163.      *  @access private
  1164.      */
  1165.     private function _trigger_SOAP()
  1166.     {
  1167.         // SOAPエントリクラス
  1168.         $gg = new Ethna_SOAP_GatewayGenerator();
  1169.         $script = $gg->generate();
  1170.         eval($script);
  1171.  
  1172.         // SOAPリクエスト処理
  1173.         $server = new SoapServer(null, array('uri' => $this->config->get('url')));
  1174.         $server->setClass($gg->getClassName());
  1175.         $server->handle();
  1176.     }
  1177.  
  1178.     /**
  1179.      *  エラーハンドラ
  1180.      *
  1181.      *  エラー発生時の追加処理を行いたい場合はこのメソッドをオーバーライドする
  1182.      *  (アラートメール送信等−デフォルトではログ出力時にアラートメール
  1183.      *  が送信されるが、エラー発生時に別にアラートメールをここで送信
  1184.      *  させることも可能)
  1185.      *
  1186.      *  @access public
  1187.      *  @param  object  Ethna_Error     エラーオブジェクト
  1188.      */
  1189.     public function handleError($error)
  1190.     {
  1191.         // ログ出力
  1192.         list ($log_level, $dummy) = $this->logger->errorLevelToLogLevel($error->getLevel());
  1193.         $message = $error->getMessage();
  1194.         $this->logger->log($log_level, sprintf("%s [ERROR CODE(%d)]", $message, $error->getCode()));
  1195.     }
  1196.  
  1197.     /**
  1198.      *  エラーメッセージを取得する
  1199.      *
  1200.      *  @access public
  1201.      *  @param  int     $code       エラーコード
  1202.      *  @return string  エラーメッセージ
  1203.      */
  1204.     public function getErrorMessage($code)
  1205.     {
  1206.         $message_list = $GLOBALS['_Ethna_error_message_list'];
  1207.         for ($i = count($message_list)-1; $i >= 0; $i--) {
  1208.             if (array_key_exists($code, $message_list[$i])) {
  1209.                 return $message_list[$i][$code];
  1210.             }
  1211.         }
  1212.         return null;
  1213.     }
  1214.  
  1215.     /**
  1216.      *  実行するアクション名を返す
  1217.      *
  1218.      *  @access private
  1219.      *  @param  mixed   $default_action_name    指定のアクション名
  1220.      *  @return string  実行するアクション名
  1221.      */
  1222.     private function _getActionName($default_action_name, $fallback_action_name)
  1223.     {
  1224.         // フォームから要求されたアクション名を取得する
  1225.         $form_action_name = $this->_getActionName_Form();
  1226.         $form_action_name = preg_replace('/[^a-z0-9\-_]+/i', '', $form_action_name);
  1227.         $this->logger->log(LOG_DEBUG, 'form_action_name[%s]', $form_action_name);
  1228.  
  1229.         // Ethnaマネージャへのフォームからのリクエストは拒否
  1230.         if ($form_action_name == "__ethna_info__" ||
  1231.             $form_action_name == "__ethna_unittest__") {
  1232.             $form_action_name = "";
  1233.         }
  1234.  
  1235.         // フォームからの指定が無い場合はエントリポイントに指定されたデフォルト値を利用する
  1236.         if ($form_action_name == "" && count($default_action_name) > 0) {
  1237.             $tmp = is_array($default_action_name) ? $default_action_name[0] : $default_action_name;
  1238.             if ($tmp{strlen($tmp)-1} == '*') {
  1239.                 $tmp = substr($tmp, 0, -1);
  1240.             }
  1241.             $this->logger->log(LOG_DEBUG, '-> default_action_name[%s]', $tmp);
  1242.             $action_name = $tmp;
  1243.         } else {
  1244.             $action_name = $form_action_name;
  1245.         }
  1246.  
  1247.         // エントリポイントに配列が指定されている場合は指定以外のアクション名は拒否する
  1248.         if (is_array($default_action_name)) {
  1249.             if ($this->_isAcceptableActionName($action_name, $default_action_name) == false) {
  1250.                 // 指定以外のアクション名で合った場合は$fallback_action_name(or デフォルト)
  1251.                 $tmp = $fallback_action_name != "" ? $fallback_action_name : $default_action_name[0];
  1252.                 if ($tmp{strlen($tmp)-1} == '*') {
  1253.                     $tmp = substr($tmp, 0, -1);
  1254.                 }
  1255.                 $this->logger->log(LOG_DEBUG, '-> fallback_action_name[%s]', $tmp);
  1256.                 $action_name = $tmp;
  1257.             }
  1258.         }
  1259.  
  1260.         $this->logger->log(LOG_DEBUG, '<<< action_name[%s] >>>', $action_name);
  1261.  
  1262.         return $action_name;
  1263.     }
  1264.  
  1265.     /**
  1266.      *  フォームにより要求されたアクション名を返す
  1267.      *
  1268.      *  アプリケーションの性質に応じてこのメソッドをオーバーライドして下さい。
  1269.      *  デフォルトでは"action_"で始まるフォーム値の"action_"の部分を除いたもの
  1270.      *  ("action_sample"なら"sample")がアクション名として扱われます
  1271.      *
  1272.      *  @access protected
  1273.      *  @return string  フォームにより要求されたアクション名
  1274.      */
  1275.     protected function _getActionName_Form()
  1276.     {
  1277.         if (isset($_SERVER['REQUEST_METHOD']) == false) {
  1278.             return null;
  1279.         }
  1280.  
  1281.         $url_handler = $this->getUrlHandler();
  1282.         if ($_SERVER['REQUEST_METHOD'] == "GET") {
  1283.             $tmp_vars = $_GET;
  1284.         } else if ($_SERVER['REQUEST_METHOD'] == "POST") {
  1285.             $tmp_vars = $_POST;
  1286.         }
  1287.  
  1288.         if (empty($_SERVER['URL_HANDLER']) == false) {
  1289.             $tmp_vars['__url_handler__'] = $_SERVER['URL_HANDLER'];
  1290.             $tmp_vars['__url_info__'] = isset($_SERVER['PATH_INFO']) ? $_SERVER['PATH_INFO'] : null;
  1291.             $tmp_vars = $url_handler->requestToAction($tmp_vars);
  1292.  
  1293.             if ($_SERVER['REQUEST_METHOD'] == "GET") {
  1294.                 $_GET = array_merge($_GET, $tmp_vars);
  1295.             } else if ($_SERVER['REQUEST_METHOD'] == "POST") {
  1296.                 $_POST = array_merge($_POST, $tmp_vars);
  1297.             }
  1298.             $_REQUEST = array_merge($_REQUEST, $tmp_vars);
  1299.         }
  1300.  
  1301.         if (strcasecmp($_SERVER['REQUEST_METHOD'], 'post') == 0) {
  1302.             $http_vars = $_POST;
  1303.         } else {
  1304.             $http_vars = $_GET;
  1305.         }
  1306.  
  1307.         // フォーム値からリクエストされたアクション名を取得する
  1308.         $action_name = $sub_action_name = null;
  1309.         foreach ($http_vars as $name => $value) {
  1310.             if ($value == "" || strncmp($name, 'action_', 7) != 0) {
  1311.                 continue;
  1312.             }
  1313.  
  1314.             $tmp = substr($name, 7);
  1315.  
  1316.             // type="image"対応
  1317.             if (preg_match('/_x$/', $name) || preg_match('/_y$/', $name)) {
  1318.                 $tmp = substr($tmp, 0, strlen($tmp)-2);
  1319.             }
  1320.  
  1321.             // value="dummy"となっているものは優先度を下げる
  1322.             if ($value == "dummy") {
  1323.                 $sub_action_name = $tmp;
  1324.             } else {
  1325.                 $action_name = $tmp;
  1326.             }
  1327.         }
  1328.         if ($action_name == null) {
  1329.             $action_name = $sub_action_name;
  1330.         }
  1331.  
  1332.         return $action_name;
  1333.     }
  1334.  
  1335.     /**
  1336.      *  アクション名を指定するクエリ/HTMLを生成する
  1337.      *
  1338.      *  @access public
  1339.      *  @param  string  $action action to request
  1340.      *  @param  string  $type   hidden, url...
  1341.      *  @todo   consider gateway
  1342.      */
  1343.     public function getActionRequest($action, $type = "hidden")
  1344.     {
  1345.         $s = null;
  1346.         if ($type == "hidden") {
  1347.             $s = sprintf('<input type="hidden" name="action_%s" value="true" />', htmlspecialchars($action, ENT_QUOTES));
  1348.         } else if ($type == "url") {
  1349.             $s = sprintf('action_%s=true', urlencode($action));
  1350.         }
  1351.         return $s;
  1352.     }
  1353.  
  1354.     /**
  1355.      *  フォームにより要求されたアクション名に対応する定義を返す
  1356.      *
  1357.      *  @access private
  1358.      *  @param  string  $action_name    アクション名
  1359.      *  @return array   アクション定義
  1360.      */
  1361.     public function _getAction($action_name, $gateway = null)
  1362.     {
  1363.         $action = array();
  1364.         $gateway = is_null($gateway) ? $this->getGateway() : $gateway;
  1365.         switch ($gateway) {
  1366.         case GATEWAY_WWW:
  1367.             $action = $this->action;
  1368.             break;
  1369.         case GATEWAY_CLI:
  1370.             $action = $this->action_cli;
  1371.             break;
  1372.         case GATEWAY_XMLRPC:
  1373.             $action = $this->action_xmlrpc;
  1374.             break;
  1375.         }
  1376.  
  1377.         $action_obj = array();
  1378.         if (isset($action[$action_name])) {
  1379.             $action_obj = $action[$action_name];
  1380.             if (isset($action_obj['inspect']) && $action_obj['inspect']) {
  1381.                 return $action_obj;
  1382.             }
  1383.         } else {
  1384.             $this->logger->log(LOG_DEBUG, "action [%s] is not defined -> try default", $action_name);
  1385.         }
  1386.  
  1387.         // アクションスクリプトのインクルード
  1388.         $this->_includeActionScript($action_obj, $action_name);
  1389.  
  1390.         // 省略値の補正
  1391.         if (isset($action_obj['class_name']) == false) {
  1392.             $action_obj['class_name'] = $this->getDefaultActionClass($action_name);
  1393.         }
  1394.  
  1395.         if (isset($action_obj['form_name']) == false) {
  1396.             $action_obj['form_name'] = $this->getDefaultFormClass($action_name);
  1397.         } else if (class_exists($action_obj['form_name']) == false) {
  1398.             // 明示指定されたフォームクラスが定義されていない場合は警告
  1399.             $this->logger->log(LOG_WARNING, 'stated form class is not defined [%s]', $action_obj['form_name']);
  1400.         }
  1401.  
  1402.         // 必要条件の確認
  1403.         if (class_exists($action_obj['class_name']) == false) {
  1404.             $this->logger->log(LOG_NOTICE, 'action class is not defined [%s]', $action_obj['class_name']);
  1405.             $_ret_object = null;
  1406.             return $_ret_object;
  1407.         }
  1408.         if (class_exists($action_obj['form_name']) == false) {
  1409.             // フォームクラスは未定義でも良い
  1410.             $class_name = $this->class_factory->getObjectName('form');
  1411.             $this->logger->log(LOG_DEBUG, 'form class is not defined [%s] -> falling back to default [%s]', $action_obj['form_name'], $class_name);
  1412.             $action_obj['form_name'] = $class_name;
  1413.         }
  1414.  
  1415.         $action_obj['inspect'] = true;
  1416.         $action[$action_name] = $action_obj;
  1417.         return $action[$action_name];
  1418.     }
  1419.  
  1420.     /**
  1421.      *  アクション名とアクションクラスからの戻り値に基づいて遷移先を決定する
  1422.      *
  1423.      *  @access protected
  1424.      *  @param  string  $action_name    アクション名
  1425.      *  @param  string  $retval         アクションクラスからの戻り値
  1426.      *  @return string  遷移先
  1427.      */
  1428.     protected function _sortForward($action_name, $retval)
  1429.     {
  1430.         return $retval;
  1431.     }
  1432.  
  1433.     /**
  1434.      *  フィルタチェインを生成する
  1435.      *
  1436.      *  @access protected
  1437.      */
  1438.     protected function _createFilterChain()
  1439.     {
  1440.         $this->filter_chain = array();
  1441.         foreach ($this->filter as $filter) {
  1442.             $filter_plugin = $this->plugin->getPlugin('Filter', $filter);
  1443.             if (Ethna::isError($filter_plugin)) {
  1444.                 continue;
  1445.             }
  1446.  
  1447.             $this->filter_chain[] = $filter_plugin;
  1448.         }
  1449.     }
  1450.  
  1451.     /**
  1452.      *  アクション名が実行許可されているものかどうかを返す
  1453.      *
  1454.      *  @access private
  1455.      *  @param  string  $action_name            リクエストされたアクション名
  1456.      *  @param  array   $default_action_name    許可されているアクション名
  1457.      *  @return bool    true:許可 false:不許可
  1458.      */
  1459.     private function _isAcceptableActionName($action_name, $default_action_name)
  1460.     {
  1461.         foreach (to_array($default_action_name) as $name) {
  1462.             if ($action_name == $name) {
  1463.                 return true;
  1464.             } else if ($name{strlen($name)-1} == '*') {
  1465.                 if (strncmp($action_name, substr($name, 0, -1), strlen($name)-1) == 0) {
  1466.                     return true;
  1467.                 }
  1468.             }
  1469.         }
  1470.         return false;
  1471.     }
  1472.  
  1473.     /**
  1474.      *  指定されたアクションのフォームクラス名を返す(オブジェクトの生成は行わない)
  1475.      *
  1476.      *  @access public
  1477.      *  @param  string  $action_name    アクション名
  1478.      *  @return string  アクションのフォームクラス名
  1479.      */
  1480.     public function getActionFormName($action_name)
  1481.     {
  1482.         $action_obj = $this->_getAction($action_name);
  1483.         if (is_null($action_obj)) {
  1484.             return null;
  1485.         }
  1486.  
  1487.         return $action_obj['form_name'];
  1488.     }
  1489.  
  1490.     /**
  1491.      *  アクションに対応するフォームクラス名が省略された場合のデフォルトクラス名を返す
  1492.      *
  1493.      *  デフォルトでは[プロジェクトID]_Form_[アクション名]となるので好み応じてオーバライドする
  1494.      *
  1495.      *  @access public
  1496.      *  @param  string  $action_name    アクション名
  1497.      *  @return string  アクションフォーム名
  1498.      */
  1499.     public function getDefaultFormClass($action_name, $gateway = null)
  1500.     {
  1501.         $gateway_prefix = $this->_getGatewayPrefix($gateway);
  1502.  
  1503.         $postfix = preg_replace('/_(.)/e', "strtoupper('\$1')", ucfirst($action_name));
  1504.         $r = sprintf("%s_%sForm_%s", $this->getAppId(), $gateway_prefix ? $gateway_prefix . "_" : "", $postfix);
  1505.         $this->logger->log(LOG_DEBUG, "default action class [%s]", $r);
  1506.  
  1507.         return $r;
  1508.     }
  1509.  
  1510.     /**
  1511.      *  getDefaultFormClass()で取得したクラス名からアクション名を取得する
  1512.      *
  1513.      *  getDefaultFormClass()をオーバーライドした場合、こちらも合わせてオーバーライド
  1514.      *  することを推奨(必須ではない)
  1515.      *
  1516.      *  @access public
  1517.      *  @param  string  $class_name     フォームクラス名
  1518.      *  @return string  アクション名
  1519.      */
  1520.     public function actionFormToName($class_name)
  1521.     {
  1522.         $prefix = sprintf("%s_Form_", $this->getAppId());
  1523.         if (preg_match("/$prefix(.*)/", $class_name, $match) == 0) {
  1524.             // 不明なクラス名
  1525.             return null;
  1526.         }
  1527.         $target = $match[1];
  1528.  
  1529.         $action_name = substr(preg_replace('/([A-Z])/e', "'_' . strtolower('\$1')", $target), 1);
  1530.  
  1531.         return $action_name;
  1532.     }
  1533.  
  1534.     /**
  1535.      *  アクションに対応するフォームパス名が省略された場合のデフォルトパス名を返す
  1536.      *
  1537.      *  デフォルトでは_getDefaultActionPath()と同じ結果を返す(1ファイルに
  1538.      *  アクションクラスとフォームクラスが記述される)ので、好みに応じて
  1539.      *  オーバーライドする
  1540.      *
  1541.      *  @access public
  1542.      *  @param  string  $action_name    アクション名
  1543.      *  @return string  form classが定義されるスクリプトのパス名
  1544.      */
  1545.     public function getDefaultFormPath($action_name)
  1546.     {
  1547.         return $this->getDefaultActionPath($action_name);
  1548.     }
  1549.  
  1550.     /**
  1551.      *  指定されたアクションのクラス名を返す(オブジェクトの生成は行わない)
  1552.      *
  1553.      *  @access public
  1554.      *  @param  string  $action_name    アクションの名称
  1555.      *  @return string  アクションのクラス名
  1556.      */
  1557.     public function getActionClassName($action_name)
  1558.     {
  1559.         $action_obj = $this->_getAction($action_name);
  1560.         if ($action_obj == null) {
  1561.             return null;
  1562.         }
  1563.  
  1564.         return $action_obj['class_name'];
  1565.     }
  1566.  
  1567.     /**
  1568.      *  アクションに対応するアクションクラス名が省略された場合のデフォルトクラス名を返す
  1569.      *
  1570.      *  デフォルトでは[プロジェクトID]_Action_[アクション名]となるので好み応じてオーバライドする
  1571.      *
  1572.      *  @access public
  1573.      *  @param  string  $action_name    アクション名
  1574.      *  @return string  アクションクラス名
  1575.      */
  1576.     public function getDefaultActionClass($action_name, $gateway = null)
  1577.     {
  1578.         $gateway_prefix = $this->_getGatewayPrefix($gateway);
  1579.  
  1580.         $postfix = preg_replace('/_(.)/e', "strtoupper('\$1')", ucfirst($action_name));
  1581.         $r = sprintf("%s_%sAction_%s", $this->getAppId(), $gateway_prefix ? $gateway_prefix . "_" : "", $postfix);
  1582.         $this->logger->log(LOG_DEBUG, "default action class [%s]", $r);
  1583.  
  1584.         return $r;
  1585.     }
  1586.  
  1587.     /**
  1588.      *  getDefaultActionClass()で取得したクラス名からアクション名を取得する
  1589.      *
  1590.      *  getDefaultActionClass()をオーバーライドした場合、こちらも合わせてオーバーライド
  1591.      *  することを推奨(必須ではない)
  1592.      *
  1593.      *  @access public
  1594.      *  @param  string  $class_name     アクションクラス名
  1595.      *  @return string  アクション名
  1596.      */
  1597.     public function actionClassToName($class_name)
  1598.     {
  1599.         $prefix = sprintf("%s_Action_", $this->getAppId());
  1600.         if (preg_match("/$prefix(.*)/", $class_name, $match) == 0) {
  1601.             // 不明なクラス名
  1602.             return null;
  1603.         }
  1604.         $target = $match[1];
  1605.  
  1606.         $action_name = substr(preg_replace('/([A-Z])/e', "'_' . strtolower('\$1')", $target), 1);
  1607.  
  1608.         return $action_name;
  1609.     }
  1610.  
  1611.     /**
  1612.      *  アクションに対応するアクションパス名が省略された場合のデフォルトパス名を返す
  1613.      *
  1614.      *  デフォルトでは"foo_bar" -> "/Foo/Bar.php"となるので好み応じてオーバーライドする
  1615.      *
  1616.      *  @access public
  1617.      *  @param  string  $action_name    アクション名
  1618.      *  @return string  アクションクラスが定義されるスクリプトのパス名
  1619.      */
  1620.     public function getDefaultActionPath($action_name)
  1621.     {
  1622.         $r = preg_replace('/_(.)/e', "'/' . strtoupper('\$1')", ucfirst($action_name)) . '.' . $this->getExt('php');
  1623.         $this->logger->log(LOG_DEBUG, "default action path [%s]", $r);
  1624.  
  1625.         return $r;
  1626.     }
  1627.  
  1628.     /**
  1629.      *  指定された遷移名に対応するビュークラス名を返す(オブジェクトの生成は行わない)
  1630.      *
  1631.      *  @access public
  1632.      *  @param  string  $forward_name   遷移先の名称
  1633.      *  @return string  view classのクラス名
  1634.      */
  1635.     public function getViewClassName($forward_name)
  1636.     {
  1637.         if ($forward_name == null) {
  1638.             return null;
  1639.         }
  1640.  
  1641.         if (isset($this->forward[$forward_name])) {
  1642.             $forward_obj = $this->forward[$forward_name];
  1643.         } else {
  1644.             $forward_obj = array();
  1645.         }
  1646.  
  1647.         if (isset($forward_obj['view_name'])) {
  1648.             $class_name = $forward_obj['view_name'];
  1649.             if (class_exists($class_name)) {
  1650.                 return $class_name;
  1651.             }
  1652.         } else {
  1653.             $class_name = null;
  1654.         }
  1655.  
  1656.         // viewのインクルード
  1657.         $this->_includeViewScript($forward_obj, $forward_name);
  1658.  
  1659.         if (is_null($class_name) == false && class_exists($class_name)) {
  1660.             return $class_name;
  1661.         } else if (is_null($class_name) == false) {
  1662.             $this->logger->log(LOG_WARNING, 'stated view class is not defined [%s] -> try default', $class_name);
  1663.         }
  1664.  
  1665.         $class_name = $this->getDefaultViewClass($forward_name);
  1666.         if (class_exists($class_name)) {
  1667.             return $class_name;
  1668.         } else {
  1669.             $class_name = $this->class_factory->getObjectName('view');
  1670.             $this->logger->log(LOG_DEBUG, 'view class is not defined for [%s] -> use default [%s]', $forward_name, $class_name);
  1671.             return $class_name;
  1672.         }
  1673.     }
  1674.  
  1675.     /**
  1676.      *  遷移名に対応するビュークラス名が省略された場合のデフォルトクラス名を返す
  1677.      *
  1678.      *  デフォルトでは[プロジェクトID]_View_[遷移名]となるので好み応じてオーバライドする
  1679.      *
  1680.      *  @access public
  1681.      *  @param  string  $forward_name   forward名
  1682.      *  @return string  view classクラス名
  1683.      */
  1684.     public function getDefaultViewClass($forward_name, $gateway = null)
  1685.     {
  1686.         $gateway_prefix = $this->_getGatewayPrefix($gateway);
  1687.  
  1688.         $postfix = preg_replace('/_(.)/e', "strtoupper('\$1')", ucfirst($forward_name));
  1689.         $r = sprintf("%s_%sView_%s", $this->getAppId(), $gateway_prefix ? $gateway_prefix . "_" : "", $postfix);
  1690.         $this->logger->log(LOG_DEBUG, "default view class [%s]", $r);
  1691.  
  1692.         return $r;
  1693.     }
  1694.  
  1695.     /**
  1696.      *  遷移名に対応するビューパス名が省略された場合のデフォルトパス名を返す
  1697.      *
  1698.      *  デフォルトでは"foo_bar" -> "/Foo/Bar.php"となるので好み応じてオーバーライドする
  1699.      *
  1700.      *  @access public
  1701.      *  @param  string  $forward_name   forward名
  1702.      *  @return string  view classが定義されるスクリプトのパス名
  1703.      */
  1704.     public function getDefaultViewPath($forward_name)
  1705.     {
  1706.         $r = preg_replace('/_(.)/e', "'/' . strtoupper('\$1')", ucfirst($forward_name)) . '.' . $this->getExt('php');
  1707.         $this->logger->log(LOG_DEBUG, "default view path [%s]", $r);
  1708.  
  1709.         return $r;
  1710.     }
  1711.  
  1712.     /**
  1713.      *  遷移名に対応するテンプレートパス名が省略された場合のデフォルトパス名を返す
  1714.      *
  1715.      *  デフォルトでは"foo_bar"というforward名が"foo/bar" + テンプレート拡張子となる
  1716.      *  ので好み応じてオーバライドする
  1717.      *
  1718.      *  @access public
  1719.      *  @param  string  $forward_name   forward名
  1720.      *  @return string  forwardパス名
  1721.      */
  1722.     public function getDefaultForwardPath($forward_name)
  1723.     {
  1724.         return str_replace('_', '/', $forward_name) . '.' . $this->ext['tpl'];
  1725.     }
  1726.  
  1727.     /**
  1728.      *  テンプレートパス名から遷移名を取得する
  1729.      *
  1730.      *  getDefaultForwardPath()をオーバーライドした場合、こちらも合わせてオーバーライド
  1731.      *  することを推奨(必須ではない)
  1732.      *
  1733.      *  @access public
  1734.      *  @param  string  $forward_path   テンプレートパス名
  1735.      *  @return string  遷移名
  1736.      */
  1737.     public function forwardPathToName($forward_path)
  1738.     {
  1739.         $forward_path = preg_replace('/^\/+/', '', $forward_path);
  1740.         $forward_path = preg_replace(sprintf('/\.%s$/', $this->getExt('tpl')), '', $forward_path);
  1741.  
  1742.         return str_replace('/', '_', $forward_path);
  1743.     }
  1744.  
  1745.     /**
  1746.      *  遷移名からテンプレートファイルのパス名を取得する
  1747.      *
  1748.      *  @access private
  1749.      *  @param  string  $forward_name   forward名
  1750.      *  @return string  テンプレートファイルのパス名
  1751.      */
  1752.     public function _getForwardPath($forward_name)
  1753.     {
  1754.         $forward_obj = null;
  1755.  
  1756.         if (isset($this->forward[$forward_name]) == false) {
  1757.             // try default
  1758.             $this->forward[$forward_name] = array();
  1759.         }
  1760.         $forward_obj = $this->forward[$forward_name];
  1761.         if (isset($forward_obj['forward_path']) == false) {
  1762.             // 省略値補正
  1763.             $forward_obj['forward_path'] = $this->getDefaultForwardPath($forward_name);
  1764.         }
  1765.  
  1766.         return $forward_obj['forward_path'];
  1767.     }
  1768.  
  1769.     /**
  1770.      *  レンダラを取得する
  1771.      *
  1772.      *  @access public
  1773.      *  @return object  Ethna_Renderer  レンダラオブジェクト
  1774.      */
  1775.     public function getRenderer()
  1776.     {
  1777.         if ($this->renderer instanceof Ethna_Renderer) {
  1778.             return $this->renderer;
  1779.         }
  1780.  
  1781.         // if action is __ethna_info__ or __ethna_unittest__, the renderer must be Smarty2
  1782.         if ($this->action_name == '__ethna_info__'
  1783.             || $this->action_name == '__ethna_unittest__') {
  1784.             require_once ETHNA_BASE . '/class/Renderer/Smarty.php';
  1785.             // force update delimiter setting
  1786.             $renderer_setting = $this->getConfig()->get('renderer');
  1787.             $smarty_setting = (isset($renreder_setting['smarty']) ? $renderer_setting['smarty'] : array());
  1788.             $this->getConfig()->set('renderer', array_merge(
  1789.                 $smarty_setting,
  1790.                 array('smarty' => array(
  1791.                     'left_delimiter' => '{',
  1792.                     'right_delimiter' => '}',
  1793.                 )
  1794.             )));
  1795.             $this->renderer = new Ethna_Renderer_Smarty($this);
  1796.         } else {
  1797.             $this->renderer = $this->class_factory->getObject('renderer');
  1798.         }
  1799.         $this->_setDefaultTemplateEngine($this->renderer);
  1800.         return $this->renderer;
  1801.     }
  1802.  
  1803.     /**
  1804.      *  テンプレートエンジン取得する (DEPRECATED)
  1805.      *  getRenderer() を使ってください
  1806.      *
  1807.      *  @access public
  1808.      *  @return object  Ethna_Renderer  レンダラオブジェクト
  1809.      *  @obsolete
  1810.      */
  1811.     public function getTemplateEngine()
  1812.     {
  1813.         trigger_error('Method ' . __METHOD__ . ' is depreacted. Use getRenderer() instead.', E_USER_DEPRECATED);
  1814.         return $this->getRenderer();
  1815.     }
  1816.  
  1817.     /**
  1818.      *  テンプレートエンジンのデフォルト状態を設定する
  1819.      *
  1820.      *  @access protected
  1821.      *  @param  object  Ethna_Renderer  レンダラオブジェクト
  1822.      *  @obsolete
  1823.      */
  1824.     protected function _setDefaultTemplateEngine($renderer)
  1825.     {
  1826.     }
  1827.  
  1828.     /**
  1829.      *  使用言語、ロケールを設定する
  1830.      *  条件によって使用言語、ロケールを切り替えたい場合は、
  1831.      *  このメソッドをオーバーライドする。
  1832.      *
  1833.      *  @access protected
  1834.      *  @param  string  $locale             ロケール名(ja_JP, en_US等)
  1835.      *                                       (ll_cc の形式。ll = 言語コード cc = 国コード)
  1836.      *  @param  string  $system_encoding    システムエンコーディング名
  1837.      *  @param  string  $client_encoding    クライアントエンコーディング(テンプレートのエンコーディングと考えれば良い)
  1838.      *  @see    http://www.gnu.org/software/gettext/manual/html_node/Locale-Names.html
  1839.      *  @see    Ethna_Controller#_getDefaultLanguage
  1840.      */
  1841.     protected function _setLanguage($locale, $system_encoding = null, $client_encoding = null)
  1842.     {
  1843.         $this->locale = $locale;
  1844.         $this->system_encoding = $system_encoding;
  1845.         $this->client_encoding = $client_encoding;
  1846.  
  1847.         //   $this->locale, $this->client_encoding を書き換えた場合は
  1848.         //   必ず Ethna_I18N クラスの setLanguageメソッドも呼ぶこと!
  1849.         //   さもないとカタログその他が再ロードされない！
  1850.         $i18n = $this->getI18N();
  1851.         $i18n->setLanguage($locale, $system_encoding, $client_encoding);
  1852.     }
  1853.  
  1854.     /**
  1855.      *  デフォルト状態での使用言語を取得する
  1856.      *  外部に出力されるEthnaのエラーメッセージ等のエンコーディングを
  1857.      *  切り替えたい場合は、このメソッドをオーバーライドする。
  1858.      *
  1859.      *  @access protected
  1860.      *  @return array   ロケール名(e.x ja_JP, en_US 等),
  1861.      *                   システムエンコーディング名,
  1862.      *                   クライアントエンコーディング名
  1863.      *                   (= テンプレートのエンコーディングと考えてよい) の配列
  1864.      *                   (ロケール名は ll_cc の形式。ll = 言語コード cc = 国コード)
  1865.      *
  1866.      *   WARNING!! : クライアントエンコーディング名が、フレームワークの内部エンコーデ
  1867.      *               ィングとして設定されます。つまり、クライアントエンコーディングで
  1868.      *               ブラウザからの入力は入ってくるものと想定しています！
  1869.      */
  1870.     protected function _getDefaultLanguage()
  1871.     {
  1872.         return array('ja_JP', 'UTF-8', 'UTF-8');
  1873.     }
  1874.  
  1875.     /**
  1876.      *  デフォルト状態でのゲートウェイを取得する
  1877.      *
  1878.      *  @access protected
  1879.      *  @return int     ゲートウェイ定義(GATEWAY_WWW, GATEWAY_CLI...)
  1880.      */
  1881.     protected function _getDefaultGateway($gateway)
  1882.     {
  1883.         if (is_null($GLOBALS['_Ethna_gateway']) == false) {
  1884.             return $GLOBALS['_Ethna_gateway'];
  1885.         }
  1886.         return GATEWAY_WWW;
  1887.     }
  1888.  
  1889.     /**
  1890.      *  ゲートウェイに対応したクラス名のプレフィクスを取得する
  1891.      *
  1892.      *  @access public
  1893.      *  @param  string  $gateway    ゲートウェイ
  1894.      *  @return string  ゲートウェイクラスプレフィクス
  1895.      */
  1896.     protected function _getGatewayPrefix($gateway = null)
  1897.     {
  1898.         $gateway = is_null($gateway) ? $this->getGateway() : $gateway;
  1899.         switch ($gateway) {
  1900.         case GATEWAY_WWW:
  1901.             $prefix = '';
  1902.             break;
  1903.         case GATEWAY_CLI:
  1904.             $prefix = 'Cli';
  1905.             break;
  1906.         case GATEWAY_XMLRPC:
  1907.             $prefix = 'Xmlrpc';
  1908.             break;
  1909.         default:
  1910.             $prefix = '';
  1911.             break;
  1912.         }
  1913.  
  1914.         return $prefix;
  1915.     }
  1916.  
  1917.     /**
  1918.      *  マネージャクラス名を取得する
  1919.      *
  1920.      *  @access public
  1921.      *  @param  string  $name   マネージャキー
  1922.      *  @return string  マネージャクラス名
  1923.      */
  1924.     public function getManagerClassName($name)
  1925.     {
  1926.         //   アプリケーションIDと、渡された名前のはじめを大文字にして、
  1927.         //   組み合わせたものが返される
  1928.         $manager_id = preg_replace('/_(.)/e', "strtoupper('\$1')", ucfirst($name));
  1929.         return sprintf('%s_%sManager', $this->getAppId(), ucfirst($manager_id));
  1930.     }
  1931.  
  1932.     /**
  1933.      *  アプリケーションオブジェクトクラス名を取得する
  1934.      *
  1935.      *  @access public
  1936.      *  @param  string  $name   アプリケーションオブジェクトキー
  1937.      *  @return string  マネージャクラス名
  1938.      */
  1939.     public function getObjectClassName($name)
  1940.     {
  1941.         //  引数のはじめの一文字目と、アンダーバー直後の
  1942.         //  1文字を必ず大文字にする。アンダーバーは削除される。
  1943.         $name = preg_replace('/_(.)/e', "strtoupper('\$1')", ucfirst($name));
  1944.  
  1945.         //  $name に foo_bar を渡し、AppID が Hogeの場合
  1946.         //  [Appid]_FooBar が返される
  1947.         return sprintf('%s_%s', $this->getAppId(), $name);
  1948.     }
  1949.  
  1950.     /**
  1951.      *  アクションスクリプトをインクルードする
  1952.      *
  1953.      *  ただし、インクルードしたファイルにクラスが正しく定義されているかどうかは保証しない
  1954.      *
  1955.      *  @access private
  1956.      *  @param  array   $action_obj     アクション定義
  1957.      *  @param  string  $action_name    アクション名
  1958.      */
  1959.     protected function _includeActionScript($action_obj, $action_name)
  1960.     {
  1961.         $class_path = $form_path = null;
  1962.  
  1963.         $action_dir = $this->getActiondir();
  1964.  
  1965.         // class_path属性チェック
  1966.         if (isset($action_obj['class_path'])) {
  1967.             // フルパス指定サポート
  1968.             $tmp_path = $action_obj['class_path'];
  1969.             if (Ethna_Util::isAbsolute($tmp_path) == false) {
  1970.                 $tmp_path = $action_dir . $tmp_path;
  1971.             }
  1972.  
  1973.             if (file_exists($tmp_path) == false) {
  1974.                 $this->logger->log(LOG_WARNING, 'class_path file not found [%s] -> try default', $tmp_path);
  1975.             } else {
  1976.                 include_once $tmp_path;
  1977.                 $class_path = $tmp_path;
  1978.             }
  1979.         }
  1980.  
  1981.         // デフォルトチェック
  1982.         if (is_null($class_path)) {
  1983.             $class_path = $this->getDefaultActionPath($action_name);
  1984.             if (file_exists($action_dir . $class_path)) {
  1985.                 include_once $action_dir . $class_path;
  1986.             } else {
  1987.                 $this->logger->log(LOG_DEBUG, 'default action file not found [%s] -> try all files', $class_path);
  1988.                 return;
  1989.             }
  1990.         }
  1991.  
  1992.         // form_path属性チェック
  1993.         if (isset($action_obj['form_path'])) {
  1994.             // フルパス指定サポート
  1995.             $tmp_path = $action_obj['form_path'];
  1996.             if (Ethna_Util::isAbsolute($tmp_path) == false) {
  1997.                 $tmp_path = $action_dir . $tmp_path;
  1998.             }
  1999.  
  2000.             if ($tmp_path == $class_path) {
  2001.                 return;
  2002.             }
  2003.             if (file_exists($tmp_path) == false) {
  2004.                 $this->logger->log(LOG_WARNING, 'form_path file not found [%s] -> try default', $tmp_path);
  2005.             } else {
  2006.                 include_once $tmp_path;
  2007.                 $form_path = $tmp_path;
  2008.             }
  2009.         }
  2010.  
  2011.         // デフォルトチェック
  2012.         if (is_null($form_path)) {
  2013.             $form_path = $this->getDefaultFormPath($action_name);
  2014.             if ($form_path == $class_path) {
  2015.                 return;
  2016.             }
  2017.             if (file_exists($action_dir . $form_path)) {
  2018.                 include_once $action_dir . $form_path;
  2019.             } else {
  2020.                 $this->logger->log(LOG_DEBUG, 'default form file not found [%s] -> maybe falling back to default form class', $form_path);
  2021.             }
  2022.         }
  2023.     }
  2024.  
  2025.     /**
  2026.      *  ビュースクリプトをインクルードする
  2027.      *
  2028.      *  ただし、インクルードしたファイルにクラスが正しく定義されているかどうかは保証しない
  2029.      *
  2030.      *  @access private
  2031.      *  @param  array   $forward_obj    遷移定義
  2032.      *  @param  string  $forward_name   遷移名
  2033.      */
  2034.     protected function _includeViewScript($forward_obj, $forward_name)
  2035.     {
  2036.         $view_dir = $this->getViewdir();
  2037.  
  2038.         // view_path属性チェック
  2039.         if (isset($forward_obj['view_path'])) {
  2040.             // フルパス指定サポート
  2041.             $tmp_path = $forward_obj['view_path'];
  2042.             if (Ethna_Util::isAbsolute($tmp_path) == false) {
  2043.                 $tmp_path = $view_dir . $tmp_path;
  2044.             }
  2045.  
  2046.             if (file_exists($tmp_path) == false) {
  2047.                 $this->logger->log(LOG_WARNING, 'view_path file not found [%s] -> try default', $tmp_path);
  2048.             } else {
  2049.                 include_once $tmp_path;
  2050.                 return;
  2051.             }
  2052.         }
  2053.  
  2054.         // デフォルトチェック
  2055.         $view_path = $this->getDefaultViewPath($forward_name);
  2056.         if (file_exists($view_dir . $view_path)) {
  2057.             include_once $view_dir . $view_path;
  2058.             return;
  2059.         } else {
  2060.             $this->logger->log(LOG_DEBUG, 'default view file not found [%s]', $view_path);
  2061.             $view_path = null;
  2062.         }
  2063.     }
  2064.  
  2065.     /**
  2066.      *  ディレクトリ以下の全てのスクリプトをインクルードする
  2067.      *
  2068.      *  @access private
  2069.      */
  2070.     protected function _includeDirectory($dir)
  2071.     {
  2072.         $ext = "." . $this->ext['php'];
  2073.         $ext_len = strlen($ext);
  2074.  
  2075.         if (is_dir($dir) == false) {
  2076.             return;
  2077.         }
  2078.  
  2079.         $dh = opendir($dir);
  2080.         if ($dh) {
  2081.             while (($file = readdir($dh)) !== false) {
  2082.                 if ($file != '.' && $file != '..' && is_dir("$dir/$file")) {
  2083.                     $this->_includeDirectory("$dir/$file");
  2084.                 }
  2085.                 if (substr($file, -$ext_len, $ext_len) != $ext) {
  2086.                     continue;
  2087.                 }
  2088.                 include_once $dir . '/' . $file;
  2089.             }
  2090.         }
  2091.         closedir($dh);
  2092.     }
  2093.  
  2094.     /**
  2095.      *  設定ファイルのDSN定義から使用するデータを再構築する(スレーブアクセス分岐等)
  2096.      *
  2097.      *  DSNの定義方法(デフォルト:設定ファイル)を変えたい場合はここをオーバーライドする
  2098.      *
  2099.      *  @access protected
  2100.      *  @return array   DSN定義(array('DBキー1' => 'dsn1', 'DBキー2' => 'dsn2', ...))
  2101.      */
  2102.     protected function _prepareDSN()
  2103.     {
  2104.         $r = array();
  2105.  
  2106.         foreach ($this->db as $key => $value) {
  2107.             $config_key = "dsn";
  2108.             if ($key != "") {
  2109.                 $config_key .= "_$key";
  2110.             }
  2111.             $dsn = $this->config->get($config_key);
  2112.             if (is_array($dsn)) {
  2113.                 // 種別1つにつき複数DSNが定義されている場合はアクセス分岐
  2114.                 $dsn = $this->_selectDSN($key, $dsn);
  2115.             }
  2116.             $r[$key] = $dsn;
  2117.         }
  2118.         return $r;
  2119.     }
  2120.  
  2121.     /**
  2122.      *  DSNのアクセス分岐を行う
  2123.      *
  2124.      *  スレーブサーバへの振分け処理(デフォルト:ランダム)を変更したい場合はこのメソッドをオーバーライドする
  2125.      *
  2126.      *  @access protected
  2127.      *  @param  string  $type       DB種別
  2128.      *  @param  array   $dsn_list   DSN一覧
  2129.      *  @return string  選択されたDSN
  2130.      */
  2131.     protected function _selectDSN($type, $dsn_list)
  2132.     {
  2133.         if (is_array($dsn_list) == false) {
  2134.             return $dsn_list;
  2135.         }
  2136.  
  2137.         // デフォルト:ランダム
  2138.         list($usec, $sec) = explode(' ', microtime());
  2139.         mt_srand($sec + ((float) $usec * 100000));
  2140.         $n = mt_rand(0, count($dsn_list)-1);
  2141.  
  2142.         return $dsn_list[$n];
  2143.     }
  2144.  
  2145.     /**
  2146.      *  Ethnaマネージャを設定する
  2147.      *
  2148.      *  不要な場合は空のメソッドとしてオーバーライドしてもよい
  2149.      *
  2150.      *  @access protected
  2151.      */
  2152.     protected function _activateEthnaManager()
  2153.     {
  2154.         if ($this->config->get('debug') == false) {
  2155.             return;
  2156.         }
  2157.  
  2158.         require_once ETHNA_BASE . '/class/InfoManager.php';
  2159.  
  2160.         // action設定
  2161.         $this->action['__ethna_info__'] = array(
  2162.             'form_name' =>  'Ethna_Form_Info',
  2163.             'form_path' =>  sprintf('%s/class/Action/Info.php', ETHNA_BASE),
  2164.             'class_name' => 'Ethna_Action_Info',
  2165.             'class_path' => sprintf('%s/class/Action/Info.php', ETHNA_BASE),
  2166.         );
  2167.  
  2168.         // forward設定
  2169.         $this->forward['__ethna_info__'] = array(
  2170.             'forward_path'  => sprintf('%s/tpl/info.tpl', ETHNA_BASE),
  2171.             'view_name'     => 'Ethna_View_Info',
  2172.             'view_path'     => sprintf('%s/class/View/Info.php', ETHNA_BASE),
  2173.         );
  2174.  
  2175.         // see if we have simpletest
  2176.         if (file_exists_ex('simpletest/unit_tester.php', true)) {
  2177.         }
  2178.         require_once ETHNA_BASE . '/class/UnitTestManager.php';
  2179.         // action設定
  2180.         $this->action['__ethna_unittest__'] = array(
  2181.             'form_name' =>  'Ethna_Form_UnitTest',
  2182.             'form_path' =>  sprintf('%s/class/Action/UnitTest.php', ETHNA_BASE),
  2183.             'class_name' => 'Ethna_Action_UnitTest',
  2184.             'class_path' => sprintf('%s/class/Action/UnitTest.php', ETHNA_BASE),
  2185.         );
  2186.  
  2187.         // forward設定
  2188.         $this->forward['__ethna_unittest__'] = array(
  2189.             'forward_path'  => sprintf('%s/tpl/unittest.tpl', ETHNA_BASE),
  2190.             'view_name'     => 'Ethna_View_UnitTest',
  2191.             'view_path'     => sprintf('%s/class/View/UnitTest.php', ETHNA_BASE),
  2192.         );
  2193.     }
  2194.  
  2195.     /**
  2196.      *  Ethnaマネージャが実行可能かをチェックする
  2197.      *
  2198.      *  Ethnaマネージャを実行するよう指示されているにも関わらず、
  2199.      *  debug が trueでない場合は実行を停止する。
  2200.      *
  2201.      *  @access private
  2202.      */
  2203.     protected function _ethnaManagerEnabledCheck($action_name)
  2204.     {
  2205.         if ($this->config->get('debug') == false
  2206.             && ($action_name == '__ethna_info__' || $action_name == '__ethna_unittest__'))
  2207.         {
  2208.             $this->ethnaManagerCheckErrorMsg($action_name);
  2209.             exit(0);
  2210.         }
  2211.     }
  2212.  
  2213.     /**
  2214.      *  Ethnaマネージャが実行不能な場合のエラーメッセージを
  2215.      *  表示する。運用上の都合でこのメッセージを出力したくない
  2216.      *  場合は、このメソッドをオーバーライドせよ
  2217.      *
  2218.      *  @access protected
  2219.      */
  2220.      protected function ethnaManagerCheckErrorMsg($action_name)
  2221.      {
  2222.          $appid = strtolower($this->getAppId());
  2223.          $run_action = ($action_name == '__ethna_info__')
  2224.                      ? ' show Application Info List '
  2225.                      : ' run Unit Test ';
  2226.          echo "Ethna cannot {$run_action} under your application setting.<br>";
  2227.          echo "HINT: You must set {$appid}/etc/{$appid}-ini.php debug setting 'true'.<br>";
  2228.          echo "<br>";
  2229.          echo "In {$appid}-ini.php, please set as follows :<br><br>";
  2230.          echo "\$config = array ( 'debug' => true, );";
  2231.      }
  2232.  
  2233.     /**
  2234.      *  CLI実行中フラグを取得する
  2235.      *
  2236.      *  @access public
  2237.      *  @return bool    CLI実行中フラグ
  2238.      *  @obsolete
  2239.      */
  2240.     public function getCLI()
  2241.     {
  2242.         return $this->gateway == GATEWAY_CLI ? true : false;
  2243.     }
  2244.  
  2245.     /**
  2246.      *  CLI実行中フラグを設定する
  2247.      *
  2248.      *  @access public
  2249.      *  @param  bool    CLI実行中フラグ
  2250.      *  @obsolete
  2251.      */
  2252.     public function setCLI($cli)
  2253.     {
  2254.         $this->gateway = $cli ? GATEWAY_CLI : $this->_getDefaultGateway();
  2255.     }
  2256. }
  2257. // }}}
  2258.  
  2259. /**
  2260.  *  XMLRPCゲートウェイのスタブクラス
  2261.  *
  2262.  *  @access     public
  2263.  */
  2264. function _Ethna_XmlrpcGateway($method_stub, $param)
  2265. {
  2266.     $ctl = Ethna_Controller::getInstance();
  2267.     $method = $ctl->getXmlrpcMethodName();
  2268.     $r = $ctl->trigger_XMLRPC($method, $param);
  2269.     if (Ethna::isError($r)) {
  2270.         return array(
  2271.             'faultCode' => $r->getCode(),
  2272.             'faultString' => $r->getMessage(),
  2273.         );
  2274.     }
  2275.     return $r;
  2276. }

Documentation generated on Fri, 11 Nov 2011 03:57:54 +0900 by phpDocumentor 1.4.3