-
Notifications
You must be signed in to change notification settings - Fork 1.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[flutter_local_notifications] linux support #888
Closed
Closed
Changes from all commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
03a46ee
initial linux support
akemimadoka a1aac0e
Introduce linux limitations
akemimadoka 543d8c9
implement periodicallyShow
akemimadoka 89be469
implement zonedSchedule
akemimadoka c3a8ad7
introduce limitations on implementing getNotificationAppLaunchDetails…
akemimadoka 783a0b9
Fix button action bugs
akemimadoka f38460f
Fix icon bugs
akemimadoka 5b29ec9
Use g_autoptr
akemimadoka 738d8de
Code format
akemimadoka 53f631c
Fix readme
akemimadoka dd6d96b
Code format, fix bugs from zonedSchedule
akemimadoka d7e69e3
rename BytesLinuxIcon to ByteDataLinuxIcon, add ci
akemimadoka 9163283
try fixing ci
akemimadoka 09ecd86
add dependencies to ci
akemimadoka 84f1683
add gtk dependencies
akemimadoka 15ce2da
Merge remote-tracking branch 'origin/master'
akemimadoka b6d24d2
Add documentation
akemimadoka 2096542
Simplify implementation and code reformat
akemimadoka 276af10
Add callback to make users can persist notifications id after a restart
akemimadoka File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
flutter/ephemeral |
106 changes: 106 additions & 0 deletions
106
flutter_local_notifications/example/linux/CMakeLists.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,106 @@ | ||
cmake_minimum_required(VERSION 3.10) | ||
project(runner LANGUAGES CXX) | ||
|
||
set(BINARY_NAME "flutter_local_notifications_example") | ||
set(APPLICATION_ID "com.dexterous.flutter_local_notifications") | ||
|
||
cmake_policy(SET CMP0063 NEW) | ||
|
||
set(CMAKE_INSTALL_RPATH "$ORIGIN/lib") | ||
|
||
# Configure build options. | ||
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() | ||
|
||
# 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 -Wall -Werror) | ||
target_compile_options(${TARGET} PRIVATE "$<$<NOT:$<CONFIG:Debug>>:-O3>") | ||
target_compile_definitions(${TARGET} PRIVATE "$<$<NOT:$<CONFIG:Debug>>:NDEBUG>") | ||
endfunction() | ||
|
||
set(FLUTTER_MANAGED_DIR "${CMAKE_CURRENT_SOURCE_DIR}/flutter") | ||
|
||
# Flutter library and tool build rules. | ||
add_subdirectory(${FLUTTER_MANAGED_DIR}) | ||
|
||
# System-level dependencies. | ||
find_package(PkgConfig REQUIRED) | ||
pkg_check_modules(GTK REQUIRED IMPORTED_TARGET gtk+-3.0) | ||
|
||
add_definitions(-DAPPLICATION_ID="${APPLICATION_ID}") | ||
|
||
# Application build | ||
add_executable(${BINARY_NAME} | ||
"main.cc" | ||
"my_application.cc" | ||
"${FLUTTER_MANAGED_DIR}/generated_plugin_registrant.cc" | ||
) | ||
apply_standard_settings(${BINARY_NAME}) | ||
target_link_libraries(${BINARY_NAME} PRIVATE flutter) | ||
target_link_libraries(${BINARY_NAME} PRIVATE PkgConfig::GTK) | ||
add_dependencies(${BINARY_NAME} flutter_assemble) | ||
# Only the install-generated bundle's copy of the executable will launch | ||
# correctly, since the resources must in the right relative locations. To avoid | ||
# people trying to run the unbundled copy, put it in a subdirectory instead of | ||
# the default top-level location. | ||
set_target_properties(${BINARY_NAME} | ||
PROPERTIES | ||
RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/intermediates_do_not_run" | ||
) | ||
|
||
# Generated plugin build rules, which manage building the plugins and adding | ||
# them to the application. | ||
include(flutter/generated_plugins.cmake) | ||
|
||
|
||
# === Installation === | ||
# By default, "installing" just makes a relocatable bundle in the build | ||
# directory. | ||
set(BUILD_BUNDLE_DIR "${PROJECT_BINARY_DIR}/bundle") | ||
if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) | ||
set(CMAKE_INSTALL_PREFIX "${BUILD_BUNDLE_DIR}" CACHE PATH "..." FORCE) | ||
endif() | ||
|
||
# Start with a clean build bundle directory every time. | ||
install(CODE " | ||
file(REMOVE_RECURSE \"${BUILD_BUNDLE_DIR}/\") | ||
" COMPONENT Runtime) | ||
|
||
set(INSTALL_BUNDLE_DATA_DIR "${CMAKE_INSTALL_PREFIX}/data") | ||
set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}/lib") | ||
|
||
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. | ||
if(NOT CMAKE_BUILD_TYPE MATCHES "Debug") | ||
install(FILES "${AOT_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" | ||
COMPONENT Runtime) | ||
endif() |
88 changes: 88 additions & 0 deletions
88
flutter_local_notifications/example/linux/flutter/CMakeLists.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
cmake_minimum_required(VERSION 3.10) | ||
|
||
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. | ||
|
||
# Serves the same purpose as list(TRANSFORM ... PREPEND ...), | ||
# which isn't available in 3.10. | ||
function(list_prepend LIST_NAME PREFIX) | ||
set(NEW_LIST "") | ||
foreach(element ${${LIST_NAME}}) | ||
list(APPEND NEW_LIST "${PREFIX}${element}") | ||
endforeach(element) | ||
set(${LIST_NAME} "${NEW_LIST}" PARENT_SCOPE) | ||
endfunction() | ||
|
||
# === Flutter Library === | ||
# System-level dependencies. | ||
find_package(PkgConfig REQUIRED) | ||
pkg_check_modules(GTK REQUIRED IMPORTED_TARGET gtk+-3.0) | ||
pkg_check_modules(GLIB REQUIRED IMPORTED_TARGET glib-2.0) | ||
pkg_check_modules(GIO REQUIRED IMPORTED_TARGET gio-2.0) | ||
pkg_check_modules(BLKID REQUIRED IMPORTED_TARGET blkid) | ||
|
||
set(FLUTTER_LIBRARY "${EPHEMERAL_DIR}/libflutter_linux_gtk.so") | ||
|
||
# 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/lib/libapp.so" PARENT_SCOPE) | ||
|
||
list(APPEND FLUTTER_LIBRARY_HEADERS | ||
"fl_basic_message_channel.h" | ||
"fl_binary_codec.h" | ||
"fl_binary_messenger.h" | ||
"fl_dart_project.h" | ||
"fl_engine.h" | ||
"fl_json_message_codec.h" | ||
"fl_json_method_codec.h" | ||
"fl_message_codec.h" | ||
"fl_method_call.h" | ||
"fl_method_channel.h" | ||
"fl_method_codec.h" | ||
"fl_method_response.h" | ||
"fl_plugin_registrar.h" | ||
"fl_plugin_registry.h" | ||
"fl_standard_message_codec.h" | ||
"fl_standard_method_codec.h" | ||
"fl_string_codec.h" | ||
"fl_value.h" | ||
"fl_view.h" | ||
"flutter_linux.h" | ||
) | ||
list_prepend(FLUTTER_LIBRARY_HEADERS "${EPHEMERAL_DIR}/flutter_linux/") | ||
add_library(flutter INTERFACE) | ||
target_include_directories(flutter INTERFACE | ||
"${EPHEMERAL_DIR}" | ||
) | ||
target_link_libraries(flutter INTERFACE "${FLUTTER_LIBRARY}") | ||
target_link_libraries(flutter INTERFACE | ||
PkgConfig::GTK | ||
PkgConfig::GLIB | ||
PkgConfig::GIO | ||
PkgConfig::BLKID | ||
) | ||
add_dependencies(flutter 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. | ||
add_custom_command( | ||
OUTPUT ${FLUTTER_LIBRARY} ${FLUTTER_LIBRARY_HEADERS} | ||
${CMAKE_CURRENT_BINARY_DIR}/_phony_ | ||
COMMAND ${CMAKE_COMMAND} -E env | ||
${FLUTTER_TOOL_ENVIRONMENT} | ||
"${FLUTTER_ROOT}/packages/flutter_tools/bin/tool_backend.sh" | ||
linux-x64 ${CMAKE_BUILD_TYPE} | ||
) | ||
add_custom_target(flutter_assemble DEPENDS | ||
"${FLUTTER_LIBRARY}" | ||
${FLUTTER_LIBRARY_HEADERS} | ||
) |
13 changes: 13 additions & 0 deletions
13
flutter_local_notifications/example/linux/flutter/generated_plugin_registrant.cc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
// | ||
// Generated file. Do not edit. | ||
// | ||
|
||
#include "generated_plugin_registrant.h" | ||
|
||
#include <flutter_local_notifications/flutter_local_notifications_plugin.h> | ||
|
||
void fl_register_plugins(FlPluginRegistry* registry) { | ||
g_autoptr(FlPluginRegistrar) flutter_local_notifications_registrar = | ||
fl_plugin_registry_get_registrar_for_plugin(registry, "FlutterLocalNotificationsPlugin"); | ||
flutter_local_notifications_plugin_register_with_registrar(flutter_local_notifications_registrar); | ||
} |
13 changes: 13 additions & 0 deletions
13
flutter_local_notifications/example/linux/flutter/generated_plugin_registrant.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
// | ||
// Generated file. Do not edit. | ||
// | ||
|
||
#ifndef GENERATED_PLUGIN_REGISTRANT_ | ||
#define GENERATED_PLUGIN_REGISTRANT_ | ||
|
||
#include <flutter_linux/flutter_linux.h> | ||
|
||
// Registers Flutter plugins. | ||
void fl_register_plugins(FlPluginRegistry* registry); | ||
|
||
#endif // GENERATED_PLUGIN_REGISTRANT_ |
16 changes: 16 additions & 0 deletions
16
flutter_local_notifications/example/linux/flutter/generated_plugins.cmake
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# | ||
# Generated file, do not edit. | ||
# | ||
|
||
list(APPEND FLUTTER_PLUGIN_LIST | ||
flutter_local_notifications | ||
) | ||
|
||
set(PLUGIN_BUNDLED_LIBRARIES) | ||
|
||
foreach(plugin ${FLUTTER_PLUGIN_LIST}) | ||
add_subdirectory(flutter/ephemeral/.plugin_symlinks/${plugin}/linux plugins/${plugin}) | ||
target_link_libraries(${BINARY_NAME} PRIVATE ${plugin}_plugin) | ||
list(APPEND PLUGIN_BUNDLED_LIBRARIES $<TARGET_FILE:${plugin}_plugin>) | ||
list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${plugin}_bundled_libraries}) | ||
endforeach(plugin) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To clarify, I wasn't suggesting to use the shared preferences plugin. In fact it should be avoided to minimise dependencies where possible. What I was referring is to look at where they save the info and have the plugin do the same. I would imagine these two lines of Dart code
have an equivalent in C++
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree, so I'm only using it in the example program, users can choose their favorite method to persist the data.
In the plugin, we are only notifying the user by LinuxNotificationNotifier.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, I was reviewing on my phone and thought the only changes would've been to the plugin so missed that this was for the example app. Note though what I was also referring to is having the plugin manage all of this. The core reason for this is goes to why a cross-platform library/SDK is typically chosen as it allows feature parity to achieved with minimal effort In other words, allowing users to get their apps and running quicker. Having the plugin manage it removes additional burden from the user. If how data is stored is that much of a concern, then that tends to be when the data needs to be stored securely and would likely require a custom implementation.
Another issue is that the plugin is now relying the on user to provide a collection of notification ids. This makes it a bit awkward as if a user is picking a library to manage notifications, I dare say the vast majority of users would be expecting the plugin to do so on its own. Having to require users to pass this info means the user becomes the source of truth (note: they could pass erroneous values) when it should really be the plugin. I also just noticed that the method for pending notification requests isn't implemented and doing so would most likely require the plugin to save the notification details anyway. If the user needed to persist this data via the
LinuxNotificationNotifier
and then feed it back to the plugin for the API to get the pending notification requests to work, this makes it even more awkward.If some of what I've raised so far including being able to have scheduled notifications occur even when the app isn't running becomes too much an effort to do, feel free to close the PR. Reason being is I imagine you're doing this on your spare time so can understand if you decide to drop working on this. Though in the case of handling scheduled notifications, perhaps one way is to simply mark those methods as not being implemented. Not sure how many applications would find it useful to be able to display a notification immediately though
cc @jpnurmi: if you happen to have time, would appreciate your thoughts on what I've raised here and in the thread so far but can understand if you're not able to do so
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @MaikuB, sorry I've been a bit busy lately, but I'll try to catch up with what's been going on here later.