Issue 1108 - Support notifications

src/org/adblockplus/android/ProxyService.java

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2015 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.net.InetAddress;
 import java.net.ServerSocket;
 import java.net.UnknownHostException;
 import java.util.Properties;
 
 import org.adblockplus.android.configurators.ProxyConfigurator;
 import org.adblockplus.android.configurators.ProxyConfigurators;
 import org.adblockplus.android.configurators.ProxyRegistrationType;
+import org.adblockplus.libadblockplus.Notification.Type;
 import org.apache.commons.lang.StringUtils;
 
 import sunlabs.brazil.server.Server;
 import sunlabs.brazil.util.Base64;
 import android.annotation.SuppressLint;
 import android.app.Notification;
 import android.app.NotificationManager;
 import android.app.PendingIntent;
 import android.app.Service;
 import android.content.BroadcastReceiver;
@@ skipping 13 matching lines @@
 public class ProxyService extends Service implements OnSharedPreferenceChangeListener
 {
   private static final String TAG = Utils.getTag(ProxyService.class);
 
   private static final String LOCALHOST = "127.0.0.1";
 
   private static final int[] PORT_VARIANTS = new int[] {-1, 2020, 3030, 4040, 5050, 6060, 7070, 9090, 1234, 12345, 4321, 0};
 
   private static final boolean LOG_REQUESTS = false;
 
-  static final int ONGOING_NOTIFICATION_ID = R.string.app_name;
-
   private static final long POSITION_RIGHT = Build.VERSION.SDK_INT >= Build.VERSION_CODES.GINGERBREAD ? Long.MIN_VALUE : Long.MAX_VALUE;
 
   /**
    * This flag indicates that this mobile device runs an Android version that allows the user to configure a http(s) proxy.
    */
   public static final boolean GLOBAL_PROXY_USER_CONFIGURABLE = Build.VERSION.SDK_INT >= 12; // Honeycomb 3.1
 
   /**
    * Broadcasted when service starts or stops.
    */
   public static final String BROADCAST_STATE_CHANGED = "org.adblockplus.android.SERVICE_STATE_CHANGED";
 
   /**
    * Broadcasted if proxy fails to start.
    */
   public static final String BROADCAST_PROXY_FAILED = "org.adblockplus.android.PROXY_FAILURE";
 
   /**
-   * Common command bridge
+   * Proxy state changed
    */
   public static final String PROXY_STATE_CHANGED_ACTION = "org.adblockplus.android.PROXY_STATE_CHANGED";
 
   boolean hideIcon;
 
   protected ProxyServer proxy = null;
 
   protected int port;
 
   private final Properties proxyConfiguration = new Properties();
 
   private ProxyConfigurator proxyConfigurator = null;
+
+  private NotificationWatcher notificationWatcher = null;
 
   @SuppressLint("NewApi")
   @Override
   public void onCreate()
   {
     super.onCreate();
 
     StrictMode.setThreadPolicy(new StrictMode.ThreadPolicy.Builder()
         .permitAll()
         .penaltyLog()
@@ skipping 108 matching lines @@
       proxy = new ProxyServer();
       proxy.logLevel = Server.LOG_LOG;
       proxy.setup(listen, proxyConfiguration.getProperty("handler"), proxyConfiguration);
       proxy.start();
     }
 
     prefs.registerOnSharedPreferenceChangeListener(this);
 
     // Lock service
     hideIcon = prefs.getBoolean(getString(R.string.pref_hideicon), getResources().getBoolean(R.bool.def_hideicon));
-    startForeground(ONGOING_NOTIFICATION_ID, getNotification());
+    startForeground(AdblockPlus.ONGOING_NOTIFICATION_ID, getNotification());
 
     sendStateChangedBroadcast();
+
+    this.startNotificationWatcher();
+
     Log.i(TAG, "Service started");
   }
 
   @Override
   public int onStartCommand(final Intent intent, final int flags, final int startId)
   {
     return START_STICKY;
   }
 
   @Override
   public void onDestroy()
   {
     super.onDestroy();
+
+    this.stopNotificationWatcher();
 
     unregisterReceiver(this.proxyReceiver);
     unregisterReceiver(this.proxyStateChangedReceiver);
 
     if (this.proxyConfigurator != null)
     {
       this.proxyConfigurator.unregisterProxy();
       this.proxyConfigurator.shutdown();
     }
 
@@ skipping 244 matching lines @@
     builder.setContentText(getString(msgId, port));
     builder.setOngoing(true);
 
     return builder.getNotification();
   }
 
   public void setEmptyIcon(final boolean hide)
   {
     hideIcon = hide;
     final NotificationManager notificationManager = (NotificationManager) getSystemService(NOTIFICATION_SERVICE);
-    notificationManager.notify(ONGOING_NOTIFICATION_ID, getNotification());
+    notificationManager.notify(AdblockPlus.ONGOING_NOTIFICATION_ID, getNotification());
   }
 
   public void sendStateChangedBroadcast()
   {
     final boolean manual = isManual();
     final Intent stateIntent = new Intent(BROADCAST_STATE_CHANGED)
         .putExtra("enabled", true)
         .putExtra("port", port)
         .putExtra("manual", manual);
 
@@ skipping 42 matching lines @@
    * </p>
    */
   private final BroadcastReceiver proxyStateChangedReceiver = new BroadcastReceiver()
   {
     @Override
     public void onReceive(final Context context, final Intent intent)
     {
       if (intent != null && PROXY_STATE_CHANGED_ACTION.equals(intent.getAction()))
       {
         final NotificationManager notificationManager = (NotificationManager) getSystemService(NOTIFICATION_SERVICE);
-        notificationManager.notify(ONGOING_NOTIFICATION_ID, getNotification());
+        notificationManager.notify(AdblockPlus.ONGOING_NOTIFICATION_ID, getNotification());
         ProxyService.this.sendStateChangedBroadcast();
       }
     }
   };
 
   final class ProxyServer extends Server
   {
     @Override
     public void close()
     {
@@ skipping 12 matching lines @@
 
     @Override
     public void log(final int level, final Object obj, final String message)
     {
       if (level <= logLevel)
       {
         Log.println(7 - level, obj != null ? obj.toString() : TAG, message);
       }
     }
   }
+
+  private void startNotificationWatcher()
+  {
+    this.stopNotificationWatcher();
+
+    this.notificationWatcher = new NotificationWatcher(this);
+
+    final Thread thread = new Thread(this.notificationWatcher);
+    thread.setDaemon(true);
+    thread.start();
+  }
+
+  private void stopNotificationWatcher()
+  {
+    if (this.notificationWatcher != null)
+    {
+      this.notificationWatcher.stop();
+      this.notificationWatcher = null;
+    }
+  }
+
+  private static class NotificationWatcher implements Runnable
+  {
+    public static final int DEFAULT_POLL_DELAY = 3 * 60; /* seconds */
+    public static final int DEFAULT_POLL_INTERVAL = 0; /* seconds */
+
+    private final ProxyService proxyService;
+    private final int pollDelay;
+    private final int pollInterval;
+
+    volatile boolean running = true;
+
+    public NotificationWatcher(final ProxyService proxyService, final int pollDelay,
+        final int pollInterval)
+    {
+      this.proxyService = proxyService;
+      this.pollDelay = Math.max(0, pollDelay);
+      this.pollInterval = Math.max(0, pollInterval);
+    }
+
+    public NotificationWatcher(final ProxyService proxyService)
+    {
+      this(proxyService, DEFAULT_POLL_DELAY, DEFAULT_POLL_INTERVAL);
+    }
+
+    protected void stop()
+    {
+      this.running = false;
+    }
+
+    @Override
+    public void run()
+    {
+      if (this.pollDelay == 0)
+      {
+        this.running = false;
+        return;
+      }
+
+      long nextPoll = System.currentTimeMillis() + 1000L * this.pollDelay;
+
+      while (this.running)
+      {
+        try
+        {
+          Thread.sleep(250);
+        }
+        catch (InterruptedException ex)
+        {
+          break;
+        }
+
+        if (System.currentTimeMillis() >= nextPoll && this.running)
+        {
+          try
+          {
+            Log.d(TAG, "Polling for notifications");
+            org.adblockplus.libadblockplus.Notification notification =
+                AdblockPlus.getApplication().getNextNotificationToShow();
+
+            while (notification != null
+                && (notification.getType() == Type.INVALID || notification.getType() == Type.QUESTION))
+            {
+              notification = AdblockPlus.getApplication().getNextNotificationToShow();
+            }
+
+            if (notification != null)
+            {
+              final NotificationManager notificationManager = (NotificationManager) this.proxyService
+                  .getSystemService(NOTIFICATION_SERVICE);
+
+              notificationManager.notify(AdblockPlus.SERVER_NOTIFICATION_ID,
+                  new NotificationCompat.Builder(this.proxyService.getApplicationContext())
+                      .setSmallIcon(R.drawable.ic_stat_blocking)
+                      .setContentTitle(notification.getTitle())
+                      .setContentText(notification.getMessageString())
+                      .getNotification());
+            }
+          }
+          catch (Exception ex)
+          {
+            Log.e(TAG, "Polling for notifications failed: " + ex.getMessage(), ex);
+          }
+
+          if (this.pollInterval == 0)
+          {
+            this.running = false;
+          }
+          else
+          {
+            nextPoll = System.currentTimeMillis() + 1000L * this.pollInterval;
+          }
+        }
+      }
+    }
+  }
 }