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     */
016    package org.opengion.plugin.table;
017    
018    import java.io.File;
019    import java.util.Locale;
020    import java.util.Map ;
021    import java.util.LinkedHashMap ;
022    
023    import org.opengion.hayabusa.common.HybsSystemException;
024    import org.opengion.hayabusa.common.HybsSystem;
025    import org.opengion.hayabusa.db.AbstractTableFilter;
026    import org.opengion.hayabusa.db.DBTableModel;
027    
028    import org.opengion.fukurou.util.ErrorMessage;
029    import org.opengion.fukurou.util.StringUtil;
030    import org.opengion.fukurou.util.ImageResizer;
031    
032    /**
033     * TableFilter_THUMBNAIL は、TableFilter インターフェースを継承した、DBTableModel 処ç�?”¨の
034     * 実è£?‚¯ラスですã?
035     *
036     * ここでは、オリジナルファイルのサãƒ?ƒ�イルファイルを作æ?しますã?
037     * keys と vals にæŒ?®šするå?を以下に示しますã?
038     *
039     * <table border="1" frame="box" rules="all" >
040     *  <tr><th>KEY                             </th><th>VAL                                                        </th><th>(å¿??)</th><th>初期値    </th><th>解説                                                                                                                                       </th></tr>
041     *  <tr><td>PATH_CLM                </td><td>å…?ƒ•ァイルのPATHカラãƒ?D             </td><td>å¿??        </td><td>           </td><td>å…?ƒ•ァイルのコンãƒ?‚­ストパスが登録されてã�?‚‹カラãƒ?D                                      </td></tr>
042     *  <tr><td>FILE_CLM                </td><td>å…?ƒ•ァイルのFILEカラãƒ?D             </td><td>å¿??        </td><td>           </td><td>å…?ƒ•ァイルのファイル名が登録されてã�?‚‹カラãƒ?D                                                   </td></tr>
043     *  <tr><td>THUMB_CLM               </td><td>サãƒ?ƒ�イルのカラãƒ?D                 </td><td>           </td><td>           </td><td>サãƒ?ƒ�イルのPATH/FILEが登録、またã?書き戻し用のカラãƒ?D                           </td></tr>
044     *  <tr><td>THUMB_DIR               </td><td>サãƒ?ƒ�イルの管ç�?ƒ•ォルãƒ?     </td><td>           </td><td>_thumb/</td><td>サãƒ?ƒ�イルを作æ?する中間管ç�?ƒ•ォルãƒ?��                                                                      </td></tr>
045     *  <tr><td>THUMB_SUFIX             </td><td>サãƒ?ƒ�イルの拡張å­?                  </td><td>           </td><td>AUTO       </td><td>サãƒ?ƒ�イルの拡張子をæŒ?®šしますã?AUTOは、å?のままですã?                                   </td></tr>
046     *  <tr><td>OVERWRITE               </td><td>上書きするかどã�?�‹                             </td><td>           </td><td>false      </td><td>サãƒ?ƒ�イルを作æ?する時ã?上書きするかどã�?�‹を指定しますã?                              </td></tr>
047     *  <tr><td>MAX_SIZE                </td><td>サãƒ?ƒ�イルのæœ?¤§ピクセル数           </td><td>           </td><td>128        </td><td>サãƒ?ƒ�イルを作æ?する時ã?画像ファイルの大きさ。比率はキープされますã? </td></tr>
048     * </table>
049     *
050     * 【解説ã€?
051     * ?‘.PATH_CLM ??FILE_CLMのカラãƒ??の値がã?å…?ƒ•ァイルのコンãƒ?‚­ストパス以下ã?ファイルのアドレスになりますã?
052     * ?’.サãƒ?ƒ�イルは通常、å?フォルãƒ?�«管ç�?ƒ•ォルãƒ?‚’作æ?しã?そã?下に、å?ファイルと同じ名前のサãƒ?ƒ�イルファイルを作æ?しますã?
053     *     つまりã?PATH_CLM ??THUMB_DIR ??FILE_CLM ??拡張子が、サãƒ?ƒ�イルのファイル名になりますã?
054     * ?“.THUMB_SUFIX を指定したå?合ã?、サãƒ?ƒ�イルの拡張子を変更できますã?初期値は、AUTOですã?
055     *     AUTOの場合ã?、å?ファイルと同じ拡張子が使われますã?自åˆ?�§æŒ?®šするå?合ã?、拡張子違ã�??å…?ƒ•ァイルがあれã?重è¤?�—ますã?で注意がå¿?¦�ですã?
056     * ?”.サãƒ?ƒ�イルを作æ?できるのは、bmp/jpeg/png/gif/tif ã�?�‘ですã?それ以外ã?ファイルにつã�?�¦は、ICONレンãƒ?ƒ©ー等を使用して、è?åˆ?�§サãƒ?ƒ�イル表示するようにして下さã�??
057     *     ただしã?å°?�¥çš?�«は、xls/ppt/doc/pdf などの主要なファイルフォーマットã?サãƒ?ƒ�イルは作æ?したã�?�¨è€?�ˆてã�?�¾すã?
058     * ?•.THUMB_CLM にサãƒ?ƒ�イルのファイル名が記述されてã�?‚‹場合ã?そã?名前でサãƒ?ƒ�イルを作æ?しますã?こã?ときã?OVERWRITE=true の場合ã?、既存ファイルの有無に関係なã�?
059     *     上書き(å?作æ??‰されますã?OVERWRITE=false(初期値)の場合ã?、すでに存在してã�?‚Œば、そのままとしますã?
060     * ?–.THUMB_CLM にサãƒ?ƒ�イルのファイル名が記述されてã�?�ªã�??合ã?、標準ã?ファイル名でサãƒ?ƒ�イルを作æ?して、THUMB_CLMカラãƒ?�«書き戻しますã?
061     *     こã?場合ã?既存ファイルの有無に関係なくã?上書き(å?作æ??‰されますã?
062     * ?—.THUMB_CLM が指定されてã�?�ªã�??合ã?、カラãƒ?�«書き戻しå?ç�?‚’行いませんã€??–.と同じで、書き戻しを行いませんã€?
063     * ?˜.MAX_SIZE は、サãƒ?ƒ�イルを作æ?する場合ã?縦、横のæœ?¤§ピクセルに、縮小されますã?比率は変わりません。これã?物ç�?š„なサãƒ?ƒ�イルファイルのサイズですã?
064     *
065     * なおã?ドキュメント管ç�?³»で、è?動スキャン取込みで、ファイルã‚?ƒ•ォルãƒ??先é?に、アンãƒ??バã?がつã�?�¦ã�?‚‹場合ã?、スキャン対象から外しますã?
066     * ドキュメントシスãƒ?ƒ から見た場合ã?ã€?š しファイルの扱ã�?�§すã?サãƒ?ƒ�イルもã?ãƒ?ƒ•ォルトでは、アンãƒ??バã?付ã?フォルãƒ?�«作æ?しますã?
067     * これは、è?動スキャンで、サãƒ?ƒ�イルのサãƒ?ƒ�イルを作æ?することを避ける意味合いもありますã?
068     * またã?サãƒ?ƒ�イルのä¸?‹¬削除などに都合が良ã�?�¨思いますã?
069     *
070     * パラメータは、tableFilterタグの keys, vals にそれぞれ記述するかã?BODY 部にCSS形式で記述しますã?
071     * @og.formSample
072     * ●形式ï¼?
073     *      â‘?&lt;og:tableFilter classId="THUMBNAIL" keys="PATH_CLM,FILE_CLM" vals='"PATH,NMFILE"' /&gt;
074     *
075     *      ② &lt;og:tableFilter classId="THUMBNAIL" &gt;
076     *               {
077     *                   PATH_CLM      :  å…?ƒ•ァイルのPATHカラãƒ?D    (å¿??)                  å…?ƒ•ァイルのコンãƒ?‚­ストパスが登録されてã�?‚‹カラãƒ?D
078     *                   FILE_CLM      :  å…?ƒ•ァイルのFILEカラãƒ?D    (å¿??)                  å…?ƒ•ァイルのファイル名が登録されてã�?‚‹カラãƒ?D
079     *                   THUMB_CLM     :  サãƒ?ƒ�イルのカラãƒ?D                                サãƒ?ƒ�イルのPATH/FILEが登録、またã?書き戻し用のカラãƒ?D
080     *                   THUMB_DIR     :  サãƒ?ƒ�イルの管ç�?ƒ•ォルãƒ?           初期値 _thumb/  サãƒ?ƒ�イルを作æ?する中間管ç�?ƒ•ォルãƒ?��
081     *                   THUMB_SUFIX   :  サãƒ?ƒ�イルの拡張å­?                 初期値 AUTO     AUTOはå…?�¨同じ拡張子を使ã�?�¾すã?
082     *                   OVERWRITE     :  上書きするかどã�?�‹                  初期値 false    サãƒ?ƒ�イルを作æ?する時ã?上書きするかどã�?�‹を指定しますã?
083     *                   MAX_SIZE      :  サãƒ?ƒ�イルのæœ?¤§ピクセル数          初期値 128      サãƒ?ƒ�イルを作æ?する時ã?画像ファイルの大きさ。比率はキープされますã?
084     *               }
085     *         &lt;/og:tableFilter&gt;
086     *
087     * @og.rev 5.6.5.1 (2013/06/14) 新規追åŠ?
088     * @og.rev 5.6.6.0 (2013/07/05) keys の整合æ?チェãƒ?‚¯を追åŠ?
089     *
090     * @version  0.9.0  2000/10/17
091     * @author   Kazuhiko Hasegawa
092     * @since    JDK1.1,
093     */
094    public class TableFilter_THUMBNAIL extends AbstractTableFilter {
095            //* こã?プログラãƒ??VERSIONæ–?­—å?を設定しますã?       {@value} */
096            private static final String VERSION = "5.6.6.1 (2013/07/12)" ;
097    
098            private static final String REAL_PATH = HybsSystem.sys( "REAL_PATH" );
099    
100            /**
101             * keys の整合æ?チェãƒ?‚¯を行うための初期設定を行いますã?
102             *
103             * @og.rev 5.6.6.1 (2013/07/12) keys の整合æ?チェãƒ?‚¯対å¿?
104             *
105             * @param       keysMap keys の整合æ?チェãƒ?‚¯を行うための Map
106             */
107            @Override
108            protected void init( final Map<String,String> keysMap ) {
109                    keysMap.put( "PATH_CLM"         , "å…?ƒ•ァイルのPATHカラãƒ?D (å¿??)"                                );
110                    keysMap.put( "FILE_CLM"         , "å…?ƒ•ァイルのFILEカラãƒ?D (å¿??)"                                );
111                    keysMap.put( "THUMB_CLM"        , "サãƒ?ƒ�イルのカラãƒ?D"                                          );
112                    keysMap.put( "THUMB_DIR"        , "サãƒ?ƒ�イルの管ç�?ƒ•ォルãƒ?  (初期値 _thumb/)"     );
113                    keysMap.put( "THUMB_SUFIX"      , "サãƒ?ƒ�イルの拡張å­?        (初期値 AUTO)"       );              // 5.6.6.1 (2013/07/12)
114                    keysMap.put( "OVERWRITE"        , "上書きするかどã�?�‹         (初期値 false" );
115                    keysMap.put( "MAX_SIZE"         , "サãƒ?ƒ�イルのæœ?¤§ピクセル数 (初期値 128"         );
116            }
117    
118            /**
119             * DBTableModel処ç�?‚’実行しますã?
120             *
121             * @og.rev 5.6.6.1 (2013/07/12) THUMB_SUFIXを追åŠ?
122             *
123             * @return 処ç�?µ�果のDBTableModel
124             */
125            public DBTableModel execute() {
126                    DBTableModel table = getDBTableModel();         // 5.5.2.6 (2012/05/25) インターフェースにgetterメソãƒ?ƒ‰追åŠ?
127    
128                    String  path_clm                = StringUtil.nval( getValue( "PATH_CLM"         ) , null                );              // å¿??é ?›®
129                    String  file_clm                = StringUtil.nval( getValue( "FILE_CLM"         ) , null                );              // å¿??é ?›®
130                    String  thumb_clm               = StringUtil.nval( getValue( "THUMB_CLM"        ) , null                );              // なければ、å?戻しをしなã�??
131                    String  thumb_dir               = StringUtil.nval( getValue( "THUMB_DIR"        ) , "_thumb/"   );              // サãƒ?ƒ�イルフォルãƒ?
132                    String  thumb_sufix             = StringUtil.nval( getValue( "THUMB_SUFIX"      ) , "AUTO"              );              // 5.6.6.1 (2013/07/12) サãƒ?ƒ�イルの拡張å­?
133                    boolean isOverwrite             = StringUtil.nval( getValue( "OVERWRITE"        ) , false               );              // サãƒ?ƒ�イルの再作æ?有無
134                    int     max_size                = StringUtil.nval( getValue( "MAX_SIZE"         ) , 128                 );
135    
136                    int path_clmNo  = table.getColumnNo( path_clm , true  );                // 存在しなã�??合ã?、エラー
137                    int file_clmNo  = table.getColumnNo( file_clm , true  );                // 存在しなã�??合ã?、エラー
138                    int thumb_clmNo = table.getColumnNo( thumb_clm , false );               // 存在しなã�??合ã?ã€?1 を返すã€?
139    
140                    ErrorMessage errMessage = null;
141                    int rowCnt = table.getRowCount();
142                    for( int row=0; row<rowCnt; row++ ) {
143                            try {
144                                    // オリジナルのファイルを構築しますã?
145                                    String pathClmVal = table.getValue( row,path_clmNo );
146                                    String fileClmVal = table.getValue( row,file_clmNo );
147                                    File orgFile = new File( StringUtil.urlAppend( REAL_PATH , pathClmVal ),fileClmVal );           // オリジナルファイルå�?
148                                    if( !orgFile.exists() ) {
149    //                                      String errMsg = "å…?ƒ•ァイルが存在しませんã€?" + orgFile.toString() + "]" ;                           // ファイルがなければエラー
150    //                                      throw new RuntimeException( errMsg );
151                                            continue;                                                                                                                                                               // 5.6.6.0 (2013/07/05) なければ無è¦?
152                                    }
153    
154                                    // â‘?サãƒ?ƒ�イル作æ?対象の拡張子ã?場合ã?み処ç�?�—ますã?よって、sufix は存在することが保障されますã?
155                                    if( ImageResizer.isReaderSuffix( fileClmVal ) ) {
156                                            // サãƒ?ƒ�イルのファイルを構築しますã?
157                                            File thumbFile = null;
158                                            String thumbClmVal = null;
159                                            if( thumb_clmNo >= 0 ) {
160                                                    thumbClmVal = table.getValue( row,thumb_clmNo );
161                                                    if( thumbClmVal != null && thumbClmVal.length() > 0 ) {                      // サãƒ?ƒ�イルファイル名がæŒ?®šされた場å�?
162                                                            thumbFile = new File( REAL_PATH , thumbClmVal );
163                                                            if( !isOverwrite && thumbFile.exists() ) { continue; }          // ファイルが存在した場合ã?、å?ç�?�—なã�?
164                                                    }
165                                                    else {
166                                                            thumbClmVal = null;
167                                                    }
168                                            }
169    
170                                            // â‘?1 thumbClmVal が未定義(=null)の場合ã?、è?åˆ?�§ファイル名を構築すã‚?
171                                            if( thumbClmVal == null ) {
172                                                    // å…?ƒ•ァイルの拡張子を取り出しますã?(小文字化も行いますã?)
173                                                    String sufix  = ImageResizer.getSuffix( fileClmVal );
174                                                    String thumbName = fileClmVal ;
175                                                    // 5.6.6.1 (2013/07/12) サãƒ?ƒ�イルの拡張å­?
176                                                    if( ! "AUTO".equalsIgnoreCase( thumb_sufix ) ) {        // AUTO以外がæŒ?®šされた場å�?
177                                                            thumbName = fileClmVal.substring( 0,fileClmVal.length()-sufix.length() ) + thumb_sufix ;
178                                                    }
179                                                    // 5.6.6.1 (2013/07/12) 拡張子が bmp の場合ã?、png に置き換えã?しなã�??
180    //                                              if( "bmp".equalsIgnoreCase( sufix ) ) {
181    //                                                      thumbName = fileClmVal.substring( 0,fileClmVal.length()-3 ) + "png" ;           // 拡張子が bmp の場合ã?、png に置き換えますã?
182    //                                              }
183    
184                                                    thumbClmVal = StringUtil.urlAppend( pathClmVal,thumb_dir,thumbName );                   // サãƒ?ƒ�イルのアドレス/ファイルå�?
185                                                    thumbFile = new File( REAL_PATH , thumbClmVal );
186    
187                                                    if( thumb_clmNo >= 0) {
188                                                            table.setValueAt( thumbClmVal,row,thumb_clmNo );                        // サãƒ?ƒ�イルファイル名ã?書き戻ã�?
189                                                    }
190                                            }
191    
192                                            // サãƒ?ƒ�イル保存å?のãƒ?‚£レクトリ作æ?
193                                            File parent = thumbFile.getParentFile();
194                                            if( !parent.exists() && !parent.mkdirs() ) {
195                                                    String errMsg = "サãƒ?ƒ�イル保存å?のãƒ?‚£レクトリ作æ?に失敗しました。file=[" + parent.toString() + "]";
196                                                    throw new HybsSystemException( errMsg );
197                                            }
198    
199                                            // 実際のサãƒ?ƒ�イルの作æ?処ç�?
200                                            ImageResizer imgRes = new ImageResizer( orgFile.getAbsolutePath() );            // 変換å…??ファイルå�?
201                                            imgRes.resizeByPixel( thumbFile.getAbsolutePath() , max_size );                         // 変換先ã?ファイル名と画像ã?大きさ
202                                    }
203                            }
204                            catch( RuntimeException ex ) {
205                                    if( errMessage == null ) { errMessage = makeErrorMessage( "TableFilter_THUMBNAIL Error",ErrorMessage.NG ); }
206                                    errMessage.addMessage( row+1,ErrorMessage.NG,ex.getMessage() );
207                            }
208                    }
209    
210                    return table;
211            }
212    }