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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
|
package cgeo.geocaching.utils;
import cgeo.geocaching.Geocache;
import cgeo.geocaching.LogEntry;
import cgeo.geocaching.R;
import cgeo.geocaching.Trackable;
import cgeo.geocaching.connector.ConnectorFactory;
import cgeo.geocaching.connector.IConnector;
import cgeo.geocaching.connector.capability.ILogin;
import cgeo.geocaching.settings.Settings;
import org.apache.commons.lang3.StringUtils;
import java.util.ArrayList;
/**
* Provides all the available templates for logging.
*
*/
public final class LogTemplateProvider {
private LogTemplateProvider() {
// utility class
}
/**
* Context aware data container for log templates.
* <p>
* Some log templates need additional information. To provide that information, it can be encapsulated in this log
* context.
* </p>
*
*/
public static class LogContext {
private Geocache cache;
private Trackable trackable;
private boolean offline = false;
private final LogEntry logEntry;
public LogContext(final Geocache cache, final LogEntry logEntry) {
this(cache, logEntry, false);
}
public LogContext(final Trackable trackable, final LogEntry logEntry) {
this.trackable = trackable;
this.logEntry = logEntry;
}
public LogContext(final Geocache cache, final LogEntry logEntry, final boolean offline) {
this.cache = cache;
this.offline = offline;
this.logEntry = logEntry;
}
public final Geocache getCache() {
return cache;
}
public final Trackable getTrackable() {
return trackable;
}
public final boolean isOffline() {
return offline;
}
public final LogEntry getLogEntry() {
return logEntry;
}
}
public abstract static class LogTemplate {
private final String template;
private final int resourceId;
protected LogTemplate(final String template, final int resourceId) {
this.template = template;
this.resourceId = resourceId;
}
public abstract String getValue(LogContext context);
public final int getResourceId() {
return resourceId;
}
public final int getItemId() {
return template.hashCode();
}
public final String getTemplateString() {
return template;
}
protected final String apply(final String input, final LogContext context) {
final String bracketedTemplate = "[" + template + "]";
// check containment first to not unconditionally call the getValue(...) method
if (input.contains(bracketedTemplate)) {
return StringUtils.replace(input, bracketedTemplate, getValue(context));
}
return input;
}
}
/**
* @return all templates, but not the signature template itself
*/
public static ArrayList<LogTemplate> getTemplatesWithoutSignature() {
final ArrayList<LogTemplate> templates = new ArrayList<>();
templates.add(new LogTemplate("DATE", R.string.init_signature_template_date) {
@Override
public String getValue(final LogContext context) {
return Formatter.formatFullDate(System.currentTimeMillis());
}
});
templates.add(new LogTemplate("TIME", R.string.init_signature_template_time) {
@Override
public String getValue(final LogContext context) {
return Formatter.formatTime(System.currentTimeMillis());
}
});
templates.add(new LogTemplate("DATETIME", R.string.init_signature_template_datetime) {
@Override
public String getValue(final LogContext context) {
final long currentTime = System.currentTimeMillis();
return Formatter.formatFullDate(currentTime) + " " + Formatter.formatTime(currentTime);
}
});
templates.add(new LogTemplate("USER", R.string.init_signature_template_user) {
@Override
public String getValue(final LogContext context) {
final Geocache cache = context.getCache();
if (cache != null) {
final IConnector connector = ConnectorFactory.getConnector(cache);
if (connector instanceof ILogin) {
return ((ILogin) connector).getUserName();
}
}
return Settings.getUsername();
}
});
templates.add(new LogTemplate("NUMBER", R.string.init_signature_template_number) {
@Override
public String getValue(final LogContext context) {
final Geocache cache = context.getCache();
if (cache == null) {
return StringUtils.EMPTY;
}
int current = 0;
final IConnector connector = ConnectorFactory.getConnector(cache);
if (connector instanceof ILogin) {
current = ((ILogin) connector).getCachesFound();
}
// try updating the login information, if the counter is zero
if (current == 0) {
if (context.isOffline()) {
return StringUtils.EMPTY;
}
if (connector instanceof ILogin) {
((ILogin) connector).login(null, null);
current = ((ILogin) connector).getCachesFound();
}
}
if (current >= 0) {
return String.valueOf(current + 1);
}
return StringUtils.EMPTY;
}
});
templates.add(new LogTemplate("OWNER", R.string.init_signature_template_owner) {
@Override
public String getValue(final LogContext context) {
final Trackable trackable = context.getTrackable();
if (trackable != null) {
return trackable.getOwner();
}
final Geocache cache = context.getCache();
if (cache != null) {
return cache.getOwnerDisplayName();
}
return StringUtils.EMPTY;
}
});
templates.add(new LogTemplate("NAME", R.string.init_signature_template_name) {
@Override
public String getValue(final LogContext context) {
final Trackable trackable = context.getTrackable();
if (trackable != null) {
return trackable.getName();
}
final Geocache cache = context.getCache();
if (cache != null) {
return cache.getName();
}
return StringUtils.EMPTY;
}
});
templates.add(new LogTemplate("URL", R.string.init_signature_template_url) {
@Override
public String getValue(final LogContext context) {
final Trackable trackable = context.getTrackable();
if (trackable != null) {
return trackable.getUrl();
}
final Geocache cache = context.getCache();
if (cache != null) {
return StringUtils.defaultString(cache.getUrl());
}
return StringUtils.EMPTY;
}
});
templates.add(new LogTemplate("LOG", R.string.init_signature_template_log) {
@Override
public String getValue(final LogContext context) {
final LogEntry logEntry = context.getLogEntry();
if (logEntry != null) {
return logEntry.getDisplayText();
}
return StringUtils.EMPTY;
}
});
return templates;
}
/**
* @return all templates, including the signature template
*/
public static ArrayList<LogTemplate> getTemplatesWithSignature() {
final ArrayList<LogTemplate> templates = getTemplatesWithoutSignature();
templates.add(new LogTemplate("SIGNATURE", R.string.init_signature) {
@Override
public String getValue(final LogContext context) {
final String nestedTemplate = StringUtils.defaultString(Settings.getSignature());
if (StringUtils.contains(nestedTemplate, "SIGNATURE")) {
return "invalid signature template";
}
return LogTemplateProvider.applyTemplates(nestedTemplate, context);
}
});
return templates;
}
public static LogTemplate getTemplate(final int itemId) {
for (final LogTemplate template : getTemplatesWithSignature()) {
if (template.getItemId() == itemId) {
return template;
}
}
return null;
}
public static String applyTemplates(final String signature, final LogContext context) {
if (signature == null) {
return StringUtils.EMPTY;
}
String result = signature;
for (final LogTemplate template : getTemplatesWithSignature()) {
result = template.apply(result, context);
}
return result;
}
}
|
