// Copyright 2013 The Flutter Authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. #include "flutter/shell/platform/linux/public/flutter_linux/fl_binary_messenger.h" #include "flutter/shell/platform/linux/fl_binary_messenger_private.h" #include "flutter/shell/platform/linux/fl_engine_private.h" #include "flutter/shell/platform/linux/public/flutter_linux/fl_engine.h" #include G_DEFINE_QUARK(fl_binary_messenger_codec_error_quark, fl_binary_messenger_codec_error) struct _FlBinaryMessenger { GObject parent_instance; FlEngine* engine; // PlatformMessageHandler keyed by channel name. GHashTable* platform_message_handlers; }; G_DEFINE_TYPE(FlBinaryMessenger, fl_binary_messenger, G_TYPE_OBJECT) struct _FlBinaryMessengerResponseHandle { GObject parent_instance; // Messenger sending response on. FlBinaryMessenger* messenger; // Handle to send the response with. This is cleared to nullptr when it is // used. const FlutterPlatformMessageResponseHandle* response_handle; }; G_DEFINE_TYPE(FlBinaryMessengerResponseHandle, fl_binary_messenger_response_handle, G_TYPE_OBJECT) static void fl_binary_messenger_response_handle_dispose(GObject* object) { FlBinaryMessengerResponseHandle* self = FL_BINARY_MESSENGER_RESPONSE_HANDLE(object); if (self->response_handle != nullptr && self->messenger->engine != nullptr) { g_critical("FlBinaryMessengerResponseHandle was not responded to"); } g_clear_object(&self->messenger); self->response_handle = nullptr; G_OBJECT_CLASS(fl_binary_messenger_response_handle_parent_class) ->dispose(object); } static void fl_binary_messenger_response_handle_class_init( FlBinaryMessengerResponseHandleClass* klass) { G_OBJECT_CLASS(klass)->dispose = fl_binary_messenger_response_handle_dispose; } static void fl_binary_messenger_response_handle_init( FlBinaryMessengerResponseHandle* self) {} static FlBinaryMessengerResponseHandle* fl_binary_messenger_response_handle_new( FlBinaryMessenger* messenger, const FlutterPlatformMessageResponseHandle* response_handle) { FlBinaryMessengerResponseHandle* self = FL_BINARY_MESSENGER_RESPONSE_HANDLE( g_object_new(fl_binary_messenger_response_handle_get_type(), nullptr)); self->messenger = FL_BINARY_MESSENGER(g_object_ref(messenger)); self->response_handle = response_handle; return self; } typedef struct { FlBinaryMessengerMessageHandler message_handler; gpointer message_handler_data; GDestroyNotify message_handler_destroy_notify; } PlatformMessageHandler; static PlatformMessageHandler* platform_message_handler_new( FlBinaryMessengerMessageHandler handler, gpointer user_data, GDestroyNotify destroy_notify) { PlatformMessageHandler* self = static_cast( g_malloc0(sizeof(PlatformMessageHandler))); self->message_handler = handler; self->message_handler_data = user_data; self->message_handler_destroy_notify = destroy_notify; return self; } static void platform_message_handler_free(gpointer data) { PlatformMessageHandler* self = static_cast(data); if (self->message_handler_destroy_notify) { self->message_handler_destroy_notify(self->message_handler_data); } g_free(self); } static void engine_weak_notify_cb(gpointer user_data, GObject* where_the_object_was) { FlBinaryMessenger* self = FL_BINARY_MESSENGER(user_data); self->engine = nullptr; // Disconnect any handlers. g_hash_table_remove_all(self->platform_message_handlers); } static gboolean fl_binary_messenger_platform_message_cb( FlEngine* engine, const gchar* channel, GBytes* message, const FlutterPlatformMessageResponseHandle* response_handle, void* user_data) { FlBinaryMessenger* self = FL_BINARY_MESSENGER(user_data); PlatformMessageHandler* handler = static_cast( g_hash_table_lookup(self->platform_message_handlers, channel)); if (handler == nullptr) { return FALSE; } g_autoptr(FlBinaryMessengerResponseHandle) handle = fl_binary_messenger_response_handle_new(self, response_handle); handler->message_handler(self, channel, message, handle, handler->message_handler_data); return TRUE; } static void fl_binary_messenger_dispose(GObject* object) { FlBinaryMessenger* self = FL_BINARY_MESSENGER(object); if (self->engine != nullptr) { g_object_weak_unref(G_OBJECT(self->engine), engine_weak_notify_cb, self); self->engine = nullptr; } g_clear_pointer(&self->platform_message_handlers, g_hash_table_unref); G_OBJECT_CLASS(fl_binary_messenger_parent_class)->dispose(object); } static void fl_binary_messenger_class_init(FlBinaryMessengerClass* klass) { G_OBJECT_CLASS(klass)->dispose = fl_binary_messenger_dispose; } static void fl_binary_messenger_init(FlBinaryMessenger* self) { self->platform_message_handlers = g_hash_table_new_full( g_str_hash, g_str_equal, g_free, platform_message_handler_free); } FlBinaryMessenger* fl_binary_messenger_new(FlEngine* engine) { g_return_val_if_fail(FL_IS_ENGINE(engine), nullptr); FlBinaryMessenger* self = FL_BINARY_MESSENGER( g_object_new(fl_binary_messenger_get_type(), nullptr)); self->engine = engine; g_object_weak_ref(G_OBJECT(engine), engine_weak_notify_cb, self); fl_engine_set_platform_message_handler( engine, fl_binary_messenger_platform_message_cb, self, NULL); return self; } G_MODULE_EXPORT void fl_binary_messenger_set_message_handler_on_channel( FlBinaryMessenger* self, const gchar* channel, FlBinaryMessengerMessageHandler handler, gpointer user_data, GDestroyNotify destroy_notify) { g_return_if_fail(FL_IS_BINARY_MESSENGER(self)); g_return_if_fail(channel != nullptr); // Don't set handlers if engine already gone. if (self->engine == nullptr) { if (handler != nullptr) { g_warning( "Attempted to set message handler on an FlBinaryMessenger without an " "engine"); } if (destroy_notify != nullptr) { destroy_notify(user_data); } return; } if (handler != nullptr) { g_hash_table_replace( self->platform_message_handlers, g_strdup(channel), platform_message_handler_new(handler, user_data, destroy_notify)); } else { g_hash_table_remove(self->platform_message_handlers, channel); } } G_MODULE_EXPORT gboolean fl_binary_messenger_send_response( FlBinaryMessenger* self, FlBinaryMessengerResponseHandle* response_handle, GBytes* response, GError** error) { g_return_val_if_fail(FL_IS_BINARY_MESSENGER(self), FALSE); g_return_val_if_fail(response_handle != nullptr, FALSE); g_return_val_if_fail(response_handle->messenger == self, FALSE); g_return_val_if_fail(response_handle->response_handle != nullptr, FALSE); if (self->engine == nullptr) { return TRUE; } if (response_handle->response_handle == nullptr) { g_set_error( error, FL_BINARY_MESSENGER_ERROR, FL_BINARY_MESSENGER_ERROR_ALREADY_RESPONDED, "Attempted to respond to a message that is already responded to"); return FALSE; } gboolean result = fl_engine_send_platform_message_response( self->engine, response_handle->response_handle, response, error); response_handle->response_handle = nullptr; return result; } static void platform_message_ready_cb(GObject* object, GAsyncResult* result, gpointer user_data) { GTask* task = G_TASK(user_data); g_task_return_pointer(task, result, g_object_unref); } G_MODULE_EXPORT void fl_binary_messenger_send_on_channel( FlBinaryMessenger* self, const gchar* channel, GBytes* message, GCancellable* cancellable, GAsyncReadyCallback callback, gpointer user_data) { g_return_if_fail(FL_IS_BINARY_MESSENGER(self)); g_return_if_fail(channel != nullptr); if (self->engine == nullptr) { return; } fl_engine_send_platform_message( self->engine, channel, message, cancellable, callback != nullptr ? platform_message_ready_cb : nullptr, callback != nullptr ? g_task_new(self, cancellable, callback, user_data) : nullptr); } G_MODULE_EXPORT GBytes* fl_binary_messenger_send_on_channel_finish( FlBinaryMessenger* self, GAsyncResult* result, GError** error) { g_return_val_if_fail(FL_IS_BINARY_MESSENGER(self), FALSE); g_return_val_if_fail(g_task_is_valid(result, self), FALSE); g_autoptr(GTask) task = G_TASK(result); GAsyncResult* r = G_ASYNC_RESULT(g_task_propagate_pointer(task, nullptr)); if (self->engine == nullptr) { return nullptr; } return fl_engine_send_platform_message_finish(self->engine, r, error); }