Implement Globalstar SPOT protocol

4 files changed, 160 insertions, 0 deletions

diff --git a/setup/default.xml b/setup/default.xml
index c5708633f..b59bfe474 100644
--- a/setup/default.xml
+++ b/setup/default.xml
@@ -224,5 +224,6 @@
     <entry key='ivt401.port'>5153</entry>
     <entry key='sigfox.port'>5154</entry>
     <entry key='t57.port'>5155</entry>
+    <entry key='spot.port'>5156</entry>
 
 </properties>
diff --git a/src/org/traccar/protocol/SpotProtocol.java b/src/org/traccar/protocol/SpotProtocol.java
new file mode 100644
index 000000000..cd5ab90f6
--- /dev/null
+++ b/src/org/traccar/protocol/SpotProtocol.java
@@ -0,0 +1,47 @@
+/*
+ * Copyright 2017 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.protocol;
+
+import org.jboss.netty.bootstrap.ServerBootstrap;
+import org.jboss.netty.channel.ChannelPipeline;
+import org.jboss.netty.handler.codec.http.HttpChunkAggregator;
+import org.jboss.netty.handler.codec.http.HttpRequestDecoder;
+import org.jboss.netty.handler.codec.http.HttpResponseEncoder;
+import org.traccar.BaseProtocol;
+import org.traccar.TrackerServer;
+
+import java.util.List;
+
+public class SpotProtocol extends BaseProtocol {
+
+    public SpotProtocol() {
+        super("spot");
+    }
+
+    @Override
+    public void initTrackerServers(List<TrackerServer> serverList) {
+        serverList.add(new TrackerServer(new ServerBootstrap(), getName()) {
+            @Override
+            protected void addSpecificHandlers(ChannelPipeline pipeline) {
+                pipeline.addLast("httpEncoder", new HttpResponseEncoder());
+                pipeline.addLast("httpDecoder", new HttpRequestDecoder());
+                pipeline.addLast("httpAggregator", new HttpChunkAggregator(65535));
+                pipeline.addLast("objectDecoder", new SpotProtocolDecoder(SpotProtocol.this));
+            }
+        });
+    }
+
+}
diff --git a/src/org/traccar/protocol/SpotProtocolDecoder.java b/src/org/traccar/protocol/SpotProtocolDecoder.java
new file mode 100644
index 000000000..ed6a03c5f
--- /dev/null
+++ b/src/org/traccar/protocol/SpotProtocolDecoder.java
@@ -0,0 +1,93 @@
+/*
+ * Copyright 2017 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.protocol;
+
+import com.fasterxml.jackson.databind.util.ByteBufferBackedInputStream;
+import org.jboss.netty.channel.Channel;
+import org.jboss.netty.handler.codec.http.HttpRequest;
+import org.jboss.netty.handler.codec.http.HttpResponseStatus;
+import org.traccar.BaseHttpProtocolDecoder;
+import org.traccar.DeviceSession;
+import org.traccar.helper.DateUtil;
+import org.traccar.model.Position;
+import org.w3c.dom.Document;
+import org.w3c.dom.Node;
+import org.w3c.dom.NodeList;
+
+import javax.xml.parsers.DocumentBuilder;
+import javax.xml.parsers.DocumentBuilderFactory;
+import javax.xml.parsers.ParserConfigurationException;
+import javax.xml.xpath.XPath;
+import javax.xml.xpath.XPathConstants;
+import javax.xml.xpath.XPathExpression;
+import javax.xml.xpath.XPathExpressionException;
+import javax.xml.xpath.XPathFactory;
+import java.net.SocketAddress;
+import java.util.LinkedList;
+import java.util.List;
+
+public class SpotProtocolDecoder extends BaseHttpProtocolDecoder {
+
+    private DocumentBuilder documentBuilder;
+    private XPath xPath;
+    private XPathExpression messageExpression;
+
+    public SpotProtocolDecoder(SpotProtocol protocol) {
+        super(protocol);
+        try {
+            documentBuilder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
+            xPath = XPathFactory.newInstance().newXPath();
+            messageExpression = xPath.compile("//messageList/message");
+        } catch (ParserConfigurationException | XPathExpressionException e) {
+            throw new RuntimeException(e);
+        }
+    }
+
+    @Override
+    protected Object decode(
+            Channel channel, SocketAddress remoteAddress, Object msg) throws Exception {
+
+        HttpRequest request = (HttpRequest) msg;
+
+        Document document = documentBuilder.parse(new ByteBufferBackedInputStream(request.getContent().toByteBuffer()));
+        NodeList nodes = (NodeList) messageExpression.evaluate(document, XPathConstants.NODESET);
+
+        List<Position> positions = new LinkedList<>();
+
+        for (int i = 0; i < nodes.getLength(); i++) {
+            Node node = nodes.item(i);
+            DeviceSession deviceSession = getDeviceSession(channel, remoteAddress, xPath.evaluate("esnName", node));
+            if (deviceSession != null) {
+
+                Position position = new Position();
+                position.setProtocol(getProtocolName());
+                position.setDeviceId(deviceSession.getDeviceId());
+
+                position.setValid(true);
+                position.setTime(DateUtil.parseDate(xPath.evaluate("timestamp", node)));
+                position.setLatitude(Double.parseDouble(xPath.evaluate("latitude", node)));
+                position.setLongitude(Double.parseDouble(xPath.evaluate("longitude", node)));
+
+                positions.add(position);
+
+            }
+        }
+
+        sendResponse(channel, HttpResponseStatus.OK);
+        return positions;
+    }
+
+}
diff --git a/test/org/traccar/protocol/SpotProtocolDecoderTest.java b/test/org/traccar/protocol/SpotProtocolDecoderTest.java
new file mode 100644
index 000000000..3d6feeca0
--- /dev/null
+++ b/test/org/traccar/protocol/SpotProtocolDecoderTest.java
@@ -0,0 +1,19 @@
+package org.traccar.protocol;
+
+import org.jboss.netty.handler.codec.http.HttpMethod;
+import org.junit.Test;
+import org.traccar.ProtocolTest;
+
+public class SpotProtocolDecoderTest extends ProtocolTest {
+
+    @Test
+    public void testDecode() throws Exception {
+
+        SpotProtocolDecoder decoder = new SpotProtocolDecoder(new SpotProtocol());
+
+        verifyPositions(decoder, request(HttpMethod.POST, "/",
+                buffer("<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<messageList xmlns=\"http://v2.shared.globalstar.com\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:schemaLocation=\"http://v2.shared.globalstar.com http://share.findmespot.com/shared/schema/spotXml-v2.xsd\">\n    <header>\n        <totalCount>1</totalCount>\n        <mode>LIVE</mode>\n    </header>\n    <message>\n        <id>891801957</id>\n        <esn>0-3112123</esn>\n        <esnName>0-3112123a</esnName>\n        <messageType>NEWMOVEMENT</messageType>\n        <messageDetail> SPOT Trace has detected that the asset has moved.</messageDetail>\n        <timestamp>2017-12-27T13:19:38.000Z</timestamp>\n        <timeInGMTSecond>1514380778</timeInGMTSecond>\n        <latitude>-1.28781</latitude>\n        <longitude>-47.93042</longitude>\n        <batteryState>GOOD</batteryState>\n    </message>\n</messageList>")));
+
+    }
+
+}