Merge pull request #2747 from brandonpage/upgrade-account-type-login

Upgrade existing users if the app adds a unique account type.

Author: brandonpage

libs/SalesforceSDK/AndroidManifest.xml

@@ -27,6 +27,16 @@
                 android:resource="@xml/authenticator" />
         </service>
 
+        <service android:exported="true"
+            android:name="com.salesforce.androidsdk.auth.LegacyAuthenticatorService"
+            tools:ignore="ExportedService">
+            <intent-filter>
+                <action android:name="android.accounts.AccountAuthenticator" />
+            </intent-filter>
+            <meta-data android:name="android.accounts.AccountAuthenticator"
+                android:resource="@xml/legacy_authenticator" />
+        </service>
+
         <!-- Login activity -->
         <activity android:name="com.salesforce.androidsdk.ui.LoginActivity"
             android:theme="@style/SalesforceSDK"

libs/SalesforceSDK/res/xml/legacy_authenticator.xml

@@ -0,0 +1,3 @@
+<account-authenticator xmlns:android="http://schemas.android.com/apk/res/android"
+    android:accountType="com.salesforce.androidsdk" android:icon="@drawable/sf__icon"
+    android:smallIcon="@drawable/sf__icon" android:label="@string/app_name" />

libs/SalesforceSDK/src/com/salesforce/androidsdk/app/SalesforceSDKManager.kt

@@ -1192,7 +1192,16 @@ open class SalesforceSDKManager protected constructor(
     open val isHybrid = false
 
     /** The authentication account type, which should match authenticator.xml */
-    val accountType = appContext.getString(account_type)
+    val accountType: String by lazy {
+        val type = appContext.getString(account_type)
+        if (type == "com.salesforce.androidsdk") {
+            // TODO: Turn this logline into an assert in 14.0
+            e(TAG, "No app specific account type found.  To ensure users " +
+                    "can login override the \"account_type\" value in your strings.xml.")
+        }
+
+        return@lazy type
+    }
 
     override fun toString() =
         """

libs/SalesforceSDK/src/com/salesforce/androidsdk/app/SalesforceSDKUpgradeManager.java

@@ -30,10 +30,13 @@
 import static com.salesforce.androidsdk.security.ScreenLockManager.SCREEN_LOCK;
 import static com.salesforce.androidsdk.security.ScreenLockManager.SCREEN_LOCK_TIMEOUT;
 
+import android.accounts.Account;
+import android.accounts.AccountManager;
 import android.content.Context;
 import android.content.SharedPreferences;
 
 import com.salesforce.androidsdk.accounts.UserAccount;
+import com.salesforce.androidsdk.accounts.UserAccountManager;
 import com.salesforce.androidsdk.auth.HttpAccess;
 import com.salesforce.androidsdk.auth.OAuth2;
 import com.salesforce.androidsdk.config.AdminSettingsManager;
@@ -46,7 +49,6 @@
 import java.util.Map;
 import java.util.concurrent.Executors;
 
-
 /**
  * This class handles upgrades from one version to another.
  *
@@ -60,7 +62,7 @@ public class SalesforceSDKUpgradeManager {
 
     private static SalesforceSDKUpgradeManager INSTANCE = null;
 
-    private UserManager userManager;
+    private final UserManager userManager;
 
     /**
      * Returns an instance of this class.
@@ -82,12 +84,7 @@ interface UserManager {
     }
 
     public SalesforceSDKUpgradeManager() {
-        this(new UserManager() {
-            @Override
-            public List<UserAccount> getAuthenticatedUsers() {
-                return SalesforceSDKManager.getInstance().getUserAccountManager().getAuthenticatedUsers();
-            }
-        });
+        this(() -> SalesforceSDKManager.getInstance().getUserAccountManager().getAuthenticatedUsers());
     }
     public SalesforceSDKUpgradeManager(UserManager userManager) {
         this.userManager = userManager;
@@ -130,6 +127,9 @@ else if (installedVersion.isGreaterThanOrEqualTo(new SdkVersion(9, 2, 0, false))
             if (installedVersion.isLessThan(new SdkVersion(12, 0, 0, false))) {
                 updateFromBefore12_0_0();
             }
+            if (installedVersion.isLessThan(new SdkVersion(15, 0, 0, false))) {
+                migrateAccountType();
+            }
         } catch (Exception e) {
             SalesforceSDKLogger.e(
                     TAG,
@@ -306,4 +306,36 @@ private void updateFromBefore12_0_0() {
         PushMessaging.setReRegistrationRequested(true);
     }
 
+
+    /*
+     *  Migrate any accounts with account_type "com.salesforce.androidsdk" to a unique value.
+     *  TODO: Remove this in Mobile SDK 15.0
+     */
+    private void migrateAccountType() {
+        final String LEGACY_ACCOUNT_TYPE = "com.salesforce.androidsdk";
+        if (SalesforceSDKManager.getInstance().getAccountType().equals(LEGACY_ACCOUNT_TYPE)) {
+            SalesforceSDKLogger.e(TAG, "No app specific account type found.  To ensure users " +
+                    "can login override the \"account_type\" value in your strings.xml.");
+            return;
+        }
+
+        final AccountManager accountManager = SalesforceSDKManager.getInstance().getClientManager().getAccountManager();
+        final UserAccountManager userAccountManager = SalesforceSDKManager.getInstance().getUserAccountManager();
+
+        for (Account account : accountManager.getAccountsByType(LEGACY_ACCOUNT_TYPE)) {
+            try {
+                final UserAccount userAccount = userAccountManager.buildUserAccount(account);
+                if (userAccount == null) {
+                    SalesforceSDKLogger.e(TAG, "Unable to build UserAccount from account: " + account.name);
+                    continue;
+                }
+
+                // Android OS accounts are immutable so we have to remove the account and add a new one.
+                accountManager.removeAccountExplicitly(account);
+                userAccountManager.createAccount(userAccount);
+            } catch (Exception e) {
+                SalesforceSDKLogger.e(TAG, "Failed to migrate account: " + account.name, e);
+            }
+        }
+    }
 }

libs/SalesforceSDK/src/com/salesforce/androidsdk/auth/LegacyAuthenticatorService.java

@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) 2011-present, salesforce.com, inc.
+ * All rights reserved.
+ * Redistribution and use of this software in source and binary forms, with or
+ * without modification, are permitted provided that the following conditions
+ * are met:
+ * - Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ * - Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ * - Neither the name of salesforce.com, inc. nor the names of its contributors
+ * may be used to endorse or promote products derived from this software without
+ * specific prior written permission of salesforce.com, inc.
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+package com.salesforce.androidsdk.auth;
+
+class LegacyAuthenticatorService extends AuthenticatorService { }