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