BitFlagsRightsEditor.java
/*
** Module : BitFlagsRightsEditor.java
** Abstract : BitFlagsRights GWT editor implementation.
**
** Copyright (c) 2017-2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- --------------------------------Description-----------------------------------
** 001 GES 20200116 Initial version based on NetRightsEditor.
** 002 HC 20230427 Added support for file system rights.
*/
/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 of the
** License, or (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
**
** Additional terms under GNU Affero GPL version 3 section 7:
**
** Under Section 7 of the GNU Affero GPL version 3, the following additional
** terms apply to the works covered under the License. These additional terms
** are non-permissive additional terms allowed under Section 7 of the GNU
** Affero GPL version 3 and may not be removed by you.
**
** 0. Attribution Requirement.
**
** You must preserve all legal notices or author attributions in the covered
** work or Appropriate Legal Notices displayed by works containing the covered
** work. You may not remove from the covered work any author or developer
** credit already included within the covered work.
**
** 1. No License To Use Trademarks.
**
** This license does not grant any license or rights to use the trademarks
** Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
** of Golden Code Development Corporation. You are not authorized to use the
** name Golden Code, FWD, or the names of any author or contributor, for
** publicity purposes without written authorization.
**
** 2. No Misrepresentation of Affiliation.
**
** You may not represent yourself as Golden Code Development Corporation or FWD.
**
** You may not represent yourself for publicity purposes as associated with
** Golden Code Development Corporation, FWD, or any author or contributor to
** the covered work, without written authorization.
**
** 3. No Misrepresentation of Source or Origin.
**
** You may not represent the covered work as solely your work. All modified
** versions of the covered work must be marked in a reasonable way to make it
** clear that the modified work is not originating from Golden Code Development
** Corporation or FWD. All modified versions must contain the notices of
** attribution required in this license.
*/
package com.goldencode.p2j.admin.client.editors;
import com.goldencode.p2j.admin.client.widget.dialog.*;
import com.goldencode.p2j.admin.client.widget.dialog.InputDialog.*;
import com.goldencode.p2j.security.Description;
import com.goldencode.p2j.security.*;
import org.gwtbootstrap3.client.ui.*;
import java.util.function.*;
/**
* {@code BitFlagsRights} GWT editor.
*/
public class BitFlagsRightsEditor
implements RightsEditor,
BitFlagsConstants
{
/** Whether the execute bit is enabled */
private final boolean enableExecuteBit;
/** Description array. */
private Description[] description;
/**
* Returns the resource type name this editor is capable to edit.
*
* @return The type name for the resource.
*/
public static String getResourceType()
{
return "bitFlags";
}
/**
* Default constructor.
*/
public BitFlagsRightsEditor()
{
enableExecuteBit = false;
}
/**
* Constructor, which allows to enable editing of the execute bit.
*
* @param enableExecuteBit
* Set to {@code true} to enable the execute bit.
*/
public BitFlagsRightsEditor(boolean enableExecuteBit)
{
this.enableExecuteBit = enableExecuteBit;
}
/**
* Gives a chance to editors to initialize their data structures.
* <p>
* This is a one time call for this kind of resource for the life time of the admin session.
*
* @param description
* The rights structure description.
*/
@Override
public void initialize(Description[] description)
{
this.description = description;
}
/**
* Creates an instance of the <code>Rights</code>, which does not take any input and is
* considered a default starting point in editing.
*
* @return An instance of <code>Rights</code>.
*/
@Override
public Rights createDefaultRights()
{
return new BitFlagsRights();
}
/**
* Edits the given instance of the <code>Rights</code>.
* <p>
* The implementation should prepare its modal dialog using the initial state from the passed
* instance of the <code>Rights</code>, show the dialog, provide event processing until the
* Save or Cancel action is applied, then hide the dialog and return the appropriate result.
*
* @param name
* name of the resource instance being edited
* @param exact
* nature of the name
* @param rights
* instance of <code>Rights</code> to be edited
* @param submitHandler
* Submit handler.
* @param cancelHandler
* Cancel handler.
*/
@Override
public void edit(String name,
boolean exact,
Rights rights,
Consumer<Rights> submitHandler,
Runnable cancelHandler)
{
String[] bitNames = description[0].getBitNames();
BitSet perms = ((BitFlagsRights) rights).getPermissions();
boolean denied = perms.isSet(BIT_DENIED_ACCESS);
RightsEditorContext ctxt = RightsEditorContext.instance();
InputDialog dlg = ctxt.getInputDialog();
Field[] fields = new Field[enableExecuteBit ? 6 : 5];
int i = 0;
// 1st row - Create permission
Field fCreate = new Field("C (" + bitNames[i] + ")",
perms.isSet(BIT_CREATE_ACCESS) && !denied)
.withTooltip("allows creation of a new resource instance");
fields[i++] = fCreate;
// 2nd row - Delete permission
Field fDelete = new Field("D (" + bitNames[i] + ")",
perms.isSet(BIT_DELETE_ACCESS) && !denied)
.withTooltip("allows deletion of an existing resource instance");
fields[i++] = fDelete;
// 3rd row - Read permission
Field fRead = new Field("R (" + bitNames[i] + ")",
perms.isSet(BIT_READ_ACCESS) && !denied)
.withTooltip("allows access, including reading the state/data");
fields[i++] = fRead;
// 4th row - Write permission
Field fWrite = new Field("W (" + bitNames[i] + ")",
perms.isSet(BIT_WRITE_ACCESS) && !denied)
.withTooltip("allows changing state and/or data");
fields[i++] = fWrite;
// Execute permission
Field fExecute;
if (enableExecuteBit)
{
fExecute = new Field("X (" + bitNames[i] + ")",
perms.isSet(FileSystemResource.BIT_EXECUTE_ACCESS) && !denied)
.withTooltip("allows execution of an existing resource instance");
fields[i++] = fExecute;
}
else
{
fExecute = null;
}
// Denied access
Field fDenied = new Field("N (" + bitNames[i] + ")", denied)
.withTooltip("denies any and all access");
fields[i] = fDenied;
dlg.build(getTitle(), fields);
CheckBox createBox = (CheckBox) dlg.getWidget(fCreate);
CheckBox deleteBox = (CheckBox) dlg.getWidget(fDelete);
CheckBox readBox = (CheckBox) dlg.getWidget(fRead);
CheckBox writeBox = (CheckBox) dlg.getWidget(fWrite);
CheckBox executeBox = enableExecuteBit ? (CheckBox) dlg.getWidget(fExecute) : null;
CheckBox deniedBox = (CheckBox) dlg.getWidget(fDenied);
Consumer<Boolean> updateBoxes = val ->
{
createBox.setEnabled(val);
deleteBox.setEnabled(val);
readBox.setEnabled(val);
writeBox.setEnabled(val);
if (executeBox != null)
{
executeBox.setEnabled(val);
}
};
updateBoxes.accept(!denied);
deniedBox.addValueChangeHandler(event ->
{
boolean val = event.getValue();
updateBoxes.accept(!val);
});
dlg.show(ctxt.getParent(), vals ->
{
if (vals != null)
{
boolean createVal = (Boolean) vals.get(fCreate);
boolean deleteVal = (Boolean) vals.get(fDelete);
boolean readVal = (Boolean) vals.get(fRead);
boolean writeVal = (Boolean) vals.get(fWrite);
boolean deniedVal = (Boolean) vals.get(fDenied);
boolean executeVal = enableExecuteBit && (Boolean) vals.get(fExecute);
perms.set(BIT_CREATE_ACCESS, createVal && !deniedVal);
perms.set(BIT_DELETE_ACCESS, deleteVal && !deniedVal);
perms.set(BIT_READ_ACCESS, readVal && !deniedVal);
perms.set(BIT_WRITE_ACCESS, writeVal && !deniedVal);
perms.set(BIT_DENIED_ACCESS, deniedVal);
if (enableExecuteBit)
{
perms.set(FileSystemResource.BIT_EXECUTE_ACCESS, executeVal && !deniedVal);
}
submitHandler.accept(createPopulatedRights(perms));
}
else
{
cancelHandler.run();
}
});
}
/**
* Creates an instance of the <code>Rights</code> configured using the given input.
*
* @param perms
* The permissions.
*
* @return An instance of <code>Rights</code>.
*/
protected Rights createPopulatedRights(BitSet perms)
{
return new BitFlagsRights(perms);
}
/**
* Obtains the window title for the editor.
*
* @return The title.
*/
protected String getTitle()
{
return "BitFlags Rights";
}
}