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
|
package cgeo.geocaching.files;
import cgeo.geocaching.Geocache;
import cgeo.geocaching.SearchResult;
import cgeo.geocaching.enumerations.CacheSize;
import cgeo.geocaching.enumerations.CacheType;
import cgeo.geocaching.location.Geopoint;
import cgeo.geocaching.utils.CancellableHandler;
import cgeo.geocaching.utils.Log;
import org.apache.commons.io.Charsets;
import org.apache.commons.lang3.StringUtils;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import org.xmlpull.v1.XmlPullParser;
import org.xmlpull.v1.XmlPullParserException;
import org.xmlpull.v1.XmlPullParserFactory;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
public final class LocParser extends FileParser {
@NonNull
private static final String NAME_OWNER_SEPARATOR = " by ";
@NonNull
private static final CacheSize[] SIZES = {
CacheSize.NOT_CHOSEN, // 1
CacheSize.MICRO, // 2
CacheSize.REGULAR, // 3
CacheSize.LARGE, // 4
CacheSize.VIRTUAL, // 5
CacheSize.OTHER, // 6
CacheSize.UNKNOWN, // 7
CacheSize.SMALL, // 8
};
// Used so that the initial value of the geocache is not null. Never filled.
@NonNull
private static final Geocache DUMMY_GEOCACHE = new Geocache();
private final int listId;
public static void parseLoc(final SearchResult searchResult, final String fileContent, final Set<Geocache> caches) {
final Map<String, Geocache> cidCoords = parseLoc(fileContent);
// save found cache coordinates
final HashSet<String> contained = new HashSet<>();
for (final String geocode : searchResult.getGeocodes()) {
if (cidCoords.containsKey(geocode)) {
contained.add(geocode);
}
}
for (final Geocache cache : caches) {
if (!cache.isReliableLatLon()) {
final Geocache coord = cidCoords.get(cache.getGeocode());
// Archived caches will not have any coordinates
if (coord != null) {
copyCoordToCache(coord, cache);
}
}
}
}
@NonNull
private static Map<String, Geocache> parseLoc(final String content) {
return parseLoc(new ByteArrayInputStream(content.getBytes(Charsets.UTF_8)));
}
@NonNull
private static Map<String, Geocache> parseLoc(final InputStream content) {
try {
final XmlPullParserFactory factory = XmlPullParserFactory.newInstance();
final XmlPullParser xpp = factory.newPullParser();
xpp.setInput(content, Charsets.UTF_8.name());
final Map<String, Geocache> caches = new HashMap<>();
int eventType = xpp.getEventType();
Geocache currentCache = DUMMY_GEOCACHE;
while (eventType != XmlPullParser.END_DOCUMENT) {
if (eventType == XmlPullParser.START_TAG) {
switch (xpp.getName()) {
case "waypoint":
currentCache = new Geocache();
currentCache.setType(CacheType.UNKNOWN); // Type not present in .loc file
break;
case "name":
currentCache.setGeocode(xpp.getAttributeValue(null, "id"));
if (xpp.next() == XmlPullParser.TEXT) {
final String nameOwner = xpp.getText();
currentCache.setName(StringUtils.trim(StringUtils.substringBeforeLast(nameOwner, NAME_OWNER_SEPARATOR)));
currentCache.setOwnerUserId(StringUtils.trim(StringUtils.substringAfterLast(nameOwner, NAME_OWNER_SEPARATOR)));
}
break;
case "coord":
currentCache.setCoords(new Geopoint(Double.valueOf(xpp.getAttributeValue(null, "lat")),
Double.valueOf(xpp.getAttributeValue(null, "lon"))));
currentCache.setReliableLatLon(true);
break;
case "container":
if (xpp.next() == XmlPullParser.TEXT) {
currentCache.setSize(SIZES[Integer.parseInt(xpp.getText()) - 1]);
}
break;
case "difficulty":
if (xpp.next() == XmlPullParser.TEXT) {
currentCache.setDifficulty(Float.valueOf(xpp.getText()));
}
break;
case "terrain":
if (xpp.next() == XmlPullParser.TEXT) {
currentCache.setTerrain(Float.valueOf(xpp.getText()));
}
break;
default:
// Ignore
}
} else if (eventType == XmlPullParser.END_TAG && xpp.getName().equals("waypoint") && StringUtils.isNotBlank(currentCache.getGeocode())) {
caches.put(currentCache.getGeocode(), currentCache);
}
eventType = xpp.next();
}
Log.d("Coordinates found in .loc content: " + caches.size());
return caches;
} catch (XmlPullParserException | IOException e) {
Log.e("unable to parse .loc content", e);
return Collections.emptyMap();
}
}
private static void copyCoordToCache(final Geocache coord, final Geocache cache) {
cache.setCoords(coord.getCoords());
cache.setDifficulty(coord.getDifficulty());
cache.setTerrain(coord.getTerrain());
cache.setSize(coord.getSize());
cache.setGeocode(coord.getGeocode());
cache.setReliableLatLon(true);
if (StringUtils.isBlank(cache.getName())) {
cache.setName(coord.getName());
}
cache.setOwnerUserId(coord.getOwnerUserId());
}
@NonNull
public static Geopoint parsePoint(final String latitude, final String longitude) {
// the loc file contains the coordinates as plain floating point values, therefore avoid using the GeopointParser
try {
return new Geopoint(Double.valueOf(latitude), Double.valueOf(longitude));
} catch (final NumberFormatException e) {
Log.e("LOC format has changed", e);
}
// fall back to parser, just in case the format changes
return new Geopoint(latitude, longitude);
}
public LocParser(final int listId) {
this.listId = listId;
}
@Override
@NonNull
public Collection<Geocache> parse(@NonNull final InputStream stream, @Nullable final CancellableHandler progressHandler) throws IOException, ParserException {
final int maxSize = stream.available();
final Map<String, Geocache> coords = parseLoc(stream);
final List<Geocache> caches = new ArrayList<>();
for (final Entry<String, Geocache> entry : coords.entrySet()) {
final Geocache cache = entry.getValue();
if (StringUtils.isBlank(cache.getGeocode()) || StringUtils.isBlank(cache.getName())) {
continue;
}
caches.add(cache);
fixCache(cache);
cache.setType(CacheType.UNKNOWN); // type is not given in the LOC file
cache.setListId(listId);
cache.setDetailed(true);
cache.store(null);
if (progressHandler != null) {
progressHandler.sendMessage(progressHandler.obtainMessage(0, maxSize * caches.size() / coords.size(), 0));
}
}
Log.i("Caches found in .loc file: " + caches.size());
return caches;
}
}
|
