1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
|
package cgeo.geocaching.export;
import cgeo.geocaching.Geocache;
import cgeo.geocaching.LogEntry;
import cgeo.geocaching.Waypoint;
import cgeo.geocaching.cgData;
import cgeo.geocaching.enumerations.CacheAttribute;
import cgeo.geocaching.enumerations.LoadFlags;
import cgeo.geocaching.geopoint.Geopoint;
import cgeo.geocaching.utils.TextUtils;
import cgeo.geocaching.utils.XmlUtils;
import cgeo.org.kxml2.io.KXmlSerializer;
import org.apache.commons.lang3.CharEncoding;
import org.apache.commons.lang3.StringUtils;
import org.xmlpull.v1.XmlSerializer;
import java.io.IOException;
import java.io.Writer;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Date;
import java.util.List;
import java.util.Locale;
import java.util.Set;
public final class GpxSerializer {
private static final SimpleDateFormat dateFormatZ = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'", Locale.US);
public static final String PREFIX_XSI = "http://www.w3.org/2001/XMLSchema-instance";
public static final String PREFIX_GPX = "http://www.topografix.com/GPX/1/0";
public static final String PREFIX_GROUNDSPEAK = "http://www.groundspeak.com/cache/1/0";
/**
* During the export, only this number of geocaches is fully loaded into memory.
*/
public static final int CACHES_PER_BATCH = 100;
/**
* counter for exported caches, used for progress reporting
*/
private int countExported;
private ProgressListener progressListener;
private final XmlSerializer gpx = new KXmlSerializer();
protected static interface ProgressListener {
void publishProgress(int countExported);
}
public void writeGPX(List<String> allGeocodesIn, Writer writer, final ProgressListener progressListener) throws IOException {
// create a copy of the geocode list, as we need to modify it, but it might be immutable
final ArrayList<String> allGeocodes = new ArrayList<String>(allGeocodesIn);
this.progressListener = progressListener;
gpx.setOutput(writer);
gpx.startDocument(CharEncoding.UTF_8, true);
gpx.setPrefix("", PREFIX_GPX);
gpx.setPrefix("xsi", PREFIX_XSI);
gpx.setPrefix("groundspeak", PREFIX_GROUNDSPEAK);
gpx.startTag(PREFIX_GPX, "gpx");
gpx.attribute("", "version", "1.0");
gpx.attribute("", "creator", "c:geo - http://www.cgeo.org/");
gpx.attribute(PREFIX_XSI, "schemaLocation",
PREFIX_GPX + " http://www.topografix.com/GPX/1/0/gpx.xsd " +
PREFIX_GROUNDSPEAK + " http://www.groundspeak.com/cache/1/0/1/cache.xsd");
// Split the overall set of geocodes into small chunks. That is a compromise between memory efficiency (because
// we don't load all caches fully into memory) and speed (because we don't query each cache separately).
while (!allGeocodes.isEmpty()) {
final List<String> batch = allGeocodes.subList(0, Math.min(CACHES_PER_BATCH, allGeocodes.size()));
exportBatch(gpx, batch);
batch.clear();
}
gpx.endTag(PREFIX_GPX, "gpx");
gpx.endDocument();
}
private void exportBatch(final XmlSerializer gpx, Collection<String> geocodesOfBatch) throws IOException {
final Set<Geocache> caches = cgData.loadCaches(geocodesOfBatch, LoadFlags.LOAD_ALL_DB_ONLY);
for (final Geocache cache : caches) {
gpx.startTag(PREFIX_GPX, "wpt");
gpx.attribute("", "lat", Double.toString(cache.getCoords().getLatitude()));
gpx.attribute("", "lon", Double.toString(cache.getCoords().getLongitude()));
final Date hiddenDate = cache.getHiddenDate();
if (hiddenDate != null) {
XmlUtils.simpleText(gpx, PREFIX_GPX, "time", dateFormatZ.format(hiddenDate));
}
XmlUtils.multipleTexts(gpx, PREFIX_GPX,
"name", cache.getGeocode(),
"desc", cache.getName(),
"url", cache.getUrl(),
"urlname", cache.getName(),
"sym", cache.isFound() ? "Geocache Found" : "Geocache",
"type", "Geocache|" + cache.getType().pattern);
gpx.startTag(PREFIX_GROUNDSPEAK, "cache");
gpx.attribute("", "id", cache.getCacheId());
gpx.attribute("", "available", !cache.isDisabled() ? "True" : "False");
gpx.attribute("", "archives", cache.isArchived() ? "True" : "False");
XmlUtils.multipleTexts(gpx, PREFIX_GROUNDSPEAK,
"name", cache.getName(),
"placed_by", cache.getOwnerDisplayName(),
"owner", cache.getOwnerUserId(),
"type", cache.getType().pattern,
"container", cache.getSize().id,
"difficulty", Float.toString(cache.getDifficulty()),
"terrain", Float.toString(cache.getTerrain()),
"country", cache.getLocation(),
"state", "",
"encoded_hints", cache.getHint());
writeAttributes(cache);
gpx.startTag(PREFIX_GROUNDSPEAK, "short_description");
gpx.attribute("", "html", TextUtils.containsHtml(cache.getShortDescription()) ? "True" : "False");
gpx.text(cache.getShortDescription());
gpx.endTag(PREFIX_GROUNDSPEAK, "short_description");
gpx.startTag(PREFIX_GROUNDSPEAK, "long_description");
gpx.attribute("", "html", TextUtils.containsHtml(cache.getDescription()) ? "True" : "False");
gpx.text(cache.getDescription());
gpx.endTag(PREFIX_GROUNDSPEAK, "long_description");
writeLogs(cache);
gpx.endTag(PREFIX_GROUNDSPEAK, "cache");
gpx.endTag(PREFIX_GPX, "wpt");
writeWaypoints(cache);
countExported++;
if (progressListener != null) {
progressListener.publishProgress(countExported);
}
}
}
private void writeWaypoints(final Geocache cache) throws IOException {
final List<Waypoint> waypoints = cache.getWaypoints();
final List<Waypoint> ownWaypoints = new ArrayList<Waypoint>(waypoints.size());
final List<Waypoint> originWaypoints = new ArrayList<Waypoint>(waypoints.size());
for (final Waypoint wp : cache.getWaypoints()) {
if (wp.isUserDefined()) {
ownWaypoints.add(wp);
} else {
originWaypoints.add(wp);
}
}
int maxPrefix = 0;
for (final Waypoint wp : originWaypoints) {
final String prefix = wp.getPrefix();
try {
final int numericPrefix = Integer.parseInt(prefix);
maxPrefix = Math.max(numericPrefix, maxPrefix);
} catch (final NumberFormatException ex) {
// ignore non numeric prefix, as it should be unique in the list of non-own waypoints already
}
writeCacheWaypoint(wp, prefix);
}
// Prefixes must be unique. There use numeric strings as prefixes in OWN waypoints
for (final Waypoint wp : ownWaypoints) {
maxPrefix++;
final String prefix = StringUtils.leftPad(String.valueOf(maxPrefix), 2, '0');
writeCacheWaypoint(wp, prefix);
}
}
/**
* Writes one waypoint entry for cache waypoint.
*
* @param cache
* The
* @param wp
* @param prefix
* @throws IOException
*/
private void writeCacheWaypoint(final Waypoint wp, final String prefix) throws IOException {
final Geopoint coords = wp.getCoords();
// TODO: create some extension to GPX to include waypoint without coords
if (coords != null) {
gpx.startTag(PREFIX_GPX, "wpt");
gpx.attribute("", "lat", Double.toString(coords.getLatitude()));
gpx.attribute("", "lon", Double.toString(coords.getLongitude()));
XmlUtils.multipleTexts(gpx, PREFIX_GPX,
"name", prefix + wp.getGeocode().substring(2),
"cmt", wp.getNote(),
"desc", wp.getName(),
"sym", wp.getWaypointType().toString(), //TODO: Correct identifier string
"type", "Waypoint|" + wp.getWaypointType().toString()); //TODO: Correct identifier string
gpx.endTag(PREFIX_GPX, "wpt");
}
}
private void writeLogs(final Geocache cache) throws IOException {
if (cache.getLogs().isEmpty()) {
return;
}
gpx.startTag(PREFIX_GROUNDSPEAK, "logs");
for (final LogEntry log : cache.getLogs()) {
gpx.startTag(PREFIX_GROUNDSPEAK, "log");
gpx.attribute("", "id", Integer.toString(log.id));
XmlUtils.multipleTexts(gpx, PREFIX_GROUNDSPEAK,
"date", dateFormatZ.format(new Date(log.date)),
"type", log.type.type);
gpx.startTag(PREFIX_GROUNDSPEAK, "finder");
gpx.attribute("", "id", "");
gpx.text(log.author);
gpx.endTag(PREFIX_GROUNDSPEAK, "finder");
gpx.startTag(PREFIX_GROUNDSPEAK, "text");
gpx.attribute("", "encoded", "False");
gpx.text(log.log);
gpx.endTag(PREFIX_GROUNDSPEAK, "text");
gpx.endTag(PREFIX_GROUNDSPEAK, "log");
}
gpx.endTag(PREFIX_GROUNDSPEAK, "logs");
}
private void writeAttributes(final Geocache cache) throws IOException {
if (cache.getAttributes().isEmpty()) {
return;
}
//TODO: Attribute conversion required: English verbose name, gpx-id
gpx.startTag(PREFIX_GROUNDSPEAK, "attributes");
for (final String attribute : cache.getAttributes()) {
final CacheAttribute attr = CacheAttribute.getByRawName(CacheAttribute.trimAttributeName(attribute));
if (attr == null) {
continue;
}
final boolean enabled = CacheAttribute.isEnabled(attribute);
gpx.startTag(PREFIX_GROUNDSPEAK, "attribute");
gpx.attribute("", "id", Integer.toString(attr.gcid));
gpx.attribute("", "inc", enabled ? "1" : "0");
gpx.text(attr.getL10n(enabled));
gpx.endTag(PREFIX_GROUNDSPEAK, "attribute");
}
gpx.endTag(PREFIX_GROUNDSPEAK, "attributes");
}
}
|
