package tim.prune.save; import java.awt.BorderLayout; import java.awt.Component; import java.awt.FlowLayout; import java.awt.GridLayout; import java.awt.event.ActionEvent; import java.awt.event.ActionListener; import java.io.File; import java.io.FileOutputStream; import java.io.IOException; import java.io.OutputStreamWriter; import java.io.Writer; import javax.swing.BorderFactory; import javax.swing.Box; import javax.swing.BoxLayout; import javax.swing.JButton; import javax.swing.JCheckBox; import javax.swing.JDialog; import javax.swing.JFileChooser; import javax.swing.JFrame; import javax.swing.JLabel; import javax.swing.JOptionPane; import javax.swing.JPanel; import javax.swing.JTextField; import tim.prune.App; import tim.prune.GenericFunction; import tim.prune.GpsPruner; import tim.prune.I18nManager; import tim.prune.UpdateMessageBroker; import tim.prune.config.Config; import tim.prune.data.Altitude; import tim.prune.data.Coordinate; import tim.prune.data.DataPoint; import tim.prune.data.Field; import tim.prune.data.Timestamp; import tim.prune.data.TrackInfo; import tim.prune.load.GenericFileFilter; /** * Class to export track information * into a specified Gpx file */ public class GpxExporter extends GenericFunction implements Runnable { private TrackInfo _trackInfo = null; private JDialog _dialog = null; private JTextField _nameField = null; private JTextField _descriptionField = null; private PointTypeSelector _pointTypeSelector = null; private JCheckBox _timestampsCheckbox = null; private JCheckBox _copySourceCheckbox = null; private File _exportFile = null; /** this program name */ private static final String GPX_CREATOR = "Prune v" + GpsPruner.VERSION_NUMBER + " activityworkshop.net"; /** * Constructor * @param inApp app object */ public GpxExporter(App inApp) { super(inApp); _trackInfo = inApp.getTrackInfo(); } /** Get name key */ public String getNameKey() { return "function.exportgpx"; } /** * Show the dialog to select options and export file */ public void begin() { // Make dialog window if (_dialog == null) { _dialog = new JDialog(_parentFrame, I18nManager.getText(getNameKey()), true); _dialog.setLocationRelativeTo(_parentFrame); _dialog.setDefaultCloseOperation(JDialog.DISPOSE_ON_CLOSE); _dialog.getContentPane().add(makeDialogComponents()); _dialog.pack(); } _pointTypeSelector.init(_app.getTrackInfo()); _dialog.setVisible(true); } /** * Create dialog components * @return Panel containing all gui elements in dialog */ private Component makeDialogComponents() { JPanel dialogPanel = new JPanel(); dialogPanel.setLayout(new BorderLayout()); JPanel mainPanel = new JPanel(); mainPanel.setLayout(new BoxLayout(mainPanel, BoxLayout.Y_AXIS)); // Make a central panel with the text boxes JPanel descPanel = new JPanel(); descPanel.setLayout(new GridLayout(2, 2)); descPanel.add(new JLabel(I18nManager.getText("dialog.exportgpx.name"))); _nameField = new JTextField(10); descPanel.add(_nameField); descPanel.add(new JLabel(I18nManager.getText("dialog.exportgpx.desc"))); _descriptionField = new JTextField(10); descPanel.add(_descriptionField); mainPanel.add(descPanel); mainPanel.add(Box.createVerticalStrut(5)); // point type selection (track points, waypoints, photo points) _pointTypeSelector = new PointTypeSelector(); mainPanel.add(_pointTypeSelector); // checkboxes for timestamps and copying JPanel checkPanel = new JPanel(); _timestampsCheckbox = new JCheckBox(I18nManager.getText("dialog.exportgpx.includetimestamps")); _timestampsCheckbox.setSelected(true); checkPanel.add(_timestampsCheckbox); _copySourceCheckbox = new JCheckBox(I18nManager.getText("dialog.exportgpx.copysource")); _copySourceCheckbox.setSelected(true); checkPanel.add(_copySourceCheckbox); mainPanel.add(checkPanel); dialogPanel.add(mainPanel, BorderLayout.CENTER); // button panel at bottom JPanel buttonPanel = new JPanel(); buttonPanel.setLayout(new FlowLayout(FlowLayout.RIGHT)); JButton okButton = new JButton(I18nManager.getText("button.ok")); ActionListener okListener = new ActionListener() { public void actionPerformed(ActionEvent e) { startExport(); } }; okButton.addActionListener(okListener); _descriptionField.addActionListener(okListener); buttonPanel.add(okButton); JButton cancelButton = new JButton(I18nManager.getText("button.cancel")); cancelButton.addActionListener(new ActionListener() { public void actionPerformed(ActionEvent e) { _dialog.dispose(); } }); buttonPanel.add(cancelButton); dialogPanel.add(buttonPanel, BorderLayout.SOUTH); dialogPanel.setBorder(BorderFactory.createEmptyBorder(10, 10, 10, 15)); return dialogPanel; } /** * Start the export process based on the input parameters */ private void startExport() { // OK pressed, so check selections if (!_pointTypeSelector.getAnythingSelected()) { JOptionPane.showMessageDialog(_parentFrame, I18nManager.getText("dialog.save.notypesselected"), I18nManager.getText("dialog.saveoptions.title"), JOptionPane.WARNING_MESSAGE); return; } // Choose output file File saveFile = chooseGpxFile(_parentFrame); if (saveFile != null) { // New file or overwrite confirmed, so initiate export in separate thread _exportFile = saveFile; new Thread(this).start(); } } /** * Select a GPX file to save to * @param inParentFrame parent frame for file chooser dialog * @return selected File, or null if selection cancelled */ public static File chooseGpxFile(JFrame inParentFrame) { File saveFile = null; JFileChooser fileChooser = new JFileChooser(); fileChooser.setDialogType(JFileChooser.SAVE_DIALOG); fileChooser.setFileFilter(new GenericFileFilter("filetype.gpx", new String[] {"gpx"})); fileChooser.setAcceptAllFileFilterUsed(false); // start from directory in config which should be set String configDir = Config.getConfigString(Config.KEY_TRACK_DIR); if (configDir != null) {fileChooser.setCurrentDirectory(new File(configDir));} // Allow choose again if an existing file is selected boolean chooseAgain = false; do { chooseAgain = false; if (fileChooser.showSaveDialog(inParentFrame) == JFileChooser.APPROVE_OPTION) { // OK pressed and file chosen File file = fileChooser.getSelectedFile(); // Check file extension if (!file.getName().toLowerCase().endsWith(".gpx")) { file = new File(file.getAbsolutePath() + ".gpx"); } // Check if file exists and if necessary prompt for overwrite Object[] buttonTexts = {I18nManager.getText("button.overwrite"), I18nManager.getText("button.cancel")}; if (!file.exists() || JOptionPane.showOptionDialog(inParentFrame, I18nManager.getText("dialog.save.overwrite.text"), I18nManager.getText("dialog.save.overwrite.title"), JOptionPane.YES_NO_OPTION, JOptionPane.WARNING_MESSAGE, null, buttonTexts, buttonTexts[1]) == JOptionPane.YES_OPTION) { // new file or overwrite confirmed saveFile = file; } else { // file exists and overwrite cancelled - select again chooseAgain = true; } } } while (chooseAgain); return saveFile; } /** * Run method for controlling separate thread for exporting */ public void run() { OutputStreamWriter writer = null; try { // normal writing to file writer = new OutputStreamWriter(new FileOutputStream(_exportFile)); boolean[] saveFlags = {_pointTypeSelector.getTrackpointsSelected(), _pointTypeSelector.getWaypointsSelected(), _pointTypeSelector.getPhotopointsSelected(), _pointTypeSelector.getJustSelection(), _timestampsCheckbox.isSelected()}; // write file final int numPoints = exportData(writer, _trackInfo, _nameField.getText(), _descriptionField.getText(), saveFlags, _copySourceCheckbox.isSelected()); // close file writer.close(); // Store directory in config for later Config.setConfigString(Config.KEY_TRACK_DIR, _exportFile.getParentFile().getAbsolutePath()); // Show confirmation UpdateMessageBroker.informSubscribers(I18nManager.getText("confirm.save.ok1") + " " + numPoints + " " + I18nManager.getText("confirm.save.ok2") + " " + _exportFile.getAbsolutePath()); // export successful so need to close dialog and return _dialog.dispose(); return; } catch (IOException ioe) { // System.out.println("Exception: " + ioe.getClass().getName() + " - " + ioe.getMessage()); try { if (writer != null) writer.close(); } catch (IOException ioe2) {} JOptionPane.showMessageDialog(_parentFrame, I18nManager.getText("error.save.failed") + " : " + ioe.getMessage(), I18nManager.getText("error.save.dialogtitle"), JOptionPane.ERROR_MESSAGE); } // if not returned already, export failed so need to recall the file selection startExport(); } /** * Export the information to the given writer * @param inWriter writer object * @param inInfo track info object * @param inName name of track (optional) * @param inDesc description of track (optional) * @param inSaveFlags array of booleans to export tracks, waypoints, photos, timestamps * @param inUseCopy true to copy source if available * @return number of points written * @throws IOException if io errors occur on write */ public static int exportData(OutputStreamWriter inWriter, TrackInfo inInfo, String inName, String inDesc, boolean[] inSaveFlags, boolean inUseCopy) throws IOException { // Instantiate source file cachers in case we want to copy output GpxCacherList gpxCachers = null; if (inUseCopy) gpxCachers = new GpxCacherList(inInfo.getFileInfo()); // Write or copy header inWriter.write(getHeaderString(gpxCachers)); // Name field String trackName = "PruneTrack"; if (inName != null && !inName.equals("")) { trackName = inName; inWriter.write("\t"); inWriter.write(trackName); inWriter.write("\n"); } // Description field inWriter.write("\t"); if (inDesc != null && !inDesc.equals("")) { inWriter.write(inDesc); } else { inWriter.write("Export from Prune"); } inWriter.write("\n"); int i = 0; DataPoint point = null; boolean hasTrackpoints = false; final boolean exportTrackpoints = inSaveFlags[0]; final boolean exportWaypoints = inSaveFlags[1]; final boolean exportPhotos = inSaveFlags[2]; final boolean exportSelection = inSaveFlags[3]; final boolean exportTimestamps = inSaveFlags[4]; // Examine selection int selStart = -1, selEnd = -1; if (exportSelection) { selStart = inInfo.getSelection().getStart(); selEnd = inInfo.getSelection().getEnd(); } // Loop over waypoints final int numPoints = inInfo.getTrack().getNumPoints(); int numSaved = 0; for (i=0; i=selStart && i<=selEnd)) { // Make a wpt element for each waypoint if (point.isWaypoint()) { if (exportWaypoints) { String pointSource = (inUseCopy?gpxCachers.getSourceString(point):null); if (pointSource != null) { inWriter.write(pointSource); inWriter.write('\n'); } else { exportWaypoint(point, inWriter, exportTimestamps); } numSaved++; } } else { hasTrackpoints = true; } } } // Export both route points and then track points if (hasTrackpoints && (exportTrackpoints || exportPhotos)) { // Output all route points (if any) numSaved += writeTrackPoints(inWriter, inInfo, exportSelection, exportTrackpoints, exportPhotos, exportTimestamps, true, gpxCachers, "1\n", null, "\t\n"); // Output all track points, if any String trackStart = "\t" + trackName + "1\n"; numSaved += writeTrackPoints(inWriter, inInfo, exportSelection, exportTrackpoints, exportPhotos, exportTimestamps, false, gpxCachers, "\n\t\n", "\t\n"); } inWriter.write("\n"); return numSaved; } /** * Loop through the track outputting the relevant track points * @param inWriter writer object for output * @param inInfo track info object containing track * @param inExportSelection true to just output current selection * @param inExportTrackpoints true to output track points * @param inExportPhotos true to output photo points * @param exportTimestamps true to include timestamps in export * @param inOnlyCopies true to only export if source can be copied * @param inCachers list of GpxCachers * @param inPointTag tag to match for each point * @param inStartTag start tag to output * @param inSegmentTag tag to output between segments (or null) * @param inEndTag end tag to output */ private static int writeTrackPoints(OutputStreamWriter inWriter, TrackInfo inInfo, boolean inExportSelection, boolean inExportTrackpoints, boolean inExportPhotos, boolean exportTimestamps, boolean inOnlyCopies, GpxCacherList inCachers, String inPointTag, String inStartTag, String inSegmentTag, String inEndTag) throws IOException { // Note: far too many input parameters to this method but avoids duplication // of output functionality for writing track points and route points int numPoints = inInfo.getTrack().getNumPoints(); int selStart = inInfo.getSelection().getStart(); int selEnd = inInfo.getSelection().getEnd(); int numSaved = 0; // Loop over track points for (int i=0; i=selStart && i<=selEnd)) && !point.isWaypoint()) { if ((point.getPhoto()==null && inExportTrackpoints) || (point.getPhoto()!=null && inExportPhotos)) { // get the source from the point (if any) String pointSource = (inCachers!=null?inCachers.getSourceString(point):null); boolean writePoint = (pointSource != null && pointSource.toLowerCase().startsWith(inPointTag)) || (pointSource == null && !inOnlyCopies); if (writePoint) { // restart track segment if necessary if ((numSaved > 0) && point.getSegmentStart() && (inSegmentTag != null)) { inWriter.write(inSegmentTag); } if (numSaved == 0) {inWriter.write(inStartTag);} if (pointSource != null) { inWriter.write(pointSource); inWriter.write('\n'); } else { if (!inOnlyCopies) {exportTrackpoint(point, inWriter, exportTimestamps);} } numSaved++; } } } } if (numSaved > 0) {inWriter.write(inEndTag);} return numSaved; } /** * Get the header string for the gpx * @param inCachers cacher list to ask for headers, if available * @return header string from cachers or as default */ private static String getHeaderString(GpxCacherList inCachers) { String gpxHeader = null; if (inCachers != null) {gpxHeader = inCachers.getFirstHeader();} if (gpxHeader == null || gpxHeader.length() < 5) { // Create default (1.0) header gpxHeader = "\n"; } return "\n" + gpxHeader + "\n"; } /** * Export the specified waypoint into the file * @param inPoint waypoint to export * @param inWriter writer object * @param inTimestamps true to export timestamps too * @throws IOException on write failure */ private static void exportWaypoint(DataPoint inPoint, Writer inWriter, boolean inTimestamps) throws IOException { inWriter.write("\t\n"); // altitude if available if (inPoint.hasAltitude()) { inWriter.write("\t\t"); inWriter.write("" + inPoint.getAltitude().getStringValue(Altitude.Format.METRES)); inWriter.write("\n"); } // timestamp if available (point might have timestamp and then be turned into a waypoint) if (inPoint.hasTimestamp() && inTimestamps) { inWriter.write("\t\t\n"); } // write waypoint name after elevation and time inWriter.write("\t\t"); inWriter.write(inPoint.getWaypointName().trim()); inWriter.write("\n"); // write waypoint type if any String type = inPoint.getFieldValue(Field.WAYPT_TYPE); if (type != null) { type = type.trim(); if (!type.equals("")) { inWriter.write("\t\t"); inWriter.write(type); inWriter.write("\n"); } } inWriter.write("\t\n"); } /** * Export the specified trackpoint into the file * @param inPoint trackpoint to export * @param inWriter writer object * @param inTimestamps true to export timestamps too */ private static void exportTrackpoint(DataPoint inPoint, Writer inWriter, boolean inTimestamps) throws IOException { inWriter.write("\t\t"); // altitude if (inPoint.hasAltitude()) { inWriter.write(""); inWriter.write("" + inPoint.getAltitude().getStringValue(Altitude.Format.METRES)); inWriter.write(""); } // timestamp if available (and selected) if (inPoint.hasTimestamp() && inTimestamps) { inWriter.write(""); } inWriter.write("\n"); } }