Issue 4399 - Add WebView inheritor with ad blocking

libadblockplus-android-settings/src/org/adblockplus/libadblockplus/android/settings/AdblockSettingsSharedPrefsStorage.java

+/*
+ * This file is part of Adblock Plus <https://adblockplus.org/>,
+ * Copyright (C) 2006-2016 Eyeo GmbH
+ *
+ * Adblock Plus is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * Adblock Plus is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package org.adblockplus.libadblockplus.android.settings;
+
+import android.content.SharedPreferences;
+
+import org.adblockplus.libadblockplus.android.Subscription;
+
+import java.util.LinkedList;
+import java.util.List;
+
+/**
+ * Settings storage implementation in Shared Preferences
+ */
+public class AdblockSettingsSharedPrefsStorage extends AdblockSettingsStorage
+{
+  private static final String SETTINGS_ENABLED_KEY = "enabled";
+  private static final String SETTINGS_AA_ENABLED_KEY = "aa_enabled";
+  private static final String SETTINGS_SUBSCRIPTIONS_KEY = "subscriptions";
+  private static final String SETTINGS_SUBSCRIPTION_KEY = "subscription";
+  private static final String SETTINGS_SUBSCRIPTION_URL_KEY = "url";
+  private static final String SETTINGS_SUBSCRIPTION_TITLE_KEY = "title";
+  private static final String SETTINGS_WL_DOMAINS_KEY = "whitelisted_domains";
+  private static final String SETTINGS_WL_DOMAIN_KEY = "domain";
+
+  private SharedPreferences prefs;
+
+  public AdblockSettingsSharedPrefsStorage(SharedPreferences prefs)
+  {
+    this.prefs = prefs;
+  }
+
+  private boolean commit = true;
+
+  public boolean isCommit()
+  {
+    return commit;
+  }
+
+  /**
+   * Do commit the changes in save() before return
+   *
+   * @param commit `true` to commit, `false`
+   */
+  public void setCommit(boolean commit)
+  {
+    this.commit = commit;
+  }
+
+  @Override
+  public AdblockSettings load()
+  {
+    if (!prefs.contains(SETTINGS_ENABLED_KEY))
+    {
+      // settings were not saved yet
+      return null;
+    }
+
+    AdblockSettings settings = new AdblockSettings();
+    settings.setAdblockEnabled(prefs.getBoolean(SETTINGS_ENABLED_KEY, true));
+    settings.setAcceptableAdsEnabled(prefs.getBoolean(SETTINGS_AA_ENABLED_KEY, true));
+
+    loadSubscriptions(settings);
+    loadWhitelistedDomains(settings);
+
+    return settings;
+  }
+
+  private void loadWhitelistedDomains(AdblockSettings settings)
+  {
+    if (prefs.contains(SETTINGS_WL_DOMAINS_KEY))
+    {
+      // count
+      int whitelistedDomainsCount = prefs.getInt(SETTINGS_WL_DOMAINS_KEY, 0);
+
+      // each domain
+      List<String> whitelistedDomains = new LinkedList<String>();
+      for (int i = 0; i < whitelistedDomainsCount; i++)
+      {
+        String whitelistedDomain = prefs.getString(getArrayItemKey(i, SETTINGS_WL_DOMAIN_KEY), "");
+        whitelistedDomains.add(whitelistedDomain);
+      }
+      settings.setWhitelistedDomains(whitelistedDomains);
+    }
+  }
+
+  private void loadSubscriptions(AdblockSettings settings)
+  {
+    if (prefs.contains(SETTINGS_SUBSCRIPTIONS_KEY))
+    {
+      // count
+      int subscriptionsCount = prefs.getInt(SETTINGS_SUBSCRIPTIONS_KEY, 0);
+
+      // each subscription
+      List<Subscription> subscriptions = new LinkedList<Subscription>();
+      for (int i = 0; i < subscriptionsCount; i++)
+      {
+        Subscription subscription = new Subscription();
+        subscription.title = prefs.getString(getSubscriptionTitleKey(i), "");
+        subscription.url = prefs.getString(getSubscriptionURLKey(i), "");
+        subscriptions.add(subscription);
+      }
+      settings.setSubscriptions(subscriptions);
+    }
+  }
+
+  private String getArrayItemKey(int index, String entity)
+  {
+    // f.e. "domain0"
+    return entity + index;
+  }
+
+  private String getArrayItemKey(int index, String entity, String field)
+  {
+    // f.e. `subscription0.field`
+    return getArrayItemKey(index, entity) + "." + field;
+  }
+
+  private String getSubscriptionTitleKey(int index)
+  {
+    return getArrayItemKey(index, SETTINGS_SUBSCRIPTION_KEY, SETTINGS_SUBSCRIPTION_TITLE_KEY);
+  }
+
+  private String getSubscriptionURLKey(int index)
+  {
+    return getArrayItemKey(index, SETTINGS_SUBSCRIPTION_KEY, SETTINGS_SUBSCRIPTION_URL_KEY);
+  }
+
+  @Override
+  public void save(AdblockSettings settings)
+  {
+    SharedPreferences.Editor editor = prefs
+      .edit()
+      .clear()
+      .putBoolean(SETTINGS_ENABLED_KEY, settings.isAdblockEnabled())
+      .putBoolean(SETTINGS_AA_ENABLED_KEY, settings.isAcceptableAdsEnabled());
+
+    saveSubscriptions(settings, editor);
+    saveWhitelistedDomains(settings, editor);
+
+    if (commit)
+    {
+      editor.commit();
+    }
+    else
+    {
+      // faster but not finished most likely before return
+      editor.apply();
+    }
+  }
+
+  private void saveWhitelistedDomains(AdblockSettings settings, SharedPreferences.Editor editor)
+  {
+    if (settings.getWhitelistedDomains() != null)
+    {
+      // count
+      editor.putInt(SETTINGS_WL_DOMAINS_KEY, settings.getWhitelistedDomains().size());
+
+      // each domain
+      for (int i = 0; i < settings.getWhitelistedDomains().size(); i++)
+      {
+        String eachDomain = settings.getWhitelistedDomains().get(i);
+        editor.putString(getArrayItemKey(i, SETTINGS_WL_DOMAIN_KEY), eachDomain);
+      }
+    }
+  }
+
+  private void saveSubscriptions(AdblockSettings settings, SharedPreferences.Editor editor)
+  {
+    if (settings.getSubscriptions() != null)
+    {
+      // count
+      editor.putInt(SETTINGS_SUBSCRIPTIONS_KEY, settings.getSubscriptions().size());
+
+      // each subscription
+      for (int i = 0; i < settings.getSubscriptions().size(); i++)
+      {
+        Subscription eachSubscription = settings.getSubscriptions().get(i);
+
+        // warning: saving `title` and `url` fields only
+        editor.putString(getSubscriptionTitleKey(i), eachSubscription.title);
+        editor.putString(getSubscriptionURLKey(i), eachSubscription.url);
+      }
+    }
+  }
+}