Move Ablock manager logic to controller

Author: didarul-codes

example/lib/browser.dart

@@ -36,7 +36,6 @@ class _BrowserState extends State<Browser> {
               });
             },
             shouldBlockAds: widget.shouldBlockAds,
-            additionalHostsToBlock: const [],
           ),
         ),
         Row(

example/lib/main.dart

@@ -1,10 +1,17 @@
+import 'package:adblocker_manager/adblocker_manager.dart';
 import 'package:adblocker_webview/adblocker_webview.dart';
 import 'package:flutter/material.dart';
 
 import 'browser_screen.dart';
 import 'url_input_section.dart';
 
-void main() {
+void main() async {
+  await AdBlockerWebviewController.instance.initialize(
+    FilterConfig(
+      filterTypes: [FilterType.easyList, FilterType.adGuard],
+    ),
+    [],
+  );
   runApp(const ExampleApp());
 }
 

lib/adblocker_webview.dart

@@ -1,3 +1,4 @@
+export 'package:adblocker_manager/adblocker_manager.dart';
 export 'src/adblocker_webview.dart';
 export 'src/adblocker_webview_controller.dart';
-export 'src/domain/entity/host.dart';
+export 'src/adblocker_webview_controller_impl.dart';

lib/src/adblocker_webview.dart

@@ -4,7 +4,6 @@ import 'dart:io';
 import 'package:adblocker_manager/adblocker_manager.dart';
 import 'package:adblocker_webview/src/adblocker_webview_controller.dart';
 import 'package:adblocker_webview/src/block_resource_loading.dart';
-import 'package:adblocker_webview/src/domain/entity/host.dart';
 import 'package:adblocker_webview/src/elem_hide.dart';
 import 'package:adblocker_webview/src/logger.dart';
 import 'package:flutter/material.dart';
@@ -23,7 +22,6 @@ class AdBlockerWebview extends StatefulWidget {
     this.onProgress,
     this.onLoadError,
     this.onUrlChanged,
-    this.additionalHostsToBlock = const [],
     super.key,
   }) : assert(
          url != null || initialHtmlData != null,
@@ -61,8 +59,6 @@ class AdBlockerWebview extends StatefulWidget {
   /// Invoked when the page title is changed.
   final void Function(String? url)? onUrlChanged;
 
-  final List<Host> additionalHostsToBlock;
-
   /// Invoked when a loading error occurred.
   final void Function(String? url, int code)? onLoadError;
 
@@ -77,29 +73,25 @@ class _AdBlockerWebviewState extends State<AdBlockerWebview> {
   late Future<void> _depsFuture;
   final List<ResourceRule> _urlsToBlock = [];
 
-  final AdblockFilterManager _adBlockManager = AdblockFilterManager();
-
   @override
   void initState() {
     super.initState();
     _depsFuture = _init();
   }
 
   Future<void> _init() async {
-    final config = FilterConfig(
-      filterTypes: [FilterType.easyList, FilterType.adGuard],
-    );
-    await _adBlockManager.init(config);
     _urlsToBlock
       ..clear()
-      ..addAll(_adBlockManager.getAllResourceRules());
+      ..addAll(widget.adBlockerWebviewController.bannedResourceRules);
 
     _webViewController = WebViewController();
-    await _webViewController.setOnConsoleMessage((message) {
-      debugLog('[FLUTTER_WEBVIEW_LOG]: ${message.message}');
-    });
-    await _webViewController.setUserAgent(_getUserAgent());
-    await _webViewController.setJavaScriptMode(JavaScriptMode.unrestricted);
+    await Future.wait([
+      _webViewController.setOnConsoleMessage((message) {
+        debugLog('[FLUTTER_WEBVIEW_LOG]: ${message.message}');
+      }),
+      _webViewController.setUserAgent(_getUserAgent()),
+      _webViewController.setJavaScriptMode(JavaScriptMode.unrestricted),
+    ]);
 
     _setNavigationDelegate();
     widget.adBlockerWebviewController.setInternalController(_webViewController);
@@ -139,7 +131,8 @@ class _AdBlockerWebviewState extends State<AdBlockerWebview> {
     _webViewController.setNavigationDelegate(
       NavigationDelegate(
         onNavigationRequest: (request) {
-          final shouldBlock = _adBlockManager.shouldBlockResource(request.url);
+          final shouldBlock = widget.adBlockerWebviewController
+              .shouldBlockResource(request.url);
           if (shouldBlock) {
             debugLog('Blocking resource: ${request.url}');
             return NavigationDecision.prevent;
@@ -160,7 +153,8 @@ class _AdBlockerWebviewState extends State<AdBlockerWebview> {
         onPageFinished: (url) {
           if (widget.shouldBlockAds) {
             // Apply element hiding after page load
-            final cssRules = _adBlockManager.getCSSRulesForWebsite(url);
+            final cssRules =
+                widget.adBlockerWebviewController.getCssRulesForWebsite(url);
             unawaited(
               _webViewController.runJavaScript(generateHidingScript(cssRules)),
             );

lib/src/adblocker_webview_controller.dart

@@ -1,5 +1,6 @@
 import 'dart:collection';
 
+import 'package:adblocker_manager/adblocker_manager.dart';
 import 'package:adblocker_webview/adblocker_webview.dart';
 import 'package:adblocker_webview/src/adblocker_webview_controller_impl.dart';
 import 'package:adblocker_webview/src/internal_adblocker_webview_controller.dart';
@@ -15,7 +16,7 @@ import 'package:adblocker_webview/src/internal_adblocker_webview_controller.dart
 ///   @override
 ///   void initState() {
 ///     super.initState();
-///     _adBlockerWebviewController.initialize();
+///     _adBlockerWebviewController.initialize(config, []);
 ///     /// ... Other code here.
 ///   }
 /// ```
@@ -34,12 +35,11 @@ abstract interface class AdBlockerWebviewController
     return _instance!;
   }
 
-  /// Returns the banned host list.
-  /// This list items are populated after calling the [initialize] method
-  UnmodifiableListView<Host> get bannedHost;
-
   /// Initializes the controller
-  Future<void> initialize();
+  Future<void> initialize(
+    FilterConfig filterConfig,
+    List<ResourceRule> additionalResourceRules,
+  );
 
   /// Returns decision of if the webview can go back
   Future<bool> canGoBack();
@@ -50,23 +50,30 @@ abstract interface class AdBlockerWebviewController
   // Clears the cache of webview
   Future<void> clearCache();
 
+  /// Returns the banned resource rules list.
+  /// This list items are populated after calling the [initialize] method
+  UnmodifiableListView<ResourceRule> get bannedResourceRules;
+
   // Returns the title of currently loaded webpage
   Future<String?> getTitle();
 
   // Loads the given url
   Future<void> loadUrl(String url);
 
-  Future<void> loadData(
-    String data, {
-    String? baseUrl,
-  });
+  Future<void> loadData(String data, {String? baseUrl});
+
+  /// Returns the css rules for the given url
+  List<String> getCssRulesForWebsite(String url);
 
   /// Navigates webview to previous page
   Future<void> goBack();
 
   /// Navigates the webview to forward page
   Future<void> goForward();
 
+  /// Returns decision of if the resource should be blocked
+  bool shouldBlockResource(String url);
+
   /// Reloads the current page
   Future<void> reload();
 

lib/src/adblocker_webview_controller_impl.dart

@@ -1,33 +1,33 @@
 import 'dart:collection';
 
-import 'package:adblocker_webview/src/adblocker_webview_controller.dart';
-import 'package:adblocker_webview/src/data/repository/adblocker_repository_impl.dart';
-import 'package:adblocker_webview/src/domain/entity/host.dart';
-import 'package:adblocker_webview/src/domain/repository/adblocker_repository.dart';
+import 'package:adblocker_manager/adblocker_manager.dart';
+import 'package:adblocker_webview/adblocker_webview.dart';
 import 'package:webview_flutter/webview_flutter.dart';
 
 ///Implementation for [AdBlockerWebviewController]
 class AdBlockerWebviewControllerImpl implements AdBlockerWebviewController {
-  AdBlockerWebviewControllerImpl({AdBlockerRepository? repository})
-      : _repository = repository ?? AdBlockerRepositoryImpl();
-  final AdBlockerRepository _repository;
+  AdBlockerWebviewControllerImpl();
 
   WebViewController? _webViewController;
-
-  final _bannedHost = <Host>[];
-
-  @override
-  UnmodifiableListView<Host> get bannedHost =>
-      UnmodifiableListView(_bannedHost);
+  final AdblockFilterManager _adBlockManager = AdblockFilterManager();
+  final _bannedResourceRules = <ResourceRule>[];
 
   @override
-  Future<void> initialize() async {
-    final hosts = await _repository.fetchBannedHostList();
-    _bannedHost
+  Future<void> initialize(
+    FilterConfig filterConfig,
+    List<ResourceRule> additionalResourceRules,
+  ) async {
+    await _adBlockManager.init(filterConfig);
+    _bannedResourceRules
       ..clear()
-      ..addAll(hosts);
+      ..addAll(_adBlockManager.getAllResourceRules())
+      ..addAll(additionalResourceRules);
   }
 
+  @override
+  UnmodifiableListView<ResourceRule> get bannedResourceRules =>
+      UnmodifiableListView(_bannedResourceRules);
+
   @override
   void setInternalController(WebViewController controller) {
     _webViewController = controller;
@@ -60,6 +60,10 @@ class AdBlockerWebviewControllerImpl implements AdBlockerWebviewController {
     return _webViewController!.clearCache();
   }
 
+  @override
+  List<String> getCssRulesForWebsite(String url) =>
+      _adBlockManager.getCSSRulesForWebsite(url);
+
   @override
   Future<String?> getTitle() async {
     if (_webViewController == null) {
@@ -97,19 +101,17 @@ class AdBlockerWebviewControllerImpl implements AdBlockerWebviewController {
   }
 
   @override
-  Future<void> loadData(
-    String data, {
-    String? baseUrl,
-  }) async {
+  Future<void> loadData(String data, {String? baseUrl}) async {
     if (_webViewController == null) {
       return;
     }
-    return _webViewController!.loadHtmlString(
-      data,
-      baseUrl: baseUrl,
-    );
+    return _webViewController!.loadHtmlString(data, baseUrl: baseUrl);
   }
 
+  @override
+  bool shouldBlockResource(String url) =>
+      _adBlockManager.shouldBlockResource(url);
+
   @override
   Future<void> reload() async {
     if (_webViewController == null) {

lib/src/data/repository/adblocker_repository_impl.dart

@@ -16,8 +16,6 @@ dependencies:
   adblocker_manager: ^1.0.0
   flutter:
     sdk: flutter
-
-  flutter_cache_manager: ^3.3.1
   webview_flutter: ^4.10.0
 
 dev_dependencies: