Merge pull request #368 from owncloud/fix/cookie_handling

[Fix] Cookie handling

Author: abelgardep

owncloudComLibrary/build.gradle

@@ -9,12 +9,13 @@ dependencies {
     api 'com.github.AppDevNext.Logcat:LogcatCore:2.2.2'
 
     // Moshi
-    implementation ("com.squareup.moshi:moshi-kotlin:$moshiVersion") {
+    implementation("com.squareup.moshi:moshi-kotlin:$moshiVersion") {
         exclude module: "kotlin-reflect"
     }
     kapt "com.squareup.moshi:moshi-kotlin-codegen:$moshiVersion"
 
     testImplementation 'junit:junit:4.13.2'
+    testImplementation 'org.robolectric:robolectric:4.3.1'
 }
 
 android {
@@ -37,4 +38,10 @@ android {
         sourceCompatibility JavaVersion.VERSION_1_8
         targetCompatibility JavaVersion.VERSION_1_8
     }
+
+    testOptions {
+        unitTests {
+            includeAndroidResources = true
+        }
+    }
 }

owncloudComLibrary/src/main/java/com/owncloud/android/lib/common/OwnCloudClientFactory.java

@@ -27,6 +27,9 @@
 import android.content.Context;
 import android.net.Uri;
 
+import com.owncloud.android.lib.common.http.HttpClient;
+import com.owncloud.android.lib.resources.status.GetRemoteStatusOperation;
+
 public class OwnCloudClientFactory {
 
     /**
@@ -42,8 +45,14 @@ public static OwnCloudClient createOwnCloudClient(Uri uri, Context context, bool
 
         client.setFollowRedirects(followRedirects);
 
-        client.setContext(context);
+        HttpClient.setContext(context);
+        retrieveCookiesFromMiddleware(client);
 
         return client;
     }
+
+    private static void retrieveCookiesFromMiddleware(OwnCloudClient client) {
+        final GetRemoteStatusOperation statusOperation = new GetRemoteStatusOperation();
+        statusOperation.run(client);
+    }
 }

owncloudComLibrary/src/main/java/com/owncloud/android/lib/common/SingleSessionManager.java

@@ -24,8 +24,6 @@
 
 package com.owncloud.android.lib.common;
 
-import android.accounts.Account;
-import android.accounts.AccountManager;
 import android.accounts.AuthenticatorException;
 import android.accounts.OperationCanceledException;
 import android.content.Context;
@@ -37,7 +35,6 @@
 import timber.log.Timber;
 
 import java.io.IOException;
-import java.util.Iterator;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ConcurrentMap;
 
@@ -111,6 +108,12 @@ public OwnCloudClient getClientFor(OwnCloudAccount account, Context context) thr
                     account.getBaseUri(),
                     context.getApplicationContext(),
                     true);    // TODO remove dependency on OwnCloudClientFactory
+
+            //the next two lines are a hack because okHttpclient is used as a singleton instead of being an
+            //injected instance that can be deleted when required
+            client.clearCookies();
+            client.clearCredentials();
+
             client.setAccount(account);
             HttpClient.setContext(context);
 
@@ -130,7 +133,6 @@ public OwnCloudClient getClientFor(OwnCloudAccount account, Context context) thr
                 Timber.v("reusing client for session %s", sessionName);
             }
 
-            keepCookiesUpdated(context, account, client);
             keepUriUpdated(account, client);
         }
         Timber.d("getClientFor finishing ");
@@ -161,32 +163,6 @@ public void removeClientFor(OwnCloudAccount account) {
         Timber.d("removeClientFor finishing ");
     }
 
-    public void saveAllClients(Context context, String accountType) {
-        Timber.d("Saving sessions... ");
-
-        Iterator<String> accountNames = mClientsWithKnownUsername.keySet().iterator();
-        String accountName;
-        Account account;
-        while (accountNames.hasNext()) {
-            accountName = accountNames.next();
-            account = new Account(accountName, accountType);
-            AccountUtils.saveClient(mClientsWithKnownUsername.get(accountName), account, context);
-        }
-
-        Timber.d("All sessions saved");
-    }
-
-    private void keepCookiesUpdated(Context context, OwnCloudAccount account, OwnCloudClient reusedClient) {
-        AccountManager am = AccountManager.get(context.getApplicationContext());
-        if (am != null && account.getSavedAccount() != null) {
-            String recentCookies = am.getUserData(account.getSavedAccount(), AccountUtils.Constants.KEY_COOKIES);
-            String previousCookies = reusedClient.getCookiesString();
-            if (recentCookies != null && !previousCookies.equals("") && !recentCookies.equals(previousCookies)) {
-                AccountUtils.restoreCookies(account.getSavedAccount(), reusedClient, context);
-            }
-        }
-    }
-
     public void refreshCredentialsForAccount(String accountName, OwnCloudCredentials credentials) {
         OwnCloudClient ownCloudClient = mClientsWithKnownUsername.get(accountName);
         if (ownCloudClient == null) {

owncloudComLibrary/src/main/java/com/owncloud/android/lib/common/accounts/AccountUtils.java

@@ -36,15 +36,10 @@
 import com.owncloud.android.lib.common.OwnCloudClient;
 import com.owncloud.android.lib.common.authentication.OwnCloudCredentials;
 import com.owncloud.android.lib.common.authentication.OwnCloudCredentialsFactory;
-import com.owncloud.android.lib.resources.files.FileUtils;
 import com.owncloud.android.lib.resources.status.OwnCloudVersion;
-import okhttp3.Cookie;
 import timber.log.Timber;
 
-import java.io.File;
 import java.io.IOException;
-import java.util.ArrayList;
-import java.util.List;
 
 public class AccountUtils {
     /**
@@ -202,64 +197,6 @@ public static String buildAccountName(Uri serverBaseUrl, String username) {
         return username + "@" + url;
     }
 
-    public static void saveClient(OwnCloudClient client, Account savedAccount, Context context) {
-        // Account Manager
-        AccountManager ac = AccountManager.get(context.getApplicationContext());
-
-        if (client != null) {
-            String cookiesString = client.getCookiesString();
-            if (!"".equals(cookiesString)) {
-                ac.setUserData(savedAccount, Constants.KEY_COOKIES, cookiesString);
-                Timber.d("Saving Cookies: %s", cookiesString);
-            }
-        }
-    }
-
-    /**
-     * Restore the client cookies persisted in an account stored in the system AccountManager.
-     *
-     * @param account Stored account.
-     * @param client  Client to restore cookies in.
-     * @param context Android context used to access the system AccountManager.
-     */
-    public static void restoreCookies(Account account, OwnCloudClient client, Context context) {
-        if (account == null) {
-            Timber.d("Cannot restore cookie for null account");
-
-        } else {
-            Timber.d("Restoring cookies for %s", account.name);
-
-            // Account Manager
-            AccountManager am = AccountManager.get(context.getApplicationContext());
-
-            Uri serverUri = (client.getBaseUri() != null) ? client.getBaseUri() : client.getUserFilesWebDavUri();
-
-            String cookiesString = am.getUserData(account, Constants.KEY_COOKIES);
-            if (cookiesString != null) {
-                String[] rawCookies = cookiesString.split(";");
-                List<Cookie> cookieList = new ArrayList<>(rawCookies.length);
-                for (String rawCookie : rawCookies) {
-                    rawCookie = rawCookie.replace(" ", "");
-                    final int equalPos = rawCookie.indexOf('=');
-                    if (equalPos == -1) {
-                        continue;
-                    }
-                    cookieList.add(new Cookie.Builder()
-                            .name(rawCookie.substring(0, equalPos))
-                            .value(rawCookie.substring(equalPos + 1))
-                            .domain(serverUri.getHost())
-                            .path(
-                                    serverUri.getPath().equals("")
-                                            ? File.separator
-                                            : serverUri.getPath()
-                            )
-                            .build());
-                }
-                client.setCookiesForCurrentAccount(cookieList);
-            }
-        }
-    }
-
     public static class AccountNotFoundException extends AccountsException {
 
         /**
@@ -299,11 +236,6 @@ public static class Constants {
 
         public static final String OAUTH_SUPPORTED_TRUE = "TRUE";
 
-        /**
-         * OC account cookies
-         */
-        public static final String KEY_COOKIES = "oc_account_cookies";
-
         /**
          * OC account version
          */

owncloudComLibrary/src/main/java/com/owncloud/android/lib/common/http/CookieJarImpl.kt

@@ -0,0 +1,63 @@
+/* ownCloud Android Library is available under MIT license
+ *   Copyright (C) 2021 ownCloud GmbH.
+ *
+ *   Permission is hereby granted, free of charge, to any person obtaining a copy
+ *   of this software and associated documentation files (the "Software"), to deal
+ *   in the Software without restriction, including without limitation the rights
+ *   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *   copies of the Software, and to permit persons to whom the Software is
+ *   furnished to do so, subject to the following conditions:
+ *
+ *   The above copyright notice and this permission notice shall be included in
+ *   all copies or substantial portions of the Software.
+ *
+ *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ *   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+ *   BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+ *   ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ *   CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ *   THE SOFTWARE.
+ *
+ */
+package com.owncloud.android.lib.common.http
+
+import okhttp3.Cookie
+import okhttp3.CookieJar
+import okhttp3.HttpUrl
+
+class CookieJarImpl(
+    private val sCookieStore: HashMap<String, List<Cookie>>
+) : CookieJar {
+
+    fun containsCookieWithName(cookies: List<Cookie>, name: String): Boolean {
+        for (cookie: Cookie in cookies) {
+            if (cookie.name == name) {
+                return true
+            }
+        }
+        return false
+    }
+
+    fun getUpdatedCookies(oldCookies: List<Cookie>, newCookies: List<Cookie>): List<Cookie> {
+        val updatedList = ArrayList<Cookie>(newCookies)
+        for (oldCookie: Cookie in oldCookies) {
+            if (!containsCookieWithName(updatedList, oldCookie.name)) {
+                updatedList.add(oldCookie)
+            }
+        }
+        return updatedList
+    }
+
+    override fun saveFromResponse(url: HttpUrl, cookies: List<Cookie>) {
+        // Avoid duplicated cookies but update
+        val currentCookies: List<Cookie> = sCookieStore[url.host] ?: ArrayList()
+        val updatedCookies: List<Cookie> = getUpdatedCookies(currentCookies, cookies)
+        sCookieStore[url.host] = updatedCookies
+    }
+
+    override fun loadForRequest(url: HttpUrl) =
+        sCookieStore[url.host] ?: ArrayList()
+
+}