The Tor Browser: mobile/android/base/fxa/receivers/FxAccountUpgradeReceiver.java@6474c204b198 (annotated)

mobile/android/base/fxa/receivers/FxAccountUpgradeReceiver.java@6474c204b198 (annotated)

mobile/android/base/fxa/receivers/FxAccountUpgradeReceiver.java

Wed, 31 Dec 2014 06:09:35 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Wed, 31 Dec 2014 06:09:35 +0100
changeset 0: 6474c204b198
permissions: -rw-r--r--

Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.

 /* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 package org.mozilla.gecko.fxa.receivers;
 import java.util.LinkedList;
 import java.util.List;
 import java.util.concurrent.Executor;
 import java.util.concurrent.Executors;
 import org.mozilla.gecko.background.common.log.Logger;
 import org.mozilla.gecko.fxa.FirefoxAccounts;
 import org.mozilla.gecko.fxa.FxAccountConstants;
 import org.mozilla.gecko.fxa.authenticator.AndroidFxAccount;
 import org.mozilla.gecko.fxa.login.State;
 import org.mozilla.gecko.fxa.login.State.StateLabel;
 import org.mozilla.gecko.sync.Utils;
 import android.accounts.Account;
 import android.content.BroadcastReceiver;
 import android.content.Context;
 import android.content.Intent;
 /**
  * A receiver that takes action when our Android package is upgraded (replaced).
  */
 public class FxAccountUpgradeReceiver extends BroadcastReceiver {
   private static final String LOG_TAG = FxAccountUpgradeReceiver.class.getSimpleName();
   /**
    * Produce a list of Runnable instances to be executed sequentially on
    * upgrade.
    * <p>
    * Each Runnable will be executed sequentially on a background thread. Any
    * unchecked Exception thrown will be caught and ignored.
    *
    * @param context Android context.
    * @return list of Runnable instances.
    */
   protected List<Runnable> onUpgradeRunnables(Context context) {
     List<Runnable> runnables = new LinkedList<Runnable>();
     runnables.add(new MaybeUnpickleRunnable(context));
     // Recovering accounts that are in the Doghouse should happen *after* we
     // unpickle any accounts saved to disk.
     runnables.add(new AdvanceFromDoghouseRunnable(context));
     return runnables;
   }
   @Override
   public void onReceive(final Context context, Intent intent) {
     Logger.setThreadLogTag(FxAccountConstants.GLOBAL_LOG_TAG);
     Logger.info(LOG_TAG, "Upgrade broadcast received.");
     // Iterate Runnable instances one at a time.
     final Executor executor = Executors.newSingleThreadExecutor();
     for (final Runnable runnable : onUpgradeRunnables(context)) {
       executor.execute(new Runnable() {
         @Override
         public void run() {
           try {
             runnable.run();
           } catch (Exception e) {
             // We really don't want to throw on a background thread, so we
             // catch, log, and move on.
             Logger.error(LOG_TAG, "Got exception executing background upgrade Runnable; ignoring.", e);
           }
         }
       });
     }
   }
   /**
    * A Runnable that tries to unpickle any pickled Firefox Accounts.
    */
   protected static class MaybeUnpickleRunnable implements Runnable {
     protected final Context context;
     public MaybeUnpickleRunnable(Context context) {
       this.context = context;
     }
     @Override
     public void run() {
       // Querying the accounts will unpickle any pickled Firefox Account.
       Logger.info(LOG_TAG, "Trying to unpickle any pickled Firefox Account.");
       FirefoxAccounts.getFirefoxAccounts(context);
     }
   }
   /**
    * A Runnable that tries to advance existing Firefox Accounts that are in the
    * Doghouse state to the Separated state.
    * <p>
    * This is our main deprecation-and-upgrade mechanism: in some way, the
    * Account gets moved to the Doghouse state. If possible, an upgraded version
    * of the package advances to Separated, prompting the user to re-connect the
    * Account.
    */
   protected static class AdvanceFromDoghouseRunnable implements Runnable {
     protected final Context context;
     public AdvanceFromDoghouseRunnable(Context context) {
       this.context = context;
     }
     @Override
     public void run() {
       final Account[] accounts = FirefoxAccounts.getFirefoxAccounts(context);
       Logger.info(LOG_TAG, "Trying to advance " + accounts.length + " existing Firefox Accounts from the Doghouse to Separated (if necessary).");
       for (Account account : accounts) {
         try {
           final AndroidFxAccount fxAccount = new AndroidFxAccount(context, account);
           // For great debugging.
           if (FxAccountConstants.LOG_PERSONAL_INFORMATION) {
             fxAccount.dump();
           }
           State state = fxAccount.getState();
           if (state == null || state.getStateLabel() != StateLabel.Doghouse) {
             Logger.debug(LOG_TAG, "Account named like " + Utils.obfuscateEmail(account.name) + " is not in the Doghouse; skipping.");
             continue;
           }
           Logger.debug(LOG_TAG, "Account named like " + Utils.obfuscateEmail(account.name) + " is in the Doghouse; advancing to Separated.");
           fxAccount.setState(state.makeSeparatedState());
         } catch (Exception e) {
           Logger.warn(LOG_TAG, "Got exception trying to advance account named like " + Utils.obfuscateEmail(account.name) +
               " from Doghouse to Separated state; ignoring.", e);
         }
       }
     }
   }
 }

The Tor Browser / annotate

mobile/android/base/fxa/receivers/FxAccountUpgradeReceiver.java@6474c204b198 (annotated)

mobile/android/base/fxa/receivers/FxAccountUpgradeReceiver.java