コミット: 79 - nova.ext (svn)

PHPのフレームワークです。オートローディング、ルーティング、ORマッパ、フォームバリデータ、その他ユーティリティがセットになっています。

コミットメタ情報

• リビジョン: 79 (tree)
• 日時: 2021-01-14 11:58:27
• 作者: tantancode

ログメッセージ

ParamCheckFilterの仕様を変更

変更サマリ

• modified: lib/extension/filters/ParamCheckFilter.php
• modified: nova/NovaAction.php
• modified: nova/readme.txt
• modified: sites/admin/develop/ApiView.html
• modified: sites/admin/sand/ApiAction.php
• modified: sites/admin/sand/IndexAction.php

差分

--- lib/extension/filters/ParamCheckFilter.php	(revision 78)
+++ lib/extension/filters/ParamCheckFilter.php	(revision 79)
@@ -1,54 +1,60 @@
 <?php
 
 /**
- * GET変数やPOST変数に、アクションの仕様として必要なキーが揃っているかを調べるフィルタ。
- * システムが入力する値を手早くチェックするためのもの。ユーザが入力した値をチェックしてエラー理由まで説明しなければならない用途には向いていない。
+ * GET変数やPOST変数に投入されたHTTP変数が仕様に沿ったものかを調べるフィルタ。
+ * システム的に入力された値を手早くチェックするためのもので、ユーザが入力した値をチェックしてエラー理由まで説明しなければならない用途には向いていない。
  * ルールの指定の仕方は NovaForm に準じる。入力値の補正も反映されるので注意。
+ * GET, POST の両方をチェックしなければならない場合はこのフィルタを複数セットするなどで対応できる。
  *
  * パラメータ)
- *      get     GET変数に必要なキーとルールを列挙した配列。
- *      post    同じくPOST変数に対するもの。POSTメソッドでない場合は検査されない。
+ *     vars        GET, POST のどちらを見るかを "get", "post" で指定する。省略時は GET。
+ *     rules       必要なキーとルールセットを列挙した配列。NovaForm コンストラクタの引数に準じる。
+ *     activate    起動条件。以下のいずれか。
+ *                     always   常にチェックする。
+ *                     auto     デフォルト。vars="get" なら常に。vars="post" ならPOSTメソッドのときのみ。
+ *                     get      GETメソッドのときのみ。
+ *                     post     POSTメソッドのときのみ。
  *
  * 例)
- *      GET変数に foo, bar が必要で、fooは真に評価される値でなければならず、barは空以外の値でなければならない("0"などはOK)。
- *      また、POSTメソッドの場合、POST変数 baz が数字のみで構成された値でなければならない。
+ *      POST変数に foo, bar が必要で、fooは真に評価される値でなければならず、barは正の整数でなければならない。
  *
  *          [
- *              'get' => [
+ *              'vars' => 'post',
+ *              'rules' => [
  *                  'foo' => 'nonzero',
- *                  'bar' => 'required',
+ *                  'bar' => ['required', 'type'=>'numonly'],
  *              ],
- *              'post' => [
- *                  'baz' => ['required', 'type'=>'numonly'],
- *              ],
  *          ]
  */
 class ParamCheckFilter extends NovaFilter {
 
-    protected static $defaults = array('get'=>[], 'post'=>[]);
+    protected static $defaults = array('vars'=>'get', 'activate'=>'auto', 'rules'=>[]);
 
     //-----------------------------------------------------------------------------------------------------
     protected function preExecute($action) {
 
-        // get, post の順で調べる。
-        foreach(['get', 'post'] as $method) {
+        // パラメータ activate から、どのメソッドで処理するのかを変数 $filter へ取得。
+        $filter = match($this->params['activate']) {
+            'always' => array('GET', 'POST'),
+            'auto' => ($this->params['vars'] == 'post') ? array('POST') : array('GET', 'POST'),
+            'get' => array('GET'),
+            'post' => array('POST'),
+        };
 
-            // POST変数を調べるのはPOSTメソッドのときのみ。
-            if($method == 'post'  &&  $_SERVER['REQUEST_METHOD'] != 'POST')
-                continue;
+        // そのメソッドでリクエストされていないならチェックしない。
+        if( !in_array($_SERVER['REQUEST_METHOD'], $filter) )
+            return;
 
-            // 調査対象の変数を選択する。
-            if($method == 'get')  $args = &$_GET;
-            else                  $args = &$_POST;
+        // パラメータ vars に従って、処理する変数を $vars に取得。
+        if($this->params['vars'] == 'post')  $vars = &$_POST;
+        else                                 $vars = &$_GET;
 
-            // 指定されたパラメータ名を一つずつ見ていく。
-            $needs = (array)$this->params[$method];
-            foreach($needs as $key => $rules) {
+        // パラメータ rules に従って NovaForm で処理する。検証でエラーになったら例外スロー。
+        $form = new NovaForm($this->params['rules']);
+        if( !$form->validate($vars) )
+            throw new CrackingException(sprintf("%s変数の値がルールに適合しない。\nエラー:\n%s\n与えられた値:\n%s", $this->params['vars'], print_rmin($form->errors()), print_rmin($vars)));
 
-                $error = NovaForm::execute($args[$key], $rules);
-                if($error)
-                    throw new CrackingException(sprintf('%s変数 "%s" の値が %s ルールに抵触している。', $method, $key, $error));
-            }
-        }
+        // 検証が通ったなら、ルールセットによる入力補正を適用して終了。
+        $vars = $form['value'];
     }
 }

--- nova/NovaAction.php	(revision 78)
+++ nova/NovaAction.php	(revision 79)
@@ -272,8 +272,8 @@
         $this->chain = array();
         foreach($definition as $key => $param) {
 
-            // フィルタ名の "." 以降を無視する形でクラス名を取得。
-            [$class] = explode('.', $key);
+            // フィルタ名の "#" 以降を無視する形でクラス名を取得。
+            [$class] = explode('#', $key);
 
             // フィルタ作成。
             $this->chain[$key] = new $class($this, $param);

--- nova/readme.txt	(revision 78)
+++ nova/readme.txt	(revision 79)
@@ -94,8 +94,8 @@
         // パラメータのない FooFilter と、パラメータ array('a'=>5) で初期化した BarFilter を適用する。
         array('FooFilter', 'BarFilter'=>['a'=>5]);
 
-        // 同じクラスのフィルタを複数設定したい場合は次のようにする。"." のあとは何でも良い。
-        array('BarFilter.1'=>['a'=>1], 'BarFilter.2'=>['a'=>1]);
+        // 同じクラスのフィルタを複数設定したい場合は次のようにする。"#" のあとは何でも良い。
+        array('BarFilter#1'=>['a'=>1], 'BarFilter#2'=>['a'=>1]);
 
         // 事前に設定されているフィルタにパラメータを追加するor書き換える。
         array('HogeFilter'=>['a'=>6]);

--- sites/admin/develop/ApiView.html	(revision 78)
+++ sites/admin/develop/ApiView.html	(revision 79)
@@ -2,6 +2,7 @@
 {[$title="APIテスト"]}
 
 {[block name="head"]}
+  <script src="//ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js"></script>
   <script><!--
 
     //-----------------------------------------------------------------------------------------------------

--- sites/admin/sand/ApiAction.php	(revision 78)
+++ sites/admin/sand/ApiAction.php	(revision 79)
@@ -4,13 +4,15 @@
 
     protected $filters = array(
         'ApiBehaviorFilter' => ['filter_order'=>1],
-//         'ParamCheckFilter' => ['get'=>[
-//             'stamp' => ['truthy', 'type'=>'number', 'decimals'=>3],
-//         ]],
+        // 'ParamCheckFilter' => [
+        //     'rules' => [
+        //         'foo' => ['nonzero', 'type'=>'number', 'decimals'=>3]
+        //     ],
+        // ],
     );
 
     protected function execute() {
 
-        $this->renderer['error'] = 'hi';
+        $this->renderer['hi'] = 'hi';
     }
 }

--- sites/admin/sand/IndexAction.php	(revision 78)
+++ sites/admin/sand/IndexAction.php	(revision 79)
@@ -1,27 +1,15 @@
 <?php
 
-use BitcoinPHP\BitcoinECDSA\BitcoinECDSA;
-
 class SandIndexAction extends AdminBaseAction {
 
-//     protected $filters = array(
-//         'ParamCheckFilter' => ['get'=>[
-//             'stamp' => ['truthy', 'type'=>'number', 'decimals'=>3],
-//         ]],
-//     );
+    protected $filters = [];
 
     protected function execute() {
 
-        // $r = 'sand';
+        $r = 'sand';
 
-        // var_dump($r);
-        // return 'none';
-
-        $this->renderer['validator'] = $v = new NovaValidator([
-            'item1' => ['callback'=> fn($v)=>var_export($v), '~regexp!'=>'[abc]*'],
-        ]);
-
-        $v->validate();
+        var_dump($r);
+        return 'none';
     }
 }