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.hayabusa.taglib; 017 018import static org.opengion.fukurou.util.StringUtil.nval; 019 020import java.util.Locale; 021import java.util.Map; 022import java.util.HashMap; 023import java.util.Enumeration; 024 025import org.opengion.fukurou.util.ErrorMessage; 026import org.opengion.fukurou.util.StringUtil; 027import org.opengion.hayabusa.common.HybsSystem; 028import org.opengion.hayabusa.common.HybsSystemException; 029import org.opengion.hayabusa.mail.MailManager_DIRECT; 030import org.opengion.hayabusa.db.DBTableModel; 031 032import javax.servlet.ServletRequest ; 033 034/** 035 * 定型文およびパラメータの設定によるメールを送信するためのタグです。 036 * 037 * @og.formSample 038 * ●形式:<og:mailSender ptnId="…" action="…" from="…" to="…" /> 039 * ●body:なし 040 * 041 * ●Tag定義: 042 * <og:mailSender2 043 * ptnId ○【TAG】メール定型文のIDを指定します(必須)。 044 * from ○【TAG】送信元(FROM)の社員IDを指定します(必須)。 045 * action ○【TAG】アクション[CHECK/SEND/NOCHECK]をセットします(必須)。 046 * addrCheck 【TAG】メールアドレスの構文とメールアカウントのチェックをするかどうか[true/false]を指定します 047 * to 【TAG】送信先(TO)の社員ID、グループIDをCSV形式で指定します 048 * cc 【TAG】送信先(CC)の社員ID、グループIDをCSV形式で指定します 049 * bcc 【TAG】送信先(BCC)の社員ID、グループIDをCSV形式で指定します 050 * tableId 【TAG】(通常は使いません)宛先のDBTableModelを、sessionに登録するときのキーを指定します 051 * scope 【TAG】キャッシュする場合のスコープ[request/page/session/applicaton]を指定します(初期値:session) 052 * fileURL 【TAG】添付ファイルのセーブディレクトリを指定します (初期値:FILE_URL[=filetemp/]) 053 * filename 【TAG】添付ファイル名をCSV形式で指定します 054 * useStop 【TAG】例外発生した場合、後続JSPの評価を中止するかどうか[true:中止/false:継続]を指定します 055 * debug 【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false) 056 * /> 057 * 058 * ●使用例 059 * <og:mailSender2 > 060 * ptnId = PtnId 定型文ID(定型文マスタに登録されている定型文ID) 061 * action = Action アクション(CHECK:確認あり/SEND:確認後の送信/NOCHECK:確認なし) 062 * from = From 送信元(送信者社員ID) 063 * to = To 送信先(コンマ区切りで複数セット可能、社員ID、グループID) 064 * cc = Cc 送信先(コンマ区切りで複数セット可能、社員ID、グループID) 065 * bcc = Bcc 送信先(コンマ区切りで複数セット可能、社員ID、グループID) 066 * fileURL = 添付ファイルのセーブディレクトリ 067 * filename = 添付ファイル名(ローカルにセーブされたファイル名)(コンマ区切りで複数登録可能) 068 * addrCheck = true/false(メールアカウントの有効チェック) 069 * useStop = true/false エラー発生時に後続JSPの評価を中止する(true)/中止しない(false) 070 * scope = request/session 宛先テーブルの格納スコープ(デフォルト:session) 071 * tableId = TableId 宛先テーブルのID(通常はデフォルトのテーブルモデルID名称を利用します) 072 * debug = true/false 073 * </og:mailSender > 074 * 075 * from には社員IDしかセットできません。 076 * to,cc,bccには社員ID、またはグループIDをコンマ区切りで複数セットできます。 077 * action:CHECK は送信前に、一度送信内容を確認したい場合に利用します。action=CHECKの場合、scopeにはsessionしかセットできません。 078 * action:SEND は確認済のメール文を送信する場合に利用します。 079 * action:NOCHECK は確認なしで送信したい場合に利用します。 080 * 081 * @og.group その他出力 082 * 083 * @version 4.0 084 * @author Sen.Li 085 * @since JDK1.6 086 */ 087public class MailSenderTag2 extends CommonTagSupport { 088 private static final String VERSION = "4.4.0.0 (2009/01/05)"; 089 private static final long serialVersionUID = 440020090105L ; 090 091 private static final String ACT_CHECK = "CHECK" ; 092 private static final String ACT_SEND = "SEND" ; 093 private static final String ACT_NOCHECK = "NOCHECK" ; 094 private static final int MAX_FILE_COUNT = 5 ; 095 private static final String[] ACTION_LIST = new String[] { ACT_CHECK , ACT_SEND, ACT_NOCHECK }; 096 private String ptnId = null; 097 private String action = null; 098 private String from = null; 099 private String to = null; 100 private String cc = null; 101 private String bcc = null; 102 private String fileURL = HybsSystem.sys( "FILE_URL" ); 103 private String[] filename = null; 104 private String tableId = HybsSystem.TBL_MDL_KEY ; 105 private boolean addrCheck = false; 106 private boolean useStop = true; 107 108 /** 109 * Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。 110 * 111 * @return 後続処理の指示 112 */ 113 @Override 114 public int doEndTag() { 115 debugPrint(); 116 int rtnCode = EVAL_PAGE; 117 int errCode = ErrorMessage.OK; 118 119 if( check( action, ACTION_LIST ) ) { 120 try { 121 tableId = ( tableId == null ) ? HybsSystem.TBL_MDL_KEY:tableId; 122 MailManager_DIRECT manager = new MailManager_DIRECT(); 123 manager.setResourceManager( getResource() ); 124 DBTableModel table = null; 125 126 if ( ACT_NOCHECK.equals( action ) || ACT_CHECK.equals( action ) ){ 127 Map<String,String> initParamMap = makeParamMap(); 128 manager.create( initParamMap ); 129 } 130 if( ACT_NOCHECK.equals( action ) ) { 131 manager.setDebug( isDebug() ); 132 manager.send(); 133 } 134 else if ( ACT_CHECK.equals( action ) ) { 135 setSessionAttribute( "MAIL.FROM_ADDR", manager.getFromAddr() ); 136 setSessionAttribute( "MAIL.PTN_ID", ptnId ); 137 setSessionAttribute( "MAIL.TITLE", manager.getTitle() ); 138 setSessionAttribute( "MAIL.CONTENT", manager.getContent() ); 139 } 140 else if ( ACT_SEND.equals( action ) ) { 141 ptnId = (String) getSessionAttribute( "MAIL.PTN_ID" ); 142 Map<String,String> initParamMap = makeParamMap(); 143 manager.setFromAddr( (String) getSessionAttribute( "MAIL.FROM_ADDR" ) ); 144 manager.setTitle( (String) getSessionAttribute( "MAIL.TITLE" ) ); 145 manager.setContent( (String) getSessionAttribute( "MAIL.CONTENT" ) ); 146 table = ( DBTableModel )getObject( tableId ); 147 manager.create( initParamMap, table ); 148 manager.setDebug( isDebug() ); 149 manager.send(); 150 } 151 startQueryTransaction( tableId ); 152 table = manager.makeDstTable(); 153 if( ! commitTableObject( tableId, table ) ) { 154 jspPrint( "DBTableModel は登録しません。" ); 155 } 156 } 157 catch( RuntimeException rex ){ 158 if ( useStop ) { 159 ErrorMessage errMsg = new ErrorMessage(); 160 errMsg.addMessage( 0, ErrorMessage.NG, "ERR0040", rex.getMessage() ); 161 jspPrint( TaglibUtil.makeHTMLErrorTable( errMsg, getResource() ) ); 162 rtnCode = SKIP_PAGE; 163 } 164 rex.printStackTrace(); 165 errCode = ErrorMessage.WARNING; 166 } 167 setSessionAttribute( "MAIL.ERR_CODE", String.valueOf( errCode ) ); 168 } 169 else { 170 String errMsg = "設定のアクションはサポートされていません:" + action ; 171 throw new HybsSystemException( errMsg ); 172 } 173 return rtnCode; 174 } 175 176 /** 177 * 【TAG】アクション[CHECK/SEND/NOCHECK]をセットします。 178 * @og.tag 179 * 送信前に、一度送信内容を確認する場合、"CHECK "をセットします。 180 * 確認済のメール文を送信する場合、"SEND"をセットします。 181 * 確認なしで送信する場合、"NOCHECK"をセットします。 182 * 183 * @param act アクション[CHECK/SEND/NOCHECK] 184 */ 185 public void setAction( final String act ) { 186 String act2 = getRequestParameter( act ); 187 if( act2 != null && act2.length() > 0 ) { action = act2.toUpperCase(Locale.JAPAN); } 188 } 189 190 /** 191 * 【TAG】メール定型文のIDを指定します。 192 * 193 * @og.tag 194 * 定型文マスタに定義されている定型文IDを指定します。 195 * 196 * @param pid 定型文ID 197 */ 198 public void setPtnId( final String pid ) { 199 ptnId = nval( getRequestParameter( pid ),null ); 200 } 201 202 /** 203 * 【TAG】送信元(FROM)の社員IDを指定します。 204 * 205 * @og.tag 206 * 送信元(FROM)の社員IDを指定します。社員マスタに存在している社員ID(例:"C12345")しかセットできません。 207 * 208 * @param fromId 送信元(FROM)の社員ID 209 */ 210 public void setFrom( final String fromId ) { 211 from = nval( getRequestParameter( fromId ), from ); 212 setRequestAttribute( "FROM", from ); 213 } 214 215 /** 216 * 【TAG】送信先(TO)の社員ID、グループIDをCSV形式で指定します。 217 * 218 * @og.tag 219 * 複数のID(社員ID、グループID)をカンマ区切りでセットできます。 220 * グループIDはグループマスタ管理画面により定義する必要があります。"GP.XXXXX"の形式でセットします。 221 * 222 * @param toIds 送信先(TO)の社員ID、グループID(CSV形式) 223 */ 224 public void setTo( final String toIds ) { 225 to = getRequestParameter( toIds ); 226 } 227 228 /** 229 * 【TAG】送信先(CC)の社員ID、グループIDをCSV形式で指定します。 230 * 231 * @og.tag 232 * 複数のID(社員ID、グループID)をカンマ区切りでセットできます。 233 * グループIDはグループマスタ管理画面により定義する必要があります。"GP.XXXXX"の形式でセットします。 234 * 235 * @param ccIds 送信先(CC)の社員ID、グループID(CSV形式) 236 */ 237 public void setCc( final String ccIds ) { 238 cc = getRequestParameter( ccIds ); 239 } 240 241 /** 242 * 【TAG】送信先(BCC)の社員ID、グループIDをCSV形式で指定します。 243 * 244 * @og.tag 245 * 複数のID(社員ID、グループID)をカンマ区切りでセットできます。 246 * グループIDはグループマスタ管理画面により定義する必要があります。"GP.XXXXX"の形式でセットします。 247 * 248 * @param bccIds 送信先(BCC)の社員ID、グループID(CSV形式) 249 */ 250 public void setBcc( final String bccIds ) { 251 bcc = getRequestParameter( bccIds ); 252 } 253 254 /** 255 * 【TAG】添付ファイルのセーブディレクトリを指定します 256 * (初期値:FILE_URL[={@og.value org.opengion.hayabusa.common.SystemData#FILE_URL}])。 257 * 258 * @og.tag 259 * この属性で指定されるディレクトリに、添付ファイルが存在すると仮定します。 260 * 指定方法は、通常の fileURL 属性と同様に、先頭が、'/' (UNIX) または、2文字目が、 261 * ":" (Windows)の場合は、指定のURLそのままのディレクトリに、そうでない場合は、 262 * fileURL = "{@USER.ID}" と指定すると、FILE_URL 属性で指定のフォルダの下に、 263 * さらに、各個人ID別のフォルダを作成して、そこを使用します。 264 * (初期値:システム定数のFILE_URL[={@og.value org.opengion.hayabusa.common.SystemData#FILE_URL}])。 265 * 266 * @param url 添付ファイルのセーブディレクトリ 267 * @see org.opengion.hayabusa.common.SystemData#FILE_URL 268 */ 269 public void setFileURL( final String url ) { 270 String furl = nval( getRequestParameter( url ),null ); 271 if( furl != null ) { 272 char ch = furl.charAt( furl.length()-1 ); 273 if( ch != '/' && ch != '\\' ) { furl = furl + "/"; } 274 fileURL = StringUtil.urlAppend( fileURL,furl ); 275 } 276 } 277 278 /** 279 * 【TAG】添付ファイル名をCSV形式で指定します。 280 * 281 * @og.tag 282 * 複数ファイルをセットできます。 283 * 設定方法は、カンマで区切って並べ複数指定できます。 284 * 285 * @param fname 添付ファイル名 286 */ 287 public void setFilename( final String fname ) { 288 filename = StringUtil.csv2ArrayOnly( getRequestParameter( fname ) ); 289 } 290 291 /** 292 * 【TAG】メールアドレスの構文とメールアカウントのチェックをするかどうか[true/false]を指定します。 293 * 294 * @og.tag 295 * メールアドレスの構文とメールアカウントのチェックをする(true)/しない(false)を指定します。 296 * メール文合成の段階では、メールアドレスの構文文法についてチェックします。 297 * メール送信の段階では、メールアカウントが有効かについてチェックします。 298 * "true"と指定する場合、エラーが検出されたら、例外を投げて本タグの処理が中止されます。 299 * "false"と指定する場合、エラーが検出されても、例外を投げません。 300 * 301 * @param addrChk 構文,アカウントチェックおするかどうか[true/false] 302 */ 303 public void setAddrCheck( final String addrChk ) { 304 addrCheck = nval( getRequestParameter( addrChk ), addrCheck ); 305 } 306 307 /** 308 * 【TAG】例外発生した場合、後続JSPの評価を中止するかどうか[true:中止/false:継続]を指定します。 309 * 310 * @og.tag 311 * "true"と指定する場合、例外が発生したら、後続JSPが評価されません。 312 * "false"と指定する場合、例外が発生しても、後続JSPが評価されます。後続のJSPでは変数 313 * {@MAIL.ERR_CODE}で本タグの実行状況(エラー発生したか)を取得できます。 314 * 315 * @param stop 例外時に後続処理を中止するかどうか[true:中止/false:継続] 316 */ 317 public void setUseStop( final String stop ) { 318 useStop = nval( getRequestParameter( stop ), useStop ); 319 } 320 321 /** 322 * 【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します 323 * (初期値:HybsSystem#TBL_MDL_KEY[={@og.value org.opengion.hayabusa.common.HybsSystem#TBL_MDL_KEY}])。 324 * 325 * @og.tag 326 * 検索結果より、DBTableModelオブジェクトを作成します。これを、下流のviewタグ等に 327 * 渡す場合に、通常は、session を利用します。その場合の登録キーです。 328 * query タグを同時に実行して、結果を求める場合、同一メモリに配置される為、 329 * この tableId 属性を利用して、メモリ空間を分けます。 330 * (初期値:HybsSystem#TBL_MDL_KEY[={@og.value org.opengion.hayabusa.common.HybsSystem#TBL_MDL_KEY}])。 331 * 332 * @param id sessionに登録する時の ID 333 */ 334 public void setTableId( final String id ) { 335 tableId = nval( getRequestParameter( id ),tableId ); // 3.8.0.9 (2005/10/17) 336 } 337 338 /** 339 * タグリブオブジェクトをリリースします。 340 * キャッシュされて再利用されるので、フィールドの初期設定を行います。 341 * 342 */ 343 @Override 344 protected void release2() { 345 super.release2(); 346 from = null; 347 to = null; 348 cc = null; 349 bcc = null; 350 fileURL = HybsSystem.sys( "FILE_URL" ); 351 filename = null; 352 ptnId = null; 353 action = null; 354 tableId = HybsSystem.TBL_MDL_KEY ; 355 addrCheck = false; 356 useStop = true; 357 } 358 359 /** 360 * このオブジェクトの文字列表現を返します。 361 * 基本的にデバッグ目的に使用します。 362 * 363 * @return このクラスの文字列表現 364 */ 365 @Override 366 public String toString() { 367 return org.opengion.fukurou.util.ToString.title(this.getClass().getName() ) 368 .println( "VERSION" ,VERSION ) 369 .println( "ptnId" ,ptnId ) 370 .println( "action" ,action ) 371 .println( "tableId" ,tableId ) 372 .println( "addrCheck" ,addrCheck ) 373 .println( "useStop" ,useStop ) 374 .println( "from" ,from ) 375 .println( "to" ,to ) 376 .println( "cc" ,cc ) 377 .println( "bcc" ,bcc ) 378 .println( "filename" ,filename ) 379 .println( "fileURL" ,fileURL ) 380 .println( "Other...", getAttributes().getAttribute() ) 381 .fixForm().toString(); 382 } 383 384 /** 385 * リクエスト変数の値より、定型文に必要なパラメータを取得して、パレメータマップに入れます。 386 * パラメータマップは引数としてメールモジュールのマネージャに渡します。 387 * マネージャの中には、定型文を元に、パラメータマップの値とマージしてメールの各項目を合成します。 388 * 389 * @return 定型文に必要なパレメータマップ 390 */ 391 private Map<String, String> makeParamMap() { 392 Map<String, String> paramMap = new HashMap<String, String>(); 393 if( action.endsWith( ACT_NOCHECK ) || action.equals( ACT_CHECK ) ) { 394 ServletRequest request = this.getRequest(); 395 Enumeration<?> enu1 = request.getAttributeNames(); 396 while( enu1.hasMoreElements() ) { 397 String name = (String) enu1.nextElement(); 398 Object tmpObj = request.getAttribute( name ); 399 if ( tmpObj instanceof String ) { 400 paramMap.put( name, (String) request.getAttribute( name ) ); 401 } 402 } 403 Enumeration<?> enu2 = request.getParameterNames(); 404 while( enu2.hasMoreElements() ) { 405 String name = (String) enu2.nextElement(); 406 paramMap.put( name, request.getParameter( name ) ); 407 } 408 409 paramMap.put( "FROM", from ); 410 paramMap.put( "TO", to ); 411 paramMap.put( "CC", cc ); 412 paramMap.put( "BCC", bcc ); 413 } 414 paramMap.put( "PTN_ID", ptnId ); 415 paramMap.put( "SYSTEM_ID", HybsSystem.sys( "SYSTEM_ID" ) ); 416 paramMap.put( "ADDR_CHECK", String.valueOf( addrCheck ) ); 417 paramMap.put( "LOGIN_USERID", getRequestValue( "USER.ID" ) ); 418 paramMap.put( "LOGIN_USERNAME", getRequestValue( "USER.JNAME" ) ); 419 paramMap.put( "PGID", getRequestValue( "GUI.KEY" ) ); 420 paramMap.put( "DATE", HybsSystem.getDate( "yyyy/MM/dd" ) ); 421 paramMap.put( "TIME", HybsSystem.getDate( "HH:mm:ss" ) ); 422 423 String[] temp = { "", "", "", "", "" }; 424 if( filename != null && filename.length > 0 ) { 425 String directory = HybsSystem.url2dir( fileURL ); 426 int fileCount = filename.length > MAX_FILE_COUNT ? MAX_FILE_COUNT : filename.length; 427 for( int i = 0; i < fileCount; i++ ) { 428 temp[i] = StringUtil.urlAppend( directory, filename[i] ); 429 } 430 } 431 paramMap.put( "ATTACH1", temp[0] ); 432 paramMap.put( "ATTACH2", temp[1] ); 433 paramMap.put( "ATTACH3", temp[2] ); 434 paramMap.put( "ATTACH4", temp[3] ); 435 paramMap.put( "ATTACH5", temp[4] ); 436 return paramMap; 437 } 438}