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