Share cookies between built-in HttpURLConnection and OkHttpClient

Author: mythz

src/AndroidClient/android/src/main/java/net/servicestack/android/AndroidServerEventsClient.java

@@ -19,6 +19,7 @@
 import java.io.InputStream;
 import java.io.InterruptedIOException;
 import java.lang.reflect.Field;
+import java.net.CookieHandler;
 import java.net.HttpURLConnection;
 import java.net.SocketException;
 import java.net.URL;
@@ -39,9 +40,15 @@
  */
 
 public class AndroidServerEventsClient extends ServerEventsClient {
+    protected OkHttpClient client;
+
     public AndroidServerEventsClient(String baseUri, String... channels) {
         super(baseUri, channels);
         this.serviceClient = new AndroidServiceClient(this.baseUri);
+
+        client = new OkHttpClient.Builder()
+            .cookieJar(new JavaNetCookieJar(CookieHandler.getDefault()))
+            .build();
     }
 
     public AndroidServerEventsClient(String baseUrl, String channel) {
@@ -52,6 +59,15 @@ public AndroidServerEventsClient(String baseUrl) {
         this(baseUrl, new String[]{});
     }
 
+    public AndroidServerEventsClient setOkHttpClient(OkHttpClient client){
+        this.client = client;
+        return this;
+    }
+
+    public OkHttpClient getOkHttpClient(){
+        return client;
+    }
+
     public AndroidServiceClient getAndroidClient(){
         return (AndroidServiceClient) this.serviceClient;
     }
@@ -61,8 +77,6 @@ protected EventStream createEventStream() {
         return new AndroidEventStream(this);
     }
 
-    public static final OkHttpClient client = new OkHttpClient();
-
     class AndroidEventStream extends EventStream
     {
         public AndroidEventStream(ServerEventsClient client) {

src/AndroidClient/android/src/main/java/net/servicestack/android/JavaNetCookieJar.java

@@ -0,0 +1,119 @@
+package net.servicestack.android;
+/*
+ * Copyright (C) 2015 Square, Inc.
+ *
+ * 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.
+ */
+
+import java.io.IOException;
+import java.net.CookieHandler;
+import java.net.HttpCookie;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+
+import okhttp3.Cookie;
+import okhttp3.CookieJar;
+import okhttp3.HttpUrl;
+import okhttp3.internal.platform.Platform;
+
+import static okhttp3.internal.Util.delimiterOffset;
+import static okhttp3.internal.Util.trimSubstring;
+import static okhttp3.internal.platform.Platform.WARN;
+
+/** A cookie jar that delegates to a {@link java.net.CookieHandler}. */
+public final class JavaNetCookieJar implements CookieJar {
+
+    private final CookieHandler cookieHandler;
+
+    public JavaNetCookieJar(CookieHandler cookieHandler) {
+        this.cookieHandler = cookieHandler;
+    }
+
+    @Override
+    public void saveFromResponse(HttpUrl url, List<Cookie> cookies) {
+        if (cookieHandler != null) {
+            List<String> cookieStrings = new ArrayList<>();
+            for (Cookie cookie : cookies) {
+                cookieStrings.add(cookie.toString());
+            }
+            Map<String, List<String>> multimap = Collections.singletonMap("Set-Cookie", cookieStrings);
+            try {
+                cookieHandler.put(url.uri(), multimap);
+            } catch (IOException e) {
+                Platform.get().log(WARN, "Saving cookies failed for " + url.resolve("/..."), e);
+            }
+        }
+    }
+
+    @Override
+    public List<Cookie> loadForRequest(HttpUrl url) {
+        // The RI passes all headers. We don't have 'em, so we don't pass 'em!
+        Map<String, List<String>> headers = Collections.emptyMap();
+        Map<String, List<String>> cookieHeaders;
+        try {
+            cookieHeaders = cookieHandler.get(url.uri(), headers);
+        } catch (IOException e) {
+            Platform.get().log(WARN, "Loading cookies failed for " + url.resolve("/..."), e);
+            return Collections.emptyList();
+        }
+
+        List<Cookie> cookies = null;
+        for (Map.Entry<String, List<String>> entry : cookieHeaders.entrySet()) {
+            String key = entry.getKey();
+            if (("Cookie".equalsIgnoreCase(key) || "Cookie2".equalsIgnoreCase(key))
+                    && !entry.getValue().isEmpty()) {
+                for (String header : entry.getValue()) {
+                    if (cookies == null) cookies = new ArrayList<>();
+                    cookies.addAll(decodeHeaderAsJavaNetCookies(url, header));
+                }
+            }
+        }
+
+        return cookies != null
+                ? Collections.unmodifiableList(cookies)
+                : Collections.<Cookie>emptyList();
+    }
+
+    /**
+     * Convert a request header to OkHttp's cookies via {@link HttpCookie}. That extra step handles
+     * multiple cookies in a single request header, which {@link Cookie#parse} doesn't support.
+     */
+    private List<Cookie> decodeHeaderAsJavaNetCookies(HttpUrl url, String header) {
+        List<Cookie> result = new ArrayList<>();
+        for (int pos = 0, limit = header.length(), pairEnd; pos < limit; pos = pairEnd + 1) {
+            pairEnd = delimiterOffset(header, pos, limit, ";,");
+            int equalsSign = delimiterOffset(header, pos, pairEnd, '=');
+            String name = trimSubstring(header, pos, equalsSign);
+            if (name.startsWith("$")) continue;
+
+            // We have either name=value or just a name.
+            String value = equalsSign < pairEnd
+                    ? trimSubstring(header, equalsSign + 1, pairEnd)
+                    : "";
+
+            // If the value is "quoted", drop the quotes.
+            if (value.startsWith("\"") && value.endsWith("\"")) {
+                value = value.substring(1, value.length() - 1);
+            }
+
+            result.add(new Cookie.Builder()
+                    .name(name)
+                    .value(value)
+                    .domain(url.host())
+                    .build());
+        }
+        return result;
+    }
+}