    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.fukurou.util;
    017
    018import org.opengion.fukurou.system.OgRuntimeException ;         // 6.4.2.0 (2016/01/29)
    019import java.awt.Component;
    020import java.awt.Graphics;
    021import java.awt.image.BufferedImage;
    022import java.io.File;
    023import java.io.IOException;
    024import javax.imageio.ImageIO;
    025
    026import com.swetake.util.Qrcode;
    027
    028import org.opengion.fukurou.system.HybsConst;                                           // fukurou.util.StringUtil → fukurou.system.HybsConst に変更
    029import org.opengion.fukurou.system.LogWriter;                                           // 6.4.2.0 (2016/01/29) package変更 fukurou.util → fukurou.system
    030
    031/**
    032 * QrcodeImage は、３次元バーコードの QRコードイメージを生成する
    033 * 独立したコンポーネントです。
    034 * ここでの使い方は、初期化時に、エンコードする文字列(120Byte以内)と、
    035 * 出力ファイル名を指定して、Graphics に描画したQRコードイメージを
    036 * JPEG 変換し、指定のファイルに上書き保存しています。
    037 * QRコード作成に、http://www.swetake.com/ の Qrcode クラスを使用しています。
    038 * これが、2004/11/7  ver.0.50beta9 とのことなので、動作チェック、および、
    039 * 製品としての保証という意味では、まだ使えるレベルではありませんが、
    040 * コード計算さえバグっていなければ使えうる為、試験的導入致します。
    041 *
    042 * @version  4.0
    043 * @author   Kazuhiko Hasegawa
    044 * @since    JDK5.0,
    045 */
    046public class QrcodeImage extends Component {
    047        /** このプログラムのVERSION文字列を設定します。   {@value} */
    048        private static final String VERSION = "6.4.2.0 (2016/01/29)" ;
    049        private static final long serialVersionUID = 642020160129L ;
    050
    051        // version  0 ～ 39 => 1 ～ 40
    052        // errCo    H,M    0:H 1:M
    053        // encMd    N,A,B  0:N 1:A 2:B
    054        private static final int[][][] QC_DATA = new int[][][] {
    055                {{   17 ,   10 ,   4 } , {   34 ,   20 ,    8 }} ,
    056                {{   34 ,   20 ,   8 } , {   63 ,   38 ,   16 }} ,
    057                {{   58 ,   35 ,  15 } , {  101 ,   61 ,   26 }} ,
    058                {{   82 ,   50 ,  21 } , {  149 ,   90 ,   38 }} ,
    059                {{  106 ,   64 ,  27 } , {  202 ,  122 ,   52 }} ,
    060                {{  139 ,   84 ,  36 } , {  255 ,  154 ,   65 }} ,
    061                {{  154 ,   93 ,  39 } , {  293 ,  178 ,   75 }} ,
    062                {{  202 ,  122 ,  52 } , {  365 ,  221 ,   93 }} ,
    063                {{  235 ,  143 ,  60 } , {  432 ,  262 ,  111 }} ,
    064                {{  288 ,  174 ,  74 } , {  513 ,  311 ,  131 }} ,
    065                {{  331 ,  200 ,  85 } , {  604 ,  366 ,  155 }} ,
    066                {{  374 ,  227 ,  96 } , {  691 ,  419 ,  177 }} ,
    067                {{  427 ,  259 , 109 } , {  796 ,  483 ,  204 }} ,
    068                {{  468 ,  283 , 120 } , {  871 ,  528 ,  223 }} ,
    069                {{  530 ,  321 , 136 } , {  991 ,  600 ,  254 }} ,
    070                {{  602 ,  365 , 154 } , { 1082 ,  656 ,  277 }} ,
    071                {{  674 ,  408 , 173 } , { 1212 ,  734 ,  310 }} ,
    072                {{  746 ,  452 , 191 } , { 1346 ,  816 ,  345 }} ,
    073                {{  813 ,  493 , 208 } , { 1500 ,  909 ,  384 }} ,
    074                {{  919 ,  557 , 235 } , { 1600 ,  970 ,  410 }} ,
    075                {{  969 ,  587 , 248 } , { 1708 , 1035 ,  438 }} ,
    076                {{ 1056 ,  640 , 270 } , { 1872 , 1134 ,  480 }} ,
    077                {{ 1108 ,  672 , 284 } , { 2059 , 1248 ,  528 }} ,
    078                {{ 1228 ,  744 , 315 } , { 2188 , 1326 ,  561 }} ,
    079                {{ 1286 ,  779 , 330 } , { 2395 , 1451 ,  614 }} ,
    080                {{ 1425 ,  864 , 365 } , { 2544 , 1542 ,  652 }} ,
    081                {{ 1501 ,  910 , 385 } , { 2701 , 1637 ,  692 }} ,
    082                {{ 1581 ,  958 , 405 } , { 2857 , 1732 ,  732 }} ,
    083                {{ 1677 , 1016 , 430 } , { 3035 , 1839 ,  778 }} ,
    084                {{ 1782 , 1080 , 457 } , { 3289 , 1994 ,  843 }} ,
    085                {{ 1897 , 1150 , 486 } , { 3486 , 2113 ,  894 }} ,
    086                {{ 2022 , 1226 , 518 } , { 3693 , 2238 ,  947 }} ,
    087                {{ 2157 , 1307 , 553 } , { 3909 , 2369 , 1002 }} ,
    088                {{ 2301 , 1394 , 590 } , { 4134 , 2506 , 1060 }} ,
    089                {{ 2361 , 1431 , 605 } , { 4343 , 2632 , 1113 }} ,
    090                {{ 2524 , 1530 , 647 } , { 4588 , 2780 , 1176 }} ,
    091                {{ 2625 , 1591 , 673 } , { 4775 , 2894 , 1224 }} ,
    092                {{ 2735 , 1658 , 701 } , { 5039 , 3054 , 1292 }} ,
    093                {{ 2927 , 1774 , 750 } , { 5313 , 3220 , 1362 }} ,
    094                {{ 3057 , 1852 , 784 } , { 5596 , 3391 , 1435 }} } ;
    095
    096        /** エラー訂正レベル ('L','M','Q','H')  H とM のみサポート     */
    097        public static enum ErrCrct {
    098                                        H(0),M(1);
    099                                        private int no;
    100                                        public static final ErrCrct DEF = M;
    101                                        /**
    102                                         * enum コンストラクター
    103                                         *
    104                                         * @param       no  番号
    105                                         */
    106                                        ErrCrct( final int no ) { this.no = no; }
    107                                        /**
    108                                         * 番号を取得します。
    109                                         *
    110                                         * @return      番号
    111                                         */
    112                                        public int getNo() { return no; }
    113                                        /**
    114                                         * チャネルを取得します。
    115                                         *
    116                                         * @return      チャネルキャラクタ
    117                                         */
    118                                        public char getCh() {
    119                                                final char ch ;
    120                                                switch(this) {
    121                                                        case H:  ch = 'H'; break;
    122                                                        case M:
    123                                                        default: ch = 'M'; break;
    124                                                }
    125                                                return ch ;
    126                                        }
    127                                        /**
    128                                         * チャネルに応じたエラー訂正を取得します。
    129                                         *
    130                                         * @param       ch      チャネルキャラクタ
    131                                         * @return      エラー訂正
    132                                         */
    133                                        public static ErrCrct get( final char ch ) {
    134                                                final ErrCrct rtn ;
    135                                                switch(ch) {
    136                                                        case 'H': rtn = H; break;
    137                                                        case 'M':
    138                                                        default:  rtn = M; break;
    139                                                }
    140                                                return rtn ;
    141                                        }
    142        };
    143
    144        /** エンコードモード ('N':数字モード 'A':英数字モード　'B':8bit byteモード) */
    145        public static enum EncMode {
    146                                        N(0),A(1),B(1);
    147                                        private int no;
    148                                        public static final EncMode DEF = B;
    149
    150                                        /**
    151                                         * エンコードモード enum を構築するコンストラクタ
    152                                         *
    153                                         * @param       エンコードモードの番号
    154                                         */
    155                                        EncMode( final int no ) { this.no = no; }
    156
    157                                        /**
    158                                         * エンコードモードの番号を返します。
    159                                         * 'N'=0:数字モード
    160                                         * 'A'=1:英数字モード
    161                                         * 'B'=1:8bit byteモード
    162                                         *
    163                                         * @return      エンコードモードの番号
    164                                         */
    165                                        public int getNo() { return no; }
    166
    167                                        /**
    168                                         * エンコードモードを表す文字
    169                                         * 'N':数字モード
    170                                         * 'A':英数字モード
    171                                         * 'B':8bit byteモード
    172                                         *
    173                                         * @return      エンコードモードを指定する文字('N':数字モード 'A':英数字モード　'B':8bit byteモード)
    174                                         */
    175                                        public char getCh() {
    176                                                final char ch ;
    177                                                switch(this) {
    178                                                        case N:  ch = 'N'; break;
    179                                                        case A:  ch = 'A'; break;
    180                                                        case B:
    181                                                        default: ch = 'B'; break;
    182                                                }
    183                                                return ch ;
    184                                        }
    185
    186                                        /**
    187                                         * エンコードモードを指定する文字から、エンコードモード enum を作成します。
    188                                         * 'N':数字モード
    189                                         * 'A':英数字モード
    190                                         * 'B':8bit byteモード
    191                                         *
    192                                         * @param       ch      エンコードモードを指定する文字
    193                                         * @return      エンコードモード
    194                                         */
    195                                        public static EncMode get( final char ch ) {
    196                                                final EncMode rtn ;
    197                                                switch(ch) {
    198                                                        case 'N': rtn = N; break;
    199                                                        case 'A': rtn = A; break;
    200                                                        case 'B':
    201                                                        default:  rtn = B; break;
    202                                                }
    203                                                return rtn ;
    204                                        }
    205        };
    206
    207        /** バージョン (1から40の整数。0を設定すると自動設定になります。) 初期値:{@value}     */
    208        public static final int DEF_VERSION = 5;                // 5.7.1.1 (2013/12/13) VERSION チェックのために、IDを変更します。
    209
    210        /** セルのマージン 初期値:{@value}        */
    211        public static final int MARGIN = 4;
    212
    213        /** １セル辺りの塗りつぶしピクセル 初期値:{@value}        */
    214        public static final int PIXEL = 3;
    215
    216        /** 出力イメージのタイプ(PNG/JPEG) 初期値:{@value}   */
    217        public static final String IMAGE_TYPE = "PNG";
    218
    219        private String qrData;
    220        private String saveFile;
    221        private String imgType  = IMAGE_TYPE ;
    222        private ErrCrct errCo   = ErrCrct.DEF ;
    223        private EncMode encMd   = EncMode.DEF ;
    224        private int             version = DEF_VERSION ;                 // 5.7.1.1 (2013/12/13) VERSION チェックのために、IDを変更します。
    225        private int             pixel   = PIXEL ;
    226
    227        private int imageSize ;
    228
    229        /**
    230         * 初期化メソッド
    231         *
    232         * エラー訂正レベル:M , マージン:4(セル分) , 塗りつぶしピクセル:3
    233         * エンコードモード:B(バイナリ) 、バージョン:5 , イメージのタイプ:PNG
    234         * に初期化されます。
    235         *
    236         * @og.rev 5.7.1.1 (2013/12/13) VERSION チェックのために、VERSION ⇒ DEF_VERSION に変更します。
    237         *
    238         * @param   qrData  エンコードする文字列(120Byte 以内)
    239         * @param   saveFile 出力ファイル名
    240         */
    241        public void init( final String qrData,final String saveFile ) {
    242                init( qrData,saveFile,DEF_VERSION,EncMode.DEF,ErrCrct.DEF,IMAGE_TYPE,PIXEL );   // 5.7.1.1 (2013/12/13)
    243        }
    244
    245        /**
    246         * 初期化メソッド
    247         *
    248         * エラー訂正レベル:M , マージン:4(セル分) , 塗りつぶしピクセル:3
    249         * イメージのタイプ:PNG に初期化されます。
    250         *
    251         * @param   qrData   エンコードする文字列(120Byte 以内)
    252         * @param   saveFile 出力ファイル名
    253         * @param   version  バージョン (1から40の整数。0を設定すると自動設定になります。)
    254         * @param   encMd    エンコードモード ('N':数字モード 'A':英数字モード　'B':8bit byteモード)
    255         */
    256        public void init( final String qrData,final String saveFile,final int version,final EncMode encMd ) {
    257                init( qrData,saveFile,version,encMd,ErrCrct.DEF,IMAGE_TYPE,PIXEL );
    258        }
    259
    260        /**
    261         * 初期化メソッド。
    262         *
    263         * エラー訂正レベル:M , マージン:4(セル分) , 塗りつぶしピクセル:3
    264         *
    265         * @param   qrData   エンコードする文字列(120Byte 以内)
    266         * @param   saveFile 出力ファイル名
    267         * @param   version  バージョン (1から40の整数。0を設定すると自動設定になります。)
    268         * @param   encMd    エンコードモード('N':数字モード 'A':英数字モード　'B':8bit byteモード)
    269         * @param   errCo    エラー訂正レベル ('L','M','Q','H')
    270         * @param   imgType  イメージファイル形式(PNG/JPEG)
    271         * @param   pixel    １セル辺りの塗りつぶしピクセル
    272         */
    273        public void init( final String qrData,final String saveFile,final int version,final EncMode encMd,
    274                                                final ErrCrct errCo ,final String imgType,final int pixel ) {
    275
    276                this.qrData   = qrData;
    277                this.saveFile = saveFile;
    278                this.imgType  = imgType;
    279                this.errCo    = errCo;
    280                this.encMd    = encMd;
    281                this.version  = version;
    282                this.pixel    = pixel;
    283
    284                imageSize = ( MARGIN*2 + 17 + version*4 )*pixel;
    285        }
    286
    287        /**
    288         * 描画処理を行います。
    289         *
    290         * @og.rev 6.4.2.0 (2016/01/29) fukurou.util.StringUtil → fukurou.system.HybsConst に変更
    291         *
    292         * @param   gpx  Graphicsオブジェクト
    293         */
    294        @Override
    295        public void paint( final Graphics gpx ) {
    296                final Qrcode qrc =new Qrcode();
    297                qrc.setQrcodeErrorCorrect(errCo.getCh());
    298                qrc.setQrcodeEncodeMode(encMd.getCh());
    299                qrc.setQrcodeVersion(version);
    300
    301                final byte[] dt =qrData.getBytes( HybsConst.DEFAULT_CHARSET );  // 6.4.2.0 (2016/01/29)
    302                final boolean[][] sfg = qrc.calQrcode( dt );
    303
    304                final int size = sfg.length;
    305                final int mgn  = MARGIN*pixel ;
    306                for( int i=0; i<size; i++ ) {
    307                        for( int j=0; j<size; j++ ) {
    308                                if( sfg[j][i] ) {
    309                                        gpx.fillRect( mgn+j*pixel,mgn+i*pixel,pixel,pixel );
    310                                }
    311                        }
    312                }
    313        }
    314
    315        /**
    316         * 描画処理を行います。
    317         *
    318         */
    319        public void saveImage() {
    320                // 出力用イメージの生成
    321                final BufferedImage image = new BufferedImage(imageSize, imageSize, BufferedImage.TYPE_INT_BGR );
    322
    323                // イメージからグラフィックコンテキストを取得
    324                final Graphics grph = image.getGraphics();
    325                grph.setColor( java.awt.Color.WHITE );
    326                grph.fillRect( 0,0,imageSize, imageSize );
    327                grph.setColor( java.awt.Color.BLACK );
    328
    329                // JEditorPane をイメージに書き込む
    330                // paintComponent は proteced なので使用できない
    331                paint( grph );
    332
    333                // 使い終わったグラフィックコンテキストを開放
    334                grph.dispose();
    335
    336                try {
    337                        // イメージの出力 Image I/O を使用
    338                        ImageIO.write( image, imgType, new File( saveFile ) );
    339                } catch( final IOException ex ) {
    340                        final String errMsg = "イメージファイルの出力に失敗しました。"
    341                                        + "File=[" + saveFile + "]" ;
    342                        throw new OgRuntimeException( errMsg,ex );
    343                }
    344        }
    345
    346        /**
    347         * メイン処理です。
    348         * Usage: java org.opengion.fukurou.util.QrcodeImage Encode [SaevFile]
    349         *
    350         * @param  args  引数文字列配列
    351         */
    352        public static void main( final String[] args ) {
    353                if( args.length == 0 ) {
    354                        LogWriter.log( "Usage: java org.opengion.fukurou.util.QrcodeImage Encode [SaevFile]" );
    355                        return ;
    356                }
    357
    358                final String qrcode = args[0];
    359                final String file   = args.length > 1 ? args[1] : "img.png";
    360
    361                final QrcodeImage qrImage = new QrcodeImage();
    362                qrImage.init( qrcode,file );
    363                qrImage.saveImage();
    364        }
    365
    366        /**
    367         * 内部データを標準出力へ出力します。
    368         *
    369         */
    370        public static void printQcData() {
    371                final char[] strJ = new char[] { 'H','M' };
    372                final char[] strK = new char[] { 'N','A','B' };
    373
    374                for( int i=0; i<QC_DATA.length; i++ ) {
    375                        System.out.print( "version=[" + (i+1) + "] " );
    376                        for( int j=0; j<QC_DATA[i].length; j++ ) {
    377                                final char errCo = strJ[j];
    378                                for( int k=0; k<QC_DATA[i][j].length; k++ ) {
    379                                        System.out.print( errCo + strK[k] + "=[" + QC_DATA[i][j][k] + "] " );
    380                                }
    381                        }
    382                        System.out.println();
    383                }
    384        }
    385
    386        /**
    387         * バージョン情報を取得します。
    388         *
    389         * @param   errCo       エラー訂正レベル ('L','M','Q','H')
    390         * @param       encMd   エンコードモード ('N':数字モード 'A':英数字モード　'B':8bit byteモード)
    391         * @param       len             対象範囲
    392         *
    393         * @return      バージョン情報
    394         */
    395        public static int getVersion( final ErrCrct errCo, final EncMode encMd, final int len ) {
    396                final int errCoInt = errCo.getNo() ;
    397                final int encMdInt = encMd.getNo() ;
    398
    399                int rtn = -1;
    400                for( int i=0; i<QC_DATA.length; i++ ) {
    401                        if( QC_DATA[i][errCoInt][encMdInt] >= len ) {
    402                                rtn = i;
    403                                break;
    404                        }
    405                }
    406
    407                if( rtn < 0 ) {
    408                        final String errMsg = "データ量が対象範囲を超えています。エラーレベルや、モードを調整してください。"
    409                                                + "ErrCo:" + errCo + " EncMd:" + encMd + " len=[" + len + "]"
    410                                                + " MaxLen=[" + QC_DATA[QC_DATA.length-1][errCoInt][encMdInt] + "]" ;
    411                        throw new OgRuntimeException( errMsg );
    412                }
    413
    414                return rtn + 1 ;
    415        }
    416
    417        /**
    418         * 最大サイズを取得します。
    419         *
    420         * @param       version バージョン情報
    421         * @param   errCo       エラー訂正レベル ('L','M','Q','H')
    422         * @param       encMd   エンコードモード ('N':数字モード 'A':英数字モード　'B':8bit byteモード)
    423         *
    424         * @return      最大サイズ
    425         */
    426        public static int getMaxSize( final int version, final ErrCrct errCo, final EncMode encMd ) {
    427                final int errCoInt = errCo.getNo() ;
    428                final int encMdInt = encMd.getNo() ;
    429
    430                return QC_DATA[version][errCoInt][encMdInt] ;
    431        }
    432}