Usage of new API, cleanups (reduced)

src/org/adblockplus/android/ABPEngine.java

 /*
  * This file is part of Adblock Plus <http://adblockplus.org/>,
  * Copyright (C) 2006-2014 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 org.adblockplus.android.updater.UpdaterActivity;
-
-import android.app.Notification;
-import android.app.NotificationManager;
-import android.app.PendingIntent;
+import java.util.List;
+
+import org.adblockplus.libadblockplus.AppInfo;
+import org.adblockplus.libadblockplus.EventCallback;
+import org.adblockplus.libadblockplus.Filter;
+import org.adblockplus.libadblockplus.FilterChangeCallback;
+import org.adblockplus.libadblockplus.FilterEngine;
+import org.adblockplus.libadblockplus.JsEngine;
+import org.adblockplus.libadblockplus.LogSystem;
+import org.adblockplus.libadblockplus.Subscription;
+import org.adblockplus.libadblockplus.UpdaterCallback;
+import org.adblockplus.libadblockplus.WebRequest;
+
 import android.content.Context;
-import android.content.Intent;
 import android.content.pm.PackageInfo;
 import android.content.pm.PackageManager.NameNotFoundException;
 import android.os.Build.VERSION;
-import android.support.v4.app.NotificationCompat;
 import android.util.Log;
 
-public class ABPEngine
+public final class ABPEngine
 {
-  private final static String TAG = "ABPEngine";
-  private static final int NOTIFICATION_ID = R.string.app_name + 1;
-
-  private Context context;
-
-  public ABPEngine(Context context, String basePath)
+  private static final String TAG = Utils.getTag(ABPEngine.class);
+
+  private final Context context;
+
+  private volatile JsEngine jsEngine;

[Felix Dahlke, 2014/04/28 07:29:01]

I know we discussed this in the last path set, but I still think it's not really
obvious why these are volatile. Maybe it makes sense to add a comment describing
the problem?

[René Jeschke, 2014/04/28 08:34:32]

Done.

+  private volatile FilterEngine filterEngine;
+  private volatile LogSystem logSystem;
+  private volatile WebRequest webRequest;
+  private volatile EventCallback updateCallback;
+  private volatile UpdaterCallback updaterCallback;
+  private volatile FilterChangeCallback filterChangeCallback;
+
+  private ABPEngine(final Context context)
   {
     this.context = context;
-    String version;
+  }
+
+  public static AppInfo generateAppInfo(final Context context)
+  {
+    String version = "0";
     try
     {
       final PackageInfo info = context.getPackageManager().getPackageInfo(context.getPackageName(), 0);
       version = info.versionName + "." + info.versionCode;
-    } catch (NameNotFoundException e)
+    }
+    catch (final NameNotFoundException e)
     {
       Log.e(TAG, "Failed to get the application version number", e);
-      version = "0";
     }
     final String sdkVersion = String.valueOf(VERSION.SDK_INT);
     final String locale = context.getResources().getConfiguration().locale.toString();
     final boolean developmentBuild = !context.getResources().getBoolean(R.bool.def_release);
-    initialize(basePath, version, sdkVersion, locale, developmentBuild);
-  }
-
-  public void onFilterChanged(String url, String status, long time)
-  {
-    context.sendBroadcast(new Intent(AdblockPlus.BROADCAST_SUBSCRIPTION_STATUS).putExtra("url", url).putExtra("status", status).putExtra("time", time));
-  }
-
-  /**
-   * Called when update event occurred.
-   * @param url Update download address
-   */
-  public void onUpdateEvent(String url, String error)
-  {
-    Notification notification = getNotification(url, error);
-    NotificationManager notificationManager = (NotificationManager) context.getSystemService(Context.NOTIFICATION_SERVICE);
-    notificationManager.notify(NOTIFICATION_ID, notification);
-  }
-
-  private native void initialize(String basePath, String version, String sdkVersion, String locale, boolean developmentBuild);
-
-  public native void release();
-
-  public native boolean isFirstRun();
-
-  public native Subscription[] getListedSubscriptions();
-
-  public native Subscription[] getRecommendedSubscriptions();
-
-  public native void addSubscription(String url);
-
-  public native void removeSubscription(String url);
-
-  public native void refreshSubscription(String url);
-
-  public native void actualizeSubscriptionStatus(String url);
-
-  public native void setAcceptableAdsEnabled(boolean enabled);
-
-  public native String getDocumentationLink();
-
-  public native boolean matches(String url, String contentType, String[] documentUrls);
-
-  public native String[] getSelectorsForDomain(String domain);
-
-  public native void checkUpdates();
-
-  private Notification getNotification(String url, String error)
-  {
-    final PendingIntent emptyIntent = PendingIntent.getActivity(context, 0, new Intent(), 0);
-
-    NotificationCompat.Builder builder = new NotificationCompat.Builder(context);
-    builder.setContentTitle(context.getText(R.string.app_name));
-    builder.setSmallIcon(R.drawable.ic_stat_warning);
-    builder.setWhen(System.currentTimeMillis());
-    builder.setAutoCancel(true);
-    builder.setOnlyAlertOnce(true);
-    builder.setContentIntent(emptyIntent);
-
-    if (url != null)
-    {
-      builder.setSmallIcon(R.drawable.ic_stat_download);
-
-
-      Intent intent = new Intent(context, UpdaterActivity.class).addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
-      intent.setAction("download");
-      intent.putExtra("url", url);
-      PendingIntent updateIntent = PendingIntent.getActivity(context, 0, intent, PendingIntent.FLAG_UPDATE_CURRENT);
-      builder.setContentIntent(updateIntent);
-      builder.setContentText(context.getString(R.string.msg_update_available));
-    }
-    else if (error != null)
-    {
-      //TODO Should we show error message to the user?
-      builder.setContentText(context.getString(R.string.msg_update_fail));
-    }
-    else
-    {
-      builder.setContentText(context.getString(R.string.msg_update_missing));
-    }
-
-    Notification notification = builder.getNotification();
-    return notification;
-  }
-
-  static
-  {
-    System.loadLibrary("adblockplus-jni");
+
+    return AppInfo.builder()
+        .setVersion(version)
+        .setApplicationVersion(sdkVersion)
+        .setLocale(locale)
+        .setDevelopmentBuild(developmentBuild)

[Felix Dahlke, 2014/04/28 07:29:01]

Is this trailing whitespace? I can't really tell from the diff, looks weird.
Same below.

[René Jeschke, 2014/04/28 08:34:32]

Nope, Editor->Save actions->Remove trailing whitespace ... if I touched the
file, there are no trailing whitespace anymore^^

[Felix Dahlke, 2014/04/28 10:09:41]

Ah, so I guess the diff is telling me that there WAS trailing whitespace then.
Pretty weird, but OK :)

[René Jeschke, 2014/04/28 10:18:34]

Done.

+        .build();
+  }
+
+  public static ABPEngine create(final Context context, final AppInfo appInfo, final String basePath)
+  {
+    final ABPEngine engine = new ABPEngine(context);
+
+    engine.jsEngine = new JsEngine(appInfo);
+    engine.jsEngine.setDefaultFileSystem(basePath);
+
+    engine.logSystem = new AndroidLogSystem();
+    engine.jsEngine.setLogSystem(engine.logSystem);
+
+    engine.webRequest = new AndroidWebRequest();
+    engine.jsEngine.setWebRequest(engine.webRequest);
+
+    engine.updateCallback = new AndroidUpdateAvailableCallback(context);
+    engine.jsEngine.setEventCallback("updateAvailable", engine.updateCallback);
+
+    engine.filterEngine = new FilterEngine(engine.jsEngine);
+    engine.filterChangeCallback = new AndroidFilterChangeCallback(context);
+    engine.filterEngine.setFilterChangeCallback(engine.filterChangeCallback);
+
+    engine.updaterCallback = new AndroidUpdaterCallback(context);
+
+    return engine;
+  }
+
+  public void dispose()
+  {
+    // Safe disposing (just in case)
+    if (this.filterEngine != null)
+    {
+      this.filterEngine.dispose();
+      this.filterEngine = null;
+    }
+
+    if (this.jsEngine != null)
+    {
+      this.jsEngine.dispose();
+      this.jsEngine = null;
+    }
+
+    if (this.logSystem != null)
+    {
+      this.logSystem.dispose();
+      this.logSystem = null;
+    }
+
+    if (this.webRequest != null)
+    {
+      this.webRequest.dispose();
+      this.webRequest = null;
+    }
+
+    if (this.updateCallback != null)
+    {
+      this.updateCallback.dispose();
+      this.updateCallback = null;
+    }
+
+    if (this.updaterCallback != null)
+    {
+      this.updaterCallback.dispose();
+      this.updaterCallback = null;
+    }
+
+    if (this.filterChangeCallback != null)
+    {
+      this.filterChangeCallback.dispose();
+      this.filterChangeCallback = null;
+    }
+  }
+
+  public boolean isFirstRun()
+  {
+    return this.filterEngine.isFirstRun();
+  }
+
+  private static org.adblockplus.android.Subscription convertJsSubscription(final Subscription jsSubscription)
+  {
+    final org.adblockplus.android.Subscription subscription = new org.adblockplus.android.Subscription();
+
+    subscription.title = jsSubscription.getProperty("title").toString();
+    subscription.url = jsSubscription.getProperty("url").toString();
+
+    return subscription;
+  }
+
+  private static org.adblockplus.android.Subscription[] convertJsSubscriptions(final List<Subscription> subs)

[Felix Dahlke, 2014/04/28 07:29:01]

How about renaming "subs" to "jsSubscription" and "ret" to "subscription" like
above?

[René Jeschke, 2014/04/28 08:34:32]

Done.

+  {
+    final org.adblockplus.android.Subscription[] ret = new org.adblockplus.android.Subscription[subs.size()];
+
+    for (int i = 0; i < ret.length; i++)
+    {
+      ret[i] = convertJsSubscription(subs.get(i));
+    }
+
+    return ret;
+  }
+
+  public org.adblockplus.android.Subscription[] getRecommendedSubscriptions()
+  {
+    return convertJsSubscriptions(this.filterEngine.fetchAvailableSubscriptions());
+  }
+
+  public org.adblockplus.android.Subscription[] getListedSubscriptions()
+  {
+    return convertJsSubscriptions(this.filterEngine.getListedSubscriptions());
+  }
+
+  public void setSubscription(final String url)
+  {
+    Subscription sub = null;
+    for (final Subscription s : this.filterEngine.getListedSubscriptions())
+    {
+      if (url.equals(s.getProperty("url").toString()))
+      {
+        sub = s;
+      }
+      s.removeFromList();
+    }
+    if (sub != null)
+    {
+      sub.addToList();
+    }
+  }
+
+  public void refreshSubscriptions()
+  {
+    for (final Subscription s : this.filterEngine.getListedSubscriptions())
+    {
+      s.updateFilters();
+    }
+  }
+
+  public void setAcceptableAdsEnabled(final boolean enabled)
+  {
+    final String url = this.filterEngine.getPref("subscriptions_exceptionsurl").toString();
+    final Subscription sub = this.filterEngine.getSubscription(url);
+    if (sub != null)
+    {
+      if (enabled)
+      {
+        sub.addToList();
+      }
+      else
+      {
+        sub.removeFromList();
+      }
+    }
+  }
+
+  public String getDocumentationLink()
+  {
+    return this.filterEngine.getPref("documentation_link").toString();
+  }
+
+  public boolean matches(final String fullUrl, final String contentType, final String[] referrerChainArray)
+  {
+    final Filter filter = this.filterEngine.matches(fullUrl, contentType, referrerChainArray);
+
+    if (filter == null)
+    {
+      return false;
+    }
+
+    // hack: if there is no referrer, block only if filter is domain-specific
+    // (to re-enable in-app ads blocking, proposed on 12.11.2012 Monday meeting)
+    // (documentUrls contains the referrers on Android)
+    if (referrerChainArray.length == 0 && (filter.getProperty("text").toString()).contains("||"))
+    {
+      return false;
+    }
+
+    return filter.getType() != Filter.Type.EXCEPTION;
+  }
+
+  public void checkForUpdates()
+  {
+    this.filterEngine.forceUpdateCheck(this.updaterCallback);
+  }
+
+  public void updateSubscriptionStatus(final String url)
+  {
+    final Subscription sub = this.filterEngine.getSubscription(url);
+    if (sub != null)
+    {
+      Utils.updateSubscriptionStatus(this.context, sub);
+    }
   }
 }