X-Git-Url: https://gitweb.fperrin.net/?a=blobdiff_plain;f=tim%2Fprune%2Fsave%2FGpxExporter.java;h=88ac7914c29a1b92a235ff426e782f07ca4fcae3;hb=2d8cb72e84d5cc1089ce77baf1e34ea3ea2f8465;hp=89d40ef2efcb2ca2bc8b8e5ab1a78e9277584878;hpb=54b9d8bc8f0025ccf97a67d9dd217ef1f9cf082f;p=GpsPrune.git diff --git a/tim/prune/save/GpxExporter.java b/tim/prune/save/GpxExporter.java index 89d40ef..88ac791 100644 --- a/tim/prune/save/GpxExporter.java +++ b/tim/prune/save/GpxExporter.java @@ -13,28 +13,43 @@ import java.io.OutputStreamWriter; import java.io.Writer; import javax.swing.BorderFactory; +import javax.swing.Box; import javax.swing.BoxLayout; +import javax.swing.ButtonGroup; 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.JRadioButton; import javax.swing.JTextField; +import javax.swing.border.EtchedBorder; import tim.prune.App; -import tim.prune.Config; import tim.prune.GenericFunction; -import tim.prune.GpsPruner; +import tim.prune.GpsPrune; import tim.prune.I18nManager; import tim.prune.UpdateMessageBroker; -import tim.prune.data.Altitude; +import tim.prune.config.Config; +import tim.prune.data.AudioClip; import tim.prune.data.Coordinate; import tim.prune.data.DataPoint; +import tim.prune.data.Field; +import tim.prune.data.MediaObject; +import tim.prune.data.Photo; +import tim.prune.data.RecentFile; +import tim.prune.data.SourceInfo; import tim.prune.data.Timestamp; -import tim.prune.data.Track; +import tim.prune.data.TrackInfo; +import tim.prune.data.UnitSetLibrary; +import tim.prune.gui.DialogCloser; import tim.prune.load.GenericFileFilter; +import tim.prune.save.xml.GpxCacherList; +import tim.prune.save.xml.XmlUtils; + /** * Class to export track information @@ -42,18 +57,21 @@ import tim.prune.load.GenericFileFilter; */ public class GpxExporter extends GenericFunction implements Runnable { - private Track _track = null; + 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 JFileChooser _fileChooser = null; + private JCheckBox _copySourceCheckbox = null; + private JPanel _encodingsPanel = null; + private JRadioButton _useSystemRadio = null, _forceUtf8Radio = null; private File _exportFile = null; + /** Remember the previous sourceInfo object to tell whether it has changed */ + private SourceInfo _previousSourceInfo = null; - /** version number of Gpx */ - private static final String GPX_VERSION_NUMBER = "1.0"; /** this program name */ - private static final String GPX_CREATOR = "Prune v" + GpsPruner.VERSION_NUMBER + " activityworkshop.net"; + private static final String GPX_CREATOR = "GpsPrune v" + GpsPrune.VERSION_NUMBER + " activityworkshop.net"; /** @@ -63,7 +81,7 @@ public class GpxExporter extends GenericFunction implements Runnable public GpxExporter(App inApp) { super(inApp); - _track = inApp.getTrackInfo().getTrack(); + _trackInfo = inApp.getTrackInfo(); } /** Get name key */ @@ -85,6 +103,15 @@ public class GpxExporter extends GenericFunction implements Runnable _dialog.getContentPane().add(makeDialogComponents()); _dialog.pack(); } + _pointTypeSelector.init(_app.getTrackInfo()); + _encodingsPanel.setVisible(!XmlUtils.isSystemUtf8()); + if (!XmlUtils.isSystemUtf8()) + { + String systemEncoding = XmlUtils.getSystemEncoding(); + _useSystemRadio.setText(I18nManager.getText("dialog.exportgpx.encoding.system") + + " (" + (systemEncoding == null ? "unknown" : systemEncoding) + ")"); + } + setFileTitle(); _dialog.setVisible(true); } @@ -99,7 +126,7 @@ public class GpxExporter extends GenericFunction implements Runnable dialogPanel.setLayout(new BorderLayout()); JPanel mainPanel = new JPanel(); mainPanel.setLayout(new BoxLayout(mainPanel, BoxLayout.Y_AXIS)); - // Make a central panel with the text boxes + // Make a panel for the name/desc text boxes JPanel descPanel = new JPanel(); descPanel.setLayout(new GridLayout(2, 2)); descPanel.add(new JLabel(I18nManager.getText("dialog.exportgpx.name"))); @@ -109,12 +136,45 @@ public class GpxExporter extends GenericFunction implements Runnable _descriptionField = new JTextField(10); descPanel.add(_descriptionField); mainPanel.add(descPanel); - // checkbox for timestamps + 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); - mainPanel.add(_timestampsCheckbox); + checkPanel.add(_timestampsCheckbox); + _copySourceCheckbox = new JCheckBox(I18nManager.getText("dialog.exportgpx.copysource")); + _copySourceCheckbox.setSelected(true); + checkPanel.add(_copySourceCheckbox); + mainPanel.add(checkPanel); + // panel for selecting character encoding + _encodingsPanel = new JPanel(); + if (!XmlUtils.isSystemUtf8()) + { + // only add this panel if system isn't utf8 (or can't be identified yet) + _encodingsPanel.setBorder(BorderFactory.createCompoundBorder( + BorderFactory.createEtchedBorder(EtchedBorder.LOWERED), BorderFactory.createEmptyBorder(4, 4, 4, 4))); + _encodingsPanel.setLayout(new BorderLayout()); + _encodingsPanel.add(new JLabel(I18nManager.getText("dialog.exportgpx.encoding")), BorderLayout.NORTH); + JPanel radioPanel = new JPanel(); + radioPanel.setLayout(new FlowLayout()); + ButtonGroup radioGroup = new ButtonGroup(); + _useSystemRadio = new JRadioButton(I18nManager.getText("dialog.exportgpx.encoding.system")); + _forceUtf8Radio = new JRadioButton(I18nManager.getText("dialog.exportgpx.encoding.utf8")); + radioGroup.add(_useSystemRadio); + radioGroup.add(_forceUtf8Radio); + radioPanel.add(_useSystemRadio); + radioPanel.add(_forceUtf8Radio); + _useSystemRadio.setSelected(true); + _encodingsPanel.add(radioPanel, BorderLayout.CENTER); + mainPanel.add(_encodingsPanel); + } dialogPanel.add(mainPanel, BorderLayout.CENTER); + // close dialog if escape pressed + _nameField.addKeyListener(new DialogCloser(_dialog)); // button panel at bottom JPanel buttonPanel = new JPanel(); buttonPanel.setLayout(new FlowLayout(FlowLayout.RIGHT)); @@ -130,8 +190,7 @@ public class GpxExporter extends GenericFunction implements Runnable buttonPanel.add(okButton); JButton cancelButton = new JButton(I18nManager.getText("button.cancel")); cancelButton.addActionListener(new ActionListener() { - public void actionPerformed(ActionEvent e) - { + public void actionPerformed(ActionEvent e) { _dialog.dispose(); } }); @@ -141,32 +200,83 @@ public class GpxExporter extends GenericFunction implements Runnable return dialogPanel; } + /** + * Set the suggestion for the name with which to export + */ + private void setFileTitle() + { + // Get the most recent file info + SourceInfo currentSource = _app.getTrackInfo().getFileInfo().getLastFileInfo(); + if (currentSource != _previousSourceInfo) + { + String lastTitle = currentSource.getFileTitle(); + if (lastTitle != null && !lastTitle.equals("")) + { + // Take the title of the last file loaded + _nameField.setText(lastTitle); + } + } + if (_nameField.getText().equals("")) + { + // no name given in the field already, so try to overwrite it + String lastTitle = _app.getTrackInfo().getFileInfo().getLastFileTitle(); + if (lastTitle != null && !lastTitle.equals("")) + { + _nameField.setText(lastTitle); + } + } + // Remember this source info so we don't use it again + _previousSourceInfo = currentSource; + } /** * Start the export process based on the input parameters */ private void startExport() { - // OK pressed, so choose output file - if (_fileChooser == null) + // 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) { - _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 - File configDir = Config.getWorkingDirectory(); - if (configDir != null) {_fileChooser.setCurrentDirectory(configDir);} + // 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(_parentFrame) == JFileChooser.APPROVE_OPTION) + if (fileChooser.showSaveDialog(inParentFrame) == JFileChooser.APPROVE_OPTION) { // OK pressed and file chosen - File file = _fileChooser.getSelectedFile(); + File file = fileChooser.getSelectedFile(); // Check file extension if (!file.getName().toLowerCase().endsWith(".gpx")) { @@ -174,22 +284,23 @@ public class GpxExporter extends GenericFunction implements Runnable } // 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(_parentFrame, + 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, so initiate export in separate thread - _exportFile = file; - new Thread(this).start(); + // new file or overwrite confirmed + saveFile = file; } else { + // file exists and overwrite cancelled - select again chooseAgain = true; } } } while (chooseAgain); + return saveFile; } @@ -198,20 +309,39 @@ public class GpxExporter extends GenericFunction implements Runnable */ public void run() { + // Instantiate source file cachers in case we want to copy output + GpxCacherList gpxCachers = null; + if (_copySourceCheckbox.isSelected()) { + gpxCachers = new GpxCacherList(_trackInfo.getFileInfo()); + } OutputStreamWriter writer = null; try { - // normal writing to file - writer = new OutputStreamWriter(new FileOutputStream(_exportFile)); + // normal writing to file - firstly specify UTF8 encoding if requested + if (_forceUtf8Radio != null && _forceUtf8Radio.isSelected()) + writer = new OutputStreamWriter(new FileOutputStream(_exportFile), "UTF-8"); + else + writer = new OutputStreamWriter(new FileOutputStream(_exportFile)); + // TODO: Move to new method + SettingsForExport settings = new SettingsForExport(); + settings.setExportTrackPoints(_pointTypeSelector.getTrackpointsSelected()); + settings.setExportWaypoints(_pointTypeSelector.getWaypointsSelected()); + settings.setExportPhotoPoints(_pointTypeSelector.getPhotopointsSelected()); + settings.setExportAudiopoints(_pointTypeSelector.getAudiopointsSelected()); + settings.setExportJustSelection(_pointTypeSelector.getJustSelection()); + settings.setExportTimestamps(_timestampsCheckbox.isSelected()); // write file - int numPoints = exportData(writer, _track, _nameField.getText(), - _descriptionField.getText(), _timestampsCheckbox.isSelected()); + final int numPoints = exportData(writer, _trackInfo, _nameField.getText(), + _descriptionField.getText(), settings, gpxCachers); // close file writer.close(); // Store directory in config for later - Config.setWorkingDirectory(_exportFile.getParentFile()); + Config.setConfigString(Config.KEY_TRACK_DIR, _exportFile.getParentFile().getAbsolutePath()); + // Add to recent file list + Config.getRecentFileList().addFile(new RecentFile(_exportFile, true)); // Show confirmation + UpdateMessageBroker.informSubscribers(); UpdateMessageBroker.informSubscribers(I18nManager.getText("confirm.save.ok1") + " " + numPoints + " " + I18nManager.getText("confirm.save.ok2") + " " + _exportFile.getAbsolutePath()); @@ -238,84 +368,333 @@ public class GpxExporter extends GenericFunction implements Runnable /** * Export the information to the given writer * @param inWriter writer object - * @param inTrack track object containing data + * @param inInfo track info object * @param inName name of track (optional) * @param inDesc description of track (optional) - * @param inTimestamps true to export timestamps + * @param inExportSettings flags for what to export and how + * @param inGpxCachers list of Gpx cachers containing input data * @return number of points written * @throws IOException if io errors occur on write */ - public static int exportData(OutputStreamWriter inWriter, Track inTrack, String inName, - String inDesc, boolean inTimestamps) throws IOException + public static int exportData(OutputStreamWriter inWriter, TrackInfo inInfo, String inName, + String inDesc, SettingsForExport inSettings, GpxCacherList inGpxCachers) throws IOException + { + // Write or copy headers + inWriter.write(getXmlHeaderString(inWriter)); + final String gpxHeader = getGpxHeaderString(inGpxCachers); + final boolean isVersion1_1 = (gpxHeader.toUpperCase().indexOf("GPX/1/1") > 0); + inWriter.write(gpxHeader); + // name and description + String trackName = (inName != null && !inName.equals("")) ? XmlUtils.fixCdata(inName) : "GpsPruneTrack"; + String desc = (inDesc != null && !inDesc.equals("")) ? XmlUtils.fixCdata(inDesc) : "Export from GpsPrune"; + writeNameAndDescription(inWriter, trackName, desc, isVersion1_1); + + DataPoint point = null; + final boolean exportWaypoints = inSettings.getExportWaypoints(); + final boolean exportSelection = inSettings.getExportJustSelection(); + final boolean exportTimestamps = inSettings.getExportTimestamps(); + // 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 (int i=0; i=selStart && i<=selEnd)) + { + // Make a wpt element for each waypoint + if (point.isWaypoint() && exportWaypoints) + { + String pointSource = (inGpxCachers == null? null : getPointSource(inGpxCachers, point)); + if (pointSource != null) + { + // If timestamp checkbox is off, strip time + if (!exportTimestamps) { + pointSource = stripTime(pointSource); + } + inWriter.write('\t'); + inWriter.write(pointSource); + inWriter.write('\n'); + } + else { + exportWaypoint(point, inWriter, inSettings); + } + numSaved++; + } + } + } + // Export both route points and then track points + if (inSettings.getExportTrackPoints() || inSettings.getExportPhotoPoints() || inSettings.getExportAudioPoints()) + { + // Output all route points (if any) + numSaved += writeTrackPoints(inWriter, inInfo, inSettings, + true, inGpxCachers, "1\n", + null, "\t\n"); + // Output all track points, if any + String trackStart = "\t\n\t\t" + trackName + "\n\t\t1\n\t\t\n"; + numSaved += writeTrackPoints(inWriter, inInfo, inSettings, + false, inGpxCachers, "\n\t\n", "\t\t\n\t\n"); + } + + inWriter.write("\n"); + return numSaved; + } + + + /** + * Write the name and description according to the GPX version number + * @param inWriter writer object + * @param inName name, or null if none supplied + * @param inDesc description, or null if none supplied + * @param inIsVersion1_1 true if gpx version 1.1, false for version 1.0 + */ + private static void writeNameAndDescription(OutputStreamWriter inWriter, + String inName, String inDesc, boolean inIsVersion1_1) throws IOException { - inWriter.write("\n\n"); - // Name field - String trackName = "PruneTrack"; + // Position of name and description fields needs to be different for GPX1.0 and GPX1.1 + if (inIsVersion1_1) + { + // GPX 1.1 has the name and description inside a metadata tag + inWriter.write("\t\n"); + } if (inName != null && !inName.equals("")) { - trackName = inName; + if (inIsVersion1_1) {inWriter.write('\t');} inWriter.write("\t"); - inWriter.write(trackName); + inWriter.write(inName); inWriter.write("\n"); } - // Description field + if (inIsVersion1_1) {inWriter.write('\t');} inWriter.write("\t"); - if (inDesc != null && !inDesc.equals("")) { - inWriter.write(inDesc); - } - else + inWriter.write(inDesc); + inWriter.write("\n"); + if (inIsVersion1_1) { - inWriter.write("Export from Prune"); + inWriter.write("\t\n"); } - inWriter.write("\n"); + } - int i = 0; - DataPoint point = null; - boolean hasTrackpoints = false; - // Loop over waypoints - int numPoints = inTrack.getNumPoints(); - for (i=0; i=selStart && i<=selEnd)) && !point.isWaypoint()) { - exportWaypoint(point, inWriter, inTimestamps); + if ((point.getPhoto()==null && exportTrackPoints) || (point.getPhoto()!=null && exportPhotos) + || (point.getAudio()!=null && exportAudios)) + { + // get the source from the point (if any) + String pointSource = getPointSource(inCachers, point); + // Clear point source if it's the wrong type of point (eg changed from waypoint or route point) + if (pointSource != null && !pointSource.trim().toLowerCase().startsWith(inPointTag)) { + pointSource = null; + } + if (pointSource != null || !inOnlyCopies) + { + // restart track segment if necessary + if ((numSaved > 0) && point.getSegmentStart() && (inSegmentTag != null)) { + inWriter.write(inSegmentTag); + } + if (numSaved == 0) {inWriter.write(inStartTag);} + if (pointSource != null) + { + // If timestamps checkbox is off, strip the time + if (!exportTimestamps) { + pointSource = stripTime(pointSource); + } + inWriter.write(pointSource); + inWriter.write('\n'); + } + else + { + if (!inOnlyCopies) { + exportTrackpoint(point, inWriter, inSettings); + } + } + numSaved++; + } + } } - else + } + if (numSaved > 0) { + inWriter.write(inEndTag); + } + return numSaved; + } + + + /** + * Get the point source for the specified point + * @param inCachers list of GPX cachers to ask for source + * @param inPoint point object + * @return xml source if available, or null otherwise + */ + private static String getPointSource(GpxCacherList inCachers, DataPoint inPoint) + { + if (inCachers == null || inPoint == null) {return null;} + String source = inCachers.getSourceString(inPoint); + if (source == null || !inPoint.isModified()) {return source;} + // Point has been modified - maybe it's possible to modify the source + source = replaceGpxTags(source, "lat=\"", "\"", inPoint.getLatitude().output(Coordinate.FORMAT_DECIMAL_FORCE_POINT)); + source = replaceGpxTags(source, "lon=\"", "\"", inPoint.getLongitude().output(Coordinate.FORMAT_DECIMAL_FORCE_POINT)); + source = replaceGpxTags(source, "", "", inPoint.getAltitude().getStringValue(UnitSetLibrary.UNITS_METRES)); + source = replaceGpxTags(source, "", inPoint.getTimestamp().getText(Timestamp.Format.ISO8601, null)); + if (inPoint.isWaypoint()) + { + source = replaceGpxTags(source, "", "", XmlUtils.fixCdata(inPoint.getWaypointName())); + if (source != null) { - hasTrackpoints = true; + source = source.replaceAll("", "").replaceAll("", ""); } + source = replaceGpxTags(source, "", "", + XmlUtils.fixCdata(inPoint.getFieldValue(Field.DESCRIPTION))); + } + // photo / audio links + if (source != null && (inPoint.hasMedia() || source.indexOf("") > 0)) { + source = replaceMediaLinks(source, makeMediaLink(inPoint)); } - // Output the track, if there is one - if (hasTrackpoints) + return source; + } + + /** + * Replace the given value into the given XML string + * @param inSource source XML for point + * @param inStartTag start tag for field + * @param inEndTag end tag for field + * @param inValue value to replace between start tag and end tag + * @return modified String, or null if not possible + */ + private static String replaceGpxTags(String inSource, String inStartTag, String inEndTag, String inValue) + { + if (inSource == null) {return null;} + // Look for start and end tags within source + final int startPos = inSource.indexOf(inStartTag); + final int endPos = inSource.indexOf(inEndTag, startPos+inStartTag.length()); + if (startPos > 0 && endPos > 0) { - boolean firstPoint = true; - inWriter.write("\t" + trackName + "1\n"); - // Loop over track points - for (i=0; i\n\t\n"); - } - if (!point.isWaypoint()) { - // export the track point - exportTrackpoint(point, inWriter, inTimestamps); - firstPoint = false; - } + String origValue = inSource.substring(startPos + inStartTag.length(), endPos); + if (inValue != null && origValue.equals(inValue)) { + // Value unchanged + return inSource; + } + else if (inValue == null || inValue.equals("")) { + // Need to delete value + return inSource.substring(0, startPos) + inSource.substring(endPos + inEndTag.length()); + } + else { + // Need to replace value + return inSource.substring(0, startPos+inStartTag.length()) + inValue + inSource.substring(endPos); } - inWriter.write("\t\n"); } - inWriter.write("\n"); - return numPoints; + // Value not found for this field in original source + if (inValue == null || inValue.equals("")) {return inSource;} + return null; + } + + + /** + * Replace the media tags in the given XML string + * @param inSource source XML for point + * @param inValue value for the current point + * @return modified String, or null if not possible + */ + private static String replaceMediaLinks(String inSource, String inValue) + { + if (inSource == null) {return null;} + // Note that this method is very similar to replaceGpxTags except there can be multiple link tags + // and the tags must have attributes. So either one heavily parameterized method or two. + // Look for start and end tags within source + final String STARTTEXT = " 0 && endPos > 0) + { + String origValue = inSource.substring(startPos, endPos + ENDTEXT.length()); + if (inValue != null && origValue.equals(inValue)) { + // Value unchanged + return inSource; + } + else if (inValue == null || inValue.equals("")) { + // Need to delete value + return inSource.substring(0, startPos) + inSource.substring(endPos + ENDTEXT.length()); + } + else { + // Need to replace value + return inSource.substring(0, startPos) + inValue + inSource.substring(endPos + ENDTEXT.length()); + } + } + // Value not found for this field in original source + if (inValue == null || inValue.equals("")) {return inSource;} + return null; + } + + + /** + * Get the header string for the xml document including encoding + * @param inWriter writer object + * @return header string defining encoding + */ + private static String getXmlHeaderString(OutputStreamWriter inWriter) + { + return "\n"; + } + + + /** + * Get the header string for the gpx tag + * @param inCachers cacher list to ask for headers, if available + * @return header string from cachers or as default + */ + private static String getGpxHeaderString(GpxCacherList inCachers) + { + String gpxHeader = null; + if (inCachers != null) {gpxHeader = inCachers.getFirstHeader();} + if (gpxHeader == null || gpxHeader.length() < 5) + { + // TODO: Consider changing this to default to GPX 1.1 + // Create default (1.0) header + gpxHeader = "\n"; + } + return gpxHeader + "\n"; } @@ -323,10 +702,11 @@ public class GpxExporter extends GenericFunction implements Runnable * Export the specified waypoint into the file * @param inPoint waypoint to export * @param inWriter writer object - * @param inTimestamps true to export timestamps too + * @param inSettings export settings * @throws IOException on write failure */ - private static void exportWaypoint(DataPoint inPoint, Writer inWriter, boolean inTimestamps) + private static void exportWaypoint(DataPoint inPoint, Writer inWriter, + SettingsForExport inSettings) throws IOException { inWriter.write("\t\n"); // altitude if available - if (inPoint.hasAltitude()) + if (inPoint.hasAltitude() || inSettings.getExportMissingAltitudesAsZero()) { inWriter.write("\t\t"); - inWriter.write("" + inPoint.getAltitude().getStringValue(Altitude.Format.METRES)); + inWriter.write(inPoint.hasAltitude() ? inPoint.getAltitude().getStringValue(UnitSetLibrary.UNITS_METRES) : "0"); inWriter.write("\n"); } - // write waypoint name after elevation - inWriter.write("\t\t"); - inWriter.write(inPoint.getWaypointName().trim()); - inWriter.write("\n"); - // timestamp if available (point might have timestamp and then be turned into a waypoint) - if (inPoint.hasTimestamp() && inTimestamps) + // timestamp if available (some waypoints have timestamps, some not) + if (inPoint.hasTimestamp() && inSettings.getExportTimestamps()) { inWriter.write("\t\t\n"); } - // TODO: Include waypt type in Gpx + // write waypoint name after elevation and time + inWriter.write("\t\t"); + inWriter.write(XmlUtils.fixCdata(inPoint.getWaypointName().trim())); + inWriter.write("\n"); + // description, if any + String desc = XmlUtils.fixCdata(inPoint.getFieldValue(Field.DESCRIPTION)); + if (desc != null && !desc.equals("")) + { + inWriter.write("\t\t"); + inWriter.write(desc); + inWriter.write("\n"); + } + // Media links, if any + if (inSettings.getExportPhotoPoints() && inPoint.getPhoto() != null) + { + inWriter.write("\t\t"); + inWriter.write(makeMediaLink(inPoint.getPhoto())); + inWriter.write('\n'); + } + if (inSettings.getExportAudioPoints() && inPoint.getAudio() != null) + { + inWriter.write("\t\t"); + inWriter.write(makeMediaLink(inPoint.getAudio())); + 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"); } @@ -361,30 +773,122 @@ public class GpxExporter extends GenericFunction implements Runnable * Export the specified trackpoint into the file * @param inPoint trackpoint to export * @param inWriter writer object - * @param inTimestamps true to export timestamps too + * @param inSettings export settings */ - private static void exportTrackpoint(DataPoint inPoint, Writer inWriter, boolean inTimestamps) + private static void exportTrackpoint(DataPoint inPoint, Writer inWriter, SettingsForExport inSettings) throws IOException { - inWriter.write("\t\t"); + inWriter.write("\">\n"); // altitude - if (inPoint.hasAltitude()) + if (inPoint.hasAltitude() || inSettings.getExportMissingAltitudesAsZero()) { - inWriter.write(""); - inWriter.write("" + inPoint.getAltitude().getStringValue(Altitude.Format.METRES)); - inWriter.write(""); + inWriter.write("\t\t\t\t"); + inWriter.write(inPoint.hasAltitude() ? inPoint.getAltitude().getStringValue(UnitSetLibrary.UNITS_METRES) : "0"); + inWriter.write("\n"); } + // Maybe take timestamp from photo if the point hasn't got one + Timestamp pointTimestamp = getPointTimestamp(inPoint, inSettings); // timestamp if available (and selected) - if (inPoint.hasTimestamp() && inTimestamps) + if (pointTimestamp != null && inSettings.getExportTimestamps()) + { + inWriter.write("\t\t\t\t\n"); + } + // photo, audio + if (inPoint.getPhoto() != null && inSettings.getExportPhotoPoints()) + { + inWriter.write("\t\t\t\t"); + inWriter.write(makeMediaLink(inPoint.getPhoto())); + inWriter.write("\n"); + } + if (inPoint.getAudio() != null && inSettings.getExportAudioPoints()) { + inWriter.write(makeMediaLink(inPoint.getAudio())); + } + inWriter.write("\t\t\t\n"); + } + + + /** + * Make the xml for the media link(s) + * @param inPoint point to generate text for + * @return link tags, or null if no links + */ + private static String makeMediaLink(DataPoint inPoint) + { + Photo photo = inPoint.getPhoto(); + AudioClip audio = inPoint.getAudio(); + if (photo == null && audio == null) { + return null; + } + String linkText = ""; + if (photo != null) { + linkText = makeMediaLink(photo); + } + if (audio != null) { + linkText += makeMediaLink(audio); + } + return linkText; + } + + /** + * Make the media link for a single media item + * @param inMedia media item, either photo or audio + * @return link for this media + */ + private static String makeMediaLink(MediaObject inMedia) + { + if (inMedia.getFile() != null) + // file link + return "" + inMedia.getName() + ""; + if (inMedia.getUrl() != null) + // url link + return "" + inMedia.getName() + ""; + // No link available, must have been loaded from zip file - no link possible + return ""; + } + + + /** + * Strip the time from a GPX point source string + * @param inPointSource point source to copy + * @return point source with timestamp removed + */ + private static String stripTime(String inPointSource) + { + return inPointSource.replaceAll("[ \t]*", ""); + } + + /** + * Get the timestamp from the point or its media + * @param inPoint point object + * @param inSettings export settings + * @return Timestamp object if available, or null + */ + private static Timestamp getPointTimestamp(DataPoint inPoint, SettingsForExport inSettings) + { + if (inPoint.hasTimestamp()) + { + return inPoint.getTimestamp(); + } + if (inPoint.getPhoto() != null && inSettings.getExportPhotoPoints()) + { + if (inPoint.getPhoto().hasTimestamp()) + { + return inPoint.getPhoto().getTimestamp(); + } + } + if (inPoint.getAudio() != null && inSettings.getExportAudioPoints()) { - inWriter.write(""); + if (inPoint.getAudio().hasTimestamp()) + { + return inPoint.getAudio().getTimestamp(); + } } - inWriter.write("\n"); + return null; } }