001/*
002 * Copyright (c) 2009 The openGion Project.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
013 * either express or implied. See the License for the specific language
014 * governing permissions and limitations under the License.
015 */
016package org.opengion.plugin.column;
017
018import org.opengion.fukurou.util.ErrorMessage;
019import org.opengion.hayabusa.db.AbstractDBType;
020import org.opengion.hayabusa.db.DBTypeCheckUtil;
021
022/**
023 * 半角/全角混在の一般的な制限のない半角優先文字列を扱う為の、カラム属性を定義します。
024 *
025 * DBType_ALL との違いは、valueCheck で、クロスサイトスクリプティングチェックを
026 * 行う為、'<', '>'などのデータは登録できません。
027 * DBType_KX との違いは、デフォルトで IME(仮名漢字変換)は OFF になります。
028 *
029 * タイプチェックとして、以下の条件を判定します。
030 * ・文字列長は、Byte換算での文字数との比較
031 * ・文字パラメータの 正規表現チェック
032 * ・クロスサイトスクリプティングチェック
033 *
034 * @og.group データ属性
035 *
036 * @version  4.0
037 * @author   Kazuhiko Hasegawa
038 * @since    JDK5.0,
039 */
040public class DBType_XK extends AbstractDBType {
041        /** このプログラムのVERSION文字列を設定します。   {@value} */
042        private static final String VERSION = "6.4.2.0 (2016/01/29)" ;
043
044        /**
045         * デフォルトコンストラクター
046         *
047         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
048         */
049        public DBType_XK() { super(); }         // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
050
051        /**
052         * データが登録可能かどうかをチェックします。
053         * データがエラーの場合は、そのエラー内容を返します。
054         *
055         * @og.rev 3.0.1.3 (2003/03/11) DBTypeCheckUtilクラスを利用するように修正
056         * @og.rev 3.6.0.0 (2004/09/22) dbType パラメータ(文字パラメータ)を引数に追加
057         * @og.rev 5.2.2.0 (2010/11/01) 厳密にチェック(isStrict=true)するフラグを追加
058         *
059         * @param   key         キー
060         * @param   value       値
061         * @param   sizeX       整数部分の文字列の長さ
062         * @param   sizeY       小数部分の文字列の長さ
063         * @param   typeParam   dbType パラメータ(文字パラメータ)
064         * @param   isStrict    厳密にチェックするかどうか[true:する/false:標準的]
065         *
066         * @return  エラー内容
067         * @og.rtnNotNull
068         */
069        @Override
070        public ErrorMessage valueCheck( final String key ,final String value ,
071                                                                        final int sizeX ,final int sizeY ,final String typeParam ,final boolean isStrict) {
072
073                // 6.3.9.1 (2015/11/27) Found 'DD'-anomaly for variable(PMD)
074                final ErrorMessage msg = new ErrorMessage();
075                if( value == null || value.isEmpty() ) { return msg; }
076
077                final int len = (sizeY == 0) ? sizeX : sizeX + sizeY + 1;
078                String check = DBTypeCheckUtil.byteLengthCheck( value,len );
079                if( check != null ) {
080                        // 文字列の長さが指定の長さよりも長いです。
081                        msg.addMessage( 0,ErrorMessage.NG,"ERR0006",key,value,check,String.valueOf( len ) );
082                }
083
084                // 3.6.0.0 (2004/09/22) dbType パラメータ(文字パラメータ)を使用したマッチチェック
085                check = DBTypeCheckUtil.matcheCheck( value,typeParam );
086                if( check != null ) {
087                        // 指定の文字以外の文字が使われています。
088                        msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,check );
089                }
090
091                // クロスサイトスクリプティング対策:'<', '>' は登録させない。
092                // 6.3.9.1 (2015/11/27) Found 'DD'-anomaly for variable(PMD)
093                return xssCheck( key ,value, msg );
094        }
095}