#include "ui/base/clipboard/clipboard_ozone.h"
#include <algorithm>
#include <limits>
#include <optional>
#include <string_view>
#include <utility>
#include <variant>
#include <vector>
#include "base/check.h"
#include "base/compiler_specific.h"
#include "base/containers/contains.h"
#include "base/containers/flat_map.h"
#include "base/containers/map_util.h"
#include "base/containers/span.h"
#include "base/functional/bind.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/no_destructor.h"
#include "base/notimplemented.h"
#include "base/run_loop.h"
#include "base/strings/strcat.h"
#include "base/strings/utf_string_conversions.h"
#include "base/timer/timer.h"
#include "base/types/optional_util.h"
#include "base/types/variant_util.h"
#include "build/build_config.h"
#include "clipboard_util.h"
#include "third_party/skia/include/core/SkBitmap.h"
#include "ui/base/clipboard/clipboard_buffer.h"
#include "ui/base/clipboard/clipboard_constants.h"
#include "ui/base/clipboard/clipboard_metrics.h"
#include "ui/base/clipboard/clipboard_monitor.h"
#include "ui/base/clipboard/clipboard_util.h"
#include "ui/base/clipboard/custom_data_helper.h"
#include "ui/base/data_transfer_policy/data_transfer_endpoint.h"
#include "ui/base/data_transfer_policy/data_transfer_policy_controller.h"
#include "ui/gfx/codec/png_codec.h"
#include "ui/ozone/public/ozone_platform.h"
#include "ui/ozone/public/platform_clipboard.h"
namespace ui {
namespace {
constexpr base::TimeDelta kRequestTimeout = base::Seconds(1);
bool IsReadAllowed(std::optional<DataTransferEndpoint> data_src,
const DataTransferEndpoint* data_dst,
const base::span<uint8_t> data) {
DataTransferPolicyController* policy_controller =
DataTransferPolicyController::Get();
if (!policy_controller || !data_src.has_value() || data.empty()) {
return true;
}
bool is_allowed = policy_controller->IsClipboardReadAllowed(
data_src, data_dst, data.size());
return is_allowed;
}
class StubPlatformClipboard : public PlatformClipboard {
public:
StubPlatformClipboard() = default;
~StubPlatformClipboard() override = default;
void OfferClipboardData(
ClipboardBuffer buffer,
const PlatformClipboard::DataMap& data_map,
PlatformClipboard::OfferDataClosure callback) override {
is_owner_[buffer] = true;
std::move(callback).Run();
}
void RequestClipboardData(
ClipboardBuffer buffer,
const std::string& mime_type,
PlatformClipboard::RequestDataClosure callback) override {
std::move(callback).Run({});
}
void GetAvailableMimeTypes(
ClipboardBuffer buffer,
PlatformClipboard::GetMimeTypesClosure callback) override {
std::move(callback).Run({});
}
bool IsSelectionOwner(ClipboardBuffer buffer) override {
return is_owner_[buffer];
}
void SetClipboardDataChangedCallback(
PlatformClipboard::ClipboardDataChangedCallback cb) override {}
bool IsSelectionBufferAvailable() const override { return false; }
private:
base::flat_map<ClipboardBuffer, bool> is_owner_;
};
}
class ClipboardOzone::AsyncClipboardOzone {
public:
explicit AsyncClipboardOzone(PlatformClipboard* platform_clipboard)
: platform_clipboard_(platform_clipboard), weak_factory_(this) {
DCHECK(platform_clipboard_);
auto update_sequence_cb =
base::BindRepeating(&AsyncClipboardOzone::OnClipboardDataChanged,
weak_factory_.GetWeakPtr());
platform_clipboard_->SetClipboardDataChangedCallback(
std::move(update_sequence_cb));
}
AsyncClipboardOzone(const AsyncClipboardOzone&) = delete;
AsyncClipboardOzone& operator=(const AsyncClipboardOzone&) = delete;
~AsyncClipboardOzone() = default;
void OnPreShutdown() { platform_clipboard_ = nullptr; }
bool IsSelectionBufferAvailable() const {
return platform_clipboard_->IsSelectionBufferAvailable();
}
std::vector<std::string> RequestMimeTypes(ClipboardBuffer buffer) {
if (buffer == ClipboardBuffer::kSelection && !IsSelectionBufferAvailable())
return {};
if (platform_clipboard_->IsSelectionOwner(buffer)) {
std::vector<std::string> mime_types;
for (const auto& item : offered_data_[buffer])
mime_types.push_back(item.first);
return mime_types;
}
return GetMimeTypes(buffer);
}
void PrepareForWriting() { data_to_offer_.clear(); }
void OfferData(ClipboardBuffer buffer) {
if (buffer == ClipboardBuffer::kSelection && !IsSelectionBufferAvailable())
return;
Offer(buffer, std::move(data_to_offer_));
}
void Clear(ClipboardBuffer buffer) {
if (buffer == ClipboardBuffer::kSelection && !IsSelectionBufferAvailable())
return;
data_to_offer_.clear();
OfferData(buffer);
}
void InsertData(std::vector<uint8_t> data,
const std::set<std::string>& mime_types) {
auto wrapped_data =
base::MakeRefCounted<base::RefCountedBytes>(std::move(data));
for (const auto& mime_type : mime_types) {
DCHECK_EQ(data_to_offer_.count(mime_type), 0U);
data_to_offer_[mime_type] = wrapped_data;
}
}
const ClipboardSequenceNumberToken& GetSequenceNumber(
ClipboardBuffer buffer) const {
return buffer == ClipboardBuffer::kCopyPaste ? clipboard_sequence_number_
: selection_sequence_number_;
}
std::optional<DataTransferEndpoint> ReadSourceAndWait(
ClipboardBuffer buffer) {
auto data = ReadClipboardDataAndWait(buffer, kMimeTypeSourceUrl);
if (data.empty()) {
return std::nullopt;
}
GURL url(std::string(data.begin(), data.end()));
if (!url.is_valid()) {
return std::nullopt;
}
return DataTransferEndpoint(std::move(url));
}
base::span<uint8_t> ReadClipboardDataAndWait(ClipboardBuffer buffer,
const std::string& mime_type) {
if (buffer == ClipboardBuffer::kSelection && !IsSelectionBufferAvailable())
return {};
if (platform_clipboard_->IsSelectionOwner(buffer)) {
auto it = offered_data_[buffer].find(mime_type);
if (it == offered_data_[buffer].end())
return {};
return base::span(it->second->as_vector());
}
if (auto data = Read(buffer, mime_type))
return base::span(data->as_vector());
return {};
}
private:
template <typename Result>
class Request {
public:
enum class State { kStarted, kDone, kAborted };
Result TakeResultSync() {
if (state_ == State::kDone)
return std::move(result_);
DCHECK_EQ(state_, State::kStarted);
base::RunLoop run_loop(base::RunLoop::Type::kNestableTasksAllowed);
quit_closure_ = run_loop.QuitClosure();
base::OneShotTimer abort_timer;
abort_timer.Start(FROM_HERE, kRequestTimeout,
base::BindOnce(&Request::Abort, GetWeakPtr()));
run_loop.Run();
return std::move(result_);
}
void Finish(const Result& result) {
DCHECK_EQ(state_, State::kStarted);
state_ = State::kDone;
result_ = result;
if (!quit_closure_.is_null())
std::move(quit_closure_).Run();
}
base::WeakPtr<Request<Result>> GetWeakPtr() {
return weak_factory_.GetWeakPtr();
}
private:
void Abort() {
DCHECK_EQ(state_, State::kStarted);
Finish(Result{});
state_ = State::kAborted;
}
State state_ = State::kStarted;
base::OnceClosure quit_closure_;
Result result_ = {};
base::WeakPtrFactory<Request<Result>> weak_factory_{this};
};
std::vector<std::string> GetMimeTypes(ClipboardBuffer buffer) {
using MimeTypesRequest = Request<std::vector<std::string>>;
MimeTypesRequest request;
platform_clipboard_->GetAvailableMimeTypes(
buffer,
base::BindOnce(&MimeTypesRequest::Finish, request.GetWeakPtr()));
return request.TakeResultSync();
}
PlatformClipboard::Data Read(ClipboardBuffer buffer,
const std::string& mime_type) {
using ReadRequest = Request<PlatformClipboard::Data>;
ReadRequest request;
platform_clipboard_->RequestClipboardData(
buffer, mime_type,
base::BindOnce(&ReadRequest::Finish, request.GetWeakPtr()));
return request.TakeResultSync().release();
}
void Offer(ClipboardBuffer buffer, PlatformClipboard::DataMap data_map) {
using OfferRequest = Request<bool>;
OfferRequest request;
offered_data_[buffer] = data_map;
platform_clipboard_->OfferClipboardData(
buffer, data_map,
base::BindOnce(&OfferRequest::Finish, request.GetWeakPtr(), true));
request.TakeResultSync();
}
void OnClipboardDataChanged(ClipboardBuffer buffer) {
DCHECK(buffer == ClipboardBuffer::kCopyPaste ||
platform_clipboard_->IsSelectionBufferAvailable());
if (buffer == ClipboardBuffer::kCopyPaste) {
clipboard_sequence_number_ = ClipboardSequenceNumberToken();
ClipboardMonitor::GetInstance()->NotifyClipboardDataChanged();
} else {
selection_sequence_number_ = ClipboardSequenceNumberToken();
}
}
bool IsBufferSupported(ClipboardBuffer buffer) const {
return buffer == ClipboardBuffer::kCopyPaste ||
platform_clipboard_->IsSelectionBufferAvailable();
}
PlatformClipboard::DataMap data_to_offer_;
base::flat_map<ClipboardBuffer, PlatformClipboard::DataMap> offered_data_;
raw_ptr<PlatformClipboard, DanglingUntriaged> platform_clipboard_ = nullptr;
ClipboardSequenceNumberToken clipboard_sequence_number_;
ClipboardSequenceNumberToken selection_sequence_number_;
base::WeakPtrFactory<AsyncClipboardOzone> weak_factory_;
};
ClipboardOzone::ClipboardOzone() {
auto* platform_clipboard =
OzonePlatform::GetInstance()->GetPlatformClipboard();
if (platform_clipboard) {
async_clipboard_ozone_ =
std::make_unique<ClipboardOzone::AsyncClipboardOzone>(
platform_clipboard);
} else {
static base::NoDestructor<StubPlatformClipboard> stub_platform_clipboard;
async_clipboard_ozone_ =
std::make_unique<ClipboardOzone::AsyncClipboardOzone>(
stub_platform_clipboard.get());
}
}
ClipboardOzone::~ClipboardOzone() = default;
void ClipboardOzone::OnPreShutdown() {
async_clipboard_ozone_->OnPreShutdown();
}
std::optional<DataTransferEndpoint> ClipboardOzone::GetSource(
ClipboardBuffer buffer) const {
return async_clipboard_ozone_->ReadSourceAndWait(buffer);
}
const ClipboardSequenceNumberToken& ClipboardOzone::GetSequenceNumber(
ClipboardBuffer buffer) const {
return async_clipboard_ozone_->GetSequenceNumber(buffer);
}
bool ClipboardOzone::IsFormatAvailable(
const ClipboardFormatType& format,
ClipboardBuffer buffer,
const DataTransferEndpoint* data_dst) const {
DCHECK(CalledOnValidThread());
if (!IsReadAllowed(GetSource(buffer), data_dst, base::span<uint8_t>()))
return false;
auto available_types = async_clipboard_ozone_->RequestMimeTypes(buffer);
return base::Contains(available_types, format.GetName());
}
void ClipboardOzone::Clear(ClipboardBuffer buffer) {
async_clipboard_ozone_->Clear(buffer);
}
std::vector<std::u16string> ClipboardOzone::GetStandardFormats(
ClipboardBuffer buffer,
const DataTransferEndpoint* data_dst) const {
std::vector<std::u16string> types;
auto available_types = async_clipboard_ozone_->RequestMimeTypes(buffer);
for (const auto& mime_type : available_types) {
if (mime_type == ClipboardFormatType::HtmlType().GetName() ||
mime_type == ClipboardFormatType::SvgType().GetName() ||
mime_type == ClipboardFormatType::RtfType().GetName() ||
mime_type == ClipboardFormatType::BitmapType().GetName() ||
mime_type == ClipboardFormatType::FilenamesType().GetName()) {
types.push_back(base::UTF8ToUTF16(mime_type));
continue;
}
if ((mime_type == ClipboardFormatType::PlainTextType().GetName() ||
mime_type == kMimeTypeLinuxText || mime_type == kMimeTypeLinuxString ||
mime_type == kMimeTypeUtf8PlainText ||
mime_type == kMimeTypeLinuxUtf8String) &&
!base::Contains(types, kMimeTypePlainText16)) {
types.push_back(kMimeTypePlainText16);
continue;
}
}
return types;
}
void ClipboardOzone::ReadAvailableTypes(
ClipboardBuffer buffer,
const DataTransferEndpoint* data_dst,
std::vector<std::u16string>* types) const {
DCHECK(CalledOnValidThread());
DCHECK(types);
if (!IsReadAllowed(GetSource(buffer), data_dst, base::span<uint8_t>()))
return;
types->clear();
for (const auto& mime_type : GetStandardFormats(buffer, data_dst)) {
types->push_back(mime_type);
}
if (IsFormatAvailable(ClipboardFormatType::DataTransferCustomType(), buffer,
data_dst)) {
auto data = async_clipboard_ozone_->ReadClipboardDataAndWait(
buffer, ClipboardFormatType::DataTransferCustomType().GetName());
ReadCustomDataTypes(data, types);
}
}
void ClipboardOzone::ReadText(ClipboardBuffer buffer,
const DataTransferEndpoint* data_dst,
std::u16string* result) const {
DCHECK(CalledOnValidThread());
auto clipboard_data = async_clipboard_ozone_->ReadClipboardDataAndWait(
buffer, kMimeTypePlainText);
if (!IsReadAllowed(GetSource(buffer), data_dst, clipboard_data))
return;
RecordRead(ClipboardFormatMetric::kText);
*result = base::UTF8ToUTF16(std::string_view(
reinterpret_cast<char*>(clipboard_data.data()), clipboard_data.size()));
}
void ClipboardOzone::ReadAsciiText(ClipboardBuffer buffer,
const DataTransferEndpoint* data_dst,
std::string* result) const {
DCHECK(CalledOnValidThread());
auto clipboard_data = async_clipboard_ozone_->ReadClipboardDataAndWait(
buffer, kMimeTypePlainText);
if (!IsReadAllowed(GetSource(buffer), data_dst, clipboard_data))
return;
RecordRead(ClipboardFormatMetric::kText);
result->assign(clipboard_data.begin(), clipboard_data.end());
}
void ClipboardOzone::ReadHTML(ClipboardBuffer buffer,
const DataTransferEndpoint* data_dst,
std::u16string* markup,
std::string* src_url,
uint32_t* fragment_start,
uint32_t* fragment_end) const {
DCHECK(CalledOnValidThread());
auto clipboard_data =
async_clipboard_ozone_->ReadClipboardDataAndWait(buffer, kMimeTypeHtml);
if (!IsReadAllowed(GetSource(buffer), data_dst, clipboard_data))
return;
RecordRead(ClipboardFormatMetric::kHtml);
markup->clear();
if (src_url)
src_url->clear();
*fragment_start = 0;
*fragment_end = 0;
*markup = base::UTF8ToUTF16(std::string_view(
reinterpret_cast<char*>(clipboard_data.data()), clipboard_data.size()));
DCHECK_LE(markup->length(), std::numeric_limits<uint32_t>::max());
*fragment_end = static_cast<uint32_t>(markup->length());
}
void ClipboardOzone::ReadSvg(ClipboardBuffer buffer,
const DataTransferEndpoint* data_dst,
std::u16string* result) const {
DCHECK(CalledOnValidThread());
auto clipboard_data =
async_clipboard_ozone_->ReadClipboardDataAndWait(buffer, kMimeTypeSvg);
if (!IsReadAllowed(GetSource(buffer), data_dst, clipboard_data))
return;
RecordRead(ClipboardFormatMetric::kSvg);
*result = base::UTF8ToUTF16(std::string_view(
reinterpret_cast<char*>(clipboard_data.data()), clipboard_data.size()));
}
void ClipboardOzone::ReadRTF(ClipboardBuffer buffer,
const DataTransferEndpoint* data_dst,
std::string* result) const {
DCHECK(CalledOnValidThread());
auto clipboard_data =
async_clipboard_ozone_->ReadClipboardDataAndWait(buffer, kMimeTypeRtf);
if (!IsReadAllowed(GetSource(buffer), data_dst, clipboard_data))
return;
RecordRead(ClipboardFormatMetric::kRtf);
result->assign(clipboard_data.begin(), clipboard_data.end());
}
void ClipboardOzone::ReadPng(ClipboardBuffer buffer,
const DataTransferEndpoint* data_dst,
ReadPngCallback callback) const {
auto clipboard_data =
async_clipboard_ozone_->ReadClipboardDataAndWait(buffer, kMimeTypePng);
if (!IsReadAllowed(GetSource(buffer), data_dst, clipboard_data)) {
std::move(callback).Run(std::vector<uint8_t>());
return;
}
RecordRead(ClipboardFormatMetric::kPng);
std::vector<uint8_t> png_data =
std::vector<uint8_t>(clipboard_data.begin(), clipboard_data.end());
std::move(callback).Run(png_data);
}
void ClipboardOzone::ReadDataTransferCustomData(
ClipboardBuffer buffer,
const std::u16string& type,
const DataTransferEndpoint* data_dst,
std::u16string* result) const {
DCHECK(CalledOnValidThread());
auto custom_data = async_clipboard_ozone_->ReadClipboardDataAndWait(
buffer, kMimeTypeDataTransferCustomData);
if (!IsReadAllowed(GetSource(buffer), data_dst, custom_data)) {
return;
}
RecordRead(ClipboardFormatMetric::kCustomData);
if (std::optional<std::u16string> maybe_data =
ReadCustomDataForType(custom_data, type);
maybe_data) {
*result = std::move(*maybe_data);
}
}
void ClipboardOzone::ReadFilenames(ClipboardBuffer buffer,
const DataTransferEndpoint* data_dst,
std::vector<ui::FileInfo>* result) const {
DCHECK(CalledOnValidThread());
auto clipboard_data = async_clipboard_ozone_->ReadClipboardDataAndWait(
buffer, kMimeTypeUriList);
if (!IsReadAllowed(GetSource(buffer), data_dst, clipboard_data))
return;
RecordRead(ClipboardFormatMetric::kFilenames);
std::string uri_list(clipboard_data.begin(), clipboard_data.end());
*result = ui::URIListToFileInfos(uri_list);
}
void ClipboardOzone::ReadBookmark(const DataTransferEndpoint* data_dst,
std::u16string* title,
std::string* url) const {
DCHECK(CalledOnValidThread());
NOTIMPLEMENTED();
}
void ClipboardOzone::ReadData(const ClipboardFormatType& format,
const DataTransferEndpoint* data_dst,
std::string* result) const {
DCHECK(CalledOnValidThread());
auto clipboard_data = async_clipboard_ozone_->ReadClipboardDataAndWait(
ClipboardBuffer::kCopyPaste, format.GetName());
if (!IsReadAllowed(GetSource(ClipboardBuffer::kCopyPaste), data_dst,
clipboard_data))
return;
RecordRead(ClipboardFormatMetric::kData);
result->assign(clipboard_data.begin(), clipboard_data.end());
}
bool ClipboardOzone::IsSelectionBufferAvailable() const {
return async_clipboard_ozone_->IsSelectionBufferAvailable();
}
void ClipboardOzone::WritePortableTextRepresentation(ClipboardBuffer buffer,
const ObjectMap& objects) {
if (buffer != ClipboardBuffer::kCopyPaste || !IsSelectionBufferAvailable()) {
return;
}
auto text_iter = objects.find(base::VariantIndexOfType<Data, TextData>());
if (text_iter == objects.end()) {
return;
}
const auto& text_data = std::get<TextData>(text_iter->second.data);
if (text_data.data.empty()) {
return;
}
async_clipboard_ozone_->PrepareForWriting();
WriteText(text_data.data);
async_clipboard_ozone_->OfferData(ClipboardBuffer::kSelection);
}
void ClipboardOzone::WritePortableAndPlatformRepresentations(
ClipboardBuffer buffer,
const ObjectMap& objects,
const std::vector<RawData>& raw_objects,
std::vector<Clipboard::PlatformRepresentation> platform_representations,
std::unique_ptr<DataTransferEndpoint> data_src,
uint32_t privacy_types) {
DCHECK(CalledOnValidThread());
async_clipboard_ozone_->PrepareForWriting();
DispatchPlatformRepresentations(std::move(platform_representations));
AddSourceToClipboard(buffer, std::move(data_src));
for (const auto& object : objects) {
DispatchPortableRepresentation(object.second);
}
for (const auto& raw_object : raw_objects) {
DispatchPortableRepresentation(raw_object);
}
async_clipboard_ozone_->OfferData(buffer);
WritePortableTextRepresentation(buffer, objects);
}
void ClipboardOzone::WriteText(std::string_view text) {
std::vector<uint8_t> data(text.begin(), text.end());
async_clipboard_ozone_->InsertData(
std::move(data),
{kMimeTypePlainText, kMimeTypeLinuxText, kMimeTypeLinuxString,
kMimeTypeUtf8PlainText, kMimeTypeLinuxUtf8String});
}
void ClipboardOzone::WriteHTML(
std::string_view markup,
std::optional<std::string_view> ) {
std::vector<uint8_t> data(markup.begin(), markup.end());
async_clipboard_ozone_->InsertData(std::move(data), {kMimeTypeHtml});
}
void ClipboardOzone::WriteSvg(std::string_view markup) {
std::vector<uint8_t> data(markup.begin(), markup.end());
async_clipboard_ozone_->InsertData(std::move(data), {kMimeTypeSvg});
}
void ClipboardOzone::WriteRTF(std::string_view rtf) {
std::vector<uint8_t> data(rtf.begin(), rtf.end());
async_clipboard_ozone_->InsertData(std::move(data), {kMimeTypeRtf});
}
void ClipboardOzone::WriteFilenames(std::vector<ui::FileInfo> filenames) {
std::string uri_list = ui::FileInfosToURIList(filenames);
std::vector<uint8_t> data(uri_list.begin(), uri_list.end());
async_clipboard_ozone_->InsertData(std::move(data), {kMimeTypeUriList});
}
void ClipboardOzone::WriteBookmark(std::string_view title,
std::string_view url) {
std::u16string bookmark =
base::StrCat({base::UTF8ToUTF16(url) + u"\n" + base::UTF8ToUTF16(title)});
std::vector<uint8_t> data(reinterpret_cast<const uint8_t*>(bookmark.data()),
reinterpret_cast<const uint8_t*>(UNSAFE_TODO(
bookmark.data() + bookmark.size())));
async_clipboard_ozone_->InsertData(std::move(data), {kMimeTypeMozillaUrl});
}
void ClipboardOzone::WriteWebSmartPaste() {
async_clipboard_ozone_->InsertData(std::vector<uint8_t>(),
{kMimeTypeWebkitSmartPaste});
}
void ClipboardOzone::WriteBitmap(const SkBitmap& bitmap) {
std::vector<uint8_t> png_bytes =
clipboard_util::EncodeBitmapToPngAcceptJank(bitmap);
if (!png_bytes.empty()) {
async_clipboard_ozone_->InsertData(std::move(png_bytes), {kMimeTypePng});
}
}
void ClipboardOzone::WriteData(const ClipboardFormatType& format,
base::span<const uint8_t> data) {
std::vector<uint8_t> owned_data(data.begin(), data.end());
async_clipboard_ozone_->InsertData(std::move(owned_data), {format.GetName()});
}
void ClipboardOzone::AddSourceToClipboard(
const ClipboardBuffer buffer,
std::unique_ptr<DataTransferEndpoint> data_src) {
if (data_src && data_src->IsUrlType()) {
const std::string& string_url = data_src->GetURL()->spec();
async_clipboard_ozone_->InsertData(
std::vector<uint8_t>(string_url.begin(), string_url.end()),
{kMimeTypeSourceUrl});
}
}
}