Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add a 'remove ruleset' button on preference page #466

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Add a 'remove ruleset' button on preference page #466

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions plugins/de.cognicrypt.core/src/de/cognicrypt/utils/UIUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,15 @@

import org.eclipse.core.resources.IFile;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Font;
import org.eclipse.swt.graphics.FontData;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.layout.RowData;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Group;
import org.eclipse.swt.widgets.Label;
import org.eclipse.ui.IEditorInput;
import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.IWorkbenchPage;
Expand All @@ -17,11 +22,25 @@
public class UIUtils {

public static Group addHeaderGroup(Composite parent, String text) {
parent.setLayout(new GridLayout(1,true));
final Group headerGroup = new Group(parent, SWT.SHADOW_IN);
headerGroup.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
headerGroup.setText(text);
headerGroup.setLayout(new GridLayout(1, true));
return headerGroup;
}

public static Label createHeadline(final Composite parent, String text) {
final Label label = new Label(parent, SWT.WRAP);
final GridData gd = new GridData(GridData.FILL_HORIZONTAL);
gd.widthHint = 1; //otherwise the wizard window will extend in width
label.setLayoutData(gd);
label.setText(text);
final Font boldFont = new Font(Display.getCurrent(), new FontData( "Arial", 12, SWT.BOLD ));
label.setFont(boldFont);
boldFont.dispose();
return label;
}

protected static void setWindow(final IWorkbenchWindow activeWorkbenchWindow) {
Utils.window = activeWorkbenchWindow;
Expand Down
169 changes: 119 additions & 50 deletions ...cognicrypt.staticanalyzer/src/de/cognicrypt/staticanalyzer/StaticAnalyzerPreferences.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,29 @@
import java.util.List;
import org.eclipse.core.runtime.preferences.InstanceScope;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.jface.layout.TableColumnLayout;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.viewers.CheckboxTableViewer;
import org.eclipse.jface.viewers.ColumnWeightData;
import org.eclipse.jface.viewers.TableViewerColumn;
import org.eclipse.jface.window.Window;
import org.eclipse.swt.SWT;
import org.eclipse.swt.custom.CCombo;
import org.eclipse.swt.custom.TableEditor;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.layout.RowLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Combo;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Group;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.swt.widgets.Table;
import org.eclipse.swt.widgets.TableColumn;
import org.eclipse.swt.widgets.TableItem;
import org.eclipse.ui.IWorkbenchWindow;
import org.eclipse.ui.PlatformUI;
Expand All @@ -40,6 +46,7 @@
import de.cognicrypt.core.properties.PreferenceListener;
import de.cognicrypt.staticanalyzer.utilities.RemoteRulesetDialog;
import de.cognicrypt.staticanalyzer.utilities.ArtifactUtils;
import de.cognicrypt.staticanalyzer.utilities.DefaultRulePreferences;
import de.cognicrypt.staticanalyzer.utilities.LocalRulesetDialog;
import de.cognicrypt.staticanalyzer.utilities.Ruleset;
import de.cognicrypt.utils.CrySLUtils;
Expand All @@ -50,6 +57,10 @@ public class StaticAnalyzerPreferences extends PreferenceListener {
private IPreferenceStore preferences = Activator.getDefault().getPreferenceStore();
private Preferences rulePreferences = InstanceScope.INSTANCE.getNode(de.cognicrypt.core.Activator.PLUGIN_ID);

private Composite parent;
private Group staticAnalysisGroup;

private Composite tableContainer;
private CheckboxTableViewer table;
private Button automatedAnalysisCheckBox;
private Button providerDetectionCheckBox;
Expand All @@ -75,13 +86,15 @@ public class StaticAnalyzerPreferences extends PreferenceListener {

@Override
public void compileBasicPreferences(Composite parent) {
this.parent = parent;
createBasicContents(parent);
performBasicDefaults();
initializeBasicValues();
}

@Override
public void compileAdvancedPreferences(Composite parent) {
parent.setLayout(new GridLayout(1,true));
createAdvancedContents(parent);
performAdvancedDefaults();
initializeAdvancedValues();
Expand Down Expand Up @@ -119,10 +132,10 @@ private void createRulesTableRow(Ruleset ruleset) {

TableEditor editor = new TableEditor(table.getTable());
TableItem rulesRow = new TableItem(table.getTable(), SWT.NONE);
rulesRow.setText(0, ruleset.getFolderName());
rulesRow.setText(1, ruleset.getFolderName());
editor.grabHorizontal = true;
editor.setEditor(ruleset.getVersions(), rulesRow, 1);
rulesRow.setText(2, ruleset.getUrlOrPath());
editor.setEditor(ruleset.getVersions(), rulesRow, 2);
rulesRow.setText(3, ruleset.getUrlOrPath());
rulesRow.setChecked(ruleset.isChecked());
ruleset.setRulesRow(rulesRow);
}
Expand Down Expand Up @@ -173,18 +186,23 @@ private List<Ruleset> getRulesetsFromPrefs() {
* This method creates a table with check boxes for the CrySL rule sets.
*/
private void createRulesTable() {
if(table != null) {
table.getTable().dispose();
}
table = CheckboxTableViewer.newCheckList(tableContainer, SWT.CHECK);
table.getTable().setLayoutData(new GridData(GridData.FILL_BOTH));
table.getTable().setHeaderVisible(true);
table.getTable().setLinesVisible(true);

TableViewerColumn checkBoxColumn = new TableViewerColumn(table, SWT.WRAP);
checkBoxColumn.getColumn().setResizable(false);
TableViewerColumn rulesColumn = new TableViewerColumn(table, SWT.FILL);
TableViewerColumn versionsColumn = new TableViewerColumn(table, SWT.FILL);
TableViewerColumn rulesURLOrPath = new TableViewerColumn(table, SWT.FILL);
rulesColumn.getColumn().setText(Constants.TABLE_HEADER_RULES);
versionsColumn.getColumn().setText(Constants.TABLE_HEADER_VERSION);
rulesURLOrPath.getColumn().setText(Constants.TABLE_HEADER_URL);
rulesColumn.getColumn().setWidth(200);
versionsColumn.getColumn().setWidth(100);
rulesURLOrPath.getColumn().setWidth(200);

listOfRulesets = getRulesetsFromPrefs();


//remove BC-JCA provider ruleset from ruleset's table to not have conflict with JCA ruleset
for (Ruleset ruleset : listOfRulesets) {
if (ruleset.getFolderName().equals("BouncyCastle-JCA")) {
Expand Down Expand Up @@ -213,6 +231,15 @@ public void widgetSelected(SelectionEvent e) {
}
});
}


rulesColumn.getColumn().pack();
versionsColumn.getColumn().pack();
rulesURLOrPath.getColumn().pack();

table.getTable().pack();
staticAnalysisGroup.pack();

}

/***
Expand Down Expand Up @@ -251,34 +278,31 @@ public void widgetSelected(SelectionEvent e) {
* @param parent Instance of the eclipse preference window on which UI widgets for CogniCrypt are added.
*/
private void createBasicContents(Composite parent) {
final Group staticAnalysisGroup = UIUtils.addHeaderGroup(parent, "Analysis");

final Composite source = new Composite(staticAnalysisGroup, SWT.FILL);
source.setLayout(new GridLayout(3, true));
final Label ruleSource = new Label(source, SWT.NONE);
ruleSource.setText("Source of CrySL Rules: ");

table = CheckboxTableViewer.newCheckList(staticAnalysisGroup, SWT.CHECK);
table.getTable().setHeaderVisible(true);
table.getTable().setLinesVisible(true);
listOfRulesets = getRulesetsFromPrefs(); //load rules

staticAnalysisGroup = UIUtils.addHeaderGroup(parent, "Analysis");

//final Composite source = new Composite(staticAnalysisGroup, SWT.FILL);
//source.setLayout(new GridLayout(3, true));
//final Label ruleSource = new Label(source, SWT.NONE);
//ruleSource.setText("Source of CrySL Rules: ");
UIUtils.createHeadline(staticAnalysisGroup, "Source of CrySL Rules");

tableContainer = new Composite(staticAnalysisGroup, SWT.FILL);
GridData gd = new GridData(GridData.FILL_HORIZONTAL);
gd.heightHint = 100;
gd.widthHint = 400;
gd.minimumWidth = 400;
tableContainer.setLayoutData(gd);
tableContainer.setLayout(new GridLayout(1,true));
createRulesTable();
table.getTable().addSelectionListener(new SelectionAdapter() {
@Override
public void widgetSelected(SelectionEvent e) {
super.widgetSelected(e);
if (e.detail == SWT.CHECK) {
TableItem item = (TableItem) e.item;

for (Iterator<Ruleset> itr = listOfRulesets.iterator(); itr.hasNext();) {
Ruleset ruleset = (Ruleset) itr.next();
if (item.getText(0) == ruleset.getFolderName())
ruleset.setChecked(item.getChecked());
}
}
}
});

addNewRemoteRulesetButton = new Button(staticAnalysisGroup, SWT.PUSH);


Composite buttons = new Composite(staticAnalysisGroup, SWT.NONE);
buttons.setLayout(new RowLayout());

addNewRemoteRulesetButton = new Button(buttons, SWT.PUSH);
addNewRemoteRulesetButton.setText("Add Remote Ruleset");
addNewRemoteRulesetButton.addListener(SWT.Selection, new Listener() {

Expand All @@ -288,7 +312,7 @@ public void handleEvent(Event e) {
}
});

addNewLocalRulesetButton = new Button(staticAnalysisGroup, SWT.PUSH);
addNewLocalRulesetButton = new Button(buttons, SWT.PUSH);
addNewLocalRulesetButton.setText("Add Local Ruleset");
addNewLocalRulesetButton.addListener(SWT.Selection, new Listener() {

Expand All @@ -298,6 +322,21 @@ public void handleEvent(Event e) {
}
});

Button removeRulesetButton = new Button(buttons, SWT.PUSH);
removeRulesetButton.setText("Remove Selected Ruleset");
removeRulesetButton.addListener(SWT.Selection, new Listener() {

@Override
public void handleEvent(Event e) {
int index = ((Table) tableContainer.getChildren()[0]).getSelectionIndex();
if(index >= 0 && index < listOfRulesets.size()) {
listOfRulesets.remove(index);
createRulesTable();

}
}
});

selectCustomRulesCheckBox = new Button(staticAnalysisGroup, SWT.CHECK);
selectCustomRulesCheckBox.setText("Select Custom Rules");

Expand Down Expand Up @@ -495,26 +534,15 @@ private void createAdvancedContents(Composite parent) {
*/
@Override
public void setDefaultValues() {

selectCustomRulesCheckBox.setSelection(preferences.getDefaultBoolean(Constants.SELECT_CUSTOM_RULES));
analyzedProjectRootDirRules.setSelection(preferences.getDefaultBoolean(Constants.ANALYZED_PROJECT_DIR_RULES));
automatedAnalysisCheckBox.setSelection(preferences.getDefaultBoolean(Constants.AUTOMATED_ANALYSIS));
providerDetectionCheckBox.setSelection(preferences.getDefaultBoolean(Constants.PROVIDER_DETECTION_ANALYSIS));
secureObjectsCheckBox.setSelection(preferences.getDefaultBoolean(Constants.SHOW_SECURE_OBJECTS));
analyseDependenciesCheckBox.setSelection(preferences.getDefaultBoolean(Constants.ANALYSE_DEPENDENCIES));

if(removeNonDefaultRulesets()) {
createRulesTable();
}
for (Iterator<Ruleset> itr = listOfRulesets.iterator(); itr.hasNext();) {
Ruleset ruleset = (Ruleset) itr.next();
ruleset.getVersions().select(ruleset.getVersions().getItemCount() - 1);
if (ruleset.getFolderName().equals("JavaCryptographicArchitecture"))
ruleset.getRulesRow().setChecked(true);
else
ruleset.getRulesRow().setChecked(false);
ruleset.setSelectedVersion(ruleset.getVersions().getItem(ruleset.getVersions().getItemCount() - 1));
ruleset.setChecked(ruleset.getRulesRow().getChecked());
}
storeAndSetDefaultRulesets();

CGSelection.select(preferences.getDefaultInt(Constants.CALL_GRAPH_SELECTION));
forbidden.select(preferences.getDefaultInt(Constants.FORBIDDEN_METHOD_MARKER_TYPE));
Expand All @@ -526,11 +554,48 @@ public void setDefaultValues() {
suppressLegacyClientErrorsCheckBox.setSelection(preferences.getDefaultBoolean(Constants.SUPPRESS_LEGACYCLIENT_ERRORS));
}

private void clearRulePreferences() {
try {
for(String key: rulePreferences.childrenNames()) {
Preferences subPref = rulePreferences.node(key);
subPref.removeNode();
}
} catch (BackingStoreException e) {
e.printStackTrace();
}
}

private void storeAndSetDefaultRulesets() {
// store default rulesets in preferences
clearRulePreferences();
DefaultRulePreferences.addDefaults();
listOfRulesets = getRulesetsFromPrefs();

// update gui
createRulesTable();

// default selection
listOfRulesets.forEach((ruleset) -> {
// only JCA should be checked
if(ruleset.getFolderName().equals("JavaCryptographicArchitecture")) {
ruleset.getRulesRow().setChecked(true);
ruleset.setChecked(true);
}
else {
ruleset.getRulesRow().setChecked(false);
ruleset.setChecked(false);
}
// select latest version
ruleset.getVersions().select(ruleset.getVersions().getItemCount() - 1);
ruleset.setSelectedVersion(ruleset.getVersions().getItem(ruleset.getVersions().getItemCount() - 1));
});
}

/***
* This method removes all rulesets that are not default from the {@link #rulePreferences} field
* and retains only the default ones of JCA, BC-JCA, BC, and Tink. It also returns a boolean of
* whether any non default ruleset was removed.
*/

private boolean removeNonDefaultRulesets() {
boolean areNonDefaultRulesets = true;
try {
Expand All @@ -549,6 +614,7 @@ private boolean removeNonDefaultRulesets() {
}
return areNonDefaultRulesets;
}
*/

/**
* This method assign the selected values for each of the preference page options and is invoked when 'Apply'
Expand All @@ -571,6 +637,9 @@ protected void storeValues() {
preferences.setValue(Constants.TYPESTATE_ERROR_MARKER_TYPE, typestate.getSelectionIndex());
preferences.setValue(Constants.SUPPRESS_LEGACYCLIENT_ERRORS, suppressLegacyClientErrorsCheckBox.getSelection());


clearRulePreferences();

for (Iterator<Ruleset> itr = listOfRulesets.iterator(); itr.hasNext();) {
Ruleset ruleset = (Ruleset) itr.next();

Expand Down