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 org.opengion.hayabusa.common.HybsSystem; 019import org.opengion.hayabusa.resource.GUIInfo; 020import org.opengion.hayabusa.db.DBEditConfig; // 6.2.0.1 (2015/03/06) 021import org.opengion.fukurou.system.OgBuilder ; // 6.4.4.2 (2016/04/01) 022import org.opengion.fukurou.util.TagBuffer; // 6.1.1.0 (2015/01/17) 023import org.opengion.fukurou.util.XHTMLTag ; 024import org.opengion.fukurou.util.ToString; // 6.1.1.0 (2015/01/17) 025 026import static org.opengion.fukurou.util.StringUtil.nval ; 027 028import jakarta.servlet.http.HttpServletRequest ; 029 030/** 031 * サブミットボタンの表示や、画面遷移先情報(forward.jsp)を制御するタグです。 032 * 033 * ユーザー情報と画面情報を元に、ロール/グループの権限と 034 * RW(読取/書込)モードを比較して、条件が成立しない場合は、そのBODY部を表示しないように 035 * できます。 036 * また、編集設定を行っている場合は、強制的に書込禁止に設定しています。 037 * (ただし、編集設定が、カラムの並べ替えのみの場合か、または、useEdit="true" に 038 * 設定した場合は、書込許可されます) 039 * このタグは、form 内に一つだけ記述してください。 040 * 041 * @og.formSample 042 * ●形式:<og:writeCheck /> 043 * ●body:あり(EVAL_BODY_INCLUDE:BODYをインクルードし、{@XXXX} は解析しません) 044 * 045 * ●Tag定義: 046 * <og:writeCheck 047 * useGamenId 【TAG】GAMENID,BACK_GAMENID 属性を付加するかどうか[true/false]を設定します(初期値:true) 048 * roles 【TAG】画面と別にロールズを与えます 049 * writable 【TAG】書込可能か場合に許可するかどうか[true/false]を設定します(初期値:true) 050 * readable 【TAG】読込可能な場合に許可するかどうか[true/false]を設定します(初期値:false) 8.1.0.1 (2022/01/07) 051 * useEdit 【TAG】EDITNAME利用時の編集を可能にするか設定します 052 * (初期値:USE_EDIT_WITH_EDITNAME[={@og.value SystemData#USE_EDIT_WITH_EDITNAME}])。 053 * outputEditName 【TAG】editNameをhiddenタグで出力するか設定します 054 * (初期値:OUTPUT_EDITNAME[={@og.value SystemData#OUTPUT_EDITNAME}])。 055 * useDummy 【TAG】IE用ダミーinputを出力するかどうか 056 * caseKey 【TAG】このタグ自体を利用するかどうかの条件キーを指定します(初期値:null) 057 * caseVal 【TAG】このタグ自体を利用するかどうかの条件値を指定します(初期値:null) 058 * caseNN 【TAG】指定の値が、null/ゼロ文字列 でない場合(Not Null=NN)は、このタグは使用されます(初期値:判定しない) 059 * caseNull 【TAG】指定の値が、null/ゼロ文字列 の場合は、このタグは使用されます(初期値:判定しない) 060 * caseIf 【TAG】指定の値が、true/TRUE文字列の場合は、このタグは使用されます(初期値:判定しない) 061 * debug 【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false) 062 * > ... Body ... 063 * </og:writeCheck> 064 * 065 * ●使用例 066 * <og:writeCheck> 067 * <og:submit value="copy" lbl="COPY" accesskey="C" /> 068 * <og:submit value="modify" lbl="MODIFY" accesskey="M" /> 069 * <og:submit value="delete" lbl="DELETE" accesskey="D" /> 070 * <jsp:directive.include file="{@SYS.JSP}/common/Excel_direct.jsp" /> 071 * <br /> 072 * </og:writeCheck> 073 * 074 * @og.group 画面制御 075 * 076 * @version 4.0 077 * @author Kazuhiko Hasegawa 078 * @since JDK5.0, 079 */ 080public class WriteCheckTag extends CommonTagSupport { 081 /** このプログラムのVERSION文字列を設定します。 {@value} */ 082 private static final String VERSION = "8.1.0.1 (2022/01/07)" ; 083 private static final long serialVersionUID = 810120220107L ; 084 085 // 6.1.1.0 (2015/01/17) DUMMY_INPUT_TAG は、システム共通で固定値でよい。 086 // 5.6.1.0 (2013/02/01) display:noneのダミー出力(IEのEnterボタンのための、隠しinput出力) 087 private static final String DUMMY_INPUT_TAG = 088 new TagBuffer( "input" ) 089 .add( "name" , "HYBS_DUMMY_NPUT" ) 090 .add( "style" , "display:none;" ) 091 .makeTag() ; 092 093 // 3.5.4.0 (2003/11/25) BACK_GAMENID を使用する/しないを指定します。 094 private boolean useGamenId = true; 095 // 3.5.4.0 (2003/11/25) 画面と別にロールズを与えられます。 096 private String roles ; 097 098 // 3.8.5.1 (2006/05/08) 書込許可属性 writable 追加 099 private boolean writable = true; 100 101 // 8.1.0.1 (2022/01/07) 読込許可属性 readable 追加 102 private boolean readable ; 103 104 // 5.5.4.2 (2012/06/13) EDITNAME利用時の編集 105 private boolean useEdit = HybsSystem.sysBool( "USE_EDIT_WITH_EDITNAME" ); 106 private boolean outputEditName = HybsSystem.sysBool( "OUTPUT_EDITNAME" ); // EditNameをhidden出力するか 107 108 // 5.6.1.0 (2013/02/01) display:noneのダミー出力 109 // 6.9.5.0 (2018/04/23) USE_DUMMY_INPUT 廃止(false固定) 110// private boolean useDummy = HybsSystem.sysBool( "USE_DUMMY_INPUT" ); 111 private boolean useDummy ; // 6.9.5.0 (2018/04/23) USE_DUMMY_INPUT 廃止(false固定) 112 113 // 6.2.4.0 (2015/05/15) 114 private String logMsg ; // 途中の状況表示用(ログメッセージ) 115 116 /** 117 * デフォルトコンストラクター 118 * 119 * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor. 120 */ 121 public WriteCheckTag() { super(); } // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。 122 123 /** 124 * Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。 125 * 126 * @og.rev 3.0.1.2 (2003/03/07) forward.jsp の代替用 CommonForwardTag を新規作成 127 * @og.rev 3.5.4.0 (2003/11/25) useGamenId で、BACK_GAMENID を使用する/しないを指定します。 128 * @og.rev 3.8.5.1 (2006/05/08) 書込許可属性 writable 追加 129 * @og.rev 5.6.1.0 (2013/02/01) display:noneのdummyインプットを出力する 130 * @og.rev 5.7.8.0 (2014/07/04) caseKey,caseVal,caseNN,caseNull 属性を追加 131 * @og.rev 8.1.0.1 (2022/01/07) 読込許可属性 readable 追加 132 * 133 * @return 後続処理の指示 134 */ 135 @Override 136 public int doStartTag() { 137// if( writable && isWrite() && useTag() ) { // 5.7.8.0 (2014/07/04) 追加 138 if( isCheck() && useTag() ) { // 8.1.0.1 (2022/01/07) に一本化 139 if( useDummy ) { jspPrint( DUMMY_INPUT_TAG ); } // 6.1.1.0 (2015/01/17) 固定値でよい 140 if( useGamenId ) { jspPrint( getHiddenTag() ); } 141 return EVAL_BODY_INCLUDE ; 142 } 143 return SKIP_BODY ; 144 } 145 146 /** 147 * タグリブオブジェクトをリリースします。 148 * キャッシュされて再利用されるので、フィールドの初期設定を行います。 149 * 150 * @og.rev 3.5.4.0 (2003/11/25) 新規追加。 151 * @og.rev 3.8.5.1 (2006/05/08) 書込許可属性 writable 追加 152 * @og.rev 5.5.4.2 (2012/07/13) EDITNAME利用時の編集 153 * @og.rev 5.6.1.0 (2013/02/01) useDummy 追加 154 * @og.rev 6.2.4.0 (2015/05/15) logMsg 追加 155 * @og.rev 6.9.5.0 (2018/04/23) USE_DUMMY_INPUT 廃止(false固定) 156 * @og.rev 8.1.0.1 (2022/01/07) 読込許可属性 readable 追加 157 */ 158 @Override 159 protected void release2() { 160 super.release2(); 161 useGamenId = true; 162 roles = null; 163 writable = true; // 3.8.5.1 (2006/05/08) 164 readable = false; // 8.1.0.1 (2022/01/07) 165 useEdit = HybsSystem.sysBool( "USE_EDIT_WITH_EDITNAME" ); // 5.5.4.2 (2012/06/13) 166 outputEditName = HybsSystem.sysBool( "OUTPUT_EDITNAME" ); // 5.5.4.2 (2012/06/13) 167// useDummy = HybsSystem.sysBool( "USE_DUMMY_INPUT" ); // 5.6.1.0 (2013/02/01) 168 useDummy = false; // 6.9.5.0 (2018/04/23) USE_DUMMY_INPUT 廃止(false固定) 169 logMsg = null ; // 6.2.4.0 (2015/05/15) 途中の状況表示用(ログメッセージ) 170 } 171 172 /** 173// * guiInfo.isWrite() の結果をチェック[true/false]して返します。 174 * 画面のアクセス許可やロール等を考慮して、使用可能かどうかをチェック[true/false]して返します。 175 * 176 * 判定は、rolesが未指定の場合は、writable && guiInfo.isWrite() || readable && guiInfo.isRead() で 177 * rolesが指定されている場合は、getUser().isAccess( roles ) で判定されます。 178 * さらに、編集設定時も書込禁止に設定されますが、USE_EDIT_WITH_NAME_SEQ = true の時のみ 179 * カラムの非表示が無ければ、使用許可します。 180 * 181 * @og.rev 3.5.4.0 (2003/11/25) 画面と別にロールズを与えられます。 182 * @og.rev 4.3.0.0 (2008/07/04) ロールモードマルチ対応 183 * @og.rev 5.3.6.0 (2011/06/01) 編集設定時もfalse(書込禁止)とする。 184 * @og.rev 5.5.4.2 (2012/07/13) EDITNAME利用時の初期値登録 185 * @og.rev 6.2.0.1 (2015/03/06) EDITNAME利用時に、カラムの非表示が無ければ、書込許可する。 186 * @og.rev 6.2.4.0 (2015/05/15) 途中の状況表示用(ログメッセージ) 187 * @og.rev 6.2.5.0 (2015/06/05) Edit機能改善。カラムの非表示が無ければ、書込許可する(USE_EDIT_WITH_NAME_SEQ = true) 188 * @og.rev 7.2.9.1 (2020/10/23) writeCheckタグ内で書込許可するかどうかを決める為の情報(DBEditConfig#useEditName() 使用) 189 * @og.rev 8.1.0.1 (2022/01/07) 読込許可属性 readable 追加 190 * 191 * @return 使用可能かどうか[true/false] 192 */ 193// private boolean isWrite() { 194 private boolean isCheck() { 195 boolean rtnFlag = false; 196 197 // 4.0.0 (2005/11/30) 指定のロールが、アクセス許可の場合は、出力します。 198 // 6.4.1.1 (2016/01/16) PMD refactoring. Avoid if (x != y) ..; else ..; 199 if( roles == null ) { 200 final GUIInfo guiInfo = (GUIInfo)getSessionAttribute( HybsSystem.GUIINFO_KEY ); 201 if( guiInfo != null ) { // 6.4.1.1 (2016/01/16) 一応、nullチェックを入れておきます。 202// rtnFlag = guiInfo.isWrite() ; // 4.0.0 (2005/01/31) 203 rtnFlag = writable && guiInfo.isWrite() || readable && guiInfo.isRead() ; 204 } 205 } 206 else { 207 rtnFlag = getUser().isAccess( roles ) ; 208 } 209 210 // 5.3.6.0 (2011/06/01) 編集設定時もfalse(書込禁止)とする。 211 if( rtnFlag ) { 212 final String editName = getRequestValue( "editName" ); 213 if( editName != null && editName.length() > 0 ) { 214 // rtnFlag = false; 215 rtnFlag = useEdit; // 5.5.4.2 (2012/07/13) EDITNAME利用時の初期値 216 217 // 6.2.0.1 (2015/03/06) 編集設定時に、カラムの非表示が無ければ、書込許可する。 218 // 6.2.5.0 (2015/06/05) カラムの非表示が無ければ、書込許可するのは、USE_EDIT_WITH_NAME_SEQ = true の時のみ 219 if( HybsSystem.sysBool( "USE_EDIT_WITH_NAME_SEQ" ) ) { 220 final String gamenId = getGUIInfoAttri( "KEY" ); 221 final DBEditConfig config = getUser().getEditConfig( gamenId, editName ); 222 if( config != null ) { 223 final String viewClms = config.getViewClms(); 224// // カラム列があり、非表示カラムがない。 225// if( viewClms != null && viewClms.indexOf( '!' ) < 0 ) { 226 // 非表示カラムがなく、集計カラム,グループカラム,小計カラム,合計カラム,総合計行もない場合のみ、true 227 // 要するに、列の並び替えと、表示順、(降順)指定のみの場合だけ、書込許可します。 228 if( config.useEditName() ) { // 7.2.9.1 (2020/10/23) 229 rtnFlag = true; // 書込許可する。 230 } 231 // 6.2.4.0 (2015/05/15) 途中の状況表示用(ログメッセージ) 232 else { 233 logMsg = "gamenId=" + gamenId + " , editName=" + editName + "=" + viewClms ; 234 } 235 } 236 } 237 } 238 } 239 240 return rtnFlag; 241 } 242 243 /** 244 * 隠し属性タグを取得します。 245 * 246 * ※内部コール用 247 * 248 * @og.rev 3.0.1.2 (2003/03/07) forward.jsp の代替用 CommonForwardTag を新規作成 249 * @og.rev 3.1.7.0 (2003/05/02) 画面IDのセットで、自画面を、BACK_GAMENID 、飛び先を、GAMENID にする。 250 * @og.rev 3.1.8.0 (2003/05/16) BACK_GAMENID を、リクエスト情報ではなく、GUI.KEY を利用するように修正。 251 * @og.rev 3.5.5.5 (2004/04/23) hidden の出力に、XHTMLTag.hidden を使用します。 252 * @og.rev 3.8.8.2 (2007/01/26) hidden の出力に、GAMENID を使用します。 253 * @og.rev 5.5.4.2 (2012/07/13) editNameの出力を追加 254 * @og.rev 6.4.4.2 (2016/04/01) StringBuilderの代わりに、OgBuilderを使用する。 255 * @og.rev 6.4.5.2 (2016/05/06) UPLOADから呼ばれた場合は、HybsSystem.USE_UPLOAD_KEY="true" を hidden出力します。 256 * 257 * @return 隠し属性タグ 258 * @og.rtnNotNull 259 */ 260 private String getHiddenTag() { 261 262 final String requestURI = ((HttpServletRequest)getRequest()).getRequestURI(); 263 if( requestURI == null ) { 264 return ""; 265 } 266 267 final int index2 = requestURI.lastIndexOf( '/' ); 268 final String jspID = requestURI.substring( index2 + 1 ); 269 final String gamenId = getGUIInfoAttri( "KEY" ); // 4.0.0 (2005/01/31) 270 271 final boolean isUpload = Boolean.parseBoolean( getRequest().getParameter( HybsSystem.USE_UPLOAD_KEY ) ); // 6.4.5.2 (2016/05/06) 272 273 return new OgBuilder() 274 .append( XHTMLTag.hidden( "BACK_GAMENID", gamenId ) ) 275 .append( XHTMLTag.hidden( "BACK_JSPID" , jspID ) ) 276 .append( XHTMLTag.hidden( "GAMENID" , gamenId ) ) // 3.8.8.2 277 .appendIf( useEdit & outputEditName , "editName" , 278 key -> XHTMLTag.hidden( key ,getRequestValue( key ) ) ) 279 .appendIf( isUpload , HybsSystem.USE_UPLOAD_KEY , // 6.4.5.2 (2016/05/06) 280 key -> XHTMLTag.hidden( key ,"true" ) ) 281 .toString(); 282 } 283 284 /** 285 * 【TAG】GAMENID,BACK_GAMENID 属性を付加するかどうか[true/false]を設定します(初期値:true)。 286 * 287 * @og.tag 288 * "true"の場合は、BACK_GAMENID 、BACK_JSPID 属性を hidden で出力します。 289 * "false"の場合は、付加しません。 290 * これは、戻るリンクを作成する場合に利用されます。 291 * 初期値は、 "true"です。 292 * ボタンで遷移先がポップアップ画面の場合に、戻るリンクを出しても戻れない為、 293 * そのようなケースでは false にします。 294 * 295 * @og.rev 3.5.4.0 (2003/11/25) useGamenId のために、新規追加。 296 * 297 * @param flag 付加するかどうか [true:付加する/false:付加しない] 298 */ 299 public void setUseGamenId( final String flag ) { 300 useGamenId = nval( getRequestParameter( flag ),useGamenId ); 301 } 302 303 /** 304 * 【TAG】画面と別にロールズを与えます。 305 * 306 * @og.tag 307 * このロールズが与えられた場合は、画面のロールズではなく、 308 * 個別のロールズを使用して、表示の制御を行います。 309 * 310 * @og.rev 3.5.4.0 (2003/11/25) 新規追加。 311 * 312 * @param rols ロールズ 313 */ 314 public void setRoles( final String rols ) { 315 roles = nval( getRequestParameter( rols ),roles ); 316 } 317 318 /** 319 * 【TAG】書込可能か場合に許可するかどうか[true/false]を設定します(初期値:true)。 320 * 321 * @og.tag 322 * 書込許可する場合は、true、許可しない場合は、true 以外を設定します。 323 * デフォルト値は、互換性のため、true です。 324 * ここで、false を設定するとBODY部の内容は表示されません。true を設定した場合、 325 * 通常通り BODY 部は表示されます。 326 * これは、roles の簡易版として、外部から ON/OFF を制御するのに使用できます。 327 * 328 * @og.rev 3.8.5.1 (2006/05/08) 書込許可属性 writable 追加 329 * 330 * @param flag 書込許可 [true:許可/false:不可] 331 */ 332 public void setWritable( final String flag ) { 333 writable = nval( getRequestParameter( flag ),writable ); 334 } 335 336 /** 337 * 【TAG】読込可能な場合に許可するかどうか[true/false]を設定します(初期値:false)。 338 * 339 * @og.tag 340 * 読込許可する場合は、true、許可しない場合は、true 以外を設定します。 341 * デフォルト値は、false です。 342 * この属性を true に設定した状態で、画面が、isRead() == true の場合は 343 * 通常通り BODY 部は表示されます。 344 * 検索ボタンやファイルダウンロ―ロボタンのような、登録系SUBMIではないwriteCheck に使用します。 345 * 346 * @og.rev 8.1.0.1 (2022/01/07) 読込許可属性 readable 追加 347 * 348 * @param flag 読込許可 [true:許可/false:不可] 349 */ 350 public void setReadable( final String flag ) { 351 readable = nval( getRequestParameter( flag ),readable ); 352 } 353 354 /** 355 * 【TAG】EDITNAME利用時の編集を可能にするか設定します 356 * (初期値:USE_EDIT_WITH_EDITNAME[={@og.value SystemData#USE_EDIT_WITH_EDITNAME}])。 357 * 358 * @og.tag 359 * カラムの並び替えや表示等を設定した場合に編集可能にするかを設定します。 360 * (つまり、ボタンを出すかどうかをコントロールします) 361 * (初期値:USE_EDIT_WITH_EDITNAME[={@og.value SystemData#USE_EDIT_WITH_EDITNAME}])。 362 * 363 * @og.rev 5.5.4.2 (2012/07/13) 新規追加 364 * 365 * @param flag 編集許可 [true:する/false:しない] 366 * @see org.opengion.hayabusa.common.SystemData#USE_EDIT_WITH_EDITNAME 367 */ 368 public void setUseEdit( final String flag ) { 369 useEdit = nval( getRequestParameter( flag ), useEdit ); 370 } 371 372 /** 373 * 【TAG】editNameをhiddenタグで出力するか設定します 374 * (初期値:OUTPUT_EDITNAME[={@og.value SystemData#OUTPUT_EDITNAME}])。 375 * 376 * @og.tag 377 * 選択したeditNameを次の画面に送信するためのhiddenタグを出力します。 378 * editNameを次の画面に送信した場合は送信先画面のviewタグのviewFormTypeが 379 * 内部的に自動セットされるため注意が必要です。 380 * useEditがfalseの場合は出力しません。 381 * (初期値:OUTPUT_EDITNAME[={@og.value SystemData#OUTPUT_EDITNAME}])。 382 * 383 * @og.rev 5.5.4.2 (2012/07/13) 新規追加 384 * 385 * @param flag 編集名出力 [true:する/false:しない] 386 * @see org.opengion.hayabusa.common.SystemData#OUTPUT_EDITNAME 387 */ 388 public void setOutputEditName( final String flag ) { 389 outputEditName = nval( getRequestParameter( flag ), outputEditName ); 390 } 391 392 /** 393 * 【TAG】ダミーのinputタグ(display:none)を出力するか設定します(初期値:false)。 394 * 395 * @og.tag 396 * ダミーのinputタグ(display:none)を出力するか設定します。 397 * IEではinputが1つだけの場合にエンターでのsubmitが上手くいかないため、ダミーを配置する必要があります。 398 * trueに設定するとWriteCheckタグがダミーを(常に)出力します。 399 * (初期値:false)。 400 * 401 * @og.rev 5.6.1.0 (2013/02/01) 新規追加 402 * 403 * @param flag ダミー出力 [true:する/false:しない] 404 */ 405 public void setUseDummy( final String flag ) { 406 useDummy = nval( getRequestParameter( flag ), useDummy ); 407 } 408 409 /** 410 * このオブジェクトの文字列表現を返します。 411 * 基本的にデバッグ目的に使用します。 412 * 413 * @return このクラスの文字列表現 414 * @og.rtnNotNull 415 */ 416 @Override 417 public String toString() { 418 return ToString.title( this.getClass().getName() ) 419 .println( "VERSION" ,VERSION ) 420 .println( "useGamenId" ,useGamenId ) 421 .println( "writable" ,writable ) // 6.2.3.0 (2015/05/01) 422 .println( "readable" ,readable ) // 8.1.0.1 (2022/01/07) 423 // .println( "isWrite" ,isWrite() ) // 6.2.3.0 (2015/05/01) 424 .println( "isCheck" ,isCheck() ) // 6.2.3.0 (2015/05/01) 425 .println( "useTag" ,useTag() ) // 6.2.3.0 (2015/05/01) 426 .println( "roles" ,roles ) 427 .println( "logMsg" ,logMsg ) // 6.2.4.0 (2015/05/15) 428 .println( "Other..." ,getAttributes().getAttribute() ) 429 .fixForm().toString() ; 430 } 431}