Windows local notifications (#439)

CHANGELOG.md

@@ -11,11 +11,18 @@ All user visible changes to this project will be documented in this file. This p
 
 [Diff](/../../compare/v0.1.0-alpha.9.2...v0.1.0-alpha.10) | [Milestone](/../../milestone/8)
 
+### Added
+
+- Windows:
+    - Notifications. ([#492], [#439])
+
 ### Changed
 
 - UI:
     - Context menu with fading effect on desktop. ([#506])
 
+[#439]: /../../issues/439
+[#492]: /../../pull/492
 [#506]: /../../pull/506
 
 

assets/conf.toml

@@ -77,3 +77,9 @@
 #
 # Default:
 #   version = "$(git describe --tags --dirty)"
+
+[windows]
+# Unique identifier of Windows application.
+#
+# Default:
+#   clsid = "00000000-0000-0000-0000-000000000000"

lib/config.dart

@@ -65,6 +65,9 @@ class Config {
   /// Version identifier of `User-Agent` header to put in network queries.
   static String userAgentVersion = '';
 
+  /// Unique identifier of Windows application.
+  static late String clsid;
+
   /// Initializes this [Config] by applying values from the following sources
   /// (in the following order):
   /// - default values;
@@ -119,6 +122,10 @@ class Config {
     userAgentVersion =
         version.isNotEmpty ? version : (Pubspec.ref ?? Pubspec.version);
 
+    clsid = const bool.hasEnvironment('SOCAPP_WINDOWS_CLSID')
+        ? const String.fromEnvironment('SOCAPP_WINDOWS_CLSID')
+        : (document['windows']?['clsid'] ?? '');
+
     origin = url;
 
     // Change default values to browser's location on web platform.

lib/domain/service/notification.dart

@@ -16,10 +16,15 @@
 // <https://www.gnu.org/licenses/agpl-3.0.html>.
 
 import 'dart:async';
+import 'dart:io';
 import 'dart:math';
 
+import 'package:flutter/foundation.dart';
 import 'package:flutter_local_notifications/flutter_local_notifications.dart';
+import 'package:win_toast/win_toast.dart';
+import 'package:window_manager/window_manager.dart';
 
+import '/config.dart';
 import '/routes.dart';
 import '/util/audio_utils.dart';
 import '/util/platform_utils.dart';
@@ -66,7 +71,30 @@ class NotificationService extends DisposableService {
       // user's interaction.
       WebUtils.onSelectNotification = onNotificationResponse;
     } else {
-      if (_plugin == null) {
+      if (PlatformUtils.isWindows) {
+        await WinToast.instance().initialize(
+          aumId: 'team113.messenger',
+          displayName: 'Gapopa',
+          iconPath: kDebugMode
+              ? File(r'assets\icons\app_icon.ico').absolute.path
+              : File(r'data\flutter_assets\assets\icons\app_icon.ico')
+                  .absolute
+                  .path,
+          clsid: Config.clsid,
+        );
+
+        WinToast.instance().setActivatedCallback((event) async {
+          await WindowManager.instance.focus();
+
+          onNotificationResponse?.call(
+            NotificationResponse(
+              notificationResponseType:
+                  NotificationResponseType.selectedNotification,
+              payload: event.argument.isEmpty ? null : event.argument,
+            ),
+          );
+        });
+      } else if (_plugin == null) {
         _plugin = FlutterLocalNotificationsPlugin();
         await _plugin!.initialize(
           InitializationSettings(
@@ -118,9 +146,29 @@ class NotificationService extends DisposableService {
         icon: icon,
         tag: tag,
       ).onError((_, __) => false);
-    } else if (!PlatformUtils.isWindows) {
-      // TODO: `flutter_local_notifications` should support Windows:
-      //       https://github.com/MaikuB/flutter_local_notifications/issues/746
+    } else if (PlatformUtils.isWindows) {
+      // TODO: Images should be downloaded to cache.
+      final File? file = await PlatformUtils.download(
+        icon!,
+        'notification_${DateTime.now().toString().replaceAll(':', '.')}.jpg',
+        null,
+        temporary: true,
+      );
+
+      await WinToast.instance().showCustomToast(
+        xml: '<?xml version="1.0" encoding="UTF-8"?>'
+            '<toast activationType="Foreground" launch="${payload ?? ''}">'
+            '  <visual addImageQuery="true">'
+            '      <binding template="ToastGeneric">'
+            '          <text>$title</text>'
+            '          <text>${body ?? ''}</text>'
+            '          <image placement="appLogoOverride" hint-crop="circle" id="1" src="${file?.path ?? ''}"/>'
+            '      </binding>'
+            '  </visual>'
+            '</toast>',
+        tag: 'Gapopa',
+      );
+    } else {
       await _plugin!.show(
         Random().nextInt(1 << 31),
         title,

lib/ui/page/home/page/chat/view.dart

@@ -609,7 +609,8 @@ class _ChatViewState extends State<ChatView>
             (previous is ChatForwardElement &&
                 previous.authorId == author &&
                 element.id.at.val.difference(previous.id.at.val).abs() <=
-                    const Duration(minutes: 5));
+                    const Duration(minutes: 5)) ||
+            previous is UnreadMessagesElement;
       }
     }
 

lib/ui/page/home/page/chat/widget/chat_forward.dart

@@ -518,17 +518,9 @@ class _ChatForwardWidgetState extends State<ChatForwardWidget> {
                       TextSpan(
                         children: [
                           if (text != null) text,
-                          const WidgetSpan(child: SizedBox(width: 4)),
-                          WidgetSpan(
-                            child: Opacity(
-                              opacity: 0,
-                              child: MessageTimestamp(
-                                at: quote.at,
-                                date: true,
-                                fontSize: style.fonts.labelSmall.fontSize,
-                              ),
-                            ),
-                          ),
+                          // TODO: Use transparent [MessageTimestamp]:
+                          //       https://github.com/flutter/flutter/issues/124787
+                          const WidgetSpan(child: SizedBox(width: 95)),
                         ],
                       ),
                       selectable: PlatformUtils.isDesktop || menu,

lib/ui/page/home/page/chat/widget/time_label.dart

@@ -44,29 +44,33 @@ class TimeLabelWidget extends StatelessWidget {
   Widget build(BuildContext context) {
     final Style style = Theme.of(context).extension<Style>()!;
 
-    return Padding(
-      padding: const EdgeInsets.symmetric(vertical: 12),
-      child: SwipeableStatus(
-        animation: animation,
-        padding: const EdgeInsets.only(right: 8),
-        crossAxisAlignment: CrossAxisAlignment.center,
-        swipeable: Padding(
-          padding: const EdgeInsets.only(right: 4),
-          child: Text(time.yyMd),
-        ),
-        child: AnimatedOpacity(
-          key: Key('$time'),
-          opacity: opacity,
-          duration: const Duration(milliseconds: 250),
-          child: Center(
-            child: Container(
-              padding: const EdgeInsets.symmetric(horizontal: 12, vertical: 8),
-              decoration: BoxDecoration(
-                borderRadius: BorderRadius.circular(15),
-                border: style.systemMessageBorder,
-                color: style.systemMessageColor,
+    return IgnorePointer(
+      ignoring: true,
+      child: Padding(
+        padding: const EdgeInsets.symmetric(vertical: 12),
+        child: SwipeableStatus(
+          animation: animation,
+          padding: const EdgeInsets.only(right: 8),
+          crossAxisAlignment: CrossAxisAlignment.center,
+          swipeable: Padding(
+            padding: const EdgeInsets.only(right: 4),
+            child: Text(time.yyMd),
+          ),
+          child: AnimatedOpacity(
+            key: Key('$time'),
+            opacity: opacity,
+            duration: const Duration(milliseconds: 250),
+            child: Center(
+              child: Container(
+                padding:
+                    const EdgeInsets.symmetric(horizontal: 12, vertical: 8),
+                decoration: BoxDecoration(
+                  borderRadius: BorderRadius.circular(15),
+                  border: style.systemMessageBorder,
+                  color: style.systemMessageColor,
+                ),
+                child: Text(time.toRelative(), style: style.systemMessageStyle),
               ),
-              child: Text(time.toRelative(), style: style.systemMessageStyle),
             ),
           ),
         ),

lib/util/platform_utils.dart

@@ -50,6 +50,9 @@ class PlatformUtilsImpl {
   /// Path to the downloads directory.
   String? _downloadDirectory;
 
+  /// Path to the temporary directory.
+  String? _temporaryDirectory;
+
   /// `User-Agent` header to put in the network requests.
   String? _userAgent;
 
@@ -272,6 +275,16 @@ class PlatformUtilsImpl {
   /// Indicates whether the application is in active state.
   Future<bool> get isActive async => _isActive && await isFocused;
 
+  /// Returns a path to the temporary directory.
+  Future<String> get temporaryDirectory async {
+    if (_temporaryDirectory != null) {
+      return _temporaryDirectory!;
+    }
+
+    _temporaryDirectory = (await getTemporaryDirectory()).path;
+    return _temporaryDirectory!;
+  }
+
   /// Enters fullscreen mode.
   Future<void> enterFullscreen() async {
     if (isWeb) {
@@ -314,13 +327,15 @@ class PlatformUtilsImpl {
     String filename, {
     int? size,
     String? url,
+    bool temporary = false,
   }) async {
     if ((size != null || url != null) && !PlatformUtils.isWeb) {
       size = size ??
           int.parse(((await (await dio).head(url!)).headers['content-length']
               as List<String>)[0]);
 
-      String downloads = await PlatformUtils.downloadsDirectory;
+      String downloads =
+          temporary ? await temporaryDirectory : await downloadsDirectory;
       String name = p.basenameWithoutExtension(filename);
       String ext = p.extension(filename);
       File file = File('$downloads/$filename');
@@ -345,6 +360,7 @@ class PlatformUtilsImpl {
     int? size, {
     Function(int count, int total)? onReceiveProgress,
     CancelToken? cancelToken,
+    bool temporary = false,
   }) async {
     dynamic completeWith;
 
@@ -378,7 +394,12 @@ class PlatformUtilsImpl {
           file = await Backoff.run(
             () async {
               try {
-                return await fileExists(filename, size: size, url: url);
+                return await fileExists(
+                  filename,
+                  size: size,
+                  url: url,
+                  temporary: temporary,
+                );
               } catch (e) {
                 onError(e);
               }
@@ -391,7 +412,8 @@ class PlatformUtilsImpl {
           if (file == null) {
             final String name = p.basenameWithoutExtension(filename);
             final String extension = p.extension(filename);
-            final String path = await downloadsDirectory;
+            final String path =
+                temporary ? await temporaryDirectory : await downloadsDirectory;
 
             file = File('$path/$filename');
             for (int i = 1; await file!.exists(); ++i) {

pubspec.lock

@@ -1972,6 +1972,14 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "1.1.1"
+  win_toast:
+    dependency: "direct main"
+    description:
+      name: win_toast
+      sha256: "371d62b17b30489cad41e831e6340c2777202d2b4b2fd55a14ffc566b3df7518"
+      url: "https://pub.dev"
+    source: hosted
+    version: "0.3.0"
   window_manager:
     dependency: "direct main"
     description:

pubspec.yaml

@@ -82,9 +82,10 @@ dependencies:
   vibration: ^1.7.7
   wakelock_plus: ^1.1.1
   web_socket_channel: ^2.4.0
+  win32: ^5.0.5
+  win_toast: ^0.3.0
   window_manager: ^0.3.5
   windows_taskbar: ^1.1.1
-  win32: ^5.0.5
 
 dev_dependencies:
   artemis: ^7.13.0-beta.1

test/e2e/mock/platform_utils.dart

@@ -34,6 +34,7 @@ class PlatformUtilsMock extends PlatformUtilsImpl {
     int? size, {
     Function(int count, int total)? onReceiveProgress,
     CancelToken? cancelToken,
+    bool temporary = false,
   }) async {
     int total = 100;
     for (int count = 0; count <= total; count++) {

test/mock/platform_utils.dart

@@ -24,7 +24,12 @@ import 'package:messenger/util/platform_utils.dart';
 /// Mocked [PlatformUtilsImpl] to use in the tests.
 class PlatformUtilsMock extends PlatformUtilsImpl {
   @override
-  Future<File?> fileExists(String filename, {int? size, String? url}) async {
+  Future<File?> fileExists(
+    String filename, {
+    int? size,
+    String? url,
+    bool temporary = false,
+  }) async {
     return null;
   }
 
@@ -35,6 +40,7 @@ class PlatformUtilsMock extends PlatformUtilsImpl {
     int? size, {
     Function(int count, int total)? onReceiveProgress,
     CancelToken? cancelToken,
+    bool temporary = false,
   }) async =>
       File('test/path');
 

windows/flutter/generated_plugin_registrant.cc

@@ -21,6 +21,7 @@
 #include <sentry_flutter/sentry_flutter_plugin.h>
 #include <share_plus/share_plus_windows_plugin_c_api.h>
 #include <url_launcher_windows/url_launcher_windows.h>
+#include <win_toast/win_toast_plugin.h>
 #include <window_manager/window_manager_plugin.h>
 #include <windows_taskbar/windows_taskbar_plugin.h>
 
@@ -55,6 +56,8 @@ void RegisterPlugins(flutter::PluginRegistry* registry) {
       registry->GetRegistrarForPlugin("SharePlusWindowsPluginCApi"));
   UrlLauncherWindowsRegisterWithRegistrar(
       registry->GetRegistrarForPlugin("UrlLauncherWindows"));
+  WinToastPluginRegisterWithRegistrar(
+      registry->GetRegistrarForPlugin("WinToastPlugin"));
   WindowManagerPluginRegisterWithRegistrar(
       registry->GetRegistrarForPlugin("WindowManagerPlugin"));
   WindowsTaskbarPluginRegisterWithRegistrar(

windows/flutter/generated_plugins.cmake

@@ -18,6 +18,7 @@ list(APPEND FLUTTER_PLUGIN_LIST
   sentry_flutter
   share_plus
   url_launcher_windows
+  win_toast
   window_manager
   windows_taskbar
 )