feat: 35-Make the user agent customizable

Author: didarul-codes

CHANGELOG.md

@@ -1,3 +1,16 @@
+## 2.3.0
+### New Features
+* **Custom User Agent**: Set a custom user agent for the webview
+  * Configure via 
+  ```dart
+  AdBlockerWebview(
+  adBlockerWebviewController: controller,
+  shouldBlockAds: true,
+  url: Uri.parse('https://example.com'),
+  userAgent: 'MyCustomApp/1.0 (Custom User Agent)',
+  // ... other parameters
+)```
+
 ## 2.2.0
 
 **Breaking Changes**

example/lib/browser.dart

@@ -30,6 +30,7 @@ class _BrowserState extends State<Browser> {
           child: AdBlockerWebview(
             url: Uri.parse(widget.url),
             adBlockerWebviewController: widget.controller,
+            userAgent: 'MyCustomApp/1.0 (Custom User Agent)',
             onProgress: (progress) {
               setState(() {
                 _progress = progress;

lib/src/adblocker_webview.dart

@@ -20,6 +20,7 @@ class AdBlockerWebview extends StatefulWidget {
     required this.shouldBlockAds,
     this.url,
     this.initialHtmlData,
+    this.userAgent,
     this.onLoadStart,
     this.onLoadFinished,
     this.onProgress,
@@ -43,6 +44,10 @@ class AdBlockerWebview extends StatefulWidget {
   /// Either this or [url] must be provided, but not both.
   final String? initialHtmlData;
 
+  /// Custom user agent string for the webview.
+  /// If not provided, a default user agent will be used based on the platform.
+  final String? userAgent;
+
   /// Required: The controller for [AdBlockerWebview].
   /// See more at [AdBlockerWebviewController].
   final AdBlockerWebviewController adBlockerWebviewController;
@@ -199,6 +204,11 @@ class _AdBlockerWebviewState extends State<AdBlockerWebview> {
   }
 
   String _getUserAgent() {
+    // Return custom user agent if provided
+    if (widget.userAgent != null && widget.userAgent!.isNotEmpty) {
+      return widget.userAgent!;
+    }
+
     final osVersion = Platform.operatingSystemVersion;
 
     if (Platform.isAndroid) {

lib/src/adblocker_webview_controller.dart

@@ -97,7 +97,6 @@ abstract interface class AdBlockerWebviewController
   /// Checks if a domain is in the whitelist
   bool isAllowedDomain(String urlOrDomain);
 
-
   /// Returns the set of blocked domains (custom block list)
   Set<String> get blockedDomains;
 
@@ -114,7 +113,6 @@ abstract interface class AdBlockerWebviewController
   /// Checks if a domain is in the custom block list
   bool isBlockedDomain(String urlOrDomain);
 
-
   /// Returns the blocking statistics
   BlockingStatistics get statistics;
 

lib/src/adblocker_webview_controller_impl.dart

@@ -118,7 +118,6 @@ class AdBlockerWebviewControllerImpl implements AdBlockerWebviewController {
     return controller.runJavaScript(script);
   }
 
-
   @override
   Set<String> get allowedDomains => _adBlockManager.allowedDomains;
 
@@ -134,7 +133,6 @@ class AdBlockerWebviewControllerImpl implements AdBlockerWebviewController {
   bool isAllowedDomain(String urlOrDomain) =>
       _adBlockManager.isAllowedDomain(urlOrDomain);
 
-
   @override
   Set<String> get blockedDomains => _adBlockManager.blockedDomains;
 

lib/src/block_resource_loading.dart

@@ -1,3 +1,5 @@
+// ignore_for_file: lines_longer_than_80_chars, use_raw_strings
+
 import 'dart:convert';
 import 'package:adblocker_manager/adblocker_manager.dart';
 
@@ -23,6 +25,7 @@ String getResourceLoadingBlockerScript(List<ResourceRule> rules) {
         }
         // Complex rule
         // t: types, d: domains, i: important, tp: thirdParty
+        // ignore: omit_local_variable_types
         final Map<String, dynamic> map = {'u': r.url};
         if (r.resourceTypes != null) map['t'] = r.resourceTypes;
         if (r.domains != null) map['d'] = r.domains;

packages/adblocker_core/lib/src/adblocker_filter_impl.dart

@@ -1,3 +1,5 @@
+// ignore_for_file: lines_longer_than_80_chars
+
 import 'package:adblocker_core/src/adblocker_filter.dart';
 import 'package:adblocker_core/src/lru_cache.dart';
 import 'package:adblocker_core/src/parser/css_rules_parser.dart';

pubspec.yaml

@@ -2,7 +2,7 @@ name: adblocker_webview
 description: A webview for flutter with adblocking capability. It's currently based on Official Flutter Webview Plugin.
 repository: https://github.com/islamdidarmd/flutter_adblocker_webview
 issue_tracker: https://github.com/islamdidarmd/flutter_adblocker_webview/issues
-version: 2.2.0
+version: 2.3.0
 homepage: https://github.com/islamdidarmd/flutter_adblocker_webview
 
 environment:
@@ -26,3 +26,7 @@ dev_dependencies:
     sdk: flutter
   test: ^1.21.0
   very_good_analysis: ^5.1.0
+
+platforms:
+  android:
+  ios: