diff --git a/flutter_local_notifications/example/lib/main.dart b/flutter_local_notifications/example/lib/main.dart index 9252ba729..370955ebe 100644 --- a/flutter_local_notifications/example/lib/main.dart +++ b/flutter_local_notifications/example/lib/main.dart @@ -182,11 +182,17 @@ Future main() async { defaultActionName: 'Open notification', defaultIcon: AssetsLinuxIcon('icons/app_icon.png'), ); + const WindowsInitializationSettings initializationSettingsWindows = + WindowsInitializationSettings( + appName: 'Flutter Local Notifications Example', + appUserModelId: 'Com.Dexterous.FlutterLocalNotificationsExample', + ); final InitializationSettings initializationSettings = InitializationSettings( android: initializationSettingsAndroid, iOS: initializationSettingsIOS, macOS: initializationSettingsMacOS, linux: initializationSettingsLinux, + windows: initializationSettingsWindows, ); await flutterLocalNotificationsPlugin.initialize( initializationSettings, @@ -210,7 +216,7 @@ Future main() async { } Future _configureLocalTimeZone() async { - if (kIsWeb || Platform.isLinux) { + if (kIsWeb || Platform.isLinux || Platform.isWindows) { return; } tz.initializeTimeZones(); @@ -733,7 +739,7 @@ class _HomePageState extends State { onPressed: () async { await _stopForegroundService(); }, - ), + ), ], if (!kIsWeb && (Platform.isIOS || Platform.isMacOS)) ...[ @@ -913,6 +919,7 @@ class _HomePageState extends State { ); Future _showNotification() async { + print('show notification'); const AndroidNotificationDetails androidPlatformChannelSpecifics = AndroidNotificationDetails('your channel id', 'your channel name', channelDescription: 'your channel description', @@ -2153,8 +2160,6 @@ class _HomePageState extends State { ?.stopForegroundService(); } - - Future _createNotificationChannel() async { const AndroidNotificationChannel androidNotificationChannel = AndroidNotificationChannel( @@ -2417,7 +2422,8 @@ Future _showLinuxNotificationWithByteDataIcon() async { data: iconBytes, width: iconData.width, height: iconData.height, - channels: 4, // The icon has an alpha channel + channels: 4, + // The icon has an alpha channel hasAlpha: true, ), ), diff --git a/flutter_local_notifications/example/pubspec.yaml b/flutter_local_notifications/example/pubspec.yaml index bb5792d96..562f115b3 100644 --- a/flutter_local_notifications/example/pubspec.yaml +++ b/flutter_local_notifications/example/pubspec.yaml @@ -24,12 +24,7 @@ dev_dependencies: sdk: flutter integration_test: sdk: flutter - -dependency_overrides: - flutter_local_notifications_platform_interface: - path: ../../flutter_local_notifications_platform_interface/ - flutter_local_notifications_linux: - path: ../../flutter_local_notifications_linux/ + msix: ^2.8.17 flutter: uses-material-design: true @@ -40,3 +35,8 @@ flutter: environment: sdk: '>=2.12.0-0 <3.0.0' flutter: '>=1.26.0-0' # allows for using integration_test from SDK + +msix_config: + display_name: Flutter Local Notifications Example + identity_name: Com.Example.FlutterLocalNotificationsExample + debug: true diff --git a/flutter_local_notifications/example/windows/.gitignore b/flutter_local_notifications/example/windows/.gitignore new file mode 100644 index 000000000..571c3131e --- /dev/null +++ b/flutter_local_notifications/example/windows/.gitignore @@ -0,0 +1,21 @@ +flutter/ephemeral/ + +# Visual Studio user-specific files. +*.suo +*.user +*.userosscache +*.sln.docstates + +# Visual Studio build-related files. +x64/ +x86/ + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!*.[Cc]ache/ + +.vs +out +flutter/ephemeral diff --git a/flutter_local_notifications/example/windows/CMakeLists.txt b/flutter_local_notifications/example/windows/CMakeLists.txt new file mode 100644 index 000000000..1633297a0 --- /dev/null +++ b/flutter_local_notifications/example/windows/CMakeLists.txt @@ -0,0 +1,95 @@ +cmake_minimum_required(VERSION 3.14) +project(example LANGUAGES CXX) + +set(BINARY_NAME "example") + +cmake_policy(SET CMP0063 NEW) + +set(CMAKE_INSTALL_RPATH "$ORIGIN/lib") + +# Configure build options. +get_property(IS_MULTICONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG) +if(IS_MULTICONFIG) + set(CMAKE_CONFIGURATION_TYPES "Debug;Profile;Release" + CACHE STRING "" FORCE) +else() + if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) + set(CMAKE_BUILD_TYPE "Debug" CACHE + STRING "Flutter build mode" FORCE) + set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS + "Debug" "Profile" "Release") + endif() +endif() + +set(CMAKE_EXE_LINKER_FLAGS_PROFILE "${CMAKE_EXE_LINKER_FLAGS_RELEASE}") +set(CMAKE_SHARED_LINKER_FLAGS_PROFILE "${CMAKE_SHARED_LINKER_FLAGS_RELEASE}") +set(CMAKE_C_FLAGS_PROFILE "${CMAKE_C_FLAGS_RELEASE}") +set(CMAKE_CXX_FLAGS_PROFILE "${CMAKE_CXX_FLAGS_RELEASE}") + +# Use Unicode for all projects. +add_definitions(-DUNICODE -D_UNICODE) + +# Compilation settings that should be applied to most targets. +function(APPLY_STANDARD_SETTINGS TARGET) + target_compile_features(${TARGET} PUBLIC cxx_std_17) + target_compile_options(${TARGET} PRIVATE /W4 /WX /wd"4100") + target_compile_options(${TARGET} PRIVATE /EHsc) + target_compile_definitions(${TARGET} PRIVATE "_HAS_EXCEPTIONS=0") + target_compile_definitions(${TARGET} PRIVATE "$<$:_DEBUG>") +endfunction() + +set(FLUTTER_MANAGED_DIR "${CMAKE_CURRENT_SOURCE_DIR}/flutter") + +# Flutter library and tool build rules. +add_subdirectory(${FLUTTER_MANAGED_DIR}) + +# Application build +add_subdirectory("runner") + +# Generated plugin build rules, which manage building the plugins and adding +# them to the application. +include(flutter/generated_plugins.cmake) + + +# === Installation === +# Support files are copied into place next to the executable, so that it can +# run in place. This is done instead of making a separate bundle (as on Linux) +# so that building and running from within Visual Studio will work. +set(BUILD_BUNDLE_DIR "$") +# Make the "install" step default, as it's required to run. +set(CMAKE_VS_INCLUDE_INSTALL_TO_DEFAULT_BUILD 1) +if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) + set(CMAKE_INSTALL_PREFIX "${BUILD_BUNDLE_DIR}" CACHE PATH "..." FORCE) +endif() + +set(INSTALL_BUNDLE_DATA_DIR "${CMAKE_INSTALL_PREFIX}/data") +set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}") + +install(TARGETS ${BINARY_NAME} RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_ICU_DATA_FILE}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) + +if(PLUGIN_BUNDLED_LIBRARIES) + install(FILES "${PLUGIN_BUNDLED_LIBRARIES}" + DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) +endif() + +# Fully re-copy the assets directory on each build to avoid having stale files +# from a previous install. +set(FLUTTER_ASSET_DIR_NAME "flutter_assets") +install(CODE " + file(REMOVE_RECURSE \"${INSTALL_BUNDLE_DATA_DIR}/${FLUTTER_ASSET_DIR_NAME}\") + " COMPONENT Runtime) +install(DIRECTORY "${PROJECT_BUILD_DIR}/${FLUTTER_ASSET_DIR_NAME}" + DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" COMPONENT Runtime) + +# Install the AOT library on non-Debug builds only. +install(FILES "${AOT_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" + CONFIGURATIONS Profile;Release + COMPONENT Runtime) diff --git a/flutter_local_notifications/example/windows/flutter/CMakeLists.txt b/flutter_local_notifications/example/windows/flutter/CMakeLists.txt new file mode 100644 index 000000000..b2e4bd8d6 --- /dev/null +++ b/flutter_local_notifications/example/windows/flutter/CMakeLists.txt @@ -0,0 +1,103 @@ +cmake_minimum_required(VERSION 3.14) + +set(EPHEMERAL_DIR "${CMAKE_CURRENT_SOURCE_DIR}/ephemeral") + +# Configuration provided via flutter tool. +include(${EPHEMERAL_DIR}/generated_config.cmake) + +# TODO: Move the rest of this into files in ephemeral. See +# https://github.com/flutter/flutter/issues/57146. +set(WRAPPER_ROOT "${EPHEMERAL_DIR}/cpp_client_wrapper") + +# === Flutter Library === +set(FLUTTER_LIBRARY "${EPHEMERAL_DIR}/flutter_windows.dll") + +# Published to parent scope for install step. +set(FLUTTER_LIBRARY ${FLUTTER_LIBRARY} PARENT_SCOPE) +set(FLUTTER_ICU_DATA_FILE "${EPHEMERAL_DIR}/icudtl.dat" PARENT_SCOPE) +set(PROJECT_BUILD_DIR "${PROJECT_DIR}/build/" PARENT_SCOPE) +set(AOT_LIBRARY "${PROJECT_DIR}/build/windows/app.so" PARENT_SCOPE) + +list(APPEND FLUTTER_LIBRARY_HEADERS + "flutter_export.h" + "flutter_windows.h" + "flutter_messenger.h" + "flutter_plugin_registrar.h" + "flutter_texture_registrar.h" +) +list(TRANSFORM FLUTTER_LIBRARY_HEADERS PREPEND "${EPHEMERAL_DIR}/") +add_library(flutter INTERFACE) +target_include_directories(flutter INTERFACE + "${EPHEMERAL_DIR}" +) +target_link_libraries(flutter INTERFACE "${FLUTTER_LIBRARY}.lib") +add_dependencies(flutter flutter_assemble) + +# === Wrapper === +list(APPEND CPP_WRAPPER_SOURCES_CORE + "core_implementations.cc" + "standard_codec.cc" +) +list(TRANSFORM CPP_WRAPPER_SOURCES_CORE PREPEND "${WRAPPER_ROOT}/") +list(APPEND CPP_WRAPPER_SOURCES_PLUGIN + "plugin_registrar.cc" +) +list(TRANSFORM CPP_WRAPPER_SOURCES_PLUGIN PREPEND "${WRAPPER_ROOT}/") +list(APPEND CPP_WRAPPER_SOURCES_APP + "flutter_engine.cc" + "flutter_view_controller.cc" +) +list(TRANSFORM CPP_WRAPPER_SOURCES_APP PREPEND "${WRAPPER_ROOT}/") + +# Wrapper sources needed for a plugin. +add_library(flutter_wrapper_plugin STATIC + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_PLUGIN} +) +apply_standard_settings(flutter_wrapper_plugin) +set_target_properties(flutter_wrapper_plugin PROPERTIES + POSITION_INDEPENDENT_CODE ON) +set_target_properties(flutter_wrapper_plugin PROPERTIES + CXX_VISIBILITY_PRESET hidden) +target_link_libraries(flutter_wrapper_plugin PUBLIC flutter) +target_include_directories(flutter_wrapper_plugin PUBLIC + "${WRAPPER_ROOT}/include" +) +add_dependencies(flutter_wrapper_plugin flutter_assemble) + +# Wrapper sources needed for the runner. +add_library(flutter_wrapper_app STATIC + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_APP} +) +apply_standard_settings(flutter_wrapper_app) +target_link_libraries(flutter_wrapper_app PUBLIC flutter) +target_include_directories(flutter_wrapper_app PUBLIC + "${WRAPPER_ROOT}/include" +) +add_dependencies(flutter_wrapper_app flutter_assemble) + +# === Flutter tool backend === +# _phony_ is a non-existent file to force this command to run every time, +# since currently there's no way to get a full input/output list from the +# flutter tool. +set(PHONY_OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/_phony_") +set_source_files_properties("${PHONY_OUTPUT}" PROPERTIES SYMBOLIC TRUE) +add_custom_command( + OUTPUT ${FLUTTER_LIBRARY} ${FLUTTER_LIBRARY_HEADERS} + ${CPP_WRAPPER_SOURCES_CORE} ${CPP_WRAPPER_SOURCES_PLUGIN} + ${CPP_WRAPPER_SOURCES_APP} + ${PHONY_OUTPUT} + COMMAND ${CMAKE_COMMAND} -E env + ${FLUTTER_TOOL_ENVIRONMENT} + "${FLUTTER_ROOT}/packages/flutter_tools/bin/tool_backend.bat" + windows-x64 $ + VERBATIM +) +add_custom_target(flutter_assemble DEPENDS + "${FLUTTER_LIBRARY}" + ${FLUTTER_LIBRARY_HEADERS} + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_PLUGIN} + ${CPP_WRAPPER_SOURCES_APP} +) diff --git a/flutter_local_notifications/example/windows/flutter/generated_plugin_registrant.cc b/flutter_local_notifications/example/windows/flutter/generated_plugin_registrant.cc new file mode 100644 index 000000000..d5a662fbd --- /dev/null +++ b/flutter_local_notifications/example/windows/flutter/generated_plugin_registrant.cc @@ -0,0 +1,17 @@ +// +// Generated file. Do not edit. +// + +// clang-format off + +#include "generated_plugin_registrant.h" + +#include +#include + +void RegisterPlugins(flutter::PluginRegistry* registry) { + FlutterLocalNotificationsPluginRegisterWithRegistrar( + registry->GetRegistrarForPlugin("FlutterLocalNotificationsPlugin")); + UrlLauncherWindowsRegisterWithRegistrar( + registry->GetRegistrarForPlugin("UrlLauncherWindows")); +} diff --git a/flutter_local_notifications/example/windows/flutter/generated_plugin_registrant.h b/flutter_local_notifications/example/windows/flutter/generated_plugin_registrant.h new file mode 100644 index 000000000..dc139d85a --- /dev/null +++ b/flutter_local_notifications/example/windows/flutter/generated_plugin_registrant.h @@ -0,0 +1,15 @@ +// +// Generated file. Do not edit. +// + +// clang-format off + +#ifndef GENERATED_PLUGIN_REGISTRANT_ +#define GENERATED_PLUGIN_REGISTRANT_ + +#include + +// Registers Flutter plugins. +void RegisterPlugins(flutter::PluginRegistry* registry); + +#endif // GENERATED_PLUGIN_REGISTRANT_ diff --git a/flutter_local_notifications/example/windows/flutter/generated_plugins.cmake b/flutter_local_notifications/example/windows/flutter/generated_plugins.cmake new file mode 100644 index 000000000..41753c0a3 --- /dev/null +++ b/flutter_local_notifications/example/windows/flutter/generated_plugins.cmake @@ -0,0 +1,17 @@ +# +# Generated file, do not edit. +# + +list(APPEND FLUTTER_PLUGIN_LIST + flutter_local_notifications + url_launcher_windows +) + +set(PLUGIN_BUNDLED_LIBRARIES) + +foreach(plugin ${FLUTTER_PLUGIN_LIST}) + add_subdirectory(flutter/ephemeral/.plugin_symlinks/${plugin}/windows plugins/${plugin}) + target_link_libraries(${BINARY_NAME} PRIVATE ${plugin}_plugin) + list(APPEND PLUGIN_BUNDLED_LIBRARIES $) + list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${plugin}_bundled_libraries}) +endforeach(plugin) diff --git a/flutter_local_notifications/example/windows/runner/CMakeLists.txt b/flutter_local_notifications/example/windows/runner/CMakeLists.txt new file mode 100644 index 000000000..de2d8916b --- /dev/null +++ b/flutter_local_notifications/example/windows/runner/CMakeLists.txt @@ -0,0 +1,17 @@ +cmake_minimum_required(VERSION 3.14) +project(runner LANGUAGES CXX) + +add_executable(${BINARY_NAME} WIN32 + "flutter_window.cpp" + "main.cpp" + "utils.cpp" + "win32_window.cpp" + "${FLUTTER_MANAGED_DIR}/generated_plugin_registrant.cc" + "Runner.rc" + "runner.exe.manifest" +) +apply_standard_settings(${BINARY_NAME}) +target_compile_definitions(${BINARY_NAME} PRIVATE "NOMINMAX") +target_link_libraries(${BINARY_NAME} PRIVATE flutter flutter_wrapper_app) +target_include_directories(${BINARY_NAME} PRIVATE "${CMAKE_SOURCE_DIR}") +add_dependencies(${BINARY_NAME} flutter_assemble) diff --git a/flutter_local_notifications/example/windows/runner/RCa04060 b/flutter_local_notifications/example/windows/runner/RCa04060 new file mode 100644 index 000000000..a890c5b8c Binary files /dev/null and b/flutter_local_notifications/example/windows/runner/RCa04060 differ diff --git a/flutter_local_notifications/example/windows/runner/RCb04060 b/flutter_local_notifications/example/windows/runner/RCb04060 new file mode 100644 index 000000000..a890c5b8c Binary files /dev/null and b/flutter_local_notifications/example/windows/runner/RCb04060 differ diff --git a/flutter_local_notifications/example/windows/runner/Runner.rc b/flutter_local_notifications/example/windows/runner/Runner.rc new file mode 100644 index 000000000..81d27749b --- /dev/null +++ b/flutter_local_notifications/example/windows/runner/Runner.rc @@ -0,0 +1,121 @@ +// Microsoft Visual C++ generated resource script. +// +#pragma code_page(65001) +#include "resource.h" + +#define APSTUDIO_READONLY_SYMBOLS +///////////////////////////////////////////////////////////////////////////// +// +// Generated from the TEXTINCLUDE 2 resource. +// +#include "winres.h" + +///////////////////////////////////////////////////////////////////////////// +#undef APSTUDIO_READONLY_SYMBOLS + +///////////////////////////////////////////////////////////////////////////// +// English (United States) resources + +#if !defined(AFX_RESOURCE_DLL) || defined(AFX_TARG_ENU) +LANGUAGE LANG_ENGLISH, SUBLANG_ENGLISH_US + +#ifdef APSTUDIO_INVOKED +///////////////////////////////////////////////////////////////////////////// +// +// TEXTINCLUDE +// + +1 TEXTINCLUDE +BEGIN + "resource.h\0" +END + +2 TEXTINCLUDE +BEGIN + "#include ""winres.h""\r\n" + "\0" +END + +3 TEXTINCLUDE +BEGIN + "\r\n" + "\0" +END + +#endif // APSTUDIO_INVOKED + + +///////////////////////////////////////////////////////////////////////////// +// +// Icon +// + +// Icon with lowest ID value placed first to ensure application icon +// remains consistent on all systems. +IDI_APP_ICON ICON "resources\\app_icon.ico" + + +///////////////////////////////////////////////////////////////////////////// +// +// Version +// + +#ifdef FLUTTER_BUILD_NUMBER +#define VERSION_AS_NUMBER FLUTTER_BUILD_NUMBER +#else +#define VERSION_AS_NUMBER 1,0,0 +#endif + +#ifdef FLUTTER_BUILD_NAME +#define VERSION_AS_STRING #FLUTTER_BUILD_NAME +#else +#define VERSION_AS_STRING "1.0.0" +#endif + +VS_VERSION_INFO VERSIONINFO + FILEVERSION VERSION_AS_NUMBER + PRODUCTVERSION VERSION_AS_NUMBER + FILEFLAGSMASK VS_FFI_FILEFLAGSMASK +#ifdef _DEBUG + FILEFLAGS VS_FF_DEBUG +#else + FILEFLAGS 0x0L +#endif + FILEOS VOS__WINDOWS32 + FILETYPE VFT_APP + FILESUBTYPE 0x0L +BEGIN + BLOCK "StringFileInfo" + BEGIN + BLOCK "040904e4" + BEGIN + VALUE "CompanyName", "com.dexterous" "\0" + VALUE "FileDescription", "example" "\0" + VALUE "FileVersion", VERSION_AS_STRING "\0" + VALUE "InternalName", "example" "\0" + VALUE "LegalCopyright", "Copyright (C) 2022 com.dexterous. All rights reserved." "\0" + VALUE "OriginalFilename", "example.exe" "\0" + VALUE "ProductName", "example" "\0" + VALUE "ProductVersion", VERSION_AS_STRING "\0" + END + END + BLOCK "VarFileInfo" + BEGIN + VALUE "Translation", 0x409, 1252 + END +END + +#endif // English (United States) resources +///////////////////////////////////////////////////////////////////////////// + + + +#ifndef APSTUDIO_INVOKED +///////////////////////////////////////////////////////////////////////////// +// +// Generated from the TEXTINCLUDE 3 resource. +// + + +///////////////////////////////////////////////////////////////////////////// +#endif // not APSTUDIO_INVOKED diff --git a/flutter_local_notifications/example/windows/runner/flutter_window.cpp b/flutter_local_notifications/example/windows/runner/flutter_window.cpp new file mode 100644 index 000000000..b43b9095e --- /dev/null +++ b/flutter_local_notifications/example/windows/runner/flutter_window.cpp @@ -0,0 +1,61 @@ +#include "flutter_window.h" + +#include + +#include "flutter/generated_plugin_registrant.h" + +FlutterWindow::FlutterWindow(const flutter::DartProject& project) + : project_(project) {} + +FlutterWindow::~FlutterWindow() {} + +bool FlutterWindow::OnCreate() { + if (!Win32Window::OnCreate()) { + return false; + } + + RECT frame = GetClientArea(); + + // The size here must match the window dimensions to avoid unnecessary surface + // creation / destruction in the startup path. + flutter_controller_ = std::make_unique( + frame.right - frame.left, frame.bottom - frame.top, project_); + // Ensure that basic setup of the controller was successful. + if (!flutter_controller_->engine() || !flutter_controller_->view()) { + return false; + } + RegisterPlugins(flutter_controller_->engine()); + SetChildContent(flutter_controller_->view()->GetNativeWindow()); + return true; +} + +void FlutterWindow::OnDestroy() { + if (flutter_controller_) { + flutter_controller_ = nullptr; + } + + Win32Window::OnDestroy(); +} + +LRESULT +FlutterWindow::MessageHandler(HWND hwnd, UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + // Give Flutter, including plugins, an opportunity to handle window messages. + if (flutter_controller_) { + std::optional result = + flutter_controller_->HandleTopLevelWindowProc(hwnd, message, wparam, + lparam); + if (result) { + return *result; + } + } + + switch (message) { + case WM_FONTCHANGE: + flutter_controller_->engine()->ReloadSystemFonts(); + break; + } + + return Win32Window::MessageHandler(hwnd, message, wparam, lparam); +} diff --git a/flutter_local_notifications/example/windows/runner/flutter_window.h b/flutter_local_notifications/example/windows/runner/flutter_window.h new file mode 100644 index 000000000..6da0652f0 --- /dev/null +++ b/flutter_local_notifications/example/windows/runner/flutter_window.h @@ -0,0 +1,33 @@ +#ifndef RUNNER_FLUTTER_WINDOW_H_ +#define RUNNER_FLUTTER_WINDOW_H_ + +#include +#include + +#include + +#include "win32_window.h" + +// A window that does nothing but host a Flutter view. +class FlutterWindow : public Win32Window { + public: + // Creates a new FlutterWindow hosting a Flutter view running |project|. + explicit FlutterWindow(const flutter::DartProject& project); + virtual ~FlutterWindow(); + + protected: + // Win32Window: + bool OnCreate() override; + void OnDestroy() override; + LRESULT MessageHandler(HWND window, UINT const message, WPARAM const wparam, + LPARAM const lparam) noexcept override; + + private: + // The project to run. + flutter::DartProject project_; + + // The Flutter instance hosted by this window. + std::unique_ptr flutter_controller_; +}; + +#endif // RUNNER_FLUTTER_WINDOW_H_ diff --git a/flutter_local_notifications/example/windows/runner/main.cpp b/flutter_local_notifications/example/windows/runner/main.cpp new file mode 100644 index 000000000..87602243e --- /dev/null +++ b/flutter_local_notifications/example/windows/runner/main.cpp @@ -0,0 +1,44 @@ +#include +#include +#include +#include + +#include "flutter_window.h" +#include "utils.h" + +int APIENTRY wWinMain(_In_ HINSTANCE instance, _In_opt_ HINSTANCE prev, + _In_ wchar_t *command_line, _In_ int show_command) { + // Attach to console when present (e.g., 'flutter run') or create a + // new console when running with a debugger. + if (!::AttachConsole(ATTACH_PARENT_PROCESS) && ::IsDebuggerPresent()) { + CreateAndAttachConsole(); + } + + // Initialize COM, so that it is available for use in the library and/or + // plugins. + ::CoInitializeEx(nullptr, COINIT_APARTMENTTHREADED); + + flutter::DartProject project(L"data"); + + std::vector command_line_arguments = + GetCommandLineArguments(); + + project.set_dart_entrypoint_arguments(std::move(command_line_arguments)); + + FlutterWindow window(project); + Win32Window::Point origin(10, 10); + Win32Window::Size size(1280, 720); + if (!window.CreateAndShow(L"example", origin, size)) { + return EXIT_FAILURE; + } + window.SetQuitOnClose(true); + + ::MSG msg; + while (::GetMessage(&msg, nullptr, 0, 0)) { + ::TranslateMessage(&msg); + ::DispatchMessage(&msg); + } + + ::CoUninitialize(); + return EXIT_SUCCESS; +} diff --git a/flutter_local_notifications/example/windows/runner/resource.h b/flutter_local_notifications/example/windows/runner/resource.h new file mode 100644 index 000000000..66a65d1e4 --- /dev/null +++ b/flutter_local_notifications/example/windows/runner/resource.h @@ -0,0 +1,16 @@ +//{{NO_DEPENDENCIES}} +// Microsoft Visual C++ generated include file. +// Used by Runner.rc +// +#define IDI_APP_ICON 101 + +// Next default values for new objects +// +#ifdef APSTUDIO_INVOKED +#ifndef APSTUDIO_READONLY_SYMBOLS +#define _APS_NEXT_RESOURCE_VALUE 102 +#define _APS_NEXT_COMMAND_VALUE 40001 +#define _APS_NEXT_CONTROL_VALUE 1001 +#define _APS_NEXT_SYMED_VALUE 101 +#endif +#endif diff --git a/flutter_local_notifications/example/windows/runner/resources/app_icon.ico b/flutter_local_notifications/example/windows/runner/resources/app_icon.ico new file mode 100644 index 000000000..c04e20caf Binary files /dev/null and b/flutter_local_notifications/example/windows/runner/resources/app_icon.ico differ diff --git a/flutter_local_notifications/example/windows/runner/runner.exe.manifest b/flutter_local_notifications/example/windows/runner/runner.exe.manifest new file mode 100644 index 000000000..c977c4a42 --- /dev/null +++ b/flutter_local_notifications/example/windows/runner/runner.exe.manifest @@ -0,0 +1,20 @@ + + + + + PerMonitorV2 + + + + + + + + + + + + + + + diff --git a/flutter_local_notifications/example/windows/runner/utils.cpp b/flutter_local_notifications/example/windows/runner/utils.cpp new file mode 100644 index 000000000..d19bdbbcc --- /dev/null +++ b/flutter_local_notifications/example/windows/runner/utils.cpp @@ -0,0 +1,64 @@ +#include "utils.h" + +#include +#include +#include +#include + +#include + +void CreateAndAttachConsole() { + if (::AllocConsole()) { + FILE *unused; + if (freopen_s(&unused, "CONOUT$", "w", stdout)) { + _dup2(_fileno(stdout), 1); + } + if (freopen_s(&unused, "CONOUT$", "w", stderr)) { + _dup2(_fileno(stdout), 2); + } + std::ios::sync_with_stdio(); + FlutterDesktopResyncOutputStreams(); + } +} + +std::vector GetCommandLineArguments() { + // Convert the UTF-16 command line arguments to UTF-8 for the Engine to use. + int argc; + wchar_t** argv = ::CommandLineToArgvW(::GetCommandLineW(), &argc); + if (argv == nullptr) { + return std::vector(); + } + + std::vector command_line_arguments; + + // Skip the first argument as it's the binary name. + for (int i = 1; i < argc; i++) { + command_line_arguments.push_back(Utf8FromUtf16(argv[i])); + } + + ::LocalFree(argv); + + return command_line_arguments; +} + +std::string Utf8FromUtf16(const wchar_t* utf16_string) { + if (utf16_string == nullptr) { + return std::string(); + } + int target_length = ::WideCharToMultiByte( + CP_UTF8, WC_ERR_INVALID_CHARS, utf16_string, + -1, nullptr, 0, nullptr, nullptr); + if (target_length == 0) { + return std::string(); + } + std::string utf8_string; + utf8_string.resize(target_length); + int converted_length = ::WideCharToMultiByte( + CP_UTF8, WC_ERR_INVALID_CHARS, utf16_string, + -1, utf8_string.data(), + target_length, nullptr, nullptr); + if (converted_length == 0) { + return std::string(); + } + return utf8_string; +} diff --git a/flutter_local_notifications/example/windows/runner/utils.h b/flutter_local_notifications/example/windows/runner/utils.h new file mode 100644 index 000000000..3879d5475 --- /dev/null +++ b/flutter_local_notifications/example/windows/runner/utils.h @@ -0,0 +1,19 @@ +#ifndef RUNNER_UTILS_H_ +#define RUNNER_UTILS_H_ + +#include +#include + +// Creates a console for the process, and redirects stdout and stderr to +// it for both the runner and the Flutter library. +void CreateAndAttachConsole(); + +// Takes a null-terminated wchar_t* encoded in UTF-16 and returns a std::string +// encoded in UTF-8. Returns an empty std::string on failure. +std::string Utf8FromUtf16(const wchar_t* utf16_string); + +// Gets the command line arguments passed in as a std::vector, +// encoded in UTF-8. Returns an empty std::vector on failure. +std::vector GetCommandLineArguments(); + +#endif // RUNNER_UTILS_H_ diff --git a/flutter_local_notifications/example/windows/runner/win32_window.cpp b/flutter_local_notifications/example/windows/runner/win32_window.cpp new file mode 100644 index 000000000..c10f08dc7 --- /dev/null +++ b/flutter_local_notifications/example/windows/runner/win32_window.cpp @@ -0,0 +1,245 @@ +#include "win32_window.h" + +#include + +#include "resource.h" + +namespace { + +constexpr const wchar_t kWindowClassName[] = L"FLUTTER_RUNNER_WIN32_WINDOW"; + +// The number of Win32Window objects that currently exist. +static int g_active_window_count = 0; + +using EnableNonClientDpiScaling = BOOL __stdcall(HWND hwnd); + +// Scale helper to convert logical scaler values to physical using passed in +// scale factor +int Scale(int source, double scale_factor) { + return static_cast(source * scale_factor); +} + +// Dynamically loads the |EnableNonClientDpiScaling| from the User32 module. +// This API is only needed for PerMonitor V1 awareness mode. +void EnableFullDpiSupportIfAvailable(HWND hwnd) { + HMODULE user32_module = LoadLibraryA("User32.dll"); + if (!user32_module) { + return; + } + auto enable_non_client_dpi_scaling = + reinterpret_cast( + GetProcAddress(user32_module, "EnableNonClientDpiScaling")); + if (enable_non_client_dpi_scaling != nullptr) { + enable_non_client_dpi_scaling(hwnd); + FreeLibrary(user32_module); + } +} + +} // namespace + +// Manages the Win32Window's window class registration. +class WindowClassRegistrar { + public: + ~WindowClassRegistrar() = default; + + // Returns the singleton registar instance. + static WindowClassRegistrar* GetInstance() { + if (!instance_) { + instance_ = new WindowClassRegistrar(); + } + return instance_; + } + + // Returns the name of the window class, registering the class if it hasn't + // previously been registered. + const wchar_t* GetWindowClass(); + + // Unregisters the window class. Should only be called if there are no + // instances of the window. + void UnregisterWindowClass(); + + private: + WindowClassRegistrar() = default; + + static WindowClassRegistrar* instance_; + + bool class_registered_ = false; +}; + +WindowClassRegistrar* WindowClassRegistrar::instance_ = nullptr; + +const wchar_t* WindowClassRegistrar::GetWindowClass() { + if (!class_registered_) { + WNDCLASS window_class{}; + window_class.hCursor = LoadCursor(nullptr, IDC_ARROW); + window_class.lpszClassName = kWindowClassName; + window_class.style = CS_HREDRAW | CS_VREDRAW; + window_class.cbClsExtra = 0; + window_class.cbWndExtra = 0; + window_class.hInstance = GetModuleHandle(nullptr); + window_class.hIcon = + LoadIcon(window_class.hInstance, MAKEINTRESOURCE(IDI_APP_ICON)); + window_class.hbrBackground = 0; + window_class.lpszMenuName = nullptr; + window_class.lpfnWndProc = Win32Window::WndProc; + RegisterClass(&window_class); + class_registered_ = true; + } + return kWindowClassName; +} + +void WindowClassRegistrar::UnregisterWindowClass() { + UnregisterClass(kWindowClassName, nullptr); + class_registered_ = false; +} + +Win32Window::Win32Window() { + ++g_active_window_count; +} + +Win32Window::~Win32Window() { + --g_active_window_count; + Destroy(); +} + +bool Win32Window::CreateAndShow(const std::wstring& title, + const Point& origin, + const Size& size) { + Destroy(); + + const wchar_t* window_class = + WindowClassRegistrar::GetInstance()->GetWindowClass(); + + const POINT target_point = {static_cast(origin.x), + static_cast(origin.y)}; + HMONITOR monitor = MonitorFromPoint(target_point, MONITOR_DEFAULTTONEAREST); + UINT dpi = FlutterDesktopGetDpiForMonitor(monitor); + double scale_factor = dpi / 96.0; + + HWND window = CreateWindow( + window_class, title.c_str(), WS_OVERLAPPEDWINDOW | WS_VISIBLE, + Scale(origin.x, scale_factor), Scale(origin.y, scale_factor), + Scale(size.width, scale_factor), Scale(size.height, scale_factor), + nullptr, nullptr, GetModuleHandle(nullptr), this); + + if (!window) { + return false; + } + + return OnCreate(); +} + +// static +LRESULT CALLBACK Win32Window::WndProc(HWND const window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + if (message == WM_NCCREATE) { + auto window_struct = reinterpret_cast(lparam); + SetWindowLongPtr(window, GWLP_USERDATA, + reinterpret_cast(window_struct->lpCreateParams)); + + auto that = static_cast(window_struct->lpCreateParams); + EnableFullDpiSupportIfAvailable(window); + that->window_handle_ = window; + } else if (Win32Window* that = GetThisFromHandle(window)) { + return that->MessageHandler(window, message, wparam, lparam); + } + + return DefWindowProc(window, message, wparam, lparam); +} + +LRESULT +Win32Window::MessageHandler(HWND hwnd, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + switch (message) { + case WM_DESTROY: + window_handle_ = nullptr; + Destroy(); + if (quit_on_close_) { + PostQuitMessage(0); + } + return 0; + + case WM_DPICHANGED: { + auto newRectSize = reinterpret_cast(lparam); + LONG newWidth = newRectSize->right - newRectSize->left; + LONG newHeight = newRectSize->bottom - newRectSize->top; + + SetWindowPos(hwnd, nullptr, newRectSize->left, newRectSize->top, newWidth, + newHeight, SWP_NOZORDER | SWP_NOACTIVATE); + + return 0; + } + case WM_SIZE: { + RECT rect = GetClientArea(); + if (child_content_ != nullptr) { + // Size and position the child window. + MoveWindow(child_content_, rect.left, rect.top, rect.right - rect.left, + rect.bottom - rect.top, TRUE); + } + return 0; + } + + case WM_ACTIVATE: + if (child_content_ != nullptr) { + SetFocus(child_content_); + } + return 0; + } + + return DefWindowProc(window_handle_, message, wparam, lparam); +} + +void Win32Window::Destroy() { + OnDestroy(); + + if (window_handle_) { + DestroyWindow(window_handle_); + window_handle_ = nullptr; + } + if (g_active_window_count == 0) { + WindowClassRegistrar::GetInstance()->UnregisterWindowClass(); + } +} + +Win32Window* Win32Window::GetThisFromHandle(HWND const window) noexcept { + return reinterpret_cast( + GetWindowLongPtr(window, GWLP_USERDATA)); +} + +void Win32Window::SetChildContent(HWND content) { + child_content_ = content; + SetParent(content, window_handle_); + RECT frame = GetClientArea(); + + MoveWindow(content, frame.left, frame.top, frame.right - frame.left, + frame.bottom - frame.top, true); + + SetFocus(child_content_); +} + +RECT Win32Window::GetClientArea() { + RECT frame; + GetClientRect(window_handle_, &frame); + return frame; +} + +HWND Win32Window::GetHandle() { + return window_handle_; +} + +void Win32Window::SetQuitOnClose(bool quit_on_close) { + quit_on_close_ = quit_on_close; +} + +bool Win32Window::OnCreate() { + // No-op; provided for subclasses. + return true; +} + +void Win32Window::OnDestroy() { + // No-op; provided for subclasses. +} diff --git a/flutter_local_notifications/example/windows/runner/win32_window.h b/flutter_local_notifications/example/windows/runner/win32_window.h new file mode 100644 index 000000000..17ba43112 --- /dev/null +++ b/flutter_local_notifications/example/windows/runner/win32_window.h @@ -0,0 +1,98 @@ +#ifndef RUNNER_WIN32_WINDOW_H_ +#define RUNNER_WIN32_WINDOW_H_ + +#include + +#include +#include +#include + +// A class abstraction for a high DPI-aware Win32 Window. Intended to be +// inherited from by classes that wish to specialize with custom +// rendering and input handling +class Win32Window { + public: + struct Point { + unsigned int x; + unsigned int y; + Point(unsigned int x, unsigned int y) : x(x), y(y) {} + }; + + struct Size { + unsigned int width; + unsigned int height; + Size(unsigned int width, unsigned int height) + : width(width), height(height) {} + }; + + Win32Window(); + virtual ~Win32Window(); + + // Creates and shows a win32 window with |title| and position and size using + // |origin| and |size|. New windows are created on the default monitor. Window + // sizes are specified to the OS in physical pixels, hence to ensure a + // consistent size to will treat the width height passed in to this function + // as logical pixels and scale to appropriate for the default monitor. Returns + // true if the window was created successfully. + bool CreateAndShow(const std::wstring& title, + const Point& origin, + const Size& size); + + // Release OS resources associated with window. + void Destroy(); + + // Inserts |content| into the window tree. + void SetChildContent(HWND content); + + // Returns the backing Window handle to enable clients to set icon and other + // window properties. Returns nullptr if the window has been destroyed. + HWND GetHandle(); + + // If true, closing this window will quit the application. + void SetQuitOnClose(bool quit_on_close); + + // Return a RECT representing the bounds of the current client area. + RECT GetClientArea(); + + protected: + // Processes and route salient window messages for mouse handling, + // size change and DPI. Delegates handling of these to member overloads that + // inheriting classes can handle. + virtual LRESULT MessageHandler(HWND window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept; + + // Called when CreateAndShow is called, allowing subclass window-related + // setup. Subclasses should return false if setup fails. + virtual bool OnCreate(); + + // Called when Destroy is called. + virtual void OnDestroy(); + + private: + friend class WindowClassRegistrar; + + // OS callback called by message pump. Handles the WM_NCCREATE message which + // is passed when the non-client area is being created and enables automatic + // non-client DPI scaling so that the non-client area automatically + // responsponds to changes in DPI. All other messages are handled by + // MessageHandler. + static LRESULT CALLBACK WndProc(HWND const window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept; + + // Retrieves a class instance pointer for |window| + static Win32Window* GetThisFromHandle(HWND const window) noexcept; + + bool quit_on_close_ = false; + + // window handle for top level window. + HWND window_handle_ = nullptr; + + // window handle for hosted content. + HWND child_content_ = nullptr; +}; + +#endif // RUNNER_WIN32_WINDOW_H_ diff --git a/flutter_local_notifications/lib/flutter_local_notifications.dart b/flutter_local_notifications/lib/flutter_local_notifications.dart index 92740ee2e..a261b56c6 100644 --- a/flutter_local_notifications/lib/flutter_local_notifications.dart +++ b/flutter_local_notifications/lib/flutter_local_notifications.dart @@ -43,5 +43,6 @@ export 'src/platform_specifics/ios/notification_details.dart'; export 'src/platform_specifics/macos/initialization_settings.dart'; export 'src/platform_specifics/macos/notification_attachment.dart'; export 'src/platform_specifics/macos/notification_details.dart'; +export 'src/platform_specifics/windows/initialization_settings.dart'; export 'src/typedefs.dart'; export 'src/types.dart'; diff --git a/flutter_local_notifications/lib/src/flutter_local_notifications_plugin.dart b/flutter_local_notifications/lib/src/flutter_local_notifications_plugin.dart index c25900f19..fdda763be 100644 --- a/flutter_local_notifications/lib/src/flutter_local_notifications_plugin.dart +++ b/flutter_local_notifications/lib/src/flutter_local_notifications_plugin.dart @@ -40,6 +40,9 @@ class FlutterLocalNotificationsPlugin { } else if (defaultTargetPlatform == TargetPlatform.linux) { FlutterLocalNotificationsPlatform.instance = LinuxFlutterLocalNotificationsPlugin(); + } else if (defaultTargetPlatform == TargetPlatform.windows) { + FlutterLocalNotificationsPlatform.instance = + WindowsFlutterLocalNotificationsPlugin(); } } @@ -85,6 +88,11 @@ class FlutterLocalNotificationsPlugin { FlutterLocalNotificationsPlatform.instance is LinuxFlutterLocalNotificationsPlugin) { return FlutterLocalNotificationsPlatform.instance as T?; + } else if (defaultTargetPlatform == TargetPlatform.windows && + T == WindowsFlutterLocalNotificationsPlugin && + FlutterLocalNotificationsPlatform.instance + is WindowsFlutterLocalNotificationsPlugin) { + return FlutterLocalNotificationsPlatform.instance as T?; } return null; @@ -142,6 +150,11 @@ class FlutterLocalNotificationsPlugin { LinuxFlutterLocalNotificationsPlugin>() ?.initialize(initializationSettings.linux!, onSelectNotification: onSelectNotification); + } else if (defaultTargetPlatform == TargetPlatform.windows) { + return await resolvePlatformSpecificImplementation< + WindowsFlutterLocalNotificationsPlugin>() + ?.initialize(initializationSettings.windows!, + onSelectNotification: onSelectNotification); } return true; } @@ -175,6 +188,10 @@ class FlutterLocalNotificationsPlugin { return await resolvePlatformSpecificImplementation< MacOSFlutterLocalNotificationsPlugin>() ?.getNotificationAppLaunchDetails(); + } else if (defaultTargetPlatform == TargetPlatform.windows) { + return await resolvePlatformSpecificImplementation< + WindowsFlutterLocalNotificationsPlugin>() + ?.getNotificationAppLaunchDetails(); } else { return await FlutterLocalNotificationsPlatform.instance .getNotificationAppLaunchDetails() ?? @@ -217,6 +234,10 @@ class FlutterLocalNotificationsPlugin { ?.show(id, title, body, notificationDetails: notificationDetails?.linux, payload: payload); + } else if (defaultTargetPlatform == TargetPlatform.windows) { + await resolvePlatformSpecificImplementation< + WindowsFlutterLocalNotificationsPlugin>() + ?.show(id, title, body, payload: payload); } else { await FlutterLocalNotificationsPlatform.instance.show(id, title, body); } diff --git a/flutter_local_notifications/lib/src/initialization_settings.dart b/flutter_local_notifications/lib/src/initialization_settings.dart index 801ae6082..0b6565523 100644 --- a/flutter_local_notifications/lib/src/initialization_settings.dart +++ b/flutter_local_notifications/lib/src/initialization_settings.dart @@ -1,5 +1,6 @@ import 'package:flutter_local_notifications_linux/flutter_local_notifications_linux.dart'; +import '../flutter_local_notifications.dart'; import 'platform_specifics/android/initialization_settings.dart'; import 'platform_specifics/ios/initialization_settings.dart'; import 'platform_specifics/macos/initialization_settings.dart'; @@ -12,6 +13,7 @@ class InitializationSettings { this.iOS, this.macOS, this.linux, + this.windows, }); /// Settings for Android. @@ -25,4 +27,7 @@ class InitializationSettings { /// Settings for Linux. final LinuxInitializationSettings? linux; + + /// Settings for Windows. + final WindowsInitializationSettings? windows; } diff --git a/flutter_local_notifications/lib/src/platform_flutter_local_notifications.dart b/flutter_local_notifications/lib/src/platform_flutter_local_notifications.dart index 227bb0803..9b6f4fa01 100644 --- a/flutter_local_notifications/lib/src/platform_flutter_local_notifications.dart +++ b/flutter_local_notifications/lib/src/platform_flutter_local_notifications.dart @@ -4,7 +4,6 @@ import 'dart:ui'; import 'package:clock/clock.dart'; import 'package:flutter/services.dart'; -import 'package:flutter/widgets.dart'; import 'package:flutter_local_notifications_platform_interface/flutter_local_notifications_platform_interface.dart'; import 'package:timezone/timezone.dart'; @@ -25,6 +24,8 @@ import 'platform_specifics/ios/notification_details.dart'; import 'platform_specifics/macos/initialization_settings.dart'; import 'platform_specifics/macos/method_channel_mappers.dart'; import 'platform_specifics/macos/notification_details.dart'; +import 'platform_specifics/windows/initialization_settings.dart'; +import 'platform_specifics/windows/method_channel_mappers.dart'; import 'type_mappers.dart'; import 'typedefs.dart'; import 'types.dart'; @@ -850,6 +851,64 @@ class MacOSFlutterLocalNotificationsPlugin } } +/// Windows implementation of the flutter_local_notifications plugin. +class WindowsFlutterLocalNotificationsPlugin + extends MethodChannelFlutterLocalNotificationsPlugin { + SelectNotificationCallback? _onSelectNotification; + + /// Initializes the plugin. + /// + /// Call this method on application before using the plugin further. + /// This should only be done once. When a notification created by this plugin + /// was used to launch the app, calling [initialize] is what will trigger to + /// the [onSelectNotification] callback to be fire. + /// + /// To handle when a notification launched an application, use + /// [getNotificationAppLaunchDetails]. + Future initialize( + WindowsInitializationSettings settings, { + SelectNotificationCallback? onSelectNotification, + }) { + _onSelectNotification = onSelectNotification; + _channel.setMethodCallHandler(_handleMethod); + + return _channel.invokeMethod('initialize', settings.toMap()); + } + + @override + Future show( + int id, + String? title, + String? body, { + String? payload, + String? group, + }) => + _channel.invokeMethod('show', { + 'id': id, + 'title': title, + 'body': body, + 'group': group, + 'payload': payload, + }); + + @override + Future cancel(int id, {String? group}) => + _channel.invokeMethod('cancel', { + 'id': id, + 'group': group, + }); + + Future _handleMethod(MethodCall call) async { + switch (call.method) { + case 'selectNotification': + if (call.arguments is String) { + _onSelectNotification?.call(call.arguments); + } + break; + } + } +} + /// Checks [backgroundHandler] method, if not `null`, for eligibility to /// be used as a background callback. /// diff --git a/flutter_local_notifications/lib/src/platform_specifics/windows/initialization_settings.dart b/flutter_local_notifications/lib/src/platform_specifics/windows/initialization_settings.dart new file mode 100644 index 000000000..a4036e483 --- /dev/null +++ b/flutter_local_notifications/lib/src/platform_specifics/windows/initialization_settings.dart @@ -0,0 +1,26 @@ +import 'package:flutter/widgets.dart'; + +/// Plugin initialization settings for Windows. +class WindowsInitializationSettings { + /// Creates a new settings object for initializing this plugin on Windows. + const WindowsInitializationSettings({ + required this.appName, + required this.appUserModelId, + this.iconPath, + this.iconBackgroundColor, + }); + + /// The name of the app that should be shown in the notification toast. + final String appName; + + /// The unique app user model ID that identifies the app, + /// in the form of CompanyName.ProductName.SubProduct.VersionInformation. + /// + /// See https://docs.microsoft.com/en-us/windows/win32/shell/appids + /// for more information. + final String appUserModelId; + + final String? iconPath; + + final Color? iconBackgroundColor; +} diff --git a/flutter_local_notifications/lib/src/platform_specifics/windows/method_channel_mappers.dart b/flutter_local_notifications/lib/src/platform_specifics/windows/method_channel_mappers.dart new file mode 100644 index 000000000..01c577cc0 --- /dev/null +++ b/flutter_local_notifications/lib/src/platform_specifics/windows/method_channel_mappers.dart @@ -0,0 +1,13 @@ +import 'initialization_settings.dart'; + +/// An extension on [WindowsInitializationSettings] that provides mapping +/// to method channel serializable values. +extension WindowsInitializationSettingsMapper on WindowsInitializationSettings { + /// Maps [WindowsInitializationSettings] to a [Map]. + Map toMap() => { + 'appName': appName, + 'aumid': appUserModelId, + 'iconPath': iconPath, + 'iconBgColor': iconBackgroundColor, + }; +} diff --git a/flutter_local_notifications/lib/src/platform_specifics/windows/notification_action.dart b/flutter_local_notifications/lib/src/platform_specifics/windows/notification_action.dart new file mode 100644 index 000000000..e69de29bb diff --git a/flutter_local_notifications/lib/src/platform_specifics/windows/notification_details.dart b/flutter_local_notifications/lib/src/platform_specifics/windows/notification_details.dart new file mode 100644 index 000000000..e69de29bb diff --git a/flutter_local_notifications/pubspec.yaml b/flutter_local_notifications/pubspec.yaml index e02e70747..522fc2107 100644 --- a/flutter_local_notifications/pubspec.yaml +++ b/flutter_local_notifications/pubspec.yaml @@ -33,6 +33,8 @@ flutter: pluginClass: FlutterLocalNotificationsPlugin linux: default_package: flutter_local_notifications_linux + windows: + pluginClass: FlutterLocalNotificationsPlugin environment: sdk: '>=2.12.0 <3.0.0' diff --git a/flutter_local_notifications/windows/.gitignore b/flutter_local_notifications/windows/.gitignore new file mode 100644 index 000000000..b3eb2be16 --- /dev/null +++ b/flutter_local_notifications/windows/.gitignore @@ -0,0 +1,17 @@ +flutter/ + +# Visual Studio user-specific files. +*.suo +*.user +*.userosscache +*.sln.docstates + +# Visual Studio build-related files. +x64/ +x86/ + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!*.[Cc]ache/ diff --git a/flutter_local_notifications/windows/CMakeLists.txt b/flutter_local_notifications/windows/CMakeLists.txt new file mode 100644 index 000000000..16807d156 --- /dev/null +++ b/flutter_local_notifications/windows/CMakeLists.txt @@ -0,0 +1,67 @@ +cmake_minimum_required(VERSION 3.14) +set(PROJECT_NAME "flutter_local_notifications") +project(${PROJECT_NAME} LANGUAGES CXX) +include(FetchContent) + +# This value is used when generating builds using this plugin, so it must +# not be changed +set(PLUGIN_NAME "flutter_local_notifications_plugin") + +# nuget configuration +set(NUGET_PACKAGES_PATH "${CMAKE_BINARY_DIR}/packages") + +FetchContent_Declare(nuget + URL "https://dist.nuget.org/win-x86-commandline/v6.0.0/nuget.exe" + URL_HASH SHA256=04eb6c4fe4213907e2773e1be1bbbd730e9a655a3c9c58387ce8d4a714a5b9e1 + DOWNLOAD_NO_EXTRACT true +) +find_program(NUGET nuget) +if (NOT NUGET) + message("Nuget.exe not found, trying to download or use cached version.") + FetchContent_MakeAvailable(nuget) + set(NUGET ${nuget_SOURCE_DIR}/nuget.exe) +endif() + +function(nuget_install pkg ver) + execute_process(COMMAND + ${NUGET} install ${pkg} -Version ${ver} -OutputDirectory ${NUGET_PACKAGES_PATH} + RESULT_VARIABLE result) + if (NOT result EQUAL 0) + message(FATAL_ERROR "Failed to install nuget package ${pkg}, version ${ver}, ${result}") + endif() +endfunction() + +add_library(${PLUGIN_NAME} SHARED + "flutter_local_notifications_plugin.cpp" + "methods.cpp" + "utils/utils.h" + "registration.cpp") + +# setup c++/winrt +set(CPPWINRT_VERSION "2.0.220131.2") +set(CPPWINRT ${NUGET_PACKAGES_PATH}/Microsoft.Windows.CppWinRT.${CPPWINRT_VERSION}/bin/cppwinrt.exe) + +nuget_install("Microsoft.Windows.CppWinRT" ${CPPWINRT_VERSION}) +execute_process(COMMAND + ${CPPWINRT} -input sdk -output include + WORKING_DIRECTORY ${CMAKE_BINARY_DIR} + RESULT_VARIABLE ret) +if (NOT ret EQUAL 0) + message(FATAL_ERROR "Result ${ret} ${CPPWINRT} Failed to run cppwinrt.exe") +endif() + +include_directories(BEFORE SYSTEM ${CMAKE_BINARY_DIR}/include) + +apply_standard_settings(${PLUGIN_NAME}) +set_target_properties(${PLUGIN_NAME} PROPERTIES + CXX_VISIBILITY_PRESET hidden) +target_compile_definitions(${PLUGIN_NAME} PRIVATE FLUTTER_PLUGIN_IMPL) +target_include_directories(${PLUGIN_NAME} INTERFACE + "${CMAKE_CURRENT_SOURCE_DIR}/include") +target_link_libraries(${PLUGIN_NAME} PRIVATE flutter flutter_wrapper_plugin) + +# List of absolute paths to libraries that should be bundled with the plugin +set(flutter_local_notifications_bundled_libraries + "" + PARENT_SCOPE +) diff --git a/flutter_local_notifications/windows/flutter_local_notifications_plugin.cpp b/flutter_local_notifications/windows/flutter_local_notifications_plugin.cpp new file mode 100644 index 000000000..792cfe576 --- /dev/null +++ b/flutter_local_notifications/windows/flutter_local_notifications_plugin.cpp @@ -0,0 +1,308 @@ +#include "include/flutter_local_notifications/flutter_local_notifications_plugin.h" +#include "include/flutter_local_notifications/methods.h" +#include "utils/utils.h" +#include "registration.h" + +// This must be included before many other Windows headers. +#include +#include +#include +#include +#include +#include +#include +#include +#include + +// For getPlatformVersion; remove unless needed for your plugin implementation. +#include + +#include +#include +#include + +#include +#include +#include + +using namespace winrt::Windows::Data::Xml::Dom; +namespace { + + class FlutterLocalNotificationsPlugin : public flutter::Plugin { + public: + static void RegisterWithRegistrar(flutter::PluginRegistrarWindows* registrar); + + FlutterLocalNotificationsPlugin(std::shared_ptr channel); + + virtual ~FlutterLocalNotificationsPlugin(); + + private: + std::wstring _aumid; + std::optional toastNotifier; + std::optional toastNotificationHistory; + std::shared_ptr channel; + + // Called when a method is called on this plugin's channel from Dart. + void HandleMethodCall( + const flutter::MethodCall& method_call, + std::unique_ptr> result); + + /// + /// Initializes this plugin. + /// + /// The app user model ID that identifies the app. + /// The display name of the app. + /// An optional path to the icon of the app. + /// An optional background color of the icon, in AARRGGBB format. + /// Whether the initialization was successful. + bool Initialize( + const std::string& appName, + const std::string& aumid, + const std::optional& iconPath, + const std::optional& iconBgColor); + + /// + /// Displays a single notification toast. + /// + /// A unique ID that identifies this notification. It can be used to cancel/dismiss the notification. + /// An optional title of the notification. + /// An optional body of the notification. + /// + void ShowNotification( + const int id, + const std::optional& title, + const std::optional& body, + const std::optional& payload, + const std::optional& group); + + /// + /// Dismisses the notification that has the given ID. + /// + /// The ID of the notification to be dismissed. + /// The group the notification is in. Default is the aumid of this app. + void CancelNotification(const int id, const std::optional& group); + + /// + /// Dismisses all currently active notifications. + /// + void CancelAllNotifications(); + + std::optional HasIdentity(); + }; + + // static + void FlutterLocalNotificationsPlugin::RegisterWithRegistrar( + flutter::PluginRegistrarWindows* registrar) { + auto channel = + std::make_shared( + registrar->messenger(), "dexterous.com/flutter/local_notifications", + &flutter::StandardMethodCodec::GetInstance()); + + auto plugin = std::make_unique(channel); + + channel->SetMethodCallHandler( + [plugin_pointer = plugin.get()](const auto& call, auto result) { + plugin_pointer->HandleMethodCall(call, std::move(result)); + }); + + registrar->AddPlugin(std::move(plugin)); + } + + FlutterLocalNotificationsPlugin::FlutterLocalNotificationsPlugin(std::shared_ptr channel) : + channel(channel) {} + + FlutterLocalNotificationsPlugin::~FlutterLocalNotificationsPlugin() {} + + void FlutterLocalNotificationsPlugin::HandleMethodCall( + const flutter::MethodCall& method_call, + std::unique_ptr> result + ) { + const auto& method_name = method_call.method_name(); + if (method_name == Method::GET_NOTIFICATION_APP_LAUNCH_DETAILS) { + result->Success(); + } + else if (method_name == Method::INITIALIZE) { + const auto args = std::get_if(method_call.arguments()); + if (args != nullptr) { + const auto appName = Utils::GetMapValue("appName", args).value(); + const auto aumid = Utils::GetMapValue("aumid", args).value(); + const auto iconPath = Utils::GetMapValue("iconPath", args); + const auto iconBgColor = Utils::GetMapValue("iconBgColor", args); + + result->Success(Initialize(appName, aumid, iconPath, iconBgColor)); + } + else { + result->Error("INTERNAL", "flutter_local_notifications encountered an internal error."); + } + } + else if (method_name == Method::SHOW) { + channel->InvokeMethod("test", nullptr); + + const auto args = std::get_if(method_call.arguments()); + if (args != nullptr && toastNotifier.has_value()) { + const auto id = Utils::GetMapValue("id", args).value(); + const auto title = Utils::GetMapValue("title", args); + const auto body = Utils::GetMapValue("body", args); + const auto payload = Utils::GetMapValue("payload", args); + const auto group = Utils::GetMapValue("group", args); + + ShowNotification(id, title, body, payload, group); + result->Success(); + } + else { + result->Error("INTERNAL", "flutter_local_notifications encountered an internal error."); + } + } + else if (method_name == Method::CANCEL && toastNotifier.has_value()) { + const auto args = std::get_if(method_call.arguments()); + if (args != nullptr) { + const auto id = Utils::GetMapValue("id", args).value(); + const auto group = Utils::GetMapValue("group", args); + + CancelNotification(id, group); + result->Success(); + } + else { + result->Error("INTERNAL", "flutter_local_notifications encountered an internal error."); + } + } + else if (method_name == Method::CANCEL_ALL && toastNotifier.has_value()) { + CancelAllNotifications(); + result->Success(); + } + else { + result->NotImplemented(); + } + } + + std::optional FlutterLocalNotificationsPlugin::HasIdentity() { + if (!IsWindows8OrGreater()) { + // OS is windows 7 or lower + return false; + } + + UINT32 length; + auto err = GetCurrentPackageFullName(&length, nullptr); + if (err != ERROR_INSUFFICIENT_BUFFER) { + if (err == APPMODEL_ERROR_NO_PACKAGE) + return false; + + return std::nullopt; + } + + PWSTR fullName = (PWSTR)malloc(length * sizeof(*fullName)); + if (fullName == nullptr) + return std::nullopt; + + err = GetCurrentPackageFullName(&length, fullName); + if (err != ERROR_SUCCESS) + return std::nullopt; + + free(fullName); + + return true; + } + + bool FlutterLocalNotificationsPlugin::Initialize( + const std::string& appName, + const std::string& aumid, + const std::optional& iconPath, + const std::optional& iconBgColor + ) { + _aumid = winrt::to_hstring(aumid); + PluginRegistration::RegisterApp(aumid, appName, iconPath, iconBgColor, channel); + + const auto hasIdentity = HasIdentity(); + if (!hasIdentity.has_value()) + return false; + + if (hasIdentity.value()) + toastNotifier = winrt::Windows::UI::Notifications::ToastNotificationManager::CreateToastNotifier(); + else + toastNotifier = winrt::Windows::UI::Notifications::ToastNotificationManager::CreateToastNotifier(winrt::to_hstring(aumid)); + + return true; + } + + void FlutterLocalNotificationsPlugin::ShowNotification( + const int id, + const std::optional& title, + const std::optional& body, + const std::optional& payload, + const std::optional& group + ) { + // obtain a notification template with a title and a body + //const auto doc = winrt::Windows::UI::Notifications::ToastNotificationManager::GetTemplateContent(winrt::Windows::UI::Notifications::ToastTemplateType::ToastText02); + // find all tags + //const auto nodes = doc.GetElementsByTagName(L"text"); + + XmlDocument doc; + doc.LoadXml(L"\ + \ + \ + \ + \ + \ + "); + + const auto bindingNode = doc.SelectSingleNode(L"//binding[1]"); + + if (title.has_value()) { + // change the text of the first , which will be the title + const auto textNode = doc.CreateElement(L"text"); + textNode.InnerText(winrt::to_hstring(*title)); + bindingNode.AppendChild(textNode); + } + if (body.has_value()) { + // change the text of the second , which will be the body + //nodes.Item(1).AppendChild(doc.CreateTextNode(winrt::to_hstring(body.value()))); + const auto textNode = doc.CreateElement(L"text"); + textNode.InnerText(winrt::to_hstring(*body)); + bindingNode.AppendChild(textNode); + } + if (payload.has_value()) { + std::cout << "payload: " << *payload << std::endl; + doc.DocumentElement().SetAttribute(L"launch", winrt::to_hstring(*payload)); + } + + std::cout << winrt::to_string(doc.GetXml()) << std::endl; + + winrt::Windows::UI::Notifications::ToastNotification notif{ doc }; + notif.Tag(winrt::to_hstring(id)); + if (group.has_value()) { + notif.Group(winrt::to_hstring(*group)); + } + else { + notif.Group(_aumid); + } + + toastNotifier.value().Show(notif); + } + + void FlutterLocalNotificationsPlugin::CancelNotification(const int id, const std::optional& group) { + if (!toastNotificationHistory.has_value()) { + toastNotificationHistory = winrt::Windows::UI::Notifications::ToastNotificationManager::History(); + } + + if (group.has_value()) { + toastNotificationHistory.value().Remove(winrt::to_hstring(id), winrt::to_hstring(group.value()), _aumid); + } + else { + toastNotificationHistory.value().Remove(winrt::to_hstring(id), _aumid, _aumid); + } + } + + void FlutterLocalNotificationsPlugin::CancelAllNotifications() { + if (!toastNotificationHistory.has_value()) { + toastNotificationHistory = winrt::Windows::UI::Notifications::ToastNotificationManager::History(); + } + toastNotificationHistory.value().Clear(_aumid); + } +} + +void FlutterLocalNotificationsPluginRegisterWithRegistrar( + FlutterDesktopPluginRegistrarRef registrar) { + FlutterLocalNotificationsPlugin::RegisterWithRegistrar( + flutter::PluginRegistrarManager::GetInstance() + ->GetRegistrar(registrar)); +} diff --git a/flutter_local_notifications/windows/include/flutter_local_notifications/flutter_local_notifications_plugin.h b/flutter_local_notifications/windows/include/flutter_local_notifications/flutter_local_notifications_plugin.h new file mode 100644 index 000000000..d50c367fc --- /dev/null +++ b/flutter_local_notifications/windows/include/flutter_local_notifications/flutter_local_notifications_plugin.h @@ -0,0 +1,39 @@ +#ifndef FLUTTER_PLUGIN_FLUTTER_LOCAL_NOTIFICATIONS_PLUGIN_H_ +#define FLUTTER_PLUGIN_FLUTTER_LOCAL_NOTIFICATIONS_PLUGIN_H_ + +#pragma once +#include +#include + +#include +#include +#include +#include +#include +#include + +#include + +#ifdef FLUTTER_PLUGIN_IMPL +#define FLUTTER_PLUGIN_EXPORT __declspec(dllexport) +#else +#define FLUTTER_PLUGIN_EXPORT __declspec(dllimport) +#endif + +#if defined(__cplusplus) +extern "C" { +#endif + +FLUTTER_PLUGIN_EXPORT void FlutterLocalNotificationsPluginRegisterWithRegistrar( + FlutterDesktopPluginRegistrarRef registrar); + +#if defined(__cplusplus) +} // extern "C" +#endif + +/// +/// Defines the type of the method channel used by this plugin. +/// +typedef flutter::MethodChannel PluginMethodChannel; + +#endif // FLUTTER_PLUGIN_FLUTTER_LOCAL_NOTIFICATIONS_PLUGIN_H_ diff --git a/flutter_local_notifications/windows/include/flutter_local_notifications/methods.h b/flutter_local_notifications/windows/include/flutter_local_notifications/methods.h new file mode 100644 index 000000000..0286ff96d --- /dev/null +++ b/flutter_local_notifications/windows/include/flutter_local_notifications/methods.h @@ -0,0 +1,15 @@ +#include + +/// +/// Defines names of methods of this plugin that are callable +/// through Flutter's method channel. +/// +namespace Method +{ + extern const std::string INITIALIZE; + extern const std::string GET_NOTIFICATION_APP_LAUNCH_DETAILS; + extern const std::string SHOW; + extern const std::string CANCEL; + extern const std::string CANCEL_ALL; + extern const std::string SELECT_NOTIFICATION; +} diff --git a/flutter_local_notifications/windows/methods.cpp b/flutter_local_notifications/windows/methods.cpp new file mode 100644 index 000000000..295d46885 --- /dev/null +++ b/flutter_local_notifications/windows/methods.cpp @@ -0,0 +1,10 @@ +#include "include/flutter_local_notifications/methods.h" + +#include + +const std::string Method::GET_NOTIFICATION_APP_LAUNCH_DETAILS = "getNotificationAppLaunchDetails"; +const std::string Method::SHOW = "show"; +const std::string Method::INITIALIZE = "initialize"; +const std::string Method::CANCEL = "cancel"; +const std::string Method::CANCEL_ALL = "cancelAll"; +const std::string Method::SELECT_NOTIFICATION = "selectNotification"; diff --git a/flutter_local_notifications/windows/registration.cpp b/flutter_local_notifications/windows/registration.cpp new file mode 100644 index 000000000..14ded76ca --- /dev/null +++ b/flutter_local_notifications/windows/registration.cpp @@ -0,0 +1,268 @@ +// Huge credit to these StackOverflow answers: +// https://stackoverflow.com/questions/51947833/activation-from-c-winrt-dll +// https://stackoverflow.com/questions/67005337/how-works-notifications-on-windows-registry-no-shortlink + +#include "registration.h" +#include "include/flutter_local_notifications/flutter_local_notifications_plugin.h" +#include "include/flutter_local_notifications/methods.h" + +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include + +/// +/// The GUID that identifies the notification activation callback. +/// 68d0c89d-760f-4f79-a067-ae8d4220ccc1 +/// +static constexpr winrt::guid CALLBACK_GUID{ + 0x68d0c89d, 0x760f, 0x4f79, {0xa0, 0x67, 0xae, 0x8d, 0x42, 0x20, 0xcc, 0xc1} +}; + +/// +/// String representation of the callback GUID. +/// +const std::string CALLBACK_GUID_STR = "{68d0c89d-760f-4f79-a067-ae8d4220ccc1}"; + +/// +/// This callback will be called when a notification sent by this plugin is clicked on. +/// +struct NotificationActivationCallback : winrt::implements +{ + std::shared_ptr channel; + + HRESULT __stdcall Activate( + LPCWSTR app, + LPCWSTR args, + [[maybe_unused]] NOTIFICATION_USER_INPUT_DATA const* data, + [[maybe_unused]] ULONG count) noexcept final + { + try { + std::wcout << L"Example" << L" has been called back from a notification." << std::endl; + std::wcout << L"Value of the 'app' parameter is '" << app << L"'." << std::endl; + std::wcout << L"Value of the 'args' parameter is '" << args << L"'." << std::endl; + const std::string payload = CW2A(args); + channel->InvokeMethod(Method::SELECT_NOTIFICATION, std::make_unique(payload), nullptr); + return S_OK; + } + catch (...) { + return winrt::to_hresult(); + } + } +}; + +/// +/// A class factory that creates an instance of NotificationActivationCallback. +/// +struct NotificationActivationCallbackFactory : winrt::implements +{ + std::shared_ptr channel; + + HRESULT __stdcall CreateInstance( + IUnknown* outer, + GUID const& iid, + void** result) noexcept final + { + std::cout << "CreateInstance" << std::endl; + + *result = nullptr; + + if (outer) { + return CLASS_E_NOAGGREGATION; + } + + const auto cb = winrt::make_self(); + cb.get()->channel = channel; + + return cb->QueryInterface(iid, result); + } + + HRESULT __stdcall LockServer(BOOL) noexcept final { + return S_OK; + } +}; + +struct RegistryHandle +{ + using type = HKEY; + + static void close(type value) noexcept { + WINRT_VERIFY_(ERROR_SUCCESS, RegCloseKey(value)); + } + + static constexpr type invalid() noexcept { + return nullptr; + } +}; + +/// +/// A handle to a registry key. +/// +using RegistryKey = winrt::handle_type; + +/// +/// Updates the Registry to enable notifications. +/// +/// Related resources: +///
    +///
  • https://docs.microsoft.com/en-us/windows/apps/design/shell/tiles-and-notifications/send-local-toast-other-apps
  • +///
+///
+/// The app user model ID of the app. Provided during initialization of the plugin. +/// The display name of the app. The name will be shown on the notification toasts. +/// An optional path to the icon of the app. The icon will be shown on the notification toasts +/// An optional string that specifies the background color of the icon, in the format of AARRGGBB. +void UpdateRegistry( + const std::string& aumid, + const std::string& appName, + const std::optional& iconPath, + const std::optional& iconBgColor +) { + std::stringstream ss; + ss << "Software\\Microsoft\\Windows\\CurrentVersion\\PushNotifications\\Backup\\" << aumid; + const auto notifSettingsKeyPath = ss.str(); + RegistryKey key; + + // create registry key + // HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\PushNotifications\Backup + winrt::check_win32(RegCreateKeyExA( + HKEY_CURRENT_USER, + notifSettingsKeyPath.c_str(), + 0, + nullptr, + 0, + KEY_WRITE, + nullptr, + key.put(), + nullptr)); + + // put the following key values under the key + // HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\PushNotifications\Backup\ + // + // appType = app:desktop + // Setting = s:banner,s:toast,s:audio,c:toast,c:ringing + // wnsId = NonImmersivePackage + + const std::string appType = "app:desktop"; + const std::string setting = "s:banner,s:toast,s:audio,c:toast,c:ringing"; + const std::string wnsId = "NonImmersivePackage"; + winrt::check_win32(RegSetValueExA( + key.get(), + "appType", + 0, + REG_SZ, + reinterpret_cast(appType.c_str()), + static_cast(appType.size() + 1 * sizeof(char)))); + winrt::check_win32(RegSetValueExA( + key.get(), + "Setting", + 0, + REG_SZ, + reinterpret_cast(setting.c_str()), + static_cast(setting.size() + 1 * sizeof(char)))); + winrt::check_win32(RegSetValueExA( + key.get(), + "wnsId", + 0, + REG_SZ, + reinterpret_cast(wnsId.c_str()), + static_cast(wnsId.size() + 1 * sizeof(char)))); + + // now, we register app info to the Registry. + + ss.clear(); + ss.str(std::string()); + ss << "Software\\Classes\\AppUserModelId\\" << aumid; + const auto appInfoKeyPath = ss.str(); + RegistryKey appInfoKey; + + // create registry key + // HKEY_CURRENT_USER\Software\Classes\AppUserModelId\ + winrt::check_win32(RegCreateKeyExA( + HKEY_CURRENT_USER, + appInfoKeyPath.c_str(), + 0, + nullptr, + 0, + KEY_WRITE, + nullptr, + appInfoKey.put(), + nullptr)); + + winrt::check_win32(RegSetValueExA( + appInfoKey.get(), + "DisplayName", + 0, + REG_SZ, + reinterpret_cast(appName.c_str()), + static_cast(appName.size() + 1 * sizeof(char)))); + + if (iconPath.has_value()) { + const auto v = iconPath.value(); + winrt::check_win32(RegSetValueExA( + appInfoKey.get(), + "IconUri", + 0, + REG_SZ, + reinterpret_cast(v.c_str()), + static_cast(v.size() + 1 * sizeof(char)))); + } + + if (iconBgColor.has_value()) { + const auto v = iconBgColor.value(); + winrt::check_win32(RegSetValueExA( + appInfoKey.get(), + "IconBackgroundColor", + 0, + REG_SZ, + reinterpret_cast(v.c_str()), + static_cast(v.size() + 1 * sizeof(char)))); + } + + // register the guid of the notification activation callback + winrt::check_win32(RegSetValueExA( + appInfoKey.get(), + "CustomActivator", + 0, + REG_SZ, + reinterpret_cast(CALLBACK_GUID_STR.c_str()), + static_cast(CALLBACK_GUID_STR.size() + 1 * sizeof(char)))); +} + +/// +/// Register the notificatio activation callback factory +/// and the guid of the callback. +/// +void RegisterCallback(std::shared_ptr channel) { + DWORD registration{}; + + const auto factory_ref = winrt::make_self(); + const auto factory = factory_ref.get(); + factory->channel = channel; + + winrt::check_hresult(CoRegisterClassObject( + CALLBACK_GUID, + factory, + CLSCTX_LOCAL_SERVER, + REGCLS_MULTIPLEUSE, + ®istration)); +} + +void PluginRegistration::RegisterApp( + const std::string& aumid, + const std::string& appName, + const std::optional& iconPath, + const std::optional& iconBgColor, + std::shared_ptr plugin +) { + std::cout << "register app" << std::endl; + UpdateRegistry(aumid, appName, iconPath, iconBgColor); + RegisterCallback(plugin); +} diff --git a/flutter_local_notifications/windows/registration.h b/flutter_local_notifications/windows/registration.h new file mode 100644 index 000000000..247f8c399 --- /dev/null +++ b/flutter_local_notifications/windows/registration.h @@ -0,0 +1,30 @@ +#ifndef PLUGIN_REGISTRATRION_H_ +#define PLUGIN_REGISTRATRION_H_ + +#include "include/flutter_local_notifications/flutter_local_notifications_plugin.h" + +#include +#include +#include + +/// +/// Contains logic for handling Registry values. +/// +namespace PluginRegistration { + /// + /// Registers the running app to the Windows Registry. + /// + /// The app user model ID that identifies the app. + /// The display name of the app. + /// An optional path to the icon of the app. + /// An optional background color of the icon, in AARRGGBB format. + /// The instance of the plugin calling this function + void RegisterApp( + const std::string& aumid, + const std::string& appName, + const std::optional& iconPath, + const std::optional& iconBgColor, + std::shared_ptr plugin); +} + +#endif // !PLUGIN_REGISTRATRION_H_ diff --git a/flutter_local_notifications/windows/utils/utils.h b/flutter_local_notifications/windows/utils/utils.h new file mode 100644 index 000000000..08766348c --- /dev/null +++ b/flutter_local_notifications/windows/utils/utils.h @@ -0,0 +1,28 @@ +#ifndef UTILS_H_ +#define UTILS_H_ + +#include +#include + +namespace Utils { + /// + /// Retrieves the string value stored with the given key in the given EncodableMap. + /// + /// The key that maps to the desired string value. + /// The EncodabeMap that stores the key-value pair. + /// The string value that the key maps to, or nullopt if none is found. + template + std::optional GetMapValue(const std::string& key, const flutter::EncodableMap* m) { + const auto pair = m->find(flutter::EncodableValue(key)); + if (pair == m->end()) { + return std::nullopt; + } + const auto val = pair->second; + if (std::holds_alternative(val)) { + return std::get(val); + } + return std::nullopt; + } +} + +#endif // !UTILS_H