aboutsummaryrefslogtreecommitdiff
path: root/src/org/traccar/notification/NotificationFormatter.java
blob: d21c05afe38cb139aa75484319958ead353cfa25 (plain)
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
/*
 * Copyright 2016 Anton Tananaev (anton@traccar.org)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.traccar.notification;

import java.text.DecimalFormat;
import java.util.Formatter;
import java.util.Locale;

import org.traccar.Context;
import org.traccar.helper.UnitsConverter;
import org.traccar.model.Device;
import org.traccar.model.Event;
import org.traccar.model.Position;

public final class NotificationFormatter {

    private NotificationFormatter() {
    }

    public static final String TITLE_TEMPLATE_TYPE_COMMAND_RESULT = "%1$s: command result received";
    public static final String MESSAGE_TEMPLATE_TYPE_COMMAND_RESULT = "Device: %1$s%n"
            + "Result: %3$s%n"
            + "Time: %2$tc%n";

    public static final String TITLE_TEMPLATE_TYPE_DEVICE_ONLINE = "%1$s: online";
    public static final String MESSAGE_TEMPLATE_TYPE_DEVICE_ONLINE = "Device: %1$s%n"
            + "Online%n"
            + "Time: %2$tc%n";
    public static final String TITLE_TEMPLATE_TYPE_DEVICE_UNKNOWN = "%1$s: status is unknown";
    public static final String MESSAGE_TEMPLATE_TYPE_DEVICE_UNKNOWN = "Device: %1$s%n"
            + "Status is unknown%n"
            + "Time: %2$tc%n";
    public static final String TITLE_TEMPLATE_TYPE_DEVICE_OFFLINE = "%1$s: offline";
    public static final String MESSAGE_TEMPLATE_TYPE_DEVICE_OFFLINE = "Device: %1$s%n"
            + "Offline%n"
            + "Time: %2$tc%n";

    public static final String TITLE_TEMPLATE_TYPE_DEVICE_MOVING = "%1$s: moving";
    public static final String MESSAGE_TEMPLATE_TYPE_DEVICE_MOVING = "Device: %1$s%n"
            + "Moving%n"
            + "Point: http://www.openstreetmap.org/?mlat=%3$f&mlon=%4$f#map=16/%3$f/%4$f%n"
            + "Time: %2$tc%n";
    public static final String TITLE_TEMPLATE_TYPE_DEVICE_STOPPED = "%1$s: stopped";
    public static final String MESSAGE_TEMPLATE_TYPE_DEVICE_STOPPED = "Device: %1$s%n"
            + "Stopped%n"
            + "Point: http://www.openstreetmap.org/?mlat=%3$f&mlon=%4$f#map=16/%3$f/%4$f%n"
            + "Time: %2$tc%n";

    public static final String TITLE_TEMPLATE_TYPE_DEVICE_OVERSPEED = "%1$s: exceeds the speed";
    public static final String MESSAGE_TEMPLATE_TYPE_DEVICE_OVERSPEED = "Device: %1$s%n"
            + "Exceeds the speed: %5$s%n"
            + "Point: http://www.openstreetmap.org/?mlat=%3$f&mlon=%4$f#map=16/%3$f/%4$f%n"
            + "Time: %2$tc%n";

    public static final String TITLE_TEMPLATE_TYPE_GEOFENCE_ENTER = "%1$s: has entered geofence";
    public static final String MESSAGE_TEMPLATE_TYPE_GEOFENCE_ENTER = "Device: %1$s%n"
            + "Has entered geofence: %5$s%n"
            + "Point: http://www.openstreetmap.org/?mlat=%3$f&mlon=%4$f#map=16/%3$f/%4$f%n"
            + "Time: %2$tc%n";
    public static final String TITLE_TEMPLATE_TYPE_GEOFENCE_EXIT = "%1$s: has exited geofence";
    public static final String MESSAGE_TEMPLATE_TYPE_GEOFENCE_EXIT = "Device: %1$s%n"
            + "Has exited geofence: %5$s%n"
            + "Point: http://www.openstreetmap.org/?mlat=%3$f&mlon=%4$f#map=16/%3$f/%4$f%n"
            + "Time: %2$tc%n";

    public static final String TITLE_TEMPLATE_TYPE_ALARM = "%1$s: alarm!";
    public static final String MESSAGE_TEMPLATE_TYPE_ALARM = "Device: %1$s%n"
            + "Alarm: %5$s%n"
            + "Point: http://www.openstreetmap.org/?mlat=%3$f&mlon=%4$f#map=16/%3$f/%4$f%n"
            + "Time: %2$tc%n";

    public static final String TITLE_TEMPLATE_TYPE_IGNITION_ON = "%1$s: ignition ON";
    public static final String MESSAGE_TEMPLATE_TYPE_IGNITION_ON = "Device: %1$s%n"
            + "Ignition ON%n"
            + "Point: http://www.openstreetmap.org/?mlat=%3$f&mlon=%4$f#map=16/%3$f/%4$f%n"
            + "Time: %2$tc%n";
    public static final String TITLE_TEMPLATE_TYPE_IGNITION_OFF = "%1$s: ignition OFF";
    public static final String MESSAGE_TEMPLATE_TYPE_IGNITION_OFF = "Device: %1$s%n"
            + "Ignition OFF%n"
            + "Point: http://www.openstreetmap.org/?mlat=%3$f&mlon=%4$f#map=16/%3$f/%4$f%n"
            + "Time: %2$tc%n";
    public static final String TITLE_TEMPLATE_TYPE_MAINTENANCE_NEED = "%1$s: maintenance is needed";
    public static final String MESSAGE_TEMPLATE_TYPE_MAINTENANCE_NEED = "Device: %1$s%n"
            + "Maintenance is needed%n"
            + "Point: http://www.openstreetmap.org/?mlat=%3$f&mlon=%4$f#map=16/%3$f/%4$f%n"
            + "Time: %2$tc%n";

    public static String formatTitle(long userId, Event event, Position position) {
        Device device = Context.getIdentityManager().getDeviceById(event.getDeviceId());
        StringBuilder stringBuilder = new StringBuilder();
        Formatter formatter = new Formatter(stringBuilder, Locale.getDefault());

        switch (event.getType()) {
            case Event.TYPE_COMMAND_RESULT:
                formatter.format(TITLE_TEMPLATE_TYPE_COMMAND_RESULT, device.getName());
                break;
            case Event.TYPE_DEVICE_ONLINE:
                formatter.format(TITLE_TEMPLATE_TYPE_DEVICE_ONLINE, device.getName());
                break;
            case Event.TYPE_DEVICE_UNKNOWN:
                formatter.format(TITLE_TEMPLATE_TYPE_DEVICE_UNKNOWN, device.getName());
                break;
            case Event.TYPE_DEVICE_OFFLINE:
                formatter.format(TITLE_TEMPLATE_TYPE_DEVICE_OFFLINE, device.getName());
                break;
            case Event.TYPE_DEVICE_MOVING:
                formatter.format(TITLE_TEMPLATE_TYPE_DEVICE_MOVING, device.getName());
                break;
            case Event.TYPE_DEVICE_STOPPED:
                formatter.format(TITLE_TEMPLATE_TYPE_DEVICE_STOPPED, device.getName());
                break;
            case Event.TYPE_DEVICE_OVERSPEED:
                formatter.format(TITLE_TEMPLATE_TYPE_DEVICE_OVERSPEED, device.getName());
                break;
            case Event.TYPE_GEOFENCE_ENTER:
                formatter.format(TITLE_TEMPLATE_TYPE_GEOFENCE_ENTER, device.getName());
                break;
            case Event.TYPE_GEOFENCE_EXIT:
                formatter.format(TITLE_TEMPLATE_TYPE_GEOFENCE_EXIT, device.getName());
                break;
            case Event.TYPE_ALARM:
                formatter.format(TITLE_TEMPLATE_TYPE_ALARM, device.getName());
                break;
            case Event.TYPE_IGNITION_ON:
                formatter.format(TITLE_TEMPLATE_TYPE_IGNITION_ON, device.getName());
                break;
            case Event.TYPE_IGNITION_OFF:
                formatter.format(TITLE_TEMPLATE_TYPE_IGNITION_OFF, device.getName());
                break;
            case Event.TYPE_MAINTENANCE_NEED:
                formatter.format(TITLE_TEMPLATE_TYPE_MAINTENANCE_NEED, device.getName());
                break;
            default:
                formatter.format("Unknown type");
                break;
        }
        String result = formatter.toString();
        formatter.close();
        return result;
    }

    public static String formatMessage(long userId, Event event, Position position) {
        Device device = Context.getIdentityManager().getDeviceById(event.getDeviceId());
        StringBuilder stringBuilder = new StringBuilder();
        Formatter formatter = new Formatter(stringBuilder, Locale.getDefault());

        switch (event.getType()) {
            case Event.TYPE_COMMAND_RESULT:
                formatter.format(MESSAGE_TEMPLATE_TYPE_COMMAND_RESULT, device.getName(), event.getServerTime(),
                        position.getAttributes().get(Position.KEY_RESULT));
                break;
            case Event.TYPE_DEVICE_ONLINE:
                formatter.format(MESSAGE_TEMPLATE_TYPE_DEVICE_ONLINE, device.getName(), event.getServerTime());
                break;
            case Event.TYPE_DEVICE_UNKNOWN:
                formatter.format(MESSAGE_TEMPLATE_TYPE_DEVICE_UNKNOWN, device.getName(), event.getServerTime());
                break;
            case Event.TYPE_DEVICE_OFFLINE:
                formatter.format(MESSAGE_TEMPLATE_TYPE_DEVICE_OFFLINE, device.getName(), event.getServerTime());
                break;
            case Event.TYPE_DEVICE_MOVING:
                formatter.format(MESSAGE_TEMPLATE_TYPE_DEVICE_MOVING, device.getName(), position.getFixTime(),
                        position.getLatitude(), position.getLongitude());
                break;
            case Event.TYPE_DEVICE_STOPPED:
                formatter.format(MESSAGE_TEMPLATE_TYPE_DEVICE_STOPPED, device.getName(), position.getFixTime(),
                        position.getLatitude(), position.getLongitude());
                break;
            case Event.TYPE_DEVICE_OVERSPEED:
                formatter.format(MESSAGE_TEMPLATE_TYPE_DEVICE_OVERSPEED, device.getName(), position.getFixTime(),
                        position.getLatitude(), position.getLongitude(), formatSpeed(userId, position.getSpeed()));
                break;
            case Event.TYPE_GEOFENCE_ENTER:
                formatter.format(MESSAGE_TEMPLATE_TYPE_GEOFENCE_ENTER, device.getName(), position.getFixTime(),
                        position.getLatitude(), position.getLongitude(),
                        Context.getGeofenceManager().getGeofence(event.getGeofenceId()).getName());
                break;
            case Event.TYPE_GEOFENCE_EXIT:
                formatter.format(MESSAGE_TEMPLATE_TYPE_GEOFENCE_EXIT, device.getName(), position.getFixTime(),
                        position.getLatitude(), position.getLongitude(),
                        Context.getGeofenceManager().getGeofence(event.getGeofenceId()).getName());
                break;
            case Event.TYPE_ALARM:
                formatter.format(MESSAGE_TEMPLATE_TYPE_ALARM, device.getName(), event.getServerTime(),
                        position.getLatitude(), position.getLongitude(),
                        position.getAttributes().get(Position.KEY_ALARM));
                break;
            case Event.TYPE_IGNITION_ON:
                formatter.format(MESSAGE_TEMPLATE_TYPE_IGNITION_ON, device.getName(), position.getFixTime(),
                        position.getLatitude(), position.getLongitude());
                break;
            case Event.TYPE_IGNITION_OFF:
                formatter.format(MESSAGE_TEMPLATE_TYPE_IGNITION_OFF, device.getName(), position.getFixTime(),
                        position.getLatitude(), position.getLongitude());
                break;
            case Event.TYPE_MAINTENANCE_NEED:
                formatter.format(MESSAGE_TEMPLATE_TYPE_MAINTENANCE_NEED, device.getName(), position.getFixTime(),
                        position.getLatitude(), position.getLongitude());
                break;
            default:
                formatter.format("Unknown type");
                break;
        }
        String result = formatter.toString();
        formatter.close();
        return result;
    }

    private static String formatSpeed(long userId, double speed) {
        DecimalFormat df = new DecimalFormat("#.##");
        String result = df.format(speed) + " kn";
        switch (Context.getPermissionsManager().getUser(userId).getSpeedUnit()) {
            case "kmh":
                result = df.format(UnitsConverter.kphFromKnots(speed)) + " km/h";
                break;
            case "mph":
                result = df.format(UnitsConverter.mphFromKnots(speed)) + " mph";
                break;
            default:
                break;
        }
        return result;
    }
}