Add user agent header (#251)

* Add Header to differentiate PiwigoNG from other API users

Add an header to all types of query using package_info_plus.
This add an header right before the query but the netcode being a mess it may not be applied everywhere.
Ideally this should be a dio baseoption but async code can't run in init of a class and package info plus doesn't support non async calls
A third party package with async calls seems like the worst way of implementing this but this seems like the only option

* Upgrade to flutter 3.38.4, bump dependencies (no major version bump)

Author: Renarde-dev

.fvmrc

@@ -1,3 +1,3 @@
 {
-  "flutter": "3.38.2"
+  "flutter": "3.38.4"
 }

lib/network/api_client.dart

@@ -6,6 +6,7 @@ import 'package:dio/dio.dart';
 import 'package:dio/io.dart';
 import 'package:dio_cookie_manager/dio_cookie_manager.dart';
 import 'package:flutter/foundation.dart';
+import 'package:package_info_plus/package_info_plus.dart';
 import 'package:piwigo_ng/services/preferences_service.dart';
 
 import 'api_interceptor.dart';
@@ -18,7 +19,8 @@ class ApiClient {
     ..httpClientAdapter = sslHttpClientAdapter;
 
   static HttpClientAdapter get sslHttpClientAdapter => IOHttpClientAdapter(
-        createHttpClient: () => HttpClient()..badCertificateCallback = piwigoSSLBypass,
+        createHttpClient: () =>
+            HttpClient()..badCertificateCallback = piwigoSSLBypass,
       );
 
   static bool piwigoSSLBypass(X509Certificate cert, String host, int port) {
@@ -35,6 +37,9 @@ class ApiClient {
     CancelToken? cancelToken,
     void Function(int, int)? onReceiveProgress,
   }) async {
+    PackageInfo packageInfo = await PackageInfo.fromPlatform();
+    dio.options.headers
+        .addAll({'User-Agent': 'PiwigoNG/${packageInfo.version}'});
     Response response = await dio.get(
       path,
       queryParameters: queryParameters,
@@ -54,6 +59,9 @@ class ApiClient {
     void Function(int, int)? onSendProgress,
     void Function(int, int)? onReceiveProgress,
   }) async {
+    PackageInfo packageInfo = await PackageInfo.fromPlatform();
+    dio.options.headers
+        .addAll({'User-Agent': 'PiwigoNG/${packageInfo.version}'});
     Response response = await dio.post(
       path,
       data: data,
@@ -75,6 +83,9 @@ class ApiClient {
     void Function(int, int)? onSendProgress,
     void Function(int, int)? onReceiveProgress,
   }) async {
+    PackageInfo packageInfo = await PackageInfo.fromPlatform();
+    dio.options.headers
+        .addAll({'User-Agent': 'PiwigoNG/${packageInfo.version}'});
     Response response = await dio.put(
       path,
       data: data,
@@ -96,6 +107,9 @@ class ApiClient {
     void Function(int, int)? onSendProgress,
     void Function(int, int)? onReceiveProgress,
   }) async {
+    PackageInfo packageInfo = await PackageInfo.fromPlatform();
+    dio.options.headers
+        .addAll({'User-Agent': 'PiwigoNG/${packageInfo.version}'});
     Response response = await dio.delete(
       path,
       data: data,
@@ -116,6 +130,8 @@ class ApiClient {
     CancelToken? cancelToken,
     void Function(int, int)? onReceiveProgress,
   }) async {
+    PackageInfo packageInfo = await PackageInfo.fromPlatform();
+    dio.options.headers = {'User-Agent': 'PiwigoNG/${packageInfo.version}'};
     Response response = await dio.download(
       path,
       outputPath,
@@ -134,7 +150,8 @@ class ApiClient {
 class SSLHttpOverrides extends HttpOverrides {
   @override
   HttpClient createHttpClient(SecurityContext? context) {
-    return super.createHttpClient(context)..badCertificateCallback = ApiClient.piwigoSSLBypass;
+    return super.createHttpClient(context)
+      ..badCertificateCallback = ApiClient.piwigoSSLBypass;
   }
 }
 

pubspec.lock

@@ -205,10 +205,10 @@ packages:
     dependency: "direct main"
     description:
       name: device_info_plus
-      sha256: dd0e8e02186b2196c7848c9d394a5fd6e5b57a43a546082c5820b1ec72317e33
+      sha256: "4df8babf73058181227e18b08e6ea3520cf5fc5d796888d33b7cb0f33f984b7c"
       url: "https://pub.dev"
     source: hosted
-    version: "12.2.0"
+    version: "12.3.0"
   device_info_plus_platform_interface:
     dependency: transitive
     description:
@@ -625,10 +625,10 @@ packages:
     dependency: transitive
     description:
       name: image_picker_ios
-      sha256: "997d100ce1dda5b1ba4085194c5e36c9f8a1fb7987f6a36ab677a344cd2dc986"
+      sha256: "956c16a42c0c708f914021666ffcd8265dde36e673c9fa68c81f7d085d9774ad"
       url: "https://pub.dev"
     source: hosted
-    version: "0.8.13+2"
+    version: "0.8.13+3"
   image_picker_linux:
     dependency: transitive
     description:
@@ -881,10 +881,10 @@ packages:
     dependency: transitive
     description:
       name: path_provider_foundation
-      sha256: "6192e477f34018ef1ea790c56fffc7302e3bc3efede9e798b934c252c8c105ba"
+      sha256: "6d13aece7b3f5c5a9731eaf553ff9dcbc2eff41087fd2df587fd0fed9a3eb0c4"
       url: "https://pub.dev"
     source: hosted
-    version: "2.5.0"
+    version: "2.5.1"
   path_provider_linux:
     dependency: transitive
     description:
@@ -1058,18 +1058,18 @@ packages:
     dependency: "direct main"
     description:
       name: shared_preferences
-      sha256: "6e8bf70b7fef813df4e9a36f658ac46d107db4b4cfe1048b477d4e453a8159f5"
+      sha256: "2939ae520c9024cb197fc20dee269cd8cdbf564c8b5746374ec6cacdc5169e64"
       url: "https://pub.dev"
     source: hosted
-    version: "2.5.3"
+    version: "2.5.4"
   shared_preferences_android:
     dependency: transitive
     description:
       name: shared_preferences_android
-      sha256: "46a46fd64659eff15f4638bbe19de43f9483f0e0bf024a9fb6b3582064bacc7b"
+      sha256: "83af5c682796c0f7719c2bbf74792d113e40ae97981b8f266fa84574573556bc"
       url: "https://pub.dev"
     source: hosted
-    version: "2.4.17"
+    version: "2.4.18"
   shared_preferences_foundation:
     dependency: transitive
     description:
@@ -1327,18 +1327,18 @@ packages:
     dependency: transitive
     description:
       name: video_player_android
-      sha256: "3f7ef3fb7b29f510e58f4d56b6ffbc3463b1071f2cf56e10f8d25f5b991ed85b"
+      sha256: d74b66f283afff135d5be0ceccca2ca74dff7df1e9b1eaca6bd4699875d3ae60
       url: "https://pub.dev"
     source: hosted
-    version: "2.8.21"
+    version: "2.8.22"
   video_player_avfoundation:
     dependency: transitive
     description:
       name: video_player_avfoundation
-      sha256: "6bced1739cf1f96f03058118adb8ac0dd6f96aa1a1a6e526424ab92fd2a6a77d"
+      sha256: e4d33b79a064498c6eb3a6a492b6a5012573d4943c28d566caf1a6c0840fe78d
       url: "https://pub.dev"
     source: hosted
-    version: "2.8.7"
+    version: "2.8.8"
   video_player_platform_interface:
     dependency: transitive
     description:
@@ -1407,10 +1407,10 @@ packages:
     dependency: transitive
     description:
       name: webview_flutter_android
-      sha256: "3fcca88ee2ae568807ebd42deed235bb8dd8e62b3e4d5caff67daa6bce062cca"
+      sha256: eeeb3fcd5f0ff9f8446c9f4bbc18a99b809e40297528a3395597d03aafb9f510
       url: "https://pub.dev"
     source: hosted
-    version: "4.10.9"
+    version: "4.10.11"
   webview_flutter_platform_interface:
     dependency: transitive
     description:
@@ -1423,10 +1423,10 @@ packages:
     dependency: transitive
     description:
       name: webview_flutter_wkwebview
-      sha256: a57b76a081bed3bf3a71a486bdf83642b00f1a7342043d50367cea68f338b1af
+      sha256: e49f378ed066efb13fc36186bbe0bd2425630d4ea0dbc71a18fdd0e4d8ed8ebc
       url: "https://pub.dev"
     source: hosted
-    version: "3.23.4"
+    version: "3.23.5"
   win32:
     dependency: transitive
     description: