GitGrepSearchPage.java

package com.proalpha.pds.gitutils.search;
 
import java.awt.Desktop;
import java.io.File;
import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.ArrayList;
import java.util.List;
 
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.egit.ui.internal.repository.RepositoriesViewContentProvider;
import org.eclipse.egit.ui.internal.repository.RepositoryTreeNodeLabelProvider;
import org.eclipse.egit.ui.internal.repository.tree.RepositoryNode;
import org.eclipse.jface.dialogs.Dialog;
import org.eclipse.jface.dialogs.DialogPage;
import org.eclipse.jface.dialogs.IDialogSettings;
import org.eclipse.jface.layout.GridDataFactory;
import org.eclipse.jface.layout.GridLayoutFactory;
import org.eclipse.jface.viewers.CheckboxTableViewer;
import org.eclipse.search.ui.ISearchPage;
import org.eclipse.search.ui.ISearchPageContainer;
import org.eclipse.search.ui.NewSearchUI;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Combo;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Group;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Spinner;
import org.eclipse.swt.widgets.Text;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
 
import com.proalpha.pds.gitutils.Activator;
 
public class GitGrepSearchPage extends DialogPage implements ISearchPage {
 
    private final Logger logger = LoggerFactory.getLogger(GitGrepSearchPage.class);
 
    private static final String PAGE_NAME = "pAGitGrepSearchPage";
    private static final String HISTORY_STORE = "HISTORY";
    private static final int HISTORY_SIZE = 1;
 
    private Text txtMatchesFile;
    private Spinner txtMaxFinds;
    private Button btnCaseSensitive;
    private Combo cmbObjectType;
    private CheckboxTableViewer repositoryViewer;
    private ISearchPageContainer container;
 
    private List<GitGrepSearchSettings> savedSettings = new ArrayList<>(HISTORY_SIZE);
    private Combo cmbSearchPhrase;
 
    @SuppressWarnings("restriction")
    @Override
    public void createControl(Composite parent) {
        loadSettings();
 
        Composite main = new Composite(parent, SWT.NONE);
        main.setLayout(new GridLayout(2, false));
 
        Label lblContainingText = new Label(main, SWT.NONE);
        lblContainingText.setText("Containing text:");
        new Label(main, SWT.NONE);
        cmbSearchPhrase = new Combo(main, SWT.SINGLE | SWT.BORDER);
        GridData gdCmbSearchPhrase = new GridData(GridData.FILL, GridData.FILL, true, false, 1, 1);
        gdCmbSearchPhrase.widthHint = convertWidthInCharsToPixels(10);
        cmbSearchPhrase.setLayoutData(gdCmbSearchPhrase);
        cmbSearchPhrase.setFocus();
 
        cmbSearchPhrase.addModifyListener(event -> 
                checkOK()
        );
 
        btnCaseSensitive = new Button(main, SWT.CHECK);
        btnCaseSensitive.setText("Case sensitive");
 
        Label lblHint = new Label(main, SWT.NONE);
        lblHint.setText("(* = any string, ? = any character, \\\\ = escape for literals: * ? \\\\)");
 
        Button help = new Button(main, SWT.NONE);
        help.setText("Git Search Help");
        help.addListener(SWT.Selection, event -> {
            if (event.type == SWT.Selection && Desktop.isDesktopSupported()) {
                try {
                    Desktop.getDesktop().browse(new URI("https://git-scm.com/docs/git-grep"));
                } catch (IOException | URISyntaxException e) {
                    logger.error("Error occured while opening git grep help", e);
                }
            }
        });
 
        Group grpScope = new Group(main, SWT.NONE);
        GridData gdGrpScope = new GridData(SWT.LEFT, SWT.CENTER, false, false, 1, 1);
        gdGrpScope.heightHint = 77;
        gdGrpScope.widthHint = 475;
        grpScope.setLayoutData(gdGrpScope);
        grpScope.setText("Scope");
 
        Label lblMatchesFile = new Label(grpScope, SWT.NONE);
        lblMatchesFile.setBounds(10, 18, 122, 15);
        lblMatchesFile.setText("Objectpath:");
 
        txtMatchesFile = new Text(grpScope, SWT.BORDER);
        txtMatchesFile.setBounds(139, 15, 150, 21);
        txtMatchesFile.setText("**/*.*");
 
        Label lblObjecttype = new Label(grpScope, SWT.NONE);
        lblObjecttype.setBounds(10, 44, 70, 15);
        lblObjecttype.setText("Objecttype:");
 
        cmbObjectType = new Combo(grpScope, SWT.NONE);
        cmbObjectType.setItems(new String[] { "ALL", "PDI", "SRC", "SRC_PDI" });
        cmbObjectType.setBounds(139, 41, 60, 23);
        cmbObjectType.setText("ALL");
 
        Label lblMaxfinds = new Label(grpScope, SWT.NONE);
        lblMaxfinds.setBounds(10, 70, 100, 15);
        lblMaxfinds.setText("Maxfinds (1 - 999):");
 
        txtMaxFinds = new Spinner(grpScope, SWT.BORDER);
        txtMaxFinds.setBounds(139, 67, 40, 21);
        txtMaxFinds.setSize(50, 20);
        txtMaxFinds.setValues(100, 1,999,0,50, 100);
        txtMaxFinds.addListener(SWT.Modify, event -> {
            try {
                if (Integer.parseInt(txtMaxFinds.getText()) > txtMaxFinds.getMaximum())
                    txtMaxFinds.setSelection(txtMaxFinds.getMaximum());
                else if (Integer.parseInt(txtMaxFinds.getText()) < txtMaxFinds.getMinimum())
                    txtMaxFinds.setSelection(txtMaxFinds.getMinimum());
            }
            catch (NumberFormatException e) {
                txtMaxFinds.setSelection(txtMaxFinds.getMinimum());
            }
        });
        new Label(main, SWT.NONE);
 
        Group repositoryGroup;
        repositoryGroup = new Group(main, SWT.NONE);
        repositoryGroup.setBackgroundMode(SWT.INHERIT_DEFAULT);
        GridDataFactory.fillDefaults().grab(true, true).span(2, 1).applyTo(repositoryGroup);
        GridLayoutFactory.swtDefaults().numColumns(2).applyTo(repositoryGroup);
 
        this.repositoryViewer = CheckboxTableViewer.newCheckList(repositoryGroup,
                SWT.SINGLE | SWT.V_SCROLL | SWT.H_SCROLL | SWT.BORDER);
        this.repositoryViewer.setLabelProvider(new RepositoryTreeNodeLabelProvider());
        this.repositoryViewer.setContentProvider(new RepositoriesViewContentProvider());
        this.repositoryViewer.setInput(ResourcesPlugin.getWorkspace().getRoot());
        this.repositoryViewer.addCheckStateListener(event -> {
            repositoryViewer.setAllChecked(false);
            repositoryViewer.setChecked(event.getElement(), true);
            checkOK();
        });
 
        GridDataFactory.fillDefaults().grab(true, true).hint(SWT.DEFAULT, 135)
                .applyTo(this.repositoryViewer.getControl());
 
        repositoryGroup.setText("Repositories:");
 
        setControl(main);
        Dialog.applyDialogFont(main);
 
    }
 
    @SuppressWarnings("restriction")
    @Override
    public boolean performAction() {
 
        GitGrepSearchSettings searchSettings = new GitGrepSearchSettings();
 
        if (txtMatchesFile.getText().length() > 0)
            searchSettings.setFileNamePhrase(txtMatchesFile.getText());
 
        searchSettings.setTextPhrase(cmbSearchPhrase.getText());
        searchSettings.setFileType(cmbObjectType.getText());
        searchSettings.setCaseSensitive(btnCaseSensitive.getSelection());
        searchSettings.setMaxFinds(Integer.parseInt(txtMaxFinds.getText()));
 
        for (Object checkedElement : repositoryViewer.getCheckedElements()) {
            try {
                searchSettings.setRepositoryPath(
                        ((RepositoryNode) checkedElement).getRepository().getDirectory().getAbsolutePath());
                searchSettings.setBranchName(((RepositoryNode) checkedElement).getRepository().getBranch());
            } catch (IOException e) {
                logger.error(e.getMessage(), e);
            }
        }
 
        // Add settings to History
        savedSettings.add(0, searchSettings);
 
        GitGrepSearchQuery newQuery = new GitGrepSearchQuery(searchSettings);
        NewSearchUI.runQueryInBackground(newQuery);
 
        return true;
    }
 
    @Override
    public void setContainer(ISearchPageContainer container) {
        this.container = container;
    }
 
    private ISearchPageContainer getContainer() {
        return this.container;
    }
 
    @Override
    public void dispose() {
        storeSettings();
        super.dispose();
    }
 
    @Override
    public void setVisible(boolean visible) {
        if (visible) {
            cmbSearchPhrase.setItems(getSavedSearchPhrases());
            cmbSearchPhrase.setText(savedSettings.get(0).getTextPhrase());
            txtMatchesFile.setText(savedSettings.get(0).getFileNamePhrase());
            txtMaxFinds.setSelection(savedSettings.get(0).getMaxFinds());
            btnCaseSensitive.setSelection(savedSettings.get(0).isCaseSensitive());
            cmbObjectType.setText(savedSettings.get(0).getFileType());
            File file = new File(savedSettings.get(0).getRepositoryPath());
            if (file.exists())
                try {
                    @SuppressWarnings("restriction")
                    RepositoryNode node = new RepositoryNode(null,
                            org.eclipse.egit.core.Activator.getDefault().getRepositoryCache().lookupRepository(file));
                    repositoryViewer.setChecked(node, true);
                } catch (IOException ignore) {
                    // Ignore and don't check
                }
 
            checkOK();
        }
 
        super.setVisible(visible);
    }
 
    private String[] getSavedSearchPhrases() {
 
        int size = savedSettings.size();
        String[] testPhrases = new String[size];
        for (int iCount = 0; iCount < size; iCount++)
            testPhrases[iCount] = savedSettings.get(iCount).getTextPhrase();
 
        return testPhrases;
 
    }
 
    private void checkOK() {
 
        boolean isOk = false;
        if (cmbSearchPhrase.getText().length() > 0 && repositoryViewer.getCheckedElements().length > 0)
            isOk = true;
 
        getContainer().setPerformActionEnabled(isOk);
 
    }
 
    private IDialogSettings getDialogSettings() {
 
        IDialogSettings dialogSettings = Activator.getDefault().getDialogSettings();
        IDialogSettings section = dialogSettings.getSection(PAGE_NAME);
        if (section == null)
            section = dialogSettings.addNewSection(PAGE_NAME);
        return section;
 
    }
 
    private void storeSettings() {
 
        int minSize = Math.min(savedSettings.size(), HISTORY_SIZE);
 
        IDialogSettings ds = getDialogSettings();
        ds.put("HISTORY_SIZE", minSize);
 
        for (int iCount = 0; iCount < minSize; iCount++)
            savedSettings.get(iCount).save(ds.addNewSection(HISTORY_STORE + iCount));
 
    }
 
    private void loadSettings() {
        IDialogSettings ds = getDialogSettings();
        try {
            int histSize = ds.getInt("HISTORY_SIZE");
            for (int iCount = 0; iCount < histSize; iCount++) {
                IDialogSettings histSettings = ds.getSection(HISTORY_STORE + iCount);
                if (histSettings != null)
                    savedSettings.add(GitGrepSearchSettings.load(histSettings));
            }
        } catch (Exception ignored) {
            //ignored
            savedSettings.add(GitGrepSearchSettings.init());
        }
    }
 
}