/* * Copyright (c) 2021, Kyle Pereira * * SPDX-License-Identifier: BSD-2-Clause */ #include "SpiceAgent.h" #include "ConnectionToClipboardServer.h" #include #include #include #include #include #include #include #include #include SpiceAgent::SpiceAgent(int fd, ConnectionToClipboardServer& connection) : m_fd(fd) , m_clipboard_connection(connection) { m_notifier = Core::Notifier::construct(fd, Core::Notifier::Read); m_notifier->on_ready_to_read = [this] { on_message_received(); }; m_clipboard_connection.on_data_changed = [this] { if (m_just_set_clip) { m_just_set_clip = false; return; } auto mime = m_clipboard_connection.get_clipboard_data().mime_type(); Optional type = mime_type_to_clipboard_type(mime); if (!type.has_value()) return; auto grab_buffer = ClipboardGrab::make_buffer({ *type }); send_message(grab_buffer); }; auto buffer = AnnounceCapabilities::make_buffer(true, { Capability::ClipboardByDemand }); send_message(buffer); } Optional SpiceAgent::mime_type_to_clipboard_type(DeprecatedString const& mime) { if (mime == "text/plain") return ClipboardType::Text; else if (mime == "image/jpeg") return ClipboardType::JPG; else if (mime == "image/bmp") return ClipboardType::BMP; else if (mime == "image/png" || mime == "image/x-serenityos") return ClipboardType::PNG; else return {}; } void SpiceAgent::on_message_received() { ChunkHeader header {}; read_n(&header, sizeof(header)); auto buffer = ByteBuffer::create_uninitialized(header.size).release_value_but_fixme_should_propagate_errors(); // FIXME: Handle possible OOM situation. read_n(buffer.data(), buffer.size()); auto* message = reinterpret_cast(buffer.data()); switch (message->type) { case (u32)MessageType::AnnounceCapabilities: { auto* capabilities_message = reinterpret_cast(message->data); if (capabilities_message->request) { auto capabilities_buffer = AnnounceCapabilities::make_buffer(false, { Capability::ClipboardByDemand }); send_message(capabilities_buffer); } break; } case (u32)MessageType::ClipboardRequest: { auto* request_message = reinterpret_cast(message->data); auto clipboard = m_clipboard_connection.get_clipboard_data(); auto& mime = clipboard.mime_type(); ByteBuffer backing_byte_buffer; ReadonlyBytes bytes; if (mime == "image/x-serenityos") { auto bitmap = m_clipboard_connection.get_bitmap(); backing_byte_buffer = MUST(Gfx::PNGWriter::encode(*bitmap)); bytes = backing_byte_buffer; } else { auto data = clipboard.data(); bytes = { data.data(), data.size() }; } auto clipboard_buffer = Clipboard::make_buffer((ClipboardType)request_message->type, bytes); send_message(clipboard_buffer); break; } case (u32)MessageType::ClipboardGrab: { auto* grab_message = reinterpret_cast(message->data); auto found_type = ClipboardType::None; for (size_t i = 0; i < (message->size / 4); i++) { auto type = (ClipboardType)grab_message->types[i]; if (found_type == ClipboardType::None) { found_type = static_cast(type); } else if (found_type == ClipboardType::Text) { switch (type) { case ClipboardType::PNG: case ClipboardType::BMP: case ClipboardType::JPG: found_type = type; break; default: break; } } } if (found_type == ClipboardType::None) return; auto request_buffer = ClipboardRequest::make_buffer(found_type); send_message(request_buffer); break; } case (u32)MessageType::Clipboard: { auto* clipboard_message = reinterpret_cast(message->data); auto type = (ClipboardType)clipboard_message->type; auto data_buffer = ByteBuffer::create_uninitialized(message->size - sizeof(u32)).release_value_but_fixme_should_propagate_errors(); // FIXME: Handle possible OOM situation. auto const total_bytes = message->size - sizeof(Clipboard); auto bytes_copied = header.size - sizeof(Message) - sizeof(Clipboard); memcpy(data_buffer.data(), clipboard_message->data, bytes_copied); while (bytes_copied < total_bytes) { ChunkHeader next_header; read_n(&next_header, sizeof(ChunkHeader)); read_n(data_buffer.data() + bytes_copied, next_header.size); bytes_copied += next_header.size; } m_just_set_clip = true; if (type == ClipboardType::Text) { auto anon_buffer_or_error = Core::AnonymousBuffer::create_with_size(data_buffer.size()); VERIFY(!anon_buffer_or_error.is_error()); auto anon_buffer = anon_buffer_or_error.release_value(); memcpy(anon_buffer.data(), data_buffer.data(), data_buffer.size()); m_clipboard_connection.async_set_clipboard_data(anon_buffer, "text/plain", {}); return; } else { ErrorOr frame_or_error = Gfx::ImageFrameDescriptor {}; if (type == ClipboardType::PNG) { if (Gfx::PNGImageDecoderPlugin::sniff({ data_buffer.data(), data_buffer.size() }).release_value_but_fixme_should_propagate_errors()) { auto png_decoder = Gfx::PNGImageDecoderPlugin::create({ data_buffer.data(), data_buffer.size() }).release_value_but_fixme_should_propagate_errors(); if (png_decoder->initialize()) frame_or_error = png_decoder->frame(0); } } else if (type == ClipboardType::BMP) { if (Gfx::BMPImageDecoderPlugin::sniff({ data_buffer.data(), data_buffer.size() }).release_value_but_fixme_should_propagate_errors()) { auto bmp_decoder = Gfx::BMPImageDecoderPlugin::create({ data_buffer.data(), data_buffer.size() }).release_value_but_fixme_should_propagate_errors(); if (bmp_decoder->initialize()) frame_or_error = bmp_decoder->frame(0); } } else if (type == ClipboardType::JPG) { if (Gfx::JPGImageDecoderPlugin::sniff({ data_buffer.data(), data_buffer.size() }).release_value_but_fixme_should_propagate_errors()) { auto jpg_decoder = Gfx::JPGImageDecoderPlugin::create({ data_buffer.data(), data_buffer.size() }).release_value_but_fixme_should_propagate_errors(); if (jpg_decoder->initialize()) frame_or_error = jpg_decoder->frame(0); } } else { dbgln("Unknown clipboard type: {}", (u32)type); return; } auto const& bitmap = frame_or_error.value().image; m_clipboard_connection.set_bitmap(*bitmap); } break; } default: dbgln("Unhandled message type {}", message->type); } } void SpiceAgent::read_n(void* dest, size_t n) { size_t bytes_read = 0; while (bytes_read < n) { int nread = read(m_fd, (u8*)dest + bytes_read, n - bytes_read); if (nread > 0) { bytes_read += nread; } else if (errno == EAGAIN) { continue; } else { dbgln("Failed to read: {}", errno); return; } } } void SpiceAgent::send_message(ByteBuffer const& buffer) { size_t bytes_written = 0; while (bytes_written < buffer.size()) { int result = write(m_fd, buffer.data() + bytes_written, buffer.size() - bytes_written); if (result < 0) { dbgln("Failed to write: {}", errno); return; } bytes_written += result; } } SpiceAgent::Message* SpiceAgent::initialize_headers(u8* data, size_t additional_data_size, MessageType type) { new (data) ChunkHeader { (u32)Port::Client, (u32)(sizeof(Message) + additional_data_size) }; auto* message = new (data + sizeof(ChunkHeader)) Message { AGENT_PROTOCOL, (u32)type, 0, (u32)additional_data_size }; return message; } ByteBuffer SpiceAgent::AnnounceCapabilities::make_buffer(bool request, Vector const& capabilities) { size_t required_size = sizeof(ChunkHeader) + sizeof(Message) + sizeof(AnnounceCapabilities); auto buffer = ByteBuffer::create_uninitialized(required_size).release_value_but_fixme_should_propagate_errors(); // FIXME: Handle possible OOM situation. u8* data = buffer.data(); auto* message = initialize_headers(data, sizeof(AnnounceCapabilities), MessageType::AnnounceCapabilities); auto* announce_message = new (message->data) AnnounceCapabilities { request, {} }; for (auto& cap : capabilities) { announce_message->caps[0] |= (1 << (u32)cap); } return buffer; } ByteBuffer SpiceAgent::ClipboardGrab::make_buffer(Vector const& types) { VERIFY(types.size() > 0); size_t variable_data_size = sizeof(u32) * types.size(); size_t required_size = sizeof(ChunkHeader) + sizeof(Message) + variable_data_size; auto buffer = ByteBuffer::create_uninitialized(required_size).release_value_but_fixme_should_propagate_errors(); // FIXME: Handle possible OOM situation. u8* data = buffer.data(); auto* message = initialize_headers(data, variable_data_size, MessageType::ClipboardGrab); auto* grab_message = new (message->data) ClipboardGrab {}; for (auto i = 0u; i < types.size(); i++) { grab_message->types[i] = (u32)types[i]; } return buffer; } ByteBuffer SpiceAgent::Clipboard::make_buffer(ClipboardType type, ReadonlyBytes contents) { size_t data_size = sizeof(Clipboard) + contents.size(); size_t required_size = sizeof(ChunkHeader) + sizeof(Message) + data_size; auto buffer = ByteBuffer::create_uninitialized(required_size).release_value_but_fixme_should_propagate_errors(); // FIXME: Handle possible OOM situation. u8* data = buffer.data(); auto* message = initialize_headers(data, data_size, MessageType::Clipboard); auto* clipboard_message = new (message->data) Clipboard { .type = (u32)type }; memcpy(clipboard_message->data, contents.data(), contents.size()); return buffer; } ByteBuffer SpiceAgent::ClipboardRequest::make_buffer(ClipboardType type) { size_t data_size = sizeof(ClipboardRequest); size_t required_size = sizeof(ChunkHeader) + sizeof(Message) + data_size; auto buffer = ByteBuffer::create_uninitialized(required_size).release_value_but_fixme_should_propagate_errors(); // FIXME: Handle possible OOM situation. u8* data = buffer.data(); auto* message = initialize_headers(data, data_size, MessageType::ClipboardRequest); new (message->data) ClipboardRequest { .type = (u32)type }; return buffer; }