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
|
package cgeo.geocaching.utils;
import cgeo.geocaching.Geocache;
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 cgeo.geocaching.ui.Formatter;
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;
public LogContext(final Geocache cache) {
this(cache, false);
}
public LogContext(final Trackable trackable) {
this.trackable = trackable;
}
public LogContext(final boolean offline) {
this(null, offline);
}
public LogContext(final Geocache cache, final boolean offline) {
this.cache = cache;
this.offline = offline;
}
public final Geocache getCache() {
return cache;
}
public final Trackable getTrackable() {
return trackable;
}
public final boolean isOffline() {
return offline;
}
}
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;
}
}
public static ArrayList<LogTemplate> getTemplates() {
ArrayList<LogTemplate> templates = new ArrayList<LogTemplateProvider.LogTemplate>();
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) {
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) {
Trackable trackable = context.getTrackable();
if (trackable != null) {
return trackable.getOwner();
}
Geocache cache = context.getCache();
if (cache != null) {
return cache.getOwnerDisplayName();
}
return StringUtils.EMPTY;
}
});
return templates;
}
public static LogTemplate getTemplate(final int itemId) {
for (LogTemplate template : getTemplates()) {
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 (LogTemplate template : getTemplates()) {
result = template.apply(result, context);
}
return result;
}
}
|
