ABP/Android Proxy switch

src/org/adblockplus/android/Preferences.java

 /*
  * This file is part of the Adblock Plus,
  * Copyright (C) 2006-2012 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.android;
 
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
 import java.util.Calendar;
 import java.util.Date;
 import java.util.List;
 
+import org.jraf.android.backport.switchwidget.SwitchPreference;
+
 import android.app.ActivityManager;
 import android.app.ActivityManager.RunningServiceInfo;
 import android.app.AlertDialog;
 import android.app.Dialog;
 import android.content.BroadcastReceiver;
 import android.content.ComponentName;
 import android.content.Context;
 import android.content.DialogInterface;
 import android.content.Intent;
 import android.content.IntentFilter;
 import android.content.ServiceConnection;
 import android.content.SharedPreferences;
 import android.content.pm.PackageManager.NameNotFoundException;
 import android.content.res.AssetManager;
 import android.net.Uri;
 import android.os.Build;
 import android.os.Bundle;
 import android.os.IBinder;
-import android.preference.CheckBoxPreference;
 import android.preference.ListPreference;
 import android.preference.PreferenceManager;
 import android.text.Html;
 import android.text.format.DateFormat;
 import android.util.Log;
 import android.view.View;
 import android.view.ViewGroup;
 import android.widget.TextView;
 
 import com.actionbarsherlock.view.Menu;
@@ skipping 14 matching lines @@
 
   private RefreshableListPreference subscriptionList;
 
   private String subscriptionSummary;
 
   @Override
   public void onCreate(Bundle savedInstanceState)
   {
     super.onCreate(savedInstanceState);
 
-    PreferenceManager.setDefaultValues(this, R.xml.preferences, false);
-    PreferenceManager.setDefaultValues(this, R.xml.preferences_advanced, false);
+    PreferenceManager.setDefaultValues(this, R.xml.preferences, true);
+    PreferenceManager.setDefaultValues(this, R.xml.preferences_advanced, true);
     setContentView(R.layout.preferences);
     addPreferencesFromResource(R.xml.preferences);
 
     SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(this);
 
     // Check if we need to update assets
     int lastVersion = prefs.getInt(getString(R.string.pref_version), 0);
     try
     {
       int thisVersion = getPackageManager().getPackageInfo(getPackageName(), 0).versionCode;
@@ skipping 95 matching lines @@
       public void run()
       {
         if (!application.verifySubscriptions())
         {
           Subscription subscription = application.getSubscription(url);
           application.setSubscription(subscription);
         }
       }
     }).start();
 
-    // Check if service is running and update UI accordingly
+    // Update service and UI state according to user settings
     boolean enabled = prefs.getBoolean(getString(R.string.pref_enabled), false);
-    if (enabled && !isServiceRunning())
-    {
-      setEnabled(false);
-    }
-    // Run service if this is first application run
-    else if (!enabled && firstRun)
-    {
-      startService(new Intent(this, ProxyService.class));
-      setEnabled(true);
-    }
+    boolean proxyenabled = prefs.getBoolean(getString(R.string.pref_proxyenabled), false);
+    if (enabled || firstRun)
+      setFilteringEnabled(true);
+    if (enabled || firstRun || proxyenabled)
+      setProxyEnabled(true);
 
     bindService(new Intent(this, ProxyService.class), proxyServiceConnection, 0);
   }
 
   @Override
   public void onPause()
   {
     super.onPause();
     try
     {
       unregisterReceiver(receiver);
     }
     catch (IllegalArgumentException e)
     {
       // ignore - it is thrown if receiver is not registered but it can not be
       // true in normal conditions
     }
     unbindService(proxyServiceConnection);
     proxyService = null;
     
     hideConfigurationMsg();
   }
 
   @Override
   protected void onStop()
   {
     super.onStop();
-    SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(this);
-    boolean enabled = prefs.getBoolean(getString(R.string.pref_enabled), false);
     AdblockPlus application = AdblockPlus.getApplication();
     application.stopInteractive();
-    if (!enabled)
+    if (!application.isFilteringEnabled())
       application.stopEngine(true);

[Felix Dahlke, 2013/03/11 06:57:38]

Why do this in onStop() and not in onSharedPreferenceChanged()?

[Andrey Novikov, 2013/03/11 07:32:55]

Because we need to have JS running during all interactive session.

   }
 
   @Override
   public boolean onCreateOptionsMenu(Menu menu)
   {
     MenuInflater inflater = getSupportMenuInflater();
     inflater.inflate(R.menu.menu_preferences, menu);
     return true;
   }
 
@@ skipping 11 matching lines @@
         showDialog(ABOUT_DIALOG);
         return true;
       case R.id.menu_advanced:
         startActivity(new Intent(this, AdvancedPreferences.class));
         return true;
       default:
         return super.onOptionsItemSelected(item);
     }
   }
 
-  private void setEnabled(boolean enabled)
+  private void setFilteringEnabled(boolean enabled)
   {
     SharedPreferences.Editor editor = PreferenceManager.getDefaultSharedPreferences(this).edit();
     editor.putBoolean(getString(R.string.pref_enabled), enabled);
     editor.commit();
-    ((CheckBoxPreference) findPreference(getString(R.string.pref_enabled))).setChecked(enabled);
+    ((SwitchPreference) findPreference(getString(R.string.pref_enabled))).setChecked(enabled);
+    AdblockPlus application = AdblockPlus.getApplication();
+    application.setFilteringEnabled(enabled);
+  }
+
+  private void setProxyEnabled(boolean enabled)
+  {
+    SharedPreferences.Editor editor = PreferenceManager.getDefaultSharedPreferences(this).edit();
+    editor.putBoolean(getString(R.string.pref_proxyenabled), enabled);
+    editor.commit();
+    AdblockPlus application = AdblockPlus.getApplication();
+    if (enabled && !application.isServiceRunning())
+      startService(new Intent(this, ProxyService.class));
   }
 
   /**
-   * Checks if ProxyService is running.
-   * 
-   * @return true if service is running
-   */
-  private boolean isServiceRunning()
-  {
-    ActivityManager manager = (ActivityManager) getSystemService(ACTIVITY_SERVICE);
-    // Actually it returns not only running services, so extra check is required
-    for (RunningServiceInfo service : manager.getRunningServices(Integer.MAX_VALUE))
-    {
-      if ("org.adblockplus.android.ProxyService".equals(service.service.getClassName()) && service.pid > 0)
-        return true;
-    }
-    return false;
-  }
-
-  /**
    * Copies file assets from installation package to filesystem.
    */
   private void copyAssets()
   {
     AssetManager assetManager = getAssets();
     String[] files = null;
     try
     {
       files = assetManager.list("install");
     }
@@ skipping 69 matching lines @@
         builder.setMessage(Html.fromHtml(message.toString()));
         dialog = builder.create();
         break;
     }
     return dialog;
   }
 
   @Override
   public void onSharedPreferenceChanged(SharedPreferences sharedPreferences, String key)
   {
+    AdblockPlus application = AdblockPlus.getApplication();
     if (getString(R.string.pref_enabled).equals(key))
     {
       boolean enabled = sharedPreferences.getBoolean(key, false);
-      boolean serviceRunning = isServiceRunning();
-      if (enabled && !serviceRunning)
-        startService(new Intent(this, ProxyService.class));
-      else if (!enabled && serviceRunning)
+      boolean autoconfigured = sharedPreferences.getBoolean(getString(R.string.pref_proxyautoconfigured), false);
+      boolean serviceRunning = application.isServiceRunning();
+      application.setFilteringEnabled(enabled);
+      if (enabled)
+      {
+        // If user has enabled filtering, enable proxy as well
+        setProxyEnabled(true);
+      }
+      else if (serviceRunning && autoconfigured)
+      {
+        // If user disabled filtering disable proxy only if it was autoconfigured
         stopService(new Intent(this, ProxyService.class));
+      }
     }
     else if (getString(R.string.pref_subscription).equals(key))
     {
       String current = sharedPreferences.getString(key, null);
-      AdblockPlus application = AdblockPlus.getApplication();
       Subscription subscription = application.getSubscription(current);
       application.setSubscription(subscription);
     }
     else if (getString(R.string.pref_hideicon).equals(key))
     {
       boolean hideIcon = sharedPreferences.getBoolean(key, false);
       if (hideIcon)
         showDialog(HIDEICONWARNING_DIALOG);
       if (proxyService != null)
         proxyService.setEmptyIcon(hideIcon);
@@ skipping 33 matching lines @@
           {
             // Proxy is properly configured
             if (extra.getBoolean("configured"))
               hideConfigurationMsg();
             else
               showConfigurationMsg(getString(R.string.msg_configuration, extra.getInt("port")));
           }
         }
         else
         {
-          setEnabled(false);
+          setFilteringEnabled(false);
           hideConfigurationMsg();
         }
       }
       if (action.equals(ProxyService.BROADCAST_PROXY_FAILED))
       {
         String msg = extra.getString("msg");
         new AlertDialog.Builder(Preferences.this).setTitle(R.string.error).setMessage(msg).setIcon(android.R.drawable.ic_dialog_alert).setPositiveButton(R.string.ok, null).create().show();
-        setEnabled(false);
+        setFilteringEnabled(false);
       }
       if (action.equals(AdblockPlus.BROADCAST_SUBSCRIPTION_STATUS))
       {
         final String text = extra.getString("text");
         final long time = extra.getLong("time");
         runOnUiThread(new Runnable()
         {
           public void run()
           {
             setSubscriptionStatus(text, time);
@@ skipping 69 matching lines @@
         showConfigurationMsg(getString(R.string.msg_configuration, proxyService.port));
     }
 
     public void onServiceDisconnected(ComponentName className)
     {
       proxyService = null;
       Log.d(TAG, "Proxy service disconnected");
     }
   };
 }