Issue 3931 - Crash on filter list request/delivery

src/org/adblockplus/sbrowser/contentblocker/MainPreferences.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
@@ skipping 29 matching lines @@
 
 public class MainPreferences extends PreferenceActivity implements
     EngineService.OnEngineCreatedCallback, SharedPreferences.OnSharedPreferenceChangeListener
 {
   private static final String TAG = MainPreferences.class.getSimpleName();
   private static final String SBROWSER_APP_ID = "com.sec.android.app.sbrowser";
   private ProgressDialog progressDialog = null;
   private Engine engine = null;
   private AlertDialog setupDialog = null;
 
+  private SharedPreferences getSharedPreferences()
+  {
+    return PreferenceManager.getDefaultSharedPreferences(this.getApplicationContext());
+  }
+
   @Override
   public void onCreate(Bundle savedInstanceState)
   {
     super.onCreate(savedInstanceState);
     PreferenceManager.setDefaultValues(this, R.layout.preferences_main, false);
 
     this.getFragmentManager()
         .beginTransaction()
         .replace(android.R.id.content, new Preferences())
         .commit();
 
-    PreferenceManager.getDefaultSharedPreferences(this.getApplicationContext())
-        .registerOnSharedPreferenceChangeListener(this);
+    // This try/catch block is a workaround for a preference mismatch
+    // issue. We check for a type mismatch in one particular key and,
+    // if there's a mismatch, clean sweep the preferences.
+    // See: https://issues.adblockplus.org/ticket/3931
+    try

[Felix Dahlke, 2016/04/26 17:39:10]

What causes this issue? Did we change the type of this key? If so, this is
rather migration code than a workaround.

+    {
+      this.getSharedPreferences().getBoolean(
+          this.getString(R.string.key_application_activated),
+          false);
+    }
+    catch(final Throwable t)
+    {
+      this.getSharedPreferences()
+          .edit()
+          .clear()
+          .commit();
+    }
   }
 
   @Override
   protected void onStart()
   {
     this.progressDialog = ProgressDialog.show(this,
         this.getString(R.string.initialization_title),
         this.getString(R.string.initialization_message));
     super.onStart();
-    EngineService.startService(this, this);
+    this.getSharedPreferences().registerOnSharedPreferenceChangeListener(this);
+    EngineService.startService(this.getApplicationContext(), this);
   }
 
   @Override
   protected void onStop()
   {
     super.onStop();
+    this.getSharedPreferences().unregisterOnSharedPreferenceChangeListener(this);
   }
 
   private void checkForCompatibleSBrowserAndProceed()
   {
     if (!Engine.hasCompatibleSBrowserInstalled(this.getApplicationContext()))
     {
       final AlertDialog d = new AlertDialog.Builder(this)
           .setCancelable(false)
           .setTitle(R.string.sbrowser_dialog_title)
           .setMessage(Html.fromHtml(this.readTextFile(R.raw.sbrowser_dialog)))
@@ skipping 17 matching lines @@
       d.show();
     }
     else
     {
       this.checkAAStatusAndProceed();
     }
   }
 
   private void checkAAStatusAndProceed()
   {
-    final SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(this);
+    final SharedPreferences prefs = this.getSharedPreferences();
     final String keyAaInfoShown = this.getString(R.string.key_aa_info_shown);
     final boolean aaInfoShown = prefs.getBoolean(keyAaInfoShown, false);
     if (!aaInfoShown)
     {
       final AlertDialog d = new AlertDialog.Builder(this)
           .setCancelable(false)
           .setTitle(R.string.aa_dialog_title)
           .setMessage(Html.fromHtml(this.readTextFile(R.raw.aa_dialog)))
           .setNeutralButton(R.string.aa_dialog_button, new OnClickListener()
           {
             @Override
             public void onClick(DialogInterface dialog, int which)
             {
               prefs.edit()
                   .putBoolean(keyAaInfoShown, true)
                   .commit();
               MainPreferences.this.checkSetupStatus();
             }
           }).create();
       d.show();
     }
     else
     {
       this.checkSetupStatus();
     }
   }
 
   private void checkSetupStatus()
   {
-    final boolean applicationActivated = PreferenceManager.getDefaultSharedPreferences(this)
+    final boolean applicationActivated = this.getSharedPreferences()
         .getBoolean(this.getString(R.string.key_application_activated), false);
 
     if (!applicationActivated)
     {
       Log.d(TAG, "Showing setup dialog");
       this.setupDialog = new AlertDialog.Builder(this)
           .setCancelable(false)
           .setTitle(R.string.setup_dialog_title)
           .setMessage(Html.fromHtml(this.readTextFile(R.raw.setup_dialog)))
           .setNeutralButton(R.string.setup_dialog_button, new OnClickListener()
@@ skipping 68 matching lines @@
         r.close();
       }
     }
     catch (IOException e)
     {
       Log.e(TAG, "Resource reading failed for: " + id, e);
       return "...";
     }
   }
 }