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.fukurou.util.StringUtil;
020import org.opengion.fukurou.util.KanaFilter;
021import org.opengion.hayabusa.db.AbstractDBType;
022import org.opengion.hayabusa.db.DBTypeCheckUtil;
023
024/**
025 * 半角/全角混在のクラスですが、半角カタカナのみを通さない文字列を扱う為の、カラム属性を定義します。
026 *
027 * 半角カタカナの定義は、\uFF61 から \uFF9F までです。
028 * 半角カタカナを入力すると、全角カタカナに変換して、登録しています。
029 * この変換処理に、KanaFilter#han2zen を使用しています。これは、
030 * 『CJKV日中韓越情報処理』のフィルターアルゴリズムで濁点や半濁点の正しい処理も含まれています。
031 *
032 * タイプチェックとして、以下の条件を判定します。
033 * ・文字列長は、Byte換算での文字数との比較
034 * ・半角文字+全角カタカナチェック「c < 0x20 || ( c >= 0xff61 && c <= 0xff9f )以外」エラー
035 * ・文字パラメータの 正規表現チェック
036 * ・クロスサイトスクリプティングチェック
037 *
038 * @og.rev 3.4.0.0 (2003/09/01) 新規作成
039 * @og.group データ属性
040 *
041 * @version  4.0
042 * @author   Kazuhiko Hasegawa
043 * @since    JDK5.0,
044 */
045public class DBType_XKZ extends AbstractDBType {
046        //* このプログラムのVERSION文字列を設定します。   {@value} */
047        private static final String VERSION = "5.2.2.0 (2010/11/01)" ;
048
049        /**
050         * エディターで編集されたデータを登録する場合に、データそのものを
051         * 変換して、実登録データを作成します。
052         * 例えば,大文字のみのフィールドなら、大文字化します。
053         * 実登録データの作成は、DBType オブジェクトを利用しますので,
054         * これと Editor とがアンマッチの場合は、うまくデータ変換
055         * されない可能性がありますので、注意願います。
056         *
057         * @param       value   (一般に編集データとして登録されたデータ)
058         *
059         * @return  修正後の文字列(一般にデータベースに登録するデータ)
060         */
061        @Override
062        public String valueSet( final String value ) {
063                if( value == null ) { return null; }
064                return KanaFilter.han2zen( StringUtil.rTrim( value ) );
065        }
066
067        /**
068         * データが登録可能かどうかをチェックします。
069         * データがエラーの場合は、そのエラー内容を返します。
070         *
071         * @og.rev 3.6.0.0 (2004/09/22) dbType パラメータを引数に追加
072         * @og.rev 5.2.2.0 (2010/11/01) 厳密にチェック(isStrict=true)するフラグを追加
073         *
074         * @param   key         キー
075         * @param   value       値
076         * @param   sizeX       整数部分の文字列の長さ
077         * @param   sizeY       少数部分の文字列の長さ
078         * @param   typeParam   dbType パラメータ
079         * @param   isStrict    厳密にチェックするかどうか[true:する/false:標準的]
080         *
081         * @return  エラー内容
082         */
083        @Override
084        public ErrorMessage valueCheck( final String key ,final String value ,
085                                                                        final int sizeX ,final int sizeY ,final String typeParam ,final boolean isStrict) {
086
087                ErrorMessage msg = new ErrorMessage();
088                if( value == null || value.length() == 0 ) { return msg; }
089
090                int len = (sizeY == 0) ? sizeX : sizeX + sizeY + 1;
091                String check = DBTypeCheckUtil.byteLengthCheck( value,len );
092                if( check != null ) {
093                        // 文字列の長さが指定の長さよりも長いです。
094                        msg.addMessage( 0,ErrorMessage.NG,"ERR0006",key,value,check,String.valueOf( len ) );
095                }
096
097                StringBuilder val = new StringBuilder();
098                boolean isError = false;
099                for( int i=0; i<value.length(); i++ ) {
100                        char ch = value.charAt( i );
101                        if( ch < 0x20 || ( ch >= 0xff61 && ch <= 0xff9f ) ) {
102                                val.append( "<span class=\"NG\">" ).append( ch ).append( "</span>" );
103                                isError = true;
104                        }
105                        else {
106                                val.append( ch );
107                        }
108                }
109                if( isError ) {
110                        // 指定の文字以外の文字が使われています。
111                        msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,val.toString() );
112                }
113
114                // 3.6.0.0 (2004/09/22) dbType パラメータを使用したマッチチェック
115                check = DBTypeCheckUtil.matcheCheck( value,typeParam );
116                if( check != null ) {
117                        // 指定の文字以外の文字が使われています。
118                        msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,check );
119                }
120
121                // クロスサイトスクリプティング対策:'<', '>' は登録させない。
122                msg = xssCheck( key ,value, msg );
123
124                return msg;
125        }
126}