Upstream oodles of Chrome for Android code into Chromium.

chrome/android/java_staging/src/org/chromium/chrome/browser/preferences/ChromePreferenceManager.java

+// Copyright 2015 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+package org.chromium.chrome.browser.preferences;
+
+import android.content.Context;
+import android.content.SharedPreferences;
+import android.preference.PreferenceManager;
+
+import org.chromium.base.annotations.SuppressFBWarnings;
+import org.chromium.chrome.browser.signin.SigninPromoUma;
+
+/**
+ * ChromePreferenceManager stores and retrieves various values in Android shared preferences.
+ */
+public class ChromePreferenceManager {
+
+    private static final String BREAKPAD_UPLOAD_SUCCESS = "breakpad_upload_success";
+    private static final String BREAKPAD_UPLOAD_FAIL = "breakpad_upload_fail";
+    private static final String PROMOS_SKIPPED_ON_FIRST_START = "promos_skipped_on_first_start";
+    private static final String SIGNIN_PROMO_LAST_SHOWN = "signin_promo_last_timestamp_key";
+    private static final String SHOW_SIGNIN_PROMO = "show_signin_promo";
+    private static final String MIGRATION_ON_UPGRADE_ATTEMPTED = "migration_on_upgrade_attempted";
+    private static final String ALLOW_LOW_END_DEVICE_UI = "allow_low_end_device_ui";
+    private static final String PREF_WEBSITE_SETTINGS_FILTER = "website_settings_filter";
+    private static final String CONTEXTUAL_SEARCH_TAP_TRIGGERED_PROMO_COUNT =
+            "contextual_search_tap_triggered_promo_count";
+    private static final String CONTEXTUAL_SEARCH_TAP_COUNT = "contextual_search_tap_count";
+
+    private static final int SIGNIN_PROMO_CYCLE_IN_DAYS = 120;
+    private static final long MILLISECONDS_IN_DAY = 1000 * 60 * 60 * 24;
+
+    private static ChromePreferenceManager sPrefs;
+
+    private final SharedPreferences mSharedPreferences;
+    private final Context mContext;
+
+    private ChromePreferenceManager(Context context) {
+        mContext = context.getApplicationContext();
+        mSharedPreferences = PreferenceManager.getDefaultSharedPreferences(mContext);
+    }
+
+    /**
+     * Get the static instance of ChromePreferenceManager if exists else create it.
+     * @param context
+     * @return the ChromePreferenceManager singleton
+     */
+    @SuppressFBWarnings("CHROMIUM_SYNCHRONIZED_METHOD")
+    public static synchronized ChromePreferenceManager getInstance(Context context) {
+        if (sPrefs == null) {
+            sPrefs = new ChromePreferenceManager(context);
+        }
+        return sPrefs;
+    }
+
+    /**
+     * @return Number of times the upload intent service successfully uploaded
+     *         a minidump.
+     */
+    public int getBreakpadUploadSuccessCount() {
+        return mSharedPreferences.getInt(BREAKPAD_UPLOAD_SUCCESS, 0);
+    }
+
+    public void setBreakpadUploadSuccessCount(int count) {
+        SharedPreferences.Editor sharedPreferencesEditor = mSharedPreferences.edit();
+        sharedPreferencesEditor.putInt(BREAKPAD_UPLOAD_SUCCESS, count);
+        sharedPreferencesEditor.apply();
+    }
+
+    public void incrementBreakpadUploadSuccessCount() {
+        setBreakpadUploadSuccessCount(getBreakpadUploadSuccessCount() + 1);
+    }
+
+    /**
+     * @return Number of times the upload intent service gave up on uploading
+     *         minidump after a few tries.
+     */
+    public int getBreakpadUploadFailCount() {
+        return mSharedPreferences.getInt(BREAKPAD_UPLOAD_FAIL, 0);
+    }
+
+    public void setBreakpadUploadFailCount(int count) {
+        SharedPreferences.Editor sharedPreferencesEditor = mSharedPreferences.edit();
+        sharedPreferencesEditor.putInt(BREAKPAD_UPLOAD_FAIL, count);
+        sharedPreferencesEditor.apply();
+    }
+
+    public void incrementBreakpadUploadFailCount() {
+        setBreakpadUploadFailCount(getBreakpadUploadFailCount() + 1);
+    }
+
+    /**
+     * @return Whether we have attempted to migrate tabbed state to document mode after OS upgrade.
+     */
+    public boolean hasAttemptedMigrationOnUpgrade() {
+        return mSharedPreferences.getBoolean(MIGRATION_ON_UPGRADE_ATTEMPTED, false);
+    }
+
+    /**
+     * Mark that we have made an attempt to migrate tabbed state to document mode after OS upgrade.
+     */
+    public void setAttemptedMigrationOnUpgrade() {
+        SharedPreferences.Editor sharedPreferencesEditor = mSharedPreferences.edit();
+        sharedPreferencesEditor.putBoolean(MIGRATION_ON_UPGRADE_ATTEMPTED, true);
+        sharedPreferencesEditor.apply();
+    }
+
+    /**
+     * @return Whether the promotion for data reduction has been skipped on first invocation.
+     */
+    public boolean getPromosSkippedOnFirstStart() {
+        return mSharedPreferences.getBoolean(PROMOS_SKIPPED_ON_FIRST_START, false);
+    }
+
+    /**
+     * Marks whether the data reduction promotion was skipped on first
+     * invocation.
+     * @param displayed Whether the promotion was shown.
+     */
+    public void setPromosSkippedOnFirstStart(boolean displayed) {
+        SharedPreferences.Editor ed = mSharedPreferences.edit();
+        ed.putBoolean(PROMOS_SKIPPED_ON_FIRST_START, displayed);
+        ed.apply();
+    }
+
+    /**
+     * @return The value for the website settings filter (the one that specifies
+     * which sites to show in the list).
+     */
+    public String getWebsiteSettingsFilterPreference() {
+        return mSharedPreferences.getString(
+                ChromePreferenceManager.PREF_WEBSITE_SETTINGS_FILTER, "");
+    }
+
+    /**
+     * Sets the filter value for website settings (which websites to show in the list).
+     * @param prefValue The type to restrict the filter to.
+     */
+    public void setWebsiteSettingsFilterPreference(String prefValue) {
+        SharedPreferences.Editor sharedPreferencesEditor = mSharedPreferences.edit();
+        sharedPreferencesEditor.putString(
+                ChromePreferenceManager.PREF_WEBSITE_SETTINGS_FILTER, prefValue);
+        sharedPreferencesEditor.apply();
+    }
+
+    /**
+     * Set shared preference to allow low end device ui.
+     */
+    public void setAllowLowEndDeviceUi() {
+        SharedPreferences.Editor sharedPreferencesEditor = mSharedPreferences.edit();
+        sharedPreferencesEditor.putBoolean(ALLOW_LOW_END_DEVICE_UI, true);
+        sharedPreferencesEditor.apply();
+    }
+
+    /**
+     * @return Whether low end device ui is allowed.
+     */
+    public boolean getAllowLowEndDeviceUi() {
+        return mSharedPreferences.getBoolean(ALLOW_LOW_END_DEVICE_UI, false);
+    }
+
+    /**
+     * Signin promo could be shown at most once every 12 weeks. This method checks
+     * wheter the signin promo has already been shown in the current cycle.
+     * @return Whether the signin promo has been shown in the current cycle.
+     */
+    public boolean getSigninPromoShown() {
+        long signinPromoLastShown = mSharedPreferences.getLong(SIGNIN_PROMO_LAST_SHOWN, 0);
+        long numDaysElapsed =
+                (System.currentTimeMillis() - signinPromoLastShown) / MILLISECONDS_IN_DAY;
+        return numDaysElapsed < SIGNIN_PROMO_CYCLE_IN_DAYS;
+    }
+
+    /**
+     * Sets the preference for tracking when the signin promo was last shown.
+     */
+    public void setSigninPromoShown() {
+        SharedPreferences.Editor sharedPreferencesEditor = mSharedPreferences.edit();
+        sharedPreferencesEditor.putLong(SIGNIN_PROMO_LAST_SHOWN, System.currentTimeMillis());
+        sharedPreferencesEditor.apply();
+    }
+
+    /**
+     * @return Whether the signin promo has been marked to be shown on next startup.
+     */
+    public boolean getShowSigninPromo() {
+        return mSharedPreferences.getBoolean(SHOW_SIGNIN_PROMO, false);
+    }
+
+    /**
+     * Sets the preference to indicate that the signin promo should be shown on next startup.
+     * @param shouldShow Whether the signin promo should be shown.
+     */
+    public void setShowSigninPromo(boolean shouldShow) {
+        SharedPreferences.Editor sharedPreferencesEditor = mSharedPreferences.edit();
+        sharedPreferencesEditor.putBoolean(SHOW_SIGNIN_PROMO, shouldShow).apply();
+
+        if (shouldShow) SigninPromoUma.recordAction(SigninPromoUma.SIGNIN_PROMO_ENABLED);
+    }
+
+    /**
+     * @return Number of times the promo was triggered by a tap gesture, or a negative value
+     *         if in the disabled state.
+     */
+    public int getContextualSearchTapTriggeredPromoCount() {
+        return mSharedPreferences.getInt(CONTEXTUAL_SEARCH_TAP_TRIGGERED_PROMO_COUNT, 0);
+    }
+
+    /**
+     * Sets the number of times the promo was triggered by a tap gesture.  Use a negative value
+     * to record that the counter has been disabled.
+     * @param count Number of times the promo was triggered by a tap gesture, or a negative value
+     *        to record that the counter has been disabled.
+     */
+    public void setContextualSearchTapTriggeredPromoCount(int count) {
+        SharedPreferences.Editor ed = mSharedPreferences.edit();
+        ed.putInt(CONTEXTUAL_SEARCH_TAP_TRIGGERED_PROMO_COUNT, count);
+        ed.apply();
+    }
+
+    /**
+     * @return Number of tap gestures that have been received when not waiting for the promo.
+     */
+    public int getContextualSearchTapCount() {
+        return mSharedPreferences.getInt(CONTEXTUAL_SEARCH_TAP_COUNT, 0);
+    }
+
+    /**
+     * Sets the number of tap gestures that have been received when not waiting for the promo.
+     * @param count Number of taps that have been received when not waiting for the promo.
+     */
+    public void setContextualSearchTapCount(int count) {
+        SharedPreferences.Editor ed = mSharedPreferences.edit();
+        ed.putInt(CONTEXTUAL_SEARCH_TAP_COUNT, count);
+        ed.apply();
+    }
+}