FilterEngine refactoring

Created Updater class for handling application updates and moved
respective API from FilterEngine to Updater component.
For now Updater class does not care about asynchronicity (if any)
in JS files which are used for update checks logic.
TODO: Move Updater class to dedicated .h and .cpp files.

Abstracted jsSources from FilterEngine. Now every component (like
FilterEngine and Updater) created by Platfrom gets EvaluateCallback
and evaluates own JS files needed for internal logic.

EvaluateCallback keeps track of evaluated files to avoid duplicated
evaluations.

Author: kzlomek

include/AdblockPlus/FilterEngine.h

@@ -187,7 +187,6 @@ namespace AdblockPlus
    * It handles:
    * - Filter management and matching.
    * - Subscription management and synchronization.
-   * - Update checks for the application.
    */
   class FilterEngine
   {
@@ -225,18 +224,6 @@ namespace AdblockPlus
      */
     typedef int32_t ContentTypeMask;
 
-    /**
-     * Callback type invoked when an update becomes available.
-     * The parameter is the download URL of the update.
-     */
-    typedef std::function<void(const std::string&)> UpdateAvailableCallback;
-
-    /**
-     * Callback type invoked when a manually triggered update check finishes.
-     * The parameter is an optional error message.
-     */
-    typedef std::function<void(const std::string&)> UpdateCheckDoneCallback;
-
     /**
      * Callback type invoked when the filters change.
      * The first parameter is the action event code (see
@@ -296,6 +283,7 @@ namespace AdblockPlus
      * @param parameters optional creation parameters.
      */
     static void CreateAsync(const JsEnginePtr& jsEngine,
+      const JsEngine::EvaluateCallback& evaluateCallback,
       const OnCreatedCallback& onCreated,
       const CreationParameters& parameters = CreationParameters());
 
@@ -476,32 +464,6 @@ namespace AdblockPlus
      */
     std::string GetHostFromURL(const std::string& url) const;
 
-    /**
-     * Sets the callback invoked when an application update becomes available.
-     * @param callback Callback to invoke.
-     */
-    void SetUpdateAvailableCallback(const UpdateAvailableCallback& callback);
-
-    /**
-     * Removes the callback invoked when an application update becomes
-     * available.
-     */
-    void RemoveUpdateAvailableCallback();
-
-    /**
-     * Forces an immediate update check.
-     * `FilterEngine` will automatically check for updates in regular intervals,
-     * so applications should only call this when the user triggers an update
-     * check manually.
-     * @param callback Optional callback to invoke when the update check is
-     *        finished. The string parameter will be empty when the update check
-     *        succeeded, or contain an error message if it failed.
-     *        Note that the callback will be invoked whether updates are
-     *        available or not - to react to updates being available, use
-     *        `FilterEngine::SetUpdateAvailableCallback()`.
-     */
-    void ForceUpdateCheck(const UpdateCheckDoneCallback& callback = UpdateCheckDoneCallback());
-
     /**
      * Sets the callback invoked when the filters change.
      * @param callback Callback to invoke.
@@ -558,7 +520,6 @@ namespace AdblockPlus
   private:
     JsEnginePtr jsEngine;
     bool firstRun;
-    int updateCheckId;
     static const std::map<ContentType, std::string> contentTypes;
 
     explicit FilterEngine(const JsEnginePtr& jsEngine);
@@ -573,6 +534,57 @@ namespace AdblockPlus
       ContentTypeMask contentTypeMask,
       const std::vector<std::string>& documentUrls) const;
   };
+
+  /**
+   * Component of libadblockplus responsible for Update checks for the application.
+   */
+  class Updater
+  {
+  public:
+    explicit Updater(const JsEnginePtr& jsEngine, const JsEngine::EvaluateCallback& callback);
+
+    /**
+     * Callback type invoked when an update becomes available.
+     * The parameter is the download URL of the update.
+     */
+    typedef std::function<void(const std::string&)> UpdateAvailableCallback;
+
+    /**
+     * Callback type invoked when a manually triggered update check finishes.
+     * The parameter is an optional error message.
+     */
+    typedef std::function<void(const std::string&)> UpdateCheckDoneCallback;
+
+    /**
+     * Sets the callback invoked when an application update becomes available.
+     * @param callback Callback to invoke.
+     */
+    void SetUpdateAvailableCallback(const UpdateAvailableCallback& callback);
+
+    /**
+     * Removes the callback invoked when an application update becomes
+     * available.
+     */
+    void RemoveUpdateAvailableCallback();
+
+    /**
+     * Forces an immediate update check.
+     * `Updater` will automatically check for updates in regular intervals,
+     * so applications should only call this when the user triggers an update
+     * check manually.
+     * @param callback Optional callback to invoke when the update check is
+     *        finished. The string parameter will be empty when the update check
+     *        succeeded, or contain an error message if it failed.
+     *        Note that the callback will be invoked whether updates are
+     *        available or not - to react to updates being available, use
+     *        `Updater::SetUpdateAvailableCallback()`.
+     */
+    void ForceUpdateCheck(const UpdateCheckDoneCallback& callback = UpdateCheckDoneCallback());
+
+  private:
+    JsEnginePtr jsEngine;
+    int updateCheckId;
+  };
 }
 
 #endif

include/AdblockPlus/JsEngine.h

@@ -21,6 +21,7 @@
 #include <functional>
 #include <map>
 #include <list>
+#include <set>
 #include <stdexcept>
 #include <stdint.h>
 #include <string>
@@ -143,6 +144,12 @@ namespace AdblockPlus
     JsValue Evaluate(const std::string& source,
         const std::string& filename = "");
 
+    /**
+     * Callback type for evaluating JS expression.
+     * The parameter is the JS file name containing the expression.
+     */
+    typedef std::function<void(const std::string&)> EvaluateCallback;
+
     /**
      * Initiates a garbage collection.
      */
@@ -293,6 +300,7 @@ namespace AdblockPlus
     std::mutex eventCallbacksMutex;
     JsWeakValuesLists jsWeakValuesLists;
     std::mutex jsWeakValuesListsMutex;
+    std::set<std::string> evaluatedJsSources;
   };
 }
 

include/AdblockPlus/Platform.h

@@ -27,6 +27,8 @@
 #include "FilterEngine.h"
 #include <mutex>
 #include <future>
+#include <set>
+#include <string>
 
 namespace AdblockPlus
 {
@@ -108,6 +110,11 @@ namespace AdblockPlus
      */
     FilterEngine& GetFilterEngine();
 
+    /**
+     * Retrieves the Updater component instance.
+     */
+    Updater& GetUpdater();
+
     typedef std::function<void(ITimer&)> WithTimerCallback;
     virtual void WithTimer(const WithTimerCallback&);
 
@@ -125,11 +132,15 @@ namespace AdblockPlus
     TimerPtr timer;
     FileSystemPtr fileSystem;
     WebRequestPtr webRequest;
+    JsEngine::EvaluateCallback evaluateCallback;
   private:
     // used for creation and deletion of modules.
     std::mutex modulesMutex;
     std::shared_ptr<JsEngine> jsEngine;
     std::shared_future<FilterEnginePtr> filterEngine;
+    std::shared_ptr<Updater> updater;
+    std::set<std::string> evaluatedJsSources;
+    JsEngine::EvaluateCallback GetEvaluateCallback();
   };
 
   /**