X-Git-Url: http://gitweb.fperrin.net/?a=blobdiff_plain;f=tim%2Fprune%2Fsave%2FGpxExporter.java;h=d35c35a8696be7e9863fca94fcb6c4c91dcf49ad;hb=f1b92378a792131ac8fb33a869405851d5b2d1f7;hp=d57d5f9b69f020d407e2ed5257f9244704144c85;hpb=f35b6d628f68e3b5ef19965ad8988d0dd1eb8efa;p=GpsPrune.git diff --git a/tim/prune/save/GpxExporter.java b/tim/prune/save/GpxExporter.java index d57d5f9..d35c35a 100644 --- a/tim/prune/save/GpxExporter.java +++ b/tim/prune/save/GpxExporter.java @@ -16,6 +16,7 @@ import java.nio.charset.Charset; 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; @@ -24,26 +25,30 @@ 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.GenericFunction; -import tim.prune.GpsPruner; +import tim.prune.GpsPrune; import tim.prune.I18nManager; import tim.prune.UpdateMessageBroker; import tim.prune.config.Config; import tim.prune.data.Altitude; -import tim.prune.data.AudioFile; +import tim.prune.data.AudioClip; import tim.prune.data.Coordinate; import tim.prune.data.DataPoint; import tim.prune.data.Field; -import tim.prune.data.MediaFile; +import tim.prune.data.MediaObject; import tim.prune.data.Photo; +import tim.prune.data.RecentFile; import tim.prune.data.Timestamp; import tim.prune.data.TrackInfo; import tim.prune.gui.DialogCloser; import tim.prune.load.GenericFileFilter; import tim.prune.save.xml.GpxCacherList; +import tim.prune.save.xml.XmlUtils; /** @@ -59,10 +64,13 @@ public class GpxExporter extends GenericFunction implements Runnable private PointTypeSelector _pointTypeSelector = null; private JCheckBox _timestampsCheckbox = null; private JCheckBox _copySourceCheckbox = null; + private JPanel _encodingsPanel = null; + private JRadioButton _useSystemRadio = null, _forceUtf8Radio = null; private File _exportFile = null; + private static String _systemEncoding = null; /** 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"; /** @@ -91,10 +99,16 @@ public class GpxExporter extends GenericFunction implements Runnable _dialog = new JDialog(_parentFrame, I18nManager.getText(getNameKey()), true); _dialog.setLocationRelativeTo(_parentFrame); _dialog.setDefaultCloseOperation(JDialog.DISPOSE_ON_CLOSE); + _systemEncoding = getSystemEncoding(); _dialog.getContentPane().add(makeDialogComponents()); _dialog.pack(); } _pointTypeSelector.init(_app.getTrackInfo()); + _encodingsPanel.setVisible(!isSystemUtf8()); + if (!isSystemUtf8()) { + _useSystemRadio.setText(I18nManager.getText("dialog.exportgpx.encoding.system") + + " (" + (_systemEncoding == null ? "unknown" : _systemEncoding) + ")"); + } _dialog.setVisible(true); } @@ -109,7 +123,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"))); @@ -132,6 +146,28 @@ public class GpxExporter extends GenericFunction implements Runnable _copySourceCheckbox.setSelected(true); checkPanel.add(_copySourceCheckbox); mainPanel.add(checkPanel); + // panel for selecting character encoding + _encodingsPanel = new JPanel(); + if (!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 @@ -168,7 +204,8 @@ public class GpxExporter extends GenericFunction implements Runnable private void startExport() { // OK pressed, so check selections - if (!_pointTypeSelector.getAnythingSelected()) { + if (!_pointTypeSelector.getAnythingSelected()) + { JOptionPane.showMessageDialog(_parentFrame, I18nManager.getText("dialog.save.notypesselected"), I18nManager.getText("dialog.saveoptions.title"), JOptionPane.WARNING_MESSAGE); return; @@ -183,6 +220,7 @@ public class GpxExporter extends GenericFunction implements Runnable } } + /** * Select a GPX file to save to * @param inParentFrame parent frame for file chooser dialog @@ -234,6 +272,7 @@ public class GpxExporter extends GenericFunction implements Runnable return saveFile; } + /** * Run method for controlling separate thread for exporting */ @@ -242,8 +281,11 @@ public class GpxExporter extends GenericFunction implements Runnable 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)); final boolean[] saveFlags = {_pointTypeSelector.getTrackpointsSelected(), _pointTypeSelector.getWaypointsSelected(), _pointTypeSelector.getPhotopointsSelected(), _pointTypeSelector.getAudiopointsSelected(), _pointTypeSelector.getJustSelection(), _timestampsCheckbox.isSelected()}; @@ -255,7 +297,10 @@ public class GpxExporter extends GenericFunction implements Runnable writer.close(); // Store directory in config for later 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()); @@ -298,20 +343,12 @@ public class GpxExporter extends GenericFunction implements Runnable if (inUseCopy) gpxCachers = new GpxCacherList(inInfo.getFileInfo()); // Write or copy headers inWriter.write(getXmlHeaderString(inWriter)); - inWriter.write(getGpxHeaderString(gpxCachers)); + final String gpxHeader = getGpxHeaderString(gpxCachers); + final boolean isVersion1_1 = (gpxHeader.toUpperCase().indexOf("GPX/1/1") > 0); + inWriter.write(gpxHeader); // 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"); - inWriter.write((inDesc != null && !inDesc.equals(""))?inDesc:"Export from Prune"); - inWriter.write("\n"); + String trackName = (inName != null && !inName.equals("")) ? inName : "GpsPruneTrack"; + writeNameAndDescription(inWriter, inName, inDesc, isVersion1_1); int i = 0; DataPoint point = null; @@ -333,21 +370,20 @@ public class GpxExporter extends GenericFunction implements Runnable for (i=0; i=selStart && i<=selEnd)) { + if (!exportSelection || (i>=selStart && i<=selEnd)) + { // Make a wpt element for each waypoint - if (point.isWaypoint()) { - if (exportWaypoints) - { - String pointSource = (inUseCopy?getPointSource(gpxCachers, point):null); - if (pointSource != null) { - inWriter.write(pointSource); - inWriter.write('\n'); - } - else { - exportWaypoint(point, inWriter, exportTimestamps, exportPhotos, exportAudios); - } - numSaved++; + if (point.isWaypoint() && exportWaypoints) + { + String pointSource = (inUseCopy?getPointSource(gpxCachers, point):null); + if (pointSource != null) { + inWriter.write(pointSource); + inWriter.write('\n'); } + else { + exportWaypoint(point, inWriter, exportTimestamps, exportPhotos, exportAudios); + } + numSaved++; } } } @@ -369,6 +405,39 @@ public class GpxExporter extends GenericFunction implements Runnable 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 + { + String desc = (inDesc != null && !inDesc.equals("")) ? inDesc : "Export from GpsPrune"; + // 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("")) + { + inWriter.write("\t\t"); + inWriter.write(inName); + inWriter.write("\n"); + } + inWriter.write("\t\t"); + inWriter.write(desc); + inWriter.write("\n"); + if (inIsVersion1_1) + { + inWriter.write("\t\n"); + } + } + /** * Loop through the track outputting the relevant track points * @param inWriter writer object for output @@ -407,7 +476,6 @@ public class GpxExporter extends GenericFunction implements Runnable if ((point.getPhoto()==null && inExportTrackpoints) || (point.getPhoto()!=null && inExportPhotos) || (point.getAudio()!=null && inExportAudios)) { - if (point.getPhoto() != null) System.out.println("Writetrackpoints: Point has photo " + point.getPhoto().getFile().getName()); // 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) @@ -420,7 +488,6 @@ public class GpxExporter extends GenericFunction implements Runnable } if (numSaved == 0) {inWriter.write(inStartTag);} if (pointSource != null) { - if (point.getPhoto() != null) System.out.println("Point has photo but using source"); inWriter.write(pointSource); inWriter.write('\n'); } @@ -453,7 +520,12 @@ public class GpxExporter extends GenericFunction implements Runnable source = replaceGpxTags(source, "lon=\"", "\"", inPoint.getLongitude().output(Coordinate.FORMAT_DECIMAL_FORCE_POINT)); source = replaceGpxTags(source, "", "", inPoint.getAltitude().getStringValue(Altitude.Format.METRES)); source = replaceGpxTags(source, "", inPoint.getTimestamp().getText(Timestamp.FORMAT_ISO_8601)); - if (inPoint.isWaypoint()) {source = replaceGpxTags(source, "", "", inPoint.getWaypointName());} // only for waypoints + if (inPoint.isWaypoint()) + { + source = replaceGpxTags(source, "", "", inPoint.getWaypointName()); + 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)); @@ -496,6 +568,7 @@ public class GpxExporter extends GenericFunction implements Runnable return null; } + /** * Replace the media tags in the given XML string * @param inSource source XML for point @@ -533,19 +606,73 @@ public class GpxExporter extends GenericFunction implements Runnable 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 default system encoding using a writer + * @param inWriter writer object + * @return string defining encoding + */ + private static String getEncoding(OutputStreamWriter inWriter) { String encoding = inWriter.getEncoding(); try { encoding = Charset.forName(encoding).name(); } catch (Exception e) {} // ignore failure to find encoding - return "\n"; + // Hack to fix bugs with Mac OSX (which reports MacRoman but is actually UTF-8) + if (encoding == null || encoding.toLowerCase().startsWith("macroman")) { + encoding = "UTF-8"; + } + return encoding; + } + + + /** + * Use a temporary file to obtain the name of the default system encoding + * @return name of default system encoding, or null if write failed + */ + private static String getSystemEncoding() + { + File tempFile = null; + String encoding = null; + try + { + tempFile = File.createTempFile("prune", null); + OutputStreamWriter writer = new OutputStreamWriter(new FileOutputStream(tempFile)); + encoding = getEncoding(writer); + writer.close(); + } + catch (IOException e) {} // value stays null + // Delete temp file + if (tempFile != null && tempFile.exists()) { + if (!tempFile.delete()) { + System.err.println("Cannot delete temp file: " + tempFile.getAbsolutePath()); + } + } + // If writing failed (eg permissions) then just ask system for default + if (encoding == null) encoding = Charset.defaultCharset().name(); + return encoding; + } + + /** + * Creates temp file if necessary to check system encoding + * @return true if system uses UTF-8 by default + */ + private static boolean isSystemUtf8() + { + if (_systemEncoding == null) _systemEncoding = getSystemEncoding(); + return (_systemEncoding != null && _systemEncoding.toUpperCase().equals("UTF-8")); } /** @@ -568,6 +695,7 @@ public class GpxExporter extends GenericFunction implements Runnable return gpxHeader + "\n"; } + /** * Export the specified waypoint into the file * @param inPoint waypoint to export @@ -604,6 +732,14 @@ public class GpxExporter extends GenericFunction implements Runnable inWriter.write("\t\t"); inWriter.write(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 (inPhoto && inPoint.getPhoto() != null) { @@ -645,7 +781,6 @@ public class GpxExporter extends GenericFunction implements Runnable boolean inExportPhoto, boolean inExportAudio) throws IOException { - if (inPoint.getPhoto() != null) System.out.println("Point has photo " + inPoint.getPhoto().getFile().getName()); inWriter.write("\t\t\n"); } + /** * Make the xml for the media link(s) * @param inPoint point to generate text for @@ -683,7 +819,7 @@ public class GpxExporter extends GenericFunction implements Runnable private static String makeMediaLink(DataPoint inPoint) { Photo photo = inPoint.getPhoto(); - AudioFile audio = inPoint.getAudio(); + AudioClip audio = inPoint.getAudio(); if (photo == null && audio == null) { return null; } @@ -702,8 +838,15 @@ public class GpxExporter extends GenericFunction implements Runnable * @param inMedia media item, either photo or audio * @return link for this media */ - private static String makeMediaLink(MediaFile inMedia) + private static String makeMediaLink(MediaObject inMedia) { - return "" + inMedia.getFile().getName() + ""; + 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 ""; } }