/* * Copyright 2015 - 2022 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; import com.fasterxml.jackson.core.JsonProcessingException; import com.fasterxml.jackson.databind.ObjectMapper; import io.netty.channel.ChannelHandler; import io.netty.util.Timer; import io.netty.util.Timeout; import io.netty.util.TimerTask; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.traccar.config.Config; import org.traccar.config.Keys; import org.traccar.helper.Checksum; import org.traccar.model.Device; import org.traccar.model.Position; import org.traccar.model.Group; import org.traccar.session.cache.CacheManager; import javax.inject.Inject; import javax.ws.rs.core.HttpHeaders; import javax.ws.rs.core.MediaType; import javax.ws.rs.core.Response; import javax.ws.rs.client.Client; import javax.ws.rs.client.Entity; import javax.ws.rs.client.Invocation; import javax.ws.rs.client.InvocationCallback; import java.util.HashMap; import java.util.Map; import java.io.UnsupportedEncodingException; import java.net.URLEncoder; import java.nio.charset.StandardCharsets; import java.util.Calendar; import java.util.Formatter; import java.util.Locale; import java.util.TimeZone; import java.util.concurrent.TimeUnit; import java.util.concurrent.atomic.AtomicInteger; @ChannelHandler.Sharable public class WebDataHandler extends BaseDataHandler { private static final Logger LOGGER = LoggerFactory.getLogger(WebDataHandler.class); private static final String KEY_POSITION = "position"; private static final String KEY_DEVICE = "device"; private final CacheManager cacheManager; private final ObjectMapper objectMapper; private final Client client; private final Timer timer; private final String url; private final String header; private final boolean json; private final boolean urlVariables; private final boolean retryEnabled; private final int retryDelay; private final int retryCount; private final int retryLimit; private final AtomicInteger deliveryPending; @Inject public WebDataHandler( Config config, CacheManager cacheManager, ObjectMapper objectMapper, Client client, Timer timer) { this.cacheManager = cacheManager; this.objectMapper = objectMapper; this.client = client; this.timer = timer; this.url = config.getString(Keys.FORWARD_URL); this.header = config.getString(Keys.FORWARD_HEADER); this.json = config.getBoolean(Keys.FORWARD_JSON); this.urlVariables = config.getBoolean(Keys.FORWARD_URL_VARIABLES); this.retryEnabled = config.getBoolean(Keys.FORWARD_RETRY_ENABLE); this.retryDelay = config.getInteger(Keys.FORWARD_RETRY_DELAY, 100); this.retryCount = config.getInteger(Keys.FORWARD_RETRY_COUNT, 10); this.retryLimit = config.getInteger(Keys.FORWARD_RETRY_LIMIT, 100); this.deliveryPending = new AtomicInteger(0); } private static String formatSentence(Position position) { StringBuilder s = new StringBuilder("$GPRMC,"); try (Formatter f = new Formatter(s, Locale.ENGLISH)) { Calendar calendar = Calendar.getInstance(TimeZone.getTimeZone("UTC"), Locale.ENGLISH); calendar.setTimeInMillis(position.getFixTime().getTime()); f.format("%1$tH%1$tM%1$tS.%1$tL,A,", calendar); double lat = position.getLatitude(); double lon = position.getLongitude(); f.format("%02d%07.4f,%c,", (int) Math.abs(lat), Math.abs(lat) % 1 * 60, lat < 0 ? 'S' : 'N'); f.format("%03d%07.4f,%c,", (int) Math.abs(lon), Math.abs(lon) % 1 * 60, lon < 0 ? 'W' : 'E'); f.format("%.2f,%.2f,", position.getSpeed(), position.getCourse()); f.format("%1$td%1$tm%1$ty,,", calendar); } s.append(Checksum.nmea(s.substring(1))); return s.toString(); } private String calculateStatus(Position position) { if (position.hasAttribute(Position.KEY_ALARM)) { return "0xF841"; // STATUS_PANIC_ON } else if (position.getSpeed() < 1.0) { return "0xF020"; // STATUS_LOCATION } else { return "0xF11C"; // STATUS_MOTION_MOVING } } public String formatRequest(Position position) throws UnsupportedEncodingException, JsonProcessingException { Device device = cacheManager.getObject(Device.class, position.getDeviceId()); String request = url .replace("{name}", URLEncoder.encode(device.getName(), StandardCharsets.UTF_8.name())) .replace("{uniqueId}", device.getUniqueId()) .replace("{status}", device.getStatus()) .replace("{deviceId}", String.valueOf(position.getDeviceId())) .replace("{protocol}", String.valueOf(position.getProtocol())) .replace("{deviceTime}", String.valueOf(position.getDeviceTime().getTime())) .replace("{fixTime}", String.valueOf(position.getFixTime().getTime())) .replace("{valid}", String.valueOf(position.getValid())) .replace("{latitude}", String.valueOf(position.getLatitude())) .replace("{longitude}", String.valueOf(position.getLongitude())) .replace("{altitude}", String.valueOf(position.getAltitude())) .replace("{speed}", String.valueOf(position.getSpeed())) .replace("{course}", String.valueOf(position.getCourse())) .replace("{accuracy}", String.valueOf(position.getAccuracy())) .replace("{statusCode}", calculateStatus(position)); if (position.getAddress() != null) { request = request.replace( "{address}", URLEncoder.encode(position.getAddress(), StandardCharsets.UTF_8.name())); } if (request.contains("{attributes}")) { String attributes = objectMapper.writeValueAsString(position.getAttributes()); request = request.replace( "{attributes}", URLEncoder.encode(attributes, StandardCharsets.UTF_8.name())); } if (request.contains("{gprmc}")) { request = request.replace("{gprmc}", formatSentence(position)); } if (request.contains("{group}")) { String deviceGroupName = ""; if (device.getGroupId() != 0) { Group group = cacheManager.getObject(Group.class, device.getGroupId()); if (group != null) { deviceGroupName = group.getName(); } } request = request.replace("{group}", URLEncoder.encode(deviceGroupName, StandardCharsets.UTF_8.name())); } return request; } class AsyncRequestAndCallback implements InvocationCallback<Response>, TimerTask { private int retries = 0; private Map<String, Object> payload; private final Invocation.Builder requestBuilder; private MediaType mediaType = MediaType.APPLICATION_JSON_TYPE; AsyncRequestAndCallback(Position position) { String formattedUrl; try { formattedUrl = json && !urlVariables ? url : formatRequest(position); } catch (UnsupportedEncodingException | JsonProcessingException e) { throw new RuntimeException("Forwarding formatting error", e); } requestBuilder = client.target(formattedUrl).request(); if (header != null && !header.isEmpty()) { for (String line: header.split("\\r?\\n")) { String[] values = line.split(":", 2); String headerName = values[0].trim(); String headerValue = values[1].trim(); if (headerName.equals(HttpHeaders.CONTENT_TYPE)) { mediaType = MediaType.valueOf(headerValue); } else { requestBuilder.header(headerName, headerValue); } } } if (json) { payload = prepareJsonPayload(position); } deliveryPending.incrementAndGet(); } private void send() { LOGGER.debug("Position forwarding initiated"); if (json) { try { Entity<String> entity = Entity.entity(objectMapper.writeValueAsString(payload), mediaType); requestBuilder.async().post(entity, this); } catch (JsonProcessingException e) { throw new RuntimeException("Failed to serialize location to json", e); } } else { requestBuilder.async().get(this); } } private void retry(Throwable throwable) { boolean scheduled = false; try { if (retryEnabled && deliveryPending.get() <= retryLimit && retries < retryCount) { schedule(); scheduled = true; } } finally { int pending = scheduled ? deliveryPending.get() : deliveryPending.decrementAndGet(); LOGGER.warn("Position forwarding failed: " + pending + " pending", throwable); } } private void schedule() { timer.newTimeout(this, retryDelay * (long) Math.pow(2, retries++), TimeUnit.MILLISECONDS); } @Override public void completed(Response response) { if (response.getStatusInfo().getFamily() == Response.Status.Family.SUCCESSFUL) { deliveryPending.decrementAndGet(); LOGGER.debug("Position forwarding succeeded"); } else { retry(new RuntimeException("Status code 2xx expected")); } } @Override public void failed(Throwable throwable) { retry(throwable); } @Override public void run(Timeout timeout) { boolean sent = false; try { if (!timeout.isCancelled()) { send(); sent = true; } } finally { if (!sent) { deliveryPending.decrementAndGet(); } } } } @Override protected Position handlePosition(Position position) { if (url != null) { AsyncRequestAndCallback request = new AsyncRequestAndCallback(position); request.send(); } return position; } private Map<String, Object> prepareJsonPayload(Position position) { Map<String, Object> data = new HashMap<>(); Device device = cacheManager.getObject(Device.class, position.getDeviceId()); data.put(KEY_POSITION, position); if (device != null) { data.put(KEY_DEVICE, device); } return data; } }