Source for file Ethna_UrlHandler.php

Documentation is available at Ethna_UrlHandler.php

  1. <?php
  2. // vim: foldmethod=marker tabstop=4 shiftwidth=4 autoindent
  3. /**
  4.  *  Ethna_UrlHandler.php
  5.  *
  6.  *  @author     Masaki Fujimoto <fujimoto@php.net>
  7.  *  @package    Ethna
  8.  *  @version    $Id$
  9.  */
  10.  
  11. /**
  12.  *  URLハンドラクラス
  13.  *
  14.  *  @author     Masaki Fujimoto <fujimoto@php.net>
  15.  *  @access     public
  16.  *  @package    Ethna
  17.  */
  18. class Ethna_UrlHandler
  19. {
  20.     /** @var    array   アクションマッピング */
  21.     var $action_map = array(
  22.         /*
  23.          * 'user'   => array(
  24.          *  'user_login' => array(
  25.          *      'path'          => 'login',
  26.          *      'path_regexp'   => false,
  27.          *      'path_ext'      => false,
  28.          *      'option'        => array(),
  29.          *  ),
  30.          * ),
  31.          */
  32.     );
  33.  
  34.     /**
  35.      *  Ethna_UrlHandlerクラスのコンストラクタ
  36.      *
  37.      *  @access public
  38.      */
  39.     function Ethna_UrlHandler()
  40.     {
  41.     }
  42.  
  43.     /**
  44.      *  Ethna_UrlHandlerクラスのインスタンスを取得する
  45.      *
  46.      *  $name がクラス名 ('_'を含む) の場合はそのクラスを、
  47.      *  そうでないときはプラグイン名とみなしてインスタンスを返す
  48.      *
  49.      *  @access public
  50.      */
  51.     function &getInstance($name = null)
  52.     {
  53.         static $instance = array();
  54.         if ($name === null) {
  55.             $name = __CLASS__;
  56.         }
  57.         if (isset($instance[$name])) {
  58.             return $instance[$name];
  59.         }
  60.  
  61.         if (strpos($name, '_') !== false) {
  62.             $instance[$name] = &new $name();
  63.         } else {
  64.             // get instance with plugin
  65.             $ctl = &Ethna_Controller::getInstance();
  66.             $plugin = &$ctl->getPlugin();
  67.             $instance[$name] = &$plugin->getPlugin('Urlhandler', $name);
  68.         }
  69.  
  70.         return $instance[$name];
  71.     }
  72.  
  73.     /**
  74.      *  アクションをユーザリクエストに変換する
  75.      *
  76.      *  @access public
  77.      */
  78.     function actionToRequest($action, $param)
  79.     {
  80.         $url_handler = null;
  81.         $action_value = null;
  82.         foreach ($this->action_map as $key => $value) {
  83.             if (isset($value[$action])) {
  84.                 $url_handler = $key;
  85.                 $action_value = $value[$action];
  86.                 break;
  87.             }
  88.         }
  89.         if (is_null($url_handler)) {
  90.             return null;
  91.         }
  92.  
  93.         // url_handler specific path
  94.         $method = sprintf("_getPath_%s", ucfirst($url_handler));
  95.         if (method_exists($this, $method) === false) {
  96.             return null;
  97.         }
  98.         list($path, $path_key) = $this->$method($action, $param);
  99.         if ($path == "") {
  100.             return null;
  101.         }
  102.  
  103.         // append action path
  104.         if ($action_value['path']) {
  105.             $path .= "/" . $action_value['path'];
  106.         }
  107.  
  108.         // path_ext candidate list
  109.         if (is_array($action_value['path_regexp'])) {
  110.             // try most matcher
  111.             $tmp = array_map('count', $action_value['path_ext']);
  112.             arsort($tmp);
  113.             $path_ext_list_indices = array_keys($tmp);
  114.             $path_ext_list = $action_value['path_ext'];
  115.         } else {
  116.             $path_ext_list_indices = array(0);
  117.             $path_ext_list = array(0 => $action_value['path_ext']);
  118.         }
  119.  
  120.         // fix path_ext to use
  121.         foreach ($path_ext_list_indices as $index) {
  122.             if (is_array($path_ext_list[$index]) === false) {
  123.                 // no parameters needed.
  124.                 $path_ext = $path_ext_list[$index];
  125.                 break;
  126.             }
  127.             $path_ext_match = true;
  128.             foreach ($path_ext_list[$index] as $key => $value) {
  129.                 if (isset($param[$key]) === false) {
  130.                     $path_ext_match = false;
  131.                     break;
  132.                 }
  133.             }
  134.             if ($path_ext_match) {
  135.                 $path_ext = $path_ext_list[$index];
  136.                 break;
  137.             }
  138.         }
  139.         if (isset($path_ext) === false) {
  140.             return null;
  141.         }
  142.  
  143.         // append extra parameters to path.
  144.         if (is_array($path_ext)) {
  145.             foreach ($path_ext as $key => $value) {
  146.                 $path_key[] = $key;
  147.                 $ext_param = $param[$key];
  148.  
  149.                 // output filter
  150.                 if (isset($value['output_filter']) && $value['output_filter'] != "") {
  151.                     $method = $value['output_filter'];
  152.                     if (method_exists($this, $method)) {
  153.                         $ext_param = $this->$method($ext_param);
  154.                     }
  155.                 }
  156.  
  157.                 // remove form (pre|suf)fix
  158.                 if (isset($value['form_prefix']) && $value['form_prefix'] != "") {
  159.                     $s = $value['form_prefix'];
  160.                     if (substr($ext_param, 0, strlen($s)) == $s) {
  161.                         $ext_param = substr($ext_param, strlen($s));
  162.                     }
  163.                 }
  164.                 if (isset($value['form_suffix']) && $value['form_suffix'] != "") {
  165.                     $s = $value['form_suffix'];
  166.                     if (substr($ext_param, -strlen($s)) == $s) {
  167.                         $ext_param = substr($ext_param, 0, -strlen($s));
  168.                     }
  169.                 }
  170.  
  171.                 // rawurlencode (url (pre|suf)fixes need not to be encoded.)
  172.                 $ext_param = rawurlencode($ext_param);
  173.  
  174.                 // add url (pre|suf)fix
  175.                 if (isset($value['url_prefix']) && $value['url_prefix'] != "") {
  176.                     $ext_param = $value['url_prefix'] . $ext_param;
  177.                 }
  178.                 if (isset($value['url_suffix']) && $value['url_suffix'] != "") {
  179.                     $ext_param = $ext_param . $value['url_suffix'];
  180.                 }
  181.  
  182.                 $path .= '/' . $ext_param;
  183.             }
  184.         }
  185.  
  186.         list($path, $is_slash) = $this->_normalizePath($path);
  187.         return array($path, $path_key);
  188.     }
  189.  
  190.     /**
  191.      *  ユーザリクエストをアクションに変換する
  192.      *
  193.      *  @access public
  194.      */
  195.     function requestToAction($http_vars)
  196.     {
  197.         if (isset($http_vars['__url_handler__']) == false
  198.             || isset($this->action_map[$http_vars['__url_handler__']]) == false) {
  199.             return array();
  200.         }
  201.  
  202.         $url_handler = $http_vars['__url_handler__'];
  203.         $action_map = $this->action_map[$url_handler];
  204.  
  205.         // parameter fix
  206.         $method = sprintf("_normalizeRequest_%s", ucfirst($url_handler));
  207.         if (method_exists($this, $method)) {
  208.             $http_vars = $this->$method($http_vars);
  209.         }
  210.  
  211.         // normalize
  212.         if (isset($http_vars['__url_info__'])) {
  213.             $path = $http_vars['__url_info__'];
  214.         } else {
  215.             $path = "";
  216.         }
  217.         list($path, $is_slash) = $this->_normalizePath($path);
  218.  
  219.         // match
  220.         $action = null;
  221.         $action_value = null;
  222.         $action_match = null;
  223.         $action_regexp_index = null;
  224.         foreach ($action_map as $key => $value) {
  225.             $match_length = strlen($value['path']);
  226.  
  227.             // check necessary match
  228.             if (strncmp($path, $value['path'], $match_length) != 0) {
  229.                 continue;
  230.             }
  231.  
  232.             // try exact match
  233.             if ($path == $value['path']) {
  234.                 $action = $key;
  235.                 break;
  236.             }
  237.  
  238.             // continue in case w/ incomplete match
  239.             if ($path != "" && $match_length > 0 && $path{$match_length} != "/") {
  240.                 continue;
  241.             }
  242.             if ($is_slash && $path{strlen($path)-1} == "/") {
  243.                 continue;
  244.             }
  245.  
  246.             // try regexp
  247.             if ($value['path_regexp']) {
  248.                 if (is_array($value['path_regexp'])) {
  249.                     foreach ($value['path_regexp'] as $index => $regexp) {
  250.                         if (preg_match($regexp, $path, $tmp)) {
  251.                             $action = $key;
  252.                             $action_match = $tmp;
  253.                             $action_regexp_index = $index;
  254.                             break;
  255.                         }
  256.                     }
  257.                 } else {
  258.                     if (preg_match($value['path_regexp'], $path, $tmp)) {
  259.                         $action = $key;
  260.                         $action_match = $tmp;
  261.                         break;
  262.                     }
  263.                 }
  264.             }
  265.         }
  266.         if (is_null($action)) {
  267.             return array();
  268.         }
  269.         $action_value = $action_map[$action];
  270.  
  271.         // build parameters
  272.         $http_vars = $this->buildActionParameter($http_vars, $action);
  273.  
  274.         // extra parameters
  275.         $path_ext = is_null($action_regexp_index)
  276.                     ? $action_value['path_ext']
  277.                     : $action_value['path_ext'][$action_regexp_index];
  278.         if (is_array($path_ext) && is_array($action_match)) {
  279.             $n = 1;
  280.             foreach ($path_ext as $key => $value) {
  281.                 if (isset($action_match[$n]) == false) {
  282.                     break;
  283.                 }
  284.  
  285.                 // remove url (pre|suf)fix
  286.                 if (isset($value['url_prefix']) && $value['url_prefix'] != "") {
  287.                     $s = $value['url_prefix'];
  288.                     if (substr($action_match[$n], 0, strlen($s)) == $s) {
  289.                         $action_match[$n] = substr($action_match[$n], strlen($s));
  290.                     }
  291.                 }
  292.                 if (isset($value['url_suffix']) && $value['url_suffix'] != "") {
  293.                     $s = $value['url_suffix'];
  294.                     if (substr($action_match[$n], -strlen($s)) == $s) {
  295.                         $action_match[$n] = substr($action_match[$n], 0, -strlen($s));
  296.                     }
  297.                 }
  298.  
  299.                 // add form (pre|suf)fix
  300.                 if (isset($value['form_prefix']) && $value['form_prefix'] != "") {
  301.                     $action_match[$n] = $value['form_prefix'] . $action_match[$n];
  302.                 }
  303.                 if (isset($value['form_suffix']) && $value['form_suffix'] != "") {
  304.                     $action_match[$n] = $action_match[$n] . $value['form_suffix'];
  305.                 }
  306.  
  307.                 // input filter
  308.                 if (isset($value['input_filter']) && $value['input_filter'] != "") {
  309.                     $method = $value['input_filter'];
  310.                     if (method_exists($this, $method)) {
  311.                         $action_match[$n] = $this->$method($action_match[$n]);
  312.                     }
  313.                 }
  314.  
  315.                 $http_vars[$key] = $action_match[$n];
  316.                 $n++;
  317.             }
  318.         }
  319.  
  320.         return $http_vars;
  321.     }
  322.  
  323.     /**
  324.      *  ゲートウェイパスを正規化する
  325.      *
  326.      *  @access private
  327.      */
  328.     function _normalizePath($path)
  329.     {
  330.         if ($path == "") {
  331.             return array($path, false);
  332.         }
  333.  
  334.         $is_slash = false;
  335.         $path = preg_replace('|/+|', '/', $path);
  336.  
  337.         if ($path{0} == '/') {
  338.             $path = substr($path, 1);
  339.         }
  340.         if ($path{strlen($path)-1} == '/') {
  341.             $path = substr($path, 0, strlen($path)-1);
  342.             $is_slash = true;
  343.         }
  344.  
  345.         return array($path, $is_slash);
  346.     }
  347.  
  348.     /**
  349.      *  アクションをリクエストパラメータに変換する
  350.      *
  351.      *  @access public
  352.      */
  353.     function buildActionParameter($http_vars, $action)
  354.     {
  355.         if ($action == "") {
  356.             return $http_vars;
  357.         }
  358.         $key = sprintf('action_%s', $action);
  359.         $http_vars[$key] = 'true';
  360.         return $http_vars;
  361.     }
  362.  
  363.     /**
  364.      *  パラメータをURLに変換する
  365.      *
  366.      *  @access public
  367.      */
  368.     function buildQueryParameter($query)
  369.     {
  370.         $param = '';
  371.  
  372.         foreach ($query as $key => $value) {
  373.             if (is_array($value)) {
  374.                 foreach ($value as $k => $v) {
  375.                     if (is_numeric($k)) {
  376.                         $k = '';
  377.                     }
  378.                     $param .= sprintf('%s=%s&',
  379.                                       urlencode(sprintf('%s[%s]', $key, $k)),
  380.                                       urlencode($v));
  381.                 }
  382.             } else if (is_null($value) == false) {
  383.                 $param .= sprintf('%s=%s&', urlencode($key), urlencode($value));
  384.             }
  385.         }
  386.  
  387.         return substr($param, 0, -1);
  388.     }
  389.  
  390.     // {{{ ゲートウェイリクエスト正規化
  391.     // }}}
  392.  
  393.     // {{{ ゲートウェイパス生成
  394.     // }}}
  395.  
  396.     // {{{ フィルタ
  397.     // }}}
  398. }
  399.  
  400. ?>

Documentation generated on Fri, 11 Nov 2011 04:01:02 +0900 by phpDocumentor 1.4.3