Merge pull request #1 from rogin/kelaompachai/main

query OIE's GH releases API

Author: kelaompachai

server/build.xml

@@ -1269,6 +1269,7 @@
 		<copy todir="${test_classes}">
 			<fileset dir="${test}">
 				<include name="**/*.xml" />
+				<include name="**/*.json" />
 			</fileset>
 		</copy>
 

server/src/com/mirth/connect/client/core/ConnectServiceUtil.java

@@ -9,13 +9,19 @@
 
 package com.mirth.connect.client.core;
 
+import java.io.IOException;
 import java.net.URI;
 import java.nio.charset.Charset;
-import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
+import java.util.Spliterator;
+import java.util.Spliterators;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+import java.util.stream.StreamSupport;
 
 import org.apache.commons.httpclient.HttpStatus;
 import org.apache.commons.io.IOUtils;
@@ -26,9 +32,7 @@
 import org.apache.http.client.config.RequestConfig;
 import org.apache.http.client.entity.UrlEncodedFormEntity;
 import org.apache.http.client.methods.CloseableHttpResponse;
-
 import org.apache.http.client.methods.HttpGet;
-
 import org.apache.http.client.methods.HttpPost;
 import org.apache.http.client.protocol.HttpClientContext;
 import org.apache.http.client.utils.HttpClientUtils;
@@ -45,6 +49,7 @@
 import org.apache.http.util.EntityUtils;
 
 import com.fasterxml.jackson.core.type.TypeReference;
+import com.fasterxml.jackson.databind.JsonMappingException;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.mirth.connect.model.User;
@@ -57,7 +62,7 @@ public class ConnectServiceUtil {
     private final static String URL_REGISTRATION_SERVLET = "/RegistrationServlet";
     private final static String URL_USAGE_SERVLET = "/UsageStatisticsServlet";
     private final static String URL_NOTIFICATION_SERVLET = "/NotificationServlet";
-    private static String NOTIFICATION_GET = "getNotifications";
+    private static String URL_NOTIFICATIONS = "https://api.github.com/repos/openintegrationengine/engine/releases";
     private static String NOTIFICATION_COUNT_GET = "getNotificationCount";
     private final static int TIMEOUT = 10000;
     public final static Integer MILLIS_PER_DAY = 86400000;
@@ -92,190 +97,181 @@ public static void registerUser(String serverId, String mirthVersion, User user,
         }
     }
 
+    /**
+     * Query an external source for new releases. Return notifications for each release that's greater than the current version.
+     * 
+     * @param serverId
+     * @param mirthVersion
+     * @param extensionVersions
+     * @param protocols
+     * @param cipherSuites
+     * @return a non-null list
+     * @throws Exception should anything fail dealing with the web request and the handling of its response
+     */
     public static List<Notification> getNotifications(String serverId, String mirthVersion, Map<String, String> extensionVersions, String[] protocols, String[] cipherSuites) throws Exception {
-        List<Notification> allNotifications = new ArrayList<Notification>();
-
-        System.out.println("Entered getNotifications");
+        List<Notification> validNotifications = Collections.emptyList();
 
-        // make an api call
-
-        // CloseableHttpClient client = HttpClients.createDefault();
-        CloseableHttpClient client = null;
-        CloseableHttpResponse response = null;
+        CloseableHttpClient httpClient = null;
+        CloseableHttpResponse httpResponse = null;
+        HttpEntity responseEntity = null;
 
-        HttpGet get = new HttpGet("https://api.github.com/repos/nextgenhealthcare/connect/releases");
-        
         try {
-            ObjectMapper mapper = new ObjectMapper();
-
-            client = getClient(protocols, cipherSuites);
-            response = client.execute(get);
-            System.out.println(response.getStatusLine());
-            HttpEntity entity1 = response.getEntity();
-            String responseContent = IOUtils.toString(entity1.getContent(), "utf8");
- 
-
-            JsonNode rootNode = mapper.readTree(responseContent);
-
-            String[] mirthVersionStringArr = mirthVersion.split("[\\.]");
-            int[] mirthVersionIntArr = new int[mirthVersionStringArr.length];
-            for (int i = 0; i < mirthVersionStringArr.length; i++) {
-                mirthVersionIntArr[i] = Integer.parseInt(mirthVersionStringArr[i]);
-            }
-
-
-            
-
-            for (JsonNode childNode : rootNode) {
-
-                
-                if (!checkNotificationVersion(mirthVersionIntArr, childNode.get("tag_name").asText())) break;
-
-                Notification notification = new Notification();
-             
-                notification.setId(childNode.get("id").asInt());
-                notification.setName(childNode.get("name").asText());
-                notification.setDate(childNode.get("published_at").asText());
+            HttpClientContext getContext = HttpClientContext.create();
+            getContext.setRequestConfig(createRequestConfig());
+            httpClient = getClient(protocols, cipherSuites);
+            httpResponse = httpClient.execute(new HttpGet(URL_NOTIFICATIONS), getContext);
 
-                // create the content html
-                String content = createNotificationHtml(childNode.get("name").asText(), childNode.get("html_url").asText());
-                notification.setContent(content);
+            int statusCode = httpResponse.getStatusLine().getStatusCode();
+            if (statusCode == HttpStatus.SC_OK) {
+                responseEntity = httpResponse.getEntity();
 
-                allNotifications.add(notification);
+                var newerOnly = filterForNewerVersions(toJsonStream(responseEntity), mirthVersion);
+                validNotifications = newerOnly.map(node -> toNotification(node)).collect(Collectors.toList());
+            } else {
+                throw new ClientException("Status code: " + statusCode);
             }
-
-            // and ensure it is fully consumed
-            EntityUtils.consume(entity1);
-
-
-        } catch (Exception e) {
-            System.out.print(e);
-            e.printStackTrace();
-            throw e;
         } finally {
-            HttpClientUtils.closeQuietly(client);
-            HttpClientUtils.closeQuietly(response);
+            EntityUtils.consumeQuietly(responseEntity);
+            HttpClientUtils.closeQuietly(httpResponse);
+            HttpClientUtils.closeQuietly(httpClient);
         }
 
-        return allNotifications;
+        return validNotifications;
     }
 
-    private static String createNotificationHtml (String name, String releaseUrl) {
-        // System.out.println("Entered createNotificationHtml");
-
-        // should arguments be sanitized?
-        // apache string escape utils??
-
-        String escapedName = StringEscapeUtils.escapeHtml4(name);
-        String escapedReleaseUrl = StringEscapeUtils.escapeHtml4(releaseUrl);
-
-        StringBuilder content = new StringBuilder();
-
-        // create header with name
-        content.append("<h2>");
-        content.append(escapedName);
-        content.append("</h2>");
-
-        // announce there is a new version with a p element
-        content.append("<h3>");
-        content.append("A new version of Mirth Connect is available!");
-        content.append("</h3>");
-
-        // create a link to the release webpage
-        content.append("<a href=\"" + escapedReleaseUrl + "\">");
-        content.append("Release Webpage");
-        content.append("</a>");
-
-        return content.toString();
+    /**
+     * Create a request config with appropriate network timeouts.
+     * 
+     * @return
+     */
+    private static RequestConfig createRequestConfig() {
+        return RequestConfig.custom().setConnectTimeout(TIMEOUT).setConnectionRequestTimeout(TIMEOUT).setSocketTimeout(TIMEOUT).build();
     }
 
-    private static boolean checkNotificationVersion (int[] mirthVersionArr, String notificationVersion) {
-        // checks release notifications to see whether they are unnecessary because user has already fully updated
-
-
-        String[] notificationVersionStringArr = notificationVersion.split("[\\.]");
-        int[] notificationVersionIntArr = new int[notificationVersionStringArr.length];
-
-
-        for (int i = 0; i < notificationVersionStringArr.length; i += 1) {
-            notificationVersionIntArr[i] = Integer.parseInt(notificationVersionStringArr[i]);
-        }
-
-        int lengthOfShorter = Math.min(mirthVersionArr.length, notificationVersionIntArr.length);
+    /**
+     * Filter the stream to only new versions, then create a notification for each.
+     * 
+     * @param nodes
+     * @param currentVersion
+     * @return a non-null List
+     */
+    protected static Stream<JsonNode> filterForNewerVersions(Stream<JsonNode> nodes, String currentVersion) {
+        int[] curVersion = toVersionArray(currentVersion);
+        return nodes.takeWhile(node -> isCurrentOlderThan(curVersion, node.get("tag_name").asText()));
+    }
 
-        for (int i = 0; i < lengthOfShorter; i++) {
-            if (mirthVersionArr[i] > notificationVersionIntArr[i]) return false;
-        }
+    /**
+     * Convert a JSON response to a stream of {@link JsonNode}.
+     * 
+     * @param responseEntity
+     * @return a stream
+     * @throws IOException
+     * @throws JsonMappingException
+     */
+    protected static Stream<JsonNode> toJsonStream(HttpEntity responseEntity) throws IOException, JsonMappingException {
+        String responseContent = getResponseContent(responseEntity);
+
+        JsonNode rootNode = new ObjectMapper().readTree(responseContent);
+
+        //convert to stream to simplify
+        return StreamSupport.stream(
+            Spliterators.spliteratorUnknownSize(rootNode.elements(), Spliterator.ORDERED),false);
+    }
 
-        // if the user's mirth version is a subpatch of the patch this notification is for, return false
-        if (mirthVersionArr.length > notificationVersionIntArr.length) return false;
+    /**
+     * Extract the reponse content. It attempts to use the charset found in the response, if any.
+     * 
+     * @param responseEntity
+     * @return
+     * @throws IOException
+     */
+    protected static String getResponseContent(HttpEntity responseEntity) throws IOException {
+        return IOUtils.toString(responseEntity.getContent(), getCharset(responseEntity));
+    }
 
-        // if the user is using the version that this notification is for, return false
-        if (mirthVersionArr[mirthVersionArr.length - 1] == notificationVersionIntArr[notificationVersionIntArr.length - 1]) return false;
-        
-        return true;   
+    /**
+     * Try pulling a charset from the given response. Default to {@link ContentType#TEXT_PLAIN}.
+     * 
+     * @param responseEntity
+     * @return
+     */
+    protected static Charset getCharset(HttpEntity responseEntity) {
+        Charset charset = ContentType.TEXT_PLAIN.getCharset();
+        try {
+            charset = ContentType.getOrDefault(responseEntity).getCharset();
+        } catch (Exception ignore) {}
+        return charset;
     }
 
-    public static List<Notification> getNotifications2(String serverId, String mirthVersion, Map<String, String> extensionVersions, String[] protocols, String[] cipherSuites) throws Exception {
+    /**
+     * Split a given version string into an int[].
+     * 
+     * @param version
+     * @return
+     */
+    protected static int[] toVersionArray(String version) {
+        return Arrays.stream(version.split("[\\.]")).mapToInt(Integer::parseInt).toArray();
+    }
 
-        System.out.println("Entered getNotifications2");
+    /**
+     * Compare the current version with another. If current is greater than or equal, this returns false.
+     * 
+     * @param currentVersion
+     * @param anotherVersion
+     * @return true if the current version is less than than the other
+     */
+    protected static boolean isCurrentOlderThan (int[] currentVersion, String anotherVersion) {
+        return Arrays.compare(currentVersion, toVersionArray(anotherVersion)) < 0;
+    }
 
+    /**
+     * Given a JSON node from a GitHub release feed, convert it to a HTML notification.
+     * 
+     * @param node
+     * @return a notification with HTML content
+     */
+    protected static Notification toNotification(JsonNode node) {
+        Notification notification = new Notification();
+             
+        notification.setId(node.get("id").asInt());
+        notification.setName(node.get("name").asText());
+        notification.setDate(node.get("published_at").asText());
 
-        CloseableHttpClient client = null;
-        HttpPost post = new HttpPost();
-        CloseableHttpResponse response = null;
+        // create the content html
+        String content = toNotificationContent(node);
+        notification.setContent(content);
 
-        List<Notification> allNotifications = new ArrayList<Notification>();
+        return notification;
+    }
 
-        try {
-            ObjectMapper mapper = new ObjectMapper();
-            String extensionVersionsJson = mapper.writeValueAsString(extensionVersions);
-            NameValuePair[] params = { new BasicNameValuePair("op", NOTIFICATION_GET),
-                    new BasicNameValuePair("serverId", serverId),
-                    new BasicNameValuePair("version", mirthVersion),
-                    new BasicNameValuePair("extensionVersions", extensionVersionsJson) };
-            RequestConfig requestConfig = RequestConfig.custom().setConnectTimeout(TIMEOUT).setConnectionRequestTimeout(TIMEOUT).setSocketTimeout(TIMEOUT).build();
+    /**
+     * Create the HTML content for a notification.
+     * 
+     * @param node
+     * @return an HTML String
+     */
+    protected static String toNotificationContent (JsonNode node) {
+        String escapedName = StringEscapeUtils.escapeHtml4(node.get("name").asText());
+        String escapedReleaseUrl = StringEscapeUtils.escapeHtml4(node.get("html_url").asText());
 
-            post.setURI(URI.create(URL_CONNECT_SERVER + URL_NOTIFICATION_SERVLET));
-            post.setEntity(new UrlEncodedFormEntity(Arrays.asList(params), Charset.forName("UTF-8")));
+        StringBuilder content = new StringBuilder(256);
 
-            HttpClientContext postContext = HttpClientContext.create();
-            postContext.setRequestConfig(requestConfig);
-            client = getClient(protocols, cipherSuites);
-            response = client.execute(post, postContext);
-            StatusLine statusLine = response.getStatusLine();
-            int statusCode = statusLine.getStatusCode();
-            if ((statusCode == HttpStatus.SC_OK)) {
-                HttpEntity responseEntity = response.getEntity();
-                Charset responseCharset = null;
-                try {
-                    responseCharset = ContentType.getOrDefault(responseEntity).getCharset();
-                } catch (Exception e) {
-                    responseCharset = ContentType.TEXT_PLAIN.getCharset();
-                }
+        // create header with name
+        content.append("<h2>")
+            .append(escapedName)
+            .append("</h2>");
 
-                String responseContent = IOUtils.toString(responseEntity.getContent(), responseCharset).trim();
-                JsonNode rootNode = mapper.readTree(responseContent);
+        // announce there is a new version
+        content.append("<h3>")
+            .append("A new version of Open Integration Engine is available!")
+            .append("</h3>");
 
-                for (JsonNode childNode : rootNode) {
-                    Notification notification = new Notification();
-                    notification.setId(childNode.get("id").asInt());
-                    notification.setName(childNode.get("name").asText());
-                    notification.setDate(childNode.get("date").asText());
-                    notification.setContent(childNode.get("content").asText());
-                    allNotifications.add(notification);
-                }
-            } else {
-                throw new ClientException("Status code: " + statusCode);
-            }
-        } catch (Exception e) {
-            throw e;
-        } finally {
-            HttpClientUtils.closeQuietly(response);
-            HttpClientUtils.closeQuietly(client);
-        }
+        // create a link to the release webpage
+        content.append("<a href=\"" + escapedReleaseUrl + "\">")
+            .append("Release Webpage")
+            .append("</a>");
 
-        return allNotifications;
+        return content.toString();
     }
 
     public static int getNotificationCount(String serverId, String mirthVersion, Map<String, String> extensionVersions, Set<Integer> archivedNotifications, String[] protocols, String[] cipherSuites) {