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.hayabusa.db.AbstractDBType;
021import org.opengion.hayabusa.db.DBTypeCheckUtil;
022
023import java.util.Locale ;
024
025/**
026 * 半角大文字の英数字の文字列を扱う為の、カラム属性を定義します。
027 *
028 * 入力文字列は、trim された後、大文字化(toUpperCase)された後、タイプチェックされます。
029 * 半角カタカナは半角大文字に分類されない為、対象外(使用できない)です。
030 *
031 * タイプチェックとして、以下の条件を判定します。
032 * ・文字列長は、Byte換算での文字数との比較
033 * ・半角大文字チェック「c < 0x20 || c > 0x7e || ( 'a' <= c && c <= 'z' )以外」エラー
034 * ・文字パラメータの 正規表現チェック
035 * ・クロスサイトスクリプティングチェック
036 *
037 * @og.group データ属性
038 *
039 * @version  4.0
040 * @author   Kazuhiko Hasegawa
041 * @since    JDK5.0,
042 */
043public class DBType_XU extends AbstractDBType {
044        //* このプログラムのVERSION文字列を設定します。   {@value} */
045        private static final String VERSION = "5.2.2.0 (2010/11/01)" ;
046
047        /**
048         * 半角0文字の固定長でFILL埋めされた文字列を返します。
049         * なお、エラーチェックは行われません。
050         * 実行前に、必ず valueCheck( String value ,int len ) が行われる必要があります。
051         *
052         * @og.rev 3.5.4.5 (2004/01/23) エンコード指定に変更します。
053         *
054         * @param   value    FILL埋めする文字列
055         * @param   sizeX    整数部分の文字列の長さ
056         * @param   sizeY    少数部分の文字列の長さ
057         * @param   encode   固定長で変換する文字エンコード
058         *
059         * @return  FILL埋めした新しい文字列
060         */
061        @Override
062        public String valueFill( final String value ,final int sizeX ,final int sizeY,final String encode ) {
063                int len = (sizeY == 0) ? sizeX : sizeX + sizeY + 1;
064
065                return StringUtil.stringXFill( value,len );
066        }
067
068        /**
069         * エディターで編集されたデータを登録する場合に、データそのものを
070         * 変換して、実登録データを作成します。
071         * 例えば,大文字のみのフィールドなら、大文字化します。
072         * 実登録データの作成は、DBType オブジェクトを利用しますので,
073         * これと Editor とがアンマッチの場合は、うまくデータ変換
074         * されない可能性がありますので、注意願います。
075         *
076         * @og.rev 3.3.3.0 (2003/07/09) 前後のスペースを取り除いておく。
077         * @og.rev 3.3.3.1 (2003/07/18) 後ろスペースを取り除く。(StringUtil#rTrim)
078         *
079         * @param       value   (一般に編集データとして登録されたデータ)
080         *
081         * @return  修正後の文字列(一般にデータベースに登録するデータ)
082         */
083        @Override
084        public String valueSet( final String value ) {
085                if( value != null ) { return (StringUtil.rTrim( value )).toUpperCase(Locale.JAPAN); }
086                else                { return null; }
087        }
088
089        /**
090         * データが登録可能かどうかをチェックします。
091         * データがエラーの場合は、そのエラー内容を返します。
092         *
093         * @og.rev 3.6.0.0 (2004/09/22) dbType パラメータを引数に追加
094         * @og.rev 5.2.2.0 (2010/11/01) 厳密にチェック(isStrict=true)するフラグを追加
095         *
096         * @param   key         キー
097         * @param   value       値
098         * @param   sizeX       整数部分の文字列の長さ
099         * @param   sizeY       少数部分の文字列の長さ
100         * @param   typeParam   dbType パラメータ
101         * @param   isStrict    厳密にチェックするかどうか[true:する/false:標準的]
102         *
103         * @return  エラー内容
104         */
105//      public ErrorMessage valueCheck( final String key ,final String value ,
106//                                                                      final int sizeX ,final int sizeY ,final String param ) {
107        @Override
108        public ErrorMessage valueCheck( final String key ,final String value ,
109                                                                        final int sizeX ,final int sizeY ,final String typeParam ,final boolean isStrict) {
110
111                ErrorMessage msg = new ErrorMessage();
112                if( value == null || value.length() == 0 ) { return msg; }
113
114                int len = (sizeY == 0) ? sizeX : sizeX + sizeY + 1;
115                if( value.length() > len ) {
116                        // 文字列の長さが指定の長さよりも長いです。
117                        msg.addMessage( 0,ErrorMessage.NG,"ERR0006", key,value, String.valueOf( value.length() ), String.valueOf( len ) );
118                }
119
120                StringBuilder val = new StringBuilder();
121                boolean isError = false;
122                for( int i=0; i<value.length(); i++ ) {
123                        char ch = value.charAt( i );
124                        if( ch < 0x20 || ch > 0x7e || ( 'a' <= ch && ch <= 'z' ) ) {
125                                val.append( "<span class=\"NG\">" ).append( ch ).append( "</span>" );
126                                isError = true;
127                        }
128                        else {
129                                val.append( ch );
130                        }
131                }
132                if( isError ) {
133                        // 指定の文字以外の文字が使われています。
134                        msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,val.toString() );
135                }
136
137                // 3.6.0.0 (2004/09/22) dbType パラメータを使用したマッチチェック
138                String check = DBTypeCheckUtil.matcheCheck( value,typeParam );
139                if( check != null ) {
140                        // 指定の文字以外の文字が使われています。
141                        msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,check );
142                }
143
144                // クロスサイトスクリプティング対策:'<', '>' は登録させない。
145                msg = xssCheck( key ,value, msg );
146                return msg;
147        }
148}