Implement mail templates

Author: Abyss777

pom.xml

@@ -138,7 +138,11 @@
             <artifactId>jxls-poi</artifactId>
             <version>1.0.11</version>
         </dependency>
-
+        <dependency>
+            <groupId>org.apache.velocity</groupId>
+            <artifactId>velocity</artifactId>
+            <version>1.7</version>
+        </dependency>
     </dependencies>
 
     <build>

src/org/traccar/Context.java

@@ -17,6 +17,9 @@
 
 import com.ning.http.client.AsyncHttpClient;
 
+import java.util.Properties;
+
+import org.apache.velocity.app.VelocityEngine;
 import org.traccar.database.AliasesManager;
 import org.traccar.database.ConnectionManager;
 import org.traccar.database.DataManager;
@@ -125,6 +128,12 @@ public static NotificationManager getNotificationManager() {
         return notificationManager;
     }
 
+    private static VelocityEngine velocityEngine;
+
+    public static VelocityEngine getVelocityEngine() {
+        return velocityEngine;
+    }
+
     private static final AsyncHttpClient ASYNC_HTTP_CLIENT = new AsyncHttpClient();
 
     public static AsyncHttpClient getAsyncHttpClient() {
@@ -242,6 +251,13 @@ public static void init(String[] arguments) throws Exception {
 
         if (config.getBoolean("event.enable")) {
             notificationManager = new NotificationManager(dataManager);
+            Properties velocityProperties = new Properties();
+            velocityProperties.setProperty("file.resource.loader.path",
+                    Context.getConfig().getString("mail.templatesPath", "templates/mail") + "/");
+            velocityProperties.setProperty("runtime.log.logsystem.class",
+                    "org.apache.velocity.runtime.log.NullLogChute");
+            velocityEngine = new VelocityEngine();
+            velocityEngine.init(velocityProperties);
         }
 
         serverManager = new ServerManager();

src/org/traccar/notification/NotificationFormatter.java

@@ -15,223 +15,65 @@
  */
 package org.traccar.notification;
 
-import java.text.DecimalFormat;
-import java.util.Formatter;
-import java.util.Locale;
+import java.io.StringWriter;
 
+import org.apache.velocity.Template;
+import org.apache.velocity.VelocityContext;
+import org.apache.velocity.exception.ResourceNotFoundException;
 import org.traccar.Context;
-import org.traccar.helper.UnitsConverter;
+import org.traccar.helper.Log;
 import org.traccar.model.Device;
 import org.traccar.model.Event;
 import org.traccar.model.Position;
+import org.traccar.reports.ReportUtils;
 
 public final class NotificationFormatter {
 
-    private NotificationFormatter() {
+    public static class MailMessage {
+        private String subject;
+        private String body;
+        public MailMessage(String subject, String body) {
+            this.subject = subject;
+            this.body = body;
+        }
+        public String getSubject() {
+            return subject;
+        }
+        public String getBody() {
+            return body;
+        }
     }
 
-    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: https://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: https://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: https://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: https://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: https://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: https://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: https://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: https://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 = "%1$s: maintenance is required";
-    public static final String MESSAGE_TEMPLATE_TYPE_MAINTENANCE = "Device: %1$s%n"
-            + "Maintenance is required%n"
-            + "Point: https://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:
-                formatter.format(TITLE_TEMPLATE_TYPE_MAINTENANCE, device.getName());
-                break;
-            default:
-                formatter.format("Unknown type");
-                break;
-        }
-        String result = formatter.toString();
-        formatter.close();
-        return result;
+    private NotificationFormatter() {
     }
 
-    public static String formatMessage(long userId, Event event, Position position) {
+    public static MailMessage 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:
-                formatter.format(MESSAGE_TEMPLATE_TYPE_MAINTENANCE, device.getName(), position.getFixTime(),
-                        position.getLatitude(), position.getLongitude());
-                break;
-            default:
-                formatter.format("Unknown type");
-                break;
+        VelocityContext velocityContext = new VelocityContext();
+        velocityContext.put("device", device);
+        velocityContext.put("event", event);
+        if (position != null) {
+            velocityContext.put("position", position);
+            velocityContext.put("speedUnits", ReportUtils.getSpeedUnit(userId));
+        }
+        if (event.getGeofenceId() != 0) {
+            velocityContext.put("geofence", Context.getGeofenceManager().getGeofence(event.getGeofenceId()));
         }
-        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;
+        Template template = null;
+        try {
+            template = Context.getVelocityEngine().getTemplate(event.getType() + ".vm");
+        } catch (ResourceNotFoundException error) {
+            Log.warning(error);
         }
-        return result;
+        if (template == null) {
+            template = Context.getVelocityEngine().getTemplate("unknown.vm");
+        }
+
+        StringWriter writer = new StringWriter();
+        template.merge(velocityContext, writer);
+        String subject = (String) velocityContext.get("subject");
+        return new MailMessage(subject, writer.toString());
     }
 }

src/org/traccar/notification/NotificationMail.java

@@ -29,6 +29,7 @@
 import org.traccar.model.Event;
 import org.traccar.model.Position;
 import org.traccar.model.User;
+import org.traccar.notification.NotificationFormatter.MailMessage;
 
 public final class NotificationMail {
 
@@ -106,8 +107,9 @@ public static void sendMailSync(long userId, Event event, Position position) thr
         }
 
         message.addRecipient(Message.RecipientType.TO, new InternetAddress(user.getEmail()));
-        message.setSubject(NotificationFormatter.formatTitle(userId, event, position));
-        message.setText(NotificationFormatter.formatMessage(userId, event, position));
+        MailMessage mailMessage = NotificationFormatter.formatMessage(userId, event, position);
+        message.setSubject(mailMessage.getSubject());
+        message.setContent(mailMessage.getBody(), "text/html; charset=utf-8");
 
         Transport transport = session.getTransport();
         try {

templates/mail/alarm.vm

@@ -0,0 +1,10 @@
+#set($subject = "$device.name: alarm!")
+<!DOCTYPE html>
+<html>
+<body>
+Device: $device.name<br>
+Alarm:  $position.getString("alarm")<br>
+Point: <a href="https://www.openstreetmap.org/?mlat=$position.latitude&mlon=$position.longitude#map=16/$position.latitude/$position.longitude">#if($position.address)$position.address#{else}$position.latitude°, $position.longitude°#end</a><br>
+Time: $event.serverTime<br>
+</body>
+</html>  

templates/mail/commandResult.vm

@@ -0,0 +1,9 @@
+#set($subject = "$device.name: command result received")
+<!DOCTYPE html>
+<html>
+<body>
+Device: $device.name<br>
+Result: $position.getString("result")<br>
+Time: $event.serverTime<br>
+</body>
+</html>  

templates/mail/deviceMoving.vm

@@ -0,0 +1,10 @@
+#set($subject = "$device.name: moving")
+<!DOCTYPE html>
+<html>
+<body>
+Device: $device.name<br>
+Moving<br>
+Point: <a href="https://www.openstreetmap.org/?mlat=$position.latitude&mlon=$position.longitude#map=16/$position.latitude/$position.longitude">#if($position.address)$position.address#{else}$position.latitude°, $position.longitude°#end</a><br>
+Time: $event.serverTime<br>
+</body>
+</html>  

templates/mail/deviceOffline.vm

@@ -0,0 +1,9 @@
+#set($subject = "$device.name: offline")
+<!DOCTYPE html>
+<html>
+<body>
+Device: $device.name<br>
+Offline<br>
+Time: $event.serverTime<br>
+</body>
+</html>  

templates/mail/deviceOnline.vm

@@ -0,0 +1,9 @@
+#set($subject = "$device.name: online")
+<!DOCTYPE html>
+<html>
+<body>
+Device: $device.name<br>
+Online<br>
+Time: $event.serverTime<br>
+</body>
+</html>