Added Enfora protocol (fix #2)

5 files changed, 250 insertions, 1 deletions

diff --git a/default.cfg b/default.cfg
index b5c76fd42..65ead85df 100644
--- a/default.cfg
+++ b/default.cfg
@@ -127,4 +127,9 @@
     <entry key="avl08.port">5007</entry>
     <entry key="avl08.resetDelay">0</entry>
 
+    <!-- Enfora server configuration -->
+    <entry key="enfora.enable">true</entry>
+    <entry key="enfora.port">5008</entry>
+    <entry key="enfora.resetDelay">0</entry>
+
 </properties>
diff --git a/src/org/traccar/Server.java b/src/org/traccar/Server.java
index cbcb68324..a6b0a67da 100644
--- a/src/org/traccar/Server.java
+++ b/src/org/traccar/Server.java
@@ -24,10 +24,14 @@ import java.util.Date;
 import java.util.LinkedList;
 import java.util.List;
 import java.util.Properties;
-import java.util.logging.*;
+import java.util.logging.FileHandler;
+import java.util.logging.Formatter;
+import java.util.logging.Level;
+import java.util.logging.LogRecord;
 import org.jboss.netty.buffer.ChannelBuffers;
 import org.jboss.netty.channel.ChannelPipeline;
 import org.jboss.netty.handler.codec.frame.DelimiterBasedFrameDecoder;
+import org.jboss.netty.handler.codec.frame.LengthFieldBasedFrameDecoder;
 import org.jboss.netty.handler.codec.string.StringDecoder;
 import org.jboss.netty.handler.codec.string.StringEncoder;
 import org.traccar.helper.Log;
@@ -85,6 +89,7 @@ public class Server {
         initT55Server(properties);
         initXexun2Server(properties);
         initAvl08Server(properties);
+        initEnforaServer(properties);
 
         // Initialize web server
         if (Boolean.valueOf(properties.getProperty("http.enable"))) {
@@ -389,4 +394,26 @@ public class Server {
         }
     }
 
+    /**
+     * Init Enfora server
+     */
+    public void initEnforaServer(Properties properties) throws SQLException {
+
+        String protocol = "enfora";
+        if (isProtocolEnabled(properties, protocol)) {
+
+            TrackerServer server = new TrackerServer(getProtocolPort(properties, protocol));
+            final Integer resetDelay = getProtocolResetDelay(properties, protocol);
+
+            server.setPipelineFactory(new GenericPipelineFactory(server, dataManager, isLoggerEnabled()) {
+                protected void addSpecificHandlers(ChannelPipeline pipeline) {
+                    pipeline.addLast("frameDecoder", new LengthFieldBasedFrameDecoder(1024, 0, 2, -2, 2));
+                    pipeline.addLast("objectDecoder", new EnforaProtocolDecoder(getDataManager(), resetDelay));
+                }
+            });
+
+            serverList.add(server);
+        }
+    }
+
 }
diff --git a/src/org/traccar/protocol/EnforaProtocolDecoder.java b/src/org/traccar/protocol/EnforaProtocolDecoder.java
new file mode 100644
index 000000000..eb9cb8ae4
--- /dev/null
+++ b/src/org/traccar/protocol/EnforaProtocolDecoder.java
@@ -0,0 +1,187 @@
+/*
+ * Copyright 2012 Anton Tananaev (anton.tananaev@gmail.com)
+ *
+ * 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.protocol;
+
+import java.nio.charset.Charset;
+import java.util.Calendar;
+import java.util.GregorianCalendar;
+import java.util.TimeZone;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import org.jboss.netty.buffer.ChannelBuffer;
+import org.jboss.netty.channel.Channel;
+import org.jboss.netty.channel.ChannelHandlerContext;
+import org.traccar.GenericProtocolDecoder;
+import org.traccar.helper.Log;
+import org.traccar.model.DataManager;
+import org.traccar.model.Position;
+
+/**
+ * Enfora protocol decoder
+ */
+public class EnforaProtocolDecoder extends GenericProtocolDecoder {
+
+    /**
+     * Initialize
+     */
+    public EnforaProtocolDecoder(DataManager dataManager, Integer resetDelay) {
+        super(dataManager, resetDelay);
+    }
+
+    /**
+     * Regular expressions pattern
+     */
+    static private Pattern pattern = Pattern.compile(
+            "GPRMC," +
+            "(\\d{2})(\\d{2})(\\d{2}).(\\d{2})," + // Time (HHMMSS.SS)
+            "([AV])," +                  // Validity
+            "(\\d{2})(\\d{2}.\\d{6})," + // Latitude (DDMM.MMMMMM)
+            "([NS])," +
+            "(\\d{3})(\\d{2}.\\d{6})," + // Longitude (DDDMM.MMMMMM)
+            "([EW])," +
+            "(\\d+.\\d)?," +             // Speed
+            "(\\d+.\\d)?," +             // Course
+            "(\\d{2})(\\d{2})(\\d{2})," + // Date (DDMMYY)
+            ".*[\r\n]*");
+
+    public static final int IMEI_LENGTH = 15;
+
+    // TODO: avoid copy-paste (from XexunFrameDecoder)
+    private static Integer find(
+            ChannelBuffer buf,
+            Integer start,
+            Integer length,
+            String subString) {
+
+        int index = start;
+        boolean match;
+
+        for (; index < length; index++) {
+            match = true;
+
+            for (int i = 0; i < subString.length(); i++) {
+                char c = (char) buf.getByte(index + i);
+                if (c != subString.charAt(i)) {
+                    match = false;
+                    break;
+                }
+            }
+
+            if (match) {
+                return index;
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * Decode message
+     */
+    protected Object decode(
+            ChannelHandlerContext ctx, Channel channel, Object msg)
+            throws Exception {
+
+        ChannelBuffer buf = (ChannelBuffer) msg;
+
+        // Find IMEI (Modem ID)
+        String imei = null;
+        for (int first = -1, i = 0; i < buf.readableBytes(); i++) {
+            if (!Character.isDigit((char) buf.getByte(i))) {
+                first = i + 1;
+            }
+
+            // Found digit string
+            if (i - first == IMEI_LENGTH - 1) {
+                imei = buf.toString(first, IMEI_LENGTH, Charset.defaultCharset());
+                break;
+            }
+        }
+
+        // Write log
+        if (imei == null) {
+            Log.warning("Enfora decoder failed to find IMEI");
+            return null;
+        }
+
+        // Find GPSMC string
+        Integer start = find(buf, 0, buf.readableBytes(), "GPRMC");
+        if (start == null) {
+            // Message does not contain GPS data
+            return null;
+        }
+        String sentence = buf.toString(start, buf.readableBytes() - start, Charset.defaultCharset());
+
+        // Parse message
+        Matcher parser = pattern.matcher(sentence);
+        if (!parser.matches()) {
+            return null;
+        }
+
+        // Create new position
+        Position position = new Position();
+        Integer index = 1;
+
+        // Get device by IMEI
+        position.setDeviceId(getDataManager().getDeviceByImei(imei).getId());
+
+        // Time
+        Calendar time = new GregorianCalendar(TimeZone.getTimeZone("UTC"));
+        time.clear();
+        time.set(Calendar.HOUR, Integer.valueOf(parser.group(index++)));
+        time.set(Calendar.MINUTE, Integer.valueOf(parser.group(index++)));
+        time.set(Calendar.SECOND, Integer.valueOf(parser.group(index++)));
+        time.set(Calendar.MILLISECOND, Integer.valueOf(parser.group(index++)) * 10);
+
+        // Validity
+        position.setValid(parser.group(index++).compareTo("A") == 0 ? true : false);
+
+        // Latitude
+        Double latitude = Double.valueOf(parser.group(index++));
+        latitude += Double.valueOf(parser.group(index++)) / 60;
+        if (parser.group(index++).compareTo("S") == 0) latitude = -latitude;
+        position.setLatitude(latitude);
+
+        // Longitude
+        Double lonlitude = Double.valueOf(parser.group(index++));
+        lonlitude += Double.valueOf(parser.group(index++)) / 60;
+        if (parser.group(index++).compareTo("W") == 0) lonlitude = -lonlitude;
+        position.setLongitude(lonlitude);
+
+        // Altitude
+        position.setAltitude(0.0);
+
+        // Speed
+        position.setSpeed(Double.valueOf(parser.group(index++)));
+
+        // Course
+        String course = parser.group(index++);
+        if (course != null) {
+            position.setCourse(Double.valueOf(course));
+        } else {
+            position.setCourse(0.0);
+        }
+
+        // Date
+        time.set(Calendar.DAY_OF_MONTH, Integer.valueOf(parser.group(index++)));
+        time.set(Calendar.MONTH, Integer.valueOf(parser.group(index++)) - 1);
+        time.set(Calendar.YEAR, 2000 + Integer.valueOf(parser.group(index++)));
+        position.setTime(time.getTime());
+
+        return position;
+    }
+
+}
diff --git a/test.sh b/test.sh
index f05fa9514..269d6d2ab 100755
--- a/test.sh
+++ b/test.sh
@@ -32,3 +32,6 @@ echo "6. xexun2"
 echo "7. avl08"
 (echo -n -e "\$\$B3123456789012345|AA\$GPRMC,120700.000,A,6000.0000,N,13000.0000,E,0.00,,010112,,,A*74|01.8|01.0|01.5|000000000000|20120403234603|14251914|00000000|0012D888|0000|0.0000|3674|940B\r\n";) | nc -v localhost 5007
 
+echo "8. enfora"
+(echo -n -e "\x00\x71\x00\x04\x02\x00                 123456789012345 13 \$GPRMC,120800.00,A,6000.000000,N,13000.000000,E,0.0,0.0,010112,,,A*52\r\n";) | nc -v localhost 5008
+
diff --git a/test/org/traccar/protocol/EnforaProtocolDecoderTest.java b/test/org/traccar/protocol/EnforaProtocolDecoderTest.java
new file mode 100644
index 000000000..9830e0c2f
--- /dev/null
+++ b/test/org/traccar/protocol/EnforaProtocolDecoderTest.java
@@ -0,0 +1,27 @@
+package org.traccar.protocol;
+
+import org.jboss.netty.buffer.ChannelBufferFactory;
+import org.jboss.netty.buffer.HeapChannelBufferFactory;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNull;
+import org.junit.Test;
+
+public class EnforaProtocolDecoderTest {
+
+    @Test
+    public void testDecode() throws Exception {
+
+        EnforaProtocolDecoder decoder = new EnforaProtocolDecoder(new TestDataManager(), 0);
+        ChannelBufferFactory factory = new HeapChannelBufferFactory();
+
+        byte[] buf1 = {0x00,0x0A,0x08,0x00,0x20,0x20,0x20,0x20,0x20,0x30,0x31,0x31,0x30,0x37,0x30,0x30,0x30,0x30,0x35,0x37,0x30,0x32,0x36,0x37};
+        assertNull(decoder.decode(null, null, factory.getBuffer(buf1, 0, buf1.length)));
+
+        byte[] buf2 = {0x00,0x3B,0x00,0x05,0x02,0x00,0x00,0x00,0x00,0x08,0x20,0x20,0x20,0x20,0x20,0x20,0x30,0x31,0x31,0x30,0x37,0x30,0x30,0x30,0x30,0x35,0x37,0x30,0x32,0x36,0x37,0x20,0x38,0x3A,0x00,0x00,0x00,0x00,0x0D,0x00,0x50,(byte)0x84,0x01,0x35,(byte)0x8E,0x64,0x00,0x32,(byte)0xB3,0x77,0x00,0x00,0x03,0x67,(byte)0xB0,0x00,0x00,(byte)0xA8,0x04};
+        assertNull(decoder.decode(null, null, factory.getBuffer(buf2, 0, buf2.length)));
+
+        byte[] buf3 = {0x00,0x71,0x00,0x04,0x02,0x00,0x20,0x20,0x20,0x20,0x20,0x20,0x20,0x20,0x20,0x38,0x20,0x20,0x20,0x20,0x20,0x20,0x20,0x31,0x32,0x33,0x34,0x35,0x36,0x37,0x38,0x39,0x30,0x31,0x32,0x33,0x34,0x35,0x20,0x31,0x33,0x20,0x24,0x47,0x50,0x52,0x4D,0x43,0x2C,0x32,0x32,0x33,0x31,0x35,0x32,0x2E,0x30,0x30,0x2C,0x41,0x2C,0x33,0x35,0x30,0x39,0x2E,0x38,0x36,0x30,0x35,0x39,0x34,0x2C,0x4E,0x2C,0x30,0x33,0x33,0x32,0x32,0x2E,0x37,0x34,0x33,0x38,0x38,0x37,0x2C,0x45,0x2C,0x30,0x2E,0x30,0x2C,0x30,0x2E,0x30,0x2C,0x30,0x32,0x30,0x36,0x31,0x32,0x2C,0x2C,0x2C,0x41,0x2A,0x35,0x32,0x0D,0x0A};
+        assertNotNull(decoder.decode(null, null, factory.getBuffer(buf3, 0, buf3.length)));
+    }
+
+}