/*
* eXist Open Source Native XML Database
* Copyright (C) 2001-2015 The eXist-db Project
* http://exist-db.org
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 2
* 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
package org.exist.client;
import java.awt.BorderLayout;
import java.awt.Cursor;
import java.awt.Dimension;
import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;
import java.io.*;
import java.net.URL;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;
import javax.swing.BorderFactory;
import javax.swing.Box;
import javax.swing.DefaultComboBoxModel;
import javax.swing.ImageIcon;
import javax.swing.JButton;
import javax.swing.JComboBox;
import javax.swing.JComponent;
import javax.swing.JFileChooser;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.JProgressBar;
import javax.swing.JSpinner;
import javax.swing.JSplitPane;
import javax.swing.JTabbedPane;
import javax.swing.JTextField;
import javax.swing.JToolBar;
import javax.swing.SpinnerNumberModel;
import javax.swing.border.BevelBorder;
import javax.xml.transform.OutputKeys;
import org.exist.security.PermissionDeniedException;
import org.exist.xmldb.LocalCollection;
import org.exist.xmldb.UserManagementService;
import org.exist.xmldb.XQueryService;
import org.exist.xmldb.XmldbURI;
import org.exist.xquery.CompiledXQuery;
import org.exist.xquery.XQueryContext;
import org.exist.xquery.XQueryWatchDog;
import org.fife.ui.rsyntaxtextarea.RSyntaxTextArea;
import org.fife.ui.rsyntaxtextarea.SyntaxConstants;
import org.fife.ui.rtextarea.RTextScrollPane;
import org.xmldb.api.base.Collection;
import org.xmldb.api.base.CompiledExpression;
import org.xmldb.api.base.Resource;
import org.xmldb.api.base.ResourceIterator;
import org.xmldb.api.base.ResourceSet;
import org.xmldb.api.base.XMLDBException;
import org.xmldb.api.modules.XMLResource;
public class QueryDialog extends JFrame {
private static final long serialVersionUID = 1L;
private InteractiveClient client;
private Collection collection;
private Properties properties;
private RSyntaxTextArea query;
private RTextScrollPane queryScrollPane;
private JTabbedPane resultTabs;
private RSyntaxTextArea resultDisplay;
private RTextScrollPane resultDisplayScrollPane;
private RSyntaxTextArea exprDisplay;
private RTextScrollPane exprDisplayScrollPane;
private JComboBox collections = null;
private SpinnerNumberModel count;
private DefaultComboBoxModel history = new DefaultComboBoxModel();
private JTextField statusMessage;
private JTextField queryPositionDisplay;
private JProgressBar progress;
private JButton submitButton;
private JButton killButton;
private QueryThread q = null;
private Resource resource = null;
private QueryDialog(final InteractiveClient client, final Collection collection, final Properties properties, boolean loadedFromDb) {
super(Messages.getString("QueryDialog.0"));
this.collection = collection;
this.properties = properties;
this.client = client;
this.setIconImage(InteractiveClient.getExistIcon(getClass()).getImage());
setupComponents(loadedFromDb);
pack();
}
public QueryDialog(final InteractiveClient client, final Collection collection, final Properties properties) {
this(client, collection, properties, false);
}
public QueryDialog(final InteractiveClient client, final Collection collection, final Resource resource, final Properties properties) throws XMLDBException {
this(client, collection, properties, true);
this.resource = resource;
addWindowListener(new WindowAdapter() {
@Override
public void windowClosing(WindowEvent ev) {
try {
final UserManagementService service = (UserManagementService) collection
.getService("UserManagementService", "1.0"); //$NON-NLS-1$ //$NON-NLS-2$
service.unlockResource(resource);
} catch (final XMLDBException e) {
e.printStackTrace();
}
}
});
//set the content of the query
query.setText(new String((byte[]) resource.getContent()));
//set title
setTitle(Messages.getString("QueryDialog.0") + ": " + resource.getId());
}
private void saveToDb(final String queryText) {
try {
resource.setContent(queryText);
collection.storeResource(resource);
} catch (final XMLDBException xmldbe) {
ClientFrame.showErrorMessage(xmldbe.getMessage(), xmldbe);
}
}
private void setupComponents(boolean loadedFromDb) {
getContentPane().setLayout(new BorderLayout());
final JToolBar toolbar = new JToolBar();
URL url = getClass().getResource("icons/Open24.gif");
JButton button = new JButton(new ImageIcon(url));
button.setToolTipText(Messages.getString("QueryDialog.opentooltip"));
button.addActionListener(e -> open());
toolbar.add(button);
if (loadedFromDb) {
url = getClass().getResource("icons/SaveAs23.gif");
button = new JButton(new ImageIcon(url));
button.setToolTipText("Save to database");
button.addActionListener(e -> saveToDb(query.getText()));
toolbar.add(button);
}
url = getClass().getResource("icons/SaveAs24.gif");
button = new JButton(new ImageIcon(url));
button.setToolTipText(Messages.getString("QueryDialog.saveastooltip"));
button.addActionListener(e -> save(query.getText(), "query"));
toolbar.add(button);
url = getClass().getResource("icons/SaveAs25.gif");
button = new JButton(new ImageIcon(url));
button.setToolTipText(Messages.getString("QueryDialog.saveresultstooltip"));
button.addActionListener(e -> save(resultDisplay.getText(), "result"));
toolbar.add(button);
toolbar.addSeparator();
url = getClass().getResource("icons/Copy24.gif");
button = new JButton(new ImageIcon(url));
button.setToolTipText(Messages.getString("QueryDialog.copytooltip"));
button.addActionListener(e -> query.copy());
toolbar.add(button);
url = getClass().getResource("icons/Cut24.gif");
button = new JButton(new ImageIcon(url));
button.setToolTipText(Messages.getString("QueryDialog.cuttooltip"));
button.addActionListener(e -> query.cut());
toolbar.add(button);
url = getClass().getResource("icons/Paste24.gif");
button = new JButton(new ImageIcon(url));
button.setToolTipText(Messages.getString("QueryDialog.pastetooltip"));
button.addActionListener(e -> query.paste());
toolbar.add(button);
toolbar.addSeparator();
//TODO: change icon
url = getClass().getResource("icons/Find24.gif");
button = new JButton(new ImageIcon(url));
button.setToolTipText(Messages.getString("QueryDialog.compiletooltip"));
button.addActionListener(e -> compileQuery());
toolbar.add(button);
toolbar.addSeparator();
url = getClass().getResource("icons/Find24.gif");
submitButton = new JButton(Messages.getString("QueryDialog.submitbutton"), new ImageIcon(url));
submitButton.setToolTipText(Messages.getString("QueryDialog.submittooltip"));
toolbar.add(submitButton);
submitButton.addActionListener(e -> {
submitButton.setEnabled(false);
if (collection instanceof LocalCollection) {
killButton.setEnabled(true);
}
q = doQuery();
});
toolbar.addSeparator();
url = getClass().getResource("icons/Delete24.gif");
killButton = new JButton(Messages.getString("QueryDialog.killbutton"), new ImageIcon(url));
killButton.setToolTipText(Messages.getString("QueryDialog.killtooltip"));
toolbar.add(killButton);
killButton.setEnabled(false);
killButton.addActionListener(e -> {
if (q != null) {
q.killQuery();
killButton.setEnabled(false);
q = null;
}
});
final JSplitPane split = new JSplitPane(JSplitPane.VERTICAL_SPLIT);
split.setResizeWeight(0.6);
final JComponent qbox = createQueryBox();
split.setTopComponent(qbox);
final JPanel vbox = new JPanel();
vbox.setLayout(new BorderLayout());
final JLabel label = new JLabel(Messages.getString("QueryDialog.resultslabel"));
vbox.add(label, BorderLayout.NORTH);
resultTabs = new JTabbedPane();
resultDisplay = new RSyntaxTextArea(14, 80);
resultDisplay.setEditable(false);
resultDisplay.getPopupMenu().remove(0); //remove undo
resultDisplay.getPopupMenu().remove(0); //remove redo
resultDisplay.getPopupMenu().remove(0); //remove undo/redo splitter
resultDisplay.setSyntaxEditingStyle(SyntaxConstants.SYNTAX_STYLE_XML);
resultDisplay.setCodeFoldingEnabled(true);
resultDisplayScrollPane = new RTextScrollPane(resultDisplay);
resultTabs.add(Messages.getString("QueryDialog.XMLtab"), resultDisplayScrollPane);
exprDisplay = new RSyntaxTextArea(14, 80);
exprDisplay.setEditable(false);
exprDisplay.getPopupMenu().remove(0); //remove undo
exprDisplay.getPopupMenu().remove(0); //remove redo
exprDisplay.getPopupMenu().remove(0); //remove undo/redo splitter
exprDisplayScrollPane = new RTextScrollPane(exprDisplay);
resultTabs.add(Messages.getString("QueryDialog.tracetab"), exprDisplayScrollPane);
vbox.add(resultTabs, BorderLayout.CENTER);
final Box statusbar = Box.createHorizontalBox();
statusbar.setBorder(BorderFactory.createBevelBorder(BevelBorder.LOWERED));
statusMessage = new JTextField(20);
statusMessage.setEditable(false);
statusMessage.setFocusable(true);
statusbar.add(statusMessage);
queryPositionDisplay = new JTextField(5);
queryPositionDisplay.setEditable(false);
queryPositionDisplay.setFocusable(true);
statusbar.add(queryPositionDisplay);
query.addCaretListener(e -> {
final RSyntaxTextArea txt = (RSyntaxTextArea) e.getSource();
queryPositionDisplay.setText("Line: " + (txt.getCaretLineNumber() + 1) + " Column:" + (txt.getCaretOffsetFromLineStart() + 1));
});
progress = new JProgressBar();
progress.setPreferredSize(new Dimension(200, statusbar.getHeight()));
progress.setVisible(false);
statusbar.add(progress);
vbox.add(statusbar, BorderLayout.SOUTH);
split.setBottomComponent(vbox);
split.setDividerLocation(0.6);
getContentPane().add(toolbar, BorderLayout.NORTH);
getContentPane().add(split, BorderLayout.CENTER);
}
private JComponent createQueryBox() {
final JTabbedPane tabs = new JTabbedPane();
final JPanel inputVBox = new JPanel();
inputVBox.setLayout(new BorderLayout());
tabs.add(Messages.getString("QueryDialog.inputtab"), inputVBox);
final Box historyBox = Box.createHorizontalBox();
JLabel label = new JLabel(Messages.getString("QueryDialog.historylabel"));
historyBox.add(label);
final JComboBox historyList = new JComboBox(history);
for (final String query : client.queryHistory) {
addQuery(query);
}
historyList.addActionListener(e -> {
final String item = (String) client.queryHistory.get(historyList.getSelectedIndex());
query.setText(item);
});
historyBox.add(historyList);
inputVBox.add(historyBox, BorderLayout.NORTH);
query = new RSyntaxTextArea(14, 80);
query.setSyntaxEditingStyle(SyntaxConstants.SYNTAX_STYLE_XML);
query.setCodeFoldingEnabled(true);
queryScrollPane = new RTextScrollPane(query);
inputVBox.add(queryScrollPane, BorderLayout.CENTER);
final Box optionsPanel = Box.createHorizontalBox();
label = new JLabel(Messages.getString("QueryDialog.contextlabel"));
optionsPanel.add(label);
final List<String> data = new ArrayList<String>();
try {
final Collection root = client.getCollection(XmldbURI.ROOT_COLLECTION);
data.add(collection.getName());
getCollections(root, collection, data);
} catch (final XMLDBException e) {
ClientFrame.showErrorMessage(
Messages.getString("QueryDialog.collectionretrievalerrormessage") + ".", e);
}
collections = new JComboBox(new java.util.Vector(data));
collections.addActionListener(e -> {
final int p = collections.getSelectedIndex();
final String context = data.get(p);
try {
collection = client.getCollection(context);
} catch (final XMLDBException e1) {
}
});
optionsPanel.add(collections);
label = new JLabel(Messages.getString("QueryDialog.maxlabel"));
optionsPanel.add(label);
count = new SpinnerNumberModel(100, 1, 10000, 50);
final JSpinner spinner = new JSpinner(count);
spinner.setMaximumSize(new Dimension(400, 100));
optionsPanel.add(spinner);
inputVBox.add(optionsPanel, BorderLayout.SOUTH);
return tabs;
}
private List<String> getCollections(final Collection root, final Collection collection, final List<String> collectionsList) throws XMLDBException {
if (!collection.getName().equals(root.getName())) {
collectionsList.add(root.getName());
}
final String[] childCollections = root.listChildCollections();
Collection child = null;
for (int i = 0; i < childCollections.length; i++) {
try {
child = root.getChildCollection(childCollections[i]);
} catch (final XMLDBException xmldbe) {
if (xmldbe.getCause() instanceof PermissionDeniedException) {
continue;
} else {
throw xmldbe;
}
} catch (Exception npe) {
System.out.println("Corrupted resource/collection skipped: " + child != null ? child.getName() != null ? child.getName() : "unknown" : "unknown");
continue;
}
try {
getCollections(child, collection, collectionsList);
} catch (Exception ee) {
System.out.println("Corrupted resource/collection skipped: " + child != null ? child.getName() != null ? child.getName() : "unknown" : "unknown");
continue;
}
}
return collectionsList;
}
private void open() {
final String workDir = properties.getProperty("working-dir", System.getProperty("user.dir"));
final JFileChooser chooser = new JFileChooser();
chooser.setCurrentDirectory(Paths.get(workDir).toFile());
chooser.setMultiSelectionEnabled(false);
chooser.setFileSelectionMode(JFileChooser.FILES_ONLY);
chooser.addChoosableFileFilter(new MimeTypeFileFilter("application/xquery"));
if (chooser.showDialog(this, Messages.getString("QueryDialog.opendialog")) == JFileChooser.APPROVE_OPTION) {
final Path selectedDir = chooser.getCurrentDirectory().toPath();
properties.setProperty("working-dir", selectedDir.toAbsolutePath().toString());
final Path file = chooser.getSelectedFile().toPath();
if (!Files.isReadable(file)) {
JOptionPane.showInternalMessageDialog(this, Messages.getString("QueryDialog.cannotreadmessage") + " " + file.toAbsolutePath(),
Messages.getString("QueryDialog.Error"), JOptionPane.ERROR_MESSAGE);
}
try (final BufferedReader reader = Files.newBufferedReader(file)) {
final StringBuilder buf = new StringBuilder();
String line;
while ((line = reader.readLine()) != null) {
buf.append(line);
buf.append('\n');
}
query.setText(buf.toString());
} catch (final IOException e) {
ClientFrame.showErrorMessage(e.getMessage(), e);
}
}
}
private void save(String stringToSave, String fileCategory) {
if (stringToSave == null || "".equals(stringToSave)) {
return;
}
final String workDir = properties.getProperty("working-dir", System.getProperty("user.dir"));
final JFileChooser chooser = new JFileChooser();
chooser.setMultiSelectionEnabled(false);
chooser.setCurrentDirectory(Paths.get(workDir).toFile());
chooser.setFileSelectionMode(JFileChooser.FILES_ONLY);
if ("result".equals(fileCategory)) {
chooser.addChoosableFileFilter(new MimeTypeFileFilter("application/xhtml+xml"));
chooser.addChoosableFileFilter(new MimeTypeFileFilter("application/xml"));
} else {
chooser.addChoosableFileFilter(new MimeTypeFileFilter("application/xquery"));
}
if (chooser.showDialog(this, Messages.getString("QueryDialog.savedialogpre") + " " + fileCategory + " " + Messages.getString("QueryDialog.savedialogpost"))
== JFileChooser.APPROVE_OPTION) {
final Path selectedDir = chooser.getCurrentDirectory().toPath();
properties.setProperty("working-dir", selectedDir.toAbsolutePath().toString());
final Path file = chooser.getSelectedFile().toPath();
if (Files.exists(file) && (!Files.isWritable(file))) {
JOptionPane.showMessageDialog(this, Messages.getString("QueryDialog.cannotsavemessagepre") + " " + fileCategory + " " + Messages.getString("QueryDialog.cannotsavemessageinf") + " " + file.toAbsolutePath(),
Messages.getString("QueryDialog.Error"), JOptionPane.ERROR_MESSAGE);
}
if (Files.exists(file) &&
JOptionPane.showConfirmDialog(this, Messages.getString("QueryDialog.savedialogconfirm"), "Overwrite?",
JOptionPane.YES_NO_OPTION) == JOptionPane.NO_OPTION) {
return;
}
try(final Writer writer = Files.newBufferedWriter(file)) {
writer.write(stringToSave);
} catch (final IOException e) {
ClientFrame.showErrorMessage(e.getMessage(), e);
}
}
}
private QueryThread doQuery() {
final String xpath = query.getText();
if (xpath.length() == 0) {
return null;
}
resultDisplay.setText("");
final QueryThread q = new QueryThread(xpath);
q.start();
return q;
}
private void compileQuery() {
final String xpath = (String) query.getText();
if (xpath.length() == 0) {
return;
}
resultDisplay.setText("");
{
statusMessage.setText(Messages.getString("QueryDialog.compilemessage"));
setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));
final long tResult = 0;
long tCompiled = 0;
try {
final XQueryService service = (XQueryService) collection.getService("XQueryService", "1.0");
service.setProperty(OutputKeys.INDENT, properties.getProperty(OutputKeys.INDENT, "yes"));
final long t0 = System.currentTimeMillis();
final CompiledExpression compiled = service.compile(xpath);
final long t1 = System.currentTimeMillis();
tCompiled = t1 - t0;
// In this way we can see the parsed structure meanwhile the query is
final StringWriter writer = new StringWriter();
service.dump(compiled, writer);
exprDisplay.setText(writer.toString());
resultTabs.setSelectedComponent(exprDisplayScrollPane);
statusMessage.setText(Messages.getString("QueryDialog.Compilation") + ": " + tCompiled + "ms");
} catch (final Throwable e) {
statusMessage.setText(Messages.getString("QueryDialog.Error") + ": " + InteractiveClient.getExceptionMessage(e) + ". " + Messages.getString("QueryDialog.Compilation") + ": " + tCompiled + "ms, " + Messages.getString("QueryDialog.Execution") + ": " + tResult + "ms");
ClientFrame.showErrorMessageQuery(
Messages.getString("QueryDialog.compilationerrormessage") + ": "
+ InteractiveClient.getExceptionMessage(e), e);
}
setCursor(Cursor.getDefaultCursor());
}
}
class QueryThread extends Thread {
private String xpath;
private XQueryContext context;
public QueryThread(String query) {
super();
this.xpath = query;
this.context = null;
}
public boolean killQuery() {
if (context != null) {
final XQueryWatchDog xwd = context.getWatchDog();
final boolean retval = !xwd.isTerminating();
if (retval) {
xwd.kill(0);
}
context = null;
return retval;
}
return false;
}
/**
* @see java.lang.Thread#run()
*/
public void run() {
statusMessage.setText(Messages.getString("QueryDialog.processingquerymessage"));
progress.setVisible(true);
progress.setIndeterminate(true);
setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));
long tResult = 0;
long tCompiled = 0;
ResourceSet result = null;
try {
final XQueryService service = (XQueryService) collection.getService("XQueryService", "1.0");
service.setProperty(OutputKeys.INDENT, properties.getProperty(OutputKeys.INDENT, "yes"));
final long t0 = System.currentTimeMillis();
if (resource != null) {
service.setModuleLoadPath(XmldbURI.EMBEDDED_SERVER_URI_PREFIX + resource.getParentCollection().getName());
}
final CompiledExpression compiled = service.compile(xpath);
final long t1 = System.currentTimeMillis();
// Check could also be collection instanceof LocalCollection
if (compiled instanceof CompiledXQuery) {
context = ((CompiledXQuery) compiled).getContext();
}
tCompiled = t1 - t0;
// In this way we can see the parsed structure meanwhile the query is
StringWriter writer = new StringWriter();
service.dump(compiled, writer);
exprDisplay.setText(writer.toString());
result = service.execute(compiled);
context = null;
tResult = System.currentTimeMillis() - t1;
// jmfg: Is this still needed? I don't think so
writer = new StringWriter();
service.dump(compiled, writer);
exprDisplay.setText(writer.toString());
statusMessage.setText(Messages.getString("QueryDialog.retrievingmessage"));
XMLResource resource;
final int howmany = count.getNumber().intValue();
progress.setIndeterminate(false);
progress.setMinimum(1);
progress.setMaximum(howmany);
int j = 0;
int select = -1;
final StringBuilder contents = new StringBuilder();
for (final ResourceIterator i = result.getIterator(); i.hasMoreResources() && j < howmany; j++) {
resource = (XMLResource) i.nextResource();
progress.setValue(j);
try {
contents.append((String) resource.getContent());
contents.append("\n");
} catch (final XMLDBException e) {
select = ClientFrame.showErrorMessageQuery(
Messages.getString("QueryDialog.retrievalerrormessage") + ": "
+ InteractiveClient.getExceptionMessage(e), e);
if (select == 3) {
break;
}
}
}
resultTabs.setSelectedComponent(resultDisplayScrollPane);
resultDisplay.setText(contents.toString());
resultDisplay.setCaretPosition(0);
statusMessage.setText(Messages.getString("QueryDialog.Found") + " " + result.getSize() + " " + Messages.getString("QueryDialog.items") + "." +
" " + Messages.getString("QueryDialog.Compilation") + ": " + tCompiled + "ms, " + Messages.getString("QueryDialog.Execution") + ": " + tResult + "ms");
} catch (final Throwable e) {
statusMessage.setText(Messages.getString("QueryDialog.Error") + ": " + InteractiveClient.getExceptionMessage(e) + ". " + Messages.getString("QueryDialog.Compilation") + ": " + tCompiled + "ms, " + Messages.getString("QueryDialog.Execution") + ": " + tResult + "ms");
progress.setVisible(false);
ClientFrame.showErrorMessageQuery(
Messages.getString("QueryDialog.queryrunerrormessage") + ": "
+ InteractiveClient.getExceptionMessage(e), e);
} finally {
if (context != null) {
context.runCleanupTasks();
}
context = null;
if (result != null)
try {
result.clear();
} catch (final XMLDBException e) {
}
}
if (client.queryHistory.isEmpty() || !((String) client.queryHistory.getLast()).equals(xpath)) {
client.addToHistory(xpath);
client.writeQueryHistory();
addQuery(xpath);
}
setCursor(Cursor.getDefaultCursor());
progress.setVisible(false);
killButton.setEnabled(false);
submitButton.setEnabled(true);
}
}
private void addQuery(String query) {
if (query.length() > 40) {
query = query.substring(0, 40);
}
history.addElement(Integer.toString(history.getSize() + 1) + ". " + query);
}
}