EditRulePanel.java

Go to the documentation of this file.

/*
 * Autopsy
 *
 * Copyright 2019 Basis Technology Corp.
 * Contact: carrier <at> sleuthkit <dot> org
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.sleuthkit.autopsy.logicalimager.configuration;

import java.awt.BorderLayout;
import java.awt.Color;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import javax.swing.JButton;
import javax.swing.JPanel;
import javax.swing.JTextArea;
import javax.swing.text.JTextComponent;
import static org.apache.commons.lang.StringUtils.isBlank;
import static org.apache.commons.lang3.StringUtils.strip;
import org.apache.commons.lang3.tuple.ImmutablePair;
import org.openide.util.NbBundle;
import org.sleuthkit.autopsy.corecomponents.TextPrompt;

final class EditRulePanel extends JPanel {

    private static final long serialVersionUID = 1L;
    private final EditFullPathsRulePanel editFullPathsRulePanel;
    private final EditNonFullPathsRulePanel editNonFullPathsRulePanel;

    EditRulePanel(JButton okButton, JButton cancelButton, String ruleName, LogicalImagerRule rule) {
        if (rule.getFullPaths() != null && rule.getFullPaths().size() > 0) {
            editFullPathsRulePanel = new EditFullPathsRulePanel(okButton, cancelButton, ruleName, rule, true);
            editNonFullPathsRulePanel = null;
        } else {
            editNonFullPathsRulePanel = new EditNonFullPathsRulePanel(okButton, cancelButton, ruleName, rule, true);
            editFullPathsRulePanel = null;
        }
    }

    JPanel getPanel() {
        if (editFullPathsRulePanel != null) {
            return editFullPathsRulePanel;
        } else {
            return editNonFullPathsRulePanel;
        }
    }

    ImmutablePair<String, LogicalImagerRule> toRule() throws IOException, NumberFormatException {
        ImmutablePair<String, LogicalImagerRule> ruleMap;
        if (editFullPathsRulePanel != null) {
            ruleMap = editFullPathsRulePanel.toRule();
        } else {
            ruleMap = editNonFullPathsRulePanel.toRule();
        }
        return ruleMap;
    }

    static void setTextFieldPrompts(JTextComponent textField, String text) {
        TextPrompt textPrompt;
        if (textField instanceof JTextArea) {
            textPrompt = new TextPrompt(text, textField, BorderLayout.NORTH);
        } else {
            textPrompt = new TextPrompt(text, textField);
        }

        textPrompt.setForeground(Color.LIGHT_GRAY);
        textPrompt.changeAlpha(0.9f); // Mostly opaque
    }

    @NbBundle.Messages({
        "EditRulePanel.emptyRuleName.message=Rule name cannot be empty",
        "# {0} - ruleName",
        "EditRulePanel.reservedRuleName.message=Rule name \"{0}\" is reserved for use with a predefined rule"})
    static String validRuleName(String name) throws IOException {
        if (name.isEmpty()) {
            throw new IOException(Bundle.EditRulePanel_emptyRuleName_message());
        }
        if (name.equals(EncryptionProgramsRule.getName())) {
            throw new IOException(Bundle.EditRulePanel_reservedRuleName_message(name));
        }
        //TODO JIRA-5239 check if rule name exists already
        return name;
    }

    @NbBundle.Messages({
        "# {0} - fieldName",
        "EditRulePanel.blankLineException={0} cannot have a blank line",})
    static List<String> validateTextList(JTextArea textArea, String fieldName) throws IOException {
        if (isBlank(textArea.getText())) {
            return null;
        }
        List<String> list = new ArrayList<>();
        for (String line : textArea.getText().split("\\n")) { // NON-NLS
            String strippedLine = strip(line);
            if (strippedLine.isEmpty()) {
                throw new IOException(Bundle.EditRulePanel_blankLineException(fieldName));
            }
            list.add(strippedLine);
        }
        if (list.isEmpty()) {
            return null;
        }
        return list;
    }

}