implement gateway selection based on geoip service

3 files changed, 76 insertions, 67 deletions

diff --git a/app/src/main/java/se/leap/bitmaskclient/eip/EIP.java b/app/src/main/java/se/leap/bitmaskclient/eip/EIP.java
index 34c88ef9..e0c96ebb 100644
--- a/app/src/main/java/se/leap/bitmaskclient/eip/EIP.java
+++ b/app/src/main/java/se/leap/bitmaskclient/eip/EIP.java
@@ -226,7 +226,7 @@ public final class EIP extends JobIntentService implements Observer {
             return;
         }
 
-        GatewaysManager gatewaysManager = gatewaysFromPreferences();
+        GatewaysManager gatewaysManager = new GatewaysManager(getApplicationContext());
         if (gatewaysManager.isEmpty()) {
             setErrorResult(result, warning_client_parsing_error_gateways, null);
             tellToReceiverOrBroadcast(this, EIP_ACTION_START, RESULT_CANCELED, result);
@@ -248,7 +248,7 @@ public final class EIP extends JobIntentService implements Observer {
      * The {@link OnBootReceiver} will care if there is no profile.
      */
     private void startEIPAlwaysOnVpn() {
-        GatewaysManager gatewaysManager = gatewaysFromPreferences();
+        GatewaysManager gatewaysManager = new GatewaysManager(getApplicationContext());
         Gateway gateway = gatewaysManager.select(0);
 
         if (!launchActiveGateway(gateway, 0)) {
@@ -310,15 +310,6 @@ public final class EIP extends JobIntentService implements Observer {
     }
 
     /**
-     * read eipServiceJson from preferences and parse Gateways
-     *
-     * @return GatewaysManager
-     */
-    private GatewaysManager gatewaysFromPreferences() {
-        return new GatewaysManager(getApplicationContext(), preferences);
-    }
-
-    /**
      * read VPN certificate from preferences and check it
      * broadcast result
      */
diff --git a/app/src/main/java/se/leap/bitmaskclient/eip/Gateway.java b/app/src/main/java/se/leap/bitmaskclient/eip/Gateway.java
index 66c9fe84..589fa751 100644
--- a/app/src/main/java/se/leap/bitmaskclient/eip/Gateway.java
+++ b/app/src/main/java/se/leap/bitmaskclient/eip/Gateway.java
@@ -34,6 +34,7 @@ import de.blinkt.openvpn.core.ConfigParser;
 import de.blinkt.openvpn.core.connection.Connection;
 import se.leap.bitmaskclient.utils.PreferenceHelper;
 
+import static se.leap.bitmaskclient.Constants.HOST;
 import static se.leap.bitmaskclient.Constants.IP_ADDRESS;
 import static se.leap.bitmaskclient.Constants.LOCATION;
 import static se.leap.bitmaskclient.Constants.LOCATIONS;
@@ -114,6 +115,10 @@ public class Gateway {
         return gateway.optString(IP_ADDRESS);
     }
 
+    public String getHost() {
+        return gateway.optString(HOST);
+    }
+
     private String locationAsName(JSONObject eipDefinition) {
         JSONObject location = getLocationInfo(eipDefinition);
         return location.optString(NAME);
diff --git a/app/src/main/java/se/leap/bitmaskclient/eip/GatewaysManager.java b/app/src/main/java/se/leap/bitmaskclient/eip/GatewaysManager.java
index fbe1861a..e3932cb6 100644
--- a/app/src/main/java/se/leap/bitmaskclient/eip/GatewaysManager.java
+++ b/app/src/main/java/se/leap/bitmaskclient/eip/GatewaysManager.java
@@ -17,7 +17,6 @@
 package se.leap.bitmaskclient.eip;
 
 import android.content.Context;
-import android.content.SharedPreferences;
 
 import com.google.gson.Gson;
 import com.google.gson.reflect.TypeToken;
@@ -30,6 +29,7 @@ import java.io.IOException;
 import java.lang.reflect.Type;
 import java.util.ArrayList;
 import java.util.LinkedHashMap;
+import java.util.List;
 
 import de.blinkt.openvpn.VpnProfile;
 import de.blinkt.openvpn.core.ConfigParser;
@@ -37,7 +37,6 @@ import de.blinkt.openvpn.core.VpnStatus;
 import de.blinkt.openvpn.core.connection.Connection;
 import se.leap.bitmaskclient.Provider;
 import se.leap.bitmaskclient.ProviderObservable;
-import se.leap.bitmaskclient.utils.PreferenceHelper;
 
 import static de.blinkt.openvpn.core.connection.Connection.TransportType.OBFS4;
 import static de.blinkt.openvpn.core.connection.Connection.TransportType.OPENVPN;
@@ -54,15 +53,9 @@ public class GatewaysManager {
     private static final String TAG = GatewaysManager.class.getSimpleName();
 
     private Context context;
-    private SharedPreferences preferences;
     private LinkedHashMap<String, Gateway> gateways = new LinkedHashMap<>();
     private Type listType = new TypeToken<ArrayList<Gateway>>() {}.getType();
-
-    public GatewaysManager(Context context, SharedPreferences preferences) {
-        this.preferences = preferences;
-        this.context = context;
-        configureFromPreferences();
-    }
+    private ArrayList<Gateway> presortedList = new ArrayList<>();
 
     public GatewaysManager(Context context) {
         configureFromCurrentProvider();
@@ -75,7 +68,18 @@ public class GatewaysManager {
      */
     public Gateway select(int nClosest) {
         Connection.TransportType transportType = getUsePluggableTransports(context) ? OBFS4 : OPENVPN;
-        GatewaySelector gatewaySelector = new GatewaySelector(new ArrayList<>(gateways.values()));
+
+        if (presortedList.size() > 0) {
+           return getGatewayFromPreorderedList(nClosest, transportType);
+        }
+
+        return getGatewayFromTimezoneCalculation(nClosest, transportType);
+    }
+
+
+    private Gateway getGatewayFromTimezoneCalculation(int nClosest, Connection.TransportType transportType) {
+        List<Gateway> list = new ArrayList<>(gateways.values());
+        GatewaySelector gatewaySelector = new GatewaySelector(list);
         Gateway gateway;
         while ((gateway = gatewaySelector.select(nClosest)) != null) {
             if (gateway.getProfile(transportType) != null) {
@@ -86,6 +90,17 @@ public class GatewaysManager {
         return null;
     }
 
+    private Gateway getGatewayFromPreorderedList(int nClosest, Connection.TransportType transportType) {
+        while (nClosest < presortedList.size()) {
+            Gateway gateway = presortedList.get(nClosest);
+            if (gateway.getProfile(transportType) != null) {
+                return gateway;
+            }
+            nClosest++;
+        }
+        return null;
+    }
+
     /**
      * Get position of the gateway from a sorted set (along the distance of the gw to your time zone)
      * @param profile profile belonging to a gateway
@@ -126,43 +141,59 @@ public class GatewaysManager {
     }
 
     /**
-     * parse gateways from eipDefinition
-     * @param eipDefinition eipServiceJson
+     * parse gateways from Provider's eip service
+     * @param provider
      */
-     private void fromEipServiceJson(JSONObject eipDefinition, JSONObject secrets) {
-        JSONArray gatewaysDefined = new JSONArray();
+     private void parseDefaultGateways(Provider provider) {
+         try {
+             JSONObject eipDefinition = provider.getEipServiceJson();
+             JSONObject secrets = secretsConfigurationFromCurrentProvider();
+
+             JSONArray gatewaysDefined = new JSONArray();
+             try {
+                 gatewaysDefined = eipDefinition.getJSONArray(GATEWAYS);
+             } catch (Exception e) {
+                 e.printStackTrace();
+             }
+
+             for (int i = 0; i < gatewaysDefined.length(); i++) {
+                 try {
+                     JSONObject gw = gatewaysDefined.getJSONObject(i);
+                     Gateway aux = new Gateway(eipDefinition, secrets, gw, this.context);
+                     if (gateways.get(aux.getHost()) == null) {
+                         addGateway(aux);
+                     }
+                 } catch (JSONException | ConfigParser.ConfigParseError | IOException e) {
+                     e.printStackTrace();
+                     VpnStatus.logError("Unable to parse gateway config!");
+                 }
+             }
+         } catch (NullPointerException npe) {
+             npe.printStackTrace();
+         }
+    }
+
+    private void parseGatewaysFromGeoIpServiceJson(Provider provider) {
+        JSONObject geoIpJson = provider.getGeoIpJson();
+        JSONArray gatewaylist = new JSONArray();
         try {
-            gatewaysDefined = eipDefinition.getJSONArray(GATEWAYS);
+            gatewaylist = geoIpJson.getJSONArray(GATEWAYS);
         } catch (Exception e) {
             e.printStackTrace();
         }
 
-        for (int i = 0; i < gatewaysDefined.length(); i++) {
+        for (int i = 0; i < gatewaylist.length(); i++) {
             try {
-                JSONObject gw = gatewaysDefined.getJSONObject(i);
-                Gateway aux = new Gateway(eipDefinition, secrets, gw, this.context);
-                if (gateways.get(aux.getRemoteIP()) == null) {
-                    addGateway(aux);
+                String key = gatewaylist.getString(i);
+                if (gateways.containsKey(key)) {
+                    presortedList.add(gateways.get(key));
                 }
-            } catch (JSONException | ConfigParser.ConfigParseError | IOException e) {
+            } catch (JSONException e) {
                 e.printStackTrace();
-                VpnStatus.logError("Unable to parse gateway config!");
             }
         }
     }
 
-    private JSONObject secretsConfigurationFromPreferences() {
-        JSONObject result = new JSONObject();
-        try {
-            result.put(Provider.CA_CERT, preferences.getString(Provider.CA_CERT, ""));
-            result.put(PROVIDER_PRIVATE_KEY, preferences.getString(PROVIDER_PRIVATE_KEY, ""));
-            result.put(PROVIDER_VPN_CERTIFICATE, preferences.getString(PROVIDER_VPN_CERTIFICATE, ""));
-        } catch (JSONException e) {
-            e.printStackTrace();
-        }
-        return result;
-    }
-
     private JSONObject secretsConfigurationFromCurrentProvider() {
         JSONObject result = new JSONObject();
         Provider provider = ProviderObservable.getInstance().getCurrentProvider();
@@ -177,31 +208,13 @@ public class GatewaysManager {
         return result;
     }
 
-
-    void clearGateways() {
-        gateways.clear();
-    }
-
     private void addGateway(Gateway gateway) {
-        gateways.put(gateway.getRemoteIP(), gateway);
-    }
-
-    /**
-     * read EipServiceJson from preferences and set gateways
-     */
-    private void configureFromPreferences() {
-        fromEipServiceJson(
-                PreferenceHelper.getEipDefinitionFromPreferences(preferences), secretsConfigurationFromPreferences()
-        );
+        gateways.put(gateway.getHost(), gateway);
     }
 
     private void configureFromCurrentProvider() {
-        try {
-            JSONObject json = ProviderObservable.getInstance().getCurrentProvider().getEipServiceJson();
-            fromEipServiceJson(json, secretsConfigurationFromCurrentProvider());
-        } catch (NullPointerException npe) {
-            npe.printStackTrace();
-        }
-
+         Provider provider = ProviderObservable.getInstance().getCurrentProvider();
+         parseDefaultGateways(provider);
+         parseGatewaysFromGeoIpServiceJson(provider);
     }
 }